nidaqmx.task.triggering

class nidaqmx.task.triggering.Triggers(task_handle, interpreter)

Bases: object

Represents the trigger configurations for a DAQmx task.

property arm_start_trigger: ArmStartTrigger

Gets the arm start trigger configurations for the task.

property handshake_trigger: HandshakeTrigger

Gets the handshake trigger configurations for the task.

property pause_trigger: PauseTrigger

Gets the pause trigger configurations for the task.

property reference_trigger: ReferenceTrigger

Gets the reference trigger configurations for the task.

property start_trigger: StartTrigger

Gets the start trigger configurations for the task.

property sync_type

Specifies the role of the device in a synchronized system. Setting this value to SyncType.MASTER or SyncType.SLAVE enables trigger skew correction. If you enable trigger skew correction, set this property to SyncType.MASTER on only one device, and set this property to SyncType.SLAVE on the other devices.

Type:

nidaqmx.constants.SyncType

class nidaqmx.task.triggering.ArmStartTrigger(task_handle, interpreter)

Bases: object

Represents the arm start trigger configurations for a DAQmx task.

property dig_edge_dig_fltr_enable

Specifies whether to apply the pulse width filter to the signal.

Type:

bool

property dig_edge_dig_fltr_min_pulse_width

Specifies in seconds the minimum pulse width the filter recognizes.

Type:

float

property dig_edge_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_edge_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_edge_dig_sync_enable

Specifies whether to synchronize recognition of transitions in the signal to the internal timebase of the device.

Type:

bool

property dig_edge_edge

Specifies on which edge of a digital signal to arm the task for a Start Trigger.

Type:

nidaqmx.constants.Edge

property dig_edge_src

Specifies the name of a terminal where there is a digital signal to use as the source of the Arm Start Trigger.

Type:

str

property term

Indicates the name of the internal Arm Start Trigger terminal for the task. This property does not return the name of the trigger source terminal.

Type:

str

property time_timescale

Specifies the timescale to be used for timestamps used in an arm start time trigger.

Type:

nidaqmx.constants.Timescale

property time_when

Specifies when to trigger the arm start trigger.

Type:

datetime

property timestamp_enable

Specifies whether the arm start trigger timestamp is enabled. If the timestamp is enabled but no resources are available, an error will be returned at run time.

Type:

bool

property timestamp_timescale

Specifies the arm start trigger timestamp timescale.

Type:

nidaqmx.constants.Timescale

property trig_type

Specifies the type of trigger to use to arm the task for a Start Trigger. If you configure an Arm Start Trigger, the task does not respond to a Start Trigger until the device receives the Arm Start Trigger.

Type:

nidaqmx.constants.TriggerType

class nidaqmx.task.triggering.HandshakeTrigger(task_handle, interpreter)

Bases: object

Represents the handshake trigger configurations for a DAQmx task.

property interlocked_asserted_lvl

Specifies the asserted level of the Handshake Trigger.

Type:

nidaqmx.constants.Level

property interlocked_src

Specifies the source terminal of the Handshake Trigger.

Type:

str

property trig_type

Specifies the type of Handshake Trigger to use.

Type:

nidaqmx.constants.TriggerType

class nidaqmx.task.triggering.PauseTrigger(task_handle, interpreter)

Bases: object

Represents 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.

Type:

nidaqmx.constants.Coupling

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.

Type:

nidaqmx.constants.ActiveLevel

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.

Type:

nidaqmx.constants.Coupling

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.

Type:

nidaqmx.constants.WindowTriggerCondition2

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.

Type:

nidaqmx.constants.Level

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.

Type:

nidaqmx.constants.DigitalPatternCondition

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.

Type:

nidaqmx.constants.TriggerType

class nidaqmx.task.triggering.ReferenceTrigger(task_handle, interpreter)

Bases: object

Represents the reference trigger configurations for a DAQmx task.

property anlg_edge_coupling

Specifies the coupling for the source signal of the trigger if the source is a terminal rather than a virtual channel.

Type:

nidaqmx.constants.Coupling

property anlg_edge_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_edge_dig_fltr_min_pulse_width

