Actions

Difference between revisions of "Broadcast messages (ACDP)"

From Zenitel Wiki

(Message example)
 
(44 intermediate revisions by 5 users not shown)
Line 1: Line 1:
This article shows some examples of the [[ACDP]] broadcast messages transmitted from the AlphaCom.
+
{{A}}
 +
This article describes the [[ACDP]] broadcast messages transmitted from the AlphaCom, and give some message examples.
 +
 
 +
== Broadcast messages ==
  
 
{| border="1"
 
{| border="1"
 
! style="background:#ffdead;" width="170" |Message  
 
! style="background:#ffdead;" width="170" |Message  
! style="background:#ffdead;" width="70" |Short name
 
 
! style="background:#ffdead;" width="70" |Message no, Hex
 
! style="background:#ffdead;" width="70" |Message no, Hex
 
! style="background:#ffdead;" width="600" |Description
 
! style="background:#ffdead;" width="600" |Description
 
|-
 
|-
|[[DPMT_INVALID ]] || align=center |  || align=center |0x0000 || Reserved value for internal use
+
|[[ST_BUSY_BC ]] || align=center | 0x0036  || Broadcast message: Intercom station is busy
|-
 
|[[PROGRAM]] || align=center|$PROG ||align=center| 0x0001 || Set audio program for single station or a predefined group of stations
 
 
|-
 
|-
|[[PROGRAM_ACK ]] || align=center |   || align=center | 0x0003 || Positive response to PROGRAM
+
|[[ST_FREE_BC ]] || align=center | 0x0037  || Broadcast message: Intercom station is free
 
|-
 
|-
|[[PROG_CONF ]] || align=center | CONF || align=center | 0x0004 || Set Simplex conference for predefined group of stations or a single station
+
|[[CALL_STATUS_BC  ]] || align=center |0x0040 ||Broadcast message telling the status of a call
 
|-
 
|-
|[[PROG_CONF_ACK ]] || align=center |   || align=center | 0x00006 || Positive response to PROG_CONF
+
|[[CONN_STATUS_BC ]] || align=center |0x0041 || Broadcast message telling that a connection is established
 
|-
 
|-
|[[ALARM_MSG]] || align=center |ALRM || align=center |0x0007 || Set up (or disconnect) an ASVP Alarm message to a single station or a predefined group of
+
|[[DISCON_STATUS_BC ]] || align=center |0x0042  || Broadcast message telling that a connection is disconnected
 
 
stations
 
 
|-
 
|-
|[[CALL_SETUP]] || align=center | CALL || align=center | 0x0008 || Sets up a coversation between two users
+
|[[EXT_FEATURE_BC ]] || align=center |0x0043 || Broadcast message when a directory number (feature 50) is dialed on a station
 
|-
 
|-
|[[ALARM_MSG_ACK]]||align=center | ||align=center|0x0009 ||Positive response to ALARM_MSG
+
|[[Q_ELEM_ADDED ]] || align=center | 0x004B  || Broadcast message. Reports that a mail message has been added to a station’s mail queue
 
|-
 
|-
|[[CONN_REQUEST ]] || align=center |CONN || align=center |0x000A || Sets up a coversation between two users
+
|[[Q_ELEM_REMOVED ]] || align=center | 0x004C  || Broadcast message. Reports that a mail message has been removed from a station’s mail queue
 
|-
 
|-
|[[CONN_REFERENCE ]] || align=center | || align=center |0x000B  || Positive response from the exchange to CONN_REQUEST
+
|[[CONF_IS_ROOT ]] || align=center |0x007B || Broadcast message. Sender informs that it is root of conference
 
|-
 
|-
|[[STATION_DOWN ]] || align=center |   || align=center | 0x000C || Negative response to CONN_REQUEST
+
|[[CONF_NOT_ROOT  ]] || align=center |0x007C || Broadcast message. Sender informs that it is no longer root of conference
 
|-
 
|-
|[[STATION_BUSY ]] || align=center |   || align=center | 0x000D || Negative response to CONN_REQUEST.
+
|}
|-
 
|[[CONN_REF_ACK  ]] || align=center |  || align=center |0x000E || The external application acknowledges the CONN_REFERENCE
 
|-
 
|[[DISCONNECTED  ]] || align=center |  || align=center |0x000F || Conversation established with CONN_REQUEST: Conversation was disconnected, e.g. the
 
  
user pressed C-key
+
== Message example ==
|-
+
The messages below are broadcast messages transmitted from the AlphaCom on the AlphaCom Data Protocol when a call is initiated by the command: [[CALL_SETUP|$CALL]] L8002 L8009
|[[DISCONNECTED_ACK ]] || align=center | || align=center |0x0010  || Conversation established with CONN_REQUEST: Acknowledge of the DISCONNECTED message
+
 +
:014101FF2118410015003632018002=54 <br>
 +
:014101FF2119410016003632018009=5D <br>
 +
:014101FF211A410017004007D706070B1A2D32018002320180090201=76 <br>
 +
:014101FF211B410018004107D706070B1A2D01043201800232018009=7F <br>
  
|-
 
|[[DISC_REQ  ]] || align=center |&nbsp;|| align=center |0x0011 || Conversation established with CONN_REQUEST: The external application disconnects a conversation.
 
|-
 
|[[DISC_REQ_ACK]] || &nbsp; || align=center|0x000E  || Conversation established with CONN_REQUEST: The AlphaCom acknowledges the DISC_REQ message
 
|-
 
|[[GET_PIN_COUNTS ]] || align=center |GPC || align=center |0x0013  || Query a RIO about number of output and input pins and support for non mandatory
 
  
features
 
|-
 
|[[PIN_COUNTS ]] || align=center | &nbsp; || align=center | 0x0014  || Response to the GET_PIN_COUNTS message
 
|-
 
|[[CLEAR_RCO ]] || align=center |CLR|| align=center |0x0015  || Turn the given remote control output off
 
|-
 
|[[CLEAR_RCO_OK]] || &nbsp; || align=center|0x0016 || Positive response to the CLEAR_RCO message
 
|-
 
|[[CLEAR_RCO_FAILED ]] || align=center |&nbsp;|| align=center |0x0017  || Negative response to the CLEAR_RCO message
 
|-
 
|[[SET_RCO ]] || align=center | SET || align=center | 0x0014  || Turn the given remote control output on
 
|-
 
|[[SET_RCO_OK ]] || align=center | &nbsp; || align=center | 0x0019 || Positive response to the SET_RCO message
 
|-
 
|[[SET_RCO_FAILED]] || align=center | &nbsp; || align=center | 0x001A  || Negative response to the SET_RCO message
 
|-
 
|[[PULSE_RCO ]] || align=center | PULS  || align=center | 0x001B  || Generate a pulse with the defined length
 
|-
 
|[[PULSE_RCO_OK ]] || align=center |&nbsp;|| align=center |0x001C || Positive response to the PULSE_RCO message
 
|-
 
|[[POLL_RCI ]] || align=center | POLL || align=center | 0x001D  || Poll the given remote control input once
 
|-
 
|[[RCI_IS_OFF ]] || align=center | &nbsp; || align=center | 0x001E  || Response to the POLL_RCI and SCAN_RCI_ONCE messages, input pin is off
 
|-
 
|[[RCI_IS_ON ]] || align=center | &nbsp; || align=center | 0x001F  || Response to the POLL_RCI and SCAN_RCI_ONCE messages, input pin is on
 
|-
 
|[[SCAN_RCI_ONCE]] || align=center | SCAN || align=center | 0x0020|| Scan input until defined condition is met, then report to exchange
 
|-
 
|[[SCAN_RCI_ACK ]] || align=center | &nbsp; || align=center | 0x0021  || Positive response to the SCAN_RCI_ONCE message
 
|-
 
|[[PULSE_RCO_FAILED ]] || align=center | &nbsp; || align=center | 0x0022  || Negative response to the PULSE_RCO message
 
|-
 
|[[ILLEGAL_PARAM  ]] || align=center | &nbsp; || align=center | 0x0023 || Negative response
 
|-
 
|[[SCAN_END_ACK ]] || align=center | &nbsp; || align=center | 0x0024  || Acknowledgment to the RCI_IS_OFF and RCI_IS_ON messages
 
|-
 
|[[GET_SYSTEM_TIME ]] || align=center |GTS|| align=center |0x0025  || Ask a device (AlphaCom) for date and time
 
|-
 
|[[SYSTEM_TIME ]] || align=center | &nbsp; || align=center | 0x0026  || Response to the GET_SYSTEM_TIME and SET_SYSTEM_TIME message
 
|-
 
|[[SET_SYSTEM_TIME ]] || align=center | SST || align=center | 0x0027  || Set the internal clock to the given date and time
 
|-
 
|[[SET_ABSENCE ]] || align=center | SABS || align=center | 0x0028 || Set absence status for an intercom station
 
|-
 
|[[GET_ABSENCE ]] || align=center |GABS|| align=center |0x0029  || Get absence status for an intercom station
 
|-
 
|[[ABSENCE_STATUS]] || align=center | &nbsp; || align=center | 0x002A || Response to SET_ABSENCE and GET_ABSENCE messages 
 
|-
 
|[[SET_REQ_TRANSF ]] || align=center | SCRT || align=center | 0x002B  || Set transfer of Call Request for an intercom station
 
|-
 
|[[GET_REQ_TRANSF ]] || align=center |&nbsp; || align=center |0x002C || Get the Call Request Transfer status for an intercom station
 
|-
 
|[[REQ_TRANSF ]] || align=center | &nbsp; || align=center | 0x002D  || Response to the SET_REQ_TRANSF and GET_REQ_TRANSF messages
 
|-
 
|[[GET_FIRST_MAIL ]] || align=center | &nbsp; || align=center |  0x002E  || Get the first mail entry in the queue for an intercom station
 
|-
 
|[[GET_NEXT_MAIL ]] || align=center |&nbsp; || align=center |0x002F || Get the next mail entry in the queue for an intercom station
 
|-
 
|[[EXT_MAIL  ]] || align=center |&nbsp; || align=center |0x0030 || Response to the GET_x_MAIL messages
 
|-
 
|[[SEND_MAIL ]] || align=center | SM || align=center | 0x0031  || Send a mail message to an intercom station
 
|-
 
|[[SEND_TXT_MAIL ]] || align=center | STM || align=center | 0x0032  || Send a mail message with free text to an intercom station
 
|-
 
|[[SEND_MAIL_ACK ]] || align=center | &nbsp; || align=center | 0x0033  || Response to the SEND_MAIL and SEND_TEXT_MAIL messages
 
|-
 
|[[DELETE_MAIL ]] || align=center |DELM|| align=center |0x0034 || Delete a mail entry in the queue for an intercom station
 
|-
 
|[[DELETE_MAIL_ACK]] || align=center |&nbsp;|| align=center |0x0035 || Response to the DELETE_MAIL message
 
|-
 
|[[ST_BUSY_BC ]] || align=center | &nbsp; || align=center | 0x0036  || Broadcast message: Intercom station is busy
 
|-
 
|[[ST_FREE_BC ]] || align=center | &nbsp; || align=center | 0x0037  || Broadcast message: Intercom station is free
 
|-
 
|[[RESET_TAKEN]] || align=center | RSST || align=center | 0x0038  || A device reports that it has done an internal reset
 
|-
 
|[[RESET_DEVICE ]] || align=center | RESET  || align=center | 0x0039  || Reset a device
 
|-
 
|[[GET_DEVICE ]] || align=center |GDEV  || align=center |0x003A || Get information from an external device
 
|-
 
|[[DEVICE_INFO]] || align=center |&nbsp; || align=center |0x003B || Response to the GET_DEVICE message
 
|-
 
|[[PING ]] || align=center | &nbsp;|| align=center | 0x003C  || Test device: “Are you there?”
 
|-
 
|[[PONG ]] || align=center | &nbsp; || align=center | 0x003C  || Response to the PING message. “Yes, I’m here.”
 
|-
 
|[[RESOURCE_BUSY ]] || align=center | &nbsp; || align=center | 0x003E  || Negative response to CONN_REQUEST
 
|-
 
|[[NO_ACCESS ]] || align=center | &nbsp; || align=center | 0x003F  || Negative response to CONN_REQUEST
 
|-
 
|[[CALL_STATUS_BC  ]] || align=center |&nbsp;|| align=center |0x0040  ||Broadcast message telling the status of a call
 
|-
 
|[[CONN_STATUS_BC ]] || align=center |&nbsp;|| align=center |0x0041  || Broadcast message telling that a connection is established
 
|-
 
|[[DISCON_STATUS_BC ]] || align=center |&nbsp;|| align=center |0x0042  || Broadcast message telling that a connection is disconnected
 
|-
 
|[[EXT_FEATURE_BC ]] || align=center |&nbsp;|| align=center |0x0043 || Broadcast message when a directory number (feature 50) is dialed on a station
 
|-
 
|[[CALL_TRANSFER ]] || align=center |TRF || align=center |0x0044  || Set or remove call transfer for a station
 
|-
 
|[[CALL_TRANSFER_OK ]] || align=center |&nbsp;|| align=center |0x0045  || Positive response to CALL_TRANSFER
 
|-
 
|[[CALL_TRANSFER_NOK  ]] || align=center |&nbsp;|| align=center |0x0046 || Negative response to CALL_TRANSFER
 
|-
 
|[[WAKE_UP ]] || align=center |&nbsp; || align=center | 0x0047 || Register or remove wake­up request
 
|-
 
|[[WAKE_UP_ACK ]] || align=center | &nbsp; || align=center |0x0048 || Positive response to WAKE_UP
 
|-
 
|[[WAKE_UP_NAK ]] || align=center | &nbsp; || align=center | 0x0049 || Negative response to WAKE_UP
 
|-
 
|[[GET_THIS_MAIL]] || align=center |&nbsp;|| align=center |0x004A  || Get the identified mail entry in the queue for an intercom station
 
|-
 
|[[Q_ELEM_ADDED ]] || align=center | &nbsp; || align=center | 0x004B  || Broadcast message. Reports that a mail message has been added to a station’s mail
 
  
queue
+
===Message explanation===
|-
 
|[[Q_ELEM_REMOVED ]] || align=center | &nbsp; || align=center | 0x004C  || Broadcast message. Reports that a mail message has been removed from a station’s
 
  
mail queue
+
'''Station 8002 busy''':
|-
+
<pre>
|[[PROGRAM_NAK  ]] || align=center | &nbsp; || align=center | 0x0003  || Negative response to PROGRAM
+
Message: 014101FF2118410015003632018002=54
|-
 
|[[PROG_CONF_NAK ]] || align=center | &nbsp; || align=center | 0x004E || Negative response to PROG_CONF
 
|-
 
|[[EXECUTE_COMMAND  ]] || align=center |X|| align=center |0x004F  || Send a command string to the exchange to be executed there 
 
|-
 
|[[DIAL_DIGITS  ]] || align=center |DD|| align=center |0x0050 || Simulate digit dialing from a station 
 
|-
 
|[[SINGLE_DIGIT ]] || align=center | DIG || align=center | 0x0051 || Dial one digit on a station
 
|-
 
|[[DIGIT_RELEASE  ]] || align=center |DREL|| align=center |0x0052  || The station has released a digit press
 
|-
 
|[[AUDIO_DETECT ]] || align=center |VOX || align=center |0x0053  || Triggers the event [[Simplex_Conference_Audio]]
 
|-
 
|[[M_KEY  ]] || align=center | M || align=center | 0x0054  || Order station to press M-key
 
|-
 
|[[M_KEY_RELEASE ]] || align=center | MREL || align=center | 0x0055  || Order station to release M-key
 
|-
 
|[[HANDSET_OFF ]] || align=center | HOFF|| align=center | 0x0056  || Order station to lift handset
 
|-
 
|[[HANDSET_ON ]] || align=center | HON || align=center | 0x0057  || Order station to replace handset
 
|-
 
|[[C_KEY  ]] || align=center |C|| align=center |0x0058  || Order station to press C-key 
 
|-
 
|[[DISPLAY_TEXT  ]] || align=center |DSPL|| align=center |0x005A  || Send text and control characters to a station
 
|-
 
|[[STATION_CONVERSATION ]] || align=center | &nbsp; || align=center | 0x0060|| Message from remote exchange. Set station in conversation mode. Stop tone and
 
  
open mic.
+
  Network      Application  Application
|-
+
layer header      header    message param.
|[[STATION_LISTEN ]] || align=center | &nbsp; || align=center | 0x0061 || Message from remote exchange. Set station in listen mode. Shut mic
+
--------------- ------------ --------
|-
+
0141 01FF 21 18 41 0015 0036 32018002 = 54
|[[STATION_TRANSFER ]] || align=center | &nbsp; || align=center |0x0062  || Message from remote exchange: Transfer of B subscriber.
+
---- ---- -- -- -- ---- ---- -------- - --
|-
+
|   |   | | |   |   |       |   | |
|[[GET_PREV_MAIL]] || align=center |&nbsp;|| align=center |0x0063 || Get the previous mail entry in the queue for an intercom station
+
|   |   | | |   |   |       |   | +- Checksum. Bytewise XOR
|-
+
|   |   | | |   |   |       |   +--- Checksum next
|[[GET_LAST_MAIL]] || align=center |&nbsp;|| align=center |0x0064  || Get the last mail entry in the queue for an intercom station
+
|   |   | | |   |   |       +-------- Station in NET_OBJ_REF format: dir no 8002, node 01
|-
+
|   |   | | |   |   +---------------- Message id: 0x0036 = Station is busy
|[[CANCEL_MAIL ]] || align=center |CANM|| align=center |0x0065 || Delete one or more mail/call request/alarm messages queued at a station
+
|    |   | | |   +--------------------- Reference: Value identifying receivers’ reference
|-
+
|   |   | | +------------------------- Message class: 65 (0x41) ‘A’ = AlphaCom
|[[COMMAND_RESPONSE ]] || align=center |&nbsp; || align=center |0x0066 || General response message to messages
+
|   |   | +---------------------------- Options: Message sequence number.
|-
+
|   |   |                               The number option bytes is given by the 3 most significant bits of <hop­count­byte>
|[[EVENT_REPORT]] || align=center |ER || align=center |0x0067 || Report an event to the event/action system
+
|   |   |                               (In this case: Hex:21 = Bin:00100001 > 1 byte option)
|-
+
|   |   +------------------------------- Hopcount byte
|[[VCP_MEET_REQ ]] || align=center | &nbsp; || align=center | 0x0069 || Request answer to global group call
+
|   +----------------------------------- Destination: Node 01, broadcast (0xFF)
|-
+
  +---------------------------------------- Source: Node 01, module 65 (0x41)
|[[GLOB_GRP_MEMB ]] || align=center | &nbsp; || align=center |0x006A  || A exchange tells which global groups this exchange is member of by broadcasting
 
  
this to all exchanges
+
</pre>
|-
 
|[[SET_LOGICAL_RCO ]] || align=center |SLRC|| align=center | 0x006B  || Set or clear a logical RCO
 
|-
 
|[[SET_CALL_REQ_MODE ]] || align=center | SCRM || align=center | 0x006C  || Turn on/off message “your call is registered, please wait”, then ringing/flashing
 
  
at a station
+
'''Station 8009 busy''':
|-
+
<pre>
|[[SET_NODE_NUMBER ]] || align=center | &nbsp; || align=center | 0x006D  || Change the node number of an exchange
+
Message: 014101FF2119410016003632018009=5D  
|-
 
|[[ROUTE_ALPHAPRO_MSG  ]] || align=center | &nbsp; || align=center | 0x006E  || Send AlphaPro message via AlphaNet to/from a remote node
 
|-
 
|[[O_DUPL_CONF ]] || align=center | ODC || align=center | 0x006F  || Include/exclude a station or a group into/from an Open Duplex Conference
 
|-
 
|[[BUILD_GLOB_GRP ]] || align=center |&nbsp;|| align=center |0x0070 || Broadcast message to all exchanges to make them rebuild global group indexes
 
|-
 
|[[OD_CONF_LEAVE ]] || align=center | &nbsp; || align=center | 0x0071  || The participant has left the Open Duplex Conference
 
|-
 
|[[STATUS_REPORT ]] || align=center | &nbsp; || align=center | 0x0072 || Report equipment Presence and Error/OK status
 
|-
 
|[[PUT_STRING ]] || align=center | &nbsp; || align=center | 0x0073 || Output String to Exchange serial port after adding appropriate framing depending on
 
  
selected port
+
  Network      Application  Application
|-
+
layer header      header    message param.
|[[ST_GROUP_DISCON ]] || align=center | SGD || align=center | 0x0074 || Switch off Group Call audio at a station that receives Group Call audio at the  
+
--------------- ------------ --------
 +
0141 01FF 21 19 41 0016 0036 32018009 = 5D
 +
---- ---- -- -- -- ---- ---- -------- - --
 +
|    |  |  |  |  |    |      |    | |
 +
|    |  |  |  |  |    |      |    | +- Checksum. Bytewise XOR
 +
|    |  |  |  |  |    |       |    +--- Checksum next
 +
|   |   | |  |  |    |      +-------- Station in NET_OBJ_REF format: dir no 8009, node 01
 +
|    |  |  |  |  |    +---------------- Message id: 0x0036 = Station is busy
 +
|    |  |  |  |  +--------------------- Reference: Value identifying receivers’ reference
 +
|    |   | | +------------------------- Message class: 65 (0x41) ‘A’ = AlphaCom
 +
|    |  | +---------------------------- Options: Message sequence number.
 +
  |   |   |                                The number option bytes is given by the 3 most significant bits of <hop­count­byte>
 +
|    |  |                                (In this case: Hex:21 = Bin:00100001 > 1 byte option)
 +
|    |  +------------------------------- Hopcount byte
 +
|    +----------------------------------- Destination: Node 01, broadcast (0xFF)
 +
+---------------------------------------- Source: Node 01, module 65 (0x41)
  
moment
+
</pre>
|-
 
|[[LOG_STRING  ]] || align=center | LOG || align=center | 0x0075 || Output String to System Log
 
|-
 
|[[OD_CONF_ENTERED ]] || align=center | &nbsp; || align=center | 0x0076  || The participant has entered an Open Duplex Conference
 
|-
 
|[[SET_DIRNO_TXT ]] || align=center | &nbsp; || align=center | 0x0077  || Change the display text of a directory number (station or feature)
 
|-
 
|[[CONF_JOIN]] || align=center |&nbsp;|| align=center |0x0078  || Exchange wants to join conference, asks root-exchange to setup connection back to sender
 
|-
 
|[[CONF_MEMB_CHK ]] || align=center |&nbsp; || align=center |0x0079 || Ask whether any neighbor exchange has any ordinary member left in conference
 
|-
 
|[[CONF_ORD_MEMB  ]] || align=center |&nbsp;|| align=center |0x007A  || An exchange tells its neighbors that it has ordinary member left in conference
 
|-
 
|[[CONF_IS_ROOT ]] || align=center |&nbsp;|| align=center |0x007B || Broadcast message. Sender informs that it is root of conference
 
|-
 
|[[CONF_NOT_ROOT  ]] || align=center |&nbsp;|| align=center |0x007C || Broadcast message. Sender informs that it is no longer root of conference
 
|-
 
|[[SET_GRP_FILT ]] || align=center | GFLT || align=center | 0x007D || Set group call filter for a station
 
|-
 
|[[CONSOLE_REQ  ]] || align=center |&nbsp;|| align=center |0x007E || Log on to system debug console (TST)
 
|-
 
|[[CONSOLE_DISC ]] || align=center |&nbsp; || align=center |0x007F || Log off from system debug console (TST)
 
|-
 
|[[NAME_EXTENSION ]] || align=center | &nbsp; || align=center | 0x0080  || Special exchange mode using two line names: Send the second line through AlphaNet
 
|-
 
|[[GROUP_MEMBERSHIP ]] || align=center | GRM || align=center | 0x0081  || Set group membership in NVRAM for a station
 
|-
 
|[[SET_MAIL_TIMEOUT ]] || align=center | SMT || align=center | 0x0082  || Set the timer of a mail queue entry
 
|-
 
|[[COPY_MAIL  ]] || align=center |CPYM || align=center |0x0083  || Send a copy of a mail in own queue to a new destination (station or group)
 
|-
 
|[[RCI_CHANGED]] || align=center | $RCIC || align=center | 0x0084  ||New RCI state reported from the exchange
 
|-
 
|[[RCO_CHANGED  ]] || align=center | RCOC|| align=center | 0x0085  || New RCO state reported from the exchange
 
|-
 
|[[PARK_INQ_BROKER ]] || align=center | INQ || align=center | 0x0086  || Park station from conversation, enter Inquiry call state
 
|-
 
|[[UNPARK ]] || align=center |&nbsp; || align=center | 0x0087  || Unpark station from Inquiry call state station, return to conversation
 
|-
 
|[[REQ_TRANSF_CALL  ]] || align=center | TRFC || align=center | 0x0088  || Transfer call in an Inquiry Call situation.
 
|-
 
|[[WRITE_USER_DEF_DATA ]] || align=center | WUDD || align=center | 0x008A  || Write User Defined Data (UDD)
 
|-
 
|[[CONF_TALK ]] || align=center |&nbsp; || align=center |0x008B || Set Simplex conference speaker
 
|-
 
|[[CONF_TALK_STOP ]] || align=center |&nbsp;|| align=center |0x008C  || Stop station form feeding Simplex conference
 
|-
 
|[[MAILQ_NAVIG ]] || align=center |&nbsp; || align=center | 0x008D  || Do operation on mail queue, or step current mail in mail queue
 
|-
 
|[[DISCON_ST ]] || align=center |&nbsp;|| align=center |0x008E  || Disconnect station from ongoing feature
 
|-
 
|[[SET_TIMER ]] || align=center | ST  || align=center | 0x008F || Start or stop a timer
 
|-
 
|[[SET_STATION_COS ]] || align=center | SSC || align=center | 0x0090 || Set COS membership in NVRAM for a station
 
|-
 
|[[MODIFY_COS_CONTENTS]] || align=center | $MCC || align=center | 0x0091 || Modify feature membership in COS in NVRAM
 
|-
 
|[[GLOBAL_SEARCH]]|| align=center | &nbsp;|| align=center | 0x0092 || internally used for timeout of call request in AlphaNet
 
|-
 
|Unused|| align=center | &nbsp;|| align=center | 0x0093 || Unused
 
|-
 
|[[DIAL_DAK ]] || align=center |&nbsp;|| align=center |0x0094  || Dial DAK on a station
 
|-
 
|[[SNV  ]] || align=center | SNV || align=center | 0x0095 || Update specific system settings (NVRAM) values
 
|-
 
| [[TEMP_PROG]] ||align=center|&nbsp;||align=center|0x0096|| Temporarily "mute" program distribution to a station
 
|-
 
| [[DTMF_CONN]] ||align=center|&nbsp;||align=center|0x0097|| Generate DTMF tone during conversation (Only during conversation with RingMaster)
 
|-
 
|[[PAR_RING]] ||align=center|    ||align=center  | 0x0098 || Add a Parallel Ringer station to a call in ringing state
 
|-
 
|[[GET_ST_STATE]]|| align=center | &nbsp;|| align=center | 0x0099 || Get status for a station
 
|-
 
|[[ST_STATE]]|| align=center | &nbsp;|| align=center | 0x009A || Status of a station. response to GET_ST_STATUS
 
|-
 
|[[RESET_AUDIO_LINK]] || align=center | &nbsp; || align=center | 0x8000 || Reset audio link between nodes
 
|-
 
|[[AUDIO_PATH_SETUP  ]] || align=center |&nbsp;|| align=center |0x8001 || Set up audio path between a source node and a destination node (possibly via
 
  
transit nodes)
 
|-
 
|[[AUDIO_PATH_OK ]] || align=center |&nbsp;|| align=center |0x8002 || End to end message: Audio path is ready
 
|-
 
|[[AUDIO_LINK_OK ]] || align=center |&nbsp; || align=center |0x8003|| Response to AUDIO_PATH_SETUP. Channel number is OK
 
|-
 
|[[AUDIO_LINK_NOT_AVAILABLE ]] || align=center |&nbsp; || align=center |0x8006 || Response to AUDIO_PATH_SETUP from next node: Channel not granted
 
|-
 
|[[AUDIO_LINK_RELEASE ]] || align=center |&nbsp; || align=center |0x8005 || Used to release audio path backwards stepwise from node to node when setup meets
 
  
busy or faulty link
+
'''Call status''':
|-
+
<pre>
|[[AUDIO_PATH_DISCONNECT  ]] || align=center |&nbsp;|| align=center |0x8006  || Release the end­to­end audio path. Normal disconnect from source or
+
Message: 014101FF211A410017004007D706070B1A2D32018002320180090201=76
  
destination
+
  Network      Application              Application
|-
+
layer header      header              message parameters
|[[AUDIO_PATH_DELAY ]] || align=center |&nbsp;|| align=center |0x8007 || Set Duplex switch delay
+
--------------- ------------ --------------------------------------
|-
+
0141 01FF 21 1A 41 0017 0040 07D706070B1A2D 32018002 32018009 02 01 = 76
|[[CHECK_AUDIO_PATH ]] || align=center |&nbsp;|| align=center |0x800E || Check of established audio path at regular intervals
+
---- ---- -- -- -- ---- ---- -------------- -------- -------- -- -- - --
|-
+
|    |  |  |  |   |   |        |           |       |     |  | | |
|[[AUDIO_PATH_CHECK_OK ]] || align=center |&nbsp;|| align=center |0x800F || Positive response to CHECK_AUDIO_PATH
+
|    |  |  |  |  |    |        |          |        |      |  | | +- Checksum. Bytewise XOR
|-
+
|    |  |  | |   |   |         |           |       |     | | +--- Checksum next
|[[AUDIO_CH_LOOPBACK_REQ ]] || align=center |&nbsp; || align=center |0x8010 || Request for loopback audio connection. Used by the Audio Channel Testing
+
|    |  |  |  |  |    |        |          |        |      | +----- Call mode: 01 = Open call
 +
|    |  |  |  |  |    |         |           |       |      +-------- A-station call priority: 02 = medium (normal)
 +
|    |  |  | |   |   |         |           |       +--------------- B-station in NetObjRef format: dir no 8009, node 01 
 +
|    |  |  |  |  |    |         |          +------------------------ A-station in NetObjRef format: dir no 8002, node 01 
 +
|    |  |  |  |   |   |         +------------------------------------ Clock 
 +
|    |  |  |  |  |    +---------------------------------------------- Message id: 0x0040 = Call status
 +
|    |   |  | |   +--------------------------------------------------- Reference: Value identifying receivers’ reference
 +
|    |  |  |  +------------------------------------------------------- Message class: 65 (0x41) ‘A’ = AlphaCom
 +
|    |  +---------------------------------------------------------- Options: Message sequence number.
 +
|    |   |                                                             The number option bytes is given by the 3 most
 +
|    |  |                                                              significant bits of <hop­count­byte>
 +
|    |  |                                                              (In this case: Hex:21 = Bin:00100001 > 1 byte option)
 +
|    |  +------------------------------------------------------------- Hopcount byte
 +
|    +----------------------------------------------------------------- Destination: Node 01, broadcast (0xFF)
 +
+---------------------------------------------------------------------- Source: Node 01, module 65 (0x41)
 +
</pre>
  
process 
 
|-
 
|[[AUDIO_CH_LOOPBACK_ACK]] || align=center |&nbsp; || align=center |0x8011  ||Positive acknowledge of AUDIO_CH_LOOPBACK_REQ
 
|-
 
|[[AUDIO_CH_DISCON]] || align=center |&nbsp; || align=center |0x8012  || Disconnect a audio channel after loopback test 
 
|-
 
|[[AUDIO_CH_FAULTY ]] || align=center |&nbsp; || align=center |0x8013  || Response to AUDIO_CH_LOOPBACK_REQ: Requested channel was faulty
 
|-
 
|[[LOOPBACK_IMPOSSIBLE ]] || align=center | &nbsp; || align=center | 0x8014  || Response to AUDIO_CH_LOOPBACK_REQ
 
|-
 
|[[AUDIO_CH_TONE_REQ ]] || align=center |&nbsp; || align=center |0x8015 || Request a peer exchange to put a 500Hz tone on a audio channel
 
|-
 
|[[AUDIO_M_PATH_SETUP ]] || align=center |&nbsp;|| align=center |0x8016  || Communication in a multi-node network
 
|-
 
|[[AUDIO_M_PATH_OK ]] || align=center |&nbsp;|| align=center |0x8017 || Contains statuses for an AUDIO_M_PATH_SETUP from one or more destination exchanges
 
|-
 
|[[AUDIO_M_PATH_BACKTRACK  ]] || align=center |&nbsp;|| align=center |0x8018 || AUDIO_M_PATH_SETUP failed
 
|-
 
|[[AUDIO_M_LINK_OK ]] || align=center | &nbsp; || align=center |0x8019  || Per­ hop positive response to AUDIO_M_PATH_SETUP
 
|-
 
|[[AUDIO_M_FEED_REQ ]] || align=center |&nbsp;|| align=center |0x801A || Global Simplex Conference: Some station is pressing the M-key when participating in
 
 
a conference
 
|-
 
|[[AUDIO_M_FEED_STOP ]] || align=center |&nbsp;|| align=center |0x801B  || Global Simplex Conference: The station is releasing the M-key 
 
|-
 
|[[DUMMY  ]] || align=center |&nbsp;|| align=center |0xFFFE  || Test message: Should be routed, accepted and ignored
 
|-
 
|}
 
 
 
 
The messages below are broadcast messages transmitted from the AlphaCom on the AlphaCom Data Protocol when a call is initiated by the command: [[CALL_SETUP|$CALL]] L8002 L8009
 
 
:014101FF2118410015003632018002=54 <br>
 
:014101FF2119410016003632018009=5D <br>
 
:014101FF211A410017004007D706070B1A2D32018002320180090201=76 <br>
 
:014101FF211B410018004107D706070B1A2D01043201800232018009=7F <br>
 
  
===Message explanation===
+
'''Connect status''':
Space is added for better readability.
 
 
<pre>
 
<pre>
Message 014101FF2118410015003632018002=54
+
Message: 014101FF211B410018004107D706070B1A2D01043201800232018009=7F
  
0141 01FF 21 18 41 0015 0036 32018002 = 54
+
  Network      Application              Application
---- ---- -- -- -- ---- ---- -------- - --
+
layer header      header              message parameters
  !   !   ! ! !   !   !      !   ! +- Checksum
+
--------------- ------------ -------------------------------------
  !   !   ! ! !   !    !      !   +--- Checksum next
+
0141 01FF 21 1B 41 0018 0041 07D706070B1A2D 0104 32018002 32018009 = 7F
  !   !   ! ! !   !   !      +-------- Station in NET_OBJ_REF format: dir no 8002, node 01
+
---- ---- -- -- -- ---- ---- -------------- ---- -------- -------- - --
  !   !   ! ! !   !   +---------------- Message id: 0x0036 = Station is busy
+
  |   |   | | |   |   |        |        |      |        |    | |
  !   !   ! ! !   +--------------------- Reference: Value identifying receivers’ reference
