iBom for EasyEDA is a native extension for EasyEDA and LCEDA: Standard Edition. It is based on the awesome project called InteractiveHtmlBom designed and built by qu1ck.

Although InteractiveHtmlBom already supports generation of interactive BOMs from EasyEDA projects, but it involves messing with Python scripts and requires to host the generated html files somewhere. Since my knowledge of Python === null, and my favorite tool for designing electronics is EasyEDA – I decided to give it a shot and port it as a native extension.

Comparing to original solution, iBom for EasyEDA is available right within EasyEDA itself:

• There is no need to run any Python scripts.
• No need to host the produced html files.
• iBom is always accessible by clicking a single menu button from your PCB document!
• It also provides an ability to generate a stand-alone HTML representation the same way InteractiveHtmlBom does out of the box.

NOTE: This extension is still in ALPHA/BETA stage – a lot of things should be done in order to make it fully compatible with EasyEDA.

1. Download easyeda-ibom-v0.1.2.zip
2. Un-zip the downloaded archive on your hard drive.
3. Go to Extension Settings dialog by using main menu Advanced -> Extensions -> Extensions Settings....
4. Click Load Extension... button and add all the files in from the extracted folder using Select Files... button.
5. Click Load Extension and close the Extension Settings dialog.

In order to launch iBom within the editor itself – just click on iBom -> Launch... menu item:

You can always dismiss the iBom view by clicking on the little close button located in the right-top corner of the panel.

Just click iBom -> Generate & Download HTML menu item in order to get the stand-alone representation of your PCB document:

Note: In case the downloaded file doesn’t have .html extension – just add it manually. It is some sort of weird browser behaviour for the case to be investigated.

If you discover any issue or have any suggestions for improvement of the plugin, please open an issue or find me on twitter @turbobabr.

This solution uses:

• InteractiveHtmlBom as a core component.
• A "hackable" nature of EasyEDA/LCEDA – thank you guys for allowing us messing with the product! 👏
• svg-path-bbox for calculating various bounding boxes during EasyEDA -> InteractiveHTMLBOM data conversions.

MIT License

Copyright (c) 2021 Andrey Shakhmin

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

The webpage is a result of XSLT transformation to both HTML applied on an XML file with football league data. It has been developed as a semestral work as a part of the course 4IZ238 XML – Theory and Practice of Markup Languages.

This is also my very first XSLT transformation to both HTML and PDF from 2016 and published now. The webpage is hosted on GitHub Pages.

For those who haven’t encountered with the following elementary terms yet:

• HTML: Hypertext Markap Language is a standard markup language for creating web pages and web applications.
• XML: Extensible Markup Language is a markup language that defines a set of rules for encoding.
• XSD: XML Schema Definition is a specification how to formally describe the elements in an XML document.
• XSLT: Extensible Stylesheet Language Transformations is a language for transforming XML documents into other XML documents or other formats.

The entire semestral work could be divided into 4 separated processes.

The only input is an XML file. All the names and numbers are fictional or randomly generated in the past and exclusively created by myself only.

It’s the input XML file with a root element league and two its descendants detail describing the league detail and teams which lists the detailed description of the team itself and all its players. A brief form appears below:

The only input XML file validated against both an XSD file and a Schematron file.

This XSD file is a validation file for the input XML which validates its entire structure, the allowed count and order of the particular elements and the data type and format of their values. The following list provides a selection of the most important rules (not ordered by the importance):

• All the names, shortcuts and contacts have to remain distinct
• Each team is allowed to recruit at least 11 and up to 20 players and each player is between 15 and 99 years, both inclusive
• Some of them are talented and their skill has to match the enumeration: free kicks, quick, powerful, technical or head
• All the contacts, licenses and ID’s must match the format usually defined with a regular expression (Regex)
• A player can play on one of 4 available positions: goalkeeper, defender, midfielder or forward
• Their overall skill is represented by a double number between 1 and 40, both inclusive round on the halves using:

  <xsd:assertion test="$value = (for $d in 1 to 40 return 0.5 * $d)"/>

I have used the Venetian Blind design.

The Schematron validation is a minor and a supplementary validation file using XPath. Its only job is to assure that each team will have only and exactly one player market as a captain. A part of the overall score was the usage of a Schematron file and the captain validation is a job which suits Schematron a lot:

The crucial part of the semestral work is the transformation into HTML and PDF output with mutually linked pages and aggregation functions. Each transformation has defined a set of functions applicable to the statistics of the players.

The first transformation produces the website consisted of mutually linked HTML pages deployed on the project’s GitHub Pages with the similar design but variable linked content.

All the transformations are applied to the root element / and define immediately self as a template rendered to index.html with to generated partial templates under the div containers. The sample code is followed with a brief sample of the en:teams template responsible that each team have own page generated into chunks folder:

<xsl:template match="en:teams">
    <h2>Teams</h2>
    <table id="teams">
        <tr id="teams-label">
            <!-- /* SKIPPED: Table header labels */-->
        </tr>
        <xsl:for-each select="en:team">
    
            <!-- /* Sorted table of teams with links to the newly generated pages below */-->
            <xsl:sort select="@id"/>
                <tr id="teams">
                    <td><a href="chunks/{translate(en:description/en:name, $uppercase, $lowercase)}.html">
	                <xsl:value-of select="@id"/>
	            </a></td>
                    <td><xsl:value-of select="en:description/en:short"/></td>
                    <td><xsl:value-of select="en:description/en:name"/></td>
                    <td><xsl:value-of select="en:description/en:trainer/en:name"/></td>
                    <td><xsl:value-of select="en:calculatePower(en:players)"/></td>
                </tr>
     
            <!-- /* Generated page for each team */-->
            <xsl:result-document 
		    href="chunks/{translate(en:description/en:name, $uppercase, $lowercase)}.html" 
		    format="html">
                <html>
                    <head>
                        <title><xsl:value-of select="en:description/en:name"/></title>
                        <link rel="stylesheet" type="text/css" href="../index.css"/>
                    </head>
                    <body>
                        <!-- /* SKIPPED: Header and  watermark */-->	
                        <div id="league">
	                    <!-- /* Generated team description using another template */-->
                            <xsl:apply-templates select="en:description"/>    
                        </div>
                        <div id="teams">
	                    <!-- /* Generated list of players using another template */-->
                            <xsl:apply-templates select="en:players"/>        
                        </div>
                        <div id="footer"/>
                    </body>
                </html>
            </xsl:result-document>
        </xsl:for-each>
    </table>
</xsl:template>

On the similar principle works the transformation to PDF with a watermark. In the beginning, there is generated a table of contents with links to particular pages. Each team is rendered to the separated page. Last few pages have generated tables with the best players.

This transformation is three times more verbose than the previous one because of the design redefinition since CSS can not be used to this kind of transformation. However, unlike the used elemenets, the principle is pretty identical. A really shortened example of a block summary of the best goalkeepers follows:

This section offers an overall view to the generated content structure.

• index.html
  • chunks/sanha.html
  • chunks/xavao.html
  • chunks/quernera.html
  • chunks/presto%20pallares.html
  • chunks/espartinas.html
  • chunks/sheinis.html
  • chunks/loueiro.html
  • chunks/pazos.html
  • chunks/palmeires.html
  • chunks/zingo.html
  • chunks/hyuni.html
  • chunks/pulpite.html
• best-players.html
• top-11.html

• index.pdf

  The GitHub PDF viewer doesn’t suppor the links to the pages. There is need to download the file for the full functionality.

I have integrated Codebeat and Codacy cloud static analysis services to check the overall code quality out of curiosity.

MIT License

Copyright (c) 2018 Nikolas Charalambidis

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Kong API Gateway plugin for url-rewrite purposes. This plugin has been tested to work along with kong >= 2.6.x, for a legacy version of this plugin, please check this link.

When using Kong, you can create routes that proxy to an upstream. The problem lies when the upstream has an url that is not very friendly to your clients, or restful, or even pretty. When you add a Route in Kong, you have a somewhat limited url rewrite capability. This plugin simply throws away the url set in Kong route and uses the url set in it’s configuration to proxy to the upstream. This gives you full freedom as to how to write your url’s in Kong and inner services as well.

The plugin folder should contain at least a schema.lua and a handler.lua, alongside with a spec folder and a .rockspec file specifying the current version of the package.

The .rockspec file should follow LuaRocks’ conventions

Configure this plugin on a Route with:

