![]() |
Livox SDK API
V1.1.0
|
Go to the source code of this file.
Typedefs | |
| typedef void(* | DeviceBroadcastCallback) (const BroadcastDeviceInfo *info) |
| typedef void(* | DeviceStateUpdateCallback) (const DeviceInfo *device, DeviceEvent type) |
| typedef void(* | DeviceInformationCallback) (uint8_t status, uint8_t handle, DeviceInformationResponse *response, void *client_data) |
| typedef void(* | DataCallback) (uint8_t handle, LivoxEthPacket *data, uint32_t data_num) |
| typedef void(* | CommonCommandCallback) (uint8_t status, uint8_t handle, uint8_t response, void *client_data) |
| typedef void(* | ErrorMessageCallback) (uint8_t handle, ErrorMessage *message) |
| typedef void(* | GetDeviceIPInformationCallback) (uint8_t status, uint8_t handle, GetDeviceIPModeResponse *response, void *client_data) |
| typedef void(* | HubQueryLidarInformationCallback) (uint8_t status, uint8_t handle, HubQueryLidarInformationResponse *response, void *client_data) |
| typedef void(* | HubSetModeCallback) (uint8_t status, uint8_t handle, HubSetModeResponse *response, void *client_data) |
| typedef void(* | HubQueryLidarStatusCallback) (uint8_t status, uint8_t handle, HubQueryLidarStatusResponse *response, void *client_data) |
| typedef void(* | HubSetExtrinsicParameterCallback) (uint8_t status, uint8_t handle, HubSetExtrinsicParameterResponse *response, void *client_data) |
| typedef void(* | HubGetExtrinsicParameterCallback) (uint8_t status, uint8_t handle, HubGetExtrinsicParameterResponse *response, void *client_data) |
| typedef void(* | HubRainFogSuppressCallback) (uint8_t status, uint8_t handle, HubRainFogSuppressResponse *response, void *client_data) |
| typedef void(* | LidarGetExtrinsicParameterCallback) (uint8_t status, uint8_t handle, LidarGetExtrinsicParameterResponse *response, void *client_data) |
| typedef void(* CommonCommandCallback) (uint8_t status, uint8_t handle, uint8_t response, void *client_data) |
Function type of callback with 1 byte of response.
| status | kStatusSuccess on successful return, kStatusTimeout on timeout, see ResponseStatus for other error code. |
| handle | device handle. |
| response | response from the device. |
| client_data | user data associated with the command. |
Definition at line 170 of file livox_sdk.h.
| typedef void(* DataCallback) (uint8_t handle, LivoxEthPacket *data, uint32_t data_num) |
Callback function for receiving point cloud data.
| handle | device handle. |
| data | device's data. |
| data_num | number of points in data. |
Definition at line 153 of file livox_sdk.h.
| typedef void(* DeviceBroadcastCallback) (const BroadcastDeviceInfo *info) |
SetBroadcastCallback response callback function.
| info | information of the broadcast device, becomes invalid after the function returns. |
Definition at line 68 of file livox_sdk.h.
| typedef void(* DeviceInformationCallback) (uint8_t status, uint8_t handle, DeviceInformationResponse *response, void *client_data) |
Function type of callback that queries device's information.
| status | kStatusSuccess on successful return, kStatusTimeout on timeout, see ResponseStatus for other error code. |
| handle | device handle. |
| response | response from the device. |
| client_data | user data associated with the command. |
Definition at line 133 of file livox_sdk.h.
| typedef void(* DeviceStateUpdateCallback) (const DeviceInfo *device, DeviceEvent type) |
SetDeviceStateUpdateCallback response callback function.
| device | information of the connected device. |
| type | the update type that indicates connection/disconnection of the device or change of working state. |
Definition at line 82 of file livox_sdk.h.
| typedef void(* ErrorMessageCallback) (uint8_t handle, ErrorMessage *message) |
Callback of the error status message.
| handle | device handle. |
| response | response from the device. |
Definition at line 219 of file livox_sdk.h.
| typedef void(* GetDeviceIPInformationCallback) (uint8_t status, uint8_t handle, GetDeviceIPModeResponse *response, void *client_data) |
Callback function that gets device's IP information.
| status | kStatusSuccess on successful return, kStatusTimeout on timeout, see ResponseStatus for other error code. |
| handle | device handle. |
| response | response from the device. |
| client_data | user data associated with the command. |
Definition at line 250 of file livox_sdk.h.
| typedef void(* HubGetExtrinsicParameterCallback) (uint8_t status, uint8_t handle, HubGetExtrinsicParameterResponse *response, void *client_data) |
HubGetExtrinsicParameter response callback function.
| status | kStatusSuccess on successful return, kStatusTimeout on timeout, see ResponseStatus for other error code. |
| handle | device handle. |
| response | response from the device. |
| client_data | user data associated with the command. |
Definition at line 367 of file livox_sdk.h.
| typedef void(* HubQueryLidarInformationCallback) (uint8_t status, uint8_t handle, HubQueryLidarInformationResponse *response, void *client_data) |
HubQueryLidarInformation response callback function.
| status | kStatusSuccess on successful return, kStatusTimeout on timeout, see ResponseStatus for other error code. |
| handle | device handle. |
| response | response from the device. |
| client_data | user data associated with the command. |
Definition at line 272 of file livox_sdk.h.
| typedef void(* HubQueryLidarStatusCallback) (uint8_t status, uint8_t handle, HubQueryLidarStatusResponse *response, void *client_data) |
HubQueryLidarStatus response callback function.
| status | kStatusSuccess on successful return, kStatusTimeout on timeout, see ResponseStatus for other error code. |
| handle | device handle. |
| response | response from the device. |
| client_data | user data associated with the command. |
Definition at line 313 of file livox_sdk.h.
| typedef void(* HubRainFogSuppressCallback) (uint8_t status, uint8_t handle, HubRainFogSuppressResponse *response, void *client_data) |
HubRainFogSuppress response callback function.
| status | kStatusSuccess on successful return, kStatusTimeout on timeout, see ResponseStatus for other error code. |
| handle | device handle. |
| response | response from the device. |
| client_data | user data associated with the command. |
Definition at line 403 of file livox_sdk.h.
| typedef void(* HubSetExtrinsicParameterCallback) (uint8_t status, uint8_t handle, HubSetExtrinsicParameterResponse *response, void *client_data) |
HubSetExtrinsicParameter response callback function.
| status | kStatusSuccess on successful return, kStatusTimeout on timeout, see ResponseStatus for other error code. |
| handle | device handle. |
| response | response from the device. |
| client_data | user data associated with the command. |
Definition at line 341 of file livox_sdk.h.
| typedef void(* HubSetModeCallback) (uint8_t status, uint8_t handle, HubSetModeResponse *response, void *client_data) |
HubSetMode response callback function.
| status | kStatusSuccess on successful return, kStatusTimeout on timeout, see ResponseStatus for other error code. |
| handle | device handle. |
| response | response from the device. |
| client_data | user data associated with the command. |
Definition at line 293 of file livox_sdk.h.
| typedef void(* LidarGetExtrinsicParameterCallback) (uint8_t status, uint8_t handle, LidarGetExtrinsicParameterResponse *response, void *client_data) |
LidarGetExtrinsicParameter response callback function.
| status | kStatusSuccess on successful return, kStatusTimeout on timeout, see ResponseStatus for other error code. |
| handle | device handle. |
| response | response from the device. |
| client_data | user data associated with the command. |
Definition at line 472 of file livox_sdk.h.
| uint8_t AddHubToConnect | ( | const char * | broadcast_code, |
| uint8_t * | handle | ||
| ) |
Add a broadcast code to the connecting list and only devices with broadcast code in this list will be connected. The broadcast code is unique for every device.
| broadcast_code | device's broadcast code. |
| handle | device handle. For Livox Hub, the handle is always 31; for LiDAR units connected to the Livox Hub, the corresponding handle is (slot-1)*3+id-1. |
| uint8_t AddLidarToConnect | ( | const char * | broadcast_code, |
| uint8_t * | handle | ||
| ) |
Add a broadcast code to the connecting list and only devices with broadcast code in this list will be connected. The broadcast code is unique for every device.
| broadcast_code | device's broadcast code. |
| handle | device handle. The handle is the same as the order calling AddLidarToConnect starting from 0. |
| uint8_t GetConnectedDevices | ( | DeviceInfo * | devices, |
| uint8_t * | size | ||
| ) |
Get all connected devices' information.
| devices | list of connected devices' information. |
| size | number of devices connected. |
| uint8_t GetDeviceIPInformation | ( | uint8_t | handle, |
| GetDeviceIPInformationCallback | cb, | ||
| void * | client_data | ||
| ) |
Get device's IP mode.
| handle | device handle. |
| cb | callback for the command. |
| client_data | user data associated with the command. |
| void GetLivoxSdkVersion | ( | LivoxSdkVersion * | version | ) |
Return SDK's version information in a numeric form.
| version | Pointer to a version structure for returning the version information. |
| uint8_t HubControlSlotPower | ( | HubControlSlotPowerRequest * | req, |
| CommonCommandCallback | cb, | ||
| void * | client_data | ||
| ) |
Toggle the power supply of designated slots.
| req | request whether to enable or disable the power of designated slots. |
| cb | callback for the command. |
| client_data | user data associated with the command. |
| uint8_t HubExtrinsicParameterCalculation | ( | bool | enable, |
| CommonCommandCallback | cb, | ||
| void * | client_data | ||
| ) |
Turn on or off the calculation of extrinsic parameters.
| enable | the request whether enable or disable calculating the extrinsic parameters. |
| cb | callback for the command. |
| client_data | user data associated with the command. |
| uint8_t HubGetExtrinsicParameter | ( | HubGetExtrinsicParameterRequest * | req, |
| uint16_t | length, | ||
| HubGetExtrinsicParameterCallback | cb, | ||
| void * | client_data | ||
| ) |
Get extrinsic parameters of LiDAR units connected to the Livox Hub.
| req | the LiDAR units broadcast code list. |
| length | the request's length. |
| cb | callback for the command. |
| client_data | user data associated with the command. |
| uint8_t HubGetLidarHandle | ( | uint8_t | slot, |
| uint8_t | id | ||
| ) |
Get the LiDAR unit handle used in the Livox Hub data callback function from slot and id.
| slot | Livox Hub's slot. |
| id | Livox Hub's id. |
| uint8_t HubQueryLidarInformation | ( | HubQueryLidarInformationCallback | cb, |
| void * | client_data | ||
| ) |
Query the information of LiDARs connected to the hub.
| cb | callback for the command. |
| client_data | user data associated with the command. |
| uint8_t HubQueryLidarStatus | ( | HubQueryLidarStatusCallback | cb, |
| void * | client_data | ||
| ) |
Get the state of LiDAR units connected to the Livox Hub.
| cb | callback for the command. |
| client_data | user data associated with the command. |
| uint8_t HubRainFogSuppress | ( | HubRainFogSuppressRequest * | req, |
| uint16_t | length, | ||
| HubRainFogSuppressCallback | cb, | ||
| void * | client_data | ||
| ) |
Toggling the rain and fog mode for lidars connected to the hub.
| req | the request whether open or close the rain and fog mode. |
| length | the request's length. |
| cb | callback for the command. |
| client_data | user data associated with the command. |
| uint8_t HubSetExtrinsicParameter | ( | HubSetExtrinsicParameterRequest * | req, |
| uint16_t | length, | ||
| HubSetExtrinsicParameterCallback | cb, | ||
| void * | client_data | ||
| ) |
Set extrinsic parameters of LiDAR units connected to the Livox Hub.
| req | the parameters to write. |
| length | the request's length. |
| cb | callback for the command. |
| client_data | user data associated with the command. |
| uint8_t HubSetMode | ( | HubSetModeRequest * | req, |
| uint16_t | length, | ||
| HubSetModeCallback | cb, | ||
| void * | client_data | ||
| ) |
Set the mode of LiDAR unit connected to the Livox Hub.
| req | mode configuration of LiDAR units. |
| length | length of req. |
| cb | callback for the command. |
| client_data | user data associated with the command. |
| uint8_t HubStartSampling | ( | CommonCommandCallback | cb, |
| void * | client_data | ||
| ) |
Start hub sampling.
| cb | callback for the command. |
| client_data | user data associated with the command. |
| uint8_t HubStopSampling | ( | CommonCommandCallback | cb, |
| void * | client_data | ||
| ) |
Stop the Livox Hub's sampling.
| cb | callback for the command. |
| client_data | user data associated with the command. |
| bool Init | ( | ) |
Initialize the SDK.
| uint8_t LidarGetExtrinsicParameter | ( | uint8_t | handle, |
| LidarGetExtrinsicParameterCallback | cb, | ||
| void * | client_data | ||
| ) |
Get LiDAR extrinsic parameters.
| handle | device handle. |
| cb | callback for the command. |
| client_data | user data associated with the command. |
| uint8_t LidarRainFogSuppress | ( | uint8_t | handle, |
| bool | enable, | ||
| CommonCommandCallback | cb, | ||
| void * | client_data | ||
| ) |
Enable and disable the rain/fog suppression.
| handle | device handle. |
| cb | callback for the command. |
| client_data | user data associated with the command. |
| uint8_t LidarSetExtrinsicParameter | ( | uint8_t | handle, |
| LidarSetExtrinsicParameterRequest * | req, | ||
| CommonCommandCallback | cb, | ||
| void * | client_data | ||
| ) |
Set LiDAR extrinsic parameters.
| handle | device handle. |
| param | the parameters to write. |
| cb | callback for the command. |
| client_data | user data associated with the command. |
| uint8_t LidarSetMode | ( | uint8_t | handle, |
| LidarMode | mode, | ||
| CommonCommandCallback | cb, | ||
| void * | client_data | ||
| ) |
Set LiDAR mode.
| handle | device handle. |
| mode | the mode to change. |
| cb | callback for the command. |
| client_data | user data associated with the command. |
| uint8_t LidarStartSampling | ( | uint8_t | handle, |
| CommonCommandCallback | cb, | ||
| void * | client_data | ||
| ) |
Start LiDAR sampling.
| handle | device handle. |
| cb | callback for the command. |
| client_data | user data associated with the command. |
| uint8_t LidarStopSampling | ( | uint8_t | handle, |
| CommonCommandCallback | cb, | ||
| void * | client_data | ||
| ) |
Stop LiDAR sampling.
| handle | device handle. |
| cb | callback for the command. |
| client_data | user data associated with the command. |
| uint8_t QueryDeviceInformation | ( | uint8_t | handle, |
| DeviceInformationCallback | cb, | ||
| void * | client_data | ||
| ) |
Command to query device's information.
| handle | device handle. |
| cb | callback for the command. |
| client_data | user data associated with the command. |
| void SaveLoggerFile | ( | ) |
Save the log file.
| void SetBroadcastCallback | ( | DeviceBroadcastCallback | cb | ) |
Set the callback of listening device broadcast message. When broadcast message is received from Livox Hub/LiDAR, cb is called.
| cb | callback for device broadcast. |
| uint8_t SetCartesianCoordinate | ( | uint8_t | handle, |
| CommonCommandCallback | cb, | ||
| void * | client_data | ||
| ) |
Command to change point cloud coordinate system to cartesian coordinate.
| handle | device handle. |
| cb | callback for the command. |
| client_data | user data associated with the command. |
| void SetDataCallback | ( | uint8_t | handle, |
| DataCallback | cb | ||
| ) |
Set the callback to receive point cloud data. Only one callback is supported for a specific device. Set the point cloud data callback before beginning sampling.
| cb | callback to receive point cloud data. |
| void SetDeviceStateUpdateCallback | ( | DeviceStateUpdateCallback | cb | ) |
Add a callback for device connection or working state changing event.
| cb | callback for device connection/disconnection. |
| uint8_t SetErrorMessageCallback | ( | uint8_t | handle, |
| ErrorMessageCallback | cb | ||
| ) |
Add error status callback for the device.
| handle | device handle. |
| cb | callback for the command. |
| uint8_t SetSphericalCoordinate | ( | uint8_t | handle, |
| CommonCommandCallback | cb, | ||
| void * | client_data | ||
| ) |
Change point cloud coordinate system to spherical coordinate.
| handle | device handle. |
| cb | callback for the command. |
| client_data | user data associated with the command. |
| uint8_t SetStaticDynamicIP | ( | uint8_t | handle, |
| SetDeviceIPModeRequest * | req, | ||
| CommonCommandCallback | cb, | ||
| void * | client_data | ||
| ) |
Set device's IP mode.
| handle | device handle. |
| req | request sent to device. |
| cb | callback for the command. |
| client_data | user data associated with the command. |
| bool Start | ( | ) |
Start the device scanning routine which runs on a separate thread.
| void Uninit | ( | ) |
Uninitialize the SDK.