+
|    |  |  |  |  |   |        |        |      |        |    | +- Checksum. Bytewise XOR
  !   !   ! ! +------------------------- Message class: 65 (0x41) ‘A’ = AlphaCom
+
  |   |   | | |   |   |        |        |      |        |    +--- Checksum next
  !   !   ! +---------------------------- Options: The number of bytes is given by <hop­count­byte>
+
  |    |  |  |  |  |    |        |        |      |        +--------- B-station in NetObjRef format: dir no 8009, node 01
  !   !   +------------------------------- Hopcount byte
+
|   |   | | |   |   |        |        |      +------------------ A-station in NetObjRef format: dir no 8002, node 01
  !   +----------------------------------- Destination: Node 01, broadcast (0xFF)
+
|    |  |  |  |  |    |        |        +------------------------- Connection reference 
  +---------------------------------------- Source: Node 01, module 65 (0x41)
+
  |   |   | | |   |   |        +----------------------------------- Clock 
 +
|    |  |  |  |  |    +--------------------------------------------- Message id: 0x0041 = Connect status
 +
  |   |   | | |   +-------------------------------------------------- Reference: Value identifying receivers’ reference
 +
  |   |   | | +------------------------------------------------------ Message class: 65 (0x41) ‘A’ = AlphaCom
 +
  |   |   | +--------------------------------------------------------- Options: Message sequence number.
 +
