Ilmsens HAL API  1.1.1
A cross-platform C-library for interfacing m:explore UWB-sensors
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
ilmsens_hal.h File Reference

Function definitions for Ilmsens HAL API. More...

Functions

int ilmsens_hal_getVersion (struct ilmsens_hal_Version *pVersion)
 Return the HAL version.
int ilmsens_hal_setDEBLevel (unsigned int pLevel)
 Sets the verbosity of the diagnostics output Diagnostics are sent to std.
int ilmsens_hal_initHAL (void)
 Initializes the library.
void ilmsens_hal_deinitHAL (void)
 Deinitializes the library.
int ilmsens_hal_openSensors (unsigned int *pDevNums, unsigned int pNum)
 Allocates specified devices for a measurement session.
void ilmsens_hal_closeSensors (unsigned int *pDevNums, unsigned int pNum)
 Releases specified devices.
int ilmsens_hal_getModId (unsigned int pDevNum, char *pID, size_t pBufferSize)
 Gets unique device-identifier.
int ilmsens_hal_getModInfo (unsigned int pDevNum, struct ilmsens_hal_ModInfo *pInfo)
 Gets device hardware-configuration.
int ilmsens_hal_setupSensors (unsigned int *pDevNums, unsigned int pNum, const struct ilmsens_hal_ModConfig *pConfig)
 Performs the initial setup of specified devices.
int ilmsens_hal_setMaster (unsigned int *pDevNums, unsigned int pNum, int pMode)
 Sets master/slave operational mode.
int ilmsens_hal_setAvg (unsigned int *pDevNums, unsigned int pNum, unsigned int pAvg, unsigned int pWaitCyc)
 Sets software averages and wait cycles.
int ilmsens_hal_setMLBS (unsigned int *pDevNums, unsigned int pNum)
 Resets the M-sequence generator (transmitter) of each device.
int ilmsens_hal_setPD (unsigned int *pDevNums, unsigned int pNum, int pPD)
 Controls the power-status of the transmitter.
int ilmsens_hal_synchMS (unsigned int *pDevNums, unsigned int pNum, int pMode)
 Performs digital synchronisation.
int ilmsens_hal_measRun (unsigned int *pDevNums, unsigned int pNum, int pMode)
 Starts a measurement run with specified devices.
int ilmsens_hal_measStop (unsigned int *pDevNums, unsigned int pNum)
 Stops running measurement.
int ilmsens_hal_measRdy (unsigned int *pDevNums, unsigned int pNum)
 Reads the fill-level of the internal ring-buffer for all specified devices.
int ilmsens_hal_measRead (unsigned int *pDevNums, unsigned int pNum, ilmsens_hal_SampleType *pBuffer, size_t pBufSizeBytes)
 Reads the measurement data for all specified devices in non-blocking way.
int ilmsens_hal_measGet (unsigned int *pDevNums, unsigned int pNum, ilmsens_hal_SampleType *pBuffer, size_t pBufSizeBytes, unsigned int pTimeoutMillis)
 Blocks and reads the measurement data for all specified devices when it becomes available.
int ilmsens_hal_readReg (unsigned int *pDevNums, unsigned int pNum, unsigned int pReg, ilmsens_hal_MemoryType *pVal, size_t pBufSizeBytes)
 Reads value from register at pReg address from all specified devices to buffer.
int ilmsens_hal_writeReg (unsigned int *pDevNums, unsigned int pNum, unsigned int pReg, ilmsens_hal_MemoryType pVal)
 Writes pVal value to register at pReg address to all specified devices.
int ilmsens_hal_readBlk (unsigned int *pDevNums, unsigned int pNum, unsigned int pAdr, unsigned int pNumEl, ilmsens_hal_MemoryType *pVal, size_t pBufSizeBytes)
 Reads pNumEl elements (32-bit words) starting at address pAdr from the internal memory of specified devices into a buffer pVal.
int ilmsens_hal_writeBlk (unsigned int *pDevNums, unsigned int pNum, unsigned int pAdr, unsigned int pNumEl, ilmsens_hal_MemoryType *pVal, size_t pBufSizeBytes)
 Writes pNumEl elements (32-bit words) from buffer pVal to internal memory starting at address pAdr of specified devices.

Detailed Description

Function definitions for Ilmsens HAL API.

This header contains prototypes for the exported functions of the HAL library.

Author
Ralf Herrmann ralf..nosp@m.herr.nosp@m.mann@.nosp@m.ilms.nosp@m.ens.c.nosp@m.om