nidaqmx.task.pause_trigger
- class nidaqmx._task_modules.triggering.pause_trigger.PauseTrigger(task_handle, interpreter)[source]
Bases:
objectRepresents the pause trigger configurations for a DAQmx task.
- property anlg_lvl_coupling
Specifies the coupling for the source signal of the trigger if the source is a terminal rather than a virtual channel.
- property anlg_lvl_dig_fltr_enable
Specifies whether to apply a digital filter to the digital output of the analog triggering circuitry (the Analog Comparison Event). When enabled, the analog signal must stay above or below the trigger level for the minimum pulse width before being recognized. Use filtering for noisy trigger signals that transition in and out of the hysteresis window rapidly.
- Type
bool
- property anlg_lvl_dig_fltr_min_pulse_width
Specifies in seconds the minimum pulse width the filter recognizes.
- Type
float
- property anlg_lvl_dig_fltr_timebase_rate
Specifies in hertz the rate of the digital filter timebase. NI-DAQmx uses this value to compute settings for the filter.
- Type
float
- property anlg_lvl_dig_fltr_timebase_src
Specifies the terminal of the signal to use as the timebase of the digital filter.
- Type
str
- property anlg_lvl_dig_sync_enable
Specifies whether to synchronize recognition of transitions in the signal to the internal timebase of the device.
- Type
bool
- property anlg_lvl_hyst
Specifies a hysteresis level in the units of the measurement or generation. If anlg_lvl_when is ActiveLevel.ABOVE, the trigger does not deassert until the source signal passes below anlg_lvl_lvl minus the hysteresis. If anlg_lvl_when is ActiveLevel.BELOW, the trigger does not deassert until the source signal passes above anlg_lvl_lvl plus the hysteresis. Hysteresis is always enabled. Set this property to a non-zero value to use hysteresis.
- Type
float
- property anlg_lvl_lvl
Specifies the threshold at which to pause the task. Specify this value in the units of the measurement or generation. Use anlg_lvl_when to specify whether the task pauses above or below this threshold.
- Type
float
- property anlg_lvl_src
Specifies the name of a virtual channel or terminal where there is an analog signal to use as the source of the trigger.
- Type
str
- property anlg_lvl_when
Specifies whether the task pauses above or below the threshold you specify with anlg_lvl_lvl.
- property anlg_win_btm
Specifies the lower limit of the window. Specify this value in the units of the measurement or generation.
- Type
float
- property anlg_win_coupling
Specifies the coupling for the source signal of the terminal if the source is a terminal rather than a virtual channel.
- property anlg_win_dig_fltr_enable
Specifies whether to apply a digital filter to the digital output of the analog triggering circuitry (the Analog Comparison Event). When enabled, the analog signal must stay within the trigger window for the minimum pulse width before being recognized. Use filtering for noisy trigger signals that transition in and out of the window rapidly.
- Type
bool
- property anlg_win_dig_fltr_min_pulse_width
Specifies in seconds the minimum pulse width the filter recognizes.
- Type
float
- property anlg_win_dig_fltr_timebase_rate
Specifies in hertz the rate of the digital filter timebase. NI-DAQmx uses this value to compute settings for the filter.
- Type
float
- property anlg_win_dig_fltr_timebase_src
Specifies the terminal of the signal to use as the timebase of the digital filter.
- Type
str
- property anlg_win_dig_sync_enable
Specifies whether to synchronize recognition of transitions in the signal to the internal timebase of the device.
- Type
bool
- property anlg_win_src
Specifies the name of a virtual channel or terminal where there is an analog signal to use as the source of the trigger.
- Type
str
- property anlg_win_top
Specifies the upper limit of the window. Specify this value in the units of the measurement or generation.
- Type
float
- property anlg_win_when
Specifies whether the task pauses while the trigger signal is inside or outside the window you specify with anlg_win_btm and anlg_win_top.
- property dig_lvl_dig_fltr_enable
Specifies whether to apply a digital filter to the trigger signal.
- Type
bool
- property dig_lvl_dig_fltr_min_pulse_width
Specifies in seconds the minimum pulse width the filter recognizes.
- Type
float
- property dig_lvl_dig_fltr_timebase_rate
Specifies in hertz the rate of the pulse width filter timebase. NI-DAQmx uses this value to compute settings for the filter.
- Type
float
- property dig_lvl_dig_fltr_timebase_src
Specifies the input terminal of the signal to use as the timebase of the pulse width filter.
- Type
str
- property dig_lvl_dig_sync_enable
Specifies whether to synchronize recognition of transitions in the signal to the internal timebase of the device.
- Type
bool
- property dig_lvl_src
Specifies the name of a terminal where there is a digital signal to use as the source of the Pause Trigger.
- Type
str
- property dig_lvl_when
Specifies whether the task pauses while the signal is high or low.
- property dig_pattern_pattern
Specifies the digital pattern that must be met for the Pause Trigger to occur.
- Type
str
- property dig_pattern_src
nidaqmx.system.physical_channel.PhysicalChannel: Specifies the physical channels to use for pattern matching. The order of the physical channels determines the order of the pattern. If a port is included, the lines within the port are in ascending order.
- property dig_pattern_when
Specifies if the Pause Trigger occurs when the physical channels specified with dig_pattern_src match or differ from the digital pattern specified with dig_pattern_pattern.
- property term
Indicates the name of the internal Pause Trigger terminal for the task. This property does not return the name of the trigger source terminal.
- Type
str
- property trig_type
Specifies the type of trigger to use to pause a task.