synaptics audiosmart 2-mic development kit for · pdf filenotice ... // ... the synaptics...

Synaptics AudioSmart 2-Mic Development Kit for Amazon AVS

511-000841-01 Rev A

Synaptics AudioSmart 2-Mic Development Kit for Amazon AVS 511-000841-01 Rev A

Revision HistoryDocument No. Release Date Change Description511-000841-01 Rev A 11/08/17 Conversion to Synaptics template

006UGR00 09/2017 Initial release

2 November 8, 2017 8:24 am Synaptics Incorporated. All Rights Reserved

Synaptics Confidential. Internal Use Only.

Synaptics Confidential. Disclosed Only Under NDA - Limited Distribution.

S ti C fid ti l Di l d O l U d NDA

CX20921 User Guide Table of Contents

Synaptics Confidential11/08/17 511-000841-01 3

Table of ContentsRevision History ...........................................................................................................................................................2

Scope .............................................................................................................................................................................1Target Audience ............................................................................................................................................................1References ....................................................................................................................................................................1Definitions, Acronyms, and Abbreviations.................................................................................................................1

Overview........................................................................................................................................................................2

CX20921 Evaluation Board ..........................................................................................................................................3

Pin Definition.................................................................................................................................................................4

Setup..............................................................................................................................................................................5Writing Raspbian OS to the microSD Card ................................................................................................................5Connecting the EVK to the RPi 3 ................................................................................................................................6

AVS Setup......................................................................................................................................................................9

Running Node.js Service, Sample App, Wake Word Engine, & Recording Agent ................................................13Terminal Window 1 ............................................................................................................................................................ 13

Terminal Window 2 ............................................................................................................................................................ 13

Terminal Window 3 ............................................................................................................................................................ 13

Terminal Window 4 ............................................................................................................................................................ 14

AVS Setup: Amazon Account Login ................................................................................................................................ 15

Changing Trigger Modes............................................................................................................................................19Verifying the Setup .....................................................................................................................................................20

Installing the Cypress Siena USB-to-I2C Device Driver..........................................................................................21

Flashing New Firmware..............................................................................................................................................23

Troubleshooting..........................................................................................................................................................25Trademarks..................................................................................................................................................................25Notice...........................................................................................................................................................................25

CX20921 User Guide List of Figures


List of FiguresFigure 1: Development Kit Components ........................................................................................................................................... 2

Figure 2: CX20921 Evaluation Board: Connections, Interfaces, and Devices.................................................................................. 3

Figure 3: Pinout of RPi 3................................................................................................................................................................... 4

Figure 4: CX20921 Eval Board Setup with RPi 3 board and Mic Board (with 2-mic Attached) ........................................................ 7

Figure 5: Connections for CX20921 Eval Board and Mic Board (with 2-mic Attached) .................................................................... 7

Figure 6: Connections for the RPi 3.................................................................................................................................................. 8

Figure 7: Alexa Voice Service User Interface ................................................................................................................................. 15

Figure 8: Example FCP Folder ....................................................................................................................................................... 23

Figure 9: Build Folder Contents ...................................................................................................................................................... 24

CX20921 User Guide Scope

ScopeThis documentation provides step-by-step instructions on setting up the Synaptics AudioSmart™ 2-Mic Development Kit for Amazon AVS. The document covers how to make the necessary hardware connections, install the driver, flash the firmware (only when needed), set up the Amazon Alexa Voice Service (AVS), and switch between the keyword detection (voice trigger) modes.

Target AudienceThis document is intended for manufacturers and developers for creating Smart Home device prototypes that utilize the Synaptics AudioSmart 2-Mic Development Kit and the RPi 3 (not provided with the kit) to offer an ideal Voice Control experience via Amazon's Alexa Voice Service.

References

Definitions, Acronyms, and Abbreviations

Name of Document Description Location

I2C I2C Specification http://www.nxp.com/documents/user_manual/UM10204.pdf

