airquality11  2.1.0.0
Modules | Functions
Air Quality 11 Click Driver

API for configuring and manipulating Air Quality 11 Click driver. More...

Modules

 Air Quality 11 Registers List
 List of registers of Air Quality 11 Click driver.
 
 Air Quality 11 Registers Settings
 Settings for registers of Air Quality 11 Click driver.
 
 Air Quality 11 MikroBUS Map
 MikroBUS pin mapping of Air Quality 11 Click driver.
 

Functions

void airquality11_cfg_setup (airquality11_cfg_t *cfg)
 Air Quality 11 configuration object setup function. More...
 
void airquality11_drv_interface_sel (airquality11_cfg_t *cfg, airquality11_drv_t drv_sel)
 Air Quality 11 driver interface setup function. More...
 
err_t airquality11_init (airquality11_t *ctx, airquality11_cfg_t *cfg)
 Air Quality 11 initialization function. More...
 
err_t airquality11_default_cfg (airquality11_t *ctx)
 Air Quality 11 default configuration function. More...
 
err_t airquality11_generic_write (airquality11_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
 Air Quality 11 data writing function. More...
 
err_t airquality11_generic_read (airquality11_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
 Air Quality 11 data reading function. More...
 
err_t airquality11_write_word (airquality11_t *ctx, uint8_t reg, uint16_t data_in)
 Air Quality 11 word data writing function. More...
 
err_t airquality11_read_word (airquality11_t *ctx, uint8_t reg, uint16_t *data_out)
 Air Quality 11 word data reading function. More...
 
err_t airquality11_get_device_id (airquality11_t *ctx, uint16_t *device_id)
 Air Quality 11 get device ID function. More...
 
err_t airquality11_set_op_mode (airquality11_t *ctx, airquality11_op_mode_t op_mode)
 Air Quality 11 set operating mode function. More...
 
err_t airquality11_set_int_config (airquality11_t *ctx, uint8_t int_cfg)
 Air Quality 11 set configures function. More...
 
err_t airquality11_set_cmd (airquality11_t *ctx, airquality11_cmd_t cmd)
 Air Quality 11 set command function. More...
 
err_t airquality11_set_measure_c (airquality11_t *ctx, float temperature, float humidity)
 Air Quality 11 set measure conditions function. More...
 
err_t airquality11_get_status (airquality11_t *ctx, uint8_t *status)
 Air Quality 11 get status function. More...
 
err_t airquality11_get_aqi_uba (airquality11_t *ctx, uint8_t *aqi_uba)
 Air Quality 11 get AQI-UBA function. More...
 
err_t airquality11_get_tvoc (airquality11_t *ctx, uint16_t *tvoc_ppb)
 Air Quality 11 get TVOC function. More...
 
err_t airquality11_get_co2 (airquality11_t *ctx, uint16_t *co2_ppm)
 Air Quality 11 get CO2 function. More...
 
err_t airquality11_get_aqi_s (airquality11_t *ctx, uint16_t *aqi_s)
 Air Quality 11 get AQI-S function. More...
 
err_t airquality11_get_measure_c (airquality11_t *ctx, float *temperature, float *humidity)
 Air Quality 11 get measure conditions function. More...
 
err_t airquality11_write_gpr_reg (airquality11_t *ctx, uint8_t *data_in)
 Air Quality 11 GPR data writing function. More...
 
err_t airquality11_read_gpr_reg (airquality11_t *ctx, uint8_t *data_out)
 Air Quality 11 GPR data reading function. More...
 
uint8_t airquality11_get_interrupt (airquality11_t *ctx)
 Rotary O 2 get interrupt function. More...
 

Detailed Description

API for configuring and manipulating Air Quality 11 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ airquality11_cfg_setup()

void airquality11_cfg_setup ( airquality11_cfg_t cfg)

Air Quality 11 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See airquality11_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ airquality11_default_cfg()

err_t airquality11_default_cfg ( airquality11_t ctx)

Air Quality 11 default configuration function.

This function executes a default configuration of Air Quality 11 click board.

Parameters
[in]ctx: Click context object. See airquality11_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
This function can consist any necessary configuration or setting to put device into operating mode.

◆ airquality11_drv_interface_sel()

void airquality11_drv_interface_sel ( airquality11_cfg_t cfg,
airquality11_drv_t  drv_sel 
)

Air Quality 11 driver interface setup function.

This function sets a serial driver interface which will be used further in the click driver.

Parameters
[out]cfg: Click configuration structure. See airquality11_cfg_t object definition for detailed explanation.
[in]drv_sel: Driver interface selection. See airquality11_drv_t object definition for detailed explanation.
Returns
Nothing.
Note
This driver selection should be called before init function to configure the driver to work with the serial interface which is consistent with the real state of the hardware. If this function is not called, the default driver interface will be set.

◆ airquality11_generic_read()

err_t airquality11_generic_read ( airquality11_t ctx,
uint8_t  reg,
uint8_t *  data_out,
uint8_t  len 
)

Air Quality 11 data reading function.

This function reads a desired number of data bytes starting from the selected register.

Parameters
[in]ctx: Click context object. See airquality11_t object definition for detailed explanation.
[in]reg: Start register address.
[out]data_out: Output read data.
[in]len: Number of bytes to be read.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ airquality11_generic_write()

err_t airquality11_generic_write ( airquality11_t ctx,
uint8_t  reg,
uint8_t *  data_in,
uint8_t  len 
)

Air Quality 11 data writing function.

This function writes a desired number of data bytes starting from the selected register.

Parameters
[in]ctx: Click context object. See airquality11_t object definition for detailed explanation.
[in]reg: Start register address.
[in]data_in: Data to be written.
[in]len: Number of bytes to be written.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ airquality11_get_aqi_s()

err_t airquality11_get_aqi_s ( airquality11_t ctx,
uint16_t *  aqi_s 
)

Air Quality 11 get AQI-S function.

This function reads the calculated relative Air Quality Index proprietary to ScioSense of the ENS161, Digital Metal-Oxide Multi-Gas Sensor with permanent and low power operating modes on the Air Quality 11 Click board.

Parameters
[in]ctx: Click context object. See airquality11_t object definition for detailed explanation.
[out]aqi_s: Air Quality Index proprietary to ScioSense [0-500].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ airquality11_get_aqi_uba()

err_t airquality11_get_aqi_uba ( airquality11_t ctx,
uint8_t *  aqi_uba 
)

Air Quality 11 get AQI-UBA function.

This function reads the calculated Air Quality Index according to the UBA of the ENS161, Digital Metal-Oxide Multi-Gas Sensor with permanent and low power operating modes on the Air Quality 11 Click board.

Parameters
[in]ctx: Click context object. See airquality11_t object definition for detailed explanation.
[out]aqi_uba: Air Quality Index according to the UBA [1-5].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ airquality11_get_co2()

err_t airquality11_get_co2 ( airquality11_t ctx,
uint16_t *  co2_ppm 
)

Air Quality 11 get CO2 function.

This function reads the calculated equivalent CO2 concentration in ppm of the ENS161, Digital Metal-Oxide Multi-Gas Sensor with permanent and low power operating modes on the Air Quality 11 Click board.

Parameters
[in]ctx: Click context object. See airquality11_t object definition for detailed explanation.
[out]co2_ppm: CO2 concentration in ppm [400-65000].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ airquality11_get_device_id()

err_t airquality11_get_device_id ( airquality11_t ctx,
uint16_t *  device_id 
)

Air Quality 11 get device ID function.

This function reads the device ID (part number) of the ENS161, Digital Metal-Oxide Multi-Gas Sensor with permanent and low power operating modes on the Air Quality 11 Click board.

Parameters
[in]ctx: Click context object. See airquality11_t object definition for detailed explanation.
[out]device_id: Part number.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ airquality11_get_interrupt()

uint8_t airquality11_get_interrupt ( airquality11_t ctx)

Rotary O 2 get interrupt function.

This function return interrupt signal, states of the INT pin of theENS161, Digital Metal-Oxide Multi-Gas Sensor with permanent and low power operating modes on the Air Quality 11 Click board.

Parameters
[in]ctx: Click context object. See #rotaryo2_t object definition for detailed explanation.
Returns
  • 0 - Low state,
  • 1 - High state.
Note
None.

◆ airquality11_get_measure_c()

err_t airquality11_get_measure_c ( airquality11_t ctx,
float *  temperature,
float *  humidity 
)

Air Quality 11 get measure conditions function.

This function reads the temperature and humidity measure conditions of the ENS161, Digital Metal-Oxide Multi-Gas Sensor with permanent and low power operating modes on the Air Quality 11 Click board.

Parameters
[in]ctx: Click context object. See airquality11_t object definition for detailed explanation.
[out]temperature: Temperature in degrees Celsius [-40.0-80.0].
[out]humidity: Relative humidity in percent [5.0-95.0].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ airquality11_get_status()

err_t airquality11_get_status ( airquality11_t ctx,
uint8_t *  status 
)

Air Quality 11 get status function.

This function reads the status register of the ENS161, Digital Metal-Oxide Multi-Gas Sensor with permanent and low power operating modes on the Air Quality 11 Click board.

Parameters
[in]ctx: Click context object. See airquality11_t object definition for detailed explanation.
[out]status: Status data.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ airquality11_get_tvoc()

err_t airquality11_get_tvoc ( airquality11_t ctx,
uint16_t *  tvoc_ppb 
)

Air Quality 11 get TVOC function.

This function reads the calculated equivalent TVOC concentration in ppb of the ENS161, Digital Metal-Oxide Multi-Gas Sensor with permanent and low power operating modes on the Air Quality 11 Click board.

Parameters
[in]ctx: Click context object. See airquality11_t object definition for detailed explanation.
[out]tvoc_ppb: TVOC concentration in ppb [0-65000].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ airquality11_init()

err_t airquality11_init ( airquality11_t ctx,
airquality11_cfg_t cfg 
)

Air Quality 11 initialization function.

This function initializes all necessary pins and peripherals used for this click board.

Parameters
[out]ctx: Click context object. See airquality11_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See airquality11_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ airquality11_read_gpr_reg()

err_t airquality11_read_gpr_reg ( airquality11_t ctx,
uint8_t *  data_out 
)

Air Quality 11 GPR data reading function.

This function reads a 8 data bytes to the general purpose read registers of the ENS161, Digital Metal-Oxide Multi-Gas Sensor with permanent and low power operating modes on the Air Quality 11 Click board.

Parameters
[in]ctx: Click context object. See airquality11_t object definition for detailed explanation.
[out]data_out: GPR output read data.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ airquality11_read_word()

err_t airquality11_read_word ( airquality11_t ctx,
uint8_t  reg,
uint16_t *  data_out 
)

Air Quality 11 word data reading function.

This function reads a 16-byte data from the selected register of the ENS161, Digital Metal-Oxide Multi-Gas Sensor with permanent and low power operating modes on the Air Quality 11 Click board.

Parameters
[in]ctx: Click context object. See airquality11_t object definition for detailed explanation.
[in]reg: Start register address.
[out]data_out: 16-byte output read data.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ airquality11_set_cmd()

err_t airquality11_set_cmd ( airquality11_t ctx,
airquality11_cmd_t  cmd 
)

Air Quality 11 set command function.

This function sets the desired command of the ENS161, Digital Metal-Oxide Multi-Gas Sensor with permanent and low power operating modes on the Air Quality 11 Click board.

Parameters
[in]ctx: Click context object. See airquality11_t object definition for detailed explanation.
[in]cmd: Additional commands to be executed. See airquality11_cmd_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ airquality11_set_int_config()

err_t airquality11_set_int_config ( airquality11_t ctx,
uint8_t  int_cfg 
)

Air Quality 11 set configures function.

This function configures the action of the interrupt (INT) pin of the ENS161, Digital Metal-Oxide Multi-Gas Sensor with permanent and low power operating modes on the Air Quality 11 Click board.

Parameters
[in]ctx: Click context object. See airquality11_t object definition for detailed explanation.
[in]cfg: Configures the action of the interrupt pin.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ airquality11_set_measure_c()

err_t airquality11_set_measure_c ( airquality11_t ctx,
float  temperature,
float  humidity 
)

Air Quality 11 set measure conditions function.

This function sets the desired temperature and humidity measure conditions of the ENS161, Digital Metal-Oxide Multi-Gas Sensor with permanent and low power operating modes on the Air Quality 11 Click board.

Parameters
[in]ctx: Click context object. See airquality11_t object definition for detailed explanation.
[in]temperature: Temperature in degrees Celsius [-40.0-80.0].
[in]humidity: Relative humidity in percent [5.0-95.0].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ airquality11_set_op_mode()

err_t airquality11_set_op_mode ( airquality11_t ctx,
airquality11_op_mode_t  op_mode 
)

Air Quality 11 set operating mode function.

This function sets the desired operating mode of the ENS161, Digital Metal-Oxide Multi-Gas Sensor with permanent and low power operating modes on the Air Quality 11 Click board.

Parameters
[in]ctx: Click context object. See airquality11_t object definition for detailed explanation.
[in]op_mode: Operating mode selection. See airquality11_op_mode_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ airquality11_write_gpr_reg()

err_t airquality11_write_gpr_reg ( airquality11_t ctx,
uint8_t *  data_in 
)

Air Quality 11 GPR data writing function.

This function writes a 8 data bytes to the general purpose write registers of the ENS161, Digital Metal-Oxide Multi-Gas Sensor with permanent and low power operating modes on the Air Quality 11 Click board.

Parameters
[in]ctx: Click context object. See airquality11_t object definition for detailed explanation.
[in]data_in: GPR data to be written.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ airquality11_write_word()

err_t airquality11_write_word ( airquality11_t ctx,
uint8_t  reg,
uint16_t  data_in 
)

Air Quality 11 word data writing function.

This function writes a desired 16-byte data to the selected register of the ENS161, Digital Metal-Oxide Multi-Gas Sensor with permanent and low power operating modes on the Air Quality 11 Click board.

Parameters
[in]ctx: Click context object. See airquality11_t object definition for detailed explanation.
[in]reg: Start register address.
[in]data_in: 16-byte data to be written.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.