TempSensor Class Reference

Implementation of a Sensor for the onboard temperature sensor. More...

#include <TempSensor.h>

Inheritance diagram for TempSensor:

Collaboration diagram for TempSensor:

Public Member Functions
	TempSensor ()
	Construct a new Temp Sensor object with default minimum_period of 0 ms.
	TempSensor (unsigned long minium_period)
	Construct a new Temp Sensor object.
bool	verify () override
	Returns if sensor can be reached, the temperature sensor is on the pico so it is assumed to be always true, implemented only for compatability with parent.
String	readData () override
	Reads temperature data in Celsius.
void	readDataPacket (uint8_t *&packet) override
	Used for creating packets, reads data from the sensor and appends it to the passed uint8_t array pointer, incrementing it while doing so.
String	decodeToCSV (uint8_t *&packet) override
	Used for onboard decoding of packets.
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.

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 onboard temperature sensor.

Constructor & Destructor Documentation

TempSensor() [1/2]

TempSensor::TempSensor

(

)

Construct a new Temp Sensor object with default minimum_period of 0 ms.

TempSensor() [2/2]

TempSensor::TempSensor

(

unsigned long

minium_period

)

Construct a new Temp Sensor object.

Parameters

minium_period

Minimum time to wait between readings in ms

Member Function Documentation

decodeToCSV()

String TempSensor::decodeToCSV ( uint8_t *&  packet )

overridevirtual

Used for onboard decoding of packets.

Parameters

packet

Pointer to the packet byte array

Returns

String The senors data decoded from the packet in csv format

Reimplemented from Sensor.

readData()

String TempSensor::readData ( )

overridevirtual

Reads temperature data in Celsius.

Returns

String Temperature data in CSV format

Implements Sensor.

readDataPacket()

void TempSensor::readDataPacket ( uint8_t *&  packet )

overridevirtual

Used for creating packets, reads data from the sensor and appends it to the passed uint8_t array pointer, incrementing it while doing so.

Parameters

packet

Pointer to the packet byte array

Returns

int The number of bytes appended

Reimplemented from Sensor.

verify()

bool TempSensor::verify ( )

overridevirtual

Returns if sensor can be reached, the temperature sensor is on the pico so it is assumed to be always true, implemented only for compatability with parent.

Returns

true always

false never

Implements Sensor.

---

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

• TempSensor.h
• TempSensor.cpp