Add Makefile and Markdown linter (#73)

* 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

View File

@@ -1,18 +1,22 @@
# Best Practice
This page shows some best practices:
## Camera Placement
## Camera Placement
* 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 digit recognition.
## Reflections
* Try to get rid of the reflections by rotating the camera, so that the reflections are at positions, where no number is.
* By using the external LED option, you can place WS2812 LEDs freely away from the main axis.
* Users report, that a handy cover foil could also help
## Post-processing
* 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.