|
@@ -1,15 +1,28 @@
|
1
|
1
|
Kaylee
|
2
|
2
|
======
|
3
|
3
|
|
4
|
|
-Kaylee is a somewhat fancy speech recognizer that runs commands and
|
5
|
|
-performs other functions when a user speaks loosely preset sentences. It
|
6
|
|
-is based on `Blather <https://gitlab.com/jezra/blather>`__ by
|
|
4
|
+Kaylee is a somewhat fancy voice command recognition program that
|
|
5
|
+performs actions when a user speaks loosely preset sentences. It has a
|
|
6
|
+flexible plugin API allowing developers to add new advanced features
|
|
7
|
+that can be distributed and loaded with ease.
|
|
8
|
+
|
|
9
|
+Kaylee is based on `Blather <https://gitlab.com/jezra/blather>`__ by
|
7
|
10
|
`Jezra <http://www.jezra.net/>`__, but adds a lot of features that go
|
8
|
11
|
beyond the original purpose of Blather.
|
9
|
12
|
|
10
|
|
-Requirements
|
|
13
|
+Installation
|
11
|
14
|
------------
|
12
|
15
|
|
|
16
|
+Kaylee is only tested on GNU/Linux systems, so make sure you're trying
|
|
17
|
+to install it on one of those. The current recommended way to use Kaylee
|
|
18
|
+is to check out the Git repository and run it from there::
|
|
19
|
+
|
|
20
|
+ git clone https://git.clayhobbs.com/clay/kaylee.git
|
|
21
|
+ cd kaylee
|
|
22
|
+
|
|
23
|
+Dependencies
|
|
24
|
+~~~~~~~~~~~~
|
|
25
|
+
|
13
|
26
|
1. Python 3 (tested with 3.5, may work with older versions)
|
14
|
27
|
2. pocketsphinx 5prealpha
|
15
|
28
|
3. gstreamer-1.0 (and what ever plugin has pocketsphinx support)
|
|
@@ -21,8 +34,8 @@ Requirements
|
21
|
34
|
**Note:** it may also be required to install
|
22
|
35
|
``pocketsphinx-hmm-en-hub4wsj``
|
23
|
36
|
|
24
|
|
-Optional
|
25
|
|
-~~~~~~~~
|
|
37
|
+Optional Dependencies
|
|
38
|
+~~~~~~~~~~~~~~~~~~~~~
|
26
|
39
|
|
27
|
40
|
1. python-pydbus (required for MPRIS plugin)
|
28
|
41
|
|
|
@@ -35,13 +48,8 @@ Usage
|
35
|
48
|
2. Run Kaylee with ``./kaylee.py``. This generates a language model and
|
36
|
49
|
dictionary using the `Sphinx Knowledge Base Tool
|
37
|
50
|
<http://www.speech.cs.cmu.edu/tools/lmtool.html>`__, then listens for
|
38
|
|
- commands with the system default microphone.
|
39
|
|
-
|
40
|
|
- - For the GTK UI, run ``./kaylee.py -i g``.
|
41
|
|
- - To start a UI in 'continuous' listen mode, use the ``-c`` flag.
|
42
|
|
- - To use a microphone other than the system default, use the ``-m``
|
43
|
|
- flag.
|
44
|
|
-
|
|
51
|
+ commands with the system default microphone. To use a microphone
|
|
52
|
+ other than the system default, use the ``-m`` flag.
|
45
|
53
|
3. Start talking!
|
46
|
54
|
|
47
|
55
|
Examples
|