Browse Source

[update] README

main
silencht 4 months ago
parent
commit
997bf3a9c5
  1. 23
      README.md
  2. 23
      README_zh-CN.md

23
README.md

@ -233,7 +233,13 @@ build cert.pem key.pem LICENSE pyproject.toml README.md rootCA.key rootCA
| `--record` | **Enable data recording mode** Press **r** to start teleoperation, then **s** to start recording; press **s** again to stop and save the episode. Press **s** repeatedly to repeat the process. | | `--record` | **Enable data recording mode** Press **r** to start teleoperation, then **s** to start recording; press **s** again to stop and save the episode. Press **s** repeatedly to repeat the process. |
| `--task-*` | Configure the save path, target, description, and steps of the recorded task. | | `--task-*` | Configure the save path, target, description, and steps of the recorded task. |
## 1.4 🔄 State Transition Diagram
<p align="center">
<a href="https://oss-global-cdn.unitree.com/static/712c312b0ac3401f8d7d9001b1e14645_11655x4305.jpg">
<img src="https://oss-global-cdn.unitree.com/static/712c312b0ac3401f8d7d9001b1e14645_11655x4305.jpg" alt="System Diagram" style="width: 85%;">
</a>
</p>
# 2. 💻 Simulation Deployment # 2. 💻 Simulation Deployment
@ -436,20 +442,13 @@ If two hands open and close continuously, it indicates success. Once successful,
## 3.3 ✋ BrainCo Hand Service (Optional) ## 3.3 ✋ BrainCo Hand Service (Optional)
Please refer to the [official documentation](https://support.unitree.com/home/en/G1_developer/brainco_hand) for setup instructions.
After installation, you need to manually start the services for both dexterous hands. Example commands are shown below (note: the serial port names may vary depending on your system):
```bash
# Terminal 1.
sudo ./brainco_hand --id 126 --serial /dev/ttyUSB1
# Terminal 2.
sudo ./brainco_hand --id 127 --serial /dev/ttyUSB2
```
Please refer to the [Repo README](https://github.com/unitreerobotics/brainco_hand_service) for setup instructions.
## 3.4 ✋ Unitree Dex1_1 Service (Optional)
Please refer to the [Repo README](https://github.com/unitreerobotics/dex1_1_service) for setup instructions.
## 3.4 🚀 Launch
## 3.5 🚀 Launch
> ![Warning](https://img.shields.io/badge/Warning-Important-red) > ![Warning](https://img.shields.io/badge/Warning-Important-red)
> >
@ -465,7 +464,7 @@ sudo ./brainco_hand --id 127 --serial /dev/ttyUSB2
Same as simulation but follow the safety warnings above. Same as simulation but follow the safety warnings above.
## 3.5 🔚 Exit
## 3.6 🔚 Exit
> ![Warning](https://img.shields.io/badge/Warning-Important-red) > ![Warning](https://img.shields.io/badge/Warning-Important-red)
> >

23
README_zh-CN.md

@ -247,6 +247,13 @@ build cert.pem key.pem LICENSE pyproject.toml README.md rootCA.key rootCA
| `--task-*` | 此类参数可配置录制的文件保存路径,任务目标、描述、步骤等信息 | | `--task-*` | 此类参数可配置录制的文件保存路径,任务目标、描述、步骤等信息 |
## 1.4 🔄 状态转移图
<p align="center">
<a href="https://oss-global-cdn.unitree.com/static/09859bdfb48f4b70b51764710381cb49_10805x4235.jpg">
<img src="https://oss-global-cdn.unitree.com/static/09859bdfb48f4b70b51764710381cb49_10805x4235.jpg" alt="System Diagram" style="width: 85%;">
</a>
</p>
------ ------
@ -464,20 +471,16 @@ unitree@PC2:~/DFX_inspire_service/build$ ./hand_example
如果两只手连续打开和关闭,则表示成功。一旦成功,即可关闭终端 2 中的 `./hand_example` 程序。 如果两只手连续打开和关闭,则表示成功。一旦成功,即可关闭终端 2 中的 `./hand_example` 程序。
## 3.3 ✋BrainCo 手部服务(可选)
## 3.3 ✋ BrainCo 手部服务(可选)
请参考[官方文档](https://support.unitree.com/home/zh/G1_developer/brainco_hand)。安装完毕后,请手动启动两个灵巧手的服务,命令示例如下(串口名称可能与实际有所差别):
请参考[仓库文档](https://github.com/unitreerobotics/brainco_hand_service)。
```bash
# Terminal 1.
sudo ./brainco_hand --id 126 --serial /dev/ttyUSB1
# Terminal 2.
sudo ./brainco_hand --id 127 --serial /dev/ttyUSB2
```
## 3.4 ✋ Unitree Dex1_1 服务(可选)
请参考[仓库文档](https://github.com/unitreerobotics/dex1_1_service)。
## 3.4 🚀 启动遥操
## 3.5 🚀 启动遥操
> ![Warning](https://img.shields.io/badge/Warning-Important-red) > ![Warning](https://img.shields.io/badge/Warning-Important-red)
> >
@ -492,7 +495,7 @@ sudo ./brainco_hand --id 127 --serial /dev/ttyUSB2
与仿真部署基本一致,但要注意上述警告事项。 与仿真部署基本一致,但要注意上述警告事项。
## 3.5 🔚 退出
## 3.6 🔚 退出
> ![Warning](https://img.shields.io/badge/Warning-Important-red) > ![Warning](https://img.shields.io/badge/Warning-Important-red)
> >

Loading…
Cancel
Save