Number of revolutions per minute.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Value | value | rpm | int16_t | Number of revolutions per minute. | Same as field type |
Report of electrical voltage.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Measured Voltage Value | value | V | fp32_t | The value of the internal electrical voltage as measured by the sensor. | Same as field type |
Report of electrical current.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Measured Current Value | value | A | fp32_t | The value of the internal electrical current as measured by the sensor. | Same as field type |
Report of a GPS fix.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Validity | validity | Bitfield (Bitfield Validity) | uint16_t | Validity of fields. | Same as field type |
| Type | type | Enumerated (Enum Type) | uint8_t | Type of fix. | Same as field type |
| UTC Year | utc_year | - | uint16_t | UTC year. | Same as field type |
| UTC Month | utc_month | - | uint8_t | UTC month. | Same as field type |
| UTC Day | utc_day | - | uint8_t | UTC day. | Same as field type |
| UTC Time of Fix | utc_time | s | fp32_t | UTC time of the GPS fix measured in seconds since 00:00:00 (midnight). | Same as field type |
| Latitude WGS-84 | lat | rad | fp64_t | WGS-84 Latitude coordinate. | min=-1.5707963267948966, max=1.5707963267948966 |
| Longitude WGS-84 | lon | rad | fp64_t | WGS-84 Longitude coordinate. | min=-3.141592653589793, max=3.141592653589793 |
| Height above WGS-84 ellipsoid | height | m | fp32_t | Height above WGS-84 ellipsoid. | Same as field type |
| Number of Satellites | satellites | - | uint8_t | Number of satellites used by the GPS device to compute the solution. | Same as field type |
| Course Over Ground | cog | rad | fp32_t | Course Over Ground (true). | Same as field type |
| Speed Over Ground | sog | m/s | fp32_t | Speed Over Ground. | Same as field type |
| Horizontal Dilution of Precision | hdop | - | fp32_t | Horizontal dilution of precision. | Same as field type |
| Vertical Dilution of Precision | vdop | - | fp32_t | Vertical dilution of precision. | Same as field type |
| Horizontal Accuracy Estimate | hacc | m | fp32_t | Horizontal Accuracy Estimate. | Same as field type |
| Vertical Accuracy Estimate | vacc | m | fp32_t | Vertical Accuracy Estimate. | Same as field type |
Validity of fields.
| Value | Name | Abbreviation | Description |
|---|---|---|---|
| 0x0001 | Valid Date | VALID_DATE | Fields ‘utc_year’, ‘utc_month’ and ‘utc_day’ are valid. |
| 0x0002 | Valid Time | VALID_TIME | Field ‘utc_time’ is valid. |
| 0x0004 | Valid Position | VALID_POS | Fields ‘lat’, ‘lon’, ‘altitude’ and ‘satellites’ are valid. |
| 0x0008 | Valid Course Over Ground | VALID_COG | Field ‘cog’ is valid. |
| 0x0010 | Valid Speed Over Ground | VALID_SOG | Field ‘sog’ is valid. |
| 0x0020 | Valid Horizontal Accuracy Estimate | VALID_HACC | Field ‘hacc’ is valid. |
| 0x0040 | Valid Vertical Accuracy Estimate | VALID_VACC | Field ‘vacc’ is valid. |
| 0x0080 | Valid Horizontal Dilution of Precision | VALID_HDOP | Field ‘hdop’ is valid. |
| 0x0100 | Valid Vertical Dilution of Precision | VALID_VDOP | Field ‘vdop’ is valid. |
Type of fix.
| Value | Name | Abbreviation | Description |
|---|---|---|---|
| 0x00 | Stand Alone | STANDALONE | Stand alone solution. |
| 0x01 | Differential | DIFFERENTIAL | Differential solution. |
| 0x02 | Dead Reckoning | DEAD_RECKONING | Dead reckoning solution. |
| 0x03 | Manual Input | MANUAL_INPUT | Manual solution. |
| 0x04 | Simulation | SIMULATION | Simulated solution. |
Report of spatial orientation according to SNAME’s notation (1950).
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Device Time | time | s | fp64_t | The device time. | Same as field type |
| Roll Angle | phi | rad | fp64_t | Rotation around the vehicle longitudinal axis. | min=-3.141592653589793, max=3.141592653589793 |
| Pitch Angle | theta | rad | fp64_t | Rotation around the vehicle lateral or transverse axis. | min=-1.57079632679490, max=1.57079632679490 |
| Yaw Angle (True) | psi | rad | fp64_t | Rotation around the vehicle vertical axis. A value of 0 means the vehicle is oriented towards true north. In cases where the sensor cannot measure the true heading, this field will have the same value as Yaw (Magnetic). | min=-3.141592653589793, max=3.141592653589793 |
| Yaw Angle (Magnetic) | psi_magnetic | rad | fp64_t | Rotation around the vehicle vertical axis. A value of 0 means the vehicle is oriented towards magnetic north. In cases where the sensor cannot measure the magnetic heading, this field will have the same value as Yaw (True). | min=-3.141592653589793, max=3.141592653589793 |
Component of incremetal orientation vector over a period of time.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Device Time | time | s | fp64_t | The device time. | Same as field type |
| X | x | rad | fp64_t | X component. | Same as field type |
| Y | y | rad | fp64_t | Y component. | Same as field type |
| Z | z | rad | fp64_t | Z component. | Same as field type |
| Timestep | timestep | s | fp32_t | Period of time of the orientation vector increments. | Same as field type |
Vector quantifying the direction and magnitude of the measured angular velocity that a device is exposed to.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Device Time | time | s | fp64_t | The device time. | Same as field type |
| X | x | rad/s | fp64_t | X component. | Same as field type |
| Y | y | rad/s | fp64_t | Y component. | Same as field type |
| Z | z | rad/s | fp64_t | Z component. | Same as field type |
Vector quantifying the direction and magnitude of the measured acceleration that a device is exposed to.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Device Time | time | s | fp64_t | The device time. | Same as field type |
| X | x | m/s/s | fp64_t | X component. | Same as field type |
| Y | y | m/s/s | fp64_t | Y component. | Same as field type |
| Z | z | m/s/s | fp64_t | Z component. | Same as field type |
Vector quantifying the direction and magnitude of the measured magnetic field that a device is exposed to.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Device Time | time | s | fp64_t | The device time. | Same as field type |
| X | x | G | fp64_t | X component. | Same as field type |
| Y | y | G | fp64_t | Y component. | Same as field type |
| Z | z | G | fp64_t | Z component. | Same as field type |
Vector quantifying the direction and magnitude of the measured velocity relative to the ground that a device is exposed to.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Validity | validity | Bitfield (Bitfield Validity) | uint8_t | Each bit of this field represents if a given velocity component is valid. | Same as field type |
| X | x | m/s | fp64_t | X component. | Same as field type |
| Y | y | m/s | fp64_t | Y component. | Same as field type |
| Z | z | m/s | fp64_t | Z component. | Same as field type |
Each bit of this field represents if a given velocity component is valid.
| Value | Name | Abbreviation | Description |
|---|---|---|---|
| 0x01 | X component is valid | VEL_X | - |
| 0x02 | Y component is valid | VEL_Y | - |
| 0x04 | Z component is valid | VEL_Z | - |
Vector quantifying the direction and magnitude of the measured velocity relative to the water that a device is exposed to.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Validity | validity | Bitfield (Bitfield Validity) | uint8_t | Each bit of this field represents if a given velocity component is valid. | Same as field type |
| X | x | m/s | fp64_t | X component. | Same as field type |
| Y | y | m/s | fp64_t | Y component. | Same as field type |
| Z | z | m/s | fp64_t | Z component. | Same as field type |
Each bit of this field represents if a given velocity component is valid.
| Value | Name | Abbreviation | Description |
|---|---|---|---|
| 0x01 | X component is valid | VEL_X | - |
| 0x02 | Y component is valid | VEL_Y | - |
| 0x04 | Z component is valid | VEL_Z | - |
Component of incremetal velocity vector.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Device Time | time | s | fp64_t | The device time. | Same as field type |
| X | x | m/s | fp64_t | X component. | Same as field type |
| Y | y | m/s | fp64_t | Y component. | Same as field type |
| Z | z | m/s | fp64_t | Z component. | Same as field type |
Distance measurement detected by the device.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Validity | validity | Enumerated (Enum Validity) | uint8_t | Validity of the measurement. | Same as field type |
| Location | location | - | message-list (Device State) | Device Location in the system. | Same as field type |
| Beam Configuration | beam_config | - | message-list (Beam Configuration) | Beam configuration of the device. | Same as field type |
| Measured Distance | value | m | fp32_t | Measured distance. | Same as field type |
Validity of the measurement.
| Value | Name | Abbreviation | Description |
|---|---|---|---|
| 0 | Invalid | INVALID | Measurement is invalid. |
| 1 | Valid | VALID | Measurement is valid. |
Report of temperature.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Measured Temperature | value | °C | fp32_t | The value of the temperature as measured by the sensor. | Same as field type |
Report of external pressure.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Measured Pressure | value | hPa | fp64_t | The value of the pressure as measured by the sensor. | Same as field type |
Depth report.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Measured Depth | value | m | fp32_t | Depth value measured by a sensor. | Same as field type |
Report of Depth Offset.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Measured Offset | value | m | fp32_t | Depth offset. | Same as field type |
Sound Speed report.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Computed Sound Speed | value | m/s | fp32_t | Estimated sound speed. Negative values denote invalid estimates. | Same as field type |
Water Density report.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Computed Water Density | value | kg/m/m/m | fp32_t | Computed Water Density. | Same as field type |
Report of conductivity.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Measured Conductivity | value | S/m | fp32_t | The value of the conductivity as measured by the sensor. | Same as field type |
Report of salinity.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Measured Salinity | value | - | fp32_t | The value of the salinity as measured by the sensor. | Same as field type |
Measurement of wind speed.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Direction | direction | rad | fp32_t | Direction of the measured wind speed. | Same as field type |
| Speed | speed | m/s | fp32_t | The value of the wind speed as measured by the sensor. | Same as field type |
| Turbulence | turbulence | m/s | fp32_t | Wind turbulence intensity. | Same as field type |
Measurement of relative humidity.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Relative Humidity Value | value | - | fp32_t | Value of relative humidity. | min=0, max=100 |
Verbatim representation of device data in plain text format.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Value | value | - | plaintext | Plain text data as extracted directly from the device. | Same as field type |
Verbatim representation of device data in binary format.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Value | value | - | rawdata | Raw binary data as extracted directly from the device. | Same as field type |
Force measurement.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Measured Force | value | N | fp32_t | Force magnitude. | Same as field type |
This message contains the data acquired by a single sonar measurement. The following describes the format used to fill the data field used in this message. (Byte order is little endian.)
Sidescan:
| Data | Name | Type |
|---|---|---|
| A | Ranges data | uintX_t |
Multibeam:
| Index | Section | Name | Type | Comments |
|---|---|---|---|---|
| 1 | H1 | Number of points | uint16_t | Number of data points |
| 2 | H2 | Start angle | fp32_t | In radians |
| 3 | H3 | Flags | uint8_t | Refer to next table |
| 4 | H4 ? | Angle scale factor | fp32_t | Used for angle steps in radians |
| 5 | H5 ? | Intensities scale factor | fp32_t | |
| 6 | D1 ? | Angle steps[H1] | uint16_t | Values in radians |
| 7 | D2 | Ranges[H1] | uintX_t | Ranges data points (scale factor from common field “Scaling Factor”) |
| 8 | D3 ? | Intensities[H1] | uintX_t | Intensities data points |
| Section | Flag Label | Bit |
|---|---|---|
| H4.1 | Intensities flag | 0 |
| H4.2 | Angle step flag | 1 |
Notes:
angle[i] = H2_start_angle + (32-bit sum of D1_angle_step[0] through D1_angle_step[i]) * H4_scaling_factor
How to write ranges and intensities data:
1 2 3 4 5 6 | data_unit = (Integer) (data_value / scale_factor);
bytes_per_unit = bits_per_unit / 8;
LOOP: i = 0, until i = bytes_per_unit
byte[i] = (data_unit >> 8 * i) & 0xFF);
write(byte);
|
Common:
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Type | type | Enumerated (Enum Type) | uint8_t | Type of sonar. | Same as field type |
| Frequency | frequency | Hz | uint32_t | Operating frequency. | Same as field type |
| Minimum Range | min_range | m | uint16_t | Minimum range. | Same as field type |
| Maximum Range | max_range | m | uint16_t | Maximum range. | Same as field type |
| Bits Per Data Point | bits_per_point | bit | uint8_t | Size of the data unit. (Should be multiple of 8) | Same as field type |
| Scaling Factor | scale_factor | - | fp32_t | Scaling factor used to multiply each data unit to restore the original floating point value. | Same as field type |
| Beam Configuration | beam_config | - | message-list (Beam Configuration) | Beam configuration of the device. | Same as field type |
| Data | data | - | rawdata | Data acquired by the measurement. | Same as field type |
Type of sonar.
| Value | Name | Abbreviation | Description |
|---|---|---|---|
| 0 | Sidescan | SIDESCAN | - |
| 1 | Echo Sounder | ECHOSOUNDER | - |
| 2 | Multibeam | MULTIBEAM | - |
Hardware pulse detection.
This message has no fields.
Control of hardware pulse detection.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Operation | op | Enumerated (Enum Operation) | uint8_t | Activate or deactivate hardware pulse detection. | Same as field type |
Activate or deactivate hardware pulse detection.
| Value | Name | Abbreviation | Description |
|---|---|---|---|
| 0 | Pulse Detection OFF | OFF | - |
| 1 | Pulse Detection ON | ON | - |
Report of fuel level.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Value | value | % | fp32_t | Fuel level percentage of the system. | min=0, max=100 |
| Confidence Level | confidence | % | fp32_t | Percentage level of confidence in the estimation of the amount of energy in the batteries. | min=0, max=100 |
| Operation Modes | opmodes | TupleList | plaintext | Operation mode name and the estimated time available in that mode in hours. Example: “Motion=1.5” | Same as field type |
Actual position of a servo.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Identifier | id | - | uint8_t | Servo identifier. | Same as field type |
| Position | value | rad | fp32_t | Value of the servo position. | min=-1.5707963267948966, max=1.5707963267948966 |
Location of a specific device in the system infrastructure.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Device Position - X | x | m | fp32_t | Device’s position over the X axis. | Same as field type |
| Device Position - Y | y | m | fp32_t | Device’s position over the Y axis. | Same as field type |
| Device Position - Z | z | m | fp32_t | Device’s position over the Z axis. | Same as field type |
| Device Rotation - X | phi | rad | fp32_t | Device’s rotation over the X axis. | Same as field type |
| Device Rotation - Y | theta | rad | fp32_t | Device’s rotation over the Y axis. | Same as field type |
| Device Rotation - Z | psi | rad | fp32_t | Device’s rotation over the Z axis. | Same as field type |
Beam configuration of the device.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Beam Width | beam_width | rad | fp32_t | Beam width of the instrument. A negative number denotes that this information is not available or is not applicable. | min=0, max=3.141592653589793 |
| Beam Height | beam_height | rad | fp32_t | Beam height of the instrument. A negative number denotes that this information is not available or is not applicable. | min=0, max=3.141592653589793 |
Report sanity or lack of it in the data output by a sensor.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Sanity | sane | Enumerated (Enum Sanity) | uint8_t | Whether the data is sane or not sane. | Same as field type |
Whether the data is sane or not sane.
| Value | Name | Abbreviation | Description |
|---|---|---|---|
| 0 | Sane | SANE | Data is sane. |
| 1 | Not Sane | NOT_SANE | Data is not sane. |
Rhodamine Dye measurement.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Value | value | PPB | fp32_t | Amount of rhodamine dye detected. | Same as field type |
Crude oil measurement.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Value | value | PPB | fp32_t | Amount of crude oil detected. | Same as field type |
Fine oil measurement.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Value | value | PPB | fp32_t | Amount of fine oil detected. | Same as field type |
Turbidity measurement.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Value | value | NTU | fp32_t | Turbidity reading. | Same as field type |
Chlorophyll measurement.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Value | value | µg/L | fp32_t | Chlorophyll reading. | Same as field type |
Fluorescein measurement.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Value | value | PPB | fp32_t | Fluorescein reading. | Same as field type |
Phycocyanin measurement.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Value | value | PPB | fp32_t | Phycocyanin reading. | Same as field type |
Phycoerythrin measurement.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Value | value | PPB | fp32_t | Phycoerythrin reading. | Same as field type |
Report of an RTK-GPS fix.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Validity | validity | Bitfield (Bitfield Validity) | uint16_t | Validity of fields. | Same as field type |
| Type | type | Enumerated (Enum Type) | uint8_t | Type of fix. | Same as field type |
| GPS Time of Week | tow | - | uint32_t | GPS Time of Week. | Same as field type |
| Base Latitude WGS-84 | base_lat | rad | fp64_t | WGS-84 Latitude coordinate of the base. | min=-1.5707963267948966, max=1.5707963267948966 |
| Base Longitude WGS-84 | base_lon | rad | fp64_t | WGS-84 Longitude coordinate of the base. | min=-3.141592653589793, max=3.141592653589793 |
| Base Height above WGS-84 ellipsoid | base_height | m | fp32_t | Height above WGS-84 ellipsoid of the base. | Same as field type |
| Position North | n | m | fp32_t | Baseline North coordinate. | Same as field type |
| Position East | e | m | fp32_t | Baseline East coordinate. | Same as field type |
| Position Down | d | m | fp32_t | Baseline Down coordinate. | Same as field type |
| Velocity North | v_n | m/s | fp32_t | Velocity North coordinate. | Same as field type |
| Velocity East | v_e | m/s | fp32_t | Velocity East coordinate. | Same as field type |
| Velocity Down | v_d | m/s | fp32_t | Velocity Down coordinate. | Same as field type |
| Number of Satellites | satellites | - | uint8_t | Number of satellites used in solution. | Same as field type |
| IAR Hypotheses | iar_hyp | - | uint16_t | Number of hypotheses in the Integer Ambiguity Resolution (smaller is better). | Same as field type |
| IAR Ratio | iar_ratio | - | fp32_t | Quality ratio of Integer Ambiguity Resolution (bigger is better). | Same as field type |
Validity of fields.
| Value | Name | Abbreviation | Description |
|---|---|---|---|
| 0x0001 | Valid Time | VALID_TIME | Field ‘tow’ is valid. |
| 0x0002 | Valid Base LLH | VALID_BASE | Fields ‘base_lat’, ‘base_lon’ and ‘base_height’ are valid. |
| 0x0004 | Valid Position | VALID_POS | Fields ‘n’, ‘e’, ‘d’ are valid. |
| 0x0008 | Valid Velocity | VALID_VEL | Fields ‘v_n’, ‘v_e’, ‘v_d’ are valid. |
Type of fix.
| Value | Name | Abbreviation | Description |
|---|---|---|---|
| 0x00 | None | NONE | No solution, but RTK task is running. |
| 0x01 | Obs | OBS | No solution, but receiving observations. |
| 0x02 | Float | FLOAT | Floating point solution of IAR. |
| 0x03 | Fixed | FIXED | Fixed (single) solution of IAR. |
Dissolved Oxygen measurement.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Value | value | µM | fp32_t | Dissolved Oxygen reading. | Same as field type |
Air Saturation measurement.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Value | value | % | fp32_t | Air Saturation reading. | Same as field type |
Throttle e.g. for Plane/Copter .
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Value | value | % | fp64_t | The value of the desired throttle. | Same as field type |
Report of pH.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Value | value | - | fp32_t | The value of the pH as measured by the sensor. | Same as field type |
Report of Redox Potential.
| Name | Abbreviation | Unit | Type | Description | Range |
|---|---|---|---|---|---|
| Value | value | V | fp32_t | The value of the Redox as measured by the sensor. | Same as field type |