LMI Gocator 2000 Family, User Manual

Page: 113 / 194

Ethernet Protocol • 113 Gocator 2000 Family
Status Codes
Label Value Description
OK 1 Command succeeded.
Failed 0 Command failed.
Invalid State -1000 Command is not valid in the current state.
Item Not Found -999 A required item (e.g. file) was not found.
Invalid Command -998 Command is not recognized.
Invalid Parameter -997 One or more command parameters are incorrect.
Not Supported -996 The operation is not supported.
Command and Reply Formats
Commands and replies that are sent and received on the Control and Upgrade channels each begin
with a common header.
Command Header
Field Type Description
length 64s Command size, in bytes.
id 64s Command identifier.
Reply Header
Field Type Description
length 64s Reply size, in bytes.
id 64s Reply identifier (same as command identifier, unless otherwise noted).
status 64s Reply status.
Length fields prepended to the beginning of each message refer to the size of the entire message including
the length field itself. For example, the value of the length field for a command that consists of only the header
(no additional fields) would be 16.
Result Format
Result messages that are received on the Data and Health channels have a common structure. Each
result message has a flexible number of attributes in its header followed by a variable number of data
blocks after the header. The structure of result messages is defined below.
Result
Field Type Description
length 64s Message length, in bytes.
id 64s Message type identifier.
attributeCount 64s Count of attributes in this message.
dataCount 64s Count of data blocks in this message.
attributes[N] 64s List of attributes specific to a particular message type.
descriptors[M] Descriptor List of data block descriptors (one per data block - format defined below).
blocks[M] - List of data blocks specific to a particular message type.
Block Descriptor
Field Type Description
length0 64s Length of block dimension 0.
length1 64s Length of block dimension 1.
length2 64s Length of block dimension 2.