Merge pull request #1042 from haverland/rolling

auto release creation and build artifact upload and release notes

.github/workflows/build.yaml

@@ -9,7 +9,7 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-
+    
     - name: Cache PlatformIO
       uses: actions/cache@v2
       with:
@@ -38,11 +38,9 @@ jobs:
 
 
     - name: Build Firmware
-#      run: mkdir -p ./code/.pio/build/esp32cam/; touch ./code/.pio/build/esp32cam/firmware.bin # Testing
+      #run: mkdir -p ./code/.pio/build/esp32cam/; touch ./code/.pio/build/esp32cam/firmware.bin; touch ./code/.pio/build/esp32cam/bootloader.bin; touch ./code/.pio/build/esp32cam/partitions.bin # Testing
       run: cd code; platformio run --environment esp32cam
-
-
-
+    
     # Old OTA concept
     # firmware__*.zip needs to be unpacked before attaching to the release!
     # The bin filename can contain versioning.
@@ -104,3 +102,63 @@ jobs:
       with:
         name: "update_firmware+web_ui+cnn__${{ steps.vars.outputs.date_time_filename }}__${{ github.ref_name }}_(${{ steps.vars.outputs.sha_short }})"
         path: ./dist/*
+
+    # creates old style binaries for fresh installation (backward compatible to wiki)
+    - name: Copy artifacts to firmware folder
+      run: |
+        mkdir -p firmware
+        # copy builds to firmware folder for committing in next step
+        cp -f "./code/.pio/build/esp32cam/firmware.bin" "firmware/firmware.bin"
+        cp -f "./code/.pio/build/esp32cam/bootloader.bin" "firmware/bootloader.bin"
+        cp -f "./code/.pio/build/esp32cam/partitions.bin" "firmware/partitions.bin"
+        cd sd-card
+        rm -f ../firmware/html.zip
+        zip -r ../firmware/html.zip html
+        cd ../dist
+        zip -r ../firmware/update.zip .
+        
+    # extract the version used in next step
+    - id: get_version
+      if: startsWith(github.ref, 'refs/tags/') 
+      uses: battila7/get-version-action@v2
+
+    # the changelog [unreleased] will now be changed to the release version
+    - name: Update changelog
+      uses: thomaseizinger/keep-a-changelog-new-release@v1
+      if: startsWith(github.ref, 'refs/tags/') 
+      with:
+        changelogPath: Changelog.md
+        version: ${{ steps.get_version.outputs.version-without-v }}
+            
+    # the release notes will be extracted from changelog 
+    - name: Extract release notes
+      id: extract-release-notes
+      if: startsWith(github.ref, 'refs/tags/') 
+      uses: ffurrer2/extract-release-notes@v1
+      with:
+          changelog_file: Changelog.md
+          
+
+    # Releases should only be created on master by tagging the last commit.
+    # all artifacts in firmware folder pushed to the release
+    - name: Release
+      uses: softprops/action-gh-release@v1
+      if: startsWith(github.ref, 'refs/tags/')
+      with:
+        name:  ${{ steps.get_version.outputs.version-without-v }}
+        body: ${{ steps.extract-release-notes.outputs.release_notes }}
+        files: |
+          firmware/*   
+          
+
+    # Commit&Push Changelog to master branch. Must be manually merged back to rolling
+    - name: Commit changes and push changes
+      if: startsWith(github.ref, 'refs/tags/') 
+      run: |
+        git config user.name github-actions
+        git config user.email github-actions@github.com
+        git add Changelog.md
+        git commit Changelog.md -m "Update Changelog.md for ${{github.event.inputs.versionIncrement}} release"
+        git push origin HEAD:master
+
+

Changelog.md

@@ -1,447 +1,576 @@
-# Versions
+# Changelog
 
-##### 10.6.2 - Stability Increase (2022-07-24)
+## [Unreleased]
 
-- **NEW 10.6.2**: ignore hidden files in model selection (configuration page) 
+## [11.3.9] - 2022-09-20
 
-- **NEW 10.6.1**: Revoke esp32cam & tflite update
+### Added
 
-- **NEW 10.6.1**: Bug Fix: tflite-filename with ".", HTML spelling error
+-   auto release creation
 
-- IndluxDB: direct injection into InfluxDB - thanks to **[wetneb](https://github.com/wetneb)**
+### Changed
 
-- MQTT: implemented "Retain Flag" and extend with absolute Change (in addition to rate)
+-   something else
 
-- `config.ini`: removal of modelsize (readout from tflite)
+### Fixed
 
-- Updated analog neural network file (`ana1000s2.tflite`) & digital neural network file (`dig1400s2q.tflite`)
+-   \#924 - fix of the Fix
 
-- TFMicro/Lite: Update (espressif Version 20220716)
+## [10.6.2] - (2022-07-24)
 
-- Updated esp32cam (v20220716)
+Stability Increase
 
-- ESP-IDF: Update to 4.4
+### Added
 
-- Internal update (CNN algorithm optimizations, reparation for new neural network type)
+-   **NEW 10.6.2**: ignore hidden files in model selection (configuration page)
 
-- Bug Fix: no time with fixed IP, Postprocessing, MQTT
+-   **NEW 10.6.1**: Revoke esp32cam & tflite update
 
-  
+-   **NEW 10.6.1**: Bug Fix: tflite-filename with ".", HTML spelling error
 
-##### 10.5.2 - Stability Increase (2022-02-22)
+-   IndluxDB: direct injection into InfluxDB - thanks to **[wetneb](https://github.com/wetneb)**
 
-- NEW 10.5.2: Bug Fix: wrong `firmware.bin` (no rate update)
-- NEW 10.5.1: Bug Fix: wrong return value, rate value & PreValue status, HTML: SSID & IP were not displayed 
-- MQTT: changed wifi naming to "wifiRSSI"
-- HTML: check selectable values for consistency
-- Refactoring of check postprocessing consistency (e.g. max rate, negative rate, ...)
-- Bug Fix: corrected error in "Check Consistency Increase"
+-   MQTT: implemented "Retain Flag" and extend with absolute Change (in addition to rate)
 
+-   `config.ini`: removal of modelsize (readout from tflite)
 
+-   Updated analog neural network file (`ana1000s2.tflite`) & digital neural network file (`dig1400s2q.tflite`)
 
-##### 10.4.0 - Stability Increase (2022-02-12)
+-   TFMicro/Lite: Update (espressif Version 20220716)
 
-- Graphical configuration: select available neural network files (*.tfl, *.tflite) from drop down menu
-- OTA-update: add option to upload tfl / tflite files to the correct location (`/config/`)
-  - In the future the new files will also be copied to the `firmware` directory of the repository
-- Added Wifi RSSI to MQTT information
-- Updated analog neural network file (`ana-s3-q-20220105.tflite`)
-- Updated digital neural network file (`dig-s1-q-20220102.tflite`)
-- Updated build environment to `Espressif 3.5.0`
+-   Updated esp32cam (v20220716)
 
+-   ESP-IDF: Update to 4.4
 
+-   Internal update (CNN algorithm optimizations, reparation for new neural network type)
 
-##### 10.3.0 - Stability Increase (2022-01-29)
+-   Bug Fix: no time with fixed IP, Postprocessing, MQTT
 
-- Implemented LED flash dimming (`LEDIntensity`). 
-  Remark: as auto illumination in the camera is used, this is rather for energy saving. It will not help reducing reflections
-- Additional camera parameters: saturation, contrast (although not too much impact yet)
-- Some readings will have removable "N"s that can not be removed automatically and are handled with an "error" --> no return value in the field "value" anymore (still reported back via field "raw value")
-- Updated esp32 camera hardware driver
-- Bug fix: MQTT, HTML improvements
+## [10.5.2] - (2022-02-22)
+
+Stability Increase
+
+### Changed
+
+-   NEW 10.5.2: Bug Fix: wrong `firmware.bin` (no rate update)
+-   NEW 10.5.1: Bug Fix: wrong return value, rate value & PreValue status, HTML: SSID & IP were not displayed
+-   MQTT: changed wifi naming to "wifiRSSI"
+-   HTML: check selectable values for consistency
+-   Refactoring of check postprocessing consistency (e.g. max rate, negative rate, ...)
+-   Bug Fix: corrected error in "Check Consistency Increase"
+
+## [10.4.0] - (2022-02-12)
+
+Stability Increase
+
+### Changed
+
+-   Graphical configuration: select available neural network files (_.tfl,_.tflite) from drop down menu
+-   OTA-update: add option to upload tfl / tflite files to the correct location (`/config/`)
+    -   In the future the new files will also be copied to the `firmware` directory of the repository
+-   Added Wifi RSSI to MQTT information
+-   Updated analog neural network file (`ana-s3-q-20220105.tflite`)
+-   Updated digital neural network file (`dig-s1-q-20220102.tflite`)
+-   Updated build environment to `Espressif 3.5.0`
+
+## [10.3.0] - (2022-01-29)
+
+Stability Increase
+
+### Changed
+
+-   Implemented LED flash dimming (`LEDIntensity`).
+    Remark: as auto illumination in the camera is used, this is rather for energy saving. It will not help reducing reflections
+-   Additional camera parameters: saturation, contrast (although not too much impact yet)
+-   Some readings will have removable "N"s that can not be removed automatically and are handled with an "error" --> no return value in the field "value" anymore (still reported back via field "raw value")
+-   Updated esp32 camera hardware driver
+-   Bug fix: MQTT, HTML improvements
 
 **ATTENTION:  The new ESP32 camera hardware driver is much more stable on newer OV2640 versions (no or much less reboots) but seems to be not fully compatible with older versions.**
 
-* If you have problem with stalled systems you can try the following
-  - Update the parameter `ImageQuality` to `12` instead of current value `5` (manually in the `config.ini`)
+If you have problem with stalled systems you can try the following
+
+-   Update the parameter `ImageQuality` to `12` instead of current value `5` (manually in the `config.ini`)
+
+-   If this is not helping, you might need to update your hardware or stay with version 9.2
+
+## [10.2.0] - (2022-01-14)
+
+Stability Increase
+
+### Changed
+
+-   Due to the updated camera driver, the image looks different and a new setup might be needed
+
+    -   Update reference image
+    -   Update Alignment marks
+
+-   Reduce reboot due to camera problems
+
+-   Update esp32-camera to new version (master as of 2022-01-09)
+
+## [10.1.1] - (2022-01-12)
+
+ Stability Increase
+
+### Changed
+
+-   Bug Fix MQTT problem
+-   Issue:
+    -   Changing from v9.x to 10.x the MQTT-parameter "Topic" was renamed into "MainTopic" to address multiple number meters. This renaming should have been done automatically in the background within the graphical configuration, but was not working. Instead the parameter "Topic" was deleted and "MainTopic" was set to disabled and "undefined".
+-   ToDo
+    -   Update the `html.zip`
+    -   If old `config.ini` available: copy it to `/config`, open the graphical configuration and save it again.
+    -   If old `config.ini` not available: reset the parameter "MainTopic" within the `config.ini` manually
+    -   Reboot
+
+## [10.1.0] -  (2022-01-09)
+
+Stability Increase
+
+### Changed
+
+-   Reduce ESP32 frequency to 160MHz
+
+-   Update tflite (new source: <https://github.com/espressif/tflite-micro-esp-examples>)
+
+-   Update analog neural network (ana-s3-q-20220105.tflite)
+
+-   Update digital neural network (dig-s1-q-20220102.tflite)
+
+-   Increased web-server buffers
+
+-   bug fix: compiler compatibility
+
+## [10.0.2] - (2022-01-01)
+
+Stability Increase
+
+### Changed
+
+-   NEW v10.0.2: Corrected JSON error
+
+-   Updated compiler toolchain to ESP-IDF 4.3
+
+-   Removal of memory leak
+
+-   Improved error handling during startup (check PSRAM and camera with remark in logfile)
+
+-   MQTT: implemented raw value additionally, removal of regex contrain
+
+-   Normalized Parameter `MaxRateValue`  to "change per minute"
+
+-   HTML: improved input handling
+
+-   Corrected error handling: in case of error the old value, rate, timestamp are not transmitted any more
+
+## [9.2.0] -  (2021-12-02)
+
+External Illumination
+
+### Changed
+
+-   Direct JSON access: `http://IP-ADRESS/json`
+-   Error message in log file in case camera error during startup
+-   Upgrade analog CNN to v9.1.0
+-   Upgrade digital CNN to v13.3.0 (added new images)
+-   html: support of different ports
+
+## [9.1.1] - External Illumination (2021-11-16)
+
+### Changed
+
+-   NEW 9.1.1 bug fix: LED implemenetation
+-   External LEDs: change control mode (resolve bug with more than 2 LEDs)
+-   Additional info into log file
+-   Bug fix: decimal shift, html, log file
+
+## [9.0.0] - External Illumination (2021-10-23)
+
+### Changed
+
+-   Implementation of external illumination to adjust positioning, brightness and color of the illumination now set individually
+    -   Technical details can be found in the wiki: <https://github.com/jomjol/AI-on-the-edge-device/wiki/External-LED>
+        <img src="https://raw.githubusercontent.com/jomjol/ai-on-the-edge-device/master/images/intern_vs_external.jpg" width="500">
+-   New housing published for external LEDs and small clearing: <https://www.thingiverse.com/thing:5028229>
+
+## [8.5.0] - Multi Meter Support (2021-10-07)
+
+### Changed
+
+-   Upgrade digital CNN to v13.1.0 (added new images)
+-   bug fix: wlan password with space, double digit output
+
+## [8.4.0] - Multi Meter Support (2021-09-25)
+
+### Changed
+
+-   License change (remove MIT license, remark see below)
+
+-   html: show hostname in title and main page
+
+-   configuration:
+
+    -   moved setting `ExtendedResolution` to individual number settings
+    -   New parameter `IgnoreLeadingNaN` (delete leading NaN's specifically)
+    -   **ATTENTION**: update of the `config.ini` needed (open, adjust `ExtendedResolution`, save)
+
+-   Bug fixing (html, images of recognized numbers)
+
+    **ATTENTION: LICENSE CHANGE - removal of MIT License.**
+
+-   Currently no licence published - copyright belongs to author
+
+-   If you are interested in a commercial usage or dedicated versions please contact the developer
+    -   no limits to private usage
+
+## [8.3.0] - Multi Meter Support (2021-09-12)
+
+### Changed
+
+-   Upgrade digital CNN to v12.1.0 (added new images)
+-   Dedicated NaN handling, internal refactoring (CNN-Handling)
+-   HTML: confirmation after config.ini update
+-   Bug fixing
+
+## [8.2.0] - Multi Meter Support (2021-08-24)
+
+### Changed
+
+-   Improve server responsiveness
+
 
-  - If this is not helping, you might need to update your hardware or stay with version 9.2
+-   Flow status and prevalue status in overview
+-   Improved prevalue handling
 
-##### 10.2.0 - Stability Increase (2022-01-14)
+## [8.1.0] - Multi Meter Support (2021-08-12)
 
-- Due to the updated camera driver, the image looks different and a new setup might be needed
+### Changed
 
-  - Update reference image
-  - Update Alignment marks
+-   GPIO: using the general mqtt main topic for GPIO
 
-- Reduce reboot due to camera problems
 
-- Update esp32-camera to new version (master as of 2022-01-09)
+-   Upgrade digital CNN to v12.0.0  (added new images)
+-   Update tfmicro to new master (2021-08-07)
+-   Bug fix: remove text in mqtt value, remove connect limit in wlan reconnet
 
-  
+## [8.0.5] - Multi Meter Support (2021-08-01)
 
-##### 10.1.1 - Stability Increase (2022-01-12)
+### Changed
 
-- Bug Fix MQTT problem
-- Issue:
-  - Changing from v9.x to 10.x the MQTT-parameter "Topic" was renamed into "MainTopic" to address multiple number meters. This renaming should have been done automatically in the background within the graphical configuration, but was not working. Instead the parameter "Topic" was deleted and "MainTopic" was set to disabled and "undefined".
-- ToDo
-  - Update the `html.zip`
-  - If old `config.ini` available: copy it to `/config`, open the graphical configuration and save it again.
-  - If old `config.ini` not available: reset the parameter "MainTopic" within the `config.ini` manually
-  - Reboot
+-   NEW 8.0.5: bug fix: saving prevalue
 
-##### 10.1.0 - Stability Increase (2022-01-09)
 
-- Reduce ESP32 frequency to 160MHz
+-   NEW 8.0.4: bug fix: load config.ini after upgrade
+-   NEW 8.0.3: bug fix: reboot during `config.ini` handling, html error
+-   NEW 8.0.2: saving roundes prevalue, bug fix html server
+-   NEW 8.0.1: bug fix: html handling of parameter `FixedExposure` and `ImageSize`
+-   Dual / multi meter support (more than 1 number to be recognized)
+    This is implemented with the feature "number" on the ROI definition as well as selected options
+-   MQTT: standardization of the naming - including new topics (`json`,  `freeMem`, `uptime`)c
+-   Preparation for extended GPIO support (thanks to Zwerk2k) - not tested and fully functional yet
+-   Bug fixing: html server, memory leak, MQTT connect, hostname, turn of flash LED
 
-- Update tflite (new source: https://github.com/espressif/tflite-micro-esp-examples)
+<span style="color: red;">**ATTENTION: the configuration and prevalue files are modified automatically and will not be backward compatible!**</span>
 
-- Update analog neural network (ana-s3-q-20220105.tflite)
+## [7.1.2] MQTT-Update - (2021-06-17)
 
-- Update digital neural network (dig-s1-q-20220102.tflite)
+### Changed
 
-- Increased web-server buffers
-- bug fix: compiler compatibility
+-   NEW: 7.1.2: bug fix setting hostname, Flash-LED not off during reboot
 
-##### 10.0.2 - Stability Increase (2022-01-01)
 
-- NEW v10.0.2: Corrected JSON error
+-   NEW: 7.1.1: bug fix wlan password with "="  (again)
 
-- Updated compiler toolchain to ESP-IDF 4.3
+-   MQTT error message: changes "no error", send retain flag
 
-- Removal of memory leak
+-   Update wlan handling to esp-idf 4.1
 
-- Improved error handling during startup (check PSRAM and camera with remark in logfile)
+-   Upgrade digital CNN to v8.7.0  (added new images)
 
-- MQTT: implemented raw value additionally, removal of regex contrain
+-   Bug fix: MQTT, WLAN, LED-Controll, GPIO usage, fixed IP, calculation flow rate
 
-- Normalized Parameter ``MaxRateValue``  to "change per minute" 
+## [7.0.1] MQTT-Update - (2021-05-13)
 
-- HTML: improved input handling
+### Changed
 
-- Corrected error handling: in case of error the old value, rate, timestamp are not transmitted any more
+-   NEW: 7.0.1: bug fix wlan password with "="
 
-  
 
-##### 9.2.0 - External Illumination (2021-12-02)
+-   Upgrade digital CNN to v8.5.0  (added new images)
 
-- Direct JSON access: ``http://IP-ADRESS/json`` 
-- Error message in log file in case camera error during startup
-- Upgrade analog CNN to v9.1.0
-- Upgrade digital CNN to v13.3.0 (added new images)
-- html: support of different ports
+-   New MQTT topics: flow rate (units/minute), time stamp (last correct read readout)
 
-##### 9.1.1 - External Illumination (2021-11-16)
+-   Update MQTT/Error topic to " " in case no error (instead of empty string)
 
-- NEW 9.1.1 bug fix: LED implemenetation
-- External LEDs: change control mode (resolve bug with more than 2 LEDs)
-- Additional info into log file
-- Bug fix: decimal shift, html, log file
+-   Portrait or landscape image orientation in rotated image (avoid cropping)
 
-##### 9.0.0 - External Illumination (2021-10-23)
+## [6.7.2] Image Processing in Memory - (2021-05-01)
 
-* Implementation of external illumination to adjust positioning, brightness and color of the illumination now set individually
-  * Technical details can be found in the wiki: https://github.com/jomjol/AI-on-the-edge-device/wiki/External-LED
-    <img src="https://raw.githubusercontent.com/jomjol/ai-on-the-edge-device/master/images/intern_vs_external.jpg" width="500">
-* New housing published for external LEDs and small clearing: https://www.thingiverse.com/thing:5028229
+### Changed
 
+-   NEW 6.7.2: Updated html for setup modus - remove reboot on edit configuration)
 
 
-##### 8.5.0 - Multi Meter Support (2021-10-07)
+-   NEW 6.7.1: Improved stability of camera (back to v6.6.1) - remove black strips and areas
 
-* Upgrade digital CNN to v13.1.0 (added new images)
-* bug fix: wlan password with space, double digit output
+-   Upgrade digital CNN to v8.3.0  (added new type of digits)
 
-##### 8.4.0 - Multi Meter Support (2021-09-25)
+-   Internal update: TFlite (v2.5), esp32cam, startup sequence
 
-* License change (remove MIT license, remark see below)
+-   Rollback to espressif v2.1.0, as v3.2.0 shows unstable reboot
 
-* html: show hostname in title and main page
+-   Bugfix: WLan-passwords, reset of hostname
 
-* configuration: 
+## [6.6.1] Image Processing in Memory - (2021-04-05)
 
-  * moved setting `ExtendedResolution` to individual number settings
-  * New parameter `IgnoreLeadingNaN` (delete leading NaN's specifically)
-  * **ATTENTION**: update of the `config.ini` needed (open, adjust `ExtendedResolution`, save)
+### Changed
 
-* Bug fixing (html, images of recognized numbers)
+-   NEW 6.6.1: failed SD card initialization indicated by fast blinking LED at startup
 
-  
 
-### **ATTENTION: LICENSE CHANGE - removal of MIT License.** 
+-   Improved SD-card handling (increase compatibility with more type of cards)
 
-- Currently no licence published - copyright belongs to author
-- If you are interested in a commercial usage or dedicated versions please contact the developer
-  - no limits to private usage
+## [6.5.0] Image Processing in Memory - (2021-03-25)
 
+### Changed
 
+-   Upgrade digital CNN to v8.2.0  (added new type of digits)
 
-##### 8.3.0 - Multi Meter Support (2021-09-12)
 
-* Upgrade digital CNN to v12.1.0 (added new images)
-* Dedicated NaN handling, internal refactoring (CNN-Handling)
-* HTML: confirmation after config.ini update
-* Bug fixing
+-   Supporting alignment structures in ROI definition
+-   Bug fixing: definition of  hostname in `config.ini`
 
-##### 8.2.0 - Multi Meter Support (2021-08-24)
+## [6.4.0] Image Processing in Memory - (2021-03-20)
 
-* Improve server responsiveness
-* Flow status and prevalue status in overview
-* Improved prevalue handling 
+### Changed
 
-##### 8.1.0 - Multi Meter Support (2021-08-12)
+-   Additional alignment marks for settings the ROIs (analog and digit)
 
-* GPIO: using the general mqtt main topic for GPIO
 
-* Upgrade digital CNN to v12.0.0  (added new images)
-* Update tfmicro to new master (2021-08-07)
-* Bug fix: remove text in mqtt value, remove connect limit in wlan reconnet
+-   Upgrade analog CNN to v7.0.0 (added new type of pointer)
 
-##### 8.0.5 - Multi Meter Support (2021-08-01)
+## [6.3.1] Image Processing in Memory - (2021-03-16)
 
-* NEW 8.0.5: bug fix: saving prevalue
-* NEW 8.0.4: bug fix: load config.ini after upgrade
-* NEW 8.0.3: bug fix: reboot during `config.ini` handling, html error
-* NEW 8.0.2: saving roundes prevalue, bug fix html server
-* NEW 8.0.1: bug fix: html handling of parameter `FixedExposure` and `ImageSize`
-* Dual / multi meter support (more than 1 number to be recognized)
-  This is implemented with the feature "number" on the ROI definition as well as selected options
-* MQTT: standardization of the naming - including new topics (`json`,  `freeMem `, `uptime`)c
-* Preparation for extended GPIO support (thanks to Zwerk2k) - not tested and fully functional yet
-* Bug fixing: html server, memory leak, MQTT connect, hostname, turn of flash LED
+### Changed
 
-<span style="color: red;">**ATTENTION: the configuration and prevalue files are modified automatically and will not be backward compatible!**</span> 
+-   NEW: 6.3.1: bug fixing in initial edit reference image and `config.ini` (Spelling error in `InitialRotate`)
 
-##### 7.1.2 MQTT-Update - (2021-06-17)
 
-* NEW: 7.1.2: bug fix setting hostname, Flash-LED not off during reboot
+-   Initial setup mode: bug fixing, error correction
+-   Bug-fixing
 
-* NEW: 7.1.1: bug fix wlan password with "="  (again)
+## [6.2.2] Image Processing in Memory - (2021-03-10)
 
-* MQTT error message: changes "no error", send retain flag
+### Changed
 
-* Update wlan handling to esp-idf 4.1
+-   NEW 6.2.2: bug fixing
 
-* Upgrade digital CNN to v8.7.0  (added new images)
 
-* Bug fix: MQTT, WLAN, LED-Controll, GPIO usage, fixed IP, calculation flow rate
+-   NEW 6.2.1: Changed brightness and contrast to default if not enabled (resolves to bright images)
 
-  
+-   Determination of fixed illumination settings during startup - speed up of 5s in each run
 
-##### 7.0.1 MQTT-Update - (2021-05-13)
+-   Update digital CNN to v8.1.1 (additional digital images trained)
 
-* NEW: 7.0.1: bug fix wlan password with "=" 
+-   Extended error message in MQTT error message
 
-* Upgrade digital CNN to v8.5.0  (added new images)
+-   Image brightness is now adjustable
 
-* New MQTT topics: flow rate (units/minute), time stamp (last correct read readout)
+-   Bug fixing: minor topics
 
-* Update MQTT/Error topic to " " in case no error (instead of empty string)
+## [6.1.0] Image Processing in Memory - (2021-01-20)
 
-* Portrait or landscape image orientation in rotated image (avoid cropping)
+### Changed
 
-##### 6.7.2 Image Processing in Memory - (2021-05-01)
+-   Disabling of analog / digital counters in configuration
 
-* NEW 6.7.2: Updated html for setup modus - remove reboot on edit configuration)
 
-* NEW 6.7.1: Improved stability of camera (back to v6.6.1) - remove black strips and areas
+-   Improved Alignment Algorithm (`AlignmentAlgo`  = `Default`,  `Accurate` , `Fast`)
+-   Analog counters: `ExtendedResolution` (last digit is extended by sub comma value of CNN)
+-   `config.ini`: additional parameter `hostname`  (additional to wlan.ini)
+-   Switching of GPIO12/13 via http-interface: `/GPIO?GPIO=12&Status=high/low`
+-   Bug fixing: html configuration page, wlan password ("=" now possible)
 
-* Upgrade digital CNN to v8.3.0  (added new type of digits)
+## [6.0.0] Image Processing in Memory - (2021-01-02)
 
-* Internal update: TFlite (v2.5), esp32cam, startup sequence
+### Changed
 
-* Rollback to espressif v2.1.0, as v3.2.0 shows unstable reboot
+-   **Major change**: image processing fully in memory - no need of SD card buffer anymore
 
-* Bugfix: WLan-passwords, reset of hostname
+    -   Need to limit camera resolution to VGA (due to memory limits)
 
 
-##### 6.6.1 Image Processing in Memory - (2021-04-05)
+-   MQTT: Last Will Testament (LWT) implemented: "connection lost" in case of connection lost to `TopicError`
+-   Disabled `CheckDigitIncreaseConsistency` in default configuration - must now be explicit enabled if needed
+-   Update digital CNN to v7.2.1 (additional digital images trained)
+-   Setting of arbitrary time server in `config.ini`
+-   Option for fixed IP-, DNS-Settings in `wlan.ini`
+-   Increased stability (internal image and camera handling)
+-   Bug fixing: edit digits, handling PreValue, html-bugs
 
-* NEW 6.6.1: failed SD card initialization indicated by fast blinking LED at startup
-* Improved SD-card handling (increase compatibility with more type of cards)
+## [5.0.0] Setup Modus - (2020-12-06)
 
-##### 6.5.0 Image Processing in Memory - (2021-03-25)
+### Changed
 
-* Upgrade digital CNN to v8.2.0  (added new type of digits)
-* Supporting alignment structures in ROI definition
-* Bug fixing: definition of  hostname in `config.ini`
+-   Implementation of initial setup modus for fresh installation
 
-##### 6.4.0 Image Processing in Memory - (2021-03-20)
 
-* Additional alignment marks for settings the ROIs (analog and digit)
-* Upgrade analog CNN to v7.0.0 (added new type of pointer)
+-   Code restructuring (full compatibility between pure ESP-IDF and Platformio w/ espressif)
 
-##### 6.3.1 Image Processing in Memory - (2021-03-16)
+## [4.1.1] Configuration editor - (2020-12-02)
 
-* NEW: 6.3.1: bug fixing in initial edit reference image and `config.ini` (Spelling error in `InitialRotate`)
-* Initial setup mode: bug fixing, error correction
-* Bug-fixing
+### Changed
 
-##### 6.2.2 Image Processing in Memory - (2021-03-10)
+-   Bug fixing: internal improvement of file handling (reduce not responding)
 
-* NEW 6.2.2: bug fixing
-* NEW 6.2.1: Changed brightness and contrast to default if not enabled (resolves to bright images)
-* Determination of fixed illumination settings during startup - speed up of 5s in each run
-* Update digital CNN to v8.1.1 (additional digital images trained)
-* Extended error message in MQTT error message
+## [4.1.0] Configuration editor - (2020-11-30)
 
+### Changed
 
-* Image brightness is now adjustable 
+-   Implementation of configuration editor (including basic and expert mode)
 
 
-* Bug fixing: minor topics 
+-   Adjustable time zone to adjust to local time setting (incl. daylight saving time)
 
+-   MQTT: additional topic for error reporting
 
-##### 6.1.0 Image Processing in Memory - (2021-01-20)
+-   standardized access to current logfile via `http://IP-ADRESS/logfileact`
 
-* Disabling of analog / digital counters in configuration 
-* Improved Alignment Algorithm (`AlignmentAlgo`  = `Default`,  `Accurate` , `Fast`)
-* Analog counters: `ExtendedResolution` (last digit is extended by sub comma value of CNN)
-* `config.ini`: additional parameter `hostname`  (additional to wlan.ini)
-* Switching of GPIO12/13 via http-interface: `/GPIO?GPIO=12&Status=high/low`
-* Bug fixing: html configuration page, wlan password ("=" now possible)
+-   Update digital CNN to v7.2.0, analog CNN to 6.3.0
 
-##### 6.0.0 Image Processing in Memory - (2021-01-02)
+-   Bug fixing: truncation error,  CheckDigitConsistency & PreValue implementation
 
-* **Major change**: image processing fully in memory - no need of SD card buffer anymore
+## [4.0.0] Tflite Core - (2020-11-15)
 
-  * Need to limit camera resolution to VGA (due to memory limits)
-* MQTT: Last Will Testament (LWT) implemented: "connection lost" in case of connection lost to `TopicError`
-* Disabled `CheckDigitIncreaseConsistency` in default configuration - must now be explicit enabled if needed
-* Update digital CNN to v7.2.1 (additional digital images trained) 
-* Setting of arbitrary time server in `config.ini`
-* Option for fixed IP-, DNS-Settings in `wlan.ini`
-* Increased stability (internal image and camera handling)
-* Bug fixing: edit digits, handling PreValue, html-bugs
+### Changed
 
+-   Implementation of rolling log-files
 
 
-##### 5.0.0 Setup Modus - (2020-12-06)
+-   Update Tflite-Core to master@20201108 (v2.4)
 
-* Implementation of initial setup modus for fresh installation
+-   Bug-fixing for reducing reboots
 
-* Code restructuring (full compatibility between pure ESP-IDF and Platformio w/ espressif)
+## [3.1.0] MQTT-Client - (2020-10-26)
 
-  
+### Changed
 
-##### 4.1.1 Configuration editor - (2020-12-02)
+-   Update digital CNN to v6.5.0 and HTML (Info to hostname, IP, ssid)
 
-* Bug fixing: internal improvement of file handling (reduce not responding)
+-   New implementation of "checkDigitConsistency" also for digits
 
+-   MQTT-Adapter: user and password for sign in MQTT-Broker
 
-##### 4.1.0 Configuration editor - (2020-11-30)
+## [3.0.0] MQTT-Client  (2020-10-14)
 
-* Implementation of configuration editor (including basic and expert mode)
+### Changed
 
-* Adjustable time zone to adjust to local time setting (incl. daylight saving time)
+-   Implementation of MQTT Client
 
-* MQTT: additional topic for error reporting
 
-* standardized access to current logfile via `http://IP-ADRESS/logfileact`
+-   Improved Version Control
+-   bug-fixing
 
-* Update digital CNN to v7.2.0, analog CNN to 6.3.0
+## [2.2.1] Version Control  (2020-09-27)
 
-* Bug fixing: truncation error,  CheckDigitConsistency & PreValue implementation
+### Changed
 
+-   Bug-Fixing (hostname in wlan.ini and error handling inside flow)
 
+## \[2.2.0| Version Control  (2020-09-27)
 
-##### 4.0.0 Tflite Core - (2020-11-15)
+### Changed
 
-* Implementation of rolling log-files
+-   Integrated automated versioning system (menu: SYSTEM --> INFO)
 
-* Update Tflite-Core to master@20201108 (v2.4)
 
-* Bug-fixing for reducing reboots
+-   Update Build-System to PlatformIO - Espressif 32 v2.0.0 (ESP-IDF 4.1)
 
-  
+## [2.1.0] Decimal Shift, Chrome & Edge  (2020-09-25)
 
-##### 3.1.0 MQTT-Client - (2020-10-26)
+### Changed
 
-* Update digital CNN to v6.5.0 and HTML (Info to hostname, IP, ssid)
+-   Implementation of Decimal Shift
 
-* New implementation of "checkDigitConsistency" also for digits
-* MQTT-Adapter: user and password for sign in MQTT-Broker
 
-##### 3.0.0 MQTT-Client  (2020-10-14)
+-   Update default CNN for digits to v6.4.0
 
-* Implementation of MQTT Client
-* Improved Version Control
-* bug-fixing
+-   Improvement HTML
 
+-   Support for Chrome and Edge
 
+-   Reduce logging to minimum - extended logging on demand
 
-##### 2.2.1 Version Control  (2020-09-27)
+-   Implementation of hostname in wlan.ini (`hostname = "HOSTNAME")`
 
-* Bug-Fixing (hostname in wlan.ini and error handling inside flow)
+-   Bug fixing, code corrections
 
+## [2.0.0] Layout update  (2020-09-12)
 
-##### 2.2.0 Version Control  (2020-09-27)
+### Changed
 
-* Integrated automated versioning system (menu: SYSTEM --> INFO)
-* Update Build-System to PlatformIO - Espressif 32 v2.0.0 (ESP-IDF 4.1)
+-   Update to **new and modern layout**
+-   Support for Chrome improved
+-   Improved robustness: improved error handling in auto flow reduces spontaneous reboots
+-   File server: Option for "DELETE ALL"
+-   WLan: support of spaces in SSID and password
+-   Reference Image: Option for mirror image, option for image update on the fly
+-   additional parameter in `wasserzaehler.html?noerror=true`  to suppress an potential error message
+-   bug fixing
 
+## [1.1.3](2020-09-09)
 
-##### 2.1.0 Decimal Shift, Chrome & Edge  (2020-09-25)
+### Changed
 
-* Implementation of Decimal Shift
+-   **Bug in configuration of analog ROIs corrected** - correction in v.1.0.2 did not work properly
 
-* Update default CNN for digits to v6.4.0
 
-* Improvement HTML
+-   Improved update page for the web server (`/html` can be updated via a zip-file, which is provided in `/firmware/html.zip`)
+-   Improved Chrome support
 
-* Support for Chrome and Edge
+## [1.1.0](2020-09-06)
 
-* Reduce logging to minimum - extended logging on demand
+### Changed
 
-* Implementation of hostname in wlan.ini (`hostname = "HOSTNAME")`
+-   Implementation of "delete complete directory"
+    **Attention: beside the `firmware.bin`, also the content of `/html` needs to be updated!**
 
-* Bug fixing, code corrections
+## [1.0.2](2020-09-06)
 
+### Changed
 
-##### 2.0.0 Layout update  (2020-09-12)
+-   Bug in configuration of analog ROIs corrected
 
-  * Update to **new and modern layout**
-  * Support for Chrome improved
-  * Improved robustness: improved error handling in auto flow reduces spontaneous reboots
-  * File server: Option for "DELETE ALL"
-  * WLan: support of spaces in SSID and password
-  * Reference Image: Option for mirror image, option for image update on the fly
-  * additional parameter in `wasserzaehler.html?noerror=true`  to suppress an potential error message
-  * bug fixing
 
+-   minor bug correction
 
+## [1.0.1](2020-09-05)
 
-##### 1.1.3 (2020-09-09)
+### Changed
 
-* **Bug in configuration of analog ROIs corrected** - correction in v.1.0.2 did not work properly
-* Improved update page for the web server (`/html` can be updated via a zip-file, which is provided in `/firmware/html.zip`)
-* Improved Chrome support
+-   preValue.ini Bug corrected
 
-##### 1.1.0 (2020-09-06)
 
-* Implementation of "delete complete directory"
-  **Attention: beside the `firmware.bin`, also the content of `/html` needs to be updated!**
+-   minor bug correction
 
+## [1.0.0](2020-09-04)
 
+### Changed
 
-##### 1.0.2 (2020-09-06)
+-   **First usable version** - compatible to previous project (<https://github.com/jomjol/water-meter-system-complete>)
 
-* Bug in configuration of analog ROIs corrected
-* minor bug correction
 
-##### 1.0.1 (2020-09-05)
+-   NEW:
+    -   no docker container for CNN calculation necessary
+    -   web based configuration editor on board
 
-* preValue.ini Bug corrected
-* minor bug correction
+## [0.1.0](2020-08-07)
 
-##### 1.0.0 (2020-09-04)
+### Changed
 
-* **First usable version** - compatible to previous project (https://github.com/jomjol/water-meter-system-complete)
-* NEW: 
-  * no docker container for CNN calculation necessary
-  * web based configuration editor on board
+-   Initial Version
 
-##### 0.1.0 (2020-08-07)
+[Unreleased]: https://github.com/haverland/AI-on-the-edge-device/compare/11.3.9...HEAD
 
-* Initial Version
+[11.3.9]: https://github.com/haverland/AI-on-the-edge-device/compare/10.6.2...11.3.9

README.md

@@ -91,7 +91,7 @@ In other cases you can contact the developer via email: <img src="https://raw.gi
   
 
 
-- **NEW v11.3.1**: corrected corupted asset `firmware.bin`
+- **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