Mentioning the sdk (#140)
Browse files
README.md
CHANGED
|
@@ -21,6 +21,7 @@ The app follows a layered architecture connecting the user, AI services, and rob
|
|
| 21 |
## Installation
|
| 22 |
|
| 23 |
> [!IMPORTANT]
|
|
|
|
| 24 |
> Windows support is currently experimental and has not been extensively tested. Use with caution.
|
| 25 |
|
| 26 |
### Using uv
|
|
@@ -146,6 +147,15 @@ By default, the app runs in console mode for direct audio interaction. Use the `
|
|
| 146 |
reachy-mini-conversation-app --no-camera
|
| 147 |
```
|
| 148 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 149 |
## LLM tools exposed to the assistant
|
| 150 |
|
| 151 |
| Tool | Action | Dependencies |
|
|
|
|
| 21 |
## Installation
|
| 22 |
|
| 23 |
> [!IMPORTANT]
|
| 24 |
+
> Before using this app, you need to install [Reachy Mini's SDK](https://github.com/pollen-robotics/reachy_mini/).<br>
|
| 25 |
> Windows support is currently experimental and has not been extensively tested. Use with caution.
|
| 26 |
|
| 27 |
### Using uv
|
|
|
|
| 147 |
reachy-mini-conversation-app --no-camera
|
| 148 |
```
|
| 149 |
|
| 150 |
+
### Troubleshooting
|
| 151 |
+
|
| 152 |
+
- Timeout error:
|
| 153 |
+
If you get an error like this:
|
| 154 |
+
```bash
|
| 155 |
+
TimeoutError: Timeout while waiting for connection with the server.
|
| 156 |
+
```
|
| 157 |
+
It probably means that the Reachy Mini's daemon isn't running. Install [Reachy Mini's SDK](https://github.com/pollen-robotics/reachy_mini/) and start the daemon.
|
| 158 |
+
|
| 159 |
## LLM tools exposed to the assistant
|
| 160 |
|
| 161 |
| Tool | Action | Dependencies |
|