From 6d79aba19112c609492476b59b0e09d82d4b4eac Mon Sep 17 00:00:00 2001
From: rudolfkoenig <>
Date: Sat, 8 Feb 2014 07:54:03 +0000
Subject: [PATCH] telnet/autocreate: german doc added
git-svn-id: https://svn.fhem.de/fhem/trunk@4844 2b470e98-0d58-463d-a4d8-8e2adae1ed80
---
fhem/FHEM/90_at.pm | 2 +-
fhem/FHEM/98_autocreate.pm | 172 +++++++++++++++++++++++++++++++++++--
fhem/FHEM/98_telnet.pm | 158 +++++++++++++++++++++++++++++++++-
3 files changed, 322 insertions(+), 10 deletions(-)
diff --git a/fhem/FHEM/90_at.pm b/fhem/FHEM/90_at.pm
index 40f6f5d6e..e6a2db7e5 100755
--- a/fhem/FHEM/90_at.pm
+++ b/fhem/FHEM/90_at.pm
@@ -488,6 +488,6 @@ at_State($$$$)
-=end html
+=end html_DE
=cut
diff --git a/fhem/FHEM/98_autocreate.pm b/fhem/FHEM/98_autocreate.pm
index 1d2a8ff16..2bef60a7b 100644
--- a/fhem/FHEM/98_autocreate.pm
+++ b/fhem/FHEM/98_autocreate.pm
@@ -508,7 +508,6 @@ autocreate_Attr(@)
define <name> autocreate
- It makes no sense to create more than one instance of this module.
By defining an instance, the global attribute autoload_undefined_devices
is set, so that modules for unknnown devices are automatically loaded.
@@ -523,6 +522,9 @@ autocreate_Attr(@)
disable attribute, in this case only the rename
hook is active, and you can use the createlog
command to add FileLog and SVG to an already defined device.
+ Note 3: It makes no sense to create more than one instance of this
+ module.
+
@@ -589,10 +591,7 @@ autocreate_Attr(@)
createlog
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.
+ device.
This command is part of the autocreate module.
@@ -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.
+ parameters (or display the CULflash command if scan is specified). The
+ usb command will only flash one device per call.
This command is part of the autocreate module.
+
+
+
+=end html
+
+=begin html_DE
+
+
+autocreate
+
+
+ Erzeugt für noch nicht definierte fhem-Geräte automatisch die
+ geignete Definition (define). Diese Definition wird aus einer Nachricht
+ gewonnen, die von diesen neuen Geräten empfangen wurde. Hinweis:
+ Geräte, die mit Polling arbeiten (wie z.B. der Zugriff auf EMEM/EMWZ
+ über EM1010PC) werden NICHT automatisch erzeugt.
+
+
+
+ Define
+
+ define <name> autocreate
+
+
+ Durch die Definition dieser Instanz wird das globale Attribut autoload_undefined_devices
+ gesetzt, sodass die Module für unbekannte Geräte automatisch
+ nachgeladen werden. Das autocreate-Modul interpretiert das
+ UNDEFINED-event, welches von jedem Modul gestartet wird, erzeugt ein
+ Gerät (device) und bei Bedarf ein FileLog sowie
+ SVG-Einträge.
+
+ Hinweis 1: Geräte werden mit einem eindeutigen Namen erzeugt,
+ der den Typ und eine individuelle ID für diesen Typ enthält.
+ Wird ein Gerät umbenannt (rename), wird
+ gleichzeitig das automatisch erzeugte FileLog und die SVG Geräte
+ unbenannt.
+
+ Hinweis 2: Durch das Setzen des disable-Attributes kann die automatische Erzeugung
+ ausgeschaltet werden. In diesem Fall ist ausschließlich die oben
+ erläuterte Umbenennung aktiv. Der createlog-Befehl kann zum Hinzufügen von
+ FileLog und SVG eines bereits definierten Gerätes benutzt werden.
+
+
+ Hinweis 3:Es macht keinen Sinn, die Instanz dieses Moduls mehrmals
+ zu erzeugen.
+
+
+
+
+ Beispiel:
+ 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
+
+
+
+
+
+ Set
+
+
+ Get
+
+
+ Attribute
+
+
+ - autosave
+ Nach der Erzeugung eines neuen Gerätes wird automatisch die
+ Konfigurationsdatei mit dem Befehl save
+ gespeichert. Der Standardwert ist 1 (d.h. aktiviert), eine 0 schaltet
+ die automatische Speicherung aus.
+
+
+ - device_room
+ "Schiebt" das neu erstellte Gerät in diesen Raum. Der Name kann
+ die Wildcards %NAME und %TYPE enthalten, siehe oben stehendes
+ Beispiel.
+
+
+ - filelog
+ Erstellt ein Filelog welches zu einem Gerät gehö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örige Gerät.
+
+
+ - weblink
+ Erzeugt ein SVG, welches mit dem Gerät/Filelog verknüpft
+ ist.
+
+
+ - weblink_room
+ "Schiebt" das neu erstellte SVG in den bezeichneten Raum. Der Name kann
+ die Wildcards %NAME und %TYPE enthalten, siehe oben stehendes
+ Beispiel.
+
+ - disable
+
+
+
+ - ignoreTypes
+ Dies ist ein Regexp, um bestimmte Geräte zu ignorieren, z.b. der
+ Funk-Heizungsthermostat (FHT) des Nachbarn. In dem Ausdruck können
+ mehr als ein Gerät über die normale Regexp-Syntax angegeben
+ werden.
+
+ Beispiel:
+
+ attr autocreate ignoreTypes CUL_HOERMANN.*|FHT_1234|CUL_WS_7
+
+
+
+
+
+
+
+ createlog
+
+ Dieser Befehl wird für ein manuelles Hinzufügen eines Logfile
+ oder eines SVG zu einem vorhandenen Gerät verwendet.
+
+ Dieser Befehl ist Bestandteilteil des autocreate-Modules.
+
+
+
+
+ usb
+
+ Verwendung:
+
+ usb scan
+ usb create
+
+ Dieser Befehl durchsucht das /dev-Verzeichnis nach angeschlossenen
+ USB-Geräten und versucht gleichzeitig sie zu identifizieren. Mit dem
+ Argument scan wird eine Liste von ausführbaren fhem-Befehlen
+ zurückgegeben. Das Argument create gibt keine Liste o.ä.
+ zurück, die Geräte werden stattdessen erzeugt.
+
+ Es ist zu beachten, dass ein CUL immer noch manuell in den
+ HomeMatic-Modus umgeschaltet werden muss.
+
+ Unter Linux wird gleichzeitig mit dem lsusb-befehl überprü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ührt wurde).
+ Pro usb Befehl wird nur ein Gerät geflasht.
+
+ Dieser Befehl ist Bestandteilteil des autocreate-Modules.
+
+=end html_DE
-=end html
=cut
diff --git a/fhem/FHEM/98_telnet.pm b/fhem/FHEM/98_telnet.pm
index 25dffc6fd..2e11f409e 100644
--- a/fhem/FHEM/98_telnet.pm
+++ b/fhem/FHEM/98_telnet.pm
@@ -471,6 +471,162 @@ telnet_ActivateInform($)
-
=end html
+
+=begin html_DE
+
+
+telnet
+
+
+
+ Define
+
+ define <name> telnet <portNumber> [global]
+ oder
+ define <name> telnet <servername>:<portNummer>
+
+
+ Erste Form, Server-mode:
+ Überwacht den TCP/IP-Port <portNummer> auf
+ ankommende Verbindungen. Wenn der zweite Parameter gobal nicht
+ angegeben wird, wird der Server nur auf Verbindungen von localhost achten.
+
+
+ Für den Gebrauch von IPV6 muss die Portnummer als IPV6:<nummer>
+ 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.
+
+ Beispiele:
+
+ define tPort telnet 7072 global
+ attr tPort globalpassword mySecret
+ attr tPort SSL
+
+ 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.
+
+
+ Zweite Form, Client-mode:
+ Verbindet zu einem angegebenen Server-Port und fü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ür den Fall, wenn das Installieren
+ von Ausnahmen in der Firewall nicht erwünscht oder nicht möglich
+ sind. Hinweis: Dieser Client-mode unterstützt zwar SSL, aber nicht
+ IPV6.
+
+ Beispiel:
+
+ Starten von tcptee auf einem öffentlich erreichbaren Host ausserhalb
+ der Firewall:
+ perl contrib/tcptee.pl --bidi 3000
+ Konfigurieren von fhem innerhalb der Firewall:
+ define tClient telnet <tcptee_host>:3000
+ Verbinden mit fhem (hinter der Firewall) von ausserhalb der Firewall:
+ telnet <tcptee_host> 3000
+
+
+
+
+
+
+
+ Set
+
+
+ Get
+
+
+ Attribute
+
+
+ - password
+ 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ückgegebene Wert wahr (true), wurde das Passwort
+ akzeptiert. Falls dieser Parameter gesetzt wird, sendet fhem
+ telnet IAC Requests, um ein Echo während der Passworteingabe zu
+ unterdrücken. Ebenso werden alle zurückgegebenen Zeilen mit
+ \r\n abgeschlossen.
+
+ Beispiel:
+
+
+ attr tPort password secret
+ attr tPort password {"$password" eq "secret"}
+
+
+ Hinweis: Falls dieses Attribut gesetzt wird, muss als erstes Argument
+ ein Passwort angegeben werden, wenn fhem.pl im Client-mode betrieben
+ wird:
+
+
+ perl fhem.pl localhost:7072 secret "set lamp on"
+
+
+
+
+
+ - globalpassword
+ Entspricht dem Attribut password; ein Passwort wird aber
+ ausschließlich für nicht-lokale Verbindungen verlangt.
+
+
+
+ - SSL
+ SSL-Verschlüsselung für eine Verbindung aktivieren. Hier gibt es eine Beschreibung, wie das erforderliche
+ SSL-Zertifikat generiert werden kann. Um eine Verbindung mit solch
+ einem Port herzustellen, sind folgende Befehle möglich:
+
+
+ socat openssl:fhemhost:fhemport,verify=0 readline
+ ncat --ssl fhemhost fhemport
+ openssl s_client -connect fhemhost:fhemport
+
+
+
+
+
+ - allowfrom
+ Regexp der erlaubten IP-Adressen oder Hostnamen. Wenn dieses Attribut
+ gesetzt wurde, werden ausschließlich Verbindungen von diesen
+ Adressen akzeptiert.
+
+
+
+ - connectTimeout
+ Gibt die maximale Wartezeit in Sekunden an, in der die Verbindung
+ aufgebaut sein muss. Standardwert ist 2.
+
+
+
+ - connectInterval
+ Gibt die Dauer an, die entweder nach Schließen einer Verbindung
+ oder für den Fall, dass die Verbindung nicht zustande kommt,
+ gewartet werden muss, bis ein erneuter Verbindungsversuch gestartet
+ werden soll. Standardwert ist 60.
+
+
+
+ - encoding
+ Bezeichnet die Zeichentabelle für die zum Client gesendeten Daten.
+ Mögliche Werte sind utf8 und latin1. Standardwert ist utf8.
+
+
+
+
+
+
+
+=end html_DE
+
=cut
+
+1;