Update README.md
Browse files
README.md
CHANGED
|
@@ -1,14 +1,70 @@
|
|
| 1 |
---
|
| 2 |
-
title: Reachy Mini
|
| 3 |
-
emoji:
|
| 4 |
-
colorFrom:
|
| 5 |
-
colorTo:
|
| 6 |
sdk: gradio
|
| 7 |
sdk_version: 5.49.1
|
| 8 |
app_file: app.py
|
| 9 |
pinned: false
|
| 10 |
license: apache-2.0
|
| 11 |
-
short_description:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 12 |
---
|
| 13 |
|
| 14 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
|
|
|
|
|
| 1 |
---
|
| 2 |
+
title: Reachy Mini Remote Control (Multi-User)
|
| 3 |
+
emoji: 🤖
|
| 4 |
+
colorFrom: blue
|
| 5 |
+
colorTo: indigo
|
| 6 |
sdk: gradio
|
| 7 |
sdk_version: 5.49.1
|
| 8 |
app_file: app.py
|
| 9 |
pinned: false
|
| 10 |
license: apache-2.0
|
| 11 |
+
short_description: Remote control for Reachy Mini robots with authentication
|
| 12 |
+
hf_oauth: true
|
| 13 |
+
hf_oauth_expiration_minutes: 480
|
| 14 |
+
---
|
| 15 |
+
|
| 16 |
+
## Multi-User Remote Control for Reachy Mini
|
| 17 |
+
|
| 18 |
+
This Space provides a centralized remote control server for Reachy Mini robots with HuggingFace OAuth authentication. Multiple users can connect their own robots and control them securely.
|
| 19 |
+
|
| 20 |
+
### Features
|
| 21 |
+
|
| 22 |
+
- **Multi-user support**: Each user can connect their own robot
|
| 23 |
+
- **Secure authentication**: Uses HuggingFace OAuth tokens
|
| 24 |
+
- **Real-time video streaming**: Live camera feed from your robot
|
| 25 |
+
- **Bidirectional audio**: Talk to and hear from your robot
|
| 26 |
+
- **Robot state monitoring**: View joint positions and status
|
| 27 |
+
|
| 28 |
+
### How to Use
|
| 29 |
+
|
| 30 |
+
#### 1. For Robot Owners
|
| 31 |
+
|
| 32 |
+
Set up your robot to connect to this Space:
|
| 33 |
+
|
| 34 |
+
```bash
|
| 35 |
+
# Set your HuggingFace token
|
| 36 |
+
export HF_TOKEN=hf_your_token_here
|
| 37 |
+
|
| 38 |
+
# Configure the robot app to point to this Space
|
| 39 |
+
# Edit your profile config to set:
|
| 40 |
+
# WEBSOCKET_URI=wss://YOUR-SPACE-NAME.hf.space
|
| 41 |
+
|
| 42 |
+
# Start the remote control app
|
| 43 |
+
python -m reachy_mini_remote_control_app
|
| 44 |
+
```
|
| 45 |
+
|
| 46 |
+
#### 2. For Browser Users
|
| 47 |
+
|
| 48 |
+
1. Visit this Space and click "Sign in with Hugging Face"
|
| 49 |
+
2. Authorize the application
|
| 50 |
+
3. Once authenticated, you'll see your robot if it's connected
|
| 51 |
+
4. Control your robot through the web interface
|
| 52 |
+
|
| 53 |
+
### Security
|
| 54 |
+
|
| 55 |
+
- Each user can only see and control their own robots
|
| 56 |
+
- Authentication is required for all connections
|
| 57 |
+
- Tokens are validated with HuggingFace API
|
| 58 |
+
- User sessions are isolated from each other
|
| 59 |
+
|
| 60 |
+
### Requirements
|
| 61 |
+
|
| 62 |
+
Your robot must:
|
| 63 |
+
- Be running the `reachy_mini_remote_control_app`
|
| 64 |
+
- Have your HuggingFace token configured (`HF_TOKEN` environment variable)
|
| 65 |
+
- Be configured to connect to this Space's WebSocket URL
|
| 66 |
+
|
| 67 |
---
|
| 68 |
|
| 69 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
| 70 |
+
|