MotionMC Software Library: algorithms/Middlewares/ST/STM32_MotionMC_Library/Inc/motion_mc.h Source File

Motion MC

previous page
MotionMC Software Library
MotionMC Software Library Documentation
motion_mc.h
Go to the documentation of this file.
1 
36 /* Define to prevent recursive inclusion -------------------------------------*/
37 #ifndef _MOTION_MC_H_
38 #define _MOTION_MC_H_
39 
40 #ifdef __cplusplus
41 extern "C"
42 {
43 #endif
44 
45 /* Includes ------------------------------------------------------------------*/
46 #include <stdint.h>
47 
59 /* Exported types ------------------------------------------------------------*/
60 
61 typedef enum
62 {
63  MMC_CALQSTATUSUNKNOWN = 0,
64  MMC_CALQSTATUSPOOR,
65  MMC_CALQSTATUSOK,
66  MMC_CALQSTATUSGOOD
67 } MMC_CalQuality_t;
68 
69 typedef struct {
70  float Mag[3]; /* Magnetometer sensor output [uT] */
71  int TimeStamp; /* Timestamp [ms] */
72 } MMC_Input_t;
73 
74 typedef struct {
75  float HI_Bias[3]; /* Hard iron offset array [uT] */
76  float SF_Matrix[3][3]; /* Scale factor correction matrix [-] */
77  MMC_CalQuality_t CalQuality; /* Calibration quality factor */
78 } MMC_Output_t;
79 
84 /* Exported constants --------------------------------------------------------*/
85 /* Exported variables --------------------------------------------------------*/
86 /* Exported macro ------------------------------------------------------------*/
87 
92 /* Exported functions ------------------------------------------------------- */
93 
100 void MotionMC_Initialize(int sampletime, unsigned short int enable);
101 
107 void MotionMC_Update(MMC_Input_t *data_in);
108 
114 void MotionMC_GetCalParams(MMC_Output_t *data_out);
115 
121 uint8_t MotionMC_GetLibVersion(char *version);
122 
135 #ifdef __cplusplus
136 }
137 #endif
138 
139 #endif /* _MOTION_MC_H_ */
140 
141 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
MotionMC_GetCalParams
void MotionMC_GetCalParams(MMC_Output_t *data_out)
Get the magnetic compensation for hard/soft iron.
MMC_CALQSTATUSOK
Definition: motion_mc.h:65
MMC_CALQSTATUSUNKNOWN
Definition: motion_mc.h:63
MMC_Input_t
Definition: motion_mc.h:69
MotionMC_Update
void MotionMC_Update(MMC_Input_t *data_in)
Run Magnetic Calibration algorithm.
MMC_CalQuality_t
MMC_CalQuality_t
Definition: motion_mc.h:61
MotionMC_GetLibVersion
uint8_t MotionMC_GetLibVersion(char *version)
Get the library version.
MMC_CALQSTATUSPOOR
Definition: motion_mc.h:64
MMC_Output_t
Definition: motion_mc.h:74
MMC_Input_t::TimeStamp
int TimeStamp
Definition: motion_mc.h:71
MotionMC_Initialize
void MotionMC_Initialize(int sampletime, unsigned short int enable)
Initialize the MotionMC engine.
MMC_Output_t::CalQuality
MMC_CalQuality_t CalQuality
Definition: motion_mc.h:77
MMC_CALQSTATUSGOOD
Definition: motion_mc.h:66
Generated on Fri Mar 31 2017 11:11:15 for MotionMC Software Library by   doxygen 1.8.9.1
previous page start