KNX Device Definition - Beispiele

Aus FHEMWiki
Zur Navigation springen Zur Suche springen

Vorwort

Emblem-question-yellow.svgHinweis: Das EIB-Modul ist seit 2018 deprecated und wird auch nicht mehr gewartet. Es ist daher dringend empfohlen, auf das KNX-Modul umzusteigen! Mit diesen Beispielen sollte auch der Umstieg auf das KNX-Modul etwas leichter fallen!


Hier soll mit eine Austausch von funktionierenden Beispielen aus dem KNX Bereich stattfinden. Es geht um die Definition, die Darstellung im FHEM-Web und um die Weiterverarbeitung mittels notify, doif, usw.

Viele Anfragen im Forum beziehen sich auf Probleme bei der Definition, Darstellung und "Weiterverarbeitung" von KNX-Geräten. Alle User sind eingeladen, mit weiteren Beispielen mitzuwirken. Im ersten Schritt werden einige Beispiele aus der Command-Referenz hierher übertragen, auch um die Command-Ref (in einem zweiten Schritt) etwas kompakter zu gestalten.

Die Command-Referenz ist nach wie vor die aktuellste (und verbindliche) Dokumentation des Moduls. Hier sollen zusätzliche Info's, Tip's & Tricks gegeben werden.

Generelle Hinweise zum KNX Modul sind hier auf der Modulbeschreibungsseite KNX zu finden.

Beispiele

on/off Device - einfach

define Lampe1 KNX 14/0/1:dpt1

Einfachstes KNX-Device ohne Alias und Rückmeldung.

on/off Device - mit Rückmeldung

define Lampe2 KNX 14/1/1:dpt1:EinAus 14/2/1:dpt1:Status:listenonly
attr Lampe2 webCmd EinAus
# attr Lampe2 webCmd :
attr Lampe2 stateFormat Status
attr Lampe2 devStateIcon off:li_wht_off:on on:li_wht_on:off

Hier gibt es 2 GA-Adressen, eine zum Schalten und die 2te für die Rückmeldung vom Aktor (muß natürlich via ETS so programmiert sein!).

Zusätzlich hat jede GA-Adresse nun einen Alias (=gadName), z.B. EinAus, Status. Das Attr "webcmd EinAus" erzeugt ein Pulldown Menü das die jeweilige Funktion ausführt. Falls man kein Pulldown Menü will, nimmt man die 2te Variante von webCmd und klickt auf das DeviceIcon um Ein/Aus zu schalten. DevStateIcon hat den Sinn, damit Icons den Zustand darstellen und beim anklicken die jeweilige Funktion ausführen. Die listenonly Option verhindert, dass ein Set- oder Get-cmd im FHEMWeb dargestellt wird. - Set oder Get sind auf diesen Alias dann nicht möglich!

on/off Device - mit verzögerter Rückmeldung

Es gibt KNX-Aktoren, die erst nach erfolgreicher Ausführung (mit Verzögerung) eine Rückmeldung schicken. Bsp: Großer Drehstrom Motor mit Anlaufstrom-Begrenzung. Nach einem set-cmd (von FHEM) wird vorerst ein hourglass-icon dargestellt, solange bis die Rückmeldung vom KNX-Aktor kommt.

define dpt1_1tst KNX 14/1/1:dpt1:EinAus:set 14/2/1:dpt1:Status:listenonly:nosuffix
attr dpt1_1tst devStateIcon on:general_an:off off:general_aus:on steuern.*:hourglass:off
attr dpt1_1tst stateRegex /EinAus-set/steuern-/ /EinAus-get//

Gleichzeitig ein Beispiel zu stateRegex Verwendung: der 1. Teil muss dem reading[:value] entsprechen, Im konkreten Fall übersetzt das stateRegex "EinAus-set[:value]" nach "steuern-<value> im state-reading, Ein EinAus-get wird ignoriert! Damit kann das state-reading nicht on oder off werden, außer es kommt ein Status von der GA: 14/2/1. Das wird im devStateIcon genutzt, um 3 Zusände darzustellen (on,off,steuern).

Sensor - mit Umrechnung

Ein Windspeed Sensor sendet einen dpt9 Wert in Meter/Sekunde (nach ISO). Nachdem die gebräuchliche Einheit für Windgeschwindigkeiten km/h sind, muss also umgerechent werden. Das kann mittels Userreading passieren, geht aber auch einfacher:

