Info |
---|
This is a draft document & the information mentioned here may change frequently |
Revision History
Rev. | Date | Prepared by | Affected Sections/ Pages | Description |
0.1 | 17/03/2020 | Manjunath HK | Document | Initial version |
0.2 | 2/07/2020 | Manjunath HK | Document | more details on intent creation and skill |
0.3 | 7/16/2021 | Ganesh prasad Sahu | Document | Modified the product creation section and details about WWE request |
Introduction
This guideline document is intended to help developers want to integrate AVS with the device. Steps described in this page mainly covers the developer account creation and defining different rules to launch/control RDK APPs. These rules created in developers Alexa account will interact with the AVS SDK application ported to the devices to achieve desire tasks.
...
- Follow the steps mentioned steps in the below link to register the device with developer account
- https://developer.amazon.com/en-US/docs/alexa/alexa-voice-service/register-a-product.html
Image Added
When you are in the AVS Developer Console.
If we want the device to go through certification process, you will need to create 2 products (for experimental purpose creating 2 products is not mandatory)
- BETA : to be used for development and certification
- PRODUCTION : for your live product used in production
Creating the products – STEP 1 of 2 – Product Information
- Select MANAGE YOUR PRODUCTS, then select ADD NEW PRODUCT
- Fill out the Product Information Form
- Product Name - use this structure: product name – beta
- Product ID – use this structure: product_name_beta
- Product type: select Device with Alexa Built-in
- Companion app: if device is connected to a screen then select No
- Product category: select for video devices for STBs and TVs
- Description: enter a short description of your product
- Alexa initiation: Touch initiated (like Push-To-Talk), Hands-Free or Far-Field (product with mic array)
- Distribute product commercially: Yes
- Alexa for Business: No
- Children’s product: No (unless your product is for children)
- Click on NEXT
Image Added Image Added
Creating the products – STEP 2 of 2 – LWA (Login With Amazon)
Select a Security Profile:
- Click on CREATE NEW PROFILE
Create a new Security Profile:- Security Profile Name: The Security Profile name is displayed on the consent screen when users agree to share information with your application.
AVS recommends using a name that includes your company or product name
- Security Profile Description: The Security Profile description is to help you remember what products are associated with this Security Profile.
The description is not shown to end users
Image Added
Review the information
- Read and agree to the Amazon Developer Services Agreement
- Click FINISH
Amazon AVS team will first enable features and certify your BETA product. Then once the product is certified using the BETA product information, all features and certification will be applied to your PRODUCTION product so it can be used with your customers in production.
- Download the config.json file from your developer account.
- Copy the file in to the RPI device to root directory.(/home/root)
Requesting a Wake Word Binary
For the devices that have a far field microphone and want to use amazon Wake Word Engine (WWE)
- Go to https://developer.amazon.com/alexa/console/avs/products
- Select the product for which the WWE binary is to be requested
- Browse to end of the product page and click on "Request a Wake Word Binary"
Image Added
- Fill out the details, provide the build instructions and attach the toolchain (if available)
- Click on Submit
Custom skill creation
...
- Enter the skill name and default language
- Skill name: This is the name customers will see when you publish the skill. You can edit this name later on the Distribution page.
- Default language: You can add additional languages to the skill later.
- Choose a model to add to your skill (custom )
Note |
---|
For creating a Video skill , please refer Integrating Alexa Video Skill Kit with RDK |
Choose a method to host your skill's backend resources (Alexa-Hosted (Node.js))
...
- you can import the skill that already host in the git repository.
- you will find import skill option is on the skill developer account while creating the new skill as shown.
- click on the option.
- past the git URL(https://github.com/manjunathtsai/alexahost.git) on the dialog and click on the import.
Continue with Template:
after creating the skill with example template (hello world) we will find the code section in the skill console where you will find the index.js file in that you replace the existing code with code provided then save and deploy.
...
Invocation Name
It is the name given to custom skill. Invocation of the skill is started by the invocation name followed by the intent.
...