Livox SDK API  V2.2.0
Livox SDK API Documentation

https://github.com/Livox-SDK/Livox-SDK/blob/master/README_CN.md "中文版本使用说明"

1 Introduction

Livox SDK is the software development kit designed for all Livox products. It is developed based on C/C++ following Livox SDK Communication Protocol, and provides easy-to-use C style API. With Livox SDK, users can quickly connect to Livox products and receive point cloud data.

Livox SDK consists of Livox SDK communication protocol, Livox SDK core, Livox SDK API, Linux sample, and ROS demo.

Prerequisites

  • Ubuntu 14.04/Ubuntu 16.04/Ubuntu 18.04, both x86 and ARM (Nvidia TX2)
  • Windows 7/10, Visual Studio 2015 Update3/2017
  • C++11 compiler

2 Livox SDK Communication Protocol

Livox SDK communication protocol opens to all users. It is the communication protocol between user programs and Livox products. The protocol consists of control commands and data format. Please refer to the Livox SDK Communication Protocol for detailed information.

3 Livox SDK Core

Livox SDK provides the implementation of control commands and point cloud data transmission, as well as the C/C++ API. The basic structure of Livox SDK core is shown as below:

sdk.png
Livox SDK Architecture

User Datagram Protocol (UDP) is used for communication between Livox SDK and LiDAR sensors. Please refer to the Livox SDK Communication Protocol for further information. Point cloud data handler supports point cloud data transmission, while command handler receives and sends control commands. And the C/C++ API is based on command handler and point cloud data handler.

The Livox LiDAR sensors can be connected to host directly or through the Livox Hub. Livox SDK supports both connection methods. When LiDAR units are connected to host directly, the host will establish communication with each LiDAR unit individually. And if the LiDAR units connect to host through Hub, then the host only communicates with the Livox Hub while the Hub communicates with each LiDAR unit.

4 Livox SDK API

Livox SDK API provides a set of C style functions which can be conveniently integrated in C/C++ programs. Please refer to the Livox SDK API Reference for further information.

4.1 Installation

The installation procedures in Ubuntu 18.04/16.04/14.04 LTS and Windows 7/10 are shown here as examples. For Ubuntu 18.04/16.04/14.04 32-bit LTS and Mac, you can get it in Livox-SDK wiki.

4.1.1 Ubuntu 18.04/16.04/14.04 LTS

Dependencies

Livox SDK requires CMake 3.0.0+ as dependencies. You can install these packages using apt:

1 sudo apt install cmake pkg-config

Compile Livox SDK

In the Livox SDK directory, run the following commands to compile the project:

1 git clone https://github.com/Livox-SDK/Livox-SDK.git
2 cd Livox-SDK

Install apr library by:

1 sudo ./third_party/apr/apr_build.sh

or by:

1 sudo apt install libapr1-dev

then

1 cd build && cmake ..
2 make
3 sudo make install

4.1.2 Windows 7/10

Dependencies

Livox SDK supports Visual Studio 2015 Update3/2017 and requires install CMake 3.0.0+ as dependencies.

In the Livox SDK directory, run the following commands to create the Visual Studio solution file. Generate the 32-bit project:

1 cd Livox-SDK
2 .\third_party\apr\apr_build.bat
3 cd build && \
4 cmake ..

Generate the 64-bit project:

1 cd Livox-SDK
2 .\third_party\apr\apr_build.bat amd64
3 cd build && \
4 cmake .. -G "Visual Studio 15 2017 Win64"

Compile Livox SDK

You can now compile the Livox SDK in Visual Studio.

4.1.3 ARM-Linux Cross Compile

The procedure of cross compile Livox-SDK in ARM-Linux are shown below.

Dependencies

Host machine requires install cmake and gcc. You can install these packages using apt:

1 sudo apt install cmake gcc

Cross Compile Toolchain

If your ARM board vendor provides a cross compile toolchain, you can skip the following step of installing the toolchain and use the vendor-supplied cross compile toolchain instead.

The following commands will install C and C++ cross compiler toolchains for 32bit and 64bit ARM board. You need to install the correct toolchain for your ARM board. For 64bit SoC ARM board, only install 64bit toolchain, and for 32bit SoC ARM board, only install 32bit toolchain.

Install **ARM 32 bits cross compile toolchain**：

1 sudo apt-get install gcc-arm-linux-gnueabi g++-arm-linux-gnueabi

Install **ARM 64 bits cross compile toolchain**：

1 sudo apt-get install gcc-aarch64-linux-gnu g++-aarch64-linux-gnu

Cross Compile Livox-SDK

For **ARM 32 bits toolchain**，In the Livox SDK directory，run the following commands to cross compile the project:

1 cd Livox-SDK
2 cd build && \
3 cmake .. -DCMAKE_SYSTEM_NAME=Linux -DCMAKE_C_COMPILER=arm-linux-gnueabi-gcc -DCMAKE_CXX_COMPILER=arm-linux-gnueabi-g++
4 make

For **ARM 64 bits toolchain**，In the Livox SDK directory，run the following commands to cross compile the project:

1 cd Livox-SDK
2 cd build && \
3 cmake .. -DCMAKE_SYSTEM_NAME=Linux -DCMAKE_C_COMPILER=aarch64-linux-gnu-gcc -DCMAKE_CXX_COMPILER=aarch64-linux-gnu-g++
4 make

Note:

  • gcc cross compiler need to support C ++11 standard

4.2 Run Livox SDK Sample

Two samples are provided in Sample/Lidar and Sample/Hub, which demonstrate how to configure Livox LiDAR units and receive the point cloud data when directly connecting Livox SDK to LiDAR units or by using a Livox Hub, respectively. The sequence diagram is shown as below:

sample.png

4.2.1 Ubuntu 18.04/16.04 /14.04 LTS

For Ubuntun 18.04/16.04/14.04 LTS, run the lidar_sample if connect with the LiDAR unit(s):

1 cd sample/lidar && ./lidar_sample

or run the hub_sample if connect with the hub unit(s):

1 cd sample/hub && ./hub_sample

4.2.2 Windows 7/10

After compiling the Livox SDK as shown in section 4.1.2, you can find hub_sample.exe or lidar_sample.exe in the {Livox-SDK} or {Livox-SDK} folder, respectively, which can be run directly.

Then you can see the information as below:

sdk_init.png

4.3 Connect to the specific LiDAR units

Samples we provided will connect all the broadcast device in you LAN in default.There are two ways to connect the specific units:

  • run sample with input options
  • edit the Broadcast Code list in source code

NOTE:

Each Livox LiDAR unit owns a unique Broadcast Code . The broadcast code consists of its serial number and an additional number (1,2, or 3). The serial number can be found on the body of the LiDAR unit (below the QR code).The Broadcast Code may be used when you want to connect to the specific LiDAR unit(s). The detailed format is shown as below:

broadcast_code.png
Broadcast Code

4.3.1 Program Options

We provide the following program options for connecting the specific units and saving log file:

1 [-c]:Register LiDAR units by Broadcast Code. Connect the registered units ONLY.
2 [-l]:Save the log file(In the executable file's directory).
3 [-h]:Show help.

Here is the example:

1 ./lidar_sample -c "00000000000002&00000000000003&00000000000004" -l
2 ./hub_sample -c "00000000000001" -l

4.3.2 Edit Broadcast Code List

Comment the following code section:

1 /** Connect all the broadcast device. */
2 int lidar_count = 0;
3 char broadcast_code_list[kMaxLidarCount][kBroadcastCodeSize];

Remove the comment of the following code section, set the BROADCAST_CODE_LIST_SIZE and replace the broadcast code lists in the main.c for both LiDAR sample ({Livox-SDK}/sample/lidar/main.c) and Hub sample ({Livox-SDK}/sample/hub/main.c) with the broadcast code of your devices before building.

1 /** Connect the broadcast device in list, please input the broadcast code and modify the BROADCAST_CODE_LIST_SIZE. */
2 /*#define BROADCAST_CODE_LIST_SIZE 3
3 int lidar_count = BROADCAST_CODE_LIST_SIZE;
4 char broadcast_code_list[kMaxLidarCount][kBroadcastCodeSize] = {
5  "000000000000002",
6  "000000000000003",
7  "000000000000004"
8 };*/

4.4 Generate the lvx file

We provide the C++ sample to generate the lvx file for hub and LiDAR unit(s). You can use the same way in 4.2.1 and 4.2.2 to run them.

4.4.1 Program Options

You can alse use the program options in 4.3.1 to connect specific device and generate the log file, and we provide two new options for lvx file:

1 [-t] Time to save point cloud to the lvx file.(unit: s)
2 [-p] Get the extrinsic parameter from standard extrinsic.xml file(The same as viewer) in the executable file's directory.(Especially for LiDAR unit(s) as the hub will calculate the extrinsic parameter by itself)

Here is the example:

1 ./lidar_lvx_sample -c "00000000000002&00000000000003&00000000000004" -l -t 10 -p
2 ./hub_lvx_sample -c "00000000000001" -l -t 10

5 Support

You can get support from Livox with the following methods: