MIP_SDK  v3.0.0
MicroStrain Communications Library for embedded systems
Modules | Classes | Enumerations
3dm Commands

Modules

 (0x0C,0x01) Poll Imu Message
 Poll the device for an IMU message with the specified format.
 
 (0x0C,0x02) Poll Gnss Message
 Poll the device for an GNSS message with the specified format.
 
 (0x0C,0x03) Poll Filter Message
 Poll the device for an Estimation Filter message with the specified format.
 
 (0x0C,0x08) Imu Message Format
 Set, read, or save the format of the IMU data packet.
 
 (0x0C,0x09) Gps Message Format
 Set, read, or save the format of the GNSS data packet.
 
 (0x0C,0x0A) Filter Message Format
 Set, read, or save the format of the Estimation Filter data packet.
 
 (0x0C,0x06) Imu Get Base Rate
 Get the base rate for the IMU data in Hz.
 
 (0x0C,0x07) Gps Get Base Rate
 Get the base rate for the GNSS data in Hz.
 
 (0x0C,0x0B) Filter Get Base Rate
 Get the base rate for the Estimation Filter data in Hz.
 
 (0x0C,0x0D) Poll Data
 Poll the device for a message with the specified descriptor set and format.
 
 (0x0C,0x0E) Get Base Rate
 Get the base rate for the specified descriptor set in Hz.
 
 (0x0C,0x0F) Message Format
 Set, read, or save the format for a given data packet.
 
 (0x0C,0x04) Nmea Poll Data
 Poll the device for a NMEA message with the specified format.
 
 (0x0C,0x0C) Nmea Message Format
 Set, read, or save the NMEA message format.
 
 (0x0C,0x30) Device Settings
 Save, Load, or Reset to Default the values for all device settings.
 
 (0x0C,0x40) Uart Baudrate
 Read, Save, Load, or Reset to Default the baud rate of the main communication channel.
 
 (0x0C,0x10) Factory Streaming
 Configures the device for recording data for technical support.
 
 (0x0C,0x11) Datastream Control
 Enable/disable the selected data stream.
 
 (0x0C,0x21) Constellation Settings
 This command configures which satellite constellations are enabled and how many channels are dedicated to tracking each constellation.
 
 (0x0C,0x22) Gnss Sbas Settings
 Configure the SBAS subsystem.
 
 (0x0C,0x23) Gnss Assisted Fix
 Set the options for assisted GNSS fix.
 
 (0x0C,0x24) Gnss Time Assistance
 Provide the GNSS subsystem with initial time information.
 
 (0x0C,0x50) Imu Lowpass Filter
 Advanced configuration for the IMU data quantity low-pass filters.
 
 (0x0C,0x28) Pps Source
 Controls the Pulse Per Second (PPS) source.
 
 (0x0C,0x41) Gpio Config
 Configures the user GPIO pins on the connector for use with several built-in functions or for general input or output.
 
 (0x0C,0x42) Gpio State
 Allows the state of the pin to be read or controlled.
 
 (0x0C,0x43) Odometer
 Configures the hardware odometer interface.
 
 (0x0C,0x2A) Get Event Support
 Lists the available trigger or action types.
 
 (0x0C,0x2B) Event Control
 Enables or disables event triggers.
 
 (0x0C,0x2C) Get Event Trigger Status
 
 (0x0C,0x2D) Get Event Action Status
 
 (0x0C,0x2E) Event Trigger
 Configures various types of event triggers.
 
 (0x0C,0x2F) Event Action
 Configures various types of event actions.
 
 (0x0C,0x37) Accel Bias
 Configures the user specified accelerometer bias.
 
 (0x0C,0x38) Gyro Bias
 Configures the user specified gyroscope bias.
 
 (0x0C,0x39) Capture Gyro Bias
 Samples gyro for a specified time range and writes the averaged result to the Gyro Bias vector in RAM.
 
 (0x0C,0x3A) Mag Hard Iron Offset
 Configure the user specified magnetometer hard iron offset vector.
 
 (0x0C,0x3B) Mag Soft Iron Matrix
 Configure the user specified magnetometer soft iron offset matrix.
 
 (0x0C,0x3E) Coning Sculling Enable
 Controls the Coning and Sculling Compenstation setting.
 
 (0x0C,0x31) Sensor 2 Vehicle Transform Euler
 Sets the sensor-to-vehicle frame transformation using Yaw, Pitch, Roll Euler angles. These are the Yaw, Pitch, and Roll mounting angles of the sensor with respect to vehicle frame of reference, and describe the transformation of vectors from the sensor body frame to the vehicle frame.
Note: This is the transformation, the inverse of the rotation defined in our legacy products.
The transformation may be stored in the device as a matrix or quaternion. When Euler angles are read back from the device, they may not be exactly equal to the Euler angles used to set the transformation, but they are functionally equivalent, such that they result in the same transformation.


This transformation to the vehicle frame will be applied to the following output quantities:

IMU:
Scaled Acceleration
Scaled Gyro
Scaled Magnetometer
Delta Theta
Delta Velocity
Complementary Filter Orientation


Estimation Filter:
Estimated Orientation, Quaternion
Estimated Orientation, Matrix
Estimated Orientation, Euler Angles
Estimated Linear Acceleration
Estimated Angular Rate
Estimated Gravity Vector

Changing this setting will force all low-pass filters, the complementary filter, and the estimation filter to reset.
 
 (0x0C,0x32) Sensor 2 Vehicle Transform Quaternion
 Set the sensor to vehicle frame transformation using unit length quaternion.
 
 (0x0C,0x33) Sensor 2 Vehicle Transform Dcm
 Set the sensor to vehicle frame transformation using a using a 3 x 3 direction cosine matrix EQSTART M_{ned}^{veh} EQEND, stored in row-major order in a 9-element array.
 
 (0x0C,0x51) Complementary Filter
 Configure the settings for the complementary filter which produces the following (0x80) descriptor set values: attitude matrix (0x80,09), quaternion (0x80,0A), and Euler angle (0x80,0C) outputs.
 
 (0x0C,0x52) Sensor Range
 Changes the IMU sensor gain.
 
 (0x0C,0x53) Calibrated Sensor Ranges
 Returns the supported sensor ranges which may be used with the 3DM Sensor Range (0x0C,0x52) command.
 
 (0x0C,0x54) Lowpass Filter
 This command controls the low-pass anti-aliasing filter supported data quantities.
 

Classes

struct  mip::commands_3dm::NmeaMessage
 

Enumerations

