FHEMWiki - Benutzerbeiträge [de]

Modul Shelly

2024-09-15T21:22:34Z

Starkstrombastler: /* Einbindung in FHEM */ XHR=1 aus Command entfernt

{{Todo|'''Achtung: Diese Seite ist teilweise veraltet, insbesondere unterstützt das Modul weitere Aktoren. Bitte Commandref lesen - diese Seite ist in Überarbeitung'''}}
{{Infobox Modul
|ModPurpose=Das Modul stellt ein Interface zur Bedienung von Shelly Devices zur Verfügung
|ModType=d
|ModCmdRef=Shelly
|ModForumArea=Sonstige Systeme
|ModFTopic=118446
|ModTechName=36_Shelly.pm
|ModOwner=Starkstrombastler ({{Link2FU|3884|Forum}}/[[Benutzer Diskussion:Starkstrombastler|Wiki]])
}}
Auf dieser Seite werden die Aktoren des bulgarischen Herstellers Allterco Robotics beschrieben (Markenname Shelly) sowie deren Ansteuerung mit FHEM und aufgetretene Probleme.
{{Randnotiz|RNTyp=r|RNText='''Achtung''': Einige der auf dieser Seite erwähnten Geräte und Funktionen sind derzeit nur mit {{Link2Forum|Topic=111905|Message=1285498|LinkText=dieser Testversion}} verfügbar, die manuell installiert werden muss!
* Für die Weiterentwicklung des Moduls wurde im Forum ein neues Thema '''({{Link2Forum|Topic=137222|LinkText=Entwicklungs-Thread Modul 36_Shelly.pm}})''' aufgemacht.}}
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 (siehe Spalte Messkanäle in unten stehender Tabelle).

==Geräteübersicht==
Übersicht der IP-basierten Produktreihen
{| class="wikitable mw:datatable"
! style="width:15px" |ID
! style="width:100px" | Produktreihe
! style="width:225px" |gemeinsame Merkmale
|-
|SH
|erste Generation
|COIOT (Nutzung mit Shelly-Monitor), kein Bluetooth
|-
|SN
|Shelly Plus
Shelly Plus mini
|
|-
|SP
|Shelly Pro
|Montage auf Hutschiene, zusätzlicher Ethernet-Port (RJ45)
|-
|S3
|Shelly Gen3
Shelly Gen3 mini
|proprietärer Prozessor
|-
|SA
|Control Panel
|Android-System
|}
ID: erste beiden Stellen der Modell-ID

Liste der aktuell unterstützten Geräte
(hier nicht aufgeführte Geräte der ersten Generation können zusammen mit dem Shelly-Monitor genutzt werden):
{| class="wikitable sortable"
! data-sort-type="text" style="width:150px" |Modell
! data-sort-type="text" style="width:75px" |Typ
! data-sort-type="number" style="width:20px;text-align:center;" |Schalt- kanäle
! data-sort-type="number" style="width:20px;text-align:center;" |Dimm- kanäle
! data-sort-type="number" style="width:20px;text-align:center;" |Mess- kanäle
! data-sort-type="number" style="width:20px;text-align:center;" |Digital Eingänge
! |Bemerkungen
|-
! colspan="7" |'''Gen 1'''
|-
|Shelly 1
|Schalter
|1
|
|
|1
|
|
|-
|Shelly 1PM
|Schalter
|1
|
|1
|1
|
|
|-
|Shelly 1L
|Schalter
| 1
|
|1
| 1
|
|
|-
| rowspan="2" |Shelly 2
| Schalter
|2
|
|1
|2
|
|
|-
|Rollladenaktor
|1
|
|1
|2
|
|-
| rowspan="2" |Shelly 2.5
|Schalter
| 2
|
|2
|2
|
|-
|Rollladenaktor
|1
|
|1
|2
|
|-
|Shelly 4Pro
|Schalter
|4
|
|4
|4
|
|-
|Shelly i3
| Digitale Eingänge
|
|
|
|3
|
|-
|Shelly EM
|Leistungsmessung
|1
|
|2
|
|
|-
|'''[[Shelly 3EM]]'''
|Leistungsmessung
|1
|
|3
|
|
|-
|'''[[Shelly Uni]]'''
|Universal
|2
|
|
|*)
|1-Wire, 2 potentialfreie Relaisausgänge
Analogeingänge
|-
|Shelly Plug
Shelly Plug S
|Schaltsteckdose
|1
|
|1
|
|1 Taster
|-
| rowspan="2" |Shelly RGBW2
|Dimmer
|
|4
|4
|1
|4-fach Aktor
|-
|Dimmer
|
|1
| 1
|1
|RGBW Controller
|-
|Shelly Dimmer2
|Dimmer
|
| 1
|1
|2
|
|-
|Shelly Duo
|Leuchte
|
|1
|
|
|E27 oder GU10 Fassung
|-
|Shelly Vintage
|Leuchte
|
|1
|
|
|
|-
|Shelly Bulb
|Leuchte
|
|1
|
|
|Modi: weiß oder farbe
|-
! colspan="7" |'''Shelly Plus'''
|-
|Shelly Plus 1

|Schalter
|1
|
|
|1
|
|-
|'''[[Shelly Plus 1PM]]'''
|Schalter
|1
|
|1
|1
|
|-
| rowspan="2" |'''[[Shelly Plus 2PM]]'''
| Schalter
|2
|
|2
|2
|-
|Rollladenaktor
|1
|
| 1
|2
|-
|Shelly Plus i4
|Digitale Eingänge
|
|
|
| 4
|AC und DC - Variante
|-
| Shelly Plus Plug S
Shelly Plus Plug IT
Shelly Plus Plug UK
Shelly Plus Plug US
|Schaltsteckdose

|1
|
|1
|
|1 Taster;
Varianten V1, V2
|-
|Shelly Plus Uni
|Universal
| 2
|
|
|*)
|1-Wire, 2 potentialfreie Relaisausgänge
Analogeingänge; Neu in 2024
|-
|Shelly Plus 0-10V Dimmer
|Dimmer
|
|1
|1
|2
|0-10 V DC Ausgang
|-
| rowspan="2" |Shelly Plus RGBW
|Dimmer
|
|4
|4
|4
|4-fach Aktor
|-
|Dimmer
|
|1
|1
|1
|RGBW Controller
|-
! colspan="7" | '''Shelly Plus Mini'''
|-
|Shelly Plus 1 Mini
|Schalter
|1
|
|
|1
|
|-
|Shelly Plus 1PM Mini
|Schalter
|1
|
|1
|1
|
|-
|Shelly PM Mini
|Leistungsmessung
|
|
| 1
|
|
|-
! colspan="7" |'''Shelly Pro'''
|-
|Shelly Pro 1
|Schalter
|1
|
|
|2
|
|-
|Shelly Pro 1PM
|Schalter
|1
|
|1
|2
|
|-
|Shelly Pro 2
| Schalter
|2
|
|
| 2
|
|-
|Shelly Pro 2PM
|Schalter
|2
|
|2
|2
|
|-
|Shelly Pro Dual
|Rollladenaktor
|4
|
|
|4
|2 Rolladenaktoren
|-
|Shelly Pro Dimmer 1PM
|Dimmer
|
|1
|1
|2
|
|-
|Shelly Pro Dimmer 2PM
|Dimmer
|
| 2
|2
|4
|
|-
|Shelly Pro 3
|Schalter
|3
|
|
|3
|
|-
|Shelly Pro 3EM
|Leistungsmessung
|
|
|3
|
|1 Schaltkanal mit Addon
|-
|Shelly Pro EM50
|Leistungsmessung

|
|
|
|
|
|-
|Shelly Pro 4PM
|Schalter
|4
|
|4
|4
|
|-
! colspan="7" |'''Shelly Gen3'''
|-
| Shelly 1 Gen3
|Schalter
|1
|
|
|1
|
|-
|Shelly 1PM Gen3
|Schalter
|1
|
|1
|1
|
|-
|Shelly i4 Gen3
|Digitale Eingänge
|
|
|
| 4
|
|-
|Shelly Dimmer 0/1-10V Gen3
|Dimmer
|
| 1
| 1
|2
|0-10V DC oder
1-10V DC Ausgang
|-
! colspan="7" |'''Shelly Gen3 Mini'''
|-
|Shelly 1 Mini Gen3
|Schalter
|1
|
|
|1
|
|-
|Shelly 1PM Mini Gen3
|Schalter
|1
|
|1
|1
|
|-
|Shelly PM Mini Gen3
|Leistungsmessung
|
|
|1
|
|
|-
! colspan="7" | '''Control Panels'''
|-
|Shelly Wall Display
| Control Panel
| 1
|
|
| 1
|
|}

