- Protocol Version: 3.0
- Release Date: January 20, 2017
The STATUS data type is used to notify the receiver about the current status of the sender. The data consist of status code in a 16-bit unsigned integer, sub- code in a 64-bit integer, error name in a 20-byte-length character string, and a status message. The length of the status message is determined by the size information in the general header. The status code is defined as a part of the OpenIGTLink protocol specification listed bellow. The sub-code is device specific and is defined by developers. In addition, developers can build their own error name/code into the status message and additional optional description in the following data field.
| Data | Type | Description |
|---|---|---|
| C | uint16 | Status code groups: 1-Ok, 2-Generic Error, ... (see below) |
| SUB_CODE | int64 | Sub-code for the error (ex. 0x200 - file not found) |
| ERROR_NAME | char[20] | "Error", "OK", "Warning" - can be anything, don't relay on this |
| MESSAGE | char[BODY_SIZE-30] | Optional (English) description (ex. "File C:\test.ini not found") |
- 00: Invalid packet - 0 is not used
- 01: OK (Default status)
- 02: Unknown error
- 03: Panic mode (emergency)
- 04: Not found (file, configuration, device etc)
- 05: Access denied
- 06: Busy
- 07: Time out / Connection lost
- 08: Overflow / Can't be reached
- 09: 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
| Data | Type | Description |
|---|
| |
N/A
N/A
N/A
- Junichi Tokuda