Startseite Unterschiede Basic / Pro Installation/Schnelleinstieg Support Forum Dokumentation Icons Sounds Hintergrundmuster Beispiele Changelog Blog / News Galerie
HomeStatus Display

Dokumentation der HomStatus Befehle

Übersicht

Alle CCU Variable, auf HomeStatus reagiert, haben Prefix „hs_“. Jede Variable hat eine Displaybezeichnung, z.b. „display1“, die ermöglicht mehrere Tablets als HomeStatus Displays einzurichten.

Folgende Syntax für die CCU-Variable ist auch möglich falls mehrere Displays gleichzeitig angesprochen werden sollen und die Einstellungen identisch sein sollen hs_display1_display2_options. Alternativ können auch mehrere Displays auf eine Nr. eingestellt werden wenn sie genau das identische darstellen sollen.

Die übermittelten Steuerbefehle werden von der App bei jeder Änderung geprüft, Fehler werden im Bereich „Log“ in der App angezeigt.

In der Pro Version ist es möglich auch mehrfache Views zu konfigurieren, siehe Multiple Views für mehr Details. In diesem Fall haben alle Variablen zusätzliche View Index parameter.

hs_display1_view2_options


hs_ — allgemeine HomeStatus Prefix

display1 — die Variable bezieht sich auf Display1 (siehe Config Tab in der App)

view2 — die Variable bezieht sich auf View mit Index 2

options — semantische Bedeutung der Variable (Einstellungen)

hs_display1_options

Allgemeine Einstellungen für ein Display (View).

In der Pro Version hat jede View eigene Einstellungen, e.g. hs_display1_view1_options

