SHTC3Sensor Class Reference

Implementation of a Sensor for the SHTC3. More...

#include <SHTC3Sensor.h>

Inheritance diagram for SHTC3Sensor:

Collaboration diagram for SHTC3Sensor:

Public Member Functions
	SHTC3Sensor (TwoWire *i2c_bus=&Wire)
	Default constructor for the SHTC3Sensor class.
	SHTC3Sensor (unsigned long minimum_period, TwoWire *i2c_bus=&Wire)
	Construct a new SHTC3Sensor object.
bool	verify () override
	Returns if sensor is connected and working.
String	readData () override
	Reads temperature in Celcius and relative humidity in % from SHTC3.
void	readDataPacket (uint8_t *&packet) override
	Copies data to the packet.
String	decodeToCSV (uint8_t *&packet) override
	Decodes data from the packet.
float	getRelHum ()
	Getter for relative humidity.
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_SHTC3	shtc3
float	relative_humidity
TwoWire *	i2c_bus

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 SHTC3.

Constructor & Destructor Documentation

SHTC3Sensor() [1/2]

SHTC3Sensor::SHTC3Sensor

(

TwoWire *

i2c_bus = &Wire

)

Default constructor for the SHTC3Sensor class.

Initializes the sensor object with a default minimum period of 0 milliseconds.

SHTC3Sensor() [2/2]

SHTC3Sensor::SHTC3Sensor	(	unsigned long	minimum_period,
		TwoWire *	i2c_bus = &Wire
	)

Construct a new SHTC3Sensor object.

Parameters

minium_period

Minimum time to wait between readings in ms

Member Function Documentation

decodeToCSV()

String SHTC3Sensor::decodeToCSV ( uint8_t *&  packet )

overridevirtual

Decodes data from the packet.

Parameters

packet

Pointer to decode at

Returns

String CSV stub Temperature, Humidity

Reimplemented from Sensor.

getRelHum()

float SHTC3Sensor::getRelHum

(

)

Getter for relative humidity.

Returns

float Relative humidity as %

Here is the caller graph for this function:

readData()

String SHTC3Sensor::readData ( )

overridevirtual

Reads temperature in Celcius and relative humidity in % from SHTC3.

Returns

String Temp (C) and Humidity (%) in csv format.

Implements Sensor.

readDataPacket()

void SHTC3Sensor::readDataPacket ( uint8_t *&  packet )

overridevirtual

Copies data to the packet.

Parameters

packet

Pointer to copy at

Reimplemented from Sensor.

verify()

bool SHTC3Sensor::verify ( )

overridevirtual

Returns if sensor is connected and working.

Returns

true if sensor is connected and working.

false if sensor is not.

Implements Sensor.

Member Data Documentation

i2c_bus

TwoWire* SHTC3Sensor::i2c_bus

private

relative_humidity

float SHTC3Sensor::relative_humidity

private

shtc3

Adafruit_SHTC3 SHTC3Sensor::shtc3

private

---

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

• SHTC3Sensor.h
• SHTC3Sensor.cpp