Skip to content

Latest commit

 

History

History
210 lines (122 loc) · 6.42 KB

README_CN.md

File metadata and controls

210 lines (122 loc) · 6.42 KB

rslidar_sdk

1 工程简介

rslidar_sdk 为速腾聚创在Ubuntu环境下的雷达驱动软件包,包括了雷达驱动内核, ROS拓展功能,ROS2拓展功能,Protobuf-UDP通信拓展功能。对于没有二次开发需求的用户,或是想直接使用ROS或ROS2进行二次开发的用户,可直接使用本软件包, 配合ROS或ROS2自带的RVIZ可视化工具即可查看点云。 对于有更深一步二次开发需求,想将雷达驱动集成到自己工程内的客户, 请参考雷达驱动内核的相关文档,直接使用内核rs_driver进行二次开发。

1.1 雷达型号支持

  • RS-LiDAR-16
  • RS-LiDAR-32
  • RS-Bpearl
  • RS-Ruby
  • RS-Ruby Lite
  • RS-LiDAR-M1
  • RS-Helios

1.2 点的类型支持

  • XYZI - x, y, z, intensity
  • XYZIRT - x, y, z, intensity, ring, timestamp

2 下载

2.1 使用git clone

由于rslidar_sdk项目中包含子模块驱动内核rs_driver, 因此在执行git clone 后还需要执行相关指令初始化并更新子模块。

git clone https://github.com/RoboSense-LiDAR/rslidar_sdk.git
cd rslidar_sdk
git submodule init
git submodule update

2.2 直接下载

用户可以直接访问 rslidar_sdk_release 下载最新版本的rslidar_sdk. 请下载 rslidar_sdk.tar.gz 压缩包, 不要下载Source code。 因为Source code压缩包内不包含子模块rs_driver的代码, 用户还需自行下载rs_driver的代码放入其中才行。

3 依赖介绍

3.1 ROS

若需在ROS环境下使用雷达驱动,则需安装ROS相关依赖库

Ubuntu 16.04 - ROS kinetic desktop-full

Ubuntu 18.04 - ROS melodic desktop-full

Ubuntu 20.04 - ROS noetic desktop-full

安装方式: 参考 http://wiki.ros.org

如果安装了ROS kinetic desktop-full版、ROS melodic desktop-full版或ROS noetic desktop-full,那么兼容版本其他依赖库也应该同时被安装了,所以不需要重新安装它们以避免多个版本冲突引起的问题, 因此,强烈建议安装desktop-full版,这将节省大量的时间来逐个安装和配置库

3.2 ROS2

若需在ROS2环境下使用雷达驱动,则需安装ROS2相关依赖库

Ubuntu 16.04 - 不支持

Ubuntu 18.04 - ROS2 Eloquent desktop

安装方式:参考 https://index.ros.org/doc/ros2/Installation/Eloquent/Linux-Install-Debians/

Ubuntu 20.04 - ROS2 Foxy desktop

安装方式:参考 https:https://docs.ros.org/en/foxy/Installation/Ubuntu-Install-Debians.html

Ubuntu 20.04 - ROS2 Galactic desktop

安装方式:参考 https://docs.ros.org/en/galactic/Installation/Ubuntu-Install-Debians.html

注意! 请避免在同一台电脑上同时安装ROS和ROS2, 这可能会产生冲突! 同时还需要手动安装Yaml库。

3.3 Yaml (必需)

版本号: >= v0.5.2

若已安装ROS desktop-full, 可跳过

安装方式:

sudo apt-get update
sudo apt-get install -y libyaml-cpp-dev

3.4 Pcap (必需)

版本号: >=v1.7.4

安装方式:

sudo apt-get install -y  libpcap-dev

3.5 Protobuf (可选)

版本号: >=v2.6.1

安装方式:

sudo apt-get install -y libprotobuf-dev protobuf-compiler

4 编译 & 运行

我们提供三种编译&运行方式。

4.1 直接编译

按照如下指令即可编译运行程序。 直接编译也可以使用ROS相关功能(不包括ROS2),但需要在程序启动前手动启动roscore,启动后手动打开rviz才能看到可视化点云结果。

cd rslidar_sdk
mkdir build && cd build
cmake .. && make -j4
./rslidar_sdk_node

4.2 依赖于ROS-catkin编译

(1) 打开工程内的CMakeLists.txt文件,将文件顶部的set(COMPILE_METHOD ORIGINAL)改为set(COMPILE_METHOD CATKIN)

#=======================================
# Compile setup (ORIGINAL,CATKIN,COLCON)
#=======================================
set(COMPILE_METHOD CATKIN)

(2) 将rslidar_sdk工程目录下的package_ros1.xml文件复制到package.xml

(3) 新建一个文件夹作为工作空间,然后再新建一个名为src的文件夹, 将rslidar_sdk工程放入src文件夹内。

(4) 返回工作空间目录,执行以下命令即可编译&运行(若使用.zsh,将第二句指令替换为 source devel/setup.zsh)。

catkin_make
source devel/setup.bash
roslaunch rslidar_sdk start.launch

4.3 依赖于ROS2-colcon编译

(1) 打开工程内的CMakeLists.txt文件,将文件顶部的set(COMPILE_METHOD ORIGINAL)改为set(COMPILE_METHOD COLCON)

#=======================================
# Compile setup (ORIGINAL,CATKIN,COLCON)
#=======================================
set(COMPILE_METHOD COLCON)

(2) 将rslidar_sdk工程目录下的package_ros2.xml文件复制到package.xml

(3) 新建一个文件夹作为工作空间,然后再新建一个名为src的文件夹, 将rslidar_sdk工程放入src文件夹内。

(4) 通过链接下载ROS2环境下的雷达packet消息定义, 将rslidar_msg工程也放在刚刚新建的src文件夹内,与rslidar_sdk并列。

(5) 返回工作空间目录,执行以下命令即可编译&运行(若使用.zsh,将第二句指令替换为 source install/setup.zsh)。

colcon build
source install/setup.bash
ros2 launch rslidar_sdk start.py

5 参数介绍

参数介绍非常重要,请仔细阅读。 本软件包的所有功能都将通过配置参数文件来实现。

参数介绍

隐藏参数介绍

6 快速上手

以下仅为一些常用功能的快速使用指南, 实际使用时并不仅限于以下几种工作模式, 可通过配置参数改变不同的工作模式。

在线读取雷达数据发送到ROS

录制ROS数据包&离线解析ROS数据包

离线解析Pcap包发送到ROS

7 使用进阶

使用Protobuf发送&接收

多雷达

切换点的类型

坐标变换功能

组播模式