|    |  |                                                            The number option bytes is given by the 3 most
 +
|    |  |                                                            significant bits of <hop­count­byte>  
 +
  |   |  |                                                            (In this case: Hex:21 = Bin:00100001 > 1 byte option)
 +
|    |   +------------------------------------------------------------ Hopcount byte
 +
  |   +---------------------------------------------------------------- Destination: Node 01, broadcast (0xFF)
 +
  +--------------------------------------------------------------------- Source: Node 01, module 65 (0x41)
 +
</pre>
  
</pre>
+
== Related articles ==
 +
* [[Network Object Reference]]
  
[[Category:AlphaCom E Software]]
+
[[Category:Protocols]]

Latest revision as of 12:05, 27 August 2024

AlphaCom icon 300px.png

This article describes the ACDP broadcast messages transmitted from the AlphaCom, and give some message examples.

Broadcast messages

Message Message no, Hex Description
ST_BUSY_BC 0x0036 Broadcast message: Intercom station is busy
ST_FREE_BC 0x0037 Broadcast message: Intercom station is free
CALL_STATUS_BC 0x0040 Broadcast message telling the status of a call
CONN_STATUS_BC 0x0041 Broadcast message telling that a connection is established
DISCON_STATUS_BC 0x0042 Broadcast message telling that a connection is disconnected
EXT_FEATURE_BC 0x0043 Broadcast message when a directory number (feature 50) is dialed on a station
Q_ELEM_ADDED 0x004B Broadcast message. Reports that a mail message has been added to a station’s mail queue
Q_ELEM_REMOVED 0x004C Broadcast message. Reports that a mail message has been removed from a station’s mail queue
CONF_IS_ROOT 0x007B Broadcast message. Sender informs that it is root of conference
CONF_NOT_ROOT 0x007C Broadcast message. Sender informs that it is no longer root of conference

