andito HF Staff Claude Sonnet 4.6 commited on
Commit
c8a9cee
Β·
1 Parent(s): 3680460

docs: add control interface link and sleeping Space guidance

Browse files

- Add direct link to the control interface in the install page setup
steps (the main gap Matthieu hit β€” page never told users where to go
to actually control the robot)
- Clarify the two URLs: wss:// for robot settings, https:// for browser
- Add sleeping Space note (48h inactivity, wait ~30s before robot connects)
- Fix README Step 4 placeholder URL β†’ actual HF Space URL
- Fix default profile example in README (was showing localhost)
- Add HTTP 429 troubleshooting entry (sleeping Space) to README

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Files changed (2) hide show
  1. README.md +17 -5
  2. index.html +12 -3
README.md CHANGED
@@ -60,13 +60,15 @@ python -m reachy_mini_remote_control_app
60
  python -m reachy_mini_remote_control_app --profile default
61
  ```
62
 
63
- #### Step 4: Control Your Robot
64
 
65
- 1. Visit the central control server: https://YOUR-CENTRAL-SERVER.hf.space
66
- 2. Click "Sign in with Hugging Face" and authorize
67
- 3. Once authenticated, you'll see your robot if it's connected
68
  4. Start controlling your robot through the web interface!
69
 
 
 
70
  ### Legacy Setup (Private Space Cloning)
71
 
72
  If you prefer the old approach of cloning your own space:
@@ -166,7 +168,7 @@ Profiles are stored in `src/reachy_mini_remote_control_app/profiles/`. Each prof
166
 
167
  **Default Profile** (`profiles/default/config.txt`):
168
  ```
169
- WEBSOCKET_URI=ws://localhost:8000
170
  VIDEO_JPEG_QUALITY=80
171
  VIDEO_WITH_TIMESTAMP=false
172
  VIDEO_FPS=25
@@ -392,6 +394,16 @@ Failed to connect to robot: Connection timeout
392
  reachy-mini-daemon --mockup-sim
393
  ```
394
 
 
 
 
 
 
 
 
 
 
 
395
  ### WebSocket connection fails
396
 
397
  ```
 
60
  python -m reachy_mini_remote_control_app --profile default
61
  ```
62
 
63
+ #### Step 4: Open the Control Interface
64
 
65
+ 1. Open the control interface in your browser: https://huggingfacem4-reachy-mini-remote-control.hf.space
66
+ 2. Click "Sign in with Hugging Face" and authorize with the same account you used for the token
67
+ 3. Once authenticated, you'll see your robot listed as connected
68
  4. Start controlling your robot through the web interface!
69
 
70
+ > **Note:** The Space may be asleep if unused for 48+ hours. Open it in your browser first and wait for it to fully load (~30 seconds) before your robot tries to connect.
71
+
72
  ### Legacy Setup (Private Space Cloning)
73
 
74
  If you prefer the old approach of cloning your own space:
 
168
 
169
  **Default Profile** (`profiles/default/config.txt`):
170
  ```
171
+ WEBSOCKET_URI=wss://huggingfacem4-reachy-mini-remote-control.hf.space
172
  VIDEO_JPEG_QUALITY=80
173
  VIDEO_WITH_TIMESTAMP=false
174
  VIDEO_FPS=25
 
394
  reachy-mini-daemon --mockup-sim
395
  ```
396
 
397
+ ### WebSocket connections fail with HTTP 429
398
+
399
+ ```
400
+ [Robot Control] Connection failed: server rejected WebSocket connection: HTTP 429
401
+ ```
402
+
403
+ The control Space is asleep. HF Spaces sleep after 48 hours of inactivity.
404
+
405
+ **Solution**: Open https://huggingfacem4-reachy-mini-remote-control.hf.space in your browser and wait for it to fully load (~30 seconds), then restart the robot app.
406
+
407
  ### WebSocket connection fails
408
 
409
  ```
index.html CHANGED
@@ -141,19 +141,28 @@
141
  <li><strong>Create a Hugging Face account</strong> (free) at <a href="https://huggingface.co/join" target="_blank" style="color: #10b981; text-decoration: underline;">huggingface.co/join</a></li>
