From 0c9d4d920ace4d7e632088a1c58e8ab584055bb9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20H=C3=A4fliger?= Date: Thu, 10 Sep 2026 08:03:38 +0000 Subject: [PATCH] Dokumentation aktualisieren: README.md --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9b8b9b8..2a04d85 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,10 @@ Energiemanagement, Manager und steuerbare Verbraucher fuer IP-Symcon. ## Status -Das Repository befindet sich im Aufbau. Aktuell ist ausschliesslich der gemeinsame Nachrichtenvertrag implementiert. Noch nicht implementierte Module werden nicht als leere Platzhalter angelegt. +Das Repository befindet sich im Aufbau. Der gemeinsame Nachrichtenvertrag und +die Deklaration der Verbraucherbasis sind implementiert. Die Module sind als +Diskussionsentwürfe dokumentiert, aber noch nicht als installierbare +IP-Symcon-Module angelegt. ## Geplante Module @@ -18,6 +21,10 @@ Das Repository befindet sich im Aufbau. Aktuell ist ausschliesslich der gemeinsa - Ladestation Gateway - Easee Gateway +Die Properties, Variablen, Zustandsdaten und offenen Punkte stehen in der +[Modulübersicht](docs/module/README.md). Gemeinsame Felder werden dort nicht +abweichend neu definiert, sondern verweisen auf den zentralen Vertrag. + Die Verbraucher kommunizieren mit dem Manager ueber den gemeinsamen Vertrag in `libs/`. Der Manager waehlt die Verbraucher aus; in einem Verbraucher gibt es keine Manager-ID-Property. ## Voraussetzungen @@ -40,5 +47,8 @@ Neue oder geaenderte Funktionen werden zusammen mit ihren PHPUnit-Tests eingeche | `beta` | Beta | | `develop` | Testing | -Die ausfuehrliche Schnittstellenbeschreibung steht unter [docs/Schnittstelle.md](docs/Schnittstelle.md). +## Dokumentation +- [Manager-Verbraucher-Schnittstelle](docs/Schnittstelle.md) +- [Obere Anschlüsse des Managers](docs/Obere-Anschluesse.md) +- [Modulübersicht](docs/module/README.md)