Actions

Difference between revisions of "AlphaNet Data Protocol"

From Zenitel Wiki

(Message Formats - Grouped by Function)
(Common notes)
Line 36: Line 36:
 
* [[Message Formats (Sortable)]]
 
* [[Message Formats (Sortable)]]
  
== Common notes ==
 
 
* Over time, more parameters will be added to existing messages.  These parameters are often marked “(optional)”, and the AMC version which introduced them is shown to the right in the explanation of each parameter.
 
:- Note that it’s the exchange that processes the DP message that adds default values when it creates an internal representation of the message.  If you send a “short” message to a remote node in AlphaNet, all default fields will be filled in in that exchange.  Example:  [[SEND_MAIL]] without A station name will get the name from the same dir.no in the remote exchange (if existing).  See comment under [[Stentofon_Simple_Link_Layer#Default_values_for_omitted_message_fields|Simple Link Layer]].
 
* In general, NULL is not allowed as [[NET_OBJ_REF]] parameter.
 
:It’s described explicitly when it can be used, e.g. to switch call forwarding OFF.  Hint:  Some DP messages works correctly only if you leave the [[NET_OBJ_REF]] parameter out, rather than supplying an explicit NULL field.
 
* Note that all messages may cause the response message ILLEGAL_PARAM, indicating that the exchange has problems recognizing either the message number, or a parameter value of a message.  In these cases the documented response message will NOT be returned. 
 
:- ILLEGAL_PARAM refers to the problem parameter using a number from 1 and up.  This is the number you will find in to the left of each parameter in the table.
 
:- In AlphaNet, if you get an ILLEGAL_PARAM from a remote node indicating that an optional parameter is required, remember that the AMC versions indicated for optional parameters refers to the receiving node, not the local node generating the message.
 
* Some messages may seem to have too few parameters.  Keep in mind that:
 
:- the network layer header contains [[node]] and [[device]] address for both a source and a destination
 
:- the reference field is always identical in a “command” and the returned “response”.
 
* '''AlphaNet:''' To control a station in a network you must address the DP message to that station’s node.  Messages are in general ONLY routed according to the network layer header. If you send a message to an exchange, and use a node number as part of the (A) Subscriber field which is different from the addressed node, the command will be ignored or cause an error response.  The messages which deviates from this rule is documented explicitly!
 
<br><br>
 
  
 
[[Category:AlphaCom E Software]]
 
[[Category:AlphaCom E Software]]
 
[[Category:AlphaNet]]
 
[[Category:AlphaNet]]
 
[[Category: ACDP messages]]
 
[[Category: ACDP messages]]

Revision as of 15:28, 24 January 2011

The AlphaCom/AlphaNet Data Protocol (ACDP protocol) is used for:

  • Data communication between AlphaCom Exchanges in AlphaNet, including other types of exchanges such as TouchLine MPC
  • Data communication between AlphaCom Exchanges and External Devices such as RIOs and PC based Control Handlers
  • Advanced internal control of the AlphaCom. Event Handler can use DP messages as general Action Commands.

The Data Protocol is made generally available from software version AMC 06.00. Previous AMC softwares are NOT compatible with this protocol descriptions.


Protocol properties

  • Binary format for speed. Readable ASCII hex format can be used as an alternative for easier debugging
  • The physical layer of the protocol is RS485, RS422 or RS232. In AlphaCom E the protocol can also be encapsulated in TCP/IP.
  • Data link layers with message checksum for reliability, and with acknowledgment and re-transmission of erroneous messages
  • Network layer for routability when several exchanges are connected
  • Variable length fields and optional fields so that the protocol can be used also in future systems with different requirements regarding number of digits in addresses, station numbers etc.
  • A systematic way of addressing exchange resources both as directory numbers and physical addresses
  • Addressed messages. Commands are addressed to a specific device, and response is returned to the device issuing the command only. In addition, there is a few status broadcast messages
  • Addressed messages can be routed in a network. The input and output messages have identical frame format, and thus can be sent via transit exchanges. The same protocol is used both to control a single exchange, and as the AlphaNet protocol

Message example

Here is a HEX coded example of a message with network layer header and application data. This is basically what you send to the exchange in the “simple link layer” format. We assume that you use exchange node 01, the PC is device 01, and that there is a station 107 and 102. The message DIAL_DIGITS looks like this, with spaces between fields for clarity only:

Network        Application   Application Message 
layer header   header        parameters              
0101 0141 01   41 1234 0050  3201107F 20102F
Src  Dest Hop  Cl Ref  Msg   P1       P2
dev  dev  cnt  ss      id    Station  Digits to dial

See also