1 Commits

Author SHA1 Message Date
Myx
a3d2ee8ad4 More info 2025-07-20 17:46:17 +02:00
2 changed files with 11 additions and 52 deletions

View File

@@ -81,13 +81,11 @@ 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 # ← change to "main" if that's your default branch: master
patchAll: true patchAll: true # Always increment patch number
# 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 }}
@@ -96,21 +94,6 @@ jobs:
release_name: Release ${{ steps.semver.outputs.next }} release_name: Release ${{ steps.semver.outputs.next }}
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: |

View File

@@ -1,25 +1,16 @@
[![myxelium - homescreen](https://img.shields.io/static/v1?label=myxelium&message=homescreen&color=purple&logo=github)](https://github.com/myxelium/homescreen "Go to GitHub repo") # This [![Build and Deploy](https://github.com/Myxelium/HomeScreen/actions/workflows/build.yml/badge.svg)](https://github.com/Myxelium/HomeScreen/actions/workflows/build.yml)
[![stars - homescreen](https://img.shields.io/github/stars/myxelium/homescreen?style=social)](https://github.com/myxelium/homescreen) Core api and Esp32 code for displaying weather data and public transport information on a e-ink display.
[![forks - homescreen](https://img.shields.io/github/forks/myxelium/homescreen?style=social)](https://github.com/myxelium/homescreen)
[![GitHub tag](https://img.shields.io/github/tag/myxelium/homescreen?include_prereleases=&sort=semver&color=purple)](https://github.com/myxelium/homescreen/releases/)
[![License](https://img.shields.io/badge/License-GPL-purple)](https://www.gnu.org/licenses/gpl-3.0.en.html)
[![issues - homescreen](https://img.shields.io/github/issues/myxelium/homescreen)](https://github.com/myxelium/homescreen/issues)
[![Build and Deploy](https://github.com/Myxelium/HomeScreen/actions/workflows/build.yml/badge.svg)](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" />
## Git Notes ## Features
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](https://www.waveshare.com/wiki/E-Paper_ESP32_Driver_Board) - ESP32 board
- [E-ink display (e.g. Waveshare 7.5 inch)](https://www.waveshare.com/7.5inch-e-paper-hat.htm) - E-ink display (e.g. Waveshare 7.5 inch)
# Installation # Installation
@@ -87,7 +78,6 @@ 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]
@@ -96,10 +86,10 @@ ESP -->|HTTP GET /home/default.jpg| API
end end
subgraph HomeApi subgraph HomeApi
API[HomeControllerAPI] API[HomeController (API)]
API -->|MediatR| Handlers API -->|MediatR| Handlers
Handlers -->|Service Calls| Services Handlers -->|Service Calls| Services
Services -->|Refit Http Clients| Clients Services -->|Refit Clients| Clients
Clients -->|External APIs| ExtAPIs Clients -->|External APIs| ExtAPIs
API -->|Returns JSON/JPEG| ESP API -->|Returns JSON/JPEG| ESP
end end
@@ -114,18 +104,4 @@ end
ExtAPIs -.-> WeatherAPI ExtAPIs -.-> WeatherAPI
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. See above link to find the download.