Skip to content

Commit de79f49

Browse files
authored
docs: minor corrections and clean-up (huggingface#1089)
1 parent cbbd4a4 commit de79f49

File tree

3 files changed

+14
-10
lines changed

3 files changed

+14
-10
lines changed

docs/source/assemble_so101.mdx

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,8 @@ Reconnect the usb cable.
9696
#### Update config file
9797

9898
Now that you have your ports, update the **port** default values of [`SO101RobotConfig`](https://github.com/huggingface/lerobot/blob/main/lerobot/common/robot_devices/robots/configs.py).
99-
You will find something like, update the `port` values with your actual motor ports:
100-
```python
99+
You will find a class called `so101` where you can update the `port` values with your actual motor ports:
100+
```diff
101101
@RobotConfig.register_subclass("so101")
102102
@dataclass
103103
class So101RobotConfig(ManipulatorRobotConfig):
@@ -110,7 +110,8 @@ class So101RobotConfig(ManipulatorRobotConfig):
110110
leader_arms: dict[str, MotorsBusConfig] = field(
111111
default_factory=lambda: {
112112
"main": FeetechMotorsBusConfig(
113-
port="/dev/tty.usbmodem58760431091", <-- UPDATE HERE
113+
- port="/dev/tty.usbmodem58760431091",
114+
+ port="{ADD YOUR LEADER PORT}",
114115
motors={
115116
# name: (index, model)
116117
"shoulder_pan": [1, "sts3215"],
@@ -127,7 +128,8 @@ class So101RobotConfig(ManipulatorRobotConfig):
127128
follower_arms: dict[str, MotorsBusConfig] = field(
128129
default_factory=lambda: {
129130
"main": FeetechMotorsBusConfig(
130-
port="/dev/tty.usbmodem585A0076891", <-- UPDATE HERE
131+
- port="/dev/tty.usbmodem585A0076891",
132+
+ port="{ADD YOUR FOLLOWER PORT}",
131133
motors={
132134
# name: (index, model)
133135
"shoulder_pan": [1, "sts3215"],
@@ -297,7 +299,7 @@ Remove all support material from the 3D-printed parts, the easiest way to do thi
297299
##### Wiring
298300

299301
- Attach the motor controller on the back.
300-
- Then insert all wires, use the wire guides everywhere to make sure the wires don't unplug themself and stay in place.
302+
- Then insert all wires, use the wire guides everywhere to make sure the wires don't unplug themselves and stay in place.
301303

302304
<div class="video-container">
303305
<video controls width="600">

docs/source/getting_started_real_world_robot.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ camera_01_frame_000047.png
8383

8484
Note: Some cameras may take a few seconds to warm up, and the first frame might be black or green.
8585

86-
Now that you have the camera indexes, you should specify the camera's in the config. TODO(pepijn): add more info about setting camera config, rotate etc..
86+
Now that you have the camera indexes, you should specify the camera's in the config.
8787

8888
### Use your phone
8989
<hfoptions id="use phone">
@@ -152,7 +152,7 @@ If everything is set up correctly, you can proceed with the rest of the tutorial
152152

153153
## Teleoperate with cameras
154154

155-
We can now teleoperate again while at the same time visualizing the camera's and joint positions with `rerun`.
155+
We can now teleoperate again while at the same time visualizing the cameras and joint positions with `rerun`.
156156

157157
```bash
158158
python lerobot/scripts/control_robot.py \

examples/12_use_so101.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ Reconnect the usb cable.
146146

147147
Now that you have your ports, update the **port** default values of [`SO101RobotConfig`](https://github.com/huggingface/lerobot/blob/main/lerobot/common/robot_devices/robots/configs.py).
148148
You will find something a class called `so101` where you can update the `port` values with your actual motor ports:
149-
```python
149+
```diff
150150
@RobotConfig.register_subclass("so101")
151151
@dataclass
152152
class So101RobotConfig(ManipulatorRobotConfig):
@@ -159,7 +159,8 @@ class So101RobotConfig(ManipulatorRobotConfig):
159159
leader_arms: dict[str, MotorsBusConfig] = field(
160160
default_factory=lambda: {
161161
"main": FeetechMotorsBusConfig(
162-
port="/dev/tty.usbmodem58760431091", <-- UPDATE HERE
162+
- port="/dev/tty.usbmodem58760431091",
163+
+ port="{ADD YOUR LEADER PORT}",
163164
motors={
164165
# name: (index, model)
165166
"shoulder_pan": [1, "sts3215"],
@@ -176,7 +177,8 @@ class So101RobotConfig(ManipulatorRobotConfig):
176177
follower_arms: dict[str, MotorsBusConfig] = field(
177178
default_factory=lambda: {
178179
"main": FeetechMotorsBusConfig(
179-
port="/dev/tty.usbmodem585A0076891", <-- UPDATE HERE
180+
- port="/dev/tty.usbmodem585A0076891",
181+
+ port="{ADD YOUR FOLLOWER PORT}",
180182
motors={
181183
# name: (index, model)
182184
"shoulder_pan": [1, "sts3215"],

0 commit comments

Comments
 (0)