Merge pull request #17 from theelims/psychichttp

Exchange ESPAsyncWebserver with PsychicHttp

Author: theelims

.gitignore

@@ -3,7 +3,6 @@
 .gcc-flags.json
 *Thumbs.db
 /data/www
-/lib/framework/WWWData.h
 /interface/build
 /interface/node_modules
 /interface/.eslintcache
@@ -12,4 +11,8 @@ node_modules
 /releases
 /src/certs
 /temp
-
+/build/firmware
+/lib/framework/WWWData.h
+*WWWData.h
+lib/framework/WWWData.h
+ssl_certs/cacert.pem

CHANGELOG.md

@@ -2,7 +2,114 @@
 
 All notable changes to this project will be documented in this file.
 
-## [0.2.2]
+## [0.3.0] - 2023-02-05
+
+> [!CAUTION]
+> This update has breaking changes!
+
+This is a major change getting rid of all ESPAsyncTCP and ESPAsyncWebserver dependencies. Despite their popularity they are plagued with countless bugs, since years unmaintained, not SSL capable and simply not suitable for a production build. Although several attempts exist to fix the most pressing bugs even these libraries lead to frequent crashes. This new version replaces them with ESP-IDF based components. [PsychicHttp](https://github.com/hoeken/PsychicHttp) and [PsychicMqttClient](https://github.com/theelims/PsychicMqttClient) both wrap the ESP-IDF components in a familiar wrapper for easy porting of the code base. However, this will break existing code and will require some effort on your codebase. In return the stability is improved greatly and the RAM usage more friendly. Now e.g. running Bluetooth in parallel becomes possible.
+
+### Added
+
+- Added postscript to platform.io build process to copy, rename and calculate MD5 checksum of \*.bin file. These files are ready for uploading to the Github Release page.
+- Added more information to SystemStatus API
+- Added generateToken API for security settings
+- Added Multi-WiFi capability. Add up to five WiFi configurations and connect to either strongest network (default), or by priority.
+- Added InfoDialog as a simpler version of the ConfirmDialog for a simple notification modal.
+- Added Adafruit certificate repository as the default choice for the X509 certificate bundle.
+
+### Changed
+
+- Better route protection for user page with deep link.
+- Changed build_interface.py script to check for modified files in the interface sources before re-building the interface. Saves some time on the compilation process.
+- Upload firmware binary allows uploading of MD5 checksum file in advance to verify downloaded firmware package.
+- GithubFirmwareManager checks against PIO build_target in filename to support Github OTA for binaries build for various targets. You should rename your old release \*.bin files on the Github release pages for backward compatibility.
+- Changed MQTT Client to an ESP-IDF backed one which supports SSL/TLS X509 root CA bundles and transport over WS.
+- Changed the `PROGMEM_WWW` flag to `EMBED_WWW` as there is technically speaking no PROGMEM on ESP32's.
+- Updated dependencies to the latest version. Except SvelteKit.
+
+### Fixed
+
+- Fixed reactivity of System Status page.
+
+### Removed
+
+- Removed support for Arduino ESP OTA.
+- HttpEndpoints and Websocket Server without a securityManager are no longer possible.
+
+### Migrate from ESPAsyncWebServer to PsychicHttp
+
+#### Migrate `main.cpp`
+
+Change the server and ESPSvelteKit instances to PsychicHttpServer and give the ESP32SvelteKit constructor the number of http endpoints of your project.
+
+```
+PsychicHttpServer server;
+ESP32SvelteKit esp32sveltekit(&server, 120);
+```
+
+Remove `server.begin();` in `void setup()`. This is handled by ESP32SvelteKit now.
+
+#### Migrate `platformio.ini`
+
+Remove the following `build_flags`:
+
+```ini
+    ; Increase queue size of SSE and WS
+    -D SSE_MAX_QUEUED_MESSAGES=64
+    -D WS_MAX_QUEUED_MESSAGES=64
+    -D CONFIG_ASYNC_TCP_RUNNING_CORE=0
+    -D NO_GLOBAL_ARDUINOOTA
+    -D PROGMEM_WWW
+```
+
+Add the following `build_flags` and adjust to your app, if needed:
+
+```ini
+    -D BUILD_TARGET=\"$PIOENV\"
+    -D APP_NAME=\"ESP32-Sveltekit\" ; Must only contain characters from [a-zA-Z0-9-_] as this is converted into a filename
+    -D APP_VERSION=\"0.3.0\" ; semver compatible version string
+    -D EMBED_WWW
+```
+
+Remove the lib dependency `esphome/AsyncTCP-esphome @ ^2.0.0` and add `https://github.com/theelims/PsychicMqttClient.git`
+
+Consider adjusting `board_ssl_cert_source = adafruit`, so that the new MQTT client has universal SSL/TLS support with a wide range of CA root certificates.
+
+#### Migrate `factory_settings.ini`
+
+The new MQTT client has slightly renamed factory settings:
+
+```ini
+  ; MQTT settings
+  -D FACTORY_MQTT_ENABLED=false
+  -D FACTORY_MQTT_URI=\"mqtts://mqtt.eclipseprojects.io:8883\"
+  -D FACTORY_MQTT_USERNAME=\"\" ; supports placeholders
+  -D FACTORY_MQTT_PASSWORD=\"\"
+  -D FACTORY_MQTT_CLIENT_ID=\"#{platform}-#{unique_id}\" ; supports placeholders
+  -D FACTORY_MQTT_KEEP_ALIVE=120
+  -D FACTORY_MQTT_CLEAN_SESSION=true
+```
+
+Max Topic Length is no longer needed.
+
+#### Custom Stateful Services
+
+Adapt the class constructor (`(PsychicHttpServer *server, ...`) to PsychicHttpServer.
+
+Due to the loading sequence HttpEndoint and WebsocketServer both have gotten a `begin()` function to register their http endpoints with the server. This must be called in your stateful services' own `begin()` function:
+
+```cpp
+void LightStateService::begin()
+{
+    _httpEndpoint.begin();
+    _webSocketServer.begin();
+    _state.ledOn = DEFAULT_LED_STATE;
+    onConfigUpdated();
+}
+```
+
+## [0.2.2] - 2023-10-08
 
 ### Added
 
@@ -53,7 +160,7 @@ All notable changes to this project will be documented in this file.
 - Compiler flag on which core ESP32-sveltekit tasks should run
 - Renamed WebSocketRxTx.h to WebSocketServer.h to create a distinction between WS Client and WS Server interfaces
 - Made code of LightStateExample slightly more verbose
-- getServer() returning a pointer to the AsnycWebServer instance.
+- getServer() returning a pointer to the AsyncWebServer instance.
 - Updated frontend dependencies and packages to newest version.
 
 ### Depreciated

ESP32-sveltekit.code-workspace

@@ -9,7 +9,56 @@
       "*.tcc": "cpp",
       "algorithm": "cpp",
       "esp32-hal-misc.c": "cpp",
-      "esp_crt_bundle.h": "c"
+      "esp_crt_bundle.h": "c",
+      "functional": "cpp",
+      "array": "cpp",
+      "atomic": "cpp",
+      "bitset": "cpp",
+      "cctype": "cpp",
+      "clocale": "cpp",
+      "cmath": "cpp",
+      "cstdarg": "cpp",
+      "cstddef": "cpp",
+      "cstdint": "cpp",
+      "cstdio": "cpp",
+      "cstdlib": "cpp",
+      "cstring": "cpp",
+      "ctime": "cpp",
+      "cwchar": "cpp",
+      "cwctype": "cpp",
+      "deque": "cpp",
+      "list": "cpp",
+      "unordered_map": "cpp",
+      "vector": "cpp",
+      "exception": "cpp",
+      "iterator": "cpp",
+      "map": "cpp",
+      "memory": "cpp",
+      "memory_resource": "cpp",
+      "numeric": "cpp",
+      "optional": "cpp",
+      "random": "cpp",
+      "regex": "cpp",
+      "string": "cpp",
+      "string_view": "cpp",
+      "system_error": "cpp",
+      "tuple": "cpp",
+      "type_traits": "cpp",
+      "utility": "cpp",
+      "fstream": "cpp",
+      "initializer_list": "cpp",
+      "iosfwd": "cpp",
+      "istream": "cpp",
+      "limits": "cpp",
+      "new": "cpp",
+      "ostream": "cpp",
+      "sstream": "cpp",
+      "stdexcept": "cpp",
+      "streambuf": "cpp",
+      "cinttypes": "cpp",
+      "typeinfo": "cpp",
+      "unordered_set": "cpp",
+      "iomanip": "cpp"
     }
   }
 }

