orbbec_camera

stable (http://github.com/badges/stability-badges)

请注意：本文档为机器翻译，仅供参考。翻译可能存在遗漏或错误，且不会及时更新。请以英文原文为准。

OrbbecSDK ROS 2 是一个用于 Orbbec 3D 相机的 ROS 2 环境无缝集成的包装器。它支持 ROS 2 Foxy、Galactic 和 Humble 版本。

安装说明

安装 ROS 2

如果您的 ROS 2 命令没有自动补全，请将以下两行放入您的 .bashrc 或 .zshrc 中

eval "$(register-python-argcomplete3 ros2)"
eval "$(register-python-argcomplete3 colcon)"

创建 colcon 工作区

mkdir -p ~/ros2_ws/src

获取源代码

cd ~/ros2_ws/src
git clone https://github.com/orbbec/OrbbecSDK_ROS2.git

安装 deb 依赖项

# 假设您已经 source 了 ROS 环境，下同
sudo apt install libgflags-dev nlohmann-json3-dev libgoogle-glog-dev \
ros-$ROS_DISTRO-image-transport ros-$ROS_DISTRO-image-publisher ros-$ROS_DISTRO-camera-info-manager \
ros-$ROS_DISTRO-diagnostic-updater ros-$ROS_DISTRO-diagnostic-msgs

安装 udev 规则

cd  ~/ros2_ws/src/OrbbecSDK_ROS2/orbbec_camera/scripts
sudo bash install_udev_rules.sh
sudo udevadm control --reload-rules && sudo udevadm trigger

入门

cd ~/ros2_ws/
# 构建 Release 版本，默认为 Debug
colcon build --event-handlers  console_direct+  --cmake-args  -DCMAKE_BUILD_TYPE=Release

启动相机节点

. ./install/setup.bash
ros2 launch orbbec_camera astra.launch.py # 或者其他启动文件，参见下表
. ./install/setup.bash
rviz2

选择要显示的主题

ros2 topic list
ros2 service list
ros2 param list
ros2 service call /camera/get_device_info orbbec_camera_msgs/srv/GetDeviceInfo '{}'
ros2 service call /camera/get_sdk_version orbbec_camera_msgs/srv/GetString '{}'
ros2 service call /camera/get_color_exposure orbbec_camera_msgs/srv/GetInt32 '{}'

如果您查看的是 ir 或 depth，请将 /camera/get_color_exposure 改为 /camera/get_ir_exposure 或 /camera/get_depth_exposure，下同。

ros2 service call /camera/get_color_gain orbbec_camera_msgs/srv/GetInt32 '{}'
ros2 service call /camera/get_white_balance orbbec_camera_msgs/srv/GetInt32 '{}'
ros2 service call /camera/set_color_auto_exposure std_srvs/srv/SetBool '{data: false}'
ros2 service call /camera/set_white_balance orbbec_camera_msgs/srv/SetInt32 '{data: 4600}'
ros2 service call  /camera/set_laser_enable std_srvs/srv/SetBool "{data: true}"
ros2 service call /camera/toggle_ir std_srvs/srv/SetBool "{data : true}"
ros2 service call /camera/save_point_cloud std_srvs/srv/Empty "{}"

所有可用的相机控制服务

以下服务的名称已经表明了它的功能。但是，需要注意的是，相应的 set_[ir|depth|color]* 和 get[ir|depth|color]* 服务只有在启动文件的对应流的参数中将 enable[ir|depth|color] 设置为 true 时才可用。

所有可用的话题

网络设备枚举

目前，网络设备枚举功能仅由 Femto Mega 设备支持。当通过网络访问此设备时，如果将 enumerate_net_device 设置为 true，则设备将自动枚举，无需预先配置 IP 地址或将启用开关设置为 true。具体配置方法如下：

多相机

ros2 run orbbec_camera list_devices_node
from launch import LaunchDescription
from launch.actions import DeclareLaunchArgument, IncludeLaunchDescription, GroupAction, ExecuteProcess
from launch.launch_description_sources import PythonLaunchDescriptionSource
from launch_ros.actions import Node
from ament_index_python.packages import get_package_share_directory
import os


def generate_launch_description():
    # 包含启动文件
    package_dir = get_package_share_directory('orbbec_camera')
    launch_file_dir = os.path.join(package_dir, 'launch')
    launch1_include = IncludeLaunchDescription(
        PythonLaunchDescriptionSource(
            os.path.join(launch_file_dir, 'gemini2L.launch.py')
        ),
        launch_arguments={
            'camera_name': 'camera_01',
            'usb_port': '6-2.4.4.2',  # 在此替换您的 USB 端口
            'device_num': '2'
        }.items()
    )

    launch2_include = IncludeLaunchDescription(
        PythonLaunchDescriptionSource(
            os.path.join(launch_file_dir, 'gemini2L.launch.py')
        ),
        launch_arguments={
            'camera_name': 'camera_02',
            'usb_port': '6-2.4.1',  # 在此替换您的 USB 端口
            'device_num': '2'
        }.items()
    )

    # 如果您需要更多相机，只需在此处添加更多 launch_include，并更改 usb_port 和 device_num

    # 启动描述
    ld = LaunchDescription([
        GroupAction([launch1_include]),
        GroupAction([launch2_include]),
    ])

    return ld
ros2 launch orbbec_camera multi_camera.launch.py

使用硬件解码器解码 JPEG

瑞芯微和晶晨

依赖于 rockchip-mpp-dev 和 rockchip-rga-dev，并非所有系统都有这两个包，名称可能不同，请自行搜索。 打开 CMakeLists.txt 并将 USE_RK_HW_DECODER 设置为 ON。

Nvidia Jetson

依赖于：jetson_multimedia_api、libyuv。 打开 CMakeLists.txt 并将 USE_NV_HW_DECODER 设置为 ON。

启动参数

以下是可用的启动参数：

检查相机支持的配置文件

ros2 run orbbec_camera list_camera_profile_mode_node

构建 Debian 包

准备环境

在开始之前，请安装所需的工具：

sudo apt install debhelper fakeroot python3-bloom

配置 ROS 依赖项

将以下 YAML 文件添加到系统的 /etc/ros/rosdep/sources.list.d/00-orbbec.yaml 中。确保将 focal 替换为您的 Ubuntu 版本的代号，将 humble 替换为您的 ROS2 发行版名称：

orbbec_camera_msgs:
  ubuntu:
    focal: [ros-humble-orbbec-camera-msgs]

接下来，创建一个新文件 /etc/ros/rosdep/sources.list.d/50-orbbec.list，并添加这一行以指定 YAML 文件的路径：

yaml file:///etc/ros/rosdep/sources.list.d/00-orbbec.yaml

更新 rosdep 数据库以反映这些更改：

rosdep update

构建包

导航到您的工作区并构建项目：

cd ~/ros2_ws/
colcon build --event-handlers console_direct+ --cmake-args -DCMAKE_BUILD_TYPE=Release
. install/setup.bash
cd src/OrbbecSDK_ROS2/
bash .make_deb.sh

启动文件

产品系列 启动文件
gemini 330 系列 gemini_330_series.launch.py
astra2 astra2.launch.py
femto mega femto_mega.launch.py
femto bolt femto_bolt.launch.py
gemini2 gemini2.launch.py
gemini2L gemini2L.launch.py

所有启动文件本质上都是相似的，主要区别在于为同一系列中不同型号设置的参数的默认值。USB 标准的差异，例如 USB 2.0 与 USB 3.0，可能需要调整这些参数。如果遇到启动失败，请仔细查看规格手册。特别注意启动文件中的分辨率设置以及其他参数，以确保兼容性和最佳性能。

产品支持

产品列表 固件版本
Gemini 335 1.2.20
Gemini 335L 1.2.20
Femto Bolt 1.0.6/1.0.9
Femto Mega 1.1.7/1.2.7
Gemini 2 XL Obox：V1.2.5 VL：1.4.54
Astra 2 2.8.20
Gemini 2 L 1.4.32
Gemini 2 1.4.60 /1.4.76

DDS 调优

默认的 DDS 设置（Galactic）可能不是数据传输的最佳选择。不同的 DDS 设置可能具有不同的性能。在此示例中，我们使用 CycloneDDS。有关更多详细信息，请参阅 ROS DDS 调优。

● 编辑 cyclonedds 配置文件

sudo gedit /etc/cyclonedds/config.xml

添加

<?xml version="1.0" encoding="UTF-8"?>
<CycloneDDS xmlns="https://cdds.io/config" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="https://cdds.io/confighttps://raw.githubusercontent.com/eclipse-cyclonedds/cyclonedds/master/etc/cyclonedds.xsd">
    <Domain id="any">
        <General>
            <NetworkInterfaceAddress>lo</NetworkInterfaceAddress>
            <AllowMulticast>false</AllowMulticast>
        </General>
        <Internal>
            <MinimumSocketReceiveBufferSize>16MB</MinimumSocketReceiveBufferSize>
        </Internal>
        <Discovery>
            <ParticipantIndex>auto</ParticipantIndex>
            <MaxAutoParticipantIndex>30</MaxAutoParticipantIndex>
            <Peers>
                <Peer address="localhost"/>
            </Peers>
        </Discovery>
    </Domain>
</CycloneDDS>

● 设置环境变量，添加到 .zshrc 或 .bashrc

export ROS_DOMAIN_ID=42 # 0 到 232 之间的数字
export ROS_LOCALHOST_ONLY=1
export CYCLONEDDS_URI=file:///etc/cyclonedds/config.xml

提示：要了解为什么最大 ROS_DOMAIN_ID 为 232，请访问 ROS 域 ID ● 增加 UDP 接收缓冲区大小 编辑

/etc/sysctl.d/10-cyclone-max.conf

添加

net.core.rmem_max=2147483647
net.core.rmem_default=2147483647

常见问题

多个相机无图像

为什么这里有那么多启动文件

许可证

版权所有 2023 Orbbec Ltd。

根据 Apache 许可证 2.0 版（"许可证"）获得许可；除非遵守许可证，否则您不得使用此项目。您可以在以下网址获取许可证副本：

http://www.apache.org/licenses/LICENSE-2.0