Nebula

Welcome to Nebula, the universal sensor driver

Nebula is a sensor driver platform that is designed to provide a unified framework for as wide a variety of devices as possible. While it primarily targets Ethernet-based LiDAR sensors, it aims to be easily extendable to support new sensors and interfaces. Nebula works with ROS 2 and is the recommended sensor driver for the Autoware project.

Documentation

We recommend you get started with the Nebula Documention. Here you will find information about the background of the project, how to install and use with ROS 2, and also how to add new sensors to the Nebula driver.

• Design
• Supported Sensors
• Installation
• Launching with ROS 2
• Parameters
• Point cloud types
• Contributing
• Tutorials

To build and serve the documentation locally, see the build steps further below.

Quick start

Nebula builds with ROS 2 Galactic and Humble.

Note

Boost version 1.74.0 or later is required. A manual install may be required in Ubuntu versions earlier than 22.04.

To build Nebula run the following commands in your workspace:

# In workspace
git clone https://github.com/tier4/nebula.git
cd nebula
# Import dependencies
vcs import < build_depends.repos
rosdep install --from-paths . --ignore-src -y -r
# Build Nebula
colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release -DCMAKE_EXPORT_COMPILE_COMMANDS=1

To build with support for Agnocast, TIER IV’s zero-copy middleware, refer to the Agnocast section below.

(optional) To build and serve the documentation, run the following commands in your workspace:

cd src
pip3 install -r docs/requirements.txt
mkdocs serve

To launch Nebula as a ROS 2 node with default parameters for your sensor model:

ros2 launch nebula_ros *sensor_vendor_name*_launch_all_hw.xml sensor_model:=*sensor_model_name*

For example, for a Hesai Pandar40P sensor:

ros2 launch nebula_ros hesai_launch_all_hw.xml sensor_model:=Pandar40P

Agnocast

Nebula supports the Agnocast zero-copy middleware for pointcloud and blockage mask outputs.

Note

Agnocast support is currently limited to Hesai sensors.

To build with support for Agnocast, add -DUSE_AGNOCAST=ON to the --cmake-args to the above colcon build command.

The following apt dependencies are required at run time:

sudo add-apt-repository ppa:t4-system-software/agnocast
sudo apt-get update
sudo apt-get install agnocast-heaphook-v2.1.1 agnocast-kmod-v2.1.1

Nebula binaries that have been compiled with Agnocast support require the following environment variables to be set at runtime:

export LD_PRELOAD=/opt/ros/humble/lib/libagnocast_heaphook.so

# This depends on the sensor model used and the number of Nebula topics subscribed.
# A few maximum-size pointclouds worth of memory shall be enough. The below threshold is a
# reasonable default.
export AGNOCAST_MEMPOOL_SIZE=134217728 # 128MB

In addition, the Agnocast kernel module must be loaded at runtime:

sudo modprobe agnocast

To confirm that Agnocast support is enabled, run:

$ ros2 topic list_agnocast
[...]
/pandar_packets
/pandar_points (Agnocast enabled)
[...]

Please note that the packets topics do not support Agnocast, as they are purely used for data recording and tools like ros2 bag do not have Agnocast support yet.