nidaqmx.task.ci_channel

class nidaqmx._task_modules.channels.ci_channel.CIChannel(task_handle, virtual_or_physical_name, interpreter)[source]

Bases: Channel

Represents one or more counter input virtual channels and their properties.

property chan_type

Indicates the type of the virtual channel.

Type:

nidaqmx.constants.ChannelType

property channel_names

Specifies the unflattened list of the virtual channels.

Type:

List[str]

property ci_ang_encoder_initial_angle

Specifies the starting angle of the encoder. This value is in the units you specify with ci_ang_encoder_units.

Type:

float

property ci_ang_encoder_pulses_per_rev

Specifies the number of pulses the encoder generates per revolution. This value is the number of pulses on either signal A or signal B, not the total number of pulses on both signal A and signal B.

Type:

int

property ci_ang_encoder_units

Specifies the units to use to return angular position measurements from the channel.

Type:

nidaqmx.constants.AngleUnits

property ci_count

Indicates the current value of the count register.

Type:

int

property ci_count_edges_active_edge

Specifies on which edges to increment or decrement the counter.

Type:

nidaqmx.constants.Edge

property ci_count_edges_count_dir_dig_fltr_enable

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

Type:

bool

property ci_count_edges_count_dir_dig_fltr_min_pulse_width

Specifies in seconds the minimum pulse width the filter recognizes.

Type:

float

property ci_count_edges_count_dir_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 ci_count_edges_count_dir_dig_fltr_timebase_src

Specifies the input terminal of the signal to use as the timebase of the pulse width filter.

Type:

str

property ci_count_edges_count_dir_dig_sync_enable

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

Type:

bool

property ci_count_edges_count_dir_hyst

Specifies a hysteresis level applied to the ci_count_edges_count_dir_thresh_voltage. The source signal must fall below ci_count_edges_count_dir_thresh_voltage minus the hysteresis before a change in count direction occurs.

Type:

float

property ci_count_edges_count_dir_logic_lvl_behavior

Specifies the logic level behavior on the count reset line.

Type:

nidaqmx.constants.LogicLvlBehavior

property ci_count_edges_count_dir_term_cfg

Specifies the input terminal configuration.

Type:

nidaqmx.constants.TerminalConfiguration

property ci_count_edges_count_dir_thresh_voltage

Specifies the voltage level applied to the Count Direction terminal. When the signal is above this threshold, the counter counts up. When the signal is below this threshold, the counter counts down.

Type:

float

property ci_count_edges_count_reset_active_edge

Specifies on which edge of the signal to reset the count.

Type:

nidaqmx.constants.Edge

property ci_count_edges_count_reset_dig_fltr_enable

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

Type:

bool

property ci_count_edges_count_reset_dig_fltr_min_pulse_width

Specifies the minimum pulse width the filter recognizes.

Type:

float

property ci_count_edges_count_reset_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 ci_count_edges_count_reset_dig_fltr_timebase_src

Specifies the input of the signal to use as the timebase of the pulse width filter.

Type:

str

property ci_count_edges_count_reset_dig_sync_enable

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

Type:

bool

property ci_count_edges_count_reset_enable

Specifies whether to reset the count on the active edge specified with ci_count_edges_count_reset_term.

Type:

bool

property ci_count_edges_count_reset_hyst

Specifies a hysteresis level applied to ci_count_edges_count_reset_thresh_voltage. When ci_count_edges_count_reset_active_edge is rising, the source signal must first fall below ci_count_edges_count_reset_thresh_voltage minus the hysteresis before a rising edge is detected at ci_count_edges_count_reset_thresh_voltage. When ci_count_edges_count_reset_active_edge is falling, the source signal must first rise above ci_count_edges_count_reset_thresh_voltage plus the hysteresis before a falling edge is detected at ci_count_edges_count_reset_thresh_voltage.

Type:

float

property ci_count_edges_count_reset_logic_lvl_behavior

Specifies the logic level behavior on the count reset line.

Type:

nidaqmx.constants.LogicLvlBehavior

property ci_count_edges_count_reset_reset_cnt

Specifies the value to reset the count to.

Type:

int

property ci_count_edges_count_reset_term

Specifies the input terminal of the signal to reset the count.

Type:

str

property ci_count_edges_count_reset_term_cfg

Specifies the input terminal configuration.

Type:

nidaqmx.constants.TerminalConfiguration

property ci_count_edges_count_reset_thresh_voltage

Specifies the voltage level at which to recognize the counter reset event.

Type:

float

property ci_count_edges_dig_fltr_enable

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

Type:

bool

property ci_count_edges_dig_fltr_min_pulse_width

