FHEMWiki - Benutzerbeiträge [de]

FHEM Tablet UI

2017-11-12T11:41:03Z

Waschto: Link zur einer FHEM und TabletUI Live-Demo hinzugefügt

{{Infobox Modul
|ModPurpose=Oberfläche für FHEM
|ModType=x
|ModFTopic=34233
|ModForumArea=Frontends
|ModTechName=n.a.
|ModOwner=setstate ({{Link2FU|7023|Forum}})
}}
[[FHEM Tablet UI]] (FTUI) ist ein leichtgewichtiges aber funktionsreiches Frontend-Framework zum Steuern und Überwachen von in FHEM integrierten Geräten. Es basiert auf HTML/CSS/JavaScript und stellt somit keine zusätzlichen Anforderungen an den FHEM-Server.

Mit Hilfe zahlreicher Widgets, die sehr leicht mit HTML Code konfiguriert werden können, ist es möglich, innerhalb kurzer Zeit ein den eigenen Wünschen entsprechendes User-Interface aufzubauen.

Für den Betrieb ist nur eine FHEM-Installation mit [[HTTPSRV|HTTPSRV-Modul]] sowie ein gängiger Webbrowser notwendig.

Mit wenigen Anpassungen ist es auch möglich das UI auf anderen Webservern (Apache, u.a.) zu betreiben. Somit können FHEM und FHEM Tablet UI auch auf getrennten Systemen ausgeführt werden.

[[File:tablet_ui.png|thumb|500px|center|Beispiel für ein mit [[FHEM Tablet UI]] erstelltes User-Interface]]

{{Todo|Design-Möglichkeiten erklären, Navigationsmethoden ausformulieren}}

== Installation ==
Die Installation von FHEM Tablet UI erzeugt keinen großen Aufwand und besteht im Großen und Ganzen aus drei Schritten:
*Dateien aus dem GitHub-Repository herunterladen
*FHEM konfigurieren ([[HTTPSRV]]-Device erstellen, [[FHEMWEB]]-Attribut longpoll einstellen)
*Eine Beispieldatei anlegen

