FHEM Tablet UI

Aus FHEMWiki
Version vom 20. Februar 2016, 10:54 Uhr von Amenophis86 (Diskussion | Beiträge) (→‎Widgets -- Beispiele: Label Icon bei den Beispielen hinzugefügt)
FHEM Tablet UI
Zweck / Funktion
Oberfläche für Fhem
Allgemein
Typ Inoffiziell
Details
Dokumentation Thema
Support (Forum) Frontends
Modulname n.a.
Ersteller setstate (Forum )
Wichtig: sofern vorhanden, gilt im Zweifel immer die (englische) Beschreibung in der commandref!
Fhem Tablet UI

FHEM Tablet UI ist ein leichtgewichtiges aber funktionsreiches Framework zum Steuern und Überwachen von in Fhem integrierten Geräten. Zahlreiche Widgets können sehr flexibel und leicht per HTML Code konfiguriert werden.

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


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


Voraussetzungen

Dieses User Interface für Tablets benötigt keine zusätzliche Frameworks, wie PHP, MySQL oder SmartVisu.

Voraussetzungen ist nur ein Standard-Fhem mit HTTPSRV Modul und ein beliebiger Standard-Browser mit Javascript auf einem beliebigen Betriebssystem oder Webviewcontrol.

Installation

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

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

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

Update

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

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

Weitere Widgets

Widgets for Fhem-tablet-ui

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

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

Näheres zur Installation unter Wiki: Installation.

Die Dokumentation der einzelnen Widgets befindet sich ebenfalls im Github-Wiki.

Konfiguration

Die Konfiguration der angezeigten Widgets erfolgt in der Datei index.html im Hauptordner 'tablet'.

Metadaten-Konfiguration

Refresh sofort, alle 15 Minuten ein voller Refresh (shortpoll) statt alle 30 Sekunden ein voller Refresh

<meta name="longpoll" content="1">

Drag&Drop deaktivieren

<meta name='gridster_disable' content='1'>

Toast messages deaktivieren

<meta name='toast' content='1'>

Größe des Basis-Rasters (data-sizey=1/data-sizex=1)

<meta name="widget_base_width" content="116">
<meta name="widget_base_height" content="131">

Abstände der Gridsterelemente verkleinern:

<meta name="widget_margin" content="3">


Das Layout und das Aussehen des UI kann durch die Klassen-Attribute beeinflusst werden. Verfügbare Klassen sind:

container, left, right, cell, narrow, darker, big, bigger, small

Farbe

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

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

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


CSS Class description

Not all widgets support all classes

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

Positioning

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

Widgets -- Konfiguration

Zurzeit stehen 33 Widgets zur Verfügung:

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


Für alle Widgets gilt:

allgemeine Attribute
data-type Widget-Typ
data-device Fhem-Name des Gerätes (mit dem Befehl 'list' bekommt man im Fhem die kpl. Liste)
class CSS-Klassen für Aussehen und Formatierung des Widgets


