MIP_SDK  v4.0.0-234-g2b06a940
MicroStrain Communications Library for embedded systems
Modules | Typedefs | Enumerations | Functions | Variables
System Commands

Modules

 (0x7F,0x10) Comm Mode
 Advanced specialized communication modes.
 
 (0x7F,0x02) Interface Control
 Reassign data protocols, both incoming and outgoing.
 

Typedefs

typedef enum mip_comms_interface mip::C::mip_comms_interface
 
typedef uint32_t mip::C::mip_comms_protocol
 

Enumerations

enum  {
  mip::C::MIP_SYSTEM_CMD_DESC_SET = 0x7F, mip::C::MIP_CMD_DESC_MIPNET_ENUMERATE = 0x01, mip::C::MIP_CMD_DESC_SYSTEM_INTERFACE_CONTROL = 0x02, mip::C::MIP_CMD_DESC_SYSTEM_COM_MODE = 0x10,
  mip::C::MIP_CMD_DESC_SYSTEM_HARDWARE_CONTROL = 0x11, mip::C::MIP_CMD_DESC_SYSTEM_HARDWARE_CONTROL_2 = 0x12, mip::C::MIP_REPLY_DESC_SYSTEM_COM_MODE = 0x90, mip::C::MIP_REPLY_DESC_SYSTEM_HARDWARE_CONTROL = 0x91,
  mip::C::MIP_REPLY_DESC_SYSTEM_HARDWARE_CONTROL_2 = 0x92, mip::C::MIP_REPLY_DESC_SYSTEM_INTERFACE_CONTROL = 0x82
}
 
enum  { mip::C::MIP_SYSTEM_COMMAND_COMM_MODE_PASSTHRU = 0x00 }
 
enum  { mip::C::MIP_SYSTEM_COMMAND_COMM_MODE_NORMAL = 0x01 }
 
enum  { mip::C::MIP_SYSTEM_COMMAND_COMM_MODE_IMU = 0x02 }
 
enum  { mip::C::MIP_SYSTEM_COMMAND_COMM_MODE_GPS = 0x03 }
 
enum  mip::C::mip_comms_interface {
  mip::C::MIP_COMMS_INTERFACE_ALL = 0, mip::C::MIP_COMMS_INTERFACE_MAIN = 1, mip::C::MIP_COMMS_INTERFACE_UART_1 = 17, mip::C::MIP_COMMS_INTERFACE_UART_2 = 18,
  mip::C::MIP_COMMS_INTERFACE_UART_3 = 19, mip::C::MIP_COMMS_INTERFACE_USB_1 = 33, mip::C::MIP_COMMS_INTERFACE_USB_2 = 34
}
 

Functions

static void mip::C::insert_mip_comms_interface (microstrain_serializer *serializer, const mip_comms_interface self)
 
static void mip::C::extract_mip_comms_interface (microstrain_serializer *serializer, mip_comms_interface *self)
 
static void mip::C::insert_mip_comms_protocol (microstrain_serializer *serializer, const mip_comms_protocol self)
 
static void mip::C::extract_mip_comms_protocol (microstrain_serializer *serializer, mip_comms_protocol *self)
 

Variables

static const mip_comms_protocol mip::C::MIP_COMMS_PROTOCOL_NONE = 0x00000000
 
static const mip_comms_protocol mip::C::MIP_COMMS_PROTOCOL_MIP = 0x00000001
 Microstrain Inertial Protocol. More...
 
static const mip_comms_protocol mip::C::MIP_COMMS_PROTOCOL_NMEA = 0x00000100
 
static const mip_comms_protocol mip::C::MIP_COMMS_PROTOCOL_RTCM = 0x00000200
 
static const mip_comms_protocol mip::C::MIP_COMMS_PROTOCOL_SPARTN = 0x01000000
 
static const mip_comms_protocol mip::C::MIP_COMMS_PROTOCOL_ALL = 0x01000301
 

Detailed Description

Typedef Documentation

◆ mip_comms_interface

◆ mip_comms_protocol

