Abstract base class of RTC modules. More...

#include <RTC.h>

Inheritance diagram for LoomRTC:

Public Types
enum	TimeZone { TimeZone::WAT = 0, TimeZone::AT, TimeZone::ADT, TimeZone::AST, TimeZone::EDT, TimeZone::EST, TimeZone::CDT, TimeZone::CST, TimeZone::MDT, TimeZone::MST, TimeZone::PDT, TimeZone::PST, TimeZone::AKDT, TimeZone::AKST, TimeZone::HST, TimeZone::SST, TimeZone::GMT, TimeZone::BST, TimeZone::CET, TimeZone::EET, TimeZone::EEST, TimeZone::BRT, TimeZone::ZP4, TimeZone::ZP5, TimeZone::ZP6, TimeZone::ZP7, TimeZone::AWST, TimeZone::ACST, TimeZone::AEST }
	Different time zones. More...

Public Types inherited from LoomModule
enum	Type { Type::Unknown = 0, Type::Other =1000, Type::Interrupt_Manager, Type::Sleep_Manager, Type::Multiplexer, Type::NTP, Type::TempSync, Type::WarmUp_Manager, Type::Sensor =2000, Type::Analog, Type::Digital, Type::I2C =2100, Type::ADS1115, Type::AS7262, Type::AS7263, Type::AS7265X, Type::FXAS21002, Type::FXOS8700, Type::LIS3DH, Type::MB1232, Type::MMA8451, Type::MPU6050, Type::MS5803, Type::SHT31D, Type::TMP007, Type::TSL2561, Type::TSL2591, Type::ZXGesture, Type::STEMMA, Type::SDI12 =2200, Type::Decagon5TM, Type::DecagonGS3, Type::SPI =2300, Type::MAX31855, Type::MAX31856, Type::L_SERIAL =2400, Type::K30, Type::L_RTC =3000, Type::DS3231, Type::PCF8523, Type::Actuator =4000, Type::Neopixel, Type::Relay, Type::Servo, Type::Stepper, Type::LogPlat =5000, Type::OLED, Type::SDCARD, Type::BATCHSD, Type::CommPlat =6000, Type::LoRa, Type::nRF, Type::Bluetooth, Type::InternetPlat =7000, Type::Ethernet, Type::WiFi, Type::LTE, Type::PublishPlat =8000, Type::GoogleSheets, Type::MaxPub, Type::SpoolPub, Type::SubscribePlats =9000, Type::MaxSub }
	Enum to check against to when finding individual component managed by a LoomManager. More...

enum	Category { Category::Unknown =0, Category::Other =1, Category::Sensor =2, Category::L_RTC =3, Category::Actuator =4, Category::LogPlat =5, Category::CommPlat =6, Category::InternetPlat =7, Category::PublishPlat =8, Category::SubscribePlat =9 }
	Enum to classify modules. More...

Public Member Functions
CONSTRUCTORS / DESTRUCTOR
	LoomRTC (LoomManager manager, const char module_name, const LoomModule::Type module_type, TimeZone timezone, const bool use_local_time, const bool custom_time)
	Constructor. More...

virtual	~LoomRTC ()=default
	Destructor. More...

OPERATION
virtual void	package (JsonObject json) override
	Adds a timestamp to the provided data Json. More...

virtual DateTime	now () const =0
	Get DateTime of current time. More...

void	time_adjust (const DateTime time, const bool is_utc=true)
	Set time to provided timezone. More...

void	get_timestamp (char header, char timestamp, const char delimiter, const uint8_t format=3)
	Get timestamp. More...

virtual void	set_alarm (DateTime time)=0
	Set an alarm to go off at the specified time. More...

void	set_alarm (const TimeSpan duration)
	Set an alarm for a duration. More...

virtual void	clear_alarms ()=0
	Clear alarms. More...

GETTERS
const char *	get_datestring ()
	Get the pin the RTC interrupt is assumed to be connected to. More...

void	get_datestring (char *buf)
	Get string of date. More...

const char *	get_timestring ()
	Get string of time. More...

void	get_timestring (char *buf)
	Get string of time. More...

const char *	get_weekday ()
	Get string of weekday. More...

