...

Components & their availability

Below table lists are the components/code used with the RDK Alexa solution and the origin/owner for distribution. components

• Components hosted in CMF or github can be accessed part of the release

...

• Operators/vendors should contact amazon POC to get the artifacts

...

• marked as "Distributed by Amazon". 

...

Skill Overview

Video Skill

Please refer to below page on integrating the Alexa Video Skill Kit with RDK

...

1. Initialize and download the code base
 - Example for RaspberryPi:
 $ repo init -u https://code.rdkcentral.com/r/manifests -m rdkv-nosrc.xml -b thunder-next
 $ repo sync

2. Download the meta-rdk-voice layer in project root
 $ git clone https://code.rdkcentral.com/r/components/generic/rdk-oe/meta-rdk-voice

3. Enable the below DISTRO feature to build AVS plugin
 $ vi meta-rdk-voice/conf/layer.conf
 - enable the below commented line
 #DISTRO_FEATURES_append = " alexa-plugin"
4. Optionally if wanted to use MIC based implementation (Ignore if using BLE voice remote)
 $ vi meta-rdk-voice/conf/layer.conf
 - enable the below commented line
 #DISTRO_FEATURES_append = " alexa_ffv"

5. - ToFollow usethe pryonsection lite(Enable KWDKeyword engineDetector) for devicesusing withamazon MICprovided input
Note: Source code need to be obtained from amazon separately
 a. Set the KWD support flag to "ON" in meta-rdk-voice/recipes-wpe/wpeframework/include/avs.inc
 b. include the KWD detector recipe to build.
 - enable the commented line
#PREFERRED_PROVIDER_virtual/alexa-kwd-detector = "pryonlite"

 # Please follow the steps mentioned in section #3.2 to enable USB audio kernel parameters (Not required for RaspberryPI).

5. Optionally For the external source builds (such as some Broadcom platforms) add below line in manifest/auto.conf
 - In <Manifest>.xml
   <project name=KWD

 # Please follow the steps mentioned in section #3.2 to enable USB audio kernel parameters (Not required for RaspberryPI).

5. Optionally For the external source builds (such as some Broadcom platforms) add below line in manifest/auto.conf
 - In <Manifest>.xml
   <project name="components/generic/avs/alexa_skill_mapper" revision="rdk-next"/>
 - In auto.conf (where brcmexternalsrc is enabled)
   BRCMEXTERNALSRC_pn-wpe-alexa += "components/generic/avs/alexa_skill_mapper" revision="rdk-next"/>
 - In auto.conf (where brcmexternalsrc is enabled)
   BRCMEXTERNALSRC_pn-wpe-alexa += "components/generic/avs/alexa_skill_mapper"
   SRCPV_pn-wpe-alexa = "${BRCMEXTERNAL-SRCPV-CMF}"
 $ repo sync
6 .Build the image target
 - Example for RaspberryPi
 $ source meta-cmf-raspberrypi/setup-environment
 ### select meta-cmf-raspberrypi/conf/machine/raspberrypi-rdk-hybridthunder-thundermc.conf ###
 $ bitbake rdk-generic-hybrid-thundermediaclient-image

Build instructions to run Alexa as systemd service

1. Initialize and download the code base
 - Example for RaspberryPi:
 $ repo init -u https://code.rdkcentral.com/r/manifests -m rdkv-nosrc.xml -b thunder-next
 $ repo sync

2. Download the meta-rdk-voice layer in project root
 $ git clone https://code.rdkcentral.com/r/components/generic/rdk-oe/meta-rdk-voice

3. AddOptionally if wanted to BBLAYERSuse MIC based implementation (Ignore if using BLE voice remote)
 $ vi meta-rdk-voice/conf/bblayerslayer.conf.sample
 BBLAYERS += "${@'${RDKROOT}/meta-rdk-voice' if os.path.isfile('${RDKROOT}/meta-rdk-voice/conf/layer.conf') else ''}"

4. Optionally if wanted to use MIC based implementation (Ignore if using BLE voice remote)
 $ vi meta-rdk-voice/conf/layer.conf
 - enable the below commented line
 #DISTRO_FEATURES_append = " alexa_ffv"

 # Please follow the steps mentioned in section #3.2 to enable USB audio kernel parameters (Not required for RaspberryPI).