README.md

@@ -35,11 +35,11 @@ Manage different user of your app with two authorization levels. An administrato
 
 ### :airplane: OTA Upgrade Service
 
-The framework can provide three different channels for Over-the-Air updates. Either an ArduinoOTA port for updates directly from the IDE, by uploading a \*.bin file from the web interface. Or by pulling a firmware image from an update server. This is implemented with the github release page as an example.
+The framework can provide two different channels for Over-the-Air updates. Either by uploading a \*.bin file from the web interface. Or by pulling a firmware image from an update server. This is implemented with the github release page as an example. It is even possible to have different build environments at the same time and the Github OTA process pulls the correct binary.
 
 ### :building_construction: Automated Build Chain
 
-The automated build chain takes out the pain and tears of getting all the bits and pieces play nice together. The repository contains a PlatformIO project at its heart. A SvelteKit project for the frontend code and a mkdocs project for the documentation go alongside. The PlatformIO build tools not only build the SvelteKit frontend with Vite, but also ensure that the build results are gzipped and find their way into the flash memory of the ESP32. You have two choices to serve the frontend either from the flash partition, or embedded into the firmware binary from PROGMEM. The latter is much more friendly if your frontend code should be distributed OTA as well, leaving all configuration files intact.
+The automated build chain takes out the pain and tears of getting all the bits and pieces play nice together. The repository contains a PlatformIO project at its heart. A SvelteKit project for the frontend code and a mkdocs project for the documentation go alongside. The PlatformIO build tools not only build the SvelteKit frontend with Vite, but also ensure that the build results are gzipped and find their way into the flash memory of the ESP32. You have two choices to serve the frontend either from the flash partition, or embedded into the firmware binary. The latter is much more friendly if your frontend code should be distributed OTA as well, leaving all configuration files intact.
 
 ### :icecream: Compatible with all ESP32 Flavours
 
@@ -57,9 +57,10 @@ The code runs on many variants of the ESP32 chip family. From the plain old ESP3
 - [tabler ICONS](https://tabler-icons.io/)
 - [unplugin-icons](https://github.com/antfu/unplugin-icons)
 - [svelte-modals](https://svelte-modals.mattjennings.io/)
+- [svelte-dnd-list](https://github.com/tarb/svelte-dnd-list)
 - [ArduinoJson](https://github.com/bblanchon/ArduinoJson)
-- [ESPAsyncWebServer](https://github.com/me-no-dev/ESPAsyncWebServer)
-- [AsyncMqttClient](https://github.com/marvinroger/async-mqtt-client)
+- [PsychicHttp](https://github.com/hoeken/PsychicHttp)
+- [PsychicMqttClient](https://github.com/theelims/PsychicMqttClient)
 
 ## Licensing