XDK API  3.6.0
Documentation
Files | Data Structures | Typedefs | Functions
BMM150_SensorUtils

SensorUtils Interfaces of BMM150. More...

+ Collaboration diagram for BMM150_SensorUtils:

Files

file  BCDS_Bmm150Utils.h
 

Data Structures

struct  Bmm150Utils_Info_S
 structure to hold the Magnetometer specific GPIO ,I2c configurations,Remap configuration and the function pointers to initialize configure and get the data from the sensor More...
 

Typedefs

typedef struct Bmm150Utils_Info_S Bmm150Utils_Info_T
 
typedef struct Bmm150Utils_Info_SBmm150Utils_InfoPtr_T
 

Functions

Retcode_T Bmm150Utils_initialize (Bmm150Utils_InfoPtr_T bmm150Info)
 Function to initialize bmm150.This needs to be called before calling any other API. More...
 
Retcode_T Bmm150Utils_remapAxis (Bmm150Utils_InfoPtr_T bmm150Info, AxisRemap_Data_T *bmiData)
 Function to read remapped bmm150 data . More...
 
Retcode_T Bmm150Utils_uninitialize (Bmm150Utils_InfoPtr_T bmm150Info)
 Function to uninitialize bmm150.After calling this API sensor is no more usable without initializing it again by calling initialize API. More...
 

Detailed Description

The interface header exports High-level Sensor API's which are used to Initialize sensor, and re-map the axis for the BMM150.


Data Structure Documentation

struct Bmm150Utils_Info_S
+ Collaboration diagram for Bmm150Utils_Info_S:

Data Fields

uint32_t BspSensorId
 
uint8_t dev_addr
 
BSP_Sensor_InterruptCallback_T ISRCallback
 
AxisRemap_Config_T remap
 

Field Documentation

uint32_t BspSensorId
uint8_t dev_addr

Typedef Documentation

Function Documentation

Retcode_T Bmm150Utils_initialize ( Bmm150Utils_InfoPtr_T  bmm150Info)
Parameters
[in]bmm150Info:structure holding the bmm150 specific configurations
Return values
RETCODE_OKBMM150 initialized successfully
RETCODE_NULL_POINTERwhen any of the input parameter(bmm150Info or bmm150Info->ISRCallback) is NULL.
RETCODE_LIB_NULL_POINTERwhen any of the input parameter for BST library API is NULL.
RETCODE_BST_BMM150_ERRORwhen error is returned from BST library API.
RETCODE_DOPPLE_INITIALIZATIONWhen initialization is already done.
Returns
In case of other failures refer BSP_SensorNode_Enable or #I2CSensorTransceiver_Init API's.
Note
1) The return value consist of (First MSB Byte represents Package ID,Next Byte represents Severity and Last 2LSB Bytes represents error code).
2) The support of multiple instances is not possible due to the limitation in the BST library.
3) Calling Bmm150 initialization API present in sensorUtils (Bmm150Utils_initialize) and BST library (bmm050_init) concurrently will lead to unexpected behaviour.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Retcode_T Bmm150Utils_remapAxis ( Bmm150Utils_InfoPtr_T  bmm150Info,
AxisRemap_Data_T bmiData 
)
Parameters
[in]bmm150Info:structure holding the bmm150 specific configurations
[in,out]bmiData:structure to hold the remapped magnetometer data
Return values
RETCODE_OKBMM150 axis remap success
RETCODE_NULL_POINTERwhen any of the input parameter is NULL.
RETCODE_UNINITIALIZEDwhen this api is called before initializing Bma280 sensor.
Returns
In case of other failures refer AxisRemap_remapSensorData API.
Note
The return value consist of (First MSB Byte represents Package ID,Next Byte represents Severity and Last 2LSB Bytes represents error code).

copying the actual sensor data into a local variable

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Retcode_T Bmm150Utils_uninitialize ( Bmm150Utils_InfoPtr_T  bmm150Info)
Parameters
[in]bmm150Info:structure holding the bmm150 specific configurations
Return values
RETCODE_OKBMM150 un-initialization success
RETCODE_NULL_POINTERwhen bmm150Info is NULL.
RETCODE_UNINITIALIZEDwhen this api is called before initializing Bma280 sensor.
Returns
In case of other failures refer BSP_SensorNode_Disable or BSP_SensorNode_IsAllNodesDisabled or #I2CSensorTransceiver_Deinit API.
Note
The return value consist of (First MSB Byte represents Package ID,Next Byte represents Severity and Last 2LSB Bytes represents error code).

+ Here is the call graph for this function:

+ Here is the caller graph for this function:


All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:52 by doxygen 1.8.8