Verify the minimum configuration
To test the end-to-end flow of your add-on, you must complete the minimum configuration for a smart home add-on. On the Build page in the developer console, navigate to each configuration item to verify.-
In SMART HOME, define the following items for your smart home add-on:
- Version 3 of the Smart Home API
- A valid AWS Lambda ARN service endpoint
A smart home add-on can include multiple models. Specify the endpoint for the custom and smart home models.
- In ACCOUNT LINKING, configure the required fields.
- In PERMISSIONS, enable Send Alexa Events.
Test your add-on
As you develop your add-on code, you can create test cases in the Lambda console to test the request from Alexa. For details, see Smart Home Tutorial: Substep 2.4: Test the Lambda function. To test your add-on code in the Lambda console, choose Deploy to build and deploy the code. Make sure that you deploy your Lambda function in the AWS region associated with the add-on language and locale. Otherwise, device discovery might succeed for one language version of the add-on and fail for another language. For more details, see Deploy your Lambda function to multiple regions. When your implementation is complete, you can enable your add-on and begin testing. To enable your add-on and begin testing- In the Alexa app, enable your add-on. Alexa performs account linking, sends an
Alexa.Authorization.AcceptGrantdirective to your add-on to connect your add-on to the user’s Amazon account, and then sends anAlexa.Discovery.Discoverdirective to your add-on to discover devices. - If your add-on successfully discovers devices, complete the steps to enable your add-on for testing in the Alexa developer console.
- In the developer console, on the Test tab, test your add-on by using the Alexa Simulator.
- Give Alexa commands using the friendly names found in your discovery response and in the Alexa app.
- Use utterances specific to the device capabilities that your add-on supports. Make sure to test your add-on with valid and invalid utterances.
- To verify change reporting and endpoint health, power your device off and back on.
- To debug issues, in the CloudWatch console, find the logs in the log group for your add-on.
Enable your add-on in the Alexa app
Complete the following steps to enable your add-on in the Alexa app installed on your iOS or Android mobile device. To enable your add-on and discover devices-
Follow these instructions to find your add-on in the Alexa app.
-
If you have Alexa+:
- Tap the menu icon.
- Under More, tap Alexa+ Store.
- Scroll down, and then tap Browse Alexa Skills and Games.
-
If you have the standard version of the Alexa app:
- Tap the menu icon.
- Tap Skills and Games.
-
If you have Alexa+:
- Scroll the skill types to the right, and then tap Dev.
- Scroll to find your add-on.
- Tap your add-on name, and then tap ENABLE TO USE.
- Follow the prompts to enter your credentials for your device cloud account.
- To allow access to the add-on, tap Allow, and then tap CLOSE.
-
After you enable and link the add-on, Alexa sends an
Alexa.Discovery.Discoverdirective to your add-on to learn about the connected devices. Your add-on returns the discovery response with details about the devices. - If Alexa can’t discover your device, check the CloudWatch the logs for your Lambda function. A common cause is an incorrectly formatted discovery response.
Debugging and testing tools
Use the following tools to test and debug your smart home add-on:- Alexa Automated Testing Service – Create test plans using natural language rather than complex JSON definitions. You can choose pre-built templates or build custom test plans that meet your specific requirements.
-
View Device State – View the current values of all properties of smart home devices associated with your add-on and your developer account, and whether the current value came from a
StateReportrequest or proactive state update, such asChangeReport. -
Smart Home Debugger – View the
ChangeReport,AddOrUpdateReport, andDeleteReportevents that Alexa receives from your add-on, including your JSON, and any processing errors. -
Smart Home Debugger for WebRTC Add-ons – If you implement the
Alexa.RTCSessionControllerinterface in your add-on, use the Smart Home Debugger to view logs from your WebRTC sessions in real time. - Smart Home Test Tool – Run automated tests that send directives to your add-on and verify that you set the state correctly. The tool supports the most common Alexa capability interfaces.
- Alexa Simulator – Test your add-on without a device by using the simulator in the developer console.
- Smart Home Evaluation REST API Reference – Use the Smart Home Evaluation REST API to start evaluations and get evaluation results programmatically.
-
Alexa Skills Kit (ASK) Command Line Interface (CLI) – Use the
create-smarthome-capability-evaluationcommand to create and start a capability evaluation.

