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

Merge remote-tracking branch 'origin/current' into next

Browse source
This commit is contained in:
Paulus Schoutsen 2017-07-13 09:31:46 -07:00
commit 8879b5a610
101 changed files with 631 additions and 860 deletions
Download patch file Download diff file Expand all files Collapse all files

2
source/_components/alert.markdown
View file

@ -27,6 +27,7 @@ The `alert` component makes use of any of the `notifications` components. To set
alert:
garage_door:
name: Garage is open
done_message: Garage is closed
entity_id: input_boolean.garage_door
state: 'on'
repeat: 30
@ -39,6 +40,7 @@ alert:
Configuration variables:
- **name** (*Required*): The friendly name of the alert.
- **done_message** (*Optional*): A message sent after an alert transitions from `on` to `off`. Is only sent if an alert notification was sent for transitioning from `off` to `on`.
- **entity_id** (*Required*): The ID of the entity to watch.
- **state** (*Optional*): The problem condition for the entity. Defaults to `on`.
- **repeat** (*Required*): Number of minutes before the notification should be repeated. Can be either a number or a list of numbers.

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

@ -13,3 +13,7 @@ ha_iot_class: "Cloud Polling"
---
Integrates Verisure binary sensors into Home Assistant. See the [main component](/components/verisure/) for configuration instructions.
The following binary sensor types are supported:
Door & Window

2
source/_components/browser.markdown
View file

@ -25,7 +25,7 @@ browser:
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `url` | no | The url to open
| `url` | no | The URL to open.
### {% linkable_title Usage %}

4
source/_components/camera.generic.markdown
View file

@ -14,7 +14,7 @@ ha_iot_class: "depends"
---
The `generic` camera platform allows you to integrate any IP camera or other url into Home Assistant. Templates can be used to generate the urls on the fly.
The `generic` camera platform allows you to integrate any IP camera or other URL into Home Assistant. Templates can be used to generate the URLs on the fly.
Home Assistant will serve the images via its server, making it possible to view your IP camera's while outside of your network. The endpoint is `/api/camera_proxy/camera.[name]`.
@ -34,7 +34,7 @@ Configuration variables:
- **username** (*Optional*): The username for accessing your camera.
- **password** (*Optional*): The password for accessing your camera.
- **authentication** (*Optional*): Type for authenticating the requests `basic` (default) or `digest`.
- **limit_refetch_to_url_change** (*Optional*): True/false value (default: false). Limits refetching of the remote image to when the url changes. Only relevant if using a template to fetch the remote image.
- **limit_refetch_to_url_change** (*Optional*): True/false value (default: false). Limits refetching of the remote image to when the URL changes. Only relevant if using a template to fetch the remote image.
- **content_type** (*Optional*): Set the content type for the IP camera if it is not a jpg file (default: `image/jpeg`). Use `image/svg+xml` to add a dynamic svg file.
<p class='img'>

20
source/_components/conversation.markdown
View file

@ -12,16 +12,32 @@ ha_category: "Voice"
---
The conversation component can process sentences into commands for Home Assistant. It is currently limited to parsing commands in the format `turn <Friendly Name> <on/off>`.
The conversation component can process sentences into commands for Home Assistant. It currently has built in functionality to recognize `turn <Friendly Name> <on/off>`, but custom phrases can be added through configuration.
To enable the conversation option in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
# Example base configuration.yaml entry
conversation:
```
To add custom phrases to be recognized:
```yaml
# Example configuration.yaml entry with custom phrasesconversation
conversation:
boolean_test:
sentence: switch boolean # The phrase it will recognize
action:
service: input_boolean.toggle
```
The action keyword uses [script
syntax](https://home-assistant.io/docs/scripts/).
When this component is active and you are using a supported browser voice commands will be activated in the frontend. Browse to [the demo](/demo/) using Chrome or Chromium to see it in action.
<p class='img'>

9
source/_components/cover.knx.markdown
View file

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: knx.png
ha_category: DIY
ha_category: Cover
ha_release: 0.48
ha_iot_class: "Local Polling"
---
@ -26,9 +26,12 @@ cover:
stop_address: 9/0/1
```
- **name** (*Optional*): A name for this devices used within Home Assistant.
- **updown_address** (*Required*): The KNX group address that is used to move the cover up and down.
- **stop_address** (*Required*): The group address that is used to stop the cover.
- **setposition_address** (*Optional*): The group address that is used to set the position.
- **getposition_address** (*Optional*): The group address that is used to read the position.
- **name** (*Optional*): A name for this devices used within Home Assistant.
- **setangle_address** (*Optional*): The group address that is used to set the tilt angle.
- **getangle_address** (*Optional*): The group address that is used to read the tilt angle.
- **invert_position** (*Optional*): Set this to true if your actuator report fully closed as 100%
- **invert_angle** (*Optional*): Set this to true if your actuator reports tilt fully closed as 100%