Specifies in seconds the minimum pulse width the filter recognizes.

Type:

float

property ci_count_edges_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 ci_count_edges_dig_fltr_timebase_src

Specifies the input terminal of the signal to use as the timebase of the pulse width filter.

Type:

str

property ci_count_edges_dig_sync_enable

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

Type:

bool

property ci_count_edges_dir

Specifies whether to increment or decrement the counter on each edge.

Type:

nidaqmx.constants.CountDirection

property ci_count_edges_dir_term

Specifies the source terminal of the digital signal that controls the count direction if ci_count_edges_dir is CountDirection1.EXTERNAL_SOURCE.

Type:

str

property ci_count_edges_gate_dig_fltr_enable

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

Type:

bool

property ci_count_edges_gate_dig_fltr_min_pulse_width

Specifies in seconds the minimum pulse width the digital filter recognizes.

Type:

float

property ci_count_edges_gate_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 ci_count_edges_gate_dig_fltr_timebase_src

Specifies the input terminal of the signal to use as the timebase of the pulse width filter.

Type:

str

property ci_count_edges_gate_enable

Specifies whether to enable the functionality to gate the counter input signal for a count edges measurement.

Type:

bool

property ci_count_edges_gate_hyst

Specifies a hysteresis level applied to the ci_count_edges_gate_thresh_voltage. When ci_count_edges_gate_when is High, the source signal must fall below ci_count_edges_gate_thresh_voltage minus the hysteresis before the counter resumes counting. When ci_count_edges_gate_when is Low, the source signal must rise above ci_count_edges_gate_thresh_voltage plus the hysteresis before the counter resumes counting.

Type:

float

property ci_count_edges_gate_logic_lvl_behavior

Specifies the logic level behavior on the gate input line.

Type:

nidaqmx.constants.LogicLvlBehavior

property ci_count_edges_gate_term

Specifies the gate terminal.

Type:

str

property ci_count_edges_gate_term_cfg

Specifies the gate terminal configuration.

Type:

nidaqmx.constants.TerminalConfiguration

property ci_count_edges_gate_thresh_voltage

Specifies the voltage level at which to recognize the counter gate signal.

Type:

float

property ci_count_edges_gate_when

Specifies whether the counter gates input pulses while the signal is high or low.

Type:

nidaqmx.constants.Level

property ci_count_edges_hyst

Specifies a hysteresis level to apply to ci_count_edges_thresh_voltage. When ci_count_edges_active_edge is rising, the source signal must first fall below ci_count_edges_thresh_voltage minus the hysteresis before a rising edge is detected at ci_count_edges_thresh_voltage. When ci_count_edges_active_edge is falling, the source signal must first rise above ci_count_edges_thresh_voltage plus the hysteresis before a falling edge is detected at ci_count_edges_thresh_voltage.

Type:

float

property ci_count_edges_initial_cnt

Specifies the starting value from which to count.

Type:

int

property ci_count_edges_logic_lvl_behavior

Specifies the logic level behavior on the input line.

Type:

nidaqmx.constants.LogicLvlBehavior

property ci_count_edges_term

Specifies the input terminal of the signal to measure.

Type:

str

property ci_count_edges_term_cfg

Specifies the input terminal configuration.

Type:

nidaqmx.constants.TerminalConfiguration

property ci_count_edges_thresh_voltage

Specifies the voltage level at which to recognize waveform repetitions. Select a voltage level that occurs only once within the entire period of a waveform. You also can select a voltage that occurs only once while the voltage rises or falls.

Type:

float

property ci_ctr_timebase_active_edge

Specifies whether a timebase cycle is from rising edge to rising edge or from falling edge to falling edge.

Type:

nidaqmx.constants.Edge

property ci_ctr_timebase_dig_fltr_enable

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

Type:

bool

property ci_ctr_timebase_dig_fltr_min_pulse_width

Specifies in seconds the minimum pulse width the filter recognizes.

Type:

float

property ci_ctr_timebase_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 ci_ctr_timebase_dig_fltr_timebase_src

Specifies the input terminal of the signal to use as the timebase of the pulse width filter.

Type:

str

property ci_ctr_timebase_dig_sync_enable

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

Type:

bool

property ci_ctr_timebase_master_timebase_div

Specifies the divisor for an external counter timebase. You can divide the counter timebase in order to measure slower signals without causing the count register to roll over.

Type:

int

property ci_ctr_timebase_rate

Specifies in Hertz the frequency of the counter timebase. Specifying the rate of a counter timebase allows you to take measurements in terms of time or frequency rather than in ticks of the timebase. If you use an external timebase and do not specify the rate, you can take measurements only in terms of ticks of the timebase.

