Desmond-Dong commited on
Commit
90389e2
·
1 Parent(s): d149a39

docs: add quick start guides for easy setup

Browse files

- Add QUICKSTART.md (English)
- Add QUICKSTART_CN.md (Chinese)
- Provide step-by-step setup instructions
- Include troubleshooting section
- Add advanced configuration examples
- Help users get started quickly

Files changed (2) hide show
  1. QUICKSTART.md +202 -0
  2. QUICKSTART_CN.md +202 -0
QUICKSTART.md ADDED
@@ -0,0 +1,202 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Quick Start Guide
2
+
3
+ This guide will help you quickly set up the Reachy Mini Home Assistant Voice Assistant.
4
+
5
+ ## Prerequisites
6
+
7
+ - Reachy Mini robot (connected and powered on)
8
+ - Home Assistant instance with ESPHome integration
9
+ - Python 3.8 or higher installed on Reachy Mini
10
+ - Network connection between Reachy Mini and Home Assistant
11
+
12
+ ## Step 1: Install Dependencies
13
+
14
+ ```bash
15
+ # SSH into your Reachy Mini
16
+ ssh reachy@<reachy-ip>
17
+
18
+ # Clone the repository
19
+ git clone https://github.com/yourusername/reachy_mini_ha_voice.git
20
+ cd reachy_mini_ha_voice
21
+
22
+ # Create virtual environment
23
+ python -m venv .venv
24
+ source .venv/bin/activate
25
+
26
+ # Install dependencies
27
+ pip install -e .
28
+ ```
29
+
30
+ ## Step 2: Download Wake Word Models
31
+
32
+ ```bash
33
+ # Download Okay Nabu model (default)
34
+ cd wakewords
35
+ wget https://github.com/kah0st/microWakeWord/raw/main/models/okay_nabu.tflite -O okay_nabu.tflite
36
+ cp okay_nabu.json.example okay_nabu.json
37
+
38
+ # Optional: Download Hey Jarvis model
39
+ wget https://github.com/kah0st/microWakeWord/raw/main/models/hey_jarvis.tflite -O hey_jarvis.tflite
40
+ wget https://github.com/kah0st/microWakeWord/raw/main/models/hey_jarvis.json -O hey_jarvis.json
41
+
42
+ cd ..
43
+ ```
44
+
45
+ ## Step 3: Configure Audio Devices
46
+
47
+ ```bash
48
+ # List available audio devices
49
+ python -m reachy_mini_ha_voice --list-input-devices
50
+ python -m reachy_mini_ha_voice --list-output-devices
51
+
52
+ # Note the device names you want to use
53
+ ```
54
+
55
+ ## Step 4: Create Configuration
56
+
57
+ ```bash
58
+ # Copy environment template
59
+ cp .env.example .env
60
+
61
+ # Edit .env file
62
+ nano .env
63
+ ```
64
+
65
+ Add your configuration:
66
+
67
+ ```env
68
+ # Audio Configuration
69
+ AUDIO_INPUT_DEVICE=Reachy Microphone
70
+ AUDIO_OUTPUT_DEVICE=Reachy Speaker
71
+ AUDIO_SAMPLE_RATE=16000
72
+ AUDIO_CHANNELS=1
73
+ AUDIO_BLOCK_SIZE=1024
74
+
75
+ # Voice Configuration
76
+ WAKE_WORD=okay_nabu
77
+ WAKE_WORD_DIR=wakewords
78
+
79
+ # Motion Configuration
80
+ MOTION_ENABLED=true
81
+ SPEECH_REACTIVE=true
82
+
83
+ # ESPHome Configuration
84
+ ESPHOME_HOST=0.0.0.0
85
+ ESPHOME_PORT=6053
86
+ ESPHOME_NAME=Reachy Mini
87
+
88
+ # Robot Configuration
89
+ ROBOT_HOST=localhost
90
+ ROBOT_WIRELESS=false
91
+
92
+ # Logging
93
+ LOG_LEVEL=INFO
94
+ ```
95
+
96
+ ## Step 5: Start the Application
97
+
98
+ ```bash
99
+ # Start the voice assistant
100
+ python -m reachy_mini_ha_voice
101
+
102
+ # Or with custom configuration
103
+ python -m reachy_mini_ha_voice \
104
+ --name "My Reachy Mini" \
105
+ --audio-input-device "Reachy Microphone" \
106
+ --audio-output-device "Reachy Speaker" \
107
+ --wake-model okay_nabu
108
+ ```
109
+
110
+ ## Step 6: Connect to Home Assistant
111
+
112
+ 1. Open Home Assistant
113
+ 2. Go to **Settings** → **Devices & Services**
114
+ 3. Click **Add Integration**
115
+ 4. Search for **ESPHome**
116
+ 5. Click **Set up another instance of ESPHome**
117
+ 6. Enter Reachy Mini's IP address and port (default: 6053)
118
+ 7. Click **Submit**
119
+
120
+ ## Step 7: Test
121
+
122
+ 1. Say the wake word: **"Okay Nabu"**
123
+ 2. Reachy Mini should nod to acknowledge
124
+ 3. Speak your command
125
+ 4. Reachy Mini should respond with motion and voice (if configured)
126
+
127
+ ## Troubleshooting
128
+
129
+ ### Wake Word Not Detected
130
+
131
+ - Check if the wake word model is downloaded: `ls wakewords/`
132
+ - Verify the model name in configuration matches the file
133
+ - Check microphone is working: `python -m reachy_mini_ha_voice --list-input-devices`
134
+ - Increase microphone volume if needed
135
+
136
+ ### No Audio Output
137
+
138
+ - Check speaker is working: `python -m reachy_mini_ha_voice --list-output-devices`
139
+ - Verify audio output device name in configuration
140
+ - Check speaker volume
141
+
142
+ ### Cannot Connect to Home Assistant
143
+
144
+ - Verify network connectivity: `ping <home-assistant-ip>`
145
+ - Check ESPHome port (6053) is not blocked by firewall
146
+ - Ensure Home Assistant ESPHome integration is installed
147
+ - Check Home Assistant logs for connection errors
148
+
149
+ ### Motion Not Working
150
+
151
+ - Verify Reachy Mini is connected: Check if robot responds to basic commands
152
+ - Check robot host in configuration
153
+ - Ensure Reachy Mini SDK is installed: `pip show reachy-mini`
154
+ - Check robot is not in sleep mode
155
+
156
+ ## Advanced Configuration
157
+
158
+ ### Custom Wake Word
159
+
160
+ 1. Train your own wake word model (see wakewords/README.md)
161
+ 2. Place the model files in wakewords/ directory
162
+ 3. Update configuration to use your model
163
+
164
+ ### Multiple Wake Words
165
+
166
+ ```bash
167
+ # Add additional wake word models to wakewords/ directory
168
+ # Update configuration to enable multiple wake words
169
+ ```
170
+
171
+ ### Web UI
172
+
173
+ ```bash
174
+ # Start with Gradio web interface
175
+ python -m reachy_mini_ha_voice --gradio
176
+
177
+ # Access at http://<reachy-ip>:7860
178
+ ```
179
+
180
+ ### Wireless Reachy Mini
181
+
182
+ ```bash
183
+ # For wireless version
184
+ python -m reachy_mini_ha_voice --wireless
185
+ ```
186
+
187
+ ## Next Steps
188
+
189
+ - Read the full [README.md](README.md) for detailed documentation
190
+ - Check [ARCHITECTURE.md](ARCHITECTURE.md) for system architecture
191
+ - See [REQUIREMENTS.md](REQUIREMENTS.md) for detailed requirements
192
+ - Explore [profiles/](profiles/) for personality customization
193
+
194
+ ## Support
195
+
196
+ - GitHub Issues: https://github.com/yourusername/reachy_mini_ha_voice/issues
197
+ - Documentation: https://github.com/yourusername/reachy_mini_ha_voice#readme
198
+ - Community: Join our Discord server
199
+
200
+ ---
201
+
202
+ **Happy talking with your Reachy Mini!** 🤖
QUICKSTART_CN.md ADDED
@@ -0,0 +1,202 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # 快速开始指南
2
+
3
+ 本指南将帮助您快速设置 Reachy Mini Home Assistant 语音助手。
4
+
5
+ ## 前置要求
6
+
7
+ - Reachy Mini 机器人(已连接并开机)
8
+ - 配置了 ESPHome 集成的 Home Assistant 实例
9
+ - Reachy Mini 上安装了 Python 3.8 或更高版本
10
+ - Reachy Mini 与 Home Assistant 之间的网络连接
11
+
12
+ ## 步骤 1: 安装依赖
13
+
14
+ ```bash
15
+ # SSH 连接到您的 Reachy Mini
16
+ ssh reachy@<reachy-ip>
17
+
18
+ # 克隆仓库
19
+ git clone https://github.com/yourusername/reachy_mini_ha_voice.git
20
+ cd reachy_mini_ha_voice
21
+
22
+ # 创建虚拟环境
23
+ python -m venv .venv
24
+ source .venv/bin/activate
25
+
26
+ # 安装依赖
27
+ pip install -e .
28
+ ```
29
+
30
+ ## 步骤 2: 下载唤醒词模型
31
+
32
+ ```bash
33
+ # 下载 Okay Nabu 模型(默认)
34
+ cd wakewords
35
+ wget https://github.com/kah0st/microWakeWord/raw/main/models/okay_nabu.tflite -O okay_nabu.tflite
36
+ cp okay_nabu.json.example okay_nabu.json
37
+
38
+ # 可选:下载 Hey Jarvis 模型
39
+ wget https://github.com/kah0st/microWakeWord/raw/main/models/hey_jarvis.tflite -O hey_jarvis.tflite
40
+ wget https://github.com/kah0st/microWakeWord/raw/main/models/hey_jarvis.json -O hey_jarvis.json
41
+
42
+ cd ..
43
+ ```
44
+
45
+ ## 步骤 3: 配置音频设备
46
+
47
+ ```bash
48
+ # 列出可用的音频设备
49
+ python -m reachy_mini_ha_voice --list-input-devices
50
+ python -m reachy_mini_ha_voice --list-output-devices
51
+
52
+ # 记下您想使用的设备名称
53
+ ```
54
+
55
+ ## 步骤 4: 创建配置
56
+
57
+ ```bash
58
+ # 复制环境变量模板
59
+ cp .env.example .env
60
+
61
+ # 编辑 .env 文件
62
+ nano .env
63
+ ```
64
+
65
+ 添加您的配置:
66
+
67
+ ```env
68
+ # 音频配置
69
+ AUDIO_INPUT_DEVICE=Reachy Microphone
70
+ AUDIO_OUTPUT_DEVICE=Reachy Speaker
71
+ AUDIO_SAMPLE_RATE=16000
72
+ AUDIO_CHANNELS=1
73
+ AUDIO_BLOCK_SIZE=1024
74
+
75
+ # 语音配置
76
+ WAKE_WORD=okay_nabu
77
+ WAKE_WORD_DIR=wakewords
78
+
79
+ # 运动配置
80
+ MOTION_ENABLED=true
81
+ SPEECH_REACTIVE=true
82
+
83
+ # ESPHome 配置
84
+ ESPHOME_HOST=0.0.0.0
85
+ ESPHOME_PORT=6053
86
+ ESPHOME_NAME=Reachy Mini
87
+
88
+ # 机器人配置
89
+ ROBOT_HOST=localhost
90
+ ROBOT_WIRELESS=false
91
+
92
+ # 日志
93
+ LOG_LEVEL=INFO
94
+ ```
95
+
96
+ ## 步骤 5: 启动应用
97
+
98
+ ```bash
99
+ # 启动语音助手
100
+ python -m reachy_mini_ha_voice
101
+
102
+ # 或使用自定义配置
103
+ python -m reachy_mini_ha_voice \
104
+ --name "我的 Reachy Mini" \
105
+ --audio-input-device "Reachy Microphone" \
106
+ --audio-output-device "Reachy Speaker" \
107
+ --wake-model okay_nabu
108
+ ```
109
+
110
+ ## 步骤 6: 连接到 Home Assistant
111
+
112
+ 1. 打开 Home Assistant
113
+ 2. 进入 **设置** → **设备与服务**
114
+ 3. 点击 **添加集成**
115
+ 4. 搜索 **ESPHome**
116
+ 5. 点击 **设置另一个 ESPHome 实例**
117
+ 6. 输入 Reachy Mini 的 IP 地址和端口(默认:6053)
118
+ 7. 点击 **提交**
119
+
120
+ ## 步骤 7: 测试
121
+
122
+ 1. 说出唤醒词:**"Okay Nabu"**
123
+ 2. Reachy Mini 应该会点头确认
124
+ 3. 说出您的命令
125
+ 4. Reachy Mini 应该会通过动作和语音回应(如果已配置)
126
+
127
+ ## 故障排除
128
+
129
+ ### 唤醒词未被检测到
130
+
131
+ - 检查唤醒词模型是否已下载:`ls wakewords/`
132
+ - 验证配置中的模型名称与文件匹配
133
+ - 检查麦克风是否工作:`python -m reachy_mini_ha_voice --list-input-devices`
134
+ - 如有需要,增加麦克风音量
135
+
136
+ ### 无音频输出
137
+
138
+ - 检查扬声器是否工作:`python -m reachy_mini_ha_voice --list-output-devices`
139
+ - 验证配置中的音频输出设备名称
140
+ - 检查扬声器音量
141
+
142
+ ### 无法连接到 Home Assistant
143
+
144
+ - 验证网络连接:`ping <home-assistant-ip>`
145
+ - 检查 ESPHome 端口(6053)是否被防火墙阻止
146
+ - 确保已安装 Home Assistant ESPHome 集成
147
+ - 检查 Home Assistant 日志中的连接错误
148
+
149
+ ### 运动不工作
150
+
151
+ - 验证 Reachy Mini 已连接:检查机器人是否响应基本命令
152
+ - 检查配置中的机器人主机
153
+ - 确保 Reachy Mini SDK 已安装:`pip show reachy-mini`
154
+ - 检查机器人未处于睡眠模式
155
+
156
+ ## 高级配置
157
+
158
+ ### 自定义唤醒词
159
+
160
+ 1. 训练您自己的唤醒词模型(参见 wakewords/README.md)
161
+ 2. 将模型文件放在 wakewords/ 目录中
162
+ 3. 更新配置以使用您的模型
163
+
164
+ ### 多个唤醒词
165
+
166
+ ```bash
167
+ # 在 wakewords/ 目录中添加其他唤醒词模型
168
+ # 更新配置以启用多个唤醒词
169
+ ```
170
+
171
+ ### Web 界面
172
+
173
+ ```bash
174
+ # 使用 Gradio Web 界面启动
175
+ python -m reachy_mini_ha_voice --gradio
176
+
177
+ # 访问 http://<reachy-ip>:7860
178
+ ```
179
+
180
+ ### 无线版 Reachy Mini
181
+
182
+ ```bash
183
+ # 用于无线版本
184
+ python -m reachy_mini_ha_voice --wireless
185
+ ```
186
+
187
+ ## 下一步
188
+
189
+ - 阅读完整的 [README_CN.md](README_CN.md) 获取详细文档
190
+ - 查看 [ARCHITECTURE_CN.md](ARCHITECTURE.md) 了解系统架构
191
+ - 查看 [REQUIREMENTS_CN.md](REQUIREMENTS.md) 了解详细需求
192
+ - 探索 [profiles/](profiles/) 进行个性化定制
193
+
194
+ ## 支持
195
+
196
+ - GitHub Issues: https://github.com/yourusername/reachy_mini_ha_voice/issues
197
+ - 文档: https://github.com/yourusername/reachy_mini_ha_voice#readme
198
+ - 社区:加入我们的 Discord 服务器
199
+
200
+ ---
201
+
202
+ **祝您与 Reachy Mini 交谈愉快!** 🤖