| 2 |
raymond |
1 |
# AsyncFsWebServer
|
|
|
2 |
ESP32/ESP8266 web server, WiFi manager, and ACE web editor Arduino library. Based on [ESPAsyncWebServer](https://github.com/ESP32Async/ESPAsyncWebServer) by @ESP32Async.
|
|
|
3 |
|
|
|
4 |
This library is the async equivalent of [**esp-fs-webserver**](https://github.com/cotestatnt/esp-fs-webserver/): it uses the **ESP Async WebServer** library instead of the default web server.
|
|
|
5 |
|
|
|
6 |
## Dependencies
|
|
|
7 |
Install the following dependencies. Remove any previously installed clones or old versions first, as they may cause conflicts.
|
|
|
8 |
|
|
|
9 |
- ESP32: https://github.com/ESP32Async/AsyncTCP
|
|
|
10 |
- ESP8266: https://github.com/ESP32Async/ESPAsyncTCP
|
|
|
11 |
- ESP32/ESP8266: https://github.com/ESP32Async/ESPAsyncWebServer
|
|
|
12 |
|
|
|
13 |
## Documentation (available methods + usage)
|
|
|
14 |
- [docs/API.md](docs/API.md)
|
|
|
15 |
- [docs/SetupAndWiFi.md](docs/SetupAndWiFi.md)
|
|
|
16 |
- [docs/FileEditorAndFS.md](docs/FileEditorAndFS.md)
|
|
|
17 |
- [docs/WebSocket.md](docs/WebSocket.md)
|
|
|
18 |
- [docs/LogoAndTitle.md](docs/LogoAndTitle.md) - Custom logo and page title configuration
|
|
|
19 |
|
|
|
20 |
**Note**:
|
|
|
21 |
Starting from version 2.0.0, the ESP32 Arduino core introduced **LittleFS**, like ESP8266. The examples in this library are written to use it by default on both platforms. Change this if you prefer other file systems.
|
|
|
22 |
|
|
|
23 |
## WiFi and options manager
|
|
|
24 |
Thanks to the built-in **/setup** page (about 8 KB of program space), you can scan and set WiFi credentials and other freely configurable parameters.
|
|
|
25 |
|
|
|
26 |

|
|
|
27 |
|
|
|
28 |

|
|
|
29 |
|
|
|
30 |
## Web server file upload and OTA updates
|
|
|
31 |
The **/setup** page also allows remote firmware updates (OTA).
|
|
|
32 |
|
|
|
33 |
In addition to built-in firmware update functionality, you can also upload your web server content all at once (typically the files are placed inside the folder `data` of your sketch).
|
|
|
34 |
|
|
|
35 |

|
|
|
36 |
|
|
|
37 |
|
|
|
38 |
This page can also be extended with custom HTML and JavaScript code to create smart and powerful web applications.
|
|
|
39 |
|
|
|
40 |
In the image below, for example, HTML and JavaScript code to provision devices on the well-known [ThingsBoard IoT platform](https://thingsboard.io/) is added at runtime from the Arduino sketch (see the [customHTML](https://github.com/cotestatnt/async-esp-fs-webserver/tree/master/examples/customHTML) example).
|
|
|
41 |
|
|
|
42 |

|
|
|
43 |
|
|
|
44 |
|
|
|
45 |
## ACE web file editor/browser
|
|
|
46 |
Thanks to the built-in **/edit** page, you can upload, delete, and edit HTML/CSS/JavaScript source files directly from your browser and immediately view changes at runtime, without recompiling the firmware.
|
|
|
47 |
The page can be enabled at runtime using `enableFsCodeEditor()` and it occupies about 6.7 KB of program space.
|
|
|
48 |
|
|
|
49 |

|
|
|
50 |
|
|
|
51 |
If you like this work, please consider [sponsoring this project!](https://paypal.me/cotesta)
|