7. Odin1 Lite Quick Start (Ubuntu)

This chapter guides users to successfully run the Odin1 Lite ROS driver on Ubuntu and obtain point cloud, image, IMU, odometry and other data.

📄 Download PDF: O1Lite Quick Start Guide v3.3


7.1 Firmware Version / Driver Version Correspondence

No. Firmware Version Driver Version
1 v1.3.7 v0.7.0
2 v2.0.x v0.12.0
3 v3.x v3.x (current latest: v3.7.0)

Please ensure the firmware and driver versions match; version mismatch may cause abnormal function. v3.x firmware must be paired with v3.x driver; the v0.12.0 driver cannot be used. The Service, parameter and topic descriptions in this document are based on v3.7.0.


7.2 Hardware Composition and Installation

# Component Description
1 Odin1 Lite main unit Integrated LiDAR + single RGB + IMU module
2 Power-and-data splitter aviation cable One end aviation plug to main unit; the other end splits to DC jack and RJ45 Ethernet port
3 12 V / 2 A DC power adapter User-provided (recommended ≥ 24 W power margin)
4 Network cable (direct or via switch) Connects Odin1 Lite to the PC

Installation steps:

  1. Align the aviation plug with the Odin1 Lite interface by the groove direction, insert and tighten the threaded ring.
  2. On the other end of the cable: connect the DC jack to the 12 V / 2 A adapter, and the RJ45 connector to the PC Ethernet port (or switch).
  3. After power-on, the device indicator should stay on, indicating normal operation.

⚠️ Please confirm the groove direction before tightening the aviation plug to avoid bent pins.


7.3 PC Preparation

7.3.1 System Requirements

Ubuntu Version Supported ROS Version
20.04 ROS1 Noetic
22.04 ROS2 Humble
24.04 ROS2 Jazzy

Before running the driver, confirm that the corresponding ROS environment is correctly installed and sourced on the PC.

7.3.2 Network Configuration

Odin1 Lite communicates with the PC via Ethernet. The default IP is 192.168.1.251 (the module IP can be changed according to customer requirements). Please configure the PC Ethernet card to the same subnet (e.g., 192.168.1.100/24).

# 1. Check whether the Ethernet IP is effective
ifconfig

# 2. Test device connectivity
ping 192.168.1.251

If ping fails, please re-enable the Ethernet card or check IP / subnet mask / firewall blocking UDP broadcast (ports 60000–60010).

7.3.3 NIC Buffer and ROS_DOMAIN_ID

Before running the driver, it is recommended to enlarge the kernel network receive buffer to avoid UDP packet loss caused by high-rate sensor data; when multiple PCs run ROS2 in the same LAN, also set an independent ROS_DOMAIN_ID.

# Enlarge receive buffer (recommended for stable mapping / relocalization)
sudo sysctl -w net.core.rmem_max=16777216
sudo sysctl -w net.core.rmem_default=8388608
sudo sysctl -w net.core.netdev_max_backlog=50000

# Set an independent ROS2 domain (1–99; 0 means shared)
export ROS_DOMAIN_ID=1

export ROS_DOMAIN_ID=... takes effect only in the current terminal; add it to ~/.bashrc for persistence. For ROS1 multi-machine isolation, see 7.14 Multi-machine Isolation.


7.4 Obtain the Driver

Acquisition steps:

  1. Contact Liuxing after-sales technical support.
  2. Provide company information, user information and email.
  3. Technical support will provide a GitLab account.
  4. Log in to GitLab with the provided account to obtain the driver (please change the password as soon as possible after login).

Driver repository: https://git.manifoldtech.cn/manifoldtech-sdk/odin_ros_driver2

The current latest driver is v3.7.0, corresponding to v3.x firmware. If the device uses v1.3.7 or v2.0.x firmware, please obtain the matching historical driver version from the table above.

The driver archive is named as:

ros_driver_v<version>_<release_type>_<date>.tar.xz

Example: ros_driver_v3.7.0_release_20261024.tar.xz


7.5 Deploy the Driver

The following example assumes the driver package has been downloaded to ~/Downloads and the workspace is named catkin_ws.

# 1. Create ROS workspace
mkdir -p ~/catkin_ws/src

# 2. Extract the driver and move it under src
cp ~/Downloads/ros_driver_v3.7.0_release_20261024.tar.xz ~/catkin_ws/src
cd ~/catkin_ws/src
tar -xvf ros_driver_v3.7.0_release_20261024.tar.xz
mv ./ros_driver_v3.7.0_release_20261024/ros_driver ./
rm -rf ros_driver_v3.7.0_release_20261024 ros_driver_v3.7.0_release_20261024.tar.xz

After completion, the directory structure should be:

catkin_ws/
└── src/
    └── ros_driver/
        ├── script/build_ros1.sh
        ├── script/build_ros2.sh
        ├── launch/
        ├── config/
        └── ...

7.6 Build the Driver

The SDK (module/sdk_api) will be built automatically by the build script, no separate installation is required; this note applies to obtaining sensor data. To use the relocalization function, also install the algorithm deb package as described in 7.10 Mapping and Relocalization Operations.

ROS1 (Noetic)

source /opt/ros/noetic/setup.bash
cd ~/catkin_ws
./src/ros_driver/script/build_ros1.sh

ROS2 (Humble / Jazzy)

source /opt/ros/humble/setup.bash       # or jazzy
cd ~/catkin_ws
./src/ros_driver/script/build_ros2.sh

7.7 Run the Driver

ROS1

cd ~/catkin_ws
source devel/setup.bash

# Default start (auto-discovery + RViz)
roslaunch odin_ros_driver_rev1 odin1Lite.launch

# Specify image resolution and frame rate
roslaunch odin_ros_driver_rev1 odin1Lite.launch \
    image_width:=640 image_height:=544 image_fps:=30

# Do not start RViz
roslaunch odin_ros_driver_rev1 odin1Lite.launch start_rviz:=false

ROS2

cd ~/catkin_ws
source install/setup.bash

# Default start
ros2 launch odin_ros_driver_rev1 odin1Lite.launch.py

# Specify image resolution and frame rate
ros2 launch odin_ros_driver_rev1 odin1Lite.launch.py \
    image_width:=640 image_height:=544 image_fps:=30

# Do not start RViz
ros2 launch odin_ros_driver_rev1 odin1Lite.launch.py start_rviz:=false

After successful operation, point cloud and image will be displayed in RViz automatically.

Common Launch Parameters

The following parameters are read at node startup; after modification, the driver must be restarted. For the full parameter list, run ros2 launch odin_ros_driver_rev1 odin1Lite.launch.py --show-args.

Parameter Default Description
start_rviz true Whether to start RViz
topic_prefix manifold Topic prefix root; final prefix is /{topic_prefix}/device{N}/
device_mode normal Device mode at startup: normal or standby
discovery_timeout_ms 2000 Device discovery timeout, in ms
image_width / image_height / image_fps 0 Image width, height and frame rate; 0 means use device default capability
image_format mjpeg Image format: mjpeg or h264
filter_confidence_threshold -1 Device-side confidence filter threshold; -1 means keep device default
filter_adaptive_cdf_percentile -1 Adaptive filter CDF percentile (1..10000); -1 means device default
filter_adaptive_outdoor_thr -1 Adaptive filter outdoor distance threshold (mm); -1 means device default
filter_range_min_depth -1 Device-side range filter minimum valid depth (mm); -1 means device default
raw_frame_id / gray_image_frame_id lidar frame_id for raw point cloud and grayscale image
slam_frame_id / odom_frame_id odom frame_id for SLAM point cloud and odometry parent frame
image_frame_id / image2_frame_id camera0 / camera1 frame_id for camera images
imu_frame_id imu frame_id for IMU
tf_publish_rate 0 TF timed retransmission frequency (Hz); 0 disables timed retransmission
enable_row_filter false Whether to enable row filter
min_row 0 Row filter minimum row number, range 0..191; points below this row are zeroed
confidence_threshold 7 Initial point cloud confidence threshold (0..255)
sensor_mode -1 Initial dToF sensor mode; -1 keeps the device current mode
log_level 1 SDK / ROS log level: 0=ERROR, 1=INFO, 2=WARN, 3=DEBUG

7.8 Parameter Setting Instructions

Driver parameters are divided into two categories: startup parameters are read only at node startup; runtime parameters can be modified while the node is running and take effect immediately. Except for the parameters marked as dynamically modifiable in the table below and in 7.11 Data Stream Switches, other parameters will not be applied to node logic even if written to the parameter server via ros2 param set; they must be set via launch parameters and the driver restarted.

Runtime Parameters

Parameter Range / Default Description
confidence_threshold 0..255 / 7 Point cloud confidence threshold; points below this value are zeroed. As small as possible while ensuring no noise; for indoor scenes, start tuning from 4
sensor_mode -1..3 / -1 dToF sensor mode; -1 means do not send at startup and keep the device current mode; meanings of 0..3 see 7.9 Long/Short Frame Switching
log_level 0..3 / 1 SDK / ROS log level: 0=ERROR, 1=INFO, 2=WARN, 3=DEBUG

Setting Methods

# ROS2: view, read and modify runtime parameters
ros2 param list /odin_ros_driver_node
ros2 param get /odin_ros_driver_node sensor_mode
ros2 param set /odin_ros_driver_node sensor_mode 3
ros2 param set /odin_ros_driver_node confidence_threshold 15
ros2 param set /odin_ros_driver_node log_level 1

# ROS2: configure startup parameters via launch, then restart driver
ros2 launch odin_ros_driver_rev1 odin1Lite.launch.py \
    image_width:=640 image_height:=544 image_fps:=30 \
    raw_frame_id:=lidar imu_frame_id:=imu_link

# ROS1: use rqt_reconfigure, or modify runtime parameters via command line
rosrun rqt_reconfigure rqt_reconfigure
rosrun dynamic_reconfigure dynparam set /odin_ros_driver_node sensor_mode 3

7.9 Long/Short Frame (Sensor Mode) Switching

Odin1 Lite supports four operating modes:

Enum Mode Description
0 HDR High dynamic range, automatically balances near and far
1 High Peak (long frame) Optimizes reception quality under strong light, suitable for outdoor; slightly lower near-range precision
2 Low Peak (short frame) Optimizes near-range and small-space noise, suitable for indoor; strongly affected by bright light
3 Adaptive Adaptive mode

Method 1: rqt GUI

rqt
# In the Dynamic Reconfigure panel, find the odin_ros_driver_node node,
# and adjust the sensor_mode parameter.

Method 2: Command-line Parameter Setting (ROS2)

source ~/catkin_ws/install/setup.bash

# Switch to High Peak
ros2 param set /odin_ros_driver_node sensor_mode 1

# Switch to Low Peak
ros2 param set /odin_ros_driver_node sensor_mode 2

7.10 Mapping and Relocalization Operations

For detailed API instructions, see 6. Mapping and Relocalization API Workflow.

Relocalization is provided jointly by the ROS Driver and the algorithm deb package (manifold-lc-sdk): when only the ROS Driver is deployed, the device can output point cloud, image, IMU and odometry data normally, but cannot run mapping and relocalization algorithms.

Please ensure the firmware has been upgraded to the latest version.

7.10.1 Install the Relocalization Algorithm deb Package

  1. Download download_lc_sdk.sh and run it on the host running the ROS Driver:

    chmod +x download_lc_sdk.sh
    ./download_lc_sdk.sh
    
  2. The script detects the host CPU architecture and GPU / NPU, CUDA, TensorRT, OpenVINO, RKNN and other runtime environments, and outputs applicable manifold-lc-sdk download links under [Download links]; prefer downloading the deb package marked as RECOMMENDED.

  3. After downloading, install in the directory where the deb file is located. Replace the file name below with the actual downloaded file name:

    sudo dpkg -i manifold-lc-sdk_<version>_<architecture>.deb
    

⚠️ Downloading or building the ROS Driver alone does not install the relocalization algorithm. After the deb installation is complete, start the ROS Driver and execute the following mapping or relocalization workflow.

7.10.2 Mapping (SLAM)

# 1. Ensure the driver is started and the device is connected

# 2. Switch to SLAM mode (start mapping)
ros2 service call /manifold/device0/device_mode \
    odin_ros_driver_rev1/srv/DeviceMode "{mode: 3}"

# 3. Move the device to map the environment...

# 4. Save the map
ros2 service call /manifold/device0/save_map \
    odin_ros_driver_rev1/srv/SaveMap "{path: '/tmp/odin_map.bin'}"

# 5. Mapping complete; switch back to Normal
ros2 service call /manifold/device0/device_mode \
    odin_ros_driver_rev1/srv/DeviceMode "{mode: 1}"

7.10.3 Relocalization

# 1. Switch to Relocation mode
ros2 service call /manifold/device0/device_mode \
    odin_ros_driver_rev1/srv/DeviceMode "{mode: 4}"

# 2. Load the previously saved map
ros2 service call /manifold/device0/load_map \
    odin_ros_driver_rev1/srv/LoadMap "{path: '/tmp/odin_map.bin'}"

# 3. Move the device and wait for the relocalization algorithm to complete matching

# 4. Stop relocalization and switch back to Normal
ros2 service call /manifold/device0/device_mode \
    odin_ros_driver_rev1/srv/DeviceMode "{mode: 1}"

7.10.4 ReMap (Incremental Mapping)

ReMap (mode: 5) relocalizes on a saved map while extending the map. It is suitable for scenarios where new areas need to be appended to an existing map.

# 1. Switch to ReMap mode and load the existing map
ros2 service call /manifold/device0/device_mode \
    odin_ros_driver_rev1/srv/DeviceMode "{mode: 5}"

ros2 service call /manifold/device0/load_map \
    odin_ros_driver_rev1/srv/LoadMap "{path: '/tmp/odin_map.bin'}"

# 2. In RViz set Fixed Frame to device0/map, then move the device to collect new areas

# 3. Save the extended map
ros2 service call /manifold/device0/save_map \
    odin_ros_driver_rev1/srv/SaveMap "{path: '/tmp/odin_map_extended.bin'}"

# 4. Stop ReMap and switch back to Normal
ros2 service call /manifold/device0/device_mode \
    odin_ros_driver_rev1/srv/DeviceMode "{mode: 1}"

The incrementally saved map is usually larger than the original map.

7.10.5 Loop-closure Visualization Topics

In SLAM / Relocation / ReMap mode, when the manifold-lc-sdk algorithm deb package is installed, the following loop-closure visualization topics are published:

Topic suffix Type Description
loop_closure/optimization_busy std_msgs/Bool Whether the optimizer is running
loop_closure/optimization_status_marker visualization_msgs/Marker Text marker showing IDLE / OPTIMIZATION
loop_closure/optimized_path nav_msgs/Path Optimized trajectory in the local_map frame
loop_closure/optimized_cloud sensor_msgs/PointCloud2 Optimized global point cloud in the local_map frame
loop_closure/map_cloud sensor_msgs/PointCloud2 Loaded map point cloud in the map frame

7.10.6 Confirming Relocalization Results

A successful load_map service response only means the map has been loaded by the algorithm session. After loading the map, move the device for a distance, and confirm whether relocalization has converged according to the application-side localization status and pose output.


7.11 Data Stream Switches

All data stream switches have been migrated from config/control_command.yaml to launch parameters. Layer A/B parameters support runtime hot switching (ros2 param set / rqt_reconfigure / Service); layer C/D/E parameters take effect only at startup, and the driver must be restarted after modification.

Layer A: Main Driver Data Channels (odin_ros_driver_node)

Parameter Default Description
enable_raw_point true Raw point cloud channel
enable_slam_point true SLAM point cloud channel
enable_image0 true Left RGB camera image channel
enable_image1 false Right RGB camera image channel (invalid on Odin1 Lite)
enable_imu true IMU data channel
enable_odom_lf true Low-frequency odometry channel
enable_odom_hf true High-frequency odometry channel
enable_tf true TF transform channel

Layer B: Post-processing Output (post_process_node)

Parameter Default Description
post_process true Post-processing master switch; takes effect only at startup
send_image_raw true Publish decoded left RGB image
send_image2_raw false Publish decoded right RGB image (invalid on Odin1 Lite)
send_cloud_render false Publish colored point cloud
send_undistort false Publish undistorted image
send_rectify false Publish rectified image and camera_info
send_opencv_undistort false Enable OpenCV undistort node

Layer C/D/E: Startup Functional Switches

Parameter Node Default Description
enable_reprojection pointcloud_reprojector_node false Enable point cloud reprojection overlay
enable_pointcloud_to_depth pointcloud_to_depth_node false Enable point cloud → dense depth map
enable_depth_to_pointcloud depth_to_pointcloud_node false Enable depth map → dense colored point cloud
# Single-channel hot switching
ros2 param set /odin_ros_driver_node enable_raw_point false
ros2 param set /postprocess send_undistort true

