Data Structures | Macros | Typedefs | Enumerations | Functions
BCDS_Accelerometer.h File Reference
#include "BCDS_Retcode.h"
+ Include dependency graph for BCDS_Accelerometer.h:
+ This graph shows which files directly or indirectly include this file:

Data Structures

struct  Accelerometer_ConfigSlopeIntr_S
 
struct  Accelerometer_Handle_S
 structure to represent corresponding Accelerometer handle More...
 
struct  Accelerometer_InterruptCallback_S
 structure to represent Accelerometer interrupt callback More...
 
struct  Accelerometer_XyzData_S
 
struct  Acceleromter_SensorInfo_S
 

Macros

#define ACCELEROMETER_PARAMETER_DISABLE   UINT8_C(0x00)
 
#define ACCELEROMETER_PARAMETER_ENABLE   UINT8_C(0x01)
 These below macros shall be used by the user to enable/disable interrupt, when the user call the accelerometerConfigInterrupt() API. More...
 

Typedefs

typedef void(* accelDeferredTimeCallback )(void *, uint32_t param)
 This data type represents a function pointer that is used to register deferred interrupt callback. More...
 
typedef enum
Accelerometer_Bandwidth_E 
Accelerometer_Bandwidth_T
 
typedef enum
Accelerometer_Bandwidth_E
Accelerometer_BandwidthPtr_T
 
typedef struct
Accelerometer_ConfigSlopeIntr_S 
Accelerometer_ConfigSlopeIntr_T
 
typedef struct
Accelerometer_ConfigSlopeIntr_S
Accelerometer_ConfigSlopeIntrPtr_T
 
typedef struct
Accelerometer_Handle_S 
Accelerometer_Handle_T
 
typedef struct
Accelerometer_Handle_S
Accelerometer_HandlePtr_T
 
typedef struct
Accelerometer_InterruptCallback_S 
Accelerometer_InterruptCallback_T
 
typedef enum
Accelerometer_InterruptChannel_E 
Accelerometer_InterruptChannel_T
 
typedef enum
Accelerometer_InterruptType_E 
Accelerometer_InterruptType_T
 
typedef enum
Accelerometer_Powermode_E 
Accelerometer_Powermode_T
 
typedef enum
Accelerometer_Powermode_E
Accelerometer_PowermodePtr_T
 
typedef enum Accelerometer_Range_E Accelerometer_Range_T
 
typedef enum
Accelerometer_Range_E
Accelerometer_RangePtr_T
 
typedef enum
Accelerometer_SensorID_E 
Accelerometer_SensorID_T
 
typedef enum
Accelerometer_SleepDuration_E 
Accelerometer_SleepDuration_T
 
typedef enum
Accelerometer_SleepDuration_E
Accelerometer_SleepDurationPtr_T
 
typedef enum
Accelerometer_SlopeInterruptDuration_E 
Accelerometer_SlopeInterruptDuration_T
 
typedef struct
Accelerometer_XyzData_S 
Accelerometer_XyzData_T
 
typedef struct
Accelerometer_XyzData_S
Accelerometer_XyzDataPtr_T
 
typedef struct
Acceleromter_SensorInfo_S 
Acceleromter_SensorInfo_T
 
typedef struct
Acceleromter_SensorInfo_S
Acceleromter_SensorInfoPtr_T
 
typedef void(* accelRealTimeCallback )(void)
 This data type represents a function pointer that is used to register realtime interrupt callback. More...
 

Enumerations

enum  Accelerometer_Bandwidth_E
 
enum  Accelerometer_InterruptChannel_E
 
enum  Accelerometer_InterruptType_E
 
enum  Accelerometer_Powermode_E
 
enum  Accelerometer_Range_E
 
enum  Accelerometer_SensorID_E
 
enum  Accelerometer_SleepDuration_E
 
enum  Accelerometer_SlopeInterruptDuration_E
 

Functions

