NI-Sync LabVIEW API Reference

niSync Enable Time Stamp Trigger (VI)

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

niSync Enable Time Stamp Trigger (VI)

Installed With: NI-Sync

Creates a timestamp every time the signal of a specified trigger or clock changes. You can then read a single timestamp or multiple timestamps using niSync Read Trigger Time Stamp at a later point in the data flow.

You cannot use the input terminal specified in this VI for other operations until you disable the timestamp trigger using niSync Disable Time Stamp Trigger or close the session with niSync Close. You can create timestamps for triggers, future time events, clocks created using niSync Create Clock, and external devices.

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

Troubleshooting Overflow Errors

If you are recording multiple timestamps, you may encounter a software buffer overflow error. This means that LabVIEW does not have enough memory to store the timestamps you are trying to record. You can take one or more of the following actions to resolve a software buffer overflow error:

  • Set a higher value in the decimation count terminal.
  • Set the Time Stamp Buffer Size parameter in the niSync Property Node by selecting Timing»Time Stamps»Time Stamp Buffer Size. Use this value to manually adjust the size, in number of time stamps, of the software buffer where timestamps are stored.
  • Set the number of timestamps terminal in the niSync Read Trigger Time Stamp VI to a lower value.

niSync Enable Time Stamp Trigger

cu32.gif

decimation count specifies by how much to decimate incoming trigger events. Use this value to adjust the number of timestamps that should elapse before the next timestamp is recorded. For example, if you set the decimation count to 10, the VI will record every tenth timestamp. The value must be greater than or equal to one, and the default value is one.

cio.gif

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

cio.gif

terminal specifies the terminal that contains the trigger signal you would like to timestamp.

cenum.gif

active edge specifies at what point in the trigger signal to record a timestamp in the software buffer.

Valid values:

Value Description
rising Records a timestamp on the rising edge of the trigger, i.e. when the trigger signal transitions from low to high.
falling Records a timestamp on the falling edge of the trigger, i.e. when the trigger signal transitions from high to low.
any edge Records a timestamp on either the rising or the falling edge of the trigger.
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.

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