AllStarLink Standard Commands: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (9 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
[[Category:How to]] | [[Category:How to]] | ||
'''This section contains the suggested prefix digits, mandatory command codes, and suggested command codes for Allstar Link.''' | '''This section contains the suggested prefix digits, mandatory command codes, and suggested command codes for Allstar Link.''' | ||
== Mandatory Command Codes == | |||
These are the mandatory command codes which all Allstar Link nodes must support to provide command code consistency to the users. | |||
<nowiki>*</nowiki>1<code>node</code>Disconnect Link | |||
<nowiki>*</nowiki>2<code>node</code>Connect link in monitor mode | |||
<nowiki>*</nowiki>3<code>node</code>Connect link in transcieve mode | |||
<nowiki>*</nowiki>4<code>node</code>Enter command mode on a remote node | |||
<nowiki>*</nowiki>70 Local connection status | |||
<nowiki>*</nowiki>99 DTMF Phone Key (Assert PTT from Phone Portal) | |||
Notes | |||
# <code>node</code> is an Allstar Link node number | |||
# Node number zero (0) is shorthand for the last node operated on by a previous command | |||
# Monitor mode means listen to a node, but do not send any audio to it | |||
# Command mode means send all received DTMF digits to the node number specified (bypassing the local command decoder). Send # to exit command mode, and restore local command decoding. | |||
== Prefix Digit Suggestions == | == Prefix Digit Suggestions == | ||
| Line 10: | Line 31: | ||
|Description | |Description | ||
|- | |- | ||
|* | |*1 | ||
|Disconnect from link. | |Disconnect from link. | ||
|- | |- | ||
|* | |*2 | ||
|Connect to node | |Connect to node in Rx only mode. | ||
|- | |- | ||
|* | |*3 | ||
|Connect to node | |Connect to node in Transceive Mode | ||
|- | |- | ||
|*4 | |*4 | ||
| Line 53: | Line 74: | ||
|} | |} | ||
== | == Optional Command Codes == | ||
These are | These are suggested, but are typically configured by default on ASL nodes. | ||
<nowiki>*</nowiki> | <nowiki>*</nowiki>80 Force System ID | ||
<nowiki>*</nowiki> | <nowiki>*</nowiki>81 Say System Time | ||
<nowiki>*</nowiki> | <nowiki>*</nowiki>980 Say app_rpt software version | ||
<nowiki>*</nowiki> | <nowiki>*</nowiki>75 Link Connect (Local Monitor Only) | ||
<nowiki>*</nowiki> | <nowiki>*</nowiki>72 Last active node (system-wide) | ||
<nowiki>*</nowiki> | <nowiki>*</nowiki>73 System-wide connection status | ||
<nowiki>*</nowiki> | <nowiki>*</nowiki>71 Disconnect all links (macro) | ||
<nowiki>*</nowiki> | <nowiki>*</nowiki>74 Reconnect all links (macro) | ||
== Complete List of AllStar Commands == | |||
The default AllStarLink DTMF commands are well commented in the configuration file [https://github.com/AllStarLink/ASL-Asterisk/blob/develop/allstar/configs/simpleusb/rpt.conf /etc/asterisk/rpt.conf] These may be changed if you or someone else edited the file so take a look at the actual file on your node to be sure. | |||
All of the possible [https://github.com/AllStarLink/ASL-Asterisk/blob/develop/asterisk/apps/app_rpt.c commands are documented] at the top of the source. You don't need to be a C programmer to read the comments. | |||
Latest revision as of 18:34, 30 April 2021
This section contains the suggested prefix digits, mandatory command codes, and suggested command codes for Allstar Link.
Mandatory Command Codes
These are the mandatory command codes which all Allstar Link nodes must support to provide command code consistency to the users.
*1nodeDisconnect Link
*2nodeConnect link in monitor mode
*3nodeConnect link in transcieve mode
*4nodeEnter command mode on a remote node
*70 Local connection status
*99 DTMF Phone Key (Assert PTT from Phone Portal)
Notes
nodeis an Allstar Link node number- Node number zero (0) is shorthand for the last node operated on by a previous command
- Monitor mode means listen to a node, but do not send any audio to it
- Command mode means send all received DTMF digits to the node number specified (bypassing the local command decoder). Send # to exit command mode, and restore local command decoding.
Prefix Digit Suggestions
| Prefix | Description |
| *1 | Disconnect from link. |
| *2 | Connect to node in Rx only mode. |
| *3 | Connect to node in Transceive Mode |
| *4 | Command Mode for controlling node |
| *5 | User-defined macros |
| *6 | User defined functions, such as autopatch |
| *7 | Connection Status / Other Functions |
| *8 | User defined functions |
| *9 | User defined functions |
| *0 | User defined functions |
| *A | User defined functions |
| *B | User defined functions |
| *C | User defined functions |
| *D | User defined functions |
Optional Command Codes
These are suggested, but are typically configured by default on ASL nodes.
*80 Force System ID
*81 Say System Time
*980 Say app_rpt software version
*75 Link Connect (Local Monitor Only)
*72 Last active node (system-wide)
*73 System-wide connection status
*71 Disconnect all links (macro)
*74 Reconnect all links (macro)
Complete List of AllStar Commands
The default AllStarLink DTMF commands are well commented in the configuration file /etc/asterisk/rpt.conf These may be changed if you or someone else edited the file so take a look at the actual file on your node to be sure. All of the possible commands are documented at the top of the source. You don't need to be a C programmer to read the comments.