Provides function prototypes for driver level interfaces It does not have a corresponding .c or .cpp file. Rather, it declares functions contained in hardware-specific files. More...

This graph shows which files directly or indirectly include this file:

Typedefs
typedef struct SensorFusionGlobals	SensorFusionGlobals

typedef struct PhysicalSensor	PhysicalSensor

Functions
Sensor Interface Prototypes
Each physical sensor must be provided with one initialization function and one "read" function. These must be installed by the user using the installSensor method defined in SensorFusionGlobals. A "physical sensor", can mean either individual sensor type (such as a 3-axis accelerometer) or a combo-sensor such as the NXP FXOS8700 6-axis accel plus mag. In the latter case, both the accel and mag readings will be made in the same call. On the other hand, if you need the sensor modes read at different rates, then define a separate *_Read() function for each mode. This might be prefered if, for example, the magnetometer doesn't have a FIFO whereas the the accelerometer on the same IC does and so the accelerometer can be read in bursts less often than the magnetometer. The init() function for each sensor is responsible for initializing all sensors contained in that package. The read() function is responsible for reading those same sensors and moving the results into the standard structures contained within the SensorFusionGlobals object.
int8_t	FXOS8700_Accel_Init (PhysicalSensor sensor, SensorFusionGlobals sfg)

int8_t	FXOS8700_Mag_Init (PhysicalSensor sensor, SensorFusionGlobals sfg)

int8_t	FXOS8700_Therm_Init (PhysicalSensor sensor, SensorFusionGlobals sfg)

int8_t	FXOS8700_Init (PhysicalSensor sensor, SensorFusionGlobals sfg)

int8_t	FXAS21002_Init (PhysicalSensor sensor, SensorFusionGlobals sfg)

int8_t	FXOS8700_Accel_Read (PhysicalSensor sensor, SensorFusionGlobals sfg)

int8_t	FXOS8700_Mag_Read (PhysicalSensor sensor, SensorFusionGlobals sfg)

int8_t	FXOS8700_Therm_Read (PhysicalSensor sensor, SensorFusionGlobals sfg)

int8_t	FXOS8700_Read (PhysicalSensor sensor, SensorFusionGlobals sfg)

int8_t	FXAS21002_Read (PhysicalSensor sensor, SensorFusionGlobals sfg)

int8_t	FXOS8700_Idle (PhysicalSensor sensor, SensorFusionGlobals sfg)

int8_t	FXAS21002_Idle (PhysicalSensor sensor, SensorFusionGlobals sfg)

Detailed Description

Provides function prototypes for driver level interfaces It does not have a corresponding .c or .cpp file. Rather, it declares functions contained in hardware-specific files.

To use, for example, the NXP FXOS8700, include the driver_FXOS8700.c source file in the build and ensure its Init and Read methods for the sensor are declared here.

Definition in file driver_sensors.h.

Typedef Documentation

◆ PhysicalSensor

typedef struct PhysicalSensor PhysicalSensor

Definition at line 30 of file driver_sensors.h.

◆ SensorFusionGlobals

typedef struct SensorFusionGlobals SensorFusionGlobals

Definition at line 29 of file driver_sensors.h.

Function Documentation

◆ FXOS8700_Accel_Init()

int8_t FXOS8700_Accel_Init	(	PhysicalSensor *	sensor,
		SensorFusionGlobals *	sfg
	)

Definition at line 134 of file driver_fxos8700.c.

◆ FXOS8700_Idle()

int8_t FXOS8700_Idle	(	PhysicalSensor *	sensor,
		SensorFusionGlobals *	sfg
	)

Definition at line 338 of file driver_fxos8700.c.

◆ FXOS8700_Init()

int8_t FXOS8700_Init	(	PhysicalSensor *	sensor,
		SensorFusionGlobals *	sfg
	)

Definition at line 153 of file driver_fxos8700.c.

◆ FXOS8700_Mag_Init()

int8_t FXOS8700_Mag_Init	(	PhysicalSensor *	sensor,
		SensorFusionGlobals *	sfg
	)

Definition at line 141 of file driver_fxos8700.c.

◆ FXOS8700_Mag_Read()

int8_t FXOS8700_Mag_Read	(	PhysicalSensor *	sensor,
		SensorFusionGlobals *	sfg
	)

Definition at line 261 of file driver_fxos8700.c.

◆ FXOS8700_Read()

int8_t FXOS8700_Read	(	PhysicalSensor *	sensor,
		SensorFusionGlobals *	sfg
	)

Definition at line 309 of file driver_fxos8700.c.

◆ FXOS8700_Therm_Init()

int8_t FXOS8700_Therm_Init	(	PhysicalSensor *	sensor,
		SensorFusionGlobals *	sfg
	)

Definition at line 147 of file driver_fxos8700.c.

◆ FXOS8700_Therm_Read()

int8_t FXOS8700_Therm_Read	(	PhysicalSensor *	sensor,
		SensorFusionGlobals *	sfg
	)

Definition at line 288 of file driver_fxos8700.c.

Typedefs

Functions