Class extending WiFiConnect to allow the use of OLED for showing information to users. More...

#include <WiFiConnectOLED.h>

Inheritance diagram for WiFiConnectOLED:

Public Member Functions
	WiFiConnectOLED (OLEDDisplay *odisplay, int pwrpin, int screenW=128, int screenH=64)
	Class initialiser. More...

void	begin (boolean flipV=false, boolean mirror=false)
	Starts the display and optionally sets its orientation. More...

void	clear ()
	Clears the screen buffer. note: Does not alter whats already showing.

void	clear (int startX, int startY, int endX, int endY)
	Clear a certain portion of the screen TODO: Not implemented yet. More...

void	FlashTurningOffScreen ()
	Displays a screen that flashes the words Turning Off before turning off the display.

void	screenTest ()
	Starts a runthrough of the screens, useful for testing.

void	displayTurnOFF (int ms=5000) override
	Turns of the display using FlashTurningOffScreen() or via displayLoop() if a parameter >0 is supplied. More...

void	displayLoop () override
	When put in another or main loop, check to see if it should turn off the display.

void	displayON () override
	Send a High signal to the power pin, turning the display on.

Public Member Functions inherited from WiFiConnect
	WiFiConnect ()
	Create WiFiConnect class.

boolean	startConfigurationPortal ()
	Starts the Access Portal for setting SSID and Password for connecting to a network and any custom user parameters. Uses the default access point name and password. More...

boolean	startConfigurationPortal (AP_Continue apcontinue)
	Starts the Access Portal for setting SSID and Password for connecting to a network and any custom user parameters. Uses the default access point name and password, but allows for specifying how to continue if network not connected. More...

boolean	startConfigurationPortal (AP_Continue apcontinue, const char apName, const char apPassword=NULL)
	Starts the Access Portal for setting SSID and Password for connecting to a network and any custom user parameters. More...

boolean	startParamsPortal ()
	Starts the custom Parameters Portal using default access point name and password. More...

boolean	startParamsPortal (AP_Continue apcontinue)
	Starts the custom Parameters Portal using default access point name and password, but allows for specifying how to continue. More...

boolean	startParamsPortal (AP_Continue apcontinue, const char apName, const char apPassword=NULL)
	Starts the custom Parameters Portal. More...

void	addParameter (WiFiConnectParam *p)
	Adds a custom parameter to be displayed in the accesspoint and parameters portals. Custom parameters can be used to save information that you do not want to hard code i.e. IP address, Port number that can be saved to the file system. More...

void	setAPName (const char *apName)
	Sets the name for the Access Point, setting a default based on the ESP chip id if needed. More...

const char *	getAPName ()
	Gets the Access Point name or the default based on the ESP chip id if not already set. More...

void	resetSettings ()
	A helper to clear the settings for the last connected network. Remember to comment out or remove and re-upload your code otherwise chip will constantly restart.

boolean	autoConnect ()
	Tries to connect to the last connected WiFi network. More...

boolean	autoConnect (const char ssidName, const char ssidPassword=NULL, WiFiMode_t acWiFiMode=WIFI_STA)
	Tries to connect to the specified WiFi network. More...

void	setAPStaticIPConfig (IPAddress ip, IPAddress gw, IPAddress sn)
	Used to set a static ip/gateway and subnet mask for the access point. IP and DNS Gateway are normally the same for a captive portal. More...

void	setSTAStaticIPConfig (IPAddress ip, IPAddress gw, IPAddress sn)
	Used to set a static ip/gateway and subnet mask for the local network. More...

void	setAPCallback (void(func)(WiFiConnect ))
	Sets the function to be called when we enter Access Point for configuration. Gets passed a the WiFiConnect for additional usage within function. More...

void	setSaveConfigCallback (void(*func)(void))
	Sets the function to be called when we need to save the custom parameters/configuration. More...

void	setDebug (boolean isDebug)
	Used to turn on or off messages to the serial port/monitor. More...

void	setRetryAttempts (int attempts)
	Sets how many times we should try to connect to the WiFi network. More...

void	setConnectionTimeoutSecs (int timeout)
	Sets how long to wait for the connection before failing. More...