5. Optionally For the external source builds (such as some Broadcom platforms) add below line in manifest/auto.conf
 - In <Manifest>.xml
   <project name=
 - enable the below commented line
 #DISTRO_FEATURES_append = " alexa_ffv"

 # Please follow the steps mentioned in section #3.2 to enable USB audio kernel parameters (Not required for RaspberryPI).

4. Optionally For the external source builds (such as some Broadcom platforms) add below line in manifest/auto.conf
 - In <Manifest>.xml
   <project name="components/generic/avs/alexa_skill_mapper" revision="rdk-next"/>
 - In auto.conf (where brcmexternalsrc is enabled)
   BRCMEXTERNALSRC_pn-wpe-alexa += "components/generic/avs/alexa_skill_mapper" revision="rdk-next"/>
 - In auto.conf (where brcmexternalsrc is enabled)
   BRCMEXTERNALSRC_pn-wpe-alexa += "components/generic/avs/alexa_skill_mapper::git/VoiceToApps"
   SRCPV_pn-wpe-alexa = "${BRCMEXTERNAL-SRCPV-CMF}"
 $ repo sync
65 .Build the image target
 - Example for RaspberryPi
 $ source meta-cmf-raspberrypi/setup-environment
 ### select meta-cmf-raspberrypi/conf/machine/raspberrypi-rdk-hybridthunder-thundermc.conf ###
 $ bitbake rdk-generic-hybridmediaclient-thunder-image

...

Enable Keyword detector support

Note: This configuration is not required for RaspberryPi platforms
# If FFV profile is enabled (DISTRO_FEATURES_append = " alexa_ffv") & we want to simulate audio input using a USB mic the below kernel configuration need to be enabled for non RPI platforms:

CONFIG_SND_HWDEP=m
CONFIG_SND_RAWMIDI=m
CONFIG_SND_USB_AUDIO=m

# After enabling the above kernel configs, recompile the kernel so that the support for USB audio will be enabled

Enable Alexa Smart Screen support

DISTRO Features : alexa_smart_screen

Enable Voice chrome

DISTRO Features: voice-chrome

How to run the service

For AVS Plugin

1.  Go to the controller web UI by typing http://<Device-IP> in a browser
2. Select the controller option from left pane menu
3. toggle the AVS option to activate the plugin

For systemd service (old implementation)

1. Login to the device with "ssh root@<Device-IP>
2. start the alexa service by invoking "systemctl start alexa.service"

Customization

Mapping to amazon developer account

Please refer the wiki link AVS Developer Account and Skill Creation Guidelines for RDK for creating a developer account.

Modify below section to map with relevant developer account.

1. Login to the device
 $ ssh root@<RDKV-Client-IP>

2. Edit the Configuration file
 $ cd /home/root
 $ vi Alexa_SDK/Integration/AlexaClientSDKConfig.json
     "deviceInfo":{
        // Unique device serial number. e.g. 123456
        "deviceSerialNumber":"<SERIAL_NO>",
        // The Client ID of the Product from developer.amazon.com
        "clientId":"<CLIENT_ID>",
        // Product ID from developer.amazon.com
        "productId":"<PRODUCT_ID>",
        // The name of the device manufacturer.
        "manufacturerName": "<MANUFACTURER_NAME>",
        // The description of the device which should contain the manufacturer name or how the device is connected.
        "description": "<DESCRIPTION"
    },

Front Panl LED Notifications

Prerequisite : Alexa Client uses IOConnector plugin to set different LED notifications, so IOConnector need to be enabled for the platform

https://github.com/rdkcentral/ThunderNanoServices/tree/master/IOConnector

$ cd /home/root
$ vi Alexa_SDK/Integration/AlexaCurl.json
Set below GPIO to appropriate value
   "PinOne":"9",
   "PinTwo":"10",
   "PinThree":"11"

Example: For RaspberryPi we can use the Traffic light LED where GPIO PIN 9, 10, 11 represents the Red, Yellow & Green LEDS 

Alexa user guide

Introduction

This Feature consists two mode "General Mode" and "Skill Mode",

• in the General Mode you ask general quires (ex: time , weather ,news)
• in the Skill Mode you can launch applications ,navigate and other functionality.

One can switch from the "General Mode" to "Skill Mode" by using steps mentioned in the section "skill invocation enable" and you can switch back to "General Mode" following the steps in the section "skill invocation disable".

Note: By default when device is booted it will be in the general mode

...

1. To use pryon lite KWD engine for devices with MIC input
 Note: Source code need to be obtained from amazon separately
2. Set the KWD support flag to "ON"
  $ vi meta-rdk-voice/recipes-wpe/wpeframework/include/avs.inc
    AVS_KWD_SUPPORT ?= "ON"
3. include the KWD detector recipe to build.
 - enable the commented line 
 #PREFERRED_PROVIDER_virtual/alexa-kwd-detector = "pryonlite"
4. Create a bbappend file in platform layer and provide artifact location
e.g. 
 $ vi meta-rdk-oem-<OEMNAME>/meta-<MACHINE>/recipes-avs/pryonlite/pryonlite_2.3.0.bbappend
   SRC_URI  = "file://pryon_lite_2.3.0-metrological-2019.12.23.2344.zip"

Kernel configurations to simulate FFV with an USB microphone

# If FFV profile is enabled (DISTRO_FEATURES_append = " alexa_ffv") & we want to simulate audio input using a USB mic the below kernel configuration need to be enabled for the platforms:

CONFIG_SND_HWDEP=m
CONFIG_SND_RAWMIDI=m
CONFIG_SND_USB_AUDIO=m

# After enabling the above kernel configs, recompile the kernel so that the support for USB audio will be enabled

Enable Alexa Smart Screen support

$ vi meta-rdk-voice/conf/layer.conf
 - enable the below commented DISTRO_FEATURE
  #DISTRO_FEATURES_append = " alexa_smart_screen"

Enable Voice chrome

1. Enable DISTRO options
$ vi meta-rdk-voice/conf/layer.conf
 - enable the below commented DISTRO_FEATURE
  #DISTRO_FEATURES_append = " voice-chrome"
2. Provide artifact location
 - Add an .bbappend file for alexa-ss-sdk and over-write the SRC_URI
e.g.
 $ vi meta-rdk-oem-OEMNAME/meta-<MACHINE>/recipes-avs/alexa-smart-screen/alexa-ss-sdk_git.bbappend
   SRC_URI_remove = "https://operator-artifact-url.com/location/SmartScreenSDKVoiceChrome-2.1.tar;name=voicechrome;subdir=voicechrome"
   SRC_URI += "file://SmartScreenSDKVoiceChrome-2.1.tar;name=voicechrome;subdir=voicechrome"

How to run the service

For AVS Plugin

1.  Go to the controller web UI by typing http://<Device-IP> in a browser
2. Select the controller option from left pane menu
3. toggle the AVS option to activate the plugin

For systemd service (old implementation)

1. Login to the device with "ssh root@<Device-IP>
2. start the alexa service by invoking "systemctl start alexa.service"

Customization

Mapping to amazon developer account

You should already have a developer account, Please refer the wiki link AVS Developer Account and Skill Creation Guidelines for RDK for creating a developer account.

Modify below section to map with relevant developer account.

1. Login to the device
 $ ssh root@<RDKV-Client-IP>

2. Edit the Configuration file
 $ cd /usr/share/WPEFramework/AVS
 $ vi AlexaClientSDKConfig.json
     "deviceInfo":{
        // Unique device serial number. e.g. 123456
        "deviceSerialNumber":"<SERIAL_NO>",
        // The Client ID of the Product from developer.amazon.com
        "clientId":"<CLIENT_ID>",
        // Product ID from developer.amazon.com
        "productId":"<PRODUCT_ID>",
        // The name of the device manufacturer.
        "manufacturerName": "<MANUFACTURER_NAME>",
        // The description of the device which should contain the manufacturer name or how the device is connected.
        "description": "<DESCRIPTION"
    },

Front Panl LED Notifications

Prerequisite : Alexa Client uses IOConnector plugin to set different LED notifications, so IOConnector need to be enabled for the platform

https://github.com/rdkcentral/ThunderNanoServices/tree/master/IOConnector

$ cd /home/root
$ vi Alexa_SDK/Integration/AlexaCurl.json
Set below GPIO to appropriate value
   "PinOne":"9",
   "PinTwo":"10",
   "PinThree":"11"

Example: For RaspberryPi we can use the Traffic light LED where GPIO PIN 9, 10, 11 represents the Red, Yellow & Green LEDS 

Alexa usage guide

Introduction

How To give voice Input:

1. Using the Tech4Home BLE Remote - Press & hold the mic button → provide the voice input → release the button.
2. Using the on-board (or USB) microphone - Wake-up the system with keyword "Alexa" → provide the voice input.

This Feature can be divided as : General skills , Custom Skills Or Video Skill,

• in General Mode you ask general quires (ex: time , weather ,news)
• in Custom Skill Mode you can launch applications ,navigate and other functionality.

One can switch from the "General Mode" to "Skill Mode" by using steps mentioned in the section "skill invocation enable" and you can switch back to "General Mode" following the steps in the section "skill invocation disable".

Note: By default when device is booted it will be in the general mode

First time authorization

On first time launch, we need to authorize the device with a amazon account. This steps will not be required for subsequent application launch.

We can check the authorization code using below command:

• In case of systemd implementation:

$ systemctl status alexa

• In case of plugin implementation

$ tail -f /opt/logs/wpeframework.log

We will be able to see a message similar to below format. Note the code that appears in console window, this will be required while authorizing with developer account.

##################################
#       NOT YET AUTHORIZED       #
##################################
#       To authorize, browse to: 'https://amazon.com/us/code' and enter the code: EXEA99
###############################################################
#       Checking for authorization (1)...       #
################################################# 

1. Open "https://amazon.com/us/code" in a browser
2. Login with the amazon developer account credential and provide the code that was displayed on the device console (one time only)

 Image Added

Note: If there is a prompt for OTP at this stage, Get it from linked phone number.

1. After the authorization below log is displayed on the console

########################################
#       Alexa is currently idle!       #
########################################

At this stage, we can provide voice commands to Alexa.

Alexa Smart Screen

The Alexa Smart Screen SDK extends the AVS Device SDK to support visual display for screen-based Alexa Built-in products that complement Alexa voice responses with rich visual experiences.

The Alexa Smart Screen implementation for RDK involves below components:

• The Alexa Smart Screen SDK
• A GUI web app that handles presentation of Alexa visual responses
• skill mapper which controls the overlay

Below are few screen shots which gives an idea about the smart screen integration for different scenarios:

a) Weather Information:

Image Added

b) Music Playback

Image Added

Example Usage

a) General Usage
ex:  1) User: what is the the time?
          Alexa: respond with current time
      2) User : what is the weather outside ?
          Alexa: it will ask for you location
          User: Provides the Location

First time authorization

On first time launch, we need to authorize the device with a amazon account. This steps will not be required for subsequent application launch.

We can check the authorization code using below command:

• In case of systemd implementation:

$ systemctl status alexa

• In case of plugin implementation

$ tail -f /opt/logs/wpeframework.log

We will be able to see a message similar to below format. Note the code that appears in console window, this will be required while authorizing with developer account.

##################################
#       NOT YET AUTHORIZED       #
##################################
#       To authorize, browse to: 'https://amazon.com/us/code' and enter the code: EXEA99
###############################################################
#       Checking for authorization (1)...       #
################################################# 

1. Open "https://amazon.com/us/code" in a browser
2. Login with the amazon developer account credential and provide the code that was displayed on the device console (one time only)

 Image Removed

Note: If there is a prompt for OTP at this stage, Get it from linked phone number.

1. After the authorization below log is displayed on the console

########################################
#       Alexa is currently idle!       #
########################################

At this stage, we can provide voice commands to alexa.

Example Usage

a) General Usage
ex:  1) User: what is the the time?
          Alexa: respond with current time
      2) User : what is the weather outside ?the climate in the current location.

          In case smart screen support enabled, the overlay will render the weather tiles.

b) Using video skill launch application

ex: 1) Launching YouTube

          Alexa: it will ask for you location User: Alexa, Launch YouTube

          User: if give the Location  Alexa: Getting Youtube from Accelerator

          Alexa: respond with the climate in the current location.Output: Youtube is launched on the device

cb) Using the custom skill to Launching Metro Applications

...

AVS Integration with custom skills

Advantages

...

Roadmap

...