|
@@ -19,10 +19,10 @@ but adds a lot of features that go beyond the original purpose of Blather.
|
19
|
19
|
## Usage
|
20
|
20
|
|
21
|
21
|
1. Move commands.tmp to ~/.config/kaylee/commands.conf and fill the file with
|
22
|
|
-sentences and command to run
|
|
22
|
+sentences and commands to run
|
23
|
23
|
2. Run kaylee.py. This will generate ~/.local/share/kaylee/sentences.corpus
|
24
|
|
-based on sentences in the 'commands' file, then use
|
25
|
|
-<http://www.speech.cs.cmu.edu/tools/lmtool.html> to create and save a new
|
|
24
|
+based on sentences in the 'commands' file, then use the [Sphinx Knowledge Base
|
|
25
|
+Tool](http://www.speech.cs.cmu.edu/tools/lmtool.html) to create and save a new
|
26
|
26
|
language model and dictionary.
|
27
|
27
|
* For GTK UI, run kaylee.py -i g
|
28
|
28
|
* To start a UI in 'continuous' listen mode, use the -c flag
|
|
@@ -35,26 +35,27 @@ accordingly.
|
35
|
35
|
|
36
|
36
|
### Examples
|
37
|
37
|
|
38
|
|
-* To run Kaylee with the GTK UI and start in continuous listen mode:
|
39
|
|
-`./kaylee.py -i g -c`
|
|
38
|
+* To run Kaylee with the GTK UI, starting in continuous listen mode:
|
|
39
|
+ `./kaylee.py -i g -c`
|
40
|
40
|
|
41
|
|
-* To run Kaylee with no UI and using a USB microphone recognized and device 2:
|
42
|
|
-`./kaylee.py -m 2`
|
|
41
|
+* To run Kaylee with no UI and using a USB microphone recognized as device 2:
|
|
42
|
+ `./kaylee.py -m 2`
|
43
|
43
|
|
44
|
44
|
* To have Kaylee pass the matched sentence to the executed command:
|
45
|
|
-`./kaylee.py -p`
|
|
45
|
+ `./kaylee.py -p`
|
46
|
46
|
|
47
|
|
-**explanation:** if the commands.conf contains:
|
48
|
|
-`good morning world: example_command.sh`
|
49
|
|
-then 3 arguments, 'good', 'morning', and 'world' would get passed to
|
50
|
|
-example_command.sh as `example_command.sh good morning world`
|
|
47
|
+ **Explanation:** if the commands.conf contains the line:
|
|
48
|
+
|
|
49
|
+ good morning world: example_command.sh
|
|
50
|
+
|
|
51
|
+ Then three arguments, 'good', 'morning', and 'world', would get passed to
|
|
52
|
+ example_command.sh as `example_command.sh good morning world`.
|
51
|
53
|
|
52
|
54
|
* To run a command when a valid sentence has been detected:
|
53
|
|
- `./kaylee.py --valid-sentence-command=/path/to/command`
|
54
|
|
- **note:** this can be set in the options.yml file
|
|
55
|
+ `./kaylee.py --valid-sentence-command=/path/to/command`
|
|
56
|
+
|
55
|
57
|
* To run a command when a invalid sentence has been detected:
|
56
|
|
- `./kaylee.py --invalid-sentence-command=/path/to/command`
|
57
|
|
- **note:** this can be set in the options.yml file
|
|
58
|
+ `./kaylee.py --invalid-sentence-command=/path/to/command`
|
58
|
59
|
|
59
|
60
|
### Finding the Device Number of a USB microphone
|
60
|
61
|
There are a few ways to find the device number of a USB microphone.
|