From d1b7e2df1311f50487b5ae053e68ee6b22eaa098 Mon Sep 17 00:00:00 2001
From: rudolfkoenig <>
Date: Sun, 15 Jul 2018 09:23:19 +0000
Subject: [PATCH] commandref_frame.html: update the inform documentation (Forum
#89381)
git-svn-id: https://svn.fhem.de/fhem/trunk@16983 2b470e98-0d58-463d-a4d8-8e2adae1ed80
---
fhem/docs/commandref_frame.html | 28 ++++++++++++++++++++--------
fhem/docs/commandref_frame_DE.html | 27 +++++++++++++++++++--------
2 files changed, 39 insertions(+), 16 deletions(-)
diff --git a/fhem/docs/commandref_frame.html b/fhem/docs/commandref_frame.html
index dddd1a48b..2bfdb0aa6 100644
--- a/fhem/docs/commandref_frame.html
+++ b/fhem/docs/commandref_frame.html
@@ -904,15 +904,27 @@ The following local attributes are used by a wider range of devices:
inform
- inform {on|off|timer|raw} [regexp]
+ inform {on|onWithState|off|raw|timer|log|status} [regexp]
- If set to on, and a device state changes, send a notification to the current
- client. This command can be used by other programs/modules to receive a
- notification.
- The option timer prepends a timerstamp to the line. Note: this command is
- a nice way to check which events are generated, to help you when creating
- notify or FileLog entries.
-
+ Monitor events via a telnet client. This command is the telnet equivalent of
+ the FHEMWEB Event monitor, but can also be used by other programs/modules to
+ receive a notification. Options:
+
+ - on
+ switch the inform mechanism on
+ - onWithState
+ show the additional state event too
+ - off
+ switch the inform mechanism off (both events and logs, see below)
+ - raw
+ show only raw events from physical devices
+ - timer
+ prepend a timestamp to each event
+ - log
+ show messages written by the FHEM Log interface
+ - status
+ show the current status
+
diff --git a/fhem/docs/commandref_frame_DE.html b/fhem/docs/commandref_frame_DE.html
index d6828084a..553a962fa 100644
--- a/fhem/docs/commandref_frame_DE.html
+++ b/fhem/docs/commandref_frame_DE.html
@@ -961,14 +961,25 @@ Die folgenden lokalen Attribute werden von mehreren Geräten verwendet:
inform {on|off|timer|raw} [regexp]
- Wenn auf "on" gesetzt und der Status eines Gerätes ändert
- sich, dann wird eine Nachricht an den Client gesendet. Dieser Befehl kann von
- anderen Programmen/Modulen dazu benutzt werden, eine Hinweisnachricht zu
- erhalten.
Die Option "timer" fügt der Nachricht
- einen Zeitstempel hinzu. Hinweis: Dieser Befehl erleichtert Ihnen die bessere
- Kontrolle in notify oder FileLog
- , wann welche Ereignisse erzeugt wurden.
-
+ Ermöglicht Event-Verfolgung über das telnet Interface. Es ist das
+ telnet Equivalent des FHEMWEB Event-Monitors, es kann aber auch von weiteren
+ Programmen zur Benachrichtigung verwendet werden. Optionen:
+
+ - on
+ aktiviert die Benachrichtigung.
+ - onWithState
+ zeigt auch das zusätzliche state Event
+ - off
+ deaktiviert die Benachrichtigung (sowohl Events wie auch Logs, s.u.)
+ - raw
+ zeigt (nur) die raw Events der physikalischen Module
+ - timer
+ stellt der Daten ein Zeitstempel vor
+ - log
+ zeigt die vom FHEM Log Interface protokollierten Daten
+ - status
+ zeigt den aktuellen Status
+