OpenIGTLink/Protocol/BWHScannerIF

From NAMIC Wiki
Jump to: navigation, search
Home < OpenIGTLink < Protocol < BWHScannerIF

From 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