Difference between revisions of "OpenIGTLink/ProtocolV2/Type/SensorData"

From NAMIC Wiki
Jump to: navigation, search
 
(46 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
[[OpenIGTLink/ProtocolV2/Draft | << Version 2 Draft Page]]
+
[[OpenIGTLink/ProtocolV2/Index | << Version 2 Index Page]]
  
 
=Summary=
 
=Summary=
−
SDATA is a message type, which is used to transfer sensor reading, 3-axis position, velocity, acceleration, angle, angle velocity and angle acceleration. The message format is intended for manipulator control and various types of sensors.
+
SENSOR is a message type, which is used to transfer sensor reading, 3-axis position, velocity, acceleration, angle, angle velocity and angle acceleration. The message format is intended for manipulator control and various types of sensors.
  
 
=Message Types=
 
=Message Types=
Line 13: Line 13:
 
| align="left" style="background:#e0e0e0;" | Description
 
| align="left" style="background:#e0e0e0;" | Description
 
|-
 
|-
−
| align="left" | NSENSORS
+
| align="left" | LARRAY
−
| align="left" | uint16
+
| align="left" | uint8
−
| align="left" | Number of sensors
 
−
|-
 
−
| colspan=3 align="left" style="background:#e0e0e0;" |FORMAT 0
 
−
|-
 
−
| align="left" | LARRAY 0
 
−
| align="left" | uint16
 
 
| align="left" | Length of array (0-255)
 
| align="left" | Length of array (0-255)
 
|-
 
|-
−
| align="left" | UNIT 0
+
| align="left" | STATUS
−
| align="left" | int64
+
| align="left" | uint8
−
| align="left" | See bellow
+
| align="left" | Sensor status (Reserved)
−
|-
 
−
| align="left" | NAME 0
 
−
| align="left" | char[20]
 
−
| align="left" | Name
 
−
|-
 
−
| colspan=3 align="left" style="background:#f0f0f0;"|...
 
−
|-
 
−
| colspan=3 align="left" style="background:#e0e0e0;" |FORMAT (NSENSORS-1)
 
−
|-
 
−
| align="left" | LARRAY (NSENSORS-1)
 
−
| align="left" | int8
 
−
| align="left" | Length of array (0-255)
 
−
|-
 
−
| align="left" | UNIT (NSENSORS-1)
 
−
| align="left" | int64
 
−
| align="left" | see bellow
 
 
|-
 
|-
−
| align="left" | NAME (NSENSORS-1)
+
| align="left" | UNIT
−
| align="left" | char[20]
+
| align="left" | uint64
−
| align="left" | Name
+
| align="left" | See [[OpenIGTLink/ProtocolV2/Unit| 64-bit UNIT field]].
 
|-
 
|-
−
| colspan=3 align="left" style="background:#e0e0e0;" |DATA
+
| align="left" | DATA
−
|-
+
| align="left" | float64[LARRAY]
−
| align="left" | DATA 0
 
−
| align="left" | float64[LARRAY 0]
 
 
| align="left" | value array for sensor 0
 
| align="left" | value array for sensor 0
−
|-
 
−
| align="left" | DATA 1
 
−
| align="left" | float64[LARRAY 1]
 
−
| align="left" | value array for sensor 1
 
−
|-
 
−
| colspan=3 align="left" style="background:#f0f0f0;"|...
 
−
|-
 
−
| align="left" | DATA (NSENSORS-1)
 
−
| align="left" | float64[LARRAY (NSENSORS-1)]
 
−
| align="left" | value array for sensor (NSENSORS-1)
 
 
|-
 
|-
 
|}
 
|}
  
−
===Definition of UNIT field===
 
−
UNIT is a 64-bit field to specify a unit consisting of SI-prefix (e.g. milli, micro, kilo etc...) and combination of SI-base and/or SI-derived unites.
 
−
 
−
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-
 
