XDK API  3.6.0
Documentation
Files | Typedefs | Enumerations | Functions
SensorErrorTypes

Sensor User error types. More...

+ Collaboration diagram for SensorErrorTypes:

Files

file  BCDS_SensorErrorType.h
 

Typedefs

typedef enum BCDS_SensorErrorType_E BCDS_SensorErrorType_T
 

Enumerations

enum  BCDS_SensorErrorType_E
 

Functions

BCDS_SensorErrorType_T BCDS_getSensorErrorCode (Retcode_T sensorApiReturnValue)
 Function responsible to map the return type of sensor API to user error types. More...
 

Detailed Description

The interfae header used to get the exact error code of the advanced Sensor API's when there is an error from those API's

Typedef Documentation

Enumeration Type Documentation

Enum values to represent user level sensor error codes

Enumerator
SENSOR_SUCCESS 

API call success

SENSOR_ERROR 

API call failed

SENSOR_INVALID_PARAMETER 

API call failed due to passing invalid input parameter

SENSOR_UNSUPPORTED_PARAMETER 

API call failed due to passing unsupported input parameter

SENSOR_INIT_NOT_DONE 

API call failed due to calling other API without calling sensor initialize API

Function Documentation

BCDS_SensorErrorType_T BCDS_getSensorErrorCode ( Retcode_T  sensorApiReturnValue)
Parameters
[in]SensorAPI return value which consist of (First 1 MSByte represents Package ID, Next Byte represents Severity and Last 2 LSBytes represents error code)
Return values
SENSOR_SUCCESSSuccessfully executed API call
SENSOR_ERRORError occurred during API call execution
SENSOR_INVALID_PARAMETERError occurred due to invalid input parameter passed to API call
SENSOR_INIT_NOT_DONEError indicating the application not called sensor initialization API before calling other API calls
SENSOR_UNSUPPORTED_PARAMETERError indicating the input is not supported for this sensor

+ Here is the call 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:51 by doxygen 1.8.8