# Batch switch main driver channels: 0=off, 1=on, -1=keep current; unlisted fields default to 0
ros2 service call /manifold/device0/set_channel_config \
    odin_ros_driver_rev1/srv/SetChannelConfig \
    "{enable_raw_point: -1, enable_slam_point: 0, enable_image0: -1, enable_image1: -1, enable_imu: -1, enable_odom_lf: -1, enable_odom_hf: -1, enable_tf: -1}"

# Batch switch post-processing output
ros2 service call /manifold/postprocess/set_post_process_config \
    odin_ros_driver_rev1/srv/SetPostProcessConfig \
    "{send_image_raw: -1, send_image2_raw: -1, send_cloud_render: -1, send_undistort: 1, send_rectify: -1, send_opencv_undistort: -1}"

When calling set_channel_config / set_post_process_config, all fields that you do not want to modify must be explicitly set to -1; otherwise unlisted fields will be defaulted to 0, accidentally turning off the corresponding data stream.

ℹ️ Odin1 Lite is a single-RGB device. enable_image1, send_image2_raw and binocular / disparity-related parameters will not publish data on Odin1 Lite.

Recording ROS2 rosbag

Before recording, confirm that ROS_DOMAIN_ID is configured and the NIC buffer is enlarged (see 7.3.3). For ROS2, it is recommended to use the QoS override file provided by the driver to avoid high-frequency topic packet loss:

ros2 bag record -a \
  --qos-profile-overrides-path ~/catkin_ws/src/ros_driver/config/rosbag2_qos.yaml

ROS1 uses TCPROS and does not need a QoS override file; rosbag record -a is sufficient.


7.12 Odin HTTP Dashboard

The device has a built-in Web console that can be accessed without additional software.

  • Access address: http://192.168.1.251:8080 (keep PC and device in the same subnet)
  • Recommended browsers: Chrome / Edge
Function Module Page Description
Device information Dashboard Product name, firmware version, serial number
System resource monitoring Dashboard CPU, memory, system load (1/5/15 min)
Temperature real-time chart Dashboard SoC temperature zones and sensor temperature (1 Hz line chart)
Frame rate real-time chart Dashboard Real-time FPS of each sensor
Calibration file management Dashboard Calibration file upload / download
Map file download Dashboard Relocalization map file download
System log download Dashboard Device log packaged download (.tar.gz)
Telemetry data recording Dashboard Real-time monitoring data recorded as CSV
OTA firmware upgrade Update Drag firmware package → auto-install → restart verification
Network configuration Setting IP / gateway / subnet mask / DHCP
Device restart Setting Remote device restart
Theme switching Global Light / dark mode
Admin login Global Admin privileges unlock advanced operations

7.13 Upgrade Firmware

  1. Contact Liuxing technical support to obtain the firmware package.
  2. After obtaining the firmware, extract it and ensure the .bin file is visible.
  3. Upgrade steps:
    • Ensure the PC and Odin1 Lite are in the same subnet and can ping each other.
    • Open a browser to http://192.168.1.251:8080.
    • Click Update on the left.
    • Click Browse Files and select the extracted .bin file.
    • Wait for the upgrade to complete.
    • Click Dashboard on the left and check the firmware version to confirm the upgrade succeeded.

7.14 Multi-machine Isolation (Avoid Topic Interference)

When multiple PCs start the driver in the same LAN, identical topics will interfere with each other.

ROS2: Set an independent ROS_DOMAIN_ID

echo $ROS_DOMAIN_ID            # View; blank or 0 means shared
export ROS_DOMAIN_ID=1         # 1–99; 0 means shared

ROS1: Restrict to localhost only or change port

# Recommended
export ROS_LOCALHOST_ONLY=1

# Or: use another port
roscore -p 11312
export ROS_MASTER_URI=http://localhost:11312

The above commands take effect only in the current terminal; append to ~/.bashrc for persistence.


← Previous Chapter:Mapping and Relocalization API Workflow | Next Chapter:Firmware Upgrade →


中文 | EN
This site uses Just the Docs, a documentation theme for Jekyll.