...

Release History

Components & their availability

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

• 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". 

Components & their availability

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

• 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". 

...

The build instructions are mentioned by taking RaspberryPi as an example but should be almost similar for other platforms.

...

Getting the source code

1. Initialize and download the code base
 - Example for RaspberryPi:
 $ repo init -u https://(we can use rdkv.xml to build with external source method or rdkv-nosrc.xml to build without externalsrc)
 $ repo init -u https://code.rdkcentral.com/r/manifests -m rdkv-nosrc.xml -b thunderrdk-next
 $ repo sync

2. Download the meta-rdk-voice layer in project root
 $ git clone https://code.rdkcentral.com/r/rdk/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. OptionallyFor ifthe wantedexternal tosource usebuilds MIC(such basedas implementationsome (IgnoreBroadcom ifplatforms) usingadd BLEbelow voiceline remote)
 $ vi meta-rdk-voice/conf/layerin manifest/auto.conf
 - enable the below commented line
 #DISTRO_FEATURES_append = " alexa_ffv"
In <Manifest>.xml
   <project name="components/generic/avs/alexa_skill_mapper" revision="rdk-next"/>
 - FollowIn the section (Enable Keyword Detector) for using amazon provided 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"
   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-thunder-mc.conf ###
 $ bitbake rdk-generic-mediaclient-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. 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).

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:git/VoiceToApps"
   SRCPV_pn-wpe-alexa = "${BRCMEXTERNAL-SRCPV-CMF}"
 $ repo sync
5 .Build the image target
 - Example for RaspberryPi
 $ source meta-cmf-raspberrypi/setup-environment
 ### select meta-cmf-raspberrypi/conf/machine/raspberrypi-rdk-thunder-mc.conf ###
 $ bitbake rdk-generic-mediaclient-image

Enable Keyword detector support

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

auto.conf (where brcmexternalsrc is enabled)
   BRCMEXTERNALSRC_pn-skillmapper += "rdk/components/generic/avs/alexa_skill_mapper"
   SRCPV_pn-skillmapper = "${BRCMEXTERNAL-SRCPV-CMF}"
 $ repo sync

Configuration for voice input from MIC

Mic input can be enable using below options , it will automatically add PORTAUDIO library as dependency.

KWD detector module will be required for MIC attached devices in order to wake-up Alexa & current implementation is only verified with pryonlite KWD detector.

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

Enable Keyword detector support

Keyword detector (KWD) support enables the device to wake-up & listen to input after receiving the hot word  "Alexa". It is used with devices that has on-board Microphone

This option need to be enabled along with "alexa_ffv" DISTRO for MIC based voice input

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

Smart Screen build configuration

Enable Alexa Smart Screen support

Smart screen support will build the components that provide visual experience along with voice response.

$ vi meta-rdk-voice/conf/layer.conf
 - enable the below commented DISTRO_FEATURE
  #DISTRO

# If FFV profile is enabled (DISTRO_FEATURES_append = " alexa_smart_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

screen"

Enable Voice chrome

Voice chrome is a feature that is used along with Alexa smart screen. it provides a animated visual element to notify different Alexa states such as Listening, Thinking or Speaking. When the system is IDLE the voice chrome UI element is cleared from screen. 

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-voice/conf/layer.conf
 - enable the below commented DISTRO_FEATURE
  #DISTRO_FEATURES_append = " alexa_smart_screen"

Enable Voice chrome

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"

Build the image

Build the image target
 - Example for RaspberryPi
 $ source meta-cmf-raspberrypi/setup-environment
 ### select meta-cmf-raspberrypi/conf/machine/raspberrypi-rdk-thunder-mc.conf ###
 $ bitbake rdk-generic-mediaclient-image

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

...

Activate 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

...

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<DESCRIPTION>"
    },

Front

...

Panel LED Notifications

...

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

...

We can check the authorization code using below command:

...

:

$ systemctl status alexa

• In case of plugin implementation

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

...

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

...

. It 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:a) Weather Information:

• Smart screen overlay shown over the main UI
• Weather information displayed as a visual element inside overlay
• Voice chrome bar visible at bottom of the overlay indicating Alexa is in SPEAKING state.

b) Music Playback

• Smart screen overlay shown over the main UI
• Audio player interface occupying the full space of overlay window.

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
          Alexa: respond with the climate in the current location.

...

Architecture & Flow diagram

AVS Integration with Video Skill & RDK Services

Image Removed

AVS Integration with custom skills

...

AVS Integration with Video Skill & RDK Services

Image Added

AVS Integration with custom skills

Image Added

Current Limitations

Roadmap