XDK API  3.6.0
Documentation
Files | Data Structures | Typedefs | Enumerations | Functions
Virtual sensor

Interface header file for the Virtual Sensor feature. More...

+ Collaboration diagram for Virtual sensor:

Files

file  XDK_VirtualSensor.h
 

Data Structures

struct  VirtualSensor_AxisFloatData_S
 Structure to represent the Float value of Various Axis. More...
 
struct  VirtualSensor_AxisIntData_S
 Structure to represent the Integer value of Various Axis. More...
 
union  VirtualSensor_DataType_U
 Structure to represent the various virtual sensor data. More...
 
struct  VirtualSensor_Enable_S
 Structure to represent the Sensors to be enabled. More...
 
struct  VirtualSensor_FingerPrintMonitorData_S
 
struct  VirtualSensor_RotationEuler_S
 Structure to represent the Rotation Euler data. More...
 
struct  VirtualSensor_RotationQuaternion_S
 Structure to represent the Rotation Quaternion data. More...
 
struct  VirtualSensor_Setup_S
 Structure to represent the Virtual Sensor setup params. More...
 

Typedefs

typedef enum
VirtualSensor_AccelMode_E 
VirtualSensor_AccelMode_T
 Typedef to represent the Accelerometer Sensor Mode. More...
 
typedef struct
VirtualSensor_AxisFloatData_S 
VirtualSensor_AxisFloatData_T
 Typedef to represent the Float value of Various Axis. More...
 
typedef struct
VirtualSensor_AxisIntData_S 
VirtualSensor_AxisIntData_T
 Typedef to represent the Integer value of Various Axis. More...
 
typedef union
VirtualSensor_DataType_U 
VirtualSensor_DataType_T
 Typedef to represent the various virtual sensor data. More...
 
typedef struct
VirtualSensor_Enable_S 
VirtualSensor_Enable_T
 Typedef to represent the Virtual Sensor to be enabled. More...
 
typedef struct
VirtualSensor_FingerPrintMonitorData_S 
VirtualSensor_FingerPrintMonitorData_T
 
typedef enum
VirtualSensor_FingerPrintNumber_E 
VirtualSensor_FingerPrintNumber_T
 Typedef to represent the different FingerPrint reference values. More...
 
typedef enum
VirtualSensor_FingerPrintStorageState_E 
VirtualSensor_FingerPrintStorageState_T
 
typedef enum
VirtualSensor_GravityMode_E 
VirtualSensor_GravityMode_T
 Typedef to represent the Gravity Sensor Mode. More...
 
typedef enum
VirtualSensor_GyroMode_E 
VirtualSensor_GyroMode_T
 Typedef to represent the Gyro Sensor Mode. More...
 
typedef enum
VirtualSensor_MagMode_E 
VirtualSensor_MagMode_T
 Typedef to represent the Magnetometer Sensor Mode. More...
 
typedef struct
VirtualSensor_RotationEuler_S 
VirtualSensor_RotationEuler_T
 Typedef to represent the Rotation Euler data. More...
 
typedef enum
VirtualSensor_RotationMode_E 
VirtualSensor_RotationMode_T
 Typedef to represent the Rotation Sensor Mode. More...
 
typedef struct
VirtualSensor_RotationQuaternion_S 
VirtualSensor_RotationQuaternion_T
 Typedef to represent the Rotation Quaternion data. More...
 
typedef struct
VirtualSensor_Setup_S 
VirtualSensor_Setup_T
 Typedef to represent the Virtual Sensor setup params. More...
 

Enumerations

enum  VirtualSensor_AccelMode_E
 Enum to represent the Accelerometer Mode. More...
 
enum  VirtualSensor_FingerPrintNumber_E
 Enum values to represent the different FingerPrint reference values. More...
 
enum  VirtualSensor_FingerPrintStorageState_E
 Enum values that represent finger print storage state. More...
 
