Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
1. Register at Amazon
First you need to obtain a set of credentials from Amazon to use the Alexa Voice service. Make a note of these credentials as you will be asked for them during the install process. Make sure to record your Product ID, Security Profile description, Security Profile ID, Client ID, and Client Secret for the device.
Login at https://developer.amazon.com and go to
Your Alexa Consoles(top right) then
You are at
- For the
Product nameuse something like AlexaPi or whatever you want.
Descriptionenter whatever you want
- All other fields can be filled out how you plan to use your AlexaPi
- For the
You are at
Create New Profile.
- Choose whatever for
Security Profile Nameand
Security Profile Description. Hit
Allowed Origins- put there
Allowed Return URLsput
https://ALEXA.DEVICE.IP.ADDRESS:5050/code. You have to replace
ALEXA.DEVICE.IP.ADDRESSwith the IP (for example 192.168.1.123) of your AlexaPi device (for example Raspberry Pi). This is especially necessary when you are installing from another computer than AlexaPi is gonna run on.
You should now be at the devices page
Managebeside your new device
Capabilitiesand then enable:
Named Timers and Reminders
Display Cards with Text
2. Install AlexaPi
NOTE: For Windows, continue at https://github.com/EmerickH/EmerickH/blob/master/AlexaPi-wiki.md#windows
Boot your PC and login to a command prompt.
Make sure you are in
Make sure you have git installed
sudo apt-get install git # For Debian OSs (Debian, Raspbian, OSMC, OpenElec...) sudo pacman -Sy git # For Arch Linux
Clone this repo
sudo git clone https://github.com/alexa-pi/AlexaPi.git
NOTE: You can also clone the repository to any other directory (and lose the
sudohere, if you have permission to write to that directory), but you won't be able to run AlexaPi on boot with our init scripts. It is therefore recommended for advanced users (who know what they're doing) only.
Run the setup script
NOTE: When asked for Device Type ID, use your Product ID
3. Post-installation steps
Now that you have installed AlexaPi there's a couple of things you need to do.
DO NOT REPORT AN ISSUE UNLESS YOU HAVE READ THIS THOROUGHLY!
Reboot your machine or start AlexaPi with
sudo systemctl start AlexaPi.service
Check the status of AlexaPi with
sudo systemctl status AlexaPi.service
If it is not running, be sure to see the full logs.
In a lot of cases, you have to setup your input / output devices properly in the configuration file. Read the Audio setup & debugging section in the documentation.
If you have a desktop OS (such as default Raspbian), you have to set up system-wide PulseAudio. You usually get dbus and pulseaudio error in the log if you don't do this.
If you got this working, but audio playback is choppy, try changing the playback handler in the config from vlc to sox. This will be default in later versions of AlexaPi. If you're using pulseaudio, please read audio setup guide.
READ THE WHOLE DOCUMENTATION BEFORE ASKING.