FHEMWiki - Benutzerbeiträge [de]

FHEM Connector für Amazon Alexa

2020-04-25T07:56:21Z

Suelle: Rechtschreibfehler korrigiert: hombridge -> homebridge

{{Baustelle}}
'''Alexa FHEMlazy''' war historisch ein Fork des Original [[Alexa-Fhem|alexa-fhem]], der im Januar 2019 mit dem Original zusammengeführt wurde und nun als '''FHEM Connector''' verfügbar ist.

Er ermöglicht innerhalb von Minuten die Verknüpfung von FHEM mit einem Amazon Echo Gerät. Auch Geräte anderer Hersteller mit verbauten Mikrofonen und Alexa-Sprachassistenten-Unterstützung sollten problemlos funktionieren. Für folgende Geräte ist dies bspw. der Fall (Falls Ihr andere/weitere Gerätemodelle bzw. Hersteller in Verwendung habt, bitte hier pflegen):

* SONOS Beam und SONOS One

Gegenüber dem klassischen Ansatz ergeben sich Einschränkungen, so läuft die Software normalerweise unter dem gleichen Benutzer wie FHEM auf dem gleichen Server, und es wird z.Zt. nur der Smarthome-Skill unterstützt (die Variante, bei der die Möglichkeiten der Interaktion von Amazon festgelegt wurden).
Dafür ist weder ein Developer-Account bei Amazon, eigene Lambda- und Skillfunktionen, noch das Öffnen eines eingehenden Ports aus dem Internet nötig.
* Die Software integriert einen Installer, der die Erstkonfiguration und Anmeldung übernimmt
* Die Kommunikation zur Software auf dem heimischen Rechner und dann zu FHEM verläuft über SSH und einen vom FHEM-Verein gehosteten Server
* Funktioniert mit IPv4, IPv6, echtem Dual Stack und DS-Lite
* Als Skill bei Amazon wird der Skill "FHEM Connector" verwendet.

Der Thread im Forum zur Software ist hier: {{Link2Forum|Topic=94817}}.

{{Infobox Modul
|ModPurpose=Einfache Anbindung von FHEM an Amazon Assistent Alexa
|ModType=h
|ModCmdRef=alexa
|ModTechName=39_alexa.pm / alexa-fhem
|ModForumArea=Frontends/Sprachsteuerung
|ModOwner=gvzdus, André/ justme1968 ({{Link2FU|430|Forum}} / [[Benutzer Diskussion:Justme|Wiki]])
}}

==Einführung==

===Arbeitsweise und Datenfluss===
Vorläufig ist alexa-fhem im "FHEM Connector-Modus" ein reiner [https://developer.amazon.com/de/docs/smarthome/understand-the-smart-home-skill-api.html SmartHome-Skill].
SmartHome-Skills erhalten weder die Sprachdaten selber noch das, was Amazon in Textform verstanden hat, sondern vielmehr extrahiert Amazon aus dem verstandenen Text Anweisungen und Abfragen für Geräte, die dann an den Skill übermittelt werden. Charmant ist dabei, dass unmittelbar gefragt werden kann "Alexa, wie ist die Temperatur im Wohnzimmer?", während andere Skills zunächst explizit angesprochen werden müssen ("Alexa, frage FHEM nach der Temperatur im Wohnzimmer"). Außerdem kann der Nutzer mehrere Smarthome-Skills installieren, und die Geräte werden zu einer Gesamtmenge zusammengefasst.

Gehen wir den Datenfluss bei der konkreten Frage "Wie ist die Temperatur im Wohnzimmer?" durch:
* Alexa hat bei der Skillinstallation gelernt, dass "FHEM Connector" bei Dir einen Thermostaten im Raum Wohnzimmer kennt. Dadurch wird bei der Sprachanalyse von "Alexa Voice Service" in der Cloud erkannt, dass eine Abfrage an "FHEM Connector" erfolgversprechend ist.
* Zunächst wird die zentrale "Lambda-Funktion" von "FHEM Connector" aufgerufen. Die Funktion leitet aber im Kern nur den Request unverändert an den vom Verein bereitgestellten Server weiter. Im Request enthalten ist ein Token, das sogenannte "Bearer-Token".
* Der "Vereinsserver" prüft anhand dieses Tokens, ob es überhaupt bekannt ist, und zu welchem Nutzer es gehört. Ist dieser Nutzer verbunden, wird der Request wiederum quasi unverändert an den Nutzer weitergeleitet.
* Diese Weiterleitung passiert über einen sogenannten SSH-Reverse-Tunnel, der von Deiner Seite und der Software auf dem FHEM-Tunnel automatisch aufgebaut wird.
* Auf Deiner Seite läuft die eigentliche Software, und zwar unter nodeJS. nodeJS ist ein Javascript ausführender Miniserver, der lokal auf einem Zufallsport auf Requests "lauscht". In der Original-Version [[Alexa-Fhem|Alexa FHEM]] kommen die Requests aus dem Internet (hoffentlich von der eigenen Lambda-Funktion), hier bei "FHEM Connector" kommen sie ausschließlich aus dem SSH-Tunnel von lokal.
* Die Software validiert nun diesen Request anhand des Bearer-Tokens. Konkret wird dabei das bei der Installation generierte Token, dass bei der Skill-Aktivierung an Amazon übertragen wurde, mit dem lokal gespeicherten Wert verglichen. Stimmt das Token, wird der Befehl verarbeitet, üblicherweise wird hierbei ein Aufruf an die Webschnittstelle von FHEM abgesetzt.
* FHEM führt den Befehl aus

Hört sich langsam und kompliziert an? Kompliziert: Okay. Langsam eher nicht, in etlichen Fällen liegt die Gesamtantwortszeit unter 200 ms.

Soweit ein erster Überblick über die Datenflüsse. Im Abschnitt Sicherheit ist das Konzept der Absicherung deutlich genauer und ausführlicher beschrieben.

==Installation==

Du wirst bei der Installation zuerst auf der Kommandozeile auf Deinem Raspberry (o.ä.) unterwegs sein, anschließend im Webfrontend von FHEM, und zum Schluss auf der Alexa-Konsole im Web.

===node.js installieren===

Ab Jessy liegt NodeJS bereits in einer ausreichend aktuellen Version vor (Stretch und Buster funktionieren ebenfalls). Mit

<syntaxhighlight lang="bash" style="width:50%;">
sudo apt-get install nodejs npm
</syntaxhighlight>

kannst Du es installieren. Mit
<syntaxhighlight lang="bash" style="width:50%;">
node --version
</syntaxhighlight>

erfährst Du die aktuelle Version - wenn hier etwas mit "8" oder höher vorneweg erscheint, ist alles gut.
Ansonsten suche Dir bitte eine Anleitung im Web, wie Du NodeJS auf Deinem System auf einen aktuellen Stand bringen kannst.

=== Alexa-FHEM installieren ===

Nun installieren wir Alexa-fhem aus dem offiziellen Repository:

<syntaxhighlight lang="bash" style="width:50%;">
sudo npm install -g alexa-fhem
</syntaxhighlight>

Der Vorgang benötigt etwas Zeit.

=== Alexa-FHEM aktivieren ===

Wechsele jetzt in FHEM-Web!

Wichtig ist, dass das Alexa-Modul in der Version ab Januar 2019 vorliegt. Dafür bitte einmal FHEM aktualisieren:
Speichern der Config nicht vergessen, und

<syntaxhighlight lang="bash" style="width:50%;">
update
shutdown restart
</syntaxhighlight>

Alles, was jetzt noch nötig ist, ist das Anlegen eines Alexa-Devices. Gib dafür in der FHEM-Web-Kommandozeile

<syntaxhighlight lang="bash" style="width:50%;">
define alexa alexa
</syntaxhighlight>

an. Nun läuft, während Du bereits das neu angelegte Alexa-Devices siehst, ein komplexer Prozess im Hintergrund:

* Falls noch kein SSH-Key für den Benutzer, unter dem FHEM läuft, existiert, wird einer generiert
* Es wird ein Secret-Key im Prozess generiert, dass den Server nicht verlässt, und der Skillanmeldung dient.
* Du wirst auf dem Server "va-fhem.fhem.de" des FHEM-Vereins mit dem SSH-Key angemeldet, und der Hash-Wert Deines Secret-Key dort abgelegt.

Und wenn Du diese Sätze gelesen hast, sollte inzwischen sich das Alexa-Device in FHEM-Web aktualisiert haben, und
ungefähr so aussehen:

[[Datei:Alexa-Device-2.png|800px]]

Neben dem Status für alexa-fhem und der Proxyverbindung ist wichtig, dass diese beiden Zeilen beim Reload aufgetaucht sind:

<syntaxhighlight lang="bash" style="width:90%;">
alexaFHEM.bearerToken crypt:...
alexaFHEM.skillRegKey crypt:...
</syntaxhighlight>

Ja, und diesen Schlüssel benötigst Du wirklich! Also am besten schon einmal mit

<syntaxhighlight lang="bash" style="width:90%;">
get <alexa> proxyKey
</syntaxhighlight>

in Klartext anzeigen lassen und in ein Editor-Fenster dauerhaft wegsichern.

Jetzt solltest Du Dein Alexa-Device nicht mehr löschen, denn das im Reading angezeigte "bearerToken" zu löschen bedeutet, dass die Software die Zugriffe von nicht mehr überprüfen kann und keine Kommandos mehr funktionieren. In diesem Fall hilft nur die Neuinstallation des Skills.

==== Fehler bei der Aktivierung ====

Während kompliziertere Fehlerfälle im Abschnitt "Mögliche Probleme und Lösungen" behandelt werden, hier häufige Fälle, warum die kryptischen Zeilen nicht auftauchen:

* Zuerst bitte einfach einmal die Seite neu laden.

===== 401: Authorization Required =====

Wenn Du FHEM-Web mit einem User/Passwort-Schutz versehen hast, wirst du folgende Fehlermeldung sehen:

<syntaxhighlight lang="bash" style="width:90%;">
alexaFHEM stopped; failed to connect to fhem: 401: Authorization Required
</syntaxhighlight>

In der Regel musst du die Angaben User/Passwort noch einmal explizit setzen. Im Attribute-Abschnitt "alexaFHEM-auth" auswählen, User/Passwort mit ":" getrennt angeben und "attr" anklicken. alexa-fhem wird automatisch neu gestartet. Hier das Ganze in der Text-Variante:

<syntaxhighlight lang="bash" style="width:90%;">
attr alexa alexaFHEM-auth user:pass
</syntaxhighlight>

===== Permission denied =====

Wenn du folgende Fehlermeldungen im Alexa Logfile siehst, wurde das Verzeichnis "/opt/fhem/.ssh/" von dir bei der Arbeit mit "root" oder "sudo" mit den falschen Berechtigungen versehen:

<syntaxhighlight lang="bash" style="width:90%;">
[2019-7-25 11:59:12] sshautoconf: aborted with ssh-keygen returned error - key_save_private: Permission denied
[2019-7-25 11:59:12] *** SSH: proxy configuration failed: ssh-keygen returned error - key_save_private: Permission denied
</syntaxhighlight>

Prüfen kannst du die Berechtigungen mit folgendem Befehl auf der Shell-Konsole:

<syntaxhighlight lang="bash" style="width:90%;">
ls -l /opt/fhem/.ssh
</syntaxhighlight>

Du solltest dann folgende Ausgabe erhalten:

<syntaxhighlight lang="bash" style="width:90%;">
insgesamt 12
-rw------- 1 fhem dialout 1675 Jul 12 13:10 id_rsa
-rw-r--r-- 1 fhem dialout 391 Jul 12 13:10 id_rsa.pub
-rw-r--r-- 1 fhem dialout 884 Jul 12 13:10 known_hosts
</syntaxhighlight>

Steht in der Ausgabe nicht "fhem dialout" (dein fhem User), sondern bspw. "root root", dann bspw. mit folgendem Befehl an deinen fhem User anpassen:

<syntaxhighlight lang="bash" style="width:90%;">
chown fhem:dialout /opt/fhem/.ssh
</syntaxhighlight>

Mit dem ersten Befehl "ls -l ..." kannst du dann nochmal prüfen, ob die Berechtigungen korrekt übernommen wurden.

===== weitere Prüfungen =====

Hast Du noch die Shell-Konsole offen? Dann prüfe bitte noch einmal auf der Konsole, ob nun zwei Prozesse laufen:

<syntaxhighlight lang="bash" style="width:50%;">
ps -ef | egrep '(alexa|ssh)'
</syntaxhighlight>

sollte Dir idealerweise so etwas anzeigen:
<syntaxhighlight lang="bash" style="width:90%;">
fhem 31322 1 99 13:56 ? 00:00:03 alexa
fhem 31332 31322 8 13:56 ? 00:00:00 /usr/bin/ssh -R 1234:127.0.0.1:<zufälliger port> -oServerAliveInterval=90 -p 58824 fhem-va.fhem.de
</syntaxhighlight>

"alexa" ist dabei der Node-JS-Prozess, der ssh-Prozess ist die aufgebaute Verbindung zum Vereinsserver.

Wenn Du diese Prozesse '''nicht''' siehst oder das Alexa-Device keinen Registrierungskey anzeigt, dann ist leider der Start nicht glatt verlaufen.

Im Logfile (über den link <code>Logfile</code> in der Detail-Ansicht über <code>set</code>, oder über den Namen bei ''currentlogfile'' in den Internals) findest Du idealerweise selber Hinweise, wo es hakt, oder kannst im Forum nachfragen.

=== Geräte im FHEM-Webfrontend zuweisen ===
Um das Aha-Erlebnis zu vergrößern, ist jetzt ein guter Zeitpunkt, 1 oder besser mind. 2 Geräte für den Alexa-Dienst zuzuweisen. Von Haus aus wird keines Deiner FHEM-Geräte automatisch Alexa zugewiesen!

Wähle die Geräte aus, rufe sie auf und setze das Attribut "alexaName". Hierbei in Kürze nur der Hinweis:
* Keine Angst vor Leerzeichen und Umlauten, funktioniert.
* Große Angst vor Rechtschreibfehlern (Terrasse, Rollladen) oder komplizierten Wörtern "handgebastelte Martinslaterne im Kinderzimmer Iphigenie-Chantal".
* Das Attribut "alexaRoom" ist NUR FÜR DEN CUSTOM SKILL relevant. Ausnahme: structure und LightScene Devices, siehe: [[FHEM_Connector_f%C3%BCr_Amazon_Alexa#Was_geht_alles_.3F]].

Lade die Geräte neu in die Software, indem Du <code>set <alexa> restart</code> ausführst!
[[Datei:HowToSet alexaName.png|alternativtext=How to set alexaName|ohne|mini|Wie setzt man das Attribut alexaName]]

'''Anmerkungen (weil oft gestellte Fragen im Forum) bzgl. Erkennung von Geräten:'''

* Wichtig ist, dass die Filtereinstellung in der alexa-fhem.cfg (zu finden unter "Edit Files") passt.
Das, was dort eingetragen ist (Standard: alexaName=..* / also es ist ein alexaName vergeben) auch an den entsprechenden Devices in fhem vorhanden ist.
Stimmt das nicht überein, kann alexa-fhem keine Devices von fhem abfragen/finden.
Ob der Filter entsprechend funktioniert kann man wie folgt testen: ''list Filtereinstellung'' beispiel mit Standardfilter: ''list alexaName=..*''

* Hat alexa-fhem per Filter Devices aus fhem "gefunden", geht es weiter mit der "Erkennung". Also um welches Device (Typ und "Fähigkeiten") handelt es sich. Dazu gilt folgendes:
** sind entsprechende Readings beim Device vorhanden (z.B. temperature, state mit on/off, ...) erkennt das alexa-fhem automatisch. Die Liste der automatisch erkannten Readings wächst ständig. Daher erst mal schauen ob das Device bereits entsprechend erkannt (typisiert) wurde. Das kann durch prüfen des alexa-fhem-Logs geschehen (NICHT fhem-log!).
** sind entsprechende "set-Befehle" erkennbar (oft auch durch Readings). Also ist beispielsweise (wie beim Dummy nötig) ein ''setList'' mit entsprechenden Einträgen vorhanden oder entsprechende Readings, z.B. desired-temp zum Stellen der Temperatur etc.
** wird das Device nicht richtig oder "unvollständig" erkannt helfen folgende Attribute:
*** genericDeviceType: hiermit kann alexa-fhem in die gewünschte Richtung "geschubbst" werden. Anmerkung: man kann nicht alles erzwingen, Readings bzw. set-Befehle müssen passen (oder per homebridgeMapping passend gemacht werden). Wenn ein genericDeviceType nicht per "Drop-Down" erscheint, dann kann er auch (wenn bekannt) einfach per WEB-cmd eingegeben werden: ''attr Devicename genericDeviceType media''
*** homebridgeMapping: hierdurch kann alexa-fhem bei der Erkennung von Zuständen und möglichen Einstellungen (also WAS kann das Device) unterstützt werden. Mittels homebridgeMapping können vorhandene Readings (Zustände) auf für alexa-fhem bekannte Zustände gemappt werden. Ebenso können damit Standard-fhem-Kommandos von alexa-fhem auf Device-spezifische gemappt werden. Beispiel: on/off auf Ein/Aus (falls das Device statt on/off eben ein Ein/Aus erwartet). Zum Beispiel: <syntaxhighlight lang="bash" style="width:50%;">
attr <thermostat> homebridgeMapping TargetTemperature=target::target,minValue=18,maxValue=25,minStep=0.5 CurrentTemperature=myTemp:temperature
</syntaxhighlight> [https://github.com/justme-1968/homebridge-fhem/blob/master/README.md weitere Beispiele]

'''Anmerkung bzgl. genericDeviceType und homebridgeMapping:'''<br>
* diese Attribute werden von verschiedenen "Sprachsteuerungsmodulen" in fhem verwendet (homebridge [dort wurde es "erfunden"], alexa-fhem, gassistant, ...). Daher ist nicht jedes Mapping für alle "Dienste" verwendbar. Ausprobieren schadet aber nicht.
* ebenso kann man mit diesen Attributen (homebridgeMapping wird gerne so "missbraucht") nichts erzwingen, was seitens Amazon/Alexa nicht unterstützt bzw. verstanden wird! D.h. zunächst ist zu prüfen, ob ein bestimmter (gewünschter) Sprachbefehl seitens Amazon/Alexa unterstützt wird! Aktuelles Beispiel (Stand Jan 2020): "Alexa, fahre den Rollo hoch/runter". Da ist Amazon/Alexa gerade dabei etwas zu tun. Bislang wird das nicht unterstützt, also ist das auch mit einem entsprechenden homebridgeMapping nicht zu erzwingen! Was unterstützt wird kann man bei Amazon nachlesen: [https://developer.amazon.com/es-ES/docs/alexa/device-apis/list-of-interfaces.html]

== Finale: Skill verknüpfen ==
Suche im WebFrontend oder der Alexa-App den Skill "FHEM Connector". Für nicht-Mac/iOS Anwerder empfiehlt das WebFrontend (https://alexa.amazon.de) statt die App, damit Du den Anmeldeschlüssel auch bequem kopieren kannst.

Wenn du noch nicht bei Amazon angemeldet bist, erwartet Amazon zunächst, dass Du Dich normal bei Amazon anmeldest.

Sobald Du "FHEM Connector" aktivierst, öffnet sich ein Browser-Tab mit folgender Maske:<br />
[[Datei:FHEMlazy_login.png|240px]]

Hier kopierst Du Deinen Anmeldeschlüssel (im Klartext!) hinein und klickst auf Check. Als glücklicher Mensch ist auf der folgenden Statusseite alles grün:<br />
[[Datei:FHEMlazy_check.png|240px]]

Im Einzelnen wird hier geprüft, ob Du per SSH verbunden bist (und auch Deine IP zur Sicherheit angezeigt), ob der Reverse-Tunnel steht, ob nodeJS erreichbar ist und wie viele Geräte Alexa gleich finden sollte (in meinem Fall 22).

Sollte etwas nicht grün sein und Du eine Idee zum Fixen haben, kannst Du mit "Retry" neue Versuche auslösen.

Ist alles okay, klicke rechts den Button "Activate Skill". Du springst damit wieder zurück zu Amazon, die Dir hoffentlich zur erfolgreichen Verknüpfung gratulieren.

Amazon möchte nun unmittelbar die Gerätesuche starten, und unter SmartHome-Geräte sollten diese nun auftauchen.

== Was geht alles ? ==

* Geräte, die sich ein- und ausschalten lassen:
** Automatisch: Müssen <code>set on</code> und <code>set off</code> Kommandos haben
** dummys müssen <code>setList</code> mit on und off haben
** Über <code>genericDeviceType</code> switch bzw. light kann bestimmt werden ob es in alexa als Schalter oder Licht behandelt wird.
** Wenn die Set-Kommandos im FHEM Device anders benannt sind: homebridgeMapping On:cmdOn=<ein>,cmdOff=<aus> setzen
** Kommandos:
***Alexa, schalte <name> ein/aus
***Alexa, Licht an/aus
***Alexa, schalte <gruppe> ein/aus
* Geräte, die eine Temperatur messen
** Automatisch: Es muss ein Reading <code>temperature</code> geben
** Über <code>genericDeviceType</code> thermometer
** Sonst: homebridgeMapping CurrentTemperature:reading=<reading>

* Geräte, deren Helligkeit sich ändern lässt
** Automatisch: wenn <code>dim</code> oder <code>pct</code> Kommandos erkannt werden
** Über <code>genericDeviceType</code> light
** Über homebridgeMapping: Wenn <code>helligkeit</code> das Reading für die aktuelle Helligkeit enthält und die Helligkeit mit <code>set <device> prozent xxx</code> gesetzt wird, sieht das homebridgeMapping wie folgt aus: homebridgeMapping Brightness=helligkeit::prozent,minValue=0,maxValue=<maximalwert>
** Kommandos:
*** Alexa, mache <name> heller/dunkler
*** Alexa, Licht heller/dunkler
* Geräte, deren Farbe sich ändern lässt
** ...

* Geräte, deren Farbtemperatur sich ändern lässt
** ...

* Geräte, bei denen sich eine Lautstärke einstellen lässt
** ...

* Geräte, bei denen sich ein prozentualer Wert einstellen lässt
** Automatisch: wenn <code>dim</code> oder <code>pct</code> Kommandos erkannt werden
** ...

* elektrische Türschlösser
** <code>genericDeviceType</code>: lock
** homebridgeMapping mit LockCurrentState und LockTargetState

* Thermostate
** Über <code>genericDeviceType</code> thermostate
** ...

* structure Devices aus FHEM (ab alexa-fhem version 0.5.7)
** können mit <code>genericDeviceType</code> scene als Szene eingebunden werden
** über <code>alexaRoom</code> kann der name um einen Ort ergänzt werden
** Szenen aus einer structure lassen sich ein- und ausschalten
** Wichtig:
*** Ein Skill darf nur 12 Szenen automatisch erkennen und einbinden.

* LightScene Devices aus FHEM (ab alexa-fhem version 0.5.8)
** können mit <code>genericDeviceType</code> scene als Szenen eingebunden werden
** über <code>alexaRoom</code> kann der name um einen Ort ergänzt werden
** Szenen aus einer LightScene lassen sich nur einschalten
** Wichtig:
*** Ein Skill darf nur 12 Szenen automatisch erkennen und einbinden.

* Geräte, deren Kanal sich umschalten lässt (ab alexa-fhem version 0.5.13)
** Über <code>genericDeviceType</code> media
** homebridgeMapping ChannelController:reading=<reading>,cmd=<cmd>
** Erlaubte Werte siehe hier: https://developer.amazon.com/de/docs/device-apis/alexa-channelcontroller.html#changechannel
** ...

* Geräte, deren Playback status sich schalten lässt (ab alexa-fhem version 0.5.13)
** Über <code>genericDeviceType</code> media
** homebridgeMapping PlaybackController:playback,values=Play;Pause;Stop;Previous;Next
** Erlaubte Werte siehe hier: https://developer.amazon.com/de/docs/device-apis/alexa-playbackcontroller.html#discovery
** ...

* Geräte, deren Eingang sich umschalten lässt (ab alexa-fhem version 0.5.13)
** Über <code>genericDeviceType</code> media
** homebridgeMapping InputController:reading=<reading>,cmd=<cmd>,values=HDMI+1;HDMI+2;XBOX
** Erlaubte Werte siehe hier: https://developer.amazon.com/de/docs/device-apis/alexa-property-schemas.html#input
** ...

* Kontaktsensoren (ab alexa-fhem version 0.5.15)
** Über <code>genericDeviceType</code> contact
** homebridgeMapping ContactSensorState:reading=<reading> oder CurrentDoorState:reading=<reading>
** Die Anzeige in der Alexa-App funktioniert sofort, die Abfrage per Sprache erst ab Version 0.5.27.

* Geräte, deren Lautstärke sich ändern lässt (ab alexa-fhem version 0.5.24)
** Über <code>genericDeviceType</code> speaker
** Automatisch: es muss ein Reading <code>volume</code> und/oder <code>mute</code> geben
** homebridgeMapping Volume:reading=<reading>,cmd=<cmd> Mute:reading=<reading>,cmd=<cmd>
** ...

* Geräte, die sich ein- (und optional) ausschalten lassen als Szene (ab alexa-fhem version 0.5.26)
** Über <code>genericDeviceType</code> scene
** Automatisch: Müssen <code>set on</code> und <code>set off</code> Kommandos haben
** homebridgeMapping On:reading=<reading>,cmdOn=<cmd>[,cmdOff=<cmd>]
** Hinweis: Fehlende Kommandos lassen sich mit cmdalias erzeugen
** Wichtig:
*** Ein Skill darf nur 12 Szenen automatisch erkennen und einbinden.
* Rollläden. Lange ein Problemthema, das nur mit "Schalte auf 0%, schalte auf 100% lief". Wichtig: "alexa-fhem" ab Version 0.5.39 einsetzen. GenericDevice-Type auf "blind" setzen. Nach Restart von alexa-fhem und neuer Gerätesuche sollte folgendes funktionieren:
** "..., öffne <Name> ganz"
** "..., schließe <Name> komplett"
** "hoch" und "runter" (ohne "ganz" oder "komplett") schalten jeweils nur einen bestimmten Prozentsatz hoch oder runter. Dieser kann mit <code>attr <name> homebridgeMapping TargetPosition:minStep=<wert></code>geändert werden. Aber Achtung: In diesem Intervall kann dann auch nur noch ein absoluter Prozentwert per Sprache oder Slider eingestellt werden! Bei z.B. 25% würden 13% zu 25% aufgerundet, 12% zu 0% abgerundet werden.
* Kontaktsensoren (ab alexa-fhem version 0.5.47)
** Automatisch wenn ein Reading <code>motion</code> vorhanden ist oder es sich um einen Zigbee bewgungsmelder an einer HUE oder deCONZ Bridge handelt
** Über <code>genericDeviceType</code> MotionSensor
** homebridgeMapping MotionDetected:reading=<reading>,values=<wert für bewgung>:1;<wert für keine bewegung>:0

Es werden noch einige andere häufig verwendete Geräte (Homematic, hue,...) automatisch erkannt.

to be continued ...

In der [https://developer.amazon.com/docs/device-apis/list-of-interfaces.html List of Capability Interfaces] bei Amazon kann man sehen, welche Möglichkeiten das Smart Home Skill API aktuell in einzelnen Ländern bietet. Leider ohne die jeweiligen landessprachlichen Kommandos.

=== Aktiv Routinen starten ===
Routinen (eine Funktionalität, die rein - genauso wie "Räume" - bei Amazon liegt und nicht von FHEM Connector beeinflusst wird) waren lange die ewige Antwort auf die Frage: "Meine Frau möchte aber '''Öffne Rollläden''<nowiki/>' sagen": In der Alexa-App gibt es im Menü den Punkt "Routinen", und hier lässt sich eine gewisse Anzahl von Aktionen (unter optionalen Bedingungen) an ein Sprachkommando knüpfen.

Neu: Routinen können inzwischen auch von Skills getriggert werden, und seit Version 0.5.47 (Februar 2020) auch von FHEM Connector. Das braucht niemand, um die Rollläden hochzufahren, denn das kann FHEM ja selber, aber um z.B. eine Ansage auf einem Alexa-Gerät zu triggern. Dafür gibt es auch das FHEM-Modul "echodevice", aber es erfordert ein paar Klimmzüge. Mit dem aktiven Triggern von Routinen kann FHEM auslösen, dass Alexa ungefragt (!) Dinge wie

''"Die Temperatur in der Tiefkühltruhe hat -16 Grad überschritten"''

in den Raum sagt. Also eine Alternative bzw. Ergänzung zu Alarmen / Erinnerungen per Telegram o.ä.

'''Vorgeschichte''':

Die Smarthome-Skill-API von Amazon sah schon lange das "proactiveReporting" vor: Also z.B. die gemessene Temperatur nicht erst auf Anfrage hin zu übermitteln, sondern laufend aktiv zu pushen. Aber warum Daten an Amazon senden, wenn es dafür keinen Mehrwert gibt? Beim Öffnen z.B. des Thermostaten in der Alexa-App kommen ohnehin laufend Statusabfragen. Warum also einen Datenpool bei Amazon über die Haustemperatur aufbauen und Änderungen pushen, wenn es keinen Mehrwert dafür gibt?

Inzwischen lassen sich (reale oder vermeintliche) Änderungen von ''Bewegungssensoren'' und ''Fensterkontakten'' als Startbedingung an Alexa-Routinen koppeln. Man kann in der Alexa-App (ggf. fiktive) Öffnen eines Fensterkontaktes an das Aufsagen eines freien Textes durch die Hausbutlerin knüpfen.

'''Umsetzung''':
* Jedes Alexa-Device, dessen Status aktiv zu Amazon gepusht werden soll, im Attribut "alexaProactiveEvents" mit einer "1" versehen. Per Default wird ''kein'' Gerät laufend aktiv zu Amazon gepusht!
* das geänderte Device einmal zu Amazon pushen "set <alexa> add <device>" (oder 'Alexa, suche neue Geräte' murmeln)
* Das Gerät sollte jetzt beim Anlegen einer neuen Routine ("Neue Routine", "Wenn Folgendes passiert", "Smart Home") als möglicher Triggerpunkt erscheinen.

==== Dummygeräte: ====
Ein Dummydevice sollte einen Kontaktschalter oder Bewegungssensor simulieren, um dann in FHEM eine beliebige Bedingung als Trigger zu definieren, und eine freie Ansage in Alexa als Routine zu definieren. Hier ein Beispiel:

<syntaxhighlight lang="bash" style="width:90%;">
define voicetrigger1 dummy
attr voicetrigger1 alexaName Trigger 1
attr voicetrigger1 alexaProactiveEvents 1
attr voicetrigger1 genericDeviceType contact
attr voicetrigger1 homebridgeMapping ContactSensorState=state,values=closed:CONTACT_DETECTED;;open:CONTACT_NOT_DETECTED
attr voicetrigger1 readingList 0:closed 1:open
attr voicetrigger1 setList closed open

set alexa add voicetrigger1
set alexa restart
</syntaxhighlight>

'''Fehlersuche:'''

Der Push setzt ein intaktes Push-Token voraus. Sollte im Alexa-Logfile Folgendes erscheinen:

<code>failed to refresh token: invalid_grant: 'The request has an invalid grant parameter : refresh_token'</code>

so ist das Push-Token nicht aktuell. Weil die Auswirkung lange nur war, dass Geräteänderungen nicht aktiv an Amazon gemeldet wurden, gibt es noch keine umfassende Analyse des Problems. Es lässt sich lösen, indem eine oder beide folgenden Aktionen ausgeführt werden:
* Löschen des ".eventToken" im Alexa-Device über "deletereading"
* "FHEM-Connector"-Skill auf "alexa.amazon.de" einmal deaktivieren und dann neu verbinden

== Mögliche Probleme und Lösungen ==

Es kann vorkommen, dass Geräte zwar korrekt erkannt werden, aber das durch Alexa erkannte Kommando nicht richtig umgesetzt wird (Beispiel - mittlerweile behoben: {{Link2Forum|Topic=96766}}). Neben dem FHEM-Log gibt es noch das Logfile, welches von alexa-fhem angelegt wird.

=== Fehlersuche über die FHEM-Oberfläche ===

* alexa-fhem Logfile anschauen (Detail-Ansicht des <alexa>-Device aufrufen, klick auf '''Logfile''' oben)
* alexa-fhem im Debug-Modus aufrufen:
** -D zum alexaFHEM-params attribut hinzufügen
** Alexa-Befehl auslösen
** -D aus dem alexaFHEM-params attribut entfernen
* Die notwendigen Informationen finden sich in dem alexa-Logfile (siehe oben)

=== Fehlersuche über Kommandozeile (lies: Shell) + FHEM-Oberfläche ===

:* set <alexa> stop (FHEM-Oberfläche)
:* Auf der Kommandozeile <code>alexa-fhem -D -c /opt/fhem/alexa-fhem.cfg > debug.log</code> starten (dadurch wird die Datei debug.log erzeugt im aktuellen Verzeichnis)
:* Alexa-Befehl auslösen
:* alexa-fhem auf der Kommandozeile wieder stoppen (CTRL-C)
:* set <alexa> start (FHEM-Oberfläche)

Die Datei debug.log sollte Hinweise enthalten, wie das Problem zu lösen ist oder Dich zumindest in die richtige Richtung schieben.

Im Beispiel aus dem Forum fand sich in dem Logfile der Hinweis darauf, dass das Device mit falschen min/max-Werten unterwegs war.

=== Registrierungskey vergessen, Registrierung zurücksetzen ===

Auf der Kommandoshell:

<syntaxhighlight lang="bash" style="width:90%;">
pi@raspberrypi:~# sudo -u fhem ssh -p 58824 fhem-va.fhem.de status
Registered.
Registered on 2019-01-13T15:38:13Z.
</syntaxhighlight>

heisst, das der Vereinsserver eigentlich alles hat, was er will. Es wird kein neuer Schlüssel generiert.
Wenn Du die Situation zurücksetzen möchtest, wäre die hässliche Methode, Deinen SSH-Key zu löschen. Eleganter ist, die Registrierung auf Vereinsseite zu löschen:

<syntaxhighlight lang="bash" style="width:90%;">
pi@raspberrypi:~# sudo -u fhem ssh -p 58824 fhem-va.fhem.de unregister
Your registration has been removed
</syntaxhighlight>

löscht Deinen Schlüssel mitsamt allen dort gespeicherten Daten auf Vereinsseite. Bei Restart von alexa-fhem in FHEM-WEB wird jetzt ein neuer Registrierungskey angefordert.

== Sicherheitskonzept und Secrets ==

Um diesen Abschnitt zu verstehen, solltest Du den Abschnitt "Arbeitsweise" im Kopf haben. Einerseits ist Dir vermutlich einleuchtend, dass ein Server, der per SSH rückwärts nur ausgewählte Kommandos in den Tunnel, den Du aufgebaut hast, leitet, "irgendwie sicherer" ist. Andererseits möchte man nicht blind vertrauen.

=== SSH ===
==== SSH - macht das nichts Gefährliches? ====
SSH ist ein Veteran des Internet und entstand, um sich sicher (verschlüsselt) und schnell auf Servern einzuloggen. Schon früh wurde dabei der sogenannte "Reverse-Tunnel" implementiert: Also der vom Client (Deinem Rechner) geäußerte Wunsch: "Bitte leite mir Requests, die bei Dir, Server, auf Port xy eingehen, an meinen lokalen Port yz weiter.". Dieses Verfahren implementiert der Reverseproxy, wobei tatsächlich auf dem Server für Dich kein echter Port geöffnet wird.

Wie Dir ggf. sicher der Unix-Guru Deines Vertrauens bestätigen wird: Die Kombination
<syntaxhighlight lang="bash" style="width:50%;">
ssh -R 1234:localhost:<zufälliger port> zielserver
</syntaxhighlight>
erlaubt keine Ausführung von Shell-Kommandos auf Deinem Server, sondern einzig, dass vom SSH-Programm Verbindungen zu einem lokalen Port auf Deinem Server auf dem alexa-fhem lauscht aufgebaut werden. Du kannst also z.B. mit einem
<syntaxhighlight lang="bash" style="width:50%;">
sudo /usr/sbin/tcpdump -X -s 0 -i lo port <zufälliger port>
</syntaxhighlight>
vollständig überwachen (oder ggf. permanent aufzeichen), was auf Deinem Server von außen gesteuert passiert.

==== Wie wird bei SSH verschlüsselt? ====
Im Prinzip wie im Web auf SSL-Seiten, teils mit den gleichen Verschlüsselungsverfahren. Allerdings arbeitet SSH eher wie das im Web recht seltene Verfahren: Bei jeder Verbindung übermitteln sowohl Server wie auch Client den öffentlichen Teil ihres Schlüssels. Anders als im Web wird der Schlüssel aber nicht von einer öffentlichen Zertifizierungsstelle wie "LetsEncrypt" unterschrieben. Stattdessen entscheiden Server wie Client beim ersten Verbindungsaufbau typischerweise per manueller Frage: "Willst Du jetzt und künftig diesem Schlüssel vertrauen?" Bei der Installation wird diese Frage für Deine Seite bejaht, und fortan wird der öffentliche Schlüssel des FHEM-Servers auf Deinem Rechner gespeichert. Ab da bist Du z.B. davor sicher, dass jemand den DNS-Eintrag verbiegt oder sich in den Datenfluss Deines Providers einhängt: Ein geänderter Serverschlüssel würde bemerkt werden.
<br />
Soweit klar? Aus Deinem öffentlichen Schlüssel wiederum leitet der Server her: "Das ist definitiv wieder derjenige, der sich damals "registriert" hat". Und an dieser Stelle kann ich auch den <b>ersten Teil des 3-teiligen Registrierungskeys</b> erläutern: Die typischerweise 6-stellige Hex-Zahl am Anfang ist der Java-Hashcode Deines öffentlichen Schlüssel. Sie ist damit sozusagen Deine aus Deinem öffentlichen Schlüssel abgeleitete Benutzer-ID.

=== Die Rolle der Secrets ===
Wenn jetzt klar ist, dass die Verbindung zum Vereinsserver sicher und vertauschungsfrei funktioniert, bleiben noch 2 Probleme zu lösen:
1) Im Web bei der Skill-Aktivierung musst Du beweisen, dass Du der Mensch am Browser bist, dem der SSH-Tunnel von IP xy mit dem öffentlichen Schlüssel X gehört. Bei der automatischen Registrierung werden lokal auf Deinem Rechner zwei 64-Bit-Secrets generiert:
* Das <b>Anmelde</b>-Secret
* Das <b>Bearer</b>-Token
Beim Anmelden des SSH-Keys auf dem öffentlichen Server wird nun der <b>Hashwert</b> des ersten Secrets übertragen und dort in Verbindung mit Deinem öffentlichen Schlüssel gespeichert. Ein Hashwert bedeutet, dass (sofern das Verfahren, hier SHA256, funktioniert), niemand aus dem Hash das Secret zurückrechnen kann. Ein Datenbankklau auf dem Server gefährdet also nicht die Sicherheit Deines Passwortes.

Wenn Du nun beim Skill-Aktivieren den Registrierungskey eingibst, dann "sieht" der Server zum ersten Mal Dein ausgewürfeltes Secret, vergleicht es mit dem Hashwert und wird es anschließend wieder umgehend vergessen. Anhand des Hashwertes kann der Server aber entscheiden, dass Du der legitime Nutzer zum öffentlichen Schlüssel XY bist.

2) Das zweite Problem ist: Wie soll Amazon "beweisen", dass sie der legitime Aufrufer sind? Amazon erhält binnen wenigen Sekunden nach dem Klick auf "Activate Skill" den <b>dritten Teil</b> des Registrierungskeys als sogenanntes Bearer-Token. Zwar läuft er durch den Registrierungsserver, er wird dort, auf dem Registrierungs/Vereinsserver aber nicht gespeichert. Das Bearer-Token wird von Amazon bei allen Requests zu Deinem Server mitgesendet. Da es am Anfang zusätzlich Deine "User-ID" enthält, weiß der Vereinsserver, zu welchem SSH-Tunnel der Request zu senden ist. Aber lokal auf Deinem Rechner wird ausgewertet, ob das Token "stimmt".

== alexa-fhem Updaten bzw. "Upgraden" ==

'''Updaten einer "Connector" Installation:'''
* alexa-fhem über FHEM anhalten (Name des Alexa-Device: alexa):
:<syntaxhighlight lang="perl" style="width:50%;">set alexa stop</syntaxhighlight>

*Auf der Konsole wie anfangs bei der Installation:
:<syntaxhighlight lang="bash" style="width:50%;">sudo npm update -g alexa-fhem</syntaxhighlight>

:Manchmal hat npm Probleme mit einem Update. Dann einfach die aktuelle Version noch mal drüber Installieren:

:<syntaxhighlight lang="bash" style="width:50%;">sudo npm install -g alexa-fhem</syntaxhighlight>

*alexa-fhem über FHEM wieder starten:
:<syntaxhighlight lang="perl" style="width:50%;">set alexa start</syntaxhighlight>

'''"Upgraden von einer "Nicht-Connector" Installation (z.B. manuelle Installation per pm-Download):'''
* Daten der aktuellen Installation sichern (v.a. config.json / man weiß ja nie)
* Autostart der aktuellen alexa-fhem Installation deaktivieren:
** Bei initd: Service deaktivieren mittels: <code>sudo update-rc.d -f alexa remove</code> Vorher mittels stoppen: <code>sudo service alexa stop</code> Startscript unter /etc/init.d/ löschen.
** Bei systemd: Service deaktivieren mittels: <code>sudo systemctl disable alexa</code> Vorher mittels stoppen: <code>sudo systemctl alexa stop</code> Startscript unter /etc/systemd/system/ löschen.
* ALLE vorhandenen alexa-fhem Daten LÖSCHEN! Bleiben Dinge zurück und wird dann laut Connector installiert kann es zu Problemen kommen!
* (reboot)
* Installation von alexa-fhem laut Anleitung (Beginn dieses Wiki)
* Falls eigene Dinge von früher genutzt werden wollen/sollen (z.B. Custom Skill), dann die entsprechenden Einträge aus der gesicherten config.json in die neu angelegte alexa-fhem.cfg (zu finden unter "Edit files") übernehmen.
* Werden keine eigenen Dinge verwendet, dann kann der Port (Standard: 3000) geschlossen werden und auch die Daten unter Amazon-Developer können gelöscht werden.

== Bug- und Wunschliste ==
* Ist beim Start keine Internetverbindung vorhanden, erfolgt kein Retry -- alexa-fhem muss restartet werden (ssh_autoconfig wertet keine temporären Fehler aus)

==Weitergehende Informationen==
*[[Alexa und Mappings]]
*[[Alexa Tipps und Kniffe]]
*[[FHEM Connector for Amazon Alexa]]
[[Kategorie:HOWTOS]]
[[Kategorie:Sprachsteuerung]]

HomeMatic Firmware Update

2020-02-21T19:09:44Z

Suelle: Korrigiert: set eq3 attrTemplate homematic_fw_check_v2

Seit 2014 ist es möglich, bei einigen [[HomeMatic]] Komponenten selbst Firmware Updates durchzuführen. Vorher ging das nur per CCU oder durch Einsenden des Gerätes an ELV.
Dabei gibt es verschiedene Möglichkeiten das Firmware Update durchzuführen. Um in FHEM die aktuelle Firmware nach dem Update angezeigt zu bekommen, ist ein erneutes Pairen mit FHEM notwendig. Es muss aber nicht gelöscht oder zurückgesetzt werden.

== Varianten für Firmwareupdates ==
=== Firmware Update mit CUL/HM-CFG-USB/HMUARTLGW unter FHEM ===
FW Updates sind in FHEM möglich. Benötigt wird dafür ein [[CUL]] oder ein [[HM-CFG-USB USB Konfigurations-Adapter|HM-CFG-USB]] oder ein [[HMUARTLGW]]. Mit einem [[HMLAN]] ist ein Update nicht möglich.

Vor dem Update ist sicherzustellen, dass das korrekte IO für das Device genutzt wird (falls mehrere IOs im System zu Verfügung stehen). Siehe Attribut IODev und IOgrp bei der Verwendung einer [[Virtueller Controller VCCU|VCCU]]. Ein HMLAN kann mit dem Befehl: <code>set <HMLAN Name> close</code> temporär ausgeschlossen werden.

Um das Update durchführen zu können, wird die in dem entsprechenden Zip/tgz-File vorhandene .eq3-Datei benötigt. Bitte genau darauf achten, dass nicht versehentlich eine falsches Firmware-Datei verwendet wird. Der Vorgang selbst erfolgt mittels folgendem Befehl:
:<code>set <device> fwUpdate <filename> <nowiki>[<time>]</nowiki></code>
<filename> ist der Name der .eq3 Datei inklusive absolutem oder relativem Pfad zu fhem-Root.
Die Angabe von [<time>] ist optional. Es ist die Zeit in Sekunden, die FHEM wartet, bis das Device in den Bootloader-Modus versetzt wird. Bei den meisten Devices ist die Zeit nicht notwendig, da FHEM das Gerät selbst in den Bootloader-Mode versetzen kann.

Bei einigen älteren FW-Versionen wie z.B. bei den [[HM-CC-RT-DN]] v1.0 geht das allerdings nicht automatisch. Um den Flashvorgang zu starten, müssen hier noch die Batterien entfernt werden und beim wiedereinlegen die beiden äußeren Knöpfe gedrückt werden. Jene Zeit, die man für eben diese Aktion benötigt, wird hier eingegeben.

Wichtig: während des Updates können keine weiteren Nachrichten in FHEM von Homematic verarbeitet werden.

Da nach dem Update immer noch die alte FW-Version in FHEM steht, kann man entweder bei einigen Geräten die Version mit
:<code> set <device> getVersion </code>
auslesen oder wenn das Kommando wie z.B. bei den oben genannten Heizkörperventilen nicht zur Verfügung steht, genügt es, am Gerät selbst die Anlerntaste zu drücken (was am Beispiel der RTs bedeutet, dass die Boost-Taste für mindestens drei Sekunden gedrückt werden muss). Nach der Aktualisierung der Firmware-Information in FHEM, muss die [[Konfiguration]] noch gespeichert werden.

==== Fehlersuche / Probleme beim Update via FHEM ====
* Der Firmware-Update nimmt mehrere Minuten in Anspruch (bei einem HM-LC-Bl1PBU-FM bis zu 10 Minuten). Über <code>attr <device> verbose 5</code> kann man für das HM-Device im Log den Fortschritt detaillierter beobachten.
* Sollte es zu einem Abbruch kommen, kann es dazu kommen, dass weitere FW-Update-Versuche abgebrochen werden mit der Fehlermeldung "fail:notInBootLoader" und einem grünen Dauerblinken an der Anlerntaste ({{Link2Forum|Topic=84200|Message=764555}}). In diesem Fall kann die explizite Angabe des Parameters <code><nowiki>[<time>]</nowiki></code> helfen.

=== Firmware Update mit CUL/HM-CFG-USB unter Linux ===
Für Linux hat mgernoth ein Updatetool erstellt.

Zunächst muss sichergestellt werden, dass alle benötigten Pakete installiert sind. Um das Tool zu installieren und auszuführen, müssen die folgenden Pakete mit den gezeigten Befehlen installiert werden. Unter Debian:
<syntaxhighlight lang="bash">
sudo apt-get install libusb-1.0-0-dev git build-essential
</syntaxhighlight>
Unter OpenSuse 13.2 64 Bit:
<syntaxhighlight lang="bash">
sudo zypper install libusb-1.0-0-dev git
sudo zypper install --type pattern devel_basis
</syntaxhighlight>

Als nächstes wird der Sourcecode für das Tool heruntergeladen (vorher z.B. in den Pfad <code>/usr/src</code> wechseln):
<syntaxhighlight lang="bash">
git clone git://git.zerfleddert.de/hmcfgusb
</syntaxhighlight>
Und mit den Anweisungen
<syntaxhighlight lang="bash">
cd hmcfgusb
make
</syntaxhighlight>
wird daraus eine ausführbare Datei erstellt.

Weiterhin muss die nötige Firmware heruntergeladen und entpackt werden. Die offiziellen Updates gibt es unter [http://www.eq-3.de/downloads.html eq-3 Downloads]. Die Befehle, um beispielsweise die benötigte Datei für die Firmware Version 1.4 des HM-CC-RT-DN zu erhalten lauten:
<syntaxhighlight lang="bash">
wget http://www.eq-3.de/Downloads/Software/Firmware/hm_cc_rt_dn_update_V1_4_001_141020.tgz
tar xvzf hm_cc_rt_dn_update_V1_4_001_141020.tgz
</syntaxhighlight>
Zu guter Letzt muss noch das Tool mit einigen Parametern und der Seriennummer des HomeMatic Devices aufgerufen werden. Für ein Update mit einem CUL (<code>/dev/ttyACM0</code> ist in diesem Beispiel die Adresse des CULs) muss folgendes eingegeben werden:
<syntaxhighlight lang="bash">
sudo ./flash-ota -c /dev/ttyACM0 -f <FirmwareImageName>.eq3 -s <DeviceSerialNo>
</syntaxhighlight>
Für ein Update mit einem COC muss folgendes eingegeben werden (/dev/ttyAMA0):
<syntaxhighlight lang="bash">
sudo ./flash-ota -c /dev/ttyAMA0 -f <FirmwareImageName>.eq3 -s <DeviceSerialNo>
</syntaxhighlight>
Für ein Update mit HM-CFG-USB
<syntaxhighlight lang="bash">
sudo ./flash-ota -f <FirmwareImageName>.eq3 -s <DeviceSerialNo>
</syntaxhighlight>
Nun muss nur noch das HomeMatic Gerät in den Update-Modus versetzt werden. Wie das geht, steht in der jeweils mit der Firmwaredatei gelieferten "readme".

=== Firmware Update mit HM-CFG-USB unter Windows ===
Für ein Firmwareupdate unter Windows wird das "HomeMatic Firmware Update Tool" von eq-3 benötigt: [https://www.eq-3.de/service/downloads.html?id=274 eQ-3 Downloads]. Zur Zeit ist das Update damit nur mit dem HM-CFG-USB-2 möglich, nicht aber mit dem HM-CFG-LAN oder dem HM-CFG-USB der ersten Generation.

Nach dem Start muss die Seriennummer des HomeMatic-Device eingegeben und die Firmware-Datei ausgewählt werden. Dann wird das Update-Tool durch einen Klick auf den entsprechenden Button in "Bereitschaft" gesetzt und anschließend muss das HomeMatic-Gerät in den Update-Modus versetzt werden. Bei Unterputz-Geräten ist das eventuell gar nicht so einfach, man kann in diesem Fall aber von FHEM aus dem Gerät ein Kommando schicken um es in den Bootloader Modus zu bringen. Dies geht mit dem Befehl
:<code>set <device> fwUpdate onlyEnterBootLoader</code>
Direkt danach sollte das Update Tool mit seiner Arbeit beginnen.

Falls das Update-Tool beim Auswählen der Firmware-Datei abstürzt ("Home Matic Firmware Update Tool funktioniert nicht mehr"), dann stimmt wahrscheinlich etwas mit der Firmware-Datei nicht. Die Datei darf nicht ausgepackt, sondern muss als ".tar.gz"-Datei, so wie sie heruntergeladen wurde, benutzt werden. Es kann Probleme geben, wenn die Datei mit dem Internet Explorer heruntergeladen wurde. Am einfachsten ist es, die Datei mit einem anderen Browser herunterzuladen.

== Mögliche Probleme ==
Lässt sich die Firmware nicht OTA auf das HomeMatic-Device flashen, kann dies folgende Ursachen haben:
* Die FHEM-Software ist nicht auf dem neuesten Stand. Bitte vorher ein ''update'' durchführen.
* '''Entfernung''' zwischen Sender und Empfänger '''zu klein'''. 1,5 bis 2 m Abstand sollten beide Geräte zueinander mindestens haben.
* '''Entfernung''' zwischen Sender und Empfänger '''zu groß'''. Überprüfen Sie die RSSI-Werte des zu flashenden Device. Schlechter als - 70 sollten sie nicht sein (also keine - 75 oder noch kleiner). Ansonsten muss der Abstand für die Dauer des Flashens verringert werden.
* Durch wiederholte Firmware-Updates oder Update-Versuche hat die [[1% Regel]] zugeschlagen. Der dort genannte Notbehelf (Funkschnittstelle kurz stromlos machen) schafft Abhilfe.

== Tool zur Firmware Versionsprüfung ==
[[Datei:HM-FWUpdate-eQ3.png|mini|400px|left|Beispiel einer Liste der relevanten Firmware Updates<br />'''Legende:'''<br />1 - Link auf die eQ-3 Download-Seite <br />2 - Link auf die Details des HTTPMOD Device <br />3 - Link auf die Details des HomeMatic Device <br />4 - (Download) Link auf die Firmware Datei <br />5 - "reread": Aktualisierung dieser Liste auslösen]]
Im FHEM-Forum wurden unter dem Titel {{Link2Forum|Topic=47729|LinkText=...Firmware Versionsprüfung}} die erforderlichen Definitionen für ein [[HTTPMOD]]-Device vorgestellt, das
* für alle HomeMatic Devices der aktuellen FHEM-Umgebung
* die derzeit benutzte Firmware Version mit
* einem evtl. auf der eQ-3 Seite verfügbaren Update vergleicht und
* alle für die aktuelle Installation relevanten Updates in einer Übersicht (siehe Screenshot) darstellt und
* einmal täglich (alle 86400 Sekunden) automatisch ausgeführt wird; dieses Intervall sollte nicht verkürzt, sondern eher verlängert werden. Im Bedarfsfall kann durch anklicken von '''''reread''''' eine sofortige Aktualisierung ausgelöst werden.
<br clear="all">
{{Randnotiz|RNTyp=y|RNText=Sollte eine alte (vor dem 15.3.2016) Version dieser Definitionen bereits in Benutzung sein (zu erkennen am Vorhandensein von ''<nowiki>reading0[2|3|4|5]*</nowiki>''-Attributen), dann wird empfohlen, das Device mit <code>delete eq3</code> zunächst komplett zu löschen und anschließend neu anzulegen.}}
Die unten aufgeführten erforderlichen Anweisungen zur Erstellung dieser Übersicht sind
* im wesentlichen über das Webinterface eingebbar (können aber auch "en bloc" in die fhem.cfg eingetragen werden - auch wenn das eigentlich nicht empfohlen ist)
* der umfangreiche Perl-Code für das Attribut ''userReadings'' ist dargestellt für die Eingabe über das [[FHEMWEB|Webinterface]]
* für das Attribut ''stateFormat'' ist die mehrzeilige Eingabe (zumindest derzeit, März 2016) nicht unterstützt, daher wurde der Code in eine Subroutine ausgelagert
<br clear="all">{{Randnotiz|RNTyp=r|RNText='''Wichtige Änderungen:'''
22.05.2016 - ''reading01Regex'' und ''reading01Format'' angepasst (eQ-3)

02.09.2019 {{Link2Forum|Topic=78501|LinkText=...Firmware check funktioniert nicht}}
}}<br clear="all">

=== Definitionen in FHEM ===
Durch seine Historie zeigt dieser Artikel fast schon unfreiwillig die Vielfalt der Lösungswege in FHEM.
Die Beschreibung ist Modular:
* Basis
* schnell fertig mit attrTemplate
* Attribute mit der Raw Definition anlegen
* Weitere Attribute mit Perl Code in der 99_myUtils oder direkt in der DEF
Zunächst einfach nur eine Zeile für die grundlegende Definition.
<syntaxhighlight lang="text">
define eq3 HTTPMOD https://www.eq-3.de/ajax/downloads/downloads_eq3.php 604800
</syntaxhighlight>
=== Definitionen der Attribute mit attrTemplate ===
Ab September 2019 geht es ganz einfach weiter mit attrTemplate.
[[Datei:SetAttrTemplateEq3.png|tumb|400px|left|Menüauswahl set Befehl]]
<br>
<br>
* Hinter dem set Button findet man das Auswahlmenü mit attrTemplate an prominenter erster Stelle.
* In der weiteren Klappliste weit nach unten gehen, dort findet man ''CUL_HM_firmware_update_downloader''.
* Dieses Template auswählen, set drücken, etwas warten und fertig. Das Device wird selbständig gefüllt.
* Das Device wird dem Raum CUL_HM zugewiesen

Man kann den set Befehl auch in der Kommandozeile oder gemeinsam mit der obigen Definition in der Raw Definition importieren.
<syntaxhighlight lang="text">
set eq3 attrTemplate homematic_fw_check_v2

</syntaxhighlight>
'''Vorteil:''' Sollten sich in Zukunft Änderungen am Device ergeben (weil z.B. eq3 ihre Seite ändert) kann diese Änderung über update verteilt werden. Ein erneute Zuweisung bringt dann ein aktuelles Device.

'''Damit ist die Definition fertig!''' Alle weiteren Schritte hier stehen nur zur vollständigen Dokumentation.

=== Basis Definitionen manuell ===
Die folgende Attribute Basis Definition ist einfach über die Raw Def einzufügen.
<syntaxhighlight lang="text">
attr eq3 userattr enableControlSet event-on-change-reading event-on-update-reading reading01AutoNumLen reading01Format reading01Name reading01RegOpt reading01RegOpt:s,i,g reading01Regex readingMaxAge readingMaxAgeReplacementMode readingMaxAgeReplacementMode:text,expression,delete readingMaxAgeReplacementMode:text,reading,internal,expression,delete requestData.* showError showMatched stateFormat userReadings webCmd
attr eq3 alignTime 00:45
attr eq3 enableControlSet 1
attr eq3 event-on-change-reading .*
attr eq3 event-on-update-reading LAST_ERROR,MATCHED_READINGS
attr eq3 reading01AutoNumLen 2
attr eq3 reading01Format https://www.eq-3.de%s
attr eq3 reading01Name fw_link
attr eq3 reading01RegOpt gi
attr eq3 reading01Regex <a.href="(\/downloads\/software\/firmware\/hm[^"]+)
attr eq3 readingMaxAge 10
attr eq3 readingMaxAgeReplacementMode delete
attr eq3 requestData.* suchbegriff=&quelle=29&suchkategorie=3&themenbereich=1
attr eq3 room eq3
attr eq3 showError 1
attr eq3 showMatched 1
attr eq3 webCmd reread
</syntaxhighlight>
Es werden noch zwei Attribute benötigt, es gibt dabei die Varianten den Code direkt im Attribute einzugeben oder beide Attribute über eine Sub in die 99_myUtils.pm auszulagern. Wählt man die Variante mit der 99_myUtils muss man zuerst beide Subs dort einfügen und kann anschließend einfach diese beiden Zeil noch über die Raw Def einfügen
<syntaxhighlight lang="text">
attr eq3 stateFormat {eq3StateFormat($name)}
attr eq3 userReadings newFwForDevices:MATCHED_READINGS:.* {eq3Attr}
</syntaxhighlight>
=== Definition/Code für 99_myUtils.pm ===
Da der Code für ''userReadings'' und ''stateFormat'' recht umfangreich ist, ist es besser beides in (Sub-)Routinen in die [[99_myUtils anlegen|99_myUtils]] auszulagern:
<syntaxhighlight lang="perl">
sub eq3Attr{
#####################
# hier den Code für UserReadings einfügen
#####################
}
sub eq3StateFormat($) {
my $name = shift @_;
#####################
# hier den Code für eq3StateFormat($name) einfügen
#####################
}
</syntaxhighlight>
=== Definition/Code für Attribut userReadings ===
Die Definition für das Attribut ''userReadings'' :
<syntaxhighlight lang="perl">
attr eq3 userReadings newFwForDevices:MATCHED_READINGS:.* {\
# hier den Perl Code UserReadings einfügen\
}
</syntaxhighlight>
Perlcode UserReadings
<syntaxhighlight lang="perl">
my $ret = "";
my @data;
my @eq3FwList = map{@data = ReadingsVal("eq3","fw_link-".$_,"?") =~ m/Firmware\/(.*?)_update_V([\d_]+)_(\d\d)(\d\d)(\d\d)/i;
$data[0] =~ s/_/-/g;
sprintf("%s:%s:%s.%s.%s:%s",$data[0],$data[1],$data[4],$data[3],"20".$data[2],$_);
} ReadingsVal("eq3","MATCHED_READINGS","?") =~ m/fw_link-(\d\d)/g;

foreach my $dev (devspec2array("TYPE=CUL_HM:FILTER=DEF=......:FILTER=subType!=(virtual|)")) {
my $md = AttrVal($dev,"model","?");
my $v = AttrVal($dev,"firmware","0.0");
my ($h,$l) = split('\.',$v);
foreach my $newFw (grep m/^${md}:/i,@eq3FwList) {
my ($nh,$nl,$no,$date,$idx) = $newFw =~ m/^[^:]+:(\d+)_(\d+)_?(\d*):([^:]+):(\d\d)$/;
if(($nh > $h) || (($nh == $h) && ($nl > $l))) {
$ret .= "," if($ret ne "");
$ret .= $dev." (".$md." | fw_".$v." => fw".$idx."_".$nh.".".$nl.($no?sprintf(".%d",$no):"")." | ".$date.")";
}
}
}
return ($ret eq "")?"no fw-updates needed!":$ret;
</syntaxhighlight>

=== Definition/Code für Attribut stateFormat ===
Die Definition für das Attribut ''stateFormat'' :
<syntaxhighlight lang="perl">
attr eq3 stateFormat {\
# hier den Code für eq3StateFormat($name) einfügen\
}
</syntaxhighlight>
Perlcode eq3StateFormat($name)
<syntaxhighlight lang="perl">
my $ret ="";
my $lastCheck = ReadingsTimestamp($name,"MATCHED_READINGS","???");
$ret .= '<div style="text-align:left">';
$ret .= 'last <a title="eq3-downloads" href="http://www.eq-3.de/service/downloads.html">homematic</a>-fw-check => '.$lastCheck;
$ret .= '<br><br>';
$ret .= '<pre>';
$ret .= "| device | model | cur_fw | new_fw | release |<br>";
$ret .= "------------------------------------------------------------------------------------<br>";
my $check = ReadingsVal($name,"newFwForDevices","error => no or wrong data from eq3-server!");
if($check eq "no fw-updates needed!") {
$ret .= '| ';
$ret .= '<b style="color:green">';
$ret .= sprintf("%-80s",$check);
$ret .= '</b>';
$ret .= ' |';
} elsif($check eq "error => no or wrong data from eq3-server!") {
$ret .= '| ';
$ret .= '<b style="color:red">';
$ret .= sprintf("%-80s",$check);
$ret .= '</b>';
$ret .= ' |';
} else {
my @devices = split(',',$check);
foreach my $devStr (@devices) {
my ($dev,$md,$ofw,$idx,$nfw,$date) = $devStr =~ m/^([^\s]+)\s$([^\s]+)\s\|\sfw_(\d+\.\d+)\s=>\sfw(\d\d)_([\d\.]+)\s\|\s([^$]+)\)$/;
my $link = ReadingsVal($name,"fw_link-".$idx,"???");
$ret .= '| ';
$ret .= '<a href="/fhem?detail='.$dev.'">';
$ret .= sprintf("%-23s",$dev);
$ret .= '</a>';
$ret .= " | ";
$ret .= '<b'.(($md eq "?")?' title="missing attribute model => set device in teach mode to receive missing data" style="color:yellow"':' style="color:lightgray"').'>';
$ret .= sprintf("%-23s",$md);
$ret .= '</b>';
$ret .= " | ";
$ret .= '<b'.(($ofw eq "0.0")?' title="missing attribute firmware => set device in teach mode to receive missing data" style="color:yellow"':' style="color:lightgray"').'>';
$ret .= sprintf("%6s",$ofw);
$ret .= '</b>';
$ret .= " | ";
$ret .= '<a title="eq3-firmware.tgz" href="'.$link.'">';
$ret .= '<b style="color:red">';
$ret .= sprintf("%6s",$nfw);
$ret .= '</b>';
$ret .= '</a>';
$ret .= " | ";
$ret .= sprintf("%-10s",$date);
$ret .= " |<br>";
}
}
$ret .= '</pre>';
$ret .= '</div>';
return $ret;
</syntaxhighlight>

=== Sondersituationen ===
[[Datei:HM-FWUpdate-eQ3-check.png|mini|455px|right|Fehlerbedingung: Attribut ''firmware'' nicht gesetzt]]
Das Tool überprüft gleichzeitig auch bestimmte Rahmenbedingungen, so z.B., ob bei allen HomeMatic Devices die Attribute ''model'' und ''firmware'' gesetzt sind. Sollte das nicht der Fall sein, wird das Device in der Liste
* mit einem gelben "old_fw" Wert von 0.0 geführt; befindet sich der Mauszeiger über dem "0.0", wird der Hinweistext ''missing attribute firmware => set device in teach mode to receive missing data'' angezeigt (siehe Beispiel im Screenshot)
* mit einem gelben {{Taste|?}} in der Spalte "model" angezeigt; befindet sich der Mauszeiger über dem "?", wird der Hinweistext ''missing attribute model => set device in teach mode to receive missing data'' angezeigt
In diesem Fall sollte bei dem betreffenden Gerät versucht werden, mit ''getConfig'' die Daten zu aktualisieren bzw. vervollständigen.

Darüber hinaus ist zu beachten, dass die Firmware-Version in den HomeMatic Geräten zwei"teilig" (Version.Release) abgelegt ist, die Firmware Update-Dateien jedoch drei"teilige" Versionskennungen (Version_Release_???) haben. Für den Vergleich, ob neue Firmware verfügbar ist, kann natürlich nur die zweiteilige Kennung verwendet werden, eine Änderung im dritten Teil der Versionskennung kann daher nicht automatisch erkannt werden.

== Links ==
* [https://www.eq-3.de/service/downloads.html Firmware Download] Seite von eq-3
* Forenthread zur {{Link2Forum|Topic=47729|LinkText="Firmware Versionsprüfung"}}
* [http://git.zerfleddert.de/hmcfgusb/ Firmware Update Tool] von mgernoth

[[Kategorie:HomeMatic Components|1toolsAndWork]]
[[Kategorie:HOWTOS]]

Qnap NAS Ruhemodus/herunterfahren

2018-07-10T19:07:55Z

Suelle: falsche Schreibweise des Scripts am Ende des Eintrags korrigiert

Mit dieser Anleitung ist es möglich sein NAS über FHEM in den Ruhemodus zu versetzen. Dies ist ggf. sinnvoll, wenn man es nur bei Anwesenheit nutzt. Der Stromverbrauch lässt sich dadurch deutlich senken. Per WoL kann es bei Bedarf wieder gestartet werden.<br>
Dieser Artikel basiert auf einem [https://forum.fhem.de/index.php/topic,27539.msg204384.html Beitrag im Forum] und lässt sich sicherlich auch für andere NAS nutzen/anpassen.

== Idee ==
Das NAS kann nur über die Oberfläche oder eine Terminalsession auf dem NAS selbst in den Ruhemodus versetzt werden. Mittels einer SSH Verbindung vom FHEM Host zum NAS ist dies möglich. Da man das Administrationskennwort des NAS nicht im Klartext hinterlegen möchte, soll stattdessen ein SSH Key verwendet werden.

== Voraussetzungen ==
Das Kennwort des root Users auf dem FHEM Host muss bekannt sein.

Der User FHEM muss sich anmelden dürfen. Hierfür muss ggf. die Datei <code>/etc/passwd</code> angepasst werden:
sudo nano /etc/passwd
Dort muss der Eintrag <code>fhem:x:999:20::/opt/fhem:/bin/false</code> in <code>fhem:x:999:20::/opt/fhem:/bin/bash</code> geändert werden.<br>
'''Wichtig''': Dies sollte nach der vollständigen Einrichtung wieder rückgängig gemacht werden!

== SSH Key für User FHEM anlegen ==
Hierfür sind die Schritte unter [https://www.debian-administration.org/article/530/SSH_with_authentication_key_instead_of_password SSH with authentication key instead of password] zu befolgen und an die eigenen Gegebenheiten anzupassen.<br>
Auf dem FHEM Host muss der Public Key erstellt werde (Generate the authentication key). Hierfür muss der FHEM User genutzt werden:
<syntaxhighlight lang="perl">
su - root
su - fhem
</syntaxhighlight>
Nun folgen die Schritte aus der oben referenzierten Anleitung:
<syntaxhighlight lang="perl">
ssh-keygen
enter
enter
enter
ssh-copy-id -i /opt/fhem/ssh-keygen.pub admin@<IP eures Qnaps>
...
</syntaxhighlight>

Anschließend muss der Public Key auf dem NAS abgelegt werden. (Install the public key on the servers).

== Script in FHEM anlegen ==
Anlage der Datei über Terminal (putty o.ä.). Der erste Befehl erzeugt eine leere Datei, die anschließend dem User fhem zugeordnet wird und zum Schluss ausführbar gemacht wird.
<syntaxhighlight lang="perl">
sudo touch /opt/fhem/FHEM/shutdownNAS.sh && sudo chown -R fhem /opt/fhem/ && sudo chmod +x /opt/fhem/FHEM/shutdownNAS.sh
</syntaxhighlight>
Nun muss der Code des Scripts eingefügt werden. Dies kann entweder über die FHEM Oberfläche (Edit files) oder das Terminal erfolgen. Für letzteres lautet der Befehl:
<syntaxhighlight lang="perl">
sudo nano /opt/fhem/FHEM/shutdownNAS.sh
</syntaxhighlight>
Folgender Code muss eingefügt werden (die IP Adresse des eigenen NAS ist anzupassen):
<syntaxhighlight lang="perl">
#!/bin/bash
# shutdownNAS.sh

DATE=$(date +%Y.%m.%d)
TIME=$(date +%T)
echo $DATE $TIME "3: NAS in den Ruhemodus versetzen"

ssh admin@192.168.xxx.xxx "echo mem > /sys/power/state"
exit 0

</syntaxhighlight>

== Script ausführen ==
Es gilt zu beachten, dass FHEM als return eines solchen Scripts immer -1 ausgibt.<br>
Ebenso sollte bedacht werden, dass das Script nicht vollständig durchlaufen werden kann, da die Verbindung zum NAS verloren geht. Deshalb erfolgt der Aufruf des Scripts am Ende mit &.<br>
Das Script kann über die FHEM Oberfläche
<syntaxhighlight lang="perl">{system('/opt/fhem/FHEM/shutdownNAS.sh&')}</syntaxhighlight>
oder in einer 99_myUtils.pm
<syntaxhighlight lang="perl">system('/opt/fhem/FHEM/shutdownNAS.sh&');</syntaxhighlight>
ausgeführt werden.

== Links ==
* [https://forum.fhem.de/index.php/topic,27539.msg204384.html Beitrag im Forum]
* [https://www.debian-administration.org/article/530/SSH_with_authentication_key_instead_of_password SSH with authentication key instead of password]

[[Kategorie:HOWTOS]]

Qnap NAS Ruhemodus/herunterfahren

2017-02-08T19:38:18Z

Suelle:

Mit dieser Anleitung ist es möglich sein NAS über FHEM in den Ruhemodus zu versetzen. Dies ist ggf. sinnvoll, wenn man es nur bei Anwesenheit nutzt. Der Stromverbrauch lässt sich dadurch deutlich senken. Per WoL kann es bei Bedarf wieder gestartet werden.<br>
Dieser Artikel basiert auf einem [https://forum.fhem.de/index.php/topic,27539.msg204384.html Beitrag im Forum] und lässt sich sicherlich auch für andere NAS nutzen/anpassen.

== Idee ==
Das NAS kann nur über die Oberfläche oder eine Terminalsession auf dem NAS selbst in den Ruhemodus versetzt werden. Mittels einer SSH Verbindung vom FHEM Host zum NAS ist dies möglich. Da man das Administrationskennwort des NAS nicht im Klartext hinterlegen möchte, soll stattdessen ein SSH Key verwendet werden.

== Voraussetzungen ==
Das Kennwort des root Users auf dem FHEM Host muss bekannt sein.

Der User FHEM muss sich anmelden dürfen. Hierfür muss ggf. die Datei <code>/etc/passwd</code> angepasst werden:
sudo nano /etc/passwd
Dort muss der Eintrag <code>fhem:x:999:20::/opt/fhem:/bin/false</code> in <code>fhem:x:999:20::/opt/fhem:/bin/bash</code> geändert werden.<br>
'''Wichtig''': Dies sollte nach der vollständigen Einrichtung wieder rückgängig gemacht werden!

== SSH Key für User FHEM anlegen ==
Hierfür sind die Schritte unter [https://www.debian-administration.org/article/530/SSH_with_authentication_key_instead_of_password SSH with authentication key instead of password] zu befolgen und an die eigenen Gegebenheiten anzupassen.<br>
Auf dem FHEM Host muss der Public Key erstellt werde (Generate the authentication key). Hierfür muss der FHEM User genutzt werden:
<source lang="perl">
su - root
su - fhem
</source>
Nun folgen die Schritte aus der oben referenzierten Anleitung:
<source lang="perl">
ssh-keygen
enter
enter
enter
ssh-copy-id -i /opt/fhem/ssh-keygen.pub admin@<IP eures Qnaps>
...
</source>

Anschließend muss der Public Key auf dem NAS abgelegt werden. (Install the public key on the servers).

== Script in FHEM anlegen ==
Anlage der Datei über Terminal (putty o.ä.). Der erste Befehl erzeugt eine leere Datei, die anschließend dem User fhem zugeordnet wird und zum Schluss ausführbar gemacht wird.
<source lang="perl">
sudo touch /opt/fhem/FHEM/shutdownNAS.sh && sudo chown -R fhem /opt/fhem/ && sudo chmod +x /opt/fhem/FHEM/shutdownNAS.sh
</source>
Nun muss der Code des Scripts eingefügt werden. Dies kann entweder über die FHEM Oberfläche (Edit files) oder das Terminal erfolgen. Für letzteres lautet der Befehl:
<source lang="perl">
sudo nano /opt/fhem/FHEM/shutdownNAS.sh
</source>
Folgender Code muss eingefügt werden (die IP Adresse des eigenen NAS ist anzupassen):
<source lang="perl">
#!/bin/bash
# SH_shutdownNAS.sh

DATE=$(date +%Y.%m.%d)
TIME=$(date +%T)
echo $DATE $TIME "3: NAS in den Ruhemodus versetzen"

ssh admin@192.168.xxx.xxx "echo mem > /sys/power/state"
exit 0

</source>

== Script ausführen ==
Es gilt zu beachten, dass FHEM als return eines solchen Scripts immer -1 ausgibt.<br>
Ebenso sollte bedacht werden, dass das Script nicht vollständig durchlaufen werden kann, da die Verbindung zum NAS verloren geht. Deshalb erfolgt der Aufruf des Scripts am Ende mit &.<br>
Das Script kann über die FHEM Oberfläche
<source lang="perl">{system('/opt/fhem/FHEM/SH_shutdownNAS.sh&')}</source>
oder in einer 99_myUtils.pm
<source lang="perl">system('/opt/fhem/FHEM/SH_shutdownNAS.sh&');</source>
ausgeführt werden.

== Links ==
* [https://forum.fhem.de/index.php/topic,27539.msg204384.html Beitrag im Forum]
* [https://www.debian-administration.org/article/530/SSH_with_authentication_key_instead_of_password SSH with authentication key instead of password]

[[Kategorie:HOWTOS]]

Departure

2016-11-25T20:23:29Z

Suelle: kleine Korrekturen; Links

Departure ist ein Modul zur Anzeige der Abfahrtszeiten von Bahn, Bus, Zug und Fähre des öffentlichen Personennahverkehrs (ÖPNV).
Diese Seite basiert auf dem Beitrag im Forum https://forum.fhem.de/index.php?topic=48255.0 (von sbierman). Mittlerweile gibt es hierzu ein noch inoffizielles Modul https://forum.fhem.de/index.php?topic=60046.0 (von uniqueck).
Zusätzlich gibt es ein Widget für die FHEM Tablet UI (FTUI) https://forum.fhem.de/index.php?topic=48255.0 (von setstate).
Diese Seite sollte angepasst/überarbeitet werden, wenn das Modul 98_departure offiziell eingecheckt ist.

== Vorbereitung ==
Um die Abfahrtzeiten zu ermitteln wird der REST-Wrapper von sbiermann genutzt, der auf dem Dienst für die Android App "Öffi" basiert.
Für die Spätere Abfrage wird der Provider und die ID der Haltestelle benötigt. Beides kann wie folgt ermittelt werden.

<b>1. Ermitteln welche Provider gibt es und welcher ist für mich zuständig.</b>
<pre>http://transportrest-sbiermann.rhcloud.com/provider</pre>

Dieses liefert als Antwort im JSON Format:
<pre>
[{"name":"Sncb","aClass":"SncbProvider"},{"name":"Vbn","aClass":"VbnProvider"},{"name":"Wien","aClass":"WienProvider"},{"name":"Linz","aClass":"LinzProvider"},{"name":"Vrr","aClass":"VrrProvider"},{"name":"Oebb","aClass":"OebbProvider"},{"name":"Gvh","aClass":"GvhProvider"},{"name":"Ns","aClass":"NsProvider"},{"name":"Vao","aClass":"VaoProvider"},{"name":"Tfi","aClass":"TfiProvider"},{"name":"Vgn","aClass":"VgnProvider"},{"name":"Mvg","aClass":"MvgProvider"},{"name":"Pl","aClass":"PlProvider"},{"name":"Vgs","aClass":"VgsProvider"},{"name":"Nasa","aClass":"NasaProvider"},{"name":"Vbb","aClass":"VbbProvider"},{"name":"Ivb","aClass":"IvbProvider"},{"name":"Nvv","aClass":"NvvProvider"},{"name":"Mvv","aClass":"MvvProvider"},{"name":"Vagfr","aClass":"VagfrProvider"},{"name":"Vvv","aClass":"VvvProvider"},{"name":"Sf","aClass":"SfProvider"},{"name":"Vms","aClass":"VmsProvider"},{"name":"Sbb","aClass":"SbbProvider"},{"name":"Bsvag","aClass":"BsvagProvider"},{"name":"Jet","aClass":"JetProvider"},{"name":"Septa","aClass":"SeptaProvider"},{"name":"Bvb","aClass":"BvbProvider"},{"name":"Mersey","aClass":"MerseyProvider"},{"name":"Vvs","aClass":"VvsProvider"},{"name":"Nvbw","aClass":"NvbwProvider"},{"name":"Se","aClass":"SeProvider"},{"name":"Svv","aClass":"SvvProvider"},{"name":"Bahn","aClass":"BahnProvider"},{"name":"Vrs","aClass":"VrsProvider"},{"name":"Stockholm","aClass":"StockholmProvider"},{"name":"Vmv","aClass":"VmvProvider"},{"name":"Stv","aClass":"StvProvider"},{"name":"Sydney","aClass":"SydneyProvider"},{"name":"Paris","aClass":"ParisProvider"},{"name":"Dsb","aClass":"DsbProvider"},{"name":"Rt","aClass":"RtProvider"},{"name":"Dub","aClass":"DubProvider"},{"name":"Bvg","aClass":"BvgProvider"},{"name":"Paca","aClass":"PacaProvider"},{"name":"Vor","aClass":"VorProvider"},{"name":"FrenchSouthWest","aClass":"FrenchSouthWestProvider"},{"name":"Avv","aClass":"AvvProvider"},{"name":"Zvv","aClass":"ZvvProvider"},{"name":"Nri","aClass":"NriProvider"},{"name":"Invg","aClass":"InvgProvider"},{"name":"Eireann","aClass":"EireannProvider"},{"name":"Vbl","aClass":"VblProvider"},{"name":"Vvo","aClass":"VvoProvider"},{"name":"Sh","aClass":"ShProvider"},{"name":"Kvv","aClass":"KvvProvider"},{"name":"Bayern","aClass":"BayernProvider"},{"name":"Atc","aClass":"AtcProvider"},{"name":"Lu","aClass":"LuProvider"},{"name":"Italy","aClass":"ItalyProvider"},{"name":"Vvm","aClass":"VvmProvider"},{"name":"Met","aClass":"MetProvider"},{"name":"Ding","aClass":"DingProvider"},{"name":"Tlem","aClass":"TlemProvider"},{"name":"Vvt","aClass":"VvtProvider"},{"name":"Vrn","aClass":"VrnProvider"}]
</pre>
Das was bei Name steht wird verwendet, der Wert aClass ist intern und braucht hier nicht weiter verwendet werden. Im Beispiel haben die Verkehrsbetriebe Stuttgart (VVS) den Namen "Vvs".

<b>2. Ermitteln der StationId für die Haltestelle deren Abfahrtszeiten ich gerne haben möchte. In diesem Beispiel die Haltstelle "SSB-Zentrum"</b>
<pre>
http://transportrest-sbiermann.rhcloud.com/station/suggest?q=SSB-Zentrum&provider=Vvs
</pre>
Dieses liefert als Antwort im JSON Format:
<pre>
[{"type":"STATION","id":"5000350","lat":48726856,"lon":9129721,"place":"Stuttgart","name":"SSB-Zentrum","products":null,"lonAsDouble":9.129721,"latAsDouble":48.726856,"identified":true},{"type":"STATION","id":"5002601","lat":48722757,"lon":9129058,"place":"Stuttgart","name":"Industriestraße (SSB-Zentrum)","products":null,"lonAsDouble":9.129058,"latAsDouble":48.722757,"identified":true}]
</pre>
Wie man sehen kann gibt es mehrere Treffer für SSB-Zentrum. Es wird aber nur der Typ "STATION" benötigt und somit lautet die StationId "5000350".

<b>3. Abfrage der Departure Zeiten für die Haltestelle "SSB-Zentrum". Diese liefert die Daten im passenden Format für das zugehörige departure Widget für FTUI</b>
<pre>
http://transportrest-sbiermann.rhcloud.com/departureFHEM?from=6930306&provider=Vvs
</pre>
dieses liefert als Antwort im passenden Format:
<pre>
[["U8","Vaihingen","3"],["U12","Dürrlewang","6"],["U8","Ostfildern","5"],["U3","Vaihingen","6"],["U12","Hallschlag","7"],["U3","Plieningen","9"],["U8","Vaihingen","12"],["U12","Dürrlewang","17"],["U8","Waldau","15"],["U3","Vaihingen","16"]]
</pre>
Die Zeiten sind immer inklusive Verspätung angegeben, sofern der Provider diese Daten mit sendet.

== Einbindung in FHEM ==
Wie in der Einleitung erwähnt gibt es aktuell zwei Wege, die Abfahrtszeiten einzubinden: über HTTPMOD oder über das noch inofizielle Modul 98_departure
<pre>
define myDeparture HTTPMOD none 0
attr myDeparture get01Name SSB-Zentrum
attr myDeparture get01URL http://transportrest-sbiermann.rhcloud.com/departureFHEM?from=6930306&provider=Vvs
attr myDeparture get01Regex (\[\[.*\]\]).*
attr VAG timeout 30
</pre>
Es können mehrere Haltestellen in einem Device hinterlegt werden, hierzu einfach die drei Attribute get01Name, get01URL und get01Regex duplizieren und durchnummerieren. Dabei müssen natürlich Name und URL angepasst werden.
Bei dieser Konfiguration erfolgt die Aktualisierung über das FTUI Widget!

== Links ==
* [https://forum.fhem.de/index.php/topic,48255.0.html Forum: Neues FTUI Widget - Departure]
* [https://forum.fhem.de/index.php?topic=60046.0 Forum: Modul 98_Departure: Bereitstellung von Abfahrtszeiten an einem Bahnhof]
* [http://www.fhemwiki.de/wiki/FHEM_Tablet_UI#departure Wiki: FHEM Tablet UI - Departure]

[[Kategorie:HOWTOS]]
[[Kategorie:Code Snippets]]
[[Kategorie:Modul (Inoffiziell)]]

FHEM Tablet UI

2016-11-25T20:10:04Z

Suelle: Departure hinzugefügt

{{Infobox Modul
|ModPurpose=Oberfläche für Fhem
|ModType=x
|ModFTopic=34233
|ModForumArea=Frontends
|ModTechName=n.a.
|ModOwner=setstate ({{Link2FU|7023|Forum}})
}}
[[Datei:tablet_ui.png|200px|thumb|right|Fhem Tablet UI]]
FHEM Tablet UI ist ein leichtgewichtiges aber funktionsreiches Framework zum Steuern und Überwachen von in Fhem integrierten Geräten. Zahlreiche Widgets können sehr flexibel und leicht per HTML Code konfiguriert werden.

In dieser Anleitung wird die Installation und Konfiguration des FHEM Tablet UI beschrieben.

{{Todo|alle Widgets hier übernehmen, Übersetzung, weitere Beispiele aus dem Forum einfügen (evtl. mit Link!?)}}

== Voraussetzungen ==
Das User Interface hat sehr wenige Anforderungen für den Betrieb. Es benötigt <u>keine</u> zusätzliche Frameworks, wie z.B. PHP oder MySQL.

Voraussetzungen ist eine Fhem Installation mit HTTPSRV Modul. Das UI kann mit den gängigen Browsern Betriebssystem unabhängig genutzt werden oder mit dem Webviewcontrol.
Das Interface wird dabei in dem FHEM eigenen Webserver ausgeführt. Mit wenigen Anpassungen ist es auch möglich das UI auf anderen Webservern (Apache, u.a.) zu betreiben, dann kann FHEM und UI auch auf getrennten Systemen ausgeführt werden.

== Installation ==
* Im Befehls-Eingabefeld eingeben: <code><nowiki>update all https://raw.githubusercontent.com/knowthelist/fhem-tablet-ui/master/controls_fhemtabletui.txt</nowiki></code>
* Im Befehls-Eingabefeld eingeben: <code>define TABLETUI HTTPSRV ftui/ ./www/tablet Tablet-UI</code>
* Im Verzeichnis ./fhem/www/tablet die Datei index-example.html in index.html umbenennen oder eine neue index.html erzeugen und diese index.html wie nachfolgend beschrieben editieren.

Das UI ist über den Link "Tablet-UI" auf der Fhem-Hauptseite oder durch Direktaufruf der URL "<nowiki>http://<Fhem-url>:8083/fhem/tablet/index.html</nowiki>" zu erreichen.

Hinweise zu einer manuellen Installation und weitere Infos sind auf der Projektseite https://github.com/knowthelist/fhem-tablet-ui zu finden.

== Update ==
* Prüfen der Änderungen seit dem letzten Download/Update durch Eingabe von: <code><nowiki>update check https://raw.githubusercontent.com/knowthelist/fhem-tablet-ui/master/controls_fhemtabletui.txt</nowiki></code>
* Update des UI durch Eingabe von: <code><nowiki>update all https://raw.githubusercontent.com/knowthelist/fhem-tablet-ui/master/controls_fhemtabletui.txt</nowiki></code>

Über
<code><nowiki>update add https://raw.githubusercontent.com/knowthelist/fhem-tablet-ui/master/controls_fhemtabletui.txt</nowiki></code>
kann seit dem 24.12.2015 die URL zum normalen Updatebefehl von FHEM hinzugefügt werden. Mit einen "update check" sieht man dann gleich alle Updates aus beiden "Welten".

== Weitere Widgets ==

=== Widgets for Fhem-tablet-ui ===
Zusätzlich zu den bei der Installation des Tablet UI direkt zur Verfügung stehenden Widgets, gibt es eine weitere Widget-Quelle von nesges unter https://github.com/nesges/Widgets-for-fhem-tablet-ui. Die Widgets aus dieser Quelle müssen für eine Nutzung separat installiert werden.

Dazu folgenden Befehl in die Fhem-Befehlszeile eingeben: <code><nowiki>update all https://raw.githubusercontent.com/nesges/Widgets-for-fhem-tablet-ui/master/controls_widgets-for-fhem-tablet-ui.txt</nowiki></code>.

Näheres zur Installation unter [https://github.com/nesges/Widgets-for-fhem-tablet-ui/wiki/Installation Wiki: Installation].

Die Dokumentation der einzelnen Widgets befindet sich ebenfalls [https://github.com/nesges/Widgets-for-fhem-tablet-ui/wiki im Github-Wiki].

== Konfiguration ==
'''META-Parameter'''

Das Tablet UI lässt sich über die META-Parameter konfigurieren. Mit den meisten META-Parametern kann das verhalten des UI beeinflusst werden. Diese Parameter befinden sich in der jeweiligen '''.html''' Datei (z.B. index.html) im Abschnitt '''<head>'''. Nachfolgend sind die verschiedenen Konfigurationsparameter aufgeführt. Die Parameter sind immer gleich aufgebaut.

:<code><meta name="<META-Parameter>" content="<Wert>"></code>

{| class="wikitable"
|-
! META-Parameter !! Wert / Beispiel !! Erklärung
|-
| longpoll || 1 oder 0 || Refresh sofort, alle 15 Minuten ein voller Refresh (shortpoll) statt alle 30 Sekunden ein voller Refresh.
|-
| gridster_disable || 1 oder 0 || Drag&Drop der Gridster-Elemente auf der Seite deaktivieren.
|-
| toast || 1 oder 0 || Toast messages deaktivieren
|-
| fhemweb_url || http://meinFhemServer:8083/fhem || Wird benötigt wenn der Webserver des TabletUI nicht auf dem FHEM Server läuft.
|-
| widget_margin || 1 bis 9999 || Abstände der Gridsterelemente verändern.
|-
| widget_base_width || 1 bis 9999 || Größe des Basis-Rasters (data-sizey=1/data-sizex=1) verändern.
|-
| widget_base_height || 1 bis 9999 || Größe des Basis-Rasters (data-sizey=1/data-sizex=1) verändern.
|}

'''CSS-Styles'''

Das Layout und das Aussehen des UI kann durch diverse vorgegebene CSS-Klassen beeinflusst werden. Die verfügbaren Klassen sind im Abschnitt [[#CSS Class description|CSS Class description]] oder [[#Positioning|Positioning]] aufgeführt. Es besteht auch die Möglichkeit eine eigene CSS Datei zu erstellen und darüber Änderungen am aussehen des UI vorzunehmen. Die eigenen CSS Datei würde bei einem Update unverändert bleiben. Daher ist abzuraten ein CSS Datei die mit dem UI Update verteilt wird zu modifizieren. Die eigene CSS Datei ist unter '''/fhem/tablet/css''' mit dem Namen '''fhem-tablet-ui-user.css''' zu finden. Sollte diese nicht vorhanden sein kann die Datei manuell erstellt werden.
Wird keine eigene CSS-Datei verwendet empfiehlt es sich den folgenden Eintrag im <head> der jeweiligen .html Datei zu entfernen, bzw. in Kommentar gesetzt werden um Probleme beim Laden der Seite zu verhindern.

:<code><link rel="stylesheet" href="/fhem/tablet/css/fhem-tablet-ui-user.css" /></code>

== Farbe ==
Es besteht die Möglichkeit, die Farbwerte in hexadezimaler Form oder als RGB-Wert anzugeben. Zum Beispiel: Hex: #A3CFA3 RBG: rgb(163, 207, 163).

Knallige Farben wie #ff0000 für Rot oder #00ff00 für Grün sollten vermieden werden. Es ist besser unterhalb von #D0 (208) für die Grundfarben zu bleiben.

Hilfreich bei der Suche nach den Farbwerten ist der color picker: http://www.w3schools.com/tags/ref_colorpicker.asp

== CSS Class description ==

Not all widgets support all classes

* readonly : changing of state is not allowed
* wider : 25px extra space for the widget to the top
* narrow : shorter distant to the widget above
* w1x, w2x, w3x : set the widget to a fix width: 1x, 2x, 3x width
* mini : lowest diameter for volume widget
* small : font 80% size (label), small diameter for volume widget
* medium : font 120% size
* large : font 150% size
* big : font 200% size
* bigplus : font 270% size
* bigger : font 320% size
* bigger.thin : font 450% size
* grande : font 600% size
* gigantic: font 144px size + 120px line-height
* thin : font thin
* darker : forecolor in gray
* hue-tick : draw ticks in color range
* hue-front : draw handle in color range
* hue-back : draw background in color range
* dim-tick : draw ticks in brightness range
* dim-front : draw handle in brightness range
* dim-back : draw background in brightness range
* red : foreground color red
* green : foreground color green
* blue : foreground color blue
* doublebox-v : container to place 2 small widgets (e.g. switch) one above the other
* doublebox-h : container to place 2 small widgets (e.g. switch) side by side
* timestamp : deliver the date time for the reading instead the value
* inline : positioning elements in a row, no line break
* top-space : 15px extra on top (top-space-2x -> 30px; top-space-3x -> 45px)
* left-space : 15px extra on left (left-space-2x -> 30px; left-space-3x -> 45px)
* right-space : 15px extra on right (right-space-2x -> 30px; right-space-3x -> 45px)
* blink : blink animatation for label or symbol widget
* verticalLine : Vertikale Line am rechten Rand

== Positioning ==

*container : new box or new row
*col-x-y : new column with x/y of width (col-1-3,col-2-3,col-1-2,col-1-4,col-1-8,col-1-5,col-2-5,col-3-5,col-4-5)
*inline : positioning elements in a row, no line break
*top-space : 15px extra on top (top-space-2x -> 30px; top-space-3x -> 45px)
*left-space : 15px extra on left (left-space-2x -> 30px; left-space-3x -> 45px)
*right-space : 15px extra on right (right-space-2x -> 30px; right-space-3x -> 45px)
*top-narrow : -15px closer on top (top-narrow-2x -> -30px; top-narrow-10 -> -10px)
*centered : horizontal centered
*left-align : align text left
*left : floating left
*right-align : align text right
*right : floating right
*wider : 15px extra space for the widget all around
*narrow : shorter distant to the widget above
*fullsize : 100% in width and height

== Widgets -- Konfiguration ==

Teilweise dokumentierte Widgets:
* [https://github.com/nesges/Widgets-for-fhem-tablet-ui/wiki/button button]: Variante der push und switch Widgets, die entweder einen URL ansteuern oder einen Fhem-Befehl absetzen kann.
* [[#chart|chart]]: chart with similar capabilities as the FHEM plots
* checkbox:
* [[#circlemenu|circlemenu]]: Mehrere Widgets hinter einem Widget verborgen, trotz des 'circle' im Namen kann das Menue jetzt auch horizontal oder vertikal ausgeklappt werden
* [https://github.com/nesges/Widgets-for-fhem-tablet-ui/wiki/clicksound clicksound]: Mit dem Widget "clicksound" können Sounds an Click-Events von Elementen gebunden werden.
* [https://github.com/nesges/Widgets-for-fhem-tablet-ui/wiki/clock clock]: Das Widget "clock" stellt eine einfach Uhr zur verfügung.
* colorwheel:
* daytimepicker:
* [[#departure|departure]]: show timetable of public transport provider
* [[#dimmer|dimmer]]: toogle button with a setter for on value
* eventmonitor:
* highchart:
* [[#homestatus|homestatus]]: selector for 4 states (1=home, 2=night, 3=away, 4=holiday)
* [https://github.com/nesges/Widgets-for-fhem-tablet-ui/wiki/iframe iframe]]: Widget zum Einbinden externer Inhalte in einem Iframe.
* [[#image|image]]: insert an image, the URL is given by a reading
* input:
* [https://github.com/nesges/Widgets-for-fhem-tablet-ui/wiki/itunes_artwork itunes_artwork]: itunes_artwork durchsucht die iTunes-Datenbank anhand eines Arrays von beliebigen Suchworten nach einem Cover-Artwork und zeigt dieses an.
* [https://github.com/nesges/Widgets-for-fhem-tablet-ui/wiki/javascript javascript]: Ermöglicht die Ausführung beliebigen Javascript-Codes aus einem Reading.
* [https://github.com/nesges/Widgets-for-fhem-tablet-ui/wiki/joinedlabel joinedlabel]: verbindet mehrere Readings zu einem Feld
* [https://github.com/nesges/Widgets-for-fhem-tablet-ui/wiki/klimatrend klimatrend]: wandelt Daten aus dem statistics-Modul in einen Pfeil um, der den aktuellen Trend anzeigt.
* Knob:
* [https://github.com/nesges/Widgets-for-fhem-tablet-ui/wiki/kodinowplaying kodinowplaying]: zeigt Informationen zu grade in KODI gespielten Medien in Form eines Labels an.
* [[#label|label]]: STATE als Text anzeigen
* [[#level|level]]: vertical/horizontal bar to show values between min/max value
* link:
* [https://github.com/nesges/Widgets-for-fhem-tablet-ui/wiki/mpdnowplaying mpdnowplaying]: zeigt Titelinformationen eines per MPD-Modul angebundenen Music Player Daemon an.
* [https://github.com/nesges/Widgets-for-fhem-tablet-ui/wiki/multistatebutton multistatebutton]: Variante des push-Widgets das den set-Befehl abhängig vom gelesenen Status ändert.
* [[#pagetab|pagetab]]: Element to smoothly exchange the whole page with another page
* pagebutton:
* [[#playstream|playstream]]: Abspielen eines Webradio-Streams per Button
* [[#popup|popup]]: a popup dialog which open on click on another widget
* [[#progress|progress]]: round symbolic display for percent values
* [[#push|push]]: send any command to Fhem e.g. up / down
* range:
* readingsgroup:
* [https://github.com/nesges/Widgets-for-fhem-tablet-ui/wiki/reload reload]: auslösen eine Pagereloads
* [[#rotor|rotor]]: Umschalten von zwei oder mehr Widgets an einer Position
* [[#select|select]]: Combobox to provide a list for selection
* [https://github.com/nesges/Widgets-for-fhem-tablet-ui/wiki/settimer settimer]: zum anzeigen und einstellen einer Uhrzeit.
* [[#simplechart|simplechart]]: simple XY line chart for one value (reads directly from Fhem log file)
* [[#slider|slider]]: vertical slider to select between min/max value
* spinner:
* swiper:
* [[#switch|switch]]: Toggle any command to Fhem (e.g. on / off)
* [[#symbol|symbol]]: State als Symbol darstellen (z.B. Fenster offen)
* [[#thermostat|thermostat]]: dial for heater thermostates to set desired value and show current value
* [[#volume|volume]]: dial to set a single value (e.g. 0-60)
* [[#weather|weather]]: insert an icon or image, represending a weather literal
* [https://github.com/svenson08/ftui-weekdaytimer-widget weekdaytimer]: Visualisierung des [[WeekdayTimer]] Modul
* [https://github.com/nesges/Widgets-for-fhem-tablet-ui/wiki/wind_direction wind_direction]: Zeigt die Windrichtung auf einer Windrose an.

Ein Demo der Widgets findet ihr [http://knowthelist.github.io/fhem/tablet/demo_widgets.html Hier].
----------------------------------

Für alle Widgets gilt:
{| class="wikitable"
|+allgemeine Attribute
|-
!align="right" |data-type
|Widget-Typ
|-
!align="right" |data-device
|Fhem-Name des Gerätes (mit dem Befehl 'list' bekommt man im Fhem die kpl. Liste)
|-
!align="right" |class
|CSS-Klassen für Aussehen und Formatierung des Widgets
|-
|}

{| class="wikitable"
|+Daten Empfangen
|-
!align="right" |data-get
|Reading Name
|-
!align="right" |data-get-on
|Wert für den Status on
|-
!align="right" |data-get-off
|Wert für den Status off
|-
|}

{| class="wikitable"
|+Daten Senden
|-
!align="right" |data-set
|Reading Name
|-
!align="right" |data-set-on
|Wert für den Status on
|-
!align="right" |data-set-off
|Wert für den Status off
|-
|}

<div id="chart">'''CHART'''</div>

{| class="wikitable"
!HTML Attribut
!Beschreibung
!Default Wert
|-
!align="right" |data-logdevice
|name of the logdevice (e.g. FileLog_WohnzimmerHeizung) or array of names if more than one graph shall be displayed
|-
|-
!align="right" |data-logfile
|name of the logfile (e.g. WohnzimmerHeizung-2015.log) or or array of names if more than one graph shall be displayed
|'-' or omitting this data means current logfile
|-
!align="right" |data-columnspec
|definition for how to find the values (e.g. "4:meas.*:1:int") or or array of columnspecs if more than one graph shall be displayed
|-
|-
!align="right" |data-style
|name of the graph style to be used (e.g. 'SVGplot l0' or 'ftui l0dash') or or array of styles if more than one graph shall be displayed using different stlyes. The standard fhem plot styles can be used furthermore there are some more predefined styles existing (details see css file). Own styles can be specified e.g. in the fhem-table-ui-user.css file.
|-
|-
!align="right" |data-ptype
|name of the plot type (e.g. 'lines' or 'fa-cog') or or array of plottypes if more than one graph shall be displayed. All fhem plot styles are supported. Additionally it is possible to specify symbols (currently supported are font awesome ('fa-...'), open automation ('oa-...') and fhem symbols ('fs-...')). Can also be something like 'icon:1' in which case the respective columnspec should result in links to icons (e.g. for weather forecast) and the y-value is taken from the graph number 1
|'lines'
|-
!align="right" |data-uaxis
|name of the axis to be used ('primary' or 'secondary') or or array of axis' to be used if more than one graph shall be displayed. The 'primary' axis is labelled on the left side, the 'secondary' axis is labelled on the right side
|'primary'
|-
!align="right" |data-legend
|caption of the graph (used in the legend and at the cursor) or an array of legend texts if more than one graph shall be displayed.
|-
|-
!align="right" |data-minvalue
|min Y value to Show or an array of values for dynamic minY for primary axis. A value of 'auto' means that the value is calculated from the data displayed dynamically
|10
|-
!align="right" |data-minvalue_sec
|min Y value to Show or an array of values for dynamic minY for secondary axis. A value of 'auto' means that the value is calculated from the data displayed dynamically
|'auto'
|-
!align="right" |data-maxvalue
|max Y value to Show or an array of values for dynamic maxY for primary axis. A value of 'auto' means that the value is calculated from the data displayed dynamically
|30
|-
!align="right" |data-maxvalue_sec
|max Y value to Show or an array of values for dynamic maxY for secondary axis. A value of 'auto' means that the value is calculated from the data displayed dynamically
|'auto'
|-
!align="right" |data-yticks
|value distance between Y tick lines (related to primary axis). A value of 'auto' means that the value is calculated from the data displayed dynamically. Can be an array containing value pairs in order to have arbitrary text for given values (e.g. data-yticks='[[0,"open"],[1,"closed"]]')
|'auto'
|-
!align="right" |data-yticks_sec
|value distance between Y tick lines (related to secondary axis). A value of 'auto' means that the value is calculated from the data displayed dynamically.Can be an array containing value pairs in order to have arbitrary text for given values (e.g. data-yticks_sec='[[0,"open"],[1,"closed"]]')
|'auto'
|-
!align="right" |data-xticks
|time range between each X tick lines (in minutes). A value of 'auto' means that the value is calculated from the data displayed dynamically
|'auto'
|-
!align="right" |data-daysago_start
|number of days back from now for the start of the plot (0 means the plot starts from today 0:00). Additionally the x-axis start value can be set here unsing standard data formats like ('2013-10-23'), the time portion of the string is only used when <code>data-nofulldays</code> is 'true'. If the setting ends with 'w', 'W', 'm', 'M', 'y', 'Y' the nuber given is interpreted as week, month or year respectively (capital letters mean rounding to full weeks, months years) (e.g. '2Y' means that, if current date is 3.6.2015, the graph will start 1.1.2013).
|0
|-
!align="right" |data-daysago_end
|number of days back from now for the end of the plot (-1 means the plot ends today 24:00). Additionally the x-axis end value can be set here unsing standard data formats like ('2013-10-23'), the time portion of the string is only used when <code>data-nofulldays</code> is 'true'. If the setting ends with 'w', 'W', 'm', 'M', 'y', 'Y' the nuber given is interpreted as week, month or year respectively (capital letters mean rounding to full weeks, months years) (e.g. '2Y' means that, if current date is 3.6.2015, the graph will end 31.12.2013).
|-1
|-
!align="right" |data-timeformat
|setting for the formatting of the x-tick text. The format can be configured in a quite flexible way. Several format classifiers are supported which are separated by special characters ('-', '.', '/', ' ', ':', ',', '\'). All characters despite '\' will be displayed in the final output.
The following is a list of supported classifiers:
* 'LF'enters a linefeed
* 'mm' - displays minutes as 2 digits
* 'hh' - displays hours as 2 digits
* 'dd' - displays day of the month as 2 digits
* 'MM' - displays months as 2 digits (e.g. 02 for February)
* 'MMM' - displays months as 3 characters (e.g. Dec for December)
* 'MMMM' - displays monhts as full names (e.g. March)
* 'ee' - displays weekdays as 2 digits (e.g. 00 for Sunday)
* 'eee' - displays weekdays as 3 characters (e.g. Mon for Monday)
* 'eeee' - displays weekdays as full names (e.g. Tuesday)
* 'yy' - displays years as 2 digits (e.g. 16 as 2016)
* 'yyyy' - displays years as 4 digits
For example a string given as 'MMM\LF\yyyy' will display 'Jan' in one line and '2016' in a second one. A string given as 'MM.dd 2016' will display '03.05 2016'.
|-
|-
!align="right" |data-nofulldays
|switch to activate/deactivate rounding of the xaxis start and end values to full days ('true' or 'false')
|'false'
|-
!align="right" |data-ytext
|text to be shown besides the primary y axis.
|-
|-
!align="right" |data-ytext_sec
|text to be shown besides the secondary y axis.
|-
|-
!align="right" |data-yunit
|unit of the value to show beside of each Y ticks for primary y axis.
|-
|-
!align="right" |data-crosshair
|switch to activate/deactivate the crosshair cursor ('true' or 'false')
|'false'
|-
!align="right" |data-cursorgroup
|number to define coupling of the crosshair cursor. The cursors of all charts having the same number are coupled and move together.
|-
|-
!align="right" |data-scrollgroup
|number to define coupling of the scrolling (shift and zoom). All charts having the same number are scrolled (shifted and zoomed) together.
|-
|-
!align="right" |data-showlegend
|switch to activate/deactivate the initial display of the legend window ('true' or 'false')
|'false'
|-
!align="right" |data-legendpos
|array of two values (horizontal and vertical) to set the initial position of the legend window. Allowed values are "left", "right" or a number giving the position in percent for the first parameter (horizontal position) and 'top', 'bottom' or a number giving the position in percent for the second parameter (vertical position).
|'["top","right"]'
|-
!align="right" |data-yunit_sec
|unit of the value to show beside of each Y ticks for secondary y axis.
|-
|-
!align="right" |data-width
|fixed size for width (in % or px)
|-
|-
!align="right" |data-height
|fixed size for height (in % or px)
|-
|-
!align="right" |data-graphsshown
|boolean to define if graphs are activated (shown) initially or an array of booleans if more than one graph shall be displayed.
|-
|-
!align="right" |data-ddd
|setting for 3D display. Array with 3 angles for rotation of the 3D chart in x, y, z (z not yet supported) (e.g. '["40","60","0"]'). If the array is existing, there will be 2 additional buttons on top for changing rotation in x and y.
|-
|-
!align="right" |data-dddspace
|setting for the space between different graphs in y direction if 3D is activated (space given in pixels).
|15
|-
!align="right" |data-dddwidth
|setting for the width of the graphs if 3D is activated (width given in pixels).
|10
|-
!align="right" |data-title
|setting for inclusion of chart title on top of the chart. Includes the possibility for calculation of values like in SVG Plots (e.g. data-title="Min: $data{mindate4}, Max: $data{maxdate4}, Last: $data{currdate4}"). Supported are:
* min1: minimum value of graph 1 (first graph in the given list). Number can be any graph or omitted if calculation shall be done over all graphs.
* max1: maximum value of graph 1 (first graph in the given list)
* avg1: average value of graph 1 (first graph in the given list)
* cnt1: number of values of graph 1 (first graph in the given list)
* currval1: last (current) value of graph 1 (first graph in the given list)
* mindate1: minimum x value of graph 1 (first graph in the given list)
* maxdate1: maximum x value of graph 1 (first graph in the given list)
* currdate1: last (current) x value of graph 1 (first graph in the given list)
|''
|-
!align="right" |class
|fullsize, noticks, nobuttons, small, normal, big
|-
|-
|}

<code>data-logfile</code> can be omitted in this case the default value "-" will be used. This means that the current logfile is going to be used.

There are several buttons that control the dynamic behaviour of the chart. The <-, ->, + and - buttons shift and zoom the displayed data. The "legend" and "cursor" buttons are switching on and off the display of the legend window and the crosshair cursor respectively. If 3D display is activated (see above) 2 more buttons control the rotation in x and y.

When the legend window is displayed, a click on the legend text shows/hides the respective graph. The legend window can be dragged to other positions on desktop browsers (currently not yet working for iOS and Android).

The crosshair cursor currently only works dynamically on desktop browsers. On iOS and Android you have to tap on the screen to set the cursor to a new position.

Three classes define default values for the texts (small, normal, big). Additionally there is a number of css styles that control the visible appearance of the chart. The following classes are supported:

{| class="wikitable"
!CSS class name
!Description
|-
!.chart-background
|Color etc. for the chart background
|-
!.text.axes
|Font and color for the chart axes
|-
!.buttons
|Size and color for the buttons (shift etc.)
|-
!.gridlines
|Size and color for gridlines generally
|-
!.xaxis
|Font, size and color for xaxis
|-
!.yaxis
|Font, size and color for yaxis
|-
!.xticks
|Font, size and color for xticks
|-
!.yticks
|Font, size and color for yticks
|-
!.crosshair
|Font, size and color (foreground/background) for the crosshair cursor
|-
!.caption
|Font, size and color for text buttons for legend and cursor switching
|-
!.legend
|Font, size and background color for legend window
|-
|-
|}

[[#Beispiel_chart|Link zu einem Beispiel]]

<div id="circlemenu">'''CIRCLEMENU'''</div>

{| class="wikitable"
!HTML Attribut
!Beschreibung
!Default Wert
|-
!align="right" |data-item-diameter
|diameter of the circle
|52
|-
!align="right" |data-circle-radius
|radius of each item, in pixel
|70
|-
!align="right" |data-direction
|position of the items in relation to the center
|'full'
|-
!align="right" |data-close-after
|closing time of the circle-menu
|(item-count + 1s) or a minimum of 4s
|-
!align="right" |class
|keepopen
|
|-
|}

Optionen für data-direction: top | right | bottom | left | top-right | top-left | bottom-right | bottom-left | top-half | right-half | bottom-half | left-half | full | vertical | horizontal

[[#Beispiel_circlemenu|Link zu einem Beispiel]]

<div id="departure">'''DEPARTURE'''</div>

{| class="wikitable"
!HTML Attribut
!Beschreibung
!Default Wert
|-
!align="right" |data-type
|widget-type; must be departure
|
|-
!align="right" |data-device
|name of the device to get data from
|
|-
!align="right" |data-get
|name of the reading of device to get data from
|
|-
!align="right" |data-icon
|define icon for widget
|
|-
!align="right" |data-interval
|interval to reload automatically
|
|-
!align="right" |class
|choose style of widget; see example
|
|-
|}

[[#Beispiel_departure|Link zu einem Beispiel]]

<div id="dimmer">'''DIMMER'''</div>

{| class="wikitable"
!HTML Attribut
!Beschreibung
!Default Wert
|-
!align="right" |data-get
|name of the reading to get from Fhem
|'STATE'
|-
!align="right" |data-get-on
|value for ON status to get
|'on'
|-
!align="right" |data-get-off
|value for OFF status to get
|'off'
|-
!align="right" |data-set
|(<command> <device> <reading> <value>)
|
|-
!align="right" |data-set-on
|value for ON status to set
|value of data-get-on
|-
!align="right" |data-set-off
|value for OFF status to set
|value of data-get-off
|-
!align="right" |data-cmd
|name of the command (<command> <device> <value>) (e.g. setstate, set, setreading, trigger)
|'set'
|-
!align="right" |data-dim
|name of the reading responsible for dim (<command> <device> <reading> <value>)
|value of data-get-on
|-
!align="right" |data-icon
|name of the font-awesome icon
|fa-lightbulb-o
|-
|}

[[#Beispiel_dimmer|Link zu einem Beispiel]]

<div id="homestatus">'''HOMESTATUS'''</div>

{| class="wikitable"
!HTML Attribut
!Beschreibung
!Default Wert
|-
!align="right" |data-get
|name of the reading to get from Fhem
|'STATE'
|-
!align="right" |data-set
|command to send to Fhem (<code>set <device> <command> <value></code>)
|''
|-
!align="right" |data-get-on
|array of states using for get
|['1','2','3','4']
|-
!align="right" |data-set-on
|array of states using for set.
|value of data-get-on
|-
!align="right" |data-alias
|array of fix names to show only in the UI as an alias to the real states
|''
|-
!align="right" |data-icons
|array of icons related to the data-get-on array
|''
|-
!align="right" |data-version
|name of the status model e.g. 'residents','roommate','guest'
|(default NULL)
|-
|}

The default version has 4 states: '1','2','3','4' The default aliases are 'Home','Night','Away','Holiday'; data-version='residents' or 'roommate' or 'guest' has 5 states ('home','asleep','absent','gone','gotosleep') They have these aliases 'Home','Night','Away','Holiday','Retire'

[[#Beispiel_homestatus|Link zu einem Beispiel]]

<div id="image">'''IMAGE'''</div>

{| class="wikitable"
!HTML Attribut
!Beschreibung
!Default Wert
|-
!align="right" |data-get
|name of the reading to get an URL from Fhem
|'STATE'
|-
!align="right" |data-size
|width of the image in px or %, the height scales proportionally
|50%
|-
!align="right" |data-url
|URL of the image to show (use data-url or data-device + data-get, not both)
|
|-
!align="right" |data-refresh
|Interval in seconds for image refresh for usage together with data-url
|900
|-
|}

[[#Beispiel_image|Link zu einem Beispiel]]

=== Widget LABEL ===
<div id="label">'''LABEL'''</div>

Mit dem LABEL Widget kann der STATUS eines Device in Textform angezeigt werden. Dabei kann das die Farbe des Anzeigetext abhängig von dessen Wert festgelegt werden.

Neben den '''allgemeine Attribute''' besitzt das LABEL-Widget die nachfolgenden Attribute.

{| class="wikitable"
!HTML Attribut
!Beschreibung
!Default Wert
|-
!align="right" |data-get
|Name des Readings in FHEM
|
|-
!align="right" |data-fix
|Eine bestimmte Anzahl an Dezimalstellen
|'-1' -> non-numeric
|-
!align="right" |data-part
|split position of the space separated value to show or an RegEx
|
|-
!align="right" |data-color
| fix color attribute or DEVICE:READING for dynamic setting of label color
| ''
|-
!align="right" |data-colors
|a array of color values to affect the colour of the label according to the limit value
|
|-
!align="right" |data-limits-get
|name of the DEVICE:Reading to colorize the label
|data-device:data-get
|-
!align="right" |data-limits
|an array of numeric values to affect the colour of the Label
|
|-
!align="right" |data-limits-part
|part number of the space separated value to show or a RegEx
|'-1' -> all
|-
!align="right" |data-unit
|add a unit after a numeric value. use encoded strings e.g. "%B0C%0A"
|
|-
!align="right" |data-substitution
|regex-substitution to apply on the value. Standard regex notation (s/regex/subst/modifier) is expected
|
|-
!align="right" |data-hide
|string to compare with current value. hide element when it's value equals data-hide
|
|-
!align="right" |data-hideparents
|jquery selector to hide element's parents too
|
|-
!align="right" |class
|small, large, big, bigger, thin, red, green, blue, darker, timestamp, w1x, w2x, w3x, fixedlabel, icon, bg-limit
|
|}

Mit der Class 'fixedlabel' kann man Label einbauen, die einen festen Text (direkt im HTML) haben, aber trotzdem die Farbe per Reading Value beeinflusst werden könnte.<br>
Mit der Class 'icon' kann man Label einbauen, die wie Icons aussehen. Als Hintergrund gibt es 'icon round' (rund), 'icon square' (Rechteck mit abgerundeten Ecken) und 'icon squareborder' (Rechteck mit abgerundeten Ecken und einem zusätzlichen Rand).<br>
Mit der Class 'bg-limit' wird der Hintergrund des Icon auf grün oder rot gesetzt, passend zum on/off Status des data-limits.
Use data-color OR data-colors + data-limits, not both.

With class="bg-limit" it changes the background color not the forecolor according data-limits

class="icon square" or class="icon round" forces the label to a fix width and height in icon style

Special layout can be achieved by overwriting of following classes in the fhem-tablet-ui-user.css:

.label-precomma .label-comma .label-aftercomma .label-unit

e.g.: .label-aftercomma{ font-size:40%; left: 4px; top: -25px; position: relative; }

Functions for data-substitution:

Array of replacements
RegEx-substitution to apply on the value. Standard regex notation (s/regex/subst/modifier) is expected
data-substitution="weekdayshort"
JS functions data-substitution="toDate().ddmm()" - convert to day:month
data-substitution="toDate().hhmm()" - convert to hour:minutes

data-substitution="toDate().hhmmss()" - convert to hour:minutes:secondes

data-substitution="toDate().eeee()" - convert to name of the week day

data-substitution="toDate().ago()" - convert to time span

[[#Beispiel_label|Link zu einem Beispiel]]

=== Widget LEVEL ===
<div id="level">'''LEVEL'''</div>

{| class="wikitable"
!HTML Attribut
!Beschreibung
!Default Wert
|-
!align="right" |data-get
|name of the reading to get from Fhem
|'STATE'
|-
!align="right" |data-min
|minimal value to set
|'0'
|-
!align="right" |data-max
|maximal value to set
|'100'
|-
!align="right" |data-on
|value where the slider moves to max
|'on'
|-
!align="right" |data-off
|value where the slider moves to min
|'off'
|-
!align="right" |data-part
|part number of the space separated value to show or an RegEx
|
|-
!align="right" |data-colors
|a array of color values to affect the colour of the label according to the limit value
|
|-
!align="right" |data-limits
|a array of numeric or RegEx values to affect the colour of the label
|
|-
!align="right" |class
|mini, horizontal
|
|-
|}

[[#Beispiel_level|Link zu einem Beispiel]] (fehlt noch)

<div id="pagetab">'''PAGETAB'''</div>

{| class="wikitable"
!HTML Attribut
!Beschreibung
!Default Wert
|-
!align="right" |data-url
|URL of the new page to show
|
|-
!align="right" |data-icon
|name of the font-awesome icon
|'fa-power-off'
|-
!align="right" |data-background-icon
|name of the font-awesome icon for background
|''
|-
!align="right" |data-on-background-color
|color of ON state
|'#aa6900'
|-
!align="right" |data-off-background-color
|color of OFF state
|'#505050'
|-
!align="right" |data-on-color
|color of ON state
|'#aa6900'
|-
!align="right" |data-off-color
|color of Off state
|'#505050'
|-
!align="right" |data-get-on
|array of status to assign a special icon-list from data-icons
|
|-
!align="right" |data-icons
|array of icons related to the a data-get-on array
|
|-
!align="right" |class
|warn, activate (as additionals for data-icons)
|
|-
|}

[[#Beispiel_pagetab|Link zu einem Beispiel]]

<div id="playstream">'''PLAYSTREAM'''</div>

{| class="wikitable"
!HTML Attribut
!Beschreibung
!Default Wert
|-
!align="right" |data-url
|URL des Radio-Streams
|-
!align="right" |data-get
|name of the reading to get the control state from FHEM
|'STATE'
|-
!align="right" |data-get-on
|value for PLAY status to get.
|'on'
|-
!align="right" |data-get-off
|value for STOP status to get.
|'off'
|-
!align="right" |data-volume
|name of the reading to get the volume value (0-100)
|volume
|-
|}

[[#Beispiel_playstream|Link zu einem Beispiel]]

<div id="popup">'''POPUP'''</div>

{| class="wikitable"
!HTML Attribut
!Beschreibung
!Default Wert
|-
!align="right" |data-get
|name of the reading where to get the alert value from
|'STATE'
|-
!align="right" |data-get-on
|value which trigger to open the dialog
|'on'
|-
!align="right" |data-off
|value which trigger to close the dialog
|'off'
|-
!align="right" |data-width
|fixe size for width (in % or px)
|
|-
!align="right" |data-height
|fixe size for height (in % or px)
|
|-
|}

[[#Beispiel_popup|Link zu einem Beispiel]]

<div id="progress">'''PROGRESS'''</div>

{| class="wikitable"
!HTML Attribut
!Beschreibung
!Default Wert
|-
!align="right" |data-get
|name of the reading to get from Fhem
|'STATE'
|-
!align="right" |data-max
|maximal value to set or name of the reading which helds the max value
|100
|-
!align="right" |class
|novalue, percent
|
|-
|}

[[#Beispiel_progress|Link zu einem Beispiel]] (fehlt noch)

<div id="push">'''PUSH'''</div>

{| class="wikitable"
!HTML Attribut
!Beschreibung
!Default-Wert
|-
!align="right" |data-set
| name of the reading to set on FHEM (<command> <device> <reading> <value>)
|
|-
!align="right" |data-set-on
|value to send when the the button get pressed oder ein Array zwischen dessen Werten umgeschaltet werden kann
|
|-
!align="right" |data-icon
|name of the font-awesome icon
|
|-
!align="right" |data-background-icon
|name of the font-awesome icon for background
|'fa-circle'
|-
!align="right" |data-cmd
|name of the command (<command> <device> <value>) (e.g. setstate, set, setreading, trigger)
|'set'
|-
!align="right" |data-doubleclick
|timeout to wait for a second click or touch. '0' disables the doubleclick feature.
|0
|-
!align="right" |data-countdown
|secondes for the countdown progress control
|autodetect from 'on-for-timer' command
|-
!align="right" |data-background-icon
|name of the font-awesome icon for background
|
|-
!align="right" |data-off-background-color
|fix color attribute for OFF state or DEVICE:READING for dynamic setting
|#505050
|-
!align="right" |data-off-color
|fix color attribute for Off state or DEVICE:READING for dynamic setting
|#505050
|-
|}

'data-set-on' can also be an array of values to toggle between this values

[[#Beispiel_push|Link zu einem Beispiel]]

<div id="rotor">'''ROTOR'''</div>

{| class="wikitable"
!HTML Attribut
!Beschreibung
!Default Wert
|-
!align="right" | data-delay
|time in millisecondes to wait until next list item get shown
|3500
|-
!align="right" |class
|fade, rotate
|''
|-
|}
Ohne Angabe von class erfolgt keine Animation.

[[#Beispiel_rotor|Link zu einem Beispiel]]

<div id="select">'''SELECT'''</div>

{| class="wikitable"
!HTML Attribut
!Beschreibung
!Default Wert
|-
!align="right" |data-get
|name of the reading that get the selected item of the list
|
|-
!align="right" |data-set
|name of the reading to set on Fhem (<command> <device> <reading> <value>)
|''
|-
!align="right" |data-list
|name of the reading to get a :-separated list from Fhem
|''
|-
!align="right" |data-items
|an array of fix items to show in the selection box (alternative if data-list is empty)
|
|-
!align="right" |data-alias
|an array of fix names to show only in the selection box as an alias to the real items
|
|-
!align="right" |data-cmd
|name of the command to send to Fhem (<command> <device> <reading> <value>) (e.g. setstate, set, setreading, trigger)
|'set'
|-
!align="right" |data-quote
|characters to enclose the send value
|
|-
!align="right" |class
|wider, w1x, w2x, w3x, large, big
|
|-
|}

[[#Beispiel_select|Link zu einem Beispiel]]

<div id="simplechart">'''SIMPLECHART'''</div>

{| class="wikitable"
!HTML Attribut
!Beschreibung
!Default Wert
|-
!align="right" |data-logdevice
|name of the logdevice (e.g. FileLog_WohnzimmerHeizung)
|
|-
!align="right" |data-logfile
|name of the logfile (e.g. WohnzimmerHeizung-2015.log)
|'-' means current logfile
|-
!align="right" |data-columnspec
|definition for how to find the values (e.g. "4:meas.*:1:int")
|''
|-
!align="right" |data-minvalue
|min Y value to Show or an array of values for dynamic minY
|10
|-
!align="right" |data-maxvalue
|max Y value to Show or an array of values for dynamic maxY
|30
|-
!align="right" |data-yticks
|value distance between Y tick lines
|5
|-
!align="right" |data-xticks
|time range between each X tick line (in Minuten)
|360 minutes
|-
!align="right" |data-daysago
|number of days back from now
|0
|-
!align="right" |data-caption
|name of the chart to show as text
|
|-
!align="right" |data-yunit
|unit of the value to show beside of each Y ticks
|
|-
!align="right" |data-width
|fixe size for width (in % or px)
|
|-
!align="right" |data-height
|fixe size for height (in % or px)
|
|-
!align="right" |class
|fullsize, noticks
|
|-
|}

[[#Beispiel_simplechart|Link zu einem Beispiel]] (fehlt noch)

<code>data-logfile</code> kann man auch weglassen, dann greift der Defaultwert "-". Damit wird das neuste Logfile gelesen.

<div id="slider">'''SLIDER'''</div>

{| class="wikitable"
!HTML Attribut
!Beschreibung
!Default Wert
|-
!align="right" |data-get
|name of the reading to get from Fhem
|'STATE'
|-
!align="right" |data-set
|command to send to Fhem (<code>set <device> <command> <value></code>)
|''
|-
!align="right" |data-cmd
|name of the command (<command> <device> <value>) (e.g. setstate, set, setreading, trigger)
|'set'
|-
!align="right" |data-min
|minimal value to set
|0
|-
!align="right" |data-max
|maximal value to set
|100
|-
!align="right" |data-step
|step value
|1
|-
!align="right" |data-on
|value where the slider moves to max
|'on'
|-
!align="right" |data-off
|value where the slider moves to min
|'off'
|-
!align="right" |data-get-value
|RegEx to retrieve the value or part number of the space separated input to get the value
|'-1': all of the input
|-
!align="right" |data-set-value
|Format of the value to send to FHEM
|'$v': the value only
|-
!align="right" |data-width
|width for horizontal sliders
|'120px', for mini '60px'
|-
!align="right" |data-height
|height for vertical sliders
|'120px', for mini '60px'
|-
!align="right" |data-color
|color for quantity range
|'#aa6900'
|-
!align="right" |data-background-color
|color for range bar
|#404040
|-
!align="right" |class
|Aussehen/Ausrichtung
|
|-
|}

Für class steht mini, horizontal und negated (0 liegt oben) zur Verfügung.

[[#Beispiel_slider|Link zu einem Beispiel]]

<div id="switch">'''SWITCH'''</div>

{| class="wikitable"
!HTML-Attribut
!Beschreibung
!Default-Wert
|-
!align="right" |data-get
|Name des Reading, was gelesen werden soll
|'STATE'
|-
!align="right" |data-set
|Name des Reading, was gelesen werden soll
|'STATE'
|-
!align="right" |data-cmd
|Kommando Name (<command> <device> <value>) <br />(z.B setstate, set, setreading, trigger)
|'set'
|-
!align="right" |data-doubleclick
|timeout to wait for x millisecondes click or touch. '0' disables the doubleclick feature.
|'0'
|-
|}
Einstellung bei zwei Werten

{| class="wikitable"
!HTML-Attribut
!Beschreibung
!Default-Wert
|-
!align="right" |data-get-on
|Wert, bei dem zum Status ON geschaltet werden soll.
|'on'
|-
!align="right" |data-get-off
|Wert, bei dem zum Status OFF geschaltet werden soll.
|'off'
|-
!align="right" |data-set-on
|Wert, der zu Fhem gesendet werden soll, wenn das Widget auf ON geschaltet wurde
|Wert von data-get-on
|-
!align="right" |data-set-off
|Wert, der zu Fhem gesendet werden soll, wenn das Widget auf OFF geschaltet wurde
|Wert von data-get-off
|-
!align="right" |data-icon
|Name des Font-Awesome Icon.
|'fa-lightbulb-o'
|-
!align="right" |data-background-icon
|Name des Font-Awesome Hintergrund Icon.
|'fa-circle'
|-
!align="right" |data-on-background-color
|Hintergrundfarbe beim Status on oder DEVICE:Reading bei dynamischen Einstellungen
|'#aa6900'
|-
!align="right" |data-off-background-color
|Hintergrundfarbe beim Status off oder DEVICE:Reading bei dynamischen Einstellungen
|'#505050'
|-
!align="right" |data-on-color
|Widget Farbe beim Status ON
|'#aa6900'
|-
!align="right" |data-off-color
|Widget Farbe beim Status OFF
|'#505050'
|-
|}

Einstellung bei mehreren Werten
{| class="wikitable"
!HTML-Attribut
!Beschreibung
!Default-Wert
|-
!align="right" |data-states
|Array mit Status Angaben
|
|-
!align="right" |data-set-states
|Array mit Status Angaben, die gesetzt werden sollen
|
|-
!align="right" |data-icons
|Array Icons zum zuvor definierten Status
|
|-
!align="right" |data-background-icons
|Array mit Hintergrund Icons zum zuvor definierten Status
|
|-
!align="right" |data-colors
|Array mit Farben zum zuvor definierten Status
|
|-
!align="right" |data-background-colors
|Array mit Hintergrund Farben zum zuvor definierten Status
|
|-
!align="right" |class : readonly
|Es wird nur der Status angezeigt und kann nicht geändert werden
|
|-
|}

<code>data-get-on</code> and <code>data-get-off</code> accept also RegEx values. e.g. data-get-on="[0-9]{1,3}|on" means set switch on if STATE is a numeric value or 'on'. data-get-off="!on" means accept all but the data-get-on value (negation)

[[#Beispiel_switch|Link zu einem Beispiel]]

=== Widget SYMBOL ===
<div id="symbol">'''SYMBOL'''</div>

Mit dem SYMBOL Widget kann der STATUS eines Device dargestellt werden. Dabei kann das angezeigte Symbol und dessen Farbe bestimmt werden. Wie bei anderen Widgets kann das Symbol und die Farbe vom State abhängig konfiguriert werden. Das SYMBOL-Widget dient nur zur Anzeige eines STATUS, es besitzt kein Möglichkeit der Interaktion.

Neben den '''allgemeine Attribute''' besitzt das SYMBOL-Widget die nachfolgenden Attribute.

dual state notation
{| class="wikitable"
! HTML Attribut !! Beschreibung !! Default Wert
|-
| data-get || Name des Reading, was gelesen werden soll || 'STATE'
|}

Einstellung bei zwei Werten
{| class="wikitable"
!HTML-Attribut !! Beschreibung !! Default-Wert
|-
|'''data-get-on''' ||Wert für on ||'open'
|-
|'''data-get-off''' ||Wert für off ||'closed'
|-
|'''data-icon''' ||Name des Symbols ||'ftui-window'
|-
|'''data-background-icon''' ||Hintergrundsymbol ||'''leer'''
|-
|'''data-on-background-color''' ||Farbe für ON-Zustand. ||'#aa6900'
|-
|'''data-off-background-color''' ||Farbe für OFF-Zustand. ||'#505050'
|-
|'''data-on-color''' ||Farbe für ON-Zustand. ||'#aa6900'
|-
|'''data-off-color''' ||Farbe für OFF-Zustand. ||'#505050'
|-
|}

Einstellung bei mehreren Werten

{| class="wikitable"
!HTML Attribut
!Beschreibung
!Default Wert
|-
!align="right" |data-states
|Array für states.
|
|-
!align="right" |data-icons
|Array mit Icons zu data-states Array
|
|-
!align="right" |data-background-icons
|Array mit Icons zu data-states Array
|
|-
!align="right" |data-colors
|Array mit Farben zu data-states aArray
|''
|-
!align="right" |data-background-colors
|Array mit Hintergrundfarben zu data-states array
|''
|-
|}

data-get-on,data-get-off and data-states accept also RegEx values. The value for one icon can also contain an additional animatation CSS name, e.g. "fa-exclamation-triangle fa-blink" for a blinking Symbol

[[#Beispiel_symbol|Link zu einem Beispiel]]

=== Widget THERMOSTAT===
<div id="thermostat">'''THERMOSTAT'''</div>

{| class="wikitable"
!HTML Attribut
!Beschreibung
!Default Wert
|-
!align="right" |data-get
|name of the reading to get from Fhem
|'desired-temp'
|-
!align="right" |data-temp
|reading for measured temperature of thermostates
|'measured-temp'
|-
!align="right" |data-set
|command to send to Fhem (set <device> <command> <value>)
|'desired-temp'
|-
!align="right" |data-valve
|reading for valve position of thermostates
|
|-
!align="right" |data-min
|minimal value to set
| 10
|-
!align="right" |data-max
|maximal value to set
| 30
|-
!align="right" |data-minColor
|Farbe des Keises für Min
| #4477FF
|-
!align="right" |data-maxColor
|Farbe des Kreises für Max, zwischen Min und Max wird linear interpoliert
| #FF0000
|-
!align="right" |data-step
|step size for value adjustment e.g. 0.5
|1
|-
!align="right" |data-bgColor
|Die Farbe der Kreises zwischen den ticks
|'transparent'
|-
!align="right" |data-fgColor
|Die Farbe der zahl im Kreismittelpunkt
|#bbbbbb
|-
!align="right" |data-tkColor
|Die Farbe der ticks
|#696969
|-
|-
!align="right" |data-angleOffset
|Start der ticks im Kreis (in Winkelgraden, 0 = oben)
| -120
|-
!align="right" |data-angleArc
|Bereich der ticks im Kreis (in Winkelgraden)
|240
|-
!align="right" |class
|big, readonly
|
|-
|}

[[#Beispiel_thermostat|Link zu einem Beispiel]]

<div id="volume">'''VOLUME'''</div>

{| class="wikitable"
!HTML Attribut
!Beschreibung
!Default Wert
|-
!align="right" |data-get
|name of the reading to get from Fhem
|'STATE'
|-
!align="right" |data-set
|command to send to Fhem (set <device> <command> <value>)
|''
|-
!align="rigth" |data-cmd
|name of the command (<command> <device> <value>) (e.g. setstate, set, setreading, trigger)
|'set'
|-
!align="right" |data-min
|minimal value to set
|0
|-
!align="right" |data-max
|maximal value to set
|70
|-
!align="right" |data-get-value
|RegEx to retrieve the value or part number of the space separated input to get the value
|'-1': all of the input
|-
!align="right" |data-set-value
|Format of the value to send to FHEM
|'$v': the value only
|-
!align="right" |data-tickstep
|distance between ticks
|4|20
|-
!align="right" |data-unit
|add a unit after the desired value.
|
|-
!align="right" |class
|mini, small, big, bigger, hue-tick, hue-front, hue-back, dim-tick ,dim-front, dim-back, readonly
|
|-
|}

[[#Beispiel_volume|Link zu einem Beispiel]] (fehlt noch)

<div id="weather">'''WEATHER'''</div>

{| class="wikitable"
!HTML Attribut
!Beschreibung
!Default Wert
|-
!align="right" |data-get
|name of the reading to get the weather literal from Fhem
|'STATE'
|-
!align="right" |data-imageset
|collection of images to display current weather situation. Possible values: 'meteocons', 'kleinklima'
|'meteocons'
|-
!align="right" |data-image-path
|path to the images of the selected imageset
|/images/weather/
|-
|}

[[#Beispiel_weather|Link zu einem Beispiel]]

== Widgets -- Beispiele ==

<div id="Beispiel_chart">'''Chart'''</div>

Display a chart with similar capabilities as the FHEM plots

<pre>
<div data-type="chart"
data-logdevice='["Log.Garden","Log.Garden","Log.Garden","Log.Predicted"]'
data-columnspec='["4:Garden.T:15:","10:Garden.T:0:delta-h","10:Garden.T:0:delta-d","4:predicted.*:15:"]'
data-style='["ftui l0fill","ftui l1fill","ftui l2","ftui l3dot"]'
data-ptype='["lines","histeps","histeps","cubic"]'
data-uaxis='["primary","secondary","secondary","primary"]'
data-legend='["Temperature","Rain/hour","Rain/day","Predicted Temp."]'
data-yunit="°C"
data-ytext="Temperature"
data-minvalue="auto"
data-maxvalue="auto"
data-yunit_sec="mm"
data-ytext_sec="Rain (mm)"
data-height="250"
data-yticks="auto"
data-minvalue_sec="auto"
data-maxvalue_sec="auto"
data-nofulldays="true"
data-daysago_start="2013-08-13T00:00:00"
data-daysago_end="2013-08-14T00:00:00"
data-cursorgroup="1"
data-scrollgroup="1"
data-xticks="auto">
</div>
</pre>

[[Datei:chart_tabletUI.png]]

<div id="Beispiel_circlemenu">'''Circlemenu'''</div>

Cover a lot of other button behind one single button

<pre>
<div class="left">
<div data-type="circlemenu" class="cell circlemenu">
<ul class="menu">
<li><div data-type="push" data-icon="fa-wrench"></div></li>
<li><div data-type="push" data-device="AvReceiver"
data-set="remoteControl subwoofer-temporary-level -6"
data-icon="">-6</div></li>
<li><div data-type="push" data-device="AvReceiver"
data-set="remoteControl subwoofer-temporary-level -2"
data-icon="">-2</div></li>
<li><div data-type="push" data-device="AvReceiver"
data-set="remoteControl subwoofer-temporary-level 0"
data-icon="">0</div></li>
<li><div data-type="push" data-device="AvReceiver"
data-set="remoteControl subwoofer-temporary-level +3"
data-icon="">2</div></li>
<li><div data-type="push" data-device="AvReceiver"
data-set="remoteControl subwoofer-temporary-level +9"
data-icon="">9</div></li>
<li><div data-type="push" data-device="AvReceiver"
data-set="remoteControl subwoofer-temporary-level +C"
data-icon="">12</div></li>
</ul>
</div>
<div data-type="label" class="cell">Woofer</div>
</div>
</pre>

[[Datei:circlemenu_tabletUI.png]]

<div id="Beispiel_departure">'''Departure'''</div>

Departure Widget Beispiel

Minimalvariante
<pre>
<div data-type="departure"
data-device="vvs"
data-get="SSB-Zentrum"
data-icon="fa-train"
data-interval="0">
</div>
</pre>

Optionen für class
<pre>
class="" : default Style (grau)
class="DVB" anderer Style (gelb)
class="VVO" : anderer Style (blau)
class="alternate" : alternierender Hintergrund
class="deptime" : Abfahrtszeit statt Minuten
</pre>

weiteres Beispiel
<pre>
<div data-type="departure"
data-device="vvs"
data-get="SSB-Zentrum"
data-icon="fa-train"
data-interval="0"
class="DVB deptime alternate">
</div>
</pre>

<div id="Beispiel_dimmer">'''Dimmer'''</div>

Dimmer Widget Beispiel für Philips Hue

Minimalvariante
<pre>
<div data-type="dimmer" data-device="HUEDevice1"
data-get-on="!off" data-get-off="off"
data-set="pct"</div>
</pre>

Mit Anzeige der Dimstufe
<pre>
<div data-type="dimmer" data-device="HUEDevice1"
data-get="onoff"
data-get-on="1" data-get-off="0"
data-set=""
data-set-on="on" data-set-off="off"
data-dim="pct">
</div>
</pre>

Dimmer Widget für MilightDevice

<pre>
<div data-type="dimmer"
data-device="SonstWas"
data-get="brightness"
data-get-off="0"
data-get-on="[1-9][0-9]*"
data-set-on="on"
data-set-off="off"
data-dim="dim"
data-min="0"
data-max="100"
></div>
</pre>

<div id="Beispiel_homestatus">'''Homestatus'''</div>

Beispiel rechts im Bild:
<pre>
<div data-type="homestatus" data-device='dummy1'
data-get-on='["1","2","3","4"]'
data-alias='["Home","Night","Away","Holiday"]'
data-icons='["fa-home","fa-bed","fa-car","fa-suitcase"]'>
</div>
</pre>

Beispiel links im Bild:
<pre>
<div data-type="homestatus" data-device='dummy1'
data-get-on='["home","asleep","absent","gone","gotosleep"]'
data-alias='["Home","Night","Away","Holiday","Retire"]'
data-icons='["fa-fire","fa-film","fa-plus","fa-car","fa-tint"]'
data-version='residents'>
</div>
</pre>

[[Datei:homestatus_tabletUI.png]]

<div id="Beispiel_image">'''Image'''</div>

Erzeugt ein Widget mit einem Bild aus dem www, das alle 5 Sekunden aktualisiert wird (hier eine Wetterkarte vom DWD).

<pre>
<div data-type="image"
data-size="80%"
data-url="http://www.dwd.de/wundk/wetter/de/Deutschland.jpg"
</div>
</pre>

[[Datei:image_tabletUI.jpg]]

Example for how to add an image to the dashboard which its URL is delivered by a Fhem module like PROPLANTA:

<pre>
<div data-type="image" data-device="Wetter1"
data-get="fc0_weatherDayIcon"
data-size="40px"
class="cell">
</div>
</pre>

<div id="Beispiel_label">'''Label'''</div>

Example for HM-WDS40-TH-I Funk-Temperatur-/Feuchtesensor innen

<pre>
STATE T: 20.0 H: 61
</pre>
<pre>
<div data-type="label" data-device="THSensorWZ"
data-part="2" data-unit="%B0C%0A" class="cell big"></div>
<div data-type="label" class="cell">Temperatur</div>
<div data-type="label" data-device="THSensorWZ" data-part="4"
data-unit="%" class="cell big"></div>
<div data-type="label" class="cell">Luftfeuchte</div>
</pre>

But the same result can reached by getting single readings:
<pre>
humidity 58
temperature 20.1
</pre>

<pre>
<div data-type="label" data-device="THSensorWZ"
data-get="temperature" data-unit="%B0C%0A" class="cell big"></div>
<div data-type="label" class="cell">Temperatur</div>
<div data-type="label" data-device="THSensorWZ"
data-get="humidity" data-unit="%" class="cell big"></div>
<div data-type="label" class="cell">Luftfeuchte</div>
</pre>

Example for how to influence the color of the label according to value limits
<pre>
<div data-type="label"
data-device="OutTemp"
data-limits='[-73,10,23]'
data-colors='["#6699FF","#AA6900","#FF0000"]'
data-unit="%B0C%0A"
class="cell big">
</div>
</pre>

Example for how to create a widget for shutter via push: show state and set up/down
<pre>
<div data-type="switch"
data-device="wzRollo"
data-get-on="up"
data-get-off="down"
data-icon="fa-bars"
class="cell" >
</div>
<div data-type="label"
class="cell">Rollo</div>
</pre>

Example for how to create a label for a time value in short format with usage of RegEx.

<pre>
<div data-type="label"
data-device="dummy1"
data-part="(\d\d\.\d\d\.).*"
class="cell">
</div>
</pre>

Example for how to show two labels in one line.

<pre>
<div class="">
<div type="label" device="OnSunrise" class="inline"></div>bis
<div type="label" device="OnSunset" class="inline"></div>
</div>
</pre>

Beispiel für die Anzeige des UV-Indexes und der Abhängigkeit der anzuzeigenden Farbe.

<pre>
<div data-type="label" class="wider cell bigger" data-device="ProVorhersage"
data-get="fc0_uv"
data-limits="[-2, 2, 5, 7, 10]"
data-colors='["#66FF33","#FFFF00","#FF6600","#FF0000","#993399"]'></div>
<div data-type="label" class="cell" data-device="ProVorhersage" data-get="fc0_date"></div>
<div data-type="label" class="wider cell bigger" data-device="ProVorhersage"
data-get="fc1_uv"
data-limits="[-2, 2, 5, 7, 10]"
data-colors='["#66FF33","#FFFF00","#FF6600","#FF0000","#993399"]'></div>
<div data-type="label" class="cell" data-device="ProVorhersage" data-get="fc1_date"></div>
</pre>

[[Datei:label_tabletUI.jpg]]

Beispiel für die Anzeige des Labels als Icon.
<pre>
<div class="cell">
<div data-type="label" data-device="AvReceiver" data-get="input" class="icon round bg-red cell"></div>
<div data-type="label" data-device="AvReceiver" data-get="input" class="icon square bg-blue cell"></div>
<div data-type="label" data-device="AvReceiver" data-get="input" class="icon squareborder cell"></div>
<div data-type="label" data-device="PowerAV_Sw" data-colors='["red","green"]' data-limits='["off","on"]' class="icon round bg-limit cell"></div>
</div>
</pre>

[[Datei:Label_tabletUI_icon.png]]

<div id="Beispiel_pagetab">'''Pagetab'''</div>

Example for a tab menu to switch smoothly between multiple pages. Multiple pagetabs in a template file: menu.html

<pre>
<html>
<body>
<header>MENU</header>
<div class="cell">
<div data-type="pagetab" data-url="index.html" data-icon="fa-home" class="cell"></div>
<div data-type="pagetab" data-url="index_2.html" data-icon="fa-sliders" class="cell"></div>
<div data-type="pagetab" data-url="index_3.html" data-icon="fa-music" class="cell"></div>
<div data-type="pagetab" data-url="index_4.html" data-icon="fa-hotel" class="cell"></div>
<div data-type="pagetab" data-url="index_5.html" data-icon="fa-music" class="cell"></div>
<div data-type="pagetab" data-url="index_6.html" data-icon="fa-database" class="cell"></div>
<div data-type="pagetab" data-url="index_7.html" data-icon="fa-fax" class="cell"></div>
</div>
</body>
</html>
</pre>

<div id="Beispiel_playstream">'''Playstream'''</div>

Erzeugt einen Knopf zum direkten Abspielen eines Webradio-Streams.

<pre>
<div data-type="playstream" data-url="http://radioeins.de/stream"></div>
<div data-type="label" class="darker">Radio eins</div>
</pre>

<div id="Beispiel_push">'''Push'''</div>

Example for how to create a push button widget to trigger all devices on:

<pre>
<div data-type="push"
data-device="LightAll"
data-cmd="trigger"
data-set="on"
class="cell">
</div>
</pre>

Beispiel für zwei horizontale Buttons:

<pre>
<div class="cell">
<div class="doublebox-h">
<div data-type="push" data-device="Rollo"
data-icon="fa-angle-up" data-background-icon="fa-square-o"
data-set="up">
</div>
<div data-type="push" data-device="Rollo"
data-icon="fa-angle-down" data-background-icon="fa-square-o"
data-set="down">
</div>
</div>
</div>
</pre>

[[Datei:push1.png]]

Beispiel für zwei quadratische vertikale Buttons:

<pre>
<div class="cell">
<div class="doublebox-v">
<div data-type="push" data-device="Rollo"
data-icon="fa-chevron-up" data-background-icon="fa-square-o"
data-set="up">
</div>
<div data-type="push" data-device="Rollo"
data-icon="fa-chevron-down" data-background-icon="fa-square-o"
data-set="down">
</div>
</div>
</div>
</pre>

[[Datei:push2.png]]

<div id="Beispiel_rotor">'''Rotor'''</div>

Example for a rotor widget, which switches between to days of weather forecast

<pre>
<div data-type="rotor" class="fade">
<ul>
<li>
<div data-type="label" class="darker">Heute</div>
<div data-type="weather" data-device="AgroWeather" data-get="fc0_weatherDay" class="big"></div>
<div data-type="label" data-device="AgroWeather" data-get="fc0_weatherDay" class=""></div>
<div data-type="label" data-device="AgroWeather" data-get="fc0_tempMax" data-unit="%B0C%0A" class="large"></div>
</li>
<li>
<div data-type="label" class="darker">Morgen</div>
<div data-type="weather" data-device="AgroWeather" data-get="fc1_weatherDay" class="big"></div>
<div data-type="label" data-device="AgroWeather" data-get="fc1_weatherDay" class=""></div>
<div data-type="label" data-device="AgroWeather" data-get="fc1_tempMax" data-unit="%B0C%0A" class="large"></div>
</li>
</ul>
</div>
</pre>

<div id="Beispiel_select">'''Select'''</div>

Erzeugt zwei Comboboxen zur Auswahl des Eingang eines 2-Zonen-AV-Receivers. Die Liste für Zone2 ist fest, die Liste für Zone1 wird von Fhem übergeben.

<pre>
<div class="cell wider">
<div data-type="label" class="inline wider">Zone2</div>
<div data-type="select" data-device="AvReceiverZ2" data-items='["Airplay","Webradio","BD/DVD","PHONO"]' data-get="input" data-set="input" class="cell w2x" ></div>
<div></div>
<div data-type="label" class="inline">Zone1</div>
<div data-type="select" data-device="AvReceiver" data-list="inputs" data-get="input" data-set="input" class="cell w2x" ></div>
</div>
</pre>

[[Datei:select_tabeltUI.png]]

<div id="Beispiel_slider">'''Slider'''</div>

Slider mit einstellbaren Werten von 10 bis 90:

<pre>
<div data-type="slider"
data-device='Dummy1'
data-min="10"
data-max="90"
class="cell" >
</div>
<div data-type="label" class="cell">Light1</div>
</pre>

[[Datei:slider_tabletUI.png]]

Horizontal angeordneter Slider:

<pre>
<div data-type="slider"
data-device='Dummy1'
data-min="0"
data-max="100"
class="horizontal"
</div>
</pre>

[[Datei:slider_tabletUI2.jpg]]

<div id="Beispiel_switch">'''Switch'''</div>

Schalter. Usage of RegEx pattern for state request:

<pre>
<div data-type="switch" class="cell"
data-device="MILIGHT_Zone1_Wohnzimmer"
data-get-on="on.*"
data-get-off="off"></div>
</pre>

[[Datei:switch.png]]

Beispiel für eine Gruppe von Schaltern, um zwischen vier verschiedenen Werten eines device umzuschalten:

<pre>
<div class="cell left">
<div data-type="switch" data-device="dummy1"
data-get-off="((?!Wert1).)*"
data-get-on="Wert1" class="cell" ></div>
<div data-type="label" class="cell">Wert1</div>
<div data-type="switch" data-device="dummy1"
data-get-off="((?!Wert2).)*"
data-get-on="Wert2" class="cell" ></div>
<div data-type="label" class="cell">Wert2</div>
<div data-type="switch" data-device="dummy1"
data-get-off="((?!Wert3).)*"
data-get-on="Wert3" class="cell" ></div>
<div data-type="label" class="cell">Wert3</div>
<div data-type="switch" data-device="dummy1"
data-get-off="((?!Wert4).)*"
data-get-on="Wert4" class="cell" ></div>
<div data-type="label" class="cell">Wert4</div>
</div>
</pre>

[[Datei:switch4.png]]

<div id="Beispiel_symbol">'''Symbol'''</div>

Example for a tristate icon

<pre>
<div data-type="symbol" data-device="dummy1"
data-get-on='["wert1","wert2","wert3"]'
data-icons='["fa-arrow-up","fa-user","fa-arrow-down"]'
data-on-colors='["SeaGreen","SlateBlue","IndianRed"]'
class="cell big">
</div>
</pre>

Example for a tristate icon with blink and spin animation

<pre>
<div data-type="symbol" data-device="dummy1"
data-icons='["fa-exclamation-triangle fa-blink","fa-exclamation-circle","fa-cog fa-spin"]'
data-on-colors='["Crimson","GoldenRod","SeaGreen"]'
data-get-on='["Wert1","Wert2","Wert3"]' >
</div>
</pre>

Example for a battery level control with RegEx

<pre>
<div data-type="symbol" data-device="BadHeizung" data-get="batteryLevel"
data-icons='["oa-measure_battery_100","oa-measure_battery_75","oa-measure_battery_50","oa-measure_battery_25","oa-measure_battery_0"]'
data-get-on='["3\\.[0-9]","2\\.[789]","2\\.[456]","2\\.[123]","((2\\.0)|([01]\\.[0-9]))"]'
data-on-colors='["#505050","#505050","#505050","#ad3333","#ad3333"]'>
</div>
</pre>

Example for a battery level control with greater-equal compare and 90° rotated symbols

<pre>
<div data-type="symbol" data-device="BadHeizung" data-get="batteryLevel"
data-icons='["oa-measure_battery_0 fa-rotate-90","oa-measure_battery_25 fa-rotate-90","oa-measure_battery_50 fa-rotate-90","oa-measure_battery_75 fa-rotate-90","oa-measure_battery_0 fa-rotate-90"]'
data-get-on='["0","2","2.4","2.7","3.0"]'
data-on-colors='["#ad3333","#ad3333","#505050","#505050","#505050"]'>
</div>
</pre>

<div id="Beispiel_thermostat">'''Thermostat'''</div>

Configure as data-device='...' that item which delivers temp and desired-temp as reading.

Default parameters are:
<pre>
data-get="desired-temp" data-temp="measured-temp" data-set="desired-temp"
</pre>

Therefor for HomaMatic HM-CC-RT-DN this is sufficient.

<pre>
<div data-type="thermostat" data-device='KH_Clima' class="cell"></div>
</pre>

The long format looks like this:

<pre>
<div data-type="thermostat"
data-device="KH_Clima"
data-get="desired-temp"
data-temp="measured-temp"
class="cell">
</div>
</pre>

Example for MAX!:
<pre>
<div data-type="thermostat" data-device="HZ_Tuer"
data-valve="valveposition"
data-get="desiredTemperature"
data-temp="temperature"
data-set="desiredTemperature"
class="cell">
</div>
</pre>

The wigets will show the valve value only in case of a valid data-valve attribute. The default for data-valve ist null. That means, a empty data-valve attribute hides the valve label for the widget.

[[Datei:thermostat.png]]

<div id="Beispiel_weather">'''Weather'''</div>

Das Widget fügt ein dem Wetter entsprechendes Bild ein. Die Daten können durch Fhem-Module wie [[PROPLANTA]], [[OPENWEATHER]] und [[Weather]] bereitgestellt werden.
Add 'big' or 'bigger' to CSS class to get a bigger weather icon.

Beispiel:
<pre>
<div data-type="weather"
data-device="Weather"
data-get="fc0_weatherDay"
class="cell big">
</div>
</pre>

[[Datei:weather.png]]

== Icon-Konfiguration ==

* Eingebaute Icons: Diese haben das ftui-Präfix. Zurzeit sind folgende verfügbar: ftui-window, ftui-door

* Mehr als 500 Icons von "http://fortawesome.github.io/Font-Awesome/icons" verfügbar. Einfach den Icon-Namen angeben (Präfix "fa-" nicht vergessen, Z.B. <code>data-icon="fa-volume-up"</code>

* Es stehen auch Openautomation Font-Files zur Verfügung. Wer sie nutzen möchte, muss folgende Stylesheets in die index.html hinzufügen.
<pre>
<link rel="stylesheet" href="/fhem/tablet/lib/openautomation.css" />
<link rel="stylesheet" href="/fhem/tablet/lib/fhemSVG.css" />
</pre>

Diese font icons haben das Präfix 'fs-' bzw. 'oa-'.

Beispiel bei einem Schalter:
<pre><div data-type="switch" data-device='dummy1' data-icon="oa-secur_locked"></div></pre>

Und so als großes Symbol:
<pre>
<div data-type="symbol" data-device='dummy1'
data-icon="oa-status_frost"
data-on-color="#bb3232"
data-get-on="on"
data-get-off="!on"
class="bigger">
</div>
</pre>

Die Icons kann man auch etwas dicker darstellen mit den Zusatz bold: <code>data-icon="oa-secur_locked bold"</code>

Die Namen der verfügbaren Icons findet man auch in den CSS Files (openautomation.css / fhemSVG.css)

== Spezial ==
Folgender Befehl setzt einen direkten Befehl an Fhem ab (<code>set dummy1 off</code>):
<pre>
<div onclick="setFhemStatus('set dummy1 off')">All off!</div>
</pre>

== FAQ ==
Häufig gestellte Fragen zum FHEM Tablet UI sind in der [[FHEM_Tablet_UI/FAQ|FHEM Tablet UI FAQ]] zusammengestellt.

== Links ==
* [http://forum.fhem.de/index.php/topic,34233.0.html Forums-Beitrag]
* [https://github.com/knowthelist/fhem-tablet-ui Projekt auf Github]
* [http://forum.fhem.de/index.php/topic,37378.0.html User-Demos]
* [https://github.com/ovibox/fhem-ftui-user-demos Download der User-Demo-Dateien]

[[Kategorie:FHEM Tablet UI]]

Departure

2016-11-08T06:49:29Z

Suelle: Initiale Anlage

Departure ist ein Modul zur Anzeige der Abfahrtszeiten von Bahn, Bus, Zug und Fähre öffentlichen Personennahverkehrs (ÖPNV).
Diese Seite basiert auf dem Beitrag im Forum https://forum.fhem.de/index.php?topic=48255.0 (von sbierman). Mittlerweile gibt es hierzu ein noch inoffizielles Modul https://forum.fhem.de/index.php?topic=60046.0 (von uniqueck).
Zusätzlich gibt es ein Widget für die FHEM Tablet UI (FTUI) https://forum.fhem.de/index.php?topic=48255.0 (von setstate).
Diese Seite sollte angepasst/überarbeitet werden, wenn das Modul 98_departure offiziell eingecheckt ist.

== Vorbereitung ==
Um die Abfahrtzeiten zu ermitteln wird der REST-Wrapper von sbiermann genutzt, der auf dem Dienst für die Android App "Öffi" basiert.
Für die Spätere Abfrage wird der Provider und die ID der Haltestelle benötigt. Beides kann wie folgt ermittelt werden.

1. Ermitteln welche Provider gibt es und welcher ist für mich zuständig.
<source lang="perl">http://transportrest-sbiermann.rhcloud.com/provider</source>

Dieses liefert als Antwort im JSON Format:
<source lang="perl">
[{"name":"Sncb","aClass":"SncbProvider"},{"name":"Vbn","aClass":"VbnProvider"},{"name":"Wien","aClass":"WienProvider"},{"name":"Linz","aClass":"LinzProvider"},{"name":"Vrr","aClass":"VrrProvider"},{"name":"Oebb","aClass":"OebbProvider"},{"name":"Gvh","aClass":"GvhProvider"},{"name":"Ns","aClass":"NsProvider"},{"name":"Vao","aClass":"VaoProvider"},{"name":"Tfi","aClass":"TfiProvider"},{"name":"Vgn","aClass":"VgnProvider"},{"name":"Mvg","aClass":"MvgProvider"},{"name":"Pl","aClass":"PlProvider"},{"name":"Vgs","aClass":"VgsProvider"},{"name":"Nasa","aClass":"NasaProvider"},{"name":"Vbb","aClass":"VbbProvider"},{"name":"Ivb","aClass":"IvbProvider"},{"name":"Nvv","aClass":"NvvProvider"},{"name":"Mvv","aClass":"MvvProvider"},{"name":"Vagfr","aClass":"VagfrProvider"},{"name":"Vvv","aClass":"VvvProvider"},{"name":"Sf","aClass":"SfProvider"},{"name":"Vms","aClass":"VmsProvider"},{"name":"Sbb","aClass":"SbbProvider"},{"name":"Bsvag","aClass":"BsvagProvider"},{"name":"Jet","aClass":"JetProvider"},{"name":"Septa","aClass":"SeptaProvider"},{"name":"Bvb","aClass":"BvbProvider"},{"name":"Mersey","aClass":"MerseyProvider"},{"name":"Vvs","aClass":"VvsProvider"},{"name":"Nvbw","aClass":"NvbwProvider"},{"name":"Se","aClass":"SeProvider"},{"name":"Svv","aClass":"SvvProvider"},{"name":"Bahn","aClass":"BahnProvider"},{"name":"Vrs","aClass":"VrsProvider"},{"name":"Stockholm","aClass":"StockholmProvider"},{"name":"Vmv","aClass":"VmvProvider"},{"name":"Stv","aClass":"StvProvider"},{"name":"Sydney","aClass":"SydneyProvider"},{"name":"Paris","aClass":"ParisProvider"},{"name":"Dsb","aClass":"DsbProvider"},{"name":"Rt","aClass":"RtProvider"},{"name":"Dub","aClass":"DubProvider"},{"name":"Bvg","aClass":"BvgProvider"},{"name":"Paca","aClass":"PacaProvider"},{"name":"Vor","aClass":"VorProvider"},{"name":"FrenchSouthWest","aClass":"FrenchSouthWestProvider"},{"name":"Avv","aClass":"AvvProvider"},{"name":"Zvv","aClass":"ZvvProvider"},{"name":"Nri","aClass":"NriProvider"},{"name":"Invg","aClass":"InvgProvider"},{"name":"Eireann","aClass":"EireannProvider"},{"name":"Vbl","aClass":"VblProvider"},{"name":"Vvo","aClass":"VvoProvider"},{"name":"Sh","aClass":"ShProvider"},{"name":"Kvv","aClass":"KvvProvider"},{"name":"Bayern","aClass":"BayernProvider"},{"name":"Atc","aClass":"AtcProvider"},{"name":"Lu","aClass":"LuProvider"},{"name":"Italy","aClass":"ItalyProvider"},{"name":"Vvm","aClass":"VvmProvider"},{"name":"Met","aClass":"MetProvider"},{"name":"Ding","aClass":"DingProvider"},{"name":"Tlem","aClass":"TlemProvider"},{"name":"Vvt","aClass":"VvtProvider"},{"name":"Vrn","aClass":"VrnProvider"}]
</source>
Das was bei Name steht wird verwendet, der Wert aClass ist intern und braucht hier nicht weiter verwendet werden. Im Beispiel haben die Verkehrsbetriebe Stuttgart (VVS) den Namen "Vvs".

2. Ermitteln der StationId für die Haltestelle deren Abfahrtszeiten ich gerne haben möchte. In diesem Beispiel die Haltstelle "SSB-Zentrum".
<source lang="perl">
http://transportrest-sbiermann.rhcloud.com/station/suggest?q=SSB-Zentrum&provider=Vvs
</source>
Dieses liefert als Antwort im JSON Format:
<source lang="perl">
[{"type":"STATION","id":"5000350","lat":48726856,"lon":9129721,"place":"Stuttgart","name":"SSB-Zentrum","products":null,"lonAsDouble":9.129721,"latAsDouble":48.726856,"identified":true},{"type":"STATION","id":"5002601","lat":48722757,"lon":9129058,"place":"Stuttgart","name":"Industriestraße (SSB-Zentrum)","products":null,"lonAsDouble":9.129058,"latAsDouble":48.722757,"identified":true}]
</source>
Wie man sehen kann gibt es mehrere Treffer für Maria-Hilf-Kirche. Es wird aber nur der Typ "STATION" benötigt und somit lautet die StationId "5000350".

3. Abfrage der Departure Zeiten für die Haltestelle "SSB-Zentrum". Diese liefert die Daten im passenden Format für das zugehörige departure Widget für FTUI
<source lang="perl">
http://transportrest-sbiermann.rhcloud.com/departureFHEM?from=6930306&provider=Vvs
</source>
dieses liefert als Antwort im passenden Format:
<source lang="perl">
[["U8","Vaihingen","3"],["U12","Dürrlewang","6"],["U8","Ostfildern","5"],["U3","Vaihingen","6"],["U12","Hallschlag","7"],["U3","Plieningen","9"],["U8","Vaihingen","12"],["U12","Dürrlewang","17"],["U8","Waldau","15"],["U3","Vaihingen","16"]]
</source>
Die Zeiten sind immer inklusive Verspätung angegeben, sofern der Provider diese Daten mit sendet.

== Einbindung in FHEM ==
Wie in der Einleitung erwähnt gibt es aktuell zwei Wege, die Abfahrtszeiten einzubinden: über HTTPMOD oder über das noch inofizielle Modul 98_departure
<source lang="perl">
define myDeparture HTTPMOD none 0
attr myDeparture get01Name SSB-Zentrum
attr myDeparture get01URL http://transportrest-sbiermann.rhcloud.com/departureFHEM?from=6930306&provider=Vvs
attr myDeparture get01Regex (\[\[.*\]\]).*
attr VAG timeout 30
</source>
Es können mehrere Haltestellen in einem Device hinterlegt werden, hierzu einfach die drei Attribute get01Name, get01URL und get01Regex duplizieren und durchnummerieren. Dabei müssen natürlich Name und URL angepasst werden.
Bei dieser Konfiguration erfolgt die Aktualisierung über das FTUI Widget!

Qnap NAS Ruhemodus/herunterfahren

2016-11-05T13:45:22Z

Suelle:

Mit dieser Anleitung ist es möglich sein NAS über FHEM in den Ruhemodus zu versetzen. Dies ist ggf. sinnvoll, wenn man es nur bei Anwesenheit nutzt. Der Stromverbrauch lässt sich dadurch deutlich senken. Per WoL kann es bei Bedarf wieder gestartet werden.<br>
Dieser Artikel basiert auf einem [https://forum.fhem.de/index.php/topic,27539.msg204384.html Beitrag im Forum] und lässt sich sicherlich auch für andere NAS nutzen/anpassen.

== Idee ==
Das NAS kann nur über die Oberfläche oder eine Terminalsession auf dem NAS selbst in den Ruhemodus versetzt werden. Mittels einer SSH Verbindung vom FHEM Host zum NAS ist dies möglich. Da man das Administrationskennwort des NAS nicht im Klartext hinterlegen möchte, soll stattdessen ein SSH Key verwendet werden.

== Voraussetzungen ==
Das Kennwort des root Users auf dem FHEM Host muss bekannt sein.

Der User FHEM muss sich anmelden dürfen. Hierfür muss ggf. die Datei [[/etc/passwd]] angepasst werden:
<source lang="perl">sudo nano /etc/passwd</source>
Dort muss der Eintrag [[fhem:x:999:20::/opt/fhem:/bin/false]] in [[fhem:x:999:20::/opt/fhem:/bin/bash]] geändert werden.<br>
[[Wichtig]]: Dies sollte nach der vollständigen Einrichtung wieder rückgängig gemacht werden!

== SSH Key für User FHEM anlegen ==
Hierfür sind die Schritte unter [https://www.debian-administration.org/article/530/SSH_with_authentication_key_instead_of_password SSH with authentication key instead of password] zu befolgen und an die eigenen Gegebenheiten anzupassen.<br>
Auf dem FHEM Host muss der Public Key erstellt werde (Generate the authentication key). Hierfür muss der FHEM User genutzt werden:
<source lang="perl">
su - root
su - fhem
</source>

Anschließend muss der Public Key auf dem NAS abgelegt werden. (Install the public key on the servers).

== Script in FHEM anlegen ==
Anlage der Datei über Terminal (putty o.ä.). Der erste Befehl erzeugt eine leere Datei, die anschließend dem User fhem zugeordnet wird und zum Schluss ausführbar gemacht wird.
<source lang="perl">
sudo touch /opt/fhem/FHEM/shutdownNAS.sh && sudo chown -R fhem /opt/fhem/ && sudo chmod +x /opt/fhem/FHEM/shutdownNAS.sh
</source>
Nun muss der Code des Scripts eingefügt werden. Dies kann entweder über die FHEM Oberfläche (Edit files) oder das Terminal erfolgen. Für letzteres lautet der Befehl:
<source lang="perl">
sudo nano /opt/fhem/FHEM/shutdownNAS.sh
</source>
Folgender Code muss eingefügt werden (die IP Adresse des eigenen NAS ist anzupassen):
<source lang="perl">
#!/bin/bash
# SH_shutdownNAS.sh

DATE=$(date +%Y.%m.%d)
TIME=$(date +%T)
echo $DATE $TIME "3: NAS in den Ruhemodus versetzen"

ssh admin@192.168.xxx.xxx "echo mem > /sys/power/state"
exit 0

</source>

== Script ausführen ==
Es gilt zu beachten, dass FHEM als return eines solchen Scripts immer -1 ausgibt.<br>
Ebenso sollte bedacht werden, dass das Script nicht vollständig durchlaufen werden kann, da die Verbindung zum NAS verloren geht. Deshalb erfolgt der Aufruf des Scripts am Ende mit &.<br>
Das Script kann über die FHEM Oberfläche
<source lang="perl">{system('/opt/fhem/FHEM/SH_shutdownNAS.sh&')}</source>
oder in einer 99_myUtils.pm
<source lang="perl">system('/opt/fhem/FHEM/SH_shutdownNAS.sh&');</source>
ausgeführt werden.

== Links ==
* [https://forum.fhem.de/index.php/topic,27539.msg204384.html Beitrag im Forum]
* [https://www.debian-administration.org/article/530/SSH_with_authentication_key_instead_of_password SSH with authentication key instead of password]

[[Kategorie:HOWTOS]]

Qnap NAS Ruhemodus/herunterfahren

2016-11-05T12:06:17Z

Suelle:

Mit dieser Anleitung ist es möglich sein NAS über FHEM in den Ruhemodus zu versetzen. Dies ist ggf. sinnvoll, wenn man es nur bei Anwesenheit nutzt. Der Stromverbrauch lässt sich dadurch deutlich senken. Per WoL kann es bei Bedarf wieder gestartet werden.<br>
Dieser Artikel basiert auf einem [https://forum.fhem.de/index.php/topic,27539.msg204384.html Beitrag im Forum] und lässt sich sicherlich auch für andere NAS nutzen/anpassen.

== Idee ==
Das NAS kann nur über die Oberfläche oder eine Terminalsession auf dem NAS selbst in den Ruhemodus versetzt werden. Mittels einer SSH Verbindung vom FHEM Host zum NAS ist dies möglich. Da man das Administrationskennwort des NAS nicht im Klartext hinterlegen möchte, soll stattdessen ein SSH Key verwendet werden.

== Voraussetzungen ==
Das Kennwort des root Users auf dem FHEM Host muss bekannt sein.

Der User FHEM muss sich anmelden dürfen. Hierfür muss ggf. die Datei [[/etc/passwd]] angepasst werden:
<source lang="perl">sudo nano /etc/passwd</source>
Dort muss der Eintrag [[fhem:x:999:20::/opt/fhem:/bin/false]] in [[fhem:x:999:20::/opt/fhem:/bin/bash]] geändert werden.<br>
[[Wichtig]]: Dies sollte nach der vollständigen Einrichtung wieder rückgängig gemacht werden!

Auf dem FHEM Host muss ggf. ssh installiert werden:
<source lang="perl">sudo apt-get install sshpass</source>

== SSH Key für User FHEM anlegen ==
Hierfür sind die Schritte unter [https://www.debian-administration.org/article/530/SSH_with_authentication_key_instead_of_password SSH with authentication key instead of password] zu befolgen und an die eigenen Gegebenheiten anzupassen.<br>
Auf dem FHEM Host muss der Public Key erstellt werde (Generate the authentication key). Hierfür muss der FHEM User genutzt werden:
<source lang="perl">
su - root
su - fhem
</source>

Anschließend muss der Public Key auf dem NAS abgelegt werden. (Install the public key on the servers).

== Script in FHEM anlegen ==
Anlage der Datei über Terminal (putty o.ä.). Der erste Befehl erzeugt eine leere Datei, die anschließend dem User fhem zugeordnet wird und zum Schluss ausführbar gemacht wird.
<source lang="perl">
sudo touch /opt/fhem/FHEM/shutdownNAS.sh && sudo chown -R fhem /opt/fhem/ && sudo chmod +x /opt/fhem/FHEM/shutdownNAS.sh
</source>
Nun muss der Code des Scripts eingefügt werden. Dies kann entweder über die FHEM Oberfläche (Edit files) oder das Terminal erfolgen. Für letzteres lautet der Befehl:
<source lang="perl">
sudo nano /opt/fhem/FHEM/shutdownNAS.sh
</source>
Folgender Code muss eingefügt werden (die IP Adresse des eigenen NAS ist anzupassen):
<source lang="perl">
#!/bin/bash
# SH_shutdownNAS.sh

DATE=$(date +%Y.%m.%d)
TIME=$(date +%T)
echo $DATE $TIME "3: NAS in den Ruhemodus versetzen"

ssh admin@192.168.xxx.xxx "echo mem > /sys/power/state"
exit 0

</source>

== Script ausführen ==
Es gilt zu beachten, dass FHEM als return eines solchen Scripts immer -1 ausgibt.<br>
Ebenso sollte bedacht werden, dass das Script nicht vollständig durchlaufen werden kann, da die Verbindung zum NAS verloren geht. Deshalb erfolgt der Aufruf des Scripts am Ende mit &.<br>
Das Script kann über die FHEM Oberfläche
<source lang="perl">{system('/opt/fhem/FHEM/SH_shutdownNAS.sh&')}</source>
oder in einer 99_myUtils.pm
<source lang="perl">system('/opt/fhem/FHEM/SH_shutdownNAS.sh&');</source>
ausgeführt werden.

== Links ==
* [https://forum.fhem.de/index.php/topic,27539.msg204384.html Beitrag im Forum]
* [https://www.debian-administration.org/article/530/SSH_with_authentication_key_instead_of_password SSH with authentication key instead of password]

[[Kategorie:HOWTOS]]

Qnap NAS Ruhemodus/herunterfahren

2016-11-05T12:04:47Z

Suelle: Initiale Anlage

Mit dieser Anleitung ist es möglich sein NAS über FHEM in den Ruhemodus zu versetzen. Dies ist ggf. sinnvoll, wenn man es nur bei Anwesenheit nutzt. Der Stromverbrauch lässt sich dadurch deutlich senken. Per WoL kann es bei Bedarf wieder gestartet werden.<br>
Dieser Artikel basiert auf einem [https://forum.fhem.de/index.php/topic,27539.msg204384.html Beitrag im Forum] und lässt sich sicherlich auch für andere NAS nutzen/anpassen.

== Idee ==
Das NAS kann nur über die Oberfläche oder eine Terminalsession auf dem NAS selbst in den Ruhemodus versetzt werden. Mittels einer SSH Verbindung vom FHEM Host zum NAS ist dies möglich. Da man das Administrationskennwort des NAS nicht im Klartext hinterlegen möchte, soll stattdessen ein SSH Key verwendet werden.

== Voraussetzungen ==
Das Kennwort des root Users auf dem FHEM Host muss bekannt sein.

Der User FHEM muss sich anmelden dürfen. Hierfür muss ggf. die Datei [[/etc/passwd]] angepasst werden:
<source lang="perl">sudo nano /etc/passwd</source>
Dort muss der Eintrag [[fhem:x:999:20::/opt/fhem:/bin/false]] in [[fhem:x:999:20::/opt/fhem:/bin/bash]] geändert werden.<br>
[[Wichtig]]: Dies sollte nach der vollständigen Einrichtung wieder rückgängig gemacht werden!

Auf dem FHEM Host muss ggf. ssh installiert werden:
<source lang="perl">sudo apt-get install sshpass</source>

== SSH Key für User FHEM anlegen ==
Hierfür sind die Schritte unter [https://www.debian-administration.org/article/530/SSH_with_authentication_key_instead_of_password SSH with authentication key instead of password] zu befolgen und an die eigenen Gegebenheiten anzupassen.<br>
Auf dem FHEM Host muss der Public Key erstellt werde (Generate the authentication key). Hierfür muss der FHEM User genutzt werden:
<source lang="perl">
su - root
su - fhem
</source>

Anschließend muss der Public Key auf dem NAS abgelegt werden. (Install the public key on the servers).

== Script in FHEM anlegen ==
Anlage der Datei über Terminal (putty o.ä.). Der erste Befehl erzeugt eine leere Datei, die anschließend dem User fhem zugeordnet wird und zum Schluss ausführbar gemacht wird.
<source lang="perl">
sudo touch /opt/fhem/FHEM/shutdownNAS.sh && sudo chown -R fhem /opt/fhem/ && sudo chmod +x /opt/fhem/FHEM/shutdownNAS.sh
</source>
Nun muss der Code des Scripts eingefügt werden. Dies kann entweder über die FHEM Oberfläche (Edit files) oder das Terminal erfolgen. Für letzteres lautet der Befehl:
<source lang="perl">
sudo nano /opt/fhem/FHEM/shutdownNAS.sh
</source>
Folgender Code muss eingefügt werden (die IP Adresse des eigenen NAS ist anzupassen):
<source lang="perl">
#!/bin/bash
# SH_shutdownNAS.sh

DATE=$(date +%Y.%m.%d)
TIME=$(date +%T)
echo $DATE $TIME "3: NAS in den Ruhemodus versetzen"

ssh admin@192.168.xxx.xxx "echo mem > /sys/power/state"
exit 0

</source>

== Script ausführen ==
Es gilt zu beachten, dass FHEM als return eines solchen Scripts immer -1 ausgibt.<br>
Ebenso sollte bedacht werden, dass das Script nicht vollständig durchlaufen werden kann, da die Verbindung zum NAS verloren geht. Deshalb erfolgt der Aufruf des Scripts am Ende mit &.<br>
Das Script kann über die FHEM Oberfläche
<source lang="perl">{system('/opt/fhem/FHEM/SH_shutdownNAS.sh&')}</source>
oder in einer 99_myUtils.pm
<source lang="perl">system('/opt/fhem/FHEM/SH_shutdownNAS.sh&');</source>
ausgeführt werden.

== Links ==
* [https://forum.fhem.de/index.php/topic,27539.msg204384.html Beitrag im Forum]
* [https://www.debian-administration.org/article/530/SSH_with_authentication_key_instead_of_password SSH with authentication key instead of password]

Qnap NAS Ruhemodus/herunterfahren

2016-11-05T11:47:03Z

Suelle: Die Seite wurde neu angelegt: „Mit dieser Anleitung ist es möglich sein NAS über FHEM in den Ruhemodus zu versetzen. Dies ist ggf. sinnvoll, wenn man es nur bei Anwesenheit nutzt. Der Stro…“

Mit dieser Anleitung ist es möglich sein NAS über FHEM in den Ruhemodus zu versetzen. Dies ist ggf. sinnvoll, wenn man es nur bei Anwesenheit nutzt. Der Stromverbrauch lässt sich dadruch deutlich senken. Per WoL kann es bei Bedarf wieder gestartet werden.<br>
Dieser Artikel basiert auf einem [https://forum.fhem.de/index.php/topic,27539.msg204384.html Beitrag im Forum] und lässt sich sicherlich auch für andere NAS nutzen/anpassen.

== Idee ==
Das NAS kann nur über die Oberfläche oder eine Terminalsession auf dem NAS selbst in den Ruhemodus versetzt werden. Mittels einer SSH Verbindung vom FHEM Host zum NAS ist dies möglich. Da man das Administrationskennwort des NAS nicht im klartext hinterlegen möchte, soll stattdessen ein SSH Key verwendet werden.

== Voraussetzungen ==
Der User FHEM muss sich anmelden dürfen. Hierfür muss ggf. die Datei /etc/passwd angepasst werden:
<source lang="perl">sudo nano /etc/passwd</source>
Dort muss der Eintrag [fhem:x:999:20::/opt/fhem:/bin/false] in [fhem:x:999:20::/opt/fhem:/bin/bash] geändert werden.<br>
WICHTIG: Dies sollte nach der vollständigen Einrichtung wieder rückgängig gemacht werden!

Auf dem FHEM Host muss ggf. ssh installiert werden:
<source lang="perl">sudo apt-get install sshpass</source>

== SSH Key für User FHEM anlegen ==
Hierfür sind die Schritte unter

su - root
su - fhem

== Script in FHEM anlegen ==
Anlage der Datei über Terminal (putty o.ä.). Der erste Befehl erzeugt eine leere Datei, die anschließend dem User fhem zugeordnet wird und zum Schluss ausführbar gemacht wird.
<source lang="perl">
sudo touch /opt/fhem/FHEM/shutdownNAS.sh && sudo chown -R fhem /opt/fhem/ && sudo chmod +x /opt/fhem/FHEM/shutdownNAS.sh
</source>
Nun muss der Code des Scripts eingefügt werden. Dies kann entweder über die FHEM Oberfläche (Edit files) oder das Terminal erfolgen. Für letzteres lautet der Befehl:
<source lang="perl">
sudo nano /opt/fhem/FHEM/shutdownNAS.sh
</source>
Folgender Code muss eingefügt werden (die IP Adresse des eigenen NAS ist anzupassen):
<source lang="perl">
#!/bin/bash
# SH_shutdownNAS.sh

DATE=$(date +%Y.%m.%d)
TIME=$(date +%T)
echo $DATE $TIME "3: NAS in den Ruhemodus versetzen"

ssh admin@192.168.xxx.xxx "echo mem > /sys/power/state"
exit 0

</source>

== Script ausführen ==
Es gilt zu beachten, dass FHEM als return eines solchen Scripts immer -1 ausgibt.<br>
Ebenso sollte bedacht werden, dass das Script nicht vollständig durchlaufen werden kann, da die Verbindung zum NAS verloren geht. Deshalb erfolgt der Aufruf des Scripts am Ende mit &.<br>
Das Script kann über die FHEM Oberfläche
<source lang="perl">{system('/opt/fhem/FHEM/SH_shutdownNAS.sh&')}</source>
oder in einer 99_myUtils.pm
<source lang="perl">system('/opt/fhem/FHEM/SH_shutdownNAS.sh&');</source>
ausgeführt werden.

== Links ==
* [https://forum.fhem.de/index.php/topic,27539.msg204384.html Beitrag im Forum]
* [https://www.debian-administration.org/article/530/SSH_with_authentication_key_instead_of_password SSH with authentication key instead of password]

Spritpreismonitor

2016-11-04T08:08:31Z

Suelle:

Die hier vorgestellten Fragmente ermöglichen es, mit Hilfe von [[HTTPMOD]] bei [http://www.clever-tanken.de clever-tanken.de] von Wunschtankstellen die Spritpreise zu protokollieren. Die Credits dafür gehen an Forum-Benutzer {{Link2FU|1774|Phil__}}. Die Original Diskussion im Forum ist {{Link2Forum|Topic=22554|Message=210795|LinkText=hier}}.

Alternativ können die Kraftstoffpreise auch über die Webseite tankerkönig.de bezogen werden. Die Vorgehensweise dafür ist im Detail in [http://www.cyberwulf.de/2016/fhem-spritpreise-von-tankerkoenig-de/ diesem Blog] beschrieben.

== Einleitung ==
{{Randnotiz|RNTyp=y|RNText=Die gezeigten Anweisungen basieren noch auf einer alten Version (vor Februar 2016) des Moduls HTTPMOD. Das betrifft insbesondere die gewählten ''readings...''-Namen. Dieses Namensschema wird u.U. in Zukunft nicht mehr unterstützt.
Zur Umstellung auf das aktuelle Namensschema (am Beispiel ''Shell'') bitte folgende Aktionen (Eingabe in das Befehlsfenster!) ausführen:
:<code>attr Shell enableControlSet 1</code>
:<code>set Shell upgradeAttributes</code>
Im Fhem-Log sollten dann Meldungen auftauchen nach dem Schema
:''Shell: upgraded attribute ... to new syntax ...''
:''Shell: dropping readings... from userattr list''
}}

Im folgenden wird mit Hilfe des Moduls HTTPMOD der Spritpreis von ausgewählten Tankstellen abgerufen. Die Daten werden [[Regulärer Ausdruck|gefiltert]], gespeichert und als Diagramm aufbereitet.

Zum Nachbau ist es erforderlich, "seine" Wunschtankstellen bei Clever-Tanken zu suchen. Jede Tankstelle hat eine eigene Nummer:
:<code>/tankstelle_details/0815</code>

Die ''600'' in den Beispielen gibt das Abrufintervall in Sekunden an.

== Konfiguration ==
Die erforderlichen Definitionen in der Fhem [[Konfiguration]] bestehen aus mehreren Teilen. Zunächst die erforderlichen Einstellungen, um die Daten der gewünschten Tankstellen abzuholen:

<pre>
define Shell HTTPMOD http://www.clever-tanken.de/tankstelle_details/4871 600
attr Shell group Spritpreise
attr Shell icon tanken
attr Shell readingsName_Diesel Diesel
attr Shell readingsName_SuperE5 SuperE5
attr Shell readingsRegex_Diesel <span>Diesel</span>[^0-9]+([0-9\.]+)
attr Shell readingsRegex_SuperE5 <span>Super E5</span>[^0-9]+([0-9\.]+)
attr Shell room Spritpreise
attr Shell stateFormat Liter_Diesel: Diesel
attr Shell timeout 5

define Total HTTPMOD http://www.clever-tanken.de/tankstelle_details/4870 600
attr Total group Spritpreise
attr Total icon tanken
attr Total readingsName_Diesel Diesel
attr Total readingsName_SuperE5 SuperE5
attr Total readingsRegex_Diesel <span>Diesel</span>[^0-9]+([0-9\.]+)
attr Total readingsRegex_SuperE5 <span>Super E5</span>[^0-9]+([0-9\.]+)
attr Total room Spritpreise
attr Total stateFormat Liter_Diesel: Diesel
attr Total timeout 5

define Aral HTTPMOD http://www.clever-tanken.de/tankstelle_details/4869 600
attr Aral group Spritpreise
attr Aral icon tanken
attr Aral readingsName_Diesel Diesel
attr Aral readingsName_SuperE5 SuperE5
attr Aral readingsRegex_Diesel <span>Diesel</span>[^0-9]+([0-9\.]+)
attr Aral readingsRegex_SuperE5 <span>Super E5</span>[^0-9]+([0-9\.]+)
attr Aral room Spritpreise
attr Aral stateFormat Liter_Diesel: Diesel
attr Aral timeout 5
</pre>

Wer die Anzeige der Benzinpreise inklusive der obligatorisch abschließenden "9" möchte, muss zu jedem readingsName einen entsprechenden Zusatzzeile hinzufügen:

<pre>
# Addiert zum Wert ($val) des Readings (readingsName_Diesel) den Wert 0.009
attr Shell readingsExpr_Diesel $val + 0.009
</pre>

Diese Zeile fügt dem Dieselpreis der Shell-Tankstelle bei einem Literpreis von 1.29 die Ziffer "9" hinzu und ergibt 1.299.

Dazu kommen noch die Definitionen für das [[FileLog]]:
<pre>
define FileLog_Spritpreise FileLog /media/usblog/fhem/log/spritpreise-langen-%Y-%m.log (Shell|Total|Aral):(SuperE5|Diesel).*
attr FileLog_Spritpreise alias Log Spritpreise
attr FileLog_Spritpreise group Logfile
attr FileLog_Spritpreise logtype text
attr FileLog_Spritpreise room Spritpreise
</pre>

Sowie eine passende [[readingsGroup]]:
<pre>
define Spritpreise readingsGroup (Shell|Total|Aral):(SuperE5|Diesel).*
attr Spritpreise group Spritpreisuebersicht
attr Spritpreise notime 1
attr Spritpreise room Spritpreise
#attr Spritpreise style style="font-size:16px" # führt ggf. zu einem PERL WARNING
attr Spritpreise valueFormat {'%.2f €'}
#attr Spritpreise valueStyle {Werte($READING,$VALUE)} # führt ggf. zu einem PERL WARNING
</pre>

Und eine [[SVG|Plotdefinition]]
<pre>
define SVG_FileLog_Spritpreise_1 SVG FileLog_Spritpreise:SVG_FileLog_Spritpreise_1:CURRENT
attr SVG_FileLog_Spritpreise_1 group Spritpreisverlauf
attr SVG_FileLog_Spritpreise_1 room Spritpreise
</pre>

== Farbliche Hervorhebung ==
Folgender Code gehört in [[99 myUtils anlegen|99_myUtils.pm]]; die Werte können natürlich entsprechend eigener Wünsche und Vorlieben angepasst werden.
<pre>
###################################################
### Spritpreisübersicht - Farbsortierung ###
###################################################

sub Werte($$) {
my ($name, $wert) = @_;
# Log(3,"$name $wert");
if ($name eq "Diesel") {
return 'style="color:red"' if($wert >= 1.39);
return 'style="color:blue"' if(($wert >= 1.33) && ($wert < 1.39));
return 'style="color:green;;font-weight:bold"' if($wert <= 1.32);
}elsif ($name eq "SuperE10") {
return 'style="color:crimson"' if($wert >= 1.70);
return 'style="color:yellow"' if(($wert >= 1.55) && ($wert < 1.70));
return 'style="color:lightgreen;;font-weight:bold"' if($wert < 1.55);
}elsif ($name eq "SuperE5") {
return 'style="color:red"' if($wert >= 1.59);
return 'style="color:blue"' if(($wert >= 1.49) && ($wert < 1.59));
return 'style="color:green;;font-weight:bold"' if($wert <= 1.48);
}
}
</pre>

=== Die zugehörige .gplot Datei ===
SVG_FileLog_Spritpreise_1.gplot
<pre>
# Created by FHEM/98_SVG.pm, 2014-10-22 12:57:34
set terminal png transparent size <SIZE> crop
set output '<OUT>.png'
set xdata time
set timefmt "%Y-%m-%d_%H:%M:%S"
set xlabel " "
set title 'Spritpreise'
set ytics
set y2tics
set grid
set ylabel "Preise (€/Liter)"
set y2label "Preise (€/Liter)"

#FileLog 4:Aral.Diesel\x3a:1:
#FileLog 4:Shell.Diesel\x3a:1:
#FileLog 4:Total.Diesel\x3a:1:
#FileLog 4:Aral.SuperE5\x3a:1:
#FileLog 4:Shell.SuperE5\x3a:1:
#FileLog 4:Total.SuperE5\x3a:1:

plot "<IN>" using 1:2 axes x1y2 title 'Aral Diesel' ls l2 lw 1 with lines,\
"<IN>" using 1:2 axes x1y2 title 'Shell Diesel' ls l1 lw 1 with lines,\
"<IN>" using 1:2 axes x1y2 title 'Total Diesel' ls l0 lw 1 with lines,\
"<IN>" using 1:2 axes x1y2 title 'Aral Super' ls l3 lw 1 with lines,\
"<IN>" using 1:2 axes x1y2 title 'Shell Super' ls l4 lw 1 with lines,\
"<IN>" using 1:2 axes x1y2 title 'Total Super' ls l5 lw 1 with lines
</pre>

== Tricks für HTTPMOD ==
Je nach Internetverbindung und Geschwindigkeit des Fhem Rechners kann das Modul manchmal Probleme haben, die Daten schnell genug zu verarbeiten.

Eine Lösung dazu wäre, die Daten vorher mit wget auf einem eigenen Webserver zu speichern (z.B. ein lokaler Apache) und HTTPMOD auf diesen zugreifen zu lassen.

== Links ==
* Vorstellung und Diskussion im {{Link2Forum|Topic=22554|LinkText=Fhem Forum}}
* Der "Datenlieferant": [http://www.clever-tanken.de/ Clever Tanken]
* Eine Anleitung, wie man das mit wget macht, gibt es {{Link2Forum|Topic=28123|Message=216228|LinkText=hier}} (ist aber noch nicht ganz fertig)
* Umsetzung für [http://www.cyberwulf.de/2016/fhem-spritpreise-von-tankerkoenig-de/ Tankerkönig API]

[[Kategorie:Code Snippets]]
[[Kategorie:Examples]]

E-Mail senden

2014-02-28T18:30:42Z

Suelle:

Um aus FHEM heraus '''E-Mail senden''' zu können, sind abhängig von der verwendeten Platform unterschiedliche Vorgehensweisen erforderlich.

== Linux ==
=== FritzBox 7170 (non-chroot) oder "reine" Linuxe ===
Datei 99_email.pm im Modul-Verzeichnis mit folgender Funktion anlegen (oder in bestehende 99_irgendwas.pm kopieren):

<nowiki>sub fb_mail {
my $rcpt = $_[0];
my $subject = $_[1];
my $text = $_[2];
system("/bin/echo \"$text\" | /usr/bin/mail send -i - -s \"$subject\" -t \"$rcpt\"");
}</nowiki>
Aufruf dann mittels
:<code>{ fb_mail('empfaenger@@mail.de','Subject','text 123') }</code>
Darauf achten, dass der fhem-User Mails senden darf (in richtige Gruppe eintragen. Ggf. vorher einmal su fhem und probieren).

=== Fritz!Box 7390 ===
Auf der [[AVM Fritz!Box|FritzBox 7390]] ist diese Funktion seit 10/2012 Bestandteil der Fhem Standardauslieferung. Sie ist untergebracht in FritzBoxUtils.pm und heisst dort FB_mail($$$) (Groß-Kleinschreibung beachten).

Da der Dateiname von FritzBoxUtils.pm nicht mit 99_ beginnt, wird diese Programmdatei nicht automatisch beim Start von Fhem geladen. Fhem muss zum Laden dieser Programmdatei aufgefordert werden. Dazu (z. B. in 99_myUtils.pm) die Zeile ''use FritzBoxUtils;'' einfügen.

Mit dem Install von AVM.de wird fhem in einer chroot-Umgebung ausgeführt, die den Zugriff auf die Mailfunktion der Fritzbox nicht zulässt. Daher muss Fhem in der [http://fhem.de/fhem.html#Download Version von fhem.de] installiert sein. Sollte Ihre Fritzbox bisher mit dem install von AVM laufen, kann (nach einem backup!) das image von fhem.de einfach drüberinstalliert werden. Es sollten dabei alle Einstellungen erhalten bleiben.

<nowiki>sub fb_mail {
my $rcpt = $_[0];
my $subject = $_[1];
my $text = $_[2];
system("/bin/echo \"$text\" > /var/tmp/fhem_nachricht.txt");
system("/sbin/mailer send -i '/var/tmp/fhem_nachricht.txt' -s \"$subject\" -t \"$rcpt\"");
system("rm /var/tmp/fhem_nachricht.txt");
}</nowiki>

Aufruf dann mittels
:<code>{ fb_mail('empfaenger@mail.de','Subject','text 123') }</code>
bzw.
:<code>{ FB_mail('empfaenger@mail.de','Subject','text 123') }</code>

'''Hinweis:''' Wenn der Aufruf der Mailfunktion aus einem notify oder at erfolgt, muss das @@ in der Adresse des Mailempfängers verdoppelt werden, da ein einfaches @ sonst durch den Namen des getriggerten Devices ersetzt würde. Bei Verwendung in der fhem-Kommandozeile oder einem eigenen *Utils.pm ist diese Doppelung nicht erforderlich. Bitte bei den ersten Mails ins Log schauen, ob die Mailadresse wie gewünscht verwendet wird.

Dem Mailer können noch weitere Parameter hinzugefügt werden. Mehr dazu siehe: [http://www.wehavemorefun.de/fritzbox/Mailer Mailer]

=== OpenWRT ===
Die Anleitung wurde mit einer frühen Beta von Barrier Breaker (r391xx) mit einem TP_Lind WDR 4900 getestet. Da "sendEmail" nicht als Package vorliegt wird in dieser Anleitung "ssmtp" verwendet.
Die Installation erfolgt mittels:

<pre>
opkg update
opkg install ssmtp_2.64-4_mpc85xx.ipk
</pre>

Hierbei werden die Packete libopenssl und zlib mit installiert. Damit ssmtp funktioniert müssen die Dateien /etc/ssmtp/ssmtp.conf und /etc/ssmtp/revaliases angepasst werden.

/etc/ssmtp/ssmtp.conf
<nowiki>root=arnold@gmx.net
mailhub=mail.gmx.net:465
rewriteDomain=gmx.net
hostname=gmx.net
FromLineOverride=YES
UseTLS=YES
#UseSTARTTLS=YES
AuthUser=arnold@gmx.net
AuthPass=Passwort_von_arnold@gmx.net
</nowiki>

/etc/ssmtp/revaliases
<nowiki>
root:arnold@gmx.net:mail.gmx.net:465</nowiki>

In der [[99_myUtils_anlegen|99_myUtils]] folgende Unterroutine einfügen (von der RPi-Anleitung übernommen):

<nowiki>sub
OpenWRTMail
{
my $rcpt = shift;
my $subject = shift;
my $text = shift;
my $ret = "";
my $sender = "dockstar\@heye-tammo.de";
Log 1, "sendEmail RCP: $rcpt, Subject: $subject, Text: $text";
$ret .= qx(echo -e 'to:$rcpt\n from:$sender\nsubject:$subject\n$text\n' | ssmtp $rcpt);
$ret =~ s,[\r\n]*,,g; # remove CR from return-string
Log 1, "sendEmail returned: $ret";
}</nowiki>

Ab hier den entsprechenden Abschnitt unter "Raspberry Pi" lesen.

=== Synology DiskStation ===
Beim DSM 3.2 gab es keinen <code>sendmail</code>-Befehl, sondern nur eine Funktion für den Versand der System-Benachrichtigungen. Interessanterweise funktionierte aber der <code>php-mail</code>-Befehl, so dass man mittels folgendem Modul Mails frei versenden kann:

<nowiki>sub sendmail($$$) {
my($empf, $subj, $nachricht) = @_;
system("php -r 'mail(\"$empf\",\"$subj\",\"$nachricht\");'");
undef;
}</nowiki>

=== Raspberry Pi ===
In der weezy-Version, wie sie von busware zur Verfügung gestellt wird, muss auf einem [[Raspberry Pi]] noch sendEmail nachinstalliert werden:

<pre>
sudo apt-get update
sudo apt-get install sendEmail
</pre>

in der [[99_myUtils_anlegen|99_myUtils]] folgende Unterroutine einfügen:

<nowiki>######## DebianMail Mail auf dem RPi versenden ############
sub
DebianMail
{
my $rcpt = shift;
my $subject = shift;
my $text = shift;
my $ret = "";
my $sender = "absender\@account.de";
my $konto = "kontoname\@account.de";
my $passwrd = "passwrd";
my $provider = "smtp.provider.de";
Log 1, "sendEmail RCP: $rcpt";
Log 1, "sendEmail Subject: $subject";
Log 1, "sendEmail Text: $text";

$ret .= qx(sendEmail -f '$sender' -t '$rcpt' -u '$subject' -m '$text' -s '$provider' -xu '$konto' -xp '$passwrd' -o tls=no);
$ret =~ s,[\r\n]*,,g; # remove CR from return-string
Log 1, "sendEmail returned: $ret";
}</nowiki>

Um die TLS Verschlüsselung (ehem. SSL) zu nutzen, muss in der 4. letzten Zeile tls=auto verwendet werden. Sollte anschließend keine Mail verschickt werden, siehe Probleme.

Beim Aufruf der Funktion gibt es zwei unterschiedliche Verhaltensweisen zu beachten. Wird DebianMail durch ein Fhem-Ereignis als Makro mit "Transferzeichen", wie @ oder % aufgerufen, so sind diese innerhalb des Aufrufs von DebianMail zu maskieren.

Siehe auch commandref:
* The character @ will be replaced with the device name. To use @ in the text itself, use the double mode (@@).
* The macro %<parameter> will expand to the current value of the named parameter. This can be either a parameter from the device definition or a parameter from the set or get command.

Beispiel:

<nowiki>define Sonstiges notify Fenster:Window:.*,.*Low.Batt*. {\
DebianMail('email@@email.domain','Subject','Text');;\
}</nowiki>

in allen anderen Fällen muss die Maskierung entfallen:

Beispiel:

<nowiki>define Sonstiges at *01:00:00 {\
DebianMail('email@email.domain','Subject','Text');;\
}</nowiki>

=== BeagleBoard-xM ===
Auf einem [[:Kategorie:BeagleBoard-xM|BeagleBoard-xM]] mit einem [http://en.opensuse.org/HCL:BeagleBoard-xM OpenSUSE 12.2] kann man ebenfalls das Perl-Programm ''sendEmail'' wie beim RPi nutzen. Dies gibt es aber nicht in den Repositories von openSUSE, sondern man muss sich ''sendEmail'' als Source herunterladen. Das geht am einfachsten per ''wget'', welches man ebenfalls erst installieren muss (aber aus einem Repository).

<nowiki>$ zypper in wget
$ cd /opt
$ wget http://caspian.dotconf.net/menu/Software/SendEmail/sendEmail-v1.56.tar.gz
$ tar xvfz sendEmail-v1.56.tar.gz
$ cd sendEmail-v1.56
$ cp sendMail /usr/local/bin</nowiki>
Dann geht man weiter vor wie unter RPi beschrieben (anlegen der SUB-Routine in 99_myUtils usw.).

'''Hinweis:''' Die Version 1.56 von ''sendEmail'' ist Stand Januar 2013 die aktuelle. Da diese Programmversion von 2009 stammt, ist mit neuen Versionen selten zu rechnen. Vielleicht schauen Sie trotzdem vorher auf der [http://caspian.dotconf.net/menu/Software/SendEmail/ Homepage von sendEmail] nach.

== Windows ==
# Kopiere die Datei sendEmail.exe* in Dein FHEM Verzeichnis (hier c:\fhem-5.0\); Quelle: [http://caspian.dotconf.net/menu/Software/SendEmail/ http://caspian.dotconf.net/menu/Software/SendEmail/]
# Erstelle im FHEM Verzeichnis die Datei wmail.bat mit folgendem Inhalt (eine Zeile): <br><code>sendEmail -f absender@domain.de -u "%1" -m " " -s SMTP-SERVERAdresse -xu SMTP_USERNAME -xp SMTP_PASSWORT -t empfänger@domain.de -o message-header="X-Message-Flag: FHEM"</code>
# Beispiel fhem.cfg
## Mail wenn sich der Status von Heizung.* oder Hzg.* ändert <br><code>define Mail_Heizung notify Heizung.*|Hzg.* { system("wmail @:%")}</code>
## Mail bei Signal Aussentemperatur (für dieses Beispiel wird [http://fhem.de/commandref.html#getstate http://fhem.de/commandref.html#getstate getstate] benötigt) <br><code>define Mail_Aussentemperatur notify Aussentemperatur {\</code><br><code>my ($val);;\</code><br><code>$val = fhem "getstate @";;\</code><br><code>system("wmail \"@: $val\"");;\</code><br><code>}</code>

== Probleme ==
=== sendEmail ===
Falls man keine E-Mails verschicken kann, kann man in einem ersten Test prüfen, ob sendEmail als solches funktioniert und die Konfiguration (Benutzer, Passwort, Server-Name usw.) des Mail-Kontos, über das die Mails abgesetzt werden sollen, richtig ist.

Hierzu setzt man in der FHEM-Befehlszeile die folgende Anweisung ab:
:<code>{ SUB-Routinen-Name('EMailAdresse@Mail.Domain','Test','Test-Text');; }</code>
und ersetzt ''SUB-Routinen-Name'' durch den Namen der in 99_myUtils erzeugten Prozedur. Statt ''EMailAdresse@Mail.Domain'' trägt man noch eine gültige E-Mail-Adresse ein und bestätigt den Befehl dann mittels <Enter> (nicht "save"). Empfangen Sie nicht kurzfristig eine entsprechende E-Mail, ist sehr wahrscheinlich an den Zugangsdaten etwas verkehrt.

Vor dem testen der Routine oben kann sendEmail auch über die Konsole (z. B. via Putty) getestet werden:
:<code>sendEmail -f 'fhemsystem@meinedomain.tld' -t 'ich@meinedomain.tld' -u 'subject' -m 'body' -s 'meinmailserver.meinedomain.de' -xu 'fhemmailer' -xp 'geheimespassword' -o tls=no</code>

=== Keine Mail mit TLS Verschlüsselung ===
Den Test über die Konsole durchführen. Erhält man folgende Fehlermeldung:
''invalid SSL_version specified at /usr/share/perl5/IO/Socket/SSL.pm line 332''
muss auf dem Raspberry folgende Datei angepasst werden: ''/usr/share/perl5/IO/Socket/SSL.pm''.
In Zeile 1490 muss das $ am Ende entfernt werden: m{^(!?)(?:(SSL(?:v2|v3|v23|v2/3))|(TLSv1[12]?))$}i

== Email laut Log gesendet aber nicht angekommen? ==
Dann bitte in der Fritzbox Oberfläche überpüfen, ob unter "System" -> "Push Service" selbiger eingerichtet und aktiviert wurde.

[[Kategorie:HOWTOS]]
[[Kategorie:FritzBox]]
[[Kategorie:BeagleBoard-xM]]
[[Kategorie:Raspberry Pi]]

HM-LC-Dim1L-Pl-2 Funk-Zwischenstecker-Dimmaktor 1fach Phasenanschnitt

2013-12-28T14:16:02Z

Suelle: /* FHEM Config-Auszug */

'''HomeMatic HM-LC-Dim1L-Pl-2 Funk-Zwischenstecker-Dimmaktor 1fach Phasenanschnitt'''

HomeMatic Funk-Zwischenstecker-Dimmaktor 1fach, Phasenanschnitt

= Features =

Dimmen eines angeschlossenen Verbrauchers mittels CUL/CUN/HMLAN Konfigurator.

'''Technische Daten:'''
* Anschlussleistung: 25 - 250 VA
* Standby Verbrauch: 0,5W
* Schutzart: IP20
* Farbe: Reinweiß mit silberner Blende
* Maße(HxBxT): 125x63x40mm

= Hinweise zum Betrieb mit FHEM =

Das Pairing sollte wie in [[HomeMatic Devices pairen]] beschrieben durchgeführt werden.

== FHEM Config-Auszug ==

Ein exemplarischer Auszug aus der fhem.cfg:
<pre>
define <name> CUL_HM 208xxx
attr <name> .devInfo 010100
attr <name> .stc 20
attr <name> autoReadReg 4_reqStatus
attr <name> expert 2_full
attr <name> firmware 2.3
attr <name> model HM-LC-Dim1L-Pl-2
attr <name> peerIDs 00000000,00005301,00005302,
attr <name> serialNr KEQ020xxxx
attr <name> subType dimmer
attr <name> webCmd on:off:pct
define FileLog_<name> FileLog ./log/<name>-%Y.log <name>
attr FileLog_<name> logtype text
attr FileLog_<name> room CUL_HM
</pre>

== Mögliche Dimmoperationen ==

Der Dimmaktor versteht folgende Aktionen:
<pre>
set <name> on # schaltet den Aktor ein
set <name> off # schaltet den Aktor aus
set <name> toggle # schaltet den Aktor um
set <name> on-for-timer <sec> # schaltet den Aktor für <sec> ein
set <name> on-till <time> # schaltet den Aktor bis <time> ein (hh:mm:ss)
set <name> <value> [<on-time>] [<ramp-time>] # schaltet den Aktor auf <value> Prozent, <on-time> und <ramp-time> sind optional

# Beispiele
set <name> 50 0 60 # der Aktor dimmt in 60 Sekunden auf 50%
set <name> 75 300 180 # der Aktor dimmt in 180 Sekunden auf 75% und bleibt 5 Minuten an
set <name> 0 0 600 # der Aktor dimmt in 10 Minuten herunter (muss vorer eine Wert >0 haben) bis er aus ist
</pre>

== Log-Auszug ==
In FHEM ist nach dem Schalten des HM-LC-Dim1L-Pl-2 folgendes Log zu sehen:
<pre>
2013-12-28_14:35:29 <name> set_on
2013-12-28_14:35:29 <name> level: 100 %
2013-12-28_14:35:29 <name> pct: 100
2013-12-28_14:35:29 <name> deviceMsg: on (to HMLAN)
2013-12-28_14:35:29 <name> on
2013-12-28_14:35:29 <name> timedOn: off
2013-12-28_14:35:29 <name> dim: stop:on
2013-12-28_14:35:29 <name> overload: off
2013-12-28_14:35:29 <name> overheat: off
2013-12-28_14:35:29 <name> reduced: off
</pre>

== Probleme ==
= Links =

Anleitung: [http://www.elv-downloads.de/Assets/Produkte/7/767/76797/Downloads/76797_HM-LC-Sw1-Pl-2_UM_GE_eQ-3_120723_um.pdf PDF]

[[Kategorie:HomeMatic Components]]
[[Kategorie:Dimmer]]

HM-LC-Dim1L-Pl-2 Funk-Zwischenstecker-Dimmaktor 1fach Phasenanschnitt

2013-12-28T14:14:22Z

Suelle: /* Log-Auszug */

'''HomeMatic HM-LC-Dim1L-Pl-2 Funk-Zwischenstecker-Dimmaktor 1fach Phasenanschnitt'''

HomeMatic Funk-Zwischenstecker-Dimmaktor 1fach, Phasenanschnitt

= Features =

Dimmen eines angeschlossenen Verbrauchers mittels CUL/CUN/HMLAN Konfigurator.

'''Technische Daten:'''
* Anschlussleistung: 25 - 250 VA
* Standby Verbrauch: 0,5W
* Schutzart: IP20
* Farbe: Reinweiß mit silberner Blende
* Maße(HxBxT): 125x63x40mm

= Hinweise zum Betrieb mit FHEM =

Das Pairing sollte wie in [[HomeMatic Devices pairen]] beschrieben durchgeführt werden.

== FHEM Config-Auszug ==

Ein exemplarischer Auszug aus der fhem.cfg:
<pre>
<< bitte ergänzen >>
</pre>

== Mögliche Dimmoperationen ==

Der Dimmaktor versteht folgende Aktionen:
<pre>
set <name> on # schaltet den Aktor ein
set <name> off # schaltet den Aktor aus
set <name> toggle # schaltet den Aktor um
set <name> on-for-timer <sec> # schaltet den Aktor für <sec> ein
set <name> on-till <time> # schaltet den Aktor bis <time> ein (hh:mm:ss)
set <name> <value> [<on-time>] [<ramp-time>] # schaltet den Aktor auf <value> Prozent, <on-time> und <ramp-time> sind optional

# Beispiele
set <name> 50 0 60 # der Aktor dimmt in 60 Sekunden auf 50%
set <name> 75 300 180 # der Aktor dimmt in 180 Sekunden auf 75% und bleibt 5 Minuten an
set <name> 0 0 600 # der Aktor dimmt in 10 Minuten herunter (muss vorer eine Wert >0 haben) bis er aus ist
</pre>

== Log-Auszug ==
In FHEM ist nach dem Schalten des HM-LC-Dim1L-Pl-2 folgendes Log zu sehen:
<pre>
2013-12-28_14:35:29 <name> set_on
2013-12-28_14:35:29 <name> level: 100 %
2013-12-28_14:35:29 <name> pct: 100
2013-12-28_14:35:29 <name> deviceMsg: on (to HMLAN)
2013-12-28_14:35:29 <name> on
2013-12-28_14:35:29 <name> timedOn: off
2013-12-28_14:35:29 <name> dim: stop:on
2013-12-28_14:35:29 <name> overload: off
2013-12-28_14:35:29 <name> overheat: off
2013-12-28_14:35:29 <name> reduced: off
</pre>

== Probleme ==
= Links =

Anleitung: [http://www.elv-downloads.de/Assets/Produkte/7/767/76797/Downloads/76797_HM-LC-Sw1-Pl-2_UM_GE_eQ-3_120723_um.pdf PDF]

[[Kategorie:HomeMatic Components]]
[[Kategorie:Dimmer]]

HM-LC-Dim1L-Pl-2 Funk-Zwischenstecker-Dimmaktor 1fach Phasenanschnitt

2013-12-28T14:12:00Z

Suelle: /* Mögliche Dimmoperationen */