fix:Fix partial description errors

Livox-SDK
2019-05-18 18:28:53 +08:00
parent 55a9f4be37
commit f3c3f35644
2 changed files with 25 additions and 59 deletions
+1 -36
@@ -1,37 +1,2 @@
# Welcome to the Livox-SDK wiki # Welcome to the Livox-SDK wiki
This is a wiki for anything related to the Livox! This is a wiki for anything related to the Livox!
# 1 Quick Links
> * [LivoxTech Official website](https://www.livoxtech.com/)
> * [Livox SDK Communication Protocol PDF](https://www.livoxtech.com/sdk/downloads)
> * [Livox MID-40 && MID-100 LiDAR Manuals](https://www.livoxtech.com/mid-40-and-mid-100/downloads)
# 2 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](https://livox-sdk.github.io/Livox-SDK/) for further information.
## 2.1 Installation
The installation procedures in Ubuntu 16.04/14.04 32-bit LTS are shown here as examples.
### 2.1.1 Ubuntu 16.04/14.04 32-bit LTS
#### Dependencies
Livox SDK requires [CMake 3.0.0+](https://cmake.org/), [Apache Portable Runtime (APR) 1.61+](http://apr.apache.org/) and [Boost 1.54+](https://www.boost.org/) as dependencies. You need to install boost, cmake using apt:
```
sudo apt install cmake libboost-atomic-dev libboost-system-dev
```
And download the newest apr linux source file in [Apache Portable Runtime (APR) 1.61+](http://apr.apache.org/):
```
tar -zxvf apr-1.X.X.tar.gz
cd apr-1.X.X
./configure --prefix=/usr/local/apr --disable-lfs
make && sudo make install
```
#### Compile Livox SDK
In the Livox SDK directory, run the following commands to compile the project:
```
git clone https://github.com/Livox-SDK/Livox-SDK.git
cd Livox-SDK/build
PKG_CONFIG_PATH=$PKG_CONFIG_PATH:/usr/local/apr/lib/pkgconfig/ && export PKG_CONFIG_PATH
cmake ..
make
sudo make install
```
As the PKG_CONFIG_PATH will only take effect on the current terminal, next time please re-add it when you build project in another terminal or you can add it in your environment variables.
+24 -23
@@ -3,6 +3,7 @@
| **Document Release History** | | | | **Document Release History** | | |
| ---------------------------- | ----------- | ------------------------------------------------------------ | | ---------------------------- | ----------- | ------------------------------------------------------------ |
| **Date** | **Release** | **Change Description** | | **Date** | **Release** | **Change Description** |
| 2019/5/17 | v1.0.5 | Fix partial description errors |
| 2019/4/18 | v1.0.4 | 1. Update motor status code (v03.05.00.00+) <br>2. Add query Hub slot power status command (v08.05.00.00+) | | 2019/4/18 | v1.0.4 | 1. Update motor status code (v03.05.00.00+) <br>2. Add query Hub slot power status command (v08.05.00.00+) |
| 2019/4/17 | v1.0.3 | Update Hub read LiDAR extrinsic parameters description | | 2019/4/17 | v1.0.3 | Update Hub read LiDAR extrinsic parameters description |
| 2019/3/25 | v1.0.2 | Update 3.2 Time Stamp description | | 2019/3/25 | v1.0.2 | Update 3.2 Time Stamp description |
@@ -347,18 +348,18 @@ response
| | cmd_id | 1 | uint8_t | Command ID: 0x03 | | | cmd_id | 1 | uint8_t | Command ID: 0x03 |
| | ret_code | 2 | uint8_t | Return Code: <br>0x00: Success <br>0x01: Fail | | | ret_code | 2 | uint8_t | Return Code: <br>0x00: Success <br>0x01: Fail |
| | work_state | 3 | uint8_t | LiDAR State: <br>0x00: Initializing <br>0x01: Normal <br>0x02: Power-Saving <br>0x03: Standby <br>0x04: Error <br>Hub State: <br>0x00: Initializing <br>0x01: Normal <br>0x04: Error | | | work_state | 3 | uint8_t | LiDAR State: <br>0x00: Initializing <br>0x01: Normal <br>0x02: Power-Saving <br>0x03: Standby <br>0x04: Error <br>Hub State: <br>0x00: Initializing <br>0x01: Normal <br>0x04: Error |
| | feature_msg | 4 | uint8_t | LiDAR Feature Message:<br> Bit0: Rain/Fog Suppression Switch <br>0x00: Turn Off 0x01: Turn On <br>Bit1 ~ Bit7: Reserved <br>**Hub is Reserved** | | | feature_msg | 4 | uint8_t | LiDAR Feature Message:<br> Bit0: Rain/Fog Suppression Switch <br>0x00: Turn Off <br>0x01: Turn On <br>Bit1 ~ Bit7: Reserved <br>**Hub is Reserved** |
| | ack_msg | 5 | uint32_t | ACK Message:<br> Related to work_state:<br> work_state is 0x00: Initialization Progress <br>work_state is other: Status Code | | | ack_msg | 5 | uint32_t | ACK Message:<br> Related to work_state:<br> work_state is 0x00: Initialization Progress <br>work_state is other: Status Code |
### 0x04 Start/Stop Sampling ### 0x04 Start/Stop Sampling
request request
| CMD | Name | Offset (byte) | Data Type | Description | | CMD | Name | Offset (byte) | Data Type | Description |
|------|-------------|---------------|-----------|------------------------------------------| | ---- | ----------- | ------------- | --------- | -------------------------------------------- |
| data | cmd_set | 0 | uint8_t | General Command: 0x00 | | data | cmd_set | 0 | uint8_t | General Command: 0x00 |
| | cmd_id | 1 | uint8_t | Command ID: 0x04 | | | cmd_id | 1 | uint8_t | Command ID: 0x04 |
| | sample_ctrl | 2 | uint8_t | 0x00: Start Sampling <br>0x01: Stop Sampling | | | sample_ctrl | 2 | uint8_t | 0x00: Stop Sampling <br>0x01: Start Sampling |
response response
@@ -603,12 +604,12 @@ In return_list, each return information has the following format:
request request
| CMD | Name | Offset (byte) | Data Type | Description | | CMD | Name | Offset (byte) | Data Type | Description |
|------|------------|---------------|-----------|-----------------------------------------------------------| | ---- | ---------- | ------------- | --------- | --------------------------------------------------- |
| data | cmd_set | 0 | uint8_t | Hub Command: 0x02 | | data | cmd_set | 0 | uint8_t | Hub Command: 0x02 |
| | cmd_id | 1 | uint8_t | Command ID: 0x02 | | | cmd_id | 1 | uint8_t | Command ID: 0x02 |
| | slot_id | 2 | uint8_t | Slot id of Hub Range: 1 ~ 9 | | | slot_id | 2 | uint8_t | Slot id of Hub Range: 1 ~ 9 |
| | power_ctrl | 3 | uint8_t | Power Control (Default 0x00) <br>0x00: Turn Off <br>0x01: Turn On | | | power_ctrl | 3 | uint8_t | Power Control: <br>0x00: Turn Off <br>0x01: Turn On |
response response
@@ -643,20 +644,20 @@ In param_list, each LiDAR parameter configuration has the following format
response response
| ACK | Name | Offset (byte) | Data Type | Description | | ACK | Name | Offset (byte) | Data Type | Description |
|------|-------------|---------------|-----------|-----------------------------------------| | ---- | ----------- | ------------- | --------- | --------------------------------------------- |
| data | cmd_set | 0 | uint8_t | Hub Command: 0x02 | | data | cmd_set | 0 | uint8_t | Hub Command: 0x02 |
| | cmd_id | 1 | uint8_t | Command ID: 0x03 | | | cmd_id | 1 | uint8_t | Command ID: 0x03 |
| | ret_code | 2 | uint8_t | Return Code: 0x00: Success 0x01: Fail | | | ret_code | 2 | uint8_t | Return Code: <br>0x00: Success <br>0x01: Fail |
| | count | 3 | uint8_t | Number of LiDAR to Write Range: 1 ~ 27 | | | count | 3 | uint8_t | Number of LiDAR to Write Range: 1 ~ 27 |
| | return_list | 4 | -- | Return Information List | | | return_list | 4 | -- | Return Information List |
In return_list, each return information has the following format: In return_list, each return information has the following format:
| Field | Offset (byte) | Data Type | Description | | Field | Offset (byte) | Data Type | Description |
|----------------|---------------|-------------|---------------------------------------------| | -------------- | ------------- | ----------- | -------------------------------------------------- |
| ret_code | 0 | uint8_t | LiDAR Return Code:<br> 0x00: Success <br>0x01: Fail | | ret_code | 0 | uint8_t | LiDAR Return Code:<br>0x00: Success <br>0x01: Fail |
| broadcast_code | 1 | uint8_t[16] | LiDAR Broadcast Code | | broadcast_code | 1 | uint8_t[16] | LiDAR Broadcast Code |
### 0x04 Read LiDAR Extrinsic Parameters ### 0x04 Read LiDAR Extrinsic Parameters