Session¶
-
class
nidigital.
Session
(self, resource_name, id_query=False, reset_device=False, options={})¶ TBD
Parameters: - resource_name (str) –
- id_query (bool) –
- reset_device (bool) –
- options (dict) –
Specifies the initial value of certain properties for the session. The syntax for options is a dictionary of properties with an assigned value. For example:
{ ‘simulate’: False }
You do not have to specify a value for all the properties. If you do not specify a value for a property, the default value is used.
Advanced Example: { ‘simulate’: True, ‘driver_setup’: { ‘Model’: ‘<model number>’, ‘BoardType’: ‘<type>’ } }
Property Default range_check True query_instrument_status False cache True simulate False record_value_coersions False driver_setup {}
Methods¶
abort_keep_alive¶
nidigital.Session.
abort_keep_alive
()¶TBD
apply_levels_and_timing¶
nidigital.Session.
apply_levels_and_timing
(levels_sheet, timing_sheet, initial_state_high_pins="", initial_state_low_pins="", initial_state_tristate_pins="")¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Parameters:
apply_tdr_offsets¶
nidigital.Session.
apply_tdr_offsets
(offsets)¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Parameters: offsets (list of float in seconds or datetime.timedelta) –
burst_pattern¶
nidigital.Session.
burst_pattern
(start_label, select_digital_function=True, wait_until_done=True, timeout=datetime.timedelta(seconds=10.0))¶Uses the start_label you specify to burst the pattern on the sites you specify. If you specify wait_until_done as True, waits for the burst to complete, and returns comparison results for each site.
Digital pins retain their state at the end of a pattern burst until the first vector of the pattern burst, a call to
nidigital.Session.write_static()
, or a call tonidigital.Session.apply_levels_and_timing()
.Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Parameters:
- start_label (str) –
- select_digital_function (bool) –
- wait_until_done (bool) –
- timeout (float in seconds or datetime.timedelta) –
Return type: { int: bool, int: bool, .. }
Returns: Dictionary where each key is a site number and value is pass/fail, if wait_until_done is specified as True. Else, None.
clock_generator_abort¶
nidigital.Session.
clock_generator_abort
()¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
clock_generator_generate_clock¶
nidigital.Session.
clock_generator_generate_clock
(frequency, select_digital_function=True)¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Parameters:
close¶
nidigital.Session.
close
()¶TBD
Note
This method is not needed when using the session context manager
configure_active_load_levels¶
nidigital.Session.
configure_active_load_levels
(iol, ioh, vcom)¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Parameters:
configure_pattern_burst_sites¶
nidigital.Session.
configure_pattern_burst_sites
()¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
configure_time_set_compare_edges_strobe¶
nidigital.Session.
configure_time_set_compare_edges_strobe
(time_set_name, strobe_edge)¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Parameters:
- time_set_name (str) –
- strobe_edge (float in seconds or datetime.timedelta) –
configure_time_set_compare_edges_strobe2x¶
nidigital.Session.
configure_time_set_compare_edges_strobe2x
(time_set_name, strobe_edge, strobe2_edge)¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Parameters:
- time_set_name (str) –
- strobe_edge (float in seconds or datetime.timedelta) –
- strobe2_edge (float in seconds or datetime.timedelta) –
configure_time_set_drive_edges¶
nidigital.Session.
configure_time_set_drive_edges
(time_set_name, format, drive_on_edge, drive_data_edge, drive_return_edge, drive_off_edge)¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Parameters:
- time_set_name (str) –
- format (
nidigital.DriveFormat
) –- drive_on_edge (float in seconds or datetime.timedelta) –
- drive_data_edge (float in seconds or datetime.timedelta) –
- drive_return_edge (float in seconds or datetime.timedelta) –
- drive_off_edge (float in seconds or datetime.timedelta) –
configure_time_set_drive_edges2x¶
nidigital.Session.
configure_time_set_drive_edges2x
(time_set_name, format, drive_on_edge, drive_data_edge, drive_return_edge, drive_off_edge, drive_data2_edge, drive_return2_edge)¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Parameters:
- time_set_name (str) –
- format (
nidigital.DriveFormat
) –- drive_on_edge (float in seconds or datetime.timedelta) –
- drive_data_edge (float in seconds or datetime.timedelta) –
- drive_return_edge (float in seconds or datetime.timedelta) –
- drive_off_edge (float in seconds or datetime.timedelta) –
- drive_data2_edge (float in seconds or datetime.timedelta) –
- drive_return2_edge (float in seconds or datetime.timedelta) –
configure_time_set_drive_format¶
nidigital.Session.
configure_time_set_drive_format
(time_set_name, drive_format)¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Parameters:
- time_set_name (str) –
- drive_format (
nidigital.DriveFormat
) –
configure_time_set_edge¶
nidigital.Session.
configure_time_set_edge
(time_set_name, edge, time)¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Parameters:
- time_set_name (str) –
- edge (
nidigital.TimeSetEdgeType
) –- time (float in seconds or datetime.timedelta) –
configure_time_set_edge_multiplier¶
nidigital.Session.
configure_time_set_edge_multiplier
(time_set_name, edge_multiplier)¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Parameters:
configure_time_set_period¶
nidigital.Session.
configure_time_set_period
(time_set_name, period)¶TBD
Parameters:
- time_set_name (str) –
- period (float in seconds or datetime.timedelta) –
configure_voltage_levels¶
nidigital.Session.
configure_voltage_levels
(vil, vih, vol, voh, vterm)¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Parameters:
create_capture_waveform_parallel¶
nidigital.Session.
create_capture_waveform_parallel
(waveform_name)¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Parameters: waveform_name (str) –
create_capture_waveform_serial¶
nidigital.Session.
create_capture_waveform_serial
(waveform_name, sample_width, bit_order)¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Parameters:
- waveform_name (str) –
- sample_width (int) –
- bit_order (
nidigital.BitOrder
) –
create_source_waveform_parallel¶
nidigital.Session.
create_source_waveform_parallel
(waveform_name, data_mapping)¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Parameters:
- waveform_name (str) –
- data_mapping (
nidigital.SourceDataMapping
) –
create_source_waveform_serial¶
nidigital.Session.
create_source_waveform_serial
(waveform_name, data_mapping, sample_width, bit_order)¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Parameters:
- waveform_name (str) –
- data_mapping (
nidigital.SourceDataMapping
) –- sample_width (int) –
- bit_order (
nidigital.BitOrder
) –
delete_all_time_sets¶
nidigital.Session.
delete_all_time_sets
()¶TBD
disable_sites¶
nidigital.Session.
disable_sites
()¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
enable_sites¶
nidigital.Session.
enable_sites
()¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
fetch_capture_waveform¶
nidigital.Session.
fetch_capture_waveform
(waveform_name, samples_to_read, timeout=datetime.timedelta(seconds=10.0))¶Returns dictionary where each key is the site number and the value is array.array of unsigned int
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Parameters:
- waveform_name (str) –
- samples_to_read (int) –
- timeout (float or datetime.timedelta) –
Return type: { site: data, site: data, .. }
Returns: Dictionary where each key is the site number and the value is array.array of unsigned int
fetch_history_ram_cycle_information¶
nidigital.Session.
fetch_history_ram_cycle_information
(position, samples_to_read)¶Returns the pattern information acquired for the specified cycles.
If the pattern is using the edge multiplier feature, cycle numbers represent tester cycles, each of which may consist of multiple DUT cycles. When using pins with mixed edge multipliers, pins may return
PIN_STATE_NOT_ACQUIRED
for DUT cycles where those pins do not have edges defined.Site number on which to retrieve pattern information must be specified via sites repeated capability. The method returns an error if more than one site is specified.
Pins for which to retrieve pattern information must be specified via pins repeated capability. If pins are not specified, pin list from the pattern containing the start label is used. Call
nidigital.Session.get_pattern_pin_names()
with the start label to retrieve the pins associated with the pattern burst:session.sites[0].pins['PinA', 'PinB'].fetch_history_ram_cycle_information(0, -1)Note
Before bursting a pattern, you must configure the History RAM trigger and specify which cycles to acquire.
nidigital.Session.history_ram_trigger_type
should be used to specify the trigger condition on which History RAM starts acquiring pattern information.If History RAM trigger is configured as
CYCLE_NUMBER
,nidigital.Session.cycle_number_history_ram_trigger_cycle_number
should be used to specify the cycle number on which History RAM starts acquiring pattern information.If History RAM trigger is configured as
PATTERN_LABEL
,nidigital.Session.pattern_label_history_ram_trigger_label
should be used to specify the pattern label from which to start acquiring pattern information.nidigital.Session.pattern_label_history_ram_trigger_vector_offset
should be used to specify the number of vectors following the specified pattern label from which to start acquiring pattern information.nidigital.Session.pattern_label_history_ram_trigger_cycle_offset
should be used to specify the number of cycles following the specified pattern label and vector offset from which to start acquiring pattern information.For all History RAM trigger conditions,
nidigital.Session.history_ram_pretrigger_samples
should be used to specify the number of samples to acquire before the trigger conditions are met. If you configure History RAM to only acquire failed cycles, you must setnidigital.Session.history_ram_pretrigger_samples
to 0.
nidigital.Session.history_ram_cycles_to_acquire
should be used to specify which cycles History RAM acquires after the trigger conditions are met.Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Parameters: Return type: list of HistoryRAMCycleInformation
Returns: Returns a list of class instances with the following information about each pattern cycle:
- pattern_name (str) Name of the pattern for the acquired cycle.
- time_set_name (str) Time set for the acquired cycle.
- vector_number (int) Vector number within the pattern for the acquired cycle. Vector numbers start at 0 from the beginning of the pattern.
- cycle_number (int) Cycle number acquired by this History RAM sample. Cycle numbers start at 0 from the beginning of the pattern burst.
- scan_cycle_number (int) Scan cycle number acquired by this History RAM sample. Scan cycle numbers start at 0 from the first cycle of the scan vector. Scan cycle numbers are -1 for cycles that do not have a scan opcode.
- expected_pin_states (list of list of enums.PinState) Pin states as expected by the loaded pattern in the order specified in the pin list. Pins without defined edges in the specified DUT cycle will have a value of
PIN_STATE_NOT_ACQUIRED
. Length of the outer list will be equal to the value of edge multiplier for the given vector. Length of the inner list will be equal to the number of pins requested.- actual_pin_states (list of list of enums.PinState) Pin states acquired by History RAM in the order specified in the pin list. Pins without defined edges in the specified DUT cycle will have a value of
PIN_STATE_NOT_ACQUIRED
. Length of the outer list will be equal to the value of edge multiplier for the given vector. Length of the inner list will be equal to the number of pins requested.- per_pin_pass_fail (list of list of bool) Pass fail information for pins in the order specified in the pin list. Pins without defined edges in the specified DUT cycle will have a value of pass (True). Length of the outer list will be equal to the value of edge multiplier for the given vector. Length of the inner list will be equal to the number of pins requested.
frequency_counter_measure_frequency¶
nidigital.Session.
frequency_counter_measure_frequency
()¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Return type: list of float Returns:
get_channel_names¶
nidigital.Session.
get_channel_names
(indices)¶Returns a list of channel names for given channel indices.
This is useful in multi-instrument sessions, where channels are expected to be referenced by their fully-qualified names, for example, PXI1Slot3/0.
Parameters: indices (basic sequence types or str or int) – Specifies indices for the channels in the session. Valid values are from zero to the total number of channels in the session minus one. The following types and formats are supported:
- int - example: 0
- Basic sequence - example: [0, range(2, 4)]
- str - example: “0, 2, 3, 1”, “0-3”, “0:3”
The input can contain any combination of above types. Both out-of-order and repeated indices are supported ([2,3,0], [1,2,2,3]). White space characters, including spaces, tabs, feeds, and carriage returns, are allowed within strings. Ranges can be incrementing or decrementing.
Return type: list of str Returns: Channel names
get_fail_count¶
nidigital.Session.
get_fail_count
()¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Return type: list of int Returns:
get_history_ram_sample_count¶
nidigital.Session.
get_history_ram_sample_count
()¶Returns the number of samples History RAM acquired on the last pattern burst.
Note
Before bursting a pattern, you must configure the History RAM trigger and specify which cycles to acquire.
nidigital.Session.history_ram_trigger_type
should be used to specify the trigger condition on which History RAM starts acquiring pattern information.If History RAM trigger is configured as
CYCLE_NUMBER
,nidigital.Session.cycle_number_history_ram_trigger_cycle_number
should be used to specify the cycle number on which History RAM starts acquiring pattern information.If History RAM trigger is configured as
PATTERN_LABEL
,nidigital.Session.pattern_label_history_ram_trigger_label
should be used to specify the pattern label from which to start acquiring pattern information.nidigital.Session.pattern_label_history_ram_trigger_vector_offset
should be used to specify the number of vectors following the specified pattern label from which to start acquiring pattern information.nidigital.Session.pattern_label_history_ram_trigger_cycle_offset
should be used to specify the number of cycles following the specified pattern label and vector offset from which to start acquiring pattern information.For all History RAM trigger conditions,
nidigital.Session.history_ram_pretrigger_samples
should be used to specify the number of samples to acquire before the trigger conditions are met. If you configure History RAM to only acquire failed cycles, you must setnidigital.Session.history_ram_pretrigger_samples
to 0.
nidigital.Session.history_ram_cycles_to_acquire
should be used to specify which cycles History RAM acquires after the trigger conditions are met.Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Return type: int Returns:
get_pin_results_pin_information¶
nidigital.Session.
get_pin_results_pin_information
()¶Returns a list of named tuples (PinInfo) that <FILL IN THE BLANK HERE>
Fields in PinInfo:
- pin_name (str)
- site_number (int)
- channel_name (str)
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Return type: list of PinInfo Returns: List of named tuples with fields:
- pin_name (str)
- site_number (int)
- channel_name (str)
get_site_pass_fail¶
nidigital.Session.
get_site_pass_fail
()¶Returns dictionary where each key is a site number and value is pass/fail
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Return type: { int: bool, int: bool, .. } Returns: Dictionary where each key is a site number and value is pass/fail
get_time_set_drive_format¶
nidigital.Session.
get_time_set_drive_format
(time_set_name)¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Parameters: time_set_name (str) – Return type: nidigital.DriveFormat
Returns:
get_time_set_edge¶
nidigital.Session.
get_time_set_edge
(time_set_name, edge)¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Parameters:
- time_set_name (str) –
- edge (
nidigital.TimeSetEdgeType
) –Return type: Returns:
get_time_set_edge_multiplier¶
nidigital.Session.
get_time_set_edge_multiplier
(time_set_name)¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Parameters: time_set_name (str) – Return type: int Returns:
initiate¶
nidigital.Session.
initiate
()¶TBD
Note
This method will return a Python context manager that will initiate on entering and abort on exit.
is_site_enabled¶
nidigital.Session.
is_site_enabled
()¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Return type: bool Returns:
load_specifications_levels_and_timing¶
nidigital.Session.
load_specifications_levels_and_timing
(specifications_file_paths=None, levels_file_paths=None, timing_file_paths=None)¶Loads settings in specifications, levels, and timing sheets. These settings are not applied to the digital pattern instrument until
nidigital.Session.apply_levels_and_timing()
is called.If the levels and timing sheets contains formulas, they are evaluated at load time. If the formulas refer to variables, the specifications sheets that define those variables must be loaded either first, or at the same time as the levels and timing sheets.
Parameters:
- specifications_file_paths (str or iterable of str) – Absolute file path of one or more specifications files.
- levels_file_paths (str or iterable of str) – Absolute file path of one or more levels sheet files.
- timing_file_paths (str or iterable of str) – Absolute file path of one or more timing sheet files.
lock¶
-
nidigital.Session.
lock
()¶ Obtains a multithread lock on the device session. Before doing so, the software waits until all other execution threads release their locks on the device session.
Other threads may have obtained a lock on this session for the following reasons:
- The application called the
nidigital.Session.lock()
method. - A call to NI-Digital Pattern Driver locked the session.
- After a call to the
nidigital.Session.lock()
method returns successfully, no other threads can access the device session until you call thenidigital.Session.unlock()
method or exit out of the with block when using lock context manager. - Use the
nidigital.Session.lock()
method and thenidigital.Session.unlock()
method around a sequence of calls to instrument driver methods if you require that the device retain its settings through the end of the sequence.
You can safely make nested calls to the
nidigital.Session.lock()
method within the same thread. To completely unlock the session, you must balance each call to thenidigital.Session.lock()
method with a call to thenidigital.Session.unlock()
method.One method for ensuring there are the same number of unlock method calls as there is lock calls is to use lock as a context manager
with nidigital.Session('dev1') as session: with session.lock(): # Calls to session within a single lock context
The first with block ensures the session is closed regardless of any exceptions raised
The second with block ensures that unlock is called regardless of any exceptions raised
Return type: context manager Returns: When used in a with statement, nidigital.Session.lock()
acts as a context manager and unlock will be called when the with block is exited- The application called the
ppmu_measure¶
nidigital.Session.
ppmu_measure
(measurement_type)¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Parameters: measurement_type ( nidigital.PPMUMeasurementType
) –Return type: list of float Returns:
ppmu_source¶
nidigital.Session.
ppmu_source
()¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
read_sequencer_flag¶
nidigital.Session.
read_sequencer_flag
(flag)¶TBD
Parameters: flag ( nidigital.SequencerFlag
) –Return type: bool Returns:
read_sequencer_register¶
nidigital.Session.
read_sequencer_register
(reg)¶TBD
Parameters: reg ( nidigital.SequencerRegister
) –Return type: int Returns:
read_static¶
nidigital.Session.
read_static
()¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Return type: list of nidigital.PinState
Returns:
reset_device¶
nidigital.Session.
reset_device
()¶TBD
self_calibrate¶
nidigital.Session.
self_calibrate
()¶TBD
send_software_edge_trigger¶
nidigital.Session.
send_software_edge_trigger
(trigger, trigger_identifier)¶Forces a particular edge-based trigger to occur regardless of how the specified trigger is configured. You can use this method as a software override.
Parameters:
- trigger (
nidigital.SoftwareTrigger
) –Trigger specifies the trigger you want to override.
Defined Values START
Overrides the Start trigger. You must specify an empty string in the trigger_identifier parameter. CONDITIONAL_JUMP
Specifies to route a conditional jump trigger. You must specify a conditional jump trigger in the trigger_identifier parameter. Note
One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.
- trigger_identifier (str) –
Trigger Identifier specifies the instance of the trigger you want to override. If trigger is specified as
NIDIGITAL_VAL_START_TRIGGER
, this parameter must be an empty string. If trigger is specified asNIDIGITAL_VAL_CONDITIONAL_JUMP_TRIGGER
, allowed values are conditionalJumpTrigger0, conditionalJumpTrigger1, conditionalJumpTrigger2, and conditionalJumpTrigger3.Note
One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.
tdr¶
nidigital.Session.
tdr
(apply_offsets=True)¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Parameters: apply_offsets (bool) – Return type: list of datetime.timedelta Returns:
unload_specifications¶
nidigital.Session.
unload_specifications
(file_paths)¶Unloads the given specifications sheets present in the previously loaded specifications files that you select.
You must call
nidigital.Session.load_specifications_levels_and_timing()
to reload the files with updated specifications values. You must then callnidigital.Session.apply_levels_and_timing()
in order to apply the levels and timing values that reference the updated specifications values.
Parameters: file_paths (str or iterable of str) – Absolute file path of one or more loaded specifications files.
unlock¶
-
nidigital.Session.
unlock
()¶ Releases a lock that you acquired on an device session using
nidigital.Session.lock()
. Refer tonidigital.Session.unlock()
for additional information on session locks.
wait_until_done¶
nidigital.Session.
wait_until_done
(timeout=datetime.timedelta(seconds=10.0))¶TBD
Parameters: timeout (float in seconds or datetime.timedelta) –
write_sequencer_flag¶
nidigital.Session.
write_sequencer_flag
(flag, value)¶TBD
Parameters:
- flag (
nidigital.SequencerFlag
) –- value (bool) –
write_sequencer_register¶
nidigital.Session.
write_sequencer_register
(reg, value)¶TBD
Parameters:
- reg (
nidigital.SequencerRegister
) –- value (int) –
write_static¶
nidigital.Session.
write_static
(state)¶TBD
Tip
This method requires repeated capabilities. If called directly on the nidigital.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling this method on the result.
Parameters: state ( nidigital.WriteStaticPinState
) –
Properties¶
active_load_ioh¶
nidigital.Session.
active_load_ioh
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_ACTIVE_LOAD_IOH
active_load_iol¶
nidigital.Session.
active_load_iol
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_ACTIVE_LOAD_IOL
active_load_vcom¶
nidigital.Session.
active_load_vcom
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_ACTIVE_LOAD_VCOM
cache¶
nidigital.Session.
cache
¶The following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based No Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_CACHE
channel_count¶
nidigital.Session.
channel_count
¶The following table lists the characteristics of this property.
Characteristic Value Datatype int Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_CHANNEL_COUNT
clock_generator_frequency¶
nidigital.Session.
clock_generator_frequency
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_CLOCK_GENERATOR_FREQUENCY
clock_generator_is_running¶
nidigital.Session.
clock_generator_is_running
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read only Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_CLOCK_GENERATOR_IS_RUNNING
conditional_jump_trigger_terminal_name¶
nidigital.Session.
conditional_jump_trigger_terminal_name
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_CONDITIONAL_JUMP_TRIGGER_TERMINAL_NAME
conditional_jump_trigger_type¶
nidigital.Session.
conditional_jump_trigger_type
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype enums.TriggerType Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_CONDITIONAL_JUMP_TRIGGER_TYPE
cycle_number_history_ram_trigger_cycle_number¶
nidigital.Session.
cycle_number_history_ram_trigger_cycle_number
¶The following table lists the characteristics of this property.
Characteristic Value Datatype int Permissions read-write Channel Based No Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_CYCLE_NUMBER_HISTORY_RAM_TRIGGER_CYCLE_NUMBER
digital_edge_conditional_jump_trigger_edge¶
nidigital.Session.
digital_edge_conditional_jump_trigger_edge
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype enums.DigitalEdge Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_DIGITAL_EDGE_CONDITIONAL_JUMP_TRIGGER_EDGE
digital_edge_conditional_jump_trigger_source¶
nidigital.Session.
digital_edge_conditional_jump_trigger_source
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_DIGITAL_EDGE_CONDITIONAL_JUMP_TRIGGER_SOURCE
digital_edge_start_trigger_edge¶
nidigital.Session.
digital_edge_start_trigger_edge
¶The following table lists the characteristics of this property.
Characteristic Value Datatype enums.DigitalEdge Permissions read-write Channel Based No Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_DIGITAL_EDGE_START_TRIGGER_EDGE
digital_edge_start_trigger_source¶
nidigital.Session.
digital_edge_start_trigger_source
¶The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based No Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_DIGITAL_EDGE_START_TRIGGER_SOURCE
driver_setup¶
nidigital.Session.
driver_setup
¶The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_DRIVER_SETUP
exported_conditional_jump_trigger_output_terminal¶
nidigital.Session.
exported_conditional_jump_trigger_output_terminal
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_EXPORTED_CONDITIONAL_JUMP_TRIGGER_OUTPUT_TERMINAL
exported_pattern_opcode_event_output_terminal¶
nidigital.Session.
exported_pattern_opcode_event_output_terminal
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_EXPORTED_PATTERN_OPCODE_EVENT_OUTPUT_TERMINAL
exported_start_trigger_output_terminal¶
nidigital.Session.
exported_start_trigger_output_terminal
¶The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based No Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_EXPORTED_START_TRIGGER_OUTPUT_TERMINAL
frequency_counter_measurement_time¶
nidigital.Session.
frequency_counter_measurement_time
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype float in seconds or datetime.timedelta Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_FREQUENCY_COUNTER_MEASUREMENT_TIME
group_capabilities¶
nidigital.Session.
group_capabilities
¶The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_GROUP_CAPABILITIES
halt_on_keep_alive_opcode¶
nidigital.Session.
halt_on_keep_alive_opcode
¶The following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based No Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_HALT_ON_KEEP_ALIVE_OPCODE
history_ram_buffer_size_per_site¶
nidigital.Session.
history_ram_buffer_size_per_site
¶The following table lists the characteristics of this property.
Characteristic Value Datatype int Permissions read-write Channel Based No Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_HISTORY_RAM_BUFFER_SIZE_PER_SITE
history_ram_cycles_to_acquire¶
nidigital.Session.
history_ram_cycles_to_acquire
¶The following table lists the characteristics of this property.
Characteristic Value Datatype enums.HistoryRAMCyclesToAcquire Permissions read-write Channel Based No Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_HISTORY_RAM_CYCLES_TO_ACQUIRE
history_ram_max_samples_to_acquire_per_site¶
nidigital.Session.
history_ram_max_samples_to_acquire_per_site
¶The following table lists the characteristics of this property.
Characteristic Value Datatype int Permissions read-write Channel Based No Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_HISTORY_RAM_MAX_SAMPLES_TO_ACQUIRE_PER_SITE
history_ram_number_of_samples_is_finite¶
nidigital.Session.
history_ram_number_of_samples_is_finite
¶The following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based No Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_HISTORY_RAM_NUMBER_OF_SAMPLES_IS_FINITE
history_ram_pretrigger_samples¶
nidigital.Session.
history_ram_pretrigger_samples
¶The following table lists the characteristics of this property.
Characteristic Value Datatype int Permissions read-write Channel Based No Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_HISTORY_RAM_PRETRIGGER_SAMPLES
history_ram_trigger_type¶
nidigital.Session.
history_ram_trigger_type
¶The following table lists the characteristics of this property.
Characteristic Value Datatype enums.HistoryRAMTriggerType Permissions read-write Channel Based No Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_HISTORY_RAM_TRIGGER_TYPE
instrument_firmware_revision¶
nidigital.Session.
instrument_firmware_revision
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_INSTRUMENT_FIRMWARE_REVISION
instrument_manufacturer¶
nidigital.Session.
instrument_manufacturer
¶The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_INSTRUMENT_MANUFACTURER
instrument_model¶
nidigital.Session.
instrument_model
¶The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_INSTRUMENT_MODEL
interchange_check¶
nidigital.Session.
interchange_check
¶The following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based No Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_INTERCHANGE_CHECK
io_resource_descriptor¶
nidigital.Session.
io_resource_descriptor
¶The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_IO_RESOURCE_DESCRIPTOR
is_keep_alive_active¶
nidigital.Session.
is_keep_alive_active
¶The following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_IS_KEEP_ALIVE_ACTIVE
logical_name¶
nidigital.Session.
logical_name
¶The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_LOGICAL_NAME
mask_compare¶
nidigital.Session.
mask_compare
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_MASK_COMPARE
pattern_label_history_ram_trigger_cycle_offset¶
nidigital.Session.
pattern_label_history_ram_trigger_cycle_offset
¶The following table lists the characteristics of this property.
Characteristic Value Datatype int Permissions read-write Channel Based No Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_PATTERN_LABEL_HISTORY_RAM_TRIGGER_CYCLE_OFFSET
pattern_label_history_ram_trigger_label¶
nidigital.Session.
pattern_label_history_ram_trigger_label
¶The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based No Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_PATTERN_LABEL_HISTORY_RAM_TRIGGER_LABEL
pattern_label_history_ram_trigger_vector_offset¶
nidigital.Session.
pattern_label_history_ram_trigger_vector_offset
¶The following table lists the characteristics of this property.
Characteristic Value Datatype int Permissions read-write Channel Based No Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_PATTERN_LABEL_HISTORY_RAM_TRIGGER_VECTOR_OFFSET
pattern_opcode_event_terminal_name¶
nidigital.Session.
pattern_opcode_event_terminal_name
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_PATTERN_OPCODE_EVENT_TERMINAL_NAME
ppmu_allow_extended_voltage_range¶
nidigital.Session.
ppmu_allow_extended_voltage_range
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_PPMU_ALLOW_EXTENDED_VOLTAGE_RANGE
ppmu_aperture_time¶
nidigital.Session.
ppmu_aperture_time
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_PPMU_APERTURE_TIME
ppmu_aperture_time_units¶
nidigital.Session.
ppmu_aperture_time_units
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype enums.PPMUApertureTimeUnits Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_PPMU_APERTURE_TIME_UNITS
ppmu_current_level¶
nidigital.Session.
ppmu_current_level
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_PPMU_CURRENT_LEVEL
ppmu_current_level_range¶
nidigital.Session.
ppmu_current_level_range
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_PPMU_CURRENT_LEVEL_RANGE
ppmu_current_limit¶
nidigital.Session.
ppmu_current_limit
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_PPMU_CURRENT_LIMIT
ppmu_current_limit_behavior¶
nidigital.Session.
ppmu_current_limit_behavior
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype enums.PPMUCurrentLimitBehavior Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_PPMU_CURRENT_LIMIT_BEHAVIOR
ppmu_current_limit_range¶
nidigital.Session.
ppmu_current_limit_range
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_PPMU_CURRENT_LIMIT_RANGE
ppmu_current_limit_supported¶
nidigital.Session.
ppmu_current_limit_supported
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read only Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_PPMU_CURRENT_LIMIT_SUPPORTED
ppmu_output_function¶
nidigital.Session.
ppmu_output_function
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype enums.PPMUOutputFunction Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_PPMU_OUTPUT_FUNCTION
ppmu_voltage_level¶
nidigital.Session.
ppmu_voltage_level
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_PPMU_VOLTAGE_LEVEL
ppmu_voltage_limit_high¶
nidigital.Session.
ppmu_voltage_limit_high
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_PPMU_VOLTAGE_LIMIT_HIGH
ppmu_voltage_limit_low¶
nidigital.Session.
ppmu_voltage_limit_low
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_PPMU_VOLTAGE_LIMIT_LOW
query_instrument_status¶
nidigital.Session.
query_instrument_status
¶The following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based No Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_QUERY_INSTRUMENT_STATUS
range_check¶
nidigital.Session.
range_check
¶The following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based No Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_RANGE_CHECK
record_coercions¶
nidigital.Session.
record_coercions
¶The following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based No Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_RECORD_COERCIONS
selected_function¶
nidigital.Session.
selected_function
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype enums.SelectedFunction Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_SELECTED_FUNCTION
sequencer_flag_terminal_name¶
nidigital.Session.
sequencer_flag_terminal_name
¶The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_SEQUENCER_FLAG_TERMINAL_NAME
serial_number¶
nidigital.Session.
serial_number
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_SERIAL_NUMBER
simulate¶
nidigital.Session.
simulate
¶The following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based No Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_SIMULATE
specific_driver_class_spec_major_version¶
nidigital.Session.
specific_driver_class_spec_major_version
¶The following table lists the characteristics of this property.
Characteristic Value Datatype int Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_SPECIFIC_DRIVER_CLASS_SPEC_MAJOR_VERSION
specific_driver_class_spec_minor_version¶
nidigital.Session.
specific_driver_class_spec_minor_version
¶The following table lists the characteristics of this property.
Characteristic Value Datatype int Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_SPECIFIC_DRIVER_CLASS_SPEC_MINOR_VERSION
specific_driver_description¶
nidigital.Session.
specific_driver_description
¶The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_SPECIFIC_DRIVER_DESCRIPTION
specific_driver_prefix¶
nidigital.Session.
specific_driver_prefix
¶The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_SPECIFIC_DRIVER_PREFIX
specific_driver_revision¶
nidigital.Session.
specific_driver_revision
¶The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_SPECIFIC_DRIVER_REVISION
specific_driver_vendor¶
nidigital.Session.
specific_driver_vendor
¶The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_SPECIFIC_DRIVER_VENDOR
start_label¶
nidigital.Session.
start_label
¶The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based No Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_START_LABEL
start_trigger_terminal_name¶
nidigital.Session.
start_trigger_terminal_name
¶The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_START_TRIGGER_TERMINAL_NAME
start_trigger_type¶
nidigital.Session.
start_trigger_type
¶The following table lists the characteristics of this property.
Characteristic Value Datatype enums.TriggerType Permissions read-write Channel Based No Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_START_TRIGGER_TYPE
supported_instrument_models¶
nidigital.Session.
supported_instrument_models
¶The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_SUPPORTED_INSTRUMENT_MODELS
tdr_endpoint_termination¶
nidigital.Session.
tdr_endpoint_termination
¶The following table lists the characteristics of this property.
Characteristic Value Datatype enums.TDREndpointTermination Permissions read-write Channel Based No Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_TDR_ENDPOINT_TERMINATION
tdr_offset¶
nidigital.Session.
tdr_offset
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype float in seconds or datetime.timedelta Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_TDR_OFFSET
termination_mode¶
nidigital.Session.
termination_mode
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype enums.TerminationMode Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_TERMINATION_MODE
timing_absolute_delay¶
nidigital.Session.
timing_absolute_delay
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype float in seconds or datetime.timedelta Permissions read-write Channel Based No Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_TIMING_ABSOLUTE_DELAY
timing_absolute_delay_enabled¶
nidigital.Session.
timing_absolute_delay_enabled
¶The following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based No Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_TIMING_ABSOLUTE_DELAY_ENABLED
vih¶
nidigital.Session.
vih
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_VIH
vil¶
nidigital.Session.
vil
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_VIL
voh¶
nidigital.Session.
voh
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_VOH
vol¶
nidigital.Session.
vol
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_VOL
vterm¶
nidigital.Session.
vterm
¶Tip
This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an nidigital.Session repeated capabilities container, and calling set/get value on the result.
The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based Yes Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NIDIGITAL_ATTR_VTERM
NI-TClk Support¶
nidigital.Session.
tclk
¶This is used to get and set NI-TClk attributes on the session.
See also
See
nitclk.SessionReference
for a complete list of attributes.
Session
- Session
- Methods
- abort
- abort_keep_alive
- apply_levels_and_timing
- apply_tdr_offsets
- burst_pattern
- clock_generator_abort
- clock_generator_generate_clock
- close
- commit
- configure_active_load_levels
- configure_pattern_burst_sites
- configure_time_set_compare_edges_strobe
- configure_time_set_compare_edges_strobe2x
- configure_time_set_drive_edges
- configure_time_set_drive_edges2x
- configure_time_set_drive_format
- configure_time_set_edge
- configure_time_set_edge_multiplier
- configure_time_set_period
- configure_voltage_levels
- create_capture_waveform_from_file_digicapture
- create_capture_waveform_parallel
- create_capture_waveform_serial
- create_source_waveform_from_file_tdms
- create_source_waveform_parallel
- create_source_waveform_serial
- create_time_set
- delete_all_time_sets
- disable_sites
- enable_sites
- fetch_capture_waveform
- fetch_history_ram_cycle_information
- frequency_counter_measure_frequency
- get_channel_names
- get_fail_count
- get_history_ram_sample_count
- get_pattern_name
- get_pattern_pin_names
- get_pin_results_pin_information
- get_site_pass_fail
- get_time_set_drive_format
- get_time_set_edge
- get_time_set_edge_multiplier
- get_time_set_name
- get_time_set_period
- initiate
- is_done
- is_site_enabled
- load_pattern
- load_pin_map
- load_specifications_levels_and_timing
- lock
- ppmu_measure
- ppmu_source
- read_sequencer_flag
- read_sequencer_register
- read_static
- reset
- reset_device
- self_calibrate
- self_test
- send_software_edge_trigger
- tdr
- unload_all_patterns
- unload_specifications
- unlock
- wait_until_done
- write_sequencer_flag
- write_sequencer_register
- write_source_waveform_broadcast
- write_source_waveform_data_from_file_tdms
- write_source_waveform_site_unique
- write_static
- Properties
- active_load_ioh
- active_load_iol
- active_load_vcom
- cache
- channel_count
- clock_generator_frequency
- clock_generator_is_running
- conditional_jump_trigger_terminal_name
- conditional_jump_trigger_type
- cycle_number_history_ram_trigger_cycle_number
- digital_edge_conditional_jump_trigger_edge
- digital_edge_conditional_jump_trigger_source
- digital_edge_start_trigger_edge
- digital_edge_start_trigger_source
- driver_setup
- exported_conditional_jump_trigger_output_terminal
- exported_pattern_opcode_event_output_terminal
- exported_start_trigger_output_terminal
- frequency_counter_measurement_time
- group_capabilities
- halt_on_keep_alive_opcode
- history_ram_buffer_size_per_site
- history_ram_cycles_to_acquire
- history_ram_max_samples_to_acquire_per_site
- history_ram_number_of_samples_is_finite
- history_ram_pretrigger_samples
- history_ram_trigger_type
- instrument_firmware_revision
- instrument_manufacturer
- instrument_model
- interchange_check
- io_resource_descriptor
- is_keep_alive_active
- logical_name
- mask_compare
- pattern_label_history_ram_trigger_cycle_offset
- pattern_label_history_ram_trigger_label
- pattern_label_history_ram_trigger_vector_offset
- pattern_opcode_event_terminal_name
- ppmu_allow_extended_voltage_range
- ppmu_aperture_time
- ppmu_aperture_time_units
- ppmu_current_level
- ppmu_current_level_range
- ppmu_current_limit
- ppmu_current_limit_behavior
- ppmu_current_limit_range
- ppmu_current_limit_supported
- ppmu_output_function
- ppmu_voltage_level
- ppmu_voltage_limit_high
- ppmu_voltage_limit_low
- query_instrument_status
- range_check
- record_coercions
- selected_function
- sequencer_flag_terminal_name
- serial_number
- simulate
- specific_driver_class_spec_major_version
- specific_driver_class_spec_minor_version
- specific_driver_description
- specific_driver_prefix
- specific_driver_revision
- specific_driver_vendor
- start_label
- start_trigger_terminal_name
- start_trigger_type
- supported_instrument_models
- tdr_endpoint_termination
- tdr_offset
- termination_mode
- timing_absolute_delay
- timing_absolute_delay_enabled
- vih
- vil
- voh
- vol
- vterm
- NI-TClk Support