Initialize docs and hello display
This commit is contained in:
@@ -0,0 +1,51 @@
|
||||
# Arduino Info Display
|
||||
|
||||
Small info display project for an Arduino MKR1000 with:
|
||||
|
||||
- SH1106 OLED display
|
||||
- AM2302 temperature and humidity sensor
|
||||
- Two control buttons
|
||||
|
||||
The device is intended to show a compact set of useful screens, navigated with:
|
||||
|
||||
- `Select` button
|
||||
- `Next` button
|
||||
|
||||
## Planned Screens
|
||||
|
||||
The display should support at least these views:
|
||||
|
||||
- Local time
|
||||
- Weather forecast
|
||||
- Temperature from the AM2302 sensor
|
||||
- Humidity from the AM2302 sensor
|
||||
|
||||
Additional screens can be added later once the basic navigation and data sources are in place.
|
||||
|
||||
## Project Status
|
||||
|
||||
This repository is currently in the documentation and planning stage.
|
||||
|
||||
- PlatformIO project initialized
|
||||
- Target board configured as `mkr1000USB`
|
||||
- Initial hardware wiring notes documented
|
||||
- Application code not started yet
|
||||
|
||||
## Repository Layout
|
||||
|
||||
- [`platformio.ini`](platformio.ini): PlatformIO configuration
|
||||
- [`src/main.cpp`](src/main.cpp): Placeholder application entry point
|
||||
- [`docs/project-overview.md`](docs/project-overview.md): Functional scope and behavior
|
||||
- [`docs/hardware-notes.md`](docs/hardware-notes.md): Component and wiring notes
|
||||
|
||||
## Initial Goals
|
||||
|
||||
- Build a stable display loop for multiple screens
|
||||
- Support simple button-based navigation
|
||||
- Read local temperature and humidity from the AM2302
|
||||
- Show time and weather information on the OLED
|
||||
- Keep the software structure easy to extend later
|
||||
|
||||
## Notes
|
||||
|
||||
The current hardware pin mapping is documented in [`docs/hardware-notes.md`](docs/hardware-notes.md). That file can be extended later with any extra electrical notes, display module specifics, or wiring photos if needed.
|
||||
Reference in New Issue
Block a user