−
  |PREFIX |  UNIT0  |  EXP0 |  UNIT1  |  EXP1 |  UNIT2  | EXP2
 
−
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-
 
−
  0              1              2              3              4
 
−
 
−
  -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 
−
  EXP2 |  UNIT3  |  EXP3 |  UNIT4  |  EXP4 |  UNIT5  |  EXP5 |
 
−
  -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 
−
  4              5              6              7
 
  
 +
===Examples===
 +
====Sending 3-axis troque====
 +
A device with 3-axis torque (N*m) sensor is sending data to a data logger program. The following table shows example data format to send 3-axis torque:
  
 
{| border="1" cellpadding="5" cellspacing="0" align="center"
 
{| border="1" cellpadding="5" cellspacing="0" align="center"
 
|-
 
|-
−
| align="left" style="background:#eeeeee;" | Value
+
| align="left" style="background:#e0e0e0;" | Data
−
| align="left" style="background:#eeeeee;" | SI-prefix
+
| align="left" style="background:#e0e0e0;" | Type
−
| align="left" style="background:#eeeeee;" | Value
+
| align="left" style="background:#e0e0e0;" | Value
−
| align="left" style="background:#eeeeee;" | SI-prefix
 
 
|-
 
|-
−
| align="left" | 0x01
+
| align="left" | LARRAY
−
| align="left" | deka (deca) (1e1)
+
| align="left" | uint8
−
| align="left" | 0xFF
+
| align="left" | 3
−
| align="left" | deci (1e-1)
 
 
|-
 
|-
−
| align="left" | 0x02
+
| align="left" | STATUS
−
| align="left" | hecto (1e2)
+
| align="left" | uint8
−
| align="left" | 0xFE
+
| align="left" | 0
−
| align="left" | centi (1e-2)
 
 
|-
 
|-
−
| align="left" | 0x03
+
| align="left" | UNIT
−
| align="left" | kilo (1e3)
+
| align="left" | uint64
−
| align="left" | 0xFD
+
| align="left" | 00000010 11000000 00010000 00000000 00000000 00000000 00000000 00000000
−
| align="left" | milli (1e-3)
 
−
|-
 
−
| align="left" | 0x06
 
−
| align="left" | mega (1e6)
 
−
| align="left" | 0xFA
 
−
| align="left" | micro (1e-6)
 
−
|-
 
−
| align="left" | 0x09
 
−
| align="left" | giga (1e9)
 
−
| align="left" | 0XF7
 
−
| align="left" | nano (1e-9)
 
−
|-
 
−
| align="left" | 0x0C
 
−
| align="left" | tera (1e12)
 
−
| align="left" | 0XF4
 
−
| align="left" | pico (1e-12)
 
−
|-
 
−
| align="left" | 0x0F
 
−
| align="left" | peta (1e15)
 
−
| align="left" | 0XF1
 
−
| align="left" | femto (1e-15)
 
−
|-
 
−
| align="left" | 0x12
 
−
| align="left" | exa (1e18)
 
−
| align="left" | 0XEE
 
−
| align="left" | atto (1e-18)
 
−
|-
 
−
| align="left" | 0x15
 
−
| align="left" | zetta (1e21)
 
−
| align="left" | 0XEB
 
−
| align="left" | zepto (1e-21)
 
 
|-
 
|-
−
|-
+
| align="left" | DATA
−
| align="left" | 0x18
+
| align="left" | double[3]
−
| align="left" | yotta (1e24)
+
| align="left" | {0.0, 0.0, 0.0}
−
| align="left" | 0XE8
 
−
| align="left" | yocto (1e-24)
 
−
|-
 
−
| align="left" | 0x00
 
−
| align="left" | None
 
−
| align="left" | --
 
−
| align="left" |--
 
 
|-
 
|-
 
|}
 
|}
  
