generated from just-the-docs/just-the-docs-template
-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
208 additions
and
55 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,9 +4,9 @@ layout: page | |
| parent: SENEC-Collector | ||
| --- | ||
|
|
||
| Der SENEC-Collector wird in das Gesamt-Setup von SOLECTRUS integriert, d.h. die bestehenden Dateien `compose.yaml` und `.env` müssen erweitert werden. Hier nur die relevanten Teile: | ||
| # Konfigurieren des SENEC-Collectors | ||
|
|
||
| Erforderlich ist eine Schreibberechtigung auf InfluxDB, um dorthin Messwerte schreiben zu können. | ||
| Der Shelly-Collector wird üblicherweise in die Gesamtkonfiguration von SOLECTRUS integriert, d.h. die bestehenden Dateien `compose.yaml` und `.env` sind zu erweitern. | ||
|
|
||
| ## compose.yaml | ||
|
|
||
|
|
@@ -50,58 +50,132 @@ services: | |
| # ... | ||
| ``` | ||
|
|
||
| ## .env | ||
| {:.note} | ||
|
|
||
| Die beiden Variablen `INFLUX_TOKEN` und `INFLUX_MEASUREMENT` werden anders lautenden Umgebungsvariablen entnommen. Dies ermöglicht eine Nutzung von Variablen für verschiedene Container und vermeidet Redundanzen. | ||
|
|
||
| ## Umgebungsvariablen | ||
|
|
||
| ### `SENEC_ADAPTER` | ||
|
|
||
| Betriebsmodus des Collectors | ||
|
|
||
| Erlaubte Werte: `local` oder `cloud` \ | ||
| Standard: `local` | ||
|
|
||
| ### `SENEC_HOST` | ||
|
|
||
| Hostname des SENEC Stromspeichers. Dies ist üblicherweise eine IP-Adresse, kann aber auch eine lokale Domain sein. Es darf **kein** `http://` oder `https://` enthalten sein! | ||
|
|
||
| Wird nur verwendet, wenn `SENEC_ADAPTER` auf `local` gesetzt ist. | ||
|
|
||
| ### `SENEC_SCHEMA` | ||
|
|
||
| Das zu verwendende Potokoll für die Verbindung zum SENEC-Stromspeicher. | ||
|
|
||
| Erlaubte Werte: `http`, `https` \ | ||
| Standard: `https` | ||
|
|
||
| Wird nur verwendet, wenn `SENEC_ADAPTER` auf `local` gesetzt ist. | ||
|
|
||
| ### `SENEC_LANGUAGE` | ||
|
|
||
| Die Sprache, die für Status-Texte verwendet werden soll. | ||
|
|
||
| Erlaubte Werte: `de` (Deutsch), `en` (Englisch), `it` (Italienisch) \ | ||
| Standard: `de` | ||
|
|
||
| Wird nur verwendet, wenn `SENEC_ADAPTER` auf `local` gesetzt ist. | ||
|
|
||
| ### `SENEC_USERNAME` | ||
|
|
||
| E-Mail-Adresse für die Anmeldung bei `mein-senec.de`. | ||
|
|
||
| Wird nur verwendet, wenn `SENEC_ADAPTER` auf `cloud` gesetzt ist. | ||
|
|
||
| ### `SENEC_PASSWORD` | ||
|
|
||
| Passwort für die Anmeldung bei `mein-senec.de`. | ||
|
|
||
| Wird nur verwendet, wenn `SENEC_ADAPTER` auf `cloud` gesetzt ist. | ||
|
|
||
| ### `SENEC_SYSTEM_ID` | ||
|
|
||
| Die System-ID des SENEC-Geräts. Kann leer bleiben, wenn es nur ein System gibt. Der Collector ermittelt dann die verfügbaren IDs, listet sie im Protokoll auf und verwendet die **erste**. | ||
|
|
||
| Um eine andere als die erste ID zu verwenden, sollte die Angabe nächst leer bleiben, der Collector gestartet und die ID aus dem Protokoll entnommen werden. Die gewünschte ID kann dann in die Umgebungsvariablen eingetragen werden und wird beim nächsten Start verwendet. | ||
|
|
||
| Wird nur verwendet, wenn `SENEC_ADAPTER` auf `cloud` gesetzt ist. | ||
|
|
||
| ### `SENEC_INTERVAL` | ||
|
|
||
| Das Intervall in Sekunden für die Häufigkeit der Datenabfrage | ||
|
|
||
| Wenn `SENEC_ADAPTER` auf `cloud` gesetzt ist, ist das Minimum 30 Sekunden, Standard ist 60 Sekunden. | ||
| Wenn `SENEC_ADAPTER` auf `local` gesetzt ist, ist das Minimum 5 Sekunden, Standard ist 5 Sekunden. | ||
|
|
||
| ### `SENEC_IGNORE` | ||
|
|
||
| Deaktivieren bestimmter Messwerte, die nicht an InfluxDB gesendet werden sollen. | ||
| Dies ist nützlich, wenn einzelne Messwerte (z.B. der Wallbox) aus einer anderen Quelle entnommen werden sollen. | ||
|
|
||
| Komma-getrennte Liste von Feldern, keine Leerzeichen. Beispiel: | ||
|
|
||
| ```properties | ||
| # Welcher Adapter soll verwendet werden? | ||
| # Werte: local, cloud (Standard: local) | ||
| SENEC_ADAPTER=local | ||
| SENEC_IGNORE=wallbox_charge_power,grid_power_minus | ||
| ``` | ||
|
|
||
| # Die IP-Adresse oder der Hostname Ihres SENEC-Geräts | ||
| # Wird nur bei Verwendung des lokalen Adapters genutzt | ||
| SENEC_HOST=192.168.178.12 | ||
|
|
||
| # Das zu verwendende Potokoll | ||
| # Werte: http, https (Standard: https) | ||
| # Wird nur bei Verwendung des lokalen Adapters genutzt | ||
| SENEC_SCHEMA=https | ||
|
|
||
| # Die Sprache, die für Status-Texte verwendet werden soll. | ||
| # Werte: de, en, it (Standard: de) | ||
| # Wird nur bei Verwendung des lokalen Adapters genutzt | ||
| SENEC_LANGUAGE=de | ||
|
|
||
| # Anmeldedaten für mein-senec.de | ||
| # Wird nur bei Verwendung des Cloud-Adapters genutzt | ||
| SENEC_USERNAME[email protected] | ||
| SENEC_PASSWORD=my-senec-password | ||
|
|
||
| # Die System-ID des SENEC-Geräts | ||
| # Wird nur bei Verwendung des Cloud-Adapters genutzt | ||
| # Kann leer bleiben, wenn es nur ein System gibt. Der Collector ermittelt | ||
| # dann die verfügbaren IDs, listet sie im Protokoll auf und verwendet die erste. | ||
| SENEC_SYSTEM_ID=123456 | ||
|
|
||
| # Das Intervall in Sekunden für die Häufigkeit der Datenabfrage | ||
| # Minimum für den lokalen Adapter ist 5 Sekunden. | ||
| # Minimum für den Cloud-Adapter ist 30 Sekunden. | ||
| SENEC_INTERVAL=5 | ||
| Optional, Standard ist leer (d.h. alle Messwerte werden gesendet) | ||
|
|
||
| # Speicherort ("Measurement") für InfluxDB | ||
| SENEC_INFLUX_MEASUREMENT=SENEC | ||
| ### `INFLUX_HOST` | ||
|
|
||
| # Optional: Deaktivieren bestimmter Messwerte, die nicht an InfluxDB gesendet werden sollen. | ||
| # Dies ist nützlich, wenn einzelne Daten (z.B. Wallbox) aus einer anderen Quelle entnommen werden sollen. | ||
| # Komma-getrennte Liste von Feldern, keine Leerzeichen. Beispiel: | ||
| # SENEC_IGNORE=wallbox_charge_power,grid_power_minus | ||
| Hostname des InfluxDB-Servers. Im Normalfall, wenn InfluxDB im gleichen Docker-Netzwerk läuft, ist das der Name des Containers (z.B. `influxdb`). Es kann aber auch ein externer InfluxDB-Server sein, z.B. `influxdb.example.com`. | ||
|
|
||
| # Zugangsdaten für InfluxDB | ||
| INFLUX_HOST=influxdb.example.com | ||
| INFLUX_SCHEMA=https | ||
| INFLUX_PORT=443 | ||
| INFLUX_TOKEN=my-super-secret-write-token | ||
| INFLUX_ORG=solectrus | ||
| ### `INFLUX_SCHEMA` | ||
|
|
||
| Schema für die Verbindung zu InfluxDB. Bei Verwendung einer externen InfluxDB, die über TLS abgesichert ist, muss dieser Wert auf `https` gesetzt werden. | ||
|
|
||
| Optional, Standard ist `http` | ||
|
|
||
| ### `INFLUX_PORT` | ||
|
|
||
| Port für die Verbindung zu InfluxDB. | ||
|
|
||
| Optional, Standard ist `8086` | ||
|
|
||
| Bei Verwendung einer externen, per TLS abgesicherten InfluxDB kann z.B. `443` eingestellt werden. | ||
|
|
||
| ### `INFLUX_TOKEN` | ||
|
|
||
| Token für den Zugriff auf InfluxDB. Dieser Token muss in InfluxDB erstellt werden und die Berechtigung haben, Daten in den angegebenen Bucket zu **schreiben**. | ||
|
|
||
| # Der Name des Buckets in InfluxDB | ||
| ### `INFLUX_ORG` | ||
|
|
||
| Organisation in InfluxDB, in der die Messwerte gespeichert werden sollen. | ||
|
|
||
| ### `INFLUX_BUCKET` | ||
|
|
||
| Bucket in InfluxDB, in der die Messwerte gespeichert werden sollen. | ||
|
|
||
| ### `INFLUX_MEASUREMENT` | ||
|
|
||
| Name des Measurements in InfluxDB, das die Messwerte aufnehmen soll. | ||
|
|
||
| Optional, Standard ist `SENEC` | ||
|
|
||
| ## Beispielhafte .env | ||
|
|
||
| ```properties | ||
| SENEC_ADAPTER=local | ||
| SENEC_HOST=192.168.178.29 | ||
| SENEC_INTERVAL=5 | ||
| SENEC_IGNORE=wallbox_charge_power | ||
| SENEC_INFLUX_MEASUREMENT=SENEC | ||
|
|
||
| INFLUX_HOST=influxdb | ||
| INFLUX_SCHEMA=http | ||
| INFLUX_PORT=8086 | ||
| INFLUX_TOKEN_WRITE=my-super-secret-admin-token | ||
| INFLUX_ORG=solectrus | ||
| INFLUX_BUCKET=solectrus | ||
| ``` | ||