mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 07:17:14 +00:00
Update cloud docs
This commit is contained in:
Paulus Schoutsen
parent
6702f48843
commit
99289b0894
@ -7,13 +7,13 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: home-assistant.png
|
||||
logo: nabu-casa.svg
|
||||
ha_release: "0.60"
|
||||
ha_category: Voice
|
||||
ha_iot_class: "Cloud Push"
|
||||
---
|
||||
|
||||
The Home Assistant Cloud allows you to quickly integrate your local Home Assistant with various cloud services like Amazon Alexa. [Learn more.](/cloud)
|
||||
The Home Assistant Cloud allows you to quickly integrate your local Home Assistant with various cloud services like Amazon Alexa and Google Assistant. [Learn more.](/cloud)
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry to enable the cloud component
|
||||
|
||||
@ -3,110 +3,14 @@ layout: page
|
||||
title: "Alexa via Home Assistant Cloud"
|
||||
description: "Enable the Alexa integration via Home Assistant Cloud integration."
|
||||
date: 2017-11-17 20:00
|
||||
sidebar: true
|
||||
sidebar: false
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
redirect_from: /components/cloud.alexa/
|
||||
---
|
||||
|
||||
The Alexa integration allows users to control the entities via the Home Assistant Smart Home skill for Alexa. This means that you can say things like "Alexa, turn on the kitchen light" to control your local Home Assistant.
|
||||
Home Assistant Cloud is a subscription service provided by our partner Nabu Casa, Inc. Check out [their website](https://www.nabucasa.com/config/amazon_alexa/) for help with the Amazon Alexa integration via Home Assistant Cloud.
|
||||
|
||||
To use this integration, you need to have:
|
||||
|
||||
- The cloud component set up. [Learn more](/components/cloud/)
|
||||
- An Alexa enabled device like the Amazon Echo
|
||||
- Activated the Home Assistant Smart Home skill via the Alexa app
|
||||
|
||||
You can use `configuration.yaml` to configure the entities that are being shown to Alexa and how they are exposed.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry configuring Alexa
|
||||
cloud:
|
||||
alexa:
|
||||
filter:
|
||||
include_entities:
|
||||
- light.kitchen
|
||||
- light.kitchen_left
|
||||
include_domains:
|
||||
- switch
|
||||
exclude_entities:
|
||||
- switch.outside
|
||||
entity_config:
|
||||
light.kitchen:
|
||||
name: Custom Name for Alexa
|
||||
description: The light in the kitchen
|
||||
switch.stairs:
|
||||
display_categories: LIGHT
|
||||
```
|
||||
|
||||
{% configuration cloud %}
|
||||
alexa:
|
||||
description: Configuration options for the Amazon Alexa integration.
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
filter:
|
||||
description: Filters for entities to include/exclude from Alexa.
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
include_entities:
|
||||
description: Entity IDs to include.
|
||||
required: false
|
||||
type: list
|
||||
include_domains:
|
||||
description: Domains to include.
|
||||
required: false
|
||||
type: list
|
||||
exclude_entities:
|
||||
description: Entity IDs to exclude.
|
||||
required: false
|
||||
type: list
|
||||
exclude_domains:
|
||||
description: Domains to exclude.
|
||||
required: false
|
||||
type: list
|
||||
entity_config:
|
||||
description: Entity specific configuration for Alexa
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
'`<ENTITY_ID>`':
|
||||
description: Entity to configure
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
name:
|
||||
description: Name of entity to show in Alexa
|
||||
required: false
|
||||
type: string
|
||||
description:
|
||||
description: Description of entity to show in Alexa
|
||||
required: false
|
||||
type: string
|
||||
display_categories:
|
||||
description: The display category to use in Alexa. [Available categories](https://developer.amazon.com/docs/device-apis/alexa-discovery.html#display-categories)
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
### {% linkable_title Possible values for customizing %}
|
||||
|
||||
_Configuration via `customize:` is no longer available. Use the entity config as described above._
|
||||
|
||||
### {% linkable_title Available domains %}
|
||||
Currently, the following domains are available to be used with Alexa:
|
||||
|
||||
- alert
|
||||
- automation (enables/disables)
|
||||
- cover
|
||||
- fan (supports on/off and set speed)
|
||||
- group
|
||||
- input_boolean
|
||||
- light
|
||||
- lock (lock and unlock, but unlock is untested as Amazon has disabled unlock for now)
|
||||
- media_player (play, pause, stop, set volume, adjust volume, next track, and previous track)
|
||||
- scene
|
||||
- script (enables/disables)
|
||||
- switch
|
||||
<div style='max-width: 250px; margin: 0 auto'><a href='https://www.nabucasa.com/config/amazon_alexa/'><img src='/images/blog/2018-09-thinking-big/logo-text.svg' style='border: 0; box-shadow: none' alt='Logo of Nabu Casa, Inc'></a>
|
||||
</div>
|
||||
|
||||
@ -3,115 +3,13 @@ layout: page
|
||||
title: "Google Assistant via Home Assistant Cloud"
|
||||
description: "Enable the Google Assistant via Home Assistant Cloud integration."
|
||||
date: 2017-11-17 20:00
|
||||
sidebar: true
|
||||
sidebar: false
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
<p class='note'>
|
||||
The minimum supported version of Home Assistant is 0.65.6.
|
||||
</p>
|
||||
Home Assistant Cloud is a subscription service provided by our partner Nabu Casa, Inc. Check out [their website](https://www.nabucasa.com/config/google_assistant/) for help with the Google Assistant integration via Home Assistant Cloud.
|
||||
|
||||
The Google Assistant integration allows users to control the entities via the Home Assistant Smart Home skill for Google Assistant. This means that you can say things like "Ok Google, turn on the kitchen light" to control your local Home Assistant.
|
||||
|
||||
To use this integration, you need to have:
|
||||
|
||||
- The cloud component set up. [Learn more](/components/cloud/)
|
||||
- A Google Assistant enabled device like the Google Home or a mobile phone running Google Assistant.
|
||||
- Activated the Home Assistant Smart Home skill for Google Assistant.
|
||||
- If you have a Google Home device, use the Google Home app, select *Home control*, and then add *hass.io* using the *Add devices* option.
|
||||
- If you only have a mobile phone, launch Google Assistant, select the three dots menu. Under *Settings* you'll find *Home Control*. There you can add *hass.io* using the *Add devices* option.
|
||||
|
||||
You can use `configuration.yaml` to configure the entities that are being shown to Google Assistant and how they are exposed.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry configuring Google Assistant
|
||||
cloud:
|
||||
google_actions:
|
||||
filter:
|
||||
include_entities:
|
||||
- light.kitchen
|
||||
- light.kitchen_left
|
||||
include_domains:
|
||||
- switch
|
||||
exclude_entities:
|
||||
- switch.outside
|
||||
entity_config:
|
||||
switch.kitchen:
|
||||
name: Custom Name for Google Assistant
|
||||
aliases:
|
||||
- bright lights
|
||||
- entry lights
|
||||
room: living room
|
||||
```
|
||||
|
||||
{% configuration cloud %}
|
||||
google_actions:
|
||||
description: Configuration options for the Google Assistant integration.
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
filter:
|
||||
description: Filters for entities to include/exclude from Google Assistant.
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
include_entities:
|
||||
description: Entity IDs to include.
|
||||
required: false
|
||||
type: list
|
||||
include_domains:
|
||||
description: Domains to include.
|
||||
required: false
|
||||
type: list
|
||||
exclude_entities:
|
||||
description: Entity IDs to exclude.
|
||||
required: false
|
||||
type: list
|
||||
exclude_domains:
|
||||
description: Domains to exclude.
|
||||
required: false
|
||||
type: list
|
||||
entity_config:
|
||||
description: Entity specific configuration for Google Assistant.
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
'`<ENTITY_ID>`':
|
||||
description: Entity to configure
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
name:
|
||||
description: Name of entity to show in Google Assistant.
|
||||
required: false
|
||||
type: string
|
||||
aliases:
|
||||
description: Aliases that can also be used to refer to this entity.
|
||||
required: false
|
||||
type: list
|
||||
room:
|
||||
description: Hint for Google Assistant in which room this entity is.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
### {% linkable_title Available domains %}
|
||||
|
||||
Currently, the following domains are available to be used with Google Assistant, listed with their default types:
|
||||
|
||||
- `group` (on/off)
|
||||
- `input_boolean` (on/off)
|
||||
- `scene` (on)
|
||||
- `script` (on)
|
||||
- `switch` (on/off)
|
||||
- `fan` (on/off)
|
||||
- `light` (on/off/brightness/rgb color/color temp)
|
||||
- `cover` (on/off/set position (via set brightness))
|
||||
- `media_player` (on/off/set volume (via set brightness))
|
||||
- `climate` (temperature setting)
|
||||
|
||||
<p class='note'>
|
||||
After setting up the cloud, if you make any device changes such as changing the name or adding a new device simply say "Ok Google, sync my devices" to get the changes to show up.
|
||||
</p>
|
||||
<div style='max-width: 250px; margin: 0 auto'><a href='https://www.nabucasa.com/config/google_assistant/'><img src='/images/blog/2018-09-thinking-big/logo-text.svg' style='border: 0; box-shadow: none' alt='Logo of Nabu Casa, Inc'></a>
|
||||
</div>
|
||||
|
||||
@ -3,7 +3,7 @@ layout: page
|
||||
title: "Home Assistant Cloud"
|
||||
description: "Enable the Home Assistant Cloud integration."
|
||||
date: 2017-11-17 20:00
|
||||
sidebar: true
|
||||
sidebar: false
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
@ -13,32 +13,7 @@ ha_category: Voice
|
||||
ha_iot_class: "Cloud Push"
|
||||
---
|
||||
|
||||
<p class='note'>The Home Assistant Cloud is currently free and will become part of the upcoming Community Support Package. [Learn more](/blog/2017/12/17/introducing-home-assistant-cloud/)</p>
|
||||
Home Assistant Cloud is a subscription service provided by our partner Nabu Casa, Inc. Check out [their website](https://www.nabucasa.com) For more information on features, pricing and how to configure Home Assistant.
|
||||
|
||||
The Home Assistant Cloud allows you to quickly integrate your local Home Assistant with various cloud services. The following integrations are currently available:
|
||||
|
||||
- [Amazon Alexa (Amazon Echo)](/cloud/alexa/)
|
||||
- [Google Assistant (Google Home)](/cloud/google_assistant/)
|
||||
|
||||
### {% linkable_title How does it work? %}
|
||||
|
||||
The Home Assistant Cloud has been designed with security in mind. When you activate the Cloud component, your instance will create a secure connection to the Home Assistant Cloud. There is no need for any further configuration or to expose your instance to the internet.
|
||||
|
||||
Integrations like Alexa or Google will deliver messages to our cloud which we will forward to your local instance for processing. We just forward the response back. This means that we do not have to store the state of your house in our cloud, we’re just the messenger!
|
||||
|
||||
You can find a list of frequently asked questions (and their answers) in [this blog post](/blog/2017/12/17/introducing-home-assistant-cloud/#faq).
|
||||
|
||||
### {% linkable_title Enabling the cloud %}
|
||||
|
||||
The Home Assistant Cloud is enabled by default. If not, add this to your configuration:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry to enable the cloud component
|
||||
cloud:
|
||||
```
|
||||
|
||||
Once activated, go to the configuration panel in Home Assistant and create an account and log in. If you are not seeing the **Configuration** panel, make sure you have the following option enabled in your configuration.yaml` file.
|
||||
|
||||
```yaml
|
||||
config:
|
||||
```
|
||||
<div style='max-width: 250px; margin: 0 auto'><a href='https://www.nabucasa.com'><img src='/images/blog/2018-09-thinking-big/logo-text.svg' style='border: 0; box-shadow: none' alt='Logo of Nabu Casa, Inc'></a>
|
||||
</div>
|
||||
|
||||
@ -3,36 +3,13 @@ layout: page
|
||||
title: "Troubleshooting Home Assistant Cloud"
|
||||
description: "Pointers to help troubleshooting issues with Home Assistant Cloud."
|
||||
date: 2018-07-17 20:00
|
||||
sidebar: true
|
||||
sidebar: false
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
Alright, so you got all excited, tried to setup cloud and it failed? Not to worry, here are some common issues and how to resolve them.
|
||||
Home Assistant Cloud is a subscription service provided by our partner Nabu Casa, Inc. Check out [their website](https://www.nabucasa.com/config/troubleshooting/) for help with troubleshooting.
|
||||
|
||||
## {% linkable_title Error fetching the cognito keyset %}
|
||||
|
||||
This issue can occur by Docker being misconfigured. This issue is especially common for people using the GENERIC installation of Hass.io on top of Ubuntu Bionic or another Linux installation. It is related to IPv6 being incorrectly marked as available.
|
||||
|
||||
The solution is to make sure that Docker uses a public available DNS server, like the Google ones. As root, run:
|
||||
|
||||
```
|
||||
mkdir -p /etc/docker
|
||||
echo '{"dns": ["8.8.8.8", "8.8.4.4"]}' > /etc/docker/daemon.json
|
||||
```
|
||||
|
||||
## {% linkable_title Alexa: We were unable to link Home Assistant at this time. Please try again later %}
|
||||
|
||||
Some users are experiencing an issue when they are setting up the Home Assistant skill inside the Alexa app. We are still researching what is going on. Some users have reported that the issue went away if they configured Alexa to not expose all entities. You can try this by changing your cloud configuration like this:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry configuring Alexa
|
||||
cloud:
|
||||
alexa:
|
||||
filter:
|
||||
include_entities:
|
||||
- light.kitchen
|
||||
```
|
||||
|
||||
If this resolves the issue, please report it in the #cloud channel on Discord as it can help us find the entities that are causing this issue.
|
||||
<div style='max-width: 250px; margin: 0 auto'><a href='https://www.nabucasa.com/config/troubleshooting/'><img src='/images/blog/2018-09-thinking-big/logo-text.svg' style='border: 0; box-shadow: none' alt='Logo of Nabu Casa, Inc'></a>
|
||||
</div>
|
||||
|
||||
1
source/images/supported_brands/nabu-casa.svg
Normal file
1
source/images/supported_brands/nabu-casa.svg
Normal file
@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 252.84 155.26"><defs><style>.cls-1{fill:#b1e2f8;}.cls-2{fill:#174b62;}.cls-3{fill:#fff;}</style></defs><title>logo</title><g id="Layer_2" data-name="Layer 2"><g id="Layer_1-2" data-name="Layer 1"><path class="cls-1" d="M218.27,75c0-.75.06-1.49.06-2.25A72.79,72.79,0,0,0,83.79,34.26a62.39,62.39,0,1,0-21.41,121H162.92V114.71H179.7v40.55h32.82A40.32,40.32,0,0,0,218.27,75Z"/><path class="cls-2" d="M212.1,91.65H194.89V59.79h4.36a3.91,3.91,0,0,0,0-7.81H69a3.91,3.91,0,0,0,0,7.81h4.36V91.65H56.16a3.91,3.91,0,0,0,0,7.82h4.35v55.79H162.92V114.71H179.7v40.55h28V99.47h4.36a3.91,3.91,0,1,0,0-7.82Z"/><rect class="cls-3" x="73.37" y="114.71" width="42.19" height="16.78"/><rect class="cls-3" x="139.08" y="67.35" width="16.78" height="16.8"/><rect class="cls-3" x="73.37" y="67.35" width="58.74" height="16.8"/><rect class="cls-3" x="162.92" y="67.35" width="16.78" height="16.8"/><rect class="cls-3" x="162.92" y="114.7" width="16.78" height="40.56"/></g></g></svg>
|
||||
|
After Width: | Height: | Size: 1011 B |
Loading…
x
Reference in New Issue
Block a user