enum  VirtualSensor_GravityMode_E
 Enum to represent the Gravity Sensor Mode. More...
 
enum  VirtualSensor_GyroMode_E
 Enum to represent the Gyro Sensor Mode. More...
 
enum  VirtualSensor_MagMode_E
 Enum to represent the Magnetometer Sensor Mode. More...
 
enum  VirtualSensor_RotationMode_E
 Enum to represent the Rotation Sensor Mode. More...
 

Functions

Retcode_T VirtualSensor_CheckFingerPrintStoredValue (VirtualSensor_FingerPrintNumber_T num, VirtualSensor_FingerPrintStorageState_T *status)
 Get current FingerPrint reference values from FingerPrint sensor. More...
 
Retcode_T VirtualSensor_Close (void)
 This will close the Virtual Sensor module. More...
 
Retcode_T VirtualSensor_Disable (void)
 This will disable the Sensor Virtual module. More...
 
Retcode_T VirtualSensor_Enable (void)
 This will enable the Sensor Virtual module. More...
 
Retcode_T VirtualSensor_GetAbsoluteHumidityData (float *humidity)
 Get the absolute humidity value from the humidity sensor. More...
 
Retcode_T VirtualSensor_GetCalibratedAccel (VirtualSensor_DataType_T *data, VirtualSensor_AccelMode_T mode)
 Get the xyz values from calibrated acceleration for given accel mode. More...
 
Retcode_T VirtualSensor_GetCalibratedGyro (VirtualSensor_DataType_T *data, VirtualSensor_GyroMode_T mode)
 Get the xyz values from calibrated gyro for given accel mode. More...
 
Retcode_T VirtualSensor_GetCalibratedMag (VirtualSensor_DataType_T *data, VirtualSensor_MagMode_T mode)
 Get the xyz values from calibrated Magnetometer for given accel mode. More...
 
Retcode_T VirtualSensor_GetCompassData (float *compass)
 Get the Heading angle from the compass sensor. More...
 
Retcode_T VirtualSensor_GetGestureCount (uint32_t *gestureCount)
 Get the gestures value (Provides the gestures detected) More...
 
Retcode_T VirtualSensor_GetGravity (VirtualSensor_DataType_T *data, VirtualSensor_GravityMode_T mode)
 Get the xyz values from Gravity sensor for given mode. More...
 
Retcode_T VirtualSensor_GetLinearAccel (VirtualSensor_DataType_T *data, VirtualSensor_AccelMode_T mode)
 Get the xyz values from linear acceleration for given accel mode. More...
 
Retcode_T VirtualSensor_GetRotationData (VirtualSensor_DataType_T *data, VirtualSensor_RotationMode_T mode)
 Get the rotation value from the rotation sensor. More...
 
Retcode_T VirtualSensor_GetStepCounter (int16_t *stepCounter)
 Get the step count value (Provides the number of user steps) More...
 
Retcode_T VirtualSensor_MonitorFingerPrint (VirtualSensor_DataType_T *result)
 Monitors whether the measured data matches with stored FingerPrint values from FingerPrint sensor. More...
 
Retcode_T VirtualSensor_ResetFingerPrintValue (VirtualSensor_FingerPrintNumber_T num)
 Clears the reference value for the selected FingerPrint. More...
 
Retcode_T VirtualSensor_SetFingerPrintValue (VirtualSensor_FingerPrintNumber_T num)
 Sets the reference value for the selected FingerPrint. More...
 
Retcode_T VirtualSensor_Setup (VirtualSensor_Setup_T *setup)
 This will setup the Virtual Sensor module. More...
 

Detailed Description

This provides the basic sensor sampling feature with the default configuration. This supports only single thread for data sampling and reporting.


Data Structure Documentation

struct VirtualSensor_AxisFloatData_S

Data Fields

float X
 
float Y
 
float Z
 

Field Documentation

float X
float Y
float Z
struct VirtualSensor_AxisIntData_S