ACPI Advanced Configuration and Power Interface

http://www.acpi.info/DOWNLOADS/ACPIspec50.pdf

RPi 3 An open source code single-board computer

https://www.raspberrypi.org/products/raspberry-pi-3-model-b/

ALSA The Advanced Linux Sound Architecture (ALSA) provides audio and MIDI functionality to the Linux operating system.

http://www.alsa-project.org/main/index.php/Main_Page

ASoC ALSA system on Chip for I2S codecs

http://www.alsa-project.org/main/index.php/ASoC

Name of Document DescriptionAVS Alexa Voice Service

DSDT Differentiated System Description Table

GPIO General-Purpose Input/Output

I2C Inter-Integrated Circuit

RPi 3 Raspberry Pi3


http://www.nxp.com/documents/user_manual/UM10204.pdf

http://www.acpi.info/DOWNLOADS/ACPIspec50.pdf

https://www.raspberrypi.org/products/raspberry-pi-3-model-b/

http://www.alsa-project.org/main/index.php/Main_Page

http://www.alsa-project.org/main/index.php/ASoC

CX20921 User Guide Overview

OverviewThe Synaptics AudioSmart 2-Mic Development Kit for Amazon AVS contains the following:

• CX20921 evaluation board, pre-flashed with firmware• Microphone module with two omnidirectional mics • Microphone holder board• Stereo 3.5mm Male-to-Male audio cable• Micro-USB cable• Type A to Type B USB cable• Cable assembly (colored wires) • +5V power supply for CX20921 evaluation board

Note:

• Micro SD card of at least 8GB is required.• Powered speakers, RPi 3 board, and micro SD card are all mandatory for the set up but are NOT

included in the Synaptics AudioSmart 2-mic Development Kit.

* Proper speaker selection will enhance overall performance. Please download "External Loudspeaker Guidelines and Recommendation for Smart Speaker Applications" document for additional info.

Figure 1: Development Kit Components


CX20921 User Guide CX20921 Evaluation Board

CX20921 Evaluation Board

Figure 2: CX20921 Evaluation Board: Connections, Interfaces, and Devices


CX20921 User Guide Pin Definition

Pin DefinitionFigure 3 shows the pinout definition on RPi 3 (not included in the kit). The pins that are used (13 and 14) are emphasized in red.

Figure 3: Pinout of RPi 3


CX20921 User Guide Setup

Setup1. Write a Raspbian Image to the micro SD. See "Writing Raspbian OS to the microSD Card".

2. Connect the CX20921 evaluation board and the RPi 3 (not provided with the kit). For more detailed information, refer to "Connecting the EVK to the RPi 3" on page 6.

3. Setup the AVS. For detailed information, please refer to "AVS Setup" on page 9.

4. Optional step: Upgrade the firmware for the CX20921 device. Note that the CX20921 evaluation board is pre-flashed with the firmware required so this step is only necessary if an updated CX20921 firmware is provided. For detailed information, refer to "Flashing New Firmware" on page 23.

Writing Raspbian OS to the microSD Card1. Format the SD card. This can be done by going to the 'Computer' folder and right clicking on the SD

card. Click Format… to display the format options. When reformatting, confirm that the File system is FAT32 or FAT, as shown below.

2. Download the Raspbian Jessie OS. The zip file is located at the following link:

http://downloads.raspberrypi.org/raspbian/images/raspbian-2017-07-05/

3. Unzip and write the downloaded image to the SD card using Win32DiskImager. This tool can be found at the following link: https://sourceforge.net/projects/win32diskimager/

4. Run the Win32DiskImager to write the image to the SD card.

– Browse to the subdirectory icon and select the image file.– Select the device drive in the Device drop down menu to write the Raspbian OS.– Click Write to write the image to the SD card.

5. After the image has finished writing, insert the microSD card into the RPi 3.


http://downloads.raspberrypi.org/raspbian/images/raspbian-2017-07-05/

https://sourceforge.net/projects/win32diskimager/

https://sourceforge.net/projects/win32diskimager/

CX20921 User Guide Connecting the EVK to the RPi 3

Connecting the EVK to the RPi 3Make the following hardware connections between the CX20921 evaluation board and the RPi 3 (not provided with the kit), as shown in Figure 4 on page 7 and Figure 5 on page 7.

1. Connect the 3.5mm audio jack on the RPi 3 (J7) to LINEIN on the CX20921 evaluation board (J25).

2. Connect audio jack, J3, (Line Out labeled as HP) on the CX20921 evaluation board to a * powered speaker.

3. Connect the microphone module (attach two microphones to the microphone board) to the CX20921 evaluation board (J19).

a. Spacing between the left MIC and right MIC should be set to 55mm with the preloaded configuration. Refer to Figure 4 on page 7.

b. Software tool (FCP Essential) will be provided for mic distance adjustment between 30mm - 120mm

4. Connect the audio path from micro USB (J1) to USB port on RPi 3.

5. Using the Cable Assembly, connect GPIO1 at pin 2.14 from CX20921 evaluation board to J8.pin13 on the RPi 3, and the other wire from the Cable Assembly to Ground (GND) at pin 2.15 from the CX20921 evaluation board to J8.pin14 on RPi 3.

6. Connect the power supplies for both the CX20921 evaluation board, (J10, +5V power supply included) and the RPi 3 (J1).

a. Switch the power switch (SW3) to turn on the CX20921 evaluation board.

b. LED D6 (5VLED) will turn on when there is power on the board.

* Proper speaker selection will enhance overall performance. Please download "External Loudspeaker Guidelines and Recommendation for Smart Speaker Applications" document for additional info.



Figure 4: CX20921 Eval Board Setup with RPi 3 board and Mic Board (with 2-mic Attached)

Figure 5: Connections for CX20921 Eval Board and Mic Board (with 2-mic Attached)



Figure 6: Connections for the RPi 3

Table 1: CX20921 to RPi 3 Connections

Signal RPi 3 CX20921 Evaluation BoardGPIO (indicating trigger detected in CX20921) J8. Pin 13 (GPIO_GEN2) GPIO1, P2.pin14

Ground J8. Pin 14 (Ground) GND, P2.pin15

Audio signal from RPi 3 3.5mm audio jack (J7) LINEIN (J25)

Processed microphone signal from CX20921 evaluation board

USB port Micro USB (J1)


CX20921 User Guide AVS Setup

AVS SetupPrior to completing the steps described in this section, the following tasks should be completed:

– Raspbian OS loaded onto the microSD card– HDMI monitor, keyboard, and mouse are connected– LAN or WiFi connection has been established– Hardware setup complete

1. Send the following command to clone the repository from the Conexant GitHub:

git clone https://github.com/conexant/alexa-avs-sample-app.git

2. Refer to the following instructions to create a developer account with Amazon:

https://github.com/alexa/alexa-avs-sample-app/wiki/Raspberry-Pi#lets-get-started

Before starting AVS installation, the automated_install.sh will require several parameters to be changed. The following credentials will need to be copied from the developer account (developer.amazon.com)

Note: These parameters can be found under Alexa -> Alexa Voice Service -> Edit, on the developer.amazon.com site. The Device Type ID can be found in the Device Type Info and the Client ID and Client Secret can be found in the Security Profile tab. A representative example is shown below.

3. Save the file. Then give the necessary file permissions and run the process with the following command:

cd alexa-avs-sample-appchmod +x automated_install.sh. automated_install.sh

After the installer is started, several screens will display. Follow the screen instructions shown below to download the AVS sample app.


https://github.com/alexa/alexa-avs-sample-app/wiki/Raspberry-Pi#lets-get-started


This requires agreeing to the terms and conditions as shown in the following screen:

