Compare commits
20 Commits
Add-more-i
...
v0.1.3
| Author | SHA1 | Date | |
|---|---|---|---|
| 3b9d5bc984 | |||
| a73f171102 | |||
| 157dc0e6cf | |||
| df6428550f | |||
| f1d4a7c1bc | |||
| 485453bc7d | |||
| 661fe4dfd6 | |||
| 0207899f1b | |||
| 359a1359f5 | |||
| 62fbdf3d5a | |||
| ec02f17089 | |||
| a164c0059b | |||
| a45f60c09e | |||
| 93ad7ba411 | |||
| 592b44ee43 | |||
| 1f78fedcb3 | |||
| 58858700d9 | |||
| 2c86c7741d | |||
| fc52024d5a | |||
| d768b8ae3f |
21
.github/workflows/build.yml
vendored
21
.github/workflows/build.yml
vendored
@@ -81,11 +81,13 @@ jobs:
|
|||||||
uses: ietf-tools/semver-action@v1
|
uses: ietf-tools/semver-action@v1
|
||||||
with:
|
with:
|
||||||
token: ${{ secrets.GITHUB_TOKEN }}
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
branch: master
|
branch: master # ← change to "main" if that's your default
|
||||||
patchAll: true # Always increment patch number
|
patchAll: true
|
||||||
|
# fallbackTag: v0.0.1 # ← optionally bootstrap from an existing tag
|
||||||
|
|
||||||
- name: Create GitHub Release
|
- name: Create GitHub Release
|
||||||
if: ${{ github.event.inputs.create_release != 'false' }}
|
if: ${{ github.event.inputs.create_release != 'false' }}
|
||||||
|
id: create_release # ← this is required
|
||||||
uses: actions/create-release@v1
|
uses: actions/create-release@v1
|
||||||
env:
|
env:
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
@@ -95,6 +97,21 @@ jobs:
|
|||||||
draft: false
|
draft: false
|
||||||
prerelease: false
|
prerelease: false
|
||||||
|
|
||||||
|
- name: Zip the build for github release
|
||||||
|
if: ${{ github.event.inputs.create_release != 'false' }}
|
||||||
|
run: Compress-Archive -Path './output/*' -DestinationPath './output/HomeScreen_Build_${{ steps.semver.outputs.next }}.zip' -CompressionLevel Optimal -Force
|
||||||
|
|
||||||
|
- name: Upload Release Asset
|
||||||
|
if: ${{ github.event.inputs.create_release != 'false' }}
|
||||||
|
uses: actions/upload-release-asset@v1
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
with:
|
||||||
|
upload_url: ${{ steps.create_release.outputs.upload_url }} # ← now available
|
||||||
|
asset_path: ./output/HomeScreen_Build_${{ steps.semver.outputs.next }}.zip
|
||||||
|
asset_name: HomeScreen_Build_${{ steps.semver.outputs.next }}.zip
|
||||||
|
asset_content_type: application/zip
|
||||||
|
|
||||||
- name: Generate appsettings.json
|
- name: Generate appsettings.json
|
||||||
run: |
|
run: |
|
||||||
$appSettings = @{
|
$appSettings = @{
|
||||||
|
|||||||
40
README.md
40
README.md
@@ -1,16 +1,25 @@
|
|||||||
# 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" />
|
||||||
|
|
||||||
## Features
|
## Git Notes
|
||||||
|
All commits has to follow this [Conventional Commits style](https://www.conventionalcommits.org/) to pass the pipeline.
|
||||||
|
## Features 😺
|
||||||
- Display current weather data
|
- Display current weather data
|
||||||
- Display public transport information
|
- Display public transport information
|
||||||
- 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
|
||||||
|
|
||||||
@@ -78,6 +87,7 @@ API endpoints:
|
|||||||
|
|
||||||
When running, API documentation is available through Scalar at `/scalar`.
|
When running, API documentation is available through Scalar at `/scalar`.
|
||||||
|
|
||||||
|
```mermaid
|
||||||
flowchart TD
|
flowchart TD
|
||||||
subgraph ESP32 Device
|
subgraph ESP32 Device
|
||||||
ESP[ESP32 E-Ink Display]
|
ESP[ESP32 E-Ink Display]
|
||||||
@@ -86,10 +96,10 @@ ESP -->|HTTP GET /home/default.jpg| API
|
|||||||
end
|
end
|
||||||
|
|
||||||
subgraph HomeApi
|
subgraph HomeApi
|
||||||
API[HomeController (API)]
|
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
|
||||||
@@ -105,3 +115,17 @@ end
|
|||||||
ExtAPIs -.-> AuroraAPI
|
ExtAPIs -.-> AuroraAPI
|
||||||
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 download them here [Download](https://files.waveshare.com/upload/5/50/E-Paper_ESP32_Driver_Board_Code.7z) or check above link.
|
||||||
|
|||||||
Reference in New Issue
Block a user