MIP_SDK  latest-2-g34f3e39
MicroStrain Communications Library for embedded systems
Classes | Typedefs | Functions
(0x0C,0x3B) Mag Soft Iron Matrix

Configure the user specified magnetometer soft iron offset matrix. More...

Classes

struct  mip::C::mip_3dm_mag_soft_iron_matrix_command
 
struct  mip::C::mip_3dm_mag_soft_iron_matrix_response
 

Typedefs

typedef struct mip_3dm_mag_soft_iron_matrix_command mip::C::mip_3dm_mag_soft_iron_matrix_command
 
typedef struct mip_3dm_mag_soft_iron_matrix_response mip::C::mip_3dm_mag_soft_iron_matrix_response
 

Functions

void mip::C::insert_mip_3dm_mag_soft_iron_matrix_command (microstrain_serializer *serializer, const mip_3dm_mag_soft_iron_matrix_command *self)
 
void mip::C::extract_mip_3dm_mag_soft_iron_matrix_command (microstrain_serializer *serializer, mip_3dm_mag_soft_iron_matrix_command *self)
 
void mip::C::insert_mip_3dm_mag_soft_iron_matrix_response (microstrain_serializer *serializer, const mip_3dm_mag_soft_iron_matrix_response *self)
 
void mip::C::extract_mip_3dm_mag_soft_iron_matrix_response (microstrain_serializer *serializer, mip_3dm_mag_soft_iron_matrix_response *self)
 
mip_cmd_result mip::C::mip_3dm_write_mag_soft_iron_matrix (mip_interface *device, const float *offset)
 
mip_cmd_result mip::C::mip_3dm_read_mag_soft_iron_matrix (mip_interface *device, float *offset_out)
 
mip_cmd_result mip::C::mip_3dm_save_mag_soft_iron_matrix (mip_interface *device)
 
mip_cmd_result mip::C::mip_3dm_load_mag_soft_iron_matrix (mip_interface *device)
 
mip_cmd_result mip::C::mip_3dm_default_mag_soft_iron_matrix (mip_interface *device)
 

Detailed Description

Configure the user specified magnetometer soft iron offset matrix.

The values for this matrix 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 matrix is applied to the scaled magnetometer vector prior to output.

The matrix is in row major order: EQSTART M = \begin{bmatrix} 0 & 1 & 2 \\ 3 & 4 & 5 \\ 6 & 7 & 8 \end{bmatrix} EQEND

Typedef Documentation

◆ mip_3dm_mag_soft_iron_matrix_command

◆ mip_3dm_mag_soft_iron_matrix_response

Function Documentation

◆ extract_mip_3dm_mag_soft_iron_matrix_command()

void mip::C::extract_mip_3dm_mag_soft_iron_matrix_command ( microstrain_serializer serializer,
mip_3dm_mag_soft_iron_matrix_command self 
)

◆ extract_mip_3dm_mag_soft_iron_matrix_response()

void mip::C::extract_mip_3dm_mag_soft_iron_matrix_response ( microstrain_serializer serializer,
mip_3dm_mag_soft_iron_matrix_response self 
)

◆ insert_mip_3dm_mag_soft_iron_matrix_command()

void mip::C::insert_mip_3dm_mag_soft_iron_matrix_command ( microstrain_serializer serializer,
const mip_3dm_mag_soft_iron_matrix_command self 
)

◆ insert_mip_3dm_mag_soft_iron_matrix_response()

void mip::C::insert_mip_3dm_mag_soft_iron_matrix_response ( microstrain_serializer serializer,
const mip_3dm_mag_soft_iron_matrix_response self 
)

◆ mip_3dm_default_mag_soft_iron_matrix()

mip_cmd_result mip::C::mip_3dm_default_mag_soft_iron_matrix ( mip_interface device)

◆ mip_3dm_load_mag_soft_iron_matrix()

mip_cmd_result mip::C::mip_3dm_load_mag_soft_iron_matrix ( mip_interface device)

◆ mip_3dm_read_mag_soft_iron_matrix()

mip_cmd_result mip::C::mip_3dm_read_mag_soft_iron_matrix ( mip_interface device,
float *  offset_out 
)

◆ mip_3dm_save_mag_soft_iron_matrix()

mip_cmd_result mip::C::mip_3dm_save_mag_soft_iron_matrix ( mip_interface device)

◆ mip_3dm_write_mag_soft_iron_matrix()

mip_cmd_result mip::C::mip_3dm_write_mag_soft_iron_matrix ( mip_interface device,
const float *  offset 
)