Specifies in seconds the minimum pulse width thefilter recognizes.

Type:

float

property anlg_edge_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_edge_dig_fltr_timebase_src

Specifies the terminal of the signal to use as the timebase of the digital filter.

Type:

str

property anlg_edge_dig_sync_enable

Specifies whether to synchronize recognition of transitions in the signal to the internal timebase of the device.

Type:

bool

property anlg_edge_hyst

Specifies a hysteresis level in the units of the measurement. If anlg_edge_slope is Slope1.RISING, the trigger does not deassert until the source signal passes below anlg_edge_lvl minus the hysteresis. If anlg_edge_slope is Slope1.FALLING, the trigger does not deassert until the source signal passes above anlg_edge_lvl plus the hysteresis. Hysteresis is always enabled. Set this property to a non-zero value to use hysteresis.

Type:

float

property anlg_edge_lvl

Specifies in the units of the measurement the threshold at which the Reference Trigger occurs. Use anlg_edge_slope to specify on which slope to trigger at this threshold.

Type:

float

property anlg_edge_slope

Specifies on which slope of the source signal the Reference Trigger occurs.

Type:

nidaqmx.constants.Slope

property anlg_edge_src

Specifies the name of a virtual channel or terminal where there is an analog signal to use as the source of the Reference Trigger.

Type:

str

property anlg_multi_edge_couplings

Specifies an list that describes the couplings for the corresponding source signal of the trigger if the source is a terminal rather than a virtual channel. Each element of the list corresponds to a source in Ref.AnlgMultiEdge.Srcs and an element in each of the other Analog Multi Edge property lists, if they are not empty.

Type:

List[nidaqmx.constants.Coupling]

property anlg_multi_edge_hysts

Specifies an list of hysteresis levels in the units of the measurement or generation. If the corresponding element of Ref.AnlgMultiEdge.Slopes is Rising, the trigger does not deassert until the source signal passes below the corresponding element of Ref.AnlgMultiEdge.Lvls minus the hysteresis. If Ref.AnlgEdge.Slope is Falling, the trigger does not deassert until the source signal passes above Ref.AnlgEdge.Lvl plus the hysteresis. Hysteresis is always enabled. Set this property to a non-zero value to use hysteresis. Each element of the list corresponds to a source in Ref.AnlgMultiEdge.Srcs and an element in each of the other Analog Multi Edge property lists, if they are not empty.

Type:

List[float]

property anlg_multi_edge_lvls

Specifies an list of thresholds in the units of the measurement or generation to start acquiring or generating samples. Each element of the list corresponds to a source in Ref.AnlgMultiEdge.Srcs and an element in each of the other Analog Multi Edge property lists, if they are not empty.

Type:

List[float]

property anlg_multi_edge_slopes

Specifies an list of slopes on which to trigger task to start generating or acquiring samples. Each element of the list corresponds to a source in Ref.AnlgMultiEdge.Srcs and an element in each of the other Analog Multi Edge property lists, if they are not empty.

Type:

List[nidaqmx.constants.Slope]

property anlg_multi_edge_srcs

Specifies a List and/or range of analog sources that are going to be used for Analog triggering. Each source corresponds to an element in each of the Analog Multi Edge property lists, if they are not empty.

Type:

str

property anlg_win_btm

Specifies the lower limit of the window. Specify this value in the units of the measurement.

Type:

float

property anlg_win_coupling

Specifies the coupling for the source signal of the trigger if the source is a terminal rather than a virtual channel.

Type:

nidaqmx.constants.Coupling

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 Reference Trigger.

Type:

str

property anlg_win_top

Specifies the upper limit of the window. Specify this value in the units of the measurement.

Type:

float

property anlg_win_trig_when

Specifies whether the Reference Trigger occurs when the source signal enters the window or when it leaves the window. Use anlg_win_btm and anlg_win_top to specify the window.

Type:

nidaqmx.constants.WindowTriggerCondition1

property auto_trig_enable

Specifies whether to send a software trigger to the device when a hardware trigger is no longer active in order to prevent a timeout.

Type:

bool

property auto_triggered