Data Fields

int32_t X
 
int32_t Y
 
int32_t Z
 

Field Documentation

int32_t X
int32_t Y
int32_t Z
union VirtualSensor_DataType_U
struct VirtualSensor_Enable_S

Data Fields

uint32_t AbsoluteHumidity:1
 
uint32_t CalibratedAccel:1
 
uint32_t CalibratedGyro:1
 
uint32_t CalibratedMag:1
 
uint32_t Compass:1
 
uint32_t FingerPrint:1
 
uint32_t Gesture:1
 
uint32_t Gravity:1
 
uint32_t LinearAccel:1
 
uint32_t Rotation:1
 
uint32_t StepCounter:1
 

Field Documentation

uint32_t AbsoluteHumidity

Boolean representing if Humidity sensor is to be enabled or not

uint32_t CalibratedAccel

Boolean representing if CalibratedAccel sensor is to be enabled or not

uint32_t CalibratedGyro

Boolean representing if CalibratedGyro sensor is to be enabled or not

uint32_t CalibratedMag

Boolean representing if CalibratedMag sensor is to be enabled or not

uint32_t Compass

Boolean representing if Compass sensor is to be enabled or not

uint32_t FingerPrint

Boolean representing if FingerPrint sensor is to be enabled or not

uint32_t Gesture

Boolean representing if Gesture sensor is to be enabled or not

uint32_t Gravity

Boolean representing if Gravity sensor is to be enabled or not

uint32_t LinearAccel

Boolean representing if LinearAccel sensor is to be enabled or not

uint32_t Rotation

Boolean representing if Rotation sensor is to be enabled or not

uint32_t StepCounter

Boolean representing if StepCounter sensor is to be enabled or not

struct VirtualSensor_FingerPrintMonitorData_S

Data structure for FingerPrint monitoring output data

Data Fields

float AngleMatching
 
float DistanceMatching
 

Field Documentation

float AngleMatching

holds FingerPrint angle monitoring output. When matchinAngle < 1: measurement is not matching with FingerPrint reference value

float DistanceMatching

holds FingerPrint distance monitoring output When matchingDistance = 0: measurement is 100% not matching FingerPrint reference value

struct VirtualSensor_RotationEuler_S

Data Fields

float Heading
 
float Pitch
 
float Roll
 

Field Documentation

float Heading
float Pitch
float Roll
struct VirtualSensor_RotationQuaternion_S

Data Fields

float W
 
float X
 
float Y
 
float Z
 

Field Documentation

float W
float X
float Y
float Z
struct VirtualSensor_Setup_S
+ Collaboration diagram for VirtualSensor_Setup_S:

Data Fields

VirtualSensor_Enable_T Enable
 

Field Documentation

The Virtual Sensor to be enabled

Typedef Documentation

Enumeration Type Documentation

Enumerator
ACCEL_LSB_MODE 

Accel Data in lsb

ACCEL_MPS2_MODE 

Accel Data in metre per second squared

ACCEL_G_MODE 

Accel Data in gravity

Enumerator
FINGERPRINT_REFVAL_1 

Specifies FingerPrint 1 to be recorded

FINGERPRINT_REFVAL_2 

Specifies FingerPrint 2 to be recorded

FINGERPRINT_REFVAL_3 

Specifies FingerPrint 3 to be recorded

FINGERPRINT_REFVAL_MAX 
Enumerator
FINGERPRINT_STORAGE_EMPTY 

FingerPrint empty

FINGERPRINT_STORAGE_RECORDED 

FingerPrint recorded

Enumerator
GRAVITY_LSB_MODE 

Gravity Data in lsb

GRAVITY_MPS2_MODE 

Gravity Data in metre per second squared

GRAVITY_G_MODE 

Gravity Data in gravity

Enumerator
GYRO_LSB_MODE 

Gyro data in lsb

GYRO_RPS_MODE 

Gyro data in radians per second

