DS3231 RTC module. More...

#include <DS3231.h>

Inheritance diagram for Loom_DS3231:

Public Member Functions
CONSTRUCTORS / DESTRUCTOR
	Loom_DS3231 (LoomManager *manager, TimeZone timezone=TimeZone::PST, const bool use_local_time=false, const bool custom_time=false)
	Constructor. More...

	Loom_DS3231 (LoomManager *manager, JsonArrayConst p)
	Constructor that takes Json Array, extracts args and delegates to regular constructor. More...

	~Loom_DS3231 ()=default
	Destructor. More...

OPERATION
DateTime	now () const override
	Get DateTime of current time. More...

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

void	clear_alarms () override
	Clear alarms. More...

Public Member Functions inherited from 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. More...

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

virtual void	package (JsonObject json) override
	Adds a timestamp to the provided data Json. 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...

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

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

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

void	link_device_manager (LoomManager *LM) override
	Add pointer back to device manager. 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
RTC_DS3231	rtc_inst
	Underlying DS3231 manager instance. More...

Protected Attributes inherited from LoomRTC
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
void	print_config () const override
	Display the configuration settings of the module. More...

bool	_begin () override
	Begin auxiliary function that subclasses need to implement. More...

bool	_initialized () override
	Initialization auxiliary function that subclasses need to implement. More...

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

Additional Inherited Members
Public Types inherited from LoomRTC
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...

Static Public Member Functions inherited from LoomRTC
static void	print_DateTime (DateTime time)
	Print an arbitrary DateTime object. More...

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

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 LoomRTC
void	init ()
	Initialize RTC. 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...

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

Detailed Description

DS3231 RTC module.

Resources

Constructor & Destructor Documentation

Loom_DS3231::Loom_DS3231	(	LoomManager *	manager,
		TimeZone	timezone = `TimeZone::PST`,
		const bool	use_local_time = `false`,
		const bool	custom_time = `false`
	)

Constructor.

Parameters

[in]	timezone	Set(TimeZone) \| <11> \| { 0("WAT"), 1("AT"), 2("ADT"), 3("AST"), 4("EDT"), 5("EST"), 6("CDT"), 7("CST"), 8("MDT"), 9("MST"), 10("PDT"), 11("PST"), 12("AKDT"), 13("AKST"), 14("HST"), 15("SST"), 16("GMT"), 17("BST"), 18("CET"), 19("EET"), 20("EEST"), 21("BRT"), 22("ZP4"), 23("ZP5"), 24("ZP6"), 25("ZP7"), 26("AWST"), 27("ACST"), 28("AEST")} \| Which timezone device is in
[in]	use_local_time	Bool \| <false> \| {true, false} \| True for local time, false for UTC time
[in]	custom_time	Bool \| <false> \| {true, false} \| True for user input local time, false otherwise

Loom_DS3231::Loom_DS3231	(	LoomManager *	manager,
		JsonArrayConst	p
	)

Constructor that takes Json Array, extracts args and delegates to regular constructor.

Parameters

[in] p The array of constuctor args to expand

Loom_DS3231::~Loom_DS3231 ( )

default

Destructor.

Member Function Documentation

void Loom_DS3231::_adjust ( const DateTime time )

inlineoverrideprotectedvirtual

Begin auxiliary function that subclasses need to implement.

Implements LoomRTC.

bool Loom_DS3231::_begin ( )

overrideprotectedvirtual

Begin auxiliary function that subclasses need to implement.

Returns: True if begin worked without issue, false otherwise

Implements LoomRTC.

bool Loom_DS3231::_initialized ( )

inlineoverrideprotectedvirtual

Initialization auxiliary function that subclasses need to implement.

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

Implements LoomRTC.

void Loom_DS3231::clear_alarms ( )

overridevirtual

Clear alarms.

Implements LoomRTC.

DateTime Loom_DS3231::now ( ) const

inlineoverridevirtual

Get DateTime of current time.

Returns: DateTime

Implements LoomRTC.

void Loom_DS3231::print_config ( ) const

overridevirtual

Display the configuration settings of the module.

Reimplemented from LoomRTC.

void Loom_DS3231::set_alarm ( DateTime time )

overridevirtual

Set an alarm to go off at the specified time.

Parameters

[in] time DateTime of time alarm should go off

Implements LoomRTC.

Member Data Documentation

RTC_DS3231 Loom_DS3231::rtc_inst

protected

Underlying DS3231 manager instance.

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

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

Public Member Functions

Protected Attributes

PRINT INFORMATION

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation