Skip to main content

Customizable voice assistant

Project description

Voice Assistant

Customizable voice assistant (README.md to be completed)

Features

  1. Trigger word can be said anywhere in a sentence, for example, "play music, Jarvis". It relies on Picovoice porcupine
  2. Speech-to-Text relies on Google Cloud Speech-To-Text API
  3. Text-to-Speech relies on Amazon Polly

Installation

  1. Install Docker with official guide or use convenience script (currently the only option for Raspbian): Uninstall old versions

    sudo apt-get remove docker docker-engine docker.io containerd runc
    

    Install using convenience script

    curl -fsSL https://get.docker.com -o get-docker.sh
    sh get-docker.sh
    
  2. Create a folder to store configuration files e.g. mkdir ~/.voice-assistant

  3. Set up Google Cloud Speech-To-Text

  • Create Google Cloud Platform project and download your credentials following instructions
  • Put credentials into your configuration folder ~/.voice-assistant/google_credentials.json
  • Activate Cloud Speech-To-Text API for your project
  1. Set up AWS for Text-to-Speech Create AWS account and take a note of Access Key ID and Secret Access Key

  2. Add configuration.yaml into ~/.voice-assistant/configuration.yaml:

     google_cloud:
       language_code: "en-US"
    
     aws:
       access_key_id: "YOUR_ACCES_KEY_ID"
       secret_access_key: "YOUR_SECRET_ACCESS_KEY"
       region_name: eu-west-2  # set closest to your location
       voice_id: "Brian"
    
  1. Build Voice Assistant on Docker sudo docker build -t voice-assistant .

Run on Docker

For convenience Docker Compose can be used:

Create docker-compose.yaml:

version: '0.0.1'
services:
  voice-assistant:
    container_name: voice-assistant
    image: voice-assistant
    volumes:
      # volume to share config and credentials from host to container
      - your/configuration/folder:/usr/src/config
    devices:
      # sounds devices need to be exposed to container
      - /dev/snd:/dev/snd
    restart: always

Then run with sudo docker-compose up in the same folder.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

voiceassistant-0.0.1.tar.gz (21.3 kB view hashes)

Uploaded Source

Built Distribution

voiceassistant-0.0.1-py3-none-any.whl (26.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page