void	get_weekday (char *buf)
	Get string of weekday. More...

Public Member Functions inherited from LoomModule
	LoomModule (LoomManager manager, const char module_name="Unknown", const Type module_type=Type::Unknown)
	Constructor. More...

virtual	~LoomModule ()=default
	Destructor. More...

virtual void	second_stage_ctor ()
	Second stage construction. More...

virtual bool	dispatch (JsonObject json)
	Route command to driver. More...

virtual void	power_down ()
	Turn off any hardware. More...

virtual void	power_up ()
	Turn on any hardware. More...

virtual void	add_config (JsonObject json)
	Add configuration information to JsonObject. More...

Type	get_module_type () const
	Get module type. More...

LoomManager *	get_device_manager () const
	Get the device manager class if linked. More...

void	get_module_name (char *buf) const
	Copy module name into buffer. More...

const char *	get_module_name () const
	Get module name. More...

Verbosity	get_print_verbosity () const
	Get print verbosity. More...

Verbosity	get_package_verbosity () const
	Get package verbosity. More...

bool	get_active () const
	Get whether or not the module should be treated as active. More...

Category	category () const
	Get the category of the module. More...

void	set_print_verbosity (const Verbosity v)
	Set print verbosity Controlls level of detail included in debug prints. More...

void	set_package_verbosity (const Verbosity v)
	Set package verbosity. More...

void	set_active (const bool enable)
	Set whether or not the module should be treated as active. More...

Protected Attributes
TimeZone	timezone
	The TimeZone to use. More...

bool	use_local_time
	Whether or not use local time, else UTC time. More...

bool	converted
	Whether or not converted daylight saving / summer time or not. More...

bool	custom_time

DateTime	local_time
	DateTime variable for the Local Time. More...

char	local_datestring [20]
	Latest saved string of Local Date (year/month/day) More...

char	local_timestring [20]
	Latest saved string of Local time (hour:minute:second) More...

char	datestring [20]
	Latest saved string of the Date (year/month/day) More...

char	timestring [20]
	Latest saved string of the time (hour:minute:second) More...

Protected Attributes inherited from LoomModule
const Type	module_type
	Module type. More...

LoomManager *	device_manager
	Pointer to manager. More...

const String	module_name_base
	The name of the module (Should have a DEFAULT but can be overriden if provided to constructor) More...

const char *	module_name

bool	active
	Whether or not the module should be treated as active. More...

Verbosity	print_verbosity
	Print verbosity. More...

Verbosity	package_verbosity
	Package verbosity. More...

PRINT INFORMATION
virtual void	print_config () const override
	Display the configuration settings of the module. More...

virtual void	print_state () const override
	Display current state of the module. More...

void	print_time (const bool verbose=false)
	Print the current time. More...

static void	print_DateTime (DateTime time)
	Print an arbitrary DateTime object. More...

MISCELLANEOUS
void	link_device_manager (LoomManager *LM) override
	Add pointer back to device manager. More...

static char *	enum_timezone_string (const TimeZone t)
	Get string of name associated with time zone enum. More...

void	init ()
	Initialize RTC. More...

virtual void	_adjust (const DateTime time)=0
	Begin auxiliary function that subclasses need to implement. More...

virtual bool	_begin ()=0
	Begin auxiliary function that subclasses need to implement. More...

virtual bool	_initialized ()=0
	Initialization auxiliary function that subclasses need to implement. More...

void	read_rtc ()
	Read the RTC, update time and date strings. More...

void	local_rtc ()
	Read local time if local time is enable to read It will be updated on contents array in the data json. More...

void	set_rtc_to_compile_time ()
	Set the RTC time to compile time. More...

void	set_rtc_to_computer_time ()
	Set the RTC time to computer time by user input if the board is connected to computer. More...

void	convert_local_to_utc (const bool to_utc=true)
	Convert time between local and UTC. More...

bool	rtc_validity_check ()
	Check if current RTC time is valid (not necessarily correct) More...

DateTime	convert_daylight_to_standard (DateTime local_time)
	Convert time between daylight saving time and standard time. More...

