home-assistant.io/source/_components/alexa.markdown

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, featured, ha_release

layout	title	description	date	sidebar	comments	sharing	footer	logo	ha_category	featured	ha_release
page	Alexa / Amazon Echo	Instructions how to connect Alexa/Amazon Echo to Home Assistant.	2015-12-13 13:02	true	false	true	true	amazon-echo.png	Voice	true	0.10

There are a few ways that you can use Amazon Echo and Home Assistant together.

• Turning devices on and off
• Build custom commands to use
• Create a new Flash Briefing source

No matter which method(s) you decide to use, please remember that Amazon Echo requires an active Internet connection to function. If your Internet is down or experiencing issues (or Amazon's infrastructure is having issues), none of these methods will work.

Amazon has released Echosim, a website that simulates the Alexa service in your browser. That way it is easy to test your skills without having access to a physical Amazon Echo.

{% linkable_title I just want to turn devices on and off using Echo %}

If you just want to be able to turn anything with a switch (like lights, switches, media players, etc) on and off, you should enable the Emulated Hue component. It makes your Home Assistant appear as if it were a Phillips Hue bridge, which Echo works with natively.

Enabling the Emulated Hue component means you can turn things on and off by simply saying

Alexa, turn the living room lights on.

or

Alexa, set the living room lights to twenty percent.

instead of

Alexa, tell Home Assistant to turn the living room lights on.

or

Alexa, tell Home Assistant to set the living room lights to twenty percent.

In addition, you would need to build custom intents for each device and on/off combination using the below method, whereas everything just works without any extra work by using Emulated Hue.

Please note that you can use Emulated Hue and the built-in Alexa component side-by-side without issue if you wish.

{% linkable_title I want to build custom commands to use with Echo %}

The built-in Alexa component allows you to integrate Home Assistant into Alexa/Amazon Echo. This component will allow you to query information and call services within Home Assistant by using your voice. Home Assistant offers no built-in sentences but offers a framework for you to define your own.

{% linkable_title Requirements %}

Amazon requires the endpoint of a skill to be hosted via SSL. Self-signed certificates are ok because our skills will only run in development mode. Read more on our blog about how to set up encryption for Home Assistant. If you are unable to get HTTPS up and running, consider using this AWS Lambda proxy for Alexa skills.

To get started with Alexa skills:

• Log in to Amazon developer 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 as the large icon and this one as the small one.

{% linkable_title Configuring your Amazon Alexa skill %}

Alexa works based on intents. Each intent has a name and variable slots. For example, a LocateIntent with a slot that contains a User. Example intent schema:

{
  "intents": [
    {
      "intent": "LocateIntent",
      "slots": [
      {
          "name": "User",
          "type": "AMAZON.US_FIRST_NAME"
        }]
    },
    {
      "intent": "WhereAreWeIntent",
      "slots": []
    }
  ]
}

To bind these intents to sentences said by users you define utterances. Example utterances can look like this:

LocateIntent Where is {User}
LocateIntent Where's {User}
LocateIntent Where {User} is
LocateIntent Where did {User} go

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

{% linkable_title Configuring Home Assistant %}

Out of the box, the component will do nothing. You have to teach it about all intents you want it to answer to. The way it works is that the answer for each intent is based on templates that you define. Each template will have access to the existing states via the states variable but will also have access to all variables defined in the intent.

You can use templates for the values of speech/text, card/title and card/content.

Actions are using the Home Assistant Script Syntax and also have access to the variables from the intent.

Configuring the Alexa component for the above intents would look like this:

{% raw %}# Example configuration.yaml entry
alexa:
  intents:
    WhereAreWeIntent:
      speech:
        type: plaintext
        text: >
          {%- if is_state('device_tracker.paulus', 'home') and
                 is_state('device_tracker.anne_therese', 'home') -%}
            You are both home, you silly
          {%- else -%}
            Anne Therese is at {{ states("device_tracker.anne_therese") }}
            and Paulus is at {{ states("device_tracker.paulus") }}
          {% endif %}

    LocateIntent:
      action:
        service: notify.notify
        data_template:
          message: The location of {{ User }} has been queried via Alexa.
      speech:
        type: plaintext
        text: >
          {%- for state in states.device_tracker -%}
            {%- if state.name.lower() == User.lower() -%}
              {{ state.name }} is at {{ state.state }}
            {%- elif loop.last -%}
              I am sorry, I do not know where {{ User }} is.
            {%- endif -%}
          {%- else -%}
            Sorry, I don't have any trackers registered.
          {%- endfor -%}
      card:
        type: simple
        title: Sample title
        content: Some more content{% endraw %}

{% linkable_title Working With Scenes %}

One of the most useful applications of Alexa integrations is to call scenes directly. This is easily achieved with some simple setup on the Home Assistant side and by letting Alexa know which scenes you want to run.

First we will configure Alexa. In the Amazon Interaction module add this to the intent schema:

{
  "intent": "ActivateSceneIntent",
  "slots":
  [
    {
      "name" : "Scene",
      "type" : "Scenes"
    }
  ]
}

Then create a custom slot type called Scenes listing every scene you want to control:

Custom slot type for scene support.

The names must exactly match the scene names (minus underscores - amazon discards them anyway and we later map them back in with the template).

Add a sample utterance:

ActivateSceneIntent activate {Scene}

Then add the intent to your Alexa Section in your HA config file:

    ActivateSceneIntent:
      action:
        service: scene.turn_on
        data_template:
          entity_id: scene.{% raw %}{{ Scene | replace(" ", "_") }}{% endraw %}
      speech:
        type: plaintext
        text: OK

Here we are using templates to take the name we gave to Alexa e.g. downstairs on and replace the space with an underscore so it becomes downstairs_on as Home Assistant expects.

Now say Alexa ask homeassistant to activate <some scene> and Alexa will activate that scene for you.

{% linkable_title Adding Scripts %}

We can easily extend the above idea to work with scripts as well. As before, add an intent for scripts:

{
  "intent": "RunScriptIntent",
  "slots":
  [
    {
      "name" : "Script",
      "type" : "Scripts"
    }
  ]
}

Create a custom slot type called Scripts listing every script you want to run:

Custom slot type for script support.

Add a sample utterance:

RunScriptIntent run {Script}

Then add the intent to your Alexa Section in your HA config file:

    RunScriptIntent:
      action:
        service: script.turn_on
        data_template:
          entity_id: script.{% raw %}{{ Script | replace(" ", "_") }}{% endraw %}
      speech:
        type: plaintext
        text: OK

Now say Alexa ask homeassistant to run <some script> and Alexa will run that script for you.

{% linkable_title Giving Alexa Some Personality %}

In the examples above, we told Alexa to say OK when she successfully completed the task. This is effective but a little dull! We can again use templates to spice things up a little.

First create a file called alexa_confirm.yaml with something like the following in it (go on, be creative!):

{% raw %}          >
          {{ [
          "OK",
          "Sure",
          "If you insist",
          "Done",
          "No worries",
          "I can do that",
          "Leave it to me",
          "Consider it done",
          "As you wish",
          "By your command",
          "Affirmative",
          "Yes oh revered one",
          "I will",
          "As you decree, so shall it be",
          "No Problem"
          ] | random }} {% endraw %}

Then, wherever you would put some simple text for a response like OK, replace it with a reference to the file so that:

text: OK

becomes:

text: !include alexa_confirm.yaml

Alexa will now respond with a random phrase each time. You can use the include for as many different intents as you like so you only need to create the list once.

{% linkable_title Flash Briefing Skills %}

As of version 0.31 Home Assistant supports the new Alexa Flash Briefing Skills API. A Flash Briefing Skill adds a new Flash Briefing source that is generated by Home Assistant.

{% linkable_title Configuring a Flash Briefing skill in Home Assistant %}

You can use templates for the title, audio, text and display_url configuration parameters.

Here's an example configuration of a Flash briefing skill that will tell you who is at home:

{% raw %}# Example configuration.yaml entry
alexa:
  flash_briefings:
    whoishome:
      - title: Who's at home?
        text: >
          {%- if is_state('device_tracker.paulus', 'home') and
                 is_state('device_tracker.anne_therese', 'home') -%}
            You are both home, you silly
          {%- else -%}
            Anne Therese is at {{ states("device_tracker.anne_therese") }}
            and Paulus is at {{ states("device_tracker.paulus") }}
          {% endif %}{% endraw %}

You can add multiple items for a feed if you want. The Amazon required uid and timestamp will be randomly generated at startup and change at every restart of Home Assistant.

Please refer to the Amazon documentation for more information about allowed configuration parameters and formats.

{% linkable_title Configuring your Flash Briefing skill %}

• Log in to Amazon developer console
• Click the Alexa navigation tab at the top of the console
• Click on the "Get Started >" button under "Alexa Skills Kit"
• Click the yellow "Add a new skill" button in the top right
  • Skill Information
    • For Skill Type select "Flash Briefing Skill API"
    • You can enter whatever name you want
    • Hit "Next"
  • Interaction Model
    • Nothing to do here
  • Configuration
    • Add new feed
      • For URL, enter https://YOUR_HOST/api/alexa/flash_briefings/BRIEFING_ID?api_password=YOUR_API_PASSWORD where BRIEFING_ID is the key you entered in your configuration (such as whoishome in the above example). NOTE: Do not use a non-standard http or https port, AWS will not connect to it.
      • You can use this specially sized Home Assistant logo as the Feed Icon
      • 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.
• To invoke your flash briefing, open the Alexa app on your phone or go to the Alexa Setings 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".