Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| a73f171102 | |||
| 157dc0e6cf | |||
| df6428550f | |||
| f1d4a7c1bc |
30
README.md
30
README.md
@@ -1,5 +1,12 @@
|
|||||||
# This [](https://github.com/Myxelium/HomeScreen/actions/workflows/build.yml)
|
[](https://github.com/myxelium/homescreen "Go to GitHub repo")
|
||||||
Core api and Esp32 code for displaying weather data and public transport information on a e-ink display.
|
[](https://github.com/myxelium/homescreen)
|
||||||
|
[](https://github.com/myxelium/homescreen)
|
||||||
|
[](https://github.com/myxelium/homescreen/releases/)
|
||||||
|
[](https://www.gnu.org/licenses/gpl-3.0.en.html)
|
||||||
|
[](https://github.com/myxelium/homescreen/issues)
|
||||||
|
[](https://github.com/Myxelium/HomeScreen/actions/workflows/build.yml)
|
||||||
|
# This
|
||||||
|
Core api and [Esp32 (Microcontroller)](https://en.wikipedia.org/wiki/ESP32) code for displaying weather data and public transport information on a e-ink display.
|
||||||
|
|
||||||
<img width="800" height="480" alt="image" src="https://github.com/user-attachments/assets/ef5af0c6-ea3a-494d-b2af-3de6e70b3e6a" />
|
<img width="800" height="480" alt="image" src="https://github.com/user-attachments/assets/ef5af0c6-ea3a-494d-b2af-3de6e70b3e6a" />
|
||||||
|
|
||||||
@@ -11,8 +18,8 @@ All commits has to follow this [Conventional Commits style](https://www.conventi
|
|||||||
- Display time and date
|
- Display time and date
|
||||||
|
|
||||||
## Requirements 🫥
|
## Requirements 🫥
|
||||||
- ESP32 board
|
- [ESP32 board](https://www.waveshare.com/wiki/E-Paper_ESP32_Driver_Board)
|
||||||
- E-ink display (e.g. Waveshare 7.5 inch)
|
- [E-ink display (e.g. Waveshare 7.5 inch)](https://www.waveshare.com/7.5inch-e-paper-hat.htm)
|
||||||
|
|
||||||
# Installation
|
# Installation
|
||||||
|
|
||||||
@@ -92,7 +99,7 @@ end
|
|||||||
API[HomeControllerAPI]
|
API[HomeControllerAPI]
|
||||||
API -->|MediatR| Handlers
|
API -->|MediatR| Handlers
|
||||||
Handlers -->|Service Calls| Services
|
Handlers -->|Service Calls| Services
|
||||||
Services -->|Refit Clients| Clients
|
Services -->|Refit Http Clients| Clients
|
||||||
Clients -->|External APIs| ExtAPIs
|
Clients -->|External APIs| ExtAPIs
|
||||||
API -->|Returns JSON/JPEG| ESP
|
API -->|Returns JSON/JPEG| ESP
|
||||||
end
|
end
|
||||||
@@ -109,3 +116,16 @@ end
|
|||||||
ExtAPIs -.-> NominatimAPI
|
ExtAPIs -.-> NominatimAPI
|
||||||
ExtAPIs -.-> ResRobotAPI
|
ExtAPIs -.-> ResRobotAPI
|
||||||
```
|
```
|
||||||
|
|
||||||
|
# ESP32 configuration and building
|
||||||
|
<img width="4096" height="1842" alt="image" src="https://github.com/user-attachments/assets/5acf1b3b-f9bb-48bd-b310-a2852544eaba" />
|
||||||
|
|
||||||
|
Best way of getting the ESP32 ready for code upload is to follow this guide [WAVESHARE ESP32 GUIDE](https://web.archive.org/web/20250706150325/https://www.waveshare.com/wiki/E-Paper_ESP32_Driver_Board).
|
||||||
|
Once you have it ready so you can upload code to it copy my code in: Esp32_Code/INFOSCREEN_WITH_INTERVAL from this repo.
|
||||||
|
|
||||||
|
Install following libraries (if more is needed search for them and install them too):
|
||||||
|
* ArduinoJson
|
||||||
|
* GUI_Paint
|
||||||
|
* JPEGDEC
|
||||||
|
|
||||||
|
You need the Waveshare examples installed since it uses code from them. See above link to find the download.
|
||||||
|
|||||||
Reference in New Issue
Block a user