Difference between revisions of "Application Layer (AlphaCom Data Protocol)"
From Zenitel Wiki
(→Application Data) |
(→AlphaCom class messages) |
||
Line 16: | Line 16: | ||
=== AlphaCom class messages === | === AlphaCom class messages === | ||
+ | |||
+ | For AlphaCom class messages, the message has the format: | ||
+ | :'''<message class> <reference> <message id> <parameters>''' | ||
+ | where: | ||
+ | :'''<reference>''' UINT2 | ||
+ | ::Value identifying receivers’ reference. The purpose of this field is that an external system shall be able to recognise responses to data commands. The external system can select any suitable reference code, and all messages returned from the exchange will contain this reference. | ||
+ | We often use the notation aabb for the reference field, where aa may be used for subrouting (software process) and bb as sequential numbering. | ||
+ | - Broadcast messages are numbered sequentially by the exchange (pr. device). | ||
+ | :<'''message id'''> UINT2 | ||
+ | ::Value identifying the message, i.e. the message number. See details on page 18. | ||
+ | ::Range 0x0000-0x6FFF: Standard application messages | ||
+ | ::Range 0x7000-0x7BFF: Site specific (engineering use) values | ||
+ | ::Range 0x7C00-0x7FFF: Site specific values for Colsys (Mr. Guard, Colnod) | ||
+ | ::Range 0x8000-0x8FFF: AlphaNet audio control messages | ||
+ | :<'''parameters'''> is a variable length string | ||
+ | ::Parameters for the message. | ||
+ | ::The messages parameters always are bytealigned, and fill a whole number of bytes. | ||
+ | |||
+ | All the following descriptions apply to the AlphaCom class message format. | ||
=== TouchLine class messages === | === TouchLine class messages === |
Revision as of 13:29, 28 June 2007
Contents
Application Data
The application part of the information message has the general format: <br\>
- <message class> <message data…….>
where:
- <message class> UINT1
- identifying class of message:
- 65 (0x41) ‘A’ = AlphaCom
- 66 (0x42) ‘B’ = SNMPLike
- 67 (0x43) ‘C’ = TouchLine
- 68 (0x44) ‘D’ = Site specific (engineering use)
- identifying class of message:
- <message data> is a application level data in a format depending on <message class>.
The use of message class means that the AlphaNet protocol is prepared to transport and/or use messages with very different structure than the AlphaCom / Intercom related message formats used today.
AlphaCom class messages
For AlphaCom class messages, the message has the format:
- <message class> <reference> <message id> <parameters>
where:
- <reference> UINT2
- Value identifying receivers’ reference. The purpose of this field is that an external system shall be able to recognise responses to data commands. The external system can select any suitable reference code, and all messages returned from the exchange will contain this reference.
We often use the notation aabb for the reference field, where aa may be used for subrouting (software process) and bb as sequential numbering. - Broadcast messages are numbered sequentially by the exchange (pr. device).
- <message id> UINT2
- Value identifying the message, i.e. the message number. See details on page 18.
- Range 0x0000-0x6FFF: Standard application messages
- Range 0x7000-0x7BFF: Site specific (engineering use) values
- Range 0x7C00-0x7FFF: Site specific values for Colsys (Mr. Guard, Colnod)
- Range 0x8000-0x8FFF: AlphaNet audio control messages
- <parameters> is a variable length string
- Parameters for the message.
- The messages parameters always are bytealigned, and fill a whole number of bytes.
All the following descriptions apply to the AlphaCom class message format.
TouchLine class messages
SNMP-like class messages
Site specific (engineering use) class messages
Data Types
The following table identifies the data types used in the application data of the AlphaNet Data Protocol:
Data Type | Definition |
---|---|
UINT1 | 8 bits (one byte) |
SINT1 | 1-byte signed integer |
UINT2 | 2byte unsigned integer. MSB first |
UINT4 | 4byte unsigned integer. MSB first |
BITMAP[1..n] | nbits bitmap (multiple of 8). Always fills whole bytes. <br\>- Unused bits in last byte is set to 0. <br\>- First bit is the most significant (leftmost) bit in first byte.<br\>- Bits are numbered from 1, a byte contains bits 1..8. |
VBITMAP[1..n] | Variable length bitmap with n bits. (n is a multiple of 8.)
Structure:<br\>UINT1 - containing the number of bytes in the following bitmap. <br\>bitmap - always fills whole bytes. <br\>- Unused bits in last byte is set to 0. <br\>- First bit is the most significant (leftmost) bit in first byte. |
TEXT16 | 16 characters (bytes) of text. Padded with spaces. <br\>ASCII values >= 32 (0x20) only. |
CLOCK | Date & time structure:<br\>UINT2 Year (yyyy)<br\>UINT1 Month (mm)<br\>UINT1 Day (dd)<br\>UINT1 Hour (hh)<br\>UINT1 Minutes (mm)<br\>UINT1 Seconds (ss) |
NET_OBJ_REF | AlphaCom Intercom Object Reference. <br\>Can both encode directory numbers and physical numbers |
Network Object Reference (NET_OBJ_REF)
Further information: Network Object Reference
The NET_OBJ_REF is a “variant record” which has a header with byte count plus a type field.