CHART
HTML Attribut Beschreibung Default Wert
data-logdevice name of the logdevice (e.g. FileLog_WohnzimmerHeizung) or array of names if more than one graph shall be displayed
data-logfile name of the logfile (e.g. WohnzimmerHeizung-2015.log) or or array of names if more than one graph shall be displayed '-' or omitting this data means current logfile
data-columnspec definition for how to find the values (e.g. "4:meas.*:1:int") or or array of columnspecs if more than one graph shall be displayed
data-style name of the graph style to be used (e.g. 'SVGplot l0' or 'ftui l0dash') or or array of styles if more than one graph shall be displayed using different stlyes. The standard fhem plot styles can be used furthermore there are some more predefined styles existing (details see css file). Own styles can be specified e.g. in the fhem-table-ui-user.css file.
data-ptype name of the plot type (e.g. 'lines' or 'fa-cog') or or array of plottypes if more than one graph shall be displayed. All fhem plot styles are supported. Additionally it is possible to specify symbols (currently supported are font awesome ('fa-...'), open automation ('oa-...') and fhem symbols ('fs-...')) 'lines'
data-uaxis name of the axis to be used ('primary' or 'secondary') or or array of axis' to be used if more than one graph shall be displayed. The 'primary' axis is labelled on the left side, the 'secondary' axis is labelled on the right side 'primary'
data-legend caption of the graph (used in the legend and at the cursor) or an array of legend texts if more than one graph shall be displayed.
data-minvalue min Y value to Show or an array of values for dynamic minY for primary axis. A value of 'auto' means that the value is calculated from the data displayed dynamically 10
data-minvalue_sec min Y value to Show or an array of values for dynamic minY for secondary axis. A value of 'auto' means that the value is calculated from the data displayed dynamically 'auto'
data-maxvalue max Y value to Show or an array of values for dynamic maxY for primary axis. A value of 'auto' means that the value is calculated from the data displayed dynamically 30
data-maxvalue_sec max Y value to Show or an array of values for dynamic maxY for secondary axis. A value of 'auto' means that the value is calculated from the data displayed dynamically 'auto'
data-yticks value distance between Y tick lines (related to primary axis). A value of 'auto' means that the value is calculated from the data displayed dynamically. 'auto'
data-xticks time range between each X tick lines (in minutes). A value of 'auto' means that the value is calculated from the data displayed dynamically 'auto'
data-daysago_start number of days back from now for the start of the plot (0 means the plot starts from today 0:00). Additionally the x-axis start value can be set here unsing standard data formats like ('2013-10-23'), the time portion of the string is only used when data-nofulldays is 'true'. 0
data-daysago_end number of days back from now for the end of the plot (-1 means the plot ends today 24:00). Additionally the x-axis end value can be set here unsing standard data formats like ('2013-10-23'), the time portion of the string is only used when data-nofulldays is 'true'.
data-nofulldays switch to activate/deactivate rounding of the xaxis start and end values to full days ('true' or 'false') 'false'
data-ytext text to be shown besides the primary y axis.
data-ytext_sec text to be shown besides the secondary y axis.
data-yunit unit of the value to show beside of each Y ticks for primary y axis.
data-crosshair switch to activate/deactivate the crosshair cursor ('true' or 'false') 'false'
data-cursorgroup number to define coupling of the crosshair cursor. The cursors of all charts having the same number are coupled and move together.
data-scrollgroup number to define coupling of the scrolling (shift and zoom). All charts having the same number are scrolled (shifted and zoomed) together.
data-showlegend switch to activate/deactivate the initial display of the legend window ('true' or 'false') 'false'
data-yunit_sec unit of the value to show beside of each Y ticks for secondary y axis.
data-width fixed size for width (in % or px)
data-height fixed size for height (in % or px)
class fullsize, noticks, nobuttons

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

There are several buttons that control the dynamic behaviour of the chart. The <-, ->, + and - buttons shift and zoom the displayed data. The "legend" and "cursor" buttons are switching on and off the display of the legend window and the crosshair cursor respectively.

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

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

There is a number of css styles that control the visible appearance of the chart. The following classes are supported:

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

Link zu einem Beispiel


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

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

Link zu einem Beispiel


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

Link zu einem Beispiel

HOMESTATUS
HTML Attribut Beschreibung Default Wert
data-get name of the reading to get from Fhem 'STATE'
data-set command to send to Fhem (set <device> <command> <value>)
data-alias array of fix names to show only in the UI as an alias to the real states
data-icons array of icons related to the data-get-on array
data-version name of the status model e.g. 'residents','roommate','guest' (default NULL)

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

Link zu einem Beispiel


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

Link zu einem Beispiel

LABEL
HTML Attribut Beschreibung Default Wert
data-get name of the reading to get from Fhem
data-fix keeping a specified number of decimals. '-1' -> non-numeric
data-part split position of the space separated value to show or an RegEx
data-colors a array of color values to affect the colour of the label according to the limit value
data-limits-get name of the DEVICE:Reading to colorize the label data-device:data-get
data-limits an array of numeric values to affect the colour of the Label
data-limits-part part number of the space separated value to show or a RegEx '-1' -> all
data-unit add a unit after a numeric value. use encoded strings e.g. "%B0C%0A"
data-substitution regex-substitution to apply on the value. Standard regex notation (s/regex/subst/modifier) is expected
class small, large, big, bigger, thin, red, green, blue, darker, timestamp, w1x, w2x, w3x, fixedlabel, icon, bg-limit

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

Link zu einem Beispiel

LEVEL
HTML Attribut Beschreibung Default Wert
data-get name of the reading to get from Fhem 'STATE'
data-min minimal value to set '0'
data-max maximal value to set '100'
data-on value where the slider moves to max 'on'
data-off value where the slider moves to min 'off'
data-colors a array of color values to affect the colour of the label according to the limit value
data-limits a array of numeric or RegEx values to affect the colour of the label
class mini, horizontal

Link zu einem Beispiel (fehlt noch)

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

Link zu einem Beispiel

PLAYSTREAM
HTML Attribut Beschreibung Default Wert
data-url URL des Radio-Streams
data-get name of the reading to get the control state from FHEM 'STATE'
data-get-on value for PLAY status to get. 'on'
data-get-off value for STOP status to get. 'off'
data-volume name of the reading to get the volume value (0-100) volume

Link zu einem Beispiel

