2
0
mirror of https://github.com/fhem/fhem-mirror.git synced 2025-04-09 07:44:19 +00:00

telnet/autocreate: german doc added

git-svn-id: https://svn.fhem.de/fhem/trunk@4844 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
rudolfkoenig 2014-02-08 07:54:03 +00:00
parent 23c468f1a3
commit 6d79aba191
3 changed files with 322 additions and 10 deletions

View File

@ -488,6 +488,6 @@ at_State($$$$)
</ul>
=end html
=end html_DE
=cut

View File

@ -508,7 +508,6 @@ autocreate_Attr(@)
<code>define &lt;name&gt; autocreate</code><br>
<br>
<ul>
It makes no sense to create more than one instance of this module.
By defining an instance, the global attribute <a href=
"#autoload_undefined_devices">autoload_undefined_devices</a>
is set, so that modules for unknnown devices are automatically loaded.
@ -523,6 +522,9 @@ autocreate_Attr(@)
<a href="#disable">disable</a> attribute, in this case only the rename
hook is active, and you can use the <a href="#createlog">createlog</a>
command to add FileLog and SVG to an already defined device.
<b>Note 3:</b> It makes no sense to create more than one instance of this
module.
</ul>
<br>
@ -589,10 +591,7 @@ autocreate_Attr(@)
<b>createlog</b>
<ul>
Use this command to manually add a FileLog and an SVG to an existing
device. E.g. if a HomeMatic device is created automatically by something
else then a pairing message, the model is unknown, so no plots will be
generated. You can set the model/subtype attribute manually, and then call
createlog to add the corresponding logs.<br><br>
device.
This command is part of the autocreate module.
</ul>
<br>
@ -615,14 +614,171 @@ autocreate_Attr(@)
On Linux it will also check with the lsusb command, if unflashed CULs are
attached. If this is the case, it will call CULflash with the appropriate
parameters (or display the CULflash command if scan is specified). Only
one device to flash is displayed at a time.<br><br>
parameters (or display the CULflash command if scan is specified). The
usb command will only flash one device per call.<br><br>
This command is part of the autocreate module.
</ul>
</ul>
<br>
=end html
=begin html_DE
<a name="autocreate"></a>
<h3>autocreate</h3>
<ul>
Erzeugt f&uuml;r noch nicht definierte fhem-Ger&auml;te automatisch die
geignete Definition (define). Diese Definition wird aus einer Nachricht
gewonnen, die von diesen neuen Ger&auml;ten empfangen wurde. Hinweis:
Ger&auml;te, die mit Polling arbeiten (wie z.B. der Zugriff auf EMEM/EMWZ
&uuml;ber EM1010PC) werden NICHT automatisch erzeugt.
<br><br>
<a name="autocreatedefine"></a>
<b>Define</b>
<ul>
<code>define &lt;name&gt; autocreate</code><br>
<br>
<ul>
Durch die Definition dieser Instanz wird das globale Attribut <a
href="#autoload_undefined_devices">autoload_undefined_devices</a>
gesetzt, sodass die Module f&uuml;r unbekannte Ger&auml;te automatisch
nachgeladen werden. Das autocreate-Modul interpretiert das
UNDEFINED-event, welches von jedem Modul gestartet wird, erzeugt ein
Ger&auml;t (device) und bei Bedarf ein FileLog sowie
SVG-Eintr&auml;ge.<br>
<b>Hinweis 1:</b> Ger&auml;te werden mit einem eindeutigen Namen erzeugt,
der den Typ und eine individuelle ID f&uuml;r diesen Typ enth&auml;lt.
Wird ein Ger&auml;t umbenannt (<a href="#rename">rename</a>), wird
gleichzeitig das automatisch erzeugte FileLog und die SVG Ger&auml;te
unbenannt.<br>
<b>Hinweis 2:</b> Durch das Setzen des <a
href="#disable">disable</a>-Attributes kann die automatische Erzeugung
ausgeschaltet werden. In diesem Fall ist ausschlie&szlig;lich die oben
erl&auml;uterte Umbenennung aktiv. Der <a
href="#createlog">createlog</a>-Befehl kann zum Hinzuf&uuml;gen von
FileLog und SVG eines bereits definierten Ger&auml;tes benutzt werden.
<br>
<b>Hinweis 3:</b>Es macht keinen Sinn, die Instanz dieses Moduls mehrmals
zu erzeugen.
</ul>
<br>
Beispiel:<PRE>
define autocreate autocreate
attr autocreate autosave
attr autocreate device_room %TYPE
attr autocreate filelog test2/log/%NAME-%Y.log
attr autocreate weblink
attr autocreate weblink_room Plots
</PRE>
</ul>
<a name="autocreateset"></a>
<b>Set</b> <ul>N/A</ul><br>
<a name="autocreateget"></a>
<b>Get</b> <ul>N/A</ul><br>
<a name="autocreateattr"></a>
<b>Attribute</b>
<ul>
<a name="autosave"></a>
<li>autosave<br>
Nach der Erzeugung eines neuen Ger&auml;tes wird automatisch die
Konfigurationsdatei mit dem Befehl <a href="#save">save</a>
gespeichert. Der Standardwert ist 1 (d.h. aktiviert), eine 0 schaltet
die automatische Speicherung aus.</li><br>
<a name="device_room"></a>
<li>device_room<br>
"Schiebt" das neu erstellte Ger&auml;t in diesen Raum. Der Name kann
die Wildcards %NAME und %TYPE enthalten, siehe oben stehendes
Beispiel.</li><br>
<a name="filelogattr"></a>
<li>filelog<br>
Erstellt ein Filelog welches zu einem Ger&auml;t geh&ouml;rt. Der
Dateiname darf die Wildcards %NAME und %TYPE enthalten, siehe oben
stehendes Beispiel. Das Filelog wird in den gleichen Raum "geschoben"
wie das zugeh&ouml;rige Ger&auml;t.</li><br>
<a name="weblinkattr"></a>
<li>weblink<br>
Erzeugt ein SVG, welches mit dem Ger&auml;t/Filelog verkn&uuml;pft
ist.</li><br>
<a name="weblink_room"></a>
<li>weblink_room<br>
"Schiebt" das neu erstellte SVG in den bezeichneten Raum. Der Name kann
die Wildcards %NAME und %TYPE enthalten, siehe oben stehendes
Beispiel.</li><br>
<li><a href="#disable">disable</a></li>
<br>
<a name="ignoreTypes"></a>
<li>ignoreTypes<br>
Dies ist ein Regexp, um bestimmte Ger&auml;te zu ignorieren, z.b. der
Funk-Heizungsthermostat (FHT) des Nachbarn. In dem Ausdruck k&ouml;nnen
mehr als ein Ger&auml;t &uuml;ber die normale Regexp-Syntax angegeben
werden.<br>
Beispiel:<br>
<code>
attr autocreate ignoreTypes CUL_HOERMANN.*|FHT_1234|CUL_WS_7
</code>
</li>
</ul>
<br>
<a name="createlog"></a>
<b>createlog</b>
<ul>
Dieser Befehl wird f&uuml;r ein manuelles Hinzuf&uuml;gen eines Logfile
oder eines SVG zu einem vorhandenen Ger&auml;t verwendet.
<br><br>
Dieser Befehl ist Bestandteilteil des autocreate-Modules.
</ul>
<br>
<a name="usb"></a>
<b>usb</b>
<ul>
Verwendung:
<ul><code>
usb scan<br>
usb create<br>
</code></ul>
Dieser Befehl durchsucht das /dev-Verzeichnis nach angeschlossenen
USB-Ger&auml;ten und versucht gleichzeitig sie zu identifizieren. Mit dem
Argument scan wird eine Liste von ausf&uuml;hrbaren fhem-Befehlen
zur&uuml;ckgegeben. Das Argument create gibt keine Liste o.&auml;.
zur&uuml;ck, die Ger&auml;te werden stattdessen erzeugt.<br><br>
Es ist zu beachten, dass ein CUL immer noch manuell in den
HomeMatic-Modus umgeschaltet werden muss. <br><br>
Unter Linux wird gleichzeitig mit dem lsusb-befehl &uuml;berpr&uuml;ft,
ob nichtgeflashte CULs angeschlossen sind. Ist dies der Fall, ruft Linux
CULflash mit den geeigneten Parametern auf (oder zeigt den
CULflash-Befehl an, falls scan aufgef&uuml;hrt wurde).
Pro usb Befehl wird nur ein Ger&auml;t geflasht.<br><br>
Dieser Befehl ist Bestandteilteil des autocreate-Modules.
</ul>
</ul> <!-- End of autocreate -->
<br>
=end html_DE
=end html
=cut

