|
|
| (302 intermediate revisions by 9 users not shown) |
| Line 1: |
Line 1: |
| − | =Overview= | + | <font color=red>The OpenIGTLink official web page has moved to http://openigtlink.org/</font> |
| − | =Protocol=
| |
| | | | |
| − | ===Header Structure===
| + | Please click [[OpenIGTLink_OldPage|here]] to visit the old page. |
| − | Bytes
| |
| − | 0 2 14 34 42 50
| |
| − | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+--+-+-+.....
| |
| − | | V | TYPE | DEVICE_NAME | BODY_SIZE | CRC | BODY
| |
| − | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+--+-+-+.....
| |
| − | | |
| − | ===Byte Order===
| |
| − | Big endian should be used.
| |
| − | | |
| − | ===Header Fields===
| |
| − | {| border="1" cellpadding="5" cellspacing="0" align="center"
| |
| − | |-
| |
| − | | align="left style="background:#e0e0e0;" | Data
| |
| − | | align="left style="background:#e0e0e0;" | Type
| |
| − | | align="left style="background:#e0e0e0;" | Description
| |
| − | |-
| |
| − | | align="left" | V
| |
| − | | align="left" | Unsigned short (16bit)
| |
| − | | align="left" | Version number (1)
| |
| − | |-
| |
| − | | align="left" | TYPE
| |
| − | | align="left" | char[8]
| |
| − | | align="left" | Type name of body
| |
| − | |-
| |
| − | | align="left" | DEVICE_NAME
| |
| − | | align="left" | char[20]
| |
| − | | align="left" | Unique device name
| |
| − | |-
| |
| − | | align="left" | BODY_SIZE
| |
| − | | align="left" | 64 bit unsigned int
| |
| − | | align="left" | Size of body in bytes
| |
| − | |-
| |
| − | | align="left" | CRC
| |
| − | | align="left" | 64 bit unsigned int
| |
| − | | align="left" | 64 bit CRC for body data
| |
| − | |-
| |
| − | |}
| |
| − | | |
| − | = Message types =
| |
| − | | |
| − | ===IMAGE===
| |
| − | ===TRANSFORM===
| |
| − | ===POSITION===
| |
| − | ===STATUS===
| |
| − | Bytes (Body)
| |
| − | 50 52 60 80
| |
| − | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+--+-+-+.....
| |
| − | | C | Sub Code | Status name | Status message (optional)
| |
| − | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+--+-+-+.....
| |
| − | | |
| − | {| border="1" cellpadding="5" cellspacing="0"
| |
| − | |-
| |
| − | | align="left style="background:#e0e0e0;" | Data
| |
| − | | align="left style="background:#e0e0e0;" | Type
| |
| − | | align="left style="background:#e0e0e0;" | Description
| |
| − | |-
| |
| − | | align="left" | C
| |
| − | | align="left" | Unsigned short (16bit)
| |
| − | | align="left" | Status code groups: 1-Ok, 2-Generic Error, ... (see below)
| |
| − | |-
| |
| − | | align="left" | Sub Code
| |
| − | | align="left" | 64 bit integer
| |
| − | | align="left" | Sub code for the error (ex. 0x200 - file not found)
| |
| − | |-
| |
| − | | align="left" | Error name
| |
| − | | align="left" | char[20] | |
| − | | align="left" | "Error", "Ok", "Starting up" - can be anything, don't relay on this
| |
| − | |-
| |
| − | | align="left" | Status Message (optional)
| |
| − | | align="left" | char[ BodySize - 30 ]
| |
| − | | align="left" | Optional (English) description (ex. "File C:\test.ini not found")
| |
| − | |-
| |
| − | |}
| |
| − | | |
| − | | |
| − | '''Status codes:'''<br />
| |
| − | 0 No Errors Found (use status 1 instead!)<br />
| |
| − | 1 OK (Default status)<br />
| |
| − | 2 Unknown error<br />
| |
| − | 3 Panic mode (emergency)<br />
| |
| − | 4 Not found (file, configuration, device etc)<br />
| |
| − | 5 Access denied<br />
| |
| − | 6 Busy<br />
| |
| − | 7 Time out / Connection lost<br />
| |
| − | 8 Overflow / Can't be reached<br />
| |
| − | 9 Checksum error<br />
| |
| − | 10 Configuration error<br />
| |
| − | 11 Not enough resource (memory, storage etc)<br />
| |
| − | 12 Illegal/Unknown instruction (or feature not implemented)<br />
| |
| − | 13 Device not ready (starting up)<br />
| |
| − | 14 Manual mode (device does not accept commands)<br />
| |
| − | 15 Device disabled<br />
| |
| − | 16 Device not present<br />
| |
| − | 17 Device version not known<br />
| |
| − | 18 Hardware failure<br />
| |
| − | 19 Exiting / shut down in progress<br />
| |
| − | <br />
| |