−
====DIMENSION====
+
====Sending 3-axis force, troque and acceleration====
−
DIMENSION can consist of up to 6 unit (either SI base unit or SI derived unit) with exponents (-3 - +3)
+
By binding SENSOR data using BIND type, values from multiple types of sensors can be transferred simultaneously. See [[OpenIGTLink/ProtocolV2/Type/Bind|BIND message description page]] for detail.
  
−
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+
==GET_SENSOR==
−
      |  UNIT0  | EXP0|  UNIT1  | EXP1|  UNIT2  | EXP2|  UNIT3  | EXP3|  UNIT4  | EXP4|  UNIT5  | EXP5|
 
−
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 
−
byte 0              1              2              3              4              5
 
−
 
 
−
=====UNIT=====
 
−
UNIT0 - UNIT5 should be either one of SI base units or SI derived units shown bellow.
 
  
−
<center>SI base units</center>
 
 
{| border="1" cellpadding="5" cellspacing="0" align="center"
 
{| border="1" cellpadding="5" cellspacing="0" align="center"
 
|-
 
|-
−
| align="left" style="background:#eeeeee;" | Value
+
| align="left style="background:#e0e0e0;" | Data
−
| align="left" style="background:#eeeeee;" | SI base unit name
+
| align="left style="background:#e0e0e0;" | Type
−
| align="left" style="background:#eeeeee;" | Value
+
| align="left style="background:#e0e0e0;" | Description
−
| align="left" style="background:#eeeeee;" | SI base unit name
 
−
|-
 
−
| align="left" | 0x01
 
−
| align="left" | meter
 
−
| align="left" | 0x05
 
−
| align="left" | kelvin
 
−
|-
 
−
| align="left" | 0x02
 
−
| align="left" | gram
 
−
| align="left" | 0x06
 
−
| align="left" | mole
 
−
|-
 
−
| align="left" | 0x03
 
−
| align="left" | second
 
−
| align="left" | 0x07
 
−
| align="left" | candela
 
−
|-
 
−
| align="left" | 0x04
 
−
| align="left" | ampere
 
−
| align="left" | --
 
−
| align="left" | --
 
 
|-
 
|-
 
|}
 
|}
  
−
<center>SI derived units</center>
+
==STT_SENSOR==
 +
 
 
{| border="1" cellpadding="5" cellspacing="0" align="center"
 
{| border="1" cellpadding="5" cellspacing="0" align="center"
 
|-
 
|-
−
| align="left" style="background:#eeeeee;" | Value
+
| align="left" style="background:#e0e0e0;" | Data
−
| align="left" style="background:#eeeeee;" | Unit name
+
| align="left" style="background:#e0e0e0;" | Type
−
| align="left" style="background:#eeeeee;" | dimension
+
| align="left" style="background:#e0e0e0;" | Description
−
| align="left" style="background:#eeeeee;" | Value
 
−
| align="left" style="background:#eeeeee;" | Unit name
 
−
| align="left" style="background:#eeeeee;" | dimension
 
−
|-
 
−
| align="left" | 0x08
 
−
| align="left" | radian
 
−
| align="left" | meter/meter
 
−
| align="left" | 0x12
 
−
| align="left" | ohm
 
−
| align="left" | meter^2-kilogram/second^3-ampere^2
 
−
|-
 
−
| align="left" | 0x09
 
−
| align="left" | steradian
 
−
| align="left" | meter^2/meter^2
 
−
| align="left" | 0x14
 
−
| align="left" | siemens
 
−
| align="left" | second^3-ampere^2/meter^2-kilogram
 
−
|-
 
−
| align="left" | 0x0A
 
−
| align="left" | hertz
 
−
| align="left" | /second
 
−
| align="left" | 0x15
 
−
| align="left" | weber
 
−
| align="left" | meter^2-kilogram/second^2-ampere
 
−
|-
 
−
| align="left" | 0x0B
 
−
| align="left" | newton
 
−
| align="left" | meter-kilogram/second^2
 
−
| align="left" | 0x16
 
−
| align="left" | tesla
 
−
| align="left" | kilogram/second^2-ampere
 
−
|-
 
−
| align="left" | 0x0C
 
−
| align="left" | pascal
 
−
| align="left" | kilogram/meter-second^2
 
−
| align="left" | 0x17
 
−
| align="left" | henry
 
−
| align="left" | meter^2-kilogram/second^2-ampere^2
 
−
|-
 
−
| align="left" | 0x0D
 
−
| align="left" | joule
 
−
| align="left" | meter^2-kilogram/second^2
 
−
| align="left" | 0x18
 
−
| align="left" | lumen
 
−
| align="left" | candela-steradian
 
−
|-
 
−
| align="left" | 0x0E
 
−
| align="left" | watt
 
−
| align="left" | meter^2-kilogram/second^3
 
−
| align="left" | 0x19
 
−
| align="left" | lux
 
−
| align="left" | candela-steradian/meter^2
 
−
|-
 
−
| align="left" | 0x0F
 
−
| align="left" | coulomb
 
−
| align="left" | second-ampere
 
−
| align="left" | 0x1A
 
−
| align="left" | becquerel
 
−
| align="left" | /second
 
−
|-
 
−
| align="left" | 0x10
 
−
| align="left" | volt
 
−
| align="left" | meter^2-kilogram/second^3-ampere
 
−
| align="left" | 0x1B
 
−
| align="left" | gray
 
−
| align="left" | meter^2/second^2
 
−
|-
 
−
| align="left" | 0x11
 
−
| align="left" | farad
 
−
| align="left" | second^4-ampere^2/meter^2-kilogram
 
−
| align="left" | 0x1C
 
−
| align="left" | sievert
 
−
| align="left" | meter^2/second^2
 
 
|-
 
|-
 
|}
 
|}
  
−
===Examples===
+
<center> or </center>
−
====Sending 3-axis position====
+
 
−
A device with 3-axis force (N), 3-axis torque (N*m) and 3-axis acceleration (mm/s^2) sensors is sending data to a data logger program. The names of the sensors are "FORCE", "TORQUE", and "ACCEL." The message structure may be as follows:
 
 
{| border="1" cellpadding="5" cellspacing="0" align="center"
 
{| border="1" cellpadding="5" cellspacing="0" align="center"
 
|-
 
|-
 
| align="left" style="background:#e0e0e0;" | Data
 
| align="left" style="background:#e0e0e0;" | Data
 
| align="left" style="background:#e0e0e0;" | Type
 
| align="left" style="background:#e0e0e0;" | Type
−
| align="left" style="background:#e0e0e0;" | Value
+
| align="left" style="background:#e0e0e0;" | Description
−
|-
 
−
| align="left" | NSENSORS
 
−
| align="left" | uint16
 
−
| align="left" | 3
 
−
|-
 
−
| align="left" | LARRAY 0
 
−
| align="left" | uint8
 
−
| align="left" | 3
 
−
|-
 
−
| align="left" | PREFIX 0
 
−
| align="left" | int8
 
−
| align="left" | 0
 
−
|-
 
−
| align="left" | DIMENSION 0
 
−
| align="left" | uint8[6]
 
−
| align="left" | 0x58 0x00 0x00 0x00 0x00 0x00 (N)
 
−
|-
 
−
| align="left" | NAME0
 
−
| align="left" | char[20]
 
−
| align="left" | "FORCE"
 
−
|-
 
−
| align="left" | LARRAY 1
 
−
| align="left" | uint8
 
−
| align="left" | 3
 
−
|-
 
−
| align="left" | PREFIX 1
 
−
| align="left" | int8
 
−
| align="left" | 0
 
−
|-
 
−
| align="left" | DIMENSION 1
 
−
| align="left" | uint8[6]
 
−
| align="left" | 0x58 0x08 0x00 0x00 0x00 0x00 (N*m)
 
−
|-
 
−
| align="left" | NAME 1
 
−
| align="left" | char[20]
 
−
| align="left" | "TORQUE"
 
−
|-
 
−
| align="left" | LARRAY 2
 
−
| align="left" | uint8
 
−
| align="left" | 3
 
 
|-
 
|-
−
| align="left" | PREFIX 2
+
| align="left" | RESOL
−
| align="left" | int8
+
| align="left" | uint64
−
| align="left" | 0
+
| align="left" | Minimum interval between message (ns). Same format as [[OpenIGTLink/Timestamp|TimeStamp]]
−
|-
 
−
| align="left" | DIMENSION 2
 
−
| align="left" | uint8[6]
 
−
| align="left" | 0x08 0x03 0x00 0x00 0x00 0x00 (m/s^2)
 
−
|-
 
−
| align="left" | NAME 2
 
−
| align="left" | char[20]
 
−
| align="left" | "ACCEL"
 
−
|-
 
−
| align="left" | DATA 0
 
−
| align="left" | double[3]
 
−
| align="left" | {0.0, 0.0, 0.0}
 
−
|-
 
−
| align="left" | DATA 1
 
−
| align="left" | double[3]
 
−
| align="left" | {0.0, 0.0, 0.0}
 
−
|-
 
−
| align="left" | DATA 2
 
−
| align="left" | double[3]
 
−
| align="left" | {0.0, 0.0, 0.0}
 
 
|-
 
|-
 
|}
 
|}
  