DateTime	us_daylight_to_standard (DateTime local_time)
	Convert the time in the US daylight saving and standard. More...

DateTime	eu_daylight_to_standard (DateTime local_time)
	Convert the time in the EU summer time and standard. More...

Additional Inherited Members
Static Public Member Functions inherited from LoomModule
static const char *	enum_verbosity_string (const Verbosity v)
	Get string of name associated with verbosity enum. More...

static const char *	enum_category_string (const Category c)
	Get string of the category associated with a Category. More...

Protected Member Functions inherited from LoomModule
void	print_module_label () const
	Print the module name as a label. More...

Detailed Description

Abstract base class of RTC modules.

Resources

Member Enumeration Documentation

enum LoomRTC::TimeZone

strong

Different time zones.

Enumerator
WAT
AT
ADT
AST
EDT
EST
CDT
CST
MDT
MST
PDT
PST
AKDT
AKST
HST
SST
GMT
BST
CET
EET
EEST
BRT
ZP4
ZP5
ZP6
ZP7
AWST
ACST
AEST

Constructor & Destructor Documentation

LoomRTC::LoomRTC	(	LoomManager *	manager,
		const char *	module_name,
		const LoomModule::Type	module_type,
		TimeZone	timezone,
		const bool	use_local_time,
		const bool	custom_time
	)

Constructor.

Parameters

[in]	module_name	Name of the module (provided by derived classes)
[in]	module_type	Type of the module (provided by derived classes)
[in]	timezone	Which timezone device is in
[in]	use_local_time	True for local time, false for UTC time
[in]	custom_time	True for user input time, false otherwise

virtual LoomRTC::~LoomRTC ( )

virtualdefault

Destructor.

Member Function Documentation

virtual void LoomRTC::_adjust ( const DateTime time )

protectedpure virtual

Begin auxiliary function that subclasses need to implement.

Implemented in Loom_PCF8523, and Loom_DS3231.

virtual bool LoomRTC::_begin ( )

protectedpure virtual

Begin auxiliary function that subclasses need to implement.

Returns: True if begin worked without issue, false otherwise

Implemented in Loom_PCF8523, and Loom_DS3231.

virtual bool LoomRTC::_initialized ( )

protectedpure virtual

Initialization auxiliary function that subclasses need to implement.

Returns: True if RTC is initialized / did not lose power

Implemented in Loom_PCF8523, and Loom_DS3231.

virtual void LoomRTC::clear_alarms ( )

pure virtual

Clear alarms.

Implemented in Loom_PCF8523, and Loom_DS3231.

DateTime LoomRTC::convert_daylight_to_standard ( DateTime local_time )

protected

Convert time between daylight saving time and standard time.

Parameters

[in] local_time The updated version of local time after convertion of daylight saving / summer time or standard time

void LoomRTC::convert_local_to_utc ( const bool to_utc = true )

protected

Convert time between local and UTC.

Uses current timezone setting

Parameters

[in] to_utc True to switch to UTC, false to go to local from UTC

char * LoomRTC::enum_timezone_string ( const TimeZone t )

static

Get string of name associated with time zone enum.

Parameters

[in] t TimeZone value to get string of

Returns: C-string of time zone

DateTime LoomRTC::eu_daylight_to_standard ( DateTime local_time )

protected

Convert the time in the EU summer time and standard.

Parameters

[in] local_time The updated local_time based on eu summmer time

const char * LoomRTC::get_datestring ( )

Get the pin the RTC interrupt is assumed to be connected to.

Returns: Interrupt pin Get string of date; Date string

void LoomRTC::get_datestring ( char * buf )

Get string of date.

Parameters

[out] buf Buffer to fill

void LoomRTC::get_timestamp	(	char *	header,
		char *	timestamp,
		const char	delimiter,
		const uint8_t	format = `3`
	)

Get timestamp.

Parameters

[out]	header	Column header(s) of timestamp element
[out]	timestamp	String to fill with timestamp element(s)
[in]	delimiter	Delimiter to use
[in]	format	How to format timestamp (0: no timestamp added, 1: only date added, 2: only time added, 3: both date and time added (two fields), 4: both date and time added (combined field) ),

const char * LoomRTC::get_timestring ( )

Get string of time.

Returns: Time string

void LoomRTC::get_timestring ( char * buf )

Get string of time.

Parameters

[out] buf Buffer to fill]

const char* LoomRTC::get_weekday ( )

inline

Get string of weekday.

Returns: Weekday string

void LoomRTC::get_weekday ( char * buf )

Get string of weekday.

Parameters

[out] buf Buffer to fill

void LoomRTC::init ( )

protected

Initialize RTC.

Called by subclass constructors

void LoomRTC::link_device_manager ( LoomManager * LM )

overridevirtual

Add pointer back to device manager.

Generally only called when device manager links module to provide pointer both directions. Derived modules may override this for increased function, such as linking a submanager or RTC module.

Parameters

[in] LM LoomManager to point to

Reimplemented from LoomModule.

void LoomRTC::local_rtc ( )

protected

Read local time if local time is enable to read It will be updated on contents array in the data json.

virtual DateTime LoomRTC::now ( ) const

pure virtual

Get DateTime of current time.

Returns: DateTime

Implemented in Loom_PCF8523, and Loom_DS3231.

void LoomRTC::package ( JsonObject json )

overridevirtual

Adds a timestamp to the provided data Json.

Parameters

[out] json Object to add timestamp to

Implements LoomModule.

void LoomRTC::print_config ( ) const

overridevirtual

Display the configuration settings of the module.

Reimplemented from LoomModule.

Reimplemented in Loom_PCF8523, and Loom_DS3231.

void LoomRTC::print_DateTime ( DateTime time )

static

Print an arbitrary DateTime object.

Parameters

[in] time Time to print

void LoomRTC::print_state ( ) const

overridevirtual

Display current state of the module.

Reimplemented from LoomModule.

void LoomRTC::print_time ( const bool verbose = false )

Print the current time.

Parameters

[in] verbose True for multile lines, false for short display

void LoomRTC::read_rtc ( )

protected

Read the RTC, update time and date strings.

bool LoomRTC::rtc_validity_check ( )

protected

Check if current RTC time is valid (not necessarily correct)

Returns: True if valid

virtual void LoomRTC::set_alarm ( DateTime time )

pure virtual

Set an alarm to go off at the specified time.

Parameters

[in] time DateTime of time alarm should go off

Implemented in Loom_PCF8523, and Loom_DS3231.

void LoomRTC::set_alarm ( const TimeSpan duration )

inline

Set an alarm for a duration.

Parameters

[in] duration TimeSpan of duration before alarm goes off

void LoomRTC::set_rtc_to_compile_time ( )

protected

Set the RTC time to compile time.

void LoomRTC::set_rtc_to_computer_time ( )

protected

Set the RTC time to computer time by user input if the board is connected to computer.

void LoomRTC::time_adjust	(	const DateTime	time,
		const bool	is_utc = `true`
	)

Set time to provided timezone.

Parameters

[in]	time	Time to set to
[in]	is_utc	True if 'time' is in UTC, false if local

DateTime LoomRTC::us_daylight_to_standard ( DateTime local_time )

protected

Convert the time in the US daylight saving and standard.

Parameters

[in] local_time The updated local_time based on us daylight saving

Member Data Documentation

bool LoomRTC::converted

protected

Whether or not converted daylight saving / summer time or not.

bool LoomRTC::custom_time

protected

char LoomRTC::datestring[20]

protected

Latest saved string of the Date (year/month/day)

char LoomRTC::local_datestring[20]

protected

Latest saved string of Local Date (year/month/day)

DateTime LoomRTC::local_time

protected

DateTime variable for the Local Time.

char LoomRTC::local_timestring[20]

protected

Latest saved string of Local time (hour:minute:second)

char LoomRTC::timestring[20]

protected

Latest saved string of the time (hour:minute:second)

TimeZone LoomRTC::timezone

protected

The TimeZone to use.

bool LoomRTC::use_local_time

protected

Whether or not use local time, else UTC time.

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

src/RTC/RTC.h
src/RTC/RTC.cpp

Public Types

Public Member Functions

Protected Attributes

PRINT INFORMATION

MISCELLANEOUS

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation