73 lines
2.5 KiB
Markdown
73 lines
2.5 KiB
Markdown
# Enelix EMS
|
|
|
|
Energiemanagement, Manager und steuerbare Verbraucher fuer IP-Symcon.
|
|
|
|
## Status
|
|
|
|
Das Repository befindet sich im Aufbau. Der gemeinsame Nachrichtenvertrag, die
|
|
Verbraucherbasis, der Manager, der mehrstufige Warmwassererwaermer, der
|
|
1-stufige Verbraucher und die Ladestation Stand-Alone sind implementiert. Die
|
|
weiteren Module sind als Diskussionsentwürfe dokumentiert.
|
|
|
|
## Geplante Module
|
|
|
|
- Manager (implementiert)
|
|
- Batterie
|
|
- Wassererwaermer (implementiert)
|
|
- Pufferspeicher
|
|
- Verbraucher 1-Stufig (implementiert)
|
|
- Waermepumpe
|
|
- Ladestation Stand-Alone (implementiert)
|
|
- 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
|
|
|
|
- IP-Symcon ab Version 8.0
|
|
- PHP ab Version 8.0 fuer die Entwicklungstests
|
|
|
|
## Entwicklung und Tests
|
|
|
|
```bash
|
|
composer install
|
|
composer check
|
|
```
|
|
|
|
Der Gesamttest schliesst alle Modulsuiten ein. Der einstufige Verbraucher kann
|
|
zusaetzlich unabhaengig ausgefuehrt werden:
|
|
|
|
```bash
|
|
composer check:verbraucher-einstufig
|
|
```
|
|
|
|
Neue oder geaenderte Funktionen werden zusammen mit ihren PHPUnit-Tests eingecheckt.
|
|
Jedes Modul besitzt zusätzlich einen standardisierten Laufzeittest für IP-Symcon
|
|
8.x. Einzel-, Änderungs- und Gesamtläufe sowie Cleanup und Berichte sind im
|
|
[Testleitfaden](docs/testing/README.md) beschrieben. Die CI-Pruefung muss vor
|
|
der Uebernahme in einen Freigabebranch erfolgreich sein.
|
|
|
|
| Git-Branch | IP-Symcon-Kanal |
|
|
| --- | --- |
|
|
| `main` | Stable |
|
|
| `beta` | Beta |
|
|
| `develop` | Testing |
|
|
|
|
## Dokumentation
|
|
|
|
- [Zentrale Liste offener Teamentscheidungen](docs/Offene-Punkte.md)
|
|
- [Manager-Verbraucher-Schnittstelle](docs/Schnittstelle.md)
|
|
- [Manager-Modul inklusive Lizenzierung](docs/module/Manager/README.md)
|
|
- [Warmwassererwaermer-Modul](docs/module/Wassererwaermer/README.md)
|
|
- [Verbraucher-1-Stufig-Modul](docs/module/Verbraucher-1-Stufig/README.md)
|
|
- [Ladestation-Stand-Alone-Modul](docs/module/Ladestation-Stand-Alone/README.md)
|
|
- [Migration Boiler x-Stufig](docs/migration/Boiler-x-Stufig.md)
|
|
- [Migration Verbraucher 1-Stufig](docs/migration/Verbraucher-1-Stufig.md)
|
|
- [Obere Anschlüsse des Managers](docs/Obere-Anschluesse.md)
|
|
- [Modulübersicht](docs/module/README.md)
|