Release esp-va-sdk-v1.0-rc1-193877

Author: kedars

CHANGELOG.md

@@ -1,6 +1,50 @@
 ## ChangeLog
 
-### v1.0b1r7 (Beta) - 2018-01-08
+### 1.0-RC1 - 2019-05-14
+
+**Enhancements**
+
+This release is a major update to the previous release and includes the following changes:
+* Alexa:
+ * All the Alexa functional and music certification tests can now be passed with this release.
+ * Robustness enhancements that pass 100-hour long duration stress tests.
+ * Wi-Fi and Alexa configuration on BLE (Bluetooth Low Energy) makes the provisioning experience much smoother (This mandates that you upgrade to the latest phone apps while using this release.).
+   * Newer app and firmware supports WiFi scanlist as well.
+ * Supports greater number of music stations because of:
+   * Greater tolerance for variance in different music stations M3U8 formats.
+   * Support for additional 'Content-Type' as reported by some music stations.
+* Improved directory structure to add flexibility to provide way to test other ESP32 based audio boards. Examples can be build and flashed on any of the following development boards with proper "AUDIO_BOARD_PATH" provided:
+ 1. LyraT
+ 2. LyraTD-SYNA
+ 3. LyraTD-DSPG
+ 4. LyraTD-MSC
+
+* LEDs and tones are added for GVA and Dialogflow.
+* Support for setting custom tones.
+* nvs-set CLI supports setting and getting int16_t variable type.
+
+**API Changes**
+
+* Examples directories are renamed according to voice assistants. There are now 3 examples viz., amazon_alexa, google_voice_assistant and google_dialogflow.
+* BLE provisioning and authentication for Alexa instead of SoftAP provisioning.
+* Local Player, Equalizer and AWS-IoT are moved inside amazon_alexa/additional_components/
+* voice_assistant_app_cb.h:
+  * va_app_set_volume() is now deprected. A new function va_app_volume_is_set() is now introduced. Earlier the app had to change the volume itself. Now this is directly handled in the medial-hal layer. The application layer only gets a notification once the volume changed has happened.
+  * va_app_set_mute() is now deprected. A new function va_app_mute_is_set() is now introduced. Earlier the app had to mute the volume itself. Now this is directly handled in the medial-hal layer. The application layer only gets a notification once the mute change has happened.
+* A new API va_boot_is_finish() is introduced that allows applications to wait until the complete boot-up has finished.
+* A new API tone_set_custom() lets application override the existing tone with a custom tone that can be played.
+* The audio_player_stop() API is now updated to include one additional parameter which is a notify callback.
+* The alexa_config_t structure now includes two additional members 'device_serial_num' and 'product_id' which are now used for communication with the AVS service.
+
+
+**Bug Fixes**
+
+* Fixed What’s up interruption stalling the device.
+* Code restructuring in the SDK to fix various race conditions occurring during long-duration testing
+* Improved stability for if the Internet or Wi-Fi connectivity is intermittent.
+* All well known TuneIn radio stations are now supported.
+
+### v1.0b1r7 (Beta) - 2019-01-08
 
 **Enhancements**
 
@@ -11,7 +55,7 @@
 **API Changes**
 
 * Example directories are renamed.
-* Many structures, functions and header files with "alexa" prefix are renamed with "va" prefix. Please follow README-FIRST.md if you want to compile and run older examples with new SDK.
+* Many structures, functions and header files with "alexa" prefix are renamed with "va" prefix. Please follow the `Upgrading from Previous Release` section from `README-Getting-Started.md` if you want to compile and run older examples with new SDK.
 
 **Bug Fixes**
 

README-FIRST.md

@@ -1,39 +1,55 @@
 # Prerequisites
 Please prepare your host system with the toolchain. Please see http://esp-idf.readthedocs.io/en/latest/get-started/index.html for the host setup.
 
-# Supported Hardware
-lyrat and lyrat_sr application supports ESP32 based LyraT v4.1, LyraT v4.2 and LyraT v4.3
-lyratd_msc_sr application supports ESP32 based LyraTD_MSC v2.0, LyraTD_MSC v2.1
 
 # Prepare Images
 
 ## Clone all the repositories
 ```
 $ git clone --recursive https://github.com/espressif/esp-idf.git
 
-$ cd esp-idf; git checkout release/v3.1; cd ..
+$ cd esp-idf; git checkout release/v3.2; cd ..
 
-$ git clone https://github.com/espressif/esp-avs-sdk.git
-```
-
-## Apply patches on esp-idf
-```
-$ cd esp-idf
-
-$ git apply ../esp-avs-sdk/esp-idf-patches/memset-i2s-dma-buffers-zero.patch
-
-$ git apply ../esp-avs-sdk/esp-idf-patches/esp-tls-Add-support-for-global-CA-store.-All-mbedtls.patch
+$ git clone https://github.com/espressif/esp-va-sdk.git
 ```
 
 ## Build and flash the project
 ```
-$ cd esp-avs-sdk/examples/<example_board_directory>
+$ cd esp-va-sdk/examples/<example_voice_assistant_directory>
+
+$ export ESPPORT=/dev/cu.SLAB_USBtoUART (or /dev/ttyUSB0 or /dev/ttyUSB1 on Linux or COMxx on MinGW)
 
 $ export IDF_PATH=/path/to/esp-idf
 
-$ export ESPPORT=/dev/cu.SLAB_USBtoUART (or /dev/ttyUSB0 or /dev/ttyUSB1 on Linux or COMxx on MinGW)
+# Set audio_board path. e.g. For LyraT board:
+$ export AUDIO_BOARD_PATH=/path/to/esp-va-sdk/board_support_pkgs/lyrat/audio_board/audio_board_lyrat/
 
-$ make -j 8 flash VOICE_ASSISTANT=<alexa/gva/dialogflow> monitor
+$ make -j 8 flash monitor
 ```
 NOTE:
-> lyrat app only supports Tap-to-talk whereas lyrat_sr and lyratd_msc_sr apps support both, "Alexa" wakeword and tap-to-talk.
+> The google_voice_assistant and google_dialogflow applications only support Tap-to-talk whereas the amazon_alexa application supports both, "Alexa" wakeword and tap-to-talk.
+
+# Upgrading from Previous Release
+Please skip this section if you are using the SDK for the first time.
+
+## Upgrading to 1.0-RC1
+
+* The example applications have changed from hardware specific to voice assistant specific.
+  * Hardware/Board specific configuration (specifically, LEDs, Hardware Codecs, DSP and the board) is moved into a separate board support package. Please pass the path of this package to the build command line as indicated above.
+* The esp-idf branch needs to be changed to release/v3.2 from release/v3.1 and the relevant new patches need to be applied.
+* The nvs version is changed with IDF release/v3.2. Please do `make erase-flash` before flashing the new app. Now re-provision the device.
+* Provisioning and authentication of Alexa app is now carried out over BLE instead of SoftAP. Use the new Android app for the same. (iOS app support is comming soon). GVA and Dialogflow would continue to use their respective older provisioning methods for now.
+
+
+## Upgrading to v1.0b1r7 (Beta)
+
+* Most API names have changed from alexa\_ to va\_. Please follow these steps to upgrade.
+* Download script v1_0r6Tov1_0r7_update_script.sh available under "releases" tab, and copy it in SDK's root directory (esp-voice-assistants).
+* Copy your example in examples directory.
+* Run the script using below commands:
+    * cd /path/to/esp-voice-assistants
+    * ./v1_0r6Tov1_0r7_update_script.sh
+
+## Upgrading to v1.0b1r6 (Beta)
+
+* Release v1.0b1r6 changes the way WiFi credentials are stored in NVS. Hence when you upgrade your device to latest SDK, your device would go into provisioning mode again, and needs to be re-provisioned via provisioning app.

README-Getting-Started.md

@@ -1,18 +1,18 @@
 ## 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 to evaluate ESP32 based voice assistant/s integrated devices like speakers and IoT devices. Please refer to [Changelog](CHANGELOG.md) to track release changes and known-issues.
+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 to evaluate ESP32 based voice assistant/s integrated devices like speakers and other IoT devices. Please refer to [Changelog](CHANGELOG.md) to track release changes and known-issues.
 
 ### About SDK
 
-The SDK contains pre-built libraries for Alexa, GVA and Dialogflow along with sources of some of the utility components such as audio pipeline and connection manager. Below are the list of features supported for each voice assistant:
-* **Alexa**:
-    * Basic Alexa conversation
-    * Alexa dialogues and multi-turn
-    * Audio Streaming and Playback: Saavn, Amazon music, TuneIn (Only limited stations are supported as of now)
+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 Alexa command
+    * Volume control via voice command
     * Seek support for Audible
-    * Alerts/Timers, Reminders, Notifications
+    * Alarms, Timers, Reminders, Notifications
 
 * **Google Voice Assistant**:
     * Basic conversation
@@ -23,7 +23,7 @@ The SDK contains pre-built libraries for Alexa, GVA and Dialogflow along with so
 * **Google Dialogflow**:
     * Basic conversation
     * Multi-turn conversations
-    * Configure and control connected devices via voice, e.g "Turn the light on"
+    * Configure and control connected devices via voice, e.g "Start the Laundry"
     * Multiple language support
 
 ## Supported Hardware
@@ -33,14 +33,13 @@ The SDK supports the following hardware platforms:
 * [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 DBMD5
+* DSPG DBMD5P
 * Intel s1000
 * Synaptics CX20921
 
 ## Getting started
 
 * Follow the `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.
-* Go through `README-<voice_assistant>.md` to know how to provision the device and to get authentication tokens from respective authorization server and flash them onto the device.
-* Check example application's README for board or example specific changes that might be required.
-* If you are updating from previous release, please check `README-FIRST.md` to know about any specific actions that needs to be taken while upgrading.
+* 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.
+* Go through `README-<voice_assistant>.md` in their respective directories to know how to provision the device and to get authentication tokens from the respective authorization server and flash them onto the device.
+* If you are updating from previous release, please check the `Upgrading from Previous Release` section from `README-Getting-Started.md` to know about any specific actions that needs to be taken while upgrading.

README.md

@@ -0,0 +1,13 @@
+## Overview
+
+This folder contains support packages for various ESP32 based development boards.
+
+Build any of the examples from this sdk by providing AUDIO_BOARD_PATH for any of the board.
+
+For example command below will build voice assistant example for `LyraT` board:
+
+```
+make -j8 AUDIO_BOARD_PATH=<path_to_this folder/lyrat/audio_board/audio_board_lyrat/>
+```
+
+You may as well create package for your own board in this fashion and provide path as example above to build for that board.

board_support_pkgs/README.md

@@ -0,0 +1,18 @@
+AUDIO_HAL_PATH := $(AUDIO_BOARD_PATH)/../../
+IPC_DRV_PATH := $(AUDIO_BOARD_PATH)/
+
+# Board
+EXTRA_COMPONENT_DIRS += $(AUDIO_BOARD_PATH)/
+
+# LED driver
+EXTRA_COMPONENT_DIRS += $(AUDIO_HAL_PATH)/led_driver/ledc_lyrat
+
+# codec
+EXTRA_COMPONENT_DIRS += $(AUDIO_HAL_PATH)/esp_codec/es8388/components/
+
+# va_dsp
+include $(IPC_DRV_PATH)/va_dsp/va_dsp.mk
+
+# This var sets partition file to partitions_4mb_flash.csv
+# Please take a look at example makefile.
+PARTITIONS_4MB_FLASH_CSV = 1

board_support_pkgs/lyrat/audio_board/audio_board_lyrat/audio_board.mk

@@ -91,12 +91,8 @@ esp_err_t audio_board_i2s_init_default(i2s_config_t *i2s_cfg_dft)
     i2s_cfg_dft->dma_buf_len = 300;                   /*!< size of each dma buffer (Byte) */
     i2s_cfg_dft->intr_alloc_flags = 0;
     i2s_cfg_dft->use_apll = 0;
+    i2s_cfg_dft->tx_desc_auto_clear = true;
 
     return ESP_OK;
 }
 
-esp_err_t audio_board_button_config(adc1_channel_t *pf_button_pin)
-{
-    *pf_button_pin = ADC1_CHANNEL_3;
-    return ESP_OK;
-}

examples/lyrat_alexa_local_player_with_equalizer/components/audio_board_lyrat/audio_board_lyrat.c renamed to board_support_pkgs/lyrat/audio_board/audio_board_lyrat/audio_board_lyrat/audio_board_lyrat.c

@@ -2,4 +2,8 @@
 # Component Makefile
 #
 
+COMPONENT_ADD_INCLUDEDIRS := .
+
 COMPONENT_SRCDIRS := .
+
+