API Reference¶
The API is a DLL with C linkage.
The interface is provided via Ndigo_interface.h, which is provided
with the Ndigo5G driver. The driver can be downloaded from our
Ndigo5G product page.
By default, the installer will copy the interface and library files to
C:\Program Files\cronologic\NdigoSeries\driver.
When compiling, all interface .h and library .lib files must be
discoverable by your compiler and linker. They are located in include\ and
x64\ (or x64_32, if you are on a 32-bit system), respectively.
When running your program the dynamic link library DLLs containing the
actual driver code must reside in the same directory as your executable or be
in a directory included in the PATH variable.
Note that for Linux, the library files are provided only as a static .a
library.
Setting up and using an Ndigo5G
Setting up and using a Ndigo5G in your application software requires that you:
Initialize an Ndigo5G device (see Initialization).
Configure the initialized Ndigo5G device (see Configuration).
Start data acquisition (see Runtime Control).
Read data from the device (see Data Readout).
Process the data provided as packets (see Output Data Format).
Contents
- Initialization
- Configuration
- Runtime Control
- Data Readout
- Output Data Format
- Status Information
ndigo_get_device_type()ndigo_get_device_name()ndigo_get_param_info()ndigo_get_fast_info()ndigo_get_slow_info()ndigo_get_static_info()ndigo_get_buffer_info()ndigo_get_pcie_info()ndigo_clear_pcie_errors()ndigo_param_infondigo_fast_infondigo_slow_infondigo_static_infondigo_buffer_infocrono_pcie_info
- Driver Information
- LED Controls
- Constants
NDIGO_CHANNEL_COUNTNDIGO_GATE_COUNTNDIGO_EXTENSION_COUNTNDIGO_FIFO_DEPTHNDIGO_API_VERSIONNDIGO_STATIC_INFO_VERSIONNDIGO_FAST_INFO_VERSIONNDIGO_TRIGGER_COUNTNDIGO_ADD_TRIGGER_COUNTNDIGO_RAW_VALUE_MINNDIGO_RAW_VALUE_ZERONDIGO_RAW_VALUE_MAXNDIGO_RAW_VALUE_COUNTNDIGO_CALIBRATION_DATE_LENNDIGO_BITSTREAM_DATE_LENNDIGO_OKNDIGO_WINDRIVER_NOT_FOUNDNDIGO_DEVICE_NOT_FOUNDNDIGO_NOT_INITIALIZEDNDIGO_WRONG_STATENDIGO_INVALID_DEVICENDIGO_BUFFER_ALLOC_FAILEDNDIGO_TDC_NO_EDGE_FOUNDNDIGO_INVALID_BUFFER_PARAMETERSNDIGO_INVALID_CONFIG_PARAMETERSNDIGO_WINDOW_CALIBRATION_FAILEDNDIGO_HARDWARE_FAILURENDIGO_INVALID_ADC_MODENDIGO_SYNCHRONIZATION_FAILEDNDIGO_DEVICE_OPEN_FAILEDNDIGO_INTERNAL_ERRORNDIGO_INVALID_ARGUMENTSCRONO_PCIE_RX_ERRORCRONO_PCIE_BAD_TLPCRONO_PCIE_BAD_DLLPCRONO_PCIE_REPLAY_NUM_ROLLOVERCRONO_PCIE_REPLAY_TIMER_TIMEOUTCRONO_PCIE_ADVISORY_NON_FATALCRONO_PCIE_CORRECTED_INTERNAL_ERRORCRONO_PCIE_HEADER_LOG_OVERFLOWCRONO_PCIE_UNC_UNDEFINEDCRONO_PCIE_UNC_DATA_LINK_PROTOCOL_ERRORCRONO_PCIE_UNC_SURPRISE_DOWN_ERRORCRONO_PCIE_UNC_POISONED_TLPCRONO_PCIE_UNC_FLOW_CONTROL_PROTOCOL_ERRORCRONO_PCIE_UNC_COMPLETION_TIMEOUTCRONO_PCIE_UNC_COMPLETER_ABORTCRONO_PCIE_UNC_UNEXPECTED_COMPLETIONCRONO_PCIE_UNC_RECEIVER_OVERFLOW_ERRORCRONO_PCIE_UNC_MALFORMED_TLPCRONO_PCIE_UNC_ECRC_ERRORCRONO_PCIE_UNC_UNSUPPORED_REQUEST_ERRORCRONO_DEVICE_NDIGO5Gndigo_bool_t