mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 07:17:14 +00:00
Add documentation for the Freebox device tracker (#5415)
This commit is contained in:
Luc Touraille
Sebastian Muszynski
parent
73a8782768
commit
481e045960
67
source/_components/device_tracker.freebox.markdown
Normal file
67
source/_components/device_tracker.freebox.markdown
Normal file
@ -0,0 +1,67 @@
|
|||||||
|
---
|
||||||
|
layout: page
|
||||||
|
title: "Freebox"
|
||||||
|
description: "Instructions on how to integrate Freebox routers into Home Assistant."
|
||||||
|
date: 2018-05-16 23:00
|
||||||
|
sidebar: true
|
||||||
|
comments: false
|
||||||
|
sharing: true
|
||||||
|
footer: true
|
||||||
|
logo: freebox.svg
|
||||||
|
ha_category: Presence Detection
|
||||||
|
ha_release: "0.70"
|
||||||
|
ha_iot_class: "Local Polling"
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
|
The `freebox` platform offers presence detection by keeping track of the
|
||||||
|
devices connected to a [Freebox](http://www.free.fr/) router.
|
||||||
|
|
||||||
|
### {% linkable_title Configuration %}
|
||||||
|
|
||||||
|
If you have enabled the [discovery component](/components/discovery/),
|
||||||
|
your Freebox should be detected automatically. Otherwise, you can set it
|
||||||
|
up manually in your `configuration.yaml` file:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
device_tracker:
|
||||||
|
- platform: freebox
|
||||||
|
host: foobar.fbox.fr
|
||||||
|
port: 1234
|
||||||
|
```
|
||||||
|
|
||||||
|
{% configuration %}
|
||||||
|
host:
|
||||||
|
description: The url of the Freebox.
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
port:
|
||||||
|
description: The https port the Freebox is listening on.
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
|
You can find out your Freebox host and port by opening
|
||||||
|
[this address](http://mafreebox.freebox.fr/api_version) in your browser. The
|
||||||
|
returned json should contain an api_domain (`host`) and a https_port (`port`).
|
||||||
|
|
||||||
|
### {% linkable_title Initial setup %}
|
||||||
|
|
||||||
|
The first time Home Assistant will connect to your Freebox, you will need to
|
||||||
|
authorize it by pressing the right button on the facade of the Freebox when
|
||||||
|
prompted to do so.
|
||||||
|
|
||||||
|
### {% linkable_title Notes %}
|
||||||
|
|
||||||
|
Note that the Freebox waits for some time before marking a device as
|
||||||
|
inactive, meaning that there will be a small delay (1 or 2 minutes)
|
||||||
|
between the time you disconnect a device and the time it will appear
|
||||||
|
as "away" in Home Assistant. You should take this into account when specifying
|
||||||
|
the `consider_home` parameter.
|
||||||
|
On the contrary, the Freebox immediately reports devices newly connected, so
|
||||||
|
they should appear as "home" almost instantly, as soon as Home Assistant
|
||||||
|
refreshes the devices states.
|
||||||
|
|
||||||
|
See the [device tracker component page](/components/device_tracker/) for
|
||||||
|
instructions how to configure the devices to be tracked.
|
||||||
|
|
||||||
45
source/images/supported_brands/freebox.svg
Normal file
45
source/images/supported_brands/freebox.svg
Normal file
@ -0,0 +1,45 @@
|
|||||||
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
|
<!-- Generator: Adobe Illustrator 13.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 14948) -->
|
||||||
|
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
|
||||||
|
<svg version="1.1" id="Calque_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
|
||||||
|
width="1718.317px" height="333.639px" viewBox="0 0 1718.317 333.639" enable-background="new 0 0 1718.317 333.639"
|
||||||
|
xml:space="preserve">
|
||||||
|
<path fill="#C70119" d="M1094.17,134.662c0,36.376-72.879,106.899-146.345,106.899c-27.478,0-36.438-14.043-36.438-27.124
|
||||||
|
c0-35.738,72.867-102.115,146.936-102.115C1085.801,112.322,1094.17,122.537,1094.17,134.662z M1015.915,1.915L1011.138,0
|
||||||
|
c-10.748,1.915-27.478,3.83-38.226,5.107c-17.324,1.915-33.448,3.505-45.995,4.146l-1.792,5.744l28.072,9.253l-78.842,167.847
|
||||||
|
c-3.588,7.66-7.175,15.638-7.175,23.614c0,23.297,31.66,34.145,71.086,34.145c94.382,0,203.687-59.032,203.687-110.089
|
||||||
|
c0-24.252-19.711-40.526-67.503-40.526c-53.758,0-102.735,26.164-134.986,45.95l-1.197-0.635L1015.915,1.915z"/>
|
||||||
|
<path fill="#C70119" d="M1197.572,196.568c0-35.104,31.653-89.033,111.699-89.033c51.368,0,67.495,22.338,67.495,44.997
|
||||||
|
c0,32.866-32.85,89.029-109.903,89.029C1214.299,241.562,1197.572,220.501,1197.572,196.568z M1149.785,185.717
|
||||||
|
c0,38.613,45.995,64.14,117.673,64.14c85.415,0,157.096-40.843,157.096-85.838c0-36.697-45.396-64.777-114.688-64.777
|
||||||
|
C1223.259,99.242,1149.785,139.768,1149.785,185.717z"/>
|
||||||
|
<path fill="#C70119" d="M1553.463,188.27l-40.624,30.635c-16.715,12.444-48.974,30.952-72.871,30.952
|
||||||
|
c-22.098,0-31.656-8.614-31.656-16.592c0-9.894,13.741-18.189,29.864-21.382l6.577,2.234c-0.603,1.595-1.201,3.191-1.201,4.471
|
||||||
|
c0,4.465,5.979,7.657,15.533,7.657c16.123,0,32.255-8.298,47.787-18.827l41.215-28.719l-15.533-28.402
|
||||||
|
c-7.762-13.718-19.12-25.527-37.627-25.527c-20.313,0-33.455,11.168-41.218,20.103l-11.351-3.191
|
||||||
|
c10.149-18.19,34.646-42.44,74.663-42.44c26.288,0,38.828,12.125,47.186,25.528l17.328,28.399l29.266-20.744
|
||||||
|
c22.7-15.632,49.58-32.228,81.831-32.228c15.532,0,25.686,6.381,25.686,14.358c0,10.85-15.525,18.51-28.667,22.023l-4.777-1.597
|
||||||
|
c-2.391-5.109-4.781-9.257-19.716-9.257c-20.31,0-37.031,10.212-51.962,20.421l-25.693,18.19l21.511,38.613
|
||||||
|
c5.372,10.212,10.748,22.338,30.459,22.338c24.492,0,36.438-14.042,48.985-22.976l9.558,3.825
|
||||||
|
c-16.733,15.002-43.006,44.357-81.239,44.357c-28.072,0-38.233-16.914-45.988-30.951L1553.463,188.27z"/>
|
||||||
|
<path fill="#C70119" d="M211.905,125.501l-7.231,12.728h-65.607L38.544,328.044l-36.731,5.595L0,331.775l92.713-193.546H38.544
|
||||||
|
l6.605-12.728h52.978c19.266-34.486,34.91-60.268,90.295-85.128c16.252-7.446,41.55-14.909,64.421-14.909
|
||||||
|
c12.037,0,24.681,2.492,24.681,9.944c0,4.342-6.024,14.917-16.862,14.917c-11.433,0-24.07-6.218-37.913-6.218
|
||||||
|
c-36.73,0-47.574,21.127-55.995,38.833l-21.066,42.562H211.905"/>
|
||||||
|
<path fill="#C70119" d="M219.294,146.83c15.047-11.509,61.403-41.648,90.897-41.648c15.048,0,24.7,3.436,24.7,11.822
|
||||||
|
c0,3.413-2.424,9.309-6.038,16.156l-22.879,42.546h1.211c16.252-15.838,72.844-70.524,110.765-70.524
|
||||||
|
c12.645,0,18.656,3.733,18.656,10.575c0,7.146-6.619,22.984-25.275,22.984c-7.231,0-15.044-1.247-22.271-1.247
|
||||||
|
c-41.537,0-84.279,60.275-104.146,91.956l-10.838,19.891c-1.203,2.168-10.831,2.479-21.677,2.479
|
||||||
|
c-7.823,0-19.251-2.805-19.251-5.594c0-0.922,0.604-1.865,1.191-2.792l47.56-85.745c3.015-4.975,7.231-13.669,7.231-18.324
|
||||||
|
c0-3.421-3.614-8.075-11.438-8.075c-16.262,0-40.937,14.598-50.567,20.818L219.294,146.83"/>
|
||||||
|
<path fill="#C70119" d="M612.157,207.716c-39.732,22.678-83.694,40.378-136.658,40.378c-55.389,0-74.057-21.114-74.057-41.931
|
||||||
|
c0-49.715,86.094-104.692,173.375-104.692c27.105,0,59.002,4.967,59.002,22.05c0,42.25-114.981,56.853-179.397,59.956
|
||||||
|
c-3.616,8.075-4.806,15.844-4.806,23.927c0,15.538,21.063,23.924,49.345,23.924c34.932,0,70.458-11.813,104.766-28.89
|
||||||
|
L612.157,207.716 M585.665,124.768c0-8.069-9.044-13.367-24.693-13.367c-46.344,0-93.904,43.504-103.545,64.002
|
||||||
|
C512.812,173.532,585.665,158.629,585.665,124.768"/>
|
||||||
|
<path fill="#C70119" d="M840.965,207.716c-39.737,22.678-83.669,40.378-136.661,40.378c-55.374,0-74.043-21.114-74.043-41.931
|
||||||
|
c0-49.715,86.11-104.692,173.392-104.692c27.075,0,58.97,4.967,58.97,22.05c0,42.25-114.965,56.853-179.367,59.956
|
||||||
|
c-3.614,8.075-4.835,15.844-4.835,23.927c0,15.538,21.079,23.924,49.375,23.924c34.9,0,70.428-11.813,104.747-28.89L840.965,207.716
|
||||||
|
M814.47,124.768c0-8.069-9.018-13.367-24.669-13.367c-46.356,0-93.916,43.504-103.541,64.002
|
||||||
|
C741.629,173.532,814.47,158.629,814.47,124.768"/>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 4.4 KiB |
Loading…
x
Reference in New Issue
Block a user