Message example

The messages below are broadcast messages transmitted from the AlphaCom on the AlphaCom Data Protocol when a call is initiated by the command: $CALL L8002 L8009

014101FF2118410015003632018002=54
014101FF2119410016003632018009=5D
014101FF211A410017004007D706070B1A2D32018002320180090201=76
014101FF211B410018004107D706070B1A2D01043201800232018009=7F


Message explanation

Station 8002 busy:

Message: 014101FF2118410015003632018002=54 

   Network      Application  Application
 layer header      header    message param.
--------------- ------------ --------
0141 01FF 21 18 41 0015 0036 32018002 = 54
---- ---- -- -- -- ---- ---- -------- - --
 |    |   |  |  |   |    |       |    | |
 |    |   |  |  |   |    |       |    | +- Checksum. Bytewise XOR
 |    |   |  |  |   |    |       |    +--- Checksum next
 |    |   |  |  |   |    |       +-------- Station in NET_OBJ_REF format: dir no 8002, node 01
 |    |   |  |  |   |    +---------------- Message id: 0x0036 = Station is busy
 |    |   |  |  |   +--------------------- Reference: Value identifying receivers’ reference
 |    |   |  |  +------------------------- Message class: 65 (0x41) ‘A’ = AlphaCom
 |    |   |  +---------------------------- Options: Message sequence number. 
 |    |   |                                The number option bytes is given by the 3 most significant bits of <hop­count­byte> 
 |    |   |                                (In this case: Hex:21 = Bin:00100001 > 1 byte option)
 |    |   +------------------------------- Hopcount byte
 |    +----------------------------------- Destination: Node 01, broadcast (0xFF)
 +---------------------------------------- Source: Node 01, module 65 (0x41)