typedef uint32_t mip::C::mip_comms_protocol

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
MIP_SYSTEM_CMD_DESC_SET 
MIP_CMD_DESC_MIPNET_ENUMERATE 
MIP_CMD_DESC_SYSTEM_INTERFACE_CONTROL 
MIP_CMD_DESC_SYSTEM_COM_MODE 
MIP_CMD_DESC_SYSTEM_HARDWARE_CONTROL 
MIP_CMD_DESC_SYSTEM_HARDWARE_CONTROL_2 
MIP_REPLY_DESC_SYSTEM_COM_MODE 
MIP_REPLY_DESC_SYSTEM_HARDWARE_CONTROL 
MIP_REPLY_DESC_SYSTEM_HARDWARE_CONTROL_2 
MIP_REPLY_DESC_SYSTEM_INTERFACE_CONTROL 

◆ anonymous enum

anonymous enum
Enumerator
MIP_SYSTEM_COMMAND_COMM_MODE_PASSTHRU 

◆ anonymous enum

anonymous enum
Enumerator
MIP_SYSTEM_COMMAND_COMM_MODE_NORMAL 

◆ anonymous enum

anonymous enum
Enumerator
MIP_SYSTEM_COMMAND_COMM_MODE_IMU 

◆ anonymous enum

anonymous enum
Enumerator
MIP_SYSTEM_COMMAND_COMM_MODE_GPS 

◆ mip_comms_interface

Enumerator
MIP_COMMS_INTERFACE_ALL 
MIP_COMMS_INTERFACE_MAIN 

An alias that directs to Main USB if it's connected, or Main UART otherwise.

MIP_COMMS_INTERFACE_UART_1 

Depending on your device, this may mean either the first UART currently configured, or the first port on which UART can be configured. Refer to your device manual.

MIP_COMMS_INTERFACE_UART_2 
MIP_COMMS_INTERFACE_UART_3 
MIP_COMMS_INTERFACE_USB_1 

The first virtual serial port over USB (ie. COM5)

MIP_COMMS_INTERFACE_USB_2 

The second virtual serial port over USB (ie. COM6), only available on GNSS/INS devices. Recommended for NMEA/RTCM.

Function Documentation

◆ insert_mip_comms_interface()

static void mip::C::insert_mip_comms_interface ( microstrain_serializer serializer,
const mip_comms_interface  self 
)
inlinestatic

◆ extract_mip_comms_interface()

static void mip::C::extract_mip_comms_interface ( microstrain_serializer serializer,
mip_comms_interface self 
)
inlinestatic

◆ insert_mip_comms_protocol()

static void mip::C::insert_mip_comms_protocol ( microstrain_serializer serializer,
const mip_comms_protocol  self 
)
inlinestatic

◆ extract_mip_comms_protocol()

static void mip::C::extract_mip_comms_protocol ( microstrain_serializer serializer,
mip_comms_protocol self 
)
inlinestatic

Variable Documentation

◆ MIP_COMMS_PROTOCOL_NONE

const mip_comms_protocol mip::C::MIP_COMMS_PROTOCOL_NONE = 0x00000000
static

◆ MIP_COMMS_PROTOCOL_MIP

const mip_comms_protocol mip::C::MIP_COMMS_PROTOCOL_MIP = 0x00000001
static

◆ MIP_COMMS_PROTOCOL_NMEA

const mip_comms_protocol mip::C::MIP_COMMS_PROTOCOL_NMEA = 0x00000100
static

◆ MIP_COMMS_PROTOCOL_RTCM

const mip_comms_protocol mip::C::MIP_COMMS_PROTOCOL_RTCM = 0x00000200
static

◆ MIP_COMMS_PROTOCOL_SPARTN

const mip_comms_protocol mip::C::MIP_COMMS_PROTOCOL_SPARTN = 0x01000000
static

◆ MIP_COMMS_PROTOCOL_ALL

const mip_comms_protocol mip::C::MIP_COMMS_PROTOCOL_ALL = 0x01000301
static