3 Driver Programming API

Attention

The API requires driver versions >2.0.0 and firmware 1.24120.

The API is a DLL with C linkage. Declarations of the interface are found in ndigo6g12_interface.h, provided by the Ndigo6G-12 driver.

This chapter provides an overview of the provided API functionality.

Contents of this Chapter

• 3.1 Constants
  • 3.1.1 General
  • 3.1.2 Trigger and Gating Block Sources
  • 3.1.3 Function return values
  • 3.1.4 Possible device states
  • 3.1.5 Alerts
  • 3.1.6 PCIe Information
• 3.2 Initialization
  • ndigo6g12_get_default_init_parameters_version()
  • ndigo6g12_init()
  • ndigo6g12_close()
  • ndigo6g12_device
  • ndigo6g12_init_parameters
• 3.3 Status information
  • ndigo6g12_get_driver_revision()
  • ndigo6g12_get_driver_revision_str()
  • ndigo6g12_count_devices()
  • ndigo6g12_get_static_info()
  • ndigo6g12_get_param_info()
  • ndigo6g12_get_fast_info()
  • ndigo6g12_get_pcie_info()
  • ndigo6g12_param_info
  • ndigo6g12_static_info
  • ndigo6g12_fast_info
  • crono_pcie_info
• 3.4 Configuration
  • ndigo6g12_get_default_configuration()
  • ndigo6g12_configure()
  • ndigo6g12_configuration
  • ndigo6g12_trigger
  • ndigo6g12_trigger_block
  • ndigo6g12_gating_block
  • ndigo6g12_tdc_configuration
  • ndigo6g12_averager_configuration
  • ndigo6g12_tdc_channel
  • ndigo6g12_tdc_gating_block
  • ndigo6g12_tdc_tiger_block
• 3.5 Runtime control
  • ndigo6g12_start_capture()
  • ndigo6g12_stop_capture()
  • ndigo6g12_manual_trigger()
  • ndigo6g12_single_shot()
  • ndigo6g12_clear_pcie_errors()
• 3.6 Readout
  • ndigo6g12_read()
  • ndigo6g12_get_last_error_message()
  • ndigo6g12_device_state_to_str()
  • ndigo6g12_read_in
  • ndigo6g12_read_out