Skip to content

docs: Add FAQ section for common questions #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
meichuanyi wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Add FAQ section for common questions #51

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,3 +120,63 @@ Configure WiFi and server
**Chat:** press the `K0` button once or multiple times until the status bar shows "Ready". You can now speak and it will show "Listening ...". The device answers after it decides that you have done speaking.

**Config:** press `RST`. While it is restarting, press and hold `K0` to enter the configuration mode. Then [open the configuration UI](https://echokit.dev/setup/) to connect to the device via BT.
## FAQ

### What is EchoKit Server?

EchoKit Server is the central component managing communication between EchoKit device and AI services. It powers the full voice–AI interaction loop with ASR → LLM → TTS pipeline.

### Key Features

| Feature | Description |
|---------|-------------|
| ASR → LLM → TTS | Real-time, natural conversations |
| Model Compatibility | OpenAI-compatible APIs |
| Gemini Pipeline | Google's multimodal model |
| Qwen Real-Time | Alibaba's open LLM |
| Local/Remote | Deploy locally or connect to remote |
| MCP Integration | Extended functionality via MCP servers |

### Model Compatibility

| Stage | Compatibility |
|-------|---------------|
| ASR | OpenAI-compatible APIs |
| LLM | OpenAI-spec endpoints (local/cloud) |
| TTS | OpenAI-spec voice models + ElevenLabs |

### How to build?

```bash
git clone https://github.com/second-state/echokit_server
cargo build --release
```

### Configuration

Edit `config.toml` to customize:
- VAD, ASR, LLM, TTS services
- Prompts
- MCP servers

### Server URLs

| Region | WebSocket URL |
|--------|---------------|
| US | `ws://indie.echokit.dev/ws/` |
| Taiwan | `ws://tw.echokit.dev/ws/` |
| Rest of world | `ws://edge.echokit.dev/ws/` |

### Is EchoKit free?

EchoKit is open-source. Check repository for license.

### Help Resources

| Resource | Link |
|----------|------|
| Website | [echokit.dev](https://echokit.dev/) |
| Discord | [Join Discord](https://discord.gg/Fwe3zsT5g3) |
| Docs | [Quick Start](https://echokit.dev/docs/quick-start/) |
| Demo | [Live Demo](https://youtu.be/Zy-rLT4EgZQ) |