GYRO_DPS_MODE 

Gyro data in degrees per second

Enumerator
MAG_LSB_MODE 

Mag data in lsb

MAG_GAUSS_MODE 

Mag data in Gauss

MAG_MICROTESLA_MODE 

Mag data in Micro tesla

Enumerator
ROTATION_EULER_DEG 

Rotation Euler Value in Degrees

ROTATION_EULER_RAD 

Rotation Euler Value in Radians

ROTATION_QUATERNION 

Rotation Quaternion values

Function Documentation

Retcode_T VirtualSensor_CheckFingerPrintStoredValue ( VirtualSensor_FingerPrintNumber_T  num,
VirtualSensor_FingerPrintStorageState_T status 
)

@ param[in] num num for which finger print stored value has to be checked

@ param[out] status finger print value for given value

Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T VirtualSensor_Close ( void  )
Returns
RETCODE_OK on success, or an error code otherwise.
Retcode_T VirtualSensor_Disable ( void  )
Returns
RETCODE_OK on success, or an error code otherwise.
Retcode_T VirtualSensor_Enable ( void  )
Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T VirtualSensor_GetAbsoluteHumidityData ( float *  humidity)

@ param[out] humidity absolute humidity value

Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T VirtualSensor_GetCalibratedAccel ( VirtualSensor_DataType_T data,
VirtualSensor_AccelMode_T  mode 
)

@ param[out] data calibrated acceleration value

@ param[in] mode calibrated acceleration mode to read data

Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T VirtualSensor_GetCalibratedGyro ( VirtualSensor_DataType_T data,
VirtualSensor_GyroMode_T  mode 
)

@ param[out] data calibrated gyro value

@ param[in] mode calibrated gyro mode to read data

Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T VirtualSensor_GetCalibratedMag ( VirtualSensor_DataType_T data,
VirtualSensor_MagMode_T  mode 
)

@ param[out] data magnetometer gyro value

@ param[in] mode calibrated magnetometer mode to read data

Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T VirtualSensor_GetCompassData ( float *  compass)

@ param[out] compass Heading angle data

Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T VirtualSensor_GetGestureCount ( uint32_t *  gestureCount)

@ param[out] gestureCount value of Gestures

Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T VirtualSensor_GetGravity ( VirtualSensor_DataType_T data,
VirtualSensor_GravityMode_T  mode 
)

@ param[out] data gravity value

@ param[in] mode gravity mode to read data

Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T VirtualSensor_GetLinearAccel ( VirtualSensor_DataType_T data,
VirtualSensor_AccelMode_T  mode 
)

@ param[out] data linear acceleration value

@ param[in] mode linear acceleration mode to read data

Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T VirtualSensor_GetRotationData ( VirtualSensor_DataType_T data,
VirtualSensor_RotationMode_T  mode 
)

@ param[out] data rotation sensor data based on given mode

@ param[in] mode mode of the rotation sensor

Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T VirtualSensor_GetStepCounter ( int16_t *  stepCounter)

@ param[out] stepCounter value of Step count

Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T VirtualSensor_MonitorFingerPrint ( VirtualSensor_DataType_T result)

@ param[out] result Finger PrintMonitor Data

Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T VirtualSensor_ResetFingerPrintValue ( VirtualSensor_FingerPrintNumber_T  num)

@ param[in] num reference value that is used to clear finger print

Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T VirtualSensor_SetFingerPrintValue ( VirtualSensor_FingerPrintNumber_T  num)

@ param[in] num reference value that is set for the finger print sensor

Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T VirtualSensor_Setup ( VirtualSensor_Setup_T setup)
Parameters
[in]setupPointer to the Virtual Sensor setup feature
Returns
RETCODE_OK on success, or an error code otherwise.
Note
  • This must be the first API to be called if this Virtual Sensor feature is to be used.
  • Only one sensor should be enabled. Do not call this API more than once.

+ 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:50 by doxygen 1.8.8