diff --git a/docs/Additional-Information.md b/docs/Additional-Information.md index c5fec93..f8e488f 100644 --- a/docs/Additional-Information.md +++ b/docs/Additional-Information.md @@ -1,8 +1,8 @@ The following links point to additional information in other repos: # Digits -* [Training and using a neural network to readout the value of a digital counter](https://github.com/jomjol/neural-network-digital-counter-readout) * [Training the CNN neural network](https://github.com/jomjol/neural-network-digital-counter-readout/blob/master/Train_Network.md) +* [Training and using a neural network to readout the value of a digit counter](https://github.com/jomjol/neural-network-digital-counter-readout) # Analog * [Training and using a neural network to read out the value of an analog display](https://github.com/jomjol/neural-network-analog-needle-readout) diff --git a/docs/Best-Practice.md b/docs/Best-Practice.md index 4df3004..557fa28 100644 --- a/docs/Best-Practice.md +++ b/docs/Best-Practice.md @@ -6,7 +6,7 @@ This page shows some best practices: * Move the Camera as close as possible (~4cm), this will help get rid of reflections. -> focus can be adjusted by turning the outer black ring of the camera. * If the LED reflections are too strong, put tape over the LED to diffuse the light -* Change the ImageSize to QVGA under "Expert mode" configuration when close enough, this will be faster and is often good enough for digital recognition. +* Change the ImageSize to QVGA under "Expert mode" configuration when close enough, this will be faster and is often good enough for digit recognition. ## Reflections @@ -18,4 +18,4 @@ This page shows some best practices: * Filter out the Number "9", as "3" will often be misread for a "9" and void every number between 3 and 9 due to it being negative flow. * Split the readings into two, while the decimal numbers might move to fast to be recognized, at least the slower moving part will produce a correct reading. -> keep in mind that the offset needs to be adjusted, a.e if you have a comma reading of "3", it needs to become "0.3". This can be done wherever the data ends up being sent, like home assistant using sensor templates. -* If you are using a low resolution and only digital mode, processing can often be done in <1 minute. Check the logs to confirm how fast it is and then set the interval accordingly under "Expert mode" in configuration, as the normal mode will lock you to 3+ minutes. +* If you are using a low resolution and only digit mode, processing can often be done in <1 minute. Check the logs to confirm how fast it is and then set the interval accordingly under "Expert mode" in configuration, as the normal mode will lock you to 3+ minutes. diff --git a/docs/Correction Algorithm.md b/docs/Correction Algorithm.md index 9f7ec93..b01c6d5 100644 --- a/docs/Correction Algorithm.md +++ b/docs/Correction Algorithm.md @@ -18,7 +18,7 @@ The last correct read value. PreValue is here a bit missleading, because normall ##### Digits -Value that are digitized from a digital number. There are 11 allowed values for this: +Value that are digitized from a digit number. There are 11 allowed values for this: 1. Digits: 0, 1, 2, ... 9 2. N = Not-a-Number - representing a not unique state between two numbers @@ -51,9 +51,9 @@ If the ``ExtendedResolution`` setting is true, there is an exception where the v The ``DecimalShift`` setting puts the decimal point in the right place. It acts like a shift. Negative values shift the decimal point to the left. Positive values move the decimal point to the right, filling with zero. -###### ``AnalogDigitalTransitionStart`` +###### ``AnalogDigitTransitionStart`` -For detailed description see [Analog-digital-transition](Watermeter-specific-analog---digital-transition.md). +For detailed description see [Analog-digit-transition](Watermeter-specific-analog---digit-transition.md). ###### ``MaxRateValue`` and ``MaxRateType`` diff --git a/docs/Error-Debugging.md b/docs/Error-Debugging.md index d2c27f1..1fead12 100644 --- a/docs/Error-Debugging.md +++ b/docs/Error-Debugging.md @@ -20,13 +20,13 @@ If after those adjustment you still have some issues, you can try to adjust your -## My Analog Meter are recognized as Digital Counter or vice versa +## My Analog Meter are recognized as Digit Counter or vice versa 1. First, check that your ROI are correctly defined (yey!) -2. Second, verify that the name of your ROI analog and digital ROIs are different +2. Second, verify that the name of your ROI analog and digit ROIs are different ## Recognition is working well, but number aren't sorted correctly diff --git a/docs/ROI-Configuration.md b/docs/ROI-Configuration.md index 5e0ed6a..142aacd 100644 --- a/docs/ROI-Configuration.md +++ b/docs/ROI-Configuration.md @@ -13,7 +13,7 @@ The most critical components for an accurate detection are: 2. Using a well trained Model. - Have a look on the [Digital Counters](https://jomjol.github.io/neural-network-digital-counter-readout/) resp. [Analog Needles](https://jomjol.github.io/neural-network-analog-needle-readout) to check if your types are contained. If your number types are **not** contained, you should take the effort to record them so we can add them to the training data. See [Collect images to improve the models](Learn-models-with-your-own-images.md) on how to collect new training data. + Have a look on the [Digit Counters](https://jomjol.github.io/neural-network-digital-counter-readout/) resp. [Analog Needles](https://jomjol.github.io/neural-network-analog-needle-readout) to check if your types are contained. If your number types are **not** contained, you should take the effort to record them so we can add them to the training data. See [Collect images to improve the models](Learn-models-with-your-own-images.md) on how to collect new training data. ## Precondition @@ -63,7 +63,7 @@ Here is an example with the details for the ROI `ana1`: ### Digits -For the Digital Meters it is a little bit more complicated, as there are different options of digital models which can be choosen. +For the Digit Meters it is a little bit more complicated, as there are different options of digit models which can be choosen. #### Correct Size for ROI First of all, choose the right size of the ROI. @@ -79,7 +79,7 @@ Here we only show the different configuration of the ROIs. -1. Digital Meters with only recognized full digits (`0, 1, 2, 3, ... 9`) +1. Digit Meters with only recognized full digits (`0, 1, 2, 3, ... 9`) Suggested Model: `dig-class11-*.tfl` @@ -87,7 +87,7 @@ Here we only show the different configuration of the ROIs. **Disadvantage:** partially rotated numbers cannot be detected. -2. Digital Meters with sub-digit resolution (`0.0, 0.1, 0.2, .... 9.8, 9.9`) +2. Digit Meters with sub-digit resolution (`0.0, 0.1, 0.2, .... 9.8, 9.9`) Suggested Model: `dig-cont-*.tfl` or `dig-class100-*.tfl` diff --git a/docs/data-logging.md b/docs/data-logging.md index 7d883f1..9aaf5c8 100644 --- a/docs/data-logging.md +++ b/docs/data-logging.md @@ -7,4 +7,4 @@ The data files are stored in `/log/data` on the SD-Card. ## Data Format The data is stored as CSV with the following columns: -`time`, `name-of-number`, `raw-value`, `return-value`, `pre-value`, `change-rate`, `change-absolute`, `error-text`, `cnn-digital`, `cnn-analog` \ No newline at end of file +`time`, `name-of-number`, `raw-value`, `return-value`, `pre-value`, `change-rate`, `change-absolute`, `error-text`, `cnn-digit`, `cnn-analog` \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 548f676..8e8fce7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -48,7 +48,7 @@ This all is integrated in an easy to do setup and use environment, taking care f The task to be demonstrated here is an automated readout of an analog water meter. The water consumption is to be recorded within a house automatization and the water meter is totally analog without any electronic interface. Therefore, the task is solved by regularly taking an image of the water meter and digitizing the reading. -There are two types of CNN implemented, a classification network for reading the digital numbers and a single output network for digitalize the analog pointers for the sub digit readings. +There are two types of CNN implemented, a classification network for reading the digit numbers and a single output network for digitize the analog pointers for the sub digit readings. This project is an evolution of the [water-meter-system-complete](https://github.com/jomjol/water-meter-system-complete), which uses ESP32-CAM just for taking the image and a 1GB-Docker image to run the neural network's backbone. Here everything is integrated in an ESP32-CAM module with 8MB of RAM and a SD card as data storage. diff --git a/docs/nav.yml b/docs/nav.yml index 69a503f..0048ccb 100644 --- a/docs/nav.yml +++ b/docs/nav.yml @@ -26,7 +26,7 @@ nav: - data-logging.md - Password-Protection.md - unstable-installation.md - - Watermeter-specific-analog---digital-transition.md + - Watermeter-specific-analog---digit-transition.md - collect-new-images.md - Learn-models-with-your-own-images.md - Correction Algorithm.md