8
source/_components/cover.template.markdown
View file

@ -13,7 +13,7 @@ ha_iot_class: "Local Push"
logo: home-assistant.png
---
The `template` platform can create covers that combine components and provides the ability to run scripts or invoke services for each of the open, close, stop, position, and tilt commands of a cover.
The `template` platform can create covers that combine components and provides the ability to run scripts or invoke services for each of the open, close, stop, position, and tilt commands of a cover.
To enable Template covers in your installation, add the following to your `configuration.yaml` file:
@ -65,13 +65,13 @@ cover:
value_template: "{% raw %}{{ sensor.garage_door }}{% endraw %}"
open_cover:
service: switch.turn_on
entity_is: switch.garage_door
entity_id: switch.garage_door
close_cover:
service: switch.turn_off
entity_is: switch.garage_door
entity_id: switch.garage_door
stop_cover:
service: switch.turn_on
entity_is: switch.garage_door
entity_id: switch.garage_door
icon_template: "{% raw %}{% if not is_state('sensor.garage_door', 'on') %}mdi:garage-open{% else %}mdi:garage{% endif %}{% endraw %}"
```

17
source/_components/device_tracker.mikrotik.markdown
View file

@ -15,6 +15,21 @@ ha_release: 0.44
The `mikrotik` platform offers presence detection by looking at connected devices to a [Mikrotik Routerboard](http://routerboard.com) based router.
You need to enable the RouterOS API to use this platform.
Terminal:
```bash
/ip service
set api disabled=no port=8728
```
Web Frontend:
Go to **IP** -> **Services** -> **API** and enable it.
Make sure that port 8728 or the port you choose is accessible from your network.
To use an Mikrotik router in your installation, add the following to your `configuration.yaml` file:
```yaml
@ -31,6 +46,6 @@ Configuration variables:
- **host** (*Required*): The IP address of your router.
- **username** (*Required*: The username of an user with administrative privileges.
- **password** (*Required*): The password for your given admin account.
- **port** (*Optional*): Mikrotik API port (see IP -> Services -> api ). Defaults to `8728`.
- **port** (*Optional*): Mikrotik API port. Defaults to `8728`.
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

7
source/_components/downloader.markdown
View file

@ -36,7 +36,8 @@ Go the the "Developer Tools", then to "Call Service", and choose `downloader/dow
This will download the file from the given URL.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `url` | no | The url of the file to download.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------- |
| `url` | no | The url of the file to download. |
| `subdir` | yes | Download into subdirectory of **download_dir** |

2
source/_components/fan.insteon_local.markdown
View file

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: insteon.png
ha_category: fan
ha_category: Fan
ha_version: 0.48
---

2
source/_components/image_processing.markdown
View file

@ -15,7 +15,7 @@ Image processing enables Home Assistant to process images from [cameras](/compon
For interval control, use `scan_interval` in platform.
<p class='note'>
If you are running Home Assistant over SSL or from within a container, you will have to setup a base url inside the [http component](/components/http/).
If you are running Home Assistant over SSL or from within a container, you will have to setup a base URL (`base_url`) inside the [http component](/components/http/).
</p>
## {% linkable_title ALPR %}

3
source/_components/knx.markdown
View file

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: knx.png
ha_category: DIY
ha_category: Hub
ha_release: 0.24
ha_iot_class: "Local Polling"
---
@ -18,6 +18,7 @@ ha_iot_class: "Local Polling"
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](/components/binary_sensor.knx)
- [Cover](/components/cover.knx)
- [Sensor](/components/sensor.knx)
- [Switch](/components/switch.knx)
- [Light](/components/light.knx)

4
source/_components/light.template.markdown
View file

@ -32,7 +32,7 @@ light:
set_level:
service: script.theater_lights_level
data_template:
volume_level: "{% raw %}{{brightness}}{% endraw %}"
brightness: "{% raw %}{{brightness}}{% endraw %}"
level_template: "{% raw %}{{is_state('sensor.theater_brightness.attributes.lux'}}{% endraw %}"
```
@ -103,4 +103,4 @@ light:
0
{%- endif -%}
{% endraw %}
```
```

1
source/_components/media_player.panasonic_viera.markdown
View file

@ -23,6 +23,7 @@ Currently known supported models:
- TX-55CX700E
- TX-49DX650B
- TX-50DX700B
- TX-L42ET50
If your model is not on the list then give it a test, if everything works correctly then add it to the list on [GitHub](https://github.com/home-assistant/home-assistant.io).

12
source/_components/media_player.pandora.markdown
View file

@ -19,12 +19,18 @@ If you have a Pandora account, you can control it from Home Assistant with this
### {% linkable_title Installation of Pianobar %}
This media player uses the [Pianobar command-line Pandora client](https://github.com/PromyLOPh/pianobar), which you have to install separately. This can be done on a Raspberry Pi 2 with Raspbian Jesse as follows . _(Note: Other platforms may have different installation processes)_
This media player uses the [Pianobar command-line Pandora client](https://github.com/PromyLOPh/pianobar), which you have to install separately. This can be done on a Raspberry Pi 2/3 with Raspbian Jessie as follows . _(Note: Other platforms may have different installation processes)_
Install the following dependencies:
The version of pianobar that comes with Jessie has a bug, so you have to build a more recent version. The latest version depends on a recent version of libraries associated with ffmpeg, so you should make sure you go through the backport process documented in [The FFmpeg component](https://home-assistant.io/components/ffmpeg/) before doing this. Install the following basic dependencies:
```bash
$ sudo apt-get install git libao-dev libgcrypt11-dev libfaad-dev libmad0-dev libjson0-dev make pkg-config libav-tools libavcodec-extra libavcodec-dev libcurl4-openssl-dev libavfilter-dev libavformat-dev
$ sudo apt-get install git libao-dev libgcrypt11-dev libfaad-dev libmad0-dev libjson0-dev make pkg-config libcurl4-openssl-dev
```
And now install the backported ffmpeg-related libraries (note that if you're using an older version of ffmpeg for other things on this machine, you may encounter issues after doings this):
```bash
$ sudo apt-get -t jessie-backports install libav-tools libavcodec-extra libavcodec-dev libavfilter-dev libavformat-dev
```
Now clone the Pianobar repo and build pianobar:

1
source/_components/media_player.samsungtv.markdown
View file

@ -59,6 +59,7 @@ Currently tested but not working models:
- J5200 - Unable to see state and unable to control
- JU7000 - Unable to see state and unable to control (but port 8001 *is* open)
- JU7500 - Unable to see state and unable to control
- JS9500 - State is always "on" and unable to control (but port 8001 *is* open)
If your model is not on the list then give it a test, if everything works correctly then add it to the list on [GitHub](https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/media_player.samsungtv.markdown).
The first letter (U, P, L, H & K) represent the screen type, e.g. LED or Plasma. The second letter represents the region, E is Europe, N is North America and A is Asia & Australia. The two numbers following that represent the screen size.

4
source/_components/media_player.universal.markdown
View file

@ -96,12 +96,12 @@ media_player:
service: media_player.select_source
data_template:
entity_id: media_player.receiver
source: '{{ source }}'
source: '{% raw %}{{ source }}{% endraw %}'
volume_set:
service: media_player.volume_set
data_template:
entity_id: media_player.receiver
volume_level: '{{ volume_level }}'
volume_level: '{% raw %}{{ volume_level }}{% endraw %}'
attributes:
state: switch.living_room_tv

4
source/_components/notify.smtp.markdown
View file

@ -32,11 +32,11 @@ Configuration variables:
- **sender** (*Required*): E-mail address of the sender.
- **recipient** (*Required*): E-mail address of the recipient of the notification. This can be a recipient address or a list of addresses for multiple recipients.
- **server** (*Optional*): SMTP server which is used to end the notifications. Defaults to `localhost`.
- **port** (*Optional*): The port that the SMTP server is using. Defaults to 465.
- **port** (*Optional*): The port that the SMTP server is using. Defaults to 587.
- **timeout** (*Optional*): The timeout in seconds that the SMTP server is using. Defaults to 5.
- **username** (*Optional*): Username for the SMTP account.
- **password** (*Optional*): Password for the SMTP server that belongs to the given username. If the password contains a colon it need to be wrapped in apostrophes.
- **encryption** (*Optional*): Set mode for encryption, `tls`, `starttls` or `none`. Defaults to `tls`.
- **encryption** (*Optional*): Set mode for encryption, `starttls`, `tls` or `none`. Defaults to `starttls`.
- **sender_name** (*Optional*): Sets a custom 'sender name' in the emails headers (*From*: Custom name <example@mail.com>).
- **debug** (*Optional*): Enables Debug, eg. True or False. Defaults to False.

24
source/_components/remote.harmony.markdown
View file

@ -24,20 +24,34 @@ Supported units:
- Harmony Elite
To use your Harmony remote in your installation, add the following to your `configuration.yaml` file:
The preferred way to setup the Harmony remote is by enabling the [discovery component](/components/discovery/).
However, if you want to manually configure the device, you will need to add its settings to your `configuration.yaml`.
```yaml
# Example configuration.yaml entry
remote:
- platform: harmony
name: Bedroom
host: 10.168.1.13
host: 10.168.1.13 # The IP of your hub
```
You can override some default configuration values on a discovered hub (e.g. the `port` or `activity`) by adding
a `configuration.yaml` setting. In this case leave the `host` setting empty so the platform will
discover the host IP automatically, but set the `name` in the config to match exactly the name you have
set for your Hub so the platform knows what Hub you are trying to configure.
```yaml
# Example configuration.yaml entry with discovery
- platform: harmony
name: Living Room # This name must match the name you have set on the Hub
activity: Watch TV # Overriding the 'activity' setting for this discovered hub
```
Configuration variables:
- **name** (*Required*): The hub's name to display in the frontend.
- **host** (*Required*): The Harmony device's IP address.
- **host** (*Optional*): The Harmony device's IP address. Leave empty for the IP to be discovered automatically.
- **port** (*Optional*): The Harmony device's port. Defaults to 5222.
- **activity** (*Optional*): Activity to use when turnon service is called without any data.
- **scan_interval** (*Optional*): Amount in seconds in between polling for device's current activity. Defaults to 30 seconds.
@ -134,12 +148,12 @@ automation:
data_template:
# using a data template to have if brances for relavant device
# Always the same entity_id - the harmony hub
entity_id: remote.bedroom
entity_id: remote.bedroom
# Always the same command - the Pause key
command: Pause
# select device based upon the activity being undertaken.
device: >
# when in WATCH TV activity, the pause key relates to a TiVo, which is device 22987101
# when in WATCH TV activity, the pause key relates to a TiVo, which is device 22987101
{% raw %}{% if is_state("sensor.bedroom", "WATCH TV") %}{% raw %}
22987101
# when in WATCH APPLE TV activity, the pause key relates to an Apple TV, which is device 23002316

2
source/_components/sensor.cups.markdown
View file

@ -36,6 +36,8 @@ sensor:
Configuration variables:
- **printers** array (*Required*): List of printers to add.
- **host** (*Optional*): IP address of the CUPS print server.
- **port** (*Optional*): Port address of the CUPS print server. Defaults to 631.
<p class='note'>

4
source/_components/sensor.speedtest.markdown
View file

@ -89,3 +89,7 @@ sensor:
- download
- upload
```
## {% linkable_title Notes %}
When running on Raspberry Pi, just note that the maximum speed is limited by its 100 Mbit/s LAN adapter.

4
source/_components/sensor.torque.markdown
View file

@ -13,7 +13,7 @@ ha_release: "0.10"
ha_iot_class: "Cloud Polling"
---
The `torque` platform will allow you to monitor [Torque](http://torque-bhp.com/) data relayed from a bluetooth OBD2 stick via the Torque mobile application.
The `torque` platform will allow you to monitor [Torque](http://torque-bhp.com/) data relayed from a Bluetooth OBD2 stick via the Torque mobile application.
## {% linkable_title Configuration %}
To use Torque sensors with your installation, you must configure both the Torque mobile application and Home Assistant.
@ -30,7 +30,7 @@ Under the **Logging Preferences** header:
Under the **Realtime Web Upload** header:
- Check **Upload to webserver**.
- Enter `http://HOST:PORT/api/torque?api_password=YOUR_PASSWORD` as the **Webserver URL**, where `HOST` and `PORT` are your externally-accessible Home Assistant HTTP host and port and YOUR_PASSWORD is your password.
- Enter `http://HOST:PORT/api/torque?api_password=YOUR_PASSWORD` as the **Webserver URL**, where `HOST` and `PORT` are your externally accessible Home Assistant HTTP host and port and YOUR_PASSWORD is your Home Assistant's [API password](/components/http/). It highly recommended that you protect your Home Assistant instance with [SSL/TSL](/docs/ecosystem/certificates/).
- Enter an email address in **User Email Address**.
- Optionally set the **Web Logging Interval**. The 2-second default may quickly fill up the Home Assistant history database.

6
source/_components/sensor.wunderground.markdown
View file

@ -34,9 +34,9 @@ sensor:
Configuration variables:
- **api_key** (Required): The API key for Weather Underground. See above for details.
- **pws_id** (Optional): You can enter a Personal Weather Station ID. The current list of Wunderground PWS stations is available [here](https://www.wunderground.com/weatherstation/ListStations.asp). If you do not enter a PWS ID, the current location information (latitude and longitude) from your `configuration.yaml` will be used to display weather conditions.
- **lang** (Optional): Specify the language that the API returns. The current list of all Wunderground language codes is available [here](https://www.wunderground.com/weather/api/d/docs?d=language-support). If not specified, it defaults to English (EN).
- **api_key** (*Required*): The API key for Weather Underground. See above for details.
- **pws_id** (*Optional*): You can enter a Personal Weather Station ID. The current list of Wunderground PWS stations is available [here](https://www.wunderground.com/weatherstation/ListStations.asp). If you do not enter a PWS ID, the current location information (latitude and longitude) from your `configuration.yaml` will be used to display weather conditions.
- **lang** (*Optional*): Specify the language that the API returns. The current list of all Wunderground language codes is available [here](https://www.wunderground.com/weather/api/d/docs?d=language-support). If not specified, it defaults to English (EN).
- **latitude** (*Optional*): Latitude coordinate to monitor weather of (required if **longitude** is specificed). Defaults to coordinates defined in your `configuration.yaml`.
- **longitude** (*Optional*): Longitude coordinate to monitor weather of (required if **latitude** is specified). Defaults to coordinates defined in your `configuration.yaml`.
- **monitored_conditions** array (*Required*): Conditions to display in the frontend. The following conditions can be monitored.

2
source/_components/tts.markdown
View file

@ -42,7 +42,7 @@ tts:
```
<p class='note'>
If you are running Home Assistant over SSL or from within a container, you will have to setup a base url inside the [http component](/components/http/).
If you are running Home Assistant over SSL or from within a container, you will have to setup a base URL (`base_url`) inside the [http component](/components/http/).
</p>
## {% linkable_title Service say %}

2
source/_components/verisure.markdown
View file

@ -22,6 +22,7 @@ We support:
* Reading from thermometers and hygrometers integrated in various [devices](/components/sensor.verisure/)
* Mouse Detector
* [Locks](/components/lock.verisure/)
* [Door & Window](/components/binary_sensor.verisure/)
To integrate Verisure with Home Assistant, add the following section to your `configuration.yaml` file:
@ -42,5 +43,6 @@ Configuration variables:
- **locks** (*Optional*): Set to 1 to show locks, 0 to disable. Default 1.
- **thermometers** (*Optional*): Set to 1 to show thermometers, 0 to disable. Default 1.
- **mouse** (*Optional*): Set to 1 to show mouse detectors, 0 to disable. Default 1.
- **door_window** (*Optional*): Set to 1 to show door and window sensors, 0 to disable. Default 1.
- **code_digits** (*Optional*): Number of digits in PIN code. Default 4.

2
source/_components/volvooncall.markdown
View file

@ -25,7 +25,7 @@ volvooncall:
password: password
```
Users registered with Volvo in North America or China will need to specify a service url:
Users registered with Volvo in North America or China will need to specify a service URL:
```yaml
# North America