"PTTLink Wiki" - User contributions [en]

IAX Text Protocol

2020-10-12T00:57:00Z

WH6GJL: Created page with "= app_rpt IAX Text Protocol = app_rpt application relies on IAX text frame to extend its protocol capabilities and exchange information with other nodes or clients. There do..."

= app_rpt IAX Text Protocol =

app_rpt application relies on IAX text frame to extend its protocol capabilities and exchange information with other nodes or clients. There does not seem to be any existing documentation for this. This page details the various type of commands in existence as observed "in the wild". This is based a compilation of reading the source code of app_rpt, and reverse engineering of known clients such as IAXRpt and WebTransceiver. As such it's likely to contain errors or misunderstandings. If you have knowledge in some of these areas, please contribute your edits.

== T: Telemetry ==
====Format====
T <NODE_NB> <CMD>,<PARAMS>
* '''NODE_NB''' Node sending message
* '''CMD''' Telemetry command ALLCAPS
* '''PARAMS''' Optional comma separated list of command specific parameters

=== Complete ===

==== Example ====
T 51696 COMPLETE

=== Status ===
Report connection status for the node. Sent in response to *70 status DTMF command.

==== Format ====
T <NODE_NB> STATUS,<NODE_1>,0,<NODE_LIST>
* '''NODE_NB''' Node sending message
* '''NODE_1''' Node reporting status
* '''0''' Unknown
* '''NODE_LIST''' List of nodes connected to NODE_1. Each node number is prefixed by a connection mode as follow:
** '''T''' Transceive mode, send and receive audio
** '''R''' Receive audio only
** '''C''' Connection is pending

==== Example ====
T 51696 STATUS,51696,0,TWH6GJL-P,R29277

=== Connected ===
Node connection succeeded

==== Format ====
T <NODE_NB> CONNECTED,<NODE_1>,<NODE_2>
* '''NODE_NB''' Node sending message
* '''NODE_1''' Node initiating connection
* '''NODE_2''' Other node connected to

==== Example ====
T 51696 CONNECTED,51696,29277

=== Disconnected ===
Remote node disconnected

==== Example ====
T 51696 REMDISC,29277

=== Removed Already Connected ===
Remote node is already part of the network. Note that it could be a direct connection or it could be the node is connected via other nodes.

==== Example ====
T 51696 REMALREADY

=== Connection Failed ===
Remote node can't be connected to.

==== Example ====
T 522540 CONNFAIL,51696

=== Version ===
app_rpt module version.

==== Example ====
T 51696 STATS_VERSION,161.327

=== Unknown ===
T 522540 ARB_ALPHA,123#

== L: Linked ==
Sent periodically by a node to broadcast all node linked to it.

==== Format ====
L <MODE><NODE_NB>,<MODE><NODE_NB>,...
* '''MODE''' Each node number is prefixed by a connection mode as follow:
** '''T''' Transceive mode, send and receive audio
** '''R''' Receive audio only
** '''C''' Connection is pending
* '''NODE_NB''' Linked node
If no other nodes are connected, the list is empty and only L is sent.

== K: Key ==
Sent by a node to update its keyed status

==== Format ====
K <TO> <NODE_NB> <KEYED> <LAST_KEYED_X_SEC_AGO>
* '''TO''' Destination to broadcast this message to. Usually * seems to indicate all connected nodes.
* '''NODE_NB''' Node reporting its keyed status
* '''KEYED''' 1 = node is keyed, 0 = node is not keyed
* '''LAST_KEYED_X_SEC_AGO''' Number of second since node was last keyed

==== Example ====
K * 51696 1 2

=== Key Query ===
Message to request other nodes to report their keyed state. Initiating this command results in all connected nodes replying with their keyed status.

==== Format ====
K? <TO> <NODE_NB> 0 0
* '''TO''' Destination to broadcast this message to. Usually * seems to indicate all connected nodes.
* '''NODE_NB''' Node requesting status? Could be * here as well

==== Example ====
K? * 51696 0 0

== M: Message ==
Text message. Can be sent as node to node or broadcast to all nodes.

==== Format ====
M <TO> <FROM> <BODY>
* '''TO''' Destination node number. 0 indicates all connected nodes
* '''FROM''' Source node number
* '''BODY''' Message content
Example
M 0 51696 Reminder net starts at 10:00 pm PST tonight.

