Files | Data Structures | Typedefs | Enumerations | Functions
Calibrated Accelerometer

Virtual Calibrated Accelerometer Sensor based on BMI160. More...

+ Collaboration diagram for Calibrated Accelerometer:

Files

file  BCDS_CalibratedAccel.h
 

Data Structures

struct  CalibratedAccel_XyzGData_S
 
struct  CalibratedAccel_XyzLsbData_S
 
struct  CalibratedAccel_XyzMps2Data_S
 

Typedefs

typedef float CalibratedAccel_GData_T
 
typedef void * CalibratedAccel_HandlePtr_T
 
typedef int32_t CalibratedAccel_LsbData_T
 
typedef float CalibratedAccel_Mps2Data_T
 
typedef struct
CalibratedAccel_XyzGData_S 
CalibratedAccel_XyzGData_T
 
typedef struct
CalibratedAccel_XyzGData_S
CalibratedAccel_XyzGDataPtr_T
 
typedef struct
CalibratedAccel_XyzLsbData_S 
CalibratedAccel_XyzLsbData_T
 
typedef struct
CalibratedAccel_XyzLsbData_S
CalibratedAccel_XyzLsbDataPtr_T
 
typedef struct
CalibratedAccel_XyzMps2Data_S 
CalibratedAccel_XyzMps2Data_T
 
typedef struct
CalibratedAccel_XyzMps2Data_S
CalibratedAccel_XyzMps2DataPtr_T
 

Enumerations

enum  CalibratedAccel_Status_E
 

Functions

 BCDS_DEPRECATED (typedef enum CalibratedAccel_Status_E CalibratedAccel_Status_T)
 
 BCDS_DEPRECATED (typedef enum CalibratedAccel_Status_E *CalibratedAccel_StatusPtr_T)
 
 BCDS_DEPRECATED (Retcode_T CalibratedAccel_getStatus(CalibratedAccel_StatusPtr_T calibAccelStatus))
 Reads calibration accuracy status from calibrated accelerometer. More...
 
Retcode_T CalibratedAccel_deInit (void)
 Deinitializes the calibrated accelerometer sensor. More...
 
Retcode_T CalibratedAccel_init (CalibratedAccel_HandlePtr_T handle)
 Initializes the calibrated accelerometer sensor. More...
 
Retcode_T CalibratedAccel_readXyzGValue (CalibratedAccel_XyzGDataPtr_T calibAccelData)
 Reads 'g' xyz values from calibrated accelerometer. More...
 
Retcode_T CalibratedAccel_readXyzLsbValue (CalibratedAccel_XyzLsbDataPtr_T calibAccelData)
 Reads 'LSB' xyz values from calibrated accelerometer. More...
 
Retcode_T CalibratedAccel_readXyzMps2Value (CalibratedAccel_XyzMps2DataPtr_T calibAccelData)
 Reads 'm/(s^2)' xyz values from calibrated accelerometer. More...
 

Detailed Description

Calibrated Accelerometer is a virtual sensor that provides calibrated accelerometer data.
i.e., Zero-g offsets are removed from the acceleration data.

Accelerometer Calibration method :
Accelerometer calibration is done by rotating the device to +/-90 degrees in all axis.
It takes some time for the accelerometer to calibrate.

Calibrated Accelerometer data is read in three different units.

Note
- To know the accuracy of calibration done, use CalibratedAccel_getStatus() API
- To get proper calibrated accelerometer data, make sure that the calibration accuracy is CALIBRATED_ACCEL_HIGH before reading the data.

Limitations of calibrated accelerometer:
This sensor cannot be used while using virtual sensor fingerPrint.


Data Structure Documentation

struct CalibratedAccel_XyzGData_S

Struct that holds calibrated accelerometer data in g units

Data Fields

CalibratedAccel_GData_T xAxisData
 
CalibratedAccel_GData_T yAxisData
 
CalibratedAccel_GData_T zAxisData
 

Field Documentation

calibrated accelerometer x-axis g data

calibrated accelerometer y-axis g data

calibrated accelerometer z-axis g data

struct CalibratedAccel_XyzLsbData_S

Struct that holds calibrated accelerometer data in lsb units

Data Fields

CalibratedAccel_LsbData_T xAxisData
 
CalibratedAccel_LsbData_T yAxisData
 
CalibratedAccel_LsbData_T zAxisData
 

Field Documentation

calibrated accelerometer x-axis lsb data

calibrated accelerometer y-axis lsb data

calibrated accelerometer z-axis lsb data

struct CalibratedAccel_XyzMps2Data_S

Struct that holds calibrated accelerometer data in m/s2 units

Data Fields

CalibratedAccel_Mps2Data_T xAxisData
 
CalibratedAccel_Mps2Data_T yAxisData
 
CalibratedAccel_Mps2Data_T zAxisData
 

Field Documentation

calibrated accelerometer x-axis m/s2 data