Station 8009 busy:

Message: 014101FF2119410016003632018009=5D  

   Network      Application  Application
 layer header      header    message param.
--------------- ------------ --------
0141 01FF 21 19 41 0016 0036 32018009 = 5D 
---- ---- -- -- -- ---- ---- -------- - --
 |    |   |  |  |   |    |       |    | |
 |    |   |  |  |   |    |       |    | +- Checksum. Bytewise XOR
 |    |   |  |  |   |    |       |    +--- Checksum next
 |    |   |  |  |   |    |       +-------- Station in NET_OBJ_REF format: dir no 8009, node 01
 |    |   |  |  |   |    +---------------- Message id: 0x0036 = Station is busy
 |    |   |  |  |   +--------------------- Reference: Value identifying receivers’ reference
 |    |   |  |  +------------------------- Message class: 65 (0x41) ‘A’ = AlphaCom
 |    |   |  +---------------------------- Options: Message sequence number. 
 |    |   |                                The number option bytes is given by the 3 most significant bits of <hop­count­byte> 
 |    |   |                                (In this case: Hex:21 = Bin:00100001 > 1 byte option)
 |    |   +------------------------------- Hopcount byte
 |    +----------------------------------- Destination: Node 01, broadcast (0xFF)
 +---------------------------------------- Source: Node 01, module 65 (0x41)