Indicates whether a completed acquisition was triggered by the auto trigger. If an acquisition has not completed after the task starts, this property returns False. This property is only applicable when auto_trig_enable is True.

Type:

bool

property delay

Specifies in seconds the time to wait after the device receives the Reference Trigger before switching from pretrigger to posttrigger samples.

Type:

float

property dig_edge_dig_fltr_enable

Specifies whether to apply a digital filter to the trigger signal.

Type:

bool

property dig_edge_dig_fltr_min_pulse_width

Specifies in seconds the minimum pulse width the filter recognizes.

Type:

float

property dig_edge_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 dig_edge_dig_fltr_timebase_src

Specifies the terminal of the signal to use as the timebase of the digital filter.

Type:

str

property dig_edge_dig_sync_enable

Specifies whether to synchronize recognition of transitions in the signal to the internal timebase of the device.

Type:

bool

property dig_edge_edge

Specifies on what edge of a digital pulse the Reference Trigger occurs.

Type:

nidaqmx.constants.Edge

property dig_edge_src

Specifies the name of a terminal where there is a digital signal to use as the source of the Reference Trigger.

Type:

str

property dig_pattern_pattern

Specifies the digital pattern that must be met for the Reference 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 order of the physical channels within the port is in ascending order.

property dig_pattern_trig_when

Specifies whether the Reference Trigger occurs when the physical channels specified with dig_pattern_src match or differ from the digital pattern specified with dig_pattern_pattern.

Type:

nidaqmx.constants.DigitalPatternCondition

property max_num_trigs_to_detect

Specifies the maximum number of times the task will detect a reference trigger during the task. The number of times a trigger is detected and acted upon by the module may be less than the specified amount if the task stops early because of trigger/retrigger window expiration. Specifying the Maximum Number of Triggers to Detect to be 0 causes the driver to automatically set this value to the maximum possible number of triggers detectable by the device and configuration combination. Note: The number of detected triggers may be less than number of trigger events occurring, because the devices were unable to respond to the trigger.

Type:

int

property pretrig_samples

Specifies the minimum number of pretrigger samples to acquire from each channel before recognizing the reference trigger. Post-trigger samples per channel are equal to samp_quant_samp_per_chan minus the number of pretrigger samples per channel.

Type:

int

property retrigger_win

Specifies the duration in seconds after each trigger during which the device may trigger. Once the window has passed, the device stops detecting triggers, and the task will stop after the device finishes acquiring post-trigger samples that it already started. Specifying a Retrigger Window of -1 causes the window to be infinite.

Type:

float

property retriggerable

Specifies whether a finite task resets, acquires pretrigger samples, and waits for another Reference Trigger after the task completes. When you set this property to True, the device will acquire post-trigger samples, reset, and acquire pretrigger samples each time the Reference Trigger occurs until the task stops. The device ignores a trigger if it is in the process of acquiring signals.

Type:

bool

property term

Indicates the name of the internal Reference Trigger terminal for the task. This property does not return the name of the trigger source terminal.

Type:

str

property timestamp_enable

Specifies whether the reference trigger timestamp is enabled. If the timestamp is enabled but no resources are available, an error will be returned at run time.

Type:

bool

property timestamp_timescale

Specifies the reference trigger timestamp timescale.

Type:

nidaqmx.constants.Timescale

property trig_type

Specifies the type of trigger to use to mark a reference point for the measurement.

Type:

nidaqmx.constants.TriggerType

property trig_win

Specifies the duration in seconds after the task starts during which the device may trigger. Once the window has passed, the device stops detecting triggers, and the task will stop after the device finishes acquiring post-trigger samples that it already started. If no triggers are detected during the entire period, then no data will be returned. Specifying a Trigger Window of -1 causes the window to be infinite.

Type:

float

cfg_anlg_edge_ref_trig(trigger_source, pretrigger_samples, trigger_slope=Slope.RISING, trigger_level=0.0)

Configures the task to stop the acquisition when the device acquires all pretrigger samples; an analog signal reaches the level you specify; and the device acquires all post-trigger samples. When you use a Reference Trigger, the default for the read RelativeTo property is first_pretrigger_sample with a read Offset of 0.

Parameters:

• trigger_source (str) – Is the name of a virtual channel or terminal where there is an analog signal to use as the source of the trigger.

• pretrigger_samples (int) – Specifies the minimum number of samples to acquire per channel before recognizing the Reference Trigger. The number of post-trigger samples per channel is equal to number of samples per channel in the DAQmx Timing function minus pretrigger_samples.

• trigger_slope (Optional[nidaqmx.constants.Slope]) – Specifies on which slope of the signal the Reference Trigger occurs.

• trigger_level (Optional[float]) – Specifies at what threshold to trigger. Specify this value in the units of the measurement or generation. Use trigger_slope to specify on which slope to trigger at this threshold.

cfg_anlg_multi_edge_ref_trig(trigger_sources, pretrigger_samples, trigger_slope_array=None, trigger_level_array=None)

Configures the task to stop the acquisition when the device acquires all pretrigger samples; any of the configured analog signals cross the respective levels you specified; and the device acquires all post-trigger samples. When you use a Reference Trigger, the default for the read RelativeTo property is First Pretrigger Sample with a read Offset of 0. Multi-edge triggering treats the specified triggers as if a logical OR is applied.

Parameters:

• trigger_sources (str) – Is the name of a virtual channel or terminal where there is an analog signal to use as the source of the trigger.

• pretrigger_samples (int) – Specifies the minimum number of samples to acquire per channel before recognizing the Reference Trigger. The number of post-trigger samples per channel is equal to number of samples per channel in the DAQmx Timing VI minus pretrigger samples per channel.

• trigger_slope_array (Optional[List[nidaqmx.constants.Slope]]) – Specifies on which slope of the signal the Reference Trigger occurs.

• trigger_level_array (Optional[List[float]]) – Specifies at what threshold to trigger. Specify this value in the units of the measurement or generation. Use slope to specify on which slope to trigger at this threshold.

cfg_anlg_window_ref_trig(trigger_source, window_top, window_bottom, pretrigger_samples, trigger_when=WindowTriggerCondition1.ENTERING_WINDOW)

Configures the task to stop the acquisition when the device acquires all pretrigger samples; an analog signal enters or leaves a range you specify; and the device acquires all post- trigger samples. When you use a Reference Trigger, the default for the read RelativeTo property is first_pretrigger_sample with a read Offset of 0.

Parameters:

• trigger_source (str) – Is the name of a virtual channel or terminal where there is an analog signal to use as the source of the trigger.

• window_top (float) – Is the upper limit of the window. Specify this value in the units of the measurement or generation.

• window_bottom (float) – Is the lower limit of the window. Specify this value in the units of the measurement or generation.

• pretrigger_samples (int) – Specifies the minimum number of samples to acquire per channel before recognizing the Reference Trigger. The number of post-trigger samples per channel is equal to number of samples per channel in the DAQmx Timing function minus pretrigger_samples.

• trigger_when (Optional[nidaqmx.constants.WindowTriggerCondition1]) – Specifies whether the Reference Trigger occurs when the signal enters the window or when it leaves the window. Use window_bottom and window_top to specify the limits of the window.

cfg_dig_edge_ref_trig(trigger_source, pretrigger_samples, trigger_edge=Edge.RISING)

Configures the task to stop the acquisition when the device acquires all pretrigger samples, detects a rising or falling edge of a digital signal, and acquires all posttrigger samples. When you use a Reference Trigger, the default for the read RelativeTo property is first_pretrigger_sample with a read Offset of 0.

Parameters:

• trigger_source (str) – Specifies the name of a terminal where there is a digital signal to use as the source of the trigger.

• pretrigger_samples (int) – Specifies the minimum number of samples to acquire per channel before recognizing the Reference Trigger. The number of post-trigger samples per channel is equal to number of samples per channel in the DAQmx Timing function minus pretrigger_samples.

• trigger_edge (Optional[nidaqmx.constants.Edge]) – Specifies on which edge of the digital signal the Reference Trigger occurs.

cfg_dig_pattern_ref_trig(trigger_source, trigger_pattern, pretrigger_samples, trigger_when=DigitalPatternCondition.PATTERN_MATCHES)

Configures the task to stop the acquisition when the device acquires all pretrigger samples, matches a digital pattern, and acquires all posttrigger samples. When you use a Reference Trigger, the default for the read RelativeTo property is First PretriggerSample with a read Offset of zero.

Parameters:

• trigger_source (str) – 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 order of the physical channels within the port is in ascending order.

• trigger_pattern (str) – Specifies the digital pattern that must be met for the trigger to occur.

• pretrigger_samples (int) – Specifies the minimum number of samples to acquire per channel before recognizing the Reference Trigger. The number of post-trigger samples per channel is equal to number of samples per channel in the DAQmx Timing function minus pretrigger_samples.

• trigger_when (Optional[nidaqmx.constants.DigitalPatternCondition]) – Specifies the condition under which the trigger occurs.

disable_ref_trig()

Disables reference triggering for the measurement.

class nidaqmx.task.triggering.StartTrigger(task_handle, interpreter)

Bases: object

Represents the start trigger configurations for a DAQmx task.

property anlg_edge_coupling

Specifies the coupling for the source signal of the trigger if the source is a terminal rather than a virtual channel.

Type:

nidaqmx.constants.Coupling

property anlg_edge_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_edge_dig_fltr_min_pulse_width

Specifies in seconds the minimum pulse width the filter recognizes.

Type:

float

property anlg_edge_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_edge_dig_fltr_timebase_src

Specifies the terminal of the signal to use as the timebase of the digital filter.

Type:

str

property anlg_edge_dig_sync_enable

Specifies whether to synchronize recognition of transitions in the signal to the internal timebase of the device.

Type:

bool

property anlg_edge_hyst

Specifies a hysteresis level in the units of the measurement or generation. If anlg_edge_slope is Slope1.RISING, the trigger does not deassert until the source signal passes below anlg_edge_lvl minus the hysteresis. If anlg_edge_slope is Slope1.FALLING, the trigger does not deassert until the source signal passes above anlg_edge_lvl plus the hysteresis. Hysteresis is always enabled. Set this property to a non-zero value to use hysteresis.

Type:

float

property anlg_edge_lvl

Specifies at what threshold in the units of the measurement or generation to start acquiring or generating samples. Use anlg_edge_slope to specify on which slope to trigger on this threshold.

Type:

float

property anlg_edge_slope

Specifies on which slope of the trigger signal to start acquiring or generating samples.

Type:

nidaqmx.constants.Slope

property anlg_edge_src

Specifies the name of a virtual channel or terminal where there is an analog signal to use as the source of the Start Trigger.

Type:

str

property anlg_multi_edge_couplings

Specifies an list that describes the couplings for the corresponding source signal of the trigger if the source is a terminal rather than a virtual channel. Each element of the list corresponds to a source in Start.AnlgMultiEdge.Srcs and an element in each of the other Analog Multi Edge property lists, if they are not empty.

Type:

List[nidaqmx.constants.Coupling]

property anlg_multi_edge_hysts

Specifies an list of hysteresis levels in the units of the measurement or generation. If the corresponding element of Start.AnlgMultiEdge.Slopes is Rising, the trigger does not deassert until the source signal passes below the corresponding element of Start.AnlgMultiEdge.Lvls minus the hysteresis. If Start.AnlgEdge.Slope is Falling, the trigger does not deassert until the source signal passes above Start.AnlgEdge.Lvl plus the hysteresis. Hysteresis is always enabled. Set this property to a non-zero value to use hysteresis. Each element of the list corresponds to a source in Start.AnlgMultiEdge.Srcs and an element in each of the other Analog Multi Edge property lists, if they are not empty.

Type:

List[float]

property anlg_multi_edge_lvls

Specifies an list of thresholds in the units of the measurement or generation to start acquiring or generating samples. Each element of the list corresponds to a source in Start.AnlgMultiEdge.Srcs and an element in each of the other Analog Multi Edge property lists, if they are not empty.

Type:

List[float]

property anlg_multi_edge_slopes

