From 5e479b1b245d379ada9de565e1f53f974bebdd0c Mon Sep 17 00:00:00 2001 From: ob-yalian Date: Mon, 1 Dec 2025 10:20:52 +0800 Subject: [PATCH] Enhance installation documentation by adding missing dependencies. --- .../2_installation/build_the_package.md | 41 ++++++++----------- docs/en/source/3_quickstarts/quickstart.md | 5 +++ .../2_installation/build_the_package.md | 32 +++++++-------- docs/zh/source/3_quickstarts/quickstart.md | 6 ++- 4 files changed, 43 insertions(+), 41 deletions(-) diff --git a/docs/en/source/2_installation/build_the_package.md b/docs/en/source/2_installation/build_the_package.md index 81470d1f..3dfde7a2 100644 --- a/docs/en/source/2_installation/build_the_package.md +++ b/docs/en/source/2_installation/build_the_package.md @@ -6,6 +6,22 @@ Install ROS 2 according to the official guide: * [ROS 2 installation (Ubuntu)](https://docs.ros.org/en/humble/Installation/Ubuntu-Install-Debians.html) +Install dependencies: + +```bash +sudo apt install libgflags-dev nlohmann-json3-dev \ +ros-$ROS_DISTRO-image-transport ros-${ROS_DISTRO}-image-transport-plugins ros-${ROS_DISTRO}-compressed-image-transport \ +ros-$ROS_DISTRO-image-publisher ros-$ROS_DISTRO-camera-info-manager \ +ros-$ROS_DISTRO-diagnostic-updater ros-$ROS_DISTRO-diagnostic-msgs ros-$ROS_DISTRO-statistics-msgs ros-$ROS_DISTRO-xacro \ +ros-$ROS_DISTRO-backward-ros libdw-dev libssl-dev +``` + +Enable ROS 2 auto-completion: + +```bash +eval "$(register-python-argcomplete3 ros2)" +eval "$(register-python-argcomplete3 colcon)" +``` #### Linux Binary Package Installation Check available packages: @@ -27,18 +43,7 @@ After installation, you can use it directly without compilation. ### Build from Source -#### Environment - -Install ROS 2 according to the official guide: - -* [ROS 2 installation (Ubuntu)](https://docs.ros.org/en/humble/Installation/Ubuntu-Install-Debians.html) - -Enable ROS 2 auto-completion: - -```bash -eval "$(register-python-argcomplete3 ros2)" -eval "$(register-python-argcomplete3 colcon)" -``` +#### Linux ROS2 Wrapper Compilation Create a `colcon` workspace: @@ -46,8 +51,6 @@ Create a `colcon` workspace: mkdir -p ~/ros2_ws/src ``` -#### Linux ROS2 Wrapper Compilation - Clone source and checkout `v2-main` branch: ```bash @@ -57,16 +60,6 @@ cd OrbbecSDK_ROS2 git checkout v2-main ``` -Install dependencies: - -```bash -sudo apt install libgflags-dev nlohmann-json3-dev \ -ros-$ROS_DISTRO-image-transport ros-${ROS_DISTRO}-image-transport-plugins ros-${ROS_DISTRO}-compressed-image-transport \ -ros-$ROS_DISTRO-image-publisher ros-$ROS_DISTRO-camera-info-manager \ -ros-$ROS_DISTRO-diagnostic-updater ros-$ROS_DISTRO-diagnostic-msgs ros-$ROS_DISTRO-statistics-msgs ros-$ROS_DISTRO-xacro \ -ros-$ROS_DISTRO-backward-ros libdw-dev libssl-dev -``` - Build: ```bash diff --git a/docs/en/source/3_quickstarts/quickstart.md b/docs/en/source/3_quickstarts/quickstart.md index 0f255589..2d5c263c 100644 --- a/docs/en/source/3_quickstarts/quickstart.md +++ b/docs/en/source/3_quickstarts/quickstart.md @@ -19,6 +19,11 @@ Make sure ROS 2 and your workspace environment are sourced: ```bash source /opt/ros/$ROS_DISTRO/setup.bash +``` + +Source code build requirements + +```bash source ~/ros2_ws/install/setup.bash ``` diff --git a/docs/zh/source/2_installation/build_the_package.md b/docs/zh/source/2_installation/build_the_package.md index c7d50d1f..a2adf04e 100644 --- a/docs/zh/source/2_installation/build_the_package.md +++ b/docs/zh/source/2_installation/build_the_package.md @@ -4,6 +4,16 @@ * [ROS 2 安装指南(Ubuntu)](https://docs.ros.org/en/humble/Installation/Ubuntu-Install-Debians.html) +安装依赖项: + +```bash +sudo apt install libgflags-dev nlohmann-json3-dev \ +ros-$ROS_DISTRO-image-transport ros-${ROS_DISTRO}-image-transport-plugins ros-${ROS_DISTRO}-compressed-image-transport \ +ros-$ROS_DISTRO-image-publisher ros-$ROS_DISTRO-camera-info-manager \ +ros-$ROS_DISTRO-diagnostic-updater ros-$ROS_DISTRO-diagnostic-msgs ros-$ROS_DISTRO-statistics-msgs ros-$ROS_DISTRO-xacro \ +ros-$ROS_DISTRO-backward-ros libdw-dev libssl-dev +``` + 启用 ROS 2 自动补全: ```bash @@ -11,12 +21,6 @@ eval "$(register-python-argcomplete3 ros2)" eval "$(register-python-argcomplete3 colcon)" ``` -创建 `colcon` 工作空间: - -```bash -mkdir -p ~/ros2_ws/src -``` - ### 二进制安装 #### Linux 二进制包安装 @@ -42,6 +46,12 @@ sudo apt install ros-humble-orbbec-camera ros-humble-orbbec-description #### Linux ROS2 包装器编译 +创建 `colcon` 工作空间: + +```bash +mkdir -p ~/ros2_ws/src +``` + 克隆源代码并切换到 `v2-main` 分支: ```bash @@ -51,16 +61,6 @@ cd OrbbecSDK_ROS2 git checkout v2-main ``` -安装依赖项: - -```bash -sudo apt install libgflags-dev nlohmann-json3-dev \ -ros-$ROS_DISTRO-image-transport ros-${ROS_DISTRO}-image-transport-plugins ros-${ROS_DISTRO}-compressed-image-transport \ -ros-$ROS_DISTRO-image-publisher ros-$ROS_DISTRO-camera-info-manager \ -ros-$ROS_DISTRO-diagnostic-updater ros-$ROS_DISTRO-diagnostic-msgs ros-$ROS_DISTRO-statistics-msgs ros-$ROS_DISTRO-xacro \ -ros-$ROS_DISTRO-backward-ros libdw-dev libssl-dev -``` - 构建: ```bash diff --git a/docs/zh/source/3_quickstarts/quickstart.md b/docs/zh/source/3_quickstarts/quickstart.md index 6119ab81..8472e79b 100644 --- a/docs/zh/source/3_quickstarts/quickstart.md +++ b/docs/zh/source/3_quickstarts/quickstart.md @@ -19,6 +19,11 @@ ```bash source /opt/ros/$ROS_DISTRO/setup.bash +``` + +源码构建需要 + +```bash source ~/ros2_ws/install/setup.bash ``` @@ -89,4 +94,3 @@ ros2 service call /camera/get_device_info orbbec_camera_msgs/srv/GetDeviceInfo ' ```bash ros2 bag record /camera/color/image_raw /camera/depth/image_raw ``` -