Call status:

Message: 014101FF211A410017004007D706070B1A2D32018002320180090201=76 

   Network      Application              Application
 layer header      header              message parameters
--------------- ------------ --------------------------------------
0141 01FF 21 1A 41 0017 0040 07D706070B1A2D 32018002 32018009 02 01 = 76
---- ---- -- -- -- ---- ---- -------------- -------- -------- -- -- - --
 |    |   |  |  |   |    |         |           |        |      |  | | |
 |    |   |  |  |   |    |         |           |        |      |  | | +- Checksum. Bytewise XOR
 |    |   |  |  |   |    |         |           |        |      |  | +--- Checksum next
 |    |   |  |  |   |    |         |           |        |      |  +----- Call mode: 01 = Open call
 |    |   |  |  |   |    |         |           |        |      +-------- A-station call priority: 02 = medium (normal)
 |    |   |  |  |   |    |         |           |        +--------------- B-station in NetObjRef format: dir no 8009, node 01  
 |    |   |  |  |   |    |         |           +------------------------ A-station in NetObjRef format: dir no 8002, node 01  
 |    |   |  |  |   |    |         +------------------------------------ Clock  
 |    |   |  |  |   |    +---------------------------------------------- Message id: 0x0040 = Call status
 |    |   |  |  |   +--------------------------------------------------- Reference: Value identifying receivers’ reference
 |    |   |  |  +------------------------------------------------------- Message class: 65 (0x41) ‘A’ = AlphaCom
 |    |   |  +---------------------------------------------------------- Options: Message sequence number. 
 |    |   |                                                              The number option bytes is given by the 3 most 
 |    |   |                                                              significant bits of <hop­count­byte> 
 |    |   |                                                              (In this case: Hex:21 = Bin:00100001 > 1 byte option)
 |    |   +------------------------------------------------------------- Hopcount byte
 |    +----------------------------------------------------------------- Destination: Node 01, broadcast (0xFF)
 +---------------------------------------------------------------------- Source: Node 01, module 65 (0x41)