defmod Windspeed KNX 14/0/9:dpt9.005:get:nosuffix
attr Windspeed stateCmd {return sprintf("%.1f",ReadingsNum($name,'g1',0)*3.6);;}
attr Windspeed stateFormat state km/h

Im reading g1 steht die WIndspeed in m/s, im reading state (siehe stateCmd) die Windspeed in km/h - ohne Einheit, im Internal STATE die Windspeed mit Einheit. Will man jedoch auch im reading state die Einheit haben, adaptiert man das stateCmd Attribute z.b. so:

attr Windspeed stateCmd {return sprintf("%.1f km/h",ReadingsNum($name,'g1',0)*3.6);;}

und lässt das Attr. stateFormat weg.

Dimmer

Dimmer.png

Eine Steuerung für KNX-Dimmer. Die Bedienung kann sowohl über on/off, als auch über prozent-Helligkeit und über dimup/dimdown (jeweils 10%) erfolgen. Dazu sind insgesamt vier GA-Adressen definert, die im KNX-Aktor (mittels ETS) konfiguriert sind .

"EinAus" ist die GA für das senden von on/off, "Status" - die Rückmeldung vom Aktor, "Dimmen" ist die GA für das Senden von Helligkeitswerten (Range 0-100%), "Dimmstatus" die Rückmeldung vom Aktor.

Das devStateIcon wird grau bei state=off, gelb bei state=on oder bei state= >0.

Die eventMap-Syntax ist reichlich verwirrend, im Wesentlichen: ein klick auf "dimup" erhöht den Wert von "Dimmen" um 10%, "dimdown" reduziert um 10%.

stateCmd wird bei jedem Event aufgerufen, in diesem Fall: Wenn sich "EinAus" ändert, wird dieser Wert nicht nur in das reading EinAus geschrieben, sondern auch in das reading Dimmen, allerdings übersetzt: on =>100, off=>0. Damit zeigt der Slider jederzeit den richtigen Zustand an. Zusätzlich wird der Wert auch in das Reading state geschrieben. Weiters: ändert sich "Dimmstatus", wird dieser Wert auch in das reading Dimmen geschreiben, damit der Slider auch den richtigen Wert anzeigt (der Dimmer könnte ja auch ausserhalb von FHEM bedient werden...).

webCmd und widgetOverride bestimmen das Aussehen und die Funktion der Overview Zeile.

defmod Dimmer KNX 14/6/1:dpt1:EinAus:set:nosuffix\
14/7/1:dpt1:Status:listenonly:nosuffix\
14/6/5:dpt5.001:Dimmen:set:nosuffix\
14/7/5:dpt5.001:DimmStatus:listenonly:nosuffix

attr Dimmer devStateIcon devStateIcon off:li_wht_off:on on:li_wht_on:off 0.*:li_wht_off:on \d+.*:li_wht_on:off
attr Dimmer eventMap {usr=>{'^dimup'=> '" . sprintf("Dimmen %d",minNum(100,ReadingsNum($NAME,"Dimmen",0) + 10)) . "', \
'^dimdown' => '" . sprintf("Dimmen %d",maxNum(0,ReadingsNum($NAME,"Dimmen",0) - 10)) . "'}, \
fw=>{'^dimup'=> 'dimup', '^dimdown'=> 'dimdown'}  }
attr Dimmer stateCmd { if ($gadName eq 'DimmStatus') {\
    fhem ("sleep 0.05 quiet;;setreading $name Dimmen $state;;");; \
  }\
  elsif ($gadName eq 'EinAus') {\
    my $val = ($state eq 'on')?'100':'0';;\
    fhem ("sleep 0.05 quiet;;setreading $name Dimmen $val;;");;\
  }\
  return $state;;\
}
attr Dimmer webCmd :dimup:dimdown:Dimmen
attr Dimmer widgetOverride Dimmen:slider,0,5,100

Garagentor Steuerung

Dieses Beispiel kann für die (noch immer) üblichen 1-Taster Garagentor-Steuerungen genutzt werden.

Die GA 14/1/100-aufzu ist einem Aktor zugeordnet, der den Garagentor-Taster simuliert.

Die GA 14/1/101-aufzu_status ist die übliche Rückmeldung vom Status des Aktors.

