LoomNTPSync class

Glue code to synchronize an RTC using an InternetPlat.

Base classes

class LoomModule: Abstract root of Loom component modules inheritance hierarchy.

LoomNTPSync(LoomManager* manager, const uint sync_interval_hours = 0): NTP Sync module constructor.
LoomNTPSync(LoomManager* manager, JsonArrayConst p): Constructor that takes Json Array, extracts args and delegates to regular constructor.
~LoomNTPSync() defaulted: Destructor.
void second_stage_ctor() override: Sync the RTC using NTP from the internet platform specified.

void measure(): Sync the time if necessary or enabled.
void package(JsonObject json) override: Package a modules measurements or state.
auto dispatch(JsonObject json) -> bool override: Route command to driver.

enum Error { OK, INVAL_DEVICE_MANAGE, INVAL_INTERNET, INVAL_TIME, INVAL_RTC, NON_START, NO_CONNECTION }: enumerate errors
const uint m_sync_interval: Store the sync interval, in hours.
LoomInternetPlat* m_internet: Store the Internet Plat from second stage contsruction.
LoomRTC* m_rtc: Store the RTC pointer so we can check the time.
DateTime m_next_sync: Store when next to change the RTC.
Error m_last_error: Store if we've successfully accomplished our task.
void print_config() const override: Display the configuration settings of the module.
void print_state() const override: Display current state of the module.

enumerate errors

Enumerators
OK
INVAL_DEVICE_MANAGE	Failed to receive a Loom Device Manager.
INVAL_INTERNET	Failed to find the correct internet object.
INVAL_TIME	Retrieved a time that was invalid.
INVAL_RTC	Failed to find a RTC.
NON_START	No attempt was made to sync.
NO_CONNECTION	Repeated attempts were made to sync, but there was no response.

NTP Sync module constructor.

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

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

Parameters
manager
p in	The array of constuctor args to expand

Sync the time if necessary or enabled.

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

Package a modules measurements or state.

Parameters
json out	Object to put data into