enum  {
  mip::commands_3dm::DESCRIPTOR_SET = 0x0C, mip::commands_3dm::CMD_POLL_IMU_MESSAGE = 0x01, mip::commands_3dm::CMD_POLL_GNSS_MESSAGE = 0x02, mip::commands_3dm::CMD_POLL_FILTER_MESSAGE = 0x03,
  mip::commands_3dm::CMD_POLL_NMEA_MESSAGE = 0x04, mip::commands_3dm::CMD_GET_IMU_BASE_RATE = 0x06, mip::commands_3dm::CMD_GET_GNSS_BASE_RATE = 0x07, mip::commands_3dm::CMD_IMU_MESSAGE_FORMAT = 0x08,
  mip::commands_3dm::CMD_GNSS_MESSAGE_FORMAT = 0x09, mip::commands_3dm::CMD_FILTER_MESSAGE_FORMAT = 0x0A, mip::commands_3dm::CMD_GET_FILTER_BASE_RATE = 0x0B, mip::commands_3dm::CMD_NMEA_MESSAGE_FORMAT = 0x0C,
  mip::commands_3dm::CMD_POLL_DATA = 0x0D, mip::commands_3dm::CMD_GET_BASE_RATE = 0x0E, mip::commands_3dm::CMD_MESSAGE_FORMAT = 0x0F, mip::commands_3dm::CMD_CONFIGURE_FACTORY_STREAMING = 0x10,
  mip::commands_3dm::CMD_CONTROL_DATA_STREAM = 0x11, mip::commands_3dm::CMD_RAW_RTCM_2_3_MESSAGE = 0x20, mip::commands_3dm::CMD_GNSS_CONSTELLATION_SETTINGS = 0x21, mip::commands_3dm::CMD_GNSS_SBAS_SETTINGS = 0x22,
  mip::commands_3dm::CMD_GNSS_ASSISTED_FIX_SETTINGS = 0x23, mip::commands_3dm::CMD_GNSS_TIME_ASSISTANCE = 0x24, mip::commands_3dm::CMD_PPS_SOURCE = 0x28, mip::commands_3dm::CMD_EVENT_SUPPORT = 0x2A,
  mip::commands_3dm::CMD_EVENT_CONTROL = 0x2B, mip::commands_3dm::CMD_EVENT_TRIGGER_STATUS = 0x2C, mip::commands_3dm::CMD_EVENT_ACTION_STATUS = 0x2D, mip::commands_3dm::CMD_EVENT_TRIGGER_CONFIG = 0x2E,
  mip::commands_3dm::CMD_EVENT_ACTION_CONFIG = 0x2F, mip::commands_3dm::CMD_DEVICE_STARTUP_SETTINGS = 0x30, mip::commands_3dm::CMD_SENSOR2VEHICLE_TRANSFORM_EUL = 0x31, mip::commands_3dm::CMD_SENSOR2VEHICLE_TRANSFORM_QUAT = 0x32,
  mip::commands_3dm::CMD_SENSOR2VEHICLE_TRANSFORM_DCM = 0x33, mip::commands_3dm::CMD_SET_GNSS_DYNAMICS_MODE = 0x34, mip::commands_3dm::CMD_SET_IMU_SIGNAL_COND = 0x35, mip::commands_3dm::CMD_SET_IMU_TIMESTAMP = 0x36,
  mip::commands_3dm::CMD_ACCEL_BIAS = 0x37, mip::commands_3dm::CMD_GYRO_BIAS = 0x38, mip::commands_3dm::CMD_CAPTURE_GYRO_BIAS = 0x39, mip::commands_3dm::CMD_HARD_IRON_OFFSET = 0x3A,
  mip::commands_3dm::CMD_SOFT_IRON_MATRIX = 0x3B, mip::commands_3dm::CMD_REALIGN_UP = 0x3C, mip::commands_3dm::CMD_REALIGN_NORTH = 0x3D, mip::commands_3dm::CMD_CONING_AND_SCULLING_ENABLE = 0x3E,
  mip::commands_3dm::CMD_UART_BAUDRATE = 0x40, mip::commands_3dm::CMD_GPIO_CONFIG = 0x41, mip::commands_3dm::CMD_GPIO_STATE = 0x42, mip::commands_3dm::CMD_ODOMETER_CONFIG = 0x43,
  mip::commands_3dm::CMD_IMU_LOWPASS_FILTER = 0x50, mip::commands_3dm::CMD_LEGACY_COMP_FILTER = 0x51, mip::commands_3dm::CMD_SENSOR_RANGE = 0x52, mip::commands_3dm::CMD_CALIBRATED_RANGES = 0x53,
  mip::commands_3dm::CMD_LOWPASS_FILTER = 0x54, mip::commands_3dm::CMD_DATASTREAM_FORMAT = 0x60, mip::commands_3dm::CMD_DEVICE_POWER_STATE = 0x61, mip::commands_3dm::CMD_SAVE_RESTORE_GPS_SETTINGS = 0x62,
  mip::commands_3dm::CMD_DEVICE_SETTINGS = 0x63, mip::commands_3dm::CMD_RAW_CLIP_SETTINGS = 0x70, mip::commands_3dm::REPLY_IMU_MESSAGE_FORMAT = 0x80, mip::commands_3dm::REPLY_GNSS_MESSAGE_FORMAT = 0x81,
  mip::commands_3dm::REPLY_FILTER_MESSAGE_FORMAT = 0x82, mip::commands_3dm::REPLY_IMU_BASE_RATE = 0x83, mip::commands_3dm::REPLY_GNSS_BASE_RATE = 0x84, mip::commands_3dm::REPLY_DATASTREAM_ENABLE = 0x85,
  mip::commands_3dm::REPLY_IMU_SIGNAL_SETTINGS = 0x86, mip::commands_3dm::REPLY_UART_BAUDRATE = 0x87, mip::commands_3dm::REPLY_DATASTREAM_FORMAT = 0x88, mip::commands_3dm::REPLY_POWER_STATE = 0x89,
  mip::commands_3dm::REPLY_FILTER_BASE_RATE = 0x8A, mip::commands_3dm::REPLY_ADVANCED_DATA_FILTER = 0x8B, mip::commands_3dm::REPLY_POLL_DATA = 0x8D, mip::commands_3dm::REPLY_BASE_RATE = 0x8E,
  mip::commands_3dm::REPLY_MESSAGE_FORMAT = 0x8F, mip::commands_3dm::REPLY_COMMUNICATIONS_MODE = 0x91, mip::commands_3dm::REPLY_GNSS_DYNAMICS_MODE = 0x92, mip::commands_3dm::REPLY_IMU_TIMESTAMP_VALUE = 0x93,
  mip::commands_3dm::REPLY_IMU_BASIC_STATUS = 0x94, mip::commands_3dm::REPLY_IMU_ADVANCED_STATUS = 0x95, mip::commands_3dm::REPLY_RAW_CLIP_SETTINGS = 0x96, mip::commands_3dm::REPLY_LEGACY_COMP_FILTER = 0x97,
  mip::commands_3dm::REPLY_ACCEL_BIAS_VECTOR = 0x9A, mip::commands_3dm::REPLY_GYRO_BIAS_VECTOR = 0x9B, mip::commands_3dm::REPLY_HARD_IRON_OFFSET_VECTOR = 0x9C, mip::commands_3dm::REPLY_SOFT_IRON_COMP_MATRIX = 0x9D,
  mip::commands_3dm::REPLY_CONING_AND_SCULLING_ENABLE = 0x9E, mip::commands_3dm::REPLY_GNSS_CONSTELLATION_SETTINGS = 0xA0, mip::commands_3dm::REPLY_GNSS_SBAS_SETTINGS = 0xA1, mip::commands_3dm::REPLY_GNSS_ASSISTED_FIX_SETTINGS = 0xA2,
  mip::commands_3dm::REPLY_GNSS_TIME_ASSISTANCE = 0xA3, mip::commands_3dm::REPLY_SENSOR2VEHICLE_TRANSFORM_EUL = 0xB1, mip::commands_3dm::REPLY_SENSOR2VEHICLE_TRANSFORM_QUAT = 0xB2, mip::commands_3dm::REPLY_SENSOR2VEHICLE_TRANSFORM_DCM = 0xB3,
  mip::commands_3dm::REPLY_EVENT_SUPPORT = 0xB4, mip::commands_3dm::REPLY_EVENT_CONTROL = 0xB5, mip::commands_3dm::REPLY_EVENT_TRIGGER_STATUS = 0xB6, mip::commands_3dm::REPLY_EVENT_ACTION_STATUS = 0xB7,
  mip::commands_3dm::REPLY_EVENT_TRIGGER_CONFIG = 0xB8, mip::commands_3dm::REPLY_EVENT_ACTION_CONFIG = 0xB9, mip::commands_3dm::REPLY_NMEA_MESSAGE_FORMAT = 0x8C, mip::commands_3dm::REPLY_PPS_SOURCE = 0xA8,
  mip::commands_3dm::REPLY_GPIO_CONFIG = 0xC1, mip::commands_3dm::REPLY_GPIO_STATE = 0xC2, mip::commands_3dm::REPLY_ODOMETER_CONFIG = 0xC3, mip::commands_3dm::REPLY_SENSOR_RANGE = 0xD2,
  mip::commands_3dm::REPLY_CALIBRATED_RANGES = 0xD3, mip::commands_3dm::REPLY_LOWPASS_FILTER = 0xD4
}
 
enum  mip::commands_3dm::SensorRangeType : uint8_t {
  mip::commands_3dm::SensorRangeType::ALL = 0, mip::commands_3dm::SensorRangeType::ACCEL = 1, mip::commands_3dm::SensorRangeType::GYRO = 2, mip::commands_3dm::SensorRangeType::MAG = 3,
  mip::commands_3dm::SensorRangeType::PRESS = 4
}
 

Detailed Description

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
DESCRIPTOR_SET 
CMD_POLL_IMU_MESSAGE 
CMD_POLL_GNSS_MESSAGE 
CMD_POLL_FILTER_MESSAGE 
CMD_POLL_NMEA_MESSAGE 
CMD_GET_IMU_BASE_RATE 
CMD_GET_GNSS_BASE_RATE 
CMD_IMU_MESSAGE_FORMAT 
CMD_GNSS_MESSAGE_FORMAT 
CMD_FILTER_MESSAGE_FORMAT 
CMD_GET_FILTER_BASE_RATE 
CMD_NMEA_MESSAGE_FORMAT 
CMD_POLL_DATA 
CMD_GET_BASE_RATE 
CMD_MESSAGE_FORMAT 
CMD_CONFIGURE_FACTORY_STREAMING 
CMD_CONTROL_DATA_STREAM 
CMD_RAW_RTCM_2_3_MESSAGE 
CMD_GNSS_CONSTELLATION_SETTINGS 
CMD_GNSS_SBAS_SETTINGS 
CMD_GNSS_ASSISTED_FIX_SETTINGS 
CMD_GNSS_TIME_ASSISTANCE 
CMD_PPS_SOURCE 
CMD_EVENT_SUPPORT 
CMD_EVENT_CONTROL 
CMD_EVENT_TRIGGER_STATUS 
CMD_EVENT_ACTION_STATUS 
CMD_EVENT_TRIGGER_CONFIG 
CMD_EVENT_ACTION_CONFIG 
CMD_DEVICE_STARTUP_SETTINGS 
CMD_SENSOR2VEHICLE_TRANSFORM_EUL 
CMD_SENSOR2VEHICLE_TRANSFORM_QUAT 
CMD_SENSOR2VEHICLE_TRANSFORM_DCM 
CMD_SET_GNSS_DYNAMICS_MODE 
CMD_SET_IMU_SIGNAL_COND 
CMD_SET_IMU_TIMESTAMP 
CMD_ACCEL_BIAS 
CMD_GYRO_BIAS 
CMD_CAPTURE_GYRO_BIAS 
CMD_HARD_IRON_OFFSET 
CMD_SOFT_IRON_MATRIX 
CMD_REALIGN_UP 
CMD_REALIGN_NORTH 
CMD_CONING_AND_SCULLING_ENABLE 
CMD_UART_BAUDRATE 
CMD_GPIO_CONFIG 
CMD_GPIO_STATE 
CMD_ODOMETER_CONFIG 
CMD_IMU_LOWPASS_FILTER 
CMD_LEGACY_COMP_FILTER 
CMD_SENSOR_RANGE 
CMD_CALIBRATED_RANGES 
CMD_LOWPASS_FILTER 
CMD_DATASTREAM_FORMAT 
CMD_DEVICE_POWER_STATE 
CMD_SAVE_RESTORE_GPS_SETTINGS 
CMD_DEVICE_SETTINGS 
CMD_RAW_CLIP_SETTINGS 
REPLY_IMU_MESSAGE_FORMAT 
REPLY_GNSS_MESSAGE_FORMAT 
REPLY_FILTER_MESSAGE_FORMAT 
REPLY_IMU_BASE_RATE 
REPLY_GNSS_BASE_RATE 
REPLY_DATASTREAM_ENABLE 
REPLY_IMU_SIGNAL_SETTINGS 
REPLY_UART_BAUDRATE 
REPLY_DATASTREAM_FORMAT 
REPLY_POWER_STATE 
REPLY_FILTER_BASE_RATE 
REPLY_ADVANCED_DATA_FILTER 
REPLY_POLL_DATA 
REPLY_BASE_RATE 
REPLY_MESSAGE_FORMAT 
REPLY_COMMUNICATIONS_MODE 
REPLY_GNSS_DYNAMICS_MODE 
REPLY_IMU_TIMESTAMP_VALUE 
REPLY_IMU_BASIC_STATUS 
REPLY_IMU_ADVANCED_STATUS 
REPLY_RAW_CLIP_SETTINGS 
REPLY_LEGACY_COMP_FILTER 
REPLY_ACCEL_BIAS_VECTOR 
REPLY_GYRO_BIAS_VECTOR 
REPLY_HARD_IRON_OFFSET_VECTOR 
REPLY_SOFT_IRON_COMP_MATRIX 
REPLY_CONING_AND_SCULLING_ENABLE 
REPLY_GNSS_CONSTELLATION_SETTINGS 
REPLY_GNSS_SBAS_SETTINGS 
REPLY_GNSS_ASSISTED_FIX_SETTINGS 
REPLY_GNSS_TIME_ASSISTANCE 
REPLY_SENSOR2VEHICLE_TRANSFORM_EUL 
REPLY_SENSOR2VEHICLE_TRANSFORM_QUAT 
REPLY_SENSOR2VEHICLE_TRANSFORM_DCM 
REPLY_EVENT_SUPPORT 
REPLY_EVENT_CONTROL 
REPLY_EVENT_TRIGGER_STATUS 
REPLY_EVENT_ACTION_STATUS 
REPLY_EVENT_TRIGGER_CONFIG 
REPLY_EVENT_ACTION_CONFIG 
REPLY_NMEA_MESSAGE_FORMAT 
REPLY_PPS_SOURCE 
REPLY_GPIO_CONFIG 
REPLY_GPIO_STATE 
REPLY_ODOMETER_CONFIG 
REPLY_SENSOR_RANGE 
REPLY_CALIBRATED_RANGES 
REPLY_LOWPASS_FILTER 

◆ SensorRangeType

enum mip::commands_3dm::SensorRangeType : uint8_t
strong
Enumerator
ALL 

Only allowed for SAVE, LOAD, and DEFAULT function selectors.

ACCEL 

Accelerometer. Range is specified in g.

GYRO 

Gyroscope. Range is specified in degrees/s.

MAG 

Magnetometer. Range is specified in Gauss.

PRESS 

Pressure sensor. Range is specified in hPa.