Difference between revisions of "OpenIGTLink/Protocol/BWHScannerIF"
From NAMIC Wiki
| Line 12: | Line 12: | ||
=From Scanner to Client= | =From Scanner to Client= | ||
| − | |||
*'''IMAGE''' | *'''IMAGE''' | ||
| + | |||
| + | *STATUS | ||
| + | |||
| + | Code and Status name field are used to report the status of the scanner. | ||
| + | |||
| + | Bytes (Body) | ||
| + | 58 60 68 88 | ||
| + | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+--+-+-+..... | ||
| + | | C | Sub Code | Status name | Status message (optional) | ||
| + | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+--+-+-+..... | ||
| + | |||
| + | The list of subcode and status name | ||
| + | |||
| + | {| border="1" cellpadding="5" cellspacing="0" | ||
| + | |- | ||
| + | | align="left style="background:#e0e0e0;" | Sub code | ||
| + | | align="left style="background:#e0e0e0;" | Status name | ||
| + | | align="left style="background:#e0e0e0;" | Description | ||
| + | |- | ||
| + | | align="left" | 0 | ||
| + | | align="left" | ERROR | ||
| + | | align="left" | error | ||
| + | |- | ||
| + | | align="left" | 1 | ||
| + | | align="left" | IDLE | ||
| + | | align="left" | scanner is idle | ||
| + | |- | ||
| + | | align="left" | 2 | ||
| + | | align="left" | START_UP | ||
| + | | align="left" | starting up | ||
| + | |- | ||
| + | | align="left" | 3 | ||
| + | | align="left" | SCANNING | ||
| + | | align="left" | scanning | ||
| + | |- | ||
| + | | align="left" | 4 | ||
| + | | align="left" | PAUSE | ||
| + | | align="left" | Optional (English) description (ex. "File C:\test.ini not found") | ||
| + | |- | ||
| + | |} | ||
| + | |||
| + | |||
| + | '''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 /> | ||
| + | |||
| + | * Back to [[OpenIGTLink]] | ||
Revision as of 14:11, 18 November 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
- *PARAMETER (Currently not available)
- Set parameter for the scanner
From Scanner to Client
- IMAGE
- STATUS
Code and Status name field are used to report the status of the scanner.
Bytes (Body) 58 60 68 88 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+--+-+-+..... | C | Sub Code | Status name | Status message (optional) +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+--+-+-+.....
The list of subcode and status name
| Sub code | Status name | Description |
| 0 | ERROR | error |
| 1 | IDLE | scanner is idle |
| 2 | START_UP | starting up |
| 3 | SCANNING | scanning |
| 4 | PAUSE | Optional (English) description (ex. "File C:\test.ini not found") |
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
- Back to OpenIGTLink
