jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Alexa: proactive api config (#7452)

Browse Source 
* Add config for alexa proactive mode

* Add tips on proactive mode attributes
This commit is contained in:
Abílio Costa 2019-01-04 16:40:59 +00:00 committed by Paulus Schoutsen
parent 9d5e147201
commit 7116d2c9e6
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
source/_components/alexa.markdown
View File

@ -358,6 +358,9 @@ the integration work easier. Example configuration:
```yaml ```yaml
alexa: alexa:
smart_home: smart_home:
endpoint: https://api.amazonalexa.com/v3/events
client_id: !secret alexa_client_id
client_secret: !secret alexa_client_secret
filter: filter:
include_entities: include_entities:
- light.kitchen - light.kitchen
@ -373,13 +376,17 @@ alexa:
switch.stairs: switch.stairs:
display_categories: LIGHT display_categories: LIGHT
``` ```
This exposes an HTTP POST endpoint at `http://your_hass_ip/api/alexa/smart_home` This exposes an HTTP POST endpoint at `http://your_hass_ip/api/alexa/smart_home`
which accepts and returns messages conforming to the which accepts and returns messages conforming to the
[Smart Home v3 payload](https://developer.amazon.com/docs/smarthome/smart-home-skill-api-message-reference.html). [Smart Home v3 payload](https://developer.amazon.com/docs/smarthome/smart-home-skill-api-message-reference.html).
You must then create an Amazon developer account with an Alexa skill and Lambda You must then create an Amazon developer account with an Alexa skill and Lambda
function to integrate this endpoint. See function to integrate this endpoint. See
[Haaska](https://github.com/mike-grant/haaska) for an example. [Haaska](https://github.com/mike-grant/haaska) for an example.
The `endpoint`, `client_id` and `client_secret` are optional, and are only required if you want to enable Alexa's proactive mode. Please note the following if you want to enable proactive mode:
- There are different endpoint urls, depending on the region of your skill. Please check the available endpoints at https://developer.amazon.com/docs/smarthome/send-events-to-the-alexa-event-gateway.html#endpoints
- The `client_id` and `client_secret` are not the ones used by the skill that have been set up using "Login with Amazon" (in the Alexa Developer Console: Build > Account Linking), but rather from the "Alexa Skill Messaging" (in the Alexa Developer Console: Build > Permissions > Alexa Skill Messaging). To get them, you need to enable the "Send Alexa Events" permission.
- If the "Send Alexa Events" permission was not enabled previously, you need to unlink and relink the skill using the Alexa App, or else Home Assistant will show the following error: "Token invalid and no refresh token available."
[amazon-dev-console]: https://developer.amazon.com [amazon-dev-console]: https://developer.amazon.com
[flash-briefing-api]: https://developer.amazon.com/alexa-skills-kit/flash-briefing [flash-briefing-api]: https://developer.amazon.com/alexa-skills-kit/flash-briefing