Skip to content

Commit 1f5bede

Browse files
committed
added some (fictional) examples
1 parent c491032 commit 1f5bede

File tree

1 file changed

+59
-7
lines changed

1 file changed

+59
-7
lines changed

docs/reference/plugins.md

Lines changed: 59 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Das Schema hat dabei immer folgende Struktur:
6262
....
6363
```
6464
65-
Dabei stehen `<name>`für den Namen des Geräts, `<attr1>` und `<attr2>` für eine der unten beschriebenen Geräteattribute, `<plugin>` für den Plugin-Typ und `<p-attr1>`, `<p-attr2>` für Plugin-spezifische Konfigurationen.
65+
Dabei stehen `<name>` für den Namen des Geräts, `<attr1>` und `<attr2>` für eine der unten beschriebenen Geräteattribute, `<plugin>` für den Plugin-Typ und `<p-attr1>`, `<p-attr2>` für Plugin-spezifische Konfigurationen.
6666

6767
#### Lesen
6868

@@ -104,10 +104,16 @@ Dabei werden alle Werte lesend von konfigurierten Plugins übernommen.
104104

105105
**Beispiel**
106106

107-
In diesem Beispiel wird die Konfiguration eines `meter`s um die gemessene Gesamtenergie über einen REST Aufruf mithilfe des HTTP-Plugins abgefragt:
107+
In diesem Beispiel wird die Konfiguration eines `meter`s um die aktuelle elektrische Leistung über einen HTTP Aufruf abgefragt:
108108

109109
```yaml
110-
// TODO ...
110+
meters:
111+
- name: volkszaehler
112+
type: custom
113+
power:
114+
source: http
115+
uri: http://zaehler.network.local:8080/api/data.json?from=now
116+
jq: .data.tuples[0][1]
111117
```
112118

113119
### Charger
@@ -129,10 +135,21 @@ Wallboxen und Ladegeräte haben folgende Attribute die ausgelesen werden können
129135

130136
**Beispiel**
131137

132-
Dieses Beispiel zeigt, wie man mit einem Shell Skript den Ladestatus (ladend/nicht ladend) eines `charger`s abfragen kann:
138+
Dieses Beispiel zeigt, wie man über das Modbus Plugin den Ladestatus (ladend/nicht ladend) eines `charger`s abfragen kann:
133139

134140
```yaml
135-
// TODO ...
141+
chargers:
142+
- name: icharge
143+
type: custom
144+
enabled:
145+
source: modbus
146+
id: 4711
147+
uri: modbus.local:502
148+
rtu: false
149+
register:
150+
address: 100
151+
type: holding
152+
decode: uint16
136153
```
137154

138155
Neben den read-only Werten können über Plugins auch Aktionen getriggert oder Konfigurationswerte gesetzt werden:
@@ -144,10 +161,17 @@ Neben den read-only Werten können über Plugins auch Aktionen getriggert oder K
144161

145162
**Beispiel**
146163

147-
Dieses Beispiel begrenzt den maximalen Ladestrom in dem eine MQTT Nachricht gesendet wird:
164+
Dieses Beispiel schaltet eine Tasmota Steckdose über eine MQTT Nachricht gesendet an:
148165

149166
```yaml
150-
// TODO ...
167+
chargers:
168+
- name: unu-charger
169+
type: custom
170+
enable:
171+
source: mqtt
172+
broker: mosquitto.local:883
173+
topic: cmd/unu-switch/Power
174+
payload: ON
151175
```
152176

153177
### Vehicle
@@ -166,11 +190,39 @@ Fahrzeugparameter können ebenfalls über Plugins ausgelesen werden.
166190
| maxcurrent | int | Maximaler Ladestrom |
167191
| finishtime | | |
168192

193+
**Beispiel**
194+
195+
Im folgenden Beispiel wie die aktuelle Reichweite des Fahrzeugs aus MQTT Nachrichten gelesen:
196+
197+
``` yaml
198+
vehicles:
199+
- name: Mazda
200+
type: custom
201+
range:
202+
source: mqtt
203+
topic: mazda2mqtt/c53/chargeInfo/drivingRangeKm
204+
```
205+
169206
Zusätzlich können spezielle Kommandos über Plugins an das Fahrzeug geschickt werden:
170207

171208
| Attribut | Typ | Beschreibung |
172209
| -------- | --- | ------------ |
173210
| wakeup | ? | Aufweck-Ping |
211+
| chargeEnable | ? | Start/Stop des Ladevorgangs über das Vehicle |
212+
| maxCurrent | ? | Begrenze maximalen Ladestrom |
213+
214+
**Beispiel**
215+
216+
Um ein Auto über einen HTTP Ping aufzuwecken um weiter Abfragen zu senden, kann wie im folgenden Beispiel das HTTP Plugin genutzt werden:
217+
218+
``` yaml
219+
vehicles:
220+
- name: model-y
221+
type: custom
222+
wakeup:
223+
source: http
224+
uri: http://teslalogger.local:5000/command/08154711/wake_up
225+
```
174226

175227
## Plugins
176228

0 commit comments

Comments
 (0)