curl -X POST http://kong:8001/routes/{route_id}/plugins \
    --data "name=kong-plugin-url-rewrite"  \
    --data "config.url=http://new-url.com"

• route_id: the id of the Route that this plugin configuration will target.
• config.url: the url where you want kong to execute the request.

docker build . -t kong-plugin-url-rewrite-dev
docker run -it -v ${PWD}/url-rewrite:/url-rewrite kong-plugin-url-rewrite-dev bash

made with ❤️ by Stone Payments

• useIntervalWhen – Sets an interval immediately when a condition is true
• useLockBodyScroll – This hook locks the scroll of the body element when isLocked is set to true.
• useRaf – A continuously running requestAnimationFrame hook for React
• useResizeObserverRef – Resize Observer hook for React.
• useTimeoutWhen – Takes a callback and fires it when a condition is true

• useGeolocation – A hook to provide the geolocation info on client side.
• useIdleDetectionApi – Hook to detect when user is idle using Idle Detection API with polyfill
• useNavigatorLanguage – Navigator Language hook for React.
• useOnline – Online status hook for React.
• useOrientation – orientation hook for react
• useScreenDetailsApi – Hook for multi-screen information and management using Screen Details API
• useWebLocksApi – Hook for coordinating operations across tabs/workers with Web Locks API
• useSpeech – Speech synthesis hook for React
• useVibrate – Vibration API hook for React

• useRenderCount – Get the render count of a component

• useDocumentEventListener – A react hook to an event listener to the document object
• useDocumentVisibilityState – Returns the visibility state of the document.
• useFocus – Handles focus events for the immediate target element.
• useFocusWithin – Handles focus events for the target component.
• useIsDroppingFiles – Check if any files are currently being dropped anywhere. Useful for highlighting drop areas.
• useOnClickRef – Callback on click/tap events
• useOnHoverRef – On hover callback hook
• useOnLongHover – Fires a callback when an element is hovered for a while
• useOnLongPress – Fire a callback on long press
• useOnStartTyping – Fires a callback when the user starts typing outside editable fields (input, textarea, contenteditable). Supports filtering for a-z and 0-9 keys.
• useOnWindowResize – A React hook for adding an event listener for window resize
• useOnWindowScroll – A React hook for adding an event listener for window scroll
• useOutsideClick – Outside click(for a ref) event as hook for React.
• useOutsideClickRef – A hook that can track a click event outside a ref. Returns a callbackRef.
• useWindowEventListener – Adds an event listener to window

• useFileDropRef – Drop files easily

• useInput – Input hook for React.
• useKey – keypress, keyup and keydown event handlers as hooks for react.
• useKeyBindings – useKeyBindings can bind multiple keys to multiple callbacks and fire the callbacks on key press.
• useKeyRef – Very similar useKey but it returns a ref
• useKeys – A hook which allows to setup callbacks when a combination of keys are pressed at the same time.

• useAsyncEffect – A version of useEffect that accepts an async function
• useDeepCompareEffect – Deep compare dependencies instead of shallow for useEffect
• useDidMount – componentDidMount hook for React
• useDidUpdate – componentDidUpdate hook for react
• useDocumentTitle – A hook to easily update document title with React
• useEffectOnceWhen – Runs a callback effect atmost one time when a condition becomes true
• useIsomorphicEffect – A hook that resolves to useEffect on the server and useLayoutEffect on the client.
• useLifecycleLogger – A react hook that console logs parameters as component transitions through lifecycles.
• useWillUnmount – componentWillUnmount lifecycle as hook for React.

• useMouse – Mouse position hook for React.
• useMouseMoveDelta – Tracks delta of mouse move
• useMouseWheelDelta – Tracks delta of mouse move

• useDebounce – Debounce hook for react
• useDebouncedValue – Tracks another value and gets updated in a debounced way.
• useDebounceFn – Powerful debounce function hook for React
• useThrottle – Throttle custom hook for React

• useArrayState – Array state manager hook for React
• useCountdown – Count down to a target timestamp and call callbacks every second (or provided peried)
• useCounter – Counter hook for React.
• useGetIsMounted – Checks if a component is mounted or not at the time. Useful for async effects
• useLocalstorageState – UseState but auto updates values to localStorage
• useMapState – A react hook to manage state in a key value pair map.
• useMultiSelectableList – A custom hook to easily select multiple values from a list
• useNativeMapState – Manage Map() object state in React
• usePreviousDifferent – usePreviousDifferent returns the last different value of a variable
• usePreviousImmediate – usePreviousImmediate returns the previous value of a variable even if it was the same or different
• usePromise – Promise management hook for react
• useQueueState – A React hook that manages state in the form of a queue
• useSafeSetState – set state but ignores if component has already unmounted
• useSelect – Select values from a list easily. List selection hook for react.
• useSelectableList – Easily select a single value from a list of values. very useful for radio buttons, select inputs etc.
• useSessionstorageState – useState but syncs with sessionstorage
• useSetState – Manage the state of a Set in React.
• useStackState – A React hook that manages state in the form of a stack

• useTimeTravelState – A hook that manages state which can undo and redo. A more powerful version of useUndoState hook.
• useToggle – Toggle (between booleans or custom data)hook for React.
• useUndoRedoState – Setstate but can also undo and redo
• useUndoState – Drop in replacement for useState hook but with undo functionality.

• useAudio – Audio hook
• useBoundingclientrect – getBoundingClientRect hook for React.
• useBoundingclientrectRef – A hook that tracks the boundingclientrect of an element. It returns a callbackRef so that the element node if changed is easily tracked.
• useDimensionsRef – Easily grab dimensions of an element with a ref using this hook
• useFullscreen – Use full screen api for making beautiful and emersive experinces.
• useIntersectionObserverRef – A hook to register an intersection observer listener.
• useInViewRef – Simple hook that monitors element enters or leave the viewport that’s using Intersection Observer API.
• useMediaMatch – Signal whether or not a media query is currently matched.
• useMutationObserver – Mutation Observer hook for React.
• useMutationObserverRef – A hook that tracks mutations of an element. It returns a callbackRef.
• usePictureInPictureApi – Hook for managing Picture-in-Picture video functionality
• useVideo – Video hook for react

• useEventListenerRef – A react hook to add an event listener to a ref
• useForkRef – A hook that can combine two refs(mutable or callbackRefs) into a single callbackRef
• useFreshCallback – Avoid stale closures and keep your callback fresh
• useFreshRef – Avoid stale state in callbacks with this hook. Auto updates values using a ref.
• useFreshTick – Like use-fresh-ref but specifically for functions
• useMergeRefs – Merges any number of refs into a single ref
• useRefElement – Helps bridge gap between callback ref and state

• useWindowScrollPosition – A React hook to get the scroll position of the window
• useWindowSize – Window size hook for React.

• useSuspenseNavigatorBattery – Suspense-enabled hook for getting battery status information from Navigator Battery API
• useSuspenseNavigatorUserAgentData – Suspense-enabled hook for getting high entropy values from Navigator User Agent Data API
• useSuspenseLocalStorageState – Suspense-enabled hook for localStorage state management with cross-tab synchronization
• useSuspenseSessionStorageState – Suspense-enabled hook for sessionStorage state management with proper serialization

⚠️ Experimental hooks may be removed or significantly changed in any release without notice. Use with caution in production.

✅ Collection of 99 hooks as standalone modules.

✅ Standalone package with all the hooks at one place

✅ Built for ESM

npm i -s rooks

Import any hook from “rooks” and start using them!

import { useDidMount } from "rooks";

function App() {
  useDidMount(() => {
    alert("mounted");
  });
  return (
    <div className="App">
      <h1>Hello CodeSandbox</h1>
      <h2>Start editing to see some magic happen!</h2>
    </div>
  );
}

Package containing all the hooks is over here. – Docs and Npm Install

MIT

Thanks goes to these wonderful people (emoji key):

