GpioEventManager Class Reference

GpioEventManager registers interrupts and posts GpioChange events to multiple listeners per pin. More...

#include <GpioEventManager.h>

Collaboration diagram for GpioEventManager:

Public Types
using	GpioCallback = std::function< void(const GpioEvent &)>
	Initialize the GPIO event manager.

Public Member Functions
void	enableInterrupt (uint pin, uint32_t edgeMask)
	Enable GPIO interrupts for a specific pin and edge mask.
void	disableInterrupt (uint pin)
	Disable GPIO interrupts for a specific pin.
void	registerCallback (uint pin, GpioCallback cb)
	Register a callback for GPIO events on a specific pin.
void	unregisterAll (uint pin)
	Unregister listeners for a GPIO pin.

Static Public Member Functions
static GpioEventManager &	getInstance ()
	Get the singleton instance of GpioEventManager.

Private Member Functions
	GpioEventManager ()=default

Static Private Member Functions
static void	gpio_event_handler (uint gpio, uint32_t events)

Private Attributes
bool	handler_set = false

Static Private Attributes
static std::map< uint, std::vector< GpioCallback > >	listeners

Detailed Description

Definition at line 21 of file GpioEventManager.h.

Member Typedef Documentation

GpioCallback

using GpioEventManager::GpioCallback = std::function<void(const GpioEvent &)>

This declares the callback used by the pico sdk when an interrupt occurs.

Definition at line 37 of file GpioEventManager.h.

Constructor & Destructor Documentation

GpioEventManager()

GpioEventManager::GpioEventManager ( )

privatedefault

Member Function Documentation

disableInterrupt()

void GpioEventManager::disableInterrupt

(

uint

pin

)

This unregisters the pin from the pico SDK and stops listening for events.

Parameters

pin	The GPIO pin number to disable interrupts for.

Definition at line 23 of file GpioEventManager.cpp.

                                                {
    gpio_set_irq_enabled(pin, GPIO_IRQ_EDGE_RISE | GPIO_IRQ_EDGE_FALL, false);
    listeners.erase(pin);
}

References listeners.

enableInterrupt()

void GpioEventManager::enableInterrupt	(	uint	pin,
		uint32_t	edgeMask
	)

This registers the pin with the pico SDK and sets up the interrupt handler.

Parameters

pin	The GPIO pin number to enable interrupts for.
edgeMask	Bitmask of edges to listen for (GPIO_IRQ_EDGE_RISE, GPIO_IRQ_EDGE_FALL).

Definition at line 15 of file GpioEventManager.cpp.

                                                                  {
     if(!handler_set){
        gpio_set_irq_callback(gpio_event_handler);
        handler_set = true;
    }
    gpio_set_irq_enabled(pin, edgeMask, true);
}

References gpio_event_handler(), and handler_set.

Referenced by App::onStart().

Here is the call graph for this function:

Here is the caller graph for this function:

getInstance()

GpioEventManager & GpioEventManager::getInstance ( )

static

This is a thread-safe singleton implementation.

Definition at line 10 of file GpioEventManager.cpp.

                                                {
    static GpioEventManager instance;
    return instance;
}

Referenced by AppContext::initFrameworkServices().

Here is the caller graph for this function:

gpio_event_handler()

void GpioEventManager::gpio_event_handler ( uint  gpio, uint32_t  events  )

staticprivate

Definition at line 36 of file GpioEventManager.cpp.

                                                                    {
    GpioEvent gpioEvent = {
        static_cast<uint16_t>(gpio),
        static_cast<uint16_t>(events)
    };
 
    // Dispatch to listeners
#if GPIO_EVENT_HANDLING & GPIO_NOTIFICATIONS
 
    auto it = listeners.find(gpio);
    if (it != listeners.end()) {
        for (auto& cb : it->second) {
            cb(gpioEvent);
        }
    }
#endif
 
    // Also send an Event to EventManager if anyone wants to subscribe
#if GPIO_EVENT_HANDLING & GPIO_EVENTS
    Event evt = Event(SystemNotification::GpioChange, gpioEvent, sizeof(GpioEvent)); // broadcast event to anyone subscribed as target isn't specified
    AppContext::get<EventManager>()->postEvent(evt); // EventManager knows whther it's an ISR or not
#endif
}

References AppContext::getTypeKey(), GpioChange, and listeners.

Referenced by enableInterrupt().

Here is the call graph for this function:

Here is the caller graph for this function:

registerCallback()

void GpioEventManager::registerCallback	(	uint	pin,
		GpioCallback	cb
	)

This allows multiple listeners to be registered for the same pin.

Parameters

pin	The GPIO pin number to register the callback for.
cb	The callback function to call when an event occurs.

Definition at line 28 of file GpioEventManager.cpp.

                                                                 {
    listeners[pin].push_back(cb);
}

References listeners.

unregisterAll()

void GpioEventManager::unregisterAll

(

uint

pin

)

This removes the the list of listeners for the specified pin.

Parameters

pin	The GPIO pin number to unregister the callback from.
cb	The callback function to remove.

Definition at line 32 of file GpioEventManager.cpp.

                                             {
    listeners.erase(pin);
}

References listeners.

Member Data Documentation

handler_set

bool GpioEventManager::handler_set = false

private

Definition at line 80 of file GpioEventManager.h.

Referenced by enableInterrupt().

listeners

std::map<uint, std::vector<GpioCallback> > GpioEventManager::listeners

inlinestaticprivate

Definition at line 84 of file GpioEventManager.h.

Referenced by disableInterrupt(), gpio_event_handler(), registerCallback(), and unregisterAll().

---

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

• GpioEventManager.h
• GpioEventManager.cpp