10_EIB.pm 44 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509
  1. ##############################################
  2. # $Id: 10_EIB.pm 11307 2016-04-25 08:02:06Z rudolfkoenig $
  3. # MH various changes/fixes from forum e.g dpt9, 0 is not necessarily off, ...
  4. # MH 20140313 changed Log to Log3, verbose instead of loglevel
  5. # MH 20140313 testing setstate....
  6. # MH 20141202 changing to readingsupdate
  7. # MH 20150518 . based on SVN 10_EIB.pm 8584 2015-05-15 18:46:52Z andi291
  8. # ABU 20150617 added dpt1, removed special handling of dpt5, added default-values for messages without dpt, changed retVal of EIB_ParseByDatapointType
  9. # MH 20150622 added getGx/setGx Readings and Attr EIBreadingX
  10. # ABU 20150617 cleanup unused lines, finalized dpt-handling, cleanup logging, added debug-par
  11. # ABU 20150729 removed special handling DPT7 in write, fixed DPT7 encoding
  12. # ABU 20150812 renamed return-value for autocreate; added attribute for reading containing sender; fixed HTML-Doku
  13. # ABU 20150917 cleaned up, implemented DPT16 for sending, implemented DPT6, added EIBanswerOnRead, changed time/date-handling, fixed DPT14-sending, removed Root-Causes for several warnings
  14. # ABU 20150919 fixed set string containing letter g
  15. # ABU 20150920 removed ne-warning, added attribute eventMarker, fixed behaviour if no model defined
  16. # ABU 20150922 fixed DPT14, restructured DPT9, fixed datum and time
  17. # ABU 20150923 improved failure-tolerance for none / wrong model
  18. # ABU 20150924 fixed date/time again
  19. # ABU 20150926 removed eventMarker, removed no get for dummies
  20. # ABU 20151207 added dpt3, fixed doku-section myDimmer
  21. # ABU 20151213 added dpt13
  22. # ABU 20151221 added multiple group support for get according thread 45954
  23. # ABU 20160111 added feature EIBreadingRegex, EIBwritingRegex, Fixed some doku
  24. # ABU 20160116 fixed motd-error due to debug-mode
  25. # ABU 20160122 fixed doku, changed return value for EIB_Set from undef to "", reintegrated multiple group sending
  26. # ABU 20160123 fixed issue for sending with additional groups
  27. package main;
  28. use strict;
  29. use warnings;
  30. my $debug=0;
  31. # Open Tasks
  32. # - precision for model percent to 0,1
  33. # - allow defined groups that are only used for sending of data (no status shown)
  34. my %eib_c2b = (
  35. "off" => "00",
  36. "on" => "01",
  37. "on-for-timer" => "01",
  38. "on-till" => "01",
  39. "raw" => "",
  40. "value" => "",#value must be last.. because of slider functionality in Set
  41. "string" => "" #value must be last.. because of slider functionality in Set
  42. );
  43. my %codes = (
  44. "00" => "off",
  45. "01" => "on",
  46. "" => "value",
  47. );
  48. my %readonly = (
  49. "dummy" => 1,
  50. );
  51. my $eib_simple ="off on value on-for-timer on-till";
  52. my %models = (
  53. );
  54. my %eib_dpttypes = (
  55. #Binary value
  56. "dpt1" => {"CODE"=>"dpt1", "UNIT"=>"", "factor"=>1},
  57. #Step value (four-bit)
  58. "dpt3" => {"CODE"=>"dpt3", "UNIT"=>"", "factor"=>1},
  59. # 1-Octet unsigned value
  60. "dpt5" => {"CODE"=>"dpt5", "UNIT"=>"", "factor"=>1},
  61. "percent" => {"CODE"=>"dpt5", "UNIT"=>"%", "factor"=>100/255, "slider"=>"0,1,100"},
  62. "dpt5.003" => {"CODE"=>"dpt5", "UNIT"=>"°", "factor"=>360/255},
  63. "angle" => {"CODE"=>"dpt5", "UNIT"=>"°", "factor"=>360/255}, # alias for dpt5.003
  64. "dpt5.004" => {"CODE"=>"dpt5", "UNIT"=>"%", "factor"=>1},
  65. "percent255" => {"CODE"=>"dpt5", "UNIT"=>"%", "factor"=>1 , "slider"=>"0,1,255"}, #alias for dpt5.004
  66. "dpt5.Slider" => {"CODE"=>"dpt5", "UNIT"=>"", "factor"=>100/255, "slider"=>"0,1,100"}, ##MH same as percent w.o. unit
  67. # 1-Octet signed value
  68. "dpt6" => {"CODE"=>"dpt6", "UNIT"=>"", "factor"=>1},
  69. "dpt6.001" => {"CODE"=>"dpt6", "UNIT"=>"%", "factor"=>1},
  70. "dpt6.010" => {"CODE"=>"dpt6", "UNIT"=>"", "factor"=>1},
  71. # 2-Octet unsigned Value (current, length, brightness)
  72. "dpt7" => {"CODE"=>"dpt7", "UNIT"=>""},
  73. "length-mm" => {"CODE"=>"dpt7", "UNIT"=>"mm"},
  74. "current-mA" => {"CODE"=>"dpt7", "UNIT"=>"mA"},
  75. "brightness" => {"CODE"=>"dpt7", "UNIT"=>"lux"},
  76. "timeperiod-ms" => {"CODE"=>"dpt7", "UNIT"=>"ms"},
  77. "timeperiod-min" => {"CODE"=>"dpt7", "UNIT"=>"min"},
  78. "timeperiod-h" => {"CODE"=>"dpt7", "UNIT"=>"h"},
  79. # 2-Octet Float Value (Temp / Light)
  80. "dpt9" => {"CODE"=>"dpt9", "UNIT"=>""},
  81. "tempsensor" => {"CODE"=>"dpt9", "UNIT"=>"°C"},
  82. "lightsensor" => {"CODE"=>"dpt9", "UNIT"=>"Lux"},
  83. "speedsensor" => {"CODE"=>"dpt9", "UNIT"=>"m/s"},
  84. "speedsensor-km/h" => {"CODE"=>"dpt9", "UNIT"=>"km/h"},
  85. "pressuresensor" => {"CODE"=>"dpt9", "UNIT"=>"Pa"},
  86. "rainsensor" => {"CODE"=>"dpt9", "UNIT"=>"l/m²"},
  87. "time1sensor" => {"CODE"=>"dpt9", "UNIT"=>"s"},
  88. "time2sensor" => {"CODE"=>"dpt9", "UNIT"=>"ms"},
  89. "humiditysensor" => {"CODE"=>"dpt9", "UNIT"=>"%"},
  90. "airqualitysensor" => {"CODE"=>"dpt9", "UNIT"=>"ppm"},
  91. "voltage-mV" => {"CODE"=>"dpt9", "UNIT"=>"mV"},
  92. "current-mA2" => {"CODE"=>"dpt9", "UNIT"=>"mA"},
  93. "power" => {"CODE"=>"dpt9", "UNIT"=>"kW"},
  94. "powerdensity" => {"CODE"=>"dpt9", "UNIT"=>"W/m²"},
  95. # Time of Day
  96. "dpt10" => {"CODE"=>"dpt10", "UNIT"=>""},
  97. "dpt10_no_seconds" => {"CODE"=>"dpt10_ns", "UNIT"=>""},
  98. "time" => {"CODE"=>"time", "UNIT"=>""},
  99. # Date
  100. "dpt11" => {"CODE"=>"dpt11", "UNIT"=>""},
  101. "date" => {"CODE"=>"date", "UNIT"=>""},
  102. # 4-Octet unsigned value (handled as dpt7)
  103. "dpt12" => {"CODE"=>"dpt12", "UNIT"=>""},
  104. # 4-Octet Signed Value
  105. "dpt13" => {"CODE"=>"dpt13", "UNIT"=>"", "factor"=>1},
  106. "dpt13.010" => {"CODE"=>"dpt13", "UNIT"=>"W/h", "factor"=>1},
  107. "dpt13.013" => {"CODE"=>"dpt13", "UNIT"=>"kW/h", "factor"=>1},
  108. # 4-Octet single precision float
  109. "dpt14" => {"CODE"=>"dpt14", "UNIT"=>""},
  110. # 14-Octet String
  111. "dpt16" => {"CODE"=>"dpt16", "UNIT"=>""},
  112. );
  113. sub
  114. EIB_Initialize($) {
  115. my ($hash) = @_;
  116. $hash->{Match} = "^B.*";
  117. $hash->{GetFn} = "EIB_Get";
  118. $hash->{SetFn} = "EIB_Set";
  119. $hash->{StateFn} = "EIB_SetState";
  120. $hash->{DefFn} = "EIB_Define";
  121. $hash->{UndefFn} = "EIB_Undef";
  122. $hash->{ParseFn} = "EIB_Parse";
  123. $hash->{AttrFn} = "EIB_Attr";
  124. $hash->{AttrList} = "IODev do_not_notify:1,0 ignore:0,1 dummy:1,0 showtime:1,0 " .
  125. "EIBreadingX:1,0 " .
  126. "EIBreadingSender:1,0 " .
  127. "EIBanswerReading:1,0 " .
  128. "EIBreadingRegex " .
  129. "EIBwritingRegex " .
  130. "$readingFnAttributes " .
  131. "model:".join(",", keys %eib_dpttypes);
  132. }
  133. #############################
  134. sub
  135. EIB_Define($$) {
  136. my ($hash, $def) = @_;
  137. my @a = split("[ \t][ \t]*", $def);
  138. my $u = "wrong syntax: define <name> EIB <group name> [<read group names>*]";
  139. return $u if(int(@a) < 3);
  140. return "Define $a[0]: wrong group name format: specify as 0-15/0-15/0-255 or as hex" if( ($a[2] !~ m/^[0-9]{1,2}\/[0-9]{1,2}\/[0-9]{1,3}$/i) && (lc($a[2]) !~ m/^[0-9a-f]{4}$/i));
  141. my $groupname = eib_name2hex(lc($a[2]));
  142. $hash->{GROUP} = lc($groupname);
  143. my $code = "$groupname";
  144. my $ncode = 1;
  145. my $name = $a[0];
  146. $hash->{CODE}{$ncode++} = $code;
  147. # add read group names
  148. if(int(@a)>3) {
  149. for (my $count = 3; $count < int(@a); $count++) {
  150. $hash->{CODE}{$ncode++} = eib_name2hex(lc($a[$count]));;
  151. }
  152. }
  153. $modules{EIB}{defptr}{$code}{$name} = $hash;
  154. AssignIoPort($hash);
  155. }
  156. #############################
  157. sub
  158. EIB_Undef($$) {
  159. my ($hash, $name) = @_;
  160. foreach my $c (keys %{ $hash->{CODE} } )
  161. {
  162. $c = $hash->{CODE}{$c};
  163. # As after a rename the $name may be different from the $defptr{$c}{$n}
  164. # we look for the hash.
  165. foreach my $dname (keys %{ $modules{EIB}{defptr}{$c} })
  166. {
  167. delete($modules{EIB}{defptr}{$c}{$dname}) if($modules{EIB}{defptr}{$c}{$dname} == $hash);
  168. }
  169. }
  170. return undef;
  171. }
  172. #####################################
  173. sub
  174. EIB_Attr(@)
  175. {
  176. my ($cmd,$name,$aName,$aVal) = @_;
  177. #debug
  178. print "Name: $name, Attribut: $aName, Wert: $aVal\n" if ($debug eq 1);
  179. # $cmd can be "del" or "set"
  180. # $name is device name
  181. # aName and aVal are Attribute name and value
  182. if ($cmd eq "set")
  183. {
  184. }
  185. elsif ($cmd eq "del")
  186. {
  187. }
  188. return undef;
  189. }
  190. #####################################
  191. sub
  192. EIB_SetState($$$$) {
  193. my ($hash, $tim, $vt, $val) = @_;
  194. Log3 $hash, 5,"EIB setState for $hash->{NAME} tim: $tim vt: $vt $val";
  195. $val = $1 if($val =~ m/^(.*) \d+$/);
  196. return undef if(!defined($eib_c2b{$val}));
  197. }
  198. ###################################
  199. sub
  200. EIB_Get($@) {
  201. #my ($hash, @a) = @_;
  202. ##return "No get for dummies" if(IsDummy($hash->{NAME}));
  203. #return "" if($a[1] && $a[1] eq "?"); # Temporary hack for FHEMWEB
  204. ##send read-request to the bus
  205. #IOWrite($hash, "B", "r" . $hash->{GROUP});
  206. #return "Current value for $hash->{NAME} ($hash->{GROUP}) requested.";
  207. my ($hash, @a, $str) = @_;
  208. my $na = int(@a);
  209. my $value = $a[1];
  210. return "" if($a[1] && $a[1] eq "?"); # Temporary hack for FHEMWEB
  211. my $groupnr = 1;
  212. # the command can be send to any of the defined groups indexed starting by 1
  213. # optional last argument starting with g indicates the group
  214. # execute only for non-strings. Otherwise a "g" is interpreted to execute this group-send-mechanism...
  215. if (defined($value) and ($value ne "string"))
  216. {
  217. $groupnr = $1 if($na=2 && $a[1]=~ m/g([0-9]*)/);
  218. #return, if unknown group
  219. return "groupnr $groupnr not known." if(!$hash->{CODE}{$groupnr});
  220. }
  221. my $groupcode = $hash->{CODE}{$groupnr};
  222. #send read-request to the bus
  223. IOWrite($hash, "B", "r" . $groupcode);
  224. return "Current value for $hash->{NAME} ($groupcode) requested.";
  225. }
  226. ###################################
  227. sub
  228. EIB_Set($@) {
  229. my ($hash, @a, $str) = @_;
  230. #my $ret = undef;
  231. my $ret = "";
  232. my $na = int(@a);
  233. #return, if no set value specified
  234. return "no set value specified" if($na < 2);# || $na > 4);
  235. #return, if this is a readonly-device
  236. return "Readonly value $a[1]" if(defined($readonly{$a[1]}));
  237. #return, if this is a dummy device
  238. return "No $a[1] for dummies" if(IsDummy($hash->{NAME}));
  239. my $name = $a[0];
  240. my $value = $a[1];
  241. my $arg1 = undef;
  242. my $arg2 = undef;
  243. $arg1 = $a[2] if($na>2);
  244. $arg2 = $a[3] if($na>3);
  245. my $model = $attr{$name}{"model"};
  246. my $sliderdef = !defined($model)?undef:$eib_dpttypes{"$model"}{"slider"};
  247. my $c = $eib_c2b{$value};
  248. if(!defined($c))
  249. {
  250. my $resp = "Unknown argument $value, choose one of " . join(" ", sort keys %eib_c2b);
  251. $resp = $resp . ":slider,$sliderdef" if(defined $sliderdef);
  252. return $resp;
  253. }
  254. my $groupnr = 1;
  255. my $extGroupNr = undef;
  256. # the command can be send to any of the defined groups indexed starting by 1
  257. # optional last argument starting with g indicates the group
  258. $extGroupNr = $1 if($na>2 && $a[$na-1]=~ m/g([0-9]*)/);
  259. if (defined ($extGroupNr))
  260. {
  261. $groupnr = $extGroupNr;
  262. print ("Found supplied group-no.: $extGroupNr\n") if ($debug eq 1);
  263. }
  264. return "groupnr $groupnr not known." if(!$hash->{CODE}{$groupnr});
  265. my $v = join(" ", @a);
  266. Log3 $name, 5, "EIB set $v";
  267. (undef, $v) = split(" ", $v, 2); # Not interested in the name...
  268. if($value eq "raw" && defined($arg1))
  269. {
  270. # complex value command.
  271. # the additional argument is transfered alone.
  272. $c = $arg1;
  273. }
  274. elsif ($value eq "value" && defined($arg1))
  275. {
  276. # value to be translated according to datapoint type
  277. $c = EIB_EncodeByDatapointType($hash,$name,$arg1,$groupnr); #MH add group in call
  278. # set the value to the back translated value
  279. $v = EIB_ParseByDatapointType($hash,$name,$c,$groupnr); # MH probably stupid - but required!!!!
  280. }
  281. elsif ($value eq "string" && ($na>2))
  282. {
  283. my $str = "";
  284. #append all following args...
  285. my $argLen = $na;
  286. #...except the last argument is a group-no
  287. $argLen -= 1 if (defined $extGroupNr);
  288. #join string
  289. for (my $i=2;$i<$argLen;$i++)
  290. {
  291. $str.= $a[$i]." ";
  292. }
  293. #trim whitespaces at the end
  294. $str =~ s/^\s+|\s+$//g;
  295. return "String too long, max. 14 chars allowed" if(length($str) > 14);
  296. Log3 $name, 5, "set string $str";
  297. # value to be translated according to datapoint type
  298. $c = EIB_EncodeByDatapointType($hash,$name,$str,$groupnr);
  299. # set the value to the back translated value
  300. $v = EIB_ParseByDatapointType($hash,$name,$c,$groupnr);
  301. }
  302. my $groupcode = $hash->{CODE}{$groupnr};
  303. $model = $attr{$name}{"model"}; ##MH
  304. $model = "" unless defined($model); ##MH avoid uninit msg
  305. my $code = $eib_dpttypes{"$model"}{"CODE"};
  306. #send new value
  307. IOWrite($hash, "B", "w" . $groupcode . $c);
  308. ###########################################
  309. # Delete any timer for on-for_timer
  310. if($modules{EIB}{ldata}{$name})
  311. {
  312. CommandDelete(undef, $name . "_timer");
  313. delete $modules{EIB}{ldata}{$name};
  314. }
  315. ###########################################
  316. # Add a timer if any for-timer command has been chosen
  317. if($value =~ m/for-timer/ && defined($arg1))
  318. {
  319. my $dur = $arg1;
  320. my $to = sprintf("%02d:%02d:%02d", $dur/3600, ($dur%3600)/60, $dur%60);
  321. $modules{EIB}{ldata}{$name} = $to;
  322. Log3 $name, 4, "Follow: +$to set $name off g$groupnr";
  323. CommandDefine(undef, $name . "_timer at +$to set $name off g$groupnr");
  324. }
  325. ###########################################
  326. # Delete any timer for on-till
  327. if($modules{EIB}{till}{$name})
  328. {
  329. CommandDelete(undef, $name . "_till");
  330. delete $modules{EIB}{till}{$name};
  331. }
  332. ###########################################
  333. # Add a timer if on-till command has been chosen
  334. if($value =~ m/on-till/ && defined($arg1))
  335. {
  336. my ($err, $hr, $min, $sec, $fn) = GetTimeSpec($arg1);
  337. if($err)
  338. {
  339. Log3 $name, 2, "Error trying to parse timespec for $a[0] $a[1] $a[2] : $err";
  340. }
  341. else
  342. {
  343. my @lt = localtime;
  344. my $hms_till = sprintf("%02d:%02d:%02d", $hr, $min, $sec);
  345. my $hms_now = sprintf("%02d:%02d:%02d", $lt[2], $lt[1], $lt[0]);
  346. if($hms_now ge $hms_till)
  347. {
  348. Log3 $name, 4, "on-till: won't switch as now ($hms_now) is later than $hms_till";
  349. }
  350. else
  351. {
  352. $modules{EIB}{till}{$name} = $hms_till;
  353. Log3 $name, 4, "Follow: $hms_till set $name off g$groupnr";
  354. CommandDefine(undef, $name . "_till at $hms_till set $name off g$groupnr");
  355. }
  356. }
  357. }
  358. ##########################
  359. # Look for all devices with the same code, and set state, timestamp
  360. $code = "$hash->{GROUP}"; ##MH reuse variable
  361. my $tn = TimeNow();
  362. my $defptr = $modules{EIB}{defptr}{$code};
  363. foreach my $n (keys %{ $defptr })
  364. {
  365. my $regAttr = $attr{$n}{"EIBwritingRegex"};
  366. if ($regAttr)
  367. {
  368. #substitute contents of state, if desired
  369. #
  370. #get array of given attributes
  371. my @reg = split("[ ]", $regAttr);
  372. #format reading as input for regex
  373. my $tempVal = "setG$groupnr:$v";
  374. #loop over all regex
  375. for (my $i = 0; $i < int(@reg); $i++)
  376. {
  377. #get search / replaye parts
  378. my @regInner = split("\/", $reg[$i]);
  379. $tempVal =~ s/$regInner[0]/$regInner[1]/g;
  380. #log it
  381. Log (5, "modified set with regex s/$regInner[0]/$regInner[1]/g to value $tempVal");
  382. print ("modified set with regex s/$regInner[0]/$regInner[1]/g to value $tempVal\n") if ($debug eq 1);
  383. }
  384. #process result
  385. readingsSingleUpdate($defptr->{$n},"state",$tempVal,1);
  386. } else
  387. {
  388. #process regular reading
  389. readingsSingleUpdate($defptr->{$n},"state",$v,1);
  390. }
  391. #debug
  392. print "setg = $defptr->{$n}{NAME} , $groupnr , attr = AttrVal($defptr->{$n}{NAME},'EIBreadingX',0)n" if ($debug eq 1);
  393. #process extended reading - mark as set
  394. readingsSingleUpdate($defptr->{$n},"setG" . $groupnr,$v,1) if (AttrVal($defptr->{$n}{NAME},'EIBreadingX',0) == 1);
  395. }
  396. return $ret;
  397. }
  398. ###################################
  399. sub
  400. EIB_Parse($$) {
  401. my ($hash, $msg) = @_;
  402. # Msg format:
  403. # B(w/r/p)<group><value> i.e. Bw00000101
  404. # we will also take reply telegrams into account,
  405. # as they will be sent if the status is asked from bus
  406. #split message into parts
  407. $msg =~ m/^B(.{4})(.{1})(.{4})(.*)$/;
  408. my $src = $1;
  409. my $cmd = $2;
  410. my $dev = $3;
  411. my $val = $4;
  412. my $v = $codes{$val};
  413. $v = "$val" if(!defined($v));
  414. my $rawv = $v;
  415. my @list;
  416. my $found = 0;
  417. # check if the code is within the read groups
  418. # we will inform all definitions subsribed to this code
  419. foreach my $mod (keys %{$modules{EIB}{defptr}})
  420. {
  421. my $def = $modules{EIB}{defptr}{"$mod"};
  422. if($def)
  423. {
  424. foreach my $n (keys %{ $def })
  425. {
  426. my $lh = $def->{$n};
  427. foreach my $gnr (keys %{ $lh->{CODE} })
  428. {
  429. my $c = $lh->{CODE}{$gnr};
  430. if($c eq $dev)
  431. {
  432. $n = $lh->{NAME}; # It may be renamed
  433. next if(IsIgnored($n)); # Little strange.
  434. push(@list, $n);
  435. $found = 1;
  436. # handle write and reply messages
  437. if($cmd =~ /[w|p]/)
  438. {
  439. # parse/translate by datapoint type
  440. $v = EIB_ParseByDatapointType($lh,$n,$rawv,$gnr); # MH added optional groupnr
  441. $lh->{RAWSTATE} = $rawv;
  442. $lh->{LASTGROUP} = $dev;
  443. my $regAttr = $attr{$n}{"EIBreadingRegex"};
  444. if ($regAttr)
  445. {
  446. #substitute contents of state, if desired
  447. #
  448. #get array of given attributes
  449. my @reg = split("[ ]", $regAttr);
  450. #format reading as input for regex
  451. my $tempVal = "getG$gnr:$v";
  452. #loop over all regex
  453. for (my $i = 0; $i < int(@reg); $i++)
  454. {
  455. #get search / replaye parts
  456. my @regInner = split("\/", $reg[$i]);
  457. $tempVal =~ s/$regInner[0]/$regInner[1]/g;
  458. #log it
  459. Log (5, "modified set with regex s/$regInner[0]/$regInner[1]/g to value $tempVal");
  460. print ("modified set with regex s/$regInner[0]/$regInner[1]/g to value $tempVal\n") if ($debug eq 1);
  461. }
  462. #process result
  463. readingsSingleUpdate($lh,"state",$tempVal,1);
  464. }
  465. else
  466. {
  467. #process regular reading
  468. readingsSingleUpdate($lh,"state",$v,1);
  469. }
  470. #debug
  471. print "getg = $n , group= $gnr , EIBreadingX = AttrVal($def->{$n}{NAME},'EIBreadingX',0)\n" if ($debug eq 1);
  472. #process extended reading - mark as "get"
  473. readingsSingleUpdate($lh,'getG' . $gnr,$v,1) if (AttrVal($def->{$n}{NAME},'EIBreadingX',0) == 1);
  474. #process output of sender
  475. if (AttrVal($def->{$n}{NAME},'EIBreadingSender',0) == 1)
  476. {
  477. my $srcName = eib_hex2name($src);
  478. #debug
  479. print "sender = $srcName, group= $gnr, EIBreadingSender = AttrVal($def->{$n}{NAME},'EIBreadingSender',0)\n" if ($debug eq 1);
  480. readingsSingleUpdate($lh,'sender',$srcName,1);
  481. }
  482. Log3 $n, 5, "EIB parse write message $n $v";
  483. }
  484. # handle read messages, if Attribute is set
  485. elsif (($cmd =~ /[r]/) && (AttrVal($def->{$n}{NAME},'EIBanswerReading',0) == 1))
  486. {
  487. #debug
  488. print "group= $c, EIBanswerReading = AttrVal($def->{$n}{NAME},'EIBanswerReading',0)\n" if ($debug eq 1);
  489. #convert value from state
  490. my $tmp = EIB_EncodeByDatapointType($hash, $n, $lh->{STATE}, $gnr);
  491. #write answer
  492. TUL_Write($hash, "B", "p" . $c . $tmp);
  493. Log3 $n, 5, "EIB parse read message $n $v";
  494. }
  495. }
  496. }
  497. }
  498. }
  499. }
  500. return @list if $found>0;
  501. if($found==0)
  502. {
  503. my $dev_name = eib_hex2name($dev);
  504. Log3 $dev, 3, "EIB Unknown device $dev ($dev_name), Value $val, please define it";
  505. return "UNDEFINED EIB_$dev EIB $dev_name";
  506. }
  507. }
  508. ###################################
  509. sub
  510. EIB_EncodeByDatapointType($$$$) {
  511. my ($hash, $name, $value, $gnr) = @_;
  512. my @model_array = split(" ",$attr{$name}{"model"}) if (defined($attr{$name}{"model"}));
  513. my $model = $model_array[0];
  514. my $transval = undef;
  515. #no model defined
  516. if (!defined($model))
  517. {
  518. $model = "dpt1";
  519. Log3 $hash, 3,"EIB encode: no model defined for $name. Replaced with DPT1.";
  520. }
  521. #no gnr defined
  522. if (defined($gnr))
  523. {
  524. $model = $model_array[$gnr-1] if (defined($model_array[$gnr-1]));
  525. }
  526. else
  527. {
  528. Log3 $hash, 2,"EIB encode no gnr defined";
  529. return undef;
  530. }
  531. my $code = $eib_dpttypes{"$model"}{"CODE"};
  532. #invalid model defined
  533. if (!defined($code))
  534. {
  535. Log3 $hash, 1,"EIB encode: invalid model defined for $name. Breaking up...";
  536. return undef;
  537. }
  538. if (!defined($value))
  539. {
  540. Log3 $hash, 2,"EIB encode no value defined";
  541. return undef;
  542. }
  543. Log3 $hash, 5,"EIB_EncodeByDatapointType: $name, Value= $value, model= $model";
  544. my $dpt = $eib_dpttypes{"$model"};
  545. my $unit = $eib_dpttypes{"$model"}{"UNIT"};
  546. my $adjustment = $eib_dpttypes{"$model"}{"ADJUSTMENT"};
  547. if (defined ($adjustment) && defined ($unit))
  548. {
  549. Log3 $hash, 4,"EIB encode $value for $name model: $model dpt: $code unit: $unit";
  550. }
  551. #start with model-selection. Go through DPT's
  552. if ($code eq "dpt1")
  553. {
  554. my $fullval = "";
  555. #replace on/off
  556. $fullval = "00" if ($value eq "off");
  557. $fullval = "01" if ($value eq "on");
  558. #return value, if encode was successful
  559. if ($fullval ne "")
  560. {
  561. $transval = $fullval;
  562. }
  563. #if not return hex-data
  564. else
  565. {
  566. $transval = sprintf("%x", $value);
  567. }
  568. Log3 $hash, 5,"EIB $code encode $value translated: $transval";
  569. }
  570. elsif ($code eq "dpt3")
  571. {
  572. #4-bit steps
  573. my $rawval = $value;
  574. my $sign = undef;
  575. my $fullval = undef;
  576. #determine dim-direction, assuming positive direction by default
  577. if ($value =~ /^-/)
  578. {
  579. $value = -$value;
  580. $sign = 0;
  581. }
  582. else
  583. {
  584. $sign = 1;
  585. }
  586. #determine value
  587. if ($value >= 75)
  588. {
  589. #adjust 100%
  590. $fullval = 01;
  591. }
  592. elsif ($value >= 50)
  593. {
  594. #adjust 50%
  595. $fullval = 02;
  596. }
  597. elsif ($value >= 25)
  598. {
  599. #adjust 25%
  600. $fullval = 03;
  601. }
  602. elsif ($value >= 12)
  603. {
  604. #adjust 12%
  605. $fullval = 04;
  606. }
  607. elsif ($value >= 6)
  608. {
  609. #adjust 6%
  610. $fullval = 05;
  611. }
  612. elsif ($value >= 3)
  613. {
  614. #adjust 3%
  615. $fullval = 06;
  616. }
  617. elsif ($value >= 1)
  618. {
  619. #adjust 1%
  620. $fullval = 07;
  621. }
  622. elsif ($value >= 0)
  623. {
  624. #adjust 0%
  625. $fullval = 00;
  626. }
  627. else
  628. {
  629. #do nothing
  630. $fullval = undef;
  631. }
  632. #place signe
  633. if (defined ($fullval) && ($sign eq 1))
  634. {
  635. $fullval = $fullval | 8;
  636. }
  637. #make it hex
  638. $transval = sprintf("0%.1x",$fullval);
  639. Log3 $hash, 5,"EIB $code encode $rawval = sign $sign value $value to $fullval. Translated to hex $transval.";
  640. }
  641. elsif ($code eq "dpt5")
  642. {
  643. #1-byte unsigned
  644. my $dpt5factor = $eib_dpttypes{"$model"}{"factor"};
  645. my $fullval = sprintf("00%.2x",($value/$dpt5factor));
  646. $transval = $fullval;
  647. Log3 $hash, 5,"EIB $code encode $value = $fullval factor = $dpt5factor translated: $transval";
  648. }
  649. elsif ($code eq "dpt6")
  650. {
  651. #1-byte signed
  652. my $dpt6factor = $eib_dpttypes{"$model"}{"factor"};
  653. my $fullval = int($value/$dpt6factor);
  654. $fullval += 256 if ($fullval < 0);
  655. $fullval = 0 if ($fullval < 0);
  656. $fullval = 0xFF if ($fullval > 0xFF);
  657. $transval = sprintf("00%.2x",$fullval);
  658. Log3 $hash, 5,"EIB $code encode $value = $fullval factor = $dpt6factor translated: $transval";
  659. }
  660. elsif ($code eq "dpt7")
  661. {
  662. #2-byte unsigned
  663. my $fullval = "";
  664. if($adjustment eq "255")
  665. {
  666. $fullval = sprintf("00%.4x",($value/2.55));
  667. }
  668. else
  669. {
  670. $fullval = sprintf("00%.4x",$value);
  671. }
  672. $transval = $fullval;
  673. Log3 $hash, 5,"EIB $code encode $value = $fullval translated: $transval";
  674. }
  675. elsif($code eq "dpt9")
  676. {
  677. #2-byte float
  678. my $fullval;
  679. my $sign = ($value <0 ? 0x8000 : 0);
  680. my $exp = 0;
  681. my $mant = 0;
  682. $mant = int($value * 100.0);
  683. while (abs($mant) > 2047) {
  684. $mant /= 2;
  685. $exp++;
  686. }
  687. $fullval = $sign | ($exp << 11) | ($mant & 0x07ff);
  688. $transval = sprintf("00%.4x",$fullval);
  689. Log3 $hash, 5,"EIB $code encode $value translated: $transval";
  690. }
  691. elsif ($code eq "dpt10")
  692. {
  693. # Time
  694. my $fullval = 0;
  695. my ($hh, $mm, $ss) = split /:/, $value;
  696. $fullval = $ss + ($mm<<8) + (($hh)<<16);
  697. $transval = sprintf("00%.6x",$fullval);
  698. Log3 $hash, 5,"EIB $code encode $value translated: $transval";
  699. }
  700. elsif ($code eq "dpt10_ns")
  701. {
  702. # Time, seconds = zero
  703. my $fullval = 0;
  704. my ($hh, $mm, $ss) = split /:/, $value;
  705. $ss = 0;
  706. $fullval = $ss + ($mm<<8) + (($hh)<<16);
  707. $transval = sprintf("00%.6x",$fullval);
  708. Log3 $hash, 5,"EIB $code encode $value translated: $transval";
  709. }
  710. elsif ($code eq "time")
  711. {
  712. # current Time
  713. my ($secs,$mins,$hours,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time);
  714. $year+=1900;
  715. $mon++;
  716. my $fullval = 0;
  717. # calculate offset for weekday
  718. $wday = 7 if ($wday eq "0");
  719. my $hoffset = 32*$wday;
  720. $fullval = $secs + ($mins<<8) + (($hoffset + $hours)<<16);
  721. $value = sprintf("%02d:%02d:%02d",$hours,$mins,$secs); # value for log
  722. $transval = sprintf("00%.6x",$fullval);
  723. Log3 $hash, 5,"EIB $code encode $value translated: $transval";
  724. }
  725. elsif ($code eq "dpt11")
  726. {
  727. # Date
  728. my $fullval = 0;
  729. my ($dd, $mm, $yyyy) = split /\./, $value;
  730. $fullval = ($yyyy - 2000) + ($mm<<8) + ($dd<<16);
  731. $transval = sprintf("00%.6x",$fullval);
  732. Log3 $hash, 5,"EIB $code encode $value translated: $transval";
  733. }
  734. elsif ($code eq "date")
  735. {
  736. # current Date
  737. my ($secs,$mins,$hours,$day,$month,$year,$wday,$yday,$isdst) = localtime(time);
  738. $year+=1900;
  739. $month++;
  740. my $fullval = 0;
  741. #encode current date
  742. $fullval = ($year-2000) + ($month<<8) + ($day<<16);
  743. $transval = sprintf("00%.6x",$fullval);
  744. Log3 $hash, 5,"EIB $code encode $value = $fullval day: $day month: $month year: $year translated: $transval";
  745. }
  746. elsif ($code eq "dpt12")
  747. {
  748. #4-byte unsigned
  749. my $fullval = sprintf("00%.8x",$value);
  750. $transval = $fullval;
  751. Log3 $hash, 5,"EIB $code encode $value" . '=' . " $fullval translated: $transval";
  752. }
  753. elsif ($code eq "dpt13")
  754. {
  755. #4-byte signed
  756. my $dpt13factor = $eib_dpttypes{"$model"}{"factor"};
  757. my $fullval = int($value/$dpt13factor);
  758. $fullval += 4294967296 if ($fullval < 0);
  759. $fullval = 0 if ($fullval < 0);
  760. $fullval = 0xFFFFFFFF if ($fullval > 0xFFFFFFFF);
  761. $transval = sprintf("00%.8x",$fullval);
  762. Log3 $hash, 5,"EIB $code encode $value = $fullval factor = $dpt13factor translated: $transval";
  763. }
  764. elsif($code eq "dpt14")
  765. {
  766. #4-byte float
  767. my $fullval;
  768. $fullval = unpack("L", pack("f", $value));
  769. $transval = sprintf("00%.8x", $fullval);
  770. Log3 $hash, 5,"EIB $code encode $value translated: $transval";
  771. }
  772. elsif ($code eq "dpt16")
  773. {
  774. #text
  775. my $dat = $value;
  776. #convert to hex-string
  777. $dat =~ s/(.)/sprintf("%x",ord($1))/eg;
  778. #format for 14-byte-length
  779. $dat = sprintf("%-028s",$dat);
  780. #append leading zeros
  781. $dat = "00" . $dat;
  782. $transval = $dat;
  783. Log3 $hash, 5,"EIB $code encode $value translated: $transval";
  784. }
  785. elsif ($code eq "dptxx")
  786. {
  787. }
  788. # set state to translated value
  789. if(defined($transval))
  790. {
  791. Log3 $hash, 4,"EIB $name translated $value to $transval";
  792. $value = "$transval";
  793. }
  794. return $value;
  795. }
  796. sub
  797. EIB_ParseByDatapointType($$$$)
  798. {
  799. my ($hash, $name, $value, $gnr) = @_; #MH
  800. my @model_array = split(" ",$attr{$name}{"model"}) if (defined($attr{$name}{"model"}));
  801. my $model = $model_array[0];
  802. # nothing to do if no model is given
  803. #return $value if(!defined($model));
  804. if (defined($gnr))
  805. {
  806. $model = $model_array[$gnr-1] if defined ($model_array[$gnr-1]);
  807. }
  808. #debug
  809. print "EIB_ParseByDatapointType: $name, val= $value, Group= $gnr, Model= $model \n" if ($debug eq 1);
  810. #no model defined
  811. if (!defined($model))
  812. {
  813. $model = "dpt1";
  814. Log3 $hash, 3,"EIB encode: no model defined for $name. Replaced with DPT1.";
  815. }
  816. my $code = $eib_dpttypes{"$model"}{"CODE"};
  817. #invalid model defined
  818. if (!defined($code))
  819. {
  820. Log3 $hash, 1,"EIB encode: invalid model defined for $name. Breaking up....";
  821. return undef;
  822. }
  823. my $dpt = $eib_dpttypes{"$model"};
  824. my $unit = $eib_dpttypes{"$model"}{"UNIT"};
  825. my $transval = undef;
  826. Log3 $hash, 5,"EIB parse $value for $name model: $model dpt: $code unit: $unit";
  827. #debug
  828. print "EIB_ParseByDatapointType: $name, val= $value, Group= $gnr, Model= $model, code= $code, unit= $unit \n" if ($debug eq 1);
  829. #moved to the front... - execute if DPT is NOT 1
  830. if ($code ne "dpt1")
  831. {
  832. $value = 0 if ($value eq "off");
  833. $value = 1 if ($value eq "on");
  834. }
  835. #correct value in realtion to potential non-compatible states
  836. if ($code eq "dpt1")
  837. {
  838. #1-bit
  839. $value = "off" if ($value eq 0);
  840. $value = "on" if ($value eq 1);
  841. $transval = $value;
  842. }
  843. elsif ($code eq "dpt3")
  844. {
  845. #4-bit steps
  846. my $rawval = $value;
  847. my $sign = undef;
  848. my $fullval = undef;
  849. #make it decimal
  850. $value = hex ($value);
  851. #determine dim-direction
  852. if ($value & 8)
  853. {
  854. $sign = "+";
  855. }
  856. else
  857. {
  858. $sign = "-";
  859. }
  860. #mask it...
  861. $value = $value & 7;
  862. #determine value
  863. if ($value == 7)
  864. {
  865. #adjust 1%
  866. $fullval = 1;
  867. }
  868. elsif ($value == 6)
  869. {
  870. #adjust 3%
  871. $fullval = 3;
  872. }
  873. elsif ($value == 5)
  874. {
  875. #adjust 6%
  876. $fullval = 6;
  877. }
  878. elsif ($value == 4)
  879. {
  880. #adjust 12%
  881. $fullval = 12;
  882. }
  883. elsif ($value == 3)
  884. {
  885. #adjust 25%
  886. $fullval = 25;
  887. }
  888. elsif ($value == 2)
  889. {
  890. #adjust 50%
  891. $fullval = 50;
  892. }
  893. elsif ($value == 1)
  894. {
  895. #adjust 100%
  896. $fullval = 100;
  897. }
  898. elsif ($value == 0)
  899. {
  900. #adjust 0%
  901. $fullval = 0;
  902. }
  903. else
  904. {
  905. #do nothing
  906. $fullval = undef;
  907. }
  908. if (defined ($sign) && defined ($fullval))
  909. {
  910. $transval = "$sign$fullval";
  911. }
  912. Log3 $hash, 5,"EIB $code decode $rawval = sign $sign value $value to $fullval";
  913. }
  914. elsif ($code eq "dpt5")
  915. {
  916. #1-byte unsigned
  917. my $dpt5factor = $eib_dpttypes{"$model"}{"factor"};
  918. my $fullval = hex($value);
  919. $transval = $fullval;
  920. $transval = sprintf("%.0f",$transval * $dpt5factor) if($dpt5factor != 0);
  921. }
  922. elsif ($code eq "dpt6")
  923. {
  924. my $dpt6factor = $eib_dpttypes{"$model"}{"factor"};
  925. my $fullval = hex($value);
  926. $transval = $fullval;
  927. $transval -= 256 if $transval >= 0x80;
  928. $transval = sprintf("%.0f",$transval * $dpt6factor) if($dpt6factor != 0);
  929. }
  930. elsif ($code eq "dpt7")
  931. {
  932. #2-byte unsigned
  933. my $fullval = hex($value);
  934. $transval = $fullval;
  935. }
  936. elsif($code eq "dpt9")
  937. {
  938. #2-bate float
  939. my $fullval = hex($value);
  940. my $sign = 1;
  941. $sign = -1 if(($fullval & 0x8000)>0);
  942. my $exp = ($fullval & 0x7800)>>11;
  943. my $mant = ($fullval & 0x07FF);
  944. $mant = -(~($mant-1)&0x07FF) if($sign==-1);
  945. $transval = (1<<$exp)*0.01*$mant;
  946. }
  947. elsif ($code eq "dpt10")
  948. {
  949. # Time
  950. my $fullval = hex($value);
  951. my $hours = ($fullval & 0x1F0000)>>16;
  952. my $mins = ($fullval & 0x3F00)>>8;
  953. my $secs = ($fullval & 0x3F);
  954. $transval = sprintf("%02d:%02d:%02d",$hours,$mins,$secs);
  955. }
  956. elsif ($code eq "dpt10_ns")
  957. {
  958. # Time without seconds
  959. my $fullval = hex($value);
  960. my $hours = ($fullval & 0x1F0000)>>16;
  961. my $mins = ($fullval & 0x3F00)>>8;
  962. my $secs = ($fullval & 0x3F);
  963. $transval = sprintf("%02d:%02d",$hours,$mins);
  964. }
  965. elsif ($code eq "time")
  966. {
  967. # Time
  968. my $fullval = hex($value);
  969. my $hours = ($fullval & 0x1F0000)>>16;
  970. my $mins = ($fullval & 0x3F00)>>8;
  971. my $secs = ($fullval & 0x3F);
  972. $transval = sprintf("%02d:%02d:%02d",$hours,$mins,$secs);
  973. }
  974. elsif ($code eq "dpt11")
  975. {
  976. # Date
  977. my $fullval = hex($value);
  978. my $day = ($fullval & 0x1F0000)>>16;
  979. my $month = ($fullval & 0x0F00)>>8;
  980. my $year = ($fullval & 0x7F);
  981. #translate year (21st cent if <90 / else 20th century)
  982. $year += 1900 if($year>=90);
  983. $year += 2000 if($year<90);
  984. $transval = sprintf("%02d.%02d.%04d",$day,$month,$year);
  985. }
  986. elsif ($code eq "date")
  987. {
  988. # Date
  989. my $fullval = hex($value);
  990. my $day = ($fullval & 0x1F0000)>>16;
  991. my $month = ($fullval & 0x0F00)>>8;
  992. my $year = ($fullval & 0x7F);
  993. #translate year (21st cent if <90 / else 20th century)
  994. $year += 1900 if($year>=90);
  995. $year += 2000 if($year<90);
  996. $transval = sprintf("%02d.%02d.%04d",$day,$month,$year);
  997. }
  998. elsif ($code eq "dpt12")
  999. {
  1000. #4-bate unsigned
  1001. my $fullval = hex($value);
  1002. $transval = $fullval;
  1003. }
  1004. elsif ($code eq "dpt13")
  1005. {
  1006. my $dpt13factor = $eib_dpttypes{"$model"}{"factor"};
  1007. my $fullval = hex($value);
  1008. $transval = $fullval;
  1009. $transval -= 4294967296 if $transval >= 0x80000000;
  1010. $transval = sprintf("%.0f",$transval * $dpt13factor) if($dpt13factor != 0);
  1011. }
  1012. elsif ($code eq "dpt14")
  1013. {
  1014. # 4-byte float
  1015. my $fullval;
  1016. $fullval = unpack "f", pack "L", hex $value;
  1017. $transval = sprintf ("%f","$fullval");
  1018. }
  1019. elsif ($code eq "dpt16")
  1020. {
  1021. #text
  1022. $transval = "";
  1023. for (my $i=0;$i<14;$i++)
  1024. {
  1025. my $c = hex(substr($value,$i*2,2));
  1026. if ($c eq 0)
  1027. {
  1028. $i = 14;
  1029. }
  1030. else
  1031. {
  1032. $transval .= sprintf("%c", $c);
  1033. }
  1034. }
  1035. }
  1036. elsif ($code eq "dptxx")
  1037. {
  1038. }
  1039. # set state to translated value
  1040. if(defined($transval))
  1041. {
  1042. Log3 $hash, 4, "EIB_ParseByDatapointType: $name, origval= $value, transval= $transval, Group= $gnr, Model= $model, code= $code, unit= $unit";
  1043. print "EIB_ParseByDatapointType: $name, origval= $value, transval= $transval, Group= $gnr, Model= $model, code= $code, unit= $unit \n" if ($debug eq 1);
  1044. $value = "$transval $unit";
  1045. $value =~ s/^\s+|\s+$//g;
  1046. }
  1047. else
  1048. {
  1049. Log3 $hash, 4, "EIB_ParseByDatapointType: $name, origval= $value could not be translated, Group= $gnr, Model= $model, code= $code, unit= $unit"; #MH
  1050. }
  1051. return $value;
  1052. }
  1053. #############################
  1054. sub
  1055. eib_hex2name($)
  1056. {
  1057. my $v = shift;
  1058. my $p1 = hex(substr($v,0,1));
  1059. my $p2 = hex(substr($v,1,1));
  1060. my $p3 = hex(substr($v,2,2));
  1061. my $r = sprintf("%d/%d/%d", $p1,$p2,$p3);
  1062. return $r;
  1063. }
  1064. #############################
  1065. sub
  1066. eib_name2hex($)
  1067. {
  1068. my $v = shift;
  1069. my $r = $v;
  1070. # Log(5, "name2hex: $v");
  1071. if($v =~ /^([0-9]{1,2})\/([0-9]{1,2})\/([0-9]{1,3})$/) {
  1072. $r = sprintf("%01x%01x%02x",$1,$2,$3);
  1073. }
  1074. elsif($v =~ /^([0-9]{1,2})\.([0-9]{1,2})\.([0-9]{1,3})$/) {
  1075. $r = sprintf("%01x%01x%02x",$1,$2,$3);
  1076. }
  1077. return $r;
  1078. }
  1079. 1;
  1080. =pod
  1081. =begin html
  1082. <a name="EIB"></a>
  1083. <h3>EIB / KNX</h3>
  1084. <div>
  1085. <p>EIB/KNX is a standard for building automation / home automation.
  1086. It is mainly based on a twisted pair wiring, but also other mediums (ip, wireless) are specified.</p>
  1087. <p>While the module <a href="#TUL">TUL</a> represents the connection to the EIB network,
  1088. the EIB modules represent individual EIB devices. This module provides a basic set of operations (on, off, on-till, etc.)
  1089. to switch on/off EIB devices. Sophisticated setups can be achieved by combining a number of
  1090. EIB module instances or by sending raw hex values to the network (set &lt;devname&gt; raw &lt;hexval&gt;).</p>
  1091. <p>EIB/KNX defines a series of Datapoint Type as standard data types used
  1092. to allow general interpretation of values of devices manufactured by different companies.
  1093. These datatypes are used to interpret the status of a device, so the state in FHEM will then
  1094. show the correct value.</p>
  1095. <p><a name="EIBdefine"></a> <b>Define</b></p>
  1096. <div>
  1097. <code>define &lt;name&gt; EIB &lt;main group&gt; [&lt;additional group&gt; ..]</code>
  1098. <p>Define an EIB device, connected via a <a href="#TUL">TUL</a>. The
  1099. &lt;group&gt; parameters are either a group name notation (0-15/0-15/0-255) or the hex representation of the value (0-f0-f0-ff).
  1100. The &lt;main group&gt; is used for sending of commands to the EIB network.</p>
  1101. <p>The state of the instance will be updated when a new state is received from the network for any of the given groups.
  1102. This is useful for example for toggle switches where a on command is send to one group and the real state (on or off) is
  1103. responded back on a second group.</p>
  1104. <p>For actors and sensors the <a href="#autocreate">autocreate</a> module may help.</p>
  1105. <p>Example:</p>
  1106. <pre>
  1107. define lamp1 EIB 0/10/12
  1108. define lamp1 EIB 0/10/12 0/0/5
  1109. define lamp1 EIB 0A0C
  1110. </pre>
  1111. </div>
  1112. <p><a name="EIBset"></a> <b>Set</b></p>
  1113. <div>
  1114. <code>set &lt;name&gt; &lt;value&gt; [&lt;time&gt; g&lt;groupnr&gt;]</code>
  1115. <p>where value one of:</p>
  1116. <li><b>on</b> switch on device</li>
  1117. <li><b>off</b> switch off device</li>
  1118. <li><b>on-for-timer</b> &lt;secs&gt; switch on the device for the given time. After the specified seconds a switch off command is sent.</li>
  1119. <li><b>on-till</b> &lt;time spec&gt; switches the device on. The device will be switched off at the given time.</li>
  1120. <li><b>raw</b> &lt;hexvalue&gt; sends the given value as raw data to the device.</li>
  1121. <li><b>value</b> &lt;decimal value&gt; transforms the value according to the chosen model and send the result to the device.</li>
  1122. <p>Example:</p>
  1123. <pre>
  1124. set lamp1 on
  1125. set lamp1 off
  1126. set lamp1 on-for-timer 10
  1127. set lamp1 on-till 13:15:00
  1128. set lamp1 raw 234578
  1129. set lamp1 value 23.44
  1130. </pre>
  1131. <p>When as last argument a g&lt;groupnr&gt; is present, the command will be sent
  1132. to the EIB group indexed by the groupnr (starting by 1, in the order as given in Define).</p>
  1133. <pre>
  1134. define lamp1 EIB 0/10/01 0/10/02
  1135. set lamp1 on g2 (will send "on" to 0/10/02)
  1136. </pre>
  1137. <p>A dimmer can be used with a slider as shown in following example:</p>
  1138. <pre>
  1139. define dim1 EIB 0/0/5
  1140. attr dim1 model percent
  1141. attr dim1 webCmd value
  1142. </pre>
  1143. <p>The current date and time can be sent to the bus by the following settings:</p>
  1144. <pre>
  1145. define timedev EIB 0/0/7
  1146. attr timedev model time
  1147. attr timedev eventMap /value now:now/
  1148. attr timedev webCmd now
  1149. define datedev EIB 0/0/8
  1150. attr datedev model date
  1151. attr datedev eventMap /value now:now/
  1152. attr datedev webCmd now
  1153. # send every midnight the new date
  1154. define dateset at *00:00:00 set datedev value now
  1155. # send every hour the current time
  1156. define timeset at +*01:00:00 set timedev value now
  1157. </pre>
  1158. </div>
  1159. <p><a name="EIBget"></a> <b>Get</b></p>
  1160. <div>
  1161. <p>If you execute get for a EIB/KNX-Element there will be requested a state from the device. The device has to be able to respond to a read - this is not given for all devices.<br>
  1162. The answer from the bus-device is not shown in the toolbox, but is treated like a regular telegram.</p>
  1163. </div>
  1164. <p><a name="EIBattr"></a> <b>Attributes</b></p>
  1165. <div>
  1166. <a href="#IODev">IODev</a><br>
  1167. <a href="#alias">alias</a><br>
  1168. <a href="#comment">comment</a><br>
  1169. <a href="#devStateIcon">devStateIcon</a><br>
  1170. <a href="#devStateStyle">devStateStyle</a><br>
  1171. <a href="#do_not_notify">do_not_notify</a><br>
  1172. <a href="#dummy">dummy</a><br>
  1173. <a href="#readingFnAttributes">readingFnAttributes</a><br>
  1174. <a href="#event-aggregator">event-aggregator</a><br>
  1175. <a href="#event-min-interval">event-min-interval</a><br>
  1176. <a href="#event-on-change-reading">event-on-change-reading</a><br>
  1177. <a href="#event-on-update-reading">event-on-update-reading</a><br>
  1178. <a href="#eventMap">eventMap</a><br>
  1179. <a href="#group">group</a><br>
  1180. <a href="#icon">icon</a><br>
  1181. <a href="#ignore">ignore</a><br>
  1182. <a href="#room">room</a><br>
  1183. <a href="#showtime">showtime</a><br>
  1184. <a href="#sortby">sortby</a><br>
  1185. <a href="#stateFormat">stateFormat</a><br>
  1186. <a href="#userReadings">userReadings</a><br>
  1187. <a href="#userattr">userattr</a><br>
  1188. <a href="#verbose">verbose</a><br>
  1189. <a href="#webCmd">webCmd</a><br>
  1190. <a href="#widgetOverride">widgetOverride</a><br>
  1191. <br>
  1192. <p><a name="EIBreadingX"></a> <b>EIBreadingX</b></p>
  1193. <div>
  1194. Enable additional readings for this EIB-device. With this Attribute set, a reading setG&lt;x&gt; will be updated when a set command is issued from FHEM, a reading getG&lt;x&gt; will be updated as soon a Value is received from EIB-Bus (&lt;x&gt; stands for the groupnr. - see define statement). The logic for the state reading remains unchanged. This is especially useful when the define statement contains more than one group parameter.
  1195. <p>If set to 1, the following additional readings will be available:</p>
  1196. <pre>
  1197. setGx will be updated on a SET command issued by FHEM. &lt;x&gt; stands for the groupnr. - see define statement
  1198. getGx will be updated on reception of a message from EIB-bus.
  1199. </pre>
  1200. <p>Example:</p>
  1201. <pre>
  1202. define myDimmer EIB 0/1/1 0/1/2
  1203. attr myDimmer EIBreadingX 1
  1204. attr myDimmer model dpt1 dpt5 # GA 0/1/1 will be interpreted as on/off, GA 0/1/2 will be handled as dpt5
  1205. attr myDimmer stateFormat getG2 % # copies actual dim-level (as received from dimmer) into STATE
  1206. </pre>
  1207. <p>If the EIBreadingX is set, you can specify multiple blank separated models to cope with multiple groups in the define statement. The setting cannot be done thru the pulldown-menu, you have to specify them with <code>attr &lt;device&gt; model &lt;dpt1&gt; &lt;dpt2&gt; &lt;dpt3&gt;</code></p>
  1208. </div>
  1209. <p><a name="EIBreadingSender"></a> <b>EIBreadingSender</b></p>
  1210. <div>
  1211. Enable an additional reading for this EIB-device. With this Attribute set, a reading sender will be updated any time a new telegram arrives.
  1212. <p>If set to 1, the following additional reading will be available: <pre>sender</pre></p>
  1213. <pre>
  1214. sender will be updated any time a new telegram arrives at this group-adress
  1215. </pre>
  1216. <p>Example:</p>
  1217. <pre>
  1218. define myDimmer EIB 0/1/1
  1219. attr myDimmer EIBreadingSender 1
  1220. </pre>
  1221. </div>
  1222. <p><a name="EIBanswerReading"></a> <b>EIBanswerReading</b></p>
  1223. <div>
  1224. If enabled, FHEM answers on read requests. The content of state is send to the bus as answer.
  1225. <p>If set to 1, read-requests are answered</p>
  1226. <p>Example:</p>
  1227. <pre>
  1228. define myValue EIB 0/1/1
  1229. attr myValue EIBanswerReading 1
  1230. </pre>
  1231. </div>
  1232. <p><a name="EIBreadingRegex"></a> <b>EIBreadingRegex</b></p>
  1233. <div>
  1234. You can pass n pairs of regex-pattern and string to replace, seperated by a slash. Internally the "new" state is always in the format getG[n]:[state]. The substitution is done every time, a new object is received. You can use this function for converting, adding units, having more fun with icons, ...
  1235. This function has only an impact on the content of state - no other functions are disturbed.
  1236. <p>Example:</p>
  1237. <pre>
  1238. define myLamp EIB 0/1/1 0/1/2 0/1/2
  1239. attr myLamp EIBreadingRegex getG[1]:/steuern: getG[2]:/status: getG[3]:/sperre:
  1240. attr myLamp EIBreadingRegex devStateIcon status.on:general_an status.off:general_aus sperre.on:lock
  1241. </pre>
  1242. </div>
  1243. <p><a name="EIBwritingRegex"></a> <b>EIBwritingRegex</b></p>
  1244. You can pass n pairs of regex-pattern and string to replace, seperated by a slash. Internally the "new" state is always in the format setG1:[state]. The substitution is done every time, after an object is send. You can use this function for converting, adding units, having more fun with icons, ...
  1245. This function has only an impact on the content of state - no other functions are disturbed.
  1246. <p>Example:</p>
  1247. <pre>
  1248. define myLockObject EIB 0/1/1
  1249. attr myLamp EIBwritingRegex setG1:on/LOCKED setG1:/UNLOCKED
  1250. </pre>
  1251. </div>
  1252. <p><a name="model"></a> <b>model</b></p>
  1253. <div>
  1254. <p>This attribute is mandatory!</p>
  1255. Set the model according to the datapoint types defined by the (<a href="http://www.sti.uniurb.it/romanell/110504-Lez10a-KNX-Datapoint%20Types%20v1.5.00%20AS.pdf" target="_blank">EIB / KNX specifications</a>). The device state in FHEM is interpreted and shown according to the specification.<br>
  1256. <br>
  1257. <U>dpt1</U> - 1 bit<br>
  1258. Will be interpreted as on/off, 1=on 0=off and vice versa<br>
  1259. <br>
  1260. <U>dpt3</U> - Discrete Dim-Message<br>
  1261. Usage: set value to +/-0..100. -54 means dim down by 50%<br>
  1262. <br>
  1263. <U>dpt5</U> - 1 byte unsigned<br>
  1264. dpt5.003 - angle in degrees<br>
  1265. angle - same as dpt5.003<br>
  1266. dpt5.004 - percent<br>
  1267. percent - same as above<br>
  1268. percent255 - scaled percentage: 255=100%<br>
  1269. <br>
  1270. <U>dpt6</U> - 1 byte signed <br>
  1271. dpt6.001 - percent<br>
  1272. dpt6.010<br>
  1273. <br>
  1274. <U>dpt7</U> - 2 byte unsigned<br>
  1275. length - mm<br>
  1276. current - mA<br>
  1277. brightness<br>
  1278. timeperiod - ms<br>
  1279. timeperiod - min<br>
  1280. timeperiod - h<br>
  1281. <br>
  1282. <U>dpt9</U> - 2 byte float<br>
  1283. tempsensor<br>
  1284. lightsensor<br>
  1285. speedsensor<br>
  1286. speedsensor-km/h<br>
  1287. pressuresensor<br>
  1288. rainsensor<br>
  1289. time1sensor<br>
  1290. time2sensor<br>
  1291. humiditysensor<br>
  1292. airqualitysensor<br>
  1293. voltage-mV<br>
  1294. current-mA2<br>
  1295. current-mA2<br>
  1296. power<br>
  1297. powerdensity<br>
  1298. <br>
  1299. <U>dpt10</U> - time hh:mm:ss<br>
  1300. dpt10_ns - same as DPT10, seconds always 0<br>
  1301. time - receiving has no effect, sending any value contains actual system time. For examle use set timedev value now<br>
  1302. <br>
  1303. <U>dpt11</U> - date dd.mm.yyyy<br>
  1304. date - receiving has no effect, sending any value contains actual system date. For examle use set timedev value now<br>
  1305. <br>
  1306. <U>dpt12</U> - 4 byte unsigned<br>
  1307. <br>
  1308. <U>dpt13</U> - 4 byte signed<br>
  1309. <br>
  1310. <U>dpt14</U> - 4 byte float<br>
  1311. <br>
  1312. <U>dpt16</U> - text, use with "string": set textdev string Hallo Welt<br>
  1313. </div>
  1314. </div>
  1315. =end html
  1316. =cut