MIP_SDK  v4.0.0-224-g55f11fa2
MicroStrain Communications Library for embedded systems
Modules | Classes | Typedefs | Enumerations | Functions | Variables
Base Commands
MIP » MIP C API » Mip Commands

Modules

 (0x01,0x01) Ping
 Test Communications with a device.
 
 (0x01,0x02) Set Idle
 Turn off all device data streams.
 
 (0x01,0x03) Get Device Info
 Get the device ID strings and firmware version number.
 
 (0x01,0x04) Get Device Descriptors
 Get the command and data descriptors supported by the device.
 
 (0x01,0x05) Built In Test
 Run the device Built-In Test (BIT).
 
 (0x01,0x06) Resume
 Take the device out of idle mode.
 
 (0x01,0x07) Get Extended Descriptors
 Get the command and data descriptors supported by the device.
 
 (0x01,0x08) Continuous Bit
 Report result of continuous built-in test.
 
 (0x01,0x09) Comm Speed
 Controls the baud rate of a specific port on the device.
 
 (0x01,0x72) Gps Time Update
 Set device internal GPS time When combined with a PPS input signal applied to the I/O connector, this command enables complete synchronization of data outputs with an external time base, such as GPS system time. Since the hardware PPS synchronization can only detect the fractional number of seconds when pulses arrive, complete synchronization requires that the user provide the whole number of seconds via this command. After achieving PPS synchronization, this command should be sent twice: once to set the time-of-week and once to set the week number. PPS synchronization can be verified by monitoring the time sync status message (0xA0, 0x02) or the valid flags of any shared external timestamp (0x–, D7) data field.
 
 (0x01,0x7E) Soft Reset
 Resets the device.
 

Classes

struct  mip::C::mip_base_device_info
 

Typedefs

typedef struct mip_base_device_info mip::C::mip_base_device_info
 
typedef enum mip_time_format mip::C::mip_time_format
 
typedef uint32_t mip::C::mip_commanded_test_bits_gq7
 

Enumerations

enum  {
  mip::C::MIP_BASE_CMD_DESC_SET = 0x01, mip::C::MIP_CMD_DESC_BASE_PING = 0x01, mip::C::MIP_CMD_DESC_BASE_SET_TO_IDLE = 0x02, mip::C::MIP_CMD_DESC_BASE_GET_DEVICE_INFO = 0x03,
  mip::C::MIP_CMD_DESC_BASE_GET_DEVICE_DESCRIPTORS = 0x04, mip::C::MIP_CMD_DESC_BASE_BUILT_IN_TEST = 0x05, mip::C::MIP_CMD_DESC_BASE_RESUME = 0x06, mip::C::MIP_CMD_DESC_BASE_GET_EXTENDED_DESCRIPTORS = 0x07,
  mip::C::MIP_CMD_DESC_BASE_CONTINUOUS_BIT = 0x08, mip::C::MIP_CMD_DESC_BASE_COMM_SPEED = 0x09, mip::C::MIP_CMD_DESC_BASE_GPS_TIME_UPDATE = 0x72, mip::C::MIP_CMD_DESC_BASE_SOFT_RESET = 0x7E,
  mip::C::MIP_REPLY_DESC_BASE_DEVICE_INFO = 0x81, mip::C::MIP_REPLY_DESC_BASE_DEVICE_DESCRIPTORS = 0x82, mip::C::MIP_REPLY_DESC_BASE_BUILT_IN_TEST = 0x83, mip::C::MIP_REPLY_DESC_BASE_GPS_CORRELATION_WEEK = 0x84,
  mip::C::MIP_REPLY_DESC_BASE_GPS_CORRELATION_SECONDS = 0x85, mip::C::MIP_REPLY_DESC_BASE_GET_EXTENDED_DESCRIPTORS = 0x86, mip::C::MIP_REPLY_DESC_BASE_CONTINUOUS_BIT = 0x88, mip::C::MIP_REPLY_DESC_BASE_COMM_SPEED = 0x89
}
 
enum  mip::C::mip_time_format { mip::C::MIP_TIME_FORMAT_GPS = 1 }
 

Functions

void mip::C::insert_mip_base_device_info (microstrain_serializer *serializer, const mip_base_device_info *self)
 
void mip::C::extract_mip_base_device_info (microstrain_serializer *serializer, mip_base_device_info *self)
 
static void mip::C::insert_mip_time_format (microstrain_serializer *serializer, const mip_time_format self)
 
static void mip::C::extract_mip_time_format (microstrain_serializer *serializer, mip_time_format *self)
 
static void mip::C::insert_mip_commanded_test_bits_gq7 (microstrain_serializer *serializer, const mip_commanded_test_bits_gq7 self)
 
static void mip::C::extract_mip_commanded_test_bits_gq7 (microstrain_serializer *serializer, mip_commanded_test_bits_gq7 *self)
 

Variables

static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_NONE = 0x00000000
 
static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_GENERAL_HARDWARE_FAULT = 0x00000001
 
