XDK API  3.6.0
Documentation
Files | Typedefs | Functions
Absolute Humidity

Virtual Absolute Humidity Sensor based on BME280. More...

+ Collaboration diagram for Absolute Humidity:

Files

file  BCDS_AbsoluteHumidity.h
 

Typedefs

typedef void * AbsoluteHumidity_HandlePtr_T
 
typedef float * AbsoluteHumidity_ValuePtr_T
 

Functions

Retcode_T AbsoluteHumidity_deInit (void)
 Deinitializes the Humidity sensor. More...
 
Retcode_T AbsoluteHumidity_init (AbsoluteHumidity_HandlePtr_T handle)
 Initializes the Humidity sensor. More...
 
Retcode_T AbsoluteHumidity_readValue (AbsoluteHumidity_HandlePtr_T handle, AbsoluteHumidity_ValuePtr_T absoluteValue)
 Reads absolute humidity value from the humidity sensor. More...
 

Detailed Description

Virtual Absolute Humidity Sensor that provides absolute Humidity data.
Humidity method :
Humidity is calculated by moving the sensor from one place to another place.

Humidity data is read in the following units.

Note
To know the absoluteHumidity, use AbsoluteHumidity_readValue() API

Limitations of absolute humidity:
This sensor cannot be used while using virtual sensor fingerPrint.

Typedef Documentation

Defines the handle for absolute humidity sensor

Defines the pointer to hold absolute humidity value

Function Documentation

Retcode_T AbsoluteHumidity_deInit ( void  )
Return values
RETCODE_OKHumidity sensor De-initialization success.
RETCODE_FAILUREHumidity sensor De-initialization failure.
Warning
This function needs to be called when we require to stop the humidity sensor 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_getSensorErrorCode API to know the sensor return code present in BCDS_SensorErrorType_E.
Retcode_T AbsoluteHumidity_init ( AbsoluteHumidity_HandlePtr_T  handle)
Parameters
[in]AbsoluteHumidity_HandlePtr_Tthe handle to the humidity sensor object that should be initialized.
Return values
RETCODE_OKHumidity sensor initialization success.
RETCODE_NULL_POINTERIn case of invalid sensor handle.
Warning
This function needs to be called before calling any other function of the Humidity sensor API.
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 AbsoluteHumidity_readValue ( AbsoluteHumidity_HandlePtr_T  handle,
AbsoluteHumidity_ValuePtr_T  absoluteValue 
)
Parameters
[in]AbsoluteHumidity_HandlePtr_Tthe handle to the humidity sensor object that should be initialized.
[out]AbsoluteHumidity_ValuePtr_TabsoluteHumidityValue, output parameter in which the absoluteHumidity value will be written to, from within the function.
Return values
RETCODE_OKReading absolute humidity value from the humidity sensor success.
RETCODE_NULL_POINTERIn case of invalid sensor handle or invalid absolute value.
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_getSensorErrorCode API to know the sensor return code present in BCDS_SensorErrorType_E.

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