MIP_SDK  v3.0.0
MicroStrain Communications Library for embedded systems
Classes | Functions
(0x0C,0x3A) Mag Hard Iron Offset

Configure the user specified magnetometer hard iron offset vector. More...

Classes

struct  mip::commands_3dm::MagHardIronOffset
 

Functions

TypedResult< MagHardIronOffsetmip::commands_3dm::writeMagHardIronOffset (C::mip_interface &device, const float *offset)
 
TypedResult< MagHardIronOffsetmip::commands_3dm::readMagHardIronOffset (C::mip_interface &device, float *offsetOut)
 
TypedResult< MagHardIronOffsetmip::commands_3dm::saveMagHardIronOffset (C::mip_interface &device)
 
TypedResult< MagHardIronOffsetmip::commands_3dm::loadMagHardIronOffset (C::mip_interface &device)
 
TypedResult< MagHardIronOffsetmip::commands_3dm::defaultMagHardIronOffset (C::mip_interface &device)
 

Detailed Description

Configure the user specified magnetometer hard iron offset vector.

The values for this offset are determined empirically by external software algorithms based on calibration data taken after the device is installed in its application. These values can be obtained and set by using Microstrain software tools. Alternatively, on some systems, the auto-mag calibration feature may be used to capture these values in-run. The offset is applied to the scaled magnetometer vector prior to output.

Function Documentation

◆ defaultMagHardIronOffset()

TypedResult< MagHardIronOffset > mip::commands_3dm::defaultMagHardIronOffset ( C::mip_interface device)

◆ loadMagHardIronOffset()

TypedResult< MagHardIronOffset > mip::commands_3dm::loadMagHardIronOffset ( C::mip_interface device)

◆ readMagHardIronOffset()

TypedResult< MagHardIronOffset > mip::commands_3dm::readMagHardIronOffset ( C::mip_interface device,
float *  offsetOut 
)

◆ saveMagHardIronOffset()

TypedResult< MagHardIronOffset > mip::commands_3dm::saveMagHardIronOffset ( C::mip_interface device)

◆ writeMagHardIronOffset()

TypedResult< MagHardIronOffset > mip::commands_3dm::writeMagHardIronOffset ( C::mip_interface device,
const float *  offset 
)