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

SensorUtils Interfaces of MAX44009. More...

+ Collaboration diagram for MAX44009_SensorUtils:

Files

file  BCDS_Max44009Utils.h
 

Data Structures

struct  Max44009Utils_Info_S
 structure to hold the Max44009 specific configurations like GPIO ,I2c and interrupt pin details. More...
 
struct  Max44009Utils_ThresholdIntrConfig_S
 structure representing the configuration of Max44009 Threshold interrupt More...
 

Typedefs

typedef struct Max44009Utils_Info_S Max44009Utils_Info_T
 
typedef struct
Max44009Utils_Info_S
Max44009Utils_InfoPtr_T
 
typedef struct
Max44009Utils_ThresholdIntrConfig_S 
Max44009Utils_ThresholdIntrConfig_T
 
typedef struct
Max44009Utils_ThresholdIntrConfig_S
Max44009Utils_ThresholdIntrConfigPtr_T
 

Functions

Retcode_T Max44009Utils_configInterrupt (Max44009Utils_ThresholdIntrConfigPtr_T interruptConfig)
 Function to Configure interrupts of Max44009. Before calling this API Update the below information in the appropriate structure 1) Update callback function in Max44009Utils_InfoPtr_T. 2) Update the type of callback(deferred or real time) in Max44009Utils_InfoPtr_T. After calling this API the given interrupt will be enabled and the callback will be associated with the interrupt. More...
 
Retcode_T Max44009Utils_disableInterrupt (void)
 Function to Disable the Interrupt.Max44009 sensor supports only Threshold Interrupt. So, calling this API will disable Max44009 Threshold interrupt explicitly. More...
 
Retcode_T Max44009Utils_initialize (Max44009Utils_InfoPtr_T max44009Info)
 Function to initialize Max44009. This needs to be called before calling any other API. More...
 
Retcode_T Max44009Utils_uninitialize (Max44009Utils_InfoPtr_T max44009Info)
 Function to uninitialize Max44009.After calling this API sensor is no more usable without initializing it again by calling Max44009Utils_initialize() API. More...
 

Detailed Description

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


Data Structure Documentation

struct Max44009Utils_Info_S

Data Fields

uint32_t BspSensorId
 
uint8_t dev_addr
 
BSP_Sensor_InterruptCallback_T ISRCallback
 

Field Documentation

uint32_t BspSensorId
uint8_t dev_addr
struct Max44009Utils_ThresholdIntrConfig_S

Data Fields

uint8_t lowerThreshold
 
uint8_t thresholdTimer
 
uint8_t upperThreshold
 

Field Documentation

uint8_t lowerThreshold

value to be programmed in lower threshold register for Max44009 interrupt

uint8_t thresholdTimer

value to be programmed in threshold timer register for Max44009 interrupt

uint8_t upperThreshold

value to be programmed in upper threshold register for Max44009 interrupt

Typedef Documentation

Function Documentation

Retcode_T Max44009Utils_configInterrupt ( Max44009Utils_ThresholdIntrConfigPtr_T  interruptConfig)
Parameters
[in]interruptConfig:Structure holding the information about interrupt related configuration should be given here
Return values
RETCODE_OKMax44009 interrupt configuration success
RETCODE_NULL_POINTERwhen interruptConfig is NULL.
RETCODE_UNINITIALIZEDwhen this api is called before initializing Bma280 sensor.
Returns
In case of other failures refer #MAX44009_setUpperThreshold or #MAX44009_setLowerThreshold or #MAX44009_setThresholdTimer or #MAX44009_setIntrptReg API's.
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:

Retcode_T Max44009Utils_disableInterrupt ( void  )
Return values
RETCODE_OKMax44009 disable interrupt success
RETCODE_UNINITIALIZEDwhen this api is called before initializing Bma280 sensor.
Returns
In case of other failures refer #MAX44009_setIntrptReg 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:

Retcode_T Max44009Utils_initialize ( Max44009Utils_InfoPtr_T  max44009Info)
Parameters
[in]max44009Info:structure holding the Max44009 specific configurations
Return values
RETCODE_OKMax44009 initialized successfully
RETCODE_NULL_POINTERwhen any of the input parameter(max44009Info or max44009Info->ISRCallback) is NULL.
RETCODE_DOPPLE_INITIALIZATIONWhen initialization is already done.
Returns
In case of other failures refer BSP_SensorNode_Enable or #I2CSensorTransceiver_Init or #MAX44009_init or #MAX44009_setCdr or #MAX44009_setIntegrationTime or #MAX44009_setContinousModeReg 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 library.
3) Calling Max44009 initialization API present in sensorUtils (Max44009Utils_initialize) and sensorDriver (MAX09_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 Max44009Utils_uninitialize ( Max44009Utils_InfoPtr_T  max44009Info)
Parameters
[in]max44009Info:structure holding the Max44009 specific configurations
Return values
RETCODE_OKMax44009 un-initialization success
RETCODE_NULL_POINTERwhen max44009Info 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