HTML Attribut Beschreibung Default Wert
data-get name of the reading where to get the alert value from 'STATE'
data-get-on value which trigger to open the dialog 'on'
data-off value which trigger to close the dialog 'off'
data-width fixe size for width (in % or px)
data-height fixe size for height (in % or px)

Link zu einem Beispiel

PROGRESS
HTML Attribut Beschreibung Default Wert
data-get name of the reading to get from Fhem 'STATE'
data-max maximal value to set or name of the reading which helds the max value 100
class novalue, percent

Link zu einem Beispiel (fehlt noch)

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

Link zu einem Beispiel


ROTOR
HTML Attribut Beschreibung Default Wert
data-delay time in millisecondes to wait until next list item get shown 3500
class fade, rotate

Ohne Angabe von class erfolgt keine Animation.

Link zu einem Beispiel


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

Link zu einem Beispiel

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

Link zu einem Beispiel (fehlt noch)

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


SLIDER
HTML Attribut Beschreibung Default Wert
data-get name of the reading to get from Fhem 'STATE'
data-set command to send to Fhem (set <device> <command> <value>)
data-cmd name of the command (<command> <device> <value>) (e.g. setstate, set, setreading, trigger) 'set'
data-min minimal value to set 0
data-max maximal value to set 100
data-on value where the slider moves to max 'on'
data-off value where the slider moves to min 'off'
data-value wenn true wird beim sliden der Wert angezeigt
data-width width for horizontal sliders '120px', for mini '60px'
data-height height for vertical sliders '120px', for mini '60px'
class Aussehen/Ausrichtung

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

Link zu einem Beispiel

SWITCH
HTML-Attribut Beschreibung Default-Wert
data-get Name des Reading, was gelesen werden soll 'STATE'
data-get-on Wert, bei dem zum Status ON geschaltet werden soll. 'on'
data-get-off Wert, bei dem zum Status OFF geschaltet werden soll. 'off'
data-set-on Wert, der zu Fhem gesendet werden soll, wenn das Widget auf ON geschaltet wurde Wert von data-get-on
data-set-off Wert, der zu Fhem gesendet werden soll, wenn das Widget auf OFF geschaltet wurde Wert von data-get-off
data-cmd Kommando Name (<command> <device> <value>)
(z.B setstate, set, setreading, trigger) 		'set'
data-icon Name des Font-Awesome Icon. 'fa-lightbulb-o'
data-background-icon Name des Font-Awesome Hintergrund Icon. 'fa-circle'
data-on-color Widget Farbe beim Status ON '#aa6900'
data-off-color Widget Farbe beim Status OFF '#505050'

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

Link zu einem Beispiel


SYMBOL

dual state notation

HTML Attribut Beschreibung Default Wert
data-get Name des Reading, was gelesen werden soll 'STATE'
data-get-on value for ON status to get. 'open'
data-get-off value for OFF status to get. 'closed'
data-icon Name des font-awesome-Symbols 'ftui-window'
data-background-icon Hintergrundsymbol
data-on-background-color Farbe für ON-Zustand. '#aa6900'
data-off-background-color Farbe für OFF-Zustand. '#505050'
data-on-color Farbe für ON-Zustand. '#aa6900'
data-off-color Farbe für OFF-Zustand. '#505050'

multi state notation

HTML Attribut Beschreibung Default Wert
data-get Name des Reading, was gelesen werden soll 'STATE'
data-states array of states.
data-icons Array mit Icons zu data-states Array
data-background-icons Array mit Icons zu data-states Array
data-colors array of colors related to the data-states array
data-background-colors array of background-colors related to the data-states array

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

Link zu einem Beispiel


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

Link zu einem Beispiel


VOLUME
HTML Attribut Beschreibung Default Wert
data-get name of the reading to get from Fhem 'STATE'
data-set command to send to Fhem (set <device> <command> <value>)
data-cmd name of the command (<command> <device> <value>) (e.g. setstate, set, setreading, trigger) 'set'
data-min minimal value to set 0
data-max maximal value to set 70
class small, hue-tick, hue-front, hue-back, dim-tick ,dim-front, dim-back

Link zu einem Beispiel (fehlt noch)


WEATHER
HTML Attribut Beschreibung Default Wert
data-get name of the reading to get the weather literal from Fhem 'STATE'
data-imageset collection of images to display current weather situation. Possible values: 'meteocons', 'kleinklima' 'meteocons'
data-image-path path to the images of the selected imageset /images/weather/

Link zu einem Beispiel

Widgets -- Beispiele

Chart

Display a chart with similar capabilities as the FHEM plots 

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

Chart tabletUI.png


Circlemenu

Cover a lot of other button behind one single button 

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

Circlemenu tabletUI.png


Dimmer

