Glue code to synchronize an RTC using an InternetPlat. More...

#include <NTP_Sync.h>

Inheritance diagram for LoomNTPSync:

Public Member Functions
CONSTRUCTORS / DESTRUCTOR
	LoomNTPSync (LoomManager *manager, const uint sync_interval_hours=0)
	NTP Sync module constructor. More...

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

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

void	second_stage_ctor () override
	Sync the RTC using NTP from the internet platform specified. More...

OPERATION
void	measure ()
	Sync the time if necessary or enabled. More...

void	package (JsonObject json) override
	Package a modules measurements or state. More...

bool	dispatch (JsonObject) override
	Route command to driver. 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	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...

virtual void	link_device_manager (LoomManager *LM)
	Add pointer back to device manager. 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...

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

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

Additional Inherited Members
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 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...

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

Detailed Description

Glue code to synchronize an RTC using an InternetPlat.

Always synchronizes the RTC from Loom_Interrupt_Manager::get_RTC_module().

Note: Requires a LoomRTC and LoomInternetPlat module to work.

Resources

Documentation

Constructor & Destructor Documentation

LoomNTPSync::LoomNTPSync	(	LoomManager *	manager,
		const uint	sync_interval_hours = `0`
	)

NTP Sync module constructor.

Parameters

[in] sync_interval_hours Int | <0> | [0-999] | What hourly period to sync the RTC, zero for once on startup.

LoomNTPSync::LoomNTPSync	(	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

LoomNTPSync::~LoomNTPSync ( )

default

Destructor.

Member Function Documentation

bool LoomNTPSync::dispatch ( JsonObject json )

inlineoverridevirtual

Route command to driver.

Reimplemented from LoomModule.

void LoomNTPSync::measure ( )

Sync the time if necessary or enabled.

Allows the module to run regularly by emulating a sensor, which have thier measure methods called regularly.

void LoomNTPSync::package ( JsonObject json )

inlineoverridevirtual

Package a modules measurements or state.

Parameters

[out] json Object to put data into

Implements LoomModule.

void LoomNTPSync::print_config ( ) const

overridevirtual

Display the configuration settings of the module.

Reimplemented from LoomModule.

void LoomNTPSync::print_state ( ) const

overridevirtual

Display current state of the module.

Reimplemented from LoomModule.

void LoomNTPSync::second_stage_ctor ( )

overridevirtual

Sync the RTC using NTP from the internet platform specified.

Reimplemented from LoomModule.

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

src/NTP_Sync.h
src/NTP_Sync.cpp

Public Member Functions

PRINT INFORMATION

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation