15 Commits

Author SHA1 Message Date
Myx
8284ae9695 fix: remove redundant files 2025-07-21 03:02:17 +02:00
c575f52ebb Update README.md 2025-07-21 02:48:50 +02:00
4d2ee85cbe docs: add wiki 2025-07-21 02:23:43 +02:00
d6364fc975 docs: Update to new repo name 2025-07-21 00:07:44 +02:00
7ff39ea252 ci: remove image url 2025-07-21 00:01:53 +02:00
b61de80e8a ci: Add placeholder appsettings.json and include index page 2025-07-20 23:56:53 +02:00
c53f6a3f77 fix: readme 2025-07-20 20:01:01 +02:00
7fe92790d7 fix: add better description of what this is 2025-07-20 20:00:05 +02:00
3b9d5bc984 fix: download link 2025-07-20 19:45:21 +02:00
a73f171102 fix: minor readme fix 2025-07-20 19:39:31 +02:00
157dc0e6cf Fix: Add ESP32 Doc 2025-07-20 19:37:17 +02:00
df6428550f feat: Release version 2025-07-20 19:23:53 +02:00
f1d4a7c1bc fix: Update README.md 2025-07-20 19:17:47 +02:00
485453bc7d fix: formatting mistake 2025-07-20 18:58:25 +02:00
661fe4dfd6 fix: release address 2025-07-20 18:56:02 +02:00
5 changed files with 106 additions and 45 deletions

View File

