Loom
Public Member Functions | List of all members
Loom_WarmUp_Manager Class Reference

#include <WarmUp_Manager.h>

Inheritance diagram for Loom_WarmUp_Manager:
Inheritance graph
[legend]

Public Member Functions

 Loom_WarmUp_Manager (LoomManager *manager)
 Constructor. More...
 
 Loom_WarmUp_Manager (LoomManager *manager, JsonArrayConst)
 
template<typename T >
void Register_WarmUp (T t)
 Registers a module as a WarmUp Interface providing access;. More...
 
void warming_Begin ()
 Start a warming timer. More...
 
void warming_Reset ()
 Reset warming to false, indicates a need to reheat in the near future. More...
 
bool is_warm ()
 Updates and returns state. More...
 
void package (JsonObject)
 An unfortunate consequence of inheriting from a bloated base class. 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...
 
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...
 
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...
 

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

Constructor & Destructor Documentation

Loom_WarmUp_Manager::Loom_WarmUp_Manager ( LoomManager *  manager)

Constructor.

Loom_WarmUp_Manager::Loom_WarmUp_Manager ( LoomManager *  manager,
JsonArrayConst   
)

Member Function Documentation

bool Loom_WarmUp_Manager::is_warm ( )

Updates and returns state.

void Loom_WarmUp_Manager::package ( JsonObject  )
inlinevirtual

An unfortunate consequence of inheriting from a bloated base class.

Implements LoomModule.

template<typename T >
void Loom_WarmUp_Manager::Register_WarmUp ( T  t)
inline

Registers a module as a WarmUp Interface providing access;.

void Loom_WarmUp_Manager::warming_Begin ( )

Start a warming timer.

void Loom_WarmUp_Manager::warming_Reset ( )

Reset warming to false, indicates a need to reheat in the near future.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.11