Skip to content

Commit

Permalink
Documentation Update: As part of the repository rename, all the refer…
Browse files Browse the repository at this point in the history
…ences to the old repository are changed to new repository.
  • Loading branch information
MuniSakkuru authored and Muni Sakkuru committed Jun 27, 2019
1 parent 8370f7c commit b9ee08f
Show file tree
Hide file tree
Showing 9 changed files with 19 additions and 19 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Expand Up @@ -92,7 +92,7 @@ No resolved issues.
* Redial, answer, terminate, and decline calls using voice. End users can also send dual-tone multi-frequency (DTMF) via voice to interact with Interactive Voice Responders (IVRs). Read more here [Phone Call Controller](./modules/phone-control/README.md).
* Switching to local media sources, generic controls and deep linking into 3rd party media applications compatible with the Amazon Media App Command and Control (MACC) specification using the External Media Player Interface 1.1. This allows customers to switch between a CD player, AM/FM player, and auxiliary input that is MACC-compliant. Read more here [Handling External Media Adapter with MACCAndroidClient](./platforms/android/ALEXA.md#handlingexternalmediaadapterwithmaccandroidclient).
* Enhancement for 3rd party wake word engine to enable cloud based verification.
* Provides a way to override Template Runtime display card timeout values for RenderTemplate and RenderPlayerInfo by updating the [templateRuntimeCapabilityAgent Engine configuration](https://alexa.github.io/aac-sdk/modules/core/#configuring-the-engine) values.
* Provides a way to override Template Runtime display card timeout values for RenderTemplate and RenderPlayerInfo by updating the [templateRuntimeCapabilityAgent Engine configuration](https://alexa.github.io/alexa-auto-sdk/modules/core/#configuring-the-engine) values.

### Resolved Issues

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Expand Up @@ -26,6 +26,6 @@ If you discover a potential security issue in this project we ask that you notif

## Licensing

See the [LICENSE](https://github.com/alexa/aac-sdk/blob/master/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
See the [LICENSE](https://github.com/alexa/alexa-auto-sdk/blob/master/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.

We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -39,8 +39,8 @@ Additional functionality is available with help from your Amazon Solutions Archi

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

* [Alexa Auto SDK for Android](https://alexa.github.io/aac-sdk/docs/android/)
* [Alexa Auto SDK for C++](https://alexa.github.io/aac-sdk/docs/cpp/)
* [Alexa Auto SDK for Android](https://alexa.github.io/alexa-auto-sdk/docs/android/)
* [Alexa Auto SDK for C++](https://alexa.github.io/alexa-auto-sdk/docs/cpp/)

> **Important!** You need an [Amazon Developer Account](https://developer.amazon.com/home.html) to use the Alexa Auto SDK. Read the [Android Sample App](./samples/android/README.md) documentation for more details.
Expand Down
4 changes: 2 additions & 2 deletions builder/meta-aac/classes/aac-module.bbclass
Expand Up @@ -11,10 +11,10 @@ python () {

AAC_PATCHES ??= ""

# Override with the aac-sdk version
# Override with the sdk version
PV = "${@aac.get_version(d)}"

HOMEPAGE ?= "http://github.com/alexa/aac-sdk"
HOMEPAGE ?= "http://github.com/alexa/alexa-auto-sdk"
LICENSE ?= "CLOSED"

inherit cmake unittests
Expand Down
2 changes: 1 addition & 1 deletion modules/alexa/README.md
Expand Up @@ -22,7 +22,7 @@ There are 3 steps to this process:
2. Your SA processes your request with the appropriate Alexa teams.
3. You'll receive a single zip file containing the necessary packages, instructions, and scripts.

All that's left for you to do is create an "extras" directory under your "aac-sdk" directory for the packages and follow the instructions in the README file included in the package.
All that's left for you to do is create an "extras" directory under your "alexa-auto-sdk" directory for the packages and follow the instructions in the README file included in the package.

### Handling Alexa state changes

Expand Down
10 changes: 5 additions & 5 deletions platforms/agl/alexa-voiceagent-service/README.md
@@ -1,13 +1,13 @@
# Automotive Grade Linux Alexa Voice Agent Binding

## Overview
AGL Alexa Voice Agent is an Alexa client software that gets plugged into the AGL speech framework to voice enable applications as described in the speech [architecture](https://confluence.automotivelinux.org/display/SPE/Speech+EG+Architecture). It is implemented as a standard AGL [binding](http://docs.automotivelinux.org/master/docs/apis_services/en/dev/reference/af-binder/afb-daemon-vocabulary.html#binding) that exposes API for
AGL Alexa Voice Agent is an Alexa client software that gets plugged into the AGL speech framework to voice enable applications as described in the speech [architecture](https://confluence.automotivelinux.org/display/SPE/Speech+EG+Architecture). It is implemented as a standard AGL [binding](https://docs.automotivelinux.org/docs/en/master/apis_services/reference/af-main/1-afm-daemons.html) that exposes API for
* Speech recognition start and cancel.
* Subscription to events containing Alexa's dialog, authentication, and connection states.
* Subscription to events containing Alexa's capability messages or directives.
* User authentication and authorization using Amazon's [Login with Amazon (LWA) Code-Based Linking](https://developer.amazon.com/docs/login-with-amazon/minitoc-lwa-other-devices.html).

[Alexa Auto SDK](https://gitlab.automotive.alexa.a2z.com/alexa-auto-hut/aac-sdk) is the underlying technology that powers the speech recognition capabilities of this binding.
[Alexa Auto SDK](https://github.com/alexa/alexa-auto-sdk) is the underlying technology that powers the speech recognition capabilities of this binding.

## Architecture
![architecture](./assets/architecture.png)
Expand Down Expand Up @@ -45,7 +45,7 @@ Alexa Voice Agent depends on Auto SDK. See the [Alexa Auto SDK Builder](../../..

For example, to build Alexa Auto SDK modules and needed dependencies for an *AGL ARM64* target, run the following commands:
```
$ git clone https://github.com/alexa/aac-sdk.git
$ git clone https://github.com/alexa/alexa-auto-sdk.git
$ ${AAC_SDK_HOME}/builder/build.sh oe -t aglarm64 ${AAC_SDK_HOME}/samples/audio
$ pushd ${AAC_SDK_HOME}/builder/deploy/aglarm64/
$ tar -xvf aac-image-minimal-aglarm64.tar.gz
Expand All @@ -65,7 +65,7 @@ Open `${AAC_SDK_HOME}/platforms/agl/alexa-voiceagent-service/src/plugins/data/co
3. Update the **aace.audio** section's **speechRecognizer** with Audio4a input role, **speechSynthesizer** and **audioPlayer** with Audio4a output roles if necessary. Otherwise use the default values in the config file. The **speechRecognizer** role *hw:ep812ch* maps to Microchip's mic array.

## Build Instructions
**Prerequisite**: Install the AGL SDK, preferably the latest stable release from [AGL artifacts](https://download.automotivelinux.org/AGL/release/). The AGL SDK contains [application framework libraries](http://docs.automotivelinux.org/master/docs/apis_services/en/dev/reference/af-binder/reference-v3/func-api.html) that we depend on for making inter-binding calls and publishing AGL events.
**Prerequisite**: Install the AGL SDK, preferably the latest stable release from [AGL artifacts](https://iot.bzh/download/public/2019/AGL_Images/). The AGL SDK contains [application framework libraries](https://docs.automotivelinux.org/docs/en/master/apis_services/reference/af-binder/reference-v3/func-api.html) that we depend on for making inter-binding calls and publishing AGL events.
1. Go to the ${AAC_SDK_HOME}/platform/agl/alexa-voiceagent-service directory
2. git submodule add https://gerrit.automotivelinux.org/gerrit/apps/app-afb-helpers-submodule afb-helpers
3. git submodule add https://gerrit.automotivelinux.org/gerrit/apps/app-controller-submodule app-controller
Expand Down Expand Up @@ -105,4 +105,4 @@ To access the Alexa Voice Service (AVS) it is required to acquire [Login with Am

## Known Issues

* There is no way to log out after authorizing with AVS. Restart the Alexa Voice Agent to authorize again.
* There is no way to log out after authorizing with AVS. Restart the Alexa Voice Agent to authorize again.
4 changes: 2 additions & 2 deletions platforms/android/CORE.md
Expand Up @@ -31,8 +31,8 @@ m_engine.configure( new EngineConfiguration[]{

Read about the `AlexaConfiguration Class` for more information about configurable methods.

* [Alexa Auto SDK for Android](https://alexa.github.io/aac-sdk/docs/android/)
* [Alexa Auto SDK for C++](https://alexa.github.io/aac-sdk/docs/cpp/)
* [Alexa Auto SDK for Android](https://alexa.github.io/alexa-auto-sdk/docs/android/)
* [Alexa Auto SDK for C++](https://alexa.github.io/alexa-auto-sdk/docs/cpp/)

**NOTE:** The Engine's `configure()` method can only be called once and must be called before registering any platform interfaces or starting the Engine.

Expand Down
2 changes: 1 addition & 1 deletion samples/android/README.md
Expand Up @@ -28,7 +28,7 @@ There are two options for including the Alexa Auto SDK dependencies:

##### Option 1: Use the pre-built aace-release.aar

To use the pre-built aace-release.aar, first download aace-release.aar from [Alexa Auto SDK Releases](https://github.com/alexa/aac-sdk/releases) to `${AAC_SDK_HOME}/samples/android/app/src/main/libs` *(you may need to create a libs directory)*, then follow steps to [configure the project in Android Studio](#configure-the-project-in-android-studio).
To use the pre-built aace-release.aar, first download aace-release.aar from [Alexa Auto SDK Releases](https://github.com/alexa/alexa-auto-sdk/releases) to `${AAC_SDK_HOME}/samples/android/app/src/main/libs` *(you may need to create a libs directory)*, then follow steps to [configure the project in Android Studio](#configure-the-project-in-android-studio).

> **Note**: Make sure to download the aace-release.aar corresponding to the version of Alexa Auto SDK that you are using.
Expand Down
8 changes: 4 additions & 4 deletions samples/cpp/README.md
Expand Up @@ -38,15 +38,15 @@ $ mkdir ~/Projects
$ cd ~/Projects
```

Clone the `aac-sdk` repository into your project directory:
Clone the `alexa-auto-sdk` repository into your project directory:

```shell
$ git clone https://github.com/alexa/aac-sdk.git
$ cd aac-sdk
$ git clone https://github.com/alexa/alexa-auto-sdk.git
$ cd alexa-auto-sdk
$ export AAC_SDK_HOME=$(pwd)
```

>**Note:** Most of the commands that follow are meant to be run from this `aac-sdk` directory.
>**Note:** Most of the commands that follow are meant to be run from this `alexa-auto-sdk` directory.
One or more configuration files can be passed to the sample app using the `--config <config-file-path>` flag. When additional modules are built with the sample app, it may be necessary to pass module specific configuration. Please refer to the `README` file within each extra module to get configuration information. For convenience, a [config file template](./assets/config.json.in) has been included for the core Auto SDK modules. The template must be customized with customer specific values.

Expand Down

0 comments on commit b9ee08f

Please sign in to comment.