MIP_SDK  v3.0.0-736-g212583cf
MicroStrain Communications Library for embedded systems
Functions | Variables
Device Info Example [CPP]

Example program to print device information for any MIP-enabled MicroStrain device using C++. More...

Functions

static void logCallback (void *_user, const microstrain_log_level _level, const char *_format, va_list _args)
 Custom logging callback for MIP SDK message formatting and output. More...
 
static void initializeDevice (mip::Interface &_device)
 Initializes and configures a MIP device interface. More...
 
static void terminate (microstrain::Connection *_connection, const char *_message, const bool _successful)
 Handles graceful program termination and cleanup. More...
 
static void terminate (mip::Interface &_device, const mip::CmdResult _cmdResult, const char *_format,...)
 Handles graceful program termination and command failure cleanup. More...
 

Variables

static constexpr const char * PORT_NAME = "/dev/ttyACM0"
 Set the port name for the connection (Serial/USB) More...
 
static constexpr uint32_t BAUDRATE = 115200
 Set the baudrate for the connection (Serial/USB) More...
 

Detailed Description

This example shows a basic setup for any MIP-enabled MicroStrain device to demonstrate how to get and print device information using C++. This is not an exhaustive example of all settings for those devices. If this example does not meet your specific setup needs, please consult the MIP SDK API documentation for the proper commands.

License

Function Documentation

◆ logCallback()

static void logCallback ( void *  _user,
const microstrain_log_level  _level,
const char *  _format,
va_list  _args 
)
static

Processes and formats log messages from the MIP SDK based on severity level. Routes messages to appropriate output streams - errors and fatal messages go to stderr while other levels go to stdout. Each message is prefixed with its severity level name.

Parameters
_userPointer to user data (unused in this implementation)
_levelLog message severity level from microstrain_log_level enum
_formatPrintf-style format string for the message
_argsVariable argument list containing message parameters

◆ initializeDevice()

static void initializeDevice ( mip::Interface _device)
static

Performs a complete device initialization sequence:

  1. Verifies device communication with a ping command
  2. Sets the device to idle mode to ensure reliable configuration
  3. Queries and displays detailed device information
Parameters
_deviceReference to a MIP device interface to initialize

◆ terminate() [1/2]

static void terminate ( microstrain::Connection _connection,
const char *  _message,
const bool  _successful 
)
static

Handles graceful shutdown when errors occur:

  • Outputs provided error message
  • Closes device connection if open
  • Exits with appropriate status code
Parameters
_connectionPointer to the device connection to close
_messageError message to display
_successfulWhether termination is due to success or failure

◆ terminate() [2/2]

static void terminate ( mip::Interface _device,
const mip::CmdResult  _cmdResult,
const char *  _format,
  ... 
)
static

Handles command failure scenarios:

  • Formats and displays an error message with command result
  • Closes device connection
  • Exits with failure status
Parameters
_deviceMIP device interface for the command that failed
_cmdResultResult code from a failed command
_formatPrintf-style format string for error message
...Variable arguments for format string

Variable Documentation

◆ PORT_NAME

constexpr const char* PORT_NAME = "/dev/ttyACM0"
staticconstexpr

◆ BAUDRATE

constexpr uint32_t BAUDRATE = 115200
staticconstexpr
Note
For native serial connections this needs to be 115200 due to the device default settings command Use mip::commands_base::*CommSpeed() or mip::commands_3dm::*UartBaudrate() to write and save the baudrate on the device