NeoPixelWiFiEventHandler Class Reference

Color a neopixel as a function of the WiFi state. More...

#include <NeoPixelWiFiEventHandler.h>

Inheritance diagram for NeoPixelWiFiEventHandler:

Public Member Functions
	NeoPixelWiFiEventHandler (gpio_num_t gpioPin)
esp_err_t	apStart () override
	Handle the Access Point started event. Handle an indication that the ESP32 has started being an access point. More...
esp_err_t	staConnected (system_event_sta_connected_t info) override
	Handle the Station Connected event. Handle having connected to remote AP. More...
esp_err_t	staGotIp (system_event_sta_got_ip_t info) override
	Handle the Station Got IP event. Handle having received/assigned an IP address when we are a station. More...
esp_err_t	staDisconnected (system_event_sta_disconnected_t info) override
	Handle the Station Disconnected event. Handle having disconnected from remote AP. More...
esp_err_t	wifiReady () override
esp_err_t	staStart () override
Public Member Functions inherited from WiFiEventHandler
	WiFiEventHandler ()
	Constructor.
virtual esp_err_t	apStaConnected (system_event_ap_staconnected_t info)
	Handle a Station Connected to AP event. Handle having a station connected to ESP32 soft-AP. More...
virtual esp_err_t	apStaDisconnected (system_event_ap_stadisconnected_t info)
	Handle a Station Disconnected from AP event. Handle having a station disconnected from ESP32 soft-AP. More...
virtual esp_err_t	apStop ()
	Handle the Access Point stop event. Handle an indication that the ESP32 has stopped being an access point. More...
system_event_cb_t	getEventHandler ()
	Get the event handler. Retrieve the event handler function to be passed to the ESP-IDF event handler system. More...
virtual esp_err_t	staScanDone (system_event_sta_scan_done_t info)
	Handle a Scan for APs done event. Handle having an ESP32 station scan (APs) done. More...
virtual esp_err_t	staAuthChange (system_event_sta_authmode_change_t info)
	Handle the auth mode of APs change event. Handle having the auth mode of AP ESP32 station connected to changed. More...
virtual esp_err_t	staStop ()
WiFiEventHandler *	getNextHandler ()
void	setNextHandler (WiFiEventHandler *nextHandler)

Detailed Description

Color a neopixel as a function of the WiFi state.

When an ESP32 runs, we can't tell by looking at it the state of the WiFi connection. This class provides a WiFi event handler that colors a NeoPixel as a function of the state of the WiFi.

Member Function Documentation

esp_err_t NeoPixelWiFiEventHandler::apStart ( )

overridevirtual

Handle the Access Point started event. Handle an indication that the ESP32 has started being an access point.

Returns

An indication of whether or not we processed the event successfully.

Reimplemented from WiFiEventHandler.

esp_err_t NeoPixelWiFiEventHandler::staConnected ( system_event_sta_connected_t  info )

overridevirtual

Handle the Station Connected event. Handle having connected to remote AP.

Parameters

[in]

event_connected

system_event_sta_connected_t.

Returns

An indication of whether or not we processed the event successfully.

Reimplemented from WiFiEventHandler.

esp_err_t NeoPixelWiFiEventHandler::staDisconnected ( system_event_sta_disconnected_t  info )

overridevirtual

Handle the Station Disconnected event. Handle having disconnected from remote AP.

Parameters

[in]

event_disconnected

system_event_sta_disconnected_t.

Returns

An indication of whether or not we processed the event successfully.

Reimplemented from WiFiEventHandler.

esp_err_t NeoPixelWiFiEventHandler::staGotIp ( system_event_sta_got_ip_t  info )

overridevirtual

Handle the Station Got IP event. Handle having received/assigned an IP address when we are a station.

Parameters

[in]

event_sta_got_ip

The Station Got IP event.

Returns

An indication of whether or not we processed the event successfully.

Reimplemented from WiFiEventHandler.

---

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

• NeoPixelWiFiEventHandler.h
• NeoPixelWiFiEventHandler.cpp