Difference between revisions of "ProstateBRP OpenIGTLink Communication June 2013"
From NAMIC Wiki
| Line 73: | Line 73: | ||
if (not receive STATUS(XXXXX, Code:??:??) within 10s) failure | if (not receive STATUS(XXXXX, Code:??:??) within 10s) failure | ||
| − | ===Test | + | ===Test 2: Start-up without connecting the device to the robot control computer=== |
| + | Before start, unplug one of the sensors or actuators from the robot control computer. | ||
| + | |||
| + | send STRING(CMD, START-UP) | ||
| + | if (not receive STRING(ACK, START-UP) within 100ms) failure | ||
| + | if (not receive STATUS(DNP) within 10s) failure | ||
| + | |||
| + | DNP: Device Not Present (code 17) | ||
| + | |||
| + | ===Test 3: === | ||
==Diagram== | ==Diagram== | ||
Revision as of 18:48, 20 June 2013
Home < ProstateBRP OpenIGTLink Communication June 2013The following table shows message exchange diagram for the communication between 3D Slicer (and other navigation software) and the robot in each workhpase.
Contents
Notations
- STRING(NN, SS) (see http://openigtlink.org/protocols/v2_string.html)
- NN: Device name in the OpenIGTLink header. (Max. 20 bytes)
- SS: String in the message body. (Max. 65536 bytes)
- STATE(NN, CC:SS:EE:MM) (see http://openigtlink.org/protocols/v2_status.html )
- NN: Device type in the OpenIGTLink header. (Max. 20 bytes)
- CC: Code
- SS: Subcode
- EE: Error name (Max 20 bytes) -- no predefined name. It will logged or show up on navigation screen as it is.
- MM: Message -- no predefined text. It will logged or show up on navigation screen as it is.
- TRANSFORM(NN, TT) (see http://openigtlink.org/protocols/v2_transform.html)
- NN: Device type in the OpenIGTLink header. (Max. 20 bytes)
- TT: 4x4 linear transformation matrix
Quality Assurance Protocol
Simulator software for QA will be hosted in https://github.com/ProstateBRP. The following tests are described as pseudo code for navigation software.
Test 1: Normal Operation Test
send STRING(CMD, START-UP) if (not receive STRING(ACK, START-UP) within 100ms) failure if (not receive STATUS(OK) within 10s) failure send STRING(CMD, PLANNING) if (not receive STRING(ACK, PLANNING) within 100ms) failure send STRING(CMD, CALIBRATION) if (not receive STRING(ACK, CALIBRATION) within 100ms) failure send TRANSFORM(CLB, matrix1) if (not receive TRANSFORM(ACK, matrix2) within 100ms) failure if (matrix1 != matrix2) failure if (not receive STATUS(CALIBRATION, OK) within 10s) failure send STRING(CMD, TARGETING) if (not receive STRING(ACK, TARGETING) within 100ms) failure if (not receive STATUS(TARGETING, OK) within 10s) failure send TRANSFORM(TGT, matrix3) if (not receive TRANSFORM(ACK, matrix4) within 100ms) failure if (matrix3 != matrix4) failure if (not receive STATUS(TARGET, OK) within 10s) failure if (not receive TRANSFORM(TARGET, matrix5) within 20s) failure if (matrix3 != matrix5) failure send STRING(CMD, MOVE_TO_TARGET) if (not receive STRING(ACK, MOVE_TO_TARGET) within 100ms) failure if (not start receiving TRANSFORM(CURRENT_POSITION, matrix 6) in 10s) failure if (not receive STATUS(MOVE_TO_TARGET, OK) within 100ms after the robot reaches the target) failure if (not receive TRANSFORM(CURRENT_POSITION, matrix 7) within 100ms after the status message is received) failure if (matrix 7 does not match the current position of the robot) failure send STRING(CMD, MANUAL) if (not receive STRING(ACK, MANUAL) within 100ms) failure if (not receive STATUS(MANUAL, OK) within 10s) failure send STRING(CMD, STOP) if (not receive STRING(ACK, STOP) within 100ms) failure if (not receive STATUS(STOP, OK) within 10s) failure send STRING(CMD, EMERGENCY) if (not receive STRING(ACK, EMERGENCY) within 100ms) failure if (not receive STATUS(EMERGENCY, Emergency) within 10s) failure send GET_TRANSFORM(CURRENT_POSITION) if (not receive TRANSFORM(CURRENT_POSITION, matrix8) within 10s) failure if (matrix 8 does not match the current position of the robot) failure send GET_STATUS(CURRENT_STATUS) if (not receive STATUS(XXXXX, Code:??:??) within 10s) failure
Test 2: Start-up without connecting the device to the robot control computer
Before start, unplug one of the sensors or actuators from the robot control computer.
send STRING(CMD, START-UP) if (not receive STRING(ACK, START-UP) within 100ms) failure if (not receive STATUS(DNP) within 10s) failure
DNP: Device Not Present (code 17)
Test 3:
Diagram
| 3D Slicer (operator) | Message | Robot Controller | Radiologist | Note |
| Start-up | ||||
| The operator presses "Start-up" button | ||||
| Send command to robot | >> STRING(CMD_XXXX, START_UP) >> | XXXX is a unique query ID (string of any ASCII letters up to 16 bytes) | ||
| << STRING(ACK_XXXX, START_UP) << | Echo back an acknowledgement command was received, but not yet completed | XXXX is the same unique query ID as the START_UP message. | ||
| Start up and initialize the hardware. Run the robot homing procedure if necessary (skip if already successfully completed). Move robot to home (loading) configuration. | ||||
| << STATUS(START_UP, Code:??:??) << | Code=OK: Confirm when robot is initialized Code>=3: Error. See error list |
|||
| Display the result of start up process. | ||||
| Planning | ||||
| The operator opens the planning panel | ||||
| >> STRING(CMD_XXXX, PLANNING) >> | XXXX is a unique query ID (string of any ASCII letters up to 16 bytes) | |||
| << STRING(ACK_XXXX, PLANNING) << | Echo back an acknowledgement command was received | XXXX is the same unique query ID as the PLANNING message. | ||
| Do nothing except keep track of current state, robot is awaiting next workphase. | ||||
| Show that the robot is in PLANNING phase. | ||||
| Calibration | ||||
| The operator opens the calibration panel | ||||
| >> STRING(CMD_XXXX, CALIBRATION) >> | XXXX is a unique query ID (string of any ASCII letters up to 16 bytes) | |||
| << STRING(ACK_XXXX, CALIBRATION) << | Echo back an acknowledgement command was received | XXXX is the same unique query ID as the CALIBRATION message. | ||
| Do nothing except keep track of current state, robot is awaiting calibration transform | ||||
| Show that the robot is in CALIBRATION phase. | ||||
| Nav Software (3D Slicer or RadVision) calculates calibration matrix | ||||
| >> TRANSFORM(CLB_XXXX, 4x4 calibration matrix in RAS coordinates) >> | XXXX is a unique query ID (string of any ASCII letters up to 16 bytes) | |||
| << TRANSFORM(ACK_XXXX, Calibration matrix in RAS coordinates) << | Echo back an acknowledgement transform was received | XXXX is the same unique query ID as the CLB message. | ||
| Update calibration transform, set flag that registration has been set externally, reply with confirmation | ||||
| << STATUS(CALIBRATION, Code:??:??) << | Code=OK: Confirm that calibration was received and robot is ready for next workphase Code=CE: Error. |
CE: Configuration Error (code 11) | ||
| Show that calibration successfully sent to robot or failed. | ||||
| Targeting | ||||
| The operator enters "Targeting" mode | ||||
| >> STRING(CMD_XXXX, TARGETING) >> | XXXX is a unique query ID (string of any ASCII letters up to 16 bytes) | |||
| << STRING(ACK_XXXX, TARGETING) << | Acknowledge receiving targeting command | XXXX is the same unique query ID as the TARGETING message. | ||
| Confirm if robot is ready for targeting; check if calibration was received; return robot to home (loading) position, if needed. | ||||
| << STATUS(TARGETING, Code:??:??) << | Code=OK: Confirm robot has entered targeting mode. Code=DNR: If not able to enter targeting mode (i.e. calibration not received) |
DNR: Device Not Ready (code 13) | ||
| The operator select a target, Nav software creates a 4x4 matrix for desired 6-DOF robot pose to reach the target | ||||
| >> TRANSFORM(TGT_XXXXX, 4x4 target matrix in RAS coordinates) >> | XXXX is a unique query ID (string of any ASCII letters up to 16 bytes). The unique ID may be used as a human-readable target name on the robot control software. For example, TGT_LeftApex-2 is for the second targeting attempt on a lesion in the left-apex. | |||
| << TRANSFORM(ACK_XXXXX, 4x4 target matrix) << | Acknowledge receipt of target transformation by echoing back | XXXX is the same unique query ID as the TARGETING message. | ||
| Calculate if target pose is reachable based on the kinematics, reply with status and set target | ||||
| << STATUS(TARGET, Code:??:??) << | Code=OK: Reply with OK if target was accepted Code=DNR: Not in targeting mode Code=CE: Not a valid target (i.e. out of workspace) |
DNR: Device Not Ready (code 13) CE: Configuration Error (code 10) | ||
| << TRANSFORM(TARGET, 4x4 target matrix) << | Send actual target pose in robot controller if one was set (corresponds to when status comes back OK) | |||
| Display the reachable target position set in robot controller. | ||||
| The operator confirms the target position set in the controller, and press "MOVE" | ||||
| >> STRING(CMD_XXXX, MOVE_TO_TARGET) >> | XXXX is a unique query ID (string of any ASCII letters up to 16 bytes) | |||
| << STRING(ACK_XXXX, MOVE_TO_TARGET) << | Echo back an acknowledgement command was received (not yet completed) | XXXX is the same unique query ID as the MOVE_TO_TARGET message. | ||
| Alert the clinician to hold footpedal to align the robot | Clinician engages interlock (footpedal in scanner room) to enable robot motion. Robot will only move when interlock is engaged following a move command. | |||
| The robot moves to the target and streams its pose during motion | ||||
| << TRANSFORM(CURRENT_POSITION, Current robot pose matrix in RAS coordinates) << | Stream current robot pose in RAS coords as moving. Can also be requested (see below). | |||
| Display the current robot position as it moves toward the target. | ||||
| Display that the robot is at the target. Send confirmation. | ||||
| << STATUS(MOVE_TO_TARGET, Code:??:??) << | Code=OK: Robot reaches target Code >= 3: Return error code when the device fails to move to the target. See error list |
|||
| << TRANSFORM(CURRENT_POSITION, Current robot pose matrix in RAS coordinates) << | Push out final robot pose in RAS coords as moving. (same format as previous stream - ensures last one is at final position) | |||
| Display the current final robot position at the target. | ||||
| Needle Insertion (Manual) | ||||
| Ask to lock the robot | ||||
| The operator presses "Lock" button | ||||
| >> STRING (CMD_XXXX, MANUAL) >> | XXXX is a unique query ID (string of any ASCII letters up to 16 bytes) | |||
| << STRING(ACK_XXXX, MANUAL) << | Echo back an acknowledgement command was received (not yet completed) | XXXX is the same unique query ID as the MANUAL message. | ||
| Cut motor power to prevent motion of the robot base. This also eliminates causes of MR interference for insertion under live imaging. | ||||
| << STATUS(MANUAL, OK:??:??) << | Reply with OK when robot is in a safe, locked state | |||
| Insert a needle, optionally under live MR imaging. Perform intervention with the needle (biopsy or seed placement). | ||||
| Retract the needle | ||||
| Ask to unlock the robot and confirm needle is retracted | ||||
| The operator presses "Unlock" | ||||
| Return to the TARGETING phase (Slicer sends STRING(ACK_XXXXX, TARGETING) ) | ||||
| All workhpases | ||||
| The operator presses "Stop" button | ||||
| >> STRING(CMD_XXXX, STOP) >> | XXXX is a unique query ID (string of any ASCII letters up to 16 bytes) | |||
| << STRING(ACK_XXXX, STOP) << | Acknowledge receiving targeting command | XXXX is the same unique query ID as the STOP message. | ||
| The robot stops all motion. Stays in current state/workphase. | ||||
| << STATUS(STOP, OK:??:??) << | Reply with OK when robot stopped safely. | |||
| All workhpases | ||||
| The operator presses "Emergency" button | ||||
| >> STRING(CMD_XXXX, EMERGENCY) >> | XXXX is a unique query ID (string of any ASCII letters up to 16 bytes) | |||
| << STRING(ACK_XXXX, EMERGENCY) << | Acknowledge receiving targeting command | XXXX is the same unique query ID as the STOP message. | ||
| The robot stops all motion and disables/locks motors. Switches to Emergency state/workphase. ?? IS THIS THE DESIRED ACTION | ||||
| << STATUS(EMERGENCY, Emergency:??:??) << | Reply with OK when robot stopped safely. | |||
| All workhpases | ||||
| Request current robot pose (or target or calibration transforms) | ||||
| >> GET_TRANSFORM(CURRENT_POSITION) >> | ||||
| The robot transmits current pose ("CURRENT_POSITION") through IGTLink upon request. This also works for requesting "TARGET_POSITION" and "CALIBRATION" transforms stored in robot controller. | ||||
| << TRANSFORM(CURRENT_POSITION, Current robot pose matrix in RAS coordinates) << | ||||
| All workhpases | ||||
| Request the robot status/workphase | ||||
| >> GET_STATUS(CURRENT_STATUS) >> ?? CONFIRM COMMAND STRUCTURE FOR STATUS REQUEST | ||||
| Sends current state/workphase. ?? SHOULD IT SEND OTHER INFO TOO | ||||
| << STATUS(XXXXX, Code:??:??) << | Send status code. error list | XXXXX is workphase (e.g. TARGETING) | ||
| All workhpases | ||||
| Robot controller sends errors or notifications through IGTLink. Transmitted asynchronously with error text in message body. To be used with limit events, hardware failures, invalid commands, etc. | ||||
| << STATUS(ERROR, Code:??:Error name) << | | align="left" | Send status code. error list | |||