==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
:<code>shelly1-..., shellyswitch-..., shelly4pro-..., </code>
*'''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
**Shelly ins häusliche WLAN anmelden (mit fester IP-Adresse <shelly-ip> natürlich...)
**Internen Access Point abschalten (kann auch nach dem nächsten Schritt oder noch später erfolgen)
**Testen: '''Laptop''' wieder mit dem häuslichen WLAN verbinden, und im Browser die Adresse <shelly-ip> aufrufen
*In FHEM definieren
:<code>define myShelly Shelly <shelly-ip></code>
*Das Modul setzt bei bekannten Geräten das Attribut <code>model</code> automatisch. Bei nicht unterstützten Geräten wird das Attribut auf den Wert <code>generic</code> gesetzt. In diesen Fällen kann das Attribut <code>model</code> auf der Detailseite des Devices manuell gesetzt werden:
:<code> attr myShelly model shellyrgbw|shellydimmer|shelly2.5|shelly2|shellyem|shelly3em|shelly4|shellyplug|shelly1|shellybulb|shelly1pm|shellyuni|generic</code>

Falls es sich um einen Shelly2 oder 2.5 handelt, muss ferner das Attribut <code>mode</code> 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 <code>interval</code> 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:
:<code>http://<FHEM-IP>:<Port>/fhem?cmd=set%20<name>%20out_on</code>
hierbei sind:
:<code><FHEM-IP></code> die IP-Adresse des Servers auf dem FHEM läuft
:<code><Port></code> die Port-Nummer
:<code><name></code> der Name des FHEM-Devices
:<code>%20</code> stellt ein Leerzeichen dar

Beispiel 2: Eingang eines Shelly2 wird betätigt:
<syntaxhighlight lang="html">http://<FHEM-IP>:<Port>/fhem?cmd=set%20<name>%20input_on%20<ch></syntaxhighlight>
:<code><ch></code> die Nummer des Schaltkanals (Nummer des Eingangs), z.B. <code>0</code> oder <code>1</code>

Beispiel 3: Eingang1 eines ShellyDimmers wird betätigt:
<syntaxhighlight lang="html">http://<FHEM-IP>:<Port>/fhem?cmd=set%20<name>%20short_push<nowiki/>%20<inp></syntaxhighlight>
:<code><nowiki><inp></nowiki></code> Nummer des Eingangs, 0 oder 1 (ShellyDimmer verfügen je Schaltkanal über zwei Eingänge)

Beispiel 4: Wirkleistung eines ShellyPro3EM:
<syntaxhighlight lang="html">http://<FHEM-IP>:<Port>/fhem?fwcsrf=csrf_368985985592099&cmd=set%20Y173%20Active_Power_$phase%20$active_power</syntaxhighlight>
:<code>fwcsrf=csrf_368985985592099</code> das CSRF-Token (FHEMWeb)
:<code>$phase</code> wird vom Shelly durch a, b oder c ersetzt
: <code>$active_power</code> wird vom Shelly durch die aktuelle Wirkleistung ersetzt

'''Endpoints'''

In vorstehenden Beispielen stellt der Teil <code>set%20<name>%20<cmd></code> den Endpoint dar, d.h. dies ist der Befehl, der vom Shelly-Device in FHEM verarbeitet werden muss.

=====Liste der Befehle der Set-Endpoints:=====
{| class="wikitable sortable mw-collapsible"
|+
!<cmd>
!Wert
!Reading
!Erläuterung
!Geräte
|-
|<code>out_on</code>
|
| rowspan="2" |<code>relay_<ch></code><code>state</code>
|Ausgang ein
| rowspan="2" |alle Shelly mit Relaisausgang
ShellyBulb
ShellyRGBW
|-
|<code>out_off</code>
|
|Ausgang aus
|-
|<code>button_on</code>
|
| rowspan="2" |<code>button_<ch></code>
|Eingang ein
| rowspan="2" |ShellyPlug
ShellyPlugS
|-
|<code>button_off</code>
|
|Eingang aus
|-
|<code>input_on</code>
|
| rowspan="2" |<code>input_<ch></code>
|Eingang ein
| rowspan="2" |alle Shelly mit HW-Eingang, aber nicht Shelly-I-Geräte
|-
|<code>input_off</code>
|
|Eingang aus
|-
|<code>input_on</code>
|
| rowspan="4" |<code>input_<inp></code>
|Eingang ein
| rowspan="4" |ShellyDimmer
|-
|<code>input_off</code>
|
|Eingang aus
|-
|<code>short_push</code>
|
|kurzer Tastendruck
|-
|<code>long_push</code>
|
|langer Tastendruck
|-
|<code>single_push</code>
|
| rowspan="6" |<code>input_<ch></code><code>input_<ch>_action</code>
|kurzer Tastendruck
| rowspan="4" |ShellyI3
ShellyI4
|-
|<code>long_push</code>
|
|langer Tastendruck
|-
|<code>double_push</code>
|
|zweifacher Tastendruck
|-
|<code>triple_push</code>
|
|dreifacher Tastendruck
|-
|<code>short_long_push</code>
|
|Tastersequenz lang-kurz
| rowspan="2" |ShellyI3
|-
|<code>long_short_push</code>
|
|Tastersequenz kurz-lang
|-
|<code>stopped</code>
|
| rowspan="5" |<code>state</code>
|Rollo angehalten
| rowspan="5" | Shelly2/2.5/Plus2/Pro2 mode=roller
<nowiki>*</nowiki>) nur für Shelly Plus2/Pro2
|-
|<code>opening</code>
|
|Rollo wird geöffnet
|-
|<code>closing</code>
|
|Rollo wird geschlossen
|-
|<code>is_open *)</code>
|
|Rollo offen (in oberer Endlage)
|-
|<code>is_closed *)</code>
|
|Rollo geschlossen (in unterer Endlage)
|-
|<code>temperature_over</code>
|
|<code>temperature_<ch>_range</code>
|Temperatur überschreitet eingestellten Grenzwert
| rowspan="5" |ShellyAddOn
|-
|<code>temperature_under</code>
|
|<code>temperature_<ch>_range</code>
|Temperatur unterschreitet eingestellten Grenzwert
|-
|<code>humidity_over</code>
|
|<code>humidity_<ch>_range</code>
|Luftfeuchtigkeit überschreitet eingestellten Grenzwert
|-
| <code>humidity_under</code>
|
|<code>humidity_<ch>_range</code>
|Luftfeuchtigkeit unterschreitet eingestellten Grenzwert
|-
|<code>tempC</code>
|<code>$temperature</code>
|<code>temperature</code>
|Temperatur in °C
|-
|<code>voltage_over</code>
|
| rowspan="2" |<code>voltage_range</code>
|Spannung überschreitet eingestellten Grenzwert
| rowspan="2" |ShellyUni
|-
|<code>voltage_under</code>
|
|Spannung unterschreitet eingestellten Grenzwert
|-
| Active_Power_$phase
|<code>$active_power</code>
|<code>Active_Power_<ph></code>
|Änderung Wirkleistung
| rowspan="3" |ShellyPro3EM
|-
|Voltage_$phase
|<code>$voltage</code>
|<code>Voltage_<ph></code>
| Änderung Spannung
|-
|Current_$phase
|<code>$current</code>
|<code>Current_<ph></code>
|Ä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 <code>notify</code> 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:
:<code>http://<FHEM-IP>:<Port>/fhem?cmd=get%20<name>%20status</code>

====Attribut webhook (derzeit nur Gen2)====
Durch Setzten des Attributes <code>webhook</code> 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 (<code>_</code>). 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 <code>webhook_cnt</code> zeigt die Anzahl aller auf dem Shelly hinterlegten Webhooks und <code>webhooks_ver</code> den Versionszähler des Shelly.

Eine Übersicht aller Actions/Webhooks eines Shelly bekommt man für Gen2-Geräte mit:
:<code>http://<ip-des-Shelly>/rpc/Webhook.List</code>

===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 ([[MQTT2-Module - Praxisbeispiele#Shelly|Praxisbeispiele zu den MQTT2-Modulen]]), für Anfänger ist das allerdings nicht unbedingt zu empfehlen.

==Links==
*{{Link2Forum|Topic=118446|LinkText=Support Thread}} zu diesem Modul
*{{Link2Forum|Topic=137222|LinkText=Entwicklungs Thread}} zur Weiterentwicklung des Moduls, ab Februar 2024
*[http://www.shelly.com Website des Herstellers der Geräte]
*[https://community.shelly.cloud Forum des Herstellers (englischsprachig]

[[Kategorie:Energieverbrauchsmessung]]
[[Kategorie:MQTT]]
[[Kategorie:Bluetooth]]
[[Kategorie:Schalter (Empfänger)]]
[[Kategorie:Shelly]]

Modul Shelly

2024-09-15T21:12:07Z

Starkstrombastler: /* Set-Endpoints is_open / is_closed */

{{Todo|'''Achtung: Diese Seite ist teilweise veraltet, insbesondere unterstützt das Modul weitere Aktoren. Bitte Commandref lesen - diese Seite ist in Überarbeitung'''}}
{{Infobox Modul
|ModPurpose=Das Modul stellt ein Interface zur Bedienung von Shelly Devices zur Verfügung
|ModType=d
|ModCmdRef=Shelly
|ModForumArea=Sonstige Systeme
|ModFTopic=118446
|ModTechName=36_Shelly.pm
|ModOwner=Starkstrombastler ({{Link2FU|3884|Forum}}/[[Benutzer Diskussion:Starkstrombastler|Wiki]])
}}
Auf dieser Seite werden die Aktoren des bulgarischen Herstellers Allterco Robotics beschrieben (Markenname Shelly) sowie deren Ansteuerung mit FHEM und aufgetretene Probleme.
{{Randnotiz|RNTyp=r|RNText='''Achtung''': Einige der auf dieser Seite erwähnten Geräte und Funktionen sind derzeit nur mit {{Link2Forum|Topic=111905|Message=1285498|LinkText=dieser Testversion}} verfügbar, die manuell installiert werden muss!
* Für die Weiterentwicklung des Moduls wurde im Forum ein neues Thema '''({{Link2Forum|Topic=137222|LinkText=Entwicklungs-Thread Modul 36_Shelly.pm}})''' aufgemacht.}}
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 (siehe Spalte Messkanäle in unten stehender Tabelle).

==Geräteübersicht==
Übersicht der IP-basierten Produktreihen
{| class="wikitable mw:datatable"
! style="width:15px" |ID
! style="width:100px" | Produktreihe
! style="width:225px" |gemeinsame Merkmale
|-
|SH
|erste Generation
|COIOT (Nutzung mit Shelly-Monitor), kein Bluetooth
|-
|SN
|Shelly Plus
Shelly Plus mini
|
|-
|SP
|Shelly Pro
|Montage auf Hutschiene, zusätzlicher Ethernet-Port (RJ45)
|-
|S3
|Shelly Gen3
Shelly Gen3 mini
|proprietärer Prozessor
|-
|SA
|Control Panel
|Android-System
|}
ID: erste beiden Stellen der Modell-ID

Liste der aktuell unterstützten Geräte
(hier nicht aufgeführte Geräte der ersten Generation können zusammen mit dem Shelly-Monitor genutzt werden):
{| class="wikitable sortable"
! data-sort-type="text" style="width:150px" |Modell
! data-sort-type="text" style="width:75px" |Typ
! data-sort-type="number" style="width:20px;text-align:center;" |Schalt- kanäle
! data-sort-type="number" style="width:20px;text-align:center;" |Dimm- kanäle
! data-sort-type="number" style="width:20px;text-align:center;" |Mess- kanäle
! data-sort-type="number" style="width:20px;text-align:center;" |Digital Eingänge
! |Bemerkungen
|-
! colspan="7" |'''Gen 1'''
|-
|Shelly 1
|Schalter
|1
|
|
|1
|
|
|-
|Shelly 1PM
|Schalter
|1
|
|1
|1
|
|
|-
|Shelly 1L
|Schalter
| 1
|
|1
| 1
|
|
|-
| rowspan="2" |Shelly 2
| Schalter
|2
|
|1
|2
|
|
|-
|Rollladenaktor
|1
|
|1
|2
|
|-
| rowspan="2" |Shelly 2.5
|Schalter
| 2
|
|2
|2
|
|-
|Rollladenaktor
|1
|
|1
|2
|
|-
|Shelly 4Pro
|Schalter
|4
|
|4
|4
|
|-
|Shelly i3
| Digitale Eingänge
|
|
|
|3
|
|-
|Shelly EM
|Leistungsmessung
|1
|
|2
|
|
|-
|'''[[Shelly 3EM]]'''
|Leistungsmessung
|1
|
|3
|
|
|-
|'''[[Shelly Uni]]'''
|Universal
|2
|
|
|*)
|1-Wire, 2 potentialfreie Relaisausgänge
Analogeingänge
|-
|Shelly Plug
Shelly Plug S
|Schaltsteckdose
|1
|
|1
|
|1 Taster
|-
| rowspan="2" |Shelly RGBW2
|Dimmer
|
|4
|4
|1
|4-fach Aktor
|-
|Dimmer
|
|1
| 1
|1
|RGBW Controller
|-
|Shelly Dimmer2
|Dimmer
|
| 1
|1
|2
|
|-
|Shelly Duo
|Leuchte
|
|1
|
|
|E27 oder GU10 Fassung
|-
|Shelly Vintage
|Leuchte
|
|1
|
|
|
|-
|Shelly Bulb
|Leuchte
|
|1
|
|
|Modi: weiß oder farbe
|-
! colspan="7" |'''Shelly Plus'''
|-
|Shelly Plus 1

|Schalter
|1
|
|
|1
|
|-
|'''[[Shelly Plus 1PM]]'''
|Schalter
|1
|
|1
|1
|
|-
| rowspan="2" |'''[[Shelly Plus 2PM]]'''
| Schalter
|2
|
|2
|2
|-
|Rollladenaktor
|1
|
| 1
|2
|-
|Shelly Plus i4
|Digitale Eingänge
|
|
|
| 4
|AC und DC - Variante
|-
| Shelly Plus Plug S
Shelly Plus Plug IT
Shelly Plus Plug UK
Shelly Plus Plug US
|Schaltsteckdose

|1
|
|1
|
|1 Taster;
Varianten V1, V2
|-
|Shelly Plus Uni
|Universal
| 2
|
|
|*)
|1-Wire, 2 potentialfreie Relaisausgänge
Analogeingänge; Neu in 2024
|-
|Shelly Plus 0-10V Dimmer
|Dimmer
|
|1
|1
|2
|0-10 V DC Ausgang
|-
| rowspan="2" |Shelly Plus RGBW
|Dimmer
|
|4
|4
|4
|4-fach Aktor
|-
|Dimmer
|
|1
|1
|1
|RGBW Controller
|-
! colspan="7" | '''Shelly Plus Mini'''
|-
|Shelly Plus 1 Mini
|Schalter
|1
|
|
|1
|
|-
|Shelly Plus 1PM Mini
|Schalter
|1
|
|1
|1
|
|-
|Shelly PM Mini
|Leistungsmessung
|
|
| 1
|
|
|-
! colspan="7" |'''Shelly Pro'''
|-
|Shelly Pro 1
|Schalter
|1
|
|
|2
|
|-
|Shelly Pro 1PM
|Schalter
|1
|
|1
|2
|
|-
|Shelly Pro 2
| Schalter
|2
|
|
| 2
|
|-
|Shelly Pro 2PM
|Schalter
|2
|
|2
|2
|
|-
|Shelly Pro Dual
|Rollladenaktor
|4
|
|
|4
|2 Rolladenaktoren
|-
|Shelly Pro Dimmer 1PM
|Dimmer
|
|1
|1
|2
|
|-
|Shelly Pro Dimmer 2PM
|Dimmer
|
| 2
|2
|4
|
|-
|Shelly Pro 3
|Schalter
|3
|
|
|3
|
|-
|Shelly Pro 3EM
|Leistungsmessung
|
|
|3
|
|1 Schaltkanal mit Addon
|-
|Shelly Pro EM50
|Leistungsmessung

|
|
|
|
|
|-
|Shelly Pro 4PM
|Schalter
|4
|
|4
|4
|
|-
! colspan="7" |'''Shelly Gen3'''
|-
| Shelly 1 Gen3
|Schalter
|1
|
|
|1
|
|-
|Shelly 1PM Gen3
|Schalter
|1
|
|1
|1
|
|-
|Shelly i4 Gen3
|Digitale Eingänge
|
|
|
| 4
|
|-
|Shelly Dimmer 0/1-10V Gen3
|Dimmer
|
| 1
| 1
|2
|0-10V DC oder
1-10V DC Ausgang
|-
! colspan="7" |'''Shelly Gen3 Mini'''
|-
|Shelly 1 Mini Gen3
|Schalter
|1
|
|
|1
|
|-
|Shelly 1PM Mini Gen3
|Schalter
|1
|
|1
|1
|
|-
|Shelly PM Mini Gen3
|Leistungsmessung
|
|
|1
|
|
|-
! colspan="7" | '''Control Panels'''
|-
|Shelly Wall Display
| Control Panel
| 1
|
|
| 1
|
|}

==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
:<code>shelly1-..., shellyswitch-..., shelly4pro-..., </code>
*'''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
**Shelly ins häusliche WLAN anmelden (mit fester IP-Adresse <shelly-ip> natürlich...)
**Internen Access Point abschalten (kann auch nach dem nächsten Schritt oder noch später erfolgen)
**Testen: '''Laptop''' wieder mit dem häuslichen WLAN verbinden, und im Browser die Adresse <shelly-ip> aufrufen
*In FHEM definieren
:<code>define myShelly Shelly <shelly-ip></code>
*Das Modul setzt bei bekannten Geräten das Attribut <code>model</code> automatisch. Bei nicht unterstützten Geräten wird das Attribut auf den Wert <code>generic</code> gesetzt. In diesen Fällen kann das Attribut <code>model</code> auf der Detailseite des Devices manuell gesetzt werden:
:<code> attr myShelly model shellyrgbw|shellydimmer|shelly2.5|shelly2|shellyem|shelly3em|shelly4|shellyplug|shelly1|shellybulb|shelly1pm|shellyuni|generic</code>

Falls es sich um einen Shelly2 oder 2.5 handelt, muss ferner das Attribut <code>mode</code> 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 <code>interval</code> 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:
:<code>http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=set%20<name>%20out_on</code>
hierbei sind:
:<code><FHEM-IP></code> die IP-Adresse des Servers auf dem FHEM läuft
:<code><Port></code> die Port-Nummer
:<code><name></code> der Name des FHEM-Devices
:<code>%20</code> stellt ein Leerzeichen dar

Beispiel 2: Eingang eines Shelly2 wird betätigt:
<syntaxhighlight lang="html">http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=set%20<name>%20input_on%20<ch></syntaxhighlight>
:<code><ch></code> die Nummer des Schaltkanals (Nummer des Eingangs), z.B. <code>0</code> oder <code>1</code>

Beispiel 3: Eingang1 eines ShellyDimmers wird betätigt:
<syntaxhighlight lang="html">http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=set%20<name>%20short_push<nowiki/>%20<inp></syntaxhighlight>
:<code><nowiki><inp></nowiki></code> Nummer des Eingangs, 0 oder 1 (ShellyDimmer verfügen je Schaltkanal über zwei Eingänge)

Beispiel 4: Wirkleistung eines ShellyPro3EM:
<syntaxhighlight lang="html">http://<FHEM-IP>:<Port>/fhem?XHR=1&fwcsrf=csrf_368985985592099&cmd=set%20Y173%20Active_Power_$phase%20$active_power</syntaxhighlight>
:<code>fwcsrf=csrf_368985985592099</code> das CSRF-Token (FHEMWeb)
:<code>$phase</code> wird vom Shelly durch a, b oder c ersetzt
: <code>$active_power</code> wird vom Shelly durch die aktuelle Wirkleistung ersetzt

'''Endpoints'''

In vorstehenden Beispielen stellt der Teil <code>set%20<name>%20<cmd></code> den Endpoint dar, d.h. dies ist der Befehl, der vom Shelly-Device in FHEM verarbeitet werden muss.

