Difference between revisions of "Courtesy Tones"

From "PTTLink Wiki"
Jump to navigation Jump to search
(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...")
 
m
Line 2: Line 2:
 
This HowTo explains how to use and define courtesy tones.
 
This HowTo explains how to use and define courtesy tones.
  
 
+
<span><h3>Node Stanza Keys</h3></span>
 
 
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
+
<table cellpadding = 10>
Value Description
+
<tr><th>Key<th width=200>Value<th>Description</tr>
linkunkeyct telemetry stanza key Courtesy tone sent when a networked user unkeys. The default for this is no courtesy tone
+
<tr><td>linkunkeyct<td>telemetry stanza key<td>Courtesy tone sent when a networked user unkeys. The default for this is no courtesy tone</tr>
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.
+
<tr><td>nolocallinkct<td>1 or 0<td>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.</tr>
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.
+
<tr><td>remotect<td>telemetry stanza key<td>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.</tr>
unlinkedct telemetry stanza key Send a this courtesy tone when the user unkeys if the node is not connected to any other nodes.
+
<tr><td>unlinkedct<td>telemetry stanza key<td>Send a this courtesy tone when the user unkeys if the node is not connected to any other nodes.</th>
.
+
</table>.
 
+
<span><h3>Telemetry Stanza Keys</h3></span>
 
+
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.
Telemetry Stanza Keys
+
Since we are discussing courtesy tones, we will skip over the morse and voice options.
  
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:
 
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
+
<em>mykey</em> is a name for the courtesy tone, known as the <strong>courtesy tone key</strong>
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.
+
<em>tone group</em> 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.
  
 +
<span><h4>Tone Group</h4></span>
  
 
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.
  
Line 43: Line 37:
 
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.
  
 
+
<span><h3>Example Telemetry Stanza</h3></span>
 
+
<pre>
Example Telemetry Stanza
 
 
[telemetry]
 
[telemetry]
 
ct1=|t(350,0,100,2048)(500,0,100,2048)(660,0,100,2048)
 
ct1=|t(350,0,100,2048)(500,0,100,2048)(660,0,100,2048)
Line 61: Line 54:
 
patchup=rpt/callproceeding
 
patchup=rpt/callproceeding
 
patchdown=rpt/callterminated
 
patchdown=rpt/callterminated
 +
</pre>

Revision as of 18:26, 25 January 2019

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 courtesy tones for, and exceptions for unkey events on locally connected nodes (hosted on the same PC).

KeyValueDescription
linkunkeycttelemetry stanza keyCourtesy tone sent when a networked user unkeys. The default for this is no courtesy tone
nolocallinkct1 or 0Send 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.
remotecttelemetry stanza keyThis 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.
unlinkedcttelemetry stanza keySend a this courtesy tone when the user unkeys if the node is not connected to any other nodes.

.

Telemetry Stanza Keys

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)
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