This unofficial Star Wars skill brings the dulcet tones of everyone's favorite. There are currently over 50,000 Alexa Skills available today, and that number is growing by an amazing 10,000 skills every four months. Essentially, a skill is a voice-triggered task that Alexa will do for you. For example, 'Alexa, give me the top headlines' is a skill that will trigger a search for top news from that day. How to Use Alexa's Skills To use an Alexa skill, you'll need to enable it. Say, 'Alexa, enable skill name,' and Alexa issues voice-prompt instructions, if needed, to complete the process. You can also go to the Alexa app, browse through skills to find something that interests you, then tap Enable Skill to get started.
Amazon Alexa provides a Smart Home API for richer home automation control without requiring the user to say the skill name, such as:
- 'Alexa, turn off the light.'
- 'Alexa, set the thermostat to cool.'
- 'Alexa, is the garage door open?'
It takes considerable effort to configure. Your Home Assistant instance must be accessible from the Internet, and you need to create an Amazon Developer account and an Amazon Web Services (AWS) account. An easier solution is to use Home Assistant Cloud.
The Emulated Hue integration provides a simpler alternative to use utterances such as 'Alexa, turn on the kitchen light'. However, it has some limitations since everything looks like a light bulb.
With Home Assistant Cloud, you can connect your Home Assistant instance in a few simple clicks to Amazon Alexa. With Home Assistant Cloud you don't have to deal with dynamic DNS, SSL certificates or opening ports on your router. Just log in via the user interface and a secure connection with the cloud will be established. Home Assistant Cloud requires a paid subscription after a 30-day free trial.
For Home Assistant Cloud Users, documentation can be found here.
Steps to Integrate an Amazon Alexa Smart Home Skill with Home Assistant:
- Create an AWS Lambda Function
Requirements
- The Alexa Smart Home API requires your Home Assistant instance to be accessible from the internet via HTTPS on port 443 using an SSL/TLS certificate. A self-signed certificate will work, but a certificate signed by an Amazon approved certificate authority is recommended. Read more on our blog about how to set up encryption for Home Assistant. When running Home Assistant using the Duck DNS add-on is the easiest method.
- Amazon Developer Account. Sign up here.
- An Amazon Web Services (AWS) account is required to host the Lambda function for your Alexa Smart Home Skill. AWS Lambda is free to use for up to 1-million requests and 1GB outbound data transfer per month.
Create an Amazon Alexa Smart Home Skill
- Sign in Alexa Developer Console, you can create your free account on the sign in page.
- Go to
Alexa Skills
page if you are not, clickCreate Skill
button to start the process. - Input
Skill name
as you like, select your skill'sDefault language
. - Select
Smart Home
andProvision your own
, then clickCreate skill
button at top right corner.
- In next screen, make sure v3 is selected in
Payload version
. - Now, you have created a skeleton of Smart Home skill. Next step we will do some 'real' developer work. You can keep Alexa Developer Console opened, we need change the skill configuration later.
Create an AWS Lambda Function
Alexa Smart Home skill will trigger a AWS Lambda function to process the request, we will write a small piece of code hosted as an Lambda function basically redirect the request to your Home Assistant instance, then the Alexa integration in Home Assistant will process the request and send back the response. Your Lambda function will deliver the response back to Alexa.
There already are some great tutorials and solutions in our community to achieve same goal 'Create your Alexa Smart Home Skill to connect Home Assistant', for example: haaska.
You can follow this document or others, but you cannot mixed-match different solutions since they may have different design.
Free image editor download for mac. Amazon also provided a step-by-step guide to create a Smart Home Skill, however you have to adapt its sample code to match Home Assistant API.
OK, let's go. You first need to sign in to your AWS console, if you don't have an AWS account yet, you can create a new user here with 12-month free tire benefit. You don't need worry the cost if your account already pass the first 12 months, AWS provides up to 1 million Lambda request, 1GB outbound data and all inbound data for free, every month, all users. See Lambda pricing for details.
Create an IAM Role for Lambda
First thing you need to do after sing in AWS console is to create an IAM Role for Lambda execution. AWS has very strict access control, you have to specific define and assign the permissions.
- Click
Services
in top navigation bar, expand the menu to display all AWS services, clickIAM
underSecurity, Identity, & Compliance
section to navigate to IAM console. Or you may use this link - Click
Roles
in the left panel, then clickCreate role
, selectAWS Service
->Lambda
in the first page of the wizard, then clickNext: Permissions
- Select
AWSLambdaBasicExecutionRole
policy, then clickNext: Tags
. (Tips: you can use the search box to filter the policy)
- You can skip
Add tags
page, clickNext: Review
. - Give your new role a name, such as
AWSLambdaBasicExecutionRole-SmartHome
, then clickCreate role
button. You should be able to find your new role in the roles list now.
Add Code to the Lambda Function
Next you need create a Lambda function.
Click
Services
in top navigation bar, expand the menu to display all AWS services, clickLambda
underCompute
section to navigate to Lambda console. Or you may use this linkIMPORTANT - Alexa Skills are only supported in certain AWS reigons Your current server location will be displayed on the top right corner (for example, Ohio), make sure you select the server closest to your location / region based on your Amazon account's country, whilst also ensuring that it is within one of the supported reigons for Alexa Skills otherwise this will not work!
- US East (N.Virginia) region for English (US) or English (CA) skills
- EU (Ireland) region for English (UK), English (IN), German (DE), Spanish (ES) or French (FR) skills
- US West (Oregon) region for Japanese and English (AU) skills.
Click
Functions
in the left navigation bar, display list of your Lambda functions.Click
Create function
, selectAuthor from scratch
, then input aFunction name
.Select Python 3.6 or Python 3.7 as
Runtime
.Make sure select Use an existing role as
Execution role
, then select the role you just created fromExisting role
list.Click
Create function
, then you can configuration detail of Lambda function.Under
Configuration
tab, expandDesigner
(if it isn't already expanded), then click+ Add trigger
in the left part of the panel, then clickAlexa Smart Home
from the drop down list to add a Alexa Smart Home trigger to your Lambda function.You will then be prompted to input the
Skill ID
from the skill you created in previous step. (Tips: you may need switch back to Alexa Developer Console to copy theSkill ID
.) Then clickAdd
.Click your Lambda function icon in the middle of the diagram (above Layers), scroll down you will see a
Function code
window.Clear the example code, copy the Python script from: https://gist.github.com/matt2005/744b5ef548cc13d88d0569eea65f5e5b (modified code to support Alexa's proactive mode, see details below)
Click
Deploy
button to publish updated code.Scroll down a little bit, you will find
Environment variables
, you need add 1 environment variable and, if required, 3 optional variables. This is done by selectingManage environment variables
then adding the following:- (required) Key = BASE_URL, Value = your Home Assistant instance's Internet accessible URL with port if needed. Do not include the trailing
/
. - (optional) Key = NOT_VERIFY_SSL, Value = True. You can set this to True to ignore SSL issues, for example if you don't have a valid SSL certificate or you are using a self-signed certificate.
- (optional) Key = DEBUG, Value = True. Set this variable to log the debug message.
- (optional, not recommend) Key = LONG_LIVED_ACCESS_TOKEN, Value = your Home Assistant Long-Lived Access Token. To avoid the use of a long-lived access token you will connect your Alexa Smart Home skill with your Home Assistant user account in the later steps, meaning you don't need to add it here. However, the access token you got from login flow is only valid for 30 minutes. It will be hard for you to test lambda function with the access token in test data. So for your convenience, you can remove the access token from the test data, generate a long-lived access token put here, then the function will fall back to read token from environment variables. (tips: You did not enable the security storage for your environment variables, so your token saved here is not that safe. You should only use it for debugging and testing purpose. You should remove and delete the long-lived access token after you finish the debugging.)
- (required) Key = BASE_URL, Value = your Home Assistant instance's Internet accessible URL with port if needed. Do not include the trailing
- Now click the
Save
button in the bottom right hand corner. - You will then be brought back to your function configuration. From here you need to select
Save
in the top right hand corner of the screen. - You also need to copy the ARN displayed in the top of the page, which is the identity of this Lambda function. You will need this ARN to continue Alexa Smart Home skill configuration later.
Test the Lambda Function
Now, you have created the Lambda function, before you can test it, you have to set up the necessary aspects of your Home Assistant configuration. Put the following minimal configuration into your configuration.yaml
file. It will expose all of your supported devices and automations to Alexa. Check the configuration section if you want more control of the exposure.
After your Home Assistant has restarted, go back to AWS Lambda Console
, you are going to do some tests.
- On the top of your Lambda function configuration page, there is a
Test
button, to the left of this button is a drop down button - click this and selectConfigure test events
- Select
Create new test event
- Name your event, for example
Discovery
- Enter the following data into the code box below
Event name
:
- Click
Create
in the bottom right hand corner.
This test event is a Discovery
directive, your Home Assistant instance will respond with a list of devices Alexa can interact with. This test data is lack of token
in payload.scope
, your Lambda function will read the LONG_LIVED_ACCESS_TOKEN
from environment variable.
Click the Test
button. If you don't have LONG_LIVED_ACCESS_TOKEN
, you will get a INVALID_AUTHORIZATION_CREDENTIAL
response as the execution result.
Now, you can login to your Home Assistant and generate a long-lived access token. After you put your long-lived access token to the Environment variable
, do not forget click Save
button before you Test
again.
This time, you will get a list of your devices in the response. ๐
Configure the Smart Home Service Endpoint
Now remove the long-lived access token (if you want), copy the ARN of your Lambda function, then navigate back to Alexa Developer Console. You will finish the configuration of the Smart Home skill.
- Sign in Alexa Developer Console, go to
Alexa Skills
page if you are not. - Find the skill you just created, click
Edit
link in theActions
column. - Click
SMART HOME
in the left navigation bar of build page. - Fill in
Default endpoint
under2. Smart Home service endpoint
using theARN
you copied from your Lambda function configuration.
Account Linking
Alexa can link your Amazon account to your Home Assistant account. Therefore Home Assistant can make sure only authenticated Alexa request be able to access your home's devices. In order to link the account, you have to make sure your Home Assistant can be accessed from Internet.
- Sign in Alexa Developer Console, go to
Alexa Skills
page if you are not. - Find the skill you just created, click
Edit
link in theActions
column. - Click
ACCOUNT LINKING
in the left navigation bar of build page - Do not turn on the 'Allow users to link their account to your skill from within your application or website' switch. This will require a Redirect URI, which won't work.
- Input all information required. Assuming your Home Assistant can be accessed by
https://[YOUR HOME ASSISTANT URL:PORT]
Authorization URI
:https://[YOUR HOME ASSISTANT URL]/auth/authorize
Access Token URI
:https://[YOUR HOME ASSISTANT URL]/auth/token
Best mac specs for music production.- Note: you must use a valid/trusted SSL Certificate and port 443 for account linking to work
Client ID
:https://pitangui.amazon.com/
if you are in UShttps://layla.amazon.com/
if you are in EUhttps://alexa.amazon.co.jp/
if you are in JP and AU (not verified yet)
The trailing slash is important here.
Client Secret
: input anything you like, Home Assistant does not check this fieldYour Authentication Scheme
: make sure you selected Credentials in request body. Home Assistant does not support HTTP Basic.Scope
: Click+ Add scope
and inputsmart_home
, Home Assistant is not using it yet, we may use it in the future when we allow more fine-grained access control.
- You can leave
Domain List
andDefault Access Token Expiration Time
as empty.
- Click
Save
button in the top right corner. - Next, you will use Alexa Mobile App or Alexa web-based app to link your account.
- Open the Alexa app, navigate to
Skills & Games
->Your Skills
->Dev
- Click the Smart Home skill you just created.
- Click
Enable to use
. - A new window will open to direct you to your Home Assistant's login screen.
- After you successfully login, you will be redirected back to Alexa app.
- You can discover your devices now!
- Open the Alexa app, navigate to
- Now, you can ask your Echo or in Alexa App, 'Alexa, turn on bedroom' ๐
Alexa Smart Home Component Configuration
Example configuration:
Configuration Variables
Alexa configuration
Alexa Smart Home configuration
The locale of your Alexa devices. Supported locales are de-DE
, en-AU
, en-CA
, en-GB
, en-IN
, en-US
, es-ES
, es-MX
, fr-CA
, fr-FR
, it-IT
, ja-JP
. See Alexa Locale for additional information.
To enable proactive events, you send a message to the Alexa event gateway, send it to the event endpoint that aligns with the geographic availability of your smart home skill. Following is the list of endpoints and the regions they cover. See Proactive Events for more information.
- North America:
https://api.amazonalexa.com/v3/events
- Europe:
https://api.eu.amazonalexa.com/v3/events
- Far East:
https://api.fe.amazonalexa.com/v3/events
See Proactive Events for more information.
See Proactive Events for more information.
Filter domains and entities for Alexa. (Configure Filter)
List of domains to include (e.g., light
).
List of domains to exclude (e.g., light
).
Include all entities matching a listed pattern (e.g., binary_sensor.*_motion
).
Exclude all entities matching a listed pattern (e.g., binary_sensor.*_motion
).
List of entities to include (e.g., light.attic
).
List of entities to exclude (e.g., light.attic
).
Configuration for specific entities. All subordinate keys are the corresponding entity ids or the domains, e.g., alarm_control_panel.woowoo
.
Additional options for specific entities.
Name of the entity to show in Amazon Alexa App.
Description of the entity to show in Amazon Alexa App.
Display category and iconography each entity is shown in the Alexa app. Separate each category with a comma. First category is primary. e.g., MUSIC_SYSTEM,STREAMING_DEVICE,SPEAKER
. See Alexa Display Categories for a list of available categories.
Alexa Locale
The locale
should match the location and language used for your Amazon echo devices.
The supported locales are:
de-DE
en-AU
en-CA
en-GB
en-IN
en-US
es-ES
es-MX
fr-CA
fr-FR
it-IT
ja-JP
See List of Capability Interfaces and Supported Locales.
Proactive Events
The endpoint
, client_id
and client_secret
are optional, and are only required if you want to enable Alexa's proactive mode (i.e., 'Send Alexa Events' enabled). 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
andclient_secret
are not the ones used by the skill that have been set up using 'Login with Amazon' (in the [Alexa Developer Console][amazon-dev-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. Also, you need to restart your Home Assistant after each disabling/enabling the skill in Alexa.'
Configure Filter
By default, no entity will be excluded. To limit which entities are being exposed to Alexa, you can use the filter
parameter. Keep in mind that only supported platforms can be added.
Filters are applied as follows:
- No includes or excludes - pass all entities
- Includes, no excludes - only include specified entities
- Excludes, no includes - only exclude specified entities
- Both includes and excludes:
- Include domain and/or glob patterns specified
- If domain is included, and entity not excluded or match exclude glob pattern, pass
- If entity matches include glob pattern, and entity does not match any exclude criteria (domain, glob pattern or listed), pass
- If domain is not included, glob pattern does not match, and entity not included, fail
- Exclude domain and/or glob patterns specified and include does not list domains or glob patterns
- If domain is excluded and entity not included, fail
- If entity matches exclude glob pattern and entity not included, fail
- If entity does not match any exclude criteria (domain, glob pattern or listed), pass
- Neither include or exclude specifies domains or glob patterns
- If entity is included, pass (as #2 above)
- If entity include and exclude, the entity exclude is ignored
- Include domain and/or glob patterns specified
See the troubleshooting if for issues setting up the integration. Mac catalina screenshot.
Alexa Display Categories
Configure a display category to override the display category and iconography each entity is shown in the Alexa app. This makes it easier to find and monitor devices.
See Alexa Display Categories for a complete list
Supported Platforms
Home Assistant supports the following integrations through Alexa using a Smart Home Skill. For Home Assistant Cloud Users, documentation can be found here.
The following integrations are currently supported:
- Binary Sensor
- Cover
- Fan
- Light
- Media Player
Alarm Control Panel
Arm and disarm Alarm Control Panel entities. Ask Alexa for the state of the Alarm Control Panel entity.
- 'Alexa, arm my home in away mode.'
- 'Alexa, arm my home.'
- 'Alexa, disarm my home.'
- 'Alexa, is my home armed?'
Arming
The Alarm Control Panel state must be in the disarmed
state before arming. Alexa does not support switching from an armed state without first disarming, e.g., switching from armed_home
to armed_night
.
The Alarm Control Panel state armed_custom_bypass
isn't supported by Alexa and is treated as armed_home
.
Alexa does not support arming with voice PIN at this time. Therefore if the Alarm Control Panel requires a code
for arming or the code_arm_required
attribute is true
, the entity will not be exposed during discovery.The Alarm Control Panel may default the code_arm_required
attribute to true
even if the platform does not support or require it. Use the Entity Customization Tool to override code_arm_required
to false
and expose the Alarm Control Panel during discovery.
Disarming
Users must opt-in to the disarm by voice feature in the Alexa App. Alexa will require a 4 digit voice personal identification number (PIN) for disarming. Configure a 4 digit PIN in the Alexa app, or use an existing 4 digit PIN code configured for the Alarm Control Panel.
To use the exiting code configured for the Alarm Control Panel the code
must be 4 digits and the code_format
attribute must be FORMAT_NUMBER
. After discovery, the Alexa app will offer the ability to use the existing code
, or create an additional 4 digit PIN to use with Alexa.
The existing code is never communicated to Alexa from Home Assistant. During disarming, Alexa will ask for a PIN. The PIN spoken to Alexa is relayed to Home Assistant and passed to the alarm_control_panel.alarm_disarm
service. If the alarm_control_panel.alarm_disarm
service fails for any reason, it is assumed the PIN was incorrect and reported to Alexa as an invalid PIN.
Alert, Automation, Group, Input Boolean
Turn on and off Alerts, Automations, Groups, and Input Boolean entities as switches.
- 'Alexa, turn on the front door alert.'
- 'Alexa, turn off energy saving automations.'
- 'Alexa, Downstairs to on.'
Binary Sensor
Requires Proactive Events enabled.
Binary Sensors with a device_class
attribute of door
garage_door
opening
window
motion
presense
are supported.
device_class | Alexa Sensor Type |
---|---|
door | Contact |
garage_door | Contact |
opening | Contact |
window | Contact |
motion | Motion |
presense | Motion |
Ask Alexa for the state of a contact sensor.
- 'Alexa, is the bedroom window open?'
Routines
Requires Proactive Events enabled.
Alexa Routines can be triggered with Binary Sensors exposed as contact or motion sensors.
Use the Entity Customization Tool to override the device_class
attribute to expose a binary_sensor
to Alexa.
Doorbell Announcement
Requires Proactive Events enabled.
Configure a binary_sensor
with display_category
of DOORBELL
in the entity_config
to gain access to the doorbell notification settings in the Alexa App.
Alexa will announce on all echo devices 'Someone is at the [entity name]' when a binary_sensor
state changes from off
to on
.
Presence Detection with Binary Sensor
Requires Proactive Events enabled.
Configure a binary_sensor
that has a device_class
attribute of motion
or presence
and configure display_category
to CAMERA
in the entity_config
to gain access the presence detected notification settings in the Alexa App.
Alexa will announce on all echo devices 'Person detected at [entity name]'.
Each Echo device will need the communication and Announcements setting enabled, and the Do Not Disturb feature turned off.
Image Processing entities also support this notification.
Camera
View a camera stream on an Amazon echo device.
- 'Alexa, show the front door camera.'
The stream
integration is required to stream cameras to Amazon echo devices.
The Amazon echo device will request the camera stream from Home Assistant. The Home Assistant URL must be accessible from the network the Amazon echo device is connected to and must support HTTPS on port 443 with a certificate signed by an Amazon approved certificate authority. These requirements can be satisfied with Home Assistant Cloud, or LetsEncrypt/DuckDNS.
Enable preload stream option for cameras used with echo devices to reduce response time, and prevent timing out before the 6 second limit.
Climate
Single, double, and triple set-point thermostats are supported. The temperature value from the thermostat will also be exposed at a separate temperature sensor.
Set Thermostat Temperature
- 'Alexa, set thermostat to 20.'
- 'Alexa, set the AC to 75.'
- 'Alexa, make it warmer in here.'
- 'Alexa, make it cooler in here.'
Thermostat Mode
'Alexa, set living room thermostat to automatic.'
DRY
is shown in Alexa app asDEHUMIDIFY
ECO
is handled as apreset
in Home Assistant, and will not display in the Alexa app.FAN_ONLY
is not supported by the Alexa voice model and is shown asOFF
in the Alexa App.
To change the thermostat mode, the exact utterance must be used:
- 'Alexa, set [entity name] to [mode utterance].'
If the climate entity supports on/off, use 'turn on' and 'turn off' utterances with the entity name or the mode utterance.
- 'Alexa, turn on the [mode utterance].'
- 'Alexa, turn off the [entity name].'
Alexa supports the following utterances value for climate thermostat mode:
HA Climate Mode | Alexa Mode Utterances |
---|---|
AUTO | 'auto', 'automatic' |
COOL | 'cool', 'cooling' |
HEAT | 'heat', 'heating' |
ECO | 'eco', 'economical' |
DRY | 'dry', 'dehumidify' |
OFF | 'off' |
Cover
Covers should be configured with the appropriate device_class
.
Covers with a device_class
of blind
, shade
, curtin
are shown as an Interior Blind in the Alexa App and Covers with a window
, awning
, or shutter
will show as an Exterior Blind.
Covers with the device_class
of garage
are shown as a Garage Door and support the Open by Voice PIN feature.
Use the Entity Customization Tool to override the device_class
attribute to correctly expose a cover
to Alexa.
Open/Close/Raise/Lower
Home Assistant configures covers with semantics that provide 'raise', 'lower', 'open', 'close' utterances for covers. In addition to semantics 'turn on' / 'turn off' utterances will also work.
- 'Alexa, open the garage door.'
- 'Alexa, close the curtain.'
- 'Alexa, lower the shades.'
- 'Alexa, raise the roof!'
Semantics are assigned based on the features supported by the cover. If the cover supports tilt functionality, the semantics 'open' and 'close' are assigned to the tilt functionality, and the semantics 'raise' and 'lower' are assigned to the position functionality.
If the cover does not support tilt, all semantics 'raise', 'lower', 'open', 'close' are assigned to the position functionality.
Set Cover Position
Covers that support a set position can be controlled using percentages.
- 'Alexa, set the [entity name] position to thirty percent.'
- 'Alexa, increase [entity name] position by ten percent.'
- 'Alexa, decrease [entity name] position by twenty percent.'
Locale | Friendly Name Synonyms |
---|---|
en-US | 'position', 'opening' |
Currently, Alexa only supports friendly name synonyms for the en-US
locale.
Set Cover Tilt
Covers that support tilt position can be controlled using percentages.
- 'Alexa, set the [entity name] tilt to thirty percent.'
- 'Alexa, increase [entity name] tilt by ten percent.'
- 'Alexa, decrease [entity name] tilt by twenty percent.'
Locale | Friendly Name Synonyms |
---|---|
en-US | 'tilt', 'angle', 'direction' |
Currently, Alexa only supports friendly name synonyms for the en-US
locale.
Garage Doors
Covers with a device_class
of garage
support the Open by Voice PIN feature in the Alexa app. Configure a 4 digit PIN code to open the garage door in the Alexa app.
Fan
Control fan speed, direction, and oscillation.
Fan Speed
The fan device must support the speed
attribute. speed
can be set using a percentage or a range value determined from the speed_list
attribute.
- 'Alexa, set the fan speed to three.'
- 'Alexa, set the fan speed to fifty percent.'
- 'Alexa, set the fan power level to fifty percent.'
- 'Alexa, turn up the speed on the tower fan.'
- 'Alexa, set the air speed on the tower fan to maximum.'
The speed_list
attribute is used to determine the range value. For example, using a speed_list
consisting of [off, low, medium, high]
the range values would be 0:off
, 1:low
, 2:medium
, 3:high
.
The following table lists the possible friendly name synonyms available for a fan with speed_list: [off, low, medium, high]
.
Fan Range | Friendly Name Synonyms |
---|---|
0 | 'zero', 'off' |
1 | 'one', 'thirty-three percent', 'low', 'minimum', 'min' |
2 | 'two', 'sixty-six percent', 'medium' |
3 | 'three', 'one hundred percent', 'high', 'maximum', 'max' |
The following synonyms can be used for 'fan speed'
Locale | Friendly Name Synonyms |
---|---|
en-US | 'fan speed', 'airflow speed', 'wind speed', 'air speed', 'air velocity', 'power level' |
Currently, Alexa only supports friendly name synonyms for the en-US
locale.
Fan Direction
The fan device must support the direction
attribute.
- 'Alexa, set the fan direction to forward.'
- 'Alexa, set the fan direction to reverse.'
Fan Oscillation
The fan device must support the oscillating
attribute.
- 'Alexa, is oscillate on for the tower fan?'
- 'Alexa, turn on swivel for the tower fan.'
- 'Alexa, turn on oscillation mode for the table fan.'
Locale | Friendly Name Synonyms |
---|---|
en-US | 'oscillate', 'swivel', 'oscillation', 'spin', 'back and forth' |
Currently, Alexa only supports friendly name synonyms for the en-US
locale.
Image Processing
Requires Proactive Events enabled.
Presence Detection Notification
All image_processing
entities support the presence detected notification settings in the Alexa App. Any state change will trigger the notification.
Alexa will announce on all echo devices 'Person detected at [entity name]'.
Display category will default to CAMERA
to enable presence detected notification settings in the Alexa App. Each Echo device will need the communication and Announcements setting enabled, and the Do Not Disturbed feature turned off.
Input Number
Control an input_number
entity with Alexa. Configures Alexa with the min
, max
, step
, and unit_of_measurement
attributes for the entity.
- 'Alexa, set [entity name] to forty five [unit of measurement].'
- 'Alexa, increase the [entity name] by two.'
- 'Alexa, set the [entity name] to maximum.'
The following table lists the possible friendly name synonyms available for a Input Number with min: -90, max: 90, step: 45, unit_of_measurement: degrees
.
Fan Range | Friendly Name Synonyms |
---|---|
-90 | 'negative ninety', 'minimum', 'min' |
-45 | 'negative forty five' |
0 | 'zero' |
45 | 'forty five' |
90 | 'ninety', 'maximum', 'max' |
Light
Control lights with 'turn on' and 'turn off' utterances, adjust brightness, color, and temperature.
- 'Alexa, turn on the bathroom light.'
- 'Alexa, turn off the patio light.'
Brightness
Lights that support brightness can be adjusted with percentages ranging from 0 to 100 percent.
- 'Alexa, set the bedroom light to fifty percent.'
- 'Alexa, living room lights to one hundred percent.'
The 'dim' utterance will decrease the brightness of a light 25 percentage points.
- 'Alexa, dim the bathroom light.'
Color Temperature
Adjust lights that support color temperature using the following friendly names:
- 'Alexa, set the dining room softer.'
- 'Alexa, make the living room warmer.'
- 'Alexa, set the dining room cooler.'
- 'Alexa, make the living room light whiter.'
- 'Alexa, make the living room warm white.'
- 'Alexa, set the kitchen to daylight.'
The following table lists the possible friendly name synonyms available to lights that support color temperature.
Color Temperature in Kelvin | Friendly Name Synonyms |
---|---|
2200 | 'warm', 'warm white' |
2700 | 'incandescent', 'soft white' |
4000 | 'white' |
5500 | 'daylight', 'daylight white' |
7000 | 'cool', 'cool white' |
Use 'warmer', 'softer', 'cooler, 'whiter' utterances to adjust color temperature by 50 mired
(approximately 300-500 degree kelvin change).
- 'Alexa, set the dining room softer.'
- 'Alexa, make the living room warmer.'
- 'Alexa, set the dining room cooler.'
- 'Alexa, make the living room light whiter.'
Color
Set the light color using the CSS basic color keywords or extended color keywords as the friendly color name.
- 'Alexa, set the front porch light to blue.'
- 'Alexa, set the bedroom light to red.'
- 'Alexa, change the kitchen to the color crimson.'
Lock
- 'Alexa, lock my front door.'
- 'Alexa, unlock the dungeon.'
Unlocking
To unlock, Alexa will require a 4 digit voice personal identification number (PIN) for unlocking. Configure a 4 digit PIN in the Alexa app to unlock locks.
Media Player
Alexa Skills For Cats
Change Channel
- 'Alexa, change the channel to 200 on the Living Room TV.'
- 'Alexa, change the channel to PBS on the TV.'
- 'Alexa, next channel on the Living Room TV.'
- 'Alexa, channel up on the TV.'
- 'Alexa, channel down on the TV.'
Speaker Volume
- 'Alexa, set the volume of the speakers to 50.'
- 'Alexa, turn the volume down on the stereo by 20.'
- 'Alexa, turn the volume down on Living Room TV.'
- 'Alexa, mute speakers.'
- 'Alexa, unmute speakers.'
- 'Alexa, lower the volume on the stereo.'
- 'Alexa, volume up 20 on the speakers.'
Equalizer Mode
Supports changing the Media Player sound_mode
from the preset sound_mode_list
.
- 'Alexa, set mode to movie on the TV.'
Alexa only supports the following modes: movie
, music
, night
, sport
, tv
.
Inputs
Supports changing the Media Player source
from the preset source_list
.
- 'Alexa, change the input to DVD on the Living Room TV.'
Home Assistant will attempt to translate the the media_player
source_list
into a valid source
name for Alexa. Alexa only supports the following input names:
AUX 1
, AUX 2
, AUX 3
, AUX 4
, AUX 5
, AUX 6
, AUX 7
, BLURAY
, CABLE
, CD
, COAX 1
, COAX 2
, COMPOSITE 1
, DVD
, GAME
, HD RADIO
, HDMI 1
, HDMI 2
, HDMI 3
, HDMI 4
, HDMI 5
, HDMI 6
, HDMI 7
, HDMI 8
, HDMI 9
, HDMI 10
, HDMI ARC
, INPUT 1
, INPUT 2
, INPUT 3
, INPUT 4
, INPUT 5
, INPUT 6
, INPUT 7
, INPUT 8
, INPUT 9
, INPUT 10
, IPOD
, LINE 1
, LINE 2
, LINE 3
, LINE 4
, LINE 5
, LINE 6
, LINE 7
, MEDIA PLAYER
, OPTICAL 1
, OPTICAL 2
, PHONO
, PLAYSTATION
, PLAYSTATION 3
, PLAYSTATION 4
, SATELLITE
, SMARTCAST
, TUNER
, TV
, USB DAC
, VIDEO 1
, VIDEO 2
, VIDEO 3
, XBOX
Playback State
Requires Proactive Events enabled.
Seek
- 'Alexa, skip 30 seconds on device.'
- 'Alexa, go back 10 seconds on device.'
Scene
Activate scenes with scene name, or 'turn on' utterance. Home Assistant does not support deactivate or 'turn off' for scenes at this time.
- 'Alexa, Party Time.'
- 'Alexa, turn on Party Time.'
Script
Run script with script name, or 'turn on' utterance. Deactivate a running script with 'turn off' utterance.
- 'Alexa, Party Time.'
- 'Alexa, turn on Party Time.'
- 'Alexa, turn off Party Time.'
Sensor
Requires Proactive Events enabled.
Only temperature sensors are configured at this time.
- 'Alexa, what's the temperature in the kitchen?'
- 'Alexa, what's the upstairs temperature?'
- 'Alexa, what's the temperature of my ex-girlfriend's heart?'
Switch
Support 'turn on' and 'turn off' utterances.
- 'Alexa, turn on the vacuum.'
- 'Alexa, turn off the lights.'
Timer
Start a timer with using the 'turn on' utterance.
- 'Alexa, turn on the laundry.'
Cancel a timer using the 'turn off' utterance.
- 'Alexa, turn off the laundry.'
Pause and Restart Timer entities in Home Assistant.
- 'Alexa, pause the microwave.'
- 'Alexa, hold the sous vide.'
- 'Alexa, restart the microwave.'
Vacuum
Support 'turn on' and 'turn off' utterances. Pause and Resume
- 'Alexa, turn on the vacuum.'
- 'Alexa, pause the vacuum.'
- 'Alexa, restart the vacuum.'
Alexa Web-Based App
The following is a list of regions and the corresponding URL for the web-based Alexa app:
- United States:
https://alexa.amazon.com
- United Kingdom:
https://alexa.amazon.co.uk
- Germany:
https://alexa.amazon.de
- Japan:
https://alexa.amazon.co.jp
- Canada:
https://alexa.amazon.ca
- Australia:
https://alexa.amazon.com.au
- India:
https://alexa.amazon.in
- Spain:
https://alexa.amazon.es
- France:
https://alexa.amazon.fr
- Italy:
https://alexa.amazon.it
Troubleshooting
Binary Sensor not available in Routine Trigger
Binary Sensors with a device_class
attribute of door
garage_door
opening
window
motion
presense
are supported.
Use the Entity Customization Tool to override the device_class
attribute to expose a binary_sensor
to Alexa.
Token Invalid and no Refresh Token Available
Disable and re-enable the skill using the Alexa App; then restart Home Assistant.
Debugging
The Alexa integration will log additional information about state updates and other messages when the log level is set to debug
. Add the relevant line below to the configuration.yaml
:
If using Alexa with an Alexa Smart Home Skill and Lambda function such as haaska:
Is The Mac Alexa App Free
If using Home Assistant Cloud you also need to debug hass_nubucasa.iot
: