NI Modular Instruments Python API
master

Drivers

  • nidcpower module
  • nidigital module
  • nidmm module
  • nifgen module
  • niscope module
  • niswitch module
  • nise module
  • nimodinst module
  • nitclk module
    • Installation
    • Usage
    • API Reference
      • Public API
      • SessionReference
      • Exceptions and Warnings
      • Examples
NI Modular Instruments Python API
  • Docs »
  • nitclk module
  • Edit on GitHub

nitclk module¶

Installation¶

As a prerequisite to using the nitclk module, you must install the NI-TClk runtime on your system. Visit ni.com/downloads to download the driver runtime for your devices.

The nimi-python modules (i.e. for NI-TClk) can be installed with pip:

$ python -m pip install nitclk

Or easy_install from setuptools:

$ python -m easy_install nitclk

Usage¶

The following is a basic example of using the nitclk module

import nitclk

Other usage examples can be found on GitHub.

API Reference¶

  • Public API
    • configure_for_homogeneous_triggers
    • finish_sync_pulse_sender_synchronize
    • initiate
    • is_done
    • setup_for_sync_pulse_sender_synchronize
    • synchronize
    • synchronize_to_sync_pulse_sender
    • wait_until_done
  • SessionReference
    • exported_sync_pulse_output_terminal
    • exported_tclk_output_terminal
    • pause_trigger_master_session
    • ref_trigger_master_session
    • sample_clock_delay
    • sequencer_flag_master_session
    • start_trigger_master_session
    • sync_pulse_clock_source
    • sync_pulse_sender_sync_pulse_source
    • sync_pulse_source
    • tclk_actual_period
  • Exceptions and Warnings
    • Error
    • DriverError
    • UnsupportedConfigurationError
    • DriverNotInstalledError
    • DriverTooOldError
    • DriverTooNewError
    • DriverWarning
  • Examples
    • nitclk_niscope_synchronize_with_trigger.py
Next Previous

© Copyright 2017-2023, National Instruments Corporation Revision 47ce8555.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: master
Versions
master
latest
stable
1.4.3
1.4.2
1.4.1
1.4.0
1.3.3
1.3.2
1.3.1
1.3.0
1.2.1
1.2.0
1.1.5
1.1.4
1.1.3
1.1.2
1.1.0
1.0.1
1.0.0
0.9.0
0.8.0
driver_readme
cleanup_class_rst
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.