Compare commits
15 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 8284ae9695 | |||
| c575f52ebb | |||
| 4d2ee85cbe | |||
| d6364fc975 | |||
| 7ff39ea252 | |||
| b61de80e8a | |||
| c53f6a3f77 | |||
| 7fe92790d7 | |||
| 3b9d5bc984 | |||
| a73f171102 | |||
| 157dc0e6cf | |||
| df6428550f | |||
| f1d4a7c1bc | |||
| 485453bc7d | |||
| 661fe4dfd6 |
92
.github/workflows/build.yml
vendored
92
.github/workflows/build.yml
vendored
@@ -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
|
||||||
@@ -74,6 +74,24 @@ jobs:
|
|||||||
} else {
|
} else {
|
||||||
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' }}
|
||||||
@@ -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 }}
|
||||||
@@ -94,21 +113,60 @@ jobs:
|
|||||||
release_name: Release ${{ steps.semver.outputs.next }}
|
release_name: Release ${{ steps.semver.outputs.next }}
|
||||||
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' }}
|
||||||
|
|
||||||
|
|||||||
@@ -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>
|
|
||||||
@@ -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; }
|
||||||
|
|||||||
@@ -1,3 +0,0 @@
|
|||||||
// See https://aka.ms/new-console-template for more information
|
|
||||||
|
|
||||||
Console.WriteLine("Hello, World!");
|
|
||||||
44
README.md
44
README.md
@@ -1,8 +1,29 @@
|
|||||||
# This [](https://github.com/Myxelium/HomeScreen/actions/workflows/build.yml)
|
[](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.
|
[](https://github.com/myxelium/Wireless_Eink_HomeScreen)
|
||||||
|
[](https://github.com/myxelium/Wireless_Eink_HomeScreen)
|
||||||
|
[](https://github.com/myxelium/Wireless_Eink_HomeScreen/releases/)
|
||||||
|
[](https://www.gnu.org/licenses/gpl-3.0.en.html)
|
||||||
|
[](https://github.com/myxelium/Wireless_Eink_HomeScreen/issues)
|
||||||
|
[](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.
|
||||||
|
|||||||
Reference in New Issue
Block a user