From 360b10fe1e7d17d6a4f504ff49106462e0280e62 Mon Sep 17 00:00:00 2001 From: docolli <78646938+docolli@users.noreply.github.com> Date: Sat, 23 Mar 2024 19:51:32 +0100 Subject: [PATCH] Update readonly parameters (#539) Co-authored-by: Oliver Merk --- docs/reference/configuration/modbusproxy.md | 23 +++++++++++++++++-- .../reference/configuration/modbusproxy.md | 23 +++++++++++++++++-- 2 files changed, 42 insertions(+), 4 deletions(-) diff --git a/docs/reference/configuration/modbusproxy.md b/docs/reference/configuration/modbusproxy.md index 20e237a6e6..f0ceec49c0 100644 --- a/docs/reference/configuration/modbusproxy.md +++ b/docs/reference/configuration/modbusproxy.md @@ -50,11 +50,24 @@ Der lokale TCP/IP-Port unter dem eine Verbindung als Proxyserver bereitstellt wi **Beispiel**: ```yaml -port: 5021 +- port: 5021 ``` ## Optionale Parameter +### `uri` + +Die IP-Adresse und der Port des Zielgerätes nach allgemeinem URI-Schema. + +Jeder bereitgestellte Port muss eindeutig und noch nicht von einer anderen Anwendung auf dem evcc Host belegt sein, muss sich aber nicht zwingend vom ausgehenden Port unterscheiden. Es ist somit problemlos möglich eine Freigabe für Port 502 zu definieren, die ihrerseits auf Port 502 des Zielgerätes verweist. + +**Beispiel**: + +```yaml +- port: 502 + uri: 192.0.2.2:502 +``` + ### `rtu` Zu Netzwerkzielen wird üblicherweise mit Modbus TCP kommuniziert. @@ -70,7 +83,13 @@ rtu: true ### `readonly` -Durch `readonly: true` lassen sich Modbus-Schreibzugriffe durch Drittsysteme pauschal unterbinden. +Durch diesen Parameter lassen sich Modbus-Schreibzugriffe durch Drittsysteme pauschal unterbinden. + +**Mögliche Werte**: + +- `true`: Schreibzugriffe werden ohne Antwort blockiert +- `deny`: Schreibzugriffe werden mit einem Modbusfehler als Antwort blockiert +- `false`: Schreibzugriffe werden weitergeleitet **Beispiel**: diff --git a/i18n/en/docusaurus-plugin-content-docs/current/reference/configuration/modbusproxy.md b/i18n/en/docusaurus-plugin-content-docs/current/reference/configuration/modbusproxy.md index c7e62772e7..d4324be783 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/reference/configuration/modbusproxy.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/reference/configuration/modbusproxy.md @@ -44,7 +44,7 @@ For more information about evcc sponsorship, please visit [the sponsorship page] ### `port` -The local TCP/IP port under which a connection is provided as a proxy server, and from which incoming Modbus TCP connections from third-party systems are accepted. +The local TCP/IP port under which a connection is provided as a proxy server, and from which incoming Modbus TCP connections from third-party systems are accepted. **For example**: @@ -54,6 +54,19 @@ port: 5021 ## Optional Parameters +### `uri` + +The IP address and the port of the target device in common URI Scheme. + +Every provided port must be unique and not already in use by another application on the same host, however, it must not be different from the port of the target device. Therefore it is valid to define a configuration for port 502, which refers to port 502 on the target device. + +**For example**: + +```yaml +- port: 502 + uri: 192.0.2.2:502 +``` + ### `rtu` Modbus TCP is typically used for communication with network targets. If needed, you can switch to Modbus RTU over TCP by specifying `rtu: true`. A typical use case is for simple transparent RS485-TCP converters (without protocol translation). This must match the device's configuration. It's ignored for serial target systems. @@ -66,7 +79,13 @@ rtu: true ### `readonly` -By setting `readonly: true`, you can prevent Modbus write accesses by third-party systems. +By setting this parameter, you can prevent Modbus write accesses by third-party systems. + +**Possible values**: + +- `true`: Write access is blocked without response +- `deny`: Write access is blocked with a modbus error as response +- `false`: Write access is forwarded **For example**: