Manager to contain Loom modules and provide users with a simpler API. More...

#include <Manager.h>

Public Types
enum	DeviceType { DeviceType::HUB, DeviceType::NODE, DeviceType::REPEATER }
	Different general types of devices. More...

Public Member Functions
CONSTRUCTORS / DESTRUCTOR
	LoomManager (const FactoryBase factory_ptr, const char device_name="Device", const uint8_t instance=1, const DeviceType device_type=DeviceType::NODE, const Verbosity print_verbosity=Verbosity::V_HIGH, const Verbosity package_verbosity=Verbosity::V_LOW, const uint16_t interval=1000)
	Loom Manager constructor. More...

virtual	~LoomManager ()

OPERATION
void	begin_LED () const
	Begin LED. More...

void	begin_serial (const bool wait_for_monitor=false) const
	Begin Serial, optionally wait for user. More...

bool	parse_config (const char *json_config)
	Parse a JSON configuration string specifying enabled modules. More...

bool	parse_config_SD (const char *config_file)
	Parse a JSON configuration on SD card specifying enabled modules. More...

bool	parse_config_serial ()

bool	check_serial_for_config ()

bool	parse_config_json (JsonObject config)
	Parse a JSON configuration object specifying enabled modules. More...

void	get_config ()
	Get complete configuration of the device. More...

void	measure ()
	Measure data of all managed sensors. More...

void	package (JsonObject json)
	Package data of all modules into provide JsonObject. More...

void	record ()
	Measure and package data. More...

JsonObject	package ()
	Package data of all modules into JsonObject and return. More...

bool	publish_all (const JsonObject json)
	Publish. More...

bool	publish_all ()
	Publish. More...

bool	log_all (const JsonObject json)
	Log. More...

bool	log_all ()
	Log. More...

void	dispatch (JsonObject json)
	Iterate over list of commands, forwarding to handling module. More...

void	dispatch ()
	Iterate over list of commands, forwarding to handling module. More...

void	pause (const uint16_t ms) const
	Delay milliseconds. More...

void	pause () const
	Delay milliseconds based on interval member. More...

void	power_up ()
	Iterate over modules, calling power up method. More...

void	power_down ()
	Iterate over modules, calling power down method. More...

template<typename T >
bool	add_data (const char module, const char key, const T val)
	Append to a Json object of data. More...

template<typename T >
T	get_data_as (const char module, const char key)
	Get a data value from Json object of data. More...

bool	has_module (const LoomModule::Type type) const
	Save current configuration to SD. More...

PRINT INFORMATION
void	print_config (const bool print_modules_config=false)
	Print the devices current configuration. More...

void	list_modules () const
	Print the linked modules. More...

void	display_data () const
	Print out the internal JSON object. More...

ADD MODULE TO MANAGER
void	add_module (LoomModule *module)
	Add a module to be managed. More...

GETTERS
DeviceType	get_device_type () const
	Get device type. More...

JsonObject	internal_json (const bool clear=false)
	Return reference to internal json object. More...

void	get_device_name (char *buf) const
	Get the device name, copies into provided buffer. More...

const char *	get_device_name () const
	Get the device name. More...

uint8_t	get_instance_num () const
	Get device instance number. More...

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

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

uint16_t	get_interval () const
	Get sampling interval. More...

SETTERS
void	set_device_name (const char *device_name)
	Set the device name. More...

void	set_instance_num (const uint8_t n)
	Set device instance number. More...

void	set_print_verbosity (const Verbosity v, const bool set_modules=false)
	Set print verbosity. More...

void	set_package_verbosity (const Verbosity v, const bool set_modules=false)
	Set package verbosity. More...

void	set_interval (const uint16_t ms)
	Set default time to use for .pause() \ .delay(). More...

Protected Attributes
char	device_name [20]
	The name of the device. More...

uint8_t	instance
	The instance / channel ID within the subnet. More...

uint16_t	interval
	Default value for pause() Used so that manager can control interval, rather than code in .ino. More...

DeviceType	device_type
	Device type (Hub / Node) More...

