readme modif

This commit is contained in:
Aurélien Gauthier 2026-01-05 13:16:02 +01:00
parent f9cc9679cc
commit 5b9c3dd174

View file

@ -1,7 +1,7 @@
# Arduino-Photometrics <!-- ![CI][] --> # Arduino-Photometrics <!-- ![CI][] -->
**Arduino-photometrics** is sub-part of **Robot Go West**, this project aim to collect lighting data of location for training a prediction model for retrieve the location of the sun. **Arduino-photometrics** is sub-part of **Robot Go West**, this project aim to collect lighting data of location for training a prediction model for retrieve the location of the sun.
The embedded part is made in **C++**, the update RTC time file and the extraction data measure file are made in **Python**. The embedded part is made in **C++**, the update RTC time and the extraction data measure files are made in **Python**.
## Arduino mounting ## Arduino mounting
![Arduino mounting](images/montage.drawio.png) ![Arduino mounting](images/montage.drawio.png)
@ -17,8 +17,7 @@ All executables files are in `exec/` folder.
## Tutorial ## Tutorial
In first, you need to mount the arduino (image shown higher in the Readme). In first, you need to mount the arduino (image shown higher in the Readme).
(Optional) You can download and create the support with a 3D printer from [Link Text](https://example.com) made by [id]. (Optional) You can download and create the support with a 3D printer from [PotPhotoResistance](https://git.cohabit.fr/gowest/gowest/src/branch/photosupport/photosupport/) made by **Jhodi Avizara**.
<!-- ![Support]() -->
Now, you can simply download the project from this webpage. Now, you can simply download the project from this webpage.
Open VSCode with the PlatformIO extension on the project directory. Open VSCode with the PlatformIO extension on the project directory.
@ -40,7 +39,8 @@ After the electrical mounting, place **print_min_max_res()** in the main loop fu
Make a scale range by putting place photo sensors in the dark, for exemple with a box (darkest as possible). Make a scale range by putting place photo sensors in the dark, for exemple with a box (darkest as possible).
Then illuminate photo sensors with the direct lightin sun or a lamp (prefere the brightess as possible). Then illuminate photo sensors with the direct lightin sun or a lamp (prefere the brightess as possible).
Once the previous steps are done, write arduino min max serial printed data by print_min_max_res() into min_res and max_res for each sensor. Once the previous steps are done, write arduino min max serial printed data by print_min_max_res() into min_res and max_res for each sensor.
The soft will normalise your data for compresse them in uint_8 type (smaller information to store). The soft will normalise your data for compresse them in uint_8 type (smaller information to store).
**TODO:** Improve this description parts **TODO:** Improve this description parts
### RTC update ### RTC update