motion_fx.h File Reference

Header for motion_fx module. More...

#include <stdint.h>

Go to the source code of this file.

Data Structures
struct	MFX_knobs_t
struct	MFX_input_t
struct	MFX_output_t
struct	MFX_MagCal_input_t
struct	MFX_MagCal_output_t

Macros
#define	MFX_NUM_AXES   3
#define	MFX_QNUM_AXES   4

Enumerations
enum	MFX_engine_state_t { MFX_ENGINE_DISABLE = 0, MFX_ENGINE_ENABLE = 1 }
enum	MFX_engine_output_ref_sys { MFX_ENGINE_OUTPUT_NED = 0, MFX_ENGINE_OUTPUT_ENU = 1 }
enum	MFX_MagCal_quality_t { MFX_MAGCALUNKNOWN = 0, MFX_MAGCALPOOR, MFX_MAGCALOK, MFX_MAGCALGOOD }

Functions
void	MotionFX_initialize (void)
	Initialize the MotionFX engine. More...
void	MotionFX_setKnobs (MFX_knobs_t *knobs)
	Set the internal knobs. More...
void	MotionFX_getKnobs (MFX_knobs_t *knobs)
	Get the current internal knobs. More...
MFX_engine_state_t	MotionFX_getStatus_6X (void)
	Get the status of the 6 axes library. More...
MFX_engine_state_t	MotionFX_getStatus_9X (void)
	Get the status of the 9 axes library. More...
void	MotionFX_enable_6X (MFX_engine_state_t enable)
	Enable or disable the 6 axes function (ACC + GYRO) More...
void	MotionFX_enable_9X (MFX_engine_state_t enable)
	Enable or disable the 9 axes function (ACC + GYRO + MAG) More...
void	MotionFX_setGbias (float *gbias)
	Set the initial gbias. More...
void	MotionFX_getGbias (float *gbias)
	Get the initial gbias. More...
void	MotionFX_update (MFX_output_t *data_out, MFX_input_t *data_in, float eml_deltatime, float *eml_q_update)
	Run the Kalman filter update. More...
void	MotionFX_propagate (MFX_output_t *data_out, MFX_input_t *data_in, float eml_deltatime)
	Run the Kalman filter propagate. More...
void	MotionFX_MagCal_init (int sampletime, unsigned short int enable)
	Initialize the compass calibration library. More...
void	MotionFX_MagCal_run (MFX_MagCal_input_t *data_in)
	Run magnetic calibration algorithm. More...
void	MotionFX_MagCal_getParams (MFX_MagCal_output_t *data_out)
	Get magnetic calibration parameters. More...
uint8_t	MotionFX_GetLibVersion (char *version)
	Get the library version. More...

Detailed Description

Header for motion_fx module.

Author

MEMS Application Team

Version

V2.0.0

Date

01-May-2017

Attention

© COPYRIGHT(c) 2017 STMicroelectronics

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of STMicroelectronics nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file motion_fx.h.