Dimmer Widget Beispiel für Philips Hue

Minimalvariante 

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

Mit Anzeige der Dimstufe 

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

Dimmer Widget für MilightDevice 

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


Homestatus

Beispiel rechts im Bild: 

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

Beispiel links im Bild: 

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

Datei:Homestatus tabletUI.png


Image


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

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

Datei:Image tabletUI.jpg


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

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


Label

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

STATE   T: 20.0 H: 61

<div data-type="label" data-device="THSensorWZ" 
     data-part="2" data-unit="%B0C%0A" class="cell big"></div>
<div data-type="label" class="cell">Temperatur</div>
<div data-type="label" data-device="THSensorWZ" data-part="4" 
     data-unit="%" class="cell big"></div>
<div data-type="label" class="cell">Luftfeuchte</div>

But the same result can reached by getting single readings: 

humidity    58
temperature 20.1

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

Example for how to influence the color of the label according to value limits 

<div data-type="label" 
     data-device="OutTemp" 
     data-limits='[-73,10,23]' 
     data-colors='["#6699FF","#AA6900","#FF0000"]' 
     data-unit="%B0C%0A" 
     class="cell big">
</div>

Example for how to create a widget for shutter via push: show state and set up/down 

<div data-type="switch" 
     data-device="wzRollo" 
     data-get-on="up" 
     data-get-off="down" 
     data-icon="fa-bars" 
     class="cell" >
</div>
<div data-type="label" 
     class="cell">Rollo</div>

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

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

Example for how to show two labels in one line. 

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

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

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

Label tabletUI.jpg

Beispiel für die Anzeige des Labels als Icon. 

    <div class="cell">
    <div data-type="label" data-device="AvReceiver" data-get="input" class="icon round bg-red cell"></div>
    <div data-type="label" data-device="AvReceiver" data-get="input" class="icon square bg-blue cell"></div>
    <div data-type="label" data-device="AvReceiver" data-get="input" class="icon squareborder cell"></div>
    <div data-type="label" data-device="PowerAV_Sw" data-colors='["red","green"]' data-limits='["off","on"]' class="icon round bg-limit cell"></div>
</div>

Label tabletUI icon.png

Pagetab

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

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


Playstream

Erzeugt einen Knopf zum direkten Abspielen eines Webradio-Streams. 

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


Push

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

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


Beispiel für zwei horizontale Buttons: 

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

Push1.png


Beispiel für zwei quadratische vertikale Buttons: 

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

Push2.png


Rotor

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

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


Select

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

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

Select tabeltUI.png


Slider


Slider mit einstellbaren Werten von 10 bis 90: 

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

Slider tabletUI.png


Horizontal angeordneter Slider: 

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

Slider tabletUI2.jpg


Switch

Schalter. Usage of RegEx pattern for state request: 

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

Switch.png

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

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

Switch4.png


Symbol

Example for a tristate icon 

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


Example for a tristate icon with blink and spin animation 

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


Example for a battery level control with RegEx 

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


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

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


Thermostat

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

Default parameters are: 

data-get="desired-temp" data-temp="measured-temp" data-set="desired-temp"

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

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

The long format looks like this: 

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


Example for MAX!: 

<div data-type="thermostat" data-device="HZ_Tuer" 
    data-valve="valveposition" 
    data-get="desiredTemperature" 
    data-temp="temperature" 
    data-set="desiredTemperature" 
    class="cell">
</div>

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

Datei:Thermostat.png


Weather

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

Beispiel: 

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

Weather.png

Icon-Konfiguration

  • Eingebaute Icons: Diese haben das ftui-Präfix. Zurzeit sind folgende verfügbar: ftui-window, ftui-door
  • Es stehen auch Openautomation Font-Files zur Verfügung. Wer sie nutzen möchte, muss folgende Stylesheets in die index.html hinzufügen.
   <link rel="stylesheet" href="/fhem/tablet/lib/openautomation.css" />
   <link rel="stylesheet" href="/fhem/tablet/lib/fhemSVG.css" />

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

Beispiel bei einem Schalter: 

<div data-type="switch" data-device='dummy1' data-icon="oa-secur_locked"></div>


Und so als großes Symbol: 

<div data-type="symbol" data-device='dummy1'
        data-icon="oa-status_frost"
        data-on-color="#bb3232"
        data-get-on="on"
        data-get-off="!on"
        class="bigger">
</div>


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


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

Spezial

Folgender Befehl setzt einen direkten Befehl an Fhem ab (set dummy1 off): 

     <div onclick="setFhemStatus('set dummy1 off')">All off!</div>


FAQ

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

Links

Abgerufen von „http://wiki.fhem.de/w/index.php?title=FHEM_Tablet_UI&oldid=14280“