You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-4Lines changed: 24 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -15,6 +15,7 @@
15
15
*[SystemRequirements](#SystemRequirements)
16
16
*[Compile](#Compile)
17
17
*[Installation](#Installation)
18
+
*[OnlineInstallation](#OnlineInstallation)
18
19
*[Upgrade](#Upgrade)
19
20
*[Run](#Run)
20
21
*[Configuration](#Configuration)
@@ -43,7 +44,7 @@ Main working modes of the StackFlow voice assistant:
43
44
After startup, KWS, ASR, LLM, TTS, and AUDIO are configured to work collaboratively. When KWS detects a keyword in the audio obtained from the AUDIO unit, it sends a wake-up signal. At this point, ASR starts working, recognizing the audio data from AUDIO and publishing the results to its output channel. Once LLM receives the text data converted by ASR, it begins reasoning and publishes the results to its output channel. TTS, upon receiving the results from LLM, starts voice synthesis and plays the synthesized audio data according to the configuration.
# Note the installation order of lib-llm_1.4-m5stack1_arm64.deb and llm-sys_1.4-m5stack1_arm64.deb. The installation order of other llm units and model packages is not required.
96
97
```
97
98
98
-
## Upgrade
99
+
## OnlineInstallation ##
100
+
Online installation requires an active internet connection. Please ensure network connectivity. The model package is relatively large, so install and use it as needed.
When upgrading, you can either upgrade the AI unit individually or upgrade the entire StackFlow framework.
100
120
When upgrading a single unit, you can upgrade via an SD card or manually install using the `dpkg` command. It's important to note that for minor version packages, you can install the upgrade package individually, but for major version upgrades, all llm units must be installed completely.
101
121
Command line upgrade package:
@@ -122,12 +142,12 @@ Both types of configuration files use the JSON format and are located in multipl
122
142
## Interface ##
123
143
StackFlow can be accessed via UART and TCP ports. The default baud rate for the UART port is 115200, and the default port for the TCP port is 10001. Parameters can be modified through configuration files.
124
144
125
-
## Contribution
145
+
## Contribution ##
126
146
127
147
* If you like this project, please give it a star first;
128
148
* To report a bug, please go to the [issue page](https://github.com/m5stack/StackFlow/issues);
129
149
* If you want to contribute code, feel free to fork it and then submit a pull request;
130
150
131
-
## Star History
151
+
## Star History ##
132
152
133
153
[](https://star-history.com/#m5stack/StackFlow&Date)
0 commit comments