# esp-va-sdk

**Repository Path**: espressif-systems/esp-va-sdk

## Basic Information

- **Project Name**: esp-va-sdk
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-11-12
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## Overview

The ESP-Voice-Assistant SDK provides an implementation of Amazon's Alexa Voice Service, Google Voice Assistant and Google's conversational interface (aka Dialogflow) for ESP32 microcontroller. This facilitates the developers directly run these voice-assistants on an ESP32. The SDK will run on hardware boards that have Microphone/Speaker interfaced with the ESP32.

Please refer to [Changelog](CHANGELOG.md) to track release changes and known-issues.

### About the SDK

The SDK contains pre-built libraries for Amazon Alexa, Google Voice Assistant (GVA) and Google Dialogflow along with sources of some of the utility components such as audio pipeline and connection manager. Below are the list of some of the features supported for each voice assistant:
* **Amazon Alexa**:
    * Basic conversation
    * Multi-turn conversations
    * Audio Streaming and Playback
    * Audio Book Support: Kindle, Audible
    * Volume control via voice command
    * Seek support for Audible
    * Alarms, Timers, Reminders, Notifications

* **Google Voice Assistant**:
    * Basic conversation
    * Multi-turn conversations
    * Getting weather reports
    * Multiple language support

* **Google Dialogflow**:
    * Basic conversation
    * Multi-turn conversations
    * Configure and control connected devices via voice, e.g "Start the Laundry"
    * Multiple language support

## Supported Hardware

The SDK supports the following hardware platforms:
* [ESP32-LyraT](https://www.espressif.com/en/products/hardware/esp32-lyrat)
* [ESP32-LyraTD-MSC](https://www.espressif.com/en/products/hardware/esp32-lyratd-msc)

The following list of acoustic front-ends is also supported. Please contact Espressif to enable acccess to these solutions.
* DSPG DBMD5P
* Intel s1000
* Synaptics CX20921

## Getting started

* Follow the [Getting Started Guide](README-Getting-Started.md) to clone the required repositories and to compile and flash the firmware.
* When flashing the SDK for the first time, it is recommended to do `make erase_flash` to wipe out entire flash and start out fresh.
* Once you have the firmware flashed, visit the following pages for interacting with the device:
   * [Alexa](examples/amazon_alexa/README-Alexa.md)
   * [Google Voice Assistant](examples/google_voice_assistant/README-GVA.md)
   * [DialogFlow](examples/google_dialogflow/README-Dialogflow.md)
* If you are updating from previous release, please check the `Upgrading from Previous Release` section from the [Getting Started Guide](README-Getting-Started.md) to know about any specific actions that needs to be taken while upgrading.