Abstract root of Loom component modules inheritance hierarchy. More...

#include <Module.h>

Inheritance diagram for LoomModule:

[legend]

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

OPERATION
virtual void	package (JsonObject json)=0
	Package a modules measurements or state. 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...

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

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

Static Public Member Functions
MISCELLANEOUS
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 Attributes
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
	Display the configuration settings of the module. More...

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

void	print_module_label () const
	Print the module name as a label. More...

Detailed Description

Abstract root of Loom component modules inheritance hierarchy.

All modules in Loom inherit from LoomModule

Resources

LoomModule Documentation

Member Enumeration Documentation

enum LoomModule::Category

strong

Enum to classify modules.

Similar LoomModule::Type but represents the astract classes rather than the leaf node modules in the inheritance tree. For a given module, its category often shares a name with the abstract class it is derived from

Enumerator
Unknown	Unknown.
Other	Other.
Sensor	Sensors.
L_RTC	RTC.
Actuator	Actuators.
LogPlat	LogPlats.
CommPlat	CommPlats.
InternetPlat	InternetPlats.
PublishPlat	PublishPlats.
SubscribePlat	SubscribePlats.

enum LoomModule::Type

strong

Enum to check against to when finding individual component managed by a LoomManager.

Used because we cannot use dynamic_cast to check type of modules (rtti disabled by Arduino IDE)

Enumerator
Unknown
Other
Interrupt_Manager
Sleep_Manager
Multiplexer
NTP
TempSync
WarmUp_Manager
Sensor
Analog
Digital
I2C
ADS1115
AS7262
AS7263
AS7265X
FXAS21002
FXOS8700
LIS3DH
MB1232
MMA8451
MPU6050
MS5803
SHT31D
TMP007
TSL2561
TSL2591
ZXGesture
STEMMA
SDI12
Decagon5TM
DecagonGS3
SPI
MAX31855
MAX31856
L_SERIAL
K30
L_RTC
DS3231
PCF8523
Actuator
Neopixel
Relay
Servo
Stepper
LogPlat
OLED
SDCARD
BATCHSD
CommPlat
LoRa
nRF
Bluetooth
InternetPlat
Ethernet
WiFi
LTE
PublishPlat
GoogleSheets
MaxPub
SpoolPub
SubscribePlats
MaxSub

Constructor & Destructor Documentation

LoomModule::LoomModule	(	LoomManager *	manager,
		const char *	module_name = `"Unknown"`,
		const Type	module_type = `Type::Unknown`
	)

Constructor.

Parameters

[in]	module_name	Name of the module (provided by derived classes)
[in]	module_type	Type of the module (provided by derived classes)

virtual LoomModule::~LoomModule ( )

virtualdefault

Destructor.

Member Function Documentation

virtual void LoomModule::add_config ( JsonObject json )

inlinevirtual

Add configuration information to JsonObject.

LoomManager iterates over modules to build complete configuration

Parameters

[in] json Json configuration object to add to

Reimplemented in Loom_Analog, Loom_LoRa, Loom_nRF, Loom_Digital, Loom_Bluetooth, Loom_Stepper, Loom_Neopixel, Loom_Servo, and Loom_Relay.

LoomModule::Category LoomModule::category ( ) const

Get the category of the module.

virtual bool LoomModule::dispatch ( JsonObject json )

inlinevirtual

Route command to driver.

Reimplemented in Loom_Multiplexer, Loom_Stepper, Loom_Neopixel, Loom_Servo, LoomNTPSync, Loom_MaxPub, and Loom_Relay.

const char * LoomModule::enum_category_string ( const Category c )

static

Get string of the category associated with a Category.

Parameters

[in] c Category value to get string representation of

Returns: String of category

const char * LoomModule::enum_verbosity_string ( const Verbosity v )

static

Get string of name associated with verbosity enum.

Parameters

[in] v Verbosity value to get string representation of

Returns: String of verbosity

bool LoomModule::get_active ( ) const

inline

Get whether or not the module should be treated as active.

Returns: Whether or not the module is active

LoomManager* LoomModule::get_device_manager ( ) const

inline

Get the device manager class if linked.

Returns: Pointer to the LoomManager, Null if not linked

void LoomModule::get_module_name ( char * buf ) const

Copy module name into buffer.

Parameters

[out] buf The buffer to copy module name into

const char* LoomModule::get_module_name ( ) const

inline

Get module name.

Returns: Module name

Type LoomModule::get_module_type ( ) const

inline

Get module type.

Returns: Module type

Verbosity LoomModule::get_package_verbosity ( ) const

inline

Get package verbosity.

Returns: The current verbosity setting

Verbosity LoomModule::get_print_verbosity ( ) const

inline

Get print verbosity.

Returns: The current verbosity setting

void LoomModule::link_device_manager ( LoomManager * LM )

