Programmer's Guide

RaDeKL Radar API Programmer’s Guide 4

Usage Warnings

For proper operation of the RaDeKL radar unit using this API, please consider these warnings:

1. When operating the RaDeKL Radar in continuous detection mode, range data is continuously

streamed from the radar unit to the PC. While in this mode, the only operation, other than reading

this data, should be to stop continuous mode (using RaDeKL_StopContinuousDetection or a low-

level register write to do the same). Do not issue any other register read and/or write commands

(or high-level functions that read/write registers), as this will interfere with the continuous data

stream presented in continuous detection mode. Note: most functions that update (write) RaDeKL

registers attempt to read the data back to ensure that it was written correctly. Therefore any write-

ongoing continuous detection, producing unpredictable results (most likely resulting in an

input/output error). If a register must be updated, please first stop continuous detection mode,

change the register value and then restart continuous detection mode.

2. When operating the RaDeKL Radar in continuous detection mode and an error occurs (i.e. the

return value of the function called, if specified, is not equal RaDeKL_OK), it is up to the caller to:

a. Attempt to stop continuous detection mode on the radar unit by issuing a call to

RaDeKL_StopContinuousDetection. Depending on the specific error, it might not be

possible to actually communicate this command to the radar. The return code of this call

should therefore be ignored in this case only.

b. Ensure that the user interface or GUI appropriately shows that the radar is no longer

operating in continuous mode. This may entail updating indicators or graying out buttons.

c. In many error cases it may be necessary to close (if possible) and re-open the radar device

in order to re-establish communications with the unit (using RaDeKL_CloseRadar and

RaDeKL_OpenRadar, respectively). In some (rare) cases the unit may have to be either

power-cycled or unplugged and re-connected to the USB cable. Contrary to the FTDI USB

Chip documentation, this cannot always be done under program control.