Skip to content

Latest commit

 

History

History
77 lines (51 loc) · 3.28 KB

README.md

File metadata and controls

77 lines (51 loc) · 3.28 KB
Raw

opsdroid audio

Build Status Coverage Status Updates Dependency Status

This application is an early alpha and should not be used yet.

A companion python application for opsdroid which adds hotwords, speech recognition and audio responses.

This application uses snowboy hotword detection to allow you to activate opsdroid by saying a hotword followed by your message. Unlike other voice assistants you can train your own hotword or choose from the vast catalogue provided by kitt.ai.

Once awoken opsdroid audio will record your voice until you stop speaking and then analyse what you said using your choice of service from a range of speech-to-text services.

When the text has been generated it will be sent off to opsdroid for analysis by the skills you have configured.

Finally when opsdroid responds this application will run the response through your choice of text-to-speech engines and will then play back the audio response.

Privacy

If you have privacy concerns when using voice assistant applications then you will be happy to hear that opsdroid audio supports both local and cloud based services.

When opsdroid audio listens for your hotword it only retains the last few seconds of sound and processes it locally. This means nothing leaves your device until you say the hotword, and even then maybe not.

When you trigger the hotword and opsdroid audio begins recording your voice it is only sent to the services you configure. If you choose to use a local speech recognition service then no sound will ever leave the application. Any sound sent to cloud based services will be encrypted in transit and it is your decision whether to trust that provider with your data or not.

Installation

macOS

  1. brew install swig portaudio pocketsphinx
  2. git clone https://github.com/opsdroid/opsdroid-audio.git /path/to/opsdroid-audio
  3. cd /path/to/opsdroid-audio
  4. scripts/install_snowboy.sh -i ./
  5. pip install -r requirements.txt
  6. python -m opsdroidaudio

Configuration

~/.opsdroidaudio/configuration.yaml

## Hotword
# "alexa", "computer", "opsdroid", "snowboy"
# or path to pmdl file generated at https://snowboy.kitt.ai/dashboard
hotword: "opsdroid"

## Opsdroid instance
opsdroid:  
  host: "localhost"
  port: 8080

## Speech configuration
speech:
  recognizer:
    name: "sphinx"
  generator:
    name: "google"

Recognizers

List of currently available speech recognition services:

  • Sphinx (local)
  • Google Cloud (cloud)

Generators

List of test-to-speech engines.

  • Apple Say (local) - Apple macOS only
  • Google (cloud)

Contributing

Pull requests are welcome!