mirror of
https://github.com/fhem/fhem-mirror.git
synced 2025-02-07 23:09:26 +00:00
OWServer, OWDevice: German documentation added
git-svn-id: https://svn.fhem.de/fhem/trunk@4950 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
borisneubert
parent
8f82cec4cd
commit
696b92be9d
@ -641,4 +641,129 @@ OWServer_Set($@)
|
||||
</ul>
|
||||
|
||||
=end html
|
||||
=begin html_DE
|
||||
|
||||
<a name="OWServer"></a>
|
||||
<h3>OWServer</h3>
|
||||
<ul>
|
||||
<br>
|
||||
<a name="OWDevicedefine"></a>
|
||||
<b>Definition</b>
|
||||
<ul>
|
||||
<code>define <name> OWServer <protocol></code>
|
||||
<br><br>
|
||||
|
||||
Definiert eine logische OWServer- Instanz. OWServer ist die Serverkomponente des
|
||||
<a href="http://owfs.org">1-Wire Dateisystems</a>. Sie ermöglicht den Zugriff auf
|
||||
alle 1-Wire- Busteilnehmer eines Systems.<br><br>
|
||||
<protocol> hat das Format <hostname>:<port> Nähere Informationen dazu gibt es in der <a href="http://owfs.org/index.php?page=owserver_protocol">owserver Dokumentation</a>.
|
||||
<br><br>
|
||||
Voraussetzung innerhalb von FHEM ist das Modul <a href="http://owfs.cvs.sourceforge.net/viewvc/owfs/owfs/module/ownet/perl5/OWNet/lib/OWNet.pm">OWNet.pm von owfs.org</a>, welches bereits mit FHEM ausgeliefert wird.
|
||||
Das auf CPAN erhältliche OWNet- Modul beinhaltet seit dem 23.12.2012 einen Fehler, der es für Fernzugriffe unbrauchbar macht.<p>
|
||||
Auf dem Computer, an dem der 1-Wire- Bus angeschlossen ist, muss die Software "owserver" installiert sein. Zusätzlich sollte auf diesem Rechner die Konfigurationsdatei "owfs.conf" eingesehen bzw. angepasst werden. <a href="http://www.fhemwiki.de/wiki/OWServer_%26_OWDevice#Tipps_und_Tricks"> Einen WIKI- Artikel dazu gibt es hier.</a>
|
||||
<br><br>
|
||||
Die vorhandenen 1-Wire- Busteilnehmer werden als <a href="#OWDevice">OWDevice</a> -Geräte definiert.
|
||||
Wenn <a href="#autocreate">autocreate</a> aktiviert ist, werden beim Start von FHEM alle Geräte automatisch erkannt und eingerichtet.
|
||||
<br><br>
|
||||
<b>Achtung: Dieses Modul ist weder verwandt noch verwendbar mit den 1-Wire Modulen, deren Namen nur aus Großbuchstaben bestehen!</b>
|
||||
<br><br>
|
||||
Beispiele für die Einrichtung:
|
||||
<ul>
|
||||
<code>define myLocalOWServer OWServer localhost:4304</code><br>
|
||||
<code>define myRemoteOWServer OWServer 192.168.1.100:4304</code><br>
|
||||
<code>define myRemoteOWServer OWServer raspi:4304</code><br>
|
||||
</ul>
|
||||
<br>
|
||||
Hinweis: Sollten keine Geräte erkannt werden, kann man versuchen in der owserver- Konfigurationsdatei (owfs.conf) zwei Servereinträge anzulegen:
|
||||
Einen mit <code>localhost</code> und einen mit dem "FQDN", bzw. dem Hostnamen, oder der IP-Adresse des Computers, auf dem die Software "owserver" läuft.
|
||||
<br><br>
|
||||
|
||||
</ul>
|
||||
|
||||
<a name="OWServerset"></a>
|
||||
<b>Set- Befehle</b>
|
||||
<ul>
|
||||
<code>set <name> <value></code>
|
||||
<br><br>
|
||||
wobei <code>value</code> für einen der folgenden Befehle steht:<br><br>
|
||||
<li><code>reopen</code><br>
|
||||
Erneuert die Verbindung zum owserver.
|
||||
</li>
|
||||
<li>owserver (OWFS) -spezifische Einstellungen:
|
||||
<ul>
|
||||
<li><code>timeout/directory</code></li>
|
||||
<li><code>timeout/ftp</code></li>
|
||||
<li><code>timeout/ha7</code></li>
|
||||
<li><code>timeout/network</code></li>
|
||||
<li><code>timeout/presence</code></li>
|
||||
<li><code>timeout/serial</code></li>
|
||||
<li><code>timeout/server</code></li>
|
||||
<li><code>timeout/stable</code></li>
|
||||
<li><code>timeout/uncached</code></li>
|
||||
<li><code>timeout/usb</code></li>
|
||||
<li><code>timeout/volatile</code></li>
|
||||
<li><code>timeout/w1</code></li>
|
||||
<li><code>units/pressure_scale</code></li>
|
||||
<li><code>units/temperature_scale</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
Nähere Informationen zu diesen Einstellungen gibt es im <a href="http://owfs.org/uploads/owserver.1.html#sect41">owserver- Manual</a>.
|
||||
<br>
|
||||
</ul>
|
||||
<br><br>
|
||||
|
||||
|
||||
<a name="OWServerget"></a>
|
||||
<b>Get- Befehle</b>
|
||||
<ul>
|
||||
<code>get <name> <value></code>
|
||||
<br><br>
|
||||
wobei <code>value</code> für einen der folgenden Befehle steht:<br><br>
|
||||
<li><code>devices</code><br>
|
||||
Gibt eine Liste der Adressen und Typen aller von owserver erkannten Geräte aus. Außerdem
|
||||
werden die entsprechenden <a href="#OWDevice">OWDevice-</a> Namen angezeigt, soweit sie bereits definiert sind.
|
||||
</li>
|
||||
<li><code>errors</code><br>
|
||||
Liefert eine Fehlerstatistik zurück.</li>
|
||||
<li>owserver (OWFS) -spezifische Einstellungen:
|
||||
<ul>
|
||||
<li><code>/settings/timeout/directory</code></li>
|
||||
<li><code>/settings/timeout/ftp</code></li>
|
||||
<li><code>/settings/timeout/ha7</code></li>
|
||||
<li><code>/settings/timeout/network</code></li>
|
||||
<li><code>/settings/timeout/presence</code></li>
|
||||
<li><code>/settings/timeout/serial</code></li>
|
||||
<li><code>/settings/timeout/server</code></li>
|
||||
<li><code>/settings/timeout/stable</code></li>
|
||||
<li><code>/settings/timeout/uncached</code></li>
|
||||
<li><code>/settings/timeout/usb</code></li>
|
||||
<li><code>/settings/timeout/volatile</code></li>
|
||||
<li><code>/settings/timeout/w1</code></li>
|
||||
<li><code>/settings/units/pressure_scale</code></li>
|
||||
<li><code>/settings/units/temperature_scale</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
Nähere Informationen zu diesen Einstellungen gibt es im <a href="http://owfs.org/uploads/owserver.1.html#sect41">owserver- Manual</a>.
|
||||
<br>
|
||||
</ul>
|
||||
<p>
|
||||
|
||||
<a name="OWDeviceattr"></a>
|
||||
<b>Attribute</b>
|
||||
<ul>
|
||||
<li>nonblocking<br>
|
||||
Holt alle readings (OWServer / <a href="#OWDevice">OWDevice</a>) über einen Tochterprozess. Dieses Verfahren stellt sicher,
|
||||
dass FHEM während der Kommunikation mit owserver nicht angehalten wird.<br>
|
||||
Beispiel:<br>
|
||||
<code> attr <name> nonblocking 1</code>
|
||||
</li>
|
||||
<li><a href="#eventMap">eventMap</a></li>
|
||||
<li><a href="#readingFnAttributes">readingFnAttributes</a></li>
|
||||
</ul>
|
||||
<br>
|
||||
Hinweis: Falls in FHEM trotzdem ungewöhnliche Stillstände auftreten, sollte das Attribut <code>nonblocking</code> wieder deaktiviert werden.<br>
|
||||
|
||||
</ul>
|
||||
|
||||
=end html_DE
|
||||
=cut
|
||||
|
||||
@ -875,4 +875,158 @@ OWDevice_InitValues($)
|
||||
|
||||
|
||||
=end html
|
||||
=begin html_DE
|
||||
|
||||
<a name="OWDevice"></a>
|
||||
<h3>OWDevice</h3>
|
||||
<ul>
|
||||
<br>
|
||||
<a name="OWDevicedefine"></a>
|
||||
<b>Definition</b>
|
||||
<ul>
|
||||
<code>define <name> OWDevice <address> [<interval>]</code>
|
||||
<br><br>
|
||||
|
||||
Definiert ein 1-Wire- Gerät. 1-Wire- Geräte werden anhand ihrer Adresse <address> definiert. Diese wird
|
||||
durch den zuvor eingerichteten <a href="#OWServer">OWServer</a> bereitgestellt.
|
||||
<br><br>
|
||||
|
||||
Wird zusätzlich <interval> angegeben, ruft OWServer alle <interval> Sekunden
|
||||
einen Datensatz des Gerätes ab.
|
||||
<br><br>
|
||||
|
||||
Jedes OWDevice ist ein eigenständiges Gerät. Seine Eigenschaften werden erstmals zum Zeitpunkt der Definition
|
||||
abgefragt. Die durch "get" oder "set" erzeugten, sowie durch den zyklischen Abruf gelieferten readings,
|
||||
können mit dem Kommando <code><a href="#list">list</a> <name></code> angezeigt werden.
|
||||
<br><br>
|
||||
Folgende 1-Wire- und iButton- Komponenten werden aktuell unterstützt:
|
||||
<ul>
|
||||
<li>DS2401 - Im Chip integrierte Seriennummer</li>
|
||||
<li>DS1990A - iButton mit fester Seriennummer</li>
|
||||
<li>DS2405 - Adressierbarer Schalter</li>
|
||||
<li>DS18S20 - Hochpräzisions-Digital-Thermosensor</li>
|
||||
<li>DS1920 - iButton-Thermosensor</li>
|
||||
<li>DS2406, DS2407 - Dualer adressierbarer Schalter mit 1 kbit Speicher</li>
|
||||
<li>DS2436 - Batterie-ID/Monitor- Schaltkreis</li>
|
||||
<li>DS2423 - Dual-Zählerbaustein mit Speicherfunktion</li>
|
||||
<li>DS2450 - Vierfach-A/D Umsetzer</li>
|
||||
<li>DS1822 - Econo-Thermosensor</li>
|
||||
<li>DS2415 - Zeitgeber- Schaltkreis </li>
|
||||
<li>DS1904 - iButton-Echtzeituhr</li>
|
||||
<li>DS2438 - Smart-Batterie-Monitor</li>
|
||||
<li>DS2417 - Zeitgeber-Schaltkreis mit Interrupt</li>
|
||||
<li>DS18B20 - Thermosensor mit programmierbarer Auflösung</li>
|
||||
<li>DS2408 - 8-kanaliger adressierbarer Schalter</li>
|
||||
<li>DS2413 - 2-kanaliger adressierbarer Schalter</li>
|
||||
<li>DS1825 - Thermosensor mit programmierbarer Auflösung und ID</li>
|
||||
<li>EDS0066 - Vielfachsensor für Temperatur und Luftdruck</li>
|
||||
<li>LCD - LCD-Ansteuerung von Louis Swart</li>
|
||||
</ul>
|
||||
<br>
|
||||
Das Hinzufügen weiterer Geräte ist im Modulcode (subroutine <code>OWDevice_GetDetails</code>) sehr einfach möglich.
|
||||
<br><br>
|
||||
<b>Achtung: Dieses Modul ist weder verwandt noch verwendbar mit den 1-Wire Modulen, deren Namen nur aus Großbuchstaben bestehen!</b>
|
||||
<br><br>
|
||||
<b>Bitte beachten:</b> Um einer Verwechselung entgegenzuwirken, stößt das reading "state" der Geräte keine Events an.<br><br>
|
||||
|
||||
Beispiele zur Einrichtung:
|
||||
<ul>
|
||||
<code>
|
||||
define myOWServer localhost:4304<br><br>
|
||||
get myOWServer devices<br>
|
||||
10.487653020800 DS18S20<br><br>
|
||||
define myT1 10.487653020800<br><br>
|
||||
list myT1 10.487653020800<br>
|
||||
Internals:<br>
|
||||
...<br>
|
||||
Readings:<br>
|
||||
2012-12-22 20:30:07 temperature 23.1875<br>
|
||||
Fhem:<br>
|
||||
...<br>
|
||||
getters:<br>
|
||||
address<br>
|
||||
family<br>
|
||||
id<br>
|
||||
power<br>
|
||||
type<br>
|
||||
temperature<br>
|
||||
templow<br>
|
||||
temphigh<br>
|
||||
polls:<br>
|
||||
temperature<br>
|
||||
setters:<br>
|
||||
alias<br>
|
||||
templow<br>
|
||||
temphigh<br>
|
||||
...<br>
|
||||
</code>
|
||||
</ul>
|
||||
<br>
|
||||
</ul>
|
||||
|
||||
<a name="OWDeviceset"></a>
|
||||
<b>Set-Befehle</b>
|
||||
<ul>
|
||||
<li><code>set <name> interval <value></code>
|
||||
<br>
|
||||
<code>value</code> überschreibt das Abrufintervall der Datensätze. Der Wert ist in Sekunden anzugeben.
|
||||
</li><br>
|
||||
<li><code>set <name> <reading> <value></code>
|
||||
<br>
|
||||
Setzt das <reading> auf <value> für das 1-Wire-Gerät <name>. Die verwendbaren Werte werden durch die
|
||||
jeweiligen 1-wire-Geräte bestimmt.
|
||||
<br><br>
|
||||
Beispiel:
|
||||
<ul>
|
||||
<code>set myT1 templow 5</code><br>
|
||||
</ul>
|
||||
<br>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<a name="OWDeviceget"></a>
|
||||
<b>Get-Befehle</b>
|
||||
<ul>
|
||||
<code>get <name> <reading> <value></code>
|
||||
<br>
|
||||
Holt das <reading> des 1- Wire Geräte- <name>. Die verwendbaren Werte werden durch die
|
||||
jeweiligen 1-wire-Geräte bestimmt.
|
||||
<br><br>
|
||||
Beispiel:
|
||||
<ul>
|
||||
<code>get myT1 temperature</code><br>
|
||||
</ul>
|
||||
<br>
|
||||
</ul>
|
||||
|
||||
|
||||
<a name="OWDeviceattr"></a>
|
||||
<b>Attribute</b>
|
||||
<ul>
|
||||
<a name="IODev"></a>
|
||||
<li>IODev:
|
||||
Bestimmt die OWServer-Instanz, welche für das Senden und Abrufen der Daten
|
||||
eines OWDevice-Gerätes genutzt werden soll. Hinweis: Während des Starts
|
||||
ordnet FHEM die neuen OWDevice-Geräte der jeweils zuletzt definierten OWServer-Instanz zu.
|
||||
Deshalb verfährt man idealerweise so, dass man zuerst eine OWServer-Instanz und
|
||||
anschließend die zugehörigen OWDevice-Geräte definiert. Danach definiert man die
|
||||
nächste OWServer-Instanz, gefolgt von den zugehörigen OWDevice-Geräten, usw.
|
||||
</li>
|
||||
<li>trimvalues: Entfernt voran- und nachgestellte Leerzeichen aus den readings. Standartwert ist 1 (ein).</li>
|
||||
<li>polls: Eine per Komma getrennte Liste der abzurufenden readings. Mit diesem Attribut unterdrückt man alle standartmäßig abgerufenen readings und ersetzt sie durch die eigene Zusammenstellung.</li>
|
||||
<li>interfaces: Ersetzt die durch dieses Gerät erzeugten Interfaces.</li>
|
||||
<li>model: Angabe des Gerätetyps, z.B.: DS18S20.</li>
|
||||
<li>resolution: Angabe der Auflösung für die Temperaturmessung in bits, zur Verfügung stehen: 9, 10, 11 oder 12.
|
||||
Hinweis: Geringere Auflösungen bewirken schnellere Reaktionen des Busses. Dies kann z.B. bei umfangreichen 1-Wire- Installationen hilfreich sein,
|
||||
um eventuelle Stillstände von FHEM zu vermindern.</li>
|
||||
<li><a href="#eventMap">eventMap</a></li>
|
||||
<li><a href="#readingFnAttributes">readingFnAttributes</a></li>
|
||||
</ul>
|
||||
<br><br>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
=end html_DE
|
||||
=cut
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user