Skip to content

Commit 1a21131

Browse files
authored
Update Readme (#93)
1 parent 5b28e56 commit 1a21131

1 file changed

Lines changed: 291 additions & 50 deletions

File tree

README.md

Lines changed: 291 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -12,97 +12,338 @@
1212
[![Bandit](https://github.com/derolli1976/enpal/actions/workflows/bandit.yaml/badge.svg)](https://github.com/derolli1976/enpal/actions/workflows/bandit.yaml)
1313
![Enpal_version](https://img.shields.io/badge/tested%20with%20enpal%20firmware-Solar%20Rel.%208.47.4--461279%20(19.09.2025)-blue)
1414

15-
1615
[![hacs_install](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=derolli1976&repository=enpal&category=integration)
1716

1817
<a href="https://buymeacoffee.com/derolli1976" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>
1918

20-
Diese Home Assistant Integration liest Daten von der lokalen Enpal-Webseite der Solaranlage (z. B. `http://192.168.178.178/deviceMessages`) aus und stellt die Werte als Sensoren in Home Assistant zur Verfügung.
19+
Eine Home Assistant Custom Integration zur lokalen Überwachung von Enpal Solaranlagen. Liest Daten direkt aus der lokalen Weboberfläche der Enpal Box und stellt über 100 Sensoren für Solaranlage, Batterie, Wallbox und Wärmepumpe bereit.
20+
21+
---
22+
23+
## ✨ Features
24+
25+
- **Lokale Kommunikation**: Keine Cloud-Anbindung erforderlich, alle Daten werden lokal im Netzwerk abgerufen
26+
- **Umfangreiche Sensoren**: Über 100 Datenpunkte für PV-Anlage, Batterie, Inverter, Wallbox und Wärmepumpe
27+
- **Flexible Sensor-Gruppen**: Wählbare Kategorien (Battery, Inverter, Wallbox, Heatpump, etc.)
28+
- **Auto-Discovery**: Automatische Erkennung der Enpal Box im lokalen Netzwerk
29+
- **Energy Dashboard**: Volle Unterstützung für Home Assistant Energy Dashboard
30+
- **Wallbox-Steuerung**: Optional über separates Add-on (Lademodus, Start/Stop)
31+
- **UI-Konfiguration**: Vollständige Einrichtung über die Home Assistant Oberfläche
32+
- **Mehrsprachig**: Deutsche und englische Übersetzungen
33+
34+
---
35+
36+
## 📊 Unterstützte Geräte & Sensoren
37+
38+
### Solaranlage & Inverter
39+
- **Leistung**: DC-Strings, AC-Phasen, Gesamtleistung
40+
- **Energie**: Tagesertrag, Gesamtertrag, Netzeinspeisung/-bezug
41+
- **Elektrik**: Spannung, Strom, Frequenz pro Phase
42+
- **Status**: Betriebszustand, Systemstatus, Alarme
43+
44+
### Batterie
45+
- **Ladestand**: Prozent und absolute Werte (kWh)
46+
- **Leistung**: Lade-/Entladeleistung, Max-Werte
47+
- **Elektrik**: Spannung, Strom pro Batterie-Unit
48+
- **Status**: Betriebsmodus, Zwangsladung/-entladung
49+
50+
### Wallbox
51+
- **Laden**: Ladestand, Leistung, Gesamtenergie
52+
- **Elektrik**: Spannung, Strom pro Phase, Phasenanzahl
53+
- **Steuerung**: Lademodus (Eco/Solar/Full), Start/Stop über Add-on
54+
- **Status**: Ladestatus, angebotene Leistung
2155

22-
### ⚠️ Hinweis: Mit dem letzten Update seitens Enpal sind manchmal einige Sensoren nicht mehr verfügbar!
23-
Diese sollten nach und nach wieder erscheinen. Ein Neustart der Anlage und von Homeassistant hilft in vielen Fällen, in anderen Fällen erledigt sich das Problem nach ein paar Tagen von alleine.
24-
Ich kann auf meiner Seite leider nichts dagegen tun, da ich darauf angewiesen bin, dass die Daten durch Enpal auch zur Verfügung gestellt werden.
56+
### Wärmepumpe (NEU in v2.3.0)
57+
- **Temperaturen**: Warmwasser, Außentemperatur
58+
- **Energie**: Verbrauch (kWh), aktuelle Leistung (kW)
59+
- **Status**: Betriebsmodus
2560

26-
### ⚠️ Hinweis: Nur einige Enpal Boxen der **1. Generation** werden **unterstützt**.
27-
Entscheidend ist, ob unter der IP-Adresse der Enpal Box im lokalen Netzwerk eine Webseite wie die folgende angezeigt wird:
61+
### System & IoT Edge Device
62+
- **System**: CPU-Last, Speichernutzung
63+
- **Netzwerk**: LTE-Qualität, Datenverbrauch, Verbindungstyp
64+
- **Diagnose**: Firmware-Version, Systemzustand
65+
66+
---
67+
68+
## 📋 Voraussetzungen
69+
70+
### ⚠️ Wichtig: Nur Enpal Boxen der 1. Generation werden unterstützt
71+
72+
Die Integration funktioniert **nur**, wenn die Enpal Box eine lokale Weboberfläche bereitstellt. Ob dies der Fall ist, lässt sich einfach testen:
73+
74+
1. IP-Adresse der Enpal Box im Router ermitteln (z.B. `192.168.178.178`)
75+
2. Im Browser die URL `http://<ENPAL-IP>/deviceMessages` aufrufen
76+
3. Wenn eine Webseite wie folgt angezeigt wird, ist die Integration kompatibel:
2877

2978
<p align="left">
3079
<img src="./images/enpal_box_webseite.png" alt="Enpal Box Webseite" width="600"/>
3180
</p>
3281

82+
**Hinweis**: Neuere Enpal Boxen (2. Generation) stellen diese Weboberfläche nicht mehr bereit und werden aktuell **nicht unterstützt**.
83+
84+
### Technische Anforderungen
85+
- Home Assistant Core 2024.1.0 oder höher
86+
- Enpal Box im selben Netzwerk wie Home Assistant
87+
- DHCP-aktivierter Router (Enpal Box bezieht IP per DHCP)
88+
3389
---
3490

35-
## 🔧 Funktionen
91+
## 📦 Installation
92+
93+
### 🎯 Empfohlene Methode: HACS
3694

37-
- Liest Messwerte aus HTML-Tabellen auf der lokalen Enpal-Geräteseite
38-
- Automatische Gruppierung nach Datenbereich (z. B. Wallbox, Battery, Inverter)
39-
- Sprechende, gruppierte Sensor-Namen
40-
- Automatische Aktualisierung über einstellbares Intervall
41-
- Sensoren erscheinen automatisch in Home Assistant
42-
- Nicht ausgewählte Gruppen werden als deaktivierte Entitäten angelegt
43-
- Konfiguration vollständig über das Home Assistant UI möglich
44-
- **NEU**: Wallbox-Steuerung über optionales Add-on
95+
Die Integration ist offiziell in HACS gelistet.
96+
97+
#### Schritt 1: Integration über HACS herunterladen
98+
99+
1. **HACS öffnen** über die Seitenleiste in Home Assistant
100+
2. Im **Suchfeld** nach `Enpal Solar` suchen
101+
3. Integration auswählen und auf **Herunterladen** klicken
102+
4. **Home Assistant neu starten**
103+
104+
[![Direkt in HACS öffnen](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=derolli1976&repository=enpal&category=integration)
105+
106+
#### Schritt 2: Integration einrichten
107+
108+
**Wichtig**: Die Integration muss erst über HACS heruntergeladen werden (Schritt 1), bevor sie unter "Geräte & Dienste" hinzugefügt werden kann.
109+
110+
1. **Einstellungen****Geräte & Dienste** öffnen
111+
2. Unten rechts auf **+ Integration hinzufügen** klicken
112+
3. Nach `Enpal Solar` suchen und auswählen
113+
4. Setup-Assistent folgen (siehe [Konfiguration](#-konfiguration))
114+
115+
[![Integration hinzufügen](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=enpal_webparser)
116+
117+
### 🛠️ Manuelle Installation
118+
119+
<details>
120+
<summary>Klicken für manuelle Installationsanleitung</summary>
121+
122+
1. [Neueste Release](https://github.com/derolli1976/enpal/releases/latest) herunterladen
123+
2. Den Ordner `custom_components/enpal_webparser/` in das Home Assistant `custom_components` Verzeichnis kopieren
124+
- Pfad: `/config/custom_components/enpal_webparser/`
125+
- Bei Hass.io: SAMBA verwenden
126+
- Bei Supervised: Eventuell unter `/usr/share/hassio/homeassistant/`
127+
3. Home Assistant neu starten
128+
4. Zur Integration hinzufügen (siehe [Konfiguration](#-konfiguration))
129+
130+
</details>
45131

46132
---
47133

48134
## ⚙️ Konfiguration
49135

50-
Die Integration kann vollständig über das Home Assistant UI konfiguriert werden:
136+
### Ersteinrichtung
137+
138+
1. **Einstellungen****Geräte & Dienste** öffnen
139+
2. Unten rechts auf **+ Integration hinzufügen** klicken
140+
3. Nach `Enpal Solar` suchen und auswählen
141+
142+
[![Integration hinzufügen](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=enpal_webparser)
143+
144+
### Setup-Assistent
145+
146+
Der Setup-Assistent führt durch folgende Schritte:
147+
148+
#### Schritt 1: Methode wählen
149+
- **Auto-Discovery**: Automatische Suche der Enpal Box im Netzwerk (empfohlen)
150+
- **Manuelle Eingabe**: URL manuell eingeben, falls Auto-Discovery fehlschlägt
151+
152+
#### Schritt 2: URL & Verbindung
153+
- Bei Auto-Discovery: Gefundene Enpal Box auswählen
154+
- Bei manueller Eingabe: URL eingeben (z.B. `http://192.168.178.178/deviceMessages`)
155+
- Die Verbindung wird automatisch getestet
156+
157+
#### Schritt 3: Sensoren konfigurieren
158+
- **Aktualisierungsintervall**: Empfohlen 60 Sekunden (Minimum 10 Sekunden)
159+
- **Sensor-Gruppen**: Auswahl der gewünschten Kategorien
160+
- `Battery` - Batterie-Sensoren
161+
- `Inverter` - Wechselrichter-Sensoren
162+
- `Wallbox` - Wallbox-Sensoren (falls vorhanden)
163+
- `Heatpump` - Wärmepumpen-Sensoren (falls vorhanden)
164+
- `Site Data` - Standort-/Verbrauchsdaten
165+
- `IoTEdgeDevice` - System-Sensoren
166+
- `PowerSensor` - Stromsensor-Daten
167+
- **Wallbox Add-on**: Bei Bedarf aktivieren für Steuerungsfunktionen
168+
169+
### Sensor-Gruppen nachträglich anpassen
170+
171+
Sensor-Gruppen können jederzeit geändert werden:
172+
173+
1. **Einstellungen****Geräte & Dienste** öffnen
174+
2. Bei der Enpal Integration auf das **Zahnrad** (Konfigurieren) klicken
175+
3. **Weiter** klicken bis zur Sensor-Gruppen-Auswahl
176+
4. Gewünschte Gruppen an-/abwählen
177+
5. Mit **Senden** bestätigen
51178

52-
- **URL der Datenquelle**: z. B. `http://192.168.178.178/deviceMessages`
53-
- **Aktualisierungsintervall**: in Sekunden
54-
- **Sensorgruppen**: Auswahl von Bereichen wie `Wallbox`, `Battery`, `Inverter`, etc.
55-
- **Wallbox-Steuerung aktivieren**: Optional, wenn Add-on installiert
179+
**Hinweis**: Nicht ausgewählte Sensor-Gruppen werden als deaktivierte Entitäten angelegt und können bei Bedarf später manuell aktiviert werden.
56180

57181
---
58182

59-
## 📦 Installation
183+
## 🚗 Wallbox-Steuerung (Optional)
184+
185+
Für die Steuerung der Enpal Wallbox wird ein separates Add-on benötigt, das die Kommunikation mit der Wallbox-Hardware übernimmt.
186+
187+
### Features des Wallbox Add-ons
188+
- **Lademodus umschalten**: Eco, Solar, Full
189+
- **Laden starten/stoppen**
190+
- **Status-Sensoren**: Aktueller Modus, Ladestatus, Leistung
191+
192+
### Installation des Add-ons
193+
194+
1. **Add-on Store** in Home Assistant öffnen
195+
2. **Drei-Punkte-Menü** (oben rechts) → **Repositories**
196+
3. Repository-URL hinzufügen:
197+
```
198+
https://github.com/derolli1976/enpal-wallbox-addon
199+
```
200+
4. **Enpal Wallbox Control** Add-on installieren
201+
5. Add-on starten
202+
6. In der Enpal Integration **Wallbox Add-on** aktivieren (siehe [Konfiguration](#-konfiguration))
203+
204+
📚 [Vollständige Wallbox Add-on Dokumentation](https://github.com/derolli1976/enpal-wallbox-addon)
205+
206+
---
207+
208+
## 🔧 Fehlerbehebung
209+
210+
### Häufige Probleme
211+
212+
<details>
213+
<summary><b>Auto-Discovery findet keine Enpal Box</b></summary>
214+
215+
**Ursachen**:
216+
- Enpal Box in anderem Subnetz
217+
- Firewall blockiert Multicast-Traffic
218+
- Docker/VM mit NAT statt Bridge-Modus
219+
220+
**Lösungen**:
221+
1. Manuelle Eingabe der URL verwenden
222+
2. IP-Adresse der Enpal Box im Router ermitteln
223+
3. Bei Docker: `--network host` verwenden
224+
4. Bei VM: Bridge-Netzwerk statt NAT konfigurieren
225+
226+
</details>
227+
228+
<details>
229+
<summary><b>Sensoren zeigen keine Werte an</b></summary>
230+
231+
**Lösungen**:
232+
1. Prüfen ob Sensor-Gruppe aktiviert ist
233+
2. Enpal Box und Home Assistant neu starten
234+
3. Logs prüfen: **Einstellungen****System****Protokolle** (nach `[Enpal]` filtern)
235+
4. URL im Browser öffnen und prüfen ob Daten vorhanden sind
236+
237+
</details>
238+
239+
<details>
240+
<summary><b>Sensoren nach Enpal-Update verschwunden</b></summary>
241+
242+
Enpal aktualisiert gelegentlich die Firmware, was zu temporär fehlenden Sensoren führen kann.
243+
244+
**Lösungen**:
245+
1. Enpal Box neu starten (Hauptschalter aus/an)
246+
2. Home Assistant neu starten
247+
3. 1-2 Tage warten (Sensoren tauchen oft von selbst wieder auf)
248+
4. Im Forum nach ähnlichen Problemen suchen
249+
250+
**Hinweis**: Die Integration kann nur Daten anzeigen, die die Enpal Box bereitstellt. Bei Firmware-Updates können sich verfügbare Datenpunkte ändern.
60251

61-
### 🧩 Variante 1: Installation über HACS (empfohlen)
252+
</details>
62253

63-
Diese Integration ist **offiziell in HACS gelistet** – ein manuelles Hinzufügen ist **nicht mehr nötig**.
254+
<details>
255+
<summary><b>Wallbox-Steuerung funktioniert nicht</b></summary>
64256

65-
#### Schritt-für-Schritt:
257+
**Prüfungen**:
258+
1. Wallbox Add-on installiert und gestartet?
259+
2. Wallbox Add-on in Integration aktiviert?
260+
3. Add-on Logs prüfen: **Einstellungen****Add-ons****Enpal Wallbox Control****Protokoll**
261+
4. Sensor `sensor.wallbox_status` vorhanden und aktualisiert?
66262

67-
1. Öffne **HACS** über die Seitenleiste in Home Assistant
68-
2. Gib im Suchfeld oben einfach **Enpal Solar** ein
69-
3. Wähle die Integration aus der Liste aus
70-
4. Klicke auf **„Installieren“**
71-
5. Starte Home Assistant neu
72-
6. Gehe zu **Einstellungen → Geräte & Dienste → Integration hinzufügen**
73-
7. Suche nach **Enpal Solar** und folge dem Konfigurationsdialog (z. B. URL, Intervall, Sensorgruppen)
263+
</details>
74264

265+
### Debug-Logs aktivieren
266+
267+
Bei Problemen Debug-Logs in `configuration.yaml` aktivieren:
268+
269+
```yaml
270+
logger:
271+
default: warning
272+
logs:
273+
custom_components.enpal_webparser: debug
274+
```
275+
276+
Danach Home Assistant neu starten und Logs unter **Einstellungen** → **System** → **Protokolle** prüfen (nach `[Enpal]` filtern).
75277

76278
---
77279

78-
### 🛠️ Variante 2: Manuelle Installation
280+
## 🌟 Energy Dashboard Integration
281+
282+
Die Integration ist vollständig mit dem Home Assistant Energy Dashboard kompatibel.
283+
284+
### Empfohlene Sensoren für Energy Dashboard
285+
286+
**Netzverbrauch**:
287+
- `sensor.inverter_grid_import_power_total_calculated` (Bezug vom Netz)
79288

80-
1. Lade das Repository herunter oder klone es
81-
2. Kopiere den Ordner `custom_components/enpal_webparser/` in dein Home Assistant `custom_components` Verzeichnis
82-
3. Starte Home Assistant neu
83-
4. Füge die Integration wie oben beschrieben hinzu
289+
**Rücklaufendes Netz**:
290+
- `sensor.inverter_power_grid_export_calculated` (Einspeisung ins Netz)
291+
292+
**Solaranlage**:
293+
- `sensor.inverter_energy_produced_total_dc` (Täglicher Ertrag)
294+
- `sensor.inverter_energy_production_total_lifetime` (Gesamtertrag)
295+
296+
**Batterie**:
297+
- `sensor.inverter_energy_battery_charge_lifetime` (Batterieladung)
298+
- `sensor.inverter_energy_battery_discharge_lifetime` (Batterieentladung)
299+
300+
**Wärmepumpe** (falls vorhanden):
301+
- `sensor.heatpump_energy_consumption_total_lifetime` (Gesamtverbrauch)
84302

85303
---
86304

87-
## 🚗 Wallbox Add-on (Optional)
305+
## 📝 Bekannte Einschränkungen
88306

89-
Zur Steuerung einer Enpal Wallbox wird dieses Add-on benötigt:
90-
🔗 [https://github.com/derolli1976/enpal-wallbox-addon](https://github.com/derolli1976/enpal-wallbox-addon)
307+
- **Nur 1. Generation Enpal Boxen** mit lokaler Weboberfläche werden unterstützt
308+
- **Firmware-Abhängigkeit**: Verfügbare Sensoren können sich durch Enpal-Firmware-Updates ändern
309+
- **Keine Cloud-Integration**: Die Integration kommuniziert nur lokal, keine Anbindung an Enpal-Cloud
310+
- **Wallbox-Steuerung**: Benötigt separates Add-on (nicht Teil der Integration)
311+
312+
---
91313

92-
### 🔌 Add-on Installation
314+
## 🙏 Mitwirken & Support
93315

94-
1. Öffne den **Add-on Store** in Home Assistant
95-
2. Gehe zum Drei-Punkte-Menü (oben rechts) → **Repositories**
96-
3. Füge folgendes Repository hinzu:
316+
### Feedback & Bugs
317+
- **Issues**: [GitHub Issues](https://github.com/derolli1976/enpal/issues)
318+
- **Diskussionen**: [GitHub Discussions](https://github.com/derolli1976/enpal/discussions)
319+
320+
### Beitragen
321+
Pull Requests sind willkommen! Bitte vorher ein Issue öffnen, um Änderungen zu besprechen.
322+
323+
### Kaffee spendieren
324+
Wenn die Integration hilfreich ist:
325+
326+
<a href="https://buymeacoffee.com/derolli1976" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>
327+
328+
---
329+
330+
## ⚖️ Rechtliches & Haftungsausschluss
331+
332+
> **Dies ist keine offizielle Integration von Enpal.**
333+
>
334+
> Dieses Projekt steht in **keinerlei Verbindung zur Enpal B.V.** und ist eine **inoffizielle, privat entwickelte Erweiterung**. Die Integration basiert ausschließlich auf lokal im Netzwerk bereitgestellten HTML-Daten.
335+
>
336+
> Die Nutzung erfolgt auf **eigene Verantwortung**. Die Funktionalität kann durch Änderungen an der Firmware oder Weboberfläche der Enpal-Anlage jederzeit eingeschränkt oder unterbrochen werden.
337+
>
338+
> Weder der Autor noch Mitwirkende übernehmen Haftung für Schäden, Datenverlust oder Fehlfunktionen.
97339

98340
---
99341

100-
## ⚠️ Rechtlicher Hinweis
342+
## 📄 Lizenz
101343

102-
> **Dies ist keine offizielle Integration von Enpal.**
103-
> Dieses Projekt steht in **keinerlei Verbindung zur Enpal B.V.**
104-
> Es handelt sich um eine **inoffizielle, privat entwickelte Erweiterung**, die auf lokal im Netzwerk bereitgestellten HTML-Daten basiert.
344+
MIT License - siehe [LICENSE](LICENSE) Datei für Details.
345+
346+
---
105347

106-
Die Nutzung erfolgt ausdrücklich auf **eigene Verantwortung**.
107-
Funktionalität kann durch Änderungen an der Firmware oder Weboberfläche der Enpal-Anlage jederzeit eingeschränkt oder unterbrochen werden.
348+
**Getestet mit**: Enpal Firmware Solar Rel. 8.47.4-461279 (19.09.2025)
108349

0 commit comments

Comments
 (0)