This project demonstrates how to access and test the Alexa Voice Service using a Java client (running on a Raspberry Pi), and a Node.js server.
Shell
Latest commit 2787fd6 Mar 9, 2017 @erikhopf-amzn erikhopf-amzn committed on GitHub Update README.md

README.md

About the project

This project provides a step-by-step walkthrough to help you build a hands-free Alexa Voice Service (AVS) prototype in 60 minutes, using wake word engines from Sensory or KITT.AI. Now, in addition to pushing a button to "start listening", you can now also just say the wake word "Alexa", much like the Amazon Echo. You can find step-by-step instructions to set up the hands-free prototype on Raspberry Pi, or follow the instructions to set up the push-to-talk only prototype on Linux, Mac, or Windows.

NEW! - Click here for instructions to build the AVS Prototype using a Raspberry Pi and the Conexant 2-Mic Development Kit for Amazon AVS


What is AVS?

Alexa Voice Service (AVS) is Amazon’s intelligent voice recognition and natural language understanding service that allows you as a developer to voice-enable any connected device that has a microphone and speaker.


What's new?

January 30, 2017:

The AVS java sample app has been updated with the following changes:

  1. Added support for the SetEndpoint directive.
    See sample code »
    Read the docs »
  2. Added support for the Settings Interface.
    See the code »
    Read the docs »
  3. Added locale switcher (en-US, en-GB, de-DE) to sample app user interface.

For information on how to update your client code, see Preparing for Internationalization on the Amazon Developer Portal.


Important considerations

  • Review the AVS Terms & Agreements.

  • The earcons associated with the sample project are for prototyping purposes only. For implementation and design guidance for commercial products, please see Designing for AVS and AVS UX Guidelines.

  • Usage of Sensory & KITT.AI wake word engines: The wake word engines included with this project (Sensory and KITT.AI) are intended to be used for prototyping purposes only. If you are building a commercial product with either solution, please use the contact information below to enquire about commercial licensing -

  • IMPORTANT: The Sensory wake word engine included with this project is time-limited: code linked against it will stop working when the library expires. The library included in this repository will, at all times, have an expiration date that is at least 120 days in the future. See Sensory's GitHub page for more information on how to renew the license for non-commercial use.


Get started

You can set up this project on the following platforms. Please choose the platform you'd like to set this up on -


Contribute

  • Want to report a bug or request an update to the documentation? See CONTRIBUTING.md.
  • Have questions or need help building the sample app? Open a new issue.