Type:

float

property ci_ctr_timebase_src

Specifies the terminal of the timebase to use for the counter.

Type:

str

property ci_custom_scale

Specifies the name of a custom scale for the channel.

Type:

nidaqmx.system.scale.Scale

property ci_data_xfer_mech

nidaqmx.constants.DataTransferActiveTransferMode: Specifies the data transfer mode for the channel.

property ci_data_xfer_req_cond

Specifies under what condition to transfer data from the onboard memory of the device to the buffer.

Type:

nidaqmx.constants.InputDataTransferCondition

property ci_dup_count_prevention

Specifies whether to enable duplicate count prevention for the channel. Duplicate count prevention is enabled by default. Setting ci_prescaler disables duplicate count prevention unless you explicitly enable it.

Type:

bool

property ci_duty_cycle_dig_fltr_enable

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

Type:

bool

property ci_duty_cycle_dig_fltr_min_pulse_width

Specifies in seconds the minimum pulse width the digital filter recognizes.

Type:

float

property ci_duty_cycle_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 ci_duty_cycle_dig_fltr_timebase_src

Specifies the input terminal of the signal to use as the timebase of the pulse width filter.

Type:

str

property ci_duty_cycle_logic_lvl_behavior

Specifies the logic level behavior on the input line.

Type:

nidaqmx.constants.LogicLvlBehavior

property ci_duty_cycle_starting_edge

Specifies which edge of the input signal to begin the duty cycle measurement.

Type:

nidaqmx.constants.Edge

property ci_duty_cycle_term

Specifies the input terminal of the signal to measure.

Type:

str

property ci_duty_cycle_term_cfg

Specifies the input terminal configuration.

Type:

nidaqmx.constants.TerminalConfiguration

property ci_encoder_a_input_dig_fltr_enable

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

Type:

bool

property ci_encoder_a_input_dig_fltr_min_pulse_width

Specifies in seconds the minimum pulse width the filter recognizes.

Type:

float

property ci_encoder_a_input_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 ci_encoder_a_input_dig_fltr_timebase_src

Specifies the input terminal of the signal to use as the timebase of the pulse width filter.

Type:

str

property ci_encoder_a_input_dig_sync_enable

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

Type:

bool

property ci_encoder_a_input_logic_lvl_behavior

Specifies the logic level behavior on the input line.

Type:

nidaqmx.constants.LogicLvlBehavior

property ci_encoder_a_input_term

Specifies the terminal to which signal A is connected.

Type:

str

property ci_encoder_a_input_term_cfg

Specifies the input terminal configuration.

Type:

nidaqmx.constants.TerminalConfiguration

property ci_encoder_b_input_dig_fltr_enable

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

Type:

bool

property ci_encoder_b_input_dig_fltr_min_pulse_width

Specifies in seconds the minimum pulse width the filter recognizes.

Type:

float

property ci_encoder_b_input_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 ci_encoder_b_input_dig_fltr_timebase_src

Specifies the input terminal of the signal to use as the timebase of the pulse width filter.

Type:

str

property ci_encoder_b_input_dig_sync_enable

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

Type:

bool

property ci_encoder_b_input_logic_lvl_behavior

Specifies the logic level behavior on the input line.

Type:

nidaqmx.constants.LogicLvlBehavior

property ci_encoder_b_input_term

Specifies the terminal to which signal B is connected.

Type:

str

property ci_encoder_b_input_term_cfg

Specifies the input terminal configuration.

Type:

nidaqmx.constants.TerminalConfiguration

property ci_encoder_decoding_type

Specifies how to count and interpret the pulses the encoder generates on signal A and signal B. EncoderType2.X_1, EncoderType2.X_2, and EncoderType2.X_4 are valid for quadrature encoders only. EncoderType2.TWO_PULSE_COUNTING is valid for two- pulse encoders only.

Type:

nidaqmx.constants.EncoderType

property ci_encoder_z_index_enable

Specifies whether to use Z indexing for the channel.

Type:

bool

property ci_encoder_z_index_phase

Specifies the states at which signal A and signal B must be while signal Z is high for NI-DAQmx to reset the measurement. If signal Z is never high while signal A and signal B are high, for example, you must choose a phase other than EncoderZIndexPhase1.AHIGH_BHIGH.

Type:

nidaqmx.constants.EncoderZIndexPhase

property ci_encoder_z_index_val

Specifies the value to which to reset the measurement when signal Z is high and signal A and signal B are at the states you specify with ci_encoder_z_index_phase. Specify this value in the units of the measurement.

Type:

float

