From ef11c036adcf5b0b2eeef3212b788113849c0494 Mon Sep 17 00:00:00 2001 From: Huang Zhenbiao Date: Fri, 20 Sep 2024 15:39:50 +0800 Subject: [PATCH] update README.md --- commands/joystick_input/{readme.md => README.md} | 7 ++++++- commands/keyboard_input/{readme.md => README.md} | 8 +++++++- descriptions/go2_description/README.md | 5 +++++ descriptions/quadruped_gazebo/README.md | 7 ++++++- hardwares/hardware_unitree_mujoco/README.md | 8 +++++++- 5 files changed, 31 insertions(+), 4 deletions(-) rename commands/joystick_input/{readme.md => README.md} (76%) rename commands/keyboard_input/{readme.md => README.md} (76%) diff --git a/commands/joystick_input/readme.md b/commands/joystick_input/README.md similarity index 76% rename from commands/joystick_input/readme.md rename to commands/joystick_input/README.md index 123ea36..e8a64de 100644 --- a/commands/joystick_input/readme.md +++ b/commands/joystick_input/README.md @@ -2,6 +2,11 @@ This node will listen to the joystick topic and publish a control_input_msgs/Input message. +Tested environment: +* Ubuntu 24.04 + * ROS2 Jazzy + * Logitech F310 Gamepad + ```bash cd ~/ros2_ws colcon build --packages-up-to joystick_input @@ -12,7 +17,7 @@ source ~/ros2_ws/install/setup.bash ros2 launch joystick_input joystick.launch.py ``` -## 1. Use Instructions +## 1. Use Instructions for Unitree Guide ### 1.1 Control Mode diff --git a/commands/keyboard_input/readme.md b/commands/keyboard_input/README.md similarity index 76% rename from commands/keyboard_input/readme.md rename to commands/keyboard_input/README.md index b60978c..9a5a68d 100644 --- a/commands/keyboard_input/readme.md +++ b/commands/keyboard_input/README.md @@ -2,6 +2,12 @@ This node will read the keyboard input and publish a control_input_msgs/Input message. +Tested environment: +* Ubuntu 24.04 + * ROS2 Jazzy +* Ubuntu 22.04 + * ROS2 Humble + ```bash cd ~/ros2_ws colcon build --packages-up-to keyboard_input @@ -12,7 +18,7 @@ source ~/ros2_ws/install/setup.bash ros2 run keyboard_input keyboard_input ``` -## 1. Use Instructions +## 1. Use Instructions for Unitree Guide ### 1.1 Control Mode * Passive Mode: Keyboard 1 * Fixed Stand: Keyboard 2 diff --git a/descriptions/go2_description/README.md b/descriptions/go2_description/README.md index b471c8b..bd35bff 100644 --- a/descriptions/go2_description/README.md +++ b/descriptions/go2_description/README.md @@ -1,6 +1,11 @@ # Unitree Go2 Description This repository contains the urdf model of go2. +Tested environment: +* Ubuntu 24.04 + * ROS2 Jazzy +* Ubuntu 22.04 + * ROS2 Humble ## Build ```bash diff --git a/descriptions/quadruped_gazebo/README.md b/descriptions/quadruped_gazebo/README.md index d218644..c29b4a9 100644 --- a/descriptions/quadruped_gazebo/README.md +++ b/descriptions/quadruped_gazebo/README.md @@ -1,6 +1,11 @@ # Quadruped Gazebo -This package contains the description of the legged robot from Unitree Robotics, and the launch file to load them into the gazebo empty world. +This package contains the description of the quadruped robot from Unitree Robotics, and the launch file to load them into the gazebo empty world. + +Tested environment: +* Ubuntu 24.04 + * ROS2 Jazzy + * Gazebo Harmonic ## Build ```bash diff --git a/hardwares/hardware_unitree_mujoco/README.md b/hardwares/hardware_unitree_mujoco/README.md index e9ad656..95eecb3 100644 --- a/hardwares/hardware_unitree_mujoco/README.md +++ b/hardwares/hardware_unitree_mujoco/README.md @@ -4,7 +4,13 @@ This package contains the hardware interface based on [unitree_sdk2](https://git In theory, it also can communicate with real robot, but it is not tested yet. You can use go2 simulation in [unitree_mujoco](https://github.com/unitreerobotics/unitree_mujoco). -* build +Tested environment: +* Ubuntu 24.04 + * ROS2 Jazzy +* Ubuntu 22.04 + * ROS2 Humble + +Build Command: ```bash cd ~/ros2_ws colcon build --packages-up-to hardware_unitree_mujoco