Amazon’s nifty little AI-powered voice-assistant, Alexa, that can process contextual queries in human voice has taken the world by storm. It’s been barely two years since Amazon launched its powerful voice service, and the company has already sold 5 million devices, and positioned itself as the ultimate home automation gadget.
The primary reason behind the widespread popularity of AVS (Amazon Voice Service) is the powerful platform that it provides to collaborators for developing interactive voice apps. Perhaps, that’s the reason why Amazon’s Alexa conquered CES 2017, and how from Ford to Martian, from LG to Whirlpool, nearly every conceptual design had in-built Alexa integration.
As you can now control a wide array of home automation devices using just your voice, it makes sense for every smart home enthusiast to buy Alexa. However, I’m a big-time DIY person, and I thought it would be really exciting to see if it’s possible to install Alexa on my Raspberry Pi.
While I expected the setup to be a complicated process, it turned out that the setup was fairly straightforward, In fact, I was able to complete the whole setup in less than an hour. It also cost significantly lesser than Echo (almost nothing), as I hooked up peripherals that I already had at my workplace.
In this article, I’m going to walk you through how you can turn your Raspberry Pi into Amazon Echo. The setup requires a fair bit of technical expertise, since you’ll be running commands on Linux terminal and editing shell scripts on Raspberry Pi.
However, by the end of the guide, you will have a fully functional Amazon Echo device that can respond to your voice commands and take actions. You’ll be able to do unit conversions, check weather, get sport updates, listen to podcasts and tons of other things.
But that’s not even the best part.
Once you’re through the entire setup, you’ll be able to alter Alexa’s settings through your iPhone or Android device, just like you’ll be able to do that on a real Echo. That means you will be able to create smart skills that allow you to control connected devices, like LIFX or Nest Thermostat, with your voice. If that’s not enough, you will even be able to call a cab, order a pizza or know what’s the next item on your to-do list just by asking Alexa.
Here’s how the end setup looks like….
(Note: The PlayStation Eye camera is used for capturing the voice.)
For the project, I used all the components that I could find lying around my desk. Of course, you could get a good quality microphone, instead of a PlayStation Eye camera. I’ve connected my portable speaker through 3.5 mm port (you could use a better one!), and I’m using wireless bluetooth keyboard and mouse to program my Pi.
The whole setup cost me less than $59 (Raspberry Pi Model 3: $39 + Portable Speaker: $8 + PlayStation Eye Camera: $7). I’ve not included the cost of wireless mouse and keyboard, as you don’t require them to send voice commands (they are needed just for programming Pi).
Here’s all the stuff you’ll need for the project:
- Raspberry Pi 3 (recommended) or any older version of Raspberry Pi. You can even use Raspberry Pi Zero, but you’ll need to buy an additional USB Wi-Fi adapter, for older models of Pi.
- 8 GB SD Card with Raspbian (Jessie) installed
- Micro-USB cable (for powering Pi)
- 3.5 mm Bluetooth or plugged-in speaker (for hearing Alexa’s voice)
- An USB microphone for sending voice commands. However, for this demo, I have used the cheap $8 PlayStation Eye Camera, as it was laying around my desk.
- Keyboard, display and mouse (for running the setup)
How to Turn Your Raspberry Pi into Amazon Echo
Step 1: Setup your Raspberry Pi
The first step is to connect setup your Raspberry Pi and get it up and running. In case you haven’t already installed Raspbian on your Pi, you can go ahead and download the latest version, here. Once you have downloaded the image file, the next step is to burn the image file on your SD card. Here’s the guide you can follow to successfully create a bootable SD card with Raspbian installed.
After installing Raspbian, the next step is to connect your keyboard and mouse with Raspberry Pi. If you’re using a USB keyboard/mouse, it should be a fairly straight-forward process. However, if you’re using a wireless bluetooth mouse/keyboard set, you’ll need to pair that up with Raspberry Pi. Again, if you’re using Model 3, you don’t need to buy an external bluetooth dongle, but in case you’re using older versions, you may need to get a compatible Bluetooth adapter to get things going. Lastly, you’ll need to connect your Pi to a HDMI display, so that you’re able to see the output.
[Tip: In case you don’t want to spend money on buying an external display, mouse or keyboard, you can even connect to your Raspberry Pi using VNC (Virtual Network Computing). Here’s a guide on how to setup VNC on your Pi. ]
Once you have your Pi up and running, the next step is to configure the speakers and microphone. For that, connect your portable speaker to the 3.5 mm jack on your Raspberry Pi, and select “Analog” by right-clicking on the speaker menu on the top-right corner.
Next, connect your microphone (in my case– camera) to USB port of your Raspberry Pi, and run the following command on Terminal: alsamixer. You’ll be able to see a similar screen. Adjust the volume and sensitivity of your microphone, using arrow keys. Once you’re done, run the command sudo alsactl store to save the changed configurations.
Next, run the following
sudo nano /usr/share/alsa/alsa.conf on Pi’s Terminal. It will open up an Editor window. Navigate below to the line that reads:
defaults.ctl.card 0 defaults.pcm.card 0
Change the above line to:
defaults.ctl.card 1 defaults.pcm.card 1
The above command should successfully set your speaker (connected via line-in) and microphone (connected via USB) as default.
Step 2: Register for Amazon Developer Account
Before proceeding with the installation, you’ll need to register for a free Amazon Developer Account, so that you can link your DIY Echo with Alexa Voice Service (AVS). Once you have registered, you should be able to login and see a similar dashboard:
- Once you’re on the dashboard, click on Alexa in the navigation menu. It’ll give you two options– Alexa Skills Set and Alexa Voice Service. Click on “Alexa Voice Service”.
- Click on “Register a Product Type”. It will ask whether you wish to register a device or an application. Click on Device.
- After that, you’ll be asked to give your device a Type ID and Name. You can give it any name. For the example, we chose to name it Raspberry Pi.
- Next, you’ll be asked whether you wish to create a new security profile. Click Next.
- Make a note of your Client ID and Client Secret key from the below screen. You don’t need to make a note of the Security Profile ID.
- Click on the “Web Settings” in the adjacent tab and once you’re on the tab, click on the “Edit” button on top-right. After you click on “Edit”, you’ll be able to add “Allowed Origins” and “Allowed Return URLs” for the the security profile.
Click on “Add Another”, next to Allowed Origins, and type in: https://localhost:3000 Click on “Add Another”, next to Allowed Return URLs, and type in:https://localhost:3000/authresponse. Once you’re done, click on “Next”.
- Once you’re through that, you’ll be on the “Device Details” screen. It really doesn’t matter what you enter, here. So, pick an image for your device, choose a category, type in the description, set the expected timeline, enter the number of devices you wish to commercialize, and select “No” for children product. Click on “Next” when you’re done.
- In the final step, you’ll be asked to add Amazon Music to the setup. However, the service does not really work on Raspberry Pi as of now, so click on “No” to finish the setup.
Step 3: Install Alexa on Your Raspberry Pi
Now that you have a working Amazon Developer account and profile for an Alexa-powered device, it’s time to go ahead and install the voice service on your Raspberry Pi.
- Open the Terminal on your Raspberry Pi and type: cd Desktop.
- Type in
git clonehttps://github.com/alexa/alexa-avs-sample-app.git and hit Enter. The command will fetch the code files from Amazon’s repository and download them on your Desktop.
- Once that’s done, type
cd ~/Desktop/alexa-avs-sample-appand hit Enter.
- Type in
nano automated_install.shand press Enter.
- It will pull up a text editor, that will look something like this: Enter the ProductID (the Type ID that you gave for the device in the first step), ClientID and ClientSecret (the keys from the security profile). You can use the arrow keys to navigate through the editor. Once you’re done, Type Ctrl + X to save and exit.
- It should bring you back to the terminal window. Type in . automated_install.sh and hit Enter.
- It should open up a prompt window, where you will be asked questions on the type of installation. Type “Y” for each question (the default configuration), or you may even choose to answer them as you wish. Once you’ve answered all the questions, grab a cup of coffee, and leave the computer alone. The setup will take at least 30-45 minutes to complete.
- In the end, if you can see that the log trace reads, something like this:Congratulations! You have successfully installed Alexa on your Raspberry Pi. But wait, the setup has not yet finished. You need to now run the companion service, followed by triggering the client and wake service.
Step 4: Run Alexa Companion Service
Just like every application needs a server to communicate with, you need to first setup Alexa Companion service. The companion service acts as a gateway between Amazon’s servers and your personalized Echo device.
You can start the companion service by typing in the following command:
cd ~/Desktop/alexa-avs-sample-app/samples/companionService && npm start
It should start the companion service, and you should be able to see the message, which will read something like this: “Listening on Port 3000”
That means, you have successfully started the companion service, and it’s now listening to incoming requests. Leave the window open [WARNING: Do not close the window, as we want the server to be running, when we start our client service.], and proceed further.
Step 5: Run the sample app and authenticate your account
The next step is to start the client service, which can send requests to your companion service. In order to do that, open second Terminal window (File > New Window), and type in the following command:
cd ~/Desktop/alexa-avs-sample-app/samples/javaclient && mvn exec:exec
When you enter the command, a dialog box will pop up, asking you to authenticate your device. Click on Yes. It should open a browser window [Tip: In case the window does not appear, copy the link in the dialog box and open it in the browser]. In the meanwhile, a second popup will open in the Java app, asking you to click “Ok”, if you have already signed into Amazon. DO NOT click on “Ok”, yet.
First, login into your Amazon account, and click on “Allow” when AVS asks for your permission. If the setup goes right and you have entered the right credentials (ProductID, ClientID and ClientSecret key), you’ll be able to see the following screen, which reads “device tokens ready”:
Once you see the above screen, close the browser and click on the “Ok” pop-up box in the Java app. Now, your Raspberry Pi has the necessary tokens to communicate with Amazon’s server and process your voice commands. You can test that by manually pressing the Listen button on the client application and saying “Hi” to Alexa.
But, wait, that’s not how Alexa works. Shouldn’t you be able to call her from anywhere? Well, there’s one final step left to get there ….
Step 6: Trigger the wake word agent
Now that we have the client and server running, we need to create a daemon service that actively listens to user commands and triggers the client service, when they call for “Alexa”.
The wake word agent is already installed on your Raspberry Pi, as part of the initial setup, so you just need to invoke it. There are two options for wake word software, Sensory and KITT.AI. While both of them are available for free, Sensory expires after 90 days.
But, since we are running the setup for experimental purpose, let’s use Sensory. Open a new terminal window and type in the following command:
cd ~/Desktop/alexa-avs-sample-app/samples/wakeWordAgent/src && ./wakeWordAgent -e sensory
That’s it. Once you enter the above command, the wake word engine will start running, You can go ahead and try it out by saying “Alexa”. You should be able to hear a beep, indicating that it’s listening to your question. Try asking her something, like, “How’s the weather?”, “What’s in the news?”, or even “How far is Mars from Earth?”
If you get a response, congratulations! You’ve successfully turned your Raspberry Pi into Amazon Echo– the world’s smartest voice-assistant.
It happens to the best of us. Sometimes, you just end up getting stuck at an error, and have no idea where to go. But here are some of the most common errors and workarounds for setting up Alexa voice service for your Raspberry Pi:
Error page on authentication
If you’re getting an authentication error when you try to give permissions to your client from the browser, it’s likely that you have entered the wrong combination of Product ID, ClientID and ClientSecret. Double check it with what you have on your AVS account. Make sure your Product ID is the Device ID for your Raspberry Pi and NOT your Security Profile ID.
Build failure on mvn exec:exec
If you’re getting build failure error when you execute mvn exec:exec for your client application, it’s possible that not all dependencies listed in the POM file have been downloaded on your machine. The obvious reason for this is that your setup skipped downloading some files (Network error?), or you’re trying to install the service on Ubuntu or any other version of Linux (that is currently not supported).
The error usually occurs, when you send a voice command to Alexa, but it takes too long to complete. It’s mostly a network issue, and the best trick, which has worked for most people, is to just restart Pi, network or Alexa client. It’s really not a setup issue, but a communication problem with the sever. For more information, visit the following thread.
Unable to find definition ‘cards.bcm2835.pcm.surround51.0:CARD=0’
The error occurs when you’ve improperly configured your microphone or sound card. Depending on the device that you’re using, you might need to set it up with your Raspberry Pi. Read the following thread for more information.
Make sure AVS client is running
The above error occurs, if you accidentally closed your client or server window, while triggering the wake agent service. Make sure that you have three terminal windows open while you’re running the setup.
Taking it Forward
As part of the tutorial, we have provided the boilerplate code for turning your Raspberry Pi into Amazon Echo. If you’re interested in taking the project a step further, you can go ahead and make the set up a little more sophisticated.
To give you some ideas, you can write a bash script that automatically runs the Alexa service every time your Raspberry Pi starts up, so that you don’t have to manually run commands on Terminal every time.
Further, you can even go ahead and try to integrate the iOS or Android companion app with AVS, so that you can run customized skills and see how third-party integrations work on the platform.
Did it work out for you?
Stuck? Having fun? Built something awesome? I’m excited to know how was your experience turning your Raspberry Pi into Amazon Echo (Alexa). Please feel free to share your comments, feedback or suggestions in the comments section below.