jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/components/sensor.fritzbox_callmonitor/index.html
Travis CI 779c204a2c Site updated at 2018-03-09 18:51:31 UTC
2018-03-09 18:51:31 +00:00

302 lines
16 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>FRITZ!Box Call Monitor - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate a phone call monitor for AVM FRITZ!Box routers into Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sensor.fritzbox_callmonitor/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="FRITZ!Box Call Monitor">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/sensor.fritzbox_callmonitor/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate a phone call monitor for AVM FRITZ!Box routers into Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="FRITZ!Box Call Monitor">
<meta name="twitter:description" content="Instructions how to integrate a phone call monitor for AVM FRITZ!Box routers into Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection, print" rel="stylesheet">
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
<link rel='shortcut icon' href='/images/favicon.ico' />
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
</head>
<body >
<header class='site-header'>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
<a href="/" class="site-title">
<img width='40' src='/demo/favicon-192x192.png'>
<span>Home Assistant</span>
</a>
</div>
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
<nav>
<input type="checkbox" id="toggle">
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
<ul class="menu pull-right">
<li><a href="/getting-started/">Getting started</a></li>
<li><a href="/components/">Components</a></li>
<li><a href="/docs/">Docs</a></li>
<li><a href="/cookbook/">Examples</a></li>
<li><a href="/developers/">Developers</a></li>
<li><a href="/blog/">Blog</a></li>
<li><a href="/help/">Need help?</a></li>
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
</ul>
</nav>
<div class='search-container' style='display: none'>
<div class='search'>
<i class="icon-search"></i>
<input id='search' placeholder='Search the docs…'>
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
</div>
</div>
</div>
</div>
</div>
</header>
<div class="grid-wrapper">
<div class="grid grid-center">
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
<article class="page">
<header>
<h1 class="title indent">
FRITZ!Box Call Monitor
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">fritzbox_callmonitor</code> sensor monitors the call monitor exposed by <a href="http://avm.de/produkte/fritzbox/">AVM Fritz!Box</a> routers
on TCP port 1012. It will assume the values <code class="highlighter-rouge">idle</code>, <code class="highlighter-rouge">ringing</code>, <code class="highlighter-rouge">dialing</code>, or <code class="highlighter-rouge">talking</code> with the phone numbers involved contained in the state attributes.
It can also access the internal phone book of the router to look up the names corresponding to the phone numbers and store them in the state attributes.</p>
<p>To activate the call monitor on your Fritz!Box, dial #96*5* from any phone connected to it.</p>
<p>To use the Fritz!Box call monitor in your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">sensor</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">fritzbox_callmonitor</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Optional</em>): The IP address of your router, eg. 192.168.1.1. It is optional since every fritzbox is also reachable by using the IP address 169.254.1.1.</li>
<li><strong>port</strong> (<em>Optional</em>): The TCP port of the call monitor. There is usually no reason to change this.</li>
<li><strong>username</strong> (<em>Optional</em>): 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.</li>
<li><strong>password</strong> (<em>Optional</em>): Fritz!Box user’s user password. This is required to use the phone book lookup feature.</li>
<li><strong>phonebook</strong> (<em>Optional</em>): Numerical ID identifying the phonebook to be used. If there is just one phonebook, this is usually 0.</li>
<li><strong>prefixes</strong> (<em>Optional</em>): 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.</li>
</ul>
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
<h3><a class="title-link" name="full-configuration" href="#full-configuration"></a> Full configuration</h3>
<p>The example below shows a full configuration for a call monitor with phone book support.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yml entry</span>
<span class="s">sensor</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">fritzbox_callmonitor</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Phone</span>
<span class="s">username</span><span class="pi">:</span> <span class="s">my_username</span>
<span class="s">password</span><span class="pi">:</span> <span class="s">my_password</span>
<span class="s">phonebook</span><span class="pi">:</span> <span class="s">0</span>
<span class="s">prefixes</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s1">'</span><span class="s">+49'</span>
<span class="pi">-</span> <span class="s1">'</span><span class="s">+4989'</span>
<span class="pi">-</span> <span class="s1">'</span><span class="s">089'</span>
</code></pre>
</div>
<h3><a class="title-link" name="send-notifications-on-state-change" href="#send-notifications-on-state-change"></a> Send notifications on state change</h3>
<p>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.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yml entry.</span>
<span class="s">automation</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Notify</span><span class="nv"> </span><span class="s">about</span><span class="nv"> </span><span class="s">phone</span><span class="nv"> </span><span class="s">state"</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">state</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">sensor.phone</span>
<span class="s">action</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">service</span><span class="pi">:</span> <span class="s">notify.notify</span>
<span class="s">data</span><span class="pi">:</span>
<span class="s">title</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Phone"</span>
<span class="s">message</span><span class="pi">:</span> <span class="pi">&gt;-</span>
<span class="no">{% if is_state("sensor.phone", "idle") %}</span>
<span class="no">Phone is idle</span>
<span class="no">{% elif is_state("sensor.phone", "dialing") %}</span>
<span class="no">Calling {{ states.sensor.phone.attributes.to_name }} ({{ states.sensor.phone.attributes.to }})</span>
<span class="no">{% elif is_state("sensor.phone", "ringing") %}</span>
<span class="no">Incoming call from {{ states.sensor.phone.attributes.from_name }} ({{ states.sensor.phone.attributes.from }})</span>
<span class="no">{% else %}</span>
<span class="no">Talking to {{ states.sensor.phone.attributes.with_name }} ({{ states.sensor.phone.attributes.with }})</span>
<span class="no">{% endif %}</span>
</code></pre>
</div>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
<div class="grid">
<section class="aside-module grid__item one-whole lap-one-half">
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/sensor.fritzbox_callmonitor.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/avm.png' />
</div>
<div class='section'>
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Local Polling
</div>
<div class='section'>
Introduced in release: 0.27
</div>
<div class='section'>
Source:
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/sensor/fritzbox_callmonitor.py'>sensor/fritzbox_callmonitor.py</a>
</div>
<div class='section'>
<h1 class="title delta">Category System Monitor</h1>
<ul class='divided'>
<li>
<a href='/components/binary_sensor.apcupsd/'>APCUPSd Binary Sensor</a>
</li>
<li>
<a href='/components/sensor.apcupsd/'>APCUPSd Sensor</a>
</li>
<li>
<a href='/components/sensor.cpuspeed/'>CPU speed</a>
</li>
<li>
<a href='/components/sensor.cups/'>CUPS Sensor</a>
</li>
<li>
<a href='/components/sensor.cert_expiry/'>Certificate Expiry</a>
</li>
<li>
<a href='/components/binary_sensor.digital_ocean/'>Digital Ocean Binary Sensor</a>
</li>
<li>
<a href='/components/sensor.dovado/'>Dovado</a>
</li>
<li>
FRITZ!Box Call Monitor
</li>
<li>
<a href='/components/sensor.fritzbox_netmonitor/'>FRITZ!Box Net Monitor</a>
</li>
<li>
<a href='/components/sensor.fastdotcom/'>Fast.com</a>
</li>
<li>
<a href='/components/sensor.glances/'>Glances</a>
</li>
<li>
<a href='/components/sensor.google_wifi/'>Google Wifi</a>
</li>
<li>
<a href='/components/sensor.hddtemp/'>HDDTemp</a>
</li>
<li>
<a href='/components/sensor.hp_ilo/'>HP ILO</a>
</li>
<li>
<a href='/components/binary_sensor.linode/'>Linode Binary Sensor</a>
</li>
<li>
<a href='/components/sensor.linux_battery/'>Linux Battery</a>
</li>
<li>
<a href='/components/sensor.nut/'>NUT Sensor</a>
</li>
<li>
<a href='/components/sensor.netdata/'>Netdata</a>
</li>
<li>
<a href='/components/sensor.openhardwaremonitor/'>Open Hardware Monitor Sensor</a>
</li>
<li>
<a href='/components/sensor.pi_hole/'>Pi-Hole Sensor</a>
</li>
<li>
<a href='/components/sensor.snmp/'>SNMP</a>
</li>
<li>
<a href='/components/sensor.speedtest/'>Speedtest.net</a>
</li>
<li>
<a href='/components/sensor.supervisord/'>Supervisord</a>
</li>
<li>
<a href='/components/sensor.synologydsm/'>SynologyDSM Sensor</a>
</li>
<li>
<a href='/components/sensor.systemmonitor/'>System Monitor</a>
</li>
<li>
<a href='/components/binary_sensor.upcloud/'>UpCloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.vultr/'>Vultr Binary Sensor</a>
</li>
<li>
<a href='/components/sensor.vultr/'>Vultr Sensor</a>
</li>
<li>
<a href='/components/zabbix/'>Zabbix</a>
</li>
<li>
<a href='/components/sensor.zabbix/'>Zabbix Sensor</a>
</li>
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<div class="copyright">
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a> (no support!).<br>
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
</div>
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
</div>
</div>
</div>
</div>
</footer>
<script>
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
<script type="text/javascript">
docsearch({
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
indexName: 'home-assistant',
inputSelector: '#search',
debug: false // Set debug to true if you want to inspect the dropdown
});
document.querySelector('.search .close').addEventListener('click', function(ev) {
ev.preventDefault();
document.querySelector('.search-container').style.display = 'none';
});
document.querySelector('.show-search').addEventListener('click', function(ev) {
ev.preventDefault();
document.querySelector('.search-container').style.display = 'block';
document.getElementById('toggle').checked = false;
document.querySelector('.search-container input').focus();
});
</script>
</body>
</html>
Reference in a new issue View git blame Copy permalink