DS3231Sensor Class Reference

Implementation of a Sensor for the DS3231 Real Time Clock. More...

#include <DS3231Sensor.h>

Inheritance diagram for DS3231Sensor:

Collaboration diagram for DS3231Sensor:

Public Member Functions
	DS3231Sensor ()
	Default constructor for the BME680Sensor class.
	DS3231Sensor (unsigned long minimum_period)
	Parameterized constructor for the BME680Sensor class.
bool	verify () override
	Verifies that the sensor is connected.
String	readData () override
	Reads timestamp data from RTC (plus temperature)
void	readDataPacket (uint8_t *&packet) override
	Reads timestamp data from RTC (plus temperature)
String	decodeToCSV (uint8_t *&packet) override
	Decodes a packet into a CSV string.
void	setTime (int year, int month, int day, int hour, int minute, int second)
	Utility function to set the RTC's time, easier to use a separate Arduino program to do this.
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_DS3231	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 a Sensor for the DS3231 Real Time Clock.

Constructor & Destructor Documentation

DS3231Sensor() [1/2]

DS3231Sensor::DS3231Sensor

(

)

Default constructor for the BME680Sensor class.

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

DS3231Sensor() [2/2]

DS3231Sensor::DS3231Sensor

(

unsigned long

minimum_period

)

Parameterized constructor for the BME680Sensor class.

This constructor initializes the BME680Sensor with a specified minimum period between sensor readings. It passes sensor-specific information like the name, CSV header, number of fields, and the minimum period between reads to the base Sensor class constructor.

Parameters

minimum_period

The minimum time (in milliseconds) between consecutive sensor reads.

Member Function Documentation

decodeToCSV()

String DS3231Sensor::decodeToCSV ( uint8_t *&  packet )

overridevirtual

Decodes a packet into a CSV string.

Reimplemented from Sensor.

readData()

String DS3231Sensor::readData ( )

overridevirtual

Reads timestamp data from RTC (plus temperature)

Implements Sensor.

readDataPacket()

void DS3231Sensor::readDataPacket ( uint8_t *&  packet )

overridevirtual

Reads timestamp data from RTC (plus temperature)

Reimplemented from Sensor.

setTime()

void DS3231Sensor::setTime	(	int	year,
		int	month,
		int	day,
		int	hour,
		int	minute,
		int	second
	)

Utility function to set the RTC's time, easier to use a separate Arduino program to do this.

Parameters

year	Year
month	Month
day	Day
hour	Hour in 24h time
minute	Minute
second	Second

verify()

bool DS3231Sensor::verify ( )

overridevirtual

Verifies that the sensor is connected.

Returns

true - If the sensor is detected and successfully initialized.

false - If the sensor is not detected or fails to initialize.

Implements Sensor.

Member Data Documentation

rtc

RTC_DS3231 DS3231Sensor::rtc

private

---

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

• DS3231Sensor.h
• DS3231Sensor.cpp