Skip to content

Fix documentation for custom meter config: #773

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 1 commit into
base: main
Choose a base branch
from
+58 −26
Open

Fix documentation for custom meter config: #773

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 20 additions & 12 deletions docs/devices/meters.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12097,26 +12097,34 @@ Neuere Slimmelezer-Geräte verwenden eine andere Konfiguration. Probieren Sie di
meters:
- name: my_meter
type: custom
power: # power (W)
source: # plugin type
power: # Leistung (W)
source: # Plugin Typ
# ...
energy: # optional energy (kWh)
source: # plugin type
energy: # optional Energie (kWh)
source: # Plugin Typ
# ...
soc: # optional battery soc (%)
source: # plugin type
soc: # optional Batterie SOC (%)
source: # Plugin Typ
# ...
currents: # optional currents (A)
- source: # L1 plugin type
currents: # optional Ströme (A)
- source: # L1 Plugin Typ
# ...
- source: # L2 plugin type
- source: # L2 Plugin Typ
# ...
- source: # L3 plugin type
- source: # L3 Plugin Typ
# ...
batterymode: # controllable (1: normal, 2: hold, 3: charge)
source: # plugin type
limitsoc: # optional SOC unteres Limit
source: # Plugin Typ
# ...
batterymode: # optional Batteriemodus (1: normal, 2: hold, 3: charge)
source: # Plugin Typ
# ...
```

:::note
`limitsoc` wird von EVCC auf den aktuellen Wert von `soc` gesetzt um ein weiteres Entladen der Batterie z.B. beim Schnelladen zu verhindern. Alternativ kann `batterymode` konfiguriert werden und eine externe Steuerung übernimmt die Kontrolle über die Entladung bzw. Ladung der Batterie basierend auf dem von EVCC übermittelten Modus. Wenn `soc` und `limitsoc` konfiguriert sind wird `batterymode` ignoriert.
:::

### Demobatterie

<DeviceFeatures features="" />
Expand Down
32 changes: 20 additions & 12 deletions docs/devices/meters/_generische_unterstützung.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,30 @@
meters:
- name: my_meter
type: custom
power: # power (W)
source: # plugin type
power: # Leistung (W)
source: # Plugin Typ
# ...
energy: # optional energy (kWh)
source: # plugin type
energy: # optional Energie (kWh)
source: # Plugin Typ
# ...
soc: # optional battery soc (%)
source: # plugin type
soc: # optional Batterie SOC (%)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
soc: # optional Batterie SOC (%)
soc: # optional Batterie SoC (%)

source: # Plugin Typ
# ...
currents: # optional currents (A)
- source: # L1 plugin type
currents: # optional Ströme (A)
- source: # L1 Plugin Typ
# ...
- source: # L2 plugin type
- source: # L2 Plugin Typ
# ...
- source: # L3 plugin type
- source: # L3 Plugin Typ
# ...
batterymode: # controllable (1: normal, 2: hold, 3: charge)
source: # plugin type
limitsoc: # optional SOC unteres Limit
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
limitsoc: # optional SOC unteres Limit
limitsoc: # optional SoC unteres Limit

source: # Plugin Typ
# ...
batterymode: # optional Batteriemodus (1: normal, 2: hold, 3: charge)
source: # Plugin Typ
# ...
```

:::note
`limitsoc` wird von EVCC auf den aktuellen Wert von `soc` gesetzt um ein weiteres Entladen der Batterie z.B. beim Schnelladen zu verhindern. Alternativ kann `batterymode` konfiguriert werden und eine externe Steuerung übernimmt die Kontrolle über die Entladung bzw. Ladung der Batterie basierend auf dem von EVCC übermittelten Modus. Wenn `soc` und `limitsoc` konfiguriert sind wird `batterymode` ignoriert.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Style:

  • evcc bitte immer klein scheiben
  • Zeilenumbruch nach jedem Satz. Das macht Diffen deutlich leichter und ändert bei Markdown nichts am Resultat.

:::
10 changes: 9 additions & 1 deletion i18n/en/docusaurus-plugin-content-docs/current/devices/meters.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12114,10 +12114,18 @@ meters:
# ...
- source: # L3 plugin type
# ...
batterymode: # controllable (1: normal, 2: hold, 3: charge)
limitsoc: # optional lower soc limit (%)
source: # plugin type
# ...
batterymode: # optional battery mode (1: normal, 2: hold, 3: charge)
source: # plugin type
# ...
```

:::note
`limitsoc` is set to the current value of 'soc' by EVCC to block further discharge of a battery e.g. for quick charging. Alternatively you can configure `batterymode` and have an external control take care of the charging or discharging of the battery based on the given mode. When `soc` and `limitsoc` are configured `batterymode` will be ignored.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`limitsoc` is set to the current value of 'soc' by EVCC to block further discharge of a battery e.g. for quick charging. Alternatively you can configure `batterymode` and have an external control take care of the charging or discharging of the battery based on the given mode. When `soc` and `limitsoc` are configured `batterymode` will be ignored.
`limitsoc` is set to the current value of `soc` by EVCC to block further discharge of a battery e.g. for quick charging. Alternatively you can configure `batterymode` and have an external control take care of the charging or discharging of the battery based on the given mode. When `soc` and `limitsoc` are configured `batterymode` will be ignored.

:::

### Demo battery

<DeviceFeatures features="" />
Expand Down
10 changes: 9 additions & 1 deletion i18n/en/docusaurus-plugin-content-docs/current/devices/meters/_generic_support.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@ meters:
# ...
- source: # L3 plugin type
# ...
batterymode: # controllable (1: normal, 2: hold, 3: charge)
limitsoc: # optional lower soc limit (%)
source: # plugin type
# ...
batterymode: # optional battery mode (1: normal, 2: hold, 3: charge)
source: # plugin type
# ...
```

:::note
`limitsoc` is set to the current value of 'soc' by EVCC to block further discharge of a battery e.g. for quick charging. Alternatively you can configure `batterymode` and have an external control take care of the charging or discharging of the battery based on the given mode. When `soc` and `limitsoc` are configured `batterymode` will be ignored.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s.o.

:::