Difference between revisions of "Voter.conf"

From AllStarLink Wiki
Jump to navigation Jump to search
Line 2: Line 2:
  
 
This file sets up the <code>chan_voter</code> channel driver to interface with <code>app_rpt</code>.  
 
This file sets up the <code>chan_voter</code> channel driver to interface with <code>app_rpt</code>.  
 +
 +
 +
Remember, in <code>rpt.conf</code>, you will need a directive to use the <code>chan_voter</code> channel driver:
 +
 +
<pre>
 +
rxchannel = Voter/1999
 +
</pre>
 +
 +
 +
The ''1999'' should match the corresponding ''instance'' stanza defined in <code>voter.conf</code> that holds all the definitions for your clients.
 +
  
 
The VOTER/RTCM may be used in any of 3 modes:  
 
The VOTER/RTCM may be used in any of 3 modes:  
Line 15: Line 26:
  
 
The <code>voter.conf</code> file is generally going to be located with the rest of the Asterisk configuration files, in <code>/etc/asterisk</code>.
 
The <code>voter.conf</code> file is generally going to be located with the rest of the Asterisk configuration files, in <code>/etc/asterisk</code>.
 +
 +
 +
There '''must''' be a <code>[general]</code> stanza that contains directives that are common to all the <code>chan_voter</code> ''instances''. Some directives may be allowed in the <code>[general]</code> stanza and/or be defined on a per-client basis with the client definition directive.
 +
 +
 +
In addition, there '''must''' be at least '''one''' ''instance'' stanza defined. An ''instance'' is a group of clients that are all related to each other. In a typical voting repeater scenario, the ''instance'' would typically be the '''node number''', and all the clients would be the transmitter client and all the voting receiver clients associated with that repeater.
 +
 +
 +
It is a valid configuration to only have one client defined in an ''instance''. You might have this if you are just using the VOTER/RTCM as a RoIP adapter to connect a remotely located repeater back to a host over Ethernet.
 +
 +
 +
You may have more than one client defined as a transmitter, as in the case of a simulcast system. Any client with a transmitter directive defined will be sent transmit audio packets associated to that ''instance''.
 +
 +
 +
Each client directive has a number of optional attributes associated with it that may, or may not, be required depending on your system configuration.
 +
 +
 +
There are also configuration directives that apply to an entire ''instance'' (and '''all''' the defined clients within it).
 +
 +
 +
The <code>voter.conf</code> file is structured as shown below (as in all other Asterisk configuration files, lines preceded with a semi-colon ";" are treated as a comment):
  
 
<pre>
 
<pre>
Line 27: Line 59:
  
 
password = secret_password ; password common to all clients (Main Menu Item 6 - Host Password, on RTCM/VOTER)
 
password = secret_password ; password common to all clients (Main Menu Item 6 - Host Password, on RTCM/VOTER)
utos = y ; Turn on IP TOS for Ubiquiti (ToS is enable by default on the RTCM/VOTER)
+
utos = y ; Turn on IP TOS for Ubiquiti (ToS is enable by default on the RTCM/VOTER) from the host TO the clients
  
[1999]
+
[1999] ; define the 1999 instance stanza
 
Main = secret,transmit ; master,transmit,adpcm,nulaw,nodeemp,buflen=value,gpsid[=value]
 
Main = secret,transmit ; master,transmit,adpcm,nulaw,nodeemp,buflen=value,gpsid[=value]
; master - this client is the Master Timing source
+
; master - this client is the Master Timing source (the RTCM client that is on the same LAN as the Asterisk server.)
 +
; There can only be 1 Master Timing source  per ENTIRE Asterisk server.
 +
;
 
; secret - password unique to this client
 
; secret - password unique to this client
; (the RTCM client that is on the same LAN as the Asterisk server.)
 
; There can only be 1 Master Timing source  per entire Asterisk server.
 
 
; transmit - this client is intended to have transmit audio sent to it and will have a transmitter connected to it.
 
; transmit - this client is intended to have transmit audio sent to it and will have a transmitter connected to it.
 
; adpcm - this client is to be sent audio in ADPCM format, rather than Mulaw.
 
; adpcm - this client is to be sent audio in ADPCM format, rather than Mulaw.
Line 41: Line 73:
 
; buflen=value - buffer length for this client only.
 
; buflen=value - buffer length for this client only.
 
; gpsid[=value] - This specifies a gps identity to associate with the specified client (as referred in the /etc/asterisk/gps.conf file).
 
; gpsid[=value] - This specifies a gps identity to associate with the specified client (as referred in the /etc/asterisk/gps.conf file).
 +
 
plfilter = y ; DSP high pass filter
 
plfilter = y ; DSP high pass filter
 
txctcss = 100.0 ; Transmit CTCSS frequency
 
txctcss = 100.0 ; Transmit CTCSS frequency

Revision as of 18:00, 2 February 2022

Introduction

This file sets up the chan_voter channel driver to interface with app_rpt.


Remember, in rpt.conf, you will need a directive to use the chan_voter channel driver:

rxchannel = Voter/1999


The 1999 should match the corresponding instance stanza defined in voter.conf that holds all the definitions for your clients.


The VOTER/RTCM may be used in any of 3 modes:

  • non-voting client mode
  • voting mode
  • voting and simulcast mode


See the VOTER page for additional information.


voter.conf

The voter.conf file is generally going to be located with the rest of the Asterisk configuration files, in /etc/asterisk.


There must be a [general] stanza that contains directives that are common to all the chan_voter instances. Some directives may be allowed in the [general] stanza and/or be defined on a per-client basis with the client definition directive.


In addition, there must be at least one instance stanza defined. An instance is a group of clients that are all related to each other. In a typical voting repeater scenario, the instance would typically be the node number, and all the clients would be the transmitter client and all the voting receiver clients associated with that repeater.


It is a valid configuration to only have one client defined in an instance. You might have this if you are just using the VOTER/RTCM as a RoIP adapter to connect a remotely located repeater back to a host over Ethernet.


You may have more than one client defined as a transmitter, as in the case of a simulcast system. Any client with a transmitter directive defined will be sent transmit audio packets associated to that instance.


Each client directive has a number of optional attributes associated with it that may, or may not, be required depending on your system configuration.


There are also configuration directives that apply to an entire instance (and all the defined clients within it).


The voter.conf file is structured as shown below (as in all other Asterisk configuration files, lines preceded with a semi-colon ";" are treated as a comment):

[general]
port = 667			;
buflen = 220			; specifies the receiver buffer length in milliseconds.
				; This parameter should be set to the maximum expected network latency,
				; plus a little padding (100 milliseconds of padding is a good amount).
				; The default is 500 milliseconds, the minimum is 120 milliseconds.
				; Buffer length may be specified on a per-stanza and per-client basis, see below.


password = secret_password	; password common to all clients (Main Menu Item 6 - Host Password, on RTCM/VOTER)
utos = y			; Turn on IP TOS for Ubiquiti (ToS is enable by default on the RTCM/VOTER) from the host TO the clients

[1999]				; define the 1999 instance stanza
Main = secret,transmit		; master,transmit,adpcm,nulaw,nodeemp,buflen=value,gpsid[=value]
				; master - this client is the Master Timing source (the RTCM client that is on the same LAN as the Asterisk server.)
				; There can only be 1 Master Timing source  per ENTIRE Asterisk server.
				; 
				; secret - password unique to this client
				; transmit - this client is intended to have transmit audio sent to it and will have a transmitter connected to it.
				; adpcm - this client is to be sent audio in ADPCM format, rather than Mulaw.
				; nulaw - this client is to be sent audio in 4000 samples/second Mulaw (Nulaw, as we call it), rather than the standard 8000 samples/second.
				; nodeemp - this client is not to perform de-emphasis of the receiver audio  (This is only to be used with non-voting clients.)
				; buflen=value - buffer length for this client only.
				; gpsid[=value] - This specifies a gps identity to associate with the specified client (as referred in the /etc/asterisk/gps.conf file).

plfilter = y			; DSP high pass filter
txctcss = 100.0			; Transmit CTCSS frequency
txctcsslevel = 20		; Transmit CTCSS level (default of 62 if txctcss is supplied, but txctcsslevel is not set)
txtoctype = phase		; Transmit tone control type: none,phase,notone
				; none - CTCSS tone encoding with no hang time (default)
				; phase - encode CTCSS and reverse phase (AKA "reverse burst") before unkeying TX
				; notone - encode CTCSS and stop sending tone before unkeying TX (AKA "chicken burst")
thresholds = 255,110=5		;
; linger=6			;
; streams = 67.215.233.178:1667 ;


; NORTH = password_1,transmit
; SOUTH = Password_2,master,transmit
; EAST = password_3,nodeemp                   ; bypass filter in RTCM
; WEST = Password_4,transmit,noplfilter       ; bypass filter in RTCM

; streams = 67.215.233.178:1667



[general]
port = 667
buflen = 180                 ; 120 min value that works at all
password = secret            ; RTCM menu 6 (Host password)

[1234]
NORTH = secret1,transmit                 ; secret1 set in RTCM menu 5 (Client password)
SOUTH = secret2,master,transmit
WEST = secret3,nodeemp                   ; bypass deemphasis filter in RTCM  
EAST = secret4,transmit,noplfilter       ; bypass CTCSS filter in RTCM
; streams = 67.215.233.178:1667
; plfilter = y                            ; DSP high pass filter
; txctcss = 107.2                         ; This and next needed for app_rpt generated tone
; txctcsslevel = 20                       ; Transmit CTCSS level. Set to zero for off
; txtoctype = notone                      ; chicken burst 
thresholds = 255,110=5
linger=10