Loom_WarmUp_Manager *	warmup_manager = nullptr

Loom_Interrupt_Manager *	interrupt_manager = nullptr

Loom_Sleep_Manager *	sleep_manager = nullptr

LoomRTC *	rtc_module = nullptr

std::vector< LoomModule * >	modules
	Vectors of LoomModule pointers. More...

Verbosity	print_verbosity
	Print detail verbosity. More...

Verbosity	package_verbosity
	Package detail verbosity. More...

StaticJsonDocument< 2000 >	doc
	Json data. More...

uint	packet_number = 1
	Packet number, incremented each time package is called. More...

MISCELLANEOUS
void	flash_LED (const uint8_t count, const uint8_t time_high, const uint8_t time_low, const bool end_high=false) const
	Flash the built in LED. More...

void	flash_LED (const uint8_t sequence[3]) const

static const char *	enum_device_type_string (const DeviceType t)
	Get c-string of name associated with device type enum. More...

MODULE ACCESS
class	Loom_Interrupt_Manager

class	Loom_Sleep_Manager

class	LoomRTC

class	Loom_SD

class	Loom_BatchSD

class	LoomNTPSync

LoomModule *	find_module (const LoomModule::Type type, const uint8_t idx=0) const
	Auxiliary function to search a list of modules for a module of specified type. More...

LoomModule *	find_module_by_category (const LoomModule::Category category, const uint8_t idx) const
	Auxiliary function to search a list of modules for a module of specified category. More...

Loom_WarmUp_Manager &	WarmUpManager (const uint8_t idx=0)

Loom_Sleep_Manager &	SleepManager (const uint8_t idx=0)

Loom_Interrupt_Manager &	InterruptManager (const uint8_t idx=0)

Loom_Multiplexer &	Multiplexer (const uint8_t idx=0)

LoomNTPSync &	NTP (const uint8_t idx=0)

LoomTempSync &	TempSync (const uint8_t idx=0)

Loom_LoRa &	LoRa (const uint8_t idx=0)

Loom_nRF &	nRF (const uint8_t idx=0)

Loom_Bluetooth &	Bluetooth (const uint8_t idx=0)

Loom_OLED &	OLED (const uint8_t idx=0)

Loom_SD &	SDCARD (const uint8_t idx=0)

Loom_BatchSD &	BATCHSD (const uint8_t idx=0)

LoomInternetPlat &	InternetPlat (const uint8_t idx=0)

Loom_Ethernet &	Ethernet (const uint8_t idx=0)

Loom_WiFi &	WiFi (const uint8_t idx=0)

Loom_LTE &	LTE (const uint8_t idx=0)

LoomPublishPlat &	PublishPlat (const uint8_t idx=0)

Loom_GoogleSheets &	GoogleSheets (const uint8_t idx=0)

Loom_SpoolPublish &	Spool (const uint8_t idx=0)

Loom_MaxPub &	MaxPub (const uint8_t idx=0)

Loom_MaxSub &	MaxSub (const uint8_t idx=0)

Loom_DS3231 &	DS3231 (const uint8_t idx=0)

Loom_PCF8523 &	PCF8523 (const uint8_t idx=0)

Loom_Neopixel &	Neopixel (const uint8_t idx=0)

Loom_Relay &	Relay (const uint8_t idx=0)

Loom_Servo &	Servo (const uint8_t idx=0)

Loom_Stepper &	Stepper (const uint8_t idx=0)

Loom_Analog &	Analog (const uint8_t idx=0)

Loom_Digital &	Digital (const uint8_t idx=0)

Loom_ADS1115 &	ADS1115 (const uint8_t idx=0)

Loom_AS7262 &	AS7262 (const uint8_t idx=0)

Loom_AS7263 &	AS7263 (const uint8_t idx=0)

Loom_AS7265X &	AS7265X (const uint8_t idx=0)

Loom_FXAS21002 &	FXAS21002 (const uint8_t idx=0)

Loom_FXOS8700 &	FXOS8700 (const uint8_t idx=0)

Loom_LIS3DH &	LIS3DH (const uint8_t idx=0)

