Ilmsens HAL API  1.1.1
A cross-platform C-library for interfacing m:explore UWB-sensors
Device ID & properties

Functions for identification and access to hardware-parameters of connected devices. More...

Data Structures

struct  ilmsens_hal_ModInfo
 Represents the device configuration & runtime parameters and limits. More...
 

Macros

#define ILMSENS_HAL_MOD_ID_BUF_SIZE   1024
 maximum length buffer size for retrieving the unique ID string.
 

Functions

int ilmsens_hal_getModId (unsigned int pDevNum, char *pID, size_t pBufferSize)
 Gets unique device-identifier. More...
 
int ilmsens_hal_getModInfo (unsigned int pDevNum, struct ilmsens_hal_ModInfo *pInfo)
 Gets device hardware-configuration. More...
 

Detailed Description

Functions for identification and access to hardware-parameters of connected devices.

Function Documentation

◆ ilmsens_hal_getModId()

int ilmsens_hal_getModId ( unsigned int  pDevNum,
char *  pID,
size_t  pBufferSize 
)

Gets unique device-identifier.

Parameters
pDevNumdevice-index
pIDpointer to an output buffer
pBufferSizeSize of buffer pointed to by pID in bytes. Maximum ID length is given via ILMSENS_HAL_MOD_ID_BUF_SIZE.
Returns
number of characters written to the buffer
negative error-code

◆ ilmsens_hal_getModInfo()

int ilmsens_hal_getModInfo ( unsigned int  pDevNum,
struct ilmsens_hal_ModInfo pInfo 
)

Gets device hardware-configuration.

Parameters
pDevNumdevice-index
pInfopointer to the ilmsens_hal_ModInfo structure
Returns
ILMSENS_SUCCESS on success (and populates pInfo)
negative error-code