commandref_frame_DE.html 84 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <head>
  4. <title>FHEM Referenz</title>
  5. <script type="text/javascript" src="fhemdoc.js"></script>
  6. <noscript>
  7. <link rel="stylesheet" type="text/css" href="../www/pgm2/style.css" />
  8. </noscript>
  9. <meta http-equiv="Content-type" content="text/html; charset=UTF-8">
  10. <link rel="shortcut icon" href="/fhem/icons/favicon.ico"/>
  11. </head>
  12. <body style="word-wrap: break-word;">
  13. <div id="menuScrollArea">
  14. <div id="logo"></div>
  15. <div id="menu">
  16. <h3>fhem.pl Referenz</h3>
  17. <br><br>
  18. <a href="#doctop">Zum Anfang</a>
  19. <br><br>
  20. <a style="display:none" href="#" name="loadAll">Komplette Doku laden</a>
  21. <br><br>
  22. <a id="otherLang" style="display:none" href="#" name="otherLang">
  23. <span style="display:none" lang="DE">Deutsche</span>
  24. <span style="display:none" lang="EN">Englische</span>
  25. Doku f&uuml;r <span class="mod"></span> laden
  26. </a>
  27. </div>
  28. </div>
  29. <div id="right">
  30. <a name="doctop"></a>
  31. <h3>Inhalt</h3>
  32. <ul>
  33. <a href="#intro">Einleitung</a><br>
  34. <a href="#command">FHEM Befehls-Typen</a><br>
  35. <a href="#devspec">Ger&auml;te-Spezifikation</a><br>
  36. <a href="#attributes">Attribute</a><br>
  37. <br>
  38. <b>FHEM-Befehle</b>
  39. <ul>
  40. <!-- header:command -->
  41. <a href="#apptime">apptime</a> &nbsp; <!-- liefert Daten &uuml;ber Ausf&uuml;hrungszeiten -->
  42. <a href="#attr">attr</a> &nbsp; <!-- setzt ein Attribut f&uuml;r ein FHEM Ger&auml;t -->
  43. <a href="#cancel">cancel</a> &nbsp; <!-- bricht ein sleep ab -->
  44. <a href="#createlog">createlog</a> &nbsp; <!-- f&uuml;gt ein FileLog und ein SVG an einem existierenden FHEM Ger&auml;t -->
  45. <a href="#define">define</a> &nbsp; <!-- definiert ein FHEM Ger&auml;t -->
  46. <a href="#defmod">defmod</a> &nbsp; <!-- definiert oder modifiziert ein FHEM Ger&auml;t -->
  47. <a href="#delete">delete</a> &nbsp; <!-- entfernt ein FHEM Ger&auml;t -->
  48. <a href="#deleteattr">deleteattr</a> &nbsp; <!-- entfernt ein Attribut -->
  49. <a href="#deletereading">deletereading</a> &nbsp; <!-- entfernt ein Reading -->
  50. <a href="#displayattr">displayattr</a> &nbsp; <!-- zeigt Attribute eines FHEM Ger&auml;tes -->
  51. <a href="#get">get</a> &nbsp; <!-- holt ein Wert von einem FHEM Ger&auml;t -->
  52. <a href="#IF">IF</a> &nbsp; <!-- bedingte Ausf&uuml;hrung von FHEM Befehlen -->
  53. <a href="#include">include</a> &nbsp; <!-- liest eine Datei mit FHEM Befehlen ein -->
  54. <a href="#inform">inform</a> &nbsp; <!-- zeigt Events in einer telnet Verbindung -->
  55. <a href="#list">list</a> &nbsp; <!-- zeigt Definition,Readings und Attribute eines FHEM Ger&auml;tes -->
  56. <a href="#modify">modify</a> &nbsp; <!-- &auml;ndert die Definition eines FHEM Ger&auml;tes -->
  57. <a href="#notice">notice</a> &nbsp; <!-- zeigt und best&auml;tigt Systemmeldungen -->
  58. <a href="#quit">quit</a> &nbsp; <!-- endet eine telnet Verbindung zu FHEM -->
  59. <a href="#reload">reload</a> &nbsp; <!-- l&auml;dt ein FHEM Modul (Programmdefinition) -->
  60. <a href="#rename">rename</a> &nbsp; <!-- benennt ein FHEM Ger&auml;t um -->
  61. <a href="#rereadcfg">rereadcfg</a> &nbsp; <!-- l&auml;dt die FHEM Konfiguration neu -->
  62. <a href="#save">save</a> &nbsp; <!-- speichert die FHEM Konfiguration -->
  63. <a href="#set">set</a> &nbsp; <!-- setzt ein Wert in einem FHEM Ger&auml;t -->
  64. <a href="#setdefaultattr">setdefaultattr</a> &nbsp; <!-- definiert ein "default" Attribut -->
  65. <a href="#setreading">setreading</a> &nbsp; <!-- setzt ein Reading f&uuml;r ein FHEM Ger&auml;t -->
  66. <a href="#setstate">setstate</a> &nbsp; <!-- setzt den Status eines FHEM Ger&aumles -->
  67. <a href="#shutdown">shutdown</a> &nbsp; <!-- beendet FHEM -->
  68. <a href="#sleep">sleep</a> &nbsp; <!-- verz&ouml;gerte Ausf&uuml;hrung -->
  69. <a href="#trigger">trigger</a> &nbsp; <!-- generiert ein FHEM Event -->
  70. <a href="#usb">usb</a> &nbsp; <!-- sucht nach USB Ger&auml;ten -->
  71. </ul>
  72. <br>
  73. <b>Ger&auml;temodule</b>
  74. <ul>
  75. <a href="#global">global</a><br>
  76. <!-- header:device -->
  77. </ul>
  78. <br>
  79. <b>Hilfs (Erweiterungs-) Module</b>
  80. <ul>
  81. <!-- header:helper -->
  82. </ul>
  83. <br>
  84. <a href="#perl">PERL Besonderheiten</a><br>
  85. <a href="#gnuplot-syntax">gnuplot file Syntax</a><br>
  86. </ul>
  87. <a name="intro"></a>
  88. <h3>Einleitung</h3>
  89. <ul>
  90. <p>FHEM wird haupts&auml;chlich zur Heimautomatisierung benutzt,
  91. ist aber ebenso f&uuml;r andere Aufgaben einsetzbar wo Benachrichtigungen,
  92. Zeitschaltungen und Datensammlungen eine wichtige Rolle spielen.</p>
  93. <p>FHEM unterst&uuml;tzt verschiedene Hardwareger&auml;te die eine
  94. Verbindung mittels unterschiedlicher Protokolle (z.B. FHZ1000 mit Interfaces vom
  95. Typ FS20 und HMS, CM11 um mit X10 zu arbeiten) sowie logischer Ger&auml;te wie FS20
  96. oder FHT die einen Nachrichtenaustausch mit verschiedensten Ger&auml;ten die diese
  97. Protokolle verwenden erm&ouml;glichen.</p>
  98. <p>
  99. FHEM ist modular. Abh&auml;ngig von den unterschiedlichen Ger&auml;ten werden in den
  100. Modulen verschiedene Funktionen (z.B. define, get, set) realisiert. FHEM enth&auml;lt
  101. weitere Funktionen wie Trigger (<a href="#notify">notify</a>),
  102. Zeitabh&auml;ngige Funktionen (<a href="#at">at</a>)
  103. die die Funktionalit&auml;t erweitern.</p>
  104. <p>
  105. FHEM wird entweder &uuml;ber einfache ASCII-Kommandozeilen gesteuert die in Dateien
  106. wie z.B. der Konfigurationsdatei fhem.cfg gespeichert sind oder &uuml;ber eine TCP/IP
  107. Verbindung, entweder direkt in einer "telnet"-Sitzung, oder per fhem.pl im
  108. Client-Modus oder &uuml;ber eines der Webfrontends.<br> &nbsp;</p>
  109. <p class="MsoNormal">Wenn Sie den FHEM-Server starten, m&uuml;ssen Sie eine
  110. Konfigurationsdatei ausw&auml;hlen:</p>
  111. <ul>
  112. <code>perl fhem.pl fhem.cfg</code>
  113. </ul>
  114. &nbsp;<p>Nachstehend eine Minimal-Konfiguration Datei: </p><pre>
  115. attr global <a href="#logfile">logfile</a> log/fhem.log
  116. attr global <a href="#modpath">modpath</a> .
  117. attr global <a href="#statefile">statefile</a> log/fhem.save
  118. attr global <a href="#verbose">verbose</a> 3
  119. define telnetPort <a href="#telnet">telnet</a> 7072 global
  120. define WEB <a href="#FHEMWEB">FHEMWEB</a> 8083 global</pre>
  121. Die letzten zwei Zeilen definieren einen telnet und einen WEB Zugang, beide k&ouml;nnen aber
  122. bei Bedarf auch abgeschaltet werden.<br><br>
  123. Die WEB Schnittstelle kann &uuml;ber
  124. <ul>
  125. http://&lt;fhemhost&gt;:8083
  126. </ul>
  127. erreicht werden.
  128. <br><br>
  129. Die Kommunikation mit FHEM kann entweder in einer "session" (&uuml;ber telnet) oder
  130. &uuml;ber einzelne Klient-Kommandos (&uuml;ber fhem.pl) erfolgen. Beispiel:
  131. <ul>
  132. <code>telnet &lt;fhemhost&gt; 7072<br>
  133. &lt;NL&gt; </code>(Die Bet&auml;tigung der &quot;Enter&quot;-Taste schaltet in den&nbsp; "prompt"
  134. Modus)<code><br>
  135. &lt;command&gt;...<br>
  136. quit</code><br>
  137. </ul>
  138. oder
  139. <ul>
  140. <code>fhem.pl &lt;fhemhost&gt;:7072 "&lt;command&gt;..."</code>
  141. </ul>
  142. <br>
  143. Falls FHEM als root gestartet wurde, und ein OS-Benutzer fhem existiert, dann
  144. wechselt FHEM nach dem start zu diesem Benutzer (via setuid). <br>
  145. </ul>
  146. <br>
  147. <!-- intro end - diese Zeile nicht entfernen! -->
  148. <a name="command"></a>
  149. <h3>FHEM Befehlstypen</h3>
  150. <ul>
  151. Es gibt drei Arten von Befehlen: "fhem" Befehle (werden in diesem Dokument
  152. beschrieben), SHELL-Befehle (diese m&uuml;ssen von doppelten
  153. Anf&uuml;hrungszeichen "" eingeschlossen werden) und PERL-Ausdr&uuml;cken (von
  154. geschwungenen Klammern {} eingeschlossen). SHELL-Befehle oder
  155. PERL-Ausdr&uuml;cke werden f&uuml;r komplexe <a href="#at">at</a> oder <a
  156. href="#notify">notify</a> Ausdr&uuml;cke ben&ouml;tigt, k&ouml;nnen aber auch
  157. als "normale" Befehle angewendet werden.
  158. <br>
  159. <br>
  160. Die folgenden drei Befehle bewirken z.B. dasselbe Ergebnis, wenn sie am
  161. telnet-Prompt eingegeben werden:
  162. <ul>
  163. set lamp off<br>
  164. "fhem.pl 7072 "set lamp off""<br>
  165. {fhem("set lamp off")}<br>
  166. </ul>
  167. SHELL-Kommandos werden im Hintergrund ausgef&uuml;hrt,
  168. PERL-Ausdr&uuml;cke und FHEM-Kommandos werden im Haupt-"thread" ausgef&uuml;hrt. Um
  169. PERL-Ausdr&uuml;cke leichter eingeben zu k&ouml;nnen, sind einige Spezialfunktionen und
  170. Variablen verf&uuml;gbar. Lesen Sie sich bitte die Abschnitte <a href="#perl">
  171. Perl special</a> zum besseren Verst&auml;ndnis durch.</p>
  172. <p>Um FHEM-Befehle in einen SHELL-Script zu triggern (dies ist
  173. eine "andere" M&ouml;glichkeit), benutzen Sie bitte die oben beschriebene Client-Form
  174. der fhem.pl.
  175. <br>
  176. Mehrere FHEM-Kommandos hintereinander werden mittels
  177. Semikolon (;) getrennt. Weil Semikola auch in PERL-Code oder SHELL-Programmen
  178. benutzt werden, m&uuml;ssen sie mittels doppelten Semikola gesch&uuml;tzt werden. Lesen
  179. Sie sich bitte die <b>Bermerkungen </b>des <a href="#notify">notify</a>-Abschnittes zu Kommandoparametern und Regeln durch.
  180. <br>
  181. Z.B. schaltet die erste der folgenden Befehlszeilen die Lampe 1 nur/erst zur
  182. Uhrzeit 07:00 Uhr aus, die Lampe 2 aber sofort und die zweite Befehlszeile
  183. schaltet Lampe 1 und 2 um 7:00 Uhr gleichzeitig aus.
  184. <ul>
  185. define lampoff at 07:00 set Lamp1 off; set Lamp2 off<br>
  186. define lampoff at 07:00 set Lamp1 off;; set Lamp2 off<br>
  187. </ul>
  188. <br>
  189. F&uuml;r jede weitere Indirektion muss man die Strichpunkte verdoppeln. Um also die beiden Lampen um 7:00 f&uuml;r 10 Minuten einzuschalten schreibt man:
  190. <ul>
  191. define onAt at 07:00 set Lamp1 on;;set Lamp2 on;; define offAt at +00:10 set Lamp1 off;;;;set Lamp2 off
  192. </ul>
  193. Keine Angst, das Vorherige kann in FHEM auch deutlich einfacher formuliert werden als:
  194. <ul>
  195. define onAt at 07:00 set Lamp1,Lamp2 on-for-timer 600
  196. </ul>
  197. <br>
  198. Befehle k&ouml;nnen entweder direkt eingegeben oder aus einer Datei (z.B. am
  199. Start von FHEM aus der Konfugurationsdatei) eingelesen werden. Die Befehle
  200. werden entweder direkt ausgef&uuml;hrt oder sp&auml;ter wenn sie als Argumente
  201. eines <a href="#at">at</a> oder <a href="#notify">notify</a>-Befehles verwendet
  202. werden.
  203. <p>Eine mit einem \ abgeschlossene Zeile wird mit der
  204. nachfolgenden Zeile verbunden. Somit k&ouml;nnen lange Befehlszeilen (die z.B. aus
  205. mehreren PERL-Befehlen bestehen) auf mehrere Zeilen aufgteilt werden. Einige
  206. Web-Frontends (z.B. webpgm2) erleichtern die Eingabe von sich &uuml;ber mehrere
  207. Zeilen erstreckende Befehle, indem man keine \ am Zeilenende eingeben muss.</p>
  208. <p>&nbsp;</p>
  209. </ul>
  210. <!-- command end - diese Zeile nicht entfernen! -->
  211. <a name="devspec"></a>
  212. <h3>Ger&auml;te-Spezifikation (devspec)</h3>
  213. <ul>
  214. Die Befehle
  215. <a href="#attr">attr</a>,
  216. <a href="#set">set</a>,
  217. <a href="#get">get</a>, usw.
  218. <a href="#attr">attr</a>,
  219. <a href="#deleteattr">deleteattr</a>,
  220. <a href="#displayattr">displayattr</a>,
  221. <a href="#delete">delete</a>,
  222. <a href="#get">get</a>,
  223. <a href="#list">list</a>,
  224. <a href="#set">set</a>,
  225. <a href="#setreading">setreading</a>,
  226. <a href="#setstate">setstate</a>,
  227. <a href="#trigger">trigger</a>
  228. k&ouml;nnen eine komplexere Ger&auml;tespezifikation als Argumente enthalten,
  229. die auch eine Anzahl von Ger&auml;ten betreffen kann. Eine
  230. Ger&auml;tespezifikation kann folgendes sein:
  231. <ul>
  232. <li>ein einzelner Ger&auml;tename. Dies ist der Normalfall</li>
  233. <li>eine durch Komma(,) getrennte Liste von Ger&auml;tenamen</li>
  234. <li>ein regul&auml;rer Ausdruck</li>
  235. <li>ein NAME=WERT Ausdruck, wo NAME ein "Internal" Wert wie TYPE ist, ein
  236. Reading-Name oder ein Attribut. WERT ist ein regul&auml;rer Ausdruck.
  237. Um die Bedingung zu negieren, muss NAME!=WERT verwendet werden.
  238. Um die Suche einzugrenzen, kann man als Praefix i: f&uuml;r internal
  239. Werte, r: f&uuml;r Reading-Namen und a: f&uuml;r Attribute verwenden,
  240. siehe das Beispiel unten. Gro&szlig;-/Kleinschreibung wird durch die
  241. Verwendung von ~ oder !~ ignoriert.
  242. </li>
  243. <li>Falls die Spezifikation von :FILTER=NAME=WERT gefolgt wird,
  244. dann wird die zuvor gefundene Liste durch diesen neuen Ausdruck
  245. gefiltert.
  246. </ul>
  247. Beispiele:
  248. <ul>
  249. <code>set lamp1 on</code><br>
  250. <code>set lamp1,lamp2,lamp3 on</code><br>
  251. <code>set lamp.* on</code><br>
  252. <code>set room=kitchen off</code><br>
  253. <code>set room=kitchen:FILTER=STATE=on off</code><br>
  254. <code>set room=kitchen:FILTER=STATE!=off off</code><br>
  255. <code>list disabled=</code><br>
  256. <code>list room~office</code><br>
  257. <code>list TYPE=FS20 STATE</code><br>
  258. <code>list i:TYPE=FS20 STATE</code><br>
  259. </ul>
  260. Bemerkungen:
  261. <ul>
  262. <li>die Spezifikation kann keine Leerzeichen enthalten.</li>
  263. <li>falls ein Ger&auml;tename exakt dem Spezifikation entspricht, dann werden
  264. keine regul&auml;re Ausdr&uuml;cke oder Filter ausgewertet.
  265. <li>zuerst wird die durch Komma getrennte Spezifikation abgearbeitet, dann
  266. folgen die regul&auml;ren Ausdr&uuml;cke und die Filter</li>
  267. <li>die Befehlszeile kann die selbe Ger&auml;tebezeichnung mehrfach enthalten
  268. z.B.: &quot;set lamp3,lamp3 on&quot;. Lamp3 wird hier zwei Mal
  269. eingeschalten.</li>
  270. <li>um Strukturen mit komplexeren Anforderungen zu realisieren lesen Sie
  271. bitte den Abschnitt zu <a href="#structure"> structure</a>.
  272. </ul>
  273. </ul>
  274. <!-- devspec end - diese Zeile nicht entfernen! -->
  275. <a name="attributes"></a>
  276. <h3>Attribute</h3>
  277. Alle Ger&auml;te haben Attribute. Diese werden mittels des Befehls <a
  278. href="#attr">attr</a> gesetzt, angezeigt mit dem Befehl <a
  279. href="#displayattr">displayattr</a>, und mit dem Kommando <a
  280. href="#deleteattr">deleteattr</a> entfernt.<p>
  281. Es gibt globale Attribute, die von allen Ger&auml;ten genutzt werden, und lokale
  282. Attribute, die nur auf individuelle Ger&auml;teklassen zutreffen.<p>
  283. Manche Ger&auml;te (wie <a href="#FHEMWEB">FHEMWEB</a>) definieren automatisch
  284. neue globale Attribute bei der ersten Definition eines Ger&auml;tes dieses
  285. Typs.<p>
  286. Sie k&ouml;nnen den Befehl<p><code>attr global userattr
  287. &lt;attributelist&gt;</code><p> f&uuml;r das Ger&auml;t <a
  288. href="#global">global</a> verwenden, um neue globale Attribute zu deklarieren,
  289. und <p><code>attr &lt;devicespec&gt; userattr
  290. &lt;attributelist&gt;</code>,<p>um neue lokale Attribute f&uuml;r bestimmte
  291. individuelle Ger&auml;te gem&auml;&szlig <a href="#devspec">devspec</a> zu
  292. deklarieren.
  293. <code>&lt;attributelist&gt;</code> ist eine durch Leerzeichen getrennte Liste,
  294. die die Namen der zus&auml;tzlichen Attribute enth&auml;lt. In der
  295. Dokumentation zum Befehl <a href="#attr">attr</a> sind Beispiele.<p>
  296. Seien Sie vorsichtig und &uuml;berschreiben Sie keine zus&auml;tzlichen
  297. globale Attribute, die bereits zuvor durch Sie selbst oder ein Ger&auml;t
  298. definiert wurden. <code>attr global userattr &lt;attributelist&gt;</code>
  299. sollte so fr&uuml;h wie m&ouml;glich in der Konfiguration erscheinen.
  300. <h4>Ger&auml;tespezifische Attribute</h4>
  301. Ger&auml;tespezifische Attribute sind in dem jeweiligen Abschnitt zum
  302. Ger&auml;t dokumentiert.
  303. <h4>Globale Attribute f&uuml;r alle Ger&auml;te</h4>
  304. <ul>
  305. <a name="alias"></a>
  306. <li>alias<br>
  307. Wird in FHEMWEB benutzt, um ein en anderen Namen f&uuml;r ein Ger&auml;t
  308. anzuzeigen z.B. wenn Sonderzeichen/Leerzeichen nicht in der
  309. Ger&auml;tedefinition verwendet werden k&ouml;nnen.
  310. </li><br>
  311. <a name="comment"></a>
  312. <li>comment<br>
  313. F&uuml;gt einen beliebigen Kommentar hinzu.
  314. </li><br>
  315. <a name="eventMap"></a>
  316. <li>eventMap<br>
  317. Ersetze Event Namen und setze Argumente. Der Wert dieses Attributes
  318. besteht aus einer Liste von durch Leerzeichen getrennte Werten. Jeder
  319. Wert ist ein durch Doppelpunkt getrenntes Paar. Der erste Teil stellt den
  320. "alten" Wert, der zweite Teil den "neuen" Wert dar. Wenn der erste Wert
  321. ein Slash (/) oder ein Komma (,) ist, dann wird nicht durch Leerzeichen
  322. sondern durch das vorgestellte Zeichen getrennt.
  323. Optional kann man auch ein widgetOverride angeben (angeh&auml;ngt nach
  324. einem Doppelpunkt (z.Bsp. on-for-timer:OnFor:texField). Die
  325. Voreinstellung ist :noArg, um das Input Feld bei cmdList zu vermeiden.
  326. Beispiele:
  327. <ul><code>
  328. attr store eventMap on:open off:closed<br>
  329. attr store eventMap /on-for-timer 10:open/off:closed/<br>
  330. set store open
  331. </code></ul>
  332. Die explizite Variante dieses Attributes hat folgenden Syntax:
  333. <ul><code>
  334. attr store eventMap { dev=>{'on'=>'open'}, usr=>{'open'=>'on'} }<br>
  335. attr store eventMap { dev=>{'^on(-for-timer)?(.*)'=>'open$2'},
  336. usr=>{'^open(.*)'=>'on$1'},
  337. fw=>{'^open(.*)'=>'open'} }
  338. </code></ul>
  339. Diese Variante muss dann verwendet werden, falls das Mapping nicht
  340. symmetrisch ist. Der erste Teil (dev) spezifiziert dabei die Richtung
  341. Ger&auml;t zu Benutzer, d.h. falls das Ger&auml;t on 100 oder
  342. on-for-timer 100 meldet, dann wird der Benutzer open 100 zu sehen
  343. bekommen. Der zweite Teil (usr) spezifiziert die Richtung Benutzer zu
  344. Ger&auml;t, d.h. wenn man "set XX open 100" eingibt, dann wird das
  345. Kommando "on 100" an das Ger&auml;t gesendet. In beiden F&auml;llen wird
  346. der Schl&uuml;ssel zuerst direkt, und dann als Regexp mit dem Wert
  347. verglichen. Falls man Regexps mit Wildcards im usr Teil verwendet, dann
  348. muss man den fw Teil mit dem exakt gleichen Schl&uuml;sseln
  349. ausf&uuml;llen, damit FHEMWEB in der Detail-Ansicht den set-Auswahl
  350. richtig anzeigen kann.
  351. </li><br>
  352. <a name="genericDisplayType"></a>
  353. <li>genericDisplayType<br>
  354. Wird von bestimmten Frontends (aber nicht FHEMWEB) verwendet, um
  355. f&uuml;r das Ger&auml;t passende Voreinstellungen (Bild/Befehle/etc)
  356. anzubieten. Z.Zt werden folgende Werte unterst&uuml;tzt:
  357. switch,outlet,light,blind,speaker,thermostat
  358. </li><br>
  359. <a name="group"></a>
  360. <li>group<br>
  361. Ger&auml;tegruppen. FHEMWEB zeigt Ger&auml;te die in die gleiche Gruppe
  362. geh&ouml;ren auch in einer gemeinsamen Box an. Ein Ger&auml;t kann zu
  363. mehr als einer Gruppe geh&ouml;ren. In diesem Fall m&uuml;ssen die
  364. entsprechenden Gruppen durch Kommata getrennt eingetragen werden. Wenn
  365. dieses Attribut nicht gesetzt ist, wird der in der Ger&auml;tegruppe
  366. gesetzte Ger&auml;tetyp verwendet.
  367. </li><br>
  368. <a name="room"></a>
  369. <li>room<br>
  370. Filtert/gruppiert Ger&auml;te.
  371. Ein Ger&auml;t kann zu mehr als einem Raum zugeordnet werden. In diesem
  372. Fall m&uuml;ssen die Raumzuordnungen durch Kommata getrennt
  373. angegeben werden.<br>
  374. Ger&auml;te, die dem Raum mit der Bezeichnung "hidden" zugeordnet
  375. werden, erscheinen nicht auf der Webseite.
  376. Mit -&gt; werden R&auml;ume strukturiert, z.Bsp. OG-&gt;Schlafzimmer
  377. </li><br>
  378. <a name="showtime"></a>
  379. <li>showtime<br>
  380. Wird im FHEMWEB verwendet, um die Zeit der letzten Aktivit&auml;t
  381. anstelle des Status in der Gesamtansicht anzuzeigen. N&uuml;tzlich z.B.
  382. f&uuml;r FS20 PIRI Ger&auml;te.
  383. </li></br>
  384. <a name="suppressReading"></a>
  385. <li>suppressReading<br>
  386. Wird verwendet, um nicht gewollte Readings zu entfernen. Der Wert ist
  387. ein Regular Expression, erg&auml;nzt mit ^ und $. Wird nur in
  388. Ausnahmef&auml;llen ben&ouml;tigt.
  389. </li><br>
  390. <a name="verbose"></a>
  391. <li>verbose<br>
  392. Setzt den Schwellwert f&uuml;r die Logfile-Meldungen.
  393. M&ouml;gliche Werte sind:
  394. <ul>
  395. <li>0 - Server start/stop</li>
  396. <li>1 - Fehlermeldungen oder unbekannte Pakete</li>
  397. <li>2 - bedeutende Ereigbisse/Alarme.</li>
  398. <li>3 - ausgesendete Kommandos werden gelogged.</li>
  399. <li>4 - von den einzelnen Ger&auml;ten empfangene Daten.</li>
  400. <li>5 - Fehlersuche.</li>
  401. </ul>
  402. Der f&uuml;r die <a href="#global">global</a> Instanz gesetzte Wert gilt
  403. als Voreinstellung f&uuml;r die Instanzen, die dieses Attribut nicht
  404. gesetzt haben.
  405. </li><br>
  406. </ul>
  407. <a name="readingFnAttributes"></a>
  408. <h4>readingFnAttribute</h4>
  409. Die folgenden Attribute werden bei Modulen verwendet, die standardisierte
  410. "readings" Aktualisierung der fhem.pl benutzen. Informieren Sie sich in der
  411. Liste der Modulattribute wenn Sie wissen m&ouml;chten ob dies
  412. unterst&uuml;tzt wird.<br><br>
  413. <ul>
  414. <a name="stateFormat"></a>
  415. <li>stateFormat<br>
  416. &Auml;ndert den Ger&auml;testatus, dies ist z.Bsp. in der Ausgabe des list
  417. Kommandos zu sehen, oder in der Raum&uumlbersicht von FHEMWEB. Falls
  418. nicht gesetzt, dann wird das state Reading &uuml;bernommen. Sonst werden
  419. alle W&ouml;rter im Wert des Attributes durch das entsprechende Reading des
  420. Ger&auml;tes ersetzt (soweit vorhanden). Falls der Wert in {}
  421. eingeschlossen ist, dann wird es als Perl Ausdruck ausgewertet. Die
  422. Auswertung passiert bei jeder &Auml;nderung eines Readings.<br>
  423. Die <a href="#set">hier</a> beschriebene "set magic" wird auch angewendet.
  424. </li>
  425. <a name="event-on-update-reading"></a>
  426. <li>event-on-update-reading<br>
  427. Wenn nicht gesetzt, erzeugt jede Ver&auml;nderung eines "readings" ein
  428. Ereignis, welches z.B. von <a href="#notify">notify</a> oder<a
  429. href="FileLog"> FileLog</a> ber&uuml;cksichtigt wird. Wenn gesetzt erzeugen
  430. nur Aktualisierungen der eingetragenen "readings" ein Ereignis.
  431. </li>
  432. <a name="event-on-change-reading"></a>
  433. <li>event-on-change-reading<br>
  434. Dieses Attribut enth&auml;lt eine durch Kommata getrennte Liste von
  435. "readings". Wenn gesetzt, erzeugen nur Ver&auml;nderungen der gelisteten
  436. "readings" ein Ereignis. Wenn die aktualiserten Werte der gelisteten
  437. "readings" identisch sind, wird kein Ereignis generiert.<br>
  438. Wenn hinter dem Namen eines "readings" eine :Schwelle angegeben ist, wird
  439. das Event nur getriggert wenn die &Auml;nderung gr&ouml;sser als diese
  440. Schwelle ist.
  441. </li>
  442. Die unterschiedlichen Bedeutungen von event-on-update-reading und
  443. event-on-change-reading sind folgende:
  444. <ol>
  445. <li>Wenn beide Attribute nicht gesetzt sind erzeugt jede Aktualisierung
  446. eines jeden "readings" eines Ger&auml;tes ein Ereignis.</li>
  447. <li>Wenn eines der Attribute gesetzt ist, erzeugen nur Updates oder
  448. &auml;nderungen von "readings" die in einem der Attribute gesetzt
  449. sind ein Ereignis.</li>
  450. <li>Wenn ein "reading" in event-on-update-reading aufgef&uuml;hrt ist,
  451. erzeugt eine Aktualisierung ein Ereignis unabh&auml;ngig ob das
  452. "reading" auch in event-on-change-reading aufgelistet ist.</li>
  453. </ol>
  454. <a name="timestamp-on-change-reading"></a>
  455. <li>timestamp-on-change-reading<br>
  456. Dieses Attribut enth&auml;lt eine durch Kommata getrennte Liste von
  457. "readings". Wenn gesetzt, werden die Zeitstempel der gelisteten "readings"
  458. nicht aktualisiert wenn durch ein ebenfalls gesetztes event-on-change-reading
  459. f&uuml;r dieses "reading" kein Ereignis erzeugen w&uuml;rde.
  460. </li>
  461. <p>
  462. <a name="event-aggregator"></a>
  463. <li>event-aggregator</li>
  464. The primary uses of this attribute are to calculate (time-weighted) averages of
  465. readings over time periods and to throttle the update rate of readings and thus
  466. the amount of data written to the logs.<p>
  467. This attribute takes a comma-separated list of <code>reading:interval:method:function:holdTime</code>
  468. quintuples. You may use regular expressions for <code>reading</code>. If set, updates for the
  469. listed readings are ignored and associated events are suppressed for a black-out period of at
  470. least <code>interval</code> seconds (downsampling). After the black-out period has expired, the reading is
  471. updated with a value that is calculated from the values and timestamps of the previously ignored
  472. updates within the black-out period as follows:
  473. <table>
  474. <tr><th>function</th><th>description</th></tr>
  475. <tr><td>v</td><td>the last value encountered</td></tr>
  476. <tr><td>v0</td><td>the first value encountered</td></tr>
  477. <tr><td>min</td><td>the smallest value encountered</td></tr>
  478. <tr><td>max</td><td>the largest value encountered</td></tr>
  479. <tr><td>mean</td><td>the arithmetic mean of all values</td></tr>
  480. <tr><td>sd</td><td>the standard deviation from the mean</td></tr>
  481. <tr><td>median</td><td>the median of all values (requires holdTime and function none)</td></tr>
  482. <tr><td>integral</td><td>the arithmetic sum (if not time-weighted) or integral area (if time-weighted) of all values</td></tr>
  483. <tr><td>n</td><td>number of samples</td></tr>
  484. <tr><td>t</td><td>timestamp of the last value</td></tr>
  485. <tr><td>t0</td><td>timestamp of the first value</td></tr>
  486. </table>
  487. <p>
  488. If <code>method</code> is <code>none</code>, then that's all there is. If <code>method</code>
  489. is <code>const</code> or <code>linear</code>, the time-weighted series of values is taken into
  490. account instead. The weight is the timespan between two subsequent updates.
  491. With the <code>const</code> method, the value is the value of the reading at the beginning of
  492. the timespan; with the <code>linear</code> method, the value is the arithmetic average of
  493. the values at the beginning and the end of the timespan.
  494. Rollovers of black-out periods are handled as one would expect it.<p>
  495. One would typically use the <code>linear</code> method with the <code>mean</code> function for
  496. quantities continuously varying over time like electric power consumption, temperature or speed.
  497. For cumulative quantities like energy consumed, rain fallen or distance covered,
  498. the <code>none</code> method with the <code>v</code> function is used. The <code>constant</code>
  499. method is for discrete quantities that stay constant until the corresponding reading is updated,
  500. e.g. counters, switches and the like.<p>
  501. If the <code>holdTime</code> in seconds is defined, the samples will be kept in memory allowing
  502. the calculation of floating statistics instead of blocked statistics. With <code>holdTime</code>
  503. defined the <code>interval</code> can be kept undefined so that the readings update rate is unchanged
  504. or it can be set to a value less then <code>holdTime</code> for downsampling as described above
  505. with a full history of the readings in memory. Note that the historic samples are not persistent
  506. and will be lost when restarting FHEM.<p>
  507. The event aggregator only takes into consideration those updates that remain after preprocessing
  508. according to the <code>event-on-update-reading</code> and <code>event-on-change-reading</code>
  509. directives. Besides which, any update of a reading that occurs within a timespan from the preceding
  510. update that is smaller than the resolution of FHEM's time granularity is ditched.<p>
  511. When more than one function should be calculated for the same reading, the original reading must be
  512. multiplied (e.g. by using a notify) before applying the event-aggregator to the derived readings.<p>
  513. Examples:<br>
  514. <code>attr myPowerMeter event-aggregator EP_POWER_METER:300:linear:mean,EP_ENERGY_METER:300:none:v</code><br>
  515. <code>attr myBadSensor event-aggregator TEMP::none:median:300</code><br>
  516. <code>attr mySunMeter event-aggregator SUN_INTENSITY_24H::const:integral:86400</code>
  517. </li>
  518. <a name="event-min-interval"></a>
  519. <li>event-min-interval<br>
  520. Dieses Attribut enth&auml;lt eine durch Kommata getrennte Liste von
  521. "readings:minInterval" Paare. readings kann ein regexp sein. Ein Event wird
  522. nur dann generiert, falls seit dem letzten Auftreten des gleichen Events
  523. mindestens minInterval Sekunden vergangen sind. Falls
  524. event-on-change-reading auch spezifiziert ist, dann werden sie mit ODER
  525. kombiniert, d.h. wenn einer der beiden Bedingungen wahr ist.
  526. </li>
  527. <a name="oldreadings"></a>
  528. <li>oldreadings<br>
  529. Dieses Attribut enth&auml;lt eine durch Kommata getrennte Liste von
  530. Readings. regex sind erlaubt. F&uuml;r jedes Reading aus der Liste
  531. speichert FHEM intern den vorherigen Wert wenn sich das Reading
  532. &auml;ndert. Zum Zugriff auf die Werte gibt es die OldReadings.* Routinen.
  533. </li>
  534. <a name="userReadings"></a>
  535. <li>userReadings<br>
  536. Komma getrennte Liste von benutzerdefinierten Readings. Jede Definition hat
  537. folgendes Format:
  538. <ul><code>
  539. &lt;reading&gt;[:&lt;trigger&gt;] [&lt;modifier&gt;] { &lt;perl code&gt; }
  540. </code></ul>
  541. Diese benutzerdefinierte Readings werden bei jeder Aktualisierung der
  542. Ger&auml;tereadings gesetzt, indem das spezifizierte <a href="#perl">perl
  543. code</a> <code>{ &lt;perl code&gt; }</code> ausgef&uuml;hrt wird, und
  544. dessen Wert dem Reading zugewiesen wird.
  545. Falls &lt;trigger&gt; spezifiziert ist, dann findet diese Ausf&uuml;hrung
  546. nur dann statt, falls einer der aktualisierten Readings dem regexp
  547. &lt;trigger&gt; entspricht (matched). <br>
  548. Beispiele:
  549. <ul><code>
  550. attr myEnergyMeter userReadings energy
  551. { ReadingsVal("myEnergyMeter","counters.A",0)/1250.0;; }<br>
  552. attr myMultiMeter userReadings
  553. energy1:counters.A.* {ReadingsVal("myMultiMeter","counters.A",0)/1250.0},
  554. energy2:counters.B.* {ReadingsVal("myMultiMeter","counters.B",0)/1250.0}
  555. </code></ul>
  556. <code>&lt;modifier&gt;</code> kann die folgenden Werte haben:
  557. <ul>
  558. <li>none: als ob man es gar nicht spezifiziert h&auml;tte.</li>
  559. <li>difference: das Reading wird auf die Differenz zw. dem aktuellen und
  560. dem vorherigen Wert gesetzt.</li>
  561. <li>differential: das Reading wird auf die Differenz zw. dem aktuellen und
  562. dem vorherigen Wert, geteilt durch die Sekunden zw. der aktuellen Zeit
  563. und der letzten Auswertung, sekundengenau. Kein Wert wird berechnet,
  564. falls der Unterschied unter eine Sekunde liegt.</li>
  565. <li>integral: das Gegenteil von differential. Das Ergebnis wird um das
  566. Produkt aus der Zeit-Differenz und der Durschnittswert der letzten zwei
  567. Readings erh&ouml;ht.<br>
  568. result += (time - timeold) * (oldval + value) / 2
  569. </li>
  570. <li>offset: wenn der aktuellen Wert kleiner als der vorherige Wert ist
  571. wird der vorherige Wert zum Reading addiert. Das Reading kann dann als
  572. offset verwendet werden um einen Z&auml;hler der durch Sromverlust
  573. zur&uuml;ckgesetzt wird zu korrigieren.</li>
  574. <li>monotonic: wenn die Differenz zw. dem aktuellen und dem vorherigen
  575. Wert positiv ist wird diese Differenz zum Reading addiert. Damit
  576. l&auml;sst sich von einem Z&auml;hler der bei Stromverlust
  577. zur&uuml;ckgesetzt wird ein monoton wachsender Z&auml;hler
  578. ableiten.</li>
  579. </ul>
  580. Beispiel:
  581. <ul><code>
  582. attr myPowerMeter userReadings power differential
  583. { ReadingsVal("myPowerMeter","counters.A",0)/1250.0}
  584. </code></ul>
  585. Achtung:<ul>
  586. <li>Falls difference oder differential spezifiziert ist, dann werden
  587. f&uuml;r die Berechnung &auml;ltere Werte ben&ouml;tigt, d.h. der Wert
  588. wird fr&uuml;hestens beim zweiten &Auml;nderung gesetzt.</li>
  589. <li>der Name der definierten Readings besteht aus alphanumerischen
  590. Zeichen, Unterstrich (_) und Minus-Zeichen (-).</li>
  591. </ul>
  592. </li><br>
  593. </ul>
  594. <h4>Allgemeine Attribute</h4>
  595. Die folgenden lokalen Attribute werden von mehreren Ger&auml;ten verwendet:
  596. <ul>
  597. <a name="IODev"></a>
  598. <li>IODev<br>
  599. Setzt das IO oder das physische Device, welches zum Senden der Signale an
  600. dieses logische Device verwendet werden soll (Beispielsweise FHZ oder
  601. CUL). Hinweis: Beim Start weist FHEM jedem logischen Device das letzte
  602. physische Device zu, das Daten von diesem Typ empfangen kann. Das
  603. Attribut IODev muss nur gesetzt werden, wenn mehr als ein physisches
  604. Device f&auml;hig ist, Signale von diesem logischen Device zu empfangen.
  605. </li><br>
  606. <li>Attribut "disable" umschalten<br/>
  607. Das Attribut "disable" kann, sofern vom Ger&auml;temodul bereitgestellt,<br/>
  608. mit folgendem Befehl einfach umgeschaltet werden:</br>
  609. <br/>
  610. <code>attr &lt;device&gt; disable toggle</code><br/>
  611. </li>
  612. </ul>
  613. <!-- attributes end - diese Zeile nicht entfernen! -->
  614. <br><br>
  615. <a name="attr"></a>
  616. <h3>attr</h3>
  617. <ul>
  618. <code>attr [-a|-r] &lt;devspec&gt; &lt;attrname&gt; [&lt;value&gt;]</code><br>
  619. <br>
  620. Dieser Befehl setzt ein Attribut f&uuml;r ein Ger&auml;t welches mit <a
  621. href="#define">define</a> definiert wurde. value ist optional, und ist 1
  622. falls nicht spezifiziert. Sie k&ouml;nnen auch Ihre eigenen
  623. Attribute definieren, um sie in anderen Applikationen anzuwenden. Geben Sie
  624. "&lt;attr &lt;name&gt; ?" ein, um eine Liste verf&uuml;gbarer Attribute
  625. anzuzeigen.
  626. Siehe den Abschnitt &uuml;ber <a href="#devspec">Ger&auml;te-Spezifikation</a>
  627. f&uuml;r Details der &lt;devspec&gt;.<br>
  628. Ger&auml;tespezifische Attribute sind in der Beschreibung zum jeweiligen
  629. Ger&auml;t aufgef&uuml;hrt.
  630. Nach der Durchf&uuml;hrung das globale Ereignis "ATTR" wird generiert.
  631. <br>
  632. Falls die Option -a spezifiziert ist, dann wird value zum aktuellen Wert
  633. hinzugef&uuml;gt. Achtung: falls value nicht mit einem Komma (,)
  634. anf&auml;ngt, dann wird es mit einem Leerzeichen angeh&auml;ngt.
  635. <br>
  636. Mit der -r Option kann man Teile eines Attributes wieder entfernen.<br>
  637. <br>
  638. Beispiele:
  639. <ul><code>
  640. attr global verbose 3<br>
  641. attr lamp room kitchen<br>
  642. attr lamp group lights<br>
  643. attr lamp loglevel 6<br>
  644. attr weatherstation event-on-update-reading wind,temperature,humidity<br>
  645. attr weatherstation event-on-change-reading israining<br>
  646. attr weatherstation event-on-change-reading israining,state<br>
  647. attr heating stateFormat Temp:measured-temp, Valve:actuator<br>
  648. attr -a TYPE=SVG room ,SvgRoom</br>
  649. attr -r TYPE=SVG room ,SvgRoom</br>
  650. </code></ul>
  651. <br>
  652. Bemerkungen:<br>
  653. <ul>
  654. <li>Lesen Sie unter <a href="#deleteattr">deleteattr</a> nach um Attribute
  655. zu l&ouml;schen.</li>
  656. </ul>
  657. </ul>
  658. <!-- attr end -->
  659. <a name="cancel"></a>
  660. <h3>cancel</h3>
  661. <ul>
  662. <code>cancel [&lt;id&gt; [quiet]]</code>
  663. <br><br>
  664. Entfernt ein benanntes <a href="#sleep">sleep</a>.
  665. </ul>
  666. <!-- cancel end -->
  667. <a name="define"></a>
  668. <h3>define</h3>
  669. <ul>
  670. <code>define [option] &lt;name&gt; &lt;type&gt; &lt;type-specific&gt;</code><br>
  671. <br>
  672. Definiert ein Ger&auml;t. Sie m&uuml;ssen Ger&auml;te einrichten um sie zu
  673. beeinflussen (z.B. das Kommando set on/off auszuf&uuml;hren). Gleichfalls
  674. ist das Logfile besser lesbar wenn es z.B. "lamp off" anstatt "Device 5673,
  675. Button 00, Code 00 (off)" als Text enth&auml;lt. <br>
  676. Nach der Durchf&uuml;hrung wird das globale Ereignis "DEFINED" generiert.
  677. <br><br>
  678. Je nach Typ ben&ouml;tigt man unterscheidliche Argumente, lesen Sie sich
  679. bitte die zu dem jeweiligen Ger&auml;t geh&ouml;renden Abschnitte durch.
  680. <br><br>
  681. Optionen:<br>
  682. <ul>
  683. <li>-temporary<br>
  684. Setzt den TEMPORARY Marker, was das Abspeichern dieser Definition in
  685. fhem.cfg verhindert.
  686. </li><br>
  687. <li>-ignoreErr<br>
  688. Reduziert die Anzahl der Fehlermeldungen, falls ein FHEM-Modul nicht
  689. geladen werden kann. Wird in fhem.cfg.demo verwendet, da das RSS Beispiel
  690. etliche, normalerweise nicht installierte perl-Module ben&ouml;tigt.
  691. </li><br>
  692. </ul>
  693. </ul>
  694. <!-- define end -->
  695. <a name="defmod"></a>
  696. <h3>defmod</h3>
  697. <ul>
  698. <code>defmod [-temporary] &lt;name&gt; &lt;type&gt; &lt;type-specific&gt;</code><br>
  699. <br>
  700. Definiert ein Ger&auml;t, oder &auml;ndert es, falls es exisitiert. Um
  701. z.Bsp. eine Lampe 10 Minuten nach der letzten Meldung eines Bewegungsmelders
  702. abzuschalten, k&ouml;nnte man folgendes definieren:
  703. <ul><code>
  704. define mdNtfy notify motionDetector defmod mdOff at +00:10 set lamp off
  705. </code></ul>
  706. Falls man statt defmod ein define verwenden w&uuml;rde, dann w&uuml;rde eine
  707. Meldung innerhalb von 10 Minuten nach der letzten Meldung zu einem Fehler
  708. f&uuml;hren, da mdOff noch existiert.
  709. <br>
  710. </ul>
  711. <!-- defmod end -->
  712. <a name="delete"></a>
  713. <h3>delete</h3>
  714. <ul>
  715. <code>delete &lt;devspec&gt;</code> <br>
  716. <br>
  717. L&ouml;scht etwas was mit dem <a href="#define">define</a> Befehl erstellt
  718. worden ist.<br>
  719. Siehe den Abschnitt &uuml;ber <a href="#devspec">Ger&auml;te-Spezifikation</a>
  720. f&uuml;r Details der &lt;devspec&gt;.<br>
  721. Nach dem l&ouml;schen, wird das globale Ereignis "DELETED" erzeugt.<br>
  722. Beispiel:
  723. <ul>
  724. <code>delete lamp</code><br>
  725. </ul>
  726. <br>
  727. </ul>
  728. <!-- delete end -->
  729. <a name="deleteattr"></a>
  730. <h3>deleteattr</h3>
  731. <ul>
  732. <code>deleteattr &lt;devspec&gt; [&lt;attrname&gt;]</code> <br>
  733. <br>
  734. L&ouml;scht entweder ein einzelnes Attribut (siehe Abschnitt <a
  735. href="#attr">attr</a> ) oder alle Attribute eines Ger&auml;tes (falls
  736. kein &lt;attrname&gt; angegeben wird).<br>
  737. Siehe den Abschnitt &uuml;ber <a href="#devspec">Ger&auml;te-Spezifikation</a>
  738. f&uuml;r Details der &lt;devspec&gt;.<br>
  739. Nach der Durchf&uuml;hrung das globale Ereignis "DELETEATTR" wird generiert.
  740. <br>
  741. Beispiele:
  742. <ul>
  743. <code>deleteattr lamp follow-on-for-timer</code><br>
  744. <code>deleteattr lamp</code><br>
  745. </ul>
  746. <br>
  747. </ul>
  748. <!-- deleteattr end -->
  749. <a name="deletereading"></a>
  750. <h3>deletereading</h3>
  751. <ul>
  752. <code>deletereading &lt;devspec&gt; &lt;readingname&gt;</code> <br>
  753. <br>
  754. Entfernt das Reading &lt;readingname&gt; f&uuml;r das spezifizierte
  755. Ger&auml;t. &lt;readingname&gt; ist ein perl Regular-Expression, was den
  756. vollst&auml;ndigen Namen des Readings erfassen muss.
  757. Mit gr&ouml;&szlig;ter Sorgfalt verwenden! FHEM kann abst&uuml;rzen, falls
  758. man lebenswichtige Readings entfernt.<br>
  759. Siehe den Abschnitt &uuml;ber <a href="#devspec">Ger&auml;te-Spezifikation</a>
  760. f&uuml;r Details der &lt;devspec&gt;.<br>
  761. <br>
  762. Beispiele:
  763. <ul>
  764. <code>deletereading mySensor temp1</code><br>
  765. <code>deletereading mySensor temp\d+</code><br>
  766. </ul>
  767. <br>
  768. </ul>
  769. <!-- deletereading end -->
  770. <a name="displayattr"></a>
  771. <h3>displayattr</h3>
  772. <ul>
  773. <code>displayattr &lt;devspec&gt; [&lt;attrname&gt;]</code> <br>
  774. <br>
  775. Zeigt entweder den Wert eines Attributes an (falls &lt;attrname&gt;
  776. spezifiziert wurde) oder alle Attribute eines Ger&auml;tes.
  777. Siehe den Abschnitt &uuml;ber <a href="#devspec">Ger&auml;te-Spezifikation</a>
  778. f&uuml;r Details der &lt;devspec&gt;.<br>
  779. Falls mehrere Ger&auml;te spezifiziert wurden, dann enth&auml;lt die Ausgabe
  780. den Namen der Ger&auml;te.
  781. <br>
  782. Beispiele:
  783. <ul>
  784. <code>
  785. fhem&gt; di WEB<br>
  786. menuEntries AlarmOn,/fhem?cmd=set%20alarm%20on<br>
  787. room Misc.<br>
  788. fhem&gt di WEB room<br>
  789. Misc.<br>
  790. </code>
  791. </ul>
  792. <br>
  793. </ul>
  794. <!-- displayattr end -->
  795. <a name="get"></a>
  796. <h3>get</h3>
  797. <ul>
  798. <code>get &lt;devspec&gt; &lt;type-specific&gt;</code>
  799. <br><br>
  800. Fragt einen Wert direkt&nbsp; (aktuell) vom Ger&auml;t ab und wartet auf eine
  801. Antwort. Eine allgemeine Liste m&ouml;glicher Paramter erhalten Sie mit<ul>
  802. <code>get &lt;device&gt; ?</code>
  803. </ul>
  804. Siehe den Abschnitt &uuml;ber <a href="#devspec">Ger&auml;te-Spezifikation</a>
  805. f&uuml;r Details der &lt;devspec&gt;.<br>
  806. Jedes Ger&auml;t hat unterschiedliche &quot;get&quot;-Parameter. Lesen Sie Details bitte im
  807. zugeh&ouml;rigen Abschnitt nach.<br>
  808. <br>
  809. </ul>
  810. <!-- get end -->
  811. <a name="getstate"></a>
  812. <h3>getstate</h3>
  813. <ul>
  814. <code>getstate &lt;devspec&gt;</code>
  815. <br><br>
  816. Gibt einen kurzen, durch Leerzeichen getrennte Statusliste f&uuml;r &lt;devspec&gt;
  817. aus . Dies ist n&uuml;tzlich, um das Ger&auml;t in z.B. Cacti zu beobachten.<br>
  818. Beispiel:
  819. <ul><code>
  820. getstate lamp<br>
  821. state:1<br>
  822. <br>
  823. getstate fl<br>
  824. ack:0 actuator:2 day-temp:21.5 desired-temp:22.5 [...] measured-temp:22.9 [...]
  825. </code></ul>
  826. Bemerkung: Um diesen Befehl nutzen zu k&ouml;nnen, kopieren Sie bitte&nbsp; die
  827. Datei 99_getstate.pm aus dem Verzeichnis contrib/getstate/ in Ihr FHEM
  828. Verzeichnis.
  829. <br>
  830. </ul>
  831. <!-- getstate end -->
  832. <a name="include"></a>
  833. <h3>include</h3>
  834. <ul>
  835. <code>include &lt;filename&gt;</code> <br>
  836. <br>
  837. Liest (z.B. als Befehlszeile in der fhem.cfg) die in &lt;filename&gt;
  838. angegebene Datei in FHEM ein und interpretiert jede Dateizeile als FHEM
  839. Befehl. Dieses Befehl sollte nur von Experten verwendet werden.
  840. <br>
  841. </ul>
  842. <!-- include end -->
  843. <a name="inform"></a>
  844. <h3>inform</h3>
  845. <ul>
  846. <code>inform {on|off|timer|raw} [regexp]</code> <br>
  847. <br>
  848. Erm&ouml;glicht Event-Verfolgung &uuml;ber das telnet Interface. Es ist das
  849. telnet Equivalent des FHEMWEB Event-Monitors, es kann aber auch von weiteren
  850. Programmen zur Benachrichtigung verwendet werden. Optionen:<br>
  851. <ul>
  852. <li>on<br>
  853. aktiviert die Benachrichtigung.</li>
  854. <li>onWithState<br>
  855. zeigt auch das zus&auml;tzliche state Event</li>
  856. <li>off<br>
  857. deaktiviert die Benachrichtigung (sowohl Events wie auch Logs, s.u.)</li>
  858. <li>raw<br>
  859. zeigt (nur) die raw Events der physikalischen Module</li>
  860. <li>timer<br>
  861. stellt der Daten ein Zeitstempel vor</li>
  862. <li>log<br>
  863. zeigt die vom FHEM Log Interface protokollierten Daten</li>
  864. <li>status<br>
  865. zeigt den aktuellen Status</li>
  866. </ul>
  867. <br>
  868. </ul>
  869. <!-- inform -->
  870. <a name="list"></a>
  871. <h3>list</h3>
  872. <ul>
  873. <code>list [devspec] [value]</code><br>
  874. oder<br>
  875. <code>list {-r|-R} devspec</code><br>
  876. <br><br>
  877. Auflistung aller &quot;definitions&quot;, &quot;notify&quot; und
  878. &quot;at&quot;-Definitionen. Dies ist eines der wenigen Befehle, die im
  879. Normalfall eine Zeichenkette ausgeben.<br> Siehe den Abschnitt &uuml;ber <a
  880. href="#devspec">Ger&auml;te-Spezifikation</a> f&uuml;r Details der
  881. &lt;devspec&gt;.<br>
  882. <br> Wenn value angegeben ist, der von ( DEF, TYPE, usw) oder reading
  883. (actuator, measured-temp) f&uuml;r alle Ger&auml;te die in devspec angegeben
  884. sind. <br><br> Beispiel:
  885. <pre><code>fhem&gt; list
  886. Type list <name> for detailed info.
  887. Internal:
  888. global (Internal)
  889. FHZ:
  890. FHZ (fhtbuf: 23)
  891. FS20:
  892. Btn4 (on-old-for-timer)
  893. Roll1 (on)
  894. Stehlampe (off)
  895. FHT:
  896. fl (measured-temp: 21.1 (Celsius))
  897. KS300:
  898. out1 (T: 2.9 H: 74 W: 2.2 R: 8.2 IR: no)
  899. at:
  900. at_rollup (Next: 07:00:00)
  901. notify:
  902. ntfy_btn4 (active)
  903. FileLog:
  904. avglog (active)
  905. </name></code></pre>
  906. Wenn Sie f&uuml;r <code>name</code> einen Ger&auml;tenamen eingeben, dann
  907. erhalten Sie einen genauen Status f&uuml;r das in<code> name</code>
  908. angegebene Ger&auml;t angezeigt, z.B.:
  909. <pre><code> fhem&gt; list fl
  910. Internals:
  911. CODE 5102
  912. DEF 5102
  913. NAME fl
  914. NR 15
  915. STATE measured-temp: 21.1 (Celsius)
  916. TYPE FHT
  917. IODev FHZ
  918. Attributes:
  919. room Heizung
  920. Readings:
  921. 2006-11-02 09:45:56 actuator 19%
  922. [...]
  923. </code></pre>
  924. Mit der -r (raw) Option werden die Daten in einem f&uuml;r fhem.cfg bzw.
  925. fhem.state passenden Format generiert. -R liefert diese Daten auch f&uuml;r
  926. alle von diesem Ger&auml;t vermutlich ben&ouml;gten Ger&auml;te.
  927. Achtung: die Bestimmung dieser Liste ist ungenau.
  928. </ul>
  929. <!-- list end -->
  930. <a name="modify"></a>
  931. <h3>modify</h3>
  932. <ul>
  933. <code>modify &lt;name&gt; &lt;type-dependent-options&gt;</code>
  934. <br><br>
  935. Dieser Befehl wird benutzt, um Definitionen zu ver&auml;ndern. Er ist
  936. n&uuml;tzlich, um <a href="#at">at</a> oder <a href="#notify">notify</a>
  937. Definitionen zu ver&auml;ndern. Wenn Sie einen Wert einer an Definition
  938. ver&auml;ndern, dann wird nur der f&uuml;r die Zeit zust&auml;ndige Teil
  939. ge&auml;ndert. Im Falle der Ver&auml;nderung einer Definition vom Typ
  940. &quot;notify&quot; wird nur der&nbsp; regex Teil ge&auml;ndert. Alle anderen
  941. Werte (Stati, Attribute,&nbsp; etc) bleiben erhalten.
  942. After modify, the global event "MODIFIED" will be generated.
  943. Nach der Durchf&uuml;hrung das globale Ereignis "MODIFIED" wird generiert.
  944. <br><br>
  945. Beispiel:
  946. <ul>
  947. <code>define lampon at 19:00 set lamp on</code><br>
  948. <code>modify lampon *19:00</code><br>
  949. <code>modify lampon 19:00 set lamp on-for-timer 16</code><br>
  950. </ul>
  951. </ul>
  952. <!-- modify end -->
  953. <a name="quit"></a>
  954. <h3>quit</h3>
  955. <ul>
  956. <code>quit</code>
  957. <br><br>
  958. Dieser Befehl wird in einer TCP/IP Session benutzt um die Client-Sitzung zu
  959. beenden.<br>
  960. Wird dieser Befehl in einem Skript benutzt, wird das abarbeiten des Skriptes
  961. beendet.
  962. <br><br>
  963. Beispiel:
  964. <ul>
  965. <code>quit</code>
  966. </ul>
  967. </ul>
  968. <!-- quit end -->
  969. <a name="reload"></a>
  970. <h3>reload</h3>
  971. <ul>
  972. <code>reload &lt;module&gt;</code>
  973. <br><br>
  974. Reload the given module from the module directory. It is a convenient way to
  975. test modules whithout restarting the program.
  976. <br><br>
  977. Example:
  978. <ul>
  979. <code>reload 99_PRIV</code>
  980. </ul>
  981. </ul>
  982. <!-- reload end -->
  983. <a name="rename"></a>
  984. <h3>rename</h3>
  985. <ul>
  986. <code>rename &lt;oldname&gt; &lt;newname&gt;</code>
  987. <br><br>
  988. Benennt ein Ger&auml;t von &lt;oldname&gt; in &lt;newname&gt;,
  989. einschliesslich der Attribute, um. Das globale Ereignis &quot;RENAMED&quot;
  990. wird erstellt, Lesen Sie bitte den Abschnitt &quot;notify&quot; durch um
  991. Details zu erfahren.
  992. <br><br>
  993. Beispiel:
  994. <ul>
  995. <code>rename FHT_1234 fht.kitchen</code>
  996. </ul>
  997. </ul>
  998. <!-- rename end -->
  999. <a name="rereadcfg"></a>
  1000. <h3>rereadcfg</h3>
  1001. <ul>
  1002. <code>rereadcfg [fhem-config-file]</code>
  1003. <br><br>
  1004. Liest entweder die aktuelle Konfigurationsdatei oder die angegebene Datei
  1005. ein.<br> Der Ablauf ist dabei wie folgt:&nbsp; Zuerst wird das <a
  1006. href="#statefile">statefile</a> gesichert. Dann werden alle Ger&auml;te
  1007. gel&ouml;scht. Dann wird die aktuelle Konfigurationsdatei (oder die
  1008. angegebene Datei) eingelesen zuletzt wird das statefile neu eingelesen.<br>
  1009. Wenn dieser Ablauf abgeschlossen ist, wird das globale REREADCFG Ereignis
  1010. ausgel&ouml;st. Alle existierenden Verbindungenwerden bis zum
  1011. &quot;rereadcfg&quot; Ereignis getrennt.
  1012. <br><br>
  1013. Beipiel:
  1014. <ul>
  1015. <code>rereadcfg</code>
  1016. </ul>
  1017. </ul>
  1018. <!-- rereadcfg end -->
  1019. <a name="save"></a>
  1020. <h3>save</h3>
  1021. <ul>
  1022. <code>save [&lt;configfile&gt;]</code>
  1023. <br><br>
  1024. Sichert zuerst das <a href="#statefile">statefile</a> und dann das
  1025. <a href="#configfile">configfile</a>. Wenn ein Parameter angegeben wird dieser
  1026. anstelle der allgemeinen Konfigurationsdatei benutzt.<br><br>
  1027. Hinweise:
  1028. <ul>
  1029. <li>Der Befehl speichert nur &quot;definitions&quot; und
  1030. &quot;attributes&quot; aber keine (set/get) Befehle die vorher Teil der
  1031. Konfigurationsdatei waren. Wenn Sie solche Befehle nach der
  1032. Initialisierung (z.B. <a href="#FHZset">FHTcode</a>)
  1033. ben&ouml;tigen,dann m&uuml;ssen Sie sie mit <a href="#notify">notify</a>
  1034. triggern wenn das INITIALIZED Ereignis eintritt.</li>
  1035. <li>Der Befehl &quot;save&quot; versucht Kommentarzeilen&nbsp; (Zeilen die
  1036. mit # beginnen) und &quot;include&quot;-Zeilen zu erhalten, aber arbeitet
  1037. nicht korrekt wenn FHEM f&uuml;r diese Dateien keine Schreibrechte
  1038. besitzt.</li>
  1039. <li>Vor dem &Uuml;berschreiben der Dateien wird die alte Version gesichert,
  1040. siehe <a href="#restoreDirs">restoreDirs</a> f&uuml;r Einzelheiten.</li>
  1041. </ul>
  1042. </ul>
  1043. <!-- save end -->
  1044. <a name="set"></a>
  1045. <h3>set</h3>
  1046. <ul>
  1047. <code>set &lt;devspec&gt; &lt;type-specific&gt;</code>
  1048. <br><br>
  1049. Der Befehl setzt Ger&auml;teparameter/sendet Signale an ein Ger&auml;t. Sie
  1050. erhalten eine Liste verf&uuml;gbarer Parameter wenn Sie folgendes eingeben:
  1051. <ul>
  1052. <code>set &lt;name&gt; ?</code>
  1053. </ul>
  1054. Siehe den Abschnitt &uuml;ber <a href="#devspec">Ger&auml;te-Spezifikation</a>
  1055. f&uuml;r Details der &lt;devspec&gt;.<br>
  1056. Der &quot;set&quot;-Befehl gibt nur bei Fehler einen Wert zur&uuml;ck.
  1057. <br><br>
  1058. Jedes Ger&auml;t hat verschiedene Parameter die mit &quot;set&quot; gesetzt
  1059. werden k&ouml;nnen. Lesen Sie bitte den entsprechenden Abschnitt f&uuml;r
  1060. das Ger&auml;t f&uuml;r Details durch.
  1061. <br><br>
  1062. Ab featurelevel 5.7 ersetzt der set und setreading Befehl
  1063. <ul>
  1064. <li>[device:name] mit dem Wert des Readings, Internals oder Attributes
  1065. f&uuml;r device, falls sowohl device, als auch Reading, Internal oder
  1066. Attribut existiert, und nicht leer ist.
  1067. <ul>
  1068. <li>Man kann einen der Pr&auml;fixe r:, i: oder a: verwenden, um die
  1069. Suche einzuschr&auml;nken, genau wie im devspec.</li>
  1070. <li>Das Suffix :d extrahiert die erste Zahl.</li>
  1071. <li>Das Suffix :i extrahiert die erste Zahl als Ganzzahl.</li>
  1072. <li>Das Suffix :r&lt;n&gt; extrahiert die erste Zahl, und rundet sie auf
  1073. &lt;n&gt; Dezimalstellen. Falls &lt;n&gt; fehlt, dann wird auf eine
  1074. Dezimalstelle gerundet.</li>
  1075. <li>Das Suffix :t liefert den Zeitstempel des Readings</li>
  1076. <li>Das Suffix :sec liefert Anzahl der Sekunden seit &Auml;nderung
  1077. des Readings.</li>
  1078. </ul>
  1079. Beispiel:
  1080. <ul>
  1081. set Lamp blink [blinkDummy:number] [r:blinkDummy:duration:d]
  1082. </ul>
  1083. </lu>
  1084. <li>{(perlExpression)} mit dem Ergebnis der perlExpression.
  1085. $DEV wird dabei mit dem Namen des vom set betroffenen Ger&auml;tes ersetzt.
  1086. </li>
  1087. </ul>
  1088. Diese Ersetzungen sind unter dem Namen "set magic" bekannt.
  1089. <br><br>
  1090. <a name="setExtensions"></a>
  1091. Manche Module unterst&uuml;tzen die sog. <b>set extensions</b>, und in der
  1092. entsprechenden Dokumentation ist ein Link auf diesem Text zu finden. Falls im
  1093. Modul selber einer der unten aufgef&uuml;hrten Befehle implementiert ist, dann
  1094. wird die Modul-Implementation verwendet.
  1095. <ul>
  1096. <li>on-for-timer &lt;sekunden&gt<br>
  1097. Das Ger&auml;t wird per "on" eingeschaltet, und ein interner Zeitgeber
  1098. wird erstellt, um nach &lt;sekunden&gt; ein "off" Kommando
  1099. auszuf&uuml;hren. Um diesen Zeitgeber zu entfernen sollte man das
  1100. Kommando mit dem Argument 0 erneut aufrufen. Achtung: dieser Zeitgeber
  1101. wird bei einem restart nicht gespeichert.</li>
  1102. <li>off-for-timer &lt;sekunden&gt<br>
  1103. siehe on-for-timer.</li>
  1104. <li>on-till &lt;timedet&gt<br>
  1105. Das Ger&auml;t wird per "on" eingeschaltet, und ein at Instanz wird
  1106. definiert, um es um &lt;timedet&gt; (Format: HH:MM[:SS]) per off
  1107. auszuschalten. Diese at Instanz ist sichtbar unter dem Namen
  1108. ger&auml;teName+"_till". Um das Ausschalten zu deaktivieren
  1109. l&ouml;scht man diese at Definition. Achtung: das Ein/Ausschalten wird
  1110. nicht durchgef&uuml;hrt, falls die aktuelle Uhrzeit nach der
  1111. spezifizierten Zeit ist, um folgende Szenarien zu vereinfachen:
  1112. <ul><code>
  1113. define morningLight at *06:00 set Lamp on-till {sunrise()}
  1114. </code></ul>
  1115. </li>
  1116. <li>on-till-overnight &lt;timedet&gt<br>
  1117. Wie on-till, aber die aktuelle Uhrzeit wird nicht mit der
  1118. Spezifizierten verglichen, damit folgendes funktioniert:
  1119. <ul><code>
  1120. define nightLight at *{sunset()} set Lamp on-till-overnight 01:00
  1121. </code></ul>
  1122. </li>
  1123. <li>off-till &lt;timedet&gt<br>
  1124. siehe on-till.</li>
  1125. <li>off-till-overnight &lt;timedet&gt<br>
  1126. siehe on-till-overnight.</li>
  1127. <li>blink &lt;anzahl&gt; &lt;blink-periode&gt;<br>
  1128. Das Ger&auml;t wird mit "on" f&uuml;r die &lt;blink-periode&gt;
  1129. eingeschaltet, und das wird nach &lt;blink-periode&gt; wiederholt. Um
  1130. das Blinken vorzeitig zu stoppen spezifiziert man "0 0" als
  1131. Argument.</li>
  1132. <li>intervals &lt;from1&gt;-&lt;till1&gt; &lt;from2&gt;-&lt;till2&gt;...
  1133. </br>
  1134. Das Ger&auml;t wird f&uuml;r die spezifizierten Intervalle
  1135. eingeschaltet. Die einzelnen Intervalle sind Leerzeichen getrennt, und
  1136. ein Intervall besteht aus zwei Zeitspezifikationen, die mit einem "-"
  1137. getrennt sind.
  1138. </li>
  1139. <li>toggle<br>
  1140. Das Ger&auml;t wird mit "on" eingeschaltet, falls STATE "off" ist (oder
  1141. dim 0), sonst wird es mit "off" ausgeschaltet.
  1142. </ul>
  1143. Beispiele:
  1144. <ul>
  1145. <code>
  1146. set switch on-for-timer 12.5<br>
  1147. set switch on-till {sunset()}<br>
  1148. set switch blink 3 1<br>
  1149. set switch intervals 08:00-12:00 13:00-18:00<br>
  1150. </code>
  1151. </ul>
  1152. </ul>
  1153. </ul>
  1154. <!-- set end -->
  1155. <a name="setdefaultattr"></a>
  1156. <h3>setdefaultattr</h3>
  1157. <ul>
  1158. <code>setdefaultattr [&lt;attrname&gt; [&lt;value&gt;]] </code><br>
  1159. <br>
  1160. F&uuml;gt Sie ein Standardattribut hinzu. Jedem nach dieser Zuweisung definierte
  1161. Ger&auml;t wird dieses Attribut zugewiesen. Wenn kein "attrname" angegeben wird,
  1162. dann wird die Liste der Standardattribute gel&ouml;scht.
  1163. <br><br>
  1164. Beispiel, um das Attribut "room kitchen" und "loglevel 4" allen Lampen
  1165. zuzuweisen:
  1166. <ul>
  1167. <code>setdefaultattr room kitchen</code><br>
  1168. <code>setdefaultattr loglevel 4</code><br>
  1169. <code>define lamp1 FS20 1234 11</code><br>
  1170. <code>define lamp2 FS20 1234 12</code><br>
  1171. <code>define lamp3 FS20 1234 13</code><br>
  1172. <code>setdefaultattr</code><br>
  1173. </ul>
  1174. <br>
  1175. Anmerkungen:<br>
  1176. <ul>
  1177. <li>es gibt keine M&ouml;glichkeit, ein einzelnes Standardattribut aus der Liste
  1178. tu l&ouml;schen.</li>
  1179. </ul>
  1180. </ul>
  1181. <!-- setdefaultattr end -->
  1182. <a name="setreading"></a>
  1183. <h3>setreading</h3>
  1184. <ul>
  1185. <code>setreading &lt;devspec&gt; &lt;reading&gt; &lt;value&gt;</code>
  1186. <br><br>
  1187. Der Befehl setzt das Reading &lt;reading&gt; auf den Wert &lt;value&gt; ohne
  1188. Signale an das betroffene Ger&auml;t zu senden, generiert aber Ereignisse und
  1189. die &uuml;bliche eventMap und stateFormat Umwandlung wird auch
  1190. durchgef&uuml;hrt.
  1191. <br>
  1192. Siehe den Abschnitt &uuml;ber <a href="#devspec">Ger&auml;te-Spezifikation</a>
  1193. f&uuml;r Details der &lt;devspec&gt; und die Beschreibung des set Befehls
  1194. f&uuml;r Ersetzung.<br>
  1195. <br>
  1196. Beispiel:
  1197. <ul>
  1198. setreading lampe state on
  1199. </ul>
  1200. Achtung: setreading generiert kein Event f&uuml;r ein Ger&auml;t X, falls es
  1201. aus einem notify f&uuml;r Ger&auml;t X aufgerufen wurde. In so einem Fall
  1202. k&ouml;nnte man auf "sleep 0.1; setreading X Y Z" ausweichen.
  1203. </ul>
  1204. <!-- setreading end -->
  1205. <a name="setstate"></a>
  1206. <h3>setstate</h3>
  1207. <ul>
  1208. <code>setstate &lt;devspec&gt; &lt;value&gt;</code>
  1209. <br><br>
  1210. Der Befehl setzt den STATE Eintrag des Ger&auml;tes direkt, ohne Ereignisse
  1211. zu generieren oder ein Signal an das Ger&auml;t zu senden. Dieser Eintrag ist
  1212. ma&szlig;gebend f&uuml;r die Status-Anzeige in diversen Frontends. Dieser
  1213. Befehl wird auch im <a href="#statefile">statefile</a> benutzt.<br> Siehe den
  1214. Abschnitt &uuml;ber <a href="#devspec">Ger&auml;te-Spezifikation</a> f&uuml;r
  1215. Details der &lt;devspec&gt;.<br> <br>
  1216. Beispiel:
  1217. <ul>
  1218. setstate lampe An
  1219. </ul>
  1220. </ul>
  1221. <!-- setstate end -->
  1222. <a name="shutdown"></a>
  1223. <h3>shutdown</h3>
  1224. <ul>
  1225. <p>
  1226. <code>shutdown [<var>restart</var>] [<var>exitValue</var>]</code>
  1227. </p>
  1228. <p>
  1229. Der Befehl f&auml;hrt <abbr>FHEM</abbr> herunter (nach dem Sichern aller <a
  1230. href="#statefile">Ger&auml;testatus</a>). Er triggert den <code>global:SHUTDOWN</code>-<span lang="en">Event</span>.
  1231. Mit dem optionalen Parameter <var lang="en">restart</var> startet <abbr>FHEM</abbr> danach neu.
  1232. Der <var lang="en">exitValue</var> ist möglicherweise bei bestimmten Start-Skripten zur korrekten Funktion
  1233. vonn&ouml;ten <abbr>bzw.</abbr> wichtig.
  1234. </p>
  1235. Beispiel:
  1236. <ul>
  1237. <code>shutdown</code><br>
  1238. <code>shutdown restart</code><br>
  1239. <code>shutdown 1</code>
  1240. </ul>
  1241. </ul>
  1242. <!-- shutdown end -->
  1243. <a name="sleep"></a>
  1244. <h3>sleep</h3>
  1245. <ul>
  1246. <code>sleep &lt;sec&gt; [&lt;id&gt;] [quiet]</code>
  1247. <br><br>
  1248. sleep gefolgt von weiteren Befehlen ist vergleichbar mit einem namenlosen <a
  1249. href="#at">at</a> Kommando, es f&uuml;hrt die nachfolgenden Befehle aus,
  1250. nachdem es die spezifizierte Zeitspanne gewartet hat. Die Einheit ist
  1251. Sekunde, Millisekunden genau, da man Nachkommastellen spezifizieren
  1252. kann.<br><br>
  1253. Ein sleep mit einer &lt;id&gt; ersetzt ein sleep mit der gleichen &lt;id&gt;
  1254. and can mit <a href="#cancel">cancel</a> entfernt werden.
  1255. Falls sleep in at/notify/etc aufgerufen wurde, und die nachfolgenden
  1256. Kommandos einen nicht leeren Text zur&uuml;ckgeliefert haben, dann wird
  1257. dieser Text mit loglevel 2 protokolliert.<br>
  1258. quiet vermeidet diese Protokollierung.
  1259. <br><br>
  1260. Beispiele:
  1261. <ul>
  1262. <code>sleep 0.5</code><br>
  1263. <code>define n3 notify btn3.* set lamp toggle;;sleep 0.5;;set lamp
  1264. toggle</code><br>
  1265. <code>define a3 at +*00:05 set Windsensor 1w_measure;; sleep 2 quiet;; get
  1266. Windsensor 1w_temp</code>
  1267. </ul>
  1268. <br>
  1269. Bemerkung: falls sleep von keinem Befehl gefolgt wird, dann wird FHEM
  1270. blockiert. Das ist unerw&uuml;nscht, und im FHEM-Log wird eine Warnung
  1271. protokolliert.
  1272. </ul>
  1273. <!-- sleep end -->
  1274. <a name="trigger"></a>
  1275. <h3>trigger</h3>
  1276. <ul>
  1277. <code>trigger &lt;devspec&gt; &lt;event&gt;</code>
  1278. <br><br>
  1279. Generiert das Ereignis &lt;event&gt;, was z.Bsp. ein <a
  1280. href="#notify">notify</a> ansto&szlig;en kann, oder den FileLog zum
  1281. protokollieren dieser Zeile bewegen kann.<br>
  1282. Siehe den Abschnitt &uuml;ber <a href="#devspec">Ger&auml;te-Spezifikation</a>
  1283. f&uuml;r Details der &lt;devspec&gt;.<br>
  1284. <br>
  1285. Beispiel:
  1286. <ul>
  1287. <code>trigger btn3 on</code>
  1288. </ul>
  1289. </ul>
  1290. <!-- trigger end -->
  1291. <!-- commands end - diese Zeile nicht entfernen! -->
  1292. <a name="global"></a>
  1293. <h3>global</h3>
  1294. <ul>
  1295. Das &quot;global&quot; Ger&auml;t wird benutzt, um allgemeing&uuml;ltige
  1296. Attribute zu setzen. Es wird automatisch erstellt und kann nicht
  1297. gel&ouml;scht oder umbenannt werden. Es hat keine &quot;set&quot; oder
  1298. &quot;get&quot; Parameter.<br>
  1299. <br>
  1300. <b>Define</b><ul>N/A</ul><br>
  1301. <b>Set </b><ul>N/A</ul><br>
  1302. <b>Get</b><ul>N/A</ul><br>
  1303. <b>Attributes</b>
  1304. <ul>
  1305. <li><a href="#archivedir">archivedir</a></li>
  1306. <li><a href="#archivecmd">archivecmd</a></li>
  1307. <li><a href="#nrarchive">nrarchive</a></li>
  1308. <a name="archivesort"></a>
  1309. <li>archivesort<br>
  1310. archivesort kann auf dem (voreingestellten) Wert alphanum oder timestamp
  1311. gesetzt werden, und bestimmt die Methode f&uuml;r die
  1312. Reihenfolgenberechnung der Dateien f&uuml;r nrarchive.<br>
  1313. </li><br>
  1314. <a name="autoload_undefined_devices"></a>
  1315. <li>autoload_undefined_devices<br>
  1316. wenn dieses Attribut gesetzt ist, werden die zu einer neu empfangenen
  1317. Nachricht zugeh&ouml;rigen Module automatisch geladen.&nbsp; Dies
  1318. erfolgt vom <a href="#autocreate"> autocreate</a> Ger&auml;t, um so
  1319. automatisch ein FHEM-Ger&auml;t bei erreichen einer entsprechenden
  1320. Nachricht zu erstellen.
  1321. </li><br>
  1322. <a name="backupcmd"></a>
  1323. <li>backupcmd<br>
  1324. Sie k&ouml;nnen das Update durch Ihre eigenen Befehle/Skripts
  1325. durchf&uuml;hren indem Sie dieses Attribut setzen. Wenn dieses
  1326. Attribut gesetzt ist, dann startet es als ein SHELL-Befehl und erstellt
  1327. eine durch Leerzeichen getrennte Liste von Dateien/Verzeichnissen als
  1328. <strong>ein</strong> Argument zum Befehl, z.B.:
  1329. <br>
  1330. <ul>
  1331. <code>"/etc/fhem.cfg /var/log/fhem/fhem.save /usr/share/fhem/contrib
  1332. /usr/share/fhem/FHEM /usr/share/fhem/foo /usr/share/fhem/foobar
  1333. /usr/share/fhem/www"</code>
  1334. </ul>
  1335. Bemerkung: Ihr Befehl/Skript muss die Zeichenkette "backup done"
  1336. zur&uuml;ckgeben oder eine entsprechende Zeichenkette um
  1337. Fehlermeldungen auszugeben, damit die Zusammenarbeit mit update
  1338. funktioniert!<br> Dieses Attribut wird vom <a href="#backup">backup</a>
  1339. Befehl benutzt.<br>
  1340. Beispiel:<br>
  1341. <ul>
  1342. attr global backupcmd /usr/local/bin/myBackupScript.sh
  1343. </ul>
  1344. </li><br>
  1345. <a name="backupdir"></a>
  1346. <li>backupdir<br>
  1347. Ein Ordner um die komprimierten Sicherheitsdateien zu speichern.
  1348. Dieses Attribut wird vom <a href="#backup">backup</a> Befehl
  1349. benutzt.<br> Beispiel:<br>
  1350. <ul>
  1351. attr global backupdir /Volumes/BigHD
  1352. </ul>
  1353. </li><br>
  1354. <a name="backupsymlink"></a>
  1355. <li>backupsymlink<br>
  1356. Wenn dieses Attribut auf etwas anderes als "no", dann unterst&uuml;tzt
  1357. der Archviierungsbefehl &quot;tar&quot; symbolische Links in Ihrem
  1358. Backup. Andererseits, wenn dieses Attribut auf "no" gesetzt ist werden
  1359. symbolische Links vom Befehl &quot;tar&quot; ignoriert. Dieses
  1360. Attribut wird vom <a href="#backup">backup</a> Befehl benutzt.<br>
  1361. Beispiel:<br>
  1362. <ul>
  1363. attr global backupsymlink yes
  1364. </ul>
  1365. </li><br>
  1366. <a name="blockingCallMax"></a>
  1367. <li>blockingCallMax<br>
  1368. Begrenzt die Anzahl der parallel laufenden Prozesse, die von der
  1369. BlockingCall FHEM Hilfsroutine gestartet wurden. Sinnvoll auf weniger
  1370. leistungsfaehigen Hardware.
  1371. </li><br>
  1372. <a name="configfile"></a>
  1373. <li>configfile<br>
  1374. Enth&auml;lt den Namen der FHEM Konfigurationsdatei. Wenn <a
  1375. href="#save">save</a> ohne Argumente aufgerufen wird dann wird die
  1376. Ausgabedatei unter diesem Dateinamen gespeichert.
  1377. </li><br>
  1378. <a name="commandref"></a>
  1379. <li>commandref<br>
  1380. Falls der Wert "full" (die Voreinstellung) ist, dann wird nach jedem
  1381. update ein komplettes commandref.html generiert. Falls der Wert
  1382. "modular" ist, dann wird die Moduldokumentation erst nach Bedarf
  1383. waehrend der Laufzeit per JavaScript geladen.
  1384. </li><br>
  1385. <a name="dnsHostsFile"></a>
  1386. <li>dnsHostsFile<br>
  1387. Falls dnsServer gesetzt ist, wird die angegebene Datei nach dem
  1388. Hostnamen durchsucht. Um die vom System verwendete Datei zu benutzen,
  1389. ist es unter Linux/Unix/OSX auf /etc/hosts und unter Windows auf
  1390. C:\windows\system32\drivers\etc\hosts zu setzen. Achtung: es wird nur
  1391. IPv4 unterst&uuml;tzt.
  1392. </li><br>
  1393. <a name="dnsServer"></a>
  1394. <li>dnsServer<br>
  1395. Enth&auml;lt die IP Adresse des DNS Servers. Die von bestimmten Modulen
  1396. (oder eigenen Code) aufgerufene HttpUtils_NonblockingGet wird auch bei
  1397. der DNS Aufl&ouml;sung nicht mehr blockieren, falls dieses Attribut
  1398. gesetzt ist, da es in diesem Fall FHEM eigene Routinen aufgerufen
  1399. werden. Sonst werden die OS-eigenen, blockierenden Routinen inet_aton
  1400. bzw gethostbyname aufgerufen.
  1401. </li><br>
  1402. <a name="featurelevel"></a>
  1403. <li>featurelevel<br>
  1404. Aktiviere bzw. deaktiviere bestimmte alte oder neue Funktionen, basierend
  1405. auf die FHEM Version. Z.Bsp. das $value hash f&uuml;r notify wird nur bis featurelevel 5.6
  1406. bef&uuml;llt, da es unerw&uuml;nscht ist. Stattdessen sollte man die
  1407. Value() Funktion verwenden.
  1408. </li><br>
  1409. <a name="holiday2we"></a>
  1410. <li>holiday2we<br>
  1411. Wenn dieses Attribut gesetzt wurde, dann wird die <a
  1412. href="#perl">$we</a> Variable als &quot;true&quot; betrachtet, wenn der
  1413. Wert der <a href="#holiday">holiday</a> Variable zu diesem Attribut
  1414. nicht &quot;none&quot; ist.<br>
  1415. Falls es eine Komma getrennte Liste ist, dann ist es wahr, falls einer
  1416. der referenzierten Instanzen nicht &quot;none&quot; ist.<br>
  1417. Beispiel:<br>
  1418. <ul>
  1419. attr global holiday2we hessen
  1420. </ul>
  1421. </li><br>
  1422. <a name="httpcompress"></a>
  1423. <li>httpcompress<br>
  1424. das HttpUtils Modul wird von etlichen FHEM modulen verwendet und
  1425. aktiviert Komprimierung in der Voreinstellung. Falls man
  1426. httpcompress auf 0 setzt, wird die Komprimierung deaktiviert.
  1427. </li><br>
  1428. <a name="keyFileName"></a>
  1429. <li>keyFileName<br>
  1430. FHEM Module speichern Passw&ouml;rter und IDs in der Datei
  1431. FHEM/FhemUtils/uniqueID. Um mehrere FHEM-Instanzen im gleichen
  1432. Verzeichnis starten zu k&ouml;nnen, kann man dieses Attribut setzen,
  1433. dessen Wert an FHEM/FhemUtils/ angeh&auml;ngt wird.
  1434. </li><br>
  1435. <a name="logdir"></a>
  1436. <li>logdir<br>
  1437. Falls gesetzt, wird %L in dem logfile Attribut (oder in der Dateinamen
  1438. Spezifikation des FileLog Moduls) durch den Wert des Attributes ersetzt.
  1439. Achtung: &auml;ndern des Wertes bewirkt nicht das Verschieben bereits
  1440. erstellter Dateien, und kann zu diversen Problemen f&uuml;hren.
  1441. </li><br>
  1442. <a name="logfile"></a>
  1443. <li>logfile<br>
  1444. Gibt das Logfile an, in welches gespeichert werden soll.&nbsp; Sie
  1445. k&ouml;nnen "-" f&uuml;r die Ausgabe in das stdout-Ger&auml;t. In
  1446. diesem Fall stellt sich der Server nicht selbst in den Hintergrund.<br>
  1447. Der Name der Logdatei kann auch &quot;wildcards&quot; enthalten, um
  1448. eine einfachere Abfolge f&uuml;r die Dateien zu erreichen. Lesen Sie
  1449. bitte den Abschnitt <a href="#FileLog">FileLog</a>. F&uuml;gen Sie die
  1450. Attribute <code>archivecmd / archivedir / nrarchive</code> zum
  1451. <code>global</code> Ger&auml;t hinzu wie Sie es auch bei einem FileLog
  1452. device tun k&ouml;nnten.<br> Sie k&ouml;nnen den Namen der Logdatei
  1453. mit&nbsp; <code>{ $currlogfile }festlegen</code>.
  1454. </li><br>
  1455. <a name="modpath"></a>
  1456. <li>modpath<br>
  1457. Mit modpath geben Sie den Pfad zu dem Verzeichnis der <code>FHEM</code>
  1458. Module an. Der Pfad enth&auml;lt <b>nicht</b> das Verzeichnis FHEM.
  1459. Durch das setzen der Attribute, wird das Verzeichnis nach Dateinamen in
  1460. der Form NN_&lt;NAME&gt;.pm durchsucht, und sie werden f&uuml;r die
  1461. Definition von Ger&auml;ten unter dem Namen &lt;NAME&gt; verf&uuml;gbar
  1462. gemacht. Wenn das erste Ger&auml;t des Typs &lt;NAME&gt; definiert
  1463. wird, werden die entsprechenden Module geladen und in dem Modul die
  1464. entsprechende Funktion mit dem Namen &lt;NAME&gt;_Initialize wird
  1465. aufgerufen. Eine Ausnahme bilden Module die mit der Nummer 99 im
  1466. Dateinamen beginnen. Diese enthalten PERL-Hilfsfunktionen und
  1467. werden zur Startzeit geladen.
  1468. </li><br>
  1469. <a name="motd"></a>
  1470. <li>motd<br>
  1471. Nachricht des Tages. Wird im Begr&uuml;&szligungsbildschirm von FHEM
  1472. angezeigt, oder direkt beim Start einer &quot;telnet&quot; Sitzung,
  1473. bevor der fhem&gt; Prompt erscheint. Der SecurityCheck setzt motd wenn
  1474. es bisher nicht gesetzt ist. Um das zu verhindern, k&ouml;nnen sie den
  1475. Wert von motd auf &quot;none&quot; setzen.
  1476. motd wird auch verwendet, um Fehlermeldungen w&auml;hrend des
  1477. FHEM-Starts zu sammeln und anzuzeigen.
  1478. </li><br>
  1479. <a name="mseclog"></a>
  1480. <li>mseclog<br>
  1481. Wenn dieses Attribut gesetzt ist, enthalten Datums/Zeiteintr&auml;ge
  1482. (timestamp) in der Logdatei einen Millisekunden-Eintrag.
  1483. </li><br>
  1484. <a name="nofork"></a>
  1485. <li>nofork<br>
  1486. Wenn dieses Attribut oder "attr global logfile -" gesetzt ist,
  1487. dann wird FHEM nicht im Hintergrund abgearbeitet.
  1488. Dieses Attribut ist bei einigen FHEM Installationen auf FRITZ!-Boxen
  1489. notwendig, und wid fuer Windows automatisch gesetzt.
  1490. </li><br>
  1491. <a name="pidfilename="></a>
  1492. <li>pidfilename<br>
  1493. Schreibt die PERL Prozess-ID in die angegebene Datei. Der Server
  1494. l&auml;uft als Daemon und einige Distributionen wollen anhand der PID
  1495. testen, ob der FHEM Prozess l&auml;uft. Die Datei wird bei
  1496. Ausf&uuml;hrung des &quot;shutdown&quot;-Kommandos gel&ouml;scht.
  1497. </li><br>
  1498. <a name="proxy"></a>
  1499. <li>proxy<br>
  1500. IP:PORT des proxy Servers, wird von HttpUtils benutzt.
  1501. </li><br>
  1502. <a name="proxyAuth"></a>
  1503. <li>proxyAuth<br>
  1504. Base64 kodiertes Benutzername:Passwort
  1505. </li><br>
  1506. <a name="proxyExclude"></a>
  1507. <li>proxyExclude<br>
  1508. Regexp, um bestimmte Hosts nicht via proxy zu kontaktieren.
  1509. </li><br>
  1510. <a name="restoreDirs"></a>
  1511. <li><a name="restoreDirs">restoreDirs</a><br>
  1512. update sichert jede Datei vor dem &Uuml;berschreiben mit der neuen
  1513. Version aus dem Web. F&uuml;r diesen Zweck wird zuerst ein
  1514. restoreDir/update Verzeichnis in der global modpath Verzeichnis
  1515. angelegt, und danach ein Unterverzeichnis mit dem aktuellen Datum. In
  1516. diesem Verzeichnis werden vor dem &Uuml;berschreiben die alten
  1517. Versionen der Dateien gerettet. Die Voreinstellung ist 3, d.h. die
  1518. letzten 3 Datums-Verzeichnisse werden aufgehoben, und die &auml;lteren
  1519. entfernt.
  1520. <br>
  1521. Auch fhem.cfg und fhem.state wird auf diese Weise vor dem ausf&uuml;ren
  1522. von save gesichert, diesmal in das restoreDir/save Verzeichnis. Zum
  1523. restaurieren der alten Dateien kann man das restore Befehl
  1524. verwenden.<br>
  1525. Falls man den Wert auf 0 setzt, dann ist dieses Feature deaktiviert.
  1526. </li><br>
  1527. <li><a href="#fheminfo">sendStatistics</a><br>
  1528. <a name="statefile"></a>
  1529. <li>statefile<br>
  1530. Dieses Attribut legt den Namen der Datei fest, in die
  1531. Statusinformationen aller Ger&auml;te gespeichert werden&nbsp; bevor der
  1532. Server heruntergefahren wird. Falls diese Datei nicht angegeben wird, so
  1533. werden keinerlei Informationen gesichert.
  1534. </li><br>
  1535. <li><a href="#title">title</a><br>
  1536. <a name="useInet6"></a>
  1537. <li>useInet6<br>
  1538. Die HttpUtils Routinen verwenden IPv6 f&uuml;r die Kommunikation, falls
  1539. der Server eine IPv6 Adresse hat. Achtung: das Perl-Modul
  1540. IO::Socket::INET6 wird ben&ouml;tigt.
  1541. </li><br>
  1542. <a name="userattr"></a>
  1543. <li>userattr<br>
  1544. Enth&auml;lt eine durch Leerzeichen getrennte Liste in welcher die
  1545. Namen zus&auml;tzlicher Attribute aufgef&uuml;hrt sind. Diese
  1546. m&uuml;ssen zuerst in dieser Liste definiert werden, bevor sie
  1547. (bei allen Ger&auml;ten) angewendet werden k&ouml;nnen.<br>
  1548. userattr kann auch f&uuml;r einzelne Ger&auml;te spezifiziert werden,
  1549. um weitere Attribute f&uuml;r diese Ger&auml;te zu definieren.
  1550. </li><br>
  1551. <a name="dupTimeout"></a>
  1552. <li>dupTimeout<br>
  1553. Definert die Wartezeit, nach der 2 identische Ereignisse zweier
  1554. Empf&auml;nger als Duplikat angesehen werden. Voreingestellt sind 0,5
  1555. Sekunden.&nbsp;
  1556. </li><br>
  1557. <a name="showInternalValues"></a>
  1558. <li>showInternalValues<br>
  1559. Attribute/Ger&auml;te-Eintraege/Readings die mit Punkt (.) anfangen
  1560. werden nicht angezeigt, es sei denn das globale Attribut
  1561. showInternalValues ist gesetzt. Diese Variable wird bei dem list und
  1562. xmllist Befehl, und bei der FHEMWEB Raumansicht gepr&uuml;ft.
  1563. </li><br>
  1564. <a name="sslVersion"></a>
  1565. <li>sslVersion<br>
  1566. Setzt die akzeptierten Crypto-Algorithmen im TcpServices Hilfsmodul.
  1567. Die Voreinstellung TLSv12:!SSLv3 wird als sicherer erachtet als die
  1568. vorherige SSLv23:!SSLv3:!SSLv2, aber sie kann Probleme mit nicht
  1569. ausreichend aktualisierten Netzwerk-Diensten verursachen.
  1570. </li><br>
  1571. <a name="stacktrace"></a>
  1572. <li>stacktrace<br>
  1573. Falls gesetzt (auf 1), schreibt ins FHEM-Log zus&auml;tzlich zu jedem
  1574. "PERL WARNING" den stacktrace.
  1575. </li><br>
  1576. <a name="restartDelay"></a>
  1577. <li>restartDelay<br>
  1578. Setzt die Verz&ouml;gerung beim Neustart mit shutdown restart, die
  1579. Voreinstellung ist 2 (Sekunden).
  1580. </li><br>
  1581. <a name="autosave"></a>
  1582. <li>autosave<br>
  1583. Erlaubt manchen Modulen save auszuf&uuml;hren, nach einer automatischen
  1584. &Auml;nderung der Konfiguration, z.Bsp. nachdem ein Ger&auml;t angelegt
  1585. wurde. Die Voreinstellung ist 1 (wahr), man kann es ausschalten, indem
  1586. man den Wert auf 0 setzt.
  1587. </li>
  1588. </ul>
  1589. <br><br>
  1590. <b>Events</b>
  1591. <ul>
  1592. <li>INITIALIZED<br>sobald die Initialization vollst&auml;ndig ist.</li>
  1593. <li>REREADCFG<br>nachdem die Konfiguration erneut eingelesen wurde.</li>
  1594. <li>SAVE<br>bevor die Konfiguration gespeichert wird.</li>
  1595. <li>SHUTDOWN<br>bevor FHEM heruntergefahren wird.</li>
  1596. <li>DEFINED &lt;devname&gt;<br>nach dem Definieren eines
  1597. Ger&auml;tes.</li>
  1598. <li>DELETED &lt;devname&gt;<br>nach dem L&ouml;schen eines
  1599. Ger&auml;tes.</li>
  1600. <li>RENAMED &lt;old&gt; &lt;new&gt;<br>nach dem Umbenennen eines
  1601. Ger&auml;tes.</li>
  1602. <li>UNDEFINED &lt;defspec&gt;<br>beim Auftreten einer Nachricht f&uuml;r
  1603. ein undefiniertes Ger&auml;t.</li>
  1604. <li>MODIFIED &lt;defspec&gt;<br>nach &Auml;nderung einer
  1605. Ger&auml;tedefinition.</li>
  1606. <li>UPDATE<br>nach Abschluss eines Updates.</li>
  1607. </ul>
  1608. </ul>
  1609. <!-- global end - diese Zeile nicht entfernen! -->
  1610. <a name="perl"></a>
  1611. <h3>Perl specials</h3>
  1612. Wenn Sie einige Aufgaben automatisieren wollen, dann sollten Sie die Befehle
  1613. <a href="#at">at</a> oder <a href="#notify">notify</a> nutzen. F&uuml;r
  1614. komplexere Aufgaben sollten Sie lieber ein SHELL-Skript oder einen PERL
  1615. "oneliner" als das at/notify argument anwenden. Dieser Abschnitt gibt Ihnen
  1616. einige Tipps zur Anwendung der PERL-oneliner.<br><br>
  1617. <li>Um PERL-&quot;oneliner&quot; zu testen, geben Sie diese am
  1618. &quot;telnet&quot; Prompt (oder in der FHEMWEB Text-Eingabezeile)
  1619. eingeschlossen von geschweiften Klammern {} in einer Zeile ein. Die letzte
  1620. Beispielzeile schreibt nur etwas in die Logdatei, w&auml;hrend das Ergebnis
  1621. der anderen Zeilen direkt auf der Webseite sichtbar ist.<ul>
  1622. Beispiele:<p>{ "Hello" }<br>
  1623. { 1+3*4 }<br>
  1624. { `ls /etc` }<br>
  1625. { Log 1, "Hello" }<br>
  1626. </p>
  1627. </ul>
  1628. <br>
  1629. </li>
  1630. <li>
  1631. PERL Ausdr&uuml;cke werden durch ein Semikolon (;) getrennt. In FHEM
  1632. &quot;oneliners&quot; m&uuml;ssen sie durch ein weiteres Semikolon (;;)
  1633. &quot;escaped&quot; (maskiert) werden<br>
  1634. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Beispiel:<ul>
  1635. { my $a = 1+1;; Log 1, "Hello $a" }
  1636. </ul>
  1637. </li><br>
  1638. <li>Um FHEM-Kommandos in den PERL-Ausdr&uuml;cken zu verwenden, benutzen
  1639. Sie bitte die Funktion <var>fhem()</var>, mit einem Textargument. Dieser Text wird als
  1640. FHEM-Kommando interpretiert.<br>
  1641. <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Beispiel<ul>
  1642. { fhem "set light on" }<br>
  1643. define n1 notify piri:on { fhem "set light on" }
  1644. <p>&nbsp;</p>
  1645. </ul>
  1646. Bemerkung: Wenn diese Funktion einen wert zur&uuml;ck liefert, wird dieser
  1647. in der allgemeinen Logdatei gespeichert.. Benutzen sie &quot;1&quot; als
  1648. zweites Argument um dieses speichern zu verhindern. Sinnvoll ist dieses
  1649. Argument bei der Abfrage von Werten mittels "get...".
  1650. </li><br>
  1651. <li>Notify kann auch dazu verwendet werden, um Macros manuell
  1652. auszuf&uuml;hren. Verwenden Sie den <a href="#trigger">trigger</a>-Befehl
  1653. um das Makro zu starten:<br>
  1654. <ul>
  1655. define MyMacro notify MyMacro { Log 1, "Hello"}<br>
  1656. trigger MyMacro<br>
  1657. define MacroWithArg notify MyMacro { Log 1, "Hello %"}<br>
  1658. trigger MyMacro MyArg<br>
  1659. </ul>
  1660. <br>
  1661. </li>
  1662. <li>Um die Verwendung von Datum und Zeitangaben zu vereinfachen, wurden die
  1663. Variablen <var>$sec</var>, <var>$min</var>, <var>$hour</var>, <var>$mday</var>,
  1664. <var>$month</var>, <var>$year</var>, <var>$wday</var>, <var>$yday</var>, <var>$isdst</var> und <var>$hms</var>
  1665. f&uuml;r die Verwendung in PERL-&quot;oneliners&quot; eingef&uuml;hrt (s.
  1666. unter <var>perldoc -f localtime</var>). Ausnahmen: <var>$month</var> hat einen Wertebereich von 1
  1667. bis 12 und <var>$year</var> ist korrigiert von 1900.
  1668. Weiterhin enth&auml;lt <var>$hms</var> die Zeit in dem HH:MM:SS Format und <var>$today</var> das
  1669. aktuellen Datum in YYYY-MM-DD Format.
  1670. <br>
  1671. Die Variabe <var>$we</var> hat den Wert 1 wenn der abgefragte Tag auf ein Wochenende
  1672. f&auml;llt (Z.B. <var>$wday</var> == 0 [Sonntag] oder <var>$wday</var> == 6 [Samstag]), und 0
  1673. f&uuml;r die anderen Wochentage. Wenn man das global <a
  1674. href="#holiday2we">holiday2we</a> Attribut setzt, dann ist <var>$we</var> ebenfalls 1
  1675. bei Urlaubstagen.<br>
  1676. <ul>
  1677. define n2 notify piri:on { if($hour &gt; 18 || $hour &lt; 5) {
  1678. fhem "set light on" } }<br>
  1679. define roll_en *07:45:00 { fhem "trigger SwitchAllRoll on" if(!$we) }<br>
  1680. define roll_en *08:30:00 { fhem "trigger SwitchAllRoll on" if($we) }<br>
  1681. </ul>
  1682. <br>
  1683. </li><li>
  1684. Die folgenden Hilfsfunktionen sind in der Datei 99_Util.pm definiert (wird
  1685. wie jede mit 99_ beginnende Datei automatisch geladen):
  1686. <ul>
  1687. <li>min(a,b), max(a,b)</li>
  1688. <li>time_str2num("YYYY-MM-DD HH:MM:SS") gibt einen numerischen Wert
  1689. zur&uuml;ck, der die Berechnung von Zeitdifferenzen vereinfacht</li>
  1690. <li>abstime2rel("HH:MM:SS") wandelt absolute in relative Zeitangaben um
  1691. </li>
  1692. </ul>
  1693. </li>
  1694. <li>
  1695. Um auf die Ger&auml;testatus/Attribute zuzugreifen benutzen Sie bitte die
  1696. folgenden Funktionen:
  1697. <br>
  1698. <ul>
  1699. <li>Value(&lt;devicename&gt;)<br>
  1700. gibt den Status eines Ger&auml;tes zur&uuml;ck (entsprechend dem
  1701. Ausdruck in Klammern, den Sie beim List-Befehl sehen).
  1702. </li><br>
  1703. <li>OldValue(&lt;devicename&gt;)</li>
  1704. <li>OldTimestamp(&lt;devicename&gt;)<br>
  1705. gibt den vorherigen Wert/Zeitstempel des Ger&auml;tes zur&uuml;ck.
  1706. </li><br>
  1707. <li>
  1708. ReadingsVal(&lt;devicename&gt;,&lt;reading&gt;,&lt;defaultvalue&gt;)<br>
  1709. Gibt den Inhalt der &quot;readings&quot; zur&uuml;ck (den Inhalt der in
  1710. dem &quot;Readings&quot;-Abschnitt von "list device" angezeigt wird)
  1711. </li><br>
  1712. <li>
  1713. ReadingsNum(&lt;devicename&gt;,&lt;reading&gt;,
  1714. &lt;defaultvalue&gt;,&lt;round&gt;)<br>
  1715. Gibt die erste Zahl aus dem Readingswert zur&uuml;ck.
  1716. Falls &lt;round&gt; spezifiziert ist, wird sie auf diese Anzahl von
  1717. Dezimalstellen gerundet.
  1718. </li><br>
  1719. <li>ReadingsTimestamp(&lt;devicename&gt;,
  1720. &lt;reading&gt;,&lt;defaultvalue&gt;)<br>
  1721. gibt den Zeitstempel des Readings zur&uuml;ck.
  1722. </li><br>
  1723. <li>ReadingsAge(&lt;devicename&gt;,&lt;reading&gt;,&lt;defaultvalue&gt;)
  1724. <br>
  1725. gibt das Alter des Readings in Sekunden zur&uuml;ck.
  1726. </li><br>
  1727. <li>
  1728. OldReadingsVal(&lt;devicename&gt;,&lt;reading&gt;
  1729. ,&lt;defaultvalue&gt;)<br>
  1730. OldReadingsNum(&lt;devicename&gt;,&lt;reading&gt;,
  1731. &lt;defaultvalue&gt;,&lt;round&gt;)<br>
  1732. OldReadingsTimestamp(&lt;devicename&gt;,&lt;reading&gt;
  1733. ,&lt;defaultvalue&gt;)<br>
  1734. OldReadingsAge(&lt;devicename&gt;,&lt;reading&gt;,&lt;
  1735. defaultvalue&gt;)<br>
  1736. analog zu den Routinen oben, aber zum Zugriff auf die vorherigen Werte.
  1737. siehe: <a href="#oldreadings">oldreadings</a><br>
  1738. </li><br>
  1739. <li>
  1740. AttrVal(&lt;devicename&gt;,&lt;attribute&gt;,&lt;defaultvalue&gt;)<br>
  1741. Gibt das entsprechende Attribut des Ger&auml;tes zur&uuml;ck
  1742. <br><br>
  1743. { Value("wz") }<br>
  1744. { OldValue("wz") }<br>
  1745. { time_str2num(OldTimestamp("wz")) }<br>
  1746. { ReadingsVal("wz", "measured-temp", "20")+0 }<br>
  1747. { ReadingsTimestamp("wz", "measured-temp", 0)}<br>
  1748. { AttrVal("wz", "room", "none") }<br>
  1749. </li><br>
  1750. <li>
  1751. AttrNum(&lt;devicename&gt;,&lt;attribute&gt;,
  1752. &lt;defaultvalue&gt;,&lt;round&gt;)<br>
  1753. Gibt die erste Zahl aus dem Attributwert zur&uuml;ck.
  1754. Falls &lt;round&gt; spezifiziert ist, wird sie auf diese Anzahl von
  1755. Dezimalstellen gerundet.
  1756. </li><br>
  1757. <li>
  1758. InternalVal(&lt;devicename&gt;,&lt;internal&gt;,
  1759. &lt;defaultvalue&gt;)<br>
  1760. Gibt den Inhalt der &quot;internal&quot; zur&uuml;ck (den Inhalt der in
  1761. dem &quot;Internals&quot;-Abschnitt von "list device" angezeigt wird)
  1762. </li><br>
  1763. <li>
  1764. InternalNum(&lt;devicename&gt;,&lt;internal&gt;,
  1765. &lt;defaultvalue&gt;,&lt;round&gt;)<br>
  1766. Gibt die erste Zahl aus dem &quot;internal&quot; zur&uuml;ck.
  1767. Falls &lt;round&gt; spezifiziert ist, wird sie auf diese Anzahl von
  1768. Dezimalstellen gerundet.
  1769. </li><br>
  1770. </ul>
  1771. </li><li>
  1772. Wenn Sie das 99_SUNRISE_EL.pm Modul benutzen, haben Sie zugriff auf
  1773. folgende Funktionen: <br>
  1774. <ul>
  1775. sunset($offset, $min, $max)<br>
  1776. sunrise($offset, $min, $max)<br>
  1777. isday()<br>
  1778. </ul>
  1779. Der Wert von &quot;offset&quot; wird in Sekunden angegeben und das Format
  1780. f&uuml;r min/max ist "HH:MM" oderr "HH:MM:SS". isday gibt 1 zur&uuml;ck,
  1781. wenn die Sonne sichtbar ist und ansonsten den Wert 0. </li>
  1782. <br>
  1783. <br>
  1784. <!-- perl end - diese Zeile nicht entfernen! -->
  1785. <a name="gnuplot-syntax"></a>
  1786. <h3>gnuplot file syntax</h3>
  1787. Die .gplot Dateien werden ebenso von den <a href="#FHEMWEB">FHEMWEB</a>/SVG
  1788. Modulen falls das <a href="#plotmode">plotmode</a>-Attribut auf SVG gesetzt
  1789. ist. In diesem Fall wird nur eine geringere Anzahl der .gnuplot Attribute
  1790. benutzt, und einige Linien haben eine besondere Bedeutung: Die Unterschiede
  1791. werden in diesem Kapitel erkl&auml;rt. Lesen Sie bitte auch <a
  1792. href="http://wiki.fhem.de/wiki/Creating_Plots"> diesen</a> FHEM Wiki Eintrag
  1793. zur Erstellung von Logdateien.<br> Im folgenden ist eine minimale .gplot
  1794. Definition (g&uuml;ltig nur bei Plotmode SVG):<br>
  1795. <pre> set terminal size &lt;SIZE&gt;
  1796. #FileLog 4:::
  1797. plot title 'Temperature' with lines
  1798. </pre>
  1799. Die .gnuplot Datei besteht aus 3 Teilen:
  1800. <ul>
  1801. <li>set Befehle<br>
  1802. Folgende &quot;sets&quot; werden erkannt:
  1803. <ul>
  1804. <li>terminal, nur die Gr&ouml;&szligenparameter.<br>
  1805. Dieser ist in der Regel auf &lt;SIZE&gt; gesetzt, welcher ersetzt wird
  1806. durch das <a href="#plotsize">plotsize</a> Attribut von FHEMWEB oder
  1807. einer Weblink-Instanz.</li>
  1808. <li>title<br>
  1809. Normalerweise gesetzt auf &lt;TL&gt; welcher durch das Weblink <a
  1810. href="#title">title</a>-Attribut, oder durch &lt;Lx&gt;, welches
  1811. wiederum vom Weblink <a href="#label">label</a> Attribut ersetzt
  1812. wird.</li>
  1813. <li>ylabel,y2label<br>
  1814. Linke und rechte vertikale Achsenbeschriftungen. Are also subject to
  1815. label replacement.</li>
  1816. <li>yrange,y2range<br>
  1817. Legen den Wertebereich der linken und rechten y-Achse fest.
  1818. Beispiele:<br>
  1819. <ul>
  1820. set yrange [-0.1:1.1]<br>
  1821. set y2range [0:]<br>
  1822. </ul>
  1823. </li>
  1824. <li>ytics,y2tics<br>
  1825. Beschriftung f&uuml;r die Werte der rechten/linken y-Achse.
  1826. Beispiele:<br>
  1827. <ul>
  1828. set ytics ("on" 0, "off" 1)<br>
  1829. set y2tics<br>
  1830. </ul>
  1831. </li>
  1832. </ul>
  1833. </li>
  1834. <br>
  1835. <li>#FileLog Eintr&auml;ge<br>
  1836. Jede Line des Plots muss eine dazugeh&ouml;rige #FileLog
  1837. Zeile haben. Zur Syntax lesen Sie bitte den Abschnitt &quot;column_spec
  1838. paragraph&quot; von der <a href="#FileLogget">Filelog get</a>
  1839. Beschreibung. Beachten sie bitte, das bei SVG-Plots die erste Spalte der
  1840. Datei unbedingt im FHEM-Zeitstempelformat (YYYY-MM-DD_HH:MM:SS)
  1841. formatiert sein muss
  1842. </li>
  1843. <br>
  1844. <li>Plot Eintr&auml;ge<br>
  1845. bestehen immer aus einem Plotbefehl und aus durch Kommata getrenne
  1846. Argumentbl&ouml;cke. Jeder Argumentblock repr&auml;sentiert eine
  1847. darzustellende Linie und hat seine eigenen Paramter.
  1848. Folgende Parameter werden are anerkannt:
  1849. <ul>
  1850. <li>axes x1y1 / x1y2<br>
  1851. weist das Programm an die aktuelle Zeile einer der beiden Achsen (links
  1852. oder rechts) zuzuweisen.&nbsp;
  1853. </li>
  1854. <li>title<br>
  1855. Beschriftung der Linie. Wenn man auf diesen Titel klickt, dann
  1856. &auml;ndert ein kleines Javascript-Programm den Titel auf die min/max
  1857. und last-Werte des Plots, Weiterhin erlaubt das Programm diese Linie zu
  1858. kopieren oder eine bereits kopierte Linie einzuf&uuml;gen (die
  1859. existierende Skalierung des Plots wird dabei nicht ver&auml;ndert, nur
  1860. die eingef&uuml;gte Linie wird skaliert/angepasst. Andere Linien des
  1861. Plots werden zeitweise nicht angezeigt.</li>
  1862. <li>with &lt;linetype&gt;<br>
  1863. spezifiziert die Art der Linie. Folgende Linienarten k&ouml;nnen
  1864. verwendet werden: points, steps, fsteps, histeps and lines. Nicht
  1865. bekannte Linienarten werden als Typ &quot;lines&quot; dargestellt.
  1866. SVG Spezial: cubic und quadratic werden zu den SVG path Typen C und Q
  1867. gewandelt.
  1868. </li>
  1869. <li>ls &lt;linestyle&gt;<br>
  1870. Der Linienstil stellt die erste Linie als l0 dar,&nbsp; die zweite
  1871. Linie als l1 und so weiter. Definiert ist dies in der svg_style.css
  1872. Datei. Darin sind zwei Sets definiert: l0-l8 and l0fill-l6fill. Das
  1873. zweite Set muss aber explizit angegeben werden. Wenn der Name des
  1874. Linienstils das Wort &quot;fill&quot; enth&auml;lt, dann haben Plots
  1875. des Linientyps "lines" ein zus&auml;tzliches Start- und Endsegment
  1876. f&uuml;r eine korrekte Darstellung.<br> Bitte lesen sie die SVG
  1877. Spezifikationen, um Details &uuml;ber diese css-Datei zu erfahren.
  1878. Notiz: Wenn Sie dieses Attribut einsetzen m&ouml;chten, m&uuml;ssen Sie
  1879. es f&uuml;r alle Linien (Attributblocks) im Plotbefehl spezifizieren.
  1880. </li>
  1881. <li>lw &lt;linewidth&gt;<br>
  1882. Setzt die Linienbreite der Linie. Dieses Attribut ist veraltet. Das
  1883. entprechende Feature der css-Datei/(Attribut ls) muss verwendet werden.
  1884. </li>
  1885. </ul>
  1886. </li></ul>
  1887. </div> <!-- right -->
  1888. </body>
  1889. </html>