Alexa Smart Screen SDK Overview
The Alexa Smart Screen SDK version 2.8.0 extends the AVS Device SDK version 1.25 to support development for screen-based Alexa Built-in products. The Smart Screen SDK enables device makers to build screen-based products that complement Alexa voice responses with rich visual experiences.
The Alexa Smart Screen SDK GitHub repo includes the following items:
- The Alexa Smart Screen SDK
- A sample app that demonstrates end-to-end Alexa Smart Screen SDK functionality
- A GUI web app that handles presentation of Alexa visual responses
The Alexa Smart Screen SDK depends on the following additional GitHub repos:
You can set up the Alexa Smart Screen SDK by using the following Quick Start Guides:
You can also create your device prototype by using an Amazon-qualified development kit that supports the Smart Screen SDK, such as the following kits:
The following diagram illustrates the data flows between components that comprise the Alexa Smart Screen SDK.
- AVS Device SDK
- The SDK for Alexa Voice Service, which implements Alexa intelligent voice control functionality.
- Capability Agents (CAs)
- The agents that handle Alexa-driven interactions; specifically directives and events. Each capability agent corresponds to a specific interface exposed by the Alexa Smart Screen API. These include the following interfaces:
AlexaPresentation— The interface for rendering Alexa Presentation Language (APL) documents.
TemplateRuntime— The interface for
Templatecards (such as music cards and other static cards).
VisualCharacteristics— The interface for reporting the physical properties of visual display devices (such as screen resolution, window size, and supported interaction modes).
- APL Core Client Reference Implementation
- GUIManager— The interface between the capability agents and the GUI.
- GUIClient— The interface that manages messages between the GUI and the rest of the sample app.
- APLCoreTextMeasurement— The interface that handles text measurement requests from the APL Core Library.
- APLCoreConnectionManager— The interface that manages the currently rendered APL document.
- APLCoreGUIRenderer— The interface that handles the creation of APL documents.
- WebSocketServer— The reference implementation of a WebSocket-based messaging interface.
- APL Core Library Engine
- An abstract engine for Alexa Presentation Language (APL) that manages not only APL document parsing and layout inflation, but also event handling, commands, and the rendering workflow.
- HTML Rendering Engine
- WebSocket— The reference implementation of a WebSocket client.
- APL Web ViewHost— The view host that renders the APL document generated by the APL Core Library.
- Alexa GUI— The reference GUI implementation.
Security best practices
All Alexa products should adopt the Security Requirements for Alexa. For information about security requirements for the Smart Screen SDK, see Security Requirements for Alexa Smart Screen SDK.
- Review the Alexa Smart Screen License.
- Review the Alexa Smart Screen Notice about Third-Party Components.
Run the GUI client with predefined device visual characteristics and GUI client configurations
Amazon provides four different sample configuration files of predefined device visual characteristics and GUI client configurations. You can find these under
modules/GUI/config/guiConfigSamples. To enable a predefined configuration, you can pass any of them as an extra configuration file argument after the main Smart Screen SDK configuration file argument when running the Sample App.
Remote control support
Exit and Back remote control functionality is minimally supported by the Smart Screen SDK. The following behaviors are expected to occur:
- Clear the rendering screen— Exit fully out of the Alexa-presented display so that no static image or layout is left.
- Release the focus management— Release any focus management that might be held.
Using the predefined device visual characteristics, Esc and B are mapped to Exit and Back respectively.
Release notes and known issues
For a list of enhancements, bug fixes, and known issues, refer to CHANGELOG.md.
Last updated: Nov 29, 2022