🚧 Development Release

[tablatronix]

Development is now merged into master
https://github.com/tzapu/WiFiManager/

#499

README NOT FULLY UPDATED

• Create docs for changes, new features functions and known issues

TLDR

• Works (mostly) the same
• No Docs, Source is documentation ATM, especially all public methods
• DEV/ondemand example has pretty much everything
• Debug level is set very high, change it via WM_DEBUG_LEVEL or _debugLevel in source
• There are some experimental options for testing issues that are forever ongoing in esp lib
• all html and strings and in string_en.h and progmem

[tablatronix]

Development Overview

Added Public Methods

setConfigPortalBlocking
setShowStaticFields
setCaptivePortalEnable
setRestorePersistent
setCaptivePortalClientCheck
setWebPortalClientCheck
startWebPortal
stopWebPortal
process
disconnect
erase
debugSoftAPConfig
debugPlatformInfo
setScanDispPerc
setHostname
setMenu(menu_page_t[])
setWiFiAutoReconnect
setSTAStaticIPConfig(..,dns)
setShowDnsFields
getLastConxResult
getWLStatusString
getModeString
getWiFiIsSaved
setShowInfoErase
setEnableConfigPortal
setCountry
setClass
htmleEtities
getWiFiPass
getWiFiSSID
setWiFiAPChannel
setWiFiAPHidden
setParamsPage
setCleanConnect
setHttpPort
getConfigPortalActive
getWebPortalActive

WiFiManagerParameter

WiFiManagerParameter(id,label)
WiFiManagerParameter.setValue(value,length)
getParameters
getParametersCount

Constructors

WiFiManager(Stream& consolePort)

define/build flags

❗️ Defines cannot be set in user sketches, can be used in build_flags
#include <rom/rtc.h> // esp32 info page will show last reset reasons if this file is included
WM_MDNS // use MDNS
WM_FIXERASECONFIG // use erase flash fix, esp8266 2.4.0
WM_ERASE_NVS // esp32 erase(true) will erase NVS
WM_DEBUG_LEVEL // set debug level 0-4
WM_DEBUG_PORT // set debug port eg. Serial1

callbacks

setAPCallback // after ap has started
setWebServerCallback // after webserver is setup
setConfigResetCallback // reset settings
setSaveParamsCallback // after save params from params menu or wifi config
setPreSaveConfigCallback // before saving wifi creds

Changes

• ESP32 support
• complete refactor of strings strings_en.h
• adds new tokens for wifiscan, and some classes (left , invert icons, MSG color)
• adds status callout panel default, primary, special colors
• adds tons of info on info page, and erase capability
• adds signal icons, replaces percentage ( has hover titles )
• adds labels to all inputs (replaces placeholders)
• all html ( and eventually all strings except debug) moved to strings_en.h
• added additional debugging, compressed debug lines, debuglevels
• persistent disabled, and restored via de/con-stuctor (uses setRestorePersistent)
• should retain all user modes including AP, should not overwrite or persist user modes or configs,even STA (storeSTAmode) (BUGGY)
• ⚠️ return values may have changed depending on portal abort, or timeout ( portalTimeoutResult,portalAbortResult)
• params memory is auto allocated by increment of WIFI_MANAGER_MAX_PARAMS(5) when exceeded, user no longer needs to specify this at all.
• addparameter now returns bool, and it returns false if param ID is not alphanum [0-9,A-Z,a-z,_]
• param field ids allow {I} token to use param_n instead of string in case someones wants to change this due to i18n or character issues
• provides #DEFINE FIXERASECONFIG to help deal with Fix erase size in ESP.eraseConfig esp8266/Arduino#3635
• failure reason reporting on portal
• set esp8266 sta hostname, esp32 sta+ap hostname ( DHCP client id)
• pass in debug stream in constructor WiFiManager(Stream& consolePort)
• you can force ip fields off with setShow_X_fields(false) if you set _disableIpFields=true
• param menu/page (setup) added to separate params from wifi page, handled automatically by setMenu
• set custom root menu
• disable configportal on autoconnect
• wm parameters init is now protected, allowing child classes, example included
• wifiscans are precached and async for faster page loads, refresh forces rescan
• adds esp32 gettemperature ( currently commented out, useful for relative measurement only )
• Set AP Channel
• Set AP Hidden
• Change Http Port
• ⚠️ setAPCallback has moved to after startap

[tablatronix]

• include <rom/rtc.h> to get esp32 info to show reset reasons

[tablatronix]

• remove esp32 autoconnect workaround ( fixed in core )
  esp32 autoconnect working in core #664

left define in to reenable, if anyone needs something like that or similar

[tablatronix]

Refactor of examples currently in progress !
They might be messy for a bit

[dvukovic]

Has anyone tried WiFiManager with an ESP8285 ?

[tablatronix]

I have one I have not tested yet

• test ESP8285

[tablatronix]

Locked this issue, this is for documentation only

[tablatronix]

Known Issues/Outstanding Design

• Since autoconnect and startcp can be non blocking now, return results may be inconsistent with old code, ensure this is cleaned up and ocncise

• You can now skip wifi and save other params, wifi will be ignored, also this will alter return results as true was for connected status previously

• save callbacks are not called if not changing wifi, unless shouldbreakafterconfig is set, this needs to be cleaned up in to a legacy handling and new handling consitancy

• save wifi and save param can be split now, wifi still retains ip inputs, setup custom params, there is no user selection here, improve where user wants params, fix up callbacks to make it clear where user is getting data back from. savewifi, saveparam, etc

• WM is NO longer persistent unless you save, atm I am reducing confusion by forcing STA mode on because that is how legacy worked, by design or not, it is what users are used to. Clarify how users want this to function, users now are responsible for user code and modes, wm can restore user modes back when starting and stopping configportal without touching their flash confgs. So if wifi was off, or ap, it will go back and they will wonder why their wifi is not on or why there is an ap when they reboot ???

• Documentation is non existent, I might work with doxygen to get some basic generated from my doc blocks, all public functions are documented fairly well. Source is Docs for now.

• DEV/ondemand example is used as my poor mans unit test, it has almost all functionality added to it and maintained.

• Examples need to be cleaned up, I want them cleaned up into useful functions also, for example MQTT, with api token, durations, etc. littlefs

• spiffs is replaced by littlefs, update examples as such

• users still want customization, almost anything can be customized in strings.h, but maybe we can add a header and footer callout for easy code only dynamic changes.

• reduce code bloat by wrapping features in a #ifdef , make features optional, advanced info page has alot of info folks might not need, advanced testing page, gpio toggle?ota form? api ?

[tablatronix]

Release v2.0.3-apha Development Is available in arduino library manager
https://github.com/tzapu/WiFiManager/releases/tag/2.0.3-alpha

[tablatronix]

Development branch is now master

• merge development into master
• delete development branch

[tablatronix]

#1199

[tablatronix]

Created https://github.com/tzapu/WiFiManager/wiki/Methods as basic outline for docs