Skip to content

Commit 8d128b3

Browse files
committedMay 29, 2021
Update README + diagram with "Kõnele service"
1 parent 287fc27 commit 8d128b3

File tree

3 files changed

+166
-142
lines changed

3 files changed

+166
-142
lines changed
 

‎README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
Kõnele
22
======
33

4-
Kõnele is an Android app that offers speech-to-text services to other apps.
4+
Kõnele is an Android app that offers speech-to-text user interfaces to other apps.
55
Its main components are:
66

77
- a voice search panel (i.e. a [RecognizerIntent](http://developer.android.com/reference/android/speech/RecognizerIntent.html) activity)
8+
- a speech keyboard that implements the [input method editor (IME) API](http://developer.android.com/reference/android/inputmethodservice/InputMethodService.html)
89
- two implementations of [SpeechRecognizer](http://developer.android.com/reference/android/speech/SpeechRecognizer.html), backed by two open source speech recognition servers
910
- <https://github.com/alumae/kaldi-gstreamer-server>
1011
- <https://github.com/alumae/ruby-pocketsphinx-server>
11-
- a speech keyboard that implements the [input method editor (IME) API](http://developer.android.com/reference/android/inputmethodservice/InputMethodService.html)
12+
13+
The SpeechRecognizer-implementations have been deprecated, we recommend to use the external app
14+
[Kõnele service](https://github.com/Kaljurand/K6nele-service) to connect to kaldi-gstreamer-server.
1215

1316
[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
1417
alt="Get it on F-Droid"
@@ -17,7 +20,7 @@ Its main components are:
1720
alt="Get it on Google Play"
1821
height="80">](https://play.google.com/store/apps/details?id=ee.ioc.phon.android.speak)
1922

20-
The diagram below shows Kõnele's main components in yellow, while the standard Android interfaces via which other apps can interact with Kõnele are in green.
23+
The diagram below shows Kõnele's main components in dark yellow, while the standard Android interfaces via which other apps can interact with Kõnele are in green. Deprecated parts are crossed out.
2124

2225
![Components](https://rawgithub.com/Kaljurand/K6nele/master/docs/components.dot.svg)
2326

‎docs/components.dot

+16-13
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ digraph G {
1111
edge [arrowhead="normal", arrowsize="0.6"];
1212
labeljust = "l";
1313

14-
"Kõnele View" [label="Kõnele mic+swipe editor\n(view component)", shape="component", style="filled", fillcolor="yellow"];
14+
"Kõnele View" [label="Kõnele mic+swipe editor\n(view component)", shape="component", style="filled", fillcolor="#ffc400"];
1515

1616
subgraph cluster_0 {
1717
label = "Cloud speech servers";
1818
style = "filled";
1919
color = "lightblue";
20-
"kaldi" [label="kaldi-gstreamer-server"];
21-
"pocketsphinx" [label="ruby-pocketsphinx-server"];
20+
"kaldi" [label=<kaldi-gstreamer-server<br/><br/><i>WebSockets</i>>];
21+
"pocketsphinx" [label=<<s>ruby-pocketsphinx-server<br/><br/><i>net-speech-api (HTTP)</i></s>>];
2222
}
2323

2424
// Services record audio, send it to the server, and make the transcription
@@ -28,24 +28,25 @@ digraph G {
2828
subgraph cluster_1 {
2929
label = "Android speech services";
3030
"other_service" [label="some other service:\nGoogle, ..."];
31-
"Kõnele fast" [label="Kõnele (fast recognition)", style="filled", fillcolor="yellow"];
32-
"Kõnele grammar" [label="Kõnele (grammar support)", style="filled", fillcolor="yellow"];
31+
"Kõnele service" [label="Kõnele service", style="filled", fillcolor="yellow"];
32+
"Kõnele fast" [label=<<s>Kõnele (fast recognition)</s>>, style="filled", fillcolor="#ffc400"];
33+
"Kõnele grammar" [label=<<s>Kõnele (grammar support)</s>>, style="filled", fillcolor="#ffc400"];
3334
}
3435

3536
// Android speech and text input APIs
36-
"Android SpeechRecognizer" [label="Android SpeechRecognizer API", shape="egg", style="filled", fillcolor="limegreen"];
37-
"Android RecognizerIntent" [label="Android RecognizerIntent API", shape="egg", style="filled", fillcolor="limegreen"];
38-
"IME" [label="Input Method Editor API", shape="egg", style="filled", fillcolor="limegreen"];
37+
"Android SpeechRecognizer" [label="Android SpeechRecognizer API", shape="egg", style="filled", fillcolor="#99cc33"];
38+
"Android RecognizerIntent" [label="Android RecognizerIntent API", shape="egg", style="filled", fillcolor="#99cc33"];
39+
"IME" [label="Input Method Editor API", shape="egg", style="filled", fillcolor="#99cc33"];
3940

4041
subgraph cluster_2 {
4142
label = "Android RecognizerIntent activities";
4243
"other_activity" [label="some other activity:\nGoogle, ..."];
43-
"panel" [label="Kõnele voice search panel", style="filled", fillcolor="yellow"];
44+
"panel" [label="Kõnele voice search panel", style="filled", fillcolor="#ffc400"];
4445
}
4546

4647
subgraph cluster_3 {
47-
label = "Android IME apps";
48-
"Kõnele IME" [label="Kõnele speak & swipe", style="filled", fillcolor="yellow"];
48+
label = "Android IME services";
49+
"Kõnele IME" [label="Kõnele speak & swipe", style="filled", fillcolor="#ffc400"];
4950
"Gboard" [label="Gboard"];
5051
"other_ime" [label="some other keyboard"];
5152
}
@@ -59,10 +60,12 @@ digraph G {
5960
"Arvutaja";
6061
}
6162

62-
"kaldi" -> "Kõnele fast" [label="WebSockets", fontsize=9, fontname="monospace"];
63-
"pocketsphinx" -> "Kõnele grammar" [label="net-speech-api (HTTP)", fontsize=9, fontname="monospace"];
63+
"kaldi" -> "Kõnele fast" [fontsize=9, fontname="monospace"];
64+
"kaldi" -> "Kõnele service" [fontsize=9, fontname="monospace"];
65+
"pocketsphinx" -> "Kõnele grammar" [fontsize=9, fontname="monospace"];
6466

6567
// Services that implement Android SpeechRecognizer
68+
"Kõnele service" -> "Android SpeechRecognizer" ;
6669
"Kõnele fast" -> "Android SpeechRecognizer" ;
6770
"Kõnele grammar" -> "Android SpeechRecognizer" ;
6871
"other_service" -> "Android SpeechRecognizer" ;

0 commit comments

Comments
 (0)
Failed to load comments.