clara/kaylee: Somewhat fancy voice command recognition software

Somewhat fancy voice command recognition software

Clara Hobbs 604bbf7ec3 Give plugins the ability to talk Finally, some sort of built-in TTS support. When a plugin emits a "tts" signal, the Kaylee object will receive it and speak the given text aloud. It even stops listening while it speaks to prevent Kaylee from talking to herself. If no TTS is configured, it will print the text instead, but since a default TTS setting is provided in the new options.json.tmp, that shouldn't happen much. Currently there's no way for the shell plugin to use TTS. The D-Bus interface will change that once I get around to making it. Speaking of D-Bus, UIs are broken again and I'm sure I can fix them once they're separate processes talking to Kaylee by D-Bus.		vor 8 Jahren
assets	New icons!	vor 8 Jahren
data	New icons!	vor 8 Jahren
kayleevc	Give plugins the ability to talk	vor 8 Jahren
systemd	Add a systemd service file for starting Kaylee	vor 8 Jahren
.gitignore	Add packaging files to .gitignore	vor 8 Jahren
COPYING	Rename license file to COPYING	vor 8 Jahren
README.rst	Updated README for new configuration	vor 8 Jahren
kaylee.py	Reorganize classes into a "kayleevc" package	vor 8 Jahren
options.json.tmp	Give plugins the ability to talk	vor 8 Jahren
plugins.json.tmp	Moved plugin configuration to plugins.json	vor 8 Jahren
setup.py	Update URL in setup script	vor 8 Jahren

Kaylee
======

Kaylee is a somewhat fancy speech recognizer that runs commands and
performs other functions when a user speaks loosely preset sentences. It
is based on `Blather <https://gitlab.com/jezra/blather>`__ by
`Jezra <http://www.jezra.net/>`__, but adds a lot of features that go
beyond the original purpose of Blather.

Requirements
------------

1. Python 3 (tested with 3.5, may work with older versions)
2. pocketsphinx 5prealpha
3. gstreamer-1.0 (and what ever plugin has pocketsphinx support)
4. gstreamer-1.0 base plugins (required for ALSA)
5. python-gobject (required for GStreamer and the GTK-based UI)
6. python-requests (required for automatic language updating)

**Note:** it may also be required to install
``pocketsphinx-hmm-en-hub4wsj``

Usage
-----

1. Copy options.json.tmp to ~/.config/kaylee/options.json.  Default
   values for command-line arguments may be specified in this file.
2. Copy plugins.json.tmp to ~/.config/kaylee/plugins.json and fill the
   ".shell" section of the file with sentences to speak and commands
   to run.
3. Run Kaylee with ``./kaylee.py``. This generates a language model and
   dictionary using the `Sphinx Knowledge Base Tool
   <http://www.speech.cs.cmu.edu/tools/lmtool.html>`__, then listens for
   commands with the system default microphone.

   -  For the GTK UI, run ``./kaylee.py -i g``.
   -  To start a UI in 'continuous' listen mode, use the ``-c`` flag.
   -  To use a microphone other than the system default, use the ``-m``
      flag.

3. Start talking!

Examples
~~~~~~~~

-  To run Kaylee with the GTK UI, starting in continuous listen mode:
   ``./kaylee.py -i g -c``

-  To run Kaylee with no UI and using a USB microphone recognized as
   device 2: ``./kaylee.py -m 2``

-  To run a command when a valid sentence has been detected:
   ``./kaylee.py --valid-sentence-command=/path/to/command``

-  To run a command when an invalid sentence has been detected:
   ``./kaylee.py --invalid-sentence-command=/path/to/command``

Finding the Device Number of a USB microphone
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

There are a few ways to find the device number of a USB microphone.

-  ``cat /proc/asound/cards``
-  ``arecord -l``

README.rst