Difference between revisions of "Telemetry"

From AllStarLink Wiki
Jump to navigation Jump to search
imported>Wd6awp
 
(5 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
+
=Definition=
Telemetry is the message you hear when connecting to or disconnecting from another node and when another node connects or disconnects to your node.
+
Telemetry is a data message that is sent between nodes when connecting to or disconnecting from another node. Telemetry is silently sent to all other connected nodes through digital (out-of-band, non-audio) data over the VoIP connection. It is purely up to each local system to decide what to do with this information. It can announce it, ignore it or even change the message. The node owner/admin determines what is appropriate for their individual node.  
 
 
Asterisk/app_rpt sends its telemetry information to all other connected systems through digital (out-of-band, non-audio)  
 
data over the VoIP connection. It is purely up to each local system to decide what to do with this
 
information. It can announce it, ignore it or even change the message. The node owner/admin determines what is appropriate for their individual node.  
 
  
 
There are configuration and mode options allowing all telemetry (both local and obtained from other nodes) to be:
 
There are configuration and mode options allowing all telemetry (both local and obtained from other nodes) to be:
Line 11: Line 7:
 
* Announced only when a function is locally executed and for short time thereafter
 
* Announced only when a function is locally executed and for short time thereafter
  
Note: These features document the operation of app_rpt.c version 0.186 or later.
+
There are 5 telemetry channels which can be individually managed:
 +
* Local Node - This node
 +
* Foreign Node - A connected node
 +
* Phone - Autopatch, phone portal
 +
* Echolink - Echolink connections
 +
* GUI - IAXrpt, SIP phone display, VoIP clients
 +
 
 +
''Note'': Requires app_rpt.c version 0.186 or later.
 +
 
 +
=Usage of type:=
 +
==Local==
 +
telemdefault 0 = telemetry output off, 1 = telemetry output on, 2 = timed telemetry output on command execution and for a short time thereafter
 +
 
 +
telemdynamic 0 = disallow users to change the local telemetry setting with a COP command, 1 = Allow users to change the setting with a COP command
 +
 
 +
==EchoLink==
 +
eannmode       0 = do not announce Echolink nodes at all, 1 = announce only the node number (Allstar-translated), 2 = announce only the call of the echolink station, 3 = announce both
 +
 
 +
echolinkdefault      0 = telemetry output off, 1 = telemetry output on, 2 = timed telemetry output on command execution and for a short time thereafter, 3 = follow local telemetry mode
 +
 
 +
echolinkdynamic      0 = disallow users to change current echolink telemetry setting with a COP command, 1 = Allow users to change the setting with a COP command
 +
 
 +
==Phone==
 +
phonelinkdefault 0 = telemetry output off, 1 = telemetry output on, 2 = timed telemetry output on command execution and for a short time thereafter, 3 = follow local telemetry mode
 +
 
 +
phonelinkdynamic 0 = disallow users to change phone telemetry setting with a COP command, 1 = Allow users to change the setting with a COP command
 +
 
 +
==GUI==
 +
 
 +
guilinkdefault  0 = telemetry output off, 1 = telemetry output on, 2 = timed telemetry output on command execution and for a short time thereafter, 3 = follow local telemetry mode
 +
 
 +
guilinkdynamic 0 = disallow users to change the gui telemetry setting with a COP command, 1 = Allow users to change the setting with a COP command
 +
 
 +
=Implementation By COP Command=
 +
==Local==
 +
33 Local Telemetry Output Enable
 +
 
 +
34 Local Telemetry Output Disable
 +
 
 +
35 Local Telemetry Output Timed
 +
==Foreign==
 +
36 Foreign Link Local Output Path Enable
 +
 
 +
37 Foreign Link Local Output Path Disable
 +
 
 +
38 Foreign Link Local Output Path Follows Local Telemetry Selection (above)
 +
 
 +
39 Foreign Link Local Output Path Timed
 +
 
 +
 
 +
NOTE: The Foreign Link COP methods only work from the user on the foreign link, (i.e. not from the local node / iax inbound telemetry).
  
The configuration options mentioned below only apply to what is heard on a specific channel type;
 
out-of-band telemetry is silently forwarded to all other compatible nodes connected in transceive mode.
 
  
There are 5 telemetry channels which can be individually managed:
+
(IAX Text messaging needs to be added here)
 +
 
 +
[[Category: How to]]

Latest revision as of 16:38, 21 December 2023

Definition

Telemetry is a data message that is sent between nodes when connecting to or disconnecting from another node. Telemetry is silently sent to all other connected nodes through digital (out-of-band, non-audio) data over the VoIP connection. It is purely up to each local system to decide what to do with this information. It can announce it, ignore it or even change the message. The node owner/admin determines what is appropriate for their individual node.

There are configuration and mode options allowing all telemetry (both local and obtained from other nodes) to be:

  • Always announced
  • Never announced
  • Announced only when a function is locally executed and for short time thereafter

There are 5 telemetry channels which can be individually managed:

  • Local Node - This node
  • Foreign Node - A connected node
  • Phone - Autopatch, phone portal
  • Echolink - Echolink connections
  • GUI - IAXrpt, SIP phone display, VoIP clients

Note: Requires app_rpt.c version 0.186 or later.

Usage of type:

Local

telemdefault 0 = telemetry output off, 1 = telemetry output on, 2 = timed telemetry output on command execution and for a short time thereafter

telemdynamic 0 = disallow users to change the local telemetry setting with a COP command, 1 = Allow users to change the setting with a COP command

EchoLink

eannmode 0 = do not announce Echolink nodes at all, 1 = announce only the node number (Allstar-translated), 2 = announce only the call of the echolink station, 3 = announce both

echolinkdefault 0 = telemetry output off, 1 = telemetry output on, 2 = timed telemetry output on command execution and for a short time thereafter, 3 = follow local telemetry mode

echolinkdynamic 0 = disallow users to change current echolink telemetry setting with a COP command, 1 = Allow users to change the setting with a COP command

Phone

phonelinkdefault 0 = telemetry output off, 1 = telemetry output on, 2 = timed telemetry output on command execution and for a short time thereafter, 3 = follow local telemetry mode

phonelinkdynamic 0 = disallow users to change phone telemetry setting with a COP command, 1 = Allow users to change the setting with a COP command

GUI

guilinkdefault 0 = telemetry output off, 1 = telemetry output on, 2 = timed telemetry output on command execution and for a short time thereafter, 3 = follow local telemetry mode

guilinkdynamic 0 = disallow users to change the gui telemetry setting with a COP command, 1 = Allow users to change the setting with a COP command

Implementation By COP Command

Local

33 Local Telemetry Output Enable

34 Local Telemetry Output Disable

35 Local Telemetry Output Timed

Foreign

36 Foreign Link Local Output Path Enable

37 Foreign Link Local Output Path Disable

38 Foreign Link Local Output Path Follows Local Telemetry Selection (above)

39 Foreign Link Local Output Path Timed


NOTE: The Foreign Link COP methods only work from the user on the foreign link, (i.e. not from the local node / iax inbound telemetry).


(IAX Text messaging needs to be added here)