NI-Sync LabVIEW API Reference

niSync Create Clock (VI)

  • Updated2024-03-29
  • 8 minute(s) read

niSync Create Clock (VI)

Installed With: NI-Sync

Generates a clock synchronized to the board time of the module you specify with instrument handle. Once you generate the clock in the specified terminal, you cannot use that terminal for other operations until you clear the clock with niSync Clear Clock or close the session with niSync Close.

When you invoke this VI, the digital signal on the specified terminal is driven low until the clock starts. After you create the clock, you can route it to other modules and devices using niSync Connect Clock Terminals. Depending on the instance you select, you can modify the clock's duty cycle, number of ticks, or the frequency at which it runs.

Note  This property is supported only on certain targets; refer to Target Support for Timing Properties for more information.

niSync Create Clock (Time)

When you create a clock using this instance, you can specify how long the clock runs at a high logic level and how long it runs at a low logic level.

niSync Create Clock (Time)

cdbl.gif

low time specifies, in seconds, how long you want the generated clock to run at the low logic state.

Note  Because you can only generate clocks on exact multiples of clock ticks, the requested low time and the actual clock low time may differ slightly. You can display the actual low time of the generated clock by wiring an indicator to the coerced low time terminal.
cdbl.gif

high time specifies, in seconds, how long you want the generated clock to run at the high logic state.

Note  Because you can only generate clocks on exact multiples of clock ticks, the high time you request and the actual high time may differ slightly. You can display the actual high time of the generated clock by wiring an indicator to the coerced high time terminal.
cio.gif

instrument handle specifies the instrument handle that you obtain from niSync Initialize.

cio.gif

terminal specifies the line you would like to generate the clock on. You cannot use this terminal for other operations until you clear the generated clock using niSync Clear Clock or you close the session with niSync Close.

cerrcodeclst.gif

error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality.

ctimestamp.gif

start time specifies when to start the generated clock. This time is synchronized with the board time of the module you use to create the clock. The default value is immediate, which generates the clock as soon as the VI is invoked.

ctimestamp.gif

stop time specifies when to stop the generated clock. This time is synchronized with the board time of the module you use to create the clock. The default value is never, in which case the clock will not stop until you invoke niSync Clear Clock or close the session.

iio.gif

instrument handle out returns the instrument handle that you obtain from niSync Initialize.

idbl.gif

coerced low time returns the actual duration, in seconds, of the generated clock's logic low state.

idbl.gif

coerced high time returns the actual duration, in seconds, of the generated clock's logic high state.

ierrcodeclst.gif

error out returns error conditions that occur after this node runs. This output provides standard error out functionality.

niSync Create Clock (Ticks)

Using this instance, you can generate a clock that runs for a specified number of high and low ticks every cycle.

niSync Create Clock (Ticks)

cu32.gif

low ticks specifies the number of ticks the generated clock should spend in the low logic state. You can view the length of a tick using the Clock Resolution parameter of the niSync Property Node.

cu32.gif

high ticks specifies the number of ticks the generated clock should spend in the high logic state. You can view the length of a tick using the Clock Resolution parameter in the niSync Property Node.

cio.gif

instrument handle specifies the instrument handle that you obtain from niSync Initialize.

cio.gif

terminal specifies the line you would like to generate the clock on. You cannot use this terminal for other operations until you clear the generated clock using niSync Clear Clock or you close the session with niSync Close.

cerrcodeclst.gif

error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality.

ctimestamp.gif

start time specifies when to start the generated clock. This time is synchronized with the board time of the module you use to create the clock. The default value is immediate, which generates the clock as soon as the VI is invoked.

ctimestamp.gif

stop time specifies when to stop the generated clock. This time is synchronized with the board time of the module you use to create the clock. The default value is never, in which case the clock will not stop until you invoke niSync Clear Clock or close the session.

iio.gif

instrument handle out returns the instrument handle that you obtain from niSync Initialize.

ierrcodeclst.gif

error out returns error conditions that occur after this node runs. This output provides standard error out functionality.

niSync Create Clock (Frequency)

Using this instance, you can generate a clock that runs at a custom frequency and duty cycle.

niSync Create Clock (Frequency)

cdbl.gif

duty cycle specifies the desired duty cycle—the ratio of high ticks to low ticks—of the generated clock.

Note  Because you can only generate clocks on exact multiples of clock ticks, the duty cycle you request and the actual duty cycle may differ slightly. You can display the actual duty cycle of the generated clock by wiring an indicator to the coerced duty cycle terminal.
cdbl.gif

frequency specifies the desired frequency of the generated clock.

Note  Because you can only generate clocks on exact multiples of clock ticks, the frequency you request and the actual clock frequency may differ slightly. You can display the actual frequency of the generated clock by wiring an indicator to the coerced frequency terminal.
cio.gif

instrument handle specifies the instrument handle that you obtain from niSync Initialize.

cio.gif

terminal specifies the line you would like to generate the clock on. You cannot use this terminal for other operations until you clear the generated clock using niSync Clear Clock or you close the session with niSync Close.

ctimestamp.gif

start time specifies when to start the generated clock. This time is synchronized with the board time of the module you use to create the clock. The default value is immediate, which generates the clock as soon as the VI is invoked.

ctimestamp.gif

stop time specifies when to stop the generated clock. This time is synchronized with the board time of the module you use to create the clock. The default value is never, in which case the clock will not stop until you invoke niSync Clear Clock or close the session.

cerrcodeclst.gif

error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality.

iio.gif

instrument handle out returns the instrument handle that you obtain from niSync Initialize.

idbl.gif

coerced frequency returns the actual frequency of the generated clock.

idbl.gif

coerced duty cycle returns the actual duty cycle of the generated clock.

ierrcodeclst.gif

error out returns error conditions that occur after this node runs. This output provides standard error out functionality.

Log in to get a better experience