jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-23 09:17:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1861 from home-assistant/next

Browse Source 
0.37
This commit is contained in:
Fabian Affolter 2017-01-29 00:47:26 +01:00 committed by GitHub
commit 7c390362d8
75 changed files with 1691 additions and 153 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
_config.yml
View File

@ -130,10 +130,10 @@ social:
# Home Assistant release details
current_major_version: 0
current_minor_version: 36
current_patch_version: 1
date_released: 2017-01-17
current_minor_version: 37
current_patch_version: 0
date_released: 2017-01-29
# Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it.
patch_version_notes: "#release-0361---january-17"
patch_version_notes: ""

31
source/_components/alarm_control_panel.wink.markdown Normal file
View File

@ -0,0 +1,31 @@
---
layout: page
title: "Wink Alarm"
description: "Instructions how to setup the Wink alarms within Home Assistant."
date: 2017-01-14 12:00
sidebar: true
comments: false
sharing: true
footer: true
logo: wink.png
ha_category: Alarm
ha_release: 0.37
---
No Wink hub is required to support these devices.
The Wink alarm platform allows you to control your [Wink](http://www.wink.com/) Canary all-in-one security camera.
The requirement is that you have setup [Wink](/components/wink/).
### Supported devices
- Canary all-in-one security camera
<p class='note'>
The above devices are confimed to work, but others may work as well.
</p>

40
source/_components/binary_sensor.bbb_gpio.markdown Normal file
View File

@ -0,0 +1,40 @@
---
layout: page
title: "BeagleBone Black GPIO Binary Sensor"
description: "Instructions how to integrate the GPIO sensor capability of a BeagleBone Black into Home Assistant."
date: 2017-01-14 10:00
sidebar: true
comments: false
sharing: true
footer: true
logo: beaglebone-black.png
ha_category: Binary Sensor
ha_release: 0.37
---
The `bbb_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [BeagleBone Black](https://beagleboard.org/black).
To use your BeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: bbb_gpio
pins:
P8_12:
name: Door
GPIO0_26:
name: Window
```
Configuration variables:
- **pins** array (*Required*): Array of used pins.
- **pin_name** (*Required*): Pin numbers and corresponding names.
- **name** (*Required*): Friendly name to use for the frontend.
- **bouncetime** (*Optional*): Debounce time for reading input pin defined in miliseconds [ms]. Defaults to `50 ms`.
- **invert_logic** (*Optional*): If `true`, inverts the input logic to ACTIVE LOW. Default is `false` (ACTIVE HIGH).
- **pull_mode** (*Optional*): Type of internal pull resistor connected to input. Options are `UP` - pull-up resistor and `DOWN` - pull-down resistor. Defaults to `UP`.
For more details about the GPIO layout, visit the [article](http://elinux.org/Beagleboard:BeagleBoneBlack) about the BeagleBone Black.

24
source/_components/binary_sensor.ffmpeg.markdown
View File

@ -17,7 +17,7 @@ ha_iot_class: "Local Polling"
The `ffmpeg` platform allows you to use any video or audio feed with [FFmpeg](http://www.ffmpeg.org/) for various sensors in Home Assistant. Available are: **noise**, **motion**.
<p class='note'>
If the `ffmpeg` process is broken, the sensor will be unavailable. To restart it, use the service *binary_sensor.ffmpeg_restart*.
If the `ffmpeg` process is broken, the sensor will be unavailable. To controll the ffmpeg process of sensor, use the service *binary_sensor.ffmpeg_start*, *binary_sensor.ffmpeg_stop*, *binary_sensor.ffmpeg_restart*.
</p>
### {% linkable_title Noise %}
@ -36,6 +36,7 @@ Configuration variables:
- **input** (*Required*): An FFmpeg-compatible input file, stream, or feed.
- **tool** (*Required*): `noise`.
- **name** (*Optional*): Override the name of your camera.
- **initial_state** (*Optional*): Default true. Start ffmpeg with home-assistant.
- **peak** (*Optional*): Default -30. The threshold of detecting noise, in dB. 0 is very loud and -100 is low.
- **duration** (*Optional*): Default 1 second. How long the noise needs to be over the peak to trigger the state.
- **reset** (*Optional*): Default 20 seconds. The time to reset the state after no new noise is over the peak.
@ -66,14 +67,15 @@ Configuration variables:
- **input** (*Required*): An FFmpeg-compatible input file, stream, or feed.
- **tool** (*Required*): `motion`.
- **name** (*Optional*): Override the name of your camera.
- **changes** (*Optional*): Default 10%. How much needs to change between two frames to detect it as motion (a lower value is more sensitive).
- **reset** (*Optional*): Default 20 seconds. The time to reset the state after no new motion is detected.
- **repeat** (*Optional*): Default 0 repeats (deactivate). How many events need to be detected in *repeat_time* in order to trigger a motion.
- **repeat_time** (*Optional*): Default 0 seconds (deactivate). The span of time *repeat* events need to occur in before triggering a motion.
- **extra_arguments** (*Optional*): Extra options to pass to FFmpeg, e.g. video denoise filtering.
- **name** (*Optional*): Override the name of your camera for the frontend.
- **initial_state** (*Optional*): Start `ffmpeg` with Home Assistant. Defaults to `true`.
- **changes** (*Optional*): How much needs to change between two frames to detect it as motion (a lower value is more sensitive). Defaults to 10%.
- **reset** (*Optional*): The time to reset the state after no new motion is detected. Defaults to 20 seconds.
- **repeat** (*Optional*): How many events need to be detected in *repeat_time* in order to trigger a motion. Defaults to 0 repeats (deactivated).
- **repeat_time** (*Optional*): The span of time *repeat* events need to occur in before triggering a motion. Defaults to 0 seconds (deactivated).
- **extra_arguments** (*Optional*): Extra options to pass to `ffmpeg`, e.g. video denoise filtering.
To experiment with values (changes/100 is the scene value in FFmpeg):
To experiment with values (changes/100 is the scene value in `ffmpeg`):
```bash
$ ffmpeg -i YOUR_INPUT -an -filter:v select=gt(scene\,0.1) -f framemd5 -
@ -83,4 +85,8 @@ If you are running into trouble with this sensor, please refer to the [troublesh
#### {% linkable_title Tipps %}
- Use motion only in a customer area with [crop filter](https://ffmpeg.org/ffmpeg-filters.html#crop): ```extra_arguments: -filter:v "crop=100:100:12:34"```
- Use motion only in a customer area with [crop filter](https://ffmpeg.org/ffmpeg-filters.html#crop):
```yaml
extra_arguments: -filter:v "crop=100:100:12:34"
```

42
source/_components/binary_sensor.iss.markdown Normal file
View File

@ -0,0 +1,42 @@
---
layout: page
title: "International Space Station"
description: "Know if or when ISS will be above your home location"
date: 2016-12-18 10:00
sidebar: true
comments: false
sharing: true
footer: true
logo: nasa.png
ha_category: Binary Sensor
ha_release: 0.36
---
The `iss` platform uses the [Open Notify API](http://open-notify.org/Open-Notify-API/ISS-Location-Now/) to let you know if the station is above your home location. This means that ISS is 10° above the horizon of your home.
You can check in the attributes of the sensor to see the timestamp for the next rise of the station, its current coordinates, and the number of people in space.
To add ISS binary sensor to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: iss
```
Configuration variables:
- **show_on_map** (*Optional*): Option to show the position of the ISS on the map. Defaults to `False`.
### {% linkable_title Show position on map with camera platform %}
The [generic camera platform](/components/camera.mjpeg/) offers the possibility to show the location of the ISS on Google Maps.
```yaml
# Example configuration.yaml entry
camera:
- platform: generic
name: ISS
still_image_url: {% raw %}https://maps.googleapis.com/maps/api/staticmap?center={{ states.binary_sensor.iss.attributes.lat }},{{ states.binary_sensor.iss.attributes.long }}&zoom=5&size=500x500&maptype=roadmap&markers=color:blue%7Clabel:P%7C{{ states.binary_sensor.iss.attributes.lat }},{{ states.binary_sensor.iss.attributes.long }}{% endraw %}
limit_refetch_to_url_change: true
```

20
source/_components/binary_sensor.nest.markdown
View File

@ -16,33 +16,25 @@ ha_release: pre 0.7
The `nest` binary sensor platform lets you monitor various states of your [Nest](https://nest.com) devices.
<p class='note'>
You must have the [Nest component](/components/nest/) configured to use these sensors. The `nest` binary sensor will automatically be setup when you do.
You must have the [Nest component](/components/nest/) configured to use these sensors. The binary sensors will be setup if the `nest` component is configured and the required configuration for the `nest binary sensor` is set.
</p>
To customize which binary sensors are enabled, you can add the following to your `configuration.yaml` file:
To enable binary sensors and customize which sensors are setup, you can extend the [Nest component](/components/nest/) configuration in your `configuration.yaml` file with the following settings:
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: nest
nest:
binary_sensors:
monitored_conditions:
- 'fan'
- 'is_using_emergency_heat'
- 'target'
```
If you leave `monitored_conditions` blank, all sensors that are available for your devices will be used.
By default all binary sensors for your available Nest devices will be monitored. Leave `monitored_conditions` blank to disable all binary sensors for the [Nest component](/components/nest/).
Configuration variables:
- **monitored_conditions** array (*Optional*): States to monitor.
- online
- fan
- is\_using\_emergency\_heat
- is\_locked
- has\_leaf
- motion\_detected
- person\_detected
- sound\_detected
The following conditions are available by device:

26
source/_components/binary_sensor.netatmo.markdown
View File

@ -14,7 +14,7 @@ ha_release: 0.31
### {% linkable_title Basic Configuration %}
The `netatmo` binary sensor platform is consuming the information provided by a [Netatmo Welcome](https://www.netatmo.com) camera. This component allows you to get the latest event seen by the camera.
The `netatmo` binary sensor platform is consuming the information provided by a [Netatmo](https://www.netatmo.com) camera. This component allows you to get the latest event seen by the camera.
To enable the Netatmo binary sensor, you have to set up [netatmo](/components/netatmo/), this will use discovery to add your binary sensor.
@ -28,27 +28,35 @@ binary_sensor:
platform: netatmo
home: home_name
timeout: 15
offset: 90
cameras:
- camera_name1
monitored_conditions:
welcome_sensors:
- Someone known
- Someone unknown
- Someone unknown
- Motion
presence_sensors:
- Outdoor motion
- Outdoor human
- Outdoor animal
- Outdoor vehicle
```
Configuration variables:
- **home** (*Optional*): Will use the cameras of this home only.
- **timeout** (*Optional*): The binary sensors will reflect the events from the last X minutes (default: 15)
- **timeout** (*Optional*): The Welcome binary sensors will reflect the events from the last X minutes. (default: 15)
- **offset** (*Optional*): The Presence binary sensors will stay on for X seconds after detection. (default: 90)
- **cameras** array (*Optional*): Cameras to use. Multiple entities allowed.
- 'camera_name': Name of the camera to display.
- **monitored_conditions** array (*Optional*): List of monitored conditions.
- **welcome_sensors** array (*Optional*): List of monitored conditions.
- 'Someone known'
- 'Someone unknown'
- 'Motion'
- **presence_sensors** array (*Optional*): List of monitored conditions.
- 'Outdoor motion'
- 'Outdoor human'
- 'Outdoor animal'
- 'Outdoor vehicle'
If **home** and **cameras** is not provided, all cameras will be used. If multiple cameras are available then each monitored conditions will create a specific sensor for each camera
<p class='note'>
[Welcome tags](https://www.netatmo.com/product/security/welcome/tags) are not yet supported, but will be in a next update.
</p>

20
source/_components/binary_sensor.wink.markdown
View File

@ -16,5 +16,23 @@ ha_iot_class: "Cloud Polling"
The Wink binary sensor platform allows you to get data from your [Wink](http://www.wink.com/) binary sensors.
The requirement is that you have setup your [Wink hub](/components/wink/).
The requirement is that you have setup [Wink](/components/wink/).
### Supported Binary sensor devices
- Smoke and CO detectors (No Wink hub required for Nest)
- Window/Door sensors
- Motion sensors
- Ring Door bells (No hub required)
- Liquid presense sensors
- Z-wave lock key codes
- Lutron connected bulb remote buttons
- Wink Relay buttons and presense 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...
<p class='note'>
The above devices are confimed to work, but others may work as well.
</p>

4
source/_components/camera.amcrest.markdown
View File

@ -33,4 +33,8 @@ Configuration variables:
- **name** (*Optional*): This parameter allows you to override the name of your camera. The default is "Amcrest Camera".
- **port** (*Optional*): The port that the camera is running on. The default is 80.
- **resolution** (*Optional*): This parameter allows you to specify the camera resolution. For a high resolution (1080/720p), specify the option `high`. For VGA resolution (640x480p), specify the option `low`. If omitted, it defaults to *high*.
- **stream_source** (*Optional*): The data source for the live stream. `mjpeg` will use the camera's native MJPEG stream, whereas `snapshot` will use the camera's snapshot API to create a stream from still images. If omitted, it defaults to *mjpeg*.
**Note:** Amcrest cameras with newer firmwares no longer have the ability to stream `high` definition video with MJPEG encoding. You may need to use `low` resolution stream or the `snapshot` stream source instead. If the quality seems too poor, lower the `Frame Rate (FPS)` and max out the `Bit Rate` settings in your camera's configuration manager.
To check if your Amcrest camera is supported/tested, visit the [supportability matrix](https://github.com/tchellomello/python-amcrest#supportability-matrix) link from the `python-amcrest` project.

1
source/_components/camera.mjpeg.markdown
View File

@ -29,6 +29,7 @@ camera:
Configuration variables:
- **mjpeg_url** (*Required*): The URL your camera serves the video on, eg. http://192.168.1.21:2112/
- **still_image_url** (*Optional*): The URL for thumbmail picture if camera support that.
- **name** (*Optional*): This parameter allows you to override the name of your camera.
- **username** (*Optional*): The username for accessing your camera.
- **password** (*Optional*): The password for accessing your camera.

4
source/_components/camera.netatmo.markdown
View File

@ -1,7 +1,7 @@
---
layout: page
title: "Netatmo Camera"
description: "Instructions how to integrate Netatmo camera into Home Assistant."
description: "Instructions how to integrate Netatmo cameras into Home Assistant."
date: 2016-06-02 08:10
sidebar: true
comments: false
@ -14,7 +14,7 @@ ha_release: 0.22
### {% linkable_title Basic Configuration %}
The `netatmo` camera platform is consuming the information provided by a [Netatmo Welcome](https://www.netatmo.com) camera. This component allows you to view the current photo created by the Camera.
The `netatmo` camera platform is consuming the information provided by a [Netatmo](https://www.netatmo.com) camera. This component allows you to view the current photo created by the Camera.
To enable the Netatmo camera, you have to set up [netatmo](/components/netatmo/), this will use discovery to add your camera.

16
source/_components/climate.wink.markdown
View File

@ -16,5 +16,19 @@ ha_iot_class: "Cloud Polling"
The Wink climate platform allows you to get data from your [Wink](http://www.wink.com/) thermostats.
The requirement is that you have setup your [Wink hub](/components/wink/).
The requirement is that you have setup [Wink](/components/wink/).
### Supported climate devices:
- Nest (No wink hub required)
- Ecobee (No wink hub required)
- Sensi (No wink hub required)
- Carrier (Unconfirmed)
- Honeywell (No wink hub required)
- Generic Z-Wave
<p class='note'>
The above devices are confimed to work, but others may work as well.
</p>

16
source/_components/cover.wink.markdown
View File

@ -18,4 +18,18 @@ The following quote is from Wink.
> As part of our agreement with Chamberlain, third-party access to control Chamberlain garage doors has been restricted. Please contact Chamberlain directly to inquire about permissions.
The requirement is that you have setup your [Wink hub](/components/wink/).
The requirement is that you have setup [Wink](/components/wink/).
### Supported cover devices
- Bali window treatments
- Lutron shades
- Pella motorized blinds and shades
- GoControl garage door opener
- Chamberlain (Limited functionality) (No Wink hub required)
<p class='note'>
The above devices are confimed to work, but others may work as well.
</p>

31
source/_components/device_tracker.sky_hub.markdown Normal file
View File

@ -0,0 +1,31 @@
---
layout: page
title: "Sky Hub"
description: "Instructions how to integrate Sky Hub routers into Home Assistant."
date: 2017-01-28 09:00
sidebar: true
comments: false
sharing: true
footer: true
logo: sky.png
ha_category: Presence Detection
ha_release: 0.37
---
The `sky_hub` platform offers presence detection by looking at connected devices to a [Sky Hub router](http://www.sky.com/shop/broadband-talk/sky-hub/) based router.
To use your Sky Hub device in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
device_tracker:
- platform: sky_hub
```
Configuration variables:
- **host** (*Optional*): The IP address of your router. Defaults to `192.168.1.254`.
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

37
source/_components/device_tracker.tado.markdown Normal file
View File

@ -0,0 +1,37 @@
---
layout: page
title: "Tado"
description: "Instructions how to integrate Tado into Home Assistant."
date: 2017-01-17 12:00
sidebar: true
comments: false
sharing: true
footer: true
logo: tado.png
ha_category: Presence Detection
ha_release: 0.37
---
The `tado` device tracker is using the [Tado Smart Thermostat](https://www.tado.com/) and it's support for person presence detection based on smartphone location by geofencing.
This tracker uses the Tado API to determine if a mobile device is at home.
To use the Tado platform in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry for Tado
device_tracker:
- platform: tado
username: YOUR_USERNAME
password: YOUR_PASSWORD
```
Configuration variables:
- **username** (*Required*): The username for your Tado account.
- **password** (*Required*): The password for your Tado account.
After configuration, your device has to be at home at least once before showing up as 'home' or 'away'.
Polling Tado API for presence information will occure at most once every 30 seconds.
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

12
source/_components/fan.wink.markdown
View File

@ -15,5 +15,15 @@ ha_release: 0.36
The Wink fan platform allows you to control your [Wink](http://www.wink.com/) fans.
The requirement is that you have setup your [Wink hub](/components/wink/).
The requirement is that you have setup [Wink](/components/wink/).
### Supported fan devices
- Gardinier
<p class='note'>
The above devices are confimed to work, but others may work as well.
</p>

7
source/_components/ha.markdown
View File

@ -1,6 +1,6 @@
---
layout: page
title: "Home Assistant 0.36"
title: "Home Assistant 0.37"
description: ""
date: 2016-12-16 17:00
sidebar: true
@ -8,8 +8,8 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Release
ha_release: 0.36
ha_category: Other
ha_release: 0.37
---
Details about the latest release can always be found at:
@ -17,4 +17,3 @@ Details about the latest release can always be found at:
- [Release blog posts](https://home-assistant.io/blog/categories/release-notes/)
- [GitHub releases](https://github.com/home-assistant/home-assistant/releases)
- [Python Package Index](https://pypi.python.org/pypi/homeassistant/)

116
source/_components/hdmi_cec.markdown
View File

@ -13,7 +13,7 @@ ha_release: 0.23
ha_iot_class: "Local Push"
---
The CEC component provides services that allow selecting the active device, powering on all devices, and setting all devices to standby. Devices are defined in the configuration file by associating HDMI port number and a device name. Connected devices that provide further HDMI ports, such as Soundbars and AVRs are also supported. Devices are listed from the perspective of the CEC-enabled Home Assistant device. Any connected device can be listed, regardless of whether it supports CEC. Ideally the HDMI port number on your device will map correctly the CEC physical address. If it does not, use `cec-client` (part of the `libcec` package) to listen to traffic on the CEC bus and discover the correct numbers.
The HDMI CEC component provides services that allow selecting the active device, powering on all devices, setting all devices to standby and creates switch entites for HDMI devices. Devices are defined in the configuration file by associating HDMI port number and a device name. Connected devices that provide further HDMI ports, such as Soundbars and AVRs are also supported. Devices are listed from the perspective of the CEC-enabled Home Assistant device. Any connected device can be listed, regardless of whether it supports CEC. Ideally the HDMI port number on your device will map correctly the CEC physical address. If it does not, use `cec-client` (part of the `libcec` package) to listen to traffic on the CEC bus and discover the correct numbers.
## {% linkable_title CEC Setup %}
@ -50,11 +50,13 @@ $ ln -s /usr/local/lib/python3.4/dist-packages/cec /srv/hass/hass_venv/lib/pytho
```bash
ssh pi@your_raspberry_pi_ip
```
* at the command line type:
```bash
echo scan | cec-client -s -d 1
```
* This will give you the list of devices that are on the bus
```bash
@ -72,12 +74,28 @@ power status: on
language: ???
```
**Note the address: line above this will be used to configure HA, this address is represented below as 3: BlueRay player**
<p class='note'>`address:` entry above this will be used to configure Home Assistant, this address is represented below as 3: BlueRay player.
</p>
## {% linkable_title Configuration Example %}
In the following example, a Pi Zero running Home Assistant is on a TV's HDMI port 1. HDMI port 2 is attached to a AV receiver. Three devices are attached to the AV receiver on HDMI ports 1 through 3.
You can use either direct mapping name to physical address of device
```yaml
hdmi_cec:
devices:
TV: 0.0.0.0
Pi Zero: 1.0.0.0
Fire TV Stick: 2.1.0.0
Chromecast: 2.2.0.0
Another Device: 2.3.0.0
BlueRay player: 3.0.0.0
```
or port mapping tree:
```yaml
hdmi_cec:
devices:
@ -89,17 +107,50 @@ hdmi_cec:
3: BlueRay player
```
Choose just one schema. Mixing both approaches is not possible.
Another option you can use in config is `platform` which specifying of default platform of HDMI devices. "switch" and "media_player" are supported. Switch is default.
```yaml
hdmi_cec:
platform: media_player
```
Then you set individual platform for devices in customizations:
```yaml
homeassistant:
customize:
hdmi_cec.hdmi_5:
platform: media_player
```
And the last option is `host`. PyCEC supports bridging CEC commands over TCP. When you start pyCEC on machine with HDMI port (`python -m pycec`), you can then run homeassistant on another machine and connect to CEC over TCP. Specify TCP address of pyCEC server:
```yaml
hdmi_cec:
host: 192.168.1.3
```
## {% linkable_title Services %}
### {% linkable_title Select Device %}
Call the `hdmi_cec/select_device` service with the name of the device to select, for example:
Call the `hdmi_cec/select_device` service with the name of the device from config or entity_id or physical address"to select it, for example:
```json
{
"device": "Chromecast"
}
{"device": "Chromecast"}
```
```json
{"device": "switch.hdmi_3"}
```
```json
{"device": "1.1.0.0"}
```
So an Automation action using the example above would look something like this.
```yaml
@ -117,6 +168,59 @@ Call the `hdmi_cec/power_on` service (no arguments) to power on any devices that
Call the `hdmi_cec/standby` service (no arguments) to place in standby any devices that support this function.
### {% linkable_title Change volume level %}
Call the `hdmi_cec/volume` service with one of following commands:
#### {% linkable_title Volume up %}
Increase volume three times:
```json
{"up": 3}
```
Keep increasing volume until release is called:
```json
{"up": "press"}
```
Stop increasing volume:
```json
{"up": "release"}
```
#### {% linkable_title Volume down %}
Decrease volume three times:
```json
{"down": 3}
```
Keep decreasing volume until release is called:
```json
{"down": "press"}
```
Stop decreasing volume:
```json
{"down": "release"}
```
#### {% linkable_title Volume mute %}
Toggle mute:
```json
{"mute": ""}
```
value is ignores.
## {% linkable_title Useful References %}
* [CEC overview](http://wiki.kwikwai.com/index.php?title=The_HDMI-CEC_bus)

23
source/_components/image_processing.markdown
View File

@ -10,7 +10,7 @@ footer: true
ha_release: 0.36
---
Image processing enables Home Assistant to process image from [cameras](/components/#camera). Only camera entities are supported as sources.
Image processing enables Home Assistant to process images from [cameras][/components/#camera]. Only camera entities are supported as sources.
For interval control, use `scan_interval` in platform.
@ -34,3 +34,24 @@ automation:
```
The following event attributes will be present: `entity_id`, `plate`, `confidence`
## {% linkable_title Face identify %}
Face entities attribute have a face counter `total_faces` and all validated person as `known_faces`.
This event is trigger after Microsoft Face identify found a known faces.
```yaml
# Example configuration.yaml automation entry
automation:
- alias: Known person in front of my door
trigger:
platform: event
event_type: identify_face
event_data:
entity_id: image_processing.door
name: 'Hans Maier'
...
```
The following event attributes will be present: `entity_id`, `name`, `confidence`

38
source/_components/image_processing.microsoft_face_identify.markdown Normal file
View File

@ -0,0 +1,38 @@
---
layout: page
title: "Microsoft Face identify"
description: "Instructions how to integrate microsoft face identify into Home Assistant."
date: 2017-01-25 00:00
sidebar: true
comments: false
sharing: true
footer: true
logo: microsoft.png
ha_category: Image_Processing
featured: false
ha_release: 0.37
---
The `microsoft_face_identify` image processing platform lets you use [Microsoft Face identify](https://www.microsoft.com/cognitive-services/en-us/) API through Home Assistant.
Please refer to the [component](/components/microsoft_face/) configuration on how to setup the API key.
For using the result inside an automation rule, take a look at the [component](/components/image_processing/) page.
### {% linkable_title Configuration Home Assistant %}
```yaml
# Example configuration.yaml entry
image_processing:
- platform: microsoft_face_identify
group: family
source:
- entity_id: camera.door
```
Configuration variables:
- **group** (*Required*): Micrsoft face group to detect person from it.
- **confidence** (*Optional*): The minimum of confidence in percent to process with Home Assistant. Defaults to 80.
- **source** array (*Required*): List of image sources.
- **entity_id** (*Required*): A camera entity id to get picture from.
- **name** (*Optional*): This parameter allows you to override the name of your `image_processing` entity.

4
source/_components/image_processing.openalpr_cloud.markdown
View File

@ -15,6 +15,8 @@ ha_release: 0.36
[OpenALPR](http://www.openalpr.com/) integration for Home Assistant allows you to process licences plates from a camera. You can use them to open a garage door or trigger any other [automation](https://home-assistant.io/components/automation/).
For using the result inside an automation rule, take a look at the [component](/components/image_processing/) page.
### {% linkable_title Configuration Home Assistant %}
```yaml
@ -30,7 +32,7 @@ Configuration variables:
- **region** (*Required*): Country or region. List of supported [values](https://github.com/openalpr/openalpr/tree/master/runtime_data/config).
- **api_key** (*Required*): You need an API key from [OpenALPR Cloud](https://cloud.openalpr.com/).
- **confidence** (*Optional*): The minimum of confidence in percent to process with Home Assistant. Defaults to 80.
- **confidence** (*Optional*): The minimum of confidence in percent to process with Home Assistant. Defaults to 80.
- **source** array (*Required*): List of image sources.
- **entity_id** (*Required*): A list of devices to add in Home Assistant.
- **name** (*Optional*): This parameter allows you to override the name of your OpenALPR entity.

4
source/_components/image_processing.openalpr_local.markdown
View File

@ -15,6 +15,8 @@ ha_release: 0.36
[OpenALPR](http://www.openalpr.com/) integration for Home Assistant allows you to process licences plates from a camera. You can use them to open a garage door or trigger any other [automation](https://home-assistant.io/components/automation/).
For using inside automation look on [component](/components/image_processing) page.
### {% linkable_title Local installation %}
If you want process all data locally, you need version 2.3.1 or higher of the `alpr` commandline tool.
@ -39,7 +41,7 @@ $ wget -O- -q http://plates.openalpr.com/h786poj.jpg | alpr -
```yaml
# Example configuration.yaml entry
image_processing:
- platform: openalpr_cloud
- platform: openalpr_local
region: eu
source:
- entity_id: camera.garage

2
source/_components/input_boolean.markdown
View File

@ -51,7 +51,7 @@ automation:
message: "Honey, I'm home!"
```
You can also set or change the status of an `input_boolean` by using `input_boolean.turn_on` and `input_boolean.turn_off` in your automations.
You can also set or change the status of an `input_boolean` by using `input_boolean.turn_on`, `input_boolean.turn_off` or `input_boolean.toggle` in your automations.
```yaml
- service: input_boolean.turn_on

75
source/_components/keyboard_remote.markdown
View File

@ -1,6 +1,6 @@
---
layout: page
title: "Keyboard"
title: "Keyboard Remote"
description: "Instructions how to use a keyboard to remote control Home Assistant."
date: 2016-09-28 14:39
sidebar: true
@ -23,14 +23,35 @@ The `evdev` package is used to interface with the keyboard and thus this is Linu
```yaml
# Example configuration.yaml entry
keyboard_remote:
device_descriptor: '/dev/input/by-id/foo'
type: 'key_up'
```
Configuration variables:
- **device_descriptor** (*Required*): List of URLS for your feeds.
- **type** (*Required*): Possible values are `key_up`, `key_down`, and `key_hold`. Be careful, `key_hold` will fire a lot of events.
- **device_descriptor** (*Optional*): Path to the local event input device file that corresponds to the keyboard.
- **device_name** (*Optional*): Name of the keyboard device.
Either `device_name` or `device_descriptor` must be present in the configuration entry. Indicating a device name is useful in case of repeating disconnections and re-connections of the device (for example, a bluetooth keyboard): the local input device file might change, thus breaking the configuration, while the name remains the same.
In case of presence of multiple devices of the same model, `device_descriptor` must be used.
A list of possible device descriptors and names is reported in the debug log at startup when the device indicated in the configuration entry could not be found.
A full configuration for Keyboard Remote could look like the one below:
```yaml
keyboard_remote:
device_descriptor: '/dev/input/by-id/bluetooth-keyboard'
type: 'key_up'
```
or like the following:
```yaml
keyboard_remote:
device_name: 'Bluetooth Keyboard'
type: 'key_down'
```
And an automation rule to breathe life into it:
@ -46,3 +67,51 @@ automation:
service: light.turn_on
entity_id: light.all
```
## {% linkable_title Disconnections %}
This component manages disconnections and re-connections of the keyboard, for example in the case of a bluetooth device that turns off automatically to preserve battery.
If the keyboard disconnects, the component will fire an event `keyboard_remote_disconnected`.
When the keyboard reconnects, an event `keyboard_remote_connected` will be fired.
Here's an automation example that plays a sound through a media player whenever the keyboard connects/disconnects:
```yaml
automation:
- alias: Keyboard Connected
trigger:
platform: event
event_type: keyboard_remote_connected
action:
- service: media_player.play_media
data:
entity_id: media_player.speaker
media_content_id: keyboard_connected.wav
media_content_type: music
- alias: Keyboard Disconnected
trigger:
platform: event
event_type: keyboard_remote_disconnected
action:
- service: media_player.play_media
data:
entity_id: media_player.speaker
media_content_id: keyboard_disconnected.wav
media_content_type: music
```
## {% linkable_title Permissions %}
There might be permissions problems with the event input device file. If this is the case, the user that hass runs as must be allowed read and write permissions with:
```
sudo setfacl -m u:HASS_USER:rw /dev/input/event*
```
where `HASS_USER` is the user hass runs as.
If you want to make this permanent, you can use a udev rule that sets it for all event input devices. Add a file `/etc/udev/rules.d/99-userdev-input.rules` containing:
```
KERNEL=="event*", SUBSYSTEM=="input", RUN+="/usr/bin/setfacl -m u:HASS_USER:rw $env{DEVNAME}"
```
You can check ACLs permissions with
```
getfacl /dev/input/event*
```

39
source/_components/light.avion.markdown Normal file
View File

@ -0,0 +1,39 @@
---
layout: page
title: "Avion"
description: "Instructions on how to setup GE Avion Bluetooth dimmers within Home Assistant."
date: 2017-01-17 23:17
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Light
ha_iot_class: "Assumed State"
featured: false
ha_release: 0.37
---
Support for the Avion Bluetooth dimmer switch [Avi-On](http://avi-on.com/). To enable these lights, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
light:
- platform: avion
devices:
00:21:4D:00:00:01:
name: Light 1
api_key: Gr35a/rt3RgaRenl9ag8Ba==
00:21:3D:20:00:a1:
name: Bulb 2
api_key: Gr35a/rt3RgaRenl9ag8Ba==
```
Configuration variables:
- **devices**: A list of devices with their bluetooth address, a custom name to use in the frontend and the API key. The API key can be obtained by executing the following command:
```
curl -X POST -H "Content-Type: application/json" -d '{"email": "fakename@example.com", "password": "password"}' https://admin.avi-on.com/api/sessions | jq
```
with the email and password fields replaced with those used when registering the device via the mobile app. The passphrase field of the output should be used as the API key in the configuration.

36
source/_components/light.decora.markdown Normal file
View File

@ -0,0 +1,36 @@
---
layout: page
title: "Decora"
description: "Instructions on how to setup Leviton Decora Bluetooth dimmers within Home Assistant."
date: 2017-01-18 22:45
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Light
ha_iot_class: "Local Polling"
logo: leviton.png
ha_release: 0.37
---
Support for the Decora Bluetooth dimmer switch [Leviton](http://www.leviton.com/OA_HTML/SectionDisplay.jsp?section=76697&minisite=10251).
The API key can be obtained by downloading [this git repository](https://github.com/mjg59/python-decora) and running the `read_key.py` script with the Bluetooth address of the switch as the first argument. Hold the switch in the off position until the green status LED starts flashing before running the script. The output is the API key.
To enable these lights, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
light:
- platform: decora
devices:
00:21:4D:00:00:01:
api_key: 0x12345678
```
Configuration variables:
- **devices** array (*Required*): A list of lights to use.
- **[mac address]** (*Required*): The bluetooth address of the switch.
- **name** (*Optional*): The custom name to use in the frontend.
- **api_key** (*Required*): The API key to acces the device.

24
source/_components/light.piglow.markdown Normal file
View File

@ -0,0 +1,24 @@
---
layout: page
title: "Piglow"
description: "Instructions how to setup Piglow LED's within Home Assistant."
date: 2017-01-13 18:00
sidebar: true
comments: false
sharing: true
footer: true
logo: raspberry-pi.png
ha_category: Light
ha_release: 0.37
---
The `piglow` platform lets you control the [Piglow](https://shop.pimoroni.com/products/piglow) lights on your Raspberry Pi from within Home Assistant.
To add piglow to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
light:
platform: piglow
```

15
source/_components/light.wink.markdown
View File

@ -14,4 +14,17 @@ ha_category: Light
The wink light platform allows you to use your [Wink](http://www.wink.com/) lights.
The requirement is that you have setup your [Wink hub](/components/wink/).
The requirement is that you have setup [Wink](/components/wink/).
### Supported light devices
- Z-wave switches with dimming
- Hue
- Lightify
- GE link
<p class='note'>
The above devices are confimed to work, but others may work as well.
</p>

9
source/_components/lock.wink.markdown
View File

@ -15,5 +15,12 @@ ha_release: 0.9
The Wink lock platform allows you to control your [Wink](http://www.wink.com/) locks.
The requirement is that you have setup your [Wink hub](/components/wink/).
The requirement is that you have setup [Wink](/components/wink/).
### Supported lock devices
- Kwikset
- Schlage
- Generic Z-wave

8
source/_components/lock.zwave.markdown
View File

@ -13,3 +13,11 @@ ha_release: 0.19
---
To get your Z-Wave locks working with Home Assistant, follow the instructions for the general [Z-Wave component](/components/zwave/).
Z-Wave locks will expose three services under the lock domain to manage usercodes if the lock supports it:
| Service | Description |
| ------- | ----------- |
| clear_usercode | Clears a usercode at code_slot X. Valid code_slots are 1-254, but max is defined by the lock. |
| get_usercode | Get a usercode from the lock at code_slot. Valid code_slots are 1-254, but max is defined by the lock. |
| set_usercode | Sets usercode to X at code_slot Y. Valid usercodes are at least 4 digits, and max defined by the lock. |

55
source/_components/media_player.anthemav.markdown Normal file
View File

@ -0,0 +1,55 @@
---
layout: page
title: "Anthem A/V Receivers"
description: "Instructions how to integrate Anthem A/V Receivers into Home Assistant."
date: 2016-12-31 23:11
sidebar: true
comments: false
sharing: true
footer: true
logo: anthemav.png
ha_category: Media Player
ha_iot_class: "Local Push"
ha_release: 0.37
---
Both [Anthem]'s current and last generation of A/V Receivers and and Processors support IP-based, network control. This Home Assistant platform adds proper "local push" support for any of these receivers on your network.
## {% linkable_title Supported Models %}
* MRX 520, MRX 720, MRX 1120, and AVM 60
* MRX 310, MRX 510, MRX 710
Support is provided through the Python [anthemav] module. Older, RS-232 serial-based units like the D2v use a different protocol entirely and are not currently supported.
[Anthem]: http://www.anthemav.com/
[anthemav]: https://github.com/nugget/python-anthemav
To use your Anthem A/V Receiver in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
media_player:
- platform: anthemav
host: IP_ADDRESS
```
Configuration variables:
- **host** (*Required*): The host name or the IP address of the device.
- **port** (*Optional*): The port number. Defaults to 14999.
- **name** (*Optional*): The name of the device used in the frontend.
## Notes and Limitations
- The tuner is currently unsupported as are the `media_player` play, pays, prev, and next controls.
- Enabling this platform will set and enforce "Standby IP Control On" in your Anthem device. You almost certainly want this. If you disable it on the device, it will just get re-enabled by Home Assistant.
- Only Zone 1 is currently supported.
<p class='note warning'>
This platform will maintain a persistent connection to the network control port which will prevent any other application from communicating with the receiver. This includes the Anthem iOS and Android remote control apps as well as the ARC-2 Anthem Room Calibration software. You will need to disable this platform and restart Home Assistant if you want to use another
application that makes use of the network control port.
<br /><br />
*The underlying Python module has hooks for halting and resuming the network connection but those functions are currently unsupported by the Home Assistant platform.*
</p>

1
source/_components/media_player.kodi.markdown
View File

@ -31,6 +31,7 @@ Configuration variables:
- **host** (*Required*): The host name or address of the device that is running XBMC/Kodi
- **port** (*Optional*): The http port number. Defaults to 8080.
- **name** (*Optional*): The name of the device used in the frontend.
- **ssl** (*Optional*): Connect to kodi with HTTPS. Defaults to false
- **username** (*Optional*): The XBMC/Kodi HTTP username.
- **password** (*Optional*): The XBMC/Kodi HTTP password.
- **turn_off_action** (*Optional*): The desired turn off action. Options are `none`, `quit`, `hibernate`, `suspend`, `reboot`, or `shutdown`. Default `none`.

10
source/_components/media_player.sonos.markdown
View File

@ -24,6 +24,7 @@ media_player:
- platform: sonos
```
If you have multiple network devices, you can provide the IP address of the device that should be used for Sonos auto-discovery.
```yaml
@ -61,6 +62,7 @@ Take a snapshot of what is currently playing on one or more speakers. This servi
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of strings that point at `entity_id`s of coordinator speakers.
| `with_group` | yes | Should be also snapshot the group state of the speaker.
### {% linkable_title Service `sonos_restore` %}
@ -69,14 +71,16 @@ Restore a previously taken snapshot of one or more speakers. If no `entity_id` i
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of strings that point at `entity_id`s of coordinator speakers.
| `with_group` | yes | Should be also restore the group state of the speaker. Only if was snapshot with group.
### {% linkable_title Service `sonos_group_players` %}
### {% linkable_title Service `sonos_join` %}
Group all players together under a single coordinator.
Do group players together under a single coordinator. That will make a new group or join to exists group.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of a single `entity_id` that will become the coordinator speaker.
| `master` | no | A single `entity_id` that will become/hold the coordinator speaker.
| `entity_id` | no | String or list of a single `entity_id` that will group to master speaker.
### {% linkable_title Service `sonos_unjoin` %}

84
source/_components/microsoft_face.markdown Normal file
View File

@ -0,0 +1,84 @@
---
layout: page
title: "Microsoft Face"
description: "Instructions how to integrate Microsoft Face component into Home Assistant."
date: 2017-01-25 00:00
sidebar: true
comments: false
sharing: true
footer: true
logo: microsoft.png
ha_category: Hub
ha_release: "0.37"
---
The `microsoft_face` component platform is the main component for Microsoft Azure Cognitive service [Face](https://www.microsoft.com/cognitive-services/en-us/face-api). All data are in a own private instance in the Azure cloud.
You need an API key which is free but requires a [Azure registration](https://azure.microsoft.com/de-de/free/) with your microsoft ID. The free resource (*F0*) is limit to 30k requests in a month and 20 per minute. If you don't want use a the Azure cloud, you can also get a API key with registration on [cognitive-services](https://www.microsoft.com/cognitive-services/en-us/subscriptions) but they need to recreate all 90 days.
To enable the Microsoft Face component, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
microsoft_face:
api_key: YOUR_API_KEY
```
Configuration variables:
- **api_key** (*Required*): The API key for your Cognitive resource.
- **timeout** (*Optional)*: Set timeout for the API connection. Defaults to 10s.
### {% linkable_title Person and Groups %}
For most of the services you need to set up a group or a person. This limits the processing and detection to elements provided by group. Home Assistent creates for all group a entity and allow you to show the state, person and IDs directly on the frontend.
For managing this feature, you have the following services. They can be called with the Frontend, a script, or the REST API.
- *microsoft_face.create_group*
- *microsoft_face.delete_group*
```yaml
service: microsoft_face.create_group
data:
name: 'Family'
```
- *microsoft_face.create_person*
- *microsoft_face.delete_person*
```yaml
service: microsoft_face.create_person
data:
group: family
name: 'Hans Maier'
```
You need to add an image of a person. You can add multiple images for every person to make the detection better. You can take a picture from a camera or send a local image to your Azure resource.
- *microsoft_face.face_person*
```yaml
service: microsoft_face.face_person
data:
group: family
name: 'Hans Maier'
camera_entity: camera.door
```
For the local image we need `curl`. The person ID is present in group entity as attribute.
```bash
$ curl -v -X POST "https://westus.api.cognitive.microsoft.com/face/v1.0/persongroups/{GroupName}/persons/{personId}/persistedFaces" \
-H "Ocp-Apim-Subscription-Key: YOUR_API_KEY" \
-H "Content-Type: application/octet-stream" --data "@/tmp/image.jpg"
```
After we done with changes on a group, we need train this group to make our AI fit to handle the new data.
- *microsoft_face.train_group*
```yaml
service: microsoft_face.train_group
data:
group: family

4
source/_components/nest.markdown
View File

@ -12,7 +12,7 @@ ha_category: Hub
featured: true
---
The Nest component is the main component to integrate all [Nest](https://nest.com/) related platforms. To connect Nest, you will have to [sign up for a developer account](https://developers.nest.com/products) and get a client_id and client_secret.
The Nest component is the main component to integrate all [Nest](https://nest.com/) related platforms. To connect Nest, you will have to [sign up for a developer account](https://developers.nest.com/products) and get a `client_id` and `client_secret`.
### {% linkable_title Setting up developer account %}
@ -54,6 +54,6 @@ nest:
Configuration variables:
- **client_id** (*Required*): Your Nest developer client id.
- **client_id** (*Required*): Your Nest developer client ID.
- **client_secret** (*Required*): Your Nest developer client secret.
- **structure** (*Optional*): The structure or structures you would like to include devices from. If not specified, this will include all structures in your Nest account.

66
source/_components/notify.discord.markdown Normal file
View File

@ -0,0 +1,66 @@
---
layout: page
title: "Discord"
description: "Instructions how to add Discord notifications to Home Assistant."
date: 2016-01-14 15:15
sidebar: true
comments: false
sharing: true
footer: true
logo: discord.png
ha_category: Notifications
---
The [Discord service](https://discordapp.com/) is a platform for the notify component. This allows components to send messages to the user using Discord.
In order to get a token you need to go to the [Discord My Apps page](https://discordapp.com/developers/applications/me) and create a new application. Once the application is ready, create a bot user. Retreive the client ID and the (hidden) token of your bot for later.
When setting up the application you can use this [icon](https://home-assistant.io/demo/favicon-192x192.png).
### {% linkable_title Configuration %}
To use Discord notifications, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
notify:
- name: NOTIFIER_NAME
platform: discord
token: A1aB2b.C3cD4d-E5eF6f
```
Configuration variables:
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
- **token** (*Required*): Your bot's token.
### {% linkable_title Using the bot %}
Bots can only send messages to servers. To add the bot to a server you are an admin on, use the Discord OAuth2 Authorization page:
[https://discordapp.com/api/oauth2/authorize?client_id=1234567890&scope=bot&permissions=0](https://discordapp.com/api/oauth2/authorize?client_id=1234567890&scope=bot&permissions=0)
Replace the client ID with the appropriate one from the [Discord My Apps page](https://discordapp.com/developers/applications/me).
Once the bot user has been added to your server, get the channel ID of the channel you want the bot to operate in.
* In The Discord app go to Settings > Appearance > Check developer mode
* Right click channel name > Copy ID
This channel ID has to be used as the target when calling the notification service. Multiple channel IDs can be specified, across multiple servers.
#### {% linkable_title Example service payload %}
```json
{
"message": "A message from Home Assistant",
"target": [
"1234567890",
"0987654321"
]
}
```
### {% linkable_title Notes %}
For more information about creating and authorizing bots, visit the [OAuth2 information page](https://discordapp.com/developers/docs/topics/oauth2)
To use notifications effectively, please see the [getting started with automation page](/getting-started/automation/).

1
source/_components/notify.twitter.markdown
View File

@ -37,5 +37,6 @@ Configuration variables:
- **consumer_secret** (*Required*): Your "Consumer Secret" (API Secret) for the application.
- **access_token** (*Required*): Your "Access Token" for the application.
- **access_token_secret** (*Required*): Your "Access Token Secret" for the application.
- **username** (*Optional*): Twitter handle without `@` or with `@` and quoting for direct messaging.
To use notifications, please see the [getting started with automation page](/getting-started/automation/).

6
source/_components/openalpr.markdown
View File

@ -8,12 +8,16 @@ comments: false
sharing: true
footer: true
logo: openalpr.png
ha_category: Automation
ha_category: Deprecated
featured: false
ha_release: 0.29
ha_iot_class: "Local Push"
---
<p class='note warning'>
**This platform has been deprecated in favor of the "[OpenALPR image processing](/components/image_processing.openalpr_local/)" platform and will be removed in the future. Please use the "OpenALPR image processing" platform.**
</p>
[OpenALPR](http://www.openalpr.com/) integration for Home Assistant allows you to process licences plates recorded with a camera. You can use them to open a garage door or trigger any other [automation](https://home-assistant.io/components/automation/).
<p class='note'>

45
source/_components/sensor.amcrest.markdown Normal file
View File

@ -0,0 +1,45 @@
---
layout: page
title: "Amcrest IP Camera"
description: "Instructions how to integrate Amcrest IP cameras sensors within Home Assistant."
date: 2017-01-13 10:00
sidebar: true
comments: false
sharing: true
footer: true
logo: amcrest.png
ha_category: Sensor
ha_release: 0.37
---
The `amcrest` sensor allows you to integrate your [Amcrest](https://amcrest.com/) IP camera in Home Assistant.
To enable the `amcrest` sensors on your camera, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: amcrest
host: IP_ADDRESS
username: USERNAME
password: PASSWORD
monitored_conditions:
- motion_detector
- sdcard
- ptz_preset
```
Configuration variables:
- **host** (*Required*): The IP address or hostname of your camera. If using hostname, make sure the DNS works as expected.
- **username** (*Required*): The username for accessing your camera.
- **password** (*Required*): The password for accessing your camera.
- **name** (*Optional*): This parameter allows you to override the name of your camera. The default is "Amcrest Camera".
- **port** (*Optional*): The port that the camera is running on. The default is 80.
- **scan_interval** (*Optional*): Defines the update interval of the sensor in seconds. The default is 10 seconds.
- **monitored_conditions** array (*Required*): Conditions to display in the frontend. The following conditions can be monitored.
- **motion_detector**: Return True/False when a motion is detected
- **sdcard**: Return the SD card usage by reporting the total and used space
- **ptz_preset**: Return the number of PTZ preset positions configured for the given camera
To check if your Amcrest camera is supported/tested, visit the [supportability matrix](https://github.com/tchellomello/python-amcrest#supportability-matrix) link from the `python-amcrest` project.

18
source/_components/sensor.arest.markdown
View File

@ -10,6 +10,7 @@ footer: true
logo: arest.png
ha_category: Sensor
ha_iot_class: "Local Polling"
ha_release: pre 0.7
---
@ -19,8 +20,9 @@ To use your aREST enabled device in your installation, add the following to your
```yaml
# Example configuration.yaml entry
sensor:
- platform: arest
resource: http://10.100.0.117
resource: http://IP_ADDRESS
monitored_variables:
temperature:
name: temperature
@ -34,13 +36,15 @@ Configuration variables:
- **resource** (*Required*): IP address and schema of the device that is exposing an aREST API, e.g. http://192.168.1.10.
- **name** (*Optional*): Let you overwrite the the name of the device. By default *name* from the device is used.
- **monitored_variables** array (*Optional*): List of exposed variables.
- **name** (*Required*): The name of the variable you wish to monitor.
- **unit_of_measurement** (*Optional*): Defines the units of measurement of the sensor, if any.
- **value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the payload.
- **[variable]** (*Required*): Name of the variable to monitor.
- **name** (*Optional*): The name to use for the frontend.
- **unit_of_measurement** (*Optional*): Defines the units of measurement of the sensor, if any.
- **value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the payload.
- **pins** array (*Optional*): List of pins to monitor. Analog pins need a leading **A** for the pin number.
- **name** (*Optional*): The name of the variable you wish to monitor.
- **unit_of_measurement** (*Optional*): Defines the unit of measurement of the sensor, if any.
- **value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the payload.
- **[pin]** (*Required*): Pin number to use.
- **name** (*Required*): The name of the variable you wish to monitor.
- **unit_of_measurement** (*Optional*): Defines the unit of measurement of the sensor, if any.
- **value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the payload.
The variables in the `monitored_variables` array must be available in the response of the device. As a starting point you could use the one of the example sketches (eg. [Ethernet](https://raw.githubusercontent.com/marcoschwartz/aREST/master/examples/Ethernet/Ethernet.ino) for an Arduino with Ethernet shield). In those sketches are two variables (`temperature` and `humidity`) available which will act as endpoints.

41
source/_components/sensor.dsmr.markdown
View File

@ -33,10 +33,15 @@ This component is known to work for:
- Kaifa E0026
- Kamstrup 382JxC (DSMR 2.2)
And USB serial converters:
,USB serial converters:
- Cheap (Banggood/ebay) Generic PL2303
- https://sites.google.com/site/nta8130p1smartmeter/webshop
- https://www.sossolutions.nl/slimme-meter-kabel
And Serial to network proxies:
- ser2net - http://ser2net.sourceforge.net/
```yaml
# Example configuration.yaml entry
@ -46,13 +51,14 @@ sensor:
Configuration variables:
- **port** string (*Optional*): Serial port to which Smartmeter is connected (default: /dev/ttyUSB0).
- **dsmr_version_** string (*Optional*): Version of DSMR used by meter, choices: 2.2, 4 (default: 2.2).
- **port** string (*Optional*): Serial port to which Smartmeter is connected (default: /dev/ttyUSB0 (connected to USB port)). For remote (i.e. ser2net) connections, use TCP port number to connect to (i.e. 2001).
- **host** string (*Optional*): Host to which Smartmeter is connected (default: '' (connected via serial or USB, see **port**)). For remote connections, use IP address of host to connect to (i.e. 192.168.1.13).
- **dsmr_version** string (*Optional*): Version of DSMR used by meter, choices: 2.2, 4 (default: 2.2).
A full configuration example can be found below:
Full configuration examples can be found below:
```yaml
# Example configuration.yaml entry
# Example configuration.yaml entry for USB/serial connected Smartmeter
sensor:
- platform: dsmr
port: /dev/ttyUSB1
@ -69,6 +75,31 @@ group:
- sensor.gas_consumption
```
```yaml
# Example configuration.yaml entry for remote (TCP/IP, i.e. via ser2net) connection to host which is connected to Smartmeter
sensor:
- platform: dsmr
host: 192.168.1.13
port: 2001
dsmr_version: 4
group:
meter_readings:
name: Meter readings
entities:
- sensor.power_consumption_low
- sensor.power_consumption_normal
- sensor.power_production_low
- sensor.power_production_normal
- sensor.gas_consumption
```
Optional configuration example for ser2net:
```sh
# Example /etc/ser2net.conf for proxying USB/serial connections to DSMRv4 smart meters
2001:raw:600:/dev/ttyUSB0:115200 NONE 1STOPBIT 8DATABITS XONXOFF LOCAL -RTSCTS
```
[HASSbian](/getting-started/installation-raspberry-pi-image/) users have to give dialout permission to the user `homeassistant`:
```

10
source/_components/sensor.iss.markdown
View File

@ -7,11 +7,15 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: bbox.png
ha_category: Sensor
logo: nasa.png
ha_category: Deprecated
ha_release: 0.36
---
<p class='note warning'>
**This platform has been deprecated in favor of the "[ISS](/components/binary_sensor.iss/)" platform and will be removed in the future. Please use the "iss" binary sensor platform.**
</p>
The `iss` platform uses the [Open Notify API](http://open-notify.org/Open-Notify-API/ISS-Location-Now/) to let you know if the station is above your home location. This means that ISS is 10° above the horizon of your home.
You can check in the attributes of the sensor how many minutes you have to wait until the next rise of the station and the number of people in space.
@ -22,5 +26,3 @@ To add ISS sensor to your installation, add the following to your `configuration
sensor:
- platform: iss
```

14
source/_components/sensor.nest.markdown
View File

@ -16,21 +16,20 @@ ha_release: pre 0.7
The `nest` sensor platform lets you monitor sensors connected to your [Nest](https://nest.com) devices.
<p class='note'>
You must have the [Nest component](/components/nest/) configured to use these sensors. The `nest` binary sensor will automatically be setup when you do.
You must have the [Nest component](/components/nest/) configured to use these sensors. The sensors will be setup if the `nest` component is configured and the required configuration for the `nest sensor` is set.
</p>
To customize which sensors are enabled, you can add the following to your `configuration.yaml` file:
To enable sensors and customize which sensors are setup, you can extend the [Nest component](/components/nest/) configuration in your `configuration.yaml` file with the following settings:
```yaml
# Example configuration.yaml entry
sensor:
- platform: nest
nest:
sensors:
monitored_conditions:
- 'temperature'
- 'target'
```
If you leave `monitored_conditions` blank, all sensors that are available for your devices will be included.
By default all sensors for your available Nest devices will be monitored. Leave `monitored_conditions` blank to disable all sensors for the [Nest component](/components/nest/).
Configuration variables:
@ -46,6 +45,7 @@ The following conditions are available by device:
- hvac\_state: The currently active state of the HVAC system, `heating`, `cooling`, or `off`.
- Nest Protect:
- co\_status
- smoke\_status
- smoke\_status
- batter\_health
- Nest Camera: none

33
source/_components/sensor.skybeacon.markdown Normal file
View File

@ -0,0 +1,33 @@
---
layout: page
title: "Skybeacon sensor"
description: "Instructions on how to integrate MiFlora BLE plant sensor with Home Assistant."
date: 2017-01-17 10:00
sidebar: true
comments: false
sharing: true
footer: true
ha_category: DIY
ha_release: 0.37
ha_iot_class: "Local Polling"
---
The `skybeacon` sensor platform supports [CR2477](http://cnsky9.en.alibaba.com)-powered [iBeacon](https://en.wikipedia.org/wiki/IBeacon)/eddystone sensors that come with temperature/sensor module.
To use your Skybeacon sensor in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: skybeacon
mac: "xx:xx:xx:xx:xx:xx"
monitored_conditions:
- temperature
- humidity
```
- **mac** (*Required*): The MAC address of your sensor. You can find this be running `hcitool lescan` from command line.
- **monitored_conditions** array (*Required*): The paramaters that should be monitored.
- **temperature**: Temperature at the sensor's location.
- **humidity**: Humidity at the sensor's location.

19
source/_components/sensor.usps.markdown
View File

@ -27,7 +27,22 @@ sensor:
Configuration options for the USPS Sensor:
- **username** (*Required*): The username to access the USPS service.
- **username** (*Required*): The username to access the MyUSPS service.
- **password** (*Required*): The password for the given username.
- **update_interval** (*Optional*): Interval in minutes for the updates.
- **name** (*Optional*): Name the sensor (default: your mailing address).
- **update_inverval** (*Optional*): Minimum time interval between updates. Default is 1 hour. Supported formats:
- `update_interval: 'HH:MM:SS'`
- `update_interval: 'HH:MM'`
- Time period dictionary, e.g.:
<pre>update_interval:
# At least one of these must be specified:
days: 0
hours: 0
minutes: 3
seconds: 30
milliseconds: 0
</pre>
<p class='note warning'>
The USPS sensor logs into the MyUSPS website to scrape package data. It does not use an API.
</p>

16
source/_components/sensor.wink.markdown
View File

@ -14,5 +14,19 @@ ha_category: Sensor
The Wink sensor platform allows you to get data from your [Wink](http://www.wink.com/) sensors.
The requirement is that you have setup your [Wink hub](/components/wink/).
The requirement is that you have setup [Wink](/components/wink/).
### Supported sensor devices
- Wink Relay temperature, proximity, and humidity
- Wink Spotter temperature, humidity, and brightness (No Wink hub required)
- Wink Porkfolio balance (No Wink hub required)
- Wink eggminder (No Wink hub required)
- Nest protect Smoke and CO severity (No confirmation that this is actually reported) (No Wink hub required)
- Motion sensor temperature
<p class='note'>
The above devices are confimed to work, but others may work as well.
</p>

81
source/_components/sensor.wsdot.markdown Normal file
View File

@ -0,0 +1,81 @@
---
layout: page
title: "Washington State DOT"
description: "Instructions on how to integrate WSDOT data into your home."
date: 2017-01-21 18:00
sidebar: true
comments: false
sharing: true
footer: true
logo: wsdot.png
ha_category: Transport
ha_iot_class: "Cloud Polling"
ha_release: 0.37
---
The `wsdot` sensor will give you travel time information from the [Washington State Department of Transportation (WSDOT)](http://wsdot.com/).
First, you need to get a free Traveler Information `api_key` from the [WSDOT API webpage](http://wsdot.com/traffic/api/). Just enter your email address to instantly get the key.
Once you have the code, create `wsdot` sensors by editing your `configuration.yaml` file as follows:
```yaml
# Example configuration.yaml entry
sensor:
- platform: wsdot
api_key: XXXXXXXXXXXXXXXXXXXXXXX
travel_time:
- id: 95
name: I-90 Eastbound HOV
```
Configuration variables:
- **api_key** (*Required*): Your `api_key` from WSDOT.
- **scan_interval** (*Optional*): How frequently to query for new data. Default: 3 minutes.
- **travel_time** array (*Required*): List of routes.
- **id** (*Required*): Name of the route.
- **name** (*Optional*): Name of the route. Default just uses `id`.
Figuring out which Travel Time ID (`id`) is associated with your routes is a bit of a challenge. If you visit `http://wsdot.com/Traffic/api/TravelTimes/TravelTimesREST.svc/GetTravelTimesAsJson?AccessCode=[your_api_key_here]` substituting your `api_key`, you will get a list of all available routes. Search through it and then find the key `TravelTimeID`. That tells you the number you need.
Some common examples include:
```
73 Issaquah-Seattle (WB PM)
74 Seattle-Issaquah (EB AM)
75 HOV Issaquah-Seattle (WB REV)
76 Issaquah-Seattle (WB REV)
77 HOV Redmond-Seattle (WB PM)
78 HOV Seattle-Redmond (EB AM)
79 Redmond-Seattle (WB PM)
80 Seattle-Redmond (EB AM)
81 HOV Redmond-Seattle via I-90 (WB PM)
82 HOV Seattle-Redmond via I-90 (EB AM)
83 Redmond-Seattle via I-90 (WB PM)
84 Seattle-Redmond via I-90 (EB AM)
85 HOV Redmond-Seattle via I-90 (WB REV)
86 Redmond-Seattle via I-90 (WB REV)
89 Bellevue-Seattle via 520 (WB PM)
90 HOV Bellevue-Seattle via 520 (WB PM)
91 HOV Seattle-Bellevue via 520 (EB AM)
92 Seattle-Bellevue via 520 (EB AM)
93 Bellevue-Seattle via I-90 (WB PM)
94 HOV Bellevue-Seattle via I-90 (WB PM)
95 HOV Seattle-Bellevue via I-90 (EB AM)
96 Seattle-Bellevue via I-90 (EB AM)
97 Bellevue-Seattle via I-90 (WB REV)
98 HOV Bellevue-Seattle via I-90 (WB REV)
```
<p class='note info'>
WSDOT does provide information about ferry schedules, mountain passes, tolls, etc. but so far only Travel Time data is available in this platform.
</p>
Here's an example of the sensor in use:
<p class='img'>
<img src='{{site_root}}/images/screenshots/wsdot_sensor.png' />
</p>

40
source/_components/sensor.zabbix.markdown Normal file
View File

@ -0,0 +1,40 @@
---
layout: page
title: "Zabbix Sensor"
description: "Instructions how to integrate Zabbix Triggers sensors within Home Assistant."
date: 2016-12-13 22:57
sidebar: true
comments: false
sharing: true
footer: true
logo: zabbix.png
ha_category: System Monitor
ha_release: 0.37
ha_iot_class: "Local Polling"
---
The `zabbix` sensor platform let you monitor the current count of active triggers for your [Zabbix](http://www.zabbix.com/) monitoring instance.
<p class='note'>
You must have the [Zabbix component](/components/zabbix/) configured to use those sensors.
</p>
To set it up, add the following information to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: zabbix
triggers:
name: Important Hosts Trigger Count
hostids: [10051,10081,10084]
individual: true
```
Configuration variables:
- **triggers** array(*Required*): Specifies that this sensor is for Zabbix 'triggers'. In the future there will be other Zabbix sensors.
- **name** (*Optional*): Allows you to specify the name for the Sensor, otherwise the host name, as stored in Zabbix, is used. This is useful when you are specifying a list of hostids to monitor as a single count.
- **hostids** (*Optional*): This is a list of Zabbis hostids that we want to filter our count on.
- **individual** (*Optional*): A 'true'/'false' to specify whether we should show individual sensors when a list of hostsids is provided. If false, the sensor state will be the count of all triggers for the specified hosts (or all hosts within the Zabbix instance, if hostids isn't provided).

40
source/_components/sensor.zamg.markdown
View File

@ -17,23 +17,29 @@ The `zamg` platform uses meteorological details published by the Austrian weathe
The following stations are available:
| `station_id` | Location |
| :----------- |:-----------------|
| 11010 | Linz/Hörsching |
| 11012 | Kremsmünster |
| 11022 | Retz |
| 11035 | Wien/Hohe Warte |
| 11036 | Wien/Schwechat |
| 11101 | Bregenz |
| 11121 | Innsbruck |
| 11126 | Patscherkofel |
| 11130 | Kufstein |
| 11150 | Salzburg |
| 11155 | Feuerkogel |
| 11157 | Aigen im Ennstal |
| 11171 | Mariazell |
| 11190 | Eisenstadt |
| 11204 | Lienz |
| `station_id` | Location |
| :----------- |:---------------------|
| 11010 | Linz/Hörsching |
| 11012 | Kremsmünster |
| 11022 | Retz |
| 11035 | Wien/Hohe Warte |
| 11036 | Wien/Schwechat |
| 11101 | Bregenz |
| 11121 | Innsbruck |
| 11126 | Patscherkofel |
| 11130 | Kufstein |
| 11150 | Salzburg |
| 11155 | Feuerkogel |
| 11157 | Aigen im Ennstal |
| 11171 | Mariazell |
| 11190 | Eisenstadt |
| 11204 | Lienz |
| 11240 | Graz/Flughafen |
| 11244 | Bad Gleichenberg |
| 11265 | Villacher Alpe |
| 11331 | Klagenfurt/Flughafen |
| 11343 | Sonnblick |
| 11389 | St. Pölten |
To add ZAMG to your installation, add the following to your `configuration.yaml` file:

8
source/_components/switch.arest.markdown
View File

@ -25,8 +25,6 @@ switch:
pins:
11:
name: Fan
12:
name: Light Desk
```
If you want to use custom functions, then add the following to your `configuration.yaml` file:
@ -39,8 +37,6 @@ switch:
name: Office
functions:
function1:
name:
function2:
name: Light Desk
```
@ -48,12 +44,12 @@ Configuration variables:
- **resource** (*Required*): IP address and schema of the device that is exposing an aREST API, eg. http://192.168.1.10 (no-trailing slash)
- **name** (*Optional*): Let you overwrite the the name of the device. By default *name* from the device is used.
- **pins** array (*Required*): An array with all used pins.
- **pins** array (*Optional*): An array with all used pins.
- **name** (*Required*): The name of the pin to use in the frontend.
or
- **functions** array (*Required*): An array with all used functions.
- **functions** array (*Optional*): An array with all used functions.
- **name** (*Required*): The name to use in the frontend.
You can still switch your pins with a web browser or a command line tool. Use the URL http://192.168.1.10/digital/8/1 to set pin 8 to high/on, the JSON response will give you the feedback.

11
source/_components/switch.wink.markdown
View File

@ -14,5 +14,14 @@ ha_category: Switch
The Wink switch platform allows you to control your [Wink](http://www.wink.com/) switches.
The requirement is that you have setup your [Wink hub](/components/wink/).
The requirement is that you have setup [Wink](/components/wink/).
### Supported switch devices
- Wink Pivot power genius (No Wink hub required)
- non-dimming Z-wave in wall switches (dimming switches show up as lights)
- Wink Relay load controlling switches
- Rachio sprinkler controller (No Wink hub required)
- iHome smart plug (No Wink hub required)

36
source/_components/tts.amazon_polly.markdown Normal file
View File

@ -0,0 +1,36 @@
---
layout: page
title: "Amazon Polly"
description: "Instructions how to setup Amazon Polly with Home Assistant."
date: 2017-01-28 09:00
sidebar: true
comments: false
sharing: true
footer: true
logo: polly.png
ha_category: Text-to-speech
ha_release: 0.37
---
The `amazon_polly` text-to-speech platform that works with [Amazon Polly](https://aws.amazon.com/polly/) to create the spoken output.
To enable text-to-speech with Amazon Polly, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
tts:
- platform: amazon_polly
aws_access_key_id: AWS_ACCESS_KEY_ID
aws_secret_access_key: AWS_SECRET_ACCESS_KEY
profile_name: AWS_PROFILE
region_name: 'us-east-1'
```
Configuration variables:
- **aws_access_key_id** (*Required if aws_secret_access_key is provided*): Your AWS Access Key ID. For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html). If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name`.
- **aws_secret_access_key** (*Required if aws_access_key_id is provided*): Your AWS Secret Access Key. For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html). If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`.
- **profile_name** (*Optional*): A credentials profile name. For more information, please see the [boto3 documentation section about credentials](http://boto3.readthedocs.io/en/latest/guide/configuration.html#shared-credentials-file).
- **region_name** (*Required*): The region identifier to connect to. The default is `us-east-1`.
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.

4
source/_components/tts.markdown
View File

@ -47,6 +47,8 @@ If you are running Home Assistant over SSL or from within a container, you will
## {% linkable_title Service say %}
The `say` service support `language` and on some platforms also `options` for set i.e. *voice, motion, speed, etc*. The text for speech is set with `message`.
Say to all `media_player` device entities:
```yaml
@ -79,7 +81,7 @@ With a template:
```yaml
service: tts.google_say
data_template:
message: 'Temperature is {% raw %}{{ sensor.temperature }}{% endraw %}.'
message: "Temperature is {% raw %}{{states('sensor.temperature')}}{% endraw %}."
cache: false
```

13
source/_components/tts.yandextts.markdown
View File

@ -2,7 +2,7 @@
layout: page
title: "Yandex TTS"
description: "Instructions how to setup Yandex SpeechKit TTS with Home Assistant."
date: 2017-01-05 03:04
date: 2017-01-17 03:04
sidebar: true
comments: false
sharing: true
@ -26,10 +26,11 @@ tts:
Configuration variables:
- **api_key** (*Requered*): API Key for use this service.
- **language** (*Optional*): The language to use. Defaults to `en-us`. Supported en-EN, ru-RU, uk-UK, tr-TR
- **codec** (*Optional*): Audo codec. Default is 'mp3'. Supported us mp3, wav, opus.
- **voice** (*Optional*): Speaker voice. Default is 'zahar'. Supported female voices are jane, oksana, alyss, omazh and male voices are zahar and ermil
- **language** (*Optional*): The language to use. Defaults to `en-us`. Supported `en-EN`, `ru-RU`, `uk-UK`, `tr-TR`.
- **codec** (*Optional*): Audo codec. Default is `mp3`. Supported us `mp3`, `wav`, `opus`.
- **voice** (*Optional*): Speaker voice. Default is `zahar`. Supported female voices are `jane`, `oksana`, `alyss`, 'omazh` and male voices are `zahar` and `ermil`.
- **emotion** (*Optional*): Speaker emotional intonation. Default is `neutral`. Also supported are `good` (freindly) and `evil` (angry)
- **speed** (*Optional*): Speech speed. Default value is `1`. Highest speed is `3` and lowest `0,1`
See on api [documentation](https://tech.yandex.com/speechkit/cloud/doc/dg/concepts/speechkit-dg-tts-docpage/) for details. N.B. english version of documentation is outdated. So you could receive api key [here](https://developer.tech.yandex.ru/)
@ -43,4 +44,6 @@ tts:
language: 'ru-RU'
codec: mp3
voice: oksana
emotion: evil
speed: 2
```

37
source/_components/wink.markdown
View File

@ -18,20 +18,40 @@ featured: true
Wink offers one, quick and simple way to connect people with the products they rely on every day in their home.
</blockquote>
Home Assistant integrates the Wink hub and allows you to get the status and control connected switches, lights, locks, and sensors.
Home Assistant integrates with the Wink API and allows you to get the status and control connected switches, lights, locks, fan, climate devices, covers, and sensors.
To get started with the Wink API, you will first need to get yourself an API access token. Because it is very difficult right now to get access to their API, John McLaughlin has created the form below to get you one.
Check the related componets pages for actual devices that are support.
Home Assistant offers multiple ways to authenticate to the Wink API. Each authentication method is described below.
### Authentication with an access token.
To use this form of authentication obtain a token from the form below and insert it into your `configuration.yaml`
<iframe src="https://winkbearertoken.appspot.com"
style='width: 100%; height: 200px; border: 0; margin: 0 auto 15px; border-left: 2px solid #049cdb; padding-left: 15px;'></iframe>
After you have gotten your access token, add the following to your `configuration.yaml`:
```yaml
wink:
access_token: YOUR_ACCESS_TOKEN
```
### Authentication with your Wink email and password.
This method uses the same form from above to obtain an access token, but does so without the user needing to manually do so.
This method pulls a new token on every startup of Home Assistant.
```yaml
wink:
email: YOUR_WINK_EMAIL_ADDRESS
password: YOUR_WINK_PASSWORD
```
### Full oath authentication. (This is the best option!)
You can also request API access via Wink's [contact us](http://www.wink.com/help/contact/) page.
You will be provided with a client ID and a client secret via email. These can then be used in your configuration in place of the access_token this will prevent you from having to manually refresh your access token.
@ -44,13 +64,6 @@ wink:
client_secret: YOUR_WINK_CLIENT_SECRET
```
The following can also be provided to allow access to the Wink Relay sensors. This value could change at any time.
```yaml
wink:
user_agent: Manufacturer/Home-Assistant WinkAndroid/4
```
Configuration variables:
- **access_token** (*Required if the below aren't present.*): The retrieved access token.
@ -60,7 +73,7 @@ Configuration variables:
- **client_secret** (*Required if access token isn't provided*): Your provided Wink client_secret.
- **user_agent** (*Optional*): The user-agent passed in the API calls to Wink.
This will connect to the Wink hub and automatically set up any lights, switches and sensors that it finds.
This will connect to the Wink API and automatically set up any switches, lights, locks, fans, climate devices, covers, and sensors.
<p class='note'>
The Wink hub can only be accessed via the cloud. This means it requires an active internet connection and you will experience delays when controlling and updating devices (~3s).

44
source/_components/zabbix.markdown Normal file
View File

@ -0,0 +1,44 @@
---
layout: page
title: "Zabbix"
description: "Instructions how to integrate Zabbix into Home Assistant."
date: 2016-12-13 22:57
sidebar: true
comments: false
sharing: true
footer: true
logo: zabbix.png
ha_category: System Monitor
featured: false
ha_release: 0.37
---
The `zabbix` component is the main component to connect to a [Zabbix](http://www.zabbix.com/) monitoring instance via the Zabbix API.
To set the Zabbix component up, add the following information to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
zabbix:
host: 192.168.0.100
```
Configuration variables:
- **host** (*Required*): Your Zabbix server.
- **path** (*Optional*): Path to your Zabbix install. Defaults to `/zabbix/`.
- **ssl** (*Optional*): Set to `True` if your Zabbix installation is using SSL. Default to `False`.
- **username** (*Optional*): Your Zabbix username.
- **password** (*Optional*): Your Zabbix password.
### {% linkable_title Full configuration %}
```yaml
# Example configuration.yaml entry
zoneminder:
host: ZABBIX_HOST
path: ZABBIX_PATH
ssl: False
username: USERNAME
password: PASSWORD
```

2
source/_ecosystem/ios/notifications/requesting_location_updates.markdown
View File

@ -23,7 +23,7 @@ automation
action:
service: notify.iOSApp
data:
message: "request_location_updates"
message: "request_location_update"
```
Assuming the device receives the notification, it will attempt to get a location update within 5 seconds and report it to Home Assistant. This is a little bit hit or miss since Apple imposes a maximum time allowed for the app to work with the notification and location updates sometimes take longer than usual due to factors such as waiting for GPS acquisition.

2
source/_posts/2017-01-14-iss-usps-images-packages.markdown
View File

@ -71,6 +71,7 @@ The new [image processing component][image] currently works with [number plates]
- Media player - SqueezeBox: Switch to JSON-RPC ([@dasos])
- Scripts: Support for `last_triggered` ([@Danielhiversen])
- Media player: Support for `SUPPORT_PLAY` flag ([@armills])
- Docker: `ffmpeg` is now included by default ([@colinodell])
- Minor and not so minor features and bug fixes by [@balloob], [@pvizeli], [@fabaff], [@mezz64], [@andrey-git], [@aequitas], [@abmantis], [@turbokongen], [@jabesq], [@michaelarnauts], [@kellerza], [@titilambert], [@btorresgil], [@henworth], [@armills], [@mjg59], [@Giannie], [@n8henrie], [@magicus], [@florianholzapfel], [@MrMep], [@bah2830], [@happyleavesaoc], [@lwis], [@glance-], [@markferry], and [@nikdoof].
### {% linkable_title Release 0.36.1 - January 17 %}
@ -114,6 +115,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
[@balloob]: https://github.com/balloob
[@brandonweeks]: https://github.com/brandonweeks
[@btorresgil]: https://github.com/btorresgil
[@colinodell]: https://github.com/colinodell
[@Danielhiversen]: https://github.com/Danielhiversen
[@danieljkemp]: https://github.com/danieljkemp
[@danielperna84]: https://github.com/danielperna84

242
source/_posts/2017-01-28-face-coffee-wink.markdown Normal file
View File

@ -0,0 +1,242 @@
---
layout: post
title: "0.37: Face, Coffee, Wink"
description: "Governance, Face recognition, improved camera security, and a coffee maker"
date: 2017-01-28 08:04:05 +0000
date_formatted: "January 28, 2017"
author: Fabian Affolter et al.
author_twitter: fabaff
comments: true
categories: Release-Notes
og_image: /images/blog/2016-01-0.37/social.png
---
No stats, no numbers, and alike this time. Ok, just one number: 0.37. We are back on track with our bi-weekly release cycle. Beside some organizational changes is this release shipping again cool features and new integrations. Please keep an eye on the "Breaking changes" section because there are also massive improvements for some platforms and components.
### {% linkable_title Governance %}
As announced, the new [Governance][gov] requires for developers to sign the CLA. [Code of Conduct][coc], [Contributor License Agreement][cla], and proper [Licensing][license] will to protect all involved parties in the Home Assistant eco-system from users and community members to contributors.
### Face recognition using the Microsoft Face API %}
[@pvizeli] has been on a roll with the image processing integrations. This time it's the [Microsoft Face API][face]. This means that now it will be possible to train the API with the people you want to recognize and send images from your camera to the API as another source of automation.
Want to play a personalized tune when someone enters the house? It is now possible 😎
### {% linkable_title Improved camera security %}
After a security audit by Stephen O'Conner, he found that our source for randomly generated access tokens for camera feeds were reasonable predictable and could be brute force attacked in 2.5 weeks. A fix has been included in this release that uses the system provided random number generator for maximum randomness and rotates the keys every 10 minutes to reduce the window in which a brute force attack can happen.
Although the old method is not insecure, the new method is a lot more secure. Upgrading to the latest version is encouraged.
### {% linkable_title Major Wink and HDMI CEC improvements %}
[@w1ll1am23] did an amazing job fixing a ton of bugs and issues with the Wink integration. Biggest improvement is that it now is able to automatically refresh the authentication tokens. This means that if you have your email address and password in your `configuration.yaml` file, no `client_id` and `client_secret` are needed, and token which was generated with the generator located in the [Wink][wink] documentation.
The new Wink support will cause renaming of all the binary sensors and will also create new sensors for devices that weren't previously detected or supported in the older version.
Thanks to [@konikvranik] the [HDMI CEC][cec] integration got a huge update with a lot of improvements. This update should make it easier to work with HDMI CEC and give you more control.
### {% linkable_title First Coffee Maker supported %}
[@stu-gott] has added support for the first coffee maker in Home Assistant: [Mr. Coffee Smart Optimal Brew][coffee]. Happy brewing!
### {% linkable_title All changes %}
#### {% linkable_title New platforms/components %}
Netatmo: [Netatmo][netatmo] Presence support ([@gieljnssns])
Sensor: [Amcrest][amcrest] camera sensors ([@tchellomello])
Notify: New [Discord][discord] notification component ([@Deinara])
Device tracker: [Tado][tado] device tracker support ([@jmvermeulen])
Sensor: Add [Skybeacon][skybeacon] BLE temperature/humidity sensor ([@anpetrov])
New [Zabbix][zabbix] component ([@Whytey])
Media player: New platform [Anthemav][anthem] Media player ([@nugget])
Light: Add support for [Avion][avion] Bluetooth dimmer switches ([@mjg59])
Binary sensor: [Beaglebone Black][bb-bin] binary sensor ([@MatoKafkac])
Light: [Piglow][piglow] support ([@xarnze])
[Face][face] recognition for automation ([@pvizeli])
Sensor: New [Washington State DOT][wsdot] sensor ([@partofthething])
Support for Wemo CoffeeMaker devices ([@stu-gott])
Device tracker: [Sky hub][sky] support ([@alexmogavero])
Support for [Lutron][lutron] RadioRA 2 ([@thecynic])
TTS: Amazon [Polly TTS][polly] platform ([@robbiet480])
Device tracker: Support for [Linksys][linksys] Access Points ([@lukas-hetzenecker])
Notify: Make calls with [Twilio][twilio] ([@fakezeta])
#### Improvements %}
Script: Fix script release ([@balloob])
Camera - Amcrest: Add support for direct MJPEG streams from Amcrest cameras ([@colinodell])
Sensor - Miflora: Removing throttle decorator ([@freol35241])
Notify - Lannouncer: Fix `get_service` method ([@mKeRix])
Sensor - WAQI: Add station parameter to waqi sensor ([@whhsw])
Sensor - USPS: Absolute path to save cookie used by USPS sensor ([@tchellomello])
Nest: Fix python-nest release number ([@Danielhiversen])
Keyboard remote: Improve support ([@MrMep])
Device tracker - VolvoOnCall: Fix timedelta ([@pvizeli])
Climate - eq3btsmart: Expose away attribute ([@rytilahti])
Remote: Reserve a test port for broken API to fix race ([@armills])
Climate - Ecobee: Made target temperature sensitive to auto mode ([@Duoxilian])
Configuration: Fix load_yaml default value ([@balloob])
Notify - Facebook: Fix encoding error ([@Danielhiversen])
Emulated_hue: Add `upnp_bind_multicast` option, default type to Google, and persist emulated hue IDs ([@hoopty], [@balloob])
Docker: Install phantomjs in Docker container ([@jnewland])
Media player - MPD: Add listing and selection of available MPD playlists ([@partofthething])
Media player - Denon AVR: Denon improvements ([@glance-])
Light - x10.py: Improved x10 state monitoring ([@martst])
Sensor - DSMR: TCP, reconnecting and V4 CRC support ([@aequitas])
Media player - Yamaha.py: Fix Yamaha doing I/O in event loop ([@balloob])
Device tracker UPC: Make upc more robust ([@pvizeli])
Climate - Generic thermostat: Update ([@MrMep])
Device tracker - Xiaomi.py: Xiaomi Mi Router token refresh ([@RiRomain])
Camera - MJPEG: Support still image for thumbmail ([@pvizeli])
Sensor - ZAMG: Updated valid station id list ([@HerrHofrat])
Light - ISY994: Not overwrite `state_attributes` ([@rmkraus])[emul-hue]
Light - Zwave: Use only supported features for devices ([@turbokongen])
Media player - Kodi: Support for volume stepping ([@armills])
Media player- roku: Use `is_screensaver`, update IDLE state, and use device name ([@robbiet480], [@xhostplus])
Switch - HDMI CEC: Support for devices and commands ([@konikvranik])
Lock - Zwave: Improvements to Zwave lock platform ([@turbokongen])
TTS: Invalidate broken file cache entries ([@stu-gott])
Light - Hue: Improvements ([@robbiet480])
TTS - YandexTTS: Added speed and emotion to Yandex TTS ([@lupin-de-mid])
Light - tellstick.py: Tellstick light fix ([@stefan-jonasson])
Switch - insteon_local.py: only check for devices when not defined in config ([@wardcraigj])
Notify - Twitter: Allow direct messaging to user ([@fabaff])
Fan - MQTT: Dont set a speed when fan turns on ([@robbiet480])
Config: Allow easier customization of whole domain, entity lists, globs ([@andrey-git])
Sensor - Homematic: Update device support ([@danielperna84])
Binary sensor - ISS: Add location to attributes and option to show position on the map ([@fabaff])
Media player - Kodi: Add SSL configuration option ([@ecksun])
Sensor - WAQI: Add missing particle value ([@fabaff])
Wink: Support for python-wink 1.0.0 ([@w1ll1am23])
Binary sensor - RPi GPIO: Add a small sleep before reading the sensor ([@snagytx])
Sensor - USPS: Add name to configuration ([@happyleavesaoc])
Sensor - Miflora: Remove throttle decorator from miflora platform ([@freol35241])
Device tracker - asuswrt.py: Add IPv6 support when parsing neighbors ([@leppa])
iOS: Discover notify.ios when iOS component loads ([@robbiet480])
Homematic: Add MAX shutter contact class ([@jannau])
Sensor - Darksky: Added forecast support ([@nordlead2005])
Switch - Pilight: Implement echo config option ([@janLo])
Core: Support customize in packages ([@kellerza])
Switch - Flux: Allow disabling setting the brightness ([@rytilahti])
Media player - Sonos: Add `is_coordinator`, set coordinator after join/unjoin, and no emtpy image ([@pvizeli], [@andrey-git], [@robbiet480])
Climate: Hold mode ([@Duoxilian])
Switch - TPlink: No longer doing I/O in event bus ([@balloob])
Light - Insteon local: Improve Insteon configuration ([@wardcraigj])
Emulated Hue: Emulated Hue "host-ip" fails to bind when running in docker without `--net=host` ([@jeremydk])
Climate - EQ3 BT smart: Add reporting for availability ([@rytilahti])
Bugfix: [@balloob], [@fabaff], [@freol35241], [@pvizeli], [@Danielhiversen], [@tdickman], [@armills], [@rytilahti], [@R1chardTM], [@asbach], [@happyleavesaoc], [@robbiet480], [@colinodell], [@joopert], [@dale3h], [@pavoni], [@jaharkes], [@MartinHjelmare], [@mezz64], [@jabesq], and you if you are missing in this list.
### {% linkable_title Breaking changes %}
- A **major** breaking change in the [`emulated_hue`][emul-hue] component means that without changing a configuration value before starting up the newer Home Assistant version you will lose all devices that Alexa has discovered and will need to re-add them as well as create new groups. Find out about the [details](emul_hue).
- The platform of the [ISS][iss] integration was change to `binary_sensor`. Please check the platform documentation.
- The [Roku][roku] media uses now a new format for the entity IDs.
- [OpenALPR][openalpr] is no longer a component. It's now a platform for [Image processing][image].
- Due to massive improvements of the [Wink][wink] integration, the names of your binary sensors will change and new devices can show up.
- The [MySensors][mysensors] component now requires all persistence file paths to be set if any is set by the user. This is to avoid name conflicts for the paths. If no path is set Home Assistant will set all paths for you.
- The [Sonos][sonos] service `sonos_group_players` was removed. Use now `sonos_join` for this function.
- TTS cache have change for the last time. Files use now also a option hash as part of the name. If you want to use the cache, it need to be renamed or cleared, new created. E. g. `HASH_LANG_PLATFORM.xxx` -> `HASH_LANG_OPTIONS_PLATFORM.xxx`, replace *OPTIONS* with `-` on exiting platforms.
### {% linkable_title If you need help... %}
...don't hesitate to use our [Forum](https://community.home-assistant.io/) or join us for a little [chat](https://gitter.im/home-assistant/home-assistant). The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks.
### {% linkable_title Reporting Issues %}
Experiencing issues introduced by this release? Please report them in our [issue tracker](https://github.com/home-assistant/home-assistant/issues). Make sure to fill in all fields of the issue template.
[@MrMep]: https://github.com/MrMep
[@joopert]: https://github.com/joopert
[@armills]: https://github.com/armills
[@janLo]: https://github.com/janLo
[@happyleavesaoc]: https://github.com/happyleavesaoc
[@danielperna84]: https://github.com/danielperna84
[@lukas-hetzenecker]: https://github.com/lukas-hetzenecker
[@robbiet480]: https://github.com/robbiet480
[@mjg59]: https://github.com/mjg59
[@turbokongen]: https://github.com/turbokongen
[@whhsw]: https://github.com/whhsw
[@jabesq]: https://github.com/jabesq
[@asbach]: https://github.com/asbach
[@stefan-jonasson]: https://github.com/stefan-jonasson
[@fabaff]: https://github.com/fabaff
[@RiRomain]: https://github.com/RiRomain
[@freol35241]: https://github.com/freol35241
[@jmvermeulen]: https://github.com/jmvermeulen
[@thecynic]: https://github.com/thecynic
[@aequitas]: https://github.com/aequitas
[@balloob]: https://github.com/balloob
[@konikvranik]: https://github.com/konikvranik
[@jeremydk]: https://github.com/jeremydk
[@alexmogavero]: https://github.com/alexmogavero
[@Duoxilian]: https://github.com/Duoxilian
[@nugget]: https://github.com/nugget
[@mezz64]: https://github.com/mezz64
[@pavoni]: https://github.com/pavoni
[@MartinHjelmare]: https://github.com/MartinHjelmare
[@R1chardTM]: https://github.com/R1chardTM
[@andrey-git]: https://github.com/andrey-git
[@kellerza]: https://github.com/kellerza
[@dale3h]: https://github.com/dale3h
[@Deinara]: https://github.com/Deinara
[@jaharkes]: https://github.com/jaharkes
[@tchellomello]: https://github.com/tchellomello
[@jannau]: https://github.com/jannau
[@glance-]: https://github.com/glance-
[@w1ll1am23]: https://github.com/w1ll1am23
[@ecksun]: https://github.com/ecksun
[@nordlead2005]: https://github.com/nordlead2005
[@rytilahti]: https://github.com/rytilahti
[@rmkraus]: https://github.com/rmkraus
[@pvizeli]: https://github.com/pvizeli
[@anpetrov]: https://github.com/anpetrov
[@partofthething]: https://github.com/partofthething
[@wardcraigj]: https://github.com/wardcraigj
[@Danielhiversen]: https://github.com/Danielhiversen
[@colinodell]: https://github.com/colinodell
[@hoopty]: https://github.com/hoopty
[@martst]: https://github.com/martst
[@Whytey]: https://github.com/Whytey
[@MatoKafkac]: https://github.com/MatoKafkac
[@stu-gott]: https://github.com/stu-gott
[@jnewland]: https://github.com/jnewland
[@tdickman]: https://github.com/tdickman
[@xarnze]: https://github.com/xarnze
[@snagytx]: https://github.com/snagytx
[@gieljnssns]: https://github.com/gieljnssns
[@leppa]: https://github.com/leppa
[@lupin-de-mid]: https://github.com/lupin-de-mid
[@HerrHofrat]: https://github.com/HerrHofrat
[@xhostplus]: https://github.com/xhostplus
[@mKeRix]: https://github.com/mKeRix
[@fakezeta]: https://github.com/fakezeta
[amcrest]: https://home-assistant.io/components/binary_sensor.arest/
[discord]: https://home-assistant.io/components/notify.discord/
[tado]: https://home-assistant.io/components/device_tracker.tado/
[sky]: https://home-assistant.io/components/device_tracker.sky_hub/
[zabbix]: https://home-assistant.io/components/zabbix/
[avion]: https://home-assistant.io/components/light.avion/
[anthem]: https://home-assistant.io/components/media_player.anthemav/
[bb-bin]: https://home-assistant.io/components/binary_sensor.bbb_gpio/
[piglow]: https://home-assistant.io/components/light.piglow/
[wsdot]: https://home-assistant.io/components/sensor.wsdot/
[skybeacon]: https://home-assistant.io/components/sensor.skybeacon/
[lutron]: https://home-assistant.io/components/lutron/
[polly]: https://home-assistant.io/components/tts.amazon_polly/
[linksys]: https://home-assistant.io/components/device_tracker.linksys_ap/
[emul-hue]: https://home-assistant.io/components/emulated_hue/
[netatmo]: https://home-assistant.io/components/netatmo/
[face]: https://home-assistant.io/components/microsoft_face/
[iss]: https://home-assistant.io/components/binary_sensor.iss/
[roku]: https://home-assistant.io/components/media_player.roku/
[openalpr]: https://home-assistant.io/components/#image-processing
[image]: https://home-assistant.io/components/image_processing/
[emul_hue]: https://github.com/home-assistant/home-assistant/pull/5549
[coc]: https://home-assistant.io/developers/code_of_conduct/
[cla]: https://home-assistant.io/developers/cla/
[gov]: https://home-assistant.io/blog/2017/01/21/home-assistant-governance/
[license]: https://home-assistant.io/developers/license/
[wink]: https://home-assistant.io/components/wink/
[coffee]: https://home-assistant.io/components/switch.wemo/
[cec]: https://home-assistant.io/components/hdmi_cec/
[mysensors]: https://home-assistant.io/components/mysensors/
[sonos]: https://home-assistant.io/components/media_player.sonos/
[twilio]: https://home-assistant.io/components/notify.twilio_call/

44
source/developers/development_environment.markdown
View File

@ -11,14 +11,52 @@ footer: true
You'll need to set up a development environment if you want to develop a new feature or component for Home Assistant. Read on to learn how to set up.
* Visit the [Home Assistant repository](https://github.com/home-assistant/home-assistant) and click **Fork**.
* Consider setting up a virtual environment using [`venv`](https://docs.python.org/3.4/library/venv.html) before running the setup script.
### {% linkable_title Setup Local Repository %}
Visit the [Home Assistant repository](https://github.com/home-assistant/home-assistant) and click **Fork**.
Once forked, setup your local copy of the source using the commands:
```bash
$ git clone https://github.com/YOUR_GIT_USERNAME/home-assistant.git
$ cd home-assistant
$ git remote add upstream https://github.com/home-assistant/home-assistant.git
```
### {% linkable_title Prepare Your Environment %}
#### {% linkable_title Core dependencies %}
Install the core dependencies.
```bash
$ sudo apt-get install python3-pip python3-dev libssl-dev
```
<p class='note'>
Different distributions have different package installation mechanisms and sometimes packages names as well. For example Centos would use: `sudo yum install epel-release && sudo yum install python34 python34-devel mysql-devel`
</p>
Additional dependencies exist if you you plan to perform Frontend Development, please read the [Frontend](https://home-assistant.io/developers/frontend/) section to learn more.
#### {% linkable_title Setting up virtual environment (optional) %}
If you plan on providing isolation to your environment using [`venv`](https://docs.python.org/3.4/library/venv.html). Within the `home-assistant` directory, create and activate your virtual environment.
If using Python < 3.6 `pyvenv` is the recommended method of setting up virtual environments, you'll need to install the `python3-venv` package.
```bash
$ sudo apt-get install python3-venv
$ pyvenv venv
$ source venv/bin/activate
```
If using Python 3.6 `pyvenv` has been deprecated:
```bash
$ python3 -m venv venv
$ source venv/bin/activate
```
### {% linkable_title Setup and Run %}
* On Mac OS X and Linux (remember to activate your virtual environment before running setup, if you are using one):
```bash
$ cd home-assistant
$ script/setup
```

81
source/getting-started/customizing-devices.markdown
View File

@ -11,6 +11,8 @@ footer: true
By default, all of your devices will be visible and have a default icon determined by their domain. You can customize the look and feel of your front page by altering some of these parameters. This can be done by overriding attributes of specific entities.
`customize` consists of a list of attribute customization blocks
```yaml
# Example configuration.yaml entry
homeassistant:
@ -18,6 +20,60 @@ homeassistant:
unit_system: metric
# etc
customize:
# Only the 'entity_id' is required. All other options are optional.
- entity_id: sensor.living_room_motion
hidden: true
- entity_id: thermostat.family_roomfamily_room
entity_picture: https://example.com/images/nest.jpg
friendly_name: Nest
- entity_id: switch.wemo_switch_1
friendly_name: Toaster
entity_picture: /local/toaster.jpg
- entity_id: switch.wemo_switch_2
friendly_name: Kitchen kettle
icon: mdi:kettle
- entity_id: switch.rfxtrx_switch
assumed_state: false
```
### {% linkable_title Possible values %}
| Attribute | Description |
| --------- | ----------- |
| `friendly_name` | Name of the entity
| `hidden` | Set to `true` to hide the entity.
| `entity_picture` | Url to use as picture for entity
| `icon` | Any icon from [MaterialDesignIcons.com](http://MaterialDesignIcons.com). Prefix name with `mdi:`, ie `mdi:home`.
| `assumed_state` | For switches with an assumed state two buttons are shown (turn off, turn on) instead of a switch. By setting `assumed_state` to `false` you will get the default switch icon.
| `sensor_class` | Sets the [class of the sensor](/components/binary_sensor/), changing the device state and icon that is displayed on the UI (see below).
### {% linkable_title Advanced example %}
You can also specify attributes for all devices in a domain, use wildcards, use several entity IDs as a list or comma separated list.
```yaml
homeassistant:
customize:
- entity_id: sensor
icon: mdi:kettle # Give all sensor the kettle icon
- entity_id: light.family*
hidden: true # Hide all lights that have an ID starting with 'family'
- entity_id: switch.wemo_switch_1,switch.wemo_switch_2,switch.wemo_switch_3
entity_picture: /local/toaster.jpg # Set picture on multiple devices
```
Either `entity_id` must be present in each customization block.
### {% linkable_title Older format %}
In the previous version of customize format the keys were the IDs:
```yaml
homeassistant:
name: Home
unit_system: metric
# etc
customize:
# Only the 'entity_id' is required. All other options are optional.
sensor.living_room_motion:
@ -31,24 +87,23 @@ homeassistant:
switch.wemo_switch_2:
friendly_name: Kitchen kettle
icon: mdi:kettle
switch.rfxtrx_switch:
- entity_id: switch.rfxtrx_switch:
assumed_state: false
```
This format doesn't support comma-separated IDs, wildcards or domain matching.
### {% linkable_title Possible values %}
| Attribute | Description |
| --------- | ----------- |
| `friendly_name` | Name of the entity
| `hidden` | Set to `true` to hide the entity.
| `entity_picture` | Url to use as picture for entity
| `icon` | Any icon from [MaterialDesignIcons.com](http://MaterialDesignIcons.com). Prefix name with `mdi:`, ie `mdi:home`.
| `assumed_state` | For switches with an assumed state two buttons are shown (turn off, turn on) instead of a switch. By setting `assumed_state` to `false` you will get the default switch icon.
| `sensor_class` | Sets the [class of the sensor](/components/binary_sensor/), changing the device state and icon that is displayed on the UI (see below).
The formats can't be mixed
```yaml
# NOT A VALID CONFIGURATION
customize:
sensor.living_room_motion:
hidden: true
- entity_id: thermostat.family_roomfamily_room
friendly_name: Nest
```
### {% linkable_title Reloading customize %}
Home Assistant offers a service to reload the core configuration while Home Assistant is running called `homeassistant/reload_core_config`. This allows you to change your customize section and see it being applied without having to restart Home Assistant. To call this service, go to the <img src='/images/screenshots/developer-tool-services-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> service developer tools, select the service `homeassistant/reload_core_config` and click "Call Service".
<p class='note warning'>

3
source/getting-started/installation-raspberry-pi.markdown
View File

@ -26,7 +26,8 @@ There's currently three documented ways to install Home Assistant on a Raspberry
This installation of Home Assistant requires the Raspberry Pi to run [Raspbian Lite](https://www.raspberrypi.org/downloads/raspbian/).
The installation will be installed in a [Virtual Environment](/getting-started/installation-virtualenv) with minimal overhead. Instructions assume this is a new installation of Raspbian Lite.
Connect to the Raspberry Pi over ssh. Default password is `raspberry`.
Connect to the Raspberry Pi over ssh. Default password is `raspberry`.
You will need to enable ssh access. The raspberry pi website has instructions [here](https://www.raspberrypi.org/documentation/remote-access/ssh/).
```bash
$ ssh pi@ipadress
```

1
source/help/index.markdown
View File

@ -29,6 +29,7 @@ Have you found an issue in your Home Assistant installation? Please report it. R
### {% linkable_title Videos, interviews, talks, and alike %}
- [Home Assistant with Paulus Schoutsen – Episode 94](https://www.podcastinit.com/episode-94-home-assistant-with-paulus-schoutsen/) - January 2017
- [Home Assistant - Erweiterungen (Platforms/Components)](https://github.com/home-assistant/home-assistant-assets/tree/master/german/2016-puzzle) at [Puzzle ITC](https://www.puzzle.ch/de/) - December 2016
- [Automating Your Life - Home Automation](http://slides.com/teagan42/life_automation#/) at Develop Denver 2016 - August
- [Building Online Communities: Home Assistant](https://medium.com/@gitter/building-online-communities-home-assistant-8818dff671ad#.och4x4rhx) - July 2016

BIN
source/images/blog/2017-01-0.37/social.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 55 KiB

BIN
source/images/screenshots/wsdot_sensor.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 30 KiB

BIN
source/images/supported_brands/anthemav.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 41 KiB

BIN
source/images/supported_brands/discord.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.0 KiB

BIN
source/images/supported_brands/leviton.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 92 KiB

BIN
source/images/supported_brands/microsoft.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 14 KiB

BIN
source/images/supported_brands/nasa.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 117 KiB

BIN
source/images/supported_brands/polly.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 3.3 KiB

BIN
source/images/supported_brands/sky.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 123 KiB

BIN
source/images/supported_brands/tado.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 8.6 KiB

BIN
source/images/supported_brands/wsdot.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 9.9 KiB

BIN
source/images/supported_brands/zabbix.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.6 KiB