STSW-STLKT01: Drivers/BSP/SensorTile/SensorTile_magneto.h Source File

STSW-STLKT01

previous page next page
STSW-STLKT01
SensorTile_magneto.h
Go to the documentation of this file.
1 
38 /* Define to prevent recursive inclusion -------------------------------------*/
39 #ifndef __SENSOR_TILE_MAGNETO_H
40 #define __SENSOR_TILE_MAGNETO_H
41 
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45 
46 
47 
48 /* Includes ------------------------------------------------------------------*/
49 #include "LSM303AGR_MAG_driver_HL.h"
50 #include "SensorTile.h"
51 
52 
53 
70 typedef enum
71 {
72  MAGNETO_SENSORS_AUTO = -1, /* Always first element and equal to -1 */
73  LSM303AGR_M_0 /* Default on board. */
74 } MAGNETO_ID_t;
75 
84 #define MAGNETO_SENSORS_MAX_NUM 1
85 
95 /* Sensor Configuration Functions */
96 DrvStatusTypeDef BSP_MAGNETO_Init( MAGNETO_ID_t id, void **handle );
97 DrvStatusTypeDef BSP_MAGNETO_DeInit( void **handle );
98 DrvStatusTypeDef BSP_MAGNETO_Sensor_Enable( void *handle );
99 DrvStatusTypeDef BSP_MAGNETO_Sensor_Disable( void *handle );
100 DrvStatusTypeDef BSP_MAGNETO_IsInitialized( void *handle, uint8_t *status );
101 DrvStatusTypeDef BSP_MAGNETO_IsEnabled( void *handle, uint8_t *status );
102 DrvStatusTypeDef BSP_MAGNETO_IsCombo( void *handle, uint8_t *status );
103 DrvStatusTypeDef BSP_MAGNETO_Get_Instance( void *handle, uint8_t *instance );
104 DrvStatusTypeDef BSP_MAGNETO_Get_WhoAmI( void *handle, uint8_t *who_am_i );
105 DrvStatusTypeDef BSP_MAGNETO_Check_WhoAmI( void *handle );
106 DrvStatusTypeDef BSP_MAGNETO_Get_Axes( void *handle, SensorAxes_t *magnetic_field );
107 DrvStatusTypeDef BSP_MAGNETO_Get_AxesRaw( void *handle, SensorAxesRaw_t *value );
108 DrvStatusTypeDef BSP_MAGNETO_Get_Sensitivity( void *handle, float *sensitivity );
109 DrvStatusTypeDef BSP_MAGNETO_Get_ODR( void *handle, float *odr );
110 DrvStatusTypeDef BSP_MAGNETO_Set_ODR( void *handle, SensorOdr_t odr );
111 DrvStatusTypeDef BSP_MAGNETO_Set_ODR_Value( void *handle, float odr );
112 DrvStatusTypeDef BSP_MAGNETO_Get_FS( void *handle, float *fullScale );
113 DrvStatusTypeDef BSP_MAGNETO_Set_FS( void *handle, SensorFs_t fullScale );
114 DrvStatusTypeDef BSP_MAGNETO_Set_FS_Value( void *handle, float fullScale );
115 DrvStatusTypeDef BSP_MAGNETO_Read_Reg( void *handle, uint8_t reg, uint8_t *data );
116 DrvStatusTypeDef BSP_MAGNETO_Write_Reg( void *handle, uint8_t reg, uint8_t data );
117 DrvStatusTypeDef BSP_MAGNETO_Get_DRDY_Status( void *handle, uint8_t *status );
134 #ifdef __cplusplus
135 }
136 #endif
137 
138 #endif /* __SENSOR_TILE_MAGNETO_H */
139 
140 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
BSP_MAGNETO_Set_ODR
DrvStatusTypeDef BSP_MAGNETO_Set_ODR(void *handle, SensorOdr_t odr)
Set the magnetometer sensor output data rate.
Definition: SensorTile_magneto.c:648
BSP_MAGNETO_Get_ODR
DrvStatusTypeDef BSP_MAGNETO_Get_ODR(void *handle, float *odr)
Get the magnetometer sensor output data rate.
Definition: SensorTile_magneto.c:610
BSP_MAGNETO_Write_Reg
DrvStatusTypeDef BSP_MAGNETO_Write_Reg(void *handle, uint8_t reg, uint8_t data)
Write the data to register.
Definition: SensorTile_magneto.c:863
BSP_MAGNETO_Get_AxesRaw
DrvStatusTypeDef BSP_MAGNETO_Get_AxesRaw(void *handle, SensorAxesRaw_t *value)
Get the magnetometer sensor raw axes.
Definition: SensorTile_magneto.c:531
BSP_MAGNETO_Get_Sensitivity
DrvStatusTypeDef BSP_MAGNETO_Get_Sensitivity(void *handle, float *sensitivity)
Get the magnetometer sensor sensitivity.
Definition: SensorTile_magneto.c:572
BSP_MAGNETO_Sensor_Disable
DrvStatusTypeDef BSP_MAGNETO_Sensor_Disable(void *handle)
Disable magnetometer sensor.
Definition: SensorTile_magneto.c:279
BSP_MAGNETO_Check_WhoAmI
DrvStatusTypeDef BSP_MAGNETO_Check_WhoAmI(void *handle)
Check the WHO_AM_I ID of the magnetometer sensor.
Definition: SensorTile_magneto.c:459
BSP_MAGNETO_IsEnabled
DrvStatusTypeDef BSP_MAGNETO_IsEnabled(void *handle, uint8_t *status)
Check if the magnetometer sensor is enabled.
Definition: SensorTile_magneto.c:340
BSP_MAGNETO_Get_Axes
DrvStatusTypeDef BSP_MAGNETO_Get_Axes(void *handle, SensorAxes_t *magnetic_field)
Get the magnetometer sensor axes.
Definition: SensorTile_magneto.c:493
BSP_MAGNETO_Set_FS_Value
DrvStatusTypeDef BSP_MAGNETO_Set_FS_Value(void *handle, float fullScale)
Set the magnetometer sensor full scale.
Definition: SensorTile_magneto.c:788
BSP_MAGNETO_Sensor_Enable
DrvStatusTypeDef BSP_MAGNETO_Sensor_Enable(void *handle)
Enable magnetometer sensor.
Definition: SensorTile_magneto.c:245
BSP_MAGNETO_DeInit
DrvStatusTypeDef BSP_MAGNETO_DeInit(void **handle)
Deinitialize a magnetometer sensor.
Definition: SensorTile_magneto.c:209
SensorTile.h
This file contains definitions for SensorTile.c file.
BSP_MAGNETO_Get_DRDY_Status
DrvStatusTypeDef BSP_MAGNETO_Get_DRDY_Status(void *handle, uint8_t *status)
Get magnetometer data ready status.
Definition: SensorTile_magneto.c:898
BSP_MAGNETO_Get_Instance
DrvStatusTypeDef BSP_MAGNETO_Get_Instance(void *handle, uint8_t *instance)
Get the magnetometer sensor instance.
Definition: SensorTile_magneto.c:394
BSP_MAGNETO_Set_ODR_Value
DrvStatusTypeDef BSP_MAGNETO_Set_ODR_Value(void *handle, float odr)
Set the magnetometer sensor output data rate.
Definition: SensorTile_magneto.c:682
BSP_MAGNETO_Get_WhoAmI
DrvStatusTypeDef BSP_MAGNETO_Get_WhoAmI(void *handle, uint8_t *who_am_i)
Get the WHO_AM_I ID of the magnetometer sensor.
Definition: SensorTile_magneto.c:422
BSP_MAGNETO_Init
DrvStatusTypeDef BSP_MAGNETO_Init(MAGNETO_ID_t id, void **handle)
Initialize a magnetometer sensor.
Definition: SensorTile_magneto.c:101
BSP_MAGNETO_IsCombo
DrvStatusTypeDef BSP_MAGNETO_IsCombo(void *handle, uint8_t *status)
Check if the magnetometer sensor is combo.
Definition: SensorTile_magneto.c:367
BSP_MAGNETO_Get_FS
DrvStatusTypeDef BSP_MAGNETO_Get_FS(void *handle, float *fullScale)
Get the magnetometer sensor full scale.
Definition: SensorTile_magneto.c:716
BSP_MAGNETO_IsInitialized
DrvStatusTypeDef BSP_MAGNETO_IsInitialized(void *handle, uint8_t *status)
Check if the magnetometer sensor is initialized.
Definition: SensorTile_magneto.c:313
BSP_MAGNETO_Set_FS
DrvStatusTypeDef BSP_MAGNETO_Set_FS(void *handle, SensorFs_t fullScale)
Set the magnetometer sensor full scale.
Definition: SensorTile_magneto.c:754
BSP_MAGNETO_Read_Reg
DrvStatusTypeDef BSP_MAGNETO_Read_Reg(void *handle, uint8_t reg, uint8_t *data)
Read the data from register.
Definition: SensorTile_magneto.c:822
Generated by   doxygen 1.8.13
previous page start next page