PCF8523Sensor Class Reference

Implementation of the PCF8523 sensor. More...

#include <PCF8523Sensor.h>

Inheritance diagram for PCF8523Sensor:

Collaboration diagram for PCF8523Sensor:

Public Member Functions
	PCF8523Sensor ()
	PCF8523Sensor (unsigned long minimum_period)
bool	verify () override
	Verifies if the sensor is connected and working.
String	decodeToCSV (uint8_t *&packet) override
	Decode the packet data and returns it in CSV format.
void	readDataPacket (uint8_t *&packet) override
	Reads sensor data and appends it to the packet byte array.
String	readData () override
	Returns the collected data from the sensor in CSV format.
void	calibrate ()
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
RTC_PCF8523	rtc

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 the PCF8523 sensor.

Constructor & Destructor Documentation

PCF8523Sensor() [1/2]

PCF8523Sensor::PCF8523Sensor

(

)

PCF8523Sensor() [2/2]

PCF8523Sensor::PCF8523Sensor

(

unsigned long

minimum_period

)

Member Function Documentation

calibrate()

void PCF8523Sensor::calibrate

(

)

decodeToCSV()

String PCF8523Sensor::decodeToCSV ( uint8_t *&  packet )

overridevirtual

Decode the packet data and returns it in CSV format.

Decodes the packet data from the PCF8523 sesor and returns it in CSV format. The data includes date and time.

Parameters

packet

- Packet to decode

Returns

String - A String containing the sensor readings

Reimplemented from Sensor.

readData()

String PCF8523Sensor::readData ( )

overridevirtual

Returns the collected data from the sensor in CSV format.

Returns

String

Implements Sensor.

readDataPacket()

void PCF8523Sensor::readDataPacket ( uint8_t *&  packet )

overridevirtual

Reads sensor data and appends it to the packet byte array.

Reads data from the PCF8523 sensor and appends it to the passed uint8_t array pointer, incrementing it while doing so. The data includes Year, Month, Day, Hour, Minutes, Seconds.

Parameters

packet

- Pointer to the packet byte array.

Reimplemented from Sensor.

verify()

bool PCF8523Sensor::verify ( )

overridevirtual

Verifies if the sensor is connected and working.

Returns

true, if connected

false, if not connected

Implements Sensor.

Member Data Documentation

rtc

RTC_PCF8523 PCF8523Sensor::rtc

private

---

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

• PCF8523Sensor.h
• PCF8523Sensor.cpp