View File

@ -471,6 +471,162 @@ telnet_ActivateInform($)
</ul>
=end html
=begin html_DE
<a name="telnet"></a>
<h3>telnet</h3>
<ul>
<br>
<a name="telnetdefine"></a>
<b>Define</b>
<ul>
<code>define &lt;name&gt; telnet &lt;portNumber&gt; [global]</code><br>
oder<br>
<code>define &lt;name&gt; telnet &lt;servername&gt:&lt;portNummer&gt;</code>
<br><br>
Erste Form, <b>Server</b>-mode:<br>
&Uuml;berwacht den TCP/IP-Port <code>&lt;portNummer&gt;</code> auf
ankommende Verbindungen. Wenn der zweite Parameter gobal <b>nicht</b>
angegeben wird, wird der Server nur auf Verbindungen von localhost achten.
<br>
F&uuml;r den Gebrauch von IPV6 muss die Portnummer als IPV6:&lt;nummer&gt;
angegeben werden, in diesem Fall wird das Perl-Modul IO::Socket:INET6
angesprochen. Unter Linux kann es sein, dass dieses Modul mittels cpan -i
IO::Socket::INET6 oder apt-get libio-socket-inet6-perl nachinstalliert werden
muss; OSX und Fritzbox-7390 enthalten bereits dieses Modul.<br>
Beispiele:
<ul>
<code>define tPort telnet 7072 global</code><br>
<code>attr tPort globalpassword mySecret</code><br>
<code>attr tPort SSL</code><br>
</ul>
Hinweis: Das alte (pre 5.3) "global attribute port" wird automatisch in
eine telnet-Instanz mit dem Namen telnetPort umgewandelt. Im Rahmen dieser
Umwandlung geht das globale Attribut allowfrom verloren.
<br><br>
Zweite Form, <b>Client</b>-mode:<br>
Verbindet zu einem angegebenen Server-Port und f&uuml;hrt die von dort aus
empfangenen Anweisungen - genau wie im Server-mode - aus. Dies kann
verwendet werden, um sich mit einer fhem-Instanz, die sich hinter einer
Firewall befindet, zu verbinden, f&uuml;r den Fall, wenn das Installieren
von Ausnahmen in der Firewall nicht erw&uuml;nscht oder nicht m&ouml;glich
sind. Hinweis: Dieser Client-mode unterst&uuml;tzt zwar SSL, aber nicht
IPV6.<br>
Beispiel:
<ul>
Starten von tcptee auf einem &ouml;ffentlich erreichbaren Host ausserhalb
der Firewall:<ul>
<code>perl contrib/tcptee.pl --bidi 3000</code></ul>
Konfigurieren von fhem innerhalb der Firewall:<ul>
<code>define tClient telnet &lt;tcptee_host&gt;:3000</code></ul>
Verbinden mit fhem (hinter der Firewall) von ausserhalb der Firewall:<ul>
<code>telnet &lt;tcptee_host&gt; 3000</code></ul>
</ul>
</ul>
<br>
<a name="telnetset"></a>
<b>Set</b> <ul>N/A</ul><br>
<a name="telnetget"></a>
<b>Get</b> <ul>N/A</ul><br>
<a name="telnetattr"></a>
<b>Attribute</b>
<ul>
<a name="password"></a>
<li>password<br>
Bezeichnet ein Passwort, welches als allererster String eingegeben
werden muss, nachdem die Verbindung aufgebaut wurde. Wenn das Argument
in {} eingebettet ist, dann wird es als Perl-Ausdruck ausgewertet, und
die Variable $password mit dem eingegebenen Passwort verglichen. Ist
der zur&uuml;ckgegebene Wert wahr (true), wurde das Passwort
akzeptiert. Falls dieser Parameter gesetzt wird, sendet fhem
telnet IAC Requests, um ein Echo w&auml;hrend der Passworteingabe zu
unterdr&uuml;cken. Ebenso werden alle zur&uuml;ckgegebenen Zeilen mit
\r\n abgeschlossen.
Beispiel:<br>
<ul>
<code>
attr tPort password secret<br>
attr tPort password {"$password" eq "secret"}
</code>
</ul>
Hinweis: Falls dieses Attribut gesetzt wird, muss als erstes Argument
ein Passwort angegeben werden, wenn fhem.pl im Client-mode betrieben
wird:
<ul>
<code>
perl fhem.pl localhost:7072 secret "set lamp on"
</code>
</ul>
</li><br>
<a name="globalpassword"></a>
<li>globalpassword<br>
Entspricht dem Attribut password; ein Passwort wird aber
ausschlie&szlig;lich f&uuml;r nicht-lokale Verbindungen verlangt.
</li><br>
<a name="SSL"></a>
<li>SSL<br>
SSL-Verschl&uuml;sselung f&uuml;r eine Verbindung aktivieren. <a
href="#HTTPS">Hier</a> gibt es eine Beschreibung, wie das erforderliche
SSL-Zertifikat generiert werden kann. Um eine Verbindung mit solch
einem Port herzustellen, sind folgende Befehle m&ouml;glich:
<ul>
<code>
socat openssl:fhemhost:fhemport,verify=0 readline<br>
ncat --ssl fhemhost fhemport<br>
openssl s_client -connect fhemhost:fhemport<br>
</code>
</ul>
</li><br>
<a name="allowfrom"></a>
<li>allowfrom<br>
Regexp der erlaubten IP-Adressen oder Hostnamen. Wenn dieses Attribut
gesetzt wurde, werden ausschlie&szlig;lich Verbindungen von diesen
Adressen akzeptiert.
</li><br>
<a name="connectTimeout"></a>
<li>connectTimeout<br>
Gibt die maximale Wartezeit in Sekunden an, in der die Verbindung
aufgebaut sein muss. Standardwert ist 2.
</li><br>
<a name="connectInterval"></a>
<li>connectInterval<br>
Gibt die Dauer an, die entweder nach Schlie&szlig;en einer Verbindung
oder f&uuml;r den Fall, dass die Verbindung nicht zustande kommt,
gewartet werden muss, bis ein erneuter Verbindungsversuch gestartet
werden soll. Standardwert ist 60.
</li><br>
<a name="encoding"></a>
<li>encoding<br>
Bezeichnet die Zeichentabelle f&uuml;r die zum Client gesendeten Daten.
M&ouml;gliche Werte sind utf8 und latin1. Standardwert ist utf8.
</li><br>
</ul>
</ul>
=end html_DE
=cut
1;