airquality12 2.1.0.0
Loading...
Searching...
No Matches
Air Quality 12 Click Driver

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

Topics

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

Functions

void airquality12_cfg_setup (airquality12_cfg_t *cfg)
 Air Quality 12 configuration object setup function.
 
void airquality12_drv_interface_sel (airquality12_cfg_t *cfg, airquality12_drv_t drv_sel)
 Air Quality 12 driver interface setup function.
 
err_t airquality12_init (airquality12_t *ctx, airquality12_cfg_t *cfg)
 Air Quality 12 initialization function.
 
err_t airquality12_default_cfg (airquality12_t *ctx)
 Air Quality 12 default configuration function.
 
err_t airquality12_send_cmd (airquality12_t *ctx, uint8_t cmd, airquality12_param_t *params)
 Air Quality 12 send cmd function.
 
void airquality12_set_rst_pin (airquality12_t *ctx, uint8_t state)
 Air Quality 12 set rst pin function.
 
void airquality12_set_gp1_pin (airquality12_t *ctx, uint8_t state)
 Air Quality 12 set gp1 pin function.
 
void airquality12_reset_device (airquality12_t *ctx)
 Air Quality 12 reset device function.
 
uint8_t airquality12_get_int_pin (airquality12_t *ctx)
 Air Quality 12 get int pin function.
 
err_t airquality12_check_comm (airquality12_t *ctx)
 Air Quality 12 check comm function.
 
err_t airquality12_get_sensor_info (airquality12_t *ctx, airquality12_info_t *info)
 Air Quality 12 get sensor info function.
 
err_t airquality12_get_op_mode (airquality12_t *ctx, uint8_t *op_mode)
 Air Quality 12 get op mode function.
 
err_t airquality12_set_op_mode (airquality12_t *ctx, uint8_t op_mode)
 Air Quality 12 set op mode function.
 
err_t airquality12_set_humidity (airquality12_t *ctx, float humidity)
 Air Quality 12 set humidity function.
 
err_t airquality12_get_measurement (airquality12_t *ctx, airquality12_results_t *results)
 Air Quality 12 get measurement function.
 
err_t airquality12_config_gpio (airquality12_t *ctx, uint8_t gpio_mask)
 Air Quality 12 config gpio function.
 
err_t airquality12_get_gpio (airquality12_t *ctx, uint8_t *gpio_mask)
 Air Quality 12 get gpio function.
 
err_t airquality12_set_gpio (airquality12_t *ctx, uint8_t gpio_mask)
 Air Quality 12 set gpio function.
 
err_t airquality12_clear_gpio (airquality12_t *ctx, uint8_t gpio_mask)
 Air Quality 12 clear gpio function.
 
err_t airquality12_perform_cleaning (airquality12_t *ctx)
 Air Quality 12 perform cleaning function.
 

Detailed Description

API for configuring and manipulating Air Quality 12 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

◆ airquality12_cfg_setup()

void airquality12_cfg_setup ( airquality12_cfg_t * cfg)

Air Quality 12 configuration object setup function.

This function initializes Click configuration structure to initial values.

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

◆ airquality12_check_comm()

err_t airquality12_check_comm ( airquality12_t * ctx)

Air Quality 12 check comm function.

This function checks the communication by reading and verifying the product ID.

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

◆ airquality12_clear_gpio()

err_t airquality12_clear_gpio ( airquality12_t * ctx,
uint8_t gpio_mask )

Air Quality 12 clear gpio function.

This function clears the GPIO1 and GPIO2 pins to low logic state.

Parameters
[in]ctx: Click context object. See airquality12_t object definition for detailed explanation.
[in]gpio_mask: GPIO mask (bit0 - GPIO1, bit1 - GPIO2).
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ airquality12_config_gpio()

err_t airquality12_config_gpio ( airquality12_t * ctx,
uint8_t gpio_mask )

Air Quality 12 config gpio function.

This function sets the GPIO1 and GPIO2 pins direction.

Parameters
[in]ctx: Click context object. See airquality12_t object definition for detailed explanation.
[in]gpio_mask: GPIO mask (bit0 - GPIO1, bit1 - GPIO2).
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ airquality12_default_cfg()

err_t airquality12_default_cfg ( airquality12_t * ctx)

Air Quality 12 default configuration function.

This function executes a default configuration of Air Quality 12 Click board.

Parameters
[in]ctx: Click context object. See airquality12_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.

◆ airquality12_drv_interface_sel()

void airquality12_drv_interface_sel ( airquality12_cfg_t * cfg,
airquality12_drv_t drv_sel )

Air Quality 12 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 airquality12_cfg_t object definition for detailed explanation.
[in]drv_sel: Driver interface selection. See airquality12_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.

◆ airquality12_get_gpio()

err_t airquality12_get_gpio ( airquality12_t * ctx,
uint8_t * gpio_mask )

