Files | Typedefs | Functions

Virtual Gesture sensor on BMI160. More...

+ Collaboration diagram for Gestures:

Files

file  BCDS_Gestures.h
 

Typedefs

typedef void * Gestures_HandlePtr_T
 

Functions

Retcode_T Gestures_clear (Gestures_HandlePtr_T handle)
 Clear Gestures value (Resets the gestures calculated) More...
 
Retcode_T Gestures_deInit (Gestures_HandlePtr_T handle)
 API to Deinitialise the gestures module. More...
 
Retcode_T Gestures_init (Gestures_HandlePtr_T handle)
 Initializes the Gestures sensor.This API should return RETCODE_OK in order to communicate with sensor.This function needs to be called before calling any other function of the Gestures sensor api. More...
 
Retcode_T Gestures_read (Gestures_HandlePtr_T handle, uint32_t *gesturesValue)
 Read gestures value (Provides the gestures detected) More...
 

Detailed Description

Gestures is used to detect the tilt, wakeup, glance,pick,flip movement done by the user.

Typedef Documentation

typedef void* Gestures_HandlePtr_T

Defines the handle for Gestures sensor

Function Documentation

Retcode_T Gestures_clear ( Gestures_HandlePtr_T  handle)
Parameters
[in]Gestures_HandlePtr_Tthe handle to the Gestures object
Return values
RETCODE_OKClearing of Gesture value success.
RETCODE_FAILUREClearing of Gesture value failure.
RETCODE_NULL_POINTERIn case of invalid sensor handle.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
Pass the return value of this function to BCDS_getSensorErrorCode API to know the sensor return code present in BCDS_SensorErrorType_E.
Retcode_T Gestures_deInit ( Gestures_HandlePtr_T  handle)
Parameters
[in]Gestures_HandlePtr_Tthe handle to the Gestures object which is to be deinitialised
Return values
RETCODE_OKGesture de-initialization success.
RETCODE_FAILUREGesture de-initialization failure.
RETCODE_NULL_POINTERIn case of invalid sensor handle.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
Pass the return value of this function to BCDS_getSensorErrorCode API to know the sensor return code present in BCDS_SensorErrorType_E.'
Retcode_T Gestures_init ( Gestures_HandlePtr_T  handle)
Parameters
[in]Gestures_HandlePtr_Tthe handle to the Gestures object that should be initialized
Return values
RETCODE_OKGesture initialization success.
RETCODE_FAILUREGesture initialization failure.
RETCODE_NULL_POINTERIn case of invalid sensor handle.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
Pass the return value of this function to BCDS_getSensorErrorCode API to know the sensor return code present in BCDS_SensorErrorType_E.
Retcode_T Gestures_read ( Gestures_HandlePtr_T  handle,
uint32_t *  gesturesValue 
)
Parameters
[in]Gestures_HandlePtr_Tthe handle to the Gestures object
[out]gesturesValuevalue of Gestures
Return values
RETCODE_OKReading of Gesture value success.
RETCODE_FAILUREReading of Gesture value failure.
RETCODE_NULL_POINTERIn case of invalid sensor handle.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
Pass the return value of this function to BCDS_getSensorErrorCode API to know the sensor return code present in BCDS_SensorErrorType_E.'

This documentation file has been automatically generated on Fri Oct 4 2019 03:47:38 by doxygen 1.8.8