Bhargav Ponnapalli 💻 🚧	anil kumar chaudhary 💻	Qiwei Yang 💻 🚧	maciek_grzybek 💻	Harsh Zalavadiya 💻	B V K MAHIJENDRA 💻	Braxton Christensen 💻
Hansel 💻	Harshil Parmar 💻	Lionel 💻	Max Stoiber 💻	Michael Moore 💻	Rajas Paranjpe 💻	Mahendra Choudhary 💻
Nghia Pham 💻	Akshay Kadam (A2K) 💻	Alex Golubtsov 💻	Arman 💻	Branden Visser 💻	Brian Steere 💻	Cal Courtney 💻
Chris Milson 💻	Cong Zhang 💻	Daniel Holmes 💻	Fernando Beck 💻	Josh Davenport 💻	MARCEL 💻	Neilor Caldeira 💻
Tobias Lins 💻	Tsvetan 💻	Wei Zhu 💻	Yakko Majuri 💻	Frank Hellwig 💻	Austin Peterson 💻	thodubois 💻
wes christiansen 💻	CJ Patoilo 💻	mar1u50 💻	Ayushman Gupta 💻	Rafael Ferreira 💻	Kristinn Thor Johannsson 💻	Michael Moore 💻
Trevor Blades 💻	official_dulin 💻	Billy Mosis Priambodo 💻	Stafford Williams 💻	Chanhee Kim 💻	Hooriza 💻	Nils Wittler 💻
Sebastian Szczepański 💻	Mahendra Choudhary 💻	Som Shekhar Mukherjee 💻	Qiushi Pan 💻	Jishnu Viswanath 💻	brahambence 💻	dependabot[bot] 💻
renovate[bot] 💻	dependabot-preview[bot] 💻	github-actions[bot] 💻	allcontributors[bot] 💻	zhangenming 💻	Antoni Kiszka 💻	Greg Poole 💻
mergify[bot] 💻	Chaitanya J 💻	G H Mahimaanvita 💻	Danilo Woznica 💻	dan-klasson 💻	Sébastien Vanvelthem 💻	Aleksandr Soldatov 💻
Eli Yukelzon 💻	Mahendra Choudhary 💻	Chaitanya J 💻	Dominik Dorfmeister 💻	Nghiệp 💻	Seongmin Park 💻	Nate Higgins 💻
Michael Moore 💻	Moritz Brandes 💻	Som Shekhar Mukherjee 💻	cursor[bot] 💻	JulianWielga 💻

These are some libraries that I constantly take inspiration and ideas from

1. React-use
2. React-aria
3. Valtio
4. Jotai
5. Recoil
6. Downshiftjs
7. React hook form

weapp-gulp-service 是一款基于 gulp 实现的微信小程序预编译开发工具，可以有效提升原生小程序的开发效率。主要功能如下所示：

语法增强：

1. 支持 less；
2. 支持 px 自动转 rpx；
3. 支持本地图片转 base64；
4. 支持路径别名 alias；
5. 支持设置环境变量（类似 vue-cli 的 .env 文件）；
6. 支持 json5 语法；
7. 扩展 app.json，支持表达力更好的路由写法；
8. 支持.vue 单文件开发（兼容大部分 v-指令）；

工具特性：

1. 0 配置使用；
2. 支持增量编译；
3. 支持自定义 task；
4. 支持插件扩展（类似 Vue.use）；
5. 支持自动构建 npm（需开启 wxDevtool cli 服务）；
6. 支持命令行上传代码（需集成 miniprogram-ci）；

全局安装并使用：

npm i weapp-gulp-service -g
# 项目根目录执行
wgs --config /user/workspace/xx/weapp.config.js

也可以局部安装并使用：

npm i weapp-gulp-service -D
# 项目根目录执行
npx wgs

项目 Demo 参见 weapp-project （可直接作为开发模版）。

见 docs 目录。

开发模式：

# 编译 + watch
wgs [options]
# 或者
wgs serve [options]

打包模式：

# 仅编译
wgs build [options]

构建 npm

# 生成 miniprogram_npm 目录
wgs build:npm [options]

代码上传:

# 先编译再上传
wgs upload -v 1.0.1 [desc]

ps: 各命令选项可通过 --help 查看

自动构建 npm 与上传代码两个功能前置依赖小程序官方服务——wxdevtool-cli 或者 miniprogram-ci。

如果使用 wxdevtool-cli（以下简称 cli 模式），需设置环境变量：

# macOS
WX_CLI=<安装路径>/Contents/MacOS/cli
# Windows
WX_CLI=<安装路径>/cli.bat

如果使用 miniprogram-ci（以下简称 ci 模式），需设置环境变量：

WE_APP_PRIVATE_KEY_PATH=<私匙路径>/private.xxxx.key

并安装全局依赖 miniprogram-ci；

npm i miniprogram-ci -g

两种方式二选一即可。如果二者同时设置，则 ci 模式优先。

• Why do we need this ESP8266_W5500_Manager library
  • Features
  • Currently supported Boards
• Changelog
• Prerequisites
• Installation
  • Use Arduino Library Manager
  • Manual Install
  • VS Code & PlatformIO
• HOWTO Fix Multiple Definitions Linker Error
• How It Works
• HOWTO Basic configurations
  • 1. Using default for every configurable parameter
  • 2. Using many configurable parameters
  • 3. Using STA-mode DHCP, but don’t like to change to static IP or display in Config Portal
  • 4. Using STA-mode DHCP, but permit to change to static IP and display in Config Portal
  • 5. Using STA-mode StaticIP, and be able to change to DHCP IP and display in Config Portal
  • 6. Using STA-mode StaticIP and configurable DNS, and be able to change to DHCP IP and display in Config Portal
  • 7. Using STA-mode StaticIP and auto DNS, and be able to change to DHCP IP and display in Config Portal
  • 8. Not using NTP to avoid issue with some WebBrowsers, especially in CellPhone or Tablets.
  • 9. Using NTP feature with CloudFlare. System can hang until you have Internet access for CloudFlare.
  • 10. Using NTP feature without CloudFlare to avoid system hang if no Internet access for CloudFlare.
  • 11. Setting STA-mode static IP
  • 12. Using CORS (Cross-Origin Resource Sharing) feature
  • 13. How to auto getting _timezoneName
  • 14. How to get TZ variable to configure Timezone
  • 15. How to use the TZ variable to configure Timezone
• HOWTO Open Config Portal
• HOWTO Add Dynamic Parameters
  • 1. Determine the variables to be configured via Config Portal (CP)
  • 2. Initialize the variables to prepare for Config Portal (CP)
    • 2.1 Use the following simple constructor for simple variables such as thingspeakApiKey, pinSda and pinScl
    • 2.2 For example, to create a new ESP8266_EMParameter object p_thingspeakApiKey for thingspeakApiKey
    • 2.3 Use the more complex following constructor for variables such as sensorDht22
    • 2.4 For example, to create a new ESP8266_EMParameter object p_sensorDht22 for sensorDht22
  • 3. Add the variables to Config Portal (CP)
    • 3.1 addParameter() function Prototype:
    • 3.2 Code to add variables to CP
  • 4. Save the variables configured in Config Portal (CP)
    • 4.1 Getting variables’ data from CP
  • 5. Write to FS (SPIFFS, LittleFS, etc.) using JSON format
    • 5.1 Create a DynamicJsonDocument Object
    • 5.2 Fill the DynamicJsonDocument Object with data got from Config Portal
    • 5.3 Open file to write the Jsonified data
    • 5.4 Write the Jsonified data to CONFIG_FILE
    • 5.5 Close CONFIG_FILE to flush and save the data
  • 6. Read from FS using JSON format
    • 6.1 Open CONFIG_FILE to read
    • 6.2 Open CONFIG_FILE to read
    • 6.3 Populate the just-read Jsonified data into the DynamicJsonDocument json object
    • 6.4 Parse the Jsonified data from the DynamicJsonDocument json object to store into corresponding parameters
    • 6.5 Then what to do now
• So, how it works?
• Documentation
  • Password protect the configuration Access Point
  • Callbacks
    • Save settings
  • ConfigPortal Timeout
  • On Demand ConfigPortal
  • Custom Parameters
  • Custom IP Configuration
    • Custom Station (client) Static IP Configuration
  • Custom HTML, CSS, Javascript
• How to connect W5x00 to ESP8266
• Examples
  • ConfigOnSwitch
  • ConfigOnSwitchFS
  • ConfigOnDoubleReset_TZ (now support ArduinoJson 6.0.0+ as well as 5.13.5-)
  • ConfigOnDoubleReset (now support ArduinoJson 6.0.0+ as well as 5.13.5-)
  • ConfigPortalParamsOnSwitch (now support ArduinoJson 6.0.0+ as well as 5.13.5-)
  • ESP8266_FSWebServer
  • ESP8266_FSWebServer_DRD
• Example ConfigOnSwitch
• Debug Terminal Output Samples
  • 1. ConfigOnDoubleReset_TZ using LittleFS on ESP8266_DEV with ESP8266_W5500
  • 2. ConfigOnSwichFS using LittleFS on ESP8266_DEV with ESP8266_W5500
  • 3. ESP8266_FSWebServer_DRD using LittleFS on ESP8266_DEV with ESP8266_W5500