Connect status:

Message: 014101FF211B410018004107D706070B1A2D01043201800232018009=7F 

   Network      Application              Application
 layer header      header              message parameters
--------------- ------------ -------------------------------------
0141 01FF 21 1B 41 0018 0041 07D706070B1A2D 0104 32018002 32018009 = 7F
---- ---- -- -- -- ---- ---- -------------- ---- -------- -------- - --
 |    |   |  |  |   |    |         |         |      |        |     | |
 |    |   |  |  |   |    |         |         |      |        |     | +- Checksum. Bytewise XOR
 |    |   |  |  |   |    |         |         |      |        |     +--- Checksum next
 |    |   |  |  |   |    |         |         |      |        +--------- B-station in NetObjRef format: dir no 8009, node 01
 |    |   |  |  |   |    |         |         |      +------------------ A-station in NetObjRef format: dir no 8002, node 01  
 |    |   |  |  |   |    |         |         +------------------------- Connection reference  
 |    |   |  |  |   |    |         +----------------------------------- Clock  
 |    |   |  |  |   |    +--------------------------------------------- Message id: 0x0041 = Connect status
 |    |   |  |  |   +-------------------------------------------------- Reference: Value identifying receivers’ reference
 |    |   |  |  +------------------------------------------------------ Message class: 65 (0x41) ‘A’ = AlphaCom
 |    |   |  +--------------------------------------------------------- Options: Message sequence number. 
 |    |   |                                                             The number option bytes is given by the 3 most 
 |    |   |                                                             significant bits of <hop­count­byte> 
 |    |   |                                                             (In this case: Hex:21 = Bin:00100001 > 1 byte option)
 |    |   +------------------------------------------------------------ Hopcount byte
 |    +---------------------------------------------------------------- Destination: Node 01, broadcast (0xFF)
 +--------------------------------------------------------------------- Source: Node 01, module 65 (0x41)

Related articles