SensorTile_magneto.c File Reference

This file provides the magnetometer driver for the Sensor Tile board. More...

#include "SensorTile_magneto.h"

Go to the source code of this file.

Functions
static DrvStatusTypeDef	BSP_LSM303AGR_MAGNETO_Init (void **handle)
DrvStatusTypeDef	Sensor_IO_Init (void)
DrvStatusTypeDef	BSP_MAGNETO_Init (MAGNETO_ID_t id, void **handle)
	Initialize a magnetometer sensor. More...
DrvStatusTypeDef	BSP_MAGNETO_DeInit (void **handle)
	Deinitialize a magnetometer sensor. More...
DrvStatusTypeDef	BSP_MAGNETO_Sensor_Enable (void *handle)
	Enable magnetometer sensor. More...
DrvStatusTypeDef	BSP_MAGNETO_Sensor_Disable (void *handle)
	Disable magnetometer sensor. More...
DrvStatusTypeDef	BSP_MAGNETO_IsInitialized (void *handle, uint8_t *status)
	Check if the magnetometer sensor is initialized. More...
DrvStatusTypeDef	BSP_MAGNETO_IsEnabled (void *handle, uint8_t *status)
	Check if the magnetometer sensor is enabled. More...
DrvStatusTypeDef	BSP_MAGNETO_IsCombo (void *handle, uint8_t *status)
	Check if the magnetometer sensor is combo. More...
DrvStatusTypeDef	BSP_MAGNETO_Get_Instance (void *handle, uint8_t *instance)
	Get the magnetometer sensor instance. More...
DrvStatusTypeDef	BSP_MAGNETO_Get_WhoAmI (void *handle, uint8_t *who_am_i)
	Get the WHO_AM_I ID of the magnetometer sensor. More...
DrvStatusTypeDef	BSP_MAGNETO_Check_WhoAmI (void *handle)
	Check the WHO_AM_I ID of the magnetometer sensor. More...
DrvStatusTypeDef	BSP_MAGNETO_Get_Axes (void *handle, SensorAxes_t *magnetic_field)
	Get the magnetometer sensor axes. More...
DrvStatusTypeDef	BSP_MAGNETO_Get_AxesRaw (void *handle, SensorAxesRaw_t *value)
	Get the magnetometer sensor raw axes. More...
DrvStatusTypeDef	BSP_MAGNETO_Get_Sensitivity (void *handle, float *sensitivity)
	Get the magnetometer sensor sensitivity. More...
DrvStatusTypeDef	BSP_MAGNETO_Get_ODR (void *handle, float *odr)
	Get the magnetometer sensor output data rate. More...
DrvStatusTypeDef	BSP_MAGNETO_Set_ODR (void *handle, SensorOdr_t odr)
	Set the magnetometer sensor output data rate. More...
DrvStatusTypeDef	BSP_MAGNETO_Set_ODR_Value (void *handle, float odr)
	Set the magnetometer sensor output data rate. More...
DrvStatusTypeDef	BSP_MAGNETO_Get_FS (void *handle, float *fullScale)
	Get the magnetometer sensor full scale. More...
DrvStatusTypeDef	BSP_MAGNETO_Set_FS (void *handle, SensorFs_t fullScale)
	Set the magnetometer sensor full scale. More...
DrvStatusTypeDef	BSP_MAGNETO_Set_FS_Value (void *handle, float fullScale)
	Set the magnetometer sensor full scale. More...
DrvStatusTypeDef	BSP_MAGNETO_Read_Reg (void *handle, uint8_t reg, uint8_t *data)
	Read the data from register. More...
DrvStatusTypeDef	BSP_MAGNETO_Write_Reg (void *handle, uint8_t reg, uint8_t data)
	Write the data to register. More...
DrvStatusTypeDef	BSP_MAGNETO_Get_DRDY_Status (void *handle, uint8_t *status)
	Get magnetometer data ready status. More...

Variables
static DrvContextTypeDef	MAGNETO_SensorHandle [MAGNETO_SENSORS_MAX_NUM]
static MAGNETO_Data_t	MAGNETO_Data [MAGNETO_SENSORS_MAX_NUM]
static LSM303AGR_M_Data_t	LSM303AGR_M_0_Data

Detailed Description

This file provides the magnetometer driver for the Sensor Tile board.

Author

Central Labs

Version

V1.3.1

Date

27-Apr-2017

Attention

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