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
Measurement run

Functions to start/stop measurements with one or more devices. More...

Macros

#define ILMSENS_HAL_RUN_OFF   0
 sensor is currently not measuring
 
#define ILMSENS_HAL_RUN_RAW   1
 sensor is measuring and data is not buffered by API
 
#define ILMSENS_HAL_RUN_BUF   2
 sensor is measuring and data is buffered by API in separate thread
 

Functions

int ilmsens_hal_measRun (unsigned int *pDevNums, unsigned int pNum, int pMode)
 Starts a measurement run with specified devices. More...
 
int ilmsens_hal_measStop (unsigned int *pDevNums, unsigned int pNum)
 Stops running measurement. More...
 

Detailed Description

Functions to start/stop measurements with one or more devices.

The library supports two modes of operation for transfering measured data from the device-buffer memory to the host-system memory (HAL or application).

Note: The buffered mode is the preferred mode of operation of the library.

Function Documentation

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

Starts a measurement run with specified devices.

One measurement run may be pending at a time.

Parameters
pDevNumspointer to a first element or an array of device-indexes
pNumnumber of array-elements
pModespecifies the mode of operation (ILMSENS_HAL_RUN_RAW for raw mode of operation, ILMSENS_HAL_RUN_BUF for buffered mode of operation)
Returns
ILMSENS_SUCCESS on success
negative error-code
See Also
ilmsens_hal_measStop()
int ilmsens_hal_measStop ( unsigned int *  pDevNums,
unsigned int  pNum 
)

Stops running measurement.

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