Skip to content
This repository has been archived by the owner on Jun 3, 2020. It is now read-only.

Latest commit

 

History

History
 
 

grpc

README.rst

Python Samples for the Google Assistant gRPC API

This repository contains a reference sample for the google-assistant-grpc Python package.

It implements the following features:

  • Triggering a conversation using a key press
  • Audio recording of user queries (single or multiple consecutive queries)
  • Playback of the Assistant response
  • Conversation state management
  • Volume control

Prerequisites

Setup

  • Install Python 3

    • Ubuntu/Debian GNU/Linux:

      sudo apt-get update
sudo apt-get install python3 python3-venv

    • MacOSX, Windows, Other

  • Create a new virtual environment (recommended):

    python3 -m venv env
env/bin/python -m pip install --upgrade pip setuptools
source env/bin/activate

Authorization

Run the samples

  • Install the sample dependencies:

    sudo apt-get install portaudio19-dev libffi-dev libssl-dev
pip install --upgrade -r requirements.txt

  • Verify audio setup:

    # Record a 5 sec sample and play it back
python -m audio_helpers

  • Register or overwrite the device model and device instance with the supported traits:

    python -m devicetool register --model 'my-model-identifier' \
                              --type LIGHT --trait action.devices.traits.OnOff \
                              --manufacturer 'Assistant SDK developer' \
                              --product-name 'Assistant SDK light' \
                              --description 'Assistant SDK light device' \
                              --device 'my-device-identifier' \
                              --nickname 'My Assistant Light'

Note: The device model identifier must be globally unique, and device instance identifier must be unique within the Google Developer Project associated with the device.

  • Run the push to talk sample. The sample records a voice query after a key press and plays back the Google Assistant's answer:

    python -m pushtotalk --device-id 'my-device-identifier'

  • Try some Google Assistant voice query like "What time is it?" or "Who am I?".

  • Try a device action query like "Turn <nickname / model product name> on".

  • Run in verbose mode to see the gRPC communication with the Google Assistant API:

    python -m pushtotalk --device-id 'my-device-identifier' -v

  • Send a pre-recorded request to the Assistant:

    python -m pushtotalk --device-id 'my-device-identifier' -i in.wav

  • Save the Assistant response to a file:

    python -m pushtotalk --device-id 'my-device-identifier' -o out.wav

Troubleshooting

  • Verify ALSA setup:

    # Play a test sound
speaker-test -t wav

# Record and play back some audio using ALSA command-line tools
arecord --format=S16_LE --duration=5 --rate=16000 --file-type=raw out.raw
aplay --format=S16_LE --rate=16000 --file-type=raw out.raw

  • If Assistant audio is choppy, try adjusting the sound device's block size:

    # If using a USB speaker or dedicated soundcard, set block size to "0"
# to automatically adjust the buffer size
python -m audio_helpers --audio-block-size=0

# If using the line-out 3.5mm audio jack on the device, set block size
# to a value larger than the `ConverseResponse` audio payload size
python -m audio_helpers --audio-block-size=3200

# Run the Assistant sample using the best block size value found above
python -m pushtotalk --audio-block-size=value

  • If Assistant audio is truncated, try adjusting the sound device's flush size:

    # Set flush size to a value larger than the audio block size. You can
# run the sample using the --audio-flush-size flag as well.
python -m audio_helpers --audio-block-size=3200 --audio-flush-size=6400

License

Copyright (C) 2017 Google Inc.

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.