Modul Shelly
Todo: Achtung: Diese Seite ist teilweise veraltet, insbesondere unterstützt das Modul weitere Aktoren. Bitte Commandref lesen - diese Seite ist in Überarbeitung |
Shelly | |
---|---|
Zweck / Funktion | |
Das Modul stellt ein Interface zur Bedienung von Shelly Devices zur Verfügung | |
Allgemein | |
Typ | Gerätemodul |
Details | |
Dokumentation | EN / DE Thema |
Support (Forum) | Sonstige Systeme |
Modulname | 36_Shelly.pm |
Ersteller | Starkstrombastler (Forum /Wiki) |
Wichtig: sofern vorhanden, gilt im Zweifel immer die (englische) Beschreibung in der commandref! |
Auf dieser Seite werden die Aktoren des bulgarischen Herstellers Allterco Robotics beschrieben ((Markenname Shelly) sowie deren Ansteuerung mit FHEM und aufgetretene Probleme.
Bei den Shelly-Geräten handelt es sich um IP-basierte Schalt- und Dimmaktoren, die auf verschiedene Weise angesteuert werden können
- über die Web-Oberfläche des eingebauten Mikro-Webservers,
- über eine proprietäre App des Herstellers (Achtung, Cloud!),
- über das hier beschriebene FHEM-Modul 36_Shelly.pm
- über MQTT
Ein Teil der Aktoren verfügt über eine eingebaute Leistungsmessung.
Geräteübersicht
Modell | Typ | Schaltkanäle | Dimmkanäle | Messkanäle | Bemerkungen |
---|---|---|---|---|---|
Shelly1 | Schalter | 1 | |||
Shelly1L | Schalter | 1 | 1 | ||
Shelly1PM | Schalter mit Leistungsmessung | 1 | 1 | ||
ShellyPlug, ShellyPlugS | Schalter mit Leistungsmessung | 1 | 1 | 1 Taster | |
Shelly2 | Schalter/Rollladenaktor | 2/1 | 1 | ||
Shelly2.5 | Schalter/Rollladenaktor | 2/1 | 2 | ||
Shelly4Pro | Schalter | 4 | 4 | ||
ShellyRGBW | Dimmer | 4 | 1 / 4 | 1 / 4 | RGBW Controller |
ShellyDimmer | Dimmer | 1 | 1 | ||
ShellyBulb | Leuchte | 1 | 1 | ||
ShellyDuo | Leuchte | 1 | 1 | ||
ShellyVintage | Leuchte | 1 | 1 | ||
ShellyEM | Leistungsmessung | 1 | 2 | ||
Shelly3EM | Leistungsmessung | 1 | 3 | ||
ShellyI3 | Digitale Eingänge | 3 Digital | |||
ShellyUni | WLAN Sensoreingang | 2 | 1-Wire, 2 potentialfreie Relaisausgänge |
Einbindung in FHEM
Vorgehensweise zur Einbindung eines Shelly-Gerätes in FHEM:
- Aktor nach Vorschrift anschließen
- mit einem WLAN-fähigen Gerät (Laptop, Smartphone, Tablet; im Folgenden als Laptop bezeichnet) nach dem internen Access Point suchen, der durch das Shelly-Gerät erzeugt wird; typischerweise hat es eine SSID ähnlich wie
shelly1-..., shellyswitch-..., shelly4pro-...,
- Laptop mit diesem Access Point verbinden; typischerweise bekommt das Gerät dabei die IP-Adresse 192.168.33.2 zugewiesen.
- im Browser des Laptops die IP-Adresse 192.168.33.1 aufrufen - das ist der Shelly selbst; in der damit angezeigten Weboberfläche kann das Shelly-Gerät konfiguriert werden
- Internen Access Point abschalten
- Shelly ins häusliche WLAN anmelden (mit fester IP-Adresse <shelly-ip> natürlich...)
- Testen: Laptop wieder mit dem häuslichen WLAN verbinden, und im Browser die Adresse <shelly-ip> aufrufen
- In FHEM definieren
define myShelly Shelly <shelly-ip>
- Das Modul setzt bei bekannten Geräten das Attribut
model
automatisch. Bei nicht unterstützten Geräten wird das Attribut auf den Wertgeneric
gesetzt. In diesen Fällen kann das Attributmodel
auf der Detailseite des Devices manuell gesetzt werden:
attr myShelly model shellyrgbw|shellydimmer|shelly2.5|shelly2|shellyem|shelly3em|shelly4|shellyplug|shelly1|shellybulb|shelly1pm|shellyuni|generic
Falls es sich um einen Shelly2 oder 2.5 handelt, muss ferner das Attribut mode
auf "roller" oder "relay" gesetzt werden. Mit diesem Modul können alle Daten übertragen und (prinzipiell) alle Konfigurationsänderungen durchgeführt werden, außerdem ist es auf einfachste Weise zu installieren. Das Modul pollt im per Attribut interval
einstellbaren Abstand zyklisch den Aktor auf Statusänderungen (Wert 0 => kein Polling). Damit der Aktor im Stande ist, irgendwelche Zustandsänderungen von sich aus an FHEM zu melden, müssen diese als REST-Befehle (also URL-Aufrufe) in der Konfigurationsoberfläche des Shelly-Aktors eingetragen werden. Siehe CommandRef.
Zum Betrieb ist ferner noch zu bemerken, dass das Modul zwar meldet, ob ein Firmware-Update nötig ist, ausgelöst werden muss dieses aber über die Web-Oberfläche des Shelly selber.
Actions/Webhooks (nur Testversion)
Ab Shelly Firmware 1.5.0 werden Actions unterstützt. Damit besteht die Möglichkeit, dass ein Shelly bei Eintreten bestimmter Ereignisse von sich aus Meldungen an andere Shellies und/oder übergeordnete Systeme wie FHEM absetzt. Dies ist nützlich, um Statusänderungen, die z.B. durch lokal betätigte Tasten entstehen, direkt an FHEM zu übermitteln.
Nachfolgende Beispiele zeigen den Code, der im Shelly unter URL einzutragen ist:
Ausgang (Relais) eines Shelly1 schaltet ein:
http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=set%20<name>%20out_on
hierbei sind:
<FHEM-IP>
die IP-Adresse des Servers auf dem FHEM läuft<Port>
die Port-Nummer<name>
der Name des FHEM-Devices%20
stellt ein Leerzeichen dar
Beispiel 2: Eingang eines Shelly2 wird betätigt:
http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=set%20<name>%20input_on%20<ch>
<ch>
die Nummer des Schaltkanals (Nummer des Eingangs), z.B.0
oder1
Beispiel 3: Eingang1 eines ShellyDimmers wird betätigt:
http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=set%20<name>%20short_push<nowiki/>%20<inp>
<inp>
Nummer des Eingangs, 0 oder 1 (ShellyDimmer verfügen je Schaltkanal über zwei Eingänge)
Beispiel 4: Wirkleistung eines ShellyPro3EM:
http://<FHEM-IP>:<Port>/fhem?XHR=1&fwcsrf=csrf_368985985592099&cmd=set%20Y173%20Active_Power_$phase%20$active_power
fwcsrf=csrf_368985985592099
das CSRF-Token (FHEMWeb)$phase
wird vom Shelly durch a, b oder c ersetzt$active_power
wird vom Shelly durch die aktuelle Wirkleistung ersetzt
Enpoints
In vorstehenden Beispielen stellt der Teil set%20<name>%20<cmd>
den Endpoint dar, d.h. dies ist der Befehl, der vom Shelly-Device in FHEM verarbeitet werden muss.
Liste der Befehle der Set-Endpoints:
<cmd> | Wert | Reading | Erläuterung | Geräte |
---|---|---|---|---|
out_on
|
relay_<ch> state
|
Ausgang ein | alle Shelly mit Relaisausgang
ShellyBulb ShellyRGBW | |
out_off
|
Ausgang aus | |||
button_on
|
button_<ch>
|
Eingang ein | ShellyPlug
ShellyPlugS | |
button_off
|
Eingang aus | |||
input_on
|
input_<ch>
|
Eingang ein | alle Shelly mit HW-Eingang, aber nicht Shelly-I-Geräte | |
input_off
|
Eingang aus | |||
input_on
|
input_<inp>
|
Eingang ein | ShellyDimmer | |
input_off
|
Eingang aus | |||
short_push
|
kurzer Tastendruck | |||
long_push
|
langer Tastendruck | |||
single_push
|
input_<ch> input_<ch>_action
|
kurzer Tastendruck | ShellyI3
ShellyI4 | |
long_push
|
langer Tastendruck | |||
double_push
|
zweifacher Tastendruck | |||
triple_push
|
dreifacher Tastendruck | |||
short_long_push
|
Tastersequenz lang-kurz | ShellyI3 | ||
long_short_push
|
Tastersequenz kurz-lang | |||
stopped
|
state
|
Rollo angehalten | Shelly2/2.5/Plus2/Pro2 mode=roller | |
opening
|
Rollo wird geöffnet | |||
closing
|
Rollo wird geschlossen | |||
is_open
|
Rollo offen (in oberer Endlage) | |||
is_closed
|
Rollo geschlossen (in unterer Endlage) | |||
temperature_over
|
temperature_<ch>_range
|
Temperatur überschreitet eingestellten Grenzwert | ShellyAddOn | |
temperature_under
|
temperature_<ch>_range
|
Temperatur unterschreitet eingestellten Grenzwert | ||
humidity_over
|
humidity_<ch>_range
|
Luftfeuchtigkeit überschreitet eingestellten Grenzwert | ||
humidity_under
|
humidity_<ch>_range
|
Luftfeuchtigkeit unterschreitet eingestellten Grenzwert | ||
tempC
|
$temperature
|
temperature
|
Temperatur in °C | |
voltage_over
|
voltage_range
|
Spannung überschreitet eingestellten Grenzwert | ShellyUni | |
voltage_under
|
Spannung unterschreitet eingestellten Grenzwert | |||
Active_Power_$phase | $active_power
|
Active_Power_<ph>
|
Änderung Wirkleistung | ShellyPro3EM |
Voltage_$phase | $voltage
|
Voltage_<ph>
|
Änderung Spannung | |
Current_$phase | $current
|
Current_<ph>
|
Änderung Strom |
Bei Eintreffen eines Set-Endpoints wird im Shelly-Device das zugeordnete Reading entsprechend gesetzt. Damit kann das Shelly-Ereignis z.B. mit einem notify
ausgewertet werden. Im Anschluss daran holt sich das Modul die aktuellen Daten vom Shelly und setzt das Intervall zurück.
Anmerkung zum ShellyPro3EM: Die Action wird erst bei einer gewissen Änderung des jeweiligen Wertes ausgelöst. Bei kleinen Schwankungen kommen also keine Webhooks in FHEM an.
Get-Endpoint
Eine besondere Form stellt der Get-Endpoint dar, mit dem das Shelly-Device in FHEM aufgefordert wird, den Status des Shelly zu holen. Beispiel:
http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=get%20<name>%20status
Attribut webhook (derzeit nur Gen2)
Durch Setzten des Attributes webhook
werden auf dem Shelly die verfügbaren Webhooks automatisiert angelegt (auf der Shelly Oberfläche unter Actions zu sehen). Als Attribut-Wert muss das empfangende FHEMWeb-Device ausgewählt werden. Wird das FHEMWeb-Device mit einem csrf-Token abgesichert, wird der Token in den Webhook eingebunden. Bei Änderungen des Tokens (z.B. bei Neustart von FHEM) werden die entsprechenden Webhooks mit angepasst.
Die vom Modul angelegten Webhooks erhalten im Shelly einen Namen, beginnend mit einem Unterstrich (_
). Wird das Attribut geändert oder gelöscht, dann werden auch zugehörige Actions geändert bzw. gelöscht. Durch Entfernen des Unterstrichs im Namen der Action kann dieser Mechanismus unterbunden werden.
Das Reading webhook_cnt
zeigt die Anzahl aller auf dem Shelly hinterlegten Webhooks und webhooks_ver
den Versionszähler des Shelly.
Eine Übersicht aller Actions/Webhooks eines Shelly bekommt man für Gen2-Geräte mit:
http://<ip-des-Shelly>/rpc/Webhook.List
MQTT
MQTT (Message Queue Telemetry Transport) ist ein nachrichtenbasiertes Protokoll, bei dem Geräte (Devices) nicht direkt miteinander, sondern mit einem zentralen MQTT-Server (in alter Nomenklatur Broker genannt) kommunizieren. Eine kurze Einführung in MQTT findet man auf der Seite MQTT Einführung. Mit entsprechend gesetzten Attributen lassen sich die Shelly-Aktoren auch steuern (Praxisbeispiele zu den MQTT2-Modulen), für Anfänger ist das allerdings nicht unbedingt zu empfehlen.