XDK API  3.6.0
Documentation
Files | Data Structures | Typedefs | Functions
BME280_SensorUtils

SensorUtils Interfaces of BME280. More...

+ Collaboration diagram for BME280_SensorUtils:

Files

file  BCDS_Bme280Utils.h
 

Data Structures

struct  Bme280Utils_Info_S
 structure to hold the Environmental specific GPIO ,I2c configurations to initialize configure and get the data from the sensor More...
 

Typedefs

typedef struct Bme280Utils_Info_S Bme280Utils_Info_T
 
typedef struct Bme280Utils_Info_SBme280Utils_InfoPtr_T
 

Functions

Retcode_T Bme280Utils_initialize (Bme280Utils_InfoPtr_T bme280Info)
 Function to initialize Environmental.This needs to be called before calling any other API. More...
 
Retcode_T Bme280Utils_uninitialize (Bme280Utils_InfoPtr_T bme280Info)
 Function to uninitialize Environmental.After calling this API sensor is no more usable without initializing it again by calling Bme280Utils_initialize() API. More...
 

Detailed Description

The interface header exports High-level Sensor API's which are used to Initialize BME280.


Data Structure Documentation

struct Bme280Utils_Info_S

Data Fields

uint32_t BspSensorId
 
uint8_t dev_addr
 

Field Documentation

uint32_t BspSensorId
uint8_t dev_addr

Typedef Documentation

Function Documentation

Retcode_T Bme280Utils_initialize ( Bme280Utils_InfoPtr_T  bme280Info)
Parameters
[in]bme280Info:structure holding the bme280 specific configurations
Return values
RETCODE_OKBME280 initialized successfully
RETCODE_NULL_POINTERwhen bma280Info is NULL.
RETCODE_LIB_NULL_POINTERwhen any of the input parameter for BST library API is NULL.
RETCODE_BST_BME280_ERRORwhen error is returned from BST library API.
RETCODE_DOPPLE_INITIALIZATIONWhen initialization is already done.
Returns
In case of other failures refer BSP_SensorNode_Enable or #I2CSensorTransceiver_Init API's.
Note
1) The return value consist of (First MSB Byte represents Package ID,Next Byte represents Severity and Last 2LSB Bytes represents error code).
2) The support of multiple instances is not possible due to the limitation in the BST library.
3) Calling Bme280 initialization API present in sensorUtils (Bme280Utils_initialize) and BST library (bme280_init) concurrently will lead to unexpected behaviour.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Retcode_T Bme280Utils_uninitialize ( Bme280Utils_InfoPtr_T  bme280Info)
Parameters
[in]bme280Info:structure holding the bme280 specific configurations
Return values
RETCODE_OKBME280 un-initialization success
RETCODE_NULL_POINTERwhen bme280Info is NULL.
RETCODE_UNINITIALIZEDwhen this api is called before initializing Bme280 sensor.
Returns
In case of other failures refer BSP_SensorNode_Disable or BSP_SensorNode_IsAllNodesDisabled or #I2CSensorTransceiver_Deinit API.
Note
The return value consist of (First MSB Byte represents Package ID,Next Byte represents Severity and Last 2LSB Bytes represents error code).

+ Here is the call graph for this function:

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