== J: ? ==
Status message reporting repeater frequencies. Seems to be only used in the context of the WebTransceiver client.

==== Format ====
J Remote Frequency \n<FREQ> FM\n<OFFSET> Offset\n<POWER> Power\nTX PL <TXPL>\nRX PL <RXPL>\n

== Miscellaneous signaling ==
There are several messages being exchanged that alter the behavior of the app_rpt application. It's unclear as to their purpose.

=== New Key ===
Seems that this is meant to be some sort of handshake. When a party receives this command it should send it back.
!NEWKEY!

=== New Key1 ===
Seems that this is meant to be some sort of handshake. When a party receives this command it should send it back.
!NEWKEY1!

=== IaxKey ===
Seems that this is meant to be some sort of handshake. When a party receives this command
!IAXKEY!
it should reply with
!IAXKEY! 1 1 0 0

=== Disconnect ===
!!DISCONNECT!!

Main Page

2020-10-12T00:56:36Z

WH6GJL: Adding link to iax text protocol documentation

<div style="clear:both; position:relative; box-sizing:border-box; width:100%; margin:1.2em 0 6px; min-width:47em; border:3px solid #ddd;background-color:#ffffff; color:#000; white-space:nowrap;text-align:center;font-size: 24px; color: #ff6600;">'''Welcome to the AllStarLink Wiki'''</div>
<div style="clear:both; position:relative; box-sizing:border-box; width:100%; margin:1.2em 0 6px; min-width:47em; border:1px solid #ddd; background-color:#ccddff; color:#000; white-space:nowrap;text-align:center;">AllStarLink is a world wide network of [https://en.wikipedia.org/wiki/Amateur_radio Amateur Radio] repeaters, remote base stations and hot spots accessible to each other via the Internet and/or private IP networks.

AllStarLink runs on a dedicated Linux computer (including the Raspberry Pi) that you host at your home, radio site, clubhouse, school, university, workplace, or computer center.

It is based on the open source Asterisk PBX and is released under the GNU GPL -- it is free for anyone to use.

The core of AllStar and AllStarLink is the powerful app_rpt application and associated modules that load into the Asterisk PBX system.
</div>

<div style="clear:both; position:relative; box-sizing:border-box; width:100%; margin:1.2em 0 6px; min-width:47em; border:2pm solid #ddd; background-color:#ebebeb; color:#000; white-space:nowrap; text-align:center; font-size:18px;">[https://grafana.allstarlink.org System Status Dashboard]</div>

<div style="float:right">__TOC__</div>

== How To ==
*[[Beginners Guide]] - Step by step instructions to create your account and AllStarLink node.
*[[Allmon2 Install]] - Allmon2 step by step instructions for install and setup Allmon2.
*[[ASL website password reset]] - allstarlink website instructions for password reset.
*[[Change call sign]] - Step by step call sign change on site and node.
*[[Find my node number]] - How can you find your node number(s) on your ASL account.
*[[Change node password]] - Step by step call sign change passwords.

== Como Hacer ==
*[[Guia para principaintes]] - Configuración paso a paso de AllStarLink para principiantes.
*[[Instalación de Allmon2]] - Instalación y configuración de Allmon2 para principiantes.
*[[Resetear contraseña ASL]] - Como resetear la contraseña de su cuenta en el sitio allstarlink.
*[[Cambiar el indicativo]] - Guía paso a paso para cambiar indicativo en el sitio y el nodo.
*[[Ver mi número de nodo]] - Como ver tu número de nodo(s) en tu cuenta de ASL.
*[[Cambiar la contraseña de un nodo]] - Guia paso a paso para cambiar la contraseña en un nodo.

== AllStarLink Menu ==
*[[Features]] - List of the many AllStarLink Features
*[[ASL FAQ]] - Questions and answers about the AllStarLink software distribution.
*[[:Category:How to|How To's]] - A collection of AllStarLink how to's.
*[[:Category:Node Configuration|Node Configuration]] - Detailed configuration settings.
*[[:Category:Development|Development]] - Information regarding development of the AllStarLink software (i.e., contributing, etc).
*[[Radio Connections]] - Instructions to Connect Radios, Repeaters and Other Devices to AllStar.
*[[Troubleshooting]] - Troubleshooting common problems, things to try, and hints to solve the problem.

== Downloads ==
* [https://github.com/AllStarLink/Asterisk/releases/tag/ASL-1.01 ASL AMD] Latest AllStarLink installer for x86/AMD (main site)
* [http://dvswitch.org/files/ASL_Images/Intel-AMD/Stretch/ ASL AMD] Latest AllStarLink installer for x86/AMD (alternative site)
* [http://dvswitch.org/files/ASL_Images/Raspberry_Pi/Stretch/ Pi] Latest AllStarLink image for the Raspberry Pi
* [http://dvswitch.org/files/ASL_Images/ ASL Repo] AllStarLink Image Repository
* [[ASL FAQ]] - Install ASL on your existing Debian box or VM

Note: The ASL 1.01 installer is a Network installer and still uses the dvswitch.org site to download the .deb install files.

== Descargas ==
* [https://github.com/AllStarLink/Asterisk/releases/tag/ASL-1.01 ASL AMD] Última versión del instalador de AllStarLink para x86/AMD (sitio principal).
* [http://dvswitch.org/files/ASL_Images/Intel-AMD/Stretch/ ASL AMD] Última versión del instalador de AllStarLink para x86/AMD (sitio alterno).
* [http://dvswitch.org/files/ASL_Images/Raspberry_Pi/Stretch/ Pi] Última versión de la imágen de AllStarLink para Raspberry Pi.

== Development/Building ==
* [[Compiling]] - Building ASL from source
*[[Dahdi_dummy|DAHDI Dummy]] - How to fix audio stutter on ASL based Raspberry PI images
*[[IAX Text Protocol]] - app_rpt iax text frame protocol

== Related Links ==
* [https://allstarlink.org/ AllStarLink Portal] - If you are looking to set up your own AllStarLink node.
* [https://www.allstarlink.org/nodelist AllStarLink Portal Nodelist] - The searchable and sortable node list.
* [http://stats.allstarlink.org/ AllStarLink Stats] - shows all the existing public nodes.
* [https://community.allstarlink.org/ AllStarLink Community Site] - Web based user support form (replaced app_rpt mailing list) This is the only forum the board monitors, but there is no technical knowledge.
* [http://lists.keekles.org/cgi-bin/mailman/listinfo/app_rpt-users AllStarLink users mailing list]- This is the app_rpt mailing list for discussion, help and helping others. '''This is the only group that developers monitor and respond on.'''
* [https://github.com/AllStarLink/ Source Code] - All of the source code for the AllStarLink Asterisk and app_rpt is available on GitHub.

==Organization==
*[[ASLCorporate:The_Organization_-_AllStarLink_Inc.]] - What is AllStarLink?
*[[ASLCorporate:The_Beginning_-_AllStarLink_Inc]] - How AllStarLink came to be.
*[[ASLCorporate:ASL_Meeting_Minutes]] - AllStarLink, Inc Official Meeting Minutes

== History ==
* [[History]] from the Duuude, Jim Dixon WB6NIL SK 12/16/2016.
* [[Thru-hole_Voter_Board|Thru-hole Voter Board]] from Jim Dixon

== References ==
* [http://rogerdudler.github.io/git-guide/ Git - The Simple Guide] - A handy reference for getting started with Git.
* [https://jwiegley.github.io/git-from-the-bottom-up/ Git from the Bottom Up] - An explanation of how git works from the bottom up.
* [https://ryanstutorials.net/linuxtutorial/cheatsheet.php Ryans Tutorials - Linux Tutorial - Cheat Sheet] Handy Cheat Sheet of Linux commands.
* [https://training.linuxfoundation.org/resources/free-courses/introduction-to-linux/ The Linux Training Foundation - Introduction to Linux] A free eight week course with optional certificate that teaches how to use Linux.

User:WH6GJL

2020-10-12T00:54:09Z

WH6GJL:

User:WH6GJL

2020-10-11T23:07:22Z

WH6GJL:

User:WH6GJL

2020-10-11T22:59:29Z

WH6GJL:

User:WH6GJL

2020-10-11T22:57:04Z

WH6GJL: WIP protocol