Specifies an list of slopes on which to trigger task to start generating or acquiring samples. Each element of the list corresponds to a source in Start.AnlgMultiEdge.Srcs and an element in each of the other Analog Multi Edge property lists, if they are not empty.

Type:

List[nidaqmx.constants.Slope]

property anlg_multi_edge_srcs

Specifies a list and/or range of analog sources that are going to be used for Analog triggering. Each source corresponds to an element in each of the Analog Multi Edge property lists, if they are not empty.

Type:

str

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 trigger if the source is a terminal rather than a virtual channel.

Type:

nidaqmx.constants.Coupling

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 Start 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_trig_when

Specifies whether the task starts acquiring or generating samples when the signal enters or leaves the window you specify with anlg_win_btm and anlg_win_top.

Type:

nidaqmx.constants.WindowTriggerCondition1

property delay

Specifies an amount of time to wait after the Start Trigger is received before acquiring or generating the first sample. This value is in the units you specify with delay_units.

Type:

float

property delay_units

Specifies the units of delay.

Type:

nidaqmx.constants.DigitalWidthUnits

property dig_edge_dig_fltr_enable

Specifies whether to apply a digital filter to the trigger signal.

Type:

bool

property dig_edge_dig_fltr_min_pulse_width

Specifies in seconds the minimum pulse width the filter recognizes.

Type:

float

property dig_edge_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_edge_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_edge_dig_sync_enable

Specifies whether to synchronize recognition of transitions in the signal to the internal timebase of the device. If you set this property to True, the device does not recognize and act upon the trigger until the next pulse of the internal timebase.

Type:

bool

property dig_edge_edge

Specifies on which edge of a digital pulse to start acquiring or generating samples.

Type:

nidaqmx.constants.Edge

property dig_edge_src

Specifies the name of a terminal where there is a digital signal to use as the source of the Start Trigger.

Type:

str

property dig_pattern_pattern

Specifies the digital pattern that must be met for the Start 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 order of the physical channels within the port is in ascending order.

property dig_pattern_trig_when

Specifies whether the Start Trigger occurs when the physical channels specified with dig_pattern_src match or differ from the digital pattern specified with dig_pattern_pattern.

Type:

nidaqmx.constants.DigitalPatternCondition

property max_num_trigs_to_detect

Specifies the maximum number of times the task will detect a start trigger during the task. The number of times a trigger is detected and acted upon by the module may be less than the specified amount if the task stops early because of trigger/retrigger window expiration. Specifying the Maximum Number of Triggers to Detect to be 0 causes the driver to automatically set this value to the maximum possible number of triggers detectable by the device and configuration combination. Note: The number of detected triggers may be less than number of trigger events occurring, because the devices were unable to respond to the trigger.

Type:

int

property retrigger_win

Specifies the period of time in seconds after each trigger during which the device may trigger. Once the window has expired, the device stops detecting triggers, and the task will finish after the device finishes acquiring post- trigger samples that it already started. Ensure the period of time specified covers the entire time span desired for retrigger detection to avoid missed triggers. Specifying a Retrigger Window of -1 causes the window to be infinite.

Type:

float

property retriggerable

Specifies whether a finite task resets and waits for another Start Trigger after the task completes. When you set this property to True, the device performs a finite acquisition or generation each time the Start Trigger occurs until the task stops. The device ignores a trigger if it is in the process of acquiring or generating signals.

Type:

bool

property term

Indicates the name of the internal Start Trigger terminal for the task. This property does not return the name of the trigger source terminal.

Type:

str

property time_timescale

Specifies the timescale to be used for timestamps used in a time trigger.

Type:

nidaqmx.constants.Timescale

property time_when

Specifies when to trigger the start trigger.

Type:

datetime

property timestamp_enable

Specifies whether the start trigger timestamp is enabled. If the timestamp is enabled but no resources are available, an error will be returned at run time.

Type:

bool

property timestamp_timescale

Specifies the start trigger timestamp timescale.

Type:

nidaqmx.constants.Timescale

property trig_type

Specifies the type of trigger to use to start a task.

Type:

nidaqmx.constants.TriggerType

property trig_win

Specifies the period of time in seconds after the task starts during which the device may trigger. Once the window has expired, the device stops detecting triggers, and the task will finish after the device finishes acquiring post- trigger samples for any triggers detected. If no triggers are detected during the entire period, then no data will be returned. Ensure the period of time specified covers the entire time span desired for trigger detection to avoid missed triggers. Specifying a Trigger Window of -1 causes the window to be infinite.

Type:

float

cfg_anlg_edge_start_trig(trigger_source='', trigger_slope=Slope.RISING, trigger_level=0.0)

Configures the task to start acquiring or generating samples when an analog signal crosses the level you specify.

Parameters:

• trigger_source (Optional[str]) – Is the name of a virtual channel or terminal where there is an analog signal to use as the source of the trigger.

• trigger_slope (Optional[nidaqmx.constants.Slope]) – Specifies on which slope of the signal to start acquiring or generating samples when the signal crosses trigger_level.

• trigger_level (Optional[float]) – Specifies at what threshold to start acquiring or generating samples. Specify this value in the units of the measurement or generation. Use trigger_slope to specify on which slope to trigger at this threshold.

cfg_anlg_multi_edge_start_trig(trigger_sources, trigger_slope_array, trigger_level_array=None)

Configures the task to start acquiring or generating samples when any of the configured analog signals cross the respective levels you specified. Multi-edge triggering treats the configured triggers as if a logical OR is applied.

Parameters:

• trigger_sources (str) – Is the name of a virtual channel or terminal where there is an analog signal to use as the source of the trigger.

• trigger_slope_array (List[nidaqmx.constants.Slope]) – Specifies on which slope of the signal to start acquiring or generating samples when the signal crosses level.

• trigger_level_array (Optional[List[float]]) – Specifies at what threshold to start acquiring or generating samples. Specify this value in the units of the measurement or generation. Use slope to specify on which slope to trigger at this threshold.

cfg_anlg_window_start_trig(window_top, window_bottom, trigger_source='', trigger_when=WindowTriggerCondition1.ENTERING_WINDOW)

Configures the task to start acquiring or generating samples when an analog signal enters or leaves a range you specify.

Parameters:

• window_top (float) – Is the upper limit of the window. Specify this value in the units of the measurement or generation.

• window_bottom (float) – Is the lower limit of the window. Specify this value in the units of the measurement or generation.

• trigger_source (Optional[str]) – Is the name of a virtual channel or terminal where there is an analog signal to use as the source of the trigger.

• trigger_when (Optional[nidaqmx.constants.WindowTriggerCondition1]) – Specifies whether the task starts measuring or generating samples when the signal enters the window or when it leaves the window. Use window_bottom and window_top to specify the limits of the window.

cfg_dig_edge_start_trig(trigger_source, trigger_edge=Edge.RISING)

Configures the task to start acquiring or generating samples on a rising or falling edge of a digital signal.

Parameters:

• trigger_source (str) – Specifies the name of a terminal where there is a digital signal to use as the source of the trigger.

• trigger_edge (Optional[nidaqmx.constants.Edge]) – Specifies on which edge of the digital signal to start acquiring or generating samples.

cfg_dig_pattern_start_trig(trigger_source, trigger_pattern, trigger_when=DigitalPatternCondition.PATTERN_MATCHES)

Configures a task to start acquiring or generating samples when a digital pattern is matched.

Parameters:

• trigger_source (str) – 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 order of the physical channels within the port is in ascending order.

• trigger_pattern (str) – Specifies the digital pattern that must be met for the trigger to occur.

• trigger_when (Optional[nidaqmx.constants.DigitalPatternCondition]) – Specifies the condition under which the trigger occurs.

cfg_time_start_trig(when, timescale=Timescale.USE_HOST)

Configures the task to start acquiring or generating samples at a specified time.

Parameters:

• when (datetime) – Specifies when to trigger.

• timescale (Optional[nidaqmx.constants.Timescale]) – Specifies the start trigger timestamp time scale.

disable_start_trig()

Configures the task to start acquiring or generating samples immediately upon starting the task.