ReadingsGroup: Unterschied zwischen den Versionen

Aus FHEMWiki
(→‎Funktion rgLink(): use <source>)
Zeile 992: Zeile 992:
** ''detail'' erzeugt einen Link zu Device-Detail Seite
** ''detail'' erzeugt einen Link zu Device-Detail Seite
* $label - Link-Name
* $label - Link-Name
<pre>
<source lang="perl">
sub rgLink($$$){
sub rgLink($$$){
   my ($name,$action,$label) = @_;  
   my ($name,$action,$label) = @_;  
Zeile 1.023: Zeile 1.023:
   return $ret;
   return $ret;
}
}
</pre>
</source>


{{Randnotiz|RNText=Tipp
{{Randnotiz|RNText=Tipp
Verwende zum Bearbeiten der eigenen .css Dateien entweder den [http://fhem.de/commandref_DE.html#JavaScripts Codemirror Editor] oder einen eigenen Editor mit [http://de.wikipedia.org/wiki/Syntaxhervorhebung Syntax Highlighting] . Das hilft bei der Fehlersuche enorm. }}
Verwende zum Bearbeiten der eigenen .css Dateien entweder den [[Konfiguration#Syntaxhervorhebung|Codemirror Editor]] oder einen eigenen Editor mit [http://de.wikipedia.org/wiki/Syntaxhervorhebung Syntax Highlighting] . Das hilft bei der Fehlersuche enorm. }}
 
===== Styling =====
===== Styling =====
Die eigene .css Datei erscheint in FHEM unter Edit-Files --> styles und kann direkt im FHEM-Editor oder mit eigenen Editor bearbeitet werden.
Die eigene .css Datei erscheint in FHEM unter Edit-Files --> styles und kann direkt im FHEM-Editor oder mit eigenen Editor bearbeitet werden.

Version vom 31. Oktober 2015, 12:50 Uhr


readingsGroup
Zweck / Funktion
Einfache zusammenfassende Darstellung von Informationen über mehrere Geräte und deren Steuerung
Allgemein
Typ Hilfsmodul
Details
Dokumentation EN / DE
Support (Forum) Frontends
Modulname 33_readingsGroup.pm
Ersteller Andre (Forum / Wiki)
Wichtig: sofern vorhanden, gilt im Zweifel immer die (englische) Beschreibung in der commandref!


Das Fhem-Hilfsmodul readingsGroup bietet eine einfache Möglichkeit, Readings (kein Präfix vor dem Reading-Namen), Internals (Präfix "+" vor dem Namen des internen Wertes) und Attributes (Präfix "?" vor dem Namen des Attributs) von einem oder mehreren Devices darzustellen und flexibel zu formatieren.

Die Aktualisierung im Browserfenster geschieht per longpoll und überträgt nur die jeweils geänderten Zellen. Wenn eine readingsGroup in keinem Browserfenster angezeigt wird findet keine longpoll aktualisierung statt.

Definition

Siehe commandref.

Attribute

Info green.pngIn allen Mappings die einen Hash verwenden muss der Key (das was jeweils links von => Operator steht) in Anführungszeichen stehen. Die einzige Ausnahme hiervon sind Keys die aus einem String bestehen der mit einem Buchstaben beginnt und nur Buchstaben und Zahlen enthält.

Weitergehende Erläuterungen zu einzelnen Attributen.

Die komplette Liste der Attribute ist der commandref zu entnehmen.

noheading

ReadingsGroup: rechts mit "noheading" Attribut, links der anklickbare Titel

Das Attribut noheading führt dazu, dass der Alias der ReadingsGroup nicht mehr als Titel angezeigt wird. Das kann wünschenswert sein, wenn die ReadingsGroup auf einer Dashboard-Seite angezeigt werden soll, hat allerdings den Nachteil, dass die Detail-Ansicht der ReadingsGroup nicht mehr über einen Klick auf den Titel aufgerufen werden kann. Der Einstellungsdialog der ReadingsGroup ist dann nur noch (z. B.) über

  • list TYPE=readingsGroup
  • einen "Probably associated with"-Link eines anderen Objekts oder über
  • manuelle Modifikation der URL eines anderen Objekts (http:.../fhem?detail=<objektname>)

erreichbar.

nolinks

Devicenamen und Titel der readingsGroup verlinken nicht mehr zur zugehörigen Detailansicht und sind nicht mehr anklickbar.

nostate

Das state-Reading wird bei regex match nicht berücksichtigt und nicht angezeigt.

notime

Es werden keine Timestamps für die Readings angezeigt. Nur für einspaltige readingsGroups sinnvoll.

Beispiele

Bitte beachten: die folgenden Beispiele enthalten keine Maskierungen oder Verdoppelungen für ; und Zeilenende, sondern sind so angegeben, wie sie im Web Interface im Befehls-Eingabefeld, nach Klick auf DEF und im Attribut-Eingabefeld eingegeben werden. Beim manuellen Einfügen in eine Konfigurationsdatei sind diese Maskierungen oder Verdoppelungen natürlich vorzunehmen.

Einfache Auswahl über Reading-Namen

Definition Erläuterungen Aussehen
define battStatus readingsGroup .*:[Bb]attery Alle readings mit Namen Battery oder battery von allen Devices.
RgBattery.png
attr battStatus alias FHT Batteriestatus Der Alias wird als Zeilentitel verwendet
attr battStatus mapping %ROOM Mapping %ROOM führt dazu, dass der Raumname als Zeilentitel angezeigt wird.

Übersicht HomeMatic Geräte

define HM_Components readingsGroup <Gerät>,<Name>,<Model>,<S/N> TYPE=CUL_HM:+NAME,?model,D-serialNr

Auswahl über Reading-Namen, Status als Symbol dargestellt

Definition Erläuterungen Aussehen
define rg_battery readingsGroup .*:battery Alle readings mit Namen battery von allen Devices.
RgBattery2.png
attr rg_battery alias Batteriestatus Der Alias wird als Überschrift verwendet
attr rg_battery valueIcon {'battery.ok' => 'batterie', 'battery.low' => 'batterie@red'} Statt der reading Werte "ok" und "low" soll ein Icon angezeigt werden.
attr rg_battery commands { "battery.low" => "set %DEVICE replaceBatteryForSec 60" } Für LaCrosse devices kann man beim Klick auf ein rotes "battery low icon" direkt replaceBatteryForSec setzen.

Reading-Werte zuordnen (Icon / Text)

Definition Erläuterungen Aussehen
define rg readingsGroup Contact.Dachboden_gross:sensed.* Alle sensedreadings des Contact.Dachboden_gross device.
RgFenster.png
attr rg mapping { 'sensed.A' => 'links', 'sensed.B' => 'rechts' } Die Zuordnung rechts/links
attr rg valueFormat {($VALUE eq '1')?"fts_window_roof":"fts_window_roof_open_2"} Die Zuordnung von reading Wert zu Icon Namen.
attr rg_battery valueIcon %VALUE Statt des reading Werts soll ein Icon angezeigt werden.

Formatvorgabe für Ausgabewerte

Definition Erläuterungen Aussehen
define TempHygro readingsGroup TYPE=CUL_WS:temperature,humidity,dewpoint Alle readings mit Namen temperature, humidity, dewpoint von allen Devices des Typs CUL_WS
S300TH-Werte in einer readingsGroup
attr TempHygro alias Temperatur / rel. Feuchte / Taupunkt Der Alias der readingsGroup wird als Überschrift verwendet
attr TempHygro mapping %ALIAS Mapping %ALIAS führt dazu, dass der Alias des Geräts als Zeilentitel angezeigt wird.
attr TempHygro valueFormat { temperature => "%.1f&deg;C", humidity => "%.1f %%", dewpoint => "%.1f&deg;C"} Formatierung der Ausgabewerte. Achtung: "%" die in der Ausgabe erscheinen sollen, müssen verdoppelt werden!

Ausgabestil (hier rechtsbündig)

Definition Erläuterungen Aussehen
define Wetter readingsGroup WetterXXX:<%temp_temperature>,<Temperatur>,temperature WetterXXX:<%weather_humidity>,<Luftfeuchte>,humidity WetterXXX:<%weather_barometric_pressure>,<Luftdruck>,pressure

Die readings mit Namen temperature, humidity und pressure vom Device WetterXXX jeweils mit einem Icon und einem Label davor.
RgWetter.png
attr Wetter valueFormat { temperature => '%1.f &deg;C', humidity => '%1.f %%', pressure => '%i mbar' } Die Formatierung der Readingswerte
attr Wetter valueStyle style="text-align:right" Die Readings sollen rechtsbündig dargestellt werden.

Internal Value ausgeben

Diese Beispiel könnte entfallen (nächstes Beispiel ist sehr ähnlich; es wird lediglich ein weiterer Wert ausgegeben).

Definition Erläuterungen Aussehen
define culRSSI readingsGroup cul_RSSI=.*:+cul_RSSI Den RSSI Wert aller Devices (am IODev cul) die einen solchen haben anzeigen.
Achtung: "internal values" werden nicht per longpoll aktualisiert, sondern nur beim Seitenaufbau.
RgculRSSI.png

Internal Values ausgeben

Definition Erläuterungen Aussehen
define culRSSI readingsGroup cul_RSSI=.*:+cul_RSSI,+cul_TIME Den RSSI Wert mit der zugehörigen Zeit aller Devices (am IODev cul) die einen solchen haben anzeigen.
Achtung: "internal values" werden nicht per longpoll aktualisiert, sondern nur beim Seitenaufbau.
"Internal Values" werden durch das vorangestellte + (Pluszeichen) identifiziert.
RgculRSSI2.png
attr culRSSI valueStyle {return undef if($READING =~ m/TIME/); ($VALUE <= -85)?'style="color:red"':($VALUE <= -80)?'style="color:yellow"':undef} Schlechte RSSI Werte sollen abhängig von zwei Schwellwerten gelb oder rot eingefärbt werden (auf dem Screenshot nicht zu sehen).

Alle Readings eines Gerätes, mit Ausnahme von...

Definition Erläuterungen Aussehen
define Systemstatus readingsGroup sysstat Alle readings des sysstat Device
RgSysstat.png
attr Systemstatus nostate 1 Ohne state
attr Systemstatus notime 1 Ohne readings timestamp
attr Systemstatus mapping {'load' => 'Systemauslastung', 'temperature' => 'Systemtemperatur in &deg;C'} Die Zuordnung der reading Namen zu den Zeilentiteln

Anzeige auf einem Floorplan

Definition Erläuterungen Aussehen
define Heizung readingsGroup t(1|2|3):temperature Die Temperatur readings der Devices t1, t2 und t3
RgHeizung.png
attr Heizung mapping {'t1.temperature' => 'Vorlauf', 't2.temperature' => 'R&ücklauf', 't3.temperature' => 'Zirkulation'} Die Zuordnung der reading Namen zu den Zeilentiteln
attr Heizung nameStyle style="text-align:left" Zeilentitel linksbündig wegen floorplan
attr Heizung style style="font-size:20px;color:lightgray" Großer Font und Farbe passend für den floorplan
attr Heizung notime 1 Ohne readings timestamp
attr Heizung valueFormat : %.1f &deg;C Doppelpunkt zwischen Zeilentitel und Wert, eine Nachkommastelle plus Einheit


LightScene DropDown-Menü für smallscreen Styles oder Floorplan

Definition Erläuterungen Aussehen
define lcDropDown meineLightScene:!state Für die LightScene meineLightScene soll ein DropDown-Menü zur Auswahl der Szene erstellt werden.
attr lcDropDown commands { state => 'scene:' } Die Anzeige des state Readings wird auf das DropDown-Menü für das scene Kommando gemapped.
attr lcDropDown nonames 1 Keine Readingnamen
attr lcDropDown notime 1 Kein Timestamp

Schriftgrößen, Farben, Icons

Definition Erläuterungen
Schriftgröße, Farbe, Icons...
define Verbrauch readingsGroup TYPE=PCA301:state,power,consumption Die readings state, power und consumption aller PCA301 Devices mit einer Zeile pro Device.
attr Verbrauch mapping %ROOM %ALIAS Der Raumname und der Alias werden als Zeilentitel verwendet
attr Verbrauch nameStyle style="font-weight:bold" Der Zeilentitel soll fett sein
attr Verbrauch style style="font-size:20px" Alles in einem größeren Font
attr Verbrauch valueFormat {power => "%.1f W", consumption => "%.2f kWh"} Die Formatierung für die power und consumption readings: eine Nachkommastelle plus Einheit.
attr Verbrauch valueIcon { state => '%devStateIcon' } Für die Dosen, die schaltbar sind, soll das anklickbare device icon gezeigt werden.
attr Verbrauch valueStyle {($READING eq "power" && $VALUE > 40)?'style="color:red"':'style="color:green"'} Wenn das power reading >40 ist, soll es in rot angezeigt werden, alle anderen Werte und readings in grün

Wertabhängige Farbgebung

Definition Erläuterungen
Wertabhängige Farben
Andere Werte - andere Farben
define wzTemperaturenRG readingsGroup Aussen:,<Temperatur>,temperature,<Luftfeuchte>,humidity Wohnzimmer:,<Temperatur>,temperature,<Luftfeuchte>,humidity Kasten_E_Geraete:,<Temperatur>,temperature,<Luftfeuchte>,humidity Die readings temperatur und humidity der Devices Aussen, Wohnzimmer und Kasten_E_Geraete in einer Zeile pro Device.
attr wzTemperaturenRG group 3. Temperaturen Die readingsGroup kommt in eine Gruppe
attr wzTemperaturenRG noheading 1 noheading
attr wzTemperaturenRG nostate 1 nostate
attr wzTemperaturenRG notime 1 notime
attr wzTemperaturenRG valueFormat {temperature => "%.1f °C", humidity =>"%.1f %%" } Die Formatierung für die temperatur und humidity readings: eine Nachkommastelle plus Einheit.
attr wzTemperaturenRG valueStyle { if($DEVICE eq "Aussen" && $READING eq "temperature" && $VALUE > 30) { 'style="color:red"'}elsif($DEVICE eq "Aussen" && $READING eq "temperature" && $VALUE > 20) { 'style="color:orange"'}elsif($DEVICE eq "Aussen" && $READING eq "temperature" && $VALUE < 5) { 'style="color:blue"'}elsif($DEVICE eq "Wohnzimmer" && $READING eq "temperature" && $VALUE > 23) { 'style="color:red"'}elsif($DEVICE eq "Wohnzimmer" && $READING eq "temperature" && $VALUE > 21) { 'style="color:orange"'}elsif($DEVICE eq "Wohnzimmer" && $READING eq "temperature" && $VALUE < 20) { 'style="color:blue"'}elsif($DEVICE eq "Kasten_E_Geraete" && $READING eq "temperature" && $VALUE > 30) { 'style="color:red"'}elsif($DEVICE eq "Kasten_E_Geraete" && $READING eq "temperature" && $VALUE > 28) { 'style="color:orange"'}elsif($READING eq "humidity" && $VALUE > 65) { 'style="color:red"'}elsif($READING eq "humidity" && $VALUE > 60) { 'style="color:orange"'}else{'style="color:green"'} } Diverse Farbkombinationen sind möglich

Enigma Receiver

Definition Erläuterungen
Wertabhängige Farben
Wertabhängige Farben
define wzReceiverRG readingsGroup wzReceiver:,<Aktuell>,eventtitle,<Rest>,eventremaining_hr,<Dauer>,eventduration_hr wzReceiver:<Beschreibung>,eventdescription wzReceiver:,<Nächste>,eventtitle_next,<Start>,eventstart_next_hr,<Dauer>,eventduration_next_hr wzReceiver:,<HDD Kapazität>,hdd1_capacity,<Frei>,wzReceiver:hdd1_free wzReceiver:,<Lautstärke>,volume,<HDD>,hdd1_capacity,<Frei>,hdd1_free Mehrere readings des Device wzReceiver in mehreren Zeilen. Wenn der Receiver auf mute ist, wird anstatt der Lautstärke, mute angezeigt. Farbige Anzeige des freien Speicherplatzes

Benötigt: ENIGMA2 Receiver, 70_ENIGMA2.pm - Siehe: Enigma2 Receiver (Dreambox, VUplus etc.) steuern

attr wzReceiverRG group Fernseher Receiver Die readingsGroup kommt in eine Gruppe
attr wzReceiverRG mapping &nbsp; mapping wird auf &nbsp; (Leerzeichen) gesetzt, damit der Device Name nicht angezeigt wird
attr wzReceiverRG noheading 1 noheading
attr wzReceiverRG nostate 1 nostate
attr wzReceiverRG notime 1 notime
attr wzReceiverRG valueColumns { eventdescription => 'colspan="4"' } Die Beschreibung soll über 4 Spalten gehen
attr wzReceiverRG valueFormat { wzReceiverRGvalueFormat($DEVICE,$READING,$VALUE);; } Die Formatierung wird in die 99_myUtils.pm ausgelagert. Siehe: 99 myUtils anlegen
attr wzReceiverRG valueStyle { if($READING eq "hdd1_free" && $VALUE < 200){ 'style="color:red"' }elsif( $READING eq "hdd1_free" && $VALUE < 500 ){ 'style="color:orange"' }elsif( $READING eq "volume" && ReadingsVal($DEVICE, "mute", "") eq "on" ){ 'style="color:red"' }else{ 'style="color:green"' } } Diverse Farbkombinationen sind möglich. Wenn der Receiver auf mute ist, wird anstatt der Lautstärke mute angezeigt.
sub wzReceiverRGvalueFormat($$$)
{
  my ($DEVICE,$READING,$VALUE) = @_;

  if($READING eq 'hdd1_capacity') { 
    return "%.2f MB";
  } elsif( $READING eq 'hdd1_free') {
    return "%.2f MB";
  } elsif( $READING eq 'volume' ) {
    if( ReadingsVal($DEVICE, "mute", "") eq "on") {
      return "mute";
    } else {
      return "%i %%";
    }
  }
}
Dieser Teil kommt in die 99_myUtils.pm

Heizungswerte inklusive Batterie- und Fensterstatus

Definition Erläuterungen
Heizungswerte inklusive Batterie- und Fensterstatus
define Heizungswerte readingsGroup <%sani_heating>,< >,<Act>,<Soll>,<Ist> TYPE=FHT:actuator,desired-temp,measured-temp,<%18>,<%20>,<%22>,window,battery Diverse readings aller Devices des Typs FHT.
attr Heizungswerte commands { 'Heizungswerte.18' => 'set $DEVICE desired-temp 18', 'Heizungswerte.20' => 'set $DEVICE desired-temp 20', 'Heizungswerte.22' => 'set $DEVICE desired-temp 22' } Die Links/Kommandos die hinter den 18, 20 und 22 liegen sollen.
attr Heizungswerte nameStyle style="color:yellow;font-weight:bold" Die Überschriften sollen gelb sein.
attr Heizungswerte valueIcon {'battery.ok' => 'batterie@lightgreen', 'battery.low' => 'batterie@red', 'window.closed' => 'fts_window_1w@lightgreen', 'window.open' => 'fts_window_1w_open@red'} Für den Batteriestand und den Zustand der Fenster sollen jeweils Icons angezeigt werden.

Heizungswerte inklusive Ventilposition

Definition Erläuterungen
Heizungswerte inklusive Statusinformationen (MAX!)
define Heizungswerte readingsGroup <%sani_heating>,<Ventil>,<Soll>,<Ist>,<MaxV>,<GID>,<Mode>,<Batterie> TYPE=CUL_HM:ValvePosition,desired-temp,measured-temp,R-valveMaxPos,groupid,mode,battery Diverse readings aller Devices des Typs MAX.
attr Heizungswerte mapping %ROOM Die Raumnamen werden angezeigt.
attr Heizungswerte nameStyle style="color:yellow;font-weight:bold" Die Überschriften sollen gelb (fett) sein.
attr Heizungswerte room Heizung Die "readingsgroup" wird dem Raum "Heizung" zugeordnet.
attr Heizungswerte valueFormat {'temperature' => "%.0f °C", 'desiredTemperature' => "%.0f °C", 'valveposition' =>"%.0f %%", 'maxValveSetting' =>"%.0f %%" } Es wird noch die Einheit °C hinter den Temperaturwerten angezeigt.
attr Heizungswerte valueIcon {'battery.ok' => 'batterie@lightgreen', 'battery.low' => 'batterie@red'} Für den Batteriezustand werden Icons anstatt Klartextwerte genommen!
attr Heizungswerte valueStyle { if($READING eq "temperature" && $VALUE > 20){ 'style="color:green;;font-weight:bold"' }elsif( $READING eq "temperature" && $VALUE <= 20 ){ 'style="color:blue"' }elsif( $READING eq "temperature" && $VALUE > 23 ){ 'style="color:red"' }else{ 'style="color:gray"' } } Die Temperaturwerte werden abhängig vom Wert farbig dargestellt.
attr Heizungswerte valueIcon {'battery.ok' => 'batterie@lightgreen', 'battery.low' => 'batterie@red', 'window.closed' => 'fts_window_1w@lightgreen', 'window.open' => 'fts_window_1w_open@red'} Für den Batteriestand und den Zustand der Fenster sollen jeweils Icons angezeigt werden.

Heizungswerte, Status und Regelmöglichkeit

Definition Erläuterungen
Anzeige + Regelmöglichkeit
define Heizungswerte2 readingsGroup <%sani_heating>,< >,<Act>,<Soll>,<Ist> TYPE=FHT:actuator,desired-temp,measured-temp,<{myUtils_HeizungUpDown($DEVICE,"up")}@desired-temp>,desired-new,<{myUtils_HeizungUpDown($DEVICE,"down")}@desired-temp>,window,battery Diverse readings aller Devices des Typs FHT.
attr Heizungswerte2 nameStyle style="color:yellow;font-weight:bold" Die Überschriften sollen gelb sein.
attr Heizungswerte2 valueIcon {'battery.ok' => 'batterie@lightgreen', 'battery.low' => 'batterie@red', 'window.closed' => 'fts_window_1w@lightgreen', 'window.open' => 'fts_window_1w_open@red'} Für den Batteriestand und den Zustand der Fenster sollen jeweils Icons angezeigt werden.
attr Heizungswerte2 valueStyle {($VALUE eq "00")?'style="visibility:hidden"':} Nach dem Einstellen den Wert wieder ausblenden.
#Heizung regeln in readingsGroup
 sub
 myUtils_HeizungUpDown($$)
 {
   my($DEVICE,$CMD) = @_;
  
   my $icon = $CMD;
   my $VALUE = ReadingsVal($DEVICE,"desired-new","20" );
   $VALUE = ReadingsVal($DEVICE,"desired-temp","20" )
      if( !$VALUE || $VALUE == 0 );
   my $link;
  
   if( $CMD eq "up" ) {
     $icon = "control_arrow_upward";
     $VALUE += 1;
  
     if( $VALUE <= 24 ) {
       $icon .= "\@red";
       $link = "setreading $DEVICE desired-new $VALUE";
     }
   } elsif( $CMD eq "down" ) {
     $icon = "control_arrow_downward";
     $VALUE -= 1;
  
     if( $VALUE >= 18 ) {
       $icon .= "\@blue";
       $link = "setreading $DEVICE desired-new $VALUE";
     }
   }
  
   my $notify = "notifyHeizungUpDown";
   if( !defined($defs{$notify}) ) {
     CommandDefine(undef,
                    "$notify notify .*:desired-new.* "
                    ."{ myUtils_HeizungUpDownNotify(\$NAME,\$EVTPART1); }" );
   }
  
   my $ret = "%$icon";
   $ret .= "%$link" if( $link );
  
   return $ret;
 }
 sub
 myUtils_HeizungUpDownNotify($$)
 {
   my($DEVICE,$VALUE) = @_;
  
   return if( $VALUE == 0 );
  
   my $at = "triggerHeizungUpDown_$DEVICE";
   CommandDelete(undef, $at) if( defined($defs{$at}) );
   CommandDefine(undef,
                  "$at at +00:00:03 "
                  ."{my \$v = ReadingsVal(\"$DEVICE\",\"desired-new\",undef);"
                  ."fhem(\"set $DEVICE desired-temp \$v\") if( \$v );"
                  ."fhem(\"setreading $DEVICE desired-new 00\");}" );
  
   return undef;
 }
Dieser Teil kommt in die 99_myUtils.pm: Hiermit werden die Icons zum Ändern der gewünschten Temperatur dargestellt und im Bereich >=18 und <= 24 Grad anklickbar gemacht. Zwischen den Pfeilen wird der gerade eingestellte Wert angezeigt. Wenn dieser drei Sekunden nicht mehr geändert wurde wird die desired-temp auf diesen Wert gesetzt und die Anzeige zwischen den Pfeilen ausgeblendet.

Heizungswerte, Status, Steuerung und Wochenprofil

Dieses Beispiel funktioniert nur mit HomeMatic HM-CC-RT-DN, für andere Thermostate müssen an diversen Stellen Änderungen vorgenommen werden.

Todo: Überarbeiten
Definition Erläuterungen
Status, Steuerung und Wochenprofil
set d_label Heizung Heizung 
set d_label Temperatur Temperatur 
set d_label  Status Status 
set d_label Wochenplan Wochenplan 
set d_label Werktag Werktag 
set d_label Samstag Samstag 
set d_label Sonntag Sonntag 
set d_label Zeitraum1 Zeitraum 1 
set d_label Zeitraum2 Zeitraum 2 
Erzeugen der Readings im Device d_label.

define rg_thermostate readingsGroup <>,Heizung@d_label,<|>,Temperatur@d_label,<|>,Status@d_label,<|>,Wochenplan@d_label,<|>,Werktag@d_label,<|>,Samstag@d_label,<|>,Sonntag@d_label,<|>,<> CUL_HM_HM_CC_RT_DN_......_Clima:<>,?alias,<|>,<Soll>,desired-temp,<Tag>,dayTemp@{rg($DEVICE."§clima")},impossible@{$DEVICE},<|>,controlMode,R-globalBtnLock@{rg($DEVICE."§device")},<|>,Zeitraum1@d_label,<|>,workday_period_1_start@{rg($DEVICE."§clima")},workday_period_1_stop@{rg($DEVICE."§clima")},<|>,saturday_period_1_start@{rg($DEVICE."§clima")},saturday_period_1_stop@{rg($DEVICE."§clima")},<|>,sunday_period_1_start@{rg($DEVICE."§clima")},sunday_period_1_stop@{rg($DEVICE."§clima")},<|>,impossible@{$DEVICE},<%system_fhem_update>,<br>,state@{rg($DEVICE."§device")},<%getConfig>,<|>,<Ist>,measured-temp,<Nacht>,nightTemp@{rg($DEVICE."§clima")},<|>,<Ventil>,ValvePosition,<|>,Zeitraum2@d_label,<|>,workday_period_2_start@{rg($DEVICE."§clima")},workday_period_2_stop@{rg($DEVICE."§clima")},<|>,saturday_period_2_start@{rg($DEVICE."§clima")},saturday_period_2_stop@{rg($DEVICE."§clima")},<|>,sunday_period_2_start@{rg($DEVICE."§clima")},sunday_period_2_stop@{rg($DEVICE."§clima")},<|>,impossible@{$DEVICE},impossible@{rg($DEVICE."§device")},<%burstXmit>

Diverse readings aller Devices CUL_HM_HM_CC_RT_DN_......_Clima, entsprechender d_climaControl (müssen vorher angelegt werden) und d_label.
attr rg_thermostate commands { 'desired-temp' => 'desired-temp:', 'dayTemp' => 'dayTemp:', 'controlMode' => 'trigger ntfy_rg $DEVICE controlMode', 'R-globalBtnLock' => 'trigger ntfy_rg $DEVICE globalBtnLock', 'workday_period_1_start' => 'workday_period_1_start:', 'workday_period_1_stop' => 'workday_period_1_stop:', 'saturday_period_1_start' => 'saturday_period_1_start:', 'saturday_period_1_stop' => 'saturday_period_1_stop:', 'sunday_period_1_start' => 'sunday_period_1_start:', 'sunday_period_1_stop' => 'sunday_period_1_stop:', 'rg_thermostate.system_fhem_update' => 'trigger ntfy_rg $DEVICE setTimeTable', 'rg_thermostate.getConfig' => 'set $DEVICE getConfig', 'nightTemp' => 'nightTemp:', 'workday_period_2_start' => 'workday_period_2_start:', 'workday_period_2_stop' => 'workday_period_2_stop:', 'saturday_period_2_start' => 'saturday_period_2_start:', 'saturday_period_2_stop' => 'saturday_period_2_stop:', 'sunday_period_2_start' => 'sunday_period_2_start:', 'sunday_period_2_stop' => 'sunday_period_2_stop:', 'rg_thermostate.burstXmit' => 'set $DEVICE burstXmit'} Temperaturen werden als DropDown Auswahl dargestellt, Icons triggern ntfy_rg
attr rg_thermostate mapping { 'desired-temp' => , 'dayTemp' => , 'workday_period_1_start' => , 'workday_period_1_stop' => , 'saturday_period_1_start' => , 'saturday_period_1_stop' => , 'sunday_period_1_start' => , 'sunday_period_1_stop' => , 'nightTemp' => , 'workday_period_2_start' => , 'workday_period_2_stop' => , 'saturday_period_2_start' => , 'saturday_period_2_stop' => , 'sunday_period_2_start' => , 'sunday_period_2_stop' => } Ausblenden der Texte vor den DropDowns.

attr rg_thermostate nameStyle{($READING eq "Soll" ||$READING eq "Tag" ||$READING eq "%getConfig" ||$READING eq "Ist" ||$READING eq "Nacht" ||$READING eq "Ventil" )?'style="text-align:right"' :($READING eq "%burstXmit" )?'style="text-align:center"' :'style=""'}

Ausrichten der Überschriften die keine readings sind.
attr rg_thermostate nonames 1 Ausblenden der Device Namen.
attr rg_thermostate valueColumns { 'Heizung' => 'colspan="2"', 'Temperatur' => 'colspan="4"', 'Status' => 'colspan="2"', 'Werktag' => 'colspan="2"', 'Samstag' => 'colspan="2"', 'Sonntag' => 'colspan="2"', 'alias' => 'colspan="2"'} Diverse Readings sollen über mehrere Spalten dargestellt werden.
attr rg_thermostate valueFormat { 'measured-temp' => "%0.1f °C", 'ValvePosition' => "%0.1f %%"} Formatierung für measured-temp und ValvePosition.
attr rg_thermostate valueIcon { 'controlMode.auto' => 'sani_heating_automatic@green', 'controlMode.set_auto' => 'sani_heating_automatic@orange', 'controlMode.manual' => 'sani_heating_manual@red', 'controlMode.set_manual' => 'sani_heating_manual@orange', 'R-globalBtnLock.on' => 'secur_locked@green', 'R-globalBtnLock.on ' => 'secur_locked@green', 'R-globalBtnLock.set_on ' => 'secur_locked@orange', 'R-globalBtnLock.off' => 'secur_open@red', 'R-globalBtnLock.off ' => 'secur_open@red', 'R-globalBtnLock.set_off ' => 'secur_open@orange'} Zuweisung der Icons.

attr rg_thermostate valueStyle{($READING eq "Heizung" ||$READING eq "Temperatur" ||$READING eq "Status" ||$READING eq "Wochenplan" ||$READING eq "Werktag" ||$READING eq "Samstag" ||$READING eq "Sonntag" )?'style="font-size:20px;;color:RoyalBlue;;text-align:center"' :($READING eq "alias" )?'style="font-size:11px;;font-weight:bold;;text-align:left"' :($READING eq "ValvePosition" &&$VALUE > 40 )?'style="font-weight:bold;;color:Orange;;text-align:left"' :($READING eq "desired-temp" ||$READING eq "measured-temp" )?'style="text-align:center"' :($READING eq "state" ||$READING eq "ValvePosition" )?'style="text-align:left"' :'style="text-align:right"'}

Ausrichten und Einfärben der Readings.


Heizungsteuerung für HM Wand- und Heizkörperthermostate

Dieses Beispiel wurde für HM-TC-IT-WM-W-EU / HM-CC-RT-DN Geräte erstellt. Verwendung anderer Thermostate wird ggf. Anpassungen erforderlich machen. Die Geräte werden nicht automatisch ermittelt, sondern sind einzeln angegeben. Es werden Soll- und Ist-Temperaturen angezeigt, Luftfeuchte und Ventilpositionen, Modus, Batterie und Global-Tastenlock. Steuerungsmöglichkeiten: Solltemperatur, Modus (Manual/Automatik), (globale) Tastenlock. Die Abweichung der Isttemperatur, die Ventilpositionen, Batteriestand etc. werden farblich hervorgehoben.

Die Gerätenamen (EG_WZ_WT01_Climate / EG_WZ_WT01, EG_WZ_TT01_Clima / EG_WZ_TT01 / EG_WZ_TT02, OG_BZ_WT01_Climate / OG_BZ_WT01, OG_BZ_TT01_Clima / OG_BZ_TT01, OG_SZ_WT01_Climate / OG_SZ_WT01, OG_SZ_TT01_Clima / OG_SZ_TT01, OG_DZ_WT01_Climate / OG_DZ_WT01, OG_DZ_TT01_Clima / OG_DZ_TT01) müssen natürlich entsprechend angepasst werden.

Definition Erläuterungen
Status, Steuerung und Wochenprofil
define heatingInfo readingsGroup <%sani_heating>,<Soll>,<Soll neu>,<Ist>,<Ventil / RH>,<Modus>,<Lock>,<Bat>\

EG_WZ_WT01_Climate:desired-temp,<sollsetz>,measured-temp,humidity,controlMode,R-globalBtnLock@EG_WZ_WT01,batteryLevel@EG_WZ_WT01 \
EG_WZ_TT01_Clima:desired-temp,<>,measured-temp,ValvePosition,controlMode,R-globalBtnLock@EG_WZ_TT01,batteryLevel@EG_WZ_TT01 \
EG_WZ_TT02_Clima:desired-temp,<>,measured-temp,ValvePosition,controlMode,R-globalBtnLock@EG_WZ_TT02,batteryLevel@EG_WZ_TT02 \
<>,<>,<>,<>,<>,<>,<>,<> \
OG_BZ_WT01_Climate:desired-temp,<sollsetz>,measured-temp,humidity,controlMode,R-globalBtnLock@OG_BZ_WT01,batteryLevel@OG_BZ_WT01 \
OG_BZ_TT01_Clima:desired-temp,<>,measured-temp,ValvePosition,controlMode,R-globalBtnLock@OG_BZ_TT01,batteryLevel@OG_BZ_TT01 \
<>,<>,<>,<>,<>,<>,<>,<> \
OG_SZ_WT01_Climate:desired-temp,<sollsetz>,measured-temp,humidity,controlMode,R-globalBtnLock@OG_SZ_WT01,batteryLevel@OG_SZ_WT01 \
OG_SZ_TT01_Clima:desired-temp,<>,measured-temp,ValvePosition,controlMode,R-globalBtnLock@OG_SZ_TT01,batteryLevel@OG_SZ_TT01 \
<>,<>,<>,<>,<>,<>,<>,<> \
OG_DZ_WT01_Climate:desired-temp,<sollsetz>,measured-temp,humidity,controlMode,R-globalBtnLock@OG_DZ_WT01,batteryLevel@OG_DZ_WT01 \
OG_DZ_TT01_Clima:desired-temp,<>,measured-temp,ValvePosition,controlMode,R-globalBtnLock@OG_DZ_TT01,batteryLevel@OG_DZ_TT01

ReadingsGoup anlegen.
attr heatingInfo cellStyle { "r:1"=>'style="font-weight:bold;;font-size:16px"',

"r:2,c:0"=>'style="font-weight:bold"',"r:6,c:0" =>'style="font-weight:bold"',
"r:9,c:0"=>'style="font-weight:bold"',"r:12,c:0"=>'style="font-weight:bold"'}

Schrift fett setzen etc.
attr heatingInfo commands {

'heatingInfo.sollsetz'=>'desired-temp:5.0,12.0,18.0,19.0,20.0,20.5,21.0,21.5,22.0,22.5,23.0,23.5,24.0',
"controlMode.manual"=>"set %DEVICE controlMode auto","controlMode.auto"=>"set %DEVICE controlMode manual",
"R-globalBtnLock.on"=>"set %DEVICE regSet globalBtnLock off",
"R-globalBtnLock.off"=>"set %DEVICE regSet globalBtnLock on"}

Heizungssteuerung ermöglichen

attr heatingInfo mapping {OG_BZ_WT01_Climate=>"Bad",
OG_BZ_TT01_Clima=>"&nbsp;;&nbsp;;&nbsp;;Regler",OG_SZ_WT01_Climate=>"Schlafzimmer",
OG_SZ_TT01_Clima=>"&nbsp;;&nbsp;;&nbsp;;Regler",OG_DZ_WT01_Climate=>"Duschbad",
OG_DZ_TT01_Clima=>"&nbsp;;&nbsp;;&nbsp;;Regler",EG_WZ_WT01_Climate=>"Wohnzimmer",
EG_WZ_TT01_Clima=>"&nbsp;;&nbsp;;&nbsp;;Regler1",EG_WZ_TT02_Clima=>"&nbsp;;&nbsp;;&nbsp;;Regler2",'desired-temp' => }

Gewünschte Namen definieren.

attr heatingInfo valueFormat {if($READING eq "ValvePosition" && $VALUE ne "0"){$VALUE = int($VALUE/10)*10}
elsif($READING eq "batteryLevel"){if($VALUE>=3){$VALUE=100}
elsif($VALUE>=2.7){$VALUE=75}elsif($VALUE>=2.5){$VALUE=50}elsif($VALUE>=2.2){$VALUE=25}
else{$VALUE=0}}}

Werte vorformatieren (für die Icon-Zuordnung).

attr heatingInfo valueIcon {'controlMode.manual' => 'sani_heating_manual@795CFF',
'controlMode.auto' => 'sani_heating_automatic@FFC13A', 'controlMode.boost' => 'sani_heating_boost@FB0C02',
'humidity'=>'humidity@6FD9FB', 'R-globalBtnLock.on'=>'secur_locked@F7301D',
'R-globalBtnLock.off'=>'secur_open@0CFB0C','ValvePosition.0' => 'sani_heating_level_0@002AE0',
'ValvePosition.10' => 'sani_heating_level_10@F8D53D','ValvePosition.20' => 'sani_heating_level_20@FF9341',
'ValvePosition.30' => 'sani_heating_level_30@F17F3F','ValvePosition.40' => 'sani_heating_level_40@E46C3C',
'ValvePosition.50' => 'sani_heating_level_50@DE3B3A','ValvePosition.60' => 'sani_heating_level_60@A30D2D',
'ValvePosition.70' => 'sani_heating_level_70@B40A23','ValvePosition.80' => 'sani_heating_level_80@C40619',
'ValvePosition.90' => 'sani_heating_level_90@D4030F','ValvePosition.100' => 'sani_heating_level_100@E50005',
'batteryLevel.100'=>'measure_battery_100@0CFB0C','batteryLevel.75'=>'measure_battery_75@42BC0A',
'batteryLevel.50'=>'measure_battery_50@F5FF10','batteryLevel.25'=>'measure_battery_25@FB5909',
'batteryLevel.0'=>'measure_battery_0@E50005','controlMode.set_boost' => 'hourglass',
'controlMode.set_auto' => 'hourglass','controlMode.set_manual' => 'hourglass',
'R-globalBtnLock.set_on' => 'hourglass','R-globalBtnLock.set_off' => 'hourglass'}

Icons zuordnen.

attr heatingInfo valueStyle {if($READING eq "measured-temp")
{my $t=$VALUE;;my $d=ReadingsVal($DEVICE,'desired-temp',0);;
if($t-$d>=1){'style="color:rgb(251,63,11);;"'}elsif($t-$d<=-1){'style="color:rgb(79,58,251);;"'}
else{'style="color:rgb(12,251,12);;"'}}}

Farben (zu kalt: blau, zu warm: rot, ok: grün).

attr heatingInfo valueSuffix {"desired-temp"=>" °C", "measured-temp"=>" °C",
"ValvePosition"=>" (".ReadingsVal($DEVICE,$READING,0)." %)",
"humidity"=>" ".ReadingsVal($DEVICE,$READING,0)." % RH",
"batteryLevel"=>" (".ReadingsVal($DEVICE,$READING,0)." V)"}

Messeinheiten und Zahlenwerte.

Readings aus zusätzlichen Devices

Im folgenden Beispiel wird gezeigt wie sich Readings zusätzlicher Devices zu einer Zeile mit mehreren Readings hinzufügen lassen. Diese zusätzlichen Devices können z.b. die unterschiedlichen Channel eines HomeMatic Gerätes sein. Im folgenden Beispiel wird der Name des zugehörigen Geräts dynamisch bestimmt.

Definition Erläuterungen
Anzeige + Regelmöglichkeit
define myTemp readingsGroup <Raum>,<Tist>,<Tsoll>,<Mode>,<Tnight>,<Tday>,<Hum>,<BatTC>,<Vist>,<Vsoll>,<Verr>,<BatVD> Thermostat.(WZ|OZ|AZ|Bad|Kueche|SZ|GZ|Bad.OG):measured-temp,desired-temp,controlMode,night-temp,day-temp,humidity,battery,ValvePosition@{valveOfDevice($DEVICE)},ValveDesired@{valveOfDevice($DEVICE)},R-valveErrorPos@{valveOfDevice($DEVICE)},battery@{valveOfDevice($DEVICE)} Broetje:ToutIst Diverse Readings aller Thermostat Devices und des jeweils zugehörigen Ventilantriebs.
attr myTemp mapping { 'Broetje' => 'Garten','Thermostat.AZ' => 'EG Arbeitszimmer','Thermostat.SZ' => 'OG Schlafzimmer','Thermostat.WZ'=>'EG Wohnzimmer','Thermostat.Kueche' => 'EG Küche','Thermostat.GZ' => 'OG Gästezimmer','Thermostat.Bad' => 'EG Bad','Thermostat.Bad.OG' => 'OG Bad','Thermostat.OZ' => 'EG Kaminzimmer','desired-temp' => '' } Die Benennung der Zeilentitel (Das ist je nach Konfiguration auch über $ALIAS und/oder $ROOM lösbar).
attr myTemp commands { 'desired-temp' => 'desired-temp:' } desired-temp soll per dropDown einstellbar sein.
attr myTemp nameStyle style="color:yellow" Die Überschriften sollen gelb sein.
attr myTemp valueIcon {'battery.ok' => 'batterie@lightgreen', 'battery.low' => 'batterie@red'} Für den Batteriestand sollen jeweils Icons angezeigt werden.
attr myTemp valueFormat { 'measured-temp' => "%0.1f &deg;C",'ToutIst' => "%.1f &deg;C",'night-temp' => "%.1f &deg;C",'day-temp' => "%.1f &deg;C",'humidity' => "%.0f

%%",'ValvePosition' => "%.0f %%",'ValveDesired' => "%.0f %%",'R-valveErrorPos' => "%.0f %%" }

Die Formatierung der Werte.
#namen des ventil device aus thermostat device ableiten
sub valveOfDevice ($) {
  my ($DEVICE) = @_;
 
  if ($DEVICE =~ m/AZ/) {
 	return "Ventil.".substr($DEVICE,11).".Nord";
  } else {
 	return "Ventil.".substr($DEVICE,11);  	
  }
}
Dieser Teil kommt in die 99_myUtils.pm: Hier wird aus dem Namen des Thermostaten der Name des zugehörigen Ventilantriebs abgeleitet.

Da im {...} Teil des <reading>@<device> Arguments keine Leerzeichen oder Kommas vorkommen dürfen ist er in der Regel das Einfachste die Funktionalität wie in diesem Beispiel in eine eigene Routine auszulagern. Mit ein paar 'Tricks' lässt es sich aber manchmal auch ohne Leerzeichen oder Kommas lösen und dann direkt in die Definition schreiben:...,ValvePosition@{$DEVICE=~s/Thermostat/Ventil/;$DEVICE;},...

Dynamische Inhalte

readingsGroup mit umschaltbarem Inhalt 1
readingsGroup mit umschaltbarem Inhalt 2

Es ist möglich, den in einer readingsGroup dargestellten Inhalt dynamisch von zusätzlichen Bedingungen abhängig zu machen. Im folgenden Beispiel lässt sich einstellen, dass nur die Devices angezeigt werden, die einen bestimmten Zustand (hier: on/off, open/tilted/closed) haben. Hier wird zum Umschalten ein dummy, der direkt über der readingsGroup dargestellt wird, verwendet. Über das links und/oder commands lässt sich auch eine Darstellung erzeugen, bei der das Umschalten direkt innerhalb der readingsGroup möglich ist.

define LXrg dummy
attr LXrg group -
attr LXrg setList mode1:on,off mode2:open,closed,tilted
attr LXrg stateFormat 1=mode1 2=mode2
attr LXrg webCmd mode1:mode2

define rg readingsGroup Window.*:state Light.*:state
attr rg group -
attr rg valueFormat { return $VALUE if ( $VALUE eq ReadingsVal("LXrg","mode1","") || $VALUE eq ReadingsVal("LXrg","mode2","") );; return undef;;}

define Watch_LX notify LX.*:.* {my $value = ReadingsVal($NAME,'state','');;;;fhem("setreading $NAME $value")}

Enable/Disable Button am Beispiel eines WeekdayTimer

Dieses Beispiel zeigt die Anwendung einer readingsGroup, um im Frontend einen Enable/Disable Button für ein Objekt darzustellen. Für den WeekdayTimer gibt es hier spezielle Erweiterungen (set Routinen, um das Attribut disable zu setzen). Es gibt aber auch eine allgemeinere Variante (siehe diesen Forumsbeitrag) für alle Objekte, die das Fhem Attribut disable unterstützen.

Definition Erläuterungen
Enable/Disable Button
define rg_Timer_Wasser readingsGroup timer_Wasser_..:disabled,+DEF,<{rg_timer_Wasser_show_conditional($DEVICE,"nextUpdate")}@disabled>,<{rg_timer_Wasser_show_conditional($DEVICE,"nextValue")}@disabled> Definition der angezeigten Readings. Das Attribut disabled wird mit weiteren Einstellungen (commands) zum Button, +DEF zeigt die Definition, d.h. die Schaltzeiten, des Timers an. Die Readings nextUpdate und nextValue sollen nur angezeigt werden, falls der Timer aktiv ist. Hierfür sorgt eine Routine rg_timer_Wasser_show_conditional, die in der 99_myUtils.pm definiert wird. Das abschließende @disabled sorgt dafür, dass der LongPoll Mechanismus die Anzeige sofort ändert, wenn der Button betätigt wird.
attr rg_Timer_Wasser valueFormat { if ( $READING =~ m/.*DEF/ ) { my @text = split(" ", $VALUE); shift @text; return join(" ", @text) }} Der Name des Timers wird aus dem Internal "+DEF" vorne abgeschnitten. Damit werden nur die definierten Schaltpunkte angezeigt.
attr rg_Timer_Wasser valueIcon { 'disabled.0' => 'Restart', 'disabled.1' => 'Shutdown' } Die beiden Zustände für den Button werden durch zwei Standard-Icons angezeigt.
attr rg_Timer_Wasser commands { 'disabled.0' => 'set $DEVICE disable', 'disabled.1' => 'set $DEVICE enable' } Toggle-Funktion für den Button. Wenn der Timer aktiv ("disabled.0") sorgt ein Klick auf den Button, dass der Timer deaktiviert wird ("set $DEVICE disable").
 sub rg_timer_Wasser_show_conditional($$)
 {
   my ($DEVICE,$READING) = @_;
   return ( ReadingsVal($DEVICE, "disabled", "1") eq "0" )? 
      ReadingsVal($DEVICE, $READING, "reading_undef") : "disabled";
 }
Dieser Teil kommt in die 99_myUtils.pm: Hiermit wird das übergebene Reading des Timers nur angezeigt, wenn der Timer aktiv ist. Andernfalls wird der String "disabled" angezeigt.

Ändern von Attributen: Noch ein WeekdayTimer Beispiel

Emblem-question-yellow.svgDieses Beispiel benutzt Funktionen, die erst ab Modulversion 8761/16.6.2015 verfügbar sind.

Inzwischen ist es auch möglich das commands Mapping auf Attribute anzuwenden. Die Syntax ist die gleiche wie für die set Kommandos. Um das Beispiel übersichtlich zu halten werden hier die Werte und Icons auch für deaktiviert WeekdayTimer angezeigt.

Definition Erläuterungen
FhemWidget für das 'disable' Attribut
define rgTimer readingsGroup <>,<Current>,<Update-Time>,<New>,<disable> TYPE=WeekdayTimer:state,nextUpdate,nextValue,?!disable Definition der angezeigten Readings. Das Attribut disable wird mit weiteren Einstellungen (commands) zum Button. Durch das ! wird das Attribut auch dann angezeigt wenn es noch nicht gesetzt ist.
attr rgTimer valueIcon { state => '%devStateIcon', nextValue => '{(split(":",Color::devStateIcon($DEVICE,"dimmer",undef,"nextValue")))[1]}' } Für den aktuellen Zustand wird das devStateIcon angezeigt und für den nächsten Zustand das passende Lampen-Icon.
attr rgTimer_Wasser valueFormat '{(split(" ", $VALUE))[1]}' Vom nächsten Schaltpunkt wird nur die Zeit angezeigt.
attr rgTimer commands { disable => 'disable:' } Für das disable attribut wird das normale dropDown mit 0 und 1 angezeigt das auch in der Device Detail Ansicht verwendet wird.

Berechnungen

Emblem-question-yellow.svgDieses Beispiel benutzt Funktionen, die erst ab Modulversion 8761/16.6.2015 verfügbar sind.

Das Rechnen funktioniert über das Flag "$", mit dem eine Funktion angegeben werden kann, die auf beliebige Kombinationen von Zeilen, Spalten und einzelnen Zellen angewendet wird. Ähnlich wie in einer Tabellenkalkulation.

Ein Beispiel:

define rg readingsGroup .*:temperature rg:$avg

Damit wird eine readingsGroup über alle temperature Readings definiert. In einer zusätzlichen Zeile am Ende wird mit $avg der Durchschnittswert aller darüber liegenden Temperaturen angezeigt.

Das genaue Format: $<operator>[(<zellen>)] mit

  • <operator>: sum, avg, min, max, scalar, count oder der Name einer beliebigen anderen Funktion, die ein Array mit allen Werten übergeben bekommt und ein Ergebnis zurückliefert.
  • <zellen> ist eine durch Semikolon getrennte Liste aus <zeilen>:<spalten> Paaren.
  • <zeilen> und <spalten> sind jeweils eine Perl Liste, d.h. hier können
    • einzelne Werte,
    • durch Komma getrennte Aufzählungen,
    • mit .. angegebene Wertebereiche
    • sowie $ROW und $COLUMN als Bezeichner für die aktuelle Zelle
verwendet werden.

Alle Möglichkeiten sind kombinierbar. Die Zählung der Zeilen und Spalten beginnt bei 1. Eine nicht vorhandene Zeilenangabe wird durch den Bereich von Zeile 1 bis zur aktuellen Zeile ersetzt, eine nicht vorhandene Spalte durch die aktuelle Spalte.

Es ergeben sich somit unter anderem folgende Möglichkeiten:

  • $sum equivalent zu $sum(1..$ROW), $sum(:$COLUMN) und $sum(1..$ROW:$COLUMN) die Summe der Werte in der Spalte über der aktuellen Zelle.
  • $max($ROW:1..$COLUMN-1) Maximum aller Werte links von der aktuellen Zelle (in der aktuellen Zeile)
  • $avg(1..$ROW:1) Durchschnitt aller Werte in Spalte 1 bis zur aktuellen Zeile
  • $scalar(:1) Anzahl der Werte in Spalte 1
  • $min(1..5:1,2,4) Minimum der Werte aus den Zeilen 1-5 in den Spalten 1, 2 und 4

Eigene Funktionen lassen sich über 99_myUtils anlegen und z.B. verwenden um Häufigkeiten zu zählen oder mit nichtnumerischen Readings umzugehen.

Die Ergebnisse werden im Weiteren wie normale Readings behandelt. Sie lassen sich von links oben nach rechts unten kaskadieren und lassen sich über valuePrefix, valueSuffix, valueFormat und valueStyle in der Darstellung beeinflussen. Also z.B. einfärben, als Balkendiagramm darstellen, ...

Mit Hilfe der Funktionalität zum auf- und zu-klappen von Teilen einer readingsGroup lassen sich z.B. im zusammengeklappten Zustand Summen, Extremwerte oder andere Ausreißer anzeigen und die Details nur beim Aufklappen zeigen.

Weitere Möglichkeiten:

  • Attribut firstCalcRow: Hiermit kann der Default für die Nummer der ersten Zeile vorgegeben werden (sofern im Ausdruck nichts genaueres angegeben ist). firstCalcRow sollte z.B. auf 2 gesetzt werden, wenn in der readingsGroup Spaltenüberschriften verwendet werden.
  • special <hr> um eine horizontale Linie über die volle Breite einzufügen
  • Über ein angehängtes @<alias> kann einem Rechenergebniss ein Alias-Name gegeben werden. Über diesen kann der Wert dann zur Formatierung mit den value-Attributen angesprochen werden.
  • das alwaysTrigger Attribut kann jetzt auch den Wert 2 bekommen. Damit werden in der readingsGroup Readings für alle durch die Aggregation gebildeten Werte und entsprechende Events auch dann erzeugt wenn die readingsGroup nicht angezeigt wird. Wenn ein Alias-Name vergeben ist, wird dieser auch für den Reading-Namen verwendet.
  • Über den operator $count(<wert>)(<zellen>) um das Vorkommen von <wert> in den angegebenen Zellen zu zählen. <wert> kann enweder direkt der zu zählende Wert sein (ohne Anführungzeichen) oder eine in / eingeschlossene regex. Mit !<wert> kann das Nicht-Vorkommen von <wert> gezählt werden.

Ein interaktives Beispiel

Beispiel-readingsGroup mit Berechnungen

In drei dummy Objekten lässt sich jeweils ein Reading über einen Slider einstellen. In der darunter liegenden readingsGroup werden diese Readings und diverse daraus abgeleitete Werte dargestellt. Alle Readings und die daraus abgeleiteten Werte werden live per longpoll aktualisiert, wenn die slider bewegt werden.

  define t1 dummy
  attr t1 room rg
  attr t1 setList state:slider,-10,1,30
  attr t1 webCmd state
  define t2 dummy
  attr t2 room rg
  attr t2 setList state:slider,-10,1,30
  attr t2 webCmd state
  define t3 dummy
  attr t3 room rg
  attr t3 setList state:slider,-10,1,30
  attr t3 webCmd state

  define rg readingsGroup <>,<value>,<sum>,<min>,<max>,<avg>\
  t\d:+NAME,state,$sum(1..$ROW:2),$min(1..$ROW:2),$max(1..$ROW:2),$avg(1..$ROW:2)\
  <hr>\
  rg:<>,$scalar,$sum(:2)@SUM,$min(:2)@MIN,$max(:2)@MAX,$avg(:2)@AVG\
  <hr>\
  t1:<t1,t2,t3>,state,state@t2,state@t3,$sum($ROW:2..4)@SUM,$count(/\d/)(2..$ROW-4:2)\
 
  attr rg nonames 1
  attr rg room rg
  attr rg style style='text-align:center'
  attr rg valueFormat { 'avg' => '%.2f', 'AVG' => '%.2f' }
  attr rg valuePrefix { 'rg.scalar' => '#', 'rg.SUM' =>'Σ; ', 'rg.MIN' =>'Min: ', 'rg.MAX' =>'Max: ', 'rg.AVG' =>'∅; ', 'rg.count' => '#(X): ' }
  attr rg valueSuffix { state => '°;C' }

Links und Trigger

readingsGroup mit Link

readingsGroup mit Link

Das PCA301 Beispiel oben lässt sich mit einem ans Ende des define angehängten

<{appendTrigger($DEVICE,"clear","Alle löschen")}>

und der folgenden appendTrigger Definition in 99_myUtils.pm um einen Link erweitern, der ein Event auslöst, an das z.B. ein notify gehängt werden kann, um die Verbrauchszähler der PCA301 Dosen zurückzusetzen.

define clearVerbrauch notify Verbrauch:clear set TYPE=PCA301 clear
use vars qw($FW_ME);
use vars qw($FW_subdir);
sub
appendTrigger($$$)
{
  my ($name,$trigger,$label) = @_; 

  my $ret .= "</table></td></tr>";

  my $link = "cmd=trigger $name $trigger";
  my $txt = "<a onClick=\"FW_cmd('$FW_ME$FW_subdir?XHR=1&$link')\">$label</a>";
  $ret .= "<td colspan=\"99\"><div style=\"cursor:pointer;color:#888888;text-align:right\">$txt</div></td>";

  return ($ret,0);
}

wenn hierdurch Änderungen an einer readingsGroup erfolgen, die ein Neuladen der Seite erforderlich machen, kann dies so erfolgen:

{myUtils_refresh("WEB")}

mit folgendem code in 99_myUtils.pm:

sub                                                                                     
myUtils_refresh($)                                                                      
{                                                                                       
  my ($name) = @_;                                                                      
                                                                                        
  FW_directNotify("#FHEMWEB:$name", "location.reload(true);","" );
}


Ein weiteres Beispiel für 'custom links und trigger' findet sich in diesem Forenbeitrag: dort wird damit eine readingsGroup dynamisch umgeschaltet, um nur die eingeschalteten, nur die ausgeschalteten oder alle Lampen anzuzeigen.

sub rg

Damit beim klicken auf ein Icon oder einen Text in einer readingsGroup etwas passiert ist es möglich dies über das commands Attribut auf ein 'trigger ntfy_rg $DEVICE $READING' oder Ähnliches zu mappen. Anlegen des ntfy_rg notify

define ntfy_rg notify ntfy_rg {rg($EVENT)}

Folgender Code muss noch in de 99_myUtils.pm

sub rg($){
  my @input    = split(/[§\s]+/,shift);
  my $device   = $input[0];
  my $function = $input[1];

if($function eq "clima"){
  my $room =  AttrVal($device, 'room', 'undef');
  $room =~ s/\D//g;
  
  return(("d_climaControl_".$room));
}
elsif($function eq "device"){
  return InternalVal($device,"device","device error");
}
elsif($function eq "controlMode"){
  my $controlMode = ReadingsVal($device,"controlMode","controlMode error");

  if($controlMode ~~ /manual/)
    {fhem("set $device controlMode auto")}
  elsif($controlMode ~~ /auto/)
    {fhem("set $device controlMode manual")};
}
elsif($function eq "globalBtnLock"){
  my $globalBtnLock = ReadingsVal($device,"R-globalBtnLock","globalBtnLock error");

  if($globalBtnLock ~~ /off/){
    {fhem("set $device regSet globalBtnLock on")}
    {fhem ("set $device getConfig")}
  }
  elsif($globalBtnLock ~~ /on/){
    {fhem("set $device regSet globalBtnLock off")}
    {fhem ("set $device getConfig")}
  };
}
elsif($function eq "state"){
  my $state = Value($device);

  if($state ~~ /off/){
    {fhem("set $device on")}
  }
  elsif($state ~~ /on/){
    {fhem("set $device off")}
  };
}
elsif($function eq "setTimeTable"){
  my $room         =  AttrVal($device, 'room', 'undef');
  $room         =~ s/\D//g;
  my $climaControl = ("d_climaControl_".$room);
  my $dayTemp           = ReadingsVal( $climaControl, "dayTemp"          , 21.0    );
  my $nightTemp         = ReadingsVal( $climaControl, "nightTemp"        , 17.0    );
  my $workday_period_1_start  = ReadingsVal( $climaControl, "workday_period_1_start"  , "06:30" );
  my $workday_period_1_stop   = ReadingsVal( $climaControl, "workday_period_1_stop"   , "18:00" );
  my $workday_period_2_start  = ReadingsVal( $climaControl, "workday_period_2_start"  , "24:00" );
  my $workday_period_2_stop   = ReadingsVal( $climaControl, "workday_period_2_stop"   , "24:00" );
  my $saturday_period_1_start = ReadingsVal( $climaControl, "saturday_period_1_start" , "06:30" );
  my $saturday_period_1_stop  = ReadingsVal( $climaControl, "saturday_period_1_stop"  , "12:00" );
  my $saturday_period_2_start = ReadingsVal( $climaControl, "saturday_period_2_start" , "24:00" );
  my $saturday_period_2_stop  = ReadingsVal( $climaControl, "saturday_period_2_stop"  , "24:00" );
  my $sunday_period_1_start   = ReadingsVal( $climaControl, "sunday_period_1_start"   , "24:00" );
  my $sunday_period_1_stop    = ReadingsVal( $climaControl, "sunday_period_1_stop"    , "24:00" );
  my $sunday_period_2_start   = ReadingsVal( $climaControl, "sunday_period_2_start"   , "24:00" );
  my $sunday_period_2_stop    = ReadingsVal( $climaControl, "sunday_period_2_stop"    , "24:00" );

  {fhem("set $device tempListMon prep $workday_period_1_start  $nightTemp $workday_period_1_stop  $dayTemp $workday_period_2_start  $nightTemp $workday_period_2_stop  $dayTemp 24:00 $nightTemp")};
  {fhem("set $device tempListTue prep $workday_period_1_start  $nightTemp $workday_period_1_stop  $dayTemp $workday_period_2_start  $nightTemp $workday_period_2_stop  $dayTemp 24:00 $nightTemp")};
  {fhem("set $device tempListWed prep $workday_period_1_start  $nightTemp $workday_period_1_stop  $dayTemp $workday_period_2_start  $nightTemp $workday_period_2_stop  $dayTemp 24:00 $nightTemp")};
  {fhem("set $device tempListThu prep $workday_period_1_start  $nightTemp $workday_period_1_stop  $dayTemp $workday_period_2_start  $nightTemp $workday_period_2_stop  $dayTemp 24:00 $nightTemp")};
  {fhem("set $device tempListFri prep $workday_period_1_start  $nightTemp $workday_period_1_stop  $dayTemp $workday_period_2_start  $nightTemp $workday_period_2_stop  $dayTemp 24:00 $nightTemp")};
  {fhem("set $device tempListSat prep $saturday_period_1_start $nightTemp $saturday_period_1_stop $dayTemp $saturday_period_2_start $nightTemp $saturday_period_2_stop $dayTemp 24:00 $nightTemp")};
  {fhem("set $device tempListSun exec $sunday_period_1_start   $nightTemp $sunday_period_1_stop   $dayTemp $sunday_period_2_start   $nightTemp $sunday_period_2_stop   $dayTemp 24:00 $nightTemp")};
}
}

Hier sind die benötigten CodeBlöcke für Heizungswerte, Status, Steuerung und Wochenprofil enthalten, aber auch um state zu triggern.

Sonstiges

In der Regel werden die Parameter zu einem reading in den mappings unter <$DEVICE> und dann <$DEVICE>.<$READING> und dann unter <$READING>.<$VALUE> gesucht.

Lesbar machen

Für die meisten Attribute gilt:

  • Wenn es komplexer wird ist es einfacher, den Code in eine eigene Routine in (beispielsweise) 99_myUtils auszulagern und diese aufzurufen:
attr <name> valueStyle {myValueToFormat($READING,$VALUE)}
  • code für unterschiedliche readings kann auch im mapping schon aufgeteilt werden:
attr <name> valueStyle { SuperE5 => '{perl code}', Diesel => '{perl code}' }
  • Ifs lassen sich verschachteln und sortieren. So kann die Anzahl der Klammern und Else-Zweige reduziert werden:
if( $READING eq ... ) {
  return xxx if( $VALUE < 1 );
  return yyy if( $VALUE < 1.5 );
  return zzz;
} elsif( $READING eq ... ) {
  ...
}

Da alles lässt sich natürlich auch kombinieren und so viel lesbarer machen als ein einziger langer Bandwurm.

readingsGroup in einer Gruppe

Wenn der doppelte Rahmen um eine readingsGroup bei Darstellung in einer Gruppe stört, lässt er sich mit dem passenden style entfernen:

attr <rgName> style style="border:0px;background:none;box-shadow:none"

Für die readingsGroup rgName wird der Darstellungsstil verändert.

Einfache Balkendiagramme

readingsGroup mit Balken

Readings lassen sich mit einem valueStyle der folgenden Art mit einem "Füllstandsbalken" hinterlegen:

attr <rgName> valueStyle style="width:200px; text-align:center; border: 1px solid #ccc; background:-webkit-linear-gradient(left, red $VALUE%, rgba(0,0,0,0) $VALUE%)"

Hier ist die gewünschte Breite der Spalte und je nach Wertebereich der Readings auch die Umrechnung des jeweiligen Readingwertes in prozentuale Werte anzupassen.

Die verwendeten Farben lassen sich natürlich auch anpassen, z.B. auch unter Verwendung der Color::pahColor Routine.

Die Balken werden bei Änderungen der Readings automatisch per longpoll aktualisiert.

Je nach verwendetem Browser ist -webkit-linear-gradient durch -moz-linear-gradient, -ms-linear-gradient oder linear-gradient zu ersetzen.

Die obige valueStyle Definition ist nur beispielhaft zu sehen und sollte mit den hier beschriebenen Methoden lesbarer gemacht werden.

Weitere Möglichkeiten zur Erzeugung von Balkendiagrammen sind in Forenbeiträgen hier und hier beschrieben.

readingsGroup Styling mit CSS

Jede readingsGroup lässt sich durch CSS individuell stylen.

Allgemeines

Damit der eigene CSS Code nach einem Update der FHEM-Style Dateien vorhanden bleibt, ist es notwenig eine eigene .css Datei (zB ios7ReadingsGroups.css) zu erstellen und ins Verzeichnis fhem/www/pgm2/ zu kopieren. Anschließend muss in der FHEMWEB Instanz das Attribut CssFiles auf zB pgm2/ios7ReadingsGroups.css gesetzt werden.

Erweiterte Device Übersicht

Diese ReadingsGroup ist an der FHEMWEB Device-Übersicht angelehnt. Zusätzlich werden weitere Readings, hier Leistung, Betriebszeit Heute und Jahr, ein Link zu Detail-Seite der ReadingsGroup und Links zu den jeweiligen Device-Detail-Seite, dargestellt.

Device ReadingsGroup ohne CSS
Device ReadingsGroup mit CSS
Definition
define rg_devices readingsGroup <{rgLink($DEVICE,"konfigurieren","Details")}>,<Device>,<Status>,<Leistung>,<Heute>,<Jahr>\
wzDeckenfluter:<%light_floor_lamp>,<{rgLink("wzDeckenfluter","detail","Deckenfluter")}>,state,<>,dauerHeute,dauerJahr\
wzMacMini:<%it_nas>,<{rgLink("wzMacMini","detail","MacMini")}>,state,power,consumption,consumptionYear\
attr rg_devices noheading 1
attr rg_devices nonames 1
attr rg_devices notime 1
attr rg_devices room ReadingsGroup Styling
attr rg_devices style class="block wide rgDevices"
attr rg_devices valueFormat { 'power' => "%.1f W ", consumption => "%.2f kWh", 'consumptionYear' => "%.2f kWh"  }
attr rg_devices valueIcon { state => '%devStateIcon' }

Damit sich der CSS auf die richtige readingsGroup bezieht, ist es nötigt das Attribut style anzupassen.

Definition Erläuterungen
attr <rgName> style class="block wide rgDevices" Die Klassen block und wide müssen eingetragen werden. Der Name der Nachfolgenden Klasse, hier rgDevices, ist frei wählbar.
Funktion rgLink()

Die Funktion rgLink($name,$action,$label) liefert einen Link mit dem Namen $label zurück. Der Code gehört in die 99_myUtils.pm.

  • $name - Name des Device das aufgerufen werden soll
  • $action - Aktion die Ausgeführt werden soll.
    • konfigurieren erzeugt den kleinen Details Button links oben der einem zur Detail Seite der ReadingsGroup führt - nützlich wenn das ReadingsGroup-Attribut noheading gesetzt ist
    • detail erzeugt einen Link zu Device-Detail Seite
  • $label - Link-Name
sub rgLink($$$){
  my ($name,$action,$label) = @_; 
  my $link = "";
  my $fhemLink = "";
  my $txt = "";
  my $ret = "";
  my $divStyle = "";
  my $aStyle = "";
  
  # FHEM Variablen einbinden
  use vars qw($FW_ME);
  use vars qw($FW_subdir);
  use vars qw($FW_ss);
  use vars qw($FW_tp);

  if( $action eq "konfigurieren" ){
    $fhemLink  = "detail=$name";
    $divStyle = "cursor:pointer;font-size:11px;padding-bottom:2px;padding-left:3px;";
  }
  elsif( $action eq "detail" ){
    $fhemLink  = "detail=$name";
    $divStyle = "cursor:pointer;display:inline;";
  }

  $link = '<a onclick="location.href=\'' . $FW_ME . $FW_subdir . '?' . $fhemLink . '\'" style="' . $aStyle . '">' . $label . '</a>';
  $txt  = '<div style="' . $divStyle . '">' . $link . '</div>';
  $ret  = "$txt";
  
  return $ret;
}
Info green.pngTipp Verwende zum Bearbeiten der eigenen .css Dateien entweder den Codemirror Editor oder einen eigenen Editor mit Syntax Highlighting . Das hilft bei der Fehlersuche enorm.


Styling

Die eigene .css Datei erscheint in FHEM unter Edit-Files --> styles und kann direkt im FHEM-Editor oder mit eigenen Editor bearbeitet werden.

ios7ReadingsGroups.css:

/*  Readings Groups Devices */
table.rgDevices tr td{ text-align: center; }
table.rgDevices tr:first-child td:nth-child(2){ /* 1. Zeile 2. Spalte */ text-align: center; }
table.rgDevices tr td:first-child{  /* 1. Spalte */ width: 45px; text-align: center; }
table.rgDevices tr td:nth-child(2){ /* 2. Spalte */ width: 33%;  text-align: left; }
table.rgDevices tr td:nth-child(3){ /* 3. Spalte */ width: 15%; }
table.rgDevices tr td:nth-child(4){ /* 4. Spalte */ width: 15%; }
table.rgDevices tr td:nth-child(5){ /* 5. Spalte */ width: 15%; }

Auf Portrait / Landscape Modus des Smartphone unterscheiden

Dieses Beispiel ist an das obige Beispiel Erweiterte Device Übersicht angelehnt.

Device ReadingsGroup im Portrait Modus
Device ReadingsGroup im Landscape Modus
Allgemeines

Mit CSS ist man in der Lage auf die aktuelle Bildschirmlage zu reagieren. Alle Anweisungen die in diesen beiden Funktionen zwischen den beiden { } stehen, werden je nach Bildschirmlage aufgerufen

/* Portrait Modus */
@media all and (orientation:portrait) { }

/* Landscape Modus */
@media all and (orientation:landscape) { }
Styling
Info green.pngInfo
  • width: xx% ändert die Breite der Spalte
  • display: none blendet die Spalte aus

In der FHEMWEB_phone Instanz muss wie hier beschrieben eine neue eigene .css Datei eingetragen werden. In diesem Beispiel ios7smallscreenReadingsGroups.css

ios7smallscreenReadingsGroups.css

/* landscape und portrait modus */
table.rgDevices tr td { /* Zuerst alles centern */ text-align: center; }
table.rgDevices tr:first-child td:nth-child(1){ /* 1. Zeile 1. Spalte */ text-align: center; }
table.rgDevices tr td:first-child { /* 1. Spalte */ width: 5%; }
table.rgDevices tr:first-child td:nth-child(2) { /* 1. Zeile 2. Spalte */ text-align: center; }
table.block table tr td table.rgDevices tr td { border-bottom: 1px solid #cbcbcb; }

/* Portrait Modus */
@media all and (orientation:portrait) {
  table.rgDevices tr td:nth-child(2){ /* 2. Spalte */ width: 50%; text-align: left; }
  table.rgDevices tr td:nth-child(3){ /* 3. Spalte */ width: auto; text-align: right; display: table-cell; }
  table.rgDevices tr td:nth-child(4){ /* 4. Spalte */ width: 0; display: none; }
  table.rgDevices tr td:nth-child(5){ /* 5. Spalte */ width: 0; display: none; }
  table.rgDevices tr td:nth-child(6){ width: 0; display: none; }	
  table.rgDevices tr td div a svg{ margin-left: 90px; }
}

/* Landscape Modus */
@media all and (orientation:landscape) { 
  table.rgDevices tr td:nth-child(2){ /* 2. Spalte */ width: 35%; text-align: left; }
  table.rgDevices tr td:nth-child(3){ /* 3. Spalte */ width: 15%; }
  table.rgDevices tr td:nth-child(4){ /* 4. Spalte */ width: 15%; }
  table.rgDevices tr td:nth-child(5){ /* 5. Spalte */ width: 15%; }
  table.rgDevices tr td:nth-child(5){ /* 5. Spalte */ width: 15%; }	
}

Plots im Portrait Modus des Smartphones ausblenden

Device ReadingsGroup im Portrait Modus
Plot nur im Landscape

Um die Plot und alle Steuerelemente im Portrait Modus auszublenden fügt man in seine eigene smallscreen.css wie hier beschrieben folgendes ein:

@media all and (orientation:portrait) {
  .SVGplot, .SVGlabel, .Zoom-in, .Zoom-out, .Prev { width: 0; display: none; }
}