jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Merge branch 'current' into next

Browse source
This commit is contained in:
Fabian Affolter 2017-07-28 22:22:07 +02:00
commit a979bcd4e4
No known key found for this signature in database
GPG key ID: DDF3D6F44AAB1336
45 changed files with 304 additions and 83 deletions
Download patch file Download diff file Expand all files Collapse all files

4
source/_components/binary_sensor.flic.markdown
View file

@ -30,7 +30,7 @@ Configuration variables:
- **host** (*Optional*): The IP or hostname of the flic service server. Defaults to `localhost`.
- **port** (*Optional*): The port of the flic service. Defaults to `5551`.
- **discovery** (*Optional*): If `true` then the component is configured to constantly scan for new buttons. Defaults to `true`.
- **ignored_click_types**: List of click types whose occurrence should not trigger and `flic_click` event.
- **ignored_click_types**: List of click types whose occurrence should not trigger a `flic_click` event. Click types are `single`, `double`, and `hold`.
- **timeout** (*Optional*): Maximum time in seconds an event can be queued locally on a button before discarding the event. Defaults to 3.
#### {% linkable_title Discovery %}
@ -38,7 +38,7 @@ Configuration variables:
If discovery is enabled, you can add a new button by pressing it for at least 7 seconds. The button will be paired with the flic service and added to Home Assistant. Otherwise, you have to manually pair it with the flic service. The Home Assistant platform will not scan for new buttons and will only connect to buttons already paired.
#### {% linkable_title Timeout %}
+When the flic button is triggered while disconnected from flic service, it will queue all events and try to connect and transmit them as soon as possible. The timeout variable can be used to stop events from triggering if too much time passed between the action and the notification in Home Assistant.
When the flic button is triggered while disconnected from flic service, it will queue all events and try to connect and transmit them as soon as possible. The timeout variable can be used to stop events from triggering if too much time passed between the action and the notification in Home Assistant.
#### {% linkable_title Events %}

2
source/_components/binary_sensor.markdown
View file

@ -15,7 +15,7 @@ Knowing that there are only two states allows Home Assistant to represent these
The way these sensors are displayed in the frontend can be modified in the [customize section](/getting-started/customizing-devices/). The following device classes are supported for binary sensors:
- **None**: Generic on/off
- **None**: Generic on/off. This is the default and doesn't need to be set.
- **cold**: `On` means cold
- **connectivity**: `On` means connection present, `Off` means no connection
- **gas**: `On` means gas detected

2
source/_components/binary_sensor.wink.markdown
View file

@ -28,7 +28,7 @@ The requirement is that you have setup [Wink](/components/wink/).
- Liquid presense sensors
- Z-wave lock key codes
- Lutron connected bulb remote buttons
- Wink Relay buttons and presense detection
- Wink Relay buttons and presence detection
- Wink spotter loudness and vibration (No Wink hub required)
- Wink hub devices connection status. This includes any paired hubs like Hue, Wink v1, Wink v2, Wink Relay...
- Dropcam sensors

2
source/_components/media_extractor.markdown
View file

@ -53,7 +53,7 @@ More info about queries [here](https://github.com/rg3/youtube-dl#format-selectio
### {% linkable_title Use the service %}
Go to the "Developer Tools", then to "Call Service", and choose `media_extractor/play_media` from the list of available services. Fill the "Service Data" field as shown in the example below and hit "CALL SERVICE".
Go to the "Developer Tools," then to "Call Service," and choose `media_extractor/play_media` from the list of available services. Fill the "Service Data" field as shown in the example below and hit "CALL SERVICE."
This will download the file from the given URL.

6
source/_components/media_player.onkyo.markdown
View file

@ -1,7 +1,7 @@
---
layout: page
title: "Onkyo"
description: "Instructions how to integrate Onkyo receivers into Home Assistant."
description: "Instructions how to integrate Onkyo and some Pioneer receivers into Home Assistant."
date: 2016-03-30 08:00
sidebar: true
comments: false
@ -14,9 +14,9 @@ ha_iot_class: "Local Polling"
---
The `onkyo` platform allows you to control a [Onkyo receiver](http://www.onkyo.com/) from Home Assistant. Please be aware that you need to enable "Network Standby" for this component to work in your Hardware.
The `onkyo` platform allows you to control a [Onkyo](http://www.onkyo.com/) and some recent [Pioneer](http://www.pioneerelectronics.com) receivers from Home Assistant. Please be aware that you need to enable "Network Standby" for this component to work in your Hardware.
To add an Onkyo receiver to your installation, add the following to your `configuration.yaml` file:
To add an Onkyo or Pioneer receiver to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry

2
source/_components/media_player.pioneer.markdown
View file

@ -14,7 +14,7 @@ ha_release: 0.19
ha_iot_class: "Local Polling"
---
The `pioneer` platform allows you to control Pioneer Network Receivers.
The `pioneer` platform allows you to control Pioneer Network Receivers. Please note, however, that the more recent Pioneer models work with [Onkyo](/components/media_player.onkyo/) platform instead.
To add a Pioneer receiver to your installation, add the following to your `configuration.yaml` file:

4
source/_components/recorder.markdown
View file

@ -120,6 +120,10 @@ homeassistant@homeassistant:/srv/homeassistant/homeassistant_venv$ source bin/ac
(homeassistant_venv) homeassistant@homeassistant:/srv/homeassistant/homeassistant_venv$ pip3 install mysqlclient
```
After installing the dependencies, it is required to create the database manually. During the startup, Home Assistant will look for the database specified in the `db_url`. If the database doesn't exist, it will not automatically create it for you.
Once Home Assistant finds the database, with right level of permissions, all the required tables will then be automatically created and the data will be populated accordingly.
### {% linkable_title PostgreSQL %}
For PostgreSQL you may have to install a few dependencies:

13
source/_components/sensor.buienradar.markdown
View file

@ -14,8 +14,9 @@ ha_iot_class: "Cloud Polling"
---
The `buienradar` platform uses [buienradar.nl](http://buienradar.nl/) as an source for current meteorological data for your location. The weather forecast is delivered by Buienradar, who provides a webservice that provides detailed weather information for users in The Netherlands.
The relevant weatherstation used will be automatically selected based on the location specified in the Home Assistant configuration (or in the buienradar weather/sensor component). The selected weatherstation will provide all weather data, with the exception of the forecasted precipitaion. The forecasted precipitation data will be retrieved from buienradar using your actual gps-location (and not the location of the nearest weatherstation).
The `buienradar` platform uses [buienradar.nl](http://buienradar.nl/) as an source for current meteorological data for your location. The weather forecast is delivered by Buienradar, who provides a webservice that provides detailed weather information for users in The Netherlands. The relevant weatherstation used will be automatically selected based on the location specified in the Home Assistant configuration (or in the buienradar weather/sensor component). A map of all available weatherstations can be found [here](https://www.google.com/maps/d/embed?mid=1NivHkTGQUOs0dwQTnTMZi8Uatj0).
The selected weatherstation will provide all weather data, with the exception of the forecasted precipitation. The forecasted precipitation data will be retrieved from buienradar using your actual gps-location (and not the location of the nearest weatherstation).
To integrate `buienradar` with Home Assistant, add the following section to your `configuration.yaml` file:
@ -42,7 +43,7 @@ Configuration variables:
- `sensor.br_ground_temperature`, since no name has been set for the sensor and the default display name for monitored condition `groundtemperature` is `Ground Temperature`
- **latitude** (*Optional*): Latitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration, but can be overridden/changed in this component to select a different location for buienradar.nl.
- **longitude** (*Optional*): Longitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration, but can be overridden/changed in this component to select a different location for buienradar.nl.
- **timeframe** (*Optional*): Minutes to look ahead for precipitation (5..120) [default: 60].
- **timeframe** (*Optional*): Minutes to look ahead for precipitation forecast (5..120) [default: 60].
- **monitored_conditions** array (*Required*): One or more conditions to display in the frontend.
- **stationname**: The name of the selected meteo-station.
- **symbol**: A symbol for the current weather.
@ -66,6 +67,8 @@ Full configuration example where location is manually specified:
```yaml
# Example configuration.yaml entry
- platform: buienradar
name: 'volkel'
# Force 'Meetstation Volkel' to be used:
latitude: 51.65
longitude: 5.70
monitored_conditions:
@ -86,4 +89,6 @@ Full configuration example where location is manually specified:
- precipitation_forecast_average
- precipitation_forecast_total
```
[Usage statement:](https://www.buienradar.nl/overbuienradar/gratis-weerdata)
> Buienradar makes free weatherdata available for use by individuals and businesses (website/intranet). The use of the weatherdata is allowed for **non-commercial purposes**. Please refer to the full usage statement linked above to confirm your usage or to request permission.

5
source/_components/sensor.random.markdown
View file

@ -14,7 +14,7 @@ ha_release: 0.32
---
The `random` sensor platform is creating random sensor values (integers) out of a given range. This can be useful if you want to test automation rules.
The `random` sensor platform is creating random sensor values (integers) out of a given range. This can be useful if you want to test automation rules. It generates a new value every time it is polled.
To enable the random sensor, add the following lines to your `configuration.yaml`:
@ -31,3 +31,6 @@ Configuration variables:
- **maximum** (*Optional*): Upper limit for the values. Defaults to `20`.
- **unit_of_measurement** (*Optional*): Defines the units of measurement of the sensor, if any.
See the [entity component options][entity-docs] to control how often the main component polls the random sensor. The default is 30 seconds.
[entity-docs]: https://home-assistant.io/docs/configuration/platform_options/

2
source/_components/switch.mqtt.markdown
View file

@ -35,6 +35,7 @@ Configuration variables:
- **name** (*Optional*): The name of the switch. Default is 'MQTT Switch'.
- **state_topic** (*Optional*): The MQTT topic subscribed to receive state updates.
- **command_topic** (*Required*): The MQTT topic to publish commands to change the switch state.
- **availability_topic** (*Optional*): The MQTT topic subscribed to receive availability (online/offline) updates. The payload is the same for the command_topic.
- **payload_on** (*Optional*): The payload that represents enabled state. Default is "ON".
- **payload_off** (*Optional*): The payload that represents disabled state. Default is "OFF".
- **optimistic** (*Optional*): Flag that defines if switch works in optimistic mode. Default is `true` if no `state_topic` defined, else `false`.
@ -61,6 +62,7 @@ switch:
name: "Bedroom Switch"
state_topic: "home/bedroom/switch1"
command_topic: "home/bedroom/switch1/set"
availability_topic: "home/bedroom/switch1/available"
payload_on: "ON"
payload_off: "OFF"
optimistic: false

2
source/_components/telegram_bot.webhooks.markdown
View file

@ -14,6 +14,8 @@ ha_release: 0.42
Telegram chatbot webhooks implementation as described in the Telegram [documentation](https://core.telegram.org/bots/webhooks).
Using Telegrams `setWebhook` method your bot's webhook URL should be set to `https://<public_url>:<port>/api/telegram_webhooks`.
This is one of two bot implementations supported by Telegram. Described by Telegram as the preferred implementation but requires your Home Assistant instance to be exposed to the internet.
To integrate this into Home Assistant, add the following section to your `configuration.yaml` file:

8
source/_components/tradfri.markdown
View file

@ -35,15 +35,15 @@ $ sudo make install
macOS:
```bash
$ sudo brew install libtool
$ sudo brew install autoconf
$ sudo brew install automake
$ brew install libtool
$ brew install autoconf
$ brew install automake
$ git clone --depth 1 --recursive -b dtls https://github.com/home-assistant/libcoap.git
$ cd libcoap
$ ./autogen.sh
$ ./configure --disable-documentation --disable-shared --without-debug CFLAGS="-D COAP_DEBUG_FD=stderr"
$ make
$ sudo make install
$ make install
```
You will be prompted to configure the gateway through the Home Assistant interface, Enter the security key when prompted and click configure

8
source/_components/weather.buienradar.markdown
View file

@ -14,7 +14,7 @@ ha_iot_class: "Cloud Polling"
---
The `buienradar` platform uses [buienradar.nl](http://buienradar.nl/) as an source for current meteorological data for your location. The weather forecast is delivered by Buienradar, who provides a webservice that provides detailed weather information for users in The Netherlands.
The relevant weatherstation used will be automatically selected based on the location specified in the Home Assistant configuration (or in the buienradar weather/sensor component).
The relevant weatherstation used will be automatically selected based on the location specified in the Home Assistant configuration (or in the buienradar weather/sensor component). A map of all available weatherstations can be found [here](https://www.google.com/maps/d/embed?mid=1NivHkTGQUOs0dwQTnTMZi8Uatj0).
To add the buienradar weather to your installation, add the following to your `configuration.yaml` file:
@ -38,7 +38,8 @@ A full configuration example:
# Example configuration.yaml entry
weather:
- platform: buienradar
name: buienradar
name: 'volkel'
# Force 'Meetstation Volkel' to be used:
latitude: 51.65
longitude: 5.70
forecast: True
@ -48,3 +49,6 @@ weather:
This platform is an alternative to the [`buienradar`](/components/sensor.buienradar/) sensor.
The weather platform is easier to configure but less customisable.
</p>
[Usage statement:](https://www.buienradar.nl/overbuienradar/gratis-weerdata)
> Buienradar makes free weatherdata available for use by individuals and businesses (website/intranet). The use of the weatherdata is allowed for **non-commercial purposes**. Please refer to the full usage statement linked above to confirm your usage or to request permission.