{{Hinweis|Diese Anleitung geht davon aus, dass FHEM unter Debian nach der Anleitung [https://debian.fhem.de Stable build using apt] installiert wurde.
Ist dies nicht der Fall, muss der Pfad '''/opt/fhem''' dementsprechend angepasst werden.}}

'''1.''' Zuerst müssen alle Dateien von FHEM Tablet UI in das FHEM-Verzeichnis '''/opt/fhem/www''' kopiert werden. Das geht mit folgendem '''update'''-Befehl über die FHEM-Befehlszeile.
:<code>update all https://raw.githubusercontent.com/knowthelist/fhem-tablet-ui/master/controls_fhemtabletui.txt</code>

:[[Datei:FTUI_Installation_01.png|thumb|none|Schritt 1: Dateien kopieren]]

'''2.''' Anschließend ist ein neues [[HTTPSRV]]-Device in FHEM anzulegen, welches auf den Ordner mit den gerade heruntergeladenen Dateien verweist.
:<code>define TABLETUI HTTPSRV ftui/ ./www/tablet/ Tablet-UI</code>

:[[Datei:FTUI_Installation_02.png|thumb|none|Schritt 2: HTTPSRV-Device anlegen]]

'''3.''' Damit FHEM Tablet UI mit FHEM kommunizieren kann, ist noch die '''longpoll'''-Einstellung im [[FHEMWEB]] Device festzulegen.

:<code>attr WEB longpoll websocket</code>
:bzw. bei Problemen mit ''websocket''
:<code>attr WEB longpoll 1</code>

:[[Datei:FTUI_Installation_03.png|thumb|none|Schritt 3: longpoll einstellen]]

'''4.''' Weil FTUI noch nichts anzuzeigen hat, wird die Datei '''/opt/fhem/www/tablet/index-example.html''' nach '''/opt/fhem/www/tablet/index.html''' kopiert.
:<code>sudo cp -a /opt/fhem/www/tablet/index-example.html /opt/fhem/www/tablet/index.html</code>

:[[Datei:FTUI_Installation_04.png|thumb|none|Schritt 4: index.html erstellen]]

'''5.''' Abschließend muss FHEM noch '''neu gestartet''' werden (''shutdown restart'') da das Attribut '''longpoll''' geändert wurde.

Somit ist FHEM Tablet UI bereit zur Verwendung und kann durch Aufruf der URL '''<nowiki>http://<fhem-server>:8083/fhem/ftui</nowiki>''' oder den Link im FHEM-Menü geöffnet werden

== Update ==
Ein Update von FTUI kann ebenfalls über die FHEM-Kommandozeile erfolgen.

'''1.''' 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>

'''2.''' Update der geänderten Dateien durch Eingabe von:
:<code><nowiki>update all https://raw.githubusercontent.com/knowthelist/fhem-tablet-ui/master/controls_fhemtabletui.txt</nowiki></code>

Eine weitere Option ist das Hinzufügen des FTUI-Git-Repositories zum allgemeinem Update-Vorgang von FHEM. Dabei wird dann bei einem FHEM-Update auch gleich FHEM Tablet UI aktualisiert, bzw. die Änderungen angezeigt.
:<code><nowiki>update add https://raw.githubusercontent.com/knowthelist/fhem-tablet-ui/master/controls_fhemtabletui.txt</nowiki></code>

== Konfiguration ==
===DOCTYPE===
In allen HTML-Dateien, die im Browser geladen werden und das typische HTML-Gerüst besitzen (also alle Hauptseiten, jedoch keine Template-Dateien), sollte eine DOCTYPE-Deklaration eingefügt werden. Mit ihr wird festgelegt, in welcher Version der nachfolgende HTML-Code vom Browser interpretiert werden soll. Lässt man sie weg, oder definiert sie auf verschiedenen Seiten unterschiedlich, kann ein und der selbe HTML-Code zu unterschiedlichen Darstellungen führen. Die DOCTYPE-Deklaration erfolgt immer auch der ersten Zeile, noch vor dem <code><html></code>-Tag. Nachfolgend wird HTML5 verwendet.

<syntaxhighlight lang="html">
<!DOCTYPE html>
<html>
<head>...</head>
<body>...</body>
</html>
</syntaxhighlight>

===META-Parameter===
Das Tablet UI lässt sich über die META-Parameter konfigurieren. Diese Parameter sind in jeder '''.html''' Datei (z.B. index.html) im Abschnitt '''<head>''' einzutragen. Ausgenommen davon sind Dateien, die als Template, Pagebutton-Zielseiten oder ähnliches eingebunden werden.

Die Parameter sind immer nach diesem Schema aufgebaut:
<meta name="[Parameter-Name]" content="[Parameter-Wert]">

===Verbindung zu FHEM===
{| class="wikitable"
|-
!Parameter-Name!!Standard-Wert!!Mögliche Werte!!Beschreibung
|-
|web_device||WEB||String||FHEM-Device, welches für das Polling verwendet wird
|-
|longpoll||1||0, 1||
'''0''': Longpoll deaktiviert; alle 30s ein Shortpoll (Neuladen der gesamten Statusänderungen)

'''1''': Longpoll aktiv; geänderte Stati werden sofort aktualisiert, zusätzlich werden alle 15min die gesamten Statusänderungen geladen.
|-
|longpoll_type||websocket||websocket, ajax, 0||
'''websocket''': Für die Aktualisierung der Daten wird das Websocket-Protokoll verwendet. Werden vom Browser keine Websockets unterstützt, gibt es einen automatischen Fallback auf Ajax.

'''ajax''': Ajax wird für die Aktualisierung verwendet.

'''0''': Longpoll deaktiviert, Shortpoll wird verwendet.
|-
|longpoll_filter||.*||RegEx||Event-Filter. Kann verwendet werden, wenn z.B. Devices, die in FTUI angezeigt werden, in einem eigenen FHEM-Room sind.
|-
|longpoll_maxage||240||Integer||Kommen in diesem Zeitraum (Sekunden) keine Longpoll-Events bei FTUI an, wird die Verbindung als "disconnected" angesehen und ein neuer Verbindungsversuch wird gestartet.
|-
|shortpoll_interval||900||Integer||Zeitraum in Sekunden, nach dem ein vollständiger Refresh stattfindet
|-
|shortpoll_only_interval||30||Integer||Zeitraum in Sekunden, nach dem ein vollständiger Refresh stattfindet, sollte Longpoll deaktiviert sein
|-
|fhemweb_url||/fhem/||Integer||URL zu FHEM. Wird benötigt wenn FTUI auf einem anderen als dem FHEM Server läuft oder nicht im Standard-Pfad installiert ist.
Hinweis: Wenn FHEM auf einem anderem Server/Domain läuft muss man das "CORS" Attribut im FHEMWEB Modul (s.o.) auf 1 setzen, sonst bekommt man Cross Origin Fehler.
|}

===Funktionalität===
{| class="wikitable"
|-
!Parameter-Name!!Standard-Wert!!Mögliche Werte!!Beschreibung
|-
|debug||0||0 - 5||Log-Level
|-
|toast||5||Integer||Anzahl an gleichzeitig angezeigten Toast-Nachrichten. Um keine anzuzeigen, ist der Wert auf 0 zu setzen.
|-
|toast_position||bottom-left||||Position im Browserfenster, wo die Toast-Nachrichten angezeigt werden.
|-
|lang||de||de||Sprache der Oberfläche (für z.B. Datums-/Zeitfunktionen)
|-
|username||||String||Benutzername für eine Basic-Authentifierung *
|-
|password||||String||Passwort für eine Basic-Authentifizierung *
|}
'''*''' Derzeit wird die Basic-Authentifizierung in Kombination mit WebSockets nicht unterstützt. Die Verwendung von '''longpoll=1''' (ajax) ist daher notwendig.

===Toast-Nachrichten===
[[Datei:Ftui_toast.png|thumb|Toast-Nachrichten]]
Tablet-UI liefert Informationen darüber, was im Moment gerade passiert. Das geschieht über Toast-Nachrichten, die in der Standardeinstellung unten links im Browser auftauchen.

Wird beispielsweise ein Gerät eingeschaltet, so erscheint eine kleine Nachricht mit dem abgesetzten Befehl. Auch Fehlermeldungen und Statusinformationen werden angezeigt. Ob überhaupt und was konkret angezeigt wird, richtet sich nach dem eingestellten Debug-Level (siehe oben). Beim Debug-Level 5 werden alle Nachrichten angezeigt, bei 0 keine.

Die Position der Toast-Nachrichten kann über den Meta-Tag <code>meta name='toast_position'</code> festgelegt werden. Für oben-mittig müsste folgender Code eingefügt werden:
<pre><meta name='toast_position' content='top-center'></pre>

Möglich sind folgende Positionen:
* <code>top-left</code>
* <code>top-right</code>
* <code>bottom-left</code>
* <code>bottom-right</code>
* <code>top-center</code>
* <code>bottom-center</code>
* <code>mid-center</code>

Die maximale Anzahl an Nachrichten, die gleichzeitig angezeigt werden können, lässt sich mit <code>meta name='toast'</code> Sind maximal 2 Nachrichten gewünscht, muss folgender Meta-Tag gesetzt werden:
<pre><meta name='toast' content='2'></pre>

==Navigationsmethoden==
{{Todo|Dieser Abschnitt dient derzeit lediglich als Sammlung von Stichpunkten und muss vollständig überarbeitet werden.}}

'''Unterschied zwischen Pagetab und Pagebutton:

'''Pagetab:''' Ganze Seite austauschen -> Menü muss auf jede Seite
[[FTUI_Widget_Pagetab]]

'''Pagebutton:''' Teil der Seite austauschen -> Menü nur in erster Seite
[[FTUI_Widget_Pagebutton]]

==Gestaltung==
===Layout-Optionen===
* [[FTUI Layout Gridster|Gridster]]
* [[FTUI Layout Flex|Flex]]
* [[FTUI Layout Sheet|Tabelle]]
* [[FTUI Layout Row|Reihen]]

=== Farben ===
Es besteht die Möglichkeit, die Farbwerte in hexadezimaler Form, als RGB-Wert oder mit dem Farbnamen anzugeben. Zum Beispiel:

*HEX: #ADD8E6
*RBG: rgb(173, 216, 230)
*Namen: lightblue

Knallige Farben wie '''<span style="color: #ff0000;">#ff0000</span>''' für Rot oder '''<span style="color: #00ff00;">#00ff00</span>''' für Grün sollten vermieden werden.
Es ist besser unterhalb von #D0 (208) für die Grundfarben zu bleiben.

Empfohlene Farben sind z.B.:

*Orange: <span style="color: #aa6900;">#aa6900</span>
*Rot: <span style="color: #ad3333;">#ad3333</span>
*Grün: <span style="color: #32a054;">#32a054</span>
*Blau: <span style="color: #6699FF;">#6699FF</span>
*Grau: <span style="color: #8C8C8C;">#8C8C8C</span>

Hilfreich bei der Suche nach den Farbwerten ist zum Beispiel der Color-Picker auf dieser Seite: http://www.colorpicker.com. Für die Suche nach Farben, die einen guten Kontrast bilden, diese Webseite: http://vanisoft.pl/~lopuszanski/public/colors/

Im Ordner ''css'' der FTUI Installation finden sich einige vorbereitete Farbschemas. Diese können mit einem zusätzlichen Eintrag im <nowiki><head></nowiki>-Bereich der FTUI-Seite(n) aktiviert werden.

Hier am Beispiel eines blauen Farbschemas:
<syntaxhighlight lang="html">
<html>
<head>
[...]
<link rel="stylesheet" href="/fhem/tablet/css/fhem-blue-ui.css" />
[...]
</head>
</syntaxhighlight>

Diese Schema-Dateien ändern alle Widgets. Einzelne Widgets können durch Hinzufügen der jeweiligen [[#CSS-Klassen|CSS-Klasse]] geändert werden.

===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-Klassen|CSS-Klassen]] aufgeführt.

Soll das Aussehen des UI durch eigene CSS-Klassen oder durch Überschreiben der vorhandenen verändert werden, kann eine eigene CSS-Datei erstellt werden, die dann bei einem eventuellen Update von FTUI nicht überschrieben wird. Diese Datei muss den Dateinamen '''fhem-tablet-ui-user.css''' haben und im Ordner '''/fhem/tablet/css''' abgelegt werden. Sie wird dann beim Aufruf von FTUI automatisch mitgeladen.

=== CSS-Klassen ===
Nicht alle Widgets unterstützen alle hier angegebenen Klassen. Welche genau unterstützt werden, kann auf der jeweiligen Widget-Seite nachgelesen werden.

{|class="wikitable mw-collapsible mw-collapsed" style="width: 100%;"
!colspan="2" style="text-align: left;"|sheet/row/cell-Layout
|-
!class="mw-collapsible-content"|Klasse!!Beschreibung
{{FTUI Klasse|sheet}}{{FTUI Klasse|row}}{{FTUI Klasse|cell}}{{FTUI Klasse|cell-1-x}}{{FTUI Klasse|cell-x}}{{FTUI Klasse|left-align}}{{FTUI Klasse|right-align}}{{FTUI Klasse|bottom-align}}{{FTUI Klasse|top-align}}{{FTUI Klasse|center-align}}
|}

{|class="wikitable mw-collapsible mw-collapsed" style="width: 100%;"
!colspan="2" style="text-align: left;"|row/col-Layout
|-
!class="mw-collapsible-content"|Klasse!!Beschreibung
{{FTUI Klasse|col}}{{FTUI Klasse|col-1-x}}{{FTUI Klasse|col-x}}
|}

{|class="wikitable mw-collapsible mw-collapsed" style="width: 100%;"
!colspan="2" style="text-align: left;"|hbox/vbox-Layout
|-
!class="mw-collapsible-content"|Klasse!!Beschreibung
{{FTUI Klasse|vbox}}{{FTUI Klasse|hbox}}{{FTUI Klasse|card}}{{FTUI Klasse|phone-width}}{{FTUI Klasse|full-height}}{{FTUI Klasse|full-width}}{{FTUI Klasse|grow-0}}{{FTUI Klasse|grow-1}}{{FTUI Klasse|grow-2}}{{FTUI Klasse|grow-x}}{{FTUI Klasse|items-top}}{{FTUI Klasse|items-center}}{{FTUI Klasse|items-bottom}}{{FTUI Klasse|items-space-between}}{{FTUI Klasse|items-space-around}}
|}

{|class="wikitable mw-collapsible mw-collapsed" style="width: 100%;"
!colspan="2" style="text-align: left;"|Generelle Klassen für die Positionierung
|-
!class="mw-collapsible-content"|Klasse!!Beschreibung
{{FTUI Klasse|inline}}{{FTUI Klasse|newline}}{{FTUI Klasse|top-space}}{{FTUI Klasse|top-space-2x}}{{FTUI Klasse|top-space-3x}}{{FTUI Klasse|left-space}}{{FTUI Klasse|left-space-2x}}{{FTUI Klasse|left-space-3x}}{{FTUI Klasse|right-space}}{{FTUI Klasse|right-space-2x}}{{FTUI Klasse|right-space-3x}}{{FTUI Klasse|top-narrow}}{{FTUI Klasse|top-narrow-2x}}{{FTUI Klasse|top-narrow-10}}{{FTUI Klasse|left-narrow}}{{FTUI Klasse|left-narrow-2x}}{{FTUI Klasse|left-narrow-3x}}{{FTUI Klasse|right-narrow}}{{FTUI Klasse|right-narrow-2x}}{{FTUI Klasse|right-narrow-3x}}{{FTUI Klasse|centered}}{{FTUI Klasse|wider}}{{FTUI Klasse|narrow}}{{FTUI Klasse|fullsize}}{{FTUI Klasse|compressed}}{{FTUI Klasse|height-narrow}}{{FTUI Klasse|w1x}}{{FTUI Klasse|w2x}}{{FTUI Klasse|w3x}}{{FTUI Klasse|maxw40}}{{FTUI Klasse|doublebox-v}}{{FTUI Klasse|doublebox-h}}{{FTUI Klasse|triplebox-v}}
|}

{|class="wikitable mw-collapsible mw-collapsed" style="width: 100%;"
!colspan="2" style="text-align: left;"|Vordergrundfarben
|-
!class="mw-collapsible-content"|Klasse!!Beschreibung
{{FTUI Klasse|red}}{{FTUI Klasse|green}}{{FTUI Klasse|blue}}{{FTUI Klasse|lightblue}}{{FTUI Klasse|orange}}{{FTUI Klasse|gray}}{{FTUI Klasse|lightgray}}{{FTUI Klasse|white}}{{FTUI Klasse|black}}{{FTUI Klasse|mint}}{{FTUI Klasse|yellow}}
|}

{|class="wikitable mw-collapsible mw-collapsed" style="width: 100%;"
!colspan="2" style="text-align: left;"|Hintergrundfarben
|-
!class="mw-collapsible-content"|Klasse!!Beschreibung
{{FTUI Klasse|bg-red}}{{FTUI Klasse|bg-green}}{{FTUI Klasse|bg-blue}}{{FTUI Klasse|bg-lightblue}}{{FTUI Klasse|bg-orange}}{{FTUI Klasse|bg-gray}}{{FTUI Klasse|bg-lightgray}}{{FTUI Klasse|bg-white}}{{FTUI Klasse|bg-black}}{{FTUI Klasse|bg-mint}}{{FTUI Klasse|bg-yellow}}
|}

{|class="wikitable mw-collapsible mw-collapsed" style="width: 100%;"
!colspan="2" style="text-align: left;"|Rahmen
|-
!class="mw-collapsible-content"|Klasse!!Beschreibung
{{FTUI Klasse|verticalLine}}{{FTUI Klasse|border-black}}{{FTUI Klasse|border-white}}{{FTUI Klasse|border-orange}}{{FTUI Klasse|border-red}}{{FTUI Klasse|border-green}}{{FTUI Klasse|border-mint}}{{FTUI Klasse|border-lightblue}}{{FTUI Klasse|border-blue}}{{FTUI Klasse|border-gray}}{{FTUI Klasse|border-yellow}}{{FTUI Klasse|border-lightgray}}
|}

{|class="wikitable mw-collapsible mw-collapsed" style="width: 100%;"
!colspan="2" style="text-align: left;"|Größen
|-
!class="mw-collapsible-content"|Klasse!!Beschreibung
{{FTUI Klasse|mini}}{{FTUI Klasse|tiny}}{{FTUI Klasse|small}}{{FTUI Klasse|normal}}{{FTUI Klasse|large}}{{FTUI Klasse|big}}{{FTUI Klasse|bigger}}{{FTUI Klasse|tall}}{{FTUI Klasse|great}}{{FTUI Klasse|grande}}{{FTUI Klasse|gigantic}}
|}

{|class="wikitable mw-collapsible mw-collapsed" style="width: 100%;"
!colspan="2" style="text-align: left;"|Schriftstil
|-
!class="mw-collapsible-content"|Klasse!!Beschreibung
{{FTUI Klasse|thin}}{{FTUI Klasse|bold}}{{FTUI Klasse|darker}}{{FTUI Klasse|truncate}}
|}

{|class="wikitable mw-collapsible mw-collapsed" style="width: 100%;"
!colspan="2" style="text-align: left;"|Sonstiges
|-
!class="mw-collapsible-content"|Klasse!!Beschreibung
{{FTUI Klasse|blank}}{{FTUI Klasse|transparent}}{{FTUI Klasse|half-transparent}}{{FTUI Klasse|blurry}}{{FTUI Klasse|shake}}{{FTUI Klasse|fail-shake}}{{FTUI Klasse|marquee}}{{FTUI Klasse|icon round}}{{FTUI Klasse|icon square}}{{FTUI Klasse|readonly}}{{FTUI Klasse|blink}}{{FTUI Klasse|rotate-90}}{{FTUI Klasse|horizontal}}{{FTUI Klasse|circleborder}}{{FTUI Klasse|autohide}}{{FTUI Klasse|notransmit}}{{FTUI Klasse|tab}}{{FTUI Klasse|FS20}}{{FTUI Klasse|value}}{{FTUI Klasse|novalue}}{{FTUI Klasse|timestamp}}{{FTUI Klasse|percent}}{{FTUI Klasse|nocache}}{{FTUI Klasse|fade}}{{FTUI Klasse|rotate}}{{FTUI Klasse|nolabels}}{{FTUI Klasse|default}}{{FTUI Klasse|prefetch}}{{FTUI Klasse|circulate}}{{FTUI Klasse|valueonly}}{{FTUI Klasse|positiononly}}{{FTUI Klasse|lineIndicator}}{{FTUI Klasse|barIndicator}}{{FTUI Klasse|roundIndicator}}{{FTUI Klasse|dim-tick}}{{FTUI Klasse|dim-front}}{{FTUI Klasse|dim-back}}{{FTUI Klasse|hue-tick}}{{FTUI Klasse|hue-front}}{{FTUI Klasse|hue-back}}{{FTUI Klasse|warn}}{{FTUI Klasse|activate}}{{FTUI Klasse|labelright}}{{FTUI Klasse|interlock}}{{FTUI Klasse|keepopen}}{{FTUI Klasse|noshade}}
|}

=== Icons ===
FTUI bringt einige Icons-"Schriftarten" mit, die für die Darstellung genützt werden können. Diese werden automatisch beim Start des UI eingebunden, sobald ein entsprechendes Icon-Präfix im Code der Seite vorkommt.

Verfügbare Icon-Schriftarten sind:
* Eingebaute Icons ''ftui-windows'' und ''ftui-door''. Präfix '''ftui-'''. Beispiel: <code>data-icon="ftui-door"</code>
* [http://fontawesome.io/icons/ Font-Awesome]: Mehr als 500 Icons zur Auswahl. Präfix '''fa-'''. Beispiel: <code>data-icon="fa-volume-up"</code>
* [https://material.io/icons/ Material Icons]: Mehr als 900 Icons zur Auswahl. Präfix '''mi-'''. Beispiel: <code>data-icon="mi-local_gas_station"</code>
* FHEM und OpenAutomation Icons: Präfix '''fs-''' und '''oa-'''. Beispiel: <code>data-icon="oa-secur_locked"</code>
* [https://erikflowers.github.io/weather-icons/ Weather-Icons]: Präfix '''wi-'''. Beispiel: <code>data-icon="wi-day-rain-mix"</code>

Alternativ können auch Bilder Icons (bspw. png) über CSS verwendet werden. Bspw:
<syntaxhighlight lang="html5">
<head>
<style type="text/css">
.logo-fhem {
background: url(https://wiki.fhem.de/fhemlogo.png) no-repeat;
width: 120px;
height: 132px;
background-size: contain;
}
</style>
</head>
<body>
<div data-type="symbol" data-icon="logo-fhem"></div>
</body>
</syntaxhighlight>

== Widgets ==
===Allgemeine Attribute===
Jedes Widget kann über verschiedene Attribute konfiguriert werden. Folgende Attribute gelten für alle Widgets:

{| 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
|-
|}

Widget-spezifische Attribute können auf der jeweiligen Widget-Seite nachgelesen werden.

=== Integrierte Widgets ===
Folgende Widgets sind direkt in FHEM Tablet UI integriert und können "out of the box" verwendet werden.

* [[FTUI Widget Button|button]]: Variante der push und switch Widgets, die entweder einen URL ansteuern oder einen FHEM-Befehl absetzen kann.
* [[FTUI Widget Checkbox|checkbox]]: Umschalter zwischen zwei definierten Zuständen
* [[FTUI Widget Circlemenu|circlemenu]]: Mehrere Widgets hinter einem Widget verborgen, trotz des 'circle' im Namen kann das Menue jetzt auch horizontal oder vertikal ausgeklappt werden
* [[FTUI Widget Clock|clock]]: Stellt eine einfach Uhr zur Verfügung.
* [[FTUI Widget Colorwheel|colorwheel]]: Farbpalette zur Auswahl von Farben
* [[FTUI Widget Controlbutton|controlbutton]]: iOS-ähnlicher Button um zwischen zwei Zuständen zu schalten (z.B. on / off)
* [[FTUI Widget Controller|controller]]: iOS-ähnlicher vertikaler Schieberegler um einen Wert einzustellen
* [[FTUI Widget Datetimepicker|datetimepicker]]: Erstellt eine Auswahl für Datum/Uhrzeit
* [[FTUI Widget Departure|departure]]: Abfahrtszeiten öffentlicher Verkehrsmittel
* [[FTUI Widget Dimmer|dimmer]]: Ein-/Aus-Button mit integriertem Schieberegler für z.B. einen Dim-Wert
* [[FTUI Widget Eventmonitor|eventmonitor]]:
* [[FTUI Widget Homestatus|homestatus]]: Auswahl für vier oder fünf definierte Stati eines Objects (z.B.: FHEM Residents)
* [[FTUI Widget Html|html]]:
* [https://github.com/nesges/Widgets-for-fhem-tablet-ui/wiki/iframe iframe]: Widget zum Einbinden externer Inhalte in einem Iframe.
* [[FTUI Widget Image|image]]: Zeigt ein Bild, dessen URL fest vorgegeben oder aus einem Device-Reading gelesen werden kann.
* [[FTUI Widget Input|input]]: Erstellen eines Texteingabefeldes
* [https://github.com/nesges/Widgets-for-fhem-tablet-ui/wiki/joinedlabel joinedlabel]: verbindet mehrere Readings zu einem Feld
* [[FTUI Widget Klimatrend|klimatrend]]: wandelt Daten aus dem statistics-Modul in einen Pfeil um, der den aktuellen Trend anzeigt.
* [[FTUI Widget Knob|knob]]: Erstellt einen Statusbalken auf einer Kreisbahn
* [[FTUI Widget Label|label]]: Reading als Text anzeigen
* [[FTUI Widget Level|level]]: Vertikale oder horizontale Leiste zur Anzeige von Werten zwischen einem Minimal- und einem Maximalwert
* [[FTUI Widget Link|link]]: Erstellt einen Link oder Button zum Aufrufen von URLs oder Senden von Befehlen an FHEM
* [[FTUI Widget Medialist|medialist]]:
* [[FTUI Widget Multistatebutton|multistatebutton]]: Variante des push-Widgets, welches den set-Befehl abhängig vom gelesenen Status ändert.
* [[FTUI Widget Notify|notify]]: Blendet ein Hinweisfenster im Browser ein
* [[FTUI Widget Pagebutton|pagebutton]]: Button, mit dem auf andere Seiten gesprungen werden kann. Eignet sich gut für eine Navigation
* [[FTUI Widget Pagetab|pagetab]]: Tauscht den Inhalt einer Seite durch den einer anderen. Eignet sich gut für ein Navigationsmenü.
* [[FTUI Widget Playstream|playstream]]: Abspielen eines Webradio-Streams per Button
* [[FTUI Widget Popup|popup]]: Öffnet ein Popup nach einem Klick auf ein Widget oder HTML-Element
* [[FTUI Widget Progress|progress]]: Zeigt einen Prozentwert in Form einer runden Fortschrittsleiste
* [[FTUI_Widget_Push|push]]: Button, mir dem ein Befehl an FHEM gesendet werden kann.
* [[FTUI Widget Range|range]]: Erstellt vertikale Balken, die einen Wertebereich in unterschiedlichen Farben darstellen
* [[FTUI Widget Readingsgroup|readingsgroup]]: Zeigt eine Readingsgroup an, wie sie in FHEM definiert wurde
* [[FTUI Widget Rotor|rotor]]: Animiertes Umschalten von zwei oder mehr Widgets an einer Position
* [[FTUI_Widget_Select|select]]: Combobox, die eine Liste an Werten zur Auswahl anzeigt
* [https://github.com/nesges/Widgets-for-fhem-tablet-ui/wiki/settimer settimer]: Zum Anzeigen und Einstellen einer Uhrzeit.
* [[FTUI Widget Simplechart|simplechart]]: Einfaches XY-Diagramm zur Anzeige eines Wertes, der direkt aus einem FHEM-Logfile gelesen wird
* [[FTUI Widget Slideout|slideout]]:
* [[FTUI Widget Slider|slider]]: Vertikaler Schieberegler um einen Wert einzustellen
* [[FTUI Widget Spinner|spinner]]: Element um Werte durch Drücken auf Plus- und Minus- oder Höher-/Tiefer-Icons zu ändern
* [[FTUI Widget Swiper|swiper]]: Bietet die Möglichkeit, durch Wischen, zwischen verschiedenen Widgets zu wechseln
* [[FTUI Widget Switch|switch]]: Button um zwischen zwei Zuständen zu schalten (z.B. on / off)
* [[FTUI Widget Symbol|symbol]]: Status eines Devices als Symbol darstellen (z.B. Fenster offen)
* [[FTUI Widget Thermostat|thermostat]]: Anzeige für Heizungsthermostate, mit der die gewünschte Temperatur eingestellt werden kann
* [[FTUI Widget Volume|volume]]: Einstellscheibe zur Änderung eines einzelnen Wertes
* [[FTUI Widget Weather|weather]]: Wettersymbol anzeigen
* [[FTUI Widget WindDirection|wind_direction]]: Anzeige der Windrichtung auf einer Windrose

===3rd Party Widgets===
Für diese Widgets kann nicht sichergestellt werden, dass sie mit der jeweils aktuellen Version von FTUI funktionieren.
* [[FTUI Widget Agenda|agenda]]: Zeigt Kalendereinträge in einer Listenform an
* [[FTUI Widget Calview|calview]]: Zeigt Einträge aus einem [[CALVIEW]]-Device an
* [[FTUI Widget Chart|chart]]: Diagramm mit ähnlichen Möglichkeiten wie die FHEM-Plots
* [[FTUI Widget Classchanger|classchanger]]: Ändert seine CSS-Klassen je nach Status eines Devices
* [[FTUI Widget Clicksound|clicksound]]: Mit dem Widget "clicksound" können Sounds an Click-Events von Elementen gebunden werden.
* [[FTUI Widget Filelog|filelog]]:
* [[FTUI Widget Fullcalview|fullcalview]]:
* [[FTUI Widget Gds|gds]]:
* [[FTUI Widget Highchart|highchart]]:
* [[FTUI Widget Highchart3d|highchart3d]]:
* [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/kodinowplaying kodinowplaying]: zeigt Informationen zu grade in KODI gespielten Medien in Form eines Labels an.
* [[FTUI Widget Loading|loading]]:
* [[FTUI Widget Meteogram|meteogram]]:
* [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/reload reload]: auslösen eine Pagereloads
* [[FTUI Widget Screensaver|screensaver]]:
* [[FTUI Widget Svgplot|svgplot]]:
* [[FTUI Widget Tts|tts]]: Sprachausgabe eines Textes aus einem Reading auf dem Endgerät.
* [[FTUI Widget UWZ|uwz]]: Anzeige der Warnungen der Unwetterzentrale
* [[FTUI Widget Wakeup|wakeup]]:
* [https://github.com/svenson08/ftui-weekdaytimer-widget wdtimer]: Visualisierung des [[WeekdayTimer]] Modul
* [[FTUI Widget Weekprofile|weekprofile]]: Visualisierung des [[weekprofile]] Moduls

==Templates==
Kommt ein bestimmtes "Code-Fragment" auf mehreren Seiten oder öfter pro Seite vor, bietet FTUI die Option, Templates zu erstellen. Diese werden einmal gebaut und können dann mit dem Attribut '''data-template''' nach Belieben in eine Seite eingefügt werden. Dabei besteht auch die Möglichkeit, Variablen zu verwenden.

Die Variablennamen sollten möglichst eindeutig und unverwechselbar gewählt werden, da bei der Verwendung von Templates im Prinzip Suchen & Ersetzen angewendet wird. Verwendet man beispielsweise die Variablen '''dev:Thermostat_Kueche''' und '''dev_temp:temperatue''', so kann es passieren, dass die Ergebnisse im erzeugten Code dann '''Thermostat_Kueche''' und '''Thermostat_Kueche_temp''' lauten, statt wie gewünscht '''Thermostat_Kueche''' und '''temperature'''. Um dies zu vermeiden, sollten die Variablen besser '''device:Thermostat_Kueche''' und '''temp:temperatue''' lauten.

Im Folgenden ein paar Beispiele, wie Templates verwendet werden können.

===Einzelnes Widget===
Soll ein Widget an mehreren Stellen in exakt der selben Ausführung eingebunden werden, kann diese Widget in einer eigenen Datei erstellt und diese dann auf den Zielseiten automatisch mitgeladen werden.

;Template-Seite
Die Template-Seite soll in diesem Beispiel ''template_symbol.html'' genannt werden. Diese wird daher zuerst im FTUI-Verzeichnis erstellt.
<syntaxhighlight lang="html">
<div data-type="symbol"
data-device="dummy1">
</syntaxhighlight>

;Haupt-Seite
Die oben erstellte Template-Seite kann nun in jeder gewünschten Seite eingebunden werden.
<syntaxhighlight lang="html" highlight="6">
[...]
<body>
<div class="gridster">
<ul>
<li data-row="1" data-col="1" data-sizey="1" data-sizex="1">
<div data-template="template_symbol.html"></div>
</li>
</ul>
</div>
</body>
[...]
</syntaxhighlight>

===Gridster-Element===
Natürlich kann auch ein ganzes Gridster-Element - in diesem Fall ein Menü - als Template eingebunden werden.
<syntaxhighlight lang="html">
<li data-row="1" data-col="1" data-sizex="1" data-sizey="4" data-template="menu.html"></li>
</syntaxhighlight>

=== Widget-Gruppen ===
Die Template-Datei des [[#Einzelnes Widget|ersten Beispiels]] kann natürlich auch mehrere Widgets auf einmal enthalten.

=== Verwendung von Variablen ===
==== Einfaches Beispiel ====
Oft wird ein und dasselbe Widget für verschiedenen Devices verwendet. Um nicht für jedes Device das Widget neu kopieren zu müssen (bzw. bei Änderungen alle Seiten ausbessern zu müssen), kann ein Template verwendet werden, dem einfach per Parameter mitgeteilt wird, von welchem Device es gerade die Daten empfangen soll.

In diesem Beispiel wird ein Template erzeugt, dass nur die Temperatur verschiedenen Thermostate mittels eines [[FTUI Widget Label|Label-Widgets]] anzeigt.

;Template-Seite
Die Template-Seite enthält nur ein einfaches Label-Widget und wird in diesem Beispiel ''template_label.html'' genannt. Um sie für mehrere Devices verwenden zu können, wird im Attribut '''data-device''' der Name des eigentlichen Devices durch den Parameter '''par01''' ersetzt.
<syntaxhighlight lang="html" highlight="2">
<div data-type="label"
data-device="par01"
data-get="measured-temp"></div>
</syntaxhighlight>

;Haupt-Seite
Auf der Haupt-Seite wird die Template-Seite mit dem Attribut '''data-template''' eingebunden und ihr via Attribut '''data-parameter''' das jeweils gewünschte Device übergeben.
<syntaxhighlight lang="html">
[...]
<div data-template="template_label.html" data-parameter='{"par01":"Thermostat1"}'></div>
<div data-template="template_label.html" data-parameter='{"par01":"Thermostat2"}'></div>
<div data-template="template_label.html" data-parameter='{"par01":"Thermostat3"}'></div>
[...]
</syntaxhighlight>

==== Wetter-Slider mit Template ====
In diesem Beispiel wird ein [[FTUI Widget Slider|Slider-Widget]] erstellt, welches die verschiedenen Tage eines Wetterberichtes anzeigt. Dabei wird für den Wetterbericht des jeweiligen Tages immer dasselbe Template verwendet um nicht für jeden Tag ein eigenes Widget schreiben zu müssen.

;Template-Seite
<syntaxhighlight lang="html">
<div class="left">
<div data-type="label" data-device="AgroWeather" data-get="par01" data-unit="°C"></div>
<div class="inline">
<div data-type="label" data-device="AgroWeather" data-get="par02"></div>
<div data-type="weather" data-device="AgroWeather" data-get="par02"></div>
min: <div data-type="label" data-device="AgroWeather" data-get="par03" data-unit="°C"></div>
</div>
</div>
<div class="left">
<div data-type="label" data-device="AgroWeather" data-get="par04" data-substitution="toDate().eeee()+','"></div>
<div data-type="label" data-device="AgroWeather" data-get="par04" data-substitution="toDate().ddmm()"></div>
</div>
</syntaxhighlight>

;Haupt-Seite
In der Haupt-Seite wird das Template dann für jede Slider-Seite eingebunden und das Reading für den jeweiligen Tag via Parameter übergeben.
<syntaxhighlight lang="html">
[...]
<div data-type="swiper">
<ul>
<li data-template="templates/wetter.html" data-parameter='{"par01":"fc0_tempMax","par02":"fc0_weatherDay","par03":"fc0_tempMin","par04":"fc0_date"}'></li>
<li data-template="templates/wetter.html" data-parameter='{"par01":"fc1_tempMax","par02":"fc1_weatherDay","par03":"fc1_tempMin","par04":"fc1_date"}'></li>
<li data-template="templates/wetter.html" data-parameter='{"par01":"fc2_tempMax","par02":"fc2_weatherDay","par03":"fc2_tempMin","par04":"fc2_date"}'></li>
<li data-template="templates/wetter.html" data-parameter='{"par01":"fc3_tempMax","par02":"fc3_weatherDay","par03":"fc3_tempMin","par04":"fc3_date"}'></li>
</ul>
</div>
[...]
</syntaxhighlight>

== JavaScript-Funktionen ==
Neben den Widgets können auch einige JavaScript-Funktionen verwendet werden, um Befehle an FHEM zu senden.

Folgende Zeile setzt einen direkten Befehl an FHEM ab (<code>set dummy1 off</code>):
<syntaxhighlight lang="html"><div onclick="ftui.setFhemStatus('set dummy1 off')">Dummy1 aus</div></syntaxhighlight>

Diese Zeile veranlasst FHEM dazu, eine Funktion aus der 99_myUtils.pm auszuführen (<code>myUtils_HeizungUpDown("WZ.Thermostat_Climate","up")</code>):
<syntaxhighlight lang="html"><div onclick="ftui.setFhemStatus('{myUtils_HeizungUpDown("WZ.Thermostat_Climate","up")}')">+</div></syntaxhighlight>

Ein Beispiel, wie ein Kommando an FHEM gesendet wird und gleichzeitig der Wert eines bereits in FTUI angezeigten Readings verwendet werden kann:
<syntaxhighlight lang="html">
<div data-type="label" data-device="dummy1" data-get="temperature"></div>
<div onClick="ftui.setFhemStatus('set dummy2 '+ftui.getDeviceParameter('dummy1','temperature').val);">Senden</div>
</syntaxhighlight>

== Eigene Widgets erstellen ==
Wie eigenen Widgets für FTUI erstellt werden können, ist auf der Seite [[FTUI eigene Widgets]] beschrieben.

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

== Links ==
* [https://github.com/knowthelist/fhem-tablet-ui Projekt auf Github]
* {{Link2Forum|Topic=34233|LinkText=Forums-Beitrag}}
* [[FTUI_Snippets|Snippets]]
* [http://knowthelist.github.io/fhem/tablet/demo_widgets.html Live-Demos]
* [https://waschto.eu/fhem-und-tabletui-livedemo/ FHEM und TabletUI Live-Demo]
* {{Link2Forum|Topic=37378|LinkText=User-Demos}}
* [https://github.com/ovibox/fhem-ftui-user-demos Download der User-Demo-Dateien]

[[Kategorie:FHEM Tablet UI]]

TRAFFIC

2017-10-29T16:57:21Z

Waschto:

{{Infobox Modul
|ModPurpose=Verkehrsdaten zu fest definierten Routen ermitteln
|ModType=d
|ModForumArea=Unterstützende Dienste
|ModTechName=98_TRAFFIC.pm
|ModOwner=jmike <br />({{Link2Forum|Topic=56045|LinkText=Forum}} / [[Benutzer:Jmike|Wiki]])
}}

Dieses Modul erfasst Fahrzeiten in aktueller Verkehrslage mittels Google Maps Directions API.

== Features / Funktionen ==
* Distanz einer Route
* Fahrzeit ohne Verkehr
* Fahrzeit mit Verkehr
* Verzögerung der geplanten Route
* Waypoints definieren
* Ausgabesprache festlegen
* Outputs in Sekunden / Meter (raw)
* Ausgabe als Text, in Minuten, Sekunden oder als Durchschnitt
* Device STATE frei wählbar
* einstellbares Update Interval
* update-burst für Stosszeiten
* Strecke kann zusätzlich in gegengesetzte Richtung ausgelesen werden
* Ankunfszeit bei Abfahrt zum Update-Zeitpunkt
* verschiedene Travel Modes (driving, walking, bicycling und transit)
* flexibler Update Schedule für Stosszeiten
* integrierte, konfigurierbare Google Map zum Visualisieren der konfigurierten Route

== Voraussetzungen ==
Erstmal muss ein eigener API Key angefordert werden.
Das geht über Googles [https://console.developers.google.com/apis/ API Manager]<br>
Dort "Google Maps Directions API" suchen und ein neues Projekt erstellen, anschliessend API aktivieren.
Für die Karte ist zusätzlich der "Google Maps JavaScript API" notwendig und sollte an dieser Stelle auch aktiviert werden.

Je nach FHEM Installation zusätzlich die Perl Module LWP::Simple, JSON und MIME::Base64 nach installieren:<br>
<code>sudo apt-get install libwww-perl</code><br>
<code>sudo apt-get install libjson-perl</code><br>
oder<br>
<code>sudo cpan -i LWP::Simple</code><br>
<code>sudo cpan -i JSON</code><br>
<code>sudo cpan -i MIME::Base64</code>

== Definition ==
<code> define <devicename> TRAFFIC <API-KEY> [update-interval] </code>

'''Beispiel:'''<br>
<code>define muc2berlin TRAFFIC ABCDEFGHIJKLMNOPQRSTVWYZ 600</code>

Der API Key muss selbstverständlich mit dem eigenen Key aus dem API Manager ersetzt werden.<br>
Das Intervall in Sekunden ist optional, der default beträgt 3600 (1 Stunde).<br>
Attribute start_address und end_address definieren.

== Readings ==
* average_delay_min
* average_duration_in_traffic_min
* average_duration_min
* delay
* delay_min
* distance
* duration
* duration_in_traffic
* duration_in_traffic_min
* duration_in_traffic_sec
* duration_min
* duration_sec
* [error_message]
* eta
* state
* status

== Befehle ==

==== update [burst-update-count] [burst-update-interval] ====
Readings manuell aktualisieren, der optionale Burst kann wie folgt genutzt werden:<br>
- erster Wert gibt an wie viele Updates abgearbeitet werden<br>
- zweiter Wert gibt an wie viele Sekunden zwischen den Updates gewartet wird<br>

Beispiel um für 1 Stunde alle 5 Minuten zu aktualisieren:<br>
<code>set <device> update 12 300</code>

== STATE ==
* Initialized - modul initialisiert
* OK - update war erfolgreich
* incomplete configuration - Konfigurationsfehler (start_address oder end_address leer)
* <APIRETURN> - Fehlermeldung von Google Maps, falls vorhanden (siehe Reading error_message)
* <Reading> - der Wert des Readings welches mit Attribut stateReading ausgewählt wurde
* disabled - das Device wurde über das Attribut disable deaktiviert

== Attribute ==

{| class="wikitable"
!Attribut
!Default Wert
!mögliche Werte
!Beschreibung
!Beispiel
|-
!align="right" |start_address
|
|<text>
|die vollständige Startadresse (erforderlich!)
|Startstr 1, 12345 Startcity
|-
!align="right" |end_address
|
|<text>
|die vollständige Zieladresse (erforderlich!)
|Zielstr 99, 99099 Zielstadt
|-
!align="right" |raw_data
|0
|0:1
|legt Readings an mit allen unbearbeiteten Werten
|
|-
!align="right" |language
|
|de, en, etc.
|Google ermittelt die Sprache automatisch, falls nicht fest definiert
|de
|-
!align="right" |waypoints
|
|lat, long<nowiki>|</nowiki>lat, long
|fixe Wegpunkte auf der Strecke, mehrere Werte per pipe <nowiki>(|)</nowiki> trennen, LAT, LONG Koordinaten angeben
|48.187918, 11.590514
|-
!align="right" |returnWaypoints
|
|lat, long<nowiki>|</nowiki>lat, long
|fixe Wegpunkte für den Rückweg, mehrere Werte per pipe <nowiki>(|)</nowiki> trennen, LAT, LONG Koordinaten angeben, wenn leer werden "waypoints" in umgekehrter Reihenfolge verwendet
|48.187918, 11.590514
|-
!align="right" |disable
|0
|0:1
|Modul deaktivieren
|1
|-
!align="right" |stateReading
|
|<beliebiges-Reading>
|Name eines Readings, dessen Wert in den STATE des Devices geschrieben wird
|delay_min
|-
!align="right" |outputReadings
|text
|text,min,sec,average
|Konfiguration, welche Readings erstellt werden sollen, eine oder mehrere möglich
|text min
|-
!align="right" |includeReturn
|0
|0:1
|aktiviert/deaktiviert, ob die gleiche Strecke in umgekehrter Richtung hinzugefügt werden soll<br>Readings werden mit return_* angegeben
|1
|-
!align="right" |verbose
|1
|0:1:2:3:4:5
|gibt vor, wie ausführlich geloggt wird
|5
|-
!align="right" |travelMode
|driving
|driving:walking:bicycling:transit
|Fortbewegungsmethode für Kalkulation
|walking
|-
!align="right" |updateSchedule
|
|<Beginn-volle-Stunde>-<Ende-volle-Stunde> [<Tag>] <update-Intervall-in-Sekunden>
|definiert einen flexiblen Zeitraum für feinere Updates, Tag als Zahl (Sonntag 0, Montag 1 etc.), mehrere Definitionen per <nowiki>(|)</nowiki> getrennt
| 6-8 1 60|6-8 2 60|6-8 3 60|6-8 4 60|6-8 5 60
|-
!align="right" |GoogleMapsStyle
|default
|default,silver,dark,night
|definiert einen der vorgegebenen Map Styles
|<i>dropdown</i>
|-
!align="right" |GoogleMapsSize
|800,600
|<Breite>,<Höhe>
|definiert die Breite und Höhe der Karte
| 600,300
|-
!align="right" |GoogleMapsCenter
|<i>auto-generiert</i>
|<lat>,<lang>
|definiert den Mittelpunkt der Karte
| 48.2322157,11.6867434
|-
!align="right" |GoogleMapsZoom
|10
|<Zoom wert>
|definiert den Zoom Wert der Karte
| 14
|-
!align="right" |GoogleMapsStroke
|#4cde44,6,100,#FF0000,1,100
|<#-6-digit-hex-code>,[<weight>[,<opacity>],]<#-6-digit-hex-code>,[<weight>,[<opacity>]]
|definiert die Farbe der Wegstrecken im HEX Format, Dicke der Linie und Transparenz. Getrennte Angabe von Hin- und Rückweg sind möglich.
| #019cdf,#ffeb19<br>#019cdf,15,50,#ffeb19,15,50<br>#019cdf,20,80,#ffeb19
|-
!align="right" |GoogleMapsTrafficLayer
|0
|0:1
|schaltet den Standard Google Maps Traffic Overlay ein/aus
| 1
|-
!align="right" |GoogleMapsDisableUI
|0
|0:1
|Dropdown um die Map Controls zu deaktivieren
| 1
|-
|}

== Integrierte Karte ==
* Zum Überprüfen der verwendeten Wegstrecke können der Hin- und Rückweg für ein TRAFFIC-Device auf einer Karte angezeigt werden.
* Um die Karte anzuzeigen einfach oben auf "toggle Map" klicken
* Für Einbindung in andere Anwendungen (TabletUI z.b) kann die Karte zusätzlich über den eingeblendeten Link erreicht werden: <nowiki>http://fhem-ip:port/fhem/TRAFFIC?name=<TRAFFIC-DEVICE></nowiki>
* Karte anpassen:
** Die Karte lässt sich über folgende Attribute anpassen:
** GoogleMapsStyle, GoogleMapsSize, GoogleMapsCenter, GoogleMapsZoom, GoogleMapsStroke und GoogleMapsTrafficLayer
** GoogleMapsZoom und GoogleMapsCenter können direkt in der Kartenansicht gespeichert werden. Dazu die Karte verschieben/zoomen und anschliessend auf die Buttons "save Zoom" bzw. "save Center" klicken
** weitere Beispiele bitte dem Forum entnehmen

== Bekannte Probleme ==
* STATE: "REQUEST DENIED"
* Reading error_message: "This API project is not authorized to use this API"
** => API Key ist nicht aktiviert. Google API > API Manager > Google Maps Directions API > AKTIVIEREN

* STATE: "UNKNOWN_ERROR"
** => Es liegt ein Fehler bei Google vor.
** => "UNKNOWN_ERROR indicates a directions request could not be processed due to a server error. The request may succeed if you try again." [https://developers.google.com/maps/documentation/javascript/directions?hl=de]

* STATE: "OVER_QUERY_LIMIT"
** Es wurden mehr als 2500 requests pro Tag abgesetzt. Abhilfe: Update Intervalle der TRAFFIC Devices erhöhen und "burst" zu den Stosszeiten nutzen.

* STATE: "ZERO_RESULTS"
** Die Waypoint Definition kann Google nicht realisieren. Statt Städtenamen besser exakte Koordinaten verwenden.

* Karte zeigt nur ein graues Bild "Ops..."
** checkt eure Javascript Konsole nach dem exakten Fehler
** Google Maps API error: ApiNotActivatedMapError https://developers.google.com/maps/documentation/javascript/error-messages#api-not-activated-map-error
** => Google Maps JavaScript API aktivieren

== Tips ==
* täglicher Burst Update zum Feierabend, 1 Stunde alle 5 Minuten updaten:
** <code>define FeierabendCheck AT *17:00 set <device> update 12 300</code>

* komplette Reisezeit, also Hin- und Rückweg, im STATE anzeigen:
** <code>attr <device> stateFormat {int(ReadingsVal($name,"delay_min",0)) + int(ReadingsVal($name,"return_delay_min",0))}</code>

* updateSchedule einsetzen um default update Intervall zu verfeinern
** Montag bis Freitag von 6 bis 8 Uhr alle 60 Sekunden
** <code>attr <device> updateSchedule 6-8 1 60|6-8 2 60|6-8 3 60|6-8 4 60|6-8 5 60</code>
** jeden Tag von 17 bis 19 Uhr alle 2 Minuten
** <code>attr <device> updateSchedule 17-19 120</code>

* Waypoints definieren (Tip von erdo_king)
** In Google-Maps die gewünschte Route auswählen (am PC)
** Auf eine signifikante Stelle der Route klicken - hierbei auf die Fahrtrichtung achten!
** Hier auf die Koordinaten klicken, diese können dann aus dem Suchfeld kopiert werden
** Im Browser zurückgehen, bis die Route wieder sichtbar ist (zum späteren Datenabgleich)
** Waypoints in FHEM deklarieren, Daten aktualisieren (set <device> update)
** distance + duration mit den Daten von Google-Maps am PC abgleichen

== to Do ==
* Reading error_message löschen wenn update erfolgreich
* deutsche Commandref

== Weblinks ==
* {{Link2Forum|Topic=56045|LinkText=Modul Vorstellung und Diskussionen}}
* [http://fhem.de/commandref.html#TRAFFIC Commandref]
* [https://console.developers.google.com/apis Google API Manager]
* [https://waschto.eu/verkehrsinfo-und-traffic-verkehrsmeldungen-in-fhem-einbinden/ How-To: Verkehrsinfos in FHEM einbinden]

Staumelder

2017-10-29T16:56:33Z

Waschto:

== Vorüberlegungen ==
Die Überlegung, sich Stau- und Verkehrsmeldung per FHEM bereitstellen zu lassen klingt verlockend.
Für die Realisierung wurden mehrere Wege betrachtet.

== Umsetzungen ==
Es gibt bereits mehrere Möglichkeiten Stau- und Verkehrsmeldung mit FHEM auszulesen und darzustellen
{{Randnotiz|RNText= Variante per HTTPMOD oder Google Maps muss noch beschrieben werden }}
* Stau- und Verkehrsmeldung über das Modul Verkehrsinfo
* Stau- und Verkehrsmeldung per HTTPMOD
* Stau- und Verkehrsmeldung über Google Maps

== Das Verkehrsinfo Modul ==
Das Modul {{Link2Forum|Topic=55118|Message=467732|LinkText=Verkehrsinfo}} bietet für Stau- und Verkehrsmeldung eine übersichtliche Möglichkeit die potentiellen Meldungen anzeigen zu lassen.
Dabei bedient es sich aktuell aus zwei Webseiten.

* https://www.verkehrsinfo.de
* http://hessenschau.de/index.html

Für das Modul werden die Perlmodule HTML::TreeBuilder::XPath sowie libjson-perl benötigt.
Installiert werden können diese mit nachfolgendem Befehl.

:<code>sudo apt-get install libxml-treebuilder-perl libhtml-treebuilder-xpath-perl</code>
:<code> sudo apt-get install libjson-perl </code>

Die Grundsätzliche Definition des Moduls sieht wie Folgt aus:
:<code>define <name> Verkehrsinfo <url> <interval></code>

=== Aktuell Mögliche Varianten ===
==== "Verkehrsinfo.de" ====
Über die Webseite verkehrsinfo.de können die Stau- und Verkehrsmeldungen von ganz Deutschland abgefragt werden.
Dabei kann über die Webseite nach Bundesland oder Strassentyp gefiltert werden.
Aus dieser Filterung wird auch der anschließend benötigte Link für das Modul generiert.

Eine Beispielkonfiguration anhand der Filterung auf einen Strassentyp. Abfrageintervall hier 3600 Sekunden.

:<code><nowiki>define A66 Verkehrsinfo https://www.verkehrsinfo.de/index.php?country=1&street=A66&UIN= 3600</nowiki></code>

==== "hessenschau.de" ====
Über die Webseite hessenschau.de können die Stau- und Verkehrsmeldungen von Hessen abgefragt werden.
Eine Filterung auf bestimmte Strassentypen ist über die zusätzlichen Attribute filter_exclude sowie filter_include möglich.

Eine Beispielkonfiguration mit Abfrageintervall von 3600 Sekunden.

:<code><nowiki>define Staumelder Verkehrsinfo http://hessenschau.de/verkehr/index.html 3600</nowiki></code>

==== "radiosaw.de" ====
Über die Webseite radiosaw.de können die Stau- und Verkehrsmeldungen von Mitteldeutschland abgefragt werden.
Eine Filterung auf bestimmte Strassentypen ist über die zusätzlichen Attribute filter_exclude sowie filter_include möglich.

Eine Beispielkonfiguration mit Abfrageintervall von 3600 Sekunden.

:<code><nowiki>define Staumelder Verkehrsinfo radiosaw 3600</nowiki></code>
Die Angabe einer URL ist bei radiosaw nicht notwendig.

=== Zusätzliche Einstellungen ===
Neues Attribut für die Formatierung der Meldungen (Voranstellen von Strasse, Richtung, beides oder keines von beiden --> siehe commandref) (nur für Verkehrsinfo.de Verfügbar)

{{Randnotiz|RNText=
Beide Filter können gleichzeitig benutzt werden,
aber es kann auch wahlweise nur einer verwendet werden.
Die Filter sind mit einem Logischen UND verknüpft.
Das heißt z.B.: wenn etwas ausgeschlossen wurde,
kann es nicht mit dem Einschlussfilter wieder geholt werden.}}

Das Modul erlaubt das Filtern von Meldungen anhand von Attributen wie '''filter_exclude''' und '''filter_include'''.
Dabei werden die geladenen Meldung nach bestimmten Schlagwörtern durchsucht und somit nur die Meldung in Readings
gespeichert, für die einer der beiden Attribute zutrifft.

:<code>attr Staumeldungen filter_exclude Baustelle | Sperrung </code>
:<code>attr Staumeldungen filter_include Frankfurt | Unfall</code>

Die neuste Version erlaubt auch eine Sortierung der Meldung anhand der z.B Strasse.
Dazu muss das Attribute '''orderby''' gesetzt werden

:<code>attr Staumeldungen orderby A3 | A5 </code>

{{Randnotiz|RNText=Das Attribute msg_format ist nur für Verkehrsinfo.de verfügbar}}
Mit Hilfe des Attributes msg_format kann die Meldung (Voranstellen von Strasse, Richtung, beides oder keines von beiden ) formatiert werden.

:<code>attr Staumeldungen msg_format road </code>

Die Funktion kann überall in FHEM aufgerufen werden und liefert als Rückgabewert das gleiche Ergebnis wie der get <name> info Aufruf.
Der Rückgabewert als Text, kann dann für weiteres verwendet werden.

:<code>Verkehrsinfo_GetData(<devicename>)</code>
:<code>my $result = Verkehrsinfo_GetData('A8')</code>

=== Vorlesen von Meldungen ===

Die Meldungen aus den Readings lassen sich auch mit FHEM vorlesen.
Dazu bedarfs es einem System, welches Text in Sprache (TTS) umwandeln kann. Hier bietet sich das Modul TTS oder z.b ein Sonossystem an.
Auch weitere System zum Vorlesen von Meldungen sind Nutzbar.

Folgendes Beispiel zeigt ein at welches dynamisch anhand der Meldungsanzahl eine Variable füllt.
Diese Variable wird dann von einem Sonossystem oder alternativ einem TTS System vorgelesen.
<pre>
define Staumelder at*05:36:00 {
my $stau_counter = ReadingsVal("Stau","count","");
my $stau = "Es liegen " . " " . "$stau_counter" ." Staumeldungen um ". TimeNow() ." vor:";
my $complete_message;

## Anhand Meldungszahl das Reading in der Schleife zusammenbauen
my $reading_pre="e_";
my $reading_suff="_msg";
my $reading;

## Iterationsvariable
my $i = 0;

while ($stau_counter >= $i)
{
$reading = "$reading_pre" . "$i" . "$reading_suff";
$complete_message = "$complete_message" .".". ReadingsVal("Stau",$reading ,"");
$i++;
}

fhem "set Staudummy $stau$complete_message ";
fhem "set MeinSonossystem Speak 50 de $stau$complete_message";
fhem "set MeinTTS tts $stau$complete_message";
}

</pre>

=== Senden von Meldungen per Messenger ===

Befindet man sich allerdings nicht zu Hause und möchte dennoch wissen, ob es im definierten Bereich Verkehsbehinderung gibt, können die Meldungen auch per Messenger Modul zugesendet werden.

==== Jabber ====

Wenn das [[Jabber|Jabbermodul]] bereits installiert und konfiguriert wurde kann mit folgendem Code in der 99_myUtils.pm das
Abrufen von Staumeldungen implementiert werden. Der Code bezieht sich dabei auf die Grundeinrichtung des Jabbermoduls von hier: [[FHEM spricht jabber]]
{{Randnotiz|RNText=Die Anzahl Meldungen zum Versenden wurde auf fünf begrenzt.}}
<pre>
# Staumeldung abrufen
if($cmd eq "stau")
{
fhem("set Staumeldungen update");
$newmsg.= "Staumeldungen von: ";
$newmsg.=ReadingsVal("Staumeldungen", "date_time", "---").":::";
$newmsg=$newmsg."\n";
$newmsg.=ReadingsVal("Staumeldungen", "e_1_msg", "---")." , ";
$newmsg=$newmsg."\n";
$newmsg.=ReadingsVal("Staumeldungen", "e_2_msg", "---")." , ";
$newmsg=$newmsg."\n";
$newmsg.=ReadingsVal("Staumeldungen", "e_3_msg", "---")." , ";
$newmsg=$newmsg."\n";
$newmsg.=ReadingsVal("Staumeldungen", "e_4_msg", "---")." , ";
$newmsg=$newmsg."\n";
$newmsg.=ReadingsVal("Staumeldungen", "e_5_msg", "//Ende").".";
}
</pre>

==== telegram ====

Das telegram Modul muss bereits installiert sein. Optional das Verkehsmodul anlegen und konfigurieren.

:<code><nowiki>define traffic.a8 Verkehrsinfo https://www.verkehrsinfo.de/httpsmobil/index.php?c=staulist&street=A8&lat=&lon= 3600</nowiki></code>

Mit Hilfe des Notify können die Meldung per [[TelegramBot]] versendet werden.
<pre>
define ntf.telebot.traffic notify telebot.msgText:\s(?i)stau.* {\
my $msgpeer = ReadingsVal('telebot', 'msgPeer','');;\
fhem("set traffic.a8 update");;\
fhem("set telebot message @". $msgpeer . " " . Verkehrsinfo_GetData('traffic.a8'));;\
}
</pre>

=== Einbindung der Staumelderdaten für das Tablet UI===

Für die Nutzer der Tablet UI Oberfläche besteht nun die Möglichkeit das Ergebnis von Staumeldungen aus dem Modul anzeigen zu lassen.
Dafür ist es notwendig eine widget_verkehrsinfo.js im Verzeichnis /opt/fhem/www/tablet/js anzulegen, die mit dem Inhalt aus dem [https://github.com/knowthelist/fhem-tablet-ui/pull/185 Repository] gefüllt wird.

Für die angelegte Datei sollten noch die Berechtigungen angepasst werden
<syntaxhighlight lang="bash">
sudo chown fhem:dialout /opt/fhem/www/tablet/js/widget_verkehrsinfo.js
</syntaxhighlight>
[[Datei:tabletUI_Verkehrsinfo.png|mini|rechts|400px|Beispiel_TabletUI]]

Um das Widget in FTUI nutzen zu können muss in der Datei index.html wie Folgt definiert werden:
<syntaxhighlight lang="html">
/*
Version 0.6

Ein Widget für Modul Verkehrsmeldungen

Paul79 04.03.2017

paul79@gmx.de

----------------------------------------------------------------------------
HTML
für maximale Attribute:

<div data-type="verkehrsinfo" data-device="name in FHEM" data-max="5" data-color-msg="#CEBCB7" data-color-head="#FD6F3F" data-shadow="true" data-shadow-head="true" data-icon="2" ></div>

für minimale Attribute:

<div data-type="verkehrsinfo" data-device="name in FHEM" ></div>

ATTRIBUTE:
~~~~~~~~~~
Attribute (Pflicht):
---------------
data-type="verkehrsinfo" : Widget-Typ
data-device : FHEM Device Name

Attribute (Optional):
-----------------
data-count: maximale Anzahl der Einträge (Default '5').
data-icon: '1' Icon links, 'No' kein icon , '2' 2 Icons links und rechts (Default '2')
date-shadow: 'true' Schatten unter Icons (Default 'true')
date-shadow-head: 'true' Schatten unter Headtext (Default 'false')
data-color-head: Farbe Headtext (Default '#FFE066')
data-color-mag: Farbe Headtext (Default '#FFFFFF')
*/
</syntaxhighlight>

Die Attribute unter "Optional" können bei Bedarf auf den eigenen Geschmack verändert werden.

=== Bekannte Probleme / Fehlermeldungen ===

<pre>Can't call method "as_trimmed_text" on an undefined value at ./FHEM/98_Verkehrsinfo.pm line 220.</pre>
Die obiger Fehlermeldung wird durch Änderungen der Webseiten hervorgerufen. Hier muss ggf. das Modul angepasst/erweitert werden.

=== Ideen ===

Attribut zur Priorisierung von Meldungen

== Das TRAFFIC Modul ==

Mit diesem Modul können eigene Wegstrecken, und deren Verkehr, über Google Maps Directions API erfasst werden.
Das Modul sowie die Grundeinstellungen sind im Modulartikel [[TRAFFIC]] beschrieben.

== Ansprechpartner ==
# {{Link2FU|20569|martins}} (martins) für Modul Verkehrsinfo und Doku
# {{Link2FU|16204|jmike}} (jmike) für Modul TRAFFIC und Doku
# [[Benutzer Diskussion:Devender|Devender]] ({{Link2FU|20043|Dirk}}) für Wiki und Doku

== Links ==
* [https://waschto.eu/verkehrsinfo-und-traffic-verkehrsmeldungen-in-fhem-einbinden/ How-To: Verkehrsinfos in FHEM einbinden]

[[Kategorie:Code Snippets]]
[[Kategorie:Glossary]]

Wetter und Wettervorhersagen

2017-10-29T16:56:01Z

Waschto:

Wetterdaten und Wettervorhersagen können auf verschiedene Weise in FHEM eingebunden werden.

== Yahoo-Wetter ==
Für die einfache Einbindung des Yahoo-Wetters gibt es das spezielle Modul [[Weather]].

== Unwetterzentrale ==
Informationen der Seite(n) Unwetterzentrale.de können mit Hilfe des Moduls [[UWZ]] eingebunden werden.

== Modul OPENWEATHER ==
Das Modul [[OPENWEATHER]] extrahiert Wetterdaten über die "openweather"-Schnittstelle (API) von www.wetter.com.
*Vorschau-Zeitraum: 3 Tage
*Vorschau-Interval: 6:00, 11:00, 17:00, 23:00
*Aktuelle Daten: keine

== Modul PROPLANTA ==
Das Modul [[PROPLANTA]] extrahiert Wetterdaten von der Website www.proplanta.de. (keine API)
*Vorschau-Zeitraum: 12 Tage
*Vorschau-Interval: 3 h
*Aktuelle Daten: jede volle Stunde

== Modul WWO ==
Das Modul extrahiert Wetterdaten über die (alte) API von worldweatheronline.com
*Vorschau-Zeitraum: ?? Tage<BR>
*Vorschau-Interval: ??<br>
*Aktuelle Daten: ??

== Wetterwarnungen des DWD ==
{{Randnotiz|RNTyp=y|RNText=Die Nutzung der Vorhersagedaten wurde vom DWD verändert und ist momentan nicht wie hier beschrieben möglich. Eine Alternative bietet das Modul [[UWZ]]!}}
Der Deutsche Wetterdienst [http://www.dwd.de DWD] stellt neben diversen Wetterdaten auch Wetterwarnungen bereit. Diese können sehr einfach via [http://fhem.de/commandref_DE.html#weblink weblink iframe] in FHEM eingebunden werden - das ist zwar nicht die schönste Form, aber die schnellste.

Dazu sucht man sich zuerst auf der [http://www.dwd.de/bvbw/appmanager/bvbw/dwdwwwDesktop?_nfpb=true&_pageLabel=_dwdwww_wetter_warnungen_warnungen&T92053gsbDocumentPath=BEA__Navigation%2FWetter__Warnungen%2FWarnungen.html%3F__nnn%3Dtrue&lastPageLabel=dwdwww_wetter_warnungen Warnungsseite des DWD] die eigene Region heraus (in der Karte durchklicken). Die gewünschte URL für Berlin Stadt ist z.B. <code>http://www.dwd.de/dyn/app/ws/html/reports/BXX_warning_de.html#WS_ANCHOR_0</code>. Das Anhängsel <code>#WS_ANCHOR_0</code> kann man in der Konfiguration auch weglassen.

Die Einbindung in FHEM sieht dann wie folgt aus:
<pre>
define dwd_warnmeldung weblink iframe http://www.dwd.de/dyn/app/ws/html/reports/BXX_warning_de.html
attr dwd_warnmeldung group Wetterwarnungen (DWD)
attr dwd_warnmeldung htmlattr width="100%" height="300" frameborder="0" marginheight="0" marginwidth="0"
attr dwd_warnmeldung room Wettervorhersage,Startseite
</pre>

== Vorhersage-Diagramm von YR ==
[http://www.yr.no YR] ist die Seite des norwegischen Wetterdiensts. Er ist zwar nur in Teilen auf Englisch (und gar nicht auf Deutsch) verfügbar, bietet aber sehr gute Wettervorhersagen - auch mit eigenen Vorhersagen für kleine Dörfer. Neben etlichen Detailinfos bietet YR eine sehr schicke 48h-Vorhersage-Grafik. Diese kann sehr einfach via [http://fhem.de/commandref_DE.html#weblink weblink iframe] in FHEM eingebunden werden.

Dazu geht man auf die [http://www.yr.no Startseite von YR] und gibt in das Suchfeld den Namen seines Dörfchens ein - die Ergebnissliste kann ziemlich lang werden, sodass man evtl. sehr genau schauen muss, welches das eigene Kaff ist - bei mir war es an 29. Stelle... ;-) Auf der gewünschten Seite gibt es einen Unterpunkt "Hour by hour", wo sich die besagte Grafik findet. Hier kopiert man sich einfach die URL der Grafik.

Die Einbindung in FHEM sieht dann bspw. wie folgt aus:
<pre>
define Wetter_yr_Vorhersage weblink iframe http://www.yr.no/place/Germany/Berlin/Berlin/meteogram.png
attr Wetter_yr_Vorhersage group Wettervorhersage (yr)
attr Wetter_yr_Vorhersage htmlattr width="100%" height="300" frameborder="0" marginheight="0" marginwidth="0"
attr Wetter_yr_Vorhersage room Wettervorhersage,Start
</pre>

== Wetter von Weather Underground ==
{{Randnotiz|RNTyp=y|RNText=Neben dem hier vorgestellten Abruf der Weather Underground-Daten mit [[HTTPMOD]] kann auf Weather Underground-Daten auch mit dem darauf spezialisierten Modul [http://fhem.de/commandref.html#Wunderground Wunderground] zugegriffen werden.}}

'''Hinweis:''' Dieses Vorgehen ist etwas anspruchsvoller und somit eher für erfahrene FHEM-User geeignet.

[http://www.wunderground.com/ Weather Underground] ist bietet eine sehr umfassende Sammlung aller möglichen offiziellen und privaten (aber teils sehr professionellen) Wetterstationen weltweit. Es besteht eine recht hohe Wahrscheinlichkeit, dass es in der eigenen Umgebung schon eine Wetterstation gibt. Anstatt nun selbst eine komplette Wetterstation aufzubauen, kann man alternativ auf die Daten der Nachbarstation zugreifen.

Dazu sind grundsätzlich die folgenden Schritte notwendig:
* Finden der geeigneten Station
* Auswerten der XML-Daten
* Erstellen passender gplot-Dateien

=== Finden der geeigneten Station ===
Als erstes geht man auf die [http://www.wunderground.com Startseite von Weather Underground] und gibt in das Suchfeld den Namen seines Dörfchens oder der nächsten Stadt ein - für Berlin landet man bspw. auf Seite für "Berlin Alexanderplatz". Es gibt aber manchmal sehr viele Wetterstationen in der direkten Umgebung. Diese findet man indem am auf "Change Station" klickt und sich eine passende Station aussucht. Nähere Infos (zB. zur verwendeten Hard- und Software) zu der gewählten Wetterstation erhält man, wenn man auf den Namen der Station klickt und dann auf "About this PWS".

Weather Underground stellt die Daten der Wetterstation auch über eine API als XML bereit, die wir auswerten können. Die entsprechende URL findet sich ebenfalls unter "About this PWS" unter "Download current conditions XML". Für Berlin Prenzlauer Berg wäre dies bspw.
<code>http://api.wunderground.com/weatherstation/WXDailyHistory.asp?ID=IBERLIN15&format=XML</code>.

Entscheidend für die jeweilige Station ist der Teil nach "?=ID", also in diesem Fall "IBERLIN15". Dieser Teil des Links lässt sich leicht durch die ID einer anderen Station ersetzen und die Suche nach dem entsprechenden Link auf der Seite der Station bleibt erspart.

=== Auswerten der XML-Daten ===
Die Auswertung der XML-Daten erfolgt via [[HTTPMOD]]. Da dies nicht ganz trivial ist, sind im Folgenden zuerst die wesentlichen Konfigurationsschritte exemplarisch beschrieben. Weiter unten findet sich dann die fertige vollständige Konfiguration.

Es erstes wird das Device HTTPMOD definiert (die 600 am Schluss ist der Aktualisierungszyklus in Sekunden, also alle 10 min):
:<code>define wetter_prenzelberg HTTPMOD http://api.wunderground.com/weatherstation/WXCurrentObXML.asp?ID=IBERLIN15 600 </code>

Dann werden Attribute für alle Readings definiert:
:<code>attr wetter_prenzelberg userattr readingsName_cloudiness readingsName_date ... </code>

Dann wird jedem Attribut ein Name zugewiesen (unter diesem Namen wird der Wert ins Log geschrieben):
:<code>attr wetter_prenzelberg readingsName_cloudiness cloudiness </code>

Zum Schluss wird das Reading selbst definiert:
:<code>attr wetter_prenzelberg readingsRegex_cloudiness cloudiness id="NN" percent="([\d\.]+) </code>

Die gesamte Konfiguration für alle von der API angebotenen Wetterwerte sieht dann wie folgt aus:
<pre>
define wetter_prenzelberg HTTPMOD http://api.wunderground.com/weatherstation/WXCurrentObXML.asp?ID=IBERLIN15 600
attr wetter_prenzelberg userattr readingsName_cloudiness readingsName_date readingsName_dewpointTemperature readingsName_fog readingsName_heatindex readingsName_humidity readingsName_pressure readingsName_solarRadiation readingsName_solarUV readingsName_temperature readingsName_time readingsName_windChill readingsName_windDegrees readingsName_windDirection readingsName_windGust readingsName_windSpeed readingsRegex_cloudiness readingsRegex_date readingsRegex_dewpointTemperature readingsRegex_fog readingsRegex_heatindex readingsRegex_humidity readingsRegex_pressure readingsRegex_solarRadiation readingsRegex_solarUV readingsRegex_temperature readingsRegex_time readingsRegex_windChill readingsRegex_windDegrees readingsRegex_windDirection readingsRegex_windGust readingsRegex_windSpeed
attr wetter_prenzelberg readingsName_cloudiness cloudiness
attr wetter_prenzelberg readingsName_date date
attr wetter_prenzelberg readingsName_dewpointTemperature dewpointTemperature
attr wetter_prenzelberg readingsName_fog fog
attr wetter_prenzelberg readingsName_heatindex heatindex
attr wetter_prenzelberg readingsName_humidity humidity
attr wetter_prenzelberg readingsName_pressure pressure
attr wetter_prenzelberg readingsName_solarRadiation solarRadiation
attr wetter_prenzelberg readingsName_solarUV solarUV
attr wetter_prenzelberg readingsName_temperature temperature
attr wetter_prenzelberg readingsName_time time
attr wetter_prenzelberg readingsName_windChill windChill
attr wetter_prenzelberg readingsName_windDegrees windDegrees
attr wetter_prenzelberg readingsName_windDirection windDirection
attr wetter_prenzelberg readingsName_windGust windGust
attr wetter_prenzelberg readingsName_windSpeed windSpeed
attr wetter_prenzelberg readingsRegex_cloudiness cloudiness id="NN" percent="([\d\.]+)
attr wetter_prenzelberg readingsRegex_date date date" content="([\d\.]+)
attr wetter_prenzelberg readingsRegex_dewpointTemperature <dewpoint_c>(\+|-?[\d\.]+)
attr wetter_prenzelberg readingsRegex_fog fog id="FOG" percent="([\d\.]+)
attr wetter_prenzelberg readingsRegex_heatindex <heat_index_c>(\+|-?[\d\.]+)
attr wetter_prenzelberg readingsRegex_humidity <relative_humidity>([\d\.]+)
attr wetter_prenzelberg readingsRegex_pressure <pressure_mb>([\d\.]+)
attr wetter_prenzelberg readingsRegex_solarRadiation <solar_radiation>([\d\.]+)
attr wetter_prenzelberg readingsRegex_solarUV <UV>([\d\.]+)
attr wetter_prenzelberg readingsRegex_temperature <temp_c>(\+|-?[\d\.]+)
attr wetter_prenzelberg readingsRegex_time time Zeit([\d\:]+)
attr wetter_prenzelberg readingsRegex_windChill <windchill_c>(\+|-?[\d\.]+)
attr wetter_prenzelberg readingsRegex_windDegrees <wind_degrees>([\d\.]+)
attr wetter_prenzelberg readingsRegex_windDirection <wind_dir>([\d\.]+)
attr wetter_prenzelberg readingsRegex_windGust <wind_gust_mph>([\d\.]+)
attr wetter_prenzelberg readingsRegex_windSpeed <wind_mph>([\d\.]+)
</pre>
Hinweis: Nicht immer werden alle Werte geliefert (wenn keine Sonne, dann kein UV-Wert...). Im System-Log kann das als Fehler auftauchen, ist aber kein Problem.

=== Erstellen passender gplot-Dateien ===
Um die ausgelesenen Werte als Graphen darstellen zu können müssen eigene gplot-Dateien erstellt werden. Eine grundsätzliche Anleitung dazu findet sich unter [[Creating Plots]]. Deshalb sollen hier nur Beispiele für die eigentlichen gplot-Dateien vorgestellt werden. Beispiele sollten sowohl für [[FileLog]] wie [[DbLog]] funktionieren.

Temperatur und Luftfeuchte:
<pre>
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 '<L1>'
set title ''
set ytics
set y2tics
set grid ytics
set ylabel "Temperature in C"
set y2label "Humidity (%)"

#FileLog 4:temperature\x3a::
#FileLog 4:windChill\x3a::
#FileLog 4:humidity\x3a::

#DbLog <SPEC1>:temperature::
#DbLog <SPEC1>:windChill::
#DbLog <SPEC1>:humidity::

plot "<IN>" using 1:2 axes x1y1 title 'Temperatur (C)' ls l0 lw 1.5 with lines,\
"<IN>" using 1:2 axes x1y1 title 'Gefühlte Temperatur (C)' ls l1 lw 1.5 with lines,\
"<IN>" using 1:2 axes x1y2 title 'Luftfeuchtigkeit (%)' ls l2fill lw 0.2 with lines
</pre>

Wind und Windrichtung:
<pre>
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 ytics
set y2tics ("Nord" 0, "Ost" 80, "Süd" 180, "West" 270, "Nord" 360)

#set title '<L1>'
set title ''

set grid xtics ytics

set yrange [0:20]
set y2range [0:360]

set ylabel "Wind (mph)"
set y2label "Richtung"

#FileLog 4:windSpeed:0:
#FileLog 4:windGust:0:
#FileLog 4:windDegrees:0:

#DbLog <SPEC1>:windSpeed::
#DbLog <SPEC1>:windGust::
#DbLog <SPEC1>:windDegrees::

plot "<IN>" using 1:2 axes x1y1 title 'Wind (mph)' ls l0 lw 1.5 with lines,\
"<IN>" using 1:2 axes x1y1 title 'Böen (mph)' ls l1 lw 1.5 with lines,\
"<IN>" using 1:2 axes x1y2 title 'Windrichtung (°)' ls l2fill lw 0.2 with points
</pre>

Sonnenintensität und UV-Werte:
<pre>
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 ytics
set y2tics

#set title '<L1>'
set title ''

set grid xtics ytics

set ylabel "Sonnenstrahlung (W/qm)"
set y2label "UV"

#FileLog 4:solarRadiation:0:
#FileLog 4:solarUV:0:

#DbLog <SPEC1>:solarRadiation::
#DbLog <SPEC1>:solarUV::

plot "<IN>" using 1:2 axes x1y1 title 'Strahlung' ls l0 lw 1.5 with lines,\
"<IN>" using 1:2 axes x1y1 title 'UV' ls l1 lw 1.5 with lines
</pre>

'''Weitere TBD'''

=== Vergangene Daten abfragen ===
Ein konkretes vergangenes Datum der Wetterstation kann man übrigens auch abrufen - für den 28.11.2014 wäre dies bspw.
<code>http://www.wunderground.com/weatherstation/WXDailyHistory.asp?ID=IBERLIN15&day=28&month=11&year=2014&graphspan=day&format=1</code>.

=== Eigene Wetterdaten hochladen ===
{{Randnotiz|RNTyp=g|RNText=Unterstützung für das Modul gibt es im dazugehörigen {{Link2Forum|Topic=65587|LinkText=Forumsthread }}.}}

Wer eigene Wetterdaten hochladen will, kann hierzu das Modul [http://fhem.de/commandref.html#WUup WUup] verwenden. Dazu benötigt man die Zugangsdaten (stationID und Paßwort) für eine eigene Wetterstation. Mit dem Modul können die meisten vom [http://wiki.wunderground.com/index.php/PWS_-_Upload_Protocol PWS Upload Protocol] unterstützten Daten hochgeladen werden:
* Winddir - [0-360 momentane Windrichtung]
* Windspeedmph - [mph momentane Windgeschwindigkeit]
* Windgustmph - [mph aktuellen Böe, mit Software-spezifischem Zeitraum]
* Windgustdir - [0-360 mit Software-spezifischer Zeit]
* Windspdmph_avg2m - [mph durchschnittliche Windgeschwindigkeit innerhalb 2 Minuten]
* Winddir_avg2m - [0-360 durchschnittliche Windrichtung innerhalb 2 Minuten]
* Windgustmph_10m - [mph Böen der vergangenen 10 Minuten]
* Windgustdir_10m - [0-360 Richtung der Böen der letzten 10 Minuten]
* Feuchtigkeit - [% Außenfeuchtigkeit 0-100%]
* Dewptf- [F Taupunkt im Freien]
* Tempf - [F Außentemperatur]
* Rainin - [in Regen in der vergangenen Stunde]
* Dailyrainin - [in Regenmenge bisher heute]
* Baromin - [inHg barometrischer Druck]
* Soiltempf - [F Bodentemperatur]
* Bodenfeuchtigkeit - [%]
* Solarradiation - [W/m²]
* UV - [Index]

Die Werte werden im Modul für Wunderground ins anglo-amerikanische System umgerechnet. Temperaturen werden also automatisch von °Celsius in Fahrenheit, Windgeschwindigkeiten von km/h in mph, mm in Inch und der barometrische Druck von hPa in inHg umgerechnet.

== Wetternetzwerk auf wetter.com ==
Ein vollständiges Beispiel zur Nutzung der Informationen über die Regenmenge (Station 1445, Weinheim) von wetter.com ist in {{Link2Forum|Topic=39600|Message=332837|LinkText=diesem Forenbeitrag}} beschrieben.

== Wetter von netatmo ==
Das FHEM-Modul [[netatmo]] ermöglicht den Datenimport von privaten und öffentlichen netatmo Wetterstationen. Eine Übersicht über die verfügbaren öffentlichen Stationen findet sich auf der Seite [http://www.netatmo.com/de-DE/weathermap Weathermap]. Die meisten öffentlichen Stationen liefern Temperatur, Luftfeuchte und Luftdruck, einige auch Wind, Regen und Daten zur Luftqualität (CO<sub>2</sub>).

== Links ==
* {{Link2Forum|Topic=33610}} mit Sammlung und Beipielen von Internet-Links für die Anzeige von teilweise animierten Wetterbildern
* [http://bloglich.de/art/rpi/wetterdaten-auf-dem-raspberry-pi-in-fhem/ Beispiel in Blog(de)]
* [[HTTPMOD]]
* [[GDS|Modul GDS]] zum Auslesen von DWD-Daten
* [https://waschto.eu/wetterdienste-in-fhem-einbinden/ How-To: Wetterdienste in FHEM einbinden]

[[Kategorie:Code Snippets]]
[[Kategorie:HOWTOS]]
[[Kategorie:Wetterstationen]]

Wetter und Wettervorhersagen

2017-10-29T16:51:19Z

Waschto: Link zum Wetterdienste in FHEM einbinden

Wetterdaten und Wettervorhersagen können auf verschiedene Weise in FHEM eingebunden werden.

== Yahoo-Wetter ==
Für die einfache Einbindung des Yahoo-Wetters gibt es das spezielle Modul [[Weather]].

== Unwetterzentrale ==
Informationen der Seite(n) Unwetterzentrale.de können mit Hilfe des Moduls [[UWZ]] eingebunden werden.

== Modul OPENWEATHER ==
Das Modul [[OPENWEATHER]] extrahiert Wetterdaten über die "openweather"-Schnittstelle (API) von www.wetter.com.
*Vorschau-Zeitraum: 3 Tage
*Vorschau-Interval: 6:00, 11:00, 17:00, 23:00
*Aktuelle Daten: keine

== Modul PROPLANTA ==
Das Modul [[PROPLANTA]] extrahiert Wetterdaten von der Website www.proplanta.de. (keine API)
*Vorschau-Zeitraum: 12 Tage
*Vorschau-Interval: 3 h
*Aktuelle Daten: jede volle Stunde

== Modul WWO ==
Das Modul extrahiert Wetterdaten über die (alte) API von worldweatheronline.com
*Vorschau-Zeitraum: ?? Tage<BR>
*Vorschau-Interval: ??<br>
*Aktuelle Daten: ??

== Wetterwarnungen des DWD ==
{{Randnotiz|RNTyp=y|RNText=Die Nutzung der Vorhersagedaten wurde vom DWD verändert und ist momentan nicht wie hier beschrieben möglich. Eine Alternative bietet das Modul [[UWZ]]!}}
Der Deutsche Wetterdienst [http://www.dwd.de DWD] stellt neben diversen Wetterdaten auch Wetterwarnungen bereit. Diese können sehr einfach via [http://fhem.de/commandref_DE.html#weblink weblink iframe] in FHEM eingebunden werden - das ist zwar nicht die schönste Form, aber die schnellste.

Dazu sucht man sich zuerst auf der [http://www.dwd.de/bvbw/appmanager/bvbw/dwdwwwDesktop?_nfpb=true&_pageLabel=_dwdwww_wetter_warnungen_warnungen&T92053gsbDocumentPath=BEA__Navigation%2FWetter__Warnungen%2FWarnungen.html%3F__nnn%3Dtrue&lastPageLabel=dwdwww_wetter_warnungen Warnungsseite des DWD] die eigene Region heraus (in der Karte durchklicken). Die gewünschte URL für Berlin Stadt ist z.B. <code>http://www.dwd.de/dyn/app/ws/html/reports/BXX_warning_de.html#WS_ANCHOR_0</code>. Das Anhängsel <code>#WS_ANCHOR_0</code> kann man in der Konfiguration auch weglassen.

Die Einbindung in FHEM sieht dann wie folgt aus:
<pre>
define dwd_warnmeldung weblink iframe http://www.dwd.de/dyn/app/ws/html/reports/BXX_warning_de.html
attr dwd_warnmeldung group Wetterwarnungen (DWD)
attr dwd_warnmeldung htmlattr width="100%" height="300" frameborder="0" marginheight="0" marginwidth="0"
attr dwd_warnmeldung room Wettervorhersage,Startseite
</pre>

== Vorhersage-Diagramm von YR ==
[http://www.yr.no YR] ist die Seite des norwegischen Wetterdiensts. Er ist zwar nur in Teilen auf Englisch (und gar nicht auf Deutsch) verfügbar, bietet aber sehr gute Wettervorhersagen - auch mit eigenen Vorhersagen für kleine Dörfer. Neben etlichen Detailinfos bietet YR eine sehr schicke 48h-Vorhersage-Grafik. Diese kann sehr einfach via [http://fhem.de/commandref_DE.html#weblink weblink iframe] in FHEM eingebunden werden.

Dazu geht man auf die [http://www.yr.no Startseite von YR] und gibt in das Suchfeld den Namen seines Dörfchens ein - die Ergebnissliste kann ziemlich lang werden, sodass man evtl. sehr genau schauen muss, welches das eigene Kaff ist - bei mir war es an 29. Stelle... ;-) Auf der gewünschten Seite gibt es einen Unterpunkt "Hour by hour", wo sich die besagte Grafik findet. Hier kopiert man sich einfach die URL der Grafik.

Die Einbindung in FHEM sieht dann bspw. wie folgt aus:
<pre>
define Wetter_yr_Vorhersage weblink iframe http://www.yr.no/place/Germany/Berlin/Berlin/meteogram.png
attr Wetter_yr_Vorhersage group Wettervorhersage (yr)
attr Wetter_yr_Vorhersage htmlattr width="100%" height="300" frameborder="0" marginheight="0" marginwidth="0"
attr Wetter_yr_Vorhersage room Wettervorhersage,Start
</pre>

== Wetter von Weather Underground ==
{{Randnotiz|RNTyp=y|RNText=Neben dem hier vorgestellten Abruf der Weather Underground-Daten mit [[HTTPMOD]] kann auf Weather Underground-Daten auch mit dem darauf spezialisierten Modul [http://fhem.de/commandref.html#Wunderground Wunderground] zugegriffen werden.}}

'''Hinweis:''' Dieses Vorgehen ist etwas anspruchsvoller und somit eher für erfahrene FHEM-User geeignet.

[http://www.wunderground.com/ Weather Underground] ist bietet eine sehr umfassende Sammlung aller möglichen offiziellen und privaten (aber teils sehr professionellen) Wetterstationen weltweit. Es besteht eine recht hohe Wahrscheinlichkeit, dass es in der eigenen Umgebung schon eine Wetterstation gibt. Anstatt nun selbst eine komplette Wetterstation aufzubauen, kann man alternativ auf die Daten der Nachbarstation zugreifen.

Dazu sind grundsätzlich die folgenden Schritte notwendig:
* Finden der geeigneten Station
* Auswerten der XML-Daten
* Erstellen passender gplot-Dateien

=== Finden der geeigneten Station ===
Als erstes geht man auf die [http://www.wunderground.com Startseite von Weather Underground] und gibt in das Suchfeld den Namen seines Dörfchens oder der nächsten Stadt ein - für Berlin landet man bspw. auf Seite für "Berlin Alexanderplatz". Es gibt aber manchmal sehr viele Wetterstationen in der direkten Umgebung. Diese findet man indem am auf "Change Station" klickt und sich eine passende Station aussucht. Nähere Infos (zB. zur verwendeten Hard- und Software) zu der gewählten Wetterstation erhält man, wenn man auf den Namen der Station klickt und dann auf "About this PWS".

Weather Underground stellt die Daten der Wetterstation auch über eine API als XML bereit, die wir auswerten können. Die entsprechende URL findet sich ebenfalls unter "About this PWS" unter "Download current conditions XML". Für Berlin Prenzlauer Berg wäre dies bspw.
<code>http://api.wunderground.com/weatherstation/WXDailyHistory.asp?ID=IBERLIN15&format=XML</code>.

Entscheidend für die jeweilige Station ist der Teil nach "?=ID", also in diesem Fall "IBERLIN15". Dieser Teil des Links lässt sich leicht durch die ID einer anderen Station ersetzen und die Suche nach dem entsprechenden Link auf der Seite der Station bleibt erspart.

=== Auswerten der XML-Daten ===
Die Auswertung der XML-Daten erfolgt via [[HTTPMOD]]. Da dies nicht ganz trivial ist, sind im Folgenden zuerst die wesentlichen Konfigurationsschritte exemplarisch beschrieben. Weiter unten findet sich dann die fertige vollständige Konfiguration.

Es erstes wird das Device HTTPMOD definiert (die 600 am Schluss ist der Aktualisierungszyklus in Sekunden, also alle 10 min):
:<code>define wetter_prenzelberg HTTPMOD http://api.wunderground.com/weatherstation/WXCurrentObXML.asp?ID=IBERLIN15 600 </code>

Dann werden Attribute für alle Readings definiert:
:<code>attr wetter_prenzelberg userattr readingsName_cloudiness readingsName_date ... </code>

Dann wird jedem Attribut ein Name zugewiesen (unter diesem Namen wird der Wert ins Log geschrieben):
:<code>attr wetter_prenzelberg readingsName_cloudiness cloudiness </code>

Zum Schluss wird das Reading selbst definiert:
:<code>attr wetter_prenzelberg readingsRegex_cloudiness cloudiness id="NN" percent="([\d\.]+) </code>

Die gesamte Konfiguration für alle von der API angebotenen Wetterwerte sieht dann wie folgt aus:
<pre>
define wetter_prenzelberg HTTPMOD http://api.wunderground.com/weatherstation/WXCurrentObXML.asp?ID=IBERLIN15 600
attr wetter_prenzelberg userattr readingsName_cloudiness readingsName_date readingsName_dewpointTemperature readingsName_fog readingsName_heatindex readingsName_humidity readingsName_pressure readingsName_solarRadiation readingsName_solarUV readingsName_temperature readingsName_time readingsName_windChill readingsName_windDegrees readingsName_windDirection readingsName_windGust readingsName_windSpeed readingsRegex_cloudiness readingsRegex_date readingsRegex_dewpointTemperature readingsRegex_fog readingsRegex_heatindex readingsRegex_humidity readingsRegex_pressure readingsRegex_solarRadiation readingsRegex_solarUV readingsRegex_temperature readingsRegex_time readingsRegex_windChill readingsRegex_windDegrees readingsRegex_windDirection readingsRegex_windGust readingsRegex_windSpeed
attr wetter_prenzelberg readingsName_cloudiness cloudiness
attr wetter_prenzelberg readingsName_date date
attr wetter_prenzelberg readingsName_dewpointTemperature dewpointTemperature
attr wetter_prenzelberg readingsName_fog fog
attr wetter_prenzelberg readingsName_heatindex heatindex
attr wetter_prenzelberg readingsName_humidity humidity
attr wetter_prenzelberg readingsName_pressure pressure
attr wetter_prenzelberg readingsName_solarRadiation solarRadiation
attr wetter_prenzelberg readingsName_solarUV solarUV
attr wetter_prenzelberg readingsName_temperature temperature
attr wetter_prenzelberg readingsName_time time
attr wetter_prenzelberg readingsName_windChill windChill
attr wetter_prenzelberg readingsName_windDegrees windDegrees
attr wetter_prenzelberg readingsName_windDirection windDirection
attr wetter_prenzelberg readingsName_windGust windGust
attr wetter_prenzelberg readingsName_windSpeed windSpeed
attr wetter_prenzelberg readingsRegex_cloudiness cloudiness id="NN" percent="([\d\.]+)
attr wetter_prenzelberg readingsRegex_date date date" content="([\d\.]+)
attr wetter_prenzelberg readingsRegex_dewpointTemperature <dewpoint_c>(\+|-?[\d\.]+)
attr wetter_prenzelberg readingsRegex_fog fog id="FOG" percent="([\d\.]+)
attr wetter_prenzelberg readingsRegex_heatindex <heat_index_c>(\+|-?[\d\.]+)
attr wetter_prenzelberg readingsRegex_humidity <relative_humidity>([\d\.]+)
attr wetter_prenzelberg readingsRegex_pressure <pressure_mb>([\d\.]+)
attr wetter_prenzelberg readingsRegex_solarRadiation <solar_radiation>([\d\.]+)
attr wetter_prenzelberg readingsRegex_solarUV <UV>([\d\.]+)
attr wetter_prenzelberg readingsRegex_temperature <temp_c>(\+|-?[\d\.]+)
attr wetter_prenzelberg readingsRegex_time time Zeit([\d\:]+)
attr wetter_prenzelberg readingsRegex_windChill <windchill_c>(\+|-?[\d\.]+)
attr wetter_prenzelberg readingsRegex_windDegrees <wind_degrees>([\d\.]+)
attr wetter_prenzelberg readingsRegex_windDirection <wind_dir>([\d\.]+)
attr wetter_prenzelberg readingsRegex_windGust <wind_gust_mph>([\d\.]+)
attr wetter_prenzelberg readingsRegex_windSpeed <wind_mph>([\d\.]+)
</pre>
Hinweis: Nicht immer werden alle Werte geliefert (wenn keine Sonne, dann kein UV-Wert...). Im System-Log kann das als Fehler auftauchen, ist aber kein Problem.

=== Erstellen passender gplot-Dateien ===
Um die ausgelesenen Werte als Graphen darstellen zu können müssen eigene gplot-Dateien erstellt werden. Eine grundsätzliche Anleitung dazu findet sich unter [[Creating Plots]]. Deshalb sollen hier nur Beispiele für die eigentlichen gplot-Dateien vorgestellt werden. Beispiele sollten sowohl für [[FileLog]] wie [[DbLog]] funktionieren.

Temperatur und Luftfeuchte:
<pre>
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 '<L1>'
set title ''
set ytics
set y2tics
set grid ytics
set ylabel "Temperature in C"
set y2label "Humidity (%)"

#FileLog 4:temperature\x3a::
#FileLog 4:windChill\x3a::
#FileLog 4:humidity\x3a::

#DbLog <SPEC1>:temperature::
#DbLog <SPEC1>:windChill::
#DbLog <SPEC1>:humidity::

plot "<IN>" using 1:2 axes x1y1 title 'Temperatur (C)' ls l0 lw 1.5 with lines,\
"<IN>" using 1:2 axes x1y1 title 'Gefühlte Temperatur (C)' ls l1 lw 1.5 with lines,\
"<IN>" using 1:2 axes x1y2 title 'Luftfeuchtigkeit (%)' ls l2fill lw 0.2 with lines
</pre>

Wind und Windrichtung:
<pre>
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 ytics
set y2tics ("Nord" 0, "Ost" 80, "Süd" 180, "West" 270, "Nord" 360)

#set title '<L1>'
set title ''

set grid xtics ytics

set yrange [0:20]
set y2range [0:360]

set ylabel "Wind (mph)"
set y2label "Richtung"

#FileLog 4:windSpeed:0:
#FileLog 4:windGust:0:
#FileLog 4:windDegrees:0:

#DbLog <SPEC1>:windSpeed::
#DbLog <SPEC1>:windGust::
#DbLog <SPEC1>:windDegrees::

plot "<IN>" using 1:2 axes x1y1 title 'Wind (mph)' ls l0 lw 1.5 with lines,\
"<IN>" using 1:2 axes x1y1 title 'Böen (mph)' ls l1 lw 1.5 with lines,\
"<IN>" using 1:2 axes x1y2 title 'Windrichtung (°)' ls l2fill lw 0.2 with points
</pre>

Sonnenintensität und UV-Werte:
<pre>
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 ytics
set y2tics

#set title '<L1>'
set title ''

set grid xtics ytics

set ylabel "Sonnenstrahlung (W/qm)"
set y2label "UV"

#FileLog 4:solarRadiation:0:
#FileLog 4:solarUV:0:

#DbLog <SPEC1>:solarRadiation::
#DbLog <SPEC1>:solarUV::

plot "<IN>" using 1:2 axes x1y1 title 'Strahlung' ls l0 lw 1.5 with lines,\
"<IN>" using 1:2 axes x1y1 title 'UV' ls l1 lw 1.5 with lines
</pre>

'''Weitere TBD'''

=== Vergangene Daten abfragen ===
Ein konkretes vergangenes Datum der Wetterstation kann man übrigens auch abrufen - für den 28.11.2014 wäre dies bspw.
<code>http://www.wunderground.com/weatherstation/WXDailyHistory.asp?ID=IBERLIN15&day=28&month=11&year=2014&graphspan=day&format=1</code>.

=== Eigene Wetterdaten hochladen ===
{{Randnotiz|RNTyp=g|RNText=Unterstützung für das Modul gibt es im dazugehörigen {{Link2Forum|Topic=65587|LinkText=Forumsthread }}.}}

Wer eigene Wetterdaten hochladen will, kann hierzu das Modul [http://fhem.de/commandref.html#WUup WUup] verwenden. Dazu benötigt man die Zugangsdaten (stationID und Paßwort) für eine eigene Wetterstation. Mit dem Modul können die meisten vom [http://wiki.wunderground.com/index.php/PWS_-_Upload_Protocol PWS Upload Protocol] unterstützten Daten hochgeladen werden:
* Winddir - [0-360 momentane Windrichtung]
* Windspeedmph - [mph momentane Windgeschwindigkeit]
* Windgustmph - [mph aktuellen Böe, mit Software-spezifischem Zeitraum]
* Windgustdir - [0-360 mit Software-spezifischer Zeit]
* Windspdmph_avg2m - [mph durchschnittliche Windgeschwindigkeit innerhalb 2 Minuten]
* Winddir_avg2m - [0-360 durchschnittliche Windrichtung innerhalb 2 Minuten]
* Windgustmph_10m - [mph Böen der vergangenen 10 Minuten]
* Windgustdir_10m - [0-360 Richtung der Böen der letzten 10 Minuten]
* Feuchtigkeit - [% Außenfeuchtigkeit 0-100%]
* Dewptf- [F Taupunkt im Freien]
* Tempf - [F Außentemperatur]
* Rainin - [in Regen in der vergangenen Stunde]
* Dailyrainin - [in Regenmenge bisher heute]
* Baromin - [inHg barometrischer Druck]
* Soiltempf - [F Bodentemperatur]
* Bodenfeuchtigkeit - [%]
* Solarradiation - [W/m²]
* UV - [Index]

Die Werte werden im Modul für Wunderground ins anglo-amerikanische System umgerechnet. Temperaturen werden also automatisch von °Celsius in Fahrenheit, Windgeschwindigkeiten von km/h in mph, mm in Inch und der barometrische Druck von hPa in inHg umgerechnet.

== Wetternetzwerk auf wetter.com ==
Ein vollständiges Beispiel zur Nutzung der Informationen über die Regenmenge (Station 1445, Weinheim) von wetter.com ist in {{Link2Forum|Topic=39600|Message=332837|LinkText=diesem Forenbeitrag}} beschrieben.

== Wetter von netatmo ==
Das FHEM-Modul [[netatmo]] ermöglicht den Datenimport von privaten und öffentlichen netatmo Wetterstationen. Eine Übersicht über die verfügbaren öffentlichen Stationen findet sich auf der Seite [http://www.netatmo.com/de-DE/weathermap Weathermap]. Die meisten öffentlichen Stationen liefern Temperatur, Luftfeuchte und Luftdruck, einige auch Wind, Regen und Daten zur Luftqualität (CO<sub>2</sub>).

== Links ==
* {{Link2Forum|Topic=33610}} mit Sammlung und Beipielen von Internet-Links für die Anzeige von teilweise animierten Wetterbildern
* [http://bloglich.de/art/rpi/wetterdaten-auf-dem-raspberry-pi-in-fhem/ Beispiel in Blog(de)]
* [[HTTPMOD]]
* [[GDS|Modul GDS]] zum Auslesen von DWD-Daten
* [https://waschto.eu/wetterdienste-in-fhem-einbinden/ Wetterdienste in FHEM einbinden]

[[Kategorie:Code Snippets]]
[[Kategorie:HOWTOS]]
[[Kategorie:Wetterstationen]]

RandomTimer

2017-09-10T19:46:18Z

Waschto: Link zu einem HowTo hinzugefügt

{{Infobox Modul
|ModPurpose=Generierung von "Zufallszeiten"
|ModType=h
|ModForumArea=Unterstützende Dienste/Kalendermodule
|ModTechName=98_RandomTimer.pm
|ModOwner=dietmar63
}}

[[RandomTimer]] ist ein Hilfsmodul, mit dem in einem bestimmten Zeitraum zu zufälligen Zeitpunkten Schaltvorgänge ausgelöst werden können (ähnlich der Funktionalität der FS20 ZSU).

== Voraussetzungen ==
Keine speziellen Voraussetzungen erforderlich.

== Anwendung ==

=== Define ===
Die Syntax für die Definition eines RandomTimer:
:<code>define <name> RandomTimer <timespec_start> <device> <timespec_stop> [<timeToSwitch>]</code>
Parameterbedeutung:
;name
:Eindeutiger Name des anzulegenden RandomTimer.
;timespec_start
:Zeitpunkt, ab wann der Timer aktiv ist, im Format ''HH:MM:SS''.
;device
:Der Name des Gerätes, das zu schalten ist.
;timespec_stop
:Zeitpunkt, ab wann der Timer nicht mehr aktiv ist, im Format ''HH:MM:SS''.
;timeToSwitch
:Zeit zwischen zwei An- und Aus-Schaltvorgängen; Angabe in Sekunden zwischen 10 und 9999

=== Attribute ===
RandomTimer unterstützt die folgenden Attribute:
;disableCond
:Bedingungen, unter denen der RandomTimer nicht aktiv wird <br />Beispiel: <code>(!isVerreist())</code> würde bedeuten, dass der RandomTimer nur aktiv wird, wenn der Status auf eine Abwesenheit hinweist.
;keepDeviceAlive
:Wenn dieses Attribut gesetzt ist, wird das Gerät bei Erreichen der Ende-Zeit nicht ausgeschaltet
;onCmd
:Befehl, der als '''Ein'''schaltbefehl verwendet werden soll (Standardwert: <code>set <device> on</code>)
;offCmd
:Befehl, der als '''Aus'''schaltbefehl verwendet werden soll (Standardwert: <code>set <device> off</code>)
;runonce
:Legt fest, ob ... (ist in der commandref (noch?) nicht beschrieben)
;switchmode nnn/nnn
:Wahrscheinlichkeit (in Promille), dass der on- bzw. off-Befehl wirklich gesendet wird. Standardwert: 800/200

== Anwendungsbeispiel(e) ==
Ein mit
:<code>define ZufallsTimerTisch RandomTimer *{sunset_abs()} StehlampeTisch *{sunset_abs(3*3600)} 480</code>
definierter RandomTimer beginnt bei '''Sonnenuntergang''' das Gerät '''StehlampeTisch''' alle '''480 Sekunden''' Ein- bzw. Auszuschalten. Diese Schaltvorgänge stoppen '''3 Stunden''' nach '''Sonnenuntergang'''.

== Links ==
* {{Link2Forum|Topic=14010|LinkText=Thread}} im Fhem Forum
* [https://waschto.eu/anwesenheitssimulation-zufaelliges-schalten-von-licht/ How-To: Anwesenheitssimulation mit dem RandomTimer]

WeekdayTimer

2017-09-10T19:44:00Z

Waschto: Link zu einem HowTo hinzugefügt

{{Todo|Der Commandref-Abschnitt zu diesem Modul enthält noch einige Fehler und Ungenauigkeiten, die im Zusammenhang mit der Ausarbeitung dieser Wiki-Seite korrigiert werden sollten. Auf dieser Seite fehlen insbesondere noch Anwendungsbeispiele mit Screenshots sowie die Beschreibung von Besonderheiten wie die vereinfachte/integrierte Unterstützung von enable/disable.}}

{{Infobox Modul
|ModPurpose=Definition von Wochen-Zeitschaltplänen
|ModType=h
|ModForumArea=Unterstuetzende Dienste
|ModTechName=98_WeekdayTimer.pm
|ModOwner={{Link2FU|405|Dietmar63}}
}}

[[WeekdayTimer]] ist ein Hilfsmodul zur Erstellung von (Wochen-)Zeitschaltplänen für Geräte.

== Voraussetzungen ==
Keine.

== Anwendung ==
=== Define ===
Ein WeekdayTimer wird angelegt mittels
:<code>define ''meinWDT'' WeekdayTimer ''meinDevice'' <nowiki><profil></nowiki> ...</code>
Details: siehe commandref

=== Attribute ===
Siehe commandref.

== Anwendungsbeispiele ==
* Rollläden schließen nach Zeitplan aber mit Zusatzbedingungen: siehe {{Link2Forum|Topic=27247|LinkText=dieses Forenthema}}
* ''disable'' Attribut setzen für WeekdayTimer: siehe {{Link2Forum|Topic=23655|LinkText=dieses Forenthema}}

== Links ==
* [https://waschto.eu/weekdaytimer-einfache-zeitschaltuhr/ How-To: Einfache Zeitschaltuhr mit dem WeekdayTimer]

LightScene

2017-09-10T19:39:38Z

Waschto: Link zu einem HowTo hinzugefügt

{{Infobox Modul
|ModPurpose=Speicherung und Wiederherstellung des Zustands von einer Gruppe von Geräten.
|ModType=h


|ModTechName=31_LightScene.pm
|ModOwner=justme1968
}}

'''LightScene''' ist ein Hilfsmodul, das es erlaubt, Zustände einer Gruppe von Geräten abzuspeichern und wiederherzustellen.

== Anwendung ==
=== Define ===
:<code>define <name> LightScene [<dev1>] [<dev2>] [<dev3>] ... </code>

=== Set ===

=== Get ===

=== Attributes ===

== Funktionen ==

== Anwendungsbeispiele ==
* [[XBMC#Lichtsteuerung_durch_KODI_oder_PLEX|Lichtsteuerung durch KODI oder PLEX]]
* [[Zuhause-Status|Umsetzung Zuhause-Status mit LightScene]]
* [[ReadingsGroup#LightScene_DropDown-Men.C3.BC_f.C3.BCr_smallscreen_Styles_oder_Floorplan|LightScene-DropDown-Menü für Smallscreen-Styles oder Floorplan]]

== Links ==
* [https://waschto.eu/lightscene-erstellen-von-lichtszenen/ How-To: Lichtszenen erstellen mit LightScene]
* weitere Dokumentation
* ...

DLCD

2017-09-10T19:35:01Z

Waschto: Link zu einem Projekt mit DLCD hinzugefügt

{{Infobox Modul
|ModPurpose=Daten sammeln und formatiert auf LCD ausgeben
|ModType=x
|ModCmdRef= ---- noch nicht Teil von FHEM ----
|ModForumArea=Codeschnipsel
|ModTechName=39_DLCD.pm
|ModOwner=epsrw1 ([http://forum.fhem.de/index.php?action=profile;u=6340 Forum] / [[Benutzer Diskussion:Epsrw1|Wiki]])}}

Das [[DLCD]]-Modul bietet eine einfache Möglichkeit, Daten zu sammeln und für die Anzeige auf einem seriellen LCD aufzubereiten.

== Features ==
<u>Diese Wiki-Seite beschreibt den Versionsstand 2.0 des DLCD-Moduls.</u>

Thread im {{Link2Forum|Topic=24519|LinkText=Fhem-Forum}} mit der jeweils aktuellen Version des Moduls als Anhang im ersten Beitrag.

== Beschreibung ==
[[Datei:dok39_DLCD.jpg|mini|Funktionsweise]]

DLCD bietet als kleines Helferlein die Möglichkeit, Textzeilen eines LCD Displays als Readings vorzubereiten und mit Daten frei konfigurierbarer Readings zu befüllen.

Jede Zeile wird als Attr vordefiniert, und mit Platzhaltern (z.B.: %1%) für die einzutragenden Werte versehen.

Die Liste aller einzulesenden Devices:Readings wird in einem attr eingestellt. Das Modul prüft dann regelmäßig (attr: poll interval) die Daten der Fhem-Devices
und aktualisiert dann die Anzeige sobald sich einer der Werte geändert hat.

Zusätzlich können Zahlen einfach über attr formatiert werden (Kommastellen, Rundung, Anzeige von + und - Zeichen).

Eine Reihe von Platzhaltern ermöglicht das Einsetzen von Datum und Zeit-Werten in die Ausgabezeilen (zB Minute einzeln, Wochentag, Datum, ....)

Die über attr einschaltbare Rollierfunktion verschiebt die Zeilen bei jedem Update um eine Ziffer nach oben. So läßt sich zB eine wechselanzeige auf einem einzeiligen Display realisieren.

Die eigentliche Ausgabe auf das LCD erfolgt jeweils immer dann wenn eine Änderung der Daten festgestellt wird, auf beliebiges konfigurierbares Device. Zum beispiel I2C LCD über FHEM, oder auch über shell-command für nicht von FHEM unterstützte displays.

Manche Displays können Leerzeichen oder Umlaute nicht richtig wiedergeben. Daher kann DLCD über attr eingestellte Ersetzungen vornehmen, bevor die Daten an das LCD-device übergeben werden.

Um die Einrichtung zu erleichtern, kann man mit dem attr dlcdDebugOutput die jeweils an das Device abgesetzten Befehle als ''reading'' ausgeben lassen.

Mit stateFormat state<br>Line1<br>Line2<br>Line3<br>Line4 kann man sich ein Abbild des Displayinhaltes im Web-frontend anzeigen lassen.

[[Datei:dlcd_stateformat.png|mini|Frontend-Beispiel]]

== Define ==
:<code>define <name> DLCD </code>

''In der Basisversion wurde Number::Format von cpan benötigt. Dies ist ab v. 1.1. nicht mehr der Fall.''

== Attribute ==
Alle Attribute sind auch in fhem durch das Kommando get attrHelp <varname> erklärt, für's "schnelle Nachschauen zwischendurch".

* dlcdRows -> Anzahl Datenzeilen (kann mehr als am Display sein mit eingeschaltetem Scrolling)
* dlcdCols -> Anzahl Spalten des LC-Displays
* dlcdPollInterval -> Zeitintervall, nach dem FHEM versucht, die Daten zu aktualisieren
* dlcdLine1 -> Formatvorlage für LCD-Zeile z.B.: text: %1% text: %2%
* dlcdLine2 -> Formatvorlage für LCD-Zeile z.B.: text: %3% text: %4%
* dlcdLine3 -> Formatvorlage für LCD-Zeile z.B.: text: %5% text: %6%
* dlcdLine4 -> Formatvorlage für LCD-Zeile Text: %7% text: %8%
* dlcdLine5 -> Formatvorlage für LCD-Zeile Text: %11% text: %12%
* dlcdVal1 -> Quelle für den Wert %1% im Format: FhemDev:reading
* dlcdVal2 -> Quelle für den Wert %2% im Format: FhemDev:reading
* dlcdVal3 -> Quelle für den Wert %3% im Format: FhemDev:reading
* ...
* dlcdVal20 -> Quelle für den Wert %12% im Format: FhemDev:reading

* dlcdTriggerCmd -> Fhem-Befehl zum Schreiben einer LCD-Zeile, z.B.: <code>set lcd_wand writeXY 0,%L%,20,1 %T%</code>
* dlcdVal1formatnum -> Zahlenformatierung für Wert %1%, muss none sein bei Nicht-Zahl
* dlcdVal2formatnum -> Zahlenformatierung für Wert %1%, muss none sein bei Nicht-Zahl
* dlcdVal3formatnum -> Zahlenformatierung für Wert %1%, muss none sein bei Nicht-Zahl
* ...
* dlcdVal20formatnum -> Zahlenformatierung für Wert %1%, muss none sein bei Nicht-Zahl

-----

dlcdVal .. formatnum setzen die Anzahl Dezimalstellen fest, sowie ob ein + bzw. - Zeichen vorangestellt wird. Es funktioniert wie folgt:

erste Ziffer: Gesamtzahl Ziffern in der Ausgabe.
zweite Ziffer: Anzahl fester Dezimalstellen
optional: +- an dritter Stelle

Beispiele:
2+1 -> 1.1 9.0 0.4
4+2+- -> -12.34 +10.50
4+0+- -> -0012 +0010

Die möglichen Optionen sind in einer Liste fest vorgegeben, um Fehleinstellungen zu vermeiden. Über manuellen Eintrag in der fhem-config können Eigenkreationen eingestellt werden, die nicht in der Liste enthalten sind (zB. 10+2+-).

-----

* dlcdVal1formatstring -> benutzerdefinierter sprintf format pattern, setzt formatnum außer kraft. zB: %03f
* dlcdVal2formatstring -> benutzerdefinierter sprintf format pattern, setzt formatnum außer kraft. zB: %03f
* dlcdVal3formatstring -> benutzerdefinierter sprintf format pattern, setzt formatnum außer kraft. zB: %03f
* ...
* dlcdVal20formatstring -> benutzerdefinierter sprintf format pattern, setzt formatnum außer kraft. zB: %03f

* dlcdBlankspaceReplace -> Leerzeichen wird im dlcdTriggerCmd durch diesen attr-Wert ersetzt. z.B.: \\x20 oder \\x{10}
* dlcdReplaceRegex -> beliebige ersetzung von zeichen, kommagetrennte paare mit = zeichen, zB.: ä=\\xE1,ö=\\xEF,ü=\\xF5,Ä=\\xE1,Ö=\\xEF,Ü=\\xF5,ß=\\xE2,°=\\x{DF}, Unicode-Beispiel: \N{U+code}, zB \N{U+0041}und \N{U+41} werden zu A und A
* dlcdPhysicalRows -> Anzahl physikalisch vorhandener Zeilen am Ausgabedisplay
* dlcdScrolling -> Zeilen automatisch scrollen, 1=an 0=aus
* dlcdDebugOutput -> zusätzliche readings für aktuelle Display-ausgabe zum testen der Scroll-Funktion
* dlcdClearLineCmd -> optional: command um lcd-zeile zu leeren (%L%=line 0-n), zB. Set lcd42 clear %L%
* dlcdClearAllCmd -> optional: command um lcd komplett zu leeren (nur bei scrolling)
* dlcdLineAddrMap -> alternative Zeilenadressierung. Default ist 0,1,2,3,4,5,6,7,8,9. Beispiel: 1,2,3 verwendet nur 2. bis 4. LCD-zeile und überspringt die erste.
* disable -> keine neuen schreibvorgänge

== Settings ==
reset ->alle Readings zurücksetzen

== Readings ==
Line1 -> Aktuelle Anzeige der Zeile 1

Line2 -> Aktuelle Anzeige der Zeile 2

Line3 -> Aktuelle Anzeige der Zeile 3

Line4 -> Aktuelle Anzeige der Zeile 4

Line5 -> Aktuelle Anzeige der Zeile 5

== Spezielle Anzeigefunktionen ==

Datum und Uhrzeit basieren aktuell auf der Systemzeit des FHEM-Servers. Eine Möglichkeit, als Zeitbasis den Timestamp eines FHEM-Readings zu verwenden, ist denkbar; wer das nutzen möchte, bitte im Forum melden.

=== Datum ===
* %date_Y% --> Jaheszahl 4-stellig
* %date_y% --> Jahreszahl 2-stellig
* %date_M% --> Monat als Zahl, 2-stellig
* %date_M_eng% --> Monat, Abkürzung englisch
* %date_M_ger% --> Monat, Abkürzung deutsch
* %date_D% --> Tag des Monats 2-stellig
* %date_WD% --> Wochentag 1-stellig im Format 0(So) ... 6(Sa)
* %date_WD_eng% --> Wochentag, Abkürzung englisch
* %date_WD_ger% --> Wochentag, Abkürzung deutsch
* %date_dmy% --> Datum im Format 25.08.2014

=== Zeit ===
* %time_hms% --> HH:MM:SS Uhrzeit
* %time_h% --> Stunde
* %time_m% --> Minute
* %time_s% --> Sekunde

=== LCD-Abbild im Web-frontend ===
attr <name> stateFormat state<br>Line1<br>Line2<br>Line3<br>Line4<br>Line5

=== Mathematische Werteberechnung ===
* Noch in Arbeit - Ideen sind willkommen ;) --> Forum
* To be continued

== Weblinks ==
* {{Link2Forum|Topic=24519|LinkText=Thread}} im Forum, in dem dieses Modul vorgestellt wurde
* [https://waschto.eu/statusdisplay-mit-esp-easy-dlcd-und-fhem/ Projekt: Statusdisplay mit ESP Easy und DLCD]
* ...

[[Kategorie:Other Components]]

99 myUtils anlegen

2017-09-10T19:10:09Z

Waschto: Link zu einem HowTo hinzugefügt

Mit wachsender Anzahl von eigenen Helfer-Programmen wird die Speicherung von perl-code in notify unübersichtlich. Es besteht die Möglichkeit, eine eigene Programmdatei zu erzeugen, in der mehrere kleine Programme gesammelt und dann aus diversen notify- oder at-Anweisungen aufgerufen werden.
== Eine neue Programmdatei erzeugen ==
FHEM enthält seit Updatestand 01/2015 eine Vorlage 'myUtilsTemplate.pm', die zur Erzeugung der Programmdatei genutzt werden sollte.
Vorgehensweise:
* FHEM-Menüpunkt {{Taste|Edit files}} anklicken
* Weblink 'myUtilsTemplate.pm' anklicken
* Im Textfeld hinter 'Save as' den Dateinamen '99_myUtils.pm' für die Programmdatei eintragen
: Hinweis: Wenn ein anderer Dateiname angegeben wird, muss der Name Initialize-Routine entsprechend angepasst werden (siehe nachfolgende Erläuterung zur Grundstruktur unter Nr. 3)
* {{Taste|Save as}} anklicken
Nun ist die eigene Programmdatei '99_myUtils.pm' mit der notwendigen Grundstruktur unter dem Menüpunkt 'Edit files' zur Bearbeitung mit dem [[Konfiguration#Integrierter_Editor|Integrierter Editor]] zu finden. Für eine einfache und fehlerminimierende Bearbeitung sollten die [[Konfiguration#Syntaxhervorhebung|Syntaxhervorhebungs-, Befehlsauswahl- und Befehlsvervollständigungsfunktionen]] im Integrierten Editor eingeschaltet sein.

Für Experten ist auch die Nutzung eines [[Konfiguration#Externer Editor|Externen Editors]] zur Bearbeitung möglich, aber nicht empfohlen.

Eine ‚leere‘ Programmdatei muss grundsätzlich folgenden Grundstruktur besitzen:

<source lang="perl">
package main;
use strict;
use warnings;
use POSIX;
sub
myUtils_Initialize($$)
{
my ($hash) = @_;
}
1;
</source>

Folgende Dinge sind für die Programmdatei besonders zu beachten:

# Der Dateiname muss mit 99_ beginnen. FHEM lädt beim Start alle Programmdateien mit dem prefix 99_. Andere Programmdateien werden erst dann geladen, wenn sie durch eine define-Anweisung in der [[Konfiguration]] angefordert werden. So wird z.B. 10_FS20.pm erst geladen, wenn beim Einlesen der Konfiguration das erste define für ein FS20-device abgearbeitet wird. Da Ihre eigene Programmsammlung wahrscheinlich kein neues Gerät mit einem zugehörigen define-Befehl implementiert, würde sie also nie geladen, wenn ihr Name nicht mit 99_ beginnt.
# Damit die neue Datei bei 'Edit files' angezeigt wird, muss sie mit Utils.pm enden. Also zum Beispiel 99_meineUtils.pm
# Der Name der Programmdatei muss mit dem Namen der Initialize-Routine übereinstimmen. Wenn Sie Ihr Programm also 99_Werkzeugkasten.pm nennen, muss die im code dargestellte initialize-Routine sub Werkzeugkasten_Initialize heißen.
# Die Zeile <code> 1; </code> muss immer die letzte Programmzeile sein. Wenn Sie also eigene Routinen in Ihre Programmsammlung einfügen, tragen Sie diese zwischen dem Ende der Initialize-Routine und der abschließenden Zeile <code> 1; </code> ein.

== Eigene Routinen einfügen ==
Als Beispiel dient das Umsetzen von FS20 toggle-Events aus dem Artikel "[[FS20 Toggle Events auf On/Off umsetzen]]".
Das gesamte Programm sieht dann folgendermaßen aus:

<source lang="perl">
package main;
use strict;
use warnings;
use POSIX;
sub
myUtils_Initialize($$)
{
my ($hash) = @_;
}
##########################################################
# Untoggle
# toggle-Vorgänge in den Status on/off umsetzen
sub Untoggle($) {
my ($obj) = @_;

if( Value($obj) eq "toggle" ){
if( OldValue($obj) eq "off" ) {
fhem( "setstate $obj on" );
}
else {
fhem( "setstate $obj off" );
}
}
else {
fhem( "setstate $obj ".Value($obj) );
}
}
1;</source>
Der Aufruf erfolgt dann z.B. so:

<pre>#fhem.cfg
define lampe_untoggle notify lampe {Untoggle(„$NAME“)}</pre>
Der Aufruf aus einem notify (oder at) erfolgt als Perl-code, muss also in geschweiften Klammern stehen. Der Aufruf erfolgt durch Angabe des Namens der Routine (Untoggle) unter Angabe der zu übergebenden Parameter (hier "$NAME").
Im Programm wurde die Routine Untoggle mit '''einem''' Parameter definiert ( Untoggle($) , die Anzahl der $-Zeichen bestimmt die Anzahl der zu übergebenden Parameter). Der Wert des übergebenen Parameters wird in der ersten Programmzeile in die Variable $obj übernommen (my ($obj) = @_; ).
Der Aufruf erfolgt mit Untoggle(„$NAME“) . Der Platzhalter $NAME in fhem steht für den Namen des Geräts. Im o.g. Beispiel erfolgt der Aufruf also eigentlich mit Untoggle(„lampe“). Natürlich können beim Aufruf auch feste Werte ( „lampe1“ ) oder Variablen ( $hour ) übergeben werden.

=== Routinen mit mehreren Parametern ===
In der Definition der Routine geben Sie außerdem an, wieviele Parameter übergeben werden sollen, für 2 Parameter z.B. so:

<source lang="perl">define test at *09:00 { wakeup($we, „Schlafzimmerlampe“) }</source>
Die Deklaration der Routine in Ihrer Programmdatei muss dann so beginnen:

<source lang="perl">#Nur am Wochenende eingeschaltet
sub wakeup($$) {
my ($wochenende, $device) = @_;
if ($wochenende) {
fhem( "set $device on" );
}
else {
fhem( "set $device off" );
}
}</source>
Durch die Anzahl der $-Zeichen in der Routinen-Deklaration wird also die Anzahl der Parameter festgelegt. In der ersten Programmzeile Ihrer Routine übernehmen Sie dann die übergebenen Parameterwerte in lokale Variablen. Wie beim Routinen-Aufruf muss auch hierbei die Anzahl der Parameter mit der Routinen-Deklaration (also Anzahl der $-Zeichen) übereinstimmen.

=== Routinen ohne Parameter ===
Auch Routinen ohne Parameter sind natürlich möglich. Definition und Aufruf sehen dann folgendermassen aus:

<source lang="perl">sub parameterlos() {
...
}</source>
{ parameterlos() }

== Eigene Programmdatei laden ==
Die Programmdatei wird beim FHEM-Start immer automatisch geladen.

Bei Änderungen an der Programmdatei bei laufendem FHEM ist bezüglich Neuladen ohne FHEM-Neustart zwischen den verschiedenen Bearbeitungsvarianten der Progammdatei zu unterscheiden.

Bei der Bearbeitung über den '''Integrierten Editor''' wird die Programmdatei beim Abspeichern automatisch mit den Änderungen neu geladen.

Bei der nicht empfohlenen Bearbeitung der Programmdatei mit einem '''externen Editor''' muss FHEM manuell angewiesen werden, die Programmdatei mit den Änderungen zu laden. Also bearbeiten Sie Ihr Programm, speichern die Programmdatei, und weisen FHEM dann explizit an, die Programmdatei erneut zu laden. Der Befehl dazu, der in das Befehls-Eingabefeld eingegeben wird, lautet: <code>reload 99_myUtils.pm</code>

Treten beim Laden (Syntax)fehler auf, werden diese am Bildschirm wie auch im Log angezeigt. Da der Ladevorgang fehlgeschlagen ist, stehen Ihre eigenen Routinen nun nicht zur Verfügung (bzw. in der zuletzt erfolgreich geladenen Version).
== Eigene Programmdatei dokumentieren ==
In der lokalen Commandref kann man die eigenen Routinen auch dokumentieren.
Dazu muss am Ende der 99_myUtils folgender Codeblock eingefügt werden
<source lang="perl">
=pod
=begin html

<a name="myUtils"></a>
<h3>myUtils</h3>
<ul>
<b>Name</b>
<br>
Text<br>
Examples:
<ul>
<code>Example Code </code><br>
</ul>
</ul>

=end html
=begin html_DE

<a name="myUtils"></a>
<h3>myUtils</h3>

=end html_DE
=cut
</source>

Der a Tag stellt einen Verweis dar, der h3 Tag kennzeichnet die Überschrift. Beide Tags müssen sein, ansonsten kann FHEM die Doku nicht in die commandref einbinden. Der Abschnitt für die deutsche Doku kann komplett fehlen. Die Beschreibungen der einzelnen Routinen werden mit ul Tags geklammert und eventuell mit ul Tags weiter untergliedert. Dabei entsteht ein eingerückter Text. Beispiele können mit dem code Tag formatiert werden.

Mit diesem Befehl kann die Erzeugung des Commandrefeintrages initiiert und getestet werden:
<source lang="perl">{system("/usr/bin/perl ./contrib/commandref_join.pl")}</source>

== Links ==
* {{Link2Forum|Topic=34363|Message=266811|LinkText=Zeit- und Datumsvariablen $hour, $wday, $month, ... in 99_myUtils.pm verfügbar machen}}
* [https://waschto.eu/eigene-routinen-erstellen-und-auslagern/ How-To: Eigene Routinen erstellen und auslagern]

[[Kategorie:Code Snippets]]
[[Kategorie:HOWTOS]]

Icons

2017-09-06T08:17:00Z

Waschto: How-To hinzugefügt zum Erstellen eigener Icons

Icons - alles rund um die Icons in FHEM
= FHEM mit Icons verschönern =
== Geräten Icons zuweisen ==
Im [[FHEMWEB]] auf Detail-Ansicht des Gerätes gehen, danach in der attr Zeile per dropdown
# Icon auswählen, um das Icon zu wählen, das standardmäßig links vom Gerät gezeigt wird; alternativ ganz unten auf '''Select Icon''' klicken, dann bekommt ihr alle Bilder angezeigt
# '''[[devStateIcon]] auswählen''', um unterschiedliche Schaltzustände mit unterschiedlichen Icons zu versehen; alternativ ganz unten auf '''Extend devStateIcon''' klicken, dann bekommt ihr alle Bilder angezeigt und könnt sie dem jeweiligen Schaltzustand zuordnen.

Dabei gilt folgendes:
* Icon-Dateiname OHNE Dateiendung eingeben
* wenn es sich bei dem Icon um eine svg-Datei handelt, kann mit @farbe die Farbe beeinflusst werden, z.B. <br /> <code>attr Geraet devStateIcon an:general_an@green aus:general_aus@red</code>, <br /> wobei hier die beiden Dateien general_an.svg und general_aus.svg heißen.
* statt des Standardfarbnamens, kann übrigens auch der 6-stellige Hex-Code übergeben werden (ohne # am Anfang). Den Code könnt ihr z.B. hier bei [http://www.colorpicker.com Colorpicker] generieren
* Möchte man dass bei Klick auf das Icon auch eine Aktion ausgelöst wird, kann man dies als dritten Parameter mit angeben. Beispiel für einen Wechsel zwischen "around" und "away": <code>around:status_available:away away:status_away_2:around</code>.

Wenn ihr die Änderungen wie oben beschrieben durchführt, könnt ihr das Ergebnis gleich betrachten. Wenn alles passt, dann noch '''Save config''' drücken, dann wird alles fest abgespeichert.

== Größe der Icons verändern ==
Auch das kein Problem. Öffnet einfach die für Eurer Template (wie sieht fhem bei Euch aus: rechts unten -> Select Style -> das was ihr dort gewählt habt ist Euer Template) zuständige css-Datei. Diese findet ihr im fhem-Verzeichnis unter www/pgm2. Dort fügt ihr einfach folgende Zeile ein und ändert ggf. die Größenangaben.
<pre>svg { height:32px; width:32px; }</pre>

== Mehr Icons zur Auswahl ==
Grundsätzlich sind bei aktuellen fhem-Installationen die meisten Icons standardmäßig aktiviert. Navigiert doch einfach mal im fhem Verzeichnis in den www Ordner und dort in images. Die Ordner default, openautomation und fhemSVG sind standardmäßig aktiviert, d.h., Icons aus diesen Ordnern werden in fhem angezeigt. Wenn ihr zusätzlich die Icons auch aus den anderen Ordnern (z.B. icons_small) verwenden wollt, dann ergänzt einfach die entsprechende Zeile "WEB iconPath" in der fhem.cfg:
<pre>attr WEB iconPath fhemSVG:openautomation:default:icons_small</pre>

Das gleiche gilt, wenn ihr eine ältere fhem-Installation habt und noch nicht die Bilder z.B. aus fhemSVG angezeigt bekommt.

== Icons Farben zuweisen ==
Man kann Icons beliebige Farben zuweisen, indem man den Icon-Namen per "@" mit einem Farbnamen oder einer Farbcodierung versieht.
<pre>
rc_dot@red
rc_dot@#a1d490
</pre>
Hilfe zur Bestimmung der Farbcodierung kann man auf den folgenden Seiten finden:
* [http://www.colorpicker.com www.colorpicker.com]
* [http://www.html-color-names.com www.html-color-names.com]

== Weitere Tipps ==
Weitere Tipps zu Icons finden sich auch auf der Seite [[Slider für HM-Rolladensteuerung anzeigen]].

= Eigene Icons erstellen =
Falls ihr eigene Icons basteln wollt - sehr gerne. Umso besser, wenn ihr diese dann mit uns teilt. Der passende {{Link2Forum|Topic=12605|LinkText=Thread im Forum}}.

== SVG-Icons ==
Hier einige Tipps zum Erstellen von SVG-Icons. SVGs bieten einige Vorteile:
* SVGs sind vektorbasiert und somit frei skalierbar
* SVGs sind, wenn man sie genauer betrachtet, gut lesbarer und veränderbarer Quellcode und können deswegen leicht über css manipuliert werden

Wie geht es nun:
* [http://inkscape.org/download/?lang=de Inkscape] besorgen (Open Source)
* Loszeichnen

Jetzt wird es wichtig - fhem ist etwas sensibel, was svgs anbelangt und will diese zudem farblich umgestalten. Daher folgendes unbedingt beachten:

* fhem ersetzt bei allen fill:#000000 und fill="#000000" die sechs Nullen mit einem Farbcode, wenn dieser mit übergeben wurde (sh. FHEM mit Icons verschönern weiter oben) - das solltet ihr beim zeichnen beachten
* daher arbeite ich immer so, dass ich beispielsweise Rechtecke/Kreise zeichne und diese dann mit "Kontur in Pfad umwandeln" umwandle -> dann ist das Rechteck transparent, die Linie schwarz (und wird von fhem erstetzt) und alles klappt
* alle Texte müssen in Pfade umgewandelt werden
* das gesamte Bild muss als "Normales SVG" gespeichert werden (Standardeinstellung bei Inkscape ist "Inkscape SVG")
* Wenn die Grafik nicht angezeigt wird sondern nur Text: In einem Editor den Inhalt mit einer funktionierenden SVG-Datei vergleichen und anpassen.
* letzter wichtiger Tipp: Eine Zeile darf im SVG nicht fehlen, sonst zeigt fhem es nicht an. Wenn ihr Euer SVG in einem Texteditor öffnet (ich empfehle notepad++), schaut in in der <svg>-Definition, ob die Zeile mit viewBox dabei ist. Wenn nicht, dann nach unterem Format ergänzen.

<syntaxhighlight lang="XML">
<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<svg
version="1.0"
width="585"
height="585"
viewBox="0 0 585 585"
id="svg2421"
sodipodi:docname="usb-stick.svg">
</syntaxhighlight>

== SVG-Icons für das Modul remotecontrol: Schriftvorlage ==
Wer beispielsweise für das Modul remotecontrol noch andere Beschriftungen braucht, der kann sich diese ganz fix selbst machen. Im Ordner fhem\www\images\fhemSVG findet ihr die Datei rc_templatebutton.svg. Mit der macht ihr folgendes:
Ganz einfach inkscape runterladen (http://inkscape.org/download/?lang=de), Datei öffnen, auf Text klicken, dann oben in der Leiste auf Text -> Schrift und Text -> Reiter Text, Text ändern. Ggf. Größe/Position anpassen, dann Pfad -> Objekt in Pfad umwandeln, dann Datei -> Speichern unter -> euer name und "Normales SVG" => FERTIG

= Links =
* [https://waschto.eu/aufwerten-von-fhem-devices-durch-icons/ How-To: FHEM-Devices mit Icons aufwerten]
* [https://waschto.eu/eigene-icons-fuer-fhem-erstellen/ How-To: Eigene Icons erstellen und in FHEM einbinden]

[[Kategorie:HOWTOS]]

Icons

2017-09-06T08:15:37Z

Waschto: Link zu einem How-To hinzugefügt

FRITZBOX

2017-08-26T18:39:35Z

Waschto: Link zum How-To: Traffic als Balkendiagramm

{{Infobox Modul
|ModPurpose=Steuerung einer Fritz!Box über FHEM
|ModType=d
|ModForumArea=FRITZ!Box
|ModTechName=72_FRITZBOX.pm
|ModOwner=tupol/Topos ({{Link2FU|5432|Forum}} / [[Benutzer Diskussion:Topos|Wiki]])}}

Das Modul [[FRITZBOX]] ermöglicht die Steuerung einer [[AVM Fritz!Box]] und von AVM FRITZ!WLAN Repeatern durch FHEM . An Fritzboxen können sowohl Geräte abgefragt werden, auf denen FHEM selbst läuft (lokaler Modus), als auch entfernte (externe) Geräte.

== Voraussetzungen ==
=== Remote-Zugang ===
Für den Remote-Zugang müssen die Module JSON:XS, LWP und SOAP::Lite installiert sein; auf einem [[Raspberry Pi]] oder unter Ubuntu z. B. mit dem Befehl
:<code>sudo apt-get install libjson-perl libwww-perl libsoap-lite-perl libjson-xs-perl</code>

Teilweise ist derzeit zusätzlich die Installation der telnet Libraries erforderlich, auch wenn der Telnet-Zugang nicht genutzt werden soll. Siehe dazu den nachfolgenden Abschnitt.

=== Telnet ===
Das Modul basierte ursprünglich auf dem Zugriff auf die Fritzbox per Telnet. Ab FRITZ!OS 6.2x baut AVM den abgekündigten Telnet-Zugang sowie die webcm-Schnittstelle sukzessive zurück bzw. hat dies, je nach Firmware, schon ganz abgestellt (siehe {{Link2Forum|Topic=38586|LinkText=dieses Forenthema}}). Der zukunftssichere Zugriff auf die Fritzbox sollte also per TR-064 erfolgen. Der Vollständigkeit halber und für ältere Firmwareversionen:

# Wer den Zugang per Telnet (noch) nutzen (kann und) möchte, muss dies zuerst freischalten. Üblicherweise durch Eingabe von #96*7* an einem direkt an der entsprechenden FritzBox angeschlosssenen Telefon
# Auf dem System, auf dem FHEM läuft ([[Systemübersicht#Server|Server]]) muss Telnet installiert sein; auf einem [[Raspberry Pi]] und unter Ubuntu z. B. mit dem Befehl
::<code>sudo apt-get install libnet-telnet-perl</code>

== Installation ==
=== Erste Schritte ===
Zur Erstinstallation reicht ein einfaches <code>define FritzBox FRITZBOX</code>, dieses Modul funktioniert lokal (FHEM auf Fritzbox) sowie per Fernzugriff (FHEM auf einem anderen Server im Netz, siehe nächsten Schritt).

==== TR-064: Modul FRITZBOX für Zugriff auf einem externen Server einrichten ====
Für den Fernzugriff über TR-064 auf eine oder mehrere Fritzboxen und/oder einen FRITZ!WLAN Repeater sind die folgenden Schritte nötig (für jedes Gerät):

Fritzbox definieren:
:<code>define FritzBox FRITZBOX</code>

Wenn die Fritzbox nicht unter <nowiki>http://fritz.box</nowiki> erreichbar ist, IP im define setzen:
:<code>define FritzBox FRITZBOX 192.168.168.168</code>
192.168.168.168 dabei natürlich durch die passende IP ersetzen... Alternativ kann statt der IP auch der Hostname eingegeben werden.

Wenn ('''und nur wenn''') das Login auf der Benutzeroberfläche der FritzBox mit User und Passwort (und nicht nur per Passwort) geschieht, den User konfigurieren:
:<code>attr FritzBox boxUser ''Benutzername'' </code>
In der Fritzbox muss dann auch "Anmeldung mit FRITZ!Box-Benutzernamen und Kennwort" ausgewählt sein.

Passwort konfigurieren:
:<code>set FritzBox password ''Passwort''</code> - legt das zugehörige Passwort fest (nur einmal --> gehört nicht in die cfg-Datei)

Manuelle TR-064 Kommandos erlauben (Das Auslesen der Readings per TR-064 funktioniert auch ohne dieses Attribut.):
:<code>attr FritzBox allowTR064Command 1</code>

==== Telnet: Modul FRITZBOX für Zugriff auf einem externen Server einrichten ====
[[Datei:Screenshot_FritzBox_TelnetUser.png|mini|300px|rechts|Anlegen des Attributs telnetUser]]
Bei Fernzugriff über Telnet sind weitere Schritte nötig:
# Telnet auf der Fritzbox freischalten (Tastenkombination #96*7* am angeschlossenen Telefon (auch FritzFon)
# TelnetUser definieren (wie im Screenshot gezeigt)
# Passwort zum Benutzer auf der Fritzbox definieren

[[Datei:Screenshot_FritzBox_Passwort.png|mini|300px|rechts|Passwort definieren]]

(bitte die Buttons {{Taste|set}} und {{Taste|attr}} bei der Definition der jeweiligen Einträge nicht vergessen)

Wer stattdessen lieber das [[Konfiguration|Befehl-Eingabefeld]] verwendet:

:<code>define FritzBox FRITZBOX</code>
:<code>attr FritzBox telnetUser ''Benutzername'' </code> - legt den Benutzer fest
:<code>set FritzBox password ''Passwort'' </code> - legt das zugehörige Passwort fest

Wer keinen User konfiguriert hat, kann das Feld "telnetUser" leer lassen.

Wer sicher gehen möchte, dass auch tatsächlich Telnet und nicht andere Zugriffe benutzt werden, sollte außerdem noch setzen:

:<code>attr FritzBox forceTelnetConnection 1</code>

=== mögliche Fehlermeldungen ===
Sollte schon bei <code>define FritzBox FRITZBOX</code> die Fehlermeldung kommen, dass dieses Modul nicht existiert, dann bitte prüfen, ob FHEM auf dem aktuellen Stand ist und ggf. [[Update|aktualisieren]].

Kommt jetzt bei der erneuten Definition die Fehlermeldung <code>Error: Perl modul Net::Telnet is missing on this system</code> bitte wie oben schon erwähnt den Befehl
:<code>sudo apt-get install libnet-telnet-perl</code>
direkt per Telnet/SSH auf dem FHEM-Server ausführen und neu starten.
Sollte alles geklappt haben, seht ihr nun eure Fritzbox und könnt diverse Einstellungen manuell vornehmen und/oder automatisch vornehmen lassen.

== Anwendung ==
=== Define ===
Siehe [http://fhem.de/commandref_DE.html#FRITZBOX commandref]

=== Attribute ===
Siehe commandref

=== TR-064 ===
Die offizielle Programmier-Schnittstelle der Fritz!Box läuft über das Protokoll TR-064.

mit dem Attribute<br/>
<code>attr <device> allowTR064Command 1</code><br/>
kann man den Befehl<br/>
<code>get <device> tr064Command <service> <control> <action> [[parameterName1 parameterValue1] ...]</code><br/>
freischalten und damit auf diese Schnittstelle zugreifen.

AVM hat die Schnittstellenbeschreibung unter [http://avm.de/service/schnittstellen/] veröffentlicht. Diese wird jedoch nur sehr sporadisch gepflegt.<br>
Ein besserer Einstiegspunkt befindet sich auf der Box unter http://fritz.box:49000/tr64desc.xml.<br>
Die möglichen TR-064-Aktionen kann man auch über den Befehl <code>get <device> tr064ServiceList</code> auslesen.

Folgende Service und Controls existieren (für den get-Befehl ''tr064Command'' werden nur die fett formatierten Wörter benötigt)

{| class="wikitable"
|-
!serviceType!!controlURL!!XML!!Dokument bei AVM
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''DeviceInfo:1'''||/upnp/control/'''deviceinfo'''||[http://fritz.box:49000/deviceinfoSCPD.xml deviceinfoSCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/deviceinfoSCPD.pdf deviceinfoSCPD.pdf]
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''DeviceConfig:1'''||/upnp/control/'''deviceconfig'''||[http://fritz.box:49000/deviceconfigSCPD.xml deviceconfigSCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/deviceconfigSCPD.pdf deviceconfigSCPD.pdf]
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''Layer3Forwarding:1'''||/upnp/control/'''layer3forwarding'''||[http://fritz.box:49000//layer3forwardingSCPD.xml layer3forwardingSCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/layer3forwardingSCPD.pdf layer3forwardingSCPD.pdf]
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''LANConfigSecurity:1'''||/upnp/control/'''lanconfigsecurity'''||[http://fritz.box:49000//lanconfigsecuritySCPD.xml lanconfigsecuritySCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/lanconfigsecuritySCPD.pdf lanconfigsecuritySCPD.pdf]
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''ManagementServer:1'''||/upnp/control/'''mgmsrv'''||[http://fritz.box:49000//mgmsrvSCPD.xml mgmsrvSCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/mgmsrvSCPD.pdf mgmsrvSCPD.pdf]
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''Time:1'''||/upnp/control/'''time'''||[http://fritz.box:49000//timeSCPD.xml timeSCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/timeSCPD.pdf timeSCPD.pdf]
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''UserInterface:1'''||/upnp/control/'''userif'''||[http://fritz.box:49000//userifSCPD.xml userifSCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/userifSCPD.pdf userifSCPD.pdf]
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''X_VoIP:1'''||/upnp/control/'''x_voip'''||[http://fritz.box:49000//x_voipSCPD.xml x_voipSCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/x_voipSCPD.pdf x_voipSCPD.pdf]
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''X_AVM-DE_Storage:1'''||/upnp/control/'''x_storage'''||[http://fritz.box:49000//x_storageSCPD.xml x_storageSCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/x_storageSCPD.pdf x_storageSCPD.pdf]
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''X_AVM-DE_OnTel:1'''||/upnp/control/'''x_contact'''||[http://fritz.box:49000//x_contactSCPD.xml x_contactSCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/x_contactSCPD.pdf x_contactSCPD.pdf]
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''X_AVM-DE_WebDAVClient:1'''||/upnp/control/'''x_webdav'''||[http://fritz.box:49000//x_webdavSCPD.xml x_webdavSCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/x_webdavSCPD.pdf x_webdavSCPD.pdf]
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''X_AVM-DE_UPnP:1'''||/upnp/control/'''x_upnp'''||[http://fritz.box:49000//x_upnpSCPD.xml x_upnpSCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/x_upnp.pdf x_upnp.pdf]
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''X_AVM-DE_RemoteAccess:1'''||/upnp/control/'''x_remote'''||[http://fritz.box:49000/x_remoteSCPD.xml x_remoteSCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/x_remoteSCPD.pdf x_remoteSCPD.pdf]
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''X_AVM-DE_MyFritz:1'''||/upnp/control/'''x_myfritz'''||[http://fritz.box:49000/x_myfritzSCPD.xml x_myfritzSCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/x_myfritzSCPD.pdf x_myfritzSCPD.pdf]
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''X_AVM-DE_TAM:1'''||/upnp/control/'''x_tam'''||[http://fritz.box:49000/x_tamSCPD.xml x_tamSCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/x_tam.pdf x_tam.pdf]
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''X_AVM-DE_AppSetup:1'''||/upnp/control/'''x_appsetup'''||[http://fritz.box:49000/x_homeautoSCPD.xml x_homeautoSCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/x_appsetupSCPD.pdf x_appsetupSCPD.pdf]
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''X_AVM-DE_Homeauto:1'''||/upnp/control/'''x_homeauto'''||[http://fritz.box:49000/x_homeautoSCPD.xml x_homeautoSCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/x_homeautoSCPD.pdf x_homeautoSCPD.pdf]
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''WLANConfiguration:1'''||/upnp/control/'''wlanconfig1'''||[http://fritz.box:49000/wlanconfigSCPD.xml wlanconfigSCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/wlanconfigSCPD.pdf wlanconfigSCPD.pdf]
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''WLANConfiguration:2'''||/upnp/control/'''wlanconfig2'''||[http://fritz.box:49000/wlanconfigSCPD.xml wlanconfigSCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/wlanconfigSCPD.pdf wlanconfigSCPD.pdf]
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''WLANConfiguration:3'''||/upnp/control/'''wlanconfig3'''||[http://fritz.box:49000/wlanconfigSCPD.xml wlanconfigSCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/wlanconfigSCPD.pdf wlanconfigSCPD.pdf]
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''Hosts:1'''||/upnp/control/'''hosts'''||[http://fritz.box:49000/hostsSCPD.xml hostsSCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/hostsSCPD.pdf hostsSCPD.pdf]
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''LANEthernetInterfaceConfig:1'''||/upnp/control/'''lanethernetifcfg'''||[http://fritz.box:49000/lanifconfigSCPD.xml lanifconfigSCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/lanifconfigSCPD.pdf lanifconfigSCPD.pdf]
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''LANHostConfigManagement:1'''||/upnp/control/'''lanhostconfigmgm'''||[http://fritz.box:49000/lanhostconfigmgmSCPD.xml lanhostconfigmgmSCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/lanhostconfigmgmSCPD.pdf lanhostconfigmgmSCPD.pdf]
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''WANCommonInterfaceConfig:1'''||/upnp/control/'''wancommonifconfig1'''||[http://fritz.box:49000/wancommonifconfigSCPD.xml wancommonifconfigSCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/wancommonifconfigSCPD.pdf wancommonifconfigSCPD.pdf]
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''WANDSLInterfaceConfig:1'''||/upnp/control/'''wandslifconfig1'''||[http://fritz.box:49000/wandslifconfigSCPD.xml wandslifconfigSCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/wandslifconfigSCPD.pdf wandslifconfigSCPD.pdf]
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''WANDSLLinkConfig:1'''||/upnp/control/'''wandsllinkconfig1'''||[http://fritz.box:49000/wandsllinkconfigSCPD.xml wandsllinkconfigSCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/wandsllinkconfigSCPD.pdf wandsllinkconfigSCPD.pdf]
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''WANEthernetLinkConfig:1'''||/upnp/control/'''wanethlinkconfig1'''||[http://fritz.box:49000/wanethlinkconfigSCPD.xml wanethlinkconfigSCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/wanethlinkconfigSCPD.pdf wanethlinkconfigSCPD.pdf]
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''WANPPPConnection:1'''||/upnp/control/'''wanpppconn1'''||[http://fritz.box:49000/wanpppconnSCPD.xml wanpppconnSCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/wanpppconnSCPD.pdf wanpppconnSCPD.pdf]
|-
|<nowiki>urn:dslforum-org:service:</nowiki>'''WANIPConnection:1'''||/upnp/control/'''wanipconnection1'''||[http://fritz.box:49000/wanipconnSCPD.xml wanipconnSCPD.xml]||[http://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/wanipconnSCPD.pdf wanipconnSCPD.pdf]
|-
|}

=== Status-Symbol ===
<code>attr <device> devStateIcon .*on.*off:WLAN_on_gWLAN_off .*on.*on.*:WLAN_on_gWLAN_on WLAN..off.*:WLAN_off</code>

Im Verzeichnis www/images/default müssen die passenden Dateien "WLAN_on_gWLAN_off.png", "WLAN_on_gWLAN_on.png" und "WLAN_off.png" liegen. Wenn die PNGs fehlen, können sie {{Link2Forum|Topic=29725|Message=318113|LinkText=hier}} heruntergeladen werden.

== Anwendungsbeispiele ==
[[Datei:Screenshot_FritzBox1.png|mini|300px|rechts|FRITZBOX Gerät auf der FHEM Oberfläche]]
Sollte alles geklappt haben, seht ihr nun unter "Unsortiert" den im nebenstehenden Screenshot gezeigten Eintrag für das "Gerät" (hier mit dem Icon "it_router").

=== TR-064 Beispiele ===
*Box Reboot: <code>get <device> tr064Command DeviceConfig:1 deviceconfig Reboot</code>
*Internet Reconnect: <code>get <device> tr064Command WANIPConnection:1 wanipconnection1 ForceTermination</code>
*Daten eines Smart-Home-Gerätes auslesen: <code>get <device> tr064Command X_AVM-DE_Homeauto:1 x_homeauto GetGenericDeviceInfos NewIndex 0</code>

=== Klingel- und Sprachausgabe per TR-064 ===
Das geht derzeit nicht, da entsprechende Kommandos per TR-064 nicht verfügbar sind. Da Telnet sukzessive abgestellt wird, sollten sich Interessenten per Feature-Request an AVM wenden, wie {{Link2Forum|Topic=38586|LinkText=hier}} beschrieben.

Eine Alternative um Telefone klingeln zu lassen, ist die Nutzung des [[SIP-Client]]s.

=== Anwesenheitserkennung per regelmäßiger Abfrage über das PRESENCE Modul ===
Fritzboxen und die FRITZ!WLAN Repeater speichern den Status angemeldeter Geräte. Dieser Status lässt sich mittels des FRITZBOX Moduls über Readings abfragen, die das Format mac_AA_AA_AA_AA_AA_AA haben und die MAC-Adressen der jeweils angemeldeten Geräte (AA:AA:AA:AA:AA:AA) enthalten. Das Reading existiert, wenn das Gerät angemeldet ist. Wenn das Gerät abgemeldet ist, existiert es nicht mehr. Es gibt auch noch den Zwischenstatus "inactive", der anscheinend gesetzt wird, bevor das Reading gelöscht wird.

Mit Hilfe des [[PRESENCE]] Moduls (vgl. [[Anwesenheitserkennung]]) kann man auf diese Weise den Anwesenheitsstatus abfragen. Anregungen dazu gibt es im zugehörigen {{Link2Forum|Topic=39433|LinkText=Forenthread}} zur Anwesenheitserkennung und in [http://heinz-otto.blogspot.de/2015/07/die-zeiten-andern-sich.html diesem Blogpost]. Auf dieser Basis könnte eine einfache Implementierung zum Beispiel so aussehen:

Funktion in [[99_myUtils anlegen|99_myUtils]]:

<syntaxhighlight lang='perl'>sub checkFritzMACpresent($$) {
# Benötigt: Name der zu testenden Fritzbox ($Device),
# zu suchende MAC ($MAC),
# Rückgabe: 1 = Gerät gefunden
# 0 = Gerät nicht gefunden
my ($Device, $MAC) = @_;
my $Status = 0;
$MAC =~ tr/:/_/;
$MAC = "mac_".uc($MAC);
my $StatusFritz = ReadingsVal($Device, $MAC, "weg");
if ($StatusFritz eq "weg") {
Log 1, ("checkFritzMACpresent ($Device): $MAC nicht gefunden, abwesend.");
$Status = 0;
} elsif ($StatusFritz eq "inactive") {
Log 1, ("checkFritzMACpresent ($Device): $MAC ist >inactive<, also abwesend.");
$Status = 0;
} else {
# Reading existiert, Rückgabewert ist nicht "inactive", also ist das Gerät per WLAN angemeldet.
Log 1, ("checkFritzMACpresent ($Device): $MAC gefunden, Gerät heißt >$StatusFritz<.");
$Status = 1;
}
return $Status
}
</syntaxhighlight>

Nutzung dieser Funktion mit dem PRESENCE Modul definieren:
:<code>define <Name> PRESENCE function {checkFritzMACpresent("Fritzbox","AA:BB:CC:DD:EE:FF")} 60 60</code>
wobei
*<Name> ein beliebig zu wählender Name für die PRESENCE-Funktion ist,
*Fritzbox der Name ist, mit dem ihr die abzufragende Fritzbox als FRITZBOX definiert habt,
*AA:BB:CC:DD:EE:FF die MAC-Adresse des gesuchten Geräts ist.
* "60 60" sagt, dass der Anwesenheitsstatus im 60-Sekunden-Takt abgefragt wird. Das macht natürlich nur Sinn, wenn ihr mit <code>attr Fritzbox INTERVAL 60</code> den Abfrageinterval bei der Fritzbox auch entsprechend hochgesetzt habt. Der Standard ist 300.
* "Log 1" führt immer zum Loggen. Das ist zum Einrichten praktisch, ohne dass man gleich für das ganze Modul oder ganz FHEM <code>attr <device> verbose 5</code> setzen muss. Wenn es läuft, können die "Log 1"-Zeilen gelöscht, auskommentiert (# an den Zeilenanfang) oder in "Log 5" geändert werden.

=== Anwesenheitserkennung über mehrere Fritzboxen oder AVM Repeater und Fritzbox ===
Existiert ein AVM Repeater im Netzwerk, kann der als eigenständiges Gerät mit FRITZBOX definiert werden. WLAN Geräte an der Fritzbox werden in der Instanz der Fritzbox gelistet und WLAN Geräte am Repeater in der Repeater Instanz. Um trotzdem die Anwesenheit im Netzwerk einfach zu erkennen, muss die Subroutine in 99_myUtils.pm abgewandelt werden.

Existiert eine zweite Fritzbox im Accesspointmodus, werden die WLAN Geräte im Netzwerk alle in der Hauptfritzbox an einem LAN Anschluss gelistet. D.h. man sieht an der Hauptfritzbox nicht, dass sie im WLAN sind. Eine zweite Instanz mit dem FRITZBOX Modul muss wegen der Anwesenheitserkennung nicht gemacht werden. Die folgende Routine kann aber universell eingesetzt werden, unabhängig von der Anzahl der FRITZBOX Instanzen. Wer mitloggen will, kann das analog zur obigen Routine einbauen

<syntaxhighlight lang='perl'>sub checkAllFritzMACpresent($) {
# Benötigt: nur die zu suchende MAC ($MAC),
# Es werden alle Instanzen vom Type FRITZBOX abgefragt
#
# Rückgabe: 1 = Gerät gefunden
# 0 = Gerät nicht gefunden
my ($MAC) = @_;
# Wird in keiner Instanz die MAC Adresse gefunden bleibt der Status 0
my $Status = 0;
$MAC =~ tr/:/_/;
$MAC = "mac_".uc($MAC);
my @FBS = devspec2array("TYPE=FRITZBOX");
foreach( @FBS ) {
my $StatusFritz = ReadingsVal($_, $MAC, "weg");
if ($StatusFritz eq "weg") {
} elsif ($StatusFritz eq "inactive") {
} else {
# Reading existiert, Rückgabewert ist nicht "inactive", also ist das Gerät am Netzwerk angemeldet.
$Status = 1;
}
}
return $Status
}
</syntaxhighlight>

Da hiermit nach allen Instanzen mit dem TYPE=FRITZBOX durchsucht wird, braucht der Name der Fritzbox nicht angegeben werden.

:<code>define <Name> PRESENCE function {checkAllFritzMACpresent("AA:BB:CC:DD:EE:FF")} 60 60</code>

Die Abfrage auf einen bestimmten Status kann einfach erweitert werden, ist aber immer vom Entwicklunsgstand der Fritzbox Firmware und des FRITZBOX Moduls abhängig. Eventuell erreicht man bessere Reaktionszeiten auf Abwesenheit durch diesen Zusatz:
<syntaxhighlight lang='perl'>my $StatusFritz = ReadingsVal($_, $MAC, "weg");
if ($StatusFritz eq "weg") {
} elsif ($StatusFritz eq "inactive") {
} elsif ($StatusFritz =~ /(.*)s, 0/) {
# Dieser Zweig testet auf "<geraetename> (WLAN, 0 / 0 Mbit/s, 0)"
} else {
$Status = 1;
}
</syntaxhighlight>

Weitere Hinweise zu komplexeren Abfragen mehrere Boxen auf einmal etc. findet ihr auch im diesem {{Link2Forum|Topic=39433|LinkText=Forenthread}}.

=== Anwesenheitserkennung per Notify ===
Der von Fritzboxen und Fritz!WLAN Repeatern gespeicherte Status zum Status angemeldeter Geräte lässt sich (statt per PRESENCE, s.o.) auch per [[notify]] anfragen:

<syntaxhighlight lang="perl">define <Name> notify Fritzbox:mac_AA_BB_CC_DD_EE_FF:.* {
if (ReadingsVal("Fritzbox", "mac_AA_BB_CC_DD_EE_FF", "inactive") eq "inactive")
{
fhem("set anwesend_smartphone absent");
}
else
{
fhem("set anwesend_smartphone present");
}
}</syntaxhighlight>

Hinweise:
* <code>fhem("set anwesend_smartphone absent");</code> ist nur ein Beispiel, das einen Dummy auf den Status "absent" bzw. "present" setzt. Man kann hier natürlich auch gleich entsprechende Aktionen durchführen. Wer das Beispiel übernehmen möchte, sollte den Dummy vorher definieren (<code>define anwesend_smartphone dummy</code>).
* mac_AA_BB_CC_DD_EE_FF ist die MAC-Adresse des gesuchten Geräts.
* "Fritzbox" ist der Name, unter dem die Fritzbox als FRITZBOX-Modul definiert wurde.
* Das Notify funktioniert, weil Geräte, wenn sie sich abgemeldet haben, erst den Status "inactive" erhalten. Ist das Gerät ganz abgemeldet, verschwindet das mac_.*-Reading. Dabei löst das Notify nicht mehr aus. Da das mac-.*-Reading aber vorher auf "inactive" stand, wurde die Abwesend-Aktion schon ausgeführt.
* Damit der Notify nicht andauernd losgeht, sollte man mittels <code>attr Fritzbox [[event-on-change-reading]] mac_AA_BB_CC_DD_EE_FF</code> Events nur auslösen, wenn sich der Status des Gerätes ändert. Will man mehrere Geräte abfragen, sollte man <code>attr Fritzbox event-on-change-reading mac_AA_BB_CC_DD_EE_FF,mac_GG_HH_II_JJ_KK_LL</code> setzen, damit bei der Änderung jedes Readings ein Event ausgelöst wird.

=== Vergleich Anwesenheitserkennung PRESENCE/Notify ===
Die Anwesenheitserkennung per regelmäßiger PRESENCE-Abfrage hat den Vorteil, dass sie im Turnus der regelmäßigen Abfragen immer einen aktuellen Status produziert. Sie hat dafür den Nachteil, dass die PRESENCE-Funktionen regelmäßig abgearbeitet werden müssen, auch wenn sich gar nichts ändert. Außerdem aktualisiert sich der Status nicht sofort, sondern erst bei der nächsten regelmäßigen Abfrage. Durch häufiges Abfragen kann dieser Nachteil verringert werden (bei entsprechend höherer Systemlast).

Die Anwesenheitserkennung per Notify hat den Vorteil, dass ein sich ändernder Status sofort abgebildet wird. Ändert sich kein Status, werden keine Routinen ausgeführt, was die Systemlast gering hält. Der Nachteil ist, dass - z.B. nach einem Systemstart - die entsprechende Aktion erst bei einer Änderung des Status ausgeführt wird. D.h. ist das zu testende Gerät anwesend, wird dann FHEM beendet, das Gerät entfernt und FHEM wieder gestartet, ist der Status in FHEM immer noch "anwesend". Da das Reading für das Gerät nicht existiert, wird darauf auch erst wieder ein Notify ausgeführt, wenn sich der Status des Geräts wieder ändert, d.h. es wieder ankommt. Bis dahin ist der Status im System falsch.
Der Nachteil des Notify kann verringert werden, wenn man statt <code>attr Fritzbox event-on-change-reading mac_AA_BB_CC_DD_EE_FF</code> ein <code>attr Fritzbox [[event-on-update-reading]] mac_AA_BB_CC_DD_EE_FF</code> setzt. Das erhöht allerdings die Systemlast und funktioniert auch nur für den Status "anwesend". Bei "abwesend" ist kein Reading vorhanden, so dass auch event-on-update-reading nicht ausgeführt wird.
Eine weitere Möglichkeit, den Nachteil der Notify-Methode auszugleichen, ist, die Statusabfrage beim Systemstart einmal manuell auszuführen, durch ein notify auf "GLOBAL:initialized":
<syntaxhighlight lang="perl">
global:INITIALIZED {
Reset_Variables;
if (ReadingsVal("Fritzbox", "mac_AA_BB_CC_DD_EE_FF", "inactive") eq "inactive") {
fhem("set anwesend_smartphone absent");
} else {
fhem("set anwesend_smartphone present");
}
}
</syntaxhighlight>
Das hilft allerdings nur beim Systemstart. Nicht, wenn FHEM aufgrund irgendwelcher Hänger eine Aktualisierung des Status verpasst hat.

=== userReadings per get tr064Command ===
Um dem Gerätewert <userReadingName> den Wert von <VariabelName> aus der Rückgabe des get-Befehls ''tr064Command'' zuzuordnen
<pre>
attr <device> userReadings <userReadingName> {my $resp=fhem("get <device> tr064Command <service> <control> <action> [[<argName1> <argValue1>] ...]",1);;$resp =~/\'<VariabelName>\' => '(.*)'/;;return $1;;}
</pre>
Beispielsweise
<pre>attr Fritzbox userReadings urMobilteil_1 {my $resp=fhem("get Fritzbox tr064Command X_AVM-DE_OnTel:1 x_contact GetDECTHandsetInfo NewDectID 1",1);;$resp =~/'NewHandsetName' => '(.*)'/;;return $1;;},
urDownstreamDSLRate {my $resp=fhem("get Fritzbox tr064Command WANDSLInterfaceConfig:1 wandslifconfig1 GetInfo",1);;$resp =~/'NewDownstreamCurrRate' => '(.*)'/;;return $1;;},
urUpstreamDSLRate {my $resp=fhem("get Fritzbox tr064Command WANDSLInterfaceConfig:1 wandslifconfig1 GetInfo",1);;$resp =~/'NewUpstreamCurrRate' => '(.*)'/;;return $1;;}</pre>

=== Klingelton-Einstellung und Abspielen von Sprachnachrichten bei Fritz!OS-Versionen >6.24 ===
Wenn die Fritzbox weder die Telnet- noch die webcmd-Schnittstelle hat, kann der Klingelton der Fritz!Fons nicht mehr verstellt und auch keine Sprachnachricht über ein Fritz!Fon ausgegeben werden.

Es gibt eine Behelfslösung über das Attribut ''useGuiHack''. Dadurch wird eine Eingabe in die WebGUI der Fritzbox simuliert.

'''ACHTUNG''': Vor allem nach einem Update der FritzBox kann es durch dieses Attribut zu ungewolltem Verstellen von Werten in der Fritzbox kommen.

Bei Verwendung der ring-Parameter "play:" und "say:" wird die abzuspielende URL in die M3U-Datei, die unter dem Internal ''M3U_LOCAL'' steht, eingetragen.<br>
Standardmäßig wird versucht, diese Datei im image-Verzeichnis von FHEM abzulegen. Diese kann dann vom Fritz!Fon über [[FHEMWEB]] abgespielt werden (IP-Freigaben beachten). Direkt nach dem ersten Anlegen der m3u-Datei kennt [[FHEMWEB]] diese noch nicht, daher bitte entweder ''set <webdevice> rereadicons'' ausführen oder FHEM neu starten.<br>

Aufgrund der Beschränkungen von [[FHEMWEB]] oder auch bei Authentifizierungsanforderungen ist es empfehlenswert, die Datei über das Attribute ''m3uFileLocal'' selber vorzugeben. Am besten auf einem Webserver, der auf dem FHEM-Server läuft und dessen Seiten-Verzeichnis durch FHEM beschreibbar ist.<br>
Beispiel: <code>attr Fritzbox m3uFileLocal /var/www/mp3/Fritzbox.m3u</code>

In dem Radioeintrag ''FHEM'' muss dann '''auf der FritzBox''', die '''Web'''-Adresse der entsprechenden Datei eingetragen werden. Dieser Sender sollte zu Testzwecken dann auch einmal am Fritz!Fon von Hand gestartet werden.<br>
Das Modul versucht, beim Start die einzutragende Radio-URL im image-Verzeichnis selber zu ermitteln (IP-Freigabe beachten). Gelingt dies, so steht diese im Internal ''M3U_URL''.

=== Ring auf mehreren Telefonen gleichzeitig ===

Damit mehrere Telefone per ring gleichzeitig Klingel, muss in der Fritzbox eine Rufgruppe definiert werden.
Sollte eine Türsprechanlage schon in Benutzung sein, kann die eventuell hierfür bereits eingerichtete Gruppe verwendet werden.
Das anlegen der Gruppe erfolgt wie in folgender AVM Anleitung erledigt werden. [http://http://avm.de/service/fritzbox/fritzbox-7390/wissensdatenbank/publication/show/1148_Interne-Rufgruppe-in-FRITZ-Box-einrichten-Gruppenruf/ AVM Interne Rufgruppe anlegen]

Es muss eine Kurzwahl bei der Gruppe zwingend hinterlegt sein.
Danach kann mit folgendem Beispiel Code gearbeitet werden:

<code>set FritzBox ring 791 15 show:Türklingel</code>

Name des Devices, Rufgruppen Nummer, Länge und gezeigter Text auf das gewünschte anpassen.

== Bekannte Probleme / Fehlersuche ==
=== Fehler nach Firmware Update===
Nach einem Firmwareupdate der Fritzbox am besten auch FHEM neu starten.

=== Modul bleibt im Status "Check APIs" hängen===
Im Log steht die Meldung: "Error: Timeout when reading Fritz!Box data.".

Mögliche Ursache: Nutzung des FHEM-Befehls [[FHEM_Command_Beispiele#rereadcfg|rereadcfg]]. Dieser verträgt sich nicht mit dem Modul "blocking.pm", das für parallel laufende FHEM-Prozesse genutzt wird.

Abhilfe schafft ein Neustart <code>shutdown restart</code> oder das Einfügen eines zusätzlichen, lokalen Telnet-Ports z.B. durch <code>define tPortLocal telnet 7073</code>

=== Nachtschaltung Doppel-WLAN ===
Beim Abschalten des WLAN über das Modul wird (über TR064) zuerst das 2.4 GHz und dann das 5 GHz WLAN ausgeschaltet. Bei der gleichzeitigen Nutzung der WLAN-Nachtschaltung (Anschalten über das Fritz!OS) wird dann jedoch nur noch das 5 GHz WLAN wieder angeschaltet. Die Box interpretiert den TR064-Befehl anscheinend als ein komplettes Abwählen des 2.4 GHz WLAN.

Abhilfe schafft hier nur ein notify auf das 5 GHz WLAN mit einem nachträglichem Anschalten des 2.4 GHz WLAN.

Alternativ kann das Ausschalten des WLANs nicht direkt über TR064-Kommandos, sondern über einen indirekten Weg erfolgen: über TR064 ein set call abzusetzen und hier den Tastencode zum Ausschalten des WLANs einzugeben, bei einer FritzBox 7490 wäre dies z. B. #96*0*.
Schaltet man über diese Methode das WLAN aus, kann es über die Nachtschaltung wieder automatisch auf beiden Frequenzen angeschaltet werden.

=== Kabelboxen ===
Bei Fritz!Boxen für den Kabelanschluss (z.B. Kabel Deutschland) scheint neben Telnet auch die TR064-API nicht zu funktionieren. Vermutlich wurde die API von AVM auf Betreiberwunsch deaktiviert, da man sonst Dinge ändern kann, die das gesamte Kabelnetz stören können.

Zumindest für Unitymedia und einer FRITZ!Box 6490 Cable (lgi) mit FRITZ!OS:06.50 funktioniert TR064.

Eine Rufumleitung bei Abwesenheit (Modul PRESENCE) funktioniert mit einer vorher eingerichten Telefonnummer wie folgt:
<code>define Rufumleitung DOIF ([Anwesenheit.dum:state] eq "off") (set FritzBox6490 diversity 1 on) DOELSEIF ([Anwesenheit.dum:state] eq "on") (set FritzBox6490 diversity 1 off)</code>

=== Wenn's nicht klingelt ===
Das Klingeln erfolgt über die Wählhilfe. Eventuell muss über die Weboberfläche der Fritz!Box ein anderer Port eingestellt werden. Der aktuelle steht in "box_stdDialPort".

=== TR064-Transport-Error: 500 Can't connect to ...:49443 (certificate verify failed) ===
Eventuell hilft es, die Perl Module Net::HTTPS, Net::SSL und IO::Socket::SSL zu aktualisieren.

=== "Error: Old SID not valid anymore." nach Erlauben von IPv6 auf der Fritzbox ===
Ohne hier den genauen Grund zu kennen - es hilft die Angabe der IPv4-Adresse: also statt <code>define FritzBox FRITZBOX</code> dann <code>define FritzBox FRITZBOX <IP></code> (z.B. <code>define FritzBox FRITZBOX 192.168.10.1</code>), so dass das Modul nicht über IPv6 geht.

=== "Didn't get a session ID" ===
Höchstwahrscheinlich wurde ein falsches Passwort gesetzt.

:<code>set <DEVICE> password <PASSWORD></code>

=== TR064-Error 401:invalid action ===
Eventuell ist auf der Fritzbox ein Benutzer gesetzt und im Modul nicht korrekt angegeben bzw. mit falschen Rechten versehen (attribut boxUser).

== Links ==
* {{Link2Forum|Topic=29725|LinkText=Forenthread}} zu diesem Modul
* [https://waschto.eu/traffic/ How-To: Traffic der FritzBox als Balkendiagramm darstellen]

[[Kategorie:FritzBox]]

WifiLight

2017-08-26T18:16:39Z

Waschto: Links zu How-Tos eingefügt

{{Infobox Modul
|ModPurpose=Steuern von LEDs / Stripes mit Hilfe eines WLAN LED Moduls
|ModType=x


|ModForumArea=Sonstige Systeme
|ModTechName=32_WifiLight.pm
|ModOwner=[http://forum.fhem.de/index.php?action=profile;u=769 Jörg alias herrmannj]
}}



FHEM Modul zum steuern diverser LED Leuchtmittel über WLAN wie Mi-Light, Limitless, IVY, sengled, LW12, LED Streifen, 2,4GHz E27 RGB Lampen ...

=== Basic Syntax ===
==== Definition ====
:<code>define <name> WifiLight <Leuchtmitteltyp> <bridgetyp>:<IP|FQDN></code>
''Für die Milight Typen die Gruppen unterstützen werden die Gruppen in der Reihenfolge der Definition automatisch erstellt.''

==== on / off ====
:<code>set <name> on|off</code>
''"on" schaltet weißes Licht mit 100% ein. (Ausnahme Milight/RGB(old) da dort kein weiß unterstützt wird: 100% rot)''

Erweiterte Parameter:
* ramp

==== dim ====
:<code>set <name> dim level</code>
''"dim" behält die aktuell gesetzte Farbe bei und so kann "dim 100" anstelle von "on" verwendet werden wenn die aktuelle Lichtfarbe beibehalten werden soll.''

erweiterte Parameter:
* ramp
* queue

==== HSV ====
:<code>set <name> HSV H,S,V</code>
''Farbangaben im Farbraum "HSV" sind vollständig und in der Regel intuitiver als RGB. H (HUE: 0..360) gibt die Grundfarbe in einem Farbkreis (Regenbogen) an. Rot liegt bei 0°, Grün bei 120° und blau bei 240°. S (Saturation/Sättigung: 0..100) steht für die Sättigung der Farbe. Eine Sättigung von 100 bedeutet die Farbe ist "rein" oder komplett gesättigt. Blau zum Beispiel mit 100% Sättigung entspricht RGB #0000FF. V (Value: 0..100) gibt die Helligkeit an. Ein V von 50 heist: "halbe Helligkeit"''

erweiterte Parameter:
* ramp
* queue
* direction
* event

<code>ramp</code>
Dieser Parameter steuert einen weichen Übergang zwischen zwei Zuständen und wird in Sekunden angegeben.

Beispiel:

<code>set <name> on</code> : schaltet die LED sofort an.

<code>set <name> on 20</code> : Die LED wird über einen Zeitraum von 20 Sekunden weich hoch-gedimmt.

<code>queue</code>
Angenommen das Modul arbeitet gerade intern eine Transition, also dem weichen Übergang zu einem anderen Zustand (siehe ramp), ab. Der user setzt während der Transition einen weiteren Befehl für die LED ab.

Ohne den Parameter "q" wird die laufende Transition sofort unterbrochen und der neue Befehl wird ausgeführt.
Mit dem Parameter "q" wird der neue Befehl in eine interne Queue geschrieben und erst bearbeitet nachdem die laufende Transition, und alle vorher in die Queue geschriebenen Befehle, abgearbeitet wurden.

Dadurch wird es möglich das mit einem Befehl mehrere ganz unterschiedliche Farb- oder Helligkeitswechsel an das modul übergibt die dann nacheinander abgearbeitet werden.

<code>direction</code>
Im HSV Farbraum entsprechen die Farben einem Winkel (0° Rot, 120° Grün, 240° Blau). Der weiche Übergang von einer Farbe zu einer anderen wird Standardmäßig auf dem "kürzesten Weg" durchlaufen. Der Wechsel von Grün auf Rot sieht also so aus: 120°, 119°, 118°, ... 2°, 1°, 0°. Das entspricht der default direction "s" für "short" - dem kürzesten Weg.

Mit dem Flag "l" für "long" (langer Weg) wird die gleiche Transition jetzt mit dem "Umweg" über Blau ausgeführt, also so: 120°, 121°, 122°, ... 358°, 359°, 360° ( = 0°).

==== RGB ====
:<code>set <name> RGB RRGGBB</code>
''RGB Angaben werden im 6 stelligen Hexadezimalen Format erwartet.''

erweiterte Parameter:
* ramp
* queue
* direction
* event

===== Unterschiede von Farbangaben HSV zu RGB =====
Angenommen das Ziel ist ein Farbverlauf Rot (ganz dunkel, Helligkeit 0) auf Blau sowie ein Farbverlauf von Grün (ebenfalls 0) auf Blau. Im RGB Farbraum starten beide Farbverläufe bei #000000 auf gehen dann auf #0000FF. Damit lassen sie sich nicht unterscheiden und anders als erwartet beginnt der Farbverlauf in beiden Fällen mit einem neutralen "Grau" (RGB #010101). Die entsprechende Beschreibung im HSV Farbraumraum ist hingegen eindeutig (120,100,0 -> 240,100,100 für GRÜN 0% auf BLAU 100%) und funktioniert wie erwartet.

==== Erweiterte Funktionen / Transitions ====
Das Modul unterstützt komplexe programmierbare Farbverläufe. Da diese im Modul berechnet werden hängt die flüssige Wiedergabe von einer ganzen Reihe von Faktoren ab:
* FHEM Host Hardware
* FHEM Auslastung und "Kooperation" von anderen Modulen
* verwendete Leuchtmittel
* Auslastung der ''Bridge''
Das Modul ist stark optimiert um die Farbverläufe flüssig wiedergeben zu können. Auf der anderen Seite reagiert das menschliche Auge sehr empfindlich. Deshalb sind gelegentliche "Sprünge" bei Farbverläufen unvermeidlich und sehr von der konkreten Umgebung abhängig.

== Unterstützte Wifi-Leuchtmittel ==

=== RGB LED (Streifen) am LW12 Wifi LED Controller ===

{{Randnotiz|RNTyp=Info|RNText=Achtung: Vom LW12 existieren mindestens zwei Ausführungen. Unterscheidbar am "eigenen" WLAN. LW12 spannt ein Netz mit der Bezeichnung "LEDNET..." auf. LW12 - HX001 spannt ein Netz mit der Bezeichnung "HX..." auf. Beide Typen werden unterstützt, müssen jedoch mit anderer Signatur definiert werden}}
[[Datei:LW12.JPG|mini|LW12 LED stripe WiFi Controller]]

Der LW12 vereint die LED Steuereinheit und den Wifi Empfänger. Zum Betrieb ist noch der LED Streifen mit gemeinsamer Anode sowie ein in Spannung und Leistung zum LED Streifen passendes Netzteil erforderlich. Alle Anschlüsse am Controller sind als Schraubklemmen ausgeführt.

==== Alternative Bezeichnungen ====
* WF200 Controller

Der Controller erstellt im Werkszustand ein WLAN mit eigener SSID und wird über die vom Hersteller gelieferte Smartphone App in das eigene Netzwerk eingebunden.
* Android Version im Google PlayStore [https://play.google.com/store/apps/details?id=com.Zengge.LEDWifiMagicColor&hl=de LED Magic Color Controller v2]
* Apple Version im Apple App-Store [https://itunes.apple.com/de/app/led-magic-color/id595148649?mt=8 LED Magic Color]

Die Definition erfolgt im Modul so:

LW12 (eigene SSID "LEDNET..."):
:<code>define <name> WifiLight RGB LW12:<IP|FQDN></code>
LW12 (eigene SSID "HX..."):
:<code>define <name> WifiLight RGB LW12HX:<IP|FQDN></code>

Es können eine beliebige Anzahl LW12 definiert werden. Ein LW12 steuert jeweils nur einen LED RGB Streifen.

Der LW12 erzeugt weißes Licht durch RGB Farbmischung und unterstützt beliebige Sättigungen sowie Helligkeiten. <strike>Deshalb und wegen seiner hohen Aktualisierungsrate, ist er für reine RGB Streifen die erste Wahl.</strike> Mittlerweile ist der (bessere) LD382 vom gleichen Hersteller verfügbar.

Zum Betrieb sind der LW12, ein RGB LED Streifen sowie passendes Netzteil (Klemmschrauben) erforderlich.

==== Bezug ====

* Zum Zeitpunkt der Erstellung dieses Artikels ist der LW12 bei eBay von diversen Händlern ab ca 30,- Euro erhältlich.
* [http://www.amazon.de/NEUER-STRIPS-CONTROLLER-iPhone-Android/dp/B00G55329A/ref=sr_1_1?ie=UTF8&qid=1390006342&sr=8-1&keywords=lw12+led LW12 RGB LED Stripecontroller Amazon]

=== RGB und RGBW LED (Streifen) am LD382 Wifi LED Controller ===

Der LD382 vereint die LED Steuereinheit und den Wifi Empfänger. Am LD382 können reine RGB Streifen, RGBW Streifen oder eine Kombination beider angeschlossen werden. Zum Betrieb ist noch der LED Streifen mit gemeinsamer Anode sowie ein in Spannung und Leistung zum LED Streifen passendes Netzteil erforderlich. Alle Anschlüsse am Controller sind als Schraubklemmen ausgeführt, das Netzteil verfügt zusätzlich über einen Steckeranschluss.

Der LD382 verfügt über einen WPS Button, kann also per "one-click" ins Netzwerk genommen werden.

==== Alternative Bezeichnungen ====
* LED Magic UFO (XCSOURCE)

Die Definition erfolgt im Modul so:

LD382 mit RGB Streifen (Weiß wird gemischt)
:<code>define <name> WifiLight RGB LD382:<IP|FQDN></code>
LD382 mit RGBW Streifen (oder Kombination aus RGB und separatem Weiß)
:<code>define <name> WifiLight RGBW LD382:<IP|FQDN></code>

Für neuere Modelle ist als Typ LD382A anzugeben.

=== RGBW LD316 LED-Lampe Wifi ===

Der LD316 vereint LED-Lampe (Fassung E27), Steuereinheit und Wifi Empfänger. Eine externe Steuereinheit ist nicht notwendig. Einfach gegen vorhandene Glühbirne auswechseln. Mittels App Magic Color(sh. LW12) kann LD316 gesteuert und eingestellt werden. Betrieb im eigenen WLAN ist möglich. Weiterhin sind Einstellungen über den in LD316 vorhandenen Webserver möglich (Benutzer: admin, Kennwort: nimda).

Die Definition erfolgt im Modul so:
:<code>define <name> WifiLight RGBW LD316:<IP|FQDN></code>

==== Alternative Bezeichnungen ====
* WIFI WLAN LED Lampe IWY MASTER Color (RGB)
* diverse wechselnde Bezeichnungen bei AliExpress

==== Bezug ====
* Amazon, ab und an vorhanden, Preis schwankt zwischen 40 und 55 €
* ebay, ab und an vorhanden, Preis meist um 45 €
* AliExpress, fast immer was zu finden, Preis zwischen 22 $ und 34 $, Coupon beim Angebot beachten, [http://de.aliexpress.com/item/Free-shipping-smartphone-controlled-lights-bulb-7w-e27-rgbw-colors/32437430102.html?adminSeq=223453226&shopNumber=1763377 Beispiel 1], [http://de.aliexpress.com/item/LED-Smart-bulb-7-5w-E27-RGB-LED-WIFI-Bulb-Light-Color-Temperature-Brightness-Adjustable-Light/32254107494.html?adminSeq=201473654&shopNumber=811614 Beispiel 2] '''ACHTUNG! Teilweise nicht kompatibel, sh. Abschnitt LD316A'''

=== RGBW LD316A LED-Lampe Wifi ===

Mittlerweile sind einige Lampen mit unterschiedlicher Firmware bei gleicher Verpackung im Handel. Diese werden mit der App. Magic Home eingestellt. Abhängig von der vom Hersteller eingesetzten Firmware ist ein Betrieb als LD316A möglich. Betrieb im eigenen WLAN ist möglich. Je nach Firmware ist die Einstellung über den Webserver nicht mehr möglich. Es erscheint zwar die Abfrage nach Benutzer und Kennwort, danach eine Fehlermeldung. Einzelheiten im Forum, Thread (sh. unten) oder Suchbegriff "Magic Home".

Die Definition erfolgt im Modul so:
:<code>define <name> WifiLight RGBW LD316A:<IP|FQDN></code>

=== sengled Boost LED-Lampe Wifi ===
<gallery>
Sengled Boost.JPG|sengled Boost
</gallery>
Die sengled Boost vereint eine Weiß-LED-Lampe (Fassung E27), Wifi Empfänger und Steuereinheit und bietet eine Wifi Repeater Funktion. Eine externe Steuereinheit ist nicht notwendig. Einfach gegen vorhandene Glühbirne auswechseln. Mittels App ("sengled Boost" unter {{Link2Forum|Topic=36811|LinkText=Android}} oder [https://itunes.apple.com/de/app/sengled-boost/id848792893?mt=8 iOS]) kann die sengled Boost gesteuert und eingestellt werden. Betrieb im eigenen WLAN ist möglich. Weiterhin sind Einstellungen (besonders zur Wifi Repeater Funktion) über den in der sengled Boost vorhandenen Webserver möglich (Benutzer: admin, Kennwort: admin).

Die Definition erfolgt im Modul so:
:<code>define <name> WifiLight White SENGLED:<IP|FQDN></code>

Weitere Informationen können im entsprechenden {{Link2Forum|Topic=36811|LinkText=Forumsthema}} nachgelesen werden.

=== Milight Systeme für LED Streifen und E27 Leuchtmittel ===

Milight Leuchtmittel sind von diversen Herstellern unter diversen Handelsnamen erhältlich. Verfügbar sind preiswerte Ansteuerungen (RGB, RGB oder Weiß, RGB und Weiß, Warm- und Kaltweiß) für LED Streifen, Downlights sowie E27 Leuchtmittel. Die E27 Leuchtmittel haben den Empfänger integriert und können direkt in vorhandenen Fassungen eingesetzt werden.

Die Lampen / Controller sprechen ein proprietäres 2,4GHz Protokoll. Zur Ansteuerung mit FHEM wird eine zusätzliche bridge benötigt.

==== Alternative Bezeichnungen ====
* Rocket LED
* Limitless LED
* Easybulb
* s`luce iLight
* iBulb
* Kreuzer
* ...

==== Milight WiFi bridge ====
Es sind verschiedenen bridge Versionen erschienen, wobei die Versionen vor iBox2 nicht mehr hergestellt und praktisch nicht mehr erhältlich sind. Der bridge erstellen im Werkszustand ein WLAN mit eigener SSID und werden über eine Smartphone App in das eigene Netzwerk eingebunden. Zum Betrieb ist ein 5V USB Netzteil erforderlich. Ein Betrieb an den USB Ports des Host ist möglich, wegen eventueller Energiemanagement Funktionen des Host jedoch nicht empfohlen.
<gallery>
BridgeV2.JPG|Milight v2 bridge
BridgeV3.JPG|Milight v3 bridge mit Limitless Aufkleber
BridgeV4.JPG|Milight v4 bridge
MiLight iBox2-small.jpg|Milight iBox2 bridge
</gallery>

===== Milight bridge v1 =====

Wird nicht unterstützt.

===== Milight bridge v2 =====

Die v2 bridge hört auf UDP Port 50000 und ist typischerweise am blauen Etikett erkennbar. Eine v2 bridge kann ansteuern:
* ein RGB Leuchtmittel
ODER
* ein RGBW1 Leuchtmittel
UND
* vier Gruppen Warmwhite/Coldwhite (White)

===== Milight bridge v3 =====

Die v3 bridge hört auf UDP Port 8899 und hat typischerweise ein dunkles Etikett. Eine v3 bridge kann ansteuern:
* ein RGB Leuchtmittel
ODER
* ein RGBW1 Leuchtmittel

UND

* vier Gruppen Warmwhite/Coldwhite (White)
UND
* vier Gruppen RGB + White (RGBW2)

===== Milight bridge v4 =====

Die Funktionen der v4 entsprechen im wesentlichen der v3, allerdings ist das WLAN Modul ein anderes (Draft-N) und das Web Interface wurde entfernt.

===== Milight bridge iBox2 =====

Diese Version lässt sich aktuell nicht mit WifiLight einbinden.

==== Leuchtmittel ====

===== Milight Leuchtmitteltyp RGB =====

E27, LED Streifen Controller oder Downlight.

Dieser Typ RGB Leuchtmittel ist veraltet und von Neuanschaffungen wird abgeraten. Die Ansteuerung ist nur im Farbkreis möglich (keine volle RGB Mischung, keine Sättigung, kein Weiß). Das Protokoll zur Ansteuerung dieses Typ ist fehleranfällig und sehr langsam. Eine parallele Benutzung der FB oder der App verursacht ebenfalls Fehler.

Benötigt eine bridge ab v2.
<gallery>
Milight-RGB-Stripe.jpg|Milight RGB LED stripe Controller mit FB
Milight-RGB-e27.JPG|Milight RGB e27 mit FB
Milight-RGB-downlight.JPG|s'luce RGB Downlight
</gallery>

===== Milight Leuchtmitteltyp RGBW1 =====

LED Streifen Controller. (RGB mit separatem Weiß Kanal)

Dieser Typ RGB Leuchtmittel ist veraltet.

FHEM kann mit diesem Controller Farbe, Helligkeit und Sättigung komplett steuern. Durch den extra Weißkanal sind sehr angenehme Farbmischungen möglich allerdings ist das verwendete Protokoll wie beim RGB langsam und fehleranfällig. Daher eignet sich der Controller nicht für häufige dynamische Farbwechsel und nur bedingt für unbeaufsichtigten / automatischen Betrieb.

Die Sättigung wird durch die Balance des Weiß- und des Farbkanals erreicht. Bei einer Sättigung von 50% werden Weiß und Farbe jeweils voll angesteuert.

Benötigt eine bridge ab v2.
<gallery>
Milight-RGBW1.JPG|Milight RGBW LED stripe Controller mit FB
</gallery>

===== Milight Leuchtmitteltyp White =====

E27, LED Streifen Controller oder Downlight.

Pur weiße LED Leuchtmittel mit Unterstützung der Farbtemperatur (Kaltweiß/Warmweiß).

FHEM steuert die Helligkeit der Leuchtmittel. Ein Unterstützung der Farbtemperatur (Weiß Kelvin) ist noch nicht implementiert. Die Farbtemperatur sollte initial über die app eingestellt werden und wird von den Leuchtmitteln beibehalten. Die e27 Lampen sind zum Zeitpunkt der Erstellung dieses Artikels (04/14) ab etwa 11,- Euro bei eBay verfügbar. Erhältlich in 9Watt (Alukühlkörper) und in 6Watt (OEM, Kunststoffsockel). Die Lichtausbeute ist sehr gut.

Benötigt eine bridge ab v2. Eine bridge kann vier getrennte Gruppen White ansteuern. Wenn mehr als vier Gruppen eingesetzt werden sollen können weitere bridge eingebunden werden.
<gallery>
Milight-WWCW-FB.JPG|Milght Warmweiß/kaltweiß LED Streifen controller mit FB
Milight-E27-WWCW-OEM.JPG|Milight Warmweiß/kaltweiß 6 Watt E27 OEM
Milight-E27-WWCW-9W.JPG|Milight Warmweiß/kaltweiß 9 Watt E27
Milight-Downlight-WWCW.JPG|Milight Warmweiß/kaltweiß Downlight (IWY STAR 6 Watt)
</gallery>

===== Milight Leuchtmitteltyp RGBW2 =====

E27, LED Streifen Controller oder Downlight.

Aktuelle Typen mit neuem und robusterem Protokoll.

Dieser Typ Leuchtmittel gibt farbiges oder weißes Licht. Die Sättigung ist nicht stufenlos sondern 0% oder 100%. Die E27 Typen sind dabei wahlweise mit Warm- oder Kaltweiß bestellbar.

Erhältlich in 9Watt (Alukühlkörper) und in 6Watt (OEM, Kunststoffsockel).

Benötigt eine bridge ab v3. Eine bridge kann vier getrennte Gruppen RGBW2 ansteuern. Mehr als vier Gruppen können mit zusätzlichen bridge verwendet werden.

Die Sättigung wird wie folgt umgesetzt: S: 0..20 => 0% / S: 21..100 => 100%.

''Bei Farbverläufen (Sonnenaufgang) die bei einer Farbe beginnen und bei Weiß enden kann es sinnvoll sein in zwei Schritten zuerst auf 100% Gelb zu faden, dort auf 20%..40% Weiß (typenabhängig) umzuschalten und dann Weiß weiter auf 100% zu dimmen.''
<gallery>
Milight-rgbw2-LED.jpg|Milight RGB/Weiß LED Streifen Controller 4 Zonen
Milight-E27-RGBW2-OEM.JPG|Milight RGB/Weiß 6 Watt E27 OEM
Milight-E27-RGBW2-9Watt.JPG|Milight RGB/Weiß 9 Watt E27 mit FB
</gallery>

== Color-Picker aktivieren ==
Um den sog. "Color-Picker" zu aktivieren müssen die beiden folgenden Attribute gesetzt werden:
<pre>
attr <name> webCmd RGB
attr <name> widgetOverride RGB:colorpicker,RGB
</pre>
<gallery>
Wifiled_colorpicker.png|Colorpicker Beispiel
</gallery>

Weitere Informationen unter [[Color|Color Wiki Artikel]]

== Farbiges Icon ==
Weiterhin kann das Lampen-Icon auch farbig dargestellt werden. Dazu ist es erforderlich, das folgende Attribut zu setzen:
<pre>
attr <name> devStateIcon {Color_devStateIcon(ReadingsVal($name,"RGB","000000"))}
</pre>

== Links ==
* Thread über das Modul im {{Link2Forum|Topic=18958|LinkText=FHEM Forum}}
* [http://www.ledsee.com/datasheet_ledsee/LED%20WiFi%20controller%20for%20home%20use_Hontech-wins__-EN.pdf LW12 Datasheet]
* [https://waschto.eu/wifilight-led-leuchtmittel-in-fhem-einbinden/ How-To: Wifilight-Geräte in FHEM einbinden]
* [https://waschto.eu/milight-geraete-in-fhem-einrichten/ How-To: Milight-Geräte in FHEM einbinden]

[[Kategorie:Unterhaltungselektronik]]
[[Kategorie:Code Snippets]]

MilightDevice

2017-08-26T18:01:22Z

Waschto: Link zu einem How-To hinzugefügt

{{Infobox Modul
|ModPurpose=Unterstützung für MiLight Devices
|ModType=d
|ModForumArea=Beleuchtung
|ModTechName=31_MilightDevice.pm
|ModOwner=mattwire ({{Link2FU|8783|Forum}})
}}

Das Modul [[MilightDevice]] beinhaltet die Unterstützung für MiLight Geräte wie Lampen, LED-Streifen (Controller), etc.

== Voraussetzungen ==
* Eine Instanz des Typs [[MilightBridge]] muss definiert sein.

== Anwendung ==
Bei den folgenden Beispielen wird davon ausgegangen, dass die MilightBridge unter dem Namen ''MilightBridge'' angelegt wurde.

=== Definition einer Zone ===
:<code>define <Lampen-Name> MilightDevice <Leuchtmittel-Typ> MilightBridge <Zone> </code>
Hier gilt es zu beachten, dass der Bereich von 5-8 für RGBW Zonen vorgesehen ist, somit wird die erste Zone für RGBW Leuchtmittel mit Zone 5 definiert.

Beispiel RGB:
:<code>define wz.DeckenLampe MilightDevice RGB MilightBridge 1 </code>
Beispiel RGBW:
:<code>define wz.DeckenLampe MilightDevice RGBW MilightBridge 5 </code>

=== Attribute ===

== Anwendungsbeispiele ==

== Links ==
* API Dokumentation [http://www.limitlessled.com/dev]
* [https://waschto.eu/milight-geraete-in-fhem-einrichten/ How-To: Milight-Geräte in FHEM einbinden]

MilightBridge

2017-08-26T17:59:07Z

Waschto: Link zu einem How-Auto hinzugefügt

{{Infobox Modul
|ModPurpose=Unterstützung für das Interface zu MiLight Devices
|ModType=d
|ModForumArea=Beleuchtung
|ModTechName=30_MilightBridge.pm
|ModOwner=mattwire ({{Link2FU|8783|Forum}})
}}
Das Modul [[MilightBridge]] beinhaltet die Unterstützung für das (Hardware-)[[Interface]] zu Milight Komponenten und Zonen.

== Voraussetzungen ==
* Die IP Adresse der MilightBridge muss bekannt sein (am einfachsten über die Milight Smartphone App zu ermitteln)
* ''libmath-round-perl'' muss installiert sein, z.B. mit:
:<code>$ sudo apt-get install libmath-round-perl && sudo reboot</code>

== Anwendung ==
=== Definition ===
Anschließend wird die Bridge in FHEM konfiguriert:
:<code>define <MilightBridge-Namen-definieren> MilightBridge <MilightBridge-IP-Adresse></code>
Beispiel:
:<code>define MilightBridge MilightBridge 192.168.x.x</code>

Jetzt ist die MilightBridge einsatzbereit und es können mit dem [[MilightDevice]]-Modul einzelne Zonen bzw. Lampen definiert werden

== Links ==
* API Dokumentation [http://www.limitlessled.com/dev]
* [https://waschto.eu/milight-geraete-in-fhem-einrichten/ How-To: Milight-Geräte in FHEM einbinden]

[[Kategorie:IP Components]]

Spritpreismonitor

2017-06-09T11:00:52Z

Waschto: Hinzufügen eines Links zu einem anpassbarem Spritpreismonitor / Tankalarm

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]
* Anpassbarer Spritpreismonitor mit Tankalarm: [https://waschto.eu/spritmonitor-2-0-individualisierter-tankalarm/ waschto.eu] (Beta-Phase)

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