void	setAPModeTimeoutMins (int mins)
	Sets the timeout for when the Access Point is idle. More...

boolean	captivePortal ()
	Redirect to captive portal if we get a request for another domain. Return true in that case so the page handler do not try to handle the request again. More...

const char *	statusToString (int state)
	A helper function to return the string version of a wifi network state. More...

int	getRSSIasQuality (int RSSI)
	Function to convert RSSI into a usable range 0-100 so we can use it to exclude poor networks. More...

boolean	isIp (String str)
	Function to check if a given string is an IP Address. More...

String	toStringIp (IPAddress ip)
	Function to return a IPAddress as a string representation. More...

Protected Member Functions
template<typename Generic >
void	DEBUG_WC (Generic text)
	Ourputs messages to the Serial debugger/monitor. More...

void	displayConnecting (int attempt, int totalAttempts) override
	Displays the attempting to connect screen, showing the progess of the attempts made to connect. More...

void	displayConnected () override
	Displays the screen showing the ip address within the connected network.

void	displayAP () override
	Displays the access point screen with the ap name and ip address.

void	displayParams () override
	Displays the paramets access point screen with the ap name and ip address.

void	displayManualReset () override
	When in an infinate loop after failing to connect to a network from within a access point, displays the Manual Reset required screen to the user.

Protected Member Functions inherited from WiFiConnect
template<typename Generic >
void	DEBUG_WC (Generic text)
	Outputs debug messages. More...

Protected Attributes
boolean	_screenTest = false
	Flag for use during screenTest() method.

Protected Attributes inherited from WiFiConnect
boolean	_debug = false
	Flag to determine wheter to output mesages or not.

Detailed Description

Class extending WiFiConnect to allow the use of OLED for showing information to users.

Constructor & Destructor Documentation

◆ WiFiConnectOLED()

WiFiConnectOLED::WiFiConnectOLED	(	OLEDDisplay *	odisplay,
		int	pwrpin,
		int	screenW = `128`,
		int	screenH = `64`
	)

Class initialiser.

Parameters

odisplay	A reference to the OLED display object for drawing to the screen.
pwrpin	The number of the pin that supplies power to the screen, allows us to turn it off if we wish.
screenW	The pixel width of the OLED.
screenH	The pixel height of the OLED.

Member Function Documentation

◆ begin()

void WiFiConnectOLED::begin	(	boolean	flipV = `false`,
		boolean	mirror = `false`
	)

Starts the display and optionally sets its orientation.

Parameters

flipV	Flips the screen display vertically.
mirror	Mirrors the screen image

◆ clear()

void WiFiConnectOLED::clear	(	int	startX,
		int	startY,
		int	endX,
		int	endY
	)

Clear a certain portion of the screen TODO: Not implemented yet.

Parameters

startX	Starting X position
startY	Starting Y position
endX	Ending X position
endY	Ending Y position \

◆ displayTurnOFF()

void WiFiConnectOLED::displayTurnOFF ( int ms = 5000 )

overridevirtual

Turns of the display using FlashTurningOffScreen() or via displayLoop() if a parameter >0 is supplied.

Parameters

ms	Milliseconds to wait before turnung off.

Reimplemented from WiFiConnect.

◆ DEBUG_WC()

template<typename Generic >

void WiFiConnectOLED::DEBUG_WC ( Generic text )

protected

Ourputs messages to the Serial debugger/monitor.

Parameters

text	The text to be displayed.

◆ displayConnecting()

void WiFiConnectOLED::displayConnecting	(	int	attempt,
		int	totalAttempts
	)

overrideprotectedvirtual

Displays the attempting to connect screen, showing the progess of the attempts made to connect.

Parameters

attempt	The number of the current attempt.
totalAttempts	The total number of allowable attempts.

Reimplemented from WiFiConnect.

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

src/WiFiConnectOLED.h
src/WiFiConnectOLED.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ WiFiConnectOLED()

Member Function Documentation

◆ begin()

◆ clear()

◆ displayTurnOFF()

◆ DEBUG_WC()

◆ displayConnecting()