Air Quality 12 get gpio function.

This function reads the GPIO1-4 pins value.

Parameters
[in]ctx: Click context object. See airquality12_t object definition for detailed explanation.
[in]gpio_mask: GPIO mask (bit0 - GPIO1, bit1 - GPIO2, bit2 - GPIO3, bit3 - GPIO4).
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ airquality12_get_int_pin()

uint8_t airquality12_get_int_pin ( airquality12_t * ctx)

Air Quality 12 get int pin function.

This function returns the INT pin logic state.

Parameters
[in]ctx: Click context object. See airquality12_t object definition for detailed explanation.
Returns
Pin logic state.
Note
None.

◆ airquality12_get_measurement()

err_t airquality12_get_measurement ( airquality12_t * ctx,
airquality12_results_t * results )

Air Quality 12 get measurement function.

This function reads the sensor measurement results.

Parameters
[in]ctx: Click context object. See airquality12_t object definition for detailed explanation.
[out]results: Sensor measurement results. See airquality12_results_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ airquality12_get_op_mode()

err_t airquality12_get_op_mode ( airquality12_t * ctx,
uint8_t * op_mode )

Air Quality 12 get op mode function.

This function reads the sensor operating mode.

Parameters
[in]ctx: Click context object. See airquality12_t object definition for detailed explanation.
[out]op_mode: Sensor operating mode.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ airquality12_get_sensor_info()

err_t airquality12_get_sensor_info ( airquality12_t * ctx,
airquality12_info_t * info )

Air Quality 12 get sensor info function.

This function reads the device product ID, firmware version, and tracking number.

Parameters
[in]ctx: Click context object. See airquality12_t object definition for detailed explanation.
[out]info: Sensor information structure. See airquality12_info_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ airquality12_init()

err_t airquality12_init ( airquality12_t * ctx,
airquality12_cfg_t * cfg )

Air Quality 12 initialization function.

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

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

◆ airquality12_perform_cleaning()

err_t airquality12_perform_cleaning ( airquality12_t * ctx)

Air Quality 12 perform cleaning function.

This function performs the sensor cleaning procedure.

Parameters
[in]ctx: Click context object. See airquality12_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
The sensor must run a cleaning procedure once in its lifetime. The cleaning process takes up to 1 minute.

◆ airquality12_reset_device()

void airquality12_reset_device ( airquality12_t * ctx)

Air Quality 12 reset device function.

This function resets device by toggling the RST pin logic state.

Parameters
[in]ctx: Click context object. See airquality12_t object definition for detailed explanation.
Returns
None.
Note
None.

◆ airquality12_send_cmd()

err_t airquality12_send_cmd ( airquality12_t * ctx,
uint8_t cmd,
airquality12_param_t * params )

Air Quality 12 send cmd function.

This function sends the selected command with parameters and reads response.

Parameters
[in]ctx: Click context object. See airquality12_t object definition for detailed explanation.
[in]cmd: Command byte.
[in,out]params: Parameters structure with request and response buffers. See airquality12_param_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ airquality12_set_gp1_pin()

void airquality12_set_gp1_pin ( airquality12_t * ctx,
uint8_t state )

Air Quality 12 set gp1 pin function.

This function sets the GP1 pin logic state.

Parameters
[in]ctx: Click context object. See airquality12_t object definition for detailed explanation.
[in]state: Pin logic state.
Returns
None.
Note
None.

◆ airquality12_set_gpio()

err_t airquality12_set_gpio ( airquality12_t * ctx,
uint8_t gpio_mask )

Air Quality 12 set gpio function.

This function sets the GPIO1 and GPIO2 pins to high logic state.

Parameters
[in]ctx: Click context object. See airquality12_t object definition for detailed explanation.
[in]gpio_mask: GPIO mask (bit0 - GPIO1, bit1 - GPIO2).
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ airquality12_set_humidity()

err_t airquality12_set_humidity ( airquality12_t * ctx,
float humidity )

Air Quality 12 set humidity function.

This function sets the relative humidity level in percents.

Parameters
[in]ctx: Click context object. See airquality12_t object definition for detailed explanation.
[in]humidity: Relative humidity level in percents.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
The default humidity level is set to 50%. Measure the humidity level externally and adjust this setting in a loop before reading measurements.

◆ airquality12_set_op_mode()

err_t airquality12_set_op_mode ( airquality12_t * ctx,
uint8_t op_mode )

Air Quality 12 set op mode function.

This function sets the sensor operating mode.

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

◆ airquality12_set_rst_pin()

void airquality12_set_rst_pin ( airquality12_t * ctx,
uint8_t state )

Air Quality 12 set rst pin function.

This function sets the RST pin logic state.

Parameters
[in]ctx: Click context object. See airquality12_t object definition for detailed explanation.
[in]state: Pin logic state.
Returns
None.
Note
None.