Skip to content

Commit

Permalink
Update readonly parameters (#539)
Browse files Browse the repository at this point in the history
Co-authored-by: Oliver Merk <oliver.merk@gmx.de>
  • Loading branch information
docolli and Oliver Merk authored Mar 23, 2024
1 parent c627fdf commit 360b10f
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 4 deletions.
23 changes: 21 additions & 2 deletions docs/reference/configuration/modbusproxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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**:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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**:

Expand All @@ -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.
Expand All @@ -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**:

Expand Down

0 comments on commit 360b10f

Please sign in to comment.