Difference between revisions of "OpenIGTLink/Protocol/BWHScannerIF"
From NAMIC Wiki
| (8 intermediate revisions by the same user not shown) | |||
| Line 3: | Line 3: | ||
*'''POSITION''' | *'''POSITION''' | ||
**Center position and orientation of the imaging plane | **Center position and orientation of the imaging plane | ||
| + | **RAS coordinate in default | ||
*'''GET_STATUS''' | *'''GET_STATUS''' | ||
**Get status of the scanner | **Get status of the scanner | ||
| − | *'''* | + | *'''*START''' |
| + | **Start image transfer | ||
| + | |||
| + | *'''*STOP''' | ||
| + | **Stop image transfer | ||
| + | |||
| + | <!-- | ||
| + | *'''*GET_PARAM''' (Currently not available) | ||
| + | **Get imaging parameter | ||
| + | |||
| + | *'''*SET_PARAM''' (Currently not available) | ||
**Set parameter for the scanner | **Set parameter for the scanner | ||
| + | --> | ||
| + | |||
| + | =From Scanner to Client= | ||
| + | |||
| + | *'''IMAGE''' | ||
| + | **Center position and orientation of the imaging plane | ||
| + | **RAS coordinate in default | ||
| + | |||
| + | *'''*PARAM''' | ||
| + | **Returns imaging parameter(s) to the client | ||
| + | |||
| + | |||
| + | *'''STATUS''' | ||
| + | |||
| + | The message follows the standard '''STATUS''' data type. | ||
| + | Bytes (Body) | ||
| + | 58 60 68 88 | ||
| + | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+--+-+-+..... | ||
| + | | C | Sub Code | Status name | Status message (optional) | ||
| + | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+--+-+-+..... | ||
| + | |||
| + | |||
| + | |||
| + | '''Status codes:'''<br /> | ||
| + | 0 Invalid packet - 0 is not used<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 / Unknown command received)<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 /> | ||
| + | |||
| + | =Discussion= | ||
| + | *Scanner should provide position range etc. | ||
| + | |||
| + | |||
| + | * Back to [[OpenIGTLink]] | ||
Latest revision as of 21:00, 9 December 2008
Home < OpenIGTLink < Protocol < BWHScannerIFFrom Client to Scanner
- POSITION
- Center position and orientation of the imaging plane
- RAS coordinate in default
- GET_STATUS
- Get status of the scanner
- *START
- Start image transfer
- *STOP
- Stop image transfer
From Scanner to Client
- IMAGE
- Center position and orientation of the imaging plane
- RAS coordinate in default
- *PARAM
- Returns imaging parameter(s) to the client
- STATUS
The message follows the standard STATUS data type.
Bytes (Body) 58 60 68 88 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+--+-+-+..... | C | Sub Code | Status name | Status message (optional) +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+--+-+-+.....
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
Discussion
- Scanner should provide position range etc.
- Back to OpenIGTLink
