OpenIGTLink/ProtocolV2/Type/Capability
Contents
Summary
The CAPABILITY data type lists the names of message types that the receiver can interpret. Although the OpenIGTLink protocol guarantees that any receiver can at least skip messages with unknown type and continue to interpret the following messages, it is a good idea to get the capability information at system startup to ensure application-level compatibility of various devices. In a CAPABILITY message type, each message type name comes with format version number. If the receiver can interpret multiple versions for a certain message type, they should be listed as independent types.
Message Types
CAPABILITY
| Data | Type | Description |
| TYPE_0 | unsigned char [12] | Type name #0 |
| Type_1 | unsigned char [12] | Type name #1 |
| ... | ... | ... |
| Type_(N-1) | unsigned char [12] | Type name #N-1 |
Status codes:
0 Invalid packet - 0 is not used
1 OK (Default status)
2 Unknown error
3 Panic mode (emergency)
4 Not found (file, configuration, device etc)
5 Access denied
6 Busy
7 Time out / Connection lost
8 Overflow / Can't be reached
9 Checksum error
10 Configuration error
11 Not enough resource (memory, storage etc)
12 Illegal/Unknown instruction (or feature not implemented / Unknown command received)
13 Device not ready (starting up)
14 Manual mode (device does not accept commands)
15 Device disabled
16 Device not present
17 Device version not known
18 Hardware failure
19 Exiting / shut down in progress
GET_STATUS
| Data | Type | Description |
STT_STATUS
N/A
STP_STATUS
N/A
Implementations
POSITION type is implemented in the following files:
Contributors
This message was originally proposed in version 1.
