Methods
This is draft outline for NEW API additions to be added to API reference
📘 = NEW Methods 📗 = Existing Methods 📙 = Legacy/deprecated
auto connect to saved wifi, or custom, and start config portal on failures
manually start the config portal, autoconnect does this automatically on connect failure
returns bool
auto generates apname
returns bool
manually stop the config portal if started manually, stop immediatly if non blocking, flag abort if blocking
returns bool
manually start the web portal, autoconnect does this automatically on connect failure
_manually stop the web portal if started manually_mark
Run webserver processing, if setConfigPortalBlocking(false)
returns bool
get the AP name of the config portal, so it can be used in the callback
returns String
_get the wifi RSSI as a percentage quality value _
returns int
erase wifi credentials
reboot esp
disconnect wifi, without persistent saving or erasing
returns bool
erase esp
returns bool
adds a custom parameter
returns false on failure_
returns bool
returns the list of Parameters
returns the Parameters Count
returns int
called after AP mode and config portal has started
called after webserver has started
called when settings reset have been triggered
called when wifi settings have been changed and connection was successful ( or setBreakAfterConfig(true) )
called when saving either params-in-wifi or params page
called when saving params-in-wifi or params before anything else happens (eg wifi)
sets timeout before AP,webserver loop ends and exits even if there has been no setup. useful for devices that failed to connect at some point and got stuck in a webserver loop in seconds setConfigPortalTimeout is a new name for setTimeout, ! not used if setConfigPortalBlocking
sets timeout for which to attempt connecting, useful if you get a lot of failed connects
REPLACES Timeout(unsigned long seconds)
sets number of retries for autoconnect, force retry after wait failure exit
sets timeout for which to attempt connecting on saves, useful if there are bugs in esp waitforconnectloop
toggle debug output
set min quality percentage to include in scan, defaults to 8% if not specified
sets a custom ip /gateway /subnet configuration
sets config for a static IP
sets config for a static IP with DNS
if this is set, it will exit after config, even if connection is unsuccessful.
_if this is set, portal will be blocking and wait until save or exit, _
is false user must manually process() to handle config portal,
setConfigPortalTimeout is ignored in this mode, user is responsible for closing configportal
if this is set, customise style
if this is true, remove duplicated Access Points - defaut true
setter for ESP wifi.persistent so we can remember it and restore user preference, as WIFi._persistent is protected
if true, always show static net inputs, IP, subnet, gateway, else only show if set via setSTAStaticIPConfig
if true, always show static dns, esle only show if set via setSTAStaticIPConfig
toggle showing the saved wifi password in wifi form, could be a security issue.
if false, disable captive portal redirection
if false, timeout captive portal even if a STA client connected to softAP (false), suggest disabling if captiveportal is open
if true, reset timeout when webclient connects (true), suggest disabling if captiveportal is open
if true, enable autoreconnecting
if true, wifiscan will show percentage instead of quality icons, until we have better templating
if true (default) then start the config portal from autoConnect if connection failed
set a custom hostname, sets sta and ap dhcp client id for esp32, and sta for esp8266
returns bool
show erase wifi onfig button on info page, true
show OTA upload button on info page
set ap channel
set ap hidden
clean connect, always disconnect before connecting
set custom menu items and order, vector or arr _see menutokens for ids
add params to its own menu page and remove from wifi, NOT TO BE COMBINED WITH setMenu!
get last connection result, includes autoconnect and wifisave
returns uint8_t
get a status as string
returns String
get wifi mode as string
returns String
check if the module has a saved ap to connect to
returns bool
helper to get saved password, if persistent get stored, else get current if connected
returns String
helper to get saved ssid, if persistent get stored, else get current if connected
returns String
debug output the softap config
debug output platform info and versioning
helper for html
returns String
set the country code for wifi settings, CN
set body class (invert), may be used for hacking in alt classes
set dark mode via invert class
get default ap esp uses , esp_chipid etc returns String
set port of webserver, 80
check if config portal is active (true)
returns bool
check if web portal is active (true)
returns bool