@@ -3,7 +3,7 @@ name: Build and Deploy
on: on:
push: push:
branches: branches:
- master # Change to your default branch if different - master
workflow_dispatch: workflow_dispatch:
inputs: inputs:
environment: environment:
@@ -28,7 +28,7 @@ on:
jobs: jobs:
build: build:
runs-on: self-hosted # Ensure your self-hosted runner is configured runs-on: self-hosted
environment: ${{ github.event.inputs.environment || 'prod' }} environment: ${{ github.event.inputs.environment || 'prod' }}
steps: steps:
- name: Get Current User - name: Get Current User
@@ -43,7 +43,7 @@ jobs:
- name: Set up .NET - name: Set up .NET
uses: actions/setup-dotnet@v2 uses: actions/setup-dotnet@v2
with: with:
dotnet-version: '9.0' # Change to your required .NET version dotnet-version: '9.0'
- name: Restore .NET Dependencies - name: Restore .NET Dependencies
run: dotnet restore ./HomeApi.sln run: dotnet restore ./HomeApi.sln
@@ -75,6 +75,24 @@ jobs:
Write-Host "ChromeHeadlessShell not found in published output" Write-Host "ChromeHeadlessShell not found in published output"
} }
# Check wwwroot and manually copy if missing
- name: Ensure wwwroot is Included
run: |
if (-not (Test-Path -Path "./output/dotnet/wwwroot")) {
Write-Host "wwwroot folder not found in published output, manually copying..."
# Check if wwwroot exists in project directory
$sourceWwwroot = "./HomeApi/wwwroot"
if (Test-Path -Path $sourceWwwroot) {
Write-Host "Found wwwroot directory in source, copying..."
New-Item -ItemType Directory -Path "./output/dotnet/wwwroot" -Force
Copy-Item -Path "$sourceWwwroot/*" -Destination "./output/dotnet/wwwroot" -Recurse -Force
} else {
Write-Host "WARNING: Could not find wwwroot in source directory!"
}
}
- name: Generate SemVer version - name: Generate SemVer version
if: ${{ github.event.inputs.create_release != 'false' }} if: ${{ github.event.inputs.create_release != 'false' }}
id: semver id: semver
@@ -82,10 +100,11 @@ jobs:
with: with:
token: ${{ secrets.GITHUB_TOKEN }} token: ${{ secrets.GITHUB_TOKEN }}
branch: master branch: master
patchAll: true # Always increment patch number patchAll: true
- 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
uses: actions/create-release@v1 uses: actions/create-release@v1
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -95,20 +114,59 @@ jobs:
draft: false draft: false
prerelease: false prerelease: false
- name: Create placeholder appsettings for release
if: ${{ github.event.inputs.create_release != 'false' }}
run: |
$appSettings = @{
Logging = @{
LogLevel = @{
Default = "Information"
"Microsoft.AspNetCore" = "Warning"
}
}
ApiConfiguration = @{
EspConfiguration = @{
InformationBoardImageUrl = "http://server_ip:port/home/default.jpg"
UpdateIntervalMinutes = [int]"${{ vars.ESP_UPDATE_INTERVAL }}"
BlackTextThreshold = [int]"${{ vars.ESP_BLACK_TEXT_THRESHOLD }}"
EnableDithering = [System.Convert]::ToBoolean("${{ vars.ESP_ENABLE_DITHERING }}")
DitheringStrength = [int]"${{ vars.ESP_DITHERING_STRENGTH }}"
EnhanceContrast = [System.Convert]::ToBoolean("${{ vars.ESP_ENHANCE_CONTRAST }}")
ContrastStrength = [int]"${{ vars.ESP_CONTRAST_STRENGTH }}"
IsHighContrastMode = [System.Convert]::ToBoolean("${{ vars.ESP_HIGH_CONTRAST_MODE }}")
}
Keys = @{
Weather = "SET THIS TO YOUR KEY"
ResRobot = "SET THIS TO YOUR KEY"
}
BaseUrls = @{
Nominatim = "${{ vars.NOMINATIM_URL }}"
Aurora = "${{ vars.AURORA_URL }}"
Weather = "${{ vars.WEATHER_URL }}"
ResRobot = "${{ vars.RES_ROBOT_URL }}"
}
DefaultCity = "CITY ADDRESS"
DefaultStation = "YOUR STATION"
}
AllowedHosts = "*"
}
$appSettings | ConvertTo-Json -Depth 10 | Set-Content -Path "./output/dotnet/appsettings.json"
Write-Host "Created placeholder appsettings.json successfully"
- name: Zip the build for github release - name: Zip the build for github release
if: ${{ github.event.inputs.create_release != 'false' }} if: ${{ github.event.inputs.create_release != 'false' }}
run: Compress-Archive -Path './output/*' -DestinationPath './output/HomeScreen_Build_${{ steps.semver.outputs.next }}.zip' -CompressionLevel Optimal -Force run: Compress-Archive -Path './output/*' -DestinationPath './output/HomeScreen_Build_${{ steps.semver.outputs.next }}.zip' -CompressionLevel Optimal -Force
- name: Upload Release Asset - name: Upload Release Asset
if: ${{ github.event.inputs.create_release != 'false' }} if: ${{ github.event.inputs.create_release != 'false' }}
id: upload-release-asset
uses: actions/upload-release-asset@v1 uses: actions/upload-release-asset@v1
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with: with:
upload_url: ${{ steps.create_release.outputs.upload_url }} upload_url: ${{ steps.create_release.outputs.upload_url }}
asset_path: ./output/HomeScreen_Build_${{ steps.semver.outputs.next }}.zip asset_path: ./output/HomeScreen_Build_${{ steps.semver.outputs.next }}.zip
asset_name: HomeScreen_Build_${{steps.semver.outputs.patch}}.zip asset_name: HomeScreen_Build_${{ steps.semver.outputs.next }}.zip
asset_content_type: application/zip asset_content_type: application/zip
- name: Generate appsettings.json - name: Generate appsettings.json
@@ -150,24 +208,6 @@ jobs:
$appSettings | ConvertTo-Json -Depth 10 | Set-Content -Path "./output/dotnet/appsettings.json" $appSettings | ConvertTo-Json -Depth 10 | Set-Content -Path "./output/dotnet/appsettings.json"
Write-Host "Generated appsettings.json successfully" Write-Host "Generated appsettings.json successfully"
# Check wwwroot and manually copy if missing
- name: Ensure wwwroot is Included
run: |
if (-not (Test-Path -Path "./output/dotnet/wwwroot")) {
Write-Host "wwwroot folder not found in published output, manually copying..."
# Check if wwwroot exists in project directory
$sourceWwwroot = "./HomeApi/wwwroot"
if (Test-Path -Path $sourceWwwroot) {
Write-Host "Found wwwroot directory in source, copying..."
New-Item -ItemType Directory -Path "./output/dotnet/wwwroot" -Force
Copy-Item -Path "$sourceWwwroot/*" -Destination "./output/dotnet/wwwroot" -Recurse -Force
} else {
Write-Host "WARNING: Could not find wwwroot in source directory!"
}
}
- name: Upload Artifacts - name: Upload Artifacts
uses: actions/upload-artifact@v4 uses: actions/upload-artifact@v4
with: with:
@@ -175,7 +215,7 @@ jobs:
path: ./output/dotnet path: ./output/dotnet
deploy: deploy:
runs-on: self-hosted # Ensure your self-hosted runner is configured runs-on: self-hosted
needs: build needs: build
environment: ${{ github.event.inputs.environment || 'prod' }} environment: ${{ github.event.inputs.environment || 'prod' }}

