schmidt.florian
39da00d486
- Move CI/release workflows from .github/workflows to .gitea/workflows (Gitea Actions), targeting the master branch. - docker-publish: push to the Gitea container registry (git.finalfactory.de) with a lowercased image name; login via github.token or a PACKAGES_TOKEN secret. - version-tag: gitea-actions bot identity; optional RELEASE_TOKEN to re-trigger the image build. - Update README/CLAUDE.md/Unraid template/build-and-push.ps1 to the Gitea registry + master. Claude-Session: https://claude.ai/code/session_01WujdMtMJPbxDpDnMeK22rr
85 lines
4.0 KiB
Markdown
85 lines
4.0 KiB
Markdown
# MeterVault
|
|
|
|
A self-hosted, local-first **energy & utility metering platform**. MeterVault pulls meter data
|
|
from Home Assistant, Tasmota and raw MQTT on a schedule, stores every reading timestamped and
|
|
immutable, normalizes it into consumption, and turns it into cost dashboards. Energy types
|
|
(electricity, water, heating oil, gas, district heat, …) and meters are **user-defined — nothing
|
|
is hardcoded**.
|
|
|
|
Successor to a hand-maintained *Energiebilanz* spreadsheet. See [`docs/SDD.md`](docs/SDD.md) for the
|
|
full design.
|
|
|
|
## Features
|
|
|
|
- **Automatic ingestion** from MQTT/Tasmota (persistent subscriptions) and Home Assistant (REST
|
|
poll or push), plus manual entry, a REST push API, and CSV import.
|
|
- **Immutable raw readings** on a TimescaleDB hypertable; a normalized, append-only **consumption**
|
|
layer on top — reproducible, auditable.
|
|
- **Seven measurement modes** (cumulative/generation registers, burner runtime, tank/consumable,
|
|
direct delta, instant rate, virtual). Handles meter swaps, counter resets, tank dip-sticks with
|
|
calibration, and **virtual meters** defined by an expression (PV self-consumption, savings, net).
|
|
- **Tariff engine** with time-ranged price history (unit/base/feed-in), scoped global / per type /
|
|
per meter; **cost categories** decoupled from energy types; meterless manual costs.
|
|
- **Continuous aggregates** (daily/monthly/yearly, local timezone) so dashboards never scan raw.
|
|
- **Dashboard**: cost KPIs with period-over-period deltas, "what costs most", a "what cost more/
|
|
less" difference view, trends, meter list, one-click reference-data load, CSV dry-run.
|
|
- **REST API + OpenAPI/Swagger**, API-key auth, reverse-proxy trust (Authelia/Traefik).
|
|
- **JSON config export/import** for portability; Docker Compose + multi-arch image.
|
|
|
|
## Quick start (Docker)
|
|
|
|
```bash
|
|
docker compose -f deploy/docker-compose.yml up -d
|
|
# open http://localhost:8080 → Import → "Load reference data" for a populated demo
|
|
# API docs at http://localhost:8080/swagger
|
|
```
|
|
|
|
Configuration is via environment variables (`Section__Key` double-underscore mapping), e.g.:
|
|
|
|
| Variable | Purpose |
|
|
|----------|---------|
|
|
| `ConnectionStrings__Default` | PostgreSQL/Timescale connection string |
|
|
| `MeterVault__TimeZone` | Local timezone for buckets/display (default `Europe/Berlin`) |
|
|
| `MeterVault__ApiKeys__0` | An API key accepted on the `X-Api-Key` header |
|
|
| `MeterVault__AllowAnonymousApi` | `true` to open the REST API without a key (trusted LAN only) |
|
|
| `MeterVault__ReverseProxyTrust` | `true` to honour `X-Forwarded-User` behind an auth proxy |
|
|
| `MeterVault__EnableLiveIngestion` | `false` to disable the MQTT/HA workers |
|
|
|
|
The REST API is **closed by default**: with no `ApiKeys` configured and `AllowAnonymousApi` off, it
|
|
returns 401. Set at least one API key (or open it explicitly for a trusted network).
|
|
|
|
Secrets (broker/HA tokens) are **never** stored in the database — endpoint configs hold the *name*
|
|
of an environment variable, resolved at runtime.
|
|
|
|
## Pushing readings (Home Assistant)
|
|
|
|
```bash
|
|
curl -X POST http://localhost:8080/api/v1/readings \
|
|
-H "X-Api-Key: $METERVAULT_API_KEY" -H "Content-Type: application/json" \
|
|
-d '[{"meterId": 1, "time": "2026-01-01T12:00:00Z", "value": 47200}]'
|
|
```
|
|
|
|
See [`docs/wiring.md`](docs/wiring.md) for wiring up Tasmota, MQTT and Home Assistant.
|
|
|
|
## Development
|
|
|
|
```bash
|
|
dotnet build
|
|
dotnet test # integration tests spin a TimescaleDB via Testcontainers (needs Docker)
|
|
dotnet test tests/Core.Tests # fast unit tests, no Docker
|
|
dotnet run --project src/App
|
|
```
|
|
|
|
Architecture, project layout and conventions live in [`CLAUDE.md`](CLAUDE.md).
|
|
|
|
## Releasing
|
|
|
|
Edit the [`VERSION`](VERSION) file on `master`; Gitea Actions tags `vX.Y.Z` and builds/pushes a
|
|
multi-arch image to the Gitea container registry (`.gitea/workflows/`). Locally:
|
|
`pwsh deploy/build-and-push.ps1 -Registry git.finalfactory.de -Image finalfactory/metervault -Push`.
|
|
Requires a Docker-capable `act_runner`; the image build itself is self-contained.
|
|
|
|
## License
|
|
|
|
Not yet chosen (see SDD §14). Add a `LICENSE` before the first public tag.
|