property ci_encoder_z_input_dig_fltr_enable

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

Type:

bool

property ci_encoder_z_input_dig_fltr_min_pulse_width

Specifies in seconds the minimum pulse width the filter recognizes.

Type:

float

property ci_encoder_z_input_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 ci_encoder_z_input_dig_fltr_timebase_src

Specifies the input terminal of the signal to use as the timebase of the pulse width filter.

Type:

str

property ci_encoder_z_input_dig_sync_enable

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

Type:

bool

property ci_encoder_z_input_logic_lvl_behavior

Specifies the logic level behavior on the input line.

Type:

nidaqmx.constants.LogicLvlBehavior

property ci_encoder_z_input_term

Specifies the terminal to which signal Z is connected.

Type:

str

property ci_encoder_z_input_term_cfg

Specifies the input terminal configuration.

Type:

nidaqmx.constants.TerminalConfiguration

property ci_filter_delay

Indicates the amount of time between when the input signal transitions and when the filtered sample is read by the host device. This value is in the units specified with ci_filter_delay_units.

Type:

float

property ci_filter_delay_units

Specifies the units of ci_filter_delay.

Type:

nidaqmx.constants.DigitalWidthUnits

property ci_filter_enable

Specifies the corresponding filter enable/disable state.

Type:

bool

property ci_filter_freq

Specifies the corresponding filter frequency (cutoff or center) of the filter response.

Type:

float

property ci_filter_order

Specifies the corresponding filter order and defines the slope of the filter response.

Type:

int

property ci_filter_response

Specifies the corresponding filter response and defines the shape of the filter response.

Type:

nidaqmx.constants.FilterResponse

property ci_freq_dig_fltr_enable

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

Type:

bool

property ci_freq_dig_fltr_min_pulse_width

Specifies in seconds the minimum pulse width the filter recognizes.

Type:

float

property ci_freq_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 ci_freq_dig_fltr_timebase_src

Specifies the input terminal of the signal to use as the timebase of the pulse width filter.

Type:

str

property ci_freq_dig_sync_enable

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

Type:

bool

property ci_freq_div

Specifies the value by which to divide the input signal if ci_freq_meas_meth is CounterFrequencyMethod.LARGE_RANGE_2_COUNTERS. The larger the divisor, the more accurate the measurement. However, too large a value could cause the count register to roll over, which results in an incorrect measurement.

Type:

int

property ci_freq_enable_averaging

Specifies whether to enable averaging mode for Sample Clock-timed frequency measurements.

Type:

bool

property ci_freq_hyst

Specifies a hysteresis level to apply to ci_freq_thresh_voltage. When ci_freq_starting_edge is rising, the source signal must first fall below ci_freq_thresh_voltage minus the hysteresis before a rising edge is detected at ci_freq_thresh_voltage. When ci_freq_starting_edge is falling, the source signal must first rise above ci_freq_thresh_voltage plus the hysteresis before a falling edge is detected at ci_freq_thresh_voltage.

Type:

float

property ci_freq_logic_lvl_behavior

Specifies the logic level behavior on the input line.

Type:

nidaqmx.constants.LogicLvlBehavior

property ci_freq_meas_meth

Specifies the method to use to measure the frequency of the signal.

Type:

nidaqmx.constants.CounterFrequencyMethod

property ci_freq_meas_time

Specifies in seconds the length of time to measure the frequency of the signal if ci_freq_meas_meth is CounterFrequencyMethod.HIGH_FREQUENCY_2_COUNTERS. Measurement accuracy increases with increased measurement time and with increased signal frequency. If you measure a high-frequency signal for too long, however, the count register could roll over, which results in an incorrect measurement.

Type:

float

property ci_freq_starting_edge

Specifies between which edges to measure the frequency of the signal.

Type:

nidaqmx.constants.Edge

property ci_freq_term

Specifies the input terminal of the signal to measure.

Type:

str

property ci_freq_term_cfg

Specifies the input terminal configuration.

Type:

nidaqmx.constants.TerminalConfiguration

property ci_freq_thresh_voltage

Specifies the voltage level at which to recognize waveform repetitions. Select a voltage level that occurs only once within the entire period of a waveform. You also can select a voltage that occurs only once while the voltage rises or falls.

Type:

float

property ci_freq_units

Specifies the units to use to return frequency measurements.

Type:

nidaqmx.constants.FrequencyUnits

property ci_gps_sync_method

Specifies the method to use to synchronize the counter to a GPS receiver.

Type:

nidaqmx.constants.GpsSignalType

property ci_gps_sync_src

Specifies the terminal to which the GPS synchronization signal is connected.

Type:

str

