HiQnet Third Party Programmers Guide - Architectural Media Systems
HiQnet Third Party Programmers Guide - Architectural Media Systems
HiQnet Third Party Programmers Guide - Architectural Media Systems
Create successful ePaper yourself
Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.
<strong>HiQnet</strong> <strong>Third</strong> <strong>Party</strong> Programmer Documentation<br />
3 <strong>HiQnet</strong> Message Format<br />
The following section lists the detailed message formats for the common <strong>HiQnet</strong><br />
messages. See section 3.4.1 for an explanation of the datatypes and how they are<br />
stored.<br />
3.1 Header<br />
This is the common header for <strong>HiQnet</strong> messages. The first field is for <strong>HiQnet</strong><br />
message version. The current <strong>HiQnet</strong> version is 0x02, please use this as the<br />
default.<br />
VERSION UBYTE 0x02<br />
HEADER LENGTH UBYTE 0xXX<br />
MESSAGE LENGTH ULONG 0xXXXXXXXX<br />
SOURCE ADDRESS HIQNETADDR 0xDEVICEVDOBJECT<br />
DEST. ADDRESS HIQNETADDR 0xDEVICEVDOBJECT<br />
MESSAGE ID UWORD 0xXXXX<br />
FLAGS UWORD 0x0000<br />
HOP COUNT UBYTE 0x01<br />
SEQUENCE NUMBER UWORD 0x0001<br />
Optional „Error‟ header (FLAGS=0x0008):<br />
ERROR CODE UWORD 0x02<br />
ERROR STRING STRING “The Error Message”<br />
Optional „Multi-part‟ header (FLAGS=0x0040):<br />
START SEQ. NO. UWORD 0x02<br />
BYTES REMAINING ULONG 0xXXXXXXXX<br />
Optional „Session Number‟ header (FLAGS=0x0100):<br />
SESSION NUMBER UWORD 0xXXXX<br />
© HARMAN 19 February 2013<br />
Page 22 of 91
Change language