jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-15 21:36:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add config flow to fritzbox callmonitor (#14651)

Browse Source 
Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
springstan 2021-02-03 11:44:51 +01:00 committed by Franck Nijhof
parent e2ac8b3f11
commit 72f4417783
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
1 changed files with 2 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
source/_integrations/fritzbox_callmonitor.markdown
View File

@ -13,74 +13,14 @@ It can also access the internal phone book of the router to look up the names co
## Setup
To activate the call monitor on your FRITZ!Box, dial #96\*5\* from any phone connected to it.
To activate the call monitor on your FRITZ!Box, dial **#96\*5\*** from any phone connected to it.
## Configuration
To use the FRITZ!Box call monitor in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: fritzbox_callmonitor
```
{% configuration %}
name:
description: Give the sensor a friendly name for in the front-end.
required: false
default: Phone
type: string
host:
description: The IP address of your router, e.g., 192.168.1.1. It is optional since every FRITZ!Box is also reachable by using the IP address 169.254.1.1. If you have a local DNS server and have assigned a hostname to your FRITZ!Box, you can also use that here instead of the IP address.
required: false
default: 169.254.1.1
type: string
port:
description: The TCP port of the call monitor. There is usually no reason to change this.
required: false
default: 1012
type: integer
username:
description: FRITZ!Box user's user name. This is required to use the phone book lookup feature. The user needs to have the "voice message, fax message, Fritz!App Fon and call list" permission.
required: false
default: admin
type: string
password:
description: FRITZ!Box user's user password. This is required to use the phone book lookup feature.
required: false
type: string
phonebook:
description: Numerical ID identifying the phonebook to be used. If there is just one phonebook, this is usually 0.
required: false
default: 0
type: integer
prefixes:
description: In case of a local call, the phone number seen by the router might differ from the one stored in the phone book by an area code, similarly for the international prefix. To remedy this, a list of prefixes, that can be appended to the phone number in case it is not found in the phone book, can be given.
required: false
type: list
{% endconfiguration %}
To add the AVM FRITZ!Box Call Monitor integration to your installation, go to **Configuration** -> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **AVM FRITZ!Box Call Monitor**.
## Examples
### Full configuration
The example below shows a full configuration for a call monitor with phone book support.
```yaml
# Example configuration.yaml entry
sensor:
- platform: fritzbox_callmonitor
name: Phone
username: my_username
password: my_password
phonebook: 0
prefixes:
- '+49'
- '+4989'
- '089'
```
### Send notifications on state change
This example shows how to send notifications whenever the sensor's state changes. You will get notified both when you receive a call and also when a call is placed.