commandref_frame_DE.html 75 KB

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