View File

@@ -1,11 +0,0 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net9.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<DockerDefaultTargetOS>Linux</DockerDefaultTargetOS>
</PropertyGroup>
</Project>

View File

@@ -1,4 +1,5 @@
namespace HomeApi.Models.Response; namespace HomeApi.Models.Response;
public class TrafikLabsApiResponse public class TrafikLabsApiResponse
{ {
public List<Departure> Departure { get; set; } public List<Departure> Departure { get; set; }

View File

@@ -1,3 +0,0 @@
// See https://aka.ms/new-console-template for more information
Console.WriteLine("Hello, World!");

View File

@@ -1,8 +1,29 @@
# This [![Build and Deploy](https://github.com/Myxelium/HomeScreen/actions/workflows/build.yml/badge.svg)](https://github.com/Myxelium/HomeScreen/actions/workflows/build.yml) [![myxelium - Wireless_Eink_HomeScreen](https://img.shields.io/static/v1?label=myxelium&message=Wireless_Eink_HomeScreen&color=purple&logo=github)](https://github.com/myxelium/Wireless_Eink_HomeScreen "Go to GitHub repo")
Core api and Esp32 code for displaying weather data and public transport information on a e-ink display. [![stars - Wireless_Eink_HomeScreen](https://img.shields.io/github/stars/myxelium/Wireless_Eink_HomeScreen?style=social)](https://github.com/myxelium/Wireless_Eink_HomeScreen)
[![forks - Wireless_Eink_HomeScreen](https://img.shields.io/github/forks/myxelium/Wireless_Eink_HomeScreen?style=social)](https://github.com/myxelium/Wireless_Eink_HomeScreen)
[![GitHub tag](https://img.shields.io/github/tag/myxelium/Wireless_Eink_HomeScreen?include_prereleases=&sort=semver&color=purple)](https://github.com/myxelium/Wireless_Eink_HomeScreen/releases/)
[![License](https://img.shields.io/badge/License-GPL-purple)](https://www.gnu.org/licenses/gpl-3.0.en.html)
[![issues - Wireless_Eink_HomeScreen](https://img.shields.io/github/issues/myxelium/Wireless_Eink_HomeScreen)](https://github.com/myxelium/Wireless_Eink_HomeScreen/issues)
[![Build and Deploy](https://github.com/Myxelium/Wireless_Eink_HomeScreen/actions/workflows/build.yml/badge.svg)](https://github.com/Myxelium/Wireless_Eink_HomeScreen/actions/workflows/build.yml)
# What why how
This is a project I created that pulls weather data from the internet, transforms it into custom images, and displays them on an e-ink screen powered by an ESP32.
## What This Project Does
I wanted a low-power way to see weather information at a glance, so I built this system that:
- Fetches real-time weather data from online APIs
- Processes and converts the data into visual images (temperature graphs, forecast icons, etc.)
- Sends these images wirelessly to an ESP32 microcontroller
- Displays the information on an energy-efficient e-ink screen
- Updates periodically while consuming minimal power
<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" />
# How do I get to use this without programming knowledge?
Check in the wiki for the guide how to get everything working!
### 😺 [Wiki Get Started Guide](https://github.com/Myxelium/Wireless_Eink_HomeScreen/wiki/)
## Git Notes ## Git Notes
All commits has to follow this [Conventional Commits style](https://www.conventionalcommits.org/) to pass the pipeline. All commits has to follow this [Conventional Commits style](https://www.conventionalcommits.org/) to pass the pipeline.
## Features 😺 ## Features 😺
@@ -11,8 +32,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 +113,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 +130,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 download them here [Download](https://files.waveshare.com/upload/5/50/E-Paper_ESP32_Driver_Board_Code.7z) or check above link.