Submanager for managing interrupts, timers, and stopwatches. More...

#include <Interrupt_Manager.h>

Inheritance diagram for Loom_Interrupt_Manager:

Public Member Functions
CONSTRUCTORS / DESTRUCTOR
	Loom_Interrupt_Manager (LoomManager manager, LoomRTC RTC_Inst=nullptr)
	Interrupt Manager module constructor. More...

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

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

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

void	run_pending_ISRs ()
	Run any waiting ISRs. More...

EXTERNAL INTERRUPT METHODS
void	register_ISR (const uint32_t pin, ISRFuncPtr ISR, const uint32_t signal_type, ISR_Type run_type)
	Register an ISR to an interrupt pin and its configuration. More...

bool	reconnect_interrupt (const uint32_t pin)
	If an ISR dettaches interrupt, use this to reattach according to previous settings. More...

void	unregister_ISR (const uint32_t pin, const uint32_t signal_type=LOW)
	Restores pin to default ISR, disables interrupt. More...

void	interrupt_reset (const uint32_t pin)
	Detaches then reattacheds interrupt according to settings. More...

RTC ALARM METHODS
bool	RTC_alarm_duration (const TimeSpan duration)
	Set RTC alarm an amount of time from now. More...

bool	RTC_alarm_duration (const uint8_t days, const uint8_t hours, const uint8_t minutes, const uint8_t seconds)
	Set RTC alarm an amount of time from now. More...

bool	RTC_alarm_at (DateTime future_time)
	Set RTC alarm for a specific time. More...

bool	RTC_alarm_at (const uint8_t hour, const uint8_t minute, const uint8_t second)
	Set RTC alarm for a specific time. More...

bool	RTC_alarm_duration_from_last (const TimeSpan duration)
	Set RTC alarm an amount of time from last alarm time. More...

bool	RTC_alarm_duration_from_last (const uint8_t days, const uint8_t hours, const uint8_t minutes, const uint8_t seconds)
	Set RTC alarm an amount of time from last alarm time. More...

ASYNCDELAY TIMER METHODS
void	check_timers ()
	Check if timers have elapsed, if so run associated 'ISR'. More...

void	register_timer (const uint8_t timer_num, const unsigned long duration, const ISRFuncPtr ISR, const bool repeat)
	Configure specified timer. More...

void	clear_timer (const uint8_t timer_num)
	Clear specified timer. More...

INTERNAL TIMER METHODS
void	register_internal_timer (const uint duration, const ISRFuncPtr ISR, const bool repeat, const ISR_Type run_type)
	Configure internal timer. More...

bool	run_pending_internal_timer_ISR ()
	Run a delayed (flag based) ISR if the interal timer elapsed. More...

bool	get_internal_timer_flag () const
	Get whether the internal timer has elapsed. More...

void	clear_internal_timer_flag () const
	Clear internal timer flag. More...

void	internal_timer_enable (const bool enable)
	Enable or disable internal timer. More...

void	unregister_internal_timer ()
	Clear and disable internal timer, remove ISR. More...

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

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

GETTERS
bool	get_interrupts_enabled () const
	Get global interrupt enable state. More...

bool	get_enable_interrupt (const uint32_t pin) const
	Get pin interrupt enable state. More...

LoomRTC *	get_RTC_module () const
	Return pointer to the currently linked RTC object. More...

SETTERS
void	link_device_manager (LoomManager *LM) override
	Link a device manager. More...

void	link_sleep_manager (Loom_Sleep_Manager *SM)
	Set pointer to sleep Manager. More...

void	set_interrupts_enabled (const bool state)
	All interrupts enable/disable. More...

void	set_enable_interrupt (const uint32_t pin, const bool state)
	Per interrupt enable. More...

void	set_RTC_module (LoomRTC *RTC_Inst)
	Set the RTC module to use for timers. 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...

Protected Attributes
LoomRTC *	RTC_Inst
	Pointer to an RTC object for managing timers / timed interrupts. More...

Loom_Sleep_Manager *	Sleep_Manager
	Pointer to a Sleep Manager object. More...

IntDetails	int_settings [InteruptRange]
	List of interrupts configurations. More...

uint8_t	int_count = 0

bool	interrupts_enabled
	Enable or disable all interrupts – currently only disables bottom halves. More...

InternalTimerDetails	internal_timer

DateTime	last_alarm_time
	Last time an alarm went off. More...

AsyncDelay	timers [MaxTimerCount]

TimerDetails	timer_settings [MaxTimerCount]

StopWatchDetails	stopwatch_settings [MaxStopWatchCount]

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

Static Protected Attributes
static bool	interrupt_triggered [InteruptRange] = {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}
	Flags set by interrupts, indicating ISR bottom half should be called if not Null. More...

MISCELLANEOUS
uint32_t	pin_to_interrupt (uint32_t pin)

static const char *	interrupt_type_to_string (const uint8_t type)
	Get c-string of name associated with interrupt type enum. 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...

Detailed Description

Submanager for managing interrupts, timers, and stopwatches.

Resources

Documentation

Constructor & Destructor Documentation

Loom_Interrupt_Manager::Loom_Interrupt_Manager	(	LoomManager *	manager,
		LoomRTC *	RTC_Inst = `nullptr`
	)

Interrupt Manager module constructor.

Parameters

[in] RTC_Inst Set(Int) | <0> | {0("Null")} | OLED module name

Loom_Interrupt_Manager::Loom_Interrupt_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_Interrupt_Manager::~Loom_Interrupt_Manager ( )

default

Destructor.

Member Function Documentation

void Loom_Interrupt_Manager::check_timers ( )

Check if timers have elapsed, if so run associated 'ISR'.

void Loom_Interrupt_Manager::clear_internal_timer_flag ( ) const

inline

Clear internal timer flag.

void Loom_Interrupt_Manager::clear_timer ( const uint8_t timer_num )

Clear specified timer.

Parameters

[in] timer_num Timer to clear

bool Loom_Interrupt_Manager::get_enable_interrupt ( const uint32_t pin ) const

inline

Get pin interrupt enable state.

Parameters

[in] pin Pin to the the enable state of

Returns: The enable state

bool Loom_Interrupt_Manager::get_internal_timer_flag ( ) const

inline

Get whether the internal timer has elapsed.

Returns: True if timer elapsed, false otherwise

bool Loom_Interrupt_Manager::get_interrupts_enabled ( ) const

inline

Get global interrupt enable state.

Returns: Global interrupt enable state

LoomRTC* Loom_Interrupt_Manager::get_RTC_module ( ) const

inline

Return pointer to the currently linked RTC object.

Returns: Current RTC object

void Loom_Interrupt_Manager::internal_timer_enable ( const bool enable )

Enable or disable internal timer.

Disabling does not remove settings, use unregister_interal_timer for that behavior

Parameters

[in] enable True to enable timer, false to disable

void Loom_Interrupt_Manager::interrupt_reset ( const uint32_t pin )

Detaches then reattacheds interrupt according to settings.

used to clear pending interrupts

Parameters

[in] pin Pin to reset interrupts for ...

const char * Loom_Interrupt_Manager::interrupt_type_to_string ( const uint8_t type )

static

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

Parameters

[in] type Interrupt type

Returns: C-string of interrupt type

void Loom_Interrupt_Manager::link_device_manager ( LoomManager * LM )

overridevirtual

Link a device manager.

Overrides default by getting RTC pointer from device manager if possible

Parameters

[in] LM Manager to link

Reimplemented from LoomModule.

void Loom_Interrupt_Manager::link_sleep_manager ( Loom_Sleep_Manager * SM )

Set pointer to sleep Manager.

Parameters

[in] SM Pointer to sleep manager

void Loom_Interrupt_Manager::package ( JsonObject json )

inlineoverridevirtual

No package necessary.

Implement with empty body.

Implements LoomModule.

uint32_t Loom_Interrupt_Manager::pin_to_interrupt ( uint32_t pin )

void Loom_Interrupt_Manager::print_config ( ) const

overridevirtual

Display the configuration settings of the module.

Reimplemented from LoomModule.

void Loom_Interrupt_Manager::print_state ( ) const

overridevirtual

Display current state of the module.

Reimplemented from LoomModule.

bool Loom_Interrupt_Manager::reconnect_interrupt ( const uint32_t pin )

If an ISR dettaches interrupt, use this to reattach according to previous settings.

Effectively to running register_ISR with previous settings

Parameters

[in] pin Which pin to reconnect the interrupt on

void Loom_Interrupt_Manager::register_internal_timer	(	const uint	duration,
		const ISRFuncPtr	ISR,
		const bool	repeat,
		const ISR_Type	run_type
	)

Configure internal timer.

Parameters

[in]	duration	How long timer should take (seconds)
[in]	ISR	ISR to run after timer goes off
[in]	repeat	Whether or not to be a repeating alarm
[in]	run_type	Whether the interrupt runs immediately, else sets flag to check and runs ISR when flag checked

void Loom_Interrupt_Manager::register_ISR	(	const uint32_t	pin,
		ISRFuncPtr	ISR,
		const uint32_t	signal_type,
		ISR_Type	run_type
	)

Register an ISR to an interrupt pin and its configuration.

Parameters

[in]	pin	Which pin to connect the interrupt on
[in]	ISR	ISR function (Null if no interrupt linked)
[in]	signal_type	Low, High, Change, Falling, Rising
[in]	run_type	Whether the interrupt runs immediately, else sets flag to check and runs ISR when flag checked

void Loom_Interrupt_Manager::register_timer	(	const uint8_t	timer_num,
		const unsigned long	duration,
		const ISRFuncPtr	ISR,
		const bool	repeat
	)

Configure specified timer.

Parameters

[in]	timer_num	Timer to set
[in]	duration	How long timer should take (seconds)
[in]	ISR	ISR to run after timer goes off
[in]	repeat	Whether or not to be a repeating alarm

bool Loom_Interrupt_Manager::RTC_alarm_at ( DateTime future_time )

Set RTC alarm for a specific time.

Increments to next day at given hour, min, sec if specified time is in past

Parameters

[in] future_time Time to set alarm for

bool Loom_Interrupt_Manager::RTC_alarm_at	(	const uint8_t	hour,
		const uint8_t	minute,
		const uint8_t	second
	)

Set RTC alarm for a specific time.

Forwards to RTC_alarm_at that takes DateTime object

Parameters

[in]	hour	Hour to set alarm for
[in]	minute	Minute to set alarm for
[in]	second	Second to set alarm for

bool Loom_Interrupt_Manager::RTC_alarm_duration ( const TimeSpan duration )

Set RTC alarm an amount of time from now.

Parameters

[in] duration How long before the alarm should go off

bool Loom_Interrupt_Manager::RTC_alarm_duration	(	const uint8_t	days,
		const uint8_t	hours,
		const uint8_t	minutes,
		const uint8_t	seconds
	)

Set RTC alarm an amount of time from now.

Parameters

[in]	days	Days into the future the alarm should be set
[in]	hours	Hours into the future the alarm should be set
[in]	minutes	Minutes into the future the alarm should be set
[in]	seconds	Seconds into the future the alarm should be set

bool Loom_Interrupt_Manager::RTC_alarm_duration_from_last ( const TimeSpan duration )

Set RTC alarm an amount of time from last alarm time.

Parameters

[in] duration How long before the alarm should go off

bool Loom_Interrupt_Manager::RTC_alarm_duration_from_last	(	const uint8_t	days,
		const uint8_t	hours,
		const uint8_t	minutes,
		const uint8_t	seconds
	)

Set RTC alarm an amount of time from last alarm time.

Parameters

[in]	days	Days into the future the alarm should be set
[in]	hours	Hours into the future the alarm should be set
[in]	minutes	Minutes into the future the alarm should be set
[in]	seconds	Seconds into the future the alarm should be set

bool Loom_Interrupt_Manager::run_pending_internal_timer_ISR ( )

Run a delayed (flag based) ISR if the interal timer elapsed.

Is not needed if using ISR_Type::IMMEDIATE ISR

Returns: True if flag was set and ISR run

void Loom_Interrupt_Manager::run_pending_ISRs ( )

Run any waiting ISRs.

Flag was set by a top half ISR

void Loom_Interrupt_Manager::set_enable_interrupt	(	const uint32_t	pin,
		const bool	state
	)

Per interrupt enable.

Parameters

[in]	pin	Interrupt pin to change enable state of
[in]	state	The enable state to set pin to

void Loom_Interrupt_Manager::set_interrupts_enabled ( const bool state )

inline

All interrupts enable/disable.

Parameters

[in] state Enable state to apply to all interrupts

void Loom_Interrupt_Manager::set_RTC_module ( LoomRTC * RTC_Inst )

inline

Set the RTC module to use for timers.

Parameters

[in] RTC_Inst Pointer to the RTC object

void Loom_Interrupt_Manager::unregister_internal_timer ( )

Clear and disable internal timer, remove ISR.

void Loom_Interrupt_Manager::unregister_ISR	(	const uint32_t	pin,
		const uint32_t	signal_type = `LOW`
	)

Restores pin to default ISR, disables interrupt.

Parameters

[in]	pin	The pin to unregister ISRs for
[in]	signal_type	What signal to configure default ISR to (default LOW)

Member Data Documentation

uint8_t Loom_Interrupt_Manager::int_count = 0

protected

IntDetails Loom_Interrupt_Manager::int_settings[InteruptRange]

protected

List of interrupts configurations.

InternalTimerDetails Loom_Interrupt_Manager::internal_timer

protected

bool Loom_Interrupt_Manager::interrupt_triggered = {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}

staticprotected

Flags set by interrupts, indicating ISR bottom half should be called if not Null.

bool Loom_Interrupt_Manager::interrupts_enabled

protected

Enable or disable all interrupts – currently only disables bottom halves.

DateTime Loom_Interrupt_Manager::last_alarm_time

protected

Last time an alarm went off.

LoomRTC* Loom_Interrupt_Manager::RTC_Inst

protected

Pointer to an RTC object for managing timers / timed interrupts.

Loom_Sleep_Manager* Loom_Interrupt_Manager::Sleep_Manager

protected

Pointer to a Sleep Manager object.

StopWatchDetails Loom_Interrupt_Manager::stopwatch_settings[MaxStopWatchCount]

protected

TimerDetails Loom_Interrupt_Manager::timer_settings[MaxTimerCount]

protected

AsyncDelay Loom_Interrupt_Manager::timers[MaxTimerCount]

protected

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

src/Interrupt_Manager.h
src/Interrupt_Manager.cpp

Public Member Functions

Protected Attributes

Static Protected Attributes

MISCELLANEOUS

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation