Submanager to manage sleep functionality. More...

#include <Sleep_Manager.h>

Inheritance diagram for Loom_Sleep_Manager:

Public Types
enum	Mode { Mode::IDLE, Mode::STANDBY, Mode::OPENS_LOWPOWER }
	Different options available to sleep in. More...

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

Public Member Functions
CONSTRUCTORS / DESTRUCTOR
	Loom_Sleep_Manager (LoomManager *manager, const bool use_LED=true, const bool delay_on_wake=false, const Mode sleep_mode=Mode::STANDBY, const byte power_off_pin=A5)
	Sleep Manager module constructor. More...

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

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

OPERATION
void	package (JsonObject json) override
	No package necessary. More...

bool	sleep ()
	Put into low power state. More...

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

GETTERS
Mode	get_sleep_mode () const
	Get the current sleep mode. More...

SETTERS
void	link_interrupt_manager (Loom_Interrupt_Manager *IM)
	Set pointer to interrupt manager. More...

void	set_sleep_mode (const Mode mode)
	Set the sleep mode to use. 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...

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_state () const
	Display current state of the module. More...

Protected Attributes
Loom_Interrupt_Manager *	interrupt_manager
	Pointer to interrupt_manager instance. More...

bool	use_LED
	Whether or not to use LED to indicate wake status. More...

bool	delay_on_wake
	Whether to provide delay on wake. More...

Mode	sleep_mode
	Which sleep mode to use. More...

byte	power_off_pin
	Which pin to use to power board off (requires power board) 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...

MISCELLANEOUS
void	link_device_manager (LoomManager *LM) override
	Add pointer back to device manager. More...

static const char *	enum_sleep_mode_string (const Mode m)
	Convert enum of sleep mode to a c-string. More...

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

Detailed Description

Submanager to manage sleep functionality.

Resources

Documentation

Member Enumeration Documentation

enum Loom_Sleep_Manager::Mode

strong

Different options available to sleep in.

Enumerator
IDLE	Idle.
STANDBY	Standby.
OPENS_LOWPOWER	OPEnS board to shut board off completely.

Constructor & Destructor Documentation

Loom_Sleep_Manager::Loom_Sleep_Manager	(	LoomManager *	manager,
		const bool	use_LED = `true`,
		const bool	delay_on_wake = `false`,
		const Mode	sleep_mode = `Mode::STANDBY`,
		const byte	power_off_pin = `A5`
	)

Sleep Manager module constructor.

Parameters

[in]	use_LED	Bool \| <true> \| {true, false} \| Whether or not to use LED to indicate wake state
[in]	delay_on_wake	Bool \| <false> \| {true, false} \| Whether or not to delay upon waking to allow time to open Serial Monitor
[in]	sleep_mode	Set(Mode) \| <1> \| { 0("Idle"), 1("Standby"), 2("Opens Low Power")} \| Which Mode to use
[in]	power_off_pin	Set(Int) \| <10> \| {5, 6, 9, 10, 11, 12, 13, 14("A0"), 15("A1"), 16("A2"), 17("A3"), 18("A4"), 19("A5")} \| Which pin should be used to power off board

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

Loom_Sleep_Manager::~Loom_Sleep_Manager ( )

default

Destructor.

Member Function Documentation

const char * Loom_Sleep_Manager::enum_sleep_mode_string ( const Mode m )

static

Convert enum of sleep mode to a c-string.

Parameters

[in] m Sleep to get string of

Returns: C-string of sleep mode

Mode Loom_Sleep_Manager::get_sleep_mode ( ) const

inline

Get the current sleep mode.

Returns: The current sleep mode

void Loom_Sleep_Manager::link_device_manager ( LoomManager * LM )

overridevirtual

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

void Loom_Sleep_Manager::link_interrupt_manager ( Loom_Interrupt_Manager * IM )

inline

Set pointer to interrupt manager.

Parameters

[in] IM Pointer to an interrupt manager

void Loom_Sleep_Manager::package ( JsonObject json )

inlineoverridevirtual

No package necessary.

Implement with empty body.

Implements LoomModule.

void Loom_Sleep_Manager::print_config ( ) const

overridevirtual

Display the configuration settings of the module.

Reimplemented from LoomModule.

void Loom_Sleep_Manager::set_sleep_mode ( const Mode mode )

inline

Set the sleep mode to use.

Parameters

[in] mode The Mode to set to

bool Loom_Sleep_Manager::sleep ( )

Put into low power state.

On wake, program will continue from where it went to sleep

Returns: Whether or not sleep was successful

Member Data Documentation

bool Loom_Sleep_Manager::delay_on_wake

protected

Whether to provide delay on wake.

Used to allow user to restart Serial Monitor

Loom_Interrupt_Manager* Loom_Sleep_Manager::interrupt_manager

protected

Pointer to interrupt_manager instance.

byte Loom_Sleep_Manager::power_off_pin

protected

Which pin to use to power board off (requires power board)

Mode Loom_Sleep_Manager::sleep_mode

protected

Which sleep mode to use.

bool Loom_Sleep_Manager::use_LED

protected

Whether or not to use LED to indicate wake status.

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

src/Sleep_Manager.h
src/Sleep_Manager.cpp

Public Types

Public Member Functions

Protected Attributes

MISCELLANEOUS

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation