From 1ed84d5890e999fa0b3e879c124f4d0d7033bb1a Mon Sep 17 00:00:00 2001
From: markusbloch <>
Date: Sun, 10 Jan 2016 12:23:45 +0000
Subject: [PATCH] FB_CALLMONITOR: minor commandref changes
git-svn-id: https://svn.fhem.de/fhem/trunk/fhem@10438 2b470e98-0d58-463d-a4d8-8e2adae1ed80
---
FHEM/72_FB_CALLMONITOR.pm | 56 +++++++++++++++++++--------------------
1 file changed, 28 insertions(+), 28 deletions(-)
diff --git a/FHEM/72_FB_CALLMONITOR.pm b/FHEM/72_FB_CALLMONITOR.pm
index b5f093817..4e8a984c5 100755
--- a/FHEM/72_FB_CALLMONITOR.pm
+++ b/FHEM/72_FB_CALLMONITOR.pm
@@ -1778,8 +1778,8 @@ sub FB_CALLMONITOR_normalizePhoneNumber($$)
Attributes
- do_not_notify
- - readingFnAttributes
- - disable
+ - readingFnAttributes 0,1
+ - disable 0,1
Optional attribute to disable the Callmonitor. When disabled, no phone events can be detected.
Possible values: 0 => Callmonitor is activated, 1 => Callmonitor is deactivated.
@@ -1791,7 +1791,7 @@ sub FB_CALLMONITOR_normalizePhoneNumber($$)
To specify an interval spawning midnight, you have to specify two intervals, e.g.:
23:00-24:00 00:00-01:00
Default Value is empty (no intervals defined, FB_CALLMONITOR is always active)
- answMachine-is-missed-call
+ answMachine-is-missed-call 0,1
If activated, a incoming call, which is answered by an answering machine, will be treated as missed call (see Generated Events).
Possible values: 0 => disabled, 1 => enabled (answering machine calls will be treated as "missed call").
@@ -1801,7 +1801,7 @@ sub FB_CALLMONITOR_normalizePhoneNumber($$)
This attribute contains a comma separated list of providers which should be used to reverse search a name to a specific phone number.
The reverse search process will try to lookup the name according to the order of providers given in this attribute (from left to right). The first valid result from the given provider order will be used as reverse search result.
per default, reverse search is disabled.
- reverse-search-cache
+ reverse-search-cache 0,1
If this attribute is activated each reverse-search result from an internet provider is saved in an internal cache
and will be used instead of requesting each internet provider every time with the same number. The cache only contains reverse-search results from internet providers.
Possible values: 0 => off , 1 => on
@@ -1823,32 +1823,32 @@ sub FB_CALLMONITOR_normalizePhoneNumber($$)
This attribute can be used to specify the (full) path to a phonebook file in FritzBox format (XML structure). Using this option it is possible to use the phonebook of a FritzBox even without FHEM running on a Fritzbox.
The phonebook file can be obtained by an export via FritzBox web UI
Default value is /var/flash/phonebook (phonebook filepath on FritzBox)
- remove-leading-zero
+ remove-leading-zero 0,1
If this attribute is activated, a leading zero will be removed from the external number (e.g. in telefon systems).
Possible values: 0 => off , 1 => on
Default Value is 0 (off)
- unique-call-ids
+ unique-call-ids 0,1
If this attribute is activated, each call will use a biunique call id. So each call can be separated from previous calls in the past.
Possible values: 0 => off , 1 => on
Default Value is 0 (off)
- local-area-code
+ local-area-code <number>
Use the given local area code for reverse search in case of a local call (e.g. 0228 for Bonn, Germany)
- country-code
+ country-code <number>
Your local country code. This is needed to identify phonenumbers in your phonebook with your local country code as a national phone number instead of an international one as well as handling Call-By-Call numbers in german speaking countries (e.g. 0049 for Germany, 0043 for Austria or 001 for USA)
Default Value is 0049 (Germany)
- fritzbox-remote-phonebook
+ fritzbox-remote-phonebook 0,1
If this attribute is activated, the phonebook should be obtained direct from the FritzBox via remote network connection (in case FHEM is not running on a FritzBox). This is only possible if a password (and depending on configuration a username as well) is configured.
Possible values: 0 => off , 1 => on (use remote telnet connection to obtain FritzBox phonebook)
Default Value is 0 (off)
- fritzbox-remote-phonebook-via
+ fritzbox-remote-phonebook-via tr064,web,telnet
Set the method how the phonebook should be requested via network. When set to "web", the phonebook is obtained from the web interface via HTTP. When set to "telnet", it uses a telnet connection to login and retrieve the phonebook (telnet must be activated via dial shortcode #96*7*). When set to "tr064" the phonebook is obtained via TR-064 SOAP request.
- Possible values: web,telnet,tr064
+ Possible values: tr064,web,telnet
Default Value is tr064 (retrieve phonebooks via TR-064 interface)
- fritzbox-remote-phonebook-exclude
+ fritzbox-remote-phonebook-exclude <list>
A comma separated list of phonebook id's or names which should be excluded when retrieving all possible phonebooks via web or tr064 method (see attribute fritzbox-remote-phonebook-via). All list possible values is provided by get command showPhonebookIds. This attribute is not applicable when using telnet method to obtain remote phonebook.
Default Value: empty (all phonebooks should be used, no exclusions)
- fritzbox-user
- Use the given user for remote connect to obtain the phonebook. This attribute is only needed, if you use multiple users on your FritzBox.
+ fritzbox-user <username>
+ Use the given user for remote connect to obtain the phonebook (see fritzbox-remote-phonebook). This attribute is only needed, if you use multiple users on your FritzBox.
@@ -1932,12 +1932,12 @@ sub FB_CALLMONITOR_normalizePhoneNumber($$)
- do_not_notify
- readingFnAttributes
- - disable
+ - disable 0,1
Optionales Attribut zur Deaktivierung des Callmonitors. Es können dann keine Anruf-Events mehr erkannt und erzeugt werden.
Mögliche Werte: 0 => Callmonitor ist aktiv, 1 => Callmonitor ist deaktiviert.
Standardwert ist 0 (aktiv)
- - disabledForIntervals
+ - disabledForIntervals HH:MM-HH:MM HH:MM-HH-MM...
Optionales Attribut zur Deaktivierung des Callmonitors innerhalb von bestimmten Zeitintervallen.
Das Argument ist eine Leerzeichen-getrennte Liste von Minuszeichen-getrennten HH:MM Pärchen (Stunde : Minute).
Falls die aktuelle Uhrzeit zwischen diese Werte fällt, dann wird die Verarbeitung, wie bei disable, ausgesetzt.
@@ -1945,7 +1945,7 @@ sub FB_CALLMONITOR_normalizePhoneNumber($$)
Um einen Intervall um Mitternacht zu spezifizieren, muss man zwei einzelne Intervalle angeben, z.Bsp.:
23:00-24:00 00:00-01:00
Standardwert ist nicht gesetzt (dauerhaft aktiv)
- answMachine-is-missed-call
+ answMachine-is-missed-call 0,1
Sofern aktiviert, werden Anrufe, welche durch einen internen Anrufbeantworter beantwortet werden, als "unbeantworteter Anruf" gewertet (siehe Reading "missed_call" unter Generated Events).
Mögliche Werte: 0 => deaktiviert, 1 => aktiviert (Anrufbeantworter gilt als "unbeantworteter Anruf").
@@ -1959,7 +1959,7 @@ sub FB_CALLMONITOR_normalizePhoneNumber($$)
Der Anbieter "textfile" verwendet die nutzereigene Textdatei, sofern definiert (siehe Attribut reverse-search-text-file).
Der Anbieter "phonebook" verwendet das Telefonbuch der FritzBox (siehe Attribut reverse-search-phonebook-file oder fritzbox-remote-phonebook).
Standardmäßig ist diese Funktion deaktiviert (nicht gesetzt)
- reverse-search-cache
+ reverse-search-cache 0,1
Wenn dieses Attribut gesetzt ist, werden alle Ergebisse von Internetanbietern in einem modul-internen Cache gespeichert
und alle existierenden Ergebnisse aus dem Cache genutzt anstatt eine erneute Anfrage bei einem Internet-Anbieter durchzuführen.
Der Cache ist immer an die Internetanbieter gekoppelt und speichert nur Ergebnisse von Internetanbietern.
@@ -1985,32 +1985,32 @@ sub FB_CALLMONITOR_normalizePhoneNumber($$)
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
Standardwert ist /var/flash/phonebook (entspricht dem Pfad auf einer FritzBox)
- remove-leading-zero
+ remove-leading-zero 0,1
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.
Mögliche Werte: 0 => deaktiviert , 1 => aktiviert
Standardwert ist 0 (deaktiviert)
- unique-call-ids
+ unique-call-ids 0,1
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.
Mögliche Werte: 0 => deaktiviert , 1 => aktiviert
Standardwert ist 0 (deaktiviert)
- local-area-code
+ local-area-code <Ortsvorwahl>
Verwendet die gesetze Vorwahlnummer bei Rückwärtssuchen von Ortsgesprächen (z.B. 0228 für Bonn)
- country-code
+ country-code <Landesvorwahl>
Die Landesvorwahl wird benötigt um Telefonbucheinträge mit lokaler Landesvorwahl als Inlands-Rufnummern, als auch um Call-By-Call-Vorwahlen richtig zu erkennen (z.B. 0049 für Deutschland, 0043 für Österreich oder 001 für USA).
Standardwert ist 0049 (Deutschland)
- fritzbox-remote-phonebook
+ fritzbox-remote-phonebook 0,1
Wenn dieses Attribut aktiviert ist, wird das FritzBox Telefonbuch direkt von der FritzBox gelesen. Dazu ist das FritzBox Passwort und je nach FritzBox Konfiguration auch ein Username notwendig, der in den entsprechenden Attributen konfiguriert sein muss.
Mögliche Werte: 0 => deaktiviert , 1 => aktiviert
Standardwert ist 0 (deaktiviert)
- fritzbox-remote-phonebook-via
+ fritzbox-remote-phonebook-via tr064,web,telnet
Setzt die Methode mit der das Telefonbuch von der FritzBox abgefragt werden soll. Bei der Methode "web", werden alle verfügbaren Telefonbücher (lokales sowie alle konfigurierten Online-Telefonbücher) über die Web-Oberfläche eingelesen. Bei der Methode "telnet" wird eine Telnet-Verbindung zur FritzBox aufgebaut um das lokale Telefonbuch abzufragen (keine Online-Telefonbücher). Dazu muss die Telnet-Funktion aktiviert sein (Telefon Kurzwahl: #96*7*). Bei der Methode "tr064" werden alle verfügbaren Telefonbücher über die TR-064 SOAP Schnittstelle ausgelesen.
- Mögliche Werte: web,telnet,tr064
+ Mögliche Werte: tr064,web,telnet
Standardwert ist "tr064" (Abfrage aller verfügbaren Telefonbücher über die TR-064-Schnittstelle)
- fritzbox-remote-phonebook-exclude
+ fritzbox-remote-phonebook-exclude <Liste>
Eine komma-separierte Liste von Telefonbuch-ID's oder Namen welche beim einlesen übersprungen werden sollen. Dieses Attribut greift nur beim einlesen der Telefonbücher via "web"- oder "tr064"-Methode (siehe Attribut fritzbox-remote-phonebook-via). Eine Liste aller möglichen Werte kann über das Get-Kommando showPhonebookIds angezeigt werden.
Standardmäßig ist diese Funktion deaktiviert (alle Telefonbücher werden eingelesen)
- fritzbox-user
- Der Username für das Telnet-Interface, sofern das Telefonbuch direkt von der FritzBox geladen werden soll (Attribut: fritzbox-remote-phonebook). Dieses Attribut ist nur notwendig, wenn mehrere Benutzer auf der FritzBox konfiguriert sind.
+ fritzbox-user <Username>
+ Der Username für das Telnet-Interface, sofern das Telefonbuch direkt von der FritzBox geladen werden soll (siehe Attribut: fritzbox-remote-phonebook). Dieses Attribut ist nur notwendig, wenn mehrere Benutzer auf der FritzBox konfiguriert sind.