=====Liste der Befehle der Set-Endpoints:=====
{| class="wikitable sortable mw-collapsible"
|+
!<cmd>
!Wert
!Reading
!Erläuterung
!Geräte
|-
|<code>out_on</code>
|
| rowspan="2" |<code>relay_<ch></code><code>state</code>
|Ausgang ein
| rowspan="2" |alle Shelly mit Relaisausgang
ShellyBulb
ShellyRGBW
|-
|<code>out_off</code>
|
|Ausgang aus
|-
|<code>button_on</code>
|
| rowspan="2" |<code>button_<ch></code>
|Eingang ein
| rowspan="2" |ShellyPlug
ShellyPlugS
|-
|<code>button_off</code>
|
|Eingang aus
|-
|<code>input_on</code>
|
| rowspan="2" |<code>input_<ch></code>
|Eingang ein
| rowspan="2" |alle Shelly mit HW-Eingang, aber nicht Shelly-I-Geräte
|-
|<code>input_off</code>
|
|Eingang aus
|-
|<code>input_on</code>
|
| rowspan="4" |<code>input_<inp></code>
|Eingang ein
| rowspan="4" |ShellyDimmer
|-
|<code>input_off</code>
|
|Eingang aus
|-
|<code>short_push</code>
|
|kurzer Tastendruck
|-
|<code>long_push</code>
|
|langer Tastendruck
|-
|<code>single_push</code>
|
| rowspan="6" |<code>input_<ch></code><code>input_<ch>_action</code>
|kurzer Tastendruck
| rowspan="4" |ShellyI3
ShellyI4
|-
|<code>long_push</code>
|
|langer Tastendruck
|-
|<code>double_push</code>
|
|zweifacher Tastendruck
|-
|<code>triple_push</code>
|
|dreifacher Tastendruck
|-
|<code>short_long_push</code>
|
|Tastersequenz lang-kurz
| rowspan="2" |ShellyI3
|-
|<code>long_short_push</code>
|
|Tastersequenz kurz-lang
|-
|<code>stopped</code>
|
| rowspan="5" |<code>state</code>
|Rollo angehalten
| rowspan="5" | Shelly2/2.5/Plus2/Pro2 mode=roller
<nowiki>*</nowiki>) nur für Shelly Plus2/Pro2
|-
|<code>opening</code>
|
|Rollo wird geöffnet
|-
|<code>closing</code>
|
|Rollo wird geschlossen
|-
|<code>is_open *)</code>
|
|Rollo offen (in oberer Endlage)
|-
|<code>is_closed *)</code>
|
|Rollo geschlossen (in unterer Endlage)
|-
|<code>temperature_over</code>
|
|<code>temperature_<ch>_range</code>
|Temperatur überschreitet eingestellten Grenzwert
| rowspan="5" |ShellyAddOn
|-
|<code>temperature_under</code>
|
|<code>temperature_<ch>_range</code>
|Temperatur unterschreitet eingestellten Grenzwert
|-
|<code>humidity_over</code>
|
|<code>humidity_<ch>_range</code>
|Luftfeuchtigkeit überschreitet eingestellten Grenzwert
|-
| <code>humidity_under</code>
|
|<code>humidity_<ch>_range</code>
|Luftfeuchtigkeit unterschreitet eingestellten Grenzwert
|-
|<code>tempC</code>
|<code>$temperature</code>
|<code>temperature</code>
|Temperatur in °C
|-
|<code>voltage_over</code>
|
| rowspan="2" |<code>voltage_range</code>
|Spannung überschreitet eingestellten Grenzwert
| rowspan="2" |ShellyUni
|-
|<code>voltage_under</code>
|
|Spannung unterschreitet eingestellten Grenzwert
|-
| Active_Power_$phase
|<code>$active_power</code>
|<code>Active_Power_<ph></code>
|Änderung Wirkleistung
| rowspan="3" |ShellyPro3EM
|-
|Voltage_$phase
|<code>$voltage</code>
|<code>Voltage_<ph></code>
| Änderung Spannung
|-
|Current_$phase
|<code>$current</code>
|<code>Current_<ph></code>
|Ä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 <code>notify</code> 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:
:<code>http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=get%20<name>%20status</code>

====Attribut webhook (derzeit nur Gen2)====
Durch Setzten des Attributes <code>webhook</code> 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 (<code>_</code>). 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 <code>webhook_cnt</code> zeigt die Anzahl aller auf dem Shelly hinterlegten Webhooks und <code>webhooks_ver</code> den Versionszähler des Shelly.

Eine Übersicht aller Actions/Webhooks eines Shelly bekommt man für Gen2-Geräte mit:
:<code>http://<ip-des-Shelly>/rpc/Webhook.List</code>