4. Type y and press Enter. The following screen enables you to validate your Amazon developer status.

5. Type y and press Enter. The following screen enables you to set up your RPi 3 credentials, enter your ProductID, ClientID, and ClientSecret.



6. Type y and press Enter. The following screen enables you to set up your locale based on language and country. For example, en (English)-US (USA), en (English)-GB (Great Britain). Locales are a framework to switch between multiple languages and allow users to use their language, country, characters, collation order, etc.

7. Type 1, 2, or 3 depending on your language and locale, and press Enter. The following screen enables you to select the method of audio output you are using.



8. For audio output, select option 1. The 3.5mm jack from the RPi 3 feeds into the CX20921 board for playback out of the LineOut speakers.

9. Type y and press Enter. The following screen enables you to enable Alexa Wake Word Detection.

This starts the installation process. The installer should take approximately one hour to complete.


CX20921 User Guide Running Node.js Service, Sample App, Wake Word Engine, & Recording Agent

Running Node.js Service, Sample App, Wake Word Engine, & Recording AgentOnce the installation is complete, you are ready to try out the Synaptics AudioSmart 2-Mic Development Kit for Amazon AVS.

• On the home directory, run the 2Mic_startup.sh script to open all necessary windows at once.

./2Mic_startup.sh

Alternatively, these windows can be opened manually. See the following for more information.

Note: It is recommended that these commands be run in the following order.

• Terminal Window 1: to run the web service for authorization.• Terminal Window 2: to run the sample app to communicate with AVS.• Terminal Window 3: to run the wake word engine which allows you to start an interaction using the

phrase Alexa.• Terminal Window 4: to run the recordingAgent, which sends audio content continuously to the client.

Terminal Window 1Open a new terminal window and type the following commands to bring up the web service which is used to authorize your sample app with AVS:

cd ~/alexa-avs-sample-app/samples/companionService && npm start

The server is now running on port 3000 and you are ready to start the client.

Terminal Window 2Open a new terminal window and type the following commands to run the sample app, which communicates with AVS:

cd ~/alexa-avs-sample-app/samples/javaclient && mvn exec:exec

See "AVS Setup: Amazon Account Login" on page 15 for more information.

Terminal Window 3Note: Skip this step to run the same app without a wake word engine.

1. Configure the .asoundrc file with the correct settings.

Note: This step is necessary to ensure correct audio playback.

cp ~/leftarc_2Mic ~/.asoundrc

This project supports two versions of Sensory's TrulyHandsFree wake word engine. The `-e` option is used to select the low-power embedded wake word engine running on the Synaptics development kit or the high-performance wake word engine running on the RPi 3.

2. Open a new terminal window and use the following commands to bring up the wake word engine from Sensory. The wake word engine will allow you to initiate interactions using the phrase Alexa.

3. If the objective is to run the embedded low-power sensory wake word engine, type:

cd ~/alexa-avs-sample-app/samples/wakeWordAgent/src


CX20921 User Guide Terminal Window 4

sudo ./wakeWordAgent -e gpio

Note: For the low-power Sensory wake word engine, the wake word agent must be run as admin.

4. If the objective is to run the high-performance sensory wake word engine (on the RPi 3), type:cd ~/alexa-avs-sample-app/samples/wakeWordAgent/src && ./wakeWordAgent -e sensory

Note: To switch trigger modes, first kill the currently running process. For more detailed information, see "Changing Trigger Modes" on page 19.

Terminal Window 4Open a new terminal window and type the following command to run the recordingAgent, which sends the processed microphone signals to the javaclient:

cd ~/alexa-avs-sample-app/samples/recordingAgent && ./run.sh

You now have a working hands-free AVS prototype.


CX20921 User Guide AVS Setup: Amazon Account Login

AVS Setup: Amazon Account LoginAn Amazon account will need to be connected to use the Synaptics AudioSmart 2-Mic Development Kit for Amazon AVS. A monitor, keyboard, and mouse is required for this procedure.

1. Using the HDMI and USB ports on the RPi, connect the RPi to the monitor, keyboard, and mouse.

2. After the RPi boots up and the startup.sh is run, the following window will popup. Note that the 'Bearer Token' is empty.

Figure 7: Alexa Voice Service User Interface

3. Click Yes and open a web browser. Go to the copied URL.

If a warning page appears, click Advanced and then click Proceed to Localhost (unsafe). The following shows representative screens.



4. The URL will go to a page to sign in using an Amazon account. Login with your Amazon account credentials.

5. The next page should display the message 'device tokens ready' as shown below. The web browser can now be closed.



6. Click OK in the following window.

Now, the 'Bearer Token' field from Step 2 should be filled. The Amazon account is set up and the demo unit is ready to be used.


CX20921 User Guide Changing Trigger Modes

Changing Trigger ModesTo test and verify different trigger modes, follow the instructions below.

1. Before switching the trigger mode, kill the process running the current trigger mode by using Ctrl + C in the terminal running the wakeWordAgent.

a. To confirm the process is successfully ended, open a terminal and send:top

b. If a process called wakeWordAgent is not displayed, then the process is killed.

Note: Each time the trigger mode is changed, the previous processes must be killed. If the terminal windows are closed before the process is killed, it is necessary to find the PID of the process and kill the process.

2. Find the PID of the process with the following command:top

