blob: cecd1e93f105927ef0faaf03a07e5b36bd9745fc (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
# Kaylee
Kaylee is a somewhat fancy speech recognizer that will run commands and perform
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. pocketsphinx
2. gstreamer-1.0 (and what ever plugin has pocket sphinx support)
3. gstreamer-1.0 base plugins (required for alsa)
5. pygtk (only required for the Gtk based UI)
6. pyyaml (only required for reading the options file)
**Note:** it may also be required to install `pocketsphinx-hmm-en-hub4wsj`
## Usage
0. Move commands.tmp to ~/.config/blather/commands.conf and fill the file with sentences and command to run
1. Run Blather.py, this will generate ~/.config/blather/sentences.corpus based on sentences in the 'commands' file
2. Quit blather (there is a good chance it will just segfault)
3. Go to <http://www.speech.cs.cmu.edu/tools/lmtool.html> and upload the sentences.corpus file
4. Download the resulting XXXX.lm file to the ~/.config/blather/language directory and rename to file to 'lm'
5. Download the resulting XXXX.dic file to the ~/.config/blather/language directory and rename to file to 'dic'
6. Run Blather.py
* For Gtk GUI, run Blather.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
7. Start talking
**Note:** to start Blather without needing to enter command line options all the time, copy options.yaml.tmp to ~/.config/blather/options.yaml and edit accordingly.
### Bonus
Once the sentences.corpus file has been created, run the language_updater.sh script to automate the process of creating and downloading language files.
### Examples
* To run blather with the GTK UI and start in continuous listen mode:
`./Blather.py -i g -c`
* To run blather with no UI and using a USB microphone recognized and device 2:
`./Blather.py -m 2`
* To have blather pass the matched sentence to the executing command:
`./Blather.py -p`
**explanation:** if the commands.conf contains:
**good morning world : example_command.sh**
then 3 arguments, 'good', 'morning', and 'world' would get passed to example_command.sh as
`example_command.sh good morning world`
* To run a command when a valid sentence has been detected:
`./Blather.py --valid-sentence-command=/path/to/command`
**note:** this can be set in the options.yml file
* To run a command when a invalid sentence has been detected:
`./Blather.py --invalid-sentence-command=/path/to/command`
**note:** this can be set in the options.yml file
### 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`
|