Update README.md
This commit is contained in:
@@ -4,6 +4,11 @@ Small FastAPI service that converts the Sachsen HWIMS RSS feed into clean, machi
|
|||||||
|
|
||||||
Perfect for use with Home Assistant or other automation tools.
|
Perfect for use with Home Assistant or other automation tools.
|
||||||
|
|
||||||
|
## 🌐 Live Service
|
||||||
|
|
||||||
|
- Running instance: [https://sachsen-pegel-proxy.vercel.app/](https://sachsen-pegel-proxy.vercel.app/)
|
||||||
|
- API docs: [https://sachsen-pegel-proxy.vercel.app/docs](https://sachsen-pegel-proxy.vercel.app/docs)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## ✨ Features
|
## ✨ Features
|
||||||
@@ -38,7 +43,7 @@ Response:
|
|||||||
"station_id": "560021",
|
"station_id": "560021",
|
||||||
"station_title": "Golzern 1 / Vereinigte Mulde",
|
"station_title": "Golzern 1 / Vereinigte Mulde",
|
||||||
"latest": {
|
"latest": {
|
||||||
"timestamp": "2026-05-05T00:45:00+00:00",
|
"timestamp": "2026-01-01T12:00:00+00:00",
|
||||||
"water_level_cm": 98,
|
"water_level_cm": 98,
|
||||||
"flow_m3s": 20.8,
|
"flow_m3s": 20.8,
|
||||||
"flood_alert_level": "Kein Hochwasser"
|
"flood_alert_level": "Kein Hochwasser"
|
||||||
@@ -109,6 +114,9 @@ http://127.0.0.1:8000/docs
|
|||||||
|
|
||||||
## ☁️ Deploy (Vercel)
|
## ☁️ Deploy (Vercel)
|
||||||
|
|
||||||
|
This repository does not include platform-specific deployment configuration.
|
||||||
|
Deploy by connecting the repo in Vercel (or using the CLI), then verify the API endpoints after deployment.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npx vercel
|
npx vercel
|
||||||
npx vercel --prod
|
npx vercel --prod
|
||||||
@@ -122,6 +130,7 @@ npx vercel --prod
|
|||||||
rest:
|
rest:
|
||||||
- resource: "https://your-app.vercel.app/api/pegel/560021"
|
- resource: "https://your-app.vercel.app/api/pegel/560021"
|
||||||
scan_interval: 300
|
scan_interval: 300
|
||||||
|
json_attributes_path: "$.latest"
|
||||||
sensor:
|
sensor:
|
||||||
- name: "Pegel Wasserstand"
|
- name: "Pegel Wasserstand"
|
||||||
value_template: "{{ value_json.latest.water_level_cm }}"
|
value_template: "{{ value_json.latest.water_level_cm }}"
|
||||||
|
|||||||
Reference in New Issue
Block a user