FHEMWiki - Benutzerbeiträge [de]

Micropelt iTRV Kleinstellantrieb

2026-02-09T13:48:11Z

Cwagner: Korrektur des Seitentitels

{{Infobox Hardware
| Bild = ITRV.jpg
| Bildbeschreibung = Batterieloser Heizungssteller
| HWProtocol = EnOcean
| HWType = Aktor
| HWCategory = EnOcean
| HWComm = EnOcean Funk, 868Mhz
| HWProtokoll = EnOcean Protokoll EEP A5-20-01 (Ventil Position in %)
| HWChannels = 1 (bidirektional)
| HWVoltage = 3.2 V, LiFePo-Akku
| HWPowerConsumption = unbekannt
| HWPoweredBy = TEG (Thermoelektrischer Generator;autark)
| HWSize = 59 × 64 × 59 [mm] (Breite × Höhe × Tiefe), Gewicht 260 g
neuere, runde Modelle: 55 x 95 [mm] (Ø x T), 260 g
| HWDeviceFHEM = [http://fhem.de/commandref.html#EnOcean EnOcean]
| HWManufacturer = Micropelt GmbH
}}

'''EnOcean-Micropelt iTRV-Kleinstellantrieb''' ist ein batterieloser Kleinstellantrieb für Raumtemperaturregelung, der seine Energie per Energy Harvesting aus der Wärme des Vorlaufes zieht. Hier wird vorrangig das Modell MVA-002 beschrieben.
Das Modell MVA-004 ist rund und hat einen eigenen PID-Controller, das Modell MVA-005 (ebenfalls rund) hat zusätzlich eine Handverstellung in Ein-Grad-Schritten (bis +/- 5°). Beide Modelle sind noch leiser und sollen laut Hersteller bei schwacher Funkversorgung die Verbindung besser halten. Das Modell MVA-005 hat das EEP A5-20-06, das seit 21.1.2019 von FHEM unterstützt wird.

Aktuell in der Auslieferung sind die Modelle MVA-008 (wie 004) und MVA-009 (wie 005) mit einer USB-Buchse zum Nachladen, falls der eingebaute Speicher leergelaufen sein sollte.

Neben der hier beschriebenen EnOcean-Variante gibt es auch Modelle für LoRaWan.

== Features ==
Kleinstellantrieb, der ohne Batterien auskommt, da er über einen thermolektrischen Generator seine Energie aus der Temperaturdifferenz des Heizungsvorlaufes und der Raumtemperatur bezieht.

== Hinweise zum Betrieb mit FHEM ==

=== Definition/Anlernvorgang ===
4BS-Bidirektionales-Teach-In:

#falls vorhanden, alle bisherigen FHEM Devices des Aktors löschen und nach Speichern der geänderten Konfiguration FHEM neu starten
#FHEM in Lernmodus versetzen: <code><nowiki>set <IODev> teach <time [s]></nowiki></code>
#Taster am iTRV zweimal drücken (Montageposition = 0%). Der erfolgreiche Anlernvorgang wird durch einmaliges Aufleuchten der Status-LED quittiert. (Fehlanzeige: 6mal Blinken)
#Nach Montage Taster einmal drücken - das Ventil fährt die von FHEM gewünschte Position an.
#Aktor-Device wird in FHEM automatisch mit allen notwendigen Parametern angelegt.

Standardmäßig nutzt FHEM den eigenen PID-Regler des FHEM-Moduls, der auf die Eingabe einer Temperaturvorgabe wartet:
<code><nowiki>set <name> desired-temp <wert°C></nowiki></code>

Solange kein Referenz-Device mit <code><nowiki>set <name> temperatureRefDev <Temperaturdevice mit einem Reading temperature></nowiki></code> angegeben wurde, benutzt das Gerät einen internen Temperaturfühler, der bauartbedingt nicht (MVA-005:bedingt) geeignet für eine Raumregelung ist.

Zur Sicherheit des Heizkörperventils gegen Festsetzen durch Rost oder Kalk, wird im Sommermodus pro Tag eine Servicefahrt – einmal auf und zu – des Ventils durchgeführt. Zusätzlich wird dreimal am Tag die Verbindung mit FHEM aufgerufen. Das dient zur Kontrolle, dass alle bislang verbundenen Devices noch vorhanden sind und ordnungsgemäß miteinander kommunizieren.

Wenn mehr als dreimal hintereinander die Funkkommunikation mit FHEM fehlschlug (was mehr als 30 Minuten im Normalbetrieb bedeutet), sendet der Aktor nur noch alle Stunde und - falls das Ventil zu weniger als 50 Prozent geöffent ist, wird es auf 50% aufgefahren bzw. bei MVA-004 und MVA-005 ff. im internen PID-Betrieb auf 21° gesteuert.

'''Durch einmaliges Drücken des Tasters''' kann man im Alltagsbetrieb eine sofortige Funkkommunikation auslösen.

{{Hinweis|Zum Energiesparen verarbeitet der Aktor nur alle 586 oder 587 Sekunden (Sommermodus: alle 8 Stunden) Telegramme von FHEM. Darum zeigen FHEM-Befehle keine sofortige Aktorreaktion, sondern erst nach der genannten Zeitspanne. Die Rückmeldung des Aktors an FHEM über die erfolgte Befehlsausführung erfolgt wiederum erst nach erneutem Ablauf der Zeitspanne.
Falls keine Temperaturdaten geliefert werden, geht das Device in einen Stromsparmodus und fragt nur noch alle 2 Stunden an.
Zur Vermeidung dieses Stromsparmodus, in dem eben auch nicht nachgeregelt wird, sollte bei Referenzgeräte wie einem Raumthermometer das attr event-on-update '''nicht''' benutzt werden. Falls die Temperatur sich 1 Stunde lang nicht ändert, würde entsprechend auch eine Stunde lang kein Referenzwert gesendet, der Stelltrieb in den Sparmodus gehen und für die nächsten 2 Stunden nun kommende Änderungen nicht verarbeiten.
In der Praxis mit einem TCM 310 zeigt sich, dass bei einem RSSI<-80 die Funkkommunikation nicht ausreichend stabil ist. Wenn dreimal hintereinander keine Funktbestätigung erhalten wurde, geht der Aktor in den Notbetrieb und öffnet das Ventil auf 50% oder lässt es auf einem gesetzten größeren Wert bis zur nächsten erfolgreichen bisdirektionalen Kommunikation offen. Das Anpassen der Antennenausrichtung ist hier sehr wichtig.}}

=== Settings ===
{| class="wikitable sortable"
|-
! set !! Wertebereich/Default !! Beschreibung
|-
|desired-temp||10...40||Soll-Temperatur für den FHEM-PID-Controler: der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet
|-
|liftSet||||??
|-
|runInit||||beim nächsten Funkkontakt wird ein Kalibrierungslauf angestoßen
|-
|setpoint||0...100||Setze Aktorposition auf X%; der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet, wenn das attr pidCtrl on ist
|-
|setpointTemp||10...40||Soll-Temperatur für den FHEM-PID-Controler, der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet; ein runInit wird ausgelöst wenn das attr pidCtrl on ist
|-
|ValveCloses||||Ventil auf 0% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|ValveOpens||||Ventil auf 100% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|}

=== Readings ===
{| class="wikitable sortable"
|-
! Reading !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|actuatorState||ok||||wenn 'obstructed', dann ist der metallene Kühlring des Gehäuses z.b. von einem Vorhang bedeckt und der Thermogenerator kann nicht richtig arbeiten
|-
|alarm||no_response_from_actuator||||nur fallweise: wenn Kommunikation ausgefallen; Aktor blinkt dreimal
|-
|battery||ok ||'''ok''' / low||
|-
|cover||closed||||wird vom MVA-002 nicht gesendet
|-
|delta||-9.75||||
|-
|feedTemp
|32.5
|
|Die Modelle ab 004 haben einen zweiten Thermofühler, der verlässlich die Vorlauftemperatur am Ventilsitz misst und zur Steuerung des eingebauten PID-Controlers herangezogen wird.
|-
|energyInput||enabled||'''enabled''' / disabled||enabled zeigt ausreichende Temperaturdifferenz zur Speisung des Akkus an
|-
|energyStorage||charged||'''charged''' / empty ||
|-
|maintenanceMode||off||'''off''' / runinit||
|-
|operationMode||setpointTemp||'''setpointTemp''' / summerMode / setpointSet||'''Betrieb mit Stellwert-Vorgabe''' / im Sommer-Modus / mit Temperatursollwert-Vorgabe
|-
|operationModeRestore||setpointTemp||||nur fallweise: Modus, der beim Beenden des summermode gesetzt wird
|-
|pidAlarm||||actuator_in_errorPos / dead_sensor / no_temperature_value / setpoint_device_missing||
|-
|pidState|||| processing |alarm / idle / '''processing''' / start / stop||
|-
|p_d||0||||
|-
|p_i||100||||
|-
|p_p||-487.5||||
|-
|roomTemp||22.0||||interne Temperatur: wenn attr setpointRefDev nicht gesetzt wird diese Temperatur benutzt - ist für Regelung nicht brauchbar wegen Verfälschung durch Vorlauftemperatur, höhere Temperaturen sind Indiz für Wärmeangebot vom Vorlauf, das den Energiespeicher lädt
|-
|selfCtrl||off||||MVA-002 hat keinen eigenen PID-Controler
|-
|setpoint||0||||beim letzten Funkkontakt gemeldete Ist-Position vom Aktuator in %
|-
|setpointSet||15||||beim nächsten Funkkontakt gesendete Aktuatorstellung in %
|-
|setpointTemp||15.0||||Soll-Temperatur. Kann gesetzt werden über <code><nowiki>set <IODev> desired-temp <°C></nowiki></code> oder auch durch Module wie Heating_Control oder WeekdayTimer
|-
|setpointTempRestore||16.0 ||||nur fallweise: setpointTemp, die bei Beenden des summermode gesetzt wird
|-
|state||T: 23.4 SPT: 15.0 SP: 0||||T:=Raumtemperatur vom Referenzsensor, SPT=setpointTemp, SP=setpoint
|-
|teach||4BS teach-in accepted EEP A5-20-01 Manufacturer: Micropelt GmbH||||Modelle >004: A5-20-06
|-
|temperature||24.75||||zuletzt gemeldete Raumtemperatur vom Referenz-Sensor (siehe Attribut temperatureRefDev)
|-
|waitingCmds||runInit|||noch nicht gesendetes Kommando, hier Kalibrierungslauf|
|-
|wakeUpCycle||240|||das Gerät meldet sich alle 4 Minuten|
|-
|window||closed||open / '''closed'''||wird vom MVA-002 nicht gesendet
|-
|}

=== Attribute ===
{| class="wikitable sortable"
|-
! Attribut !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|actualTemp
|biDir
|t/°C
|
|-
|comMode||biDir||||
|-
|destinationID||unicast||||
|-
|eep||A5-20-01||||MVA-002 bis MVA-004; beim MVA-005 A5-20-06
|-
|manufID||049||||
|-
|pidActorErrorPos||20||||MVA-002 ignoriert diesen Wert und benutzt '''50%''' oder den zuvor gesendeten höheren Stellwert
|-
|pidActorLimitLower||1||||bei 0% Öffnung wird eine Initialisierung ausgelöst?
|-
|pidCtrl||on||||bei on wird der FHEM Pid-Controler benutzt, bei off der im Actor (Modell MVA-002 hat keinen internen PID-Controler, wohl aber MVA-004 und MVA-005)
|-
|pidFactor_I||0.2||||
|-
|pidFactor_P||50||||
|-
|pidSensorTimeout||3600|||| Zahl der Sekunden, in denen der Sensor auf einen Wert vom temperatureRefDev auf einen Wert wartet, sonst Alarm
|-
|pidDeltaTreshold
|2
|1
|Minimale Veränderung der Aktorstellung in Prozent
|-
|rcvRespAction||||||Hier kann eine Aktion eingetragen werden, die bei Rückmeldung des Aktors durchgeführt wird. Details in der FHEM-Referenz
|-
|setpointRefDev||||||Das Device, das die Ventilöffnung (Aktuator) vorgibt, z.B. ein Raumregler, FHEM-PID20. Typischerweise '''nicht gesetzt, es wird der modul-eigene PID-Controler benutzt'''
|-
|setpointSummerMode||2||||Ventilöffnung, die im Sommer gelten soll
|-
|setpointTempRefDev||CC.Kueche||||Eintragen, wenn ein Device, die Solltemperatur vorgibt, z.B. Heating_Control oder ein physischer Raumthermostat, der in FHEM ausgelesen wird.
|-
|subDef||********||||Sender-ID
|-
|subType||hvac.01||||bei MVA-002 bis MVA-004: hvac.01; ab MVA-005: hvac.06
|-
|summerMode||off||||
|-
|teachMethod||4BS||||
|-
|temperatureRefDev||T.Kueche||||Das Device, das mindestens einmal pro Stunde ein Event mit Namen temperature (aktuelle Raumtemperatur) meldet
|-
|webCmd||setpointTemp||||
|-
|}

== Tipps & Tricks ==
Fehlermeldungen wie Sensor '''dead''' oder '''no Response from actuator''' kann man im Betrieb mit einem externen Sensor verhindern, indem man mindestens alle 5 Minuten einen Temperaturwert sendet (gegebenenfalls mit attr event-min-interval im sendenden Temperatur-Device einstellen). Alternativ kann man auch über ein DOIF alle 24 Stunden den Wunschwert mit <Code>set <Devicename> desired-temp 20</Code> wiederholen, wobei 20 beispielhaft eine Wunschtemperatur ist.

Für eine stabile Funkkommunikation ist ein RSSI von besser als -80 anzustreben. Eine Verbesserungsmöglichkeit bietet das versuchsweise Drehen des Micropelt am Heizkörper um 90°. Normalerweise ist der geprägte Schriftzug Micropelt waagerecht wie auch die innen liegende Antenne. Nach der Drehung steht diese dann aufrecht. Das passt in der Praxis dann manchmal besser zu einer waagerecht angeordneten Senderantenne, deren Leistung sich dann gezielter im Haus verbreitet. Ein RSSI von -70 ist besser als -80.
Die Empfangsqualität aller EnOcean-Geräte lässt sich schnell mit <Code>list .* TCM_ESP3_0_RSSI</Code> abfragen, wobei TCM_ESP3_0 der Name des EnOcean-Gateways ist.

Die neueren Modelle beginnen nach einer sehr langen Sommerpause bei leerem Akku schon nach wenigen Minuten mit Vorlauftemperaturen um 30 Grad wieder ihren Betrieb alleine mit dem Strom, den der kleine Thermo-Generator erzeugt.

== ToDos ==
Optimierungstipps, um möglichst wenig Energie im Aktor zu verbrauchen: Sommerbetrieb und Filtern von Sollwert-Verstellungen.

event-on-NN beim Sensor, wakeupCycle

Sorgt Setpoint 0 für eine Initialisierung?

Optimierung von p_i,p_d,p_p in der Praxis

Bedeutung von set <name> liftSet

Abgrenztung ActualTemp gegenüber temperatureRefDev

== Links ==
* {{Link2Forum|Topic=34314|Message=290203|LinkText=Forenbeitrag}}

[[Kategorie:EnOcean Components]]
[[Kategorie:Heizungsventile]]

Micropelt iTRV Kleinstellantrieb

2024-10-17T06:40:11Z

Cwagner: sprachliche Korrekturen; Beschreibung Attribut actualTemp entfernt und in ToDo übernommen

{{Infobox Hardware
| Bild = ITRV.jpg
| Bildbeschreibung = Batterieloser Heizungssteller
| HWProtocol = EnOcean
| HWType = Aktor
| HWCategory = EnOcean
| HWComm = EnOcean Funk, 868Mhz
| HWProtokoll = EnOcean Protokoll EEP A5-20-01 (Ventil Position in %)
| HWChannels = 1 (bidirektional)
| HWVoltage = 3.2 V, LiFePo-Akku
| HWPowerConsumption = unbekannt
| HWPoweredBy = TEG (Thermoelektrischer Generator;autark)
| HWSize = 59 × 64 × 59 [mm] (Breite × Höhe × Tiefe), Gewicht 260 g
neuere, runde Modelle: 55 x 95 [mm] (Ø x T), 260 g
| HWDeviceFHEM = [http://fhem.de/commandref.html#EnOcean EnOcean]
| HWManufacturer = Micropelt GmbH
}}

'''EnOcean-Micropelt iRTV-Kleinstellantrieb''' ist ein batterieloser Kleinstellantrieb für Raumtemperaturregelung, der seine Energie per Energy Harvesting aus der Wärme des Vorlaufes zieht. Hier wird vorrangig das Modell MVA-002 beschrieben.
Das Modell MVA-004 ist rund und hat einen eigenen PID-Controller, das Modell MVA-005 (ebenfalls rund) hat zusätzlich eine Handverstellung in Ein-Grad-Schritten (bis +/- 5°). Beide Modelle sind noch leiser und sollen laut Hersteller bei schwacher Funkversorgung die Verbindung besser halten. Das Modell MVA-005 hat das EEP A5-20-06, das seit 21.1.2019 von FHEM unterstützt wird.

Aktuell in der Auslieferung sind die Modelle MVA-008 (wie 004) und MVA-009 (wie 005) mit einer USB-Buchse zum Nachladen, falls der eingebaute Speicher leergelaufen sein sollte.

Neben der hier beschriebenen EnOcean-Variante gibt es auch Modelle für LoRaWan.

== Features ==
Kleinstellantrieb, der ohne Batterien auskommt, da er über einen thermolektrischen Generator seine Energie aus der Temperaturdifferenz des Heizungsvorlaufes und der Raumtemperatur bezieht.

== Hinweise zum Betrieb mit FHEM ==

=== Definition/Anlernvorgang ===
4BS-Bidirektionales-Teach-In:

#falls vorhanden, alle bisherigen FHEM Devices des Aktors löschen und nach Speichern der geänderten Konfiguration FHEM neu starten
#FHEM in Lernmodus versetzen: <code><nowiki>set <IODev> teach <time [s]></nowiki></code>
#Taster am iTRV zweimal drücken (Montageposition = 0%). Der erfolgreiche Anlernvorgang wird durch einmaliges Aufleuchten der Status-LED quittiert. (Fehlanzeige: 6mal Blinken)
#Nach Montage Taster einmal drücken - das Ventil fährt die von FHEM gewünschte Position an.
#Aktor-Device wird in FHEM automatisch mit allen notwendigen Parametern angelegt.

Standardmäßig nutzt FHEM den eigenen PID-Regler des FHEM-Moduls, der auf die Eingabe einer Temperaturvorgabe wartet:
<code><nowiki>set <name> desired-temp <wert°C></nowiki></code>

Solange kein Referenz-Device mit <code><nowiki>set <name> temperatureRefDev <Temperaturdevice mit einem Reading temperature></nowiki></code> angegeben wurde, benutzt das Gerät einen internen Temperaturfühler, der bauartbedingt nicht (MVA-005:bedingt) geeignet für eine Raumregelung ist.

Zur Sicherheit des Heizkörperventils gegen Festsetzen durch Rost oder Kalk, wird im Sommermodus pro Tag eine Servicefahrt – einmal auf und zu – des Ventils durchgeführt. Zusätzlich wird dreimal am Tag die Verbindung mit FHEM aufgerufen. Das dient zur Kontrolle, dass alle bislang verbundenen Devices noch vorhanden sind und ordnungsgemäß miteinander kommunizieren.

Wenn mehr als dreimal hintereinander die Funkkommunikation mit FHEM fehlschlug (was mehr als 30 Minuten im Normalbetrieb bedeutet), sendet der Aktor nur noch alle Stunde und - falls das Ventil zu weniger als 50 Prozent geöffent ist, wird es auf 50% aufgefahren bzw. bei MVA-004 und MVA-005 ff. im internen PID-Betrieb auf 21° gesteuert.

'''Durch einmaliges Drücken des Tasters''' kann man im Alltagsbetrieb eine sofortige Funkkommunikation auslösen.

{{Hinweis|Zum Energiesparen verarbeitet der Aktor nur alle 586 oder 587 Sekunden (Sommermodus: alle 8 Stunden) Telegramme von FHEM. Darum zeigen FHEM-Befehle keine sofortige Aktorreaktion, sondern erst nach der genannten Zeitspanne. Die Rückmeldung des Aktors an FHEM über die erfolgte Befehlsausführung erfolgt wiederum erst nach erneutem Ablauf der Zeitspanne.
Falls keine Temperaturdaten geliefert werden, geht das Device in einen Stromsparmodus und fragt nur noch alle 2 Stunden an.
Zur Vermeidung dieses Stromsparmodus, in dem eben auch nicht nachgeregelt wird, sollte bei Referenzgeräte wie einem Raumthermometer das attr event-on-update '''nicht''' benutzt werden. Falls die Temperatur sich 1 Stunde lang nicht ändert, würde entsprechend auch eine Stunde lang kein Referenzwert gesendet, der Stelltrieb in den Sparmodus gehen und für die nächsten 2 Stunden nun kommende Änderungen nicht verarbeiten.
In der Praxis mit einem TCM 310 zeigt sich, dass bei einem RSSI<-80 die Funkkommunikation nicht ausreichend stabil ist. Wenn dreimal hintereinander keine Funktbestätigung erhalten wurde, geht der Aktor in den Notbetrieb und öffnet das Ventil auf 50% oder lässt es auf einem gesetzten größeren Wert bis zur nächsten erfolgreichen bisdirektionalen Kommunikation offen. Das Anpassen der Antennenausrichtung ist hier sehr wichtig.}}

=== Settings ===
{| class="wikitable sortable"
|-
! set !! Wertebereich/Default !! Beschreibung
|-
|desired-temp||10...40||Soll-Temperatur für den FHEM-PID-Controler: der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet
|-
|liftSet||||??
|-
|runInit||||beim nächsten Funkkontakt wird ein Kalibrierungslauf angestoßen
|-
|setpoint||0...100||Setze Aktorposition auf X%; der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet, wenn das attr pidCtrl on ist
|-
|setpointTemp||10...40||Soll-Temperatur für den FHEM-PID-Controler, der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet; ein runInit wird ausgelöst wenn das attr pidCtrl on ist
|-
|ValveCloses||||Ventil auf 0% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|ValveOpens||||Ventil auf 100% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|}

=== Readings ===
{| class="wikitable sortable"
|-
! Reading !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|actuatorState||ok||||wenn 'obstructed', dann ist der metallene Kühlring des Gehäuses z.b. von einem Vorhang bedeckt und der Thermogenerator kann nicht richtig arbeiten
|-
|alarm||no_response_from_actuator||||nur fallweise: wenn Kommunikation ausgefallen; Aktor blinkt dreimal
|-
|battery||ok ||'''ok''' / low||
|-
|cover||closed||||wird vom MVA-002 nicht gesendet
|-
|delta||-9.75||||
|-
|feedTemp
|32.5
|
|Die Modelle ab 004 haben einen zweiten Thermofühler, der verlässlich die Vorlauftemperatur am Ventilsitz misst und zur Steuerung des eingebauten PID-Controlers herangezogen wird.
|-
|energyInput||enabled||'''enabled''' / disabled||enabled zeigt ausreichende Temperaturdifferenz zur Speisung des Akkus an
|-
|energyStorage||charged||'''charged''' / empty ||
|-
|maintenanceMode||off||'''off''' / runinit||
|-
|operationMode||setpointTemp||'''setpointTemp''' / summerMode / setpointSet||'''Betrieb mit Stellwert-Vorgabe''' / im Sommer-Modus / mit Temperatursollwert-Vorgabe
|-
|operationModeRestore||setpointTemp||||nur fallweise: Modus, der beim Beenden des summermode gesetzt wird
|-
|pidAlarm||||actuator_in_errorPos / dead_sensor / no_temperature_value / setpoint_device_missing||
|-
|pidState|||| processing |alarm / idle / '''processing''' / start / stop||
|-
|p_d||0||||
|-
|p_i||100||||
|-
|p_p||-487.5||||
|-
|roomTemp||22.0||||interne Temperatur: wenn attr setpointRefDev nicht gesetzt wird diese Temperatur benutzt - ist für Regelung nicht brauchbar wegen Verfälschung durch Vorlauftemperatur, höhere Temperaturen sind Indiz für Wärmeangebot vom Vorlauf, das den Energiespeicher lädt
|-
|selfCtrl||off||||MVA-002 hat keinen eigenen PID-Controler
|-
|setpoint||0||||beim letzten Funkkontakt gemeldete Ist-Position vom Aktuator in %
|-
|setpointSet||15||||beim nächsten Funkkontakt gesendete Aktuatorstellung in %
|-
|setpointTemp||15.0||||Soll-Temperatur. Kann gesetzt werden über <code><nowiki>set <IODev> desired-temp <°C></nowiki></code> oder auch durch Module wie Heating_Control oder WeekdayTimer
|-
|setpointTempRestore||16.0 ||||nur fallweise: setpointTemp, die bei Beenden des summermode gesetzt wird
|-
|state||T: 23.4 SPT: 15.0 SP: 0||||T:=Raumtemperatur vom Referenzsensor, SPT=setpointTemp, SP=setpoint
|-
|teach||4BS teach-in accepted EEP A5-20-01 Manufacturer: Micropelt GmbH||||Modelle >004: A5-20-06
|-
|temperature||24.75||||zuletzt gemeldete Raumtemperatur vom Referenz-Sensor (siehe Attribut temperatureRefDev)
|-
|waitingCmds||runInit|||noch nicht gesendetes Kommando, hier Kalibrierungslauf|
|-
|wakeUpCycle||240|||das Gerät meldet sich alle 4 Minuten|
|-
|window||closed||open / '''closed'''||wird vom MVA-002 nicht gesendet
|-
|}

=== Attribute ===
{| class="wikitable sortable"
|-
! Attribut !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|actualTemp
|biDir
|t/°C
|
|-
|comMode||biDir||||
|-
|destinationID||unicast||||
|-
|eep||A5-20-01||||MVA-002 bis MVA-004; beim MVA-005 A5-20-06
|-
|manufID||049||||
|-
|pidActorErrorPos||20||||MVA-002 ignoriert diesen Wert und benutzt '''50%''' oder den zuvor gesendeten höheren Stellwert
|-
|pidActorLimitLower||1||||bei 0% Öffnung wird eine Initialisierung ausgelöst?
|-
|pidCtrl||on||||bei on wird der FHEM Pid-Controler benutzt, bei off der im Actor (Modell MVA-002 hat keinen internen PID-Controler, wohl aber MVA-004 und MVA-005)
|-
|pidFactor_I||0.2||||
|-
|pidFactor_P||50||||
|-
|pidSensorTimeout||3600|||| Zahl der Sekunden, in denen der Sensor auf einen Wert vom temperatureRefDev auf einen Wert wartet, sonst Alarm
|-
|pidDeltaTreshold
|2
|1
|Minimale Veränderung der Aktorstellung in Prozent
|-
|rcvRespAction||||||Hier kann eine Aktion eingetragen werden, die bei Rückmeldung des Aktors durchgeführt wird. Details in der FHEM-Referenz
|-
|setpointRefDev||||||Das Device, das die Ventilöffnung (Aktuator) vorgibt, z.B. ein Raumregler, FHEM-PID20. Typischerweise '''nicht gesetzt, es wird der modul-eigene PID-Controler benutzt'''
|-
|setpointSummerMode||2||||Ventilöffnung, die im Sommer gelten soll
|-
|setpointTempRefDev||CC.Kueche||||Eintragen, wenn ein Device, die Solltemperatur vorgibt, z.B. Heating_Control oder ein physischer Raumthermostat, der in FHEM ausgelesen wird.
|-
|subDef||********||||Sender-ID
|-
|subType||hvac.01||||bei MVA-002 bis MVA-004: hvac.01; ab MVA-005: hvac.06
|-
|summerMode||off||||
|-
|teachMethod||4BS||||
|-
|temperatureRefDev||T.Kueche||||Das Device, das mindestens einmal pro Stunde ein Event mit Namen temperature (aktuelle Raumtemperatur) meldet
|-
|webCmd||setpointTemp||||
|-
|}

== Tipps & Tricks ==
Fehlermeldungen wie Sensor '''dead''' oder '''no Response from actuator''' kann man im Betrieb mit einem externen Sensor verhindern, indem man mindestens alle 5 Minuten einen Temperaturwert sendet (gegebenenfalls mit attr event-min-interval im sendenden Temperatur-Device einstellen). Alternativ kann man auch über ein DOIF alle 24 Stunden den Wunschwert mit <Code>set <Devicename> desired-temp 20</Code> wiederholen, wobei 20 beispielhaft eine Wunschtemperatur ist.

Für eine stabile Funkkommunikation ist ein RSSI von besser als -80 anzustreben. Eine Verbesserungsmöglichkeit bietet das versuchsweise Drehen des Micropelt am Heizkörper um 90°. Normalerweise ist der geprägte Schriftzug Micropelt waagerecht wie auch die innen liegende Antenne. Nach der Drehung steht diese dann aufrecht. Das passt in der Praxis dann manchmal besser zu einer waagerecht angeordneten Senderantenne, deren Leistung sich dann gezielter im Haus verbreitet. Ein RSSI von -70 ist besser als -80.
Die Empfangsqualität aller EnOcean-Geräte lässt sich schnell mit <Code>list .* TCM_ESP3_0_RSSI</Code> abfragen, wobei TCM_ESP3_0 der Name des EnOcean-Gateways ist.

Die neueren Modelle beginnen nach einer sehr langen Sommerpause bei leerem Akku schon nach wenigen Minuten mit Vorlauftemperaturen um 30 Grad wieder ihren Betrieb alleine mit dem Strom, den der kleine Thermo-Generator erzeugt.

== ToDos ==
Optimierungstipps, um möglichst wenig Energie im Aktor zu verbrauchen: Sommerbetrieb und Filtern von Sollwert-Verstellungen.

event-on-NN beim Sensor, wakeupCycle

Sorgt Setpoint 0 für eine Initialisierung?

Optimierung von p_i,p_d,p_p in der Praxis

Bedeutung von set <name> liftSet

Abgrenztung ActualTemp gegenüber temperatureRefDev

== Links ==
* {{Link2Forum|Topic=34314|Message=290203|LinkText=Forenbeitrag}}

[[Kategorie:EnOcean Components]]
[[Kategorie:Heizungsventile]]

Raspberry Pi

2024-04-15T20:52:08Z

Cwagner: Rücknahme einer Randnotiz, weil sie sich als fehlerhaft erwies.

Beim [[Raspberry Pi]] handelt es sich um einen postkartengroßen Einplatinen-Computer, der von der Raspberry Pi Foundation entwickelt wird. Die Hardware basiert auf dem BCM 283x SoC (System-on-Chip) von Broadcom, einem ARM-Prozessor. Zu Hardwaredetails und den verschiedenen Modellen sowie Produktentwicklungen siehe [http://de.wikipedia.org/wiki/Raspberry_Pi#Hardware Wikipedia].
Dank der kleinen Abmessungen, dem recht geringen Energieverbrauch (bis ca. 4 Watt) sowie der günstigen Anschaffungskosten (ca. 30€) ist der Raspberry Pi eine attraktive Hardware für die Heimautomatisierung mit FHEM. Er ist dank dem Linux-Betriebssystem vollständig kompatibel zur aktuell vorhandenen und von FHEM unterstützen Hardware. Das derzeit empfohlene Standard-Image zum Betrieb des Raspberry Pi ist die auf Debian basierende Raspberry Pi OS Distribution (ab Mitte 2019 ''Buster'').

== Installation / Setup ==
=== Betriebssystem ===
====Vorbemerkung====
Raspberry Pi OS ist direkt bei raspberrybi.org unter https://www.raspberrypi.org/downloads/raspberry-pi-os/ herunterladbar. Die folgende Anleitung gilt für die lite-Version ohne grafischen Desktop und für die Modelle für B, B+, B2, B3, B3+, Zero W. (Stand Juni 2018)

Alle in diesem Abschnitt verwendeten Code Blöcke benötigen root Rechte. Deshalb bitte immer am Besten im Kontext <code>sudo su</code> ausführen. Man kann auch einzelne Befehle mit sudo davor ausführen, allerdings wird die Berechtigung bei Pipe Befehlen nicht durchgereicht. Einige dieser Kommandos funktionieren in der angegebenen Form nicht unter der Wheezy-Version [https://en.wikipedia.org/wiki/Raspberry_Pi_OS#Release_history] des RPi OS. Läuft der betreffende RPi noch unter Wheezy, ist ein Upgrade des RPi OS empfehlenswert.

Alle Dateien müssen im Linux-Format (nur LF als Zeilenende) erzeugt/editiert werden! Unbedingt einen geeigneten Editor verwenden und auf das Format beim Speichern achten!

====SD-Karte vorbereiten====
Die heruntergeladene Datei muss entpackt und auf die Speicherkarte geschrieben werden. Es gibt dazu verschiedene Tools je nach Betriebssystem. Für Windows ist windisk32imager zu empfehlen, Projektseite [https://sourceforge.net/projects/win32diskimager/]. Für Mac OS gibt es den Pi Filler.

Detaillierte Anleitungen zur Vorgehensweise finden sich für die Betriebssysteme Linux, Mac OS und Windows unter [https://www.raspberrypi.org/documentation/installation/installing-images/README.md Writing an image to the SD card]

Die SD Card enthält nun zwei Partitionen/Laufwerke, wobei das erste Laufwerk unter alle Betriebssystemen lesbar ist. In diesem Laufwerk (/boot) müssen jetzt noch zwei Dateien erzeugt werden:
* eine leere Datei mit dem Namen ssh, um den (headless) Zugriff per ssh zu ermöglichen (Pi Filler macht dies automatisch). Hinweis: Eine spätere Aktivierung von SSH ist mit <code>sudo raspi-config</code> (Punkt 5 "Interfacing Options", dann Punkt 2 SSH) möglich, erfordert dann aber Tastatur und Monitor am RPi.
* eine Textdatei im Linux Format mit Namen wpa_supplicant.conf und folgendem Inhalt, wenn der Pi sofort mit WLAN starten soll.

<pre>country=DE
ctrl_interface=DIR=/var/run/wpa_supplicant GROUP=netdev
update_config=1
network={
ssid="FRITZ!Box 7490"
psk="12345678901234567890"
}
</pre>
* SD Karte auswerfen.
* SD Karte in Raspberry Pi stecken und booten.

Alternativ kann auch Monitor und Tastatur verwendet werden.

====Anmeldung und Grundkonfiguration====
Default raspberrypi-os: Host raspberrypi, User pi, Passwort raspberry

Default ubuntu: Host ubuntu, User ubuntu, Passwort ubuntu

Anmeldung entweder lokal oder mit dem Befehl: ssh <user>@<hostname>

Das Passwort sollte geändert werden, dazu dem Sicherheitshinweis folgen und <code>passwd</code> eingeben.

Alle unten genannten Befehle müssen mit erhöhten Rechten ausgeführt werden (z. B. sudo)!

Als Erstes sollte: Zeitzone, Sprache und Hostname angepasst werden.
Entweder Menügeführt mit <code>sudo raspi-config</code>
oder per Script / Shell Befehle:

<syntaxhighlight lang="bash"># Zeitzone einstellen & Zeitsynchronisierung über das Internet aktivieren
timedatectl set-timezone Europe/Berlin
timedatectl set-ntp true

# Konfigurieren lokale Sprache deutsch
sed -i -e 's/# de_DE.UTF-8 UTF-8/de_DE.UTF-8 UTF-8/' /etc/locale.gen
locale-gen
localectl set-locale LANG=de_DE.UTF-8 LANGUAGE=de_DE

# Hostname
hostnamectl set-hostname mymachine

# System aktualisieren
apt-get update
apt-get upgrade

#Neustart
reboot</syntaxhighlight>

Am Anfang sollte man Befehle nicht verketten, sondern immer auf die Ausgabe warten (es sei denn, man hat Erfahrung): also kein <code>apt-get update && apt-get upgrade </code>. Ebenso sollte man nicht mit automatischen Bestätigungen arbeiten, also kein upgrade mit "-y". Nach einer Installation ist ein aufräumen immer gut, also:
<syntaxhighlight lang="bash">
apt-get autoremove
apt-get clean
apt-get purge $(dpkg --get-selections | grep deinstall | cut -f1 | xargs)
</syntaxhighlight>

====Verwendung UART für Zusatzmodule====
Einige Aufsteckmodule (z.B. HM-MOD-RPI-PCB) für den GPIO Port verwenden die serielle Schnittstelle UART. Der Zugriff auf diese serielle Schnittstelle erfordert eine modellabhängige Konfiguration. Siehe auch [https://www.raspberrypi.com/documentation/computers/configuration.html Raspberry Pi Dokumentation]

Bei allen Modellen muss die Verwendung der seriellen Linux console an ttyAMA0 deaktiviert werden:
<syntaxhighlight lang="bash"># seriell-getty Dienst für ttyAMA0 dauerhaft deaktivieren
systemctl stop serial-getty@ttyAMA0.service
systemctl disable serial-getty@ttyAMA0.service
systemctl mask serial-getty@ttyAMA0.service
</syntaxhighlight>
Bei den Modellen mit Bluetooth muss die UART aktiviert und umkonfiguriert werden. Hier ein bash Script, welches die Originaldatei entsprechend modifiziert:
{{Randnotiz|RNTyp=Info|RNText=Im aktuellen RaspberryPi OS Bookworm Image ist die config.txt in den Pfad /boot/firmware gewandert. Die alte Datei wurde durch einen Dummy ersetzt.
Verwendet man ein debian Image findet man Infos in {{Link2Forum|Topic=137496|Message=1307865|LinkText=diesem Forenbeitrag}}}}
<syntaxhighlight lang="bash">
# serielle Schnittstelle aktivieren und mit BT Schnittstelle tauschen
config="/boot/firmware/config.txt"
# für Raspberry Pi OS vor Bookworm
# config="/boot/config.txt"
# für Ubuntu
#config="/boot/firmware/usercfg.txt"

bash -c "cat <<EOF >> $config
enable_uart=1
dtoverlay=miniuart-bt
core_freq=250
EOF"
</syntaxhighlight>
Wer dem nicht traut, der editiert die Datei von Hand (Linux Editor!) und fügt am Ende die drei Zeilen aus dem Script ein, die vor EOF stehen.

Die config Datei von ubuntu verwendet den Befehl include usercfg.txt. Mit Erscheinen des Pi 4 wurden die overlay Dateien umbenannt (Start mit Pi3- entfernt) die alten Namen funktionieren aber noch.

Um die Konfiguration abzuschließen ist ein Neustart erforderlich
<syntaxhighlight lang="bash">#Neustart erforderlich
reboot</syntaxhighlight>

====Troubleshooting====
{{Randnotiz|RNTyp=r|RNText=Das hat sich mit RaspberryPI OS Bookworm geändert, aktuell wird darüber ab {{Link2Forum|Topic=135864|Message=1294588|LinkText=diesem Forenbeitrag}} diskutiert.}}
'''Kontrolle der seriellen Schnittstelle'''

Der Befehl <code>ls -l /dev/ttyAMA0</code> muss folgende Ausgabe liefern.
crw-rw---- 1 root dialout 204, 64 Jun 7 22:56 /dev/ttyAMA0
Sollte dies nicht der Fall sein, muss der Dienst serial-getty@ttyAMA0.service deaktiviert werden!

Kontrolle der Verlinkung von /dev/serial*

Der Befehl <code>ls -l /dev/serial*</code> muss folgende Ausgabe liefern.
* Bei Modellen mit BT und richtiger Konfiguration (funktioniert nur unter Raspberry Pi OS)
lrwxrwxrwx 1 root root 7 Jun 7 22:55 /dev/serial0 -> ttyAMA0
lrwxrwxrwx 1 root root 5 Jun 7 22:55 /dev/serial1 -> ttyS0
* Bei den Modellen ohne BT und richtiger Konfiguration
lrwxrwxrwx 1 root root 7 Jun 8 18:30 /dev/serial0 -> ttyAMA0
Sollte das nicht der Fall sein, sind die Einträge in der /boot/config.txt fehlerhaft.

Sollte die serielle Schnittstelle unerwartet nicht funktionieren, kann auch andere Software daran Schuld sein, weil diese einfach versucht, alle Schnittstellen abzufragen / zu initialisieren. Für die Fehlersuche ist es also wichtig zu wissen, welche Software so installiert wurde, speziell wenn diese serielle Schnitttstellen (USB) verwendet / verwenden will. Ein Beispiel (deconz/conbee) wird in {{Link2Forum|Topic=116428|Message=1107317|LinkText=diesem Forenbeitrag}} behandelt.

Bei einem Raspberry 4 stört unter Umständen die Temperaturkontrolle des Lüfters, siehe auch Abschnitt bekannte Probleme: [[HM-MOD-RPI-PCB HomeMatic Funkmodul für Raspberry Pi]].

'''Kontrolle Bluetooth'''

Die Funktion von Bluetooth kann mit dem hcitool überprüft werden. Mit <code>hcitool dev</code> wird das interne BT Gerät mit MAC Adresse angezeigt. Mit <code>hcitool scan</code> bzw. <code>hcitool lescan</code> kann nach sichtbaren Geräten gesucht werden.

Weitergehende Informationen zur Anpassung der Konfiguration von Raspberry Pi OS sind nachzulesen auf https://www.raspberrypi.org/documentation/configuration/.

Sollte die Bluetooth Schnittstelle nach der Installation von FHEM nicht funktionieren, hilft es den Dienst abhängig zu starten, siehe diesen Wiki Artikel [[Fhem.service (systemd unit file)]]

=== FHEM ===
Die Installation von FHEM kann nach der Raspberry Pi OS Installation sehr einfach über das Debian-Repository [http://debian.fhem.de] erfolgen.
* Es wird unbedingt empfohlen zur Grundinstallation zunächst keine Module, USB Sticks oder ähnliche Zusatzbaugruppen an den IO Ports des Raspberry gesteckt zu haben.
* Dieser Abschnitt beschreibt nur die Grundinstallation von FHEM auf einem Raspberry Pi mit Raspberry Pi OS!
* Weitere Installationsschritte sind je nach verwendeten FHEM-Modulen notwendig.
** Informationen hierzu liefert üblicherweise die {{Link2CmdRef}} zum jeweiligen Modul.
** Den weiteren Einstieg in FHEM findet man im Artikel [[Quick-Start]]

==== Der einfache Weg zum aktuellen System ====
Der folgende Befehlsblock ist die praktische Umsetzung der Beschreibung auf http://debian.fhem.de. Bitte unbedingt vor Installation rückversichern, ob es dort (insbesondere unter ''The easy way: use apt-get'') Aktualisierungen gab.
* Dieser Befehlsblock erfordert erhöhte Rechte, also bitte als Erstes <code>sudo su</code> ausführen!
* Beim Kopieren aufpassen! Jede Zeile muss einzeln ausgeführt werden!
Dieser Befehlsblock gilt ab der Version ''debian buster'' als veraltet (es gibt Sicherheitsbedenken), muss aber bis einschließlich ''debian stretch'' eingesetzt werden.
<syntaxhighlight lang="bash">
# von debian.fhem.de installieren - siehe aktuelle Anleitung dort https://debian.fhem.de/
wget -qO - https://debian.fhem.de/archive.key | apt-key add -
echo "deb http://debian.fhem.de/nightly/ /" >> /etc/apt/sources.list
apt-get update
apt-get install fhem
</syntaxhighlight>
Dieser Befehlsblock funktioniert erst ab ''debian buster'' (erfordert erhöhte Rechte <code>sudo su</code>)
<syntaxhighlight lang="bash">
# Bei manchen debian Distributionen fehlt das Paket gpg -> nachinstallieren
apt update
apt install gpg
# von debian.fhem.de installieren - siehe aktuelle Anleitung dort https://debian.fhem.de/
wget -O- https://debian.fhem.de/archive.key | gpg --dearmor > /usr/share/keyrings/debianfhemde-archive-keyring.gpg
echo "deb [signed-by=/usr/share/keyrings/debianfhemde-archive-keyring.gpg] https://debian.fhem.de/nightly/ /" >> /etc/apt/sources.list
apt update
apt install fhem
</syntaxhighlight>

==== Das offizielle Release ====
Man kann FHEM mit dem Debian-Paket von [https://fhem.de/#Installation fhem.de] installieren. Dieser Weg führt zu einem offiziellen Release, welches aber unter Umständen erheblich vom aktuellen Versions- und Diskussionsstand im Forum abweicht.

Alternativ kann man auch den manuellen Weg von https://debian.fhem.de/ wählen.

==== Empfohlener Patch ====
Da gerade auf dem Raspberry die automatische Erkennung der USB Schnittstellen zu 100% CPU Last führt (FHEM träge und reagiert nicht), wird empfohlen sofort nach der Installation noch diesen "Patch" auszuführen: FHEM starten, wenn alle USB-Geräte ausgesteckt sind. Dann <code>attr initialUsbCheck disable 1</code> in der Kommandozeile in FHEMWEB eingeben, <code>save</code> ausführen und FHEM anschließen wieder mit eingesteckten USB-Geräten neu starten.

====Deinstallation====
Man kann FHEM auch wieder spurlos vom System entfernen und ganz von vorn beginnen. Allerdings sollte man sich im Klaren sein, damit ensteht kein jungfräuliches System!
<syntaxhighlight lang="bash">
sudo apt-get purge fhem
sudo apt-get autoremove
</syntaxhighlight>

===Zusatzpakete bei FHEM-Erst- und Zweitinstallation===
Nachdem der RPi eingerichtet ist, können weitere Pakete installiert werden. Keines davon ist zwingend erforderlich, um das Grundgerüst von FHEM betreiben zu können. Einige Pakete erhöhen aber den Bedienungskomfort, andere sind zur Nutzung bestimmter weiterer FHEM-Module (siehe {{Link2CmdRef}}) erforderlich.

Hierzu wurden in letzter Zeit mehrere Hilfsmodule entwickelt, die insbesondere bei Wiederinstallation (etwa nach Absturz) wichtig sein können. So zeigt das Modul Installer die installierten Perl-Module an, siehe dazu {{Link2Forum|Topic=98381|LinkText=diesen Thread}}.

Wenn man eine frühere Installation auf einer anderen SD-Karte installieren möchte und nicht mehr weiß, welche Zusatzpakete man auf der alten Karte installiert hatte, hilft (diese und nachfolgende Hinweise sind aus dem Blog [https://heinz-otto.blogspot.com/2019/07/infos-zur-installation-von-modulen-und.html])
zcat $(ls -tr /var/log/apt/history.log.*.gz)|grep -A1 Start-Date
weiter. Hier werden frühere Eingaben der Kommandozeile wiedergegeben. Es gibt einen analogen Befehl, um die mit CPAN installierten Pakete anzuzeigen. Dazu muss man das debian Paket perl-doc installiert haben und gibt dann ein
for M in `perldoc -t perllocal|grep Module |sed -e 's/^.*" //'`; do V=`perldoc -t perllocal|awk "/$M/{y=1;next}y" |grep VERSION |head -n 1`; printf "%30s %s\n" "$M" "$V"; done |sort
Ebenso kann man herausfinden, ob und durch welches debian-Paket das Perl-Paket installiert wurde. Die zweite Version sucht nur in Paketen die -perl im Namen tragen und läuft damit wesentlich schneller:
s='Device::SerialPort' ## zu diesem Paket wird gesucht
perl -M$s -e '' 2>/dev/null &&echo "Modul $s ist vorhanden"''
for i in $(dpkg -l |grep ^ii| awk '{ print $2 }'|tr -d "\r"|tr "\n" " ");do if dpkg -L $i|grep $s &> /dev/null;then echo $i enthält $s;fi;done
for i in $(dpkg -l |grep ^ii|grep '\-perl'| awk '{ print $2 }'|tr -d "\r"|tr "\n" " ");do if dpkg -L $i|grep $s &> /dev/null;then echo $i enthält $s;fi;done

Es gibt gute Gründe, die Installation von Perl Modulen über debian-Pakete der Installation über cpan zu bevorzugen. Dazu zählt die Updatefähigkeit und die Geschwindigkeit. Man kann im Internet nach den Paketen suchen, man kann aber auch einfach die Verfügbarkeit für das lokale System testen. Dazu braucht man das Tool apt-file, welches man zuerst installieren muss. Der letzte Befehl lädt den Infocache lokal und dauert etwas:
sudo apt-get update
sudo apt-get install apt-file
sudo apt-file update
Die folgende Suche nutzt den Umstand, dass in der im Paket enthaltenen Liste der Dateien auch die Doku in der Form "/usr/share/man/man3/IO::File.3perl.gz" enthalten ist. Der search Befehl unten akzeptiert mehrere Modulnamen durch Zeilenumbruch getrennt. In dem Beispiel sind die Modulnamen in einem String durch Leerzeichen getrennt, die Trennung wird in Zeilenumbruch geändert, jede Zeile ergänzt und über stdin an den search Befehl von apt-file übergeben. Die Option -l bewirkt das nur die gefunden Pakete gelistet werden, werden mehrere der abgefragten Modulnamen in einem Paket gefunden, wird es nur einmal gelistet:
s="IO::File Digest::MD5" ##Such-String
echo $s|tr " " "\n"|sed 's/$/./;s/^/\//'|apt-file search -l -f -

Zuletzt eine Übersicht diverser Zusatzpakete.
{| class="wikitable"
! style="width:10%" |Beschreibung
! style="width:10%" |Paketname
! style="width:50%" |Kontext
! style="width:30%" |Installieren
|-
|Zeitserver
|ntpdate
| Setzt die Systemzeit bei Start des RPi. Wird für FHEM benötigt, da es sonst nicht startet.
|<code>sudo apt-get install ntpdate
sudo ntpdate -u de.pool.ntp.org</code>
|-
| Perl JSON
|JSON
|Wird von einigen Modulen benötigt, z.B. harmony, iTunes
|<code>sudo apt-get install libjson-perl</code>
|-
|Samba-Server
|samba
|Mittels Samba kann man z.B. den Ordner /opt/fhem als Share freigeben. Dieser Share kann z.B. im Windows-Explorer als Laufwerk verbunden werden, so dass die Bearbeitung von config- und Programmdateien bequem möglich ist. Hier eine hilfreiche [https://www.elektronik-kompendium.de/sites/raspberry-pi/2007071.htm Kurzanleitung] aus der (wenn man auf einen speziellen user verzichtet) nur die Einträge für smb.conf gesetzt werden müssen.
|<code>sudo apt-get install samba cifs-utils</code>
Danach muss der share definiert werden mittels

<code>sudo nano /etc/samba/smb.conf</code>
|-
| Mailversand
|sendemail (alt: sendEmail)
|Wird benötigt, um Mails versenden zu können, bspw. für Alarm-Benachrichtigungen.
Nach Installation des Paketes benötigt man noch eine Routine in FHEM gemäß [[E-Mail senden#Raspberry Pi]]
|<code>sudo apt-get install sendemail</code> bzw. <code>sudo apt-get install sendEmail</code>
|-
|Wake-on-LAN
|etherwake
|Wird z.B. für das Modul WOL benötigt.
|<code>sudo apt-get install etherwake</code>
|-
|Perl Telnet
|telnet
|Wurde vor Fritz!OS 6.2x z.B. für das Modul [[FRITZBOX]] benötigt, da es eine im Netzwerk vorhandene Fritzbox über deren Telnet-Port ansprach. Mittlerweile wird TR-64 und SOAP verwendet.
|<code>sudo apt-get install libnet-telnet-perl</code>
|-
|Socat
|socat
| Kann verwendet werden, um auf anderen Rechnern im Netzwerk Linux-Befehle oder Skripts auszuführen. Auch können auf Slave-FHEM-Installationen Befehl ausgeführt werden, z.B. mit

<code><nowiki>system("echo 'set lampe on' | /usr/bin/socat - TCP:1.2.3.4:7072");</nowiki></code>

1.2.3.4 muss natürlich durch die IP-Adresse des Zielrechners ersetzt werden.
|<code>sudo apt-get install socat</code>
|-
|Libcrypt
| Libcrypt
|Perl libcrypt, erforderlich falls Homematic-devices mit AES verwendet werden sollen.
|<code>sudo apt-get install libcrypt-rijndael-perl</code>
|-
|libdatetime
|libdatetime
|Perl libdatetime, erforderlich für das Weather-Modul.
|<code>sudo apt-get install libdatetime-format-strptime-perl</code>
|-
|EnOcean XML functions
|libxml simple
|Perl XML::SIMPLE, erforderlich für die XML Funktionen des ENOCEAN Moduls.
|<code>sudo apt-get install libxml-simple-perl</code>
|-
|EnOcean Cryptographic functions
|libcrypt-random-source-perl
|Perl Crypt::Random, erforderlich für die Cryptographic Funktionen des ENOCEAN Moduls.
|<code>sudo /usr/bin/perl -MCPAN -e 'install Crypt::Random'</code>
|}

==Bekannte Probleme==
===Netzteil===
Der RPi verwendet ein USB Netzteil als Spannungsversorgung. Gemessen kann der RPi allein bereits um die 900mA Strom fordern. Das bringt kleine Netzteile, besonders wenn noch CULs oder WLAN Sticks an USB hängen schnell an die Grenze. Die Fehler die daraus resultieren sind Abstürze, Netzwerkprobleme uvm. Daher bitte ein ausreichend starkes Netzteil mit mind. 2000mA oder einen aktiven USB-HUB für die Periperie verwenden.

===Kabel (Micro-USB)===
Auch das verwendete Kabel kann einen (großen) Unterschied machen. Billige Kabel haben sehr dünne Kupferadern, die auf größeren Strecken (bereits ab 30cm!) einen Spannungsabfall verursachen können, der sonst nicht nachvollziehbare Probleme (Festplattenausfall, SD-Kartenausfall etc.) auslöst. Siehe beispielsweise diesen Thread mit einer Tabelle, die die Höhe des Spannungsabfalls explizit beschreibt: [https://forum.fhem.de/index.php/topic,127508.0.html Link zum Forum]

===Echtzeituhr===
Der RPi hat keine [http://de.wikipedia.org/wiki/Echtzeituhr Real-Time-Clock] (RTC), das heißt, dass er nach einem Neustart keine gültige (im Sinne von aktuell) Systemzeit hat, sondern ein Datum in der Vergangenheit. Dieses Problem wird sinnvollerweise mit einer [http://de.wikipedia.org/wiki/Network_Time_Protocol NTP-Konfiguration] oder durch [[Raspberry Pi: RTC Hat|Installation einer Echtzeituhr]] umgangen.

Dabei muss Sorge getragen werden, dass der [http://wiki.debian.org/NTP ntpd] schon einen Datums-/Zeitabgleich gemacht hat, bevor FHEM gestartet wird. Geschieht der Abgleich nicht vorher, sondern erst nachdem FHEM schon läuft, stellt FHEM die Logs zwar auf das nun aktuelle Datum um (die "alten" Logs mit dem eigentlich ungültigen Datum werden natürlich behalten), aber irgendetwas scheint FHEM dabei so zu belasten, dass es eine Last von über 0.8 bis 0.9 erzeugt. Diese Last besteht auf Dauer und verschwindet erst, wenn man das Ganze sauber durchkonfiguriert und FHEM neu gestartet hat. Die hohe Systemauslastung zeigt sich auch in einem sehr trägen Laden der FHEM-Webseiten in einem beliebigen Browser. (siehe {{Link2Forum|Topic=70741}})

===Last durch Backup (während update)===
Bei einen [[Update]] von FHEM durch den Befehl <code>update</code> kann durch Setzen des Attributs "<code>attr global backup_before_update 1</code>" automatisch vorab ein [[Backup]] durchgeführt werden. Die (ggf. großen) Log-Dateien werden dabei ebenfalls archiviert. Während der Archivierung ist FHEM blockiert. Durch die beschränkte Leistungsfähigkeit des Raspberry Pi kann das Backup zudem lange dauern. Durch ein "<code>attr global updateInBackground 1</code>" wird ein Backup im Hintergrund ausgeführt (Quelle: {{Link2Forum|Topic=15729}}).

Alternative Möglichkeiten:
*Backup ausschalten und manuell durchführen
*Backup-Befehl anpassen und so große Dateien bzw. Verzeichnisse (log/) nicht archivieren

==Watchdog einrichten==
Man kann den RPi regelmäßig prüfen lassen, ob FHEM noch läuft und gegebenenfalls einen Neustart durchführen lassen. Eine mögliche Vorgehensweise ist in diesem {{Link2Forum|Topic=20553|LinkText=Forumsthema}} beschrieben.
{{Hinweis|Statt des Einsatzes derartiger Methoden ist zu empfehlen, nach der eigentliche Fehlerursache zu forschen und diese abzustellen. Haben Sie dennoch einen solchen Watchdog eingerichtet, sollten Sie bei Fragen zu Ihnen seltsam erscheinenden Phänomänen im Forum darauf hinweisen, auch wenn die Symptome scheinbar nichts mit dem Watchdog zu tun haben sollten.}}

==Interne Links ==
*[[CUL am Raspberry Pi flashen]]
*[[Raspberry Pi und 1-Wire]]

==Externe Links==
*{{Link2Forum|Topic=33460|Message=264679}} zum Umzug von Raspberry B auf Raspberry Pi 2
* [http://www.raspberrypi.org/ Offizielle Webseite der Raspberry Pi Foundation]
*[http://www.raspberrypi.org/downloads Offizielle Downloads der Raspberry Pi Foundation]

[[Kategorie:Raspberry Pi]]
[[Kategorie:HOWTOS]]

Raspberry Pi

2024-03-28T19:17:27Z

Cwagner: Randnotiz zu attr initialUsbCheck disable 1

Beim [[Raspberry Pi]] handelt es sich um einen postkartengroßen Einplatinen-Computer, der von der Raspberry Pi Foundation entwickelt wird. Die Hardware basiert auf dem BCM 283x SoC (System-on-Chip) von Broadcom, einem ARM-Prozessor. Zu Hardwaredetails und den verschiedenen Modellen sowie Produktentwicklungen siehe [http://de.wikipedia.org/wiki/Raspberry_Pi#Hardware Wikipedia].
Dank der kleinen Abmessungen, dem recht geringen Energieverbrauch (bis ca. 4 Watt) sowie der günstigen Anschaffungskosten (ca. 30€) ist der Raspberry Pi eine attraktive Hardware für die Heimautomatisierung mit FHEM. Er ist dank dem Linux-Betriebssystem vollständig kompatibel zur aktuell vorhandenen und von FHEM unterstützen Hardware. Das derzeit empfohlene Standard-Image zum Betrieb des Raspberry Pi ist die auf Debian basierende Raspberry Pi OS Distribution (ab Mitte 2019 ''Buster'').

== Installation / Setup ==
=== Betriebssystem ===
====Vorbemerkung====
Raspberry Pi OS ist direkt bei raspberrybi.org unter https://www.raspberrypi.org/downloads/raspberry-pi-os/ herunterladbar. Die folgende Anleitung gilt für die lite-Version ohne grafischen Desktop und für die Modelle für B, B+, B2, B3, B3+, Zero W. (Stand Juni 2018)

Alle in diesem Abschnitt verwendeten Code Blöcke benötigen root Rechte. Deshalb bitte immer am Besten im Kontext <code>sudo su</code> ausführen. Man kann auch einzelne Befehle mit sudo davor ausführen, allerdings wird die Berechtigung bei Pipe Befehlen nicht durchgereicht. Einige dieser Kommandos funktionieren in der angegebenen Form nicht unter der Wheezy-Version [https://en.wikipedia.org/wiki/Raspberry_Pi_OS#Release_history] des RPi OS. Läuft der betreffende RPi noch unter Wheezy, ist ein Upgrade des RPi OS empfehlenswert.

Alle Dateien müssen im Linux-Format (nur LF als Zeilenende) erzeugt/editiert werden! Unbedingt einen geeigneten Editor verwenden und auf das Format beim Speichern achten!

====SD-Karte vorbereiten====
Die heruntergeladene Datei muss entpackt und auf die Speicherkarte geschrieben werden. Es gibt dazu verschiedene Tools je nach Betriebssystem. Für Windows ist windisk32imager zu empfehlen, Projektseite [https://sourceforge.net/projects/win32diskimager/]. Für Mac OS gibt es den Pi Filler.

Detaillierte Anleitungen zur Vorgehensweise finden sich für die Betriebssysteme Linux, Mac OS und Windows unter [https://www.raspberrypi.org/documentation/installation/installing-images/README.md Writing an image to the SD card]

Die SD Card enthält nun zwei Partitionen/Laufwerke, wobei das erste Laufwerk unter alle Betriebssystemen lesbar ist. In diesem Laufwerk (/boot) müssen jetzt noch zwei Dateien erzeugt werden:
* eine leere Datei mit dem Namen ssh, um den (headless) Zugriff per ssh zu ermöglichen (Pi Filler macht dies automatisch). Hinweis: Eine spätere Aktivierung von SSH ist mit <code>sudo raspi-config</code> (Punkt 5 "Interfacing Options", dann Punkt 2 SSH) möglich, erfordert dann aber Tastatur und Monitor am RPi.
* eine Textdatei im Linux Format mit Namen wpa_supplicant.conf und folgendem Inhalt, wenn der Pi sofort mit WLAN starten soll.

<pre>country=DE
ctrl_interface=DIR=/var/run/wpa_supplicant GROUP=netdev
update_config=1
network={
ssid="FRITZ!Box 7490"
psk="12345678901234567890"
}
</pre>
* SD Karte auswerfen.
* SD Karte in Raspberry Pi stecken und booten.

Alternativ kann auch Monitor und Tastatur verwendet werden.

====Anmeldung und Grundkonfiguration====
Default raspberrypi-os: Host raspberrypi, User pi, Passwort raspberry

Default ubuntu: Host ubuntu, User ubuntu, Passwort ubuntu

Anmeldung entweder lokal oder mit dem Befehl: ssh <user>@<hostname>

Das Passwort sollte geändert werden, dazu dem Sicherheitshinweis folgen und <code>passwd</code> eingeben.

Alle unten genannten Befehle müssen mit erhöhten Rechten ausgeführt werden (z. B. sudo)!

Als Erstes sollte: Zeitzone, Sprache und Hostname angepasst werden.
Entweder Menügeführt mit <code>sudo raspi-config</code>
oder per Script / Shell Befehle:

<syntaxhighlight lang="bash"># Zeitzone einstellen & Zeitsynchronisierung über das Internet aktivieren
timedatectl set-timezone Europe/Berlin
timedatectl set-ntp true

# Konfigurieren lokale Sprache deutsch
sed -i -e 's/# de_DE.UTF-8 UTF-8/de_DE.UTF-8 UTF-8/' /etc/locale.gen
locale-gen
localectl set-locale LANG=de_DE.UTF-8 LANGUAGE=de_DE

# Hostname
hostnamectl set-hostname mymachine

# System aktualisieren
apt-get update
apt-get upgrade

#Neustart
reboot</syntaxhighlight>

Am Anfang sollte man Befehle nicht verketten, sondern immer auf die Ausgabe warten (es sei denn, man hat Erfahrung): also kein <code>apt-get update && apt-get upgrade </code>. Ebenso sollte man nicht mit automatischen Bestätigungen arbeiten, also kein upgrade mit "-y". Nach einer Installation ist ein aufräumen immer gut, also:
<syntaxhighlight lang="bash">
apt-get autoremove
apt-get clean
apt-get purge $(dpkg --get-selections | grep deinstall | cut -f1 | xargs)
</syntaxhighlight>

====Verwendung UART für Zusatzmodule====
Einige Aufsteckmodule (z.B. HM-MOD-RPI-PCB) für den GPIO Port verwenden die serielle Schnittstelle UART. Der Zugriff auf diese serielle Schnittstelle erfordert eine modellabhängige Konfiguration. Siehe auch [https://www.raspberrypi.com/documentation/computers/configuration.html Raspberry Pi Dokumentation]

Bei allen Modellen muss die Verwendung der seriellen Linux console an ttyAMA0 deaktiviert werden:
<syntaxhighlight lang="bash"># seriell-getty Dienst für ttyAMA0 dauerhaft deaktivieren
systemctl stop serial-getty@ttyAMA0.service
systemctl disable serial-getty@ttyAMA0.service
systemctl mask serial-getty@ttyAMA0.service
</syntaxhighlight>
Bei den Modellen mit Bluetooth muss die UART aktiviert und umkonfiguriert werden. Hier ein bash Script, welches die Originaldatei entsprechend modifiziert:
{{Randnotiz|RNTyp=Info|RNText=Im aktuellen RaspberryPi OS Bookworm Image ist die config.txt in den Pfad /boot/firmware gewandert. Die alte Datei wurde durch einen Dummy ersetzt.
Verwendet man ein debian Image findet man Infos in {{Link2Forum|Topic=137496|Message=1307865|LinkText=diesem Forenbeitrag}}}}
<syntaxhighlight lang="bash">
# serielle Schnittstelle aktivieren und mit BT Schnittstelle tauschen
config="/boot/firmware/config.txt"
# für Raspberry Pi OS vor Bookworm
# config="/boot/config.txt"
# für Ubuntu
#config="/boot/firmware/usercfg.txt"

bash -c "cat <<EOF >> $config
enable_uart=1
dtoverlay=miniuart-bt
core_freq=250
EOF"
</syntaxhighlight>
Wer dem nicht traut, der editiert die Datei von Hand (Linux Editor!) und fügt am Ende die drei Zeilen aus dem Script ein, die vor EOF stehen.

Die config Datei von ubuntu verwendet den Befehl include usercfg.txt. Mit Erscheinen des Pi 4 wurden die overlay Dateien umbenannt (Start mit Pi3- entfernt) die alten Namen funktionieren aber noch.

Um die Konfiguration abzuschließen ist ein Neustart erforderlich
<syntaxhighlight lang="bash">#Neustart erforderlich
reboot</syntaxhighlight>

====Troubleshooting====
{{Randnotiz|RNTyp=r|RNText=Das hat sich mit RaspberryPI OS Bookworm geändert, aktuell wird darüber ab {{Link2Forum|Topic=135864|Message=1294588|LinkText=diesem Forenbeitrag}} diskutiert.}}
'''Kontrolle der seriellen Schnittstelle'''

Der Befehl <code>ls -l /dev/ttyAMA0</code> muss folgende Ausgabe liefern.
crw-rw---- 1 root dialout 204, 64 Jun 7 22:56 /dev/ttyAMA0
Sollte dies nicht der Fall sein, muss der Dienst serial-getty@ttyAMA0.service deaktiviert werden!

Kontrolle der Verlinkung von /dev/serial*

Der Befehl <code>ls -l /dev/serial*</code> muss folgende Ausgabe liefern.
* Bei Modellen mit BT und richtiger Konfiguration (funktioniert nur unter Raspberry Pi OS)
lrwxrwxrwx 1 root root 7 Jun 7 22:55 /dev/serial0 -> ttyAMA0
lrwxrwxrwx 1 root root 5 Jun 7 22:55 /dev/serial1 -> ttyS0
* Bei den Modellen ohne BT und richtiger Konfiguration
lrwxrwxrwx 1 root root 7 Jun 8 18:30 /dev/serial0 -> ttyAMA0
Sollte das nicht der Fall sein, sind die Einträge in der /boot/config.txt fehlerhaft.

Sollte die serielle Schnittstelle unerwartet nicht funktionieren, kann auch andere Software daran Schuld sein, weil diese einfach versucht, alle Schnittstellen abzufragen / zu initialisieren. Für die Fehlersuche ist es also wichtig zu wissen, welche Software so installiert wurde, speziell wenn diese serielle Schnitttstellen (USB) verwendet / verwenden will. Ein Beispiel (deconz/conbee) wird in {{Link2Forum|Topic=116428|Message=1107317|LinkText=diesem Forenbeitrag}} behandelt.

Bei einem Raspberry 4 stört unter Umständen die Temperaturkontrolle des Lüfters, siehe auch Abschnitt bekannte Probleme: [[HM-MOD-RPI-PCB HomeMatic Funkmodul für Raspberry Pi]].

'''Kontrolle Bluetooth'''

Die Funktion von Bluetooth kann mit dem hcitool überprüft werden. Mit <code>hcitool dev</code> wird das interne BT Gerät mit MAC Adresse angezeigt. Mit <code>hcitool scan</code> bzw. <code>hcitool lescan</code> kann nach sichtbaren Geräten gesucht werden.

Weitergehende Informationen zur Anpassung der Konfiguration von Raspberry Pi OS sind nachzulesen auf https://www.raspberrypi.org/documentation/configuration/.

Sollte die Bluetooth Schnittstelle nach der Installation von FHEM nicht funktionieren, hilft es den Dienst abhängig zu starten, siehe diesen Wiki Artikel [[Fhem.service (systemd unit file)]]

=== FHEM ===
Die Installation von FHEM kann nach der Raspberry Pi OS Installation sehr einfach über das Debian-Repository [http://debian.fhem.de] erfolgen.
* Es wird unbedingt empfohlen zur Grundinstallation zunächst keine Module, USB Sticks oder ähnliche Zusatzbaugruppen an den IO Ports des Raspberry gesteckt zu haben.
* Dieser Abschnitt beschreibt nur die Grundinstallation von FHEM auf einem Raspberry Pi mit Raspberry Pi OS!
* Weitere Installationsschritte sind je nach verwendeten FHEM-Modulen notwendig.
** Informationen hierzu liefert üblicherweise die {{Link2CmdRef}} zum jeweiligen Modul.
** Den weiteren Einstieg in FHEM findet man im Artikel [[Quick-Start]]

==== Der einfache Weg zum aktuellen System ====
Der folgende Befehlsblock ist die praktische Umsetzung der Beschreibung auf http://debian.fhem.de. Bitte unbedingt vor Installation rückversichern, ob es dort (insbesondere unter ''The easy way: use apt-get'') Aktualisierungen gab.
* Dieser Befehlsblock erfordert erhöhte Rechte, also bitte als Erstes <code>sudo su</code> ausführen!
* Beim Kopieren aufpassen! Jede Zeile muss einzeln ausgeführt werden!
Dieser Befehlsblock gilt ab der Version ''debian buster'' als veraltet (es gibt Sicherheitsbedenken), muss aber bis einschließlich ''debian stretch'' eingesetzt werden.
<syntaxhighlight lang="bash">
# von debian.fhem.de installieren - siehe aktuelle Anleitung dort https://debian.fhem.de/
wget -qO - https://debian.fhem.de/archive.key | apt-key add -
echo "deb http://debian.fhem.de/nightly/ /" >> /etc/apt/sources.list
apt-get update
apt-get install fhem
</syntaxhighlight>
Dieser Befehlsblock funktioniert erst ab ''debian buster'' (erfordert erhöhte Rechte <code>sudo su</code>)
<syntaxhighlight lang="bash">
# Bei manchen debian Distributionen fehlt das Paket gpg -> nachinstallieren
apt update
apt install gpg
# von debian.fhem.de installieren - siehe aktuelle Anleitung dort https://debian.fhem.de/
wget -O- https://debian.fhem.de/archive.key | gpg --dearmor > /usr/share/keyrings/debianfhemde-archive-keyring.gpg
echo "deb [signed-by=/usr/share/keyrings/debianfhemde-archive-keyring.gpg] https://debian.fhem.de/nightly/ /" >> /etc/apt/sources.list
apt update
apt install fhem
</syntaxhighlight>

==== Das offizielle Release ====
Man kann FHEM mit dem Debian-Paket von [https://fhem.de/#Installation fhem.de] installieren. Dieser Weg führt zu einem offiziellen Release, welches aber unter Umständen erheblich vom aktuellen Versions- und Diskussionsstand im Forum abweicht.

Alternativ kann man auch den manuellen Weg von https://debian.fhem.de/ wählen.

==== Empfohlener Patch ====
Da gerade auf dem Raspberry die automatische Erkennung der USB Schnittstellen zu 100% CPU Last führt (FHEM träge und reagiert nicht), wird empfohlen sofort nach der Installation noch diesen "Patch" auszuführen: FHEM starten, wenn alle USB-Geräte ausgesteckt sind. Dann <code>attr initialUsbCheck disable 1</code> in der Kommandozeile in FHEMWEB eingeben, <code>save</code> ausführen und FHEM anschließen wieder mit eingesteckten USB-Geräten neu starten.

{{Randnotiz|RNText=Gibt es in neueren FHEM-Versionen überhaupt noch initialUsbCheck?}}

==== Deinstallation ====
Man kann FHEM auch wieder spurlos vom System entfernen und ganz von vorn beginnen. Allerdings sollte man sich im Klaren sein, damit ensteht kein jungfräuliches System!
<syntaxhighlight lang="bash">
sudo apt-get purge fhem
sudo apt-get autoremove
</syntaxhighlight>

=== Zusatzpakete bei FHEM-Erst- und Zweitinstallation ===
Nachdem der RPi eingerichtet ist, können weitere Pakete installiert werden. Keines davon ist zwingend erforderlich, um das Grundgerüst von FHEM betreiben zu können. Einige Pakete erhöhen aber den Bedienungskomfort, andere sind zur Nutzung bestimmter weiterer FHEM-Module (siehe {{Link2CmdRef}}) erforderlich.

Hierzu wurden in letzter Zeit mehrere Hilfsmodule entwickelt, die insbesondere bei Wiederinstallation (etwa nach Absturz) wichtig sein können. So zeigt das Modul Installer die installierten Perl-Module an, siehe dazu {{Link2Forum|Topic=98381|LinkText=diesen Thread}}.

Wenn man eine frühere Installation auf einer anderen SD-Karte installieren möchte und nicht mehr weiß, welche Zusatzpakete man auf der alten Karte installiert hatte, hilft (diese und nachfolgende Hinweise sind aus dem Blog [https://heinz-otto.blogspot.com/2019/07/infos-zur-installation-von-modulen-und.html])
zcat $(ls -tr /var/log/apt/history.log.*.gz)|grep -A1 Start-Date
weiter. Hier werden frühere Eingaben der Kommandozeile wiedergegeben. Es gibt einen analogen Befehl, um die mit CPAN installierten Pakete anzuzeigen. Dazu muss man das debian Paket perl-doc installiert haben und gibt dann ein
for M in `perldoc -t perllocal|grep Module |sed -e 's/^.*" //'`; do V=`perldoc -t perllocal|awk "/$M/{y=1;next}y" |grep VERSION |head -n 1`; printf "%30s %s\n" "$M" "$V"; done |sort
Ebenso kann man herausfinden, ob und durch welches debian-Paket das Perl-Paket installiert wurde. Die zweite Version sucht nur in Paketen die -perl im Namen tragen und läuft damit wesentlich schneller:
s='Device::SerialPort' ## zu diesem Paket wird gesucht
perl -M$s -e '' 2>/dev/null &&echo "Modul $s ist vorhanden"''
for i in $(dpkg -l |grep ^ii| awk '{ print $2 }'|tr -d "\r"|tr "\n" " ");do if dpkg -L $i|grep $s &> /dev/null;then echo $i enthält $s;fi;done
for i in $(dpkg -l |grep ^ii|grep '\-perl'| awk '{ print $2 }'|tr -d "\r"|tr "\n" " ");do if dpkg -L $i|grep $s &> /dev/null;then echo $i enthält $s;fi;done

Es gibt gute Gründe, die Installation von Perl Modulen über debian-Pakete der Installation über cpan zu bevorzugen. Dazu zählt die Updatefähigkeit und die Geschwindigkeit. Man kann im Internet nach den Paketen suchen, man kann aber auch einfach die Verfügbarkeit für das lokale System testen. Dazu braucht man das Tool apt-file, welches man zuerst installieren muss. Der letzte Befehl lädt den Infocache lokal und dauert etwas:
sudo apt-get update
sudo apt-get install apt-file
sudo apt-file update
Die folgende Suche nutzt den Umstand, dass in der im Paket enthaltenen Liste der Dateien auch die Doku in der Form "/usr/share/man/man3/IO::File.3perl.gz" enthalten ist. Der search Befehl unten akzeptiert mehrere Modulnamen durch Zeilenumbruch getrennt. In dem Beispiel sind die Modulnamen in einem String durch Leerzeichen getrennt, die Trennung wird in Zeilenumbruch geändert, jede Zeile ergänzt und über stdin an den search Befehl von apt-file übergeben. Die Option -l bewirkt das nur die gefunden Pakete gelistet werden, werden mehrere der abgefragten Modulnamen in einem Paket gefunden, wird es nur einmal gelistet:
s="IO::File Digest::MD5" ##Such-String
echo $s|tr " " "\n"|sed 's/$/./;s/^/\//'|apt-file search -l -f -

Zuletzt eine Übersicht diverser Zusatzpakete.
{| class="wikitable"
! style="width:10%" | Beschreibung
! style="width:10%" | Paketname
! style="width:50%" | Kontext
! style="width:30%" | Installieren
|-
|Zeitserver
|ntpdate
|Setzt die Systemzeit bei Start des RPi. Wird für FHEM benötigt, da es sonst nicht startet.
|<code>sudo apt-get install ntpdate
sudo ntpdate -u de.pool.ntp.org</code>
|-
|Perl JSON
|JSON
|Wird von einigen Modulen benötigt, z.B. harmony, iTunes
|<code>sudo apt-get install libjson-perl</code>
|-
|Samba-Server
|samba
|Mittels Samba kann man z.B. den Ordner /opt/fhem als Share freigeben. Dieser Share kann z.B. im Windows-Explorer als Laufwerk verbunden werden, so dass die Bearbeitung von config- und Programmdateien bequem möglich ist. Hier eine hilfreiche [https://www.elektronik-kompendium.de/sites/raspberry-pi/2007071.htm Kurzanleitung] aus der (wenn man auf einen speziellen user verzichtet) nur die Einträge für smb.conf gesetzt werden müssen.
|<code>sudo apt-get install samba cifs-utils</code>
Danach muss der share definiert werden mittels

<code>sudo nano /etc/samba/smb.conf</code>
|-
|Mailversand
|sendemail (alt: sendEmail)
|Wird benötigt, um Mails versenden zu können, bspw. für Alarm-Benachrichtigungen.
Nach Installation des Paketes benötigt man noch eine Routine in FHEM gemäß [[E-Mail senden#Raspberry Pi]]
|<code>sudo apt-get install sendemail</code> bzw. <code>sudo apt-get install sendEmail</code>
|-
|Wake-on-LAN
|etherwake
|Wird z.B. für das Modul WOL benötigt.
|<code>sudo apt-get install etherwake</code>
|-
|Perl Telnet
|telnet
|Wurde vor Fritz!OS 6.2x z.B. für das Modul [[FRITZBOX]] benötigt, da es eine im Netzwerk vorhandene Fritzbox über deren Telnet-Port ansprach. Mittlerweile wird TR-64 und SOAP verwendet.
|<code>sudo apt-get install libnet-telnet-perl</code>
|-
|Socat
|socat
|Kann verwendet werden, um auf anderen Rechnern im Netzwerk Linux-Befehle oder Skripts auszuführen. Auch können auf Slave-FHEM-Installationen Befehl ausgeführt werden, z.B. mit

<code><nowiki>system("echo 'set lampe on' | /usr/bin/socat - TCP:1.2.3.4:7072");</nowiki></code>

1.2.3.4 muss natürlich durch die IP-Adresse des Zielrechners ersetzt werden.
|<code>sudo apt-get install socat</code>
|-
|Libcrypt
|Libcrypt
|Perl libcrypt, erforderlich falls Homematic-devices mit AES verwendet werden sollen.
|<code>sudo apt-get install libcrypt-rijndael-perl</code>
|-
|libdatetime
|libdatetime
|Perl libdatetime, erforderlich für das Weather-Modul.
|<code>sudo apt-get install libdatetime-format-strptime-perl</code>
|-
|EnOcean XML functions
|libxml simple
|Perl XML::SIMPLE, erforderlich für die XML Funktionen des ENOCEAN Moduls.
|<code>sudo apt-get install libxml-simple-perl</code>
|-
|EnOcean Cryptographic functions
|libcrypt-random-source-perl
|Perl Crypt::Random, erforderlich für die Cryptographic Funktionen des ENOCEAN Moduls.
|<code>sudo /usr/bin/perl -MCPAN -e 'install Crypt::Random'</code>
|}

== Bekannte Probleme ==
=== Netzteil ===
Der RPi verwendet ein USB Netzteil als Spannungsversorgung. Gemessen kann der RPi allein bereits um die 900mA Strom fordern. Das bringt kleine Netzteile, besonders wenn noch CULs oder WLAN Sticks an USB hängen schnell an die Grenze. Die Fehler die daraus resultieren sind Abstürze, Netzwerkprobleme uvm. Daher bitte ein ausreichend starkes Netzteil mit mind. 2000mA oder einen aktiven USB-HUB für die Periperie verwenden.

=== Kabel (Micro-USB) ===
Auch das verwendete Kabel kann einen (großen) Unterschied machen. Billige Kabel haben sehr dünne Kupferadern, die auf größeren Strecken (bereits ab 30cm!) einen Spannungsabfall verursachen können, der sonst nicht nachvollziehbare Probleme (Festplattenausfall, SD-Kartenausfall etc.) auslöst. Siehe beispielsweise diesen Thread mit einer Tabelle, die die Höhe des Spannungsabfalls explizit beschreibt: [https://forum.fhem.de/index.php/topic,127508.0.html Link zum Forum]

=== Echtzeituhr ===
Der RPi hat keine [http://de.wikipedia.org/wiki/Echtzeituhr Real-Time-Clock] (RTC), das heißt, dass er nach einem Neustart keine gültige (im Sinne von aktuell) Systemzeit hat, sondern ein Datum in der Vergangenheit. Dieses Problem wird sinnvollerweise mit einer [http://de.wikipedia.org/wiki/Network_Time_Protocol NTP-Konfiguration] oder durch [[Raspberry Pi: RTC Hat|Installation einer Echtzeituhr]] umgangen.

Dabei muss Sorge getragen werden, dass der [http://wiki.debian.org/NTP ntpd] schon einen Datums-/Zeitabgleich gemacht hat, bevor FHEM gestartet wird. Geschieht der Abgleich nicht vorher, sondern erst nachdem FHEM schon läuft, stellt FHEM die Logs zwar auf das nun aktuelle Datum um (die "alten" Logs mit dem eigentlich ungültigen Datum werden natürlich behalten), aber irgendetwas scheint FHEM dabei so zu belasten, dass es eine Last von über 0.8 bis 0.9 erzeugt. Diese Last besteht auf Dauer und verschwindet erst, wenn man das Ganze sauber durchkonfiguriert und FHEM neu gestartet hat. Die hohe Systemauslastung zeigt sich auch in einem sehr trägen Laden der FHEM-Webseiten in einem beliebigen Browser. (siehe {{Link2Forum|Topic=70741}})

=== Last durch Backup (während update) ===
Bei einen [[Update]] von FHEM durch den Befehl <code>update</code> kann durch Setzen des Attributs "<code>attr global backup_before_update 1</code>" automatisch vorab ein [[Backup]] durchgeführt werden. Die (ggf. großen) Log-Dateien werden dabei ebenfalls archiviert. Während der Archivierung ist FHEM blockiert. Durch die beschränkte Leistungsfähigkeit des Raspberry Pi kann das Backup zudem lange dauern. Durch ein "<code>attr global updateInBackground 1</code>" wird ein Backup im Hintergrund ausgeführt (Quelle: {{Link2Forum|Topic=15729}}).

Alternative Möglichkeiten:
* Backup ausschalten und manuell durchführen
* Backup-Befehl anpassen und so große Dateien bzw. Verzeichnisse (log/) nicht archivieren

== Watchdog einrichten ==
Man kann den RPi regelmäßig prüfen lassen, ob FHEM noch läuft und gegebenenfalls einen Neustart durchführen lassen. Eine mögliche Vorgehensweise ist in diesem {{Link2Forum|Topic=20553|LinkText=Forumsthema}} beschrieben.
{{Hinweis|Statt des Einsatzes derartiger Methoden ist zu empfehlen, nach der eigentliche Fehlerursache zu forschen und diese abzustellen. Haben Sie dennoch einen solchen Watchdog eingerichtet, sollten Sie bei Fragen zu Ihnen seltsam erscheinenden Phänomänen im Forum darauf hinweisen, auch wenn die Symptome scheinbar nichts mit dem Watchdog zu tun haben sollten.}}

== Interne Links ==
* [[CUL am Raspberry Pi flashen]]
* [[Raspberry Pi und 1-Wire]]

== Externe Links ==
* {{Link2Forum|Topic=33460|Message=264679}} zum Umzug von Raspberry B auf Raspberry Pi 2
* [http://www.raspberrypi.org/ Offizielle Webseite der Raspberry Pi Foundation]
* [http://www.raspberrypi.org/downloads Offizielle Downloads der Raspberry Pi Foundation]

[[Kategorie:Raspberry Pi]]
[[Kategorie:HOWTOS]]

Micropelt iTRV Kleinstellantrieb

2023-10-02T09:07:21Z

Cwagner: Korrektur attr actualTemp

{{Infobox Hardware
| Bild = ITRV.jpg
| Bildbeschreibung = Batterieloser Heizungssteller
| HWProtocol = EnOcean
| HWType = Aktor
| HWCategory = EnOcean
| HWComm = EnOcean Funk, 868Mhz
| HWProtokoll = EnOcean Protokoll EEP A5-20-01 (Ventil Position in %)
| HWChannels = 1 (bidirektional)
| HWVoltage = 3.2 V, LiFePo-Akku
| HWPowerConsumption = unbekannt
| HWPoweredBy = TEG (Thermoelektrischer Generator;autark)
| HWSize = 59 × 64 × 59 [mm] (Breite × Höhe × Tiefe), Gewicht 260 g
neuere, runde Modelle: 55 x 95 [mm] (Ø x T), 260 g
| HWDeviceFHEM = [http://fhem.de/commandref.html#EnOcean EnOcean]
| HWManufacturer = Micropelt GmbH
}}

'''EnOcean-Micropelt iRTV-Kleinstellantrieb''' ist ein batterieloser Kleinstellantrieb für Raumtemperaturregelung, der seine Energie per Energy Harvesting aus der Wärme des Vorlaufes zieht. Hier wird vorrangig das Modell MVA-002 beschrieben.
Das Modell MVA-004 ist rund und hat einen eigenen PID-Controller, das Modell MVA-005 (ebenfalls rund) hat zusätzlich eine Handverstellung in Ein-Grad-Schritten (bis +/- 5°). Beide Modelle sind noch leiser und sollen laut Hersteller bei schwacher Funkversorgung die Verbindung besser halten. Das Modell MVA-005 hat das EEP A5-20-06, das seit 21.1.2019 von FHEM unterstützt wird.

Aktuell in der Auslieferung sind die Modelle MVA-008 (wie 004) und MVA-009 (wie 005) mit einer USB-Buchse zum Nachladen, falls der eingebaute Speicher leergelaufen sein sollte.

Neben der hier beschriebenen EnOcean-Variante gibt es auch Modelle für LoRaWan.

== Features ==
Kleinstellantrieb, der ohne Batterien auskommt, da er über einen thermolektrischen Generator seine Energie aus der Temperaturdifferenz des Heizungsvorlaufes und der Raumtemperatur bezieht.

== Hinweise zum Betrieb mit FHEM ==

=== Definition/Anlernvorgang ===
4BS-Bidirektionales-Teach-In:

#falls vorhanden, alle bisherigen FHEM Devices des Aktors löschen und nach Speichern der geänderten Konfiguration FHEM neu starten
#FHEM in Lernmodus versetzen: <code><nowiki>set <IODev> teach <time [s]></nowiki></code>
#Taster am iTRV zweimal drücken (Montageposition = 0%). Der erfolgreiche Anlernvorgang wird durch einmaliges Aufleuchten der Status-LED quittiert. (Fehlanzeige: 6mal Blinken)
#Nach Montage Taster einmal drücken - das Ventil fährt die von FHEM gewünschte Position an.
#Aktor-Device wird in FHEM automatisch mit allen notwendigen Parametern angelegt.

Standardmäßig nutzt FHEM den eigenen PID-Regler des FHEM-Moduls, der auf die Eingabe einer Temperaturvorgabe wartet:
<code><nowiki>set <name> desired-temp <wert°C></nowiki></code>

Solange kein Referenz-Device mit <code><nowiki>set <name> temperatureRefDev <Temperaturdevice mit einem Reading temperature></nowiki></code> angegeben wurde, benutzt das Gerät einen internen Temperaturfühler, der bauartbedingt nicht (MVA-005:bedingt) geeignet für eine Raumregelung ist.

Zur Sicherheit des Heizkörperventils gegen Festsetzen durch Rost oder Kalk, wird im Sommermodus pro Tag eine Servicefahrt – einmal auf und zu – des Ventils durchgeführt. Zusätzlich wird dreimal am Tag die Verbindung mit FHEM aufgerufen. Das dient zur Kontrolle, dass alle bislang verbundenen Devices noch vorhanden sind und ordnungsgemäß miteinander kommunizieren.

Wenn mehr als dreimal hintereinander die Funkkommunikation mit FHEM fehlschlug (was mehr als 30 Minuten im Normalbetrieb bedeutet), sendet der Aktor nur noch alle Stunde und - falls das Ventil zu weniger als 50 Prozent geöffent ist, wird es auf 50% aufgefahren bzw. bei MVA-004 und MVA-005 ff. im internen PID-Betrieb auf 21° gesteuert.

'''Durch einmaliges Drücken des Tasters''' kann man im Alltagsbetrieb eine sofortige Funkkommunikation auslösen.

{{Hinweis|Zum Energiesparen verarbeitet der Aktor nur alle 586 oder 587 Sekunden (Sommermodus: alle 8 Stunden) Telegramme von FHEM. Darum zeigen FHEM-Befehle keine sofortige Aktorreaktion, sondern erst nach der genannten Zeitspanne. Die Rückmeldung des Aktors an FHEM über die erfolgte Befehlsausführung erfolgt wiederum erst nach erneutem Ablauf der Zeitspanne.
Falls keine Temperaturdaten geliefert werden, geht das Device in einen Stromsparmodus und fragt nur noch alle 2 Stunden an.
Zur Vermeidung dieses Stromsparmodus, in dem eben auch nicht nachgeregelt wird, sollte bei Referenzgeräte wie einem Raumthermometer das attr event-on-update '''nicht''' benutzt werden. Falls die Temperatur sich 1 Stunde lang nicht ändert, würde entsprechend auch eine Stunde lang kein Referenzwert gesendet, der Stelltrieb in den Sparmodus gehen und für die nächsten 2 Stunden nun kommende Änderungen nicht verarbeiten.
In der Praxis mit einem TCM 310 zeigt sich, dass bei einem RSSI<-80 die Funkkommunikation nicht ausreichend stabil ist. Wenn dreimal hintereinander keine Funktbestätigung erhalten wurde, geht der Aktor in den Notbetrieb und öffnet das Ventil auf 50% oder lässt es auf einem gesetzten größeren Wert bis zur nächsten erfolgreichen bisdirektionalen Kommunikation offen. Das Anpassen der Antennenausrichtung ist hier sehr wichtig.}}

=== Settings ===
{| class="wikitable sortable"
|-
! set !! Wertebereich/Default !! Beschreibung
|-
|desired-temp||10...40||Soll-Temperatur für den FHEM-PID-Controler: der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet
|-
|liftSet||||??
|-
|runInit||||beim nächsten Funkkontakt wird ein Kalibrierungslauf angestoßen
|-
|setpoint||0...100||Setze Aktorposition auf X%; der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet, wenn das attr pidCtrl on ist
|-
|setpointTemp||10...40||Soll-Temperatur für den FHEM-PID-Controler, der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet; ein runInit wird ausgelöst wenn das attr pidCtrl on ist
|-
|ValveCloses||||Ventil auf 0% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|ValveOpens||||Ventil auf 100% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|}

=== Readings ===
{| class="wikitable sortable"
|-
! Reading !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|actuatorState||ok||||wenn 'obstructed', dann ist der metallene Kühlring des Gehäuses z.b. von einem Vorhang bedeckt und der Thermogenerator kann nicht richtig arbeiten
|-
|alarm||no_response_from_actuator||||nur fallweise: wenn Kommunikation ausgefallen; Aktor blinkt dreimal
|-
|battery||ok ||'''ok''' / low||
|-
|cover||closed||||wird vom MVA-002 nicht gesendet
|-
|delta||-9.75||||
|-
|feedTemp
|32.5
|
|Die Modelle ab 004 haben einen zweiten Thermofühler, der verlässlich die Vorlauftemperatur am Ventilsitz misst und zur Steuerung des eingebauten PID-Controlers herangezogen wird.
|-
|energyInput||enabled||'''enabled''' / disabled||enabled zeigt ausreichende Temperaturdifferenz zur Speisung des Akkus an
|-
|energyStorage||charged||'''charged''' / empty ||
|-
|maintenanceMode||off||'''off''' / runinit||
|-
|operationMode||setpointTemp||'''setpointTemp''' / summerMode / setpointSet||'''Betrieb mit Stellwert-Vorgabe''' / im Sommer-Modus / mit Temperatursollwert-Vorgabe
|-
|operationModeRestore||setpointTemp||||nur fallweise: Modus, der beim Beenden des summermode gesetzt wird
|-
|pidAlarm||||actuator_in_errorPos / dead_sensor / no_temperature_value / setpoint_device_missing||
|-
|pidState|||| processing |alarm / idle / '''processing''' / start / stop||
|-
|p_d||0||||
|-
|p_i||100||||
|-
|p_p||-487.5||||
|-
|roomTemp||22.0||||interne Temperatur: wenn attr setpointRefDev nicht gesetzt wird diese Temperatur benutzt - ist für Regelung nicht brauchbar wegen Verfälschung durch Vorlauftemperatur, höhere Temperaturen sind Indiz für Wärmeangebot vom Vorlauf, das den Energiespeicher lädt
|-
|selfCtrl||off||||MVA-002 hat keinen eigenen PID-Controler
|-
|setpoint||0||||beim letzten Funkkontakt gemeldete Ist-Position vom Aktuator in %
|-
|setpointSet||15||||beim nächsten Funkkontakt gesendete Aktuatorstellung in %
|-
|setpointTemp||15.0||||Soll-Temperatur. Kann gesetzt werden über <code><nowiki>set <IODev> desired-temp <°C></nowiki></code> oder auch durch Module wie Heating_Control oder WeekdayTimer
|-
|setpointTempRestore||16.0 ||||nur fallweise: setpointTemp, die bei Beenden des summermode gesetzt wird
|-
|state||T: 23.4 SPT: 15.0 SP: 0||||T:=Raumtemperatur vom Referenzsensor, SPT=setpointTemp, SP=setpoint
|-
|teach||4BS teach-in accepted EEP A5-20-01 Manufacturer: Micropelt GmbH||||Modelle >004: A5-20-06
|-
|temperature||24.75||||zuletzt gemeldete Raumtemperatur vom Referenz-Sensor (siehe Attribut temperatureRefDev)
|-
|waitingCmds||runInit|||noch nicht gesendetes Kommando, hier Kalibrierungslauf|
|-
|wakeUpCycle||240|||das Gerät meldet sich alle 4 Minuten|
|-
|window||closed||open / '''closed'''||wird vom MVA-002 nicht gesendet
|-
|}

=== Attribute ===
{| class="wikitable sortable"
|-
! Attribut !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|actualTemp
|biDir
|t/°C
|Festlegung eines Raumfühler oder einer Steuereinheit, der die konkrete Temperatur angibt. Wird dann im Status des Device genannt. Ist dieses Attribut nicht gesetzt, wird bei Modellen >004 die von Aktor gemeldete Temperatur verwendet. Beim 004 wird das Reading temperature von setpointRefDev verwendet
|-
|comMode||biDir||||
|-
|destinationID||unicast||||
|-
|eep||A5-20-01||||MVA-002 bis MVA-004; beim MVA-005 A5-20-06
|-
|manufID||049||||
|-
|pidActorErrorPos||20||||MVA-002 ignoriert diesen Wert und benutzt '''50%''' oder den zuvor gesendeten höheren Stellwert
|-
|pidActorLimitLower||1||||bei 0% Öffnung wird eine Initialisierung ausgelöst?
|-
|pidCtrl||on||||bei on wird der FHEM Pid-Controler benutzt, bei off der im Actor (Modell MVA-002 hat keinen internen PID-Controler, wohl aber MVA-004 und MVA-005)
|-
|pidFactor_I||0.2||||
|-
|pidFactor_P||50||||
|-
|pidSensorTimeout||3600|||| Zahl der Sekunden, in denen der Sensor auf einen Wert vom temperatureRefDev auf einen Wert wartet, sonst Alarm
|-
|pidDeltaTreshold
|2
|1
|Minimale Veränderung der Aktorstellung in Prozent
|-
|rcvRespAction||||||Hier kann eine Aktion eingetragen werden, die bei Rückmeldung des Aktors durchgeführt wird. Details in der FHEM-Referenz
|-
|setpointRefDev||||||Das Device, das die Ventilöffnung (Aktuator) vorgibt, z.B. ein Raumregler, FHEM-PID20. Typischerweise '''nicht gesetzt, es wird der modul-eigene PID-Controler benutzt'''
|-
|setpointSummerMode||2||||Ventilöffnung, die im Sommer gelten soll
|-
|setpointTempRefDev||CC.Kueche||||Eintragen, wenn ein Device, die Solltemperatur vorgibt, z.B. Heating_Control oder ein physischer Raumthermostat, der in FHEM ausgelesen wird.
|-
|subDef||********||||Sender-ID
|-
|subType||hvac.01||||bei MVA-002 bis MVA-004: hvac.01; bei MVA-005: hvac.06
|-
|summerMode||off||||
|-
|teachMethod||4BS||||
|-
|temperatureRefDev||T.Kueche||||Das Device, das fortlaufend die Ist-Temperatur meldet
|-
|webCmd||setpointTemp||||
|-
|}

== Tipps & Tricks ==
Fehlermeldungen wie Sensor '''dead''' oder '''no Response from actuator''' kann man im Betrieb mit einem externen Sensor verhindern, indem man mindestens alle 5 Minuten einen Temperaturwert sendet (gegebenenfalls mit attr event-min-interval im sendenden Temperatur-Device einstellen). Alternativ kann man auch über ein DOIF alle 24 Stunden den Wunschwert mit <Code>set <Devicename> desired-temp 20</Code> wiederholen, wobei 20 beispielhaft eine Wunschtemperatur ist.

Für eine stabile Funkkommunikation ist ein RSSI von besser als -80 anzustreben. Eine Verbesserungsmöglichkeit bietet das versuchsweise Drehen des Micropelt am Heizkörper um 90°. Normalerweise ist der geprägte Schriftzug Micropelt waagerecht wie auch die innen liegende Antenne. Nach der Drehung steht diese dann aufrecht. Das passt in der Praxis dann manchmal besser zu einer waagerecht angeordneten Senderantenne, deren Leistung sich dann gezielter im Haus verbreitet. Ein RSSI von -70 ist besser als -80.
Die Empfangsqualität aller EnOcean-Geräte lässt sich schnell mit <Code>list .* TCM_ESP3_0_RSSI</Code> abfragen, wobei TCM_ESP3_0 der Name des EnOcean-Gateways ist.

Die neueren Modelle beginnen nach einer sehr langen Sommerpause bei leerem Akku schon nach wenigen Minuten mit Vorlauftemperaturen um 30 Grad wieder ihren Betrieb alleine mit dem Strom, den der kleine Thermo-Generator erzeugt.

== ToDos ==
Optimierungstipps, um möglichst wenig Energie im Aktor zu verbrauchen: Sommerbetrieb und Filtern von Sollwert-Verstellungen.

event-on-NN beim Sensor, wakeupCycle

Sorgt Setpoint 0 für eine Initialisierung?

Optimierung von p_i,p_d,p_p in der Praxis

Bedeutung von set <name> liftSet

== Links ==
* {{Link2Forum|Topic=34314|Message=290203|LinkText=Forenbeitrag}}

[[Kategorie:EnOcean Components]]
[[Kategorie:Heizungsventile]]

Micropelt iTRV Kleinstellantrieb

2023-09-29T08:42:10Z

Cwagner: Weitere Modelle erwähnt, kleinere ERgänzungen und Präzisierungen

{{Infobox Hardware
| Bild = ITRV.jpg
| Bildbeschreibung = Batterieloser Heizungssteller
| HWProtocol = EnOcean
| HWType = Aktor
| HWCategory = EnOcean
| HWComm = EnOcean Funk, 868Mhz
| HWProtokoll = EnOcean Protokoll EEP A5-20-01 (Ventil Position in %)
| HWChannels = 1 (bidirektional)
| HWVoltage = 3.2 V, LiFePo-Akku
| HWPowerConsumption = unbekannt
| HWPoweredBy = TEG (Thermoelektrischer Generator;autark)
| HWSize = 59 × 64 × 59 [mm] (Breite × Höhe × Tiefe), Gewicht 260 g
neuere, runde Modelle: 55 x 95 [mm] (Ø x T), 260 g
| HWDeviceFHEM = [http://fhem.de/commandref.html#EnOcean EnOcean]
| HWManufacturer = Micropelt GmbH
}}

'''EnOcean-Micropelt iRTV-Kleinstellantrieb''' ist ein batterieloser Kleinstellantrieb für Raumtemperaturregelung, der seine Energie per Energy Harvesting aus der Wärme des Vorlaufes zieht. Hier wird vorrangig das Modell MVA-002 beschrieben.
Das Modell MVA-004 ist rund und hat einen eigenen PID-Controller, das Modell MVA-005 (ebenfalls rund) hat zusätzlich eine Handverstellung in Ein-Grad-Schritten (bis +/- 5°). Beide Modelle sind noch leiser und sollen laut Hersteller bei schwacher Funkversorgung die Verbindung besser halten. Das Modell MVA-005 hat das EEP A5-20-06, das seit 21.1.2019 von FHEM unterstützt wird.

Aktuell in der Auslieferung sind die Modelle MVA-008 (wie 004) und MVA-009 (wie 005) mit einer USB-Buchse zum Nachladen, falls der eingebaute Speicher leergelaufen sein sollte.

Neben der hier beschriebenen EnOcean-Variante gibt es auch Modelle für LoRaWan.

== Features ==
Kleinstellantrieb, der ohne Batterien auskommt, da er über einen thermolektrischen Generator seine Energie aus der Temperaturdifferenz des Heizungsvorlaufes und der Raumtemperatur bezieht.

== Hinweise zum Betrieb mit FHEM ==

=== Definition/Anlernvorgang ===
4BS-Bidirektionales-Teach-In:

#falls vorhanden, alle bisherigen FHEM Devices des Aktors löschen und nach Speichern der geänderten Konfiguration FHEM neu starten
#FHEM in Lernmodus versetzen: <code><nowiki>set <IODev> teach <time [s]></nowiki></code>
#Taster am iTRV zweimal drücken (Montageposition = 0%). Der erfolgreiche Anlernvorgang wird durch einmaliges Aufleuchten der Status-LED quittiert. (Fehlanzeige: 6mal Blinken)
#Nach Montage Taster einmal drücken - das Ventil fährt die von FHEM gewünschte Position an.
#Aktor-Device wird in FHEM automatisch mit allen notwendigen Parametern angelegt.

Standardmäßig nutzt FHEM den eigenen PID-Regler des FHEM-Moduls, der auf die Eingabe einer Temperaturvorgabe wartet:
<code><nowiki>set <name> desired-temp <wert°C></nowiki></code>

Solange kein Referenz-Device mit <code><nowiki>set <name> temperatureRefDev <Temperaturdevice mit einem Reading temperature></nowiki></code> angegeben wurde, benutzt das Gerät einen internen Temperaturfühler, der bauartbedingt nicht (MVA-005:bedingt) geeignet für eine Raumregelung ist.

Zur Sicherheit des Heizkörperventils gegen Festsetzen durch Rost oder Kalk, wird im Sommermodus pro Tag eine Servicefahrt – einmal auf und zu – des Ventils durchgeführt. Zusätzlich wird dreimal am Tag die Verbindung mit FHEM aufgerufen. Das dient zur Kontrolle, dass alle bislang verbundenen Devices noch vorhanden sind und ordnungsgemäß miteinander kommunizieren.

Wenn mehr als dreimal hintereinander die Funkkommunikation mit FHEM fehlschlug (was mehr als 30 Minuten im Normalbetrieb bedeutet), sendet der Aktor nur noch alle Stunde und - falls das Ventil zu weniger als 50 Prozent geöffent ist, wird es auf 50% aufgefahren bzw. bei MVA-004 und MVA-005 ff. im internen PID-Betrieb auf 21° gesteuert.

'''Durch einmaliges Drücken des Tasters''' kann man im Alltagsbetrieb eine sofortige Funkkommunikation auslösen.

{{Hinweis|Zum Energiesparen verarbeitet der Aktor nur alle 586 oder 587 Sekunden (Sommermodus: alle 8 Stunden) Telegramme von FHEM. Darum zeigen FHEM-Befehle keine sofortige Aktorreaktion, sondern erst nach der genannten Zeitspanne. Die Rückmeldung des Aktors an FHEM über die erfolgte Befehlsausführung erfolgt wiederum erst nach erneutem Ablauf der Zeitspanne.
Falls keine Temperaturdaten geliefert werden, geht das Device in einen Stromsparmodus und fragt nur noch alle 2 Stunden an.
Zur Vermeidung dieses Stromsparmodus, in dem eben auch nicht nachgeregelt wird, sollte bei Referenzgeräte wie einem Raumthermometer das attr event-on-update '''nicht''' benutzt werden. Falls die Temperatur sich 1 Stunde lang nicht ändert, würde entsprechend auch eine Stunde lang kein Referenzwert gesendet, der Stelltrieb in den Sparmodus gehen und für die nächsten 2 Stunden nun kommende Änderungen nicht verarbeiten.
In der Praxis mit einem TCM 310 zeigt sich, dass bei einem RSSI<-80 die Funkkommunikation nicht ausreichend stabil ist. Wenn dreimal hintereinander keine Funktbestätigung erhalten wurde, geht der Aktor in den Notbetrieb und öffnet das Ventil auf 50% oder lässt es auf einem gesetzten größeren Wert bis zur nächsten erfolgreichen bisdirektionalen Kommunikation offen. Das Anpassen der Antennenausrichtung ist hier sehr wichtig.}}

=== Settings ===
{| class="wikitable sortable"
|-
! set !! Wertebereich/Default !! Beschreibung
|-
|desired-temp||10...40||Soll-Temperatur für den FHEM-PID-Controler: der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet
|-
|liftSet||||??
|-
|runInit||||beim nächsten Funkkontakt wird ein Kalibrierungslauf angestoßen
|-
|setpoint||0...100||Setze Aktorposition auf X%; der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet, wenn das attr pidCtrl on ist
|-
|setpointTemp||10...40||Soll-Temperatur für den FHEM-PID-Controler, der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet; ein runInit wird ausgelöst wenn das attr pidCtrl on ist
|-
|ValveCloses||||Ventil auf 0% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|ValveOpens||||Ventil auf 100% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|}

=== Readings ===
{| class="wikitable sortable"
|-
! Reading !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|actuatorState||ok||||wenn 'obstructed', dann ist der metallene Kühlring des Gehäuses z.b. von einem Vorhang bedeckt und der Thermogenerator kann nicht richtig arbeiten
|-
|alarm||no_response_from_actuator||||nur fallweise: wenn Kommunikation ausgefallen; Aktor blinkt dreimal
|-
|battery||ok ||'''ok''' / low||
|-
|cover||closed||||wird vom MVA-002 nicht gesendet
|-
|delta||-9.75||||
|-
|feedTemp
|32.5
|
|Die Modelle ab 004 haben einen zweiten Thermofühler, der verlässlich die Vorlauftemperatur am Ventilsitz misst und zur Steuerung des eingebauten PID-Controlers herangezogen wird.
|-
|energyInput||enabled||'''enabled''' / disabled||enabled zeigt ausreichende Temperaturdifferenz zur Speisung des Akkus an
|-
|energyStorage||charged||'''charged''' / empty ||
|-
|maintenanceMode||off||'''off''' / runinit||
|-
|operationMode||setpointTemp||'''setpointTemp''' / summerMode / setpointSet||'''Betrieb mit Stellwert-Vorgabe''' / im Sommer-Modus / mit Temperatursollwert-Vorgabe
|-
|operationModeRestore||setpointTemp||||nur fallweise: Modus, der beim Beenden des summermode gesetzt wird
|-
|pidAlarm||||actuator_in_errorPos / dead_sensor / no_temperature_value / setpoint_device_missing||
|-
|pidState|||| processing |alarm / idle / '''processing''' / start / stop||
|-
|p_d||0||||
|-
|p_i||100||||
|-
|p_p||-487.5||||
|-
|roomTemp||22.0||||interne Temperatur: wenn attr setpointRefDev nicht gesetzt wird diese Temperatur benutzt - ist für Regelung nicht brauchbar wegen Verfälschung durch Vorlauftemperatur, höhere Temperaturen sind Indiz für Wärmeangebot vom Vorlauf, das den Energiespeicher lädt
|-
|selfCtrl||off||||MVA-002 hat keinen eigenen PID-Controler
|-
|setpoint||0||||beim letzten Funkkontakt gemeldete Ist-Position vom Aktuator in %
|-
|setpointSet||15||||beim nächsten Funkkontakt gesendete Aktuatorstellung in %
|-
|setpointTemp||15.0||||Soll-Temperatur. Kann gesetzt werden über <code><nowiki>set <IODev> desired-temp <°C></nowiki></code> oder auch durch Module wie Heating_Control oder WeekdayTimer
|-
|setpointTempRestore||16.0 ||||nur fallweise: setpointTemp, die bei Beenden des summermode gesetzt wird
|-
|state||T: 23.4 SPT: 15.0 SP: 0||||T:=Raumtemperatur vom Referenzsensor, SPT=setpointTemp, SP=setpoint
|-
|teach||4BS teach-in accepted EEP A5-20-01 Manufacturer: Micropelt GmbH||||Modelle >004: A5-20-06
|-
|temperature||24.75||||zuletzt gemeldete Raumtemperatur vom Referenz-Sensor (siehe Attribut temperatureRefDev)
|-
|waitingCmds||runInit|||noch nicht gesendetes Kommando, hier Kalibrierungslauf|
|-
|wakeUpCycle||240|||das Gerät meldet sich alle 4 Minuten|
|-
|window||closed||open / '''closed'''||wird vom MVA-002 nicht gesendet
|-
|}

=== Attribute ===
{| class="wikitable sortable"
|-
! Attribut !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|actualTemp
|biDir
|
|bei Modellen >004 externer Temperatursensor als Referenz für die interne PID-Regelung
|-
|comMode||biDir||||
|-
|destinationID||unicast||||
|-
|eep||A5-20-01||||MVA-002 bis MVA-004; beim MVA-005 A5-20-06
|-
|manufID||049||||
|-
|pidActorErrorPos||20||||MVA-002 ignoriert diesen Wert und benutzt '''50%''' oder den zuvor gesendeten höheren Stellwert
|-
|pidActorLimitLower||1||||bei 0% Öffnung wird eine Initialisierung ausgelöst?
|-
|pidCtrl||on||||bei on wird der FHEM Pid-Controler benutzt, bei off der im Actor (Modell MVA-002 hat keinen internen PID-Controler, wohl aber MVA-004 und MVA-005)
|-
|pidFactor_I||0.2||||
|-
|pidFactor_P||50||||
|-
|pidSensorTimeout||3600|||| Zahl der Sekunden, in denen der Sensor auf einen Wert vom temperatureRefDev auf einen Wert wartet, sonst Alarm
|-
|pidDeltaTreshold
|2
|1
|Minimale Veränderung der Aktorstellung in Prozent
|-
|rcvRespAction||||||Hier kann eine Aktion eingetragen werden, die bei Rückmeldung des Aktors durchgeführt wird. Details in der FHEM-Referenz
|-
|setpointRefDev||||||Das Device, das die Ventilöffnung (Aktuator) vorgibt, z.B. ein Raumregler, FHEM-PID20. Typischerweise '''nicht gesetzt, es wird der modul-eigene PID-Controler benutzt'''
|-
|setpointSummerMode||2||||Ventilöffnung, die im Sommer gelten soll
|-
|setpointTempRefDev||CC.Kueche||||Eintragen, wenn ein Device, die Solltemperatur vorgibt, z.B. Heating_Control oder ein physischer Raumthermostat, der in FHEM ausgelesen wird.
|-
|subDef||********||||Sender-ID
|-
|subType||hvac.01||||bei MVA-002 bis MVA-004: hvac.01; bei MVA-005: hvac.06
|-
|summerMode||off||||
|-
|teachMethod||4BS||||
|-
|temperatureRefDev||T.Kueche||||Das Device, das fortlaufend die Ist-Temperatur meldet
|-
|webCmd||setpointTemp||||
|-
|}

== Tipps & Tricks ==
Fehlermeldungen wie Sensor '''dead''' oder '''no Response from actuator''' kann man im Betrieb mit einem externen Sensor verhindern, indem man mindestens alle 5 Minuten einen Temperaturwert sendet (gegebenenfalls mit attr event-min-interval im sendenden Temperatur-Device einstellen). Alternativ kann man auch über ein DOIF alle 24 Stunden den Wunschwert mit <Code>set <Devicename> desired-temp 20</Code> wiederholen, wobei 20 beispielhaft eine Wunschtemperatur ist.

Für eine stabile Funkkommunikation ist ein RSSI von besser als -80 anzustreben. Eine Verbesserungsmöglichkeit bietet das versuchsweise Drehen des Micropelt am Heizkörper um 90°. Normalerweise ist der geprägte Schriftzug Micropelt waagerecht wie auch die innen liegende Antenne. Nach der Drehung steht diese dann aufrecht. Das passt in der Praxis dann manchmal besser zu einer waagerecht angeordneten Senderantenne, deren Leistung sich dann gezielter im Haus verbreitet. Ein RSSI von -70 ist besser als -80.
Die Empfangsqualität aller EnOcean-Geräte lässt sich schnell mit <Code>list .* TCM_ESP3_0_RSSI</Code> abfragen, wobei TCM_ESP3_0 der Name des EnOcean-Gateways ist.

Die neueren Modelle beginnen nach einer sehr langen Sommerpause bei leerem Akku schon nach wenigen Minuten mit Vorlauftemperaturen um 30 Grad wieder ihren Betrieb alleine mit dem Strom, den der kleine Thermo-Generator erzeugt.

== ToDos ==
Optimierungstipps, um möglichst wenig Energie im Aktor zu verbrauchen: Sommerbetrieb und Filtern von Sollwert-Verstellungen.

event-on-NN beim Sensor, wakeupCycle

Sorgt Setpoint 0 für eine Initialisierung?

Optimierung von p_i,p_d,p_p in der Praxis

Bedeutung von set <name> liftSet

== Links ==
* {{Link2Forum|Topic=34314|Message=290203|LinkText=Forenbeitrag}}

[[Kategorie:EnOcean Components]]
[[Kategorie:Heizungsventile]]

Set magic

2023-08-07T08:40:07Z

Cwagner: ReadingsVal durch ReadingsNum ersetzt, weil in den Parametern die 0 schon als Zahl eingetragen wurde und es um eine numerische Operation geht.

== Begriff ==
Der Begriff [[set magic]]<ref>{{Link2Forum|Topic=38276|LinkText=Einfache Angabe von Reading-Values in notify Commands}}</ref> steht für die besondere Schreibweise einer Funktion zum Auslesen von [[Gerätevariable|Gerätevariablen]] im Argument einiger FHEM-Befehle. Er ist im Zusammenhang mit der Entstehung dieser Schreibweise geprägt worden.

== Verwendungsbereich ==
Die Schreibweise steht seit Featurelevel 5.7 zur Verfügung.
[[set magic]] kann verwendet werden für die Befehle
* set<ref>{{Link2CmdRef|Anker=set|Lang=de}}</ref>
* setreading<ref>{{Link2CmdRef|Anker=setreading|Lang=de}}</ref>
und als Sonderfälle für
* [[attr]]<ref>{{Link2CmdRef|Anker=attr|Lang=de}}</ref> stateFormat<ref>{{Link2CmdRef|Anker=stateFormat|Lang=de}}</ref>
* [[attr]] wu_dataValues im [[Modul]] [[HP1000]]<ref>{{Link2CmdRef|Anker=HP1000|Lang=de}}</ref>
dazu zählen auch [[Modul|Module]], die Teile der Syntax verwenden
* [[readingsGroup]]<ref>{{Link2CmdRef|Anker=readingsGroup|Lang=de}}</ref> verwendet Präfix und Suffix
oder [[Modul|Module]] mit einer erweiterten Anwendung
* [[DOIF]]<ref>{{Link2CmdRef|Anker=DOIF|Lang=de}}</ref> inhaltliche und funktionale Erweiterungen, wie [[DOIF/Einsteigerleitfaden,_Grundfunktionen_und_Erl%C3%A4uterungen#Ausl.C3.B6ser|Auslöser]]
[[set magic]] vereinfacht Schreibweisen wie
{fhem("setreading <Gerätename> <Readingname> ".ReadingsNum("<Gerätename>","<Readingname>","<Defaultwert>"))}
zu
setreading <Gerätename> <Readingname> [<Gerätename>:<Readingname>:d]

== Syntax 1 ==
[<Präfix>:<Gerätename>:<Name des [[Gerätevariable]]>:<Suffix>]

Der optionale Präfix schränkt die Suche auf bestimmte [[Gerätevariable|Gerätevariablen]] ein.
* '''a''' beschränkt die Suche auf [[Attribute]]
* '''i''' beschränkt die Suche auf [[Internals]]
* '''r''' beschränkt die Suche auf [[Readings]]

Es muss ein gültiger [[Gerätename]] für ein existierendes Gerät angegeben werden.

Es muss eine existierende, nicht leere [[Gerätevariable]] angegeben werden.

Der optionale Suffix extrahiert bestimmte Werte der [[Gerätevariable|Gerätevariablen]].
* '''d''' extrahiert die erste Zahl.
* '''i''' extrahiert die erste Zahl als Ganzzahl.
* '''r'''<'''n'''> extrahiert die erste Zahl, und rundet sie auf '''n''' Dezimalstellen, ohne '''n''' auf eine Stelle.
* '''sec''' liefert die Zeit in Sekunden seit Änderung des Readings.
* '''t''' liefert den Zeitstempel des Readings

== Syntax 2 ==
{(<Perlausdruck>)}
Der [[Gerätename]] kann im Perlausdruck mit $DEV angegeben werden.

== Verwendung ==
Mit [[set magic#Syntax 1|Syntax 1]] im Gegensatz zu [[set magic#Syntax 2|Syntax 2]], ist es möglich ohne Perlkenntnis variable Inhalte zu setzen.

=== Beispiel Syntax 1: Formatieren eines Readingwertes zu einer Ganzzahl ===
In einem [[Gerät]] ''sensor'' wird der Wert des [[Readings|Reading]] ''brightness'' zu einer Ganzzahl umgewandelt und in das [[Readings|Reading]] ''brightness'' des Gerätes ''Anzeige'' geschrieben.

<code>setreading Anzeige brightness [sensor:brightness:i]</code>

=== Beispiel Syntax 2: Inkrementieren eines Readingwertes ===
In einem [[Gerät]] ''PIR'' wird das [[Readings|Reading]] ''Count'' um den Wert 1 erhöht.

<code>setreading PIR Count {(ReadingsNum("PIR","Count",0) + 1)}</code>

== Verweise ==

<references />

[[Kategorie:Glossary]]

DWD OpenData

2022-04-26T21:33:05Z

Cwagner: Ergänzung der Tabelle Kürzel für Forecasts

{{Hinweis|Versionsänderung: Die Vorhersagedaten wurden Mitte September 2018 von CSV auf KML umgestellt. Diese Umstellung ist inkompatibel: das DWD_OpenData-Modul muss aktualisiert werden, einige Reading-Namen haben sich geändert und der Weblink muss deinstalliert und neu installiert werden (siehe diesen {{Link2Forum|Topic=83097|Message=840270|Linktext=Beitrag im Forum}}).}}

{{Infobox Modul
|ModPurpose=Daten vom DWD OpenData Server abrufen
|ModType=d
|ModCmdRef=DWD_OpenData
|ModForumArea=Unterstützende Dienste/Wettermodule
|ModTechName=55_DWD_OpenData.pm
|ModOwner=JensB ({{Link2FU|14024|Forum}}/[[Benutzer Diskussion:JensB|Wiki]])
}}

Der Deutsche Wetterdienst (DWD) stellt Wetterdaten über den [https://www.dwd.de/DE/leistungen/opendata/opendata.html Open Data Server] zur Verfügung. Die Verwendung dieses Dienstes und der vom DWD zur Verfügung gestellten Daten unterliegt den auf der OpenData Webseite beschriebenen Bedingungen. Einen Überblick über die verfügbaren Daten findet man in der Tabelle [https://www.dwd.de/DE/leistungen/opendata/help/inhalt_allgemein/opendata_content_de_en_xls.xls OpenData_weather_content.xls] oder hier: https://opendata.dwd.de/weather/lib/MetElementDefinition.xml.

== Anwendung ==
Aufgrund der unterschiedlichen vom DWD bereitgestellten Datenformate benötigt das Modul zur Dekodierung je nach gewünschtem Funktionsumfang zusätzliche Perl-Module, die nicht standardmäßig vorinstalliert sind und je nach Systemkonfiguration nachinstalliert werden müssen. Außerdem unterstützt das Modul Zeitzonen, um z.B. die Wettervorhersage internationaler Stationen in Ortszeit darstellen zu können. Hierfür sind je nach Systemkonfiguration weitere Einstellungen erforderlich. Auch die Sprache der Wochentage für die Wettervorhersage ist frei wählbar. Je nach Systemkonfiguration ist aber die Standardsprache u.U. auf Englisch eingestellt, was weitere Anpassungen der Systemkonfiguration erforderlich macht.

=== Vorbereitung ===
Im folgenden wird z.T. von einem System mit Rasbian oder Debian mit System-V Startsystem ausgegangen. Auf anderen Betriebssystemen und auf Systemen mit System-D müssen die Installationsschritte ggf. angepasst werden.

1. Für die Wettervorhersage und die Wetterwarnungen:
Installation des Perl-Moduls ''XML::LibXML'' über die System-Kommandozeile mit
<source lang="bash">
sudo apt-get install libxml-libxml-perl
</source>
oder mit CPAN.

2. Weiterhin ist das Perl-Modul '' DateTime'' erforderlich. Dieses lässt sich mit <source lang="bash">sudo apt-get install libdatetime-perl</source> installieren.

3. Falls man einen eigenen Internet-Proxy nutzt:
Die Konfiguration des Proxies für FHEM erfolgt z.B. durch Eintrag von
<pre>
attr global proxy <myProxyHost>:<myProxyPort>
</pre>
in die [[Konfiguration]], wobei ''myProxyHost'' durch den Namen oder die IP-Adresse des Proxy-Servers ersetzt werden muss und für ''myProxyPort'' der Port des Proxy-Servers eingetragen werden muss (oft 3128).

3. FHEM Uhrzeit und Zeitzone:
Durch Eingabe von
<pre>
{localtime()}
</pre>
in die FHEM-Kommandozeile überprüfen, ob die FHEM-Uhrzeit plausibel ist. Ist dies nicht der Fall sollten die Uhrzeit auf Systemebene überprüft werden und ggf. die Systemeinstellungen angepasst werden.
Ermitteln der Bezeichnung der eigenen Zeitzone über die System-Kommandozeile mit
<pre>
tzselect
</pre>
und diese Bezeichnung in die Datei ''/etc/timezone'' eintragen und
<pre>
export TZ=`cat /etc/timezone`
</pre>
der Datei ''/etc/profile'' hinzufügen und dann das System neu starten. Nun muss die Zeitanzeige in FHEM korrekt sein.

4. FHEM Sprache:
Durch Eingabe von
<pre>
{$ENV{LANG}}
</pre> in die FHEM-Kommandozeile überprüfen, in welcher Sprache der Wochentag angezeigt wird. Stimmt die Sprache nicht, dann auf der System-Kommandozeile
<pre>
dpkg-reconfigure locales
</pre> eingeben und aus der Liste z.B. ''de_DE.UTF-8'' zusätzlich auswählen. Dieser Befehl gilt für Debian-basierte Betriebssysteme - für andere Betriebssysteme ist eine analoge Funktion zu verwenden. Mit Eingabe von
<pre>
locale -a
</pre> auf der System-Kommandozeile überprüfen, ob die ausgewählte Sprache nun zur Verfügung steht. Sollte FHEM nach einem Neustart noch immer nicht die gewünschte Sprache verwenden, kann man auf einem System V Linux durch Hinzufügen von z.B.
<pre>
export LANG=de_DE.UTF-8
</pre> in die Datei ''/etc/init.d/fhem'' (irgendwo zwischen ''start'' und ''perl'') und erneutem Neustart von FHEM die Sprache für FHEM erzwingen. Bei einem Systemd Linux kann man die Einstellungen mit ''systemctl edit --full fhem.service'' bearbeiten. Spätestes jetzt muss die Wochentagsanzeige in FHEM korrekt sein.

5. Nur für den Weblink erforderlich:
Installation des Perl-Moduls ''DateTime'' über die System-Kommandozeile mit
<pre>
sudo apt-get install libdatetime-perl
</pre>
oder mit CPAN.

=== Define ===
Siehe {{Link2CmdRef|Anker=DWD_OpenDatadefine|Label=Commandref}}.

=== Attributes ===
Siehe {{Link2CmdRef|Anker=DWD_OpenDataattr|Label=Commandref}}.

== Anwendungsbeispiele ==
=== Beispiel zur Modul-Einrichtung ===

* Wettervorhersage
Für die Wettervorhersage muss der Stationscode ermittelt werden. Dazu den [https://www.dwd.de/DE/leistungen/met_verfahren_mosmix/mosmix_stationskatalog.pdf MOSMIX Stationskatalog] herunterladen, öffnen und die gewünschte Station heraussuchen (Spalte ''id''). Einen Teil der deutschen Stationen kann man auch der [https://www.dwd.de/DE/derdwd/messnetz/bodenbeobachtung/messnetzkarte_boden.pdf Bodenmessnetzkarte] entnehmen. Den ermittelten Stationscode kann man dann entweder für eine Einzelabfrage als Parameter für das Kommando ''get forecast'' verwenden oder für die automatische Aktualisierung als Attribut ''forecastStation'' hinterlegen. Insgesamt werden vom DWD mehr als 70 Merkmale zur Verfügung gestellt. Eine Auflistung findet sich im Dokument [https://opendata.dwd.de/weather/lib/MetElementDefinition.xml MetElementDefinition]. Nur ein kleiner Teil der Merkmale wird in der Standardeinstellung des Moduls als Reading zur Verfügung gestellt. Wer andere Merkmale benötigt muss sie mit Komma getrennt dem Attribut ''forecastProperties'' zuweisen. Es empfiehlt sich zur Performance-Optimierung sowohl das Attribut ''forecastDays'' als auch das Attribut ''forecastProperties'' auf den tatsächlichen Bedarf einzustellen.

* Wetterwarnungen
Für die Wetterwarnungen muss die Warnzelle ermittelt werden. Dazu [https://www.dwd.de/DE/leistungen/opendata/help/warnungen/cap_warncellids_csv.csv Warnzellen-ID Katalog] herunterladen, öffnen und die gewünschte Warnzelle heraussuchen. Unterstützt werden Gemeinden (beginnen mit 8), Landkreise (beginnen mit 1 oder 9) oder Küste (beginnen mit 5). Die Warnzellen-ID kann man dann entweder für eine Einzelabfrage als Parameter für das Kommando ''get alerts'' verwenden oder für die automatische Aktualisierung als Attribut ''alertArea'' hinterlegen. Die Warnzellen-ID ist ab der 2. Stelle identisch mit den ersten Ziffern des amtlichen Gemeindeschlüssels. Man kann z.B. den Namen von Gemeinde oder Landkreis bei den [https://www.statistik-bw.de/Statistik-Portal/gemeindeverz.asp Statistischen Ämtern des Bundes und der Länder] eingeben, den amtlichen Gemeindeschlüssel ermitteln und dann mit vorangestellter 1, 8 oder 9 im Warnzellen-ID Katalog des DWD nach einem Eintrag mit exakter oder weitgehender Übereinstimmung suchen. Wem das zu kompliziert vorkommt, der kann bei mehrdeutigen Gemeinde- bzw. Landkreisbezeichnungen auch versuchen auszuprobieren, welche die richtige Warnzellen-ID ist.

Um das Modul mit automatisch Aktualisierung von Vorhersage und Wetterwarnungen zu nutzen, kann z.B. folgendes in die [[Konfiguration]] eingetragen werden:

<pre>
define DWD DWD_OpenData
attr DWD alertArea 111000000
attr DWD forecastStation 99810
attr DWD forecastDays 3
attr DWD forecastWW2Text 1
</pre>

* Performance
Das DWD_OpenData-Modul ist ein Datenmodul mit relativ vielen Readings. In der Standardkonfiguration wird, wie bei jedem anderen FHEM Modul, bei jeder Änderung jedes Readings ein FHEM internes Ereignis erzeugt, damit andere FHEM Devices auf diese Änderungen reagieren können. Diese Ereignisse sorgen auch dafür, dass man Änderungen in der Weboberfläche sofort angezeigt bekommt, ohne die Webseite neu aufzurufen. Interessiert sich aber kein FHEM Device für die Änderungsbenachrichtigung bestimmter Readings, entsteht unnötiger Verarbeitungs-Overhead, der je nach FHEM Konfiguration und verfügbarer CPU-Leistung auch mehrere Sekunden benötigen kann und in dieser Zeit andere Abläufe blockiert. Um die Performance zu optimieren, empfiehlt es sich, mit [[event-on-update-reading]] für eine angepasste und dadurch effizientere Verarbeitung zu sorgen, indem man nur für jene Readings Ereignisse zulässt, welche man für die Weiterverarbeitung braucht. Der DWD_OpenData_Weblink braucht z.B. gar keine Ereignisse, um zu funktionieren. Hier eine minimalistische Beispielkonfiguration:

<pre>
attr DWD event-on-update-reading state,fc_state,a_state
</pre>

Weitere Details zur Installation und Konfiguration des Moduls finden sich in der
{{Link2CmdRef|Anker=DWD_OpenData|Label=Commandref}}.

=== Beispiel für die Einrichtung eines Meteogramms ===
Um den vorhergesagten Wetterverlauf als Meteogramm in Kurvenform mit [[SVG]] darzustellen, kann man wie folgt vorgehen:

1. 99_myUtils.pm

Für die Bestimmung der Werte für den SVG-Plot wird eine Perl-Funktion benötigt, die in die Datei 99_myUtils.pm vor dem Ende eingefügt wird. Wer diese FHEM-Datei noch nicht nutzt, legt sie einfach an (siehe [[99_myUtils_anlegen]]).
<source lang="perl">
package main;

use strict;
use warnings;

...

#
# (c) mumpitzstuff 19.12.2018
#
# see https://forum.fhem.de/index.php/topic,83097.msg874150.html#msg874150
#
sub logProxy_dwd2Plot($$$$;$$$)
{
my ($device, $fcValue, $from, $to, $fcHour, $expMode, $shiftTime) = @_;
my $regex;
my @rl;

return undef if(!$device);

if ($fcValue =~ s/_$//)
{
$regex = "^fc[\\d]+_[\\d]+_".$fcValue."\$";
}
else
{
$regex = "^fc[\\d]+_".$fcValue."\$";
}

$fcHour = 12 if(!defined($fcHour));
$expMode = "point" if(!defined($expMode));
#Log3 undef,2, "Regex: ".$regex;

# ermitteln aller relevanten Readings
if ( defined($defs{$device}) )
{
if ( $defs{$device}{TYPE} eq "DWD_OpenData" )
{
@rl = sort
{
my ($an) = ($a =~ m/fc(\d+)_.*/);
my ($bn) = ($b =~ m/fc(\d+)_.*/);
my ($ao) = ($a =~ m/fc\d+_(\d+).*/);
my ($bo) = ($b =~ m/fc\d+_(\d+).*/);
$an <=> $bn or $ao <=> $bo or $a cmp $b;
} ( grep /${regex}/,keys %{$defs{$device}{READINGS}} );
return undef if ( !@rl );
}
else
{
Log3 undef, 2, "logProxy_dwd2Plot: $device is not a DWD_OpenData device";
return undef;
}
}

my $fromsec = SVG_time_to_sec($from);
my $tosec = SVG_time_to_sec($to);
my $sec = $fromsec;
my ($h, $hp, $fcDay, $mday, $mon, $year);
my $timestamp;

my $reading;
my $value;
my $prev_value;
my $min = 999999;
my $max = -999999;
my $ret = "";

# while not end of plot range reached
while (($sec < $tosec) && @rl)
{
#remember previous value for start of plot range
$prev_value = $value;

$reading = shift @rl;
($fcDay) = $reading =~ m/^fc(\d+).*/;
($hp) = $reading =~ m/^fc\d+_(\d+).*/;
#Log 1, "hp: ".$hp;

if ($hp)
{
$h = ReadingsVal($device, "fc".$fcDay."_".$hp."_time", $fcHour);
if ($h =~ m/^(\d+):\d+/)
{
$h = $1;
}
}
else
{
$h = $fcHour;
}

$value = ReadingsVal($device, $reading, undef);

# calculate minutes of sunshine per hour
if ($fcValue =~ /^SunD(\d+)/)
{
if (defined($1))
{
$value = $value / ($1 * 36);
}
else
{
$value = $value / (12 * 36);
}
}

# calculate amount of rain per hour
if ($fcValue =~ /^RR(\d+)c$/)
{
if (defined($1))
{
$value /= $1;
}
}

($year, $mon, $mday) = split('\-',ReadingsVal($device, "fc".$fcDay."_date",undef));
$timestamp = sprintf("%04d-%02d-%02d_%02d:%02d:%02d", $year, $mon, $mday, $h, 0, 0);
$sec = SVG_time_to_sec($timestamp);
if (defined($shiftTime))
{
$sec += $shiftTime;
$timestamp = logProxy_shiftTime($timestamp, $shiftTime);
}

# skip all values before start of plot range
next if ( $sec < $fromsec );

# add first value at start of plot range
if ( !$ret && $prev_value )
{
$min = $prev_value if ( $prev_value < $min );
$max = $prev_value if ( $prev_value > $max );
$ret .= "$from $prev_value\n";
}

# done if after end of plot range
last if ($sec > $tosec);

$min = $value if ( $value < $min );
$max = $value if ( $value > $max );

# add actual control point
$ret .= "$timestamp $value\n";
}

if (($sec < $tosec) && !@rl && ($expMode eq "day"))
{
$timestamp = sprintf("%04d-%02d-%02d_%02d:%02d:%02d", $year, $mon, $mday, 23, 59, 59);
$_ = SVG_time_to_sec($timestamp);
if (defined($shiftTime))
{
$_ += $shiftTime;
$timestamp = logProxy_shiftTime($timestamp, $shiftTime);
}

if ($_ < $tosec)
{
$ret .= "$timestamp $value\n";
}
else
{
$ret .= "$to $value\n";
}
}
elsif (($sec > $tosec) && ($expMode eq "day"))
{
$value = $prev_value + ($value - $prev_value) * (86400 + ($tosec - $sec)) / 86400;
$ret .= "$to $value\n";
}

return ($ret, $min, $max, $prev_value);
}

1;
</source>

2. LogProxy

Wer bereits ein [[logProxy]]-Device hat, muss den Namen seines logProxy-Devices in die weiter unter aufgeführte GPlot-Konfiguration eintragen. Ansonsten wird es wie folgt neu erstellt:
<pre>
define LogProxy logProxy
</pre>

3. FileLog

Das Meteogramm kennt anders als andere FHEM-Plots keine Vergangenheit außer heute. Trotzdem wird aus formalen Gründen ein [[FileLog]]-Device benötigt. Dazu kann ein beliebiges vorhandenes FileLog-Device verwendet werden. Wer will, kann hierfür aber auch ein neues FileLog Device für das DWD_OpenData-Device anlegen (Achtung: wird schnell umfangreich):
<pre>
define FileLog_DWD FileLog ./log/DWD-%Y-%m.log DWD
</pre>

Im folgenden wird für das FileLog-Device der Platzhalter ''FileLog_Dummy'' verwendet, der mit dem Namen des gewählten FileLog-Devices zu ersetzen ist.

4. SVG Plot

Das eigentliche Meteogramm ist ein SVG-Device. Will man mehrere Tage darstellen bietet sich die folgende Definition an:
<pre>
define SVG_DWD SVG FileLog_Dummy:SVG_DWD:CURRENT
attr SVG_DWD fixedoffset 6
attr SVG_DWD fixedrange 7days
attr SVG_DWD nrAxis 1,2
</pre>

Dabei muss das SVG-Attribut ''fixedoffset'' entweder gleich oder kleiner als die Einstellung des DWD_OpenData-Attributs ''forecastDays'' (Standardwert: 6 Tage) gewählt werden und das SVG-Attribut ''fixedrange'' um eins größer als ''fixedoffset'' eingestellt werden.

Will man stattdessen nur die nächsten 24 Stunden anzeigen, nimmt man folgende Einstellungen:
<pre>
define SVG_DWD SVG FileLog_Dummy:SVG_DWD:CURRENT
attr SVG_DWD endPlotNow 1
attr SVG_DWD fixedoffset 1
attr SVG_FileLog_WETTER_DWD_3 label "Tmin: $data{max1} °C, Tmax: $data{min1} °C"
attr SVG_DWD nrAxis 1,2
</pre>

Um die DWD_OpenData-Readings mit dem Plot zu verknüpfen, muss man nun die GPlot-Konfigurationsdatei des SVG-Plots manuell bearbeiten. Dazu auf den Link klicken, der im SVG_DWD-Device am Internal ''GPLOTFILE'' steht. Die y-Wertebereiche für die Regenmenge und die Temperaturen sind im Beispiel auskommentiert (Autorange). Das kann man so lassen oder man stellt sie nach den eigenen Wetter-Gegebenheiten ein. Je nach Konfiguration des DWD_OpenData-Attributs ''forecastResolution'' sind aber noch einige weitere Einstellungen anzupassen. Das folgende Beispiel ist für die 3h-Auflösung:
<pre>
set terminal png transparent size <SIZE> crop
set output '<OUT>.png'
set xdata time
set timefmt "%Y-%m-%d_%H:%M:%S"
set xlabel " "
set title 'Wettervorhersage'
set ytics
set y2tics
set grid ytics
set ylabel "Regen [mm]"
#set yrange [0:4]
set y2label "Temperatur [°C]"
#set y2range [-5:35]
set y3label "Wolken/Regen/Sonne [%]"
set y3range [0:100]

#LogProxy Func:logProxy_dwd2Plot("DWD","TTT_",$from,$to,0,"day")
#LogProxy Func:logProxy_dwd2Plot("DWD","Tx",$from,$to,18,"day")
#LogProxy Func:logProxy_dwd2Plot("DWD","Tn",$from,$to,6,"day")
#LogProxy Func:logProxy_dwd2Plot("DWD","SunD3_",$from,$to,0,"day",(-3*3600))
#LogProxy Func:logProxy_dwd2Plot("DWD","RR3c_",$from,$to,0,"day",(-3*3600))
#LogProxy Func:logProxy_dwd2Plot("DWD","FX1_",$from,$to,0,"day")
#LogProxy Func:logProxy_dwd2Plot("DWD","R600_",$from,$to,0,"day",(-3*3600))
#LogProxy Func:logProxy_dwd2Plot("DWD","Neff_",$from,$to,0,"day")
#LogProxy ConstX:TimeNow(),0,100
#LogProxy ConstY:0

plot "<IN>" using 1:2 axes x1y2 title 'T' ls l0 lw 2 with quadraticSmooth,\
"<IN>" using 1:2 axes x1y2 title 'Tmax' ls l0dot lw 2 with quadraticSmooth,\
"<IN>" using 1:2 axes x1y2 title 'Tmin' ls l0dot lw 2 with quadraticSmooth,\
"<IN>" using 1:2 axes x1y3 title 'Sonne' ls l4fill lw 1 with lines,\
"<IN>" using 1:2 axes x1y1 title 'Regenmenge' ls l2fill lw 1 with steps,\
"<IN>" using 1:2 axes x1y3 title 'Wind' ls l1 lw 1 with quadraticSmooth,\
"<IN>" using 1:2 axes x1y3 title 'Regen' ls l5fill lw 1 with quadraticSmooth,\
"<IN>" using 1:2 axes x1y3 title 'Wolken' ls l6fill lw 1 with quadraticSmooth,\
"<IN>" using 1:2 axes x1y3 notitle ls l5 lw 4 with lines,\
"<IN>" using 1:2 axes x1y2 notitle ls l5 lw 1 with lines
</pre>

Verwendet man dagegen eine Auflösung von 1 Stunde, sind folgende LogProxy-Einträge erforderlich:
<pre>
#LogProxy Func:logProxy_dwd2Plot("DWD","TTT_",$from,$to,0,"day")
#LogProxy Func:logProxy_dwd2Plot("DWD","Tx",$from,$to,18,"day")
#LogProxy Func:logProxy_dwd2Plot("DWD","Tn",$from,$to,6,"day")
#LogProxy Func:logProxy_dwd2Plot("DWD","SunD1_",$from,$to,0,"day",(-1*3600))
#LogProxy Func:logProxy_dwd2Plot("DWD","RR1c_",$from,$to,0,"day",(-1*3600))
#LogProxy Func:logProxy_dwd2Plot("DWD","FX1_",$from,$to,0,"day")
#LogProxy Func:logProxy_dwd2Plot("DWD","R101_",$from,$to,0,"day",(-0.5*3600))
#LogProxy Func:logProxy_dwd2Plot("DWD","Neff_",$from,$to,0,"day")
#LogProxy ConstX:TimeNow(),0,100
#LogProxy ConstY:0
</pre>

Für die Darstellung der nächsten 24 Stunden mit einer Auflösung von 1 Stunde nimmt man folgende GPlot-Konfiguration:
<pre>
set terminal png transparent size <SIZE> crop
set output '<OUT>.png'
set xdata time
set timefmt "%Y-%m-%d_%H:%M:%S"
set xlabel " "
set title '<L1>'
set ytics
set y2tics
set y3tics
set grid xtics y2tics
set ylabel "Regen [mm]"
set y2label "Temperatur [°C]"
set y3label "Wolken/Regen/Sonne [%]"
set y3range [0:100]

#LogProxy Func:logProxy_dwd2Plot("DWD","TTT_",$from,$to,0,"day")
#LogProxy Func:logProxy_dwd2Plot("DWD","SunD1_",$from,$to,0,"day",(-1*3600))
#LogProxy Func:logProxy_dwd2Plot("DWD","RR1c_",$from,$to,0,"day",(-1*3600))
#LogProxy Func:logProxy_dwd2Plot("DWD","FX1_",$from,$to,0,"day")
#LogProxy Func:logProxy_dwd2Plot("DWD","R101_",$from,$to,0,"day",(-0.5*3600))
#LogProxy Func:logProxy_dwd2Plot("DWD","Neff_",$from,$to,0,"day")
#LogProxy ConstY:0

plot "<IN>" using 1:2 axes x1y2 title 'T' ls l0 lw 2 with quadraticSmooth,\
"<IN>" using 1:2 axes x1y3 title 'Sonne' ls l4fill lw 1 with lines,\
"<IN>" using 1:2 axes x1y1 title 'Regenmenge' ls l2fill lw 1 with steps,\
"<IN>" using 1:2 axes x1y3 title 'Wind' ls l1 lw 1 with quadraticSmooth,\
"<IN>" using 1:2 axes x1y3 title 'Regen' ls l5fill lw 1 with quadraticSmooth,\
"<IN>" using 1:2 axes x1y3 title 'Wolken' ls l6fill lw 1 with quadraticSmooth,\
"<IN>" using 1:2 axes x1y2 notitle ls l2 lw 2 with lines
</pre>

Je nachdem, welche Auflösung man verwendet, werden unterschiedliche Readings des DWD_OpenData-Devices benötigt. Diese sind in den LogProxy-Zeilen in der GPlot-Konfigurationsdatei zu finden und müssen auf jeden Fall dem Attribut ''forecastProperties'' des DWD_OpenData-Device hinzugefügt werden.

Viele Detaileinstellungen des Meteogramms lassen sich individualisieren. Man kann z.B. mehr oder weniger Daten anzeigen und zumindest für ''heute'' auch aktuelle Messwerte hinzufügen.

Hier ein Beispiel für ein Meteogramm über 4 Tage mit 3 Stunden Auflösung:

[[File:DWDODmeteogram4d3h.png|500px]]

=== Beispiel für die Einrichtung eines Weblinks ===
Zur graphischen Darstellung der Vorhersage und der Wetterwarnungen mit [[FHEMWEB]] steht das Modul [https://raw.githubusercontent.com/jnsbyr/fhem/master/FHEM/99_DWD_OpenData_Weblink.pm 99_DWD_OpenData_Weblink.pm] zur Verfügung.

Zunächst die Moduldatei herunterladen und in das Modulverzeichnis ''fhem/FHEM'' kopieren. Entweder die Datei direkt auf den FHEM-Server herunterladen (z.B. mit ''wget'') oder beim indirekten Herunterladen darauf achten, dass dabei das Encoding nicht verändert wird (also z.B. bei WinSCP den Binär-Modus und nicht den Text-Modus verwenden). Ansonsten werden später z.B. Sonderzeichen wie ''°C'' falsch angezeigt.

Anschließend kann in die [[Konfiguration]] z.B. folgendes eingetragen werden:

<pre>
define DWD_Weblink_Generator DWD_OpenData_Weblink
attr DWD_Weblink_Generator IODev DWD
attr DWD_Weblink_Generator forecastDays 4
# refreshRate nur dann setzten, wenn der Browser Java-Script beherrscht:
attr DWD_Weblink_Generator refreshRate 900

define DWD_Weblink weblink htmlCode { DWD_OpenData_Weblink::AsHtmlH("DWD_Weblink_Generator") }
</pre>

Damit legt man das Weblink-Generator-Device an und verknüpft es mit dem DWD_OpenData-Device. Außerdem wird der [[weblink ]] selbst angelegt, der seinerseits mit dem Weblink-Generator-Device verknüpft wird. Der Weblink benötigt für seine Funktion eine bestimmte Auswahl der Vorhersage-Merkmale. Wer das Attribut ''forecastProperties'' des DWD_OpenData-Moduls anpassen will, muss diese Merkmale auf jeden Fall mit berücksichtigen.

Wenn vom Weblink nichts im Browser zu sehen ist, kann das daran liegen, dass der Browser kein aktuelles JavaScript verwendet oder JavaScript deaktiviert ist. Dann sollte das Attribut ''refreshRate'' auf 0 Sekunden eingestellt oder gelöscht werden. Mit aktiviertem Refresh werden die Daten auch ohne Seitenneuaufbau regelmäßig und bei Tab-Wechsel aktualisiert.

Die Liste der erforderlichen Vorhersage-Merkmale finden sich zusammen mit allen weiteren Details zur Installation und Konfiguration in der Modulhilfe von ''99_DWD_OpenData_Weblink.pm'', die man z.B. nach dem Anlegen des Weblink-Generator-Devices über die Weboberfläche abrufen kann.

Hier ein Ausschnitt aus der Darstellung des Weblinks mit [[FHEMWEB]]:

[[File:DWDODweblink.png|500px]]

FHEM Connector für Amazon Alexa

2021-08-25T16:01:30Z

Cwagner: mehrere Namen im attr alexaName werden durch Komma getrennt

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

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

* SONOS Beam und SONOS One

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

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

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

==Einführung==

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

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

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

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

==Installation==

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

===node.js installieren===

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

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

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

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

'''Anmerkung:''' diese Aussage bzgl. node-Version (und Jessie/Stretch) stimmt wohl für alexa-fhem Stand heute (12.06.2020) nicht mehr, siehe https://forum.fhem.de/index.php/topic,112025.msg1063218.html#msg1063218

=== Alexa-FHEM installieren ===

Nun installieren wir Alexa-fhem aus dem offiziellen Repository:

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

Der Vorgang benötigt etwas Zeit.

=== Alexa-FHEM aktivieren ===

Wechsele jetzt in FHEM-Web!

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

* Zuerst bitte einfach einmal die Seite neu laden.

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

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

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

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

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

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

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

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

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

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

Du solltest dann folgende Ausgabe erhalten:

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

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

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

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

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

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

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

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

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

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

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

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

Wähle die Geräte aus, rufe sie auf und setze das Attribut "alexaName". Hierbei in Kürze nur der Hinweis:
* Keine Angst vor Leerzeichen und Umlauten, funktioniert.
* Große Angst vor Rechtschreibfehlern (Terrasse, Rollladen) oder komplizierten Wörtern "handgebastelte Martinslaterne im Kinderzimmer Iphigenie-Chantal".
* Mehrere Namen für dasselbe Gerät/Device in fhem werden unterstützt. Mehrere Namen werden durch Strichpunkt getrennt<ref>Feature nicht dokumentiert {{Link2Forum|Topic=74041|LinkText=Forumsthread}}</ref>.
* Das Attribut "alexaRoom" ist NUR FÜR DEN CUSTOM SKILL relevant. Ausnahme: structure und LightScene Devices, siehe: [[FHEM_Connector_f%C3%BCr_Amazon_Alexa#Was_geht_alles_.3F]].

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

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

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

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

 '''Mehrere Namen für dasselbe Gerät/Device in fhem sind möglich.''' 
Die Namen werden durch <s>Strichpunkt</s> Komma getrennt. 
Beispiel: 
<code>attr dmLampe alexaName Lichtkuppel,Lichtkugel</code>

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

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

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

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

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

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

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

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

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

== Was geht alles ? ==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

* Alarmmelder (noch nicht in Deutschland):
** genericDeviceType Security
** homebridgeMapping Alarm=<reading>[,type=[fireAlarm|waterAlarm|burglaryAlarm|carbonMonoxideAlarm]]
** wenn der type nicht angegeben wird ist fireAlarm der default
** automatisch werden 0, ok und alles was mit no anfängt als OK erkannt. alles andere gilt als ALARM.

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

to be continued ...

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

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

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

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

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

'''Vorgeschichte''':

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

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

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

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

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

set alexa add voicetrigger1
set alexa restart
</syntaxhighlight>

'''Fehlersuche:'''

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

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

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

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

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

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

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

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

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

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

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

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

Auf der Kommandoshell:

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

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

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

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

== Sicherheitskonzept und Secrets ==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

==Hinweise==
<references />

DOIF/uiTable Schnelleinstieg

2021-05-09T06:38:00Z

Cwagner: Komma in $prop in Randnotiz cards ergänzt

[[Datei:UiTable state screen.png|700px|rechts|Webansicht bestehend aus mehreren DOIF/uiTable-Definitionen]]
An dieser Stelle wird das DOIF-Web-Interface erklärt, welches über das DOIF-Attribut '''uiTable''' realisiert wurde.

Abhängig von der Art der Funktion können in einer tabellarischen Darstellung FHEM-Geräte visualisiert und über die Web-Oberfläche bedient werden. Eventbasierte Änderungen visualisierter Readings werden unmittelbar in der Web-Ansicht aktualisiert. Eine erstellte Tabelle erscheint unterhalb der Statuszeile eines DOIF-Devices. Das uiTable-Attribut kann in bereits bestehenden DOIFs oder in funktionslosen DOIFs, wie in den unteren Beispielen, als reines WEB-Interface erstellt werden. In der Abbildung rechts ist ein Statusbildschirm aus vier Spalten mit mehreren DOIF/uiTable-Definitionen aufgebaut worden. 

Die Darstellungsmöglichkeiten werden anhand von Beispielen insb. mit Hilfe bereits im DOIF-Modul vordefinierter uiTable-Funktionen aufgezeigt. Diese Perlfunktionen sind in einem eigenen Package namens 'ui_Table' definiert worden. Mit Hilfe dieser Funktionen lassen sich recht einfach, ohne tiefere HTML/CSS-Kenntnisse, eigene Übersichten definieren. Im Anschluss werden typische '''[[DOIF/uiTable Schnelleinstieg#Anwendungsbeispiele|Anwendungsbeispiele]]''' aufgezeigt.

Die folgenden Beispieldefinitionen arbeiten mit konkreten Geräten und Readings, sie können als RAW-Definition ins eigene System übernommen werden, dazu müssen die Gerätenamen, Readings, ggf. auch Icons den existierenden Namen des eigenen Systems angepasst werden. Zum Ausprobieren der Beispiele können statt echter Geräte auch Dummys benutzt werden.

== Aufbau des uiTable-Attributs ==
Im uiTable-Attribut wird in erster Linie die zu visualisierende Tabelle definiert. Optional können zuvor ein Perlblock sowie Templates definiert werden.
{{Randnotiz|RNText='''Aufbau des Attributs'''
* das uiTable-Attribut besteht aus drei Bereichen:
* [[DOIF/uiTable Schnelleinstieg#Der Perlblock|Perlblock]]
* [[DOIF/uiTable Schnelleinstieg#uiTable-Templates|Templates-Definitionen]]
* [[DOIF/uiTable Schnelleinstieg#Die Tabellendefinition|Tabellendefinition]]
}}
'''Aufbaustruktur'''
<syntaxhighlight lang="perl">
{
<Perlblock, optional>
}

<Templates-Definitionen, optional>

<Tabellendefinition>
</syntaxhighlight>
=== Der Perlblock ===
Der Perlblock dient dazu, das Layout der Tabelle zu beeinflussen sowie eigene uiTable-Funktionen zu definieren. Hier wird insb. das Package definiert, welches für die Tabellendefinition gilt. Ebenfalls können CSS-Variablen sowie Steuerungsattribute gesetzt werden. Der Perlblock beginnt und endet mit einer geschweiften Klammer.

==== CSS-Variablen und Steuerungsattribute ====
Mit Hilfe von CSS-Variablen kann das Layout der Tabelle beeinflusst werden. Die Steuerungsattribute beeinflussen die Statuszeile sowie die Detailansicht des DOIF-Moduls.
{{Randnotiz|RNText='''CSS-Variablen und Steuerungsattribute'''
*Das Layout der gesamten Tabelle wird beeinflusst über die Variablendefinition: '''$TABLE="<CSS-Attribute der Tabelle>"'''
*Spaltenformatierungen werden beeinflusst mit Hilfe der Variablendefinition: '''$TC{<Zellenbereich für Spalten>}="<CSS-Attribute der Spalten>"'''
*Zeilenformatierungen werden beeinflusst mit Hilfe der Variablendefinition: '''$TR{Zeilenbereich}="<CSS-Attribute der Zeilen>"'''
*einzelne Zellen werden beeinflusst mit Hilfe der Variablen: '''$TD{<Zellenbereich für Zeilen>}{<Zellenbereich für Spalten>}="<CSS-Attribute der Zellen>"'''
*für Zellen-, Spalten- und Zeilen-Bereich gilt: '''<Zahl><nowiki>|</nowiki><kommagetrennte Aufzählung><nowiki>|</nowiki><Bereich von..bis>'''
*Der Status in der Statuszeile des DOIFs wird ausgeblendet mit '''$SHOWNOSTATE=1'''
*Die Gerätezeile des DOIFs wird ausgeblendet mit '''$SHOWNODEVICELINE = "<regex room>"'''
*Die Tabelle des DOIFs wird ausgeblendet mit '''$SHOWNOUITABLE = "<regex room>"'''
*Die Detailansicht wird umorganisiert mit '''$ATTRIBUTESFIRST=1'''
}}
'''Bespieldefinition'''
<syntaxhighlight lang="perl">
defmod di_bsp_layout DOIF ##
attr di_bsp_layout uiTable { ## Beginn des Perlblocks\
## CSS-Variablen\
\
## Die Tabelle soll ein Hintergrundbild der Größe 300x300 Pixel haben\
$TABLE = "width:300px;; height:300px;; background-image:url(/fhem/www/pgm2/images/Grundriss.png);; background-size: 300px 300px;;";;\
\
## die Zelle der ersten Zeile und der ersten Spalte soll rechts eine Rahmenlinie haben\
$TD{0}{0} = "style='border-right-style:solid;; border-right-width:10px'";;\
\
## Die erste Zeile soll aus der Klasse 'odd' sein und fett-Schrift haben\
$TR{0} = "class='odd' style='font-weight:bold'";;\
\
## die Spalten 2 bis 6 sollen zentriert sein\
$TC{1..5} = "align='center'";;\
\
## die Spalten 2, 4 und 5 sollen zentriert sein\
$TC{1,3,5} = "align='center'";;\
\
## die letzte Spalte der Tabelle soll fett sein\
$TC{last} = "style='font-weight:bold'";;\
\
\## Steuerungsattribute\
\
\## Ausblenden des Status in der Statuszeile\
$SHOWNOSTATE=1;;\
\
## Die Gerätezeile wird ausgeblendet in allen Räumen\
$SHOWNODEVICELINE = ".*";;\
\
## Die Tabelle wird im Raum info ausgeblendet\
$SHOWNOUITABLE = "^info$";;\
\
## Die Detailansicht wird umorganisiert, hilfreich beim Editieren längerer uiTable-Definitionen\
$ATTRIBUTESFIRST = 1;;\
} ## Ende des Perlblocks
</syntaxhighlight>

=== Die Tabellendefinition ===
==== Einfache Tabellendefinition ohne Funktionen ====
{{Randnotiz|RNText='''Tabellendefinition'''
* eine Tabelle wird aus Zellen zusammengebaut
* mehrere Zellen werden mit <nowiki>|</nowiki> von einander getrennt, sie bilden eine Tabellenzeile
* eine neue Tabellenzeile beginnt mit einer neuen Zeile in der Tabellendefinition
* eine Tabellenzeile kann auch in mehreren Zeilen definiert werden, diese müssen dann mit <nowiki>|</nowiki> enden
* Texte werden in Anführungszeichen angegeben
* Readings werden in der Form [<device>:<reading>] angegeben
* Kommentare beginnen mit ## und enden mit Zeilenende
* Events eines definierten Readings, führen sofort zu Aktualisierung seines Inhalts in der visualisierten Tabelle
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod ui_Table_definition DOIF ##
attr ui_Table_definition uiTable { ## Perlblock für globale Tabellendefinitionen\
\
$TC{1..2}="align='center'" ## zentrierte Ausrichtung der zweiten und dritten Spalte\
\
}\
\
## Tabellendefinition\
\
"Warmwasser"|"Vorlauf"|"Rücklauf" ## erste Tabellenzeile\
## zweite Tabellenzeile\
[T_Warmwasserspeicher:temperature]| ## Zeile wird fortgesetzt, da sie mit | endet\
[T_Vorlauf:temperature]| ## Zeile wird fortgesetzt, da sie mit | endet\
[T_Ruecklauf:temperature]
</syntaxhighlight>

''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable Definition.png|mini|ohne]]

==== Tabellendefinition mit Berechnungen ====
{{Randnotiz|RNText='''Zellenauswertung'''
* jede Zelle der Tabelle wird über Perl ausgewertet
* Readingangaben der Form [<device>:<reading>] werden in eine Perlfunktion übersetzt
* das Ergebnis des ausgewerteten Perlausdrucks wird ausgegeben
* in einer Zelle können beliebige Perlfunktionen genutzt werden
* Texte oder Funktionen können mit Punkt aneinander gehängt werden
* mit Komma werden Texte oder Werte untereinander dargestellt
* wird eine Zeile mit < abgeschlossen, so wird die aktuelle Tabelle abgeschlossen, die nächste Zeile beginnt in einer neuen Tabelle
* in einer Berechnung sollte ein Trigger in Form einer Readingangabe [<device>:<reading>] vorkommen, sonst wäre das Ergebnis statisch und würde sich nicht ändern
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_uiTable_calc DOIF ##
attr di_uiTable_calc uiTable ## Tabellendefinition\
"Differenz"|[T_Ruecklauf:temperature]-[T_Vorlauf:temperature]\
"Minimum"|minNum([TH_WZ_HM:measured-temp],[TH_Keller_HM:measured-temp])\
"Durchschnitt"|([T_Ruecklauf:temperature]+[T_Vorlauf:temperature])/2
</syntaxhighlight>

''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable calc.png|mini|ohne]]

== Vordefinierte uiTable-Funktionen ==
Typische Widgets bzw. Styles wurden als Perl-Funktionen im package ui_Table für eine einfache Tabellendefinition programmiert. Im folgenden wird näher auf die einzelnen uiTable-Funktionen eingegangen.

=== FHEM-Widgets mit der Funktion '''widget''' ===
Alle in FHEM vorhanden Widgets können mit Hilfe der Perlfunktion '''widget''' genutzt werden. Bei häufiger Nutzung eines bestimmten Widgets bietet sich alternativ die Definition einer uiTable-Funktion (Typ 3) mit dem jeweiligen Widget an, siehe: [[DOIF/uiTable Schnelleinstieg#Eigene uiTable-Funktionen programmieren|uiTable-Funktion]]
{{Randnotiz|RNText=Funktion '''widget'''
<syntaxhighlight lang="perl">
widget(<Reading>,$fhem_widget,$set)

Reading # [<device>:<reading>]
$fhem_widget # Angabe des FHEM-Widgets
$set # optional, undef zum Setzen beliebiger Readings (entspricht setreading), "set" wenn das Reading per set-Befehl gesetzt wird (siehe Attribut ReadingList), "set <Befehl>", wenn sich der Befehl vom Reading unterscheidet, default undef
</syntaxhighlight>

'''nützliche Links'''
* [[FHEMWEB/Widgets|Fhem-Widgets]]
* Fhem-Widgets als [[DOIF/uiTable Schnelleinstieg#Eigene uiTable-Funktionen programmieren|uiTable-Funktion]]
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_uiTable_widget DOIF ##
attr di_uiTable_widget uiTable ## FHEM-Widgets mit Hilfe der WID-Funktion\
{package ui_Table}\
"Widget"\
"Select"| widget([uhr:wochentag],"select,Montag,Dienstag,Mittwoch,Donnerstag,Freitag,Samstag,Sonntag")\
"Selectnumbers"| widget([motor:spannung],"selectnumbers,0,0.5,12,1,lin")\
"Slider"| widget([bla:wert],"slider,0,5,100,1")\
"Colorpicker RGB"| widget([Lampe:farbe],"colorpicker,RGB")\
"Colorpicker HSV"| widget([Lampe:farbe],"colorpicker,HSV")\
"Colorpicker CT"| widget([Lampe:waerme],"colorpicker,CT,2000,10,6500")\
"Colorpicker HUE"| widget([Lampe:farbe],"colorpicker,HUE,0,1,359")\
"Colorpicker BRI"| widget([Lampe:helligkeit],"colorpicker,BRI,0,1,100")\
"Time"| widget([start:zeit],"time")\
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable WID.png|mini|ohne]]

=== SVG-uiTable-Funktionen ===
SVG-uiTable-Funktionen sind skalierbare Widgets, die auf SVG-Elementen basieren. Bei allen SVG-Funktionen für Temperatur bzw. Feuchtigkeit wird die Einfärbung abhängig vom Temperatur- bzw. Feuchtigkeitswert mit Hilfe einer Zuordnungsfunktion bestimmt.

==== '''ring'''-Funktionen ====
===== Farbskalierte Temperaturanzeige mit Hilfe der SVG-Funktionen '''temp_ring/temp_mring''' =====
Die Farbe der dargestellten Temperatur ist abhängig vom Temperaturwert. Die Helligkeit der Farbgebung ist einstellbar. Bei der '''temp_mring'''-SVG-Funktion wird der Ring einfarbig dargestellt.

Farbskalierung der '''temp_ring'''-SVG-Funktion:
[[Datei:Farbskalierung temp_ring_scaling.png|600px|ohne]]

Farbskalierung der '''temp_mring'''-SVG-Funktion:
[[Datei:Farbskalierung temp_mring_scaling.png|600px|ohne]]

{{Randnotiz|RNText=SVG-uiTable-Funktion '''temp_ring/temp_mring'''
<syntaxhighlight lang="perl">
temp_ring/temp_mring ($temp_value,$temp_min,$temp_max,$size, $lightring,$lightnumber,$decFont)

$temp_value # Temperatur
$temp_min, # minimale Temperatur, optional, default=-20
$temp_max, # maximale Temperatur, optional, default=60
$size, # Größe der Grafik, optional, default=80
$lightring, # Helligkeit des Ringes (0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (0-100), optional, default=50
$decFont # "<Anzahl der Nachkommastellen>,<Schrift-SVG-Attribute Wert>,<Schrift-SVG-Attribute Einheit>", optional
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_temp_ring DOIF ##
attr di_temp_ring uiTable {package ui_Table}\
"außen (standard)"|temp_ring([Aussensensor:temperature])\
"Warmwasser (größer,aufgehellt,Normalschrift)" |temp_mring([vaillant:WWSpeicher],15,70,110,90,100,"1,font-weight:normal")\
"Vorlauf (größer)"| temp_mring([ESPEasy_ESP_Temp_Vorlauf:Temperature],15,45,100)
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:temp_ring_bsp.png|ohne|mini]]

===== Farbskalierte Feuchtigkeitsanzeige mit Hilfe der SVG-Funktionen '''hum_ring/hum_mring''' =====
Die Farbe der dargestellten Feuchtigkeit ist abhängig vom Feuchtigkeitswert. Die Helligkeit der Farbgebung ist einstellbar. Bei der '''hum_mring'''-SVG-Funktion wird der Ring einfarbig dargestellt.

Farbskalierung der '''hum_ring'''-SVG-Funktion:
[[Datei:Farbskalierung hum_ring_scaling.png|600px|ohne]]

Farbskalierung der '''hum_mring'''-SVG-Funktion:
[[Datei:Farbskalierung hum_mring_scaling.png|600px|ohne]]

{{Randnotiz|RNText=SVG-uiTable-Funktion '''hum_ring/hum_mring'''
<syntaxhighlight lang="perl">
hum_ring/hum_mring ($hum_value,$size,$lightring,$lightnumber,$decFont)
$hum_value # Feuchtigkeit
$size # Größe der Grafik, optional, default=80
$lightring # Helligkeit des Ringes (0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (0-100), optional, default=50
$decFont # "<Anzahl der Nachkommastellen>,<Schrift-SVG-Attribute Wert>,<Schrift-SVG-Attribute Einheit>", optional
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_hum_ring DOIF ##
attr di_hum_ring room test2
attr di_hum_ring uiTable {package ui_Table}\
"klein ohne Farbverlauf"|hum_mring([Aussensensor:humidity],60)\
"normal groß mit Farbverlauf"|hum_ring([Aussensensor:humidity])\
"groß ohne Farbverlauf aufgehellt"|hum_mring([Aussensensor:humidity],100,80)
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:hum_ring_bsp.png|ohne|mini]]

===== Farbskalierte Anzeige eines Zahlenwertes mit Hilfe der universellen SVG-Funktion '''ring''' =====
Die Farbe des dargestellten Wertes kann abhängig vom Wert bestimmt werden.
{{Randnotiz|RNText=SVG-uiTable-Funktion '''ring'''
<syntaxhighlight lang="perl">
ring ($value,$min,$max,$minColor,$maxColor,$unit, $size,$colorRef,$decFont,$gradient,$light,$lightnumber)

$value # darzustellender Wert
$min # minimaler Wert, optional, default=0
$max # maximaler Wert, optional, default=100
$minColor # Farbe (hue: 0-360) des kleinsten Wertes, optional, default = undef
$maxColor # Farbe (hue: 0-360) des maximalen Wertes, optional, default = undef
$unit # Einheit des Wertes, optional, default = undef
$size # Größe der Grafik, optional, default = 100
$colorRef # Referenz auf eine Funktion, die zu einem Wert einen Farbwert (hue: 0-360) bestimmt, oder eine Referenz auf eine Arrayliste mit Grenzwerten und Farben, optional, default = undef
$decFont # "<Anzahl der Nachkommastellen>,<Schrift-SVG-Attribute Wert>,<Schrift-SVG-Attribute Einheit>", optional
$gradient # Farbverlauf, optional, undef mit Farbverlauf, 1 ohne Farbverlauf, default = undef
$ligh # Helligkeit der Grafik (light:0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (light:0-100), optional, default=50
</syntaxhighlight>
Wird '''$colorFunc''' nicht angegeben, so wird der Farbwert zwischen '''$minColor''' und '''$maxColor''' linear interpoliert
}}

'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_ring DOIF (1)
attr di_ring room test5,testeinzel
attr di_ring uiTable {package ui_Table}\
## von 0 bis 20 in Farben von grün (hue:120) bis rot (hue:0)\
"Umlaufmenge"|ring(12.9,0,20,120,0,"l/min",100)\
\\
## von 0 bis 3 in Farben von rot (hue:0) bis türkis (hue:180), eine Nachkommastelle, Schriftgröße 170%\
"Wasserdruck"|ring(1.2,0,3,0,180,"bar",100,undef,"1,font-size:170%")\
\
## Temperaturdarstellung, entspricht dem Funktionsaufruf:\
## temp_ring ([Aussensensor:temperature],-20,60,100,"1,font-weight:normal;;font-size:140%")\
## Eine Nachkommastelle, Normalschrift, Schriftgröße 140%\
"Temperatur"|ring(12.5,-20,60,undef,undef,"°C",100,\&temp_hue,"1,font-weight:normal;;font-size:140%")
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:ring_bsp.png|ohne|mini]]

===== Farbskalierte Temperatur- und Feuchtigkeitsanzeige mit Hilfe der SVG-Funktion '''temp_hum_ring''' =====
Die Farbe ist jeweils abhängig vom dargestellten Temperatur- bzw. Feuchtigkeitswert. Die Helligkeit der Farbgebung ist einstellbar:
[[Datei:Farbskalierung temp_hum_ring_scaling.png|600px|ohne]]

{{Randnotiz|RNText=SVG-uiTable-Funktion '''temp_hum_ring'''
<syntaxhighlight lang="perl">
temp_hum_ring ($temp_value,$hum_value,$temp_min,$temp_max,$size, $lightring,$lightnumber,$decFontTemp,$decFontHum)

$temp_value # Temperatur
$hum_value # Feuchtigkeit
$temp_min # minimale Temperatur, optional, default=-20
$temp_max # maximale Temperatur, optional, default=60
$size # Größe der Grafik, optional, default=90
$lightring # Helligkeit des Ringes (0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (0-100), optional, default=50
$decFontTemp # Temperatur: "<Anzahl der Nachkommastellen>,<Schrift-SVG-Attribute Wert>,<Schrift-SVG-Attribute Einheit>", optional
$decFontHum # Feuchtigkeit: "<Anzahl der Nachkommastellen>,<Schrift-SVG-Attribute Wert>,<Schrift-SVG-Attribute Einheit>", optional
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_temp_hum_ring DOIF ##
attr di_temp_hum_ring uiTable {package ui_Table}\
\
"klein"|temp_hum_ring([Aussensensor:temperature],[Aussensensor:humidity],undef,undef,60)\
"normal"|temp_hum_ring([Aussensensor:temperature],[Aussensensor:humidity])\
"größer, aufgehellt"|temp_hum_ring([Aussensensor:temperature],[Aussensensor:humidity],undef,undef,100,undef,80)\
"größer, Ring aufgehellt, Normalschrift"|temp_hum_ring([Aussensensor:temperature],[Aussensensor:humidity],undef,undef,100,80,50,"1,font-weight:normal","0,font-weight:normal")
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:temp_hum_ring_bsp.png|ohne|mini]]

===== Farbskalierte Anzeige von zwei Temperaturwerten mit Hilfe der SVG-Funktion '''temp_temp_ring''' =====
Die Farbe ist jeweils abhängig vom dargestellten Temperaturwert. Die Helligkeit der Farbgebung ist einstellbar:
[[Datei:Farbskalierung temp_temp_ring_scaling.png|600px|ohne]]

{{Randnotiz|RNText=SVG-uiTable-Funktion '''temp_temp_ring'''
<syntaxhighlight lang="perl">
temp_temp_ring ($temp1_value,$temp2_value,$temp_min,$temp_max,$size, $lightring,$lightnumber,$decFontTemp1,$decFontTemp2)

$temp1_value # erster Temperaturwert
$temp2_value # zweiter Temperaturwert
$temp_min # minimale Temperatur, optional, default=-20
$temp_max # maximale Temperatur, optional, default=60
$size # Größe der Grafik, optional, default=90
$lightring # Helligkeit des Ringes (0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (0-100), optional, default=50
$decFontTemp1 # Temperatur1: "<Anzahl der Nachkommastellen>,<Schrift-SVG-Attribute Wert>,<Schrift-SVG-Attribute Einheit>", optional
$decFontTemp2 # Temperatur2: "<Anzahl der Nachkommastellen>,<Schrift-SVG-Attribute Wert>,<Schrift-SVG-Attribute Einheit>", optional
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_temp_temp_ring DOIF ##
attr di_temp_temp_ring uiTable {package ui_Table}\
"klein, Ring augehellt"|temp_temp_ring([Vorlauf:Temperature],[Ruecklauf:Temperature],15,60,60,80,50)\
"normal"|temp_temp_ring([Vorlauf:Temperature],[Ruecklauf:Temperature],15,60)\
"groß, Zahlen aufgehellt"|temp_temp_ring([Vorlauf:Temperature],[Ruecklauf:Temperature],15,60,100,undef,80)
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:temp_hum_temp_bsp.png|ohne|mini]]

===== Farbskalierte Anzeige von zwei Zahlenwerten mit Hilfe der universellen SVG-Funktion '''ring2''' =====
Die Farbe der dargestellten Werte kann abhängig vom Wert bestimmt werden.
{{Randnotiz|RNText=SVG-uiTable-Funktion '''ring2'''
<syntaxhighlight lang="perl">
ring2 ($value1,$min1,$max1,$minColor1,$maxColor1,$unit1,$size,$colorFunc1,$decFont1,
$value2,$min2,$max2,$minColor2,$maxColor2,$unit2,$colorFunc2,$decFont2)

$value1 # darzustellender Wert1
$min1 # minimaler Wert, optional, default=0
$max1 # maximaler Wert, optional, default=100
$minColor1 # Farbe (hue: 0-360) des kleinsten Wertes, optional, default = undef
$maxColor1 # Farbe (hue: 0-360) des maximalen Wertes, optional, default = undef
$unit1 # Einheit des Wertes, optional, default = undef
$size # Größe der Grafik, optional, default = 100
$colorFunc1 # Funktion, die zu einem Wert einen Farbwert (hue: 0-360) bestimmt, optional, default = undef
$decFont1 # "<Anzahl der Nachkommastellen>,<Schrift-SVG-Attribute Wert>,<Schrift-SVG-Attribute Einheit>", optional
$value2 # darzustellender Wert2
...
$decFont2 # "<Anzahl der Nachkommastellen>,<Schrift-SVG-Attribute Wert>,<Schrift-SVG-Attribute Einheit>", optional
$lightness # Helligkeit einzelner Elemente (0-100) "<Ring>,<Einheit>,<Wert>,<Icon>", optional, default: "50,40,50,40"

Argumente für den zweiten Wert entsprechend den Argumenten des ersten Wertes
</syntaxhighlight>
Wird '''$colorFunc...''' nicht angegeben, so wird der Farbwert zwischen '''$minColor...''' und '''$maxColor...''' linear interpoliert
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_ring2 DOIF ##
attr di_ring2 uiTable {package ui_Table;;}\
## Leistungsaufnahme von 0 kW bis 3,6 kW in Farben von grün (hue:120) bis rot (hue:0)\
## Kapazität von 0 % bis 100 % V in Farben von rot (hue:0) bis grün (hue:120)\
"Wallbox"| ring2([tesla:Leistung],0,3.6,120,0,"kW",undef,undef,"1,font-weight:normal",[tesla:Kapazitaet],0,100,0,120,"%",undef,"0,font-weight:normal")\
\
## Stromstärke von 0 A bis 2 A in Farben von grün (hue:120) bis rot (hue:0)\
## Spannung von 1 V bis 1.5 V in Farben von rot (hue:0) bis grün (hue:120)\
## 3 Nachkommastellen, Normalschrift, Schriftgröße 80% \
"Akku"| ring2([akku:Strom],0,2,120,0,"A",undef,undef,"3,font-weight:normal;;font-size:80%",[akku:Spannung],1,1.5,0,120,"V",undef,"3,font-weight:normal;;font-size:80%")
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:ring2_bsp.png|ohne|mini]]

==== '''icon_ring'''-Funktionen ====
===== Farbskalierte Temperaturanzeige mit einem Icon mit Hilfe der SVG-Funktionen '''icon_temp_ring/icon_temp_mring''' =====
Diese Funktionen basieren auf den obigen temp_ring-Funktionen, zusätzlich wird ein SVG-Icon dargestellt. Die Farbe des Icons kann mit @ an den Iconnamen angehängt werden, ansonsten wird die Farbe der Temperatur für das Icon verwendet. Die Größe des Icons kann skaliert werden, ebenso kann die Positionen des Icons verschoben werden.

{{Randnotiz|RNText=SVG-uiTable-Funktion '''icon_temp_ring/icon_temp_mring'''
<syntaxhighlight lang="perl">
icon_temp_ring/icon_temp_mring ($icon,$temp_value,$temp_min,$temp_max,$size,$lightring,$lightnumber,$decFont)

$icon # "Iconname\@Farbe,Skalierungsfaktor,x-Position,y-Position,Rotation", \@Farbe, Skalierungsfaktor, x-Position, y-Position, Rotation (0-360) sind optional
$temp_value # Temperatur
$temp_min, # minimale Temperatur, optional, default=-20
$temp_max, # maximale Temperatur, optional, default=60
$size, # Größe der Grafik, optional, default=80
$lightring, # Helligkeit des Ringes (0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (0-100), optional, default=50
$decFont # "<Anzahl der Nachkommastellen>,<Schrift-SVG-Attribute Wert>,<Schrift-SVG-Attribute Einheit>", optional
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_Heizung_temp DOIF ##
attr di_Heizung_temp uiTable {\
package ui_Table;;\
}\
\
icon_temp_ring("temp_outside",[vaillant:Aussentemp],-15,40)|\
icon_temp_mring(([vaillant:Flame] eq "off"?"sani_boiler_temp\@white":"sani_boiler_temp\@Darkorange"),[vaillant:Vorlauf],15,70)|\
icon_temp_mring(([vaillant:Pumpenstatus] eq "4" ? "sani_buffer_temp_down\@Darkorange" : "sani_buffer_temp_down\@white"),[vaillant:WWSpeicher],15,70)|\
icon_temp_mring(([Zirk] eq "off"?"sani_pump\@white":"sani_pump\@Darkorange"),[ESPEasy_ESP_Temp_Zirkulation:Temperature],15,70)|\
icon_temp_mring(([vaillant:Pumpenstatus] eq "on" ? "sani_floor_heating\@Darkorange" : "sani_floor_heating_neutral\@white"),[ESPEasy_ESP_Temp_Vorlauf:Temperature],15,70)|\
icon_temp_mring("sani_floor_heating_neutral\@white",[ESPEasy_ESP_Temp_Keller_Ruecklauf:Temperature],15,70)|""

</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:icon_temp_ring_bsp.png|ohne|mini]]

===== Farbskalierte Feuchtigkeitsanzeige mit einem Icon mit Hilfe der SVG-Funktionen '''icon_hum_ring/icon_hum_mring''' =====
Diese Funktionen basieren auf den obigen hum_ring-Funktionen, zusätzlich wird ein SVG-Icon dargestellt. Die Farbe des Icons kann mit @ an den Iconnamen angehängt werden, ansonsten wird die Farbe der Feuchtigkeit für das Icon verwendet. Die Größe des Icons kann skaliert werden, ebenso kann die Positionen des Icons verschoben werden.
{{Randnotiz|RNText=SVG-uiTable-Funktion '''icon_hum_ring/icon_hum_mring'''
<syntaxhighlight lang="perl">
icon_hum_ring/icon_hum_mring ($icon,$hum_value,$size,$lightring,$lightnumber,$decFont)

$icon # "Iconname\@Farbe,Skalierungsfaktor,x-Position,y-Position,Rotation", \@Farbe, Skalierungsfaktor, x-Position, y-Position, Rotation sind optional
$hum_value # Feuchtigkeit
$size # Größe der Grafik, optional, default=80
$lightring # Helligkeit des Ringes (0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (0-100), optional, default=50
$decFont # "<Anzahl der Nachkommastellen>,<Schrift-SVG-Attribute Wert>,<Schrift-SVG-Attribute Einheit>", optional
</syntaxhighlight>
}}

'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_icon_hum_ring DOIF ##
attr di_icon_hum_ring room test5
attr di_icon_hum_ring uiTable {package ui_Table}\
"klein ohne Farbverlauf"|icon_hum_mring("weather_humidity",[Aussensensor:humidity],60)\
"normal groß mit Farbverlauf"|icon_hum_ring("weather_humidity",[Aussensensor:humidity])\
"groß ohne Farbverlauf aufgehellt"|icon_hum_mring("weather_humidity",[Aussensensor:humidity],100,80)
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:icon_hum_ring_bsp.png|ohne|mini]]

===== Farbskalierte Anzeige eines Icons mit einem Zahlenwert mit Hilfe der universellen SVG-Funktion '''icon_ring/icon_mring/icon_uring''' =====
Diese Funktionen basieren auf der universellen ring-Funktion. Die Farbe des dargestellten Icons und des Wertes kann abhängig vom Wert bestimmt werden. Die Funktion '''icon_ring''' stellt den Farbring mit Farbverlauf dar, die Funktion '''icon_mring''' stellt den Farbring einfarbig dar. Die universelle Funktion '''icon_uring''' kann über den Parameter '''$model''' das Erscheinungsbild der Grafik verändern.

{{Randnotiz|RNText=SVG-uiTable-Funktion '''icon_ring/icon_mring/icon_uring'''
<syntaxhighlight lang="perl">
icon_ring ($icon,$value,$min,$max,$minColor,$maxColor, $unit,$decFont,$size,$colorRef,$lightness)

icon_mring ($icon,$value,$min,$max,$minColor,$maxColor, $unit,$decFont,$size,$colorRef,$lightness)

icon_uring ($model,$icon,$value,$min,$max,$minColor,$maxColor, $unit,$decFont,$size,$colorRef,$lightness)

$icon # "Iconname\@Farbe,Skalierungsfaktor,x-Position,y-Position,Rotation", \@Farbe, Skalierungsfaktor, x-Position, y-Position, Rotation sind optional
$value # darzustellender Wert
$min # minimaler Wert, optional, default=0
$max # maximaler Wert, optional, default=100
$minColor # Farbe (hue: 0-360) des kleinsten Wertes, optional, default = undef
$maxColor # Farbe (hue: 0-360) des maximalen Wertes, optional, default = undef
$unit # Einheit des Wertes, optional, default = undef
$decFont # "<Anzahl der Nachkommastellen>,<Style-SVG-Attribute Wert>,<Style-SVG-Attribute Einheit>", optional
$size # Größe der Grafik, optional, default = 100
$colorRef # Referenz auf eine Funktion, die zu einem Wert einen Farbwert (hue: 0-360) bestimmt, oder eine Referenz auf eine Arrayliste mit Grenzwerten und Farben, optional, default = undef
$lightnesss# Helligkeit einzelner Elemente (0-100) "<ring>,<Innenring>,<minmax>,<Einheit>,<Wert>,<Icon>", optional, default: (50,40,40,40,50,40)
$model # '<Farbverlauf>,<Min/Max>,<Innenring>,<Zeigerstärke>', Farbverlauf: 1 für monochrom, Min/Max: Style-SVG-Attribute oder 1 zum Anzeigen der Min-/Maxwerte, Innenring: Style-SVG-Attribute oder 1 zum Anzeigen des Innenrings, Zeigerstärke: in Pixel, alle Parameter sind optional, default keine Angaben: ',,,,'
</syntaxhighlight>
Wird '''$colorRef''' nicht angegeben, so wird der Farbwert zwischen '''$minColor''' und '''$maxColor''' linear interpoliert
}}

'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_icon_ring DOIF ##
attr di_icon_ring uiTable {package ui_Table}\
\
icon_ring ('sani_floor_heating_neutral',[Heizenergie:Vortag_hc],0,150,120,0,'kWh')|\
icon_mring ('fuel',[Tankstelle:Diesel],1.10,1.30,120,0,'€',2)|\
icon_uring ('0,1,1',"air",[ESPEasy_Eingang_CO2:PPM],400,1200,undef,undef,'ppm',0,100,[(600,120,1000,60,1200,0)])|\
icon_uring ('0,1','Zisterne',([Wasserzisterne]/3.4),0,100,0,120,'%',0)##/\
\
icon_uring ('1,1,0,8',"measure_water_meter",[Wasserverbrauch:heute],0,600,120,0,'l',0)|\
icon_uring ('0,fill:white,opacity:0.4',([vaillant:Pumpenstatus] eq '4' ? 'sani_buffer_temp_down@Darkorange' : 'sani_buffer_temp_down@white'),[vaillant:Umlaufmenge],0,20,120,0,'l/min')|\
icon_uring('0,1,1,4','weather_barometric_pressure',[vaillant:Wasserdruck],0,3,undef,undef,'bar',1,100,[(0.8,0,1,60,1.5,120,1.7,60,3,0)])|\
icon_uring('0,opacity:0.8,1,6','sani_water_tap',[vaillant:HwcHours_hoursum2_value],0,2000,120,0,'h',0)
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:icon_ring_bsp.png|ohne|mini]]

===== Farbskalierte Temperatur- und Feuchtigkeitsanzeige mit einem Icon mit Hilfe der SVG-Funktion '''icon_temp_hum_ring''' =====
Die Farbe ist jeweils abhängig vom dargestellten Temperatur- bzw. Feuchtigkeitswert. Die Helligkeit der Farbgebung ist einstellbar:

{{Randnotiz|RNText=SVG-uiTable-Funktion '''icon_temp_hum_ring'''
<syntaxhighlight lang="perl">
icon_temp_hum_ring ($icon,$temp_value,$hum_value,$temp_min,$temp_max,$size, $lightring,$lightnumber,$decFontTemp,$decFontHum)

$icon # "Iconname\@Farbe,Skalierungsfaktor,x-Position,y-Position,Rotation", \@Farbe, Skalierungsfaktor, x-Position, y-Position, Rotation sind optional
$temp_value # Temperatur
$hum_value # Feuchtigkeit
$temp_min # minimale Temperatur, optional, default=-20
$temp_max # maximale Temperatur, optional, default=60
$size # Größe der Grafik, optional, default=90
$lightring # Helligkeit des Ringes (0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (0-100), optional, default=50
$decFontTemp # Temperatur: "<Anzahl der Nachkommastellen>,<Schrift-SVG-Attribute Wert>,<Schrift-SVG-Attribute Einheit>", optional
$decFontHum # Feuchtigkeit: "<Anzahl der Nachkommastellen>,<Schrift-SVG-Attribute Wert>,<Schrift-SVG-Attribute Einheit>", optional
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_icon_temp_hum_ring DOIF ##
attr di_icon_temp_hum_ring uiTable {package ui_Table}\
\
"normal"|icon_temp_hum_ring("temp_outside",[Aussensensor:temperature],[Aussensensor:humidity])\
"mit Normalschrift"|icon_temp_hum_ring("temp_outside",[Aussensensor:temperature],[Aussensensor:humidity], undef,undef,undef,undef,undef,"1,font-weight:normal","0,font-weight:normal")\
"größer aufgehellt"|icon_temp_hum_ring("temp_outside",[Aussensensor:temperature],[Aussensensor:humidity], undef,undef,120,undef,80)
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:icon_temp_hum_ring.png|ohne|mini]]

===== Farbskalierte Anzeige von zwei Temperaturwerten mit einem Icon mit Hilfe der SVG-Funktion '''icon_temp_temp_ring''' =====
Die Farbe ist jeweils abhängig vom dargestellten Temperaturwert. Die Helligkeit der Farbgebung ist einstellbar:

{{Randnotiz|RNText=SVG-uiTable-Funktion '''icon_temp_temp_ring'''
<syntaxhighlight lang="perl">
icon_temp_temp_ring ($icon,$temp1_value,$temp2_value,$temp_min,$temp_max,$size, $lightring,$lightnumber,$decFontTemp1,$decFontTemp2)

$icon # "Iconname\@Farbe,Skalierungsfaktor,x-Position,y-Position,Rotation", \@Farbe, Skalierungsfaktor, x-Position, y-Position, Rotation sind optional
$temp1_value # erster Temperaturwert
$temp2_value # zweiter Temperaturwert
$temp_min # minimale Temperatur, optional, default=-20
$temp_max # maximale Temperatur, optional, default=60
$size # Größe der Grafik, optional, default=90
$lightring # Helligkeit des Ringes (0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (0-100), optional, default=50
$decFontTemp1 # Temperatur1: "<Anzahl der Nachkommastellen>,<Schrift-SVG-Attribute Wert>,<Schrift-SVG-Attribute Einheit>", optional
$decFontTemp2 # Temperatur2: "<Anzahl der Nachkommastellen>,<Schrift-SVG-Attribute Wert>,<Schrift-SVG-Attribute Einheit>", optional
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_icon_temp_temp_ring DOIF ##
attr di_icon_temp_temp_ring uiTable {package ui_Table}\
## Größe 120%\
"FB-Heizung"|icon_temp_temp_ring(([vaillant:Pumpenstatus] eq "on" ? "sani_floor_heating\@Darkorange" : "sani_floor_heating_neutral\@white"),[ESPEasy_ESP_Temp_Vorlauf:Temperature],[ESPEasy_ESP_Temp_Keller_Ruecklauf:Temperature],15,70,120)\
\
## Größe 120%, Normalschrift\
"Temperatur","Taupunkt"|icon_temp_temp_ring("temp_outside",[Aussensensor:temperature],[Aussensensor:dewpoint],undef,undef,120,undef,undef,"1,font-weight:normal","1,font-weight:normal")
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:icon_temp_temp_ring.png|ohne|mini]]

===== Farbskalierte Anzeige von zwei Zahlenwerten mit einem Icon mit Hilfe der universellen SVG-Funktion '''icon_ring2''' =====
Die Farbe der dargestellten Werte kann abhängig vom Wert bestimmt werden.

{{Randnotiz|RNText=SVG-uiTable-Funktion '''icon_ring2'''
<syntaxhighlight lang="perl">
icon_ring2 ($icon,$value1,$min1,$max1,$minColor1,$maxColor1,$unit1,$size,$colorFunc1,$decFont1,
$value2,$min2,$max2,$minColor2,$maxColor2,$unit2,$colorFunc2,$decFont2,$lightnesss)

$icon # "Iconname\@Farbe,Skalierungsfaktor,x-Position,y-Position,Rotation", \@Farbe, Skalierungsfaktor, x-Position, y-Position, Rotation sind optional
$value1 # darzustellender Wert1
$min1 # minimaler Wert, optional, default=0
$max1 # maximaler Wert, optional, default=100
$minColor1 # Farbe (hue: 0-360) des kleinsten Wertes, optional, default = undef
$maxColor1 # Farbe (hue: 0-360) des maximalen Wertes, optional, default = undef
$unit1 # Einheit des Wertes, optional, default = undef
$size # Größe der Grafik, optional, default = 100
$colorFunc1 # Funktion, die zu einem Wert einen Farbwert (hue: 0-360) bestimmt, optional, default = undef
$decFont1 # "<Anzahl der Nachkommastellen>,<Schrift-SVG-Attribute Wert>,<Schrift-SVG-Attribute Einheit>", optional
$value2 ## darzustellender Wert2
...
$unit2 # Einheit des Wertes, optional, default = undef
$colorFunc2 # Funktion, die zu einem Wert einen Farbwert (hue: 0-360) bestimmt, optional, default = undef
$decFont2 # "<Anzahl der Nachkommastellen>,<Schrift-SVG-Attribute Wert>,<Schrift-SVG-Attribute Einheit>", optional
$lightness # Helligkeit einzelner Elemente (0-100) "<Ring>,<Einheit>,<Wert>,<Icon>", optional, default: "50,40,50,40"

Argumente für den zweiten Wert entsprechend den Argumenten des ersten Wertes
</syntaxhighlight>
Wird '''$colorFunc...''' nicht angegeben, so wird der Farbwert zwischen '''$minColor...''' und '''$maxColor...''' linear interpoliert.

Bei der Farbangabe des Icons beim Übergabeparameter $icon wird mit '''\@colorVal2''' das Icon mit der Farbe des zweiten Wertes eingefärbt. Bei keiner Farbangabe oder '''\@colorVal1''' wird das Icon mit der Farbe des ersten Wertes eingefärbt. Ansonsten gilt die allgemeine FHEM-Syntax für Farbgebung von Icons angehängt mit '''\@'''.
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_icon_ring2 DOIF ##
attr di_icon_ring2 uiTable {package ui_Table;;\
\
sub himmelsrichtung {\
my ($richtung)=@_;;\
my $element=int($richtung/22.5);;\##/
my @h=(qw"N NNO NO ONO O OSO SO SSO S SSW SW WSW W WNW NW NNW");;\
return($h[$element]);;\
}\
}\
"Wallbox"| icon_ring2("car,1.5,0,-3",[tesla:Leistung],0,3.6,120,0,"kW",120,undef,"1,font-weight:normal",[tesla:Kapazitaet],0,100,0,120,"%",undef,"0,font-weight:normal")\
\
"Wind"|icon_ring2(([Wind:Geschwindigkeit]>0 ? "wind":"no_wind").",1,0,0,".[Wind:Richtung],[Wind:Geschwindigkeit],0,50,120,0,"km/h",120,undef,1,[Wind:Richtung],361,361,220,220,([Wind:Geschwindigkeit]>0?himmelsrichtung([Wind:Richtung]):"--"),undef,0)\
\
"Strom"|icon_ring2([zaehler:l-Produktion] > 0 ? "sani_solar\@colorVal1":"fa_bolt\@colorVal2",[zaehler:l-Produktion],0,3.6,20,120,"PV kW",150,undef,"1,,font-size:50%;fill:white",[zaehler:l-Bezug,0],0,2,120,0,"Netz kW",undef,"1,,font-size:50%;fill:white")
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:icon_ring2.png|ohne|mini]]

==== '''bar'''-Funktionen ====
===== Farbskalierte Anzeige der Temperatur in Balkenform mit Hilfe der SVG-Funktionen '''temp_bar/temp_mbar''' =====
Die Farbe der dargestellten Temperatur ist abhängig vom Temperaturwert. Die Helligkeit der Farbgebung ist einstellbar. Bei der '''temp_mbar'''-SVG-Funktion wird der Balken einfarbig dargestellt.

Farbskalierung der '''temp_bar'''-SVG-Funktion:
[[Datei:Farbskalierung temp_bar_scaling.png|600px|ohne]]

Farbskalierung der '''temp_mbar'''-SVG-Funktion:
[[Datei:Farbskalierung temp_mbar_scaling.png|600px|ohne]]

{{Randnotiz|RNText=SVG-uiTable-Funktion '''temp_bar/temp_mbar'''
<syntaxhighlight lang="perl">
temp_bar/temp_mbar ($temp_value,$temp_min,$temp_max, $header,$width,$height,$size, $light,$lightnumber,$decFont)

$temp_value # Temperaturwert
$temp_min # minimale Temperatur, optional, default=-20
$temp_max # maximale Temperatur, optional, default=60
$header # Überschrift, optional, default= undef (keine)
$width # Breite der Grafik, optional, default=63
$height # Höhe der Grafik, optional, default=60
$size # Größe der Grafik, optional, default=100
$light # Helligkeit der Grafik (0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (0-100), optional, default=50
$decFont # "<Anzahl der Nachkommastellen>,<Schrift-SVG-Attribute Wert>,<Schrift-SVG-Attribute Einheit>", optional, default = 1
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_temp_bar DOIF ##
attr di_temp_bar uiTable {package ui_Table}\
"standard"|temp_bar([Aussensensor:temperature])\
"heller"|temp_bar([Aussensensor:temperature],undef,undef,undef,undef,undef,undef,80)\
"monochrom"|temp_mbar([Aussensensor:temperature])\
"kleiner"|temp_bar([Aussensensor:temperature],undef,undef,undef,undef,undef,80)\
"mit Überschrift"|temp_bar([Aussensensor:temperature],undef,undef,"Außen")\
"hoch"|temp_bar([Aussensensor:temperature],undef,undef,undef,undef,100)
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:temp_bar_bsp.png|ohne|mini]]

===== Farbskalierte Anzeige der Feuchtigkeit in Balkenform mit Hilfe der SVG-Funktionen '''hum_bar/hum_mbar''' =====
Die Farbe der dargestellten Feuchtigkeit ist abhängig vom Feuchtigkeitswert. Die Helligkeit der Farbgebung ist einstellbar. Bei der '''hum_mbar'''-SVG-Funktion wird der Balken einfarbig dargestellt.

Farbskalierung der '''hum_bar'''-SVG-Funktion:
[[Datei:Farbskalierung hum_bar_scaling.png|600px|ohne]]

Farbskalierung der '''hum_mbar'''-SVG-Funktion:
[[Datei:Farbskalierung hum_mbar_scaling.png|600px|ohne]]

{{Randnotiz|RNText=SVG-uiTable-Funktion '''hum_bar/hum_mbar'''
<syntaxhighlight lang="perl">
hum_bar/hum_mbar ($hum_value,$header,$width,$height,$size, $light,$lightnumber,$decFont)

$hum_value # Feuchtigkeitswert
$header # Überschrift, optional, default = undef (keine)
$width # Breite der Grafik, optional, default=63
$height # Höhe der Grafik, optional, default=80
$size # Größe der Grafik, optional, default=100
$light # Helligkeit des der Grafik (0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (0-100), optional, default=50
$decFont # "<Anzahl der Nachkommastellen>,<Schrift-SVG-Attribute Wert>,<Schrift-SVG-Attribute Einheit>", optional, default = 0
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_hum_bar DOIF ##
attr di_hum_bar uiTable {package ui_Table}\
"standard"|hum_bar([Aussensensor:humidity])\
"heller"|hum_bar([Aussensensor:humidity],undef,undef,undef,undef,80)\
"monochrom"|hum_mbar([Aussensensor:humidity])\
"kleiner"|hum_bar([Aussensensor:humidity],undef,undef,undef,80)\
"mit Überschrift"|hum_bar([Aussensensor:humidity],"Außen")\
"hoch"|hum_bar([Aussensensor:humidity],undef,undef,100)
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:hum_bar_bsp.png|ohne|mini]]

===== Farbskalierte Anzeige eines Zahlenwertes mit Hilfe der universellen SVG-Funktion '''bar''' =====
Die Farbe des dargestellten Wertes kann abhängig vom Wert bestimmt werden.
{{Randnotiz|RNText=SVG-uiTable-Funktion '''bar'''
<syntaxhighlight lang="perl">
bar ($value,$min,$max,$header,$minColor,$maxColor,$unit,$width, $height,$size,$colorFunc,$decFont,$gradient,$light,$lightnumber)

$value # darzustellender Wert
$min # minimaler Wert, optional, default=0
$max # maximaler Wert, optional, default=100
$header # Überschrift, optional, default = undef (keine)
$minColor # Farbe (hue: 0-360) des kleinsten Wertes, optional, default = undef
$maxColor # Farbe (hue: 0-360) des maximalen Wertes, optional, default = undef
$unit # Einheit des Wertes, optional, default = undef
$width # Breite der Grafik, optional, default = 63
$height # Höhe der Grafik, optional, default = 60
$size # Größe der Grafik, optional, default = 100
$colorFunc # Funktion, die zu einem Wert einen Farbwert (hue: 0-360) bestimmt, optional, default = undef
$decFont # "<Anzahl der Nachkommastellen>,<Schrift-SVG-Attribute Wert>,<Schrift-SVG-Attribute Einheit>", optional, default = 1
$gradient # Farbverlauf, optional, undef mit Farbverlauf, 1 ohne Farbverlauf, default = undef
$light # Helligkeit der Grafik (light:0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (light:0-100), optional, default=50
</syntaxhighlight>
Wird '''$colorFunc''' nicht angegeben, so wird der Farbwert zwischen '''$minColor''' und '''$maxColor''' linear interpoliert
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
{package ui_Table}
defmod di_bar DOIF ##
attr di_bar uiTable {package ui_Table}\
## von 0 bis 20 in Farben von grün (hue:120) bis rot (hue:0)\
"Umlaufmenge"|bar([heizung:Umlaufmenge],0,20,"Umlauf",120,0,"l/min")\
\
## von 0 bis 3 in Farben von rot (hue:0) bis türkis (hue:180)\
"Wasserdruck"|bar([heizung:Wasserdruck],0,3,undef,0,180,"bar"undef,70,undef,undef,"1,font-size:130%;;font-weight:normal")\
\
## Temperaturdarstellung, entspricht dem Funktionsaufruf:\
## temp_bar ([Aussensensor:temperature],-20,60)\
"Temperatur"|bar([Aussensensor:temperature],-20,60,undef,undef,undef,"°C",undef,undef,undef,\&temp_hue)
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:bar_bsp.png|ohne|mini]]

==== '''icon_bar'''-Funktionen ====
===== Farbskalierte Anzeige der Temperatur in Balkenform mit Hilfe der SVG-Funktion '''icon_temp_bar/icon_temp_mbar''' =====
Die Farbe der dargestellten Temperatur ist abhängig vom Temperaturwert. Die Helligkeit der Farbgebung ist einstellbar. Bei der '''icon_temp_mbar'''-SVG-Funktion wird der Balken einfarbig dargestellt.

{{Randnotiz|RNText=SVG-uiTable-Funktion '''icon_temp_bar/icon_temp_mbar'''
<syntaxhighlight lang="perl">
icon_temp_bar/icon_temp_mbar ($icon,$temp_value,$temp_min,$temp_max, $header,$width,$height,$size,$light,$lightnumber,$decFont)

$icon # "Iconname\@Farbe,Skalierungsfaktor,x-Position,y-Position", \@Farbe, Skalierungsfaktor, x-Position, y-Position sind optional
$temp_value # Temperaturwert
$temp_min # minimale Temperatur, optional, default=-20
$temp_max # maximale Temperatur, optional, default=60
$header # Überschrift, optional, default= undef (keine)
$width # Breite der Grafik, optional, default=63
$height # Höhe der Grafik, optional, default=75
$size # Größe der Grafik, optional, default=100
$light # Helligkeit der Grafik (0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (0-100), optional, default=50
$decFont # "<Anzahl der Nachkommastellen>,<Schrift-SVG-Attribute Wert>,<Schrift-SVG-Attribute Einheit>", optional, default = 1
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_icon_temp_bar DOIF ##
attr di_icon_temp_bar room test10
attr di_icon_temp_bar uiTable {package ui_Table}\
"standard"|icon_temp_bar("temp_outside",[Aussensensor:temperature])\
"heller"|icon_temp_bar("temp_outside",[Aussensensor:temperature],undef,undef,undef,undef,undef,undef,80)\
"monochrom"|icon_temp_mbar("temp_outside",[Aussensensor:temperature])\
"kleiner"|icon_temp_bar("temp_outside",[Aussensensor:temperature],undef,undef,undef,undef,undef,80)\
"mit Überschrift"|icon_temp_bar("temp_outside",[Aussensensor:temperature],undef,undef,"Außen")\
"hoch"|icon_temp_bar("temp_outside",[Aussensensor:temperature],undef,undef,undef,undef,100)
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:icon_temp_bar_bsp.png|ohne|mini]]

===== Farbskalierte Anzeige der Feuchtigkeit in Balkenform mit Hilfe der SVG-Funktionen '''icon_hum_bar/icon_hum_mbar''' =====
Die Farbe der dargestellten Feuchtigkeit ist abhängig vom Feuchtigkeitswert. Die Helligkeit der Farbgebung ist einstellbar. Bei der '''icon_hum_mbar'''-SVG-Funktion wird der Balken einfarbig dargestellt.

{{Randnotiz|RNText=SVG-uiTable-Funktion '''icon_hum_bar/icon_hum_mbar'''
<syntaxhighlight lang="perl">
icon_hum_bar/icon_hum_mbar ($icon,$hum_value,$header,$width,$height,$size, $light,$lightnumber,$decFont)

$icon # "Iconname\@Farbe,Skalierungsfaktor,x-Position,y-Position", \@Farbe, Skalierungsfaktor, x-Position, y-Position sind optional
$hum_value # Temperaturwert
$header # Überschrift, optional, default = undef (keine)
$width # Breite der Grafik, optional, default=63
$height # Höhe der Grafik, optional, default=75
$size # Größe der Grafik, optional, default=100
$light # Helligkeit des der Grafik (0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (0-100), optional, default=50
$decFont # "<Anzahl der Nachkommastellen>,<Schrift-SVG-Attribute Wert>,<Schrift-SVG-Attribute Einheit>", optional, default = 1
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_icon_hum_bar DOIF ##
attr di_icon_hum_bar uiTable {package ui_Table}\
"standard"|icon_hum_bar("temperature_humidity",[Aussensensor:humidity])\
"heller"|icon_hum_bar("temperature_humidity",[Aussensensor:humidity],undef,undef,undef,undef,80)\
"monochrom"|icon_hum_mbar("temperature_humidity",[Aussensensor:humidity])\
"kleiner"|icon_hum_bar("temperature_humidity",[Aussensensor:humidity],undef,undef,undef,80)\
"mit Überschrift"|icon_hum_bar("temperature_humidity",[Aussensensor:humidity],"Außen")\
"hoch"|icon_hum_bar("temperature_humidity",[Aussensensor:humidity],undef,undef,100)
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:icon_hum_bar_bsp.png|ohne|mini]]

===== Farbskalierte Anzeige eines Zahlenwertes mit Hilfe der universellen SVG-Funktionen '''icon_bar/icon_mbar''' =====
Die Farbe des dargestellten Wertes und des Icons kann abhängig vom Wert bestimmt werden. Bei der '''icon_mbar'''-SVG-Funktion wird der Balken einfarbig dargestellt.

{{Randnotiz|RNText=SVG-uiTable-Funktion '''icon_bar/icon_mbar'''
<syntaxhighlight lang="perl">
icon_bar ($icon,$value,$min,$max,$minColor,$maxColor,$unit,$decfont,$header,$width,$height,$size, $colorFunc,$light,$lightnumber)

$icon # "Iconname\@Farbe,Skalierungsfaktor,x-Position,y-Position,Rotation", \@Farbe, Skalierungsfaktor, x-Position, y-Position, Rotation (0-360) sind optional
$value # darzustellender Wert
$min # minimaler Wert, optional, default=0
$max # maximaler Wert, optional, default=100
$header # Überschrift, optional, default = undef (keine)
$minColor # Farbe (hue: 0-360) des kleinsten Wertes, optional, default = undef
$maxColor # Farbe (hue: 0-360) des maximalen Wertes, optional, default = undef
$unit # Einheit des Wertes, optional, default = undef
$decFont # "<Anzahl der Nachkommastellen>,<Schrift-SVG-Attribute Wert>,<Schrift-SVG-Attribute Einheit>", optional, default = 1
$width # Breite der Grafik, optional, default = 63
$height # Höhe der Grafik, optional, default = 75
$size # Größe der Grafik, optional, default = 100
$colorFunc # Funktion, die zu einem Wert einen Farbwert (hue: 0-360) bestimmt, optional, default = undef
$light # Helligkeit der Grafik (light:0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (light:0-100), optional, default=50
</syntaxhighlight>
Wird '''$colorFunc''' nicht angegeben, so wird der Farbwert zwischen '''$minColor''' und '''$maxColor''' linear interpoliert
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_icon_bar_bsp DOIF ##
attr di_icon_bar_bsp uiTable {package ui_Table;;\
}\
icon_bar ("fuel",[Tankstelle:Diesel],1.10,1.30,120,0,"€",2)|\
icon_bar ("air",[ESPEasy_Eingang_CO2:PPM],400,1200,120,0,"ppm",0)|\
icon_bar ("Zisterne",([Wasserzisterne]/3.4),0,100,0,120,"%",0)|\
icon_bar (([vaillant:Pumpenstatus] eq "off" ? "sani_buffer_temp_down\@Darkorange" : "sani_buffer_temp_down\@white"),[vaillant:Umlaufmenge],0,20,120,0,"l/min")\
icon_bar ("measure_water_meter",[Wasserverbrauch:heute],0,600,120,0,"l",0)|\
icon_bar ("weather_barometric_pressure",[vaillant:Wasserdruck],0,3,0,180,"bar")|\
icon_bar ("sani_water_tap",[vaillant:HwcHours_hoursum2_value],0,2000,120,0,"h",0)|\
icon_bar ("sani_floor_heating_neutral",[Heizenergie:Vortag_hc],0,150,120,0,"kWh")
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:icon_bar_bsp.png|ohne|mini]]

==== Anzeige eines Werteverlaufs und des aktuellen Wertes mit Hilfe der SVG-Funktion '''card''' ====
Es wird der aktuelle Wert eines Readings, sein zeitlicher Verlauf sowie der maximale und minimale Wert in Form einer Informationskarte visualisiert. Das Erscheinungsbild kann über zahlreiche Parameter individualisiert werden. Die Besonderheit ist das Argument '''col<Anzahl><Zeitformat>''' bei der Angabe des Readings der Form '''[<Device>:<Reading>:col<Anzahl><Zeitformat>]'''. Dadurch werden Daten des Readings temporär im DOIF-Modul gesammelt und für die Erzeugung eines Graphen zur Verfügung gestellt - es sind keine weiteren Definitionen erforderlich. Dabei wird besonders sparsam mit der Datensammlung umgegangen, es werden maximal 72 Werte (in Timeslots) gespeichert, unabhängig davon wie lange die Zeitspanne ist und wie oft die Daten ankommen. Die Auflösung des Graphen nimmt mit der Zeitspanne ab - es werden immer maximal 72 Werte dargestellt. Daraus ergibt sich bei einer Stunde eine Auflösung von einer 3600/72=50 Sekunden/Eintrag, bei 6 Stunden sind es 6*60/72=5 Minuten/Eintrag, für eine Woche 7*24*60/72=140 Minuten/Eintrag usw. Die gesammelten Daten werden über den FHEM-Befehl '''save''' in versteckten Readings des jeweiligen DOIF-Moduls gespeichert.

{{Randnotiz|RNText=SVG-uiTable-Funktion '''card'''
<syntaxhighlight lang="perl">
card ($collect,$header,$icon,$min,$max,$minColor,$maxColor, $unit,$colorRef,$decfont,$prop,$ringModel,$lightness)

$collect # Angabe eine Readings der Form [<Device>:<Reading>:col<Anzahl><Zeitformat>], mit Hilfe des Argumentes col (von collect) wird das Modul angewiesen Daten des Readings über einen bestimmten Zeitraum zu sammeln

col<Anzahl><Zeitformat> # <Zeitformat>: d Tage, w Wochen, ohne Angabe des Zeitformates wird <Anzahl> in Stunden interpretiert. Beispiele: col (entspricht col24), col1, col12, col1d, col3d, col1w, col4w, col52w usw.

$header # "<Überschrifttext,<Style-SVG-Text-Attribute>", optional
$icon # "Iconname\@Farbe,Skalierungsfaktor,x-Position,y-Position,Rotation", \@Farbe, Skalierungsfaktor, x-Position, y-Position, Rotation sind optional
$min # minimaler Wert, optional, default=0
$max # maximaler Wert, optional, default=100
$minColor # Farbe (hue: 0-360) des kleinsten Wertes, optional, default = 0 (rot)
$maxColor # Farbe (hue: 0-360) des maximalen Wertes, optional, default = 120 (grün)
$unit # Einheit des Wertes, optional, default = undef
$colorRef # Referenz auf eine Funktion, die zu einem Wert einen Farbwert (hue: 0-360) bestimmt, oder eine Referenz auf eine Arrayliste mit Grenzwerten und Farben, optional, default = undef
$decFont # "<Anzahl der Nachkommastellen>,<Style-SVG-Attribute Wert>,<Style-SVG-Attribute Einheit>", optional
$prop # "<Größe der Karte>,<feste Y-Skalierung>,<steps>,<noFooter>", optional, Größe der der Karte, default = 130, feste Y-Skalierung: 1, sonst automatische Skalierung, steps: 1 für Stufen, noFooter: 1 für keine Fußzeile
$ringModel # '<Farbverlauf>,<Min/Max>,<Innenring>,<Zeigerstärke>', Farbverlauf: 1 für monochrom, Min/Max: Style-SVG-Attribute oder 1 zum Anzeigen der Min-/Maxwerte, Innenring: Style-SVG-Attribute oder 1 zum Anzeigen des Innenrings, Zeigerstärke: in Pixel, alle Parameter sind optional, default keine Angaben: ',,,,'
$lightness # Helligkeit einzelner Elemente (0-100) "<ring>,<Innenring>,<minmax>,<Einheit>,<Wert>,<Icon>", optional, default: "50,40,40,40,50,40"
</syntaxhighlight>
Wird '''$colorRef''' nicht angegeben, so wird der Farbwert zwischen '''$minColor''' und '''$maxColor''' linear interpoliert

'''nützliche Links'''
* Anwendungsbeispiel [[DOIF/uiTable_Schnelleinstieg#Visualisierung:_Wetterstation|Wetterstation]]
* Anwendungsbeispiel [[DOIF/uiTable_Schnelleinstieg#Visualisierung:_aktueller_Spritpreis|Spritpreise]]
* Anwendungsbeispiel [[DOIF/uiTable_Schnelleinstieg#Visualisierung_und_Steuerung:_Heiztherme|Heiztherme]]
* svg-Funktion [[DOIF/uiTable_Schnelleinstieg#Farbskalierte_Anzeige_eines_Icons_mit_einem_Zahlenwert_mit_Hilfe_der_universellen_SVG-Funktion_icon_ring.2Ficon_mring.2Ficon_uring|icon_ring]]
}}

'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_collect DOIF ##
attr di_collect uiTable {package ui_Table;;}\
card([Aussensensor:temperature:col12],"Außen","temp_outside",-10,45,undef,undef,"°C",\&temp_hue,undef)|\
card([Tankstelle:Diesel:col12],"Sprit,fill:darkorange","fuel","1.00","1.40",120,0,"Diesel €",undef,"2",",,1")\
card([zaehler:l-Produktion:col12],undef,[zaehler:l-Produktion] > 0 ? "sani_solar\@colorVal1":"fa_bolt\@colorVal2",0,3.6,30,60,"PV kW",undef,"1,,font-size:50%")|\
card([ESPEasy_Eingang_CO2:PPM:col12],undef,"air",400,1200,120,0,"ppm",[(600,120,1000,60,1200,0)],0,undef,'0,1,1',"50,35,45,35,50,35")
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:svgcard.png|ohne|mini]]

==== 3d-Balkendarstellung mehrerer Zahlenwerten mit Hilfe der universellen SVG-Funktion '''cylinder''' ====
Es können mehrere Zahlenwerte mit Legende farbig in Balkenform visualisiert werden. Negative Werte werden als Balken nach unten dargestellt, positive nach oben, der Nullpunkt wird automatisch berechnet.
{{Randnotiz|RNText=SVG-uiTable-Funktion '''cylinder'''
<syntaxhighlight lang="perl">
cylinder ($header,$min,$max,$unit,$width,$height,$size,$dec,($value1,$color1,$text1),($value2,$color2,$text2),...

$header # Überschrift
$min # minimaler Wert, optional, default = 0
$max # maximaler Wert, optional, default = 100
$unit # Einheit des Wertes, optional, default = undef
$width # Breite der Grafik, optional, default = wird bei Beschriftungen automatisch angepasst
$height # Höhe der Grafik, optional, default = wird automatisch berechnet
$size # Größe der Grafik, optional, default = 100
$dec # Anzahl der Nachkommastellen, optional, default=1
$value1 # erster Zahlenwert
$color1 # HSL-Farbe des ersten Balkens: "<hue>.<saturation>.<lightness>" (hue:0-360,saturation:0-100,lightness:0-100), saturation (default:100) und lightness (default:50) sind optional
$text1 # Beschriftung des Zahlenwertes in der Legende, optional, default = undef
$value2 # zweiter Zahlenwert, optional
$color2 # HSL-Farbe des zweiten Balkens: "<hue>.<saturation>.<lightness>" (hue:0-360,saturation:0-100,lightness:0-100), saturation (default:100) und lightness (default:50) sind optional
$text2 # Beschriftung des Zahlenwertes in der Legende, optional, default = undef
...
Es können weitere Zahlenwerte jeweils mit Farbe und Beschriftung optional angegeben werden
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_cylinder DOIF ##
attr di_cylinder room Test,wiki
attr di_cylinder uiTable {package ui_Table}\
"normal"|cylinder("",0,100,"%",80,undef,undef,0,[Wasserzisterne:state],200,undef)\
\
"mit Überschrift"|cylinder("Zisterne",0,100,"%",80,undef,undef,0,[Wasserzisterne:state],200,undef)\
\
"kleiner"|cylinder("Zisterne",0,100,"%",80,undef,80,0,[Wasserzisterne:state],200,undef)\
\
"hoch"|cylinder("Zisterne",0,100,"%",undef,100,undef,0,[Wasserzisterne:state],200,undef)\
\
"mit Beschriftung"|cylinder("Zisterne",0,100,"%",undef,100,undef,0,[Wasserzisterne:state],200,"Wasserstand")\
\
"mit mehreren Informationen"|cylinder("Energie",-20,30,"kWh",undef,undef,undef,1,[zaehler:Bezug],0,"Bezug",[zaehler:Produktion],60,"Produktion",[zaehler:Eigenverbrauch],30,"Eigenverbrauch")\
\
"mit hellen Farben"| cylinder("Tag",0,100,"kWh",undef,undef,undef,1,[Heizenergie:Tagesverbrauch_hc]/100000,"30.100.70","letzter",[Heizenergie:heute_hc]/100000,"60.100.70","aktuell")
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:cylinder_bsp.png|ohne|mini]]

==== Balkendarstellung mehrerer Zahlenwerte mit Hilfe der universellen SVG-Funktion '''cylinder_bars''' ====
Es können mehrere Zahlenwerte mit Legende farbig in Balkenform visualisiert werden. Negative Werte werden als Balken nach unten dargestellt, positive nach oben, der Nullpunkt wird automatisch berechnet. Die '''cylinder_bars'''-SVG-Funkton besitzt die gleichen Argumente, wie die obige '''cylinder'''-SVG-Funktion, mehrerer Balken werden jedoch nicht übereinander, sondern nebeneinander dargestellt.
{{Randnotiz|RNText=SVG-uiTable-Funktion '''cylinder_bars'''
<syntaxhighlight lang="perl">
cylinder_bars ($header,$min,$max,$unit,$width,$height,$size,$dec,($value1,$color1,$text1),($value2,$color2,$text2),...

$header # Überschrift
$min # minimaler Wert, optional, default = 0
$max # maximaler Wert, optional, default = 100
$unit # Einheit des Wertes, optional, default = undef
$width # Breite der Grafik, optional, default = wird bei Beschriftungen automatisch angepasst
$height # Höhe der Grafik, optional, default = wird automatisch berechnet
$size # Größe der Grafik, optional, default = 100
$dec # Anzahl der Nachkommastellen, optional, default=1
$value1 # erster Zahlenwert
$color1 # HSL-Farbe des ersten Balkens: "<hue>.<saturation>.<lightness>" (hue:0-360,saturation:0-100,lightness:0-100), saturation (default:100) und lightness (default:50) sind optional
$text1 # Beschriftung des Zahlenwertes in der Legende, optional, default = undef
$value2 # zweiter Zahlenwert, optional
$color2 # HSL-Farbe des zweiten Balkens: "<hue>.<saturation>.<lightness>" (hue:0-360,saturation:0-100,lightness:0-100), saturation (default:100) und lightness (default:50) sind optional
$text2 # Beschriftung des Zahlenwertes in der Legende, optional, default = undef
...
Es können weitere Zahlenwerte jeweils mit Farbe und Beschriftung optional angegeben werden
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_wasserverbrauch DOIF ##
attr di_wasserverbrauch uiTable {package ui_Table;;}\
cylinder_bars("Monat",0,15,"m³",undef,undef,undef,1,[Wasserverbrauch:monatsdurchschnitt],30,"Durchschnitt",[Wasserverbrauch:monatsverbrauch]/1000,220,"letzter",[Wasserverbrauch:monat]/1000,180,"aktuell")\
\
cylinder_bars("Monat",0,15,"m³",undef,undef,undef,1,[Wasserverbrauch:jan],30,"Januar",[Wasserverbrauch:feb],220,"Februar",[Wasserverbrauch:mrz],180,"März",[Wasserverbrauch:apr],30,"April",[Wasserverbrauch:mai],220,"Mai",[Wasserverbrauch:jun],180,"Juni",[Wasserverbrauch:jul],30,"Juli",[Wasserverbrauch:aug],220,"August",[Wasserverbrauch:sep],180,"September",[Wasserverbrauch:okt],30,"Oktober",[Wasserverbrauch:nov],220,"November",[Wasserverbrauch:dez],180,"Dezember")
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:cylinder_bars_bsp.png|ohne|mini]]

=== Farbskalierte Temperaturanzeige mit Hilfe der Funktion '''temp''' ===
Die Farbe der dargestellten Temperatur ist abhängig vom Temperaturwert:
[[Datei:Farbskalierung temp.png|600px|ohne]]
{{Randnotiz|RNText=uiTable-Funktion '''temp'''
<syntaxhighlight lang="perl">
temp ($temp,$size,$icon)

$temp # Temperatur
$size # Schriftgröße in Pixel (pt), optional
$icon # Icon, welches vorangestellt wird, optional
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_uiTable_temp DOIF ##
attr di_uiTable_temp uiTable {\
package ui_Table;; ## Package für uiTable-Funktionen\
$TC{0..2}="align='center'";; ## zentrierte Darstellung aller Tabellenspalten\
}\
## Tabellendefinition\
\
"Aussen"|"Bad"|"Warmwasser" ## mit | werden Tabellenzellen voneinander getrennt \
temp([Aussensensor:temperature])| ## Anzeige des Readings 'temperature' des Gerätes 'Aussensensor' \
temp([TH_Bad_HM:measured-temp],24,"temp_temperature")| ## Schriftgröße 24pt, mit Icon namens temp_temperature\
temp([T_Warmwasserspeicher:temperature:d1],20) ## Schriftgröße 20pt
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:Temp.png|ohne|mini]]

=== Farbskalierte Feuchtigkeitsanzeige mit Hilfe der Funktion '''hum''' ===
Die Farbe der dargestellten Feuchtigkeit ist abhängig vom Feuchtigkeitswert:
[[Datei:Farbskalierung hum.png|350px|ohne]]
{{Randnotiz|RNText=uiTable-Funktion '''hum'''
<syntaxhighlight lang="perl">
hum ($hum,$size,$icon)

$hum # Feuchtigkeit
$size # Schriftgröße in Pixel (pt), optional
$icon # Icon, welches vorangestellt wird, optional
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_uiTable_hum DOIF ##
attr di_uiTable_hum uiTable {\
package ui_Table;;\
$TC{1}="align='center'";; ## zweite Spalte der Tabelle zentriert\
}\
## Tabellendefinition \
\
## Anzeige des Readings 'humidity' des Thermostats 'TH_Bad_HM' \
"Bad"|hum ([TH_Bad_HM:humidity])\
\
## Feuchtigkeit in Größe 10pt mit Temperatur in einer Tabellenzelle\
"Aussen"|temp ([Aussensensor:temperature]),hum ([Aussensensor:humidity],10)\
\
## Feuchtigkeit in Größe 26pt mit Icon namens 'temperature_humidity'\
"Keller"|hum ([TH_Keller_HM:humidity],26,"temperature_humidity")
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable Funktion hum.png|ohne|mini]]

=== Textformatierungen mit Hilfe der Funktion '''style''' ===
Texte werden in Farbe, Größe und Schriftart statisch oder dynamisch formatiert.
{{Randnotiz|RNText=uiTable-Funktion '''style'''
<syntaxhighlight lang="perl">
style ($text,$color,$font_size,$font_weight)

$text # anzuzeigender Text
$color # CSS color, optional
$font_size # Schriftgröße in Pixel (pt), optional
$font_weight # CSS Schriftart, optional
</syntaxhighlight>
Mögliche Werte für '''''color''''' und '''''font_weight''''' können in einschlägiger Dokumentation zu CSS nachgeschlagen werden
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_uiTable_style DOIF ##
attr di_uiTable_style uiTable {\
package ui_Table;;\
}\
## Tabellendefinition\
\
## statische Farbgebung, Größe, Schriftart \
style("Montag","orange")\
style("Dienstag","red",14)\
style("Mittwoch","#00FFFF",20)\
style("Donnerstag","blue",23,"bold")\
\
## dynamische Farbgebung abhängig vom Zustand des Gerätes 'Alarm'\
style("Alarm",([Alarm:state] eq "on" ? "red":"green"))\
\
## dynamische Farbgebung des Zustands des Gerätes 'Alarm'\
style([Alarm:state],([Alarm:state] eq "on" ? "red":"green"))\
\
## variabler Text abhängig vom Zustand des Gerätes 'Alarm'\
style(([Alarm:state] eq "on" ? "Alarm aktiv":"Alarm deaktiviert"),"red")
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:Style.png|ohne|mini]]

=== Icon-Darstellung mit Hilfe der Funktion '''ICON''' ===
Mit Hilfe der Funktion '''ICON''' kann ein FHEM-Icon dargestellt werden
{{Randnotiz|RNText=uiTable-Funktion '''ICON'''
<syntaxhighlight lang="perl">
ICON ($icon)

$icon # Icon mit Farbgebung
</syntaxhighlight>

'''ICON''' benutzt die Funktion [[DevelopmentFHEMWEB-API#FW_makeImage|FW_makeImage]]

'''nützliche Links'''
* [[DOIF/uiTable Schnelleinstieg#hsv-Funktion für Farbskalierungen|hsv-Funktion]]
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_Table_ICON DOIF ##
attr di_Table_ICON uiTable {\
package ui_Table;;\
}\
## Tabellendefinition\
ICON("temp_frost") | ## Icon ohne Einfärbung\
ICON("temp_frost\@blue") | ## Icon in CSS-Farbe blau\
ICON("temp_frost\@#8A2BE2") | ## Icon in CSS-Farbe #8A2BE2\
ICON("temp_frost\@".([Aussensensor:temperature] > 0 ? "orange":"blue"))| ## Icon in CSS-Farbe orange über Null Grad, sonst in CSS-Farbe blau\
ICON("temp_frost\@".hsv ([Aussensensor:temperature],-20,40,320,0)) ## Icon in Farbskalierung von violett (-20 °C) bis rot (40 °C) mit Hilfe der Funktion hsv
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable_IC.png|mini|ohne]]

=== Icon-Darstellung mit Text mit Hilfe der Funktion '''icon_label''' ===
Mit Hilfe der Funktion '''icon_label''' kann ein FHEM-Icon mit einem angehängten Text/Wert dargestellt werden.
{{Randnotiz|RNText=uiTable-Funktion '''icon_label'''
<syntaxhighlight lang="perl">
icon_label ($icon,$text,$color,$color_bg,$pos_left,$pos_top)
$icon # FHEM-Icon mit Farboption
$text # dargestellter Text
$color # Farbe des Textes, optional
$color # Hintergrundfarbe des Textes, optional
$pos_left # horizontale Position des Textes in px, default -5, optional
$pos_top # vertikale Position des Textes in px, default -8, optional
</syntaxhighlight>

'''Anwendungsbeispiele'''
* [[DOIF/uiTable Schnelleinstieg#Anzahl der Tage bis zur Abfall-Entsorgung|Abfall]]
* [[DOIF/uiTable Schnelleinstieg#Visualisierung: aktueller Spritpreis|Sprit]]
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_uiTable_icon_label DOIF ##
attr di_uiTable_icon_label uiTable { package ui_Table;;\
}\
\
icon_label("fuel",[Tankstelle:Diesel])|\
icon_label("fuel",[Tankstelle:Diesel],"red")|\
icon_label("fuel\@blue",[Tankstelle:Diesel],"blue","#999999")|\
icon_label("fuel\@red",[Tankstelle:Diesel],"red","white",-10)|\
icon_label("fuel",[Tankstelle:Diesel],"white","red",-5,8)\

</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable_icon_label.png|mini|ohne]]

=== Visualisierung eines Gerätes mit Hilfe der Funktion '''icon''' ===
Der Zustand eines Gerätes/Readings wird mit Hilfe eines Icons dargestellt.
{{Randnotiz|RNText=uiTable-Funktion '''icon'''
<syntaxhighlight lang="perl">
icon ($value,$icon_off,$icon_on,$state_off,$state_on)

$value # Wert
$icon_off # Icon für den Wert off, default "off"
$icon_on # Icon für den Wert on, default Icon für Wert 'off' in Farbe 'DarkOrange', sonst Icon 'on', wenn $icon_off nicht definiert ist
$state_off # Wert zugehörig zum Icon off, default "off"
$state_on # Wert zugehörig zum Icon on, default "on"
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_uiTable_icon DOIF ##
attr di_uiTable_icon uiTable {\
package ui_Table;;\
}\
## Tabellendefinition\
\
## Standard-Icon off/on für Standardwert off/on \
"Lampe"|icon([Lampe:state]) ## entspricht icon([Lampe:state],"off","on","off","on")\
\
## Icon für Zustand 'off' ist 'hue_room_hallway', für Zustand 'on' 'hue_room_hallway\@DarkOrange'\
"Flur"|icon([Lampeflur:state],"hue_room_hallway") ## entspricht icon([Lampeflur:state],"hue_room_hallway","hue_room_hallway\DarkOrange","off","on")\
\
## Icon für Zustand 'off' ist 'status_away_2', für Zustand 'on' 'status_available\@DarkOrange'\
"Anwesenheit"|icon([Anwesenheit:state],"status_away_2","status_available\@DarkOrange") \
\
## Icon für Zustand 'closed' ist "status_locked", für Zustand 'open' 'status_open\@DarkOrange'\
"Haus"|icon([Schloss:state],"status_locked","status_open\@DarkOrange","closed","open")
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable icon.png|mini|ohne]]

=== Schaltbares Icon mit Hilfe der Funktion '''switch''' ===
Der Zustand eines Gerätes/Readings wird mit Hilfe eines Icons dargestellt, er kann über die WEB-Oberfläche durch Anklicken geschaltet werden. Damit der Zustand des Gerätes geschaltet werden kann, muss das Gerät den set-Befehl unterstützen.

{{Randnotiz|RNText=uiTable-Funktion '''switch'''
<syntaxhighlight lang="perl">
switch ($value,$icon_off,$icon_on,$state_off,$state_on)

$value # [<device>:<reading>]
$icon_off # Icon für den Wert off, default "off"
$icon_on # Icon für den Wert on, default Icon für Wert 'off' in Farbe 'DarkOrange', sonst Icon 'on', wenn $icon_off nicht definiert ist
$state_off # Wert zugehörig zum Icon off, default "off"
$state_on # Wert zugehörig zum Icon on, default "on"
</syntaxhighlight>
}}

'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_uiTable_switch DOIF ##
attr di_uiTable_switch uiTable {\
package ui_Table;;\
}\
## schaltbares Icons in der Webansicht \
switch([Lampe:state]) | \
switch([Lampeflur:state],"hue_room_hallway") |\
switch([Anwesenheit:state],"status_away_2","status_available\@DarkOrange")|\
switch([Haus:state],"status_locked","status_open\@DarkOrange","closed","open")\
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable switch.png|mini|ohne]]

=== Rollladen: Visualisierung und Steuerung mit Hilfe der Funktion '''shutter''' ===
Die aktuelle Position des Rollladens (0 % - 100 %) wird über Icons visualisiert. Das Anklicken eines Symbols steuert den Rollladen auf die entsprechende Position. Prozentwerte zwischen zwei Icon-Werten werden dem nächsthöheren Icon-Wert zugeordnet.
{{Randnotiz|RNText=uiTable-Funktion '''shutter'''
<syntaxhighlight lang="perl">
shutter ($value,$color,$type)

$value # [<device>:<reading>]
$color # Farbe der aktuellen Rollladenposition, vorangestelltes @ verändert die Farbe des Icons, ohne @ wird der Hintergrund des Icons eingefärbt, default ist @DarkOrange
$type # optional, Anzahl der Symbole 2 bis 6, 3 ist default
</syntaxhighlight>

* [[DOIF/uiTable Schnelleinstieg#Visualisierung und Steuerung von Rollläden|Anwendungsbeispiel]]
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod ui_Table_shutter DOIF ##
attr ui_Table_shutter uiTable {\
package ui_Table;;\
}\
shutter([R_Keller:pct],"\@yellow",2) ## zwei Symbole für 0 % und 100 %\
shutter([R_Wohnzimmer_S:pct]) ## entspricht shutter ([R_Wohnzimmer_S:pct],"\@DarkOrange",3) \
shutter([R_Wohnzimmer_W1:pct],"blue",4) ## vier Symbole \
shutter([R_Wohnzimmer_W2:pct],"\@red",5) ## fünf Symbole\
shutter([R_Wohnzimmer_W3:pct],"red",6 ## sechs Symbole)
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable shutter.png|mini|ohne]]

=== Helligkeit: Visualisierung und Steuerung mit Hilfe der Funktion '''dimmer''' ===
Die aktuelle Helligkeit (0 % - 100 %) wird über Icons visualisiert. Das Anklicken eines Icons bestimmt die Helligkeit der Leuchte. Prozentwerte zwischen zwei Icon-Werten werden dem nächsthöheren Icon-Wert zugeordnet.
{{Randnotiz|RNText=uiTable-Funktion '''dimmer'''
<syntaxhighlight lang="perl">
dimmer ($value,$color,$type)

$value # [<device>:<reading>]
$color # Farbe der aktuellen Helligkeit, vorangestelltes @ verändert die Farbe des Icons, ohne @ wird der Hintergrund des Icons eingefärbt, default ist @DarkOrange
$type # Anzahl der Symbole 2 bis 7, 3 ist default
</syntaxhighlight>
}}

'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_uiTable_dimmer DOIF ##
attr di_uiTable_dimmer uiTable {\
package ui_Table;;\
}\
dimmer([Strauch3:pct],"\@yellow",2)\
dimmer([Strauch3:pct]) ## entspricht dimmer([Strauch3:pct],"\@DarkOrange",3) \
dimmer([Strauch3:pct],"blue",4)\
dimmer([Strauch3:pct],"\@red",5)\
dimmer([Strauch3:pct],"red",6)\
dimmer([Strauch3:pct],"DarkOrange",7)

</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable dimmer.png|mini|ohne]]

=== Vorgabetemperatur eines Thermostats mit Hilfe der Funktion '''temp_knob''' ===
Die aktuelle Vorgabetemperatur eines Thermostats wird über ein Icons visualisiert. Durch Anklicken des Ringes wird die Vorgabetemperatur verändert.
{{Randnotiz|RNText=uiTable-Funktion '''temp_knob'''
<syntaxhighlight lang="perl">
temp_knob ($value,$color,$set)

$value # [<device>:<reading>]
$color # Farbe der voreingestellten Temperatur, default "Darkorange"
$set # set-Befehl, default "set", sonst muss "set <Readingname>" angegeben werden, falls sich das Reading vom set-Befehl vom angezeigten Reading unterscheidet, wie beim THRESHOLD-Modul
</syntaxhighlight>
}}

'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod ui_Table_temp_knob DOIF ##
attr ui_Table_temp_knob uiTable {\
package ui_Table;;\
}\
\
## HM-EU-Thermostat, angezeigt wird das Reading "desired-temp", geschaltet wird über "set desired-temp" \
"Dachgeschoss"|temp_knob([TH_DG_HM:desired-temp]) ## entspricht temp_knob([TH_DG_HM:desired-temp],"Darkorange","set") \
\
## HM-EU-Thermostat Temperaturanzeige in gelb \
"Wohnzimmer"|temp_knob([TH_WZ_HM:desired-temp],"yellow") \
\
## Beim THRESHOLD-Modul wird das Reading "desired_value" angezeigt, geändert wird die Temperatur per "set desired" \
"Küche"|temp_knob([TH_Kueche:desired_value],"red","set desired")
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable temp knob.png|mini|ohne]]

== uiTable-'''Templates''' ==
Die Definition einer oder mehrere Zellen kann zu einem Template zusammengefasst werden. Durch die Nutzung von Templates kann die Definition einer Tabelle erheblich vereinfacht werden. Insb. bei gleichartigen Zellen/Zeilen für verschiedene Geräte/Readings braucht eine aufwendige Definition nicht immer wieder wiederholt werden, sondern kann jeweils mit dem Aufruf eines zuvor definierten Templates realisiert werden.
{{Randnotiz|RNText='''Templates'''
* Die Definition von Templates muss vor der Tabellendefinition vorgenommen werden
* Eine Template-Definition beginnt mit dem Schlüsselwort '''DEF'''
* Der Template-Name muss mit '''TPL_''' beginnen
* '''Template-Definition'''-Syntax
<syntaxhighlight lang="perl">
DEF TPL_<Template-Name>(<Zellendefinition mit Platzhaltern: $1,$2,...>)
</syntaxhighlight>
* Templates-Definitionen können in externe Dateien ausgelagert werden
* Templates-Definitionen können per IMPORT-Befehl aus externen Dateien importiert werden
* '''Template-Import'''-Syntax
<syntaxhighlight lang="perl">
IMPORT <Pfad mit Dateinamen>
</syntaxhighlight>
* Innerhalb einer Tabellendefinition können zuvor definierte oder importierte Templates mehrfach genutzt werden
* '''Template-Aufruf'''-Syntax
<syntaxhighlight lang="perl">
TPL_<Template-Name>(<Übergabeparameter für $1>,<Übergabeparameter für $2>,...)
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod ui_Table_Template DOIF ##
attr ui_Table_Template uiTable {\
package ui_Table;;\
$TC{1..3}="align='center'";; ## Spalten 1 bis 3 werden zentriert\
}\
\
## Template-Definitionen beginnen vor der Tabellendefinition\
\
## Das Template TPL_raum stellt eine Tabellenzeile dar, die mit Hilfe von uiTable-Funktionen mehrere Tabellenzellen definiert\
DEF TPL_raum ("$1" | temp([TH_$2_HM:measured-temp]),hum([TH_$2_HM:humidity]) | switch([H_$2:state],"fa_off") | temp_knob([TH_$2_HM:desired-temp]))\
\
## Tabellendefinition\
\
## pro Tabellenzeile wird ein Raum mit Hilfe des oben definierten Templates "TPL_raum" dargestellt\
"Raum"|"Temp./Feuchte"|"Ventil"|"Vorgabetemp."\
TPL_raum (Dachgeschoss,DG) ## der Übergabeparameter "Dachgeschoss" wird im Template "TPL_raum" anstelle von $1 eingesetzt, "DG" wird anstelle von $2 eingesetzt\
TPL_raum (Bad,Bad)\
TPL_raum (Kinderzimmer ost,Kz_o)\
TPL_raum (Kinderzimmer west,Kz_w)\
TPL_raum (Wohnzimmer,WZ)\
TPL_raum (Keller,Keller)

</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable Templates.png|mini|ohne]]

== Eigene uiTable-Funktionen programmieren ==
Für die eigenen Bedürfnisse können eigene uiTable-Funktionen programmiert werden. In der Datei [https://svn.fhem.de/trac/browser/trunk/fhem/contrib/DOIF/uiTable.tpl contrib/DOIF/uiTable.tpl] befinden sich alle intern definierten uiTable-Funktion aus dem package ui_Table als Kopie. Diese Funktionen können als Inspiration für eigene Entwicklung dienen.
{{Randnotiz|RNText='''uiTable-Funktionen'''
* Es gibt drei Arten von uiTable-Funktionen, sie werden intern anhand der Rückgabewerte unterschieden
* uiTable-Funktionen vom Typ 1: '''HTML''', ein Rückgabewert
<syntaxhighlight lang="perl">
return(<HTML-code>)
</syntaxhighlight>
* uiTable-Funktionen vom Typ 2: '''Style''' (entspricht der '''STY'''-Funktion), zwei Rückgabewerte
<syntaxhighlight lang="perl">
return(<value>,<CSS-style>)
</syntaxhighlight>
* uiTable-Funktionen vom Typ 3: '''Widget''' (entspricht der '''WID'''-Funktion), vier Rückgabewerte
<syntaxhighlight lang="perl">
return (<value>,<>,<FHEM-widget>,<set-command: "" or "set" or "set <Readingname>">)
</syntaxhighlight>
* uiTable-Funktionen sind reine Perlfunktionen
* uiTable-Funktionen sollten im eigenen Package definiert werden, sonst könnten bestehende Perlfunktionen im System überschrieben werden
* uiTable-Funktionen können in Template-Dateien ausgelagert werden und über IMPORT-Befehl importiert werden, siehe Templates
}}

'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_uiTable_function DOIF ##
attr di_uiTable_function uiTable {\
package my_uiTable;; ## eigenes Package mit selbstdefinierten Funktionen\
\
## uiTable-Funktion vom Typ "HTML", Rückgabewert: (HTML-code)\
\
sub clock { ## Anzeige aktueller Uhrzeit mit Datum\
## Voraussetzung: contrib/DOIF/doifclock.js muss ins www/pgm2-Verzeichnis kopiert werden\
## Attribut setzen in der Webinstanz: attr <WEB-Instanz> JavaScripts pgm2/doifclock.js \
my ($color,$size)=@_;;\
$color="darkorange" if (!defined ($color));; ## $color ist optional, default Darkorange\
$size="20" if (!defined ($size));; ## $size ist optional, default 20pt\
return("<div class='doifclock'style='font-weight:bold;;font-size:".$size."pt;;color:".$color.";;'>error</div>")\
}\
\
## uiTable-Funktion vom Typ Style, Rückgabewerte (Wert,CSS-style)\
\
sub red_green { ## Farbige Skalierung von Zahlen mit Hilfe der DOIF_hsv-Funktion: von 0 - rot bis 10 - grün\
my ($value)=@_;;\
return ($value." KW", ## Wert/Text\
"font-weight:bold;;color:".::DOIF_hsv ($value,0,10,0,120,70,100) ## CSS-Style\
);;\
} \
\
## uiTable-Funktion vom Typ Widget, Rückgabewerte (Wert,Leer,FHEM-Widget,set-Befehl)\
\
sub slider { ## FHEM-Widget Slider, weitere FHEM-Widgets siehe: https://wiki.fhem.de/wiki/FHEMWEB/Widgets\
my ($value,$set)=@_;;\
$set="" if (!defined $set);;\
return ($value, ## Zahlenwert\
"", ## leer\
"slider,0,0.5,100,1", ## FHEM-Widget\
$set ## set-Befehl des FHEM-Widgets\
) \
}\
\
}\
\
## Tabellendefinition\
\
"Uhrzeit/Datum"\
clock("yellow",30) ## obige Funktion clock\
"Dimmer"\
slider([Wohnzimmer:pct]) ## obige Funktion slider\
"Leistung"\
red_green([Leistung:state]) ## obige Funktion red_green
</syntaxhighlight>

''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable-functions.png|mini|ohne]]

== Package-Konzept, Auslagerung eigener Funktionen, der '''IMPORT'''-Befehl==
uiTable arbeitet mit Packages. In einem Package sind definierte Funktionen gekapselt, sie kollidieren nicht mit bereits definierten Funktionen in FHEM.
{{Randnotiz|RNText='''Package'''
* das für die Definition der Tabelle gültige Package wird im Perlblock des uiTable-Attributes angegeben
* interne uiTable-Funktionen befinden sich im Package '''ui_Table'''
* ohne eine Angabe eines Package befindet man sich im Package '''main'''
* Funktionen außerhalb des gültigen Package müssen mit <package-Name>::<Funktion> angegeben werden
* externe uiTable-Funktionen können per IMPORT-Befehl importiert werden
}}
=== Tabellendefinition im Package main ===
<syntaxhighlight lang="perl">
defmod beispiel1 DOIF ##
attr beispiel1 uiTable ## keine Package-Definition im Perlblock\
\
## Tabellendefinition befindet sich im Package main\
\
## Funktionen aus dem main-Package können unmittelbar angegeben werden\
FW_makeImage("scene_day")\
\
## Funktionen aus dem ui_Table-Package müssen mit vorangestelltem Package angegeben werden\
ui_Table::temp ([Aussensensor:tempaerature])
</syntaxhighlight>

=== Tabellendefinition im Package ui_Table ===
<syntaxhighlight lang="perl">
defmod beispiel2 DOIF ##
attr beispiel2 uiTable {\
package ui_Table; ## Package-Angabe im Perlblock\
}\
\
## Tabellendefinition befindet sich im Package ui_Table\
\
## Funktionen aus dem main-Package müssen mit vorangestelltem package angegeben werden, der Name main kann weggelassen werden\
::FW_makeImage("scene_day")\
\
## Funktionen aus dem ui_Table-Package können direkt angegeben werden\
temp ([Aussensensor:temperature])
</syntaxhighlight>

=== Eigene uiTable-Funktionen im eigenen Package ===
Diese Art der Definition bietet sich dann an, wenn man eine eigene uiTable-Funktion nur in einem DOIF nutzen möchte.
<syntaxhighlight lang="perl">
defmod beispiel3 DOIF ##
attr beispiel3 uiTable {\
package $SELF;; ## Package-Name ist der Name des DOIF-Moduls, dadurch ist der Package-Name eindeutig\
sub scene_day { ## eigene Funktion befindet sich im eigenen Package beispiel3\
return (::FW_makeImage("scene_day"));;\
}\
}\
## Tabellendefinition befindet sich im Package beispiel3\
\
## Funktionen aus dem main-Package müssen mit vorangestelltem Package angegeben werden (der Name main kann weggelassen werden)\
::FW_makeImage("scene_day")\
\
## interne Funktionen aus dem ui_Table-Package müssen mit vorangestelltem Package ui_Table angegeben werden\
ui_Table::temp ([Aussensensor:temperature])\
\
## eigene Funktionen können direkt angegeben werden\
scene_day()
</syntaxhighlight>

=== Eigene ausgelagerte uiTable-Funktionen ===
Möchte man das ui_Table-Package um eigene Funktionen erweitern, die man in verschiedenen DOIFs nutzen möchte, so sollte man diese in eine eigene Datei auslagern, die man mit dem IMPORT-Befehl vor der Definition der Tabelle importieren kann.

Ausgelagerte Funktion in einer eigenen Datei z. B. my_uiTable.tpl:

<syntaxhighlight lang="perl">
{ ## Inhalt der Datei my_uiTable.tpl
package ui_Table; ## das aktuelle Package ist ui_Table
sub scene_day { ## eigene Funktion wird zum Package ui_Table hinzugefügt
return (::FW_makeImage("scene_day"));
}
## die Datei kann alle Funktionen beinhalten, die man in diversen DOIFs nutzen möchte
}
</syntaxhighlight>

<syntaxhighlight lang="perl">
defmod beispiel4 DOIF ##
attr beispiel4 uiTable ##\
\
IMPORT ./contrib/DOIF/my_uiTable.tpl ## nach dem Import befindet man sich in Package ui_Table erweitert um eigene Funktionen\
\
## Tabellendefinition befindet sich im Package ui_Table\
\
## Funktionen aus dem main-Package müssen mit vorangestelltem Package angegeben werden (der Name main kann weggelassen werden)\
::FW_makeImage("scene_day")\
\
## interne uiTable-Funktionen aus dem ui_Table-Package können direkt angegeben werden\
temp ([Aussensensor:temperature])\
\
## eigene Funktionen können direkt angegeben werden, da man sich bereits im Package uiTable befinden\
scene_day()\
</syntaxhighlight>

== '''hsv'''-Funktion für Farbskalierungen==
Mit Hilfe der hsv-Funktion können Texte, Werte oder Icons abhängig vom Wert eingefärbt werden. Es wird durch Vorgabe von Farbsättigung (saturation) und Helligkeit (lightness), linear ein Farbton für einen bestimmten Wert errechnet. Den Farbwert HUE (0 - 360) für den kleinsten sowie größten Wert kann man mit Hilfe eines Color-Pickers bestimmen. Der Rückgabewert ist ein Farbwert in der CSS-Notation.
{{Randnotiz|RNText='''hsv-Funktion für Farbskalierungen'''
<syntaxhighlight lang="perl">
hsv ($value,$min_value,$max_value,$min_hue,$max_hue,$saturation,$lightness)
$value # Wert, Reading
$min_value # der kleinste Wert, dieser entspricht dem Farbwert $min_hue
$max_value # der größte Wert, dieser entspricht dem Farbwert $max_hue
$min_hue # Farbwert für den kleinsten Wert $min_value
$max_hue # Farbwert für den größten Wert $max_value
$saturation # Farbsättigung, default 100, optional
$lightness # Farbhelligkeit, default 100, optional
</syntaxhighlight>
Die Funktion befindet sich im ui_Table-Package
}}

'''<big>Beispieldefinition</big>'''

<syntaxhighlight lang="perl">
defmod di_uiTable_hsv DOIF ##
attr di_uiTable_hsv uiTable {\
package ui_Table;;\
## eigene uiTable-Funktionen vom Typ 1 mit einem Rückgabewert als HTML-Code\
\
sub bat_icon { ## färbt das Icon 'measure_battery_100' abhängig vom Wert mit Hilfe der Funktion hsv \
my ($value)=@_;;\
return(ICON("measure_battery_100\@".hsv($value,0,100,0,120,100,100)))\
}\
\
sub bat_icon2 {## zusätzlich zum Farbwert wird ein entsprechendes Icon bestimmt\
my($val)=@_;;\
my $icon;;\
if ($val==0) {\
$icon="measure_battery_0";;\
} elsif ($val<=25) {\
$icon="measure_battery_25";;\
} elsif ($val<=50) {\
$icon="measure_battery_50";;\
} elsif ($val<=75) {\
$icon="measure_battery_75";;\
} else {\
$icon="measure_battery_100";;\
}\
\
my $output=ICON("$icon\@".hsv ($val,0,100,0,120,90,100));;\
return($output);;\
}\
}\
\
## Tabellendefinition\
\
## eingefärbtes Icon 0 % entspricht rot (HSV-Wert 0), 100 % entspricht grün (HSV-Wert 120) mit Direktangabe\
1|ICON("measure_battery_100\@".hsv([bat:level],0,100,0,120,100,100))\
\
## gleiche Funktionalität mit Hilfe der oben definierten Funktion bat_icon \
2|bat_icon([bat:level])\
\
## Icon mit Hilfe der oben definierten Funktion bat_icon2\
3|bat_icon2([bat:level])\
\
## Beispiel für die Farbskaliereung von 0 bis 100 % mit der obigen Funktion bat_icon\
4|bat_icon(0)|bat_icon(10)|bat_icon(20)|bat_icon(30)|bat_icon(40)|bat_icon(50)|bat_icon(60)|bat_icon(70)|bat_icon(80)|bat_icon(90)|bat_icon(100)\
\
## Beispiel für die Farbskaliereung von 0 bis 100 % mit der obigen Funktion bat_icon2\
5|bat_icon2(0)|bat_icon2(10)|bat_icon2(20)|bat_icon2(30)|bat_icon2(40)|bat_icon2(50)|bat_icon2(60)|bat_icon2(70)|bat_icon2(80)|bat_icon2(90)|bat_icon2(100)
</syntaxhighlight>

''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable DOIF hsv.png|mini|ohne]]

== Eine for-Schleife mit Hilfe des '''FOR'''-Befehls ==
Mit Hilfe des '''FOR'''-Befehls können über eine Schleife aus einer Liste mit Elementen mehrere Tabellenzellen definiert werden. Die Elementenliste (Array) kann über eine Funktion bestimmt werden. Auf diese Weise kann z. B. eine Tabelle für mehrere Geräte einfach definiert werden.
{{Randnotiz|RNText='''FOR-Befehl'''
* Der FOR-Befehl entspricht einer foreach-Schleife in Perl
* Syntax: '''FOR (<Array>,<Zellendefinitionen>)''' '''<Array>''' eine gültige Angabe eines Arrays oder eine Perlfunktion, die ein Array liefert '''<Zellendefinitionen>''' Definition einer oder mehrerer Zellen, die Angabe $_ wird durch das jeweilige Element des Arrays ersetzt
*'''nützliche Links'''
**{{Link2CmdRef|Anker=DOIF_aggregation|Lang=de|Label=DOIF Aggregationsfunktionen mit Perlfunktion AggrDoIf}}
**[[DevelopmentModuleAPI#devspec2array|devspec2array]]
}}
'''<big>Beispieldefinitionen</big>'''
<syntaxhighlight lang="perl">
defmod di_for DOIF ##
attr di_for uiTable \
## Temperaturen aller Geräte, die mit 'T' beginnen und ein Reading 'temperature' haben, sollen in einer Tabelle visualisiert werden\
FOR(::AggrDoIf('@','^T_','temperature'),"$_"|temp([$_:temperature:d2]))
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable-FOR-temperature.png|200px|ohne]]

<syntaxhighlight lang="perl">
defmod di_for DOIF ##
attr di_for uiTable \
## Anzeige des Batteriestatus aller Geräte, bei denen das Wort 'Fenster' vorkommt, die das Readings 'battery' haben\
FOR(::AggrDoIf('@','Fenster','battery'),"$_"|bat([$_:battery]))
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable-FOR-battery.png|200px|ohne]]

<syntaxhighlight lang="perl">
defmod di_for DOIF ##
attr di_for uiTable \
## Anzeige des Status aller Geräte im System vom Typ 'HMS'\
FOR(::devspec2array("TYPE=HMS"),"$_"|[$_])
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable-FOR-HMS.png|300px|ohne]]

<syntaxhighlight lang="perl">
defmod di_for DOIF ##
attr di_for uiTable \
## Elemente einer kommagetrennten Liste sollen jeweils in einer Tabellenzelle in einer Tabellenzeile angezeigt werden\
FOR(split(",","Mo,Di,Mi,Do,Fr,Sa,So"),ui_Table::style("$_","Darkorange")|)
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable-FOR-split.png|300px|ohne]]

<syntaxhighlight lang="perl">
defmod di_for DOIF ##
attr di_for uiTable \
## Durch Leerzeichen getrennte Zeichenketten sollen jeweils in einer Tabellenzelle in einer Tabellenzeile angezeigt werden\
FOR(qw/Montag Dienstag Mittwoch Donnerstag Freitag/,"$_"|)
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable-FOR-qw.png|300px|ohne]]

<syntaxhighlight lang="perl">
defmod di_for DOIF ##
attr di_for uiTable \
## das Templates TPL_raum, soll vier mal aufgerufen werden: TPL_raum(1), TPL_raum(2)...\
## das Templates TPL_raum muss vorher definiert worden sein\
FOR(1..4,TPL_raum($_))
</syntaxhighlight>

''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable-FOR TPL raum.png|600px|ohne]]

== '''Anwendungsbeispiele''' ==
=== '' Visualisierung und Steuerung von '''Rollläden''''' ===
Im folgenden Beispiel werden Rollläden morgens hochgefahren, ebenso wird die Position aller Rollläden visualisiert. Durch Anklicken eines Icons wird der Rollladen auf die entsprechende Position bewegt.
{{Randnotiz|RNText='''nützliche Links'''
* {{Link2CmdRef|Anker=DOIF_Zeitsteuerung_mit_Zeitintervallen|Lang=de|Label=Zeitsteuerung}}
* uiTable-Funktion [[DOIF/uiTable Schnelleinstieg#Rollladen: Visualisierung und Steuerung mit Hilfe der Funktion shutter|shutter]]
* uiTable-Funktion [[DOIF/uiTable Schnelleinstieg#Textformatierungen mit Hilfe der Funktion style|style]]
* [[DOIF/uiTable Schnelleinstieg#uiTable-Templates|Templates]]
}}
<syntaxhighlight lang="perl">
defmod DI_Rollladen DOIF (([Dunkelheit] eq "off" and [06:25-09:00|8]) or [09:00|7]) \
((set R_W_S,R_W_W[1-3] on)) ## Hochfahren der Rollläden im Erdgeschoss morgens\
DOELSEIF ([Dunkelheit] eq "on")
attr DI_Rollladen cmdState oben|unten
attr DI_Rollladen devStateIcon unten:status_night oben:scene_day
attr DI_Rollladen icon fts_shutter_automatic
attr DI_Rollladen uiTable {\
package ui_Table;;\
}\
\
## Template für ein Fenster\
DEF TPL_shutter("$1"|shutter([$1:pct]))\
\
## Tabellendefinition\
\
style("Dachgeschoss","Darkorange")|""\
TPL_shutter(R_Dachboden)\
style("erstes Geschoss","Darkorange")|""\
TPL_shutter(R_Bad)\
TPL_shutter(R_Kinderzimmer1_O)\
TPL_shutter(R_Kinderzimmer1_S)\
TPL_shutter(R_Kinderzimmer2_S)\
TPL_shutter(R_Kinderzimmer2_W1)\
TPL_shutter(R_Kinderzimmer2_W2)\
style("Erdgeschoss","Darkorange")|""\
TPL_shutter(R_Kueche)\
TPL_shutter(R_W_S)\
TPL_shutter(R_W_W1)\
TPL_shutter(R_W_W2)\
TPL_shutter(R_W_W3)\
style("Keller","Darkorange")|""\
TPL_shutter(R_Keller)\
</syntaxhighlight>
''Ergebnis des Anwendungsbeispiels in der Webansicht:''
[[Datei:UiTable Rollladen.png|mini|ohne]]

=== ''Anzahl der Tage bis zur '''Abfall-Entsorgung''''' ===
Mit Hilfe des Kalender-Moduls werden die verbleibenden Tage bis zur Abfall-Entsorgung der jeweiligen Tonne berechnet und mit Hilfe von uiTable visualisiert. Wenn der Tag der Entsorgung bevorsteht, wird er farbig gekennzeichnet. Vorausgesetzt wird die Definition des Kalenders namens 'cal' mit Hilfe des Moduls [[Calendar]]. Dieser muss die Termine der Abfallentsorgung der Tonnen beinhalten. Im Beispiel wird nach Stichwörtern: "Altpapier", "Restmüll", "Bio", "Gelber" und "Grünschnitt" im Kalender gesucht.
{{Randnotiz|RNText='''nützliche Links'''
* FHEM-Modul [[Calendar]]
* ui_Table Funktion [[DOIF/uiTable Schnelleinstieg#Icon-Darstellung mit Text mit Hilfe der Funktion icon_label|icon_label]]
}}
<syntaxhighlight lang="perl">
defmod Abfall DOIF subs {\
## Die Funktion 'days' sucht nach dem Ereignis $event im Kalender und berechnet die Anzahl der verbleibenden Tage und legt sie im entsprechendem Reading $reading des DOIF-Moduls ab\
sub days \
{\
my ($event,$reading)=@_;;\
set_Reading($reading,fhem('get cal events timeFormat:"%j" filter:field(summary)=~"'.$event.'" limit:count=1,from=0 format:custom="$T1"')-::strftime ('%j', localtime()),1)\
}\
## Die Funktion 'update' bestimmt die verbleibenden Tage mit Hilfe der obigen Funktion 'days' für die jeweiligen Tonnen\
sub update\
{\
days("Altpapier","altpapier");;days("Restmüll","restmuell");;days("Bio","bio");;days("Gelber","gelbe_tonne");;days("Grünschnitt","gruenschnitt");;\
}\
}\
## Beim Start, um 02:00 Uhr und 08:00 Uhr wird zeitverzögert die obige Funktion 'update' aufgerufen\
init {[02:00];;[08:00];;set_Exec("Timer",60,'update()');;\
}
attr Abfall uiTable {\
package ui_Table;;\
$TC{0..4}="align='center'";;\
$SHOWNOSTATE=1;;\
\
## die Funktion 'ic' benutzt die Funktion 'icon_label' für die Darstellung des Icons, abhängig von der Anzahl der Tage wird die Anzahl in grün bzw. rot eingefärbt \
sub ic\
{\
my ($icon,$days)=@_;;\
icon_label($icon,$days,"white",$days > 1 ? "green":"red")\
}\
}\
## Tabellendefinition, die einzelnen Tonnen werden mit Hilfe der obigen Funkton 'ic' dargestellt\
\
ic ("Abfalltonne-Recycling-Logo\@yellow",[$SELF:gelbe_tonne])|\
ic ("Abfalltonne-Recycling-Logo\@blue",[$SELF:altpapier])|\
ic ("Abfalltonne\@gray",[$SELF:restmuell])|\
ic ("Abfalltonne-Recycling-Logo\@green",[$SELF:bio])|\
ic ("Gartenabfall\@green",[$SELF:gruenschnitt])
</syntaxhighlight>

''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:Anwendungsbeispiel Abfall.png|mini|ohne]]

=== ''Visualisierung: '''offene Fenster''''' ===
Alle offenen Fenster werden aufgelistet und mit entsprechendem Icon visualisiert.
{{Randnotiz|RNText='''nützliche Links'''
* Attribut {{Link2CmdRef|Anker=DOIF_DOIF_Readings|Lang=de|Label=DOIF_Readings}}
* DOIF-{{Link2CmdRef|Anker=DOIF_aggregation|Lang=de|Label=Aggregationsfunktionen}}
* uiTable-Funktion [[DOIF/uiTable Schnelleinstieg#Icon-Darstellung mit Hilfe der Funktion icon|icon]]
}}
<syntaxhighlight lang="perl">
defmod di_uiTable_windows DOIF ## Visualisierung offener Fenster, Fenster-Devices enden mit "Fenster" im Namen
attr di_uiTable_windows DOIF_Readings windows:[@as( )"Fenster$":state:"open","keine"]
attr di_uiTable_windows uiTable {package ui_Table;;}\
icon([$SELF:windows],"fts_window_1w_open\@DarkOrange","fts_window_1w",".*","keine")|[$SELF:windows]
</syntaxhighlight>

''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable windows closed.png|mini|ohne]]
[[Datei:UiTable windows open.png|mini|ohne]]

=== ''Visualisierung: '''aktuelle Wetterlage''''' ===
Regenrader animiert, aktuelle Temperatur und Feuchte vom Sensor, aktuelle Wetterlage sowie Wettervorhersage der nächsten Tage. Über entsprechende Weblinks werden Bilder aus dem WWW in der Tabelle visualisiert. Im Gegensatz zu lokalen Sensoren, muss für die Aktualisierung der WWW-Elemente in der jeweiligen Webinstanz (FHEMWEB) das refresh-Attribut gesetzt werden.
{{Randnotiz|RNText='''nützliche Links'''
* DWD [https://www.dwd.de/DE/Home/home_node.html Homepage]
* Regenradar [https://www.dwd.de/DE/wetter/wetterundklima_vorort/_node.html Radarfilm BRD]
* aktuelles Wetter [https://www.dwd.de/DE/wetter/wetterundklima_vorort/nordrhein-westfalen/nrw_node.html NRW]
* Wetteronline [https://www.wetteronline.de/wetter-widget eignes Widget]
*
}}

<syntaxhighlight lang="perl">
defmod di_uiTable_wetter DOIF ##
attr di_uiTable_wetter uiTable {\
package ui_Table;;\
$TC{1}="align='center'";;\
}\
## das Attribut 'refresh' der Webinstanz für ein Wandtablet wurde auf 900 gesetzt, damit die Bilder alle 15 Minuten aktualisiert werden \
## Tabellendefinition\
\
## Regenradar BRD\
'<img src="https://www.dwd.de/DWD/wetter/radar/radfilm_brd_akt.gif" height="365px" width="365px">'|\
\
## Aktuelle Temperatur und Feuchtigkeit vom lokalen sensor\
temp([Aussensensor:temperature],40),hum ([Aussensensor:humidity],30),\
\
## aktuelle Wetterlage NRW\
"<img src ='https://www.dwd.de/DE/wetter/wetterundklima_vorort/nordrhein-westfalen/_functions/bildgalerie/wetter_aktuell.jpg?view=nasImage&nn=561200' height='255px' width='255px'>"|\
\
## Wettervorhersage\
"<iframe marginheight='0' marginwidth='0' scrolling='no' width='300' height='365' name='FC3' style='border:1px solid;;border-color:#00537f;;' src='https://api.wetteronline.de/wetterwidget?gid=x0677&modeid=FC3&seourl=juelich&locationname=Jülich&lang=de'></iframe>"\
</syntaxhighlight>

''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable wetter.png|600px|links]]
 

=== ''Visualisierung: '''Wetterstation''''' ===
Die vorgestellte Lösung funktioniert ohne Anmeldung beim Wetterdienst und ohne Nutzung von API.
Über den Wetterdienst: https://www.wunderground.com/ werden sehr viele private Wifi-Wetterstationen eingebunden. Das kann man sich zunutze machen, indem man zunächst in seiner Umgebung nach Wetterstationen des Dienstes sucht - oft findet man im Umkreis von wenigen Kilometern schon einige Stationen, die rege Wetterdaten liefern. Danach definiert man über HTTPMOD seine Station und visualisiert diese anschließend.

{{Randnotiz|RNText='''nützliche Links'''
* Wunderground [https://wunderground.com/ Homepage]
* svg-Funktion [https://wiki.fhem.de/wiki/DOIF/uiTable_Schnelleinstieg#Anzeige_eines_Werteverlaufs_und_des_aktuellen_Wertes_mit_Hilfe_der_SVG-Funktion_card card]
* svg-Funktionen [https://wiki.fhem.de/wiki/DOIF/uiTable_Schnelleinstieg#icon_ring-Funktionen icon_ring]
}}
Definition einer Station in der Nachbarschaft. <StationsID> muss gegen die korrekte Stationsnummer ersetzt werden.
<syntaxhighlight lang="perl">
defmod Wetter HTTPMOD https://www.wunderground.com/dashboard/pws/<StationsID>
attr Wetter enableControlSet 1
attr Wetter reading01Name Wind
attr Wetter reading01Regex wu-unit .{109}>(\d+\.\d)
attr Wetter reading02Name Windboeen
attr Wetter reading02Regex wu-unit-speed .{109}>(\d+\.\d)
attr Wetter reading03Name Windrichtung
attr Wetter reading03Regex (\d+)deg\).{84}Wind-Marker
attr Wetter reading04Name Regen
attr Wetter reading04Regex wu-unit-rainRate .{109}>(\d+\.\d\d)
attr Wetter reading05Name RegenGesamt
attr Wetter reading05Regex wu-unit-rain .{109}>(\d+\.\d\d)
attr Wetter reading06Name Temperatur
attr Wetter reading06Regex wu-unit-temperature .{127}>(\d+.\d)
attr Wetter reading07Name Feuchtigkeit
attr Wetter reading07Regex wu-unit-humidity .{109}>(\d\d)
attr Wetter reading08Name UV
attr Wetter reading08Regex UV<.{268}>(\d)
attr Wetter reading09Name Luftdruck
attr Wetter reading09Regex PRESSURE<.{285}>(\d+.\d+)
attr Wetter reading10Name TemperaturGefuehlt
attr Wetter reading10Regex wu-unit is-degree-visible .{109}>(\d+.\d)
attr Wetter reading11Name TaupunktTemp
attr Wetter reading11Regex DEWPOINT.{306}>(\d+.\d)
attr Wetter reading12Name Sonnenstrahlung
attr Wetter reading12Regex Solar radiation<.{549}>(\d+.\d+)
attr Wetter timeout 10
attr Wetter userReadings WindKm {sprintf("%1.1f",ReadingsVal("Wetter","Wind",0)*1.60934)},\
WindboeenKm {sprintf("%1.1f",ReadingsVal("Wetter","Windboeen",0)*1.60934)},\
WindrichtungGrad {ReadingsVal("Wetter","Windrichtung",0)-180},\
RegenMm {ReadingsVal("Wetter","Regen",0)*25.4},\
RegenGesamtMm {ReadingsVal("Wetter","RegenGesamt",0)*25.4},\
TemperaturC {sprintf("%1.1f",(ReadingsVal("Wetter","Temperatur",0)-32)*5/9)},\
TaupunktTempC {sprintf("%1.1f",(ReadingsVal("Wetter","TaupunktTemp",0)-32)*5/9)},\
LuftdruckHpa {sprintf("%d",ReadingsVal("Wetter","Luftdruck",0)*33.8639)},\
TemperaturGefuehltC {sprintf("%1.1f",(ReadingsVal("Wetter","TemperaturGefuehlt",0)-32)*5/9)}
</syntaxhighlight>

Nun erfolgt die Visualisierung der Daten.

<syntaxhighlight lang="perl">
defmod di_Wetter_ring DOIF ##
attr di_Wetter_ring uiTable {package ui_Table;;}\
\
icon_temp_hum_ring("temp_outside",[Wetter:TemperaturC],[Wetter:Feuchtigkeit],undef,undef,150)|\
icon_temp_ring ("temp_windchill",[Wetter:TemperaturGefuehltC],undef,undef,150) |\
icon_temp_ring ("temperature_humidity",[Wetter:TaupunktTempC],undef,undef,150) |\
icon_ring2([Wetter:WindKm] > 0 ? "wind".",1,0,0,".[Wetter:WindrichtungGrad]:"no_wind",[Wetter:WindKm],0,50,120,0,"km/h",150,undef,1,[Wetter:WindboeenKm],0,50,120,0,"km/h",undef,1) |\
icon_ring2("weather_rain_gauge",[Wetter:RegenMm],0,10,180,270,"mm/h",150,undef,1,[Wetter:RegenGesamtMm],0,50,180,270,"mm",undef,1)|\
icon_ring2("sani_solar",[Wetter:UV],0,10,100,30,"UV",150,undef,0,[Wetter:Sonnenstrahlung],0,1000,100,30,"Watt/m²",undef,0)|\
icon_ring ("weather_barometric_pressure",[Wetter:LuftdruckHpa],980,1047,0,120,"hPa",0,150)
</syntaxhighlight>

''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable ringwetter.png|600px|links]]
 

Hier ein Beispiel der Visualisierung mit Hilfe der svg-Funktion '''card''':

<syntaxhighlight lang="perl">
defmod di_Wetter DOIF ##
attr di_Wetter uiTable {package ui_Table;;}\
## card ($collect,$header,$icon,$min,$max,$minColor,$maxColor,$unit,$func,$decfont,$size,$model,$lightness)\
\
card([Wetter:TemperaturC:col12],"Außentemperatur","temp_outside",-10,30,undef,undef,"°C",\&temp_hue)|\
card([Wetter:TemperaturGefuehltC:col12],"gefühlte Temperatur","temp_windchill",-10,30,undef,undef,"°C",\&temp_hue)|\
card([Wetter:TaupunktTempC:col12],"Taupunkttemperatur","temperature_humidity",-10,30,undef,undef,"°C",\&temp_hue)|\
card([Wetter:Feuchtigkeit:col12],"Außenfeuchtigkeit","temperature_humidity",30,100,undef,undef,"%",\&hum_hue)|\
card([Wetter:WindKm:col],"Wind",[Wetter:WindKm] > 0 ? "wind".",1,0,0,".[Wetter:WindrichtungGrad]:"no_wind",0,30,120,0,"km/h",undef,1)\
card([Wetter:WindboeenKm:col12],"Windböen","weather_wind",0,30,120,0,"km/h",undef,1)|\
card([Wetter:RegenMm:col12],"Regen","weather_rain_gauge",0,10,180,270,"mm/h")|\
card([Wetter:RegenGesamtMm:col12],"Regengesamt","weather_rain_gauge",0,50,180,270,"mm")|\
##card([Wetter:UV:col],"UV-Strahlung","sani_solar",0,7,100,30,"UV",undef,0)|\
card([Wetter:Sonnenstrahlung:col12],"Sonnenstrahlung","sani_solar",0,1000,100,30,"Watt/m²",undef,0)|\
card([Wetter:LuftdruckHpa:col12],"Luftdruck","weather_barometric_pressure",980,1047,0,120,"hPa",undef,0)
</syntaxhighlight>

''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable svgwetter.png|600px|links]]
 

Ohne Angabe der Überschrift (undef für $header setzen) lässt sich eine kompaktere Darstellung erzielen:

[[Datei:UiTable svgwetteroh.png|600px|links]]

 

=== ''Visualisierung: '''aktueller Spritpreis''''' ===
Der aktuelle Spritpreis einer Tankstelle wird ermittelt und mit seinem zeitlichen Verlauf visualisiert.
{{Randnotiz|RNText='''nützliche Links'''
* svg-Funktion [[DOIF/uiTable_Schnelleinstieg#ring-Funktionen|ring]]
* svg-Funktion [[DOIF/uiTable_Schnelleinstieg#Anzeige_eines_Werteverlaufs_und_des_aktuellen_Wertes_mit_Hilfe_der_SVG-Funktion_card|card]]
* [https://www.clever-tanken.de Tankstelle bestimmen]
* Modul [[HTTPMOD]]
}}

Zunächst wird ein HTTPMOD-Modul für den aktuellen Spritpreis definiert, dabei ist <Stations-ID> durch die ID der Tankstelle zu ersetzen.

<syntaxhighlight lang="perl">
defmod Tankstelle HTTPMOD http://www.clever-tanken.de/tankstelle_details/<Stations-ID> 300
attr Tankstelle devStateIcon {ui_Table::ring(ReadingsVal("$name","Diesel",0),1.00,1.40,120,0,"Diesel",90,undef,2)." ".ui_Table::ring(ReadingsVal("$name","SuperE5",0),1.10,1.60,120,0,"E5",90,undef,2)}
attr Tankstelle enableControlSet 1
attr Tankstelle event-on-change-reading .*
attr Tankstelle group Spritpreise
attr Tankstelle reading01Name Diesel
attr Tankstelle reading01Regex "current-price-1">(\d.\d{2})
attr Tankstelle reading02Name SuperE5
attr Tankstelle reading02Regex "current-price-2">(\d.\d{2})
attr Tankstelle room Spritpreise
attr Tankstelle timeout 10
</syntaxhighlight>

''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:Di uiTable Tankstelle.png|ohne|mini]]

Visualisierung der Preisentwicklung der letzten 24 Stunden:

<syntaxhighlight lang="perl">
defmod sprit DOIF ##
attr sprit uiTable {package ui_Table;;}\
card([Tankstelle:Diesel:col24],"Diesel","fuel","1.00","1.40",120,0,"Diesel €",undef,"2",",,1")\
card([Tankstelle:SuperE5:col24],"Super E5","fuel","1.10","1.60",120,0,"Super €",undef,"2",",,1")
</syntaxhighlight>

''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:Di uiTable sprit.png|ohne|mini]]

=== '' Visualisierung und Steuerung: '''Heiztherme''''' ===
Im folgenden Beispiel wurde eine Heiztherme über einen ebus-Adapter in FHEM eingebunden. Die Heizungsdaten werden über MQTT ausgelesen und anschließend visualisiert. Die vorgestellten Visualisierungsbeispiele können ebenso im funktionslosen DOIF mit Hilfe des uiTable-Attriutes auf bereits existierende Readings des eigenen Systems angewendet werden.

{{Randnotiz|RNText='''nützliche Links'''
* svg-Funktion [[DOIF/uiTable_Schnelleinstieg#icon_ring-Funktionen|icon_ring]]
* svg-Funktion [[DOIF/uiTable_Schnelleinstieg#Anzeige_eines_Werteverlaufs_und_des_aktuellen_Wertes_mit_Hilfe_der_SVG-Funktion_card|card]]
* Commandref [https://fhem.de/commandref_DE.html#DOIF_Perl_Modus DOIF Perl-Modus]
* ebus-Adapter [https://ebusd.de/ ebusd]
* ebus-Wiki [[EBUS|ebus]]
}}

Definition eines MQTT2-Devices für die Kommunikation mit der Therme über einen ebus-Adapter.

Im diesem Fall wurde eine Vaillanttherme eingebunden, die meisten Readings wurden automatisch vom MQTT2-Server angelegt. Die Anbindung ist gerätespezifisch und unterscheidet sich je nach Gerättyp.

<syntaxhighlight lang="perl">
defmod vaillant MQTT2_DEVICE ebusd_bai
attr vaillant IODev MQTT2_FHEM_Server
attr vaillant devStateStyle style="text-align:left"
attr vaillant event-on-change-reading .*
attr vaillant group Ebus
attr vaillant icon sani_boiler_temp
attr vaillant jsonMap Status01_0_value:Vorlauf Status01_0_name:0\
Status01_1_value:Ruecklauf Status01_1_name:0\
Status01_2_value:Aussentemp Status01_2_name:0\
Status01_3_value:Warmwasser Status01_3_name:0\
Status01_4_value:WWSpeicher Status01_4_name:0\
Status01_5_value:Pumpenstatus Status01_5_name:0\
Flame_0_value:Flame Flame_0_name:0\
Storageloadpump_percent0_value:Storageloadpump\
FlowTempDesired_temp_value:VorlaufSoll\
Hc1HeatCurve_0_value:HeizKennlinie Hc1HeatCurve_0_name:0\
HolidayEndPeriod_hto_value:FerienEnde\
HolidayStartPeriod_hfrom_value:FerienBeginn\
PumpPower_0_value:PumpenLeistung PumpPower_0_name:0\
PrimaryCircuitFlowrate_uin100_value:Umlaufmenge\
z1DayTemp_tempv_value:TagSolltemp\
z1NightTemp_tempv_value:NachtSolltemp\
FanSpeed_0_value:LuefterDrehzahl FanSpeed_0_name:0\
WaterPressure_pressv_value:Wasserdruck\
z1OpMode_opmode_value:Heizmodus
attr vaillant model eBus_bai_jsonmap
attr vaillant readingList ebusd/bai/PumpHours:.* { json2nameValue($EVENT, 'PumpHours_', $JSONMAP) }\
ebusd/bai/WPPostrunTime:.* { json2nameValue($EVENT, 'WPPostrunTime_', $JSONMAP) }\
ebusd/bai/PowerValue:.* { json2nameValue($EVENT, 'PowerValue_', $JSONMAP) }\
ebusd/bai/StorageExitTemp:.* { json2nameValue($EVENT, 'StorageExitTemp_', $JSONMAP) }\
ebusd/global/version:.* version\
ebusd/global/running:.* running\
ebusd/scan\x5c\x2e08/:.* { json2nameValue($EVENT, 'scan.08_', $JSONMAP) }\
ebusd/scan\x5c\x2e08/id:.* { json2nameValue($EVENT, 'id_', $JSONMAP) }\
ebusd/global/uptime:.* uptime\
ebusd/global/signal:.* signal\
ebusd/scan\x5c\x2e15/:.* { json2nameValue($EVENT, 'scan.15_', $JSONMAP) }\
ebusd/scan\x5c\x2e15/id:.* { json2nameValue($EVENT, 'id_', $JSONMAP) }\
ebusd/bai/FanSpeed:.* { json2nameValue($EVENT, 'FanSpeed_', $JSONMAP) }\
ebusd/bai/PumpPower:.* { json2nameValue($EVENT, 'PumpPower_', $JSONMAP) }\
ebusd/broadcast/vdatetime:.* { json2nameValue($EVENT, 'vdatetime_', $JSONMAP) }\
ebusd/broadcast/outsidetemp:.* { json2nameValue($EVENT, 'outsidetemp_', $JSONMAP) }\
ebusd/bai/DateTime:.* { json2nameValue($EVENT, 'DateTime_', $JSONMAP) }\
ebusd/global/updatecheck:.* updatecheck\
ebusd/bai/DCFTimeDate:.* { json2nameValue($EVENT, 'DCFTimeDate_', $JSONMAP) }\
ebusd/bai/PumpPowerDesired:.* { json2nameValue($EVENT, 'PumpPowerDesired_', $JSONMAP) }\
ebusd/bai/HwcImpellorSwitch:.* { json2nameValue($EVENT, 'HwcImpellorSwitch_', $JSONMAP) }\
ebusd/bai/ReturnTemp:.* { json2nameValue($EVENT, 'ReturnTemp_', $JSONMAP) }\
ebusd/700/HwcStorageTempBottom:.* { json2nameValue($EVENT, 'HwcStorageTempBottom_', $JSONMAP) }\
ebusd/700/HwcTempDesired:.* { json2nameValue($EVENT, 'HwcTempDesired_', $JSONMAP) }\
ebusd/bai/FanPWMSum:.* { json2nameValue($EVENT, 'FanPWMSum_', $JSONMAP) }\
ebusd/bai/HcHours:.* { json2nameValue($EVENT, 'HcHours_', $JSONMAP) }\
ebusd/bai/HoursTillService:.* { json2nameValue($EVENT, 'HoursTillService_', $JSONMAP) }\
ebusd/bai/PumpHwcFlowNumber:.* { json2nameValue($EVENT, 'PumpHwcFlowNumber_', $JSONMAP) }\
ebusd/bai/WP:.* { json2nameValue($EVENT, 'WP_', $JSONMAP) }\
ebusd/700/WaterPressure:.* { json2nameValue($EVENT, 'WaterPressure_', $JSONMAP) }\
ebusd/bai/PrimaryCircuitFlowrate:.* { json2nameValue($EVENT, 'PrimaryCircuitFlowrate_', $JSONMAP) }\
ebusd/bai/Flame:.* { json2nameValue($EVENT, 'Flame_', $JSONMAP) }\
ebusd/bai/Storageloadpump:.* { json2nameValue($EVENT, 'Storageloadpump_', $JSONMAP) }\
ebusd/bai/Status01:.* { json2nameValue($EVENT, 'Status01_', $JSONMAP) }\
ebusd/bai/FlowTempDesired:.* { json2nameValue($EVENT, 'FlowTempDesired_', $JSONMAP) }\
ebusd/700/FrostOverRideTime:.* { json2nameValue($EVENT, 'FrostOverRideTime_', $JSONMAP) }\
ebusd/700/Hc1ActualFlowTempDesired:.* { json2nameValue($EVENT, 'Hc1ActualFlowTempDesired_', $JSONMAP) }\
ebusd/700/Hc1AutoOffMode:.* { json2nameValue($EVENT, 'Hc1AutoOffMode_', $JSONMAP) }\
ebusd/700/Hc1CircuitType:.* { json2nameValue($EVENT, 'Hc1CircuitType_', $JSONMAP) }\
ebusd/700/Hc1HeatCurve:.* { json2nameValue($EVENT, 'Hc1HeatCurve_', $JSONMAP) }\
ebusd/700/HcStorageTempBottom:.* { json2nameValue($EVENT, 'HcStorageTempBottom_', $JSONMAP) }\
ebusd/700/HcStorageTempTop:.* { json2nameValue($EVENT, 'HcStorageTempTop_', $JSONMAP) }\
ebusd/700/HolidayTemp:.* { json2nameValue($EVENT, 'HolidayTemp_', $JSONMAP) }\
ebusd/700/OpMode:.* { json2nameValue($EVENT, 'OpMode_', $JSONMAP) }\
ebusd/700/z1RoomTemp:.* { json2nameValue($EVENT, 'z1RoomTemp_', $JSONMAP) }\
ebusd/700/z1SFMode:.* { json2nameValue($EVENT, 'z1SFMode_', $JSONMAP) }\
ebusd/700/z1OpMode:.* { json2nameValue($EVENT, 'z1OpMode_', $JSONMAP) }\
ebusd/700/Time:.* { json2nameValue($EVENT, 'Time_', $JSONMAP) }\
ebusd/bai/EbusVoltage:.* { json2nameValue($EVENT, 'EbusVoltage_', $JSONMAP) }\
ebusd/bai/extWP:.* { json2nameValue($EVENT, 'extWP_', $JSONMAP) }\
ebusd/bai/FanStarts:.* { json2nameValue($EVENT, 'FanStarts_', $JSONMAP) }\
ebusd/700/z1NightTemp:.* { json2nameValue($EVENT, 'z1NightTemp_', $JSONMAP) }\
ebusd/700/z1DayTemp:.* { json2nameValue($EVENT, 'z1DayTemp_', $JSONMAP) }\
ebusd/700/HolidayStartPeriod:.* { json2nameValue($EVENT, 'HolidayStartPeriod_', $JSONMAP) }\
ebusd/700/HolidayEndPeriod:.* { json2nameValue($EVENT, 'HolidayEndPeriod_', $JSONMAP) }\
ebusd/700/z1Timer.Monday:.* { json2nameValue($EVENT, 'z1Timer.Monday_', $JSONMAP) }\
ebusd/700/z1Timer.Tuesday:.* { json2nameValue($EVENT, 'z1Timer.Tuesday_', $JSONMAP) }\
ebusd/700/z1Timer.Wednesday:.* { json2nameValue($EVENT, 'z1Timer.Wednesday_', $JSONMAP) }\
ebusd/700/z1Timer.Thursday:.* { json2nameValue($EVENT, 'z1Timer.Thursday_', $JSONMAP) }\
ebusd/700/z1Timer.Friday:.* { json2nameValue($EVENT, 'z1Timer.Friday_', $JSONMAP) }\
ebusd/700/z1Timer.Sunday:.* { json2nameValue($EVENT, 'z1Timer.Sunday_', $JSONMAP) }\
ebusd/700/z1Timer.Saturday:.* { json2nameValue($EVENT, 'z1Timer.Saturday_', $JSONMAP) }\
ebusd/bai/PrEnergyCountHc1:.* { json2nameValue($EVENT, 'PrEnergyCountHc1_', $JSONMAP) }\
ebusd/bai/PrEnergyCountHwc1:.* { json2nameValue($EVENT, 'PrEnergyCountHwc1_', $JSONMAP) }\
ebusd/bai/PrEnergySumHc1:.* { json2nameValue($EVENT, 'PrEnergySumHc1_', $JSONMAP) }\
ebusd/bai/PrEnergySumHwc1:.* { json2nameValue($EVENT, 'PrEnergySumHwc1_', $JSONMAP) }\
ebusd/bai/FanHours:.* { json2nameValue($EVENT, 'FanHours_', $JSONMAP) }\
ebusd/bai/HcHours:.* { json2nameValue($EVENT, 'HcHours_', $JSONMAP) }\
ebusd/bai/HwcHours:.* { json2nameValue($EVENT, 'HwcHours_', $JSONMAP) }\
ebusd/bai/HcStarts:.* { json2nameValue($EVENT, 'HcStarts_', $JSONMAP) }\
ebusd/bai/HwcStarts:.* { json2nameValue($EVENT, 'HwcStarts_', $JSONMAP) }
attr vaillant setList HeizKennlinie:selectnumbers,0,.1,2,1,lin ebusd/700/Hc1HeatCurve/set $EVTPART1\
TagSolltemp:selectnumbers,15,1,25,1,lin ebusd/700/z1DayTemp/set $EVTPART1\
NachtSolltemp:selectnumbers,15,1,25,1,lin ebusd/700/z1NightTemp/set $EVTPART1
</syntaxhighlight>

Definition eines DOIF-Devices zur Steuerung der Therme und Visualisierung der Daten. Es werden Readings und Befehle genutzt, die durch den MQTT2-Server der obigen Definition zur Verfügung gestellt werden. Einzelne Heizungswerte werden in bestimmten Intervallen über den publish-Befehl ausgelesen. Die Temperaturen der Zirkulation, des Vorlaufs und des Rücklaufs werden außerhalb der Therme mit 1-wire-Temperatursensoren über WLAN-ESP-Easy ausgelesen. Die Definition des Layouts über das Attribut uiTable ist unabhängig vom Auslesen der Werte, sie bezieht sich lediglich auf vorhandene Readings, die visualisiert werden sollen. Das Layout kann ebenso auf Readings aus anderen Devices der eigenen FHEM-Umgebung anpasst werden.

<syntaxhighlight lang="perl">
defmod di_vaillant DOIF ##{[+00:01];;foreach (qw(FanSpeed Flame PumpPower Storageloadpump PrimaryCircuitFlowrate FlowTempDesired PumpHours HcHours HcPumpStarts)) {fhem_set("MQTT2_FHEM_Server publish ebusd/bai/$_/get")}}\
\
{[+[1]:01];;foreach (qw(PrEnergySumHc1 PrEnergySumHwc1 HcHours HwcHours z1OpMode WaterPressure z1NightTemp z1DayTemp Hc1HeatCurve HwcLockTime HolidayStartPeriod HolidayEndPeriod)) {fhem_set("MQTT2_FHEM_Server publish ebusd/bai/$_/get")}\
}\
\
{[+00:00:30];;foreach (qw(Flame PrimaryCircuitFlowrate)) {fhem_set("MQTT2_FHEM_Server publish ebusd/bai/$_/get")}}\
\
init {[00:01];;foreach (qw(FanHours HcStarts HwcStarts )) {fhem_set("MQTT2_FHEM_Server publish ebusd/bai/$_/get")}\
set_Reading("gesamt_hc",int([?vaillant:PrEnergySumHc1_0_value]/10000)/10,0);;\
set_Reading("gesamt_hwc",int([?vaillant:PrEnergySumHwc1_0_value]/10000)/10,0);;\
set_Reading("diff_hc",0,0);;\
set_Reading("diff_hwc",0,0);;\
}\
\
{if ([00:05|WE]) {fhem_set("MQTT2_FHEM_Server publish ebusd/700/BankHolidayStartPeriod/set $mday.$month.$year");;fhem_set("MQTT2_FHEM_Server publish ebusd/700/BankHolidayEndPeriod/set $mday.$month.$year")}}\
\
Timer {\
fhem_set "MQTT2_FHEM_Server publish ebusd/700/z1Timer.Monday/set 04:00;;09:00;;13:00;;22:00;;-:-;;-:-"\
fhem_set "MQTT2_FHEM_Server publish ebusd/700/z1Timer.Tuesday/set 04:00;;09:00;;13:00;;22:00;;-:-;;-:-"\
fhem_set "MQTT2_FHEM_Server publish ebusd/700/z1Timer.Wednesday/set 04:00;;09:00;;13:00;;22:00;;-:-;;-:-"\
fhem_set "MQTT2_FHEM_Server publish ebusd/700/z1Timer.Thursday/set 04:00;;09:00;;13:00;;22:00;;-:-;;-:-"\
fhem_set "MQTT2_FHEM_Server publish ebusd/700/z1Timer.Friday/set 04:00;;09:00;;13:00;;22:00;;-:-;;-:-"\
fhem_set "MQTT2_FHEM_Server publish ebusd/700/z1Timer.Sunday/set 05:00;;10:00;;12:00;;22:30;;-:-;;-:-"\
fhem_set "MQTT2_FHEM_Server publish ebusd/700/z1Timer.Saturday/set 05:00;;10:00;;12:00;;22:30;;-:-;;-:-"\
}\
\
diff {\
set_Reading("diff_hc",int(([vaillant:PrEnergySumHc1_0_value]/100000-get_Reading("gesamt_hc",0))*10)/10,1);;\
set_Reading("diff_hwc",int(([vaillant:PrEnergySumHwc1_0_value]/100000-get_Reading("gesamt_hwc",0))*10)/10,1);;\
}\

attr di_vaillant event-on-change-reading .*
attr di_vaillant uiTable {\
package ui_Table;;\
$TABLE='text-align:center;;';;\
}\
icon_temp_ring("temp_outside",[vaillant:Aussentemp],-15,40)|\
icon_temp_mring(([vaillant:Flame] eq "off"?"sani_boiler_temp\@white":"sani_boiler_temp\@Darkorange"),[vaillant:Vorlauf],15,70)|\
icon_temp_mring(([vaillant:Pumpenstatus] eq "4" ? "sani_buffer_temp_down\@Darkorange" : "sani_buffer_temp_down\@white"),[vaillant:WWSpeicher],15,70)|\
icon_uring("0,0,1","weather_barometric_pressure",[vaillant:Wasserdruck],0,3,undef,undef,"bar",1,100,[(0.8,0,1,60,1.5,120,1.7,60,3,0)])|\
icon_ring("sani_floor_heating_neutral",[vaillant:HcHours_hoursum2_value],0,10000,120,0,"h",0)|\
icon_ring("sani_water_tap",[vaillant:HwcHours_hoursum2_value],0,2000,120,0,"h",0)<\
\
card([vaillant:Aussentemp:col],"Außentemperatur","temp_outside",-15,35,undef,undef,"°C",\&temp_hue)|\
card([vaillant:WWSpeicher:col],"WW-Speicher",([vaillant:Pumpenstatus] eq "4" ? "sani_buffer_temp_down\@Darkorange" : "sani_buffer_temp_down\@white"),15,70,undef,undef,"°C",\&temp_hue)\
card([ESPEasy_ESP_Temp_Zirkulation:Temperature:col],"Zirkulation",([Zirk] eq "off"?"sani_pump\@white":"sani_pump\@Darkorange"),15,70,undef,undef,"°C",\&temp_hue)|\
card([ESPEasy_ESP_Temp_Vorlauf:Temperature:col],"Vorlauf",([vaillant:Pumpenstatus] eq "on" ? "sani_floor_heating\@Darkorange" : "sani_floor_heating_neutral\@white"),15,70,undef,undef,"°C",\&temp_hue)\
card([vaillant:Umlaufmenge:col],"Umlaufmenge","sani_pump",0,20,120,0,"l/min")|\
card([ESPEasy_ESP_Temp_Keller_Ruecklauf:Temperature:col],"Rücklauf","sani_floor_heating_neutral\@white",15,70,undef,undef,"°C",\&temp_hue)\
card([$SELF:diff_hc:col],"Energie Heizung","sani_floor_heating_neutral",0,200,120,0,"kWh",undef,1)|\
card([$SELF:diff_hwc:col],"Energie Warmwasser","sani_water_tap",0,20,120,0,"kWh",undef,1)<\
\
icon_ring("time_graph",[vaillant:HeizKennlinie],0.4,1,120,0,"HK",1,110)|\
icon_temp_mring("scene_day\@yellow",[vaillant:TagSolltemp],undef,undef,110)|\
icon_temp_mring("scene_night\@#3464eb",[vaillant:NachtSolltemp],undef,undef,110)\
\
widget([vaillant:HeizKennlinie],"selectnumbers,0.4,.1,1,1,lin","set")|widget([vaillant:TagSolltemp],"selectnumbers,15,1,25,1,lin","set")|widget([vaillant:NachtSolltemp],"selectnumbers,15,1,25,1,lin","set")
</syntaxhighlight>

''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:Di uiTable Heizung.png|ohne|mini]]

=== ''Visualisierung: '''Anwesenheitsstatus''''' ===
Die aktuelle Anwesenheit von Heimbewohnern wird visualisiert. 
Zunächst wird mit Hilfe des Moduls [[FRITZBOX]] ein Device namens ''FritzBox'' erstellt. Dort werden die eingebuchten Smartphones der Bewohner mit Ihren MAC-Adressen in Readings abgelegt. Die folgende Definition wertet aus, ob die angegebenen MAC-Adressen als Readings vorhanden sind und erstellt für jeden Bewohner ein Reading mit den Zuständen on/off. Diese Readings werden dann über das Attribut uiTable visualisiert. Die anwesenden Personen werden farblich markiert. Die Namen der Personen sowie die MAC-Adressen sind fiktiv und müssen den eigenen Angaben entsprechend angepasst werden.
{{Randnotiz|RNText='''nützliche Links'''
* [[FRITZBOX|FritzBox-Modul]]
* ui_Table Funktion [[DOIF/uiTable Schnelleinstieg#Icon-Darstellung mit Text mit Hilfe der Funktion icon_label|icon_label]]
*[[DOIF/uiTable Schnelleinstieg#uiTable-Templates|uiTable-Templates]]
}}

<syntaxhighlight lang="perl">
defmod myHome DOIF {\
set_Reading_Begin;;\
set_Reading_Update("Ernie",[FritzBox:mac_12_34_E0_00_CD_E4] ? "on":"off");;\
set_Reading_Update("Bert", [FritzBox:mac_02_08_02_07_30_E3] ? "on":"off");;\
set_Reading_Update("Grobi", [FritzBox:mac_00_08_01_0B_00_E7] ? "on":"off");; \
set_Reading_Update("Kermit", [FritzBox:mac_01_30_A9_72_02_E3] ? "on":"off");; \
set_Reading_End(1);;\
}
attr myHome checkReadingEvent 0
attr myHome uiTable {\
package ui_Table;;\
$SHOWNOSTATE=1;;\
$TC{0..4}="align='center'";;\
}\
## Template-Definition für die Visualisierung eines Bewohners mit Hilfe des Icons fa__508\
DEF TPL_person (icon_label([$SELF:$1] eq "on" ? "fa__508\@DarkOrange":"fa__508","$1","#e67e00","white",-10))\
\
## Darstellung der Bewohner mit Hilfe des obigen Templates\
TPL_person(Ernie)|TPL_person(Bert)|TPL_person(Grobi)|TPL_person(Kermit)
</syntaxhighlight>

''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable myHome.png|ohne|mini]]

=== Weitere Anwendungsbeispiele zur Automatisierung ===
* siehe [[DOIF/Automatisierung]]

== Weiterführende Links ==
* Weitere Beispiele für Fortgeschrittene, siehe "[[DOIF/uiTable|uiTable mit FHEM-Widgets und Styles]]"

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

DOIF/uiTable Schnelleinstieg

2021-02-20T17:24:36Z

Cwagner: Rand-Notiz icon_ring: Parameter $dec gehört hinter $unit wie im Beispiel auch gezeigt

[[Datei:UiTable state screen.png|700px|rechts|Webansicht bestehend aus mehreren DOIF/uiTable-Definitionen]]
An dieser Stelle wird das DOIF-Web-Interface erklärt, welches über das DOIF-Attribut '''uiTable''' realisiert wurde.

Abhängig von der Art der Funktion können in einer tabellarischen Darstellung FHEM-Geräte visualisiert und über die Web-Oberfläche bedient werden. Eventbasierte Änderungen visualisierter Readings werden unmittelbar in der Web-Ansicht aktualisiert. Eine erstellte Tabelle erscheint unterhalb der Statuszeile des DOIFs. Das uiTable-Attribut kann in bereits bestehenden DOIFs oder in funktionslosen DOIFs, wie in den unteren Beispielen, als reines WEB-Interface erstellt werden. In der Abbildung rechts ist ein Statusbildschirm aus vier Spalten mit mehreren DOIF/uiTable-Definitionen aufgebaut worden. 

Die Darstellungsmöglichkeiten werden anhand von Beispielen insb. mit Hilfe bereits im DOIF-Modul vordefinierter uiTable-Funktionen aufgezeigt. Diese Perlfunktionen sind in einem eigenen Package namens 'ui_Table' definiert worden. Mit Hilfe dieser Funktionen lassen sich recht einfach, ohne tiefere HTML/CSS-Kenntnisse, eigene Übersichten definieren. Im Anschluss werden typische '''[https://wiki.fhem.de/wiki/DOIF/uiTable_Schnelleinstieg#Anwendungsbeispiele Anwendungsbeispiele]''' aufgezeigt.

Die folgenden Beispieldefinitionen arbeiten mit konkreten Geräten und Readings, sie können als RAW-Definition ins eigene System übernommen werden, dazu müssen die Gerätenamen, Readings, ggf. auch Icons den existierenden Namen des eigenen Systems angepasst werden. Zum Ausprobieren der Beispiele können statt echter Geräte auch Dummys benutzt werden.
 

== Aufbau des uiTable-Attributs ==
Im uiTable-Attribut wird in erster Linie die zu visualisierende Tabelle definiert. Optional können zuvor ein Perlblock sowie Templates definiert werden.

{{Randnotiz|RNText='''Aufbau des Attributs'''
* das uiTable-Attribut besteht aus drei Bereichen:
* [https://wiki.fhem.de/wiki/DOIF/uiTable_Schnelleinstieg#Der_Perlblock Perlblock]
* [https://wiki.fhem.de/wiki/DOIF/uiTable_Schnelleinstieg#uiTable-Templates Templates-Definitionen]
* [https://wiki.fhem.de/wiki/DOIF/uiTable_Schnelleinstieg#Die_Tabellendefinition Tabellendefinition]
}}
'''Aufbaustruktur'''
<syntaxhighlight lang="perl">
{
<Perlblock, optional>
}

<Templates-Definitionen, optional>

<Tabellendefinition>
</syntaxhighlight>
=== Der Perlblock ===
Der Perlblock dient dazu das Layout der Tabelle zu beeinflussen sowie eigene uiTable-Funktionen zu definieren. Hier wird insb. das Package definiert, welches für die Tabellendefinition gilt. Ebenfalls können CSS-Variablen sowie Steuerungsattribute gesetzt werden. Der Perlblock beginnt und endet mit einer geschweiften Klammer.
==== CSS-Variablen und Steuerungsattribute ====
Mit Hilfe von CSS-Variablen kann das Layout der Tabelle beeinflusst werden. Die Steuerungsattribute beeinflussen die Statuszeile sowie die Detailansicht des DOIF-Moduls.
{{Randnotiz|RNText='''CSS-Variablen und Steuerungsattribute'''
*Das Layout der gesamten Tabelle wird beeinflusst über die Variablendefinition: '''$TABLE="<CSS-Attribute der Tabelle>"'''
*Spaltenformatierungen werden beeinflusst mit Hilfe der Variablendefinition: '''$TC{<Zellenbereich für Spalten>}="<CSS-Attribute der Spalten>"'''
*Zeilenformatierungen werden beeinflusst mit Hilfe der Variablendefinition: '''$TR{Zeilenbereich}="<CSS-Attribute der Zeilen>"'''
*einzelne Zellen werden beeinflusst mit Hilfe der Variablen: '''$TD{<Zellenbereich für Zeilen>}{<Zellenbereich für Spalten>}="<CSS-Attribute der Zellen>"'''
*für Zellen-, Spalten- und Zeilen-Bereich gilt: '''<Zahl><nowiki>|</nowiki><kommagetrennte Aufzählung><nowiki>|</nowiki><Bereich von..bis>'''
*Der Status in der Statuszeile des DOIFs wird ausgeblendet mit '''$SHOWNOSTATE=1'''
*Die Gerätezeile des DOIFs wird ausgeblendet mit '''$SHOWNODEVICELINE = "<regex room>"'''
*Die Tabelle des DOIFs wird ausgeblendet mit '''$SHOWNOUITABLE = "<regex room>"'''
*Die Detailansicht wird umorganisiert mit '''$ATTRIBUTESFIRST=1'''
}}
'''Bespieldefinition'''
<syntaxhighlight lang="perl">
defmod di_bsp_layout DOIF ##
attr di_bsp_layout uiTable { ## Beginn des Perlblocks\
## CSS-Variablen\
\
## Die Tabelle soll ein Hintergrundbild der Größe 300x300 Pixel haben\
$TABLE = "width:300px;; height:300px;; background-image:url(/fhem/www/pgm2/images/Grundriss.png);; background-size: 300px 300px;;";;\
\
## die Zelle der ersten Zeile und der ersten Spalte soll rechts eine Rahmenlinie haben\
$TD{0}{0} = "style='border-right-style:solid;; border-right-width:10px'";;\
\
## Die erste Zeile soll aus der Klasse 'odd' sein und fett-Schrift haben\
$TR{0} = "class='odd' style='font-weight:bold'";;\
\
## die Spalten 2 bis 6 sollen zentriert sein\
$TC{1..5} = "align='center'";;\
\
## die Spalten 2, 4 und 5 sollen zentriert sein\
$TC{1,3,5} = "align='center'";;\
\
## die letzte Spalte der Tabelle soll fett sein\
$TC{last} = "style='font-weight:bold'";;\
\
\## Steuerungsattribute\
\
\## Ausblenden des Status in der Statuszeile\
$SHOWNOSTATE=1;;\
\
## Die Gerätezeile wird ausgeblendet in allen Räumen\
$SHOWNODEVICELINE = ".*";;\
\
## Die Tabelle wird im Raum info ausgeblendet\
$SHOWNOUITABLE = "^info$";;\
\
## Die Detailansicht wird umorganisiert, hilfreich beim Editieren längerer uiTable-Definitionen\
$ATTRIBUTESFIRST = 1;;\
} ## Ende des Perlblocks
</syntaxhighlight>

=== Die Tabellendefinition ===
==== Einfache Tabellendefinition ohne Funktionen ====
{{Randnotiz|RNText='''Tabellendefinition'''
* eine Tabelle wird aus Zellen zusammengebaut
* mehrere Zellen werden mit <nowiki>|</nowiki> von einander getrennt, sie bilden eine Tabellenzeile
* eine neue Tabellenzeile beginnt mit einer neuen Zeile in der Tabellendefinition
* eine Tabellenzeile kann auch in mehreren Zeilen definiert werden, diese müssen dann mit <nowiki>|</nowiki> enden
* Texte werden in Anführungszeichen angegeben
* Readings werden in der Form [<device>:<reading>] angegeben
* Kommentare beginnen mit ## und enden mit Zeilenende
* Events eines definierten Readings, führen sofort zu Aktualisierung seines Inhalts in der visualisierten Tabelle
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod ui_Table_definition DOIF ##
attr ui_Table_definition uiTable { ## Perlblock für globale Tabellendefinitionen\
\
$TC{1..2}="align='center'" ## zentrierte Ausrichtung der zweiten und dritten Spalte\
\
}\
\
## Tabellendefinition\
\
"Warmwasser"|"Vorlauf"|"Rücklauf" ## erste Tabellenzeile\
## zweite Tabellenzeile\
[T_Warmwasserspeicher:temperature]| ## Zeile wird fortgesetzt, da sie mit | endet\
[T_Vorlauf:temperature]| ## Zeile wird fortgesetzt, da sie mit | endet\
[T_Ruecklauf:temperature]
</syntaxhighlight>

''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable Definition.png|mini|ohne]]

==== Tabellendefinition mit Berechnungen ====
{{Randnotiz|RNText='''Zellenauswertung'''
* jede Zelle der Tabelle wird über Perl ausgewertet
* Readingangaben der Form [<device>:<reading>] werden in eine Perlfunktion übersetzt
* das Ergebnis des ausgewerteten Perlausdrucks wird ausgegeben
* in einer Zelle können beliebige Perlfunktionen genutzt werden
* Texte oder Funktionen können mit Punkt aneinander gehängt werden
* mit Komma werden Texte oder Werte untereinander dargestellt
* in einer Berechnung sollte ein Trigger in Form einer Readingangabe [<device>:<reading>] vorkommen, sonst wäre das Ergebnis statisch und würde sich nicht ändern
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_uiTable_calc DOIF ##
attr di_uiTable_calc uiTable ## Tabellendefinition\
"Differenz"|[T_Ruecklauf:temperature]-[T_Vorlauf:temperature]\
"Minimum"|minNum([TH_WZ_HM:measured-temp],[TH_Keller_HM:measured-temp])\
"Durchschnitt"|([T_Ruecklauf:temperature]+[T_Vorlauf:temperature])/2
</syntaxhighlight>

''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable calc.png|mini|ohne]]

== FHEM-Widgets mit der '''WID'''-Funktion ==
Alle in FHEM vorhanden Widgets können mit Hilfe der WID-Funktion genutzt werden. Bei häufiger Nutzung eines bestimmten Widgets bietet sich alternativ die Definition einer uiTable-Funktion (Typ 3) mit dem jeweiligen Widget an, siehe: [https://wiki.fhem.de/wiki/DOIF/uiTable_Schnelleinstieg#Eigene_uiTable-Funktionen_programmieren uiTable-Funktion]
{{Randnotiz|RNText=Widget-Funktion '''WID'''
<syntaxhighlight lang="perl">
WID(<Reading>,<FHEM-Widget>)

Reading # [<device>:<reading>]
FHEM-Widget # Angabe des FHEM-Widgets
</syntaxhighlight>

'''nützliche Links'''
* Fhem-Widgets [https://wiki.fhem.de/wiki/FHEMWEB/Widgets wiki]
* Fhem-Widgets als [https://wiki.fhem.de/wiki/DOIF/uiTable_Schnelleinstieg#Eigene_uiTable-Funktionen_programmieren uiTable-Funktion]
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_uiTable_WID DOIF ##
attr di_uiTable_WID uiTable ## FHEM-Widgets mit Hilfe der WID-Funktion\
"Widget"\
"Select"| WID([uhr:wochentag],"select,Montag,Dienstag,Mittwoch,Donnerstag,Freitag,Samstag,Sonntag")\
"Selectnumbers"| WID([motor:spannung],"selectnumbers,0,0.5,12,1,lin")\
"Slider"| WID([bla:wert],"slider,0,5,100,1")\
"Colorpicker RGB"| WID([Lampe:farbe],"colorpicker,RGB")\
"Colorpicker HSV"| WID([Lampe:farbe],"colorpicker,HSV")\
"Colorpicker CT"| WID([Lampe:waerme],"colorpicker,CT,2000,10,6500")\
"Colorpicker HUE"| WID([Lampe:farbe],"colorpicker,HUE,0,1,359")\
"Colorpicker BRI"| WID([Lampe:helligkeit],"colorpicker,BRI,0,1,100")\
"Time"| WID([start:zeit],"time")\
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable WID.png|mini|ohne]]

== Vordefinierte uiTable-Funktionen ==
Typische Widgets bzw. Styles wurden als Perl-Funktionen im package ui_Table für eine einfache Tabellendefinition programmiert. Im folgenden wird näher auf die einzelnen uiTable-Funktionen eingegangen.
=== SVG-uiTable-Funktionen ===
SVG-uiTable-Funktionen sind skalierbare Widgets, die auf SVG-Elementen basieren. Bei allen SVG-Funktionen für Temperatur bzw. Feuchtigkeit wird die Einfärbung abhängig vom Temperatur- bzw. Feuchtigkeitswert mit Hilfe einer Zuordnungsfunktion bestimmt.
==== ring-Funktionen ====
===== Farbskalierte Temperaturanzeige mit Hilfe der SVG-Funktionen '''temp_ring/temp_mring''' =====
Die Farbe der dargestellten Temperatur ist abhängig vom Temperaturwert. Die Helligkeit der Farbgebung ist einstellbar. Bei der '''temp_mring'''-SVG-Funktion wird der Ring einfarbig dargestellt.

Farbskalierung der '''temp_ring'''-SVG-Funktion:
[[Datei:Farbskalierung temp_ring_scaling.png|600px|ohne]]

Farbskalierung der '''temp_mring'''-SVG-Funktion:
[[Datei:Farbskalierung temp_mring_scaling.png|600px|ohne]]

{{Randnotiz|RNText=SVG-uiTable-Funktion '''temp_ring/temp_mring'''
<syntaxhighlight lang="perl">
temp_ring/temp_mring ($temp_value,$temp_min,$temp_max,$size, $lightring,$lightnumber)

$temp_value # Temperatur
$temp_min, # minimale Temperatur, optional, default=-20
$temp_max, # maximale Temperatur, optional, default=60
$size, # Größe der Grafik, optional, default=80
$lightring, # Helligkeit des Ringes (0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (0-100), optional, default=50
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_temp_ring DOIF ##
attr di_temp_ring room test2
attr di_temp_ring uiTable {package ui_Table}\
"außen"|temp_ring([Aussensensor:temperature])\
"Warmwasser" |temp_mring([vaillant:WWSpeicher],15,70,110,90,100)\
"Vorlauf"| temp_mring([ESPEasy_ESP_Temp_Vorlauf:Temperature],15,45,100)\
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:temp_ring_bsp.png|ohne|mini]]

===== Farbskalierte Feuchtigkeitsanzeige mit Hilfe der SVG-Funktionen '''hum_ring/hum_mring''' =====
Die Farbe der dargestellten Feuchtigkeit ist abhängig vom Feuchtigkeitswert. Die Helligkeit der Farbgebung ist einstellbar. Bei der '''hum_mring'''-SVG-Funktion wird der Ring einfarbig dargestellt.

Farbskalierung der '''hum_ring'''-SVG-Funktion:
[[Datei:Farbskalierung hum_ring_scaling.png|600px|ohne]]

Farbskalierung der '''hum_mring'''-SVG-Funktion:
[[Datei:Farbskalierung hum_mring_scaling.png|600px|ohne]]

{{Randnotiz|RNText=SVG-uiTable-Funktion '''hum_ring/hum_mring'''
<syntaxhighlight lang="perl">
hum_ring/hum_mring ($hum_value,$size,$lightring,$lightnumber)
$hum_value # Feuchtigkeit
$size # Größe der Grafik, optional, default=80
$lightring # Helligkeit des Ringes (0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (0-100), optional, default=50
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_hum_ring DOIF ##
attr di_hum_ring room test2
attr di_hum_ring uiTable {package ui_Table}\
"klein ohne Farbverlauf"|hum_mring([Aussensensor:humidity],60)\
"normal groß mit Farbverlauf"|hum_ring([Aussensensor:humidity])\
"groß ohne Farbverlauf aufgehellt"|hum_mring([Aussensensor:humidity],100,80)
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:hum_ring_bsp.png|ohne|mini]]

===== Farbskalierte Anzeige eines Zahlenwertes mit Hilfe der universellen SVG-Funktion '''ring''' =====
Die Farbe des dargestellten Wertes kann abhängig vom Wert bestimmt werden.
{{Randnotiz|RNText=SVG-uiTable-Funktion '''ring'''
<syntaxhighlight lang="perl">
ring ($value,$min,$max,$minColor,$maxColor,$unit, $size,$colorFunc,$dec,$gradient,$light,$lightnumber)

$value # darzustellender Wert
$min # minimaler Wert, optional, default=0
$max # maximaler Wert, optional, default=100
$minColor # Farbe (hue: 0-360) des kleinsten Wertes, optional, default = undef
$maxColor # Farbe (hue: 0-360) des maximalen Wertes, optional, default = undef
$unit # Einheit des Wertes, optional, default = undef
$size # Größe der Grafik, optional, default = 100
$colorFunc # Funktion, die zu einem Wert einen Farbwert (hue: 0-360) bestimmt, optional, default = undef
$dec # Anzahl der dargestellten Nachkommastellen, optional, default = 1
$gradient # Farbverlauf, optional, undef mit Farbverlauf, 1 ohne Farbverlauf, default = undef
$ligh # Helligkeit der Grafik (light:0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (light:0-100), optional, default=50
</syntaxhighlight>
Wird '''$colorFunc''' nicht angegeben, so wird der Farbwert zwischen '''$minColor''' und '''$maxColor''' linear interpoliert
}}

'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_ring DOIF ##
attr di_ring uiTable {package ui_Table}\
## von 0 bis 20 in Farben von grün (hue:120) bis rot (hue:0)\
"Umlaufmenge"|ring([heizung:Umlaufmenge],0,20,120,0,"l/min",100)\
\
## von 0 bis 3 in Farben von rot (hue:0) bis türkis (hue:180)\
"Wasserdruck"|ring([heizung:Wasserdruck],0,3,0,180,"bar",100)\
\
## Temperaturdarstellung, entspricht dem Funktionsaufruf:\
## temp_ring ([Aussensensor:temperature],-20,60,100)\
"Temperatur"|ring([Aussensensor:temperature],-20,60,undef,undef,"°C",100,\&temp_hue)\
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:ring_bsp.png|ohne|mini]]

===== Farbskalierte Temperatur- und Feuchtigkeitsanzeige mit Hilfe der SVG-Funktion '''temp_hum_ring''' =====
Die Farbe ist jeweils abhängig vom dargestellten Temperatur- bzw. Feuchtigkeitswert. Die Helligkeit der Farbgebung ist einstellbar:
[[Datei:Farbskalierung temp_hum_ring_scaling.png|600px|ohne]]

{{Randnotiz|RNText=SVG-uiTable-Funktion '''temp_hum_ring'''
<syntaxhighlight lang="perl">
temp_hum_ring ($temp_value,$hum_value,$temp_min,$temp_max,$size, $lightring,$lightnumber)

$temp_value # Temperatur
$hum_value # Feuchtigkeit
$temp_min # minimale Temperatur, optional, default=-20
$temp_max # maximale Temperatur, optional, default=60
$size # Größe der Grafik, optional, default=90
$lightring # Helligkeit des Ringes (0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (0-100), optional, default=50
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_temp_hum_ring DOIF ##
attr di_temp_hum_ring uiTable {package ui_Table}\
\
"klein aufgehellt"|temp_hum_ring([Aussensensor:temperature],[Aussensensor:humidity],undef,undef,60,80)\
"normal"|temp_hum_ring([Aussensensor:temperature],[Aussensensor:humidity])\
"groß Zahlen aufgehellt"|temp_hum_ring([Aussensensor:temperature],[Aussensensor:humidity],undef,undef,100,undef,80)
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:temp_hum_ring_bsp.png|ohne|mini]]

===== Farbskalierte Anzeige von zwei Temperaturwerten mit Hilfe der SVG-Funktion '''temp_temp_ring''' =====
Die Farbe ist jeweils abhängig vom dargestellten Temperaturwert. Die Helligkeit der Farbgebung ist einstellbar:
[[Datei:Farbskalierung temp_temp_ring_scaling.png|600px|ohne]]

{{Randnotiz|RNText=SVG-uiTable-Funktion '''temp_temp_ring'''
<syntaxhighlight lang="perl">
temp_temp_ring ($temp1_value,$temp2_value,$temp_min,$temp_max,$size, $lightring,$lightnumber)

$temp1_value # erster Temperaturwert
$temp2_value # zweiter Temperaturwert
$temp_min # minimale Temperatur, optional, default=-20
$temp_max # maximale Temperatur, optional, default=60
$size # Größe der Grafik, optional, default=90
$lightring # Helligkeit des Ringes (0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (0-100), optional, default=50
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_temp_temp_ring DOIF ##
attr di_temp_temp_ring uiTable {package ui_Table}\
"klein, Ring augehellt"|temp_temp_ring([Vorlauf:Temperature],[Ruecklauf:Temperature],15,60,60,80,50)\
"normal"|temp_temp_ring([Vorlauf:Temperature],[Ruecklauf:Temperature],15,60)\
"groß, Zahlen aufgehellt"|temp_temp_ring([Vorlauf:Temperature],[Ruecklauf:Temperature],15,60,100,undef,80)
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:temp_hum_temp_bsp.png|ohne|mini]]

===== Farbskalierte Anzeige von zwei Zahlenwerten mit Hilfe der universellen SVG-Funktion '''ring2''' =====
Die Farbe der dargestellten Werte kann abhängig vom Wert bestimmt werden.

{{Randnotiz|RNText=SVG-uiTable-Funktion '''ring2'''
<syntaxhighlight lang="perl">
ring2 ($value1,$min1,$max1,$minColor1,$maxColor1,$unit1,$size,$colorFunc1,$dec1,
$value2,$min2,$max2,$minColor2,$maxColor2,$unit2,$colorFunc2,$dec2)

$value1 # darzustellender Wert1
$min1 # minimaler Wert, optional, default=0
$max1 # maximaler Wert, optional, default=100
$minColor1 # Farbe (hue: 0-360) des kleinsten Wertes, optional, default = undef
$maxColor1 # Farbe (hue: 0-360) des maximalen Wertes, optional, default = undef
$unit1 # Einheit des Wertes, optional, default = undef
$size # Größe der Grafik, optional, default = 100
$colorFunc1 # Funktion, die zu einem Wert einen Farbwert (hue: 0-360) bestimmt, optional, default = undef
$dec1 # Anzahl der Dezimalstellen, optional, default = 1
...
Werte für den zweiten Wert entsprechend dem ersten Wert
</syntaxhighlight>
Wird '''$colorFunc...''' nicht angegeben, so wird der Farbwert zwischen '''$minColor...''' und '''$maxColor...''' linear interpoliert
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_ring2 DOIF ##
attr di_ring2 uiTable {package ui_Table}\
## Stromstärke von 0 A bis 15 A in Farben von grün (hue:120) bis rot (hue:0)\
## Kapazität von 0 % bis 100 % in Farben von rot (hue:0) bis grün (hue:120)\
"Tesla"| ring2([tesla:Strom],0,16,120,0,"A",120,undef,2,[tesla:Kapazitaet],0,100,0,120,"%",undef,0)\
\
## Stromstärke von 0 A bis 2 A in Farben von grün (hue:120) bis rot (hue:0)\
## Spannung von 1 V bis 1.5 V in Farben von rot (hue:0) bis grün (hue:120)\
"Akku"| ring2([akku:Strom],0,2,120,0,"A",120,undef,2,[akku:Spannung],1,1.5,0,120,"V",undef,2)\
\
"Temperatur","Taupunkt"| ring2([Aussensensor:temperature],-20,60,undef,undef,"°C",120,\&temp_hue,1,[Aussensensor:dewpoint],0,30,undef,undef,"°C",\&temp_hue,1)\
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:ring2_bsp.png|ohne|mini]]

==== icon_ring-Funktionen ====
===== Farbskalierte Temperaturanzeige mit Hilfe der SVG-Funktionen '''icon_temp_ring/icon_temp_mring''' =====
Diese Funktionen basieren auf den obigen temp_ring-Funktionen, zusätzlich wird ein SVG-Icon dargestellt. Die Farbe des Icons kann mit @ an den Iconnamen angehängt werden, ansonsten wird die Farbe der Temperatur für das Icon verwendet. Die Größe des Icons kann skaliert werden, ebenso kann die Positionen des Icons verschoben werden.

{{Randnotiz|RNText=SVG-uiTable-Funktion '''icon_temp_ring/icon_temp_mring'''
<syntaxhighlight lang="perl">
icon_temp_ring/icon_temp_mring ($icon,$temp_value,$temp_min,$temp_max,$size,$lightring,$lightnumber)

$icon # "Iconname\@Farbe,Skalierungsfaktor,x-Position,y-Position", \@Farbe, Skalierungsfaktor, x-Position, y-Position sind optional
$temp_value # Temperatur
$temp_min, # minimale Temperatur, optional, default=-20
$temp_max, # maximale Temperatur, optional, default=60
$size, # Größe der Grafik, optional, default=80
$lightring, # Helligkeit des Ringes (0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (0-100), optional, default=50
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_Heizung_temp DOIF ##
attr di_Heizung_temp uiTable {\
package ui_Table;;\
}\
\
icon_temp_ring("temp_outside",[vaillant:Aussentemp],-15,40)|\
icon_temp_mring(([vaillant:Flame] eq "off"?"sani_boiler_temp\@white":"sani_boiler_temp\@Darkorange"),[vaillant:Vorlauf],15,70)|\
icon_temp_mring(([vaillant:Pumpenstatus] eq "4" ? "sani_buffer_temp_down\@Darkorange" : "sani_buffer_temp_down\@white"),[vaillant:WWSpeicher],15,70)|\
icon_temp_mring(([Zirk] eq "off"?"sani_pump\@white":"sani_pump\@Darkorange"),[ESPEasy_ESP_Temp_Zirkulation:Temperature],15,70)|\
icon_temp_mring(([vaillant:Pumpenstatus] eq "on" ? "sani_floor_heating\@Darkorange" : "sani_floor_heating_neutral\@white"),[ESPEasy_ESP_Temp_Vorlauf:Temperature],15,70)|\
icon_temp_mring("sani_floor_heating_neutral\@white",[ESPEasy_ESP_Temp_Keller_Ruecklauf:Temperature],15,70)|""

</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:icon_temp_ring_bsp.png|ohne|mini]]

===== Farbskalierte Feuchtigkeitsanzeige mit Hilfe der SVG-Funktionen '''icon_hum_ring/icon_hum_mring''' =====
Diese Funktionen basieren auf den obigen hum_ring-Funktionen, zusätzlich wird ein SVG-Icon dargestellt. Die Farbe des Icons kann mit @ an den Iconnamen angehängt werden, ansonsten wird die Farbe der Feuchtigkeit für das Icon verwendet. Die Größe des Icons kann skaliert werden, ebenso kann die Positionen des Icons verschoben werden.
{{Randnotiz|RNText=SVG-uiTable-Funktion '''icon_hum_ring/icon_hum_mring'''
<syntaxhighlight lang="perl">
icon_hum_ring/icon_hum_mring ($icon,$hum_value,$size,$lightring,$lightnumber)

$icon # "Iconname\@Farbe,Skalierungsfaktor,x-Position,y-Position", \@Farbe, Skalierungsfaktor, x-Position, y-Position sind optional
$hum_value # Feuchtigkeit
$size # Größe der Grafik, optional, default=80
$lightring # Helligkeit des Ringes (0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (0-100), optional, default=50
</syntaxhighlight>
}}

'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_icon_hum_ring DOIF ##
attr di_icon_hum_ring room test5
attr di_icon_hum_ring uiTable {package ui_Table}\
"klein ohne Farbverlauf"|icon_hum_mring("weather_humidity",[Aussensensor:humidity],60)\
"normal groß mit Farbverlauf"|icon_hum_ring("weather_humidity",[Aussensensor:humidity])\
"groß ohne Farbverlauf aufgehellt"|icon_hum_mring("weather_humidity",[Aussensensor:humidity],100,80)
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:icon_hum_ring_bsp.png|ohne|mini]]

===== Farbskalierte Anzeige eines Icons mit einem Zahlenwert mit Hilfe der universellen SVG-Funktion '''icon_ring''' =====
Diese Funktion basiert auf der universellen ring-Funktion. Die Farbe des dargestellten Icons und des Wertes kann abhängig vom Wert bestimmt werden.

{{Randnotiz|RNText=SVG-uiTable-Funktion '''icon_ring'''
<syntaxhighlight lang="perl">
ring ($icon,$value,$min,$max,$minColor,$maxColor,$unit,$dec,$size, $colorFunc,$gradient,$light,$lightnumber)

$icon # "Iconname\@Farbe,Skalierungsfaktor,x-Position,y-Position", \@Farbe, Skalierungsfaktor, x-Position, y-Position sind optional
$value # darzustellender Wert
$min # minimaler Wert, optional, default=0
$max # maximaler Wert, optional, default=100
$minColor # Farbe (hue: 0-360) des kleinsten Wertes, optional, default = undef
$maxColor # Farbe (hue: 0-360) des maximalen Wertes, optional, default = undef
$unit # Einheit des Wertes, optional, default = undef
$dec # Anzahl der dargestellten Nachkommastellen, optional, default = 1
$size # Größe der Grafik, optional, default = 100
$colorFunc # Funktion, die zu einem Wert einen Farbwert (hue: 0-360) bestimmt, optional, default = undef
$gradient # Farbverlauf, optional, undef mit Farbverlauf, 1 ohne Farbverlauf, default = undef
$light # Helligkeit der Grafik (light:0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (light:0-100), optional, default=50
</syntaxhighlight>
Wird '''$colorFunc''' nicht angegeben, so wird der Farbwert zwischen '''$minColor''' und '''$maxColor''' linear interpoliert
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_icon_ring DOIF ##
attr di_icon_ring uiTable {package ui_Table;;\
}\
icon_ring ("fuel",[Tankstelle:Diesel],1.10,1.30,120,0,"€",2)|\
icon_ring ("air",[ESPEasy_Eingang_CO2:PPM],400,1200,120,0,"ppm",0)|\
icon_ring ("Zisterne",([Wasserzisterne]/3.4),0,100,0,120,"%",0)|\
icon_ring ("measure_water_meter",[Wasserverbrauch:heute],0,600,120,0,"l",0)\
icon_ring (([vaillant:Pumpenstatus] eq "4" ? "sani_buffer_temp_down\@Darkorange" : "sani_buffer_temp_down\@white"),[vaillant:Umlaufmenge],0,20,120,0,"l/min")|\
icon_ring ("weather_barometric_pressure",[vaillant:Wasserdruck],0,3,0,180,"bar")|\
icon_ring ("sani_floor_heating_neutral",[Heizenergie:Vortag_hc],0,150,120,0,"kWh")|\
icon_ring("sani_water_tap",[vaillant:HwcHours_hoursum2_value],0,2000,120,0,"h",0)
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:icon_ring_bsp.png|ohne|mini]]

==== bar-Funktionen ====

===== Farbskalierte Anzeige der Temperatur in Balkenform mit Hilfe der SVG-Funktionen '''temp_bar/temp_mbar''' =====
Die Farbe der dargestellten Temperatur ist abhängig vom Temperaturwert. Die Helligkeit der Farbgebung ist einstellbar. Bei der '''temp_mbar'''-SVG-Funktion wird der Balken einfarbig dargestellt.

Farbskalierung der '''temp_bar'''-SVG-Funktion:
[[Datei:Farbskalierung temp_bar_scaling.png|600px|ohne]]

Farbskalierung der '''temp_mbar'''-SVG-Funktion:
[[Datei:Farbskalierung temp_mbar_scaling.png|600px|ohne]]

{{Randnotiz|RNText=SVG-uiTable-Funktion '''temp_bar/temp_mbar'''
<syntaxhighlight lang="perl">
temp_bar/temp_mbar ($temp_value,$temp_min,$temp_max, $header,$width,$height,$size,$light,$lightnumber)

$temp_value # Temperaturwert
$temp_min # minimale Temperatur, optional, default=-20
$temp_max # maximale Temperatur, optional, default=60
$header # Überschrift, optional, default= undef (keine)
$width # Breite der Grafik, optional, default=75
$height # Höhe der Grafik, optional, default=70
$size # Größe der Grafik, optional, default=100
$light # Helligkeit der Grafik (0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (0-100), optional, default=50
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
{package ui_Table}
"standard"|temp_bar([Aussensensor:temperature])
"heller"|temp_bar([Aussensensor:temperature],undef,undef,undef,undef,undef,undef,80)
"monochrom"|temp_mbar([Aussensensor:temperature])
"kleiner"|temp_bar([Aussensensor:temperature],undef,undef,undef,undef,undef,80)
"mit Überschrift"|temp_bar([Aussensensor:temperature],undef,undef,"Außen")
"hoch"|temp_bar([Aussensensor:temperature],undef,undef,undef,undef,100)
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:temp_bar_bsp.png|ohne|mini]]

===== Farbskalierte Anzeige der Feuchtigkeit in Balkenform mit Hilfe der SVG-Funktionen '''hum_bar/hum_mbar''' =====
Die Farbe der dargestellten Feuchtigkeit ist abhängig vom Feuchtigkeitswert. Die Helligkeit der Farbgebung ist einstellbar. Bei der '''hum_mbar'''-SVG-Funktion wird der Balken einfarbig dargestellt.

Farbskalierung der '''hum_bar'''-SVG-Funktion:
[[Datei:Farbskalierung hum_bar_scaling.png|600px|ohne]]

Farbskalierung der '''hum_mbar'''-SVG-Funktion:
[[Datei:Farbskalierung hum_mbar_scaling.png|600px|ohne]]

{{Randnotiz|RNText=SVG-uiTable-Funktion '''hum_bar/hum_mbar'''
<syntaxhighlight lang="perl">
hum_bar/hum_mbar ($hum_value,$header,$width,$height,$size, $light,$lightnumber)

$hum_value # Temperaturwert
$header # Überschrift, optional, default = undef (keine)
$width # Breite der Grafik, optional, default=75
$height # Höhe der Grafik, optional, default=70
$size # Größe der Grafik, optional, default=100
$light # Helligkeit des der Grafik (0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (0-100), optional, default=50
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_hum_bar DOIF ##
attr di_hum_bar uiTable {package ui_Table}\
"standard"|hum_bar([Aussensensor:humidity])\
"heller"|hum_bar([Aussensensor:humidity],undef,undef,undef,undef,80)\
"monochrom"|hum_mbar([Aussensensor:humidity])\
"kleiner"|hum_bar([Aussensensor:humidity],undef,undef,undef,80)\
"mit Überschrift"|hum_bar([Aussensensor:humidity],"Außen")\
"hoch"|hum_bar([Aussensensor:humidity],undef,undef,100)
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:hum_bar_bsp.png|ohne|mini]]

===== Farbskalierte Anzeige eines Zahlenwertes mit Hilfe der universellen SVG-Funktion '''bar''' =====
Die Farbe des dargestellten Wertes kann abhängig vom Wert bestimmt werden.

{{Randnotiz|RNText=SVG-uiTable-Funktion '''bar'''
<syntaxhighlight lang="perl">
bar ($value,$min,$max,$header,$minColor,$maxColor,$unit,$width, $height,$size,$colorFunc,$dec,$gradient,$light,$lightnumber)

$value # darzustellender Wert
$min # minimaler Wert, optional, default=0
$max # maximaler Wert, optional, default=100
$header # Überschrift, optional, default = undef (keine)
$minColor # Farbe (hue: 0-360) des kleinsten Wertes, optional, default = undef
$maxColor # Farbe (hue: 0-360) des maximalen Wertes, optional, default = undef
$unit # Einheit des Wertes, optional, default = undef
$width # Breite der Grafik, optional, default = 75
$height # Höhe der Grafik, optional, default = 70
$size # Größe der Grafik, optional, default = 100
$colorFunc # Funktion, die zu einem Wert einen Farbwert (hue: 0-360) bestimmt, optional, default = undef
$dec # Anzahl der dargestellten Nachkommastellen, optional, default = 1
$gradient # Farbverlauf, optional, undef mit Farbverlauf, 1 ohne Farbverlauf, default = undef
$light # Helligkeit der Grafik (light:0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (light:0-100), optional, default=50
</syntaxhighlight>
Wird '''$colorFunc''' nicht angegeben, so wird der Farbwert zwischen '''$minColor''' und '''$maxColor''' linear interpoliert
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
{package ui_Table}
defmod di_bar DOIF ##
attr di_bar uiTable {package ui_Table}\
## von 0 bis 20 in Farben von grün (hue:120) bis rot (hue:0)\
"Umlaufmenge"|bar([heizung:Umlaufmenge],0,20,"Umlauf",120,0,"l/min",75)\
\
## von 0 bis 3 in Farben von rot (hue:0) bis türkis (hue:180)\
"Wasserdruck"|bar([heizung:Wasserdruck],0,3,undef,0,180,"bar",undef,80,100)\
\
## Temperaturdarstellung, entspricht dem Funktionsaufruf:\
## temp_bar ([Aussensensor:temperature],-20,60,undef,undef,55,100)\
"Temperatur"|bar([Aussensensor:temperature],-20,60,undef,undef,undef,"°C",undef,55,100,\&temp_hue)
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:bar_bsp.png|ohne|mini]]

==== icon_bar-Funktionen ====

===== Farbskalierte Anzeige der Temperatur in Balkenform mit Hilfe der SVG-Funktion '''icon_temp_bar/icon_temp_mbar''' =====
Die Farbe der dargestellten Temperatur ist abhängig vom Temperaturwert. Die Helligkeit der Farbgebung ist einstellbar. Bei der '''icon_temp_mbar'''-SVG-Funktion wird der Balken einfarbig dargestellt.

{{Randnotiz|RNText=SVG-uiTable-Funktion '''icon_temp_bar/icon_temp_mbar'''
<syntaxhighlight lang="perl">
icon_temp_bar/icon_temp_mbar ($icon,$temp_value,$temp_min,$temp_max, $header,$width,$height,$size,$light,$lightnumber)

$icon # "Iconname\@Farbe,Skalierungsfaktor,x-Position,y-Position", \@Farbe, Skalierungsfaktor, x-Position, y-Position sind optional
$temp_value # Temperaturwert
$temp_min # minimale Temperatur, optional, default=-20
$temp_max # maximale Temperatur, optional, default=60
$header # Überschrift, optional, default= undef (keine)
$width # Breite der Grafik, optional, default=75
$height # Höhe der Grafik, optional, default=70
$size # Größe der Grafik, optional, default=100
$light # Helligkeit der Grafik (0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (0-100), optional, default=50
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_icon_temp_bar DOIF ##
attr di_icon_temp_bar room test10
attr di_icon_temp_bar uiTable {package ui_Table}\
"standard"|icon_temp_bar("temp_outside",[Aussensensor:temperature])\
"heller"|icon_temp_bar("temp_outside",[Aussensensor:temperature],undef,undef,undef,undef,undef,undef,80)\
"monochrom"|icon_temp_mbar("temp_outside",[Aussensensor:temperature])\
"kleiner"|icon_temp_bar("temp_outside",[Aussensensor:temperature],undef,undef,undef,undef,undef,80)\
"mit Überschrift"|icon_temp_bar("temp_outside",[Aussensensor:temperature],undef,undef,"Außen")\
"hoch"|icon_temp_bar("temp_outside",[Aussensensor:temperature],undef,undef,undef,undef,100)
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:icon_temp_bar_bsp.png|ohne|mini]]

===== Farbskalierte Anzeige der Feuchtigkeit in Balkenform mit Hilfe der SVG-Funktionen '''icon_hum_bar/icon_hum_mbar''' =====
Die Farbe der dargestellten Feuchtigkeit ist abhängig vom Feuchtigkeitswert. Die Helligkeit der Farbgebung ist einstellbar. Bei der '''icon_hum_mbar'''-SVG-Funktion wird der Balken einfarbig dargestellt.

{{Randnotiz|RNText=SVG-uiTable-Funktion '''icon_hum_bar/icon_hum_mbar'''
<syntaxhighlight lang="perl">
icon_hum_bar/icon_hum_mbar ($icon,$hum_value,$header,$width,$height,$size,$light,$lightnumber)

$icon # "Iconname\@Farbe,Skalierungsfaktor,x-Position,y-Position", \@Farbe, Skalierungsfaktor, x-Position, y-Position sind optional
$hum_value # Temperaturwert
$header # Überschrift, optional, default = undef (keine)
$width # Breite der Grafik, optional, default=75
$height # Höhe der Grafik, optional, default=70
$size # Größe der Grafik, optional, default=100
$light # Helligkeit des der Grafik (0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (0-100), optional, default=50
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_icon_hum_bar DOIF ##
attr di_icon_hum_bar uiTable {package ui_Table}\
"standard"|icon_hum_bar("temperature_humidity",[Aussensensor:humidity])\
"heller"|icon_hum_bar("temperature_humidity",[Aussensensor:humidity],undef,undef,undef,undef,80)\
"monochrom"|icon_hum_mbar("temperature_humidity",[Aussensensor:humidity])\
"kleiner"|icon_hum_bar("temperature_humidity",[Aussensensor:humidity],undef,undef,undef,80)\
"mit Überschrift"|icon_hum_bar("temperature_humidity",[Aussensensor:humidity],"Außen")\
"hoch"|icon_hum_bar("temperature_humidity",[Aussensensor:humidity],undef,undef,100)
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:icon_hum_bar_bsp.png|ohne|mini]]

===== Farbskalierte Anzeige eines Zahlenwertes mit Hilfe der universellen SVG-Funktionen '''icon_bar/icon_mbar''' =====
Die Farbe des dargestellten Wertes und des Icons kann abhängig vom Wert bestimmt werden. Bei der '''icon_mbar'''-SVG-Funktion wird der Balken einfarbig dargestellt.

{{Randnotiz|RNText=SVG-uiTable-Funktion '''icon_bar/icon_mbar'''
<syntaxhighlight lang="perl">
bar ($icon,$value,$min,$max,$minColor,$maxColor,$unit,$header, $width,$height,$size,$colorFunc,$dec,$light,$lightnumber)

$value # darzustellender Wert
$min # minimaler Wert, optional, default=0
$max # maximaler Wert, optional, default=100
$header # Überschrift, optional, default = undef (keine)
$minColor # Farbe (hue: 0-360) des kleinsten Wertes, optional, default = undef
$maxColor # Farbe (hue: 0-360) des maximalen Wertes, optional, default = undef
$unit # Einheit des Wertes, optional, default = undef
$width # Breite der Grafik, optional, default = 75
$height # Höhe der Grafik, optional, default = 70
$size # Größe der Grafik, optional, default = 100
$colorFunc # Funktion, die zu einem Wert einen Farbwert (hue: 0-360) bestimmt, optional, default = undef
$dec # Anzahl der dargestellten Nachkommastellen, optional, default = 1
$light # Helligkeit der Grafik (light:0-100), optional, default=50
$lightnumber # Helligkeit der Zahl (light:0-100), optional, default=50
</syntaxhighlight>
Wird '''$colorFunc''' nicht angegeben, so wird der Farbwert zwischen '''$minColor''' und '''$maxColor''' linear interpoliert
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_icon_bar_bsp DOIF ##
attr di_icon_bar_bsp uiTable {package ui_Table;;\
}\
icon_bar ("fuel",[Tankstelle:Diesel],1.10,1.30,120,0,"€",2)|\
icon_bar ("air",[ESPEasy_Eingang_CO2:PPM],400,1200,120,0,"ppm",0,undef,65)|\
icon_bar ("Zisterne",([Wasserzisterne]/3.4),0,100,0,120,"%",0)|\
icon_bar (([vaillant:Pumpenstatus] eq "off" ? "sani_buffer_temp_down\@Darkorange" : "sani_buffer_temp_down\@white"),[vaillant:Umlaufmenge],0,20,120,0,"l/min",1,undef,80)\
icon_bar ("measure_water_meter",[Wasserverbrauch:heute],0,600,120,0,"l",0)|\
icon_bar ("weather_barometric_pressure",[vaillant:Wasserdruck],0,3,0,180,"bar",1,undef,65)|\
icon_bar ("sani_water_tap",[vaillant:HwcHours_hoursum2_value],0,2000,120,0,"h",0)|\
icon_bar ("sani_floor_heating_neutral",[Heizenergie:Vortag_hc],0,150,120,0,"kWh",1,undef,80)
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:icon_bar_bsp.png|ohne|mini]]

==== 3d-Balkendarstellung mehrerer Zahlenwerten mit Hilfe der universellen SVG-Funktion '''cylinder''' ====
Es können mehrere Zahlenwerte mit Legende farbig in Balkenform visualisiert werden. Negative Werte werden als Balken nach unten dargestellt, positive nach oben, der Nullpunkt wird automatisch berechnet.
{{Randnotiz|RNText=SVG-uiTable-Funktion '''cylinder'''
<syntaxhighlight lang="perl">
cylinder ($header,$min,$max,$unit,$width,$height,$size,$dec,($value1,$color1,$text1),($value2,$color2,$text2),...

$header # Überschrift
$min # minimaler Wert, optional, default = 0
$max # maximaler Wert, optional, default = 100
$unit # Einheit des Wertes, optional, default = undef
$width # Breite der Grafik, optional, default = wird bei Beschriftungen automatisch angepasst
$height # Höhe der Grafik, optional, default = wird automatisch berechnet
$size # Größe der Grafik, optional, default = 100
$dec # Anzahl der Nachkommastellen, optional, default=1
$value1 # erster Zahlenwert
$color1 # HSL-Farbe des ersten Balkens: "<hue>.<saturation>.<lightness>" (hue:0-360,saturation:0-100,lightness:0-100), saturation (default:100) und lightness (default:50) sind optional
$text1 # Beschriftung des Zahlenwertes in der Legende, optional, default = undef
$value2 # zweiter Zahlenwert, optional
$color2 # HSL-Farbe des zweiten Balkens: "<hue>.<saturation>.<lightness>" (hue:0-360,saturation:0-100,lightness:0-100), saturation (default:100) und lightness (default:50) sind optional
$text2 # Beschriftung des Zahlenwertes in der Legende, optional, default = undef
...
Es können weitere Zahlenwerte jeweils mit Farbe und Beschriftung optional angegeben werden
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_cylinder DOIF ##
attr di_cylinder room Test,wiki
attr di_cylinder uiTable {package ui_Table}\
"normal"|cylinder("",0,100,"%",80,undef,undef,0,[Wasserzisterne:state],200,undef)\
\
"mit Überschrift"|cylinder("Zisterne",0,100,"%",80,undef,undef,0,[Wasserzisterne:state],200,undef)\
\
"kleiner"|cylinder("Zisterne",0,100,"%",80,undef,80,0,[Wasserzisterne:state],200,undef)\
\
"hoch"|cylinder("Zisterne",0,100,"%",undef,100,undef,0,[Wasserzisterne:state],200,undef)\
\
"mit Beschriftung"|cylinder("Zisterne",0,100,"%",undef,100,undef,0,[Wasserzisterne:state],200,"Wasserstand")\
\
"mit mehreren Informationen"|cylinder("Energie",-20,30,"kWh",undef,undef,undef,1,[zaehler:Bezug],0,"Bezug",[zaehler:Produktion],60,"Produktion",[zaehler:Eigenverbrauch],30,"Eigenverbrauch")\
\
"mit hellen Farben"| cylinder("Tag",0,100,"kWh",undef,undef,undef,1,[Heizenergie:Tagesverbrauch_hc]/100000,"30.100.70","letzter",[Heizenergie:heute_hc]/100000,"60.100.70","aktuell")
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:cylinder_bsp.png|ohne|mini]]

==== Balkendarstellung mehrerer Zahlenwerten mit Hilfe der universellen SVG-Funktion '''cylinder_bars''' ====
Es können mehrere Zahlenwerte mit Legende farbig in Balkenform visualisiert werden. Negative Werte werden als Balken nach unten dargestellt, positive nach oben, der Nullpunkt wird automatisch berechnet. Die '''cylinder_bars'''-SVG-Funkton besitzt die gleichen Argumente, wie die obige '''cylinder'''-SVG-Funktion, mehrerer Balken werden jedoch nicht übereinander, sondern nebeneinander dargestellt.
{{Randnotiz|RNText=SVG-uiTable-Funktion '''cylinder_bars'''
<syntaxhighlight lang="perl">
cylinder_bars ($header,$min,$max,$unit,$width,$height,$size,$dec,($value1,$color1,$text1),($value2,$color2,$text2),...

$header # Überschrift
$min # minimaler Wert, optional, default = 0
$max # maximaler Wert, optional, default = 100
$unit # Einheit des Wertes, optional, default = undef
$width # Breite der Grafik, optional, default = wird bei Beschriftungen automatisch angepasst
$height # Höhe der Grafik, optional, default = wird automatisch berechnet
$size # Größe der Grafik, optional, default = 100
$dec # Anzahl der Nachkommastellen, optional, default=1
$value1 # erster Zahlenwert
$color1 # HSL-Farbe des ersten Balkens: "<hue>.<saturation>.<lightness>" (hue:0-360,saturation:0-100,lightness:0-100), saturation (default:100) und lightness (default:50) sind optional
$text1 # Beschriftung des Zahlenwertes in der Legende, optional, default = undef
$value2 # zweiter Zahlenwert, optional
$color2 # HSL-Farbe des zweiten Balkens: "<hue>.<saturation>.<lightness>" (hue:0-360,saturation:0-100,lightness:0-100), saturation (default:100) und lightness (default:50) sind optional
$text2 # Beschriftung des Zahlenwertes in der Legende, optional, default = undef
...
Es können weitere Zahlenwerte jeweils mit Farbe und Beschriftung optional angegeben werden
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_wasserverbrauch DOIF ##
attr di_wasserverbrauch uiTable {package ui_Table;;}\
cylinder_bars("Monat",0,15,"m³",undef,undef,undef,1,[Wasserverbrauch:monatsdurchschnitt],30,"Durchschnitt",[Wasserverbrauch:monatsverbrauch]/1000,220,"letzter",[Wasserverbrauch:monat]/1000,180,"aktuell")\
\
cylinder_bars("Monat",0,15,"m³",undef,undef,undef,1,[Wasserverbrauch:jan],30,"Januar",[Wasserverbrauch:feb],220,"Februar",[Wasserverbrauch:mrz],180,"März",[Wasserverbrauch:apr],30,"April",[Wasserverbrauch:mai],220,"Mai",[Wasserverbrauch:jun],180,"Juni",[Wasserverbrauch:jul],30,"Juli",[Wasserverbrauch:aug],220,"August",[Wasserverbrauch:sep],180,"September",[Wasserverbrauch:okt],30,"Oktober",[Wasserverbrauch:nov],220,"November",[Wasserverbrauch:dez],180,"Dezember")
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:cylinder_bars_bsp.png|ohne|mini]]

=== Farbskalierte Temperaturanzeige mit Hilfe der Funktion '''temp''' ===
Die Farbe der dargestellten Temperatur ist abhängig vom Temperaturwert:
[[Datei:Farbskalierung temp.png|600px|ohne]]
{{Randnotiz|RNText=uiTable-Funktion '''temp'''
<syntaxhighlight lang="perl">
temp ($temp,$size,$icon)

$temp # Temperatur
$size # Schriftgröße in Pixel (pt), optional
$icon # Icon, welches vorangestellt wird, optional
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_uiTable_temp DOIF ##
attr di_uiTable_temp uiTable {\
package ui_Table;; ## Package für uiTable-Funktionen\
$TC{0..2}="align='center'";; ## zentrierte Darstellung aller Tabellenspalten\
}\
## Tabellendefinition\
\
"Aussen"|"Bad"|"Warmwasser" ## mit | werden Tabellenzellen voneinander getrennt \
temp([Aussensensor:temperature])| ## Anzeige des Readings 'temperature' des Gerätes 'Aussensensor' \
temp([TH_Bad_HM:measured-temp],24,"temp_temperature")| ## Schriftgröße 24pt, mit Icon namens temp_temperature\
temp([T_Warmwasserspeicher:temperature:d1],20) ## Schriftgröße 20pt
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:Temp.png|ohne|mini]]

=== Farbskalierte Feuchtigkeitsanzeige mit Hilfe der Funktion '''hum''' ===
Die Farbe der dargestellten Feuchtigkeit ist abhängig vom Feuchtigkeitswert:
[[Datei:Farbskalierung hum.png|350px|ohne]]
{{Randnotiz|RNText=uiTable-Funktion '''hum'''
<syntaxhighlight lang="perl">
hum ($hum,$size,$icon)

$hum # Feuchtigkeit
$size # Schriftgröße in Pixel (pt), optional
$icon # Icon, welches vorangestellt wird, optional
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_uiTable_hum DOIF ##
attr di_uiTable_hum uiTable {\
package ui_Table;;\
$TC{1}="align='center'";; ## zweite Spalte der Tabelle zentriert\
}\
## Tabellendefinition \
\
## Anzeige des Readings 'humidity' des Thermostats 'TH_Bad_HM' \
"Bad"|hum ([TH_Bad_HM:humidity])\
\
## Feuchtigkeit in Größe 10pt mit Temperatur in einer Tabellenzelle\
"Aussen"|temp ([Aussensensor:temperature]),hum ([Aussensensor:humidity],10)\
\
## Feuchtigkeit in Größe 26pt mit Icon namens 'temperature_humidity'\
"Keller"|hum ([TH_Keller_HM:humidity],26,"temperature_humidity")
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable Funktion hum.png|ohne|mini]]

=== Textformatierungen mit Hilfe der Funktion '''style''' ===
Texte werden in Farbe, Größe und Schriftart statisch oder dynamisch formatiert.
{{Randnotiz|RNText=uiTable-Funktion '''style'''
<syntaxhighlight lang="perl">
style ($text,$color,$font_size,$font_weight)

$text # anzuzeigender Text
$color # CSS color, optional
$font_size # Schriftgröße in Pixel (pt), optional
$font_weight # CSS Schriftart, optional
</syntaxhighlight>
Mögliche Werte für '''''color''''' und '''''font_weight''''' können in einschlägiger Dokumentation zu CSS nachgeschlagen werden
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_uiTable_style DOIF ##
attr di_uiTable_style uiTable {\
package ui_Table;;\
}\
## Tabellendefinition\
\
## statische Farbgebung, Größe, Schriftart \
style("Montag","orange")\
style("Dienstag","red",14)\
style("Mittwoch","#00FFFF",20)\
style("Donnerstag","blue",23,"bold")\
\
## dynamische Farbgebung abhängig vom Zustand des Gerätes 'Alarm'\
style("Alarm",([Alarm:state] eq "on" ? "red":"green"))\
\
## dynamische Farbgebung des Zustands des Gerätes 'Alarm'\
style([Alarm:state],([Alarm:state] eq "on" ? "red":"green"))\
\
## variabler Text abhängig vom Zustand des Gerätes 'Alarm'\
style(([Alarm:state] eq "on" ? "Alarm aktiv":"Alarm deaktiviert"),"red")
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:Style.png|ohne|mini]]

=== Icon-Darstellung mit Hilfe der Funktion '''ICON''' ===
Mit Hilfe der Funktion '''ICON''' kann ein FHEM-Icon dargestellt werden
{{Randnotiz|RNText=uiTable-Funktion '''ICON'''
<syntaxhighlight lang="perl">
ICON ($icon)

$icon # Icon mit Farbgebung
</syntaxhighlight>

'''ICON''' benutzt die Funktion [https://wiki.fhem.de/wiki/DevelopmentFHEMWEB-API#FW_makeImage FW_makeImage]

'''nützliche Links'''
*[https://wiki.fhem.de/wiki/DOIF/uiTable_Schnelleinstieg#hsv-Funktion_f.C3.BCr_Farbskalierungen hsv-Funktion]
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_Table_ICON DOIF ##
attr di_Table_ICON uiTable {\
package ui_Table;;\
}\
## Tabellendefinition\
ICON("temp_frost") | ## Icon ohne Einfärbung\
ICON("temp_frost\@blue") | ## Icon in CSS-Farbe blau\
ICON("temp_frost\@#8A2BE2") | ## Icon in CSS-Farbe #8A2BE2\
ICON("temp_frost\@".([Aussensensor:temperature] > 0 ? "orange":"blue"))| ## Icon in CSS-Farbe orange über Null Grad, sonst in CSS-Farbe blau\
ICON("temp_frost\@".hsv ([Aussensensor:temperature],-20,40,320,0)) ## Icon in Farbskalierung von violett (-20 °C) bis rot (40 °C) mit Hilfe der Funktion hsv
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable_IC.png|mini|ohne]]

=== Icon-Darstellung mit Text mit Hilfe der Funktion '''icon_label''' ===
Mit Hilfe der Funktion '''icon_label''' kann ein FHEM-Icon mit einem angehängten Text/Wert dargestellt werden.
{{Randnotiz|RNText=uiTable-Funktion '''icon_label'''
<syntaxhighlight lang="perl">
icon_label ($icon,$text,$color,$color_bg,$pos_left,$pos_top)
$icon # FHEM-Icon mit Farboption
$text # dargestellter Text
$color # Farbe des Textes, optional
$color # Hintergrundfarbe des Textes, optional
$pos_left # horizontale Position des Textes in px, default -5, optional
$pos_top # vertikale Position des Textes in px, default -8, optional
</syntaxhighlight>

'''Anwendungsbeispiele'''
* [https://wiki.fhem.de/wiki/DOIF/uiTable_Schnelleinstieg#Anzahl_der_Tage_bis_zur_Abfall-Entsorgung Abfall]
* [https://wiki.fhem.de/wiki/DOIF/uiTable_Schnelleinstieg#Visualisierung:_aktueller_Spritpreis Sprit]
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_uiTable_icon_label DOIF ##
attr di_uiTable_icon_label uiTable { package ui_Table;;\
}\
\
icon_label("fuel",[Tankstelle:Diesel])|\
icon_label("fuel",[Tankstelle:Diesel],"red")|\
icon_label("fuel\@blue",[Tankstelle:Diesel],"blue","#999999")|\
icon_label("fuel\@red",[Tankstelle:Diesel],"red","white",-10)|\
icon_label("fuel",[Tankstelle:Diesel],"white","red",-5,8)\

</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable_icon_label.png|mini|ohne]]

=== Visualisierung eines Gerätes mit Hilfe der Funktion '''icon''' ===
Der Zustand eines Gerätes/Readings wird mit Hilfe eines Icons dargestellt.
{{Randnotiz|RNText=uiTable-Funktion '''icon'''
<syntaxhighlight lang="perl">
icon ($value,$icon_off,$icon_on,$state_off,$state_on)

$value # Wert
$icon_off # Icon für den Wert off, default "off"
$icon_on # Icon für den Wert on, default Icon für Wert 'off' in Farbe 'DarkOrange', sonst Icon 'on', wenn $icon_off nicht definiert ist
$state_off # Wert zugehörig zum Icon off, default "off"
$state_on # Wert zugehörig zum Icon on, default "on"
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_uiTable_icon DOIF ##
attr di_uiTable_icon uiTable {\
package ui_Table;;\
}\
## Tabellendefinition\
\
## Standard-Icon off/on für Standardwert off/on \
"Lampe"|icon([Lampe:state]) ## entspricht icon([Lampe:state],"off","on","off","on")\
\
## Icon für Zustand 'off' ist 'hue_room_hallway', für Zustand 'on' 'hue_room_hallway\@DarkOrange'\
"Flur"|icon([Lampeflur:state],"hue_room_hallway") ## entspricht icon([Lampeflur:state],"hue_room_hallway","hue_room_hallway\DarkOrange","off","on")\
\
## Icon für Zustand 'off' ist 'status_away_2', für Zustand 'on' 'status_available\@DarkOrange'\
"Anwesenheit"|icon([Anwesenheit:state],"status_away_2","status_available\@DarkOrange") \
\
## Icon für Zustand 'closed' ist "status_locked", für Zustand 'open' 'status_open\@DarkOrange'\
"Haus"|icon([Schloss:state],"status_locked","status_open\@DarkOrange","closed","open")
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable icon.png|mini|ohne]]

=== Schaltbares Icon mit Hilfe der Funktion '''switch''' ===
Der Zustand eines Gerätes/Readings wird mit Hilfe eines Icons dargestellt, er kann über die WEB-Oberfläche durch Anklicken geschaltet werden. Damit der Zustand des Gerätes geschaltet werden kann, muss das Gerät den set-Befehl unterstützen.

{{Randnotiz|RNText=uiTable-Funktion '''switch'''
<syntaxhighlight lang="perl">
switch ($value,$icon_off,$icon_on,$state_off,$state_on)

$value # [<device>:<reading>]
$icon_off # Icon für den Wert off, default "off"
$icon_on # Icon für den Wert on, default Icon für Wert 'off' in Farbe 'DarkOrange', sonst Icon 'on', wenn $icon_off nicht definiert ist
$state_off # Wert zugehörig zum Icon off, default "off"
$state_on # Wert zugehörig zum Icon on, default "on"
</syntaxhighlight>
}}

'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_uiTable_switch DOIF ##
attr di_uiTable_switch uiTable {\
package ui_Table;;\
}\
## schaltbares Icons in der Webansicht \
switch([Lampe:state]) | \
switch([Lampeflur:state],"hue_room_hallway") |\
switch([Anwesenheit:state],"status_away_2","status_available\@DarkOrange")|\
switch([Haus:state],"status_locked","status_open\@DarkOrange","closed","open")\
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable switch.png|mini|ohne]]

=== Rollladen: Visualisierung und Steuerung mit Hilfe der Funktion '''shutter''' ===
Die aktuelle Position des Rollladens (0 % - 100 %) wird über Icons visualisiert. Das Anklicken eines Symbols steuert den Rollladen auf die entsprechende Position. Prozentwerte zwischen zwei Icon-Werten werden dem nächsthöheren Icon-Wert zugeordnet.
{{Randnotiz|RNText=uiTable-Funktion '''shutter'''
<syntaxhighlight lang="perl">
shutter ($value,$color,$type)

$value # [<device>:<reading>]
$color # Farbe der aktuellen Rollladenposition, vorangestelltes @ verändert die Farbe des Icons, ohne @ wird der Hintergrund des Icons eingefärbt, default ist @DarkOrange
$type # optional, Anzahl der Symbole 2 bis 6, 3 ist default
</syntaxhighlight>

*[https://wiki.fhem.de/wiki/DOIF/uiTable_Schnelleinstieg#Visualisierung_und_Steuerung_von_Rolll.C3.A4den Anwendungsbeispiel]
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod ui_Table_shutter DOIF ##
attr ui_Table_shutter uiTable {\
package ui_Table;;\
}\
shutter([R_Keller:pct],"\@yellow",2) ## zwei Symbole für 0 % und 100 %\
shutter([R_Wohnzimmer_S:pct]) ## entspricht shutter ([R_Wohnzimmer_S:pct],"\@DarkOrange",3) \
shutter([R_Wohnzimmer_W1:pct],"blue",4) ## vier Symbole \
shutter([R_Wohnzimmer_W2:pct],"\@red",5) ## fünf Symbole\
shutter([R_Wohnzimmer_W3:pct],"red",6 ## sechs Symbole)
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable shutter.png|mini|ohne]]

=== Helligkeit: Visualisierung und Steuerung mit Hilfe der Funktion '''dimmer''' ===
Die aktuelle Helligkeit (0 % - 100 %) wird über Icons visualisiert. Das Anklicken eines Icons bestimmt die Helligkeit der Leuchte. Prozentwerte zwischen zwei Icon-Werten werden dem nächsthöheren Icon-Wert zugeordnet.
{{Randnotiz|RNText=uiTable-Funktion '''dimmer'''
<syntaxhighlight lang="perl">
dimmer ($value,$color,$type)

$value # [<device>:<reading>]
$color # Farbe der aktuellen Helligkeit, vorangestelltes @ verändert die Farbe des Icons, ohne @ wird der Hintergrund des Icons eingefärbt, default ist @DarkOrange
$type # Anzahl der Symbole 2 bis 7, 3 ist default
</syntaxhighlight>
}}

'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_uiTable_dimmer DOIF ##
attr di_uiTable_dimmer uiTable {\
package ui_Table;;\
}\
dimmer([Strauch3:pct],"\@yellow",2)\
dimmer([Strauch3:pct]) ## entspricht dimmer([Strauch3:pct],"\@DarkOrange",3) \
dimmer([Strauch3:pct],"blue",4)\
dimmer([Strauch3:pct],"\@red",5)\
dimmer([Strauch3:pct],"red",6)\
dimmer([Strauch3:pct],"DarkOrange",7)

</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable dimmer.png|mini|ohne]]

=== Vorgabetemperatur eines Thermostats mit Hilfe der Funktion '''temp_knob''' ===
Die aktuelle Vorgabetemperatur eines Thermostats wird über ein Icons visualisiert. Durch Anklicken des Ringes wird die Vorgabetemperatur verändert.
{{Randnotiz|RNText=uiTable-Funktion '''temp_knob'''
<syntaxhighlight lang="perl">
temp_knob ($value,$color,$set)

$value # [<device>:<reading>]
$color # Farbe der voreingestellten Temperatur, default "Darkorange"
$set # set-Befehl, default "set", sonst muss "set <Readingname>" angegeben werden, falls sich das Reading vom set-Befehl vom angezeigten Reading unterscheidet, wie beim THRESHOLD-Modul
</syntaxhighlight>
}}

'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod ui_Table_temp_knob DOIF ##
attr ui_Table_temp_knob uiTable {\
package ui_Table;;\
}\
\
## HM-EU-Thermostat, angezeigt wird das Reading "desired-temp", geschaltet wird über "set desired-temp" \
"Dachgeschoss"|temp_knob([TH_DG_HM:desired-temp]) ## entspricht temp_knob([TH_DG_HM:desired-temp],"Darkorange","set") \
\
## HM-EU-Thermostat Temperaturanzeige in gelb \
"Wohnzimmer"|temp_knob([TH_WZ_HM:desired-temp],"yellow") \
\
## Beim THRESHOLD-Modul wird das Reading "desired_value" angezeigt, geändert wird die Temperatur per "set desired" \
"Küche"|temp_knob([TH_Kueche:desired_value],"red","set desired")
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable temp knob.png|mini|ohne]]

== uiTable-'''Templates''' ==
Die Definition einer oder mehrere Zellen kann zu einem Template zusammengefasst werden. Durch die Nutzung von Templates kann die Definition einer Tabelle erheblich vereinfacht werden. Insb. bei gleichartigen Zellen/Zeilen für verschiedene Geräte/Readings braucht eine aufwendige Definition nicht immer wieder wiederholt werden, sondern kann jeweils mit dem Aufruf eines zuvor definierten Templates realisiert werden.
{{Randnotiz|RNText='''Templates'''
* Die Definition von Templates muss vor der Tabellendefinition vorgenommen werden
* Eine Template-Definition beginnt mit dem Schlüsselwort '''DEF'''
* Der Template-Name muss mit '''TPL_''' beginnen
* '''Template-Definition'''-Syntax
<syntaxhighlight lang="perl">
DEF TPL_<Template-Name>(<Zellendefinition mit Platzhaltern: $1,$2,...>)
</syntaxhighlight>
* Templates-Definitionen können in externe Dateien ausgelagert werden
* Templates-Definitionen können per IMPORT-Befehl aus externen Dateien importiert werden
* '''Template-Import'''-Syntax
<syntaxhighlight lang="perl">
IMPORT <Pfad mit Dateinamen>
</syntaxhighlight>
* Innerhalb einer Tabellendefinition können zuvor definierte oder importierte Templates mehrfach genutzt werden
* '''Template-Aufruf'''-Syntax
<syntaxhighlight lang="perl">
TPL_<Template-Name>(<Übergabeparameter für $1>,<Übergabeparameter für $2>,...)
</syntaxhighlight>
}}
'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod ui_Table_Template DOIF ##
attr ui_Table_Template uiTable {\
package ui_Table;;\
$TC{1..3}="align='center'";; ## Spalten 1 bis 3 werden zentriert\
}\
\
## Template-Definitionen beginnen vor der Tabellendefinition\
\
## Das Template TPL_raum stellt eine Tabellenzeile dar, die mit Hilfe von uiTable-Funktionen mehrere Tabellenzellen definiert\
DEF TPL_raum ("$1" | temp([TH_$2_HM:measured-temp]),hum([TH_$2_HM:humidity]) | switch([H_$2:state],"fa_off") | temp_knob([TH_$2_HM:desired-temp]))\
\
## Tabellendefinition\
\
## pro Tabellenzeile wird ein Raum mit Hilfe des oben definierten Templates "TPL_raum" dargestellt\
"Raum"|"Temp./Feuchte"|"Ventil"|"Vorgabetemp."\
TPL_raum (Dachgeschoss,DG) ## der Übergabeparameter "Dachgeschoss" wird im Template "TPL_raum" anstelle von $1 eingesetzt, "DG" wird anstelle von $2 eingesetzt\
TPL_raum (Bad,Bad)\
TPL_raum (Kinderzimmer ost,Kz_o)\
TPL_raum (Kinderzimmer west,Kz_w)\
TPL_raum (Wohnzimmer,WZ)\
TPL_raum (Keller,Keller)

</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable Templates.png|mini|ohne]]

== Eigene uiTable-Funktionen programmieren ==
Für die eigenen Bedürfnisse können eigene uiTable-Funktionen programmiert werden. In der Datei [https://svn.fhem.de/trac/browser/trunk/fhem/contrib/DOIF/uiTable.tpl contrib/DOIF/uiTable.tpl] befinden sich alle intern definierten uiTable-Funktion aus dem package ui_Table als Kopie. Diese Funktionen können als Inspiration für eigene Entwicklung dienen.
{{Randnotiz|RNText='''uiTable-Funktionen'''
* Es gibt drei Arten von uiTable-Funktionen, sie werden intern anhand der Rückgabewerte unterschieden
* uiTable-Funktionen vom Typ 1: '''HTML''', ein Rückgabewert
<syntaxhighlight lang="perl">
return(<HTML-code>)
</syntaxhighlight>
* uiTable-Funktionen vom Typ 2: '''Style''' (entspricht der '''STY'''-Funktion), zwei Rückgabewerte
<syntaxhighlight lang="perl">
return(<value>,<CSS-style>)
</syntaxhighlight>
* uiTable-Funktionen vom Typ 3: '''Widget''' (entspricht der '''WID'''-Funktion), vier Rückgabewerte
<syntaxhighlight lang="perl">
return (<value>,<>,<FHEM-widget>,<set-command: "set" or "set <Readingname>">)
</syntaxhighlight>
* uiTable-Funktionen sind reine Perlfunktionen
* uiTable-Funktionen sollten im eigenen Package definiert werden, sonst könnten bestehende Perlfunktionen im System überschrieben werden
* uiTable-Funktionen können in Template-Dateien ausgelagert werden und über IMPORT-Befehl importiert werden, siehe Templates
}}

'''<big>Beispieldefinition</big>'''
<syntaxhighlight lang="perl">
defmod di_uiTable_function DOIF ##
attr di_uiTable_function uiTable {\
package my_uiTable;; ## eigenes Package mit selbstdefinierten Funktionen\
\
## uiTable-Funktion vom Typ "HTML", Rückgabewert: (HTML-code)\
\
sub clock { ## Anzeige aktueller Uhrzeit mit Datum\
## Voraussetzung: contrib/DOIF/doifclock.js muss ins www/pgm2-Verzeichnis kopiert werden\
## Attribut setzen in der Webinstanz: attr <WEB-Instanz> JavaScripts pgm2/doifclock.js \
my ($color,$size)=@_;;\
$color="darkorange" if (!defined ($color));; ## $color ist optional, default Darkorange\
$size="20" if (!defined ($size));; ## $size ist optional, default 20pt\
return("<div class='doifclock'style='font-weight:bold;;font-size:".$size."pt;;color:".$color.";;'>error</div>")\
}\
\
## uiTable-Funktion vom Typ Style, Rückgabewerte (Wert,CSS-style)\
\
sub red_green { ## Farbige Skalierung von Zahlen mit Hilfe der DOIF_hsv-Funktion: von 0 - rot bis 10 - grün\
my ($value)=@_;;\
return ($value." KW", ## Wert/Text\
"font-weight:bold;;color:".::DOIF_hsv ($value,0,10,0,120,70,100) ## CSS-Style\
);;\
} \
\
## uiTable-Funktion vom Typ Widget, Rückgabewerte (Wert,Leer,FHEM-Widget,set-Befehl)\
\
sub slider { ## FHEM-Widget Slider, weitere FHEM-Widgets siehe: https://wiki.fhem.de/wiki/FHEMWEB/Widgets\
my ($value,$set)=@_;;\
$set="set" if (!defined $set);;\
return ($value, ## Zahlenwert\
"", ## leer\
"slider,0,0.5,100,1", ## FHEM-Widget\
$set ## set-Befehl des FHEM-Widgets\
) \
}\
\
}\
\
## Tabellendefinition\
\
"Uhrzeit/Datum"\
clock("yellow",30) ## obige Funktion clock\
"Dimmer"\
slider([Wohnzimmer:pct]) ## obige Funktion slider\
"Leistung"\
red_green([Leistung:state]) ## obige Funktion red_green
</syntaxhighlight>

''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable-functions.png|mini|ohne]]

== Package-Konzept, Auslagerung eigener Funktionen, der '''IMPORT'''-Befehl==
uiTable arbeitet mit Packages. In einem Package sind definierte Funktionen gekapselt, sie kollidieren nicht mit bereits definierten Funktionen in FHEM.
{{Randnotiz|RNText='''Package'''
* das für die Definition der Tabelle gültige Package wird im Perlblock des uiTable-Attributes angegeben
* interne uiTable-Funktionen befinden sich im Package '''ui_Table'''
* ohne eine Angabe eines Package befindet man sich im Package '''main'''
* Funktionen außerhalb des gültigen Package müssen mit <package-Name>::<Funktion> angegeben werden
* externe uiTable-Funktionen können per IMPORT-Befehl importiert werden
}}
=== Tabellendefinition im Package main ===
<syntaxhighlight lang="perl">
defmod beispiel1 DOIF ##
attr beispiel1 uiTable ## keine Package-Definition im Perlblock\
\
## Tabellendefinition befindet sich im Package main\
\
## Funktionen aus dem main-Package können unmittelbar angegeben werden\
FW_makeImage("scene_day")\
\
## Funktionen aus dem ui_Table-Package müssen mit vorangestelltem Package angegeben werden\
ui_Table::temp ([Aussensensor:tempaerature])
</syntaxhighlight>

=== Tabellendefinition im Package ui_Table ===

<syntaxhighlight lang="perl">
defmod beispiel2 DOIF ##
attr beispiel2 uiTable {\
package ui_Table; ## Package-Angabe im Perlblock\
}\
\
## Tabellendefinition befindet sich im Package ui_Table\
\
## Funktionen aus dem main-Package müssen mit vorangestelltem package angegeben werden, der Name main kann weggelassen werden\
::FW_makeImage("scene_day")\
\
## Funktionen aus dem ui_Table-Package können direkt angegeben werden\
temp ([Aussensensor:temperature])
</syntaxhighlight>

=== Eigene uiTable-Funktionen im eigenen Package ===
Diese Art der Definition bietet sich dann an, wenn man eine eigene uiTable-Funktion nur in einem DOIF nutzen möchte.
<syntaxhighlight lang="perl">
defmod beispiel3 DOIF ##
attr beispiel3 uiTable {\
package $SELF;; ## Package-Name ist der Name des DOIF-Moduls, dadurch ist der Package-Name eindeutig\
sub scene_day { ## eigene Funktion befindet sich im eigenen Package beispiel3\
return (::FW_makeImage("scene_day"));;\
}\
}\
## Tabellendefinition befindet sich im Package beispiel3\
\
## Funktionen aus dem main-Package müssen mit vorangestelltem Package angegeben werden (der Name main kann weggelassen werden)\
::FW_makeImage("scene_day")\
\
## interne Funktionen aus dem ui_Table-Package müssen mit vorangestelltem Package ui_Table angegeben werden\
ui_Table::temp ([Aussensensor:temperature])\
\
## eigene Funktionen können direkt angegeben werden\
scene_day()
</syntaxhighlight>

=== Eigene ausgelagerte uiTable-Funktionen ===
Möchte man das ui_Table-Package um eigene Funktionen erweitern, die man in verschiedenen DOIFs nutzen möchte, so sollte man diese in eine eigene Datei auslagern, die man mit dem IMPORT-Befehl vor der Definition der Tabelle importieren kann.

Ausgelagerte Funktion in einer eigenen Datei z. B. my_uiTable.tpl:

<syntaxhighlight lang="perl">
{ ## Inhalt der Datei my_uiTable.tpl
package ui_Table; ## das aktuelle Package ist ui_Table
sub scene_day { ## eigene Funktion wird zum Package ui_Table hinzugefügt
return (::FW_makeImage("scene_day"));
}
## die Datei kann alle Funktionen beinhalten, die man in diversen DOIFs nutzen möchte
}
</syntaxhighlight>

<syntaxhighlight lang="perl">
defmod beispiel4 DOIF ##
attr beispiel4 uiTable ##\
\
IMPORT ./contrib/DOIF/my_uiTable.tpl ## nach dem Import befindet man sich in Package ui_Table erweitert um eigene Funktionen\
\
## Tabellendefinition befindet sich im Package ui_Table\
\
## Funktionen aus dem main-Package müssen mit vorangestelltem Package angegeben werden (der Name main kann weggelassen werden)\
::FW_makeImage("scene_day")\
\
## interne uiTable-Funktionen aus dem ui_Table-Package können direkt angegeben werden\
temp ([Aussensensor:temperature])\
\
## eigene Funktionen können direkt angegeben werden, da man sich bereits im Package uiTable befinden\
scene_day()\
</syntaxhighlight>

== '''hsv'''-Funktion für Farbskalierungen==
Mit Hilfe der hsv-Funktion können Texte, Werte oder Icons abhängig vom Wert eingefärbt werden. Es wird durch Vorgabe von Farbsättigung (saturation) und Helligkeit (lightness), linear ein Farbton für einen bestimmten Wert errechnet. Den Farbwert HUE (0 - 360) für den kleinsten sowie größten Wert kann man mit Hilfe eines Color-Pickers bestimmen. Der Rückgabewert ist ein Farbwert in der CSS-Notation.
{{Randnotiz|RNText='''hsv-Funktion für Farbskalierungen'''
<syntaxhighlight lang="perl">
hsv ($value,$min_value,$max_value,$min_hue,$max_hue,$saturation,$lightness)
$value # Wert, Reading
$min_value # der kleinste Wert, dieser entspricht dem Farbwert $min_hue
$max_value # der größte Wert, dieser entspricht dem Farbwert $max_hue
$min_hue # Farbwert für den kleinsten Wert $min_value
$max_hue # Farbwert für den größten Wert $max_value
$saturation # Farbsättigung, default 100, optional
$lightness # Farbhelligkeit, default 100, optional
</syntaxhighlight>
Die Funktion befindet sich im ui_Table-Package
}}

'''<big>Beispieldefinition</big>'''

<syntaxhighlight lang="perl">
defmod di_uiTable_hsv DOIF ##
attr di_uiTable_hsv uiTable {\
package ui_Table;;\
## eigene uiTable-Funktionen vom Typ 1 mit einem Rückgabewert als HTML-Code\
\
sub bat_icon { ## färbt das Icon 'measure_battery_100' abhängig vom Wert mit Hilfe der Funktion hsv \
my ($value)=@_;;\
return(ICON("measure_battery_100\@".hsv($value,0,100,0,120,100,100)))\
}\
\
sub bat_icon2 {## zusätzlich zum Farbwert wird ein entsprechendes Icon bestimmt\
my($val)=@_;;\
my $icon;;\
if ($val==0) {\
$icon="measure_battery_0";;\
} elsif ($val<=25) {\
$icon="measure_battery_25";;\
} elsif ($val<=50) {\
$icon="measure_battery_50";;\
} elsif ($val<=75) {\
$icon="measure_battery_75";;\
} else {\
$icon="measure_battery_100";;\
}\
\
my $output=ICON("$icon\@".hsv ($val,0,100,0,120,90,100));;\
return($output);;\
}\
}\
\
## Tabellendefinition\
\
## eingefärbtes Icon 0 % entspricht rot (HSV-Wert 0), 100 % entspricht grün (HSV-Wert 120) mit Direktangabe\
1|ICON("measure_battery_100\@".hsv([bat:level],0,100,0,120,100,100))\
\
## gleiche Funktionalität mit Hilfe der oben definierten Funktion bat_icon \
2|bat_icon([bat:level])\
\
## Icon mit Hilfe der oben definierten Funktion bat_icon2\
3|bat_icon2([bat:level])\
\
## Beispiel für die Farbskaliereung von 0 bis 100 % mit der obigen Funktion bat_icon\
4|bat_icon(0)|bat_icon(10)|bat_icon(20)|bat_icon(30)|bat_icon(40)|bat_icon(50)|bat_icon(60)|bat_icon(70)|bat_icon(80)|bat_icon(90)|bat_icon(100)\
\
## Beispiel für die Farbskaliereung von 0 bis 100 % mit der obigen Funktion bat_icon2\
5|bat_icon2(0)|bat_icon2(10)|bat_icon2(20)|bat_icon2(30)|bat_icon2(40)|bat_icon2(50)|bat_icon2(60)|bat_icon2(70)|bat_icon2(80)|bat_icon2(90)|bat_icon2(100)
</syntaxhighlight>

''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable DOIF hsv.png|mini|ohne]]

== Eine for-Schleife mit Hilfe des '''FOR'''-Befehls ==
Mit Hilfe des '''FOR'''-Befehls können über eine Schleife aus einer Liste mit Elementen mehrere Tabellenzellen definiert werden. Die Elementenliste (Array) kann über eine Funktion bestimmt werden. Auf diese Weise kann z. B. eine Tabelle für mehrere Geräte einfach definiert werden.
{{Randnotiz|RNText='''FOR-Befehl'''
* Der FOR-Befehl entspricht einer foreach-Schleife in Perl
* Syntax: '''FOR (<Array>,<Zellendefinitionen>)''' '''<Array>''' eine gültige Angabe eines Arrays oder eine Perlfunktion, die ein Array liefert '''<Zellendefinitionen>''' Definition einer oder mehrerer Zellen, die Angabe $_ wird durch das jeweilige Element des Arrays ersetzt
*'''nützliche Links''' [http://fhem.de/commandref_DE.html#DOIF_aggregation DOIF Aggregationsfunktionen mit Perlfunktion AggrDoIf] [https://wiki.fhem.de/wiki/DevelopmentModuleAPI#devspec2array devspec2array]
}}
'''<big>Beispieldefinitionen</big>'''
<syntaxhighlight lang="perl">
defmod di_for DOIF ##
attr di_for uiTable \
## Temperaturen aller Geräte, die mit 'T' beginnen und ein Reading 'temperature' haben, sollen in einer Tabelle visualisiert werden\
FOR(::AggrDoIf('@','^T_','temperature'),"$_"|temp([$_:temperature:d2]))
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable-FOR-temperature.png|200px|ohne]]

<syntaxhighlight lang="perl">
defmod di_for DOIF ##
attr di_for uiTable \
## Anzeige des Batteriestatus aller Geräte, bei denen das Wort 'Fenster' vorkommt, die das Readings 'battery' haben\
FOR(::AggrDoIf('@','Fenster','battery'),"$_"|bat([$_:battery]))
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable-FOR-battery.png|200px|ohne]]

<syntaxhighlight lang="perl">
defmod di_for DOIF ##
attr di_for uiTable \
## Anzeige des Status aller Geräte im System vom Typ 'HMS'\
FOR(::devspec2array("TYPE=HMS"),"$_"|[$_])
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable-FOR-HMS.png|300px|ohne]]

<syntaxhighlight lang="perl">
defmod di_for DOIF ##
attr di_for uiTable \
## Elemente einer kommagetrennten Liste sollen jeweils in einer Tabellenzelle in einer Tabellenzeile angezeigt werden\
FOR(split(",","Mo,Di,Mi,Do,Fr,Sa,So"),ui_Table::style("$_","Darkorange")|)
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable-FOR-split.png|300px|ohne]]

<syntaxhighlight lang="perl">
defmod di_for DOIF ##
attr di_for uiTable \
## Durch Leerzeichen getrennte Zeichenketten sollen jeweils in einer Tabellenzelle in einer Tabellenzeile angezeigt werden\
FOR(qw/Montag Dienstag Mittwoch Donnerstag Freitag/,"$_"|)
</syntaxhighlight>
''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable-FOR-qw.png|300px|ohne]]

<syntaxhighlight lang="perl">
defmod di_for DOIF ##
attr di_for uiTable \
## das Templates TPL_raum, soll vier mal aufgerufen werden: TPL_raum(1), TPL_raum(2)...\
## das Templates TPL_raum muss vorher definiert worden sein\
FOR(1..4,TPL_raum($_))
</syntaxhighlight>

''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable-FOR TPL raum.png|600px|ohne]]

== '''Anwendungsbeispiele''' ==

=== '' Visualisierung und Steuerung von '''Rollläden''''' ===
Im folgenden Beispiel werden Rollläden morgens hochgefahren, ebenso wird die Position aller Rollläden visualisiert. Durch Anklicken eines Icons wird der Rollladen auf die entsprechende Position bewegt.
{{Randnotiz|RNText='''nützliche Links'''
* [https://fhem.de/commandref_DE.html#DOIF_Zeitsteuerung_mit_Zeitintervallen Zeitsteuerung]
* uiTable-Funktion [https://wiki.fhem.de/wiki/DOIF/uiTable_Schnelleinstieg#Rollladen:_Visualisierung_und_Steuerung_mit_Hilfe_der_Funktion_shutter shutter]
* uiTable-Funktion [https://wiki.fhem.de/wiki/DOIF/uiTable_Schnelleinstieg#Textformatierungen_mit_Hilfe_der_Funktion_style style]
* [https://wiki.fhem.de/wiki/DOIF/uiTable_Schnelleinstieg#uiTable-Templates Templates]
}}
<syntaxhighlight lang="perl">
defmod DI_Rollladen DOIF (([Dunkelheit] eq "off" and [06:25-09:00|8]) or [09:00|7]) \
((set R_W_S,R_W_W[1-3] on)) ## Hochfahren der Rollläden im Erdgeschoss morgens\
DOELSEIF ([Dunkelheit] eq "on")
attr DI_Rollladen cmdState oben|unten
attr DI_Rollladen devStateIcon unten:status_night oben:scene_day
attr DI_Rollladen icon fts_shutter_automatic
attr DI_Rollladen uiTable {\
package ui_Table;;\
}\
\
## Template für ein Fenster\
DEF TPL_shutter("$1"|shutter([$1:pct]))\
\
## Tabellendefinition\
\
style("Dachgeschoss","Darkorange")|""\
TPL_shutter(R_Dachboden)\
style("erstes Geschoss","Darkorange")|""\
TPL_shutter(R_Bad)\
TPL_shutter(R_Kinderzimmer1_O)\
TPL_shutter(R_Kinderzimmer1_S)\
TPL_shutter(R_Kinderzimmer2_S)\
TPL_shutter(R_Kinderzimmer2_W1)\
TPL_shutter(R_Kinderzimmer2_W2)\
style("Erdgeschoss","Darkorange")|""\
TPL_shutter(R_Kueche)\
TPL_shutter(R_W_S)\
TPL_shutter(R_W_W1)\
TPL_shutter(R_W_W2)\
TPL_shutter(R_W_W3)\
style("Keller","Darkorange")|""\
TPL_shutter(R_Keller)\
</syntaxhighlight>
''Ergebnis des Anwendungsbeispiels in der Webansicht:''
[[Datei:UiTable Rollladen.png|mini|ohne]]

=== ''Anzahl der Tage bis zur '''Abfall-Entsorgung''''' ===
Mit Hilfe des Kalender-Moduls werden die verbleibenden Tage bis zur Abfall-Entsorgung der jeweiligen Tonne berechnet und mit Hilfe von uiTable visualisiert. Wenn der Tag der Entsorgung bevorsteht, wird er farbig gekennzeichnet. Vorausgesetzt wird die Definition des Kalenders namens 'cal' mit Hilfe des Moduls [https://wiki.fhem.de/wiki/Calendar calendar]. Dieser muss die Termine der Abfallentsorgung der Tonnen beinhalten. Im Beispiel wird nach Stichwörtern: "Altpapier", "Restmüll", "Bio", "Gelber" und "Grünschnitt" im Kalender gesucht.
{{Randnotiz|RNText='''nützliche Links'''
* FHEM-Modul [https://wiki.fhem.de/wiki/Calendar calendar]
* ui_Table Funktion [https://wiki.fhem.de/wiki/DOIF/uiTable_Schnelleinstieg#Icon-Darstellung_mit_Text_mit_Hilfe_der_Funktion_icon_label icon_label]
}}
<syntaxhighlight lang="perl">
defmod Abfall DOIF subs {\
## Die Funktion 'days' sucht nach dem Ereignis $event im Kalender und berechnet die Anzahl der verbleibenden Tage und legt sie im entsprechendem Reading $reading des DOIF-Moduls ab\
sub days \
{\
my ($event,$reading)=@_;;\
set_Reading($reading,fhem('get cal events timeFormat:"%j" filter:field(summary)=~"'.$event.'" limit:count=1,from=0 format:custom="$T1"')-::strftime ('%j', localtime()),1)\
}\
## Die Funktion 'update' bestimmt die verbleibenden Tage mit Hilfe der obigen Funktion 'days' für die jeweiligen Tonnen\
sub update\
{\
days("Altpapier","altpapier");;days("Restmüll","restmuell");;days("Bio","bio");;days("Gelber","gelbe_tonne");;days("Grünschnitt","gruenschnitt");;\
}\
}\
## Beim Start, um 02:00 Uhr und 08:00 Uhr wird zeitverzögert die obige Funktion 'update' aufgerufen\
init {[02:00];;[08:00];;set_Exec("Timer",60,'update()');;\
}
attr Abfall uiTable {\
package ui_Table;;\
$TC{0..4}="align='center'";;\
$SHOWNOSTATE=1;;\
\
## die Funktion 'ic' benutzt die Funktion 'icon_label' für die Darstellung des Icons, abhängig von der Anzahl der Tage wird die Anzahl in grün bzw. rot eingefärbt \
sub ic\
{\
my ($icon,$days)=@_;;\
icon_label($icon,$days,"white",$days > 1 ? "green":"red")\
}\
}\
## Tabellendefinition, die einzelnen Tonnen werden mit Hilfe der obigen Funkton 'ic' dargestellt\
\
ic ("Abfalltonne-Recycling-Logo\@yellow",[$SELF:gelbe_tonne])|\
ic ("Abfalltonne-Recycling-Logo\@blue",[$SELF:altpapier])|\
ic ("Abfalltonne\@gray",[$SELF:restmuell])|\
ic ("Abfalltonne-Recycling-Logo\@green",[$SELF:bio])|\
ic ("Gartenabfall\@green",[$SELF:gruenschnitt])
</syntaxhighlight>

''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:Anwendungsbeispiel Abfall.png|mini|ohne]]

=== ''Visualisierung: '''offene Fenster''''' ===
Alle offenen Fenster werden aufgelistet und mit entsprechendem Icon visualisiert.
{{Randnotiz|RNText='''nützliche Links'''
* Attribut [https://fhem.de/commandref_DE.html#DOIF_DOIF_Readings DOIF_Radings]
* DOIF-[https://fhem.de/commandref_DE.html#DOIF_aggregation Aggregationsfunktionen]
* uiTable-Funktion [https://wiki.fhem.de/wiki/DOIF/uiTable_Schnelleinstieg#Icon-Darstellung_mit_Hilfe_der_Funktion_icon icon]
*
}}
<syntaxhighlight lang="perl">
defmod di_uiTable_windows DOIF ## Visualisierung offener Fenster, Fenster-Devices enden mit "Fenster" im Namen
attr di_uiTable_windows DOIF_Readings windows:[@as( )"Fenster$":state:"open","keine"]
attr di_uiTable_windows uiTable {package ui_Table;;}\
icon([$SELF:windows],"fts_window_1w_open\@DarkOrange","fts_window_1w",".*","keine")|[$SELF:windows]
</syntaxhighlight>

''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable windows closed.png|mini|ohne]]
[[Datei:UiTable windows open.png|mini|ohne]]

=== ''Visualisierung: '''aktuelle Wetterlage''''' ===
Regenrader animiert, aktuelle Temperatur und Feuchte vom Sensor, aktuelle Wetterlage sowie Wettervorhersage der nächsten Tage. Über entsprechende Weblinks werden Bilder aus dem WWW in der Tabelle visualisiert. Im Gegensatz zu lokalen Sensoren, muss für die Aktualisierung der WWW-Elemente in der jeweiligen Webinstanz (FHEMWEB) das refresh-Attribut gesetzt werden.
{{Randnotiz|RNText='''nützliche Links'''
* DWD [https://www.dwd.de/DE/Home/home_node.html Homepage]
* Regenradar [https://www.dwd.de/DE/wetter/wetterundklima_vorort/_node.html Radarfilm BRD]
* aktuelles Wetter [https://www.dwd.de/DE/wetter/wetterundklima_vorort/nordrhein-westfalen/nrw_node.html NRW]
* Wetteronline [https://www.wetteronline.de/wetter-widget eignes Widget]
*
}}

<syntaxhighlight lang="perl">
defmod di_uiTable_wetter DOIF ##
attr di_uiTable_wetter uiTable {\
package ui_Table;;\
$TC{1}="align='center'";;\
}\
## das Attribut 'refresh' der Webinstanz für ein Wandtablet wurde auf 900 gesetzt, damit die Bilder alle 15 Minuten aktualisiert werden \
## Tabellendefinition\
\
## Regenradar BRD\
'<img src="https://www.dwd.de/DWD/wetter/radar/radfilm_brd_akt.gif" height="365px" width="365px">'|\
\
## Aktuelle Temperatur und Feuchtigkeit vom lokalen sensor\
temp([Aussensensor:temperature],40),hum ([Aussensensor:humidity],30),\
\
## aktuelle Wetterlage NRW\
"<img src ='https://www.dwd.de/DE/wetter/wetterundklima_vorort/nordrhein-westfalen/_functions/bildgalerie/wetter_aktuell.jpg?view=nasImage&nn=561200' height='255px' width='255px'>"|\
\
## Wettervorhersage\
"<iframe marginheight='0' marginwidth='0' scrolling='no' width='300' height='365' name='FC3' style='border:1px solid;;border-color:#00537f;;' src='https://api.wetteronline.de/wetterwidget?gid=x0677&modeid=FC3&seourl=juelich&locationname=Jülich&lang=de'></iframe>"\
</syntaxhighlight>

''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable wetter.png|600px|links]]
 

=== ''Visualisierung: '''aktueller Spritpreis''''' ===
Der aktuelle Spritpreis einer Tankstelle wird farbig mit einem eingefärben Icon visualisiert.
{{Randnotiz|RNText='''nützliche Links'''
*ui_Table Funktion [https://wiki.fhem.de/wiki/DOIF/uiTable_Schnelleinstieg#Icon-Darstellung_mit_Text_mit_Hilfe_der_Funktion_icon_label icon_label]
*[https://wiki.fhem.de/wiki/DOIF/uiTable_Schnelleinstieg#hsv-Funktion_f.C3.BCr_Farbskalierungen hsv-Funktion]
*[https://www.clever-tanken.de Tankstelle bestimmen]
*[https://wiki.fhem.de/wiki/HTTPMOD HTTPMOD-Modul]
}}

Zunächst wird ein HTTPMOD-Modul für den aktuellen Sprit definiert:
<syntaxhighlight lang="perl">
defmod Tankstelle HTTPMOD http://www.clever-tanken.de/tankstelle_details/22380 300
attr Tankstelle userattr reading01Name reading01Regex reading02Name reading02Regex
attr Tankstelle enableControlSet 1
attr Tankstelle reading01Name Diesel
attr Tankstelle reading01Regex "current-price-1">(\d.\d{2})
attr Tankstelle reading02Name SuperE5
attr Tankstelle reading02Regex "current-price-2">(\d.\d{2})
attr Tankstelle stateFormat Liter_Diesel: Diesel
attr Tankstelle timeout 10
</syntaxhighlight>

DOIF mit der Definition einer uiTable-Funktion namens '''sprit'''. Die Funktion kann ebenso in ein externes Package ausgelagert werden.

<syntaxhighlight lang="perl">
defmod di_uiTable_sprit DOIF ##
attr di_uiTable_sprit uiTable {\
package ui_Table;;\
$SHOWNOSTATE=1;;\
$TC{0..10}="align='center';;";;\
\
## Die Funktion sprit färbt das Tankstellensymbol und den Spritpreis und stellt ihn mit Hilfe der Funktion icon_label dar\
sub sprit {\
my ($value,$min,$max)=@_;;\
$min=1.16 if (!defined $min);; \
$max=1.40 if (!defined $max);; \
return(icon_label ("fuel\@".hsv ($value,$min,$max,120,0),$value,hsv ($value,$min,$max,120,0)));;\
}\
}\
## Tabellendefinition\
"aktueller Spritpreis"\
sprit([Tankstelle:Diesel:d2])\
"Farbdarstellung"\
sprit("1.18")|sprit("1.20")|sprit("1.25")|sprit("1.30")|sprit("1.35")|sprit("1.40")
</syntaxhighlight>

''Ergebnis der Beispieldefinition in der Webansicht:''

[[Datei:Di uiTable sprit.png|ohne|mini]]

=== ''Visualisierung: '''Anwesenheitsstatus''''' ===
Die aktuelle Anwesenheit von Heimbewohnern wird visualisiert. 
Zunächst wird mit Hilfe des Moduls [https://wiki.fhem.de/wiki/FRITZBOX FritzBox] ein Device namens ''FritzBox'' erstellt. Dort werden die eingebuchten Smartphones der Bewohner mit Ihren MAC-Adressen in Readings abgelegt. Die folgende Definition wertet aus, ob die angegebenen MAC-Adressen als Readings vorhanden sind und erstellt für jeden Bewohner ein Reading mit den Zuständen on/off. Diese Readings werden dann über das Attribut uiTable visualisiert. Die anwesenden Personen werden farblich markiert. Die Namen der Personen sowie die MAC-Adressen sind fiktiv und müssen den eigenen Angaben entsprechend angepasst werden.
{{Randnotiz|RNText='''nützliche Links'''
*[https://wiki.fhem.de/wiki/FRITZBOX FritzBox-Modul]
*ui_Table Funktion [https://wiki.fhem.de/wiki/DOIF/uiTable_Schnelleinstieg#Icon-Darstellung_mit_Text_mit_Hilfe_der_Funktion_icon_label icon_label]
*[https://wiki.fhem.de/wiki/DOIF/uiTable_Schnelleinstieg#uiTable-Templates uiTable-Templates]
}}

<syntaxhighlight lang="perl">
defmod myHome DOIF {\
set_Reading_Begin;;\
set_Reading_Update("Ernie",[FritzBox:mac_12_34_E0_00_CD_E4] ? "on":"off");;\
set_Reading_Update("Bert", [FritzBox:mac_02_08_02_07_30_E3] ? "on":"off");;\
set_Reading_Update("Grobi", [FritzBox:mac_00_08_01_0B_00_E7] ? "on":"off");; \
set_Reading_Update("Kermit", [FritzBox:mac_01_30_A9_72_02_E3] ? "on":"off");; \
set_Reading_End(1);;\
}
attr myHome checkReadingEvent 0
attr myHome uiTable {\
package ui_Table;;\
$SHOWNOSTATE=1;;\
$TC{0..4}="align='center'";;\
}\
## Template-Definition für die Visualisierung eines Bewohners mit Hilfe des Icons fa__508\
DEF TPL_person (icon_label([$SELF:$1] eq "on" ? "fa__508\@DarkOrange":"fa__508","$1","#e67e00","white",-10))\
\
## Darstellung der Bewohner mit Hilfe des obigen Templates\
TPL_person(Ernie)|TPL_person(Bert)|TPL_person(Grobi)|TPL_person(Kermit)
</syntaxhighlight>

''Ergebnis der Beispieldefinition in der Webansicht:''
[[Datei:UiTable myHome.png|ohne|mini]]

=== Weitere Anwendungsbeispiele zur Automatisierung ===
* siehe, [https://wiki.fhem.de/wiki/DOIF/Automatisierung DOIF-Automatisierung]
== Weiterführende Links ==
* Weitere Beispiele für Fortgeschrittene, siehe "[[DOIF/uiTable|uiTable mit FHEM-Widgets und Styles]]" ===

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

AutoShuttersControl

2021-02-07T10:09:30Z

Cwagner: ASC_Drive_DelayStart Typo; Unklarheit in der Beschreibung markiert.

{{Baustelle}}
{{Infobox Modul
|ModPurpose=Steuerung von Rollläden
|ModCategory=Automatisierung
|ModType=d
|ModForumArea=Automatisierung
|ModTechName=73_AutoShuttersControl.pm
|ModOwner=CoolTux ({{Link2FU|13684|Forum}}/[[Benutzer Diskussion:CoolTux|Wiki]])}}

Mit [[AutoShuttersControl]] oder kurz ASC können typische Aufgabenstellungen im Zusammenhang mit Rollläden u.ä. automatisiert werden, wie zum Beispiel das Öffnen bei Sonnenaufgang, Schließen bei Sonnenuntergang oder das Anfahren von Lüftungspositionen beim Öffnen des zugehörigen Fensters.

== Basics ==
{{Hinweis|Das Modul befindet sich derzeit noch in der Entwicklung; der derzeit aktuelle Stand ist diesem {{Link2Forum|Topic=112325|LinkText="Thread im Forum"}} zu entnehmen.}}
Zur Nutzung des Moduls sollten folgende andere FHEM-Devices vorhanden sein:
* Rollläden
* Fensterkontakte und
* Bewohnerstatus auf Basis von Residents/Roomates in englisch. Ersatzweise andere Devices, z.B. Dummys, welche als ''state'' ''home'', ''absent'', ''asleep'', ''gotosleep'' und ''awoken'' setzen sowie ein Reading ''lastState''.
* Optional:
** Ein Helligkeitssensor (Steuerung nach Helligkeit und Beschattung)
** Ein Device zur Bestimmung des Sonnenstands (nur für Beschattung). Unterstützt werden derzeit [[Modul Astro|Astro]] und [[Twilight]]<ref>Dabei müssen ggf. in [[Global|global]] auch Angaben zu ''longitude'' und ''latitude'' vorhanden sein</ref>.
** Wenn Feiertage berücksichtigt werden sollen: Ein oder mehrere {{Link2CmdRef|Anker=holiday2we|Lang=en|Label=holiday2we}}-Angaben in [[Global|global]] samt entsprechender [[Wochenende, Feiertage und Schulferien#Feiertage mittels holiday-Datei|holiday]]-Dateien<ref>Es kann auch z.B. ein Dummy-Device verwendet werden, dieses sollte dann aber neben dem eigentlichen Feiertags-''state'' auch in einem Reading ''tomorrow'' Angaben zu anstehenden Feiertagen enthalten.</ref> <ref>Bitte verfahren Sie entsprechend, wenn Urlaubs- oder Ferientage wie Feiertage behandelt werden sollen.</ref>.

Die Einrichtung des Moduls bzw. dessen Funktionalität erfolgt in mehreren Schritten:
* Definition des ASC-Devices
* Einstellung zentraler Vorgaben am ASC-Device
* Markieren der zukünftig zu steuernden Rollladen-Devices
* Einbinden der Rollladen-Devices in das ASC-Device
* Einstellen der individuellen Vorgaben je Rollladen (am Rollladen-Device)
Dabei geht man am einfachsten schrittweise vor und erweitert die Funktionalität nach und nach um die gewünschten Funktionen. Dann benötigt man jeweils nur einen kleinen Teil der vielen per Attribut einstellbaren Optionen, und kann die Auswirkungen der jeweiligen Änderung besser nachvollziehen.

== Einrichtung ==
{{Hinweis|ASC kann auch verwendet werden, um lediglich Teilaufgaben der Rollladensteuerung zu erfüllen, also z.B. nur das morgendliche Öffnen der Rollläden. Allerdings geht dabei ein erheblicher Teil des Komforts verloren, der dadurch entsteht, dass die Steuerung innerhalb der vollintegrierten Lösung jeweils nachvollzieht, aus welchem Grund eine Fahrt erfolgt war und dies ggf. bei der nächsten Aktion berücksichtigt.}}

=== Vorbereitung ===
Zunächst sollten die in den [[#Basics|Basics]] beschriebenen Geräte vorhanden und funktionsfähig sein.

=== Define des ASC-Devices ===
Es genügt ein einfaches define ohne weitere Parameter.
<code>define <name> AutoShuttersControl</code>
Dies bewirkt neben der Anlage des Devices selbst auch, dass als weiteres globales Attribut ''ASC'' verfügbar wird.

=== Einstellung zentraler Vorgaben ===
Es stehen am ASC-Device einige Attribute zur Verfügung, über die sich das Verhalten des ASC-Devices insgesamt steuern lässt, z.B. zur Vermeidung von morgendlichen oder abendlichen Fahrten sowie bei Gefahr von Schäden an den Rollläden durch Frost oder zur Reaktion auf Fensterkontakte. Details sind der Commandref zu entnehmen.
Diese Attribute können auch nachträglich noch geändert werden.

=== Markieren zu steuernder Rollladen-Devices ===
Um einen oder mehrere Rollläden durch das ASC-Device zu steuern, wird für jeden Rollladen jeweils das neue globale Attribut ''ASC'' gesetzt. Der Wert ist mit 1 oder 2 festzulegen, wobei '''1''' bedeutet, dass
* die Offen-Position kleiner ist als die Geschlossen-Position, also typischerweise 0 ''offen'' bedeutet und 100 für ''geschlossen'' steht
* eine bestimmte Position mit '''position''' angefahren wird, also z.B. <code>set <name> position 70</code>.
Dies ist z.B. die passende Wahl für ROLLO-Devices

Die '''2''' steht für ein umgekehrtes Verhalten und den Befehlsteil ''pct'', also ''offen'' für <code>set <name> pct 100</code>. Typischer Vertreter dieses Typs sind HomeMatic (CUL_HM-) Geräte oder die Shelly2-Aktoren.

Aus dieser Vorgabe leitet das Modul dann jeweils bestimmte Voreinstellungen (''defaults'') für den Rolladen ab, ohne dass die betreffenden, dafür vorgesehenen Attribute ausdrücklich gesetzt werden müssen. Es genügt daher, nur jeweils die Einstellungen zu verändern, die anders gewünscht werden oder für den Rollladenaktortyp anders sein müssen (z.B. ''dim 99'' für vollständiges Öffnen eines ZWave-Aktors).
{{Hinweis|Das Vorstehende gilt jeweils für den nicht-invertierten Modus! Wer z.B. ein HomeMatic-Gerät mit ''levelinverse'' betreibt, sollte ''ASC'' auf "1" setzen usw.. Maßgeblich ist letztlich nur die Frage, ob die Offen-Positionsangabe nummerisch kleiner oder größer als die Geschlossen-Positionsangabe ist; die konkreten Zahlenwerte spielen dabei keine Rolle, die Angabe ''position'' oder ''pct'' kann auch später über ein weiteres Attribut passend eingestellt werden.}}

=== Einbinden in das ASC-Device ===
Nachdem man das obige Attribut bei einem oder mehreren Rollladen-Devices gesetzt hat, kann mit
<code>set <name> scanForShutters</code> ein Suchlauf gestartet werden, mit dem dann diese Rollläden durch das Modul gefunden und in die Steuerungslogik eingebunden werden.

=== Einstellen der individuellen Vorgaben ===
Nach der Einbindung sind an den Rollladen-Devices weitere Attribute verfügbar, mit denen die für den jeweiligen Rollladen geltenden Einstellungen vorgenommen werden können.
Die Beschreibung der Attribute ist in der commandref enthalten.

== Readings ==

===Readings im ASC-Device selbst ===

{| class="wikitable"
|-
! Name !! Datentyp/ Wertebereich !! Bedeutung
|-
|..._nextAstroTimeEvent || || Zeit wird abhängig von der eingestellten Attribute ASC_Time_Up/ASC_Time_Down angezeigt. Bei ''astro'' die Uhrzeit des Sonnenauf- oder Sonnenuntergang, bei ''time'' und ''brightness'' die Zeit aus ASC_Time_Up_Early/ASC_Time_Down_Late pro Rollonamen
|-
|..._lastPosValue || || Position pro Rollonamen bevor ASC die Rolläden verfahren hat
|-
|..._PosValue || ||aktuelle Position pro Rollonamen
|-
|ascEnable||on, off ||globale ASC Steuerung bei den Rollläden aktiv oder inaktiv
|-
|controlShading||on, off ||globale Beschattungsfunktion aktiv oder inaktiv
|-
|hardLockOut || on, off ||Status des hardwareseitigen Aussperrschutzes / gilt nur für Rolläden mit dem Attribut bei denen das Attributs ASC_LockOut entsprechend auf hard gesetzt ist
|-
|selfDefense || on, off ||globale Selbstschutzfunktion aktiv oder inaktiv
|-
|partyMode ||on, off || globaler Partymodus aktiv oder inaktiv
|-
|state || ||Status des ASC-Devices: active, enabled, disabled oder weitere Statusinformationen wie z.B. Grund der letzen Fahrt
|-
|room_... || ||Auflistung aller Rollläden, welche in den jeweiligen Räumen gefunden wurden, Bsp.: room_Schlafzimmer,Terrasse
|-
|sunriseTimeWeHoliday|| on,off ||globale Wochenendunterstützung aktiv oder inaktiv
|-
|userAttrList || rolled out ||Das ASC-Modul verteilt an die gesteuerten Rollladen-Geräte diverse Benutzerattribute (userattr). In diesem Reading kann der Status dieser Verteilung geprüft werden.

|}

=== Readings in den Rolllädendevices ===

{| class="wikitable"
|-
! Name !! Bedeutung
|-
|ASC_Enable ||Status von ASC_Enable (on,off)
|-
|ASC_ShuttersLastDrive ||Grund des letzten Fahrens des Rolladens
|-
|ASC_Time_DriveDown ||Zeit wird abhängig von der eingestellten Attribute ASC_Time_Down angezeigt. Bei astro die Uhrzeit des Sonnenuntergangs, bei time und brightness die Zeit aus /ASC_Time_Down_Late
|-
|ASC_Time_DriveUp ||Zeit wird abhängig von der eingestellten Attribute ASC_Time_Up angezeigt. Bei astro die Uhrzeit des Sonnenaufgangs, bei time und brightness die Zeit aus /ASC_Time_Up_Early
|}

==set- und get-Befehle für das ASC-Device==

=== set-Anweisungen ===
{| class="wikitable"
|-
! Name !! Datentyp/ Wertebereich !! Beschreibung
|-
|advDriveDown ||on, off ||holt bei allen Rollläden durch ASC_Adv on ausgesetzte Fahrten nach
|-
|ascEnable||on, off ||Aktiviert oder deaktiviert die globale ASC-Steuerung
|-
|controlShading||on, off ||Aktiviert oder deaktiviert die globale Beschattungssteuerung
|-
|createNewNotifyDev || ||Legt die interne Struktur für NOTIFYDEV neu an. (Diese Funktion steht nur zur Verfügung, wenn Attribut ASC_expert auf 1 gesetzt ist.)
|-
|hardLockOut ||on, off ||Aktiviert den hardwareseitigen Aussperrschutz für die Rollläden, bei denen das Attributs ASC_LockOut entsprechend auf hard gesetzt ist. Mehr Informationen in der Beschreibung bei den Attributen für die Rollladengeräten.
|-
|partyMode ||on, off ||Aktiviert den globalen Partymodus. Alle Rollladen-Geräten, in welchen das Attribut ASC_Partymode auf on gesetzt ist, werden durch ASC nicht mehr gesteuert. Der letzte Schaltbefehl, der bspw. durch ein Fensterevent oder Wechsel des Bewohnerstatus an die Rollläden gesendet wurde, wird beim Deaktivieren des Partymodus ausgeführt
|-
|renewAllTimer || ||erneuert bei allen Rollläden die Zeiten gemäß ASC_UP/ASC_DOWN und setzt die internen Timer neu.
|-
|renewTimer || ||erneuert bei dem ausgewählten Rolladen die Zeiten gemäß ASC_UP/ASC_DOWN und setzt die internen Timer neu.
|-
|scanForShutters || ||sucht alle FHEM Devices mit dem Attribut ''ASDC'' ''1'' oder ''2'' und legt diese im ASC-Modul an
|-
|selfDefence ||on, off||Aktiviert bzw. deaktiviert die Selbstschutzfunktion. Beispiel 1: Wenn das Residents-Gerät ''gone'' meldet, alle Rollläden dann heruntergefahren. Beispiel 2 : Wenn das Residents-Gerät absent meldet, das Attribut ASC_ShuttersPlace=terrace ist und ein Fenster im Haus noch geöffnet ist, so wird an diesem Fenster der Rollladen dann heruntergefahren.
|-
|shutterASCenableToggle || ||Aktivieren oder deaktivieren der ASC Kontrolle beim einzelnen Rollladens
|-
|sunriseTimeWeHoliday || on,off ||Aktiviert die Wochenendunterstützung und somit, ob im Rollladen das Attribut ASC_Time_Up_WE_Holiday beachtet werden soll oder nicht.
|-
|wiggle ||||bewegt einen oder mehrere Rollläden um einen definierten Wert (Default: 5%) und nach einer Minute wieder zurück in die Ursprungsposition. Diese Funktion könnte bspw. zur Abschreckung in einem Alarmsystem eingesetzt werden.
|-
|||||
|}

=== get-Anweisungen ===

{| class="wikitable"
|-
! Name !! Beschreibung
|-
| showNotifyDevsInformations ||zeigt eine Übersicht der abgelegten NOTIFYDEV Struktur. Diese Funktion wird primär fürs Debugging genutzt. Hierzu ist das Attribut ASC_expert = 1 zu setzen.
|}

== Attribute ==
{{Hinweis|Die Attributnamen haben sich teilweise geändert, nachfolgend ist der Stand von Modulversion v0.8.x wiedergegeben.}}
{{Hinweis|In der commandref findet sich häufig die Schreibweise <code><nowiki>ASC_BrightnessSensor Sensorname[:brightness [400:800]]</nowiki></code>. Dabei sind die Angaben in den eckigen Klammern optional. Dies müssen also nicht angegeben werden, stattdessen verwendet das Modul dann Standardwerte (siehe cref), die in der cref zu findenden Angaben entsprechen dabei den defaults. Werden Werte angegeben, sind die eckigen Klammern '''wegzulassen'''! Beispiel: <code>ASC_BrightnessSensor hm_motion_1 70:100</code> würde das brightness-Reading des Sensors hm_motion_1 verwenden und einen morgendlichen Schwellenwert von 70 bzw. 100 für abends.}}
===Attribute direkt am ASC-Device ===

{| class="wikitable"
|-
! Name !! Datentyp/ Wertebereich !! Default-Wert !! Beschreibung
|-
|ASC_autoAstroModeEvening || ||REAL, CIVIL, NAUTIC, ASTRONOMIC oder HORIZON ||nach welchem ASTRO-Modus soll die Abendfahrt berechnet werden
|-
|ASC_autoAstroModeEveningHorizon || - 9 bis 9 || 0|| Höhe über dem Horizont. Wird nur berücksichtigt, wenn im Attribut ASC_autoAstroModeEvening der Wert HORIZON ausgewählt wurde.
|-
|ASC_autoAstroModeMorning || ||REAL, CIVIL, NAUTIC, ASTRONOMIC oder HORIZON || nach welchem ASTRO-Modus soll die Morgendfahrt berechnet werden
|-
|ASC_autoAstroModeMorningHorizon || - 9 bis 9|| 0|| Höhe über dem Horizont. Wird nur berücksichtigt, wenn im Attribut ASC_autoAstroModeMorning der Wert HORIZON ausgewählt wurde.
|-
|ASC_autoShuttersControlComfort ||on, off || off ||schaltet die Komfortfunktion an. Bedeutet, dass ein Rollladen mit einem threestate-Sensor am Fenster beim Öffnen in eine Offenposition fährt. Hierzu muss beim Rollladen das Attribut ASC_ComfortOpen_Pos entsprechend konfiguriert sein.
|-
|ASC_autoShuttersControlEvening ||on, off || ||Aktiviert die automatische Steuerung durch das ASC-Modul am Abend.
|-
|ASC_autoShuttersControlMorning ||on, off || ||Aktiviert die automatische Steuerung durch das ASC-Modul am Morgen.
|-
|ASC_blockASCDrivesAfterManual ||0, 1 || ||wenn dieser Wert auf 1 gesetzt ist, dann werden Rollläden vom ASC-Modul nicht mehr gesteuert, wenn zuvor manuell eingegriffen wurde. Voraussetzung hierfür ist jedoch, dass im Reading ASC_ShuttersLastDrive der Status manual enthalten ist und sich der Rollladen auf eine unbekannte (nicht in den Attributen anderweitig konfigurierte) Position befindet.
|-
|ASC_brightnessDriveUpDown || || || Werte (z.B. Lux) bei dem Schaltbedingungen für Sonnenauf- und -untergang geprüft werden sollen. Diese globale Einstellung kann durch die WERT-MORGENS:WERT-ABENDS Einstellung von ASC_BrightnessSensor im Rollladen selbst überschrieben werden.
|-
|ASC_debug ||0, 1 || 0||Aktiviert die erweiterte Logausgabe für Debugausgaben (nur nach Aufforderung nutzen)
|-
|ASC_expert ||0, 1 ||0 ||ist der Wert 1, so werden erweiterte Informationen bezüglich des NotifyDevs unter ''set und get'' angezeigt
|-
|ASC_freezeTemp ||-5 bis 5 || ||Temperatur, ab welcher der Frostschutz greifen soll und der Rollladen nicht mehr fährt. Der letzte Fahrbefehl wird gespeichert.
|-
|ASC_rainSensor || || ||DEVICENAME[:READINGNAME] MAXTRIGGER[:HYSTERESE] [CLOSEDPOS] - der Inhalt ist eine Kombination aus Devicename, Readingname, Wert ab dem getriggert werden soll, Hysterese Wert ab dem der Status Regenschutz aufgehoben werden soll und der "wegen Regen geschlossen Position".
|-
|ASC_residentsDev || || ||DEVICENAME[:READINGNAME] - der Inhalt ist eine Kombination aus Devicenamen und Readingnamen des Residents-Device der obersten Ebene (z.B. rgr_Residents:state)
|-
|ASC_shuttersDriveDelay || || ||maximale Zufallsverzögerung in Sekunden bei der Berechnung der Fahrzeiten. 0 bedeutet keine Verzögerung
|-
|ASC_tempSensor || || ||DEVICENAME[:READINGNAME] - der Inhalt ist eine Kombination aus Device und Reading für die Außentemperatur
|-
|ASC_twilightDevice || || ||das Device, welches die Informationen zum Sonnenstand liefert. Wird unter anderem für die Beschattung verwendet.
|-
|ASC_windSensor || || ||DEVICE[:READING] - Sensor für die Windgeschwindigkeit. Kombination aus Device und Reading.
|-
| || || ||
|-
| || || ||
|}

===Attribute in den Rolllädendevices===

{| class="wikitable"
|-
! Name !! Datentyp/ Wertebereich !! Default-Wert !! Beschreibung
|-
|ASC || 0, 1, 2|| ||"kein Anlegen der Attribute beim ersten Scan bzw. keine Beachtung eines Fahrbefehles",1 = "Inverse oder Rollo - Bsp.: Rollo oben 0, Rollo unten 100 und der Befehl zum prozentualen Fahren ist position",2 = "Homematic Style - Bsp.: Rollo oben 100, Rollo unten 0 und der Befehl zum prozentualen Fahren ist pct
|-
|ASC_Adv || on, off||||bei on wird das runterfahren des Rollos während der Weihnachtszeit (1. Advent bis 6. Januar) ausgesetzt! Durch set <ASCDEVICE> advDriveDown werden alle ausgesetzten Fahrten nachgeholt.
|-
|ASC_Antifreeze ||off, soft, hard, am, pm || ||Frostschutz, wenn soft fährt der Rollladen in die ASC_Antifreeze_Pos, bei hard/am/pm wird gar nicht oder innerhalb der entsprechenden Tageszeit nicht gefahren
|-
|ASC_Antifreeze_Pos || || ||Position des Rolllades die angefahren werden soll, wenn der Fahrbefehl komplett schließen lautet, aber der Frostschutz aktiv ist !!!Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss eine positive Zahl/Dezimalzahl sein!!!
|-
|ASC_autoAstroModeEvening ||REAL, CIVIL, NAUTIC, ASTRONOMIC oder HORIZON || ||nach welchem ASTRO-Modus soll die Abendfahrt berechnet werden
|-
|ASC_autoAstroModeEveningHorizon || - 9 bis 9 || 0|| Höhe über dem Horizont. Wird nur berücksichtigt, wenn im Attribut ASC_autoAstroModeEvening der Wert HORIZON ausgewählt wurde.
|-
|ASC_autoAstroModeMorning ||REAL, CIVIL, NAUTIC, ASTRONOMIC oder HORIZON || || nach welchem ASTRO-Modus soll die Morgendfahrt berechnet werden
|-
|ASC_autoAstroModeMorningHorizon || - 9 bis 9|| 0|| Höhe über dem Horizont. Wird nur berücksichtigt, wenn im Attribut ASC_autoAstroModeMorning der Wert HORIZON ausgewählt wurde.
|-
|ASC_BlockingTime_afterManual || ||1200 ||wie viel Sekunden soll die Automatik nach einer manuellen Fahrt aussetzen
|-
|ASC_BlockingTime_beforeDayOpen || ||3600 ||wie viel Sekunden vor dem morgendlichen öffnen soll keine schließen Fahrt mehr stattfinden.
|-
|ASC_BlockingTime_beforeNightClose || ||3600 ||ie viel Sekunden vor dem nächtlichen schließen soll keine öffnen Fahrt mehr stattfinden.
|-
|ASC_BrightnessSensor || ||none ||DEVICE[:READING] WERT-MORGENS:WERT-ABENDS / 'Sensorname[:brightness [400:800]]' Angaben zum Helligkeitssensor mit (Readingname, optional) für die Beschattung und dem Fahren der Rollladen nach brightness und den optionalen Brightnesswerten für Sonnenauf- und Sonnenuntergang
|-
|ASC_Closed_Pos || ||default Vorgabe ist abhängig vom Attribut ''ASC''||in 10er-Schritten von 0 bis 100
wird angefahren wenn SelfDefense aktiv ist
|-
|ASC_ComfortOpen_Pos || || || in 10er Schritten von 0 bis 100 !!! Die eingestellte Position wird bei einem threestate Sensor angefahren. Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss eine positive Zahl/Dezimalzahl sein!!!
|-
|ASC_Down || time, astro, brightness, roommate || astro||bei ''astro'' wird Sonnenuntergang berechnet, bei time wird der Wert aus ASC_Time_Down_Early als Fahrzeit verwendet und bei brightness muss ASC_Time_Down_Early und ASC_Time_Down_Late korrekt gesetzt werden. Der Timer läuft dann nach ASC_Time_Down_Late Zeit, es wird aber in der Zeit zwischen ASC_Time_Down_Early und ASC_Time_Down_Late geschaut, ob die als Attribut im Moduldevice hinterlegte ASC_brightnessDriveUpDown der Down Wert erreicht wurde. Wenn ja, wird der Rollladen runter gefahren.
|-
|ASC_DiveUpMaxDuration || || 60||die Dauer des Hochfahrens des Rollladens plus 5 Sekunden
|-
|ASC_Drive_Delay || || -1|| maximaler Wert für einen zufällig ermittelte Verzögerungswert in Sekunden bei der Berechnung der Fahrzeiten, 0 bedeutet keine Verzögerung, -1 bedeutet, dass das ??gleichwertige Attribut?? aus dem ASC Device ausgewertet werden soll
|-
|ASC_Drive_DelayStart || || -1|| in Sekunden verzögerter Wert ab welchen dann erst das Offset startet und dazu addiert wird. Funktioniert nur wenn gleichzeitig ASC_DriveDelay gesetzt wird.
|-
|ASC_ExternalTrigger || |||| DEVICE:READING VALUEACTIVE:VALUEINACTIVE POSACTIVE:POSINACTIVE, Beispiel: "WohnzimmerTV:state on:off 66:100" bedeutet das wenn ein "state:on" Event kommt soll das Rollo in Position 66 fahren, kommt ein "state:off" Event soll es in Position 100 fahren. Es ist möglich die POSINACTIVE weg zu lassen dann fährt das Rollo in LastStatus Position.
|-
|ASC_GuestRoom || on, off |||| aktuell noch nicht umgesetzt...
|-
|ASC_LockOut || soft, hard, off ||off || stellt entsprechend den Aussperrschutz ein. Bei global aktivem Aussperrschutz (set ASC-Device lockOut soft) und einem Fensterkontakt open bleibt dann der Rollladen oben. Dies gilt nur bei Steuerbefehlen über das ASC Modul. Stellt man global auf hard, wird bei entsprechender Möglichkeit versucht den Rollladen hardwareseitig zu blockieren. Dann ist auch ein Fahren über die Taster nicht mehr möglich
|-
|ASC_LockOut_Cmd || inhibit, blocked, protection ||none|| set Befehl für das Rollladen-Device zum Hardware sperren. Dieser Befehl wird gesetzt werden, wenn man "ASC_LockOut" auf hard setzt
|-
|ASC_Mode_Down ||absent, always, off, home || always ||Wann darf die Automatik steuern. immer, niemals, bei Abwesenheit des Roommate (ist kein Roommate und absent eingestellt, wird gar nicht gesteuert)
|-
|ASC_Mode_Up ||absent, always, off, home || always ||Wann darf die Automatik steuern. immer, niemals, bei Abwesenheit des Roommate (ist kein Roommate und absent eingestellt, wird gar nicht gesteuert)
|-
|ASC_Open_Pos || ||default Vorgabe ist abhängig vom Attribut ''ASC''||in 10er-Schritten von 0 bis 100
|-
|ASC_Partymode || on, off || off ||schaltet den Partymodus an oder aus. Wird am ASC Device set ASC-DEVICE partyMode on geschalten, werden alle Fahrbefehle an den Rollläden, welche das Attribut auf on haben, zwischengespeichert und später erst ausgeführ
|-
|ASC_Pos_Reading || || ||Name des Readings, welches die Position des Rollladen in Prozent angibt. Wird bei unbekannten Device-Typen auch als ''set'' Befehl zum Fahren verwendet
|-
|ASC_PrivacyDownValue_beforNightClose || || -1||wie viele Sekunden vor dem abendlichen schließen soll der Rollladen in die Sichtschutzposition fahren, oder bei Brightness ab welchem minimum Brightnesswert soll das Rollo in die Privacy Position fahren. Bei Brightness muss zusätzlich zum Zeitwert der Brightnesswert mit angegeben werden 1800:300 bedeutet 30 min vor night close oder bei unter einem Brightnesswert von 300
|-
|ASC_PrivacyDown_Pos || ||50||Position den Rollladens für den abendlichen Sichtschutz!Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss eine positive Zahl/Dezimalzahl sein!!!
|-
|ASC_PrivacyUpValue_beforDay || || -1||wie viele Sekunden vor dem morgendlichen öffnen soll der Rollladen in die Sichtschutzposition fahren, oder bei Brightness ab welchem minimum Brightnesswert soll das Rollo in die Privacy Position fahren. Bei Brightness muss zusätzlich zum Zeitwert der Brightnesswert mit angegeben werden 1800:600 bedeutet 30 min vor day open oder bei über einem Brightnesswert von 600
|-
|ASC_PrivacyUp_Pos || ||50||Position den Rollladens für den morgendlichen Sichtschutz!Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss eine positive Zahl/Dezimalzahl sein!!!
|-
|ASC_RainProtection ||on, off || ||soll der Rollladen beim Regenschutz beachtet werden. on=JA, off=NEIN.
|-
|ASC_Roommate_Device || || none ||mit Komma getrennte Namen des/der Roommate-Device/s welche den/die Bewohner des Rollladen-Raumes wiedergibt. Macht nur Sinn in Schlaf- oder Kinderzimmern
|-
|ASC_Roommate_Reading || || ||Reading des Roommate-Device, welches den Status wieder gibt
|-
|ASC_Self_Defense_AbsentDelay || || 300||um wie viele Sekunden soll das fahren in Selfdefense bei Residents absent verzögert werden
|-
|ASC_Self_Defense_Mode || || gone||ab welchen Residents Status soll Selfdefense aktiv werden ohne das Fenster auf sind
|-
|ASC_Shading_InOutAzimuth || ||95:265 ||Azimut Wert ab dem bei Überschreiten Beschattet und bei Unterschreiten Endschattet werden soll
|-
|ASC_Shading_MinMax_Elevation || ||25.0:100.0 ||ab welcher min Höhe des Sonnenstandes soll beschattet und ab welcher max Höhe wieder beendet werden, immer in Abhängigkeit der anderen einbezogenen Sensorwerte
|-
|ASC_Shading_MinOutsideTemperature_ || ||18 ||ab welcher Temperatur soll Beschattet werden, immer in Abhängigkeit der anderen einbezogenen Sensorwert
|-
|ASC_ShadingMode ||absent, always, off, home || off||wann soll die Beschattung nur stattfinden
|-
|ASC_Shading_Pos || || ||Position des Rollladens für die Beschattung !!!Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss eine positive Zahl/Dezimalzahl sein!!!
|-
|ASC_Shading_StateChange_SunnyCloudy || ||35000:20000 ||Brightness Wert ab welchen die Beschattung stattfinden und aufgehoben werden soll, immer in Abhängigkeit der anderen einbezogenen Sensorwerte
|-
|ASC_Shading_WaitingPeriod || ||1200 ||wie viele Sekunden soll gewartet werden bevor eine weitere Auswertung der Sensordaten für die Beschattung stattfinden soll
|-
|ASC_Shutter_IdleDetection || ||||READING:VALUE gibt das Reading an welches Auskunft über den Fahrstatus des Rollos gibt, sowie als zweites den Wert im Reading welcher aus sagt das das Rollo nicht fährt
|-
|ASC_ShuttersPlace || window, terrace || ||wenn dieses Attribut auf ''terrace'' gesetzt ist und das Residents-Device in den Status ''absent'' geht, ''selfDefence'' aktiv ist und das Fenster geöffnet ist, wird das Rollo geschlossen. Wenn ein twostate Senso genutzt wird und dieses Attribut auf ''terrace'' gesetzt ist wird ASC_Ventilate_Pos ignoriert und das Rollo wird beim öffnen des Fenster komplett geöffnet. Wenn dieses Attribut auf ''window'' gesetzt ist wird ASC_Ventilate_Pos berücksichtigt und das Rollo wird entsprechend der ASC_Ventilate_Pos geöffnet. Wenn das Fenster wieder geschlossen wird, dann wird das Rollo unabhängig von ''windows oder terrace'' vollständig geschlossen.
|-
|ASC_Sleep_Pos || || ||in 10er-Schritten von 0 bis 100, default Vorgabe ist abhängig vom Attribut ''ASC.'' Position wird angefahren wenn Bedingung für modeDown aktiv ist. Hiermit kann z.B. das komplette abendliche Schließen des Rollos begrenzt werden.
|-
|ASC_TempSensor || || ||DEVICENAME[:READINGNAME] - der Inhalt ist eine Kombination aus Device und Reading für die Außentemperatur
|-
|ASC_Time_Down_Early || ||16:00 ||Sonnenuntergang frühste Zeit zum Runterfahren !!!Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss ein Zeitformat in Form HH:MM[:SS] sein!!!
|-
|ASC_Time_Down_Late || ||22:00 ||Sonnenuntergang späteste Zeit zum Runterfahren !!!Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss ein Zeitformat in Form HH:MM[:SS] sein!!!
|-
|ASC_Time_Up_Early || || 05:00||Sonnenaufgang frühste Zeit zum Hochfahren !!!Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss ein Zeitformat in Form HH:MM[:SS] sein!!!
|-
|ASC_Time_Up_Late || ||08:30 ||Sonnenaufgang späteste Zeit zum Hochfahren !!!Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss ein Zeitformat in Form HH:MM[:SS] sein!!!
|-
|ASC_Time_Up_WE_Holiday || ||08:00 ||Sonnenaufgang frühste Zeit zum Hochfahren am Wochenende und/oder Urlaub (holiday2we wird beachtet).ACHTUNG!!! in Verbindung mit Brightness für ASC_Up muss die Uhrzeit kleiner sein wie die Uhrzeit aus ASC_Time_Up_Late !!!Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss ein Zeitformat in Form HH:MM[:SS] sein!!!
|-
|ASC_Ventilate_Window_Open ||on, off ||on||auf lüften, wenn das Fenster gekippt/geöffnet wird und aktuelle Position unterhalb der Lüften-Position ist
|-
|ASC_WiggleValue || ||5 ||Wert, um welchen sich die Position des Rollladens bei ''Wiggle'' ändern soll
|-
|ASC_WindParameters || ||5 ||TRIGGERMAX[:HYSTERESE] [DRIVEPOSITION] / Angabe von Max Wert ab dem für Wind getriggert werden soll, Hytsrese Wert ab dem der Windschutz aufgehoben werden soll TRIGGERMAX - HYSTERESE / Ist es bei einigen Rollläden nicht gewünscht das gefahren werden soll, so ist der TRIGGERMAX Wert mit -1 an zu geben. (default: '50:20 ClosedPosition')
|-
|ASC_WindProtection ||on, off || ||soll der Rollladen beim Windschutz beachtet werden. on=JA, off=NEIN.
|-
|ASC_WindowRec || ||none ||Name des Fensterkontakts, an welchen Fenster der Rollladen angebracht ist. WINDOWREC:[READING], Name des Fensterkontaktes, an dessen Fenster der Rollladen angebracht ist. Reading ist optional
|-
|ASC_WindowRec_PosAfterDayClosed ||open, lastManual ||open ||Name des Fensterkontakts, an welchen Fenster der Rollladen angebracht ist. Sein Reading ''state'' muss die Werte ''open'', ''closed'' oder ''tilted'' enthalten.
|-
|ASC_WindowRec_subType ||twostate, threestate ||twostate||Typ des verwendeten Fensterkontaktes: twostate (optisch oder magnetisch) oder threestate (Drehgriffkontakt)
|-
| || || ||
| || || ||
|-
| || || ||
|-
| || || ||
|-
| || || ||
|}

== Hilfsmittel ==
{{Hinweis|Die Device-Namen sind auf die eigene Installation anzupassen.}}

{{Hinweis|Codezeilen sind im [[Import von Code Snippets|RAW]]-Format.}}

{{Randnotiz|RNTyp=g|RNText= Stand 2019-05-03
* Erfolgreich getestet mit Homematic Devices, Beta-User
* Die Farbgebung entspricht dem Standard, wenn unter dem Style f18 der Farbpreset ''light'' gewählt wird.
}}

=== readingsGroup für Level ===
<pre style="width:65%;word-wrap: break-word;">defmod rg_ASC_Rolllaeden_Level readingsGroup <Gerät>,<Stand>,<Schliessen bis>,<Öffnen auf>,<Beschattung>,<Komfort>,<Lüften>,<Privacy> (Rollladen_.*|Jalousie_.*)..:level,!?ASC_Closed_Pos,!?ASC_Open_Pos,!?ASC_Shading_Pos,!?ASC_ComfortOpen_Pos,!?ASC_Ventilate_Pos,!?ASC_PrivacyDown_Pos
attr rg_ASC_Rolllaeden_Level commands {level => 'pct:selectnumbers,0,5,100,0,lin',\
ASC_Closed_Pos => 'ASC_Closed_Pos:selectnumbers,0,5,100,0,lin',\
ASC_Open_Pos => 'ASC_Open_Pos:selectnumbers,0,5,100,0,lin',\
ASC_Shading_Pos => 'ASC_Shading_Pos:selectnumbers,0,5,100,0,lin',\
ASC_Ventilate_Pos => 'ASC_Ventilate_Pos:selectnumbers,0,5,100,0,lin',\
ASC_ComfortOpen_Pos => 'ASC_ComfortOpen_Pos:selectnumbers,0,5,100,0,lin',\
ASC_PrivacyDown_Pos => 'ASC_PrivacyDown_Pos:selectnumbers,0,5,100,0,lin'}
</pre>

=== readingsGroup für Zeiten ===
[[Bild:ReadingsGroup ASC times.png|thumb|right|ReadingsGroup - Zeitenbeispiel]]
<pre style="width:65%;word-wrap: break-word;">defmod rg_ASC_Rolllaeden_Times readingsGroup <Gerät>,<Position>,<Time_Up_Early>,<Time_Up_Late>,<Time_Up_WE/Hol>,<Time_Down_Early>,<Time_Down_Late>,<Mode_Down>,<Mode_Up> \
(.*Rollo.*|.*Rollladen|Jalousie_.*):level,!?ASC_Time_Up_Early,!?ASC_Time_Up_Late,!?ASC_Time_Up_WE_Holiday,!?ASC_Time_Down_Early,!?ASC_Time_Down_Late,!?ASC_Mode_Down,!?ASC_Mode_Up
attr rg_ASC_Rolllaeden_Times commands {level => 'pct:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,100', \
ASC_Time_Down_Early => 'ASC_Time_Down_Early:15:00,15:15,15:30,15:45,16:00,16:15,16:30,16:45,17:00,17:15,17:30,17:45,18:00,18:15,18:30,18:45,19:00,19:15,19:30,19:45,20:00,20:15,20:30,20:45,21:00,21:15,21:30,21:45,22:00', \
ASC_Time_Down_Late => 'ASC_Time_Down_Late:19:00,19:15,19:30,19:45,20:00,20:15,20:30,20:45,21:00,21:15,21:30,21:45,22:00,22:15,22:30,22:45,23:00,23:15,23:30', \
ASC_Time_Up_WE_Holiday => 'ASC_Time_Up_WE_Holiday:06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00',\
ASC_Time_Up_Early => 'ASC_Time_Up_Early:05:00,05:05,05:30,05:55,06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00', \
ASC_Time_Up_Late => 'ASC_Time_Up_Late:06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00', \
ASC_Mode_Down => 'ASC_Mode_Down:always,absent,off', \
ASC_Mode_Up => 'ASC_Mode_Up:always,absent,off' }
attr rg_ASC_Rolllaeden_Times room Rollladen</pre>

[[Bild:ASC RG Zeiten HM ZWave Siro.png|thumb|right|ReadingsGroup - CUL_HM+ZWave+Siro mit widgets]]Neue Version mit time-Widgets und pct/dim/position-widget (5-er Schritte), passend für CUL_HM, ZWave und Siro-Geräte:
<pre style="width:65%;word-wrap: break-word;">defmod rg_ASC_Rolllaeden_Times readingsGroup <Gerät>,<Stand>,<Time_Up_Early >,<Time_Up_WE >,<Time_Up_Late >,<Time_Down_Early>,<Time_Down_Late>,<Mode_Down>,<Mode_Up> (Rollo_.*|Jalousie_.*)..:(level|dim|position),!?ASC_Time_Up_Early,!?ASC_Time_Up_WE_Holiday,!?ASC_Time_Up_Late,!?ASC_Time_Down_Early,!?ASC_Time_Down_Late,!?ASC_Mode_Down,!?ASC_Mode_Up
attr rg_ASC_Rolllaeden_Times commands {level => 'pct:selectnumbers,0,5,100,0,lin', \
dim => 'dim:selectnumbers,0,5,99,0,lin',\
position => 'pct:selectnumbers,0,5,99,0,lin',\
ASC_Mode_Down => 'ASC_Mode_Down:always,absent,off',\
ASC_Mode_Up => 'ASC_Mode_Up:always,absent,off',\
ASC_Time_Down_Early => 'ASC_Time_Down_Early:time', \
ASC_Time_Down_Late => 'ASC_Time_Down_Late:time',\
ASC_Time_Up_Early => 'ASC_Time_Up_Early:time', \
ASC_Time_Up_Late =>'ASC_Time_Up_Late:time',\
ASC_Time_Up_WE_Holiday =>'ASC_Time_Up_WE_Holiday:time'}
attr rg_ASC_Rolllaeden_Times room Rollladen
</pre>

=== readingsGroup für die Beschattung ===
[[Bild:ReadingsGroup ASC shading.png|thumb|right|ReadingsGroup - Beschattungsbeispiel]]
<pre style="width:65%;word-wrap: break-word;">
defmod rg_ASC_Rolllaeden_Shading readingsGroup <Gerät>,<Modus>,<Position>,<Richtung>,<°links>,<°rechts>,<Elevation>,<Sunny>,<Cloudy>,<Min Temp> (Rollo|Jalousie)_.*..:!?ASC_Shading_Mode,!?ASC_Shading_Pos,!?ASC_Shading_Direction,!?ASC_Shading_Angle_Left,!?ASC_Shading_Angle_Right,!?ASC_Shading_MinMax_Elevation,!?ASC_Shading_StateChange_Sunny,!?ASC_Shading_StateChange_Cloudy,!?ASC_Shading_Min_OutsideTemperature
attr rg_ASC_Rolllaeden_Shading alias Rollläden: Beschattung
attr rg_ASC_Rolllaeden_Shading commands {ASC_Shading_Pos => 'ASC_Shading_Pos:knob,min:0,max:100,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:5,lineCap:round',\
ASC_Shading_Mode => 'ASC_Shading_Mode:always,home,absent,off',\
ASC_Shading_Direction => 'ASC_Shading_Direction:knob,min:0,max:360,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:1,cursor:true,lineCap:round',\
ASC_Shading_Angle_Left => 'ASC_Shading_Angle_Left:knob,min:0,max:85,angleArc:85,rotation:anticlockwise,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:5,lineCap:round,angleOffset:270',\
ASC_Shading_Angle_Right => 'ASC_Shading_Angle_Right:knob,min:0,max:85,angleArc:85,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:5,lineCap:round,',\
ASC_Shading_MinMax_Elevation => 'ASC_Shading_MinMax_Elevation:knob,min:0,max:35,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:1,lineCap:round,angleArc:120,angleOffset:270',\
ASC_Shading_StateChange_Sunny => 'ASC_Shading_StateChange_Sunny:knob,min:100,max:40000,angleArc:85,rotation:anticlockwise,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:20,lineCap:round,angleOffset:270',\
ASC_Shading_StateChange_Cloudy => 'ASC_Shading_StateChange_Cloudy:knob,min:100,max:40000,angleArc:85,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:20,lineCap:round,',\
ASC_Shading_Min_OutsideTemperature => 'ASC_Shading_Min_OutsideTemperature:knob,min:5,max:30,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:0.5,lineCap:round,angleArc:120,angleOffset:270'}
attr rg_ASC_Rolllaeden_Shading room Rollladen</pre>
 
Anderes {{Link2Forum|Topic=99980|Message=946357|LinkText=Foren-Beispiel}} für eine RG zu Beschattung (für V. 0.6.x):
[[Bild:ReadingsGroup ASC shading2.png|thumb|right|ReadingsGroup - Beschattungsbeispiel]]
<pre style="width:65%;word-wrap: break-word;">
defmod rg_ASC_Shading readingsGroup <Gerät>,<Grad>,<Position>,<Mode>,<Links>,<Rechts>,<Wait>,<ShadeIn>,<ShadeOut>,<Elevation>,<Temperature>,<Device>\
(Rollo_.*|Jalousie.*):!?ASC_Shading_Direction,!?ASC_Shading_Pos,!?ASC_Shading_Mode,!?ASC_Shading_Angle_Left,!?ASC_Shading_Angle_Right,!?ASC_Shading_WaitingPeriod,!?ASC_Shading_StateChange_Sunny,!?ASC_Shading_StateChange_Cloudy,!?ASC_Shading_MinMax_Elevation,!?ASC_Shading_Min_OutsideTemperature,!?ASC_BrightnessSensor\

attr rg_ASC_Shading commands {ASC_Shading_Direction => 'ASC_Shading_Direction:129,255,309',\
ASC_Shading_Pos => 'ASC_Shading_Pos:selectnumbers,0,5,100,0,lin',\
ASC_Shading_Mode => 'ASC_Shading_Mode:absent,always,off,home',\
ASC_Shading_Angle_Left => 'ASC_Shading_Angle_Left:selectnumbers,0,5,100,0,lin',\
ASC_Shading_Angle_Right => 'ASC_Shading_Angle_Right:selectnumbers,0,5,100,0,lin',\
ASC_Shading_WaitingPeriod => 'ASC_Shading_WaitingPeriod:selectnumbers,0,60,1200,0,lin',\
ASC_Shading_StateChange_Sunny => 'ASC_Shading_StateChange_Sunny:selectnumbers,0,20,1000,0,lin',\
ASC_Shading_StateChange_Cloudy => 'ASC_Shading_StateChange_Cloudy:selectnumbers,0,20,1000,0,lin',\
ASC_Shading_MinMax_Elevation =>\
'ASC_Shading_Min_Elevation:selectnumbers,0,1,40,0,lin' ,\
ASC_Shading_Min_OutsideTemperature =>\
'ASC_Shading_Min_OutsideTemperature:selectnumbers,0,1,30,0,lin'}
attr rg_ASC_Shading room Rollladen</pre>

=== readingsGroup für FIBARO Roller Shutter FGR-222 Devices ===
{{Randnotiz|RNTyp=g|RNText=Getestet von majestro84, Stand 2019-01-28.
* https://forum.fhem.de/index.php/topic,92628.msg897099.html#msg897099
* Die Farbgebung entspricht dem Standard, wenn unter dem Style f18 der Farbpreset ''dark'' gewählt wird}}

[[Bild:ASC Jalousien Times.JPG|thumb|right|Beispiel]]
<pre style="width:65%;word-break: break-all;word-wrap: break-word;">define ASC_Jalousien_Times readingsGroup <Gerät>,<Stand>,<Time_Up_Early>,<Time_Up_WE>,<Time_Up_Late>,<Time_Down_Early>,<Time_Down_Late>,<Mode_Down>,<Mode_Up>,<PartyMode>,<LockOut> (.*_Jalousie.*):position,!?ASC_Time_Up_Early,!?ASC_Time_Up_WE_Holiday,!?ASC_Time_Up_Late,!?ASC_Time_Down_Early,!?ASC_Time_Down_Late,!?ASC_Mode_Down,!?ASC_Mode_Up,!?ASC_Partymode,!?ASC_LockOut

attr ASC_Jalousien_Times commands {position => 'dim:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_Mode_Down => 'ASC_Mode_Down:always,absent,off',
ASC_Mode_Up => 'ASC_Mode_Up:always,absent,off',
ASC_Partymode => 'ASC_Partymode:on,off',
ASC_LockOut => 'ASC_LockOut:soft,hard,off',
ASC_Time_Down_Early => 'ASC_Time_Down_Early:15:00,15:15,15:30,15:45,16:00,16:15,16:30,16:45,17:00,17:15,17:30,17:45,18:00,18:15,18:30,18:45,19:00,19:15,19:30,19:45,20:00,20:15,20:30,20:45,21:00,21:15,21:30,21:45,22:00',
ASC_Time_Down_Late => 'ASC_Time_Down_Late:20:15,20:30,20:45,21:00,21:15,21:30,21:45,22:00,22:15,22:30,22:45,23:00,23:15,23:30',
ASC_Time_Up_Early => 'ASC_Time_Up_Early:05:00,05:05,05:30,05:45,06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00',
ASC_Time_Up_Late =>'ASC_Time_Up_Late:06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00',
ASC_Time_Up_WE_Holiday => 'ASC_Time_Up_WE_Holiday:06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00'}
attr ASC_Jalousien_Times room Jalousien</pre>

[[Bild:ASC Jalousien Level.JPG|thumb|right|Beispiel]]
<pre style="width:65%;word-break: break-all;word-wrap: break-word;"> define Jalousien_Level readingsGroup <Gerät>,<Closed_Pos>,<Open_Pos>,<Comfort_Pos>,<Ventilate_Pos>,<PrivacyDown_Pos>,<Shading_Pos> (.*_Jalousie.*):!?ASC_Closed_Pos,!?ASC_Open_Pos,!?ASC_ComfortOpen_Pos,!?ASC_Ventilate_Pos,!?ASC_PrivacyDown_Pos,!?ASC_Shading_Pos
attr Jalousien_Level commands { ASC_Closed_Pos => 'ASC_Closed_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_Open_Pos => 'ASC_Open_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_ComfortOpen_Pos => 'ASC_ComfortOpen_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_Ventilate_Pos => 'ASC_Ventilate_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_PrivacyDown_Pos => 'ASC_PrivacyDown_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_Shading_Pos => 'ASC_Shading_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99'}
attr Jalousien_Level room Jalousien</pre>

== Einrichtungsbeispiel (nach Sonnenstand) ==
=== Zielsetzung und Vorgaben ===
Es sollen alle Rollläden und Jalousien in einem Haus innerhalb bestimmter zeitlicher Grenzen Morgens und Abends sonnenstandsabhängig gefahren werden, an den Wochenenden und an Ferientagen soll etwas später geöffnet werden. Es sind Tür- und Fensterkontakte vorhanden (Türkontakte: twoState, Fensterkontakte: threeState), wobei bei jeder Öffnung ein eventuell geschlossener Rollladen geöffnet werden soll. Bei allen Rollladenaktoren, Tür- und Fensterkontakten handelt es sich um CUL_HM-Geräte.

=== Vorarbeiten ===
Im global-Device sind Angaben zu latitude und longitude vorhanden, holiday2we wie folgt<ref>''ferien'' ist eine automatisiert erstellte holiday-Datei nach diesem {{Link2Forum|Topic=85759|Message=885883|LinkText=Foren-Beitrag}}.</ref>:
attr global holiday2we bw,ferien
Weitere Angaben benötigen wir zunächst nicht, die Festlegung eines Astro-Devices erfolgt hier erst im Rahmen der Beschattung.
Dann erfolgt das ''Define des ASC-Devices'' wie oben beschrieben:
<code>define Rollladenautomatik AutoShuttersControl</code>
Folgen die einzubindenden Rollladenaktoren einem einheitlichen Namensschema, können diese sodann z.B. mit
attr (Jalousie|Rollladen)_.* ASC 2
auf einen Rutsch mit dem passenden ASC-Typ gekennzeichnet werden.

{{Hinweis|Achtung: Das AutoShuttersControl-Device selbst darf kein ASC-Attribut bekommen!}}

Dann verteilen wir mir
set Rollladenautomatik scanForShutters
die nachfolgend weiter zu bearbeitenden Attribute.
=== Schließen morgens und abends ===
{{Randnotiz|RNTyp=g|RNText=Alternative: Fahren nach brightness:
Will man insgesamt oder nur an einzelnen Rollläden stattdessen helligkeitsgesteuert fahren, muß für jeden Rollladen ein Helligkeitssensor definiert und entweder zentral oder am einzelnen Rollladen jeweils ein Höchst- bzw. Mindestwert festgelegt werden (''ASC_BrightnessSensor'' etc.), bei dessen Überschreitung geöffnet bzw. Unterschreitung geschlossen werden soll.}}
==== Konfiguration des ASC-Devices ====
Da wir sonnenstandsabhängig Fahrzeiten wollen, legen wir erst einmal fest, dass dies morgens und abends berücksichtigt werden soll:
<pre>
attr Rollladenautomatik ASC_autoAstroModeEvening CIVIL
attr Rollladenautomatik ASC_autoAstroModeMorning CIVIL
</pre>
Aus der Angabe ''CIVIL'' und den Vorgaben in den einzelnen Rollladen wird dabei mit Hilfe von [[SUNRISE_EL]] die effektive Fahrzeit berechnet, dort finden sich auch weitere Hinweise, zu den meisten anderen Optionen für die ersten beiden Attribute.
Bei allen Fensteröffnungen soll auf eine Lüften-Position gefahren werden, also schalten wir diese Funktion ebenfalls zentral an<ref>Sonst wird bei threeState-Sensoren nur bei ''tilted'' auf die in ''ASC_Ventilate_Pos'' gefahren.</ref>:
attr Rollladenautomatik ASC_autoShuttersControlComfort on
Zuletzt legen wir noch einen Temperatur-Sensor fest. Dieser wird beim Frostschutz sowie bei der Beschattung berücksichtigt.
<pre>
attr Rollladenautomatik ASC_tempSensor Aussentemperatur_Nord:temperature
attr Rollladenautomatik ASC_freezeTemp 3
</pre>{{Hinweis|Achtung: Für jede weitere Sensor-Information (z.B. zu Regen oder Wind) muß ein eigenes Device verwendet werden. Sollen unterschiedliche Readings desselben Sensors ausgewertet werden, müssen diese in ein eigenes Device übertragen werden, z.B. über einen readingsProxy mit gesetztem event-on-update-reading-Attribut (sonst triggert dieser nicht bei Aktualisierung des Readings)!}}

tbd:
* Rain
* Wind
==== Konfiguration der Rollladendevices ====
{{Hinweis|Positionen dürfen sich innerhalb eines Rollos nicht überschneiden - Auch ASC_Closed_Pos 100 ASC_Shading_Pos 98 ASC_ComfortOpen_Pos 97 usw... sind bereits unterschiedliche Positionen.}}

===== Fahrzeiten =====
Zur Konfiguration der Fahrzeiten bietet es sich an, eine ReadingsGroup zu nutzen, wie unter [[#Hilfsmittel|Hilfsmittel]] dargestellt. Alternativ kann man die Zeiten auch manuell in den einzelnen Rollläden hinterlegen.
===== Bewohner =====
Wird ein Raum von einer oder mehreren bestimmten Person/en bewohnt oder gibt es ein Sammel-Gerät für mehrere Bewohner, kann dies mit den Attributen ''ASC_Roommate_Device'' und ''ASC_Roommate_Reading'' einem Rollladen zugeordnet werden. Ist einer der Bewohner ''asleep'', wird morgens erst geöffnet, wenn auch der letzte Roommate nicht mehr ''asleep'' ist.
===== Fensterkontakte =====
Dann werden ggf. vorhandene Fensterkontakte mit ''ASC_WindowRec'' zugeordnet und der Sensortyp mit ''ASC_WindowRec_subType'' festgelegt. Im Falle von threeState-Sensoren wird das übergreifende ''ASC_autoShuttersControlComfort'' beachtet, wobei dann bei vollständiger Öffnung des Fensters auf den in ''ASC_ComfortOpen_Pos'' festgelegten Wert gefahren wird.
===== Frostschutz =====
Zuletzt können die Attribute ''ASC_Antifreeze'' und ''ASC_Antifreeze_Pos'' festgelegt werden, wenn die Frostschutzfunktion aktiviert werden soll.

=== Beschattung ===
==== Konfiguration des ASC-Devices ====
IM ASC DEVICE das Reading "controlShading" mit dem Wert on, sowie ein Astro/Twilight Device im Attribut "ASC_twilightDevice" und das Attribut "ASC_tempSensor".

==== Konfiguration der Rollladendevices ====
Ihr benötigt einen Helligkeitssensor als Attribut "ASC_BrightnessSensor", sofern noch nicht vorhanden. Findet der Sensor nur für die Beschattung Verwendung ist der Wert DEVICENAME[:READING] ausreichend.
Alle weiteren Attribute sind optional und wenn nicht gesetzt mit Default-Werten belegt. Ihr solltet sie dennoch einmal anschauen und entsprechend Euren Gegebenheiten setzen. Die Werte für die Fensterposition und den Vor- Nachlaufwinkel ''(ASC_Shading_InOutAzimuth)'' sowie die Grenzwerte für <code>''ASC_shading_StateChange_SunnyCloudy''</code> solltet ihr besondere Beachtung dabei schenken.

==== Bedingungen ====
Damit die Beschattung startet müssen '''alle''' Bedingungen erfüllt sein. Entschattet wird sobald '''einer''' der Bedingungen wegfällt und die Zeit aus <code>ASC_Shading_WaitingPeriod</code> abgelaufen ist.

Der Sonnensensor <ASC_BrightnessSensor> muss mindestens 2 Messwerte liefern, bevor das ASC-Modul in die Beschattungsposition fährt! Beim (zeitlich gesehen) ersten Messwert wird der Zustand ''in-reserved'' eingenommen und erst beim zweiten Messwert dann der Zustand ''in shading'' eingenommen. Die Anzahl der Messwerte ist abhängig vom "moving average window", der mit dem dritten Parameter des Attributs ''ASC_Shading_StateChange_SunnyCloudy'' konfiguriert wird.

'''Von Standardwerten ausgehend ist nachfolgender Ablauf angestrebt:'''
# Ein Event vom Astro oder Helligkeits Device kommt -> sind alle Werte innerhalb des Arbeitsbereiches, ändert sich der ASC Info-Zustand im Rollo von xx auf „in reserved“ (Beschattung vorbereitet)
# Ein erneutes Event vom Astro oder Helligkeits Device kommt -> Überprüfung der Werte -> sind diese weiterhin gegeben folgt der Wechsel von „in reserved“ auf „in“ (Beschattung aktiv)
# Bei Verwendung von ''ASC_Shading_StateChange_SunnyCloudy'' ist zu beachten, dass ein Durchschnitt über die letzten drei Brightness Events gerechnet wird. Möchte man das vermeiden muss man SUNNY:CLOUDY 1[2] setzen.
# Die Zeiten ''ASC_Shading_WaitingPeriod'' und ''ASC_BlockingTime_afterManual'' können hier zusätzlich für eine Verzögerung sorgen.
'''Wichtig zu beachten:''' Es müssen immer mehrere (mind. 2) Events für den Betrieb erfolgen. In den Standardeinstellungen vom Astro Modul erfolgt dieses z.B. nur 1 x pro Stunde. Kommt also ein Helligkeits-Event auch nur 1x pro Stunde, könnte es 2 Std dauern, bis die Beschattungsfunltion greift.

Wenn das Rollo einmal aus der Beschattung manuell (im Rollo Device muss bei ''ASC_ShuttersLastDrive manuel'' stehen gefahren wurde wird das Rollo erst wieder nach einer Entschattung und erneuter Beschattung gefahren. Also es muss einmal shading out kommen und beim nächsten shading in fährt er dann wieder.

=== Weitere Funktionen ===

==== '''Beschreibung WeekendHoliday Funktion im Brightnessbetrieb.''' ====
Wenn Wochenende oder Feiertag ist und WeekendHoliday aktiviert wurde und im Rollo das Attribut ASC_Time_Up_WE_Holiday gesetzt ist dann wird ausschließlich zur angebenden ASC_Time_Up_WE_Holiday Zeit gefahren ungeachtet des Brightnesswertes.

==== Privacy ====
Werden hierfür Werte festgelegt, werden die betreffenden Rollläden die festgelegte Zeit/Helligkeit vor dem abendlichen Schließen vorab teilweise geschlossen. Dies kann z.B. gewünscht sein, um Rollläden zur Straße hin mit viel Fußgängerverkehr zwar nicht vollständig abzudunkeln, aber gleichzeitig zu verhindern, dass von außen in Wohnräume geschaut werden kann, sobald dort das Licht angeschaltet wird

==== BlockingTime====
Bewirkt, dass nach einer manuellen Fahrt, eine vom ASC Modul initiierte Fahrt zunächst ausgesetzt wird, bis die im Attribute angegebene Zeit überschritten ist. Erst dann wird eine vom ASC Modul initiierte Fahrt tatsächlich durchgeführt.
Genau so wird ein Hochfahren eines Rollos durch das ASC Modul nicht mehr ausgeführt, wenn es innerhalb der Zeit von ASC_BlockingTime_beforNightClose und das Runterfahren wird nicht mehr erfolgen, wenn es innerhalb von ASC_BlockingTime_beforDayOpen ist.
Beispiel: Meine Tochter geht früh außer Haus und Ihre Rollos sind nicht hochgefahren. Diese fahren auch nicht mehr hoch, da die ausschließlich bei home (anwesend) fahren sollen. Nun kommt sie am Nachmittag um 16:23 Uhr nach Hause. Eigentlich sollten nun die Rollos fahren. Doch die Sonnenuntergangsfahrt (schließen) wäre schon 16:51 Uhr und damit innerhalb der 3600 ASC_BlockingTime_beforNightClose. Die Rollos bleiben also unten. Es lohnt sich für die paar Minuten einfach nicht mehr.

==== wiggle====
Mit einem <code>set <ASC-Device> wiggle</code> können alle Rollladen mit einem entsprechenden Attribut zu einer kurzen Fahrt veranlasst werden, nach Ablauf von einer Minute wieder um denselben Wert zurück. Dabei wird jeweils in die Richtung gefahren, die den weiteren Weg ermöglicht. Wenn also zu 70% geschlossen ist, wird der Rollladen hoch fahren.
==== Partymode ====
Dieser wird am ASC-Device selbst aktiviert mittels <code>set <ASC-Device> partyMode on</code>. Alle Rollladen-Devices, welche das Attribut ''ASC_Partymode'' auf ''on'' gestellt haben, werden nicht mehr gesteuert. Der letzte Schaltbefehl, der durch ein Fensterevent oder Bewohnerstatus an die Rollläden gesendet wurde, beim Beenden des Modus durch <code>set ASC-Device partyMode off</code> ausgeführt.
==== lock-out ====
Man kann mit dem Befehl <code> set <ASC-Device> hardLockOut</code> auf einen Schlag alle Rollos sperren welche <code> attr <ROLLO-Device> ASC_LockOut hard</code> gesetzt haben.
Das ist dafür gedacht, wenn Du eine gewisse Zeit den Rolloaktor sperren willst. Zum Beispiel das die Kinder nicht schalten sollen.

== Sonstige Hinweise und Problemlösungen ==
* Werden Attribute geändert, kann es vereinzelt vorkommen, dass das ASC-Modul dies nicht mitbekommt und das tatsächliche Verhalten nicht den Erwartungen entspricht. In so einem Fall empfielt es sich, das NOTIFYDEV nochmals aufbauen zu lassen. Dazu werden zunächst mit <code>set <ASC-Modul> expert 1</code> erweiterte Informationen bezüglich des NotifyDevs unter set und get aktiviert und anschließend ein <code>set <ASC-Modul> createNewNotifyDev</code> ausgeführt.

* Hin und wieder berichten Nutzer davon, wenn Sie die ''Privacy Funktion'' nutzen, dass sich im NOTIFYDEV anstelle des Device Namen ein Raumname befindet. Diese Problem kann damit gelöst werden, dass in dem betroffenen '''Rollo Device''' das Atribut <code>attr event-on-change .*</code> gesetzt wird.
'''Wichtig!''' Nicht verwechseln mit dem ASC Device dort darf <code>attr event-on-change</code> '''nicht''' gesetzt sein!
* Wenn mehrere Rollladen gleichzeitig den Fahrbefehl bekommen, kann es (z. B. bei zwave) dazu kommen, dass ein Rollladen seinen Befehl nicht bekommt. Dies kann durch eine zeitverzögerte Aussendung der Fahrbefehle vermieden werden. Dazu in den jeweiligen Rollo Devices das Attribut ASC_Drive_DelayStart wie folgt benutzen im: ersten Rollo Device braucht das Attribut nicht gesetzt werden, im zweiten Rollo Device im Attribut ASC_Drive_DelayStart dann 4 Sekunden eintragen, im dritten Rollo Device im Attribut ASC_Drive_DelayStart 8 Sekunden eintragen, usw. Ein Abstand von 3-4 Sekunden ist dabei zielführend.

==== Spezielle Hardware ====
{{Link2Forum|Topic=101182|LinkText="Thread zu getesteter Hardware im Forum"}}

== Weblinks ==
* {{Link2Forum|Topic=92628|LinkText="Thread zum Modul im Forum"}}
* {{Link2Forum|Topic=90751|LinkText="Thread zur Entwicklung im Forum"}}
* {{Link2Forum|Topic=73964|LinkText="Thread zu den Scripten von user cluni"}}, die der Entwicklung des Moduls zugrunde liegen
* Daten zum Sonnenstand z.B. hier https://www.sonnenverlauf.de/

<references />

[[Kategorie:Code Snippets]]
[[Kategorie:Rollladensteuerung]]

Micropelt iTRV Kleinstellantrieb

2021-02-01T08:23:14Z

Cwagner: Attribut pidDeltaTreshold beschrieben

{{Infobox Hardware
|Bild=ITRV.jpg
|Bildbeschreibung=Batterieloser Heizungssteller
|HWProtocol=EnOcean
|HWType=Aktor
|HWCategory=EnOcean
|HWComm=EnOcean Funk, 868Mhz
|HWProtokoll=EnOcean Protokoll EEP A5-20-01 (Ventil Position in %)
|HWChannels=1 (bidirektional)
|HWVoltage=3.7 V, LiOn-Akku
|HWPowerConsumption=
|HWPoweredBy=TEG (Thermoelektrischer Generator;autark)
|HWSize=59 × 64 × 59 [mm] (Breite × Höhe × Tiefe), Gewicht 260 g
|HWDeviceFHEM=[http://fhem.de/commandref.html#EnOcean EnOcean]
|HWManufacturer=Micropelt GmbH
}}

'''EnOcean-Micropelt iRTV-Kleinstellantrieb''' ist ein batterieloser Kleinstellantrieb für Raumtemperaturregelung. Hier wird vorrangig das Modell MVA-002 beschrieben.
Das Modell MVA-004 ist rund und hat einen eigenen PID-Controller, das Modell MVA-005 (ebenfalls rund) hat zusätzlich eine Handverstellung in Ein-Grad-Schritten (bis +/- 5°). Beide Modelle sind noch leiser und sollen laut Hersteller bei schwacher Funkversorgung die Verbindung besser halten. Das Modell MVA-005 hat das EEP A5-20-06, das seit 21.1.2019 von FHEM unterstützt wird.

== Features ==
Kleinstellantrieb, der ohne Batterien auskommt, da er über einen thermolektrischen Generator seine Energie aus der Temperaturdifferenz des Heizungsvorlaufes und der Raumtemperatur bezieht.

== Hinweise zum Betrieb mit FHEM ==

=== Definition/Anlernvorgang ===
4BS-Bidirektionales-Teach-In:

#falls vorhanden, alle bisherigen FHEM Devices des Aktors löschen und nach Speichern der geänderten Konfiguration FHEM neu starten
#FHEM in Lernmodus versetzen: <code><nowiki>set <IODev> teach <time [s]></nowiki></code>
#Taster am iTRV zweimal drücken (Montageposition = 0%). Der erfolgreiche Anlernvorgang wird durch einmaliges Aufleuchten der Status-LED quittiert. (Fehlanzeige: 6mal Blinken)
#Nach Montage Taster einmal drücken - das Ventil fährt die von FHEM gewünschte Position an.
#Aktor-Device wird in FHEM automatisch mit allen notwendigen Parametern angelegt.

Standardmäßig nutzt FHEM den eigenen PID-Regler des FHEM-Moduls, der auf die Eingabe einer Temperaturvorgabe wartet:
<code><nowiki>set <name> desired-temp <wert°C></nowiki></code>

Solange kein Referenz-Device mit <code><nowiki>set <name> temperatureRefDev <Temperaturdevice mit einem Reading temperature></nowiki></code> angegeben wurde, benutzt das Gerät einen internen Temperaturfühler, der bauartbedingt nicht (MVA-005:bedingt) geeignet für eine Raumregelung ist.

Zur Sicherheit des Heizkörperventils gegen Festsetzen durch Rost oder Kalk, wird im Sommermodus pro Tag eine Servicefahrt – einmal auf und zu – des Ventils durchgeführt. Zusätzlich wird dreimal am Tag die Verbindung mit FHEM aufgerufen. Das dient zur Kontrolle, dass alle bislang verbundenen Devices noch vorhanden sind und ordnungsgemäß miteinander kommunizieren.

Wenn mehr als dreimal hintereinander die Funkkommunikation mit FHEM fehlschlug (was mehr als 30 Minuten im Normalbetrieb bedeutet), sendet der Aktor nur noch alle Stunde und - falls das Ventil zu weniger als 50 Prozent geöffent ist, wird es auf 50% aufgefahren bzw. bei MVA-004 und MVA-005 im internen PID-Betrieb auf 21° gesteuert.

'''Durch einmaliges Drücken des Tasters''' kann man im Alltagsbetrieb eine sofortige Funkkommunikation auslösen.

{{Hinweis|Zum Energiesparen verarbeitet der Aktor nur alle 586 oder 587 Sekunden (Sommermodus: alle 8 Stunden) Telegramme von FHEM. Darum zeigen FHEM-Befehle keine sofortige Aktorreaktion, sondern erst nach der genannten Zeitspanne. Die Rückmeldung des Aktors an FHEM über die erfolgte Befehlsausführung erfolgt wiederum erst nach erneutem Ablauf der Zeitspanne.
Falls keine Temperaturdaten geliefert werden, geht das Device in einen Stromsparmodus und fragt nur noch alle 2 Stunden an.
Zur Vermeidung dieses Stromsparmodus, in dem eben auch nicht nachgeregelt wird, sollte bei Referenzgeräte wie einem Raumthermometer das attr event-on-update '''nicht''' benutzt werden. Falls die Temperatur sich 1 Stunde lang nicht ändert, würde entsprechend auch eine Stunde lang kein Referenzwert gesendet, der Stelltrieb in den Sparmodus gehen und für die nächsten 2 Stunden nun kommende Änderungen nicht verarbeiten.
In der Praxis mit einem TCM 310 zeigt sich, dass bei einem RSSI<-80 die Funkkommunikation nicht ausreichend stabil ist. Wenn dreimal hintereinander keine Funktbestätigung erhalten wurde, geht der Aktor in den Notbetrieb und öffnet das Ventil auf 50% oder lässt es auf einem gesetzten größeren Wert bis zur nächsten erfolgreichen bisdirektionalen Kommunikation offen. Das Anpassen der Antennenausrichtung ist hier sehr wichtig.}}

=== Settings ===
{| class="wikitable sortable"
|-
! set !! Wertebereich/Default !! Beschreibung
|-
|desired-temp||10...30||Soll-Temperatur für den FHEM-PID-Controler, der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet
|-
|liftSet||||??
|-
|runInit||||beim nächsten Funkkontakt wird ein Kalibrierungslauf angestoßen
|-
|setpoint||0...100||Setze Aktorposition auf X%; der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet, wenn das attr pidCtrl on ist
|-
|setpointTemp||10...30||Soll-Temperatur für den FHEM-PID-Controler, der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet; ein runInit wird ausgelöst wenn das attr pidCtrl on ist
|-
|ValveCloses||||Ventil auf 0% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|ValveOpens||||Ventil auf 100% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|}

=== Readings ===
{| class="wikitable sortable"
|-
! Reading !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|actuatorState||ok||||wenn 'obstructed', dann ist der metallene Kühlring des Gehäuses z.b. von einem Vorhang bedeckt und der Thermogenerator kann nicht richtig arbeiten
|-
|alarm||no_response_from_actuator||||nur fallweise: wenn Kommunikation ausgefallen; Aktor blinkt dreimal
|-
|battery||ok ||'''ok''' / low||
|-
|cover||closed||||wird vom MVA-002 nicht gesendet
|-
|delta||-9.75||||
|-
|energyInput||enabled||'''enabled''' / disabled||enabled zeigt ausreichende Temperaturdifferenz zur Speisung des Akkus an
|-
|energyStorage||charged||'''charged''' / empty ||
|-
|maintenanceMode||off||'''off''' / runinit||
|-
|operationMode||setpointTemp||'''setpointTemp''' / summerMode / setpointSet||'''Betrieb mit Stellwert-Vorgabe''' / im Sommer-Modus / mit Temperatursollwert-Vorgabe
|-
|operationModeRestore||setpointTemp||||nur fallweise: Modus, der beim Beenden des summermode gesetzt wird
|-
|pidAlarm||||actuator_in_errorPos / dead_sensor / no_temperature_value / setpoint_device_missing||
|-
|pidState|||| processing |alarm / idle / '''processing''' / start / stop||
|-
|p_d||0||||
|-
|p_i||100||||
|-
|p_p||-487.5||||
|-
|roomTemp||22.0||||interne MVA-002-Temperatur (wenn attr setpointRefDev nicht gesetzt wird diese Temperatur benutzt - ist für Regelung nicht brauchbar wegen Verfälschung durch Vorlauftemperatur, höhere Temperaturen sind Indiz für Wärmeangebot vom Vorlauf, das den Energiespeicher lädt)
|-
|selfCtrl||off||||MVA-002 hat keinen eigenen PID-Controler
|-
|setpoint||0||||beim letzten Funkkontakt gemeldete Ist-Position vom Aktuator in %
|-
|setpointSet||15||||beim nächsten Funkkontakt gesendete Aktuatorstellung in %
|-
|setpointTemp||15.0||||Soll-Temperatur. Kann gesetzt werden über <code><nowiki>set <IODev> desired-temp <°C></nowiki></code> oder auch durch Module wie Heating_Control oder WeekdayTimer
|-
|setpointTempRestore||16.0 ||||nur fallweise: setpointTemp, die bei Beenden des summermode gesetzt wird
|-
|state||T: 23.4 SPT: 15.0 SP: 0||||T:=Raumtemperatur vom Referenzsensor, SPT=setpointTemp, SP=setpoint
|-
|teach||4BS teach-in accepted EEP A5-20-01 Manufacturer: Micropelt GmbH||||
|-
|temperature||24.75||||zuletzt gemeldete Raumtemperatur vom Referenz-Sensor (siehe Attribut temperatureRefDev)
|-
|waitingCmds||runInit|||noch nicht gesendetes Kommando, hier Kalibrierungslauf|
|-
|wakeUpCycle||240|||das Gerät meldet sich alle 4 Minuten|
|-
|window||closed||open / '''closed'''||wird vom MVA-002 nicht gesendet
|-
|}

=== Attribute ===
{| class="wikitable sortable"
|-
! Attribut !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|comMode||biDir||||
|-
|destinationID||unicast||||
|-
|eep||A5-20-01||||MVA-002 bis MVA-004; beim MVA-005 A5-20-06
|-
|manufID||049||||
|-
|pidActorErrorPos||20||||MVA-002 ignoriert diesen Wert und benutzt '''50%''' oder den zuvor gesendeten höheren Stellwert
|-
|pidActorLimitLower||1||||bei 0% Öffnung wird eine Initialisierung ausgelöst?
|-
|pidCtrl||on||||bei on wird der FHEM Pid-Controler benutzt, bei off der im Actor (Modell MVA-002 hat keinen internen PID-Controler, wohl aber MVA-004 und MVA-005)
|-
|pidFactor_I||0.2||||
|-
|pidFactor_P||50||||
|-
|pidSensorTimeout||3600|||| Zahl der Sekunden, in denen der Sensor auf einen Wert vom temperatureRefDev auf einen Wert wartet, sonst Alarm
|-
|pidDeltaTreshold
|2
|1
|Minimaler Veränderukng der Aktorstellung in Prozent
|-
|rcvRespAction||||||Hier kann eine Aktion eingetragen werden, die bei Rückmeldung des Aktors durchgeführt wird. Details in der FHEM-Referenz
|-
|setpointRefDev||||||Das Device, das die Ventilöffnung (Aktuator) vorgibt, z.B. ein Raumregler, FHEM-PID20. Typischerweise '''nicht gesetzt, es wird der modul-eigene PID-Controler benutzt'''
|-
|setpointSummerMode||2||||Ventilöffnung, die im Sommer gelten soll
|-
|setpointTempRefDev||CC.Kueche||||Eintragen, wenn ein Device, die Solltemperatur vorgibt, z.B. Heating_Control oder ein physischer Raumthermostat, der in FHEM ausgelesen wird.
|-
|subDef||********||||Sender-ID
|-
|subType||hvac.01||||bei MVA-002 bis MVA-004: hvac.01; bei MVA-005: hvac.06
|-
|summerMode||off||||
|-
|teachMethod||4BS||||
|-
|temperatureRefDev||T.Kueche||||Das Device, das fortlaufend die Ist-Temperatur meldet
|-
|webCmd||setpointTemp||||
|-
|}

== Tipps & Tricks ==
Fehlermeldungen wie Sensor dead oder no Response from actuator kann man im Betrieb mit einem externen Sensor verhindern, in dem man mindestens alle 5 Minuten einen Temperaturwert sendet (gegebenenfalls mit attr event-min-interval im sendenden Temperatur-Device einstellen). Alternativ kann man auch über ein DOIF alle 24 Stunden den Wunschwert mit <Code>set <Devicename> desired-temp 20</Code> wiederholen, wobei 20 beispielhaft eine Wunschtemperatur ist.

Für eine stabile Funkkommunikation ist ein RSSI von besser als -80 anzustreben. Eine Verbesserungsmöglichkeit bietet das versuchsweise Drehen des Micropelt am Heizkörper um 90°. Normalerweise ist der geprägte Schriftzug Micropelt waagerecht wie auch die innen liegende Antenne. Nach der Drehung steht diese dann aufrecht. Das passt in der Praxis dann manchmal besser zu einer waagerecht angeordneten Senderantenne, deren Leistung sich dann gezielter im Haus verbreitet. Ein RSSI von -70 ist besser als -80.
Die Empfangsqualität aller EnOcean-Geräte lässt sich schnell mit <Code>list .* TCM_ESP3_0_RSSI</Code> abfragen, wobei TCM_ESP3_0 der Name des EnOcean-Gateways ist.

== ToDos ==
event-on-NN beim Sensor, wakeupCycle

Sorgt Setpoint 0 für eine Initialisierung?

Optimierung von p_i,p_d,p_p in der Praxis

Bedeutung von set <name> liftSet

== Links ==
* {{Link2Forum|Topic=34314|Message=290203|LinkText=Forenbeitrag}}

[[Kategorie:EnOcean Components]]
[[Kategorie:Heizungsventile]]

Event-on-change-reading

2021-01-15T16:10:56Z

Cwagner: Entfernung der nachfolgenden Leerzeichen in Listenaufzählungen des Attributes gem. dieser Diskussion: https://forum.fhem.de/index.php?topic=60557.0

{{SEITENTITEL:event-on-change-reading}} 


Mit dem Attribut [[event-on-change-reading]] kann für Readings eines Gerätes festgelegt werden, dass nur bei einer Wertänderung ein Event (und damit in der Regel auch ein Log-Eintrag) erzeugt werden soll und nicht bei jedem turnusmäßigen Update des Gerätes.

Wird ''event-on-change-reading'' für ein einzelnes Reading gesetzt, werden zunächst alle übrigen Readings nicht mehr protokolliert, erzeugen also keine Events mehr.

== Einführung ==
Grundsätzlich senden Geräte ihre Readings dann, wenn ein Ereignis zu einer Statusänderung führt, also z.b. ein Schalter betätig wird. Allerdings senden die meisten Geräte auch immer Zusatzinformationen, etwa den Batteriestatus, Zieltemperatur, Pairingstatus, PeerList etc.etc.; meist sogar in bestimmten Intervallen (Update) auch ohne das das Reading sich ändert. Einige Geräte wie z.b. Shelly Plugs sind sehr "gesprächig" und senden auch den Status des Tasters mit jedem Update, selbst wenn der Schaltzustand sich nicht ändert.

Dies hat einige Nachteile:
* Aufblähen des Logfiles
* höhere Last der FHEM-Installation, da ein Event vom GeraetXXXX zunächst alle Notifys in FHEM benachrichtigt (d.h. notify, FileLog, sequence, watchdog, DOIF, etc), auch wenn diese mit dem Event nichts anfangen können.
* Konstrukte der Art <code><nowiki>… notify GeraetXXXX:wert …</nowiki></code> werden unter Umständen immer wieder im Update-Intervall ausgelöst, obwohl der Schaltzustand sich nicht geändert hat. (z.b. bei Shelly Plugs)
* EvenMonitor bzw. Telnet ''Info Timer'' mitunter unübersichtlich

Mit event-on-change-reading lässen sich für Readings eines Gerätes festgelegt, dass nur bei einer Wertänderung ein Event erzeugt wird und nicht mit jedem Update. Dies adressiert alle oben genannten Nachteile.

Allerdings kann die Nutzung von ''event-on-change-reading'' auch selbst Probleme erzeugen:
* Es muss überlegt werden, ob die eigene FHEM Installation an manchen Stellen in bestimmten Intervallen Meldungen benötigt, auch wenn die Werte sich nicht ändern. Dies sind typischerweise Graphen.
* Wird ''event-on-change-reading'' für ein einzelnes Reading gesetzt, erzeugen alle übrigen Readings des Gerätes keine Events mehr, '''auch nicht wenn Werte sich ändern'''.

Um das Verhalten von event-on-change-reading zu modifizieren und diese Probleme zu lösen, stehen ausserdem die Attribute [[event-on-update-reading]] (Reading soll mit jedem Update gesendet werden, auch wenn es sich nicht geändert hat) und [[event-min-interval]] ((Reading soll mit Update gesendet werden, wenn seit der letzten Meldung ZeitspanneX vergangen ist) zur Verfügung.

== Syntax ==
Das ''event-on-change-reading'' Attribut wird in der folgenden Weise spezifiziert:
:<code><nowiki>attr <device> event-on-change-reading reading1[:threshold][,reading2[:threshold]...n]</nowiki></code>
Die zu berücksichtigenden Readings sind als durch Komma getrennte Werte anzugeben, können aber auch über reguläre Ausdrücke zusammengefasst werden.

Insbesondere sinnvoll ist der reguläre Ausdruck .* , der alle Readings umfasst:
:<code><nowiki>attr <device><nowiki>event-on-change-reading .*</nowiki></code>
So formuliert führt das Attribut dazu, dass alle Readings noch Events erzeugen, aber nur wenn diese sich im Wert ändern.

Mit Threshold ist optional ein Wert angegebbar, um den das "neue" Reading größer oder kleiner sein soll als das vorherige, um ein Event auszulösen. So löst
:<code>attr event-on-change-reading temperature:0.4,humidity:2 </code>
nur bei Änderungen der Temperatur um mindestens 0,4 Grad oder Änderung der Luftfeuchtigkeit von 2 % ein Event aus (und damit einen Eintrag ins Logfile). Threshold ist besonders sinnvoll bei sehr fein auflösenden Sensoren, um z.b. zu verhindern, das jede Temperaturschwankung um 0,1 Grad ein Event auslöst.

== Wechselwirkungen ==
Wie oben erwähnt steht das Attribut in Wechselwirkung mit den Attributen ''timestamp-on-change-reading'' [[event-on-update-reading]] und [[event-min-interval]], die das Verhalten modifizieren. Dies ist beim Einsatz zu berücksichtigen.

Sind bei einem Device weder ''event-on-change-reading'' noch ''event-on-update-reading'' spezifiziert, werden für alle Readings sowohl bei Änderung als auch bei der Aktualisierung (Update mit dem gleichen Wert) Events erzeugt (Default Verhalten). Sobald jedoch eines der beiden Attribute gesetzt ist, müssen alle Readings, die protokolliert werden sollen bei (mindestens) einem der Attribute berücksichtigt sein.

Ist für ein Reading sowohl ''event-on-change-reading'' als auch ''event-on-update-reading'' spezifiziert, wird bei jeder Aktualisierung des Readings ein Event erzeugt, das ''event-on-change'' wird für dieses Reading also außer Kraft gesetzt bzw. "überstimmt".

== timestamp-on-change-reading ==
Ist nur event-on-change-reading für ein Reading spezifiziert, entfällt zunächst einmal nur der Trigger, der Zeitstempel wird weiter aktualisiert. Benötigt man jedoch den Zeitstempel der letzten Änderung (z.B. die Ein- oder Ausschaltzeit eines Relais), kann man mithilfe von ''timestamp-on-change-reading'' auch die Aktualisierung des Zeitstempels unterbinden, falls der Wert sich nicht geändert hat.

== Beispiel ==
In einer einfachen Anwendung kann, um alle Readings eines Gerätes nur bei Änderungen zu verarbeiten, das Attribut folgendermaßen gesetzt werden:
:<code><nowiki>attr <device> event-on-change-reading .*</nowiki></code>
Zusätzlich kann mit
:<code><nowiki>attr <device> event-min-interval .*:3600</nowiki></code>
dafür gesorgt werden, dass jede Stunde auch ohne Werteänderung die Readings dennoch verarbeitet werden, also in z.b. in das Logfile geschrieben werden (findet FHEM zu wenige Ereignisse pro betrachteter Zeitspanne, bleiben Graphen leer oder werden nur teilweise gezeichnet (Plotabriss)).

Das obige Kombination der Attribute führt also dazu, dass ein Event wird erzeugt wird, wenn der neue Wert wirklich abweichend vom alten Wert ist '''oder''' mindestens ''min-interval'' Sekunden seit dem letzten Event vergangen sind.

Achtung: dies löst wie oben beschrieben ggf. Konstrukte wie <code><nowiki>… notify GeraetXXXX:wert …</nowiki></code> aus.

Um ein Threshold für nur eine Reading zu setzen:
:<code>attr <device> <device> event-on-change-reading Temp.*:0.4,.*</code>
Alle Readings, die mit Temp beginnen, erzeugen nur ein Event, wenn die Änderung >0.4 Grad ist. Alle anderen Readings erzeugen bei jeder Änderung ein Event.

Nur ein Reading mit Threshold berücksichtigen:
:<code><nowiki>attr <device> <device> event-on-change-reading Temp.*:0.4</nowiki></code>
Alle Readings, die mit Temp beginnen, erzeugen nur ein Event, wenn die Änderung >0.4 Grad ist. Alle anderen Readings erzeugen keine Event, auch nicht bei Werteänderung.

Mit [[event-on-update-reading]] und [[event-min-interval]] kann das Verhalten verfeinert werden.

== Siehe auch ==
*{{Link2Forum|Topic=26694|Message=196955|LinkText=Forenbeitrag}}
*[[event-on-update-reading]]
*[[event-min-interval]]
*[[event-aggregator]]

== Links ==
* Benutzungstipps (''Best Practice'') für das Attribut in {{Link2Forum|Topic=36522|LinkText=diesem Forenthread}}

[[Kategorie:Attribut (allgemeingültig)]]

AutoShuttersControl

2020-07-18T06:10:57Z

Cwagner: Anpassung Bezeichnung Attribut ASC_DriveDelay

{{Baustelle}}
{{Infobox Modul
|ModPurpose=Steuerung von Rollläden
|ModCategory=Automatisierung
|ModType=d
|ModForumArea=Automatisierung
|ModTechName=73_AutoShuttersControl.pm
|ModOwner=CoolTux ({{Link2FU|13684|Forum}}/[[Benutzer Diskussion:CoolTux|Wiki]])}}

Mit [[AutoShuttersControl]] oder kurz ASC können typische Aufgabenstellungen im Zusammenhang mit Rollläden u.ä. automatisiert werden, wie zum Beispiel das Öffnen bei Sonnenaufgang, Schließen bei Sonnenuntergang oder das Anfahren von Lüftungspositionen beim Öffnen des zugehörigen Fensters.

== Basics ==
{{Hinweis|Das Modul befindet sich derzeit noch in der Entwicklung; der jeweils aktuelle Stand ist diesem {{Link2Forum|Topic=90751|LinkText="Thread im Forum"}} zu entnehmen.}}
Zur Nutzung des Moduls sollten folgende andere FHEM-Devices vorhanden sein:
* Rollläden
* Fensterkontakte und
* Bewohnerstatus auf Basis von Residents/Roomates in englisch. Ersatzweise andere Devices, z.B. Dummys, welche als ''state'' ''home'', ''absent'', ''asleep'', ''gotosleep'' und ''awoken'' setzen sowie ein Reading ''lastState''.
* Optional:
** Ein Helligkeitssensor (Steuerung nach Helligkeit und Beschattung)
** Ein Device zur Bestimmung des Sonnenstands (nur für Beschattung). Unterstützt werden derzeit [[Modul Astro|Astro]] und [[Twilight]]<ref>Dabei müssen ggf. in [[Global|global]] auch Angaben zu ''longitude'' und ''latitude'' vorhanden sein</ref>.
** Wenn Feiertage berücksichtigt werden sollen: Ein oder mehrere {{Link2CmdRef|Anker=holiday2we|Lang=en|Label=holiday2we}}-Angaben in [[Global|global]] samt entsprechender [[Wochenende, Feiertage und Schulferien#Feiertage mittels holiday-Datei|holiday]]-Dateien<ref>Es kann auch z.B. ein Dummy-Device verwendet werden, dieses sollte dann aber neben dem eigentlichen Feiertags-''state'' auch in einem Reading ''tomorrow'' Angaben zu anstehenden Feiertagen enthalten.</ref> <ref>Bitte verfahren Sie entsprechend, wenn Urlaubs- oder Ferientage wie Feiertage behandelt werden sollen.</ref>.

Die Einrichtung des Moduls bzw. dessen Funktionalität erfolgt in mehreren Schritten:
* Definition des ASC-Devices
* Einstellung zentraler Vorgaben am ASC-Device
* Markieren der zukünftig zu steuernden Rollladen-Devices
* Einbinden der Rollladen-Devices in das ASC-Device
* Einstellen der individuellen Vorgaben je Rollladen (am Rollladen-Device)
Dabei geht man am einfachsten schrittweise vor und erweitert die Funktionalität nach und nach um die gewünschten Funktionen. Dann benötigt man jeweils nur einen kleinen Teil der vielen per Attribut einstellbaren Optionen, und kann die Auswirkungen der jeweiligen Änderung besser nachvollziehen.

== Einrichtung ==
{{Hinweis|ASC kann auch verwendet werden, um lediglich Teilaufgaben der Rollladensteuerung zu erfüllen, also z.B. nur das morgendliche Öffnen der Rollläden. Allerdings geht dabei ein erheblicher Teil des Komforts verloren, der dadurch entsteht, dass die Steuerung innerhalb der vollintegrierten Lösung jeweils nachvollzieht, aus welchem Grund eine Fahrt erfolgt war und dies ggf. bei der nächsten Aktion berücksichtigt.}}

=== Vorbereitung ===
Zunächst sollten die in den [[#Basics|Basics]] beschriebenen Geräte vorhanden und funktionsfähig sein.

=== Define des ASC-Devices ===
Es genügt ein einfaches define ohne weitere Parameter.
<code>define <name> AutoShuttersControl</code>
Dies bewirkt neben der Anlage des Devices selbst auch, dass als weiteres globales Attribut ''ASC'' verfügbar wird.

=== Einstellung zentraler Vorgaben ===
Es stehen am ASC-Device einige Attribute zur Verfügung, über die sich das Verhalten des ASC-Devices insgesamt steuern lässt, z.B. zur Vermeidung von morgendlichen oder abendlichen Fahrten sowie bei Gefahr von Schäden an den Rollläden durch Frost oder zur Reaktion auf Fensterkontakte. Details sind der Commandref zu entnehmen.
Diese Attribute können auch nachträglich noch geändert werden.

=== Markieren zu steuernder Rollladen-Devices ===
Um einen oder mehrere Rollläden durch das ASC-Device zu steuern, wird für jeden Rollladen jeweils das neue globale Attribut ''ASC'' gesetzt. Der Wert ist mit 1 oder 2 festzulegen, wobei '''1''' bedeutet, dass
* die Offen-Position kleiner ist als die Geschlossen-Position, also typischerweise 0 ''offen'' bedeutet und 100 für ''geschlossen'' steht
* eine bestimmte Position mit '''position''' angefahren wird, also z.B. <code>set <name> position 70</code>.
Dies ist z.B. die passende Wahl für ROLLO-Devices

Die '''2''' steht für ein umgekehrtes Verhalten und den Befehlsteil ''pct'', also ''offen'' für <code>set <name> pct 100</code>. Typischer Vertreter dieses Typs sind HomeMatic (CUL_HM-) Geräte oder die Shelly2-Aktoren.

Aus dieser Vorgabe leitet das Modul dann jeweils bestimmte Voreinstellungen (''defaults'') für den Rolladen ab, ohne dass die betreffenden, dafür vorgesehenen Attribute ausdrücklich gesetzt werden müssen. Es genügt daher, nur jeweils die Einstellungen zu verändern, die anders gewünscht werden oder für den Rollladenaktortyp anders sein müssen (z.B. ''dim 99'' für vollständiges Öffnen eines ZWave-Aktors).
{{Hinweis|Das Vorstehende gilt jeweils für den nicht-invertierten Modus! Wer z.B. ein HomeMatic-Gerät mit ''levelinverse'' betreibt, sollte ''ASC'' auf "1" setzen usw.. Maßgeblich ist letztlich nur die Frage, ob die Offen-Positionsangabe nummerisch kleiner oder größer als die Geschlossen-Positionsangabe ist; die konkreten Zahlenwerte spielen dabei keine Rolle, die Angabe ''position'' oder ''pct'' kann auch später über ein weiteres Attribut passend eingestellt werden.}}

=== Einbinden in das ASC-Device ===
Nachdem man das obige Attribut bei einem oder mehreren Rollladen-Devices gesetzt hat, kann mit
<code>set <name> scanForShutters</code> ein Suchlauf gestartet werden, mit dem dann diese Rollläden durch das Modul gefunden und in die Steuerungslogik eingebunden werden.

=== Einstellen der individuellen Vorgaben ===
Nach der Einbindung sind an den Rollladen-Devices weitere Attribute verfügbar, mit denen die für den jeweiligen Rollladen geltenden Einstellungen vorgenommen werden können.
Die Beschreibung der Attribute ist in der commandref enthalten.

== Readings ==

===Readings im ASC-Device selbst ===

{| class="wikitable"
|-
! Name !! Datentyp/ Wertebereich !! Bedeutung
|-
|..._nextAstroTimeEvent || || Zeit wird abhängig von der eingestellten Attribute ASC_Time_Up/ASC_Time_Down angezeigt. Bei ''astro'' die Uhrzeit des Sonnenauf- oder Sonnenuntergang, bei ''time'' und ''brightness'' die Zeit aus ASC_Time_Up_Early/ASC_Time_Down_Late pro Rollonamen
|-
|..._lastPosValue || || Position pro Rollonamen bevor ASC die Rolläden verfahren hat
|-
|..._PosValue || ||aktuelle Position pro Rollonamen
|-
|ascEnable||on, off ||globale ASC Steuerung bei den Rollläden aktiv oder inaktiv
|-
|controlShading||on, off ||globale Beschattungsfunktion aktiv oder inaktiv
|-
|hardLockOut || on, off ||Status des hardwareseitigen Aussperrschutzes / gilt nur für Rolläden mit dem Attribut bei denen das Attributs ASC_LockOut entsprechend auf hard gesetzt ist
|-
|selfDefense || on, off ||globale Selbstschutzfunktion aktiv oder inaktiv
|-
|partyMode ||on, off || globaler Partymodus aktiv oder inaktiv
|-
|state || ||Status des ASC-Devices: active, enabled, disabled oder weitere Statusinformationen wie z.B. Grund der letzen Fahrt
|-
|room_... || ||Auflistung aller Rollläden, welche in den jeweiligen Räumen gefunden wurden, Bsp.: room_Schlafzimmer,Terrasse
|-
|sunriseTimeWeHoliday|| on,off ||globale Wochenendunterstützung aktiv oder inaktiv
|-
|userAttrList || rolled out ||Das ASC-Modul verteilt an die gesteuerten Rollladen-Geräte diverse Benutzerattribute (userattr). In diesem Reading kann der Status dieser Verteilung geprüft werden.

|}

=== Readings in den Rolllädendevices ===

{| class="wikitable"
|-
! Name !! Bedeutung
|-
|ASC_Enable ||Status von ASC_Enable (on,off)
|-
|ASC_ShuttersLastDrive ||Grund des letzten Fahrens des Rolladens
|-
|ASC_Time_DriveDown ||Zeit wird abhängig von der eingestellten Attribute ASC_Time_Down angezeigt. Bei astro die Uhrzeit des Sonnenuntergangs, bei time und brightness die Zeit aus /ASC_Time_Down_Late
|-
|ASC_Time_DriveUp ||Zeit wird abhängig von der eingestellten Attribute ASC_Time_Up angezeigt. Bei astro die Uhrzeit des Sonnenaufgangs, bei time und brightness die Zeit aus /ASC_Time_Up_Early
|}

==set- und get-Befehle für das ASC-Device==

=== set-Anweisungen ===
{| class="wikitable"
|-
! Name !! Datentyp/ Wertebereich !! Beschreibung
|-
|advDriveDown ||on, off ||holt bei allen Rollläden durch ASC_Adv on ausgesetzte Fahrten nach
|-
|ascEnable||on, off ||Aktiviert oder deaktiviert die globale ASC-Steuerung
|-
|controlShading||on, off ||Aktiviert oder deaktiviert die globale Beschattungssteuerung
|-
|createNewNotifyDev || ||Legt die interne Struktur für NOTIFYDEV neu an. (Diese Funktion steht nur zur Verfügung, wenn Attribut ASC_expert auf 1 gesetzt ist.)
|-
|hardLockOut ||on, off ||Aktiviert den hardwareseitigen Aussperrschutz für die Rollläden, bei denen das Attributs ASC_LockOut entsprechend auf hard gesetzt ist. Mehr Informationen in der Beschreibung bei den Attributen für die Rollladengeräten.
|-
|partyMode ||on, off ||Aktiviert den globalen Partymodus. Alle Rollladen-Geräten, in welchen das Attribut ASC_Partymode auf on gesetzt ist, werden durch ASC nicht mehr gesteuert. Der letzte Schaltbefehl, der bspw. durch ein Fensterevent oder Wechsel des Bewohnerstatus an die Rollläden gesendet wurde, wird beim Deaktivieren des Partymodus ausgeführt
|-
|renewAllTimer || ||erneuert bei allen Rollläden die Zeiten gemäß ASC_UP/ASC_DOWN und setzt die internen Timer neu.
|-
|renewTimer || ||erneuert bei dem ausgewählten Rolladen die Zeiten gemäß ASC_UP/ASC_DOWN und setzt die internen Timer neu.
|-
|scanForShutters || ||sucht alle FHEM Devices mit dem Attribut ''ASDC'' ''1'' oder ''2'' und legt diese im ASC-Modul an
|-
|selfDefence ||on, off||Aktiviert bzw. deaktiviert die Selbstschutzfunktion. Beispiel 1: Wenn das Residents-Gerät ''gone'' meldet, alle Rollläden dann heruntergefahren. Beispiel 2 : Wenn das Residents-Gerät absent meldet, das Attribut ASC_ShuttersPlace=terrace ist und ein Fenster im Haus noch geöffnet ist, so wird an diesem Fenster der Rollladen dann heruntergefahren.
|-
|shutterASCenableToggle || ||Aktivieren oder deaktivieren der ASC Kontrolle beim einzelnen Rollladens
|-
|sunriseTimeWeHoliday || on,off ||Aktiviert die Wochenendunterstützung und somit, ob im Rollladen das Attribut ASC_Time_Up_WE_Holiday beachtet werden soll oder nicht.
|-
|wiggle ||||bewegt einen oder mehrere Rollläden um einen definierten Wert (Default: 5%) und nach einer Minute wieder zurück in die Ursprungsposition. Diese Funktion könnte bspw. zur Abschreckung in einem Alarmsystem eingesetzt werden.
|-
|||||
|}

=== get-Anweisungen ===

{| class="wikitable"
|-
! Name !! Beschreibung
|-
| showNotifyDevsInformations ||zeigt eine Übersicht der abgelegten NOTIFYDEV Struktur. Diese Funktion wird primär fürs Debugging genutzt. Hierzu ist das Attribut ASC_expert = 1 zu setzen.
|}

== Attribute ==
{{Hinweis|Die Attributnamen haben sich teilweise geändert, nachfolgend ist der Stand von Modulversion v0.8.x wiedergegeben.}}
{{Hinweis|In der commandref findet sich häufig die Schreibweise <code><nowiki>ASC_BrightnessSensor Sensorname[:brightness [400:800]]</nowiki></code>. Dabei sind die Angaben in den eckigen Klammern optional. Dies müssen also nicht angegeben werden, stattdessen verwendet das Modul dann Standardwerte (siehe cref), die in der cref zu findenden Angaben entsprechen dabei den defaults. Werden Werte angegeben, sind die eckigen Klammern '''wegzulassen'''! Beispiel: <code>ASC_BrightnessSensor hm_motion_1 70:100</code> würde das brightness-Reading des Sensors hm_motion_1 verwenden und einen morgendlichen Schwellenwert von 70 bzw. 100 für abends.}}
===Attribute direkt am ASC-Device ===

{| class="wikitable"
|-
! Name !! Datentyp/ Wertebereich !! Default-Wert !! Beschreibung
|-
|ASC_autoAstroModeEvening || ||REAL, CIVIL, NAUTIC, ASTRONOMIC oder HORIZON ||nach welchem ASTRO-Modus soll die Abendfahrt berechnet werden
|-
|ASC_autoAstroModeEveningHorizon || - 9 bis 9 || 0|| Höhe über dem Horizont. Wird nur berücksichtigt, wenn im Attribut ASC_autoAstroModeEvening der Wert HORIZON ausgewählt wurde.
|-
|ASC_autoAstroModeMorning || ||REAL, CIVIL, NAUTIC, ASTRONOMIC oder HORIZON || nach welchem ASTRO-Modus soll die Morgendfahrt berechnet werden
|-
|ASC_autoAstroModeMorningHorizon || - 9 bis 9|| 0|| Höhe über dem Horizont. Wird nur berücksichtigt, wenn im Attribut ASC_autoAstroModeMorning der Wert HORIZON ausgewählt wurde.
|-
|ASC_autoShuttersControlComfort ||on, off || off ||schaltet die Komfortfunktion an. Bedeutet, dass ein Rollladen mit einem threestate-Sensor am Fenster beim Öffnen in eine Offenposition fährt. Hierzu muss beim Rollladen das Attribut ASC_ComfortOpen_Pos entsprechend konfiguriert sein.
|-
|ASC_autoShuttersControlEvening ||on, off || ||Aktiviert die automatische Steuerung durch das ASC-Modul am Abend.
|-
|ASC_autoShuttersControlMorning ||on, off || ||Aktiviert die automatische Steuerung durch das ASC-Modul am Morgen.
|-
|ASC_blockASCDrivesAfterManual ||0, 1 || ||wenn dieser Wert auf 1 gesetzt ist, dann werden Rollläden vom ASC-Modul nicht mehr gesteuert, wenn zuvor manuell eingegriffen wurde. Voraussetzung hierfür ist jedoch, dass im Reading ASC_ShuttersLastDrive der Status manual enthalten ist und sich der Rollladen auf eine unbekannte (nicht in den Attributen anderweitig konfigurierte) Position befindet.
|-
|ASC_brightnessDriveUpDown || || || Werte (z.B. Lux) bei dem Schaltbedingungen für Sonnenauf- und -untergang geprüft werden sollen. Diese globale Einstellung kann durch die WERT-MORGENS:WERT-ABENDS Einstellung von ASC_BrightnessSensor im Rollladen selbst überschrieben werden.
|-
|ASC_debug ||0, 1 || 0||Aktiviert die erweiterte Logausgabe für Debugausgaben (nur nach Aufforderung nutzen)
|-
|ASC_expert ||0, 1 ||0 ||ist der Wert 1, so werden erweiterte Informationen bezüglich des NotifyDevs unter ''set und get'' angezeigt
|-
|ASC_freezeTemp ||-5 bis 5 || ||Temperatur, ab welcher der Frostschutz greifen soll und der Rollladen nicht mehr fährt. Der letzte Fahrbefehl wird gespeichert.
|-
|ASC_rainSensor || || ||DEVICENAME[:READINGNAME] MAXTRIGGER[:HYSTERESE] [CLOSEDPOS] - der Inhalt ist eine Kombination aus Devicename, Readingname, Wert ab dem getriggert werden soll, Hysterese Wert ab dem der Status Regenschutz aufgehoben werden soll und der "wegen Regen geschlossen Position".
|-
|ASC_residentsDev || || ||DEVICENAME[:READINGNAME] - der Inhalt ist eine Kombination aus Devicenamen und Readingnamen des Residents-Device der obersten Ebene (z.B. rgr_Residents:state)
|-
|ASC_shuttersDriveDelay || || ||maximale Zufallsverzögerung in Sekunden bei der Berechnung der Fahrzeiten. 0 bedeutet keine Verzögerung
|-
|ASC_tempSensor || || ||DEVICENAME[:READINGNAME] - der Inhalt ist eine Kombination aus Device und Reading für die Außentemperatur
|-
|ASC_twilightDevice || || ||das Device, welches die Informationen zum Sonnenstand liefert. Wird unter anderem für die Beschattung verwendet.
|-
|ASC_windSensor || || ||DEVICE[:READING] - Sensor für die Windgeschwindigkeit. Kombination aus Device und Reading.
|-
| || || ||
|-
| || || ||
|}

===Attribute in den Rolllädendevices===

{| class="wikitable"
|-
! Name !! Datentyp/ Wertebereich !! Default-Wert !! Beschreibung
|-
|ASC || 0, 1, 2|| ||"kein Anlegen der Attribute beim ersten Scan bzw. keine Beachtung eines Fahrbefehles",1 = "Inverse oder Rollo - Bsp.: Rollo oben 0, Rollo unten 100 und der Befehl zum prozentualen Fahren ist position",2 = "Homematic Style - Bsp.: Rollo oben 100, Rollo unten 0 und der Befehl zum prozentualen Fahren ist pct
|-
|ASC_Adv || on, off||||bei on wird das runterfahren des Rollos während der Weihnachtszeit (1. Advent bis 6. Januar) ausgesetzt! Durch set <ASCDEVICE> advDriveDown werden alle ausgesetzten Fahrten nachgeholt.
|-
|ASC_Antifreeze ||off, soft, hard, am, pm || ||Frostschutz, wenn soft fährt der Rollladen in die ASC_Antifreeze_Pos, bei hard/am/pm wird gar nicht oder innerhalb der entsprechenden Tageszeit nicht gefahren
|-
|ASC_Antifreeze_Pos || || ||Position des Rolllades die angefahren werden soll, wenn der Fahrbefehl komplett schließen lautet, aber der Frostschutz aktiv ist !!!Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss eine positive Zahl/Dezimalzahl sein!!!
|-
|ASC_autoAstroModeEvening ||REAL, CIVIL, NAUTIC, ASTRONOMIC oder HORIZON || ||nach welchem ASTRO-Modus soll die Abendfahrt berechnet werden
|-
|ASC_autoAstroModeEveningHorizon || - 9 bis 9 || 0|| Höhe über dem Horizont. Wird nur berücksichtigt, wenn im Attribut ASC_autoAstroModeEvening der Wert HORIZON ausgewählt wurde.
|-
|ASC_autoAstroModeMorning ||REAL, CIVIL, NAUTIC, ASTRONOMIC oder HORIZON || || nach welchem ASTRO-Modus soll die Morgendfahrt berechnet werden
|-
|ASC_autoAstroModeMorningHorizon || - 9 bis 9|| 0|| Höhe über dem Horizont. Wird nur berücksichtigt, wenn im Attribut ASC_autoAstroModeMorning der Wert HORIZON ausgewählt wurde.
|-
|ASC_BlockingTime_afterManual || ||1200 ||wie viel Sekunden soll die Automatik nach einer manuellen Fahrt aussetzen
|-
|ASC_BlockingTime_beforeDayOpen || ||3600 ||wie viel Sekunden vor dem morgendlichen öffnen soll keine schließen Fahrt mehr stattfinden.
|-
|ASC_BlockingTime_beforeNightClose || ||3600 ||ie viel Sekunden vor dem nächtlichen schließen soll keine öffnen Fahrt mehr stattfinden.
|-
|ASC_BrightnessSensor || ||none ||DEVICE[:READING] WERT-MORGENS:WERT-ABENDS / 'Sensorname[:brightness [400:800]]' Angaben zum Helligkeitssensor mit (Readingname, optional) für die Beschattung und dem Fahren der Rollladen nach brightness und den optionalen Brightnesswerten für Sonnenauf- und Sonnenuntergang
|-
|ASC_Closed_Pos || ||default Vorgabe ist abhängig vom Attribut ''ASC''||in 10er-Schritten von 0 bis 100
wird angefahren wenn SelfDefense aktiv ist
|-
|ASC_ComfortOpen_Pos || || || in 10er Schritten von 0 bis 100 !!! Die eingestellte Position wird bei einem threestate Sensor angefahren. Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss eine positive Zahl/Dezimalzahl sein!!!
|-
|ASC_Down || time, astro, brightness, roommate || astro||bei ''astro'' wird Sonnenuntergang berechnet, bei time wird der Wert aus ASC_Time_Down_Early als Fahrzeit verwendet und bei brightness muss ASC_Time_Down_Early und ASC_Time_Down_Late korrekt gesetzt werden. Der Timer läuft dann nach ASC_Time_Down_Late Zeit, es wird aber in der Zeit zwischen ASC_Time_Down_Early und ASC_Time_Down_Late geschaut, ob die als Attribut im Moduldevice hinterlegte ASC_brightnessDriveUpDown der Down Wert erreicht wurde. Wenn ja, wird der Rollladen runter gefahren.
|-
|ASC_DiveUpMaxDuration || || 60||die Dauer des Hochfahrens des Rollladens plus 5 Sekunden
|-
|ASC_Drive_Delay || || -1|| maximaler Wert für einen zufällig ermittelte Verzögerungswert in Sekunden bei der Berechnung der Fahrzeiten, 0 bedeutet keine Verzögerung, -1 bedeutet, dass das gleichwertige Attribut aus dem ASC Device ausgewertet werden soll
|-
|ASC_DriveDelayStart || || -1|| in Sekunden verzögerter Wert ab welchen dann erst das Offset startet und dazu addiert wird. Funktioniert nur wenn gleichzeitig ASC_DriveDelay gesetzt wird.
|-
|ASC_ExternalTrigger || |||| DEVICE:READING VALUEACTIVE:VALUEINACTIVE POSACTIVE:POSINACTIVE, Beispiel: "WohnzimmerTV:state on:off 66:100" bedeutet das wenn ein "state:on" Event kommt soll das Rollo in Position 66 fahren, kommt ein "state:off" Event soll es in Position 100 fahren. Es ist möglich die POSINACTIVE weg zu lassen dann fährt das Rollo in LastStatus Position.
|-
|ASC_GuestRoom || on, off |||| aktuell noch nicht umgesetzt...
|-
|ASC_LockOut || soft, hard, off ||off || stellt entsprechend den Aussperrschutz ein. Bei global aktivem Aussperrschutz (set ASC-Device lockOut soft) und einem Fensterkontakt open bleibt dann der Rollladen oben. Dies gilt nur bei Steuerbefehlen über das ASC Modul. Stellt man global auf hard, wird bei entsprechender Möglichkeit versucht den Rollladen hardwareseitig zu blockieren. Dann ist auch ein Fahren über die Taster nicht mehr möglich
|-
|ASC_LockOut_Cmd || inhibit, blocked, protection ||none|| set Befehl für das Rollladen-Device zum Hardware sperren. Dieser Befehl wird gesetzt werden, wenn man "ASC_LockOut" auf hard setzt
|-
|ASC_Mode_Down ||absent, always, off, home || always ||Wann darf die Automatik steuern. immer, niemals, bei Abwesenheit des Roommate (ist kein Roommate und absent eingestellt, wird gar nicht gesteuert)
|-
|ASC_Mode_Up ||absent, always, off, home || always ||Wann darf die Automatik steuern. immer, niemals, bei Abwesenheit des Roommate (ist kein Roommate und absent eingestellt, wird gar nicht gesteuert)
|-
|ASC_Open_Pos || ||default Vorgabe ist abhängig vom Attribut ''ASC''||in 10er-Schritten von 0 bis 100
|-
|ASC_Partymode || on, off || off ||schaltet den Partymodus an oder aus. Wird am ASC Device set ASC-DEVICE partyMode on geschalten, werden alle Fahrbefehle an den Rollläden, welche das Attribut auf on haben, zwischengespeichert und später erst ausgeführ
|-
|ASC_Pos_Reading || || ||Name des Readings, welches die Position des Rollladen in Prozent angibt. Wird bei unbekannten Device-Typen auch als ''set'' Befehl zum Fahren verwendet
|-
|ASC_PrivacyDownValue_beforNightClose || || -1||wie viele Sekunden vor dem abendlichen schließen soll der Rollladen in die Sichtschutzposition fahren, oder bei Brightness ab welchem minimum Brightnesswert soll das Rollo in die Privacy Position fahren. Bei Brightness muss zusätzlich zum Zeitwert der Brightnesswert mit angegeben werden 1800:300 bedeutet 30 min vor night close oder bei unter einem Brightnesswert von 300
|-
|ASC_PrivacyDown_Pos || ||50||Position den Rollladens für den abendlichen Sichtschutz!Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss eine positive Zahl/Dezimalzahl sein!!!
|-
|ASC_PrivacyUpValue_beforDay || || -1||wie viele Sekunden vor dem morgendlichen öffnen soll der Rollladen in die Sichtschutzposition fahren, oder bei Brightness ab welchem minimum Brightnesswert soll das Rollo in die Privacy Position fahren. Bei Brightness muss zusätzlich zum Zeitwert der Brightnesswert mit angegeben werden 1800:600 bedeutet 30 min vor day open oder bei über einem Brightnesswert von 600
|-
|ASC_PrivacyUp_Pos || ||50||Position den Rollladens für den morgendlichen Sichtschutz!Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss eine positive Zahl/Dezimalzahl sein!!!
|-
|ASC_RainProtection ||on, off || ||soll der Rollladen beim Regenschutz beachtet werden. on=JA, off=NEIN.
|-
|ASC_Roommate_Device || || none ||mit Komma getrennte Namen des/der Roommate-Device/s welche den/die Bewohner des Rollladen-Raumes wiedergibt. Macht nur Sinn in Schlaf- oder Kinderzimmern
|-
|ASC_Roommate_Reading || || ||Reading des Roommate-Device, welches den Status wieder gibt
|-
|ASC_Self_Defense_AbsentDelay || || 300||um wie viele Sekunden soll das fahren in Selfdefense bei Residents absent verzögert werden
|-
|ASC_Self_Defense_Mode || || gone||ab welchen Residents Status soll Selfdefense aktiv werden ohne das Fenster auf sind
|-
|ASC_Shading_InOutAzimuth || ||95:265 ||Azimut Wert ab dem bei Überschreiten Beschattet und bei Unterschreiten Endschattet werden soll
|-
|ASC_Shading_MinMax_Elevation || ||25.0:100.0 ||ab welcher min Höhe des Sonnenstandes soll beschattet und ab welcher max Höhe wieder beendet werden, immer in Abhängigkeit der anderen einbezogenen Sensorwerte
|-
|ASC_Shading_MinOutsideTemperature_ || ||18 ||ab welcher Temperatur soll Beschattet werden, immer in Abhängigkeit der anderen einbezogenen Sensorwert
|-
|ASC_ShadingMode ||absent, always, off, home || off||wann soll die Beschattung nur stattfinden
|-
|ASC_Shading_Pos || || ||Position des Rollladens für die Beschattung !!!Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss eine positive Zahl/Dezimalzahl sein!!!
|-
|ASC_Shading_StateChange_SunnyCloudy || ||35000:20000 ||Brightness Wert ab welchen die Beschattung stattfinden und aufgehoben werden soll, immer in Abhängigkeit der anderen einbezogenen Sensorwerte
|-
|ASC_Shading_WaitingPeriod || ||1200 ||wie viele Sekunden soll gewartet werden bevor eine weitere Auswertung der Sensordaten für die Beschattung stattfinden soll
|-
|ASC_Shutter_IdleDetection || ||||READING:VALUE gibt das Reading an welches Auskunft über den Fahrstatus des Rollos gibt, sowie als zweites den Wert im Reading welcher aus sagt das das Rollo nicht fährt
|-
|ASC_ShuttersPlace || window, terrace || ||wenn dieses Attribut auf ''terrace'' gesetzt ist und das Residents-Device in den Status ''absent'' geht, ''selfDefence'' aktiv ist und das Fenster geöffnet ist, wird das Rollo geschlossen. Wenn ein twostate Senso genutzt wird und dieses Attribut auf ''terrace'' gesetzt ist wird ASC_Ventilate_Pos ignoriert und das Rollo wird beim öffnen des Fenster komplett geöffnet. Wenn dieses Attribut auf ''window'' gesetzt ist wird ASC_Ventilate_Pos berücksichtigt und das Rollo wird entsprechend der ASC_Ventilate_Pos geöffnet. Wenn das Fenster wieder geschlossen wird, dann wird das Rollo unabhängig von ''windows oder terrace'' vollständig geschlossen.
|-
|ASC_Sleep_Pos || || ||in 10er-Schritten von 0 bis 100, default Vorgabe ist abhängig vom Attribut ''ASC.'' Position wird angefahren wenn Bedingung für modeDown aktiv ist. Hiermit kann z.B. das komplette abendliche Schließen des Rollos begrenzt werden.
|-
|ASC_TempSensor || || ||DEVICENAME[:READINGNAME] - der Inhalt ist eine Kombination aus Device und Reading für die Außentemperatur
|-
|ASC_Time_Down_Early || ||16:00 ||Sonnenuntergang frühste Zeit zum Runterfahren !!!Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss ein Zeitformat in Form HH:MM[:SS] sein!!!
|-
|ASC_Time_Down_Late || ||22:00 ||Sonnenuntergang späteste Zeit zum Runterfahren !!!Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss ein Zeitformat in Form HH:MM[:SS] sein!!!
|-
|ASC_Time_Up_Early || || 05:00||Sonnenaufgang frühste Zeit zum Hochfahren !!!Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss ein Zeitformat in Form HH:MM[:SS] sein!!!
|-
|ASC_Time_Up_Late || ||08:30 ||Sonnenaufgang späteste Zeit zum Hochfahren !!!Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss ein Zeitformat in Form HH:MM[:SS] sein!!!
|-
|ASC_Time_Up_WE_Holiday || ||08:00 ||Sonnenaufgang frühste Zeit zum Hochfahren am Wochenende und/oder Urlaub (holiday2we wird beachtet).ACHTUNG!!! in Verbindung mit Brightness für ASC_Up muss die Uhrzeit kleiner sein wie die Uhrzeit aus ASC_Time_Up_Late !!!Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss ein Zeitformat in Form HH:MM[:SS] sein!!!
|-
|ASC_Ventilate_Window_Open ||on, off ||on||auf lüften, wenn das Fenster gekippt/geöffnet wird und aktuelle Position unterhalb der Lüften-Position ist
|-
|ASC_WiggleValue || ||5 ||Wert, um welchen sich die Position des Rollladens bei ''Wiggle'' ändern soll
|-
|ASC_WindParameters || ||5 ||TRIGGERMAX[:HYSTERESE] [DRIVEPOSITION] / Angabe von Max Wert ab dem für Wind getriggert werden soll, Hytsrese Wert ab dem der Windschutz aufgehoben werden soll TRIGGERMAX - HYSTERESE / Ist es bei einigen Rollläden nicht gewünscht das gefahren werden soll, so ist der TRIGGERMAX Wert mit -1 an zu geben. (default: '50:20 ClosedPosition')
|-
|ASC_WindProtection ||on, off || ||soll der Rollladen beim Windschutz beachtet werden. on=JA, off=NEIN.
|-
|ASC_WindowRec || ||none ||Name des Fensterkontakts, an welchen Fenster der Rollladen angebracht ist. WINDOWREC:[READING], Name des Fensterkontaktes, an dessen Fenster der Rollladen angebracht ist. Reading ist optional
|-
|ASC_WindowRec_PosAfterDayClosed ||open, lastManual ||open ||Name des Fensterkontakts, an welchen Fenster der Rollladen angebracht ist. Sein Reading ''state'' muss die Werte ''open'', ''closed'' oder ''tilted'' enthalten.
|-
|ASC_WindowRec_subType ||twostate, threestate ||twostate||Typ des verwendeten Fensterkontaktes: twostate (optisch oder magnetisch) oder threestate (Drehgriffkontakt)
|-
| || || ||
| || || ||
|-
| || || ||
|-
| || || ||
|-
| || || ||
|}

== Hilfsmittel ==
{{Hinweis|Die Device-Namen sind auf die eigene Installation anzupassen.}}

{{Hinweis|Codezeilen sind im [[Import von Code Snippets|RAW]]-Format.}}

{{Randnotiz|RNTyp=g|RNText= Stand 2019-05-03
* Erfolgreich getestet mit Homematic Devices, Beta-User
* Die Farbgebung entspricht dem Standard, wenn unter dem Style f18 der Farbpreset ''light'' gewählt wird.
}}

=== readingsGroup für Level ===
<pre style="width:65%;word-wrap: break-word;">defmod rg_ASC_Rolllaeden_Level readingsGroup <Gerät>,<Stand>,<Schliessen bis>,<Öffnen auf>,<Beschattung>,<Komfort>,<Lüften>,<Privacy> (Rollladen_.*|Jalousie_.*)..:level,!?ASC_Closed_Pos,!?ASC_Open_Pos,!?ASC_Shading_Pos,!?ASC_ComfortOpen_Pos,!?ASC_Ventilate_Pos,!?ASC_PrivacyDown_Pos
attr rg_ASC_Rolllaeden_Level commands {level => 'pct:selectnumbers,0,5,100,0,lin',\
ASC_Closed_Pos => 'ASC_Closed_Pos:selectnumbers,0,5,100,0,lin',\
ASC_Open_Pos => 'ASC_Open_Pos:selectnumbers,0,5,100,0,lin',\
ASC_Shading_Pos => 'ASC_Shading_Pos:selectnumbers,0,5,100,0,lin',\
ASC_Ventilate_Pos => 'ASC_Ventilate_Pos:selectnumbers,0,5,100,0,lin',\
ASC_ComfortOpen_Pos => 'ASC_ComfortOpen_Pos:selectnumbers,0,5,100,0,lin',\
ASC_PrivacyDown_Pos => 'ASC_PrivacyDown_Pos:selectnumbers,0,5,100,0,lin'}
</pre>

=== readingsGroup für Zeiten ===
[[Bild:ReadingsGroup ASC times.png|thumb|right|ReadingsGroup - Zeitenbeispiel]]
<pre style="width:65%;word-wrap: break-word;">defmod rg_ASC_Rolllaeden_Times readingsGroup <Gerät>,<Position>,<Time_Up_Early>,<Time_Up_Late>,<Time_Up_WE/Hol>,<Time_Down_Early>,<Time_Down_Late>,<Mode_Down>,<Mode_Up> \
(.*Rollo.*|.*Rollladen|Jalousie_.*):level,!?ASC_Time_Up_Early,!?ASC_Time_Up_Late,!?ASC_Time_Up_WE_Holiday,!?ASC_Time_Down_Early,!?ASC_Time_Down_Late,!?ASC_Mode_Down,!?ASC_Mode_Up
attr rg_ASC_Rolllaeden_Times commands {level => 'pct:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,100', \
ASC_Time_Down_Early => 'ASC_Time_Down_Early:15:00,15:15,15:30,15:45,16:00,16:15,16:30,16:45,17:00,17:15,17:30,17:45,18:00,18:15,18:30,18:45,19:00,19:15,19:30,19:45,20:00,20:15,20:30,20:45,21:00,21:15,21:30,21:45,22:00', \
ASC_Time_Down_Late => 'ASC_Time_Down_Late:19:00,19:15,19:30,19:45,20:00,20:15,20:30,20:45,21:00,21:15,21:30,21:45,22:00,22:15,22:30,22:45,23:00,23:15,23:30', \
ASC_Time_Up_WE_Holiday => 'ASC_Time_Up_WE_Holiday:06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00',\
ASC_Time_Up_Early => 'ASC_Time_Up_Early:05:00,05:05,05:30,05:55,06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00', \
ASC_Time_Up_Late => 'ASC_Time_Up_Late:06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00', \
ASC_Mode_Down => 'ASC_Mode_Down:always,absent,off', \
ASC_Mode_Up => 'ASC_Mode_Up:always,absent,off' }
attr rg_ASC_Rolllaeden_Times room Rollladen</pre>

[[Bild:ASC RG Zeiten HM ZWave Siro.png|thumb|right|ReadingsGroup - CUL_HM+ZWave+Siro mit widgets]]Neue Version mit time-Widgets und pct/dim/position-widget (5-er Schritte), passend für CUL_HM, ZWave und Siro-Geräte:
<pre style="width:65%;word-wrap: break-word;">defmod rg_ASC_Rolllaeden_Times readingsGroup <Gerät>,<Stand>,<Time_Up_Early >,<Time_Up_WE >,<Time_Up_Late >,<Time_Down_Early>,<Time_Down_Late>,<Mode_Down>,<Mode_Up> (Rollo_.*|Jalousie_.*)..:(level|dim|position),!?ASC_Time_Up_Early,!?ASC_Time_Up_WE_Holiday,!?ASC_Time_Up_Late,!?ASC_Time_Down_Early,!?ASC_Time_Down_Late,!?ASC_Mode_Down,!?ASC_Mode_Up
attr rg_ASC_Rolllaeden_Times commands {level => 'pct:selectnumbers,0,5,100,0,lin', \
dim => 'dim:selectnumbers,0,5,99,0,lin',\
position => 'pct:selectnumbers,0,5,99,0,lin',\
ASC_Mode_Down => 'ASC_Mode_Down:always,absent,off',\
ASC_Mode_Up => 'ASC_Mode_Up:always,absent,off',\
ASC_Time_Down_Early => 'ASC_Time_Down_Early:time', \
ASC_Time_Down_Late => 'ASC_Time_Down_Late:time',\
ASC_Time_Up_Early => 'ASC_Time_Up_Early:time', \
ASC_Time_Up_Late =>'ASC_Time_Up_Late:time',\
ASC_Time_Up_WE_Holiday =>'ASC_Time_Up_WE_Holiday:time'}
attr rg_ASC_Rolllaeden_Times room Rollladen
</pre>

=== readingsGroup für die Beschattung ===
[[Bild:ReadingsGroup ASC shading.png|thumb|right|ReadingsGroup - Beschattungsbeispiel]]
<pre style="width:65%;word-wrap: break-word;">
defmod rg_ASC_Rolllaeden_Shading readingsGroup <Gerät>,<Modus>,<Position>,<Richtung>,<°links>,<°rechts>,<Elevation>,<Sunny>,<Cloudy>,<Min Temp> (Rollo|Jalousie)_.*..:!?ASC_Shading_Mode,!?ASC_Shading_Pos,!?ASC_Shading_Direction,!?ASC_Shading_Angle_Left,!?ASC_Shading_Angle_Right,!?ASC_Shading_MinMax_Elevation,!?ASC_Shading_StateChange_Sunny,!?ASC_Shading_StateChange_Cloudy,!?ASC_Shading_Min_OutsideTemperature
attr rg_ASC_Rolllaeden_Shading alias Rollläden: Beschattung
attr rg_ASC_Rolllaeden_Shading commands {ASC_Shading_Pos => 'ASC_Shading_Pos:knob,min:0,max:100,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:5,lineCap:round',\
ASC_Shading_Mode => 'ASC_Shading_Mode:always,home,absent,off',\
ASC_Shading_Direction => 'ASC_Shading_Direction:knob,min:0,max:360,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:1,cursor:true,lineCap:round',\
ASC_Shading_Angle_Left => 'ASC_Shading_Angle_Left:knob,min:0,max:85,angleArc:85,rotation:anticlockwise,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:5,lineCap:round,angleOffset:270',\
ASC_Shading_Angle_Right => 'ASC_Shading_Angle_Right:knob,min:0,max:85,angleArc:85,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:5,lineCap:round,',\
ASC_Shading_MinMax_Elevation => 'ASC_Shading_MinMax_Elevation:knob,min:0,max:35,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:1,lineCap:round,angleArc:120,angleOffset:270',\
ASC_Shading_StateChange_Sunny => 'ASC_Shading_StateChange_Sunny:knob,min:100,max:40000,angleArc:85,rotation:anticlockwise,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:20,lineCap:round,angleOffset:270',\
ASC_Shading_StateChange_Cloudy => 'ASC_Shading_StateChange_Cloudy:knob,min:100,max:40000,angleArc:85,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:20,lineCap:round,',\
ASC_Shading_Min_OutsideTemperature => 'ASC_Shading_Min_OutsideTemperature:knob,min:5,max:30,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:0.5,lineCap:round,angleArc:120,angleOffset:270'}
attr rg_ASC_Rolllaeden_Shading room Rollladen</pre>
 
Anderes {{Link2Forum|Topic=99980|Message=946357|LinkText=Foren-Beispiel}} für eine RG zu Beschattung (für V. 0.6.x):
[[Bild:ReadingsGroup ASC shading2.png|thumb|right|ReadingsGroup - Beschattungsbeispiel]]
<pre style="width:65%;word-wrap: break-word;">
defmod rg_ASC_Shading readingsGroup <Gerät>,<Grad>,<Position>,<Mode>,<Links>,<Rechts>,<Wait>,<ShadeIn>,<ShadeOut>,<Elevation>,<Temperature>,<Device>\
(Rollo_.*|Jalousie.*):!?ASC_Shading_Direction,!?ASC_Shading_Pos,!?ASC_Shading_Mode,!?ASC_Shading_Angle_Left,!?ASC_Shading_Angle_Right,!?ASC_Shading_WaitingPeriod,!?ASC_Shading_StateChange_Sunny,!?ASC_Shading_StateChange_Cloudy,!?ASC_Shading_MinMax_Elevation,!?ASC_Shading_Min_OutsideTemperature,!?ASC_BrightnessSensor\

attr rg_ASC_Shading commands {ASC_Shading_Direction => 'ASC_Shading_Direction:129,255,309',\
ASC_Shading_Pos => 'ASC_Shading_Pos:selectnumbers,0,5,100,0,lin',\
ASC_Shading_Mode => 'ASC_Shading_Mode:absent,always,off,home',\
ASC_Shading_Angle_Left => 'ASC_Shading_Angle_Left:selectnumbers,0,5,100,0,lin',\
ASC_Shading_Angle_Right => 'ASC_Shading_Angle_Right:selectnumbers,0,5,100,0,lin',\
ASC_Shading_WaitingPeriod => 'ASC_Shading_WaitingPeriod:selectnumbers,0,60,1200,0,lin',\
ASC_Shading_StateChange_Sunny => 'ASC_Shading_StateChange_Sunny:selectnumbers,0,20,1000,0,lin',\
ASC_Shading_StateChange_Cloudy => 'ASC_Shading_StateChange_Cloudy:selectnumbers,0,20,1000,0,lin',\
ASC_Shading_MinMax_Elevation =>\
'ASC_Shading_Min_Elevation:selectnumbers,0,1,40,0,lin' ,\
ASC_Shading_Min_OutsideTemperature =>\
'ASC_Shading_Min_OutsideTemperature:selectnumbers,0,1,30,0,lin'}
attr rg_ASC_Shading room Rollladen</pre>

=== readingsGroup für FIBARO Roller Shutter FGR-222 Devices ===
{{Randnotiz|RNTyp=g|RNText=Getestet von majestro84, Stand 2019-01-28.
* https://forum.fhem.de/index.php/topic,92628.msg897099.html#msg897099
* Die Farbgebung entspricht dem Standard, wenn unter dem Style f18 der Farbpreset ''dark'' gewählt wird}}

[[Bild:ASC Jalousien Times.JPG|thumb|right|Beispiel]]
<pre style="width:65%;word-break: break-all;word-wrap: break-word;">define ASC_Jalousien_Times readingsGroup <Gerät>,<Stand>,<Time_Up_Early>,<Time_Up_WE>,<Time_Up_Late>,<Time_Down_Early>,<Time_Down_Late>,<Mode_Down>,<Mode_Up>,<PartyMode>,<LockOut> (.*_Jalousie.*):position,!?ASC_Time_Up_Early,!?ASC_Time_Up_WE_Holiday,!?ASC_Time_Up_Late,!?ASC_Time_Down_Early,!?ASC_Time_Down_Late,!?ASC_Mode_Down,!?ASC_Mode_Up,!?ASC_Partymode,!?ASC_LockOut

attr ASC_Jalousien_Times commands {position => 'dim:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_Mode_Down => 'ASC_Mode_Down:always,absent,off',
ASC_Mode_Up => 'ASC_Mode_Up:always,absent,off',
ASC_Partymode => 'ASC_Partymode:on,off',
ASC_LockOut => 'ASC_LockOut:soft,hard,off',
ASC_Time_Down_Early => 'ASC_Time_Down_Early:15:00,15:15,15:30,15:45,16:00,16:15,16:30,16:45,17:00,17:15,17:30,17:45,18:00,18:15,18:30,18:45,19:00,19:15,19:30,19:45,20:00,20:15,20:30,20:45,21:00,21:15,21:30,21:45,22:00',
ASC_Time_Down_Late => 'ASC_Time_Down_Late:20:15,20:30,20:45,21:00,21:15,21:30,21:45,22:00,22:15,22:30,22:45,23:00,23:15,23:30',
ASC_Time_Up_Early => 'ASC_Time_Up_Early:05:00,05:05,05:30,05:45,06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00',
ASC_Time_Up_Late =>'ASC_Time_Up_Late:06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00',
ASC_Time_Up_WE_Holiday => 'ASC_Time_Up_WE_Holiday:06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00'}
attr ASC_Jalousien_Times room Jalousien</pre>

[[Bild:ASC Jalousien Level.JPG|thumb|right|Beispiel]]
<pre style="width:65%;word-break: break-all;word-wrap: break-word;"> define Jalousien_Level readingsGroup <Gerät>,<Closed_Pos>,<Open_Pos>,<Comfort_Pos>,<Ventilate_Pos>,<PrivacyDown_Pos>,<Shading_Pos> (.*_Jalousie.*):!?ASC_Closed_Pos,!?ASC_Open_Pos,!?ASC_ComfortOpen_Pos,!?ASC_Ventilate_Pos,!?ASC_PrivacyDown_Pos,!?ASC_Shading_Pos
attr Jalousien_Level commands { ASC_Closed_Pos => 'ASC_Closed_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_Open_Pos => 'ASC_Open_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_ComfortOpen_Pos => 'ASC_ComfortOpen_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_Ventilate_Pos => 'ASC_Ventilate_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_PrivacyDown_Pos => 'ASC_PrivacyDown_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_Shading_Pos => 'ASC_Shading_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99'}
attr Jalousien_Level room Jalousien</pre>

== Einrichtungsbeispiel ==
=== Zielsetzung und Vorgaben ===
Es sollen alle Rollläden und Jalousien in einem Haus innerhalb bestimmter zeitlicher Grenzen Morgens und Abends sonnenstandsabhängig gefahren werden, an den Wochenenden und an Ferientagen soll etwas später geöffnet werden. Es sind Tür- und Fensterkontakte vorhanden (Türkontakte: twoState, Fensterkontakte: threeState), wobei bei jeder Öffnung ein eventuell geschlossener Rollladen geöffnet werden soll. Bei allen Rollladenaktoren, Tür- und Fensterkontakten handelt es sich um CUL_HM-Geräte.

=== Vorarbeiten ===
Im global-Device sind Angaben zu latitude und longitude vorhanden, holiday2we wie folgt<ref>''ferien'' ist eine automatisiert erstellte holiday-Datei nach diesem {{Link2Forum|Topic=85759|Message=885883|LinkText=Foren-Beitrag}}.</ref>:
attr global holiday2we bw,ferien
Weitere Angaben benötigen wir zunächst nicht, die Festlegung eines Astro-Devices erfolgt hier erst im Rahmen der Beschattung.
Dann erfolgt das ''Define des ASC-Devices'' wie oben beschrieben:
<code>define Rollladenautomatik AutoShuttersControl</code>
Folgen die einzubindenden Rollladenaktoren einem einheitlichen Namensschema, können diese sodann z.B. mit
attr (Jalousie|Rollladen)_.* ASC 2
auf einen Rutsch mit dem passenden ASC-Typ gekennzeichnet werden. Dann verteilen wir mir
set Rollladenautomatik scanForShutters
die nachfolgend weiter zu bearbeitenden Attribute.
=== Schließen morgens und abends ===
{{Randnotiz|RNTyp=g|RNText=Alternative: Fahren nach brightness:
Will man insgesamt oder nur an einzelnen Rollläden stattdessen helligkeitsgesteuert fahren, muß für jeden Rollladen ein Helligkeitssensor definiert und entweder zentral oder am einzelnen Rollladen jeweils ein Höchst- bzw. Mindestwert festgelegt werden (''ASC_BrightnessSensor'' etc.), bei dessen Überschreitung geöffnet bzw. Unterschreitung geschlossen werden soll.}}
==== Konfiguration des ASC-Devices ====
Da wir sonnenstandsabhängig Fahrzeiten wollen, legen wir erst einmal fest, dass dies morgens und abends berücksichtigt werden soll:
<pre>
attr Rollladenautomatik ASC_autoAstroModeEvening CIVIL
attr Rollladenautomatik ASC_autoAstroModeMorning CIVIL
</pre>
Aus der Angabe ''CIVIL'' und den Vorgaben in den einzelnen Rollladen wird dabei mit Hilfe von [[SUNRISE_EL]] die effektive Fahrzeit berechnet, dort finden sich auch weitere Hinweise, zu den meisten anderen Optionen für die ersten beiden Attribute.
Bei allen Fensteröffnungen soll auf eine Lüften-Position gefahren werden, also schalten wir diese Funktion ebenfalls zentral an<ref>Sonst wird bei threeState-Sensoren nur bei ''tilted'' auf die in ''ASC_Ventilate_Pos'' gefahren.</ref>:
attr Rollladenautomatik ASC_autoShuttersControlComfort on
Zuletzt legen wir noch einen Temperatur-Sensor fest. Dieser wird beim Frostschutz sowie bei der Beschattung berücksichtigt.
<pre>
attr Rollladenautomatik ASC_tempSensor Aussentemperatur_Nord:temperature
attr Rollladenautomatik ASC_freezeTemp 3
</pre>

tbd:
* Rain
* Wind
==== Konfiguration der Rollladendevices ====
===== Fahrzeiten =====
Zur Konfiguration der Fahrzeiten bietet es sich an, eine ReadingsGroup zu nutzen, wie unter [[#Hilfsmittel|Hilfsmittel]] dargestellt. Alternativ kann man die Zeiten auch manuell in den einzelnen Rollläden hinterlegen.
===== Bewohner =====
Wird ein Raum von einer oder mehreren bestimmten Person/en bewohnt oder gibt es ein Sammel-Gerät für mehrere Bewohner, kann dies mit den Attributen ''ASC_Roommate_Device'' und ''ASC_Roommate_Reading'' einem Rollladen zugeordnet werden. Ist einer der Bewohner ''asleep'', wird morgens erst geöffnet, wenn auch der letzte Roommate nicht mehr ''asleep'' ist.
===== Fensterkontakte =====
Dann werden ggf. vorhandene Fensterkontakte mit ''ASC_WindowRec'' zugeordnet und der Sensortyp mit ''ASC_WindowRec_subType'' festgelegt. Im Falle von threeState-Sensoren wird das übergreifende ''ASC_autoShuttersControlComfort'' beachtet, wobei dann bei vollständiger Öffnung des Fensters auf den in ''ASC_ComfortOpen_Pos'' festgelegten Wert gefahren wird.
===== Frostschutz =====
Zuletzt können die Attribute ''ASC_Antifreeze'' und ''ASC_Antifreeze_Pos'' festgelegt werden, wenn die Frostschutzfunktion aktiviert werden soll.

=== Beschattung ===
==== Konfiguration des ASC-Devices ====
IM ASC DEVICE das Reading "controlShading" mit dem Wert on, sowie ein Astro/Twilight Device im Attribut "ASC_twilightDevice" und das Attribut "ASC_tempSensor".

==== Konfiguration der Rollladendevices ====
Ihr benötigt einen Helligkeitssensor als Attribut "ASC_BrightnessSensor", sofern noch nicht vorhanden. Findet der Sensor nur für die Beschattung Verwendung ist der Wert DEVICENAME[:READING] ausreichend.
Alle weiteren Attribute sind optional und wenn nicht gesetzt mit Default-Werten belegt. Ihr solltet sie dennoch einmal anschauen und entsprechend Euren Gegebenheiten setzen. Die Werte für die Fensterposition und den Vor- Nachlaufwinkel ''(ASC_Shading_InOutAzimuth)'' sowie die Grenzwerte für <code>''ASC_shading_StateChange_SunnyCloudy''</code> solltet ihr besondere Beachtung dabei schenken.

==== Bedingungen ====
Damit die Beschattung startet müssen '''alle''' Bedingungen erfüllt sein. Entschattet wird sobald '''einer''' der Bedingungen wegfällt und die Zeit aus <code>ASC_Shading_WaitingPeriod</code> abgelaufen ist.

Der Sonnensensor <ASC_BrightnessSensor> muss mindestens 2 Messwerte liefern, bevor das ASC-Modul in die Beschattungsposition fährt! Beim (zeitlich gesehen) ersten Messwert wird der Zustand ''in-reserved'' eingenommen und erst beim zweiten Messwert dann der Zustand ''in shading'' eingenommen. Die Anzahl der Messwerte ist abhängig vom "moving average window", der mit dem dritten Parameter des Attributs ''ASC_Shading_StateChange_SunnyCloudy'' konfiguriert wird.

'''Von Standardwerten ausgehend ist nachfolgender Ablauf angestrebt:'''
# Ein Event vom Astro oder Helligkeits Device kommt -> sind alle Werte innerhalb des Arbeitsbereiches, ändert sich der ASC Info-Zustand im Rollo von xx auf „in reserved“ (Beschattung vorbereitet)
# Ein erneutes Event vom Astro oder Helligkeits Device kommt -> Überprüfung der Werte -> sind diese weiterhin gegeben folgt der Wechsel von „in reserved“ auf „in“ (Beschattung aktiv)
# Bei Verwendung von ''ASC_Shading_StateChange_SunnyCloudy'' ist zu beachten, dass ein Durchschnitt über die letzten drei Brightness Events gerechnet wird. Möchte man das vermeiden muss man SUNNY:CLOUDY 1[2] setzen.
# Die Zeiten ''ASC_Shading_WaitingPeriod'' und ''ASC_BlockingTime_afterManual'' können hier zusätzlich für eine Verzögerung sorgen.
'''Wichtig zu beachten:''' Es müssen immer mehrere (mind. 2) Events für den Betrieb erfolgen. In den Standardeinstellungen vom Astro Modul erfolgt dieses z.B. nur 1 x pro Stunde. Kommt also ein Helligkeits-Event auch nur 1x pro Stunde, könnte es 2 Std dauern, bis die Beschattungsfunltion greift.

Wenn das Rollo einmal aus der Beschattung manuell (im Rollo Device muss bei ''ASC_ShuttersLastDrive manuel'' stehen gefahren wurde wird das Rollo erst wieder nach einer Entschattung und erneuter Beschattung gefahren. Also es muss einmal shading out kommen und beim nächsten shading in fährt er dann wieder.

=== Weitere Funktionen ===

==== '''Beschreibung WeekendHoliday Funktion im Brightnessbetrieb.''' ====
Wenn Wochenende oder Feiertag ist und WeekendHoliday aktiviert wurde und im Rollo das Attribut ASC_Time_Up_WE_Holiday gesetzt ist dann wird ausschließlich zur angebenden ASC_Time_Up_WE_Holiday Zeit gefahren ungeachtet des Brightnesswertes.

==== Privacy ====
Werden hierfür Werte festgelegt, werden die betreffenden Rollläden die festgelegte Zeit/Helligkeit vor dem abendlichen Schließen vorab teilweise geschlossen. Dies kann z.B. gewünscht sein, um Rollläden zur Straße hin mit viel Fußgängerverkehr zwar nicht vollständig abzudunkeln, aber gleichzeitig zu verhindern, dass von außen in Wohnräume geschaut werden kann, sobald dort das Licht angeschaltet wird

==== BlockingTime====
Bewirkt, dass nach einer manuellen Fahrt, eine vom ASC Modul initiierte Fahrt zunächst ausgesetzt wird, bis die im Attribute angegebene Zeit überschritten ist. Erst dann wird eine vom ASC Modul initiierte Fahrt tatsächlich durchgeführt.
Genau so wird ein Hochfahren eines Rollos durch das ASC Modul nicht mehr ausgeführt, wenn es innerhalb der Zeit von ASC_BlockingTime_beforNightClose und das Runterfahren wird nicht mehr erfolgen, wenn es innerhalb von ASC_BlockingTime_beforDayOpen ist.
Beispiel: Meine Tochter geht früh außer Haus und Ihre Rollos sind nicht hochgefahren. Diese fahren auch nicht mehr hoch, da die ausschließlich bei home (anwesend) fahren sollen. Nun kommt sie am Nachmittag um 16:23 Uhr nach Hause. Eigentlich sollten nun die Rollos fahren. Doch die Sonnenuntergangsfahrt (schließen) wäre schon 16:51 Uhr und damit innerhalb der 3600 ASC_BlockingTime_beforNightClose. Die Rollos bleiben also unten. Es lohnt sich für die paar Minuten einfach nicht mehr.

==== wiggle====
Mit einem <code>set <ASC-Device> wiggle</code> können alle Rollladen mit einem entsprechenden Attribut zu einer kurzen Fahrt veranlasst werden, nach Ablauf von einer Minute wieder um denselben Wert zurück. Dabei wird jeweils in die Richtung gefahren, die den weiteren Weg ermöglicht. Wenn also zu 70% geschlossen ist, wird der Rollladen hoch fahren.
==== Partymode ====
Dieser wird am ASC-Device selbst aktiviert mittels <code>set <ASC-Device> partyMode on</code>. Alle Rollladen-Devices, welche das Attribut ''ASC_Partymode'' auf ''on'' gestellt haben, werden nicht mehr gesteuert. Der letzte Schaltbefehl, der durch ein Fensterevent oder Bewohnerstatus an die Rollläden gesendet wurde, beim Beenden des Modus durch <code>set ASC-Device partyMode off</code> ausgeführt.
==== lock-out ====
Man kann mit dem Befehl <code> set <ASC-Device> hardLockOut</code> auf einen Schlag alle Rollos sperren welche <code> attr <ROLLO-Device> ASC_LockOut hard</code> gesetzt haben.
Das ist dafür gedacht, wenn Du eine gewisse Zeit den Rolloaktor sperren willst. Zum Beispiel das die Kinder nicht schalten sollen.

== Sonstige Hinweise und Problemlösungen ==
* Werden Attribute geändert, kann es vereinzelt vorkommen, dass das ASC-Modul dies nicht mitbekommt und das tatsächliche Verhalten nicht den Erwartungen entspricht. In so einem Fall empfielt es sich, das NOTIFYDEV nochmals aufbauen zu lassen. Dazu werden zunächst mit <code>set <ASC-Modul> expert 1</code> erweiterte Informationen bezüglich des NotifyDevs unter set und get aktiviert und anschließend ein <code>set <ASC-Modul> createNewNotifyDev</code> ausgeführt.

* Hin und wieder berichten Nutzer davon, wenn Sie die ''Privacy Funktion'' nutzen, dass sich im NOTIFYDEV anstelle des Device Namen ein Raumname befindet. Diese Problem kann damit gelöst werden, dass in dem betroffenen '''Rollo Device''' das Atribut <code>attr event-on-change .*</code> gesetzt wird.
'''Wichtig!''' Nicht verwechseln mit dem ASC Device dort darf <code>attr event-on-change</code> '''nicht''' gesetzt sein!

==== Spezielle Hardware ====
{{Link2Forum|Topic=101182|LinkText="Thread zu getesteter Hardware im Forum"}}

== Weblinks ==
* {{Link2Forum|Topic=92628|LinkText="Thread zum Modul im Forum"}}
* {{Link2Forum|Topic=90751|LinkText="Thread zur Entwicklung im Forum"}}
* {{Link2Forum|Topic=73964|LinkText="Thread zu den Scripten von user cluni"}}, die der Entwicklung des Moduls zugrunde liegen

<references />

[[Kategorie:Code Snippets]]
[[Kategorie:Rollladensteuerung]]

EiMSIG Universalsensor mit EnOcean

2019-04-22T18:20:30Z

Cwagner: redigiert

{{Infobox Hardware
|Bild=Universal-Sensor.png
|Bildbeschreibung=2-Kanal-Tür-Kontakt eingebaut im Türrahmen (EM-USE-00)
|HWProtocol=EnOcean
|HWType=Sensor
|HWCategory=EnOcean
|HWComm=EnOcean Funk, 868Mhz
|HWProtokoll=EnOcean Protokoll EEP A5-14-01 bzw. A5-14-07
|HWChannels=2
|HWVoltage=3V
|HWPowerConsumption=<4µA (beim Senden:25mA)
|HWPoweredBy=2* CR 2032
|HWSize= 135 x 26 x 9 [mm] (Breite × Höhe × Tiefe), Gewicht 34 g
|HWDeviceFHEM=[http://fhem.de/commandref.html#EnOcean EnOcean]
|HWManufacturer=EiMSIG GmbH
}}

'''EnOcean EiMSIG Universalsensor''' ist ein batteriebetriebener schlanker Tür-(Fenster-)Kontakt mit 2 Kanälen

== Features ==
Der Universal-Sensor passt meist in den Luftraum zwischen Tür- und Türrahmen und erkennt per Reed-Kontakt sowie einen Schalter das Öffnen der Tür und den ordnungsgemäßen Verschluss (Schlossriegel vollständig in der Falle).

Im Auslieferungszustand meldet sich der Sensor mit EEP A5-14-01 und wird als subType Multisensor angelegt. In diesem Fall wird nur der Reed-Kontakt erkannt (Kanal A des Gerätes).

== Hinweise zum Betrieb mit FHEM ==
Mit dem von www.fenstersensor.com herunterladbaren PC-Tool EiMSIG Konfigurator (setzt ein USB-Enocean-Gateway wie TCM 300 voraus) kann sehr leicht auf das EEP A5-14-07 umgestellt werden. FHEM erkennt das Gerät dann als subType doorContact und kennt den Kanal A für den Reedkontakt und Kanal B für den Kontakt in der Schlossfalle (Riegelschaltkontakt oder entsprechendes Schließblech; per Kabel an dem Device angeschlossen).

=== Definition/Anlernvorgang ===
4BS-Bidirektionales-Teach-In:

#falls vorhanden, alle bisherigen FHEM Devices des Gerätes löschen und nach Speichern der geänderten Konfiguration FHEM neu starten
#FHEM in Lernmodus versetzen: <code><nowiki>set <IODev> teach <time [s]></nowiki></code>
#Taster am Sensor zwischen 5 und <10 Sekunden drücken. Der erfolgreiche Anlernvorgang wird durch einmaliges Aufleuchten der Status-LED quittiert.
#Alternativ: Taster am Sensor zwischen 2 und <5 Sekunden drücken, damit wird die AES-Verschlüsselung eingeschaltet. Der erfolgreiche Anlernvorgang wird durch einmaliges Aufleuchten der Status-LED quittiert.

=== Readings ===
{| class="wikitable sortable"
|-
! Reading !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|block||unlocked||locked/unlocked||Ist der Kontakt B geschlossen oder offen (z.B. ein Schalter in der Schlossfalle)
|-
|contact||open||open/closed||Ist der Kontakt A (Reed-Kontakt) geschlossen oder offen
|-
|state||C: open B: unlocked V: off U: 3.10||||
|-
|teach||each-in accepted EEP A5-14-07 Manufacturer: EiMSIG, EFP GmbH||||
|-
|vibration||off||||wird von dem Sensor nicht unterstützt
|-
|voltage||3.10||||
|-
|}

=== Attribute ===

== Tipps & Tricks ==

== ToDos ==

== Links ==

[[Kategorie:NeedsEditing]]
[[Kategorie:EnOcean Components]]

EiMSIG Universalsensor mit EnOcean

2019-04-22T09:26:49Z

Cwagner: Foto eingefügt

{{Infobox Hardware
|Bild=Universal-Sensor.png
|Bildbeschreibung=2-Kanal-Tür-Kontakt eingebaut im Türrahmen (EM-USE-00)
|HWProtocol=EnOcean
|HWType=Sensor
|HWCategory=EnOcean
|HWComm=EnOcean Funk, 868Mhz
|HWProtokoll=EnOcean Protokoll EEP A5-14-01 bzw. A5-14-07
|HWChannels=2
|HWVoltage=3V
|HWPowerConsumption=<4µA (beim Senden:25mA)
|HWPoweredBy=2* CR 2032
|HWSize= 135 x 26 x 9 [mm] (Breite × Höhe × Tiefe), Gewicht 34 g
|HWDeviceFHEM=[http://fhem.de/commandref.html#EnOcean EnOcean]
|HWManufacturer=EiMSIG GmbH
}}

'''EnOcean EiMSIG Universalsensor''' ist ein batteriebetriebener schlanker Tür-(Fenster-)Kontakt mit 2 Kanälen

== Features ==
Der Universal-Sensor passt meist in den Luftraum zwischen Tür- und Türrahmen und erkennt per Reed-Kontakt sowie einen Schalter das Öffnen der Tür und den ordnungsgemäßen Verschluss (Schlossriegel vollständig in der Falle).

Im Auslieferungszustand meldet sich der Sensor mit EEP A5-14-01 und wird als subType Multisensor angelegt. In diesem Fall wird nur der Reed-Kontakt erkannt (Kanal A des Gerätes).

== Hinweise zum Betrieb mit FHEM ==
Mit dem von www.fenstersensor.com herunterladbaren PC-Tool EiMSIG Konfigurator (setzt ein USB-Enocean-Gateway wie TCM 300 voraus) kann sehr leicht auf das EEP A5-14-07 umgestellt werden. FHEM erkennt das Gerät dann als subType doorContact und kennt den Kanal A für den Reedkontakt und Kanal B für den Kontakt in der Schlossfalle (per Kabel an dem Device angeschlossen).

=== Definition/Anlernvorgang ===
4BS-Bidirektionales-Teach-In:

#falls vorhanden, alle bisherigen FHEM Devices des Gerätes löschen und nach Speichern der geänderten Konfiguration FHEM neu starten
#FHEM in Lernmodus versetzen: <code><nowiki>set <IODev> teach <time [s]></nowiki></code>
#Taster am Sensor zwischen 5 und <10 Sekunden drücken. Der erfolgreiche Anlernvorgang wird durch einmaliges Aufleuchten der Status-LED quittiert.
#Alternativ: Taster am Sensor zwischen 2 und <5 Sekunden drücken, damit wird die AES-Verschlüsselung eingeschaltet. Der erfolgreiche Anlernvorgang wird durch einmaliges Aufleuchten der Status-LED quittiert.

=== Readings ===
{| class="wikitable sortable"
|-
! Reading !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|block||unlocked||locked/unlocked||Ist der Kontakt B geschlossen oder offen (z.B. ein Schalter in der Schlossfalle)
|-
|contact||open||open/closed||Ist der Kontakt A (Reed-Kontakt) geschlossen oder offen
|-
|state||C: open B: unlocked V: off U: 3.10||||
|-
|teach||each-in accepted EEP A5-14-07 Manufacturer: EiMSIG, EFP GmbH||||
|-
|vibration||off||||wird von dem Sensor nicht unterstützt
|-
|voltage||3.10||||
|-
|}

=== Attribute ===

== Tipps & Tricks ==

== ToDos ==

== Links ==

[[Kategorie:NeedsEditing]]
[[Kategorie:EnOcean Components]]

Datei:Universal-Sensor.png

2019-04-22T09:20:12Z

Cwagner: Unsiversal-Sensor eingebaut im Türrahmen. Das Kabel führt zum Taster für den Schlossriegel

== Beschreibung ==
Unsiversal-Sensor eingebaut im Türrahmen. Das Kabel führt zum Taster für den Schlossriegel

EiMSIG Universalsensor mit EnOcean

2019-04-22T09:15:46Z

Cwagner:

{{Infobox Hardware
|Bild=[[Datei:Universal-Sensor.png|mini|Sensor im Türrahmen]]
|Bildbeschreibung=2-Kanal-Tür-Kontakt (EM-USE-00)
|HWProtocol=EnOcean
|HWType=Sensor
|HWCategory=EnOcean
|HWComm=EnOcean Funk, 868Mhz
|HWProtokoll=EnOcean Protokoll EEP A5-14-01 bzw. A5-14-07
|HWChannels=2
|HWVoltage=3V
|HWPowerConsumption=<4µA (beim Senden:25mA)
|HWPoweredBy=2* CR 2032
|HWSize= 135 x 26 x 9 [mm] (Breite × Höhe × Tiefe), Gewicht 34 g
|HWDeviceFHEM=[http://fhem.de/commandref.html#EnOcean EnOcean]
|HWManufacturer=EiMSIG GmbH
}}

'''EnOcean EiMSIG Universalsensor''' ist ein batteriebetriebener schlanker Tür-(Fenster-)Kontakt mit 2 Kanälen

== Features ==
Der Universal-Sensor passt meist in den Luftraum zwischen Tür- und Türrahmen und erkennt per Reed-Kontakt sowie einen Schalter das Öffnen der Tür und den ordnungsgemäßen Verschluss (Schlossriegel vollständig in der Falle).

Im Auslieferungszustand meldet sich der Sensor mit EEP A5-14-01 und wird als subType Multisensor angelegt. In diesem Fall wird nur der Reed-Kontakt erkannt (Kanal A des Gerätes).

== Hinweise zum Betrieb mit FHEM ==
Mit dem von www.fenstersensor.com herunterladbaren PC-Tool EiMSIG Konfigurator (setzt ein USB-Enocean-Gateway wie TCM 300 voraus) kann sehr leicht auf das EEP A5-14-07 umgestellt werden. FHEM erkennt das Gerät dann als subType doorContact und kennt den Kanal A für den Reedkontakt und Kanal B für den Kontakt in der Schlossfalle (per Kabel an dem Device angeschlossen).

=== Definition/Anlernvorgang ===
4BS-Bidirektionales-Teach-In:

#falls vorhanden, alle bisherigen FHEM Devices des Gerätes löschen und nach Speichern der geänderten Konfiguration FHEM neu starten
#FHEM in Lernmodus versetzen: <code><nowiki>set <IODev> teach <time [s]></nowiki></code>
#Taster am Sensor zwischen 5 und <10 Sekunden drücken. Der erfolgreiche Anlernvorgang wird durch einmaliges Aufleuchten der Status-LED quittiert.
#Alternativ: Taster am Sensor zwischen 2 und <5 Sekunden drücken, damit wird die AES-Verschlüsselung eingeschaltet. Der erfolgreiche Anlernvorgang wird durch einmaliges Aufleuchten der Status-LED quittiert.

=== Readings ===
{| class="wikitable sortable"
|-
! Reading !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|block||unlocked||locked/unlocked||Ist der Kontakt B geschlossen oder offen (z.B. ein Schalter in der Schlossfalle)
|-
|contact||open||open/closed||Ist der Kontakt A (Reed-Kontakt) geschlossen oder offen
|-
|state||C: open B: unlocked V: off U: 3.10||||
|-
|teach||each-in accepted EEP A5-14-07 Manufacturer: EiMSIG, EFP GmbH||||
|-
|vibration||off||||wird von dem Sensor nicht unterstützt
|-
|voltage||3.10||||
|-
|}

=== Attribute ===

== Tipps & Tricks ==

== ToDos ==

== Links ==

[[Kategorie:NeedsEditing]]
[[Kategorie:EnOcean Components]]

EiMSIG Universalsensor mit EnOcean

2019-04-22T09:11:45Z

Cwagner:

{{Infobox Hardware
|Bild=
|Bildbeschreibung=2-Kanal-Tür-Kontakt (EM-USE-00)
|HWProtocol=EnOcean
|HWType=Sensor
|HWCategory=EnOcean
|HWComm=EnOcean Funk, 868Mhz
|HWProtokoll=EnOcean Protokoll EEP A5-14-01 bzw. A5-14-07
|HWChannels=2
|HWVoltage=3V
|HWPowerConsumption=<4µA (beim Senden:25mA)
|HWPoweredBy=2* CR 2032
|HWSize= 135 x 26 x 9 [mm] (Breite × Höhe × Tiefe), Gewicht 34 g
|HWDeviceFHEM=[http://fhem.de/commandref.html#EnOcean EnOcean]
|HWManufacturer=EiMSIG GmbH
}}

'''EnOcean EiMSIG Universalsensor''' ist ein batteriebetriebener schlanker Tür-(Fenster-)Kontakt mit 2 Kanälen

== Features ==
Der Universal-Sensor passt meist in den Luftraum zwischen Tür- und Türrahmen und erkennt per Reed-Kontakt sowie einen Schalter das Öffnen der Tür und den ordnungsgemäßen Verschluss (Schlossriegel vollständig in der Falle).

Im Auslieferungszustand meldet sich der Sensor mit EEP A5-14-01 und wird als subType Multisensor angelegt. In diesem Fall wird nur der Reed-Kontakt erkannt (Kanal A des Gerätes).

== Hinweise zum Betrieb mit FHEM ==
Mit dem von www.fenstersensor.com herunterladbaren PC-Tool EiMSIG Konfigurator (setzt ein USB-Enocean-Gateway wie TCM 300 voraus) kann sehr leicht auf das EEP A5-14-07 umgestellt werden. FHEM erkennt das Gerät dann als subType doorContact und kennt den Kanal A für den Reedkontakt und Kanal B für den Kontakt in der Schlossfalle (per Kabel an dem Device angeschlossen).

=== Definition/Anlernvorgang ===
4BS-Bidirektionales-Teach-In:

#falls vorhanden, alle bisherigen FHEM Devices des Gerätes löschen und nach Speichern der geänderten Konfiguration FHEM neu starten
#FHEM in Lernmodus versetzen: <code><nowiki>set <IODev> teach <time [s]></nowiki></code>
#Taster am Sensor zwischen 5 und <10 Sekunden drücken. Der erfolgreiche Anlernvorgang wird durch einmaliges Aufleuchten der Status-LED quittiert.
#Alternativ: Taster am Sensor zwischen 2 und <5 Sekunden drücken, damit wird die AES-Verschlüsselung eingeschaltet. Der erfolgreiche Anlernvorgang wird durch einmaliges Aufleuchten der Status-LED quittiert.

=== Readings ===
{| class="wikitable sortable"
|-
! Reading !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|block||unlocked||locked/unlocked||Ist der Kontakt B geschlossen oder offen (z.B. ein Schalter in der Schlossfalle)
|-
|contact||open||open/closed||Ist der Kontakt A (Reed-Kontakt) geschlossen oder offen
|-
|state||C: open B: unlocked V: off U: 3.10||||
|-
|teach||each-in accepted EEP A5-14-07 Manufacturer: EiMSIG, EFP GmbH||||
|-
|vibration||off||||wird von dem Sensor nicht unterstützt
|-
|voltage||3.10||||
|-
|}

=== Attribute ===

== Tipps & Tricks ==

== ToDos ==

== Links ==

[[Kategorie:NeedsEditing]]
[[Kategorie:EnOcean Components]]

Vorlage:EnOceanSubTypeTable

2019-04-22T08:01:44Z

Cwagner: doorContact mit Beispiel hinzugefügt

{|
{{News|'''subType''' |'''Wiki-Seite'''}}
{{News|tempSensor.XX | }}
{{News|roomSensorControl.01 | }}
{{News|tempHumiSensor.02 |[[EnOcean-FBH65TFB-Funk-Bewegungs- Helligkeits- Temperatur- und Feuchte-Sensor]] }}
{{News|lightSensor.XX |[[EnOcean-FAH60-Au%C3%9Fen-Helligkeitssensor]] }}
{{News|occupSensor.XX | }}
{{News|lightTempOccupSensor.XX |[[EnOcean-FBH65S-Funk-Bewegungs- Helligkeitssensor]] }}
{{News||[[EnOcean-FBH65TFB-Funk-Bewegungs- Helligkeits- Temperatur- und Feuchte-Sensor]] }}
{{News|COSensor.01 | }}
{{News|tempHumiCO2Sensor.XX | }}
{{News|vocSensor.01 | }}
{{News|radonSensor.01 | }}
{{News|particlesSensor.01 | }}
{{News|roomSensorControl.XX | }}
{{News|tempCtrlState.01 | }}
{{News|shutterCtrlState.01 |[[EnOcean-D-452-FU-EBIM-JR-Aktor-Beschattungselemente-Rollladen]]}}
{{News|blindsCtrl.00 |[[EnOcean-UPJ230_12-Jalousieaktor]]}}
{{News|lightCtrlState.XX |[[EnOcean-D-452-FU-EBIM-Aktor-2fach]] }}
{{News|autoMeterReading.XX |[[EnOcean-FSR61VA-10A-Stromstoß-Schaltrelais mit Strommessung]] }}
{{News|environmentApp |[[EnOcean-FWS61-24V-DC-Funk-Wetterdaten-Sendemodul]] }}
{{News|multiFuncSensor | }}
{{News|hvac.XX |[[EnOcean-MD15-Kleinstellantrieb]] }}
{{News||[[Micropelt iRTV Kleinstellantrieb]] }}
{{News|digitalInput.XX | }}
{{News|gateway; gwCmd switching|[[EnOcean-FSR14-4x-RS485-Bus-Schaltaktor-4-Kanal-Stromstoß-Schaltrelais]] }}
{{News|gateway; gwCmd dimming|[[EnOcean-FUD12NPN-RS485-Bus-Universal-Dimmaktor]] }}
{{News||[[EnOcean-FUD14-RS485-Bus-Universal-Dimmaktor]] }}
{{News||[[EnOcean-FUD61NPN-Funk-Universal-Dimmaktor]] }}
{{News||[[EnOcean-FUD61NPN-Funk-Universal-Dimmaktor-unidirektional]] }}
{{News||{{Link2Forum|Topic=58832|LinkText=Osram Touch Dim RC}} }}
{{News|gateway; gwCmd blindCmd|[[EnOcean-D-452-FU-EBIM-JR-Aktor-Beschattungselemente-Rollladen]] }}
{{News||[[EnOcean-D-452-FU-EBI-JR-Aktor-Beschattungselemente-Rollladen]] }}
{{News|manufProfile |[[EnOcean-FSB12-RS485-Bus-Schaltaktor-2-Kanal-Beschattungselemente-Rollladen]] }}
{{News||[[EnOcean-FSB14-RS485-Bus-Schaltaktor-2-Kanal-Beschattungselemente-Rollladen]]}}
{{News||[[EnOcean-FSB61-Aktor-Beschattungselemente-Rollladen]]}}
{{News|actuator.01 |[[EnOcean-D-452-FU-EBIM-Aktor-2fach]] }}
{{News||[[EnOcean-PSC234-Zwischenstecker]] }}
{{News|switch.XX |[[EnOcean-PTM-210-Taster]] }}
{{News||[[EnOcean-FBH65TFB-Funk-Bewegungs- Helligkeits- Temperatur- und Feuchte-Sensor]]}}
{{News||[[EnOcean-FSR12-4x-RS485-Bus-Schaltaktor-4-Kanal-Stromstoß-Schaltrelais]]}}
{{News||[[EnOcean-FMS61NP-2-Kanal-Multifunktions-Stromstoßschalter]]}}
{{News||[[EnOcean-FSR61VA-10A-Stromstoß-Schaltrelais mit Strommessung]]}}
{{News||[[EnOcean-SecuSignal-Fenstergriff]]}}
{{News|roomCtrlPanel.00 | }}
{{News|contact |[[EnOcean_Starter_Guide#Kontakte]] }}
{{News||[[EnOcean-STM-250-Fenster-Türkontakt]]}}
{{News|keycard.xx | }}
{{News|windowHandle.XX |[[EnOcean-SecuSignal-Fenstergriff]]}}
{{News|sensor | }}
{{News|smokeDetector.02 |[[EnOcean-FRW-Rauchmelder]]}}
{{News|PM101|[[EnOcean_Starter_Guide#Profilloses_4BS-Teach-In]] }}
{{News|raw | }}
{{News|doorContact|[[EiMSIG Universalsensor mit EnOcean]] }}
|}

<code>Die Endung .XX bei einem subType bedeutet, dass es mehrere subType-Untervarianten gibt, die sich aber nur in Kleinigkeiten -zumeist Skalierung- unterscheiden.</code>

EiMSIG Universalsensor mit EnOcean

2019-04-22T07:58:51Z

Cwagner: Wiki-Überschrift angeglichen

{{Infobox Hardware
|Bild=
|Bildbeschreibung=2-Kanal-Tür-Kontakt
|HWProtocol=EnOcean
|HWType=Sensor
|HWCategory=EnOcean
|HWComm=EnOcean Funk, 868Mhz
|HWProtokoll=EnOcean Protokoll EEP A5-14-01 bzw. A5-14-07
|HWChannels=2
|HWVoltage=3V
|HWPowerConsumption=<20µA (beim Senden:25mA
|HWPoweredBy=2* CR 2032
|HWSize= 135 x 26 x 9 [mm] (Breite × Höhe × Tiefe), Gewicht 34 g
|HWDeviceFHEM=[http://fhem.de/commandref.html#EnOcean EnOcean]
|HWManufacturer=EiMSIG GmbH
}}

'''EnOcean EiMSIG Universalsensor''' ist ein batteriebetriebener schlanker Tür-(Fenster-)Kontakt mit 2 Kanälen

== Features ==
Der Universal-Sensor passt meist in den Luftraum zwischen Tür- und Türrahmen und erkennt per Reed-Kontakt sowie einen Schalter das Öffnen der Tür und den ordnungsgemäßen Verschluss (Schlossriegel vollständig in der Falle).

Im Auslieferungszustand meldet sich der Sensor mit EEP A5-14-01 und wird als subType Multisensor angelegt. In diesem Fall wird nur der Reed-Kontakt erkannt (Kanal A des Gerätes).

== Hinweise zum Betrieb mit FHEM ==
Mit dem von www.fenstersensor.com herunterladbaren PC-Tool EiMSIG Konfigurator (setzt ein USB-Enocean-Gateway wie TCM 300 voraus) kann sehr leicht auf das EEP A5-14-07 umgestellt werden. FHEM erkennt das Gerät dann als subType doorContact und kennt den Kanal A für den Reedkontakt und Kanal B für den Kontakt in der Schlossfalle (per Kabel an dem Device angeschlossen).

=== Definition/Anlernvorgang ===
4BS-Bidirektionales-Teach-In:

#falls vorhanden, alle bisherigen FHEM Devices des Gerätes löschen und nach Speichern der geänderten Konfiguration FHEM neu starten
#FHEM in Lernmodus versetzen: <code><nowiki>set <IODev> teach <time [s]></nowiki></code>
#Taster am Sensor zwischen 5 und <10 Sekunden drücken. Der erfolgreiche Anlernvorgang wird durch einmaliges Aufleuchten der Status-LED quittiert.
#Alternativ: Taster am Sensor zwischen 2 und <5 Sekunden drücken, damit wird die AES-Verschlüsselung eingeschaltet. Der erfolgreiche Anlernvorgang wird durch einmaliges Aufleuchten der Status-LED quittiert.

=== Readings ===
{| class="wikitable sortable"
|-
! Reading !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|block||unlocked||locked/unlocked||Ist der Kontakt B geschlossen oder offen (z.B. ein Schalter in der Schlossfalle)
|-
|contact||open||open/closed||Ist der Kontakt A (Reed-Kontakt) geschlossen oder offen
|-
|state||C: open B: unlocked V: off U: 3.10||||
|-
|teach||each-in accepted EEP A5-14-07 Manufacturer: EiMSIG, EFP GmbH||||
|-
|vibration||off||||wird von dem Sensor nicht unterstützt
|-
|voltage||3.10||||
|-
|}

=== Attribute ===

== Tipps & Tricks ==

== ToDos ==

== Links ==

[[Kategorie:NeedsEditing]]
[[Kategorie:EnOcean Components]]

EiMSIG Universalsensor mit EnOcean

2019-04-22T07:56:22Z

Cwagner: Inititale Fassung

{{Infobox Hardware
|Bild=
|Bildbeschreibung=2-Kanal-Tür-Kontakt
|HWProtocol=EnOcean
|HWType=Sensor
|HWCategory=EnOcean
|HWComm=EnOcean Funk, 868Mhz
|HWProtokoll=EnOcean Protokoll EEP A5-14-01 bzw. A5-14-07
|HWChannels=2
|HWVoltage=3V
|HWPowerConsumption=<20µA (beim Senden:25mA
|HWPoweredBy=2* CR 2032
|HWSize= 135 x 26 x 9 [mm] (Breite × Höhe × Tiefe), Gewicht 34 g
|HWDeviceFHEM=[http://fhem.de/commandref.html#EnOcean EnOcean]
|HWManufacturer=EiMSIG GmbH
}}

'''EiMSIG Universalsensor mit EnOcean''' ist ein batteriebetriebener schlanker Tür-(Fenster-)Kontakt mit 2 Kanälen

== Features ==
Der Universal-Sensor passt meist in den Luftraum zwischen Tür- und Türrahmen und erkennt per Reed-Kontakt sowie einen Schalter das Öffnen der Tür und den ordnungsgemäßen Verschluss (Schlossriegel vollständig in der Falle).

Im Auslieferungszustand meldet sich der Sensor mit EEP A5-14-01 und wird als subType Multisensor angelegt. In diesem Fall wird nur der Reed-Kontakt erkannt (Kanal A des Gerätes).

== Hinweise zum Betrieb mit FHEM ==
Mit dem von www.fenstersensor.com herunterladbaren PC-Tool EiMSIG Konfigurator (setzt ein USB-Enocean-Gateway wie TCM 300 voraus) kann sehr leicht auf das EEP A5-14-07 umgestellt werden. FHEM erkennt das Gerät dann als subType doorContact und kennt den Kanal A für den Reedkontakt und Kanal B für den Kontakt in der Schlossfalle (per Kabel an dem Device angeschlossen).

=== Definition/Anlernvorgang ===
4BS-Bidirektionales-Teach-In:

#falls vorhanden, alle bisherigen FHEM Devices des Gerätes löschen und nach Speichern der geänderten Konfiguration FHEM neu starten
#FHEM in Lernmodus versetzen: <code><nowiki>set <IODev> teach <time [s]></nowiki></code>
#Taster am Sensor zwischen 5 und <10 Sekunden drücken. Der erfolgreiche Anlernvorgang wird durch einmaliges Aufleuchten der Status-LED quittiert.
#Alternativ: Taster am Sensor zwischen 2 und <5 Sekunden drücken, damit wird die AES-Verschlüsselung eingeschaltet. Der erfolgreiche Anlernvorgang wird durch einmaliges Aufleuchten der Status-LED quittiert.

=== Readings ===
{| class="wikitable sortable"
|-
! Reading !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|block||unlocked||locked/unlocked||Ist der Kontakt B geschlossen oder offen (z.B. ein Schalter in der Schlossfalle)
|-
|contact||open||open/closed||Ist der Kontakt A (Reed-Kontakt) geschlossen oder offen
|-
|state||C: open B: unlocked V: off U: 3.10||||
|-
|teach||each-in accepted EEP A5-14-07 Manufacturer: EiMSIG, EFP GmbH||||
|-
|vibration||off||||wird von dem Sensor nicht unterstützt
|-
|voltage||3.10||||
|-
|}

=== Attribute ===

== Tipps & Tricks ==

== ToDos ==

== Links ==

[[Kategorie:NeedsEditing]]
[[Kategorie:EnOcean Components]]

Micropelt iTRV Kleinstellantrieb

2019-01-20T17:49:37Z

Cwagner: Modell MVA-005 wird von FHEM direkt unterstützt

{{Infobox Hardware
|Bild=ITRV.jpg
|Bildbeschreibung=Batterieloser Heizungssteller
|HWProtocol=EnOcean
|HWType=Aktor
|HWCategory=EnOcean
|HWComm=EnOcean Funk, 868Mhz
|HWProtokoll=EnOcean Protokoll EEP A5-20-01 (Ventil Position in %)
|HWChannels=1 (bidirektional)
|HWVoltage=3.7 V, LiOn-Akku
|HWPowerConsumption=
|HWPoweredBy=TEG (Thermoelektrischer Generator;autark)
|HWSize=59 × 64 × 59 [mm] (Breite × Höhe × Tiefe), Gewicht 260 g
|HWDeviceFHEM=[http://fhem.de/commandref.html#EnOcean EnOcean]
|HWManufacturer=Micropelt GmbH
}}

'''EnOcean-Micropelt iRTV-Kleinstellantrieb''' ist ein batterieloser Kleinstellantrieb für Raumtemperaturregelung. Hier wird vorrangig das Modell MVA-002 beschrieben.
Das Modell MVA-004 ist rund und hat einen eigenen PID-Controller, das Modell MVA-005 (ebenfalls rund) hat zusätzlich eine Handverstellung in Ein-Grad-Schritten (bis +/- 5°). Beide Modelle sind noch leiser und sollen laut Hersteller bei schwacher Funkversorgung die Verbindung besser halten. Das Modell MVA-005 hat das EEP A5-20-06, das seit 21.1.2019 von FHEM unterstützt wird.

== Features ==
Kleinstellantrieb, der ohne Batterien auskommt, da er über einen thermolektrischen Generator seine Energie aus der Temperaturdifferenz des Heizungsvorlaufes und der Raumtemperatur bezieht.

== Hinweise zum Betrieb mit FHEM ==

=== Definition/Anlernvorgang ===
4BS-Bidirektionales-Teach-In:

#falls vorhanden, alle bisherigen FHEM Devices des Aktors löschen und nach Speichern der geänderten Konfiguration FHEM neu starten
#FHEM in Lernmodus versetzen: <code><nowiki>set <IODev> teach <time [s]></nowiki></code>
#Taster am iTRV zweimal drücken (Montageposition = 0%). Der erfolgreiche Anlernvorgang wird durch einmaliges Aufleuchten der Status-LED quittiert. (Fehlanzeige: 6mal Blinken)
#Nach Montage Taster einmal drücken - das Ventil fährt die von FHEM gewünschte Position an.
#Aktor-Device wird in FHEM automatisch mit allen notwendigen Parametern angelegt.

Standardmäßig nutzt FHEM den eigenen PID-Regler des FHEM-Moduls, der auf die Eingabe einer Temperaturvorgabe wartet:
<code><nowiki>set <name> desired-temp <wert°C></nowiki></code>

Solange kein Referenz-Device mit <code><nowiki>set <name> temperatureRefDev <Temperaturdevice mit einem Reading temperature></nowiki></code> angegeben wurde, benutzt das Gerät einen internen Temperaturfühler, der bauartbedingt nicht (MVA-005:bedingt) geeignet für eine Raumregelung ist.

Zur Sicherheit des Heizkörperventils gegen Festsetzen durch Rost oder Kalk, wird im Sommermodus pro Tag eine Servicefahrt – einmal auf und zu – des Ventils durchgeführt. Zusätzlich wird dreimal am Tag die Verbindung mit FHEM aufgerufen. Das dient zur Kontrolle, dass alle bislang verbundenen Devices noch vorhanden sind und ordnungsgemäß miteinander kommunizieren.

Wenn mehr als dreimal hintereinander die Funkkommunikation mit FHEM fehlschlug (was mehr als 30 Minuten im Normalbetrieb bedeutet), sendet der Aktor nur noch alle Stunde und - falls das Ventil zu weniger als 50 Prozent geöffent ist, wird es auf 50% aufgefahren bzw. bei MVA-004 und MVA-005 im internen PID-Betrieb auf 21° gesteuert.

'''Durch einmaliges Drücken des Tasters''' kann man im Alltagsbetrieb eine sofortige Funkkommunikation auslösen.

{{Hinweis|Zum Energiesparen verarbeitet der Aktor nur alle 586 oder 587 Sekunden (Sommermodus: alle 8 Stunden) Telegramme von FHEM. Darum zeigen FHEM-Befehle keine sofortige Aktorreaktion, sondern erst nach der genannten Zeitspanne. Die Rückmeldung des Aktors an FHEM über die erfolgte Befehlsausführung erfolgt wiederum erst nach erneutem Ablauf der Zeitspanne.
Falls keine Temperaturdaten geliefert werden, geht das Device in einen Stromsparmodus und fragt nur noch alle 2 Stunden an.
Zur Vermeidung dieses Stromsparmodus, in dem eben auch nicht nachgeregelt wird, sollte bei Referenzgeräte wie einem Raumthermometer das attr event-on-update '''nicht''' benutzt werden. Falls die Temperatur sich 1 Stunde lang nicht ändert, würde entsprechend auch eine Stunde lang kein Referenzwert gesendet, der Stelltrieb in den Sparmodus gehen und für die nächsten 2 Stunden nun kommende Änderungen nicht verarbeiten.
In der Praxis mit einem TCM 310 zeigt sich, dass bei einem RSSI<-80 die Funkkommunikation nicht ausreichend stabil ist. Wenn dreimal hintereinander keine Funktbestätigung erhalten wurde, geht der Aktor in den Notbetrieb und öffnet das Ventil auf 50% oder lässt es auf einem gesetzten größeren Wert bis zur nächsten erfolgreichen bisdirektionalen Kommunikation offen. Das Anpassen der Antennenausrichtung ist hier sehr wichtig.}}

=== Settings ===
{| class="wikitable sortable"
|-
! set !! Wertebereich/Default !! Beschreibung
|-
|desired-temp||10...30||Soll-Temperatur für den FHEM-PID-Controler, der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet
|-
|liftSet||||??
|-
|runInit||||beim nächsten Funkkontakt wird ein Kalibrierungslauf angestoßen
|-
|setpoint||0...100||Setze Aktorposition auf X%; der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet, wenn das attr pidCtrl on ist
|-
|setpointTemp||10...30||Soll-Temperatur für den FHEM-PID-Controler, der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet; ein runInit wird ausgelöst wenn das attr pidCtrl on ist
|-
|ValveCloses||||Ventil auf 0% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|ValveOpens||||Ventil auf 100% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|}

=== Readings ===
{| class="wikitable sortable"
|-
! Reading !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|actuatorState||ok||||wenn 'obstructed', dann ist der metallene Kühlring des Gehäuses z.b. von einem Vorhang bedeckt und der Thermogenerator kann nicht richtig arbeiten
|-
|alarm||no_response_from_actuator||||nur fallweise: wenn Kommunikation ausgefallen; Aktor blinkt dreimal
|-
|battery||ok ||'''ok''' / low||
|-
|cover||closed||||wird vom MVA-002 nicht gesendet
|-
|delta||-9.75||||
|-
|energyInput||enabled||'''enabled''' / disabled||enabled zeigt ausreichende Temperaturdifferenz zur Speisung des Akkus an
|-
|energyStorage||charged||'''charged''' / empty ||
|-
|maintenanceMode||off||'''off''' / runinit||
|-
|operationMode||setpointTemp||'''setpointTemp''' / summerMode / setpointSet||'''Betrieb mit Stellwert-Vorgabe''' / im Sommer-Modus / mit Temperatursollwert-Vorgabe
|-
|operationModeRestore||setpointTemp||||nur fallweise: Modus, der beim Beenden des summermode gesetzt wird
|-
|pidAlarm||||actuator_in_errorPos / dead_sensor / no_temperature_value / setpoint_device_missing||
|-
|pidState||||processing|alarm / idle / '''processing''' / start / stop||
|-
|p_d||0||||
|-
|p_i||100||||
|-
|p_p||-487.5||||
|-
|roomTemp||22.0||||interne MVA-002-Temperatur (wenn attr setpointRefDev nicht gesetzt wird diese Temperatur benutzt - ist für Regelung nicht brauchbar wegen Verfälschung durch Vorlauftemperatur, höhere Temperaturen sind Indiz für Wärmeangebot vom Vorlauf, das den Energiespeicher lädt)
|-
|selfCtrl||off||||MVA-002 hat keinen eigenen PID-Controler
|-
|setpoint||0||||beim letzten Funkkontakt gemeldete Ist-Position vom Aktuator in %
|-
|setpointSet||15||||beim nächsten Funkkontakt gesendete Aktuatorstellung in %
|-
|setpointTemp||15.0||||Soll-Temperatur. Kann gesetzt werden über <code><nowiki>set <IODev> desired-temp <°C></nowiki></code> oder auch durch Module wie Heating_Control oder WeekdayTimer
|-
|setpointTempRestore||16.0 ||||nur fallweise: setpointTemp, die bei Beenden des summermode gesetzt wird
|-
|state||T: 23.4 SPT: 15.0 SP: 0||||T:=Raumtemperatur vom Referenzsensor, SPT=setpointTemp, SP=setpoint
|-
|teach||4BS teach-in accepted EEP A5-20-01 Manufacturer: Micropelt GmbH||||
|-
|temperature||24.75||||zuletzt gemeldete Raumtemperatur vom Referenz-Sensor (siehe Attribut temperatureRefDev)
|-
|waitingCmds||runInit|||noch nicht gesendetes Kommando, hier Kalibrierungslauf|
|-
|wakeUpCycle||240|||das Gerät meldet sich alle 4 Minuten|
|-
|window||closed||open / '''closed'''||wird vom MVA-002 nicht gesendet
|-
|}

=== Attribute ===
{| class="wikitable sortable"
|-
! Attribut !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|comMode||biDir||||
|-
|destinationID||unicast||||
|-
|eep||A5-20-01||||MVA-002 bis MVA-004; beim MVA-005 A5-20-06
|-
|manufID||049||||
|-
|pidActorErrorPos||20||||MVA-002 ignoriert diesen Wert und benutzt '''50%''' oder den zuvor gesendeten höheren Stellwert
|-
|pidActorLimitLower||1||||bei 0% Öffnung wird eine Initialisierung ausgelöst?
|-
|pidCtrl||on||||bei on wird der FHEM Pid-Controler benutzt, bei off der im Actor (Modell MVA-002 hat keinen internen PID-Controler, wohl aber MVA-004 und MVA-005)
|-
|pidFactor_I||0.2||||
|-
|pidFactor_P||50||||
|-
|pidSensorTimeout||3600|||| Zahl der Sekunden, in denen der Sensor auf einen Wert vom temperatureRefDev auf einen Wert wartet, sonst Alarm
|-
|rcvRespAction||||||Hier kann eine Aktion eingetragen werden, die bei Rückmeldung des Aktors durchgeführt wird. Details in der FHEM-Referenz
|-
|setpointRefDev||||||Das Device, das die Ventilöffnung (Aktuator) vorgibt, z.B. ein Raumregler, FHEM-PID20. Typischerweise '''nicht gesetzt, es wird der modul-eigene PID-Controler benutzt'''
|-
|setpointSummerMode||2||||Ventilöffnung, die im Sommer gelten soll
|-
|setpointTempRefDev||CC.Kueche||||Eintragen, wenn ein Device, die Solltemperatur vorgibt, z.B. Heating_Control oder ein physischer Raumthermostat, der in FHEM ausgelesen wird.
|-
|subDef||********||||Sender-ID
|-
|subType||hvac.01||||bei MVA-002 bis MVA-004: hvac.01; bei MVA-005: hvac.06
|-
|summerMode||off||||
|-
|teachMethod||4BS||||
|-
|temperatureRefDev||T.Kueche||||Das Device, das fortlaufend die Ist-Temperatur meldet
|-
|webCmd||setpointTemp||||
|-
|}

== Tipps & Tricks ==
Fehlermeldungen wie Sensor dead oder no Response from actuator kann man im Betrieb mit einem externen Sensor verhindern, in dem man mindestens alle 5 Minuten einen Temperaturwert sendet (gegebenenfalls mit attr event-min-interval im sendenden Temperatur-Device einstellen). Alternativ kann man auch über ein DOIF alle 24 Stunden den Wunschwert mit <Code>set <Devicename> desired-temp 20</Code> wiederholen, wobei 20 beispielhaft eine Wunschtemperatur ist.

Für eine stabile Funkkommunikation ist ein RSSI von besser als -80 anzustreben. Eine Verbesserungsmöglichkeit bietet das versuchsweise Drehen des Micropelt am Heizkörper um 90°. Normalerweise ist der geprägte Schriftzug Micropelt waagerecht wie auch die innen liegende Antenne. Nach der Drehung steht diese dann aufrecht. Das passt in der Praxis dann manchmal besser zu einer waagerecht angeordneten Senderantenne, deren Leistung sich dann gezielter im Haus verbreitet. Ein RSSI von -70 ist besser als -80.
Die Empfangsqualität aller EnOcean-Geräte lässt sich schnell mit <Code>list .* TCM_ESP3_0_RSSI</Code> abfragen, wobei TCM_ESP3_0 der Name des EnOcean-Gateways ist.

== ToDos ==
event-on-NN beim Sensor, wakeupCycle

Sorgt Setpoint 0 für eine Initialisierung?

Optimierung von p_i,p_d,p_p in der Praxis

Bedeutung von set <name> liftSet

== Links ==
* {{Link2Forum|Topic=34314|Message=290203|LinkText=Forenbeitrag}}

[[Kategorie:EnOcean Components]]
[[Kategorie:Heizungsventile]]

Micropelt iTRV Kleinstellantrieb

2019-01-13T07:50:17Z

Cwagner: Modellvarianten aufgeführt

{{Infobox Hardware
|Bild=ITRV.jpg
|Bildbeschreibung=Batterieloser Heizungssteller
|HWProtocol=EnOcean
|HWType=Aktor
|HWCategory=EnOcean
|HWComm=EnOcean Funk, 868Mhz
|HWProtokoll=EnOcean Protokoll EEP A5-20-01 (Ventil Position in %)
|HWChannels=1 (bidirektional)
|HWVoltage=3.7 V, LiOn-Akku
|HWPowerConsumption=
|HWPoweredBy=TEG (Thermoelektrischer Generator;autark)
|HWSize=59 × 64 × 59 [mm] (Breite × Höhe × Tiefe), Gewicht 260 g
|HWDeviceFHEM=[http://fhem.de/commandref.html#EnOcean EnOcean]
|HWManufacturer=Micropelt GmbH
}}

'''EnOcean-Micropelt iRTV-Kleinstellantrieb''' ist ein batterieloser Kleinstellantrieb für Raumtemperaturregelung. Hier wird vorrangig das Modell MVA-002 beschrieben.
Das Modell MVA-004 ist rund und hat einen eigenen PID-Controller, das Modell MVA-005 (ebenfalls rund) hat zusätzlich eine Handverstellung in Ein-Grad-Schritten (bis +/- 5°). Beide Modelle sind noch leiser und sollen laut Hersteller bei schwacher Funkversorgung die Verbindung besser halten. Das Modell MVA-005 hat das EEP A5-20-06, das aktuell noch nicht von FHEM unterstützt wird. Mit EEP A5-20-01 ist ein Basisbetrieb möglich.

== Features ==
Kleinstellantrieb, der ohne Batterien auskommt, da er über einen thermolektrischen Generator seine Energie aus der Temperaturdifferenz des Heizungsvorlaufes und der Raumtemperatur bezieht.

== Hinweise zum Betrieb mit FHEM ==

=== Definition/Anlernvorgang ===
4BS-Bidirektionales-Teach-In:

#falls vorhanden, alle bisherigen FHEM Devices des Aktors löschen und nach Speichern der geänderten Konfiguration FHEM neu starten
#FHEM in Lernmodus versetzen: <code><nowiki>set <IODev> teach <time [s]></nowiki></code>
#Taster am iTRV zweimal drücken (Montageposition = 0%). Der erfolgreiche Anlernvorgang wird durch einmaliges Aufleuchten der Status-LED quittiert. (Fehlanzeige: 6mal Blinken)
#Nach Montage Taster einmal drücken - das Ventil fährt die von FHEM gewünschte Position an.
#Aktor-Device wird in FHEM automatisch mit allen notwendigen Parametern angelegt.

Standardmäßig nutzt FHEM den eigenen PID-Regler des FHEM-Moduls, der auf die Eingabe einer Temperaturvorgabe wartet:
<code><nowiki>set <name> desired-temp <wert°C></nowiki></code>

Solange kein Referenz-Device mit <code><nowiki>set <name> temperatureRefDev <Temperaturdevice mit einem Reading temperature></nowiki></code> angegeben wurde, benutzt das Gerät einen internen Temperaturfühler, der bauartbedingt nicht geeignet für eine Raumregelung ist.

Zur Sicherheit des Heizkörperventils gegen Festsetzen durch Rost oder Kalk, wird im Sommermodus pro Tag eine Servicefahrt – einmal auf und zu – des Ventils durchgeführt. Zusätzlich wird dreimal am Tag die Verbindung mit FHEM aufgerufen. Das dient zur Kontrolle, dass alle bislang verbundenen Devices noch vorhanden sind und ordnungsgemäß miteinander kommunizieren.

Wenn mehr als dreimal hintereinander die Funkkommunikation mit FHEM fehlschlug (was mehr als 30 Minuten im Normalbetrieb bedeutet), sendet der Aktor nur noch alle Stunde und - falls das Ventil zu weniger als 50 Prozent geöffent ist, wird es auf 50% aufgefahren.

'''Durch einmaliges Drücken des Tasters''' kann man im Alltagsbetrieb eine sofortige Funkkommunikation auslösen.

{{Hinweis|Zum Energiesparen verarbeitet der Aktor nur alle 586 oder 587 Sekunden (Sommermodus: alle 8 Stunden) Telegramme von FHEM. Darum zeigen FHEM-Befehle keine sofortige Aktorreaktion, sondern erst nach der genannten Zeitspanne. Die Rückmeldung des Aktors an FHEM über die erfolgte Befehlsausführung erfolgt wiederum erst nach erneutem Ablauf der Zeitspanne.
Falls keine Temperaturdaten geliefert werden, geht das Device in einen Stromsparmodus und fragt nur noch alle 2 Stunden an.
Zur Vermeidung dieses Stromsparmodus, in dem eben auch nicht nachgeregelt wird, sollte bei Referenzgeräte wie einem Raumthermometer das attr event-on-update '''nicht''' benutzt werden. Falls die Temperatur sich 1 Stunde lang nicht ändert, würde entsprechend auch eine Stunde lang kein Referenzwert gesendet, der Stelltrieb in den Sparmodus gehen und für die nächsten 2 Stunden nun kommende Änderungen nicht verarbeiten.
In der Praxis mit einem TCM 310 zeigt sich, dass bei einem RSSI<-80 die Funkkommunikation nicht ausreichend stabil ist. Wenn dreimal hintereinander keine Funktbestätigung erhalten wurde, geht der Aktor in den Notbetrieb und öffnet das Ventil auf 50% oder lässt es auf einem gesetzten größeren Wert bis zur nächsten erfolgreichen bisdirektionalen Kommunikation offen. Das Anpassen der Antennenausrichtung ist hier sehr wichtig.}}

=== Settings ===
{| class="wikitable sortable"
|-
! set !! Wertebereich/Default !! Beschreibung
|-
|desired-temp||10...30||Soll-Temperatur für den FHEM-PID-Controler, der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet
|-
|liftSet||||??
|-
|runInit||||beim nächsten Funkkontakt wird ein Kalibrierungslauf angestoßen
|-
|setpoint||0...100||Setze Aktorposition auf X%; der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet, wenn das attr pidCtrl on ist
|-
|setpointTemp||10...30||Soll-Temperatur für den FHEM-PID-Controler, der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet; ein runInit wird ausgelöst wenn das attr pidCtrl on ist
|-
|ValveCloses||||Ventil auf 0% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|ValveOpens||||Ventil auf 100% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|}

=== Readings ===
{| class="wikitable sortable"
|-
! Reading !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|actuatorState||ok||||wenn 'obstructed', dann ist der metallene Kühlring des Gehäuses z.b. von einem Vorhang bedeckt und der Thermogenerator kann nicht richtig arbeiten
|-
|alarm||no_response_from_actuator||||nur fallweise: wenn Kommunikation ausgefallen; Aktor blinkt dreimal
|-
|battery||ok ||'''ok''' / low||
|-
|cover||closed||||wird vom MVA-002 nicht gesendet
|-
|delta||-9.75||||
|-
|energyInput||enabled||'''enabled''' / disabled||enabled zeigt ausreichende Temperaturdifferenz zur Speisung des Akkus an
|-
|energyStorage||charged||'''charged''' / empty ||
|-
|maintenanceMode||off||'''off''' / runinit||
|-
|operationMode||setpointTemp||'''setpointTemp''' / summerMode / setpointSet||'''Betrieb mit Stellwert-Vorgabe''' / im Sommer-Modus / mit Temperatursollwert-Vorgabe
|-
|operationModeRestore||setpointTemp||||nur fallweise: Modus, der beim Beenden des summermode gesetzt wird
|-
|pidAlarm||||actuator_in_errorPos / dead_sensor / no_temperature_value / setpoint_device_missing||
|-
|pidState||||processing|alarm / idle / '''processing''' / start / stop||
|-
|p_d||0||||
|-
|p_i||100||||
|-
|p_p||-487.5||||
|-
|roomTemp||22.0||||interne MVA-002-Temperatur (wenn attr setpointRefDev nicht gesetzt wird diese Temperatur benutzt - ist für Regelung nicht brauchbar wegen Verfälschung durch Vorlauftemperatur, höhere Temperaturen sind Indiz für Wärmeangebot vom Vorlauf, das den Energiespeicher lädt)
|-
|selfCtrl||off||||MVA-002 hat keinen eigenen PID-Controler
|-
|setpoint||0||||beim letzten Funkkontakt gemeldete Ist-Position vom Aktuator in %
|-
|setpointSet||15||||beim nächsten Funkkontakt gesendete Aktuatorstellung in %
|-
|setpointTemp||15.0||||Soll-Temperatur. Kann gesetzt werden über <code><nowiki>set <IODev> desired-temp <°C></nowiki></code> oder auch durch Module wie Heating_Control oder WeekdayTimer
|-
|setpointTempRestore||16.0 ||||nur fallweise: setpointTemp, die bei Beenden des summermode gesetzt wird
|-
|state||T: 23.4 SPT: 15.0 SP: 0||||T:=Raumtemperatur vom Referenzsensor, SPT=setpointTemp, SP=setpoint
|-
|teach||4BS teach-in accepted EEP A5-20-01 Manufacturer: Micropelt GmbH||||
|-
|temperature||24.75||||zuletzt gemeldete Raumtemperatur vom Referenz-Sensor (siehe Attribut temperatureRefDev)
|-
|waitingCmds||runInit|||noch nicht gesendetes Kommando, hier Kalibrierungslauf|
|-
|wakeUpCycle||240|||das Gerät meldet sich alle 4 Minuten|
|-
|window||closed||open / '''closed'''||wird vom MVA-002 nicht gesendet
|-
|}

=== Attribute ===
{| class="wikitable sortable"
|-
! Attribut !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|comMode||biDir||||
|-
|destinationID||unicast||||
|-
|eep||A5-20-01||||MVA-002 bis MVA-005: dies eintragen, wenn beim Teach-in ein anderer Wert eingetragen wurde
|-
|manufID||049||||
|-
|pidActorErrorPos||20||||MVA-002 ignoriert diesen Wert und benutzt '''50%''' oder den zuvor gesendeten höheren Stellwert
|-
|pidActorLimitLower||1||||bei 0% Öffnung wird eine Initialisierung ausgelöst?
|-
|pidCtrl||on||||bei on wird der FHEM Pid-Controler benutzt, bei off der im Actor (Modell MVA-002 hat keinen internen PID-Controler, wohl aber MVA-004 und MVA-005)
|-
|pidFactor_I||0.2||||
|-
|pidFactor_P||50||||
|-
|pidSensorTimeout||3600|||| Zahl der Sekunden, in denen der Sensor auf einen Wert vom temperatureRefDev auf einen Wert wartet, sonst Alarm
|-
|rcvRespAction||||||Hier kann eine Aktion eingetragen werden, die bei Rückmeldung des Aktors durchgeführt wird. Details in der FHEM-Referenz
|-
|setpointRefDev||||||Das Device, das die Ventilöffnung (Aktuator) vorgibt, z.B. ein Raumregler, FHEM-PID20. Typischerweise '''nicht gesetzt, es wird der modul-eigene PID-Controler benutzt'''
|-
|setpointSummerMode||2||||Ventilöffnung, die im Sommer gelten soll
|-
|setpointTempRefDev||CC.Kueche||||Eintragen, wenn ein Device, die Solltemperatur vorgibt, z.B. Heating_Control oder ein physischer Raumthermostat, der in FHEM ausgelesen wird.
|-
|subDef||********||||Sender-ID
|-
|subType||hvac.01||||
|-
|summerMode||off||||
|-
|teachMethod||4BS||||
|-
|temperatureRefDev||T.Kueche||||Das Device, das fortlaufend die Ist-Temperatur meldet
|-
|webCmd||setpointTemp||||
|-
|}

== Tipps & Tricks ==
Fehlermeldungen wie Sensor dead oder no Response from actuator kann man im Betrieb mit einem externen Sensor verhindern, in dem man mindestens alle 5 Minuten einen Temperaturwert sendet (gegebenenfalls mit attr event-min-interval im sendenden Temperatur-Device einstellen). Alternativ kann man auch über ein DOIF alle 24 Stunden den Wunschwert mit <Code>set <Devicename> desired 20</Code> wiederholen, wobei 20 beispielhaft eine Wunschtemperatur ist.

Für eine stabile Funkkommunikation ist ein RSSI von besser als -80 anzustreben. Eine Verbesserungsmöglichkeit bietet das versuchsweise Drehen des Micropelt am Heizkörper um 90°. Normalerweise ist der geprägte Schriftzug Micropelt waagerecht wie auch die innen liegende Antenne. Nach der Drehung steht diese dann aufrecht. Das passt in der Praxis dann manchmal besser zu einer waagerecht angeordneten Senderantenne, deren Leistung sich dann gezielter im Haus verbreitet. Ein RSSI von -70 ist besser als -80.
Die Empfangsqualität aller EnOcean-Geräte lässt sich schnell mit <Code>list .* TCM_ESP3_0_RSSI</Code> abfragen, wobei TCM_ESP3_0 der Name des EnOcean-Gateways ist.

== ToDos ==
event-on-NN beim Sensor, wakeupCycle

Sorgt Setpoint 0 für eine Initialisierung?

Optimierung von p_i,p_d,p_p in der Praxis

Bedeutung von set <name> liftSet

== Links ==
* {{Link2Forum|Topic=34314|Message=290203|LinkText=Forenbeitrag}}

[[Kategorie:EnOcean Components]]
[[Kategorie:Heizungsventile]]

Micropelt iTRV Kleinstellantrieb

2019-01-03T07:14:09Z

Cwagner: Korrekturen in den set-Befehlen setpointTemp und setpointSet; Einführung Modell MVA-004 und MVA-005

{{Infobox Hardware
|Bild=ITRV.jpg
|Bildbeschreibung=Batterieloser Heizungssteller
|HWProtocol=EnOcean
|HWType=Aktor
|HWCategory=EnOcean
|HWComm=EnOcean Funk, 868Mhz
|HWProtokoll=EnOcean Protokoll EEP A5-20-01 (Ventil Position in %)
|HWChannels=1 (bidirektional)
|HWVoltage=3.7 V, LiOn-Akku
|HWPowerConsumption=
|HWPoweredBy=TEG (Thermoelektrischer Generator;autark)
|HWSize=59 × 64 × 59 [mm] (Breite × Höhe × Tiefe), Gewicht 260 g
|HWDeviceFHEM=[http://fhem.de/commandref.html#EnOcean EnOcean]
|HWManufacturer=Micropelt GmbH
}}

'''EnOcean-Micropelt iRTV-Kleinstellantrieb''' ist ein batterieloser Kleinstellantrieb für Raumtemperaturregelung. Hier wird vorrangig das Modell MVA-002 beschrieben.

== Features ==
Kleinstellantrieb, der ohne Batterien auskommt, da er über einen thermolektrischen Generator seine Energie aus der Temperaturdifferenz des Heizungsvorlaufes und der Raumtemperatur bezieht.

== Hinweise zum Betrieb mit FHEM ==

=== Definition/Anlernvorgang ===
4BS-Bidirektionales-Teach-In:

#falls vorhanden, alle bisherigen FHEM Devices des Aktors löschen und nach Speichern der geänderten Konfiguration FHEM neu starten
#FHEM in Lernmodus versetzen: <code><nowiki>set <IODev> teach <time [s]></nowiki></code>
#Taster am iTRV zweimal drücken (Montageposition = 0%). Der erfolgreiche Anlernvorgang wird durch einmaliges Aufleuchten der Status-LED quittiert. (Fehlanzeige: 6mal Blinken)
#Nach Montage Taster einmal drücken - das Ventil fährt die von FHEM gewünschte Position an.
#Aktor-Device wird in FHEM automatisch mit allen notwendigen Parametern angelegt.

Standardmäßig nutzt FHEM den eigenen PID-Regler des FHEM-Moduls, der auf die Eingabe einer Temperaturvorgabe wartet:
<code><nowiki>set <name> desired-temp <wert°C></nowiki></code>

Solange kein Referenz-Device mit <code><nowiki>set <name> temperatureRefDev <Temperaturdevice mit einem Reading temperature></nowiki></code> angegeben wurde, benutzt das Gerät einen internen Temperaturfühler, der bauartbedingt nicht geeignet für eine Raumregelung ist.

Zur Sicherheit des Heizkörperventils gegen Festsetzen durch Rost oder Kalk, wird im Sommermodus pro Tag eine Servicefahrt – einmal auf und zu – des Ventils durchgeführt. Zusätzlich wird dreimal am Tag die Verbindung mit FHEM aufgerufen. Das dient zur Kontrolle, dass alle bislang verbundenen Devices noch vorhanden sind und ordnungsgemäß miteinander kommunizieren.

Wenn mehr als dreimal hintereinander die Funkkommunikation mit FHEM fehlschlug (was mehr als 30 Minuten im Normalbetrieb bedeutet), sendet der Aktor nur noch alle Stunde und - falls das Ventil zu weniger als 50 Prozent geöffent ist, wird es auf 50% aufgefahren.

'''Durch einmaliges Drücken des Tasters''' kann man im Alltagsbetrieb eine sofortige Funkkommunikation auslösen.

{{Hinweis|Zum Energiesparen verarbeitet der Aktor nur alle 586 oder 587 Sekunden (Sommermodus: alle 8 Stunden) Telegramme von FHEM. Darum zeigen FHEM-Befehle keine sofortige Aktorreaktion, sondern erst nach der genannten Zeitspanne. Die Rückmeldung des Aktors an FHEM über die erfolgte Befehlsausführung erfolgt wiederum erst nach erneutem Ablauf der Zeitspanne.
Falls keine Temperaturdaten geliefert werden, geht das Device in einen Stromsparmodus und fragt nur noch alle 2 Stunden an.
Zur Vermeidung dieses Stromsparmodus, in dem eben auch nicht nachgeregelt wird, sollte bei Referenzgeräte wie einem Raumthermometer das attr event-on-update '''nicht''' benutzt werden. Falls die Temperatur sich 1 Stunde lang nicht ändert, würde entsprechend auch eine Stunde lang kein Referenzwert gesendet, der Stelltrieb in den Sparmodus gehen und für die nächsten 2 Stunden nun kommende Änderungen nicht verarbeiten.
In der Praxis mit einem TCM 310 zeigt sich, dass bei einem RSSI<-80 die Funkkommunikation nicht ausreichend stabil ist. Wenn dreimal hintereinander keine Funktbestätigung erhalten wurde, geht der Aktor in den Notbetrieb und öffnet das Ventil auf 50% oder lässt es auf einem gesetzten größeren Wert bis zur nächsten erfolgreichen bisdirektionalen Kommunikation offen. Das Anpassen der Antennenausrichtung ist hier sehr wichtig.}}

=== Settings ===
{| class="wikitable sortable"
|-
! set !! Wertebereich/Default !! Beschreibung
|-
|desired-temp||10...30||Soll-Temperatur für den FHEM-PID-Controler, der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet
|-
|liftSet||||??
|-
|runInit||||beim nächsten Funkkontakt wird ein Kalibrierungslauf angestoßen
|-
|setpoint||0...100||Setze Aktorposition auf X%; der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet, wenn das attr pidCtrl on ist
|-
|setpointTemp||10...30||Soll-Temperatur für den FHEM-PID-Controler, der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet; ein runInit wird ausgelöst wenn das attr pidCtrl on ist
|-
|ValveCloses||||Ventil auf 0% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|ValveOpens||||Ventil auf 100% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|}

=== Readings ===
{| class="wikitable sortable"
|-
! Reading !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|actuatorState||ok||||wenn 'obstructed', dann ist der metallene Kühlring des Gehäuses z.b. von einem Vorhang bedeckt und der Thermogenerator kann nicht richtig arbeiten
|-
|alarm||no_response_from_actuator||||nur fallweise: wenn Kommunikation ausgefallen; Aktor blinkt dreimal
|-
|battery||ok ||'''ok''' / low||
|-
|cover||closed||||wird vom MVA-002 nicht gesendet
|-
|delta||-9.75||||
|-
|energyInput||enabled||'''enabled''' / disabled||enabled zeigt ausreichende Temperaturdifferenz zur Speisung des Akkus an
|-
|energyStorage||charged||'''charged''' / empty ||
|-
|maintenanceMode||off||'''off''' / runinit||
|-
|operationMode||setpointTemp||'''setpointTemp''' / summerMode / setpointSet||'''Betrieb mit Stellwert-Vorgabe''' / im Sommer-Modus / mit Temperatursollwert-Vorgabe
|-
|operationModeRestore||setpointTemp||||nur fallweise: Modus, der beim Beenden des summermode gesetzt wird
|-
|pidAlarm||||actuator_in_errorPos / dead_sensor / no_temperature_value / setpoint_device_missing||
|-
|pidState||||processing|alarm / idle / '''processing''' / start / stop||
|-
|p_d||0||||
|-
|p_i||100||||
|-
|p_p||-487.5||||
|-
|roomTemp||22.0||||interne MVA-002-Temperatur (wenn attr setpointRefDev nicht gesetzt wird diese Temperatur benutzt - ist für Regelung nicht brauchbar wegen Verfälschung durch Vorlauftemperatur, höhere Temperaturen sind Indiz für Wärmeangebot vom Vorlauf, das den Energiespeicher lädt)
|-
|selfCtrl||off||||MVA-002 hat keinen eigenen PID-Controler
|-
|setpoint||0||||beim letzten Funkkontakt gemeldete Ist-Position vom Aktuator in %
|-
|setpointSet||15||||beim nächsten Funkkontakt gesendete Aktuatorstellung in %
|-
|setpointTemp||15.0||||Soll-Temperatur. Kann gesetzt werden über <code><nowiki>set <IODev> desired-temp <°C></nowiki></code> oder auch durch Module wie Heating_Control oder WeekdayTimer
|-
|setpointTempRestore||16.0 ||||nur fallweise: setpointTemp, die bei Beenden des summermode gesetzt wird
|-
|state||T: 23.4 SPT: 15.0 SP: 0||||T:=Raumtemperatur vom Referenzsensor, SPT=setpointTemp, SP=setpoint
|-
|teach||4BS teach-in accepted EEP A5-20-01 Manufacturer: Micropelt GmbH||||
|-
|temperature||24.75||||zuletzt gemeldete Raumtemperatur vom Referenz-Sensor (siehe Attribut temperatureRefDev)
|-
|waitingCmds||runInit|||noch nicht gesendetes Kommando, hier Kalibrierungslauf|
|-
|wakeUpCycle||240|||das Gerät meldet sich alle 4 Minuten|
|-
|window||closed||open / '''closed'''||wird vom MVA-002 nicht gesendet
|-
|}

=== Attribute ===
{| class="wikitable sortable"
|-
! Attribut !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|comMode||biDir||||
|-
|destinationID||unicast||||
|-
|eep||A5-20-01||||dies eintragen, wenn beim Teach-in ein anderer Wert eingetragen wurde
|-
|manufID||049||||
|-
|pidActorErrorPos||20||||MVA-002 ignoriert diesen Wert und benutzt '''50%''' oder den zuvor gesendeten höheren Stellwert
|-
|pidActorLimitLower||1||||bei 0% Öffnung wird eine Initialisierung ausgelöst?
|-
|pidCtrl||on||||bei on wird der FHEM Pid-Controler benutzt, bei off der im Actor (Modell MVA-002 hat keinen internen PID-Controler, wohl aber MVA-004 und MVA-005)
|-
|pidFactor_I||0.2||||
|-
|pidFactor_P||50||||
|-
|pidSensorTimeout||3600|||| Zahl der Sekunden, in denen der Sensor auf einen Wert vom temperatureRefDev auf einen Wert wartet, sonst Alarm
|-
|rcvRespAction||||||Hier kann eine Aktion eingetragen werden, die bei Rückmeldung des Aktors durchgeführt wird. Details in der FHEM-Referenz
|-
|setpointRefDev||||||Das Device, das die Ventilöffnung (Aktuator) vorgibt, z.B. ein Raumregler, FHEM-PID20. Typischerweise '''nicht gesetzt, es wird der modul-eigene PID-Controler benutzt'''
|-
|setpointSummerMode||2||||Ventilöffnung, die im Sommer gelten soll
|-
|setpointTempRefDev||CC.Kueche||||Ein Device, das die Solltemperatur vorgibt. Z.B.: Heating_Control
|-
|subDef||********||||Sender-ID
|-
|subType||hvac.01||||
|-
|summerMode||off||||
|-
|teachMethod||4BS||||
|-
|temperatureRefDev||T.Kueche||||Das Device, das fortlaufend die Ist-Temperatur meldet
|-
|webCmd||setpointTemp||||
|-
|}

== Tipps & Tricks ==
Fehlermeldungen wie Sensor dead oder no Response from actuator kann man im Betrieb mit einem externen Sensor verhindern, in dem man mindestens alle 5 Minuten einen Temperaturwert sendet (gegebenenfalls mit attr event-min-interval im sendenden Temperatur-Device einstellen). Alternativ kann man auch über ein DOIF alle 24 Stunden den Wunschwert mit <Code>set <Devicename> desired 20</Code> wiederholen, wobei 20 beispielhaft eine Wunschtemperatur ist.

Für eine stabile Funkkommunikation ist ein RSSI von besser als -80 anzustreben. Eine Verbesserungsmöglichkeit bietet das versuchsweise Drehen des Micropelt am Heizkörper um 90°. Normalerweise ist der geprägte Schriftzug Micropelt waagerecht wie auch die innen liegende Antenne. Nach der Drehung steht diese dann aufrecht. Das passt in der Praxis dann manchmal besser zu einer waagerecht angeordneten Senderantenne, deren Leistung sich dann gezielter im Haus verbreitet. Ein RSSI von -70 ist besser als -80.
Die Empfangsqualität aller EnOcean-Geräte lässt sich schnell mit <Code>list .* TCM_ESP3_0_RSSI</Code> abfragen, wobei TCM_ESP3_0 der Name des EnOcean-Gateways ist.

== ToDos ==
event-on-NN beim Sensor, wakeupCycle

Sorgt Setpoint 0 für eine Initialisierung?

Optimierung von p_i,p_d,p_p in der Praxis

Bedeutung von set <name> liftSet

== Links ==
* {{Link2Forum|Topic=34314|Message=290203|LinkText=Forenbeitrag}}

[[Kategorie:EnOcean Components]]
[[Kategorie:Heizungsventile]]

Micropelt iTRV Kleinstellantrieb

2018-12-29T12:03:54Z

Cwagner: Weitere Erkenntnisse bei Energie-Readings dokumentiert, Ergänzungen bei Attributen, Präzisierungen

{{Infobox Hardware
|Bild=ITRV.jpg
|Bildbeschreibung=Batterieloser Heizungssteller
|HWProtocol=EnOcean
|HWType=Aktor
|HWCategory=EnOcean
|HWComm=EnOcean Funk, 868Mhz
|HWProtokoll=EnOcean Protokoll EEP A5-20-01 (Ventil Position in %)
|HWChannels=1 (bidirektional)
|HWVoltage=3.7 V, LiOn-Akku
|HWPowerConsumption=
|HWPoweredBy=TEG (Thermoelektrischer Generator;autark)
|HWSize=59 × 64 × 59 [mm] (Breite × Höhe × Tiefe), Gewicht 260 g
|HWDeviceFHEM=[http://fhem.de/commandref.html#EnOcean EnOcean]
|HWManufacturer=Micropelt GmbH
}}

'''EnOcean-Micropelt iRTV MVA-002-Kleinstellantrieb''' ist ein batterieloser Kleinstellantrieb für Raumtemperaturregelung

== Features ==
Kleinstellantrieb, der ohne Batterien auskommt, da er über einen thermolektrischen Generator seine Energie aus der Temperaturdifferenz des Heizungsvorlaufes und der Raumtemperatur bezieht.

== Hinweise zum Betrieb mit FHEM ==

=== Definition/Anlernvorgang ===
4BS-Bidirektionales-Teach-In:

#falls vorhanden, alle bisherigen FHEM Devices des Aktors löschen und nach Speichern der geänderten Konfiguration FHEM neu starten
#FHEM in Lernmodus versetzen: <code><nowiki>set <IODev> teach <time [s]></nowiki></code>
#Taster am iTRV zweimal drücken (Montageposition = 0%). Der erfolgreiche Anlernvorgang wird durch einmaliges Aufleuchten der Status-LED quittiert. (Fehlanzeige: 6mal Blinken)
#Nach Montage Taster einmal drücken - das Ventil fährt die von FHEM gewünschte Position an.
#Aktor-Device wird in FHEM automatisch mit allen notwendigen Parametern angelegt.

Standardmäßig nutzt FHEM den eigenen PID-Regler des FHEM-Moduls, der auf die Eingabe einer Temperaturvorgabe wartet:
<code><nowiki>set <name> desired-temp <wert°C></nowiki></code>

Solange kein Referenz-Device mit <code><nowiki>set <name> temperatureRefDev <Temperaturdevice mit einem Reading temperature></nowiki></code> angegeben wurde, benutzt das Gerät einen internen Temperaturfühler, der bauartbedingt nicht geeignet für eine Raumregelung ist.

Zur Sicherheit des Heizkörperventils gegen Festsetzen durch Rost oder Kalk, wird im Sommermodus pro Tag eine Servicefahrt – einmal auf und zu – des Ventils durchgeführt. Zusätzlich wird dreimal am Tag die Verbindung mit FHEM aufgerufen. Das dient zur Kontrolle, dass alle bislang verbundenen Devices noch vorhanden sind und ordnungsgemäß miteinander kommunizieren.

Wenn mehr als dreimal hintereinander die Funkkommunikation mit FHEM fehlschlug (was mehr als 30 Minuten im Normalbetrieb bedeutet), sendet der Aktor nur noch alle Stunde und - falls das Ventil zu weniger als 50 Prozent geöffent ist, wird es auf 50% aufgefahren.

'''Durch einmaliges Drücken des Tasters''' kann man im Alltagsbetrieb eine sofortige Funkkommunikation auslösen.

{{Hinweis|Zum Energiesparen verarbeitet der Aktor nur alle 586 oder 587 Sekunden (Sommermodus: alle 8 Stunden) Telegramme von FHEM. Darum zeigen FHEM-Befehle keine sofortige Aktorreaktion, sondern erst nach der genannten Zeitspanne. Die Rückmeldung des Aktors an FHEM über die erfolgte Befehlsausführung erfolgt wiederum erst nach erneutem Ablauf der Zeitspanne.
Falls keine Temperaturdaten geliefert werden, geht das Device in einen Stromsparmodus und fragt nur noch alle 2 Stunden an.
Zur Vermeidung dieses Stromsparmodus, in dem eben auch nicht nachgeregelt wird, sollte bei Referenzgeräte wie einem Raumthermometer das attr event-on-update '''nicht''' benutzt werden. Falls die Temperatur sich 1 Stunde lang nicht ändert, würde entsprechend auch eine Stunde lang kein Referenzwert gesendet, der Stelltrieb in den Sparmodus gehen und für die nächsten 2 Stunden nun kommende Änderungen nicht verarbeiten.
In der Praxis mit einem TCM 310 zeigt sich, dass bei einem RSSI<-80 die Funkkommunikation nicht ausreichend stabil ist. Wenn dreimal hintereinander keine Funktbestätigung erhalten wurde, geht der Aktor in den Notbetrieb und öffnet das Ventil auf 50% oder lässt es auf einem gesetzten größeren Wert bis zur nächsten erfolgreichen bisdirektionalen Kommunikation offen. Das Anpassen der Antennenausrichtung ist hier sehr wichtig.}}

=== Settings ===
{| class="wikitable sortable"
|-
! set !! Wertebereich/Default !! Beschreibung
|-
|desired-temp||10...30||Soll-Temperatur für den FHEM-PID-Controler, der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet
|-
|liftSet||||??
|-
|runInit||||beim nächsten Funkkontakt wird ein Kalibrierungslauf angestoßen
|-
|setpoint||0...100||Setze Aktorposition auf X%; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|setpointTemp||10...30||Soll-Temperatur für den FHEM-PID-Controler, der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet; ein runInit wird ausgelöst
|-
|ValveCloses||||Ventil auf 0% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|ValveOpens||||Ventil auf 100% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|}

=== Readings ===
{| class="wikitable sortable"
|-
! Reading !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|actuatorState||ok||||wenn 'obstructed', dann ist der metallene Kühlring des Gehäuses z.b. von einem Vorhang bedeckt und der Thermogenerator kann nicht richtig arbeiten
|-
|alarm||no_response_from_actuator||||nur fallweise: wenn Kommunikation ausgefallen; Aktor blinkt dreimal
|-
|battery||ok ||'''ok''' / low||
|-
|cover||closed||||wird vom MVA-002 nicht gesendet
|-
|delta||-9.75||||
|-
|energyInput||enabled||'''enabled''' / disabled||enabled zeigt ausreichende Temperaturdifferenz zur Speisung des Akkus an
|-
|energyStorage||charged||'''charged''' / empty ||
|-
|maintenanceMode||off||'''off''' / runinit||
|-
|operationMode||setpointTemp||'''setpointTemp''' / summerMode / setpointSet||'''Betrieb mit Stellwert-Vorgabe''' / im Sommer-Modus / mit Temperatursollwert-Vorgabe
|-
|operationModeRestore||setpointTemp||||nur fallweise: Modus, der beim Beenden des summermode gesetzt wird
|-
|pidAlarm||||actuator_in_errorPos / dead_sensor / no_temperature_value / setpoint_device_missing||
|-
|pidState||||processing|alarm / idle / '''processing''' / start / stop||
|-
|p_d||0||||
|-
|p_i||100||||
|-
|p_p||-487.5||||
|-
|roomTemp||22.0||||interne MVA-002-Temperatur (wenn attr setpointRefDev nicht gesetzt wird diese Temperatur benutzt - ist für Regelung nicht brauchbar wegen Verfälschung durch Vorlauftemperatur, höhere Temperaturen sind Indiz für Wärmeangebot vom Vorlauf, das den Energiespeicher lädt)
|-
|selfCtrl||off||||MVA-002 hat keinen eigenen PID-Controler
|-
|setpoint||0||||beim letzten Funkkontakt gemeldete Ist-Position vom Aktuator in %
|-
|setpointSet||15||||beim nächsten Funkkontakt gesendete Aktuatorstellung in %
|-
|setpointTemp||15.0||||Soll-Temperatur. Kann gesetzt werden über <code><nowiki>set <IODev> desired-temp <°C></nowiki></code> oder auch durch Module wie Heating_Control oder WeekdayTimer
|-
|setpointTempRestore||16.0 ||||nur fallweise: setpointTemp, die bei Beenden des summermode gesetzt wird
|-
|state||T: 23.4 SPT: 15.0 SP: 0||||T:=Raumtemperatur vom Referenzsensor, SPT=setpointTemp, SP=setpoint
|-
|teach||4BS teach-in accepted EEP A5-20-01 Manufacturer: Micropelt GmbH||||
|-
|temperature||24.75||||zuletzt gemeldete Raumtemperatur vom Referenz-Sensor (siehe Attribut temperatureRefDev)
|-
|waitingCmds||runInit|||noch nicht gesendetes Kommando, hier Kalibrierungslauf|
|-
|wakeUpCycle||240|||das Gerät meldet sich alle 4 Minuten|
|-
|window||closed||open / '''closed'''||wird vom MVA-002 nicht gesendet
|-
|}

=== Attribute ===
{| class="wikitable sortable"
|-
! Attribut !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|comMode||biDir||||
|-
|destinationID||unicast||||
|-
|eep||A5-20-01||||dies eintragen, wenn beim Teach-in ein anderer Wert eingetragen wurde
|-
|manufID||049||||
|-
|pidActorErrorPos||20||||MVA-002 ignoriert diesen Wert und benutzt '''50%''' oder den zuvor gesendeten höheren Stellwert
|-
|pidActorLimitLower||1||||bei 0% Öffnung wird eine Initialisierung ausgelöst?
|-
|pidFactor_I||0.2||||
|-
|pidFactor_P||50||||
|-
|pidSensorTimeout||3600|||| Zahl der Sekunden, in denen der Sensor auf einen Wert vom temperatureRefDev auf einen Wert wartet, sonst Alarm
|-
|rcvRespAction||||||Hier kann eine Aktion eingetragen werden, die bei Rückmeldung des Aktors durchgeführt wird. Details in der FHEM-Referenz
|-
|setpointRefDev||||||Das Device, das die Ventilöffnung (Aktuator) vorgibt, z.B. ein Raumregler, FHEM-PID20. Typischerweise '''nicht gesetzt, es wird der modul-eigene PID-Controler benutzt'''
|-
|setpointSummerMode||2||||Ventilöffnung, die im Sommer gelten soll
|-
|setpointTempRefDev||CC.Kueche||||Ein Device, das die Solltemperatur vorgibt. Z.B.: Heating_Control
|-
|subDef||********||||Sender-ID
|-
|subType||hvac.01||||
|-
|summerMode||off||||
|-
|teachMethod||4BS||||
|-
|temperatureRefDev||T.Kueche||||Das Device, das fortlaufend die Ist-Temperatur meldet
|-
|webCmd||setpointTemp||||
|-
|}

== Tipps & Tricks ==
Fehlermeldungen wie Sensor dead oder no Response from actuator kann man im Betrieb mit einem externen Sensor verhindern, in dem man mindestens alle 5 Minuten einen Temperaturwert sendet (gegebenenfalls mit attr event-min-interval im sendenden Temperatur-Device einstellen). Alternativ kann man auch über ein DOIF alle 24 Stunden den Wunschwert mit <Code>set <Devicename> desired 20</Code> wiederholen, wobei 20 beispielhaft eine Wunschtemperatur ist.

Für eine stabile Funkkommunikation ist ein RSSI von besser als -80 anzustreben. Eine Verbesserungsmöglichkeit bietet das versuchsweise Drehen des Micropelt am Heizkörper um 90°. Normalerweise ist der geprägte Schriftzug Micropelt waagerecht wie auch die innen liegende Antenne. Nach der Drehung steht diese dann aufrecht. Das passt in der Praxis dann manchmal besser zu einer waagerecht angeordneten Senderantenne, deren Leistung sich dann gezielter im Haus verbreitet. Ein RSSI von -70 ist besser als -80.
Die Empfangsqualität aller EnOcean-Geräte lässt sich schnell mit <Code>list .* TCM_ESP3_0_RSSI</Code> abfragen, wobei TCM_ESP3_0 der Name des EnOcean-Gateways ist.

== ToDos ==
event-on-NN beim Sensor, wakeupCycle

Sorgt Setpoint 0 für eine Initialisierung?

Optimierung von p_i,p_d,p_p in der Praxis

Bedeutung von set <name> liftSet

== Links ==
* {{Link2Forum|Topic=34314|Message=290203|LinkText=Forenbeitrag}}

[[Kategorie:EnOcean Components]]
[[Kategorie:Heizungsventile]]

Micropelt iTRV Kleinstellantrieb

2018-12-28T14:01:17Z

Cwagner:

{{Infobox Hardware
|Bild=ITRV.jpg
|Bildbeschreibung=Batterieloser Heizungssteller
|HWProtocol=EnOcean
|HWType=Aktor
|HWCategory=EnOcean
|HWComm=EnOcean Funk, 868Mhz
|HWProtokoll=EnOcean Protokoll EEP A5-20-01 (Ventil Position in %)
|HWChannels=1 (bidirektional)
|HWVoltage=3.7 V, LiOn-Akku
|HWPowerConsumption=
|HWPoweredBy=TEG (Thermoelektrischer Generator;autark)
|HWSize=59 × 64 × 59 [mm] (Breite × Höhe × Tiefe), Gewicht 260 g
|HWDeviceFHEM=[http://fhem.de/commandref.html#EnOcean EnOcean]
|HWManufacturer=Micropelt GmbH
}}

'''EnOcean-Micropelt iRTV MVA-002-Kleinstellantrieb''' ist ein batterieloser Kleinstellantrieb für Raumtemperaturregelung

== Features ==
Kleinstellantrieb, der ohne Batterien auskommt, da er über einen thermolektrischen Generator seine Energie aus der Temperaturdifferenz des Heizungsvorlaufes und der Raumtemperatur bezieht.

== Hinweise zum Betrieb mit FHEM ==

=== Definition/Anlernvorgang ===
4BS-Bidirektionales-Teach-In:

#falls vorhanden, alle bisherigen FHEM Devices des Aktors löschen und nach Speichern der geänderten Konfiguration FHEM neu starten
#FHEM in Lernmodus versetzen: <code><nowiki>set <IODev> teach <time [s]></nowiki></code>
#Taster am iTRV zweimal drücken (Montageposition = 0%). Der erfolgreiche Anlernvorgang wird durch einmaliges Aufleuchten der Status-LED quittiert. (Fehlanzeige: 6mal Blinken)
#Nach Montage Taster einmal drücken - das Ventil fährt die von FHEM gewünschte Position an.
#Aktor-Device wird in FHEM automatisch mit allen notwendigen Parametern angelegt.

Standardmäßig nutzt FHEM den eigenen PID-Regler des FHEM-Moduls, der auf die Eingabe einer Temperaturvorgabe wartet:
<code><nowiki>set <name> desired-temp <wert°C></nowiki></code>

Solange kein Referenz-Device mit <code><nowiki>set <name> temperatureRefDev <Temperaturdevice mit einem Reading temperature></nowiki></code> angegeben wurde, benutzt das Gerät einen internen Temperaturfühler, der bauartbedingt nicht geeignet für eine Raumregelung ist.

Zur Sicherheit des Heizkörperventils gegen Festsetzen durch Rost oder Kalk, wird im Sommermodus pro Tag eine Servicefahrt – einmal auf und zu – des Ventils durchgeführt. Zusätzlich wird dreimal am Tag die Verbindung mit FHEM aufgerufen. Das dient zur Kontrolle, dass alle bislang verbundenen Devices noch vorhanden sind und ordnungsgemäß miteinander kommunizieren.

Wenn mehr als dreimal hintereinander die Funkkommunikation mit FHEM fehlschlug (was mehr als 30 Minuten im Normalbetrieb bedeutet), sendet der Aktor nur noch alle Stunde und - falls das Ventil zu weniger als 50 Prozent geöffent ist, wird es auf 50% aufgefahren.

'''Durch einmaliges Drücken des Tasters''' kann man im Alltagsbetrieb eine sofortige Funkkommunikation auslösen.

{{Hinweis|Zum Energiesparen verarbeitet der Aktor nur alle 586 oder 587 Sekunden (Sommermodus: alle 8 Stunden) Telegramme von FHEM. Darum zeigen FHEM-Befehle keine sofortige Aktorreaktion, sondern erst nach der genannten Zeitspanne. Die Rückmeldung des Aktors an FHEM über die erfolgte Befehlsausführung erfolgt wiederum erst nach erneutem Ablauf der Zeitspanne.
Falls keine Temperaturdaten geliefert werden, geht das Device in einen Stromsparmodus und fragt nur noch alle 2 Stunden an.
Zur Vermeidung dieses Stromsparmodus, in dem eben auch nicht nachgeregelt wird, sollte bei Referenzgeräte wie einem Raumthermometer das attr event-on-update '''nicht''' benutzt werden. Falls die Temperatur sich 1 Stunde lang nicht ändert, würde entsprechend auch eine Stunde lang kein Referenzwert gesendet, der Stelltrieb in den Sparmodus gehen und für die nächsten 2 Stunden nun kommende Änderungen nicht verarbeiten.
In der Praxis mit einem TCM 310 zeigt sich, dass bei einem RSSI<-80 die Funkkommunikation nicht ausreichend stabil ist. Wenn dreimal hintereinander keine Funktbestätigung erhalten wurde, geht der Aktor in den Notbetrieb und öffnet das Ventil auf 50% oder lässt es auf einem gesetzten größeren Wert bis zur nächsten erfolgreichen bisdirektionalen Kommunikation offen. Das Anpassen der Antennenausrichtung ist hier sehr wichtig.}}

=== Settings ===
{| class="wikitable sortable"
|-
! set !! Wertebereich/Default !! Beschreibung
|-
|desired-temp||10...30||Soll-Temperatur für den FHEM-PID-Controler, der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet
|-
|liftSet||||??
|-
|runInit||||beim nächsten Funkkontakt wird ein Kalibrierungslauf angestoßen
|-
|setpoint||0...100||Setze Aktorposition auf X%; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|setpointTemp||10...30||Soll-Temperatur für den FHEM-PID-Controler, der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet; ein runInit wird ausgelöst
|-
|ValveCloses||||Ventil auf 0% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|ValveOpens||||Ventil auf 100% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|}

=== Readings ===
{| class="wikitable sortable"
|-
! Reading !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|actuatorState||ok||||wenn 'obstructed', dann ist der metallene Kühlring des Gehäuses z.b. von einem Vorhang bedeckt und der Thermogenerator kann nicht richtig arbeiten
|-
|alarm||no_response_from_actuator||||nur fallweise: wenn Kommunikation ausgefallen; Aktor blinkt dreimal
|-
|battery||ok||||wird vom MVA-002 nicht gesendet
|-
|cover||closed||||wird vom MVA-002 nicht gesendet
|-
|delta||-9.75||||
|-
|energyInput||disabled||enabled / '''disabled'''||enabled zeigt ausreichende Temperaturdifferenz zur Speisung des Akkus an
|-
|energyStorage||charged||||
|-
|maintenanceMode||off||'''off''' / runinit||
|-
|operationMode||setpointTemp||'''setpointTemp''' / summerMode / setpointSet||Betrieb mit Stellwert-Vorgabe / im Sommer-Modus / mit Temperatursollwert-Vorgabe
|-
|operationModeRestore||setpointTemp||||nur fallweise: Modus, der beim Beenden des summermode gesetzt wird
|-
|pidAlarm||||actuator_in_errorPos / dead_sensor / no_temperature_value / setpoint_device_missing||
|-
|pidState||||processing|alarm / idle / '''processing''' / start / stop||
|-
|p_d||0||||
|-
|p_i||100||||
|-
|p_p||-487.5||||
|-
|roomTemp||22.0||||interne MVA-002-Temperatur (wenn attr setpointRefDev nicht gesetzt wird diese Temperatur benutzt - ist für Regelung nicht brauchbar wegen Verfälschung durch Vorlauftemperatur, höhere Temperaturen sind Indiz für Wärmeangebot vom Vorlauf, das den Energiespeicher lädt)
|-
|selfCtrl||off||||MVA-002 hat keinen eigenen PID-Controler
|-
|setpoint||0||||beim letzten Funkkontakt gemeldete Ist-Position vom Aktuator in %
|-
|setpointSet||15||||beim nächsten Funkkontakt gesendete Aktuatorstellung in %
|-
|setpointTemp||15.0||||Soll-Temperatur. Kann gesetzt werden über <code><nowiki>set <IODev> desired-temp <°C></nowiki></code> oder auch durch Module wie Heating_Control oder WeekdayTimer
|-
|setpointTempRestore||16.0 ||||nur fallweise: setpointTemp, die bei Beenden des summermode gesetzt wird
|-
|state||T: 23.4 SPT: 15.0 SP: 0||||T:=Raumtemperatur vom Referenzsensor, SPT=setpointTemp, SP=setpoint
|-
|teach||4BS teach-in accepted EEP A5-20-01 Manufacturer: Micropelt GmbH||||
|-
|temperature||24.75||||zuletzt gemeldete Raumtemperatur vom Referenz-Sensor (siehe Attribut temperatureRefDev)
|-
|waitingCmds||runInit|||noch nicht gesendetes Kommando, hier Kalibrierungslauf|
|-
|wakeUpCycle||240|||das Gerät meldet sich alle 4 Minuten|
|-
|window||closed||open / '''closed'''||wird vom MVA-002 nicht gesendet
|-
|}

=== Attribute ===
{| class="wikitable sortable"
|-
! Attribut !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|comMode||biDir||||
|-
|destinationID||unicast||||
|-
|eep||A5-20-01||||dies eintragen, wenn beim Teach-in ein anderer Wert eingetragen wurde
|-
|manufID||049||||
|-
|pidActorErrorPos||20||||MVA-002 ignoriert diesen Wert und benutzt '''50%''' oder den zuvor gesendeten höheren Stellwert
|-
|pidActorLimitLower||1||||bei 0% Öffnung wird eine Initialisierung ausgelöst?
|-
|pidFactor_I||0.2||||
|-
|pidFactor_P||50||||
|-
|setpointRefDev||||||Das Device, das die Ventilöffnung (Aktuator) vorgibt, z.B. ein Raumregler, FHEM-PID20. Typischerweise '''nicht gesetzt, es wird der modul-eigene PID-Controler benutzt'''
|-
|setpointTempRefDev||CC.Kueche||||Ein Device, das die Solltemperatur vorgibt. Z.B.: Heating_Control
|-
|subDef||********||||Sender-ID
|-
|subType||hvac.01||||
|-
|summerMode||off||||
|-
|teachMethod||4BS||||
|-
|temperatureRefDev||T.Kueche||||Das Device, das fortlaufend die Ist-Temperatur meldet
|-
|webCmd||setpointTemp||||
|-
|}

== Tipps & Tricks ==
Fehlermeldungen wie Sensor dead oder no Response from actuator kann man im Betrieb mit einem externen Sensor verhindern, in dem man mindestens alle 5 Minuten einen Temperaturwert sendet (gegebenenfalls mit attr event-min-interval im sendenden Temperatur-Device einstellen). Alternativ kann man auch über ein DOIF alle 24 Stunden den Wunschwert mit <Code>set <Devicename> desired 20</Code> wiederholen, wobei 20 beispielhaft eine Wunschtemperatur ist.

Für eine stabile Funkkommunikation ist ein RSSI von besser als -80 anzustreben. Eine Verbesserungsmöglichkeit bietet das versuchsweise Drehen des Micropelt am Heizkörper um 90°. Normalerweise ist der geprägte Schriftzug Micropelt waagerecht wie auch die innen liegende Antenne. Nach der Drehung steht diese dann aufrecht. Das passt in der Praxis dann manchmal besser zu einer waagerecht angeordneten Senderantenne, deren Leistung sich dann gezielter im Haus verbreitet. Ein RSSI von -70 ist besser als -80.
Die Empfangsqualität aller EnOcean-Geräte lässt sich schnell mit <Code>list .* TCM_ESP3_0_RSSI</Code> abfragen, wobei TCM_ESP3_0 der Name des EnOcean-Gateways ist.

== ToDos ==
event-on-NN beim Sensor, wakeupCycle

Sorgt Setpoint 0 für eine Initialisierung?

Optimierung von p_i,p_d,p_p in der Praxis

Bedeutung von set <name> liftSet

== Links ==
* {{Link2Forum|Topic=34314|Message=290203|LinkText=Forenbeitrag}}

[[Kategorie:EnOcean Components]]
[[Kategorie:Heizungsventile]]

Micropelt iTRV Kleinstellantrieb

2018-12-16T07:12:51Z

Cwagner:

{{Infobox Hardware
|Bild=ITRV.jpg
|Bildbeschreibung=Batterieloser Heizungssteller
|HWProtocol=EnOcean
|HWType=Aktor
|HWCategory=EnOcean
|HWComm=EnOcean Funk, 868Mhz
|HWProtokoll=EnOcean Protokoll EEP A5-20-01 (Ventil Position in %)
|HWChannels=1 (bidirektional)
|HWVoltage=3.7 V, LiOn-Akku
|HWPowerConsumption=
|HWPoweredBy=TEG (Thermoelektrischer Generator;autark)
|HWSize=59 × 64 × 59 [mm] (Breite × Höhe × Tiefe), Gewicht 260 g
|HWDeviceFHEM=[http://fhem.de/commandref.html#EnOcean EnOcean]
|HWManufacturer=Micropelt GmbH
}}

'''EnOcean-Micropelt iRTV MVA-002-Kleinstellantrieb''' ist ein batterieloser Kleinstellantrieb für Raumtemperaturregelung

== Features ==
Kleinstellantrieb, der ohne Batterien auskommt, da er über einen thermolektrischen Generator seine Energie aus der Temperaturdifferenz des Heizungsvorlaufes und der Raumtemperatur bezieht.

== Hinweise zum Betrieb mit FHEM ==

=== Definition/Anlernvorgang ===
4BS-Bidirektionales-Teach-In:

#falls vorhanden, alle bisherigen FHEM Devices des Aktors löschen und nach Speichern der geänderten Konfiguration FHEM neu starten
#FHEM in Lernmodus versetzen: <code><nowiki>set <IODev> teach <time [s]></nowiki></code>
#Taster am iTRV zweimal drücken (Montageposition = 0%). Der erfolgreiche Anlernvorgang wird durch einmaliges Aufleuchten der Status-LED quittiert. (Fehlanzeige: 6mal Blinken)
#Nach Montage Taster einmal drücken - das Ventil fährt die von FHEM gewünschte Position an.
#Aktor-Device wird in FHEM automatisch mit allen notwendigen Parametern angelegt.

Standardmäßig nutzt FHEM den eigenen PID-Regler des FHEM-Moduls, der auf die Eingabe einer Temperaturvorgabe wartet:
<code><nowiki>set <name> desired-temp <wert°C></nowiki></code>

Solange kein Referenz-Device mit <code><nowiki>set <name> temperatureRefDev <Temperaturdevice mit einem Reading temperature></nowiki></code> angegeben wurde, benutzt das Gerät einen internen Temperaturfühler, der bauartbedingt nicht geeignet für eine Raumregelung ist.

Zur Sicherheit des Heizkörperventils gegen Festsetzen durch Rost oder Kalk, wird im Sommermodus pro Tag eine Servicefahrt – einmal auf und zu – des Ventils durchgeführt. Zusätzlich wird dreimal am Tag die Verbindung mit FHEM aufgerufen. Das dient zur Kontrolle, dass alle bislang verbundenen Devices noch vorhanden sind und ordnungsgemäß miteinander kommunizieren.

Wenn mehr als dreimal hintereinander die Funkkommunikation mit FHEM fehlschlug (was mehr als 30 Minuten im Normalbetrieb bedeutet), sendet der Aktor nur noch alle Stunde und - falls das Ventil zu weniger als 50 Prozent geöffent ist, wird es auf 50% aufgefahren.

'''Durch einmaliges Drücken des Tasters''' kann man im Alltagsbetrieb eine sofortige Funkkommunikation auslösen.

{{Hinweis|Zum Energiesparen verarbeitet der Aktor nur alle 586 oder 587 Sekunden (Sommermodus: alle 8 Stunden) Telegramme von FHEM. Darum zeigen FHEM-Befehle keine sofortige Aktorreaktion, sondern erst nach der genannten Zeitspanne. Die Rückmeldung des Aktors an FHEM über die erfolgte Befehlsausführung erfolgt wiederum erst nach erneutem Ablauf der Zeitspanne.
Falls keine Temperaturdaten geliefert werden, geht das Device in einen Stromsparmodus und fragt nur noch alle 2 Stunden an.
Zur Vermeidung dieses Stromsparmodus, in dem eben auch nicht nachgeregelt wird, sollte bei Referenzgeräte wie einem Raumthermometer das attr event-on-update '''nicht''' benutzt werden. Falls die Temperatur sich 1 Stunde lang nicht ändert, würde entsprechend auch eine Stunde lang kein Referenzwert gesendet, der Stelltrieb in den Sparmodus gehen und für die nächsten 2 Stunden nun kommende Änderungen nicht verarbeiten.
In der Praxis mit einem TCM 310 zeigt sich, dass bei einem RSSI<-80 die Funkkommunikation nicht ausreichend stabil ist. Wenn dreimal hintereinander keine Funktbestätigung erhalten wurde, geht der Aktor in den Notbetrieb und öffnet das Ventil auf 50% oder lässt es auf einem gesetzten größeren Wert bis zur nächsten erfolgreichen bisdirektionalen Kommunikation offen. Das Anpassen der Antennenausrichtung ist hier sehr wichtig.}}

=== Settings ===
{| class="wikitable sortable"
|-
! set !! Wertebereich/Default !! Beschreibung
|-
|desired-temp||10...30||Soll-Temperatur für den FHEM-PID-Controler, der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet
|-
|liftSet||||??
|-
|runInit||||beim nächsten Funkkontakt wird ein Kalibrierungslauf angestoßen
|-
|setpoint||0...100||Setze Aktorposition auf X%; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|setpointTemp||10...30||Soll-Temperatur für den FHEM-PID-Controler, der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet; ein runInit wird ausgelöst
|-
|ValveCloses||||Ventil auf 0% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|ValveOpens||||Ventil auf 100% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|}

=== Readings ===
{| class="wikitable sortable"
|-
! Reading !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|actuatorState||ok||||wenn 'obstructed', dann ist der metallene Kühlring des Gehäuses z.b. von einem Vorhang bedeckt und der Thermogenerator kann nicht richtig arbeiten
|-
|alarm||no_response_from_actuator||||nur fallweise: wenn Kommunikation ausgefallen; Aktor blinkt dreimal
|-
|battery||ok||||wird vom MVA-002 nicht gesendet
|-
|cover||closed||||wird vom MVA-002 nicht gesendet
|-
|delta||-9.75||||
|-
|energyInput||disabled||enabled / '''disabled'''||enabled zeigt ausreichende Temperaturdifferenz zur Speisung des Akkus an
|-
|energyStorage||charged||||
|-
|maintenanceMode||off||'''off''' / runinit||
|-
|operationMode||setpointTemp||'''setpointTemp''' / summerMode / setpointSet||Betrieb mit Stellwert-Vorgabe / mit Temperatursollwert-Vorgabe / Ruhebetrieb im Sommer
|-
|operationModeRestore||setpointTemp||||nur fallweise: Modus, der beim Beenden des summermode gesetzt wird
|-
|pidAlarm||||actuator_in_errorPos / dead_sensor / no_temperature_value / setpoint_device_missing||
|-
|pidState||||processing|alarm / idle / '''processing''' / start / stop||
|-
|p_d||0||||
|-
|p_i||100||||
|-
|p_p||-487.5||||
|-
|roomTemp||22.0||||interne MVA-002-Temperatur (wenn attr setpointRefDev nicht gesetzt wird diese Temperatur benutzt - ist für Regelung nicht brauchbar wegen Verfälschung durch Vorlauftemperatur, höhere Temperaturen sind Indiz für Wärmeangebot vom Vorlauf, das den Energiespeicher lädt)
|-
|selfCtrl||off||||MVA-002 hat keinen eigenen PID-Controler
|-
|setpoint||0||||beim letzten Funkkontakt gemeldete Ist-Position vom Aktuator in %
|-
|setpointSet||15||||beim nächsten Funkkontakt gesendete Aktuatorstellung in %
|-
|setpointTemp||15.0||||Soll-Temperatur. Kann gesetzt werden über <code><nowiki>set <IODev> desired-temp <°C></nowiki></code> oder auch durch MOdule wieHeating_Control oder WeekdayTimer
|-
|setpointTempRestore||16.0 ||||nur fallweise: setpointTemp, die bei Beenden des summermode gesetzt wird
|-
|state||T: 23.4 SPT: 15.0 SP: 0||||T:=Raumtemperatur vom Referenzsensor, SPT = setpointTemp, SP=setpoint
|-
|teach||4BS teach-in accepted EEP A5-20-01 Manufacturer: Micropelt GmbH||||
|-
|temperature||24.75||||zuletzt gemeldete Raumtemperatur vom Referenz-Sensor (siehe Attribut temperatureRefDev)
|-
|waitingCmds||runInit||||
|-
|wakeUpCycle||240||||
|-
|window||closed||open / '''closed'''||wird vom MVA-002 nicht gesendet
|-
|}

=== Attribute ===
{| class="wikitable sortable"
|-
! Attribut !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|comMode||biDir||||
|-
|destinationID||unicast||||
|-
|eep||A5-20-01||||dies eintragen, wenn beim Teach-in ein anderer Wert eingetragen wurde
|-
|manufID||049||||
|-
|pidActorErrorPos||20||||MVA-002 ignoriert diesen Wert und benutzt '''50%''' oder den zuvor gesendeten höheren Stellwert
|-
|pidActorLimitLower||1||||bei 0% Öffnung wird eine Initialisierung ausgelöst?
|-
|pidFactor_I||0.2||||
|-
|pidFactor_P||50||||
|-
|setpointRefDev||||||Das Device, das die Ventilöffnung (Aktuator) vorgibt, z.B. ein Raumregler, FHEM-PID20. Typischerweise '''nicht gesetzt, es wird der modul-eigene PID-Controler benutzt'''
|-
|setpointTempRefDev||CC.Kueche||||Ein Device, das die Solltemperatur vorgibt. Z.B.: Heating_Control
|-
|subDef||********||||Sender-ID
|-
|subType||hvac.01||||
|-
|summerMode||off||||
|-
|teachMethod||4BS||||
|-
|temperatureRefDev||T.Kueche||||Das Device, das fortlaufend die Ist-Temperatur meldet
|-
|webCmd||setpointTemp||||
|-
|}

== Tipps & Tricks ==
Fehlermeldungen wie Sensor dead oder no Response from actuator kann man im Betrieb mit einem externen Sensor verhindern, in dem man mindestens alle 6 Stunden einen Temperaturwert sendet. Alternativ kann man auch über ein DOIF alle 24 Stunden den Wunschwert mit <Code>set <Devicename> desired 20</Code> wiederholen, wobei 20 beispielhaft eine Wunschtemperatur ist.

Für eine stabile Funkkommunikation ist ein RSSI von besser als -80 anzustreben. Eine Verbesserungsmöglichkeit bietet das versuchsweise Drehen des Micropelt am Heizkörper um 90°. Normalerweise ist der geprägte Schriftzug Micropelt waagerecht wie auch die innen liegende Antenne. Nach der Drehung steht diese dann aufrecht. Das passt in der Praxis dann manchmal besser zu einer waagerecht angeordneten Senderantenne, deren Leistung sich dann gezielter im Haus verbreitet. Ein RSSI von -70 ist besser als -80.
Die Empfangsqualität aller EnOcean-Geräte lässt sich schnell mit <Code>list .* TCM_ESP3_0_RSSI</Code> abfragen, wobei TCM_ESP3_0 der Name des EnOcean-Gateways ist.

== ToDos ==
event-on-NN beim Sensor, wakeupCycle

Sorgt Setpoint 0 für eine Initialisierung?

Optimierung von p_i,p_d,p_p in der Praxis

Bedeutung von set <name> liftSet

== Links ==
* {{Link2Forum|Topic=34314|Message=290203|LinkText=Forenbeitrag}}

[[Kategorie:EnOcean Components]]
[[Kategorie:Heizungsventile]]

Micropelt iTRV Kleinstellantrieb

2018-02-24T08:35:44Z

Cwagner: ereklärung actuarstate obstructed

{{Infobox Hardware
|Bild=ITRV.jpg
|Bildbeschreibung=Batterieloser Heizungssteller
|HWProtocol=EnOcean
|HWType=Aktor
|HWCategory=EnOcean
|HWComm=EnOcean Funk, 868Mhz
|HWProtokoll=EnOcean Protokoll EEP A5-20-01 (Ventil Position in %)
|HWChannels=1 (bidirektional)
|HWVoltage=3.7 V, LiOn-Akku
|HWPowerConsumption=
|HWPoweredBy=TEG (Thermoelektrischer Generator;autark)
|HWSize=59 × 64 × 59 [mm] (Breite × Höhe × Tiefe), Gewicht 260 g
|HWDeviceFHEM=[http://fhem.de/commandref.html#EnOcean EnOcean]
|HWManufacturer=Micropelt GmbH
}}

'''EnOcean-Micropelt iRTV MVA-002-Kleinstellantrieb''' ist ein batterieloser Kleinstellantrieb für Raumtemperaturregelung

== Features ==
Kleinstellantrieb, der ohne Batterien auskommt, da er über einen thermolektrischen Generator seine Energie aus der Temperaturdifferenz des Heizungsvorlaufes und der Raumtemperatur bezieht.

== Hinweise zum Betrieb mit FHEM ==

=== Definition/Anlernvorgang ===
4BS-Bidirektionales-Teach-In:

#falls vorhanden, alle bisherigen FHEM Devices des Aktors löschen und nach Speichern der geänderten Konfiguration FHEM neu starten
#FHEM in Lernmodus versetzen: <code><nowiki>set <IODev> teach <time/s></nowiki></code>
#Taster am iTRV zweimal drücken (Montageposition = 0%). Der erfolgreiche Anlernvorgang wird durch einmaliges Aufleuchten der Status-LED quittiert. (Fehlanzeige: 6mal Blinken)
#Nach Montage Taster einmal drücken - das Ventil fährt die von FHEM gewünschte Position an.
#Aktor-Device wird in FHEM automatisch mit allen notwendigen Parametern angelegt.

Standardmäßig nutzt FHEM den eigenen PID-Regler des FHEM-Moduls, der auf die Eingabe einer Temperaturvorgabe wartet:
<code><nowiki>set <name> desired-temp <wert°C></nowiki></code>

Solange kein Referenz-Device mit <code><nowiki>set <name> temperatureRefDev <Temperaturdevice mit einem Reading temperature></nowiki></code> angegeben wurde, benutzt das Gerät einen internen Temperaturfühler, der bauartbedingt nicht geeignet für eine Raumregelung ist.

Zur Sicherheit des Heizkörperventils gegen Festsetzen durch Rost oder Kalk, wird im Sommermodus pro Tag eine Servicefahrt – einmal auf und zu – des Ventils durchgeführt. Zusätzlich wird dreimal am Tag die Verbindung mit FHEM aufgerufen. Das dient zur Kontrolle, dass alle bislang verbundenen Devices noch vorhanden sind und ordnungsgemäß miteinander kommunizieren.

Wenn mehr als dreimal hintereinander die Funkkommunikation mit FHEM fehlschlug (was mehr als 30 Minuten im Normalbetrieb bedeutet), sendet der Aktor nur noch alle Stunde und - falls das Ventil zu weniger als 50 Prozent geöffent ist, wird es auf 50% aufgefahren.

'''Durch einmaliges Drücken des Tasters''' kann man im Alltagsbetrieb eine sofortige Funkkommunikation auslösen.

{{Hinweis|Zum Energiesparen verarbeitet der Aktor nur alle 586 oder 587 Sekunden (Sommermodus: alle 8 Stunden) Telegramme von FHEM. Darum zeigen FHEM-Befehle keine sofortige Aktorreaktion, sondern erst nach der genannten Zeitspanne. Die Rückmeldung des Aktors an FHEM über die erfolgte Befehlsausführung erfolgt wiederum erst nach erneutem Ablauf der Zeitspanne.
Falls keine Temperaturdaten geliefert werden, geht das Device in einen Stromsparmodus und fragt nur noch alle 2 Stunden an.
Zur Vermeidung dieses Stromsparmodus, in dem eben auch nicht nachgeregelt wird, sollte bei Referenzgeräte wie einem Raumthermometer das attr event-on-update '''nicht''' benutzt werden. Falls die Temperatur sich 1 Stunde lang nicht ändert, würde entsprechend auch eine Stunde lang kein Referenzwert gesendet, der Stelltrieb in den Sparmodus gehen und für die nächsten 2 Stunden nun kommende Änderungen nicht verarbeiten.
In der Praxis mit einem TCM 310 zeigt sich, dass bei einem RSSI<-80 die Funkkommunikation nicht ausreichend stabil ist. Wenn dreimal hintereinander keine Funktbestätigung erhalten wurde, geht der Aktor in den Notbetrieb und öffnet das Ventil auf 50% oder lässt es auf einem gesetzten größeren Wert bis zur nächsten erfolgreichen bisdirektionalen Kommunikation offen. Das Anpassen der Antennenausrichtung ist hier sehr wichtig.}}

=== Settings ===
{| class="wikitable sortable"
|-
! set !! Wertebereich/Default !! Beschreibung
|-
|desired-temp||10...30||Soll-Temperatur für den FHEM-PID-Controler, der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet
|-
|liftSet||||??
|-
|runInit||||beim nächsten Funkkontakt wird ein Kalibrierungslauf angestoßen
|-
|setpoint||0...100||Setze Aktorposition auf X%; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|setpointTemp||10...30||Soll-Temperatur für den FHEM-PID-Controler, der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet; ein runInit wird ausgelöst
|-
|ValveCloses||||Ventil auf 0% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|ValveOpens||||Ventil auf 100% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|}

=== Readings ===
{| class="wikitable sortable"
|-
! Reading !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|actuatorState||ok||||wenn 'obstructed', dann ist der metallene Kühlring des Gehäuses z.b. von einem Vorhang bedeckt und der Thermogenerator kann nicht richtig arbeiten
|-
|alarm||no_response_from_actuator||||nur fallweise: wenn Kommunikation ausgefallen; Aktor blinkt dreimal
|-
|battery||ok||||wird vom MVA-002 nicht gesendet
|-
|cover||closed||||wird vom MVA-002 nicht gesendet
|-
|delta||-9.75||||
|-
|energyInput||disabled||enabled / '''disabled'''||enabled zeigt ausreichende Temperaturdifferenz zur Speisung des Akkus an
|-
|energyStorage||charged||||
|-
|maintenanceMode||off||'''off''' / runinit||
|-
|operationMode||setpointTemp||'''setpointTemp''' / summerMode / setpointSet||Betrieb mit Stellwert-Vorgabe / mit Temperatursollwert-Vorgabe / Ruhebetrieb im Sommer
|-
|operationModeRestore||setpointTemp||||nur fallweise: Modus, der beim Beenden des summermode gesetzt wird
|-
|pidAlarm||||actuator_in_errorPos / dead_sensor / no_temperature_value / setpoint_device_missing||
|-
|pidState||||processing|alarm / idle / '''processing''' / start / stop||
|-
|p_d||0||||
|-
|p_i||100||||
|-
|p_p||-487.5||||
|-
|roomTemp||22.0||||interne MVA-002-Temperatur (wenn attr setpointRefDev nicht gesetzt wird diese Temperatur benutzt - ist für Regelung nicht brauchbar wegen Verfälschung durch Vorlauftemperatur, höhere Temperaturen sind Indiz für Wärmeangebot vom Vorlauf, das den Energiespeicher lädt)
|-
|selfCtrl||off||||MVA-002 hat keinen eigenen PID-Controler
|-
|setpoint||0||||beim letzten Funkkontakt gemeldete Ist-Position vom Aktuator in %
|-
|setpointSet||15||||beim nächsten Funkkontakt gesendete Aktuatorstellung in %
|-
|setpointTemp||15.0||||Soll-Temperatur. Kann gesetzt werden über <code><nowiki>set <IODev> desired-temp <°C></nowiki></code> oder auch durch MOdule wieHeating_Control oder WeekdayTimer
|-
|setpointTempRestore||16.0 ||||nur fallweise: setpointTemp, die bei Beenden des summermode gesetzt wird
|-
|state||T: 23.4 SPT: 15.0 SP: 0||||T:=Raumtemperatur vom Referenzsensor, SPT = setpointTemp, SP=setpoint
|-
|teach||4BS teach-in accepted EEP A5-20-01 Manufacturer: Micropelt GmbH||||
|-
|temperature||24.75||||zuletzt gemeldete Raumtemperatur vom Referenz-Sensor (siehe Attribut temperatureRefDev)
|-
|waitingCmds||runInit||||
|-
|wakeUpCycle||240||||
|-
|window||closed||open / '''closed'''||wird vom MVA-002 nicht gesendet
|-
|}

=== Attribute ===
{| class="wikitable sortable"
|-
! Attribut !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|comMode||biDir||||
|-
|destinationID||unicast||||
|-
|eep||A5-20-01||||dies eintragen, wenn beim Teach-in ein anderer Wert eingetragen wurde
|-
|manufID||049||||
|-
|pidActorErrorPos||20||||MVA-002 ignoriert diesen Wert und benutzt '''50%''' oder den zuvor gesendeten höheren Stellwert
|-
|pidActorLimitLower||1||||bei 0% Öffnung wird eine Initialisierung ausgelöst?
|-
|pidFactor_I||0.2||||
|-
|pidFactor_P||50||||
|-
|setpointRefDev||||||Das Device, das die Ventilöffnung (Aktuator) vorgibt, z.B. ein Raumregler, FHEM-PID20. Typischerweise '''nicht gesetzt, es wird der modul-eigene PID-Controler benutzt'''
|-
|setpointTempRefDev||CC.Kueche||||Ein Device, das die Solltemperatur vorgibt. Z.B.: Heating_Control
|-
|subDef||********||||Sender-ID
|-
|subType||hvac.01||||
|-
|summerMode||off||||
|-
|teachMethod||4BS||||
|-
|temperatureRefDev||T.Kueche||||Das Device, das fortlaufend die Ist-Temperatur meldet
|-
|webCmd||setpointTemp||||
|-
|}

== Tipps & Tricks ==
Fehlermeldungen wie Sensor dead oder no Response from actuator kann man im Betrieb mit einem externen Sensor verhindern, in dem man mindestens alle 6 Stunden einen Temperaturwert sendet. Alternativ kann man auch über ein DOIF alle 24 Stunden den Wunschwert mit <Code>set <Devicename> desired 20</Code> wiederholen, wobei 20 beispielhaft eine Wunschtemperatur ist.

Für eine stabile Funkkommunikation ist ein RSSI von besser als -80 anzustreben. Eine Verbesserungsmöglichkeit bietet das versuchsweise Drehen des Micropelt am Heizkörper um 90°. Normalerweise ist der geprägte Schriftzug Micropelt waagerecht wie auch die innen liegende Antenne. Nach der Drehung steht diese dann aufrecht. Das passt in der Praxis dann manchmal besser zu einer waagerecht angeordneten Senderantenne, deren Leistung sich dann gezielter im Haus verbreitet. Ein RSSI von -70 ist besser als -80.
Die Empfangsqualität aller EnOcean-Geräte lässt sich schnell mit <Code>list .* TCM_ESP3_0_RSSI</Code> abfragen, wobei TCM_ESP3_0 der Name des EnOcean-Gateways ist.

== ToDos ==
event-on-NN beim Sensor, wakeupCycle

Sorgt Setpoint 0 für eine Initialisierung?

Optimierung von p_i,p_d,p_p in der Praxis

Bedeutung von set <name> liftSet

== Links ==
* {{Link2Forum|Topic=34314|Message=290203|LinkText=Forenbeitrag}}

[[Kategorie:EnOcean Components]]
[[Kategorie:Heizungsventile]]

Micropelt iTRV Kleinstellantrieb

2018-01-25T07:12:18Z

Cwagner: Korrekturen

{{Infobox Hardware
|Bild=ITRV.jpg
|Bildbeschreibung=Batterieloser Heizungssteller
|HWProtocol=EnOcean
|HWType=Aktor
|HWCategory=EnOcean
|HWComm=EnOcean Funk, 868Mhz
|HWProtokoll=EnOcean Protokoll EEP A5-20-01 (Ventil Position in %)
|HWChannels=1 (bidirektional)
|HWVoltage=3.7 V, LiOn-Akku
|HWPowerConsumption=
|HWPoweredBy=TEG (Thermoelektrischer Generator;autark)
|HWSize=59 × 64 × 59 [mm] (Breite × Höhe × Tiefe), Gewicht 260 g
|HWDeviceFHEM=[http://fhem.de/commandref.html#EnOcean EnOcean]
|HWManufacturer=Micropelt GmbH
}}

'''EnOcean-Micropelt iRTV MVA-002-Kleinstellantrieb''' ist ein batterieloser Kleinstellantrieb für Raumtemperaturregelung

== Features ==
Kleinstellantrieb, der ohne Batterien auskommt, da er über einen thermolektrischen Generator seine Energie aus der Temperaturdifferenz des Heizungsvorlaufes und der Raumtemperatur bezieht.

== Hinweise zum Betrieb mit FHEM ==

=== Definition/Anlernvorgang ===
4BS-Bidirektionales-Teach-In:

#falls vorhanden, alle bisherigen FHEM Devices des Aktors löschen und nach Speichern der geänderten Konfiguration FHEM neu starten
#FHEM in Lernmodus versetzen: <code><nowiki>set <IODev> teach <time/s></nowiki></code>
#Taster am iTRV zweimal drücken (Montageposition = 0%). Der erfolgreiche Anlernvorgang wird durch einmaliges Aufleuchten der Status-LED quittiert. (Fehlanzeige: 6mal Blinken)
#Nach Montage Taster einmal drücken - das Ventil fährt die von FHEM gewünschte Position an.
#Aktor-Device wird in FHEM automatisch mit allen notwendigen Parametern angelegt.

Standardmäßig nutzt FHEM den eigenen PID-Regler des FHEM-Moduls, der auf die Eingabe einer Temperaturvorgabe wartet:
<code><nowiki>set <name> desired-temp <wert°C></nowiki></code>

Solange kein Referenz-Device mit <code><nowiki>set <name> temperatureRefDev <Temperaturdevice mit einem Reading temperature></nowiki></code> angegeben wurde, benutzt das Gerät einen internen Temperaturfühler, der bauartbedingt nicht geeignet für eine Raumregelung ist.

Zur Sicherheit des Heizkörperventils gegen Festsetzen durch Rost oder Kalk, wird im Sommermodus pro Tag eine Servicefahrt – einmal auf und zu – des Ventils durchgeführt. Zusätzlich wird dreimal am Tag die Verbindung mit FHEM aufgerufen. Das dient zur Kontrolle, dass alle bislang verbundenen Devices noch vorhanden sind und ordnungsgemäß miteinander kommunizieren.

Wenn mehr als dreimal hintereinander die Funkkommunikation mit FHEM fehlschlug (was mehr als 30 Minuten im Normalbetrieb bedeutet), sendet der Aktor nur noch alle Stunde und - falls das Ventil zu weniger als 50 Prozent geöffent ist, wird es auf 50% aufgefahren.

'''Durch einmaliges Drücken des Tasters''' kann man im Alltagsbetrieb eine sofortige Funkkommunikation auslösen.

{{Hinweis|Zum Energiesparen verarbeitet der Aktor nur alle 586 oder 587 Sekunden (Sommermodus: alle 8 Stunden) Telegramme von FHEM. Darum zeigen FHEM-Befehle keine sofortige Aktorreaktion, sondern erst nach der genannten Zeitspanne. Die Rückmeldung des Aktors an FHEM über die erfolgte Befehlsausführung erfolgt wiederum erst nach erneutem Ablauf der Zeitspanne.
Falls keine Temperaturdaten geliefert werden, geht das Device in einen Stromsparmodus und fragt nur noch alle 2 Stunden an.
Zur Vermeidung dieses Stromsparmodus, in dem eben auch nicht nachgeregelt wird, sollte bei Referenzgeräte wie einem Raumthermometer das attr event-on-update '''nicht''' benutzt werden. Falls die Temperatur sich 1 Stunde lang nicht ändert, würde entsprechend auch eine Stunde lang kein Referenzwert gesendet, der Stelltrieb in den Sparmodus gehen und für die nächsten 2 Stunden nun kommende Änderungen nicht verarbeiten.
In der Praxis mit einem TCM 310 zeigt sich, dass bei einem RSSI<-80 die Funkkommunikation nicht ausreichend stabil ist. Wenn dreimal hintereinander keine Funktbestätigung erhalten wurde, geht der Aktor in den Notbetrieb und öffnet das Ventil auf 50% oder lässt es auf einem gesetzten größeren Wert bis zur nächsten erfolgreichen bisdirektionalen Kommunikation offen. Das Anpassen der Antennenausrichtung ist hier sehr wichtig.}}

=== Settings ===
{| class="wikitable sortable"
|-
! set !! Wertebereich/Default !! Beschreibung
|-
|desired-temp||10...30||Soll-Temperatur für den FHEM-PID-Controler, der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet
|-
|liftSet||||??
|-
|runInit||||beim nächsten Funkkontakt wird ein Kalibrierungslauf angestoßen
|-
|setpoint||0...100||Setze Aktorposition auf X%; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|setpointTemp||10...30||Soll-Temperatur für den FHEM-PID-Controler, der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet; ein runInit wird ausgelöst
|-
|ValveCloses||||Ventil auf 0% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|ValveOpens||||Ventil auf 100% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|}

=== Readings ===
{| class="wikitable sortable"
|-
! Reading !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|actuatorState||ok||||
|-
|alarm||no_response_from_actuator||||nur fallweise: wenn Kommunikation ausgefallen; Aktor blinkt dreimal
|-
|battery||ok||||wird vom MVA-002 nicht gesendet
|-
|cover||closed||||wird vom MVA-002 nicht gesendet
|-
|delta||-9.75||||
|-
|energyInput||disabled||enabled / '''disabled'''||enabled zeigt ausreichende Temperaturdifferenz zur Speisung des Akkus an
|-
|energyStorage||charged||||
|-
|maintenanceMode||off||'''off''' / runinit||
|-
|operationMode||setpointTemp||'''setpointTemp''' / summerMode / setpointSet||Betrieb mit Stellwert-Vorgabe / mit Temperatursollwert-Vorgabe / Ruhebetrieb im Sommer
|-
|operationModeRestore||setpointTemp||||nur fallweise: Modus, der beim Beenden des summermode gesetzt wird
|-
|pidAlarm||||actuator_in_errorPos / dead_sensor / no_temperature_value / setpoint_device_missing||
|-
|pidState||||processing|alarm / idle / '''processing''' / start / stop||
|-
|p_d||0||||
|-
|p_i||100||||
|-
|p_p||-487.5||||
|-
|roomTemp||22.0||||interne MVA-002-Temperatur (wenn attr setpointRefDev nicht gesetzt wird diese Temperatur benutzt - ist für Regelung nicht brauchbar wegen Verfälschung durch Vorlauftemperatur, höhere Temperaturen sind Indiz für Wärmeangebot vom Vorlauf, das den Energiespeicher lädt)
|-
|selfCtrl||off||||MVA-002 hat keinen eigenen PID-Controler
|-
|setpoint||0||||beim letzten Funkkontakt gemeldete Ist-Position vom Aktuator in %
|-
|setpointSet||15||||beim nächsten Funkkontakt gesendete Aktuatorstellung in %
|-
|setpointTemp||15.0||||Soll-Temperatur. Kann gesetzt werden über <code><nowiki>set <IODev> desired-temp <°C></nowiki></code> oder auch durch MOdule wieHeating_Control oder WeekdayTimer
|-
|setpointTempRestore||16.0 ||||nur fallweise: setpointTemp, die bei Beenden des summermode gesetzt wird
|-
|state||T: 23.4 SPT: 15.0 SP: 0||||T:=Raumtemperatur vom Referenzsensor, SPT = setpointTemp, SP=setpoint
|-
|teach||4BS teach-in accepted EEP A5-20-01 Manufacturer: Micropelt GmbH||||
|-
|temperature||24.75||||zuletzt gemeldete Raumtemperatur vom Referenz-Sensor (siehe Attribut temperatureRefDev)
|-
|waitingCmds||runInit||||
|-
|wakeUpCycle||240||||
|-
|window||closed||open / '''closed'''||wird vom MVA-002 nicht gesendet
|-
|}

=== Attribute ===
{| class="wikitable sortable"
|-
! Attribut !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|comMode||biDir||||
|-
|destinationID||unicast||||
|-
|eep||A5-20-01||||dies eintragen, wenn beim Teach-in ein anderer Wert eingetragen wurde
|-
|manufID||049||||
|-
|pidActorErrorPos||20||||MVA-002 ignoriert diesen Wert und benutzt '''50%''' oder den zuvor gesendeten höheren Stellwert
|-
|pidActorLimitLower||1||||bei 0% Öffnung wird eine Initialisierung ausgelöst?
|-
|pidFactor_I||0.2||||
|-
|pidFactor_P||50||||
|-
|setpointRefDev||||||Das Device, das die Ventilöffnung (Aktuator) vorgibt, z.B. ein Raumregler, FHEM-PID20. Typischerweise '''nicht gesetzt, es wird der modul-eigene PID-Controler benutzt'''
|-
|setpointTempRefDev||CC.Kueche||||Ein Device, das die Solltemperatur vorgibt. Z.B.: Heating_Control
|-
|subDef||********||||Sender-ID
|-
|subType||hvac.01||||
|-
|summerMode||off||||
|-
|teachMethod||4BS||||
|-
|temperatureRefDev||T.Kueche||||Das Device, das fortlaufend die Ist-Temperatur meldet
|-
|webCmd||setpointTemp||||
|-
|}

== Tipps & Tricks ==
Fehlermeldungen wie Sensor dead oder no Response from actuator kann man im Betrieb mit einem externen Sensor verhindern, in dem man mindestens alle 6 Stunden einen Temperaturwert sendet. Alternativ kann man auch über ein DOIF alle 24 Stunden den Wunschwert mit <Code>set <Devicename> desired 20</Code> wiederholen, wobei 20 beispielhaft eine Wunschtemperatur ist.

Für eine stabile Funkkommunikation ist ein RSSI von besser als -80 anzustreben. Eine Verbesserungsmöglichkeit bietet das versuchsweise Drehen des Micropelt am Heizkörper um 90°. Normalerweise ist der geprägte Schriftzug Micropelt waagerecht wie auch die innen liegende Antenne. Nach der Drehung steht diese dann aufrecht. Das passt in der Praxis dann manchmal besser zu einer waagerecht angeordneten Senderantenne, deren Leistung sich dann gezielter im Haus verbreitet. Ein RSSI von -70 ist besser als -80.
Die Empfangsqualität aller EnOcean-Geräte lässt sich schnell mit <Code>list .* TCM_ESP3_0_RSSI</Code> abfragen, wobei TCM_ESP3_0 der Name des EnOcean-Gateways ist.

== ToDos ==
event-on-NN beim Sensor, wakeupCycle

Sorgt Setpoint 0 für eine Initialisierung?

Optimierung von p_i,p_d,p_p in der Praxis

Bedeutung von set <name> liftSet

== Links ==
* {{Link2Forum|Topic=34314|Message=290203|LinkText=Forenbeitrag}}

[[Kategorie:EnOcean Components]]
[[Kategorie:Heizungsventile]]

Micropelt iTRV Kleinstellantrieb

2018-01-23T14:03:14Z

Cwagner: Schreibfehler

{{Infobox Hardware
|Bild=ITRV.jpg
|Bildbeschreibung=Batterieloser Heizungssteller
|HWProtocol=EnOcean
|HWType=Aktor
|HWCategory=EnOcean
|HWComm=EnOcean Funk, 868Mhz
|HWProtokoll=EnOcean Protokoll EEP A5-20-01 (Ventil Position in %)
|HWChannels=1 (bidirektional)
|HWVoltage=3.7 V, LiOn-Akku
|HWPowerConsumption=
|HWPoweredBy=TEG (Thermoelektrischer Generator;autark)
|HWSize=59 × 64 × 59 [mm] (Breite × Höhe × Tiefe), Gewicht 260 g
|HWDeviceFHEM=[http://fhem.de/commandref.html#EnOcean EnOcean]
|HWManufacturer=Micropelt GmbH
}}

'''EnOcean-Micropelt iRTV MVA-002-Kleinstellantrieb''' ist ein batterieloser Kleinstellantrieb für Raumtemperaturregelung

== Features ==
Kleinstellantrieb, der ohne Batterien auskommt, da er über einen thermolektrischen Generator seine Energie aus der Temperaturdifferenz des Heizungsvorlaufes und der Raumtemperatur bezieht.

== Hinweise zum Betrieb mit FHEM ==

=== Definition/Anlernvorgang ===
4BS-Bidirektionales-Teach-In:

#falls vorhanden, alle bisherigen FHEM Devices des Aktors löschen und nach Speichern der geänderten Konfiguration FHEM neu starten
#FHEM in Lernmodus versetzen: <code><nowiki>set <IODev> teach <time/s></nowiki></code>
#Taster am iTRV zweimal drücken (Montageposition = 0%). Der erfolgreiche Anlernvorgang wird durch einmaliges Aufleuchten der Status-LED quittiert. (Fehlanzeige: 6mal Blinken)
#Nach Montage Taster einmal drücken - das Ventil fährt die von FHEM gewünschte Position an.
#Aktor-Device wird in FHEM automatisch mit allen notwendigen Parametern angelegt.

Standardmäßig nutzt FHEM den eigenen PID-Regler des Moduls, der auf die Eingabe einer Temperaturvorgabe wartet:
<code><nowiki>set <name> desired-temp <wert°C></nowiki></code>

Solange kein Referenz-Device mit <code><nowiki>set <name> temperatureRefDev <Temperaturdevice mit einem Reading temperature></nowiki></code> angegeben wurde, benutzt das Gerät einen internen Temperaturfühler, der bauartbedingt nicht geeignet für eine Raumregelung ist.

Zur Sicherheit des Heizkörperventils gegen Festsetzen durch Rost oder Kalk, wird im Sommermodus pro Tag eine Servicefahrt – einmal auf und zu – des Ventils durchgeführt. Zusätzlich wird dreimal am Tag die Verbindung mit FHEM aufgerufen. Das dient zur Kontrolle, dass alle bislang verbundenen Devices noch vorhanden sind und ordnungsgemäß miteinander kommunizieren.

Wenn mehr als dreimal hintereinander die Funkkommunikation mit FHEM fehlschlug (was mehr als 30 Minuten im Normalbetrieb bedeutet), sendet der Aktor nur noch alle Stunde und - falls das Ventil zu weniger als 50 Prozent geöffent ist, wird es auf 50% aufgefahren.

'''Durch einmaliges Drücken des Tasters''' kann man im Alltagsbetrieb eine sofortige Funkkommunikation auslösen.

{{Hinweis|Zum Energiesparen verarbeitet der Aktor nur alle 586 oder 587 Sekunden (Sommermodus: alle 8 Stunden) Telegramme von FHEM. Darum zeigen FHEM-Befehle keine sofortige Aktorreaktion, sondern erst nach der genannten Zeitspanne. Die Rückmeldung des Aktors an FHEM über die erfolgte Befehlsausführung erfolgt wiederum erst nach erneutem Ablauf der Zeitspanne.
Falls keine Temperaturdaten geliefert werden, geht das Device in einen Stromsparmodus und fragt nur noch alle 2 Stunden an.
Zur Vermeidung dieses Stromsparmodus, in dem eben auch nicht nachgeregelt wird, sollte bei Referenzgeräte wie einem Raumthermometer das attr event-on-update '''nicht''' benutzt werden. Falls die Temperatur sich 1 Stunde lang nicht ändert, würde entsprechend auch eine Stunde lang kein Referenzwert gesendet, der Stelltrieb in den Sparmodus gehen und für die nächsten 2 Stunden nun kommende Änderungen nicht verarbeiten.
In der Praxis mit einem TCM 310 zeigt sich, dass bei einem RSSI<-80 die Funkkommunikation nicht ausreichend stabil ist. Wenn dreimal hintereinander keine Funktbestätigung erhalten wurde, geht der Aktor in den Notbetrieb und öffnet das Ventil auf 50% oder lässt es auf einem gesetzten größeren Wert bis zur nächsten erfolgreichen bisdirektionalen Kommunikation offen. Das Anpassen der Antennenausrichtung ist hier sehr wichtig.}}

=== Settings ===
{| class="wikitable sortable"
|-
! set !! Wertebereich/Default !! Beschreibung
|-
|desired-temp||10...30||Soll-Temperatur für den FHEM-PID-Controler, der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet
|-
|liftSet||||??
|-
|runInit||||beim nächsten Funkkontakt wird ein Kalibrierungslauf angestoßen
|-
|setpoint||0...100||Setze Aktorposition auf X%; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|setpointTemp||10...30||Soll-Temperatur für den FHEM-PID-Controler, der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet; ein runInit wird ausgelöst
|-
|ValveCloses||||Ventil auf 0% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|ValveOpens||||Ventil auf 100% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|}

=== Readings ===
{| class="wikitable sortable"
|-
! Reading !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|actuatorState||ok||||
|-
|alarm||no_response_from_actuator||||nur fallweise: wenn Kommunikation ausgefallen; Aktor blinkt dreimal
|-
|battery||ok||||wird vom MVA-002 nicht gesendet
|-
|cover||closed||||wird vom MVA-002 nicht gesendet
|-
|delta||-9.75||||
|-
|energyInput||disabled||enabled / '''disabled'''||enabled zeigt ausreichende Temperaturdifferenz zur Speisung des Akkus an
|-
|energyStorage||charged||||
|-
|maintenanceMode||off||'''off''' / runinit||
|-
|operationMode||setpointTemp||'''setpointTemp''' / summerMode / setpointSet||Betrieb mit Stellwert-Vorgabe / mit Temperatursollwert-Vorgabe / Ruhebetrieb im Sommer
|-
|operationModeRestore||setpointTemp||||nur fallweise: Modus, der beim Beenden des summermode gesetzt wird
|-
|pidAlarm||||actuator_in_errorPos / dead_sensor / no_temperature_value / setpoint_device_missing||
|-
|pidState||||processing|alarm / idle / '''processing''' / start / stop||
|-
|p_d||0||||
|-
|p_i||100||||
|-
|p_p||-487.5||||
|-
|roomTemp||22.0||||interne MVA-002-Temperatur (wenn attr setpointRefDev nicht gesetzt wird diese Temperatur benutzt - ist für Regelung nicht brauchbar wegen Verfälschung durch Vorlauftemperatur, höhere Temperaturen sind Indiz für Wärmeangebot vom Vorlauf, das den Energiespeicher lädt)
|-
|selfCtrl||off||||MVA-002 hat keinen eigenen PID-Controler
|-
|setpoint||0||||beim letzten Funkkontakt gemeldete Ist-Position vom Aktuator in %
|-
|setpointSet||15||||beim nächsten Funkkontakt gesendete Aktuatorstellung in %
|-
|setpointTemp||15.0||||Soll-Temperatur. Kann gesetzt werden über <code><nowiki>set <IODev> desired-temp <°C></nowiki></code> oder auch durch MOdule wieHeating_Control oder WeekdayTimer
|-
|setpointTempRestore||16.0 ||||nur fallweise: setpointTemp, die bei Beenden des summermode gesetzt wird
|-
|state||T: 23.4 SPT: 15.0 SP: 0||||T:=Raumtemperatur vom Referenzsensor, SPT = setpointTemp, SP=setpoint
|-
|teach||4BS teach-in accepted EEP A5-20-01 Manufacturer: Micropelt GmbH||||
|-
|temperature||24.75||||zuletzt gemeldete Raumtemperatur vom Referenz-Sensor (siehe Attribut temperatureRefDev)
|-
|waitingCmds||runInit||||
|-
|wakeUpCycle||240||||
|-
|window||closed||open / '''closed'''||wird vom MVA-002 nicht gesendet
|-
|}

=== Attribute ===
{| class="wikitable sortable"
|-
! Attribut !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|comMode||biDir||||
|-
|destinationID||unicast||||
|-
|eep||A5-20-01||||
|-
|manufID||049||||
|-
|pidActorErrorPos||20||||MVA-002 ignoriert diesen Wert und benutzt '''50%''' oder den zuvor gesendeten höheren Stellwert
|-
|pidActorLimitLower||1||||bei 0% Öffnung wird eine Initialisierung ausgelöst?
|-
|pidFactor_I||0.2||||
|-
|pidFactor_P||50||||
|-
|setpointRefDev||||||Das Device, das die Ventilöffnung (Aktuator) vorgibt, z.B. ein Raumregler, FHEM-PID20. Typischerweise '''nicht gesetzt, es wird der modul-eigene PID-Controler benutzt'''
|-
|setpointTempRefDev||CC.Kueche||||Ein Device, das die Solltemperatur vorgibt. Z.B.: Heating_Control
|-
|subDef||********||||Sender-ID
|-
|subType||hvac.01||||
|-
|summerMode||off||||
|-
|teachMethod||4BS||||
|-
|temperatureRefDev||T.Kueche||||Das Device, das fortlaufend die Ist-Temperatur meldet
|-
|webCmd||setpointTemp||||
|-
|}

== Tipps & Tricks ==
Fehlermeldungen wie Sensor dead oder no Response from actuator kann man im Betrieb mit einem externen Sensor verhindern, in dem man mindestens alle 6 Stunden einen Temperaturwert sendet. Alternativ kann man auch über ein DOIF alle 24 Stunden den Wunschwert mit <Code>set <Devicename> desired 20</Code> wiederholen, wobei 20 beispielhaft eine Wunschtemperatur ist.

Für eine stabile Funkkommunikation ist ein RSSI von besser als -80 anzustreben. Eine Verbesserungsmöglichkeit bietet das versuchsweise Drehen des Micropelt am Heizkörper um 90°. Normalerweise ist der geprägte Schriftzug Micropelt waagerecht wie auch die innen liegende Antenne. Nach der Drehung steht diese dann aufrecht. Das passt in der Praxis dann manchmal besser zu einer waagerecht angeordneten Senderantenne, deren Leistung sich dann gezielter im Haus verbreitet. Ein RSSI von -70 ist besser als -80.
Die Empfangsqualität aller EnOcean-Geräte lässt sich schnell mit <Code>list .* TCM_ESP3_0_RSSI</Code> abfragen, wobei TCM_ESP3_0 der Name des EnOcean-Gateways ist.

== ToDos ==
event-on-NN beim Sensor, wakeupCycle

Sorgt Setpoint 0 für eine Initialisierung?

Optimierung von p_i,p_d,p_p in der Praxis

Bedeutung von set <name> liftSet

== Links ==
* {{Link2Forum|Topic=34314|Message=290203|LinkText=Forenbeitrag}}

[[Kategorie:EnOcean Components]]
[[Kategorie:Heizungsventile]]

Micropelt iTRV Kleinstellantrieb

2018-01-23T14:02:09Z

Cwagner: Neue Rubrik Tipps und Tricks

{{Infobox Hardware
|Bild=ITRV.jpg
|Bildbeschreibung=Batterieloser Heizungssteller
|HWProtocol=EnOcean
|HWType=Aktor
|HWCategory=EnOcean
|HWComm=EnOcean Funk, 868Mhz
|HWProtokoll=EnOcean Protokoll EEP A5-20-01 (Ventil Position in %)
|HWChannels=1 (bidirektional)
|HWVoltage=3.7 V, LiOn-Akku
|HWPowerConsumption=
|HWPoweredBy=TEG (Thermoelektrischer Generator;autark)
|HWSize=59 × 64 × 59 [mm] (Breite × Höhe × Tiefe), Gewicht 260 g
|HWDeviceFHEM=[http://fhem.de/commandref.html#EnOcean EnOcean]
|HWManufacturer=Micropelt GmbH
}}

'''EnOcean-Micropelt iRTV MVA-002-Kleinstellantrieb''' ist ein batterieloser Kleinstellantrieb für Raumtemperaturregelung

== Features ==
Kleinstellantrieb, der ohne Batterien auskommt, da er über einen thermolektrischen Generator seine Energie aus der Temperaturdifferenz des Heizungsvorlaufes und der Raumtemperatur bezieht.

== Hinweise zum Betrieb mit FHEM ==

=== Definition/Anlernvorgang ===
4BS-Bidirektionales-Teach-In:

#falls vorhanden, alle bisherigen FHEM Devices des Aktors löschen und nach Speichern der geänderten Konfiguration FHEM neu starten
#FHEM in Lernmodus versetzen: <code><nowiki>set <IODev> teach <time/s></nowiki></code>
#Taster am iTRV zweimal drücken (Montageposition = 0%). Der erfolgreiche Anlernvorgang wird durch einmaliges Aufleuchten der Status-LED quittiert. (Fehlanzeige: 6mal Blinken)
#Nach Montage Taster einmal drücken - das Ventil fährt die von FHEM gewünschte Position an.
#Aktor-Device wird in FHEM automatisch mit allen notwendigen Parametern angelegt.

Standardmäßig nutzt FHEM den eigenen PID-Regler des Moduls, der auf die Eingabe einer Temperaturvorgabe wartet:
<code><nowiki>set <name> desired-temp <wert°C></nowiki></code>

Solange kein Referenz-Device mit <code><nowiki>set <name> temperatureRefDev <Temperaturdevice mit einem Reading temperature></nowiki></code> angegeben wurde, benutzt das Gerät einen internen Temperaturfühler, der bauartbedingt nicht geeignet für eine Raumregelung ist.

Zur Sicherheit des Heizkörperventils gegen Festsetzen durch Rost oder Kalk, wird im Sommermodus pro Tag eine Servicefahrt – einmal auf und zu – des Ventils durchgeführt. Zusätzlich wird dreimal am Tag die Verbindung mit FHEM aufgerufen. Das dient zur Kontrolle, dass alle bislang verbundenen Devices noch vorhanden sind und ordnungsgemäß miteinander kommunizieren.

Wenn mehr als dreimal hintereinander die Funkkommunikation mit FHEM fehlschlug (was mehr als 30 Minuten im Normalbetrieb bedeutet), sendet der Aktor nur noch alle Stunde und - falls das Ventil zu weniger als 50 Prozent geöffent ist, wird es auf 50% aufgefahren.

'''Durch einmaliges Drücken des Tasters''' kann man im Alltagsbetrieb eine sofortige Funkkommunikation auslösen.

{{Hinweis|Zum Energiesparen verarbeitet der Aktor nur alle 586 oder 587 Sekunden (Sommermodus: alle 8 Stunden) Telegramme von FHEM. Darum zeigen FHEM-Befehle keine sofortige Aktorreaktion, sondern erst nach der genannten Zeitspanne. Die Rückmeldung des Aktors an FHEM über die erfolgte Befehlsausführung erfolgt wiederum erst nach erneutem Ablauf der Zeitspanne.
Falls keine Temperaturdaten geliefert werden, geht das Device in einen Stromsparmodus und fragt nur noch alle 2 Stunden an.
Zur Vermeidung dieses Stromsparmodus, in dem eben auch nicht nachgeregelt wird, sollte bei Referenzgeräte wie einem Raumthermometer das attr event-on-update '''nicht''' benutzt werden. Falls die Temperatur sich 1 Stunde lang nicht ändert, würde entsprechend auch eine Stunde lang kein Referenzwert gesendet, der Stelltrieb in den Sparmodus gehen und für die nächsten 2 Stunden nun kommende Änderungen nicht verarbeiten.
In der Praxis mit einem TCM 310 zeigt sich, dass bei einem RSSI<-80 die Funkkommunikation nicht ausreichend stabil ist. Wenn dreimal hintereinander keine Funktbestätigung erhalten wurde, geht der Aktor in den Notbetrieb und öffnet das Ventil auf 50% oder lässt es auf einem gesetzten größeren Wert bis zur nächsten erfolgreichen bisdirektionalen Kommunikation offen. Das Anpassen der Antennenausrichtung ist hier sehr wichtig.}}

=== Settings ===
{| class="wikitable sortable"
|-
! set !! Wertebereich/Default !! Beschreibung
|-
|desired-temp||10...30||Soll-Temperatur für den FHEM-PID-Controler, der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet
|-
|liftSet||||??
|-
|runInit||||beim nächsten Funkkontakt wird ein Kalibrierungslauf angestoßen
|-
|setpoint||0...100||Setze Aktorposition auf X%; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|setpointTemp||10...30||Soll-Temperatur für den FHEM-PID-Controler, der PID-Controler des FHEM-Moduls wird '''ein'''geschaltet; ein runInit wird ausgelöst
|-
|ValveCloses||||Ventil auf 0% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|ValveOpens||||Ventil auf 100% setzen; der PID-Controler des FHEM-Moduls wird '''aus'''geschaltet
|-
|}

=== Readings ===
{| class="wikitable sortable"
|-
! Reading !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|actuatorState||ok||||
|-
|alarm||no_response_from_actuator||||nur fallweise: wenn Kommunikation ausgefallen; Aktor blinkt dreimal
|-
|battery||ok||||wird vom MVA-002 nicht gesendet
|-
|cover||closed||||wird vom MVA-002 nicht gesendet
|-
|delta||-9.75||||
|-
|energyInput||disabled||enabled / '''disabled'''||enabled zeigt ausreichende Temperaturdifferenz zur Speisung des Akkus an
|-
|energyStorage||charged||||
|-
|maintenanceMode||off||'''off''' / runinit||
|-
|operationMode||setpointTemp||'''setpointTemp''' / summerMode / setpointSet||Betrieb mit Stellwert-Vorgabe / mit Temperatursollwert-Vorgabe / Ruhebetrieb im Sommer
|-
|operationModeRestore||setpointTemp||||nur fallweise: Modus, der beim Beenden des summermode gesetzt wird
|-
|pidAlarm||||actuator_in_errorPos / dead_sensor / no_temperature_value / setpoint_device_missing||
|-
|pidState||||processing|alarm / idle / '''processing''' / start / stop||
|-
|p_d||0||||
|-
|p_i||100||||
|-
|p_p||-487.5||||
|-
|roomTemp||22.0||||interne MVA-002-Temperatur (wenn attr setpointRefDev nicht gesetzt wird diese Temperatur benutzt - ist für Regelung nicht brauchbar wegen Verfälschung durch Vorlauftemperatur, höhere Temperaturen sind Indiz für Wärmeangebot vom Vorlauf, das den Energiespeicher lädt)
|-
|selfCtrl||off||||MVA-002 hat keinen eigenen PID-Controler
|-
|setpoint||0||||beim letzten Funkkontakt gemeldete Ist-Position vom Aktuator in %
|-
|setpointSet||15||||beim nächsten Funkkontakt gesendete Aktuatorstellung in %
|-
|setpointTemp||15.0||||Soll-Temperatur. Kann gesetzt werden über <code><nowiki>set <IODev> desired-temp <°C></nowiki></code> oder auch durch MOdule wieHeating_Control oder WeekdayTimer
|-
|setpointTempRestore||16.0 ||||nur fallweise: setpointTemp, die bei Beenden des summermode gesetzt wird
|-
|state||T: 23.4 SPT: 15.0 SP: 0||||T:=Raumtemperatur vom Referenzsensor, SPT = setpointTemp, SP=setpoint
|-
|teach||4BS teach-in accepted EEP A5-20-01 Manufacturer: Micropelt GmbH||||
|-
|temperature||24.75||||zuletzt gemeldete Raumtemperatur vom Referenz-Sensor (siehe Attribut temperatureRefDev)
|-
|waitingCmds||runInit||||
|-
|wakeUpCycle||240||||
|-
|window||closed||open / '''closed'''||wird vom MVA-002 nicht gesendet
|-
|}

=== Attribute ===
{| class="wikitable sortable"
|-
! Attribut !! Beispiel !! Wertebereich/Default !! Beschreibung
|-
|comMode||biDir||||
|-
|destinationID||unicast||||
|-
|eep||A5-20-01||||
|-
|manufID||049||||
|-
|pidActorErrorPos||20||||MVA-002 ignoriert diesen Wert und benutzt '''50%''' oder den zuvor gesendeten höheren Stellwert
|-
|pidActorLimitLower||1||||bei 0% Öffnung wird eine Initialisierung ausgelöst?
|-
|pidFactor_I||0.2||||
|-
|pidFactor_P||50||||
|-
|setpointRefDev||||||Das Device, das die Ventilöffnung (Aktuator) vorgibt, z.B. ein Raumregler, FHEM-PID20. Typischerweise '''nicht gesetzt, es wird der modul-eigene PID-Controler benutzt'''
|-
|setpointTempRefDev||CC.Kueche||||Ein Device, das die Solltemperatur vorgibt. Z.B.: Heating_Control
|-
|subDef||********||||Sender-ID
|-
|subType||hvac.01||||
|-
|summerMode||off||||
|-
|teachMethod||4BS||||
|-
|temperatureRefDev||T.Kueche||||Das Device, das fortlaufend die Ist-Temperatur meldet
|-
|webCmd||setpointTemp||||
|-
|}

== Tipps & Tricks ==
Fehlermeldungen wie Sensor dead oder no Response from actuator kann man im Betrieb mit einem externen Sensor verhindern, in dem man mindestens alle 6 Stunden einen Temperaturwert sendet. Alternativ kann man auch über ein DOIF alle 24 Stunden den Wunschwert mit <Code>set <Devicename> desried 20</Code> wiederholen, wobei 20 beispielhaft eine Wunschtemperatur ist.

Für eine stabile Funkkommunikation ist ein RSSI von besser als -80 anzustreben. Eine Verbesserungsmöglichkeit bietet das versuchsweise Drehen des Micropelt am Heizkörper um 90°. Normalerweise ist der geprägte Schriftzug Micropelt waagerecht wie auch die innen liegende Antenne. Nach der Drehung steht diese dann aufrecht. Das passt in der Praxis dann manchmal besser zu einer waagerecht angeordneten Senderantenne, deren Leistung sich dann gezielter im Haus verbreitet. Ein RSSI von -70 ist besser als -80.
Die Empfangsqualität aller EnOcean-Geräte lässt sich schnell mit <Code>list .* TCM_ESP3_0_RSSI</Code> abfragen, wobei TCM_ESP3_0 der Name des EnOcean-Gateways ist.

== ToDos ==
event-on-NN beim Sensor, wakeupCycle

Sorgt Setpoint 0 für eine Initialisierung?

Optimierung von p_i,p_d,p_p in der Praxis

Bedeutung von set <name> liftSet

== Links ==
* {{Link2Forum|Topic=34314|Message=290203|LinkText=Forenbeitrag}}

[[Kategorie:EnOcean Components]]
[[Kategorie:Heizungsventile]]

ReadingsChange

2018-01-05T08:45:26Z

Cwagner: Initiale Fassung: Anlass Problematik mit event-on-*-Atrributen

{{SEITENTITEL:readingsChange}}
{{Infobox Modul
|ModPurpose=Formatieren von Readings
|ModType=h
|ModCmdRef=readingsChange
|ModTechName=33_readingsChange.pm
|ModForumArea=Automatisierung}}

Eventuell ist es nötig, die Readings eines Gerätes zu formatieren, Ihnen also Nachkommastellen abzuschneiden oder Textinhalte zu entfernen, hinzufügen oder umzustellen.

Hierzu dient das FHEM-[[:Kategorie:Hilfsmodul|Hilfsmodul]] [[readingsChangey]]. Sobald ein Reading vom Device erzeugt wird, dass dem RegEX des Moduls entspricht, wird die Formatierung, z.B. von 27.2852 zu 27.3 vorgenommen.

=== Definition ===

Die Definition ist bestens vom Modulautor in der Referenz beschrieben.

== Besonderheiten ==
ReadingsChange ist abhängig von der Reihenfolge der Events und deren interner Verarbeitung. In dieser "Nahrungskette" steht es ziemlich weit hinten, mit dem Ergebnis, dass zum Beispiel Devices mit Attributen wie event-on-Change-reading fallweise nicht formatiert werden.
Dies erklärt dieser und sein folgender Forumseintrag: {{Link2Forum|Topic=65055|LinkText=readingsChange funktioniert nicht mehr}}

Hier spielt eine wichtige Rolle die Notify-Order, die man mit list .* NTFY_ORDER sich vor Augen führen kann.
== Links ==
* Forenthema zur {{Link2Forum|Topic=60226|LinkText=Vorstellung des Moduls}}

[[Kategorie:HOWTOS]]

DbLog

2017-08-05T07:46:39Z

Cwagner: Entfernung einer fehlerhaften Ergänzung

{{Infobox Modul
|ModPurpose=Protokolliert Ereignisse in einer Datenbank
|ModType=h
|ModForumArea=Automatisierung
|ModTechName=93_DbLog.pm
|ModOwner=tobiasfaust ({{Link2FU|118|Forum}}/[[Benutzer Diskussion:Tobias.faust|Wiki]])
}}

== Einleitung ==
Mit der Zeit entstehen im fhem recht umfangreiche Log-Daten für die verschiedensten konfigurierten Devices. Die übliche Einstiegs-[[Konfiguration]] sieht vor, dass die Logs als [http://fhem.de/commandref_DE.html#FileLog FileLog] gespeichert werden - je nach Einstellung in wenigen sehr großen oder vielen kleineren Dateien. Der Datei-basierte Zugriff ist allerdings nicht wirklick performant und kann schnell zum Flaschenhals werden (z.B. bei der Darstellung von Graphen über einen längeren Zeitraum).

Alternativ kann Fhem die Log-Daten mittels [http://fhem.de/commandref_DE.html#DbLog DbLog] in einer Datenbank speichern. Diese kann lokal als einfache SQLite- oder als zentrale Server-Datenbank (s.u.) gestaltet sein. Schon eine lokale einfache SQLite-Datenbank ist in der Regel deutlich performanter als File-basierte Logs.

Damit eine Datenbank-Nutzung möglich ist, müssen folgende Anpassungen gemacht werden:
# [[#Datenbank|Erstellen einer entsprechenden Datenbank]]
# [[#Datenbank-Anbindung mittels db.conf|Konfiguration der Datenbank-Anbindung in FHEM]]
# [[#Konfiguration als Device in fhem.cfg|Anpassen aller (oder einzelner) Konfigurationen von FileLog nach DbLog]]
# [[#Anpassen der gplot-Konfigurationen|Ggf. Anpassen der gplot-Konfigurationen]]

== Konfiguration ==
=== Datenbank-Anbindung mittels db.conf ===
DbLog wird durch 2 verschiedene Einträge aktiviert/definiert. In einer Datei namens '''db.conf''' werden die Parameter für eine Verbindung zur Datenbank (host, username, password, etc.) hinterlegt. Diese Datei kann in einem beliebigen Verzeichnis angelegt werden. Für eine MySQL-Datenbank sieht die db.conf folgendermaßen aus:

%dbconfig= (
connection => "mysql:database=fhem;host=db;port=3306",
user => "fhemuser",
password => "fhempassword",
);

Im Verzeichnis '''contrib/dblog''' der FHEM-Installation befindet sich eine Beispielkonfiguration mit der Syntax für jeden unterstützen Datenbanktyp.
Es wird empfohlen diese Datei zu kopieren und erst dann entsprechend zu bearbeiten. Am Besten kopiert man diese Datei in das FHEM Home Directory /opt/fhem/ und achtet auf die entsprechenden Rechte!
chown fhem:dialout /opt/fhem/db.conf

=== Konfiguration als Device ===
Das DbLog Device wird dann definiert mit
:<code>define <name> DbLog <configfilename> <regexp> </code>
wobei ''<configfilename>'' dem Pfad zur zuvor angelegten db.conf entspricht.
Ein Beispiel hierfür wäre:
:<code>define logdb DbLog ./db.conf .*:.* </code>
Die Angabe von <code>.*:.*</code> bedeutet, dass sämtliche DeviceMessages (Messwerte, Batteriestatus, KeepAlives, etc.) in die Datenbank geschrieben werden. Dies führt u.U. dazu, dass die Datenbank auch mit vielen teils irrelevanten Werten gefüllt wird. Man kann daher die zu loggenden Werte einschränken, indem man genau angibt welche Werte übertragen werden sollen. Dies ist in [[#Finetuning des Loggings]] beschrieben.

=== Finetuning des Loggings ===
Bei der Konfiguration des Log-Devices werden die zu loggenden Daten definiert - in der einfachsten Form sieht das so aus: <code>define logdb DbLog ./db.conf .*:.* </code>. Die Angabe von <code>.*:.*</code> bedeutet, dass sämtliche DeviceMessages (Messwerte, Batteriestatus, KeepAlives, etc.) in die Datenbank geschrieben werden. Dies führt u.U. dazu, dass die Datenbank auch mit sehr vielen und teils nicht benötigten Werten gefüllt wird und schnell wächst. Die Datenbank ist zwar deutlich leistungsfähiger, was große Datenmengen angeht, Datensparsamkeit kann aber schnell sinnvoll werden...

Um das Log-Aufkommen einzugrenzen gibt es 2 Ansätze:
* Einschränkung über den <code>define</code>-Eintrag
* Einschränkung über DbLogExclude-Einträge der jeweiligen Devices
* Einschränkung über DbLogInclude-Einträge des jeweiligen Devices

==== Einschränkung über den zentralen <code>define</code>-Eintrag ====
Man kann die zu loggenden Werte einschränken, indem man genau angibt welche Werte übertragen werden sollen. Die erste Wildcard, also das erste <code>.*</code>, entspricht dem in FHEM verwendeten Device-Namen. Die zweite Wildcard entspricht dem vom Device ausgegebenen zu loggenden Wert. Separiert werden beiden Angaben durch einen Doppelpunkt.

Ein Beispiel, um zwar alle definierten Devices zu erfassen, aber nur die Werte Temperatur, Ventilposition und Luftfeuchte in die Datenbank zu schreiben wäre:
:<code>define myDbLog DbLog ./db.conf .*:(temperature|valveposition|humidity).* </code>

==== Einschränkung über die jeweiligen Devices ====
Man kann die zu loggenden Werte für einzelne Devices separat einschränken, ohne dies im zentralen define-Eintrag machen zu müssen. Dies kann interessant sein, wenn beispielsweise ein Device Fehlerwerte meldet, die uninteressant sind, oder es meldet unnötig häufig Werte - beides ist z.B. bei 1-wire-Temperatursensoren gerne der Fall.

Um das einzuschränken gibt es 2 Stellparameter, die als Attribute direkt zum jeweiligen Device konfiguriert werden:
* DbLogExclude - definiert Werte, die nicht geloggt werden sollen
* DbLogInclude - definiert Werte, die geloggt werden sollen ( siehe attr DbLogSelectionMode )
* event-min-interval, event-on-change-reading und event-on-update-reading beeinflussen, wie häufig Werte geloggt werden (vgl. [http://fhem.de/commandref_DE.html#event-on-update-reading commandref])

Eine konkrete Konfiguration für einen sehr gesprächigen 1-wire-Temperatursensor könnte wie folgt aussehen:
<pre>
define EG_Balkon GPIO4 BUSMASTER
attr EG_Balkon DbLogExclude failures,T,85 # logge keine "failures", "T"-Werte und "85"-Werte (default-Werte, wenn keine Temperatur gelesen werden kann)
attr EG_Balkon event-on-change-reading state # logge nur, wenn sich ein Wert ändert (wenn sich die Temperatur nicht ändert, logge das nicht)
attr EG_Balkon event-min-interval state:900 # logge spätestens alle 900sec = 15min
attr EG_Balkon event-on-update-reading .* # logge alle Werte, die aktualisiert werden

attr <1-Wire-Device vom Typ OWTHERM oder OWSWITCH> DbLogExclude data.* # verhindert das Logging der state-Eintragungen
</pre>

Eine in diesem {{Link2Forum|Topic=33697|Message=264127}} vorgestellte Strategie zur Vermeidung unnötigen Loggings ist, dass bei der Definition von Devices durch das nachfolgende <code>notify</code> automatisch ein DbLogExclude für alle Werte (.*) des Devices zugewiesen wird und dies nur bei Interesse an geloggten Werten gelöscht bzw. angepasst wird:
<code>define nDbLogExclude notify global:DEFINED.* attr $EVTPART1 DbLogExclude .*</code>

Ebenso ist es mittlerweile möglich, lediglich erwünschte Werte (Positiv-Liste) zu loggen und alle anderen zu verwerfen. Hierfür wird im LogDevice das attribut DbLogSelectionMode Include verwendet. Nun kann für jedes Device mit DbLogInclude <Reading1>,<Reading2>,... angegeben werden, welche Readings geloggt werden sollen.
Integriert ist ebenfalls ein "min-interval", siehe commandref.

== Datenbank ==
Unterstützte Datenbanksysteme (Auswahl):
* Sqlite
* MySQL
* PostGreSql

=== Tabellen ===
Die Datenbank ist relativ simpel gestaltet und besteht lediglich aus den folgenden beiden Tabellen:
* current
* history

DbLog ist auf eine feste Tabellenstruktur angewiesen. Man muss daher in seiner Datenbank eine Tabelle mit folgenden Spalten anlegen:
{| class="wikitable"
|-
! Spalte
! Beschreibung (en)
! Beschreibung (de)
! Beispiel
|-
| '''TIMESTAMP'''
| timestamp of event
| Zeitstempel
| 2007-12-30 21:45:22
|-
| '''DEVICE'''
| device name
| Device-Name
| Wetterstation
|-
| '''TYPE'''
| device type
| Device-Typ
| KS300
|-
| '''EVENT'''
| event specification as full string
| Eventspezifikation als Text
| humidity: 71 (%)
|-
| '''READING'''
| name of reading extracted from event
| Bezeichnung des Readings
| humidity
|-
| '''VALUE'''
| actual reading extracted from event
| Wert des Readings
| 71
|-
| '''UNIT'''
| unit extracted from event
| Einheit des Readings
| %
|-
|}

Die Vorlagen zur Anlage von Tabellen und Indizes sind für jeden unterstützten Datenbanktyp im Verzeichnis '''contrib/dblog''' der FHEM-Installation, oder hier zu finden: [https://svn.fhem.de/trac/browser/trunk/fhem/contrib/dblog/ Link]. Das MySQL-Skript (db_create_mysql.sql) legt eine neue Datenbank, das PostGres-Skript (db_create_postgresql.sql) ein neues Schema mit Namen "fhem" an.

==== current ====
Die Tabelle current enthält für jedes zu loggende Device lediglich den letzten Wert. Falls noch kein Wert geloggt wurde, ist diese Tabelle leer.
Falls der Inhalt gelöscht wird, bauen sich die Daten automatisch wieder auf. Es gehen durch das löschen der Tabelle current keine Log-Informationen verloren.
Der Inhalt wird aber u.a. für die Dropdown-Felder beim Plot-Editor verwendet.

Um doppelte Einträge in der Tabelle zu vermeiden, wurden die Möglichkeit geschaffen Primary Keys zu definieren. Da in der Spalte <code>READING</code> u.U. bei verschiedenen Geräten gleiche Namen vorkommen können, sollte der Primary Key um den Gerätenamen erweitert werden. Der Primary Key sollte also aus <code>DEVICE</code> und <code>READING</code> bestehen. Um in der Datenbank ''fhem'' diesen PK zu setzen, kann folgender SQL Code verwendet werden:

<syntaxhighlight lang="sql">
ALTER TABLE `fhem`.`current`
CHANGE COLUMN `DEVICE` `DEVICE` VARCHAR(64) CHARACTER SET 'utf8' COLLATE 'utf8_bin' NOT NULL ,
CHANGE COLUMN `READING` `READING` VARCHAR(64) CHARACTER SET 'utf8' COLLATE 'utf8_bin' NOT NULL ,
ADD PRIMARY KEY (`DEVICE`, `READING`);
</syntaxhighlight>

==== history ====
Die Tabelle history enthält alle bisher geloggten Daten. Löschen in dieser Tabelle bedeutet automatisch Datenverlust (gewollt oder nicht ... )
Der Inhalt dieser Tabelle wird verwendet, um die Plots zu zeichnen.

== Anpassen der gplot-Konfigurationen ==
Die meisten gplot-Konfigurationen sind bisher lediglich auf FileLog-Konfigurationen ausgelegt. Deshalb müssen sie für die Verwendung mit DbLog angepasst werden. Glücklicherweise beschränkt sich dies auf die reinen FileLog-Zeilen - es müssen die DbLog-Äquivalente hinzugefügt werden. Die FileLog-Einträge müssen zwar nicht gelöscht werden, wenn man aber FileLog und DbLog parallel betreibt, sollte man getrennte gplot-Dateien für beide Logging-Typen haben um Auswertungsprobleme erkennen zu können.

Für die fht.gplot Konfiguration sähe die Anpassung wie folgt aus (lediglich die vier DbLog-Zeilen wurden hinzugefügt):
<pre>
# Created by FHEM/98_SVG.pm, 2014-12-25 21:53:30
set terminal png transparent size <SIZE> crop
set output '<OUT>.png'
set xdata time
set timefmt "%Y-%m-%d_%H:%M:%S"
set xlabel " "
set title '<L1>'
set ytics nomirror
set y2tics
set grid y2tics
set ylabel "Actuator/Window (%)"
set y2label "Temperature in C"
set yrange 0:100
set y2range 5:25

#FileLog 4:.measured-temp\x3a:0:
#FileLog 4:.actuator\x3a:0:int
#FileLog 4:.desired-temp::
#FileLog 4:.window\x3a::

#DbLog <SPEC1>:.measured-temp:0:
#DbLog <SPEC1>:.actuator:0:int
#DbLog <SPEC1>:.desired-temp::
#DbLog <SPEC1>:.window::

plot "<IN>" using 1:2 axes x1y2 title 'Measured temperature' ls l0 lw 1 with lines,\
"<IN>" using 1:2 axes x1y1 title 'Actuator (%)' ls l1 lw 1 with lines,\
"<IN>" using 1:2 axes x1y2 title 'Desired Temperature' ls l2 lw 1 with steps,\
"<IN>" using 1:2 axes x1y1 title 'Window' ls l3 lw 1 with steps
</pre>

Des weiteren ist zu beachten:

On-Off-Plots

EG_Bad:window:::$val=~s/(on|off)(\d*).*/$1eq"on"?1:0/eg

unter Berücksichtigung von dim-Werten:

EG_WoZi_Licht:value:::$val=~s/(on|off)(\d*).*/$1eq"on"?1:($1eq"dim"?$2*0.01:0)/eg

== Beispiel: Anlegen und Nutzung einer SQLite-Datenbank ==
Im folgenden wird eine lokale SQLite-Datenbank auf einen Ubuntu-System angelegt (nach Quelle: [http://www.tatsch-it.de/fhem-dblog/ http://www.tatsch-it.de/fhem-dblog/])
<ol>
<li>
''Installation von SQLite:''
<pre>sudo aptitude install sqlite3 libdbi-perl libdbd-sqlite3-perl</pre>
</li>
<li>
''Anlegen der SQLite-Datenbank fhem.db'' (öffnet auch direkt eine SQL-Kommandozeile):
<pre>sudo sqlite3 /opt/fhem/fhem.db</pre>
In der geöffneten SQL-Kommandozeile eingeben:
<pre>
CREATE TABLE 'history' (TIMESTAMP TIMESTAMP, DEVICE varchar(64), TYPE varchar(64), EVENT varchar(512), READING varchar(64), VALUE varchar(128), UNIT varchar(32));
CREATE TABLE 'current' (TIMESTAMP TIMESTAMP, DEVICE varchar(64), TYPE varchar(64), EVENT varchar(512), READING varchar(64), VALUE varchar(128), UNIT varchar(32));
</pre>
Die Kommandozeile verlässt man mit <code>.exit</code>.
</li>
<li>
''Anpassen des Besitzers und der Rechte der Datenbank-Datei:''
<pre>
sudo chown fhem /opt/fhem/fhem.db
sudo chmod 666 /opt/fhem/fhem.db
</pre>
</li>
<li>
''Datenbank-Anbindung des FHEM konfigurieren:''
<pre>sudo nano /opt/fhem/db.conf</pre>
Inhalt:
<pre>
%dbconfig= (
connection => "SQLite:dbname=/opt/fhem/fhem.db",
user => "",
password => ""
);
</pre>
</li>
<li>
''Logging des FHEM auf die Datenbank konfigurieren:'' (hier sind nur die Anpassungen aufgeführt)
<pre>sudo nano /opt/fhem/fhem.cfg</pre>
<pre>
...
attr global userattr DbLogExclude ... # erlaubt es einzelne Einträge nicht zu loggen
...
define logdb DbLog ./db.conf .*:.* # logt alle(!) auflaufenden Events aller Konfigurationen
...
</pre>
Da durch diese <code>define</code>-Definition alle auflaufenden Events gelogt werden, müssen keine weiteren Anpassungen in der Konfiguration gemacht werden. Die FileLog-Einträge können bedenkenlos bestehen bleiben - dann wird in Datenbank und FileLog gelogt und man verliert keine Daten, falls etwas nicht klappt. Wenn alles wie geplant läuft, können die FileLog-Definitionen gelöscht werden (ebenso die Log-Dateien). Ebenso können die zu loggenden Daten später eingegrenzt werden (s. [[#Finetuning des Loggings]]).
</li>
<li>
''FHEM neu starten:''
<pre>
sudo service fhem stop
sudo service fhem start
</pre>
</li>
<li>
''Kontrollieren, ob Logs in die Datenbank geschrieben werden:''
<pre>sudo sqlite3 /opt/fhem/fhem.db</pre>
In der geöffneten SQL-Kommandozeile eingeben:
<pre>
select * from history order by TIMESTAMP; # dies gibt alle(!) Logs chronologisch aus (kann nach längerem Betrieb recht lange dauern)
</pre>
Die Kommandozeile verlässt man mit <code>.exit</code>.
</li>
<li>
''Anpassung der glot-Dateien:'' siehe [[#Anpassen der gplot-Konfigurationen]]
</li>
</ol>

== Beispiel: Anlegen und Nutzung einer Mysql-Datenbank ==
Anstatt nano kann jeder andere kompatible Editor verwendet werden.

Unter Ubuntu/debian:
apt-get update && apt-get install mysql-server mysql-client libdbd-mysql libdbd-mysql-perl

Bei der Installation sollte man aus Sicherheitsgründen ein Passwort für den mysql-root vergeben, wenn man nicht sogar ganz den Login verbietet.

Hinweis: im Folgenden ist "#" der normale Prompt und "mysql>" der prompt innerhalb mysql, dieser kann mit exit verlassen werden.

Zum Test mal mit mysql verbinden:
# mysql -p -u root
Enter password:
mysql> exit

Jetzt die Tabellenstruktur anlegen.
Hierfür kann die Datei /opt/fhem/contrib/dblog/db_create_mysql.sql als Vorlage verwendet und das Passwort und der Benutzername geändert werden.
cp /opt/fhem/contrib/dblog/db_create_mysql.sql
nano db_create_mysql.sql
Dann wird die Datei eingelesen (root Passwort wird abgefragt):

# mysql -u root -p < db_create_mysql.sql

Jetzt kann man den Zugang testen:

# mysql -p -u <fhemuser>
Enter password: <fhempassword>
mysql> show databases;

Nun müsste eine Datenbank "fhem" angezeigt werden, die die Tabellen current und history enthält.

Nun in der Datei db.conf den mysql-Block auskommentieren und ebenfalls Benutzername, Passwort UND HOST anpassen. Leider ist hier nicht standardmäßig localhost eingestellt.
nano /opt/fhem/db.conf

Jetzt kann unter FHEM ein DbLog-Device angelegt werden (mit dem beispiel wird alles geloggt:
define logdb DbLog ./db.conf .*:.*
Als State muss ein "connected" angezeigt werden.

Ein rereadcfg in Fhem stellt sicher, dass die neue Konfiguration übernommen wird - ein Neustart ist nicht erforderlich

Nun kann die Funktion noch einmal überprüft werden:
<syntaxhighlight lang="sql">
# mysql -u <fhemuser> -p
Enter password: <fhempassword>
mysql> use fhem;
Database changed
mysql> show tables;
+----------------+
| Tables_in_fhem |
+----------------+
| current |
| history |
+----------------+
2 rows in set (0,00 sec)
mysql> select * from history; # Achtung, kann sehr groß werden .... #
</syntaxhighlight>

== Integration von DBLog in eigene Module ==
=== Bereitstellung der UNITS ===
Mit der DbLog_splitFn kann der Modulautor selbst festlegen, wie die Events des Moduls in die Bestandteile Reading/Value/Unit zerlegt werden um ein korrektes Logging per DbLog zu gewährleisten.

Dazu muss der Modulautor in der [[DevelopmentModuleIntro#X_Initialize|Initialize-Funktion]] eine <code>DbLog_splitFn</code> bereitstellen:

<syntaxhighlight lang="perl">
sub X_Initialize($)
{
my ($hash) = @_;
...
$hash->{DbLog_splitFn} = "X_DbLog_splitFn";
}
</syntaxhighlight>

Die genaue Aufrufsyntax und Funktionweise einer DbLog_split-Funktion findet man [[DevelopmentModuleIntro#X_DbLog_split|hier]].

== Bekannte Probleme ==
Beim Anlegen der Datenbank per script wird die Value-Spalte nur als Varchar(32) definiert. Dieses kann dazu führen, dass besonders lange Readings (z.b. vom Modul sysmon) abgeschnitten werden und nicht in der Datenbank landen. Dieses lässt sich leicht beheben, indem man die Spalte auf Varchar(64) ändert (siehe auch {{Link2Forum|Topic=25648|Message=252433|LinkText=diesen Forenbeitrag}}).

mysql> ALTER TABLE current MODIFY VALUE VARCHAR(64);
mysql> ALTER TABLE history MODIFY VALUE VARCHAR(64);

== Werte auslesen ==
Manchmal möchte man Daten aus den Logs abrufen ohne händisch in der Datenbank herumzuwühlen (s.u.). Dies ist insb. auch dann hilfreich, wenn man eigenen Funktionen, Notifys oder spezielle Plots entwirft, bei denen man auf Logdaten zugreifen möchte.

Grundsätzlich beschrieben ist dies in der [http://fhem.de/commandref_DE.html#DbLog commandref#DbLog] und unterscheidet sich minimal (aber entscheidend) von der Struktur bei [[FileLog#Werte_auslesen|FileLogs]].

Hier ein paar Beispiele, was man damit anstellen kann:

* <code>get meineDB - - 2016-10-01 2016-10-03 meinSensor</code> alle Einträge des meinSensor vom 01.10.-03.10.2016
* <code>get meineDB - - 2016-10-01_08:00:00 2016-10-01_16:00:00 meinSensor</code> alle Einträge des meinSensor von 8-16 Uhr am 01.10.2016
* <code>get meineDB - - 2016-10-01_08:00:00 2016-10-01_16:00:00 meinSensor:temperature</code> nur die temperature Werte
* <code>{ ReadingsTimestamp("meinSensor","state","0") }</code> Timestamp des aktuellen state des meinSensor
* <code>{ OldTimestamp("meinSensor") }</code> Timestamp des letzten state des FHT_3a32
* <code>{ time_str2num(OldTimestamp("meinSensor")) }</code> Timestamp in Sekunden des letzten state des meinSensor
* ...

== Bearbeitung von Datenbank-Einträgen ==
{{Hinweis|Dieser Abschnitt soll lediglich eine kleine Einführung in die Datenbank-Bearbeitung liefern. Für vertiefende Informationen sollte man sich grundsätzlich mit SQL beschäftigen. Eine umfassende und gut verständliche Anleitung zu SQL bietet bspw. [http://www.w3schools.com/sql/default.asp w3schools].}}
Irgendwann wird der Fall eintreten, dass in der Datenbank Einträge drinstehen, die geändert oder gelöscht werden sollen (zB. fehlerhafte Sensor-Rückmeldungen, umbenannte Readings). In klassischen Log-Dateien würde man diese einfach bearbeiten und löschen/anpassen (wobei man aber tunlichst zuvor den fhem ausmacht um Datenfehler zu vermeiden). Eine Datenbank kann bearbeitet werden ohne den fhem abschalten zu müssen.

Datenbanken kann man ohne weiter Hilfsmittel direkt von der Kommandozeile/Shell aus bearbeiten. Alternativ gibt es auch verschiedenste Tools (webbasiert oder als Applikation), die einen dabei unterstützen (Bsp. findet man u.a. [https://wiki.ubuntuusers.de/SQLite/#Grafische-Benutzeroberflaechen hier]). Für einfache Arbeiten reicht allerdings idR. Shell.

=== SQLite-Datenbanken ===
'''Öffnen der DB unter Linux:'''

(Es werden Schreibrechte benötigt,ohne kann man die DB zwar öffnen, aber nichts machen)
sudo sqlite3 fhem.db
Dadurch öffnet sich ein SQL-Konsole, auf der alle weiteren Befehle ausgeführt werden.

'''Schliessen der DB:'''

sqlite> .exit

'''Hilfe anzeigen:'''

sqlite> .help

'''Alle Tabellen anzeigen:'''

sqlite> .tables

'''Das Schema der DB anzeigen:'''

(vgl. oben [[DbLog#Datenbanken]] und [[DbLog#Beispiel: Anlegen und Nutzung einer SQLite-Datenbank]])

sqlite> .schema

'''Alle Eintäge anzeigen:'''

Die Einträge liegen alle in der Tabelle "History".

'''Ganz wichtig''' ist immer das ";" am Ende Zeile (bei allen Kommandos, die nicht mit einem "." anfangen). Wenn es vergessen wurde zeigt die Konsole solange neue Zeilen bis ein ";" eingegeben wird. So kann ein Befehl auch bequem über mehrere Zeilen geschrieben werden.

sqlite> select * from HISTORY;

Dies kann sehr lange dauern und kann ggf. mit <code>STRG-C</code> abgebrochen werden.

'''Alle Einträge eines Geräts anzeigen:'''

In <code>where</code>-Statements werden Strings in einfache Anführungsstriche gesetzt, Zahlen nicht.

sqlite> select * from HISTORY where DEVICE='Pollenflug';

'''Alle Einträge eines Readings eines Geräts anzeigen:'''

sqlite> select * from HISTORY where DEVICE='Pollenflug' and READING='Graeser';

'''Alle Einträge eines bestimmten Wertes eines Readings eines Geräts anzeigen:'''

sqlite> select * from HISTORY where DEVICE='Pollenflug' and READING='Graeser' and VALUE>1;

'''LÖSCHEN aller Einträge eines bestimmten Wertes eines Readings eines Geräts anzeigen:'''

'''Achtung:''' Löschen kann nicht rückgängig gemacht werden!! Also IMMER erst die entsprechenden SELECT-Statements solange verfeinern bis wirklich nur die gewünschten Einträge angezeigt werden. Dann das <code>select *</code> durch <code>delete</code> ersetzen.

sqlite> delete from HISTORY where DEVICE='Pollenflug' and READING='Graeser' and VALUE>1;

== Datenbank reparieren ==
Es kann immer wieder mal vorkommen, dass Datenbanken Fehler enthalten. Das muss im Alltag garnicht auffallen und auch nicht immer schlimm enden. Wenn man auf der SQL-Konsole aber bspw. eine Meldung <code>Error: database disk image is malformed</code> erhält, sollte man ein Reparatur vornehmen.

=== SQLite-Datenbanken ===
Die folgenden Schritte beschreiben, wie man eine SQLite-DB reparieren kann (Quelle: [http://techblog.dorogin.com/2011/05/sqliteexception-database-disk-image-is.html]):

<ol>
<li>
DB öffnen:
<pre>sudo sqlite3 fhem.db</pre>
</li>
<li>
Integritäts-Check durchführen:
<pre>sqlite> pragma integrity_check;</pre>
Kommt hier ein "ok" ist die DB gesund. Ansonsten erscheint etwas wie
<pre>
*** in database main ***
On tree page 118786 cell 1: Rowid 75 out of order (previous was 816660)
On tree page 118786 cell 4: Rowid 815704 out of order (previous was 816727)
Corruption detected in cell 0 on page 118786
Multiple uses for byte 132 of page 118786
...
</pre>
</li>
<li>
Datenbank-Dump erstellen (Export gesamten DB in die Datei "dump_all_20160516_1043.sql") und DB verlassen:
<pre>
sqlite> .mode insert
sqlite> .output dump_all_20160516_1043.sql
sqlite> .dump
sqlite> .exit
</pre>
</li>
<li>
Neue Datenbank erstellen und den Dump einlesen, Integritäts-Check machen und verlassen:
<pre>sudo sqlite3 fhem-neu.db</pre>
<pre>
sqlite> .read dump_all_20160516_1043.sql
sqlite> pragma integrity_check;
ok
sqlite> .exit
</pre>
</li>
<li>
Spätestens jetzt fhem stoppen:
<pre>sudo service fhem stop</pre>
</li>
<li>
Alte DB sichern und neue aktivieren:
<pre>
sudo mv fhem.db fhem.db.sv_20160516
sudo mv fhem-neu.db fhem.db
</pre>
</li>
<li>
Kontrollieren, dass die neue DB die gleichen Rechte wie die alte DB hat (und ggf. korrigieren):
<pre>
~/fhem$ ls -lha
insgesamt 6,3G
drwxr-xr-x 12 fhem root 4,0K Mai 16 11:07 .
drwxr-xr-x 4 root root 4,0K Dez 25 17:50 ..
...
-rw-r--r-- 1 root root 1,4G Mai 16 11:04 fhem.db
-rw-r--r-- 1 fhem root 2,6G Mai 16 10:59 fhem.db.sv_20160516
...

~/fhem$ sudo chown fhem:root fhem.db

~/fhem$ ls -lha
insgesamt 6,3G
drwxr-xr-x 12 fhem root 4,0K Mai 16 11:07 .
drwxr-xr-x 4 root root 4,0K Dez 25 17:50 ..
...
-rw-r--r-- 1 fhem root 1,4G Mai 16 11:04 fhem.db
-rw-r--r-- 1 fhem root 2,6G Mai 16 10:59 fhem.db.sv_20160516
...
</pre>
</li>
<li>
fhem wieder starten (und natürlich kontrollieren):
<pre>sudo service fhem start</pre>
</li>
</ol>

== Nützliche Codeschnipsel ==
Anbei ein paar nützliche Codeschnipsel rund um DbLog

=== Dateigrösse mitloggen ===
Da die Datenbank ins Unermessliche wachsen kann, empfiehlt es sich - je nach Speicherplatz - ab einer bestimmten Grösse tätig zu werden. Dazu muss diese Grösse allerdings ermittelt werden. Diese geschieht mittels des Userreadings, welches man vorteilshafterweise mit im DbLog-device anlegt:

<pre>attr myDbLog userReadings DbFileSize:lastReduceLogResult.* { (split(' ',`du -m fhem.db`))[0] }</pre>

Mittels dieses Attributs wird die Grösse der .db-Datei immer nach dem Ausführen des ReduceLog in das Reading "DbFileSize" in ganzzahligen MByte abgelegt.

Basierend auf diesem Reading können dann weitere Aktionen, beispielsweise ein Plot, erstellt werden.

== Links ==
* [[Heizleistung_und_Gasverbrauch|Beispiel das DbLog-Daten für SVG-Plots verwendet]]
* [[SVG-Plots von FileLog auf DbLog umstellen]]

DbLog

2017-08-05T07:43:00Z

Cwagner: SQL: Hinweis auf Einbinden der db.conf

{{Infobox Modul
|ModPurpose=Protokolliert Ereignisse in einer Datenbank
|ModType=h
|ModForumArea=Automatisierung
|ModTechName=93_DbLog.pm
|ModOwner=tobiasfaust ({{Link2FU|118|Forum}}/[[Benutzer Diskussion:Tobias.faust|Wiki]])
}}

== Einleitung ==
Mit der Zeit entstehen im fhem recht umfangreiche Log-Daten für die verschiedensten konfigurierten Devices. Die übliche Einstiegs-[[Konfiguration]] sieht vor, dass die Logs als [http://fhem.de/commandref_DE.html#FileLog FileLog] gespeichert werden - je nach Einstellung in wenigen sehr großen oder vielen kleineren Dateien. Der Datei-basierte Zugriff ist allerdings nicht wirklick performant und kann schnell zum Flaschenhals werden (z.B. bei der Darstellung von Graphen über einen längeren Zeitraum).

Alternativ kann Fhem die Log-Daten mittels [http://fhem.de/commandref_DE.html#DbLog DbLog] in einer Datenbank speichern. Diese kann lokal als einfache SQLite- oder als zentrale Server-Datenbank (s.u.) gestaltet sein. Schon eine lokale einfache SQLite-Datenbank ist in der Regel deutlich performanter als File-basierte Logs.

Damit eine Datenbank-Nutzung möglich ist, müssen folgende Anpassungen gemacht werden:
# [[#Datenbank|Erstellen einer entsprechenden Datenbank]]
# [[#Datenbank-Anbindung mittels db.conf|Konfiguration der Datenbank-Anbindung in FHEM]]
# [[#Konfiguration als Device in fhem.cfg|Anpassen aller (oder einzelner) Konfigurationen von FileLog nach DbLog]]
# [[#Anpassen der gplot-Konfigurationen|Ggf. Anpassen der gplot-Konfigurationen]]

== Konfiguration ==
=== Datenbank-Anbindung mittels db.conf ===
DbLog wird durch 2 verschiedene Einträge aktiviert/definiert. In einer Datei namens '''db.conf''' werden die Parameter für eine Verbindung zur Datenbank (host, username, password, etc.) hinterlegt. Diese Datei kann in einem beliebigen Verzeichnis angelegt werden. Für eine MySQL-Datenbank sieht die db.conf folgendermaßen aus:

%dbconfig= (
connection => "mysql:database=fhem;host=db;port=3306",
user => "fhemuser",
password => "fhempassword",
);

Im Verzeichnis '''contrib/dblog''' der FHEM-Installation befindet sich eine Beispielkonfiguration mit der Syntax für jeden unterstützen Datenbanktyp.
Es wird empfohlen diese Datei zu kopieren und erst dann entsprechend zu bearbeiten. Am Besten kopiert man diese Datei in das FHEM Home Directory /opt/fhem/ und achtet auf die entsprechenden Rechte!
chown fhem:dialout /opt/fhem/db.conf

=== Konfiguration als Device ===
Das DbLog Device wird dann definiert mit
:<code>define <name> DbLog <configfilename> <regexp> </code>
wobei ''<configfilename>'' dem Pfad zur zuvor angelegten db.conf entspricht.
Ein Beispiel hierfür wäre:
:<code>define logdb DbLog ./db.conf .*:.* </code>
Die Angabe von <code>.*:.*</code> bedeutet, dass sämtliche DeviceMessages (Messwerte, Batteriestatus, KeepAlives, etc.) in die Datenbank geschrieben werden. Dies führt u.U. dazu, dass die Datenbank auch mit vielen teils irrelevanten Werten gefüllt wird. Man kann daher die zu loggenden Werte einschränken, indem man genau angibt welche Werte übertragen werden sollen. Dies ist in [[#Finetuning des Loggings]] beschrieben.

=== Finetuning des Loggings ===
Bei der Konfiguration des Log-Devices werden die zu loggenden Daten definiert - in der einfachsten Form sieht das so aus: <code>define logdb DbLog ./db.conf .*:.* </code>. Die Angabe von <code>.*:.*</code> bedeutet, dass sämtliche DeviceMessages (Messwerte, Batteriestatus, KeepAlives, etc.) in die Datenbank geschrieben werden. Dies führt u.U. dazu, dass die Datenbank auch mit sehr vielen und teils nicht benötigten Werten gefüllt wird und schnell wächst. Die Datenbank ist zwar deutlich leistungsfähiger, was große Datenmengen angeht, Datensparsamkeit kann aber schnell sinnvoll werden...

Um das Log-Aufkommen einzugrenzen gibt es 2 Ansätze:
* Einschränkung über den <code>define</code>-Eintrag
* Einschränkung über DbLogExclude-Einträge der jeweiligen Devices
* Einschränkung über DbLogInclude-Einträge des jeweiligen Devices

==== Einschränkung über den zentralen <code>define</code>-Eintrag ====
Man kann die zu loggenden Werte einschränken, indem man genau angibt welche Werte übertragen werden sollen. Die erste Wildcard, also das erste <code>.*</code>, entspricht dem in FHEM verwendeten Device-Namen. Die zweite Wildcard entspricht dem vom Device ausgegebenen zu loggenden Wert. Separiert werden beiden Angaben durch einen Doppelpunkt.

Ein Beispiel, um zwar alle definierten Devices zu erfassen, aber nur die Werte Temperatur, Ventilposition und Luftfeuchte in die Datenbank zu schreiben wäre:
:<code>define myDbLog DbLog ./db.conf .*:(temperature|valveposition|humidity).* </code>

==== Einschränkung über die jeweiligen Devices ====
Man kann die zu loggenden Werte für einzelne Devices separat einschränken, ohne dies im zentralen define-Eintrag machen zu müssen. Dies kann interessant sein, wenn beispielsweise ein Device Fehlerwerte meldet, die uninteressant sind, oder es meldet unnötig häufig Werte - beides ist z.B. bei 1-wire-Temperatursensoren gerne der Fall.

Um das einzuschränken gibt es 2 Stellparameter, die als Attribute direkt zum jeweiligen Device konfiguriert werden:
* DbLogExclude - definiert Werte, die nicht geloggt werden sollen
* DbLogInclude - definiert Werte, die geloggt werden sollen ( siehe attr DbLogSelectionMode )
* event-min-interval, event-on-change-reading und event-on-update-reading beeinflussen, wie häufig Werte geloggt werden (vgl. [http://fhem.de/commandref_DE.html#event-on-update-reading commandref])

Eine konkrete Konfiguration für einen sehr gesprächigen 1-wire-Temperatursensor könnte wie folgt aussehen:
<pre>
define EG_Balkon GPIO4 BUSMASTER
attr EG_Balkon DbLogExclude failures,T,85 # logge keine "failures", "T"-Werte und "85"-Werte (default-Werte, wenn keine Temperatur gelesen werden kann)
attr EG_Balkon event-on-change-reading state # logge nur, wenn sich ein Wert ändert (wenn sich die Temperatur nicht ändert, logge das nicht)
attr EG_Balkon event-min-interval state:900 # logge spätestens alle 900sec = 15min
attr EG_Balkon event-on-update-reading .* # logge alle Werte, die aktualisiert werden

attr <1-Wire-Device vom Typ OWTHERM oder OWSWITCH> DbLogExclude data.* # verhindert das Logging der state-Eintragungen
</pre>

Eine in diesem {{Link2Forum|Topic=33697|Message=264127}} vorgestellte Strategie zur Vermeidung unnötigen Loggings ist, dass bei der Definition von Devices durch das nachfolgende <code>notify</code> automatisch ein DbLogExclude für alle Werte (.*) des Devices zugewiesen wird und dies nur bei Interesse an geloggten Werten gelöscht bzw. angepasst wird:
<code>define nDbLogExclude notify global:DEFINED.* attr $EVTPART1 DbLogExclude .*</code>

Ebenso ist es mittlerweile möglich, lediglich erwünschte Werte (Positiv-Liste) zu loggen und alle anderen zu verwerfen. Hierfür wird im LogDevice das attribut DbLogSelectionMode Include verwendet. Nun kann für jedes Device mit DbLogInclude <Reading1>,<Reading2>,... angegeben werden, welche Readings geloggt werden sollen.
Integriert ist ebenfalls ein "min-interval", siehe commandref.

== Datenbank ==
Unterstützte Datenbanksysteme (Auswahl):
* Sqlite
* MySQL
* PostGreSql

=== Tabellen ===
Die Datenbank ist relativ simpel gestaltet und besteht lediglich aus den folgenden beiden Tabellen:
* current
* history

DbLog ist auf eine feste Tabellenstruktur angewiesen. Man muss daher in seiner Datenbank eine Tabelle mit folgenden Spalten anlegen:
{| class="wikitable"
|-
! Spalte
! Beschreibung (en)
! Beschreibung (de)
! Beispiel
|-
| '''TIMESTAMP'''
| timestamp of event
| Zeitstempel
| 2007-12-30 21:45:22
|-
| '''DEVICE'''
| device name
| Device-Name
| Wetterstation
|-
| '''TYPE'''
| device type
| Device-Typ
| KS300
|-
| '''EVENT'''
| event specification as full string
| Eventspezifikation als Text
| humidity: 71 (%)
|-
| '''READING'''
| name of reading extracted from event
| Bezeichnung des Readings
| humidity
|-
| '''VALUE'''
| actual reading extracted from event
| Wert des Readings
| 71
|-
| '''UNIT'''
| unit extracted from event
| Einheit des Readings
| %
|-
|}

Die Vorlagen zur Anlage von Tabellen und Indizes sind für jeden unterstützten Datenbanktyp im Verzeichnis '''contrib/dblog''' der FHEM-Installation, oder hier zu finden: [https://svn.fhem.de/trac/browser/trunk/fhem/contrib/dblog/ Link]. Das MySQL-Skript (db_create_mysql.sql) legt eine neue Datenbank, das PostGres-Skript (db_create_postgresql.sql) ein neues Schema mit Namen "fhem" an.

==== current ====
Die Tabelle current enthält für jedes zu loggende Device lediglich den letzten Wert. Falls noch kein Wert geloggt wurde, ist diese Tabelle leer.
Falls der Inhalt gelöscht wird, bauen sich die Daten automatisch wieder auf. Es gehen durch das löschen der Tabelle current keine Log-Informationen verloren.
Der Inhalt wird aber u.a. für die Dropdown-Felder beim Plot-Editor verwendet.

Um doppelte Einträge in der Tabelle zu vermeiden, wurden die Möglichkeit geschaffen Primary Keys zu definieren. Da in der Spalte <code>READING</code> u.U. bei verschiedenen Geräten gleiche Namen vorkommen können, sollte der Primary Key um den Gerätenamen erweitert werden. Der Primary Key sollte also aus <code>DEVICE</code> und <code>READING</code> bestehen. Um in der Datenbank ''fhem'' diesen PK zu setzen, kann folgender SQL Code verwendet werden:

<syntaxhighlight lang="sql">
ALTER TABLE `fhem`.`current`
CHANGE COLUMN `DEVICE` `DEVICE` VARCHAR(64) CHARACTER SET 'utf8' COLLATE 'utf8_bin' NOT NULL ,
CHANGE COLUMN `READING` `READING` VARCHAR(64) CHARACTER SET 'utf8' COLLATE 'utf8_bin' NOT NULL ,
ADD PRIMARY KEY (`DEVICE`, `READING`);
</syntaxhighlight>

==== history ====
Die Tabelle history enthält alle bisher geloggten Daten. Löschen in dieser Tabelle bedeutet automatisch Datenverlust (gewollt oder nicht ... )
Der Inhalt dieser Tabelle wird verwendet, um die Plots zu zeichnen.

== Anpassen der gplot-Konfigurationen ==
Die meisten gplot-Konfigurationen sind bisher lediglich auf FileLog-Konfigurationen ausgelegt. Deshalb müssen sie für die Verwendung mit DbLog angepasst werden. Glücklicherweise beschränkt sich dies auf die reinen FileLog-Zeilen - es müssen die DbLog-Äquivalente hinzugefügt werden. Die FileLog-Einträge müssen zwar nicht gelöscht werden, wenn man aber FileLog und DbLog parallel betreibt, sollte man getrennte gplot-Dateien für beide Logging-Typen haben um Auswertungsprobleme erkennen zu können.

Für die fht.gplot Konfiguration sähe die Anpassung wie folgt aus (lediglich die vier DbLog-Zeilen wurden hinzugefügt):
<pre>
# Created by FHEM/98_SVG.pm, 2014-12-25 21:53:30
set terminal png transparent size <SIZE> crop
set output '<OUT>.png'
set xdata time
set timefmt "%Y-%m-%d_%H:%M:%S"
set xlabel " "
set title '<L1>'
set ytics nomirror
set y2tics
set grid y2tics
set ylabel "Actuator/Window (%)"
set y2label "Temperature in C"
set yrange 0:100
set y2range 5:25

#FileLog 4:.measured-temp\x3a:0:
#FileLog 4:.actuator\x3a:0:int
#FileLog 4:.desired-temp::
#FileLog 4:.window\x3a::

#DbLog <SPEC1>:.measured-temp:0:
#DbLog <SPEC1>:.actuator:0:int
#DbLog <SPEC1>:.desired-temp::
#DbLog <SPEC1>:.window::

plot "<IN>" using 1:2 axes x1y2 title 'Measured temperature' ls l0 lw 1 with lines,\
"<IN>" using 1:2 axes x1y1 title 'Actuator (%)' ls l1 lw 1 with lines,\
"<IN>" using 1:2 axes x1y2 title 'Desired Temperature' ls l2 lw 1 with steps,\
"<IN>" using 1:2 axes x1y1 title 'Window' ls l3 lw 1 with steps
</pre>

Des weiteren ist zu beachten:

On-Off-Plots

EG_Bad:window:::$val=~s/(on|off)(\d*).*/$1eq"on"?1:0/eg

unter Berücksichtigung von dim-Werten:

EG_WoZi_Licht:value:::$val=~s/(on|off)(\d*).*/$1eq"on"?1:($1eq"dim"?$2*0.01:0)/eg

== Beispiel: Anlegen und Nutzung einer SQLite-Datenbank ==
Im folgenden wird eine lokale SQLite-Datenbank auf einen Ubuntu-System angelegt (nach Quelle: [http://www.tatsch-it.de/fhem-dblog/ http://www.tatsch-it.de/fhem-dblog/])
<ol>
<li>
''Installation von SQLite:''
<pre>sudo aptitude install sqlite3 libdbi-perl libdbd-sqlite3-perl</pre>
</li>
<li>
''Anlegen der SQLite-Datenbank fhem.db'' (öffnet auch direkt eine SQL-Kommandozeile):
<pre>sudo sqlite3 /opt/fhem/fhem.db</pre>
In der geöffneten SQL-Kommandozeile eingeben:
<pre>
CREATE TABLE 'history' (TIMESTAMP TIMESTAMP, DEVICE varchar(64), TYPE varchar(64), EVENT varchar(512), READING varchar(64), VALUE varchar(128), UNIT varchar(32));
CREATE TABLE 'current' (TIMESTAMP TIMESTAMP, DEVICE varchar(64), TYPE varchar(64), EVENT varchar(512), READING varchar(64), VALUE varchar(128), UNIT varchar(32));
</pre>
Die Kommandozeile verlässt man mit <code>.exit</code>.
</li>
<li>
''Anpassen des Besitzers und der Rechte der Datenbank-Datei:''
<pre>
sudo chown fhem /opt/fhem/fhem.db
sudo chmod 666 /opt/fhem/fhem.db
</pre>
</li>
<li>
''Datenbank-Anbindung des FHEM konfigurieren:''
<pre>sudo nano /opt/fhem/db.conf</pre>
Inhalt:
<pre>
%dbconfig= (
connection => "SQLite:dbname=/opt/fhem/fhem.db",
user => "",
password => ""
);
</pre>
</li>
<li>
''Logging des FHEM auf die Datenbank konfigurieren:'' (hier sind nur die Anpassungen aufgeführt)
<pre>sudo nano /opt/fhem/fhem.cfg</pre>
<pre>
...
attr global userattr DbLogExclude ... # erlaubt es einzelne Einträge nicht zu loggen
...
define logdb DbLog ./db.conf .*:.* # logt alle(!) auflaufenden Events aller Konfigurationen
...
</pre>
Da durch diese <code>define</code>-Definition alle auflaufenden Events gelogt werden, müssen keine weiteren Anpassungen in der Konfiguration gemacht werden. Die FileLog-Einträge können bedenkenlos bestehen bleiben - dann wird in Datenbank und FileLog gelogt und man verliert keine Daten, falls etwas nicht klappt. Wenn alles wie geplant läuft, können die FileLog-Definitionen gelöscht werden (ebenso die Log-Dateien). Ebenso können die zu loggenden Daten später eingegrenzt werden (s. [[#Finetuning des Loggings]]).
</li>
<li>
''FHEM neu starten:''
<pre>
sudo service fhem stop
sudo service fhem start
</pre>
</li>
<li>
''Kontrollieren, ob Logs in die Datenbank geschrieben werden:''
<pre>sudo sqlite3 /opt/fhem/fhem.db</pre>
In der geöffneten SQL-Kommandozeile eingeben:
<pre>
select * from history order by TIMESTAMP; # dies gibt alle(!) Logs chronologisch aus (kann nach längerem Betrieb recht lange dauern)
</pre>
Die Kommandozeile verlässt man mit <code>.exit</code>.
</li>
<li>
''Anpassung der glot-Dateien:'' siehe [[#Anpassen der gplot-Konfigurationen]]
</li>
</ol>

=== Praxishinweis ===
Findet sich im Fhem.log der Fehlerhinweis: <code>DbLog logdb - Error while reading ./db.conf: 'Error on reading ./db.conf from database!'</code>
dann sollte in FHEM mit diesem Befehl die Konfiguration integriert werden:
<code>configdb fileimport /opt/fhem/db.conf</code>

== Beispiel: Anlegen und Nutzung einer Mysql-Datenbank ==
Anstatt nano kann jeder andere kompatible Editor verwendet werden.

Unter Ubuntu/debian:
apt-get update && apt-get install mysql-server mysql-client libdbd-mysql libdbd-mysql-perl

Bei der Installation sollte man aus Sicherheitsgründen ein Passwort für den mysql-root vergeben, wenn man nicht sogar ganz den Login verbietet.

Hinweis: im Folgenden ist "#" der normale Prompt und "mysql>" der prompt innerhalb mysql, dieser kann mit exit verlassen werden.

Zum Test mal mit mysql verbinden:
# mysql -p -u root
Enter password:
mysql> exit

Jetzt die Tabellenstruktur anlegen.
Hierfür kann die Datei /opt/fhem/contrib/dblog/db_create_mysql.sql als Vorlage verwendet und das Passwort und der Benutzername geändert werden.
cp /opt/fhem/contrib/dblog/db_create_mysql.sql
nano db_create_mysql.sql
Dann wird die Datei eingelesen (root Passwort wird abgefragt):

# mysql -u root -p < db_create_mysql.sql

Jetzt kann man den Zugang testen:

# mysql -p -u <fhemuser>
Enter password: <fhempassword>
mysql> show databases;

Nun müsste eine Datenbank "fhem" angezeigt werden, die die Tabellen current und history enthält.

Nun in der Datei db.conf den mysql-Block auskommentieren und ebenfalls Benutzername, Passwort UND HOST anpassen. Leider ist hier nicht standardmäßig localhost eingestellt.
nano /opt/fhem/db.conf

Jetzt kann unter FHEM ein DbLog-Device angelegt werden (mit dem beispiel wird alles geloggt:
define logdb DbLog ./db.conf .*:.*
Als State muss ein "connected" angezeigt werden.

Ein rereadcfg in Fhem stellt sicher, dass die neue Konfiguration übernommen wird - ein Neustart ist nicht erforderlich

Nun kann die Funktion noch einmal überprüft werden:
<syntaxhighlight lang="sql">
# mysql -u <fhemuser> -p
Enter password: <fhempassword>
mysql> use fhem;
Database changed
mysql> show tables;
+----------------+
| Tables_in_fhem |
+----------------+
| current |
| history |
+----------------+
2 rows in set (0,00 sec)
mysql> select * from history; # Achtung, kann sehr groß werden .... #
</syntaxhighlight>

== Integration von DBLog in eigene Module ==
=== Bereitstellung der UNITS ===
Mit der DbLog_splitFn kann der Modulautor selbst festlegen, wie die Events des Moduls in die Bestandteile Reading/Value/Unit zerlegt werden um ein korrektes Logging per DbLog zu gewährleisten.

Dazu muss der Modulautor in der [[DevelopmentModuleIntro#X_Initialize|Initialize-Funktion]] eine <code>DbLog_splitFn</code> bereitstellen:

<syntaxhighlight lang="perl">
sub X_Initialize($)
{
my ($hash) = @_;
...
$hash->{DbLog_splitFn} = "X_DbLog_splitFn";
}
</syntaxhighlight>

Die genaue Aufrufsyntax und Funktionweise einer DbLog_split-Funktion findet man [[DevelopmentModuleIntro#X_DbLog_split|hier]].

== Bekannte Probleme ==
Beim Anlegen der Datenbank per script wird die Value-Spalte nur als Varchar(32) definiert. Dieses kann dazu führen, dass besonders lange Readings (z.b. vom Modul sysmon) abgeschnitten werden und nicht in der Datenbank landen. Dieses lässt sich leicht beheben, indem man die Spalte auf Varchar(64) ändert (siehe auch {{Link2Forum|Topic=25648|Message=252433|LinkText=diesen Forenbeitrag}}).

mysql> ALTER TABLE current MODIFY VALUE VARCHAR(64);
mysql> ALTER TABLE history MODIFY VALUE VARCHAR(64);

== Werte auslesen ==
Manchmal möchte man Daten aus den Logs abrufen ohne händisch in der Datenbank herumzuwühlen (s.u.). Dies ist insb. auch dann hilfreich, wenn man eigenen Funktionen, Notifys oder spezielle Plots entwirft, bei denen man auf Logdaten zugreifen möchte.

Grundsätzlich beschrieben ist dies in der [http://fhem.de/commandref_DE.html#DbLog commandref#DbLog] und unterscheidet sich minimal (aber entscheidend) von der Struktur bei [[FileLog#Werte_auslesen|FileLogs]].

Hier ein paar Beispiele, was man damit anstellen kann:

* <code>get meineDB - - 2016-10-01 2016-10-03 meinSensor</code> alle Einträge des meinSensor vom 01.10.-03.10.2016
* <code>get meineDB - - 2016-10-01_08:00:00 2016-10-01_16:00:00 meinSensor</code> alle Einträge des meinSensor von 8-16 Uhr am 01.10.2016
* <code>get meineDB - - 2016-10-01_08:00:00 2016-10-01_16:00:00 meinSensor:temperature</code> nur die temperature Werte
* <code>{ ReadingsTimestamp("meinSensor","state","0") }</code> Timestamp des aktuellen state des meinSensor
* <code>{ OldTimestamp("meinSensor") }</code> Timestamp des letzten state des FHT_3a32
* <code>{ time_str2num(OldTimestamp("meinSensor")) }</code> Timestamp in Sekunden des letzten state des meinSensor
* ...

== Bearbeitung von Datenbank-Einträgen ==
{{Hinweis|Dieser Abschnitt soll lediglich eine kleine Einführung in die Datenbank-Bearbeitung liefern. Für vertiefende Informationen sollte man sich grundsätzlich mit SQL beschäftigen. Eine umfassende und gut verständliche Anleitung zu SQL bietet bspw. [http://www.w3schools.com/sql/default.asp w3schools].}}
Irgendwann wird der Fall eintreten, dass in der Datenbank Einträge drinstehen, die geändert oder gelöscht werden sollen (zB. fehlerhafte Sensor-Rückmeldungen, umbenannte Readings). In klassischen Log-Dateien würde man diese einfach bearbeiten und löschen/anpassen (wobei man aber tunlichst zuvor den fhem ausmacht um Datenfehler zu vermeiden). Eine Datenbank kann bearbeitet werden ohne den fhem abschalten zu müssen.

Datenbanken kann man ohne weiter Hilfsmittel direkt von der Kommandozeile/Shell aus bearbeiten. Alternativ gibt es auch verschiedenste Tools (webbasiert oder als Applikation), die einen dabei unterstützen (Bsp. findet man u.a. [https://wiki.ubuntuusers.de/SQLite/#Grafische-Benutzeroberflaechen hier]). Für einfache Arbeiten reicht allerdings idR. Shell.

=== SQLite-Datenbanken ===
'''Öffnen der DB unter Linux:'''

(Es werden Schreibrechte benötigt,ohne kann man die DB zwar öffnen, aber nichts machen)
sudo sqlite3 fhem.db
Dadurch öffnet sich ein SQL-Konsole, auf der alle weiteren Befehle ausgeführt werden.

'''Schliessen der DB:'''

sqlite> .exit

'''Hilfe anzeigen:'''

sqlite> .help

'''Alle Tabellen anzeigen:'''

sqlite> .tables

'''Das Schema der DB anzeigen:'''

(vgl. oben [[DbLog#Datenbanken]] und [[DbLog#Beispiel: Anlegen und Nutzung einer SQLite-Datenbank]])

sqlite> .schema

'''Alle Eintäge anzeigen:'''

Die Einträge liegen alle in der Tabelle "History".

'''Ganz wichtig''' ist immer das ";" am Ende Zeile (bei allen Kommandos, die nicht mit einem "." anfangen). Wenn es vergessen wurde zeigt die Konsole solange neue Zeilen bis ein ";" eingegeben wird. So kann ein Befehl auch bequem über mehrere Zeilen geschrieben werden.

sqlite> select * from HISTORY;

Dies kann sehr lange dauern und kann ggf. mit <code>STRG-C</code> abgebrochen werden.

'''Alle Einträge eines Geräts anzeigen:'''

In <code>where</code>-Statements werden Strings in einfache Anführungsstriche gesetzt, Zahlen nicht.

sqlite> select * from HISTORY where DEVICE='Pollenflug';

'''Alle Einträge eines Readings eines Geräts anzeigen:'''

sqlite> select * from HISTORY where DEVICE='Pollenflug' and READING='Graeser';

'''Alle Einträge eines bestimmten Wertes eines Readings eines Geräts anzeigen:'''

sqlite> select * from HISTORY where DEVICE='Pollenflug' and READING='Graeser' and VALUE>1;

'''LÖSCHEN aller Einträge eines bestimmten Wertes eines Readings eines Geräts anzeigen:'''

'''Achtung:''' Löschen kann nicht rückgängig gemacht werden!! Also IMMER erst die entsprechenden SELECT-Statements solange verfeinern bis wirklich nur die gewünschten Einträge angezeigt werden. Dann das <code>select *</code> durch <code>delete</code> ersetzen.

sqlite> delete from HISTORY where DEVICE='Pollenflug' and READING='Graeser' and VALUE>1;

== Datenbank reparieren ==
Es kann immer wieder mal vorkommen, dass Datenbanken Fehler enthalten. Das muss im Alltag garnicht auffallen und auch nicht immer schlimm enden. Wenn man auf der SQL-Konsole aber bspw. eine Meldung <code>Error: database disk image is malformed</code> erhält, sollte man ein Reparatur vornehmen.

=== SQLite-Datenbanken ===
Die folgenden Schritte beschreiben, wie man eine SQLite-DB reparieren kann (Quelle: [http://techblog.dorogin.com/2011/05/sqliteexception-database-disk-image-is.html]):

<ol>
<li>
DB öffnen:
<pre>sudo sqlite3 fhem.db</pre>
</li>
<li>
Integritäts-Check durchführen:
<pre>sqlite> pragma integrity_check;</pre>
Kommt hier ein "ok" ist die DB gesund. Ansonsten erscheint etwas wie
<pre>
*** in database main ***
On tree page 118786 cell 1: Rowid 75 out of order (previous was 816660)
On tree page 118786 cell 4: Rowid 815704 out of order (previous was 816727)
Corruption detected in cell 0 on page 118786
Multiple uses for byte 132 of page 118786
...
</pre>
</li>
<li>
Datenbank-Dump erstellen (Export gesamten DB in die Datei "dump_all_20160516_1043.sql") und DB verlassen:
<pre>
sqlite> .mode insert
sqlite> .output dump_all_20160516_1043.sql
sqlite> .dump
sqlite> .exit
</pre>
</li>
<li>
Neue Datenbank erstellen und den Dump einlesen, Integritäts-Check machen und verlassen:
<pre>sudo sqlite3 fhem-neu.db</pre>
<pre>
sqlite> .read dump_all_20160516_1043.sql
sqlite> pragma integrity_check;
ok
sqlite> .exit
</pre>
</li>
<li>
Spätestens jetzt fhem stoppen:
<pre>sudo service fhem stop</pre>
</li>
<li>
Alte DB sichern und neue aktivieren:
<pre>
sudo mv fhem.db fhem.db.sv_20160516
sudo mv fhem-neu.db fhem.db
</pre>
</li>
<li>
Kontrollieren, dass die neue DB die gleichen Rechte wie die alte DB hat (und ggf. korrigieren):
<pre>
~/fhem$ ls -lha
insgesamt 6,3G
drwxr-xr-x 12 fhem root 4,0K Mai 16 11:07 .
drwxr-xr-x 4 root root 4,0K Dez 25 17:50 ..
...
-rw-r--r-- 1 root root 1,4G Mai 16 11:04 fhem.db
-rw-r--r-- 1 fhem root 2,6G Mai 16 10:59 fhem.db.sv_20160516
...

~/fhem$ sudo chown fhem:root fhem.db

~/fhem$ ls -lha
insgesamt 6,3G
drwxr-xr-x 12 fhem root 4,0K Mai 16 11:07 .
drwxr-xr-x 4 root root 4,0K Dez 25 17:50 ..
...
-rw-r--r-- 1 fhem root 1,4G Mai 16 11:04 fhem.db
-rw-r--r-- 1 fhem root 2,6G Mai 16 10:59 fhem.db.sv_20160516
...
</pre>
</li>
<li>
fhem wieder starten (und natürlich kontrollieren):
<pre>sudo service fhem start</pre>
</li>
</ol>

== Nützliche Codeschnipsel ==
Anbei ein paar nützliche Codeschnipsel rund um DbLog

=== Dateigrösse mitloggen ===
Da die Datenbank ins Unermessliche wachsen kann, empfiehlt es sich - je nach Speicherplatz - ab einer bestimmten Grösse tätig zu werden. Dazu muss diese Grösse allerdings ermittelt werden. Diese geschieht mittels des Userreadings, welches man vorteilshafterweise mit im DbLog-device anlegt:

<pre>attr myDbLog userReadings DbFileSize:lastReduceLogResult.* { (split(' ',`du -m fhem.db`))[0] }</pre>

Mittels dieses Attributs wird die Grösse der .db-Datei immer nach dem Ausführen des ReduceLog in das Reading "DbFileSize" in ganzzahligen MByte abgelegt.

Basierend auf diesem Reading können dann weitere Aktionen, beispielsweise ein Plot, erstellt werden.

== Links ==
* [[Heizleistung_und_Gasverbrauch|Beispiel das DbLog-Daten für SVG-Plots verwendet]]
* [[SVG-Plots von FileLog auf DbLog umstellen]]

HM-ES-TX-WM Zählersensor für Strom- und Gaszähler

2017-05-14T14:11:43Z

Cwagner:

{{Infobox Hardware
|Bild=HM-EM-TX-WM.jpg
|Bildbeschreibung=HomeMatic Zählersensor
|HWProtocol=HomeMatic
|HWType=Powersensor
|HWCategory=HomeMatic
|HWComm=868 MHz
|HWChannels=1
|HWVoltage=6 V
|HWPowerConsumption=30 mA
|HWPoweredBy=4 Batterien LR6/AA/Mignon
|HWSize=68x105x30mm
|HWDeviceFHEM=[http://fhem.de/commandref.html#CUL_HM CUL_HM]
|HWManufacturer=ELV / eQ-3
}}

== Features ==
Der HM-ES-TX-WM ist eine Datenerfassungs- und Sendeeinheit, an die genau ein (separat zu erwerbender) Zählersensor für passende Strom-/Gaszähler angeschlossen wird, der den aktuellen Verbrauch direkt am jeweiligen Zähler erfasst und in FHEM als Momentanwerte und als laufenden Saldo verfügbar macht.

'''Technische Daten:'''

Gewicht: 195 g (inkl. 4 LR6/Mignon/AA-Batterien)

== Anwendungsszenarien ==
Mit den erfassten und gesammelten Daten lassen sich Aktionen beim Erreichen bestimmter Schwellwerte auslösen, Verbrauchs- und Kostenstatistiken erstellen sowie beliebige weitere Abhängigkeiten bilden. Durch die Funkdatenübertragung sowie den Batteriebetrieb (1 bis 2 Jahre Betriebsdauer verspricht der Hersteller mit einem Satz) ist die Installation denkbar einfach und erfordert lediglich beim Anbringen der Leseeinheit Genauigkeit.

Im Februar 2015 hat die Auslieferung der Geräte als (einfacher) Bausatz begonnen, zu dem es
* einen [https://www.elv.de/homematic-zaehlersensor-ferraris-zaehler-es-fer.html Ferraris-Sensor] (für Stromzähler mit den markanten Laufscheiben) (ca. 25€),
* einen [https://www.elv.de/homematic-zaehlersensor-led-es-led.html LED-Sensor] (für neue Zähler mit S0-Schnittstelle) (ca. 25€), sowie
* einen [https://www.elv.de/homematic-zaehlersensor-gas-es-gas.html BK-G4-Gaszähler] von Elster-Kromschröder (die an einer Ziffernrolle einen kleinen Magneten haben, der über einen Sensor mit Reedkontakt erfasst wird) (ca. 60€)
gibt. Es ist laut Hersteller ELV als [http://www.elv.de/homematic-zaehlersensor-strom-gas-bausatz.html Bausatz] (ca. 45€) oder auch - deutlich teurer - [https://www.elv.de/homematic-komplettbausatz-zaehlersensor-sendeeinheit-strom-gas.html fertig montiert] (ca. 70€) verfügbar.

Die Zähler werden mit rückstandslos entfernbaren Klebepads angebracht.

== Parameter ==
'''list: register | range | peer | description'''
0: pairCentral | 0 to 16777215 | | pairing to central
1: mtrConstGas | 0 to 655.36 | | constant gas
1: mtrConstIr | 0 to 65536 | | constant IR
1: mtrConstLed | 0 to 65536 | | constant led
1: mtrSensIr | -99 to 99 | | sensiblity IR
1: mtrType | literal | | type of measurement options:LED,gas,unknown,IR

== Probleme ==
Der HM-ES-TX-WM sendet zyklisch im 3-Minuten Takt die aktuellen Verbrauchsdaten. Dabei ist für das Reading "power" (aktuelle Stromleistung in Watt) zu beachten, dass alle drei Minuten der ''zuletzt bekannte Wert'' gesendet wird. Das heißt im Besonderen:

* Sollten innerhalb der drei Minuten mehrfach Impulse auftreten mit unterschiedlichen Leistungswerten, wird nur der zuletzt bekannte Wert genommen. Es findet keine Aggregation der Impulse (Mittelwert, Summe, …) statt.
* Sollten innerhalb der drei Minuten keinerlei Impulse auftreten, wird dennoch der zuletzt bekannte Leistungswert gesendet, auch wenn er mehrere Minuten/Stunden/Tage alt ist.

Der state des Devices zeigt den letzten Übertragungsstatus an das Device, das Geräte unterstützt keinen Burst. D.h. einen an das Gerät abgesetzten Befehl z.B. getConfig oder einstellen von Zählerkonstanten sollte man möglichst am Geräte bestätigen, sonst könnte es sein, dass ein ACK zu spät zurück kommt und man sich anschließend im state über ein NACK wundert.

Scheinbar gibt es für das reading energy bei 838860.7 einen Zählerüberlauf. {{Link2Forum|Topic=32827|Message=270012}}

== Betrieb mit FHEM ==
Der Sensor wird mit einem FHEM im Update-Stand vom (mindestens) 7.2.2015 funktionsfähig eingebunden (getestet in der Variante mit Ferraris-Fühler). Es werden der Fühlertyp und die Fühlerkonstante richtig ausgelesen und im Reading ''energy'' die errechnete Energiemenge ausgegeben (bei Strom: Wattstunden, Wh).

Für die perfekte Konfiguration wird auf die Seite "[[Heizleistung und Gasverbrauch]]" verwiesen, wo eine vollständige Lösung für die Umrechnung von Gasverbrauch in kW/h, Graphen und Hilfsprogramme vorgestellt wird.

=== Readings ===
'''Reading: |Beispiel'''
D-firmware |1.0
D-serialNr |MEQ0025452
battery |ok
boot |off
current |0
eState |E: 6199.9 P: 1713 I: 0 U: 0 f: 50
energy |6199.9
energyOffset |84413.2
frequency |50
power |1713
powerOn |2015-03-26 14:57:48
voltage |0

=== Events Auszug ===
'''Event |Beispielswert'''
battery* |ok
energy |10186.6
power |283
current |0
voltage |0
frequency |50
eState |E: 10186.6 P: 283 I: 0 U: 0 f: 50
boot |off

Ein battery-Event wird nicht zyklisch getriggert. Erst wenn die Batterie tatsächlich leer ist, wird eine entsprechende Meldung vom Gerät selber gesendet und ein battery-Event getriggert (battery: low).

Mit einem Userreading lässt sich die Angabe aus ''energy'' (zum Beispiel für einen Stromzähler (Wh)) in die auf dem Zähler übliche Angabe kWh umrechnen und zugleich mit dem Aufaddieren des Unterschieds beim Start (das Zählermodul beginnt ja mit 0 Wh, während der Zähler meist schon einige Jahre auf der "Rolle" hat) die Angaben gleichziehen:
:<code><nowiki>attr <DeviceName> userReadings kWh {sprintf("%.1f",ReadingsVal("<DeviceName>","energy","???")/1000+72031.5639)}</nowiki></code>

=== Konfiguration ===
Nach dem Erkennen durch [[autocreate]] wird der Zählersensor mit diesen Angaben eingebunden:

define CUL_HM_HM_ES_TX_WM_353594 CUL_HM 353594
attr CUL_HM_HM_ES_TX_WM_353594 IODev CUL_0
attr CUL_HM_HM_ES_TX_WM_353594 actCycle 000:10
attr CUL_HM_HM_ES_TX_WM_353594 actStatus alive
attr CUL_HM_HM_ES_TX_WM_353594 expert 2_full
attr CUL_HM_HM_ES_TX_WM_353594 firmware 1.0
attr CUL_HM_HM_ES_TX_WM_353594 model HM-ES-TX-WM
attr CUL_HM_HM_ES_TX_WM_353594 subType powerSensor
define CUL_HM_HM_ES_TX_WM_353594_IEC_01 CUL_HM 353594
attr CUL_HM_HM_ES_TX_WM_353594_IEC_01 icon measure_power
attr CUL_HM_HM_ES_TX_WM_353594_IEC_01 model HM-ES-TX-WM
attr CUL_HM_HM_ES_TX_WM_353594_IEC_01 peerIDs
define CUL_HM_HM_ES_TX_WM_353594_IEC_02 CUL_HM 353594
attr CUL_HM_HM_ES_TX_WM_353594_IEC_02 model HM-ES-TX-WM

Die Übertragung der Messwerte erfolgt in Kanal 01 (hier: "CUL_HM_HM_ES_TX_WM_353594_IEC_01"). Für eine Darstellung als SVG-Plot können die Messwerte mittels folgender Anweisung in einer Datei abgespeichert werden.

define FileLog_CUL_HM_HM_ES_TX_WM_353594_IEC_01 FileLog ./log/Stromverbrauch-%Y-%m.log CUL_HM_HM_ES_TX_WM_353594_IEC_01

Für den Betrieb mit den verschiedenen Zählern muß eines der Readings '''R-mtrConst'''XXX auf den jeweiligen verwendeten Zähler konfiguriert werden. Z.B. kann ein Ferraris-Stromzähler 100, 150 oder 200 Umdrehungen je kWh benötigen. Dies geschieht z.B. für 150 Meldungen je Einheit für einen Ferraris-Zähler mit dem Befehl
:<code>set CUL_HM_HM_ES_TX_WM_353594 regSet mtrConstIr 150</code>

oder für einen Gaszähler auf der 1. Rolle (d.h. 1 Impuls je 0.1 m^3)
:<code>set CUL_HM_HM_ES_TX_WM_353594 regSet mtrConstGas 0.1</code>

In FHEM bis zum Anfang November 2015 war hier ein kleiner Bug enthalten, der diesen Wert nicht akzeptierte. In diesem Fall läßt sich die Anzahl der Impulse direkt am Gerät über das Display einstellen.

== Logging/Graph. Darstellung ==
[[Datei:PlotStromverbrauchProStunde.png|mini|400px|rechts|Beispiel der graph. Darstellung]]
Der Zähler wird fortlaufend aufaddiert. Mit der delta-Funktion von SVG-Plot können die Verbräuche sehr gut visualisiert werden.
Beispiel Stromzähler:

set terminal png transparent size <SIZE> crop
set output '<OUT>.png'
set xdata time
set timefmt "%Y-%m-%d_%H:%M:%S"
set xlabel " "
set title 'Stündlicher Stromverbrauch | aktuell: $data{currval1} ($data{min1} / $data{avg1} / $data{max1}) kWh'
set ytics
set y2tics
set grid ytics
set ylabel "kWh/h"
set y2label "kWh/h"
#FileLog 4:CUL_HM_HM_ES_TX_WM_353594.kWh\x3a:0:delta-h
plot "<IN>" using 1:2 axes x1y2 title 'Line 1' ls l0 lw 2 with bars

== Wiki ToDo ==
Seit dem FHEM Update vom 06.03.2016 werden bei Neueinrichtung mit Autocreate 2 Kanäle angelegt. Dies entspricht der Firmware Revision 1.1:
* _IEC_01
Im Gas-Modus werden hier die Werte geliefert.
Im IR-Modus kommen seit R12555 vom 12.11.2016 hier die Zähl-Werte Energiewerte an, die auch im Status von IEC02 gezeigt werden.
state enthält dabei den Wert des readings energy. Möchte man hier z.B. die im letzten Zeitfenster gemessene Leistung anzeigen lassen, reading power, so hilft das Attribut stateformat
<code>{sprintf("P: %.1f W", ReadingsVal($name,"power",0))}</code>

* _IEC_02

== Firmwareupdate ==
Das Gerät lässt sich in den Updatemodus versetzen, im dem die Batterien zunächst entfernt, dann beim Einsetzen die Anlerntaste (die rechte mit der Bezeichnung ">") gedrückt bleibt. die Leuchtdiode blinkt dann rot im schnellen Takt. Das FHEM-Kommando zum Senden der Firmware per <code>set <devicename> fwUpdate <Firmwaredatei.eq3></code> muss vor dem Einlegen der Batterie (bei gleichzeitigem Drücken der Anlerntaste) aufgegeben werden. Erfolgt zum Zeitpunkt des Anstartens im Updatemodus keine Sendung der Firmware wird der Zählersensor normal gebootet. Die Meldung <code> <devicename> fwUpdate: fail:notInBootLoader</code> im Filelog erscheint, wenn das FHEM fwUpdate Kommando ''zu spät'' gesendet wurde.

Der Update dauert etwa eine Minute. Während des Updates blinkt die Diode rot in kurzen Intervallen.
Nach erfolgreichen Update muss der Sensor auf die Werkseinstellungen zurückgesetzt (">" Taste 4 Sekunden drücken (Display zeigt reS), kurz warten, ">" noch mal 4 Sekunden drücken - Zählersensor rebootet), aus der FHEM Konfiguration entfernt und neu angelernt werden.

Wenn der Reset nicht durchgeführt wird, kommt vom Sensor immer die Fehlermeldung: einmal langes und drei mal kurzes rotes Blinken (Sitz des Auslesekopfes prüfen). Diese Meldung ist in diesem Zusammenhang ziemlich irreführend.

Dieser Vorgang ist im changelog.txt file der Firmware unvollständig beschrieben, da hier ein Update an der CCU vorausgesetzt wird und die CCU die Firmware wohl automatisch sendet.

== Links ==
* Handbuch [http://files.elv.de/Assets/Produkte/14/1401/140143/Downloads/140143_sensor_um.pdf]
* Produktseite ELV: [http://www.elv.de/homematic-zaehlersensor-strom-gas-bausatz.html]
* Forum {{Link2Forum|Topic=32827|Message=252161}}
* Forum {{Link2Forum|Topic=30936|Message=234877}}

[[Kategorie:HomeMatic Components]]
[[Kategorie:Energieverbrauchsmessung]]
[[Kategorie:Energieerzeugungsmessung]]

HM-ES-TX-WM Zählersensor für Strom- und Gaszähler

2017-05-13T08:32:58Z

Cwagner: Beschreibung des Update-Prozess erweitert

{{Infobox Hardware
|Bild=HM-EM-TX-WM.jpg
|Bildbeschreibung=HomeMatic Zählersensor
|HWProtocol=HomeMatic
|HWType=Powersensor
|HWCategory=HomeMatic
|HWComm=868 MHz
|HWChannels=1
|HWVoltage=6 V
|HWPowerConsumption=30 mA
|HWPoweredBy=4 Batterien LR6/AA/Mignon
|HWSize=68x105x30mm
|HWDeviceFHEM=[http://fhem.de/commandref.html#CUL_HM CUL_HM]
|HWManufacturer=ELV / eQ-3
}}

== Features ==
Der HM-ES-TX-WM ist eine Datenerfassungs- und Sendeeinheit, an die genau ein (separat zu erwerbender) Zählersensor für passende Strom-/Gaszähler angeschlossen wird, der den aktuellen Verbrauch direkt am jeweiligen Zähler erfasst und in FHEM als Momentanwerte und als laufenden Saldo verfügbar macht.

'''Technische Daten:'''

Gewicht: 195 g (inkl. 4 LR6/Mignon/AA-Batterien)

== Anwendungsszenarien ==
Mit den erfassten und gesammelten Daten lassen sich Aktionen beim Erreichen bestimmter Schwellwerte auslösen, Verbrauchs- und Kostenstatistiken erstellen sowie beliebige weitere Abhängigkeiten bilden. Durch die Funkdatenübertragung sowie den Batteriebetrieb (1 bis 2 Jahre Betriebsdauer verspricht der Hersteller mit einem Satz) ist die Installation denkbar einfach und erfordert lediglich beim Anbringen der Leseeinheit Genauigkeit.

Im Februar 2015 hat die Auslieferung der Geräte als (einfacher) Bausatz begonnen, zu dem es
* einen [https://www.elv.de/homematic-zaehlersensor-ferraris-zaehler-es-fer.html Ferraris-Sensor] (für Stromzähler mit den markanten Laufscheiben) (ca. 25€),
* einen [https://www.elv.de/homematic-zaehlersensor-led-es-led.html LED-Sensor] (für neue Zähler mit S0-Schnittstelle) (ca. 25€), sowie
* einen [https://www.elv.de/homematic-zaehlersensor-gas-es-gas.html BK-G4-Gaszähler] von Elster-Kromschröder (die an einer Ziffernrolle einen kleinen Magneten haben, der über einen Sensor mit Reedkontakt erfasst wird) (ca. 60€)
gibt. Es ist laut Hersteller ELV als [http://www.elv.de/homematic-zaehlersensor-strom-gas-bausatz.html Bausatz] (ca. 45€) oder auch - deutlich teurer - [https://www.elv.de/homematic-komplettbausatz-zaehlersensor-sendeeinheit-strom-gas.html fertig montiert] (ca. 70€) verfügbar.

Die Zähler werden mit rückstandslos entfernbaren Klebepads angebracht.

== Parameter ==
'''list: register | range | peer | description'''
0: pairCentral | 0 to 16777215 | | pairing to central
1: mtrConstGas | 0 to 655.36 | | constant gas
1: mtrConstIr | 0 to 65536 | | constant IR
1: mtrConstLed | 0 to 65536 | | constant led
1: mtrSensIr | -99 to 99 | | sensiblity IR
1: mtrType | literal | | type of measurement options:LED,gas,unknown,IR

== Probleme ==
Der HM-ES-TX-WM sendet zyklisch im 3-Minuten Takt die aktuellen Verbrauchsdaten. Dabei ist für das Reading "power" (aktuelle Stromleistung in Watt) zu beachten, dass alle drei Minuten der ''zuletzt bekannte Wert'' gesendet wird. Das heißt im Besonderen:

* Sollten innerhalb der drei Minuten mehrfach Impulse auftreten mit unterschiedlichen Leistungswerten, wird nur der zuletzt bekannte Wert genommen. Es findet keine Aggregation der Impulse (Mittelwert, Summe, …) statt.
* Sollten innerhalb der drei Minuten keinerlei Impulse auftreten, wird dennoch der zuletzt bekannte Leistungswert gesendet, auch wenn er mehrere Minuten/Stunden/Tage alt ist.

Der state des Devices zeigt den letzten Übertragungsstatus an das Device, das Geräte unterstützt keinen Burst. D.h. einen an das Gerät abgesetzten Befehl z.B. getConfig oder einstellen von Zählerkonstanten sollte man möglichst am Geräte bestätigen, sonst könnte es sein, dass ein ACK zu spät zurück kommt und man sich anschließend im state über ein NACK wundert.

Scheinbar gibt es für das reading energy bei 838860.7 einen Zählerüberlauf. {{Link2Forum|Topic=32827|Message=270012}}

== Betrieb mit FHEM ==
Der Sensor wird mit einem FHEM im Update-Stand vom (mindestens) 7.2.2015 funktionsfähig eingebunden (getestet in der Variante mit Ferraris-Fühler). Es werden der Fühlertyp und die Fühlerkonstante richtig ausgelesen und im Reading ''energy'' die errechnete Energiemenge ausgegeben (bei Strom: Wattstunden, Wh).

Für die perfekte Konfiguration wird auf die Seite "[[Heizleistung und Gasverbrauch]]" verwiesen, wo eine vollständige Lösung für die Umrechnung von Gasverbrauch in kW/h, Graphen und Hilfsprogramme vorgestellt wird.

=== Readings ===
'''Reading: |Beispiel'''
D-firmware |1.0
D-serialNr |MEQ0025452
battery |ok
boot |off
current |0
eState |E: 6199.9 P: 1713 I: 0 U: 0 f: 50
energy |6199.9
energyOffset |84413.2
frequency |50
power |1713
powerOn |2015-03-26 14:57:48
voltage |0

=== Events Auszug ===
'''Event |Beispielswert'''
battery* |ok
energy |10186.6
power |283
current |0
voltage |0
frequency |50
eState |E: 10186.6 P: 283 I: 0 U: 0 f: 50
boot |off

Ein battery-Event wird nicht zyklisch getriggert. Erst wenn die Batterie tatsächlich leer ist, wird eine entsprechende Meldung vom Gerät selber gesendet und ein battery-Event getriggert (battery: low).

Mit einem Userreading lässt sich die Angabe aus ''energy'' (zum Beispiel für einen Stromzähler (Wh)) in die auf dem Zähler übliche Angabe kWh umrechnen und zugleich mit dem Aufaddieren des Unterschieds beim Start (das Zählermodul beginnt ja mit 0 Wh, während der Zähler meist schon einige Jahre auf der "Rolle" hat) die Angaben gleichziehen:
:<code><nowiki>attr <DeviceName> userReadings kWh {sprintf("%.1f",ReadingsVal("<DeviceName>","energy","???")/1000+72031.5639)}</nowiki></code>

=== Konfiguration ===
Nach dem Erkennen durch [[autocreate]] wird der Zählersensor mit diesen Angaben eingebunden:

define CUL_HM_HM_ES_TX_WM_353594 CUL_HM 353594
attr CUL_HM_HM_ES_TX_WM_353594 IODev CUL_0
attr CUL_HM_HM_ES_TX_WM_353594 actCycle 000:10
attr CUL_HM_HM_ES_TX_WM_353594 actStatus alive
attr CUL_HM_HM_ES_TX_WM_353594 expert 2_full
attr CUL_HM_HM_ES_TX_WM_353594 firmware 1.0
attr CUL_HM_HM_ES_TX_WM_353594 model HM-ES-TX-WM
attr CUL_HM_HM_ES_TX_WM_353594 subType powerSensor
define CUL_HM_HM_ES_TX_WM_353594_IEC_01 CUL_HM 353594
attr CUL_HM_HM_ES_TX_WM_353594_IEC_01 icon measure_power
attr CUL_HM_HM_ES_TX_WM_353594_IEC_01 model HM-ES-TX-WM
attr CUL_HM_HM_ES_TX_WM_353594_IEC_01 peerIDs
define CUL_HM_HM_ES_TX_WM_353594_IEC_02 CUL_HM 353594
attr CUL_HM_HM_ES_TX_WM_353594_IEC_02 model HM-ES-TX-WM

Die Übertragung der Messwerte erfolgt in Kanal 01 (hier: "CUL_HM_HM_ES_TX_WM_353594_IEC_01"). Für eine Darstellung als SVG-Plot können die Messwerte mittels folgender Anweisung in einer Datei abgespeichert werden.

define FileLog_CUL_HM_HM_ES_TX_WM_353594_IEC_01 FileLog ./log/Stromverbrauch-%Y-%m.log CUL_HM_HM_ES_TX_WM_353594_IEC_01

Für den Betrieb mit den verschiedenen Zählern muß eines der Readings '''R-mtrConst'''XXX auf den jeweiligen verwendeten Zähler konfiguriert werden. Z.B. kann ein Ferraris-Stromzähler 100, 150 oder 200 Umdrehungen je kWh benötigen. Dies geschieht z.B. für 150 Meldungen je Einheit für einen Ferraris-Zähler mit dem Befehl
:<code>set CUL_HM_HM_ES_TX_WM_353594 regSet mtrConstIr 150</code>

oder für einen Gaszähler auf der 1. Rolle (d.h. 1 Impuls je 0.1 m^3)
:<code>set CUL_HM_HM_ES_TX_WM_353594 regSet mtrConstGas 0.1</code>

In FHEM bis zum Anfang November 2015 war hier ein kleiner Bug enthalten, der diesen Wert nicht akzeptierte. In diesem Fall läßt sich die Anzahl der Impulse direkt am Gerät über das Display einstellen.

== Logging/Graph. Darstellung ==
[[Datei:PlotStromverbrauchProStunde.png|mini|400px|rechts|Beispiel der graph. Darstellung]]
Der Zähler wird fortlaufend aufaddiert. Mit der delta-Funktion von SVG-Plot können die Verbräuche sehr gut visualisiert werden.
Beispiel Stromzähler:

set terminal png transparent size <SIZE> crop
set output '<OUT>.png'
set xdata time
set timefmt "%Y-%m-%d_%H:%M:%S"
set xlabel " "
set title 'Stündlicher Stromverbrauch | aktuell: $data{currval1} ($data{min1} / $data{avg1} / $data{max1}) kWh'
set ytics
set y2tics
set grid ytics
set ylabel "kWh/h"
set y2label "kWh/h"
#FileLog 4:CUL_HM_HM_ES_TX_WM_353594.kWh\x3a:0:delta-h
plot "<IN>" using 1:2 axes x1y2 title 'Line 1' ls l0 lw 2 with bars

== Wiki ToDo ==
Seit dem FHEM Update vom 06.03.2016 werden bei Neueinrichtung mit Autocreate 2 Kanäle angelegt. Dies entspricht der Firmware Revision 1.1:
* _IEC_01
Im Gas-Modus werden hier die Werte geliefert.
Im IR-Modus kommen seit R12555 vom 12.11.2016 hier die Zähl-Werte Energiewerte an, die auch im Status von IEC02 gezeigt werden.
state enthält dabei den Wert des readings energy. Möchte man hier z.B. die im letzten Zeitfenster gemessene Leistung anzeigen lassen, reading power, so hilft das Attribut stateformat
<code>{sprintf("P: %.1f W", ReadingsVal($name,"power",0))}</code>

* _IEC_02

== Firmwareupdate ==
Das Gerät lässt sich in den Updatemodus versetzen, im dem die Batterien zunächst entfernt, dann beim Einsetzen die Anlerntaste (die rechte mit der Bezeichnung ">") gedrückt bleibt. die Leuchtdiode blinkt dann rot im schnellen Takt. Das FHEM-Kommando zum Senden der Firmware per <code>set <devicename> fwUpdate <Firmwaredatei.eq3></code> muss vor dem Einlegen der Batterie (bei gleichzeitigem Drücken der Anlerntaste) aufgegeben werden. Erfolgt zum Zeitpunkt des Anstartens im Updatemodus keine Sendung der Firmware wird der Zählersensor normal gebootet. Die Meldung <code> <devicename> fwUpdate: fail:notInBootLoader</code> im Filelog erscheint, wenn das FHEM fwUpdate Kommando ''zu spät'' gesendet wurde.

Tipp: Da Einlegen von Batterie, Drücken der Anlerntaste schon zwei von zwei Händen belegt, kann man mit einem kleinen AT alle Sekunde die Firmwareupdate auslösen (die im fhem-Verzeichnis liegen sollte). Die Definition dafür:

<code>+*00:00:01 set [Name des Zählers] fwUpdate HM-ES-TX-WM_update_V1_2_160628.eq3</code>

Der Update dauert etwa eine Minute. Während des Updates blinkt die Diode rot in kurzen Intervallen.
Nach erfolgreichen Update muss der Sensor auf die Werkseinstellungen zurückgesetzt (">" Taste 4 Sekunden drücken (Display zeigt reS), kurz warten, ">" noch mal 4 Sekunden drücken - Zählersensor rebootet), aus der FHEM Konfiguration entfernt und neu angelernt werden.

Wenn der Reset nicht durchgeführt wird, kommt vom Sensor immer die Fehlermeldung: einmal langes und drei mal kurzes rotes Blinken (Sitz des Auslesekopfes prüfen). Diese Meldung ist in diesem Zusammenhang ziemlich irreführend.

Dieser Vorgang ist im changelog.txt file der Firmware unvollständig beschrieben, da hier ein Update an der CCU vorausgesetzt wird und die CCU die Firmware wohl automatisch sendet.

== Links ==
* Handbuch [http://files.elv.de/Assets/Produkte/14/1401/140143/Downloads/140143_sensor_um.pdf]
* Produktseite ELV: [http://www.elv.de/homematic-zaehlersensor-strom-gas-bausatz.html]
* Forum {{Link2Forum|Topic=32827|Message=252161}}
* Forum {{Link2Forum|Topic=30936|Message=234877}}

[[Kategorie:HomeMatic Components]]
[[Kategorie:Energieverbrauchsmessung]]
[[Kategorie:Energieerzeugungsmessung]]

Delete

2016-12-08T18:52:10Z

Cwagner: Schreibweise von deleteReading korrigiert

{{SEITENTITEL:delete}}
{{Infobox Modul
|ModPurpose=Befehl zum Löschen von Gerätedefinitionen
|ModType=cmd
|ModCmdRef=delete
|ModForumArea=Sonstiges
|ModTechName=fhem.pl ("Built-in")
|ModOwner=rudolfkoenig ({{Link2FU|8|Forum}} / [[Benutzer Diskussion:Rudolfkoenig|Wiki]])
}}
Der Befehl [[delete]] dient dazu, Geräte (Devices) aus der Fhem-[[Konfiguration]] zu löschen.

Der Befehl kann direkt über die [[FHEMWEB|Weboberfläche]] eingegeben werden.

Sollen nur Teile eines Gerätes gelöscht werden, stehen dafür dir Befehle ''deleteattr'' (löschen von Attributen) und ''deleteReading'' (löschen von Readings) zur Verfügung.

HM-ES-TX-WM Zählersensor für Strom- und Gaszähler

2016-11-28T07:12:14Z

Cwagner: neuerliche Korrektur Zuordnung Channels nach neuerlicher Änderung von CUL_HM

{{Infobox Hardware
|Bild=HM-EM-TX-WM.jpg
|Bildbeschreibung=HomeMatic Zählersensor
|HWProtocol=HomeMatic
|HWType=Powersensor
|HWCategory=HomeMatic
|HWComm=868 MHz
|HWChannels=1
|HWVoltage=6 V
|HWPowerConsumption=30 mA
|HWPoweredBy=4 Batterien LR6/AA/Mignon
|HWSize=68x105x30mm
|HWDeviceFHEM=[http://fhem.de/commandref.html#CUL_HM CUL_HM]
|HWManufacturer=ELV / eQ-3
}}

== Features ==
Der Zählersensor ist ein Datenerfassungssystem, das den Energieverbräuche (Strom, Gas) direkt am Zähler erfasst und in FHEM als laufender Saldo und als Momentanwerte verfügbar macht.

'''Technische Daten:'''

Gewicht: 195 g (inkl. 4 LR6/Mignon/AA-Batterien)

== Anwendungsszenarien ==
Mit den erfassten und gesammelten Daten lassen sich Aktionen beim Erreichen bestimmter Schwellwerte auslösen, Verbrauchs- und Kostenstatistiken erstellen sowie beliebige weitere Abhängigkeiten bilden. Durch die Funkdatenübertragung sowie den Batteriebetrieb (1 bis 2 Jahre Betriebsdauer verspricht der Hersteller mit einem Satz) ist die Installation denkbar einfach und erfordert lediglich beim Anbringen der Leseeinheit Genauigkeit.

Im Februar 2015 hat die Auslieferung der Geräte als (einfacher) Bausatz begonnen, zu dem es
* einen Ferraris-Sensor (für Stromzähler mit den markanten Laufscheiben),
* LED-Sensor (für neue Zähler mit S0-Schnittstelle) sowie
* BK-G4-Gaszähler von Elster-Kromschröder (die an einer Ziffernrolle einen kleinen Magneten haben, der über einen Sensor mit Reedkontakt erfasst wird)
gibt. Es ist laut Hersteller [http://www.elv.de/homematic-zaehlersensor-strom-gas-bausatz.html ELV] nur der Bausatz verfügbar. Ein Fertiggerät ist aktuell nicht geplant.

Die Zähler werden mit rückstandslos entfernbaren Klebepads angebracht.

== Parameter ==
'''list: register | range | peer | description'''
0: pairCentral | 0 to 16777215 | | pairing to central
1: mtrConstGas | 0 to 655.36 | | constant gas
1: mtrConstIr | 0 to 65536 | | constant IR
1: mtrConstLed | 0 to 65536 | | constant led
1: mtrSensIr | -99 to 99 | | sensiblity IR
1: mtrType | literal | | type of measurement options:LED,gas,unknown,IR

== Probleme ==
Der HM-ES-TX-WM sendet zyklisch im 3-Minuten Takt die aktuellen Verbrauchsdaten. Dabei ist für das Reading "power" (aktuelle Stromleistung in Watt) zu beachten, dass alle drei Minuten der ''zuletzt bekannte Wert'' gesendet wird. Das heißt im Besonderen:

* Sollten innerhalb der drei Minuten mehrfach Impulse auftreten mit unterschiedlichen Leistungswerten, wird nur der zuletzt bekannte Wert genommen. Es findet keine Aggregation der Impulse (Mittelwert, Summe, …) statt.
* Sollten innerhalb der drei Minuten keinerlei Impulse auftreten, wird dennoch der zuletzt bekannte Leistungswert gesendet, auch wenn er mehrere Minuten/Stunden/Tage alt ist.

Der state des Devices zeigt den letzten Übertragungsstatus an das Device, das Geräte unterstützt keinen Burst. D.h. einen an das Gerät abgesetzten Befehl z.B. getConfig oder einstellen von Zählerkonstanten sollte man möglichst am Geräte bestätigen, sonst könnte es sein, dass ein ACK zu spät zurück kommt und man sich anschließend im state über ein NACK wundert.

Scheinbar gibt es für das reading energy bei 838860.7 einen Zählerüberlauf. [http://forum.fhem.de/index.php/topic,32827.msg270012.html#msg270012]

== Betrieb mit FHEM ==
Der Sensor wird mit einem FHEM im Update-Stand vom (mindestens) 7.2.2015 funktionsfähig eingebunden (getestet in der Variante mit Ferraris-Fühler). Es werden der Fühlertyp und die Fühlerkonstante richtig ausgelesen und im Reading ''energy'' die errechnete Energiemenge ausgegeben (bei Strom: Wattstunden, Wh).

Für die perfekte Konfiguration wird auf die Seite "[[Heizleistung und Gasverbrauch]]" verwiesen, wo eine vollständige Lösung für die Umrechnung von Gasverbrauch in kW/h, Graphen und Hilfsprogramme vorgestellt wird.

=== Readings ===
'''Reading: |Beispiel'''
D-firmware |1.0
D-serialNr |MEQ0025452
battery |ok
boot |off
current |0
eState |E: 6199.9 P: 1713 I: 0 U: 0 f: 50
energy |6199.9
energyOffset |84413.2
frequency |50
power |1713
powerOn |2015-03-26 14:57:48
voltage |0

=== Events Auszug ===
'''Event |Beispielswert'''
battery* |ok
energy |10186.6
power |283
current |0
voltage |0
frequency |50
eState |E: 10186.6 P: 283 I: 0 U: 0 f: 50
boot |off

Ein battery-Event wird nicht zyklisch getriggert. Erst wenn die Batterie tatsächlich leer ist, wird eine entsprechende Meldung vom Gerät selber gesendet und ein battery-Event getriggert (battery: low).

Mit einem Userreading lässt sich die Angabe aus ''energy'' (zum Beispiel für einen Stromzähler (Wh)) in die auf dem Zähler übliche Angabe kWh umrechnen und zugleich mit dem Aufaddieren des Unterschieds beim Start (das Zählermodul beginnt ja mit 0 Wh, während der Zähler meist schon einige Jahre auf der "Rolle" hat) die Angaben gleichziehen:
:<code><nowiki>attr <DeviceName> userReadings kWh {sprintf("%.1f",ReadingsVal("<DeviceName>","energy","???")/1000+72031.5639)}</nowiki></code>

=== Konfiguration ===
Nach dem Erkennen durch [[autocreate]] wird der Zählersensor mit diesen Angaben eingebunden:

define CUL_HM_HM_ES_TX_WM_353594 CUL_HM 353594
attr CUL_HM_HM_ES_TX_WM_353594 IODev CUL_0
attr CUL_HM_HM_ES_TX_WM_353594 actCycle 000:10
attr CUL_HM_HM_ES_TX_WM_353594 actStatus alive
attr CUL_HM_HM_ES_TX_WM_353594 expert 2_full
attr CUL_HM_HM_ES_TX_WM_353594 firmware 1.0
attr CUL_HM_HM_ES_TX_WM_353594 model HM-ES-TX-WM
attr CUL_HM_HM_ES_TX_WM_353594 subType powerSensor

Für den Betrieb mit den verschiedenen Zählern muß eines der Readings '''R-mtrConst'''XXX auf den jeweiligen verwendeten Zähler konfiguriert werden. Z.B. kann ein Ferraris-Stromzähler 100, 150 oder 200 Umdrehungen je kWh benötigen. Dies geschieht z.B. für 150 Meldungen je Einheit für einen Ferraris-Zähler mit dem Befehl
:<code>set CUL_HM_HM_ES_TX_WM_353594 regSet mtrConstIr 150</code>

oder für einen Gaszähler auf der 1. Rolle (d.h. 1 Impuls je 0.1 m^3)
:<code>set CUL_HM_HM_ES_TX_WM_353594 regSet mtrConstGas 0.1</code>

In Fhem bis zum Anfang November 2015 war hier ein kleiner Bug enthalten, der diesen Wert nicht akzeptierte. In diesem Fall läßt sich die Anzahl der Impulse direkt am Gerät über das Display einstellen.

== Logging/Graph. Darstellung ==
[[Datei:PlotStromverbrauchProStunde.png|mini|400px|rechts|Beispiel der graph. Darstellung]]
Der Zähler wird fortlaufend aufaddiert. Mit der delta-Funktion von SVG-Plot können die Verbräuche sehr gut visualisiert werden.
Beispiel Stromzähler:

set terminal png transparent size <SIZE> crop
set output '<OUT>.png'
set xdata time
set timefmt "%Y-%m-%d_%H:%M:%S"
set xlabel " "
set title 'Stündlicher Stromverbrauch | aktuell: $data{currval1} ($data{min1} / $data{avg1} / $data{max1}) kWh'
set ytics
set y2tics
set grid ytics
set ylabel "kWh/h"
set y2label "kWh/h"
#FileLog 4:CUL_HM_HM_ES_TX_WM_353594.kWh\x3a:0:delta-h
plot "<IN>" using 1:2 axes x1y2 title 'Line 1' ls l0 lw 2 with bars

== Wiki ToDo ==
Seit dem FHEM Update vom 06.03.2016 werden bei Neueinrichtung mit Autocreate 2 Kanäle angelegt. Dies entspricht der Firmware Revision 1.1:
* _IEC_01
Im Gas-Modus werden hier die Werte geliefert.
Im IR-Modus kommen seit R12555 vom 12.11.2016 hier die Zähl-Werte Energiewerte an, die auch im Status von IEC02 gezeigt werden.
state enthält dabei den Wert des readings energy. Möchte man hier z.B. die im letzten Zeitfenster gemessene Leistung anzeigen lassen, reading power, so hilft das Attribut stateformat
<code>{sprintf("P: %.1f W", ReadingsVal($name,"power",0))}</code>

* _IEC_02

== Firmwareupdate ==
Das Gerät lässt sich in den Updatemodus versetzen, im dem die Batterien zunächst entfernt, dann beim Einsetzen die Anlerntaste gedrückt bleibt. die Leuchtdiode blinkt dann rot im schnellen Takt. Das FHEM-Kommando zum Senden der Firmware per <code>set <devicename> fwUpdate <Firmwaredatei.eq3></code> muss vor dem Einlegen der Batterie (+ ">" Taste) aufgegeben werden. Erfolgt zum Zeitpunkt des Anstartens im Updatemodus keine Sendung der Firmware wird der Zählersensor normal gebootet. Die Meldung <code> <devicename> fwUpdate: fail:notInBootLoader</code> im Filelog erscheint, wenn das FHEM fwUpdate Kommando ''zu spät'' gesendet wurde.

Der Update dauert etwa eine Minute. Während des Updates blinkt die Diode rot in kurzen Intervallen.
Nach erfolgreichen Update muss der Sensor auf die Werkseinstellungen zurückgesetzt (">" Taste 4 Sekunden drücken (Display zeigt reS), kurz warten, ">" noch mal 4 Sekunden drücken - Zählersensor rebootet), aus der FHEM Konfiguration entfernt und neu angelernt werden.

Wenn der Reset nicht durchgeführt wird, kommt vom Sensor immer die Fehlermeldung: einmal langes und drei mal kurzes rotes Blinken (Sitz des Auslesekopfes prüfen). Diese Meldung ist in diesem Zusammenhang ziemlich irreführend.

Dieser Vorgang ist im changelog.txt file der Firmware unvollständig beschrieben, da hier ein Update an der CCU vorausgesetzt wird und die CCU die Firmware wohl automatisch sendet.

== Links ==
* Handbuch [http://files.elv.de/Assets/Produkte/14/1401/140143/Downloads/140143_sensor_um.pdf]
* Produktseite ELV: [http://www.elv.de/homematic-zaehlersensor-strom-gas-bausatz.html]
* Forum [http://forum.fhem.de/index.php/topic,32827.msg252161.html#msg252161]
* Forum [http://forum.fhem.de/index.php/topic,30936.msg234877.html#msg234877]

[[Kategorie:HomeMatic Components]]
[[Kategorie:Energieverbrauchsmessung]]
[[Kategorie:Energieerzeugungsmessung]]

HM-ES-TX-WM Zählersensor für Strom- und Gaszähler

2016-11-21T18:52:13Z

Cwagner:

{{Infobox Hardware
|Bild=HM-EM-TX-WM.jpg
|Bildbeschreibung=HomeMatic Zählersensor
|HWProtocol=HomeMatic
|HWType=Powersensor
|HWCategory=HomeMatic
|HWComm=868 MHz
|HWChannels=1
|HWVoltage=6 V
|HWPowerConsumption=30 mA
|HWPoweredBy=4 Batterien LR6/AA/Mignon
|HWSize=68x105x30mm
|HWDeviceFHEM=[http://fhem.de/commandref.html#CUL_HM CUL_HM]
|HWManufacturer=ELV / eQ-3
}}

== Features ==
Der Zählersensor ist ein Datenerfassungssystem, das den Energieverbräuche (Strom, Gas) direkt am Zähler erfasst und in FHEM als laufender Saldo und als Momentanwerte verfügbar macht.

'''Technische Daten:'''

Gewicht: 195 g (inkl. 4 LR6/Mignon/AA-Batterien)

== Anwendungsszenarien ==
Mit den erfassten und gesammelten Daten lassen sich Aktionen beim Erreichen bestimmter Schwellwerte auslösen, Verbrauchs- und Kostenstatistiken erstellen sowie beliebige weitere Abhängigkeiten bilden. Durch die Funkdatenübertragung sowie den Batteriebetrieb (1 bis 2 Jahre Betriebsdauer verspricht der Hersteller mit einem Satz) ist die Installation denkbar einfach und erfordert lediglich beim Anbringen der Leseeinheit Genauigkeit.

Im Februar 2015 hat die Auslieferung der Geräte als (einfacher) Bausatz begonnen, zu dem es
* einen Ferraris-Sensor (für Stromzähler mit den markanten Laufscheiben),
* LED-Sensor (für neue Zähler mit S0-Schnittstelle) sowie
* BK-G4-Gaszähler von Elster-Kromschröder (die an einer Ziffernrolle einen kleinen Magneten haben, der über einen Sensor mit Reedkontakt erfasst wird)
gibt. Es ist laut Hersteller [http://www.elv.de/homematic-zaehlersensor-strom-gas-bausatz.html ELV] nur der Bausatz verfügbar. Ein Fertiggerät ist aktuell nicht geplant.

Die Zähler werden mit rückstandslos entfernbaren Klebepads angebracht.

== Parameter ==
'''list: register | range | peer | description'''
0: pairCentral | 0 to 16777215 | | pairing to central
1: mtrConstGas | 0 to 655.36 | | constant gas
1: mtrConstIr | 0 to 65536 | | constant IR
1: mtrConstLed | 0 to 65536 | | constant led
1: mtrSensIr | -99 to 99 | | sensiblity IR
1: mtrType | literal | | type of measurement options:LED,gas,unknown,IR

== Probleme ==
Der HM-ES-TX-WM sendet zyklisch im 3-Minuten Takt die aktuellen Verbrauchsdaten. Dabei ist für das Reading "power" (aktuelle Stromleistung in Watt) zu beachten, dass alle drei Minuten der ''zuletzt bekannte Wert'' gesendet wird. Das heißt im Besonderen:

* Sollten innerhalb der drei Minuten mehrfach Impulse auftreten mit unterschiedlichen Leistungswerten, wird nur der zuletzt bekannte Wert genommen. Es findet keine Aggregation der Impulse (Mittelwert, Summe, …) statt.
* Sollten innerhalb der drei Minuten keinerlei Impulse auftreten, wird dennoch der zuletzt bekannte Leistungswert gesendet, auch wenn er mehrere Minuten/Stunden/Tage alt ist.

Der state des Devices zeigt den letzten Übertragungsstatus an das Device, das Geräte unterstützt keinen Burst. D.h. einen an das Gerät abgesetzten Befehl z.B. getConfig oder einstellen von Zählerkonstanten sollte man möglichst am Geräte bestätigen, sonst könnte es sein, dass ein ACK zu spät zurück kommt und man sich anschließend im state über ein NACK wundert.

Scheinbar gibt es für das reading energy bei 838860.7 einen Zählerüberlauf. [http://forum.fhem.de/index.php/topic,32827.msg270012.html#msg270012]

== Betrieb mit FHEM ==
Der Sensor wird mit einem FHEM im Update-Stand vom (mindestens) 7.2.2015 funktionsfähig eingebunden (getestet in der Variante mit Ferraris-Fühler). Es werden der Fühlertyp und die Fühlerkonstante richtig ausgelesen und im Reading ''energy'' die errechnete Energiemenge ausgegeben (bei Strom: Wattstunden, Wh).

Für die perfekte Konfiguration wird auf die Seite "[[Heizleistung und Gasverbrauch]]" verwiesen, wo eine vollständige Lösung für die Umrechnung von Gasverbrauch in kW/h, Graphen und Hilfsprogramme vorgestellt wird.

=== Readings ===
'''Reading: |Beispiel'''
D-firmware |1.0
D-serialNr |MEQ0025452
battery |ok
boot |off
current |0
eState |E: 6199.9 P: 1713 I: 0 U: 0 f: 50
energy |6199.9
energyOffset |84413.2
frequency |50
power |1713
powerOn |2015-03-26 14:57:48
voltage |0

=== Events Auszug ===
'''Event |Beispielswert'''
battery* |ok
energy |10186.6
power |283
current |0
voltage |0
frequency |50
eState |E: 10186.6 P: 283 I: 0 U: 0 f: 50
boot |off

Ein battery-Event wird nicht zyklisch getriggert. Erst wenn die Batterie tatsächlich leer ist, wird eine entsprechende Meldung vom Gerät selber gesendet und ein battery-Event getriggert (battery: low).

Mit einem Userreading lässt sich die Angabe aus ''energy'' (zum Beispiel für einen Stromzähler (Wh)) in die auf dem Zähler übliche Angabe kWh umrechnen und zugleich mit dem Aufaddieren des Unterschieds beim Start (das Zählermodul beginnt ja mit 0 Wh, während der Zähler meist schon einige Jahre auf der "Rolle" hat) die Angaben gleichziehen:
:<code><nowiki>attr <DeviceName> userReadings kWh {sprintf("%.1f",ReadingsVal("<DeviceName>","energy","???")/1000+72031.5639)}</nowiki></code>

=== Konfiguration ===
Nach dem Erkennen durch [[autocreate]] wird der Zählersensor mit diesen Angaben eingebunden:

define CUL_HM_HM_ES_TX_WM_353594 CUL_HM 353594
attr CUL_HM_HM_ES_TX_WM_353594 IODev CUL_0
attr CUL_HM_HM_ES_TX_WM_353594 actCycle 000:10
attr CUL_HM_HM_ES_TX_WM_353594 actStatus alive
attr CUL_HM_HM_ES_TX_WM_353594 expert 2_full
attr CUL_HM_HM_ES_TX_WM_353594 firmware 1.0
attr CUL_HM_HM_ES_TX_WM_353594 model HM-ES-TX-WM
attr CUL_HM_HM_ES_TX_WM_353594 subType powerSensor

Für den Betrieb mit den verschiedenen Zählern muß eines der Readings '''R-mtrConst'''XXX auf den jeweiligen verwendeten Zähler konfiguriert werden. Z.B. kann ein Ferraris-Stromzähler 100, 150 oder 200 Umdrehungen je kWh benötigen. Dies geschieht z.B. für 150 Meldungen je Einheit für einen Ferraris-Zähler mit dem Befehl
:<code>set CUL_HM_HM_ES_TX_WM_353594 regSet mtrConstIr 150</code>

oder für einen Gaszähler auf der 1. Rolle (d.h. 1 Impuls je 0.1 m^3)
:<code>set CUL_HM_HM_ES_TX_WM_353594 regSet mtrConstGas 0.1</code>

In Fhem bis zum Anfang November 2015 war hier ein kleiner Bug enthalten, der diesen Wert nicht akzeptierte. In diesem Fall läßt sich die Anzahl der Impulse direkt am Gerät über das Display einstellen.

== Logging/Graph. Darstellung ==
[[Datei:PlotStromverbrauchProStunde.png|mini|400px|rechts|Beispiel der graph. Darstellung]]
Der Zähler wird fortlaufend aufaddiert. Mit der delta-Funktion von SVG-Plot können die Verbräuche sehr gut visualisiert werden.
Beispiel Stromzähler:

set terminal png transparent size <SIZE> crop
set output '<OUT>.png'
set xdata time
set timefmt "%Y-%m-%d_%H:%M:%S"
set xlabel " "
set title 'Stündlicher Stromverbrauch | aktuell: $data{currval1} ($data{min1} / $data{avg1} / $data{max1}) kWh'
set ytics
set y2tics
set grid ytics
set ylabel "kWh/h"
set y2label "kWh/h"
#FileLog 4:CUL_HM_HM_ES_TX_WM_353594.kWh\x3a:0:delta-h
plot "<IN>" using 1:2 axes x1y2 title 'Line 1' ls l0 lw 2 with bars

== Wiki ToDo ==
Seit dem FHEM Update vom 06.03.2016 werden bei Neueinrichtung mit Autocreate 2 Kanäle angelegt. Dies entspricht der Firmware Revision 1.1:
* _IEC_01
Im Gas-Modus werden hier die Werte geliefert.
Im IR-Modus kommen seit R12555 vom 12.11.2016 hier die Werte an.
state enthält dabei den Wert des readings energy. Möchte man hier z.B. die im letzten Zeitfenster gemessene Leistung anzeigen lassen, reading power, so hilft das Attribut stateformat
<code>{sprintf("P: %.1f W", ReadingsVal($name,"power",0))}</code>

* _IEC_02

== Firmwareupdate ==
Das Gerät lässt sich in den Updatemodus versetzen, im dem die Batterien zunächst entfernt, dann beim Einsetzen die Anlerntaste gedrückt bleibt. die Leuchtdiode blinkt dann rot im schnellen Takt. Das FHEM-Kommando zum Senden der Firmware per <code>set <devicename> fwUpdate <Firmwaredatei.eq3></code> muss vor dem Einlegen der Batterie (+ ">" Taste) aufgegeben werden. Erfolgt zum Zeitpunkt des Anstartens im Updatemodus keine Sendung der Firmware wird der Zählersensor normal gebootet. Die Meldung <code> <devicename> fwUpdate: fail:notInBootLoader</code> im Filelog erscheint, wenn das FHEM fwUpdate Kommando ''zu spät'' gesendet wurde.

Der Update dauert etwa eine Minute. Während des Updates blinkt die Diode rot in kurzen Intervallen.
Nach erfolgreichen Update muss der Sensor auf die Werkseinstellungen zurückgesetzt (">" Taste 4 Sekunden drücken (Display zeigt reS), kurz warten, ">" noch mal 4 Sekunden drücken - Zählersensor rebootet), aus der FHEM Konfiguration entfernt und neu angelernt werden.

Wenn der Reset nicht durchgeführt wird, kommt vom Sensor immer die Fehlermeldung: einmal langes und drei mal kurzes rotes Blinken (Sitz des Auslesekopfes prüfen). Diese Meldung ist in diesem Zusammenhang ziemlich irreführend.

Dieser Vorgang ist im changelog.txt file der Firmware unvollständig beschrieben, da hier ein Update an der CCU vorausgesetzt wird und die CCU die Firmware wohl automatisch sendet.

== Links ==
* Handbuch [http://files.elv.de/Assets/Produkte/14/1401/140143/Downloads/140143_sensor_um.pdf]
* Produktseite ELV: [http://www.elv.de/homematic-zaehlersensor-strom-gas-bausatz.html]
* Forum [http://forum.fhem.de/index.php/topic,32827.msg252161.html#msg252161]
* Forum [http://forum.fhem.de/index.php/topic,30936.msg234877.html#msg234877]

[[Kategorie:HomeMatic Components]]
[[Kategorie:Energieverbrauchsmessung]]
[[Kategorie:Energieerzeugungsmessung]]

HM-ES-TX-WM Zählersensor für Strom- und Gaszähler

2016-11-21T18:38:15Z

Cwagner: Korrektur Zuordnung Channel 1 und 2 nach neuestem Update vom 10.11.2016

{{Infobox Hardware
|Bild=HM-EM-TX-WM.jpg
|Bildbeschreibung=HomeMatic Zählersensor
|HWProtocol=HomeMatic
|HWType=Powersensor
|HWCategory=HomeMatic
|HWComm=868 MHz
|HWChannels=1
|HWVoltage=6 V
|HWPowerConsumption=30 mA
|HWPoweredBy=4 Batterien LR6/AA/Mignon
|HWSize=68x105x30mm
|HWDeviceFHEM=[http://fhem.de/commandref.html#CUL_HM CUL_HM]
|HWManufacturer=ELV / eQ-3
}}

== Features ==
Der Zählersensor ist ein Datenerfassungssystem, das den Energieverbräuche (Strom, Gas) direkt am Zähler erfasst und in FHEM als laufender Saldo und als Momentanwerte verfügbar macht.

'''Technische Daten:'''

Gewicht: 195 g (inkl. 4 LR6/Mignon/AA-Batterien)

== Anwendungsszenarien ==
Mit den erfassten und gesammelten Daten lassen sich Aktionen beim Erreichen bestimmter Schwellwerte auslösen, Verbrauchs- und Kostenstatistiken erstellen sowie beliebige weitere Abhängigkeiten bilden. Durch die Funkdatenübertragung sowie den Batteriebetrieb (1 bis 2 Jahre Betriebsdauer verspricht der Hersteller mit einem Satz) ist die Installation denkbar einfach und erfordert lediglich beim Anbringen der Leseeinheit Genauigkeit.

Im Februar 2015 hat die Auslieferung der Geräte als (einfacher) Bausatz begonnen, zu dem es
* einen Ferraris-Sensor (für Stromzähler mit den markanten Laufscheiben),
* LED-Sensor (für neue Zähler mit S0-Schnittstelle) sowie
* BK-G4-Gaszähler von Elster-Kromschröder (die an einer Ziffernrolle einen kleinen Magneten haben, der über einen Sensor mit Reedkontakt erfasst wird)
gibt. Es ist laut Hersteller [http://www.elv.de/homematic-zaehlersensor-strom-gas-bausatz.html ELV] nur der Bausatz verfügbar. Ein Fertiggerät ist aktuell nicht geplant.

Die Zähler werden mit rückstandslos entfernbaren Klebepads angebracht.

== Parameter ==
'''list: register | range | peer | description'''
0: pairCentral | 0 to 16777215 | | pairing to central
1: mtrConstGas | 0 to 655.36 | | constant gas
1: mtrConstIr | 0 to 65536 | | constant IR
1: mtrConstLed | 0 to 65536 | | constant led
1: mtrSensIr | -99 to 99 | | sensiblity IR
1: mtrType | literal | | type of measurement options:LED,gas,unknown,IR

== Probleme ==
Der HM-ES-TX-WM sendet zyklisch im 3-Minuten Takt die aktuellen Verbrauchsdaten. Dabei ist für das Reading "power" (aktuelle Stromleistung in Watt) zu beachten, dass alle drei Minuten der ''zuletzt bekannte Wert'' gesendet wird. Das heißt im Besonderen:

* Sollten innerhalb der drei Minuten mehrfach Impulse auftreten mit unterschiedlichen Leistungswerten, wird nur der zuletzt bekannte Wert genommen. Es findet keine Aggregation der Impulse (Mittelwert, Summe, …) statt.
* Sollten innerhalb der drei Minuten keinerlei Impulse auftreten, wird dennoch der zuletzt bekannte Leistungswert gesendet, auch wenn er mehrere Minuten/Stunden/Tage alt ist.

Der state des Devices zeigt den letzten Übertragungsstatus an das Device, das Geräte unterstützt keinen Burst. D.h. einen an das Gerät abgesetzten Befehl z.B. getConfig oder einstellen von Zählerkonstanten sollte man möglichst am Geräte bestätigen, sonst könnte es sein, dass ein ACK zu spät zurück kommt und man sich anschließend im state über ein NACK wundert.

Scheinbar gibt es für das reading energy bei 838860.7 einen Zählerüberlauf. [http://forum.fhem.de/index.php/topic,32827.msg270012.html#msg270012]

== Betrieb mit FHEM ==
Der Sensor wird mit einem FHEM im Update-Stand vom (mindestens) 7.2.2015 funktionsfähig eingebunden (getestet in der Variante mit Ferraris-Fühler). Es werden der Fühlertyp und die Fühlerkonstante richtig ausgelesen und im Reading ''energy'' die errechnete Energiemenge ausgegeben (bei Strom: Wattstunden, Wh).

Für die perfekte Konfiguration wird auf die Seite "[[Heizleistung und Gasverbrauch]]" verwiesen, wo eine vollständige Lösung für die Umrechnung von Gasverbrauch in kW/h, Graphen und Hilfsprogramme vorgestellt wird.

=== Readings ===
'''Reading: |Beispiel'''
D-firmware |1.0
D-serialNr |MEQ0025452
battery |ok
boot |off
current |0
eState |E: 6199.9 P: 1713 I: 0 U: 0 f: 50
energy |6199.9
energyOffset |84413.2
frequency |50
power |1713
powerOn |2015-03-26 14:57:48
voltage |0

=== Events Auszug ===
'''Event |Beispielswert'''
battery* |ok
energy |10186.6
power |283
current |0
voltage |0
frequency |50
eState |E: 10186.6 P: 283 I: 0 U: 0 f: 50
boot |off

Ein battery-Event wird nicht zyklisch getriggert. Erst wenn die Batterie tatsächlich leer ist, wird eine entsprechende Meldung vom Gerät selber gesendet und ein battery-Event getriggert (battery: low).

Mit einem Userreading lässt sich die Angabe aus ''energy'' (zum Beispiel für einen Stromzähler (Wh)) in die auf dem Zähler übliche Angabe kWh umrechnen und zugleich mit dem Aufaddieren des Unterschieds beim Start (das Zählermodul beginnt ja mit 0 Wh, während der Zähler meist schon einige Jahre auf der "Rolle" hat) die Angaben gleichziehen:
:<code><nowiki>attr <DeviceName> userReadings kWh {sprintf("%.1f",ReadingsVal("<DeviceName>","energy","???")/1000+72031.5639)}</nowiki></code>

=== Konfiguration ===
Nach dem Erkennen durch [[autocreate]] wird der Zählersensor mit diesen Angaben eingebunden:

define CUL_HM_HM_ES_TX_WM_353594 CUL_HM 353594
attr CUL_HM_HM_ES_TX_WM_353594 IODev CUL_0
attr CUL_HM_HM_ES_TX_WM_353594 actCycle 000:10
attr CUL_HM_HM_ES_TX_WM_353594 actStatus alive
attr CUL_HM_HM_ES_TX_WM_353594 expert 2_full
attr CUL_HM_HM_ES_TX_WM_353594 firmware 1.0
attr CUL_HM_HM_ES_TX_WM_353594 model HM-ES-TX-WM
attr CUL_HM_HM_ES_TX_WM_353594 subType powerSensor

Für den Betrieb mit den verschiedenen Zählern muß eines der Readings '''R-mtrConst'''XXX auf den jeweiligen verwendeten Zähler konfiguriert werden. Z.B. kann ein Ferraris-Stromzähler 100, 150 oder 200 Umdrehungen je kWh benötigen. Dies geschieht z.B. für 150 Meldungen je Einheit für einen Ferraris-Zähler mit dem Befehl
:<code>set CUL_HM_HM_ES_TX_WM_353594 regSet mtrConstIr 150</code>

oder für einen Gaszähler auf der 1. Rolle (d.h. 1 Impuls je 0.1 m^3)
:<code>set CUL_HM_HM_ES_TX_WM_353594 regSet mtrConstGas 0.1</code>

In Fhem bis zum Anfang November 2015 war hier ein kleiner Bug enthalten, der diesen Wert nicht akzeptierte. In diesem Fall läßt sich die Anzahl der Impulse direkt am Gerät über das Display einstellen.

== Logging/Graph. Darstellung ==
[[Datei:PlotStromverbrauchProStunde.png|mini|400px|rechts|Beispiel der graph. Darstellung]]
Der Zähler wird fortlaufend aufaddiert. Mit der delta-Funktion von SVG-Plot können die Verbräuche sehr gut visualisiert werden.
Beispiel Stromzähler:

set terminal png transparent size <SIZE> crop
set output '<OUT>.png'
set xdata time
set timefmt "%Y-%m-%d_%H:%M:%S"
set xlabel " "
set title 'Stündlicher Stromverbrauch | aktuell: $data{currval1} ($data{min1} / $data{avg1} / $data{max1}) kWh'
set ytics
set y2tics
set grid ytics
set ylabel "kWh/h"
set y2label "kWh/h"
#FileLog 4:CUL_HM_HM_ES_TX_WM_353594.kWh\x3a:0:delta-h
plot "<IN>" using 1:2 axes x1y2 title 'Line 1' ls l0 lw 2 with bars

== Wiki ToDo ==
Seit dem FHEM Update vom 06.03.2016 werden bei Neueinrichtung mit Autocreate 2 Kanäle angelegt. Dies entspricht der Firmware Revision 1.1:
* _IEC_01
Im Gas-Modus werden hier die Werte geliefert.
Im IR-Modus kommen hier die Werte an.
state enthält dabei den Wert des readings energy. Möchte man hier z.B. die im letzten Zeitfenster gemessene Leistung anzeigen lassen, reading power, so hilft das Attribut stateformat
<code>{sprintf("P: %.1f W", ReadingsVal($name,"power",0))}</code>

* _IEC_02

== Firmwareupdate ==
Das Gerät lässt sich in den Updatemodus versetzen, im dem die Batterien zunächst entfernt, dann beim Einsetzen die Anlerntaste gedrückt bleibt. die Leuchtdiode blinkt dann rot im schnellen Takt. Das FHEM-Kommando zum Senden der Firmware per <code>set <devicename> fwUpdate <Firmwaredatei.eq3></code> muss vor dem Einlegen der Batterie (+ ">" Taste) aufgegeben werden. Erfolgt zum Zeitpunkt des Anstartens im Updatemodus keine Sendung der Firmware wird der Zählersensor normal gebootet. Die Meldung <code> <devicename> fwUpdate: fail:notInBootLoader</code> im Filelog erscheint, wenn das FHEM fwUpdate Kommando ''zu spät'' gesendet wurde.

Der Update dauert etwa eine Minute. Während des Updates blinkt die Diode rot in kurzen Intervallen.
Nach erfolgreichen Update muss der Sensor auf die Werkseinstellungen zurückgesetzt (">" Taste 4 Sekunden drücken (Display zeigt reS), kurz warten, ">" noch mal 4 Sekunden drücken - Zählersensor rebootet), aus der FHEM Konfiguration entfernt und neu angelernt werden.

Wenn der Reset nicht durchgeführt wird, kommt vom Sensor immer die Fehlermeldung: einmal langes und drei mal kurzes rotes Blinken (Sitz des Auslesekopfes prüfen). Diese Meldung ist in diesem Zusammenhang ziemlich irreführend.

Dieser Vorgang ist im changelog.txt file der Firmware unvollständig beschrieben, da hier ein Update an der CCU vorausgesetzt wird und die CCU die Firmware wohl automatisch sendet.

== Links ==
* Handbuch [http://files.elv.de/Assets/Produkte/14/1401/140143/Downloads/140143_sensor_um.pdf]
* Produktseite ELV: [http://www.elv.de/homematic-zaehlersensor-strom-gas-bausatz.html]
* Forum [http://forum.fhem.de/index.php/topic,32827.msg252161.html#msg252161]
* Forum [http://forum.fhem.de/index.php/topic,30936.msg234877.html#msg234877]

[[Kategorie:HomeMatic Components]]
[[Kategorie:Energieverbrauchsmessung]]
[[Kategorie:Energieerzeugungsmessung]]

Micropelt iTRV Kleinstellantrieb

2016-11-20T20:59:29Z

Cwagner: Präzisierung Funkqualität

Micropelt iTRV Kleinstellantrieb

2016-11-13T09:05:14Z

Cwagner:

ReadingsGroup

2016-10-30T11:28:14Z

Cwagner: Korrektur bei rgTimer (im zweiten attr war noch hieß es noch rgTimer_wasser)

{{SEITENTITEL:readingsGroup}}
{{Infobox Modul
|ModPurpose=Einfache zusammenfassende Darstellung von Informationen über mehrere Geräte und deren Steuerung
|ModType=h
|ModCmdRef=readingsGroup
|ModForumArea=Frontends
|ModTechName=33_readingsGroup.pm
|ModOwner=Andre ({{Link2FU|430|Forum}} / [[Benutzer Diskussion:justme|Wiki]])}}

Das Fhem-[[:Kategorie:Hilfsmodul|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 [http://fhem.de/commandref.html#readingsGroup commandref].

== Attribute ==
{{Randnotiz|RNText=In 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 ===
[[Datei:ReadingsGroup_noheading.png|mini|rechts|400px|ReadingsGroup: rechts mit "noheading" Attribut, links der anklickbare Titel]]
Das Attribut <code>noheading</code> 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
* <code>list TYPE=readingsGroup</code>
* einen "Probably associated with"-Link eines anderen Objekts oder über
* manuelle Modifikation der URL eines anderen Objekts (<code>http:.../fhem?detail=<objektname></code>)
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 [[PGM2|Web Interface]] im Befehls-Eingabefeld, nach Klick auf DEF und im Attribut-Eingabefeld eingegeben werden. Beim manuellen Einfügen in eine [[Konfiguration|Konfigurationsdatei]] sind diese Maskierungen oder Verdoppelungen natürlich vorzunehmen.

=== Einfache Auswahl über Reading-Namen ===
{| class="wikitable"
! Definition !! Erläuterungen !! Aussehen
|-
| style="width:40%" |<code>define battStatus readingsGroup .*:[Bb]attery</code>
| Alle readings mit Namen '''Battery''' oder '''battery''' von allen Devices.
| rowspan=3 | [[Datei:rgBattery.png|thumb]]
|-
| <code>attr battStatus alias FHT Batteriestatus </code>
| Der Alias wird als Zeilentitel verwendet
|-
| <code>attr battStatus mapping %ROOM </code>
| ''Mapping %ROOM'' führt dazu, dass der Raumname als Zeilentitel angezeigt wird.
|}

=== Übersicht HomeMatic Geräte ===

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

=== Auswahl über Reading-Namen, Status als Symbol dargestellt ===
{| class="wikitable"
! Definition !! Erläuterungen !! Aussehen
|-
| style="width:40%" |<code>define rg_battery readingsGroup .*:battery</code>
| Alle readings mit Namen '''battery''' von allen Devices.
| rowspan=4 | [[Datei:rgBattery2.png|thumb]]
|-
| <code>attr rg_battery alias Batteriestatus </code>
| Der Alias wird als Überschrift verwendet
|-
| <code>attr rg_battery valueIcon {'battery.ok' => 'batterie', 'battery.low' => 'batterie@red'}</code>
| Statt der reading Werte "ok" und "low" soll ein Icon angezeigt werden.
|-
|<code>attr rg_battery commands { "battery.low" => "set %DEVICE replaceBatteryForSec 60" }</code>
| Für LaCrosse devices kann man beim Klick auf ein rotes "battery low icon" direkt replaceBatteryForSec setzen.
|}

=== Reading-Werte zuordnen (Icon / Text) ===
{| class="wikitable"
! Definition !! Erläuterungen !! Aussehen
|-
| style="width:40%" |<code>define rg readingsGroup Contact.Dachboden_gross:sensed.*</code>
| Alle sensedreadings des Contact.Dachboden_gross device.
| rowspan=4 | [[Datei:rgFenster.png|thumb]]
|-
| <code>attr rg mapping { 'sensed.A' => 'links', 'sensed.B' => 'rechts' }</code>
| Die Zuordnung rechts/links
|-
| <code>attr rg valueFormat {($VALUE eq '1')?"fts_window_roof":"fts_window_roof_open_2"}</code>
| Die Zuordnung von reading Wert zu Icon Namen.
|-
| <code>attr rg_battery valueIcon %VALUE </code>
| Statt des reading Werts soll ein Icon angezeigt werden.
|}

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

=== Ausgabestil (hier rechtsbündig) ===
{| class="wikitable"
! Definition !! Erläuterungen !! Aussehen
|-
| style="width:40%" |<code>define Wetter readingsGroup WetterXXX:<%temp_temperature>,<Temperatur>,temperature WetterXXX:<%weather_humidity>,<Luftfeuchte>,humidity WetterXXX:<%weather_barometric_pressure>,<Luftdruck>,pressure
</code>
| Die readings mit Namen '''temperature''', '''humidity''' und '''pressure''' vom Device WetterXXX jeweils mit einem Icon und einem Label davor.
| rowspan=3 | [[Datei:rgWetter.png|thumb]]
|-
| <code>attr Wetter valueFormat { temperature => '%1.f &deg;C', humidity => '%1.f %%', pressure => '%i mbar' }</code>
| Die Formatierung der Readingswerte
|-
| <code>attr Wetter valueStyle style="text-align:right"</code>
| 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).
{| class="wikitable"
! Definition !! Erläuterungen !! Aussehen
|-
| style="width:40%" |<code>define culRSSI readingsGroup cul_RSSI=.*:+cul_RSSI</code>
| 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.
| rowspan=1 | [[Datei:rgculRSSI.png|thumb]]
|}

=== Internal Values ausgeben ===
{| class="wikitable"
! Definition !! Erläuterungen !! Aussehen
|-
| style="width:40%" |<code>define culRSSI readingsGroup cul_RSSI=.*:+cul_RSSI,+cul_TIME</code>
| 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.
| rowspan=2 | [[Datei:rgculRSSI2.png|thumb]]
|-
|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... ===
{| class="wikitable"
! Definition !! Erläuterungen !! Aussehen
|-
| style="width:40%" |<code>define Systemstatus readingsGroup sysstat</code>
| Alle readings des sysstat Device
| rowspan=4 | [[Datei:rgSysstat.png|thumb]]
|-
| <code>attr Systemstatus nostate 1</code>
| Ohne state
|-
| <code>attr Systemstatus notime 1</code>
| Ohne readings timestamp
|-
| <code>attr Systemstatus mapping {'load' => 'Systemauslastung', 'temperature' => 'Systemtemperatur in &deg;C'}</code>
| Die Zuordnung der reading Namen zu den Zeilentiteln
|}

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

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

{| class="wikitable"
! Definition !! Erläuterungen !! Aussehen
|-
| style="width:40%" |<code>define lcDropDown readingsGroup meineLightScene:!state</code>
| Für die LightScene ''meineLightScene'' soll ein DropDown-Menü zur Auswahl der Szene erstellt werden.
| rowspan=6 |
|-
| <code>attr lcDropDown commands { state => 'scene:' }</code>
| Die Anzeige des state Readings wird auf das DropDown-Menü für das scene Kommando gemapped.
|-
| <code>attr lcDropDown nonames 1</code>
| Keine Readingnamen
|-
| <code>attr lcDropDown notime 1</code>
| Kein Timestamp
|}

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

=== Wertabhängige Farbgebung ===
{| class="wikitable"
! Definition !! Erläuterungen
|-
| colspan=2 | [[Datei:TemperaturenRG.png|600px|mini|links|Wertabhängige Farben]]
[[Datei:TemperaturenRG2.png|600px|mini|links|Andere Werte - andere Farben]]
|-
| style="width:40%" |<code>define wzTemperaturenRG readingsGroup Aussen:,<Temperatur>,temperature,<Luftfeuchte>,humidity Wohnzimmer:,<Temperatur>,temperature,<Luftfeuchte>,humidity Kasten_E_Geraete:,<Temperatur>,temperature,<Luftfeuchte>,humidity</code>
| Die readings temperatur und humidity der Devices Aussen, Wohnzimmer und Kasten_E_Geraete in einer Zeile pro Device.
|-
| <code>attr wzTemperaturenRG group 3. Temperaturen</code>
| Die readingsGroup kommt in eine Gruppe
|-
| <code>attr wzTemperaturenRG noheading 1</code>
| noheading
|-
| <code>attr wzTemperaturenRG nostate 1</code>
| nostate
|-
| <code>attr wzTemperaturenRG notime 1</code>
| notime
|-
| <code>attr wzTemperaturenRG valueFormat {temperature => "%.1f °C", humidity =>"%.1f %%" }</code>
| Die Formatierung für die temperatur und humidity readings: eine Nachkommastelle plus Einheit.
|-
|<code>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"'} }</code>
| Diverse Farbkombinationen sind möglich
|}

=== Enigma Receiver ===
{| class="wikitable"
! Definition !! Erläuterungen
|-
| colspan=2 | [[Datei:ReceiverRG.jpg|600px|mini|links|Wertabhängige Farben]]
[[Datei:ReceiverRGmute.jpg|600px|mini|links|Wertabhängige Farben]]
|-
| style="width:40%" |<code>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</code>
| 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]]
|-
| <code>attr wzReceiverRG group Fernseher Receiver</code>
| Die readingsGroup kommt in eine Gruppe
|-
| <code>attr wzReceiverRG mapping &nbsp;</code>
| mapping wird auf &nbsp; (Leerzeichen) gesetzt, damit der Device Name nicht angezeigt wird
|-
| <code>attr wzReceiverRG noheading 1</code>
| noheading
|-
| <code>attr wzReceiverRG nostate 1</code>
| nostate
|-
| <code>attr wzReceiverRG notime 1</code>
| notime
|-
|-
| <code>attr wzReceiverRG valueColumns { eventdescription => 'colspan="4"' }</code>
| Die Beschreibung soll über 4 Spalten gehen
|-
| <code>attr wzReceiverRG valueFormat { wzReceiverRGvalueFormat($DEVICE,$READING,$VALUE);; }</code>
| Die Formatierung wird in die 99_myUtils.pm ausgelagert. Siehe: [[99 myUtils anlegen]]
|-
|<code>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"' } }</code>
| Diverse Farbkombinationen sind möglich. Wenn der Receiver auf mute ist, wird anstatt der Lautstärke mute angezeigt.
|-
|<source lang="perl">
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 %%";
}
}
}</source>
| Dieser Teil kommt in die [[99_myUtils_anlegen|99_myUtils.pm]]
|}

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

=== Heizungswerte inklusive Ventilposition ===
{| class="wikitable"
! Definition !! Erläuterungen
|-
| colspan=2 | [[Datei:Rg_Heizung_Valveposition.png|thumb|links|500px|Heizungswerte inklusive Statusinformationen (MAX!)]]
|-
| style="width:40%" |<code>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</code>
| Diverse readings aller Devices des Typs MAX.
|-
| <code>attr Heizungswerte mapping %ROOM</code>
| Die Raumnamen werden angezeigt.
|-
| <code>attr Heizungswerte nameStyle style="color:yellow;font-weight:bold"</code>
| Die Überschriften sollen gelb (fett) sein.
|-
| <code>attr Heizungswerte room Heizung</code>
| Die "readingsgroup" wird dem Raum "Heizung" zugeordnet.
|-
| <code>attr Heizungswerte valueFormat {'temperature' => "%.0f °C", 'desiredTemperature' => "%.0f °C", 'valveposition' =>"%.0f %%", 'maxValveSetting' =>"%.0f %%" }</code>
| Es wird noch die Einheit °C hinter den Temperaturwerten angezeigt.
|-
| <code>attr Heizungswerte valueIcon {'battery.ok' => 'batterie@lightgreen', 'battery.low' => 'batterie@red'}</code>
| Für den Batteriezustand werden Icons anstatt Klartextwerte genommen!
|-
| <code>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"' } }</code>
| Die Temperaturwerte werden abhängig vom Wert farbig dargestellt.
|-
| <code>attr Heizungswerte valueIcon {'battery.ok' => 'batterie@lightgreen', 'battery.low' => 'batterie@red', 'window.closed' => 'fts_window_1w@lightgreen', 'window.open' => 'fts_window_1w_open@red'}</code>
| Für den Batteriestand und den Zustand der Fenster sollen jeweils Icons angezeigt werden.
|}

=== Heizungswerte, Status und Regelmöglichkeit ===
{| class="wikitable"
! Definition !! Erläuterungen
|-
| colspan=2 | [[Datei:rgHeizung2.png|thumb|500px|links|Anzeige + Regelmöglichkeit]]
|-
| style="width:40%" |<code>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</code>
| Diverse readings aller Devices des Typs FHT.
|-
| <code>attr Heizungswerte2 nameStyle style="color:yellow;font-weight:bold"</code>
| Die Überschriften sollen gelb sein.
|-
| <code>attr Heizungswerte2 valueIcon {'battery.ok' => 'batterie@lightgreen', 'battery.low' => 'batterie@red', 'window.closed' => 'fts_window_1w@lightgreen', 'window.open' => 'fts_window_1w_open@red'}</code>
| Für den Batteriestand und den Zustand der Fenster sollen jeweils Icons angezeigt werden.
|-
| <code>attr Heizungswerte2 valueStyle {($VALUE eq "00")?'style="visibility:hidden"':''}</code>
| Nach dem Einstellen den Wert wieder ausblenden.
|-
| <source lang="perl">
#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;
}</source>
| Dieser Teil kommt in die [[99_myUtils_anlegen|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: umstellen auf readingList oder setreading, label als readings in die readingsGroup selber stecken statt in einen extra dummy. oder !<reading> und mapping verwenden.}}
{| class="wikitable"
! Definition !! Erläuterungen
|-
| colspan=2 | [[Datei:RgThermostate.png|thumb|750px|links|Status, Steuerung und Wochenprofil]]
|-
| style="width:40%" |<pre>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 </pre>
|Erzeugen der Readings im Device [[dummy#d_label|d_label]].
|-
| <code>
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>,<nowiki> </nowiki>,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> </code>
| Diverse readings aller Devices CUL_HM_HM_CC_RT_DN_......_Clima, entsprechender [[Makefine#d_climaControl|d_climaControl]] (müssen vorher angelegt werden) und [[dummy#d_label|d_label]].
|-
| <code>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'}</code>
| Temperaturen werden als DropDown Auswahl dargestellt, Icons triggern [[readingsGroup#sub_rg|ntfy_rg]]
|-
| <code>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' => ''}</code>
| Ausblenden der Texte vor den DropDowns.
|-
| <code>
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=""'}
</code>
| Ausrichten der Überschriften die keine readings sind.
|-
| <code>attr rg_thermostate nonames 1</code>
| Ausblenden der Device Namen.
|-
| <code>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"'}</code>
| Diverse Readings sollen über mehrere Spalten dargestellt werden.
|-
| <code>attr rg_thermostate valueFormat { 'measured-temp' => "%0.1f °C", 'ValvePosition' => "%0.1f %%"}</code>
| Formatierung für measured-temp und ValvePosition.
|-
| <code>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'}</code>
| Zuweisung der Icons.
|-
| <code>
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"'}
</code>
| 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.

{| class="wikitable"
! Definition !! Erläuterungen
|-
| colspan=2 | [[Datei:RgHMTh.jpg|thumb|500px|links|Status, Steuerung und Wochenprofil]]
|-
| <code>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</code>
| ReadingsGoup anlegen.
|-
| <code>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"'}</code>
| Schrift fett setzen etc.
|-
| <code>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"}</code>
| Heizungssteuerung ermöglichen
|-
| <code>
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' => ''} 
</code>
| Gewünschte Namen definieren.
|-
| <code>
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}}}
</code>
| Werte vorformatieren (für die Icon-Zuordnung).
|-
| <code>
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'}
</code>
| Icons zuordnen.
|-
| <code>
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);;"'}}}
</code>
| Farben (zu kalt: blau, zu warm: rot, ok: grün).
|-
| <code>
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)"}
</code>
| 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.
{| class="wikitable"
! Definition !! Erläuterungen
|-
| colspan=2 | [[Datei:rgHeizung4.png|thumb|750px|links|Anzeige + Regelmöglichkeit]]
|-
| style="width:40%" |<code>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 </code>
| Diverse Readings aller Thermostat Devices und des jeweils zugehörigen Ventilantriebs.
|-
| <code>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' => <nowiki>''</nowiki> }</code>
| Die Benennung der Zeilentitel (Das ist je nach Konfiguration auch über $ALIAS und/oder $ROOM lösbar).
|-
| <code>attr myTemp commands { 'desired-temp' => 'desired-temp:' }</code>
| desired-temp soll per dropDown einstellbar sein.
|-
| <code>attr myTemp nameStyle style="color:yellow"</code>
| Die Überschriften sollen gelb sein.
|-
| <code>attr myTemp valueIcon {'battery.ok' => 'batterie@lightgreen', 'battery.low' => 'batterie@red'}</code>
| Für den Batteriestand sollen jeweils Icons angezeigt werden.
|-
| <code>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 %%" }</code>
| Die Formatierung der Werte.
|-
|<source lang="perl">
#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);
}
}</source>
| Dieser Teil kommt in die [[99_myUtils_anlegen|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:<code>...,ValvePosition@{$DEVICE=~s/Thermostat/Ventil/;$DEVICE;},...</code>

=== Inhalte filtern ===
Wenn man gewisse Zeilen einer Readingsgroup nicht dargestellt haben möchte, so kann man diese mit Hilfe von <code>valueFormat</code> ausfiltern, bspw.:

<code>attr rg valueFormat { return $VALUE if ( $VALUE > 0 );; return undef;; }</code>

In diesem Bsp. werden alle Zeilen/Devices, deren Value > 0 sind, angezeigt. Alle anderen werden als <code>undef</code> formatiert und erscheinen damit nicht im Listing.

Dies kann man noch weiter ausbauen und dynamische Auswahllisten erstellen (s. [[ReadingsGroup#Dynamische Inhalte]]).

=== Dynamische Inhalte ===
[[Datei:rgDynamic-1.png|mini|450px|readingsGroup mit umschaltbarem Inhalt 1]]
[[Datei:rgDynamic-2.png|mini|450px|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.

<pre>
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")}
</pre>

=== 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 [http://forum.fhem.de/index.php/topic,23655.msg169141.html#msg169141 diesen Forumsbeitrag]) für alle Objekte, die das Fhem Attribut ''disable'' unterstützen.
{| class="wikitable"
! Definition !! Erläuterungen
|-
| colspan=2 | [[Datei:rg_scheduling.png|thumb|500px|links|Enable/Disable Button]]
|-
| style="width:40%" |<code>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></code>
| 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 <code>rg_timer_Wasser_show_conditional</code>, 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.
|-
| <code>attr rg_Timer_Wasser valueFormat { if ( $READING =~ m/.*DEF/ ) { my @text = split(" ", $VALUE); shift @text; return join(" ", @text) }}</code>
| Der Name des Timers wird aus dem Internal "+DEF" vorne abgeschnitten. Damit werden nur die definierten Schaltpunkte angezeigt.
|-
| <code>attr rg_Timer_Wasser valueIcon { 'disabled.0' => 'Restart', 'disabled.1' => 'Shutdown' }</code>
| Die beiden Zustände für den Button werden durch zwei Standard-Icons angezeigt.
|-
| <code>attr rg_Timer_Wasser commands { 'disabled.0' => 'set $DEVICE disable', 'disabled.1' => 'set $DEVICE enable' }</code>
| 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").
|-
|<source lang="perl">
sub rg_timer_Wasser_show_conditional($$)
{
my ($DEVICE,$READING) = @_;
return ( ReadingsVal($DEVICE, "disabled", "1") eq "0" )?
ReadingsVal($DEVICE, $READING, "reading_undef") : "disabled";
}</source>
| Dieser Teil kommt in die [[99_myUtils_anlegen|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 ===
{{Randnotiz|RNTyp=y|RNText=Dieses Beispiel benutzt Funktionen, die erst ab [[version|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.

{| class="wikitable"
! Definition !! Erläuterungen
|-
| colspan=2 | [[Datei:rg_timer.png|thumb|500px|links|FhemWidget für das 'disable' Attribut]]
|-
| style="width:40%" |<code>define rgTimer readingsGroup <>,<Current>,<Update-Time>,<New>,<disable> TYPE=WeekdayTimer:state,nextUpdate,nextValue,?!disable</code>
| 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.
|-
| <code>attr rgTimer valueIcon { state => '%devStateIcon', nextValue => '{(split(":",Color::devStateIcon($DEVICE,"dimmer",undef,"nextValue")))[1]}' }</code>
| Für den aktuellen Zustand wird das devStateIcon angezeigt und für den nächsten Zustand das passende Lampen-Icon.
|-
| <code>attr rgTimer valueFormat '{(split(" ", $VALUE))[1]}'</code>
| Vom nächsten Schaltpunkt wird nur die Zeit angezeigt.
|-
| <code>attr rgTimer commands { disable => 'disable:' }</code>
| Für das disable attribut wird das normale dropDown mit 0 und 1 angezeigt das auch in der Device Detail Ansicht verwendet wird.
|}

=== Readings löschen ===
Es kann vorkommen, dass Readings angezeigt werden, die garnicht existieren sollten - bspw. wenn man in einer HTTPMOD ein Reading umbeannt hat, kann auch der alte Readingsname immernoch angezeigt werden. Solche Readings können mit der globalen Funktion [http://fhem.de/commandref.html#deletereading deletereading] gelöscht werden.

'''Achtung:''' Auf jeden Fall die [http://fhem.de/commandref.html#deletereading CommandRef dazu] lesen!

Beispiel:
Im HTTPMOD des [[Pollenflug]] war zuerst das <code>reading04Name Graeser</code> definiert und wurde später in <code>reading04Name Gräser</code> umbenannt. In der zugehörigen ReadingGroup wurden dann konsequent beide Varianten dargestellt - auch nachdem alle Alt-Einträge aus den Logs entfernt wurden. Erst ein <code>deletereading Pollenflug Graeser</code> in der fhem-Befehltszeile hat das veraltete Reading entfernt.

=== Ausrichtung der Tabelle drehen (horizontal/vertikal) ===
Eine Readingsgroup wird standardmäßig immer zeilenweise aufgebaut, zB. jedes Gerät in eine neue Zeile. Die Werte der Geräte werden dann in den Spalten dargestellt.
Wenn man eine Readingsgroup für nur ein Gerät mit vielen Readings hat (zB. [[Allergy]]), so kann man die Darstellung horizontal oder vertikal ausrichten, indem man die Readingsgroup detailliert definiert. Ein Bsp. dazu liefert der Foreneintrag [https://forum.fhem.de/index.php/topic,37194.msg440446.html#msg440446] :

<pre>
define Pollenflugvorhersage allergy <PLZ>
attr Pollenflugvorhersage levelsFormat rc_dot@white,rc_dot@yellow,rc_dot@orange,rc_dot@red
attr Pollenflugvorhersage stateFormat fc1_maximum
attr Pollenflugvorhersage updateEmpty 1
attr Pollenflugvorhersage updateIgnored 1

# Pollen in Spalten, Tage in Zeilen
define PollenAlarmHorizontal readingsGroup <>,<Ampfer>,<Ambrosia>,<Beifuß>,<Birke>,<Buche>,<Eiche>,<Erle>,<Gräser>,<Hasel>,<Pappel>,<Roggen>,<Ulme>,<Wegerich>,<Weide> \
Pollenflugvorhersage:fc1_day_of_week,fc1_Ampfer,fc1_Ambrosia,fc1_Beifuß,fc1_Birke,fc1_Buche,fc1_Eiche,fc1_Erle,fc1_Gräser,fc1_Hasel,fc1_Pappel,fc1_Roggen,fc1_Ulme,fc1_Wegerich,fc1_Weide \
Pollenflugvorhersage:fc2_day_of_week,fc2_Ampfer,fc2_Ambrosia,fc2_Beifuß,fc2_Birke,fc2_Buche,fc2_Eiche,fc2_Erle,fc2_Gräser,fc2_Hasel,fc2_Pappel,fc2_Roggen,fc2_Ulme,fc2_Wegerich,fc2_Weide \
Pollenflugvorhersage:fc3_day_of_week,fc3_Ampfer,fc3_Ambrosia,fc3_Beifuß,fc3_Birke,fc3_Buche,fc3_Eiche,fc3_Erle,fc3_Gräser,fc3_Hasel,fc3_Pappel,fc3_Roggen,fc3_Ulme,fc3_Wegerich,fc3_Weide \
Pollenflugvorhersage:fc4_day_of_week,fc4_Ampfer,fc4_Ambrosia,fc4_Beifuß,fc4_Birke,fc4_Buche,fc4_Eiche,fc4_Erle,fc4_Gräser,fc4_Hasel,fc4_Pappel,fc4_Roggen,fc4_Ulme,fc4_Wegerich,fc4_Weide \
Pollenflugvorhersage:fc5_day_of_week,fc5_Ampfer,fc5_Ambrosia,fc5_Beifuß,fc5_Birke,fc5_Buche,fc5_Eiche,fc5_Erle,fc5_Gräser,fc5_Hasel,fc5_Pappel,fc5_Roggen,fc5_Ulme,fc5_Wegerich,fc5_Weide \
Pollenflugvorhersage:fc6_day_of_week,fc6_Ampfer,fc6_Ambrosia,fc6_Beifuß,fc6_Birke,fc6_Buche,fc6_Eiche,fc6_Erle,fc6_Gräser,fc6_Hasel,fc6_Pappel,fc6_Roggen,fc6_Ulme,fc6_Wegerich,fc6_Weide \
Pollenflugvorhersage:fc7_day_of_week,fc7_Ampfer,fc7_Ambrosia,fc7_Beifuß,fc7_Birke,fc7_Buche,fc7_Eiche,fc7_Erle,fc7_Gräser,fc7_Hasel,fc7_Pappel,fc7_Roggen,fc7_Ulme,fc7_Wegerich,fc7_Weide
attr PollenAlarm nonames 1
attr PollenAlarm valueFormat %VALUE
attr PollenAlarm valueIcon %VALUE

# Tage in Spalten, Pollen in Zeilen
define PollenAlarmVertikal readingsGroup Pollenflugvorhersage:<Pollen>,fc0_day_of_week,fc1_day_of_week,fc2_day_of_week,fc3_day_of_week,fc4_day_of_week,fc5_day_of_week,fc6_day_of_week,fc7_day_of_week \
Pollenflugvorhersage:<Ambrosia>,fc0_Ambrosia,fc1_Ambrosia,fc2_Ambrosia,fc3_Ambrosia,fc4_Ambrosia,fc5_Ambrosia,fc6_Ambrosia,fc7_Ambrosia\
Pollenflugvorhersage:<Ampfer>,fc0_Ampfer,fc1_Ampfer,fc2_Ampfer,fc3_Ampfer,fc4_Ampfer,fc5_Ampfer,fc6_Ampfer,fc7_Ampfer\
Pollenflugvorhersage:<Beifuß>,fc0_Beifuss,fc1_Beifuss,fc2_Beifuss,fc3_Beifuss,fc4_Beifuss,fc5_Beifuss,fc6_Beifuss,fc7_Beifuss\
Pollenflugvorhersage:<Birke<Birke>,fc0_Birke,fc1_Birke,fc2_Birke,fc3_Birke,fc4_Birke,fc5_Birke,fc6_Birke,fc7_Birke\
Pollenflugvorhersage:<Buche>,fc0_Buche,fc1_Buche,fc2_Buche,fc3_Buche,fc4_Buche,fc5_Buche,fc6_Buche,fc7_Buche\
Pollenflugvorhersage:<Eiche>,fc0_Eiche,fc1_Eiche,fc2_Eiche,fc3_Eiche,fc4_Eiche,fc5_Eiche,fc6_Eiche,fc7_Eiche\
Pollenflugvorhersage:<Erle<Erle>,fc0_Erle,fc1_Erle,fc2_Erle,fc3_Erle,fc4_Erle,fc5_Erle,fc6_Erle,fc7_Erle\
Pollenflugvorhersage:<Gräser>,fc0_Graeser,fc1_Graeser,fc2_Graeser,fc3_Graeser,fc4_Graeser,fc5_Graeser,fc6_Graeser,fc7_Graeser\
Pollenflugvorhersage:<Hasel<Hasel>,fc0_Hasel,fc1_Hasel,fc2_Hasel,fc3_Hasel,fc4_Hasel,fc5_Hasel,fc6_Hasel,fc7_Hasel\
Pollenflugvorhersage:<Pappel>,fc0_Pappel,fc1_Pappel,fc2_Pappel,fc3_Pappel,fc4_Pappel,fc5_Pappel,fc6_Pappel,fc7_Pappel\
Pollenflugvorhersage:<Roggen>,fc0_Roggen,fc1_Roggen,fc2_Roggen,fc3_Roggen,fc4_Roggen,fc5_Roggen,fc6_Roggen,fc7_Roggen\
Pollenflugvorhersage:<Ulme>,fc0_Ulme,fc1_Ulme,fc2_Ulme,fc3_Ulme,fc4_Ulme,fc5_Ulme,fc6_Ulme,fc7_Ulme\
Pollenflugvorhersage:<Wegerich>,fc0_Wegerich,fc1_Wegerich,fc2_Ulme,fc3_Wegerich,fc4_Wegerich,fc5_Wegerich,fc6_Wegerich,fc7_Wegerich\
Pollenflugvorhersage:<Weide>,fc0_Weide,fc1_Weide,fc2_Weide,fc3_Weide,fc4_Weide,fc5_Weide,fc6_Weide,fc7_Weide
</pre>

== Berechnungen ==
{{Randnotiz|RNTyp=y|RNText=Dieses Beispiel benutzt Funktionen, die erst ab [[version|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:
:<code>define rg readingsGroup .*:temperature rg:$avg</code>
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: <code>$<operator>[(<zellen>)]</code> mit
*<code><operator></code>: 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.
*<code><zellen></code> ist eine durch Semikolon getrennte Liste aus <code><zeilen>:<spalten></code> Paaren.
*<code><zeilen></code> und <code><spalten></code> sind jeweils eine Perl Liste, d.h. hier können
** einzelne Werte,
** durch Komma getrennte Aufzählungen,
** mit .. angegebene Wertebereiche
** sowie <code>$ROW</code> und <code>$COLUMN</code> 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:
*<code>$sum</code> equivalent zu <code>$sum(1..$ROW), $sum(:$COLUMN)</code> und <code>$sum(1..$ROW:$COLUMN)</code> die Summe der Werte in der Spalte über der aktuellen Zelle.
*<code>$max($ROW:1..$COLUMN-1)</code> Maximum aller Werte links von der aktuellen Zelle (in der aktuellen Zeile)
*<code>$avg(1..$ROW:1)</code> Durchschnitt aller Werte in Spalte 1 bis zur aktuellen Zeile
*<code>$scalar(:1)</code> Anzahl der Werte in Spalte 1
*<code>$min(1..5:1,2,4)</code> 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 <code>firstCalcRow</code>: 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 <code><nowiki><hr></nowiki></code> um eine horizontale Linie über die volle Breite einzufügen
* Über ein angehängtes <code>@<alias></code> kann einem Rechenergebniss ein Alias-Name gegeben werden. Über diesen kann der Wert dann zur Formatierung mit den value-Attributen angesprochen werden.
* das <code>alwaysTrigger</code> 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 <code>$count(<wert>)(<zellen>)</code> um das Vorkommen von <code><wert></code> in den angegebenen Zellen zu zählen. <code><wert></code> kann enweder direkt der zu zählende Wert sein (ohne Anführungzeichen) oder eine in / eingeschlossene regex. Mit <code>!<wert></code> kann das Nicht-Vorkommen von <code><wert></code> gezählt werden.

=== Ein interaktives Beispiel ===
[[Datei:rgCalc.png|mini|right|400px|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.
 
<pre>
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' }
</pre>

== Links und Trigger ==
=== readingsGroup mit Link ===
[[Datei:rgPCA-detail.png|mini|400px|readingsGroup mit Link]]
Das PCA301 Beispiel oben lässt sich mit einem ans Ende des define angehängten
:<code><{appendTrigger($DEVICE,"clear","Alle löschen")}></code>
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.
:<code>define clearVerbrauch notify Verbrauch:clear set TYPE=PCA301 clear</code>

<source lang="perl">
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);
}</source>

wenn hierdurch Änderungen an einer readingsGroup erfolgen, die ein Neuladen der Seite erforderlich machen, kann dies so erfolgen:
:<code>{myUtils_refresh("WEB")}</code>
mit folgendem code in 99_myUtils.pm:
<source lang="perl">
sub
myUtils_refresh($)
{
my ($name) = @_;

FW_directNotify("#FHEMWEB:$name", "location.reload(true);","" );
}</source>

Ein weiteres Beispiel für 'custom links und trigger' findet sich in {{Link2Forum|Topic=14425|Message=109383|LinkText=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 <code>'trigger ntfy_rg $DEVICE $READING'</code> oder Ähnliches zu mappen.
Anlegen des ntfy_rg notify
<pre>
define ntfy_rg notify ntfy_rg {rg($EVENT)}
</pre>
Folgender Code muss noch in de [[99_myUtils_anlegen|99_myUtils.pm]]
<source lang="perl">
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")};
}
}
</source>
Hier sind die benötigten CodeBlöcke für [[ReadingsGroup#Heizungswerte.2C_Status.2C_Steuerung_und_Wochenprofil|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 anlegen|99_myUtils]] auszulagern und diese aufzurufen:
:<code> attr <name> valueStyle {myValueToFormat($READING,$VALUE)}</code>
* code für unterschiedliche readings kann auch im mapping schon aufgeteilt werden:
:<code>attr <name> valueStyle { SuperE5 => '{perl code}', Diesel => '{perl code}' }</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:
:<code>attr <rgName> style style="border:0px;background:none;box-shadow:none"</code>
Für die readingsGroup ''rgName'' wird der Darstellungsstil verändert.

Anwendungs-Bsp: [[Pollenflug]]

=== Einfache Balkendiagramme ===
[[Datei:rgBars.png|mini|400px|readingsGroup mit Balken]]
Readings lassen sich mit einem valueStyle der folgenden Art mit einem "Füllstandsbalken" hinterlegen:
:<code>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%)"</code>

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

Diese direkte Definition des <code>valueStyle</code> ist allerdings sehr unflexibel - bspw. müsste der <code>$VALUE</code> zufällig max 100 erreichen und es darf nur ein Browsertyp eingesetzt werden, damit alles sauber funktioniert.

Deutlich flexibler ist eine Auslagerung als eigenständige Funktion in die [[99_myUtils_anlegen|99_myUtils.pm]], die den valueStyle dynamisch generiert, bspw.:

<source lang="perl">
sub Balkenanzeige($)
{
# Zuweisung der übergebenen Variablen
my ($val) = @_;

# Konfiguration des maximal übergebenen Werts (hier wäre der höchste zu erwartende Wert = 3)
my $maxValue = 3;

# Normalisierung auf 100%-Wert
my $percent = $val / $maxValue * 100;

# Definition des valueStyles
my $stylestring = 'style="
width: 200px;
text-align:center;
border: 1px solid #ccc;
background-image: -webkit-linear-gradient(left,red '.$percent.'%, rgba(0,0,0,0) '.$percent.'%);
background-image: -moz-linear-gradient(left,red '.$percent.'%, rgba(0,0,0,0) '.$percent.'%);
background-image: -ms-linear-gradient(left,red '.$percent.'%, rgba(0,0,0,0) '.$percent.'%);
background-image: -o-linear-gradient(left,red '.$percent.'%, rgba(0,0,0,0) '.$percent.'%);
background-image: linear-gradient(left,red '.$percent.'%, rgba(0,0,0,0) '.$percent.'%);
"';

# Rückgabe des definierten Strings
return $stylestring;
}
</source>

Der Aufruf sähe dann wie folgt aus:

<code> attr <rgName> valueStyle { Balkenanzeige($VALUE) } </code>

Die einzelnen Werte des <code>$stylestring</code> haben folgende Bedeutungen:
* width - Breite des Balkenrahmens
* text-align - Ausrichtung des Texts
* border - Format des Balkenrahmens
* background-image - Format des Hintergrunds des Balkenrahmens, also des Balkens selbst
** linear-gradient - css-Funktion zur Erstellung von Farbverläufen ''(*)''
*** left - linksbündiger Balken
*** red x% - roter Balken x% breit
*** rgba(0,0,0,0) x% - farbloser Teil startet bei x%

''(*) linear-gradient wird in verschiedenen Browsern unterschiedlich umgesetzt. Deshalb sollten immer alle Varianten zusammen angegeben werden, damit die Darstellung auf allen Browsern funktioniert. (vgl. Link unten)''

Weitere Infos zu:
* linear-gradient - [https://developer.mozilla.org/de/docs/Web/CSS/linear-gradient]
* Farbanpassungen, z.B. auch unter Verwendung der [[Color#Skalenfarbe_mit_Color::pahColor|Color::pahColor]] Routine.
* Anpassung von Werten s.o. [[ReadingsGroup#Lesbar_machen]]
* weiteren Möglichkeiten zur Erzeugung von Balkendiagrammen in Forenbeiträgen {{Link2Forum|Topic=25313|LinkText=hier}} und {{Link2Forum|Topic=28318|LinkText=hier}}
* [[99_myUtils_anlegen|99_myUtils.pm]]

Anwendungs-Bsp: [[Pollenflug]]

=== 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.

{| class="wikitable"
| [[Datei:RgStylingOhneCss.png|600px|mini|left|Device ReadingsGroup ohne CSS]] [[Datei:RgStylingMitCss.png|600px|mini|left|Device ReadingsGroup mit CSS]]
|}

===== Definition =====
<pre>
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' }
</pre>

Damit sich der CSS auf die richtige readingsGroup bezieht, ist es nötigt
das Attribut ''style'' anzupassen.
{| class="wikitable"
! Definition !! Erläuterungen
|-
| style="width:40%" |<code>attr <rgName> style class="block wide rgDevices"</code>
| 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 anlegen|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
<source lang="perl">
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;
}
</source>

{{Randnotiz|RNText=Tipp
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 =====
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:
<pre>
/* 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%; }
</pre>

==== Auf Portrait / Landscape Modus des Smartphone unterscheiden ====
Dieses Beispiel ist an das obige Beispiel [[#Erweiterte_Device_.C3.9Cbersicht|Erweiterte Device Übersicht]] angelehnt.

{| class="wikitable"
| style="width:40%" |[[Datei:RgStylingSmallscreenPortrait.png|300px|mini|center|Device ReadingsGroup im Portrait Modus]]
|[[Datei:RgStylingSmallscreenLandscape.png|550px|mini|center|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
<pre>
/* Portrait Modus */
@media all and (orientation:portrait) { }

/* Landscape Modus */
@media all and (orientation:landscape) { }
</pre>

===== Styling =====
{{Randnotiz|RNText=Info
* ''width: xx%'' ändert die Breite der Spalte
* ''display: none'' blendet die Spalte aus}}
In der FHEMWEB_phone Instanz muss wie [[#Allgemeines|hier]] beschrieben eine neue eigene .css Datei eingetragen werden. In diesem Beispiel ios7smallscreenReadingsGroups.css

ios7smallscreenReadingsGroups.css
<pre>
/* 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%; }
}
</pre>

==== Plots im Portrait Modus des Smartphones ausblenden ====
{| class="wikitable"
| style="width:40%" |[[Datei:RgStylingSmallscreenPortraitPlot.png|350px|mini|center|Device ReadingsGroup im Portrait Modus]]
|[[Datei:RgStylingSmallscreenLandscapePlot.PNG|550px|mini|center|Plot nur im Landscape]]
|}

Um die Plot und alle Steuerelemente im Portrait Modus auszublenden fügt man in seine eigene smallscreen.css wie [[#Allgemeines|hier beschrieben]] folgendes ein:
<pre>
@media all and (orientation:portrait) {
.SVGplot, .SVGlabel, .Zoom-in, .Zoom-out, .Prev { width: 0; display: none; }
}
</pre>

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

Micropelt iTRV Kleinstellantrieb

2016-10-23T10:17:29Z

Cwagner: Ergänzung der Typbezeichnung MVA-002; redaktionelle Nachbesserungen

Micropelt iTRV Kleinstellantrieb

2016-10-23T09:51:39Z

Cwagner: Korrektur Anlernvorgang, Tabelle Readings, Tabelle Attribute, Hinzufügen Tabelle Setter

Micropelt iTRV Kleinstellantrieb

2016-10-21T14:12:04Z

Cwagner:

Micropelt iTRV Kleinstellantrieb

2016-10-21T14:09:51Z

Cwagner: redaktionelle Änderungen, Erweiterung Info um event-on-update

HM-SEC-KEY KeyMatic

2016-09-13T21:12:01Z

Cwagner: Ergänzung zur Anlernprozedur

== Features ==
Das Gerät dient zum motorgesteuerten Betätigen von Zylinderschlössern in Türen.

== Hinweise zum Betrieb mit FHEM ==
Der HM-SEC-KEY Keymatic verwendet ausschließlich die AES authentifizierte Kommunikation und kann mit dem [[HMLAN Konfigurator]] bzw. [[CUL]] gesteuert werden.

Das Pairing sollte wie in [[HomeMatic Devices pairen]] beschrieben durchgeführt werden. An der KeyMatic muss dafür die Anlerntaste (Taste Schloss öffnen) betätigt werden.
{{Hinweis|Falls bereits ein Handsender als Masterfernbedienung 1 angelernt ist (was für autarken Betrieb sehr empfehlenswert ist), muss der Anlernvorgang zwingend durch Tastendruck auf eine Taste dieser Fernbedienung bestätigt werden.
Bestätigung im fhem.log '''3: CUL_HM pair: Haustuer keyMatic, model HM-SEC-KEY serialNr LEQ********'''
}}

Die KeyMatic-Unterstützung existiert derzeit in der aktuellen Entwicklerversion von FHEM

=== Sicherheitshinweis ===
Wenn die KeyMatic an einem aktiven HMLAN Konfigurator angelernt wurde, kann die entsprechende Tür per FHEM ver- / entriegelt bzw. geöffnet werden. Somit sollte das Netzwerk in dem FHEM läuft entsprechend gesichert sein. (Nicht nach Außen geöffnet, kein unsicheres WLAN usw.)

Die Verwendung eines eigenen [[AES Encryption#Aktivieren.2C_Einrichten.2C_Umgang_in_FHEM|AES Sicherheitsschlüssels]] ist dringend anzuraten, da ansonsten eine KeyMatic relativ einfach ferngesteuert werden kann.

=== FHEM Config-Auszug ===
Beispiel für die Konfiguration:

ssssss -> 6-Stellige hexadezimale Seriennummer. (Siehe Logfile: CUL_HM Unknown device CUL_HM_keyMatic_ssssss, please define it)
xxxxxxx -> Seriennummer (vom Aufkleber auf dem Gerät)

define keymatic CUL_HM ssssss
attr keymatic devInfo 010100
attr keymatic firmware 2.4
attr keymatic hmClass receiver
attr keymatic model HM-SEC-KEY-S
attr keymatic room Flur
attr keymatic serialNr JEQxxxxxxx
attr keymatic subType keyMatic
attr keymatic webCmd lock:unlock:open

== Mögliche Zustände ==
KeyMatic hat folgende Schaltzustände:

locked -> Der Riegel des Türschlosses ist an die vorher festgelegte Verschlussstellung gefahren (Tür verschlossen)
unlocked -> Der Riegel des Türschlosses ist "eingefahren" (Tür nicht verschlossen)
uncertain (locked / unlocked) -> Das Schloss wurde am Handrad gedreht. Die Schlossposition ist somit nicht mehr als "zuverlässig erkannt" gemeldet.
== Links ==
Anleitung [http://www.eq-3.de/Downloads/eq3/pdf_produkte/HM-Sec-Key_UM_GE_eQ-3_081218.pdf] PDF

[[Kategorie:HomeMatic Components]]
[[Kategorie:Türschlosssteuerung]]