diff --git a/docs/devices/plugins.mdx b/docs/devices/plugins.mdx index 0e552d950..e84479152 100644 --- a/docs/devices/plugins.mdx +++ b/docs/devices/plugins.mdx @@ -182,25 +182,26 @@ Neben den Attributen, die Plugins zur lesenden Auswertung bereitstellen, werden ### Charger {#charger} -Wallboxen und Ladegeräte haben folgende Attribute die ausgelesen werden können: - -| Attribut | Typ | Erfordert | Beschreibung | -| ----------- | ------------------- | --------- | ---------------------------------------------------------------------------------------- | -| status | string | ja | Status (A..F) | -| enabled | bool | ja | Ist Ladung freigegeben? | -| power | float | nein | Ladeleistung in W | -| energy | float | nein | Zählerstand in kWh | -| identify | string | nein | Aktuelle RFID-Kennung | -| soc | int | nein | Ladestand in % | -| finishtime | string | nein | Geschätztes Ladeende (RFC3339, Go-Duration, Unix-Zeitstempel oder verbleibende Sekunden) | -| phases | int | nein | Anzahl der physischen Phasen (1..3) | -| powers | [float,float,float] | nein | Phasenleistungen in W. Zur Vorzeichenerkennung bei vorzeichenlosen Strömen. | -| currents | [float,float,float] | nein | Phasenströme in A. Zur Erkennung aktiver Phasen. | -| voltages | [float,float,float] | nein | Phasenspannungen in V. Zur Anschlusserkennung (1p/3p). | -| temp | float | nein | Aktuelle Temperatur in °C (Heizung) | -| templimit | int | nein | Temperaturlimit in °C (Heizung) | -| getmode | int | nein | SG-Ready Modus (Wärmepumpe) | -| getmaxpower | float | nein | Maximale Heizleistung in W (Heizung) | +Wallboxen vom Typ `custom` haben folgende Attribute die ausgelesen werden können: + +| Attribut | Typ | Erfordert | Beschreibung | +| ---------- | ------------------- | --------- | ---------------------------------------------------------------------------------------- | +| status | string | ja | Status (A..F) | +| enabled | bool | ja | Ist Ladung freigegeben? | +| power | float | nein | Ladeleistung in W | +| energy | float | nein | Zählerstand in kWh | +| identify | string | nein | Aktuelle RFID-Kennung | +| soc | int | nein | Ladestand in % | +| limitsoc | int | nein | Ladelimit in % | +| temp | float | nein | Aktuelle Temperatur in °C (Heizung, Alias für `soc`) | +| limittemp | int | nein | Temperaturlimit in °C (Heizung, Alias für `limitsoc`) | +| finishtime | string | nein | Geschätztes Ladeende (RFC3339, Go-Duration, Unix-Zeitstempel oder verbleibende Sekunden) | +| phases | int | nein | Anzahl der physischen Phasen (1..3) | +| powers | [float,float,float] | nein | Phasenleistungen in W. Zur Vorzeichenerkennung bei vorzeichenlosen Strömen. | +| currents | [float,float,float] | nein | Phasenströme in A. Zur Erkennung aktiver Phasen. | +| voltages | [float,float,float] | nein | Phasenspannungen in V. Zur Anschlusserkennung (1p/3p). | + +Für Wärmepumpen-spezifische Charger-Typen (`heatpump`, `sgready`, `sgready-relay`) gelten andere Plugin-Attribute, siehe [Wärmepumpen](#charger-heating). #### Allgemeine Konfigurationsoptionen {#charger-config} @@ -278,15 +279,13 @@ chargers: Neben den read-only Werten können über Plugins auch Aktionen getriggert oder Konfigurationswerte gesetzt werden: -| Attribut | Typ | Erfordert | Beschreibung | -| --------------- | ----- | --------- | ------------------------------------------------------- | -| enable | bool | ja | Ladung freigeben / sperren | -| maxcurrent | int | ja | Setze maximalen Ladestrom in A | -| maxcurrentmilis | float | nein | Setze maximalen Ladestrom in A | -| phases1p3p | int | nein | Phasenumschaltung durchführen (erfordert `tos: true`) | -| wakeup | bool | nein | Wecke Fahrzeug auf | -| setmode | int | nein | Ändere SG-Ready Modus (1: reduced, 2: normal, 3: boost) | -| setmaxpower | int | nein | Setze maximale Heizleistung in W (Heizung) | +| Attribut | Typ | Erfordert | Beschreibung | +| ---------------- | ----- | --------- | ----------------------------------------------------- | +| enable | bool | ja | Ladung freigeben / sperren | +| maxcurrent | int | ja | Setze maximalen Ladestrom in A | +| maxcurrentmillis | float | nein | Setze maximalen Ladestrom in A (mit Nachkommastellen) | +| phases1p3p | int | nein | Phasenumschaltung durchführen (erfordert `tos: true`) | +| wakeup | bool | nein | Wecke Fahrzeug auf | **Beispiel** @@ -303,6 +302,43 @@ chargers: payload: ON ``` +#### Wärmepumpen {#charger-heating} + +Für Wärmepumpen und vergleichbare Heizgeräte gibt es eigene Charger-Typen mit jeweils eigenen Plugin-Attributen. +Die vollständige Einrichtung ist unter [Wärmepumpen, Heizstäbe](./heating) beschrieben. + +Allen drei Typen gemeinsam sind die optionalen Mess-Attribute: + +| Attribut | Typ | Erfordert | Beschreibung | +| --------- | ----- | --------- | ------------------------------------- | +| power | float | nein | Aktuelle Leistung in W | +| energy | float | nein | Zählerstand in kWh | +| temp | float | nein | Aktuelle Temperatur in °C | +| limittemp | int | nein | Geräte-internes Temperaturlimit in °C | + +**`type: heatpump`**: Wärmepumpe mit Leistungsvorgabe. + +| Attribut | Typ | Erfordert | Beschreibung | +| ----------- | ----- | --------- | ----------------------------------- | +| setmaxpower | int | ja | Setze maximale Heizleistung in W | +| getmaxpower | float | nein | Aktuelle maximale Heizleistung in W | + +**`type: sgready`**: Wärmepumpe mit SG-Ready Schnittstelle. + +| Attribut | Typ | Erfordert | Beschreibung | +| ----------- | --- | --------- | ------------------------------------------------------- | +| setmode | int | ja | Ändere SG-Ready Modus (1: reduced, 2: normal, 3: boost) | +| getmode | int | nein | Aktueller SG-Ready Modus (1, 2, 3) | +| setmaxpower | int | nein | Setze maximale Heizleistung in W | + +**`type: sgready-relay`**: Wärmepumpe gesteuert über Relais-Kontakte. +Die Sub-Charger werden über typisierte Verweise statt Plugins eingebunden. + +| Attribut | Typ | Erfordert | Beschreibung | +| -------- | ------------- | --------- | ------------------------------------- | +| boost | charger-typed | ja | Relais für den SG-Ready Boost-Kontakt | +| dim | charger-typed | nein | Relais für den SG-Ready Dim-Kontakt | + ### Vehicle {#vehicle} Fahrzeugparameter können ebenfalls über Plugins ausgelesen werden. diff --git a/i18n/en/docusaurus-plugin-content-docs/current/devices/plugins.mdx b/i18n/en/docusaurus-plugin-content-docs/current/devices/plugins.mdx index cbf3e0b7f..f99752469 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/devices/plugins.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/devices/plugins.mdx @@ -182,25 +182,26 @@ In addition to the attributes that plugins provide for reading evaluation, the f ### Charger {#charger} -Wallboxes and chargers have the following attributes that can be read: - -| Attribute | Type | Required | Description | -| ----------- | ------------------- | -------- | ------------------------------------------------------------------------------------------- | -| status | string | yes | Status (A..F) | -| enabled | bool | yes | Is charging enabled? | -| power | float | no | Charging power in W | -| energy | float | no | Meter reading in kWh | -| identify | string | no | Current RFID identifier | -| soc | int | no | State of charge in % | -| finishtime | string | no | Estimated charging finish time (RFC3339, Go duration, Unix timestamp, or remaining seconds) | -| phases | int | no | Number of physical phases (1..3) | -| powers | [float,float,float] | no | Phase powers in W. For sign detection of unsigned currents. | -| currents | [float,float,float] | no | Phase currents in A. For detecting active phases. | -| voltages | [float,float,float] | no | Phase voltages in V. For connection detection (1p/3p). | -| temp | float | no | Current temperature in °C (heating) | -| templimit | int | no | Temperature limit in °C (heating) | -| getmode | int | no | SG-Ready mode (heat pump) | -| getmaxpower | float | no | Maximum heating power in W (heating) | +Chargers of `type: custom` have the following attributes that can be read: + +| Attribute | Type | Required | Description | +| ---------- | ------------------- | -------- | ------------------------------------------------------------------------------------------- | +| status | string | yes | Status (A..F) | +| enabled | bool | yes | Is charging enabled? | +| power | float | no | Charging power in W | +| energy | float | no | Meter reading in kWh | +| identify | string | no | Current RFID identifier | +| soc | int | no | State of charge in % | +| limitsoc | int | no | Charge limit in % | +| temp | float | no | Current temperature in °C (heating, alias for `soc`) | +| limittemp | int | no | Temperature limit in °C (heating, alias for `limitsoc`) | +| finishtime | string | no | Estimated charging finish time (RFC3339, Go duration, Unix timestamp, or remaining seconds) | +| phases | int | no | Number of physical phases (1..3) | +| powers | [float,float,float] | no | Phase powers in W. For sign detection of unsigned currents. | +| currents | [float,float,float] | no | Phase currents in A. For detecting active phases. | +| voltages | [float,float,float] | no | Phase voltages in V. For connection detection (1p/3p). | + +For heat-pump-specific charger types (`heatpump`, `sgready`, `sgready-relay`), different plugin attributes apply, see [Heat pumps](#charger-heating). #### General Configuration Options {#charger-config} @@ -278,15 +279,13 @@ chargers: In addition to read-only values, actions can also be triggered or configuration values set via plugins: -| Attribute | Type | Required | Description | -| --------------- | ----- | -------- | ------------------------------------------------------ | -| enable | bool | yes | Enable / disable charging | -| maxcurrent | int | yes | Set maximum charging current in A | -| maxcurrentmilis | float | no | Set maximum charging current in A | -| phases1p3p | int | no | Perform phase switching (requires `tos: true`) | -| wakeup | bool | no | Wake up vehicle | -| setmode | int | no | Change SG-Ready mode (1: reduced, 2: normal, 3: boost) | -| setmaxpower | int | no | Set maximum heating power in W (heating) | +| Attribute | Type | Required | Description | +| ---------------- | ----- | -------- | ------------------------------------------------- | +| enable | bool | yes | Enable / disable charging | +| maxcurrent | int | yes | Set maximum charging current in A | +| maxcurrentmillis | float | no | Set maximum charging current in A (with decimals) | +| phases1p3p | int | no | Perform phase switching (requires `tos: true`) | +| wakeup | bool | no | Wake up vehicle | **Example** @@ -303,6 +302,43 @@ chargers: payload: ON ``` +#### Heat Pumps {#charger-heating} + +Heat pumps and similar heating devices use dedicated charger types, each with its own plugin attributes. +The full setup is described under [Heat pumps, heating rods](./heating). + +All three types share the following optional measurement attributes: + +| Attribute | Type | Required | Description | +| --------- | ----- | -------- | --------------------------------------- | +| power | float | no | Current power in W | +| energy | float | no | Meter reading in kWh | +| temp | float | no | Current temperature in °C | +| limittemp | int | no | Device-internal temperature limit in °C | + +**`type: heatpump`**: heat pump with power setpoint. + +| Attribute | Type | Required | Description | +| ----------- | ----- | -------- | ---------------------------------- | +| setmaxpower | int | yes | Set maximum heating power in W | +| getmaxpower | float | no | Current maximum heating power in W | + +**`type: sgready`**: heat pump with SG-Ready interface. + +| Attribute | Type | Required | Description | +| ----------- | ---- | -------- | ------------------------------------------------------ | +| setmode | int | yes | Change SG-Ready mode (1: reduced, 2: normal, 3: boost) | +| getmode | int | no | Current SG-Ready mode (1, 2, 3) | +| setmaxpower | int | no | Set maximum heating power in W | + +**`type: sgready-relay`**: heat pump controlled via relay contacts. +Sub-chargers are referenced by type instead of via plugins. + +| Attribute | Type | Required | Description | +| --------- | ------------- | -------- | ------------------------------------ | +| boost | charger-typed | yes | Relay for the SG-Ready boost contact | +| dim | charger-typed | no | Relay for the SG-Ready dim contact | + ### Vehicle {#vehicle} Vehicle parameters can also be read via plugins.