Spaces:
Running
Running
docs: use proper naming for everything
Browse files
examples/cyberpunk-standalone/src/components/docs-section.tsx
CHANGED
@@ -228,6 +228,28 @@ const findProcess = await findPort({
|
|
228 |
calibrationProcess.stop(); // Stop range recording
|
229 |
const calibrationData = await calibrationProcess.result;`}
|
230 |
</CodeBlock>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
231 |
<div className="mt-3">
|
232 |
<h5 className="font-bold text-sm text-muted-foreground tracking-wider">
|
233 |
Returns:{" "}
|
@@ -272,6 +294,45 @@ const directTeleop = await teleoperate({
|
|
272 |
teleop: { type: "direct" },
|
273 |
});`}
|
274 |
</CodeBlock>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
275 |
<div className="mt-3">
|
276 |
<h5 className="font-bold text-sm text-muted-foreground tracking-wider">
|
277 |
Returns:{" "}
|
@@ -320,7 +381,7 @@ await releaseMotors(robot, [1, 2, 3]);`}
|
|
320 |
</CodeBlock>
|
321 |
<div className="mt-3">
|
322 |
<h5 className="font-bold text-sm text-muted-foreground tracking-wider">
|
323 |
-
|
324 |
</h5>
|
325 |
<ul className="mt-1 ml-4 space-y-1 text-sm text-muted-foreground">
|
326 |
<li>
|
|
|
228 |
calibrationProcess.stop(); // Stop range recording
|
229 |
const calibrationData = await calibrationProcess.result;`}
|
230 |
</CodeBlock>
|
231 |
+
<div className="mt-3">
|
232 |
+
<h5 className="font-bold text-sm text-muted-foreground tracking-wider">
|
233 |
+
Options
|
234 |
+
</h5>
|
235 |
+
<ul className="mt-1 ml-4 space-y-1 text-sm text-muted-foreground">
|
236 |
+
<li>
|
237 |
+
• <code>robot: RobotConnection</code> - Connected robot from
|
238 |
+
findPort()
|
239 |
+
</li>
|
240 |
+
<li>
|
241 |
+
• <code>onProgress?: (message: string) => void</code> -
|
242 |
+
Progress messages callback
|
243 |
+
</li>
|
244 |
+
<li>
|
245 |
+
•{" "}
|
246 |
+
<code>
|
247 |
+
onLiveUpdate?: (data: LiveCalibrationData) => void
|
248 |
+
</code>{" "}
|
249 |
+
- Real-time position updates
|
250 |
+
</li>
|
251 |
+
</ul>
|
252 |
+
</div>
|
253 |
<div className="mt-3">
|
254 |
<h5 className="font-bold text-sm text-muted-foreground tracking-wider">
|
255 |
Returns:{" "}
|
|
|
294 |
teleop: { type: "direct" },
|
295 |
});`}
|
296 |
</CodeBlock>
|
297 |
+
<div className="mt-3">
|
298 |
+
<h5 className="font-bold text-sm text-muted-foreground tracking-wider">
|
299 |
+
Options
|
300 |
+
</h5>
|
301 |
+
<ul className="mt-1 ml-4 space-y-1 text-sm text-muted-foreground">
|
302 |
+
<li>
|
303 |
+
• <code>robot: RobotConnection</code> - Connected robot from
|
304 |
+
findPort()
|
305 |
+
</li>
|
306 |
+
<li>
|
307 |
+
• <code>teleop: TeleoperatorConfig</code> - Teleoperator
|
308 |
+
configuration:
|
309 |
+
<ul className="mt-1 ml-4 space-y-1">
|
310 |
+
<li>
|
311 |
+
• <code>{`{ type: "keyboard" }`}</code> - Keyboard
|
312 |
+
control
|
313 |
+
</li>
|
314 |
+
<li>
|
315 |
+
• <code>{`{ type: "direct" }`}</code> - Direct
|
316 |
+
programmatic control
|
317 |
+
</li>
|
318 |
+
</ul>
|
319 |
+
</li>
|
320 |
+
<li>
|
321 |
+
•{" "}
|
322 |
+
<code>
|
323 |
+
calibrationData?: {`{ [motorName: string]: any }`}
|
324 |
+
</code>{" "}
|
325 |
+
- Calibration data from calibrate()
|
326 |
+
</li>
|
327 |
+
<li>
|
328 |
+
•{" "}
|
329 |
+
<code>
|
330 |
+
onStateUpdate?: (state: TeleoperationState) => void
|
331 |
+
</code>{" "}
|
332 |
+
- State change callback
|
333 |
+
</li>
|
334 |
+
</ul>
|
335 |
+
</div>
|
336 |
<div className="mt-3">
|
337 |
<h5 className="font-bold text-sm text-muted-foreground tracking-wider">
|
338 |
Returns:{" "}
|
|
|
381 |
</CodeBlock>
|
382 |
<div className="mt-3">
|
383 |
<h5 className="font-bold text-sm text-muted-foreground tracking-wider">
|
384 |
+
Options
|
385 |
</h5>
|
386 |
<ul className="mt-1 ml-4 space-y-1 text-sm text-muted-foreground">
|
387 |
<li>
|
packages/web/README.md
CHANGED
@@ -176,7 +176,7 @@ const calibrationData = await calibrationProcess.result;
|
|
176 |
// Save calibration data to localStorage or file
|
177 |
```
|
178 |
|
179 |
-
####
|
180 |
|
181 |
- `config: CalibrateConfig`
|
182 |
- `robot: RobotConnection` - Connected robot from `findPort()`
|
@@ -263,7 +263,7 @@ await directController.setMotorPositions({
|
|
263 |
setTimeout(() => directTeleop.stop(), 30000);
|
264 |
```
|
265 |
|
266 |
-
####
|
267 |
|
268 |
- `config: TeleoperateConfig`
|
269 |
- `robot: RobotConnection` - Connected robot from `findPort()`
|
@@ -307,7 +307,7 @@ await releaseMotors(robot);
|
|
307 |
await releaseMotors(robot, [1, 2, 3]);
|
308 |
```
|
309 |
|
310 |
-
####
|
311 |
|
312 |
- `robot: RobotConnection` - Connected robot
|
313 |
- `motorIds?: number[]` - Specific motor IDs (default: all motors for robot type)
|
|
|
176 |
// Save calibration data to localStorage or file
|
177 |
```
|
178 |
|
179 |
+
#### Options
|
180 |
|
181 |
- `config: CalibrateConfig`
|
182 |
- `robot: RobotConnection` - Connected robot from `findPort()`
|
|
|
263 |
setTimeout(() => directTeleop.stop(), 30000);
|
264 |
```
|
265 |
|
266 |
+
#### Options
|
267 |
|
268 |
- `config: TeleoperateConfig`
|
269 |
- `robot: RobotConnection` - Connected robot from `findPort()`
|
|
|
307 |
await releaseMotors(robot, [1, 2, 3]);
|
308 |
```
|
309 |
|
310 |
+
#### Options
|
311 |
|
312 |
- `robot: RobotConnection` - Connected robot
|
313 |
- `motorIds?: number[]` - Specific motor IDs (default: all motors for robot type)
|