Die GA 14/1/102-Doorstatus ist mit dem Garagensensor (KNX-Input) Tor= zu/offen verknüpft.

defmod Garagentor KNX 14/1/100:dpt1.001:aufzu:set:nosuffix\
14/1/101:dpt1.001:aufzu_status:listenonly:nosuffix\
14/1/102:dpt1.019:Doorstatus:listenonly:nosuffix\

attr Garagentor IODev myKNXIO
attr Garagentor comment set door trigger for 1 second, Status des Tors wird durch GA "Doorstatus" bestimmt.
attr Garagentor devStateIcon closed:fts_garage_door_100@green:on open:fts_garage@red:on
attr Garagentor eventMap {usr=>{'on'=>'aufzu on-for-timer 2','aufzu off'=>'off'} }
attr Garagentor stateRegex /aufzu// /aufzu_status//
attr Garagentor webCmd :
attr Garagentor widgetOverride aufzu:on

Ein Klick auf das DeviceState-Icon bewirkt ein "Set on", das wird mittels eventMap auf "Set aufzu on-for-timer 2" geändert. Der KNX-Aktor schließt den entsprechenden Kontakt für 2 Sekunden, simuliert damt einen Taster. Das Attribut stateRegex verhindert, dass von aufzu und von aufzu_status GA's der Wert ins reading "state" geschrieben wird. Ist das Garagentor geöffnet, wird der Wert von GA Doorstatus "open" - was auch ins state-reading kopiert wird und damit das DevstateIcon als offen/geschlossen anzeigt.

