A manual fork from https://github.com/gmag11/FSBrowserNG with update to support MQTT and various sensors and i/o functionaly

#FSBrowserNG Full autocontained (on SPIFFS) async web server on ESP8266. Written as a Library.

Same features as my FSBrowser sketch but built around AsyncWebServer library and implemented as a library itself. See *.ino file for usage example

##Introduction I wanted to add a standard environment for all my ESP8266 based projects to be able to configure them via web browser to avoid code editing when I need to change some settings like SSID, password, etc.

I found John Lassen's WebConfig project to almost fit my needs. It uses a simple but powerful web interface with dynamic data using microAJAX. I've added some dynamic data using Links2004's WebSockets library.

So, I tried to fork it. Original WebConfig project stores web pages on PROGMEM, but I was recently using SPIFFS on ESP8266 and I think it is a good way to store web content. I found I was not the first to think this when I noticed about FSBrowser example in ESP8266WebServer library.

This example code has a great bonus: a text editor (based on ACE) with syntax highligth that can be used to edit html on board directly. I found a bug on it (already sent to esp8266/Arduino repository) and, when fixed, noticed how usefull this editor is.

My code is a fork of both projects, and has become a start framework for my future projects. Finally i've refactored code to use it as a library, so it is easier to integrate it in a project. See this example to check that only 3 lines are necessary to use it.

I only have to add more HTML data and some funtions to show dynamic data in order to adapt it to any other task.

It has integrated NTP syncronization based on my own NTPClient library, that can be configured via this Web interface too.

Configuration is stored on SPIFFS too, in a JSON file. So, it recovers config during boot.

Implemented OTA Update with Arduino IDE and Web interface.

Web access can be protected with Basic HTTP Authentication.

I use a library called ESPAsyncWebServer. It is much faster than standard ESP8266WebServer library due to its async design.

Notice that Basic HTTP Authentication alone is not suitable to protect data over Internet. It allows recovery of user and password via sniffing and does not encrypt data flow. It is valid to give a first protection and may be a good solution combining it with strong VPN. Take this in account when connecting it to public networks or Internet.

##WiFi connection I've implemented a way to turn ESP8266 into AP mode so I can set WiFi config when prior WiFi is not available. It is done by setting IO pin 4 to high status during boot. This pin is configurable by a #define. in FSWebServerlib.h. You must ensure it is connected to GND to allow it to connect to a router.

AP Mode is also started when loadConfig() finds no config file (config.json). This is so to help first use without needind to hardcode user and password. config.js is generated automatically if needed:

{
	"ssid":"YOUR_SSID",
	"pass":"YOUR_PASSWORD",
	"ip":[192,168,1,4],
	"netmask":[255,255,255,0],
	"gateway":[192,168,1,1],
	"dns":[192,168,1,1],
	"dhcp":1
	,"ntp":"es.pool.ntp.org"
	,"NTPperiod":5
	,"timeZone":10
	,"daylight":1
	,"deviceName":"ESP8266fs"
}

WiFi connection to router is confirmed via LED on IO pin GPIO02 as soon an IP address is got. Same LED is used to confirm AP mode by flashing 3 times. LED ping can be configured in FSWebServerlib.h.

##How to use it

After compile and flash into ESP8266 you need to upload SPIFFS data using download tool for Arduino IDE. Check SPIFFS doc for details.

• http://ip_address/admin.html takes you to main configuration GUI.
• http://ip_address/edit contains code editor. Any file stored in SPIFFS may be loaded here and saved using CTRL+S command.
• http://ip_address/update allows remote update through WEB.
• http://ip_address/ includes an example info page that shows how to get realtime data from ESP. You may change this to adapt to your project.

You may add your own files to SPIFFS to be served by ESP8266. You only need to add some code if you need dynamic data.

FSBrowserNG extends AsyncWebServer class. So, you may use all its methods as usual.

##Dependances

This library makes use of other libraries you have to include in your Arduino library folder.

TimeLib.h Time library by Paul Stoffregen https://github.com/PaulStoffregen/Time NtpClientLib.h NTP Client library by Germán Martín https://github.com/gmag11/NtpClient ESPAsyncTCP.h Async TCP library by Me No Dev https://github.com/me-no-dev/ESPAsyncTCP ESPAsyncWebServer.h HTTP Async Web Server library by Me No Dev https://github.com/me-no-dev/ESPAsyncTCP ArduinoJson JSON library by Benoît Blanchon https://github.com/bblanchon/ArduinoJson

All other libraries used are installed in Arduino ESP8266 framework.

##Troubleshooting

If the compiler exits with an error similar to "WebHandlers.cpp:67:64: error: 'strftime' was not declared in this scope", follow these steps:

• Locate folder /Library/Arduino15/packages/esp8266/tools/xtensa-lx106-elf-gcc/1.20.0-26-gb404fb9-2/xtensa-lx106-elf/include
• make a copy of time.h and name it _time.h
• Locate and open ESPAsyncWebServer\src\WebHandlerImpl.h
• Replace #include <time.h> to #include <_time.h>

see me-no-dev/ESPAsyncWebServer#60

If the ESP8266 Sketch Data Upload fails with an error similar to "Exception in thread "AWT-EventQueue-0" java.lang.IllegalAccessError: tried to access method", replace the ESP8266FS 0.3.0 plugin by the ESP8266FS 0.2.0 plugin.

##TODO

• HTTP Authentication HTTP Basic authentication implemented. Will try to improve to a more secure mechanism.
• OTA update via web interface MD5 cheching added.
• MD5 check of uploaded firmware
• Configuration protection
• HTTPS (in evaluation). Not possible with ESP8266 yet
• Integration of editor in admin.html
• Convert code to classes and try to design a library to add all this functionality easily.

Species5618 additions Customisations to support Wemos D1 mini #IOT board currently under developmentWemos D1 mini is a Arduino compatible ESP8266 esp-12e based Wi-Fi enabled board the PCB will expose 6 i/o pins, + two i2c busses, in one of the following i/o configuration (using solder links on the board and fitting different components)

1. All 4 i/o from CPU direct to terminal block
2. 2 input (opto isolated voltage input, or contact input)
   2 output (relay with 230v separation on contacts) or open drain MOS FET for PWM
3. 4 output into h-bridge driver,

It has i2c at 3v3 , and optional level shift to 5v ic2, (two header so you can you both and same time) (the display in the video is on the 5v i2c)

Place for DHT 11 / 22 temp / humidity sensor , or DS18xx temp sensor

Current status

• Pin map defined in global.h
• Force setup mode changed to gnd pin D1 (wemos label) i2c SCL pin,
• Basic i/o via MQTT working, and supporting retained messages so restart in to correct output state
• DHT11 and DHT22 supoprted, support for dallas temperature sensor (untested)
• Analog in working
• MQTT "will" TOPIC used to signal device lost contact, up/down
• MQTT root topic supported, i used this for bridging segregation
• Additional Web pages working for
  • MQTT settings
  • Pin i/o mode
• MQTT update interval control , so update rate can be limited , usefull when on freeplan from cloudmqtt
• Frequency in pins
  • Frequency, double edge, double edge will be Hz * 2
  • Support resetable big int Totaliser
• PWM out Pins
• optional on timeout for outputs, so relays will shut down after timeout, set default time out in WEB ui, or override with : on MQTT messages 1:30 will turn on for 30 seconds then off

ToDo

• MQTT update interval more intelligent, currenlt simple 5 secd, if change, want if change but not more then 5 seconds
• Frequency in pins
  • Frequency, double edge, double edge will be Hz * 2
  • Support resteable big int Totaliser
• PWM out Pins
• 2FA login, plan to include a google auithenticator libary so one time password can be used, this feature May be added back into orginal project
• send email on config change or login
• send SMS via textlocal or nexmo,
  • may try and support tokenised URL
  • may try and support SSL URLs
• split config for I/O from web server, may leave it depends on code space
• add configurable MQTT WILL topic and messages,
• max on time for outputs, so relays will shut down after timeout if contact is lost
• SSL MQTT
• support for dallas temperature sensor
• support for some I2C sensors, list TBC