Retcode_T Accelerometer_configInterrupt (Accelerometer_HandlePtr_T handle, Accelerometer_InterruptChannel_T channel, Accelerometer_InterruptType_T interruptType, void *InterruptTypeParameters)
 Configures the accelerometer Interrupt referenced by the passed handle. More...
 
Retcode_T Accelerometer_deInit (Accelerometer_HandlePtr_T handle)
 DeInitializes the accelerometer referenced by the passed handle. More...
 
Retcode_T Accelerometer_disableInterrupt (Accelerometer_HandlePtr_T handle, Accelerometer_InterruptChannel_T channel, Accelerometer_InterruptType_T interruptType)
 Disable Interrupt type on the specified channel. More...
 
Retcode_T Accelerometer_getBandwidth (Accelerometer_HandlePtr_T handle, Accelerometer_BandwidthPtr_T bandwidth)
 Reads the bandwidth for the accelerometer referenced by the passed handle. More...
 
Retcode_T Accelerometer_getMode (Accelerometer_HandlePtr_T handle, Accelerometer_PowermodePtr_T powermode)
 get the powermode for the accelerometer referenced by the passed handle. More...
 
Retcode_T Accelerometer_getRange (Accelerometer_HandlePtr_T handle, Accelerometer_RangePtr_T range)
 Reads the Range for the accelerometer referenced by the passed handle. More...
 
Retcode_T Accelerometer_getSleepDuration (Accelerometer_HandlePtr_T handle, Accelerometer_SleepDurationPtr_T lowPowerModeSleepDuration)
 Reads the last set sleep duration of accelerometer referenced by the passed handle. More...
 
Retcode_T Accelerometer_init (Accelerometer_HandlePtr_T handle)
 Initializes the accelerometer referenced by the passed handle. More...
 
Retcode_T Accelerometer_readXyzGValue (Accelerometer_HandlePtr_T handle, Accelerometer_XyzDataPtr_T value)
 Reads an milli Gravity values from the accelerometer referenced by the passed handle for the UG correction. More...
 
Retcode_T Accelerometer_readXyzLsbValue (Accelerometer_HandlePtr_T handle, Accelerometer_XyzDataPtr_T value)
 Reads an LSB xyz value from the accelerometer referenced by the passed handle. More...
 
Retcode_T Accelerometer_regDeferredCallback (Accelerometer_HandlePtr_T handle, Accelerometer_InterruptChannel_T intChannel, accelDeferredTimeCallback deferredCallback)
 Register deferred user callback function on the specified channel to indicate user that interrupt has occurred not immediately but at deferred context of RTOS. More...
 
Retcode_T Accelerometer_regRealTimeCallback (Accelerometer_HandlePtr_T handle, Accelerometer_InterruptChannel_T intChannel, accelRealTimeCallback realTimeCallback)
 Register real time user callback function on the specified channel to indicate user that interrupt has occurred. More...
 
Retcode_T Accelerometer_setBandwidth (Accelerometer_HandlePtr_T handle, Accelerometer_Bandwidth_T bandwidth)
 Sets the bandwidth for the accelerometer referenced by the passed handle. More...
 
Retcode_T Accelerometer_setMode (Accelerometer_HandlePtr_T handle, Accelerometer_Powermode_T powermode)
 Sets the powermode for the accelerometer referenced by the passed handle. More...
 
Retcode_T Accelerometer_setRange (Accelerometer_HandlePtr_T handle, Accelerometer_Range_T range)
 Sets the Range for the accelerometer referenced by the passed handle. More...
 
Retcode_T Accelerometer_setSleepDuration (Accelerometer_HandlePtr_T handle, Accelerometer_SleepDuration_T lowPowerModeSleepDuration)
 Sets the SleepDuration for the accelerometer referenced by the passed handle. More...
 

This documentation file has been automatically generated on Wed May 6 2020 20:45:16 by doxygen 1.8.8