Syntax Beschreibung Default
{dim:XX} Bildschirmhelligkeit in Prozent (0 – schaltet den Bildschirm aus, eine positive Werte schaltet ihm wieder ein). 80
{backgroundColor:#XXXXXX} Hintergrundfarbe für HomeStatus Display #FFFFFFFF (transparent)
{margin:x,x,x,x} margin in pixels (für Zellen) 3,3,3,3
{defaultImgMargin:x,x,x,x} margin in pixels (für einzelne Bilder) 0,0,0,0
{volume:XX} sound Lautstärke 0-100 oder „none“, „none“ überlässt die Regelung dem Gerät und greift nicht dauernd ein none
{color:#XXXXXX} default Text Farbe, kann in einzelnen Feldern eigenständig geregelt werden. black
{width:XXX} Breite der Tabelle von 0-100 in Prozent 80
{defaultBlockBackgroundColor:XXX} Default Hintergrundfarbe für das Display (View) #22FFFFFF
{backgroundImage:XXX} Hintergrund Bild/Muster. Um das Bild zu entfernen kann ’none‘ gesetzt werden none
{defaultFontSize:XXX} default font size für alle Texte. Wenn für eine Zelle eine eigene fontSize festgelegt wurde wird die betreffende Zelle nicht beeinflusst. 14
{defaultTypeFace:XXX} Standard Schriftart für alle Texte. Mögliche Schriftarten (kann von Gerät zu Gerät variieren): ‚monospace‘, ’serif‘, ’sans-serif‘, ‚default‘ default (system standard Schriftart)
{timestampFormat:XXX} wird in Zusammenhang mit #TS:# im {text:} benutzt um die letzte Änderung der Variable. Es gibt zwei Möglichkeiten:

  • „die Tür wurde um 07:15 geöffnet“, dafür soll man nur folgendes machen {text: die Tür wurd um #TS:%h%m# geöffnet} (das Zeitformat %Y-%M-%D %h:%m:%s) Alle platzhalter
  • „die Tür wurde vor 32 Minuten geöffnet“, dafür muss zuerst das timestampFormat konfiguriert werden (für jede View), {timestampFormat:0-60s, vor # Sekunden; 1-59m, vor # Minuten; 1-24h, vor # Stunden; 25-48h, gestern; 49-9999h, lang davor…} und dann im {text: die Tür wurde #TS:# geöffnet} ohne format.
{pinSizeFactor:XXX} Pincode Dialog Größe in Prozenten 100
{pinFontColor:XXX} Pincode Dialog Textfarbe black
{pinBordersColor:XXX} Pincode Dialog Borderfarbe black
{pinBackgroundColor:XXX} Pincode Dialog Hintergrundfarbe white
{pinBackgroundPressedColor:XXX} Pincode Dialog Hintergrundfarbe, wenn’s gedrückt wird #CCCCCC (grau)

hs_display1:A1

Kann auch „hs_display1:A1_display:B2“ sein, wenn mehrere Displays mit unterschiedlich großen Tabellen angesprochen werden.

Es besteht die Möglichkeit Zellen zusammenzufassen:

Eine in der CCU angelegte Variable mit Namen „hs_display1:A1-2“ würde die Zellen A1/A2 zusammenlegen. Das gleiche geht auch für Zeilen „hs_display1:A-B1“ oder beides zusammen „hs_display1:A-B1-2“

Beispiel „hs_display1:A-B1“:

A-B1 C1
A2 B2 C2
A3 B3 C3

 

Beispiel „hs_display1:A1-2“

A1-2 B1 C1
B2 C2
A3 B3 C3

 

Beispiel „hs_display1:A-B1-2“

A-B1-2 C1
C2
A3 B3 C3

 

 

Syntax Beschreibung Default
{color:#XXXXXX} Textfarbe. Spezialwert ‚default‘, setzt die in _options gesetzte Textfarbe. black
{backgroundColor:#XXXXXX} Hintergrundfarbe der Zelle. Spezialwert ‚default‘ setzt die in _options gesetzte Hintergrundfarbe. #22FFFFFF (12.5% transparent)
{text:XXX YYY ZZZ} Dargestellter Text. Die Werte ’none‘ setzen um Text zu leeren.
Anzeige der Uhrzeit %y auch möglich. Platzhalter #TS:# um die letzte Änderung anzuzeigen (siehe {timestampFormat:XXX} unter hs_display1_options), e.g.
{text:Heute ist %D.%M.%Y Uhr: %h%m%s} Alle platzhalter
none
{img:XXX} Bild, z.b. ein Icon. Der Wert XXX kann ein Pfad auf dem Tablet sein (nur HomeStatus Pro), oder ein integriertes Icon (Liste der Icons findet sich hier – Größen: 64/128/256).Bei einer Pfadangabe wird das Vorhandensein der Datei geprüft – falls Datei nicht vorhanden wird ein Fehler im Log (Tab) angezeigt. Wert ’none‘ entfernt das Bild. none
{img:XXX,YYY,ZZZ} XXX ist eine externe URL, e.g. http://homestatus.de/wp-content/uploads/2014/06/4inone.png, YYY – refresh rate in Sekunden, ZZZ Größe, e.g. „200×160“ none
{imgMargin:x,x,x,x} Abstand in Pixeln (für Icons). 0,0,0,0 (gesetzt in _options)
{fontSize:XXX} Schriftgrösse in Pixel. Standardwert ist „14“ 14
{typeFace:XXX} Schriftart des Textes. Defaultwert kann in _options gesetzt werden. Mögliche Schriftarten (kann von Gerät zu Gerät variieren): ‚monospace‘, ’serif‘, ’sans-serif‘, ‚default‘. default (system standard Schriftart)
{align:XXX} Bündigkeit vom Text. Mögliche Werte sind: ‚left‘, ‚right‘, ‚center‘, ‚top‘, ‚left‘ (center kann nur gesetzt werden wenn ein Bild einzeln oder eine Text einzeln in der Zelle dargestellt wird). Beispiel left
{padding:x,x,x,x} Zwischenabstände in Pixel. Ordnung: top, right, bottom, left 3,5,3,5
{action:XXX,YYY,ZZZ} Virtuelle Taste drücken, eine CCU Variable setzen oder ein View umschalten.

  • Taste drücken. XXX ist die Adresse einer Taste (z.b. FEQ0042340:3 oder BidCoS-RF:1), YYY: Typ des Tastendrucks PRESS_SHORT oder PRESS_LONG, ZZZ – PIN code (optional / nur Zahlenwerte, z.b. 1234 (1-5 Stellen))
  • Variable setzen. XXX – Name einer Variable, YYY – neue Werte (geschweifte Klammerun und Kommas müssen mit einem Backslash escaped werden \{ \} \,), ZZZ – Pincode, e.g. {action:my_variable,my_value,1234}. Pincode (3. Stelle) ist optional.
  • View umschalten. XXX – muss eine View referenzieren, e.g. „v1“ für View1, YYY – Pincode.
  • Externe URL aufrufen:
  • GET. {action:GET,http://homestatus.de/subpage}
  • POST. {action:POST,http://homestatus.de/subpage?post_param1=value1&post_param2=value2}
{run:XXX} Laufende Text. XXX – Anzahl Millisekunden pro Runde. Vorsicht, performancehungrig 0
{blink:XXX} Blinking Text. XXX – Anzahl Millisekunden pro Runde. Vorsicht, performancehungrig 0
{beep:XXX} Beep Sound, das standard Klick Sound ersetzt. XXX – Pfad zur Datei none

hs_display1_alarm

Spezielle Variable für Alarm View (implementiert als Alias für View 999). hs_display1_alarm wird intern ins hs_display1_view999 umgewandelt. Alarm ist auch ein Grid, d.h. es können mehrere Zelle definiert werden, z.B. hs_display1_alarm:B1, hs_display1_alarm:C-D2-3 usw.

Als ganz normales View hat der Alarmscreen auch die Options: hs_display1_alarm_options (identisch mit Display Options)

Syntax Beschreibung Default
{status:XXX} Schaltet den Alarmscreen ein und aus. Werte ‚on‘ or ‚off‘ off
{sound:XXX} siehe hs_display1_sound none
{say_XXX:YYY} siehe hs_display1_sound
alle andere Options sind gleich mit hs_display1:A1

hs_display1_sound

Ermöglicht Abspielen sound Dateien, Online Streams, Sprachausgabe

Syntax Beschreibung Default
{sound:XXX} XXX ist absoluter Pfad zu Datei (nur HomeStatus Pro) oder ohne Pfad für eine integrierte Sounddatei. (Liste der vorinstallierten Sounds findet sich hier). Externe Dateien oder Streams (e.g. Internet Radio) können direkt abgespielt werden, dafür muss XXX einen Pfad setzen, e.g. {sound:http://my-super-internet-radio.de:8001/stream.mp3}. Die Werte „none“ schaltet aktuelles Abspielen aus. none
{soundLoop:XXX} XXX true oder false. Wenn true gesetzt ist, dann wird das {sound:} unendlich wiederholt false
{say_XXX:YYY} XXX – Lokale Einstellung (z.b. ‚de‘ für Deutsch oder ‚fr‘ für Französisch), YYY – ein beliebiger Text der Ausgesprochen werden soll. Es kann nur die „sound“ ODER „say“ Option benutzt werden, ein gleichzeitiges abspielen ist nicht möglich
{soundStream:XXX} XXX – URL zum Stream. Der Stream wird gestoppt, wenn andere Sounds abgespielt werden, und dann wieder aktiviert.

External Refresh

http://tablett_ip:8080/refresh aufrufen, danach werden die Variablen aus der CCU geholt. In der Konfiguration der App kann der Refresh auf „0“ gestellt werden, dann wird kein automatischer refresh gemacht.

Variable per URL Aufruf Setzen

Eine Variable kann direkt gesetz werden (ohne CCU). z.B. http://tablett_ip:8080/set?hs_display1_view0:A1={text:hello world!}. Man muss aber alle interne Klammarn escapen, z.B. http://tablett_ip:8080/set?hs_display1_view0:A1={text:text mit \{klammarn\}}.
Momentan hat der CCU eine höhere Priorität. Alle Variablen, die nicht auf der CCU existieren werden währen Refresh entfernt.

Es ist möglich mehrere Variablen gleichzeitig zu setzen: http://tablett_ip:8080/set?hs_display1_view0:A1={text:test1}&hs_display2_view0:A2={text:test2}

Noch ein Beispiel: alarm abschalten

eine Variable hs_display1_alarm:B1 mit Werte {text:ALARM OFF}{action:get,http://127.0.0.1:8080/set?hs_display1_alarm=\{status:off\}}.

Multiple Views

Pro Version unterstütz mehrfache Views. Bei jedem Tablett kann man mehrere Views konfigurieren und dann umschalten über {action:} oder über eine CCU Variable „hs_display1_changeView“. Views werden mit Indexes referenziert. view0 ist ein Hauptview (default), z.B. „hs_display1:A1“ das gleiche view „hs_display1_view0:A1“.

Umschalten

z.b. wir haben zwei Views konfiguriert:
hs_display1_view0:A1: {text:view1 anzeigen}{action:v1} — beim touch wird das Display auf view1 umschalten
hs_display1_view0:A2
und
hs_display1_view1:A1
hs_display1_view1:A1 {text:zurück zur hauptansicht}{action:v0}

oder per CCU Variable hs_display1_changeView mit Wert „1“ wird auf view1 umschalten, „0“ auf Hauptansicht umschalten.

Unterstützte Farbformate

#RRGGBB (Web-Tool um HEX Farbcodes zu generieren: http://www.colorpicker.com/) oder #AARRGGBB (AA steht für Transparenz

sowie die Standardfarben:

‚red‘, ‚blue‘, ‚green‘, ‚black‘, ‚white‘, ‚gray‘, ‚cyan‘, ‚magenta‘, ‚yellow‘, ‚lightgray‘, ‚darkgray‘, ‚grey‘, ‚lightgrey‘, ‚darkgrey‘, ‚aqua‘, ‚fuschia‘, ‚lime‘, ‚maroon‘, ’navy‘, ‚olive‘, ‚purple‘, ’silver‘, ‚teal‘

Bei unterschiedlichen Geräten/Android Versionen kann es sein, dass einzelne Farben nicht unterstützt werden. In diesem Fall bitte auf die RGB Farben ausweichen – Dank an Christian für die Info.

Unterstützte Datum/Zeit Platzhalter

%Y – Jahr, e.g. 2014
%M – Monat, e.g. 12
%D – Tag, e.g. 01
%h – Stunde, e.g. 16
%m – Minute, e.g. 09
%s – Sekunde, e.g. 08
%w – KW, e.g. 01
%DD – Tagname kurz, e.g. Di.
%DDD – Tagname lang, e.g. Dienstag
%MM – Monatsname kurz, e.g. Dez
%MMM – Monatsname lang, e.g. Dezember

Alle namen hängen von Gerätlokale an

Batterie Status Übergabe

HS Display kann den Batterie Status and der CCU senden. Dafür sollte eine Variable („hs_battery_display1“ mit dem Typ „Zahl“, statt 1 kann auch andere Zahl stehen) auf der CCU erstellt werden. Der Status wird alle 5 minuten als eine Zahl 0-100 gesendet werden (prozentual). Fehlermeldungen werden auf dem Log Tab angezeigt.

Unterstützte Datum/Zeit Platzhalter

%Y – Jahr, e.g. 2014
%M – Monat, e.g. 12
%D – Tag, e.g. 01
%h – Stunde, e.g. 16
%m – Minute, e.g. 09
%s – Sekunde, e.g. 08
%w – KW, e.g. 01
%DD – Tagname kurz, e.g. Di.
%DDD – Tagname lang, e.g. Dienstag
%MM – Monatsname kurz, e.g. Dez
%MMM – Monatsname lang, e.g. Dezember

Alle namen hängen von Gerätlokale an