osx_motion_fx.h File Reference

Header for OSX MotionFX module. More...

#include "stdint.h"

Go to the source code of this file.

Data Structures
struct	osxMFX_knobs
struct	osxMFX_input
struct	osxMFX_output
struct	osxMFX_calibFactor

Macros
#define	NUM_AXES   3
#define	QNUM_AXES   4

Enumerations
enum	osxMFX_Engine_State { OSXMFX_ENGINE_DISABLE = 0, OSXMFX_ENGINE_ENABLE = 1 }
enum	osxMFX_Engine_Output_Ref_Sys { OSXMFX_ENGINE_OUTPUT_NED = 0, OSXMFX_ENGINE_OUTPUT_ENU = 1 }

Functions
uint8_t	osx_MotionFX_initialize (void)
	Initialize the MotionFX engine. More...
void	osx_MotionFX_setKnobs (osxMFX_knobs *knobs)
	Set the internal knobs. More...
void	osx_MotionFX_getKnobs (osxMFX_knobs *knobs)
	Get the current internal knobs. More...
osxMFX_Engine_State	osx_MotionFX_getStatus_6X (void)
	Get the status of the 6 axes library. More...
osxMFX_Engine_State	osx_MotionFX_getStatus_9X (void)
	Get the status of the 9 axes library. More...
void	osx_MotionFX_enable_6X (osxMFX_Engine_State enable)
	Enable or disable the 6 axes function (ACC + GYRO) More...
void	osx_MotionFX_enable_9X (osxMFX_Engine_State enable)
	Enable or disable the 9 axes function (ACC + GYRO + MAG) More...
void	osx_MotionFX_setGbias (float *gbias)
	Set the initial gbias. More...
void	osx_MotionFX_getGbias (float *gbias)
	Get the initial gbias. More...
void	osx_MotionFX_update (osxMFX_output *data_out, osxMFX_input *data_in, float eml_deltatime, float *eml_q_update)
	Run the Kalman filter update. More...
void	osx_MotionFX_propagate (osxMFX_output *data_out, osxMFX_input *data_in, float eml_deltatime)
	Run the Kalman filter propagate. More...
int	osx_MotionFX_getLibVersion (char *version)
	Get the library version. More...
void	osx_MotionFX_compass_init (void)
	Initialize the compass calibration library. More...
void	osx_MotionFX_compass_saveAcc (int acc_x, int acc_y, int acc_z)
	Save accelerometer data ENU systems coordinate. More...
void	osx_MotionFX_compass_saveMag (int mag_x, int mag_y, int mag_z)
	Save magnetometer data ENU systems coordinate. More...
int	osx_MotionFX_compass_run (void)
	Run compass API at 25 Hz. More...
unsigned char	osx_MotionFX_compass_isCalibrated (void)
	Check if calibration is needed. More...
void	osx_MotionFX_compass_forceReCalibration (void)
	Force new calibration. More...
void	osx_MotionFX_getCalibrationData (osxMFX_calibFactor *CalibrationData)
	Get calibration data. More...
void	osx_MotionFX_setCalibrationData (osxMFX_calibFactor *CalibrationData)
	Set calibration data. More...

Detailed Description

Header for OSX MotionFX module.

Author

VMA Application Team

Version

V1.0.7

Date

17-September-2015

Attention

© COPYRIGHT(c) 2016 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.