diff --git a/README.md b/README.md index c81d27b..12813fb 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,9 @@ ## What is it ? -An ATMEGA328PU and NRF24L01+ based weather station operating on a single 18650 li-ion battery (or equivalent) and a solar panel : +An ATMEGA328PU and NRF24L01+ based weather station operating on a single 18650 li-ion battery (or equivalent) and a solar panel. + +**Check the LICENSE.md file at the root of this project for more information.** ![](http://82.64.196.164/images/git/weather_station_under.jpg) @@ -14,12 +16,39 @@ The station is equipped with the following sensors and has these functionalities * Humidity (HTU21) * Pressure (BMP280) * Sunlight (LDR) -* Battery level indication (ATMEGA's ADC) +* Battery level indication (ATMEGA's 10 bit ADC) + +## Project folder architecture +``` json +/ +|_src This folder contains all the C/C++ file sources. +| \_app This folder contains the main app and it's dependencies. +| |_libs This folder contains all the required 3rd party libraries that should be put in "Arduino\libraries" folder in order for the app to compile. +| |_test This folder contains a test program which was used to test the dependencies. +| +|_schematic +| \_KiCad This folder contains the KiCad files associated with the project. +| |_ATMEGA328PU_lowPower_weather_station.pdf Which is the most recent schematic exported as a pdf for quick viewing. +| +|_documentation This folder may one day contain the associated documentation if needed. +| +|_.gitignore +|_LICENSE.md +|_README.md The content of this page +``` ## The hardware : +Here is a list of the parts used to build the station with a link to the page of each products : +* [Solar panel : 72x72](https://fr.aliexpress.com/item/4001240640418.html?spm=a2g0s.9042311.0.0.27426c3741mIVH) +* [NRF24L01](https://fr.aliexpress.com/item/32976054389.html?spm=a2g0o.cart.0.0.657d3c00t37c7e&mp=1) +* [TC4056 (1 cell lipo charge/discharge protection)](https://fr.aliexpress.com/item/4000522397541.html?spm=a2g0o.productlist.0.0.175b30dfajsyO5&algo_pvid=203adaed-55ba-4678-a3e4-3aafcad89952&algo_exp_id=203adaed-55ba-4678-a3e4-3aafcad89952-1) +* [BMP280 pressure sensor](https://fr.aliexpress.com/item/32228095913.html?spm=a2g0s.9042311.0.0.27426c3741mIVH) +* [SHT/HTU 21 humidity sensor](https://fr.aliexpress.com/item/32787282185.html?spm=a2g0s.9042311.0.0.27426c3741mIVH) +* [ATMEGA328PU board](https://fr.aliexpress.com/item/4000190780977.html?spm=a2g0o.store_pc_allProduct.8148356.4.66547f0dNb2qkV) +* [3.3V LDO for the power rail : RT9013-33PB](https://fr.aliexpress.com/item/4001097171645.html?spm=a2g0o.productlist.0.0.48aa7800HoFD4h&algo_pvid=454c2fa4-a1a9-4ec2-9398-00d598a20b67&algo_exp_id=454c2fa4-a1a9-4ec2-9398-00d598a20b67-0) +* [LDR type : 5528](https://fr.aliexpress.com/item/32623615207.html?spm=a2g0o.productlist.0.0.41a66ceaAE4l8B&algo_pvid=b7699cb3-9564-4a0e-bfb2-cf66f2917b04&algo_exp_id=b7699cb3-9564-4a0e-bfb2-cf66f2917b04-0) -**The main board** - +### This is what my board looks like : Top view : ![](http://82.64.196.164/images/git/weather_station_pcb_back.jpg)