Skip to content
Closed
4 changes: 2 additions & 2 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,8 @@ social:
# Home Assistant release details
current_major_version: 0
current_minor_version: 107
current_patch_version: 1
date_released: 2020-03-18
current_patch_version: 4
date_released: 2020-03-20

# Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it.
Expand Down
45 changes: 26 additions & 19 deletions source/_integrations/freebox.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,35 @@ ha_release: 0.85
ha_iot_class: Local Polling
ha_codeowners:
- '@snoof85'
- '@Quentame'
ha_config_flow: true
ha_domain: freebox
---

The `freebox` integration allows you to observe and control [Freebox router](https://www.free.fr/).

There is currently support for the following device types within Home Assistant:

* [Sensor](#sensor) with traffic metrics
* [Sensor](#sensor) with traffic and temperature metrics
* [Device tracker](#presence-detection) for connected devices
* [Switch](#switch) to control Wi-Fi

## Configuration

If you have enabled the [discovery component](/integrations/discovery/),
your Freebox should be detected automatically. Otherwise, you can set it
up manually in your `configuration.yaml` file:
If you have enabled the [discovery integration](/integrations/discovery/), your Freebox should be detected automatically.
Otherwise, you can set it up manually via the frontend or via your `configuration.yaml` file.

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`).
Please consult the [API documentation](https://dev.freebox.fr/sdk/os/) for more information.

### Via the frontend

Menu: **Configuration** -> **Integrations**. Search for "Freebox", add your host and port, click submit.

If you add the integration for the first time, follow the instructions in the [Initial setup](#initial-setup) section.

### Via the configuration file

```yaml
freebox:
Expand All @@ -44,28 +57,23 @@ port:
type: string
{% endconfiguration %}

You can find out your Freebox host and port by opening the address <http://mafreebox.freebox.fr/api_version> in your browser. The
returned JSON should contain an `api_domain` (`host`) and a `https_port` (`port`).
Please consult the [API documentation](https://dev.freebox.fr/sdk/os/) for more information.

<div class='note warning'>

If you change your Freebox router for a new one, you need to delete the `freebox.conf` file located in your Home Assistant configuration directory to make the association again.
If you change your Freebox router for a new one, go into your Home Assistant configuration `.storage` folder and delete the "freebox" folder, then add the integration again.

</div>

### Initial setup

<div class='note warning'>
You must have set a password for your Freebox router web administration page. Enable the option "Permettre les nouvelles demandes d'associations" and check that the option "Accès à distance sécurisé à Freebox OS" is active in "Gestion des ports" > "Connexions entrantes".

You must have set a password for your Freebox router web administration page. Enable the option "Permettre les nouvelles demandes d'associations" and check that the option "Accès à distance sécurisé à Freebox OS" is active in "Gestion des ports" > "Connexions entrantes".

</div>

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.
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.

To make the Wi-Fi switch and the reboot service working you will have to add "Modification des réglages de la Freebox
" permission to Home Assistant application in "Paramètres de la Freebox" > "Gestion des accès" > "Applications".
To make the Wi-Fi switch and the reboot service working you will have to add "Modification des réglages de la Freebox" permission to Home Assistant application in "Paramètres de la Freebox" > "Gestion des accès" > "Applications".

### Supported routers

Expand All @@ -77,8 +85,7 @@ Only the routers with Freebox OS are supported:

## Presence Detection

This platform offers presence detection by keeping track of the
devices connected to a [Freebox](https://www.free.fr/) router.
This platform offers presence detection by keeping track of the devices connected to a [Freebox](https://www.free.fr/) router.

### Notes

Expand All @@ -93,8 +100,8 @@ refreshes the devices states.

## Sensor

This platform offers you sensors to monitor a Freebox router. The monitored conditions are
instant upload and download rates in KB/s.
This platform offers you sensors to monitor a Freebox router.
The monitored conditions are internal temperature and upload and download rates in KB/s.

## Service

Expand Down
5 changes: 4 additions & 1 deletion source/_integrations/opnsense.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,10 @@ Where the `api_key` and `api_secret` values are acquired from your OPNsense
router using the web interface. For more information on this procedure, refer
to the OPNsense [documentation](https://docs.opnsense.org/development/how-tos/api.html#creating-keys).

User with API Key requires privileges for Type: GUI Name: Diagnostics: ARP Table.
User with API Key requires privileges for Type:

- GUI Name: Diagnostics: ARP Table
- GUI Name: Diagnostics: Network Insight

{% configuration %}
url:
Expand Down
18 changes: 18 additions & 0 deletions source/_integrations/rtorrent.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@ sensor:
- 'current_status'
- 'download_speed'
- 'upload_speed'
- 'all_torrents'
- 'stopped_torrents'
- 'complete_torrents'
- 'uploading_torrents'
- 'downloading_torrents'
- 'active_torrents'
```

This sensor requires the rTorrent XML-RPC API exposed on an HTTP interface.
Expand Down Expand Up @@ -49,4 +55,16 @@ monitored_variables:
description: The current download speed.
upload_speed:
description: The current upload speed.
all_torrents:
description: The number of all torrents.
stopped_torrents:
description: The number of torrents that are stopped.
complete_torrents:
description: The number of torrents that are fully downloaded.
uploading_torrents:
description: The number of torrents that are seeding.
downloading_torrents:
description: The number of torrents that are leeching.
active_torrents:
description: The number of torrents that are actively ( measurable speed ) leeching, seeding or both.
{% endconfiguration %}
9 changes: 5 additions & 4 deletions source/_integrations/samsungtv.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -117,11 +117,12 @@ For example: for model `UN55NU7100`, the `UN55` would mean it's an LED, North Am
- NU8000
- U6000
- U6300
- UE6199UXZG (On/Off, Forward/Backward, Volume control, but no Play button)
- UE65KS8005 (On/Off, Forward/Backward, Volume are OK, but no Play button)
- UE49KU6470 (On/Off, Forward/Backward, Volume are OK, but no Play button)
- UE46ES5500 (partially supported, turn on doesn't work)
- UE46D7000
- UE49KU6470 (On/Off, Forward/Backward, Volume are OK, but no Play button)
- UE55NU8070
- UE6199UXZG (On/Off, Forward/Backward, Volume control, but no Play button)
- UE65KS8005 (On/Off, Forward/Backward, Volume are OK, but no Play button)

#### Models tested but not yet working

Expand All @@ -139,11 +140,11 @@ For example: for model `UN55NU7100`, the `UN55` would mean it's an LED, North Am
- MU6125 - Unable to see state and unable to control (Tested on UE58MU6125 on port 8001 and 8801)
- MU6300 - Port set to 8001, turning on works, status not working reliably, turning off is not permanent (it comes back on)
- MU6400 - Unable to see state and unable to control (using latest 1270 firmware. Had limited functionality on previous firmware)
- RU8000 - Turning on works, turning off does not work. State is correct but says on periodically but in reality is not. Nothing else works via port 8001.
- Q60 – Turning on works, turning off does not work, State is always "off".
- Q6F – Port set to 8001, turning on works, turning off does not work, status not working reliably.
- Q7F - State is always "off" and unable to control via port 8001.
- Q9F - Turning on works, turning off does not work. State is correct. Nothing else works. Port 8001.
- RU8000 - Turning on works, turning off does not work. State is correct but says on periodically but in reality is not. Nothing else works via port 8001.

None of the 2014 (H) and 2015 (J) model series (e.g., J5200) will work, since Samsung have used a different (encrypted) type of interface for these.

Expand Down
1 change: 1 addition & 0 deletions source/_integrations/spotify.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ After you have set up the above:

You can send playlists to Spotify using the `"media_content_type": "playlist"`, which are part of the
[media_player.play_media](/integrations/media_player/#service-media_playerplay_media) service.
The `media_content_id` can be obtained from the Spotify desktop-app by clicking on the more options ("...") next to the album art picture, selecting "share" and then "Copy Spotify URI" or "Copy Playlist Link" (also available in the Spotify phone and web app).

## Unsupported Devices

Expand Down
10 changes: 6 additions & 4 deletions source/_integrations/tankerkoenig.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ You can also add additional stations manually, referencing them via their IDs. T

To use this sensor you need an API key from [tankerkoenig](https://creativecommons.tankerkoenig.de). Go to [tankerkoenig API](https://creativecommons.tankerkoenig.de) and click on API-KEY in the top right, fill out the form and request a key. The API is free, but requests should be limited to less than once every 5 minutes.

It is recommended to choose a radius that doesn't return too many fuel stations. The Terms & Conditions of [tankerkoenig.de](https://creativecommons.tankerkoenig.de/terms) specify that the API is not meant for massive data fetching, but it does not explicitly mention a limit. Having a maximum of 10 monitored fuel stations is recommended, and a warning will be issued otherwise.

## Configuration

To enable this platform, add the following lines to your `configuration.yaml`:
Expand Down Expand Up @@ -60,9 +62,9 @@ radius:
default: 2
type: integer
scan_interval:
description: The time interval to poll the server for new data. You should not put values lower than 5 minutes here; otherwise you risk your API key being blocked.
description: The time interval in seconds to poll the server for new data. You should not put values lower than 5 minutes here; otherwise you risk your API key being blocked.
required: false
default: 0:30
default: 1800 (30min)
type: time
stations:
description: List of additional fuel stations to create entities for.
Expand All @@ -88,10 +90,10 @@ tankerkoenig:
- 8531b393-1e42-423b-cb4d-e4b98cff8a0c
```

Assuming there are two fuel stations within the specified range and location, you would get six sensor entities:
Assuming there are only two fuel stations within the specified range and location, you would get six sensor entities:
* sensor.tankerkoenig_berlin_paulstrasse_20_diesel
* sensor.tankerkoenig_berlin_paulstrasse_20_e10
* sensor.tankerkoenig_aral_tankstelle_diesel
* sensor.tankerkoenig_aral_tankstelle_e10
* sensor.tankerkoenig_svg_hamburg_strassen>_diesel
* sensor.tankerkoenig_svg_hamburg_strassen_diesel
* sensor.tankerkoenig_svg_hamburg_strassen_e10
2 changes: 1 addition & 1 deletion source/_integrations/tesla.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This integration provides the following platforms:
- Binary sensors - such as parking and charger connection.
- Sensors - such as Battery level, Inside/Outside temperature, odometer, estimated range, and charging rate.
- Device tracker - to track location of your car
- Lock - Door lock. Enables you to control Tesla's door lock
- Lock - Door lock and charger door lock. Enables you to control Tesla's door and charger door lock
- Climate - HVAC control. Allow you to control (turn on/off, set target temperature) your Tesla's HVAC system.
- Switch - Charger and max range switch to allow you to start/stop charging and set max range charging. Update switch to allow you to disable polling of vehicles to conserve battery

Expand Down
74 changes: 14 additions & 60 deletions source/_integrations/unifi.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ ha_category:
- Hub
- Presence Detection
- Switch
- Sensor
ha_release: 0.81
ha_iot_class: Local Polling
ha_iot_class: Local Push
ha_config_flow: true
ha_quality_scale: platinum
ha_codeowners:
Expand All @@ -21,70 +22,17 @@ There is currently support for the following device types within Home Assistant:

- [Presence Detection](#presence-detection)
- [Switch](#switch)
- [Sensor](#sensor)

## Configuration

Home Assistant offers UniFi integration through **Configuration** -> **Integrations** -> **UniFi Controller**.
Home Assistant offers UniFi integration through **Configuration** -> **Integrations** -> **UniFi Controller**. Follow the instructions to get it set up.

Enter `host address`, `user name` and `password` and then continue to select which `site` you want to connect to Home Assistant. The user needs administrator privileges in order to control POE switches.
The user needs administrator privileges in order to control switches.

### Extra configuration for device tracker
### Extra configuration of the integration

You can augment the behavior of UniFi device tracker by adding

```yaml
# Example configuration.yaml entry
unifi:
controllers:
- host: unifi
site: My site
ssid_filter:
- 'HomeSSID'
- 'IoTSSID'
```

{% configuration %}
host:
description: Same address as relevant configuration entry, needed to identify configuration entry.
type: string
required: true
default: None
site:
description: Same site as relevant configuration entry, needed to identify configuration entry.
type: string
required: true
default: None
block_client:
description: A list of Clients MAC Addresses that can be blocked from the network.
type: list
required: false
default: None
detection_time:
description: How long since the last seen time before the device is marked away, specified in seconds.
type: integer
required: false
default: 300
dont_track_clients:
description: enable to not allow device tracker to track clients.
type: boolean
required: false
default: false
dont_track_devices:
description: enable to not allow device tracker to track devices.
type: boolean
required: false
default: false
dont_track_wired_clients:
description: enable to not allow device tracker to track wired clients.
type: boolean
required: false
default: false
ssid_filter:
description: Filter the SSIDs that tracking will occur on.
type: list
required: false
default: None
{% endconfiguration %}
All configuration options are offered from the front end. Enter what UniFi integration you want to change options on and press the cog wheel.

### Configuring Users

Expand Down Expand Up @@ -112,14 +60,20 @@ If Home Assistant and the UniFi controller are running on separate machines or V

### Block network access for clients

Allow control of network access to clients configured in the `configuration.yaml` file by adding a list of the MAC addresses. Items in this list will have a Home Assistant switch created, using the UniFi Device name, allowing for blocking and unblocking.
Allow control of network access to clients configured in the integration options by adding MAC addresses. Items in this list will have a Home Assistant switch created, using the UniFi Device name, allowing for blocking and unblocking.

### Control clients powered by POE

Entities appear automatically for each connected POE client. If no POE client device is in operation, no entity will be visible. Note: UniFi infrastructure devices such as access points and other switches are not (yet) supported, even if they are powered over ethernet themselves.

Note that POE control actually configures the network port of the switch which the client is connected to.

## Sensor

### Bandwidth sensor

Get entities reporting receiving and transmitting bandwidth per network client.

## Debugging integration

If you have problems with UniFi or the integration you can add debug prints to the log.
Expand Down
31 changes: 31 additions & 0 deletions source/_integrations/velbus.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,37 @@ port:
type: string
{% endconfiguration %}

## Services

- `velbus.sync clock`: Synchronize Velbus time to local clock.
- `velbus.set_memo_text`: Show memo text on Velbus display modules.

### Service `velbus.sync_clock`

You can use the service `velbus.sync clock` to synchronize the clock of the Velbus modules to the clock of the machine running Home Assistant. This is the same as the 'sync clock' button at the VelbusLink software.

### Service `velbus.set_memo_text`

You can use the service `velbus.set_memo_text` to provide the memo text to be displayed at Velbus modules like VMBGPO(D) and VMBELO.

| Service data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------- |
| `address` | no | The module address in decimal format, which is displayed at the device list at the integration page. |
| `memo_text` | yes | Text to be displayed on module. When no memo text is supplied the memo text will be cleared. |

Example:

```yaml
script:
trash_memo:
alias: Trash memo text
sequence:
- data:
address: 65
memo_text: "It's trash day"
service: velbus.set_memo_text
```

## Example automation

The Velbus integration allows you to link a Velbus button (i.e., a button of a [VMBGPOD](https://www.velbus.eu/products/view/?id=416302&lang=en) module) to a controllable entity of Home Assistant.
Expand Down
Loading