Configure the user specified magnetometer soft iron offset matrix. More...
Classes | |
| struct | mip_3dm_mag_soft_iron_matrix_command |
| struct | mip_3dm_mag_soft_iron_matrix_response |
Typedefs | |
| typedef struct mip_3dm_mag_soft_iron_matrix_command | mip_3dm_mag_soft_iron_matrix_command |
| typedef struct mip_3dm_mag_soft_iron_matrix_response | mip_3dm_mag_soft_iron_matrix_response |
Functions | |
| void | extract_mip_3dm_mag_soft_iron_matrix_command (struct mip_serializer *serializer, mip_3dm_mag_soft_iron_matrix_command *self) |
| void | extract_mip_3dm_mag_soft_iron_matrix_response (struct mip_serializer *serializer, mip_3dm_mag_soft_iron_matrix_response *self) |
| void | insert_mip_3dm_mag_soft_iron_matrix_command (struct mip_serializer *serializer, const mip_3dm_mag_soft_iron_matrix_command *self) |
| void | insert_mip_3dm_mag_soft_iron_matrix_response (struct mip_serializer *serializer, const mip_3dm_mag_soft_iron_matrix_response *self) |
| mip_cmd_result | mip_3dm_default_mag_soft_iron_matrix (struct mip_interface *device) |
| mip_cmd_result | mip_3dm_load_mag_soft_iron_matrix (struct mip_interface *device) |
| mip_cmd_result | mip_3dm_read_mag_soft_iron_matrix (struct mip_interface *device, float *offset_out) |
| mip_cmd_result | mip_3dm_save_mag_soft_iron_matrix (struct mip_interface *device) |
| mip_cmd_result | mip_3dm_write_mag_soft_iron_matrix (struct mip_interface *device, const float *offset) |
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 the LORD "MIP Iron Calibration" application. 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
Definition at line 1862 of file commands_3dm.h.
◆ mip_3dm_mag_soft_iron_matrix_response
Definition at line 1871 of file commands_3dm.h.
Function Documentation
◆ extract_mip_3dm_mag_soft_iron_matrix_command()
| void extract_mip_3dm_mag_soft_iron_matrix_command | ( | struct mip_serializer * | serializer, |
| mip_3dm_mag_soft_iron_matrix_command * | self | ||
| ) |
Definition at line 4165 of file commands_3dm.c.
◆ extract_mip_3dm_mag_soft_iron_matrix_response()
| void extract_mip_3dm_mag_soft_iron_matrix_response | ( | struct mip_serializer * | serializer, |
| mip_3dm_mag_soft_iron_matrix_response * | self | ||
| ) |
Definition at line 4183 of file commands_3dm.c.
◆ insert_mip_3dm_mag_soft_iron_matrix_command()
| void insert_mip_3dm_mag_soft_iron_matrix_command | ( | struct mip_serializer * | serializer, |
| const mip_3dm_mag_soft_iron_matrix_command * | self | ||
| ) |
Definition at line 4154 of file commands_3dm.c.
◆ insert_mip_3dm_mag_soft_iron_matrix_response()
| void insert_mip_3dm_mag_soft_iron_matrix_response | ( | struct mip_serializer * | serializer, |
| const mip_3dm_mag_soft_iron_matrix_response * | self | ||
| ) |
Definition at line 4177 of file commands_3dm.c.
◆ mip_3dm_default_mag_soft_iron_matrix()
| mip_cmd_result mip_3dm_default_mag_soft_iron_matrix | ( | struct mip_interface * | device | ) |
Definition at line 4257 of file commands_3dm.c.
◆ mip_3dm_load_mag_soft_iron_matrix()
| mip_cmd_result mip_3dm_load_mag_soft_iron_matrix | ( | struct mip_interface * | device | ) |
Definition at line 4245 of file commands_3dm.c.
◆ mip_3dm_read_mag_soft_iron_matrix()
| mip_cmd_result mip_3dm_read_mag_soft_iron_matrix | ( | struct mip_interface * | device, |
| float * | offset_out | ||
| ) |
Definition at line 4206 of file commands_3dm.c.
◆ mip_3dm_save_mag_soft_iron_matrix()
| mip_cmd_result mip_3dm_save_mag_soft_iron_matrix | ( | struct mip_interface * | device | ) |
Definition at line 4233 of file commands_3dm.c.
◆ mip_3dm_write_mag_soft_iron_matrix()
| mip_cmd_result mip_3dm_write_mag_soft_iron_matrix | ( | struct mip_interface * | device, |
| const float * | offset | ||
| ) |
Definition at line 4190 of file commands_3dm.c.