|
@@ -18,45 +18,53 @@ but adds a lot of features that go beyond the original purpose of Blather.
|
18
|
18
|
|
19
|
19
|
## Usage
|
20
|
20
|
|
21
|
|
-0. Move commands.tmp to ~/.config/blather/commands.conf and fill the file with sentences and command to run
|
22
|
|
-1. Run Blather.py, this will generate ~/.config/blather/sentences.corpus based on sentences in the 'commands' file
|
23
|
|
-2. Quit blather (there is a good chance it will just segfault)
|
24
|
|
-3. Go to <http://www.speech.cs.cmu.edu/tools/lmtool.html> and upload the sentences.corpus file
|
25
|
|
-4. Download the resulting XXXX.lm file to the ~/.config/blather/language directory and rename to file to 'lm'
|
26
|
|
-5. Download the resulting XXXX.dic file to the ~/.config/blather/language directory and rename to file to 'dic'
|
27
|
|
-6. Run Blather.py
|
28
|
|
- * For Gtk GUI, run Blather.py -i g
|
|
21
|
+1. Move commands.tmp to ~/.config/blather/commands.conf and fill the file with
|
|
22
|
+sentences and command to run
|
|
23
|
+2. Run blather.py, this will generate ~/.config/blather/sentences.corpus based
|
|
24
|
+on sentences in the 'commands' file
|
|
25
|
+3. Quit Kaylee (there is a good chance it will just segfault)
|
|
26
|
+4. Go to <http://www.speech.cs.cmu.edu/tools/lmtool.html> and upload the
|
|
27
|
+sentences.corpus file
|
|
28
|
+5. Download the resulting XXXX.lm file to the ~/.config/blather/language
|
|
29
|
+directory and rename to file to 'lm'
|
|
30
|
+6. Download the resulting XXXX.dic file to the ~/.config/blather/language
|
|
31
|
+directory and rename to file to 'dic'
|
|
32
|
+7. Run blather.py
|
|
33
|
+ * For GTK UI, run blather.py -i g
|
29
|
34
|
* To start a UI in 'continuous' listen mode, use the -c flag
|
30
|
35
|
* To use a microphone other than the system default, use the -m flag
|
31
|
|
-7. Start talking
|
|
36
|
+8. Start talking
|
32
|
37
|
|
33
|
|
-**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.
|
|
38
|
+**Note:** to start Kaylee without needing to enter command line options all the
|
|
39
|
+time, copy options.yaml.tmp to ~/.config/blather/options.yaml and edit
|
|
40
|
+accordingly.
|
34
|
41
|
|
35
|
42
|
### Bonus
|
36
|
43
|
|
37
|
|
-Once the sentences.corpus file has been created, run the language_updater.sh script to automate the process of creating and downloading language files.
|
|
44
|
+Once the sentences.corpus file has been created, run the language_updater.sh
|
|
45
|
+script to automate the process of creating and downloading language files.
|
38
|
46
|
|
39
|
47
|
### Examples
|
40
|
48
|
|
41
|
|
-* To run blather with the GTK UI and start in continuous listen mode:
|
42
|
|
-`./Blather.py -i g -c`
|
|
49
|
+* To run Kaylee with the GTK UI and start in continuous listen mode:
|
|
50
|
+`./blather.py -i g -c`
|
43
|
51
|
|
44
|
|
-* To run blather with no UI and using a USB microphone recognized and device 2:
|
45
|
|
-`./Blather.py -m 2`
|
|
52
|
+* To run Kaylee with no UI and using a USB microphone recognized and device 2:
|
|
53
|
+`./blather.py -m 2`
|
46
|
54
|
|
47
|
|
-* To have blather pass the matched sentence to the executing command:
|
48
|
|
- `./Blather.py -p`
|
|
55
|
+* To have Kaylee pass the matched sentence to the executed command:
|
|
56
|
+`./blather.py -p`
|
49
|
57
|
|
50
|
|
- **explanation:** if the commands.conf contains:
|
51
|
|
- **good morning world : example_command.sh**
|
52
|
|
- then 3 arguments, 'good', 'morning', and 'world' would get passed to example_command.sh as
|
53
|
|
- `example_command.sh good morning world`
|
|
58
|
+**explanation:** if the commands.conf contains:
|
|
59
|
+`good morning world: example_command.sh`
|
|
60
|
+then 3 arguments, 'good', 'morning', and 'world' would get passed to
|
|
61
|
+example_command.sh as `example_command.sh good morning world`
|
54
|
62
|
|
55
|
63
|
* To run a command when a valid sentence has been detected:
|
56
|
|
- `./Blather.py --valid-sentence-command=/path/to/command`
|
|
64
|
+ `./blather.py --valid-sentence-command=/path/to/command`
|
57
|
65
|
**note:** this can be set in the options.yml file
|
58
|
66
|
* To run a command when a invalid sentence has been detected:
|
59
|
|
- `./Blather.py --invalid-sentence-command=/path/to/command`
|
|
67
|
+ `./blather.py --invalid-sentence-command=/path/to/command`
|
60
|
68
|
**note:** this can be set in the options.yml file
|
61
|
69
|
|
62
|
70
|
### Finding the Device Number of a USB microphone
|