Track Parcels Using Google Assistant SDK on Pi

GassistPi -- Google Assistant for all Raspberry Pi Boards

Features:

1. Headless auto start on boot with multiple custom wakeword activation triggers. 2. Voice control of GPIOs without IFTTT, api.ai, Actions SDK. 3. Voice control of NodeMCU without IFTTT and MQTT. 4. Radio streaming. 5. Voice control of servo connected to RPi GPIO. 6. Safe shutdown RPi using voice command. 7. Stream Music from YouTube. 8. Indicator lights for assistant listening and speaking events. 9. Startup audio and audio feedback for wakeword detection. 10. Pushbutton service to stop Music or Radio playback. 11. Parcel tracking using Aftership API. 12. RSS Feed streaming.

Existing Python3 GassistPi users, update the project using the script: https://github.com/shivasiddharth/GassistPi/blob/update-script/GassistPi-01-Dec-2017-update.sh New users, folow the instructions in this document.

CLI or Raspbian Lite does not support all features and Custom wakeword does not work with Google's AIY image. So please use the Standard Raspbian Desktop image- Link https://www.raspberrypi.org/downloads/raspbian/

FIRST STEP- CLONE the PROJECT on to Pi

Open the terminal and execute the following:

git clone https://github.com/shivasiddharth/GassistPi

INSTALL AUDIO CONFIG FILES

Update OS and Kernel

sudo apt-get update  
sudo apt-get install raspberrypi-kernel  
sudo reboot

Choose the audio configuration according to your setup. The speaker-test command is used to initialize alsa, so please do not skip that. AIY-HAT and CUSTOM-HAT users, please reboot the Pi at places mentioned, else it will lead to audio and taskbar issues.

USB DAC or USB Sound CARD users,

sudo chmod +x /home/pi/GassistPi/audio-drivers/USB-DAC/scripts/install-usb-dac.sh  
sudo /home/pi/GassistPi/audio-drivers/USB-DAC/scripts/install-usb-dac.sh 
speaker-test  

AIY-HAT users,

sudo chmod +x /home/pi/GassistPi/audio-drivers/AIY-HAT/scripts/configure-driver.sh  
sudo /home/pi/GassistPi/audio-drivers/AIY-HAT/scripts/configure-driver.sh  
sudo reboot  
sudo chmod +x /home/pi/GassistPi/audio-drivers/AIY-HAT/scripts/install-alsa-config.sh 
sudo /home/pi/GassistPi/audio-drivers/AIY-HAT/scripts/install-alsa-config.sh  
speaker-test  

USB MIC AND HDMI users,

sudo chmod +x /home/pi/GassistPi/audio-drivers/USB-MIC-HDMI/scripts/install-usb-mic-hdmi.sh  
sudo /home/pi/GassistPi/audio-drivers/USB-MIC-HDMI/scripts/install-usb-mic-hdmi.sh  
speaker-test  

USB MIC AND AUDIO JACK users,

sudo chmod +x /home/pi/GassistPi/audio-drivers/USB-MIC-JACK/scripts/usb-mic-onboard-jack.sh  
sudo /home/pi/GassistPi/audio-drivers/USB-MIC-JACK/scripts/usb-mic-onboard-jack.sh  
speaker-test  

CUSTOM VOICE HAT users,

sudo chmod +x /home/pi/GassistPi/audio-drivers/CUSTOM-VOICE-HAT/scripts/install-i2s.sh
sudo /home/pi/GassistPi/audio-drivers/CUSTOM-VOICE-HAT/scripts/install-i2s.sh 
sudo reboot 
sudo chmod +x /home/pi/GassistPi/audio-drivers/CUSTOM-VOICE-HAT/scripts/custom-voice-hat.sh  
sudo /home/pi/GassistPi/audio-drivers/CUSTOM-VOICE-HAT/scripts/custom-voice-hat.sh  
speaker-test   

Those Using HDMI/Onboard Jack, make sure to force the audio

sudo raspi-config  

Select advanced options, then audio and choose to force audio

Those using any other DACs or HATs install the cards as per the manufacturer's guide and then you can try using the USB-DAC config file after changing the hardware ids

• Restart Pi

• Check the speaker using the following command

speaker-test -t wav  

CONTINUE after SETTING UP AUDIO

• Download credentials--->.json file (refer to this doc for creating credentials https://developers.google.com/assistant/sdk/develop/python/config-dev-project-and-account)

• Place the .json file in/home/pi directory DO NOT RENAME

• Use the one-line installer for installing Google Assistant Pi3 and Armv7 users use the "gassist-installer-pi3.sh" installer and Pi Zero, Pi A and Pi 1 B+ users use the "gassist-installer-pi-zero.sh" installer. 4.1 Make the installers Executable

sudo chmod +x /home/pi/GassistPi/scripts/gassist-installer-pi3.sh 
sudo chmod +x /home/pi/GassistPi/scripts/gassist-installer-pi-zero.sh  

4.2 Execute the installers Pi3 and Armv7 users use the "gassist-installer-pi3.sh" installer and Pi Zero, Pi A and Pi 1 B+ users use the "gassist-installer-pi-zero.sh" installer. When Prompted, enter your Google Cloud console Project-Id, A name for your Assistant and the Full Name of your credentials file, including the json extension.

sudo  /home/pi/GassistPi/scripts/gassist-installer-pi3.sh   
sudo  /home/pi/GassistPi/scripts/gassist-installer-pi-zero.sh  

• Copy the google assistant authentication link from terminal and authorize using your google account

• Copy the authorization code from browser onto the terminal and press enter

• After successful authentication, the Google Assistant Demo test will automatically start. At the start, the volume might be low, the assistant volume is independent of the Pi volume, so increase the volume by using "Volume Up" command.

• After verifying the working of assistant, close and exit the terminal

HEADLESS AUTOSTART on BOOT SERVICE SETUP

• Open the service files in the /home/pi/GassistPi/systemd/ directory and add your project and model ids in the indicated places and save the file.

• Make the service installer executable

sudo chmod +x /home/pi/GassistPi/scripts/service-installer.sh

• Run the service installer

sudo /home/pi/GassistPi/scripts/service-installer.sh   

• Enable the services - Pi3 and Armv7 users, enable the "gassistpi-ok-ggogle.service" and Pi Zero, Pi A and Pi 1 B+ users, enable "gassistpi-push-button.service" To stop music playback using a pushbutton connected to GPIO 23 enable stopbutton.service

sudo systemctl enable gassistpi-ok-google.service  
sudo systemctl enable gassistpi-push-button.service
sudo systemctl enable stopbutton.service  

• Start the service - Pi3 and Armv7 users, start the "gassistpi-ok-ggogle.service" and Pi Zero, Pi A and Pi 1 B+ users, start "gassistpi-push-button.service" To stop music playback using a pushbutton connected to GPIO 23 start stopbutton.service

sudo systemctl start gassistpi-ok-google.service  
sudo systemctl start gassistpi-push-button.service
sudo systemctl start stopbutton.service  

RESTART and ENJOY

INDICATORS for GOOGLE ASSISTANT'S LISTENING AND SPEAKING EVENTS

Connect LEDs with colours of your choice to GPIO05 for Listening and GPIO06 for Speaking Events.

PUSHBUTTON TO STOP MUSIC/RADIO PLAYBACK

Connect a pushbutton between GPIO23 and Ground. Using this pushbutton, now you can stop the music or radio playback.

VOICE CONTROL of GPIOs, SERVO and Pi SHUTDOWN

The default GPIO and shutdown trigger word is trigger. It should be used for controlling the GPIOs, servo and for safe shutdown of Pi.

It has been intentionally included to prevent control actions due to false positive commands. If you wish to change the trigger word, you can replace the 'trigger'in the main.py and assistant.py code with your desired trigger word.

The default keyword for servo motor is servo. For example, the command trigger servo 90 will rotate the servo by 90 degrees.

If you wish to change the keyword, you can replace the 'servo' in the action.py script with your desired keyword for the motor.

For safe shutdown of the pi, command is: trigger shutdown

You can define your own custom actions in the actions.py script. THE ACTIONS SCRIPT OF THIS PROJECT IS DIFFERENT FROM AIY KIT's SCRIPT, COPY PASTING THE COMMANDS FROM AIY's ACTION SCRIPT WILL NOT WORK HERE. FOR A BETTER UNDERSTANDING OF THE ACTIONS FILE, FOLLOW THE FOLLOWING YOUTUBE VIDEO.

VOICE CONTROL of NodeMCU

Download the Arduino IDE code for Nodemcu from here: https://github.com/shivasiddharth/iotwemos/blob/master/Google-Home-NodeMCU.ino

Add the wifi credentials, make the desired changes and upload the Arduino code onto the NodeMCU and get the IP address from the serial monitor.

Add the NodeMCU's IP address in the actions.py file.

FOR GUIDELINES ON MODIFYING THE ARDUINO CODE AND ACTIONS.PY FILE, FOLLOW THE FOLLOWING YOUTUBE VIDEO.

MUSIC STREAMING from YOUTUBE

Default keyword for playing music from YouTube is Play. For example, Play I got you command will fetch Bebe Rexha's I Got You from YouTube.

Music streaming has been enabled for both OK-Google and Custom hotwords/wakewords.

Due to the Pi Zero's limitations, users are advised to not use the Music streaming feature. Music streaming will send the CPU usage of Pi Zero into the orbit.

RADIO STREAMING

Default keyword for streaming radio is tune into. For example, tune into Radio 2 command will open the corresponding radio stream listed in the actions.py file.

Radio streaming has been enabled for both OK-Google and Custom hotwords/wakewords.

Useful links for obtaining radio streaming links: http://www.radiosure.com/stations/

http://www.live-radio.net/worldwide.shtml

http://worldradiomap.com/map/

Due to the Pi Zero's limitations, users are advised to not use the Radio streaming feature. Radio streaming will send the CPU usage of Pi Zero into next galaxy.

FOR PARCEL TRACKING

The default keyword for tracking parcel is parcel. For example, you can say where is my parcel or track my parcel.

Regsiter for a free account with Aftership at https://www.aftership.com gnereate an API number and add parcels to the tracking list. The generated API number should be added to the actions.py script at the indicated location. For a better understanding follow the attached youtube video.

FOR RSS FEEDS

Default keywords for playing RSS feeds is feed or news or quote. Example usage, top tech news will play the top technology news, top world news will play top news related to different countires, top sports news will play the top sports related news and quote of the day will give some quotes.

Do not mix the commands with Play as that has been associated with music streaming from YouTube.

numfeeds variable within the feed function in actions.py file is the feed limit. Certain RSS feeds can have upto 60 items and numfeeds variable limits the number of items to stream. The default value has been set to 10, which if you want can change.

FOR NEOPIXEL INDICATOR

• Change the Pin numbers in the given sketch according to your board and upload it.

• Follow the circuit diagram given.

LIST OF GPIOs USED

Note: some HATS may use GPIOs 18, 19, 20, 21 for I2S audio please refer to the manufacturer's pinouts