SGP30Sensor Class Reference

Implementation of a Sensor for the SGP Air Quality sensor. More...

#include <SGP30Sensor.h>

Inheritance diagram for SGP30Sensor:

Collaboration diagram for SGP30Sensor:

Public Member Functions
	SGP30Sensor ()
	Default constructor for the SGP30Sensor.
	SGP30Sensor (unsigned long minimum_period)
	Constructor that sets a minimum period between sensor reads.
bool	verify () override
	Verifies that the SGP30 sensor is connected and operational.
String	readData () override
	Reads the SGP30 data as a CSV string ("eCO2,TVOC,").
void	readDataPacket (uint8_t *&packet) override
	Appends the SGP30 sensor data (eCO2, TVOC) plus a simple 16-bit checksum to the packet buffer.
String	decodeToCSV (uint8_t *&packet) override
	Decodes the SGP30 sensor data (eCO2, TVOC) plus checksum from the packet buffer, and returns a CSV string.
Public Member Functions inherited from Sensor
	Sensor (String sensor_name, String csv_header, unsigned long minimum_period)
	Sensor (String sensor_name, String csv_header)
	Sensor (String sensor_name, String csv_header, int fields)
	Construct a new Sensor object with default minimum_period of 0 (depreciated)
	Sensor (String sensor_name, String csv_header, int fields, unsigned long minimum_period)
	Construct a new Sensor object (Depreciated)
unsigned long	getPeriod () const
	Get the minimum minimum_period between sensor reads in ms.
void	setPeriod (int minimum_period)
	Set the minimum minimum_period between sensor reads in ms.
unsigned long	getLastExecution () const
	Get the system time of the last execution in ms.
void	setLastExecution (int last_execution)
	Set the system time of the last execution in ms.
const String &	getSensorCSVHeader () const
	Get the csv header string associated with this sensor.
void	getDataPacket (uint32_t &sensor_id, uint8_t *&packet)
	Append the data from a sensor to the packet if the minium period is satisfied.
String	readEmpty () const
	Returns CSV line in the same format as readData() but with "-" instead of data.
String	getDataCSV ()
	Uses readData and readEmpty to get the data-filled or empty-celled CSV line for the sensor.
Public Member Functions inherited from Device
	Device (String device_name)
	Default constructor, sets a max_attempt of 1 (device recovery won't be attempted)
	Device (String device_name, int max_attempts, int wait_factor)
const String &	getDeviceName ()
bool	getVerified ()
	Get if the Device is Verified.
void	recoveryConfig (int max_attempts, int wait_factor)
	Set recovery config (used keep default constructor)
void	setWaitFactor (int wait_factor)
	Set wait_factor.
void	setMaxAttempts (int max_attempts)
	Set max_attempts.
bool	attemptConnection ()
	If the sensor is verified, return true, if not and it has been long enough since the last attempt (decided by wait_factor and attempt_number), attempt to reverify (reinitialize) it.

Private Attributes
Adafruit_SGP30	sgp

Additional Inherited Members
Protected Attributes inherited from Sensor
int	num_fields
Protected Attributes inherited from Device
bool	verified
String	device_name

Detailed Description

Implementation of a Sensor for the SGP Air Quality sensor.

Constructor & Destructor Documentation

SGP30Sensor() [1/2]

SGP30Sensor::SGP30Sensor

(

)

Default constructor for the SGP30Sensor.

SGP30Sensor() [2/2]

SGP30Sensor::SGP30Sensor

(

unsigned long

minimum_period

)

Constructor that sets a minimum period between sensor reads.

Parameters

minimum_period

Minimum period in ms.

Member Function Documentation

decodeToCSV()

String SGP30Sensor::decodeToCSV ( uint8_t *&  packet )

overridevirtual

Decodes the SGP30 sensor data (eCO2, TVOC) plus checksum from the packet buffer, and returns a CSV string.

Data layout must match the above function:

• eCO2: uint16_t
• TVOC: uint16_t
• checksum: uint16_t

Parameters

packet

Pointer to the packet buffer. This pointer is advanced by 6 bytes.

Returns

String "eCO2,TVOC,Checksum: X (computed: Y),"

Reimplemented from Sensor.

readData()

String SGP30Sensor::readData ( )

overridevirtual

Reads the SGP30 data as a CSV string ("eCO2,TVOC,").

Implements Sensor.

readDataPacket()

void SGP30Sensor::readDataPacket ( uint8_t *&  packet )

overridevirtual

Appends the SGP30 sensor data (eCO2, TVOC) plus a simple 16-bit checksum to the packet buffer.

Data layout in the packet:

• eCO2: uint16_t (2 bytes)
• TVOC: uint16_t (2 bytes)
• checksum: uint16_t (2 bytes) sum of the above 4 bytes

Parameters

packet

Pointer to the current position in the packet buffer.

Returns

The number of bytes appended (6).

Reimplemented from Sensor.

verify()

bool SGP30Sensor::verify ( )

overridevirtual

Verifies that the SGP30 sensor is connected and operational.

Returns

true if sensor initializes correctly, false otherwise.

Implements Sensor.

Member Data Documentation

sgp

Adafruit_SGP30 SGP30Sensor::sgp

private

---

The documentation for this class was generated from the following files:

• SGP30Sensor.h
• SGP30Sensor.cpp