−
==GET_SENSOR==
+
==STP_SENSOR==
 +
 
  
 
{| border="1" cellpadding="5" cellspacing="0" align="center"
 
{| border="1" cellpadding="5" cellspacing="0" align="center"
Line 351: Line 107:
 
|-
 
|-
 
|}
 
|}
−
 
−
 
−
==STT_SENSOR==
 
−
 
−
N/A
 
−
 
−
==STP_SENSOR==
 
−
 
−
N/A
 
−
 
  
 
==RTS_SENSOR==
 
==RTS_SENSOR==
  
−
N/A
+
{| 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" | Status
 +
| align="left" | 8 bit unsigned
 +
| align="left" | 0: Success 1: Error
 +
|-
 +
|}
  
 
=Implementations=
 
=Implementations=

Latest revision as of 04:44, 30 November 2011

Home < OpenIGTLink < ProtocolV2 < Type < SensorData

<< Version 2 Index Page

Summary

SENSOR is a message type, which is used to transfer sensor reading, 3-axis position, velocity, acceleration, angle, angle velocity and angle acceleration. The message format is intended for manipulator control and various types of sensors.

Message Types

SENSOR

Data Type Description
LARRAY uint8 Length of array (0-255)
STATUS uint8 Sensor status (Reserved)
UNIT uint64 See 64-bit UNIT field.
DATA float64[LARRAY] value array for sensor 0


Examples

Sending 3-axis troque

A device with 3-axis torque (N*m) sensor is sending data to a data logger program. The following table shows example data format to send 3-axis torque:

Data Type Value
LARRAY uint8 3
STATUS uint8 0
UNIT uint64 00000010 11000000 00010000 00000000 00000000 00000000 00000000 00000000
DATA double[3] {0.0, 0.0, 0.0}

Sending 3-axis force, troque and acceleration

By binding SENSOR data using BIND type, values from multiple types of sensors can be transferred simultaneously. See BIND message description page for detail.

GET_SENSOR

Data Type Description

STT_SENSOR

Data Type Description
or
Data Type Description
RESOL uint64 Minimum interval between message (ns). Same format as TimeStamp

STP_SENSOR

Data Type Description

RTS_SENSOR

Data Type Description
Status 8 bit unsigned 0: Success 1: Error

Implementations

The TDATA message type is implemented in the following source code.

Contributors

Junichi Tokuda, Yuichiro Hayashi

Comments

Retrieved from "https://www.na-mic.org/w/index.php?title=OpenIGTLink/ProtocolV2/Type/SensorData&oldid=72185"