mirror of
https://github.com/fhem/fhem-mirror.git
synced 2025-03-10 09:16:53 +00:00
FB_CALLMONITOR: minor commandref corrections
git-svn-id: https://svn.fhem.de/fhem/trunk@6284 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
markusbloch
parent
04fab91ff7
commit
47a2cf3d5c
@ -750,7 +750,7 @@ sub FB_CALLMONITOR_loadCacheFile($)
|
||||
The FB_CALLMONITOR module connects to a AVM FritzBox Fon and listens for telephone
|
||||
<a href="#FB_CALLMONITORevents">events</a> (Receiving incoming call, Making a call)
|
||||
<br><br>
|
||||
In order to use this module with fhem you <b>must</b> enable the CallMonitor feature via
|
||||
In order to use this module with fhem you <b>must</b> enable the Callmonitor feature via
|
||||
telephone shortcode.<br><br>
|
||||
<ul>
|
||||
<code>#96*5* - for activating<br>#96*4* - for deactivating</code>
|
||||
@ -758,8 +758,8 @@ sub FB_CALLMONITOR_loadCacheFile($)
|
||||
|
||||
<br>
|
||||
Just dial the shortcode for activating on one of your phones, after 3 seconds just hang up. The feature is now activated.
|
||||
<br>
|
||||
After activating the CallMonitor-Support in your FritzBox, this module is able to
|
||||
<br><br>
|
||||
After activating the Callmonitor-Support in your FritzBox, this module is able to
|
||||
generate an event for each external call. Internal calls were not be detected by the Callmonitor.
|
||||
<br><br>
|
||||
This module work with any FritzBox Fon model.
|
||||
@ -805,7 +805,7 @@ sub FB_CALLMONITOR_loadCacheFile($)
|
||||
If is set to "none", then no reverse searching will be used.<br><br>Default value is "none".<br><br>
|
||||
<li><a name="reverse-search-cache">reverse-search-cache</a></li>
|
||||
If this attribute is activated each reverse-search result is saved in an internal cache
|
||||
and will be used instead of reverse searching again the same number.<br><br>
|
||||
and will be used instead of reverse searching every time the same number.<br><br>
|
||||
Possible values: 0 => off , 1 => on<br>
|
||||
Default Value is 0 (off)<br><br>
|
||||
<li><a name="reverse-search-cache-file">reverse-search-cache-file</a> <file></li>
|
||||
@ -816,7 +816,7 @@ sub FB_CALLMONITOR_loadCacheFile($)
|
||||
The phonebook file can be obtained by an export via FritzBox web UI<br><br>
|
||||
Default value is /var/flash/phonebook (phonebook filepath on FritzBox)<br><br>
|
||||
<li><a name="remove-leading-zero">remove-leading-zero</a></li>
|
||||
If this attribute is activated, a leading zero will be removed from the external_number (e.g. in telefon systems).<br><br>
|
||||
If this attribute is activated, a leading zero will be removed from the external number (e.g. in telefon systems).<br><br>
|
||||
Possible values: 0 => off , 1 => on<br>
|
||||
Default Value is 0 (off)<br><br>
|
||||
<li><a name="unique-call-ids">unique-call-ids</a></li>
|
||||
@ -836,12 +836,12 @@ sub FB_CALLMONITOR_loadCacheFile($)
|
||||
<li><b>external_number</b> - The participants number which is calling (event: ring) or beeing called (event: call)</li>
|
||||
<li><b>external_name</b> - The result of the reverse lookup of the external_number via internet. Is only available if reverse-search is activated. Special values are "unknown" (no search results found) and "timeout" (got timeout while search request). In case of an timeout and activated caching, the number will be searched again next time a call occurs with the same number</li>
|
||||
<li><b>internal_number</b> - The internal number (fixed line, VoIP number, ...) on which the participant is calling (event: ring) or is used for calling (event: call)</li>
|
||||
<li><b>internal_connection</b> - The internal connection (FON1, FON2, ISDN, DECT, ...) which is used to take the call</li>
|
||||
<li><b>external_connection</b> - The external connection (fixed line, VoIP account) which is used to take the call</li>
|
||||
<li><b>internal_connection</b> - The internal connection (FON1, FON2, ISDN, DECT, ...) which is used to take or perform the call</li>
|
||||
<li><b>external_connection</b> - The external connection (fixed line, VoIP account) which is used to take or perform the call</li>
|
||||
<li><b>call_duration</b> - The call duration in seconds. Is only generated at a disconnect event. The value 0 means, the call was not taken by anybody.</li>
|
||||
<li><b>call_id</b> - The call identification number to separate events of two or more different calls at the same time. This id number is equal for all events relating to one specific call.</li>
|
||||
<li><b>missed_call</b> - This event will be raised in case of a missing incoming call. If available, also the name of the calling number will be displayed.</li>
|
||||
<li><b>missed_call_line</b> - Will be raised together with "missed_call". It shows the number of the line which received the missed call.</li>
|
||||
<li><b>missed_call_line</b> - Will be raised together with "missed_call". It shows the number of the internal line which received the missed call.</li>
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
@ -856,16 +856,16 @@ sub FB_CALLMONITOR_loadCacheFile($)
|
||||
Das Modul FB_CALLMONITOR verbindet sich zu einer AVM FritzBox Fon und verarbeitet
|
||||
Telefonie-<a href="#FB_CALLMONITORevents">Ereignisse</a>.(eingehende & ausgehende Telefonate)
|
||||
<br><br>
|
||||
Um dieses Modul nutzen zu können, muss der CallMonitor via Kurzwahl mit einem Telefon aktiviert werden.
|
||||
Um dieses Modul nutzen zu können, muss der Callmonitor via Kurzwahl mit einem Telefon aktiviert werden.
|
||||
.<br><br>
|
||||
<ul>
|
||||
<code>#96*5* - CallMonitor aktivieren<br>#96*4* - CallMonitor deaktivieren</code>
|
||||
<code>#96*5* - Callmonitor aktivieren<br>#96*4* - Callmonitor deaktivieren</code>
|
||||
</ul>
|
||||
<br>
|
||||
Einfach die entsprechende Kurzwahl auf irgend einem Telefon eingeben, welches an die Fritz!Box angeschlossen ist.
|
||||
Nach ca. 3 Sekunden kann man einfach wieder auflegen. Nun ist der CallMonitor aktiviert.
|
||||
<br>
|
||||
Sobald der CallMonitor auf der Fritz!Box aktiviert wurde erzeugt das Modul entsprechende Events (s.u.) für alle externen Anrufe. Interne Anrufe werden nicht durch den Callmonitor erfasst.
|
||||
Nach ca. 3 Sekunden kann man einfach wieder auflegen. Nun ist der Callmonitor aktiviert.
|
||||
<br><br>
|
||||
Sobald der Callmonitor auf der Fritz!Box aktiviert wurde erzeugt das Modul entsprechende Events (s.u.) für alle externen Anrufe. Interne Anrufe werden nicht durch den Callmonitor erfasst.
|
||||
<br><br>
|
||||
Dieses Modul funktioniert mit allen Fritz!Box Modellen, welche Telefonie unterstützen (Namenszusatz: Fon).
|
||||
<br><br>
|
||||
@ -912,45 +912,45 @@ sub FB_CALLMONITOR_loadCacheFile($)
|
||||
für die Rückwärtssuche herangezogen, solange bis irgend ein Anbieter ein valides Ergebniss liefert.
|
||||
Wenn der Wert "none" ist, wird keine Rückwärtssuche durchgeführt.<br><br>Standardwert ist "none" (keine Rückwärtssuche).<br><br>
|
||||
<li><a name="reverse-search-cache">reverse-search-cache</a></li>
|
||||
Wenn dieses Attribut gesetzt ist, werden alle Ergebisse der Rückwärtssuche in einem modul-internen gespeichert
|
||||
und von da an nur noch aus dem Cache genutzt anstatt eine erneute Rückwärtssuche durchzuführen.<br><br>
|
||||
Wenn dieses Attribut gesetzt ist, werden alle Ergebisse der Rückwärtssuche in einem modul-internen Cache gespeichert
|
||||
und alle existierenden Ergebnisse aus dem Cache genutzt anstatt eine erneute Rückwärtssuche durchzuführen.<br><br>
|
||||
Mögliche Werte: 0 => deaktiviert , 1 => aktiviert<br>
|
||||
Standardwert ist 0 (deaktiviert)<br><br>
|
||||
<li><a name="reverse-search-cache-file">reverse-search-cache-file</a> <Dateipfad></li>
|
||||
Da der Cache nur im Arbeitsspeicher existiert, ist er nicht persisten und geht beim stoppen von FHEM verloren.
|
||||
Mit diesem Parameter werden alle Cache-Ergebnisse in eine Textdatei geschrieben (z.B. /usr/share/fhem/telefonbuch.txt)
|
||||
und beim nächsten Start von FHEM direkt wieder in den Cache geladen und genutzt.
|
||||
Da der Cache nur im Arbeitsspeicher existiert, ist er nicht persistent und geht beim stoppen von FHEM verloren.
|
||||
Mit diesem Parameter werden alle Cache-Ergebnisse in eine Textdatei geschrieben (z.B. /usr/share/fhem/telefonbuch.txt)
|
||||
und beim nächsten Start von FHEM wieder in den Cache geladen und genutzt.
|
||||
<br><br>
|
||||
<li><a name="reverse-search-phonebook-file">reverse-search-phonebook-file</a> <Dateipfad></li>
|
||||
Mit diesem Attribut kann man optional den Pfad zu einer Datei angeben, welche ein Telefonbuch im FritzBox-Format (XML-Struktur) enthält.
|
||||
Dadurch ist es möglich ein FritzBox-Telefonbuch zu verwenden, ohne das FHEM auf einer FritzBox laufen muss.
|
||||
Sofern FHEM auf einer FritzBox läuft (und nichts abweichendes angegeben wurde), wird das interne File /var/flash/phonebook verwendet. Alternativ kann man das Telefonbuch in der FritzBox-Weboberfläche exportieren und dieses verwenden<br><br>
|
||||
Standartwert ist /var/flash/phonebook (entspricht dem Pfad auf einer FritzBox)<br><br>
|
||||
Standardwert ist /var/flash/phonebook (entspricht dem Pfad auf einer FritzBox)<br><br>
|
||||
<li><a name="remove-leading-zero">remove-leading-zero</a></li>
|
||||
Wenn dieses Attribut aktiviert ist, wird die führende Null aus der externen Rufnummer (bei eingehenden & abgehenden Anrufen) entfernt. Dies ist z.B. notwendig bei Telefonanlagen.<br><br>
|
||||
Mögliche Werte: 0 => deaktiviert , 1 => aktiviert<br>
|
||||
Standardwert ist 0 (deaktiviert)<br><br>
|
||||
<li><a name="unique-call-ids">unique-call-ids</a></li>
|
||||
Wenn dieses Attribut aktiviert ist, wird für jedes Gespräch eine eineindeutige Identifizierungsnummer verwendet. Dadurch lassen sich auch bereits beendete Gespräche voneinander unterscheiden. Dies ist zum Beispiel notwendig bei der Verarbeitung der Events durch eine Datenbank.<br><br>
|
||||
Wenn dieses Attribut aktiviert ist, wird für jedes Gespräch eine eineindeutige Identifizierungsnummer verwendet. Dadurch lassen sich auch bereits beendete Gespräche voneinander unterscheiden. Dies ist z.B. notwendig bei der Verarbeitung der Events durch eine Datenbank.<br><br>
|
||||
Mögliche Werte: 0 => deaktiviert , 1 => aktiviert<br>
|
||||
Standardwert ist 0 (deaktiviert)<br><br>
|
||||
<li><a name="local-area-code">local-area-code</a></li>
|
||||
Verwendet die gesetze Vorwahlnummer bei Rückwärtssuchen bei Ortsgesprächen (z.B. 0228 für Bonn)<br><br>
|
||||
Verwendet die gesetze Vorwahlnummer bei Rückwärtssuchen von Ortsgesprächen (z.B. 0228 für Bonn)<br><br>
|
||||
</ul>
|
||||
<br>
|
||||
|
||||
<a name="FB_CALLMONITORevents"></a>
|
||||
<b>Generierte Events:</b><br><br>
|
||||
<ul>
|
||||
<li><b>event</b> (call|ring|connect|disconnect) - Welches Event wurde genau ausgelöst.</li>
|
||||
<li><b>event</b> (call|ring|connect|disconnect) - Welches Event wurde genau ausgelöst. ("call" => ausgehender Rufversuch, "ring" => eingehender Rufversuch, "connect" => Gespräch ist zustande gekommen, "disconnect" => es wurde aufgelegt)</li>
|
||||
<li><b>direction</b> (incoming|outgoing) - Die Anruf-Richtung ("incoming" => eingehender Anruf, "outgoing" => ausgehender Anruf)</li>
|
||||
<li><b>external_number</b> - Die Rufnummer des Gegenübers, welcher anruft (event: ring) oder angerufen wird (event: call)</li>
|
||||
<li><b>external_name</b> - Das Ergebniss der Rückwärtssuche (sofern aktiviert). Im Fehlerfall kann diese Reading auch den Inhalt "unknown" (keinen Eintrag gefunden) und "timeout" (Zeitüberschreitung bei der Abfrage) enthalten. Im Falle einer Zeitüberschreitung und aktiviertem Caching, wird die Rufnummer beim nächsten Mal erneut gesucht.</li>
|
||||
<li><b>external_name</b> - Das Ergebniss der Rückwärtssuche (sofern aktiviert). Im Fehlerfall kann diese Reading auch den Inhalt "unknown" (keinen Eintrag gefunden) oder "timeout" (Zeitüberschreitung bei der Abfrage) enthalten. Im Falle einer Zeitüberschreitung und aktiviertem Caching, wird die Rufnummer beim nächsten Mal erneut gesucht.</li>
|
||||
<li><b>internal_number</b> - Die interne Rufnummer (Festnetz, VoIP-Nummer, ...) auf welcher man angerufen wird (event: ring) oder die man gerade nutzt um jemanden anzurufen (event: call)</li>
|
||||
<li><b>internal_connection</b> - Der interne Anschluss an der Fritz!Box welcher genutzt wird um das Gespräch durchzuführen (FON1, FON2, ISDN, DECT, ...)</li>
|
||||
<li><b>external_connection</b> - Der externe Anschluss welcher genutzt wird um das Gespräch durchzuführen (Festnetz, VoIP Nummer, ...)</li>
|
||||
<li><b>call_duration</b> - Die Gesprächsdauer in Sekunden. Dieser Wert wird nur bei einem disconnect-Event erzeugt. Ist der Wert 0, so wurde das Gespräch von niemandem angenommen.</li>
|
||||
<li><b>call_id</b> - Die Identifizierungsnummer eines einzelnen Gesprächs. Dient der Zuordnung bei 2 oder mehr parallelen Gesprächen, damit alle Events eindeutig einem Gespräch zugeordnet werden können</li>
|
||||
<li><b>call_id</b> - Die Identifizierungsnummer eines einzelnen Gesprächs. Dient der Zuordnung bei zwei oder mehr parallelen Gesprächen, damit alle Events eindeutig einem Gespräch zugeordnet werden können</li>
|
||||
<li><b>missed_call</b> - Dieses Event wird nur generiert, wenn ein eingehender Anruf nicht beantwortet wird. Sofern der Name dazu bekannt ist, wird dieser ebenfalls mit angezeigt.</li>
|
||||
<li><b>missed_call_line</b> - Analog zu "missed_call" wird dieses Event nur generiert, wenn ein eingehender Anruf nicht beantwortet wird. Es zeigt die Rufnummer an über, den dieser unbeantwortete Anruf eingegangen ist.</li>
|
||||
</ul>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user