Class that helps to connect to WiFi networks, that also has captive portal web interface for configuration. This is the base class for WiFiConntectOLED which displays information on a OLED display. More...

#include <WiFiConnect.h>

Inheritance diagram for WiFiConnect:

Public Member Functions
	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...

virtual void	displayTurnOFF (int ms=5000)
	Virtual method overriden in WiFiConnectOLED. More...

virtual void	displayLoop ()
	Virtual method overriden in WiFiConnectOLED. More...

virtual void	displayON ()
	Virtual method overriden in WiFiConnectOLED. More...

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

virtual void	displayConnecting (int attempt, int totalAttempts)
	Virtual method overriden in WiFiConnectOLED. More...

virtual void	displayConnected ()
	Virtual method overriden in WiFiConnectOLED. More...

virtual void	displayAP ()
	Virtual method overriden in WiFiConnectOLED. More...

virtual void	displayParams ()
	Virtual method overriden in WiFiConnectOLED. More...

virtual void	displayManualReset ()
	Virtual method overriden in WiFiConnectOLED. More...

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

Detailed Description

Class that helps to connect to WiFi networks, that also has captive portal web interface for configuration. This is the base class for WiFiConntectOLED which displays information on a OLED display.

Member Function Documentation

◆ startConfigurationPortal() [1/3]

boolean WiFiConnect::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.

Returns: Returns wether WiFi is connected to a network if AP_NONE is passed as a parameter

◆ startConfigurationPortal() [2/3]

boolean WiFiConnect::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.

Parameters

apcontinue What should the access point do if there is still no connection. AP_NONE - continue running code, AP_LOOP - stay in an infinate loop, AP_RESET - Restart the ESP

Returns: Returns wether WiFi is connected to a network if AP_NONE is passed as a parameter

◆ startConfigurationPortal() [3/3]

boolean WiFiConnect::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.

Parameters

apcontinue	What should the access point do if there is still no connection. AP_NONE - continue running code, AP_LOOP - stay in an infinate loop, AP_RESET - Restart the ESP, handy for sensors if you network goes down, do they keep trying to connect.
apName	The Name to use for the access point
apPassword	The optional Password to protect the access point

Returns: Returns wether WiFi is connected to a network if AP_NONE is passed as a parameter

◆ startParamsPortal() [1/3]

boolean WiFiConnect::startParamsPortal ( )

Starts the custom Parameters Portal using default access point name and password.

Returns: Returns wether WiFi is connected to a network

◆ startParamsPortal() [2/3]

boolean WiFiConnect::startParamsPortal ( AP_Continue apcontinue )

Starts the custom Parameters Portal using default access point name and password, but allows for specifying how to continue.

Parameters

apcontinue What should the access point do if there is still no connection. AP_NONE - continue running code, AP_LOOP - stay in an infinate loop, AP_RESET - Restart the ESP

Returns: Returns wether WiFi is connected to a network if AP_NONE is passed as a parameter

◆ startParamsPortal() [3/3]

boolean WiFiConnect::startParamsPortal	(	AP_Continue	apcontinue,
		const char *	apName,
		const char *	apPassword = `NULL`
	)

Starts the custom Parameters Portal.

Parameters

apcontinue	What should the access point do if there is still no connection. AP_NONE - continue running code, AP_LOOP - stay in an infinate loop, AP_RESET - Restart the ESP
apName	The Name to use for the access point
apPassword	The optional Password to protect the access point

Returns: Returns wether WiFi is connected to a network if AP_NONE is passed as a parameter

◆ addParameter()

void WiFiConnect::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.

Parameters

p	The custom parameter to add.

◆ setAPName()

void WiFiConnect::setAPName ( const char * apName )

Sets the name for the Access Point, setting a default based on the ESP chip id if needed.

Parameters

apName The new name for the access point.

◆ getAPName()

const char * WiFiConnect::getAPName ( )

Gets the Access Point name or the default based on the ESP chip id if not already set.

Returns: The name to be given to the access point.

◆ autoConnect() [1/2]

boolean WiFiConnect::autoConnect ( )

Tries to connect to the last connected WiFi network.

Returns: Returns wether WiFi is connected

Example

The return value can be used to automatically start the access point so you may change networks if required.

if(!wificonnect.autoConnect()){
    //Start the access point
    wificonnect.startConfigurationPortal();
}

◆ autoConnect() [2/2]

boolean WiFiConnect::autoConnect	(	const char *	ssidName,
		const char *	ssidPassword = `NULL`,
		WiFiMode_t	acWiFiMode = `WIFI_STA`
	)

Tries to connect to the specified WiFi network.

Parameters

ssidName	The SSID of the netqork you want to connect to.
ssidPassword	The password for a secure network.
WiFiMode	The WiFi mode

Returns: Returns wether WiFi is connected

◆ setAPStaticIPConfig()

void WiFiConnect::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.

Parameters

ip	The IP address that you want to access the portal through.
gw	The gateway address for the DNS server, usually the same as IP for captive portal.
sn	The subnet mask for the access point, usually 255.255.255.0

◆ setSTAStaticIPConfig()

void WiFiConnect::setSTAStaticIPConfig	(	IPAddress	ip,
		IPAddress	gw,
		IPAddress	sn
	)

Used to set a static ip/gateway and subnet mask for the local network.

Parameters

ip	The IP address that you want to use on the network.
gw	The gateway address for the DNS server or network router.
sn	The subnet mask for the access point, usually 255.255.255.0 for local networks.

◆ setAPCallback()

void WiFiConnect::setAPCallback ( void(*)(WiFiConnect *) func )