calibrated accelerometer y-axis m/s2 data

calibrated accelerometer z-axis m/s2 data

Typedef Documentation

typedef float CalibratedAccel_GData_T

data type for calibrated accelerometer g data

Defines the handle for calibrated accelerometer object. This handle is required for the initialisation of calibrated accelerometer

typedef int32_t CalibratedAccel_LsbData_T

custom data types for calibrated Accelerometer data data type for calibrated accelerometer lsb data

data type for calibrated accelerometer m/s2 data

Enumeration Type Documentation

enum that defines calibration status of calibrated accelerometer

Enumerator
CALIBRATED_ACCEL_UNRELIABLE 

unreliable calibration status of calibrated accelerometer

CALIBRATED_ACCEL_LOW 

low calibration status of calibrated accelerometer

CALIBRATED_ACCEL_MEDIUM 

medium calibration status of calibrated accelerometer

CALIBRATED_ACCEL_HIGH 

high calibration status of calibrated accelerometer

Function Documentation

BCDS_DEPRECATED ( typedef enum CalibratedAccel_Status_E  CalibratedAccel_Status_T)
BCDS_DEPRECATED ( typedef enum CalibratedAccel_Status_E CalibratedAccel_StatusPtr_T)
BCDS_DEPRECATED ( Retcode_T   CalibratedAccel_getStatusCalibratedAccel_StatusPtr_T calibAccelStatus)
Deprecated:
since version v3.0.1
Parameters
[out]calibAccelStatusoutput parameter in which the accelerometer calibration status will be written to, from within the function
Return values
RETCODE_SUCCESSReading calibration accuracy status from calibrated accelerometer success.
RETCODE_INVALID_PARAMIn case calibAccelStatus is NULL pointer .
Note
There are four levels of calibration accuracy
  • CALIBRATED_ACCEL_UNRELIABLE
  • CALIBRATED_ACCEL_LOW
  • CALIBRATED_ACCEL_MEDIUM
  • CALIBRATED_ACCEL_HIGH
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_getUserErrorCode() API to know the user type return code present in #BCDS_SensorErrorType.h.
Retcode_T CalibratedAccel_deInit ( void  )
Return values
RETCODE_OKCalibrated accelerometer sensor De-initialization success.
RETCODE_FAILURECalibrated accelerometer sensor De-initialization failure.
Warning
This API needs to be called when we require to stop the calibrated Accelerometer data reading.
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_getUserErrorCode() API to know the user type return code present in #BCDS_SensorErrorType.h.
Retcode_T CalibratedAccel_init ( CalibratedAccel_HandlePtr_T  handle)
Parameters
[in]CalibratedAccel_HandlePtr_Tthe handle to the calibrated accelerometer object that should be initialized
Return values
RETCODE_OKcalibrated accelerometer initialization success.
RETCODE_NULL_POINTERIn case of invalid sensor handle.
Warning
This API needs to be called before calling any other function of the calibrated accelerometer.
Note
Refer #XdkSensorHandle.h for selecting the proper handle.
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_getUserErrorCode() API to know the user type return code present in #BCDS_SensorErrorType.h.
Retcode_T CalibratedAccel_readXyzGValue ( CalibratedAccel_XyzGDataPtr_T  calibAccelData)
Parameters
[out]calibAccelDataoutput parameter in which the calibrated accelerometer data will be written to, from within the function
Return values
RETCODE_OKReading calibrated accelerometer g xyz value success.
RETCODE_UNINITIALIZEDIf called without initializing the sensor.
RETCODE_NULL_POINTERIn case calibAccelData is NULL pointer.
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_getUserErrorCode() API to know the user type return code present in #BCDS_SensorErrorType.h.
Retcode_T CalibratedAccel_readXyzLsbValue ( CalibratedAccel_XyzLsbDataPtr_T  calibAccelData)
Parameters
[out]calibAccelDataoutput parameter in which the calibrated accelerometer data will be written to, from within the function
Return values
RETCODE_OKReading calibrated accelerometer xyzLsb value success.
RETCODE_UNINITIALIZEDIf called without initializing the sensor.
RETCODE_NULL_POINTERIn case calibAccelData is NULL pointer.
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_getUserErrorCode() API to know the user type return code present in #BCDS_SensorErrorType.h.
Retcode_T CalibratedAccel_readXyzMps2Value ( CalibratedAccel_XyzMps2DataPtr_T  calibAccelData)
Parameters
[out]calibAccelDataoutput parameter in which the calibrated accelerometer data will be written to, from within the function
Return values
RETCODE_OKReading calibrated accelerometer 'm/(s^2)' xyz value success.
RETCODE_UNINITIALIZEDIf called without initializing the sensor.
RETCODE_NULL_POINTERIn case calibAccelData is NULL pointer.
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_getUserErrorCode() API to know the user type return code present in #BCDS_SensorErrorType.h.

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