Driver for SGPC3 VOC gas sensor. More...

Typedefs
typedef struct twr_sgpc3_t	twr_sgpc3_t
	SGPC3 instance.

Enumerations
enum	twr_sgpc3_event_t { TWR_SGPC3_EVENT_ERROR = 0 , TWR_SGPC3_EVENT_UPDATE = 1 }
	Callback events. More...

Functions
void	twr_sgpc3_init (twr_sgpc3_t *self, twr_i2c_channel_t i2c_channel, uint8_t i2c_address)
	Initialize SGPC3. More...

void	twr_sgpc3_deinit (twr_sgpc3_t *self)
	Deinitialize SGPC3. More...

void	twr_sgpc3_set_event_handler (twr_sgpc3_t self, void(event_handler)(twr_sgpc3_t , twr_sgpc3_event_t, void ), void *event_param)
	Set callback function. More...

void	twr_sgpc3_set_update_interval (twr_sgpc3_t *self, twr_tick_t interval)
	Set measurement interval. More...

bool	twr_sgpc3_measure (twr_sgpc3_t *self)
	Start measurement manually. More...

bool	twr_sgpc3_get_tvoc_ppb (twr_sgpc3_t self, uint16_t ppb)
	Get measured TVOC in ppb (parts per billion) More...

float	twr_sgpc3_set_compensation (twr_sgpc3_t self, float t_celsius, float *rh_percentage)
	Set sensor compensation (absolute humidity is calculated from temperature and relative humidity) More...

Detailed Description

Driver for SGPC3 VOC gas sensor.

Enumeration Type Documentation

◆ twr_sgpc3_event_t

enum twr_sgpc3_event_t

Callback events.

Enumerator
TWR_SGPC3_EVENT_ERROR	Error event.
TWR_SGPC3_EVENT_UPDATE	Update event.

Definition at line 13 of file twr_sgpc3.h.

Function Documentation

◆ twr_sgpc3_deinit()

void twr_sgpc3_deinit ( twr_sgpc3_t * self )

Deinitialize SGPC3.

Parameters

[in] self Instance

Definition at line 33 of file twr_sgpc3.c.

Here is the call graph for this function:

◆ twr_sgpc3_get_tvoc_ppb()

bool twr_sgpc3_get_tvoc_ppb	(	twr_sgpc3_t *	self,
		uint16_t *	ppb
	)

Get measured TVOC in ppb (parts per billion)

Parameters

[in]	self	Instance
[out]	ppb	Pointer to variable where result will be stored

Returns: true When value is valid; false When value is invalid

Definition at line 81 of file twr_sgpc3.c.

Referenced by twr_tag_voc_lp_get_tvoc_ppb().

Here is the caller graph for this function:

◆ twr_sgpc3_init()

void twr_sgpc3_init	(	twr_sgpc3_t *	self,
		twr_i2c_channel_t	i2c_channel,
		uint8_t	i2c_address
	)

Initialize SGPC3.

Parameters

[in]	self	Instance
[in]	i2c_channel	I2C channel
[in]	i2c_address	I2C device address

Definition at line 18 of file twr_sgpc3.c.

Referenced by twr_tag_voc_lp_init().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ twr_sgpc3_measure()

bool twr_sgpc3_measure ( twr_sgpc3_t * self )

Start measurement manually.

Parameters

[in] self Instance

Returns: true On success; false When other measurement is in progress

Definition at line 62 of file twr_sgpc3.c.

Referenced by twr_sgpc3_set_update_interval(), and twr_tag_voc_lp_measure().

Here is the caller graph for this function:

◆ twr_sgpc3_set_compensation()

float twr_sgpc3_set_compensation	(	twr_sgpc3_t *	self,
		float *	t_celsius,
		float *	rh_percentage
	)

Set sensor compensation (absolute humidity is calculated from temperature and relative humidity)

Parameters

[in]	self	Instance
[in]	t_celsius	Pointer to variable holding temperature in degrees of celsius (must be NULL if not available)
[in]	rh_percentage	Pointer to variable holding relative humidity in percentage (must be NULL if not available)