static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_GENERAL_FIRMWARE_FAULT = 0x00000002
 
static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_TIMING_OVERLOAD = 0x00000004
 
static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_BUFFER_OVERRUN = 0x00000008
 
static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_RESERVED = 0x000000F0
 
static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_IPC_IMU_FAULT = 0x00000100
 
static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_IPC_NAV_FAULT = 0x00000200
 
static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_IPC_GNSS_FAULT = 0x00000400
 
static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_COMMS_FAULT = 0x00000800
 
static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_IMU_ACCEL_FAULT = 0x00001000
 
static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_IMU_GYRO_FAULT = 0x00002000
 
static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_IMU_MAG_FAULT = 0x00004000
 
static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_IMU_PRESS_FAULT = 0x00008000
 
static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_IMU_RESERVED = 0x00030000
 
static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_IMU_CAL_ERROR = 0x00040000
 
static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_IMU_GENERAL_FAULT = 0x00080000
 
static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_FILT_RESERVED = 0x00300000
 
static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_FILT_SOLUTION_FAULT = 0x00400000
 
static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_FILT_GENERAL_FAULT = 0x00800000
 
static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_GNSS_RECEIVER1_FAULT = 0x01000000
 
static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_GNSS_ANTENNA1_FAULT = 0x02000000
 
static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_GNSS_RECEIVER2_FAULT = 0x04000000
 
static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_GNSS_ANTENNA2_FAULT = 0x08000000
 
static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_GNSS_RTCM_FAILURE = 0x10000000
 
static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_GNSS_RTK_FAULT = 0x20000000
 
static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_GNSS_SOLUTION_FAULT = 0x40000000
 
static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_GNSS_GENERAL_FAULT = 0x80000000
 
static const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_ALL = 0xFFFFFFFF
 

Detailed Description

Typedef Documentation

◆ mip_base_device_info

typedef struct mip_base_device_info mip::C::mip_base_device_info

◆ mip_time_format

typedef enum mip_time_format mip::C::mip_time_format

◆ mip_commanded_test_bits_gq7

typedef uint32_t mip::C::mip_commanded_test_bits_gq7

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
MIP_BASE_CMD_DESC_SET 
MIP_CMD_DESC_BASE_PING 
MIP_CMD_DESC_BASE_SET_TO_IDLE 
MIP_CMD_DESC_BASE_GET_DEVICE_INFO 
MIP_CMD_DESC_BASE_GET_DEVICE_DESCRIPTORS 
MIP_CMD_DESC_BASE_BUILT_IN_TEST 
MIP_CMD_DESC_BASE_RESUME 
MIP_CMD_DESC_BASE_GET_EXTENDED_DESCRIPTORS 
MIP_CMD_DESC_BASE_CONTINUOUS_BIT 
MIP_CMD_DESC_BASE_COMM_SPEED 
MIP_CMD_DESC_BASE_GPS_TIME_UPDATE 
MIP_CMD_DESC_BASE_SOFT_RESET 
MIP_REPLY_DESC_BASE_DEVICE_INFO 
MIP_REPLY_DESC_BASE_DEVICE_DESCRIPTORS 
MIP_REPLY_DESC_BASE_BUILT_IN_TEST 
MIP_REPLY_DESC_BASE_GPS_CORRELATION_WEEK 
MIP_REPLY_DESC_BASE_GPS_CORRELATION_SECONDS 
MIP_REPLY_DESC_BASE_GET_EXTENDED_DESCRIPTORS 
MIP_REPLY_DESC_BASE_CONTINUOUS_BIT 
MIP_REPLY_DESC_BASE_COMM_SPEED 

◆ mip_time_format

enum mip::C::mip_time_format
Enumerator
MIP_TIME_FORMAT_GPS 

GPS time, a = week number since 1980, b = time of week in milliseconds.

Function Documentation

◆ insert_mip_base_device_info()

void mip::C::insert_mip_base_device_info ( microstrain_serializer *  serializer,
const mip_base_device_info *  self 
)

◆ extract_mip_base_device_info()

void mip::C::extract_mip_base_device_info ( microstrain_serializer *  serializer,
mip_base_device_info *  self 
)

◆ insert_mip_time_format()

static void mip::C::insert_mip_time_format ( microstrain_serializer *  serializer,
const mip_time_format  self 
)
inlinestatic

◆ extract_mip_time_format()

static void mip::C::extract_mip_time_format ( microstrain_serializer *  serializer,
mip_time_format *  self 
)
inlinestatic

◆ insert_mip_commanded_test_bits_gq7()

static void mip::C::insert_mip_commanded_test_bits_gq7 ( microstrain_serializer *  serializer,
const mip_commanded_test_bits_gq7  self 
)
inlinestatic

◆ extract_mip_commanded_test_bits_gq7()

static void mip::C::extract_mip_commanded_test_bits_gq7 ( microstrain_serializer *  serializer,
mip_commanded_test_bits_gq7 *  self 
)
inlinestatic

