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-22 16:56:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3324 from home-assistant/release-0-53

Browse Source 
0.53
This commit is contained in:
Paulus Schoutsen 2017-09-09 00:50:36 -07:00 committed by GitHub
commit 684c8acebb
68 changed files with 1742 additions and 124 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
.project Normal file
View File

@ -0,0 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
<name>home-assistant.github.io</name>
<comment></comment>
<projects>
</projects>
<buildSpec>
</buildSpec>
<natures>
</natures>
</projectDescription>

8
_config.yml
View File

@ -139,12 +139,12 @@ social:
# Home Assistant release details
current_major_version: 0
current_minor_version: 52
current_patch_version: 1
date_released: 2017-08-28
current_minor_version: 53
current_patch_version: 0
date_released: 2017-09-9
# Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it.
# Major release:
patch_version_notes: "#release-0521---august-28"
patch_version_notes: "#"
# Minor release (Example #release-0431---april-25):

9
source/_components/abode.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: abode.jpg
ha_category: Hub
ha_release: 0.52
ha_iot_class: "Cloud Polling"
ha_iot_class: "Cloud Push"
---
The `abode` component will allow users to integrate their Abode Home Security systems into Home Assistant and use its alarm system and sensors to automate their homes.
@ -19,10 +19,11 @@ Please visit the [Abode website](https://goabode.com/) for further information a
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](/components/binary_sensor.abode/): Reports on `Door Contacts` (open or close) and `Motion Camera` (motion detected or not)
- [Alarm Control Panel](/components/alarm_control_panel.abode/): Reports on current alarm status and can be used to arm/disarm the system
The component currently polls every 30 seconds, so device status may not be immediately reflected in Home Assistant.
- [Binary Sensor](/components/binary_sensor.abode/): Reports on `Door Contacts` (open or closed), `Motion Camera` (motion detected or not), `Water Sensors` (detected or not), `Keypad` (online or not), `Glass Break` (online or not), `Status Display` (online or not)
- [Cover](/components/cover.abode/): Reports on `Secure Barriers` (open or closed) and can be used to open/close the cover
- [Lock](/components/cover.abode/): Reports on `Door Locks` (locked or unlocked) and can be used to lock/unlock the door
- [Switch](/components/switch.abode/): Reports on `Power Switch Sensors` (on or off) and can be used to turn the power switch sensor on/off
An `abode` section must be present in the `configuration.yaml` file and contain the following options as required:

2
source/_components/alarm_control_panel.abode.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: abode.jpg
ha_category: Alarm
ha_release: 0.52
ha_iot_class: "Cloud Polling"
ha_iot_class: "Cloud Push"
---

6
source/_components/binary_sensor.abode.markdown
View File

@ -7,14 +7,14 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: alarmdecoder.png
logo: abode.jpg
ha_release: 0.52
ha_category: Binary Sensor
ha_iot_class: "Cloud Polling"
ha_iot_class: "Cloud Push"
---
The `abode` security control panel platform allows you to control your [Abode](https://goabode.com/) alarms.
This component will automatically add `Door Contact` and `Motion Camera` binary sensors that are configured in your Abode account.
This component will automatically add `Door Contact`, `Motion Camera`, `Water Sensor`, `Keypad`, `Glass Break`, and `Status Display` binary sensors that are configured in your Abode account.
The requirement is that you have setup your [Abode hub](/components/abode/).

80
source/_components/binary_sensor.bayesian.markdown Normal file
View File

@ -0,0 +1,80 @@
---
layout: page
title: "Bayesian Binary Sensor"
description: "Instructions how to integrate threshold Bayesian sensors into Home Assistant."
date: 2017-08-27 20:05
sidebar: true
comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Binary Sensor
ha_iot_class: "Local Polling"
ha_release: 0.53
---
The `bayesian` binary sensor platform observes the state from multiple sensors and uses Bayes' rule to estimate the probability that an event has occurred
given the state of the observed sensors. If the estimated posterior probability is above the `probabiliy_threshold`, the value of the sensor is `on`.
Otherwise, the sensor is `off`.
This allows for the detection of complex events that may not be readily observable, i.e., cooking, showering, in bed, the start of a morning routine, etc. It
can also be used to gain greater confidence about events that _are_ directly observable, but for which the sensors can be unreliable, i.e., presence.
To enable the Bayesian sensor, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: 'bayesian'
prior: 0.1
observations:
- entity_id: 'switch.kitchen_lights'
prob_given_true: 0.6
prob_given_false: 0.2
platform: 'state'
to_state: 'on'
```
Configuration variables:
- **prior** (*Required*): The prior probability of the event. At any point in time (ignoring all external influences) how likely is this event to occur?
- **observations** array (*Required*): The observations which should influence the likelihood that the given event has occurred.
- **entity_id** (*Required*): Name of the entity to monitor.
- **prob_given_true** (*Required*): The probability of the observation occurring, given the event is `true`.
- **prob_given_false** (*Optional*): The probability of the observation occurring, given the event is `false` can be set as well. If `prob_given_false` is not set, it will default to `1 - prob_given_true`.
- **platform** (*Required*): The only supported observation platforms are `state` and `numeric_state`, which are modeled after their corresponding triggers for automations.
- **to_state** (*Required*): THe target start.
- **probability_threshold** (*Optional*): The probability at which the sensor should trigger to `on`.
- **name** (*Optional*): Name of the sensor to use in the frontend. Defaults to `Bayesian Binary`.
## {% linkable_title Full examples %}
```yaml
# Example configuration.yaml entry
binary_sensor:
name: 'in_bed'
platform: 'bayesian'
prior: 0.25
probability_threshold: 0.95
observations:
- entity_id: 'sensor.living_room_motion'
prob_given_true: 0.4
prob_given_false: 0.2
platform: 'state'
to_state: 'off'
- entity_id: 'sensor.basement_motion'
prob_given_true: 0.5
prob_given_false: 0.4
platform: 'state'
to_state: 'off'
- entity_id: 'sensor.bedroom_motion'
prob_given_true: 0.5
platform: 'state'
to_state: 'on'
- entity_id: 'sensor.sun'
prob_given_true: 0.7
platform: 'state'
to_state: 'below_horizon'
```

46
source/_components/binary_sensor.knx.markdown
View File

@ -13,4 +13,48 @@ ha_release: 0.24
ha_iot_class: "Local Polling"
---
To get your KNX binary sensors working with Home Assistant, follow the instructions for the [KNX component](/components/knx/).
The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) binary sensors.
The `knx` component must be configured correctly, see [KNX Component](/components/knx).
```yaml
binary_sensor:
- platform: knx
name: "Entrance.Motion.Sensor"
address: '6/0/2'
device_class: 'motion'
#significant_bit: 2
```
* **name** (*Optional*): A name for this device used within Home Assistant.
* **address**: KNX group address of the binary sensor
* **device_class**: (Optional) HASS device class e.g. "motion"
* **significant_bit**: (Optional) Specify which significant bit of the KNX value should be used. Default is 1.
You can also attach actions to binary sensors (e.g., to switch on a light when a switch was pressed). In this example, one light is switched on when the button was pressed once and two others when the button was pressed a second time.
```yaml
binary_sensor:
- platform: knx
name: Livingroom.3Switch3
address: '5/0/26'
automation:
- counter: 1
hook: 'on'
action:
- entity_id: light.hue_color_lamp_1
service: homeassistant.turn_on
- counter: 2
hook: 'on'
action:
- entity_id: light.hue_bloom_1
service: homeassistant.turn_on
- entity_id: light.hue_bloom_2
service: homeassistant.turn_on
```
- **name** (*Optional*): A name for this device used within Home Assistant.
- **counter**: (*Optional*) Set to 2 if your only want the action to be executed if the button was pressed twice. To 3 for three times button pressed. Defaults to 1.
- **hook**: (Optional): Indicates if the automation should be executed on what state of the binary sensor. Values: "on" or "off". Defaults to "on".
- **action**: Specify a list of actions analog to the [HASS automation rules](https://home-assistant.io/docs/automation/action/).

16
source/_components/binary_sensor.template.markdown
View File

@ -32,6 +32,8 @@ Configuration variables:
- **device_class** (*Optional*): The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend.
- **value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the payload.
- **entity_id** (*Optional*): Add a list of entity IDs so the sensor only reacts to state changes of these entities. This will reduce the number of times the sensor will try to update it's state.
- **on_delay** (*Optional*): The amount of time the template state must be met before this sensor will switch to on.
- **off_delay** (*Optional*): The amount of time the template state must be not met before this sensor will switch to off.
## {% linkable_title Examples %}
@ -97,6 +99,20 @@ binary_sensor:
- sensor.wardrobe_co_status
```
### {% linkable_title Washing Machine Running %}
This example creates a washing machine "load running" sensor by monitoring an energy meter connected to the washer. During the washer's operation, the energy meter will fluctuate wildly, hitting zero frequently even before the load is finished. By utilizing `off_delay`, we can have this sensor only turn off if there has been no washer activity for 5 minutes.
```yaml
# Determine when the washing machine has a load running.
binary_sensor:
- platform: template
name: Washing Machine
value_template: {% raw %}'{{ sensor.washing_machine_power > 0 }}'{% endraw %}
off_delay:
minutes: 5
```
### {% linkable_title Is anyone home? %}
This example is determining if anyone is home based on the combination

20
source/_components/binary_sensor.tesla.markdown Normal file
View File

@ -0,0 +1,20 @@
---
layout: page
title: "Tesla Binary Sensor"
description: "Instructions on how to integrate Tesla binary sensors into Home Assistant."
date: 2017-08-30 12:29
sidebar: true
comments: false
sharing: true
footer: true
logo: tesla.png
ha_category: Binary Sensor
ha_iot_class: "Cloud polling"
ha_release: 0.53
---
The `Tesla` platform allows you to get data from your [Tesla](https://www.tesla.com/) sensors from within Home Assistant.
They will be automatically discovered if the Tesla component is loaded.
For more configuration information see the [Tesla component](/components/tesla/) documentation.

2
source/_components/binary_sensor.xiaomi.markdown
View File

@ -29,13 +29,13 @@ The requirement is that you have setup the [`xiaomi` component](/components/xiao
| Door and Window Sensor (2nd gen) | sensor_magnet.aq2 | MCCGQ11LM | on, off | | | |
| Smoke Detector | smoke | JTYJ-GD-01LM/BW | on, off | | | |
| Gas Leak Detector | natgas | JTQJ-BF-01LM/BW | on, off | | | |
| Water Leak Sensor | sensor_wleak.aq1 | SJCGQ11LM | on, off | | | |
| Button (1st gen) | switch | WXKG01LM | on (thru long_click_press), off | `click` | `click_type` | `long_click_press`, `long_click_release`, `hold`, `single`, `double` |
| Button (2nd gen) | sensor_switch.aq2 | WXKG11LM | off (always) | `click` | `click_type` | `single`, `double` |
| Aqara Wireless Switch (Single) | 86sw1 | WXKG03LM | off (always) | `click` | `click_type` | `single` |
| Aqara Wireless Switch (Double) | 86sw2 | WXKG02LM | off (always) | `click` | `click_type` | `single`, `both` |
| Cube | cube | MFKZQ01LM | off (always) | `cube_action` | `action_type`, `action_value` (rotate) | `flip90`, `flip180`, `move`, `tap_twice`, `shake_air`, `swing`, `alert`, `free_fall`, `rotate` (degrees at action_value) |
### {% linkable_title Automation examples %}
#### {% linkable_title Motion %}

51
source/_components/climate.knx.markdown
View File

@ -1,6 +1,6 @@
---
layout: page
title: "KNX Thermostat"
title: "KNX Climate"
description: "Instructions on how to integrate KXN thermostats with Home Assistant."
date: 2016-06-24 12:00
sidebar: true
@ -16,22 +16,49 @@ ha_iot_class: "Local Polling"
The `knx` climate platform is used as in interface with KNX thermostats.
KNX thermostats use at least 2 group addresses: one for the current temperature and one for the target temperature (named set-point in KNX terms).
The `knx` component must be configured correctly, see [KNX Component](/components/knx).
To use your KNX thermostats in your installation, add the following to your `configuration.yaml` file:
To use your KNX thermostats in your installation, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
climate:
- platform: knx
address : KNX_ADDRESS
temperature_address: 0/1/1
setpoint_address: 0/1/0
name: HASS-Kitchen.Temperature
temperature_address: '6/2/1'
setpoint_address: '5/1/2'
target_temperature_address: '5/1/1'
operation_mode_address: '5/1/3'
```
- **address** (*Required*): The KNX group address that is used to turn on/off this actuator channel.
- **temperature_address** (*Required*): The group address that is used to communicate the current temperature. Data format must be datapoint type 9.001 DPT_Value_Temp (2-Octet float value), check [details](http://www.knx.org/fileadmin/template/documents/downloads_support_menu/KNX_tutor_seminar_page/Advanced_documentation/05_Interworking_E1209.pdf).
- **setpoint_address** (*Required*): The group address that is used to set/read the target temperature. Data format must be datapoint type 9.001 DPT_Value_Temp (2-Octet float value). Make sure, you set the read-flag for the thermostat to allow Home Assistant to read the target temperature.
- **name** (*Optional*): A name for this devices used within Home Assistant.
Alternatively, if your device has dedicated binary group addresses for frost/night/comfort mode:
```yaml
climate:
- platform: knx
name: HASS-Kitchen.Temperature
temperature_address: '6/2/1'
setpoint_address: '5/1/2'
target_temperature_address: '5/1/1'
operation_mode_frost_protection_address: '5/1/3'
operation_mode_night_address: '5/1/4'
operation_mode_comfort_address: '5/1/5'
```
* **name** (*Optional*): A name for this device used within Home Assistant.
* **temperature_address**: KNX group address for reading current room temperature from KNX bus.
* **target_temperature_address**: KNX group address for reading current target temperature from KNX bus.
* **setpoint_address**: KNX group address for basis setpoint
* **operation_mode_address** (*Optional*) KNX address for operation mode (Frost protection/night/comfort).
* **operation_mode_state_address** (*Optional*) Explicit KNX address for reading operation mode
* **controller_status_address** (*Optional*) KNX address for HVAC controller status (in accordance with KNX AN 097/07 rev 3)
* **controller_status_state_address** (*Optional*) Explicit KNX address for reading HVAC controller status
* **operation_mode_frost_protection_address** (*Optional*) KNX address for switching on/off frost/heat protection mode.
* **operation_mode_night_address** (*Optional*) KNX address for switching on/off night nmode.
* **operation_mode_comfort_address** (*Optional*) KNX address for switching on/off comfort mode.
`operation_mode_frost_protection_address` / `operation_mode_night_address` / `operation_mode_comfort_address` are not necessary if `operation_mode_address` was specified.
With the current version of the module, no advanced KNX thermostat functionalities (e.g. HVAC mode) are supported.

20
source/_components/climate.tesla.markdown Normal file
View File

@ -0,0 +1,20 @@
---
layout: page
title: "Tesla HVAC"
description: "Instructions on how to integrate Tesla climate system (HVAC) into Home Assistant."
date: 2017-08-30 12:20
sidebar: true
comments: false
sharing: true
footer: true
logo: tesla.png
ha_category: Climate
ha_iot_class: "Cloud push"
ha_release: 0.53
---
The `Tesla` climate platform allows you to control your [Tesla](https://www.tesla.com/) climate from within Home Assistant.
The climate platform will be automatically configured if Tesla component is configured.
For more configuration information see the [Tesla component](/components/tesla/) documentation.

76
source/_components/counter.markdown Normal file
View File

@ -0,0 +1,76 @@
---
layout: page
title: "Counter"
description: "Instructions how to integrate counters into Home Assistant."
date: 2017-08-26 06:00
sidebar: true
comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Automation
ha_release: 0.53
---
The `counter` component allows one to count occurrences fired by automations.
To add a counter to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
counter:
counter:
initial: 30
step: 1
```
Configuration variables:
- **[alias]** (*Required*): Alias for the slider input. Multiple entries are allowed.
- **name** (*Optional*): Friendly name of the slider input.
- **initial** (*Optional*): Initial value when Home Assistant starts. Defaults to 0.
- **step** (*Optional*): Step value for the slider. Defaults to 1.
- **icon** (*Optional*): Icon for entry.
Pick an icon that you can find on [materialdesignicons.com](https://materialdesignicons.com/) to use for your input and prefix the name with `mdi:`. For example `mdi:car`, `mdi:ambulance`, or `mdi:motorbike`.
## {% linkable_title Services %}
### {% linkable_title Media control services %}
Available services: `increment`, `decrement`, and `reset`.
#### {% linkable_title Service `counter/increment` %}
Increments the counter with 1 or the given value for the steps.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | Name of the entity to take action, e.g., `counter.count0`. |
#### {% linkable_title Service `counter/decrement` %}
Decrements the counter with 1 or the given value for the steps.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | Name of the entity to take action, e.g., `counter.count0`. |
#### {% linkable_title Service `counter/reset` %}
With this service the counter is reset to its initial value.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | Name of the entity to take action, e.g., `counter.count0`. |
### {% linkable_title Use the service %}
Select <img src='/images/screenshots/developer-tool-services-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> **Services** from the **Developer Tools**. Choose **counter** from the list of **Domains**, select the **Service**, enter something like the sample below into the **Service Data** field, and hit **CALL SERVICE**.
```json
{
"entitiy": "counter.count0"
}
```

20
source/_components/cover.abode.markdown Normal file
View File

@ -0,0 +1,20 @@
---
layout: page
title: "Abode Cover"
description: "Instructions how to integrate Abode covers into Home Assistant."
date: 2017-08-26 13:28
sidebar: true
comments: false
sharing: true
footer: true
logo: abode.jpg
ha_release: 0.52
ha_category: Cover
ha_iot_class: "Cloud Push"
---
The `abode` security control panel platform allows you to control your [Abode](https://goabode.com/) alarms.
This component will automatically add `Secure Barriers` configured in your Abode account.
The requirement is that you have setup your [Abode hub](/components/abode/).

32
source/_components/cover.knx.markdown
View File

@ -16,22 +16,32 @@ ha_iot_class: "Local Polling"
The `knx` cover platform is used as in interface with KNX covers.
The `knx` component must be configured correctly, see [KNX Component](/components/knx).
To use your KNX covers in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
cover:
- platform: knx
updown_address: 9/0/0
stop_address: 9/0/1
name: "Kitchen.Shutter"
move_long_address: '3/0/0'
move_short_address: '3/0/1'
position_address: '3/0/3'
position_state_address: '3/0/2'
travelling_time_down: 51
travelling_time_up: 61
```
- **name** (*Optional*): A name for this devices used within Home Assistant.
- **updown_address** (*Required*): The KNX group address that is used to move the cover up and down.
- **stop_address** (*Required*): The group address that is used to stop the cover.
- **setposition_address** (*Optional*): The group address that is used to set the position.
- **getposition_address** (*Optional*): The group address that is used to read the position.
- **setangle_address** (*Optional*): The group address that is used to set the tilt angle.
- **getangle_address** (*Optional*): The group address that is used to read the tilt angle.
- **invert_position** (*Optional*): Set this to true if your actuator report fully closed as 100%
- **invert_angle** (*Optional*): Set this to true if your actuator reports tilt fully closed as 100%
- **name** (*Optional*): A name for this device used within Home Assistant.
- **move_long_address**: KNX group address for moving the cover full up or down.
- **move_short_address**: (*Optional*) KNX group address for moving the cover short time up or down.
- **position_address**: (*Optional*) KNX group address for moving the cover to the dedicated position.
- **position_state_address**: (*Optional*) Separate KNX group address for requesting the current position of the cover.
- **angle_address**: (*Optional*) KNX group address for moving the cover to the dedicated angle.
- **angle_state_address**: (*Optional*) Separate KNX group address for requesting the current angle of cover.
- **travelling_time_down**: (*Optional*) Time cover needs to travel down in seconds. Needed to calculate the intermediate positions of cover while traveling. Defaults to 25.
- **travelling_time_up**: (*Optional*) Time cover needs to travel up in seconds. Needed to calculate the intermediate positions of cover while traveling. Defaults to 25.
- **invert_position**: (*Optional*) Set this to true if your actuator report fully closed as 100%
- **invert_angle**: (*Optional*) Set this to true if your actuator reports tilt fully closed as 100%

12
source/_components/cover.lutron_caseta.markdown
View File

@ -13,14 +13,10 @@ ha_iot_class: "Local Polling"
ha_release: 0.45
---
To get your Lutron Caseta covers (Serena Shades) working with Home Assistant, first follow the instructions for the general [Lutron Caseta component](/components/lutron_caseta/).
To get Lutron Caseta roller and honeycomb shades working with Home Assistant, first follow the instructions for the general [Lutron Caseta component](/components/lutron_caseta/).
You also need to configure Lutron Caseta as a cover platform in your `configuration.yaml` file:
After setup, shades will appear in Home Assistant using an `entity_id` based on the name used in the Lutron mobile app. For example, a shade called 'Living Room Window' will appear in Home Assistant as `cover.living_room_window`.
```yaml
# Example configuration.yaml entry
cover:
- platform: lutron_caseta
```
For more information on working with shades in Home Assistant, see the [Covers component](/components/cover/).
Your Lutron Caseta shades will be pulled into Home Assistant with the names they were assigned in the Lutron Caseta app.
Available services: `cover.open_cover`, `cover.close_cover` and `cover.set_cover_position`. Cover `position` ranges from `0` for fully closed to `100` for fully open.

4
source/_components/device_tracker.bluetooth_tracker.markdown
View File

@ -15,6 +15,10 @@ ha_release: 0.18
This tracker discovers new devices on boot and tracks bluetooth devices periodically based on interval_seconds value. It is not required to pair the devices with each other! Devices discovered are stored with 'bt_' as the prefix for device mac addresses in `known_devices.yaml`.
<p class='note'>
If you are using [Hass.io](/hassio/) you will need to enable the Bluetooth BCM43xx (/addons/bluetooth_bcm43xx/) addon.
</p>
To use the Bluetooth tracker in your installation, add the following to your `configuration.yaml` file:
```yaml

44
source/_components/device_tracker.geofency.markdown Normal file
View File

@ -0,0 +1,44 @@
---
layout: page
title: "Geofency"
description: "Instructions for how to use Geofency to track devices in Home Assistant."
date: 2017-08-22 19:00
sidebar: true
comments: false
sharing: true
footer: true
logo: geofency.png
ha_category: Presence Detection
ha_release: 0.53
---
This platform allows you to detect presence using [Geofency](http://www.geofency.com/). Geofency is a [paid app](https://itunes.apple.com/app/id615538630) for iOS that lets users to configure a request that will be sent when a geofence or iBeacon region is entered or exited. This can be configured with Home Assistant to update your location.
To integrate Geofency in Home Assistant, add the following section to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
device_tracker:
- platform: geofency
```
Configuration variables:
- **mobile_beacons** (*Optional*): List of beacon names that are to be treated as *mobile*. The name must match the name you configure in Geofency. By default, beacons will be treated as *stationary*.
A full sample configuration for the `geofency` platform is shown below:
```yaml
# Example configuration.yaml entry
device_tracker:
- platform: geofency
mobile_beacons:
- car
- keys
```
To configure Geofency, you must configure (via the Webhook feature) to send a POST request to your Home Assistant server at `http://<ha_server>/api/geofency`. Use the default POST format, and make sure to include the API password if you have configured a password in Home Assistant (add `?api_password=<password>` to the end of the URL). Make sure to enable the 'Update Geo-Position' functionality for mobile beacons.
Geofency will automatically generate the device tracker name used for geofences, and you will find it in `known_devices.yaml` after the first request. For beacons, the device name will be `beacon_<name from Geofency>`, e.g., `device_tracker.beacon_car`.
When you enter a geofence or stationary beacon, your location name in Home Assistant will be set to the name of the geofence or beacon location in Geofency. When you exit a geofence or stationary beacon, your location name in Home Assistant will be set to 'not home'. For mobile beacons, the location name will be 'not_home' whenever the beacon is entered or exited outside of a [zone](https://home-assistant.io/components/zone/), otherwise, it will be set to the name of the zone.

19
source/_components/device_tracker.tesla.markdown Normal file
View File

@ -0,0 +1,19 @@
---
layout: page
title: "Tesla"
description: "Instructions on for how to integrate Tesla into Home Assistant."
date: 2017-08-02 12:20
sidebar: true
comments: false
sharing: true
footer: true
logo: tesla.png
ha_category: Presence Detection
ha_release: 0.53
---
The `Tesla` platform allows you to get data about the location of your [Tesla](https://www.tesla.com/) car within Home Assistant.
The device tracker platform will be automatically configured if Tesla component is configured.
For more configuration information see the [Tesla component](/components/tesla/) documentation.

19
source/_components/frontend.markdown
View File

@ -18,7 +18,7 @@ This offers the official frontend to control Home Assistant.
frontend:
```
### {% linkable_title Themes %}
## {% linkable_title Themes %}
Starting with version 0.49 you can define themes:
@ -76,3 +76,20 @@ automation:
### {% linkable_title Manual Theme Selection %}
When themes are enabled in the `configuration.yaml` file, a new option will show up in the Configuration panel under `configuration.yaml` called "Set a theme." You can then choose any installed theme from the dropdown list and it will be applied immediately.
## {% linkable_title Loading extra HTML %}
Starting with version 0.53 you can specify extra HTML files to load.
Example:
```yaml
# Example configuration.yaml entry
frontend:
extra_html_url:
- https://example.com/file1.html
- /file2.html
```
Those will be loaded via `<link rel='import' href='{{ extra_url }}' async>` on any page (states and panels)

39
source/_components/input_text.markdown Normal file
View File

@ -0,0 +1,39 @@
---
layout: page
title: "Input Text"
description: "Instructions how to integrate the Input Text component into Home Assistant."
date: 2016-03-15 06:00
sidebar: true
comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Automation
ha_release: 0.53
---
The `input_text` component allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. Changes to the value stored in the text box generate state events. These state events can be utilized as `automation` triggers as well.
```yaml
# Example configuration.yaml entries
input_text:
text1:
name: Text 1
initial: Some Text
text2:
name: Text 2
min: 8
max: 40
text3:
name: Text 3
pattern: '[a-fA-F0-9]*'
```
Configuration variables:
- **[alias]** (*Required*): Alias for the text input.
- **min** (*Optional*): Minimum length for the text value. Default is `0`.
- **max** (*Optional*): Maximum length for the text value. Default is `100`.
- **name** (*Optional*): Friendly name of the text input.
- **initial** (*Optional*): Initial value when Home Assistant starts. Default is empty string.
- **pattern** (*Optional*): Regex pattern for client side validation. Default is empty string, which is treated same as `.*`.

82
source/_components/knx.markdown
View File

@ -13,7 +13,12 @@ ha_release: 0.24
ha_iot_class: "Local Polling"
---
[KNX/EIB](http://www.knx.org) integration for Home Assistant allows you to connect to a KNX bus. The component requires a local KNX/IP interface like the [Weinzierl 730](http://www.weinzierl.de/index.php/en/all-knx/knx-devices-en/knx-ip-interface-730-en). Through this it will send and receive commands to and from other devices to the KNX bus.
Overview
--------
The [KNX](http://www.knx.org) integration for Home Assistant allows you to connect to a KNX/IP devices.
The component requires a local KNX/IP interface like the [Weinzierl 730](http://www.weinzierl.de/index.php/en/all-knx/knx-devices-en/knx-ip-interface-730-en). Through this, it will send and receive commands to and from other devices to the KNX bus.
There is currently support for the following device types within Home Assistant:
@ -23,13 +28,80 @@ There is currently support for the following device types within Home Assistant:
- [Switch](/components/switch.knx)
- [Light](/components/light.knx)
- [Thermostat](/components/climate.knx)
- [Notify](/components/notify.knx)
A `knx` section must be present in the `configuration.yaml` file and contain the following options as required:
Configuration
--------------
To use your KNX in your installation, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
knx:
```
- **host** (*Optional*): The IP address of the KNX/IP interface to use. It defaults to `0.0.0.0` which will start discovery for your KNX/IP gateway.
- **port** (*Optional*): The UDP port number. Defaults to `3671`.
Optional, recommended for large KNX installations (>100 devices) and/or if you want to use the XKNX abstraction also for other scripted tools outside HASS:
```yaml
knx:
config_file: '/path/to/xknx.yaml'
```
* **config_file**: (*Optional*) path for xknx configuration file.
If the auto detection of the KNX/IP device does not work you can specify ip/port of the tunneling device:
```yaml
knx:
tunneling:
host: '192.168.2.23'
port: 3671
local_ip: '192.168.2.109'
```
* **host**: Host of the KNX/IP tunneling device
* **port**: Port of the KNX/IP tunneling device
* **local_ip**: IP of the local interface
Explicit connection to a KNX/IP routing device:
```yaml
knx:
config_file: '/path/to/xknx.yaml'
routing:
local_ip: '192.168.2.109'
```
* **local_ip**: local ip of interface (which should be used for multicasting)
```yaml
knx:
fire_event: True
fire_event_filter: ["1/0/*", "6/2,3,4-6/*"]
```
* **fire_event** (Optional) if set to True, platform will write all received KNX messages to event bus
* **fire_event_filter** If `fire_event` is set `fire_event_filter` has to be specified. `fire_event_filter` defines a list of patterns for filtering KNX addresses. Only telegrams which match this pattern are sent to the HASS event bus.
Service
-------
In order to directly interact with the KNX bus, you can now use the following service:
```
Domain: knx
Service: send
Service Data: {"address": "1/0/15", "payload": 0}
```
* **address** : KNX group address
* **payload** : payload, either an integer or an array of integers
Known issues:
-------------
Due to lame multicast support the routing abstraction and the gateway scanner
only work with python >=3.5.

26
source/_components/light.knx.markdown
View File

@ -16,18 +16,28 @@ ha_iot_class: "Local Polling"
The `knx` light component is used as in interface to switching/light actuators.
To use your KNX light in your installation, add the following to your `configuration.yaml` file:
The `knx` component must be configured correctly, see [KNX Component](/components/knx).
To use your KNX light in your installation, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
light:
- platform: knx
name: KNX light
address: 0/0/1
name: Kitchen-Light-1
address: '1/0/9'
brightness_address: '1/0/11'
- platform: knx
name: Kitchen-Light-2
address: '1/0/12'
brightness_address: '1/0/14'
```
- **name** (*Optional*): A name for this devices used within Home assistant
- **address** (*Required*): The KNX group address that is used to turn on/off this actuator channel
- **state_address** (*Optional*): Some KNX devices can change their state internally without any messages on the KXN bus, e.g. if you configure a timer on a channel. The optional `state_address` can be used to inform Home Assistant about these state changes. If a KNX message is seen on the bus addressed to the given state address, this will overwrite the state of the switch object.
For switching/light actuators that are only controlled by a single group address and can't change their state internally, you don't have to configure the state address.
* **name** (*Optional*): A name for this device used within Home Assistant.
* **address**: KNX group address for switching the light on and off
* **brightness_address**: (Optional) KNX group address for dimming light.
* **state_address**: (*Optional*) separate KNX group address for retrieving the switch state of the light.
* **brightness_state_address**: (*Optional*) separate KNX group address for retrieving the dimmed state of the light.
Some KNX devices can change their state internally without any messages on the KXN bus, e.g., if you configure a timer on a channel. The optional `state_address` can be used to inform Home Assistant about these state changes. If a KNX message is seen on the bus addressed to the given state address, this will overwrite the state of the switch object.
For switching/light actuators that are only controlled by a single group address and can't change their state internally, you don't have to configure the state address.

10
source/_components/light.lutron_caseta.markdown
View File

@ -12,4 +12,12 @@ ha_category: Light
ha_iot_class: "Local Polling"
---
To get your Lutron Caseta lights working with Home Assistant, follow the instructions for the general [Lutron Caseta component](/components/lutron_caseta/).
To get Lutron Caseta lights working with Home Assistant, follow the instructions for the general [Lutron Caseta component](/components/lutron_caseta/).
After setup, dimmable lights including wall and plug-in dimmers will appear in Home Assistant using an `entity_id` based on the name used in the Lutron mobile app. For example, a light called 'Bedroom Lamp' will appear in Home Assistant as `light.bedroom_lamp`.
For non-dimmable lights or switched loads, see [Lutron Caseta Switch](/components/switch.lutron_caseta/).
For more information on working with lights in Home Assistant, see the [Lights component](/components/light/).
Available services: `light.turn_on`, `light.turn_off` and `light.toggle`. The `light.turn_on` service supports attributes `brightness` and `brightness_pct`.

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

@ -0,0 +1,36 @@
---
layout: page
title: "Xiaomi Philips Light"
description: "Instructions how to integrate your Xiaomi Philips Lights within Home Assistant."
date: 2017-08-26 08:45
sidebar: true
comments: false
sharing: true
footer: true
logo: philips.png
ha_category: Light
ha_version: 0.53
ha_iot_class: "Local Polling"
---
The `xiaomi_philipslight` platform allows you to control the state of your Xiaomi Philips LED Ball Lamp and Xiaomi Philips LED Ceiling Lamp.
Currently, the supported features are `on`, `off`, `set_cct` (colortemp) , `set_bright` (brightness).
Please follow the instructions on [Retrieving the Access Token](/xiaomi/#retrieving-the-access-token) to get the API token to use in the `configuration.yaml` file.
To add a Xiaomi Philips Light to your installation, add the following to your configuration.yaml file:
```yaml
# Example configuration.yaml entries
light:
- platform: xiaomi_philipslight
name: Xiaomi Philips Smart LED Ball
host: 192.168.130.67
token: YOUR_TOKEN
```
Configuration variables:
- **host** (*Required*): The IP of your light.
- **token** (*Required*): The API token of your light.
- **name** (*Optional*): The name of your light.

20
source/_components/lock.abode.markdown Normal file
View File

@ -0,0 +1,20 @@
---
layout: page
title: "Abode Lock"
description: "Instructions how to integrate Abode locks into Home Assistant."
date: 2017-08-26 13:28
sidebar: true
comments: false
sharing: true
footer: true
logo: abode.jpg
ha_release: 0.52
ha_category: Lock
ha_iot_class: "Cloud Push"
---
The `abode` security control panel platform allows you to control your [Abode](https://goabode.com/) alarms.
This component will automatically add `Door Locks` configured in your Abode account.
The requirement is that you have setup your [Abode hub](/components/abode/).

20
source/_components/lock.tesla.markdown Normal file
View File

@ -0,0 +1,20 @@
---
layout: page
title: "Tesla Lock"
description: "Instructions on how to integrate Tesla door lock into Home Assistant."
date: 2017-08-30 12:20
sidebar: true
comments: false
sharing: true
footer: true
logo: tesla.png
ha_category: Lock
ha_iot_class: "Coud Push"
ha_release: 0.53
---
The `Tesla` platform allows you to control your [Tesla](https://www.tesla.com/) door lock from within Home Assistant.
The lock platform will be automatically configured if Tesla component is configured.
For more configuration information see the [Tesla component](/components/tesla/) documentation.

20
source/_components/lutron_caseta.markdown
View File

@ -14,18 +14,20 @@ ha_release: 0.41
ha_iot_class: "Local Polling"
---
[Lutron](http://www.lutron.com/) is an American lighting control company. They have several lines of home automation devices that manage light switches/dimmers, occupancy sensors, HVAC controls, etc. The `lutron_caseta` component in Home Assistant is responsible for communicating with the Lutron SmartBridge for these systems. Both 'pro' and 'standard' models are supported.
[Lutron](http://www.lutron.com/) is an American lighting control company. They have several lines of home automation devices that manage light switches, dimmers, occupancy sensors, HVAC controls, etc. The `lutron_caseta` component in Home Assistant is responsible for communicating with the Lutron Caseta Smart Bridge for the [Caseta](http://www.casetawireless.com) product line of dimmers, switches and shades.
This component only supports the Caseta line of products. The current supported Caseta devices are:
This component only supports the [Caseta](http://www.casetawireless.com) line of products. Both Smart Bridge (L-BDG2-WH) and Smart Bridge PRO (L-BDGPRO2-WH) models are supported. For the RadioRA 2 product line, see the [Lutron component](/components/lutron/).
- Dimmers as Home Assistant lights
- Wall switches as Home Assistant switches
- Scenes as Home Assistant scenes
- Serena shades (honeycomb and roller) as Home Assistant covers
The currently supported Caseta devices are:
When configured, the `lutron_caseta` component will automatically discover the currently support devices as setup in the Lutron SmartBridge.
- Wall and plug-in dimmers as Home Assistant [lights](/components/light.lutron_caseta/)
- Wall switches as Home Assistant [switches](/components/switch.lutron_caseta/)
- Scenes as Home Assistant [scenes](/components/scene.lutron_caseta/)
- Lutron shades as Home Assistant [covers](/components/cover.lutron_caseta/)
To use Lutron Caseta devices in your installation, add the following to your `configuration.yaml` file using the IP of your lutron Smartbridge:
When configured, the `lutron_caseta` component will automatically discover the currently supported devices as setup in the Lutron Smart Bridge. The name assigned in the Lutron mobile app will be used to form the `entity_id` used in Home Assistant. e.g. a dimmer called 'Bedroom Lamp' becomes `light.bedroom_lamp` in Home Assistant.
To use Lutron Caseta devices in your installation, add the following to your `configuration.yaml` file using the IP of your Smart Bridge:
```yaml
# Example configuration.yaml entry
@ -39,4 +41,6 @@ Configuration variables:
<p class='note'>
It is recommended to assign a static IP address to your Lutron Smart Bridge. This ensures that it won't change IP address, so you won't have to change the `host` if it reboots and comes up with a different IP address.
<br>
Use a DHCP reservation on your router to reserve the address or in the PRO model of the Smart Bridge, set the IP address under Network Settings in the Advanced / Integration menu in the mobile app.
</p>

7
source/_components/media_player.directv.markdown
View File

@ -13,9 +13,9 @@ ha_release: 0.25
ha_iot_class: "Local Polling"
---
The [DirecTV](http://www.directv.com/) receivers will be automatically discovered if you enable the [discovery component](/components/discovery/).
Master [DirecTV](http://www.directv.com/) receivers (ie: those that have tuners) will be automatically discovered if you enable the [discovery component](/components/discovery/) and the the receiver is powered-on. Slave/RVU client/Genie boxes will also be discovered, but only if they are also online at the time of discovery.
The `directv` media player platform can also be forced to load by adding the following lines to your `configuration.yaml`:
To ensure that your DirecTV boxes are always found and configured, they should be added into your `configuration.yaml`.
```yaml
# Example configuration.yaml entry
@ -29,7 +29,6 @@ Configuration variables:
- **name** (*Optional*): Use to give a specific name to the device.
- **device** (*Optional*): Use to specify a particular receiver in a Genie setup.
In a DirecTV setup with Genie slave boxes, only the master Genie server is currently found via the [discovery component](/components/discovery/). Slave boxes must be manually configured via the `device` configuration variable in order to be used with Home Assistant.
To find valid device IDs, open `http://<IP Address of Genie Server>:8080/info/getLocations` in a web browser. For each Genie slave, you will find a variable `clientAddr` in the response, and this should be used for `device` in `configuration.yaml`
@ -73,4 +72,4 @@ media_player:
device: 5009591D6969
```
It is important to notice that the host and port variables for slave receivers are the same as the master receiver.
It is important to notice that the host and port variables for slave/Genie receivers are the same as the master receiver.

45
source/_components/media_player.yamaha_musiccast.markdown Normal file
View File

@ -0,0 +1,45 @@
---
layout: page
title: "Yamaha MusicCast Receivers"
description: "Instructions on how to integrate Yamaha MusicCast Receivers into Home Assistant."
date: 2017-09-02 22:00 +0100
sidebar: true
comments: false
sharing: true
footer: true
logo: yamaha.png
ha_category: Media Player
ha_release: 0.53
---
The `yamaha_musiccast` platform allows you to control [Yamaha MusicCast Receivers](https://usa.yamaha.com/products/audio_visual/hifi_components/index.html) from Home Assistant.
Supported devices are listed on their [German site](https://de.yamaha.com/de/products/contents/audio_visual/musiccast/products.html).
To add a Yamaha Network Receiver to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
media_player:
- platform: yamaha_musiccast
host: 192.168.xx.xx
```
Configuration variables:
- **name** (*Optional*): Name of the device
- **host** (*Required*): IP address or hostname of the device
- **port** (*Optional*): UDP Port
A few notes:
- Currently, this component supports powering on/off, mute, volume control, and source selection. Playback controls, for instance, play and stop are available for sources that support it.
A full configuration example will look like the sample below:
```yaml
# Example configuration.yaml entry
media_player:
- platform: yamaha_musiccast
name: "Living Room"
host: 192.168.178.97
port: 5005
```

31
source/_components/mycroft.markdown Normal file
View File

@ -0,0 +1,31 @@
---
layout: page
title: "Mycroft"
description: "Instructions how to setup Mycroft AI within Home Assistant."
date: 2017-08-26 17:00
sidebar: true
comments: false
sharing: true
footer: true
logo: mycroft.png
ha_category: Voice
ha_release: 0.53
---
[Mycroft](https://mycroft.ai) is a open source voice assistant that allows you to send notifications and more to Mycroft from Home Assistant.
```yaml
# Example configuration.yaml entry
mycroft:
host: 0.0.0.0
```
`host` is your IP address of your mycroft instance. Once you have added your host to your `configuration.yaml` file, restart your Home Assistant server. This will load up the Mycroft component and make a service available to notify on Mycroft and more eventually.
The `mycroft` notification platform allows you to deliver notifications from Home Assistant to [Mycroft AI](https://mycroft.ai/).
To use this notification platform you simply need to input into the configuration that mycroft is your notification platform like seen above.
To use notifications, please see the [getting started with automation page](/getting-started/automation/).

7
source/_components/mysensors.markdown
View File

@ -26,6 +26,11 @@ mysensors:
- device: '/dev/ttyUSB0'
persistence_file: 'path/mysensors.json'
baud_rate: 38400
nodes:
1:
name: 'kitchen'
3:
name: 'living_room'
- device: '/dev/ttyACM0'
persistence_file: 'path/mysensors2.json'
baud_rate: 115200
@ -55,6 +60,8 @@ Configuration variables:
- **version** (*Optional*): Specifies the MySensors protocol version to use. Supports 1.4, 1.5 and 2.0. Default is 1.4.
- **optimistic** (*Optional*): Enable or disable optimistic mode for actuators (switch/light). Default is false. Set this to true if no state feedback from actuators is possible. Home Assistant will assume that the command succeeded and change state.
- **retain** (*Optional*): Enable or disable retain flag for published messages from Home Assistant when using the MQTT gateway. Default is true.
- **nodes** (*Optional*): Nodes that need a custom name.
- **name** (*Optional*): The name the node will be renamed to. This nodename becomes part of the entity_id. Default the entity_id is [sketch_name]\_[node_id]\_[child_id] and when this name is set, the entity_id becomes [name]\_[child_id].
<p class='note'>
Not all features of MySensors 2.0 are yet supported by Home Assistant. As more features are added, they will be described here in the documentation. Go to the MySensors platform pages under "related components" to see what message types are currently supported.

12
source/_components/netatmo.markdown
View File

@ -21,23 +21,23 @@ To enable the Netatmo component, add the following lines to your `configuration.
```yaml
# Example configuration.yaml entry
netatmo:
api_key: YOUR_API_KEY
secret_key: YOUR_SECRET_KEY
api_key: YOUR_CLIENT_ID
secret_key: YOUR_CLIENT_SECRET
username: YOUR_USERNAME
password: YOUR_PASSWORD
```
Configuration variables:
- **api_key** (*Required*): The API key for your Netatmo account.
- **secret_key** (*Required*): Your Netatmo secret key
- **api_key** (*Required*): The `client id` form your Netatmo app.
- **secret_key** (*Required*): The `client secret` form your Netatmo app.
- **username** (*Required*): Username for the Netatmo account.
- **password** (*Required*): Password for the Netatmo account.
- **discovery** (*Optional)*: Whether to discover Netatmo devices. Set it to False, if you want to choose which Netatmo device you want to add (default True).
### {% linkable_title Get API and Secret Key %}
To get your API credentials, you have to declare a new application in the [NetAtmo Developer Page](https://dev.netatmo.com/). Sign in using your username and password from your regular Netatmo account.
To get your API credentials, you have to declare a new application in the [Netatmo Developer Page](https://dev.netatmo.com/). Sign in using your username and password from your regular Netatmo account.
Click on 'Create an App' at the top of the page.
<p class='img'>
@ -49,7 +49,7 @@ You have to fill the form, but only two fields are required : Name and Descripti
<img src='/images/screenshots/netatmo_app.png' />
</p>
That's it. You can copy and paste your new API and secret keys in your Home Assistant configuration file just as said above.
That's it. You can copy and paste your new `client id` and `client secret` in your Home Assistant configuration file just as described above, in the configuration example.
<p class='img'>
<img src='/images/screenshots/netatmo_api.png' />

30
source/_components/notify.knx.markdown Normal file
View File

@ -0,0 +1,30 @@
---
layout: page
title: "KNX Notify"
description: "Instructions on how to use the KNX notify with Home Assistant."
date: 2016-09-03 17:00
sidebar: true
comments: false
sharing: true
footer: true
logo: knx.png
ha_category: Notify
ha_release: 0.53
ha_iot_class: "Local Push"
---
The `knx` notify platform allows you to send notifications to [KNX](http://www.knx.org) devices.
The `knx` component must be configured correctly, see [KNX Component](/components/knx).
To use your KNX switch in your installation, add the following lines to your `configuration.yaml` file:
```yaml
notify:
- platform: knx
name: Alarm
address: '5/1/10'
```
* **name** (*Optional*): A name for this device used within Home Assistant.
* **address**: KNX group address of the notification

15
source/_components/notify.mycroft.markdown Normal file
View File

@ -0,0 +1,15 @@
---
layout: page
title: "Mycroft AI"
description: "Instructions how to add Mycroft AI notifications to Home Assistant."
date: 2017-08-26 17:00 UTC
sidebar: true
comments: false
sharing: true
footer: true
logo: mycroft.png
ha_category: Notifications
ha_release: "0.53"
---
Please see the main [Mycroft Component](/components/mycroft)

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

@ -34,6 +34,7 @@ Configuration variables:
- **password** (*Required*): The password for your given Jabber account.
- **recipient** (*Required*): The Jabber ID (JID) that will receive the messages.
- **tls** (*Optional*): Allow to disable TLS. Defaults to `true`.
- **verify** (*Optional*): Allow disabling SSL certificate validity check (e.g., self-signed certificate). Defaults to `true`.
All Jabber IDs (JID) must include the domain. Make sure that the password matches the account provided as sender.

9
source/_components/scene.lutron_caseta.markdown
View File

@ -13,7 +13,12 @@ ha_release: 0.49.2
ha_iot_class: "Cloud Polling"
---
To get Lutron Caseta Scenes working with Home Assistant, follow the instructions for the general [Lutron Caseta component](/components/lutron_caseta/).
The Lutron Caseta scene platform allows you to control your [Lutron Caseta](http://www.casetawireless.com/Pages/Caseta.aspx) SmartBridge Scenes.
The Lutron Caseta scene platform allows you to control your Smart Bridge Scenes that are created in the Lutron mobile app.
The requirement is that you have setup the [Lutron Caseta](/components/lutron_caseta/) component.
After setup, scenes will appear in Home Assistant using an `entity_id` based on the name used in the Lutron mobile app. For example, a scene called 'Entertain' will appear in Home Assistant as `scene.entertain`.
For more information on working with scenes in Home Assistant, see the [Scenes component](/components/scene/).
Available services: `scene.turn_on`.

112
source/_components/sensor.airvisual.markdown Normal file
View File

@ -0,0 +1,112 @@
---
layout: page
title: "AirVisual"
description: "Instructions on how to use AirVisual data within Home Assistant"
date: 2017-09-06 12:15
sidebar: true
comments: false
sharing: true
footer: true
logo: airvisual.jpg
ha_category: Health
ha_release: 0.53
ha_iot_class: "Cloud Polling"
---
The `airvisual` sensor platform queries the [AirVisual](https://airvisual.com/) API for air quality
data on the nearest city to a latitude and longitude. The resulting information
creates sensors for the Air Quality Index (AQI), the human-friendly air quality
level, and the main pollutant of that area. Sensors that conform to either/both
the [U.S. and Chinese air quality standards](http://www.clm.com/publication.cfm?ID=366) can be created.
This platform requires an AirVisual API key, which can be obtained [here](https://airvisual.com/api). Note
that the platform was designed using the "Community" package; the "Startup"
and "Enterprise" package keys should continue to function, but actual results
may vary (or not work at all).
<p class='note warning'>
The "Community" API key is limited to 10,000 calls per month. In order to leave
a buffer, the `airvisual` platform queries the API every 10 minutes.
</p>
## {% linkable_title Configuring the Platform %}
To enable this platform, add the following lines to your `configuration.yaml`
file:
```yaml
sensor:
- platform: airvisual
api_key: abc123
monitored_conditions:
- us
- cn
latitude: 42.81212
longitude: 108.12422
radius: 500
```
Configuration variables:
- **api_key** (*Required*): your AirVisual API key
- **monitored_conditions** (*Required*): the air quality standard(s) to use
(`us` for U.S., `cn` for Chinese)
- **latitude** (*Optional*): the latitude to monitor; if excluded, the latitude
defined in `configuration.yaml` will be used
- **longitude** (*Optional*): the longitude to monitor; if excluded, the longitude
defined in `configuration.yaml` will be used
- **radius** (*Optional*): the radius (in meters) around the latitude/longitude to
search for the nearest city; defaults to `1000`
## {% linkable_title Sensor Types %}
When configured, the platform will create three sensors for each configured
air quality standard:
### Air Quality Index
**Description:** This sensor displays a numeric air quality index (AQI), a metric
for the overall "health" of the air.
**Example Sensor Name:** `sensor.chinese_air_quality_index`
**Example Sensor Value:** `32`
**Explanation:**
AQI | Status | Description
------- | :----------------: | ----------
0 - 50 | **Good** | Air quality is considered satisfactory, and air pollution poses little or no risk
51 - 100 | **Moderate** | Air quality is acceptable; however, for some pollutants there may be a moderate health concern for a very small number of people who are unusually sensitive to air pollution
101 - 150 | **Unhealthy for Sensitive Groups** | Members of sensitive groups may experience health effects. The general public is not likely to be affected
151 - 200 | **Unhealthy** | Everyone may begin to experience health effects; members of sensitive groups may experience more serious health effects
201 - 300 | **Very unhealthy** | Health warnings of emergency conditions. The entire population is more likely to be affected
301+ | **Hazardous** | Health alert: everyone may experience more serious health effects
### Air Polution Level
**Description:** This sensor displays the associated `Status` (from the above
table) for the current AQI.
**Sample Sensor Name:** `sensor.us_air_pollution_level`
**Example Sensor Value:** `Moderate`
### Main Pollutant
**Description:** This sensor displays the pollutant whose value is currently
highest.
**Sample Sensor Name:** `sensor.us_main_pollutant`
**Example Sensor Value:** `PM2.5`
**Explanation:**
Pollutant | Symbol | More Info
------- | :----------------: | ----------
Particulate (<= 2.5 μm) | PM2.5 | [EPA: Particulate Matter (PM) Pollution ](https://www.epa.gov/pm-pollution)
Particulate (<= 10 μm) | PM10 | [EPA: Particulate Matter (PM) Pollution ](https://www.epa.gov/pm-pollution)
Ozone | O | [EPA: Ozone Pollution](https://www.epa.gov/ozone-pollution)
Sulpher Dioxide | SO2 | [EPA: Sulfur Dioxide (SO2) Pollution](https://www.epa.gov/so2-pollution)
Carbon Monoxide | CO | [EPA: Carbon Monoxide (CO) Pollution in Outdoor Air](https://www.epa.gov/co-pollution)

43
source/_components/sensor.dwdwarnapp.markdown Normal file
View File

@ -0,0 +1,43 @@
---
layout: page
title: "DWD Warn Weather"
description: "Instructions on how to integrate Deutsche Wetter Dienst weather warnings into Home Assistant."
date: 2017-07-26 22:00
sidebar: true
comments: false
sharing: true
footer: true
#logo: dwdwarnapp.png
ha_category: Weather
ha_release: 0.51
ha_iot_class: "Cloud Polling"
---
The `dwdwarnapp` sensor platform uses the [Deutsche Wetter Dienst (DWD)](http://www.dwd.de) as a source for current and advance warnings.
- A name is optional but if multiple regions are used a name will be required.
- The sensor checks for new data every 15 minutes.
To add the DWD WarnApp sensor to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: dwdwarnapp
region_name: Hansestadt Hamburg
```
To get the region name:
- Find your region here: `https://www.dwd.de/DE/wetter/warnungen_landkreise/warnWetter_node.html?ort=Hamburg`
- Verify if you find any warning for your region here: `https://www.dwd.de/DWD/warnungen/warnapp_landkreise/json/warnings.json?jsonp=loadWarnings`
The warning level is between 0 (no danger) and 4 (warnings of extreme weather):
- Warnungen vor extremem Unwetter (Stufe 4)
- Unwetterwarnungen (Stufe 3)
- Warnungen vor markantem Wetter (Stufe 2)
- Wetterwarnungen (Stufe 1)
Configuration variables:
- **region_name** (*Optional*): The region name string as identified from the DWD website. If not given, defaults to Hansestadt Hamburg.
- **name** (*Optional*): The name you would like to give to the warnapp sensor.

36
source/_components/sensor.knx.markdown
View File

@ -17,23 +17,20 @@ The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) sensor
The `knx` component must be configured correctly, see [KNX Component](/components/knx).
There is currently support for the following KNX data point types:
| Condition | KNX Datapoint Type | Unit of measurement | Data type |
| :-------------------|:--------------------|:--------------------|:-------------------------------|
| Temperature | 9.001 | °C | 2 Byte Float |
| Speed (Wind speed) | 9.005 | m/s | 2 Byte Float |
| Illuminance (Lux) | 9.004 | Lux | 2 Byte Float |
| Percentage | 5.001 | % | 1 Byte Scaled Unsigned Integer |
To use your KNX sensor in your installation, add the following to your `configuration.yaml` file:
To use your KNX sensor in your installation, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: knx
type: temperature
address: 1/0/3
name: Heating.Valve1
address: '2/0/0'
type: 'percent'
- platform: knx
name: Kitchen.Temperature
address: '6/2/1'
type: 'temperature'
- platform: knx
name: Wind speed
@ -44,18 +41,11 @@ sensor:
name: Lux
type: illuminance
address: 1/0/1
- platform: knx
name: percent
type: percentage
address: 1/0/4
```
Configuration variables:
* **name** (*Optional*): A name for this device used within Home Assistant.
* **address**: KNX group address of the sensor
* **type**: (Optional) "percent", "temperature", "illuminance", "speed_ms", "current"
- **type** (*Required*): The type of the sensor. See table above for available options.
- **address** (*Required*): The address of the sensor on the bus.
- **name** (*Optional*): The name to use in the frontend.
- **minimum** (*Optional*): Minimum sensor value - defaults to a hardcoded default value.
- **maximum** (*Optional*): Maximum sensor value - defaults to a hardcoded default value.

54
source/_components/sensor.mopar.markdown Normal file
View File

@ -0,0 +1,54 @@
---
layout: page
title: "Mopar"
description: "Instructions on how to integrate Mopar vehicles into Home Assistant."
date: 2017-08-30 10:00
sidebar: true
comments: false
sharing: true
footer: true
logo: mopar.png
ha_category: Sensor
featured: false
ha_release: 0.53
ha_iot_class: "Cloud Polling"
---
The `mopar` sensor provides the following for owners of FCA vehicles with a uConnect subscription:
- Sensor per vehicle with vehicle health report and other metadata
- Service for remote commands: Lock/unlock, Engine on/off, Horn & lights
Be sure you have a [mopar.com](http://mopar.com) account with your vehicle(s) registered by VIN. You must also have a current uConnect subscription.
To enable this sensor, add the following lines to your `configuration.yaml`.
```yaml
sensor:
- platform: mopar
username: <mopar.com username>
password: <mopar.com password>
pin: <uconnect pin>
```
Configuration options for the Mopar sensor:
- **username** (*Required*): Your mopar.com username.
- **password** (*Required*): Your mopar.com password.
- **pin** (*Required*): Your uConnect pin.
## {% linkable_title Service %}
Call the `mopar.remote_command` service to perform a remote command on your vehicle.
- **vehicle_index** (*Required*): `vehicle_index` attribute found on sensor.
- **command** (*Required*): One of `lock/unlock/engineon/engineoff/horn`.
Example data:
```json
{
"vehicle_index": 0,
"command": "unlock"
}
```

29
source/_components/sensor.season.markdown Normal file
View File

@ -0,0 +1,29 @@
---
layout: page
title: "Season Sensor"
description: "Instructions how to add season sensors into Home Assistant."
date: 2017-07-04 07:00:00
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Sensor
ha_iot_class: "Local Polling"
ha_release: 0.53
---
This sensor will display the current astronomical or meteorological season (Spring, Summer, Autumn, Winter) based on the users setting in the config file.
All information about how the seasons work was taken from Wikipedia:
- [https://en.wikipedia.org/wiki/Season#Astronomical](https://en.wikipedia.org/wiki/Season#Astronomical)
- [https://en.wikipedia.org/wiki/Equinox](https://en.wikipedia.org/wiki/Equinox)
- [https://en.wikipedia.org/wiki/Solstice](https://en.wikipedia.org/wiki/Solstice)
```yaml
# Example configuration.yaml entry
sensor:
- platform: season
type: astronomical (optional, will default to astronomical)
```

3
source/_components/sensor.statistics.markdown
View File

@ -27,6 +27,8 @@ sensor:
entity_id: sensor.cpu
- platform: statistics
entity_id: binary_sensor.movement
max_age:
minutes: 30
```
Configuration variables:
@ -34,6 +36,7 @@ Configuration variables:
- **entity_id** (*Required*): The entity to monitor. Only [sensors](/components/sensor/) and [binary sensor](/components/binary_sensor/).
- **name** (*Optional*): Name of the sensor to use in the frontend. Defaults to `Stats`.
- **sampling_size** (*Optional*): Size of the sampling. If the limit is reached then the values are rotated. Defaults to `20`.
- **max_age** (*Optional*): Maximum age of measurements. Setting this to a time interval will cause older values to be discarded.
<p class='img'>
<img src='{{site_root}}/images/screenshots/stats-sensor.png' />

44
source/_components/sensor.tank_utility.markdown Normal file
View File

@ -0,0 +1,44 @@
---
layout: page
title: "Tank Utility Sensor"
description: "How to integrate Tank Utility sensors within Home Assistant."
date: 2017-08-24 08:21
sidebar: true
comments: false
sharing: true
footer: true
logo: tank_utility.png
ha_category: Sensor
ha_release: "0.53"
---
Add [Tank Utility](https://www.tankutility.com/) propane tank monitors to Home Assistant.
```yaml
# Example configuration.yaml entry
sensor:
- platform: tank_utility
email: EMAIL
password: PASSWORD
devices:
- 000000000000000000000000
```
Configuration variables:
* **email** *(Required)*: [https://app.tankutility.com](https://app.tankutility.com) email address
* **password** *(Required)*: [https://app.tankutility.com](https://app.tankutility.com) password
* **devices** *(Required)*: List of devices
Authentication:
Authentication for the Tank Utility API is performed with the same email and password credentials used at
[https://app.tankutility.com](https://app.tankutility.com).
Devices:
Each item in the list of devices is a 24 character string. These values can be found by clicking on the **Usage
Reports** link at the bottom of the graph on the [Tank Utility devices page](https://app.tankutility.com/#/devices).
The device item value is the last segment of the URL path, e.g., the URL
[https://app.tankutility.com/#/reports/000000000000000000000000](https://app.tankutility.com/#/reports/000000000000000000000000)
would indicate `000000000000000000000000` as a device value.

20
source/_components/sensor.tesla.markdown Normal file
View File

@ -0,0 +1,20 @@
---
layout: page
title: "Tesla Sensor"
description: "Instructions on how to integrate Tesla sensors into Home Assistant."
date: 2017-08-30 12:21
sidebar: true
comments: false
sharing: true
footer: true
logo: tesla.png
ha_category: Sensor
ha_iot_class: "Cloud Push"
ha_release: 0.53
---
The `Tesla` platform allows you to get data from your [Tesla](https://www.tesla.com/) sensors from within Home Assistant.
The sensor platform will be automatically configured if Tesla component is configured.
For more configuration information see the [Tesla component](/components/tesla/) documentation.

20
source/_components/switch.abode.markdown Normal file
View File

@ -0,0 +1,20 @@
---
layout: page
title: "Abode Switch"
description: "Instructions how to integrate Abode switches into Home Assistant."
date: 2017-08-26 13:28
sidebar: true
comments: false
sharing: true
footer: true
logo: abode.jpg
ha_release: 0.52
ha_category: Switch
ha_iot_class: "Cloud Push"
---
The `abode` security control panel platform allows you to control your [Abode](https://goabode.com/) alarms.
This component will automatically add `Power Switch Sensors` configured in your Abode account.
The requirement is that you have setup your [Abode hub](/components/abode/).

16
source/_components/switch.knx.markdown
View File

@ -16,18 +16,22 @@ ha_iot_class: "Local Polling"
The `knx` switch component is used as in interface to switching actuators.
The `knx` component must be configured correctly, see [KNX Component](/components/knx).
To use your KNX switch in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
switch:
- platform: knx
name: KNX Switch
address: 0/0/1
name: Kitchen.Coffee
address: '1/1/6'
```
* **name** (*Optional*): A name for this device used within Home Assistant.
* **address**: KNX group address for switching the switch on/off
* **state_address**: (*Optional*) separate KNX group address for retrieving the switch state.
- **name** (*Optional*): A name for this devices used within Home assistant
- **address** (*Required*): The KNX group address that is used to turn on/off this actuator channel
- **state_address** (*Optional*): Some KNX devices can change their state internally without any messages on the KXN bus, e.g. if you configure a timer on a channel. The optional `state_address` can be used to inform Home Assistant about these state changes. If a KNX message is seen on the bus addressed to the given state address, this will overwrite the state of the switch object.
Some KNX devices can change their state internally without any messages on the KXN bus, e.g., if you configure a timer on a channel. The optional `state_address` can be used to inform Home Assistant about these state changes. If a KNX message is seen on the bus addressed to the given state address, this will overwrite the state of the switch object.
For switching actuators that are only controlled by a single group address and can't change their state internally, you don't have to configure the state address.

10
source/_components/switch.lutron_caseta.markdown
View File

@ -12,4 +12,12 @@ ha_category: Switch
ha_iot_class: "Local Polling"
---
To get your Lutron Caseta switches working with Home Assistant, follow the instructions for the general [Lutron Caseta component](/components/lutron_caseta/).
To get Lutron Caseta switches working with Home Assistant, follow the instructions for the general [Lutron Caseta component](/components/lutron_caseta/).
After setup, switches will appear in Home Assistant using an `entity_id` based on the name used in the Lutron mobile app. For example, a light switch called 'Master Bathroom Vanity' will appear in Home Assistant as `switch.master_bathroom_vanity`.
For dimmable lights including wall and plug-in dimmers, see [Lutron Caseta Light](/components/light.lutron_caseta/).
For more information on working with switches in Home Assistant, see the [Switches component](/components/switch/).
Available services: `switch.turn_on` and `switch.turn_off`.

39
source/_components/tesla.markdown Normal file
View File

@ -0,0 +1,39 @@
---
layout: page
title: "Tesla"
description: "Instructions on how to integrate Tesla car into Home Assistant."
date: 2017-08-28 17:00
sidebar: true
comments: false
sharing: true
footer: true
logo: tesla.png
ha_category: Hub
ha_release: 0.53
ha_iot_class: "Cloud Polling"
---
The `Tesla` component offers integration with the [Tesla](https://auth.tesla.com/login) cloud service and provides presence detection as well as sensors such as charger state and temperature.
This component provides the following platforms:
- Binary sensors - such as parking and charger connection.
- Sensors - such as Battery level, Inside/Outside temperature.
- Device tracker - to track location of your car
- Lock - Door lock. Enables you to control Tesla's door lock
- Climate - HVAC control. Allow you to control (turn on/off, set target temperature) your Tesla's HVAC system.
To use Tesla in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
tesla:
username: email
password: password
```
Configuration variables:
- **username** (*Required*): The email address associated with your Tesla account.
- **password** (*Required*): The password for your given Tesla account.
- **scan_interval** (*Optional*): API polling interval. Minimal value can't be less then 300. (Defaults 300)

2
source/_components/twilio.markdown
View File

@ -29,7 +29,7 @@ twilio:
Configuration variables:
- **account_sid** (*Required*): Your Twilio Account SID which can be found in your [console](https://www.twilio.com/console). It starts with the letters `AC`.
- **auth_token** (*Required*): Your Twilio Account SID which can be found in your [console](https://www.twilio.com/console). It should be directly under where you found the `account_sid`.
- **auth_token** (*Required*): Your Twilio AUTH TOKEN which can be found in your [console](https://www.twilio.com/console). It should be directly under where you found the `account_sid`.
### {% linkable_title Usage %}
After configuring the base Twilio component, add and configure either or both of the [twilio SMS](https://home-assistant.io/components/notify.twilio_sms/) and [twilio Phone](https://home-assistant.io/components/notify.twilio_call) components to utilize the notification functionality.

4
source/_components/xiaomi.markdown
View File

@ -32,13 +32,13 @@ The `xiaomi` platform allows you to integrate the following [Xiaomi](http://www.
- Smoke Detector (reports alarm and density)
- Gateway (Light, Illumination Sensor, Ringtone play)
- Intelligent Curtain
- Water Leak Sensor
- Battery
What's not available?
- Gateway Radio
- Gateway Button
- Water Sensor
- Aqara Air Conditioning Companion
- Aqara Intelligent Air Conditioner Controller Hub
- Decoupled mode of the Aqara Wall Switches (Single & Double)
@ -208,4 +208,4 @@ $ java.exe -jar ../android-backup-extractor/abe.jar unpack backup.ab backup.tar
3. Install [iBackup Viewer](http://www.imactools.com/iphonebackupviewer/).
4. Extract this file: **`/raw data/com.xiami.mihome/1234567_mihome.sqlite`** to your computer, where `_1234567_` is any string of numbers.
5. Open the SQLite database with a tool like SQLite Manager extension for FireFox or DB Browser. You will then see the list of all the devices in your account with their token. The token you need is in the column **`ZToken`** and looks like **`123a1234567b12345c1d123456789e12`**.
(Location of SQLite files directly on iOS devices **/private/var/mobile/Containers/Data/Application/A80CE9E4-AD2E-4649-8C28-801C96B16BD7/Documents/**)

6
source/_docs/automation/trigger.markdown
View File

@ -68,6 +68,12 @@ automation:
# At least one of the following required
above: 17
below: 25
# If given, will trigger when condition has been for X time.
for:
hours: 1
minutes: 10
seconds: 5
```
<p class='note'>

2
source/_docs/ecosystem/apache.markdown
View File

@ -54,7 +54,7 @@ If you don't want HTTPS, you can change `<VirtualHost *:443>` to `<VirtualHost *
<p class='note'>
In case you are getting occasional HTTP 504 error messages ("Gateway Timeout") when accessing the Web UI through your proxy, try adding disablereuse=on to both ProxyPass directives:
In case you are getting occasional HTTP 504 error messages ("Gateway Timeout") or HTTP 502 messages ("Bad Gateway") when accessing the Web UI through your proxy, try adding disablereuse=on to both ProxyPass directives:
</p>
```text
<VirtualHost *:443>

17
source/_docs/z-wave.markdown
View File

@ -184,8 +184,25 @@ automation:
scene_id: 11
```
Some devices (like the HomeSeer wall switches) allow you to do things like double, and triple click the up and down buttons and fire an event. These devices will also send `scene_data` to differentiate the events. This is an example of double clicking the on/up button:
```yaml
# Example configuration.yaml automation entry
automation
- alias: 'Dining room dimmer - double tap up'
trigger:
- event_type: zwave.scene_activated
platform: event
event_data:
entity_id: zwave.dining_room_cans
scene_id: 1
scene_data: 3
```
The *object_id* and *scene_id* of all triggered events can be seen in the console output.
For more information on HomeSeer devices and similar devices, please see the [device specific page](https://home-assistant.io/docs/z-wave/device-specific/#homeseer-switches).
### {% linkable_title Services %}
The `zwave` component exposes multiple services to help maintain the network.

26
source/_docs/z-wave/device-specific.markdown
View File

@ -115,3 +115,29 @@ Here's a handy configuration for the Aeon Labs Minimote that defines all possibl
entity_id: zwave.aeon_labs_minimote_1
scene_id: 8
```
##### {% linkable_title HomeSeer Switches %}
For the HomeSeer devices specifically, you may need to update the `COMMAND_CLASS_CENTRAL_SCENE` for each node in your `zwcfg` file with the following:
```xml
<CommandClass id="91" name="COMMAND_CLASS_CENTRAL_SCENE" version="1" request_flags="4" innif="true" scenecount="0">
<Instance index="1" />
<Value type="int" genre="system" instance="1" index="0" label="Scene Count" units="" read_only="true" write_only="false" verify_changes="false" poll_intensity="0" min="-2147483648" max="2147483647" value="2" />
<Value type="int" genre="user" instance="1" index="1" label="Top Button Scene" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="-2147483648" max="2147483647" value="0" />
<Value type="int" genre="user" instance="1" index="2" label="Bottom Button Scene" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="-2147483648" max="2147483647" value="0" />
</CommandClass>
```
Below is a table of the action/scenes for the HomeSeer devices (as a reference for other similar devices):
**Action**|**scene\_id**|**scene\_data**
:-----:|:-----:|:-----:
Single tap on|1|0
Single tap off|2|0
Double tap on|1|3
Double tap off|2|3
Triple tap on|1|4
Triple tap off|2|4
Tap and hold on|1|2

451
source/_posts/2017-09-09-release-53.markdown Normal file
View File

@ -0,0 +1,451 @@
---
layout: post
title: "0.53: Tesla, Customize editor, and super fast KNX rewrite"
description: "Also now supports a text input UI component, Mopar and Geofency."
date: 2017-09-09 00:11:05
date_formatted: "September 9, 2017"
author: Paulus Schoutsen
author_twitter: balloob
comments: true
categories: Release-Notes
og_image: /images/blog/2017-09-0.53/components.png
---
<a href='/components/#version/0.53'><img src='/images/blog/2017-09-0.53/components.png' style='border: 0;box-shadow: none;'></a>
The Home Assistant community has been super busy in the last two weeks to bring you this amazing release. 60 different contributors have done over a 100 PRs filled with new features, bug fixes and performance improvements.
9 days away from our 4th birthday, we've just accomplished a couple of great milestones that I would love to share with you. We've hit over 8000 stars 🌟 on GitHub and starting this release we now ship over 800 platforms and components!
## Customize editor
Another step in making Home Assistant configurable via the frontend has been contributed by @andrey-git: a customization editor! You are now able to inspect all (possible) customizations of an entity and update them with just a few taps. Want to change the name or icon of an entity? All possible in mere seconds.
<p class='img'>
<img src='/images/blog/2017-09-0.53/customize-editor.png'>
Screenshot of the new customize editor.
</p>
New Home Assistant configurations will be created correctly automatically. If you are an existing user, make sure you have the config screen enabled and that you include customizations from `customize.yaml`.
```yaml
# Example configuration.yaml entry
homeassistant:
# Include the customizations.
customize: !include customize.yaml
# Enable the config screen
config:
```
## Tesla
Thanks to the contribution by @zabuldon, you will now be able to control your Tesla car from Home Assistant. You're able to check the temperature inside and outside your car, control your AC and unlock the car.
## Input text
This release introduces a new input component: `input_text` contributed by @BioSehnsucht. With this component you will be able to set free form from the UI and then let that be used by your automations or templates.
## KNX
This release ships a new KNX implementation thanks to @Julius2342. It will instantly show all changed states of KNX devices within Home Assistant. Additionally it brings support for HVAC devices and notification services. It also adds a service for direct communication with the KNX bus. You can connect to KNX/IP routing and tunnelling devices. In the background it uses asyncio communication. Check the climate integration in action [here](https://www.youtube.com/watch?v=JI0VJzlGpx4) and see the lights in action below:
<div class='videoWrapper'>
<iframe src="https://www.youtube.com/embed/Fe3yaflU2XM" frameborder="0" allowfullscreen></iframe>
</div>
## New Platforms
- Xiaomi Philips Lights integration ([@syssi] - [#9087]) ([light.xiaomi_philipslight docs]) (new-platform)
- Mycroft notify/component ([@btotharye] - [#9173]) ([mycroft docs]) ([notify.mycroft docs]) (new-platform)
- Add counter component ([@fabaff] - [#9146]) ([counter docs]) (new-platform)
- Support for season sensor ([@w1ll1am23] - [#8958]) ([sensor.season docs]) (new-platform)
- Abode push events and lock, cover, and switch components ([@1091741+MisterWil] - [#9095]) ([abode docs]) ([alarm_control_panel.abode docs]) ([binary_sensor.abode docs]) ([cover.abode docs]) ([lock.abode docs]) ([switch.abode docs]) (new-platform)
- Bayesian Binary Sensor ([@jlmcgehee21] - [#8810]) ([binary_sensor.bayesian docs]) (new-platform)
- Add Tank Utility sensor ([@krismolendyke] - [#9132]) ([sensor.tank_utility docs]) (new-platform)
- Tesla platform ([@zabuldon] - [#9211]) ([tesla docs]) ([binary_sensor.tesla docs]) ([climate.tesla docs]) ([device_tracker.tesla docs]) ([lock.tesla docs]) ([sensor.tesla docs]) (new-platform)
- mopar sensor ([@happyleavesaoc] - [#9136]) ([sensor.mopar docs]) (new-platform)
- Add Geofency device tracker ([@gunnarhelgason] - [#9106]) ([device_tracker.geofency docs]) (new-platform)
- Added DWD WarnApp Sensor ([@runningman84] - [#8657]) ([sensor.dwd_warnapp docs]) (new-platform)
- Add input_text component ([@BioSehnsucht] - [#9112]) ([input_text docs]) (new-platform)
- Introducing a media_player component for Yamaha Multicast devices ([@jalmeroth] - [#9258]) ([media_player.yamaha_musiccast docs]) (new-platform)
- Stable and asynchronous KNX library. ([@Julius2342] - [#8725]) ([knx docs]) ([binary_sensor.knx docs]) ([climate.knx docs]) ([cover.knx docs]) ([light.knx docs]) ([sensor.knx docs]) ([switch.knx docs]) (new-platform)
- Adds the AirVisual air quality sensor platform ([@bachya] - [#9320]) ([sensor.airvisual docs]) (new-platform)
## {% linkable_title If you need help... %}
...don't hesitate to use our very active [forums][forum] or join us for a little [chat][discord]. 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][issue]. Make sure to fill in all fields of the issue template.
<!--more-->
## Breaking Changes
- The new customize editor is using the file `customize.yaml` in your config folder. If you are using this file today for other config, make sure to rename it before using the new customize UI editor. ([@andrey-git] - [#9134]) ([config docs]) (breaking change) (new-platform)
- The frontend component now supports loading custom html files when Home Assistant front end starts ([@andrey-git] - [#9150]) (breaking change). It could be Javascript, CSS or custom Web Components. Along there was a breaking change in the way Custom UI is used:
* `custom_ui_state_card` now specifies the exact element name and not a suffix after `state-card`. So if you had `state_card_custom_ui: custom-ui` in your config, you should change it to `state_card_custom_ui: state-card-custom-ui`
* `custom_ui_state_card` no longer makes the html fetch, you should make it separately:
```
frontend:
extra_html_url:
- /local/custom_ui/state-card-custom-ui.html
```
- The Egardia alarm control panel now defaults to port 52010 instead of 85. ([@jeroenterheerdt] - [#9225]) ([alarm_control_panel.egardia docs]) (breaking change)
- The Homematic `delay` option has been dropped because it is no longer necessary ([@pvizeli] - [#9058]) ([homematic docs]) ([binary_sensor.homematic docs]) ([climate.homematic docs]) ([cover.homematic docs]) ([light.homematic docs]) ([sensor.homematic docs]) ([switch.homematic docs]) (breaking change)
- Switch - Dlink: Remove spaces and capital letters from attribute names for consistency ([@emlt] - [#9277]) ([switch.dlink docs]) (breaking change)
## All changes
- Xiaomi Philips Lights integration ([@syssi] - [#9087]) ([light.xiaomi_philipslight docs]) (new-platform)
- Backend changes for customize config panel. ([@andrey-git] - [#9134]) ([config docs]) (breaking change)
- Upgrade async_timeout to 1.3.0 ([@fabaff] - [#9156])
- Remove links to gitter ([@fabaff] - [#9155])
- Upgrade sphinx-autodoc-typehints to 1.2.3 ([@fabaff] - [#9151])
- Upgrade uber_rides to 0.5.2 ([@fabaff] - [#9149]) ([sensor.uber docs])
- Allow specifying custom html urls to load. ([@andrey-git] - [#9150]) (breaking change)
- Allow getting number of available states in template ([@balloob] - [#9158])
- upgrade xiaomi lib to 0.3.1 to supprt water sensor ([@danielhiversen] - [#9168]) ([xiaomi docs])
- Use node_modules gulp in script/build_frontend ([@armills] - [#9170])
- Mysensors nodes can be renamed in config file ([@EmitKiwi] - [#9123]) ([mysensors docs])
- Xiaomi gateway: Device support for the Aqara Water Leak Sensor (sensor_wleak.aq1) ([@syssi] - [#9172]) ([xiaomi docs]) ([binary_sensor.xiaomi docs])
- "TypeError: write_to_hub() takes 2 positional arguments but 4 were given" fixed. ([@syssi] - [#9174]) ([cover.xiaomi docs])
- Mycroft notify/component ([@btotharye] - [#9173]) ([mycroft docs]) ([notify.mycroft docs]) (new-platform)
- Fix dht22 when no data was read initially #8976 ([@maweki] - [#9198]) ([sensor.dht docs])
- Update pushbullet.py ([@bobnwk] - [#9200]) ([notify.pushbullet docs])
- fix worldtidesinfo #9184 ([@aetolus] - [#9201]) ([sensor.worldtidesinfo docs])
- Add "status" to Sonarr sensor ([@tboyce021] - [#9204]) ([sensor.radarr docs]) ([sensor.sonarr docs])
- Prevent error when no forecast data was available ([@mjj4791] - [#9176]) ([sensor.buienradar docs])
- Fix and optimize digitalloggers platform ([@dale3h] - [#9203]) ([switch.digitalloggers docs])
- Add counter component ([@fabaff] - [#9146]) ([counter docs]) (new-platform)
- Support for season sensor ([@w1ll1am23] - [#8958]) ([sensor.season docs]) (new-platform)
- Issue #6893 in rfxtrx ([@danielhiversen] - [#9130]) ([rfxtrx docs])
- Refactor rfxtrx ([@danielhiversen] - [#9117]) ([rfxtrx docs]) ([cover.rfxtrx docs]) ([light.rfxtrx docs]) ([switch.rfxtrx docs])
- Upgrade pymysensors to 0.11.1 ([@MartinHjelmare] - [#9212]) ([mysensors docs])
- Abode push events and lock, cover, and switch components ([@1091741+MisterWil] - [#9095]) ([abode docs]) ([alarm_control_panel.abode docs]) ([binary_sensor.abode docs]) ([cover.abode docs]) ([lock.abode docs]) ([switch.abode docs]) (new-platform)
- Add cloud auth support ([@balloob] - [#9208])
- Bayesian Binary Sensor ([@jlmcgehee21] - [#8810]) ([binary_sensor.bayesian docs]) (new-platform)
- directv: extended discovery via REST api, bug fix ([@sielicki] - [#8800]) ([media_player.directv docs])
- Upgrade pyasn1 to 0.3.3 and pyasn1-modules to 0.1.1 ([@fabaff] - [#9216]) ([notify.xmpp docs])
- Upgrade sendgrid to 5.0.1 ([@fabaff] - [#9215]) ([notify.sendgrid docs])
- Fix fitbit error when trying to access token after upgrade. ([@tchellomello] - [#9183]) ([sensor.fitbit docs])
- Allow sonos to select album as a source ([@commento] - [#9221]) ([media_player.sonos docs])
- Add max_age to statistics sensor ([@tinloaf] - [#8790]) ([sensor.statistics docs])
- Egardia package to .19 and change in port number for egardiaserver ([@jeroenterheerdt] - [#9225]) ([alarm_control_panel.egardia docs]) (breaking change)
- pushbullet, send a file from url ([@danielhiversen] - [#9189]) ([notify.pushbullet docs])
- Add Tank Utility sensor ([@krismolendyke] - [#9132]) ([sensor.tank_utility docs]) (new-platform)
- Upgrade shodan to 1.7.5 ([@fabaff] - [#9228]) ([sensor.shodan docs])
- Tesla platform ([@zabuldon] - [#9211]) ([tesla docs]) ([binary_sensor.tesla docs]) ([climate.tesla docs]) ([device_tracker.tesla docs]) ([lock.tesla docs]) ([sensor.tesla docs]) (new-platform)
- [light.tradfri] Full range of white spectrum lightbulbs support ([@matemaciek] - [#9224]) ([tradfri docs]) ([light.tradfri docs])
- Allow panels with external URL ([@andrey-git] - [#9214])
- Use ZCL mandatory attribute to determine ZHA light capabilities ([@jkl1337] - [#9232]) ([light.zha docs])
- A bugfix for pushbullet ([@danielhiversen] - [#9237]) ([notify.pushbullet docs])
- mopar sensor ([@happyleavesaoc] - [#9136]) ([sensor.mopar docs]) (new-platform)
- Upgrade discord.py to 0.16.11 ([@fabaff] - [#9239]) ([notify.discord docs])
- Skip automatic events older than latest data ([@armills] - [#9230]) ([device_tracker.automatic docs])
- title and message was swapped in pushbullet ([@danielhiversen] - [#9241]) ([notify.pushbullet docs])
- Fix possible KeyError ([@MartinHjelmare] - [#9242]) ([mysensors docs])
- WIP: Homematic improvments with new hass interfaces ([@pvizeli] - [#9058]) ([homematic docs]) ([binary_sensor.homematic docs]) ([climate.homematic docs]) ([cover.homematic docs]) ([light.homematic docs]) ([sensor.homematic docs]) ([switch.homematic docs]) (breaking change)
- Add available to sonos ([@pvizeli] - [#9243]) ([media_player.sonos docs])
- Make sure Ring binary_sensor state will update only if device_id matches ([@tchellomello] - [#9247]) ([binary_sensor.ring docs])
- Added configurable timeout for receiver HTTP requests | Additional AV… ([@scarface-4711] - [#9244]) ([media_player.denonavr docs])
- upgrade xiaomi lib ([@danielhiversen] - [#9250]) ([xiaomi docs])
- Fix nello.io login ([@pschmitt] - [#9251]) ([lock.nello docs])
- This is to fix #6386: Manual Alarm not re-arm after 2nd trigger ([@snjoetw] - [#9249]) ([alarm_control_panel.manual docs])
- Version bump of DLink switch to v0.6.0 ([@LinuxChristian] - [#9252]) ([switch.dlink docs])
- Upgrade sendgrid to 5.2.0 ([@fabaff] - [#9254]) ([notify.sendgrid docs])
- Upgrade psutil to 5.3.0 ([@fabaff] - [#9253]) ([sensor.systemmonitor docs])
- Adding ZWave CentralScene activation handler. ([@sirmalloc] - [#9178]) ([zwave docs])
- Add Geofency device tracker ([@gunnarhelgason] - [#9106]) ([device_tracker.geofency docs]) (new-platform)
- flux: fix for when stop_time is after midnight ([@abmantis] - [#8932])
- Change attribute names ([@emlt] - [#9277]) ([switch.dlink docs]) (breaking change)
- insteon_plm: fix typo in attributes ([@drkp] - [#9284]) ([insteon_plm docs])
- discovery: If unknown NetDisco service discovered, log about it. ([@pfalcon] - [#9280])
- Upgrade youtube_dl to 2017.9.2 ([@fabaff] - [#9279]) ([media_extractor docs])
- Upgrade python-telegram-bot to 8.0.0 ([@fabaff] - [#9282]) ([telegram_bot docs]) ([switch.rest docs])
- rfxtrx lib upgrade ([@danielhiversen] - [#9288]) ([rfxtrx docs])
- Fixing bug when using egardiaserver - package requirement updated to 1.0.20. ([@jeroenterheerdt] - [#9294]) ([alarm_control_panel.egardia docs])
- Added intent_type to exception log ([@andreasjacobsen93] - [#9289]) ([snips docs])
- Handle spotify failing to refresh access_token ([@Tommatheussen] - [#9295]) ([media_player.spotify docs])
- Core track same state for a period / Allow on platforms ([@pvizeli] - [#9273])
- Improved Lutron Caseta shade support ([@30200174+upsert] - [#9302]) ([lutron_caseta docs]) ([cover.lutron_caseta docs]) ([light.lutron_caseta docs]) ([switch.lutron_caseta docs])
- Upgrade mycroftapi to 2.0 ([@btotharye] - [#9309]) ([mycroft docs])
- Fix for Honeywell Round thermostats ([@dansarginson] - [#9308]) ([climate.honeywell docs])
- Update jinja to 2.9.6 ([@pvizeli] - [#9306])
- Ensure display-name does not exceed 12 characters for CecAdapter. ([@gollo] - [#9268]) ([hdmi_cec docs])
- Expose hue group 0 ([@filcole] - [#8663]) ([light.hue docs])
- Added DWD WarnApp Sensor ([@runningman84] - [#8657]) ([sensor.dwd_warnapp docs]) (new-platform)
- Add input_text component ([@BioSehnsucht] - [#9112]) ([input_text docs]) (new-platform)
- Introducing a media_player component for Yamaha Multicast devices ([@jalmeroth] - [#9258]) ([media_player.yamaha_musiccast docs]) (new-platform)
- Handle the case where no registration number is available (instead display VIN (vehicle identification number)). ([@molobrakos] - [#9073]) ([volvooncall docs]) ([device_tracker.volvooncall docs])
- Add post_pending_state attribute to manual alarm_control_panel ([@snjoetw] - [#9291]) ([alarm_control_panel.manual docs])
- Add new config variable to MQTT light ([@belyalov] - [#9304]) ([light.mqtt docs])
- Follow Twitter guidelines for media upload by conforming to the "STATUS" phase, when required, and by providing "media_category" information. These will, for example, allow users to upload videos that exceed the basic 30 second limit. ([@MikeChristianson] - [#9261]) ([notify.twitter docs])
- Optionally disable ssl certificate validity check. ([@1868995+ohmer1] - [#9181]) ([notify.xmpp docs])
- Version bump dlib to 1.0.0 ([@arsaboo] - [#9316]) ([image_processing.dlib_face_detect docs]) ([image_processing.dlib_face_identify docs])
- Fixed bug with devices not being discovered correctly. ([@1091741+MisterWil] - [#9311]) ([abode docs])
- Platform not ready behavior fixed. ([@syssi] - [#9325]) ([light.xiaomi_philipslight docs])
- Stable and asynchronous KNX library. ([@Julius2342] - [#8725]) ([knx docs]) ([binary_sensor.knx docs]) ([climate.knx docs]) ([cover.knx docs]) ([light.knx docs]) ([sensor.knx docs]) ([switch.knx docs]) (new-platform)
- Fix for potential issue with tesla initialization ([@zabuldon] - [#9307]) ([tesla docs])
- Adds the AirVisual air quality sensor platform ([@bachya] - [#9320]) ([sensor.airvisual docs]) (new-platform)
- Cleanup input_text ([@balloob] - [#9326]) ([input_text docs])
- Bump pyHik version to add IO support ([@mezz64] - [#9341]) ([binary_sensor.hikvision docs])
[#8657]: https://github.com/home-assistant/home-assistant/pull/8657
[#8663]: https://github.com/home-assistant/home-assistant/pull/8663
[#8725]: https://github.com/home-assistant/home-assistant/pull/8725
[#8790]: https://github.com/home-assistant/home-assistant/pull/8790
[#8800]: https://github.com/home-assistant/home-assistant/pull/8800
[#8810]: https://github.com/home-assistant/home-assistant/pull/8810
[#8932]: https://github.com/home-assistant/home-assistant/pull/8932
[#8958]: https://github.com/home-assistant/home-assistant/pull/8958
[#9058]: https://github.com/home-assistant/home-assistant/pull/9058
[#9073]: https://github.com/home-assistant/home-assistant/pull/9073
[#9087]: https://github.com/home-assistant/home-assistant/pull/9087
[#9095]: https://github.com/home-assistant/home-assistant/pull/9095
[#9106]: https://github.com/home-assistant/home-assistant/pull/9106
[#9112]: https://github.com/home-assistant/home-assistant/pull/9112
[#9117]: https://github.com/home-assistant/home-assistant/pull/9117
[#9123]: https://github.com/home-assistant/home-assistant/pull/9123
[#9130]: https://github.com/home-assistant/home-assistant/pull/9130
[#9132]: https://github.com/home-assistant/home-assistant/pull/9132
[#9134]: https://github.com/home-assistant/home-assistant/pull/9134
[#9136]: https://github.com/home-assistant/home-assistant/pull/9136
[#9146]: https://github.com/home-assistant/home-assistant/pull/9146
[#9149]: https://github.com/home-assistant/home-assistant/pull/9149
[#9150]: https://github.com/home-assistant/home-assistant/pull/9150
[#9151]: https://github.com/home-assistant/home-assistant/pull/9151
[#9155]: https://github.com/home-assistant/home-assistant/pull/9155
[#9156]: https://github.com/home-assistant/home-assistant/pull/9156
[#9158]: https://github.com/home-assistant/home-assistant/pull/9158
[#9168]: https://github.com/home-assistant/home-assistant/pull/9168
[#9170]: https://github.com/home-assistant/home-assistant/pull/9170
[#9172]: https://github.com/home-assistant/home-assistant/pull/9172
[#9173]: https://github.com/home-assistant/home-assistant/pull/9173
[#9174]: https://github.com/home-assistant/home-assistant/pull/9174
[#9176]: https://github.com/home-assistant/home-assistant/pull/9176
[#9178]: https://github.com/home-assistant/home-assistant/pull/9178
[#9181]: https://github.com/home-assistant/home-assistant/pull/9181
[#9183]: https://github.com/home-assistant/home-assistant/pull/9183
[#9189]: https://github.com/home-assistant/home-assistant/pull/9189
[#9198]: https://github.com/home-assistant/home-assistant/pull/9198
[#9200]: https://github.com/home-assistant/home-assistant/pull/9200
[#9201]: https://github.com/home-assistant/home-assistant/pull/9201
[#9203]: https://github.com/home-assistant/home-assistant/pull/9203
[#9204]: https://github.com/home-assistant/home-assistant/pull/9204
[#9208]: https://github.com/home-assistant/home-assistant/pull/9208
[#9211]: https://github.com/home-assistant/home-assistant/pull/9211
[#9212]: https://github.com/home-assistant/home-assistant/pull/9212
[#9214]: https://github.com/home-assistant/home-assistant/pull/9214
[#9215]: https://github.com/home-assistant/home-assistant/pull/9215
[#9216]: https://github.com/home-assistant/home-assistant/pull/9216
[#9221]: https://github.com/home-assistant/home-assistant/pull/9221
[#9224]: https://github.com/home-assistant/home-assistant/pull/9224
[#9225]: https://github.com/home-assistant/home-assistant/pull/9225
[#9228]: https://github.com/home-assistant/home-assistant/pull/9228
[#9230]: https://github.com/home-assistant/home-assistant/pull/9230
[#9232]: https://github.com/home-assistant/home-assistant/pull/9232
[#9237]: https://github.com/home-assistant/home-assistant/pull/9237
[#9239]: https://github.com/home-assistant/home-assistant/pull/9239
[#9241]: https://github.com/home-assistant/home-assistant/pull/9241
[#9242]: https://github.com/home-assistant/home-assistant/pull/9242
[#9243]: https://github.com/home-assistant/home-assistant/pull/9243
[#9244]: https://github.com/home-assistant/home-assistant/pull/9244
[#9247]: https://github.com/home-assistant/home-assistant/pull/9247
[#9249]: https://github.com/home-assistant/home-assistant/pull/9249
[#9250]: https://github.com/home-assistant/home-assistant/pull/9250
[#9251]: https://github.com/home-assistant/home-assistant/pull/9251
[#9252]: https://github.com/home-assistant/home-assistant/pull/9252
[#9253]: https://github.com/home-assistant/home-assistant/pull/9253
[#9254]: https://github.com/home-assistant/home-assistant/pull/9254
[#9258]: https://github.com/home-assistant/home-assistant/pull/9258
[#9261]: https://github.com/home-assistant/home-assistant/pull/9261
[#9268]: https://github.com/home-assistant/home-assistant/pull/9268
[#9273]: https://github.com/home-assistant/home-assistant/pull/9273
[#9277]: https://github.com/home-assistant/home-assistant/pull/9277
[#9279]: https://github.com/home-assistant/home-assistant/pull/9279
[#9280]: https://github.com/home-assistant/home-assistant/pull/9280
[#9282]: https://github.com/home-assistant/home-assistant/pull/9282
[#9284]: https://github.com/home-assistant/home-assistant/pull/9284
[#9288]: https://github.com/home-assistant/home-assistant/pull/9288
[#9289]: https://github.com/home-assistant/home-assistant/pull/9289
[#9291]: https://github.com/home-assistant/home-assistant/pull/9291
[#9294]: https://github.com/home-assistant/home-assistant/pull/9294
[#9295]: https://github.com/home-assistant/home-assistant/pull/9295
[#9302]: https://github.com/home-assistant/home-assistant/pull/9302
[#9304]: https://github.com/home-assistant/home-assistant/pull/9304
[#9306]: https://github.com/home-assistant/home-assistant/pull/9306
[#9307]: https://github.com/home-assistant/home-assistant/pull/9307
[#9308]: https://github.com/home-assistant/home-assistant/pull/9308
[#9309]: https://github.com/home-assistant/home-assistant/pull/9309
[#9311]: https://github.com/home-assistant/home-assistant/pull/9311
[#9316]: https://github.com/home-assistant/home-assistant/pull/9316
[#9320]: https://github.com/home-assistant/home-assistant/pull/9320
[#9325]: https://github.com/home-assistant/home-assistant/pull/9325
[#9326]: https://github.com/home-assistant/home-assistant/pull/9326
[#9341]: https://github.com/home-assistant/home-assistant/pull/9341
[@1091741+MisterWil]: https://github.com/1091741+MisterWil
[@1868995+ohmer1]: https://github.com/1868995+ohmer1
[@30200174+upsert]: https://github.com/30200174+upsert
[@BioSehnsucht]: https://github.com/BioSehnsucht
[@EmitKiwi]: https://github.com/EmitKiwi
[@Julius2342]: https://github.com/Julius2342
[@LinuxChristian]: https://github.com/LinuxChristian
[@MartinHjelmare]: https://github.com/MartinHjelmare
[@MikeChristianson]: https://github.com/MikeChristianson
[@Tommatheussen]: https://github.com/Tommatheussen
[@abmantis]: https://github.com/abmantis
[@aetolus]: https://github.com/aetolus
[@andreasjacobsen93]: https://github.com/andreasjacobsen93
[@andrey-git]: https://github.com/andrey-git
[@armills]: https://github.com/armills
[@arsaboo]: https://github.com/arsaboo
[@bachya]: https://github.com/bachya
[@balloob]: https://github.com/balloob
[@belyalov]: https://github.com/belyalov
[@bobnwk]: https://github.com/bobnwk
[@btotharye]: https://github.com/btotharye
[@commento]: https://github.com/commento
[@dale3h]: https://github.com/dale3h
[@danielhiversen]: https://github.com/danielhiversen
[@dansarginson]: https://github.com/dansarginson
[@drkp]: https://github.com/drkp
[@emlt]: https://github.com/emlt
[@fabaff]: https://github.com/fabaff
[@filcole]: https://github.com/filcole
[@gollo]: https://github.com/gollo
[@gunnarhelgason]: https://github.com/gunnarhelgason
[@happyleavesaoc]: https://github.com/happyleavesaoc
[@jalmeroth]: https://github.com/jalmeroth
[@jeroenterheerdt]: https://github.com/jeroenterheerdt
[@jkl1337]: https://github.com/jkl1337
[@jlmcgehee21]: https://github.com/jlmcgehee21
[@krismolendyke]: https://github.com/krismolendyke
[@matemaciek]: https://github.com/matemaciek
[@maweki]: https://github.com/maweki
[@mezz64]: https://github.com/mezz64
[@mjj4791]: https://github.com/mjj4791
[@molobrakos]: https://github.com/molobrakos
[@pfalcon]: https://github.com/pfalcon
[@pschmitt]: https://github.com/pschmitt
[@pvizeli]: https://github.com/pvizeli
[@runningman84]: https://github.com/runningman84
[@scarface-4711]: https://github.com/scarface-4711
[@sielicki]: https://github.com/sielicki
[@sirmalloc]: https://github.com/sirmalloc
[@snjoetw]: https://github.com/snjoetw
[@syssi]: https://github.com/syssi
[@tboyce021]: https://github.com/tboyce021
[@tchellomello]: https://github.com/tchellomello
[@tinloaf]: https://github.com/tinloaf
[@w1ll1am23]: https://github.com/w1ll1am23
[@zabuldon]: https://github.com/zabuldon
[abode docs]: https://home-assistant.io/components/abode/
[alarm_control_panel.abode docs]: https://home-assistant.io/components/alarm_control_panel.abode/
[alarm_control_panel.egardia docs]: https://home-assistant.io/components/alarm_control_panel.egardia/
[alarm_control_panel.manual docs]: https://home-assistant.io/components/alarm_control_panel.manual/
[binary_sensor.abode docs]: https://home-assistant.io/components/binary_sensor.abode/
[binary_sensor.bayesian docs]: https://home-assistant.io/components/binary_sensor.bayesian/
[binary_sensor.hikvision docs]: https://home-assistant.io/components/binary_sensor.hikvision/
[binary_sensor.homematic docs]: https://home-assistant.io/components/binary_sensor.homematic/
[binary_sensor.ring docs]: https://home-assistant.io/components/binary_sensor.ring/
[binary_sensor.tesla docs]: https://home-assistant.io/components/binary_sensor.tesla/
[binary_sensor.xiaomi docs]: https://home-assistant.io/components/binary_sensor.xiaomi/
[binary_sensor.knx docs]: https://home-assistant.io/components/binary_sensor.knx/
[climate.homematic docs]: https://home-assistant.io/components/climate.homematic/
[climate.honeywell docs]: https://home-assistant.io/components/climate.honeywell/
[climate.tesla docs]: https://home-assistant.io/components/climate.tesla/
[climate.knx docs]: https://home-assistant.io/components/climate.knx/
[cloud docs]: https://home-assistant.io/components/cloud/
[cloud.cloud_api docs]: https://home-assistant.io/components/cloud.cloud_api/
[cloud.const docs]: https://home-assistant.io/components/cloud.const/
[cloud.http_api docs]: https://home-assistant.io/components/cloud.http_api/
[cloud.util docs]: https://home-assistant.io/components/cloud.util/
[config docs]: https://home-assistant.io/components/config/
[config.customize docs]: https://home-assistant.io/components/config.customize/
[counter docs]: https://home-assistant.io/components/counter/
[cover.abode docs]: https://home-assistant.io/components/cover.abode/
[cover.homematic docs]: https://home-assistant.io/components/cover.homematic/
[cover.lutron_caseta docs]: https://home-assistant.io/components/cover.lutron_caseta/
[cover.rfxtrx docs]: https://home-assistant.io/components/cover.rfxtrx/
[cover.xiaomi docs]: https://home-assistant.io/components/cover.xiaomi/
[cover.knx docs]: https://home-assistant.io/components/cover.knx/
[device_tracker.automatic docs]: https://home-assistant.io/components/device_tracker.automatic/
[device_tracker.geofency docs]: https://home-assistant.io/components/device_tracker.geofency/
[device_tracker.tesla docs]: https://home-assistant.io/components/device_tracker.tesla/
[device_tracker.volvooncall docs]: https://home-assistant.io/components/device_tracker.volvooncall/
[hdmi_cec docs]: https://home-assistant.io/components/hdmi_cec/
[homematic docs]: https://home-assistant.io/components/homematic/
[image_processing.dlib_face_detect docs]: https://home-assistant.io/components/image_processing.dlib_face_detect/
[image_processing.dlib_face_identify docs]: https://home-assistant.io/components/image_processing.dlib_face_identify/
[input_text docs]: https://home-assistant.io/components/input_text/
[input_text docs]: https://home-assistant.io/components/input_text/
[insteon_plm docs]: https://home-assistant.io/components/insteon_plm/
[light.homematic docs]: https://home-assistant.io/components/light.homematic/
[light.hue docs]: https://home-assistant.io/components/light.hue/
[light.lutron_caseta docs]: https://home-assistant.io/components/light.lutron_caseta/
[light.mqtt docs]: https://home-assistant.io/components/light.mqtt/
[light.xiaomi_philipslight docs]: https://home-assistant.io/components/light.xiaomi_philipslight/
[light.rfxtrx docs]: https://home-assistant.io/components/light.rfxtrx/
[light.tradfri docs]: https://home-assistant.io/components/light.tradfri/
[light.xiaomi_philipslight docs]: https://home-assistant.io/components/light.xiaomi_philipslight/
[light.knx docs]: https://home-assistant.io/components/light.knx/
[light.zha docs]: https://home-assistant.io/components/light.zha/
[lock.abode docs]: https://home-assistant.io/components/lock.abode/
[lock.nello docs]: https://home-assistant.io/components/lock.nello/
[lock.tesla docs]: https://home-assistant.io/components/lock.tesla/
[lutron_caseta docs]: https://home-assistant.io/components/lutron_caseta/
[media_extractor docs]: https://home-assistant.io/components/media_extractor/
[media_player.denonavr docs]: https://home-assistant.io/components/media_player.denonavr/
[media_player.directv docs]: https://home-assistant.io/components/media_player.directv/
[media_player.sonos docs]: https://home-assistant.io/components/media_player.sonos/
[media_player.spotify docs]: https://home-assistant.io/components/media_player.spotify/
[media_player.yamaha_musiccast docs]: https://home-assistant.io/components/media_player.yamaha_musiccast/
[mycroft docs]: https://home-assistant.io/components/mycroft/
[mysensors docs]: https://home-assistant.io/components/mysensors/
[notify.discord docs]: https://home-assistant.io/components/notify.discord/
[notify.mycroft docs]: https://home-assistant.io/components/notify.mycroft/
[notify.pushbullet docs]: https://home-assistant.io/components/notify.pushbullet/
[notify.sendgrid docs]: https://home-assistant.io/components/notify.sendgrid/
[notify.twitter docs]: https://home-assistant.io/components/notify.twitter/
[notify.xmpp docs]: https://home-assistant.io/components/notify.xmpp/
[rfxtrx docs]: https://home-assistant.io/components/rfxtrx/
[sensor.airvisual docs]: https://home-assistant.io/components/sensor.airvisual/
[sensor.buienradar docs]: https://home-assistant.io/components/sensor.buienradar/
[sensor.dht docs]: https://home-assistant.io/components/sensor.dht/
[sensor.dwd_warnapp docs]: https://home-assistant.io/components/sensor.dwd_warnapp/
[sensor.fitbit docs]: https://home-assistant.io/components/sensor.fitbit/
[sensor.homematic docs]: https://home-assistant.io/components/sensor.homematic/
[sensor.mopar docs]: https://home-assistant.io/components/sensor.mopar/
[sensor.radarr docs]: https://home-assistant.io/components/sensor.radarr/
[sensor.season docs]: https://home-assistant.io/components/sensor.season/
[sensor.shodan docs]: https://home-assistant.io/components/sensor.shodan/
[sensor.sonarr docs]: https://home-assistant.io/components/sensor.sonarr/
[sensor.statistics docs]: https://home-assistant.io/components/sensor.statistics/
[sensor.systemmonitor docs]: https://home-assistant.io/components/sensor.systemmonitor/
[sensor.tank_utility docs]: https://home-assistant.io/components/sensor.tank_utility/
[sensor.tesla docs]: https://home-assistant.io/components/sensor.tesla/
[sensor.uber docs]: https://home-assistant.io/components/sensor.uber/
[sensor.worldtidesinfo docs]: https://home-assistant.io/components/sensor.worldtidesinfo/
[sensor.knx docs]: https://home-assistant.io/components/sensor.knx/
[snips docs]: https://home-assistant.io/components/snips/
[switch.abode docs]: https://home-assistant.io/components/switch.abode/
[switch.digitalloggers docs]: https://home-assistant.io/components/switch.digitalloggers/
[switch.dlink docs]: https://home-assistant.io/components/switch.dlink/
[switch.homematic docs]: https://home-assistant.io/components/switch.homematic/
[switch.lutron_caseta docs]: https://home-assistant.io/components/switch.lutron_caseta/
[switch.rest docs]: https://home-assistant.io/components/switch.rest/
[switch.rfxtrx docs]: https://home-assistant.io/components/switch.rfxtrx/
[switch.knx docs]: https://home-assistant.io/components/switch.knx/
[telegram_bot docs]: https://home-assistant.io/components/telegram_bot/
[tesla docs]: https://home-assistant.io/components/tesla/
[tradfri docs]: https://home-assistant.io/components/tradfri/
[volvooncall docs]: https://home-assistant.io/components/volvooncall/
[xiaomi docs]: https://home-assistant.io/components/xiaomi/
[knx docs]: https://home-assistant.io/components/knx/
[zwave docs]: https://home-assistant.io/components/zwave/
[forum]: https://community.home-assistant.io/
[issue]: https://github.com/home-assistant/home-assistant/issues
[discord]: https://discord.gg/c5DvZ4e

15
source/developers/frontend_creating_custom_ui.markdown
View File

@ -13,22 +13,27 @@ If you would like to use your own [State card](/developers/frontend_add_card/) w
Put the element source file and its dependencies in `www/custom_ui/` directory under your Home Assistant [configuration](/docs/configuration/) directory.
For example if creating a state card for the `light` domain named `my_custom_light_card` put `state-card-my_custom_light_card.html` in `www/custom_ui/`.
For example if creating a state card for the `light` domain named `my_custom_light_card` put `my_custom_light_card.html` in `www/custom_ui/`.
That file should implement `<state-card-my_custom_light_card>` tag with Polymer.
That file should implement `<my_custom_light_card>` tag with Polymer.
In `state-card-my_custom_light_card.html` you should use `<link rel="import">` to import all the dependencies **not** used by Home Assistant's UI.
In `my_custom_light_card.html` you should use `<link rel="import">` to import all the dependencies **not** used by Home Assistant's UI.
Do not import any dependencies used by the Home Assistant UI.
Importing those will work in `development: 1` mode, but will fail in production mode.
In the `customize:` section of the `configuration.yaml` file put `custom_ui_state_card: <element-name>`.
1) In the `customize:` section of the `configuration.yaml` file put `custom_ui_state_card: <element-name>`.
2) In the `frontend` section use `extra_html_url` to specify the URL to load.
For example:
```yaml
homeassistant:
customize:
- entity_id: light
light.bedroom:
custom_ui_state_card: my_custom_light_card
frontend:
extra_html_url:
- /local/custom_ui/my_custom_light_card.html
```
For more possibilities, see the [Custom UI section](/cookbook/#user-interface) on our Examples page.

BIN
source/images/blog/2017-09-0.53/components.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 33 KiB

BIN
source/images/blog/2017-09-0.53/customize-editor.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 24 KiB

BIN
source/images/screenshots/netatmo_api.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 55 KiB

After

Width:  |  Height:  |  Size: 29 KiB

BIN
source/images/screenshots/netatmo_app.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 143 KiB

After

Width:  |  Height:  |  Size: 21 KiB

BIN
source/images/screenshots/netatmo_create.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 221 KiB

After

Width:  |  Height:  |  Size: 18 KiB

BIN
source/images/supported_brands/airvisual.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 17 KiB

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

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 43 KiB

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

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 22 KiB

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

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 22 KiB

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

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.5 KiB

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

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 11 KiB