• Debug
• Troubleshooting
• Issues
• Contributions and Thanks
• Contributing
• License and credits
• Copyright

This is an ESP8266 + LwIP W5500 Credentials and Connection Manager with fallback Web ConfigPortal. This Library is used for configuring ESP8266 Ethernet Static / DHCP and Credentials at runtime. You can specify static DNS servers, personalized HostName and CORS feature.

This library is based on, modified and improved from:

1. Khoi Hoang's ESP_WiFiManager

This ESP8266_W5500_Manager library currently supports these following boards:

1. ESP8266 boards using LwIP W5500 Ethernet

1. Arduino IDE 1.8.19+ for Arduino.
2. ESP8266 Core 3.0.2+ for ESP8266-based boards.
3. ESP_DoubleResetDetector v1.3.2+ if using DRD feature. To install, check . Use v1.1.0+ if using LittleFS for ESP8266 v1.0.6+.

The best and easiest way is to use Arduino Library Manager. Search for ESP8266_W5500_Manager, then select / install the latest version. You can also use this link for more detailed instructions.

1. Navigate to ESP8266_W5500_Manager page.
2. Download the latest release ESP8266_W5500_Manager-main.zip.
3. Extract the zip file to ESP8266_W5500_Manager-main directory
4. Copy the whole ESP8266_W5500_Manager-main folder to Arduino libraries’ directory such as ~/Arduino/libraries/.

1. Install VS Code
2. Install PlatformIO
3. Install ESP8266_W5500_Manager library by using Library Manager. Search for ESP8266_W5500_Manager in Platform.io Author’s Libraries
4. Use included platformio.ini file from examples to ensure that all dependent libraries will installed automatically. Please visit documentation for the other options and examples at Project Configuration File

The current library implementation, using xyz-Impl.h instead of standard xyz.cpp, possibly creates certain Multiple Definitions Linker error in certain use cases.

You can use

#include <ESP8266_W5500_Manager.hpp>               //https://github.com/khoih-prog/ESP8266_W5500_Manager

in many files. But be sure to use the following #include <ESP8266_W5500_Manager.h> in just 1 .h, .cpp or .ino file, which must not be included in any other file, to avoid Multiple Definitions Linker Error

// To be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error
#include <ESP8266_W5500_Manager.h>          //https://github.com/khoih-prog/ESP8266_W5500_Manager

Have a look at the discussion in Different behaviour using the src_cpp or src_h lib #80

• The ConfigOnSwitch example shows how it works and should be used as the basis for a sketch that uses this library.
• The concept of ConfigOnSwitch is that a new ESP8266 will start a ConfigPortal when powered up and save the configuration data in non volatile memory. Thereafter, the ConfigPortal will only be started again if a button is pushed on the ESP8266 module.
• Using any network-enabled device with a browser (computer, phone, tablet) connect to the newly created Access Point (AP) (Dynamic or Static IP specified in sketch)

then connect WebBrowser to configurable ConfigPortal IP address, e.g. 192.168.186

• Include in your sketch

#include <FS.h>

#include <ESP8266WiFi.h>          //https://github.com/esp8266/Arduino
//needed for library
#include <DNSServer.h>

#define USE_LITTLEFS      true

#if USE_LITTLEFS
  #include <LittleFS.h>
  FS* filesystem =      &LittleFS;
  #define FileFS        LittleFS
  #define FS_Name       "LittleFS"
#else
  FS* filesystem =      &SPIFFS;
  #define FileFS        SPIFFS
  #define FS_Name       "SPIFFS"
#endif

//////////////////////////////////////////////////////////

#define ESP_getChipId()   (ESP.getChipId())

#define LED_ON      LOW
#define LED_OFF     HIGH

//////////////////////////////////////////////////////////

// You only need to format the filesystem once
//#define FORMAT_FILESYSTEM       true
#define FORMAT_FILESYSTEM         false

////////////////////////////////////////////////////

#include <ESP8266_W5500_Manager.h>               //https://github.com/khoih-prog/ESP8266_W5500_Manager

#define HTTP_PORT     80

• Include in your sketch

#include <FS.h>

#include <ESP8266WiFi.h>          //https://github.com/esp8266/Arduino
//needed for library
#include <DNSServer.h>

#define USE_LITTLEFS      true

#if USE_LITTLEFS
  #include <LittleFS.h>
  FS* filesystem =      &LittleFS;
  #define FileFS        LittleFS
  #define FS_Name       "LittleFS"
#else
  FS* filesystem =      &SPIFFS;
  #define FileFS        SPIFFS
  #define FS_Name       "SPIFFS"
#endif

//////////////////////////////////////////////////////////

#define ESP_getChipId()   (ESP.getChipId())

#define LED_ON      LOW
#define LED_OFF     HIGH

//////////////////////////////////////////////////////////////

// You only need to format the filesystem once
//#define FORMAT_FILESYSTEM       true
#define FORMAT_FILESYSTEM         false

//////////////////////////////////////////////////////////////

// Assuming max 49 chars
#define TZNAME_MAX_LEN            50
#define TIMEZONE_MAX_LEN          50

typedef struct
{
  char TZ_Name[TZNAME_MAX_LEN];     // "America/Toronto"
  char TZ[TIMEZONE_MAX_LEN];        // "EST5EDT,M3.2.0,M11.1.0"
  uint16_t checksum;
} EthConfig;

EthConfig         Ethconfig;

//////////////////////////////////////////////////////////////

#define  CONFIG_FILENAME              F("/eth_cred.dat")

//////////////////////////////////////////////////////////////

// Indicates whether ESP has credentials saved from previous session, or double reset detected
bool initialConfig = false;

// Use false if you don't like to display Available Pages in Information Page of Config Portal
// Comment out or use true to display Available Pages in Information Page of Config Portal
// Must be placed before #include <ESP8266_W5500_Manager.h>
#define USE_AVAILABLE_PAGES     true

// From v1.0.10 to permit disable/enable StaticIP configuration in Config Portal from sketch. Valid only if DHCP is used.
// You'll loose the feature of dynamically changing from DHCP to static IP, or vice versa
// You have to explicitly specify false to disable the feature.
//#define USE_STATIC_IP_CONFIG_IN_CP          false

// Use false to disable NTP config. Advisable when using Cellphone, Tablet to access Config Portal.
// See Issue 23: On Android phone ConfigPortal is unresponsive (https://github.com/khoih-prog/ESP_WiFiManager/issues/23)
#define USE_ESP_ETH_MANAGER_NTP     true

// Just use enough to save memory. On ESP8266, can cause blank ConfigPortal screen
// if using too much memory
#define USING_AFRICA        false
#define USING_AMERICA       true
#define USING_ANTARCTICA    false
#define USING_ASIA          false
#define USING_ATLANTIC      false
#define USING_AUSTRALIA     false
#define USING_EUROPE        false
#define USING_INDIAN        false
#define USING_PACIFIC       false
#define USING_ETC_GMT       false

// Use true to enable CloudFlare NTP service. System can hang if you don't have Internet access while accessing CloudFlare
// See Issue #21: CloudFlare link in the default portal (https://github.com/khoih-prog/ESP_WiFiManager/issues/21)
#define USE_CLOUDFLARE_NTP          false

// New in v1.0.11
#define USING_CORS_FEATURE          true

//////////////////////////////////////////////////////////////

// Use USE_DHCP_IP == true for dynamic DHCP IP, false to use static IP which you have to change accordingly to your network
#if (defined(USE_STATIC_IP_CONFIG_IN_CP) && !USE_STATIC_IP_CONFIG_IN_CP)
  // Force DHCP to be true
  #if defined(USE_DHCP_IP)
    #undef USE_DHCP_IP
  #endif
  #define USE_DHCP_IP     true
#else
  // You can select DHCP or Static IP here
  //#define USE_DHCP_IP     true
  #define USE_DHCP_IP     false
#endif

#if ( USE_DHCP_IP )
  // Use DHCP

  #if (_ESP8266_ETH_MGR_LOGLEVEL_ > 3)
    #warning Using DHCP IP
  #endif

  IPAddress stationIP   = IPAddress(0, 0, 0, 0);
  IPAddress gatewayIP   = IPAddress(192, 168, 2, 1);
  IPAddress netMask     = IPAddress(255, 255, 255, 0);

#else
  // Use static IP

  #if (_ESP8266_ETH_MGR_LOGLEVEL_ > 3)
    #warning Using static IP
  #endif

  IPAddress stationIP   = IPAddress(192, 168, 2, 186);
  IPAddress gatewayIP   = IPAddress(192, 168, 2, 1);
  IPAddress netMask     = IPAddress(255, 255, 255, 0);
#endif

//////////////////////////////////////////////////////////////

#define USE_CONFIGURABLE_DNS      true

IPAddress dns1IP      = gatewayIP;
IPAddress dns2IP      = IPAddress(8, 8, 8, 8);

#include <ESP8266_W5500_Manager.h>               //https://github.com/khoih-prog/ESP8266_W5500_Manager

#define HTTP_PORT     80

//////////////////////////////////////////////////////////////

/******************************************
   // Defined in ESP8266_W5500_Manager.hpp
  typedef struct
  {
    IPAddress _sta_static_ip;
    IPAddress _sta_static_gw;
    IPAddress _sta_static_sn;
    #if USE_CONFIGURABLE_DNS
    IPAddress _sta_static_dns1;
    IPAddress _sta_static_dns2;
    #endif
  }  ETH_STA_IPConfig;
******************************************/

ETH_STA_IPConfig EthSTA_IPconfig;

// You'll loose the feature of dynamically changing from DHCP to static IP, or vice versa
// You have to explicitly specify false to disable the feature.
#define USE_STATIC_IP_CONFIG_IN_CP          false

// You'll loose the feature of dynamically changing from DHCP to static IP, or vice versa
// You have to explicitly specify false to disable the feature.
//#define USE_STATIC_IP_CONFIG_IN_CP          false

// Use USE_DHCP_IP == true for dynamic DHCP IP, false to use static IP which you have to change accordingly to your network
#if (defined(USE_STATIC_IP_CONFIG_IN_CP) && !USE_STATIC_IP_CONFIG_IN_CP)
  // Force DHCP to be true
  #if defined(USE_DHCP_IP)
    #undef USE_DHCP_IP
  #endif
  #define USE_DHCP_IP     true
#else
  // You can select DHCP or Static IP here
  #define USE_DHCP_IP     true
#endif

// You'll loose the feature of dynamically changing from DHCP to static IP, or vice versa
// You have to explicitly specify false to disable the feature.
//#define USE_STATIC_IP_CONFIG_IN_CP          false

// Use USE_DHCP_IP == true for dynamic DHCP IP, false to use static IP which you have to change accordingly to your network
#if (defined(USE_STATIC_IP_CONFIG_IN_CP) && !USE_STATIC_IP_CONFIG_IN_CP)
// Force DHCP to be true
  #if defined(USE_DHCP_IP)
    #undef USE_DHCP_IP
  #endif
  #define USE_DHCP_IP     true
#else
  // You can select DHCP or Static IP here
  #define USE_DHCP_IP     false
#endif

// You'll loose the feature of dynamically changing from DHCP to static IP, or vice versa
// You have to explicitly specify false to disable the feature.
//#define USE_STATIC_IP_CONFIG_IN_CP          false

// Use USE_DHCP_IP == true for dynamic DHCP IP, false to use static IP which you have to change accordingly to your network
#if (defined(USE_STATIC_IP_CONFIG_IN_CP) && !USE_STATIC_IP_CONFIG_IN_CP)
  // Force DHCP to be true
  #if defined(USE_DHCP_IP)
    #undef USE_DHCP_IP
  #endif
  #define USE_DHCP_IP     true
#else
  // You can select DHCP or Static IP here
  #define USE_DHCP_IP     false
#endif

#define USE_CONFIGURABLE_DNS      true

IPAddress dns1IP      = gatewayIP;
IPAddress dns2IP      = IPAddress(8, 8, 8, 8);

// You'll loose the feature of dynamically changing from DHCP to static IP, or vice versa
// You have to explicitly specify false to disable the feature.
//#define USE_STATIC_IP_CONFIG_IN_CP          false

// Use USE_DHCP_IP == true for dynamic DHCP IP, false to use static IP which you have to change accordingly to your network
#if (defined(USE_STATIC_IP_CONFIG_IN_CP) && !USE_STATIC_IP_CONFIG_IN_CP)
  // Force DHCP to be true
  #if defined(USE_DHCP_IP)
    #undef USE_DHCP_IP
  #endif
  #define USE_DHCP_IP     true
#else
  // You can select DHCP or Static IP here
  #define USE_DHCP_IP     false
#endif

#define USE_CONFIGURABLE_DNS      false

// Use false to disable NTP config. Advisable when using Cellphone, Tablet to access Config Portal.
// See Issue 23: On Android phone ConfigPortal is unresponsive (https://github.com/khoih-prog/ESP_WiFiManager/issues/23)
#define USE_ESP_ETH_MANAGER_NTP     false

// Use false to disable NTP config. Advisable when using Cellphone, Tablet to access Config Portal.
// See Issue 23: On Android phone ConfigPortal is unresponsive (https://github.com/khoih-prog/ESP_WiFiManager/issues/23)
#define USE_ESP_ETH_MANAGER_NTP     true

// Use true to enable CloudFlare NTP service. System can hang if you don't have Internet access while accessing CloudFlare
// See Issue #21: CloudFlare link in the default portal (https://github.com/khoih-prog/ESP_WiFiManager/issues/21)
#define USE_CLOUDFLARE_NTP          true

// Use false to disable NTP config. Advisable when using Cellphone, Tablet to access Config Portal.
// See Issue 23: On Android phone ConfigPortal is unresponsive (https://github.com/khoih-prog/ESP_WiFiManager/issues/23)
#define USE_ESP_ETH_MANAGER_NTP     true

// Use true to enable CloudFlare NTP service. System can hang if you don't have Internet access while accessing CloudFlare
// See Issue #21: CloudFlare link in the default portal (https://github.com/khoih-prog/ESP_WiFiManager/issues/21)
#define USE_CLOUDFLARE_NTP          false

//ESP8266_W5500_manager.setSTAStaticIPConfig(stationIP, gatewayIP, netMask, dns1IP, dns2IP);
ESP8266_W5500_manager.setSTAStaticIPConfig(WM_STA_IPconfig);

1. To use CORS feature with default CORS Header ““. Some WebBrowsers won’t accept this allowing-all “” CORS Header.

// Default false for using only whenever necessary to avoid security issue
#define USING_CORS_FEATURE     true

2. To use CORS feature with specific CORS Header “Your Access-Control-Allow-Origin”. To be modified according to your specific Allowed-Origin.

// Default false for using only whenever necessary to avoid security issue
#define USING_CORS_FEATURE     true

...

#if USING_CORS_FEATURE
  ESP_wifiManager.setCORSHeader("Your Access-Control-Allow-Origin");
#endif

3. Not use CORS feature (default)

// Default false for using only whenever necessary to avoid security issue
#define USING_CORS_FEATURE     false

1. Turn on auto NTP configuration by

// Use false to disable NTP config. Advisable when using Cellphone, Tablet to access Config Portal.
// See Issue 23: On Android phone ConfigPortal is unresponsive (https://github.com/khoih-prog/ESP_WiFiManager/issues/23)
#define USE_ESP_ETH_MANAGER_NTP     true

2. The _timezoneName, in the format similar to America/New_York, America/Toronto, Europe/London, etc., can be retrieved by using

String tempTZ = ESP8266_W5500_manager.getTimezoneName();

1. ESP8266 TZ can be configured, using the similar to EST5EDT,M3.2.0,M11.1.0 (for America/New_York) , as follows:

// EST5EDT,M3.2.0,M11.1.0 (for America/New_York)
// EST5EDT is the name of the time zone
// EST is the abbreviation used when DST is off
// 6 hours is the time difference from GMT
// EDT is the abbreviation used when DST is on
// ,M3 is the third month
// .2 is the second occurrence of the day in the month
// .0 is Sunday
// ,M11 is the eleventh month
// .1 is the first occurrence of the day in the month
// .0 is Sunday

configTime(Ethconfig.TZ, "pool.ntp.org");

2. To convert from _timezoneName to TZ, use the function getTZ() as follows:

const char * TZ_Result = ESP8266_W5500_manager.getTZ(_timezoneName);

The conversion depends on the stored TZs, which is using some memory, and can cause issue for ESP8266 in certain cases. Therefore, enable just the region you’re interested.

For example, your application is used in America continent, you need just

#define USING_AMERICA       true

Hereafter is the regions’ list

// Just use enough to save memory. On ESP8266, can cause blank ConfigPortal screen
// if using too much memory
#define USING_AFRICA        false
#define USING_AMERICA       true
#define USING_ANTARCTICA    false
#define USING_ASIA          false
#define USING_ATLANTIC      false
#define USING_AUSTRALIA     false
#define USING_EUROPE        false
#define USING_INDIAN        false
#define USING_PACIFIC       false
#define USING_ETC_GMT       false

configTime(Ethconfig.TZ, "pool.ntp.org");

then to print local time

void printLocalTime()
{
  static time_t now;

  now = time(nullptr);

  if ( now > 1451602800 )
  {
    Serial.print("Local Date/Time: ");
    Serial.print(ctime(&now));
  }
}

• When you want to open a config portal, with default DHCP hostname ESP8266-XXXXXX, just add

#include <ESP8266_W5500_Manager.h>              //https://github.com/khoih-prog/ESP8266_W5500_Manager

#define HTTP_PORT           80

WebServer webServer(HTTP_PORT);

ESP8266_W5500_Manager ESP8266_W5500_manager();

If you’d like to have a personalized hostname (RFC952-conformed,- 24 chars max,- only a..z A..Z 0..9 '-' and no '-' as last char)

add

ESP8266_W5500_Manager ESP8266_W5500_manager("Personalized-HostName");

then later call

ESP8266_W5500_manager.startConfigPortal()

While in Config Portal, connect to it using its AP IP, e.g. 192.168.2.186, configure Credentials, then save. The settings will be saved in non volatile memory. It will then reboot and autoconnect.

These illustrating steps is based on the example ConfigOnSwitchFS

The application will:

• use DHT sensor (either DHT11 or DHT22) and
• need to connect to ThingSpeak with unique user’s API Key.

The DHT sensor is connected to the ESP boards using SDA/SCL pins which also need to be configurable.

So this is the list of variables to be dynamically configured using CP

1. `thingspeakApiKey`,  type `char array`, max length 17 chars, and just arbitrarily selected default value to be "" or "ThingSpeak-APIKey"
2. `sensorDht22`,       type `bool`, default to be `true` (DHT22)
3. `pinSda`,            type `int`,  default to be `PIN_D2`
4. `pinScl`,            type `int`,  default to be `PIN_D1`

The Label can be any arbitrary string that help you identify the variable, but must be unique in your application

The initial code will be

#define API_KEY_LEN                 17

// Default configuration values
char thingspeakApiKey[API_KEY_LEN]  = "";
bool sensorDht22                    = true;
int pinSda                          = PIN_D2;     // Pin D2 mapped to pin GPIO4 of ESP8266
int pinScl                          = PIN_D1;     // Pin D1 mapped to pin GPIO5 of ESP8266

// Any unique string helping you identify the vars
#define ThingSpeakAPI_Label         "thingspeakApiKey"
#define SensorDht22_Label           "SensorDHT22"
#define PinSDA_Label                "PinSda"
#define PinSCL_Label                "PinScl"

The example ConfigOnSwitchFS will open the CP whenever a SW press is detected in loop(). So the code to add dynamic variables will be there, just after the CP ESP8266_W5500_Manager class initialization to create ESP8266_W5500_Manager object.