3. The process to kill is called wakeWordAgent. This process can be killed using the following command, and using the PID number found above.sudo kill [PID#]

Example: Killing a process

1. Open a terminal and send the following commandtop

2. Note the PID of the process called wakeWordAgent. This is required for the next step.

3. Send the following command:sudo kill [PID#]


CX20921 User Guide Verifying the Setup

4. For this example, send the following command:

After the command is sent, the wakeWordAgent process is eliminated from the top window and shown below:

Verifying the SetupTo verify whether the setup is done properly, please say Alexa followed by a question or command.

• A green LED will light up if Alexa wake word is heard. This confirms that CX29021 evaluation board is working properly. – If the green LED does not light up when speaking less than 1m away, please check power

connection. • A voice feedback can be heard if the development kit is successfully connected to AVS network.

– If there is no voice feedback, please check whether speaker is powered on and all cables are connected properly between the evaluation board and RPi 3.

To learn more about Amazon Alexa Voice Service and access the AVS API reference guide, see the following link: https://developer.amazon.com/alexa-voice-service/.

Amazon, Alexa, and all related logos are trademarks of Amazon.com, Inc. or its affiliates


https://developer.amazon.com/alexa-voice-service/

CX20921 User Guide Installing the Cypress Siena USB-to-I2C Device Driver

Installing the Cypress Siena USB-to-I2C Device DriverA driver must be installed to enable the onboard Cypress Siena USB-to-I2C device. Once enabled, this device will allow the user to communicate with the CX20921 evaluation board over I2C. This is necessary to flash firmware.

1. Connect the Type A to Type B USB cable between your laptop and the CX20921 evaluation board to connector J2.

a. This cable will interface to a Cypress USB-to-I2C control device, allowing you to control parameters of the CX20921 evaluation board using a Conexant GUI.

b. This cable can also be used to flash new Firmware to the CX20921 evaluation board if needed (see "Flashing New Firmware" on page 23).

2. The Cypress Siena driver that enables USB-I2C communication between your laptop and the CX20921 evaluation board can be downloaded from:

http://www.conexant.com/avs-support/Conexant_Siena_Driver.rar

a. Filename: Conexant_Siena_Driver.rar

b. Extract the Conexant_Siena_Driver.rar file onto your laptop.

3. Run the Setup.exe file included in the Conexant_Siena_Driver folder as shown below:


http://www.conexant.com/avs-support/Conexant_Siena_Driver.rar

CX20921 User Guide Installing the Cypress Siena USB-to-I2C Device Driver

4. When the following message appears. Click Yes.

In the Device Manager, you should shortly see Conexant Siena USB Driver appear under Universal Serial Bus Controllers.

The Cypress Siena device is now ready to use.


CX20921 User Guide Flashing New Firmware

Flashing New FirmwareThe CX20921 evaluation board comes pre-flashed with firmware (FW). The following instructions are only needed if a new FW version needs to be loaded.

1. Connect the standard USB cable to allow Cypress Siena USB-I2C control if not done already.

2. Firmware flashing on the CX20921 device is done from the laptop/PC through the onboard Cypress Siena CY7C68013A I2C-to-USB converter device going to the CX20921 and the SPI flash device.

a. FW update system flow: Laptop/PC>Cypress CY7C68013A>CX20921>SPI Flash.

b. A driver is required to use the Cypress Siena CY7C68013A device, so make sure you have previously installed the Cypress Siena CX7C68013A driver as described in "Installing the Cypress Siena USB-to-I2C Device Driver" on page 21.

The FW release package is stored in a folder named fcp. This folder contains a number of subfolders as shown below.

Figure 8: Example FCP Folder


CX20921 User Guide Flashing New Firmware

3. Open the build folder which contains the *.sfs FW image file.

Figure 9: Build Folder Contents

4. Double click on the i2c_flash.exe file. FW updating will begin, and the following window will appear.

Wait for the green PASS message to appear, indicating that the FW was updated successfully. The FW upgrade should take less than 30 ms to complete.

5. Once the successful PASS message appears, close the window and cycle power on the board by unplugging and plugging back the power on the CX20921 evaluation board. The CX20921 device is ready to be used with the new updated FW.


CX20921 User Guide Troubleshooting

TroubleshootingIf you encounter any issues with the AVS Sample App, see the following link to the list of solutions to some common problems reported by AVS developers.

https://github.com/conexant/alexa-avs-sample-app/wiki/Troubleshooting

TrademarksSynaptics, the Synaptics logo, and AudioSmart, are trademarks or registered trademarks of Synaptics Incorporated or its affiliates in the United States and/or other countries.

NoticeSynaptics, the Synaptics logo, and AudioSmart, are trademarks or registered trademarks of Synaptics Incorporated or its affiliates in the United States and/or other countries.

Use of the materials may require a license of intellectual property from a third party or from Synaptics. This document conveys no express or implied licenses to any intellectual property rights belonging to Synaptics or any other party. Synaptics may, from time to time and at its sole option, update the information contained in this document without notice.

INFORMATION CONTAINED IN THIS DOCUMENT IS PROVIDED "AS-IS," WITH NO EXPRESS OR IMPLIED WARRANTIES, INCLUDING ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, AND ANY WARRANTIES OF NON-INFRINGEMENT OF ANY INTELLECTUAL PROPERTY RIGHTS. IN NO EVENT SHALL SYNAPTICS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, PUNITIVE, OR CONSEQUENTIAL DAMAGES ARISING OUT OF OR IN CONNECTION WITH THE USE OF THE INFORMATION CONTAINED IN THIS DOCUMENT, HOWEVER CAUSED AND BASED ON ANY THEORY OF LIABILITY, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, AND EVEN IF SYNAPTICS WAS ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. IF A TRIBUNAL OF COMPETENT JURISDICTION DOES NOT PERMIT THE DISCLAIMER OF DIRECT DAMAGES OR ANY OTHER DAMAGES, SYNAPTICS' TOTAL CUMULATIVE LIABILITY TO ANY PARTY SHALL NOT EXCEED ONE HUNDRED U.S. DOLLARS.


https://github.com/conexant/alexa-avs-sample-app/wiki/Troubleshooting

synaptics audiosmart 2-mic development kit for · pdf filenotice ... // ... the synaptics...

Documents