142
  <li><strong>Create an access token</strong> at <a href="https://huggingface.co/settings/tokens" target="_blank" style="color: #10b981; text-decoration: underline;">huggingface.co/settings/tokens</a> with 'read' permissions</li>
143
  <li><strong>Install this app</strong> on your Reachy Mini robot</li>
144
- <li><strong>Configure in settings:</strong> Copy the server URI below and paste it along with your token in the app's settings page</li>
145
- <li><strong>Start controlling!</strong> Your connection is secure and isolated from other users</li>
 
146
  </ol>
147
  <p style="margin: 0.75rem 0 0 0; font-size: 0.85rem; color: #9ca3af;">
148
  πŸ”’ <strong>Secure:</strong> Your token authenticates your robot and creates an isolated session. Other users on the same space cannot access your robot's video, audio, or controls.
149
  </p>
 
 
 
150
  </div>
151
 
152
  <div class="connection-info">
153
- <label>Server URI:</label>
154
  <code class="uri-code">wss://huggingfacem4-reachy-mini-remote-control.hf.space</code>
155
  <button class="btn-copy" onclick="copyToClipboard('wss://huggingfacem4-reachy-mini-remote-control.hf.space', this)">πŸ“‹ Copy</button>
156
  </div>
 
 
 
 
 
157
  </div>
158
 
159
  <div class="setup-card">
 
141
  <li><strong>Create a Hugging Face account</strong> (free) at <a href="https://huggingface.co/join" target="_blank" style="color: #10b981; text-decoration: underline;">huggingface.co/join</a></li>
142
  <li><strong>Create an access token</strong> at <a href="https://huggingface.co/settings/tokens" target="_blank" style="color: #10b981; text-decoration: underline;">huggingface.co/settings/tokens</a> with 'read' permissions</li>
143
  <li><strong>Install this app</strong> on your Reachy Mini robot</li>
144
+ <li><strong>Configure in settings:</strong> Copy the Server URI below and paste it along with your token in the app's settings page on your robot</li>
145
+ <li><strong>Open the control interface</strong> in your browser and sign in with your Hugging Face account: <a href="https://huggingfacem4-reachy-mini-remote-control.hf.space" target="_blank" style="color: #10b981; text-decoration: underline;">huggingfacem4-reachy-mini-remote-control.hf.space</a></li>
146
+ <li><strong>Start controlling!</strong> Your robot should appear connected in the interface</li>
147
  </ol>
148
  <p style="margin: 0.75rem 0 0 0; font-size: 0.85rem; color: #9ca3af;">
149
  πŸ”’ <strong>Secure:</strong> Your token authenticates your robot and creates an isolated session. Other users on the same space cannot access your robot's video, audio, or controls.
150
  </p>
151
+ <p style="margin: 0.5rem 0 0 0; font-size: 0.85rem; color: #9ca3af;">
152
+ πŸ’€ <strong>Note:</strong> The control Space may be asleep if it hasn't been used in 48 hours. Open it in your browser first and wait for it to fully load (~30 seconds) before your robot connects.
153
+ </p>
154
  </div>
155
 
156
  <div class="connection-info">
157
+ <label>Server URI (for robot settings):</label>
158
  <code class="uri-code">wss://huggingfacem4-reachy-mini-remote-control.hf.space</code>
159
  <button class="btn-copy" onclick="copyToClipboard('wss://huggingfacem4-reachy-mini-remote-control.hf.space', this)">πŸ“‹ Copy</button>
160
  </div>
161
+ <div class="connection-info" style="margin-top: 0.5rem;">
162
+ <label>Control interface (open in browser):</label>
163
+ <code class="uri-code">https://huggingfacem4-reachy-mini-remote-control.hf.space</code>
164
+ <button class="btn-copy" onclick="copyToClipboard('https://huggingfacem4-reachy-mini-remote-control.hf.space', this)">πŸ“‹ Copy</button>
165
+ </div>
166
  </div>
167
 
168
  <div class="setup-card">