diff --git a/source/_components/device_tracker.freebox.markdown b/source/_components/device_tracker.freebox.markdown index fa2a2dd6181..633a5043baa 100644 --- a/source/_components/device_tracker.freebox.markdown +++ b/source/_components/device_tracker.freebox.markdown @@ -1,7 +1,7 @@ --- layout: page -title: "Freebox" -description: "Instructions on how to integrate Freebox routers into Home Assistant." +title: "Freebox Device Tracker" +description: "Instructions on how to track devices connected to a Freebox router in Home Assistant." date: 2018-05-16 23:00 sidebar: true comments: false @@ -14,42 +14,10 @@ ha_iot_class: "Local Polling" --- -The `freebox` platform offers presence detection by keeping track of the +This 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. +This requires you to have set up the [Freebox component](/components/freebox/) ### {% linkable_title Notes %} diff --git a/source/_components/freebox.markdown b/source/_components/freebox.markdown new file mode 100644 index 00000000000..c6ff2f5cb56 --- /dev/null +++ b/source/_components/freebox.markdown @@ -0,0 +1,65 @@ +--- +layout: page +title: "Freebox" +description: "Instructions on how to integrate Freebox routers into Home Assistant." +date: 2018-11-15 20:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: freebox.svg +ha_category: Network +ha_release: "0.85" +ha_iot_class: "Local Polling" +--- + + +The `freebox` component allows you to observe and control [Freebox router](http://www.free.fr/). + +The integration provides: + +* a sensor with traffic metrics +* a device tracker for connected devices + +### {% 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 +freebox: + host: foobar.fbxos.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 %} + +

+You must have set a password for your Freebox router web administration page and enabled the option "Permettre les nouvelles demandes d'associations". +

+ +The first time Home Assistant will connect to your Freebox, you will need to +authorize it by pressing the right arrow on the facade of the Freebox when +prompted to do so. + +### {% linkable_title Supported routers %} + +Only the routers with Freebox OS are supported: +* Freebox V6 also known as Freebox Revolution +* Freebox mini 4k diff --git a/source/_components/sensor.freebox.markdown b/source/_components/sensor.freebox.markdown new file mode 100644 index 00000000000..d3ef9f0df4b --- /dev/null +++ b/source/_components/sensor.freebox.markdown @@ -0,0 +1,20 @@ +--- +layout: page +title: "Freebox Sensor" +description: "Instructions on how to integrate sensors from a Freebox router into Home Assistant." +date: 2018-05-16 23:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: freebox.svg +ha_category: Network +ha_release: "0.85" +ha_iot_class: "Local Polling" +--- + + +This platform offers you sensors to monitor a Freebox router. The monitored conditions are +instant upload and download rates in KB/s. + +This requires you to have set up the [Freebox component](/components/freebox/)