Difference between revisions of "Structure of Config Files"

From "PTTLink Wiki"
Jump to navigation Jump to search
 
(14 intermediate revisions by one other user not shown)
Line 1: Line 1:
Configuration files have a simple structure consisting of two parts, the stanza and key/value pairs.
+
[[Category: Node Configuration]]
# A stanza is a section of the config file. It starts with a name (or number) surrounded by square brackets on a line by itself. A config file will have one or more stanza. Each stanza continues until the next stanza or end of file. Stanzas contain one or more ker/value pairs.  
+
[[Category:How to]]
# Key/value pairs set various values such as the ID of the node.
+
Configuration files have a simple structure consisting of stanzas, key/value pairs and comments. A stanza is a block of text within a configuration file. It starts with a name (or number) surrounded by square brackets on a line by itself. Configuration files will have one or more stanzas. Each stanza continues until the next stanza or end of file.  
 +
<syntaxhighlight lang="ini">
 +
[this is a stanza]
 +
...
  
Config file comments are preceded with a semicolon.
+
[this is another stanza]
 +
...
 +
</syntaxhighlight>
 +
Stanzas contain one or more ker/value pairs. Key/value pairs set various values within each stanza.
 +
<syntaxhighlight lang="ini">myname=timothy ; There are some who call me Tim?</syntaxhighlight>
  
In this example of two nodes the stanza is the node number and the key/value pairs set the CW ID and the ID timer:
+
Config file comments are preceded with a semicolon. In this example of two nodes the stanza is the node number and the key/value pairs set the CW ID and the ID timer:
  
<pre>
+
<syntaxhighlight lang="ini">
; Node 1998 Stanza
 
 
[1998]
 
[1998]
 
idrecording = |iW1ABC
 
idrecording = |iW1ABC
 
idtime = 540000          ; 9 minutes
 
idtime = 540000          ; 9 minutes
  
; Node 1999 Stanza
 
 
[1999]
 
[1999]
 
idrecording = |iW1XYZ
 
idrecording = |iW1XYZ
 
idtime = 540000  
 
idtime = 540000  
</pre>
+
</syntaxhighlight>
 +
 
 +
==Settings to name other Stanzas==
 +
Some key=value pairs point to other stanzas. This allows nodes on the same server to have the same settings (without duplicate entries) or different settings in some cases. For example the phone patch command may be *6 on one node, yet *61 on another.
 +
 
 +
For example:
 +
<syntaxhighlight lang="ini">
 +
[1000]
 +
functions=functionsVHF
 +
 
 +
[1001]
 +
functions=functionsVHF  ;same functions as node 1000
 +
 
 +
[1002]
 +
functions=functionsUHF
 +
 
 +
[functionsVHF]
 +
; Two meter Autopatch up is *6
 +
6=autopatchup,noct=1,farenddisconnect=1,dialtime=20000
 +
0=autopatchdn      ; Autopatch down
 +
 
 +
[functionsUHF]
 +
; 440 Autopatch up is *61
 +
61=autopatchup,noct=1,farenddisconnect=1,dialtime=20000  ; Autopatch up
 +
0=autopatchdn      ; Autopatch down
 +
</syntaxhighlight>
 +
 
 +
==Named Stanzas in rpt.conf==
 +
* controlstates=
 +
* functions=
 +
* link_functions=
 +
* macro=
 +
* phone_functions=
 +
* telemetry=
 +
* wait_times=
  
 
''Note:'' A stanza is also called a context in Asterisk PBX terminology, particularly related to the dialplan.
 
''Note:'' A stanza is also called a context in Asterisk PBX terminology, particularly related to the dialplan.

Latest revision as of 18:50, 27 January 2022

Configuration files have a simple structure consisting of stanzas, key/value pairs and comments. A stanza is a block of text within a configuration file. It starts with a name (or number) surrounded by square brackets on a line by itself. Configuration files will have one or more stanzas. Each stanza continues until the next stanza or end of file.

[this is a stanza]
...

[this is another stanza]
...

Stanzas contain one or more ker/value pairs. Key/value pairs set various values within each stanza.

myname=timothy ; There are some who call me Tim?

Config file comments are preceded with a semicolon. In this example of two nodes the stanza is the node number and the key/value pairs set the CW ID and the ID timer:

[1998]
idrecording = |iW1ABC
idtime = 540000          ; 9 minutes

[1999]
idrecording = |iW1XYZ
idtime = 540000

Settings to name other Stanzas

Some key=value pairs point to other stanzas. This allows nodes on the same server to have the same settings (without duplicate entries) or different settings in some cases. For example the phone patch command may be *6 on one node, yet *61 on another.

For example:

[1000]
functions=functionsVHF

[1001]
functions=functionsVHF   ;same functions as node 1000

[1002]
functions=functionsUHF

[functionsVHF]
; Two meter Autopatch up is *6
6=autopatchup,noct=1,farenddisconnect=1,dialtime=20000 
0=autopatchdn       ; Autopatch down

[functionsUHF]
; 440 Autopatch up is *61
61=autopatchup,noct=1,farenddisconnect=1,dialtime=20000  ; Autopatch up
0=autopatchdn       ; Autopatch down

Named Stanzas in rpt.conf

  • controlstates=
  • functions=
  • link_functions=
  • macro=
  • phone_functions=
  • telemetry=
  • wait_times=

Note: A stanza is also called a context in Asterisk PBX terminology, particularly related to the dialplan.