Skip to content

Docs: sgready-boost #819

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Docs: sgready-boost #819

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b3d5ec3
Docs: sgready-boost
naltatis Jun 13, 2025
d6498e6
wip
naltatis Jun 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 7 additions & 52 deletions docs/devices/heating.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Dies empfiehlt sich eigentlich fast immer, da die intern ermittelten Daten bei d
Im Diagram ist ein Shelly 3EM dargestellt, hier kann aber ein beliebiger [Zähler](./meters) verwendet werden.

Dieses Code-Beispiel zeigt, wie du eine Wärmepumpe mittels Shelly 1 und Shelly 3EM konfigurieren kannst.
Dafür kommt der spezielle Typ `sgready` zum Einsatz.
Dafür kommt der spezielle Typ `sgready-boost` zum Einsatz.

```yaml
loadpoints:
Expand All @@ -84,64 +84,19 @@ meters:

chargers:
- name: heatpump_control
type: sgready
setmode:
source: switch
switch:
- case: 1 # dimm (not supported, yet)
set:
source: error
error: ErrNotAvailable
- case: 2 # normal
set:
# Hier wird der Funktionsaufruf eingefügt, der die Heizung in den Normalbetrieb setzt.
# Dafür können alle üblichen Plugins verwendet werden.
source: const
value: false
set:
source: charger
config:
type: template
template: shelly # Boost-Kontakt der Wärmepumpe
host: 192.168.0.101
- case: 3 # boost
set:
# Hier wird der Funktionsaufruf eingefügt, der die Heizung in den Boostbetrieb setzt.
source: const
value: true
set:
source: charger
config:
type: template
template: shelly # Boost-Kontakt der Wärmepumpe
host: 192.168.0.101
getmode:
# hier wird der Funktionsaufruf eingefügt, der den Status der Heizung zurückmeldet:
# 1 für reduzierte Leistung
# 2 für Normalbetrieb
# 3 für Boostbetrieb
source: calc
add:
- source: const
value: 2
- source: charger
config:
type: template
template: shelly # Boost-Kontakt der Wärmepumpe
host: 192.168.0.101
type: sgready-boost
charger:
type: template
template: shelly # Boost-Kontakt der Wärmepumpe
host: 192.168.0.101
# temp:
# source: http
# uri: "http://192.168.0.103/temperature"

# [...]
```

:::note
Dieses Code-Beispiel enthält einige Redundanzen.
Wir werden später Templates für die einfachere Konfiguration gängiger Konstellationen bereitstellen.
:::

Neben `setmode` und `getmode`, kannst du optional auch die aktuelle Temperatur (`temp`) [via Plugin](./plugins) hinzufügen.
Optional kannst du auch die aktuelle Temperatur (`temp`) [via Plugin](./plugins) hinzufügen.
Diese dient lediglich zur Anzeige und wird bei Wärmepumpen nicht für die Steuerung verwendet.

## Heizstäbe
Expand Down
59 changes: 7 additions & 52 deletions i18n/en/docusaurus-plugin-content-docs/current/devices/heating.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ If you want to monitor the power and energy consumption of the heat pump, you ca
In the diagram, a Shelly 3EM is shown, but any [meter](./meters) can be used.

This example shows how to configure a heat pump using a Shelly 1 and a Shelly 3EM.
The special type `sgready` is used for this.
The special type `sgready-boost` is used for this.

```yaml
loadpoints:
Expand All @@ -79,64 +79,19 @@ meters:

chargers:
- name: heatpump_control
type: sgready
setmode:
source: switch
switch:
- case: 1 # dimm (not supported, yet)
set:
source: error
error: ErrNotAvailable
- case: 2 # normal
set:
source: const
value: false
set:
# Add the function here to set the heatpump in normal operation mode.
# All types of plugins can be used.
source: charger
config:
type: template
template: shelly # Boost contact of the heat pump
host: 192.168.0.101
- case: 3 # boost
set:
# Add the function here to set the heatpump in boost mode.
source: const
value: true
set:
source: charger
config:
type: template
template: shelly # Boost contact of the heat pump
host: 192.168.0.101
getmode:
# Add function here to get the current mode of the heatpump, return
# 1 for reduced operation
# 2 for normal operation
# 3 for boost operation
source: calc
add:
- source: const
value: 2
- source: charger
config:
type: template
template: shelly # Boost contact of the heat pump
host: 192.168.0.101
type: sgready-boost
charger:
type: template
template: shelly # Boost contact of the heat pump
host: 192.168.0.101
# temp:
# source: http
# uri: "http://192.168.0.103/temperature"

# [...]
```

:::note
This code example contains some redundancies.
We will later provide templates for easier configuration of common hardware constellations.
:::

In addition to `setmode` and `getmode`, you can optionally add the current temperature (`temp`) [via Plugin](./plugins).
You can optionally add the current temperature (`temp`) [via Plugin](./plugins).
This is only used for display.
evcc does not use this value for regulation.

Expand Down