Skip to content
The Alexa Auto SDK is for automotive OEMs to integrate Alexa directly into vehicles.
Branch: 1.5
Clone or download
MuniSakkuru Version 1.5.0 aac-sdk
The Alexa Automotive Core (AAC) SDK is for automotive OEMs to integrate Alexa directly into vehicles.

**v1.5.0**

* v1.5.0 released on 2019-03-06

**Enhancements**

* Added a C++ sample application to demonstrate use cases that the Alexa Auto SDK supports. Read more about the C++ Sample App [here](./samples/cpp/README.md).
* Released the code for the AGL Alexa Voice Agent, a binding for Automotive Grade Linux powered by Alexa Auto SDK v1.5. The software is shipped as a standard AGL binding that exposes an API for speech recognition using the Alexa Voice Service. Please refer to the [AGL Alexa Voice Agent documentation](./platforms/agl/alexa-voiceagent-service/README.md) for instructions to build, install, and test the binding on an R-Car M3 board.
* Added support for runtime selection of the AmazonLite wake word locale. The AmazonLite locale will automatically switch when the AVS locale is switched.
* Added support for optionally logging and uploading Alexa Auto SDK metrics to the Amazon cloud. Voice request metrics, for example, include start and end timestamps of user and Alexa speech and UPL between the request and Alexa’s response. Please contact your SA or Partner Manager for details or to request this package for Android.
* Added support for an optional platform interface `EqualizerController`. The Equalizer Controller enables Alexa voice control of device audio equalizer settings by making gain adjustments to three frequency bands (“BASS”, “MIDRANGE”, and/or “TREBLE”).
* Added an optional Code-Based Linking (CBL) authorization implementation in the Engine. With the new `cbl` module, the Engine handles acquiring access tokens. A `CBL` platform implementation should be registered with the Engine in place of an `AuthProvider` implementation to use this method for authorization.
* Improved the usage and deployment of the Local Voice Engine extension on Android. Please contact your SA or Partner Manager for more information.
* Updated the vehicle information configuration API to include a vehicle identifier. An `aace.vehicle.info.vehicleIdentifier` property of vehicle configuration is now available through the existing `VehicleConfiguration`.

**Resolved Issues**

* Fixed an issue where barging in while many unprocessed Speak directives are queued could cause SpeechSynthesizer to become unresponsive or crash
* Added an `EXPECTING` state to the `AlexaClient DialogState` to accommodate multi-turn for hold-to-talk interactions. When more user input is required during an interaction, tap-to-talk interactions will transition directly from `EXPECTING` to `LISTENING` whereas hold-to-talk will remain in the `EXPECTING` state until listening is manually triggered.
* Fixed an issue where the Android Sample App could get stuck in a loop of INVALID_REQUEST_EXCEPTION errors being thrown repeatedly after MACCAndroidClient reported an error. Note: To fix this, the C++ `ExternalMediaAdapter::getState` method signature changed to allow the implementation to say whether the state it provides is valid. This change is not backward compatible.
* Fixed an issue where the Android Sample App created a syslog sink and logged VERBOSE in release builds. Note: As part of the fix, the default Engine logger sink id changed from *console* to *default*. Existing calls to `LoggerConfiguration::createLoggerRuleConfig` with sink id `"console"` should be changed to sink id `"default"`.

**Known Issues**

* The Alexa Auto SDK Engine becomes unresponsive if it receives a ```Play``` directive during shutdown. However, since shutdown is triggered when car ignition is turned off, there is no direct customer impact expected.
* When a timer sounds during an Alexa-to-Alexa call, uttering "stop" ends the call, not the timer.
* Multiple automotive devices using the same account at the same time can access contacts from phones paired across those devices.
Latest commit 798ead5 Mar 5, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets Version 1.3.0 aac-sdk Nov 21, 2018
builder Version 1.5.0 aac-sdk Mar 6, 2019
docs Version 1.5.0 aac-sdk Mar 6, 2019
modules Version 1.5.0 aac-sdk Mar 6, 2019
platforms Version 1.5.0 aac-sdk Mar 6, 2019
samples Version 1.5.0 aac-sdk Mar 6, 2019
.gitignore Version 1.3.0 aac-sdk Nov 21, 2018
.gitmodules Version 1.5.0 aac-sdk Mar 6, 2019
CHANGELOG.md Version 1.5.0 aac-sdk Mar 6, 2019
CMakeLists.txt Version 1.5.0 aac-sdk Mar 6, 2019
CODE_OF_CONDUCT.md Version 1.1.0 aac-sdk Aug 31, 2018
CONTRIBUTING.md
LICENSE Creating initial file from template Apr 24, 2018
NEED_HELP.md Version 1.5.0 aac-sdk Mar 6, 2019
NOTICE
README.md
SEQUENCE_DIAGRAMS.md

README.md

Alexa Auto SDK

Alexa Auto SDK contains essential client-side software required to integrate Alexa into the automobile. The Alexa Auto SDK provides a runtime engine for communicating with the Alexa service. It also provides interfaces that allow the developer to implement platform specific behavior such as audio input, media playback, template and state rendering, and phone control. It also includes two sample applications that demonstrates how to use the Alexa Auto SDK interfaces.

Table of Contents:

Tip: Try looking at Need Help? if you don't see the topic you are looking for.

What is Included

The following components are included with the Alexa Auto SDK:

  • Builder: This directory contains the scripts that allow developers to build modules for a variety of hardware targets.

  • Modules: This directory contains the Alexa Auto SDK interfaces and source code in the following modules:

  • Android Sample App: This directory contains the Android sample application that uses the Alexa Auto SDK to demonstrate end-to-end functionality.

  • C++ Sample App: This directory contains the C++ sample application that uses the Alexa Auto SDK to demonstrate end-to-end functionality.

Additional functionality is available with help from your Amazon Solutions Architect (SA) or Partner Manager:

Alexa Auto SDK API Reference documentation is available for Android and C++. Access the Alexa Auto SDK API reference documentation from the links below.

Important! You need an Amazon Developer Account to use the Alexa Auto SDK. Read the Android Sample App documentation for more details.

General Build Requirements

You can build on a Linux, Unix, or macOS host of your choice.

However, we recommend and support running a Docker environment with the following configuration.

  • macOS Sierra or Ubuntu 16.04 LTS
  • Processor: 2.5 GHz
  • Memory: 16 Gb
  • Storage: 1 Gb+ available to use.

Build Dependencies and License Information

During the build time, the following dependencies are fetched and built for the target platform by Alexa Auto SDK Builder. Please refer to each of the individual entities for the particular licenses.

Note: that OpenEmbedded-Core will fetch and build additional components for preparing the dedicated toolchain for your environment (Such as GNU Binutils). Please refer to the Yocto project to understand how it works.

Vehicle Configuration Information

The Vehicle Configuration class provides an interface for vehicle information to be supplied to the SDK. This information is required to pass the certification process.

Read detailed information about the vehicle configuration class in the API reference documentation.

Build the Alexa Auto SDK

To build the Alexa Auto SDK you should read and understand the instructions in the Builder README.

The recommended and tested host operating systems are Ubuntu 16.04 LTS or macOS Sierra.

Supported Target Platforms

Alexa Auto SDK is supported on the following platforms:

  • Android 5.1 Lollipop API Level 22 or higher.
    • ARM 32-bit
    • ARM 64-bit
    • x86
    • x86 64-bit
  • QNX 7.0
    • ARM 64-bit
    • x86 64-bit
  • AGL
    • ARM 64-bit

Note: For Android targets, Alexa Auto SDK is available as a prebuilt library on GitHub. Read the instructions about accessing and using the library in the samples/android/ directory.

Alexa Auto SDK Architecture Overview

The Alexa Auto SDK is designed to allow flexibility in the integration of Alexa as a part of the automotive in-cabin experience. The Alexa Auto SDK Engine provides runtime support for Alexa and other services and allows the application to integrate with platform specific functionality. Platform specific behavior in Alexa Auto is abstracted into interfaces called "Platform Interfaces." These interfaces should be extended in the application and registered with the Engine.

The Platform Interfaces are documented in their respective module's API documentation.

Note: This diagram shows only some of the available platform interfaces.

architecture

Alexa Auto SDK Engine Alexa Auto SDK Engine

The runtime implementation of the Alexa Auto SDK is known as the Engine. Modules extend the Engine by providing services and defining the runtime behavior for Platform Interfaces that are registered by the application. The application software communicates with the Engine through the API defined by the Platform Interfaces.

Alexa Auto SDK Engine Core Module

The Core Module includes Platform Interfaces and runtime Engine support for Core features in the Alexa Auto SDK, such as logging, location, and network information. The services are used by components in other modules and are required by Alexa Auto SDK.

Click here for more information.

Alexa Auto SDK Engine Alexa Module

The Alexa Module includes Platform Interfaces and runtime Engine support for Alexa features in the Alexa Auto SDK. View some sequence diagrams for more details.

This module includes support for audio input, media playback, template and state rendering, and much more.

Click here for more information.

Alexa Auto SDK Engine Navigation Module

The Navigation Module includes Platform Interfaces and runtime Engine support for Alexa to interface with the onboard navigation system.

Click here for more information.

Alexa Auto SDK Engine Phone Control Module

The Phone Control Module includes Platform Interfaces and runtime Engine support for Alexa to interface with the onboard telephony system.

Click here for more information.

Additional Functionality

The following extensions to the Alexa Auto SDK are available by request. Please contact your Amazon Solutions Architect (SA) or Partner Manager for more information.

Wake Word Extension

Wake Word enables hands-free, voice-initiated interactions with Alexa. The Wake Word extension enables AmazonLite Wake Word support in the Alexa Auto SDK.

Alexa Communication Extension

The Alexa Communication extension enables integration with Alexa-to-Alexa calling, Alexa-to-PSTN calling, and messaging capabilities.

Local Voice Control Extension

The Local Voice Control extension provides car control functionality like climate control with and without an internet connection. It includes components that run an Alexa endpoint inside the vehicle's head unit. Local Voice Control is currently supported on Android 6.0, x86 64-bit and ARM 64-bit.

Metrics Uploading Extension

The Metrics Uploading extension enables logging and uploading Alexa Auto SDK metrics to the Amazon cloud. Voice request metrics, for example, include start and end timestamps of user and Alexa speech and UPL between the request and Alexa’s response. Metrics may be tagged Beta, Gamma, or Prod depending on the vehicle lifecycle. The Metrics Uploading extension is currently available for Android platforms.

Getting Started With a Sample App

The Android Sample App and C++ Sample App each provide an example of using the Alexa Auto SDK. Their respective READMEs have detailed instructions for setup and usage.

Release Notes and Known Issues

Feature enhancements, updates, and resolved issues are available to view in CHANGELOG.md

Android Sample App, C++ Sample App, and AGL known issues are documented in their respective READMEs.

You can’t perform that action at this time.