mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-15 13:26:54 +00:00
Merge remote-tracking branch 'origin/current' into next
This commit is contained in:
commit
52ff7978c0
@ -14,7 +14,7 @@ featured: true
|
||||
If you are wanting to integrate your Google Home, or mobile phone running Google Assistant, with Home Assistant then you want the [Google Assistant component](https://home-assistant.io/components/google_assistant/).
|
||||
</p>
|
||||
|
||||
[Google Assistant][GoogleAssistant] is an AI-powered voice assistant that runs on the Raspberry Pi and x86 platforms and interact over [api.ai] with Home-Assistant. You can also use [Google Actions][GoogleActions] to extend its functionality.
|
||||
[Google Assistant][GoogleAssistant] is an AI-powered voice assistant that runs on the Raspberry Pi and x86 platforms and interact via the [DialogFlow][comp] integration with Home-Assistant. You can also use [Google Actions][GoogleActions] to extend its functionality.
|
||||
|
||||
To enable access to the Google Assistant API, do the following:
|
||||
|
||||
@ -71,14 +71,13 @@ Configuration variables:
|
||||
|
||||
### {% linkable_title Home Assistant configuration %}
|
||||
|
||||
Use the Home Assistant [api.ai component][comp] to integrate the add-on into Home Assistant.
|
||||
Use the Home Assistant [DialogFlow component][comp] to integrate the add-on into Home Assistant.
|
||||
|
||||
|
||||
[GoogleAssistant]: https://assistant.google.com/
|
||||
[GoogleActions]: https://actions.google.com/
|
||||
[api.ai]: https://api.ai/
|
||||
[Samba]: /addons/samba/
|
||||
[comp]: /components/apiai/
|
||||
[comp]: /components/dialogflow/
|
||||
[project]: https://console.cloud.google.com/project
|
||||
[API]: https://console.developers.google.com/apis/api/embeddedassistant.googleapis.com/overview
|
||||
[oauthclient]: https://console.developers.google.com/apis/credentials/oauthclient
|
||||
|
@ -48,10 +48,6 @@ binary_sensor:
|
||||
description: Name to use in the frontend.
|
||||
required: false
|
||||
type: string
|
||||
entity_id:
|
||||
description: Add a list of entity IDs so the sensor only reacts to state changes of these entities. This will reduce the number of times the sensor will try to update its state.
|
||||
required: false
|
||||
type: string, list
|
||||
device_class:
|
||||
description: The type/class of the sensor to set the icon in the frontend.
|
||||
required: false
|
||||
@ -126,13 +122,11 @@ binary_sensor:
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
### {% linkable_title Combining Multiple Sensors, and Using `entity_id` %}
|
||||
### {% linkable_title Combining Multiple Sensors %}
|
||||
|
||||
This example combines multiple CO sensors into a single overall
|
||||
status. When using templates with binary sensors, you need to return
|
||||
`true` or `false` explicitly. `entity_id` is used to limit which
|
||||
sensors are being monitored to update the state, making computing this
|
||||
sensor far more efficient.
|
||||
`true` or `false` explicitly.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
@ -142,10 +136,6 @@ binary_sensor:
|
||||
co:
|
||||
friendly_name: "CO"
|
||||
device_class: gas
|
||||
entity_id:
|
||||
- sensor.bedroom_co_status
|
||||
- sensor.kitchen_co_status
|
||||
- sensor.wardrobe_co_status
|
||||
value_template: >-
|
||||
{{ is_state('sensor.bedroom_co_status', 'Ok')
|
||||
and is_state('sensor.kitchen_co_status', 'Ok')
|
||||
@ -190,14 +180,6 @@ binary_sensor:
|
||||
- platform: template
|
||||
sensors:
|
||||
people_home:
|
||||
entity_id:
|
||||
- device_tracker.sean
|
||||
- device_tracker.susan
|
||||
- binary_sensor.office_124
|
||||
- binary_sensor.hallway_134
|
||||
- binary_sensor.living_room_139
|
||||
- binary_sensor.porch_ms6_1_129
|
||||
- binary_sensor.family_room_144
|
||||
value_template: >-
|
||||
{{ is_state('device_tracker.sean', 'home')
|
||||
or is_state('device_tracker.susan', 'home')
|
||||
|
@ -15,7 +15,7 @@ ha_iot_class: "Local Polling"
|
||||
|
||||
The `yi` camera platform allows you to utilize [Yi Home Cameras](https://www.yitechnology.com/) within Home Assistant. Specifically, this platform supports the line of Yi Home Cameras that are based on the Hi3518e Chipset. This includes:
|
||||
|
||||
* Yi Home 17CN
|
||||
* Yi Home 17CN / 27US / 47US
|
||||
* Yi 1080p Home
|
||||
* Yi Dome
|
||||
* Yi 1080p Dome
|
||||
@ -63,7 +63,7 @@ Configuration variables:
|
||||
- **host** (*Required*): The IP address or hostname of the camera.
|
||||
- **password** (*Required*): The password to the FTP server on the camera (from above).
|
||||
- **path** (*Optional*): The path to the raw MP4 files. Defaults to `/tmp/sd/record`.
|
||||
- **username** (*Optional*): The user that can access the FTP server. Ddefaults to `root`.
|
||||
- **username** (*Optional*): The user that can access the FTP server. Defaults to `root`.
|
||||
- **ffmpeg_arguments** (*Optional*): Extra options to pass to `ffmpeg` (e.g. image quality or video filter options).
|
||||
|
||||
## {% linkable_title Image quality %}
|
||||
|
@ -48,10 +48,6 @@ cover:
|
||||
description: Name to use in the frontend.
|
||||
required: false
|
||||
type: string
|
||||
entity_id:
|
||||
description: Add a list of entity IDs so the switch only reacts to state changes of these entities. This will reduce the number of times the cover will try to update its state.
|
||||
required: false
|
||||
type: [string, list]
|
||||
value_template:
|
||||
description: Defines a template to get the state of the cover. Valid values are `open`/`true` or `closed`/`false`. [`value_template`](#value_template) and [`position_template`](#position_template) cannot be specified concurrently.
|
||||
required: exclusive
|
||||
@ -201,9 +197,6 @@ cover:
|
||||
{% else %}
|
||||
mdi:window-closed
|
||||
{% endif %}
|
||||
entity_id:
|
||||
- cover.bedroom
|
||||
- cover.livingroom
|
||||
|
||||
sensor:
|
||||
- platform: template
|
||||
@ -217,9 +210,6 @@ sensor:
|
||||
{% else %}
|
||||
closed
|
||||
{% endif %}
|
||||
entity_id:
|
||||
- cover.bedroom
|
||||
- cover.livingroom
|
||||
|
||||
script:
|
||||
cover_group:
|
||||
|
@ -17,7 +17,7 @@ Z-Wave garage doors, blinds, and roller shutters are supported as cover in Home
|
||||
|
||||
To get your Z-Wave covers working with Home Assistant, follow the instructions for the general [Z-Wave component](/components/zwave/).
|
||||
|
||||
If you discover that you need to [invert the operation]](/docs/z-wave/installation/#invert_openclose_buttons) of open/close for a particular device, you may change this behavior in your Z-Wave section of your `configuration.yaml` file as follows:
|
||||
If you discover that you need to [invert the operation](/docs/z-wave/installation/#invert_openclose_buttons) of open/close for a particular device, you may change this behavior in your Z-Wave section of your `configuration.yaml` file as follows:
|
||||
|
||||
```yaml
|
||||
zwave:
|
||||
|
@ -13,7 +13,7 @@ ha_release: 0.21
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
The [EnOcean](https://en.wikipedia.org/wiki/EnOcean) standard is supported by many different vendors. There are switches and sensors of many different kinds, and typically they employ energy harvesting to get power such that no batteries are unnecessary.
|
||||
The [EnOcean](https://en.wikipedia.org/wiki/EnOcean) standard is supported by many different vendors. There are switches and sensors of many different kinds, and typically they employ energy harvesting to get power such that no batteries are necessary.
|
||||
|
||||
The `enocean` component adds support for some of these devices. You will need a controller like the [USB300](https://www.enocean.com/en/enocean_modules/usb-300-oem/) in order for it to work.
|
||||
|
||||
|
@ -17,6 +17,10 @@ The `http` component serves all files and data required for the Home Assistant f
|
||||
It is HIGHLY recommended that you set the `api_password`, especially if you are planning to expose your installation to the internet.
|
||||
</p>
|
||||
|
||||
<p class='note'>
|
||||
Don't use option `server_host` on a hass.io installation!
|
||||
</p>
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
http:
|
||||
|
@ -51,10 +51,6 @@ light:
|
||||
description: Name to use in the frontend.
|
||||
required: false
|
||||
type: string
|
||||
entity_id:
|
||||
description: Add a list of entity IDs so the switch only reacts to state changes of these entities. This will reduce the number of times the light will try to update its state.
|
||||
required: false
|
||||
type: [string, list]
|
||||
value_template:
|
||||
description: Defines a template to get the state of the light.
|
||||
required: false
|
||||
|
@ -17,7 +17,7 @@ ha_iot_class: "Local Polling"
|
||||
|
||||
Google Cast devices like Android TVs and Chromecasts will be automatically discovered if you enable [the discovery component]({{site_root}}/components/discovery/). There is a issue where Chromecasts can only be discovered if your device is connected to the same subnet as your Chromecast.
|
||||
|
||||
Chromecast platform can also be forced to load by adding the following lines to your `configuration.yaml`:
|
||||
The Chromecast platform can also be forced to load by adding the following lines to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -28,4 +28,15 @@ media_player:
|
||||
Configuration variables:
|
||||
|
||||
- **host** (*Optional*): Use only if you don't want to scan for devices.
|
||||
- **ignore_cec** (*Optional*) A list of chromecasts that should ignore CEC data for determining the active input. [See the upstream documentation for more information.](https://github.com/balloob/pychromecast#ignoring-cec-data)
|
||||
- **ignore_cec** (*Optional*) A list of Chromecasts that should ignore CEC data for determining the active input. [See the upstream documentation for more information.](https://github.com/balloob/pychromecast#ignoring-cec-data)
|
||||
|
||||
## {% linkable_title Example %}
|
||||
|
||||
By setting `host:` you can specify the Chromecast to use.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
media_player:
|
||||
- platform: cast
|
||||
host: 192.168.1.10
|
||||
```
|
||||
|
@ -33,7 +33,7 @@ The Home Assistant Neato platform has not been tested with all models of Botvac.
|
||||
| BotVac Model | Tested |
|
||||
| --- | --- |
|
||||
| Botvac Connected | SUCCESS |
|
||||
| Botvac D3 Connected (firmware 4.0+) | UNTESTED |
|
||||
| Botvac D3 Connected (firmware 4.0+) | PARTIALLY WORKING |
|
||||
| Botvac D5 Connected (firmware 4.0+) | PARTIALLY WORKING |
|
||||
| Botvac D7 Connected | SUCCESS |
|
||||
|
||||
|
@ -18,6 +18,9 @@ To use this notification platform you need to get a developer token. To obtain a
|
||||
|
||||
At this time you also need to specify the `Cisco Spark` `roomid`. The `roomid` can also be found at [Spark for Developers](https://developer.ciscospark.com/index.html). Just look in the Documentation under Rooms.
|
||||
|
||||
In order to get notified for all new messages in the room you will need to create a bot. This will post the messages from the bot and mark them as new for you which will alert you. If you use your own personal token the messages are added to the room but no notification is triggered.
|
||||
Once you have created the bot through the new App menu you will need to add the bot to the room that you are a member of as well. Now use the bot access token in your configuration below.
|
||||
|
||||
To enable the Cisco Spark notification in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
|
@ -36,7 +36,7 @@ Configuration variables:
|
||||
|
||||
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
|
||||
- **api_key** (*Required*): The Slack API token to use for sending Slack messages.
|
||||
- **default_channel** (*Required*): The default channel to post to if no channel is explicitly specified when sending the notification message.
|
||||
- **default_channel** (*Required*): The default channel to post to if no channel is explicitly specified when sending the notification message. A channel can be specified adding a target attribute to the json at the same level as "message"
|
||||
- **username** (*Optional*): Setting username will allow Home Assistant to post to Slack using the username specified. By default not setting this will post to Slack using the user account or botname that you generated the api_key as.
|
||||
- **icon** (*Optional*): Use one of the Slack emojis as an Icon for the supplied username. Slack uses the standard emoji sets used [here](http://www.webpagefx.com/tools/emoji-cheat-sheet/).
|
||||
|
||||
@ -60,6 +60,7 @@ Example for posting file from URL:
|
||||
{
|
||||
"message":"Message that will be added as a comment to the file.",
|
||||
"title":"Title of the file.",
|
||||
"target": ["#channelname"],
|
||||
"data":{
|
||||
"file":{
|
||||
"url":"http://[url to file, photo, security camera etc]",
|
||||
|
@ -47,6 +47,6 @@ automation:
|
||||
data:
|
||||
message: 'The sun has set'
|
||||
target:
|
||||
- +14151234567
|
||||
- +15105555555
|
||||
- '+14151234567'
|
||||
- '+15105555555'
|
||||
```
|
||||
|
@ -46,10 +46,6 @@ sensor:
|
||||
description: Name to use in the frontend.
|
||||
required: false
|
||||
type: string
|
||||
entity_id:
|
||||
description: Add a list of entity IDs so the sensor only reacts to state changes of these entities. This will reduce the number of times the sensor will try to update its state.
|
||||
required: false
|
||||
type: string, list
|
||||
unit_of_measurement:
|
||||
description: Defines the units of measurement of the sensor, if any.
|
||||
required: false
|
||||
@ -71,12 +67,11 @@ sensor:
|
||||
## {% linkable_title Considerations %}
|
||||
|
||||
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. This results
|
||||
in error messages in your log file until that platform has completed loading.
|
||||
If you use `is_state()` function in your template, you can avoid this situation.
|
||||
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
|
||||
with this equivalent that returns `true`/`false` and never gives an `unknown`
|
||||
result:
|
||||
{% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %}
|
||||
|
||||
|
@ -55,10 +55,6 @@ switch:
|
||||
description: Name to use in the frontend.
|
||||
required: false
|
||||
type: string
|
||||
entity_id:
|
||||
description: Add a list of entity IDs so the switch only reacts to state changes of these entities. This will reduce the number of times the switch will try to update its state.
|
||||
required: false
|
||||
type: [string, list]
|
||||
value_template:
|
||||
description: Defines a template to set the state of the switch.
|
||||
required: true
|
||||
|
@ -10,6 +10,7 @@ footer: true
|
||||
logo: tahoma.png
|
||||
ha_category: Hub
|
||||
ha_release: 0.59
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
|
||||
@ -38,4 +39,4 @@ exclude:
|
||||
description: Excludes devices
|
||||
required: false
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
{% endconfiguration %}
|
||||
|
@ -136,6 +136,14 @@ Here's a handy configuration for the Aeon Labs Minimote that defines all possibl
|
||||
scene_id: 8
|
||||
```
|
||||
|
||||
### {% linkable_title Zooz Toggle Switches %}
|
||||
|
||||
Some models of the Zooz Toggle switches ship with an instruction manual with incorrect instruction for Z-Wave inclusion/exclusion. The instructions say that the switch should be quickly switched on-off-on for inclusion and off-on-off for exclusion. However, the correct method is on-on-on for inclusion and off-off-off for exclusion.
|
||||
|
||||
## {% linkable_title Central Scene configuration %}
|
||||
|
||||
To provide Central Scene support you need to shut Home Assistant down and modify your `zwcfg_*.xml` file according to the following guides.
|
||||
|
||||
### {% linkable_title HomeSeer Switches %}
|
||||
|
||||
For the HomeSeer devices specifically, you may need to update the `COMMAND_CLASS_CENTRAL_SCENE` for each node in your `zwcfg` file with the following:
|
||||
@ -221,6 +229,6 @@ Button four single tap|4|0
|
||||
Button four hold|4|2
|
||||
Button four release|4|1
|
||||
|
||||
### {% linkable_title Zooz Toggle Switches %}
|
||||
### {% linkable_title WallC-S Switch %}
|
||||
|
||||
Some models of the Zooz Toggle switches ship with an instruction manual with incorrect instruction for Z-Wave inclusion/exclusion. The instructions say that the switch should be quickly switched on-off-on for inclusion and off-on-off for exclusion. However, the correct method is on-on-on for inclusion and off-off-off for exclusion.
|
||||
Use the same configuration as for the Aeotec Wallmote.
|
||||
|
@ -20,7 +20,7 @@ Use `hassio` to speak with the internal API.
|
||||
|
||||
## {% linkable_title Home Assistant %}
|
||||
|
||||
An add-on can speak to the [Home Assistant API][hass-api] with our internal proxy. That makes it very easy to communicate with the API without knowing the password, port or any other information of the Home Assistant instance. Use this URL: `http://hassio/homeassistant/api` and internal communication is redirected to the right place. The next stept is to add `homeassistant_api: true` to `config.json` and read the environment variable `API_TOKEN` and use this as Home-Assistant password.
|
||||
An add-on can speak to the [Home Assistant API][hass-api] with our internal proxy. That makes it very easy to communicate with the API without knowing the password, port or any other information of the Home Assistant instance. Use this URL: `http://hassio/homeassistant/api` and internal communication is redirected to the right place. The next stept is to add `homeassistant_api: true` to `config.json` and read the environment variable `HASSIO_TOKEN` and use this as Home-Assistant password.
|
||||
|
||||
We have also a proxy for [Websocket Home Assistant API][hass-websocket]. It work like the API proxy above and use `API_TOKEN` as password. Use this URL: `http://hassio/homeassistant/websocket`.
|
||||
|
||||
@ -30,7 +30,7 @@ We have severals services for Hass.io inside Home Assistant to execute tasks. To
|
||||
|
||||
## {% linkable_title Hass.io API %}
|
||||
|
||||
To enables calls to the [Hass.io API][hassio-api], add `hassio_api: true` to `config.json` and read the environment variable `API_TOKEN`. Now you can use the API over the URL: `http://hassio/`. Use the `API_TOKEN` with header `X-HASSIO-KEY`.
|
||||
To enables calls to the [Hass.io API][hassio-api], add `hassio_api: true` to `config.json` and read the environment variable `API_TOKEN`. Now you can use the API over the URL: `http://hassio/`. Use the `HASSIO_TOKEN` with header `X-HASSIO-KEY`.
|
||||
|
||||
[hass-api]: https://home-assistant.io/developers/rest_api/
|
||||
[hass-websocket]: https://home-assistant.io/developers/websocket_api/
|
||||
|
Loading…
x
Reference in New Issue
Block a user