property ci_lin_encoder_dist_per_pulse

Specifies the distance to measure for each pulse the encoder generates on signal A or signal B. This value is in the units you specify with ci_lin_encoder_units.

Type:

float

property ci_lin_encoder_initial_pos

Specifies the position of the encoder when the measurement begins. This value is in the units you specify with ci_lin_encoder_units.

Type:

float

property ci_lin_encoder_units

Specifies the units to use to return linear encoder measurements from the channel.

Type:

nidaqmx.constants.LengthUnits

property ci_max

Specifies the maximum value you expect to measure. This value is in the units you specify with a units property. When you query this property, it returns the coerced maximum value that the hardware can measure with the current settings.

Type:

float

property ci_max_meas_period

Specifies the maximum period (in seconds) in which the device will recognize signals. For frequency measurements, a signal with a higher period than the one set in this property will return 0 Hz. For duty cycle, the device will return 0 or 1 depending on the state of the line during the max defined period of time. Period measurements will return NaN. Pulse width measurement will return zero.

Type:

float

property ci_meas_type

Indicates the measurement to take with the channel.

Type:

nidaqmx.constants.UsageTypeCI

property ci_mem_map_enable

Specifies for NI-DAQmx to map hardware registers to the memory space of the application, if possible. Normally, NI- DAQmx maps hardware registers to memory accessible only to the kernel. Mapping the registers to the memory space of the application increases performance. However, if the application accesses the memory space mapped to the registers, it can adversely affect the operation of the device and possibly result in a system crash.

Type:

bool

property ci_min

Specifies the minimum value you expect to measure. This value is in the units you specify with a units property. When you query this property, it returns the coerced minimum value that the hardware can measure with the current settings.

Type:

float

property ci_num_possibly_invalid_samps

Indicates the number of samples that the device might have overwritten before it could transfer them to the buffer.

Type:

int

property ci_output_state

Indicates the current state of the out terminal of the counter.

Type:

nidaqmx.constants.Level

property ci_period_dig_fltr_enable

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

Type:

bool

property ci_period_dig_fltr_min_pulse_width

Specifies in seconds the minimum pulse width the filter recognizes.

Type:

float

property ci_period_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 ci_period_dig_fltr_timebase_src

Specifies the input terminal of the signal to use as the timebase of the pulse width filter.

Type:

str

property ci_period_dig_sync_enable

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

Type:

bool

property ci_period_div

Specifies the value by which to divide the input signal if ci_period_meas_meth is CounterFrequencyMethod.LARGE_RANGE_2_COUNTERS. The larger the divisor, the more accurate the measurement. However, too large a value could cause the count register to roll over, which results in an incorrect measurement.

Type:

int

property ci_period_enable_averaging

Specifies whether to enable averaging mode for Sample Clock-timed period measurements.

Type:

bool

property ci_period_hyst

Specifies a hysteresis level to apply to ci_period_thresh_voltage. When ci_period_starting_edge is rising, the source signal must first fall below ci_period_thresh_voltage minus the hysteresis before a rising edge is detected at ci_period_thresh_voltage. When ci_period_starting_edge is falling, the source signal must first rise above ci_period_thresh_voltage plus the hysteresis before a falling edge is detected at ci_period_thresh_voltage.

Type:

float

property ci_period_logic_lvl_behavior

Specifies the logic level behavior on the input line.

Type:

nidaqmx.constants.LogicLvlBehavior

property ci_period_meas_meth

Specifies the method to use to measure the period of the signal.

Type:

nidaqmx.constants.CounterFrequencyMethod

property ci_period_meas_time

Specifies in seconds the length of time to measure the period of the signal if ci_period_meas_meth is CounterFrequencyMethod.HIGH_FREQUENCY_2_COUNTERS. Measurement accuracy increases with increased measurement time and with increased signal frequency. If you measure a high-frequency signal for too long, however, the count register could roll over, which results in an incorrect measurement.

Type:

float

property ci_period_starting_edge

Specifies between which edges to measure the period of the signal.

Type:

nidaqmx.constants.Edge

property ci_period_term

Specifies the input terminal of the signal to measure.

Type:

str

property ci_period_term_cfg

Specifies the input terminal configuration.

Type:

nidaqmx.constants.TerminalConfiguration

property ci_period_thresh_voltage

Specifies the voltage level at which to recognize waveform repetitions. Select a voltage level that occurs only once within the entire period of a waveform. You also can select a voltage that occurs only once while the voltage rises or falls.

Type:

float

property ci_period_units

Specifies the unit to use to return period measurements.

Type:

nidaqmx.constants.TimeUnits

property ci_prescaler

Specifies the divisor to apply to the signal you connect to the counter source terminal. Scaled data that you read takes this setting into account. You should use a prescaler only when you connect an external signal to the counter source terminal and when that signal has a higher frequency than the fastest onboard timebase. Setting this value disables duplicate count prevention unless you explicitly set ci_dup_count_prevention to True.

Type:

int

property ci_pulse_freq_dig_fltr_enable

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

Type:

bool

property ci_pulse_freq_dig_fltr_min_pulse_width

Specifies in seconds the minimum pulse width the filter recognizes.

Type:

float

property ci_pulse_freq_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 ci_pulse_freq_dig_fltr_timebase_src

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

Type:

str

property ci_pulse_freq_dig_sync_enable

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

Type:

bool

property ci_pulse_freq_logic_lvl_behavior

Specifies the logic level behavior on the count reset line.

Type:

nidaqmx.constants.LogicLvlBehavior

property ci_pulse_freq_starting_edge

Specifies on which edge of the input signal to begin pulse measurement.

Type:

nidaqmx.constants.Edge

property ci_pulse_freq_term

Specifies the input terminal of the signal to measure.

Type:

str

property ci_pulse_freq_term_cfg

Specifies the input terminal configuration.

Type:

nidaqmx.constants.TerminalConfiguration

property ci_pulse_freq_units

Specifies the units to use to return pulse specifications in terms of frequency.

Type:

nidaqmx.constants.FrequencyUnits

property ci_pulse_ticks_dig_fltr_enable

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

Type:

bool

property ci_pulse_ticks_dig_fltr_min_pulse_width

Specifies in seconds the minimum pulse width the filter recognizes.

Type:

float

property ci_pulse_ticks_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 ci_pulse_ticks_dig_fltr_timebase_src

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

Type:

str

property ci_pulse_ticks_dig_sync_enable

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

Type:

bool

property ci_pulse_ticks_logic_lvl_behavior

Specifies the logic level behavior on the count reset line.

Type:

nidaqmx.constants.LogicLvlBehavior

property ci_pulse_ticks_starting_edge

Specifies on which edge of the input signal to begin pulse measurement.

Type:

nidaqmx.constants.Edge

property ci_pulse_ticks_term

Specifies the input terminal of the signal to measure.

Type:

str

property ci_pulse_ticks_term_cfg

Specifies the input terminal configuration.

Type:

nidaqmx.constants.TerminalConfiguration

property ci_pulse_time_dig_fltr_enable

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

Type:

bool

property ci_pulse_time_dig_fltr_min_pulse_width

Specifies in seconds the minimum pulse width the filter recognizes.

Type:

float

property ci_pulse_time_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 ci_pulse_time_dig_fltr_timebase_src

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

Type:

str

property ci_pulse_time_dig_sync_enable

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

Type:

bool

property ci_pulse_time_logic_lvl_behavior

Specifies the logic level behavior on the count reset line.

Type:

nidaqmx.constants.LogicLvlBehavior

property ci_pulse_time_starting_edge

Specifies on which edge of the input signal to begin pulse measurement.

Type:

nidaqmx.constants.Edge

property ci_pulse_time_term

Specifies the input terminal of the signal to measure.

Type:

str

property ci_pulse_time_term_cfg

Specifies the input terminal configuration.

Type:

nidaqmx.constants.TerminalConfiguration

property ci_pulse_time_units

Specifies the units to use to return pulse specifications in terms of high time and low time.

Type:

nidaqmx.constants.TimeUnits

property ci_pulse_width_dig_fltr_enable

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

Type:

bool

property ci_pulse_width_dig_fltr_min_pulse_width

Specifies in seconds the minimum pulse width the filter recognizes.

Type:

float

property ci_pulse_width_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 ci_pulse_width_dig_fltr_timebase_src

Specifies the input terminal of the signal to use as the timebase of the pulse width filter.

Type:

str

property ci_pulse_width_dig_sync_enable

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

Type:

bool

property ci_pulse_width_logic_lvl_behavior

Specifies the logic level behavior on the input line.

Type:

nidaqmx.constants.LogicLvlBehavior

property ci_pulse_width_starting_edge

Specifies on which edge of the input signal to begin each pulse width measurement.

Type:

nidaqmx.constants.Edge

property ci_pulse_width_term

Specifies the input terminal of the signal to measure.

Type:

str

property ci_pulse_width_term_cfg

Specifies the input terminal configuration.

Type:

nidaqmx.constants.TerminalConfiguration

property ci_pulse_width_units

Specifies the units to use to return pulse width measurements.

Type:

nidaqmx.constants.TimeUnits