Alternativ: Falls der KNX-Aktor eine "TreppenLicht Funktion" implementiert hat, (bei einem on wird eingeschaltet und nach x Sekunden augeschaltet, kann das Attribut eventMap komplett weggelassen werden.

"Doorstatus" muss nicht unbedingt ein KNX-Gerät sein, das könnte auch von einem anderen Device z.B.via notify gesetzt werden:

setreading Garagentor Doorstatus open/closed

Slider - einfach

define Slider_Test KNX 15/2/2:dpt5:Position
attr Slider_Test webCmd Position
attr Slider_Test widgetOverride Position-set:slider,0,5,100

Slider - mit Rückmeldung

define Slider2_Test KNX 15/2/2:dpt5.001:Position:set:nosuffix 15/2/3:dpt5.001:PosStatus:get:nosuffix
attr Slider2_Test stateCmd { fhem "sleep 0.05 quiet;; setreading $name Position $state" if ($gadName eq 'PosStatus');; return $state;; }
attr Slider2_Test webCmd Position
attr Slider2_Test widgetOverride Position:slider,0,5,100

Das Attr stateCmd setzt den Wert der vom Aktor kommt - zusätzlich in das reading 'Position', damit der Slider immer auch die aktuelle Position anzeigt. Die doppelten semicolons sind aus parsing Gründen nötig. Falls man das Attribut über Device-Detail-view setzt, sind nur einfache ; nötig!

Zwei Slider mit Rückmeldung

KNX dpt5tst.png

Z.B. für eine Jalousie mit Lamellensteuerung. Das ist eine Erweiterung des vorigen Beispiels.

define dpt5test KNX 9/1/1:dpt5.001:blind:set:nosuffix 9/1/2:dpt5.001:blindStatus:listenonly:nosuffix
9/1/3:dpt5.001:slat:set:nosuffix 9/1/4:dpt5.001:slatStatus:listenonly:nosuffix
attr dpt5test devStateIcon {Jal_devStateIcon()}
attr dpt5test room KNXtest
attr dpt5test stateCmd { if ($gadName =~ /(.*)Status/x) {
    fhem ("sleep 0.05 quiet; setreading $name $1 $state");
  }
  return $state;
}
attr dpt5test stateFormat 1:blind
<br/> 
2:slat
attr dpt5test webCmd blind:slat
attr dpt5test webCmdLabel Blind
:Slat
attr dpt5test widgetOverride blind:slider,0,1,100 slat:slider,0,10,100

Dazu braucht es noch eine sub in 99_myUtils.pm (siehe auch Beispiel Jalousie / Rolladen). Der Trick liegt in der indizierten Variante von stateFormat (1:blind,...), damit wird auch in devStateIcon dieser Index ausgewertet! Leider gibts für die Lamellen-Stellung nur 3 Icons, für die Stellungen: 0%,50%,100%.

## return string for devStateIcon
## input: none
## return string
sub Jal_devStateIcon {
  my $iconstring = 'block.on:fts_door_open@red ' .
         "block.off: " .
         'aufab.off:black_down:Ab ' .
         'aufab.on:black_up:Auf ' .
         'moving:fts_shutter_updown@red:Stop ' .
         '1.100.*:fts_shutter_100 1.1\d.*:fts_shutter_10 ' .
         '1.2\d.*:fts_shutter_20 1.3\d.*:fts_shutter_30 ' .
         '1.4\d.*:fts_shutter_40 1.5\d.*:fts_shutter_50 ' .
         '1.6\d.*:fts_shutter_60 1.7\d.*:fts_shutter_70 ' .
         '1.8\d.*:fts_shutter_80 1.9\d.*:fts_shutter_90 ' .
         '1.\d.*:fts_window_2w ' .
         '2.100.*:fts_blade_arc_close_100 ' .
         '2.\d\d.*:fts_blade_arc_close_50 ' .
         '2.\d.*:fts_blade_arc_close_00 ';
   return $iconstring;
}

RaumThermostat / HeizungsAktor

Fhemwiki KNX - RaumThermostat.png
define XXXZimmer_Heizung KNX 5/0/52:dpt9:solltemp:set:nosuffix 5/0/53:dpt9:solltemp_ist:get:nosuffix 5/0/50:dpt9:temperature:get:nosuffix 5/0/51:dpt5.001:valvepos:get:nosuffix
attr XXXZimmer_Heizung comment GAs: SollTemp-schreiben, SollTemp-lesen, IstTemp, ValvePosition
attr XXXZimmer_Heizung stateFormat temperature °C, Soll: solltemp_ist °C, Ventil: valvepos
attr XXXZimmer_Heizung webCmd solltemp
attr XXXZimmer_Heizung webCmdLabel SollTemperatur
attr XXXZimmer_Heizung widgetOverride solltemp:18.0,18.5,19.0,19.5,20.0,20.5,21.0,21.5,22.0,22.5,23.0,23.5,24.0,24.5,25.0 solltemp_ist:noArg temperature:noArg
attr XXXZimmer_Heizung widgetOverride solltemp:slider,18,0.5,25,1 solltemp_ist:noArg temperature:noArg

Beispiel für einen RaumThermostat / Heizungsregler. Die Soll-Temperatur kann entweder mittels pull-down oder mittels slider eingestellt werden. Siehe die beiden Attribute widgetoverride... (nur eines davon verwenden!)

Falls solltemp_ist nicht zur Verfügung steht, kann es weggelassen werden. Funktion: Es könnte ja die SollTemperatur am Raumthermostat eingestellt worden sein!

valvepos ist der Prozentwert, den das Raumthermostat für das Ventil der FB-Heizung sendet.

Zeit und Datum

define timedev KNX 0/0/7:dpt10:time 0/0/8:dpt11:date 0/0/9:dpt19:datetime

Hier sind alle Varianten von Zeit / Datum dargestellt. Die Empfänger müssen den jeweiligen DPT natürlich unterstützen! die entsprechenden set-cmd's lauten:

# setze das Datum auf den Bus:
set timedev date now
set timedev date 01.11.2021

# setze die Zeit auf den Bus:
set timedev time now
set timedev time 18:33:44

# setze Datum und Zeit (gleichzeitig) auf den Bus:
set timedev datetime now
set timedev datetime 01.11.2020_18:33:44

Text senden / empfangen

define textdev KNX 0/0/9:dpt16:txt

Die entsprechenden set-cmd's lauten:

set textdev txt AbCdEfGhIjkLmN  # send text to Bus (max 14 Char.)
set textdev txt >CLR< # delete text on the KNX display

Fhem antwortet auf Read Request vom Bus

define putDemo KNX 1/0/30:dpt9.001:temp 1/0/31:dpt9.001:humidity 1/0/32:dpt9:refVal

attr putDemo putCmd {ReadingsNum($name,'refVal-get',0) if ($gadName eq 'temp');}

Es sind 3 GA_Adressen definiert, FHEM antwortet allerdings nur auf einen read-request vom Bus wenn die 1/0/30 Adresse angesprochen wird, mit dem Wert der im refVal reading steht!

Jalousie / Rolladen

KNX JalKueche.png

Ein komplexes Beispiel, getestet mit einem Jal-Aktor von MDT. Ganz wichtig ist die GA: moving, der Aktor sendet on solange sich die Jalousie bewegt. Das ist ein Parameter, der mittels ETS konfiguriert werden kann. Ergebnis ist ein Device, dass jederzeit die Position anzeigt, Schlaltfllächen für Auf/Ab und einen Slider für's setzen der absoluten Position bietet. Dazu braucht es allerdings 2 sub-routinen in der 99_myUtils!

define Jal_Kueche KNX 5/1/53:dpt1.008:aufab:set:nosuffix
5/1/55:dpt1.010:stop:set:nosuffix
5/1/57:dpt1:moving:listenonly:nosuffix
5/1/58:dpt5.001:position:set:nosuffix
5/1/60:dpt5.001:posstatus:get:nosuffix
5/1/72:dpt1:block:set:nosuffix
5/1/65:dpt1:uppos:listenonly:nosuffix
5/1/66:dpt1:dnpos:listenonly:nosuffix

attr Jal_Kueche cmdIcon Auf:black_up Ab:black_down Stop:remotecontrol/black_btn_RED
attr Jal_Kueche comment GA's: aufab,stop,movestatus,posstatus,Setposition,block,uppos,dnpos
attr Jal_Kueche devStateIcon {Jal_devStateIcon()}
attr Jal_Kueche eventMap { usr=>{'Stop'=>'stop stop','Auf'=>'aufab up','Ab'=>'aufab down'} }
attr Jal_Kueche stateCmd {Jal_stateCmd($name,$gadName,$state)}
attr Jal_Kueche webCmd Auf:Ab:position
attr Jal_Kueche widgetOverride position:slider,0,5,100

.. und die beiden sub's in 99_myUtils.pm (Diese werden von allen Jalousien / Rolladen verwendet.

### Jalousie Utilities
## return string for stateCmd
## input: devicename, Gadname, state
sub Jal_stateCmd {
   my ($dname,$gadname,$dstate) = @_;
   my $newstate = '';
   if (ReadingsVal($dname,'block','off') eq 'on' ) {
      $newstate = 'block:on';
   } elsif (ReadingsVal($dname,'moving','off') eq 'on' ) {
      $newstate = 'moving';
      Log3 $dname, 5, "in stateCmd-movingon: $dname, $gadname,$dstate,newstate: $newstate";
   } else {
      $newstate = int((ReadingsNum($dname,'posstatus',0)+5)/10) * 10;
   }
   return $newstate;
}

## return string for devStateIcon
## input: none
## return string
sub Jal_devStateIcon {
  my $iconstring = 'block.on:fts_door_open@red ' .
         'block.off: ' .
         'wind.on:weather_wind@red ' .
         'wind.off: ' .
         'aufab.off:black_down:Ab ' .
         'aufab.on:black_up:Auf ' .
         'moving:fts_shutter_updown@red:Stop ' .
         '100.*:fts_shutter_100 1\d.*:fts_shutter_10 ' .
         '2\d.*:fts_shutter_20 3\d.*:fts_shutter_30 ' .
         '4\d.*:fts_shutter_40 5\d.*:fts_shutter_50 ' .
         '6\d.*:fts_shutter_60 7\d.*:fts_shutter_70 ' .
         '8\d.*:fts_shutter_80 9\d.*:fts_shutter_90 ' .
         '\d.*:fts_window_2w';
   return $iconstring;
}

Die sub stateCmd berücksichtigt auch noch die GA: block - z.B. wenn Fenster/Tür offen ist oder einen einen WindAlarm!

Slider - mit Rückmeldung und Wert Umrechnung

Ein komplexer Fall, wo ein Hersteller zwar den dpt5 verwendet, aber sein "eigenes Zahlen-Format" implementiert hat. Konkret geht's um eine Lüftungsanlage, die Stufen 0 (=Aus) bis 8 (=Maximum) verwendet. Am Bus kommen / werden erwartet die folgenden Werte:

0 (Aus)->0, 1->31, 2->63, 3->95, ... , 8->255

Im FHEM-Web sollen aber die Stufen 0-8 verwendet werden.

define KNXStufentest KNX 11/1/18:dpt5:StufeSoll:set:nosuffix 11/1/20:dpt5:StufeIst:get:nosuffix

attr KNXStufentest eventMap { usr => {'Aus' => 'StufeSoll 0', '^Ein' => 'StufeSoll ' . (3 * 32 - 1), '^Stufe (\d)' => '" . sprintf("StufeSoll %d",(($1 == 0)?0:($1 * 32 - 1)) ) . "' },
fw => {'^Ein' => 'Ein', '^Stufe (\d)' => 'Stufe' } }

attr KNXStufentest stateCmd { ($state,undef) = split(/\s/ix,$state);
  my $stateC = int(($state + 1) / 32);
  if ($gadName eq 'StufeIst') {
    fhem ("sleep 0.1;setreading $name Stufe $stateC"); 
  }
  if ($gadName eq 'StufeSoll') {
    fhem ("sleep 0.1;setreading $name Stufe $stateC"); 
  }
  return $state;
}
attr KNXStufentest webCmd Aus:Ein:Stufe
attr KNXStufentest widgetOverride Aus:noArg Ein:noArg Stufe:slider,0,1,8

Ankommende Messages (von Alias StufeIst) werden wie üblich im reading "StufeIst" (Werte: 0-255) gespeichert und zusätzlich umgerechnet und im reading "Stufe" (Wert: 0-8) gespeichert. Ein cmd vom User (Werte: 0-8) wird durch die eventMap umgerechnet und auf den Bus gesendet. Zusätzlich gibt's noch die Schaltflächen "Ein" und "Aus" . Auch diese Werde mittels eventMap auf Stufe 3(=Ein) bzw. Stufe 0(=Aus) umgerechnet. Die Syntax der eventMap ist gewöhnungsbedüftig, aber so funktioniert's! Was noch fehlt ist die Darstellung der Lüfterstufe mittels Icon.

DPT nicht unterstützt im KNX Modul ?

Im KNX-Modul sind (fast) alle DPT's unterstützt, die in den frei verfügbaren Standard-Dokumenten definiert sind. Hersteller definieren manchmal eigene sub-DPT's, die dann möglicherweise nicht unmittelbar unterstützt sind.

Im wesentlichen unterscheiden sich die sub-DPT's z.B. dpt9.020 von den "Haupt-DPT's" z.B. dpt9 durch die angefügte Einheit, den min/max Werte-Bereich, die Skalierung oder einen Offset. Falls also ein Gerät eine 2Byte-float Wert senden will, dann könnte das so aussehen:

define dpt9test KNX 0/4/6:dpt9
attr dpt9test format g/m&sup3; # gramm / m³

und schon steht die richtige Einheit dahinter... Oder Skalierung - Watt -> kW:

attr dpt9test stateCmd { return sprintf('%.3f kW',$state / 1000); }

Falsch definierte DPT's (z.B: dpt5 statt dpt7) produzieren falsche Ergebnisse, sowohl in FHEM als auch im KNX Device!

Übernehmen dieser Beispiele in die eigene config

Die meisten dieser Beispiele sind mittels "exportdevice <name>" erstellt. Bei der Übernahme mit c&p in die FHEM- commandozeile (oder auch Telnet) gibt's Fallstricke...(Es müssen Semicolons u. Zeilenumbrüche maskiert werden). Um das zu umgehen, schlage ich folgenden Vorgangsweise vor:

Definiere z.b. ein (kompliziertes) Attr stateCmd auf der FHEM-cmd Zeile:

attr meinDevice stateCmd {}

... also mit nichts drin! - Damit kann's auch keine syntax-Fehler geben! Danach geht man in den device-detail-View, klickt auf statecmd und mit c&p wird der code zwischen den (äussersten {} ) eingefügt. Selbes Vorgehen gilt auch für komplexe DevstateIcon, notifies, at,... Noch grössere code Teile sind sinnvoller in einer sub-routine in 99_myUtils.pm aufgehoben und werden z.b. im stateCmd aufgerufen:

attr <meinDevice> stateCmd { $state = meineAllerwichtigsteSubroutine(p1,p2,p3); }

Das hat dann auch den Vorteil, dass die sub-Routine von mehreren devices verwendet werden kann!