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-21 16:27:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'current' into next

Browse Source
This commit is contained in:
Paulus Schoutsen 2019-01-16 16:29:15 -08:00
commit db8aa47bd4
76 changed files with 1020 additions and 691 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
_config.yml
View File

@ -142,8 +142,8 @@ social:
# Home Assistant release details
current_major_version: 0
current_minor_version: 85
current_patch_version: 0
date_released: 2019-01-09
current_patch_version: 1
date_released: 2019-01-11
# Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it.

2
plugins/configuration.rb
View File

@ -2,7 +2,7 @@ module Jekyll
class ConfigurationBlock < Liquid::Block
TYPE_LINKS = {
'action' => '/docs/scripts/',
'device_class' => '/components/%{component}/#device-class',
'device_class' => '/docs/configuration/customizing-devices/#device-class',
'template' => '/docs/configuration/templating/',
'icon' => '/docs/configuration/customizing-devices/#icon',
}

2
source/_addons/homematic.markdown
View File

@ -118,7 +118,7 @@ homematic:
port: 2000
hmip:
host: core-homematic
port: 2001
port: 2010
```
## {% linkable_title Raspberry Pi3 %}

2
source/_addons/samba.markdown
View File

@ -37,7 +37,7 @@ workgroup:
default: "`WORKGROUP`"
type: string
username:
description: Username for logging in if guest login is not used.
description: Username for logging in.
required: true
type: string
password:

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

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: lupusec.jpg
logo: lupusec.png
ha_category: Alarm
ha_release: 0.83
ha_iot_class: "Local Polling"

46
source/_components/alexa.markdown
View File

@ -54,16 +54,16 @@ Additionally, note that at the time of this writing, your Alexa skill endpoint *
To get started with Alexa skills:
- Log in to [Amazon developer console][amazon-dev-console]
- Click the Alexa button at the top of the console
- Click the yellow "Add a new skill" button in the top right
- Skill Type: Custom Interaction Model (default)
- Name: Home Assistant
- Invocation name: home assistant (or be creative, up to you)
- Version: 1.0
- Endpoint:
- https
- `https://YOUR_HOST/api/alexa?api_password=YOUR_API_PASSWORD`
- Log in to [Amazon developer console][amazon-dev-console]
- Click the Alexa button at the top of the console
- Click the yellow "Add a new skill" button in the top right
- Skill Type: Custom Interaction Model (default)
- Name: Home Assistant
- Invocation name: home assistant (or be creative, up to you)
- Version: 1.0
- Endpoint:
- https
- `https://YOUR_HOST/api/alexa?api_password=YOUR_API_PASSWORD`
You can use this [specially sized Home Assistant logo][large-icon] as the large icon and [this one][small-icon] as the small one.
@ -103,14 +103,14 @@ WhereAreWeIntent where we are
This means that we can now ask Alexa things like:
- Alexa, ask Home Assistant where Paul is
- Alexa, ask Home Assistant where we are
- Alexa, ask Home Assistant where Paul is
- Alexa, ask Home Assistant where we are
## {% linkable_title Configuring Home Assistant %}
When activated, the Alexa component will have Home Assistant's native intent support handle the incoming intents. If you want to run actions based on intents, use the [`intent_script`](/components/intent_script) component.
To enable Alexa add the following entry to your `configuration.yaml` file:
To enable Alexa, add the following entry to your `configuration.yaml` file:
```yaml
alexa:
@ -222,15 +222,16 @@ intent_script:
Now say `Alexa ask Home Assistant to run <some script>` and Alexa will run that script for you.
### {% linkable_title Support for Launch Requests %}
There may be times when you want to respond to a launch request initiated from a command such as "Alexa, Red Alert!".
To start, you need to get the skill id:
- Log into [Amazon developer console][amazon-dev-console]
- Click the Alexa button at the top of the console
- Click the Alexa Skills Kit Get Started button
- Locate the skill for which you would like Launch Request support
- Click the "View Skill ID" link and copy the ID
- Log into [Amazon developer console][amazon-dev-console]
- Click the Alexa button at the top of the console
- Click the Alexa Skills Kit Get Started button
- Locate the skill for which you would like Launch Request support
- Click the "View Skill ID" link and copy the ID
The configuration is the same as an intent with the exception being you will use your skill ID instead of the intent name.
```yaml
@ -273,13 +274,13 @@ First create a file called `alexa_confirm.yaml` with something like the followin
Then, wherever you would put some simple text for a response like `OK`, replace it with a reference to the file so that:
```
```yaml
text: OK
```
becomes:
```
```yaml
text: !include alexa_confirm.yaml
```
@ -334,10 +335,9 @@ Please refer to the [Amazon documentation][flash-briefing-api-docs] for more inf
- All other settings are up to you
- Hit "Next"
- Test
- Having passed all validations to reach this screen, you can now click on "< Back to All Skills" as your flash briefing is now available as in "Development" service.
- Having passed all validations to reach this screen, you can now click on "< Back to All Skills" as your flash briefing is now available as in "Development" service.
- To invoke your flash briefing, open the Alexa app on your phone or go to the [Alexa Settings Site][alexa-settings-site], open the "Skills" configuration section, select "Your Skills", scroll to the bottom, tap on the Flash Briefing Skill you just created, enable it, then manage Flash Briefing and adjust ordering as necessary. Finally ask your Echo for your "news","flash briefing", or "briefing".
## {% linkable_title Smart Home %}
While the Skills API described above allows for arbitrary intents, all
@ -384,7 +384,7 @@ function to integrate this endpoint. See
[Haaska](https://github.com/mike-grant/haaska) for an example.
The `endpoint`, `client_id` and `client_secret` are optional, and are only required if you want to enable Alexa's proactive mode. Please note the following if you want to enable proactive mode:
- There are different endpoint urls, depending on the region of your skill. Please check the available endpoints at https://developer.amazon.com/docs/smarthome/send-events-to-the-alexa-event-gateway.html#endpoints
- There are different endpoint urls, depending on the region of your skill. Please check the available endpoints at <https://developer.amazon.com/docs/smarthome/send-events-to-the-alexa-event-gateway.html#endpoints>
- The `client_id` and `client_secret` are not the ones used by the skill that have been set up using "Login with Amazon" (in the Alexa Developer Console: Build > Account Linking), but rather from the "Alexa Skill Messaging" (in the Alexa Developer Console: Build > Permissions > Alexa Skill Messaging). To get them, you need to enable the "Send Alexa Events" permission.
- If the "Send Alexa Events" permission was not enabled previously, you need to unlink and relink the skill using the Alexa App, or else Home Assistant will show the following error: "Token invalid and no refresh token available."

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

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: lupusec.jpg
logo: lupusec.png
ha_category: Binary Sensor
ha_release: 0.83
ha_iot_class: "Local Polling"

4
source/_components/binary_sensor.mqtt.markdown
View File

@ -197,7 +197,3 @@ binary_sensor:
payload_on: "1"
payload_off: "0"
```
<<<<<<< HEAD
=======
>>>>>>> current

2
source/_components/climate.mqtt.markdown
View File

@ -21,7 +21,7 @@ It uses a sensor under the hood to obtain the current temperature.
## {% linkable_title Configuration %}
To enable this camera in your installation, add the following to your `configuration.yaml` file:
To enable this climate platform in your installation, first add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry

20
source/_components/climate.zwave.markdown
View File

@ -1,7 +1,7 @@
---
layout: page
title: "Z-Wave Climate"
description: "Instructions on how to setup the Z-Wave thermostat or HVAC within Home Assistant."
description: "Instructions on how to set up the Z-Wave thermostat or HVAC within Home Assistant."
date: 2016-04-03 9:52
sidebar: true
comments: false
@ -13,13 +13,12 @@ ha_release: 0.17
ha_iot_class: "Local Push"
---
To get your Z-Wave thermostat or HVAC unit working with Home Assistant, follow the instructions for the general [Z-Wave component](/getting-started/z-wave/).
<p class='note'>
Thermostats with support for fan modes or different operating modes, will be handled like a HVAC device and will also be detected as one.
Thermostats with support for fan modes or different operating modes, will be handled like a HVAC device and will also be detected as one.
If the thermostat support different operating modes, you will get one thermostat entity for each mode. These can be hidden with settings using the customize setting in the `configuration.yaml` file.
If the thermostat supports different operating modes, you will get one thermostat entity for each mode. These can be hidden with settings using the customize setting in the `configuration.yaml` file.
</p>
To enable the climate component for your Z-Wave network, add the following to your `configuration.yaml` file.
@ -31,10 +30,10 @@ climate:
Once enabled, any Z-Wave climate devices will be available to Home Assistant. Multiple entities may be created. The following entities are created for a Remotec ZXT-120.
- **climate.remotec_zxt120_heating_1_id** Allows you to control the connected device. See below for examples.
- **sensor.remotec_zxt120_temperature_38** A sensor which returns the current temperature set on the attached device.
- `climate.remotec_zxt120_heating_1_id`: Allows you to control the connected device. See below for examples.
- `sensor.remotec_zxt120_temperature_38`: A sensor which returns the current temperature set on the attached device.
### {% linkable_title Automating Z-Wave Climate Devices %}
## {% linkable_title Automating Z-Wave Climate Devices %}
The following examples will instruct a Remotec ZXT-120 to turn the attached device mode to Heating, and set the temperature at 24 degrees after 8pm. Add it to `automation.yaml`.
@ -55,7 +54,7 @@ automation:
temperature: 24
```
Generally in Home Assistant you can use the `homeassistant/turn_off` service to turn devices off. For the Remotec ZXT-120, you must instead make a service call like the following.
Generally, in Home Assistant, you can use the `homeassistant/turn_off` service to turn devices off. For the Remotec ZXT-120, you must instead make a service call like the following.
```yaml
automation:
@ -72,9 +71,9 @@ automation:
**Note:** In the example above, the word `Off` is encased in single quotes to be valid YAML.
### {% linkable_title Test if it works %}
## {% linkable_title Test if it works %}
A simple way to test if your Z-Wave climate device is working is to use <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 the applicable Climate service from the list of **Available services:** and enter something like the sample below into the **Service Data** field and then press **CALL SERVICE**.
A simple way to test if your Z-Wave climate device is working is to use <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 the applicable Climate service from the list of **Available services:** and enter something like the sample below into the **Service Data** field and then press **CALL SERVICE**.
```json
{
@ -82,4 +81,3 @@ A simple way to test if your Z-Wave climate device is working is to use <img src
"operation_mode": "Heat"
}
```

4
source/_components/cover.mqtt.markdown
View File

@ -67,7 +67,7 @@ payload_stop:
type: string
default: STOP
state_topic:
description: The MQTT topic subscribed to receive cover state messages. Use only if not using get_position_topic. State topic can only read open/close state. Cannot read position state.
description: The MQTT topic subscribed to receive cover state messages. Use only if not using `position_topic`. State topic can only read open/close state. Cannot read position state. If `position_topic` is set `state_topic` is ignored.
required: false
type: string
state_open:
@ -81,7 +81,7 @@ state_closed:
type: string
default: closed
position_topic:
description: The MQTT topic subscribed to receive cover position messages. Always in favor if used together with state_topic.
description: The MQTT topic subscribed to receive cover position messages. If `position_topic` is set `state_topic` is ignored.
required: false
type: integer
position_open:

1
source/_components/discovery.markdown
View File

@ -82,6 +82,7 @@ Valid values for ignore are:
* `frontier_silicon`: Frontier Silicon internet radios
* `google_cast`: Google Cast
* `harmony`: Logitech Harmony Hub
* `igd`: Internet Gateway Device
* `ikea_tradfri`: IKEA Trådfri (Tradfri)
* `logitech_mediaserver`: Logitech media server (Squeezebox)
* `netgear_router`: Netgear routers

1
source/_components/freebox.markdown
View File

@ -61,5 +61,6 @@ prompted to do so.
### {% linkable_title Supported routers %}
Only the routers with Freebox OS are supported:
* Freebox V7 also known as Freebox Delta
* Freebox V6 also known as Freebox Revolution
* Freebox mini 4k

2
source/_components/fritzbox.markdown
View File

@ -43,7 +43,7 @@ devices:
host:
description: The hostname or IP address of the Fritzbox.
required: true
type: optional
type: string
username:
description: The username for Smart Home access.
required: true

2
source/_components/google_assistant.markdown
View File

@ -179,7 +179,7 @@ entity_config:
Currently, the following domains are available to be used with Google Assistant, listed with their default types:
- group (on/off)
- input boolean (on/off)
- input_boolean (on/off)
- scene (on)
- script (on)
- switch (on/off)

2
source/_components/http.markdown
View File

@ -27,7 +27,7 @@ http:
{% configuration %}
api_password:
description: Protect the Home Assistant API with a password - this password can also be used to log in to the frontend. Where possible you should use a long lasting access token instead of this.
description: Protect the Home Assistant API with a password - this password can also be used to log in to the frontend. Where your client or other software supports it, you should use [long lasting access token](/docs/authentication/#your-account-profile) instead, as [shown in the REST API](https://developers.home-assistant.io/docs/en/external_api_rest.html) and [websocket API](https://developers.home-assistant.io/docs/en/external_api_websocket.html) documentation.
required: false
type: string
server_host:

2
source/_components/hue.markdown
View File

@ -47,7 +47,7 @@ filename:
required: false
type: string
allow_hue_groups:
description: Enable this to stop Home Assistant from importing the groups defined on the Hue bridge.
description: Disable this to stop Home Assistant from importing the groups defined on the Hue bridge.
required: false
type: boolean
{% endconfiguration %}

44
source/_components/input_text.markdown
View File

@ -70,6 +70,50 @@ input_text:
default: text
{% endconfiguration %}
### {% linkable_title Services %}
This components provide three services to modify the state of the `input_text`.
| Service | Data | Description |
| ------- | ---- | ----------- |
| `set_value` | `value`<br>`entity_id(s)` | Set the value for specific `input_text` entities.
### {% linkable_title Restore State %}
This component will automatically restore the state it had prior to Home Assistant stopping as long as your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`.
## {% linkable_title Automation Examples %}
Here's an example using `input_text` in an action in an automation.
{% raw %}
```yaml
# Example configuration.yaml entry using 'input_text' in an action in an automation
input_select:
scene_bedroom:
name: Scene
options:
- Select
- Concentrate
- Energize
- Reading
- Relax
- 'OFF'
initial: 'Select'
input_text:
bedroom:
name: Brightness
automation:
- alias: Bedroom Light - Custom
trigger:
platform: state
entity_id: input_select.scene_bedroom
action:
- service: input_text.set_value
# Again, note the use of 'data_template:' rather than the normal 'data:' if you weren't using an input variable.
data_template:
entity_id: input_text.bedroom
value: "{{ states('input_select.scene_bedroom') }}"
```
{% endraw %}

54
source/_components/intent_script.markdown
View File

@ -26,12 +26,54 @@ intent_script:
data_template:
message: Hello from an intent!
```
Configuration variables:
Inside an intent we can define these variables:
- **intent** (*Required*): Name of the intent. Multiple entries are possible.
- **speech** (*Optional*): Text or template to return.
- **action** (*Optional*): [Script syntax](/docs/scripts/).
- **async_action** (*Optional*): Set to True to have Home Assistant not wait for the script to finish before returning the intent response.
{% configuration %}
intent:
description: Name of the intent. Multiple entries are possible.
required: true
type: map
keys:
action:
description: Defines an action to run to intents.
required: false
type: action
async_action:
description: Set to True to have Home Assistant not wait for the script to finish before returning the intent response.
required: false
default: false
type: boolean
card:
description: Card to display.
required: false
type: map
keys:
type:
description: Type of card to display.
required: false
default: simple
type: string
title:
description: Title of the card to display.
required: true
type: template
content:
description: Contents of the card to display.
required: true
type: template
speech:
description: Text or template to return.
required: false
type: map
keys:
type:
description: Type of speech.
required: false
default: plain
type: string
text:
description: Text to speech.
required: true
type: template
{% endconfiguration %}

2
source/_components/keyboard.markdown
View File

@ -35,7 +35,7 @@ You may need to install platform-specific [dependencies for PyUserInput](https:/
pip3 install [package name]
```
#### {% linkable_title Windows %}
### {% linkable_title Windows %}
x64 Windows users may have trouble installing pywin through pip. Using an [executable installer](http://sourceforge.net/projects/pywin32/files/pywin32/) should work around this issue.

8
source/_components/light.mqtt.markdown
View File

@ -82,6 +82,10 @@ brightness_value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the brightness value."
required: false
type: string
color_temp_command_template:
description: "Defines a [template](/docs/configuration/templating/) to compose message which will be sent to `color_temp_command_topic`. Available variables: `value`."
required: false
type: string
color_temp_command_topic:
description: The MQTT topic to publish commands to change the light’s color temperature state. The color temperature command slider has a range of 153 to 500 mireds (micro reciprocal degrees).
required: false
@ -91,7 +95,7 @@ color_temp_state_topic:
required: false
type: string
color_temp_value_template:
description: "Defines a [template](/topics/templating/) to extract the color temperature value."
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the color temperature value."
required: false
type: string
effect_command_topic:
@ -155,7 +159,7 @@ retain:
type: boolean
default: false
rgb_command_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to compose message which will be sent to `rgb_command_topic`. Available variables: `red`, `green` and `blue`."
description: "Defines a [template](/docs/configuration/templating/) to compose message which will be sent to `rgb_command_topic`. Available variables: `red`, `green` and `blue`."
required: false
type: string
rgb_command_topic:

3
source/_components/light.tplink.markdown
View File

@ -22,6 +22,9 @@ Supported units:
- LB120
- LB130
- LB230
- KL110
- KL120
- KL130
To use your TP-Link light in your installation, add the following to your `configuration.yaml` file:

18
source/_components/light.yeelight.markdown
View File

@ -13,14 +13,28 @@ ha_release: 0.32
ha_iot_class: "Local Polling"
---
The `yeelight` light platform allows you to control your Yeelight Wifi bulbs with Home Assistant.
The `yeelight` light platform allows you to control your Yeelight Wifi bulbs with Home Assistant. There are two possible methods for configuration of the Yeelight: Manual or Automatic.
### {% linkable_title Example configuration %}
### {% linkable_title Example configuration (Automatic) %}
After the lights are connected to the WiFi network and have been detected in Home Assistant, the discovered names will be shown in the `Light` section of the `Overview` view. Add the following lines to your `customize.yaml` file:
```yaml
# Example customize.yaml entry
light.yeelight_rgb_XXXXXXXXXXXX:
friendly_name: Living Room
light.yeelight_color2_XXXXXXXXXXXX:
friendly_name: Downstairs Toilet
```
### {% linkable_title Example configuration (Manual) %}
To enable those lights, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
discovery:
ignore:
- yeelight
light:
- platform: yeelight
devices:

10
source/_components/lupusec.markdown
View File

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: lupusec.jpg
logo: lupusec.png
ha_category: Hub
ha_release: 0.83
ha_iot_class: "Local Polling"
@ -15,6 +15,10 @@ ha_iot_class: "Local Polling"
The `lupusec` component allows the user to integrate their Lupusec alarm control panel and ultimately all connected sensors and other devices. For more information about the LUPUS-Electronics security system please visit their [website](https://www.lupus-electronics.de).
Supported units:
- Lupusec XT1
The following devices are supported by the underlying `lupupy` Python library and integrated into Home Assistant.
- [Alarm Control Panel](/components/alarm_control_panel.lupusec/): Displays the alarm status and controls arming, disarming and home modus.
@ -30,7 +34,7 @@ To use Lupusec devices in your installation, add the following `lupusec` section
lupusec:
username: YOUR_USERNAME
password: YOUR_PASSWORD
ip_address: 192.168.178.35
ip_address: YOUR_IP_ADDRESS
```
{% configuration %}
@ -43,7 +47,7 @@ password:
required: true
type: string
ip_address:
description: The IP-address of your Lupusec alarm panel.
description: The IP address of your Lupusec alarm panel.
required: true
type: string
name:

2
source/_components/media_player.webostv.markdown
View File

@ -128,7 +128,7 @@ media_player:
turn_on_action:
service: wake_on_lan.send_magic_packet
data:
mac: "B4-E6-2A-1E-11-0F"
mac: "B4:E6:2A:1E:11:0F"
```
Any other [actions](/docs/automation/action/) to power on the device can be

15
source/_components/notify.free_mobile.markdown
View File

@ -36,13 +36,14 @@ notify:
username: YOUR_ACCOUNT_ID
access_token: TOKEN
```
{% configuration %}
username:
username:
description: This is the id given by FreeMobile to access to your online account.
required: true
type: string
access_token:
description: You can get this token by activating the SMS API in your online account.
required: true
type: string
required: true
type: string
access_token:
description: You can get this token by activating the SMS API in your online account.
required: true
type: string
{% endconfiguration %}

15
source/_components/notify.group.markdown
View File

@ -15,12 +15,12 @@ ha_qa_scale: internal
The `group` notification platform allows you to combine multiple `notify` platforms into a single service.
To use this notification platform in your installation, add the following to your `configuration.yaml` file:
## {% linkable_title Configuration %}
```yaml
# Example configuration.yaml entry
notify:
- name: NOTIFIER_NAME
- name: NAME_OF_NOTIFIER_GROUP
platform: group
services:
- service: html5
@ -48,3 +48,14 @@ services:
required: false
type: string
{% endconfiguration %}
## {% linkable_title Example %}
An example on how to use it in an automation:
```yaml
action:
service: notify.NAME_OF_NOTIFIER_GROUP
data:
message: "The sun is {% if is_state('sun.sun', 'above_horizon') %}up{% else %}down{% endif %}!"
```

6
source/_components/plum_lightpad.markdown
View File

@ -26,12 +26,6 @@ Configurable/Dimmable WiFi Lightswitch
- Wifi & Bluetooth connectivity
- Phone Apps for iOS & Android
"The most advanced smart dimmer. Ever." - [https://plumlife.com/](https://plumlife.com/)
> The Lightpad’s elegant design compliments any decor and provides amazing control of your lights. The Lightpad allows you to control a single light, group of lights, or all of your lights in a natural and intuitive way.
> Control your lights, not just with your smartphone and your voice (with Alexa and Google Assistant), but with your fingertips too. While most home automation devices today force you to use your smartphone, Plum Lightpads feature Multi-Touch allowing you to use simple gestures to control any light in the house from any Lightpad.
## {% linkable_title Configuration %}
To enable Plum Lightpad support, add the following lines to your `configuration.yaml` file:

2
source/_components/point.markdown
View File

@ -15,7 +15,7 @@ ha_iot_class: "Cloud Polling"
ha_qa_scale: silver
---
The Point component is the main component to integrate the [Minut Point](https://minut.se/). To connect Point, you will have to [sign up for a developer account](https://minut.com/community/developers/) and get a `client_id` and `client_secret` using the `callback url` as `base_url` + `/api/minut` eg. `http://localhost:8123/api/minut`. The `client_id` and `client_secret` should be used as below.
The Point component is the main component to integrate the [Minut Point](https://minut.com/). To connect Point, you will have to [sign up for a developer account](https://minut.com/community/developers/) and get a `client_id` and `client_secret` using the `callback url` as `base_url` + `/api/minut` eg. `http://localhost:8123/api/minut`. The `client_id` and `client_secret` should be used as below.
Once Home Assistant is started, a configurator will pop up asking you to Authenticate your Point account via a link when you follow the link and have clicked on **Accept** you will be redirected to the `callback url` and the Point integration will be automatically configured and you can go back to the original dialog and press **Submit**.

21
source/_components/sensor.gitlab_ci.markdown
View File

@ -13,12 +13,13 @@ ha_release: 0.80
ha_iot_class: "Cloud Polling"
---
The GitLab_CI sensor integrates results reported by CI/CD Pipeline Jobs in [GitLab](https://gitlab.com/).
The `gitlab_ci` sensor platform integrates results reported by CI/CD Pipeline Jobs in [GitLab](https://gitlab.com/).
## {% linkable_title Setup %}
You will need a GitLab repository ID. On the "Details" page for your GitLab repo, just below the project name is "Project ID:"
Alternatively, you can use "{GitLab_Username}/{GitLab_RepositoryName}", ex: "MyCoolUsername/MyCoolRepository"
You will need a GitLab repository ID. On the **Details** page for your GitLab repo, just below the project name is **Project ID:**.
Alternatively, you can use `GitLab_Username/GitLab_RepositoryName`, e.g., `MyCoolUsername/MyCoolRepository`.
A GitLab token with at least the API permission scope is needed, which can be created on the [GitLab Personal Access Tokens](https://gitlab.com/profile/personal_access_tokens) page of your GitLab User Settings.
@ -30,25 +31,27 @@ To enable this platform, please add the following to your `configuration.yaml` f
# Example configuration.yaml entry
sensor:
- platform: gitlab_ci
gitlab_id: '1234567'
token: 'aaaaaaaaaaAAAAAAAAAA'
gitlab_id: YOUR_GITLAB_ID
token: YOUR_GITLAB_TOKEN
```
{% configuration %}
gitlab_id:
description: GitLab repository ID or "username/repository"
description: The GitLab repository identifier.
required: true
type: string
token:
description: GitLab API Token
description: The GitLab API token.
required: true
type: string
name:
description: Sensor name as it appears in Home Assistant. Defaults to 'GitLab CI Status'.
description: Sensor name as it appears in Home Assistant.
required: false
type: string
default: GitLab CI Status
url:
description: GitLab repository URL. Defaults to 'https://gitlab.com'. Used for self-hosted repositories.
description: The GitLab repository URL. Used for self-hosted repositories.
required: false
type: string
default: https://gitlab.com
{% endconfiguration %}

2
source/_components/sensor.solaredge.markdown
View File

@ -16,7 +16,7 @@ ha_iot_class: "Cloud Polling"
The `solaredge` platform uses the [SolarEdge Monitoring API](https://www.solaredge.com/sites/default/files/se_monitoring_api.pdf) to allow you to get details from your SolarEdge solar power setup and integrate these in your Home Assistant installation.
<p class='note'>
The SolarEdge Monitoring API has a daily rate limit of 300 requests. In order to stay under this limit, and alow for some additional requests, the `solaredge` platform will update the site overview every 5 minutes.
The SolarEdge Monitoring API has a daily rate limit of 300 requests. In order to stay under this limit, and alow for some additional requests, the `solaredge` platform will update the site overview every 10 minutes.
</p>
## {% linkable_title Configuration %}

26
source/_components/sensor.sql.markdown
View File

@ -68,7 +68,7 @@ queries:
## {% linkable_title Examples %}
In this section you find some real-life examples of how to use this sensor.
In this section, you find some real-life examples of how to use this sensor.
### {% linkable_title Current state of an entity %}
@ -81,7 +81,7 @@ sensor:
unit_of_measurement: '°C'
```
The query will look like this:
The query will look like this:
```sql
SELECT * FROM states WHERE entity_id = 'sensor.temperature_in' ORDER BY state_id DESC LIMIT 1;
@ -99,7 +99,6 @@ sensor:
```
{% endraw %}
Note that the SQL sensor state corresponds to the last row of the SQL result set.
### {% linkable_title Previous state of an entity %}
@ -107,7 +106,7 @@ Note that the SQL sensor state corresponds to the last row of the SQL result set
This example only works with *binary_sensors*:
```sql
SELECT * FROM states WHERE entity_id='binary_sensor.xyz789' GROUP BY state ORDER BY last_changed DESC LIMIT 1;
SELECT * FROM states WHERE entity_id = 'binary_sensor.xyz789' GROUP BY state ORDER BY last_changed DESC LIMIT 1;
```
### {% linkable_title Database size %}
@ -116,13 +115,14 @@ SELECT * FROM states WHERE entity_id='binary_sensor.xyz789' GROUP BY state ORDER
{% raw %}
```yaml
- platform: sql
sensor:
- platform: sql
db_url: postgresql://user:password@host/dbname
queries:
- name: DB size
query: "SELECT (pg_database_size('dsmrreader')/1024/1024) as db_size;"
column: "db_size"
unit_of_measurement: MB
unit_of_measurement: MB
```
{% endraw %}
@ -131,12 +131,12 @@ SELECT * FROM states WHERE entity_id='binary_sensor.xyz789' GROUP BY state ORDER
{% raw %}
```yaml
sensor:
- platform: sql
db_url: mysql://user:password@localhost/hass
queries:
- name: DB size
query: 'SELECT table_schema "database", Round(Sum(data_length + index_length) / 1024, 1) "value" FROM information_schema.tables WHERE table_schema="hass" GROUP BY table_schema;'
column: 'value'
unit_of_measurement: kB
- platform: sql
db_url: mysql://user:password@localhost/hass
queries:
- name: DB size
query: 'SELECT table_schema "database", Round(Sum(data_length + index_length) / 1024, 1) "value" FROM information_schema.tables WHERE table_schema="hass" GROUP BY table_schema;'
column: 'value'
unit_of_measurement: kB
```
{% endraw %}

17
source/_components/sensor.template.markdown
View File

@ -55,7 +55,7 @@ sensor:
required: false
type: string, list
unit_of_measurement:
description: "Defines the units of measurement of the sensor, if any. This will also influence the graphical presentation in the history visualisation as continuous value. Sensors with missing `unit_of_measurement` are showing as discrete values."
description: "Defines the units of measurement of the sensor, if any. This will also influence the graphical presentation in the history visualization as a continuous value. Sensors with missing `unit_of_measurement` are showing as discrete values."
required: false
type: string
default: None
@ -80,18 +80,19 @@ sensor:
## {% linkable_title Considerations %}
### Startup
### {% linkable_title Startup %}
If you are using the state of a platform that takes extra time to load, the Template Sensor may get an `unknown` state during startup. To avoid this (and the resulting error messages in your log file), you can use `is_state()` function in your template. For example, you would replace {% raw %}`{{ states.switch.source.state == 'on' }}`{% endraw %} with this equivalent that returns `true`/`false` and never gives an `unknown` result:
{% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %}
### Entity IDs
### {% linkable_title Entity IDs %}
The template engine will attempt to work out what entities should trigger an update of the sensor. This can fail, for example if your template loops over the contents of a group. In this case you can use `entity_id` to provide a list of entity IDs that will cause the sensor to update or you can run the service `homeassistant.update_entity` to update the sensor at will.
The template engine will attempt to work out what entities should trigger an update of the sensor. This can fail, for example, if your template loops over the contents of a group. In this case, you can use `entity_id` to provide a list of entity IDs that will cause the sensor to update or you can run the service `homeassistant.update_entity` to update the sensor at will.
## {% linkable_title Examples %}
In this section you find some real-life examples of how to use this sensor.
In this section, you find some real-life examples of how to use this sensor.
### {% linkable_title Sun Angle %}
@ -111,7 +112,7 @@ sensor:
### {% linkable_title Renaming Sensor Output %}
If you don't like the wording of a sensor output then the Template Sensor can help too. Let's rename the output of the [Sun component](/components/sun/) as
If you don't like the wording of a sensor output, then the Template Sensor can help too. Let's rename the output of the [Sun component](/components/sun/) as
a simple example:
{% raw %}
@ -156,7 +157,7 @@ sensor:
### {% linkable_title Change The Unit of Measurement %}
With a Template Sensor it's easy to convert given values into others if the unit of measurement doesn't fit your needs.
With a Template Sensor, it's easy to convert given values into others if the unit of measurement doesn't fit your needs.
{% raw %}
```yaml
@ -267,7 +268,7 @@ sensor:
```
{% endraw %}
Useful entities to choose might be `sensor.date` which update once per day, or `sensor.time` which updates once per minute.
Useful entities to choose might be `sensor.date` which update once per day or `sensor.time` which updates once per minute.
An alternative to this is to create an interval-based automation that calls the service `homeassistant.update_entity` for the entities requiring updates. This modified example updates every 5 minutes:

2
source/_components/switch.lupusec.markdown
View File

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: lupusec.jpg
logo: lupusec.png
ha_category: Switch
ha_release: 0.83
ha_iot_class: "Local Polling"

19
source/_components/switch.vultr.markdown
View File

@ -13,13 +13,13 @@ ha_release: "0.58"
ha_iot_class: "Cloud Polling"
---
The `vultr` switch platform allows you to control (start/stop) your [Vultr](https://www.vultr.com/) subscription.
The `vultr` switch platform allows you to control (start/stop) your
[Vultr](https://www.vultr.com/) subscription.
To control your Vultr subscription, you first have to set up your [Vultr hub](/components/vultr/).
To control your Vultr subscription, you first have to set up
your [Vultr hub](/components/vultr/).
<p class='note'>
The following examples assume a subscription that has an ID of `123456` and a label of `Web Server`
</p>
## {% linkable_title Configuration %}
Minimal `configuration.yaml` (produces `switch.vultr_web_server`):
@ -27,7 +27,7 @@ Minimal `configuration.yaml` (produces `switch.vultr_web_server`):
# Example configuration.yaml entry
switch:
- platform: vultr
subscription: 123456
subscription: YOUR_SUBSCRIPTION_ID
```
{% configuration %}
@ -42,14 +42,15 @@ name:
type: string
{% endconfiguration %}
## {% linkable_title Additional Examples %}
Full `configuration.yaml` (produces `switch.amazing_server`):
Full example that produces `switch.amazing_server`, assuming a subscription
that has an ID of `123456` and a label of `Web Server`:
```yaml
# Example configuration.yaml entry
switch:
- platform: vultr
name: Amazing Server
subscription: 123456
```

1
source/_components/switch.wemo.markdown
View File

@ -12,7 +12,6 @@ ha_category: Switch
ha_iot_class: "Local Push"
---
The `wemo` platform allows you to control your [Belkin WeMo](http://www.belkin.com/us/p/P-F7C027/) switches from within Home Assistant. This includes support for Wemo enabled [Mr. Coffee](http://www.mrcoffee.com/wemo-landing-page.html) smart coffee makers.
WeMo devices are automatically discovered if the `discovery` component is enabled. For more configuration information, see the [WeMo component](/components/wemo/) documentation.

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

@ -13,18 +13,15 @@ ha_release: pre 0.7
ha_iot_class: "Cloud Polling"
---
The Wink switch platform allows you to control your [Wink](http://www.wink.com/) switches.
The requirement is that you have setup [Wink](/components/wink/).
The requirement is that you have set up [Wink](/components/wink/).
### Supported switch devices
## {% linkable_title Supported switch devices %}
- Wink Pivot power genius (No Wink hub required)
- non-dimming Z-wave in wall switches (dimming switches show up as lights)
- non-dimming Z-wave in-wall switches (dimming switches show up as lights)
- Wink Relay load controlling switches
- Rachio sprinkler controller (No Wink hub required)
- iHome smart plug (No Wink hub required)
- Wink switch groups (User created groups of switches)

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

@ -1,7 +1,7 @@
---
layout: page
title: "Xiaomi Switch"
description: "Instructions on how to setup the Xiaomi switch within Home Assistant."
description: "Instructions on how to set up the Xiaomi switch within Home Assistant."
date: 2017-07-21 16:34
sidebar: true
comments: false
@ -13,8 +13,6 @@ ha_release: "0.50"
ha_iot_class: "Local Push"
---
The `xiaomi_aqara` switch platform allows you to get data from your [Xiaomi aqara](http://www.mi.com/en/) switches.
The `xiaomi aqara` switch platform allows you to get data from your [Xiaomi aqara](http://www.mi.com/en/) switches.
The requirement is that you have setup [Xiaomi aqara](/components/xiaomi_aqara/).
The requirement is that you have set up [Xiaomi aqara](/components/xiaomi_aqara/).

42
source/_components/switch.xiaomi_miio.markdown
View File

@ -17,50 +17,50 @@ The `xiaomi_miio` switch platform allows you to control the state of your Xiaomi
Please follow the instructions on [Retrieving the Access Token](/components/vacuum.xiaomi_miio/#retrieving-the-access-token) to get the API token to use in the `configuration.yaml` file.
## Features
## {% linkable_title Features %}
### Xiaomi Smart WiFi Socket
### {% linkable_title Xiaomi Smart WiFi Socket %}
Supported models: `chuangmi.plug.m1`, `chuangmi.plug.m3`, `chuangmi.plug.v2`, `chuangmi.plug.hmi205`
* Power (on, off)
* Attributes
- Power (on, off)
- Attributes
- Temperature
### Xiaomi Chuangmi Plug V1
### {% linkable_title Xiaomi Chuangmi Plug V1 %}
Supported models: `chuangmi.plug.v1`, `chuangmi.plug.v3`
* Power (on, off)
* USB (on, off)
* Attributes
- Power (on, off)
- USB (on, off)
- Attributes
- Temperature
### Xiaomi Smart Power Strip
### {% linkable_title Xiaomi Smart Power Strip %}
Supported models: `qmi.powerstrip.v1`, `zimi.powerstrip.v2`
* Power (on, off)
* Wifi LED (on, off)
* Power Price (0...999)
* Power Mode (green, normal) (Power Strip V1 only)
* Attributes
- Power (on, off)
- Wifi LED (on, off)
- Power Price (0...999)
- Power Mode (green, normal) (Power Strip V1 only)
- Attributes
- Temperature
- Current
- Load power
- Wifi LED
- Mode (Power Strip V1 only)
## {% linkable_title Configuration %}
To add a plug to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entries
switch:
- platform: xiaomi_miio
name: Original Xiaomi Mi Smart WiFi Socket
host: 192.168.130.59
host: MIIO_IP_ADDRESS
token: YOUR_TOKEN
model: chuangmi.plug.m1
```
{% configuration %}
@ -91,7 +91,7 @@ Turn the wifi led on.
| Service data attribute | Optional | Description |
|---------------------------|----------|---------------------------------------------------------|
| `entity_id` | yes | Only act on a specific xiaomi miio switch entity. Else targets all. |
| `entity_id` | yes | Only act on a specific Xiaomi miio switch entity. Else targets all. |
### {% linkable_title Service `switch.xiaomi_miio_set_wifi_led_off` %} (Power Strip only)
@ -99,7 +99,7 @@ Turn the wifi led off.
| Service data attribute | Optional | Description |
|---------------------------|----------|---------------------------------------------------------|
| `entity_id` | yes | Only act on a specific xiaomi miio switch entity. Else targets all. |
| `entity_id` | yes | Only act on a specific Xiaomi miio switch entity. Else targets all. |
### {% linkable_title Service `switch.xiaomi_miio_set_power_price` %} (Power Strip)
@ -107,7 +107,7 @@ Set the power price.
| Service data attribute | Optional | Description |
|---------------------------|----------|---------------------------------------------------------|
| `entity_id` | yes | Only act on a specific xiaomi miio switch entity. Else targets all. |
| `entity_id` | yes | Only act on a specific Xiaomi miio switch entity. Else targets all. |
| `price` | no | Power price, between 0 and 999. |
### {% linkable_title Service `switch.xiaomi_miio_set_power_mode` %} (Power Strip V1 only)
@ -116,5 +116,5 @@ Set the power mode.
| Service data attribute | Optional | Description |
|---------------------------|----------|---------------------------------------------------------------|
| `entity_id` | yes | Only act on a specific xiaomi miio switch entity. Else targets all. |
| `entity_id` | yes | Only act on a specific Xiaomi miio switch entity. Else targets all. |
| `mode` | no | Power mode, valid values are 'normal' and 'green' |

14
source/_components/system_log.markdown
View File

@ -15,7 +15,9 @@ ha_qa_scale: internal
The `system_log` component stores information about all logged errors and warnings in Home Assistant. All collected information is accessible directly in the frontend, just navigate to the `Info` section under `Developer Tools`. In order to not overload Home Assistant with log data, only the 50 last errors and warnings will be stored. Older entries are automatically discarded from the log. It is possible to change the number of stored log entries using the parameter `max_entries`.
This component is automatically loaded by the `frontend` (so no need to do anything if you are using the frontend). If you are not doing so, or if you wish to change a parameter, add the following section to your `configuration.yaml` file:
## {% linkable_title Configuration %}
This component is automatically loaded by the `frontend` (so no need to do anything if you are using the frontend). If you are not doing so, or if you wish to change a parameter, add the following section to your `configuration.yaml` file:
```yaml
system_log:
@ -45,11 +47,11 @@ To manually clear the system log, call this service.
Errors and warnings are posted as the event `system_log_event`, so it is possible to write automations that trigger whenever a warning or error occurs. The following information is included in each event:
| Field | Description |
|------------------------------------------------------------------------------------------|
| `level` | Either `WARNING` or `ERROR` depending on severity. |
| Field | Description |
|-------------------------------------------------------------------------------------------|
| `level` | Either `WARNING` or `ERROR` depending on severity. |
| `source` | File that triggered the error, e.g., `core.py` or `media_player/yamaha.py`. |
| `exception` | Full stack trace if available, otherwise empty string. |
| `exception` | Full stack trace if available, an empty string otherwise. |
| `message` | Descriptive message of the error, e.g., "Error handling request". |
| `timestamp` | Unix timestamp with as a double, e.g., 1517241010.237416. |
@ -57,7 +59,7 @@ Live examples of these events can be found in the Home Assistant log file or by
<img src='/images/components/system_log/system_log_entry.png' />
The message ("Unable to find service..."), source (`core.py`) and level (`WARNING`) can easily be extracted from the image. Exact timestamp and stack trace is shown if the entry is selected.
The message ("Unable to find service..."), source (`core.py`) and level (`WARNING`) can easily be extracted from the image. The exact timestamp and stack trace is shown in the selected entry.
## {% linkable_title Examples %}

3
source/_components/telegram_bot.markdown
View File

@ -150,6 +150,7 @@ Respond to a callback query originated by clicking on an online keyboard button.
| `show_alert` | yes | True/false for show a permanent notification. Defaults to False. |
### {% linkable_title Service `telegram_bot.delete_message` %}
Delete a previously sent message in a conversation.
| Service data attribute | Optional | Description |
@ -161,7 +162,7 @@ Delete a previously sent message in a conversation.
The [`telegram` notification platform](/components/notify.telegram/) requires the `telegram_bot` component to work with, and it's designed to generate a customized shortcut (`notify.USERNAME`) to send notifications (messages, photos, documents and locations) to a particular `chat_id` with the old syntax, allowing backward compatibility.
The required yaml configuration now reduces to:
The required YAML configuration now reduces to:
```yaml
notify:

13
source/_components/tesla.markdown
View File

@ -16,12 +16,13 @@ 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, odometer, and estimated range.
- 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.
- Switch - Charger and max range switch. Allow you to start/stop charging and set max range charging.
- Binary sensors - such as parking and charger connection.
- Sensors - such as Battery level, Inside/Outside temperature, odometer, and estimated range.
- 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.
- Switch - Charger and max range switch. Allow you to start/stop charging and set max range charging.
## {% linkable_title Configuration %}

8
source/_components/timer.markdown
View File

@ -18,7 +18,7 @@ The `timer` component aims to simplify automations based on (dynamic) durations.
When a timer finishes or gets canceled the corresponding events are fired. This allows you to differentiate if a timer has switched from `active` to `idle` because the given duration has elapsed or it has been canceled. To control timers in your automations you can use the services mentioned below. When calling the `start` service on a timer that is already running, it resets the duration it will need to finish and restart the timer without triggering a canceled or finished event. This, for example, makes it easy to create timed lights that get triggered by motion. Starting a timer triggers a started event unless the timer is paused, in that case, it triggers a restarted event.
<p class='note warning'>
With the current implementation timers don't persist over restarts. After a restart they will be idle again, together with their initial configuration.
With the current implementation timers don't persist over restarts. After a restart, they will be idle again, together with their initial configuration.
</p>
## {% linkable_title Configuration %}
@ -67,7 +67,7 @@ Pick an icon that you can find on [materialdesignicons.com](https://materialdesi
## {% linkable_title Services %}
#### {% linkable_title Service `timer.start` %}
### {% linkable_title Service `timer.start` %}
Starts or restarts a timer with the provided duration. If no duration is given, it will either restart with its initial value, or continue a paused timer with the remaining duration. If a new duration is provided, this will be the new default for the timer until Home Assistant is restarted (which loads your default values). The duration can be specified as a number of seconds or the easier to read `01:23:45` format.
If no `entity_id` is given all active timers will be started.
@ -77,7 +77,7 @@ If no `entity_id` is given all active timers will be started.
| `entity_id` | yes | Name of the entity to take action, e.g., `timer.timer0`. |
| `duration` | yes | Duration in seconds or `00:00:00` until the timer finishes. |
#### {% linkable_title Service `timer.pause` %}
### {% linkable_title Service `timer.pause` %}
Pause a running timer. This will retain the remaining duration for later continuation. If no `entity_id` is given all active timers will be paused.
@ -151,7 +151,7 @@ timer:
message: "Timer stop"
```
### {% linkable_title Control a timer from the frontend %}
### {% linkable_title Control a timer manually %}
With the [`script`](/components/script/) component you would be able to control a timer (see above for a `timer` configuration sample) manually.

7
source/_components/tts.markdown
View File

@ -1,7 +1,7 @@
---
layout: page
title: "Text-to-Speech (TTS)"
description: "Instructions on how to setup Text-to-Speech (TTS) with Home Assistant."
description: "Instructions on how to set up Text-to-Speech (TTS) with Home Assistant."
date: 2016-12-13 07:00
sidebar: true
comments: false
@ -17,7 +17,7 @@ Text-to-Speech (TTS) enables Home Assistant to speak to you.
To get started, add the following lines to your `configuration.yaml` (example for Google):
```yaml
# Example configuration.yaml entry for google tts service
# Example configuration.yaml entry for Google TTS service
tts:
- platform: google
```
@ -97,6 +97,7 @@ service: tts.google_say
data:
message: 'May the Force be with you.'
```
Say to the `media_player.floor` device entity:
```yaml
@ -131,7 +132,7 @@ The component has two caches. Both caches can be controlled with the `cache` opt
## {% linkable_title REST Api %}
#### {% linkable_title POST /api/tts_get_url %}
### {% linkable_title POST /api/tts_get_url %}
Returns an URL to the generated TTS file. Platform and message are required.

3
source/_components/tts.microsoft.markdown
View File

@ -1,7 +1,7 @@
---
layout: page
title: "Microsoft Text-to-Speech"
description: "Instructions on how to setup Microsoft Text-to-Speech with Home Assistant."
description: "Instructions on how to set up Microsoft Text-to-Speech with Home Assistant."
date: 2017-11-07 12:00
sidebar: true
comments: false
@ -67,7 +67,6 @@ contour:
type: string
{% endconfiguration %}
## {% linkable_title Full configuration example %}
A full configuration sample including optional variables:

4
source/_components/twilio.markdown
View File

@ -14,7 +14,7 @@ ha_release: "0.40"
The `twilio` component enables the sending of notifications via SMS and the creation of calls with [Twilio](https://twilio.com).
Free trial account is available at [Twilio](https://twilio.com) website providing free calls to verified phone numbers.
A free trial account is available at [Twilio](https://twilio.com) website providing free calls to verified phone numbers.
Calls are limited to 10 minutes and will play a short trial message before your message runs. Upgraded accounts have no limitation.
## {% linkable_title Configuration %}
@ -40,6 +40,7 @@ auth_token:
{% endconfiguration %}
### {% linkable_title Usage %}
After configuring the base Twilio component, add and configure either or both of the [twilio SMS](/components/notify.twilio_sms/) and [twilio Phone](/components/notify.twilio_call) components to utilize the notification functionality.
To be able to receive events from Twilio, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP component ([docs](https://www.home-assistant.io/components/http/#base_url)).
@ -63,4 +64,3 @@ automation:
service: light.turn_on
entity_id: light.office
```

1
source/_components/usps.markdown
View File

@ -43,6 +43,7 @@ If you use the PhantomJS option, specify `driver: phantomjs` in your `usps` conf
Install Chrome 59 or greater (preferably the most recent). Install the latest [Chromedriver](https://sites.google.com/a/chromium.org/chromedriver/downloads). Ensure both executables are on your `PATH`. `google-chrome --version` and `chromedriver --version` should work and report the correct version.
OS-specific instructions:
- [Ubuntu 16](https://gist.github.com/ziadoz/3e8ab7e944d02fe872c3454d17af31a5) (Selenium server portion *not* necessary)
- [RHEL/Centos 7](https://stackoverflow.com/a/46686621)

17
source/_components/vacuum.dyson.markdown
View File

@ -22,11 +22,12 @@ You have to set up the [Dyson component](/components/dyson/) first.
### {% linkable_title Component services %}
This component support the following services (see [Vacuum Cleaner Robots](/components/vacuum/)):
* [`turn_on`](/components/vacuum/#service-vacuumturn_on)
* [`turn_off`](/components/vacuum/#service-vacuumturn_off)
* [`start_pause`](/components/vacuum/#service-vacuumstart_pause)
* [`stop`](/components/vacuum/#service-vacuumstop)
* [`return_to_home`](/components/vacuum/#service-vacuumreturn_to_home)
* [`set_fan_speed`](/components/vacuum/#service-vacuumset_fanspeed). Fan speed values:
* `Quiet`
* `Max`
- [`turn_on`](/components/vacuum/#service-vacuumturn_on)
- [`turn_off`](/components/vacuum/#service-vacuumturn_off)
- [`start_pause`](/components/vacuum/#service-vacuumstart_pause)
- [`stop`](/components/vacuum/#service-vacuumstop)
- [`return_to_home`](/components/vacuum/#service-vacuumreturn_to_home)
- [`set_fan_speed`](/components/vacuum/#service-vacuumset_fanspeed). Fan speed values:
- `Quiet`
- `Max`

1
source/_components/vacuum.mqtt.markdown
View File

@ -160,7 +160,6 @@ payload_not_available:
default: offline
{% endconfiguration %}
### {% linkable_title Full configuration example %}
{% raw %}

166
source/_components/vacuum.xiaomi_miio.markdown
View File

@ -13,7 +13,7 @@ ha_release: 0.51
ha_iot_class: "Local Polling"
---
The `xiaomi miio` vacuum platform allows you to control the state of your [Xiaomi Mi Robot Vacuum](https://www.mi.com/roomrobot/).
The `xiaomi_miio` vacuum platform allows you to control the state of your [Xiaomi Mi Robot Vacuum](https://www.mi.com/roomrobot/).
Currently supported services are:
@ -69,39 +69,39 @@ In addition to all of the services provided by the `vacuum` component (`start`,
Start the remote control mode of the robot. You can then move it with `remote_control_move`; when done, call `remote_control_stop`.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific robot; default targets all |
| Service data attribute | Optional | Description |
|---------------------------|----------|---------------------------------------------------|
| `entity_id` | yes | Only act on a specific robot; default targets all |
### {% linkable_title Service `vacuum.xiaomi_remote_control_stop` %}
Exit the remote control mode of the robot.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific robot; default targets all |
| Service data attribute | Optional | Description |
|---------------------------|----------|---------------------------------------------------|
| `entity_id` | yes | Only act on a specific robot; default targets all |
### {% linkable_title Service `vacuum.xiaomi_remote_control_move` %}
Remote control the robot. Please ensure you first set it in remote control mode with `remote_control_start`.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific robot; default targets all |
| `velocity` | no | Speed: between -0.29 and 0.29 |
| `rotation` | no | Rotation: between -179 degrees and 179 degrees |
| `duration` | no | The number of milliseconds that the robot should move for |
| Service data attribute | Optional | Description |
|---------------------------|----------|-----------------------------------------------------------|
| `entity_id` | yes | Only act on a specific robot; default targets all |
| `velocity` | no | Speed: between -0.29 and 0.29 |
| `rotation` | no | Rotation: between -179 degrees and 179 degrees |
| `duration` | no | The number of milliseconds that the robot should move for |
### {% linkable_title Service `vacuum.xiaomi_remote_control_move_step` %}
Enter remote control mode, make one move, stop, and exit remote control mode.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific robot; default targets all |
| `velocity` | no | Speed: between -0.29 and 0.29. |
| `rotation` | no | Rotation: between -179 degrees and 179 degrees. |
| `duration` | no | The number of milliseconds that the robot should move for |
| Service data attribute | Optional | Description |
|---------------------------|----------|-----------------------------------------------------------|
| `entity_id` | yes | Only act on a specific robot; default targets all |
| `velocity` | no | Speed: between -0.29 and 0.29 |
| `rotation` | no | Rotation: between -179 degrees and 179 degrees |
| `duration` | no | The number of milliseconds that the robot should move for |
## {% linkable_title Attributes %}
@ -134,23 +134,23 @@ The following table shows the units of measurement for each attribute:
## {% linkable_title Retrieving the Access Token %}
<p class='note'>
As per [python-miio issue 185](https://github.com/rytilahti/python-miio/issues/185) the Android Mi Home app no longer stores the token within the database (it's retrieved from Xiaomi servers from version 5.0.31+). Currently the only known fix is to uninstall, then install a downgraded version of the apk. Apkmirror is a trusted source for older versions of the app. [Mi-Home version 5.0.30](https://www.apkmirror.com/apk/xiaomi-inc/mihome/mihome-5-0-30-release/) is confirmed as working for the following Android methods. Using older version than 5.0.30 is not recommended as it might lack support for some newer devices like the Roborock S50.
As per [`python-miio` issue 185](https://github.com/rytilahti/python-miio/issues/185) the Android Mi Home app no longer stores the token within the database (it's retrieved from Xiaomi servers from version 5.0.31+). Currently, the only known fix is to uninstall, then install a downgraded version of the apk. Apkmirror is a trusted source for older versions of the app. [Mi-Home version 5.0.30](https://www.apkmirror.com/apk/xiaomi-inc/mihome/mihome-5-0-30-release/) is confirmed as working for the following Android methods. Using an older version than 5.0.30 is not recommended as it might lack support for some newer devices like the Roborock S50.
<br/> <br/>
The iPhone app still stores the token in the sqlite db as of v4.10.2 (Dec 22, 2018).
The iPhone app still stores the token in the SQLite db as of v4.10.2 (Dec 22, 2018).
<br/> <br/>
This token (32 hexadecimal characters) is required for the Xiaomi Mi Robot Vacuum, Mi Robot 2 (Roborock) Vacuum, Xiaomi Philips Lights and Xiaomi IR Remote. The Xiaomi Gateway uses another security method and requires a `key` (16 alphanumeric chars), which can be obtained
easily via a hidden menu item at the Mi-Home app or using the `miio` command line tool.
</p>
#### {% linkable_title Miio command line tool %}
### {% linkable_title Miio command line tool %}
You can install the command line tool with:
You can install the command line tool using the following command:
```bash
npm install -g miio
```
Discovering devices on current network
Discovering devices on the current network:
```bash
miio discover
@ -170,12 +170,12 @@ Support: At least basic
The information output is:
- __Device ID__ - the unique identifier of the device, does not change if the device is reset.
- __Model ID__ - the model id if it could be determined, this indicates what type of device it is
- __Address__ - the IP that the device has on the network
- __Token__ - the token of the device or ??? if it could not be automatically determined
- `Device ID` - The unique identifier of the device, does not change if the device is reset.
- `Model ID`- The model id if it could be determined, this indicates what type of device it is.
- `Address` - The IP that the device has on the network.
- `Token` - The token of the device or `???` if it could not be automatically determined.
#### {% linkable_title Windows and Android %}
### {% linkable_title Windows and Android %}
To fetch the token follow these instructions depending on your mobile phone platform.
@ -183,14 +183,14 @@ To fetch the token follow these instructions depending on your mobile phone plat
2. Download and extract the [MiToolKit.zip](https://github.com/ultrara1n/MiToolkit/releases).
3. Enable developer mode and USB debugging on the Android phone and plug it into the computer.
4. Change the MiToolKit language to English if you need to.
5. Click "Extract Token"
5. Click "Extract Token".
6. On the phone, you must confirm the backup. DO NOT enter any password and press the button to make the backup.
7. Once you have confirmed the backup the token extraction will begin, it should appear in the MiToolKit shortly.
8. If you don't get a token, close MiToolKit completely, delete the folder MiToolkit\apps\com.xiaomi.smarthome and relaunch MiToolKit to force recreate a new backup (sometimes the files would not be overwritten before deleting the old ones)
8. If you don't get a token, close MiToolKit completely, delete the folder MiToolkit\apps\com.xiaomi.smarthome and relaunch MiToolKit to force recreate a new backup (sometimes the files would not be overwritten before deleting the old ones).
#### {% linkable_title Linux and Android (not rooted) %}
### {% linkable_title Linux and Android (not rooted) %}
Follow the pairing process using your phone and Mi-Home app. You will be able to retrieve the token from a SQLite file inside your phone.
Follow the pairing process using your phone and Mi-Home app. You will be able to retrieve the token from an SQLite file inside your phone.
Before you begin you need to install `libffi-dev` and `libssl-dev` by running the command below. This is needed for `python-miio` to be installed correctly.
@ -198,7 +198,7 @@ Before you begin you need to install `libffi-dev` and `libssl-dev` by running th
sudo apt-get install libffi-dev libssl-dev
```
If your Home Assistant installation is running in a [Virtualenv](/docs/installation/virtualenv/#upgrading-home-assistant), make sure you activate it by running the commands below.
If your Home Assistant installation is running in a [virtualenv](/docs/installation/virtualenv/#upgrading-home-assistant), make sure you activate it by running the commands below.
```bash
sudo -u homeassistant -H -s
@ -209,17 +209,23 @@ To fetch the token follow these instructions depending on your mobile phone plat
1. Configure the robot with the Mi-Home app.
2. Enable developer mode, USB debugging and plug the Android phone into the computer.
3. Get ADB e.g., `apt-get install android-tools-adb` or `apt-get install adb`
4. `adb devices` should list your device. Consult ADB manual if necessary.
5. Issue a backup command via adb: `adb backup -noapk com.xiaomi.smarthome -f backup.ab` (set a password if prompted on your phone). Some devices may required single quotes in the command `adb backup '-noapk com.xiaomi.smarthome -f backup.ab'`
6. Download the 'ADB Backup Extractor' from [here](https://sourceforge.net/projects/adbextractor/files/latest/download)
7. Extract the data from the backup: `java -jar Android\ Backup\ Utilities/Android\ Backup\ Extractor/android-backup-extractor-20171005-bin/abe.jar unpack backup.ab unpacked.tar` (enter the password, if prompted)
8. Untar the unpacked data: `tar -xvf unpacked.tar`
9. `sqlite3 apps/com.xiaomi.smarthome/db/miio2.db 'select token from devicerecord where name like "%Vacuum%";'` returns the token for your Xiaomi vacuum bot.
3. Get ADB by running `apt-get install android-tools-adb` or `apt-get install adb`.
4. `adb devices` should list your device. Consult the ADB manual if necessary.
5. Issue a backup command via adb: `adb backup -noapk com.xiaomi.smarthome -f backup.ab` (set a password if prompted on your phone). Some devices may require single quotes in the command `adb backup '-noapk com.xiaomi.smarthome -f backup.ab'`.
6. Download the ['ADB Backup Extractor'](https://sourceforge.net/projects/adbextractor/files/latest/download).
7. Extract the data from the backup: (enter the password, if prompted)
```bash
java -jar Android\ Backup\ Utilities/Android\ Backup\ Extractor/android-backup-extractor-20171005-bin/abe.jar unpack backup.ab unpacked.tar
```
8. Untar the unpacked data: `tar -xvf unpacked.tar`.
9. The following command returns the token for your Xiaomi vacuum bot:
```bash
sqlite3 apps/com.xiaomi.smarthome/db/miio2.db 'select token from devicerecord where name like "%Vacuum%";'
```
#### {% linkable_title Linux and Android (rooted!) %}
### {% linkable_title Linux and Android (rooted!) %}
Follow the pairing process using your phone and Mi-Home app. You will be able to retrieve the token from a SQLite file inside your phone.
Follow the pairing process using your phone and Mi-Home app. You will be able to retrieve the token from an SQLite file inside your phone.
Before you begin you need to install `libffi-dev` and `libssl-dev` by running the command below. This is needed for `python-miio` to be installed correctly.
@ -227,7 +233,7 @@ Before you begin you need to install `libffi-dev` and `libssl-dev` by running th
sudo apt-get install libffi-dev libssl-dev
```
If your Home Assistant installation is running in a [Virtualenv](/docs/installation/virtualenv/#upgrading-home-assistant), make sure you activate it by running the commands below.
If your Home Assistant installation is running in a [virtualenv](/docs/installation/virtualenv/#upgrading-home-assistant), make sure you activate it by running the commands below.
```bash
sudo -u homeassistant -H -s
@ -238,57 +244,71 @@ To fetch the token follow these instructions depending on your mobile phone plat
1. Configure the robot with the Mi-Home app.
2. Enable developer mode, USB debugging and root permission only for ADB on the Android phone and plug it into the computer.
3. Get ADB f.e. `apt-get install android-tools-adb`
4. `adb devices` should list your device
5. `adb root` (does work for development builds only: ones with `ro.debuggable=1`)
6. `adb shell` (for those using Magisk based root the previous command won't work. After entering a shell, type `su` to enter the root shell)
7. `echo "select name,localIP,token from devicerecord;" | sqlite3 /data/data/com.xiaomi.smarthome/databases/miio2.db` returns a list of all registered devices including IP address and token.
3. Get ADB (e.g, using `apt-get install android-tools-adb`).
4. The command `adb devices` should list your device.
5. The command `adb root` (does work for development builds only: ones with `ro.debuggable=1`).
6. The command `adb shell` (for those using Magisk based root the this command won't work. After entering a shell, type `su` to enter the root shell and try again).
7. The following command returns a list of all registered devices including IP address and token:
```bash
echo "select name,localIP,token from devicerecord;" | sqlite3 /data/data/com.xiaomi.smarthome/databases/miio2.db
```
#### {% linkable_title iOS %}
### {% linkable_title iOS %}
1. Configure the robot with the Mi-Home app.
2. Using iTunes, create an unencrypted backup of your iPhone.
3. Install [iBackup Viewer](https://www.imactools.com/iphonebackupviewer/), open it, and open your backup.
4. Open the "Raw Data" module.
5. Navigate to `com.xiaomi.mihome`.
6. Search for a file that looks like this: `123456789_mihome.sqlite` – note that `_mihome.sqlite` is *not* the correct file.
6. Search for a file that looks like this: `123456789_mihome.sqlite` (Note: `_mihome.sqlite` is *not* the correct file).
7. Save this file to your filesystem.
8. Install [DB Browser for SQLite](https://sqlitebrowser.org/).
9. Open DB Browser and load the `.sqlite` file you saved from your backup.
10. Click on the `Execute SQL` tab.
11. Input and run this query: `SELECT ZTOKEN FROM ZDEVICE WHERE ZMODEL LIKE "%vacuum%"`
11. Input and run this query:
```sql
SELECT ZTOKEN FROM ZDEVICE WHERE ZMODEL LIKE "%vacuum%"
```
12. Copy the returned 32-digit hexadecimal string to your clipboard.
13. Open `Terminal` and execute this command: `echo '0: <YOUR HEXADECIMAL STRING>' | xxd -r -p | openssl enc -d -aes-128-ecb -nopad -nosalt -K 00000000000000000000000000000000`
13. Open `Terminal` and execute this command:
```bash
echo '0: <YOUR HEXADECIMAL STRING>' | xxd -r -p | openssl enc -d -aes-128-ecb -nopad -nosalt -K 00000000000000000000000000000000
```
14. Use the resulting string as your token.
#### {% linkable_title Bluestacks %}
### {% linkable_title Bluestacks %}
1. Configure the robot with the Mi-Home app.
2. Install [BlueStacks](https://www.bluestacks.com).
3. Set up the Mi-Home app in BlueStacks and login to synchronize devices.
4. Use [BlueStacks Tweaker](https://forum.xda-developers.com/general/general/bluestacks-tweaker-2-tool-modifing-t3622681) to access the filesystem and retrieve the token.
#### {% linkable_title Selecting token manually (Windows and Android)%}
### {% linkable_title Selecting token manually (Windows and Android) %}
The following instruction explained an alternative method, in case the MiToolKit didn't work.
Software Required:
The following instruction explained an alternativ way, if MiToolKit didn't work.
Software Required:
- Android ADB is contained in [Android SDK](https://developer.android.com/studio/releases/platform-tools)
- [Mi-Home version 5.0.30](https://www.apkmirror.com/apk/xiaomi-inc/mihome/mihome-5-0-30-release/)
- [Android Backup Extractor](https://sourceforge.net/projects/adbextractor/)
- [SQLite Browser](https://sqlitebrowser.org/)
1. Install an old Version of MiHome (e.g. Mi-Home version 5.0.30) on your Android-Device
2. Open MiHome, log-in and add your devices
3. Enable USB-Debugging on your Android
4. Create a backup from your MiHome App, by using adb
```bash
adb backup com.xiaomi.smarthome
```
Now the backup App opens on you Android-Device. You don't need to set a password, just click save.
5. Extract the backup-file with android-backup-extractor
```bash
java -jar abe.jar unpack backup.ab backup.tar
```
After that, you kann open the file with WinRaR or what ever you like.
6. Go to \apps\com.xiaomi.smarthome\db
7. Open miio2.db with SQLite Browser
8. You can find your device tokens in "devicerecord" table
Steps to take:
1. Install an old Version of MiHome (e.g. Mi-Home version 5.0.30) on your Android-Device.
2. Open MiHome, log-in and add your devices.
3. Enable USB-Debugging on your Android.
4. Create a backup from your MiHome App, by using adb:
```bash
adb backup com.xiaomi.smarthome
```
Now the backup App opens on you Android-Device. You don't need to set a password, just click save.
5. Extract the backup-file with android-backup-extractor:
```bash
java -jar abe.jar unpack backup.ab backup.tar
```
After that, extract the file with WinRAR, 7-Zip (or similar).
6. Go to `\apps\com.xiaomi.smarthome\db`.
7. Open `miio2.db` with the SQLite Browser.
8. You can find your device tokens in `devicerecord` table.

12
source/_components/verisure.markdown
View File

@ -17,12 +17,12 @@ Home Assistant has support to integrate your [Verisure](https://www.verisure.com
We support:
* [Alarm](/components/alarm_control_panel.verisure/)
* [Smartplugs](/components/switch.verisure/)
* Reading from thermometers and hygrometers integrated in various [devices](/components/sensor.verisure/)
* Mouse Detector
* [Locks](/components/lock.verisure/)
* [Door & Window](/components/binary_sensor.verisure/)
- [Alarm](/components/alarm_control_panel.verisure/)
- [Smartplugs](/components/switch.verisure/)
- Reading from thermometers and hygrometers integrated in various [devices](/components/sensor.verisure/)
- Mouse Detector
- [Locks](/components/lock.verisure/)
- [Door & Window](/components/binary_sensor.verisure/)
## {% linkable_title Configuration %}

105
source/_components/volvooncall.markdown
View File

@ -52,22 +52,47 @@ volvooncall:
region: cn
```
A more advanced example for setting the vehicle name and selecting what resources to display:
{% configuration %}
username:
description: The username associated with your Volvo On Call account.
required: true
type: string
password:
description: The password for your given Volvo On Call account.
required: true
type: string
region:
description: The region where the Volvo is registered. Needs to be set for users in North America or China.
required: false
type: string
service_url:
description: The service URL to use for Volvo On Call. Normally not necessary to specify.
required: false
type: string
mutable:
description: If set to true, include components that can make changes to the vehicle (unlock, start engine, start heater etc).
required: false
default: true
type: boolean
name:
description: Make it possible to provide a name for the vehicles.
required: false
type: string
resources:
description: A list of resources to display (defaults to all available).
required: false
type: list
scandinavian_miles:
description: If set to true, Scandinavian miles ("mil") are used for distances and fuel range.
required: false
type: boolean
default: false
{% endconfiguration %}
```yaml
# Example configuration.yaml entry
volvooncall:
username: YOUR_USERNAME
password: YOUR_PASSWORD
name:
abc123: 'Batmobile'
resources:
- odometer
- lock
- heater
```
### {% linkable_title Available Resources %}
The list of currently available resources:
Currently available resources:
- `position`
- `lock`
- `heater`
@ -105,39 +130,19 @@ Currently available resources:
- `any_door_open`
- `any_window_open`
{% configuration %}
username:
description: The username associated with your Volvo On Call account.
required: true
type: string
password:
description: The password for your given Volvo On Call account.
required: true
type: string
region:
description: The region where the Volvo is registered. Needs to be set for users in North America or China.
required: false
type: string
service_url:
description: The service URL to use for Volvo On Call. Normally not necessary to specify.
required: false
type: string
mutable:
description: If set to true, include components that can make changes to the vehicle (unlock, start engine, start heater etc).
required: false
default: true
type: boolean
name:
description: Make it possible to provide a name for the vehicles.
required: false
type: string
resources:
description: A list of resources to display (defaults to all available).
required: false
type: list
scandinavian_miles:
description: If set to true, Scandinavian miles ("mil") are used for distances and fuel range.
required: false
type: boolean
default: false
{% endconfiguration %}
## {% linkable_title Advanced Examples %}
A more advanced example for setting the vehicle name and selecting what resources to display:
```yaml
# Example configuration.yaml entry
volvooncall:
username: YOUR_USERNAME
password: YOUR_PASSWORD
name:
abc123: 'Batmobile'
resources:
- odometer
- lock
- heater
```

7
source/_components/w800rf32.markdown
View File

@ -13,10 +13,10 @@ ha_release: 0.83
ha_iot_class: "Local Push"
---
The `w800rf32` component supports W800RF32 devices by [WGL Designs](http://www.wgldesigns.com/w800.html) which
The `w800rf32` component supports W800RF32 devices by [WGL Designs](http://www.wgldesigns.com/w800.html) which
communicate in the frequency range of 310MHz or if you are outside Canada or the U.S., 433.92 MHz.
The W800 family of RF receivers are designed to receive X10 RF signals generated from X10 products: Palm Pad
The W800 family of RF receivers are designed to receive X10 RF signals generated from X10 products: Palm Pad
remotes, key chain remotes, Hawkeye motion detectors, and many, many other X10 RF devices.
To enable W800rf32 in your installation, add the following to your `configuration.yaml` file:
@ -33,6 +33,3 @@ device:
required: true
type: string
{% endconfiguration %}

13
source/_components/water_heater.econet.markdown
View File

@ -14,8 +14,7 @@ ha_iot_class: "Cloud Polling"
redirect_from: /components/climate.econet/
---
The `econet` water heater platform is consuming the information provided by a [EcoNet enabled Rheem water heater](http://www.rheem.com/EcoNet/Home). This platform allows you to set the temperature, the operation mode, and enable vaction mode.
The `econet` water heater platform is consuming the information provided by a [EcoNet enabled Rheem water heater](http://www.rheem.com/EcoNet/Home). This platform allows you to set the temperature, the operation mode, and enable vacation mode.
## {% linkable_title Configuration %}
@ -46,9 +45,9 @@ You can use the service `econet.add_vacation` to create a new vacation for your
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | The entity id of the water heater to add the vaction to.
| `start_date` | yes | This is a Unix timestamp for when the vaction should start.
| `end_date` | yes | this is a Unix timestamp for when the vaction should end.
| `entity_id` | yes | The entity id of the water heater to add the vacation to.
| `start_date` | yes | This is a Unix timestamp for when the vacation should start.
| `end_date` | yes | this is a Unix timestamp for when the vacation should end.
<p class='note'>
The Unix timestamps can be obtained from the `input_datetime` component. This will allow you to graphically set the start and end date.
@ -56,11 +55,11 @@ The Unix timestamps can be obtained from the `input_datetime` component. This wi
### {% linkable_title Service `econet.delete_vacation` %}
You can use the service `econet.delete_vacation` to remove all vactions from an EcoNet water heater.
You can use the service `econet.delete_vacation` to remove all vacations from an EcoNet water heater.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | The entity id of the water heater to remove the vaction from.
| `entity_id` | yes | The entity id of the water heater to remove the vacation from.
<p class='note'>
Econet water heaters use to live under the `climate` platform prior to release 0.81.

12
source/_components/water_heater.markdown
View File

@ -9,9 +9,8 @@ sharing: true
footer: true
---
The `water_heater` component is built for the controlling and monitoring of hot water heaters.
To enable this component, pick one of the platforms, and add it to your `configuration.yaml`:
```yaml
@ -23,6 +22,7 @@ water_heater:
## {% linkable_title Services %}
### {% linkable_title Water heater control services %}
Available services: `water_heater.set_temperature`, `water_heater.turn_away_mode_on`, `water_heater.turn_away_mode_off`, `water_heater.set_operation_mode`
<p class='note'>
@ -31,13 +31,13 @@ Not all water heater services may be available for your platform. Be sure to che
### {% linkable_title Service `water_heater.set_temperature` %}
Set target temperature of water heater device
Sets target temperature of water heater device.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of water heater devices to control. Else targets all.
| `temperature` | no | New target temperature for water heater
| `operation_mode` | yes | Operation mode to set temperature to. This defaults to current_operation mode if not set, or set incorrectly.
| `operation_mode` | yes | Operation mode to set the temperature to. This defaults to current_operation mode if not set, or set incorrectly.
#### {% linkable_title Automation example %}
@ -63,7 +63,7 @@ Set operation mode for water heater device
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of water heater devices to control. Else targets all.
| `operation_mode` | no | New value of operation mode
#### {% linkable_title Automation example %}
#### {% linkable_title Automation example %}
```yaml
automation:
@ -86,7 +86,7 @@ Turn away mode on or off for water heater device
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of water heater devices to control. Else targets all.
| `away_mode` | no | New value of away mode. 'on'/'off' or True/False
#### {% linkable_title Automation example %}
#### {% linkable_title Automation example %}
```yaml
automation:

8
source/_components/water_heater.wink.markdown
View File

@ -1,7 +1,7 @@
---
layout: page
title: "Wink Water Heater"
description: "Instructions on how to setup the Wink water heaters within Home Assistant."
description: "Instructions on how to set up the Wink water heaters within Home Assistant."
date: 2016-11-01 22:36
sidebar: true
comments: false
@ -15,14 +15,12 @@ ha_iot_class: "Cloud Polling"
The Wink water heater platform allows you to get data from your [Wink](http://www.wink.com/) Water Heaters.
The requirement is that you have setup [Wink](/components/wink/).
The requirement is that you have set up [Wink](/components/wink/).
### {% linkable_title Supported water heaters %}
## {% linkable_title Supported water heaters %}
- Rheem Econet water heaters (No Wink hub required)
<p class='note'>
Wink water heaters use to live under the `climate` platform prior to release 0.81.
</p>

33
source/_components/waterfurnace.markdown
View File

@ -17,21 +17,20 @@ The `waterfurnace` component communicates with the WaterFurnace Symphony website
The sensors provided include:
- Thermostat Setpoint
- Thermostat Current Temp
- Leaving Air Temp
- Entering Water Loop Temp
- Current Humidity
- Current Humidity Setpoint
- Total system power (in Watts)
- Furnace Mode
- Compressor Power
- Fan Power
- Aux Power
- Loop Pump Power
- Compressor Speed
- Fan Speed
- Thermostat Setpoint
- Thermostat Current Temp
- Leaving Air Temp
- Entering Water Loop Temp
- Current Humidity
- Current Humidity Setpoint
- Total system power (in Watts)
- Furnace Mode
- Compressor Power
- Fan Power
- Aux Power
- Loop Pump Power
- Compressor Speed
- Fan Speed
## {% linkable_title Configuration %}
@ -55,8 +54,8 @@ password:
type: string
{% endconfiguration %}
#### {% linkable_title Limitations %}
## {% linkable_title Limitations %}
The WebSocket interface used by this module requires active polling, otherwise the server side shuts down the connection. By default, this polling is happening every 10 seconds. All sensors are updated during every polling cycle.
The WebSocket interface used by this module requires active polling to prevent the server side shuts down the connection. By default, this polling is happening every 10 seconds. All sensors are updated during every polling cycle.
While this is communicating with a thermostat, geothermal systems operate most efficiently when setbacks are not used, and the home is kept at a constant temperature. It remains useful to collect the data from the system to understand its performance, but a full climate interface won't be implemented.

9
source/_components/watson_iot.markdown
View File

@ -22,10 +22,11 @@ a gateway device in your IoT platform instance. For instructions on how to do
this check the [official documentation](https://console.bluemix.net/docs/services/IoT/gateways/dashboard.html#IoT_connectGateway)
which provides the details on doing this. After you register the gateway device
for your home-assistant you'll need 4 pieces of information:
- Organization ID
- Gateway device Type
- Gateway device ID
- Authentication Token
- Organization ID
- Gateway device Type
- Gateway device ID
- Authentication Token
With this basic information you can configure the component:

36
source/_components/wink.markdown
View File

@ -1,7 +1,7 @@
---
layout: page
title: "Wink"
description: "Instructions on how to setup the Wink hub within Home Assistant."
description: "Instructions on how to set up the Wink hub within Home Assistant."
date: 2015-01-20 22:36
sidebar: true
comments: false
@ -24,17 +24,17 @@ Home Assistant integrates with the Wink API and automatically sets up any switch
Check the related components pages for actual devices that are supported.
### {% linkable_title Authenticate using [developer.wink.com](https://developer.wink.com) %}
## {% linkable_title Authenticate using [developer.wink.com](https://developer.wink.com) %}
You need to setup a developer account with Wink. This process can take a few days to get approved.
You need to set up a developer account with Wink. This process can take a few days to get approved.
Wink requests three pieces of information from the user when they sign up for a developer account.
1. `Name:` This can be anything, for example "Home Assistant"
1. `Name:` This can be anything, for example, "Home Assistant"
2. `Website:` The external address of your Home Assistant instance. If not externally accessible you can use your email address.
3. `Redirect URI:` This should be "http://192.168.1.5:8123/auth/wink/callback" replacing the IP with the internal IP of your Home Assistant box.
3. `Redirect URI:` This should be `http://192.168.1.5:8123/auth/wink/callback` replacing the IP with the internal IP of your Home Assistant box.
No settings are required in the configuration.yaml other than `wink:` this is because you will be guided through setup via the configurator on the frontend.
No settings are required in the `configuration.yaml` other than `wink:` this is because you will be guided through setup via the configurator on the frontend.
<p class='note'>
When using the configurator make sure the initial setup is performed on the same local network as the Home Assistant server, if not from the same box Home Assistant is running on. This will allow for authentication redirects to happen correctly.
@ -44,7 +44,7 @@ When using the configurator make sure the initial setup is performed on the same
wink:
```
### {% linkable_title Full oauth authentication (legacy) %}
## {% linkable_title Full oauth authentication (legacy) %}
This should be used for users that obtained their client_id and client_secret via email from Wink support prior to [developer.wink.com's](https://developer.wink.com) existence.
@ -87,7 +87,7 @@ Local control:
- Wink's local control API isn't officially documented and therefore could be broken by a hub update. For these reasons `local_control` defaults to `false`.
- Using local control doesn't appear to make commands any quicker, but does function in an internet/Wink outage.
- Local control is also only available for the Wink hub v1 and v2, not the Wink relay.
- Local control isn't used during start-up of Home Assistant; this means initial setup requires an active internet connection.
- Local control isn't used during the start-up of Home Assistant; this means initial setup requires an active internet connection.
- Local control requests are first sent to the controlling hub. If a request fails, that request will attempt to go online.
<p class='note'>
@ -95,23 +95,23 @@ It is possible for the hub to get into a bad state where it stops accepting loca
The following error will be logged if the hub is rejecting local requests.
```
```txt
Error sending local control request. Sending request online
```
</p>
### {% linkable_title Service `refresh_state_from_wink` %}
## {% linkable_title Service `refresh_state_from_wink` %}
The Wink component only obtains the device states from the Wink API once, during startup. All updates after that are pushed via a third party called PubNub. On rare occasions where an update isn't pushed device states can be out of sync.
You can use the service wink/refresh_state_from_wink to pull the most recent state from the Wink API for all devices. If `local_control` is set to `True` states will be pulled from the devices controlling hub, not the online API.
### {% linkable_title Service `pull_newly_added_devices_from_wink` %}
## {% linkable_title Service `pull_newly_added_devices_from_wink` %}
You can use the service wink/add_new_devices to pull any newly paired Wink devices to an already running instance of Home-Assistant. Any new devices will also be added if Home-Assistant is restarted.
### {% linkable_title Service `delete_wink_device` %}
## {% linkable_title Service `delete_wink_device` %}
You can use the service wink/delete_wink_device to remove/unpair a device from Wink.
@ -119,7 +119,7 @@ You can use the service wink/delete_wink_device to remove/unpair a device from W
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String that points at the `entity_id` of device to delete.
### {% linkable_title Service `pair_new_device` %}
## {% linkable_title Service `pair_new_device` %}
You can use the service wink/pair_new_device to pair a new device to your Wink hub/relay
@ -133,7 +133,7 @@ You can use the service wink/pair_new_device to pair a new device to your Wink h
Calling service wink/pull_newly_added_wink_devices after a device is paired will add that new device to Home Assistant. The device will also show up on the next restart of Home Assistant.
</p>
### {% linkable_title Service `rename_wink_device` %}
## {% linkable_title Service `rename_wink_device` %}
You can use the service wink/rename_wink_device to change the name of a device.
@ -150,17 +150,15 @@ Home Assistant entity_ids for Wink devices are based on the Wink device's name.
The Wink hub, by default, can only be accessed via the cloud. This means it requires an active internet connection and you will experience delays when controlling and updating devices (~3s).
</p>
### Custom Wink devices and their services
## {% linkable_title Custom Wink devices and their services %}
- GoControl siren and strobe
- Dome siren/chime/strobe
- Quirky Nimbus (Legacy device) These can no longer be officially added to your Wink account
### {% linkable_title Service `set_siren_auto_shutoff` %}
You can use the service wink/set_siren_auto_shutoff to set how long the siren will sound before shuting off.
You can use the service wink/set_siren_auto_shutoff to set how long the siren will sound before shutting off.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
@ -189,7 +187,7 @@ You can use the service wink/set_chime_volume to set the volume for the chime on
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `volume` | no | String. One of ["low", "medium", "high"]
| `entity_id` | yes | String or list of strings that point at `entity_id`s of siren/chime.
| `entity_id` | yes | String or list of strings that point at `entity_id`s of the siren/chime.
Example:

24
source/_components/wunderlist.markdown
View File

@ -12,16 +12,14 @@ ha_category: Calendar
ha_release: 0.84
---
The `wunderlist` component allows you to create tasks in [Wunderlist](https://www.wunderlist.com) from Home Assistant. You can use this if you want Home Assistant to send you a task that
you should not forget, e.g., Congratulate Dani.
The `wunderlist` component allows you to create tasks in [Wunderlist](https://www.wunderlist.com) from Home Assistant. You can use this if you want Home Assistant to send you a task that you should not forget, e.g., Congratulate Dani.
## {% linkable_title Setup %}
Wunderlist API uses OAuth2, so you need to obtain a `client_id` and an `access_token`.
Wunderlist API uses OAuth2, so you need to obtain a `client_id` and an `access_token`.
There are two ways:
1. Go to the [Wunderlist IOT app page](https://wunderlist-iot.herokuapp.com), login with your Wunderlist account and accept the application permissions.
1. Go to the [Wunderlist IOT app page](https://wunderlist-iot.herokuapp.com), log in with your Wunderlist account and accept the application permissions.
It will print for you the `client_id` and the `access_token`.
2. Or you can create your own application and `access_token` following the instructions at the [Wunderlist developer page](https://developer.wunderlist.com/).
@ -29,20 +27,16 @@ Store the parameters in your Home Assistant configuration:
```yaml
# Example configuration.yaml entry
wunderlist:
client_id: YOUR_CLIENT_ID
access_token: YOUR_ACCESS_TOKEN
```
{% configuration %}
client_id:
description: The ID of your Wunderlist application (OAuth2).
required: true
type: string
access_token:
description: A token for your Wunderlist personal account (For the ``client_id`` application).
required: true
@ -51,15 +45,15 @@ access_token:
## {% linkable_title Creating tasks with service `create_task`%}
This component offers a new service domain `wunderlist` with the service `create_task`.
You can call this service with the argument `list_name` the argument `name` and the optional parameter `starred` to create a new task.
This component offers a new service domain `wunderlist` with the service `create_task`.
You can call this service with the argument `list_name` the argument `name` and the optional parameter `starred` to create a new task.
|Service data attribute | Optional | Description | Example |
|-----------------------|----------|-------------|---------|
| Service data attribute | Optional | Description | Example |
|------------------------|----------|-------------|---------|
| list_name | no | Name of the list | "Shopping list"
| name | no | Name of the new task | "Spanish Jam" |
| starred | yes | Create the task starred or not | false |
## {% linkable_title Disclaimer %}
This product uses the Wunderlist API but is not endorsed or certified by Wunderlist.

36
source/_components/xiaomi_aqara.markdown
View File

@ -16,34 +16,34 @@ redirect_from: /components/xiaomi/
The `xiaomi_aqara` component allows you to integrate [Xiaomi](http://www.mi.com/en/) Aqara-compatible devices into Home Assistant.
#### {% linkable_title Supported Devices %}
## {% linkable_title Supported Devices %}
- Xiaomi Mijia Gateway (lumi.gateway.v2, lumi.gateway.v3)
- Aqara Air Conditioning Companion (lumi.acpartner.v3)
- Aqara Intelligent Door Lock (lock.aq1)
- Temperature and Humidity Sensor (1st and 2nd generation)
- Motion Sensor (1st and 2nd generation)
- Door and Window Sensor (1st and 2nd generation)
- Button 1st generation (Single, Double, long_click_press)
- Button 2nd generation (Single, Double)
- Plug aka Socket (Zigbee version, reports power consumed, power load, state and if device in use)
- Wall Plug (reports power consumed, power load and state)
- Aqara Wall Switch (Single)
- Aqara Wall Switch (Double)
- Aqara Wall Switch LN (Single)
- Aqara Wall Switch (Single)
- Aqara Wall Switch LN (Double)
- Aqara Wireless Switch (Single)
- Aqara Wall Switch LN (Single)
- Aqara Wireless Switch (Double)
- Aqara Wireless Switch (Single)
- Battery
- Button 1st generation (Single, Double, Long Click)
- Button 2nd generation (Single, Double)
- Cube
- Door and Window Sensor (1st and 2nd generation)
- Gas Leak Detector (reports alarm and density)
- Smoke Detector (reports alarm and density)
- Gateway (Light, Illumination Sensor, Ringtone play)
- Intelligent Curtain
- Water Leak Sensor
- Motion Sensor (1st and 2nd generation)
- Plug aka Socket (Zigbee version, reports power consumed, power load, state and if the device is in use)
- Smoke Detector (reports alarm and density)
- Temperature and Humidity Sensor (1st and 2nd generation)
- Vibration Sensor
- Battery
- Wall Plug (reports power consumed, power load, and state)
- Water Leak Sensor
- Xiaomi Mijia Gateway (lumi.gateway.v2, lumi.gateway.v3)
#### {% linkable_title Unsupported Devices %}
## {% linkable_title Unsupported Devices %}
- Xiaomi Aqara Gateway (lumi.gateway.aqhm01), as it is not possible to activate dev mode in the Mi Home App.
- Gateway Radio
@ -250,7 +250,6 @@ This example toggles the living room lamp on a double click of the button.
entity_id: light.living_room_lamp
```
## {% linkable_title Troubleshooting %}
### {% linkable_title Initial setup problem %}
@ -265,6 +264,7 @@ If you run into trouble initializing the gateway with your app, try another smar
```
That means that Home Assistant is not getting any response from your Xiaomi gateway. Might be a local network problem or your firewall.
- Make sure you have [enabled LAN access](https://www.domoticz.com/wiki/Xiaomi_Gateway_(Aqara)#Adding_the_Xiaomi_Gateway_to_Domoticz).
- Turn off the firewall on the system where Home Assistant is running.
- Ensure your router supports multicast as this is a requirement of the Xiaomi Gateway.
@ -274,6 +274,6 @@ That means that Home Assistant is not getting any response from your Xiaomi gate
- Hard reset the gateway: Press the button of the gateway 30 seconds and start again from scratch.
- If you are using Home Assistant in [Docker](/docs/installation/docker/), make sure to use `--net=host`.
- If you receive an `{"error":"Invalid key"}` in your log while trying to control the gateway light
- You should generate the key again using an Android Phone or alternatively an emulator such as [bluestacks](https://www.bluestacks.com). In some instances there is an issue with keys being generated using the iOS application.
- You should generate the key again using an Android Phone or alternatively an emulator such as [bluestacks](https://www.bluestacks.com). In some instances, there is an issue with keys being generated using the iOS application.
- You need to make sure to have multicast support on your network. If you are running Home Assistant in a virtual machine (like Proxmox), try `echo 0 >/sys/class/net/vmbr0/bridge/multicast_snooping` on the host and restart the service or reboot the host.
- If the required library "PyXiaomiGateway" cannot be installed you will need to install some missing system dependencies `python3-dev`, `libssl-dev`, `libffi-dev` manually (e.g., `$ sudo apt-get install python3-dev libssl-dev libffi-dev`).

2
source/_components/zeroconf.markdown
View File

@ -41,6 +41,6 @@ Browsing domain 'local' on -1.-1 ...
Browsing for services of type '_home-assistant._tcp' in domain 'local' on 4.0 ...
Found service 'Home' of type '_home-assistant._tcp' in domain 'local' on 4.0.
Service data for service 'Home' of type '_home-assistant._tcp' in domain 'local' on 4.0:
Host Home._home-assistant._tcp.local (192.168.0.70), port 8123, TXT data:
Host Home._home-assistant._tcp.local (192.168.0.70), port 8123, TXT data:
['requires_api_password=true', 'base_url=http://192.168.0.70:8123', 'version=0.41.0']
```

6
source/_components/zha.markdown
View File

@ -14,7 +14,7 @@ ha_iot_class: "Local Polling"
---
[Zigbee Home Automation](http://www.zigbee.org/zigbee-for-developers/applicationstandards/zigbeehomeautomation/)
integration for Home Assistant allows you to connect many off-the-shelf Zigbee based devices to Home Assistant, using one of the available Zigbee radio modules compatible with [zigpy](https://github.com/zigpy/zigpy) (an open source Python library implementing a Zigbee stack, which in turn relies on seperate libraries which can each interface a with Zigbee radio module a different manufacturer).
integration for Home Assistant allows you to connect many off-the-shelf Zigbee based devices to Home Assistant, using one of the available Zigbee radio modules compatible with [zigpy](https://github.com/zigpy/zigpy) (an open source Python library implementing a Zigbee stack, which in turn relies on separate libraries which can each interface a with Zigbee radio module a different manufacturer).
There is currently support for the following device types within Home Assistant:
@ -74,8 +74,6 @@ enable_quirks:
default: true
{% endconfiguration %}
To add new devices to the network, call the `permit` service on the `zha` domain. Do this by clicking the Service icon in Developer tools and typing `zha.permit` in the **Service** dropdown box. Next, follow the device instructions for adding, scanning or factory reset.
To add new devices to the network, call the `permit` service on the `zha` domain. Do this by clicking the Service icon in Developer tools and typing `zha.permit` in the **Service** dropdown box. Next, follow the device instructions for adding, scanning or factory reset.
In case you want to add Philips Hue bulbs that have previously been added to another bridge, have a look at: [https://github.com/vanviegen/hue-thief/](https://github.com/vanviegen/hue-thief/)

4
source/_components/zigbee.markdown
View File

@ -13,7 +13,7 @@ ha_release: 0.12
ha_iot_class: "Local Polling"
---
[Zigbee](http://www.zigbee.org/what-is-zigbee/) integration for Home Assistant allows you to utilize modules such as the [XBee](http://www.digi.com/lp/xbee) as wireless General Purpose Input/Output (GPIO) devices. The component requires a local Zigbee device to be connected to a serial port. Through this it will send and receive commands to and from other devices on the Zigbee mesh network.
[Zigbee](http://www.zigbee.org/what-is-zigbee/) integration for Home Assistant allows you to utilize modules such as the [XBee](http://www.digi.com/lp/xbee) as wireless General Purpose Input/Output (GPIO) devices. The component requires a local Zigbee device to be connected to a serial port. Through this, it will send and receive commands to and from other devices on the Zigbee mesh network.
There is currently support for the following device types within Home Assistant:
@ -49,7 +49,7 @@ baud:
To find the possible serial port names of your device, run:
```bash
$ ls /dev/ttyUSB*
ls /dev/ttyUSB*
```
<p class='note'>

8
source/_components/zone.markdown
View File

@ -1,7 +1,7 @@
---
layout: page
title: "Zone"
description: "Instructions on how to setup zones within Home Assistant."
description: "Instructions on how to set up zones within Home Assistant."
date: 2015-10-04 09:23
sidebar: true
comments: false
@ -68,7 +68,7 @@ passive:
To find the latitude/longitude of a certain place you can use [Google Maps](https://www.google.com/maps/) or [Bing Maps](https://www.bing.com/maps). Just right click and copy the coordinates from there (Bing) or click on the "What is here?" (Google)
#### {% linkable_title Home zone %}
## {% linkable_title Home zone %}
If no configuration is given, the `zone` component will create a zone for home. This zone will use location provided in the `configuration.yaml` file and have a radius of 100 meters. To override this, create a zone configuration and name it **'Home'**.
@ -76,10 +76,10 @@ If no configuration is given, the `zone` component will create a zone for home.
Devices that are in the zone **'Home'** will not appear on the map in the Home Assistant UI.
</p>
#### {% linkable_title Icons %}
## {% linkable_title Icons %}
It is preferred to pick an icon to use for your zone. Pick any icon that you can find on [materialdesignicons.com](https://materialdesignicons.com/) and prefix the name with `mdi:`. For example `mdi:school`, `mdi:worker`, `mdi:home`, `mdi:cart`, or `mdi:castle`.
#### State
## {% linkable_title State %}
`zoning` is the state a `zone` has when it is configured. A `zone` doesn't have another state; all configured zones are `zoning` all the time.

1
source/_components/zoneminder.markdown
View File

@ -83,6 +83,7 @@ Once loaded, the `zoneminder` platform will expose a service (`set_run_state`) t
| `name` | no | Name of the new run state to set. |
For example, if your ZoneMinder instance was configured with a run state called "Home", you could write an [automation](/getting-started/automation/) that changes ZoneMinder to the "Home" run state by including the following [action](/getting-started/automation-action/):
```yaml
action:
service: zoneminder.set_run_state

4
source/_docs/configuration/packages.markdown
View File

@ -22,7 +22,7 @@ homeassistant:
...package configuration here...
```
The package configuration can include: `switch`, `light`, `automation`, `groups`, or most other Home Assistant components.
The package configuration can include: `switch`, `light`, `automation`, `groups`, or most other Home Assistant components including hardware platforms.
It can be specified inline or in a separate YAML file using `!include`.
@ -88,7 +88,7 @@ homeassistant:
```
This uses the concept splitting the configuration and will include all files in a directory with the keys representing the filenames.
See the documentation about [splitting the configuration](/docs/configuration/splitting_configuration/) for more information about `!include_dir_named` and other include statements that might be helpful.
See the documentation about [splitting the configuration](/docs/configuration/splitting_configuration/) for more information about `!include_dir_named` and other include statements that might be helpful. The benefit of this approach is to pull all configurations required to integrate a system, into one file, rather than accross several.
### {% linkable_title Customizing entities with packages %}

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

@ -31,7 +31,7 @@ The `ios` component is the companion component for the Home Assistant iOS app. W
Loading the `ios` component will also load the [`device_tracker`](/components/device_tracker), [`zeroconf`](/components/zeroconf) and [`notify`](/components/notify) platforms.
In order to save credentials and adjust settings within the iOS Home Assistant app, the Optional (`api_password`)[https://www.home-assistant.io/components/http/#api_password] must be set.
In order to save credentials and adjust settings within the iOS Home Assistant app, the optional [`api_password`](/components/http/#api_password) must be set.
## {% linkable_title Setup %}

15
source/_posts/2019-01-09-release-85.markdown
View File

@ -51,6 +51,21 @@ This release also features native support for [ESPHome](https://esphomelib.com/e
- Add IDTECK proximity card component ([@dubnom] - [#18309]) ([idteck_prox docs]) (new-platform)
- Add ness alarm control panel using nessclient ([@nickw444] - [#18463]) ([ness_alarm docs]) ([alarm_control_panel.ness_alarm docs]) ([binary_sensor.ness_alarm docs]) (new-platform)
## {% linkable_title Release 0.85.1 - January 11 %}
- check config instead of config_entry for quirks flag ([@dmulcahey] - [#19730]) ([zha docs])
- Don't map LevelControl to light for single cluster devices. ([@Adminiuga] - [#19929]) ([zha docs])
- Fix entity_id: all warning ([@balloob] - [#19946])
- Lovelace: Fix resources being dropped in inline editor
[#19730]: https://github.com/home-assistant/home-assistant/pull/19730
[#19929]: https://github.com/home-assistant/home-assistant/pull/19929
[#19946]: https://github.com/home-assistant/home-assistant/pull/19946
[@Adminiuga]: https://github.com/Adminiuga
[@balloob]: https://github.com/balloob
[@dmulcahey]: https://github.com/dmulcahey
[zha docs]: /components/zha/
## {% linkable_title If you need help... %}
...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks.

688
source/developers/credits.markdown
View File

File diff suppressed because it is too large Load Diff

4
source/hassio/commandline.markdown
View File

@ -56,9 +56,9 @@ $ hassio hardware audio
To update Home Assistant to a specific version, use the command:
```bash
hassio homeassistant update --options version=x.y.z
hassio homeassistant update --version=x.y.z
```
Replace x.y.z with the desired version like `version=0.74.2`
Replace x.y.z with the desired version like `--version=0.74.2`
You can get a better description of the CLI capabilities by typing `hassio help`:

2
source/hassio/installation.markdown
View File

@ -100,6 +100,8 @@ apt-get update
apt-get install -y apparmor-utils apt-transport-https avahi-daemon ca-certificates curl dbus jq network-manager socat software-properties-common
curl -fsSL get.docker.com | sh
curl -sL "https://raw.githubusercontent.com/home-assistant/hassio-build/master/install/hassio_install" | bash -s
```

BIN
source/images/supported_brands/lupusec.jpg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 17 KiB

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

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 16 KiB

7
source/lovelace/changelog.markdown
View File

@ -8,6 +8,11 @@ comments: false
sharing: true
footer: true
---
## {% linkable_title Changes in 0.85.1 %}
- 🔧 Fix removal of `resources` on save in Raw Config Editor
- 🔧 Auto-gen correctly converts weblink entities to [weblink row]
- 🔧 The [weblink row] opens links in new tabs
## {% linkable_title Changes in 0.85.0 %}
- 📣 [map card]: New config `geo_location_sources`
- 📣 [alarm panel card]: Hide keypad if `code_format` attribute is not "Number"
@ -259,3 +264,5 @@ footer: true
[thermostat card]: /lovelace/thermostat/
[vertical stack card]: /lovelace/vertical-stack/
[weather forecast card]: /lovelace/weather-forecast/
[weblink row]: /lovelace/entities/#weblink

10
source/lovelace/yaml-mode.markdown
View File

@ -52,13 +52,8 @@ excluded_entities:
views:
# View tab title.
- title: Example
<<<<<<< HEAD
# Unique id for direct access /lovelace/${id} and editing it from the UI.
id: example
=======
# Unique path for direct access /lovelace/${path}
path: example
>>>>>>> origin/current
# Optional background (overwrites the global background).
background: radial-gradient(crimson, skyblue)
# Each view can have a different theme applied. Theme should be defined in the frontend.
@ -66,12 +61,7 @@ views:
# The cards to show on this view.
cards:
# The filter card will filter entities for their state
<<<<<<< HEAD
- id: peoplehome # Every card needs an ID, for it to be edited from the UI.
type: entity-filter
=======
- type: entity-filter
>>>>>>> origin/current
entities:
- device_tracker.paulus
- device_tracker.anne_there