property ci_samp_clk_overrun_behavior

Specifies the counter behavior when data is read but a new value was not detected during a sample clock.

Type:

nidaqmx.constants.SampClkOverrunBehavior

property ci_samp_clk_overrun_sentinel_val

Specifies the sentinel value returned when the No New Sample Behavior is set to Sentinel Value.

Type:

int

property ci_semi_period_dig_fltr_enable

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

Type:

bool

property ci_semi_period_dig_fltr_min_pulse_width

Specifies in seconds the minimum pulse width the filter recognizes.

Type:

float

property ci_semi_period_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 ci_semi_period_dig_fltr_timebase_src

Specifies the input terminal of the signal to use as the timebase of the pulse width filter.

Type:

str

property ci_semi_period_dig_sync_enable

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

Type:

bool

property ci_semi_period_logic_lvl_behavior

Specifies the logic level behavior on the count reset line.

Type:

nidaqmx.constants.LogicLvlBehavior

property ci_semi_period_starting_edge

Specifies on which edge of the input signal to begin semi-period measurement. Semi-period measurements alternate between high time and low time, starting on this edge.

Type:

nidaqmx.constants.Edge

property ci_semi_period_term

Specifies the input terminal of the signal to measure.

Type:

str

property ci_semi_period_term_cfg

Specifies the input terminal configuration.

Type:

nidaqmx.constants.TerminalConfiguration

property ci_semi_period_units

Specifies the units to use to return semi-period measurements.

Type:

nidaqmx.constants.TimeUnits

property ci_tc_reached

Indicates whether the counter rolled over. When you query this property, NI-DAQmx resets it to False.

Type:

bool

property ci_thresh_voltage

Specifies the digital threshold value in Volts for high and low input transitions. Some devices do not support this for differential channels.

Type:

float

property ci_timestamp_initial_seconds

Specifies the number of seconds that elapsed since the beginning of the current year. This value is ignored if ci_gps_sync_method is GpsSignalType1.IRIGB.

Type:

int

property ci_timestamp_units

Specifies the units to use to return timestamp measurements.

Type:

nidaqmx.constants.TimeUnits

property ci_two_edge_sep_first_dig_fltr_enable

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

Type:

bool

property ci_two_edge_sep_first_dig_fltr_min_pulse_width

Specifies in seconds the minimum pulse width the filter recognizes.

Type:

float

property ci_two_edge_sep_first_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 ci_two_edge_sep_first_dig_fltr_timebase_src

Specifies the input terminal of the signal to use as the timebase of the pulse width filter.

Type:

str

property ci_two_edge_sep_first_dig_sync_enable

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

Type:

bool

property ci_two_edge_sep_first_edge

Specifies on which edge of the first signal to start each measurement.

Type:

nidaqmx.constants.Edge

property ci_two_edge_sep_first_logic_lvl_behavior

Specifies the logic level behavior on the input line.

Type:

nidaqmx.constants.LogicLvlBehavior

property ci_two_edge_sep_first_term

Specifies the source terminal of the digital signal that starts each measurement.

Type:

str

property ci_two_edge_sep_first_term_cfg

Specifies the input terminal configuration.

Type:

nidaqmx.constants.TerminalConfiguration

property ci_two_edge_sep_second_dig_fltr_enable

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

Type:

bool

property ci_two_edge_sep_second_dig_fltr_min_pulse_width

Specifies in seconds the minimum pulse width the filter recognizes.

Type:

float

property ci_two_edge_sep_second_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 ci_two_edge_sep_second_dig_fltr_timebase_src

Specifies the input terminal of the signal to use as the timebase of the pulse width filter.

Type:

str

property ci_two_edge_sep_second_dig_sync_enable

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

Type:

bool

property ci_two_edge_sep_second_edge

Specifies on which edge of the second signal to stop each measurement.

Type:

nidaqmx.constants.Edge

property ci_two_edge_sep_second_logic_lvl_behavior

Specifies the logic level behavior on the count reset line.

Type:

nidaqmx.constants.LogicLvlBehavior

property ci_two_edge_sep_second_term

Specifies the source terminal of the digital signal that stops each measurement.

Type:

str

property ci_two_edge_sep_second_term_cfg

Specifies the input terminal configuration.

Type:

nidaqmx.constants.TerminalConfiguration

property ci_two_edge_sep_units

Specifies the units to use to return two-edge separation measurements from the channel.

Type:

nidaqmx.constants.TimeUnits

property ci_usb_xfer_req_count

Specifies the maximum number of simultaneous USB transfers used to stream data. Modify this value to affect performance under different combinations of operating system and device.

Type:

int

property ci_usb_xfer_req_size

Specifies the maximum size of a USB transfer request in bytes. Modify this value to affect performance under different combinations of operating system and device.

Type:

int

property ci_velocity_a_input_dig_fltr_enable

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

Type:

bool

property ci_velocity_a_input_dig_fltr_min_pulse_width

Specifies in seconds the minimum pulse width the digital filter recognizes.

Type:

float

property ci_velocity_a_input_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 ci_velocity_a_input_dig_fltr_timebase_src

Specifies the input terminal of the signal to use as the timebase of the pulse width filter.

Type:

str

property ci_velocity_a_input_logic_lvl_behavior

Specifies the logic level behavior of the input terminal.

Type:

nidaqmx.constants.LogicLvlBehavior

property ci_velocity_a_input_term

Specifies the terminal to which signal A is connected.

Type:

str

property ci_velocity_a_input_term_cfg

Specifies the input terminal configuration.

Type:

nidaqmx.constants.TerminalConfiguration

property ci_velocity_ang_encoder_pulses_per_rev

Specifies the number of pulses the encoder generates per revolution. This value is the number of pulses on either signal A or signal B, not the total number of pulses on both signal A and signal B.

Type:

int

property ci_velocity_ang_encoder_units

Specifies the units to use to return angular velocity counter measurements.

Type:

nidaqmx.constants.AngularVelocityUnits

property ci_velocity_b_input_dig_fltr_enable

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

Type:

bool

property ci_velocity_b_input_dig_fltr_min_pulse_width

Specifies in seconds the minimum pulse width the digital filter recognizes.

Type:

float

property ci_velocity_b_input_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 ci_velocity_b_input_dig_fltr_timebase_src

Specifies the input terminal of the signal to use as the timebase of the pulse width filter.

Type:

str

property ci_velocity_b_input_logic_lvl_behavior

Specifies the logic level behavior of the input terminal.

Type:

nidaqmx.constants.LogicLvlBehavior

property ci_velocity_b_input_term

Specifies the terminal to which signal B is connected.

Type:

str

property ci_velocity_b_input_term_cfg

Specifies the input terminal configuration.

Type:

nidaqmx.constants.TerminalConfiguration

property ci_velocity_div

Specifies the value by which to divide the input signal.

Type:

int

property ci_velocity_encoder_decoding_type

Specifies how to count and interpret the pulses the encoder generates on signal A and signal B. X1, X2, and X4 are valid for quadrature encoders only. Two Pulse Counting is valid for two-pulse encoders only.

Type:

nidaqmx.constants.EncoderType

property ci_velocity_lin_encoder_dist_per_pulse

Specifies the distance to measure for each pulse the encoder generates on signal A or signal B. This value is in the units you specify in CI.Velocity.LinEncoder.DistUnits.

Type:

float

property ci_velocity_lin_encoder_units

Specifies the units to use to return linear encoder velocity measurements from the channel.

Type:

nidaqmx.constants.VelocityUnits

property ci_velocity_meas_time

Specifies in seconds the length of time to measure the velocity of the signal.

Type:

float

property description

Specifies a user-defined description for the channel.

Type:

str

property is_global

Indicates whether the channel is a global channel.

Type:

bool

property name

Specifies the name of the virtual channel this object represents.

Type:

str

property physical_channel

nidaqmx.system.physical_channel.PhysicalChannel: Specifies the name of the physical channel upon which this virtual channel is based.

save(save_as='', author='', overwrite_existing_channel=False, allow_interactive_editing=True, allow_interactive_deletion=True)

Saves this local or global channel to MAX as a global channel.

Parameters:
  • save_as (Optional[str]) – Is the name to save the task, global channel, or custom scale as. If you do not specify a value for this input, NI-DAQmx uses the name currently assigned to the task, global channel, or custom scale.

  • author (Optional[str]) – Is a name to store with the task, global channel, or custom scale.

  • overwrite_existing_channel (Optional[bool]) – Specifies whether to overwrite a global channel of the same name if one is already saved in MAX. If this input is False and a global channel of the same name is already saved in MAX, this function returns an error.

  • allow_interactive_editing (Optional[bool]) – Specifies whether to allow the task, global channel, or custom scale to be edited in the DAQ Assistant. If allow_interactive_editing is True, the DAQ Assistant must support all task or global channel settings.

  • allow_interactive_deletion (Optional[bool]) – Specifies whether to allow the task, global channel, or custom scale to be deleted through MAX.

property sync_unlock_behavior

Specifies the action to take if the target loses its synchronization to the grand master.

Type:

nidaqmx.constants.SyncUnlockBehavior