Air quality Click Driver

API for configuring and manipulating Air quality Click driver. More...

Topics
	Air quality Registers List
	List of registers of Air quality Click driver.
	Air quality Registers Settings
	Settings for registers of Air quality Click driver.
	Air quality MikroBUS Map
	MikroBUS pin mapping of Air quality Click driver.

Functions
void	airquality_cfg_setup (airquality_cfg_t *cfg)
	Air quality configuration object setup function.
err_t	airquality_init (airquality_t *ctx, airquality_cfg_t *cfg)
	Air quality initialization function.
err_t	airquality_read_an_pin_value (airquality_t *ctx, uint16_t *data_out)
	Air quality read AN pin value function.
err_t	airquality_read_an_pin_voltage (airquality_t *ctx, float *data_out)
	Air quality read AN pin voltage level function.

Detailed Description

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

airquality_cfg_setup()

void airquality_cfg_setup

(

airquality_cfg_t *

cfg

)

Air quality configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See airquality_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

airquality_init()

err_t airquality_init	(	airquality_t *	ctx,
		airquality_cfg_t *	cfg )

Air quality initialization function.

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

Parameters

[out]	ctx	: Click context object. See airquality_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See airquality_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.

airquality_read_an_pin_value()

err_t airquality_read_an_pin_value	(	airquality_t *	ctx,
		uint16_t *	data_out )

Air quality read AN pin value function.

This function reads results of AD conversion of the AN pin.

Parameters

[in]	ctx	: Click context object. See airquality_t object definition for detailed explanation.
[out]	data_out	: Output ADC result.

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.

airquality_read_an_pin_voltage()

err_t airquality_read_an_pin_voltage	(	airquality_t *	ctx,
		float *	data_out )

Air quality read AN pin voltage level function.

This function reads results of AD conversion of the AN pin and converts them to proportional voltage level.

Parameters

[in]	ctx	: Click context object. See airquality_t object definition for detailed explanation.
[out]	data_out	: Output voltage level of the analog pin [V].

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

The conversion to voltage depends on the entered configuration of the ADC (resolution, reference voltage).