Variable Documentation

◆ MIP_COMMANDED_TEST_BITS_GQ7_NONE

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_NONE = 0x00000000
static

◆ MIP_COMMANDED_TEST_BITS_GQ7_GENERAL_HARDWARE_FAULT

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_GENERAL_HARDWARE_FAULT = 0x00000001
static

◆ MIP_COMMANDED_TEST_BITS_GQ7_GENERAL_FIRMWARE_FAULT

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_GENERAL_FIRMWARE_FAULT = 0x00000002
static

◆ MIP_COMMANDED_TEST_BITS_GQ7_TIMING_OVERLOAD

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_TIMING_OVERLOAD = 0x00000004
static

◆ MIP_COMMANDED_TEST_BITS_GQ7_BUFFER_OVERRUN

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_BUFFER_OVERRUN = 0x00000008
static

◆ MIP_COMMANDED_TEST_BITS_GQ7_RESERVED

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_RESERVED = 0x000000F0
static

◆ MIP_COMMANDED_TEST_BITS_GQ7_IPC_IMU_FAULT

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_IPC_IMU_FAULT = 0x00000100
static

◆ MIP_COMMANDED_TEST_BITS_GQ7_IPC_NAV_FAULT

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_IPC_NAV_FAULT = 0x00000200
static

◆ MIP_COMMANDED_TEST_BITS_GQ7_IPC_GNSS_FAULT

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_IPC_GNSS_FAULT = 0x00000400
static

◆ MIP_COMMANDED_TEST_BITS_GQ7_COMMS_FAULT

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_COMMS_FAULT = 0x00000800
static

◆ MIP_COMMANDED_TEST_BITS_GQ7_IMU_ACCEL_FAULT

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_IMU_ACCEL_FAULT = 0x00001000
static

◆ MIP_COMMANDED_TEST_BITS_GQ7_IMU_GYRO_FAULT

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_IMU_GYRO_FAULT = 0x00002000
static

◆ MIP_COMMANDED_TEST_BITS_GQ7_IMU_MAG_FAULT

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_IMU_MAG_FAULT = 0x00004000
static

◆ MIP_COMMANDED_TEST_BITS_GQ7_IMU_PRESS_FAULT

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_IMU_PRESS_FAULT = 0x00008000
static

◆ MIP_COMMANDED_TEST_BITS_GQ7_IMU_RESERVED

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_IMU_RESERVED = 0x00030000
static

◆ MIP_COMMANDED_TEST_BITS_GQ7_IMU_CAL_ERROR

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_IMU_CAL_ERROR = 0x00040000
static

◆ MIP_COMMANDED_TEST_BITS_GQ7_IMU_GENERAL_FAULT

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_IMU_GENERAL_FAULT = 0x00080000
static

◆ MIP_COMMANDED_TEST_BITS_GQ7_FILT_RESERVED

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_FILT_RESERVED = 0x00300000
static

◆ MIP_COMMANDED_TEST_BITS_GQ7_FILT_SOLUTION_FAULT

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_FILT_SOLUTION_FAULT = 0x00400000
static

◆ MIP_COMMANDED_TEST_BITS_GQ7_FILT_GENERAL_FAULT

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_FILT_GENERAL_FAULT = 0x00800000
static

◆ MIP_COMMANDED_TEST_BITS_GQ7_GNSS_RECEIVER1_FAULT

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_GNSS_RECEIVER1_FAULT = 0x01000000
static

◆ MIP_COMMANDED_TEST_BITS_GQ7_GNSS_ANTENNA1_FAULT

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_GNSS_ANTENNA1_FAULT = 0x02000000
static

◆ MIP_COMMANDED_TEST_BITS_GQ7_GNSS_RECEIVER2_FAULT

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_GNSS_RECEIVER2_FAULT = 0x04000000
static

◆ MIP_COMMANDED_TEST_BITS_GQ7_GNSS_ANTENNA2_FAULT

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_GNSS_ANTENNA2_FAULT = 0x08000000
static

◆ MIP_COMMANDED_TEST_BITS_GQ7_GNSS_RTCM_FAILURE

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_GNSS_RTCM_FAILURE = 0x10000000
static

◆ MIP_COMMANDED_TEST_BITS_GQ7_GNSS_RTK_FAULT

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_GNSS_RTK_FAULT = 0x20000000
static

◆ MIP_COMMANDED_TEST_BITS_GQ7_GNSS_SOLUTION_FAULT

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_GNSS_SOLUTION_FAULT = 0x40000000
static

◆ MIP_COMMANDED_TEST_BITS_GQ7_GNSS_GENERAL_FAULT

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_GNSS_GENERAL_FAULT = 0x80000000
static

◆ MIP_COMMANDED_TEST_BITS_GQ7_ALL

const mip_commanded_test_bits_gq7 mip::C::MIP_COMMANDED_TEST_BITS_GQ7_ALL = 0xFFFFFFFF
static
Generated by   doxygen 1.8.17