home-assistant.io/source/_components/cloud.alexa.markdown
Paulus Schoutsen b4b0972cc5
Add docs for entity_config for Google Assistant and Alexa (#4386)
* Update cloud docs and google assistant docs

* Unpublish Google Assistant

* ✏️ Grammar

* ✏️ Missing comma

* ✏️ Spelling & grammar
2018-01-11 13:45:14 -08:00

3.6 KiB

layout title description date sidebar comments sharing footer logo ha_release ha_category ha_iot_class
page Alexa via Home Assistant Cloud Enable the Alexa integration via Home Assistant Cloud integration. 2017-11-17 20:00 true false true true home-assistant.png 0.60 Cloud Cloud Push

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.

To use this integration, you need to have:

Only Amazon US is currently supported. Other regions are being certified.

You can use configuration.yaml to configure the entities that are being shown to Alexa and how they are exposed.

# 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 %} 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 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