Просмотр исходного кода

Update Changelog.md for release

github-actions 3 лет назад
Родитель
Сommit
aec1dc770b
1 измененных файлов с 72 добавлено и 59 удалено
  1. 72 59
      Changelog.md

+ 72 - 59
Changelog.md

@@ -2,108 +2,119 @@
 
 ## [Unreleased]
 
+## [12.0.1] - 2022-09-29
+
 Improve **u**ser e**x**perience 
 
 :bangbang: The release breaks a few things in ota update :bangbang:
 
 **Make sure to read the instructions below carfully!**.
 
-1. Backup your configuration (use the `System > Backup/Restore` page)!
-2. You should update to `11.3.1` before you update to this release. All other migrations are not tested. 
+1.  Backup your configuration (use the `System > Backup/Restore` page)!
+2.  You should update to `11.3.1` before you update to this release. All other migrations are not tested. 
     Rolling newer than `11.3.1` can also be used, but no guaranty.
-3. Upload and update the `firmware.bin` file from this release. **but do not reboot**
-4. Upload the `html-from-11.3.1.zip` in html upload and update the web interface.
-5. Now you can reboot.
+3.  Upload and update the `firmware.bin` file from this release. **but do not reboot**
+4.  Upload the `html-from-11.3.1.zip` in html upload and update the web interface.
+5.  Now you can reboot.
 
 If anything bricks you can try to
-1. Call `http://<IP>/ota?task=update&file=firmware.bin` resp. `http://<IP>/ota?task=update&file=html.zip` if the upload successed but the extraction failed.
-1. Use the initial_esp32_setup.zip ( <https://github.com/jomjol/AI-on-the-edge-device/wiki/Installation> ) as alternative.
+1\. Call `http://<IP>/ota?task=update&file=firmware.bin` resp. `http://<IP>/ota?task=update&file=html.zip` if the upload successed but the extraction failed.
+1\. Use the initial_esp32_setup.zip ( <https://github.com/jomjol/AI-on-the-edge-device/wiki/Installation> ) as alternative.
 
 ### Added
 
-- Automatic release creation
-- Newest firmware of rolling branch now automatically build and provided in [Github Actions Output](https://github.com/jomjol/AI-on-the-edge-device/actions) (developers only)
-- [\#1068](https://github.com/jomjol/AI-on-the-edge-device/issues/1068) New update mechanism: 
-  - Handling of all files (`zip`, `tfl`, `tflite`, `bin`) within in one common update interface
-  - Using the `update.zip` from the [Release page](https://github.com/jomjol/AI-on-the-edge-device/releases)
-  - Status (`upload`, `processing`, ...) displayed on Web Interface
-  - Automatical detection and suggestion for reboot where needed (Web Interface uupdates only need a page refresh)
-  - :bangbang: Best for OTA use Firefox. Chrome works with warnings. Safari stuck in upload.
+-   Automatic release creation
+-   Newest firmware of rolling branch now automatically build and provided in [Github Actions Output](https://github.com/jomjol/AI-on-the-edge-device/actions) (developers only)
+-   [#1068](https://github.com/jomjol/AI-on-the-edge-device/issues/1068) New update mechanism: 
+    -   Handling of all files (`zip`, `tfl`, `tflite`, `bin`) within in one common update interface
+    -   Using the `update.zip` from the [Release page](https://github.com/jomjol/AI-on-the-edge-device/releases)
+    -   Status (`upload`, `processing`, ...) displayed on Web Interface
+    -   Automatical detection and suggestion for reboot where needed (Web Interface uupdates only need a page refresh)
+    -   :bangbang: Best for OTA use Firefox. Chrome works with warnings. Safari stuck in upload.
 
 ### Changed
-- Integrated version info better shown on the Info page and in the log
-- Updated menu
-- Update used libraries (`tflite`, `esp32-cam`, `esp-nn`, as of 20220924) 
-### Fixed
 
-- [\#1092](https://github.com/jomjol/AI-on-the-edge-device/issues/1092) censor passwords in log outputs 
-- [\#1029](https://github.com/jomjol/AI-on-the-edge-device/issues/1029) wrong change of `checkDigitConsistency` now working like releases before `11.3.1` 
-- Spelling corrections (**[cristianmitran](https://github.com/cristianmitran)**) 
+-   Integrated version info better shown on the Info page and in the log
+-   Updated menu
+-   Update used libraries (`tflite`, `esp32-cam`, `esp-nn`, as of 20220924) 
 
+### Fixed
+
+-   [#1092](https://github.com/jomjol/AI-on-the-edge-device/issues/1092) censor passwords in log outputs 
+-   [#1029](https://github.com/jomjol/AI-on-the-edge-device/issues/1029) wrong change of `checkDigitConsistency` now working like releases before `11.3.1` 
+-   Spelling corrections (**[cristianmitran](https://github.com/cristianmitran)**) 
 
 ### Removed
-- Remove the folder `/firmware` from GitHub repository. 
-  If you want to get the latest `firmware.bin` and `html.zip` files, please download from the automated [build action](https://github.com/jomjol/AI-on-the-edge-device/actions) or [release page](https://github.com/jomjol/AI-on-the-edge-device/releases)
+
+-   Remove the folder `/firmware` from GitHub repository. 
+    If you want to get the latest `firmware.bin` and `html.zip` files, please download from the automated [build action](https://github.com/jomjol/AI-on-the-edge-device/actions) or [release page](https://github.com/jomjol/AI-on-the-edge-device/releases)
 
 ## [11.3.1] - (2022-09-17)
+
 Intermediate Digits
 
-- **ATTENTION**: 
-  - first update the `firmware.bin` and ensure that the new version is running
+-   **ATTENTION**: 
+
+    -   first update the `firmware.bin` and ensure that the new version is running
 
-  - Only afterwards update the `html.zip`
-  
-  - Otherwise the downwards compatibility of the new counter clockwise feature is not given and you end in a reboot loop, that needs manual flashing!
-  
+    -   Only afterwards update the `html.zip`
 
+    -   Otherwise the downwards compatibility of the new counter clockwise feature is not given and you end in a reboot loop, that needs manual flashing!
 
-- **NEW v11.3.1**: corrected corrupted asset `firmware.bin`
-- Increased precision (more than 6-7 digits)
-- Implements Counter Clockwise Analog Pointers
-- Improved post processing algorithm
-- Debugging: intensive use of testcases
-- MQTT: improved handling, extended logging, automated reconnect
-- HTML: Backup Option for Configuration
-- HTML: Improved Reboot
-- HTML: Update WebUI (Reboot, Infos, CPU Temp, RSSI)
-- This version is largely also based on the work of **[caco3](https://github.com/caco3)**,  **[adellafave](https://github.com/adellafave)**,  **[haverland](https://github.com/haverland)**,  **[stefanbode](https://github.com/stefanbode)**, **[PLCHome](https://github.com/PLCHome)**
+
+-   **NEW v11.3.1**: corrected corrupted asset `firmware.bin`
+-   Increased precision (more than 6-7 digits)
+-   Implements Counter Clockwise Analog Pointers
+-   Improved post processing algorithm
+-   Debugging: intensive use of testcases
+-   MQTT: improved handling, extended logging, automated reconnect
+-   HTML: Backup Option for Configuration
+-   HTML: Improved Reboot
+-   HTML: Update WebUI (Reboot, Infos, CPU Temp, RSSI)
+-   This version is largely also based on the work of **[caco3](https://github.com/caco3)**,  **[adellafave](https://github.com/adellafave)**,  **[haverland](https://github.com/haverland)**,  **[stefanbode](https://github.com/stefanbode)**, **[PLCHome](https://github.com/PLCHome)**
 
 ## [11.2.0] -  (2022-08-28)
+
 Intermediate Digits
 
-- Updated Tensorflow / TFlite to newest tflite (version as of 2022-07-27)
-- Updated analog neural network file (`ana-cont_11.3.0_s2.tflite` - default, `ana-class100_0120_s1_q.tflite`)
-- Updated digital neural network file (`dig-cont_0570_s3.tflite` - default, `dig-class100_0120_s2_q.tflite`)
+-   Updated Tensorflow / TFlite to newest tflite (version as of 2022-07-27)
 
-- Added automated filtering of tflite-file in the graphical configuration (thanks to @**[caco3](https://github.com/caco3)**)
-- Updated consistency algorithm & test cases
-- HTML: added favicon and system name, Improved reboot dialog  (thanks to @**[caco3](https://github.com/caco3)**)
+-   Updated analog neural network file (`ana-cont_11.3.0_s2.tflite` - default, `ana-class100_0120_s1_q.tflite`)
+
+-   Updated digital neural network file (`dig-cont_0570_s3.tflite` - default, `dig-class100_0120_s2_q.tflite`)
+
+-   Added automated filtering of tflite-file in the graphical configuration (thanks to @**[caco3](https://github.com/caco3)**)
+
+-   Updated consistency algorithm & test cases
+
+-   HTML: added favicon and system name, Improved reboot dialog  (thanks to @**[caco3](https://github.com/caco3)**)
 
 ## [11.1.1] -  (2022-08-22)
+
 Intermediate Digits
 
-- New and improved consistency check (especially with analog and digital counters mixed)
-- Bug Fix: digital counter algorithm
+-   New and improved consistency check (especially with analog and digital counters mixed)
+-   Bug Fix: digital counter algorithm
 
 ## [11.0.1] - (2022-08-18)
-Intermediate Digits
 
-- **NEW v11.0.1**: Bug Fix InfluxDB configuration (only update of html.zip necessary)
+Intermediate Digits
 
-- Implementation of new CNN types to detect intermediate values of digits with rolling numbers
+-   **NEW v11.0.1**: Bug Fix InfluxDB configuration (only update of html.zip necessary)
 
-  - By default the old algo (0, 1, ..., 9, "N") is active (due to the limited types of digits trained so far)
-  - Activation can be done by selection a tflite file with the new trained model in the 'config.ini'
-  - **Details can be found in the [wiki](https://github.com/jomjol/AI-on-the-edge-device/wiki/Neural-Network-Types)** (different types, trained image types, naming convention)
+-   Implementation of new CNN types to detect intermediate values of digits with rolling numbers
 
-- Updated  neural network files (and adaption to new naming convention)
+    -   By default the old algo (0, 1, ..., 9, "N") is active (due to the limited types of digits trained so far)
+    -   Activation can be done by selection a tflite file with the new trained model in the 'config.ini'
+    -   **Details can be found in the [wiki](https://github.com/jomjol/AI-on-the-edge-device/wiki/Neural-Network-Types)** (different types, trained image types, naming convention)
 
-- Published a tool to download and combine log files - **Thanks to **
+-   Updated  neural network files (and adaption to new naming convention)
 
-  - Files see ['/tools/logfile-tool'](tbd), How-to see [wiki](https://github.com/jomjol/AI-on-the-edge-device/wiki/Gasmeter-Log-Downloader)
+-   Published a tool to download and combine log files - **Thanks to **
 
-- Bug Fix: InfluxDB enabling in grahic configuration
+    -   Files see ['/tools/logfile-tool'](tbd), How-to see [wiki](https://github.com/jomjol/AI-on-the-edge-device/wiki/Gasmeter-Log-Downloader)
 
+-   Bug Fix: InfluxDB enabling in grahic configuration
 
 ## [10.6.2] - (2022-07-24)
 
@@ -660,7 +671,9 @@ External Illumination
 
 -   Initial Version
 
-[Unreleased]: https://github.com/haverland/AI-on-the-edge-device/compare/11.4.3...HEAD
+[Unreleased]: https://github.com/jomjol/AI-on-the-edge-device/compare/12.0.1...HEAD
+
+[12.0.1]: https://github.com/jomjol/AI-on-the-edge-device/compare/11.3.1...12.0.1
 
 [11.4.3]: https://github.com/haverland/AI-on-the-edge-device/compare/10.6.2...11.4.3