Sets the function to be called when we enter Access Point for configuration. Gets passed a the WiFiConnect for additional usage within function.

Parameters

func	The function to be called.

◆ setSaveConfigCallback()

void WiFiConnect::setSaveConfigCallback ( void(*)(void) func )

Sets the function to be called when we need to save the custom parameters/configuration.

Parameters

func	The function to be called. This function should be short running and ideally just set. a flag for processing else where.

◆ setDebug()

void WiFiConnect::setDebug ( boolean isDebug )

Used to turn on or off messages to the serial port/monitor.

Parameters

isDebug Set to true to enable messages.

◆ setRetryAttempts()

void WiFiConnect::setRetryAttempts ( int attempts )

Sets how many times we should try to connect to the WiFi network.

Parameters

attempts How may attampts.

◆ setConnectionTimeoutSecs()

void WiFiConnect::setConnectionTimeoutSecs ( int timeout )

Sets how long to wait for the connection before failing.

Parameters

timeout How may seconds to wait for the connection to be made.

◆ setAPModeTimeoutMins()

void WiFiConnect::setAPModeTimeoutMins ( int mins )

Sets the timeout for when the Access Point is idle.

Parameters

mins	The number of minutes to before exiting an idle access point.

◆ captivePortal()

boolean WiFiConnect::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.

Returns: True if we have redirected to our portal, else false and contimue to handle request

◆ statusToString()

const char * WiFiConnect::statusToString ( int state )

A helper function to return the string version of a wifi network state.

Parameters

state The state that we want the string representation of.

Returns: WiFi state as a string.

◆ getRSSIasQuality()

int WiFiConnect::getRSSIasQuality ( int RSSI )

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

Parameters

RSSI	The quality/signal strength of the WiFi network.

Returns: Value in the range of 0-100 to network indicate quality.

◆ isIp()

boolean WiFiConnect::isIp ( String str )

Function to check if a given string is an IP Address.

Parameters

str	The string to process.

Returns: True if inputted string is an IP Address.

◆ toStringIp()

String WiFiConnect::toStringIp ( IPAddress ip )

Function to return a IPAddress as a string representation.

Parameters

ip	The IPAddress to process.

Returns: String version of the IPAddress

◆ displayTurnOFF()

void WiFiConnect::displayTurnOFF ( int ms = 5000 )

virtual

Virtual method overriden in WiFiConnectOLED.

This function gets overridden by WiFiConnectOLED, please view its documentation.

Reimplemented in WiFiConnectOLED.

◆ displayLoop()

void WiFiConnect::displayLoop ( )

virtual

Virtual method overriden in WiFiConnectOLED.

This function gets overridden by WiFiConnectOLED, please view its documentation.

Reimplemented in WiFiConnectOLED.

◆ displayON()

void WiFiConnect::displayON ( )

virtual

Virtual method overriden in WiFiConnectOLED.

This function gets overridden by WiFiConnectOLED, please view its documentation.

Reimplemented in WiFiConnectOLED.

◆ DEBUG_WC()

template<typename Generic >

void WiFiConnect::DEBUG_WC ( Generic text )

protected

Outputs debug messages.

Parameters

text	The text to be outputted

◆ displayConnecting()

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

protectedvirtual

Virtual method overriden in WiFiConnectOLED.

This function gets overridden by WiFiConnectOLED, please view its documentation.

Reimplemented in WiFiConnectOLED.

◆ displayConnected()

void WiFiConnect::displayConnected ( )

protectedvirtual

Virtual method overriden in WiFiConnectOLED.

This function gets overridden by WiFiConnectOLED, please view its documentation.

Reimplemented in WiFiConnectOLED.

◆ displayAP()

void WiFiConnect::displayAP ( )

protectedvirtual

Virtual method overriden in WiFiConnectOLED.

This function gets overridden by WiFiConnectOLED, please view its documentation.

Reimplemented in WiFiConnectOLED.

◆ displayParams()

void WiFiConnect::displayParams ( )

protectedvirtual

Virtual method overriden in WiFiConnectOLED.

This function gets overridden by WiFiConnectOLED, please view its documentation.

Reimplemented in WiFiConnectOLED.

◆ displayManualReset()

void WiFiConnect::displayManualReset ( )

protectedvirtual

Virtual method overriden in WiFiConnectOLED.

This function gets overridden by WiFiConnectOLED, please view its documentation.

Reimplemented in WiFiConnectOLED.

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

src/WiFiConnect.h
src/WiFiConnect.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ startConfigurationPortal() [1/3]

◆ startConfigurationPortal() [2/3]

◆ startConfigurationPortal() [3/3]

◆ startParamsPortal() [1/3]

◆ startParamsPortal() [2/3]

◆ startParamsPortal() [3/3]

◆ addParameter()

◆ setAPName()

◆ getAPName()

◆ autoConnect() [1/2]

Example

◆ autoConnect() [2/2]

◆ setAPStaticIPConfig()

◆ setSTAStaticIPConfig()

◆ setAPCallback()

◆ setSaveConfigCallback()

◆ setDebug()

◆ setRetryAttempts()

◆ setConnectionTimeoutSecs()

◆ setAPModeTimeoutMins()

◆ captivePortal()

◆ statusToString()

◆ getRSSIasQuality()

◆ isIp()

◆ toStringIp()

◆ displayTurnOFF()

◆ displayLoop()

◆ displayON()

◆ DEBUG_WC()

◆ displayConnecting()

◆ displayConnected()

◆ displayAP()

◆ displayParams()

◆ displayManualReset()