Skip to content

Commit ae5a74e

Browse files
committed
update README for Lite3
1 parent 00fa458 commit ae5a74e

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

src/Lite3_sdk_deploy/README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Lite3 SDK Deploy
22

3-
[![Discord](https://img.shields.io/badge/-Discord-5865F2?style=flat&logo=Discord&logoColor=white)](https://discord.gg/gdM9mQutC8)
4-
3+
[![Discord](https://img.shields.io/badge/-Discord-5865F2?style=flat&logo=Discord&logoColor=white)](https://discord.gg/gdM9mQutC8)
4+
## Note
5+
<span style="color: red;">**SDK deployment is only available for Lite 3 Venture Edition.**</span>
56
## Overview
6-
77
This repository uses ROS2 to implement the entire Sim-to-sim and Sim-to-real workflow. Therefore, ROS2 must first be installed on your computer, such as installing [ROS2 Humble](https://docs.ros.org/en/humble/index.html) on Ubuntu 22.04.
88
Keyboard controls, the process is as follows:
99
```mermaid
@@ -115,10 +115,11 @@ python3 src/Lite3_sdk_deploy/interface/robot/simulation/mujoco_simulation_ros2.p
115115
> - qe:clockwise/counter clockwise
116116
117117
## Sim-to-real
118-
<span style="color: red;">**Before proceeding with this step, verify the version of your Lite3 system image. Ensure the image has ROS 2 and the transfer functionality package installed. If the image has not been upgraded, please contact your technical support.**</span>
118+
**Before proceeding with this step, verify the version of your Lite3 system image. Ensure the image has ROS 2 and the transfer functionality package installed. If the image has not been upgraded, please contact your technical support.**
119119
The default controller mode is currently set to keyboard mode. To switch to gamepad control, modify `RemoteCommandType::kKeyBoard` to `RemoteCommandType::kRetroidGamepad` in `main.cpp`.
120120
### SDK Mode Activation and Switching
121-
<span style="color: red;">**Note:ensure Lite3 switches modes while in a safe state such as idle; failure to do so may result in machine damage or personal injury.**</span>
121+
<span style="color: red;">**Warning: Ensure Lite3 switches modes while in a safe state such as idle; failure to do so may result in machine damage or personal injury.**</span>
122+
<span style="color: red;">**Warning: Switching states requires processing time. After pressing the slider, please wait for approximately 10 seconds. Then manually rotate the joint to ensure it moves freely without resistance and is not in damping mode. Only then proceed with standing up or walking. Failure to do so may cause dangerous situations such as the Lite3 suddenly jumping up or dashing forward.**</span>
122123
> - Click the slider to the right of SDK Mode. When the slider turns blue, it indicates that SDK Mode is enabled. Lite3 will automatically perform a zero-reset. On the contrary,SDK mode will become inactive, and the system will switch to MPC mode.
123124
<img src="../../img/Lite3_switch_mode.png" alt="Click slider to switch mode in Retroid gamepad" width="500">
124125
### SSH connection

0 commit comments

Comments
 (0)