virtual

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 in Loom_Interrupt_Manager, LoomRTC, Loom_SD, and Loom_Sleep_Manager.

virtual void LoomModule::package ( JsonObject json )

pure virtual

Package a modules measurements or state.

Parameters

[out] json Object to put data into

Implemented in Loom_Interrupt_Manager, Loom_Analog, Loom_Multiplexer, LoomCommPlat, LoomInternetPlat, Loom_ADS1115, LoomRTC, Loom_BatchSD, Loom_WiFi, Loom_MPU6050, Loom_Sleep_Manager, Loom_Digital, Loom_AS7265X, Loom_AS7263, Loom_AS7262, Loom_ZXGesture, Loom_TSL2591, Loom_K30, Loom_TSL2561, Loom_MAX31856, Loom_MS5803, Loom_MMA8451, LoomTempSync, LoomPublishPlat, Loom_LIS3DH, Loom_FXOS8700, Loom_MaxSub, Loom_FXAS21002, Loom_SHT31D, Loom_TMP007, Loom_MAX31855, Loom_Servo, LoomNTPSync, LoomLogPlat, Loom_MB1232, Loom_Relay, Loom_DecagonGS3, Loom_Decagon5TM, Loom_STEMMA, LoomActuator, and Loom_WarmUp_Manager.

virtual void LoomModule::power_down ( )

inlinevirtual

Turn off any hardware.

Reimplemented in Loom_Multiplexer, Loom_LoRa, Loom_SD, Loom_LTE, and Loom_BatchSD.

virtual void LoomModule::power_up ( )

inlinevirtual

Turn on any hardware.

Reimplemented in Loom_Multiplexer, Loom_LoRa, Loom_SD, Loom_LTE, and Loom_BatchSD.

void LoomModule::print_config ( ) const

virtual

Display the configuration settings of the module.

Reimplemented in Loom_Interrupt_Manager, LoomCommPlat, Loom_Multiplexer, LoomRTC, Loom_Analog, Loom_LoRa, Loom_SD, Loom_OLED, Loom_nRF, Loom_Bluetooth, Loom_LTE, Loom_ADS1115, Loom_BatchSD, Loom_Sleep_Manager, Loom_WiFi, LoomPublishPlat, Loom_Digital, Loom_Ethernet, Loom_AS7263, Loom_AS7262, Loom_ZXGesture, LoomSubscribePlat, Loom_Neopixel, Loom_MMA8451, Loom_MaxSub, LoomTempSync, LoomLogPlat, Loom_PCF8523, LoomNTPSync, Loom_MaxPub, LoomI2CSensor, Loom_DS3231, Loom_GoogleSheets, LoomSensor, Loom_DecagonGS3, Loom_Decagon5TM, and LoomSerialSensor.

void LoomModule::print_module_label ( ) const

protected

Print the module name as a label.

Used for matching debug prints to corresponding module

void LoomModule::print_state ( ) const

virtual

Display current state of the module.

Reimplemented in Loom_Interrupt_Manager, LoomCommPlat, Loom_Multiplexer, LoomRTC, Loom_LTE, Loom_WiFi, Loom_MPU6050, Loom_Ethernet, LoomPublishPlat, LoomSubscribePlat, Loom_Neopixel, Loom_Stepper, Loom_Servo, LoomNTPSync, and Loom_Relay.

virtual void LoomModule::second_stage_ctor ( )

inlinevirtual

Second stage construction.

Perform any actions that need all of the devices to be initized beforehand - such as looking up an internet platform This function is guranteed to be called AFTER all modules have been constructed.

Reimplemented in LoomSubscribePlat, LoomPublishPlat, LoomTempSync, Loom_MaxSub, Loom_MaxPub, and LoomNTPSync.

void LoomModule::set_active ( const bool enable )

inline

Set whether or not the module should be treated as active.

Parameters

[in] enable Whether or not to enable module

void LoomModule::set_package_verbosity ( const Verbosity v )

Set package verbosity.

Controlls level of detail included in bundles

Parameters

[in] v The verbosity setting

void LoomModule::set_print_verbosity ( const Verbosity v )

Set print verbosity Controlls level of detail included in debug prints.

Member Data Documentation

bool LoomModule::active

protected

Whether or not the module should be treated as active.

If inactive at setup (due to failed initialization, module will be deleted)

LoomManager* LoomModule::device_manager

protected

Pointer to manager.

LoomManager provides to any modules passed to add_module

const char* LoomModule::module_name

protected

const String LoomModule::module_name_base

protected

The name of the module (Should have a DEFAULT but can be overriden if provided to constructor)

const Type LoomModule::module_type

protected

Module type.

Verbosity LoomModule::package_verbosity

protected

Package verbosity.

Verbosity LoomModule::print_verbosity

protected

Print verbosity.

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

src/Module.h
src/Module.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

PRINT INFORMATION

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation