Add cloud update
This commit is contained in:
Paulus Schoutsen
parent
fcded280af
commit
d3279215b1
8 changed files with 87 additions and 34 deletions
114
source/cloud/alexa.markdown
Normal file
114
source/cloud/alexa.markdown
Normal file
|
|
@ -0,0 +1,114 @@
|
|||
---
|
||||
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
|
||||
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][alexa skill]. This means that you can say things like "Alexa, 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/)
|
||||
- An Alexa enabled device like the Amazon Echo
|
||||
- Activated the [Home Assistant Smart Home skill for Alexa][alexa skill]
|
||||
|
||||
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
|
||||
|
||||
[alexa skill]: https://alexa.amazon.com/spa/index.html#skills/dp/B0772J1QKB/?ref=skill_dsk_skb_sr_2
|
||||
94
source/cloud/google_assistant.markdown
Normal file
94
source/cloud/google_assistant.markdown
Normal file
|
|
@ -0,0 +1,94 @@
|
|||
---
|
||||
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
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
published: false
|
||||
---
|
||||
|
||||
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
|
||||
- Activated the Home Assistant Smart Home skill for Google Assistant
|
||||
|
||||
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
|
||||
type: 'action.devices.types.LIGHT'
|
||||
```
|
||||
|
||||
{% 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
|
||||
type:
|
||||
description: Override the type of the entity in Google Assistant. [List of available types](https://developers.google.com/actions/smarthome/guides/)
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
47
source/cloud/index.markdown
Normal file
47
source/cloud/index.markdown
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Home Assistant Cloud"
|
||||
description: "Enable the Home Assistant Cloud integration."
|
||||
date: 2017-11-17 20:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: home-assistant.png
|
||||
ha_release: "0.60"
|
||||
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>
|
||||
|
||||
The Home Assistant Cloud allows you to quickly integrate your local Home Assistant with various cloud services like Amazon Alexa.
|
||||
|
||||
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 will deliver messages to our cloud which we will forward to your local instance for processing. We just forward the response back to Alexa. 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:
|
||||
```
|
||||
Loading…
Add table
Add a link
Reference in a new issue