Ilmsens HAL API  1.1.1
A cross-platform C-library for interfacing m:explore UWB-sensors
Measurement configuration

Macros

#define ILMSENS_HAL_SYNCH_OFF   0
 retract digital synchronisation, i.e. sensors will be unsynch'ed
 
#define ILMSENS_HAL_SYNCH_ON   1
 perform digital synchronisation, i.e. sensors will be synch'ed
 
#define ILMSENS_HAL_TX_OFF   1
 transmitter is in power down mode, i.e. output amplifier is switch off
 
#define ILMSENS_HAL_TX_ON   0
 transmitter is working, i.e. output amplifier is switched on
 

Functions

int ilmsens_hal_setAvg (unsigned int *pDevNums, unsigned int pNum, unsigned int pAvg, unsigned int pWaitCyc)
 Sets software averages and wait cycles. More...
 
int ilmsens_hal_setMLBS (unsigned int *pDevNums, unsigned int pNum)
 Resets the M-sequence generator (transmitter) of each device. More...
 
int ilmsens_hal_setPD (unsigned int *pDevNums, unsigned int pNum, int pPD)
 Controls the power-status of the transmitter. More...
 
int ilmsens_hal_synchMS (unsigned int *pDevNums, unsigned int pNum, int pMode)
 Performs digital synchronisation. More...
 

Detailed Description

Function Documentation

◆ ilmsens_hal_setAvg()

int ilmsens_hal_setAvg ( unsigned int *  pDevNums,
unsigned int  pNum,
unsigned int  pAvg,
unsigned int  pWaitCyc 
)

Sets software averages and wait cycles.

Software averages define the acquisition aperture duration. If wait cycles are set to 0, devices measure in continuous mode. If wait cycles are non-zero, devices measure in snapshot mode.

Note: May only be called when no measurement is running!

Parameters
pDevNumspointer to a first element or an array of device-indexes
pNumnumber of array-elements
pAvgnumber of Sw averages
pWaitCycnumber of wait cycles
Returns
ILMSENS_SUCCESS on success
negative error-code

◆ ilmsens_hal_setMLBS()

int ilmsens_hal_setMLBS ( unsigned int *  pDevNums,
unsigned int  pNum 
)

Resets the M-sequence generator (transmitter) of each device.

After digital synchronisation, the M-sequence generator (transmitter) of each device should be reset to ensure repeatable alignment of the transmitters and receivers. The reset typically takes a few ms to complete and cannot be used to mute the transmitter(s).

Note: May only be called when no measurement is running!

Parameters
pDevNumspointer to a first element or an array of device-indexes
pNumnumber of array-elements
Returns
ILMSENS_SUCCESS on success
negative error-code

◆ ilmsens_hal_setPD()

int ilmsens_hal_setPD ( unsigned int *  pDevNums,
unsigned int  pNum,
int  pPD 
)

Controls the power-status of the transmitter.

Note: May only be called when no measurement is running!

Parameters
pDevNumspointer to a first element or an array of device-indexes
pNumnumber of array-elements
pPDILMSENS_HAL_TX_ON = power-up the transmitter | ILMSENS_HAL_TX_OFF = power-down (mute) the transmitter
Returns
ILMSENS_SUCCESS on success
negative error-code

◆ ilmsens_hal_synchMS()

int ilmsens_hal_synchMS ( unsigned int *  pDevNums,
unsigned int  pNum,
int  pMode 
)

Performs digital synchronisation.

Must be used at least once before a measurement is started.

Parameters
pDevNumspointer to a first element or an array of device-indexes
pNumnumber of array-elements
pModeILMSENS_HAL_SYNCH_OFF = de-synchronise sensors (revoke) | ILMSENS_HAL_SYNCH_ON = trigger digital synchronisation
Returns
ILMSENS_SUCCESS on success
negative error-code