environment
2.0.0.0
|
Functions | |
void | environment_cfg_setup (environment_cfg_t *cfg) |
Config Object Initialization function. More... | |
ENVIRONMENT_RETVAL | environment_init (environment_t *ctx, environment_cfg_t *cfg) |
Initialization function. More... | |
void | environment_default_cfg (environment_t *ctx) |
Click Default Configuration function. More... | |
void | environment_generic_write (environment_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len) |
Generic write function. More... | |
void | environment_generic_read (environment_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len) |
Generic read function. More... | |
void | environment_write_byte (environment_t *ctx, uint8_t reg_address, uint8_t write_data) |
Generic the write byte of data function. More... | |
uint8_t | environment_read_byte (environment_t *ctx, uint8_t reg_address) |
Generic the read byte of data function. More... | |
uint8_t | environment_check_id (environment_t *ctx) |
Check device ID function. More... | |
uint8_t | environment_get_device_id (environment_t *ctx) |
Get device ID function. More... | |
void | environment_soft_reset (environment_t *ctx) |
Software reset function. More... | |
void | environment_get_calibration_data (environment_t *ctx) |
Get factory calibration parameters function. More... | |
void | environment_default_config (environment_t *ctx) |
Set default configuration for the BMP680 sensor function. More... | |
float | environment_get_ambient_data (environment_t *ctx, uint8_t data_in) |
Get ambient data function. More... | |
float | environment_get_temperature (environment_t *ctx) |
Gets temperature in degrees Celsius function. More... | |
float | environment_get_humidity (environment_t *ctx) |
Gets humidity in percentage [ % ] function. More... | |
float | environment_get_pressure (environment_t *ctx) |
Gets pressure in degrees Celsius function. More... | |
uint32_t | environment_get_gas_resistance (environment_t *ctx) |
Gets gas resistance data function. More... | |
void environment_cfg_setup | ( | environment_cfg_t * | cfg | ) |
Config Object Initialization function.
cfg | Click configuration structure. |
This function initializes click configuration structure to init state.
uint8_t environment_check_id | ( | environment_t * | ctx | ) |
Check device ID function.
ctx | Click object. |
Function check device ID by read ID value from the sensor ID register address of BME680 chip on Environment Click board.
void environment_default_cfg | ( | environment_t * | ctx | ) |
Click Default Configuration function.
ctx | Click object. |
This function executes default configuration for Environment click.
void environment_default_config | ( | environment_t * | ctx | ) |
Set default configuration for the BMP680 sensor function.
ctx | Click object. |
Function set default configuration to the sensor configuration register address of BME680 chip on Environment Click board.
void environment_generic_read | ( | environment_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | data_buf, | ||
uint8_t | len | ||
) |
Generic read function.
ctx | Click object. |
reg | Register address. |
data_buf | Data buf to be written. |
len | Number of the bytes in data buf. |
This function reads data from the desired register.
void environment_generic_write | ( | environment_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | data_buf, | ||
uint8_t | len | ||
) |
Generic write function.
ctx | Click object. |
reg | Register address. |
data_buf | Output data buf |
len | Number of the bytes to be read |
This function writes data to the desired register.
float environment_get_ambient_data | ( | environment_t * | ctx, |
uint8_t | data_in | ||
) |
Get ambient data function.
ctx | Click object. |
dataIn | Data for reading: |
Function get ambient data by sets device force mode and read data from the sensor temperature, pressure or humidity register address of BME680 chip on Environment Click board.
void environment_get_calibration_data | ( | environment_t * | ctx | ) |
Get factory calibration parameters function.
ctx | Click object. |
Function read factory calibration parameters value from the sensor calibration registers address of BME680 chip on Environment Click board.
uint8_t environment_get_device_id | ( | environment_t * | ctx | ) |
Get device ID function.
ctx | Click object. |
Function read device ID from the sensor ID register address of BME680 chip on Environment Click board.
uint32_t environment_get_gas_resistance | ( | environment_t * | ctx | ) |
Gets gas resistance data function.
ctx | Click object. |
32-bite gas resistance data
Function get gas resistance value from the sensor gas resistance register address of BME680 chip on Environment Click board.
float environment_get_humidity | ( | environment_t * | ctx | ) |
Gets humidity in percentage [ % ] function.
ctx | Click object. |
Function get humidity value in percentage [ % ] from the sensor humidity register address of BME680 chip on Environment Click board.
float environment_get_pressure | ( | environment_t * | ctx | ) |
Gets pressure in degrees Celsius function.
ctx | Click object. |
Function get pressure value in [ mbar ] from the sensor pressure register address of BME680 chip on Environment Click board.
float environment_get_temperature | ( | environment_t * | ctx | ) |
Gets temperature in degrees Celsius function.
ctx | Click object. |
Function get temperature value in degrees Celsius [ �C ] from the sensor temperature register address of BME680 chip on Environment Click board.
ENVIRONMENT_RETVAL environment_init | ( | environment_t * | ctx, |
environment_cfg_t * | cfg | ||
) |
Initialization function.
environment | Click object. |
cfg | Click configuration structure. |
This function initializes all necessary pins and peripherals used for this click.
uint8_t environment_read_byte | ( | environment_t * | ctx, |
uint8_t | reg_address | ||
) |
Generic the read byte of data function.
ctx | Click object. |
reg_address | Register address |
8-bit read data
Function read the 8-bit of data from the target 8-bit register address of BME680 chip on Environment Click board.
void environment_soft_reset | ( | environment_t * | ctx | ) |
Software reset function.
ctx | Click object. |
Function software reset by write value of 0xB6 to the sensor reset register address of BME680 chip on Environment Click board.
void environment_write_byte | ( | environment_t * | ctx, |
uint8_t | reg_address, | ||
uint8_t | write_data | ||
) |
Generic the write byte of data function.
ctx | Click object. |
reg_address | 8-bit register address |
write_data | Byte of data to write |
Function write the 8-bit of data to the target 8-bit register address of BME680 chip on Environment Click board.