Spaces:
Running
Running
docs: clean up readme
Browse files
README.md
CHANGED
|
@@ -1,63 +1,18 @@
|
|
| 1 |
-
#
|
| 2 |
|
| 3 |
-
|
| 4 |
|
| 5 |
## Install
|
| 6 |
|
| 7 |
```bash
|
| 8 |
-
#
|
| 9 |
-
npm install -g lerobot
|
| 10 |
-
|
| 11 |
-
# Web library
|
| 12 |
npm install @lerobot/web
|
| 13 |
-
```
|
| 14 |
-
|
| 15 |
-
## CLI Usage
|
| 16 |
-
|
| 17 |
-
```bash
|
| 18 |
-
# Find hardware
|
| 19 |
-
lerobot find-port
|
| 20 |
|
| 21 |
-
#
|
| 22 |
-
|
| 23 |
-
|
| 24 |
-
# Show help
|
| 25 |
-
lerobot --help
|
| 26 |
```
|
| 27 |
|
| 28 |
-
##
|
| 29 |
-
|
| 30 |
-
```typescript
|
| 31 |
-
import { findPort, calibrate, teleoperate } from "@lerobot/web";
|
| 32 |
-
|
| 33 |
-
// Find and connect to hardware
|
| 34 |
-
const devices = await findPort();
|
| 35 |
-
const robot = devices[0];
|
| 36 |
-
|
| 37 |
-
// Calibrate
|
| 38 |
-
const calibration = await calibrate(robot);
|
| 39 |
-
await calibration.result;
|
| 40 |
-
|
| 41 |
-
// Control
|
| 42 |
-
const controller = await teleoperate(robot);
|
| 43 |
-
controller.start();
|
| 44 |
-
```
|
| 45 |
-
|
| 46 |
-
## Hardware Support
|
| 47 |
-
|
| 48 |
-
- **SO-100**: Follower/leader robot arms
|
| 49 |
-
- **WebSerial API**: Chrome/Edge 89+, HTTPS required
|
| 50 |
-
- **Node.js**: Cross-platform serial port access
|
| 51 |
-
|
| 52 |
-
## Demo
|
| 53 |
-
|
| 54 |
-
```bash
|
| 55 |
-
git clone https://github.com/timpietrusky/lerobot.js
|
| 56 |
-
cd lerobot.js && npm install && npm run dev
|
| 57 |
-
```
|
| 58 |
-
|
| 59 |
-
Visit `http://localhost:5173` for the web interface.
|
| 60 |
-
|
| 61 |
-
## License
|
| 62 |
|
| 63 |
-
|
|
|
|
|
|
| 1 |
+
# LeRobot.js
|
| 2 |
|
| 3 |
+
> interact with your robot in JS, inspired by [LeRobot](https://github.com/huggingface/lerobot)
|
| 4 |
|
| 5 |
## Install
|
| 6 |
|
| 7 |
```bash
|
| 8 |
+
# Web library (available now)
|
|
|
|
|
|
|
|
|
|
| 9 |
npm install @lerobot/web
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 10 |
|
| 11 |
+
# Node.js library (coming soon)
|
| 12 |
+
# npm install @lerobot/node
|
|
|
|
|
|
|
|
|
|
| 13 |
```
|
| 14 |
|
| 15 |
+
## Resources
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 16 |
|
| 17 |
+
- **📖 Documentation**: See [`@lerobot/web` README](./packages/web/README.md) for complete API reference
|
| 18 |
+
- **🚀 Live Demo**: Try it online at [huggingface.co/spaces/NERDDISCO/LeRobot.js](https://huggingface.co/spaces/NERDDISCO/LeRobot.js)
|