Mirror/AI-on-the-edge-device-docs
1
0
Fork 0
mirror of https://github.com/jomjol/AI-on-the-edge-device-docs.git synced 2025-12-07 12:07:01 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add Makefile and Markdown linter (#73)

Browse Source 
* Add Makefile

* Update .gitignore to exclude venv

* Add requirements.txt for venv

* Add pymarkdown lint Github action

* Update .md from lint tool

* Update README with make commands

* Add linter config
This commit is contained in:
Adriaan Van Niekerk
2025-10-31 01:06:36 +02:00
committed by GitHub
parent bbe3bd79db
commit 0cd98c67e2
44 changed files with 524 additions and 279 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/Configuration.md
View File

@@ -1,4 +1,5 @@
# Graphical Configuration
Most of the settings can be modified on the Settings page:
<img src="../img/config_s1_access.jpg" width="600" align="middle">
@@ -12,18 +13,20 @@ It can be reached via the menu `Settings > Configuration`.
All parameters are documented on the [Parameters](Parameters.md) page and as tooltips on the config page.
## Expert Parameters
Some parameters are treated as **Expert Parameters** and are hidden by default.
Tick the checkbox in the top left corner to enable them:
![](img/expert-parameters.png)
![Expert Parameters](img/expert-parameters.png)
The **Expert Parameters** then will be shown with a red background:
![](img/expert-parameters2.png)
![Second Expert Parameters](img/expert-parameters2.png)
## Manual Editing of the Config File
Even more configuration parameters can be edited manually in the `config.ini`:
![](img/manual-config-editing.png)
![Manual Config Editing](img/manual-config-editing.png)
To edit the `config.ini` file directly, click on the `Edit Config.ini directly` button.
@@ -35,31 +38,40 @@ To edit the `config.ini` file directly, click on the `Edit Config.ini directly`
The principle is very simple and can most easily be described as a flow of processing steps. Each step has a dedicated parameter description in the `config.ini`, which is indicated by brackets ```[name_of_step]```. The steps are processed in the order written in the config file. That means, that you first have to describe the image taking, then the aligning and cutting and only after that you can start to config a neural network. The last step is the post processing.
### Processing steps - Overview
### Processing steps - Overview
In the following you get a short overview over the available steps. This order is also the suggested order for the processing flow. Single steps can be left out, if not needed (e.g. omit the analog part, if only digits are present)
#### 1. `[TakeImage]`
This steps parametrises the taking of the image by the ESP32-CAM. Size, quality and storage for logging and debugging can be set.
#### 2. `[Alignment]`
Image preprocessing, including image alignment with reference images
#### 3. `[Digits]`
Neural network evaluation of an image for digits. The neural network is defined by a tflite formatted file and the output is a number between 0 .. 9 or NaN (if image is not unique enough)
#### 4. `[Analog]`
Neural network evaluation of analog counter. The neural network is defined by a tflite formatted file and the output is a number between 0.0 .. 9.9, representing the position of the pointer.
#### 5. `[PostProcessing]`
Summarized the individually converted pictures to the overall result. It also implements some error corrections and consistency checks to filter wrong reading.
For more details look at [Correction Algorithm](Correction%20Algorithm.md)).
#### 6. `[MQTT]`
Transfer of the readings to a MQTT server.
#### 7. `[AutoTimer]`
Configuration of the automated flow start at the start up of the ESP32.
Configuration of the automated flow start at the start up of the ESP32.
#### 8. `[Debug]`
Configuration for debugging details