Merge pull request #60 from xmos/release/v3.1.0

Release/v3.1.0

CHANGELOG.md

@@ -1,5 +1,11 @@
 # VocalFusion AVS Setup Change Log
 
+## 3.1.0
+
+  * Renamed xvf3510 device as xvf3510-int
+  * Added support for xvf3510-ua
+  * Updated Readme
+
 ## 3.0.0
 
   * Added support for xvf3610-ua and xvf3615-ua

README.md

@@ -29,7 +29,7 @@ You will need:
 - MicroSD card (min. 16GB)
 - Powered speakers with audio 3.5mm analogue plug
 
-   Stereo for the XVF3610, XVF3510 and XVF3500, or
+   Stereo for the XVF3615, XVF3610, XVF3510 and XVF3500, or
    Mono for the XVF3100 and XVF3000
 
 - Monitor with HDMI input
@@ -55,14 +55,16 @@ Once the hardware is setup, upgrade the firmware on your AVS development kit. Th
    - XVF3615-UA: https://www.xmos.ai/file/xvf3615-ua-release
    - XVF3610-INT: https://www.xmos.ai/file/xvf3610-int-release
    - XVF3610-UA: https://www.xmos.ai/file/xvf3610-ua-release
-   - XVF3510: https://www.xmos.ai/file/xvf3510-int-release
+   - XVF3510-INT: https://www.xmos.ai/file/xvf3510-int-release
+   - XVF3510-UA: https://www.xmos.ai/file/xvf3510-ua-release
    - XVF3500: https://www.xmos.ai/file/vocalfusion-stereo-evaluation-binaries
    - XVF3100: https://www.xmos.ai/file/vocalfusion-speaker-evaluation-binaries
    - XVF3000: https://www.xmos.ai/file/vocalfusion-speaker-evaluation-binaries
 
-To upgrage the firmware you will need the XMOS xTAG adapter https://www.xmos.ai/xtag-debug-adapter/
+To upgrade the firmware you will need the XMOS xTAG adapter https://www.xmos.ai/xtag-debug-adapter/
 
 ## Create a Raspberry Pi system disk
+
 First, obtain the required version of the Raspberry Pi operating system, which is available here:
 
 https://downloads.raspberrypi.org/raspbian/images/raspbian-2020-02-14/2020-02-13-raspbian-buster.zip
@@ -118,7 +120,8 @@ When the Raspberry Pi boots up, give these answers to the following questions:
    - XVF3615-UA: ```./auto_install.sh xvf3615-ua```
    - XVF3610-INT: ```./auto_install.sh xvf3610-int```
    - XVF3610-UA: ```./auto_install.sh xvf3610-ua```
-   - XVF3510: ```./auto_install.sh xvf3510```
+   - XVF3510-INT: ```./auto_install.sh xvf3510-int```
+   - XVF3510-UA: ```./auto_install.sh xvf3510-ua```
    - XVF3500: ```./auto_install.sh xvf3500```
    - XVF3100: ```./auto_install.sh xvf3100```
    - XVF3000: ```./auto_install.sh xvf3100```
@@ -129,11 +132,11 @@ When the Raspberry Pi boots up, give these answers to the following questions:
 
 6. You will be asked whether you want the Sample App to run automatically when the Raspberry Pi boots. It is recommended that you respond "yes" to this option.
 
-7. Read and accept the Sensory license agreement. Wait for the script to complete the installation. The script is configuring the Raspberry Pi audio system, downloading and updating dependencies, building and configuring the AVS Device SDK. It takes around 30 minutes to complete.
+7. Wait for the script to complete the installation. The script is configuring the Raspberry Pi audio system, downloading and updating dependencies, building and configuring the AVS Device SDK. It takes around 30 minutes to complete.
 
 8. Enter `sudo reboot` to reboot the Raspberry Pi and complete the installation.
 
-9. If you selected the option to run the Sample App on boot you should now be able to complete the registration by following the instructions on the screen, although you may need to scroll back to see them. A code will be printed on the screen, and you will be prompted to visit https://amazon.com/us/code, log in to your developer account, and enter the code when prompted.
+9. If you selected the option to run the Sample App on boot there should now be a terminal open with the sample app runnning. If the sample app is not running, then open a terminal and use `avsrun` to start the app. You should now be able to complete the registration by following the instructions on the screen, although you may need to scroll back to see them. A code will be printed on the screen, and you will be prompted to visit https://amazon.com/us/code, log in to your developer account, and enter the code when prompted.
 
 10. Now you can execute an AVS command such as "Alexa, what time is it?".
 
@@ -145,10 +148,11 @@ When the Raspberry Pi boots up, give these answers to the following questions:
 The automated installation script creates a number of aliases which can be used to execute the AVS Device SDK client, or run the unit tests:
 - `avsrun` to run the Sample App.
 
-## Changing Sensory operating point
+The XVF3615-INT and XVF3615-UA devices have an internal wakeword detector which switches the AVS console to listening mode when saying "Alexa". The other devices don't have any wakeword detection mechanism, neither on the device nor on host. Before the user issues a command, they must use the 'tap-to-talk' option, by pressing 't' on the AVS console.
+
+## Reinstalling the AVS SDK and Raspberry Pi audio setup
+
+In case of re-installation, please repeat the full procedure as described in the sections "Create a Raspberry Pi system disk" and "AVS SDK installation and Raspberry Pi audio setup". It is recommended the re-installation procedure starts always from a blank SD card.
 
-To change to operating point of the Sensory keyword engine, edit the shell script run by the `avsrun` alias:
 
-   `~/sdk-folder/avs-device-sdk/tools/Install/.avsrun-startup.sh`
 
-and change the third argument to SampleApp from the default value of `12` to the desired value.

auto_install.sh

@@ -7,12 +7,12 @@ RPI_SETUP_REPO=vocalfusion-rpi-setup
 RPI_SETUP_DIR=$SETUP_DIR/$RPI_SETUP_REPO
 RPI_SETUP_SCRIPT=$RPI_SETUP_DIR/setup.sh
 
-RPI_SETUP_TAG="v5.0.0"
-AVS_DEVICE_SDK_TAG="v1.25.0.2"
+RPI_SETUP_TAG="v5.1.0"
+AVS_DEVICE_SDK_TAG="v1.25.0.3"
 AVS_SCRIPT="setup.sh"
 
 # Valid values for XMOS device
-VALID_XMOS_DEVICES="xvf3100 xvf3500 xvf3510 xvf3600-slave xvf3600-master xvf3610-int xvf3610-ua xvf3615-int xvf3615-ua"
+VALID_XMOS_DEVICES="xvf3100 xvf3500 xvf3510-int xvf3510-ua xvf3600-slave xvf3600-master xvf3610-int xvf3610-ua xvf3615-int xvf3615-ua"
 XMOS_DEVICE=
 
 # Default device serial number if nothing is specified
@@ -156,8 +156,8 @@ if $RPI_SETUP_SCRIPT $XMOS_DEVICE; then
   wget -O pi.sh https://raw.githubusercontent.com/xmos/avs-device-sdk/$AVS_DEVICE_SDK_TAG/tools/Install/pi.sh
   wget -O genConfig.sh https://raw.githubusercontent.com/xmos/avs-device-sdk/$AVS_DEVICE_SDK_TAG/tools/Install/genConfig.sh
   chmod +x $AVS_SCRIPT
-AVS_CMD="./${AVS_SCRIPT} ${CONFIG_JSON_FILE} ${AVS_DEVICE_SDK_TAG} -s ${DEVICE_SERIAL_NUMBER} -x ${XMOS_DEVICE} ${GPIO_KEY_WORD_DETECTOR_FLAG} ${HID_KEY_WORD_DETECTOR_FLAG}"
-echo "Running command ${AVS_CMD}"
+  AVS_CMD="./${AVS_SCRIPT} ${CONFIG_JSON_FILE} ${AVS_DEVICE_SDK_TAG} -s ${DEVICE_SERIAL_NUMBER} -x ${XMOS_DEVICE} ${GPIO_KEY_WORD_DETECTOR_FLAG} ${HID_KEY_WORD_DETECTOR_FLAG}"
+  echo "Running command ${AVS_CMD}"
   if $AVS_CMD; then
     echo "Type 'sudo reboot' below to reboot the Raspberry Pi and complete the AVS setup."
   fi