Update main to v0.2.0 (#4)

### Added - Introduced CHANGELOG.md - Added core temperature to the system status API - Added mDNS / Bonjour / zeroConf for better discoverability in local network - Added recovery mode which forces AP to spin up regardless from its settings - Added push notification service to show notification toasts on all clients - Added SSE to update RSSI in status bar on client - Added firmware version to System Status API - Added sleep service to send ESP32 into deep sleep. Wake-up with button using EXT1 - Added battery service to show battery state of charge in the status bar. Uses SSE. - Added download firmware manager to pull firmware binaries e.g. from github release pages - modified generate_cert_bundle.py from Espressif included into the build process to automatically create SSL Root CA Bundle ### Changed - Improved system status with more meaningful presentation of available data - Improved layout on small screens - Increased queue size for SSE and WS to 64 instead of 32 - ESP32-SvelteKit loop()-function is its own task now - ArduinoOTA handle runs in own task now - AsyncTCP tasks run on Core 0 to move all networking related stuff to Core 0 and free up Core 1 for business logic - 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. - Updated frontend dependencies and packages to newest version. ### Depreciated - ArduinoOTA feature is set to depreciate. It is unstable with mDNS causing some reset loops until it finally settles. ### Removed - `FT_PROJECT` feature flag removed.
theelims · Aug 3, 2023 · 758c9a8 · 758c9a8
1 parent aee4c73
commit 758c9a8
Show file tree

Hide file tree

Showing 72 changed files with 2,924 additions and 828 deletions.
diff --git a/.gitignore b/.gitignore
@@ -9,4 +9,7 @@
 /interface/.eslintcache
 .vscode
 node_modules
+/releases
+/src/certs
+/temp
 
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,63 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.2.0] - 2023-08-03
+
+### Added
+
+- Introduced CHANGELOG.md
+- Added core temperature to the system status API
+- Added mDNS / Bonjour / zeroConf for better discoverability in local network
+- Added recovery mode which forces AP to spin up regardless from its settings
+- Added push notification service to show notification toasts on all clients
+- Added SSE to update RSSI in status bar on client
+- Added firmware version to System Status API
+- Added sleep service to send ESP32 into deep sleep. Wake-up with button using EXT1
+- Added battery service to show battery state of charge in the status bar. Uses SSE.
+- Added download firmware manager to pull firmware binaries e.g. from github release pages
+- modified generate_cert_bundle.py from Espressif included into the build process to automatically create SSL Root CA Bundle
+
+### Changed
+
+- Improved system status with more meaningful presentation of available data
+- Improved layout on small screens
+- Increased queue size for SSE and WS to 64 instead of 32
+- ESP32-SvelteKit loop()-function is its own task now
+- ArduinoOTA handle runs in own task now
+- AsyncTCP tasks run on Core 0 to move all networking related stuff to Core 0 and free up Core 1 for business logic
+- 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.
+- Updated frontend dependencies and packages to newest version.
+
+### Depreciated
+
+- ArduinoOTA feature is set to depreciate. It is unstable with mDNS causing some reset loops until it finally settles.
+
+### Removed
+
+- `FT_PROJECT` feature flag removed.
+
+### Fixed
+
+### Security
+
+## [0.1.0] - 2023-05-18
+
+This is the initial release of ESP32-sveltekit. With this it is feature complete to [rjwats/esp8266-react](https://github.com/rjwats/esp8266-react), where it forked from.
+
+### Added
+
+- Added copyright notes
+
+### Changed
+
+- Renaming into ESP32-sveltekit
+- Small changes to reflect the slightly different file structure of sveltekit
+- Build process for sveltekit
+
+### Removed
+
+- Dropping support for ESP8266
diff --git a/ESP32-sveltekit.code-workspace b/ESP32-sveltekit.code-workspace
@@ -1,13 +1,15 @@
 {
-	"folders": [
-		{
-			"path": "."
-		}
-    ],
-    "settings": {
-        "files.associations": {
-            "*.tcc": "cpp",
-            "algorithm": "cpp"
-        }
+  "folders": [
+    {
+      "path": "."
     }
-}
+  ],
+  "settings": {
+    "files.associations": {
+      "*.tcc": "cpp",
+      "algorithm": "cpp",
+      "esp32-hal-misc.c": "cpp",
+      "esp_crt_bundle.h": "c"
+    }
+  }
+}
diff --git a/README.md b/README.md
@@ -35,7 +35,7 @@ Manage different user of your app with two authorization levels. An administrato
 
 ### :airplane: OTA Upgrade Service
 
-The framework can provide two different channels for Over-the-Air updates. Either an Arduino OTA port for updates directly from the IDE. Or by uploading a \*.bin file from the web interface.
+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.
 
 ### :building_construction: Automated Build Chain
 

diff --git a/docs/buildprocess.md b/docs/buildprocess.md
@@ -29,22 +29,26 @@ Many of the framework's built in features may be enabled or disabled as required
 Customize the settings as you see fit. A value of 0 will disable the specified feature:
 
 ```ini
-  -D FT_PROJECT=1
   -D FT_SECURITY=1
   -D FT_MQTT=1
   -D FT_NTP=1
   -D FT_OTA=1
   -D FT_UPLOAD_FIRMWARE=1
+  -D FT_DOWNLOAD_FIRMWARE=1
+  -D FT_SLEEP=1
+  -D FT_BATTERY=1
 ```
 
-| Flag               | Description                                                                                                                                                                                                              |
-| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| FT_PROJECT         | Controls whether the "project" section of the UI is enabled. Disable this if you don't intend to have your own screens in the UI.                                                                                        |
-| FT_SECURITY        | Controls whether the [security features](statefulservice.md#security-features) are enabled. Disabling this means you won't need to authenticate to access the device and all authentication predicates will be bypassed. |
-| FT_MQTT            | Controls whether the MQTT features are enabled. Disable this if your project does not require MQTT support.                                                                                                              |
-| FT_NTP             | Controls whether network time protocol synchronization features are enabled. Disable this if your project does not require accurate time.                                                                                |
-| FT_OTA             | Controls whether OTA update support is enabled. Disable this if you won't be using the remote update feature.                                                                                                            |
-| FT_UPLOAD_FIRMWARE | Controls the whether the manual upload firmware feature is enabled. Disable this if you won't be manually uploading firmware.                                                                                            |
+| Flag                 | Description                                                                                                                                                                                                              |
+| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| FT_SECURITY          | Controls whether the [security features](statefulservice.md#security-features) are enabled. Disabling this means you won't need to authenticate to access the device and all authentication predicates will be bypassed. |
+| FT_MQTT              | Controls whether the MQTT features are enabled. Disable this if your project does not require MQTT support.                                                                                                              |
+| FT_NTP               | Controls whether network time protocol synchronization features are enabled. Disable this if your project does not require accurate time.                                                                                |
+| FT_OTA               | Controls whether ArduinoOTA update support is enabled. Disable this if you won't be using the remote update feature.                                                                                                     |
+| FT_UPLOAD_FIRMWARE   | Controls whether the manual upload firmware feature is enabled. Disable this if you won't be manually uploading firmware.                                                                                                |
+| FT_DOWNLOAD_FIRMWARE | Controls whether the firmware download feature is enabled. Disable this if you won't firmware pulled from a server.                                                                                                      |
+| FT_SLEEP             | Controls whether the deep sleep feature is enabled. Disable this if your device is not battery operated or you don't need to place it in deep sleep to save energy.                                                      |
+| FT_BATTERY           | Controls whether the battery state of charge shall be reported to the clients. Disable this if your device is not battery operated.                                                                                      |
 
 ## Factory Settings
 
@@ -123,6 +127,23 @@ build_flags =
 
 It accepts values from 1 (Verbose) to 5 (Errors) for different information depths to be logged on the serial terminal.
 
+## SSL Root Certificate Store
+
+Some features like firmware download require a SSL connection. For that the SSL Root CA certificate must be known to the ESP32. The build system contains a python script derived from Espressif ESP-IDF building a certificate store containing one or more certificates. In order to create the store you must uncomment the three lines below in `platformio.ini`.
+
+```ini
+extra_scripts =
+    pre:scripts/generate_cert_bundle.py
+board_build.embed_files = src/certs/x509_crt_bundle.bin
+board_ssl_cert_source = folder
+```
+
+The script will download a public certificate store from Mozilla, builds a binary containing all certs and embeds this into the firmware. This will add ~65kb to the firmware image. Should you only need a few known certificates you can place their `*.pem` or `*.der` files in the [ssl_certs](https://github.com/theelims/ESP32-sveltekit/blob/main/ssl_certs) folder and change `board_ssl_cert_source = folder`. Then only these certificates will be included in the store. This is especially useful, if you only need to connect to know servers and need to shave some kb off the firmware image:
+
+!!! info
+
+        To enable SSL the feature `FT_NTP=1` must be enabled as well.
+
 ## Vite and LittleFS 32 Character Limit
 
 The static files for the website are build using vite. By default vite adds a unique hash value to all filenames for improved caching performance. However, LittleFS on the ESP32 is limited to filenames with 32 characters. This restricts the number of characters available for the user to name svelte files. To give a little bit more headroom a vite-plugin removes all hash values, as they offer no benefit on an ESP32. However, have the 32 character limit in mind when naming files. Excessively long names may still cause some issues when building the LittleFS binary.
diff --git a/docs/components.md b/docs/components.md
@@ -81,7 +81,7 @@ Three slots are available. Besides the main slot for the content there is a name
 
 The component exports two properties to determine its behavior. `collapsible` is a boolean describing wether the component should behave like a collapsible in the first place. `open` is a boolean as well and if set true shows the full content of the body on mount.
 
-## Spinner
+## Spinner (OBSOLETE)
 
 A small component showing an animated spinner which can be used while waiting for data.
 
@@ -109,3 +109,11 @@ and call one of the 4 toast methods:
 | `notification.success(msg:string, timeout:number)` | :octicons-check-circle-16: Shows as success message |
 
 Each method takes an `msg`-string as an argument, which will be shown as the message body. It accepts HTML yo enrich your toasts, if you should desire to do so. The `timeout` argument specifies how many milliseconds the toast notification shall be shown to the user.
+
+## Github Update Dialog
+
+This is a modal showing the update progress, possible error messages and makes a full page refresh 5 seconds after the OTA was successful.
+
+## Update Indicator
+
+The update indicator is a small widget shown in the upper right corner of the status bar. It indicates the availability of a newer stable firmware release then the current one. Upon pressing the icon it will automatically update the firmware to the latest stable release. By default this works through the Github Latest Release API. This must be customized should you use a different update server. Have a look at the [source file](https://github.com/theelims/ESP32-sveltekit/blob/main/interface/src/lib/components/GithubUpdateDialog.svelte) to see what portions to update.
diff --git a/docs/gettingstarted.md b/docs/gettingstarted.md
@@ -43,7 +43,7 @@ pip install mkdocs-material
 | [src/](https://github.com/theelims/ESP32-sveltekit/blob/main/src)                      | The main.cpp and demo project to get you started                 |
 | [scripts/](https://github.com/theelims/ESP32-sveltekit/tree/main/scripts)              | Scripts that build the interface as part of the platformio build |
 | [platformio.ini](https://github.com/theelims/ESP32-sveltekit/blob/main/platformio.ini) | PlatformIO project configuration file                            |
-| [mkdocs.yaml](https://github.com/theelims/ESP32-sveltekit/blob/main/mkdosc.yaml)       | MkDocs project configuration file                                |
+| [mkdocs.yaml](https://github.com/theelims/ESP32-sveltekit/blob/main/mkdocs.yaml)       | MkDocs project configuration file                                |
 
 ## Setting up PlatformIO
 

diff --git a/docs/index.md b/docs/index.md
@@ -43,7 +43,7 @@ Manage different user of your app with two authorization levels. An administrato
 
 ### :airplane: OTA Upgrade Service
 
-The framework can provide two different channels for Over-the-Air updates. Either an Arduino OTA port for updates directly from the IDE. Or by uploading a \*.bin file from the web interface.
+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.
 
 ### :construction_site: Automated Build Chain
 
@@ -57,4 +57,4 @@ The code runs on all variants of the ESP32 chip family. From the plain old ESP32
 
 ## License
 
-ESP32 SvelteKit is distributed with two licenses for different sections of the code. The back end code inherits the GNU LESSER GENERAL PUBLIC LICENSE Version 3 and is therefore distributed with said license. The front end code is distributed under the MIT License. See the [LICENSE](https://github.com/theelims/ESP32-sveltekit/LICENSE) for a full text of both licenses.
+ESP32 SvelteKit is distributed with two licenses for different sections of the code. The back end code inherits the GNU LESSER GENERAL PUBLIC LICENSE Version 3 and is therefore distributed with said license. The front end code is distributed under the MIT License. See the [LICENSE](https://github.com/theelims/ESP32-sveltekit/blob/main/LICENSE) for a full text of both licenses.
diff --git a/docs/restfulapi.md b/docs/restfulapi.md
@@ -25,7 +25,9 @@ The back end exposes a number of API endpoints which are referenced in the table
 | POST   | /rest/restart             | `IS_ADMIN`         | none                                                                                                                                                                                                                               | Restart the ESP32                                                              |
 | POST   | /rest/factoryReset        | `IS_ADMIN`         | none                                                                                                                                                                                                                               | Reset the ESP32 and all settings to their default values                       |
 | POST   | /rest/uploadFirmware      | `IS_ADMIN`         | none                                                                                                                                                                                                                               | File upload of firmware.bin                                                    |
-| POST   | /rest/signIn              | `NONE_REQUIRED`    | `{"password": "admin","username": "admin"}  `                                                                                                                                                                                      | Signs a user in and returns access token                                       |
+| POST   | /rest/signIn              | `NONE_REQUIRED`    | `{"password": "admin","username": "admin"}`                                                                                                                                                                                        | Signs a user in and returns access token                                       |
 | GET    | /rest/securitySettings    | `IS_ADMIN`         | none                                                                                                                                                                                                                               | retrieves all user information and roles                                       |
 | POST   | /rest/securitySettings    | `IS_ADMIN`         | `{"jwt_secret": "734cb5bb-5597b722", "users": [{"username": "admin", "password": "admin", "admin": true}, {"username": "guest", "password": "guest", "admin": false, }]`                                                           | retrieves all user information and roles                                       |
 | GET    | /rest/verifyAuthorization | `NONE_REQUIRED`    | none                                                                                                                                                                                                                               | Verifies the content of the auth bearer token                                  |
+| POST   | /rest/sleep               | `IS_AUTHENTICATED` | none                                                                                                                                                                                                                               | Puts the device in deep sleep mode                                             |
+| POST   | /rest/downloadUpdate      | `IS_ADMIN`         | `{"download_url": "https://github.com/theelims/ESP32-sveltekit/releases/download/v0.1.0/firmware_esp32s3.bin"}`                                                                                                                    | Download link for OTA                                                          |