Loom_MB1232 &	MB1232 (const uint8_t idx=0)

Loom_MMA8451 &	MMA8451 (const uint8_t idx=0)

Loom_MPU6050 &	MPU6050 (const uint8_t idx=0)

Loom_MS5803 &	MS5803 (const uint8_t idx=0)

Loom_SHT31D &	SHT31D (const uint8_t idx=0)

Loom_TMP007 &	TMP007 (const uint8_t idx=0)

Loom_TSL2561 &	TSL2561 (const uint8_t idx=0)

Loom_TSL2591 &	TSL2591 (const uint8_t idx=0)

Loom_ZXGesture &	ZXGesture (const uint8_t idx=0)

Loom_STEMMA &	STEMMA (const uint8_t idx=0)

Loom_Decagon5TM &	Decagon5TM (const uint8_t idx=0)

Loom_DecagonGS3 &	DecagonGS3 (const uint8_t idx=0)

Loom_MAX31855 &	MAX31855 (const uint8_t idx=0)

Loom_MAX31856 &	MAX31856 (const uint8_t idx=0)

Loom_K30 &	K30 (const uint8_t idx=0)

void	print_device_label () const
	Print the device name as '[device_name]'. More...

Detailed Description

Manager to contain Loom modules and provide users with a simpler API.

Resources

LoomManager Documentation

Member Enumeration Documentation

enum LoomManager::DeviceType

strong

Different general types of devices.

Enumerator
HUB	Central device.
NODE	Data collecting / actuating node.
REPEATER	Forwards messages between other devices.

Constructor & Destructor Documentation

LoomManager::LoomManager	(	const FactoryBase *	factory_ptr,
		const char *	device_name = `"Device"`,
		const uint8_t	instance = `1`,
		const DeviceType	device_type = `DeviceType::NODE`,
		const Verbosity	print_verbosity = `Verbosity::V_HIGH`,
		const Verbosity	package_verbosity = `Verbosity::V_LOW`,
		const uint16_t	interval = `1000`
	)

Loom Manager constructor.

Parameters

[in]	device_name	String \| <"Default"> \| null \| Manager name
[in]	instance	Int \| <1> \| [0-99] \| Device instance number on its subnet
[in]	device_type	Set(DeviceType) \| <1> \| {0("Hub"), 1("Node"), 2("Repeater")} \| Device's topological type
[in]	print_verbosity	Set(Verbosity) \| <1> \| {0("Off"), 1("Low"), 2("High")} \| How detailed prints to the Serial Monitor should be
[in]	package_verbosity	Set(Verbosity) \| <2> \| {0("Off"), 1("Low"), 2("High")} \| How detailed to package data
[in]	interval	Int \| <1> \| [0-60000] \| Default milliseconds to pause

LoomManager::~LoomManager ( )

virtual

Member Function Documentation

template<typename T >

bool LoomManager::add_data	(	const char *	module,
		const char *	key,
		const T	val
	)

inline

Append to a Json object of data.

If object is non-empty and contains non-data, will not add and will return false. Only call this after package, otherwise the data will be overriden

Parameters

[in]	module	Which module to add data to (will create if it doesn't exist)
[in]	key	Key of data to add
[in]	val	Value of data to add

Returns: True if success

void LoomManager::add_module ( LoomModule * module )

Add a module to be managed.

Loom_ADS1115 & LoomManager::ADS1115 ( const uint8_t idx = 0 )

Loom_Analog & LoomManager::Analog ( const uint8_t idx = 0 )

Loom_AS7262 & LoomManager::AS7262 ( const uint8_t idx = 0 )

Loom_AS7263 & LoomManager::AS7263 ( const uint8_t idx = 0 )

Loom_AS7265X & LoomManager::AS7265X ( const uint8_t idx = 0 )

Loom_BatchSD & LoomManager::BATCHSD ( const uint8_t idx = 0 )

void LoomManager::begin_LED ( ) const

inline

Begin LED.

void LoomManager::begin_serial ( const bool wait_for_monitor = false ) const

Begin Serial, optionally wait for user.

Parameters

[in] wait_for_monitor True to wait for serial monitor to open

Loom_Bluetooth & LoomManager::Bluetooth ( const uint8_t idx = 0 )

bool LoomManager::check_serial_for_config ( )

Loom_Decagon5TM & LoomManager::Decagon5TM ( const uint8_t idx = 0 )

Loom_DecagonGS3 & LoomManager::DecagonGS3 ( const uint8_t idx = 0 )

Loom_Digital & LoomManager::Digital ( const uint8_t idx = 0 )

void LoomManager::dispatch ( JsonObject json )

Iterate over list of commands, forwarding to handling module.

Parameters

[in] json Object containing commands

void LoomManager::dispatch ( )

inline

Iterate over list of commands, forwarding to handling module.

Uses internal json

void LoomManager::display_data ( ) const

Print out the internal JSON object.

Loom_DS3231 & LoomManager::DS3231 ( const uint8_t idx = 0 )

const char * LoomManager::enum_device_type_string ( const DeviceType t )

static

Get c-string of name associated with device type enum.

Returns: C-string of device type

Loom_Ethernet & LoomManager::Ethernet ( const uint8_t idx = 0 )

LoomModule * LoomManager::find_module	(	const LoomModule::Type	type,
		const uint8_t	idx = `0`
	)		const

Auxiliary function to search a list of modules for a module of specified type.

Parameters

[in] type Type to search for

LoomModule * LoomManager::find_module_by_category	(	const LoomModule::Category	category,
		const uint8_t	idx
	)		const

Auxiliary function to search a list of modules for a module of specified category.

Parameters

[in] category Category to search for

void LoomManager::flash_LED	(	const uint8_t	count,
		const uint8_t	time_high,
		const uint8_t	time_low,
		const bool	end_high = `false`
	)		const

Flash the built in LED.

Parameters

[in]	count	Number of times to flash
[in]	time_high	Milliseconds to stay on for
[in]	time_low	Milliseconds to stay off for

void LoomManager::flash_LED ( const uint8_t sequence[3] ) const

inline

Loom_FXAS21002 & LoomManager::FXAS21002 ( const uint8_t idx = 0 )

Loom_FXOS8700 & LoomManager::FXOS8700 ( const uint8_t idx = 0 )

void LoomManager::get_config ( )

Get complete configuration of the device.

Generally used to save configuration to SD

template<typename T >

T LoomManager::get_data_as	(	const char *	module,
		const char *	key
	)

inline

Get a data value from Json object of data.

Parameters

[in]	module	LoomModule key is associated with
[in]	key	Key of data value to find

Returns: Data value if found

void LoomManager::get_device_name ( char * buf ) const

Get the device name, copies into provided buffer.

Parameters

[out] buf The buffer copy device name into

const char * LoomManager::get_device_name ( ) const

Get the device name.

Returns: String literal of device name.

DeviceType LoomManager::get_device_type ( ) const

inline

Get device type.

Returns: Device type (Hub/Node)

uint8_t LoomManager::get_instance_num ( ) const

inline

Get device instance number.

Returns: Family number

uint16_t LoomManager::get_interval ( ) const

inline

Get sampling interval.

Returns: sampling interval, in ms

Verbosity LoomManager::get_package_verbosity ( ) const

inline

Get package verbosity.

Returns: package verbosity

Verbosity LoomManager::get_print_verbosity ( ) const

inline

Get print verbosity.

Returns: print verbosity

Loom_GoogleSheets & LoomManager::GoogleSheets ( const uint8_t idx = 0 )

bool LoomManager::has_module ( const LoomModule::Type type ) const

Save current configuration to SD.

Parameters

[in] config_file File to save configuration to

Returns: True is success, false if fail or file not found Determine if the manager has a module of the specified type

Parameters

[in] type Module type to check for

JsonObject LoomManager::internal_json ( const bool clear = false )

Return reference to internal json object.

Parameters

[in] clear Whether or not to empty Json before returning it

Returns: Reference to internal json object

LoomInternetPlat& LoomManager::InternetPlat ( const uint8_t idx = 0 )

Loom_Interrupt_Manager & LoomManager::InterruptManager ( const uint8_t idx = 0 )

Loom_K30 & LoomManager::K30 ( const uint8_t idx = 0 )

Loom_LIS3DH & LoomManager::LIS3DH ( const uint8_t idx = 0 )

void LoomManager::list_modules ( ) const

Print the linked modules.

bool LoomManager::log_all ( const JsonObject json )

Log.

Parameters

[in] json Data object to log

Returns: True if success

bool LoomManager::log_all ( )

inline

Log.

Calls log_all(const JsonObject json) with interal json

Returns: True if success

Loom_LoRa & LoomManager::LoRa ( const uint8_t idx = 0 )

Loom_LTE & LoomManager::LTE ( const uint8_t idx = 0 )

Loom_MAX31855 & LoomManager::MAX31855 ( const uint8_t idx = 0 )

Loom_MAX31856 & LoomManager::MAX31856 ( const uint8_t idx = 0 )

Loom_MaxPub & LoomManager::MaxPub ( const uint8_t idx = 0 )

Loom_MaxSub & LoomManager::MaxSub ( const uint8_t idx = 0 )

Loom_MB1232 & LoomManager::MB1232 ( const uint8_t idx = 0 )

void LoomManager::measure ( )

Measure data of all managed sensors.

Loom_MMA8451 & LoomManager::MMA8451 ( const uint8_t idx = 0 )

Loom_MPU6050 & LoomManager::MPU6050 ( const uint8_t idx = 0 )

Loom_MS5803 & LoomManager::MS5803 ( const uint8_t idx = 0 )

Loom_Multiplexer & LoomManager::Multiplexer ( const uint8_t idx = 0 )

Loom_Neopixel & LoomManager::Neopixel ( const uint8_t idx = 0 )

Loom_nRF & LoomManager::nRF ( const uint8_t idx = 0 )

LoomNTPSync & LoomManager::NTP ( const uint8_t idx = 0 )

Loom_OLED & LoomManager::OLED ( const uint8_t idx = 0 )

void LoomManager::package ( JsonObject json )

Package data of all modules into provide JsonObject.

How detailed data is can be modified with package_verbosity

Parameters

[out] json JsonObject of packaged data of enabled modules

JsonObject LoomManager::package ( )

Package data of all modules into JsonObject and return.

Returns: JsonObject of packaged data of enabled modules

bool LoomManager::parse_config ( const char * json_config )

Parse a JSON configuration string specifying enabled modules.

Enabled modules are instantiated with specified settings and added to manager lists for managing

Parameters

[in] json_config Configuration

Returns: True if success

bool LoomManager::parse_config_json ( JsonObject config )

Parse a JSON configuration object specifying enabled modules.

Enabled modules are instantiated with specified settings and added to manager lists for managing. Called by parse_config and parse_config_SD

Parameters

[in] json_config Configuration

Returns: True if success

bool LoomManager::parse_config_SD ( const char * config_file )

Parse a JSON configuration on SD card specifying enabled modules.

Enabled modules are instantiated with specified settings and added to manager lists for managing. Json should be on a single line in a .txt file.

Parameters

[in] json_config Configuration

Returns: True if success

bool LoomManager::parse_config_serial ( )

void LoomManager::pause ( const uint16_t ms ) const

inline

Delay milliseconds.

void LoomManager::pause ( ) const

inline

Delay milliseconds based on interval member.

Uses interval member as value

Loom_PCF8523 & LoomManager::PCF8523 ( const uint8_t idx = 0 )

void LoomManager::power_down ( )

Iterate over modules, calling power down method.

void LoomManager::power_up ( )

Iterate over modules, calling power up method.

void LoomManager::print_config ( const bool print_modules_config = false )

Print the devices current configuration.

Lists modules. Optionally also prints configuration of linked modules.

void LoomManager::print_device_label ( ) const

inlineprotected

Print the device name as '[device_name]'.

bool LoomManager::publish_all ( const JsonObject json )

Publish.

Parameters

[in] json Data object to publish

Returns: True if success

bool LoomManager::publish_all ( )

inline

Publish.

Calls publish_all(const JsonObject json) with interal json

Returns: True if success

LoomPublishPlat& LoomManager::PublishPlat ( const uint8_t idx = 0 )

void LoomManager::record ( )

inline

Measure and package data.

Convenience function, current just calls measure then package

Loom_Relay & LoomManager::Relay ( const uint8_t idx = 0 )

Loom_SD & LoomManager::SDCARD ( const uint8_t idx = 0 )

Loom_Servo & LoomManager::Servo ( const uint8_t idx = 0 )

void LoomManager::set_device_name ( const char * device_name )

Set the device name.

Parameters

[in] device_name The new device name

void LoomManager::set_instance_num ( const uint8_t n )

inline

Set device instance number.

Parameters

[in] n New instance number

void LoomManager::set_interval ( const uint16_t ms )

Set default time to use for .pause() \ .delay().

Pause and delay can still take explicit times, but if not provided, this value will be used

void LoomManager::set_package_verbosity	(	const Verbosity	v,
		const bool	set_modules = `false`
	)

Set package verbosity.

Parameters

[in]	v	New package verbosity
[in]	set_modules	Whether or not to also apply setting to modules

void LoomManager::set_print_verbosity	(	const Verbosity	v,
		const bool	set_modules = `false`
	)

Set print verbosity.

Parameters

[in]	v	New print verbosity
[in]	set_modules	Whether or not to also apply setting to modules

Loom_SHT31D & LoomManager::SHT31D ( const uint8_t idx = 0 )

Loom_Sleep_Manager & LoomManager::SleepManager ( const uint8_t idx = 0 )

Loom_SpoolPublish & LoomManager::Spool ( const uint8_t idx = 0 )

Loom_STEMMA & LoomManager::STEMMA ( const uint8_t idx = 0 )

Loom_Stepper & LoomManager::Stepper ( const uint8_t idx = 0 )

LoomTempSync & LoomManager::TempSync ( const uint8_t idx = 0 )

Loom_TMP007 & LoomManager::TMP007 ( const uint8_t idx = 0 )

Loom_TSL2561 & LoomManager::TSL2561 ( const uint8_t idx = 0 )

Loom_TSL2591 & LoomManager::TSL2591 ( const uint8_t idx = 0 )

Loom_WarmUp_Manager & LoomManager::WarmUpManager ( const uint8_t idx = 0 )

Loom_WiFi & LoomManager::WiFi ( const uint8_t idx = 0 )

Loom_ZXGesture & LoomManager::ZXGesture ( const uint8_t idx = 0 )

Friends And Related Function Documentation

friend class Loom_BatchSD

friend

friend class Loom_Interrupt_Manager

friend

friend class Loom_SD

friend

friend class Loom_Sleep_Manager

friend

friend class LoomNTPSync

friend

friend class LoomRTC

friend

Member Data Documentation

char LoomManager::device_name[20]

protected

The name of the device.

DeviceType LoomManager::device_type

protected

Device type (Hub / Node)

StaticJsonDocument<2000> LoomManager::doc

protected

Json data.

uint8_t LoomManager::instance

protected

The instance / channel ID within the subnet.

Loom_Interrupt_Manager* LoomManager::interrupt_manager = nullptr

protected

uint16_t LoomManager::interval

protected

Default value for pause() Used so that manager can control interval, rather than code in .ino.

std::vector<LoomModule*> LoomManager::modules

protected

Vectors of LoomModule pointers.

Verbosity LoomManager::package_verbosity

protected

Package detail verbosity.

uint LoomManager::packet_number = 1

protected

Packet number, incremented each time package is called.

Verbosity LoomManager::print_verbosity

protected

Print detail verbosity.

LoomRTC* LoomManager::rtc_module = nullptr

protected

Loom_Sleep_Manager* LoomManager::sleep_manager = nullptr

protected

Loom_WarmUp_Manager* LoomManager::warmup_manager = nullptr

protected

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

Public Types

Public Member Functions

Protected Attributes

MISCELLANEOUS

MODULE ACCESS

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation