Courtesy Tones: Difference between revisions

From AllStarLink Wiki
Jump to navigation Jump to search
imported>N8THN
Created page with "Category:How to This HowTo explains how to use and define courtesy tones. Node Stanza Keys The node stanza keys below define what unkey events you want to send courtes..."
 
No edit summary
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:How to]]
[[Category:How to]]
This HowTo explains how to use and define courtesy tones.
This HowTo explains how to use and define courtesy tones. Tones are defined for each node in the [node] stanza and those common to all nodes in the [telemetry] stanza.  


 
=== Node Stanza Settings ===
 
Node Stanza Keys


The node stanza keys below define what unkey events you want to send courtesy tones for, and exceptions for unkey events on locally connected nodes (hosted on the same PC).
The node stanza keys below define what unkey events you want to send courtesy tones for, and exceptions for unkey events on locally connected nodes (hosted on the same PC).
Key
{| class="wikitable"
Value Description
!Key
linkunkeyct telemetry stanza key Courtesy tone sent when a networked user unkeys. The default for this is no courtesy tone
!Value
nolocallinkct 1 or 0 Send unlinkedct instead of linkedct if another local node is connected to this node (hosted on the same PC).The nolocallinkct key became available in version 0.184 of app_rpt.c.
!Description
remotect telemetry stanza key This courtesy tone will be sent in addition to any other courtesy tone when a remote base is connected to the node.The default is to send telemetry stanza key ct3.
|-
unlinkedct telemetry stanza key Send a this courtesy tone when the user unkeys if the node is not connected to any other nodes.
|linkunkeyct
.
|telemetry stanza key
|Courtesy tone sent when a networked user unkeys. The default for this is no courtesy tone
|-
|nolocallinkct
|1 or 0
|Send unlinkedct instead of linkedct if another local node is connected to this node (hosted on the same PC).The nolocallinkct key became available in version 0.184 of app_rpt.c.
|-
|remotect
|telemetry stanza key
|This courtesy tone will be sent in addition to any other courtesy tone when a remote base is connected to the node.The default is to send telemetry stanza key ct3.
|-
|unlinkedct
|telemetry stanza key
|Send a this courtesy tone when the user unkeys if the node is not connected to any other nodes.
|}


=== Example Node Stanza===
[1234]                          ; Your node number
telemetry = telemetry          ; Points to the telemetry stanza
unlinkedct = ct2                ; Send a this courtesy tone when the user unkeys if the node is not connected to any other nodes. (optional, default is none)
remotect = ct3                  ; remote linked courtesy tone (indicates a remote is in the list of links)
linkunkeyct = ct8              ; sent when a transmission received over the link unkeys
;nolocallinkct = 0              ; Send unlinkedct instead if another local node is connected to this node (hosted on the same PC).


Telemetry Stanza Keys


=== Telemetry Stanza Settings ===
The telemetry stanza is used to define a telemetry sequence. A telemetry sequence can be a sound file, a tone sequence, or a morse code message.
The telemetry stanza is used to define a telemetry sequence. A telemetry sequence can be a sound file, a tone sequence, or a morse code message.
Since we are discussing courtesy tones, we will skip over the morse and voice options.
Since we are discussing courtesy tones, we will skip over the morse and voice options.
To define a telemetry sequence, you must first choose a telemetry key, then set the value for that key as follows:
To define a telemetry sequence, you must first choose a telemetry key, then set the value for that key as follows:


mykey=!t(tone group)[(tone group)][...]
<code>mykey=!t(tone group)[(tone group)][...]</code>


Where:
Where:
mykey is a name for the courtesy tone, known as the courtesy tone key
tone group is a way to define a single or dual tone sequency of arbitrary duration, frequency, and amplitude. There can be one or multiple tone groups for entry in the telemetry stanza.


''mykey'' is a name for the courtesy tone, known as the '''courtesy tone key'''


''tone group'' is a way to define a single or dual tone sequency of arbitrary duration, frequency, and amplitude. There can be one or multiple tone groups for entry in the telemetry stanza.


Tone Group
==== Tone Group ====
A tone group is a set of 4 comma separated integers formatted as follows:
A tone group is a set of 4 comma separated integers formatted as follows:


(frequency1,frequency2,duration,amplitude)
<code>(frequency1,frequency2,duration,amplitude)</code>


frequency1 and frequency2 must be a number between 0 and 3000. These specify the tone frequency in Hz.
frequency1 and frequency2 must be a number between 0 and 3000. These specify the tone frequency in Hz.
duration is the tone on time in Milliseconds. amplitude is the relative volume level of the tone or tones. This can be from 0 to 8192.
duration is the tone on time in Milliseconds. amplitude is the relative volume level of the tone or tones. This can be from 0 to 8192.


A tone group consisting of zeroes for amplitude and frequency will be sent as a silent period.
A tone group consisting of zeroes for amplitude and frequency will be sent as a silent period.
A single frequency tone can be sent by setting frequency2 to zero.
A single frequency tone can be sent by setting frequency2 to zero.


Note: There must be no spaces between the commas, numbers, or the parenthesis.
Note: There must be no spaces between the commas, numbers, or the parenthesis.


 
=== Example Telemetry Stanza ===
 
[telemetry]
Example Telemetry Stanza
ct1=|t(350,0,100,2048)(500,0,100,2048)(660,0,100,2048)
[telemetry]
ct2=|t(660,880,150,2048)
ct1=|t(350,0,100,2048)(500,0,100,2048)(660,0,100,2048)
ct3=|t(440,0,150,4096)      
ct2=|t(660,880,150,2048)
ct4=|t(550,0,150,2048)      
ct3=|t(440,0,150,4096)
ct5=|t(660,0,150,2048)
ct4=|t(550,0,150,2048)
ct6=|t(880,0,150,2048)
ct5=|t(660,0,150,2048)
ct7=|t(660,440,150,2048)
ct6=|t(880,0,150,2048)
ct8=|t(700,1100,150,2048)
ct7=|t(660,440,150,2048)
ranger = |t(1800,0,60,3072)(0,0,50,0)(1800,0,60,3072)(0,0,50,0)(1800,0,60,3072)(0,0,50,0)(1800,0,60,3072)(0,0,50,0)(1800,0,60,3072)(0,0,50,0)(1800,0,60,3072)(0,0,150,0)   
ct8=|t(700,1100,150,2048)
remotetx=|t(1633,0,50,3000)(0,0,80,0)(1209,0,50,3000)
remotetx=|t(1633,0,50,3000)(0,0,80,0)(1209,0,50,3000);
remotemon=|t(1209,0,50,2048)
remotemon=|t(1209,0,50,2048)
cmdmode=|t(900,903,200,2048)
cmdmode=|t(900,903,200,2048)
functcomplete=|t(1000,0,100,2048)(0,0,100,0)(1000,0,100,2048)
functcomplete=|t(1000,0,100,2048)(0,0,100,0)(1000,0,100,2048)
patchup=rpt/callproceeding
patchup=rpt/callproceeding
patchdown=rpt/callterminated
patchdown=rpt/callterminated

Latest revision as of 15:49, 5 August 2021

This HowTo explains how to use and define courtesy tones. Tones are defined for each node in the [node] stanza and those common to all nodes in the [telemetry] stanza.

Node Stanza Settings

The node stanza keys below define what unkey events you want to send courtesy tones for, and exceptions for unkey events on locally connected nodes (hosted on the same PC).

Key Value Description
linkunkeyct telemetry stanza key Courtesy tone sent when a networked user unkeys. The default for this is no courtesy tone
nolocallinkct 1 or 0 Send unlinkedct instead of linkedct if another local node is connected to this node (hosted on the same PC).The nolocallinkct key became available in version 0.184 of app_rpt.c.
remotect telemetry stanza key This courtesy tone will be sent in addition to any other courtesy tone when a remote base is connected to the node.The default is to send telemetry stanza key ct3.
unlinkedct telemetry stanza key Send a this courtesy tone when the user unkeys if the node is not connected to any other nodes.

Example Node Stanza

[1234]                          ; Your node number
telemetry = telemetry           ; Points to the telemetry stanza 
unlinkedct = ct2                ; Send a this courtesy tone when the user unkeys if the node is not connected to any other nodes. (optional, default is none)
remotect = ct3                  ; remote linked courtesy tone (indicates a remote is in the list of links)
linkunkeyct = ct8               ; sent when a transmission received over the link unkeys
;nolocallinkct = 0              ; Send unlinkedct instead if another local node is connected to this node (hosted on the same PC).


Telemetry Stanza Settings

The telemetry stanza is used to define a telemetry sequence. A telemetry sequence can be a sound file, a tone sequence, or a morse code message.

Since we are discussing courtesy tones, we will skip over the morse and voice options.

To define a telemetry sequence, you must first choose a telemetry key, then set the value for that key as follows:

mykey=!t(tone group)[(tone group)][...]

Where:

mykey is a name for the courtesy tone, known as the courtesy tone key

tone group is a way to define a single or dual tone sequency of arbitrary duration, frequency, and amplitude. There can be one or multiple tone groups for entry in the telemetry stanza.

Tone Group

A tone group is a set of 4 comma separated integers formatted as follows:

(frequency1,frequency2,duration,amplitude)

frequency1 and frequency2 must be a number between 0 and 3000. These specify the tone frequency in Hz.

duration is the tone on time in Milliseconds. amplitude is the relative volume level of the tone or tones. This can be from 0 to 8192.

A tone group consisting of zeroes for amplitude and frequency will be sent as a silent period.

A single frequency tone can be sent by setting frequency2 to zero.

Note: There must be no spaces between the commas, numbers, or the parenthesis.

Example Telemetry Stanza

[telemetry]
ct1=|t(350,0,100,2048)(500,0,100,2048)(660,0,100,2048)
ct2=|t(660,880,150,2048)
ct3=|t(440,0,150,4096)       
ct4=|t(550,0,150,2048)       
ct5=|t(660,0,150,2048)
ct6=|t(880,0,150,2048)
ct7=|t(660,440,150,2048)
ct8=|t(700,1100,150,2048)
ranger = |t(1800,0,60,3072)(0,0,50,0)(1800,0,60,3072)(0,0,50,0)(1800,0,60,3072)(0,0,50,0)(1800,0,60,3072)(0,0,50,0)(1800,0,60,3072)(0,0,50,0)(1800,0,60,3072)(0,0,150,0)    
remotetx=|t(1633,0,50,3000)(0,0,80,0)(1209,0,50,3000)
remotemon=|t(1209,0,50,2048)
cmdmode=|t(900,903,200,2048)
functcomplete=|t(1000,0,100,2048)(0,0,100,0)(1000,0,100,2048)
patchup=rpt/callproceeding
patchdown=rpt/callterminated