void loop()
{
// is configuration portal requested?
  if ((digitalRead(TRIGGER_PIN) == LOW) || (digitalRead(TRIGGER_PIN2) == LOW))
  {
    Serial.println("\nConfiguration portal requested.");
    digitalWrite(LED_BUILTIN, LED_ON); // turn the LED on by making the voltage LOW to tell us we are in configuration mode.

    //Local initialization. Once its business is done, there is no need to keep it around
    ESP8266_W5500_Manager ESP8266_W5500_manager("ConfigOnSwitchFS");

    //Check if there is stored WiFi router/password credentials.
    //If not found, device will remain in configuration mode until switched off via webserver.
    Serial.print("Opening configuration portal. ");
    
    ...
    
    // The addition of dynamic vars will be somewhere here
    
}    

The ESP8266_EMParameter class constructor will be used to initialize each newly-added parameter object.

ESP8266_EMParameter(const char *id, const char *placeholder, const char *defaultValue, int length);

The command to use will be

ESP8266_EMParameter p_thingspeakApiKey(ThingSpeakAPI_Label, "Thingspeak API Key", thingspeakApiKey, API_KEY_LEN);

where

- p_thingspeakApiKey                  : ESP8266_EMParameter class object reference that stores the new Custom Parameter
- id => ThingSpeakAPI_Label           : var ref to Json associative name and HTML element ID for the new Custom Paramerter you just defined in step 1
- placeholder => "Thingspeak API Key" : HTML input placeholder and/or label element text the user sees in the configuration interface for this Custom Parameter
- defaultValue => thingspeakApiKey    : variable for storing the value of your Custom Parameter in the file system or default value when no data is entered
- length  => API_KEY_LEN              : max allowed length you want for this Custom Parameter to have

For pinSda and pinScl, the command will be similar

// I2C SCL and SDA parameters are integers so we need to convert them to char array but
// no other special considerations
char convertedValue[3];
sprintf(convertedValue, "%d", pinSda);
ESP8266_EMParameter p_pinSda(PinSDA_Label, "I2C SDA pin", convertedValue, 3);

sprintf(convertedValue, "%d", pinScl);
ESP8266_EMParameter p_pinScl(PinSCL_Label, "I2C SCL pin", convertedValue, 3);

where

- p_pinSda / p_pinScl                         : ESP8266_EMParameter class object reference that stores the new Custom Parameter
- id => PinSDA_Label/PinSCL_Label             : var ref to Json associative name and HTML element ID for the new Custom Paramerter you just defined in step 1
- placeholder => "I2C SDA pin"https://github.com/"I2C SCL pin"  : HTML input placeholder and/or label element text the user sees in the configuration interface for this Custom Parameter
- defaultValue => convertedValue              : variable for storing the value of your Custom Parameter in the file system or default value when no data is entered
- length  => 3                                : max allowed length you want for this Custom Parameter to have

ESP8266_EMParameter(const char *id, const char *placeholder, const char *defaultValue, int length, const char *custom, int labelPlacement);

The command to use will be

ESP8266_EMParameter p_sensorDht22(SensorDht22_Label, "DHT-22 Sensor", "T", 2, customhtml, WFM_LABEL_AFTER);

where

- p_sensorDht22                       : ESP8266_EMParameter class object reference that stores the new Custom Parameter
- id => SensorDht22_Label             : var ref to Json associative name and HTML element ID for the new Custom Paramerter you just defined in step 1
- placeholder => "DHT-22 Sensor"      : HTML input placeholder and/or label element text the user sees in the configuration interface for this Custom Parameter
- defaultValue => "T"                 : variable for storing the value of your Custom Parameter in the file system or default value when no data is entered ("T" means `true`)
- length  => 2                        : max allowed length you want for this Custom Parameter to have
- custom => customhtml                : custom HTML code to add element type, e.g. `checkbox`, and `checked` when `sensorDht22 == true`
- labelPlacement => WFM_LABEL_AFTER   : to place label after

and customhtml Code is:

char customhtml[24] = "type=\"checkbox\"";

if (sensorDht22)
{
  strcat(customhtml, " checked");
}

Adding those ESP8266_EMParameter objects created in Step 2 using the function addParameter() of object ESP8266_W5500_Manager

//adds a custom parameter
bool addParameter(ESP8266_EMParameter *p);

Add parameter objects, previously created in Step 2, such as : p_thingspeakApiKey, p_sensorDht22, p_pinSda and p_pinScl

//add all parameters here

ESP8266_W5500_manager.addParameter(&p_thingspeakApiKey);
ESP8266_W5500_manager.addParameter(&p_sensorDht22);
ESP8266_W5500_manager.addParameter(&p_pinSda);
ESP8266_W5500_manager.addParameter(&p_pinScl);

When the CP exits, we have to store the parameters’ values that users input via CP to use later.

For ESP8266, that can be EEPROM or SPIFFS.

We can write directly to a well-defined structure of our choice, but the current example is using JSON to be portable but much more complicated and not advised for new users.

After users select Save, the CP ESP8266_W5500_Manager object will save the user input data into related ESP8266_EMParameter objects.

We can now retrieve the data, using getValue() function, for each ESP8266_EMParameter object. Then we can utilize the data for our purpose, such as thingspeakApiKey to log in, sensorDht22 type to know how to handle the sensor, pinSda and pinSda to know which pins to use to communicate with the DHT sensor.

The code is as follows:

// Getting posted form values and overriding local variables parameters
// Config file is written regardless the connection state
strcpy(thingspeakApiKey, p_thingspeakApiKey.getValue());
sensorDht22 = (strncmp(p_sensorDht22.getValue(), "T", 1) == 0);
pinSda = atoi(p_pinSda.getValue());
pinScl = atoi(p_pinScl.getValue());

We can also save to FS file to use later in next boot.

// Writing JSON config file to flash for next boot
writeConfigFile();

First, you have to familiarize yourself with ArduinoJson library, its functions, the disruptive differences between ArduinoJson version 5.x.x- and v6.0.0+. The best documentation can be found at The best JSON library for embedded C++.

This documentation will discuss only ArduinoJson v6.x.x+ (ARDUINOJSON_VERSION_MAJOR >= 6)

Then have a look at the code snippet of writeConfigFile() function and the following step-by-step explanations.

bool writeConfigFile()
{
  Serial.println("Saving config file");

#if (ARDUINOJSON_VERSION_MAJOR >= 6)
  DynamicJsonDocument json(1024);
#else
  DynamicJsonBuffer jsonBuffer;
  JsonObject& json = jsonBuffer.createObject();
#endif

  // JSONify local configuration parameters
  json[ThingSpeakAPI_Label] = thingspeakApiKey;
  json[SensorDht22_Label] = sensorDht22;
  json[PinSDA_Label] = pinSda;
  json[PinSCL_Label] = pinScl;

  // Open file for writing
  File f = FileFS.open(CONFIG_FILE, "w");

  if (!f)
  {
    Serial.println("Failed to open config file for writing");
    return false;
  }

#if (ARDUINOJSON_VERSION_MAJOR >= 6)
  serializeJsonPretty(json, Serial);
  // Write data to file and close it
  serializeJson(json, f);
#else
  json.prettyPrintTo(Serial);
  // Write data to file and close it
  json.printTo(f);
#endif

  f.close();

  Serial.println("\nConfig file was successfully saved");
  return true;
}

We’ll create an object with size 1024 bytes, enough to hold our data:

DynamicJsonDocument json(1024);

Then JSONify all local parameters we’ve just received from CP and wish to store into FS by using the function prototype:

json[Unique_Label] = Value_For_Unique_Label;

as follows:

// JSONify local configuration parameters
json[ThingSpeakAPI_Label] = thingspeakApiKey;
json[SensorDht22_Label]   = sensorDht22;
json[PinSDA_Label]        = pinSda;
json[PinSCL_Label]        = pinScl;

This is the CONFIG_FILE file name we already declared at the beginning of the sketch (for ESP8266):

#include <SPIFFS.h>
FS* filesystem =      &SPIFFS;
#define FileFS        SPIFFS
    
const char* CONFIG_FILE = "/ConfigSW.json";

Now just open the file for writing, and abort if open-for-writing error:

// Open file for writing
File f = FileFS.open(CONFIG_FILE, "w");

if (!f)
{
  Serial.println("Failed to open config file for writing");
  return false;
}

As simple as this single command to write the whole json object we declared then filled with data in steps 5.1 and 5.2

// Write data to file and close it
serializeJson(json, f);

Soooo simple !!! Now everybody can do it.

f.close();

But HOWTO use the saved data in the next startup ???? That’s in next step 6.

Now, you have familiarized yourself with ArduinoJson library, its functions. We’ll discuss HOWTO read data from the CONFIG_FILE in Jsonified format, then HOWTO parse the to use.

The documentation will discuss only ArduinoJson v6.x.x+ (ARDUINOJSON_VERSION_MAJOR >= 6)

First, have a look at the code snippet of readConfigFile() function.

bool readConfigFile()
{
  // this opens the config file in read-mode
  File f = FileFS.open(CONFIG_FILE, "r");

  if (!f)
  {
    Serial.println("Configuration file not found");
    return false;
  }
  else
  {
    // we could open the file
    size_t size = f.size();
    // Allocate a buffer to store contents of the file.
    std::unique_ptr<char[]> buf(new char[size + 1]);

    // Read and store file contents in buf
    f.readBytes(buf.get(), size);
    // Closing file
    f.close();
    // Using dynamic JSON buffer which is not the recommended memory model, but anyway
    // See https://github.com/bblanchon/ArduinoJson/wiki/Memory%20model

#if (ARDUINOJSON_VERSION_MAJOR >= 6)
    DynamicJsonDocument json(1024);
    auto deserializeError = deserializeJson(json, buf.get());
    if ( deserializeError )
    {
      Serial.println("JSON parseObject() failed");
      return false;
    }
    serializeJson(json, Serial);
#else
    DynamicJsonBuffer jsonBuffer;
    // Parse JSON string
    JsonObject& json = jsonBuffer.parseObject(buf.get());
    // Test if parsing succeeds.
    if (!json.success())
    {
      Serial.println("JSON parseObject() failed");
      return false;
    }
    json.printTo(Serial);
#endif

    // Parse all config file parameters, override
    // local config variables with parsed values
    if (json.containsKey(ThingSpeakAPI_Label))
    {
      strcpy(thingspeakApiKey, json[ThingSpeakAPI_Label]);
    }

    if (json.containsKey(SensorDht22_Label))
    {
      sensorDht22 = json[SensorDht22_Label];
    }

    if (json.containsKey(PinSDA_Label))
    {
      pinSda = json[PinSDA_Label];
    }

    if (json.containsKey(PinSCL_Label))
    {
      pinScl = json[PinSCL_Label];
    }
  }
  Serial.println("\nConfig file was successfully parsed");
  return true;
}

and the following step-by-step explanations.

As simple as this

// this opens the config file in read-mode
File f = FileFS.open(CONFIG_FILE, "r");

We’ll inform and abort if the CONFIG_FILE can’t be opened (file not found, can’t be opened, etc.)

if (!f)
{
  Serial.println("Configuration file not found");
  return false;
}

Now we have to determine the file size to create a buffer large enough to store the to-be-read data

// we could open the file
size_t size = f.size();
// Allocate a buffer to store contents of the file.
std::unique_ptr<char[]> buf(new char[size + 1]);

Remember always add 1 to the buffer length to store the terminating 0.

Then just read the file into the buffer, and close the file to be safe

// Read and store file contents in buf
f.readBytes(buf.get(), size);
// Closing file
f.close();

We again use the same DynamicJsonDocument json object to store the data we’ve just read from CONFIG_FILE.

Why the same complicated DynamicJsonDocument json object ?? Because in steps 5, we did store Jsonified data using the same DynamicJsonDocument json object. It’s much easier we now use it again to facilitate the parsing of Jsonified data back to the data we can use easily.

We first create the object with enough size

DynamicJsonDocument json(1024);

then populate it with data from buffer we read from CONFIG_FILE in step 6.2, pre-parse and check for error. All is done just by one command deserializeJson()

auto deserializeError = deserializeJson(json, buf.get());

Abort if there is any data error in the process of writing, storing, reading back. If OK, just nicely print out to the Debug Terminal

if ( deserializeError )
{
  Serial.println("JSON parseObject() failed");
  return false;
}

serializeJson(json, Serial);

This is as simple as in the step 5.2, but in reverse direction.

To be sure there is good corresponding data, not garbage, for each variable, we have to perform sanity checks by verifying the DynamicJsonDocument json object still contains the correct keys we passed to it when we wrote into CONFIG_FILE.

For example:

if (json.containsKey(ThingSpeakAPI_Label))

Then proceed to get every parameter we know we stored there from last CP Save.

// Parse all config file parameters, override
// local config variables with parsed values
if (json.containsKey(ThingSpeakAPI_Label))
{
  strcpy(thingspeakApiKey, json[ThingSpeakAPI_Label]);
}

if (json.containsKey(SensorDht22_Label))
{
  sensorDht22 = json[SensorDht22_Label];
}

if (json.containsKey(PinSDA_Label))
{
  pinSda = json[PinSDA_Label];
}

if (json.containsKey(PinSCL_Label))
{
  pinScl = json[PinSCL_Label];
}

Just use those parameters for whatever purpose you designed them for in step 1:

The application will use DHT sensor (either DHT11 or DHT22) and need to connect to ThingSpeak with unique user's API Key. The DHT sensor is connected to the ESP boards using SDA/SCL pins which also need to be configurable.

In ConfigPortal Mode, it starts an access point @ the current Static or DHCP IP.

Connect to it by going to, e.g. http://192.168.2.186, you’ll see this Main page:

Select Information to enter the Info page where the board info will be shown (long page)

Select Configuration to enter this page where you can modify its Credentials

Enter your credentials, then click Save. The Credentials will be saved and the board continues, or reboots if necessary, to connect to the selected Static IP or DHCP.

If you’re already satisfied with the current settings and don’t want to change anything, just select Exit Portal from the Main page to continue or reboot the board and connect using the previously-stored Credentials.

You can password protect the ConfigPortal AP. Check ESP8266_FSWebServer example

This gets called when custom parameters have been set AND a connection has been established. Use it to set a flag, so when all the configuration finishes, you can save the extra parameters somewhere.

See ConfigOnSwitchFS Example.

ESP8266_W5500_manager.setSaveConfigCallback(saveConfigCallback);

saveConfigCallback declaration and example

//flag for saving data
bool shouldSaveConfig = false;

//callback notifying us of the need to save config
void saveConfigCallback () 
{
  Serial.println("Should save config");
  shouldSaveConfig = true;
}

If you need to set a timeout so the ESP8266 doesn’t hang waiting to be configured for ever.

ESP8266_W5500_manager.setConfigPortalTimeout(120);

which will wait 2 minutes (120 seconds). When the time passes, the startConfigPortal() function will return and continue the sketch, unless you’re accessing the Config Portal. In this case, the startConfigPortal() function will stay until you save config data or exit the Config Portal.

Example usage

void loop()
{
  // is configuration portal requested?
  if ((digitalRead(TRIGGER_PIN) == LOW) || (digitalRead(TRIGGER_PIN2) == LOW))
  {
    Serial.println(F("\nConfiguration portal requested."));
    digitalWrite(LED_BUILTIN, LED_ON); // turn the LED on by making the voltage LOW to tell us we are in configuration mode.

    //Local initialization. Once its business is done, there is no need to keep it around
    // Use this to default DHCP hostname to ESP8266-XXXXXX
    //ESP8266_W5500_Manager ESP8266_W5500_manager;
    // Use this to personalize DHCP hostname (RFC952 conformed)
    ESP8266_W5500_Manager ESP8266_W5500_manager("ConfigOnSwitch");

#if !USE_DHCP_IP
#if USE_CONFIGURABLE_DNS
    // Set static IP, Gateway, Subnetmask, DNS1 and DNS2
    ESP8266_W5500_manager.setSTAStaticIPConfig(stationIP, gatewayIP, netMask, dns1IP, dns2IP);
#else
    // Set static IP, Gateway, Subnetmask, Use auto DNS1 and DNS2.
    ESP8266_W5500_manager.setSTAStaticIPConfig(stationIP, gatewayIP, netMask);
#endif
#endif

#if USING_CORS_FEATURE
    ESP8266_W5500_manager.setCORSHeader("Your Access-Control-Allow-Origin");
#endif

    //Check if there is stored credentials.
    //If not found, device will remain in configuration mode until switched off via webserver.
    Serial.println(F("Opening configuration portal. "));

    if (loadConfigData())
    {
      //If no access point name has been previously entered disable timeout.
      ESP8266_W5500_manager.setConfigPortalTimeout(120);

      Serial.println(F("Got stored Credentials. Timeout 120s for Config Portal"));
    }
    else
    {
      // Enter CP only if no stored SSID on flash and file
      ESP8266_W5500_manager.setConfigPortalTimeout(0);
      Serial.println(F("Open Config Portal without Timeout: No stored Credentials."));
      initialConfig = true;
    }

    //Starts an access point
    //and goes into a blocking loop awaiting configuration
    if (!ESP8266_W5500_manager.startConfigPortal())
      Serial.println(F("Not connected to ETH network but continuing anyway."));
    else
    {
      Serial.println(F("ETH network connected...yeey :)"));
      Serial.print(F("Local IP: "));
      Serial.println(eth.localIP());
    }

#if USE_ESP_ETH_MANAGER_NTP
    String tempTZ = ESP8266_W5500_manager.getTimezoneName();

    if (strlen(tempTZ.c_str()) < sizeof(Ethconfig.TZ_Name) - 1)
      strcpy(Ethconfig.TZ_Name, tempTZ.c_str());
    else
      strncpy(Ethconfig.TZ_Name, tempTZ.c_str(), sizeof(Ethconfig.TZ_Name) - 1);

    const char * TZ_Result = ESP8266_W5500_manager.getTZ(Ethconfig.TZ_Name);

    if (strlen(TZ_Result) < sizeof(Ethconfig.TZ) - 1)
      strcpy(Ethconfig.TZ, TZ_Result);
    else
      strncpy(Ethconfig.TZ, TZ_Result, sizeof(Ethconfig.TZ_Name) - 1);

    if ( strlen(Ethconfig.TZ_Name) > 0 )
    {
      LOGERROR3(F("Saving current TZ_Name ="), Ethconfig.TZ_Name, F(", TZ = "), Ethconfig.TZ);

      configTime(Ethconfig.TZ, "pool.ntp.org");
    }
    else
    {
      LOGERROR(F("Current Timezone Name is not set. Enter Config Portal to set."));
    }

#endif

    ESP8266_W5500_manager.getSTAStaticIPConfig(EthSTA_IPconfig);

    saveConfigData();

#if !USE_DHCP_IP

    // Reset to use new Static IP, if different from current eth.localIP()
    if (eth.localIP() != EthSTA_IPconfig._sta_static_ip)
    {
      Serial.print(F("Current IP = "));
      Serial.print(eth.localIP());
      Serial.print(F(". Reset to take new IP = "));
      Serial.println(EthSTA_IPconfig._sta_static_ip);

      ESP.reset();
      delay(2000);
    }

#endif

    digitalWrite(LED_BUILTIN, LED_OFF); // Turn led off as we are not in configuration mode.
  }

  // put your main code here, to run repeatedly
  check_status();
}

See ConfigOnSwitch example for a more complex version.

Many applications need configuration parameters like MQTT host and port, Blynk or emoncms tokens, etc. While it is possible to use ESP8266_W5500_Manager to collect additional parameters, it is better to read these parameters from a web service once ESP8266_W5500_Manager has been used to connect to the Internet.

To capture other parameters with ESP8266_W5500_Manager is a little bit more complicated than all the other features. This requires adding custom HTML to your form.

If you want to do it with ESP8266_W5500_Manager see the example ConfigOnSwitchFS

You can set a custom IP for STA (station mode, client mode, normal project state)

This will use the specified IP configuration instead of using DHCP in station mode.

ESP8266_W5500_manager.setSTAStaticIPConfig(IPAddress(192,168,2,186), IPAddress(192,168,2,1), IPAddress(255,255,255,0));

There are various ways in which you can inject custom HTML, CSS or Javascript into the ConfigPortal.

The options are:

• inject custom head element

You can use this to any html bit to the head of the ConfigPortal. If you add a <style> element, keep in mind it overwrites the included css, not replaces.

ESP8266_W5500_manager.setCustomHeadElement("<style>html{filter: invert(100%); -webkit-filter: invert(100%);}</style>");

• inject a custom bit of html in the configuration form

ESP8266_EMParameter custom_text("<p>This is just a text paragraph</p>");
ESP8266_W5500_manager.addParameter(&custom_text);

• inject a custom bit of html in a configuration form element

Just add the bit you want added as the last parameter to the custom parameter constructor.

ESP8266_EMParameter custom_mqtt_server("server", "mqtt server", "iot.eclipse", 40, " readonly");

You can change the CS/SS pin to another one. Default is GPIO16

Connecting CS/SS to TX0/GPIO15 interferes with uploading firmware to ESP8266. If absolutely necessary to use TX0/GPIO15, remove the wire to TX0/GPIO15 before uploading firmware. Then reconnect after done uploading.

// Using GPIO4, GPIO16, or GPIO5
#define CSPIN             16

1. ConfigOnSwitch
2. ConfigOnSwitchFS
3. ConfigOnDoubleReset_TZ (now support ArduinoJson 6.0.0+ as well as 5.13.5-)
4. ConfigOnDoubleReset (now support ArduinoJson 6.0.0+ as well as 5.13.5-)
5. ConfigPortalParamsOnSwitch (now support ArduinoJson 6.0.0+ as well as 5.13.5-)
6. ESP8266_FSWebServer
7. ESP8266_FSWebServer_DRD