===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 ([[MQTT2-Module - Praxisbeispiele#Shelly|Praxisbeispiele zu den MQTT2-Modulen]]), für Anfänger ist das allerdings nicht unbedingt zu empfehlen.

==Links==
*{{Link2Forum|Topic=118446|LinkText=Support Thread}} zu diesem Modul
*{{Link2Forum|Topic=137222|LinkText=Entwicklungs Thread}} zur Weiterentwicklung des Moduls, ab Februar 2024
*[http://www.shelly.com Website des Herstellers der Geräte]
*[https://community.shelly.cloud Forum des Herstellers (englischsprachig]

[[Kategorie:Energieverbrauchsmessung]]
[[Kategorie:MQTT]]
[[Kategorie:Bluetooth]]
[[Kategorie:Schalter (Empfänger)]]
[[Kategorie:Shelly]]

Modul Shelly

2024-08-12T08:44:33Z

Starkstrombastler: Geräteübersicht und Links ergänzt

{{Todo|'''Achtung: Diese Seite ist teilweise veraltet, insbesondere unterstützt das Modul weitere Aktoren. Bitte Commandref lesen - diese Seite ist in Überarbeitung'''}}
{{Infobox Modul
|ModPurpose=Das Modul stellt ein Interface zur Bedienung von Shelly Devices zur Verfügung
|ModType=d
|ModCmdRef=Shelly
|ModForumArea=Sonstige Systeme
|ModFTopic=118446
|ModTechName=36_Shelly.pm
|ModOwner=Starkstrombastler ({{Link2FU|3884|Forum}}/[[Benutzer Diskussion:Starkstrombastler|Wiki]])
}}
Auf dieser Seite werden die Aktoren des bulgarischen Herstellers Allterco Robotics beschrieben (Markenname Shelly) sowie deren Ansteuerung mit FHEM und aufgetretene Probleme.
{{Randnotiz|RNTyp=r|RNText='''Achtung''': Einige der auf dieser Seite erwähnten Geräte und Funktionen sind derzeit nur mit {{Link2Forum|Topic=111905|Message=1285498|LinkText=dieser Testversion}} verfügbar, die manuell installiert werden muss!
* Für die Weiterentwicklung des Moduls wurde im Forum ein neues Thema '''({{Link2Forum|Topic=137222|LinkText=Entwicklungs-Thread Modul 36_Shelly.pm}})''' aufgemacht.}}
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 (siehe Spalte Messkanäle in unten stehender Tabelle).

==Geräteübersicht==
Übersicht der IP-basierten Produktreihen
{| class="wikitable mw:datatable"
! style="width:15px" |ID
! style="width:100px" | Produktreihe
! style="width:225px" |gemeinsame Merkmale
|-
|SH
|erste Generation
|COIOT (Nutzung mit Shelly-Monitor), kein Bluetooth
|-
|SN
|Shelly Plus
Shelly Plus mini
|
|-
|SP
|Shelly Pro
|Montage auf Hutschiene, zusätzlicher Ethernet-Port (RJ45)
|-
|S3
|Shelly Gen3
Shelly Gen3 mini
|proprietärer Prozessor
|-
|SA
|Control Panel
|Android-System
|}
ID: erste beiden Stellen der Modell-ID

Liste der aktuell unterstützten Geräte
(hier nicht aufgeführte Geräte der ersten Generation können zusammen mit dem Shelly-Monitor genutzt werden):
{| class="wikitable sortable"
! data-sort-type="text" style="width:150px" |Modell
! data-sort-type="text" style="width:75px" |Typ
! data-sort-type="number" style="width:20px;text-align:center;" |Schalt- kanäle
! data-sort-type="number" style="width:20px;text-align:center;" |Dimm- kanäle
! data-sort-type="number" style="width:20px;text-align:center;" |Mess- kanäle
! data-sort-type="number" style="width:20px;text-align:center;" |Digital Eingänge
! |Bemerkungen
|-
! colspan="7" |'''Gen 1'''
|-
|Shelly 1
|Schalter
|1
|
|
|1
|
|
|-
|Shelly 1PM
|Schalter
|1
|
|1
|1
|
|
|-
|Shelly 1L
|Schalter
| 1
|
|1
| 1
|
|
|-
| rowspan="2" |Shelly 2
| Schalter
|2
|
|1
|2
|
|
|-
|Rollladenaktor
|1
|
|1
|2
|
|-
| rowspan="2" |Shelly 2.5
|Schalter
| 2
|
|2
|2
|
|-
|Rollladenaktor
|1
|
|1
|2
|
|-
|Shelly 4Pro
|Schalter
|4
|
|4
|4
|
|-
|Shelly i3
| Digitale Eingänge
|
|
|
|3
|
|-
|Shelly EM
|Leistungsmessung
|1
|
|2
|
|
|-
|'''[[Shelly 3EM]]'''
|Leistungsmessung
|1
|
|3
|
|
|-
|'''[[Shelly Uni]]'''
|Universal
|2
|
|
|*)
|1-Wire, 2 potentialfreie Relaisausgänge
Analogeingänge
|-
|Shelly Plug
Shelly Plug S
|Schaltsteckdose
|1
|
|1
|
|1 Taster
|-
| rowspan="2" |Shelly RGBW2
|Dimmer
|
|4
|4
|1
|4-fach Aktor
|-
|Dimmer
|
|1
| 1
|1
|RGBW Controller
|-
|Shelly Dimmer2
|Dimmer
|
| 1
|1
|2
|
|-
|Shelly Duo
|Leuchte
|
|1
|
|
|E27 oder GU10 Fassung
|-
|Shelly Vintage
|Leuchte
|
|1
|
|
|
|-
|Shelly Bulb
|Leuchte
|
|1
|
|
|Modi: weiß oder farbe
|-
! colspan="7" |'''Shelly Plus'''
|-
|Shelly Plus 1

|Schalter
|1
|
|
|1
|
|-
|'''[[Shelly Plus 1PM]]'''
|Schalter
|1
|
|1
|1
|
|-
| rowspan="2" |'''[[Shelly Plus 2PM]]'''
| Schalter
|2
|
|2
|2
|-
|Rollladenaktor
|1
|
| 1
|2
|-
|Shelly Plus i4
|Digitale Eingänge
|
|
|
| 4
|AC und DC - Variante
|-
| Shelly Plus Plug S
Shelly Plus Plug IT
Shelly Plus Plug UK
Shelly Plus Plug US
|Schaltsteckdose

|1
|
|1
|
|1 Taster;
Varianten V1, V2
|-
|Shelly Plus Uni
|Universal
| 2
|
|
|*)
|1-Wire, 2 potentialfreie Relaisausgänge
Analogeingänge; Neu in 2024
|-
|Shelly Plus 0-10V Dimmer
|Dimmer
|
|1
|1
|2
|0-10 V DC Ausgang
|-
| rowspan="2" |Shelly Plus RGBW
|Dimmer
|
|4
|4
|4
|4-fach Aktor
|-
|Dimmer
|
|1
|1
|1
|RGBW Controller
|-
! colspan="7" | '''Shelly Plus Mini'''
|-
|Shelly Plus 1 Mini
|Schalter
|1
|
|
|1
|
|-
|Shelly Plus 1PM Mini
|Schalter
|1
|
|1
|1
|
|-
|Shelly PM Mini
|Leistungsmessung
|
|
| 1
|
|
|-
! colspan="7" |'''Shelly Pro'''
|-
|Shelly Pro 1
|Schalter
|1
|
|
|2
|
|-
|Shelly Pro 1PM
|Schalter
|1
|
|1
|2
|
|-
|Shelly Pro 2
| Schalter
|2
|
|
| 2
|
|-
|Shelly Pro 2PM
|Schalter
|2
|
|2
|2
|
|-
|Shelly Pro Dual
|Rollladenaktor
|4
|
|
|4
|2 Rolladenaktoren
|-
|Shelly Pro Dimmer 1PM
|Dimmer
|
|1
|1
|2
|
|-
|Shelly Pro Dimmer 2PM
|Dimmer
|
| 2
|2
|4
|
|-
|Shelly Pro 3
|Schalter
|3
|
|
|3
|
|-
|Shelly Pro 3EM
|Leistungsmessung
|
|
|3
|
|1 Schaltkanal mit Addon
|-
|Shelly Pro EM50
|Leistungsmessung

|
|
|
|
|
|-
|Shelly Pro 4PM
|Schalter
|4
|
|4
|4
|
|-
! colspan="7" |'''Shelly Gen3'''
|-
| Shelly 1 Gen3
|Schalter
|1
|
|
|1
|
|-
|Shelly 1PM Gen3
|Schalter
|1
|
|1
|1
|
|-
|Shelly i4 Gen3
|Digitale Eingänge
|
|
|
| 4
|
|-
|Shelly Dimmer 0/1-10V Gen3
|Dimmer
|
| 1
| 1
|2
|0-10V DC oder
1-10V DC Ausgang
|-
! colspan="7" |'''Shelly Gen3 Mini'''
|-
|Shelly 1 Mini Gen3
|Schalter
|1
|
|
|1
|
|-
|Shelly 1PM Mini Gen3
|Schalter
|1
|
|1
|1
|
|-
|Shelly PM Mini Gen3
|Leistungsmessung
|
|
|1
|
|
|-
! colspan="7" | '''Control Panels'''
|-
|Shelly Wall Display
| Control Panel
| 1
|
|
| 1
|
|}

==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
:<code>shelly1-..., shellyswitch-..., shelly4pro-..., </code>
*'''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
**Shelly ins häusliche WLAN anmelden (mit fester IP-Adresse <shelly-ip> natürlich...)
**Internen Access Point abschalten (kann auch nach dem nächsten Schritt oder noch später erfolgen)
**Testen: '''Laptop''' wieder mit dem häuslichen WLAN verbinden, und im Browser die Adresse <shelly-ip> aufrufen
*In FHEM definieren
:<code>define myShelly Shelly <shelly-ip></code>
*Das Modul setzt bei bekannten Geräten das Attribut <code>model</code> automatisch. Bei nicht unterstützten Geräten wird das Attribut auf den Wert <code>generic</code> gesetzt. In diesen Fällen kann das Attribut <code>model</code> auf der Detailseite des Devices manuell gesetzt werden:
:<code> attr myShelly model shellyrgbw|shellydimmer|shelly2.5|shelly2|shellyem|shelly3em|shelly4|shellyplug|shelly1|shellybulb|shelly1pm|shellyuni|generic</code>

Falls es sich um einen Shelly2 oder 2.5 handelt, muss ferner das Attribut <code>mode</code> 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 <code>interval</code> 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:
:<code>http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=set%20<name>%20out_on</code>
hierbei sind:
:<code><FHEM-IP></code> die IP-Adresse des Servers auf dem FHEM läuft
:<code><Port></code> die Port-Nummer
:<code><name></code> der Name des FHEM-Devices
:<code>%20</code> stellt ein Leerzeichen dar

Beispiel 2: Eingang eines Shelly2 wird betätigt:
<syntaxhighlight lang="html">http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=set%20<name>%20input_on%20<ch></syntaxhighlight>
:<code><ch></code> die Nummer des Schaltkanals (Nummer des Eingangs), z.B. <code>0</code> oder <code>1</code>

Beispiel 3: Eingang1 eines ShellyDimmers wird betätigt:
<syntaxhighlight lang="html">http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=set%20<name>%20short_push<nowiki/>%20<inp></syntaxhighlight>
:<code><nowiki><inp></nowiki></code> Nummer des Eingangs, 0 oder 1 (ShellyDimmer verfügen je Schaltkanal über zwei Eingänge)

Beispiel 4: Wirkleistung eines ShellyPro3EM:
<syntaxhighlight lang="html">http://<FHEM-IP>:<Port>/fhem?XHR=1&fwcsrf=csrf_368985985592099&cmd=set%20Y173%20Active_Power_$phase%20$active_power</syntaxhighlight>
:<code>fwcsrf=csrf_368985985592099</code> das CSRF-Token (FHEMWeb)
:<code>$phase</code> wird vom Shelly durch a, b oder c ersetzt
: <code>$active_power</code> wird vom Shelly durch die aktuelle Wirkleistung ersetzt

'''Endpoints'''

In vorstehenden Beispielen stellt der Teil <code>set%20<name>%20<cmd></code> den Endpoint dar, d.h. dies ist der Befehl, der vom Shelly-Device in FHEM verarbeitet werden muss.

=====Liste der Befehle der Set-Endpoints:=====
{| class="wikitable sortable mw-collapsible"
|+
!<cmd>
!Wert
!Reading
!Erläuterung
!Geräte
|-
|<code>out_on</code>
|
| rowspan="2" |<code>relay_<ch></code><code>state</code>
|Ausgang ein
| rowspan="2" |alle Shelly mit Relaisausgang
ShellyBulb
ShellyRGBW
|-
|<code>out_off</code>
|
|Ausgang aus
|-
|<code>button_on</code>
|
| rowspan="2" |<code>button_<ch></code>
|Eingang ein
| rowspan="2" |ShellyPlug
ShellyPlugS
|-
|<code>button_off</code>
|
|Eingang aus
|-
|<code>input_on</code>
|
| rowspan="2" |<code>input_<ch></code>
|Eingang ein
| rowspan="2" |alle Shelly mit HW-Eingang, aber nicht Shelly-I-Geräte
|-
|<code>input_off</code>
|
|Eingang aus
|-
|<code>input_on</code>
|
| rowspan="4" |<code>input_<inp></code>
|Eingang ein
| rowspan="4" |ShellyDimmer
|-
|<code>input_off</code>
|
|Eingang aus
|-
|<code>short_push</code>
|
|kurzer Tastendruck
|-
|<code>long_push</code>
|
|langer Tastendruck
|-
|<code>single_push</code>
|
| rowspan="6" |<code>input_<ch></code><code>input_<ch>_action</code>
|kurzer Tastendruck
| rowspan="4" |ShellyI3
ShellyI4
|-
|<code>long_push</code>
|
|langer Tastendruck
|-
|<code>double_push</code>
|
|zweifacher Tastendruck
|-
|<code>triple_push</code>
|
|dreifacher Tastendruck
|-
|<code>short_long_push</code>
|
|Tastersequenz lang-kurz
| rowspan="2" |ShellyI3
|-
|<code>long_short_push</code>
|
|Tastersequenz kurz-lang
|-
|<code>stopped</code>
|
| rowspan="5" |<code>state</code>
|Rollo angehalten
| rowspan="5" | Shelly2/2.5/Plus2/Pro2 mode=roller
|-
|<code>opening</code>
|
|Rollo wird geöffnet
|-
|<code>closing</code>
|
|Rollo wird geschlossen
|-
|<code>is_open</code>
|
|Rollo offen (in oberer Endlage)
|-
|<code>is_closed</code>
|
|Rollo geschlossen (in unterer Endlage)
|-
|<code>temperature_over</code>
|
|<code>temperature_<ch>_range</code>
|Temperatur überschreitet eingestellten Grenzwert
| rowspan="5" |ShellyAddOn
|-
|<code>temperature_under</code>
|
|<code>temperature_<ch>_range</code>
|Temperatur unterschreitet eingestellten Grenzwert
|-
|<code>humidity_over</code>
|
|<code>humidity_<ch>_range</code>
|Luftfeuchtigkeit überschreitet eingestellten Grenzwert
|-
| <code>humidity_under</code>
|
|<code>humidity_<ch>_range</code>
|Luftfeuchtigkeit unterschreitet eingestellten Grenzwert
|-
|<code>tempC</code>
|<code>$temperature</code>
|<code>temperature</code>
|Temperatur in °C
|-
|<code>voltage_over</code>
|
| rowspan="2" |<code>voltage_range</code>
|Spannung überschreitet eingestellten Grenzwert
| rowspan="2" |ShellyUni
|-
|<code>voltage_under</code>
|
|Spannung unterschreitet eingestellten Grenzwert
|-
| Active_Power_$phase
|<code>$active_power</code>
|<code>Active_Power_<ph></code>
|Änderung Wirkleistung
| rowspan="3" |ShellyPro3EM
|-
|Voltage_$phase
|<code>$voltage</code>
|<code>Voltage_<ph></code>
| Änderung Spannung
|-
|Current_$phase
|<code>$current</code>
|<code>Current_<ph></code>
|Ä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 <code>notify</code> 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:
:<code>http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=get%20<name>%20status</code>

====Attribut webhook (derzeit nur Gen2)====
Durch Setzten des Attributes <code>webhook</code> 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 (<code>_</code>). 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 <code>webhook_cnt</code> zeigt die Anzahl aller auf dem Shelly hinterlegten Webhooks und <code>webhooks_ver</code> den Versionszähler des Shelly.

Eine Übersicht aller Actions/Webhooks eines Shelly bekommt man für Gen2-Geräte mit:
:<code>http://<ip-des-Shelly>/rpc/Webhook.List</code>

===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 ([[MQTT2-Module - Praxisbeispiele#Shelly|Praxisbeispiele zu den MQTT2-Modulen]]), für Anfänger ist das allerdings nicht unbedingt zu empfehlen.

==Links==
*{{Link2Forum|Topic=118446|LinkText=Support Thread}} zu diesem Modul
*{{Link2Forum|Topic=137222|LinkText=Entwicklungs Thread}} zur Weiterentwicklung des Moduls, ab Februar 2024
*[http://www.shelly.com Website des Herstellers der Geräte]
*[https://community.shelly.cloud Forum des Herstellers (englischsprachig]

[[Kategorie:Energieverbrauchsmessung]]
[[Kategorie:MQTT]]
[[Kategorie:Bluetooth]]
[[Kategorie:Schalter (Empfänger)]]
[[Kategorie:Shelly]]

Modul Shelly

2024-08-11T15:31:40Z

Starkstrombastler: Geräteübersicht erweitert

{{Todo|'''Achtung: Diese Seite ist teilweise veraltet, insbesondere unterstützt das Modul weitere Aktoren. Bitte Commandref lesen - diese Seite ist in Überarbeitung'''}}
{{Infobox Modul
|ModPurpose=Das Modul stellt ein Interface zur Bedienung von Shelly Devices zur Verfügung
|ModType=d
|ModCmdRef=Shelly
|ModForumArea=Sonstige Systeme
|ModFTopic=118446
|ModTechName=36_Shelly.pm
|ModOwner=Starkstrombastler ({{Link2FU|3884|Forum}}/[[Benutzer Diskussion:Starkstrombastler|Wiki]])
}}
Auf dieser Seite werden die Aktoren des bulgarischen Herstellers Allterco Robotics beschrieben (Markenname Shelly) sowie deren Ansteuerung mit FHEM und aufgetretene Probleme.
{{Randnotiz|RNTyp=r|RNText='''Achtung''': Einige der auf dieser Seite erwähnten Geräte und Funktionen sind derzeit nur mit {{Link2Forum|Topic=111905|Message=1285498|LinkText=dieser Testversion}} verfügbar, die manuell installiert werden muss!
* Für die Weiterentwicklung des Moduls wurde im Forum ein neues Thema '''({{Link2Forum|Topic=137222|LinkText=Entwicklungs-Thread Modul 36_Shelly.pm}})''' aufgemacht.}}
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 (siehe Spalte Messkanäle in unten stehender Tabelle).

==Geräteübersicht==
{| class="wikitable sortable"
! data-sort-type="text" style="width:150px" |Modell
! data-sort-type="text" style="width:75px" | Typ
! data-sort-type="number" style="width:20px;text-align:center;" | Schalt- kanäle
! data-sort-type="number" style="width:20px;text-align:center;" |Dimm- kanäle
! data-sort-type="number" style="width:20px;text-align:center;" |Mess- kanäle
! data-sort-type="number" style="width:20px;text-align:center;" |Digital Eingänge
! |Bemerkungen
|-
! colspan="7" |'''Gen 1'''
|-
| Shelly 1
|Schalter
|1
|
|
|1
|
|
|-
|Shelly 1PM
|Schalter
|1
|
|1
|1
|
|
|-
|Shelly 1L
|Schalter
|1
|
|1
|1
|
|
|-
| rowspan="2" |Shelly 2
|Schalter
|2
|
|1
|2
|
|
|-
|Rollladenaktor
|1
|
|1
|2
|
|-
| rowspan="2" |Shelly 2.5
|Schalter
|2
|
|2
|2
|
|-
|Rollladenaktor
| 1
|
|1
|2
|
|-
|Shelly 4Pro
|Schalter
| 4
|
|4
|4
|
|-
|Shelly i3
|Digitale Eingänge
|
|
|
|3
|
|-
|Shelly EM
|Leistungsmessung
|1
|
|2
|
|
|-
|'''[[Shelly 3EM]]'''
|Leistungsmessung
|1
|
|3
|
|
|-
|'''[[Shelly Uni]]'''
|Universal
|2
|
|
|*)
|1-Wire, 2 potentialfreie Relaisausgänge
Analogeingänge
|-
|Shelly Plug
Shelly Plug S
|Schaltsteckdose
|1
|
|1
|
|1 Taster
|-
| rowspan="2" |Shelly RGBW2
|Dimmer
|
|4
|4
|1
|4-fach Aktor
|-
|Dimmer
|
|1
|1
|1
| RGBW Controller
|-
|Shelly Dimmer2
| Dimmer
|
|1
|1
|2
|
|-
|Shelly Duo
|Leuchte
|
|1
|
|
|E27 oder GU10 Fassung
|-
|Shelly Vintage
| Leuchte
|
|1
|
|
|
|-
|Shelly Bulb
|Leuchte
|
|1
|
|
|Modi: weiß oder farbe
|-
! colspan="7" |'''Shelly Plus'''
|-
|Shelly Plus 1

|Schalter
|1
|
|
|1
|
|-
|'''[[Shelly Plus 1PM]]'''
|Schalter
|1
|
| 1
|1
|
|-
| rowspan="2" |'''[[Shelly Plus 2PM]]'''
|Schalter
|2
|
|2
| 2
|-
|Rollladenaktor
|1
|
|1
|2
|-
|Shelly Plus i4
|Digitale Eingänge
|
|
|
|4
|AC und DC - Variante
|-
|Shelly Plus Plug S
Shelly Plus Plug IT
Shelly Plus Plug UK
Shelly Plus Plug US
|Schaltsteckdose

|1
|
|1
|
|1 Taster;
Varianten V1, V2
|-
|Shelly Plus Uni
|Universal
| 2
|
|
|*)
|1-Wire, 2 potentialfreie Relaisausgänge
Analogeingänge; Neu in 2024
|-
|Shelly Plus 0-10V Dimmer
|Dimmer
|
|1
|1
|2
| 0-10 V DC Ausgang
|-
| rowspan="2" |Shelly Plus RGBW
|Dimmer
|
|4
|4
|4
|4-fach Aktor
|-
|Dimmer
|
|1
|1
|1
|RGBW Controller
|-
! colspan="7" |'''Shelly Plus Mini'''
|-
|Shelly Plus 1 Mini
|Schalter
|1
|
|
|1
|
|-
|Shelly Plus 1PM Mini
|Schalter
|1
|
|1
|1
|
|-
|Shelly PM Mini
|Leistungsmessung
|
|
|1
|
|
|-
! colspan="7" |'''Shelly Pro'''
|-
|Shelly Pro 1
|Schalter
|1
|
|
|2
|
|-
|Shelly Pro 1PM
|Schalter
|1
|
|1
|2
|
|-
|Shelly Pro 2
|Schalter
|2
|
|
|2
|
|-
|Shelly Pro 2PM
|Schalter
|2
|
|2
|2
|
|-
|Shelly Pro Dual
|Rollladenaktor
|4
|
|
|4
|2 Rolladenaktoren
|-
|Shelly Pro Dimmer 1PM
|Dimmer
|
|1
|1
|2
|
|-
|Shelly Pro Dimmer 2PM
|Dimmer
|
|2
|2
|4
|
|-
|Shelly Pro 3
|Schalter
|3
|
|
|3
|
|-
|Shelly Pro 3EM
|Leistungsmessung
|
|
|3
|
|1 Schaltkanal mit Addon
|-
|Shelly Pro EM50
| Leistungsmessung

|
|
|
|
|
|-
|Shelly Pro 4PM
|Schalter
|4
|
|4
|4
|
|-
! colspan="7" |'''Shelly Gen3'''
|-
|Shelly 1 Gen3
|Schalter
|1
|
|
|1
|
|-
|Shelly 1PM Gen3
|Schalter
|1
|
|1
|1
|
|-
|Shelly i4 Gen3
|Digitale Eingänge
|
|
|
|4
|
|-
| Shelly Dimmer 0/1-10V Gen3
|Dimmer
|
|1
|1
|2
|0-10V DC oder
1-10V DC Ausgang
|-
! colspan="7" | '''Shelly Gen 3 Mini'''
|-
| Shelly 1 Mini Gen3
|Schalter
|1
|
|
|1
|
|-
|Shelly 1PM Mini Gen3
| Schalter
| 1
|
|1
|1
|
|-
|Shelly PM Mini Gen3
|Leistungsmessung
|
|
| 1
|
|
|-
| colspan="7" |'''Control Panels'''
|-
|Shelly Wall Display
|Control Panel
|1
|
|
|1
|
|}

==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
:<code>shelly1-..., shellyswitch-..., shelly4pro-..., </code>
*'''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
**Shelly ins häusliche WLAN anmelden (mit fester IP-Adresse <shelly-ip> natürlich...)
**Internen Access Point abschalten (kann auch nach dem nächsten Schritt oder noch später erfolgen)
**Testen: '''Laptop''' wieder mit dem häuslichen WLAN verbinden, und im Browser die Adresse <shelly-ip> aufrufen
*In FHEM definieren
:<code>define myShelly Shelly <shelly-ip></code>
*Das Modul setzt bei bekannten Geräten das Attribut <code>model</code> automatisch. Bei nicht unterstützten Geräten wird das Attribut auf den Wert <code>generic</code> gesetzt. In diesen Fällen kann das Attribut <code>model</code> auf der Detailseite des Devices manuell gesetzt werden:
:<code> attr myShelly model shellyrgbw|shellydimmer|shelly2.5|shelly2|shellyem|shelly3em|shelly4|shellyplug|shelly1|shellybulb|shelly1pm|shellyuni|generic</code>

Falls es sich um einen Shelly2 oder 2.5 handelt, muss ferner das Attribut <code>mode</code> 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 <code>interval</code> 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:
:<code>http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=set%20<name>%20out_on</code>
hierbei sind:
:<code><FHEM-IP></code> die IP-Adresse des Servers auf dem FHEM läuft
:<code><Port></code> die Port-Nummer
:<code><name></code> der Name des FHEM-Devices
:<code>%20</code> stellt ein Leerzeichen dar

Beispiel 2: Eingang eines Shelly2 wird betätigt:
<syntaxhighlight lang="html">http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=set%20<name>%20input_on%20<ch></syntaxhighlight>
:<code><ch></code> die Nummer des Schaltkanals (Nummer des Eingangs), z.B. <code>0</code> oder <code>1</code>

Beispiel 3: Eingang1 eines ShellyDimmers wird betätigt:
<syntaxhighlight lang="html">http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=set%20<name>%20short_push<nowiki/>%20<inp></syntaxhighlight>
:<code><nowiki><inp></nowiki></code> Nummer des Eingangs, 0 oder 1 (ShellyDimmer verfügen je Schaltkanal über zwei Eingänge)

Beispiel 4: Wirkleistung eines ShellyPro3EM:
<syntaxhighlight lang="html">http://<FHEM-IP>:<Port>/fhem?XHR=1&fwcsrf=csrf_368985985592099&cmd=set%20Y173%20Active_Power_$phase%20$active_power</syntaxhighlight>
:<code>fwcsrf=csrf_368985985592099</code> das CSRF-Token (FHEMWeb)
:<code>$phase</code> wird vom Shelly durch a, b oder c ersetzt
:<code>$active_power</code> wird vom Shelly durch die aktuelle Wirkleistung ersetzt

'''Endpoints'''

In vorstehenden Beispielen stellt der Teil <code>set%20<name>%20<cmd></code> den Endpoint dar, d.h. dies ist der Befehl, der vom Shelly-Device in FHEM verarbeitet werden muss.

=====Liste der Befehle der Set-Endpoints:=====
{| class="wikitable sortable mw-collapsible"
|+
!<cmd>
!Wert
!Reading
!Erläuterung
!Geräte
|-
|<code>out_on</code>
|
| rowspan="2" |<code>relay_<ch></code><code>state</code>
|Ausgang ein
| rowspan="2" |alle Shelly mit Relaisausgang
ShellyBulb
ShellyRGBW
|-
|<code>out_off</code>
|
|Ausgang aus
|-
|<code>button_on</code>
|
| rowspan="2" |<code>button_<ch></code>
|Eingang ein
| rowspan="2" |ShellyPlug
ShellyPlugS
|-
|<code>button_off</code>
|
|Eingang aus
|-
|<code>input_on</code>
|
| rowspan="2" |<code>input_<ch></code>
|Eingang ein
| rowspan="2" |alle Shelly mit HW-Eingang, aber nicht Shelly-I-Geräte
|-
|<code>input_off</code>
|
|Eingang aus
|-
|<code>input_on</code>
|
| rowspan="4" |<code>input_<inp></code>
|Eingang ein
| rowspan="4" |ShellyDimmer
|-
|<code>input_off</code>
|
|Eingang aus
|-
|<code>short_push</code>
|
|kurzer Tastendruck
|-
|<code>long_push</code>
|
|langer Tastendruck
|-
|<code>single_push</code>
|
| rowspan="6" |<code>input_<ch></code><code>input_<ch>_action</code>
|kurzer Tastendruck
| rowspan="4" |ShellyI3
ShellyI4
|-
|<code>long_push</code>
|
|langer Tastendruck
|-
|<code>double_push</code>
|
|zweifacher Tastendruck
|-
|<code>triple_push</code>
|
|dreifacher Tastendruck
|-
|<code>short_long_push</code>
|
|Tastersequenz lang-kurz
| rowspan="2" |ShellyI3
|-
|<code>long_short_push</code>
|
|Tastersequenz kurz-lang
|-
|<code>stopped</code>
|
| rowspan="5" |<code>state</code>
|Rollo angehalten
| rowspan="5" |Shelly2/2.5/Plus2/Pro2 mode=roller
|-
|<code>opening</code>
|
|Rollo wird geöffnet
|-
|<code>closing</code>
|
|Rollo wird geschlossen
|-
|<code>is_open</code>
|
|Rollo offen (in oberer Endlage)
|-
|<code>is_closed</code>
|
|Rollo geschlossen (in unterer Endlage)
|-
|<code>temperature_over</code>
|
|<code>temperature_<ch>_range</code>
|Temperatur überschreitet eingestellten Grenzwert
| rowspan="5" |ShellyAddOn
|-
|<code>temperature_under</code>
|
|<code>temperature_<ch>_range</code>
|Temperatur unterschreitet eingestellten Grenzwert
|-
|<code>humidity_over</code>
|
|<code>humidity_<ch>_range</code>
|Luftfeuchtigkeit überschreitet eingestellten Grenzwert
|-
|<code>humidity_under</code>
|
|<code>humidity_<ch>_range</code>
|Luftfeuchtigkeit unterschreitet eingestellten Grenzwert
|-
|<code>tempC</code>
|<code>$temperature</code>
|<code>temperature</code>
|Temperatur in °C
|-
|<code>voltage_over</code>
|
| rowspan="2" |<code>voltage_range</code>
|Spannung überschreitet eingestellten Grenzwert
| rowspan="2" |ShellyUni
|-
|<code>voltage_under</code>
|
|Spannung unterschreitet eingestellten Grenzwert
|-
| Active_Power_$phase
|<code>$active_power</code>
|<code>Active_Power_<ph></code>
|Änderung Wirkleistung
| rowspan="3" |ShellyPro3EM
|-
|Voltage_$phase
|<code>$voltage</code>
|<code>Voltage_<ph></code>
| Änderung Spannung
|-
|Current_$phase
|<code>$current</code>
|<code>Current_<ph></code>
|Ä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 <code>notify</code> 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:
:<code>http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=get%20<name>%20status</code>

==== Attribut webhook (derzeit nur Gen2)====
Durch Setzten des Attributes <code>webhook</code> 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 (<code>_</code>). 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 <code>webhook_cnt</code> zeigt die Anzahl aller auf dem Shelly hinterlegten Webhooks und <code>webhooks_ver</code> den Versionszähler des Shelly.

Eine Übersicht aller Actions/Webhooks eines Shelly bekommt man für Gen2-Geräte mit:
:<code>http://<ip-des-Shelly>/rpc/Webhook.List</code>

===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 ([[MQTT2-Module - Praxisbeispiele#Shelly|Praxisbeispiele zu den MQTT2-Modulen]]), für Anfänger ist das allerdings nicht unbedingt zu empfehlen.

==Links==
*Website des Herstellers der Geräte [www.shelly.com]

[[Kategorie:Energieverbrauchsmessung]]
[[Kategorie:MQTT]]
[[Kategorie:Bluetooth]]
[[Kategorie:Schalter (Empfänger)]]
[[Kategorie:Shelly]]

Modul Shelly

2024-08-11T12:02:01Z

Starkstrombastler: Geräteübersicht erweitert

{{Todo|'''Achtung: Diese Seite ist teilweise veraltet, insbesondere unterstützt das Modul weitere Aktoren. Bitte Commandref lesen - diese Seite ist in Überarbeitung'''}}
{{Infobox Modul
|ModPurpose=Das Modul stellt ein Interface zur Bedienung von Shelly Devices zur Verfügung
|ModType=d
|ModCmdRef=Shelly
|ModForumArea=Sonstige Systeme
|ModFTopic=118446
|ModTechName=36_Shelly.pm
|ModOwner=Starkstrombastler ({{Link2FU|3884|Forum}}/[[Benutzer Diskussion:Starkstrombastler|Wiki]])
}}
Auf dieser Seite werden die Aktoren des bulgarischen Herstellers Allterco Robotics beschrieben (Markenname Shelly) sowie deren Ansteuerung mit FHEM und aufgetretene Probleme.
{{Randnotiz|RNTyp=r|RNText='''Achtung''': Einige der auf dieser Seite erwähnten Geräte und Funktionen sind derzeit nur mit {{Link2Forum|Topic=111905|Message=1285498|LinkText=dieser Testversion}} verfügbar, die manuell installiert werden muss!
* Für die Weiterentwicklung des Moduls wurde im Forum ein neues Thema '''({{Link2Forum|Topic=137222|LinkText=Entwicklungs-Thread Modul 36_Shelly.pm}})''' aufgemacht.}}
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==
{| class="wikitable mw-datatable"
! style="width:100px" |Modell
! style="width:50px" |Typ
! style="width:20px" |Schaltkanäle
! style="width:20px" |Dimmkanäle
! style="width:20px" |Messkanäle
! |Bemerkungen
|-
! colspan="6" |'''Gen 1'''
|-
|Shelly 1
|Schalter
|1
|
|
|
|-
|Shelly 1PM
|Schalter mit Leistungsmessung
|1
|
|1
|-
|Shelly 1L
|Schalter
|1
|
|1
|-
|Shelly 2
|Schalter/Rollladenaktor
|2/1
|
|1
|
|-
|Shelly 2.5
|Schalter/Rollladenaktor
|2/1
|
|2
|
|-
|Shelly 4Pro
|Schalter
|4
|
|4
|
|-
|Shelly i3
|Digitale Eingänge
|
|
|3 Digital
|
|-
|Shelly EM
|Leistungsmessung
|1
|
|2
|
|-
|'''[[Shelly 3EM]]'''
|Leistungsmessung
|1
|
|3
|
|-
|'''[[Shelly Uni]]'''
|WLAN Sensoreingang
|2
|
|
|1-Wire, 2 potentialfreie Relaisausgänge
|-
|Shelly Plug, Shelly Plug S
|Schalter mit Leistungsmessung
|1
|
|1
|1 Taster
|-
|Shelly RGBW2
|Dimmer
|4
|1 / 4
|1 / 4
|RGBW Controller
|-
|Shelly Dimmer2
|Dimmer
|
|1
|1
|
|-
|Shelly Duo
|Leuchte
|1
|1
|
|E27 oder GU10 Fassung
|-
|Shelly Vintage
|Leuchte
|1
|1
|
|
|-
|Shelly Bulb
|Leuchte
|1
|1
|
|
|-
! colspan="6" |'''Shelly Plus'''
|-
|Shelly Plus 1
|Schalter
|1
|
|
|-
|'''[[Shelly Plus 1PM]]'''
|Schalter mit Leistungsmessung
|1
|
|1
|-
|'''[[Shelly Plus 2PM]]'''
|Schalter mit Leistungsmessung
|2
|
|2
|-
|Shelly Plus i4
|Digitale Eingänge
|
|
|4 Digital
|AC und DC - Variante
|-
|Shelly Plus Plug S
|Schalter
|1
|
|1
|1 Taster;
Varianten V1, V2
|-
|Shelly Plus Uni
|WLAN Sensoreingang
|2
|
|
|1-Wire, 2 potentialfreie Relaisausgänge; Neu in 2024
|-
|Shelly Plus 0-10V Dimmer
|Dimmer
|
|1
|1
|0-10 V DC Ausgang
|-
|Shelly Plus RGBW
|Dimmer
|4
|1 / 4
|1 /4
|RGBW Controller
|-
! colspan="6" |'''Shelly Plus Mini'''
|-
|Shelly Plus 1 Mini
|Schalter
|1
|
|
|
|-
|Shelly Plus 1PM Mini
|Schalter mit Leistungsmessung
|1
|
|1
|
|-
|Shelly PM Mini
|Leistungsmessung
|
|
|1
|
|-
! colspan="6" |'''Shelly Pro'''
|-
|Shelly Pro 1
|Schalter
|1
|
|
|
|-
|Shelly Pro 1PM
|Schalter mit Leistungsmessung
|1
|
|1
|
|-
|Shelly Pro 2
|Schalter
|2
|
|
|
|-
|Shelly Pro 2PM
|Schalter mit Leistungsmessung
|2
|
|2
|
|-
|Shelly Pro Dual
|Schalter
|4
|
|
|2 Rolladenaktoren
|-
|Shelly Pro Dimmer 1PM
|Dimmer
|
|1
|1
|
|-
|Shelly Pro Dimmer 2PM
|Dimmer
|
|2
|2
|
|-
|Shelly Pro 3
|Schalter
|3
|
|
|
|-
|Shelly Pro 3EM
|Leistungsmessung
|
|
|
|
|-
|Shelly Pro EM50
|Leistungsmessung
|
|
|
|
|-
|Shelly Pro 4PM
|Schalter mit Leistungsmessung
|4
|
|4
|
|-
! colspan="6" |'''Shelly Gen3'''
|-
|Shelly 1 Gen3
|Schalter
|1
|
|
|
|-
|Shell 1PM Gen3
|Schalter mit Leistungsmessung
|1
|
|1
|
|-
|Shelly i4 Gne3
|Digitale Eingänge
|
|
|4 Digital
|
|-
|Shelly Dimmer 0/1-10V Gen3
|Dimmer
|
|1
|1
|0-10V DC oder
1-10V DC Ausgang
|-
! colspan="6" |'''Shelly Gen 3 Mini'''
|-
|Shelly 1 Mini Gen3
|Schalter
|1
|
|
|
|-
|Shelly 1PM Mini Gen3
|Schalter mit Leistungsmessung
|1
|
|1
|
|-
|Shelly PM Mini Gen3
|Leistungsmessung
|
|
|1
|
|-
| colspan="6" |'''Control Panels'''
|-
|Shelly Wall Display
|Control Panel
|1
|
|
|
|}

==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
:<code>shelly1-..., shellyswitch-..., shelly4pro-..., </code>
*'''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
**Shelly ins häusliche WLAN anmelden (mit fester IP-Adresse <shelly-ip> natürlich...)
**Internen Access Point abschalten (kann auch nach dem nächsten Schritt oder noch später erfolgen)
**Testen: '''Laptop''' wieder mit dem häuslichen WLAN verbinden, und im Browser die Adresse <shelly-ip> aufrufen
*In FHEM definieren
:<code>define myShelly Shelly <shelly-ip></code>
*Das Modul setzt bei bekannten Geräten das Attribut <code>model</code> automatisch. Bei nicht unterstützten Geräten wird das Attribut auf den Wert <code>generic</code> gesetzt. In diesen Fällen kann das Attribut <code>model</code> auf der Detailseite des Devices manuell gesetzt werden:
:<code> attr myShelly model shellyrgbw|shellydimmer|shelly2.5|shelly2|shellyem|shelly3em|shelly4|shellyplug|shelly1|shellybulb|shelly1pm|shellyuni|generic</code>

Falls es sich um einen Shelly2 oder 2.5 handelt, muss ferner das Attribut <code>mode</code> 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 <code>interval</code> 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:
:<code>http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=set%20<name>%20out_on</code>
hierbei sind:
:<code><FHEM-IP></code> die IP-Adresse des Servers auf dem FHEM läuft
:<code><Port></code> die Port-Nummer
:<code><name></code> der Name des FHEM-Devices
:<code>%20</code> stellt ein Leerzeichen dar

Beispiel 2: Eingang eines Shelly2 wird betätigt:
<syntaxhighlight lang="html">http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=set%20<name>%20input_on%20<ch></syntaxhighlight>
:<code><ch></code> die Nummer des Schaltkanals (Nummer des Eingangs), z.B. <code>0</code> oder <code>1</code>

Beispiel 3: Eingang1 eines ShellyDimmers wird betätigt:
<syntaxhighlight lang="html">http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=set%20<name>%20short_push<nowiki/>%20<inp></syntaxhighlight>
:<code><nowiki><inp></nowiki></code> Nummer des Eingangs, 0 oder 1 (ShellyDimmer verfügen je Schaltkanal über zwei Eingänge)

Beispiel 4: Wirkleistung eines ShellyPro3EM:
<syntaxhighlight lang="html">http://<FHEM-IP>:<Port>/fhem?XHR=1&fwcsrf=csrf_368985985592099&cmd=set%20Y173%20Active_Power_$phase%20$active_power</syntaxhighlight>
:<code>fwcsrf=csrf_368985985592099</code> das CSRF-Token (FHEMWeb)
:<code>$phase</code> wird vom Shelly durch a, b oder c ersetzt
:<code>$active_power</code> wird vom Shelly durch die aktuelle Wirkleistung ersetzt

'''Endpoints'''

In vorstehenden Beispielen stellt der Teil <code>set%20<name>%20<cmd></code> den Endpoint dar, d.h. dies ist der Befehl, der vom Shelly-Device in FHEM verarbeitet werden muss.

=====Liste der Befehle der Set-Endpoints:=====
{| class="wikitable sortable mw-collapsible"
|+
!<cmd>
!Wert
!Reading
!Erläuterung
!Geräte
|-
|<code>out_on</code>
|
| rowspan="2" |<code>relay_<ch></code><code>state</code>
|Ausgang ein
| rowspan="2" |alle Shelly mit Relaisausgang
ShellyBulb
ShellyRGBW
|-
|<code>out_off</code>
|
|Ausgang aus
|-
|<code>button_on</code>
|
| rowspan="2" |<code>button_<ch></code>
|Eingang ein
| rowspan="2" |ShellyPlug
ShellyPlugS
|-
|<code>button_off</code>
|
|Eingang aus
|-
|<code>input_on</code>
|
| rowspan="2" |<code>input_<ch></code>
|Eingang ein
| rowspan="2" |alle Shelly mit HW-Eingang, aber nicht Shelly-I-Geräte
|-
|<code>input_off</code>
|
|Eingang aus
|-
|<code>input_on</code>
|
| rowspan="4" |<code>input_<inp></code>
|Eingang ein
| rowspan="4" |ShellyDimmer
|-
|<code>input_off</code>
|
|Eingang aus
|-
|<code>short_push</code>
|
|kurzer Tastendruck
|-
|<code>long_push</code>
|
|langer Tastendruck
|-
|<code>single_push</code>
|
| rowspan="6" |<code>input_<ch></code><code>input_<ch>_action</code>
|kurzer Tastendruck
| rowspan="4" |ShellyI3
ShellyI4
|-
|<code>long_push</code>
|
|langer Tastendruck
|-
|<code>double_push</code>
|
|zweifacher Tastendruck
|-
|<code>triple_push</code>
|
|dreifacher Tastendruck
|-
|<code>short_long_push</code>
|
|Tastersequenz lang-kurz
| rowspan="2" |ShellyI3
|-
|<code>long_short_push</code>
|
|Tastersequenz kurz-lang
|-
|<code>stopped</code>
|
| rowspan="5" |<code>state</code>
|Rollo angehalten
| rowspan="5" |Shelly2/2.5/Plus2/Pro2 mode=roller
|-
|<code>opening</code>
|
|Rollo wird geöffnet
|-
|<code>closing</code>
|
|Rollo wird geschlossen
|-
|<code>is_open</code>
|
|Rollo offen (in oberer Endlage)
|-
|<code>is_closed</code>
|
|Rollo geschlossen (in unterer Endlage)
|-
|<code>temperature_over</code>
|
|<code>temperature_<ch>_range</code>
|Temperatur überschreitet eingestellten Grenzwert
| rowspan="5" |ShellyAddOn
|-
|<code>temperature_under</code>
|
|<code>temperature_<ch>_range</code>
|Temperatur unterschreitet eingestellten Grenzwert
|-
|<code>humidity_over</code>
|
|<code>humidity_<ch>_range</code>
|Luftfeuchtigkeit überschreitet eingestellten Grenzwert
|-
|<code>humidity_under</code>
|
|<code>humidity_<ch>_range</code>
|Luftfeuchtigkeit unterschreitet eingestellten Grenzwert
|-
|<code>tempC</code>
|<code>$temperature</code>
|<code>temperature</code>
|Temperatur in °C
|-
|<code>voltage_over</code>
|
| rowspan="2" |<code>voltage_range</code>
|Spannung überschreitet eingestellten Grenzwert
| rowspan="2" |ShellyUni
|-
|<code>voltage_under</code>
|
|Spannung unterschreitet eingestellten Grenzwert
|-
|Active_Power_$phase
|<code>$active_power</code>
|<code>Active_Power_<ph></code>
|Änderung Wirkleistung
| rowspan="3" |ShellyPro3EM
|-
|Voltage_$phase
|<code>$voltage</code>
|<code>Voltage_<ph></code>
|Änderung Spannung
|-
|Current_$phase
|<code>$current</code>
|<code>Current_<ph></code>
|Ä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 <code>notify</code> 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:
:<code>http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=get%20<name>%20status</code>

====Attribut webhook (derzeit nur Gen2)====
Durch Setzten des Attributes <code>webhook</code> 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 (<code>_</code>). 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 <code>webhook_cnt</code> zeigt die Anzahl aller auf dem Shelly hinterlegten Webhooks und <code>webhooks_ver</code> den Versionszähler des Shelly.

Eine Übersicht aller Actions/Webhooks eines Shelly bekommt man für Gen2-Geräte mit:
:<code>http://<ip-des-Shelly>/rpc/Webhook.List</code>

===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 ([[MQTT2-Module - Praxisbeispiele#Shelly|Praxisbeispiele zu den MQTT2-Modulen]]), für Anfänger ist das allerdings nicht unbedingt zu empfehlen.

==Links==
*Website des Herstellers der Geräte [www.shelly.com]

[[Kategorie:Energieverbrauchsmessung]]
[[Kategorie:MQTT]]
[[Kategorie:Bluetooth]]
[[Kategorie:Schalter (Empfänger)]]
[[Kategorie:Shelly]]

Modul Shelly

2023-12-07T19:24:30Z

Starkstrombastler:

{{Infobox Modul
|ModPurpose=Das Modul 36_Shelly.pm stellt ein Interface zur Bedienung von Shelly Devices zur Verfügung
|ModType=d

|ModCmdRef=Shelly
|ModForumArea=Sonstige Systeme
|ModFTopic=118446
|ModTechName=36_Shelly.pm
|ModOwner=Prof. Dr. Peter A. Henning
}}
Auf dieser Seite werden die Aktoren des bulgarischen Herstellers Allterco Robotics beschrieben ((Markenname Shelly) sowie deren Ansteuerung mit FHEM und aufgetretene Probleme. Für Supportanfragen bitte ''{{Link2Forum|Topic=118446.0|LinkText=diesen Forenthread}}'' verwenden. Einige der auf dieser Wiki-Seite erwähnten Geräte und Funktionen sind derzeit nur mit dieser {{Link2Forum|Topic=111905|Message=1285498|LinkText=Testversion}} verfügbar. Diese muss manuell installiert werden.
{{Baustelle}}
'''Achtung: Diese Seite ist teilweise veraltet, insbesondere unterstützt das Modul weitere Aktoren. Bitte Commandref lesen - diese Seite ist in Überarbeitung'''

Es handelt 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 ==
{| class="wikitable mw-datatable"
! style="width:50px" |Modell
! style="width:50px" |Typ
! style="width:20px" |Schaltkanäle
! style="width:20px" |Dimmkanäle
! style="width:20px" |Messkanäle
! style="width:650px" |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
|
|1 / 4
|1 / 4
|-
|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
|
|2
|
|
|
|}

== Einbindung in FHEM ==
*Schließen Sie den Aktor nach Vorschrift an
*Suchen Sie mit einem WLAN-fähigen Gerät (Laptop oder Smartphone) nach dem internen Access Point, der durch den Aktor erzeugt wird. Typischerweise hat dieser eine SSID ähnlich wie
:<code>shelly1-..., shellyswitch-..., shelly4pro-..., </code>
*Verbinden Sie Ihr Gerät mit diesem Access Point. Typischerweise bekommt Ihr Gerät dabei die IP-Adresse 192.168.33.2 zugewiesen.
*Im Browser dieses Gerätes einfach die IP-Adresse 192.168.33.1 aufrufen - das ist der Shelly selbst, in dieser Web-Oberfläche kann man alles konfigurieren.
**Internen Access Point abschalten
**Shelly ins häusliche WLAN anmelden. Mit fester IP-Adresse <shelly-ip> natürlich...
**Testen: Ihr Gerät wieder mit dem häuslichen WLAN verbinden, und im Browser die Adresse <shelly-ip> aufrufen
*In FHEM definieren
:<code>define myShelly Shelly <shelly-ip></code>
*Das Modul setzt bei bekannten Geräten das Attribut <code>model</code> automatisch. Bei nicht unterstützten Geräten wird das Attribut auf den Wert <code>generic</code> gesetzt. In diesen Fällen kann das Attribut <code>model</code>auf der Detailseite des Devices manuell gesetzt werden:
:<code> attr myShelly model shellyrgbw|shellydimmer|shelly2.5|shelly2|shellyem|shelly3em|shelly4|shellyplug|shelly1|shellybulb|shelly1pm|shellyuni|generic</code>

Falls es sich um einen Shelly2 oder 2.5 handelt, muss ferner das Attribut <code>mode</code> 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 <code>interval</code> 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, für Nicht-Experten) 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:
:<code>http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=set%20<name>%20out_on</code>
hierbei sind:
:<code><FHEM-IP></code> die IP-Adresse des Servers auf dem FHEM läuft
:<code><Port></code> die Port-Nummer
:<code><name></code> der Name des FHEM-Devices
:<code>%20</code> stellt ein Leerzeichen dar

Beispiel 2: Eingang eines Shelly2 wird betätigt:
<syntaxhighlight lang="html">http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=set%20<name>%20input_on%20<ch></syntaxhighlight>
:<code><ch></code> die Nummer des Schaltkanals (Nummer des Eingangs), z.B. <code>0</code> oder <code>1</code>

Beispiel 3: Eingang1 eines ShellyDimmers wird betätigt:</code>
<syntaxhighlight lang="html">http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=set%20<name>%20short_push<nowiki/>%20<inp></syntaxhighlight>
:<code><nowiki><inp></nowiki></code> Nummer des Eingangs, 0 oder 1 (ShellyDimmer verfügen je Schaltkanal über zwei Eingänge)

Beispiel 4: Wirkleistung eines ShellyPro3EM:
<syntaxhighlight lang="html">http://<FHEM-IP>:<Port>/fhem?XHR=1&fwcsrf=csrf_368985985592099&cmd=set%20Y173%20Active_Power_$phase%20$active_power</syntaxhighlight>
:<code>fwcsrf=csrf_368985985592099</code> das CSRF-Token (FHEMWeb)
:<code>$phase</code> wird vom Shelly durch a, b oder c ersetzt
:<code>$active_power</code> wird vom Shelly durch die aktuelle Wirkleistung ersetzt

'''Enpoints'''

In vorstehenden Beispielen stellt der Teil <code>set%20<name>%20<cmd></code> den Endpoint dar, d.h. dies ist der Befehl, der vom Shelly-Device in FHEM verarbeitet werden muss.

=====Liste der Befehle der Set-Endpoints:=====
{| class="wikitable sortable mw-collapsible"
|+
!<cmd>
!Wert
!Reading
!Erläuterung
!Geräte
|-
|<code>out_on</code>
|
| rowspan="2" |<code>relay_<ch></code><code>state</code>
|Ausgang ein
| rowspan="2" |alle Shelly mit Relaisausgang
ShellyBulb
ShellyRGBW
|-
|<code>out_off</code>
|
|Ausgang aus
|-
|<code>button_on</code>
|
| rowspan="2" |<code>button_<ch></code>
|Eingang ein
| rowspan="2" |ShellyPlug
ShellyPlugS
|-
|<code>button_off</code>
|
|Eingang aus
|-
|<code>input_on</code>
|
| rowspan="2" |<code>input_<ch></code>
|Eingang ein
| rowspan="2" |alle Shelly mit HW-Eingang, aber nicht Shelly-I-Geräte
|-
|<code>input_off</code>
|
|Eingang aus
|-
|<code>input_on</code>
|
| rowspan="4" |<code>input_<inp></code>
|Eingang ein
| rowspan="4" |ShellyDimmer
|-
|<code>input_off</code>
|
|Eingang aus
|-
|<code>short_push</code>
|
|kurzer Tastendruck
|-
|<code>long_push</code>
|
|langer Tastendruck
|-
|<code>single_push</code>
|
| rowspan="6" |<code>input_<ch></code><code>input_<ch>_action</code>
|kurzer Tastendruck
| rowspan="4" |ShellyI3
ShellyI4
|-
|<code>long_push</code>
|
|langer Tastendruck
|-
|<code>double_push</code>
|
|zweifacher Tastendruck
|-
|<code>triple_push</code>
|
|dreifacher Tastendruck
|-
|<code>short_long_push</code>
|
|Tastersequenz lang-kurz
| rowspan="2" |ShellyI3
|-
|<code>long_short_push</code>
|
|Tastersequenz kurz-lang
|-
|<code>stopped</code>
|
| rowspan="5" |<code>state</code>
|Rollo angehalten
| rowspan="5" |Shelly2/2.5/Plus2/Pro2 mode=roller
|-
|<code>opening</code>
|
|Rollo wird geöffnet
|-
|<code>closing</code>
|
|Rollo wird geschlossen
|-
|<code>is_open</code>
|
|Rollo offen (in oberer Endlage)
|-
|<code>is_closed</code>
|
|Rollo geschlossen (in unterer Endlage)
|-
|<code>temperature_over</code>
|
|<code>temperature_<ch>_range</code>
|Temperatur überschreitet eingestellten Grenzwert
| rowspan="5" |ShellyAddOn
|-
|<code>temperature_under</code>
|
|<code>temperature_<ch>_range</code>
|Temperatur unterschreitet eingestellten Grenzwert
|-
|<code>humidity_over</code>
|
|<code>humidity_<ch>_range</code>
|Luftfeuchtigkeit überschreitet eingestellten Grenzwert
|-
|<code>humidity_under</code>
|
|<code>humidity_<ch>_range</code>
|Luftfeuchtigkeit unterschreitet eingestellten Grenzwert
|-
|<code>tempC</code>
|<code>$temperature</code>
|<code>temperature</code>
|Temperatur in °C
|-
|<code>voltage_over</code>
|
| rowspan="2" |<code>voltage_range</code>
|Spannung überschreitet eingestellten Grenzwert
| rowspan="2" |ShellyUni
|-
| <code>voltage_under</code>
|
|Spannung unterschreitet eingestellten Grenzwert
|-
| Active_Power_$phase
|<code>$active_power</code>
|<code>Active_Power_<ph></code>
|Änderung Wirkleistung
| rowspan="3" |ShellyPro3EM
|-
|Voltage_$phase
|<code>$voltage</code>
|<code>Voltage_<ph></code>
|Änderung Spannung
|-
|Current_$phase
|<code>$current</code>
|<code>Current_<ph></code>
|Änderung Strom
|}
Bei Eintreffen eines Set-Endpoints wird im Shelly-Device das zugeordnete Reading entsprechend gesetzt. Damit kann das Shelly-Ereigniss z.B. mit einem <code>notify</code> 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: <code>http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=get%20<name>%20status</code>

====Attribut webhook (derzeit nur Gen2)====
Durch Setzten des Attributes <code>webhook</code> 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 Csfr-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 (<code>_</code>). 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 <code>webhook_cnt</code> zeigt die Anzahl aller auf dem Shelly hinterlegten Webhooks und <code>webhooks_ver</code> den Versionszähler des Shelly.

Eine Übersicht aller Actions/Webhooks eines Shelly bekommt man für Gen2-Geräte mit:

<code>http://<ip-des-Shelly>/rpc/Webhook.List</code>

===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 ([[MQTT2-Module - Praxisbeispiele#Shelly|Praxisbeispiele zu den MQTT2-Modulen]]), für Anfänger ist das allerdings nicht unbedingt zu empfehlen.

Modul Shelly

2023-09-30T16:20:41Z

Starkstrombastler: Hinweis auf Testversion. Geräteübersicht ergänzt, Hinweis zu Attribut model

{{Infobox Modul
|ModPurpose=Das Modul 36_Shelly.pm stellt ein Interface zur Bedienung von Shelly Devices zur Verfügung
|ModType=d

|ModCmdRef=Shelly
|ModForumArea=Sonstige Systeme
|ModFTopic=118446
|ModTechName=36_Shelly.pm
|ModOwner=Prof. Dr. Peter A. Henning
}}
Auf dieser Seite werden die Aktoren des bulgarischen Herstellers Allterco Robotics beschrieben ((Markenname Shelly) sowie deren Ansteuerung mit FHEM und aufgetretene Probleme. Für Supportanfragen bitte ''{{Link2Forum|Topic=118446.0|LinkText=diesen Forenthread}}'' verwenden. Einige der auf dieser Wiki-Seite erwähnten Geräte und Funktionen sind derzeit nur mit dieser [https://forum.fhem.de/index.php?topic=111905.msg1285498#msg1285498 Testversion] verfügbar. Diese muss manuell installiert werden.
{{Baustelle}}
'''Achtung: Diese Seite ist teilweise veraltet, insbesondere unterstützt das Modul weitere Aktoren. Bitte Commandref lesen - diese Seite ist in Überarbeitung'''

Es handelt 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 ==
{| class="wikitable mw-datatable"
! style="width:50px" |Modell
! style="width:50px" |Typ
! style="width:20px" |Schaltkanäle
! style="width:20px" |Dimmkanäle
! style="width:20px" |Messkanäle
! style="width:650px" |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
|
|1 / 4
|1 / 4
|-
|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
|
|2
|
|
|
|}

== Einbindung in FHEM ==
*Schließen Sie den Aktor nach Vorschrift an
*Suchen Sie mit einem WLAN-fähigen Gerät (Laptop oder Smartphone) nach dem internen Access Point, der durch den Aktor erzeugt wird. Typischerweise hat dieser eine SSID ähnlich wie
:<code>shelly1-..., shellyswitch-..., shelly4pro-..., </code>
*Verbinden Sie Ihr Gerät mit diesem Access Point. Typischerweise bekommt Ihr Gerät dabei die IP-Adresse 192.168.33.2 zugewiesen.
*Im Browser dieses Gerätes einfach die IP-Adresse 192.168.33.1 aufrufen - das ist der Shelly selbst, in dieser Web-Oberfläche kann man alles konfigurieren.
**Internen Access Point abschalten
**Shelly ins häusliche WLAN anmelden. Mit fester IP-Adresse <shelly-ip> natürlich...
**Testen: Ihr Gerät wieder mit dem häuslichen WLAN verbinden, und im Browser die Adresse <shelly-ip> aufrufen
*In FHEM definieren
:<code>define myShelly Shelly <shelly-ip></code>
*Das Modul setzt bei bekannten Geräten das Attribut <code>model</code> automatisch. Bei nicht unterstützten Geräten wird das Attribut auf den Wert <code>generic</code> gesetzt. In diesen Fällen kann das Attribut <code>model</code>auf der Detailseite des Devices manuell gesetzt werden:
:<code> attr myShelly model shellyrgbw|shellydimmer|shelly2.5|shelly2|shellyem|shelly3em|shelly4|shellyplug|shelly1|shellybulb|shelly1pm|shellyuni|generic</code>

Falls es sich um einen Shelly2 oder 2.5 handelt, muss ferner das Attribut <code>mode</code> 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 <code>interval</code> 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, für Nicht-Experten) 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:
:<code>http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=set%20<name>%20out_on</code>
hierbei sind:
:<code><FHEM-IP></code> die IP-Adresse des Servers auf dem FHEM läuft
:<code><Port></code> die Port-Nummer
:<code><name></code> der Name des FHEM-Devices
:<code>%20</code> stellt ein Leerzeichen dar

Beispiel 2: Eingang eines Shelly2 wird betätigt:
<syntaxhighlight lang="html">http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=set%20<name>%20input_on%20<ch></syntaxhighlight>
:<code><ch></code> die Nummer des Schaltkanals (Nummer des Eingangs), z.B. <code>0</code> oder <code>1</code>

Beispiel 3: Eingang1 eines ShellyDimmers wird betätigt:</code>
<syntaxhighlight lang="html">http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=set%20<name>%20short_push<nowiki/>%20<inp></syntaxhighlight>
:<code><nowiki><inp></nowiki></code> Nummer des Eingangs, 0 oder 1 (ShellyDimmer verfügen je Schaltkanal über zwei Eingänge)

Beispiel 4: Wirkleistung eines ShellyPro3EM:
<syntaxhighlight lang="html">http://<FHEM-IP>:<Port>/fhem?XHR=1&fwcsrf=csrf_368985985592099&cmd=set%20Y173%20Active_Power_$phase%20$active_power</syntaxhighlight>
:<code>fwcsrf=csrf_368985985592099</code> das CSRF-Token (FHEMWeb)
:<code>$phase</code> wird vom Shelly durch a, b oder c ersetzt
:<code>$active_power</code> wird vom Shelly durch die aktuelle Wirkleistung ersetzt

'''Enpoints'''

In vorstehenden Beispielen stellt der Teil <code>set%20<name>%20<cmd></code> den Endpoint dar, d.h. dies ist der Befehl, der vom Shelly-Device in FHEM verarbeitet werden muss.

=====Liste der Befehle der Set-Endpoints:=====
{| class="wikitable sortable mw-collapsible"
|+
!<cmd>
!Wert
!Reading
!Erläuterung
!Geräte
|-
|<code>out_on</code>
|
| rowspan="2" |<code>relay_<ch></code><code>state</code>
|Ausgang ein
| rowspan="2" |alle Shelly mit Relaisausgang
ShellyBulb
ShellyRGBW
|-
|<code>out_off</code>
|
|Ausgang aus
|-
|<code>button_on</code>
|
| rowspan="2" |<code>button_<ch></code>
|Eingang ein
| rowspan="2" |ShellyPlug
ShellyPlugS
|-
|<code>button_off</code>
|
|Eingang aus
|-
|<code>input_on</code>
|
| rowspan="2" |<code>input_<ch></code>
|Eingang ein
| rowspan="2" |alle Shelly mit HW-Eingang, aber nicht Shelly-I-Geräte
|-
|<code>input_off</code>
|
|Eingang aus
|-
|<code>input_on</code>
|
| rowspan="4" |<code>input_<inp></code>
|Eingang ein
| rowspan="4" |ShellyDimmer
|-
|<code>input_off</code>
|
|Eingang aus
|-
|<code>short_push</code>
|
|kurzer Tastendruck
|-
|<code>long_push</code>
|
|langer Tastendruck
|-
|<code>single_push</code>
|
| rowspan="6" |<code>input_<ch></code><code>input_<ch>_action</code>
|kurzer Tastendruck
| rowspan="4" |ShellyI3
ShellyI4
|-
|<code>long_push</code>
|
|langer Tastendruck
|-
|<code>double_push</code>
|
|zweifacher Tastendruck
|-
|<code>triple_push</code>
|
|dreifacher Tastendruck
|-
|<code>short_long_push</code>
|
|Tastersequenz lang-kurz
| rowspan="2" |ShellyI3
|-
|<code>long_short_push</code>
|
|Tastersequenz kurz-lang
|-
|<code>stopped</code>
|
| rowspan="5" |<code>state</code>
|Rollo angehalten
| rowspan="5" |Shelly2/2.5/Plus2/Pro2 mode=roller
|-
|<code>opening</code>
|
|Rollo wird geöffnet
|-
|<code>closing</code>
|
|Rollo wird geschlossen
|-
|<code>is_open</code>
|
|Rollo offen (in oberer Endlage)
|-
|<code>is_closed</code>
|
|Rollo geschlossen (in unterer Endlage)
|-
| <code>temperature*</code>
|
|<code>temperature_<ch>_range</code>
|Temperatur
| rowspan="2" |ShellyAddOn
|-
|<code>humidity*</code>
|
|<code>humidity_<ch>_range</code>
|Luftfeuchtigkeit
|-
|<code>voltage_over</code>
|
| rowspan="2" |<code>voltage_range</code>
|Spannung unterschreitet eingestellten Grenzwert
| rowspan="2" |ShellyUni
|-
| <code>voltage_under</code>
|
|Spannung überschreitet eingestellten Grenzwert
|-
| Active_Power_$phase
|<code>$active_power</code>
|<code>Active_Power_<ph></code>
|Änderung Wirkleistung
| rowspan="3" |ShellyPro3EM
|-
|Voltage_$phase
|<code>$voltage</code>
|<code>Voltage_<ph></code>
|Änderung Spannung
|-
|Current_$phase
|<code>$current</code>
|<code>Current_<ph></code>
|Änderung Strom
|}
Bei Eintreffen eines Set-Endpoints wird im Shelly-Device das zugeordnete Reading entsprechend gesetzt. Damit kann das Shelly-Ereigniss z.B. mit einem <code>notify</code> 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: <code>http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=get%20<name>%20status</code>

====Attribut webhook (derzeit nur Gen2)====
Durch Setzten des Attributes <code>webhook</code> 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 Csfr-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 (<code>_</code>). 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 <code>webhook_cnt</code> zeigt die Anzahl aller auf dem Shelly hinterlegten Webhooks und <code>webhooks_ver</code> den Versionszähler des Shelly.

Eine Übersicht aller Actions/Webhooks eines Shelly bekommt man für Gen2-Geräte mit:

<code>http://<ip-des-Shelly>/rpc/Webhook.List</code>

===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 ([[MQTT2-Module - Praxisbeispiele#Shelly|Praxisbeispiele zu den MQTT2-Modulen]]), für Anfänger ist das allerdings nicht unbedingt zu empfehlen.

Modul Shelly

2023-08-23T09:38:09Z

Starkstrombastler: Abschnitt Actions/Webhooks überarbeitet

{{Infobox Modul
|ModPurpose=Das Modul 36_Shelly.pm stellt ein Interface zur Bedienung von Shelly Devices zur Verfügung
|ModType=d

|ModCmdRef=Shelly
|ModForumArea=Sonstige Systeme
|ModFTopic=118446
|ModTechName=36_Shelly.pm
|ModOwner=Prof. Dr. Peter A. Henning
}}
Auf dieser Seite werden die Aktoren des bulgarischen Herstellers Allterco Robotics beschrieben ((Markenname Shelly) sowie deren Ansteuerung mit FHEM und aufgetretene Probleme.
Für Supportanfragen bitte ''{{Link2Forum|Topic=118446.0|LinkText=diesen Forenthread}}'' verwenden.
{{Baustelle}}
'''Achtung: Diese Seite ist teilweise veraltet, insbesondere unterstützt das Modul weitere Aktoren. Bitte Commandref lesen - diese Seite ist in Überarbeitung'''

Es handelt 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 ==
{| class="wikitable mw-datatable"
! style="width:50px" |Modell
! style="width:50px" |Typ
! style="width:20px" |Schaltkanäle
! style="width:20px" |Dimmkanäle
! style="width:20px" |Messkanäle
! style="width:650px" |Bemerkungen
|-
|Shelly1
|Schalter
|1
|
|
|-
|Shelly1PM
|Schalter mit Leistungsmessung
|1
|
|1
|-
|ShellyPlug, ShellyPlugS
|Schalter mit Leistungsmessung
|1
|
|1
|-
|ShellyEM
|Leistungsmessung
|1
|
|2
|-
|Shelly2
|Schalter/Rollladenaktor
|2/1
|
|1
|-
|Shelly2.5
|Schalter/Rollladenaktor
|2/1
|
|2
|-
|Shelly4Pro
|Schalter
|4
|
|4
|-
|ShellyRGBW
|Dimmer
|
|4
|1
|-
|ShellyDimmer
|Dimmer
|
|1
|1
|}

== Einbindung in FHEM ==
*Schließen Sie den Aktor nach Vorschrift an
*Suchen Sie mit einem WLAN-fähigen Gerät (Laptop oder Smartphone) nach dem internen Access Point, der durch den Aktor erzeugt wird. Typischerweise hat dieser eine SSID ähnlich wie
shelly1-..., shellyswitch-..., shelly4pro-...,
*Verbinden Sie Ihr Gerät mit diesem Access Point. Typischerweise bekommt Ihr Gerät dabei die IP-Adresse 192.168.33.2 zugewiesen.
*Im Browser dieses Gerätes einfach die IP-Adresse 192.168.33.1 aufrufen - das ist der Shelly selbst, in dieser Web-Oberfläche kann man alles konfigurieren.
**Internen Access Point abschalten
**Shelly ins häusliche WLAN anmelden. Mit fester IP-Adresse <shelly-ip> natürlich...
**Testen: Ihr Gerät wieder mit dem häuslichen WLAN verbinden, und im Browser die Adresse <shelly-ip> aufrufen
*In FHEM definieren
define myShelly Shelly <shelly-ip>
*Auf der Detailseite des Devices muss unbedingt noch das Attribut <code>model</code> gesetzt werden:
attr myShelly model shellyrgbw|shellydimmer|shelly2.5|generic|shelly2|shellyem|shelly4|shellyplug|shelly1|shellybulb|shelly1pm|shellyuni
Falls es sich um einen Shelly2 oder 2.5 handelt, muss ferner das Attribut <code>mode</code> 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 <code>interval</code> 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, für Nicht-Experten) 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 bestiimmter 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: <code>http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=set%20<name>%20out_on</code>

hierbei sind: <code><FHEM-IP></code> die IP-Adresse des Servers auf dem FHEM läuft

<code><Port></code> die Port-Nummer

<code><name></code> der Name des FHEM-Devices

<code>%20</code> stellt ein Leerzeichen dar

Beispiel 2: Eingang eines Shelly2 wird betätigt:

<code>http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=set%20<name>%20input_on%20<ch></code>

<code><ch></code> die Nummer des Schaltkanals (Nummer des Eingangs), z.B. <code>0</code> oder <code>1</code>

<code>Beispiel 3: Eingang1 eines ShellyDimmers wird betätigt:</code>

<code>http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=set%20<name>%20short_push<nowiki/>%20<inp></code>

<code><inp> Nummer des Eingangs, 0 oder 1 (ShellyDimmer verfügen je Schaltkanal über zwei Eingänge)</code>

Beispiel 4: Wirkleistung eines ShellyPro3EM: <code>http://<FHEM-IP>:<Port>/fhem?XHR=1&fwcsrf=csrf_368985985592099&cmd=set%20Y173%20Active_Power_$phase%20$active_power</code>

<code>fwcsrf=csrf_368985985592099 das CSRF-Token (FHEMWeb)</code>

<code>$phase</code> wird vom Shelly durch a, b oder c ersetzt

<code>$active_power wird vom Shelly durch die aktuelle Wirkleistung ersetzt</code>

Enpoints

In vorstehenden Beispielen stellt der Teil <code>set%20<name>%20<cmd></code> den Endpoint dar, d.h. dies ist der Befehl der vom Shelly-Device in FHEM verarbeitet werden muss.

=====Liste der Befehle der Set-Endpoints:=====
{| class="wikitable sortable mw-collapsible"
|+
!<cmd>
!Wert
!Reading
!Erläuterung
!Geräte
|-
|<code>out_on</code>
|
| rowspan="2" |<code>relay_<ch></code><code>state</code>
|Ausgang ein
| rowspan="2" |alle Shelly mit Relaisausgang
ShellyBulb
ShellyRGBW
|-
|<code>out_off</code>
|
|Ausgang aus
|-
|<code>button_on</code>
|
| rowspan="2" |<code>button_<ch></code>
|Eingang ein
| rowspan="2" |ShellyPlug
ShellyPlugS
|-
|<code>button_off</code>
|
|Eingang aus
|-
|<code>input_on</code>
|
| rowspan="2" |<code>input_<ch></code>
|Eingang ein
| rowspan="2" |alle Shelly mit HW-Eingang, aber nicht Shelly-I-Geräte
|-
|<code>input_off</code>
|
|Eingang aus
|-
|<code>input_on</code>
|
| rowspan="4" |<code>input_<inp></code>
|Eingang ein
| rowspan="4" |ShellyDimmer
|-
|<code>input_off</code>
|
|Eingang aus
|-
|<code>short_push</code>
|
|kurzer Tastendruck
|-
|<code>long_push</code>
|
|langer Tastendruck
|-
|<code>single_push</code>
|
| rowspan="6" |<code>input_<ch></code><code>input_<ch>_action</code>
|kurzer Tastendruck
| rowspan="4" |ShellyI3
ShellyI4
|-
|<code>long_push</code>
|
|langer Tastendruck
|-
|<code>double_push</code>
|
|zweifacher Tastendruck
|-
|<code>triple_push</code>
|
|dreifacher Tastendruck
|-
|<code>short_long_push</code>
|
|Tastersequenz lang-kurz
| rowspan="2" |ShellyI3
|-
|<code>long_short_push</code>
|
|Tastersequenz kurz-lang
|-
|<code>stopped</code>
|
| rowspan="5" |<code>state</code>
|Rollo angehalten
| rowspan="5" |Shelly2/2.5/Plus2/Pro2 mode=roller
|-
|<code>opening</code>
|
|Rollo wird geöffnet
|-
|<code>closing</code>
|
|Rollo wird geschlossen
|-
|<code>is_open</code>
|
|Rollo offen (in oberer Endlage)
|-
|<code>is_closed</code>
|
|Rollo geschlossen (in unterer Endlage)
|-
| <code>temperature*</code>
|
|<code>temperature_<ch>_range</code>
|Temperatur
| rowspan="2" |ShellyAddOn
|-
|<code>humidity*</code>
|
|<code>humidity_<ch>_range</code>
|Luftfeuchtigkeit
|-
|<code>voltage_over</code>
|
| rowspan="2" |<code>voltage_range</code>
|Spannung unterschreitet eingestellten Grenzwert
| rowspan="2" |ShellyUni
|-
| <code>voltage_under</code>
|
|Spannung überschreitet eingestellten Grenzwert
|-
| Active_Power_$phase
|<code>$active_power</code>
|<code>Active_Power_<ph></code>
|Änderung Wirkleistung
| rowspan="3" |ShellyPro3EM
|-
|Voltage_$phase
|<code>$voltage</code>
|<code>Voltage_<ph></code>
|Änderung Spannung
|-
|Current_$phase
|<code>$current</code>
|<code>Current_<ph></code>
|Änderung Strom
|}
Bei Eintreffen eines Set-Endpoints wird im Shelly-Device das zugeordnete Reading entsprechend gesetzt. Damit kann das Shelly-Ereigniss z.B. mit einem <code>notify</code> 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: <code>http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=get%20<name>%20status</code>

====Attribut webhook (derzeit nur Gen2)====
Durch Setzten des Attributes <code>webhook</code> 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 Csfr-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 (<code>_</code>). 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 <code>webhook_cnt</code> zeigt die Anzahl aller auf dem Shelly hinterlegten Webhooks und <code>webhooks_ver</code> den Versionszähler des Shelly.

Eine Übersicht aller Actions/Webhooks eines Shelly bekommt man für Gen2-Geräte mit:

<code>http://<ip-des-Shelly>/rpc/Webhook.List</code>

===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 ([[MQTT2-Module - Praxisbeispiele#Shelly|Praxisbeispiele zu den MQTT2-Modulen]]), für Anfänger ist das allerdings nicht unbedingt zu empfehlen.

Modul Shelly

2023-08-22T16:49:29Z

Starkstrombastler: Abschnitt Actions/Webhooks eingefügt

{{Infobox Modul
|ModPurpose=Das Modul 36_Shelly.pm stellt ein Interface zur Bedienung von Shelly Devices zur Verfügung
|ModType=d

|ModCmdRef=Shelly
|ModForumArea=Sonstige Systeme
|ModFTopic=118446
|ModTechName=36_Shelly.pm
|ModOwner=Prof. Dr. Peter A. Henning
}}
Auf dieser Seite werden die Aktoren des bulgarischen Herstellers Allterco Robotics beschrieben ((Markenname Shelly) sowie deren Ansteuerung mit FHEM und aufgetretene Probleme.
Für Supportanfragen bitte ''{{Link2Forum|Topic=118446.0|LinkText=diesen Forenthread}}'' verwenden.
{{Baustelle}}
'''Achtung: Diese Seite ist teilweise veraltet, insbesondere unterstützt das Modul weitere Aktoren. Bitte Commandref lesen - diese Seite ist in Überarbeitung'''

Es handelt 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 ==
{| class="wikitable mw-datatable"
! style="width:50px" |Modell
! style="width:50px" |Typ
! style="width:20px" |Schaltkanäle
! style="width:20px" |Dimmkanäle
! style="width:20px" |Messkanäle
! style="width:650px" |Bemerkungen
|-
|Shelly1
|Schalter
|1
|
|
|-
|Shelly1PM
|Schalter mit Leistungsmessung
|1
|
|1
|-
|ShellyPlug, ShellyPlugS
|Schalter mit Leistungsmessung
|1
|
|1
|-
|ShellyEM
|Leistungsmessung
|1
|
|2
|-
|Shelly2
|Schalter/Rollladenaktor
|2/1
|
|1
|-
|Shelly2.5
|Schalter/Rollladenaktor
|2/1
|
|2
|-
|Shelly4Pro
|Schalter
|4
|
|4
|-
|ShellyRGBW
|Dimmer
|
|4
|1
|-
|ShellyDimmer
|Dimmer
|
|1
|1
|}

== Einbindung in FHEM ==
*Schließen Sie den Aktor nach Vorschrift an
*Suchen Sie mit einem WLAN-fähigen Gerät (Laptop oder Smartphone) nach dem internen Access Point, der durch den Aktor erzeugt wird. Typischerweise hat dieser eine SSID ähnlich wie
shelly1-..., shellyswitch-..., shelly4pro-...,
*Verbinden Sie Ihr Gerät mit diesem Access Point. Typischerweise bekommt Ihr Gerät dabei die IP-Adresse 192.168.33.2 zugewiesen.
*Im Browser dieses Gerätes einfach die IP-Adresse 192.168.33.1 aufrufen - das ist der Shelly selbst, in dieser Web-Oberfläche kann man alles konfigurieren.
**Internen Access Point abschalten
**Shelly ins häusliche WLAN anmelden. Mit fester IP-Adresse <shelly-ip> natürlich...
**Testen: Ihr Gerät wieder mit dem häuslichen WLAN verbinden, und im Browser die Adresse <shelly-ip> aufrufen
*In FHEM definieren
define myShelly Shelly <shelly-ip>
*Auf der Detailseite des Devices muss unbedingt noch das Attribut <code>model</code> gesetzt werden:
attr myShelly model shellyrgbw|shellydimmer|shelly2.5|generic|shelly2|shellyem|shelly4|shellyplug|shelly1|shellybulb|shelly1pm|shellyuni
Falls es sich um einen Shelly2 oder 2.5 handelt, muss ferner das Attribut <code>mode</code> 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 <code>interval</code> 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, für Nicht-Experten) 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 bestiimmter 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: <code>http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=set%20<name>%20out_on</code>

hierbei sind: <code><FHEM-IP></code> die IP-Adresse des Servers auf dem FHEM läuft

<code><Port></code> die Port-Nummer

<code><name></code> der Name des FHEM-Devices

<code>%20</code> stellt ein Leerzeichen dar

Beispiel 2: Eingang eines Shelly2 wird betätigt:

<code>http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=set%20<name>%20button_on%20<ch></code>

<code><ch></code> die Nummer des Eingangs, z.B. <code>0</code> oder <code>1</code>

Beispiel 3: Wirkleistung eines ShellyPro3EM: <code>http://<FHEM-IP>:<Port>/fhem?XHR=1&fwcsrf=csrf_368985985592099&cmd=set%20Y173%20Active_Power_$phase%20$active_power</code>

<code>fwcsrf=csrf_368985985592099 das CSRF-Token (FHEMWeb)</code>

<code>$phase</code> wird vom Shelly durch a, b oder c ersetzt

<code>$active_power wird vom Shelly durch die aktuelle Wirkleistung ersetzt</code>

Enpoints

In vorstehenden Beispielen stellt der Teil <code>set%20<name>%20<cmd></code> den Endpoint dar, d.h. dies ist der Befehl der vom Shelly-Device in FHEM verarbeitet werden muss.

===== Liste der Befehle der Set-Endpoints: =====
{| class="wikitable sortable mw-collapsible"
|+
!<cmd>
!Wert
!
!Erläuterung
|-
|<code>out_on</code>
|
|
|Ausgang ein
|-
|<code>out_off</code>
|
|
|Ausgang aus
|-
|<code>button_on</code>
|
|
|Eingang ein
|-
|<code>button_off</code>
|
|
|Eingang aus
|-
|<code>input_on</code>
|
|
|Eingang ein
|-
|<code>input_off</code>
|
|
|Eingan aus
|-
|<code>single_push</code>
|
|
|einfacher, kurzer Tastendruck
|-
|<code>long_push</code>
|
|
|langer Tastendruck
|-
|<code>double_push</code>
|
|
|zweifacher Tastendruck
|-
|<code>triple_push</code>
|
|
|dreifacher Tastendruck
|-
|<code>short_long_push</code>
|
|
|Tastersequenz lang-kurz
|-
|<code>long_short_push</code>
|
|
|Tastersequenz kurz-lang
|-
|<code>stopped</code>
|
|
|Rollo angehalten
|-
|<code>opening</code>
|
|
|Rollo wird geöffnet
|-
|<code>closing</code>
|
|
|Rollo wird geschlossen
|-
|<code>is_open</code>
|
|
|Rollo offen (in oberer Endlage)
|-
|<code>is_closed</code>
|
|
|Rollo geschlossen (in unterer Endlage)
|-
|<code>temperature*</code>
|
|
|Temperatur
|-
|<code>humidity*</code>
|
|
|Luftfeuchtigkeit
|-
|<code>voltage_over</code>
|
|
|Spannung unterschreitet eingestellten Grenzwert
|-
|<code>voltage_under</code>
|
|
|Spannung überschreitet eingestellten Grenzwert
|-
|Active_Power_$phase
|<code>$active_power</code>
|
|Wirkleistung
|-
|Voltage_$phase
|<code>$voltage</code>
|
|Spannung
|-
|Current_$phase
|<code>$current</code>
|
|Strom
|}
Bei Eintreffen eines Set-Endpoints wird im Shelly-Device ein Reading entsprechend gesetzt. Damit kann das Shelly-Ereigniss z.B. mit einem <code>notify</code> ausgewertet werden.

===== 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: <code>http://<FHEM-IP>:<Port>/fhem?XHR=1&cmd=get%20<name>%20status</code>

==== Attribut webhook (derzeit nur Gen2) ====
Durch Setzten des Attributes <code>webhook</code> werden auf dem Shelly einige Webhooks angelegt (auf der Shelly Oberfläche unter Actions zu sehen).

Das Reading <code>webhook_cnt</code> zeigt die Anzahl der auf dem Shelly hinterlegten Webhooks und <code>webhooks_ver</code> den Versionszähler des Shelly.

Eine Übersicht aller Actions/Webhooks eines Shelly bekommt man für Gen2-Geräte mit:

<code>http://<ip-des-Shelly>/rpc/Webhook.List</code>

=== 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 ([[MQTT2-Module - Praxisbeispiele#Shelly|Praxisbeispiele zu den MQTT2-Modulen]]), für Anfänger ist das allerdings nicht unbedingt zu empfehlen.