diff --git a/Makefile b/Makefile index fc816f3ec..a86081416 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,5 @@ -ALL_DRIVERS := nifake nimodinst niswitch nidmm niscope +ALL_DRIVERS := nifake nidcpower nidmm niscope niswitch nimodinst DRIVERS ?= $(ALL_DRIVERS) ROOT_DIR := $(abspath .) diff --git a/README.rst b/README.rst index e7ffcc868..310949f76 100644 --- a/README.rst +++ b/README.rst @@ -70,7 +70,7 @@ NI-DCPower Python API Status +-------------------------------+--------------------------+ | NI-DCPower (nidcpower) | | +===============================+==========================+ -| Driver Version Tested Against | 18.1.1 | +| Driver Version Tested Against | 19.1.0d33 | +-------------------------------+--------------------------+ | PyPI Version | |nidcpowerLatestVersion| | +-------------------------------+--------------------------+ diff --git a/build/helper/metadata_add_all.py b/build/helper/metadata_add_all.py index 569ed1940..c60f751da 100644 --- a/build/helper/metadata_add_all.py +++ b/build/helper/metadata_add_all.py @@ -498,7 +498,7 @@ def _add_enum_value_python_name(enum_info, config): # We need to check again to see if we have any values that start with a digit for v in enum_info['values']: - assert not v['python_name'][0].isdigit() + assert not v['python_name'][0].isdigit(), 'enum {0} value {1} begins with a digit'.format(enum_info, v['python_name']) return enum_info diff --git a/docs/nidcpower/class.rst b/docs/nidcpower/class.rst index 26716a51a..9afeac1d8 100644 --- a/docs/nidcpower/class.rst +++ b/docs/nidcpower/class.rst @@ -149,6 +149,8 @@ nidcpower.Session +-----------------------------------------------------------------+----------------------------------------+ | :py:attr:`current_limit_autorange` | bool | +-----------------------------------------------------------------+----------------------------------------+ + | :py:attr:`current_limit_behavior` | int | + +-----------------------------------------------------------------+----------------------------------------+ | :py:attr:`current_limit_high` | float | +-----------------------------------------------------------------+----------------------------------------+ | :py:attr:`current_limit_low` | float | @@ -325,6 +327,10 @@ nidcpower.Session +-----------------------------------------------------------------+----------------------------------------+ | :py:attr:`sequence_loop_count_is_finite` | bool | +-----------------------------------------------------------------+----------------------------------------+ + | :py:attr:`sequence_step_delta_time` | float | + +-----------------------------------------------------------------+----------------------------------------+ + | :py:attr:`sequence_step_delta_time_enabled` | float | + +-----------------------------------------------------------------+----------------------------------------+ | :py:attr:`simulate` | bool | +-----------------------------------------------------------------+----------------------------------------+ | :py:attr:`source_complete_event_output_terminal` | str | @@ -488,7 +494,7 @@ aperture_time +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -535,7 +541,7 @@ aperture_time_units +----------------+-------------------------+ | Permissions | read-write | +----------------+-------------------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+-------------------------+ | Resettable | No | +----------------+-------------------------+ @@ -579,7 +585,7 @@ auto_zero +----------------+----------------+ | Permissions | read-write | +----------------+----------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+----------------+ | Resettable | No | +----------------+----------------+ @@ -614,7 +620,7 @@ auxiliary_power_source_available +----------------+-----------+ | Permissions | read only | +----------------+-----------+ - | Channel Based | False | + | Channel Based | No | +----------------+-----------+ | Resettable | No | +----------------+-----------+ @@ -643,7 +649,7 @@ channel_count +----------------+-----------+ | Permissions | read only | +----------------+-----------+ - | Channel Based | False | + | Channel Based | No | +----------------+-----------+ | Resettable | No | +----------------+-----------+ @@ -705,7 +711,7 @@ compliance_limit_symmetry +----------------+-------------------------------+ | Permissions | read-write | +----------------+-------------------------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+-------------------------------+ | Resettable | No | +----------------+-------------------------------+ @@ -751,7 +757,7 @@ current_compensation_frequency +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -797,7 +803,7 @@ current_gain_bandwidth +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -844,7 +850,7 @@ current_level +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -890,7 +896,7 @@ current_level_autorange +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -938,7 +944,7 @@ current_level_range +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -957,7 +963,7 @@ current_limit .. py:attribute:: current_limit Specifies the current limit, in amps, that the output cannot exceed when generating the desired voltage level on the specified channel(s). - This property is applicable only if the :py:data:`nidcpower.Session.output_function` property is set to :py:data:`~nidcpower.OutputFunction.DC_VOLTAGE` and the :py:data:`nidcpower.Session.compliance_limit_symmetry` property is set to :py:data:`~nidcpower.NIDCPOWER_VAL_SYMMETRIC`. + This property is applicable only if the :py:data:`nidcpower.Session.output_function` property is set to :py:data:`~nidcpower.OutputFunction.DC_VOLTAGE` and the :py:data:`nidcpower.Session.compliance_limit_symmetry` property is set to :py:data:`~nidcpower.ComplianceLimitSymmetry.SYMMETRIC`. :py:data:`nidcpower.Session.output_enabled` property for more information about enabling the output channel. Valid Values: The valid values for this property are defined by the values to which :py:data:`nidcpower.Session.current_limit_range` property is set. @@ -965,8 +971,6 @@ current_limit .. note:: The channel must be enabled for the specified current limit to take effect. Refer to the - .. 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. - .. tip:: This property can use repeated capabilities (channels). If set or get directly on the nidcpower.Session object, then the set/get will use all repeated capabilities in the session. @@ -987,7 +991,7 @@ current_limit +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -1033,7 +1037,7 @@ current_limit_autorange +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -1044,6 +1048,42 @@ current_limit_autorange - LabVIEW Property: **Source:DC Voltage:Current Limit Autorange** - C Attribute: **NIDCPOWER_ATTR_CURRENT_LIMIT_AUTORANGE** +current_limit_behavior +~~~~~~~~~~~~~~~~~~~~~~ + + .. py:currentmodule:: nidcpower.Session + + .. py:attribute:: current_limit_behavior + + .. tip:: This property can use repeated capabilities (channels). If set or get directly on the + nidcpower.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 + nidcpower.Session repeated capabilities container, and calling set/get value on the result.: + + .. code:: python + + session.channels[0,1].current_limit_behavior = var + var = session.channels[0,1].current_limit_behavior + + The following table lists the characteristics of this property. + + +----------------+------------+ + | Characteristic | Value | + +================+============+ + | Datatype | int | + +----------------+------------+ + | Permissions | read-write | + +----------------+------------+ + | Channel Based | Yes | + +----------------+------------+ + | Resettable | No | + +----------------+------------+ + + .. tip:: + This property corresponds to the following LabVIEW Property or C Attribute: + + - C Attribute: **NIDCPOWER_ATTR_CURRENT_LIMIT_BEHAVIOR** + current_limit_high ~~~~~~~~~~~~~~~~~~ @@ -1102,7 +1142,7 @@ current_limit_high +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -1171,7 +1211,7 @@ current_limit_low +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -1219,7 +1259,7 @@ current_limit_range +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -1265,7 +1305,7 @@ current_pole_zero_ratio +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -1300,7 +1340,7 @@ dc_noise_rejection +----------------+------------------------+ | Permissions | read-write | +----------------+------------------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------------------+ | Resettable | No | +----------------+------------------------+ @@ -1336,7 +1376,7 @@ digital_edge_measure_trigger_input_terminal +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -1371,7 +1411,7 @@ digital_edge_pulse_trigger_input_terminal +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -1407,7 +1447,7 @@ digital_edge_sequence_advance_trigger_input_terminal +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -1443,7 +1483,7 @@ digital_edge_source_trigger_input_terminal +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -1479,7 +1519,7 @@ digital_edge_start_trigger_input_terminal +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -1510,7 +1550,7 @@ driver_setup +----------------+-----------+ | Permissions | read only | +----------------+-----------+ - | Channel Based | False | + | Channel Based | No | +----------------+-----------+ | Resettable | No | +----------------+-----------+ @@ -1546,7 +1586,7 @@ exported_measure_trigger_output_terminal +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -1581,7 +1621,7 @@ exported_pulse_trigger_output_terminal +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -1617,7 +1657,7 @@ exported_sequence_advance_trigger_output_terminal +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -1653,7 +1693,7 @@ exported_source_trigger_output_terminal +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -1689,7 +1729,7 @@ exported_start_trigger_output_terminal +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -1718,7 +1758,7 @@ fetch_backlog +----------------+-----------+ | Permissions | read only | +----------------+-----------+ - | Channel Based | False | + | Channel Based | No | +----------------+-----------+ | Resettable | No | +----------------+-----------+ @@ -1747,7 +1787,7 @@ instrument_firmware_revision +----------------+-----------+ | Permissions | read only | +----------------+-----------+ - | Channel Based | False | + | Channel Based | No | +----------------+-----------+ | Resettable | No | +----------------+-----------+ @@ -1776,7 +1816,7 @@ instrument_manufacturer +----------------+-----------+ | Permissions | read only | +----------------+-----------+ - | Channel Based | False | + | Channel Based | No | +----------------+-----------+ | Resettable | No | +----------------+-----------+ @@ -1805,7 +1845,7 @@ instrument_model +----------------+-----------+ | Permissions | read only | +----------------+-----------+ - | Channel Based | False | + | Channel Based | No | +----------------+-----------+ | Resettable | No | +----------------+-----------+ @@ -1840,7 +1880,7 @@ interlock_input_open +----------------+-----------+ | Permissions | read only | +----------------+-----------+ - | Channel Based | False | + | Channel Based | No | +----------------+-----------+ | Resettable | No | +----------------+-----------+ @@ -1871,7 +1911,7 @@ io_resource_descriptor +----------------+-----------+ | Permissions | read only | +----------------+-----------+ - | Channel Based | False | + | Channel Based | No | +----------------+-----------+ | Resettable | No | +----------------+-----------+ @@ -1901,7 +1941,7 @@ logical_name +----------------+-----------+ | Permissions | read only | +----------------+-----------+ - | Channel Based | False | + | Channel Based | No | +----------------+-----------+ | Resettable | No | +----------------+-----------+ @@ -1938,7 +1978,7 @@ measure_buffer_size +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -1974,7 +2014,7 @@ measure_complete_event_delay +----------------+----------------------------------------+ | Permissions | read-write | +----------------+----------------------------------------+ - | Channel Based | False | + | Channel Based | No | +----------------+----------------------------------------+ | Resettable | No | +----------------+----------------------------------------+ @@ -2009,7 +2049,7 @@ measure_complete_event_output_terminal +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -2044,7 +2084,7 @@ measure_complete_event_pulse_polarity +----------------+----------------+ | Permissions | read-write | +----------------+----------------+ - | Channel Based | False | + | Channel Based | No | +----------------+----------------+ | Resettable | No | +----------------+----------------+ @@ -2082,7 +2122,7 @@ measure_complete_event_pulse_width +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -2117,7 +2157,7 @@ measure_record_delta_time +----------------+----------------------------------------+ | Permissions | read only | +----------------+----------------------------------------+ - | Channel Based | False | + | Channel Based | No | +----------------+----------------------------------------+ | Resettable | No | +----------------+----------------------------------------+ @@ -2153,7 +2193,7 @@ measure_record_length +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -2188,7 +2228,7 @@ measure_record_length_is_finite +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -2223,7 +2263,7 @@ measure_trigger_type +----------------+-------------------+ | Permissions | read-write | +----------------+-------------------+ - | Channel Based | False | + | Channel Based | No | +----------------+-------------------+ | Resettable | No | +----------------+-------------------+ @@ -2254,7 +2294,7 @@ measure_when +----------------+-------------------+ | Permissions | read-write | +----------------+-------------------+ - | Channel Based | False | + | Channel Based | No | +----------------+-------------------+ | Resettable | No | +----------------+-------------------+ @@ -2300,7 +2340,7 @@ output_capacitance +----------------+-------------------------+ | Permissions | read-write | +----------------+-------------------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+-------------------------+ | Resettable | No | +----------------+-------------------------+ @@ -2348,7 +2388,7 @@ output_connected +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -2395,7 +2435,7 @@ output_enabled +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -2453,7 +2493,7 @@ output_function +----------------+----------------------+ | Permissions | read-write | +----------------+----------------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+----------------------+ | Resettable | No | +----------------+----------------------+ @@ -2499,7 +2539,7 @@ output_resistance +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -2530,7 +2570,7 @@ overranging_enabled +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -2566,7 +2606,7 @@ ovp_enabled +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -2602,7 +2642,7 @@ ovp_limit +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -2650,7 +2690,7 @@ power_line_frequency +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -2685,7 +2725,7 @@ power_source +----------------+-------------------+ | Permissions | read-write | +----------------+-------------------+ - | Channel Based | False | + | Channel Based | No | +----------------+-------------------+ | Resettable | No | +----------------+-------------------+ @@ -2714,7 +2754,7 @@ power_source_in_use +----------------+------------------------+ | Permissions | read only | +----------------+------------------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------------------+ | Resettable | No | +----------------+------------------------+ @@ -2760,7 +2800,7 @@ pulse_bias_current_level +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -2806,7 +2846,7 @@ pulse_bias_current_limit +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -2878,7 +2918,7 @@ pulse_bias_current_limit_high +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -2950,7 +2990,7 @@ pulse_bias_current_limit_low +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -2996,7 +3036,7 @@ pulse_bias_delay +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -3042,7 +3082,7 @@ pulse_bias_voltage_level +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -3088,7 +3128,7 @@ pulse_bias_voltage_limit +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -3160,7 +3200,7 @@ pulse_bias_voltage_limit_high +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -3232,7 +3272,7 @@ pulse_bias_voltage_limit_low +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -3267,7 +3307,7 @@ pulse_complete_event_output_terminal +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -3301,7 +3341,7 @@ pulse_complete_event_pulse_polarity +----------------+----------------+ | Permissions | read-write | +----------------+----------------+ - | Channel Based | False | + | Channel Based | No | +----------------+----------------+ | Resettable | No | +----------------+----------------+ @@ -3337,7 +3377,7 @@ pulse_complete_event_pulse_width +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -3383,7 +3423,7 @@ pulse_current_level +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -3430,7 +3470,7 @@ pulse_current_level_range +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -3449,15 +3489,13 @@ pulse_current_limit .. py:attribute:: pulse_current_limit Specifies the pulse current limit, in amps, that the output cannot exceed when generating the desired pulse voltage on the specified channel(s) during the on phase of a pulse. - This property is applicable only if the :py:data:`nidcpower.Session.output_function` property is set to :py:data:`~nidcpower.OutputFunction.PULSE_VOLTAGE` and the :py:data:`nidcpower.Session.compliance_limit_symmetry` property is set to :py:data:`~nidcpower.NIDCPOWER_VAL_SYMMETRIC`. + This property is applicable only if the :py:data:`nidcpower.Session.output_function` property is set to :py:data:`~nidcpower.OutputFunction.PULSE_VOLTAGE` and the :py:data:`nidcpower.Session.compliance_limit_symmetry` property is set to :py:data:`~nidcpower.ComplianceLimitSymmetry.SYMMETRIC`. Valid Values: The valid values for this property are defined by the values you specify for the :py:data:`nidcpower.Session.pulse_current_limit_range` property. .. note:: This property is not supported by all devices. Refer to Supported Properties by Device for information about supported devices. - .. 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. - .. tip:: This property can use repeated capabilities (channels). If set or get directly on the nidcpower.Session object, then the set/get will use all repeated capabilities in the session. @@ -3478,7 +3516,7 @@ pulse_current_limit +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -3550,7 +3588,7 @@ pulse_current_limit_high +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -3622,7 +3660,7 @@ pulse_current_limit_low +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -3669,7 +3707,7 @@ pulse_current_limit_range +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -3715,7 +3753,7 @@ pulse_off_time +----------------+----------------------------------------+ | Permissions | read-write | +----------------+----------------------------------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+----------------------------------------+ | Resettable | No | +----------------+----------------------------------------+ @@ -3761,7 +3799,7 @@ pulse_on_time +----------------+----------------------------------------+ | Permissions | read-write | +----------------+----------------------------------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+----------------------------------------+ | Resettable | No | +----------------+----------------------------------------+ @@ -3795,7 +3833,7 @@ pulse_trigger_type +----------------+-------------------+ | Permissions | read-write | +----------------+-------------------+ - | Channel Based | False | + | Channel Based | No | +----------------+-------------------+ | Resettable | No | +----------------+-------------------+ @@ -3841,7 +3879,7 @@ pulse_voltage_level +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -3888,7 +3926,7 @@ pulse_voltage_level_range +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -3907,15 +3945,13 @@ pulse_voltage_limit .. py:attribute:: pulse_voltage_limit Specifies the pulse voltage limit, in volts, that the output cannot exceed when generating the desired pulse current on the specified channel(s) during the on phase of a pulse. - This property is applicable only if the :py:data:`nidcpower.Session.output_function` property is set to :py:data:`~nidcpower.OutputFunction.PULSE_CURRENT` and the :py:data:`nidcpower.Session.compliance_limit_symmetry` property is set to :py:data:`~nidcpower.NIDCPOWER_VAL_SYMMETRIC`. + This property is applicable only if the :py:data:`nidcpower.Session.output_function` property is set to :py:data:`~nidcpower.OutputFunction.PULSE_CURRENT` and the :py:data:`nidcpower.Session.compliance_limit_symmetry` property is set to :py:data:`~nidcpower.ComplianceLimitSymmetry.SYMMETRIC`. Valid Values: The valid values for this property are defined by the values you specify for the :py:data:`nidcpower.Session.pulse_voltage_limit_range` property. .. note:: This property is not supported by all devices. Refer to Supported Properties by Device for information about supported devices. - .. 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. - .. tip:: This property can use repeated capabilities (channels). If set or get directly on the nidcpower.Session object, then the set/get will use all repeated capabilities in the session. @@ -3936,7 +3972,7 @@ pulse_voltage_limit +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -4008,7 +4044,7 @@ pulse_voltage_limit_high +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -4080,7 +4116,7 @@ pulse_voltage_limit_low +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -4127,7 +4163,7 @@ pulse_voltage_limit_range +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -4160,7 +4196,7 @@ query_instrument_status +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -4194,7 +4230,7 @@ ready_for_pulse_trigger_event_output_terminal +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -4228,7 +4264,7 @@ ready_for_pulse_trigger_event_pulse_polarity +----------------+----------------+ | Permissions | read-write | +----------------+----------------+ - | Channel Based | False | + | Channel Based | No | +----------------+----------------+ | Resettable | No | +----------------+----------------+ @@ -4264,7 +4300,7 @@ ready_for_pulse_trigger_event_pulse_width +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -4311,7 +4347,7 @@ reset_average_before_measurement +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -4363,7 +4399,7 @@ samples_to_average +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -4399,7 +4435,7 @@ self_calibration_persistence +----------------+----------------------------------+ | Permissions | read-write | +----------------+----------------------------------+ - | Channel Based | False | + | Channel Based | No | +----------------+----------------------------------+ | Resettable | No | +----------------+----------------------------------+ @@ -4443,7 +4479,7 @@ sense +----------------+-------------+ | Permissions | read-write | +----------------+-------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+-------------+ | Resettable | No | +----------------+-------------+ @@ -4478,7 +4514,7 @@ sequence_advance_trigger_type +----------------+-------------------+ | Permissions | read-write | +----------------+-------------------+ - | Channel Based | False | + | Channel Based | No | +----------------+-------------------+ | Resettable | No | +----------------+-------------------+ @@ -4513,7 +4549,7 @@ sequence_engine_done_event_output_terminal +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -4548,7 +4584,7 @@ sequence_engine_done_event_pulse_polarity +----------------+----------------+ | Permissions | read-write | +----------------+----------------+ - | Channel Based | False | + | Channel Based | No | +----------------+----------------+ | Resettable | No | +----------------+----------------+ @@ -4586,7 +4622,7 @@ sequence_engine_done_event_pulse_width +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -4621,7 +4657,7 @@ sequence_iteration_complete_event_output_terminal +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -4656,7 +4692,7 @@ sequence_iteration_complete_event_pulse_polarity +----------------+----------------+ | Permissions | read-write | +----------------+----------------+ - | Channel Based | False | + | Channel Based | No | +----------------+----------------+ | Resettable | No | +----------------+----------------+ @@ -4694,7 +4730,7 @@ sequence_iteration_complete_event_pulse_width +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -4731,7 +4767,7 @@ sequence_loop_count +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -4767,7 +4803,7 @@ sequence_loop_count_is_finite +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -4778,6 +4814,78 @@ sequence_loop_count_is_finite - LabVIEW Property: **Source:Advanced:Sequence Loop Count Is Finite** - C Attribute: **NIDCPOWER_ATTR_SEQUENCE_LOOP_COUNT_IS_FINITE** +sequence_step_delta_time +~~~~~~~~~~~~~~~~~~~~~~~~ + + .. py:currentmodule:: nidcpower.Session + + .. py:attribute:: sequence_step_delta_time + + .. tip:: This property can use repeated capabilities (channels). If set or get directly on the + nidcpower.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 + nidcpower.Session repeated capabilities container, and calling set/get value on the result.: + + .. code:: python + + session.channels[0,1].sequence_step_delta_time = var + var = session.channels[0,1].sequence_step_delta_time + + The following table lists the characteristics of this property. + + +----------------+------------+ + | Characteristic | Value | + +================+============+ + | Datatype | float | + +----------------+------------+ + | Permissions | read-write | + +----------------+------------+ + | Channel Based | Yes | + +----------------+------------+ + | Resettable | No | + +----------------+------------+ + + .. tip:: + This property corresponds to the following LabVIEW Property or C Attribute: + + - C Attribute: **NIDCPOWER_ATTR_SEQUENCE_STEP_DELTA_TIME** + +sequence_step_delta_time_enabled +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + .. py:currentmodule:: nidcpower.Session + + .. py:attribute:: sequence_step_delta_time_enabled + + .. tip:: This property can use repeated capabilities (channels). If set or get directly on the + nidcpower.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 + nidcpower.Session repeated capabilities container, and calling set/get value on the result.: + + .. code:: python + + session.channels[0,1].sequence_step_delta_time_enabled = var + var = session.channels[0,1].sequence_step_delta_time_enabled + + The following table lists the characteristics of this property. + + +----------------+------------+ + | Characteristic | Value | + +================+============+ + | Datatype | float | + +----------------+------------+ + | Permissions | read-write | + +----------------+------------+ + | Channel Based | Yes | + +----------------+------------+ + | Resettable | No | + +----------------+------------+ + + .. tip:: + This property corresponds to the following LabVIEW Property or C Attribute: + + - C Attribute: **NIDCPOWER_ATTR_SEQUENCE_STEP_DELTA_TIME_ENABLED** + simulate ~~~~~~~~ @@ -4797,7 +4905,7 @@ simulate +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -4832,7 +4940,7 @@ source_complete_event_output_terminal +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -4867,7 +4975,7 @@ source_complete_event_pulse_polarity +----------------+----------------+ | Permissions | read-write | +----------------+----------------+ - | Channel Based | False | + | Channel Based | No | +----------------+----------------+ | Resettable | No | +----------------+----------------+ @@ -4905,7 +5013,7 @@ source_complete_event_pulse_width +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -4952,7 +5060,7 @@ source_delay +----------------+----------------------------------------+ | Permissions | read-write | +----------------+----------------------------------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+----------------------------------------+ | Resettable | No | +----------------+----------------------------------------+ @@ -4982,7 +5090,7 @@ source_mode +----------------+------------------+ | Permissions | read-write | +----------------+------------------+ - | Channel Based | False | + | Channel Based | No | +----------------+------------------+ | Resettable | No | +----------------+------------------+ @@ -5017,7 +5125,7 @@ source_trigger_type +----------------+-------------------+ | Permissions | read-write | +----------------+-------------------+ - | Channel Based | False | + | Channel Based | No | +----------------+-------------------+ | Resettable | No | +----------------+-------------------+ @@ -5046,7 +5154,7 @@ specific_driver_description +----------------+-----------+ | Permissions | read only | +----------------+-----------+ - | Channel Based | False | + | Channel Based | No | +----------------+-----------+ | Resettable | No | +----------------+-----------+ @@ -5075,7 +5183,7 @@ specific_driver_prefix +----------------+-----------+ | Permissions | read only | +----------------+-----------+ - | Channel Based | False | + | Channel Based | No | +----------------+-----------+ | Resettable | No | +----------------+-----------+ @@ -5104,7 +5212,7 @@ specific_driver_revision +----------------+-----------+ | Permissions | read only | +----------------+-----------+ - | Channel Based | False | + | Channel Based | No | +----------------+-----------+ | Resettable | No | +----------------+-----------+ @@ -5133,7 +5241,7 @@ specific_driver_vendor +----------------+-----------+ | Permissions | read only | +----------------+-----------+ - | Channel Based | False | + | Channel Based | No | +----------------+-----------+ | Resettable | No | +----------------+-----------+ @@ -5168,7 +5276,7 @@ start_trigger_type +----------------+-------------------+ | Permissions | read-write | +----------------+-------------------+ - | Channel Based | False | + | Channel Based | No | +----------------+-------------------+ | Resettable | No | +----------------+-------------------+ @@ -5197,7 +5305,7 @@ supported_instrument_models +----------------+-----------+ | Permissions | read only | +----------------+-----------+ - | Channel Based | False | + | Channel Based | No | +----------------+-----------+ | Resettable | No | +----------------+-----------+ @@ -5243,7 +5351,7 @@ transient_response +----------------+-------------------------+ | Permissions | read-write | +----------------+-------------------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+-------------------------+ | Resettable | No | +----------------+-------------------------+ @@ -5289,7 +5397,7 @@ voltage_compensation_frequency +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -5335,7 +5443,7 @@ voltage_gain_bandwidth +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -5382,7 +5490,7 @@ voltage_level +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -5428,7 +5536,7 @@ voltage_level_autorange +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -5476,7 +5584,7 @@ voltage_level_range +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -5495,7 +5603,7 @@ voltage_limit .. py:attribute:: voltage_limit Specifies the voltage limit, in volts, that the output cannot exceed when generating the desired current level on the specified channels. - This property is applicable only if the :py:data:`nidcpower.Session.output_function` property is set to :py:data:`~nidcpower.OutputFunction.DC_CURRENT` and the :py:data:`nidcpower.Session.compliance_limit_symmetry` property is set to :py:data:`~nidcpower.NIDCPOWER_VAL_SYMMETRIC`. + This property is applicable only if the :py:data:`nidcpower.Session.output_function` property is set to :py:data:`~nidcpower.OutputFunction.DC_CURRENT` and the :py:data:`nidcpower.Session.compliance_limit_symmetry` property is set to :py:data:`~nidcpower.ComplianceLimitSymmetry.SYMMETRIC`. :py:data:`nidcpower.Session.output_enabled` property for more information about enabling the output channel. Valid Values: The valid values for this property are defined by the values to which the :py:data:`nidcpower.Session.voltage_limit_range` property is set. @@ -5503,8 +5611,6 @@ voltage_limit .. note:: The channel must be enabled for the specified current level to take effect. Refer to the - .. 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. - .. tip:: This property can use repeated capabilities (channels). If set or get directly on the nidcpower.Session object, then the set/get will use all repeated capabilities in the session. @@ -5525,7 +5631,7 @@ voltage_limit +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -5571,7 +5677,7 @@ voltage_limit_autorange +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -5640,7 +5746,7 @@ voltage_limit_high +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -5709,7 +5815,7 @@ voltage_limit_low +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -5757,7 +5863,7 @@ voltage_limit_range +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -5803,7 +5909,7 @@ voltage_pole_zero_ratio +----------------+------------+ | Permissions | read-write | +----------------+------------+ - | Channel Based | True | + | Channel Based | Yes | +----------------+------------+ | Resettable | No | +----------------+------------+ @@ -7226,6 +7332,8 @@ Properties +-----------------------------------------------------------------------------------+----------------------------------------+ | :py:attr:`nidcpower.Session.current_limit_autorange` | bool | +-----------------------------------------------------------------------------------+----------------------------------------+ +| :py:attr:`nidcpower.Session.current_limit_behavior` | int | ++-----------------------------------------------------------------------------------+----------------------------------------+ | :py:attr:`nidcpower.Session.current_limit_high` | float | +-----------------------------------------------------------------------------------+----------------------------------------+ | :py:attr:`nidcpower.Session.current_limit_low` | float | @@ -7402,6 +7510,10 @@ Properties +-----------------------------------------------------------------------------------+----------------------------------------+ | :py:attr:`nidcpower.Session.sequence_loop_count_is_finite` | bool | +-----------------------------------------------------------------------------------+----------------------------------------+ +| :py:attr:`nidcpower.Session.sequence_step_delta_time` | float | ++-----------------------------------------------------------------------------------+----------------------------------------+ +| :py:attr:`nidcpower.Session.sequence_step_delta_time_enabled` | float | ++-----------------------------------------------------------------------------------+----------------------------------------+ | :py:attr:`nidcpower.Session.simulate` | bool | +-----------------------------------------------------------------------------------+----------------------------------------+ | :py:attr:`nidcpower.Session.source_complete_event_output_terminal` | str | diff --git a/docs/nidcpower/status.inc b/docs/nidcpower/status.inc index 4da9a8772..560f7c499 100644 --- a/docs/nidcpower/status.inc +++ b/docs/nidcpower/status.inc @@ -5,7 +5,7 @@ NI-DCPower Python API Status +-------------------------------+--------------------------+ | NI-DCPower (nidcpower) | | +===============================+==========================+ -| Driver Version Tested Against | 18.1.1 | +| Driver Version Tested Against | 19.1.0d33 | +-------------------------------+--------------------------+ | PyPI Version | |nidcpowerLatestVersion| | +-------------------------------+--------------------------+ diff --git a/generated/nidcpower/session.py b/generated/nidcpower/session.py index 91295696d..fafbb8dea 100644 --- a/generated/nidcpower/session.py +++ b/generated/nidcpower/session.py @@ -348,15 +348,12 @@ class _SessionBase(object): '''Type: float Specifies the current limit, in amps, that the output cannot exceed when generating the desired voltage level on the specified channel(s). - This property is applicable only if the output_function property is set to OutputFunction.DC_VOLTAGE and the compliance_limit_symmetry property is set to NIDCPOWER_VAL_SYMMETRIC. + This property is applicable only if the output_function property is set to OutputFunction.DC_VOLTAGE and the compliance_limit_symmetry property is set to ComplianceLimitSymmetry.SYMMETRIC. output_enabled property for more information about enabling the output channel. Valid Values: The valid values for this property are defined by the values to which current_limit_range property is set. Note: The channel must be enabled for the specified current limit to take effect. Refer to the - 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. - Tip: This property can use repeated capabilities (channels). If set or get directly on the nidcpower.Session object, then the set/get will use all repeated capabilities in the session. @@ -384,6 +381,18 @@ class _SessionBase(object): session.channels[0,1].current_limit_autorange = var var = session.channels[0,1].current_limit_autorange ''' + current_limit_behavior = _attributes.AttributeViInt32(1250004) + '''Type: int + + Tip: + This property can use repeated capabilities (channels). If set or get directly on the + nidcpower.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 + nidcpower.Session repeated capabilities container, and calling set/get value on the result.: + + session.channels[0,1].current_limit_behavior = var + var = session.channels[0,1].current_limit_behavior + ''' current_limit_high = _attributes.AttributeViReal64(1150187) '''Type: float @@ -1270,14 +1279,11 @@ class _SessionBase(object): '''Type: float Specifies the pulse current limit, in amps, that the output cannot exceed when generating the desired pulse voltage on the specified channel(s) during the on phase of a pulse. - This property is applicable only if the output_function property is set to OutputFunction.PULSE_VOLTAGE and the compliance_limit_symmetry property is set to NIDCPOWER_VAL_SYMMETRIC. + This property is applicable only if the output_function property is set to OutputFunction.PULSE_VOLTAGE and the compliance_limit_symmetry property is set to ComplianceLimitSymmetry.SYMMETRIC. Valid Values: The valid values for this property are defined by the values you specify for the pulse_current_limit_range property. Note: This property is not supported by all devices. Refer to Supported Properties by Device for information about supported devices. - 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. - Tip: This property can use repeated capabilities (channels). If set or get directly on the nidcpower.Session object, then the set/get will use all repeated capabilities in the session. @@ -1483,14 +1489,11 @@ class _SessionBase(object): '''Type: float Specifies the pulse voltage limit, in volts, that the output cannot exceed when generating the desired pulse current on the specified channel(s) during the on phase of a pulse. - This property is applicable only if the output_function property is set to OutputFunction.PULSE_CURRENT and the compliance_limit_symmetry property is set to NIDCPOWER_VAL_SYMMETRIC. + This property is applicable only if the output_function property is set to OutputFunction.PULSE_CURRENT and the compliance_limit_symmetry property is set to ComplianceLimitSymmetry.SYMMETRIC. Valid Values: The valid values for this property are defined by the values you specify for the pulse_voltage_limit_range property. Note: This property is not supported by all devices. Refer to Supported Properties by Device for information about supported devices. - 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. - Tip: This property can use repeated capabilities (channels). If set or get directly on the nidcpower.Session object, then the set/get will use all repeated capabilities in the session. @@ -1805,6 +1808,30 @@ class _SessionBase(object): Note: This property is not supported by all devices. When the ''' + sequence_step_delta_time = _attributes.AttributeViReal64(1150198) + '''Type: float + + Tip: + This property can use repeated capabilities (channels). If set or get directly on the + nidcpower.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 + nidcpower.Session repeated capabilities container, and calling set/get value on the result.: + + session.channels[0,1].sequence_step_delta_time = var + var = session.channels[0,1].sequence_step_delta_time + ''' + sequence_step_delta_time_enabled = _attributes.AttributeViReal64(1150199) + '''Type: float + + Tip: + This property can use repeated capabilities (channels). If set or get directly on the + nidcpower.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 + nidcpower.Session repeated capabilities container, and calling set/get value on the result.: + + session.channels[0,1].sequence_step_delta_time_enabled = var + var = session.channels[0,1].sequence_step_delta_time_enabled + ''' simulate = _attributes.AttributeViBoolean(1050005) '''Type: bool @@ -2025,15 +2052,12 @@ class _SessionBase(object): '''Type: float Specifies the voltage limit, in volts, that the output cannot exceed when generating the desired current level on the specified channels. - This property is applicable only if the output_function property is set to OutputFunction.DC_CURRENT and the compliance_limit_symmetry property is set to NIDCPOWER_VAL_SYMMETRIC. + This property is applicable only if the output_function property is set to OutputFunction.DC_CURRENT and the compliance_limit_symmetry property is set to ComplianceLimitSymmetry.SYMMETRIC. output_enabled property for more information about enabling the output channel. Valid Values: The valid values for this property are defined by the values to which the voltage_limit_range property is set. Note: The channel must be enabled for the specified current level to take effect. Refer to the - 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. - Tip: This property can use repeated capabilities (channels). If set or get directly on the nidcpower.Session object, then the set/get will use all repeated capabilities in the session. diff --git a/generated/nidcpower/unit_tests/_mock_helper.py b/generated/nidcpower/unit_tests/_mock_helper.py index a8e5c1685..fe194874f 100644 --- a/generated/nidcpower/unit_tests/_mock_helper.py +++ b/generated/nidcpower/unit_tests/_mock_helper.py @@ -34,7 +34,7 @@ def __init__(self): self._defaults['Disable']['return'] = 0 self._defaults['ExportAttributeConfigurationBuffer'] = {} self._defaults['ExportAttributeConfigurationBuffer']['return'] = 0 - self._defaults['ExportAttributeConfigurationBuffer']['Configuration'] = None + self._defaults['ExportAttributeConfigurationBuffer']['configuration'] = None self._defaults['ExportAttributeConfigurationFile'] = {} self._defaults['ExportAttributeConfigurationFile']['return'] = 0 self._defaults['FetchMultiple'] = {} @@ -63,31 +63,31 @@ def __init__(self): self._defaults['GetChannelName']['channelName'] = None self._defaults['GetError'] = {} self._defaults['GetError']['return'] = 0 - self._defaults['GetError']['Code'] = None - self._defaults['GetError']['Description'] = None + self._defaults['GetError']['code'] = None + self._defaults['GetError']['description'] = None self._defaults['GetExtCalLastDateAndTime'] = {} self._defaults['GetExtCalLastDateAndTime']['return'] = 0 - self._defaults['GetExtCalLastDateAndTime']['Year'] = None - self._defaults['GetExtCalLastDateAndTime']['Month'] = None - self._defaults['GetExtCalLastDateAndTime']['Day'] = None - self._defaults['GetExtCalLastDateAndTime']['Hour'] = None - self._defaults['GetExtCalLastDateAndTime']['Minute'] = None + self._defaults['GetExtCalLastDateAndTime']['year'] = None + self._defaults['GetExtCalLastDateAndTime']['month'] = None + self._defaults['GetExtCalLastDateAndTime']['day'] = None + self._defaults['GetExtCalLastDateAndTime']['hour'] = None + self._defaults['GetExtCalLastDateAndTime']['minute'] = None self._defaults['GetExtCalLastTemp'] = {} self._defaults['GetExtCalLastTemp']['return'] = 0 - self._defaults['GetExtCalLastTemp']['Temperature'] = None + self._defaults['GetExtCalLastTemp']['temperature'] = None self._defaults['GetExtCalRecommendedInterval'] = {} self._defaults['GetExtCalRecommendedInterval']['return'] = 0 - self._defaults['GetExtCalRecommendedInterval']['Months'] = None + self._defaults['GetExtCalRecommendedInterval']['months'] = None self._defaults['GetSelfCalLastDateAndTime'] = {} self._defaults['GetSelfCalLastDateAndTime']['return'] = 0 - self._defaults['GetSelfCalLastDateAndTime']['Year'] = None - self._defaults['GetSelfCalLastDateAndTime']['Month'] = None - self._defaults['GetSelfCalLastDateAndTime']['Day'] = None - self._defaults['GetSelfCalLastDateAndTime']['Hour'] = None - self._defaults['GetSelfCalLastDateAndTime']['Minute'] = None + self._defaults['GetSelfCalLastDateAndTime']['year'] = None + self._defaults['GetSelfCalLastDateAndTime']['month'] = None + self._defaults['GetSelfCalLastDateAndTime']['day'] = None + self._defaults['GetSelfCalLastDateAndTime']['hour'] = None + self._defaults['GetSelfCalLastDateAndTime']['minute'] = None self._defaults['GetSelfCalLastTemp'] = {} self._defaults['GetSelfCalLastTemp']['return'] = 0 - self._defaults['GetSelfCalLastTemp']['Temperature'] = None + self._defaults['GetSelfCalLastTemp']['temperature'] = None self._defaults['ImportAttributeConfigurationBuffer'] = {} self._defaults['ImportAttributeConfigurationBuffer']['return'] = 0 self._defaults['ImportAttributeConfigurationFile'] = {} @@ -102,7 +102,7 @@ def __init__(self): self._defaults['LockSession']['callerHasLock'] = None self._defaults['Measure'] = {} self._defaults['Measure']['return'] = 0 - self._defaults['Measure']['Measurement'] = None + self._defaults['Measure']['measurement'] = None self._defaults['MeasureMultiple'] = {} self._defaults['MeasureMultiple']['return'] = 0 self._defaults['MeasureMultiple']['voltageMeasurements'] = None @@ -127,7 +127,7 @@ def __init__(self): self._defaults['QueryOutputState']['inState'] = None self._defaults['ReadCurrentTemperature'] = {} self._defaults['ReadCurrentTemperature']['return'] = 0 - self._defaults['ReadCurrentTemperature']['Temperature'] = None + self._defaults['ReadCurrentTemperature']['temperature'] = None self._defaults['ResetDevice'] = {} self._defaults['ResetDevice']['return'] = 0 self._defaults['ResetWithDefaults'] = {} @@ -212,16 +212,16 @@ def niDCPower_Disable(self, vi): # noqa: N802 def niDCPower_ExportAttributeConfigurationBuffer(self, vi, size, configuration): # noqa: N802 if self._defaults['ExportAttributeConfigurationBuffer']['return'] != 0: return self._defaults['ExportAttributeConfigurationBuffer']['return'] - if self._defaults['ExportAttributeConfigurationBuffer']['Configuration'] is None: - raise MockFunctionCallError("niDCPower_ExportAttributeConfigurationBuffer", param='Configuration') + if self._defaults['ExportAttributeConfigurationBuffer']['configuration'] is None: + raise MockFunctionCallError("niDCPower_ExportAttributeConfigurationBuffer", param='configuration') if size.value == 0: - return len(self._defaults['ExportAttributeConfigurationBuffer']['Configuration']) + return len(self._defaults['ExportAttributeConfigurationBuffer']['configuration']) try: configuration_ref = configuration.contents except AttributeError: configuration_ref = configuration - for i in range(len(self._defaults['ExportAttributeConfigurationBuffer']['Configuration'])): - configuration_ref[i] = self._defaults['ExportAttributeConfigurationBuffer']['Configuration'][i] + for i in range(len(self._defaults['ExportAttributeConfigurationBuffer']['configuration'])): + configuration_ref[i] = self._defaults['ExportAttributeConfigurationBuffer']['configuration'][i] return self._defaults['ExportAttributeConfigurationBuffer']['return'] def niDCPower_ExportAttributeConfigurationFile(self, vi, file_path): # noqa: N802 @@ -336,105 +336,105 @@ def niDCPower_GetError(self, vi, code, buffer_size, description): # noqa: N802 if self._defaults['GetError']['return'] != 0: return self._defaults['GetError']['return'] # code - if self._defaults['GetError']['Code'] is None: - raise MockFunctionCallError("niDCPower_GetError", param='Code') + if self._defaults['GetError']['code'] is None: + raise MockFunctionCallError("niDCPower_GetError", param='code') if code is not None: - code.contents.value = self._defaults['GetError']['Code'] - if self._defaults['GetError']['Description'] is None: - raise MockFunctionCallError("niDCPower_GetError", param='Description') + code.contents.value = self._defaults['GetError']['code'] + if self._defaults['GetError']['description'] is None: + raise MockFunctionCallError("niDCPower_GetError", param='description') if buffer_size.value == 0: - return len(self._defaults['GetError']['Description']) - description.value = self._defaults['GetError']['Description'].encode('ascii') + return len(self._defaults['GetError']['description']) + description.value = self._defaults['GetError']['description'].encode('ascii') return self._defaults['GetError']['return'] def niDCPower_GetExtCalLastDateAndTime(self, vi, year, month, day, hour, minute): # noqa: N802 if self._defaults['GetExtCalLastDateAndTime']['return'] != 0: return self._defaults['GetExtCalLastDateAndTime']['return'] # year - if self._defaults['GetExtCalLastDateAndTime']['Year'] is None: - raise MockFunctionCallError("niDCPower_GetExtCalLastDateAndTime", param='Year') + if self._defaults['GetExtCalLastDateAndTime']['year'] is None: + raise MockFunctionCallError("niDCPower_GetExtCalLastDateAndTime", param='year') if year is not None: - year.contents.value = self._defaults['GetExtCalLastDateAndTime']['Year'] + year.contents.value = self._defaults['GetExtCalLastDateAndTime']['year'] # month - if self._defaults['GetExtCalLastDateAndTime']['Month'] is None: - raise MockFunctionCallError("niDCPower_GetExtCalLastDateAndTime", param='Month') + if self._defaults['GetExtCalLastDateAndTime']['month'] is None: + raise MockFunctionCallError("niDCPower_GetExtCalLastDateAndTime", param='month') if month is not None: - month.contents.value = self._defaults['GetExtCalLastDateAndTime']['Month'] + month.contents.value = self._defaults['GetExtCalLastDateAndTime']['month'] # day - if self._defaults['GetExtCalLastDateAndTime']['Day'] is None: - raise MockFunctionCallError("niDCPower_GetExtCalLastDateAndTime", param='Day') + if self._defaults['GetExtCalLastDateAndTime']['day'] is None: + raise MockFunctionCallError("niDCPower_GetExtCalLastDateAndTime", param='day') if day is not None: - day.contents.value = self._defaults['GetExtCalLastDateAndTime']['Day'] + day.contents.value = self._defaults['GetExtCalLastDateAndTime']['day'] # hour - if self._defaults['GetExtCalLastDateAndTime']['Hour'] is None: - raise MockFunctionCallError("niDCPower_GetExtCalLastDateAndTime", param='Hour') + if self._defaults['GetExtCalLastDateAndTime']['hour'] is None: + raise MockFunctionCallError("niDCPower_GetExtCalLastDateAndTime", param='hour') if hour is not None: - hour.contents.value = self._defaults['GetExtCalLastDateAndTime']['Hour'] + hour.contents.value = self._defaults['GetExtCalLastDateAndTime']['hour'] # minute - if self._defaults['GetExtCalLastDateAndTime']['Minute'] is None: - raise MockFunctionCallError("niDCPower_GetExtCalLastDateAndTime", param='Minute') + if self._defaults['GetExtCalLastDateAndTime']['minute'] is None: + raise MockFunctionCallError("niDCPower_GetExtCalLastDateAndTime", param='minute') if minute is not None: - minute.contents.value = self._defaults['GetExtCalLastDateAndTime']['Minute'] + minute.contents.value = self._defaults['GetExtCalLastDateAndTime']['minute'] return self._defaults['GetExtCalLastDateAndTime']['return'] def niDCPower_GetExtCalLastTemp(self, vi, temperature): # noqa: N802 if self._defaults['GetExtCalLastTemp']['return'] != 0: return self._defaults['GetExtCalLastTemp']['return'] # temperature - if self._defaults['GetExtCalLastTemp']['Temperature'] is None: - raise MockFunctionCallError("niDCPower_GetExtCalLastTemp", param='Temperature') + if self._defaults['GetExtCalLastTemp']['temperature'] is None: + raise MockFunctionCallError("niDCPower_GetExtCalLastTemp", param='temperature') if temperature is not None: - temperature.contents.value = self._defaults['GetExtCalLastTemp']['Temperature'] + temperature.contents.value = self._defaults['GetExtCalLastTemp']['temperature'] return self._defaults['GetExtCalLastTemp']['return'] def niDCPower_GetExtCalRecommendedInterval(self, vi, months): # noqa: N802 if self._defaults['GetExtCalRecommendedInterval']['return'] != 0: return self._defaults['GetExtCalRecommendedInterval']['return'] # months - if self._defaults['GetExtCalRecommendedInterval']['Months'] is None: - raise MockFunctionCallError("niDCPower_GetExtCalRecommendedInterval", param='Months') + if self._defaults['GetExtCalRecommendedInterval']['months'] is None: + raise MockFunctionCallError("niDCPower_GetExtCalRecommendedInterval", param='months') if months is not None: - months.contents.value = self._defaults['GetExtCalRecommendedInterval']['Months'] + months.contents.value = self._defaults['GetExtCalRecommendedInterval']['months'] return self._defaults['GetExtCalRecommendedInterval']['return'] def niDCPower_GetSelfCalLastDateAndTime(self, vi, year, month, day, hour, minute): # noqa: N802 if self._defaults['GetSelfCalLastDateAndTime']['return'] != 0: return self._defaults['GetSelfCalLastDateAndTime']['return'] # year - if self._defaults['GetSelfCalLastDateAndTime']['Year'] is None: - raise MockFunctionCallError("niDCPower_GetSelfCalLastDateAndTime", param='Year') + if self._defaults['GetSelfCalLastDateAndTime']['year'] is None: + raise MockFunctionCallError("niDCPower_GetSelfCalLastDateAndTime", param='year') if year is not None: - year.contents.value = self._defaults['GetSelfCalLastDateAndTime']['Year'] + year.contents.value = self._defaults['GetSelfCalLastDateAndTime']['year'] # month - if self._defaults['GetSelfCalLastDateAndTime']['Month'] is None: - raise MockFunctionCallError("niDCPower_GetSelfCalLastDateAndTime", param='Month') + if self._defaults['GetSelfCalLastDateAndTime']['month'] is None: + raise MockFunctionCallError("niDCPower_GetSelfCalLastDateAndTime", param='month') if month is not None: - month.contents.value = self._defaults['GetSelfCalLastDateAndTime']['Month'] + month.contents.value = self._defaults['GetSelfCalLastDateAndTime']['month'] # day - if self._defaults['GetSelfCalLastDateAndTime']['Day'] is None: - raise MockFunctionCallError("niDCPower_GetSelfCalLastDateAndTime", param='Day') + if self._defaults['GetSelfCalLastDateAndTime']['day'] is None: + raise MockFunctionCallError("niDCPower_GetSelfCalLastDateAndTime", param='day') if day is not None: - day.contents.value = self._defaults['GetSelfCalLastDateAndTime']['Day'] + day.contents.value = self._defaults['GetSelfCalLastDateAndTime']['day'] # hour - if self._defaults['GetSelfCalLastDateAndTime']['Hour'] is None: - raise MockFunctionCallError("niDCPower_GetSelfCalLastDateAndTime", param='Hour') + if self._defaults['GetSelfCalLastDateAndTime']['hour'] is None: + raise MockFunctionCallError("niDCPower_GetSelfCalLastDateAndTime", param='hour') if hour is not None: - hour.contents.value = self._defaults['GetSelfCalLastDateAndTime']['Hour'] + hour.contents.value = self._defaults['GetSelfCalLastDateAndTime']['hour'] # minute - if self._defaults['GetSelfCalLastDateAndTime']['Minute'] is None: - raise MockFunctionCallError("niDCPower_GetSelfCalLastDateAndTime", param='Minute') + if self._defaults['GetSelfCalLastDateAndTime']['minute'] is None: + raise MockFunctionCallError("niDCPower_GetSelfCalLastDateAndTime", param='minute') if minute is not None: - minute.contents.value = self._defaults['GetSelfCalLastDateAndTime']['Minute'] + minute.contents.value = self._defaults['GetSelfCalLastDateAndTime']['minute'] return self._defaults['GetSelfCalLastDateAndTime']['return'] def niDCPower_GetSelfCalLastTemp(self, vi, temperature): # noqa: N802 if self._defaults['GetSelfCalLastTemp']['return'] != 0: return self._defaults['GetSelfCalLastTemp']['return'] # temperature - if self._defaults['GetSelfCalLastTemp']['Temperature'] is None: - raise MockFunctionCallError("niDCPower_GetSelfCalLastTemp", param='Temperature') + if self._defaults['GetSelfCalLastTemp']['temperature'] is None: + raise MockFunctionCallError("niDCPower_GetSelfCalLastTemp", param='temperature') if temperature is not None: - temperature.contents.value = self._defaults['GetSelfCalLastTemp']['Temperature'] + temperature.contents.value = self._defaults['GetSelfCalLastTemp']['temperature'] return self._defaults['GetSelfCalLastTemp']['return'] def niDCPower_ImportAttributeConfigurationBuffer(self, vi, size, configuration): # noqa: N802 @@ -476,10 +476,10 @@ def niDCPower_Measure(self, vi, channel_name, measurement_type, measurement): # if self._defaults['Measure']['return'] != 0: return self._defaults['Measure']['return'] # measurement - if self._defaults['Measure']['Measurement'] is None: - raise MockFunctionCallError("niDCPower_Measure", param='Measurement') + if self._defaults['Measure']['measurement'] is None: + raise MockFunctionCallError("niDCPower_Measure", param='measurement') if measurement is not None: - measurement.contents.value = self._defaults['Measure']['Measurement'] + measurement.contents.value = self._defaults['Measure']['measurement'] return self._defaults['Measure']['return'] def niDCPower_MeasureMultiple(self, vi, channel_name, voltage_measurements, current_measurements): # noqa: N802 @@ -573,10 +573,10 @@ def niDCPower_ReadCurrentTemperature(self, vi, temperature): # noqa: N802 if self._defaults['ReadCurrentTemperature']['return'] != 0: return self._defaults['ReadCurrentTemperature']['return'] # temperature - if self._defaults['ReadCurrentTemperature']['Temperature'] is None: - raise MockFunctionCallError("niDCPower_ReadCurrentTemperature", param='Temperature') + if self._defaults['ReadCurrentTemperature']['temperature'] is None: + raise MockFunctionCallError("niDCPower_ReadCurrentTemperature", param='temperature') if temperature is not None: - temperature.contents.value = self._defaults['ReadCurrentTemperature']['Temperature'] + temperature.contents.value = self._defaults['ReadCurrentTemperature']['temperature'] return self._defaults['ReadCurrentTemperature']['return'] def niDCPower_ResetDevice(self, vi): # noqa: N802 diff --git a/src/nidcpower/metadata/__init__.py b/src/nidcpower/metadata/__init__.py index d7db8ce3e..39afad340 100644 --- a/src/nidcpower/metadata/__init__.py +++ b/src/nidcpower/metadata/__init__.py @@ -5,6 +5,7 @@ import metadata.functions_addon import metadata.attributes_addon import metadata.enums_addon +import metadata.config_addon import build.helper as helper import sys diff --git a/src/nidcpower/metadata/attributes.py b/src/nidcpower/metadata/attributes.py index c8a86103b..a8cd03881 100644 --- a/src/nidcpower/metadata/attributes.py +++ b/src/nidcpower/metadata/attributes.py @@ -1,2612 +1,1728 @@ - # -*- coding: utf-8 -*- -# This file is code generated, do not make changes here. -# If the generated information is not correct for python -# changes can be made in attributes_addon.py and they will be -# applied at build time. - +# This file is generated from API metadata for NI-DCPower version 19.1.0d33 attributes = { 1050002: { 'access': 'read-write', - 'channel_based': 'False', - 'enum': 'tBoolean', + 'channel_based': False, + 'codegen_method': 'no', + 'documentation': { + 'description': '\nSpecifies whether to validate attribute values and function parameters.\nIf this attribute is enabled, NI-DCPower validates the parameter values that you pass to NI-DCPower functions. Range checking parameters is useful for debugging. After you validate your program, you can set this attribute to VI_FALSE to disable range checking and maximize performance.\nUse the niDCPower_InitializeWithChannels function to override this value.\nDefault Value: VI_TRUE\n' + }, 'lv_property': 'Inherent IVI Attributes:User Options:Range Check', 'name': 'RANGE_CHECK', - 'resettable': 'No', - 'type': 'ViBoolean', -'documentation': { -'description': ''' -Specifies whether to validate attribute values and function parameters. -If this attribute is enabled, NI-DCPower validates the parameter values that you pass to NI-DCPower functions. Range checking parameters is useful for debugging. After you validate your program, you can set this attribute to VI_FALSE to disable range checking and maximize performance. -Use the niDCPower_InitializeWithChannels function to override this value. -Default Value: VI_TRUE -''', -}, + 'resettable': False, + 'type': 'ViBoolean' }, 1050003: { 'access': 'read-write', - 'channel_based': 'False', - 'enum': 'tBoolean', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies whether NI-DCPower queries the device status after each operation.\nQuerying the device status is useful for debugging. After you validate your program, you can set this attribute to VI_FALSE to disable status checking and maximize performance.\nNI-DCPower ignores status checking for particular attributes regardless of the setting of this attribute.\nUse the niDCPower_InitializeWithChannels function to override this value.\nDefault Value: VI_TRUE\n' + }, 'lv_property': 'Inherent IVI Attributes:User Options:Query Instrument Status', 'name': 'QUERY_INSTRUMENT_STATUS', - 'resettable': 'No', - 'type': 'ViBoolean', -'documentation': { -'description': ''' -Specifies whether NI-DCPower queries the device status after each operation. -Querying the device status is useful for debugging. After you validate your program, you can set this attribute to VI_FALSE to disable status checking and maximize performance. -NI-DCPower ignores status checking for particular attributes regardless of the setting of this attribute. -Use the niDCPower_InitializeWithChannels function to override this value. -Default Value: VI_TRUE -''', -}, + 'resettable': False, + 'type': 'ViBoolean' }, 1050004: { 'access': 'read-write', - 'channel_based': 'False', - 'enum': 'tBoolean', + 'channel_based': False, + 'codegen_method': 'no', + 'documentation': { + 'description': '\nSpecifies whether to cache the value of attributes.\nWhen caching is enabled, NI-DCPower records the current power supply settings and avoids sending redundant commands to the device. Enabling caching can significantly increase execution speed.\nNI-DCPower might always cache or never cache particular attributes regardless of the setting of this attribute.\nUse the niDCPower_InitializeWithChannels function to override this value.\nDefault Value: VI_TRUE\n' + }, 'lv_property': 'Inherent IVI Attributes:User Options:Cache', 'name': 'CACHE', - 'resettable': 'No', - 'type': 'ViBoolean', -'documentation': { -'description': ''' -Specifies whether to cache the value of attributes. -When caching is enabled, NI-DCPower records the current power supply settings and avoids sending redundant commands to the device. Enabling caching can significantly increase execution speed. -NI-DCPower might always cache or never cache particular attributes regardless of the setting of this attribute. -Use the niDCPower_InitializeWithChannels function to override this value. -Default Value: VI_TRUE -''', -}, + 'resettable': False, + 'type': 'ViBoolean' }, 1050005: { 'access': 'read-write', - 'channel_based': 'False', - 'enum': 'tBoolean', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies whether to simulate NI-DCPower I/O operations. VI_TRUE specifies that operation is simulated.\nDefault Value: VI_FALSE\n' + }, 'lv_property': 'Inherent IVI Attributes:User Options:Simulate', 'name': 'SIMULATE', - 'resettable': 'No', - 'type': 'ViBoolean', -'documentation': { -'description': ''' -Specifies whether to simulate NI-DCPower I/O operations. VI_TRUE specifies that operation is simulated. -Default Value: VI_FALSE -''', -}, + 'resettable': False, + 'type': 'ViBoolean' }, 1050006: { 'access': 'read-write', - 'channel_based': 'False', - 'enum': 'tBoolean', + 'channel_based': False, + 'codegen_method': 'no', + 'documentation': { + 'description': '\nSpecifies whether the IVI engine records the value coercions it makes for ViInt32 and ViReal64 attributes. Call the niDCPower_GetNextCoercionRecord function to read and delete the earliest coercion record from the list.\nDefault Value: The default value is VI_FALSE. Use the niDCPower_InitializeWithChannels function to override this value.\n' + }, 'lv_property': 'Inherent IVI Attributes:User Options:Record Value Coercions', 'name': 'RECORD_COERCIONS', - 'resettable': 'No', - 'type': 'ViBoolean', -'documentation': { -'description': ''' -Specifies whether the IVI engine records the value coercions it makes for ViInt32 and ViReal64 attributes. Call the niDCPower_GetNextCoercionRecord function to read and delete the earliest coercion record from the list. -Default Value: The default value is VI_FALSE. Use the niDCPower_InitializeWithChannels function to override this value. -''', -}, + 'resettable': False, + 'type': 'ViBoolean' }, 1050007: { 'access': 'read only', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nIndicates the Driver Setup string that you specified when initializing the driver.\nSome cases exist where you must specify the instrument driver options at initialization time. An example of this case is specifying a particular device model from among a family of devices that the driver supports. This attribute is useful when simulating a device. You can specify the driver-specific options through the DriverSetup keyword in the optionsString parameter in the niDCPower_InitializeWithChannels function or through the IVI Configuration Utility.\nYou can specify driver-specific options through the DriverSetup keyword in the optionsString parameter in the niDCPower_InitializeWithChannels function. If you do not specify a Driver Setup string, this attribute returns an empty string.\n' + }, 'lv_property': 'Inherent IVI Attributes:Advanced Session Information:Driver Setup', 'name': 'DRIVER_SETUP', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': ''' -Indicates the Driver Setup string that you specified when initializing the driver. -Some cases exist where you must specify the instrument driver options at initialization time. An example of this case is specifying a particular device model from among a family of devices that the driver supports. This attribute is useful when simulating a device. You can specify the driver-specific options through the DriverSetup keyword in the optionsString parameter in the niDCPower_InitializeWithChannels function or through the IVI Configuration Utility. -You can specify driver-specific options through the DriverSetup keyword in the optionsString parameter in the niDCPower_InitializeWithChannels function. If you do not specify a Driver Setup string, this attribute returns an empty string. -''', -}, + 'resettable': False, + 'type': 'ViString' }, 1050021: { 'access': 'read-write', - 'channel_based': 'False', - 'enum': 'tBoolean', + 'channel_based': False, + 'codegen_method': 'no', + 'documentation': { + 'description': '\nSpecifies whether to perform interchangeability checking and log interchangeability warnings when you call NI-DCPower functions. VI_TRUE specifies that interchangeability checking is enabled.\nInterchangeability warnings indicate that using your application with a different power supply might cause different behavior. Call the niDCPower_GetNextInterchangeWarning function to retrieve interchange warnings.\nCall the niDCPower_GetNextInterchangeWarning function to clear the list of interchangeability warnings without reading them.\nInterchangeability checking examines the attributes in a capability group only if you specify a value for at least one attribute within that group. Interchangeability warnings can occur when an attribute affects the behavior of the device and you have not set that attribute or when the attribute has been invalidated since you set it.\nDefault Value: VI_FALSE\n' + }, 'lv_property': 'Inherent IVI Attributes:User Options:Interchange Check', 'name': 'INTERCHANGE_CHECK', - 'resettable': 'No', - 'type': 'ViBoolean', -'documentation': { -'description': ''' -Specifies whether to perform interchangeability checking and log interchangeability warnings when you call NI-DCPower functions. VI_TRUE specifies that interchangeability checking is enabled. -Interchangeability warnings indicate that using your application with a different power supply might cause different behavior. Call the niDCPower_GetNextInterchangeWarning function to retrieve interchange warnings. -Call the niDCPower_GetNextInterchangeWarning function to clear the list of interchangeability warnings without reading them. -Interchangeability checking examines the attributes in a capability group only if you specify a value for at least one attribute within that group. Interchangeability warnings can occur when an attribute affects the behavior of the device and you have not set that attribute or when the attribute has been invalidated since you set it. -Default Value: VI_FALSE -''', -}, + 'resettable': False, + 'type': 'ViBoolean' }, 1050203: { 'access': 'read only', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': 'Indicates the number of channels that NI-DCPower supports for the instrument that was chosen when the current session was opened. For channel-based attributes, the IVI engine maintains a separate cache value for each channel.' + }, 'lv_property': 'Inherent IVI Attributes:Driver Capabilities:Channel Count', 'name': 'CHANNEL_COUNT', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': 'Indicates the number of channels that NI-DCPower supports for the instrument that was chosen when the current session was opened. For channel-based attributes, the IVI engine maintains a separate cache value for each channel.', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1050302: { 'access': 'read only', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': 'Contains the prefix for NI-DCPower. The name of each user-callable function in NI-DCPower begins with this prefix.' + }, 'lv_property': 'Inherent IVI Attributes:Driver Identification:Driver Prefix', 'name': 'SPECIFIC_DRIVER_PREFIX', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': 'Contains the prefix for NI-DCPower. The name of each user-callable function in NI-DCPower begins with this prefix.', -}, + 'resettable': False, + 'type': 'ViString' }, 1050304: { 'access': 'read only', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nIndicates the resource descriptor NI-DCPower uses to identify the physical device.\nIf you initialize NI-DCPower with a logical name, this attribute contains the resource descriptor that corresponds to the entry in the IVI Configuration utility.\nIf you initialize NI-DCPower with the resource descriptor, this attribute contains that value.\n' + }, 'lv_property': 'Inherent IVI Attributes:Advanced Session Information:Resource Descriptor', 'name': 'IO_RESOURCE_DESCRIPTOR', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': ''' -Indicates the resource descriptor NI-DCPower uses to identify the physical device. -If you initialize NI-DCPower with a logical name, this attribute contains the resource descriptor that corresponds to the entry in the IVI Configuration utility. -If you initialize NI-DCPower with the resource descriptor, this attribute contains that value. -''', -}, + 'resettable': False, + 'type': 'ViString' }, 1050305: { 'access': 'read only', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nContains the logical name you specified when opening the current IVI session.\nYou can pass a logical name to the niDCPower_InitializeWithChannels function. The IVI Configuration utility must contain an entry for the logical name. The logical name entry refers to a function section in the IVI Configuration file. The function section specifies a physical device and initial user options.\n' + }, 'lv_property': 'Inherent IVI Attributes:Advanced Session Information:Logical Name', 'name': 'LOGICAL_NAME', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': ''' -Contains the logical name you specified when opening the current IVI session. -You can pass a logical name to the niDCPower_InitializeWithChannels function. The IVI Configuration utility must contain an entry for the logical name. The logical name entry refers to a function section in the IVI Configuration file. The function section specifies a physical device and initial user options. -''', -}, + 'resettable': False, + 'type': 'ViString' }, 1050327: { 'access': 'read only', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': 'Contains a comma-separated (,) list of supported NI-DCPower device models.' + }, 'lv_property': 'Inherent IVI Attributes:Driver Capabilities:Supported Instrument Models', 'name': 'SUPPORTED_INSTRUMENT_MODELS', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': 'Contains a comma-separated (,) list of supported NI-DCPower device models.', -}, + 'resettable': False, + 'type': 'ViString' }, 1050401: { 'access': 'read only', - 'channel_based': 'False', + 'channel_based': False, + 'codegen_method': 'no', + 'documentation': { + 'description': 'Contains a comma-separated list of class-extension groups that NI-DCPower implements.' + }, 'lv_property': 'Inherent IVI Attributes:Driver Capabilities:Class Group Capabilities', 'name': 'GROUP_CAPABILITIES', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': 'Contains a comma-separated list of class-extension groups that NI-DCPower implements.', -}, + 'resettable': False, + 'type': 'ViString' }, 1050510: { 'access': 'read only', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': 'Contains the firmware revision information for the device you are currently using.' + }, 'lv_property': 'Inherent IVI Attributes:Instrument Identification:Firmware Revision', 'name': 'INSTRUMENT_FIRMWARE_REVISION', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': 'Contains the firmware revision information for the device you are currently using.', -}, + 'resettable': False, + 'type': 'ViString' }, 1050511: { 'access': 'read only', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': 'Contains the name of the manufacturer for the device you are currently using.' + }, 'lv_property': 'Inherent IVI Attributes:Instrument Identification:Manufacturer', 'name': 'INSTRUMENT_MANUFACTURER', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': 'Contains the name of the manufacturer for the device you are currently using.', -}, + 'resettable': False, + 'type': 'ViString' }, 1050512: { 'access': 'read only', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': 'Contains the model number or name of the device that you are currently using.' + }, 'lv_property': 'Inherent IVI Attributes:Instrument Identification:Model', 'name': 'INSTRUMENT_MODEL', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': 'Contains the model number or name of the device that you are currently using.', -}, + 'resettable': False, + 'type': 'ViString' }, 1050513: { 'access': 'read only', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': 'Contains the name of the vendor that supplies NI-DCPower.' + }, 'lv_property': 'Inherent IVI Attributes:Driver Identification:Driver Vendor', 'name': 'SPECIFIC_DRIVER_VENDOR', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': 'Contains the name of the vendor that supplies NI-DCPower.', -}, + 'resettable': False, + 'type': 'ViString' }, 1050514: { 'access': 'read only', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': 'Contains a brief description of the specific driver.' + }, 'lv_property': 'Inherent IVI Attributes:Driver Identification:Description', 'name': 'SPECIFIC_DRIVER_DESCRIPTION', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': 'Contains a brief description of the specific driver.', -}, + 'resettable': False, + 'type': 'ViString' }, 1050515: { 'access': 'read only', - 'channel_based': 'False', + 'channel_based': False, + 'codegen_method': 'no', + 'documentation': { + 'description': 'Contains the major version number of the class specification with which NI-DCPower is compliant.' + }, 'lv_property': 'Inherent IVI Attributes:Driver Identification:Class Specification Major Version', 'name': 'SPECIFIC_DRIVER_CLASS_SPEC_MAJOR_VERSION', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': 'Contains the major version number of the class specification with which NI-DCPower is compliant.', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1050516: { 'access': 'read only', - 'channel_based': 'False', + 'channel_based': False, + 'codegen_method': 'no', + 'documentation': { + 'description': 'Contains the minor version number of the class specification with which NI-DCPower is compliant.' + }, 'lv_property': 'Inherent IVI Attributes:Driver Identification:Class Specification Minor Version', 'name': 'SPECIFIC_DRIVER_CLASS_SPEC_MINOR_VERSION', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': 'Contains the minor version number of the class specification with which NI-DCPower is compliant.', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1050551: { 'access': 'read only', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': 'Contains additional version information about NI-DCPower.' + }, 'lv_property': 'Inherent IVI Attributes:Driver Identification:Revision', 'name': 'SPECIFIC_DRIVER_REVISION', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': 'Contains additional version information about NI-DCPower.', -}, + 'resettable': False, + 'type': 'ViString' }, 1150000: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the power source to use. NI-DCPower switches the power source used by the device to the specified value.\nDefault Value: NIDCPOWER_VAL_AUTOMATIC\nis set to NIDCPOWER_VAL_AUTOMATIC. However, if the session is in the Committed or Uncommitted state when you set this attribute, the power source selection only occurs after you call the niDCPower_Initiate function.\n', + 'note': 'Automatic selection is not persistent and occurs only at the time this attribute' + }, 'enum': 'PowerSource', 'lv_property': 'Advanced:Power Source', 'name': 'POWER_SOURCE', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the power source to use. NI-DCPower switches the power source used by the device to the specified value. -Default Value: NIDCPOWER_VAL_AUTOMATIC -is set to NIDCPOWER_VAL_AUTOMATIC. However, if the session is in the Committed or Uncommitted state when you set this attribute, the power source selection only occurs after you call the niDCPower_Initiate function. -''', -'note': 'Automatic selection is not persistent and occurs only at the time this attribute', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150001: { 'access': 'read only', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': 'Indicates whether the device is using the internal or auxiliary power source to generate power.' + }, 'enum': 'PowerSourceInUse', 'lv_property': 'Advanced:Power Source In Use', 'name': 'POWER_SOURCE_IN_USE', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': 'Indicates whether the device is using the internal or auxiliary power source to generate power.', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150002: { 'access': 'read only', - 'channel_based': 'False', - 'enum': 'tBoolean', + 'channel_based': False, + 'documentation': { + 'description': '\nIndicates whether an auxiliary power source is connected to the device.\nA value of VI_FALSE may indicate that the auxiliary input fuse has blown. Refer to the Detecting Internal/Auxiliary Power topic in the NI DC Power Supplies and SMUs Help for more information about internal and auxiliary power.\npower source to generate power. Use the NIDCPOWER_ATTR_POWER_SOURCE_IN_USE attribute to retrieve this information.\n', + 'note': 'This attribute does not necessarily indicate if the device is using the auxiliary' + }, 'lv_property': 'Advanced:Auxiliary Power Source Available', 'name': 'AUXILIARY_POWER_SOURCE_AVAILABLE', - 'resettable': 'No', - 'type': 'ViBoolean', -'documentation': { -'description': ''' -Indicates whether an auxiliary power source is connected to the device. -A value of VI_FALSE may indicate that the auxiliary input fuse has blown. Refer to the Detecting Internal/Auxiliary Power topic in the NI DC Power Supplies and SMUs Help for more information about internal and auxiliary power. -power source to generate power. Use the NIDCPOWER_ATTR_POWER_SOURCE_IN_USE attribute to retrieve this information. -''', -'note': 'This attribute does not necessarily indicate if the device is using the auxiliary', -}, + 'resettable': False, + 'type': 'ViBoolean' }, 1150003: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the number of samples to average when you take a measurement.\nIncreasing the number of samples to average decreases measurement noise but increases the time required to take a measurement. Refer to the NI PXI-4110, NI PXI-4130, NI PXI-4132, or NI PXIe-4154 Averaging topic for optional attribute settings to improve immunity to certain noise types, or refer to the NI PXIe-4140/4141 DC Noise Rejection, NI PXIe-4142/4143 DC Noise Rejection, or NI PXIe-4144/4145 DC Noise Rejection topic for information about improving noise immunity for those devices.\nDefault Value:\nNI PXI-4110 or NI PXI-4130—10\nNI PXI-4132—1\nNI PXIe-4112—1\nNI PXIe-4113—1\nNI PXIe-4140/4141—1\nNI PXIe-4142/4143—1\nNI PXIe-4144/4145—1\nNI PXIe-4154—500\n' + }, 'lv_property': 'Measurement:Samples To Average', 'name': 'SAMPLES_TO_AVERAGE', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the number of samples to average when you take a measurement. -Increasing the number of samples to average decreases measurement noise but increases the time required to take a measurement. Refer to the NI PXI-4110, NI PXI-4130, NI PXI-4132, or NI PXIe-4154 Averaging topic for optional attribute settings to improve immunity to certain noise types, or refer to the NI PXIe-4140/4141 DC Noise Rejection, NI PXIe-4142/4143 DC Noise Rejection, or NI PXIe-4144/4145 DC Noise Rejection topic for information about improving noise immunity for those devices. -Default Value: -NI PXI-4110 or NI PXI-4130—10 -NI PXI-4132—1 -NI PXIe-4112—1 -NI PXIe-4113—1 -NI PXIe-4140/4141—1 -NI PXIe-4142/4143—1 -NI PXIe-4144/4145—1 -NI PXIe-4154—500 -''', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150004: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the current limit range, in amps, for the specified channel(s).\nThe range defines the valid value to which the current limit can be set. Use the NIDCPOWER_ATTR_CURRENT_LIMIT_AUTORANGE attribute to enable automatic selection of the current limit range.\nThe NIDCPOWER_ATTR_CURRENT_LIMIT_RANGE attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_VOLTAGE.\nNIDCPOWER_ATTR_OUTPUT_ENABLED attribute for more information about enabling the output channel.\nFor valid ranges, refer to the Ranges topic for your device in the NI DC Power Supplies and SMUs Help.\n', + 'note': 'The channel must be enabled for the specified current limit to take effect. Refer to the' + }, 'lv_property': 'Source:DC Voltage:Current Limit Range', 'name': 'CURRENT_LIMIT_RANGE', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the current limit range, in amps, for the specified channel(s). -The range defines the valid value to which the current limit can be set. Use the NIDCPOWER_ATTR_CURRENT_LIMIT_AUTORANGE attribute to enable automatic selection of the current limit range. -The NIDCPOWER_ATTR_CURRENT_LIMIT_RANGE attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_VOLTAGE. -NIDCPOWER_ATTR_OUTPUT_ENABLED attribute for more information about enabling the output channel. -For valid ranges, refer to the Ranges topic for your device in the NI DC Power Supplies and SMUs Help. -''', -'note': 'The channel must be enabled for the specified current limit to take effect. Refer to the', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150005: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the voltage level range, in volts, for the specified channel(s).\nThe range defines the valid values to which the voltage level can be set. Use the NIDCPOWER_ATTR_VOLTAGE_LEVEL_AUTORANGE attribute to enable automatic selection of the voltage level range.\nThe NIDCPOWER_ATTR_VOLTAGE_LEVEL_RANGE attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_VOLTAGE.\nNIDCPOWER_ATTR_OUTPUT_ENABLED attribute for more information about enabling the output channel.\nFor valid ranges, refer to the Ranges topic for your device in the NI DC Power Supplies and SMUs Help.\n', + 'note': 'The channel must be enabled for the specified voltage level range to take effect. Refer to the' + }, 'lv_property': 'Source:DC Voltage:Voltage Level Range', 'name': 'VOLTAGE_LEVEL_RANGE', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the voltage level range, in volts, for the specified channel(s). -The range defines the valid values to which the voltage level can be set. Use the NIDCPOWER_ATTR_VOLTAGE_LEVEL_AUTORANGE attribute to enable automatic selection of the voltage level range. -The NIDCPOWER_ATTR_VOLTAGE_LEVEL_RANGE attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_VOLTAGE. -NIDCPOWER_ATTR_OUTPUT_ENABLED attribute for more information about enabling the output channel. -For valid ranges, refer to the Ranges topic for your device in the NI DC Power Supplies and SMUs Help. -''', -'note': 'The channel must be enabled for the specified voltage level range to take effect. Refer to the', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150006: { 'access': 'read-write', - 'channel_based': 'True', - 'enum': 'tBoolean', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies whether the measurement returned from any measurement call starts with a new measurement call (VI_TRUE) or returns a measurement that has already begun or completed(VI_FALSE).\nfor information about supported devices.\nWhen you set the NIDCPOWER_ATTR_SAMPLES_TO_AVERAGE attribute in the Running state, the output channel measurements might move out of synchronization. While NI-DCPower automatically synchronizes measurements upon the initialization of a session, you can force a synchronization in the running state before you run the niDCPower_MeasureMultiple function. To force a synchronization in the running state, set this attribute to VI_TRUE, and then run the niDCPower_MeasureMultiple function, specifying all channels in the channel name parameter. You can set the NIDCPOWER_ATTR_RESET_AVERAGE_BEFORE_MEASUREMENT attribute to VI_FALSE after the niDCPower_MeasureMultiple function completes.\nDefault Value: VI_TRUE\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'lv_property': 'Measurement:Advanced:Reset Average Before Measurement', 'name': 'RESET_AVERAGE_BEFORE_MEASUREMENT', - 'resettable': 'No', - 'type': 'ViBoolean', -'documentation': { -'description': ''' -Specifies whether the measurement returned from any measurement call starts with a new measurement call (VI_TRUE) or returns a measurement that has already begun or completed(VI_FALSE). -for information about supported devices. -When you set the NIDCPOWER_ATTR_SAMPLES_TO_AVERAGE attribute in the Running state, the output channel measurements might move out of synchronization. While NI-DCPower automatically synchronizes measurements upon the initialization of a session, you can force a synchronization in the running state before you run the niDCPower_MeasureMultiple function. To force a synchronization in the running state, set this attribute to VI_TRUE, and then run the niDCPower_MeasureMultiple function, specifying all channels in the channel name parameter. You can set the NIDCPOWER_ATTR_RESET_AVERAGE_BEFORE_MEASUREMENT attribute to VI_FALSE after the niDCPower_MeasureMultiple function completes. -Default Value: VI_TRUE -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViBoolean' }, 1150007: { 'access': 'read-write', - 'channel_based': 'False', - 'enum': 'tBoolean', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies whether NI-DCPower allows setting the voltage level, current level, voltage limit and current limit outside the device specification limits. VI_TRUE means that overranging is enabled.\nRefer to the Ranges topic in the NI DC Power Supplies and SMUs Help for more information about overranging.\nDefault Value: VI_FALSE\n' + }, 'lv_property': 'Source:Advanced:Overranging Enabled', 'name': 'OVERRANGING_ENABLED', - 'resettable': 'No', - 'type': 'ViBoolean', -'documentation': { -'description': ''' -Specifies whether NI-DCPower allows setting the voltage level, current level, voltage limit and current limit outside the device specification limits. VI_TRUE means that overranging is enabled. -Refer to the Ranges topic in the NI DC Power Supplies and SMUs Help for more information about overranging. -Default Value: VI_FALSE -''', -}, + 'resettable': False, + 'type': 'ViBoolean' }, 1150008: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nConfigures the function to generate on the specified channel(s).\nWhen NIDCPOWER_VAL_DC_VOLTAGE is selected, the device generates the desired voltage level on the output as long as the output current is below the current limit. You can use the following attributes to configure the channel when NIDCPOWER_VAL_DC_VOLTAGE is selected:\nNIDCPOWER_ATTR_VOLTAGE_LEVEL\nNIDCPOWER_ATTR_CURRENT_LIMIT\nNIDCPOWER_ATTR_CURRENT_LIMIT_HIGH\nNIDCPOWER_ATTR_CURRENT_LIMIT_LOW\nNIDCPOWER_ATTR_VOLTAGE_LEVEL_RANGE\nNIDCPOWER_ATTR_CURRENT_LIMIT_RANGE\nNIDCPOWER_ATTR_COMPLIANCE_LIMIT_SYMMETRY\nWhen NIDCPOWER_VAL_DC_CURRENT is selected, the device generates the desired current level on the output as long as the output voltage is below the voltage limit. You can use the following attributes to configure the channel when NIDCPOWER_VAL_DC_CURRENT is selected:\nNIDCPOWER_ATTR_CURRENT_LEVEL\nNIDCPOWER_ATTR_VOLTAGE_LIMIT\nNIDCPOWER_ATTR_VOLTAGE_LIMIT_HIGH\nNIDCPOWER_ATTR_VOLTAGE_LIMIT_LOW\nNIDCPOWER_ATTR_CURRENT_LEVEL_RANGE\nNIDCPOWER_ATTR_VOLTAGE_LIMIT_RANGE\nNIDCPOWER_ATTR_COMPLIANCE_LIMIT_SYMMETRY\n' + }, 'enum': 'OutputFunction', 'lv_property': 'Source:Output Function', 'name': 'OUTPUT_FUNCTION', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Configures the function to generate on the specified channel(s). -When NIDCPOWER_VAL_DC_VOLTAGE is selected, the device generates the desired voltage level on the output as long as the output current is below the current limit. You can use the following attributes to configure the channel when NIDCPOWER_VAL_DC_VOLTAGE is selected: -NIDCPOWER_ATTR_VOLTAGE_LEVEL -NIDCPOWER_ATTR_CURRENT_LIMIT -NIDCPOWER_ATTR_CURRENT_LIMIT_HIGH -NIDCPOWER_ATTR_CURRENT_LIMIT_LOW -NIDCPOWER_ATTR_VOLTAGE_LEVEL_RANGE -NIDCPOWER_ATTR_CURRENT_LIMIT_RANGE -NIDCPOWER_ATTR_COMPLIANCE_LIMIT_SYMMETRY -When NIDCPOWER_VAL_DC_CURRENT is selected, the device generates the desired current level on the output as long as the output voltage is below the voltage limit. You can use the following attributes to configure the channel when NIDCPOWER_VAL_DC_CURRENT is selected: -NIDCPOWER_ATTR_CURRENT_LEVEL -NIDCPOWER_ATTR_VOLTAGE_LIMIT -NIDCPOWER_ATTR_VOLTAGE_LIMIT_HIGH -NIDCPOWER_ATTR_VOLTAGE_LIMIT_LOW -NIDCPOWER_ATTR_CURRENT_LEVEL_RANGE -NIDCPOWER_ATTR_VOLTAGE_LIMIT_RANGE -NIDCPOWER_ATTR_COMPLIANCE_LIMIT_SYMMETRY -''', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150009: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the current level, in amps, that the device attempts to generate on the specified channel(s).\nThis attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_CURRENT.\nNIDCPOWER_ATTR_OUTPUT_ENABLED attribute for more information about enabling the output channel.\nValid Values: The valid values for this attribute are defined by the values to which the NIDCPOWER_ATTR_CURRENT_LEVEL_RANGE attribute is set.\n', + 'note': 'The channel must be enabled for the specified current level to take effect. Refer to the' + }, 'lv_property': 'Source:DC Current:Current Level', 'name': 'CURRENT_LEVEL', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the current level, in amps, that the device attempts to generate on the specified channel(s). -This attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_CURRENT. -NIDCPOWER_ATTR_OUTPUT_ENABLED attribute for more information about enabling the output channel. -Valid Values: The valid values for this attribute are defined by the values to which the NIDCPOWER_ATTR_CURRENT_LEVEL_RANGE attribute is set. -''', -'note': 'The channel must be enabled for the specified current level to take effect. Refer to the', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150010: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the voltage limit, in volts, that the output cannot exceed when generating the desired current level on the specified channels.\nThis attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_CURRENT and the NIDCPOWER_ATTR_COMPLIANCE_LIMIT_SYMMETRY attribute is set to NIDCPOWER_VAL_SYMMETRIC.\nNIDCPOWER_ATTR_OUTPUT_ENABLED attribute for more information about enabling the output channel.\nValid Values: The valid values for this attribute are defined by the values to which the NIDCPOWER_ATTR_VOLTAGE_LIMIT_RANGE attribute is set.\n', + 'note': 'The channel must be enabled for the specified current level to take effect. Refer to the' + }, 'lv_property': 'Source:DC Current:Voltage Limit', 'name': 'VOLTAGE_LIMIT', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the voltage limit, in volts, that the output cannot exceed when generating the desired current level on the specified channels. -This attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_CURRENT and the NIDCPOWER_ATTR_COMPLIANCE_LIMIT_SYMMETRY attribute is set to NIDCPOWER_VAL_SYMMETRIC. -NIDCPOWER_ATTR_OUTPUT_ENABLED attribute for more information about enabling the output channel. -Valid Values: The valid values for this attribute are defined by the values to which the NIDCPOWER_ATTR_VOLTAGE_LIMIT_RANGE attribute is set. -''', -'note': 'The channel must be enabled for the specified current level to take effect. Refer to the', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150011: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the current level range, in amps, for the specified channel(s).\nThe range defines the valid value to which the current level can be set. Use the NIDCPOWER_ATTR_CURRENT_LEVEL_AUTORANGE attribute to enable automatic selection of the current level range.\nThe NIDCPOWER_ATTR_CURRENT_LEVEL_RANGE attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_CURRENT.\nNIDCPOWER_ATTR_OUTPUT_ENABLED attribute for more information about enabling the output channel.\nFor valid ranges, refer to the Ranges topic for your device in the NI DC Power Supplies and SMUs Help.\n', + 'note': 'The channel must be enabled for the specified current level range to take effect. Refer to the' + }, 'lv_property': 'Source:DC Current:Current Level Range', 'name': 'CURRENT_LEVEL_RANGE', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the current level range, in amps, for the specified channel(s). -The range defines the valid value to which the current level can be set. Use the NIDCPOWER_ATTR_CURRENT_LEVEL_AUTORANGE attribute to enable automatic selection of the current level range. -The NIDCPOWER_ATTR_CURRENT_LEVEL_RANGE attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_CURRENT. -NIDCPOWER_ATTR_OUTPUT_ENABLED attribute for more information about enabling the output channel. -For valid ranges, refer to the Ranges topic for your device in the NI DC Power Supplies and SMUs Help. -''', -'note': 'The channel must be enabled for the specified current level range to take effect. Refer to the', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150012: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the voltage limit range, in volts, for the specified channel(s).\nThe range defines the valid values to which the voltage limit can be set. Use the NIDCPOWER_ATTR_VOLTAGE_LIMIT_AUTORANGE attribute to enable automatic selection of the voltage limit range.\nThe NIDCPOWER_ATTR_VOLTAGE_LIMIT_RANGE attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_CURRENT.\nNIDCPOWER_ATTR_OUTPUT_ENABLED attribute for more information about enabling the output channel.\nFor valid ranges, refer to the Ranges topic for your device in the NI DC Power Supplies and SMUs Help.\n', + 'note': 'The channel must be enabled for the specified voltage limit range to take effect. Refer to the' + }, 'lv_property': 'Source:DC Current:Voltage Limit Range', 'name': 'VOLTAGE_LIMIT_RANGE', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the voltage limit range, in volts, for the specified channel(s). -The range defines the valid values to which the voltage limit can be set. Use the NIDCPOWER_ATTR_VOLTAGE_LIMIT_AUTORANGE attribute to enable automatic selection of the voltage limit range. -The NIDCPOWER_ATTR_VOLTAGE_LIMIT_RANGE attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_CURRENT. -NIDCPOWER_ATTR_OUTPUT_ENABLED attribute for more information about enabling the output channel. -For valid ranges, refer to the Ranges topic for your device in the NI DC Power Supplies and SMUs Help. -''', -'note': 'The channel must be enabled for the specified voltage limit range to take effect. Refer to the', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150013: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSelects either local or remote sensing of the output voltage for the specified channel(s).\nRefer to the Local and Remote Sense topic in the NI DC Power Supplies and SMUs Help for more information about sensing voltage on supported channels and about devices that support local and/or remote sensing.\nDefault Value: The default value is NIDCPOWER_VAL_LOCAL if the device supports local sense. Otherwise, the default and only supported value is NIDCPOWER_VAL_REMOTE.\n' + }, 'enum': 'Sense', 'lv_property': 'Measurement:Sense', 'name': 'SENSE', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Selects either local or remote sensing of the output voltage for the specified channel(s). -Refer to the Local and Remote Sense topic in the NI DC Power Supplies and SMUs Help for more information about sensing voltage on supported channels and about devices that support local and/or remote sensing. -Default Value: The default value is NIDCPOWER_VAL_LOCAL if the device supports local sense. Otherwise, the default and only supported value is NIDCPOWER_VAL_REMOTE. -''', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150014: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies whether to use a low or high capacitance on the output for the specified channel(s).\nfor information about supported devices.\nRefer to the NI PXI-4130 Output Capacitance Selection topic in the NI DC Power Supplies and SMUs Help for more information about capacitance.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'enum': 'OutputCapacitance', 'lv_property': 'Source:Advanced:Output Capacitance', 'name': 'OUTPUT_CAPACITANCE', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies whether to use a low or high capacitance on the output for the specified channel(s). -for information about supported devices. -Refer to the NI PXI-4130 Output Capacitance Selection topic in the NI DC Power Supplies and SMUs Help for more information about capacitance. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150015: { 'access': 'read-write', - 'channel_based': 'True', - 'enum': 'VoltageLevelAutorange', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies whether NI-DCPower automatically selects the voltage level range based on the desired voltage level for the specified channel(s).\nIf you set this attribute to NIDCPOWER_VAL_ON, NI-DCPower ignores any changes you make to the NIDCPOWER_ATTR_VOLTAGE_LEVEL_RANGE attribute. If you change the NIDCPOWER_ATTR_VOLTAGE_LEVEL_AUTORANGE attribute from NIDCPOWER_VAL_ON to NIDCPOWER_VAL_OFF, NI-DCPower retains the last value the NIDCPOWER_ATTR_VOLTAGE_LEVEL_RANGE attribute was set to (or the default value if the attribute was never set) and uses that value as the voltage level range.\nQuery the NIDCPOWER_ATTR_VOLTAGE_LEVEL_RANGE attribute by using the niDCPower_GetAttributeViInt32 function for information about which range NI-DCPower automatically selects.\nThe NIDCPOWER_ATTR_VOLTAGE_LEVEL_AUTORANGE attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_VOLTAGE.\nDefault Value: NIDCPOWER_VAL_OFF\n' + }, 'lv_property': 'Source:DC Voltage:Voltage Level Autorange', 'name': 'VOLTAGE_LEVEL_AUTORANGE', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies whether NI-DCPower automatically selects the voltage level range based on the desired voltage level for the specified channel(s). -If you set this attribute to NIDCPOWER_VAL_ON, NI-DCPower ignores any changes you make to the NIDCPOWER_ATTR_VOLTAGE_LEVEL_RANGE attribute. If you change the NIDCPOWER_ATTR_VOLTAGE_LEVEL_AUTORANGE attribute from NIDCPOWER_VAL_ON to NIDCPOWER_VAL_OFF, NI-DCPower retains the last value the NIDCPOWER_ATTR_VOLTAGE_LEVEL_RANGE attribute was set to (or the default value if the attribute was never set) and uses that value as the voltage level range. -Query the NIDCPOWER_ATTR_VOLTAGE_LEVEL_RANGE attribute by using the niDCPower_GetAttributeViInt32 function for information about which range NI-DCPower automatically selects. -The NIDCPOWER_ATTR_VOLTAGE_LEVEL_AUTORANGE attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_VOLTAGE. -Default Value: NIDCPOWER_VAL_OFF -''', -}, + 'python_type': 'bool', + 'resettable': False, + 'type': 'ViInt32' }, 1150016: { 'access': 'read-write', - 'channel_based': 'True', - 'enum': 'CurrentLimitAutorange', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies whether NI-DCPower automatically selects the current limit range based on the desired current limit for the specified channel(s).\nIf you set this attribute to NIDCPOWER_VAL_ON, NI-DCPower ignores any changes you make to the NIDCPOWER_ATTR_CURRENT_LIMIT_RANGE attribute. If you change this attribute from NIDCPOWER_VAL_ON to NIDCPOWER_VAL_OFF, NI-DCPower retains the last value the NIDCPOWER_ATTR_CURRENT_LIMIT_RANGE attribute was set to (or the default value if the attribute was never set) and uses that value as the current limit range.\nQuery the NIDCPOWER_ATTR_CURRENT_LIMIT_RANGE attribute by using the niDCPower_GetAttributeViInt32 function for information about which range NI-DCPower automatically selects.\nThe NIDCPOWER_ATTR_CURRENT_LIMIT_AUTORANGE attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_VOLTAGE.\nDefault Value: NIDCPOWER_VAL_OFF\n' + }, 'lv_property': 'Source:DC Voltage:Current Limit Autorange', 'name': 'CURRENT_LIMIT_AUTORANGE', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies whether NI-DCPower automatically selects the current limit range based on the desired current limit for the specified channel(s). -If you set this attribute to NIDCPOWER_VAL_ON, NI-DCPower ignores any changes you make to the NIDCPOWER_ATTR_CURRENT_LIMIT_RANGE attribute. If you change this attribute from NIDCPOWER_VAL_ON to NIDCPOWER_VAL_OFF, NI-DCPower retains the last value the NIDCPOWER_ATTR_CURRENT_LIMIT_RANGE attribute was set to (or the default value if the attribute was never set) and uses that value as the current limit range. -Query the NIDCPOWER_ATTR_CURRENT_LIMIT_RANGE attribute by using the niDCPower_GetAttributeViInt32 function for information about which range NI-DCPower automatically selects. -The NIDCPOWER_ATTR_CURRENT_LIMIT_AUTORANGE attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_VOLTAGE. -Default Value: NIDCPOWER_VAL_OFF -''', -}, + 'python_type': 'bool', + 'resettable': False, + 'type': 'ViInt32' }, 1150017: { 'access': 'read-write', - 'channel_based': 'True', - 'enum': 'CurrentLevelAutorange', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies whether NI-DCPower automatically selects the current level range based on the desired current level for the specified channels.\nIf you set this attribute to NIDCPOWER_VAL_ON, NI-DCPower ignores any changes you make to the NIDCPOWER_ATTR_CURRENT_LEVEL_RANGE attribute. If you change the NIDCPOWER_ATTR_CURRENT_LEVEL_AUTORANGE attribute from NIDCPOWER_VAL_ON to NIDCPOWER_VAL_OFF, NI-DCPower retains the last value the NIDCPOWER_ATTR_CURRENT_LEVEL_RANGE attribute was set to (or the default value if the attribute was never set) and uses that value as the current level range.\nQuery the NIDCPOWER_ATTR_CURRENT_LEVEL_RANGE attribute by using the niDCPower_GetAttributeViInt32 function for information about which range NI-DCPower automatically selects.\nThe NIDCPOWER_ATTR_CURRENT_LEVEL_AUTORANGE attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_CURRENT.\nDefault Value: NIDCPOWER_VAL_OFF\n' + }, 'lv_property': 'Source:DC Current:Current Level Autorange', 'name': 'CURRENT_LEVEL_AUTORANGE', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies whether NI-DCPower automatically selects the current level range based on the desired current level for the specified channels. -If you set this attribute to NIDCPOWER_VAL_ON, NI-DCPower ignores any changes you make to the NIDCPOWER_ATTR_CURRENT_LEVEL_RANGE attribute. If you change the NIDCPOWER_ATTR_CURRENT_LEVEL_AUTORANGE attribute from NIDCPOWER_VAL_ON to NIDCPOWER_VAL_OFF, NI-DCPower retains the last value the NIDCPOWER_ATTR_CURRENT_LEVEL_RANGE attribute was set to (or the default value if the attribute was never set) and uses that value as the current level range. -Query the NIDCPOWER_ATTR_CURRENT_LEVEL_RANGE attribute by using the niDCPower_GetAttributeViInt32 function for information about which range NI-DCPower automatically selects. -The NIDCPOWER_ATTR_CURRENT_LEVEL_AUTORANGE attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_CURRENT. -Default Value: NIDCPOWER_VAL_OFF -''', -}, + 'python_type': 'bool', + 'resettable': False, + 'type': 'ViInt32' }, 1150018: { 'access': 'read-write', - 'channel_based': 'True', - 'enum': 'VoltageLimitAutorange', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies whether NI-DCPower automatically selects the voltage limit range based on the desired voltage limit for the specified channel(s).\nIf this attribute is set to NIDCPOWER_VAL_ON, NI-DCPower ignores any changes you make to the NIDCPOWER_ATTR_VOLTAGE_LIMIT_RANGE attribute. If you change the NIDCPOWER_ATTR_VOLTAGE_LIMIT_AUTORANGE attribute from NIDCPOWER_VAL_ON to NIDCPOWER_VAL_OFF, NI-DCPower retains the last value the NIDCPOWER_ATTR_VOLTAGE_LIMIT_RANGE attribute was set to (or the default value if the attribute was never set) and uses that value as the voltage limit range.\nQuery the NIDCPOWER_ATTR_VOLTAGE_LIMIT_RANGE attribute by using the niDCPower_GetAttributeViInt32 function to find out which range NI-DCPower automatically selects.\nThe NIDCPOWER_ATTR_VOLTAGE_LIMIT_AUTORANGE attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_CURRENT.\nDefault Value: NIDCPOWER_VAL_OFF\n' + }, 'lv_property': 'Source:DC Current:Voltage Limit Autorange', 'name': 'VOLTAGE_LIMIT_AUTORANGE', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies whether NI-DCPower automatically selects the voltage limit range based on the desired voltage limit for the specified channel(s). -If this attribute is set to NIDCPOWER_VAL_ON, NI-DCPower ignores any changes you make to the NIDCPOWER_ATTR_VOLTAGE_LIMIT_RANGE attribute. If you change the NIDCPOWER_ATTR_VOLTAGE_LIMIT_AUTORANGE attribute from NIDCPOWER_VAL_ON to NIDCPOWER_VAL_OFF, NI-DCPower retains the last value the NIDCPOWER_ATTR_VOLTAGE_LIMIT_RANGE attribute was set to (or the default value if the attribute was never set) and uses that value as the voltage limit range. -Query the NIDCPOWER_ATTR_VOLTAGE_LIMIT_RANGE attribute by using the niDCPower_GetAttributeViInt32 function to find out which range NI-DCPower automatically selects. -The NIDCPOWER_ATTR_VOLTAGE_LIMIT_AUTORANGE attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_CURRENT. -Default Value: NIDCPOWER_VAL_OFF -''', -}, + 'python_type': 'bool', + 'resettable': False, + 'type': 'ViInt32' }, 1150020: { 'access': 'read-write', - 'channel_based': 'True', - 'enum': 'PowerLineFrequency', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the power line frequency for specified channel(s). NI-DCPower uses this value to select a timebase for setting the NIDCPOWER_ATTR_APERTURE_TIME attribute in power line cycles (PLCs).\nin the NI DC Power Supplies and SMUs Help for information about supported devices.\nDefault Value: NIDCPOWER_VAL_60_HERTZ\n', + 'note': 'This attribute is not supported by all devices. Refer to the Supported Attributes by Device topic' + }, 'lv_property': 'Measurement:Power Line Frequency', 'name': 'POWER_LINE_FREQUENCY', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the power line frequency for specified channel(s). NI-DCPower uses this value to select a timebase for setting the NIDCPOWER_ATTR_APERTURE_TIME attribute in power line cycles (PLCs). -in the NI DC Power Supplies and SMUs Help for information about supported devices. -Default Value: NIDCPOWER_VAL_60_HERTZ -''', -'note': 'This attribute is not supported by all devices. Refer to the Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150021: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the behavior of the Start trigger.\nfor information about supported devices.\nDefault Value: NIDCPOWER_VAL_NONE\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'enum': 'TriggerType', 'lv_property': 'Triggers:Start Trigger:Trigger Type', 'name': 'START_TRIGGER_TYPE', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the behavior of the Start trigger. -for information about supported devices. -Default Value: NIDCPOWER_VAL_NONE -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150022: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'codegen_method': 'no', + 'documentation': { + 'description': '\nSpecifies whether to configure the Start trigger to assert on the rising or falling edge.\nfor information about supported devices.\nDefault Value: NIDCPOWER_VAL_RISING\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'enum': 'DigitalEdge', 'lv_property': 'Triggers:Start Trigger:Digital Edge:Edge', 'name': 'DIGITAL_EDGE_START_TRIGGER_EDGE', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies whether to configure the Start trigger to assert on the rising or falling edge. -for information about supported devices. -Default Value: NIDCPOWER_VAL_RISING -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150023: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the input terminal for the Start trigger. Use this attribute only when the NIDCPOWER_ATTR_START_TRIGGER_TYPE attribute is set to NIDCPOWER_VAL_DIGITAL_EDGE.\nfor information about supported devices.\nYou can specify any valid input terminal for this attribute. Valid terminals are listed in Measurement & Automation Explorer under the Device Routes tab.\nInput terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0. The input terminal can also be a terminal from another device. For example, you can set the input terminal on Dev1 to be /Dev2/SourceCompleteEvent.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'lv_property': 'Triggers:Start Trigger:Digital Edge:Input Terminal', 'name': 'DIGITAL_EDGE_START_TRIGGER_INPUT_TERMINAL', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': ''' -Specifies the input terminal for the Start trigger. Use this attribute only when the NIDCPOWER_ATTR_START_TRIGGER_TYPE attribute is set to NIDCPOWER_VAL_DIGITAL_EDGE. -for information about supported devices. -You can specify any valid input terminal for this attribute. Valid terminals are listed in Measurement & Automation Explorer under the Device Routes tab. -Input terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0. The input terminal can also be a terminal from another device. For example, you can set the input terminal on Dev1 to be /Dev2/SourceCompleteEvent. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViString' }, 1150024: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the output terminal for exporting the Start trigger.\nRefer to the Device Routes tab in Measurement & Automation Explorer (MAX) for a list of the terminals available on your device.\nOutput terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0.\nfor information about supported devices.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'lv_property': 'Triggers:Start Trigger:Export Output Terminal', 'name': 'EXPORTED_START_TRIGGER_OUTPUT_TERMINAL', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': ''' -Specifies the output terminal for exporting the Start trigger. -Refer to the Device Routes tab in Measurement & Automation Explorer (MAX) for a list of the terminals available on your device. -Output terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0. -for information about supported devices. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViString' }, 1150025: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the number of times a sequence is run after initiation.\nRefer to the Sequence Source Mode topic in the NI DC Power Supplies and SMUs Help for more information about the sequence loop count.\nfor information about supported devices. When the NIDCPOWER_ATTR_SEQUENCE_LOOP_COUNT_IS_FINITE attribute is set to VI_FALSE, the NIDCPOWER_ATTR_SEQUENCE_LOOP_COUNT attribute is ignored.\nValid Range: 1 to 134217727\nDefault Value: 1\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'lv_property': 'Source:Advanced:Sequence Loop Count', 'name': 'SEQUENCE_LOOP_COUNT', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the number of times a sequence is run after initiation. -Refer to the Sequence Source Mode topic in the NI DC Power Supplies and SMUs Help for more information about the sequence loop count. -for information about supported devices. When the NIDCPOWER_ATTR_SEQUENCE_LOOP_COUNT_IS_FINITE attribute is set to VI_FALSE, the NIDCPOWER_ATTR_SEQUENCE_LOOP_COUNT attribute is ignored. -Valid Range: 1 to 134217727 -Default Value: 1 -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150026: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the behavior of the Sequence Advance trigger.\nfor information about supported devices.\nDefault Value: NIDCPOWER_VAL_NONE\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'enum': 'TriggerType', 'lv_property': 'Triggers:Sequence Advance Trigger:Trigger Type', 'name': 'SEQUENCE_ADVANCE_TRIGGER_TYPE', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the behavior of the Sequence Advance trigger. -for information about supported devices. -Default Value: NIDCPOWER_VAL_NONE -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150027: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'codegen_method': 'no', + 'documentation': { + 'description': '\nSpecifies whether to configure the Sequence Advance trigger to assert on the rising or falling edge.\nfor information about supported devices.\nDefault Value: NIDCPOWER_VAL_RISING\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'enum': 'DigitalEdge', 'lv_property': 'Triggers:Sequence Advance Trigger:Digital Edge:Edge', 'name': 'DIGITAL_EDGE_SEQUENCE_ADVANCE_TRIGGER_EDGE', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies whether to configure the Sequence Advance trigger to assert on the rising or falling edge. -for information about supported devices. -Default Value: NIDCPOWER_VAL_RISING -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150028: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the input terminal for the Sequence Advance trigger. Use this attribute only when the NIDCPOWER_ATTR_SEQUENCE_ADVANCE_TRIGGER_TYPE attribute is set to NIDCPOWER_VAL_DIGITAL_EDGE.\nthe NI DC Power Supplies and SMUs Help for information about supported devices.\nYou can specify any valid input terminal for this attribute. Valid terminals are listed in Measurement & Automation Explorer under the Device Routes tab.\nInput terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0. The input terminal can also be a terminal from another device. For example, you can set the input terminal on Dev1 to be /Dev2/SourceCompleteEvent.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic in' + }, 'lv_property': 'Triggers:Sequence Advance Trigger:Digital Edge:Input Terminal', 'name': 'DIGITAL_EDGE_SEQUENCE_ADVANCE_TRIGGER_INPUT_TERMINAL', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': ''' -Specifies the input terminal for the Sequence Advance trigger. Use this attribute only when the NIDCPOWER_ATTR_SEQUENCE_ADVANCE_TRIGGER_TYPE attribute is set to NIDCPOWER_VAL_DIGITAL_EDGE. -the NI DC Power Supplies and SMUs Help for information about supported devices. -You can specify any valid input terminal for this attribute. Valid terminals are listed in Measurement & Automation Explorer under the Device Routes tab. -Input terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0. The input terminal can also be a terminal from another device. For example, you can set the input terminal on Dev1 to be /Dev2/SourceCompleteEvent. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic in', -}, + 'resettable': False, + 'type': 'ViString' }, 1150029: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the output terminal for exporting the Sequence Advance trigger.\nRefer to the Device Routes tab in Measurement & Automation Explorer for a list of the terminals available on your device.\nfor information about supported devices.\nOutput terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'lv_property': 'Triggers:Sequence Advance Trigger:Export Output Terminal', 'name': 'EXPORTED_SEQUENCE_ADVANCE_TRIGGER_OUTPUT_TERMINAL', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': ''' -Specifies the output terminal for exporting the Sequence Advance trigger. -Refer to the Device Routes tab in Measurement & Automation Explorer for a list of the terminals available on your device. -for information about supported devices. -Output terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViString' }, 1150030: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the behavior of the Source trigger.\nfor information about supported devices.\nDefault Value: NIDCPOWER_VAL_NONE\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'enum': 'TriggerType', 'lv_property': 'Triggers:Source Trigger:Trigger Type', 'name': 'SOURCE_TRIGGER_TYPE', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the behavior of the Source trigger. -for information about supported devices. -Default Value: NIDCPOWER_VAL_NONE -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150031: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'codegen_method': 'no', + 'documentation': { + 'description': '\nSpecifies whether to configure the Source trigger to assert on the rising or falling edge.\nfor information about supported devices.\nDefault Value: NIDCPOWER_VAL_RISING\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'enum': 'DigitalEdge', 'lv_property': 'Triggers:Source Trigger:Digital Edge:Edge', 'name': 'DIGITAL_EDGE_SOURCE_TRIGGER_EDGE', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies whether to configure the Source trigger to assert on the rising or falling edge. -for information about supported devices. -Default Value: NIDCPOWER_VAL_RISING -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150032: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the input terminal for the Source trigger. Use this attribute only when the NIDCPOWER_ATTR_SOURCE_TRIGGER_TYPE attribute is set to NIDCPOWER_VAL_DIGITAL_EDGE.\nfor information about supported devices.\nYou can specify any valid input terminal for this attribute. Valid terminals are listed in Measurement & Automation Explorer under the Device Routes tab.\nInput terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0. The input terminal can also be a terminal from another device. For example, you can set the input terminal on Dev1 to be /Dev2/SourceCompleteEvent.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'lv_property': 'Triggers:Source Trigger:Digital Edge:Input Terminal', 'name': 'DIGITAL_EDGE_SOURCE_TRIGGER_INPUT_TERMINAL', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': ''' -Specifies the input terminal for the Source trigger. Use this attribute only when the NIDCPOWER_ATTR_SOURCE_TRIGGER_TYPE attribute is set to NIDCPOWER_VAL_DIGITAL_EDGE. -for information about supported devices. -You can specify any valid input terminal for this attribute. Valid terminals are listed in Measurement & Automation Explorer under the Device Routes tab. -Input terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0. The input terminal can also be a terminal from another device. For example, you can set the input terminal on Dev1 to be /Dev2/SourceCompleteEvent. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViString' }, 1150033: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the output terminal for exporting the Source trigger.\nRefer to the Device Routes tab in MAX for a list of the terminals available on your device.\nfor information about supported devices.\nOutput terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'lv_property': 'Triggers:Source Trigger:Export Output Terminal', 'name': 'EXPORTED_SOURCE_TRIGGER_OUTPUT_TERMINAL', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': ''' -Specifies the output terminal for exporting the Source trigger. -Refer to the Device Routes tab in MAX for a list of the terminals available on your device. -for information about supported devices. -Output terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViString' }, 1150034: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the behavior of the Measure trigger.\nfor information about supported devices.\nDefault Value: NIDCPOWER_VAL_DIGITAL_EDGE\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'enum': 'TriggerType', 'lv_property': 'Triggers:Measure Trigger:Trigger Type', 'name': 'MEASURE_TRIGGER_TYPE', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the behavior of the Measure trigger. -for information about supported devices. -Default Value: NIDCPOWER_VAL_DIGITAL_EDGE -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150035: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'codegen_method': 'no', + 'documentation': { + 'description': '\nSpecifies whether to configure the Measure trigger to assert on the rising or falling edge.\nNIDCPOWER_ATTR_SOURCE_TRIGGER_TYPE attribute is set to NIDCPOWER_VAL_DIGITAL_EDGE.\nfor information about supported devices.\nDefault Value: NIDCPOWER_VAL_RISING\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'enum': 'DigitalEdge', 'lv_property': 'Triggers:Measure Trigger:Digital Edge:Edge', 'name': 'DIGITAL_EDGE_MEASURE_TRIGGER_EDGE', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies whether to configure the Measure trigger to assert on the rising or falling edge. -NIDCPOWER_ATTR_SOURCE_TRIGGER_TYPE attribute is set to NIDCPOWER_VAL_DIGITAL_EDGE. -for information about supported devices. -Default Value: NIDCPOWER_VAL_RISING -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150036: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the input terminal for the Measure trigger. This attribute is used only when the NIDCPOWER_ATTR_MEASURE_TRIGGER_TYPE attribute is set to NIDCPOWER_VAL_DIGITAL_EDGE.\nfor this attribute.\nYou can specify any valid input terminal for this attribute. Valid terminals are listed in Measurement & Automation Explorer under the Device Routes tab.\nInput terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0. The input terminal can also be a terminal from another device. For example, you can set the input terminal on Dev1 to be /Dev2/SourceCompleteEvent.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'lv_property': 'Triggers:Measure Trigger:Digital Edge:Input Terminal', 'name': 'DIGITAL_EDGE_MEASURE_TRIGGER_INPUT_TERMINAL', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': ''' -Specifies the input terminal for the Measure trigger. This attribute is used only when the NIDCPOWER_ATTR_MEASURE_TRIGGER_TYPE attribute is set to NIDCPOWER_VAL_DIGITAL_EDGE. -for this attribute. -You can specify any valid input terminal for this attribute. Valid terminals are listed in Measurement & Automation Explorer under the Device Routes tab. -Input terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0. The input terminal can also be a terminal from another device. For example, you can set the input terminal on Dev1 to be /Dev2/SourceCompleteEvent. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViString' }, 1150037: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the output terminal for exporting the Measure trigger.\nRefer to the Device Routes tab in Measurement & Automation Explorer for a list of the terminals available on your device.\nfor information about supported devices.\nOutput terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'lv_property': 'Triggers:Measure Trigger:Export Output Terminal', 'name': 'EXPORTED_MEASURE_TRIGGER_OUTPUT_TERMINAL', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': ''' -Specifies the output terminal for exporting the Measure trigger. -Refer to the Device Routes tab in Measurement & Automation Explorer for a list of the terminals available on your device. -for information about supported devices. -Output terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViString' }, 1150038: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the behavior of the Sequence Iteration Complete event.\nfor information about supported devices.\nDefault Value: NIDCPOWER_VAL_ACTIVE_HIGH\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'enum': 'Polarity', 'lv_property': 'Events:Sequence Iteration Complete Event:Pulse:Polarity', 'name': 'SEQUENCE_ITERATION_COMPLETE_EVENT_PULSE_POLARITY', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the behavior of the Sequence Iteration Complete event. -for information about supported devices. -Default Value: NIDCPOWER_VAL_ACTIVE_HIGH -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150039: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the width of the Sequence Iteration Complete event, in seconds.\nThe minimum event pulse width value for PXI devices is 150 ns, and the minimum event pulse width value for PXI Express devices is 250 ns.\nThe maximum event pulse width value for all devices is 1.6 microseconds.\nthe NI DC Power Supplies and SMUs Help for information about supported devices.\nValid Values: 1.5e-7 to 1.6e-6 seconds\nDefault Value: The default value for PXI devices is 150 ns. The default value for PXI Express devices is 250 ns.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic in' + }, 'lv_property': 'Events:Sequence Iteration Complete Event:Pulse:Width', 'name': 'SEQUENCE_ITERATION_COMPLETE_EVENT_PULSE_WIDTH', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the width of the Sequence Iteration Complete event, in seconds. -The minimum event pulse width value for PXI devices is 150 ns, and the minimum event pulse width value for PXI Express devices is 250 ns. -The maximum event pulse width value for all devices is 1.6 microseconds. -the NI DC Power Supplies and SMUs Help for information about supported devices. -Valid Values: 1.5e-7 to 1.6e-6 seconds -Default Value: The default value for PXI devices is 150 ns. The default value for PXI Express devices is 250 ns. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic in', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150040: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the output terminal for exporting the Sequence Iteration Complete event.\nfor information about supported devices.\nOutput terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'lv_property': 'Events:Sequence Iteration Complete Event:Output Terminal', 'name': 'SEQUENCE_ITERATION_COMPLETE_EVENT_OUTPUT_TERMINAL', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': ''' -Specifies the output terminal for exporting the Sequence Iteration Complete event. -for information about supported devices. -Output terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViString' }, 1150041: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the behavior of the Source Complete event.\nfor information about supported devices.\nDefault Value: NIDCPOWER_VAL_ACTIVE_HIGH\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'enum': 'Polarity', 'lv_property': 'Events:Source Complete Event:Pulse:Polarity', 'name': 'SOURCE_COMPLETE_EVENT_PULSE_POLARITY', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the behavior of the Source Complete event. -for information about supported devices. -Default Value: NIDCPOWER_VAL_ACTIVE_HIGH -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150042: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the width of the Source Complete event, in seconds.\nfor information about supported devices.\nThe minimum event pulse width value for PXI devices is 150 ns, and the minimum event pulse width value for PXI Express devices is 250 ns.\nThe maximum event pulse width value for all devices is 1.6 microseconds\nValid Values: 1.5e-7 to 1.6e-6 seconds\nDefault Value: The default value for PXI devices is 150 ns. The default value for PXI Express devices is 250 ns.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'lv_property': 'Events:Source Complete Event:Pulse:Width', 'name': 'SOURCE_COMPLETE_EVENT_PULSE_WIDTH', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the width of the Source Complete event, in seconds. -for information about supported devices. -The minimum event pulse width value for PXI devices is 150 ns, and the minimum event pulse width value for PXI Express devices is 250 ns. -The maximum event pulse width value for all devices is 1.6 microseconds -Valid Values: 1.5e-7 to 1.6e-6 seconds -Default Value: The default value for PXI devices is 150 ns. The default value for PXI Express devices is 250 ns. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150043: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the output terminal for exporting the Source Complete event.\nfor information about supported devices.\nOutput terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'lv_property': 'Events:Source Complete Event:Output Terminal', 'name': 'SOURCE_COMPLETE_EVENT_OUTPUT_TERMINAL', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': ''' -Specifies the output terminal for exporting the Source Complete event. -for information about supported devices. -Output terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViString' }, 1150044: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the behavior of the Measure Complete event.\nfor information about supported devices.\nDefault Value: NIDCPOWER_VAL_ACTIVE_HIGH\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'enum': 'Polarity', 'lv_property': 'Events:Measure Complete Event:Pulse:Polarity', 'name': 'MEASURE_COMPLETE_EVENT_PULSE_POLARITY', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the behavior of the Measure Complete event. -for information about supported devices. -Default Value: NIDCPOWER_VAL_ACTIVE_HIGH -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150045: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the width of the Measure Complete event, in seconds.\nThe minimum event pulse width value for PXI devices is 150 ns, and the minimum event pulse width value for PXI Express devices is 250 ns.\nThe maximum event pulse width value for all devices is 1.6 microseconds.\nfor information about supported devices.\nValid Values: 1.5e-7 to 1.6e-6\nDefault Value: The default value for PXI devices is 150 ns. The default value for PXI Express devices is 250 ns.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'lv_property': 'Events:Measure Complete Event:Pulse:Width', 'name': 'MEASURE_COMPLETE_EVENT_PULSE_WIDTH', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the width of the Measure Complete event, in seconds. -The minimum event pulse width value for PXI devices is 150 ns, and the minimum event pulse width value for PXI Express devices is 250 ns. -The maximum event pulse width value for all devices is 1.6 microseconds. -for information about supported devices. -Valid Values: 1.5e-7 to 1.6e-6 -Default Value: The default value for PXI devices is 150 ns. The default value for PXI Express devices is 250 ns. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150046: { 'access': 'read-write', - 'channel_based': 'False', + 'attribute_class': 'AttributeViReal64TimeDeltaSeconds', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the amount of time to delay the generation of the Measure Complete event, in seconds.\nfor information about supported devices.\nValid Values: 0 to 167 seconds\nDefault Value: The NI PXI-4132 and NI PXIe-4140/4141/4142/4143/4144/4145/4154 supports values from 0 seconds to 167 seconds.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'lv_property': 'Events:Measure Complete Event:Event Delay', 'name': 'MEASURE_COMPLETE_EVENT_DELAY', - 'resettable': 'No', + 'resettable': False, 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the amount of time to delay the generation of the Measure Complete event, in seconds. -for information about supported devices. -Valid Values: 0 to 167 seconds -Default Value: The NI PXI-4132 and NI PXIe-4140/4141/4142/4143/4144/4145/4154 supports values from 0 seconds to 167 seconds. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'type_in_documentation': 'float in seconds or datetime.timedelta' }, 1150047: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the output terminal for exporting the Measure Complete event.\nfor information about supported devices.\nOutput terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'lv_property': 'Events:Measure Complete Event:Output Terminal', 'name': 'MEASURE_COMPLETE_EVENT_OUTPUT_TERMINAL', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': ''' -Specifies the output terminal for exporting the Measure Complete event. -for information about supported devices. -Output terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViString' }, 1150048: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the behavior of the Sequence Engine Done event.\nfor information about supported devices.\nDefault Value: NIDCPOWER_VAL_ACTIVE_HIGH\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'enum': 'Polarity', 'lv_property': 'Events:Sequence Engine Done Event:Pulse:Polarity', 'name': 'SEQUENCE_ENGINE_DONE_EVENT_PULSE_POLARITY', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the behavior of the Sequence Engine Done event. -for information about supported devices. -Default Value: NIDCPOWER_VAL_ACTIVE_HIGH -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150049: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the width of the Sequence Engine Done event, in seconds.\nThe minimum event pulse width value for PXI devices is 150 ns, and the minimum event pulse width value for PXI Express devices is 250 ns.\nThe maximum event pulse width value for all devices is 1.6 microseconds.\nfor information about supported devices.\nValid Values: 1.5e-7 to 1.6e-6 seconds\nDefault Value: The default value for PXI devices is 150 ns. The default value for PXI Express devices is 250 ns.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'lv_property': 'Events:Sequence Engine Done Event:Pulse:Width', 'name': 'SEQUENCE_ENGINE_DONE_EVENT_PULSE_WIDTH', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the width of the Sequence Engine Done event, in seconds. -The minimum event pulse width value for PXI devices is 150 ns, and the minimum event pulse width value for PXI Express devices is 250 ns. -The maximum event pulse width value for all devices is 1.6 microseconds. -for information about supported devices. -Valid Values: 1.5e-7 to 1.6e-6 seconds -Default Value: The default value for PXI devices is 150 ns. The default value for PXI Express devices is 250 ns. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150050: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the output terminal for exporting the Sequence Engine Done Complete event.\nfor information about supported devices.\nOutput terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'lv_property': 'Events:Sequence Engine Done Event:Output Terminal', 'name': 'SEQUENCE_ENGINE_DONE_EVENT_OUTPUT_TERMINAL', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': ''' -Specifies the output terminal for exporting the Sequence Engine Done Complete event. -for information about supported devices. -Output terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViString' }, 1150051: { 'access': 'read-write', - 'channel_based': 'True', + 'attribute_class': 'AttributeViReal64TimeDeltaSeconds', + 'channel_based': True, + 'documentation': { + 'description': '\nDetermines when, in seconds, the device generates the Source Complete event, potentially starting a measurement if the NIDCPOWER_ATTR_MEASURE_WHEN attribute is set to NIDCPOWER_VAL_AUTOMATICALLY_AFTER_SOURCE_COMPLETE.\nRefer to the Single Point Source Mode and Sequence Source Mode topics for more information.\nValid Values: 0 to 167 seconds\nDefault Value: 0.01667 seconds\n', + 'note': '\nRefer to Supported Attributes by Device for information about supported devices.\n' + }, 'lv_property': 'Source:Advanced:Source Delay', 'name': 'SOURCE_DELAY', - 'resettable': 'No', + 'resettable': False, 'type': 'ViReal64', -'documentation': { -'description': ''' -Determines when, in seconds, the device generates the Source Complete event, potentially starting a measurement if the NIDCPOWER_ATTR_MEASURE_WHEN attribute is set to NIDCPOWER_VAL_AUTOMATICALLY_AFTER_SOURCE_COMPLETE. -Refer to the Single Point Source Mode and Sequence Source Mode topics for more information. -Valid Values: 0 to 167 seconds -Default Value: 0.01667 seconds -''', -'note': ''' -Refer to Supported Attributes by Device for information about supported devices. -''', -}, + 'type_in_documentation': 'float in seconds or datetime.timedelta' }, 1150054: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies whether to run a single output point or a sequence. Refer to the Single Point Source Mode and Sequence Source Mode topics in the NI DC Power Supplies and SMUs Help for more information about source modes.\nDefault value: NIDCPOWER_VAL_SINGLE_POINT\n' + }, 'enum': 'SourceMode', 'lv_property': 'Source:Source Mode', 'name': 'SOURCE_MODE', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies whether to run a single output point or a sequence. Refer to the Single Point Source Mode and Sequence Source Mode topics in the NI DC Power Supplies and SMUs Help for more information about source modes. -Default value: NIDCPOWER_VAL_SINGLE_POINT -''', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150055: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the auto-zero method to use on the device.\nRefer to the NI PXI-4132 Measurement Configuration and Timing and Auto Zero topics for more information about how to configure your measurements.\nDefault Value: The default value for the NI PXI-4132 is NIDCPOWER_VAL_ON. The default value for all other devices is NIDCPOWER_VAL_OFF, which is the only supported value for these devices.\n' + }, 'enum': 'AutoZero', 'lv_property': 'Measurement:Auto Zero', 'name': 'AUTO_ZERO', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the auto-zero method to use on the device. -Refer to the NI PXI-4132 Measurement Configuration and Timing and Auto Zero topics for more information about how to configure your measurements. -Default Value: The default value for the NI PXI-4132 is NIDCPOWER_VAL_ON. The default value for all other devices is NIDCPOWER_VAL_OFF, which is the only supported value for these devices. -''', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150056: { 'access': 'read only', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': 'Returns the number of measurements acquired that have not been fetched yet.' + }, 'lv_property': 'Measurement:Fetch Backlog', 'name': 'FETCH_BACKLOG', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': 'Returns the number of measurements acquired that have not been fetched yet.', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150057: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies when the measure unit should acquire measurements. Unless this attribute is configured to NIDCPOWER_VAL_ON_MEASURE_TRIGGER, the NIDCPOWER_ATTR_MEASURE_TRIGGER_TYPE attribute is ignored.\nRefer to the Acquiring Measurements topic in the NI DC Power Supplies and SMUs Help for more information about how to configure your measurements.\nDefault Value: If the NIDCPOWER_ATTR_SOURCE_MODE attribute is set to NIDCPOWER_VAL_SINGLE_POINT, the default value is NIDCPOWER_VAL_ON_DEMAND. This value supports only the niDCPower_Measure function and niDCPower_MeasureMultiple function. If the NIDCPOWER_ATTR_SOURCE_MODE attribute is set to NIDCPOWER_VAL_SEQUENCE, the default value is NIDCPOWER_VAL_AUTOMATICALLY_AFTER_SOURCE_COMPLETE. This value supports only the niDCPower_FetchMultiple function.\n' + }, 'enum': 'MeasureWhen', 'lv_property': 'Measurement:Advanced:Measure When', 'name': 'MEASURE_WHEN', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies when the measure unit should acquire measurements. Unless this attribute is configured to NIDCPOWER_VAL_ON_MEASURE_TRIGGER, the NIDCPOWER_ATTR_MEASURE_TRIGGER_TYPE attribute is ignored. -Refer to the Acquiring Measurements topic in the NI DC Power Supplies and SMUs Help for more information about how to configure your measurements. -Default Value: If the NIDCPOWER_ATTR_SOURCE_MODE attribute is set to NIDCPOWER_VAL_SINGLE_POINT, the default value is NIDCPOWER_VAL_ON_DEMAND. This value supports only the niDCPower_Measure function and niDCPower_MeasureMultiple function. If the NIDCPOWER_ATTR_SOURCE_MODE attribute is set to NIDCPOWER_VAL_SEQUENCE, the default value is NIDCPOWER_VAL_AUTOMATICALLY_AFTER_SOURCE_COMPLETE. This value supports only the niDCPower_FetchMultiple function. -''', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150058: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the measurement aperture time for the channel configuration. Aperture time is specified in the units set by the NIDCPOWER_ATTR_APERTURE_TIME_UNITS attribute.\nfor information about supported devices.\nRefer to the Aperture Time topic in the NI DC Power Supplies and SMUs Help for more information about how to configure your measurements and for information about valid values.\nDefault Value: 0.01666666 seconds\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'lv_property': 'Measurement:Aperture Time', 'name': 'APERTURE_TIME', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the measurement aperture time for the channel configuration. Aperture time is specified in the units set by the NIDCPOWER_ATTR_APERTURE_TIME_UNITS attribute. -for information about supported devices. -Refer to the Aperture Time topic in the NI DC Power Supplies and SMUs Help for more information about how to configure your measurements and for information about valid values. -Default Value: 0.01666666 seconds -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150059: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the units of the NIDCPOWER_ATTR_APERTURE_TIME attribute for the channel configuration.\nfor information about supported devices.\nRefer to the Aperture Time topic in the NI DC Power Supplies and SMUs Help for more information about how to configure your measurements and for information about valid values.\nDefault Value: NIDCPOWER_VAL_SECONDS\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'enum': 'ApertureTimeUnits', 'lv_property': 'Measurement:Aperture Time Units', 'name': 'APERTURE_TIME_UNITS', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the units of the NIDCPOWER_ATTR_APERTURE_TIME attribute for the channel configuration. -for information about supported devices. -Refer to the Aperture Time topic in the NI DC Power Supplies and SMUs Help for more information about how to configure your measurements and for information about valid values. -Default Value: NIDCPOWER_VAL_SECONDS -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150060: { 'access': 'read-write', - 'channel_based': 'True', - 'enum': 'tBoolean', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies whether the output relay is connected (closed) or disconnected (open). The NIDCPOWER_ATTR_OUTPUT_ENABLED attribute does not change based on this attribute; they are independent of each other.\nabout supported devices.\nSet this attribute to VI_FALSE to disconnect the output terminal from the output.\nto the output terminal might discharge unless the relay is disconnected. Excessive connecting and disconnecting of the output can cause premature wear on the relay.\nDefault Value: VI_TRUE\n', + 'note': 'Only disconnect the output when disconnecting is necessary for your application. For example, a battery connected' + }, 'lv_property': 'Source:Output Connected', 'name': 'OUTPUT_CONNECTED', - 'resettable': 'No', - 'type': 'ViBoolean', -'documentation': { -'description': ''' -Specifies whether the output relay is connected (closed) or disconnected (open). The NIDCPOWER_ATTR_OUTPUT_ENABLED attribute does not change based on this attribute; they are independent of each other. -about supported devices. -Set this attribute to VI_FALSE to disconnect the output terminal from the output. -to the output terminal might discharge unless the relay is disconnected. Excessive connecting and disconnecting of the output can cause premature wear on the relay. -Default Value: VI_TRUE -''', -'note': 'Only disconnect the output when disconnecting is necessary for your application. For example, a battery connected', -}, + 'resettable': False, + 'type': 'ViBoolean' }, 1150061: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': "\nSpecifies the output resistance that the device attempts to generate for the specified channel(s). This attribute is available only when you set the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute on a support device. Refer to a supported device's topic about output resistance for more information about selecting an output resistance.\nabout supported devices.\nDefault Value: 0.0\n", + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic for information' + }, 'lv_property': 'Source:Output Resistance', 'name': 'OUTPUT_RESISTANCE', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the output resistance that the device attempts to generate for the specified channel(s). This attribute is available only when you set the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute on a support device. Refer to a supported device's topic about output resistance for more information about selecting an output resistance. -about supported devices. -Default Value: 0.0 -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic for information', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150062: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the transient response. Refer to the Transient Response topic in the NI DC Power Supplies and SMUs Help for more information about transient response.\nfor information about supported devices.\nDefault Value: NIDCPOWER_VAL_NORMAL\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'enum': 'TransientResponse', 'lv_property': 'Source:Transient Response', 'name': 'TRANSIENT_RESPONSE', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the transient response. Refer to the Transient Response topic in the NI DC Power Supplies and SMUs Help for more information about transient response. -for information about supported devices. -Default Value: NIDCPOWER_VAL_NORMAL -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150063: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies how many measurements compose a measure record. When this attribute is set to a value greater than 1, the NIDCPOWER_ATTR_MEASURE_WHEN attribute must be set to NIDCPOWER_VAL_AUTOMATICALLY_AFTER_SOURCE_COMPLETE or NIDCPOWER_VAL_ON_MEASURE_TRIGGER.\nfor information about supported devices.\nValid Values: 1 to 16,777,216\nDefault Value: 1\n', + 'note': '\nThis attribute is not available in a session involving multiple channels.\n' + }, 'lv_property': 'Measurement:Measure Record Length', 'name': 'MEASURE_RECORD_LENGTH', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies how many measurements compose a measure record. When this attribute is set to a value greater than 1, the NIDCPOWER_ATTR_MEASURE_WHEN attribute must be set to NIDCPOWER_VAL_AUTOMATICALLY_AFTER_SOURCE_COMPLETE or NIDCPOWER_VAL_ON_MEASURE_TRIGGER. -for information about supported devices. -Valid Values: 1 to 16,777,216 -Default Value: 1 -''', -'note': ''' -This attribute is not available in a session involving multiple channels. -''', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150064: { 'access': 'read-write', - 'channel_based': 'False', - 'enum': 'tBoolean', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies whether to take continuous measurements. Call the niDCPower_Abort function to stop continuous measurements. When this attribute is set to VI_FALSE and the NIDCPOWER_ATTR_SOURCE_MODE attribute is set to NIDCPOWER_VAL_SINGLE_POINT, the NIDCPOWER_ATTR_MEASURE_WHEN attribute must be set to NIDCPOWER_VAL_AUTOMATICALLY_AFTER_SOURCE_COMPLETE or NIDCPOWER_VAL_ON_MEASURE_TRIGGER. When this attribute is set to VI_FALSE and the NIDCPOWER_ATTR_SOURCE_MODE attribute is set to NIDCPOWER_VAL_SEQUENCE, the NIDCPOWER_ATTR_MEASURE_WHEN attribute must be set to NIDCPOWER_VAL_ON_MEASURE_TRIGGER.\nfor information about supported devices.\nDefault Value: VI_TRUE\n', + 'note': '\nThis attribute is not available in a session involving multiple channels.\n' + }, 'lv_property': 'Measurement:Measure Record Length Is Finite', 'name': 'MEASURE_RECORD_LENGTH_IS_FINITE', - 'resettable': 'No', - 'type': 'ViBoolean', -'documentation': { -'description': ''' -Specifies whether to take continuous measurements. Call the niDCPower_Abort function to stop continuous measurements. When this attribute is set to VI_FALSE and the NIDCPOWER_ATTR_SOURCE_MODE attribute is set to NIDCPOWER_VAL_SINGLE_POINT, the NIDCPOWER_ATTR_MEASURE_WHEN attribute must be set to NIDCPOWER_VAL_AUTOMATICALLY_AFTER_SOURCE_COMPLETE or NIDCPOWER_VAL_ON_MEASURE_TRIGGER. When this attribute is set to VI_FALSE and the NIDCPOWER_ATTR_SOURCE_MODE attribute is set to NIDCPOWER_VAL_SEQUENCE, the NIDCPOWER_ATTR_MEASURE_WHEN attribute must be set to NIDCPOWER_VAL_ON_MEASURE_TRIGGER. -for information about supported devices. -Default Value: VI_TRUE -''', -'note': ''' -This attribute is not available in a session involving multiple channels. -''', -}, + 'resettable': False, + 'type': 'ViBoolean' }, 1150065: { 'access': 'read only', - 'channel_based': 'False', + 'attribute_class': 'AttributeViReal64TimeDeltaSeconds', + 'channel_based': False, + 'documentation': { + 'description': '\nQueries the amount of time, in seconds, between between the start of two consecutive measurements in a measure record. Only query this attribute after the desired measurement settings are committed.\nfor information about supported devices.\ntwo measurements and the rest would differ.\n', + 'note': 'This attribute is not available when Auto Zero is configured to Once because the amount of time between the first' + }, 'lv_property': 'Measurement:Measure Record Delta Time', 'name': 'MEASURE_RECORD_DELTA_TIME', - 'resettable': 'No', + 'resettable': False, 'type': 'ViReal64', -'documentation': { -'description': ''' -Queries the amount of time, in seconds, between between the start of two consecutive measurements in a measure record. Only query this attribute after the desired measurement settings are committed. -for information about supported devices. -two measurements and the rest would differ. -''', -'note': 'This attribute is not available when Auto Zero is configured to Once because the amount of time between the first', -}, + 'type_in_documentation': 'float in seconds or datetime.timedelta' }, 1150066: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nDetermines the relative weighting of samples in a measurement. Refer to the NI PXIe-4140/4141 DC Noise Rejection, NI PXIe-4142/4143 DC Noise Rejection, or NI PXIe-4144/4145 DC Noise Rejection topic in the NI DC Power Supplies and SMUs Help for more information about noise rejection.\nfor information about supported devices.\nDefault Value: NIDCPOWER_VAL_NORMAL\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'enum': 'DCNoiseRejection', 'lv_property': 'Measurement:Advanced:DC Noise Rejection', 'name': 'DC_NOISE_REJECTION', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Determines the relative weighting of samples in a measurement. Refer to the NI PXIe-4140/4141 DC Noise Rejection, NI PXIe-4142/4143 DC Noise Rejection, or NI PXIe-4144/4145 DC Noise Rejection topic in the NI DC Power Supplies and SMUs Help for more information about noise rejection. -for information about supported devices. -Default Value: NIDCPOWER_VAL_NORMAL -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150067: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nThe frequency at which the unloaded loop gain extrapolates to 0 dB in the absence of additional poles and zeroes. This attribute takes effect when the channel is in Constant Voltage mode.\nfor information about supported devices.\nDefault Value: Determined by the value of the NIDCPOWER_VAL_NORMAL setting of the NIDCPOWER_ATTR_TRANSIENT_RESPONSE attribute.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'lv_property': 'Source:Custom Transient Response:Voltage:Gain Bandwidth', 'name': 'VOLTAGE_GAIN_BANDWIDTH', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -The frequency at which the unloaded loop gain extrapolates to 0 dB in the absence of additional poles and zeroes. This attribute takes effect when the channel is in Constant Voltage mode. -for information about supported devices. -Default Value: Determined by the value of the NIDCPOWER_VAL_NORMAL setting of the NIDCPOWER_ATTR_TRANSIENT_RESPONSE attribute. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150068: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nThe frequency at which a pole-zero pair is added to the system when the channel is in Constant Voltage mode.\nfor information about supported devices.\nDefault value: Determined by the value of the NIDCPOWER_VAL_NORMAL setting of the NIDCPOWER_ATTR_TRANSIENT_RESPONSE attribute.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'lv_property': 'Source:Custom Transient Response:Voltage:Compensation Frequency', 'name': 'VOLTAGE_COMPENSATION_FREQUENCY', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -The frequency at which a pole-zero pair is added to the system when the channel is in Constant Voltage mode. -for information about supported devices. -Default value: Determined by the value of the NIDCPOWER_VAL_NORMAL setting of the NIDCPOWER_ATTR_TRANSIENT_RESPONSE attribute. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150069: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nThe ratio of the pole frequency to the zero frequency when the channel is in Constant Voltage mode.\nfor information about supported devices.\nDefault value: Determined by the value of the NIDCPOWER_VAL_NORMAL setting of the NIDCPOWER_ATTR_TRANSIENT_RESPONSE attribute.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'lv_property': 'Source:Custom Transient Response:Voltage:Pole-Zero Ratio', 'name': 'VOLTAGE_POLE_ZERO_RATIO', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -The ratio of the pole frequency to the zero frequency when the channel is in Constant Voltage mode. -for information about supported devices. -Default value: Determined by the value of the NIDCPOWER_VAL_NORMAL setting of the NIDCPOWER_ATTR_TRANSIENT_RESPONSE attribute. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150070: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nThe frequency at which the unloaded loop gain extrapolates to 0 dB in the absence of additional poles and zeroes. This attribute takes effect when the channel is in Constant Current mode.\nfor information about supported devices.\nDefault Value: Determined by the value of the NIDCPOWER_VAL_NORMAL setting of the NIDCPOWER_ATTR_TRANSIENT_RESPONSE attribute.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'lv_property': 'Source:Custom Transient Response:Current:Gain Bandwidth', 'name': 'CURRENT_GAIN_BANDWIDTH', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -The frequency at which the unloaded loop gain extrapolates to 0 dB in the absence of additional poles and zeroes. This attribute takes effect when the channel is in Constant Current mode. -for information about supported devices. -Default Value: Determined by the value of the NIDCPOWER_VAL_NORMAL setting of the NIDCPOWER_ATTR_TRANSIENT_RESPONSE attribute. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150071: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nThe frequency at which a pole-zero pair is added to the system when the channel is in Constant Current mode.\nfor information about supported devices.\nDefault Value: Determined by the value of the NIDCPOWER_VAL_NORMAL setting of the NIDCPOWER_ATTR_TRANSIENT_RESPONSE attribute.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'lv_property': 'Source:Custom Transient Response:Current:Compensation Frequency', 'name': 'CURRENT_COMPENSATION_FREQUENCY', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -The frequency at which a pole-zero pair is added to the system when the channel is in Constant Current mode. -for information about supported devices. -Default Value: Determined by the value of the NIDCPOWER_VAL_NORMAL setting of the NIDCPOWER_ATTR_TRANSIENT_RESPONSE attribute. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150072: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nThe ratio of the pole frequency to the zero frequency when the channel is in Constant Current mode.\nfor information about supported devices.\nDefault Value: Determined by the value of the NIDCPOWER_VAL_NORMAL setting of the NIDCPOWER_ATTR_TRANSIENT_RESPONSE attribute.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'lv_property': 'Source:Custom Transient Response:Current:Pole-Zero Ratio', 'name': 'CURRENT_POLE_ZERO_RATIO', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -The ratio of the pole frequency to the zero frequency when the channel is in Constant Current mode. -for information about supported devices. -Default Value: Determined by the value of the NIDCPOWER_VAL_NORMAL setting of the NIDCPOWER_ATTR_TRANSIENT_RESPONSE attribute. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150073: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies whether the values calculated during self-calibration should be written to hardware to be used until the next self-calibration or only used until the niDCPower_ResetDevice function is called or the machine is powered down.\nThis attribute affects the behavior of the niDCPower_CalSelfCalibrate function. When set to NIDCPOWER_VAL_KEEP_IN_MEMORY, the values calculated by the niDCPower_CalSelfCalibrate function are used in the existing session, as well as in all further sessions until you call the niDCPower_ResetDevice function or restart the machine. When you set this property to NIDCPOWER_VAL_WRITE_TO_EEPROM, the values calculated by the niDCPower_CalSelfCalibrate function are written to hardware and used in the existing session and in all subsequent sessions until another call to the niDCPower_CalSelfCalibrate function is made.\nabout supported devices.\nDefault Value: NIDCPOWER_VAL_KEEP_IN_MEMORY\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information' + }, 'enum': 'SelfCalibrationPersistence', 'lv_property': 'Advanced:Self-Calibration Persistence', 'name': 'SELF_CALIBRATION_PERSISTENCE', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies whether the values calculated during self-calibration should be written to hardware to be used until the next self-calibration or only used until the niDCPower_ResetDevice function is called or the machine is powered down. -This attribute affects the behavior of the niDCPower_CalSelfCalibrate function. When set to NIDCPOWER_VAL_KEEP_IN_MEMORY, the values calculated by the niDCPower_CalSelfCalibrate function are used in the existing session, as well as in all further sessions until you call the niDCPower_ResetDevice function or restart the machine. When you set this property to NIDCPOWER_VAL_WRITE_TO_EEPROM, the values calculated by the niDCPower_CalSelfCalibrate function are written to hardware and used in the existing session and in all subsequent sessions until another call to the niDCPower_CalSelfCalibrate function is made. -about supported devices. -Default Value: NIDCPOWER_VAL_KEEP_IN_MEMORY -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150074: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'codegen_method': 'private', + 'documentation': { + 'description': '\nSpecifies the advanced sequence to configure or generate.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic.' + }, 'lv_property': 'Source:Advanced:Active Advanced Sequence', 'name': 'ACTIVE_ADVANCED_SEQUENCE', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': ''' -Specifies the advanced sequence to configure or generate. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic.', -}, + 'resettable': False, + 'type': 'ViString' }, 1150075: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'codegen_method': 'private', + 'documentation': { + 'description': '\nSpecifies the advanced sequence step to configure.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic.' + }, 'lv_property': 'Source:Advanced:Active Advanced Sequence Step', 'name': 'ACTIVE_ADVANCED_SEQUENCE_STEP', - 'resettable': 'No', - 'type': 'ViInt64', -'documentation': { -'description': ''' -Specifies the advanced sequence step to configure. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic.', -}, + 'resettable': False, + 'type': 'ViInt64' }, 1150077: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the number of samples that the active channel measurement buffer can hold.\nThe default value is the maximum number of samples that a device is capable of recording in one second.\nfor information about supported devices.\nValid Values: 1000 to 2147483647\nDefault Value: Varies by device. Refer to Supported Attributes by Device topic in the NI DC Power Supplies and SMUs Help for more information about default values.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'lv_property': 'Measurement:Advanced:Measure Buffer Size', 'name': 'MEASURE_BUFFER_SIZE', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the number of samples that the active channel measurement buffer can hold. -The default value is the maximum number of samples that a device is capable of recording in one second. -for information about supported devices. -Valid Values: 1000 to 2147483647 -Default Value: Varies by device. Refer to Supported Attributes by Device topic in the NI DC Power Supplies and SMUs Help for more information about default values. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150078: { 'access': 'read-write', - 'channel_based': 'False', - 'enum': 'tBoolean', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies whether a sequence should repeat indefinitely.\nRefer to the Sequence Source Mode topic in the NI DC Power Supplies and SMUs Help for more information about infinite sequencing.\nNIDCPOWER_ATTR_SEQUENCE_LOOP_COUNT_IS_FINITE attribute is set to VI_FALSE, the NIDCPOWER_ATTR_SEQUENCE_LOOP_COUNT attribute is ignored.\nDefault Value: VI_TRUE\n', + 'note': 'This attribute is not supported by all devices. When the' + }, 'lv_property': 'Source:Advanced:Sequence Loop Count Is Finite', 'name': 'SEQUENCE_LOOP_COUNT_IS_FINITE', - 'resettable': 'No', - 'type': 'ViBoolean', -'documentation': { -'description': ''' -Specifies whether a sequence should repeat indefinitely. -Refer to the Sequence Source Mode topic in the NI DC Power Supplies and SMUs Help for more information about infinite sequencing. -NIDCPOWER_ATTR_SEQUENCE_LOOP_COUNT_IS_FINITE attribute is set to VI_FALSE, the NIDCPOWER_ATTR_SEQUENCE_LOOP_COUNT attribute is ignored. -Default Value: VI_TRUE -''', -'note': 'This attribute is not supported by all devices. When the', -}, + 'resettable': False, + 'type': 'ViBoolean' }, 1150080: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the pulse current limit, in amps, that the output cannot exceed when generating the desired pulse voltage on the specified channel(s) during the on phase of a pulse.\nThis attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_PULSE_VOLTAGE.\nValid Values: The valid values for this attribute are defined by the values you specify for the NIDCPOWER_ATTR_PULSE_CURRENT_LIMIT_RANGE attribute.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.' + }, 'lv_property': 'Source:Pulse Voltage:Pulse Voltage Level', 'name': 'PULSE_VOLTAGE_LEVEL', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the pulse current limit, in amps, that the output cannot exceed when generating the desired pulse voltage on the specified channel(s) during the on phase of a pulse. -This attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_PULSE_VOLTAGE. -Valid Values: The valid values for this attribute are defined by the values you specify for the NIDCPOWER_ATTR_PULSE_CURRENT_LIMIT_RANGE attribute. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150081: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the pulse current limit, in amps, that the output cannot exceed when generating the desired pulse voltage on the specified channel(s) during the on phase of a pulse.\nThis attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_PULSE_VOLTAGE and the NIDCPOWER_ATTR_COMPLIANCE_LIMIT_SYMMETRY attribute is set to NIDCPOWER_VAL_SYMMETRIC.\nValid Values: The valid values for this attribute are defined by the values you specify for the NIDCPOWER_ATTR_PULSE_CURRENT_LIMIT_RANGE attribute.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.' + }, 'lv_property': 'Source:Pulse Voltage:Pulse Current Limit', 'name': 'PULSE_CURRENT_LIMIT', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the pulse current limit, in amps, that the output cannot exceed when generating the desired pulse voltage on the specified channel(s) during the on phase of a pulse. -This attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_PULSE_VOLTAGE and the NIDCPOWER_ATTR_COMPLIANCE_LIMIT_SYMMETRY attribute is set to NIDCPOWER_VAL_SYMMETRIC. -Valid Values: The valid values for this attribute are defined by the values you specify for the NIDCPOWER_ATTR_PULSE_CURRENT_LIMIT_RANGE attribute. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150082: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the pulse bias voltage level, in volts, that the device attempts to generate on the specified channel(s) during the off phase of a pulse.\nThis attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_PULSE_VOLTAGE.\nValid Values: The valid values for this attribute are defined by the values you specify for the NIDCPOWER_ATTR_PULSE_VOLTAGE_LEVEL_RANGE attribute.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.' + }, 'lv_property': 'Source:Pulse Voltage:Pulse Bias Voltage Level', 'name': 'PULSE_BIAS_VOLTAGE_LEVEL', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the pulse bias voltage level, in volts, that the device attempts to generate on the specified channel(s) during the off phase of a pulse. -This attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_PULSE_VOLTAGE. -Valid Values: The valid values for this attribute are defined by the values you specify for the NIDCPOWER_ATTR_PULSE_VOLTAGE_LEVEL_RANGE attribute. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150083: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the pulse bias current limit, in amps, that the output cannot exceed when generating the desired pulse bias voltage on the specified channel(s) during the off phase of a pulse.\nThis attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_PULSE_VOLTAGE.\nValid Values: The valid values for this attribute are defined by the values you specify for the NIDCPOWER_ATTR_PULSE_CURRENT_LIMIT_RANGE property.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.' + }, 'lv_property': 'Source:Pulse Voltage:Pulse Bias Current Limit', 'name': 'PULSE_BIAS_CURRENT_LIMIT', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the pulse bias current limit, in amps, that the output cannot exceed when generating the desired pulse bias voltage on the specified channel(s) during the off phase of a pulse. -This attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_PULSE_VOLTAGE. -Valid Values: The valid values for this attribute are defined by the values you specify for the NIDCPOWER_ATTR_PULSE_CURRENT_LIMIT_RANGE property. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150084: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the pulse voltage level range, in volts, for the specified channel(s).\nThe range defines the valid values at which you can set the pulse voltage level and pulse bias voltage level.\nThis attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_PULSE_VOLTAGE.\nFor valid ranges, refer to the ranges topic for your device in the NI DC Power Supplies and SMUs Help.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.' + }, 'lv_property': 'Source:Pulse Voltage:Pulse Voltage Level Range', 'name': 'PULSE_VOLTAGE_LEVEL_RANGE', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the pulse voltage level range, in volts, for the specified channel(s). -The range defines the valid values at which you can set the pulse voltage level and pulse bias voltage level. -This attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_PULSE_VOLTAGE. -For valid ranges, refer to the ranges topic for your device in the NI DC Power Supplies and SMUs Help. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150085: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the pulse current limit range, in amps, for the specified channel(s).\nThe range defines the valid values to which you can set the pulse current limit and pulse bias current limit.\nThis attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_PULSE_VOLTAGE.\nFor valid ranges, refer to the ranges topic for your device in the NI DC Power Supplies and SMUs Help.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.' + }, 'lv_property': 'Source:Pulse Voltage:Pulse Current Limit Range', 'name': 'PULSE_CURRENT_LIMIT_RANGE', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the pulse current limit range, in amps, for the specified channel(s). -The range defines the valid values to which you can set the pulse current limit and pulse bias current limit. -This attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_PULSE_VOLTAGE. -For valid ranges, refer to the ranges topic for your device in the NI DC Power Supplies and SMUs Help. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150086: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the pulse current level, in amps, that the device attempts to generate on the specified channel(s) during the on phase of a pulse.\nThis attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_PULSE_CURRENT.\nValid Values: The valid values for this attribute are defined by the values you specify for the NIDCPOWER_ATTR_PULSE_CURRENT_LEVEL_RANGE attribute.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.' + }, 'lv_property': 'Source:Pulse Current:Pulse Current Level', 'name': 'PULSE_CURRENT_LEVEL', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the pulse current level, in amps, that the device attempts to generate on the specified channel(s) during the on phase of a pulse. -This attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_PULSE_CURRENT. -Valid Values: The valid values for this attribute are defined by the values you specify for the NIDCPOWER_ATTR_PULSE_CURRENT_LEVEL_RANGE attribute. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150087: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the pulse voltage limit, in volts, that the output cannot exceed when generating the desired pulse current on the specified channel(s) during the on phase of a pulse.\nThis attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_PULSE_CURRENT and the NIDCPOWER_ATTR_COMPLIANCE_LIMIT_SYMMETRY attribute is set to NIDCPOWER_VAL_SYMMETRIC.\nValid Values: The valid values for this attribute are defined by the values you specify for the NIDCPOWER_ATTR_PULSE_VOLTAGE_LIMIT_RANGE attribute.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.' + }, 'lv_property': 'Source:Pulse Current:Pulse Voltage Limit', 'name': 'PULSE_VOLTAGE_LIMIT', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the pulse voltage limit, in volts, that the output cannot exceed when generating the desired pulse current on the specified channel(s) during the on phase of a pulse. -This attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_PULSE_CURRENT and the NIDCPOWER_ATTR_COMPLIANCE_LIMIT_SYMMETRY attribute is set to NIDCPOWER_VAL_SYMMETRIC. -Valid Values: The valid values for this attribute are defined by the values you specify for the NIDCPOWER_ATTR_PULSE_VOLTAGE_LIMIT_RANGE attribute. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150088: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the pulse bias current level, in amps, that the device attempts to generate on the specified channel(s) during the off phase of a pulse.\nThis attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_PULSE_CURRENT.\nValid Values: The valid values for this attribute are defined by the values you specify for the NIDCPOWER_ATTR_PULSE_CURRENT_LEVEL_RANGE attribute.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.' + }, 'lv_property': 'Source:Pulse Current:Pulse Bias Current Level', 'name': 'PULSE_BIAS_CURRENT_LEVEL', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the pulse bias current level, in amps, that the device attempts to generate on the specified channel(s) during the off phase of a pulse. -This attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_PULSE_CURRENT. -Valid Values: The valid values for this attribute are defined by the values you specify for the NIDCPOWER_ATTR_PULSE_CURRENT_LEVEL_RANGE attribute. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150089: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the pulse voltage limit, in volts, that the output cannot exceed when generating the desired current on the specified channel(s) during the off phase of a pulse.\nThis attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_PULSE_CURRENT.\nValid Values: The valid values for this attribute are defined by the values you specify for the NIDCPOWER_ATTR_PULSE_VOLTAGE_LIMIT_RANGE attribute.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.' + }, 'lv_property': 'Source:Pulse Current:Pulse Bias Voltage Limit', 'name': 'PULSE_BIAS_VOLTAGE_LIMIT', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the pulse voltage limit, in volts, that the output cannot exceed when generating the desired current on the specified channel(s) during the off phase of a pulse. -This attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_PULSE_CURRENT. -Valid Values: The valid values for this attribute are defined by the values you specify for the NIDCPOWER_ATTR_PULSE_VOLTAGE_LIMIT_RANGE attribute. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150090: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the pulse current level range, in amps, for the specified channel(s).\nThe range defines the valid values to which you can set the pulse current level and pulse bias current level.\nThis attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_PULSE_CURRENT.\nFor valid ranges, refer to the ranges topic for your device in the NI DC Power Supplies and SMUs Help.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.' + }, 'lv_property': 'Source:Pulse Current:Pulse Current Level Range', 'name': 'PULSE_CURRENT_LEVEL_RANGE', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the pulse current level range, in amps, for the specified channel(s). -The range defines the valid values to which you can set the pulse current level and pulse bias current level. -This attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_PULSE_CURRENT. -For valid ranges, refer to the ranges topic for your device in the NI DC Power Supplies and SMUs Help. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150091: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the pulse voltage limit range, in volts, for the specified channel(s).\nThe range defines the valid values to which you can set the pulse voltage limit and pulse bias voltage limit.\nThis attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_PULSE_CURRENT.\nFor valid ranges, refer to the ranges topic for your device in the NI DC Power Supplies and SMUs Help.\n', + 'note': 'The channel must be enabled for the specified current limit to take effect. Refer to the NIDCPOWER_ATTR_OUTPUT_ENABLED attribute for more information about enabling the output channel.' + }, 'lv_property': 'Source:Pulse Current:Pulse Voltage Limit Range', 'name': 'PULSE_VOLTAGE_LIMIT_RANGE', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the pulse voltage limit range, in volts, for the specified channel(s). -The range defines the valid values to which you can set the pulse voltage limit and pulse bias voltage limit. -This attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_PULSE_CURRENT. -For valid ranges, refer to the ranges topic for your device in the NI DC Power Supplies and SMUs Help. -''', -'note': 'The channel must be enabled for the specified current limit to take effect. Refer to the NIDCPOWER_ATTR_OUTPUT_ENABLED attribute for more information about enabling the output channel.', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150092: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nDetermines when, in seconds, the device generates the Pulse Complete event after generating the off level of a pulse.\nValid Values: 0 to 167 seconds\nDefault Value: 16.67 milliseconds\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.' + }, 'lv_property': 'Source:Advanced:Pulse Bias Delay', 'name': 'PULSE_BIAS_DELAY', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Determines when, in seconds, the device generates the Pulse Complete event after generating the off level of a pulse. -Valid Values: 0 to 167 seconds -Default Value: 16.67 milliseconds -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150093: { 'access': 'read-write', - 'channel_based': 'True', + 'attribute_class': 'AttributeViReal64TimeDeltaSeconds', + 'channel_based': True, + 'documentation': { + 'description': '\nDetermines the length, in seconds, of the on phase of a pulse.\nValid Values: 10 microseconds to 167 seconds\nDefault Value: 34 milliseconds\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.' + }, 'lv_property': 'Source:Advanced:Pulse On Time', 'name': 'PULSE_ON_TIME', - 'resettable': 'No', + 'resettable': False, 'type': 'ViReal64', -'documentation': { -'description': ''' -Determines the length, in seconds, of the on phase of a pulse. -Valid Values: 10 microseconds to 167 seconds -Default Value: 34 milliseconds -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.', -}, + 'type_in_documentation': 'float in seconds or datetime.timedelta' }, 1150094: { 'access': 'read-write', - 'channel_based': 'True', + 'attribute_class': 'AttributeViReal64TimeDeltaSeconds', + 'channel_based': True, + 'documentation': { + 'description': '\nDetermines the length, in seconds, of the off phase of a pulse.\nValid Values: 10 microseconds to 167 seconds\nDefault Value: 34 milliseconds\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.' + }, 'lv_property': 'Source:Advanced:Pulse Off Time', 'name': 'PULSE_OFF_TIME', - 'resettable': 'No', + 'resettable': False, 'type': 'ViReal64', -'documentation': { -'description': ''' -Determines the length, in seconds, of the off phase of a pulse. -Valid Values: 10 microseconds to 167 seconds -Default Value: 34 milliseconds -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.', -}, + 'type_in_documentation': 'float in seconds or datetime.timedelta' }, 1150095: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the behavior of the Pulse trigger.\nDefault Value: NIDCPOWER_VAL_NONE\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.' + }, 'enum': 'TriggerType', 'lv_property': 'Triggers:Pulse Trigger:Trigger Type', 'name': 'PULSE_TRIGGER_TYPE', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the behavior of the Pulse trigger. -Default Value: NIDCPOWER_VAL_NONE -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150096: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'codegen_method': 'no', + 'documentation': { + 'description': '\nSpecifies whether to configure the Pulse trigger to assert on the rising or falling edge.\nDefault Value: NIDCPOWER_VAL_RISING\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.' + }, 'enum': 'DigitalEdge', 'lv_property': 'Triggers:Pulse Trigger:Digital Edge:Edge', 'name': 'DIGITAL_EDGE_PULSE_TRIGGER_EDGE', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies whether to configure the Pulse trigger to assert on the rising or falling edge. -Default Value: NIDCPOWER_VAL_RISING -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150097: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the input terminal for the Pulse trigger. This attribute is used only when the NIDCPOWER_ATTR_PULSE_TRIGGER_TYPE attribute is set to digital edge.\nYou can specify any valid input terminal for this attribute. Valid terminals are listed in Measurement & Automation Explorer under the Device Routes tab.\nInput terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0. The input terminal can also be a terminal from another device. For example, you can set the input terminal on Dev1 to be /Dev2/SourceCompleteEvent.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.' + }, 'lv_property': 'Triggers:Pulse Trigger:Digital Edge:Input Terminal', 'name': 'DIGITAL_EDGE_PULSE_TRIGGER_INPUT_TERMINAL', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': ''' -Specifies the input terminal for the Pulse trigger. This attribute is used only when the NIDCPOWER_ATTR_PULSE_TRIGGER_TYPE attribute is set to digital edge. -You can specify any valid input terminal for this attribute. Valid terminals are listed in Measurement & Automation Explorer under the Device Routes tab. -Input terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0. The input terminal can also be a terminal from another device. For example, you can set the input terminal on Dev1 to be /Dev2/SourceCompleteEvent. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.', -}, + 'resettable': False, + 'type': 'ViString' }, 1150098: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the output terminal for exporting the Pulse trigger.\nRefer to the Device Routes tab in Measurement & Automation Explorer for a list of the terminals available on your device.\nOutput terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.' + }, 'lv_property': 'Triggers:Pulse Trigger:Export Output Terminal', 'name': 'EXPORTED_PULSE_TRIGGER_OUTPUT_TERMINAL', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': ''' -Specifies the output terminal for exporting the Pulse trigger. -Refer to the Device Routes tab in Measurement & Automation Explorer for a list of the terminals available on your device. -Output terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.', -}, + 'resettable': False, + 'type': 'ViString' }, 1150099: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the output terminal for exporting the Pulse Complete event.\nOutput terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0.\nDefault Value:The default value for PXI Express devices is 250 ns.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.' + }, 'lv_property': 'Events:Pulse Complete Event:Output Terminal', 'name': 'PULSE_COMPLETE_EVENT_OUTPUT_TERMINAL', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': ''' -Specifies the output terminal for exporting the Pulse Complete event. -Output terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0. -Default Value:The default value for PXI Express devices is 250 ns. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.', -}, + 'resettable': False, + 'type': 'ViString' }, 1150100: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the behavior of the Pulse Complete event.\nDefault Value: NIDCPOWER_VAL_ACTIVE_HIGH\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.' + }, 'enum': 'Polarity', 'lv_property': 'Events:Pulse Complete Event:Pulse:Polarity', 'name': 'PULSE_COMPLETE_EVENT_PULSE_POLARITY', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the behavior of the Pulse Complete event. -Default Value: NIDCPOWER_VAL_ACTIVE_HIGH -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150101: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the width of the Pulse Complete event, in seconds.\nThe minimum event pulse width value for PXI Express devices is 250 ns.\nThe maximum event pulse width value for PXI Express devices is 1.6 microseconds.\nDefault Value: The default value for PXI Express devices is 250 ns.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.' + }, 'lv_property': 'Events:Pulse Complete Event:Pulse:Width', 'name': 'PULSE_COMPLETE_EVENT_PULSE_WIDTH', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the width of the Pulse Complete event, in seconds. -The minimum event pulse width value for PXI Express devices is 250 ns. -The maximum event pulse width value for PXI Express devices is 1.6 microseconds. -Default Value: The default value for PXI Express devices is 250 ns. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150102: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the output terminal for exporting the Ready For Pulse Trigger event.\nOutput terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.' + }, 'lv_property': 'Events:Ready For Pulse Trigger Event:Output Terminal', 'name': 'READY_FOR_PULSE_TRIGGER_EVENT_OUTPUT_TERMINAL', - 'resettable': 'No', - 'type': 'ViString', -'documentation': { -'description': ''' -Specifies the output terminal for exporting the Ready For Pulse Trigger event. -Output terminals can be specified in one of two ways. If the device is named Dev1 and your terminal is PXI_Trig0, you can specify the terminal with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the shortened terminal name, PXI_Trig0. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.', -}, + 'resettable': False, + 'type': 'ViString' }, 1150103: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the behavior of the Ready For Pulse Trigger event.\nDefault Value: NIDCPOWER_VAL_ACTIVE_HIGH\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.' + }, 'enum': 'Polarity', 'lv_property': 'Events:Ready For Pulse Trigger Event:Pulse:Polarity', 'name': 'READY_FOR_PULSE_TRIGGER_EVENT_PULSE_POLARITY', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the behavior of the Ready For Pulse Trigger event. -Default Value: NIDCPOWER_VAL_ACTIVE_HIGH -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150104: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nSpecifies the width of the Ready For Pulse Trigger event, in seconds.\nThe minimum event pulse width value for PXI Express devices is 250 ns.\nThe maximum event pulse width value for all devices is 1.6 microseconds.\nDefault Value: The default value for PXI Express devices is 250 ns\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.' + }, 'lv_property': 'Events:Ready For Pulse Trigger Event:Pulse:Width', 'name': 'READY_FOR_PULSE_TRIGGER_EVENT_PULSE_WIDTH', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the width of the Ready For Pulse Trigger event, in seconds. -The minimum event pulse width value for PXI Express devices is 250 ns. -The maximum event pulse width value for all devices is 1.6 microseconds. -Default Value: The default value for PXI Express devices is 250 ns -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150105: { 'access': 'read only', - 'channel_based': 'False', - 'enum': 'tBoolean', + 'channel_based': False, + 'documentation': { + 'description': '\nIndicates whether the safety interlock circuit is open.\nRefer to the Safety Interlock topic in the NI DC Power Supplies and SMUs Help for more information about the safety interlock circuit.\nabout supported devices.\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information' + }, 'lv_property': 'Advanced:Interlock Input Open', 'name': 'INTERLOCK_INPUT_OPEN', - 'resettable': 'No', - 'type': 'ViBoolean', -'documentation': { -'description': ''' -Indicates whether the safety interlock circuit is open. -Refer to the Safety Interlock topic in the NI DC Power Supplies and SMUs Help for more information about the safety interlock circuit. -about supported devices. -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device for information', -}, + 'resettable': False, + 'type': 'ViBoolean' }, 1150184: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies whether compliance limits for current generation and voltage\ngeneration for the device are applied symmetrically about 0 V and 0 A or\nasymmetrically with respect to 0 V and 0 A.\nWhen set to **Symmetric**, voltage limits and current limits are set\nusing a single property with a positive value. The resulting range is\nbounded by this positive value and its opposite.\nWhen set to **Asymmetric**, you must separately set a limit high and a\nlimit low using distinct properties.\nFor asymmetric limits, the range bounded by the limit high and limit low\nmust include zero.\n**Default Value:** Symmetric\n**Related Topics:**\n`Compliance `__\n`Ranges `__\n`Changing\nRanges `__\n`Overranging `__\n', + 'note': '\nRefer to `Supported Properties by\nDevice `__ for\ninformation about supported devices.\n' + }, 'enum': 'ComplianceLimitSymmetry', 'lv_property': 'Source:Advanced:Compliance Limit Symmetry', 'name': 'COMPLIANCE_LIMIT_SYMMETRY', - 'resettable': 'No', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies whether compliance limits for current generation and voltage -generation for the device are applied symmetrically about 0 V and 0 A or -asymmetrically with respect to 0 V and 0 A. -When set to **Symmetric**, voltage limits and current limits are set -using a single property with a positive value. The resulting range is -bounded by this positive value and its opposite. -When set to **Asymmetric**, you must separately set a limit high and a -limit low using distinct properties. -For asymmetric limits, the range bounded by the limit high and limit low -must include zero. -**Default Value:** Symmetric -**Related Topics:** -`Compliance `__ -`Ranges `__ -`Changing -Ranges `__ -`Overranging `__ -''', -'note': ''' -Refer to `Supported Properties by -Device `__ for -information about supported devices. -''', -}, + 'resettable': False, + 'type': 'ViInt32' }, 1150185: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the maximum voltage, in volts, that the output can produce\nwhen generating the desired current on the specified channel(s).\nThis property is applicable only if the `Compliance Limit\nSymmetry `__ property is set to\n**Asymmetric** and the `Output\nFunction `__ property is set to **DC\nCurrent**.\nYou must also specify a `Voltage Limit\nLow `__ to complete the asymmetric\nrange.\n**Valid Values:** [1% of `Voltage Limit\nRange `__, `Voltage Limit\nRange `__]\nThe range bounded by the limit high and limit low must include zero.\n**Default Value:** Refer to `Supported Properties by\nDevice `__ for\nthe default value by device.\n**Related Topics:**\n`Ranges `__\n`Changing\nRanges `__\n`Overranging `__\n', + 'note': '\nThe limit may be extended beyond the selected limit range if the\n`Overranging Enabled `__ property is\nset to TRUE.\n' + }, 'lv_property': 'Source:DC Current:Voltage Limit High', 'name': 'VOLTAGE_LIMIT_HIGH', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the maximum voltage, in volts, that the output can produce -when generating the desired current on the specified channel(s). -This property is applicable only if the `Compliance Limit -Symmetry `__ property is set to -**Asymmetric** and the `Output -Function `__ property is set to **DC -Current**. -You must also specify a `Voltage Limit -Low `__ to complete the asymmetric -range. -**Valid Values:** [1% of `Voltage Limit -Range `__, `Voltage Limit -Range `__] -The range bounded by the limit high and limit low must include zero. -**Default Value:** Refer to `Supported Properties by -Device `__ for -the default value by device. -**Related Topics:** -`Ranges `__ -`Changing -Ranges `__ -`Overranging `__ -''', -'note': ''' -The limit may be extended beyond the selected limit range if the -`Overranging Enabled `__ property is -set to TRUE. -''', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150186: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the minimum voltage, in volts, that the output can produce\nwhen generating the desired current on the specified channel(s).\nThis property is applicable only if the `Compliance Limit\nSymmetry `__ property is set to\n**Asymmetric** and the `Output\nFunction `__ property is set to **DC\nCurrent**.\nYou must also specify a `Voltage Limit\nHigh `__ to complete the asymmetric\nrange.\n**Valid Values:** [-`Voltage Limit\nRange `__, -1% of `Voltage Limit\nRange `__]\nThe range bounded by the limit high and limit low must include zero.\n**Default Value:** Refer to `Supported Properties by\nDevice `__ for\nthe default value by device.\n**Related Topics:**\n`Ranges `__\n`Changing\nRanges `__\n`Overranging `__\n', + 'note': '\nThe limit may be extended beyond the selected limit range if the\n`Overranging Enabled `__ property is\nset to TRUE.\n' + }, 'lv_property': 'Source:DC Current:Voltage Limit Low', 'name': 'VOLTAGE_LIMIT_LOW', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the minimum voltage, in volts, that the output can produce -when generating the desired current on the specified channel(s). -This property is applicable only if the `Compliance Limit -Symmetry `__ property is set to -**Asymmetric** and the `Output -Function `__ property is set to **DC -Current**. -You must also specify a `Voltage Limit -High `__ to complete the asymmetric -range. -**Valid Values:** [-`Voltage Limit -Range `__, -1% of `Voltage Limit -Range `__] -The range bounded by the limit high and limit low must include zero. -**Default Value:** Refer to `Supported Properties by -Device `__ for -the default value by device. -**Related Topics:** -`Ranges `__ -`Changing -Ranges `__ -`Overranging `__ -''', -'note': ''' -The limit may be extended beyond the selected limit range if the -`Overranging Enabled `__ property is -set to TRUE. -''', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150187: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the maximum current, in amps, that the output can produce when\ngenerating the desired voltage on the specified channel(s).\nThis property is applicable only if the `Compliance Limit\nSymmetry `__ property is set to\n**Asymmetric** and the `Output\nFunction `__ property is set to **DC\nVoltage**.\nYou must also specify a `Current Limit\nLow `__ to complete the asymmetric\nrange.\n**Valid Values:** [1% of `Current Limit\nRange `__, `Current Limit\nRange `__]\nThe range bounded by the limit high and limit low must include zero.\n**Default Value:** Refer to `Supported Properties by\nDevice `__ for\nthe default value by device.\n**Related Topics:**\n`Ranges `__\n`Changing\nRanges `__\n`Overranging `__\n', + 'note': '\nThe limit may be extended beyond the selected limit range if the\n`Overranging Enabled `__ property is\nset to TRUE.\n' + }, 'lv_property': 'Source:DC Voltage:Current Limit High', 'name': 'CURRENT_LIMIT_HIGH', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the maximum current, in amps, that the output can produce when -generating the desired voltage on the specified channel(s). -This property is applicable only if the `Compliance Limit -Symmetry `__ property is set to -**Asymmetric** and the `Output -Function `__ property is set to **DC -Voltage**. -You must also specify a `Current Limit -Low `__ to complete the asymmetric -range. -**Valid Values:** [1% of `Current Limit -Range `__, `Current Limit -Range `__] -The range bounded by the limit high and limit low must include zero. -**Default Value:** Refer to `Supported Properties by -Device `__ for -the default value by device. -**Related Topics:** -`Ranges `__ -`Changing -Ranges `__ -`Overranging `__ -''', -'note': ''' -The limit may be extended beyond the selected limit range if the -`Overranging Enabled `__ property is -set to TRUE. -''', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150188: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the minimum current, in amps, that the output can produce when\ngenerating the desired voltage on the specified channel(s).\nThis property is applicable only if the `Compliance Limit\nSymmetry `__ property is set to\n**Asymmetric** and the `Output\nFunction `__ property is set to **DC\nVoltage**.\nYou must also specify a `Current Limit\nHigh `__ to complete the asymmetric\nrange.\n**Valid Values:** [-`Current Limit\nRange `__, -1% of `Current Limit\nRange `__]\nThe range bounded by the limit high and limit low must include zero.\n**Default Value:** Refer to `Supported Properties by\nDevice `__ for\nthe default value by device.\n**Related Topics:**\n`Ranges `__\n`Changing\nRanges `__\n`Overranging `__\n', + 'note': '\nThe limit may be extended beyond the selected limit range if the\n`Overranging Enabled `__ property is\nset to TRUE.\n' + }, 'lv_property': 'Source:DC Voltage:Current Limit Low', 'name': 'CURRENT_LIMIT_LOW', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the minimum current, in amps, that the output can produce when -generating the desired voltage on the specified channel(s). -This property is applicable only if the `Compliance Limit -Symmetry `__ property is set to -**Asymmetric** and the `Output -Function `__ property is set to **DC -Voltage**. -You must also specify a `Current Limit -High `__ to complete the asymmetric -range. -**Valid Values:** [-`Current Limit -Range `__, -1% of `Current Limit -Range `__] -The range bounded by the limit high and limit low must include zero. -**Default Value:** Refer to `Supported Properties by -Device `__ for -the default value by device. -**Related Topics:** -`Ranges `__ -`Changing -Ranges `__ -`Overranging `__ -''', -'note': ''' -The limit may be extended beyond the selected limit range if the -`Overranging Enabled `__ property is -set to TRUE. -''', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150189: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the maximum voltage, in volts, that the output can produce\nwhen generating the desired pulse current on the specified channel(s)\nduring the *on* phase of a pulse.\nThis property is applicable only if the `Compliance Limit\nSymmetry `__ property is set to\n**Asymmetric** and the `Output\nFunction `__ property is set to **Pulse\nCurrent**.\nYou must also specify a `Pulse Voltage Limit\nLow `__ to complete the asymmetric\nrange.\n**Valid Values:** [1% of `Pulse Voltage Limit\nRange `__, `Pulse Voltage Limit\nRange `__]\nThe range bounded by the limit high and limit low must include zero.\n**Default Value:** Refer to `Supported Properties by\nDevice `__ for\nthe default value by device.\n**Related Topics:**\n`Ranges `__\n`Changing\nRanges `__\n`Overranging `__\n', + 'note': '\nThe limit may be extended beyond the selected limit range if the\n`Overranging Enabled `__ property is\nset to TRUE or if the `Output\nFunction `__ property is set to a\npulsing function.\n' + }, 'lv_property': 'Source:Pulse Current:Pulse Voltage Limit High', 'name': 'PULSE_VOLTAGE_LIMIT_HIGH', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the maximum voltage, in volts, that the output can produce -when generating the desired pulse current on the specified channel(s) -during the *on* phase of a pulse. -This property is applicable only if the `Compliance Limit -Symmetry `__ property is set to -**Asymmetric** and the `Output -Function `__ property is set to **Pulse -Current**. -You must also specify a `Pulse Voltage Limit -Low `__ to complete the asymmetric -range. -**Valid Values:** [1% of `Pulse Voltage Limit -Range `__, `Pulse Voltage Limit -Range `__] -The range bounded by the limit high and limit low must include zero. -**Default Value:** Refer to `Supported Properties by -Device `__ for -the default value by device. -**Related Topics:** -`Ranges `__ -`Changing -Ranges `__ -`Overranging `__ -''', -'note': ''' -The limit may be extended beyond the selected limit range if the -`Overranging Enabled `__ property is -set to TRUE or if the `Output -Function `__ property is set to a -pulsing function. -''', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150190: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the minimum voltage, in volts, that the output can produce\nwhen generating the desired pulse current on the specified channel(s)\nduring the *on* phase of a pulse.\nThis property is applicable only if the `Compliance Limit\nSymmetry `__ property is set to\n**Asymmetric** and the `Output\nFunction `__ property is set to **Pulse\nCurrent**.\nYou must also specify a `Pulse Voltage Limit\nHigh `__ to complete the\nasymmetric range.\n**Valid Values:** [-`Pulse Voltage Limit\nRange `__, -1% of `Pulse Voltage\nLimit Range `__]\nThe range bounded by the limit high and limit low must include zero.\n**Default Value:** Refer to `Supported Properties by\nDevice `__ for\nthe default value by device.\n**Related Topics:**\n`Ranges `__\n`Changing\nRanges `__\n`Overranging `__\n', + 'note': '\nThe limit may be extended beyond the selected limit range if the\n`Overranging Enabled `__ property is\nset to TRUE or if the `Output\nFunction `__ property is set to a\npulsing function.\n' + }, 'lv_property': 'Source:Pulse Current:Pulse Voltage Limit Low', 'name': 'PULSE_VOLTAGE_LIMIT_LOW', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the minimum voltage, in volts, that the output can produce -when generating the desired pulse current on the specified channel(s) -during the *on* phase of a pulse. -This property is applicable only if the `Compliance Limit -Symmetry `__ property is set to -**Asymmetric** and the `Output -Function `__ property is set to **Pulse -Current**. -You must also specify a `Pulse Voltage Limit -High `__ to complete the -asymmetric range. -**Valid Values:** [-`Pulse Voltage Limit -Range `__, -1% of `Pulse Voltage -Limit Range `__] -The range bounded by the limit high and limit low must include zero. -**Default Value:** Refer to `Supported Properties by -Device `__ for -the default value by device. -**Related Topics:** -`Ranges `__ -`Changing -Ranges `__ -`Overranging `__ -''', -'note': ''' -The limit may be extended beyond the selected limit range if the -`Overranging Enabled `__ property is -set to TRUE or if the `Output -Function `__ property is set to a -pulsing function. -''', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150191: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the maximum voltage, in volts, that the output can produce\nwhen generating the desired pulse current on the specified channel(s)\nduring the *off* phase of a pulse.\nThis property is applicable only if the `Compliance Limit\nSymmetry `__ property is set to\n**Asymmetric** and the `Output\nFunction `__ property is set to **Pulse\nCurrent**.\nYou must also specify a `Pulse Bias Voltage Limit\nLow `__ to complete the\nasymmetric range.\n**Valid Values:** [1% of `Pulse Voltage Limit\nRange `__, `Pulse Voltage Limit\nRange `__]\nThe range bounded by the limit high and limit low must include zero.\n**Default Value:** Refer to `Supported Properties by\nDevice `__ for\nthe default value by device.\n**Related Topics:**\n`Ranges `__\n`Changing\nRanges `__\n`Overranging `__\n', + 'note': '\nThe limit may be extended beyond the selected limit range if the\n`Overranging Enabled `__ property is\nset to TRUE or if the `Output\nFunction `__ property is set to a\npulsing function.\n' + }, 'lv_property': 'Source:Pulse Current:Pulse Bias Voltage Limit High', 'name': 'PULSE_BIAS_VOLTAGE_LIMIT_HIGH', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the maximum voltage, in volts, that the output can produce -when generating the desired pulse current on the specified channel(s) -during the *off* phase of a pulse. -This property is applicable only if the `Compliance Limit -Symmetry `__ property is set to -**Asymmetric** and the `Output -Function `__ property is set to **Pulse -Current**. -You must also specify a `Pulse Bias Voltage Limit -Low `__ to complete the -asymmetric range. -**Valid Values:** [1% of `Pulse Voltage Limit -Range `__, `Pulse Voltage Limit -Range `__] -The range bounded by the limit high and limit low must include zero. -**Default Value:** Refer to `Supported Properties by -Device `__ for -the default value by device. -**Related Topics:** -`Ranges `__ -`Changing -Ranges `__ -`Overranging `__ -''', -'note': ''' -The limit may be extended beyond the selected limit range if the -`Overranging Enabled `__ property is -set to TRUE or if the `Output -Function `__ property is set to a -pulsing function. -''', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150192: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the minimum voltage, in volts, that the output can produce\nwhen generating the desired pulse current on the specified channel(s)\nduring the *off* phase of a pulse.\nThis property is applicable only if the `Compliance Limit\nSymmetry `__ property is set to\n**Asymmetric** and the `Output\nFunction `__ property is set to **Pulse\nCurrent**.\nYou must also specify a `Pulse Bias Voltage Limit\nHigh `__ to complete the\nasymmetric range.\n**Valid Values:** [-`Pulse Voltage Limit\nRange `__, -1% of `Pulse Voltage\nLimit Range `__]\nThe range bounded by the limit high and limit low must include zero.\n**Default Value:** Refer to `Supported Properties by\nDevice `__ for\nthe default value by device.\n**Related Topics:**\n`Ranges `__\n`Changing\nRanges `__\n`Overranging `__\n', + 'note': '\nThe limit may be extended beyond the selected limit range if the\n`Overranging Enabled `__ property is\nset to TRUE or if the `Output\nFunction `__ property is set to a\npulsing function.\n' + }, 'lv_property': 'Source:Pulse Current:Pulse Bias Voltage Limit Low', 'name': 'PULSE_BIAS_VOLTAGE_LIMIT_LOW', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the minimum voltage, in volts, that the output can produce -when generating the desired pulse current on the specified channel(s) -during the *off* phase of a pulse. -This property is applicable only if the `Compliance Limit -Symmetry `__ property is set to -**Asymmetric** and the `Output -Function `__ property is set to **Pulse -Current**. -You must also specify a `Pulse Bias Voltage Limit -High `__ to complete the -asymmetric range. -**Valid Values:** [-`Pulse Voltage Limit -Range `__, -1% of `Pulse Voltage -Limit Range `__] -The range bounded by the limit high and limit low must include zero. -**Default Value:** Refer to `Supported Properties by -Device `__ for -the default value by device. -**Related Topics:** -`Ranges `__ -`Changing -Ranges `__ -`Overranging `__ -''', -'note': ''' -The limit may be extended beyond the selected limit range if the -`Overranging Enabled `__ property is -set to TRUE or if the `Output -Function `__ property is set to a -pulsing function. -''', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150193: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the maximum current, in amps, that the output can produce when\ngenerating the desired pulse voltage on the specified channel(s) during\nthe *on* phase of a pulse.\nThis property is applicable only if the `Compliance Limit\nSymmetry `__ property is set to\n**Asymmetric** and the `Output\nFunction `__ property is set to **Pulse\nVoltage**.\nYou must also specify a `Pulse Current Limit\nLow `__ to complete the asymmetric\nrange.\n**Valid Values:** [1% of `Pulse Current Limit\nRange `__, `Pulse Current Limit\nRange `__]\nThe range bounded by the limit high and limit low must include zero.\n**Default Value:** Refer to `Supported Properties by\nDevice `__ for\nthe default value by device.\n**Related Topics:**\n`Ranges `__\n`Changing\nRanges `__\n`Overranging `__\n', + 'note': '\nThe limit may be extended beyond the selected limit range if the\n`Overranging Enabled `__ property is\nset to TRUE or if the `Output\nFunction `__ property is set to a\npulsing function.\n' + }, 'lv_property': 'Source:Pulse Voltage:Pulse Current Limit High', 'name': 'PULSE_CURRENT_LIMIT_HIGH', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the maximum current, in amps, that the output can produce when -generating the desired pulse voltage on the specified channel(s) during -the *on* phase of a pulse. -This property is applicable only if the `Compliance Limit -Symmetry `__ property is set to -**Asymmetric** and the `Output -Function `__ property is set to **Pulse -Voltage**. -You must also specify a `Pulse Current Limit -Low `__ to complete the asymmetric -range. -**Valid Values:** [1% of `Pulse Current Limit -Range `__, `Pulse Current Limit -Range `__] -The range bounded by the limit high and limit low must include zero. -**Default Value:** Refer to `Supported Properties by -Device `__ for -the default value by device. -**Related Topics:** -`Ranges `__ -`Changing -Ranges `__ -`Overranging `__ -''', -'note': ''' -The limit may be extended beyond the selected limit range if the -`Overranging Enabled `__ property is -set to TRUE or if the `Output -Function `__ property is set to a -pulsing function. -''', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150194: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the minimum current, in amps, that the output can produce when\ngenerating the desired pulse voltage on the specified channel(s) during\nthe *on* phase of a pulse.\nThis property is applicable only if the `Compliance Limit\nSymmetry `__ property is set to\n**Asymmetric** and the `Output\nFunction `__ property is set to **Pulse\nVoltage**.\nYou must also specify a `Pulse Current Limit\nHigh `__ to complete the\nasymmetric range.\n**Valid Values:** [-`Pulse Current Limit\nRange `__, -1% of `Pulse Current\nLimit Range `__]\nThe range bounded by the limit high and limit low must include zero.\n**Default Value:** Refer to `Supported Properties by\nDevice `__ for\nthe default value by device.\n**Related Topics:**\n`Ranges `__\n`Changing\nRanges `__\n`Overranging `__\n', + 'note': '\nThe limit may be extended beyond the selected limit range if the\n`Overranging Enabled `__ property is\nset to TRUE or if the `Output\nFunction `__ property is set to a\npulsing function.\n' + }, 'lv_property': 'Source:Pulse Voltage:Pulse Current Limit Low', 'name': 'PULSE_CURRENT_LIMIT_LOW', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the minimum current, in amps, that the output can produce when -generating the desired pulse voltage on the specified channel(s) during -the *on* phase of a pulse. -This property is applicable only if the `Compliance Limit -Symmetry `__ property is set to -**Asymmetric** and the `Output -Function `__ property is set to **Pulse -Voltage**. -You must also specify a `Pulse Current Limit -High `__ to complete the -asymmetric range. -**Valid Values:** [-`Pulse Current Limit -Range `__, -1% of `Pulse Current -Limit Range `__] -The range bounded by the limit high and limit low must include zero. -**Default Value:** Refer to `Supported Properties by -Device `__ for -the default value by device. -**Related Topics:** -`Ranges `__ -`Changing -Ranges `__ -`Overranging `__ -''', -'note': ''' -The limit may be extended beyond the selected limit range if the -`Overranging Enabled `__ property is -set to TRUE or if the `Output -Function `__ property is set to a -pulsing function. -''', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150195: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the maximum current, in amps, that the output can produce when\ngenerating the desired pulse voltage on the specified channel(s) during\nthe *off* phase of a pulse.\nThis property is applicable only if the `Compliance Limit\nSymmetry `__ property is set to\n**Asymmetric** and the `Output\nFunction `__ property is set to **Pulse\nVoltage**.\nYou must also specify a `Pulse Bias Current Limit\nLow `__ to complete the\nasymmetric range.\n**Valid Values:** [1% of `Pulse Current Limit\nRange `__, `Pulse Current Limit\nRange `__]\nThe range bounded by the limit high and limit low must include zero.\n**Default Value:** Refer to `Supported Properties by\nDevice `__ for\nthe default value by device.\n**Related Topics:**\n`Ranges `__\n`Changing\nRanges `__\n`Overranging `__\n', + 'note': '\nThe limit may be extended beyond the selected limit range if the\n`Overranging Enabled `__ property is\nset to TRUE or if the `Output\nFunction `__ property is set to a\npulsing function.\n' + }, 'lv_property': 'Source:Pulse Voltage:Pulse Bias Current Limit High', 'name': 'PULSE_BIAS_CURRENT_LIMIT_HIGH', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the maximum current, in amps, that the output can produce when -generating the desired pulse voltage on the specified channel(s) during -the *off* phase of a pulse. -This property is applicable only if the `Compliance Limit -Symmetry `__ property is set to -**Asymmetric** and the `Output -Function `__ property is set to **Pulse -Voltage**. -You must also specify a `Pulse Bias Current Limit -Low `__ to complete the -asymmetric range. -**Valid Values:** [1% of `Pulse Current Limit -Range `__, `Pulse Current Limit -Range `__] -The range bounded by the limit high and limit low must include zero. -**Default Value:** Refer to `Supported Properties by -Device `__ for -the default value by device. -**Related Topics:** -`Ranges `__ -`Changing -Ranges `__ -`Overranging `__ -''', -'note': ''' -The limit may be extended beyond the selected limit range if the -`Overranging Enabled `__ property is -set to TRUE or if the `Output -Function `__ property is set to a -pulsing function. -''', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1150196: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the minimum current, in amps, that the output can produce when\ngenerating the desired pulse voltage on the specified channel(s) during\nthe *off* phase of a pulse.\nThis property is applicable only if the `Compliance Limit\nSymmetry `__ property is set to\n**Asymmetric** and the `Output\nFunction `__ property is set to **Pulse\nVoltage**.\nYou must also specify a `Pulse Bias Current Limit\nHigh `__ to complete the\nasymmetric range.\n**Valid Values:** [-`Pulse Current Limit\nRange `__, -1% of `Pulse Current\nLimit Range `__]\nThe range bounded by the limit high and limit low must include zero.\n**Default Value:** Refer to `Supported Properties by\nDevice `__ for\nthe default value by device.\n**Related Topics:**\n`Ranges `__\n`Changing\nRanges `__\n`Overranging `__\n', + 'note': '\nThe limit may be extended beyond the selected limit range if the\n`Overranging Enabled `__ property is\nset to TRUE or if the `Output\nFunction `__ property is set to a\npulsing function.\n' + }, 'lv_property': 'Source:Pulse Voltage:Pulse Bias Current Limit Low', 'name': 'PULSE_BIAS_CURRENT_LIMIT_LOW', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the minimum current, in amps, that the output can produce when -generating the desired pulse voltage on the specified channel(s) during -the *off* phase of a pulse. -This property is applicable only if the `Compliance Limit -Symmetry `__ property is set to -**Asymmetric** and the `Output -Function `__ property is set to **Pulse -Voltage**. -You must also specify a `Pulse Bias Current Limit -High `__ to complete the -asymmetric range. -**Valid Values:** [-`Pulse Current Limit -Range `__, -1% of `Pulse Current -Limit Range `__] -The range bounded by the limit high and limit low must include zero. -**Default Value:** Refer to `Supported Properties by -Device `__ for -the default value by device. -**Related Topics:** -`Ranges `__ -`Changing -Ranges `__ -`Overranging `__ -''', -'note': ''' -The limit may be extended beyond the selected limit range if the -`Overranging Enabled `__ property is -set to TRUE or if the `Output -Function `__ property is set to a -pulsing function. -''', -}, + 'resettable': False, + 'type': 'ViReal64' + }, + 1150198: { + 'access': 'read-write', + 'channel_based': True, + 'name': 'SEQUENCE_STEP_DELTA_TIME', + 'resettable': False, + 'type': 'ViReal64' + }, + 1150199: { + 'access': 'read-write', + 'channel_based': True, + 'name': 'SEQUENCE_STEP_DELTA_TIME_ENABLED', + 'resettable': False, + 'type': 'ViReal64' }, 1250001: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the voltage level, in volts, that the device attempts to generate on the specified channel(s).\nThis attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_VOLTAGE.\nNIDCPOWER_ATTR_OUTPUT_ENABLED attribute for more information about enabling the output channel.\nValid Values: The valid values for this attribute are defined by the values you specify for the NIDCPOWER_ATTR_VOLTAGE_LEVEL_RANGE attribute.\n', + 'note': 'The channel must be enabled for the specified voltage level to take effect. Refer to the' + }, 'lv_property': 'Source:DC Voltage:Voltage Level', 'name': 'VOLTAGE_LEVEL', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the voltage level, in volts, that the device attempts to generate on the specified channel(s). -This attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_VOLTAGE. -NIDCPOWER_ATTR_OUTPUT_ENABLED attribute for more information about enabling the output channel. -Valid Values: The valid values for this attribute are defined by the values you specify for the NIDCPOWER_ATTR_VOLTAGE_LEVEL_RANGE attribute. -''', -'note': 'The channel must be enabled for the specified voltage level to take effect. Refer to the', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1250002: { 'access': 'read-write', - 'channel_based': 'False', - 'enum': 'tBoolean', + 'channel_based': False, + 'documentation': { + 'description': '\nEnables (VI_TRUE) or disables (VI_FALSE) overvoltage protection (OVP).\nRefer to the Output Overvoltage Protection topic in the NI DC Power Supplies and SMUs Help for more information about overvoltage protection.\nfor information about supported devices.\nDefault Value: VI_FALSE\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'lv_property': 'Source:Advanced:OVP Enabled', 'name': 'OVP_ENABLED', - 'resettable': 'No', - 'type': 'ViBoolean', -'documentation': { -'description': ''' -Enables (VI_TRUE) or disables (VI_FALSE) overvoltage protection (OVP). -Refer to the Output Overvoltage Protection topic in the NI DC Power Supplies and SMUs Help for more information about overvoltage protection. -for information about supported devices. -Default Value: VI_FALSE -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViBoolean' }, 1250003: { 'access': 'read-write', - 'channel_based': 'False', + 'channel_based': False, + 'documentation': { + 'description': '\nDetermines the voltage limit, in volts, beyond which overvoltage protection (OVP) engages.\nfor information about supported devices.\nValid Values: 2 V to 210 V\nDefault Value: 210 V\n', + 'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic' + }, 'lv_property': 'Source:Advanced:OVP Limit', 'name': 'OVP_LIMIT', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Determines the voltage limit, in volts, beyond which overvoltage protection (OVP) engages. -for information about supported devices. -Valid Values: 2 V to 210 V -Default Value: 210 V -''', -'note': 'This attribute is not supported by all devices. Refer to Supported Attributes by Device topic', -}, + 'resettable': False, + 'type': 'ViReal64' + }, + 1250004: { + 'access': 'read-write', + 'channel_based': True, + 'name': 'CURRENT_LIMIT_BEHAVIOR', + 'resettable': False, + 'type': 'ViInt32' }, 1250005: { 'access': 'read-write', - 'channel_based': 'True', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies the current limit, in amps, that the output cannot exceed when generating the desired voltage level on the specified channel(s).\nThis attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_VOLTAGE and the NIDCPOWER_ATTR_COMPLIANCE_LIMIT_SYMMETRY attribute is set to NIDCPOWER_VAL_SYMMETRIC.\nNIDCPOWER_ATTR_OUTPUT_ENABLED attribute for more information about enabling the output channel.\nValid Values: The valid values for this attribute are defined by the values to which NIDCPOWER_ATTR_CURRENT_LIMIT_RANGE attribute is set.\n', + 'note': 'The channel must be enabled for the specified current limit to take effect. Refer to the' + }, 'lv_property': 'Source:DC Voltage:Current Limit', 'name': 'CURRENT_LIMIT', - 'resettable': 'No', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the current limit, in amps, that the output cannot exceed when generating the desired voltage level on the specified channel(s). -This attribute is applicable only if the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_VOLTAGE and the NIDCPOWER_ATTR_COMPLIANCE_LIMIT_SYMMETRY attribute is set to NIDCPOWER_VAL_SYMMETRIC. -NIDCPOWER_ATTR_OUTPUT_ENABLED attribute for more information about enabling the output channel. -Valid Values: The valid values for this attribute are defined by the values to which NIDCPOWER_ATTR_CURRENT_LIMIT_RANGE attribute is set. -''', -'note': 'The channel must be enabled for the specified current limit to take effect. Refer to the', -}, + 'resettable': False, + 'type': 'ViReal64' }, 1250006: { 'access': 'read-write', - 'channel_based': 'True', - 'enum': 'tBoolean', + 'channel_based': True, + 'documentation': { + 'description': '\nSpecifies whether the output is enabled (VI_TRUE) or disabled (VI_FALSE).\nDepending on the value you specify for the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute, you also must set the voltage level or current level in addition to enabling the output\nthe niDCPower_Initiate function. Refer to the Programming States topic in the NI DC Power Supplies and SMUs Help for more information about NI-DCPower programming states.\nDefault Value: The default value is VI_TRUE if you use the niDCPower_InitializeWithChannels function to open the session. Otherwise the default value is VI_FALSE, including when you use a calibration session or the deprecated programming model.\n', + 'note': 'If the session is in the Committed or Uncommitted states, enabling the output does not take effect until you call' + }, 'lv_property': 'Source:Output Enabled', 'name': 'OUTPUT_ENABLED', - 'resettable': 'No', - 'type': 'ViBoolean', -'documentation': { -'description': ''' -Specifies whether the output is enabled (VI_TRUE) or disabled (VI_FALSE). -Depending on the value you specify for the NIDCPOWER_ATTR_OUTPUT_FUNCTION attribute, you also must set the voltage level or current level in addition to enabling the output -the niDCPower_Initiate function. Refer to the Programming States topic in the NI DC Power Supplies and SMUs Help for more information about NI-DCPower programming states. -Default Value: The default value is VI_TRUE if you use the niDCPower_InitializeWithChannels function to open the session. Otherwise the default value is VI_FALSE, including when you use a calibration session or the deprecated programming model. -''', -'note': 'If the session is in the Committed or Uncommitted states, enabling the output does not take effect until you call', -}, - }, + 'resettable': False, + 'type': 'ViBoolean' + } } diff --git a/src/nidcpower/metadata/attributes_addon.py b/src/nidcpower/metadata/attributes_addon.py index 198b8dd2c..395f33212 100644 --- a/src/nidcpower/metadata/attributes_addon.py +++ b/src/nidcpower/metadata/attributes_addon.py @@ -5,59 +5,14 @@ # Python API bindings release attributes_codegen_method = { - 1050401: { "codegen_method": "no" }, # GROUP_CAPABILITIES - IVI Attribute - #824 - 1050021: { "codegen_method": "no" }, # INTERCHANGE_CHECK - IVI Attribute - #824 - 1050002: { "codegen_method": "no" }, # RANGE_CHECK - IVI Attribute - #824 - 1050006: { "codegen_method": "no" }, # RECORD_COERCIONS - IVI Attribute - #824 - 1050515: { "codegen_method": "no" }, # SPECIFIC_DRIVER_CLASS_SPEC_MAJOR_VERSION - IVI Attribute - #824 - 1050516: { "codegen_method": "no" }, # SPECIFIC_DRIVER_CLASS_SPEC_MINOR_VERSION - IVI Attribute - #824 - 1050004: { "codegen_method": "no" }, # CACHE - IVI Attribute - #824 - 1150074: { "codegen_method": "private" }, # ACTIVE_ADVANCED_SEQUENCE - Advanced Sequence Attribute - #793 - 1150075: { "codegen_method": "private" }, # ACTIVE_ADVANCED_SEQUENCE_STEP - Advanced Sequence Attribute - #793 - 1150035: { "codegen_method": "no" }, # DIGITAL_EDGE_MEASURE_TRIGGER_EDGE - Backplane only, always falling edge - #860 - 1150096: { "codegen_method": "no" }, # DIGITAL_EDGE_PULSE_TRIGGER_EDGE - Backplane only, always falling edge - #860 - 1150027: { "codegen_method": "no" }, # DIGITAL_EDGE_SEQUENCE_ADVANCE_TRIGGER_EDGE - Backplane only, always falling edge - #860 - 1150031: { "codegen_method": "no" }, # DIGITAL_EDGE_SOURCE_TRIGGER_EDGE - Backplane only, always falling edge - #860 - 1150022: { "codegen_method": "no" }, # DIGITAL_EDGE_START_TRIGGER_EDGE - Backplane only, always falling edge - #860 } attributes_converters = { - 1150046: { 'attribute_class': 'AttributeViReal64TimeDeltaSeconds', - 'type_in_documentation': 'float in seconds or datetime.timedelta', }, # MEASURE_COMPLETE_EVENT_DELAY - 1150065: { 'attribute_class': 'AttributeViReal64TimeDeltaSeconds', - 'type_in_documentation': 'float in seconds or datetime.timedelta', }, # MEASURE_RECORD_DELTA_TIME - 1150093: { 'attribute_class': 'AttributeViReal64TimeDeltaSeconds', - 'type_in_documentation': 'float in seconds or datetime.timedelta', }, # PULSE_ON_TIME - 1150094: { 'attribute_class': 'AttributeViReal64TimeDeltaSeconds', - 'type_in_documentation': 'float in seconds or datetime.timedelta', }, # PULSE_OFF_TIME - 1150051: { 'attribute_class': 'AttributeViReal64TimeDeltaSeconds', - 'type_in_documentation': 'float in seconds or datetime.timedelta', }, # SOURCE_DELAY } attributes_enums = { - 1150020: { "enum": None }, # POWER_LINE_FREQUENCY, Don't use the enum because a number will do - 1050002: { "enum": None }, # RANGE_CHECK, Don't use the enum because a bool will do - 1050003: { "enum": None }, # QUERY_INSTRUMENT_STATUS, Don't use the enum because a bool will do - 1050004: { "enum": None }, # CACHE, Don't use the enum because a bool will do - 1050005: { "enum": None }, # SIMULATE, Don't use the enum because a bool will do - 1050006: { "enum": None }, # RECORD_COERCIONS, Don't use the enum because a bool will do - 1050021: { "enum": None }, # INTERCHANGE_CHECK, Don't use the enum because a bool will do - 1150002: { "enum": None }, # AUXILIARY_POWER_SOURCE_AVAILABLE, Don't use the enum because a bool will do - 1150006: { "enum": None }, # RESET_AVERAGE_BEFORE_MEASUREMENT, Don't use the enum because a bool will do - 1150007: { "enum": None }, # OVERRANGING_ENABLED, Don't use the enum because a bool will do - 1150060: { "enum": None }, # OUTPUT_CONNECTED, Don't use the enum because a bool will do - 1150064: { "enum": None }, # MEASURE_RECORD_LENGTH_IS_FINITE, Don't use the enum because a bool will do - 1150078: { "enum": None }, # SEQUENCE_LOOP_COUNT_IS_FINITE, Don't use the enum because a bool will do - 1150105: { "enum": None }, # INTERLOCK_INPUT_OPEN, Don't use the enum because a bool will do - 1250002: { "enum": None }, # OVP_ENABLED, Don't use the enum because a bool will do - 1250006: { "enum": None }, # OUTPUT_ENABLED, Don't use the enum because a bool will do } # If the associated enum represents boolean values only, disconnect attributes_remove_enum = { - 1150020: { "enum": None, }, # POWER_LINE_FREQUENCY, Don't use enum since simple value will do - 1150016: { 'enum': None, 'python_type': 'bool', }, # CURRENT_LIMIT_AUTORANGE, Don't use the enum because a bool will do - 1150017: { 'enum': None, 'python_type': 'bool', }, # CURRENT_LEVEL_AUTORANGE, Don't use the enum because a bool will do - 1150015: { 'enum': None, 'python_type': 'bool', }, # VOLTAGE_LEVEL_AUTORANGE, Don't use the enum because a bool will do - 1150018: { 'enum': None, 'python_type': 'bool', }, # CURRENT_LIMIT_AUTORANGE, Don't use the enum because a bool will do } diff --git a/src/nidcpower/metadata/config.py b/src/nidcpower/metadata/config.py index 33c489187..ae79ef3c4 100644 --- a/src/nidcpower/metadata/config.py +++ b/src/nidcpower/metadata/config.py @@ -1,32 +1,44 @@ +# -*- coding: utf-8 -*- +# This file is generated from API metadata for NI-DCPower version 19.1.0d33 config = { - 'metadata_version': '1.0', - 'module_name': 'nidcpower', - 'module_version': '1.1.1.dev0', 'c_function_prefix': 'niDCPower_', - 'driver_name': 'NI-DCPower', - 'session_class_description': 'An NI-DCPower session to a National Instruments Programmable Power Supply or Source Measure Unit.', - 'session_handle_parameter_name': 'vi', - 'library_info': - { - 'Windows': { - '32bit': {'name': 'nidcpower_32.dll', 'type': 'windll'}, - '64bit': {'name': 'nidcpower_64.dll', 'type': 'cdll'}, - }, - 'Linux': { - '64bit': {'name': 'libnidcpower.so', 'type': 'cdll'}, - }, - }, + 'close_function': 'Close', 'context_manager_name': { - 'task': 'acquisition', - 'initiate_function': 'Initiate', 'abort_function': 'Abort', + 'initiate_function': 'Initiate', + 'task': 'acquisition' }, + 'custom_types': [ + ], + 'driver_name': 'NI-DCPower', 'init_function': 'InitializeWithChannels', - 'close_function': 'close', - 'custom_types': [], - 'last_tested_version': '18.1.1', + 'last_tested_version': '19.1.0d33', + 'library_info': { + 'Linux': { + '64bit': { + 'name': 'libnidcpower.so', + 'type': 'cdll' + } + }, + 'Windows': { + '32bit': { + 'name': 'nidcpower_32.dll', + 'type': 'windll' + }, + '64bit': { + 'name': 'nidcpower_64.dll', + 'type': 'cdll' + } + } + }, + 'metadata_version': '2.0', + 'module_name': 'nidcpower', 'repeated_capabilities': [ - {'python_name': 'channels', 'prefix': '', }, + { + 'prefix': '', + 'python_name': 'channels' + } ], + 'session_class_description': 'An NI-DCPower session to a National Instruments Programmable Power Supply or Source Measure Unit.', + 'session_handle_parameter_name': 'vi' } - diff --git a/src/nidcpower/metadata/config_addon.py b/src/nidcpower/metadata/config_addon.py new file mode 100644 index 000000000..bf5472136 --- /dev/null +++ b/src/nidcpower/metadata/config_addon.py @@ -0,0 +1,4 @@ +# We need to maintain the version here since it needs to be updated by the build process on GitHub +config_additional_config = { + 'module_version': '1.1.1.dev0', +} diff --git a/src/nidcpower/metadata/enums.py b/src/nidcpower/metadata/enums.py index 6cf3d6281..d9d7aa563 100644 --- a/src/nidcpower/metadata/enums.py +++ b/src/nidcpower/metadata/enums.py @@ -1,479 +1,535 @@ - # -*- coding: utf-8 -*- -# This file is code generated, do not make changes here. -# If the generated information is not correct for python -# changes can be made in enums_addon.py and they will be -# applied at build time. - +# This file is generated from API metadata for NI-DCPower version 19.1.0d33 enums = { 'ApertureTimeUnits': { 'values': [ { + 'documentation': { + 'description': 'Specifies aperture time in seconds.' + }, 'name': 'NIDCPOWER_VAL_SECONDS', - 'value': 1028, -'documentation': { -'description': 'Specifies aperture time in seconds.', -}, + 'value': 1028 }, { + 'documentation': { + 'description': 'Specifies aperture time in power line cycles (PLCs).' + }, 'name': 'NIDCPOWER_VAL_POWER_LINE_CYCLES', - 'value': 1029, -'documentation': { -'description': 'Specifies aperture time in power line cycles (PLCs).', -}, - }, - ], + 'value': 1029 + } + ] }, 'AutoZero': { 'values': [ { + 'documentation': { + 'description': 'Disables auto zero.' + }, 'name': 'NIDCPOWER_VAL_OFF', - 'value': 0, -'documentation': { -'description': 'Disables auto zero.', -}, + 'value': 0 }, { + 'documentation': { + 'description': 'Makes zero conversions for every measurement.' + }, 'name': 'NIDCPOWER_VAL_ON', - 'value': 1, -'documentation': { -'description': 'Makes zero conversions for every measurement.', -}, + 'value': 1 }, { + 'documentation': { + 'description': 'Makes zero conversions following the first measurement after initiating the device. The device uses these zero conversions for the preceding measurement and future measurements until the device is reinitiated.' + }, 'name': 'NIDCPOWER_VAL_ONCE', - 'value': 1024, -'documentation': { -'description': 'Makes zero conversions following the first measurement after initiating the device. The device uses these zero conversions for the preceding measurement and future measurements until the device is reinitiated.', -}, - }, - ], + 'value': 1024 + } + ] }, 'ComplianceLimitSymmetry': { 'values': [ { - 'name': 'SYMMETRIC', - 'value': 0, -'documentation': { -'description': 'Compliance limits are specified symmetrically about 0.', -}, + 'documentation': { + 'description': 'Compliance limits are specified symmetrically about 0.' + }, + 'name': 'NIDCPOWER_VAL_SYMMETRIC', + 'value': 0 }, { - 'name': 'ASYMMETRIC', - 'value': 1, -'documentation': { -'description': 'Compliance limits can be specified asymmetrically with respect to 0.', -}, - }, - ], + 'documentation': { + 'description': 'Compliance limits can be specified asymmetrically with respect to 0.' + }, + 'name': 'NIDCPOWER_VAL_ASYMMETRIC', + 'value': 1 + } + ] }, - 'CurrentLevelAutorange': { + 'CurrentLimitBehavior': { 'values': [ { - 'name': 'NIDCPOWER_VAL_OFF', - 'value': 0, -'documentation': { -'description': 'Autoranging is disabled.', -}, + 'documentation': { + 'description': '' + }, + 'name': 'NIDCPOWER_VAL_CURRENT_REGULATE', + 'value': 0 }, { - 'name': 'NIDCPOWER_VAL_ON', - 'value': 1, -'documentation': { -'description': 'Autoranging is enabled.', -}, - }, - ], + 'documentation': { + 'description': '' + }, + 'name': 'NIDCPOWER_VAL_CURRENT_TRIP', + 'value': 1 + } + ] }, - 'CurrentLimitAutorange': { + 'DCNoiseRejection': { 'values': [ { - 'name': 'NIDCPOWER_VAL_OFF', - 'value': 0, -'documentation': { -'description': 'Autoranging is disabled.', -}, + 'documentation': { + 'description': 'Second-order rejection of DC noise.' + }, + 'name': 'NIDCPOWER_VAL_DC_NOISE_REJECTION_SECOND_ORDER', + 'value': 1043 }, { - 'name': 'NIDCPOWER_VAL_ON', - 'value': 1, -'documentation': { -'description': 'Autoranging is enabled.', -}, - }, - ], + 'documentation': { + 'description': 'Normal rejection of DC noise.' + }, + 'name': 'NIDCPOWER_VAL_DC_NOISE_REJECTION_NORMAL', + 'value': 1044 + } + ] }, - 'CurrentLimitBehavior': { + 'DigitalEdge': { 'values': [ { - 'name': 'CURRENT_REGULATE', - 'value': 13613, -'documentation': { -'description': '', -}, + 'documentation': { + 'description': 'Asserts the trigger on the rising edge of the digital signal.' + }, + 'name': 'NIDCPOWER_VAL_RISING', + 'value': 1016 }, { - 'name': 'CURRENT_TRIP', - 'value': 13614, -'documentation': { -'description': '', -}, - }, - ], + 'documentation': { + 'description': 'Asserts the trigger on the falling edge of the digital signal.' + }, + 'name': 'NIDCPOWER_VAL_FALLING', + 'value': 1017 + } + ] }, - 'DCNoiseRejection': { + 'Event': { 'values': [ { - 'name': 'NIDCPOWER_VAL_DC_NOISE_REJECTION_SECOND_ORDER', - 'value': 1043, -'documentation': { -'description': 'Second-order rejection of DC noise.', -}, + 'name': 'NIDCPOWER_VAL_SOURCE_COMPLETE', + 'value': 1030 }, { - 'name': 'NIDCPOWER_VAL_DC_NOISE_REJECTION_NORMAL', - 'value': 1044, -'documentation': { -'description': 'Normal rejection of DC noise.', -}, + 'name': 'NIDCPOWER_VAL_MEASURE_COMPLETE', + 'value': 1031 + }, + { + 'name': 'NIDCPOWER_VAL_SEQUENCE_ITERATION_COMPLETE', + 'value': 1032 }, - ], + { + 'name': 'NIDCPOWER_VAL_SEQUENCE_ENGINE_DONE', + 'value': 1033 + }, + { + 'name': 'NIDCPOWER_VAL_PULSE_COMPLETE', + 'value': 1051 + }, + { + 'name': 'NIDCPOWER_VAL_READY_FOR_PULSE_TRIGGER', + 'value': 1052 + } + ] }, - 'DigitalEdge': { + 'ExportSignal': { 'values': [ { - 'name': 'NIDCPOWER_VAL_RISING', - 'value': 1016, -'documentation': { -'description': 'Asserts the trigger on the rising edge of the digital signal.', -}, + 'documentation': { + 'description': 'Exports the Source Complete event.' + }, + 'name': 'NIDCPOWER_VAL_SOURCE_COMPLETE_EVENT', + 'value': 1030 }, { - 'name': 'NIDCPOWER_VAL_FALLING', - 'value': 1017, -'documentation': { -'description': 'Asserts the trigger on the falling edge of the digital signal.', -}, + 'documentation': { + 'description': 'Exports the Measure Complete event.' + }, + 'name': 'NIDCPOWER_VAL_MEASURE_COMPLETE_EVENT', + 'value': 1031 + }, + { + 'documentation': { + 'description': 'Exports the Sequence Iteration Complete event.' + }, + 'name': 'NIDCPOWER_VAL_SEQUENCE_ITERATION_COMPLETE_EVENT', + 'value': 1032 + }, + { + 'documentation': { + 'description': 'Exports the Sequence Engine Done event.' + }, + 'name': 'NIDCPOWER_VAL_SEQUENCE_ENGINE_DONE_EVENT', + 'value': 1033 + }, + { + 'documentation': { + 'description': 'Exports the Pulse Complete event.' + }, + 'name': 'NIDCPOWER_VAL_PULSE_COMPLETE_EVENT', + 'value': 1051 + }, + { + 'documentation': { + 'description': 'Exports the Ready Pulse Trigger event.' + }, + 'name': 'NIDCPOWER_VAL_READY_FOR_PULSE_TRIGGER_EVENT', + 'value': 1052 }, - ], + { + 'documentation': { + 'description': 'Exports the Start trigger.' + }, + 'name': 'NIDCPOWER_VAL_START_TRIGGER', + 'value': 1034 + }, + { + 'documentation': { + 'description': 'Exports the Source trigger.' + }, + 'name': 'NIDCPOWER_VAL_SOURCE_TRIGGER', + 'value': 1035 + }, + { + 'documentation': { + 'description': 'Exports the Measure trigger.' + }, + 'name': 'NIDCPOWER_VAL_MEASURE_TRIGGER', + 'value': 1036 + }, + { + 'documentation': { + 'description': 'Exports the Sequence Advance trigger.' + }, + 'name': 'NIDCPOWER_VAL_SEQUENCE_ADVANCE_TRIGGER', + 'value': 1037 + }, + { + 'documentation': { + 'description': 'Exports the Pulse trigger.' + }, + 'name': 'NIDCPOWER_VAL_PULSE_TRIGGER', + 'value': 1053 + } + ] }, 'MeasureWhen': { 'values': [ { + 'documentation': { + 'description': 'Acquires a measurement after each Source Complete event completes.' + }, 'name': 'NIDCPOWER_VAL_AUTOMATICALLY_AFTER_SOURCE_COMPLETE', - 'value': 1025, -'documentation': { -'description': 'Acquires a measurement after each Source Complete event completes.', -}, + 'value': 1025 }, { + 'documentation': { + 'description': 'Acquires a measurement when the niDCPower_Measure function or niDCPower_MeasureMultiple function is called.' + }, 'name': 'NIDCPOWER_VAL_ON_DEMAND', - 'value': 1026, -'documentation': { -'description': 'Acquires a measurement when the niDCPower_Measure function or niDCPower_MeasureMultiple function is called.', -}, + 'value': 1026 }, { + 'documentation': { + 'description': 'Acquires a measurement when a Measure trigger is received.' + }, 'name': 'NIDCPOWER_VAL_ON_MEASURE_TRIGGER', - 'value': 1027, -'documentation': { -'description': 'Acquires a measurement when a Measure trigger is received.', -}, + 'value': 1027 + } + ] + }, + 'MeasurementTypes': { + 'values': [ + { + 'documentation': { + 'description': 'The device measures current.' + }, + 'name': 'NIDCPOWER_VAL_MEASURE_CURRENT', + 'value': 0 }, - ], + { + 'documentation': { + 'description': 'The device measures voltage.' + }, + 'name': 'NIDCPOWER_VAL_MEASURE_VOLTAGE', + 'value': 1 + } + ] }, 'OutputCapacitance': { 'values': [ { + 'documentation': { + 'description': 'Output Capacitance is low.' + }, 'name': 'NIDCPOWER_VAL_LOW', - 'value': 1010, -'documentation': { -'description': 'Output Capacitance is low.', -}, + 'value': 1010 }, { + 'documentation': { + 'description': 'Output Capacitance is high.' + }, 'name': 'NIDCPOWER_VAL_HIGH', - 'value': 1011, -'documentation': { -'description': 'Output Capacitance is high.', -}, - }, - ], + 'value': 1011 + } + ] }, 'OutputFunction': { 'values': [ { + 'documentation': { + 'description': 'Sets the output function to DC voltage.' + }, 'name': 'NIDCPOWER_VAL_DC_VOLTAGE', - 'value': 1006, -'documentation': { -'description': 'Sets the output function to DC voltage.', -}, + 'value': 1006 }, { + 'documentation': { + 'description': 'Sets the output function to DC current.' + }, 'name': 'NIDCPOWER_VAL_DC_CURRENT', - 'value': 1007, -'documentation': { -'description': 'Sets the output function to DC current.', -}, + 'value': 1007 }, { + 'documentation': { + 'description': 'Sets the output function to pulse voltage.' + }, 'name': 'NIDCPOWER_VAL_PULSE_VOLTAGE', - 'value': 1049, -'documentation': { -'description': 'Sets the output function to pulse voltage.', -}, + 'value': 1049 }, { + 'documentation': { + 'description': 'Sets the output function to pulse current.' + }, 'name': 'NIDCPOWER_VAL_PULSE_CURRENT', - 'value': 1050, -'documentation': { -'description': 'Sets the output function to pulse current.', -}, - }, - ], + 'value': 1050 + } + ] }, - 'Polarity': { + 'OutputStates': { 'values': [ { - 'name': 'NIDCPOWER_VAL_ACTIVE_HIGH', - 'value': 1018, -'documentation': { -'description': 'A high pulse occurs when the event is generated. The exported signal is low level both before and after the event is generated.', -}, + 'documentation': { + 'description': 'The device maintains a constant voltage by adjusting the current ' + }, + 'name': 'NIDCPOWER_VAL_OUTPUT_CONSTANT_VOLTAGE', + 'value': 0 }, { - 'name': 'NIDCPOWER_VAL_ACTIVE_LOW', - 'value': 1019, -'documentation': { -'description': 'A low pulse occurs when the event is generated. The exported signal is high level both before and after the event is generated.', -}, - }, - ], + 'documentation': { + 'description': 'The device maintains a constant current by adjusting the voltage.' + }, + 'name': 'NIDCPOWER_VAL_OUTPUT_CONSTANT_CURRENT', + 'value': 1 + } + ] }, - 'PowerLineFrequency': { + 'Polarity': { 'values': [ { - 'name': 'NIDCPOWER_VAL_50_HERTZ', - 'value': 50.0, -'documentation': { -'description': 'Specifies a power line frequency of 50 Hz.', -}, + 'documentation': { + 'description': 'A high pulse occurs when the event is generated. The exported signal is low level both before and after the event is generated.' + }, + 'name': 'NIDCPOWER_VAL_ACTIVE_HIGH', + 'value': 1018 }, { - 'name': 'NIDCPOWER_VAL_60_HERTZ', - 'value': 60.0, -'documentation': { -'description': 'Specifies a power line frequency of 60 Hz.', -}, - }, - ], + 'documentation': { + 'description': 'A low pulse occurs when the event is generated. The exported signal is high level both before and after the event is generated.' + }, + 'name': 'NIDCPOWER_VAL_ACTIVE_LOW', + 'value': 1019 + } + ] }, 'PowerSource': { 'values': [ { + 'documentation': { + 'description': 'Uses the PXI chassis power source.' + }, 'name': 'NIDCPOWER_VAL_INTERNAL', - 'value': 1003, -'documentation': { -'description': 'Uses the PXI chassis power source.', -}, + 'value': 1003 }, { + 'documentation': { + 'description': 'Uses the auxiliary power source connected to the device.' + }, 'name': 'NIDCPOWER_VAL_AUXILIARY', - 'value': 1004, -'documentation': { -'description': 'Uses the auxiliary power source connected to the device.', -}, + 'value': 1004 }, { + 'documentation': { + 'description': 'Uses the auxiliary power source if it is available; otherwise uses the PXI chassis power source.' + }, 'name': 'NIDCPOWER_VAL_AUTOMATIC', - 'value': 1005, -'documentation': { -'description': 'Uses the auxiliary power source if it is available; otherwise uses the PXI chassis power source.', -}, - }, - ], + 'value': 1005 + } + ] }, 'PowerSourceInUse': { 'values': [ { + 'documentation': { + 'description': 'Uses the PXI chassis power source.' + }, 'name': 'NIDCPOWER_VAL_INTERNAL', - 'value': 1003, -'documentation': { -'description': 'Uses the PXI chassis power source.', -}, + 'value': 1003 }, { + 'documentation': { + 'description': 'Uses the auxiliary power source connected to the device. Only the NI PXI-4110, NI PXIe-4112, NI PXIe-4113, and NI PXI-4130 support this value. This is the only supported value for the NI PXIe-4112 and NI PXIe-4113.' + }, 'name': 'NIDCPOWER_VAL_AUXILIARY', - 'value': 1004, -'documentation': { -'description': 'Uses the auxiliary power source connected to the device. Only the NI PXI-4110, NI PXIe-4112, NI PXIe-4113, and NI PXI-4130 support this value. This is the only supported value for the NI PXIe-4112 and NI PXIe-4113.', -}, - }, - ], + 'value': 1004 + } + ] }, 'SelfCalibrationPersistence': { 'values': [ { + 'documentation': { + 'description': 'Keep new self calibration values in memory only.' + }, 'name': 'NIDCPOWER_VAL_KEEP_IN_MEMORY', - 'value': 1045, -'documentation': { -'description': 'Keep new self calibration values in memory only.', -}, + 'value': 1045 }, { + 'documentation': { + 'description': 'Write new self calibration values to hardware.' + }, 'name': 'NIDCPOWER_VAL_WRITE_TO_EEPROM', - 'value': 1046, -'documentation': { -'description': 'Write new self calibration values to hardware.', -}, + 'value': 1046 + } + ] + }, + 'SendSoftwareEdgeTriggerType': { + 'values': [ + { + 'name': 'NIDCPOWER_VAL_START', + 'value': 1034 + }, + { + 'name': 'NIDCPOWER_VAL_SOURCE', + 'value': 1035 + }, + { + 'name': 'NIDCPOWER_VAL_MEASURE', + 'value': 1036 + }, + { + 'name': 'NIDCPOWER_VAL_SEQUENCE_ADVANCE', + 'value': 1037 }, - ], + { + 'name': 'NIDCPOWER_VAL_PULSE', + 'value': 1053 + } + ] }, 'Sense': { 'values': [ { + 'documentation': { + 'description': 'Local sensing is selected.' + }, 'name': 'NIDCPOWER_VAL_LOCAL', - 'value': 1008, -'documentation': { -'description': 'Local sensing is selected.', -}, + 'value': 1008 }, { + 'documentation': { + 'description': 'Remote sensing is selected.' + }, 'name': 'NIDCPOWER_VAL_REMOTE', - 'value': 1009, -'documentation': { -'description': 'Remote sensing is selected.', -}, - }, - ], + 'value': 1009 + } + ] }, 'SourceMode': { 'values': [ { + 'documentation': { + 'description': 'The source unit applies a single source configuration.' + }, 'name': 'NIDCPOWER_VAL_SINGLE_POINT', - 'value': 1020, -'documentation': { -'description': 'The source unit applies a single source configuration.', -}, + 'value': 1020 }, { + 'documentation': { + 'description': 'The source unit applies a list of voltage or current configurations sequentially.' + }, 'name': 'NIDCPOWER_VAL_SEQUENCE', - 'value': 1021, -'documentation': { -'description': 'The source unit applies a list of voltage or current configurations sequentially.', -}, - }, - ], + 'value': 1021 + } + ] }, 'TransientResponse': { 'values': [ { + 'documentation': { + 'description': 'The output responds to changes in load at a normal speed.' + }, 'name': 'NIDCPOWER_VAL_NORMAL', - 'value': 1038, -'documentation': { -'description': 'The output responds to changes in load at a normal speed.', -}, + 'value': 1038 }, { + 'documentation': { + 'description': 'The output responds to changes in load quickly.' + }, 'name': 'NIDCPOWER_VAL_FAST', - 'value': 1039, -'documentation': { -'description': 'The output responds to changes in load quickly.', -}, + 'value': 1039 }, { + 'documentation': { + 'description': 'The output responds to changes in load slowly.' + }, 'name': 'NIDCPOWER_VAL_SLOW', - 'value': 1041, -'documentation': { -'description': 'The output responds to changes in load slowly.', -}, + 'value': 1041 }, { + 'documentation': { + 'description': 'The output responds to changes in load based on specified values.' + }, 'name': 'NIDCPOWER_VAL_CUSTOM', - 'value': 1042, -'documentation': { -'description': 'The output responds to changes in load based on specified values.', -}, - }, - ], + 'value': 1042 + } + ] }, 'TriggerType': { 'values': [ { + 'documentation': { + 'description': 'No trigger is configured.' + }, 'name': 'NIDCPOWER_VAL_NONE', - 'value': 1012, -'documentation': { -'description': 'No trigger is configured.', -}, + 'value': 1012 }, { + 'documentation': { + 'description': 'The data operation starts when a digital edge is detected.' + }, 'name': 'NIDCPOWER_VAL_DIGITAL_EDGE', - 'value': 1014, -'documentation': { -'description': 'The data operation starts when a digital edge is detected.', -}, + 'value': 1014 }, { + 'documentation': { + 'description': 'The data operation starts when a software trigger occurs.' + }, 'name': 'NIDCPOWER_VAL_SOFTWARE_EDGE', - 'value': 1015, -'documentation': { -'description': 'The data operation starts when a software trigger occurs.', -}, - }, - ], - }, - 'VoltageLevelAutorange': { - 'values': [ - { - 'name': 'NIDCPOWER_VAL_OFF', - 'value': 0, -'documentation': { -'description': 'Autoranging is disabled.', -}, - }, - { - 'name': 'NIDCPOWER_VAL_ON', - 'value': 1, -'documentation': { -'description': 'Autoranging is enabled.', -}, - }, - ], - }, - 'VoltageLimitAutorange': { - 'values': [ - { - 'name': 'NIDCPOWER_VAL_OFF', - 'value': 0, -'documentation': { -'description': 'Autoranging is disabled.', -}, - }, - { - 'name': 'NIDCPOWER_VAL_ON', - 'value': 1, -'documentation': { -'description': 'Autoranging is enabled.', -}, - }, - ], - }, - 'tBoolean': { - 'values': [ - { - 'name': 'FALSE', - 'value': 0, -'documentation': { -'description': '', -}, - }, - { - 'name': 'TRUE', - 'value': 1, -'documentation': { -'description': '', -}, - }, - ], - }, + 'value': 1015 + } + ] + } } diff --git a/src/nidcpower/metadata/enums_addon.py b/src/nidcpower/metadata/enums_addon.py index 8faa5fb82..74cd6913c 100644 --- a/src/nidcpower/metadata/enums_addon.py +++ b/src/nidcpower/metadata/enums_addon.py @@ -9,181 +9,6 @@ } enums_additional_enums = { - 'SendSoftwareEdgeTriggerType': { - 'values': [ - { - 'name': 'NIDCPOWER_VAL_START', - 'value': 1034, - }, - { - 'name': 'NIDCPOWER_VAL_SOURCE', - 'value': 1035, - }, - { - 'name': 'NIDCPOWER_VAL_MEASURE', - 'value': 1036, - }, - { - 'name': 'NIDCPOWER_VAL_SEQUENCE_ADVANCE', - 'value': 1037, - }, - { - 'name': 'NIDCPOWER_VAL_PULSE', - 'value': 1053, - }, - ], - }, - 'Event': { - 'values': [ - { - 'name': 'NIDCPOWER_VAL_SOURCE_COMPLETE', - 'value': 1030, - }, - { - 'name': 'NIDCPOWER_VAL_MEASURE_COMPLETE', - 'value': 1031, - }, - { - 'name': 'NIDCPOWER_VAL_SEQUENCE_ITERATION_COMPLETE', - 'value': 1032, - }, - { - 'name': 'NIDCPOWER_VAL_SEQUENCE_ENGINE_DONE', - 'value': 1033, - }, - { - 'name': 'NIDCPOWER_VAL_PULSE_COMPLETE', - 'value': 1051, - }, - { - 'name': 'NIDCPOWER_VAL_READY_FOR_PULSE_TRIGGER', - 'value': 1052, - }, - ], - }, - 'MeasurementTypes': { - 'values': [ - { - 'name': 'NIDCPOWER_VAL_MEASURE_CURRENT', - 'value': 0, - 'documentation': { - 'description': 'The device measures current.', - }, - }, - { - 'name': 'NIDCPOWER_VAL_MEASURE_VOLTAGE', - 'value': 1, - 'documentation': { - 'description': 'The device measures voltage.', - }, - } - ], - }, - 'OutputStates': { - 'values': [ - { - 'name': 'NIDCPOWER_VAL_OUTPUT_CONSTANT_VOLTAGE', - 'value': 0, - 'documentation': { - 'description': 'The device maintains a constant voltage by adjusting the current ', - }, - }, - { - 'name': 'NIDCPOWER_VAL_OUTPUT_CONSTANT_CURRENT', - 'value': 1, - 'documentation': { - 'description': 'The device maintains a constant current by adjusting the voltage.', - }, - } - ], - }, - 'ExportSignal': { - 'values': [ - { - 'name': 'NIDCPOWER_VAL_SOURCE_COMPLETE_EVENT', - 'value': 1030, - 'documentation': { - 'description': 'Exports the Source Complete event.', - }, - }, - { - 'name': 'NIDCPOWER_VAL_MEASURE_COMPLETE_EVENT', - 'value': 1031, - 'documentation': { - 'description': 'Exports the Measure Complete event.', - }, - }, - { - 'name': 'NIDCPOWER_VAL_SEQUENCE_ITERATION_COMPLETE_EVENT', - 'value': 1032, - 'documentation': { - 'description': 'Exports the Sequence Iteration Complete event.', - }, - }, - { - 'name': 'NIDCPOWER_VAL_SEQUENCE_ENGINE_DONE_EVENT', - 'value': 1033, - 'documentation': { - 'description': 'Exports the Sequence Engine Done event.', - }, - }, - { - 'name': 'NIDCPOWER_VAL_PULSE_COMPLETE_EVENT', - 'value': 1051, - 'documentation': { - 'description': 'Exports the Pulse Complete event.', - }, - }, - { - 'name': 'NIDCPOWER_VAL_READY_FOR_PULSE_TRIGGER_EVENT', - 'value': 1052, - 'documentation': { - 'description': 'Exports the Ready Pulse Trigger event.', - }, - }, - { - 'name': 'NIDCPOWER_VAL_START_TRIGGER', - 'value': 1034, - 'documentation': { - 'description': 'Exports the Start trigger.', - }, - }, - { - 'name': 'NIDCPOWER_VAL_SOURCE_TRIGGER', - 'value': 1035, - 'documentation': { - 'description': 'Exports the Source trigger.', - }, - }, - { - 'name': 'NIDCPOWER_VAL_MEASURE_TRIGGER', - 'value': 1036, - 'documentation': { - 'description': 'Exports the Measure trigger.', - }, - }, - { - 'name': 'NIDCPOWER_VAL_SEQUENCE_ADVANCE_TRIGGER', - 'value': 1037, - 'documentation': { - 'description': 'Exports the Sequence Advance trigger.', - }, - }, - { - 'name': 'NIDCPOWER_VAL_PULSE_TRIGGER', - 'value': 1053, - 'documentation': { - 'description': 'Exports the Pulse trigger.', - }, - }, - ], - }, - 'PowerLineFrequency': {}, # Enum metadata actually contains constants. - 'CurrentLimitAutorange': {}, # Delete because boolean values only - 'CurrentLevelAutorange': {}, # Delete because boolean values only - 'VoltageLevelAutorange': {}, # Delete because boolean values only - 'VoltageLimitAutorange': {}, # Delete because boolean values only - 'tBoolean': {}, # Enum just represents True/False } diff --git a/src/nidcpower/metadata/functions.py b/src/nidcpower/metadata/functions.py index a17339108..8d57eab76 100644 --- a/src/nidcpower/metadata/functions.py +++ b/src/nidcpower/metadata/functions.py @@ -1,7374 +1,7516 @@ - # -*- coding: utf-8 -*- -# This file is code generated, do not make changes here -# If the generated information is not correct for python -# changes can be made in functions_addon.py and they will be -# applied at build time - - +# This file is generated from API metadata for NI-DCPower version 19.1.0d33 functions = { 'Abort': { - 'returns': 'ViStatus', + 'documentation': { + 'description': '\nTransitions the NI-DCPower session from the Running state to the\nCommitted state. If a sequence is running, it is stopped. Any\nconfiguration functions called after this function are not applied until\nthe niDCPower_Initiate function is called. If power output is enabled\nwhen you call the niDCPower_Abort function, the output channels remain\nin their current state and continue providing power.\n\nUse the niDCPower_ConfigureOutputEnabled function to disable power\noutput on a per channel basis. Use the niDCPower_reset function to\ndisable output on all channels.\n\nRefer to the `Programming\nStates `__ topic in\nthe *NI DC Power Supplies and SMUs Help* for information about the\nspecific NI-DCPower software states.\n\n**Related Topics:**\n\n`Programming\nStates `__\n' + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + } + ], + 'returns': 'ViStatus' + }, + 'AbortWithChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' + } + ], + 'returns': 'ViStatus' + }, + 'AllocateServer': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'serverName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + } + ], + 'returns': 'ViStatus' + }, + 'AttributeWasSetByUser': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, - }, - ], -'documentation': { -'description': ''' -Transitions the NI-DCPower session from the Running state to the -Committed state. If a sequence is running, it is stopped. Any -configuration functions called after this function are not applied until -the niDCPower_Initiate function is called. If power output is enabled -when you call the niDCPower_Abort function, the output channels remain -in their current state and continue providing power. - -Use the niDCPower_ConfigureOutputEnabled function to disable power -output on a per channel basis. Use the niDCPower_reset function to -disable output on all channels. - -Refer to the `Programming -States `__ topic in -the *NI DC Power Supplies and SMUs Help* for information about the -specific NI-DCPower software states. - -**Related Topics:** - -`Programming -States `__ -''', -}, + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'name': 'attributeId', + 'type': 'ViAttr' + }, + { + 'direction': 'out', + 'name': 'wasSetByUser', + 'type': 'ViBoolean' + } + ], + 'returns': 'ViStatus' }, 'CalAdjustCurrentLimit': { - 'returns': 'ViStatus', + 'codegen_method': 'no', + 'documentation': { + 'description': '\nCalculates the calibration constants for the current limit for the\nspecified output channel and range. This function compares the array in\n**requestedOutputs** to the array in **measuredOutputs** and calculates\nthe calibration constants for the current limit returned by the device.\nRefer to the calibration procedure for the device you are calibrating\nfor detailed instructions on the appropriate use of this function. This\nfunction can only be called from an external calibration session.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument calibration session. **vi** is\nobtained from the niDCPower_InitExtCal function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument calibration session. **vi** is -obtained from the niDCPower_InitExtCal function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': 'Specifies the channel name to which these calibration settings apply.' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': 'Specifies the channel name to which these calibration settings apply.', -}, + 'type': 'ViConstString' }, { 'direction': 'in', - 'name': 'Range', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the range to calibrate with these settings. Only one channel -at a time may be calibrated. -''', -}, + 'documentation': { + 'description': '\nSpecifies the range to calibrate with these settings. Only one channel\nat a time may be calibrated.\n' + }, + 'name': 'range', + 'type': 'ViReal64' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the number of elements in **requestedOutputs** and\n**measuredOutputs**.\n' + }, 'name': 'numberOfMeasurements', - 'type': 'ViUInt32', -'documentation': { -'description': ''' -Specifies the number of elements in **requestedOutputs** and -**measuredOutputs**. -''', -}, + 'type': 'ViUInt32' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies an array of the output values that were requested in the\nniDCPower_ConfigureCurrentLimit function.\n' + }, 'name': 'requestedOutputs', - 'type': 'ViReal64[]', -'documentation': { -'description': ''' -Specifies an array of the output values that were requested in the -niDCPower_ConfigureCurrentLimit function. -''', -}, + 'type': 'ViReal64' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies an array of the output values measured by an external\nprecision digital multimeter.\n' + }, 'name': 'measuredOutputs', - 'type': 'ViReal64[]', -'documentation': { -'description': ''' -Specifies an array of the output values measured by an external -precision digital multimeter. -''', -}, - }, - ], -'documentation': { -'description': ''' -Calculates the calibration constants for the current limit for the -specified output channel and range. This function compares the array in -**requestedOutputs** to the array in **measuredOutputs** and calculates -the calibration constants for the current limit returned by the device. -Refer to the calibration procedure for the device you are calibrating -for detailed instructions on the appropriate use of this function. This -function can only be called from an external calibration session. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, 'CalAdjustCurrentMeasurement': { - 'returns': 'ViStatus', + 'codegen_method': 'no', + 'documentation': { + 'description': '\nCalibrates the current measurements returned by the niDCPower_Measure\nfunction for the specified output channel. This function calculates new\ncalibration coefficients for the specified current measurement range\nbased on the **reportedOutputs** and **measuredOutputs**. Refer to the\ncalibration procedure for the device you are calibrating for detailed\ninstructions about the appropriate use of this function. This function\ncan only be called in an external calibration session.\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument calibration session. **vi** is\nobtained from the niDCPower_InitExtCal function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument calibration session. **vi** is -obtained from the niDCPower_InitExtCal function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel name to which these calibration settings\napply.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel name to which these calibration settings -apply. -''', -}, + 'type': 'ViConstString' }, { 'direction': 'in', - 'name': 'Range', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the range to calibrate with these settings. Only one channel -at a time may be calibrated. -''', -}, + 'documentation': { + 'description': '\nSpecifies the range to calibrate with these settings. Only one channel\nat a time may be calibrated.\n' + }, + 'name': 'range', + 'type': 'ViReal64' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the number of elements in **reportedOutputs** and\n**measuredOutputs**.\n' + }, 'name': 'numberOfMeasurements', - 'type': 'ViUInt32', -'documentation': { -'description': ''' -Specifies the number of elements in **reportedOutputs** and -**measuredOutputs**. -''', -}, + 'type': 'ViUInt32' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies an array of the output values that were returned by the\nniDCPower_Measure function.\n' + }, 'name': 'reportedOutputs', - 'type': 'ViReal64[]', -'documentation': { -'description': ''' -Specifies an array of the output values that were returned by the -niDCPower_Measure function. -''', -}, + 'type': 'ViReal64' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies an array of the output values measured by an external\nprecision digital multimeter.\n' + }, 'name': 'measuredOutputs', - 'type': 'ViReal64[]', -'documentation': { -'description': ''' -Specifies an array of the output values measured by an external -precision digital multimeter. -''', -}, - }, - ], -'documentation': { -'description': ''' -Calibrates the current measurements returned by the niDCPower_Measure -function for the specified output channel. This function calculates new -calibration coefficients for the specified current measurement range -based on the **reportedOutputs** and **measuredOutputs**. Refer to the -calibration procedure for the device you are calibrating for detailed -instructions about the appropriate use of this function. This function -can only be called in an external calibration session. -''', -}, + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, 'CalAdjustInternalReference': { - 'returns': 'ViStatus', + 'codegen_method': 'no', + 'documentation': { + 'description': '\nPrograms the adjusted reference value to the device. Refer to the\ncalibration procedure for the device you are calibrating for detailed\ninstructions on the appropriate use of this function. This function can\nonly be called from an external calibration session.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, - }, - { - 'direction': 'in', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the internal reference to be adjusted.\n**Defined Values**:\n', + 'table_body': [ + [ + 'NIDCPOWER_VAL_INTERNAL_REFERENCE_5V (1054)', + 'Calibration pin connected to 5 V internal reference.' + ], + [ + 'NIDCPOWER_VAL_INTERNAL_REFERENCE_100KOHM (1055)', + 'Calibration pin connected to 100 kΩ internal reference.' + ] + ] + }, 'name': 'internalReference', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the internal reference to be adjusted. -**Defined Values**: -''', -'table_body': [['NIDCPOWER_VAL_INTERNAL_REFERENCE_5V (1054)', 'Calibration pin connected to 5 V internal reference.'], ['NIDCPOWER_VAL_INTERNAL_REFERENCE_100KOHM (1055)', 'Calibration pin connected to 100 kΩ internal reference.']], -}, + 'type': 'ViInt32' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the updated value of the internal reference that will be\nprogrammed to the device.\n' + }, 'name': 'adjustedInternalReference', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the updated value of the internal reference that will be -programmed to the device. -''', -}, - }, - ], -'documentation': { -'description': ''' -Programs the adjusted reference value to the device. Refer to the -calibration procedure for the device you are calibrating for detailed -instructions on the appropriate use of this function. This function can -only be called from an external calibration session. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, 'CalAdjustOutputResistance': { - 'returns': 'ViStatus', + 'codegen_method': 'no', + 'documentation': { + 'description': '\nCompares the array in **requestedOutputs** to the array in\n**measuredOutputs** and calculates the calibration constants for the\noutput resistance of the specified channel. Refer to the calibration\nprocedure for the device you are calibrating for detailed instructions\non the appropriate use of this function. This function can only be\ncalled from an external calibration session.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument calibration session. **vi** is\nobtained from the niDCPower_InitExtCal function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument calibration session. **vi** is -obtained from the niDCPower_InitExtCal function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel name to which these calibration settings\napply. Only one channel at a time can be calibrated.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel name to which these calibration settings -apply. Only one channel at a time can be calibrated. -''', -}, + 'type': 'ViConstString' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the number of elements in **requestedOutputs** and\n**measuredOutputs**.\n' + }, 'name': 'numberOfMeasurements', - 'type': 'ViUInt32', -'documentation': { -'description': ''' -Specifies the number of elements in **requestedOutputs** and -**measuredOutputs**. -''', -}, + 'type': 'ViUInt32' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies an array of the output values that were requested in the\nniDCPower_ConfigureOutputResistance function.\n' + }, 'name': 'requestedOutputs', - 'type': 'ViReal64[]', -'documentation': { -'description': ''' -Specifies an array of the output values that were requested in the -niDCPower_ConfigureOutputResistance function. -''', -}, + 'type': 'ViReal64' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies an array of the output values measured by an external\nprecision digital multimeter.\n' + }, 'name': 'measuredOutputs', - 'type': 'ViReal64[]', -'documentation': { -'description': ''' -Specifies an array of the output values measured by an external -precision digital multimeter. -''', -}, - }, - ], -'documentation': { -'description': ''' -Compares the array in **requestedOutputs** to the array in -**measuredOutputs** and calculates the calibration constants for the -output resistance of the specified channel. Refer to the calibration -procedure for the device you are calibrating for detailed instructions -on the appropriate use of this function. This function can only be -called from an external calibration session. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' + }, + 'CalAdjustResidualCmrrAndRangeChange': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' + } + ], + 'returns': 'ViStatus' }, 'CalAdjustResidualCurrentOffset': { - 'returns': 'ViStatus', + 'codegen_method': 'no', + 'documentation': { + 'description': '\nCalculates the calibration constants for the residual current offsets\nfor the specified output channel. Residual offsets account for minor\noffset effects on the device that lie outside of the self-calibration\ncircuitry. These offsets can include multiplexer input offsets and\nleakage effects from internal switching.\n\nThis function requires that the output be open prior to it being\ninvoked.\n\nRefer to the calibration procedure for the device you are calibrating\nfor detailed instructions on the appropriate use of this function. This\nfunction can be called only in an external calibration session.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - ], -'documentation': { -'description': ''' -Calculates the calibration constants for the residual current offsets -for the specified output channel. Residual offsets account for minor -offset effects on the device that lie outside of the self-calibration -circuitry. These offsets can include multiplexer input offsets and -leakage effects from internal switching. - -This function requires that the output be open prior to it being -invoked. - -Refer to the calibration procedure for the device you are calibrating -for detailed instructions on the appropriate use of this function. This -function can be called only in an external calibration session. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'type': 'ViConstString' + } + ], + 'returns': 'ViStatus' }, 'CalAdjustResidualVoltageOffset': { - 'returns': 'ViStatus', + 'codegen_method': 'no', + 'documentation': { + 'description': '\nCalculates the calibration constants for the residual voltage offsets\nfor the specified output channel. Residual offsets account for minor\noffset effects on the device that lie outside of the self-calibration\ncircuitry. These offsets can include multiplexer input offsets and\nleakage effects from internal switching.\n\nThis function requires that the output be shorted prior to it being\ninvoked.\n\nRefer to the calibration procedure for the device you are calibrating\nfor detailed instructions on the appropriate use of this function. This\nfunction can be called only in an external calibration session.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, + 'name': 'channelName', + 'type': 'ViConstString' + } + ], + 'returns': 'ViStatus' + }, + 'CalAdjustResidualVoltageOffsetOnly': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - ], -'documentation': { -'description': ''' -Calculates the calibration constants for the residual voltage offsets -for the specified output channel. Residual offsets account for minor -offset effects on the device that lie outside of the self-calibration -circuitry. These offsets can include multiplexer input offsets and -leakage effects from internal switching. - -This function requires that the output be shorted prior to it being -invoked. - -Refer to the calibration procedure for the device you are calibrating -for detailed instructions on the appropriate use of this function. This -function can be called only in an external calibration session. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'type': 'ViConstString' + } + ], + 'returns': 'ViStatus' }, 'CalAdjustVoltageLevel': { - 'returns': 'ViStatus', + 'codegen_method': 'no', + 'documentation': { + 'description': '\nCalculates the calibration constants for the voltage level for the\nspecified output channel. This function compares the array in\n**requestedOutputs** to the array in **measuredOutputs** and calculates\nthe calibration constants for the voltage level of the output channel.\nRefer to the calibration procedure of the device you are calibrating for\ndetailed instructions on the appropriate use of this function. This\nfunction can be called only in an external calibration session.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument calibration session. **vi** is\nobtained from the niDCPower_InitExtCal function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument calibration session. **vi** is -obtained from the niDCPower_InitExtCal function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': 'Specifies the output channel to which these calibration settings apply.' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': 'Specifies the output channel to which these calibration settings apply.', -}, + 'type': 'ViConstString' }, { 'direction': 'in', - 'name': 'Range', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the range to calibrate with these settings. Only one channel -at a time may be calibrated. -''', -}, + 'documentation': { + 'description': '\nSpecifies the range to calibrate with these settings. Only one channel\nat a time may be calibrated.\n' + }, + 'name': 'range', + 'type': 'ViReal64' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the number of elements in **requestedOutputs** and\n**measuredOutputs**.\n' + }, 'name': 'numberOfMeasurements', - 'type': 'ViUInt32', -'documentation': { -'description': ''' -Specifies the number of elements in **requestedOutputs** and -**measuredOutputs**. -''', -}, + 'type': 'ViUInt32' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies an array of the output values requested in the\nniDCPower_ConfigureVoltageLevel function.\n' + }, 'name': 'requestedOutputs', - 'type': 'ViReal64[]', -'documentation': { -'description': ''' -Specifies an array of the output values requested in the -niDCPower_ConfigureVoltageLevel function. -''', -}, + 'type': 'ViReal64' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies an array of the output values measured by an external\nprecision digital multimeter.\n' + }, 'name': 'measuredOutputs', - 'type': 'ViReal64[]', -'documentation': { -'description': ''' -Specifies an array of the output values measured by an external -precision digital multimeter. -''', -}, - }, - ], -'documentation': { -'description': ''' -Calculates the calibration constants for the voltage level for the -specified output channel. This function compares the array in -**requestedOutputs** to the array in **measuredOutputs** and calculates -the calibration constants for the voltage level of the output channel. -Refer to the calibration procedure of the device you are calibrating for -detailed instructions on the appropriate use of this function. This -function can be called only in an external calibration session. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, 'CalAdjustVoltageMeasurement': { - 'returns': 'ViStatus', + 'codegen_method': 'no', + 'documentation': { + 'description': '\nCalculates the calibration constants for the voltage measurements\nreturned by the niDCPower_Measure function for the specified output\nchannel. This function compares the array in **reportedOutputs** to the\narray in **measuredOutputs** and calculates the calibration constants\nfor the voltage measurements returned by the niDCPower_Measure\nfunction. Refer to the calibration procedure for the device you are\ncalibrating for detailed instructions on the appropriate use of this\nfunction. This function can only be called in an external calibration\nsession.\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument calibration session. **vi** is\nobtained from the niDCPower_InitExtCal function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument calibration session. **vi** is -obtained from the niDCPower_InitExtCal function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': 'Specifies the channel name to which these calibration settings apply.' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': 'Specifies the channel name to which these calibration settings apply.', -}, + 'type': 'ViConstString' }, { 'direction': 'in', - 'name': 'Range', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the range to calibrate with these settings. Only one channel -at a time may be calibrated. -''', -}, + 'documentation': { + 'description': '\nSpecifies the range to calibrate with these settings. Only one channel\nat a time may be calibrated.\n' + }, + 'name': 'range', + 'type': 'ViReal64' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the number of elements in **reportedOutputs** and\n**measuredOutputs**.\n' + }, 'name': 'numberOfMeasurements', - 'type': 'ViUInt32', -'documentation': { -'description': ''' -Specifies the number of elements in **reportedOutputs** and -**measuredOutputs**. -''', -}, + 'type': 'ViUInt32' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies an array of the output values that were returned by the\nniDCPower_Measure function.\n' + }, 'name': 'reportedOutputs', - 'type': 'ViReal64[]', -'documentation': { -'description': ''' -Specifies an array of the output values that were returned by the -niDCPower_Measure function. -''', -}, + 'type': 'ViReal64' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies an array of the output values measured by an external\nprecision digital multimeter.\n' + }, 'name': 'measuredOutputs', - 'type': 'ViReal64[]', -'documentation': { -'description': ''' -Specifies an array of the output values measured by an external -precision digital multimeter. -''', -}, - }, - ], -'documentation': { -'description': ''' -Calculates the calibration constants for the voltage measurements -returned by the niDCPower_Measure function for the specified output -channel. This function compares the array in **reportedOutputs** to the -array in **measuredOutputs** and calculates the calibration constants -for the voltage measurements returned by the niDCPower_Measure -function. Refer to the calibration procedure for the device you are -calibrating for detailed instructions on the appropriate use of this -function. This function can only be called in an external calibration -session. -''', -}, + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, 'CalSelfCalibrate': { - 'returns': 'ViStatus', + 'documentation': { + 'description': '\nPerforms a self-calibration upon the specified channel(s).\n\nThis function disables the output, performs several internal\ncalculations, and updates calibration values. The updated calibration\nvalues are written to the device hardware if the\nNIDCPOWER_ATTR_SELF_CALIBRATION_PERSISTENCE attribute is set to\nNIDCPOWER_VAL_WRITE_TO_EEPROM. Refer to the\nNIDCPOWER_ATTR_SELF_CALIBRATION_PERSISTENCE attribute topic for more\ninformation about the settings for this attribute.\n\nWhen calling niDCPower_CalSelfCalibrate with the PXIe-4162/4163,\nspecify all channels of your PXIe-4162/4163 with the channelName input.\nYou cannot self-calibrate a subset of PXIe-4162/4163 channels.\n\nRefer to the\n`Self-Calibration `__ topic for\nmore information about this function.\n\n**Related Topics:**\n\n`Self-Calibration `__\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - ], -'documentation': { -'description': ''' -Performs a self-calibration upon the specified channel(s). - -This function disables the output, performs several internal -calculations, and updates calibration values. The updated calibration -values are written to the device hardware if the -NIDCPOWER_ATTR_SELF_CALIBRATION_PERSISTENCE attribute is set to -NIDCPOWER_VAL_WRITE_TO_EEPROM. Refer to the -NIDCPOWER_ATTR_SELF_CALIBRATION_PERSISTENCE attribute topic for more -information about the settings for this attribute. - -When calling niDCPower_CalSelfCalibrate with the PXIe-4162/4163, -specify all channels of your PXIe-4162/4163 with the channelName input. -You cannot self-calibrate a subset of PXIe-4162/4163 channels. - -Refer to the -`Self-Calibration `__ topic for -more information about this function. - -**Related Topics:** - -`Self-Calibration `__ -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'type': 'ViConstString' + } + ], + 'python_name': 'self_cal', + 'returns': 'ViStatus' }, 'ChangeExtCalPassword': { - 'returns': 'ViStatus', + 'codegen_method': 'no', + 'documentation': { + 'description': '\nChanges the **password** that is required to initialize an external\ncalibration session. The **password** can be a maximum of four\nalphanumeric characters. If you call this function in a session,\n**password** is changed immediately. If you call this function in an\nexternal calibration session, **password** is changed only after you\nclose the session using the niDCPower_CloseExtCal function with\n**action** set to NIDCPOWER_VAL_COMMIT.\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitExtCal or niDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitExtCal or niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': 'Specifies the previous password used to protect the calibration values.' + }, 'name': 'oldPassword', - 'type': 'ViChar[]', -'documentation': { -'description': 'Specifies the previous password used to protect the calibration values.', -}, + 'type': 'ViConstString' }, { 'direction': 'in', + 'documentation': { + 'description': 'Specifies the new password to use to protect the calibration values.' + }, 'name': 'newPassword', - 'type': 'ViChar[]', -'documentation': { -'description': 'Specifies the new password to use to protect the calibration values.', -}, - }, - ], -'documentation': { -'description': ''' -Changes the **password** that is required to initialize an external -calibration session. The **password** can be a maximum of four -alphanumeric characters. If you call this function in a session, -**password** is changed immediately. If you call this function in an -external calibration session, **password** is changed only after you -close the session using the niDCPower_CloseExtCal function with -**action** set to NIDCPOWER_VAL_COMMIT. -''', -}, + 'type': 'ViConstString' + } + ], + 'returns': 'ViStatus' }, 'ClearError': { - 'returns': 'ViStatus', + 'codegen_method': 'no', + 'documentation': { + 'description': '\n| Clears the error code and error description for the IVI session. If\n the user specifies a valid IVI session for **vi**, this function\n clears the error information for the session. If the user passes\n VI_NULL for **vi**, this function clears the error information for\n the current execution thread. If the ViSession parameter is an invalid\n session, the function does nothing and returns an error.\n| The function clears the error code by setting it to VI_SUCCESS. If\n the error description string is non-NULL, the function de-allocates\n the error description string and sets the address to VI_NULL.\n| Maintaining the error information separately for each thread is useful\n if the user does not have a session handle to pass to the\n niDCPower_GetError function, which occurs when a call to\n niDCPower_InitializeWithChannels fails.\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, - }, + 'type': 'ViSession' + } ], -'documentation': { -'description': ''' -| Clears the error code and error description for the IVI session. If - the user specifies a valid IVI session for **vi**, this function - clears the error information for the session. If the user passes - VI_NULL for **vi**, this function clears the error information for - the current execution thread. If the ViSession parameter is an invalid - session, the function does nothing and returns an error. -| The function clears the error code by setting it to VI_SUCCESS. If - the error description string is non-NULL, the function de-allocates - the error description string and sets the address to VI_NULL. -| Maintaining the error information separately for each thread is useful - if the user does not have a session handle to pass to the - niDCPower_GetError function, which occurs when a call to - niDCPower_InitializeWithChannels fails. -''', -}, + 'returns': 'ViStatus' }, 'ClearInterchangeWarnings': { - 'returns': 'ViStatus', + 'codegen_method': 'no', + 'documentation': { + 'description': 'Clears the list of current interchange warnings.' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, - }, + 'type': 'ViSession' + } ], -'documentation': { -'description': 'Clears the list of current interchange warnings.', -}, + 'returns': 'ViStatus' }, 'CloseExtCal': { - 'returns': 'ViStatus', + 'codegen_method': 'no', + 'documentation': { + 'description': '\nCloses the session specified in **vi** and deallocates the resources\nthat NI-DCPower reserved for calibration. Refer to the calibration\nprocedure for the device you are calibrating for detailed instructions\non the appropriate use of this function.\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument calibration session. **vi** is\nobtained from the niDCPower_InitExtCal function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument calibration session. **vi** is -obtained from the niDCPower_InitExtCal function. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Action', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies how to use the calibration values from this session as the -session is closed. - -**Defined Values**: -''', -'table_body': [['NIDCPOWER_VAL_COMMIT (1002)', 'The new calibration constants are stored in the EEPROM.'], ['NIDCPOWER_VAL_CANCEL (1001)', 'The old calibration constants are kept, and the new ones are discarded.']], -}, - }, - ], -'documentation': { -'description': ''' -Closes the session specified in **vi** and deallocates the resources -that NI-DCPower reserved for calibration. Refer to the calibration -procedure for the device you are calibrating for detailed instructions -on the appropriate use of this function. -''', -}, + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies how to use the calibration values from this session as the\nsession is closed.\n\n**Defined Values**:\n', + 'table_body': [ + [ + 'NIDCPOWER_VAL_COMMIT (1002)', + 'The new calibration constants are stored in the EEPROM.' + ], + [ + 'NIDCPOWER_VAL_CANCEL (1001)', + 'The old calibration constants are kept, and the new ones are discarded.' + ] + ] + }, + 'name': 'action', + 'type': 'ViInt32' + } + ], + 'returns': 'ViStatus' }, 'Commit': { - 'returns': 'ViStatus', + 'documentation': { + 'description': '\nApplies previously configured settings to the device. Calling this\nfunction moves the NI-DCPower session from the Uncommitted state into\nthe Committed state. After calling this function, modifying any\nattribute reverts the NI-DCPower session to the Uncommitted state. Use\nthe niDCPower_Initiate function to transition to the Running state.\nRefer to the `Programming\nStates `__ topic in\nthe *NI DC Power Supplies and SMUs Help* for details about the specific\nNI-DCPower software states.\n\n**Related Topics:**\n\n`Programming\nStates `__\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, - }, - ], -'documentation': { -'description': ''' -Applies previously configured settings to the device. Calling this -function moves the NI-DCPower session from the Uncommitted state into -the Committed state. After calling this function, modifying any -attribute reverts the NI-DCPower session to the Uncommitted state. Use -the niDCPower_Initiate function to transition to the Running state. -Refer to the `Programming -States `__ topic in -the *NI DC Power Supplies and SMUs Help* for details about the specific -NI-DCPower software states. - -**Related Topics:** - -`Programming -States `__ -''', -}, + 'type': 'ViSession' + } + ], + 'returns': 'ViStatus' }, - 'ConfigureApertureTime': { - 'returns': 'ViStatus', + 'CommitWithChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, + 'type': 'ViConstString' + } + ], + 'returns': 'ViStatus' + }, + 'ConfigureApertureTime': { + 'documentation': { + 'description': '\nConfigures the aperture time on the specified channel(s).\n\nThe supported values depend on the **units**. Refer to the *Aperture\nTime* topic for your device in the *NI DC Power Supplies and SMUs Help*\nfor more information. In general, devices support discrete\n**apertureTime** values, and if you configure **apertureTime** to some\nunsupported value, NI-DCPower coerces it up to the next supported value.\n\nRefer to the *Measurement Configuration and Timing* or *DC Noise\nRejection* topic for your device in the *NI DC Power Supplies and SMUs\nHelp* for more information about how to configure your measurements.\n\n**Related Topics:**\n\n`Aperture Time `__\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'apertureTime', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the aperture time. Refer to the *Aperture Time* topic for your -device in the *NI DC Power Supplies and SMUs Help* for more information. -''', -}, + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, + 'name': 'channelName', + 'type': 'ViConstString' }, { 'direction': 'in', - 'name': 'Units', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the units for **apertureTime**. -**Defined Values**: -''', -'table_body': [['NIDCPOWER_VAL_SECONDS (1028)', 'Specifies seconds.'], ['NIDCPOWER_VAL_POWER_LINE_CYCLES (1029)', 'Specifies Power Line Cycles.']], -}, - }, - ], -'documentation': { -'description': ''' -Configures the aperture time on the specified channel(s). - -The supported values depend on the **units**. Refer to the *Aperture -Time* topic for your device in the *NI DC Power Supplies and SMUs Help* -for more information. In general, devices support discrete -**apertureTime** values, and if you configure **apertureTime** to some -unsupported value, NI-DCPower coerces it up to the next supported value. - -Refer to the *Measurement Configuration and Timing* or *DC Noise -Rejection* topic for your device in the *NI DC Power Supplies and SMUs -Help* for more information about how to configure your measurements. - -**Related Topics:** - -`Aperture Time `__ -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'documentation': { + 'description': '\nSpecifies the aperture time. Refer to the *Aperture Time* topic for your\ndevice in the *NI DC Power Supplies and SMUs Help* for more information.\n' + }, + 'name': 'apertureTime', + 'type': 'ViReal64' + }, + { + 'default_value': 'ApertureTimeUnits.SECONDS', + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the units for **apertureTime**.\n**Defined Values**:\n', + 'table_body': [ + [ + 'NIDCPOWER_VAL_SECONDS (1028)', + 'Specifies seconds.' + ], + [ + 'NIDCPOWER_VAL_POWER_LINE_CYCLES (1029)', + 'Specifies Power Line Cycles.' + ] + ] + }, + 'enum': 'ApertureTimeUnits', + 'name': 'units', + 'type': 'ViInt32' + } + ], + 'returns': 'ViStatus' }, 'ConfigureAutoZero': { - 'returns': 'ViStatus', + 'codegen_method': 'no', + 'documentation': { + 'description': '\nConfigures auto zero for the device.\n\nRefer to the `NI PXI-4132 Auto\nZero `__ and `NI PXI-4132\nMeasurement Configuration and\nTiming `__\ntopics in the *NI DC Power Supplies and SMUs Help* for more information\nabout how to configure your measurements.\n\n**Related Topics:**\n\n`Auto Zero `__\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - { - 'direction': 'in', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the auto-zero setting. Refer to the *Measurement Configuration\nand Timing* topic and the *Auto Zero* topic for your device for more\ninformation about how to configure your measurements.\n**Defined Values:**\n', + 'table_body': [ + [ + 'NIDCPOWER_VAL_OFF (0)', + 'Disables auto-zero.' + ], + [ + 'NIDCPOWER_VAL_ONCE (1024)', + 'Makes zero conversions following the first measurement after initiating the device. The device uses these zero conversions for the preceding measurement and future measurements until the device is reinitiated.' + ], + [ + 'NIDCPOWER_VAL_ON (1)', + 'Makes zero conversions for every measurement.' + ] + ] + }, + 'enum': 'AutoZero', 'name': 'autoZero', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the auto-zero setting. Refer to the *Measurement Configuration -and Timing* topic and the *Auto Zero* topic for your device for more -information about how to configure your measurements. -**Defined Values:** -''', -'table_body': [['NIDCPOWER_VAL_OFF (0)', 'Disables auto-zero.'], ['NIDCPOWER_VAL_ONCE (1024)', 'Makes zero conversions following the first measurement after initiating the device. The device uses these zero conversions for the preceding measurement and future measurements until the device is reinitiated.'], ['NIDCPOWER_VAL_ON (1)', 'Makes zero conversions for every measurement.']], -}, - }, - ], -'documentation': { -'description': ''' -Configures auto zero for the device. - -Refer to the `NI PXI-4132 Auto -Zero `__ and `NI PXI-4132 -Measurement Configuration and -Timing `__ -topics in the *NI DC Power Supplies and SMUs Help* for more information -about how to configure your measurements. - -**Related Topics:** - -`Auto Zero `__ -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'type': 'ViInt32' + } + ], + 'returns': 'ViStatus' }, 'ConfigureCurrentLevel': { - 'returns': 'ViStatus', + 'codegen_method': 'no', + 'documentation': { + 'description': "\nConfigures the current level the device attempts to generate for the\nspecified channel(s). The channel must be enabled for the specified\ncurrent level to take effect. Refer to the\nniDCPower_ConfigureOutputEnabled function for more information about\nenabling the output channel.\n\nThe current level setting is applicable only if the output function of\nthe channel is set to NIDCPOWER_VAL_DC_CURRENT. Use\nnidcpower_ConfigureOutputFunction to set the output function. The\ndevice actively regulates the current at the specified level unless\ndoing so causes a voltage greater than the\nniDCPower_ConfigureVoltageLimit across the channels' output terminals.\n\n**Related Topics:**\n\n`Constant Current\nMode `__\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Level', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the current level, in amps, to generate for the specified -channel(s). -**Valid Values:** -The valid values for this parameter are defined by the current level -range that is configured using the niDCPower_ConfigureCurrentlevelRange -function. -''', -}, - }, - ], -'documentation': { -'description': ''' -Configures the current level the device attempts to generate for the -specified channel(s). The channel must be enabled for the specified -current level to take effect. Refer to the -niDCPower_ConfigureOutputEnabled function for more information about -enabling the output channel. - -The current level setting is applicable only if the output function of -the channel is set to NIDCPOWER_VAL_DC_CURRENT. Use -nidcpower_ConfigureOutputFunction to set the output function. The -device actively regulates the current at the specified level unless -doing so causes a voltage greater than the -niDCPower_ConfigureVoltageLimit across the channels' output terminals. - -**Related Topics:** - -`Constant Current -Mode `__ -''', -}, + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the current level, in amps, to generate for the specified\nchannel(s).\n**Valid Values:**\nThe valid values for this parameter are defined by the current level\nrange that is configured using the niDCPower_ConfigureCurrentlevelRange\nfunction.\n' + }, + 'name': 'level', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, 'ConfigureCurrentLevelRange': { - 'returns': 'ViStatus', + 'codegen_method': 'no', + 'documentation': { + 'description': '\nConfigures the current level range for the specified channel(s). The\nconfigured range defines the valid values the current level can be set\nto using the niDCPower_ConfigureCurrentLevel function. The current\nlevel range setting is applicable only if the output function of the\nchannel is set to NIDCPOWER_VAL_DC_CURRENT. Use\nnidcpower_ConfigureOutputFunction to set the output function.\n\nUse the NIDCPOWER_ATTR_CURRENT_LEVEL_AUTORANGE attribute to enable\nautomatic selection of the current level range.\n\n**Related Topics:**\n\n`Ranges `__\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Range', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the current level range, in amps, for the specified channel. -For valid ranges, refer to the *ranges* topic for your device in the *NI -DC Power Supplies and SMUs Help*. -''', -}, - }, - ], -'documentation': { -'description': ''' -Configures the current level range for the specified channel(s). The -configured range defines the valid values the current level can be set -to using the niDCPower_ConfigureCurrentLevel function. The current -level range setting is applicable only if the output function of the -channel is set to NIDCPOWER_VAL_DC_CURRENT. Use -nidcpower_ConfigureOutputFunction to set the output function. - -Use the NIDCPOWER_ATTR_CURRENT_LEVEL_AUTORANGE attribute to enable -automatic selection of the current level range. - -**Related Topics:** - -`Ranges `__ -''', -}, + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the current level range, in amps, for the specified channel.\nFor valid ranges, refer to the *ranges* topic for your device in the *NI\nDC Power Supplies and SMUs Help*.\n' + }, + 'name': 'range', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, 'ConfigureCurrentLimit': { - 'returns': 'ViStatus', + 'codegen_method': 'no', + 'documentation': { + 'description': '\n| Configures the current limit for the specified channel(s). The channel\n must be enabled for the specified current limit to take effect. Refer\n to the niDCPower_ConfigureOutputEnabled function for more information\n about enabling the output channel.\n| The current limit is the current that the output should not exceed\n when generating the desired niDCPower_ConfigureVoltageLevel. The\n current limit setting is applicable only if the output function of the\n channel is set to NIDCPOWER_VAL_DC_VOLTAGE. Use\n nidcpower_ConfigureOutputFunction to set the output function.\n\n**Related Topics:**\n\n`Compliance `__\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Behavior', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies how the output should behave when the current limit is -reached. -**Defined Values:** -''', -'table_body': [['NIDCPOWER_VAL_CURRENT_REGULATE', 'Controls output current so that it does not exceed the current limit. Power continues to generate even if the current limit is reached.']], -}, + 'type': 'ViConstString' }, { 'direction': 'in', - 'name': 'Limit', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the current limit, in amps, on the specified channel(s). The -limit is specified as a positive value, but symmetric positive and -negative limits are enforced simultaneously. -**Valid Values:** -The valid values for this parameter are defined by the current limit -range that is configured using the niDCPower_ConfigureCurrentlimitRange -function. -''', -}, - }, - ], -'documentation': { -'description': ''' -| Configures the current limit for the specified channel(s). The channel - must be enabled for the specified current limit to take effect. Refer - to the niDCPower_ConfigureOutputEnabled function for more information - about enabling the output channel. -| The current limit is the current that the output should not exceed - when generating the desired niDCPower_ConfigureVoltageLevel. The - current limit setting is applicable only if the output function of the - channel is set to NIDCPOWER_VAL_DC_VOLTAGE. Use - nidcpower_ConfigureOutputFunction to set the output function. - -**Related Topics:** - -`Compliance `__ -''', -}, + 'documentation': { + 'description': '\nSpecifies how the output should behave when the current limit is\nreached.\n**Defined Values:**\n', + 'table_body': [ + [ + 'NIDCPOWER_VAL_CURRENT_REGULATE', + 'Controls output current so that it does not exceed the current limit. Power continues to generate even if the current limit is reached.' + ] + ] + }, + 'name': 'behavior', + 'type': 'ViInt32' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the current limit, in amps, on the specified channel(s). The\nlimit is specified as a positive value, but symmetric positive and\nnegative limits are enforced simultaneously.\n**Valid Values:**\nThe valid values for this parameter are defined by the current limit\nrange that is configured using the niDCPower_ConfigureCurrentlimitRange\nfunction.\n' + }, + 'name': 'limit', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, 'ConfigureCurrentLimitRange': { - 'returns': 'ViStatus', + 'codegen_method': 'no', + 'documentation': { + 'description': '\nConfigures the current limit range for the specified channel(s).The\nconfigured range defines the valid values the current limit can be set\nto using the niDCPower_ConfigureCurrentLimit function. The current\nlimit range setting is applicable only if the output function of the\nchannel is set to NIDCPOWER_VAL_DC_VOLTAGE. Use\nnidcpower_ConfigureOutputFunction to set the output function.\n\nUse the NIDCPOWER_ATTR_CURRENT_LIMIT_AUTORANGE attribute to enable\nautomatic selection of the current limit range.\n\n**Related Topics:**\n\n`Ranges `__\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Range', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the current limit range, in amps, for the specified channel. -For valid ranges, refer to the *ranges* topic for your device in the *NI -DC Power Supplies and SMUs Help*. -''', -}, - }, - ], -'documentation': { -'description': ''' -Configures the current limit range for the specified channel(s).The -configured range defines the valid values the current limit can be set -to using the niDCPower_ConfigureCurrentLimit function. The current -limit range setting is applicable only if the output function of the -channel is set to NIDCPOWER_VAL_DC_VOLTAGE. Use -nidcpower_ConfigureOutputFunction to set the output function. - -Use the NIDCPOWER_ATTR_CURRENT_LIMIT_AUTORANGE attribute to enable -automatic selection of the current limit range. - -**Related Topics:** - -`Ranges `__ -''', -}, + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the current limit range, in amps, for the specified channel.\nFor valid ranges, refer to the *ranges* topic for your device in the *NI\nDC Power Supplies and SMUs Help*.\n' + }, + 'name': 'range', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, 'ConfigureDigitalEdgeMeasureTrigger': { - 'returns': 'ViStatus', + 'codegen_method': 'no', + 'documentation': { + 'description': 'Configures the Measure trigger for digital edge triggering.', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the input terminal for the digital edge Measure trigger.\n\nYou can specify any valid input terminal for this function. Valid\nterminals are listed in MAX under the **Device Routes** tab. For\nPXIe-4162/4163, refer to the Signal Routing topic for the device to\ndetermine which routes are available. This information is not available\non a Device Routes tab in MAX.\n\nInput terminals can be specified in one of two ways. If the device is\nnamed Dev1 and your terminal is PXI_Trig0, you can specify the terminal\nwith the fully qualified terminal name, /Dev1/PXI_Trig0, or with the\nshortened terminal name, PXI_Trig0. The input terminal can also be a\nterminal from another device. For example, you can set the input\nterminal on Dev1 to be /Dev2/SourceCompleteEvent.\n' + }, 'name': 'inputTerminal', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the input terminal for the digital edge Measure trigger. - -You can specify any valid input terminal for this function. Valid -terminals are listed in MAX under the **Device Routes** tab. For -PXIe-4162/4163, refer to the Signal Routing topic for the device to -determine which routes are available. This information is not available -on a Device Routes tab in MAX. - -Input terminals can be specified in one of two ways. If the device is -named Dev1 and your terminal is PXI_Trig0, you can specify the terminal -with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the -shortened terminal name, PXI_Trig0. The input terminal can also be a -terminal from another device. For example, you can set the input -terminal on Dev1 to be /Dev2/SourceCompleteEvent. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Edge', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies whether to configure the Measure trigger to assert on the -rising or falling edge. -**Defined Values:** -''', -'table_body': [['NIDCPOWER_VAL_RISING (1016)', 'Asserts the trigger on the rising edge of the digital signal.'], ['NIDCPOWER_VAL_FALLING (1017)', 'Asserts the trigger on the falling edge of the digital signal.']], -}, - }, - ], -'documentation': { -'description': 'Configures the Measure trigger for digital edge triggering.', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies whether to configure the Measure trigger to assert on the\nrising or falling edge.\n**Defined Values:**\n', + 'table_body': [ + [ + 'NIDCPOWER_VAL_RISING (1016)', + 'Asserts the trigger on the rising edge of the digital signal.' + ], + [ + 'NIDCPOWER_VAL_FALLING (1017)', + 'Asserts the trigger on the falling edge of the digital signal.' + ] + ] + }, + 'name': 'edge', + 'type': 'ViInt32' + } + ], + 'returns': 'ViStatus' }, - 'ConfigureDigitalEdgePulseTrigger': { - 'returns': 'ViStatus', + 'ConfigureDigitalEdgeMeasureTriggerWithChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' }, { 'direction': 'in', 'name': 'inputTerminal', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the input terminal for the digital edge Pulse trigger. - -You can specify any valid input terminal for this function. Valid -terminals are listed in MAX under the **Device Routes** tab. - -Input terminals can be specified in one of two ways. If the device is -named Dev1 and your terminal is PXI_Trig0, you can specify the terminal -with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the -shortened terminal name, PXI_Trig0. The input terminal can also be a -terminal from another device. For example, you can set the input -terminal on Dev1 to be /Dev2/SourceCompleteEvent. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Edge', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies whether to configure the Pulse trigger to assert on the rising -or falling edge. -**Defined Values:** -''', -'table_body': [['NIDCPOWER_VAL_RISING (1016)', 'Asserts the trigger on the rising edge of the digital signal.'], ['NIDCPOWER_VAL_FALLING (1017)', 'Asserts the trigger on the falling edge of the digital signal.']], -}, - }, - ], -'documentation': { -'description': 'Configures the Pulse trigger for digital edge triggering.', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'name': 'edge', + 'type': 'ViInt32' + } + ], + 'returns': 'ViStatus' }, - 'ConfigureDigitalEdgeSequenceAdvanceTrigger': { - 'returns': 'ViStatus', + 'ConfigureDigitalEdgePulseTrigger': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'Configures the Pulse trigger for digital edge triggering.', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the input terminal for the digital edge Pulse trigger.\n\nYou can specify any valid input terminal for this function. Valid\nterminals are listed in MAX under the **Device Routes** tab.\n\nInput terminals can be specified in one of two ways. If the device is\nnamed Dev1 and your terminal is PXI_Trig0, you can specify the terminal\nwith the fully qualified terminal name, /Dev1/PXI_Trig0, or with the\nshortened terminal name, PXI_Trig0. The input terminal can also be a\nterminal from another device. For example, you can set the input\nterminal on Dev1 to be /Dev2/SourceCompleteEvent.\n' + }, 'name': 'inputTerminal', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the input terminal for the digital edge Sequence Advance -trigger. - -You can specify any valid input terminal for this function. Valid -terminals are listed in MAX under the **Device Routes** tab. For -PXIe-4162/4163, refer to the Signal Routing topic for the device to -determine which routes are available. This information is not available -on a Device Routes tab in MAX. - -Input terminals can be specified in one of two ways. If the device is -named Dev1 and your terminal is PXI_Trig0, you can specify the terminal -with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the -shortened terminal name, PXI_Trig0. The input terminal can also be a -terminal from another device. For example, you can set the input -terminal on Dev1 to be /Dev2/SourceCompleteEvent. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Edge', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies whether to configure the Sequence Advance trigger to assert on -the rising or falling edge. -**Defined Values:** -''', -'table_body': [['NIDCPOWER_VAL_RISING (1016)', 'Asserts the trigger on the rising edge of the digital signal.'], ['NIDCPOWER_VAL_FALLING (1017)', 'Asserts the trigger on the falling edge of the digital signal.']], -}, - }, - ], -'documentation': { -'description': 'Configures the Sequence Advance trigger for digital edge triggering.', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies whether to configure the Pulse trigger to assert on the rising\nor falling edge.\n**Defined Values:**\n', + 'table_body': [ + [ + 'NIDCPOWER_VAL_RISING (1016)', + 'Asserts the trigger on the rising edge of the digital signal.' + ], + [ + 'NIDCPOWER_VAL_FALLING (1017)', + 'Asserts the trigger on the falling edge of the digital signal.' + ] + ] + }, + 'name': 'edge', + 'type': 'ViInt32' + } + ], + 'returns': 'ViStatus' }, - 'ConfigureDigitalEdgeSourceTrigger': { - 'returns': 'ViStatus', + 'ConfigureDigitalEdgePulseTriggerWithChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' }, { 'direction': 'in', 'name': 'inputTerminal', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the input terminal for the digital edge Source trigger. - -You can specify any valid input terminal for this function. Valid -terminals are listed in MAX under the **Device Routes** tab. For -PXIe-4162/4163, refer to the Signal Routing topic for the device to -determine which routes are available. This information is not available -on a Device Routes tab in MAX. - -Input terminals can be specified in one of two ways. If the device is -named Dev1 and your terminal is PXI_Trig0, you can specify the terminal -with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the -shortened terminal name, PXI_Trig0. The input terminal can also be a -terminal from another device. For example, you can set the input -terminal on Dev1 to be /Dev2/SourceCompleteEvent. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Edge', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies whether to configure the Source trigger to assert on the -rising or falling edge. -**Defined Values:** -''', -'table_body': [['NIDCPOWER_VAL_RISING (1016)', 'Asserts the trigger on the rising edge of the digital signal.'], ['NIDCPOWER_VAL_FALLING (1017)', 'Asserts the trigger on the falling edge of the digital signal.']], -}, - }, - ], -'documentation': { -'description': 'Configures the Source trigger for digital edge triggering.', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'name': 'edge', + 'type': 'ViInt32' + } + ], + 'returns': 'ViStatus' }, - 'ConfigureDigitalEdgeStartTrigger': { - 'returns': 'ViStatus', + 'ConfigureDigitalEdgeSequenceAdvanceTrigger': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'Configures the Sequence Advance trigger for digital edge triggering.', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the input terminal for the digital edge Sequence Advance\ntrigger.\n\nYou can specify any valid input terminal for this function. Valid\nterminals are listed in MAX under the **Device Routes** tab. For\nPXIe-4162/4163, refer to the Signal Routing topic for the device to\ndetermine which routes are available. This information is not available\non a Device Routes tab in MAX.\n\nInput terminals can be specified in one of two ways. If the device is\nnamed Dev1 and your terminal is PXI_Trig0, you can specify the terminal\nwith the fully qualified terminal name, /Dev1/PXI_Trig0, or with the\nshortened terminal name, PXI_Trig0. The input terminal can also be a\nterminal from another device. For example, you can set the input\nterminal on Dev1 to be /Dev2/SourceCompleteEvent.\n' + }, 'name': 'inputTerminal', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the input terminal for the digital edge Start trigger. - -You can specify any valid input terminal for this function. Valid -terminals are listed in MAX under the **Device Routes** tab. For -PXIe-4162/4163, refer to the Signal Routing topic for the device to -determine which routes are available. This information is not available -on a Device Routes tab in MAX. - -Input terminals can be specified in one of two ways. If the device is -named Dev1 and your terminal is PXI_Trig0, you can specify the terminal -with the fully qualified terminal name, /Dev1/PXI_Trig0, or with the -shortened terminal name, PXI_Trig0. The input terminal can also be a -terminal from another device. For example, you can set the input -terminal on Dev1 to be /Dev2/SourceCompleteEvent. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Edge', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies whether to configure the Start trigger to assert on the rising -or falling edge. -**Defined Values:** -''', -'table_body': [['NIDCPOWER_VAL_RISING (1016)', 'Asserts the trigger on the rising edge of the digital signal.'], ['NIDCPOWER_VAL_FALLING (1017)', 'Asserts the trigger on the falling edge of the digital signal.']], -}, - }, - ], -'documentation': { -'description': 'Configures the Start trigger for digital edge triggering.', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies whether to configure the Sequence Advance trigger to assert on\nthe rising or falling edge.\n**Defined Values:**\n', + 'table_body': [ + [ + 'NIDCPOWER_VAL_RISING (1016)', + 'Asserts the trigger on the rising edge of the digital signal.' + ], + [ + 'NIDCPOWER_VAL_FALLING (1017)', + 'Asserts the trigger on the falling edge of the digital signal.' + ] + ] + }, + 'name': 'edge', + 'type': 'ViInt32' + } + ], + 'returns': 'ViStatus' }, - 'ConfigureOutputEnabled': { - 'returns': 'ViStatus', + 'ConfigureDigitalEdgeSequenceAdvanceTriggerWithChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Enabled', - 'type': 'ViBoolean', -'documentation': { -'description': ''' -Specifies whether the output is enabled or disabled. -**Defined Values**: -''', -'table_body': [['VI_TRUE', 'Enables generation on the specified output channel(s).'], ['VI_FALSE', 'Disables generation on the specified output channel(s). This parameter has no effect on the output disconnect relay. To toggle the relay, use the NIDCPOWER_ATTR_OUTPUT_CONNECTED attribute.']], -}, - }, - ], -'documentation': { -'description': ''' -Enables or disables generation on the specified channel(s). Depending on -the selected output function, the voltage level, current level,or output -resistance must be set in addition to enabling the output to generate -the desired level. For more information about configuring the output -level, refer to niDCPower_ConfigureOutputFunction. -''', -'note': ''' -If the device is in the -`Uncommitted `__ -state, enabling the output does not take effect until you call the -niDCPower_Initiate function. -''', -}, + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'name': 'inputTerminal', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'name': 'edge', + 'type': 'ViInt32' + } + ], + 'returns': 'ViStatus' }, - 'ConfigureOutputFunction': { - 'returns': 'ViStatus', + 'ConfigureDigitalEdgeSourceTrigger': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'Configures the Source trigger for digital edge triggering.', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Function', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Configures the function to generate for the specified channel(s). -**Defined Values**: -''', -'table_body': [['NIDCPOWER_VAL_DC_VOLTAGE (1006)', 'Sets the output function to DC voltage.'], ['NIDCPOWER_VAL_DC_CURRENT (1007)', 'Sets the output function to DC current.'], ['NIDCPOWER_VAL_PULSE_VOLTAGE (1049)', 'Sets the output function to pulse voltage.'], ['NIDCPOWER_VAL_PULSE_CURRENT (1050)', 'Sets the output function to pulse current.']], -}, - }, - ], -'documentation': { -'description': ''' -Configures the function the device attempts to generate for the -specified channel(s). - -When NIDCPOWER_VAL_DC_VOLTAGE is selected, the device generates the -desired voltage level on the output as long as the output current is -below the current limit. The following functions can be used to -configure the channel when NIDCPOWER_VAL_DC_VOLTAGE is selected: - -- niDCPower_ConfigureVoltageLevel -- niDCPower_ConfigureCurrentLimit -- niDCPower_ConfigureVoltageLevelRange -- niDCPower_ConfigureCurrentLimitRange - -When NIDCPOWER_VAL_DC_CURRENT is selected, the device generates the -desired current level on the output as long as the output voltage is -below the voltage limit. The following functions can be used to -configure the channel when NIDCPOWER_VAL_DC_CURRENT is selected: - -- niDCPower_ConfigureCurrentLevel -- niDCPower_ConfigureVoltageLimit -- niDCPower_ConfigureCurrentLevelRange -- niDCPower_ConfigureVoltageLimitRange - -When NIDCPOWER_VAL_PULSE_VOLTAGE is selected, the device generates -pulses at the desired voltage levels on the output as long as the output -current is below the current limit. The following VIs can be used to -configure the channel when NIDCPOWER_VAL_PULSE_VOLTAGE is selected: - -- niDCPower_ConfigurePulseVoltageLevel -- niDCPower_ConfigurePulseBiasVoltageLevel -- niDCPower_ConfigurePulseCurrentLimit -- niDCPower_ConfigurePulseBiasCurrentLimit -- niDCPower_ConfigurePulseVoltageLevelRange -- niDCPower_ConfigurePulseCurrentLimitRange - -When NIDCPOWER_VAL_PULSE_CURRENT is selected, the device generates -pulses at the desired current levels on the output as long as the output -voltage is below the voltage limit. The following VIs can be used to -configure the channel when NIDCPOWER_VAL_PULSE_CURRENT is selected: - -- niDCPower_ConfigurePulseCurrentLevel -- niDCPower_ConfigurePulseBiasCurrentLevel -- niDCPower_ConfigurePulseVoltageLimit -- niDCPower_ConfigurePulseBiasVoltageLimit -- niDCPower_ConfigurePulseCurrentLevelRange -- niDCPower_ConfigurePulseVoltageLimitRange - -**Related Topics:** - -`Constant Voltage -Mode `__ - -`Constant Current -Mode `__ -''', -}, + 'documentation': { + 'description': '\nSpecifies the input terminal for the digital edge Source trigger.\n\nYou can specify any valid input terminal for this function. Valid\nterminals are listed in MAX under the **Device Routes** tab. For\nPXIe-4162/4163, refer to the Signal Routing topic for the device to\ndetermine which routes are available. This information is not available\non a Device Routes tab in MAX.\n\nInput terminals can be specified in one of two ways. If the device is\nnamed Dev1 and your terminal is PXI_Trig0, you can specify the terminal\nwith the fully qualified terminal name, /Dev1/PXI_Trig0, or with the\nshortened terminal name, PXI_Trig0. The input terminal can also be a\nterminal from another device. For example, you can set the input\nterminal on Dev1 to be /Dev2/SourceCompleteEvent.\n' + }, + 'name': 'inputTerminal', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies whether to configure the Source trigger to assert on the\nrising or falling edge.\n**Defined Values:**\n', + 'table_body': [ + [ + 'NIDCPOWER_VAL_RISING (1016)', + 'Asserts the trigger on the rising edge of the digital signal.' + ], + [ + 'NIDCPOWER_VAL_FALLING (1017)', + 'Asserts the trigger on the falling edge of the digital signal.' + ] + ] + }, + 'name': 'edge', + 'type': 'ViInt32' + } + ], + 'returns': 'ViStatus' }, - 'ConfigureOutputRange': { - 'returns': 'ViStatus', + 'ConfigureDigitalEdgeSourceTriggerWithChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, + 'type': 'ViConstString' }, { 'direction': 'in', - 'name': 'rangeType', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the type of the range: voltage or current. -**Defined Values**: -''', -'table_body': [['NIDCPOWER_VAL_RANGE_CURRENT (0)', 'NI-DCPower configures the current range.'], ['NIDCPOWER_VAL_RANGE_VOLTAGE (1)', 'NI-DCPower configures the voltage range.']], -}, + 'name': 'inputTerminal', + 'type': 'ViConstString' }, { 'direction': 'in', - 'name': 'Range', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the range to calibrate with these settings. Only one channel -at a time may be calibrated. -''', -}, - }, - ], -'documentation': { -'description': ''' -Configures either the voltage level range or the current limit range. If -**range type** is Voltage, the voltage level range is configured. If -**range type** is Current, the current limit range is configured. - -This function does not configure any of the DC Current output function -settings. Refer to the niDCPower_ConfigureOutputFunction function for -more information. - -This is a deprecated function. You must use the following functions -instead of theniDCPower_ConfigureOutputRange function: - -- niDCPower_ConfigureVoltageLevel -- niDCPower_ConfigureVoltageLimit -- niDCPower_ConfigureCurrentLevel -- niDCPower_ConfigureCurrentLimit -''', -}, + 'name': 'edge', + 'type': 'ViInt32' + } + ], + 'returns': 'ViStatus' }, - 'ConfigureOutputResistance': { - 'returns': 'ViStatus', + 'ConfigureDigitalEdgeStartTrigger': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'Configures the Start trigger for digital edge triggering.', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Resistance', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the output resistance, in ohms, for the specified channel. -Refer to the `NI PXIe-4141 Programmable Output -resistance `__, -`NI PXIe-4143 Programmable Output -resistance `__, -`NI PXIe-4145 Programmable Output -resistance `__,or -`NI PXIe-4154 Programmable Output -resistance `__ -topic in the NI DC Power Supplies and SMUs Help for more information -about configuring output resistance. -''', -}, - }, - ], -'documentation': { -'description': ''' -Configures the output resistance that the device attempts to generate -for the specified channel or channels. The channel must be enabled for -the specified output resistance to take effect. - -Refer to the nidcpower_ConfigureOutputEnabled function for more -information about enabling the output channel. - -For NI PXIe-4141/4143/4145 devices, output resistance is only supported -if the output function of the channel is set to -NIDCPOWER_VAL_DC_VOLTAGE using the niDCPower_ConfigureOutputFunction -function. - -For PXIe-4135, NI PXIe-4137, and NI PXIe-4139 devices, output resistance -is supported if the output function of the channel is set to -NIDCPOWER_VAL_DC_CURRENT or NIDCPOWER_VAL_DC_VOLTAGE using the -niDCPower_ConfigureOutputFunction function. - -The device actively regulates the current and voltage to reach the -specified output resistance, although in DC Voltage output mode, the -voltage at the output experiences a "virtual drop" that is proportional -to its current. In DC Current output mode, the output experiences a -"virtual leakage current" that is proportional to the output voltage. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'documentation': { + 'description': '\nSpecifies the input terminal for the digital edge Start trigger.\n\nYou can specify any valid input terminal for this function. Valid\nterminals are listed in MAX under the **Device Routes** tab. For\nPXIe-4162/4163, refer to the Signal Routing topic for the device to\ndetermine which routes are available. This information is not available\non a Device Routes tab in MAX.\n\nInput terminals can be specified in one of two ways. If the device is\nnamed Dev1 and your terminal is PXI_Trig0, you can specify the terminal\nwith the fully qualified terminal name, /Dev1/PXI_Trig0, or with the\nshortened terminal name, PXI_Trig0. The input terminal can also be a\nterminal from another device. For example, you can set the input\nterminal on Dev1 to be /Dev2/SourceCompleteEvent.\n' + }, + 'name': 'inputTerminal', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies whether to configure the Start trigger to assert on the rising\nor falling edge.\n**Defined Values:**\n', + 'table_body': [ + [ + 'NIDCPOWER_VAL_RISING (1016)', + 'Asserts the trigger on the rising edge of the digital signal.' + ], + [ + 'NIDCPOWER_VAL_FALLING (1017)', + 'Asserts the trigger on the falling edge of the digital signal.' + ] + ] + }, + 'name': 'edge', + 'type': 'ViInt32' + } + ], + 'returns': 'ViStatus' }, - 'ConfigurePowerLineFrequency': { - 'returns': 'ViStatus', + 'ConfigureDigitalEdgeStartTriggerWithChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'powerlineFrequency', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the power line frequency in hertz for specified channel(s). -NI-DCPower uses this value to select a timebase for the -NIDCPOWER_ATTR_APERTURE_TIME attribute. Refer to the *Measurement -Configuration and Timing* topic for your device for more information -about how to configure your measurements. -**Defined Values**: -''', -'note': 'Set this parameter to the frequency of the AC power line.', -'table_body': [['NIDCPOWER_VAL_50_HERTZ (50.0)', 'Specifies 50 Hz.'], ['NIDCPOWER_VAL_60_HERTZ (60.0)', 'Specifies 60 Hz.']], -}, - }, - ], -'documentation': { -'description': ''' -Specifies the power line frequency for specified channel(s). NI-DCPower -uses this value to select a timebase for setting the -niDCPower_ConfigureApertureTime function in power line cycles (PLCs). - -Refer to the *Measurement Configuration and Timing* topic for your -device in the *NI DC Power Supplies and SMUs Help* for more information -about how to configure your measurements. - -**Related Topics:** - -`Measurement Noise -Rejection `__ -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'name': 'inputTerminal', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'name': 'edge', + 'type': 'ViInt32' + } + ], + 'returns': 'ViStatus' }, - 'ConfigurePulseBiasCurrentLevel': { - 'returns': 'ViStatus', + 'ConfigureOutputEnabled': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nEnables or disables generation on the specified channel(s). Depending on\nthe selected output function, the voltage level, current level,or output\nresistance must be set in addition to enabling the output to generate\nthe desired level. For more information about configuring the output\nlevel, refer to niDCPower_ConfigureOutputFunction.\n', + 'note': "\nIf the device is in the\n`Uncommitted `__\nstate, enabling the output does not take effect until you call the\nniDCPower_Initiate function.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Level', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the pulse bias current level, in amps, on the specified -channel(s). -**Valid Values:** -The valid values for this parameter are defined by the pulse current -level range that is configured using the -niDCPower_ConfigurePulseCurrentlevelRange function. -''', -}, - }, - ], -'documentation': { -'description': ''' -Configures the pulse bias current level that the device attempts to -generate for the specified channel(s) during the off phase of a pulse. -The channel must be enabled for the specified current level to take -effect. - -Refer to the niDCPower_ConfigureOutputEnabled function for more -information about enabling the output channel. The pulse current level -setting is applicable only if the channel is set to the -NIDCPOWER_VAL_PULSE_CURRENT output function using the -niDCPower_ConfigureOutputFunction function. - -The device actively regulates the current at the specified level unless -doing so causes a voltage drop greater than the -NIDCPOWER_ATTR_PULSE_BIAS_VOLTAGE_LIMIT across the channels' output -terminals. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies whether the output is enabled or disabled.\n**Defined Values**:\n', + 'table_body': [ + [ + 'VI_TRUE', + 'Enables generation on the specified output channel(s).' + ], + [ + 'VI_FALSE', + 'Disables generation on the specified output channel(s). This parameter has no effect on the output disconnect relay. To toggle the relay, use the NIDCPOWER_ATTR_OUTPUT_CONNECTED attribute.' + ] + ] + }, + 'name': 'enabled', + 'type': 'ViBoolean' + } + ], + 'returns': 'ViStatus' }, - 'ConfigurePulseBiasCurrentLimit': { - 'returns': 'ViStatus', + 'ConfigureOutputFunction': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nConfigures the function the device attempts to generate for the\nspecified channel(s).\n\nWhen NIDCPOWER_VAL_DC_VOLTAGE is selected, the device generates the\ndesired voltage level on the output as long as the output current is\nbelow the current limit. The following functions can be used to\nconfigure the channel when NIDCPOWER_VAL_DC_VOLTAGE is selected:\n\n- niDCPower_ConfigureVoltageLevel\n- niDCPower_ConfigureCurrentLimit\n- niDCPower_ConfigureVoltageLevelRange\n- niDCPower_ConfigureCurrentLimitRange\n\nWhen NIDCPOWER_VAL_DC_CURRENT is selected, the device generates the\ndesired current level on the output as long as the output voltage is\nbelow the voltage limit. The following functions can be used to\nconfigure the channel when NIDCPOWER_VAL_DC_CURRENT is selected:\n\n- niDCPower_ConfigureCurrentLevel\n- niDCPower_ConfigureVoltageLimit\n- niDCPower_ConfigureCurrentLevelRange\n- niDCPower_ConfigureVoltageLimitRange\n\nWhen NIDCPOWER_VAL_PULSE_VOLTAGE is selected, the device generates\npulses at the desired voltage levels on the output as long as the output\ncurrent is below the current limit. The following VIs can be used to\nconfigure the channel when NIDCPOWER_VAL_PULSE_VOLTAGE is selected:\n\n- niDCPower_ConfigurePulseVoltageLevel\n- niDCPower_ConfigurePulseBiasVoltageLevel\n- niDCPower_ConfigurePulseCurrentLimit\n- niDCPower_ConfigurePulseBiasCurrentLimit\n- niDCPower_ConfigurePulseVoltageLevelRange\n- niDCPower_ConfigurePulseCurrentLimitRange\n\nWhen NIDCPOWER_VAL_PULSE_CURRENT is selected, the device generates\npulses at the desired current levels on the output as long as the output\nvoltage is below the voltage limit. The following VIs can be used to\nconfigure the channel when NIDCPOWER_VAL_PULSE_CURRENT is selected:\n\n- niDCPower_ConfigurePulseCurrentLevel\n- niDCPower_ConfigurePulseBiasCurrentLevel\n- niDCPower_ConfigurePulseVoltageLimit\n- niDCPower_ConfigurePulseBiasVoltageLimit\n- niDCPower_ConfigurePulseCurrentLevelRange\n- niDCPower_ConfigurePulseVoltageLimitRange\n\n**Related Topics:**\n\n`Constant Voltage\nMode `__\n\n`Constant Current\nMode `__\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Limit', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the pulse bias current limit, in amps, on the specified -channel(s). The limit is specified as a positive value, but symmetric -positive and negative limits are enforced simultaneously. -**Valid Values:** -The valid values for this parameter are defined by the pulse current -limit range that is configured using the -niDCPower_ConfigurePulseCurrentlimitRange function. -''', -}, - }, - ], -'documentation': { -'description': ''' -Configures the pulse bias current limit for the specified channel(s). -The channel must be enabled for the specified current limit to take -effect. - -Refer to the niDCPower_ConfigureOutputEnabled function for more -information about enabling the output channel. The pulse bias current -limit is the current that the output must not exceed when generating the -desired NIDCPOWER_ATTR_pULSE_bIAS_vOLTAGE_lEVEL. The pulse bias -current limit setting is only applicable if the channel is set to the -NIDCPOWER_VAL_PULSE_VOLTAGE output function using the -niDCPower_ConfigureOutputFunction function. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nConfigures the function to generate for the specified channel(s).\n**Defined Values**:\n', + 'table_body': [ + [ + 'NIDCPOWER_VAL_DC_VOLTAGE (1006)', + 'Sets the output function to DC voltage.' + ], + [ + 'NIDCPOWER_VAL_DC_CURRENT (1007)', + 'Sets the output function to DC current.' + ], + [ + 'NIDCPOWER_VAL_PULSE_VOLTAGE (1049)', + 'Sets the output function to pulse voltage.' + ], + [ + 'NIDCPOWER_VAL_PULSE_CURRENT (1050)', + 'Sets the output function to pulse current.' + ] + ] + }, + 'name': 'function', + 'type': 'ViInt32' + } + ], + 'returns': 'ViStatus' }, - 'ConfigurePulseBiasVoltageLevel': { - 'returns': 'ViStatus', + 'ConfigureOutputRange': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nConfigures either the voltage level range or the current limit range. If\n**range type** is Voltage, the voltage level range is configured. If\n**range type** is Current, the current limit range is configured.\n\nThis function does not configure any of the DC Current output function\nsettings. Refer to the niDCPower_ConfigureOutputFunction function for\nmore information.\n\nThis is a deprecated function. You must use the following functions\ninstead of theniDCPower_ConfigureOutputRange function:\n\n- niDCPower_ConfigureVoltageLevel\n- niDCPower_ConfigureVoltageLimit\n- niDCPower_ConfigureCurrentLevel\n- niDCPower_ConfigureCurrentLimit\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Level', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the pulse bias voltage level, in volts, for the output channel -generation. -**Valid Values**: -The valid values for this parameter are defined by the pulse voltage -level range that is selected using the -niDCPower_ConfigurePulseVoltagelevelRange function. -''', -}, - }, - ], -'documentation': { -'description': ''' -Configures the pulse bias voltage level that the device attempts to -generate for the specified channel(s) during the off phase of a pulse. -The channel must be enabled for the specified voltage level to take -effect. - -Refer to the niDCPower_ConfigureOutputEnabled function for more -information about enabling the output channel. The pulse bias voltage -level setting is applicable only if the channel is set to the -NIDCPOWER_VAL_PULSE_VOLTAGE output function using the -niDCPower_ConfigureOutputFunction function. - -The device actively regulates the voltage at the specified level unless -doing so causes a current greater than the -NIDCPOWER_ATTR_PULSE_BIAS_CURRENT_LIMIT through the channels' -output terminals. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the type of the range: voltage or current.\n**Defined Values**:\n', + 'table_body': [ + [ + 'NIDCPOWER_VAL_RANGE_CURRENT (0)', + 'NI-DCPower configures the current range.' + ], + [ + 'NIDCPOWER_VAL_RANGE_VOLTAGE (1)', + 'NI-DCPower configures the voltage range.' + ] + ] + }, + 'name': 'rangeType', + 'type': 'ViInt32' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the range to calibrate with these settings. Only one channel\nat a time may be calibrated.\n' + }, + 'name': 'range', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, - 'ConfigurePulseBiasVoltageLimit': { - 'returns': 'ViStatus', + 'ConfigureOutputResistance': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nConfigures the output resistance that the device attempts to generate\nfor the specified channel or channels. The channel must be enabled for\nthe specified output resistance to take effect.\n\nRefer to the nidcpower_ConfigureOutputEnabled function for more\ninformation about enabling the output channel.\n\nFor NI PXIe-4141/4143/4145 devices, output resistance is only supported\nif the output function of the channel is set to\nNIDCPOWER_VAL_DC_VOLTAGE using the niDCPower_ConfigureOutputFunction\nfunction.\n\nFor PXIe-4135, NI PXIe-4137, and NI PXIe-4139 devices, output resistance\nis supported if the output function of the channel is set to\nNIDCPOWER_VAL_DC_CURRENT or NIDCPOWER_VAL_DC_VOLTAGE using the\nniDCPower_ConfigureOutputFunction function.\n\nThe device actively regulates the current and voltage to reach the\nspecified output resistance, although in DC Voltage output mode, the\nvoltage at the output experiences a "virtual drop" that is proportional\nto its current. In DC Current output mode, the output experiences a\n"virtual leakage current" that is proportional to the output voltage.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Limit', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the pulse bias voltage limit, in volts, on the specified -channel(s). The limit is specified as a positive value, but symmetric -positive and negative limits are enforced simultaneously. -**Valid Values:** -The valid values for this parameter are defined by the pulse voltage -limit range that is configured using the -niDCPower_ConfigurePulseVoltagelimitRange function. -''', -}, - }, - ], -'documentation': { -'description': ''' -Configures the pulse bias voltage limit for the specified channel(s). -The channel must be enabled for the specified voltage limit to take -effect. - -Refer to the niDCPower_ConfigureOutputEnabled function for more -information about enabling the output channel. The pulse bias voltage -limit is the voltage that the output must not exceed when generating the -desired NIDCPOWER_ATTR_PULSE_bIAS_cURRENT_lEVEL. The pulse bias -voltage limit setting is only applicable if the channel is set to the -NIDCPOWER_VAL_PULSE_CURRENT output function using the -niDCPower_ConfigureOutputFunction function. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output resistance, in ohms, for the specified channel.\nRefer to the `NI PXIe-4141 Programmable Output\nresistance `__,\n`NI PXIe-4143 Programmable Output\nresistance `__,\n`NI PXIe-4145 Programmable Output\nresistance `__,or\n`NI PXIe-4154 Programmable Output\nresistance `__\ntopic in the NI DC Power Supplies and SMUs Help for more information\nabout configuring output resistance.\n' + }, + 'name': 'resistance', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, - 'ConfigurePulseCurrentLevel': { - 'returns': 'ViStatus', + 'ConfigureOvp': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Level', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the pulse current level, in amps, on the specified channel(s). -**Valid Values:** -The valid values for this parameter are defined by the pulse current -level range that is configured using the -niDCPower_ConfigurePulseCurrentlevelRange function. -''', -}, - }, - ], -'documentation': { -'description': ''' -Configures the pulse current level that the device attempts to generate -for the specified channel(s) during the on phase of a pulse. The channel -must be enabled for the specified current level to take effect. - -Refer to the niDCPower_ConfigureOutputEnabled function for more -information about enabling the output channel. The pulse current level -setting is applicable only if the channel is set to the -NIDCPOWER_VAL_PULSE_CURRENT output function using the -niDCPower_ConfigureOutputEnabled function. - -The device actively regulates the current at the specified level unless -doing so causes a voltage drop greater than the -NIDCPOWER_ATTR_PULSE_VOLTAGE_lIMIT across the channels' output -terminals. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, - }, - 'ConfigurePulseCurrentLevelRange': { - 'returns': 'ViStatus', - 'parameters': [ + 'type': 'ViConstString' + }, { 'direction': 'in', - 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'name': 'enabled', + 'type': 'ViBoolean' }, { 'direction': 'in', - 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Range', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the pulse current level range, in amps, on the specified -channel(s). -For valid ranges, refer to the *ranges* topic for your device in the *NI -DC Power Supplies and SMUs Help*. -''', -}, - }, - ], -'documentation': { -'description': ''' -Configures the pulse current level range for the specified channel(s). - -The configured range defines the valid values to which you can set the -pulse current level and pulse bias current level using the -niDCPower_ConfigurePulseCurrentLevel and -niDCPower_ConfigurePulseBiasCurrentLevel functions. The pulse current -level range setting is applicable only if the channel is set to the -NIDCPOWER_VAL_PULSE_CURRENT output function using the -niDCPower_ConfigureOutputFunction function. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'name': 'limit', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, - 'ConfigurePulseCurrentLimit': { - 'returns': 'ViStatus', + 'ConfigurePowerLineFrequency': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nSpecifies the power line frequency for specified channel(s). NI-DCPower\nuses this value to select a timebase for setting the\nniDCPower_ConfigureApertureTime function in power line cycles (PLCs).\n\nRefer to the *Measurement Configuration and Timing* topic for your\ndevice in the *NI DC Power Supplies and SMUs Help* for more information\nabout how to configure your measurements.\n\n**Related Topics:**\n\n`Measurement Noise\nRejection `__\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, - }, - { - 'direction': 'in', - 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Limit', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the pulse current limit, in amps, on the specified channel(s). -The limit is specified as a positive value, but symmetric positive and -negative limits are enforced simultaneously. -**Valid Values:** -The valid values for this parameter are defined by the pulse current -limit range that is configured using the -niDCPower_ConfigurePulseCurrentlimitRange function. -''', -}, - }, - ], -'documentation': { -'description': ''' -Configures the pulse current limit for the specified channel(s). The -channel must be enabled for the specified current limit to take effect. - -Refer to the niDCPower_ConfigureOutputEnabled function for more -information about enabling the output channel. The pulse current limit -is the current that the output must not exceed when generating the -desired NIDCPOWER_ATTR_PULSE_vOLTAGE_lEVEL. The pulse current limit -setting is only applicable if the channel is set to the -NIDCPOWER_VAL_PULSE_VOLTAGE output function using the -niDCPower_ConfigureOutputFunction function. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the power line frequency in hertz for specified channel(s).\nNI-DCPower uses this value to select a timebase for the\nNIDCPOWER_ATTR_APERTURE_TIME attribute. Refer to the *Measurement\nConfiguration and Timing* topic for your device for more information\nabout how to configure your measurements.\n**Defined Values**:\n', + 'note': 'Set this parameter to the frequency of the AC power line.', + 'table_body': [ + [ + 'NIDCPOWER_VAL_50_HERTZ (50.0)', + 'Specifies 50 Hz.' + ], + [ + 'NIDCPOWER_VAL_60_HERTZ (60.0)', + 'Specifies 60 Hz.' + ] + ] + }, + 'name': 'powerlineFrequency', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, - 'ConfigurePulseCurrentLimitRange': { - 'returns': 'ViStatus', + 'ConfigurePulseBiasCurrentLevel': { + 'codegen_method': 'no', + 'documentation': { + 'description': "\nConfigures the pulse bias current level that the device attempts to\ngenerate for the specified channel(s) during the off phase of a pulse.\nThe channel must be enabled for the specified current level to take\neffect.\n\nRefer to the niDCPower_ConfigureOutputEnabled function for more\ninformation about enabling the output channel. The pulse current level\nsetting is applicable only if the channel is set to the\nNIDCPOWER_VAL_PULSE_CURRENT output function using the\nniDCPower_ConfigureOutputFunction function.\n\nThe device actively regulates the current at the specified level unless\ndoing so causes a voltage drop greater than the\nNIDCPOWER_ATTR_PULSE_BIAS_VOLTAGE_LIMIT across the channels' output\nterminals.\n", + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Range', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the pulse current limit range, in amps, on the specified -channel(s). -For valid ranges, refer to the *ranges* topic for your device in the *NI -DC Power Supplies and SMUs Help*. -''', -}, - }, - ], -'documentation': { -'description': ''' -Configures the pulse current limit range for the specified channel(s). - -The configured range defines the valid values to which you can set the -pulse current limit and pulse bias current limit using the -niDCPower_ConfigurePulseCurrentLimit and -niDCPower_ConfigurePulseBiasCurrentLimit functions. The pulse current -limit range setting is applicable only if the channel is set to the -NIDCPOWER_VAL_PULSE_VOLTAGE output function using the -niDCPower_ConfigureOutputFunction function. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the pulse bias current level, in amps, on the specified\nchannel(s).\n**Valid Values:**\nThe valid values for this parameter are defined by the pulse current\nlevel range that is configured using the\nniDCPower_ConfigurePulseCurrentlevelRange function.\n' + }, + 'name': 'level', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, - 'ConfigurePulseVoltageLevel': { - 'returns': 'ViStatus', + 'ConfigurePulseBiasCurrentLimit': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nConfigures the pulse bias current limit for the specified channel(s).\nThe channel must be enabled for the specified current limit to take\neffect.\n\nRefer to the niDCPower_ConfigureOutputEnabled function for more\ninformation about enabling the output channel. The pulse bias current\nlimit is the current that the output must not exceed when generating the\ndesired NIDCPOWER_ATTR_pULSE_bIAS_vOLTAGE_lEVEL. The pulse bias\ncurrent limit setting is only applicable if the channel is set to the\nNIDCPOWER_VAL_PULSE_VOLTAGE output function using the\nniDCPower_ConfigureOutputFunction function.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Level', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the pulse voltage level, in volts, for the output channel -generation. -**Valid Values**: -The valid values for this parameter are defined by the voltage level -range that is selected using the -niDCPower_ConfigurePulseVoltagelevelRange function. -''', -}, - }, - ], -'documentation': { -'description': ''' -Configures the pulse voltage level that the device attempts to generate -for the specified channel(s) during the on phase of a pulse. The channel -must be enabled for the specified voltage level to take effect. - -Refer to the niDCPower_ConfigureOutputEnabled function for more -information about enabling the output channel. The pulse voltage level -setting is applicable only if the channel is set to the -NIDCPOWER_VAL_PULSE_VOLTAGE output function using the -niDCPower_ConfigureOutputFunction function. - -The device actively regulates the voltage at the specified level unless -doing so causes a current greater than the -NIDCPOWER_ATTR_PULSE_cURRENT_lIMIT through the channels' output -terminals. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the pulse bias current limit, in amps, on the specified\nchannel(s). The limit is specified as a positive value, but symmetric\npositive and negative limits are enforced simultaneously.\n**Valid Values:**\nThe valid values for this parameter are defined by the pulse current\nlimit range that is configured using the\nniDCPower_ConfigurePulseCurrentlimitRange function.\n' + }, + 'name': 'limit', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, - 'ConfigurePulseVoltageLevelRange': { - 'returns': 'ViStatus', + 'ConfigurePulseBiasVoltageLevel': { + 'codegen_method': 'no', + 'documentation': { + 'description': "\nConfigures the pulse bias voltage level that the device attempts to\ngenerate for the specified channel(s) during the off phase of a pulse.\nThe channel must be enabled for the specified voltage level to take\neffect.\n\nRefer to the niDCPower_ConfigureOutputEnabled function for more\ninformation about enabling the output channel. The pulse bias voltage\nlevel setting is applicable only if the channel is set to the\nNIDCPOWER_VAL_PULSE_VOLTAGE output function using the\nniDCPower_ConfigureOutputFunction function.\n\nThe device actively regulates the voltage at the specified level unless\ndoing so causes a current greater than the\nNIDCPOWER_ATTR_PULSE_BIAS_CURRENT_LIMIT through the channels'\noutput terminals.\n", + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Range', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the pulse voltage level range, in volts, on the specified -channel(s). -For valid ranges, refer to the *ranges* topic for your device in the *NI -DC Power Supplies and SMUs Help*. -''', -}, - }, - ], -'documentation': { -'description': ''' -Configures the pulse voltage level range for the specified channel(s). - -The configured range defines the valid values to which you can set the -pulse voltage level and pulse bias voltage level using the -niDCPower_ConfigurePulseVoltageLevel and -niDCPower_ConfigurePulseBiasVoltageLevel functions. The pulse voltage -level range setting is applicable only if the channel is set to the -NIDCPOWER_VAL_PULSE_VOLTAGE output function using the -niDCPower_ConfigureOutputFunction function. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the pulse bias voltage level, in volts, for the output channel\ngeneration.\n**Valid Values**:\nThe valid values for this parameter are defined by the pulse voltage\nlevel range that is selected using the\nniDCPower_ConfigurePulseVoltagelevelRange function.\n' + }, + 'name': 'level', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, - 'ConfigurePulseVoltageLimit': { - 'returns': 'ViStatus', + 'ConfigurePulseBiasVoltageLimit': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nConfigures the pulse bias voltage limit for the specified channel(s).\nThe channel must be enabled for the specified voltage limit to take\neffect.\n\nRefer to the niDCPower_ConfigureOutputEnabled function for more\ninformation about enabling the output channel. The pulse bias voltage\nlimit is the voltage that the output must not exceed when generating the\ndesired NIDCPOWER_ATTR_PULSE_bIAS_cURRENT_lEVEL. The pulse bias\nvoltage limit setting is only applicable if the channel is set to the\nNIDCPOWER_VAL_PULSE_CURRENT output function using the\nniDCPower_ConfigureOutputFunction function.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Limit', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the pulse voltage limit, in volts, on the specified output -channel(s). The limit is specified as a positive value, but symmetric -positive and negative limits are enforced simultaneously. -**Valid Values:** -The valid values for this parameter are defined by the pulse voltage -limit range that is configured using the -niDCPower_ConfigurePulseVoltagelimitRange function. -''', -}, - }, - ], -'documentation': { -'description': ''' -Configures the pulse voltage limit for the specified channel(s). The -channel must be enabled for the specified voltage limit to take effect. - -Refer to the niDCPower_ConfigureOutputEnabled function for more -information about enabling the output channel. The pulse voltage limit -is the voltage that the output must not exceed when generating the -desired NIDCPOWER_ATTR_PULSE_cURRENT_lEVEL. The pulse voltage limit -setting is only applicable if the channel is set to the -NIDCPOWER_VAL_PULSE_CURRENT output function using the -niDCPower_ConfigureOutputFunction function. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the pulse bias voltage limit, in volts, on the specified\nchannel(s). The limit is specified as a positive value, but symmetric\npositive and negative limits are enforced simultaneously.\n**Valid Values:**\nThe valid values for this parameter are defined by the pulse voltage\nlimit range that is configured using the\nniDCPower_ConfigurePulseVoltagelimitRange function.\n' + }, + 'name': 'limit', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, - 'ConfigurePulseVoltageLimitRange': { - 'returns': 'ViStatus', + 'ConfigurePulseCurrentLevel': { + 'codegen_method': 'no', + 'documentation': { + 'description': "\nConfigures the pulse current level that the device attempts to generate\nfor the specified channel(s) during the on phase of a pulse. The channel\nmust be enabled for the specified current level to take effect.\n\nRefer to the niDCPower_ConfigureOutputEnabled function for more\ninformation about enabling the output channel. The pulse current level\nsetting is applicable only if the channel is set to the\nNIDCPOWER_VAL_PULSE_CURRENT output function using the\nniDCPower_ConfigureOutputEnabled function.\n\nThe device actively regulates the current at the specified level unless\ndoing so causes a voltage drop greater than the\nNIDCPOWER_ATTR_PULSE_VOLTAGE_lIMIT across the channels' output\nterminals.\n", + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Range', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the pulse voltage limit range, in volts, on the specified -channel(s). -For valid ranges, refer to the *ranges* topic for your device in the *NI -DC Power Supplies and SMUs Help*. -''', -}, - }, - ], -'documentation': { -'description': ''' -Configures the pulse voltage limit range for the specified channel(s). - -The configured range defines the valid values to which you can set the -pulse voltage limit and pulse bias voltage limit using the -niDCPower_ConfigurePulseVoltageLimit and -niDCPower_ConfigurePulseBiasVoltageLimit functions. The pulse voltage -limit range setting is applicable only if the channel is set to the -NIDCPOWER_VAL_PULSE_CURRENT output function using the -niDCPower_ConfigureOutputFunction function. - -. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the pulse current level, in amps, on the specified channel(s).\n**Valid Values:**\nThe valid values for this parameter are defined by the pulse current\nlevel range that is configured using the\nniDCPower_ConfigurePulseCurrentlevelRange function.\n' + }, + 'name': 'level', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, - 'ConfigureSense': { - 'returns': 'ViStatus', + 'ConfigurePulseCurrentLevelRange': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nConfigures the pulse current level range for the specified channel(s).\n\nThe configured range defines the valid values to which you can set the\npulse current level and pulse bias current level using the\nniDCPower_ConfigurePulseCurrentLevel and\nniDCPower_ConfigurePulseBiasCurrentLevel functions. The pulse current\nlevel range setting is applicable only if the channel is set to the\nNIDCPOWER_VAL_PULSE_CURRENT output function using the\nniDCPower_ConfigureOutputFunction function.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Sense', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies local or remote sensing on the specified channel(s). -**Defined Values:** -''', -'table_body': [['NIDCPOWER_VAL_LOCAL (1008)', 'Local sensing'], ['NIDCPOWER_VAL_REMOTE (1009)', 'Remote sensing']], -}, - }, - ], -'documentation': { -'description': ''' -Specifies whether to use -`local `__ or -`remote `__ -sensing of the output voltage on the specified channel(s). Refer to the -*Devices* topic specific to your device in the *NI DC Power Supplies and -SMUs* Help for more information about sensing voltage on supported -channels. - -**Related Topics:** - -`Local and Remote -Sense `__ -''', -}, - }, - 'ConfigureSoftwareEdgeMeasureTrigger': { - 'returns': 'ViStatus', - 'parameters': [ + 'type': 'ViConstString' + }, { 'direction': 'in', - 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, - }, + 'documentation': { + 'description': '\nSpecifies the pulse current level range, in amps, on the specified\nchannel(s).\nFor valid ranges, refer to the *ranges* topic for your device in the *NI\nDC Power Supplies and SMUs Help*.\n' + }, + 'name': 'range', + 'type': 'ViReal64' + } ], -'documentation': { -'description': ''' -Configures the Measure trigger for software triggering. Use the -niDCPower_SendSoftwareEdgeTrigger function to assert the trigger -condition. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'returns': 'ViStatus' }, - 'ConfigureSoftwareEdgePulseTrigger': { - 'returns': 'ViStatus', + 'ConfigurePulseCurrentLimit': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nConfigures the pulse current limit for the specified channel(s). The\nchannel must be enabled for the specified current limit to take effect.\n\nRefer to the niDCPower_ConfigureOutputEnabled function for more\ninformation about enabling the output channel. The pulse current limit\nis the current that the output must not exceed when generating the\ndesired NIDCPOWER_ATTR_PULSE_vOLTAGE_lEVEL. The pulse current limit\nsetting is only applicable if the channel is set to the\nNIDCPOWER_VAL_PULSE_VOLTAGE output function using the\nniDCPower_ConfigureOutputFunction function.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, - ], -'documentation': { -'description': ''' -Configures the Pulse trigger for software triggering. Use the -niDCPower_SendSoftwareEdgeTrigger function to assert the trigger -condition. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, - }, - 'ConfigureSoftwareEdgeSequenceAdvanceTrigger': { - 'returns': 'ViStatus', - 'parameters': [ { 'direction': 'in', - 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, + 'name': 'channelName', + 'type': 'ViConstString' }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the pulse current limit, in amps, on the specified channel(s).\nThe limit is specified as a positive value, but symmetric positive and\nnegative limits are enforced simultaneously.\n**Valid Values:**\nThe valid values for this parameter are defined by the pulse current\nlimit range that is configured using the\nniDCPower_ConfigurePulseCurrentlimitRange function.\n' + }, + 'name': 'limit', + 'type': 'ViReal64' + } ], -'documentation': { -'description': ''' -Configures the Sequence Advance trigger for software triggering. Use the -niDCPower_SendSoftwareEdgeTrigger function to assert the trigger -condition. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'returns': 'ViStatus' }, - 'ConfigureSoftwareEdgeSourceTrigger': { - 'returns': 'ViStatus', + 'ConfigurePulseCurrentLimitRange': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nConfigures the pulse current limit range for the specified channel(s).\n\nThe configured range defines the valid values to which you can set the\npulse current limit and pulse bias current limit using the\nniDCPower_ConfigurePulseCurrentLimit and\nniDCPower_ConfigurePulseBiasCurrentLimit functions. The pulse current\nlimit range setting is applicable only if the channel is set to the\nNIDCPOWER_VAL_PULSE_VOLTAGE output function using the\nniDCPower_ConfigureOutputFunction function.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, - ], -'documentation': { -'description': ''' -Configures the Source trigger for software triggering. Use the -niDCPower_SendSoftwareEdgeTrigger function to assert the trigger -condition. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, - }, - 'ConfigureSoftwareEdgeStartTrigger': { - 'returns': 'ViStatus', - 'parameters': [ { 'direction': 'in', - 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, + 'name': 'channelName', + 'type': 'ViConstString' }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the pulse current limit range, in amps, on the specified\nchannel(s).\nFor valid ranges, refer to the *ranges* topic for your device in the *NI\nDC Power Supplies and SMUs Help*.\n' + }, + 'name': 'range', + 'type': 'ViReal64' + } ], -'documentation': { -'description': ''' -Configures the Start trigger for software triggering. Use the -niDCPower_SendSoftwareEdgeTrigger function to assert the trigger -condition. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'returns': 'ViStatus' }, - 'ConfigureSourceMode': { - 'returns': 'ViStatus', + 'ConfigurePulseVoltageLevel': { + 'codegen_method': 'no', + 'documentation': { + 'description': "\nConfigures the pulse voltage level that the device attempts to generate\nfor the specified channel(s) during the on phase of a pulse. The channel\nmust be enabled for the specified voltage level to take effect.\n\nRefer to the niDCPower_ConfigureOutputEnabled function for more\ninformation about enabling the output channel. The pulse voltage level\nsetting is applicable only if the channel is set to the\nNIDCPOWER_VAL_PULSE_VOLTAGE output function using the\nniDCPower_ConfigureOutputFunction function.\n\nThe device actively regulates the voltage at the specified level unless\ndoing so causes a current greater than the\nNIDCPOWER_ATTR_PULSE_cURRENT_lIMIT through the channels' output\nterminals.\n", + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'sourceMode', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the source mode for the NI-DCPower session. -**Defined Values**: -''', -'table_body': [['NIDCPOWER_VAL_SINGLE_POINT (1020)', 'Applies a single source configuration.'], ['NIDCPOWER_VAL_SEQUENCE (1021)', 'Applies a list of voltage or current configurations sequentially.']], -}, - }, - ], -'documentation': { -'description': ''' -Configures the NIDCPOWER_ATTR_SOURCE_MODE attribute. Specifies -whether to run a single output point or a sequence. Refer to the `Single -Point Source Mode `__ and -`Sequence Source Mode `__ -topics in the *NI DC Power Supplies and SMUs Help* for more information -about using this function. -''', -}, + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the pulse voltage level, in volts, for the output channel\ngeneration.\n**Valid Values**:\nThe valid values for this parameter are defined by the voltage level\nrange that is selected using the\nniDCPower_ConfigurePulseVoltagelevelRange function.\n' + }, + 'name': 'level', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, - 'ConfigureVoltageLevel': { - 'returns': 'ViStatus', + 'ConfigurePulseVoltageLevelRange': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nConfigures the pulse voltage level range for the specified channel(s).\n\nThe configured range defines the valid values to which you can set the\npulse voltage level and pulse bias voltage level using the\nniDCPower_ConfigurePulseVoltageLevel and\nniDCPower_ConfigurePulseBiasVoltageLevel functions. The pulse voltage\nlevel range setting is applicable only if the channel is set to the\nNIDCPOWER_VAL_PULSE_VOLTAGE output function using the\nniDCPower_ConfigureOutputFunction function.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Level', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the voltage level, in volts, for the output channel -generation. -**Valid Values**: -The valid values for this parameter are defined by the voltage level -range that is selected using the niDCPower_ConfigureVoltagelevelRange -function. -''', -}, - }, - ], -'documentation': { -'description': ''' -Configures the voltage level the device attempts to generate for the -specified channel(s). The channel must be enabled for the specified -voltage level to take effect. Refer to the -niDCPower_ConfigureOutputEnabled function for more information about -enabling the output channel. - -The voltage level setting is applicable only if the output function of -the channel is set to NIDCPOWER_VAL_DC_VOLTAGE. Use -nidcpower_ConfigureOutputFunction to set the output function. - -The device actively regulates the voltage at the specified level unless -doing so causes a current output greater than the -NIDCPOWER_ATTR_CURRENT_LIMIT across the channels' output terminals. - -**Related Topics:** - -`Constant Voltage -Mode `__ -''', -}, + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the pulse voltage level range, in volts, on the specified\nchannel(s).\nFor valid ranges, refer to the *ranges* topic for your device in the *NI\nDC Power Supplies and SMUs Help*.\n' + }, + 'name': 'range', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, - 'ConfigureVoltageLevelRange': { - 'returns': 'ViStatus', + 'ConfigurePulseVoltageLimit': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nConfigures the pulse voltage limit for the specified channel(s). The\nchannel must be enabled for the specified voltage limit to take effect.\n\nRefer to the niDCPower_ConfigureOutputEnabled function for more\ninformation about enabling the output channel. The pulse voltage limit\nis the voltage that the output must not exceed when generating the\ndesired NIDCPOWER_ATTR_PULSE_cURRENT_lEVEL. The pulse voltage limit\nsetting is only applicable if the channel is set to the\nNIDCPOWER_VAL_PULSE_CURRENT output function using the\nniDCPower_ConfigureOutputFunction function.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Range', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the voltage level range, in volts, on the specified -channel(s). -For valid ranges, refer to the *ranges* topic for your device in the *NI -DC Power Supplies and SMUs Help*. -''', -}, - }, - ], -'documentation': { -'description': ''' -Configures the voltage level range for the specified channel(s). The -configured range defines the valid values the voltage level can be set -to using the niDCPower_ConfigureVoltageLevel function. The voltage -level range setting is applicable only if the output function of the -channel is set to NIDCPOWER_VAL_DC_VOLTAGE. Use -nidcpower_ConfigureOutputFunction to set the output function. - -Use the NIDCPOWER_ATTR_VOLTAGE_LEVEL_AUTORANGE attribute to enable -automatic selection of the voltage level range. - -**Related Topics:** - -`Ranges `__ -''', -}, + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the pulse voltage limit, in volts, on the specified output\nchannel(s). The limit is specified as a positive value, but symmetric\npositive and negative limits are enforced simultaneously.\n**Valid Values:**\nThe valid values for this parameter are defined by the pulse voltage\nlimit range that is configured using the\nniDCPower_ConfigurePulseVoltagelimitRange function.\n' + }, + 'name': 'limit', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, - 'ConfigureVoltageLimit': { - 'returns': 'ViStatus', + 'ConfigurePulseVoltageLimitRange': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nConfigures the pulse voltage limit range for the specified channel(s).\n\nThe configured range defines the valid values to which you can set the\npulse voltage limit and pulse bias voltage limit using the\nniDCPower_ConfigurePulseVoltageLimit and\nniDCPower_ConfigurePulseBiasVoltageLimit functions. The pulse voltage\nlimit range setting is applicable only if the channel is set to the\nNIDCPOWER_VAL_PULSE_CURRENT output function using the\nniDCPower_ConfigureOutputFunction function.\n\n.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Limit', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the voltage limit, in volts, on the specified output -channel(s). The limit is specified as a positive value, but symmetric -positive and negative limits are enforced simultaneously. -**Valid Values:** -The valid values for this parameter are defined by the voltage limit -range that is configured using the niDCPower_ConfigureVoltagelimitRange -function. -''', -}, - }, - ], -'documentation': { -'description': ''' -Configures the voltage limit for the specified channel(s). The channel -must be enabled for the specified voltage limit to take effect. Refer to -the niDCPower_ConfigureOutputEnabled function for more information -about enabling the output channel. - -The voltage limit is the voltage that the output should not exceed when -generating the desired niDCPower_ConfigureCurrentLevel. The voltage -limit setting is applicable only if the output function of the channel -is set to NIDCPOWER_VAL_DC_CURRENT. Use -nidcpower_ConfigureOutputFunction to set the output function. - -**Related Topics:** - -`Compliance `__ -''', -}, + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the pulse voltage limit range, in volts, on the specified\nchannel(s).\nFor valid ranges, refer to the *ranges* topic for your device in the *NI\nDC Power Supplies and SMUs Help*.\n' + }, + 'name': 'range', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, - 'ConfigureVoltageLimitRange': { - 'returns': 'ViStatus', + 'ConfigureSense': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nSpecifies whether to use\n`local `__ or\n`remote `__\nsensing of the output voltage on the specified channel(s). Refer to the\n*Devices* topic specific to your device in the *NI DC Power Supplies and\nSMUs* Help for more information about sensing voltage on supported\nchannels.\n\n**Related Topics:**\n\n`Local and Remote\nSense `__\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Range', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the voltage limit range, in volts, on the specified -channel(s). -For valid ranges, refer to the *ranges* topic for your device in the *NI -DC Power Supplies and SMUs Help*. -''', -}, - }, - ], -'documentation': { -'description': ''' -Configures the voltage limit range for the specified channel(s). The -configured range defines the valid values the voltage limit can be set -to using the niDCPower_ConfigureVoltageLimit function. The voltage -limit range setting is applicable only if the output function of the -channel is set to NIDCPOWER_VAL_DC_CURRENT. Use -nidcpower_ConfigureOutputFunction to set the output function. - -Use the NIDCPOWER_ATTR_VOLTAGE_LIMIT_AUTORANGE attribute to enable -automatic selection of the voltage limit range. - -**Related Topics:** - -`Ranges `__ -''', -}, + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies local or remote sensing on the specified channel(s).\n**Defined Values:**\n', + 'table_body': [ + [ + 'NIDCPOWER_VAL_LOCAL (1008)', + 'Local sensing' + ], + [ + 'NIDCPOWER_VAL_REMOTE (1009)', + 'Remote sensing' + ] + ] + }, + 'name': 'sense', + 'type': 'ViInt32' + } + ], + 'returns': 'ViStatus' }, - 'ConnectInternalReference': { - 'returns': 'ViStatus', + 'ConfigureSoftwareEdgeMeasureTrigger': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nConfigures the Measure trigger for software triggering. Use the\nniDCPower_SendSoftwareEdgeTrigger function to assert the trigger\ncondition.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, - }, - { - 'direction': 'in', - 'name': 'internalReference', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the internal reference to be connected to the calibration pin. -**Defined Values**: -''', -'table_body': [['NIDCPOWER_VAL_INTERNAL_REFERENCE_5V (1054)', 'Calibration pin connected to 5 V internal reference.'], ['NIDCPOWER_VAL_INTERNAL_REFERENCE_100KOHM (1055)', 'Calibration pin connected to 100 kΩ internal reference.'], ['NIDCPOWER_VAL_INTERNAL_REFERENCE_GROUND (1056)', 'Calibration pin connected to ground reference.'], ['NIDCPOWER_VAL_INTERNAL_REFERENCE_NONE (1057)', 'Calibration pin disconnected from internal reference.']], -}, - }, - ], -'documentation': { -'description': ''' -Routes the internal reference to the calibration pin in preparation for -adjustment. Refer to the calibration procedure for the device you are -calibrating for detailed instructions on the appropriate use of this -function. This function can only be called from an external calibration -session. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'type': 'ViSession' + } + ], + 'returns': 'ViStatus' }, - 'CreateAdvancedSequence': { - 'returns': 'ViStatus', + 'ConfigureSoftwareEdgeMeasureTriggerWithChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'sequenceName', - 'type': 'ViConstString', -'documentation': { -'description': 'Specifies the name of the sequence to create.', -}, - }, + 'name': 'channelName', + 'type': 'ViConstString' + } + ], + 'returns': 'ViStatus' + }, + 'ConfigureSoftwareEdgePulseTrigger': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nConfigures the Pulse trigger for software triggering. Use the\nniDCPower_SendSoftwareEdgeTrigger function to assert the trigger\ncondition.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, + 'parameters': [ { 'direction': 'in', - 'name': 'attributeIdCount', - 'type': 'ViInt32', -'documentation': { -'description': 'Specifies the number of attributes in the attributeIDs array.', -}, - }, + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + } + ], + 'returns': 'ViStatus' + }, + 'ConfigureSoftwareEdgePulseTriggerWithChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ { 'direction': 'in', - 'name': 'attributeIds', - 'type': 'ViInt32[]', -'documentation': { -'description': ''' -Specifies the attributes you reconfigure per step in the advanced -sequence. The following table lists which attributes can be configured -in an advanced sequence for each NI-DCPower device that supports -advanced sequencing. A ✓ indicates that the attribute can be configured -in advanced sequencing. An ✕ indicates that the attribute cannot be -configured in advanced sequencing. -''', -'table_body': [['NIDCPOWER_ATTR_DC_NOISE_REJECTION', '✓', '✕', '✓', '✕', '✓', '✕', '✕', '✓'], ['NIDCPOWER_ATTR_APERTURE_TIME', '✓', '✓', '✓', '✓', '✓', '✓', '✓', '✓'], ['NIDCPOWER_ATTR_MEASURE_RECORD_LENGTH', '✓', '✓', '✓', '✓', '✓', '✓', '✓', '✓'], ['NIDCPOWER_ATTR_SENSE', '✓', '✓', '✓', '✓', '✓', '✓', '✓', '✓'], ['NIDCPOWER_ATTR_OVP_ENABLED', '✓', '✓', '✓', '✕', '✕', '✕', '✕', '✕'], ['NIDCPOWER_ATTR_OVP_LIMIT', '✓', '✓', '✓', '✕', '✕', '✕', '✕', '✕'], ['NIDCPOWER_ATTR_PULSE_BIAS_DELAY', '✓', '✓', '✓', '✓', '✓', '✕', '✕', '✕'], ['NIDCPOWER_ATTR_PULSE_OFF_TIME', '✓', '✓', '✓', '✓', '✓', '✕', '✕', '✕'], ['NIDCPOWER_ATTR_PULSE_ON_TIME', '✓', '✓', '✓', '✓', '✓', '✕', '✕', '✕'], ['NIDCPOWER_ATTR_SOURCE_DELAY', '✓', '✓', '✓', '✓', '✓', '✓', '✓', '✓'], ['NIDCPOWER_ATTR_CURRENT_COMPENSATION_FREQUENCY', '✓', '✕', '✓', '✕', '✓', '✕', '✓', '✓'], ['NIDCPOWER_ATTR_CURRENT_GAIN_BANDWIDTH', '✓', '✕', '✓', '✕', '✓', '✕', '✓', '✓'], ['NIDCPOWER_ATTR_CURRENT_POLE_ZERO_RATIO', '✓', '✕', '✓', '✕', '✓', '✕', '✓', '✓'], ['NIDCPOWER_ATTR_VOLTAGE_COMPENSATION_FREQUENCY', '✓', '✕', '✓', '✕', '✓', '✕', '✓', '✓'], ['NIDCPOWER_ATTR_VOLTAGE_GAIN_BANDWIDTH', '✓', '✕', '✓', '✕', '✓', '✕', '✓', '✓'], ['NIDCPOWER_ATTR_VOLTAGE_POLE_ZERO_RATIO', '✓', '✕', '✓', '✕', '✓', '✕', '✓', '✓'], ['NIDCPOWER_ATTR_CURRENT_LEVEL', '✓', '✓', '✓', '✓', '✓', '✓', '✓', '✓'], ['NIDCPOWER_ATTR_CURRENT_LEVEL_RANGE', '✓', '✓', '✓', '✓', '✓', '✓', '✓', '✓'], ['NIDCPOWER_ATTR_VOLTAGE_LIMIT', '✓', '✓', '✓', '✓', '✓', '✓', '✓', '✓'], ['NIDCPOWER_ATTR_VOLTAGE_LIMIT_HIGH', '✓', '✓', '✓', '✓', '✓', '✓', '✓', '✕'], ['NIDCPOWER_ATTR_VOLTAGE_LIMIT_LOW', '✓', '✓', '✓', '✓', '✓', '✓', '✓', '✕'], ['NIDCPOWER_ATTR_VOLTAGE_LIMIT_RANGE', '✓', '✓', '✓', '✓', '✓', '✓', '✓', '✓'], ['NIDCPOWER_ATTR_CURRENT_LIMIT', '✓', '✓', '✓', '✓', '✓', '✓', '✓', '✓'], ['NIDCPOWER_ATTR_CURRENT_LIMIT_HIGH', '✓', '✓', '✓', '✓', '✓', '✓', '✓', '✕'], ['NIDCPOWER_ATTR_CURRENT_LIMIT_LOW', '✓', '✓', '✓', '✓', '✓', '✓', '✓', '✕'], ['NIDCPOWER_ATTR_CURRENT_LIMIT_RANGE', '✓', '✓', '✓', '✓', '✓', '✓', '✓', '✓'], ['NIDCPOWER_ATTR_VOLTAGE_LEVEL', '✓', '✓', '✓', '✓', '✓', '✓', '✓', '✓'], ['NIDCPOWER_ATTR_VOLTAGE_LEVEL_RANGE', '✓', '✓', '✓', '✓', '✓', '✓', '✓', '✓'], ['NIDCPOWER_ATTR_OUTPUT_ENABLED', '✓', '✓', '✓', '✓', '✓', '✓', '✓', '✓'], ['NIDCPOWER_ATTR_OUTPUT_FUNCTION', '✓', '✓', '✓', '✓', '✓', '✓', '✓', '✓'], ['NIDCPOWER_ATTR_OUTPUT_RESISTANCE', '✓', '✕', '✓', '✕', '✓', '✕', '✓', '✕'], ['NIDCPOWER_ATTR_PULSE_BIAS_CURRENT_LEVEL', '✓', '✓', '✓', '✓', '✓', '✕', '✕', '✕'], ['NIDCPOWER_ATTR_PULSE_BIAS_VOLTAGE_LIMIT', '✓', '✓', '✓', '✓', '✓', '✕', '✕', '✕'], ['NIDCPOWER_ATTR_PULSE_BIAS_VOLTAGE_LIMIT_HIGH', '✓', '✓', '✓', '✓', '✓', '✕', '✕', '✕'], ['NIDCPOWER_ATTR_PULSE_BIAS_VOLTAGE_LIMIT_LOW', '✓', '✓', '✓', '✓', '✓', '✕', '✕', '✕'], ['NIDCPOWER_ATTR_PULSE_CURRENT_LEVEL', '✓', '✓', '✓', '✓', '✓', '✕', '✕', '✕'], ['NIDCPOWER_ATTR_PULSE_CURRENT_LEVEL_RANGE', '✓', '✓', '✓', '✓', '✓', '✕', '✕', '✕'], ['NIDCPOWER_ATTR_PULSE_VOLTAGE_LIMIT', '✓', '✓', '✓', '✓', '✓', '✕', '✕', '✕'], ['NIDCPOWER_ATTR_PULSE_VOLTAGE_LIMIT_HIGH', '✓', '✓', '✓', '✓', '✓', '✕', '✕', '✕'], ['NIDCPOWER_ATTR_PULSE_VOLTAGE_LIMIT_LOW', '✓', '✓', '✓', '✓', '✓', '✕', '✕', '✕'], ['NIDCPOWER_ATTR_PULSE_VOLTAGE_LIMIT_RANGE', '✓', '✓', '✓', '✓', '✓', '✕', '✕', '✕'], ['NIDCPOWER_ATTR_PULSE_BIAS_CURRENT_LIMIT', '✓', '✓', '✓', '✓', '✓', '✕', '✕', '✕'], ['NIDCPOWER_ATTR_PULSE_BIAS_CURRENT_LIMIT_HIGH', '✓', '✓', '✓', '✓', '✓', '✕', '✕', '✕'], ['NIDCPOWER_ATTR_PULSE_BIAS_CURRENT_LIMIT_LOW', '✓', '✓', '✓', '✓', '✓', '✕', '✕', '✕'], ['NIDCPOWER_ATTR_PULSE_BIAS_VOLTAGE_LEVEL', '✓', '✓', '✓', '✓', '✓', '✕', '✕', '✕'], ['NIDCPOWER_ATTR_PULSE_CURRENT_LIMIT', '✓', '✓', '✓', '✓', '✓', '✕', '✕', '✕'], ['NIDCPOWER_ATTR_PULSE_CURRENT_LIMIT_HIGH', '✓', '✓', '✓', '✓', '✓', '✕', '✕', '✕'], ['NIDCPOWER_ATTR_PULSE_CURRENT_LIMIT_LOW', '✓', '✓', '✓', '✓', '✓', '✕', '✕', '✕'], ['NIDCPOWER_ATTR_PULSE_CURRENT_LIMIT_RANGE', '✓', '✓', '✓', '✓', '✓', '✕', '✕', '✕'], ['NIDCPOWER_ATTR_PULSE_VOLTAGE_LEVEL', '✓', '✓', '✓', '✓', '✓', '✕', '✕', '✕'], ['NIDCPOWER_ATTR_PULSE_VOLTAGE_LEVEL_RANGE', '✓', '✓', '✓', '✓', '✓', '✕', '✕', '✕'], ['NIDCPOWER_ATTR_TRANSIENT_RESPONSE', '✓', '✓', '✓', '✓', '✓', '✓', '✓', '✓']], -'table_header': ['Attribute', 'PXIe-4135', 'PXIe-4136', 'PXIe-4137', 'PXIe-4138', 'PXIe-4139', 'PXIe-4140/4142/4144', 'PXIe-4141/4143/4145', 'PXIe-4162/4163'], -}, + 'name': 'vi', + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'setAsActiveSequence', - 'type': 'ViBoolean', -'documentation': { -'description': 'Specifies that this current sequence is active.', -}, - }, - ], -'documentation': { -'description': ''' -Creates an empty advanced sequence. Call the -niDCPower_CreateAdvancedSequenceStep function to add steps to the -active advanced sequence. - -You can create multiple advanced sequences in a session. - -**Support for this function** - -You must set the source mode to Sequence to use this function. - -Using the niDCPower_SetSequence function with Advanced Sequence -functions is unsupported. - -Use this function in the Uncommitted or Committed programming states. -Refer to the `Programming -States `__ topic in -the *NI DC Power Supplies and SMUs Help* for more information about -NI-DCPower programming states. - -**Related Topics**: - -`Advanced Sequence -Mode `__ - -`Programming -States `__ - -niDCPower_CreateAdvancedSequenceStep -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'name': 'channelName', + 'type': 'ViConstString' + } + ], + 'returns': 'ViStatus' }, - 'CreateAdvancedSequenceStep': { - 'returns': 'ViStatus', + 'ConfigureSoftwareEdgeSequenceAdvanceTrigger': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nConfigures the Sequence Advance trigger for software triggering. Use the\nniDCPower_SendSoftwareEdgeTrigger function to assert the trigger\ncondition.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, - }, - { - 'direction': 'in', - 'name': 'setAsActiveStep', - 'type': 'ViBoolean', -'documentation': { -'description': 'Specifies that this current step in the active sequence is active.', -}, - }, - ], -'documentation': { -'description': ''' -Creates a new advanced sequence step in the advanced sequence specified -by the Active advanced sequence. When you create an advanced sequence -step, each attribute you passed to the niDCPower_CreateAdvancedSequence -function is reset to its default value for that step unless otherwise -specified. - -**Support for this Function** - -You must set the source mode to Sequence to use this function. - -Using the niDCPower_SetSequence function with Advanced Sequence -functions is unsupported. - -**Related Topics**: - -`Advanced Sequence -Mode `__ - -`Programming -States `__ - -niDCPower_CreateAdvancedSequence -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'type': 'ViSession' + } + ], + 'returns': 'ViStatus' }, - 'DeleteAdvancedSequence': { - 'returns': 'ViStatus', + 'ConfigureSoftwareEdgeSequenceAdvanceTriggerWithChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'sequenceName', - 'type': 'ViConstString', -'documentation': { -'description': 'specifies the name of the sequence to delete.', -}, - }, - ], -'documentation': { -'description': ''' -Deletes a previously created advanced sequence and all the advanced -sequence steps in the advanced sequence. - -**Support for this Function** - -You must set the source mode to Sequence to use this function. - -Using the niDCPower_SetSequence function with Advanced Sequence -functions is unsupported. - -**Related Topics**: - -`Advanced Sequence -Mode `__ - -`Programming -States `__ -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'name': 'channelName', + 'type': 'ViConstString' + } + ], + 'returns': 'ViStatus' }, - 'Disable': { - 'returns': 'ViStatus', + 'ConfigureSoftwareEdgeSourceTrigger': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nConfigures the Source trigger for software triggering. Use the\nniDCPower_SendSoftwareEdgeTrigger function to assert the trigger\ncondition.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, - }, + 'type': 'ViSession' + } ], -'documentation': { -'description': ''' -This function performs the same actions as the niDCPower_reset -function, except that this function also immediately sets the -NIDCPOWER_ATTR_OUTPUT_ENABLED attribute to VI_FALSE. - -This function opens the output relay on devices that have an output -relay. -''', -}, + 'returns': 'ViStatus' }, - 'DisablePulseTrigger': { - 'returns': 'ViStatus', + 'ConfigureSoftwareEdgeSourceTriggerWithChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, - }, - ], -'documentation': { -'description': ''' -Disables the Pulse trigger. The device does not wait for a pulse trigger -before performing a pulse operation. Refer to `Pulse -Mode `__ and `Sequence Source -Mode `__ for more information -about the Pulse trigger. - -This function is necessary only if you configured a Pulse trigger in the -past and now want to disable it. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' + } + ], + 'returns': 'ViStatus' }, - 'DisableSequenceAdvanceTrigger': { - 'returns': 'ViStatus', + 'ConfigureSoftwareEdgeStartTrigger': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nConfigures the Start trigger for software triggering. Use the\nniDCPower_SendSoftwareEdgeTrigger function to assert the trigger\ncondition.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, - }, + 'type': 'ViSession' + } ], -'documentation': { -'description': ''' -Disables the Sequence Advance trigger. The device does not wait for a -Sequence Advance trigger before advancing to the next iteration of the -sequence. Refer to the `Sequence Source -Mode `__ topic for more -information about the Sequence Advance trigger. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'returns': 'ViStatus' }, - 'DisableSourceTrigger': { - 'returns': 'ViStatus', + 'ConfigureSoftwareEdgeStartTriggerWithChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' + } ], -'documentation': { -'description': ''' -Disables the Source trigger. The device does not wait for a source -trigger before performing a source operation. Refer to the `Single Point -Source Mode `__ and `Sequence -Source Mode `__ topics for -more information about the Source trigger. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'returns': 'ViStatus' }, - 'DisableStartTrigger': { - 'returns': 'ViStatus', + 'ConfigureSourceMode': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nConfigures the NIDCPOWER_ATTR_SOURCE_MODE attribute. Specifies\nwhether to run a single output point or a sequence. Refer to the `Single\nPoint Source Mode `__ and\n`Sequence Source Mode `__\ntopics in the *NI DC Power Supplies and SMUs Help* for more information\nabout using this function.\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, - }, + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the source mode for the NI-DCPower session.\n**Defined Values**:\n', + 'table_body': [ + [ + 'NIDCPOWER_VAL_SINGLE_POINT (1020)', + 'Applies a single source configuration.' + ], + [ + 'NIDCPOWER_VAL_SEQUENCE (1021)', + 'Applies a list of voltage or current configurations sequentially.' + ] + ] + }, + 'name': 'sourceMode', + 'type': 'ViInt32' + } ], -'documentation': { -'description': ''' -Disables the Start trigger. The device does not wait for a Start trigger -when starting generation or acquisition. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'returns': 'ViStatus' }, - 'ExportAttributeConfigurationBuffer': { - 'returns': 'ViStatus', + 'ConfigureSourceModeWithChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'Size', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the size, in bytes, of the byte array to export. If you enter -0, this function returns the needed size. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Configuration', - 'type': 'ViAddr', -'documentation': { -'description': ''' -Specifies the byte array buffer to be populated with the exported -attribute configuration. -''', -}, - }, - ], -'documentation': { -'description': ''' -Exports the attribute configuration of the session to the specified -configuration buffer. - -You can export and import session attribute configurations only between -devices with identical model numbers and the same number of configured -channels. - -This function verifies that the attributes you have configured for the -session are valid. If the configuration is invalid, NI‑DCPower returns -an error. - -**Support for this Function** - -Calling this function in `Sequence Source -Mode `__ is unsupported. - -**Channel Mapping Behavior for Multichannel Sessions** - -When importing and exporting session attribute configurations between -NI‑DCPower sessions that were initialized with different channels, the -configurations of the exporting channels are mapped to the importing -channels in the order you specify in the **channelName** input to the -niDCPower_InitializeWithChannels function. - -For example, if your entry for **channelName** is 0,1 for the exporting -session and 1,2 for the importing session: - -- The configuration exported from channel 0 is imported into channel 1. -- The configuration exported from channel 1 is imported into channel 2. - -**Related Topics:** - -`Using Properties and -Attributes `__ - -`Setting Properties and Attributes Before Reading -Them `__ -''', -'note': ''' -This function will return an error if the total number of channels -initialized for the exporting session is not equal to the total number -of channels initialized for the importing session. -''', -}, + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'name': 'sourceMode', + 'type': 'ViInt32' + } + ], + 'returns': 'ViStatus' }, - 'ExportAttributeConfigurationFile': { - 'returns': 'ViStatus', + 'ConfigureVoltageLevel': { + 'codegen_method': 'no', + 'documentation': { + 'description': "\nConfigures the voltage level the device attempts to generate for the\nspecified channel(s). The channel must be enabled for the specified\nvoltage level to take effect. Refer to the\nniDCPower_ConfigureOutputEnabled function for more information about\nenabling the output channel.\n\nThe voltage level setting is applicable only if the output function of\nthe channel is set to NIDCPOWER_VAL_DC_VOLTAGE. Use\nnidcpower_ConfigureOutputFunction to set the output function.\n\nThe device actively regulates the voltage at the specified level unless\ndoing so causes a current output greater than the\nNIDCPOWER_ATTR_CURRENT_LIMIT across the channels' output terminals.\n\n**Related Topics:**\n\n`Constant Voltage\nMode `__\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'filePath', - 'type': 'ViConstString', -'documentation': { -'description': ''' -Specifies the absolute path to the file to contain the exported -attribute configuration. If you specify an empty or relative path, this -function returns an error. -**Default file extension:** .nidcpowerconfig -''', -}, - }, - ], -'documentation': { -'description': ''' -Exports the attribute configuration of the session to the specified -file. - -You can export and import session attribute configurations only between -devices with identical model numbers and the same number of configured -channels. - -This function verifies that the attributes you have configured for the -session are valid. If the configuration is invalid, NI‑DCPower returns -an error. - -**Support for this Function** - -Calling this function in `Sequence Source -Mode `__ is unsupported. - -**Channel Mapping Behavior for Multichannel Sessions** - -When importing and exporting session attribute configurations between -NI‑DCPower sessions that were initialized with different channels, the -configurations of the exporting channels are mapped to the importing -channels in the order you specify in the **channelName** input to the -niDCPower_InitializeWithChannels function. - -For example, if your entry for **channelName** is 0,1 for the exporting -session and 1,2 for the importing session: - -- The configuration exported from channel 0 is imported into channel 1. -- The configuration exported from channel 1 is imported into channel 2. - -**Related Topics:** - -`Using Properties and -Attributes `__ - -`Setting Properties and Attributes Before Reading -Them `__ -''', -'note': ''' -This function will return an error if the total number of channels -initialized for the exporting session is not equal to the total number -of channels initialized for the importing session. -''', -}, + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the voltage level, in volts, for the output channel\ngeneration.\n**Valid Values**:\nThe valid values for this parameter are defined by the voltage level\nrange that is selected using the niDCPower_ConfigureVoltagelevelRange\nfunction.\n' + }, + 'name': 'level', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, - 'ExportSignal': { - 'returns': 'ViStatus', + 'ConfigureVoltageLevelRange': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nConfigures the voltage level range for the specified channel(s). The\nconfigured range defines the valid values the voltage level can be set\nto using the niDCPower_ConfigureVoltageLevel function. The voltage\nlevel range setting is applicable only if the output function of the\nchannel is set to NIDCPOWER_VAL_DC_VOLTAGE. Use\nnidcpower_ConfigureOutputFunction to set the output function.\n\nUse the NIDCPOWER_ATTR_VOLTAGE_LEVEL_AUTORANGE attribute to enable\nautomatic selection of the voltage level range.\n\n**Related Topics:**\n\n`Ranges `__\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'Signal', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies which trigger or event to export. -**Defined Values:** -''', -'table_body': [['NIDCPOWER_VAL_SOURCE_COMPLETE_EVENT (1030)', 'Exports the Source Complete event.'], ['NIDCPOWER_VAL_MEASURE_COMPLETE_EVENT (1031)', 'Exports the Measure Complete event.'], ['NIDCPOWER_VAL_SEQUENCE_ITERATION_COMPLETE_EVENT (1032)', 'Exports the Sequence Iteration Complete event.'], ['NIDCPOWER_VAL_SEQUENCE_ENGINE_DONE_EVENT (1033)', 'Exports the Sequence Engine Done event.'], ['NIDCPOWER_VAL_PULSE_COMPLETE_EVENT (1051)', 'Exports the Pulse Complete event.'], ['NIDCPOWER_VAL_READY_FOR_PULSE_TRIGGER_EVENT (1052)', 'Exports the Ready Pulse Trigger event.'], ['NIDCPOWER_VAL_START_TRIGGER (1034)', 'Exports the Start trigger.'], ['NIDCPOWER_VAL_SOURCE_TRIGGER (1035)', 'Exports the Source trigger.'], ['NIDCPOWER_VAL_MEASURE_TRIGGER (1036)', 'Exports the Measure trigger.'], ['NIDCPOWER_VAL_SEQUENCE_ADVANCE_TRIGGER (1037)', 'Exports the Sequence Advance trigger.'], ['NIDCPOWER_VAL_PULSE_TRIGGER (1053)', 'Exports the Pulse trigger.']], -}, + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, + 'name': 'channelName', + 'type': 'ViConstString' }, { 'direction': 'in', - 'name': 'signalIdentifier', - 'type': 'ViChar[]', -'documentation': { -'description': 'Reserved for future use. Pass in an empty string for this parameter.', -}, + 'documentation': { + 'description': '\nSpecifies the voltage level range, in volts, on the specified\nchannel(s).\nFor valid ranges, refer to the *ranges* topic for your device in the *NI\nDC Power Supplies and SMUs Help*.\n' + }, + 'name': 'range', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' + }, + 'ConfigureVoltageLimit': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nConfigures the voltage limit for the specified channel(s). The channel\nmust be enabled for the specified voltage limit to take effect. Refer to\nthe niDCPower_ConfigureOutputEnabled function for more information\nabout enabling the output channel.\n\nThe voltage limit is the voltage that the output should not exceed when\ngenerating the desired niDCPower_ConfigureCurrentLevel. The voltage\nlimit setting is applicable only if the output function of the channel\nis set to NIDCPOWER_VAL_DC_CURRENT. Use\nnidcpower_ConfigureOutputFunction to set the output function.\n\n**Related Topics:**\n\n`Compliance `__\n' + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'outputTerminal', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies where to export the selected signal. -**Relative Terminals**: -''', -'table_body': [['""', 'Do not export signal'], ['"PXI_Trig0"', 'PXI trigger line 0'], ['"PXI_Trig1"', 'PXI trigger line 1'], ['"PXI_Trig2"', 'PXI trigger line 2'], ['"PXI_Trig3"', 'PXI trigger line 3'], ['"PXI_Trig4"', 'PXI trigger line 4'], ['"PXI_Trig5"', 'PXI trigger line 5'], ['"PXI_Trig6"', 'PXI trigger line 6'], ['"PXI_Trig7"', 'PXI trigger line 7']], -}, - }, - ], -'documentation': { -'description': ''' -Routes signals (triggers and events) to the output terminal you specify. -The route is created when the session is niDCPower_Commit. - -**Related Topics:** - -`Triggers `__ -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the voltage limit, in volts, on the specified output\nchannel(s). The limit is specified as a positive value, but symmetric\npositive and negative limits are enforced simultaneously.\n**Valid Values:**\nThe valid values for this parameter are defined by the voltage limit\nrange that is configured using the niDCPower_ConfigureVoltagelimitRange\nfunction.\n' + }, + 'name': 'limit', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, - 'FetchMultiple': { - 'returns': 'ViStatus', + 'ConfigureVoltageLimitRange': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nConfigures the voltage limit range for the specified channel(s). The\nconfigured range defines the valid values the voltage limit can be set\nto using the niDCPower_ConfigureVoltageLimit function. The voltage\nlimit range setting is applicable only if the output function of the\nchannel is set to NIDCPOWER_VAL_DC_CURRENT. Use\nnidcpower_ConfigureOutputFunction to set the output function.\n\nUse the NIDCPOWER_ATTR_VOLTAGE_LIMIT_AUTORANGE attribute to enable\nautomatic selection of the voltage limit range.\n\n**Related Topics:**\n\n`Ranges `__\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Timeout', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the maximum time allowed for this function to complete, in -seconds. If the function does not complete within this time interval, -NI-DCPower returns an error. -''', -'note': ''' -When setting the timeout interval, ensure you take into account any -triggers so that the timeout interval is long enough for your -application. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Count', - 'type': 'ViInt32', -'documentation': { -'description': 'Specifies the number of measurements to fetch.', -}, + 'type': 'ViConstString' }, { - 'direction': 'out', - 'name': 'voltageMeasurements', + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the voltage limit range, in volts, on the specified\nchannel(s).\nFor valid ranges, refer to the *ranges* topic for your device in the *NI\nDC Power Supplies and SMUs Help*.\n' + }, + 'name': 'range', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' + }, + 'ConnectInternalReference': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nRoutes the internal reference to the calibration pin in preparation for\nadjustment. Refer to the calibration procedure for the device you are\ncalibrating for detailed instructions on the appropriate use of this\nfunction. This function can only be called from an external calibration\nsession.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the internal reference to be connected to the calibration pin.\n**Defined Values**:\n', + 'table_body': [ + [ + 'NIDCPOWER_VAL_INTERNAL_REFERENCE_5V (1054)', + 'Calibration pin connected to 5 V internal reference.' + ], + [ + 'NIDCPOWER_VAL_INTERNAL_REFERENCE_100KOHM (1055)', + 'Calibration pin connected to 100 kΩ internal reference.' + ], + [ + 'NIDCPOWER_VAL_INTERNAL_REFERENCE_GROUND (1056)', + 'Calibration pin connected to ground reference.' + ], + [ + 'NIDCPOWER_VAL_INTERNAL_REFERENCE_NONE (1057)', + 'Calibration pin disconnected from internal reference.' + ] + ] + }, + 'name': 'internalReference', + 'type': 'ViInt32' + } + ], + 'returns': 'ViStatus' + }, + 'CreateAdvancedSequence': { + 'codegen_method': 'private', + 'documentation': { + 'description': '\nCreates an empty advanced sequence. Call the\nniDCPower_CreateAdvancedSequenceStep function to add steps to the\nactive advanced sequence.\n\nYou can create multiple advanced sequences in a session.\n\n**Support for this function**\n\nYou must set the source mode to Sequence to use this function.\n\nUsing the niDCPower_SetSequence function with Advanced Sequence\nfunctions is unsupported.\n\nUse this function in the Uncommitted or Committed programming states.\nRefer to the `Programming\nStates `__ topic in\nthe *NI DC Power Supplies and SMUs Help* for more information about\nNI-DCPower programming states.\n\n**Related Topics**:\n\n`Advanced Sequence\nMode `__\n\n`Programming\nStates `__\n\nniDCPower_CreateAdvancedSequenceStep\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the name of the sequence to create.' + }, + 'name': 'sequenceName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the number of attributes in the attributeIDs array.' + }, + 'name': 'attributeIdCount', + 'type': 'ViInt32' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the attributes you reconfigure per step in the advanced\nsequence. The following table lists which attributes can be configured\nin an advanced sequence for each NI-DCPower device that supports\nadvanced sequencing. A ✓ indicates that the attribute can be configured\nin advanced sequencing. An ✕ indicates that the attribute cannot be\nconfigured in advanced sequencing.\n', + 'table_body': [ + [ + 'NIDCPOWER_ATTR_DC_NOISE_REJECTION', + '✓', + '✕', + '✓', + '✕', + '✓', + '✕', + '✕', + '✓' + ], + [ + 'NIDCPOWER_ATTR_APERTURE_TIME', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓' + ], + [ + 'NIDCPOWER_ATTR_MEASURE_RECORD_LENGTH', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓' + ], + [ + 'NIDCPOWER_ATTR_SENSE', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓' + ], + [ + 'NIDCPOWER_ATTR_OVP_ENABLED', + '✓', + '✓', + '✓', + '✕', + '✕', + '✕', + '✕', + '✕' + ], + [ + 'NIDCPOWER_ATTR_OVP_LIMIT', + '✓', + '✓', + '✓', + '✕', + '✕', + '✕', + '✕', + '✕' + ], + [ + 'NIDCPOWER_ATTR_PULSE_BIAS_DELAY', + '✓', + '✓', + '✓', + '✓', + '✓', + '✕', + '✕', + '✕' + ], + [ + 'NIDCPOWER_ATTR_PULSE_OFF_TIME', + '✓', + '✓', + '✓', + '✓', + '✓', + '✕', + '✕', + '✕' + ], + [ + 'NIDCPOWER_ATTR_PULSE_ON_TIME', + '✓', + '✓', + '✓', + '✓', + '✓', + '✕', + '✕', + '✕' + ], + [ + 'NIDCPOWER_ATTR_SOURCE_DELAY', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓' + ], + [ + 'NIDCPOWER_ATTR_CURRENT_COMPENSATION_FREQUENCY', + '✓', + '✕', + '✓', + '✕', + '✓', + '✕', + '✓', + '✓' + ], + [ + 'NIDCPOWER_ATTR_CURRENT_GAIN_BANDWIDTH', + '✓', + '✕', + '✓', + '✕', + '✓', + '✕', + '✓', + '✓' + ], + [ + 'NIDCPOWER_ATTR_CURRENT_POLE_ZERO_RATIO', + '✓', + '✕', + '✓', + '✕', + '✓', + '✕', + '✓', + '✓' + ], + [ + 'NIDCPOWER_ATTR_VOLTAGE_COMPENSATION_FREQUENCY', + '✓', + '✕', + '✓', + '✕', + '✓', + '✕', + '✓', + '✓' + ], + [ + 'NIDCPOWER_ATTR_VOLTAGE_GAIN_BANDWIDTH', + '✓', + '✕', + '✓', + '✕', + '✓', + '✕', + '✓', + '✓' + ], + [ + 'NIDCPOWER_ATTR_VOLTAGE_POLE_ZERO_RATIO', + '✓', + '✕', + '✓', + '✕', + '✓', + '✕', + '✓', + '✓' + ], + [ + 'NIDCPOWER_ATTR_CURRENT_LEVEL', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓' + ], + [ + 'NIDCPOWER_ATTR_CURRENT_LEVEL_RANGE', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓' + ], + [ + 'NIDCPOWER_ATTR_VOLTAGE_LIMIT', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓' + ], + [ + 'NIDCPOWER_ATTR_VOLTAGE_LIMIT_HIGH', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✕' + ], + [ + 'NIDCPOWER_ATTR_VOLTAGE_LIMIT_LOW', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✕' + ], + [ + 'NIDCPOWER_ATTR_VOLTAGE_LIMIT_RANGE', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓' + ], + [ + 'NIDCPOWER_ATTR_CURRENT_LIMIT', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓' + ], + [ + 'NIDCPOWER_ATTR_CURRENT_LIMIT_HIGH', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✕' + ], + [ + 'NIDCPOWER_ATTR_CURRENT_LIMIT_LOW', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✕' + ], + [ + 'NIDCPOWER_ATTR_CURRENT_LIMIT_RANGE', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓' + ], + [ + 'NIDCPOWER_ATTR_VOLTAGE_LEVEL', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓' + ], + [ + 'NIDCPOWER_ATTR_VOLTAGE_LEVEL_RANGE', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓' + ], + [ + 'NIDCPOWER_ATTR_OUTPUT_ENABLED', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓' + ], + [ + 'NIDCPOWER_ATTR_OUTPUT_FUNCTION', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓' + ], + [ + 'NIDCPOWER_ATTR_OUTPUT_RESISTANCE', + '✓', + '✕', + '✓', + '✕', + '✓', + '✕', + '✓', + '✕' + ], + [ + 'NIDCPOWER_ATTR_PULSE_BIAS_CURRENT_LEVEL', + '✓', + '✓', + '✓', + '✓', + '✓', + '✕', + '✕', + '✕' + ], + [ + 'NIDCPOWER_ATTR_PULSE_BIAS_VOLTAGE_LIMIT', + '✓', + '✓', + '✓', + '✓', + '✓', + '✕', + '✕', + '✕' + ], + [ + 'NIDCPOWER_ATTR_PULSE_BIAS_VOLTAGE_LIMIT_HIGH', + '✓', + '✓', + '✓', + '✓', + '✓', + '✕', + '✕', + '✕' + ], + [ + 'NIDCPOWER_ATTR_PULSE_BIAS_VOLTAGE_LIMIT_LOW', + '✓', + '✓', + '✓', + '✓', + '✓', + '✕', + '✕', + '✕' + ], + [ + 'NIDCPOWER_ATTR_PULSE_CURRENT_LEVEL', + '✓', + '✓', + '✓', + '✓', + '✓', + '✕', + '✕', + '✕' + ], + [ + 'NIDCPOWER_ATTR_PULSE_CURRENT_LEVEL_RANGE', + '✓', + '✓', + '✓', + '✓', + '✓', + '✕', + '✕', + '✕' + ], + [ + 'NIDCPOWER_ATTR_PULSE_VOLTAGE_LIMIT', + '✓', + '✓', + '✓', + '✓', + '✓', + '✕', + '✕', + '✕' + ], + [ + 'NIDCPOWER_ATTR_PULSE_VOLTAGE_LIMIT_HIGH', + '✓', + '✓', + '✓', + '✓', + '✓', + '✕', + '✕', + '✕' + ], + [ + 'NIDCPOWER_ATTR_PULSE_VOLTAGE_LIMIT_LOW', + '✓', + '✓', + '✓', + '✓', + '✓', + '✕', + '✕', + '✕' + ], + [ + 'NIDCPOWER_ATTR_PULSE_VOLTAGE_LIMIT_RANGE', + '✓', + '✓', + '✓', + '✓', + '✓', + '✕', + '✕', + '✕' + ], + [ + 'NIDCPOWER_ATTR_PULSE_BIAS_CURRENT_LIMIT', + '✓', + '✓', + '✓', + '✓', + '✓', + '✕', + '✕', + '✕' + ], + [ + 'NIDCPOWER_ATTR_PULSE_BIAS_CURRENT_LIMIT_HIGH', + '✓', + '✓', + '✓', + '✓', + '✓', + '✕', + '✕', + '✕' + ], + [ + 'NIDCPOWER_ATTR_PULSE_BIAS_CURRENT_LIMIT_LOW', + '✓', + '✓', + '✓', + '✓', + '✓', + '✕', + '✕', + '✕' + ], + [ + 'NIDCPOWER_ATTR_PULSE_BIAS_VOLTAGE_LEVEL', + '✓', + '✓', + '✓', + '✓', + '✓', + '✕', + '✕', + '✕' + ], + [ + 'NIDCPOWER_ATTR_PULSE_CURRENT_LIMIT', + '✓', + '✓', + '✓', + '✓', + '✓', + '✕', + '✕', + '✕' + ], + [ + 'NIDCPOWER_ATTR_PULSE_CURRENT_LIMIT_HIGH', + '✓', + '✓', + '✓', + '✓', + '✓', + '✕', + '✕', + '✕' + ], + [ + 'NIDCPOWER_ATTR_PULSE_CURRENT_LIMIT_LOW', + '✓', + '✓', + '✓', + '✓', + '✓', + '✕', + '✕', + '✕' + ], + [ + 'NIDCPOWER_ATTR_PULSE_CURRENT_LIMIT_RANGE', + '✓', + '✓', + '✓', + '✓', + '✓', + '✕', + '✕', + '✕' + ], + [ + 'NIDCPOWER_ATTR_PULSE_VOLTAGE_LEVEL', + '✓', + '✓', + '✓', + '✓', + '✓', + '✕', + '✕', + '✕' + ], + [ + 'NIDCPOWER_ATTR_PULSE_VOLTAGE_LEVEL_RANGE', + '✓', + '✓', + '✓', + '✓', + '✓', + '✕', + '✕', + '✕' + ], + [ + 'NIDCPOWER_ATTR_TRANSIENT_RESPONSE', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓', + '✓' + ] + ], + 'table_header': [ + 'Attribute', + 'PXIe-4135', + 'PXIe-4136', + 'PXIe-4137', + 'PXIe-4138', + 'PXIe-4139', + 'PXIe-4140/4142/4144', + 'PXIe-4141/4143/4145', + 'PXIe-4162/4163' + ] + }, + 'name': 'attributeIds', + 'size': { + 'mechanism': 'len', + 'value': 'attributeIdCount' + }, + 'type': 'ViInt32[]' + }, + { + 'default_value': True, + 'direction': 'in', + 'documentation': { + 'description': 'Specifies that this current sequence is active.' + }, + 'name': 'setAsActiveSequence', + 'type': 'ViBoolean' + } + ], + 'returns': 'ViStatus' + }, + 'CreateAdvancedSequenceCommitStepWithChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'name': 'setAsActiveStep', + 'type': 'ViBoolean' + } + ], + 'returns': 'ViStatus' + }, + 'CreateAdvancedSequenceStep': { + 'codegen_method': 'private', + 'documentation': { + 'description': '\nCreates a new advanced sequence step in the advanced sequence specified\nby the Active advanced sequence. When you create an advanced sequence\nstep, each attribute you passed to the niDCPower_CreateAdvancedSequence\nfunction is reset to its default value for that step unless otherwise\nspecified.\n\n**Support for this Function**\n\nYou must set the source mode to Sequence to use this function.\n\nUsing the niDCPower_SetSequence function with Advanced Sequence\nfunctions is unsupported.\n\n**Related Topics**:\n\n`Advanced Sequence\nMode `__\n\n`Programming\nStates `__\n\nniDCPower_CreateAdvancedSequence\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'default_value': True, + 'direction': 'in', + 'documentation': { + 'description': 'Specifies that this current step in the active sequence is active.' + }, + 'name': 'setAsActiveStep', + 'type': 'ViBoolean' + } + ], + 'returns': 'ViStatus' + }, + 'CreateAdvancedSequenceStepWithChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'name': 'setAsActiveStep', + 'type': 'ViBoolean' + } + ], + 'returns': 'ViStatus' + }, + 'CreateAdvancedSequenceWithChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'name': 'sequenceName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'name': 'attributeIdCount', + 'type': 'ViInt32' + }, + { + 'direction': 'in', + 'name': 'attributeIDs', + 'size': { + 'mechanism': 'TBD', + 'value': 'TBD' + }, + 'type': 'ViInt32[]' + }, + { + 'direction': 'in', + 'name': 'setAsActiveSequence', + 'type': 'ViBoolean' + } + ], + 'returns': 'ViStatus' + }, + 'DeleteAdvancedSequence': { + 'codegen_method': 'private', + 'documentation': { + 'description': '\nDeletes a previously created advanced sequence and all the advanced\nsequence steps in the advanced sequence.\n\n**Support for this Function**\n\nYou must set the source mode to Sequence to use this function.\n\nUsing the niDCPower_SetSequence function with Advanced Sequence\nfunctions is unsupported.\n\n**Related Topics**:\n\n`Advanced Sequence\nMode `__\n\n`Programming\nStates `__\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'specifies the name of the sequence to delete.' + }, + 'name': 'sequenceName', + 'type': 'ViConstString' + } + ], + 'returns': 'ViStatus' + }, + 'DeleteAdvancedSequenceWithChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'name': 'sequenceName', + 'type': 'ViConstString' + } + ], + 'returns': 'ViStatus' + }, + 'Disable': { + 'documentation': { + 'description': '\nThis function performs the same actions as the niDCPower_reset\nfunction, except that this function also immediately sets the\nNIDCPOWER_ATTR_OUTPUT_ENABLED attribute to VI_FALSE.\n\nThis function opens the output relay on devices that have an output\nrelay.\n' + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + } + ], + 'returns': 'ViStatus' + }, + 'DisablePulseTrigger': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nDisables the Pulse trigger. The device does not wait for a pulse trigger\nbefore performing a pulse operation. Refer to `Pulse\nMode `__ and `Sequence Source\nMode `__ for more information\nabout the Pulse trigger.\n\nThis function is necessary only if you configured a Pulse trigger in the\npast and now want to disable it.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + } + ], + 'returns': 'ViStatus' + }, + 'DisablePulseTriggerWithChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' + } + ], + 'returns': 'ViStatus' + }, + 'DisableSequenceAdvanceTrigger': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nDisables the Sequence Advance trigger. The device does not wait for a\nSequence Advance trigger before advancing to the next iteration of the\nsequence. Refer to the `Sequence Source\nMode `__ topic for more\ninformation about the Sequence Advance trigger.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + } + ], + 'returns': 'ViStatus' + }, + 'DisableSequenceAdvanceTriggerWithChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' + } + ], + 'returns': 'ViStatus' + }, + 'DisableSourceTrigger': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nDisables the Source trigger. The device does not wait for a source\ntrigger before performing a source operation. Refer to the `Single Point\nSource Mode `__ and `Sequence\nSource Mode `__ topics for\nmore information about the Source trigger.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + } + ], + 'returns': 'ViStatus' + }, + 'DisableSourceTriggerWithChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' + } + ], + 'returns': 'ViStatus' + }, + 'DisableStartTrigger': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nDisables the Start trigger. The device does not wait for a Start trigger\nwhen starting generation or acquisition.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + } + ], + 'returns': 'ViStatus' + }, + 'DisableStartTriggerWithChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' + } + ], + 'returns': 'ViStatus' + }, + 'EnableSequenceInstructionCapturing': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'name': 'enable', + 'type': 'ViBoolean' + } + ], + 'returns': 'ViStatus' + }, + 'EraseFlashEepromSector': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'address', + 'type': 'ViUInt32' + } + ], + 'returns': 'ViStatus' + }, + 'ErrorQuery': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'out', + 'name': 'errorCode', + 'type': 'ViInt32' + }, + { + 'direction': 'in', + 'name': 'errorMessage', + 'size': { + 'mechanism': 'TBD', + 'value': 'TBD' + }, + 'type': 'ViString[]' + } + ], + 'returns': 'ViStatus' + }, + 'ExportAttributeConfigurationBuffer': { + 'documentation': { + 'description': '\nExports the attribute configuration of the session to the specified\nconfiguration buffer.\n\nYou can export and import session attribute configurations only between\ndevices with identical model numbers and the same number of configured\nchannels.\n\nThis function verifies that the attributes you have configured for the\nsession are valid. If the configuration is invalid, NI‑DCPower returns\nan error.\n\n**Support for this Function**\n\nCalling this function in `Sequence Source\nMode `__ is unsupported.\n\n**Channel Mapping Behavior for Multichannel Sessions**\n\nWhen importing and exporting session attribute configurations between\nNI‑DCPower sessions that were initialized with different channels, the\nconfigurations of the exporting channels are mapped to the importing\nchannels in the order you specify in the **channelName** input to the\nniDCPower_InitializeWithChannels function.\n\nFor example, if your entry for **channelName** is 0,1 for the exporting\nsession and 1,2 for the importing session:\n\n- The configuration exported from channel 0 is imported into channel 1.\n- The configuration exported from channel 1 is imported into channel 2.\n\n**Related Topics:**\n\n`Using Properties and\nAttributes `__\n\n`Setting Properties and Attributes Before Reading\nThem `__\n', + 'note': '\nThis function will return an error if the total number of channels\ninitialized for the exporting session is not equal to the total number\nof channels initialized for the importing session.\n' + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the size, in bytes, of the byte array to export. If you enter\n0, this function returns the needed size.\n' + }, + 'name': 'size', + 'type': 'ViInt32' + }, + { + 'direction': 'out', + 'documentation': { + 'description': '\nSpecifies the byte array buffer to be populated with the exported\nattribute configuration.\n' + }, + 'name': 'configuration', + 'size': { + 'mechanism': 'ivi-dance', + 'value': 'size' + }, + 'type': 'ViInt8[]' + } + ], + 'returns': 'ViStatus' + }, + 'ExportAttributeConfigurationFile': { + 'documentation': { + 'description': '\nExports the attribute configuration of the session to the specified\nfile.\n\nYou can export and import session attribute configurations only between\ndevices with identical model numbers and the same number of configured\nchannels.\n\nThis function verifies that the attributes you have configured for the\nsession are valid. If the configuration is invalid, NI‑DCPower returns\nan error.\n\n**Support for this Function**\n\nCalling this function in `Sequence Source\nMode `__ is unsupported.\n\n**Channel Mapping Behavior for Multichannel Sessions**\n\nWhen importing and exporting session attribute configurations between\nNI‑DCPower sessions that were initialized with different channels, the\nconfigurations of the exporting channels are mapped to the importing\nchannels in the order you specify in the **channelName** input to the\nniDCPower_InitializeWithChannels function.\n\nFor example, if your entry for **channelName** is 0,1 for the exporting\nsession and 1,2 for the importing session:\n\n- The configuration exported from channel 0 is imported into channel 1.\n- The configuration exported from channel 1 is imported into channel 2.\n\n**Related Topics:**\n\n`Using Properties and\nAttributes `__\n\n`Setting Properties and Attributes Before Reading\nThem `__\n', + 'note': '\nThis function will return an error if the total number of channels\ninitialized for the exporting session is not equal to the total number\nof channels initialized for the importing session.\n' + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the absolute path to the file to contain the exported\nattribute configuration. If you specify an empty or relative path, this\nfunction returns an error.\n**Default file extension:** .nidcpowerconfig\n' + }, + 'name': 'filePath', + 'type': 'ViConstString' + } + ], + 'returns': 'ViStatus' + }, + 'ExportSignal': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nRoutes signals (triggers and events) to the output terminal you specify.\nThe route is created when the session is niDCPower_Commit.\n\n**Related Topics:**\n\n`Triggers `__\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies which trigger or event to export.\n**Defined Values:**\n', + 'table_body': [ + [ + 'NIDCPOWER_VAL_SOURCE_COMPLETE_EVENT (1030)', + 'Exports the Source Complete event.' + ], + [ + 'NIDCPOWER_VAL_MEASURE_COMPLETE_EVENT (1031)', + 'Exports the Measure Complete event.' + ], + [ + 'NIDCPOWER_VAL_SEQUENCE_ITERATION_COMPLETE_EVENT (1032)', + 'Exports the Sequence Iteration Complete event.' + ], + [ + 'NIDCPOWER_VAL_SEQUENCE_ENGINE_DONE_EVENT (1033)', + 'Exports the Sequence Engine Done event.' + ], + [ + 'NIDCPOWER_VAL_PULSE_COMPLETE_EVENT (1051)', + 'Exports the Pulse Complete event.' + ], + [ + 'NIDCPOWER_VAL_READY_FOR_PULSE_TRIGGER_EVENT (1052)', + 'Exports the Ready Pulse Trigger event.' + ], + [ + 'NIDCPOWER_VAL_START_TRIGGER (1034)', + 'Exports the Start trigger.' + ], + [ + 'NIDCPOWER_VAL_SOURCE_TRIGGER (1035)', + 'Exports the Source trigger.' + ], + [ + 'NIDCPOWER_VAL_MEASURE_TRIGGER (1036)', + 'Exports the Measure trigger.' + ], + [ + 'NIDCPOWER_VAL_SEQUENCE_ADVANCE_TRIGGER (1037)', + 'Exports the Sequence Advance trigger.' + ], + [ + 'NIDCPOWER_VAL_PULSE_TRIGGER (1053)', + 'Exports the Pulse trigger.' + ] + ] + }, + 'enum': 'ExportSignal', + 'name': 'signal', + 'type': 'ViInt32' + }, + { + 'default_value': '""', + 'direction': 'in', + 'documentation': { + 'description': 'Reserved for future use. Pass in an empty string for this parameter.' + }, + 'name': 'signalIdentifier', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies where to export the selected signal.\n**Relative Terminals**:\n', + 'table_body': [ + [ + '""', + 'Do not export signal' + ], + [ + '"PXI_Trig0"', + 'PXI trigger line 0' + ], + [ + '"PXI_Trig1"', + 'PXI trigger line 1' + ], + [ + '"PXI_Trig2"', + 'PXI trigger line 2' + ], + [ + '"PXI_Trig3"', + 'PXI trigger line 3' + ], + [ + '"PXI_Trig4"', + 'PXI trigger line 4' + ], + [ + '"PXI_Trig5"', + 'PXI trigger line 5' + ], + [ + '"PXI_Trig6"', + 'PXI trigger line 6' + ], + [ + '"PXI_Trig7"', + 'PXI trigger line 7' + ] + ] + }, + 'name': 'outputTerminal', + 'type': 'ViConstString' + } + ], + 'returns': 'ViStatus' + }, + 'ExportSignalWithChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'name': 'signal', + 'type': 'ViInt32' + }, + { + 'direction': 'in', + 'name': 'signalIdentifier', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'name': 'outputTerminal', + 'type': 'ViConstString' + } + ], + 'returns': 'ViStatus' + }, + 'FancyFetchMultiple': { + 'codegen_method': 'python-only', + 'documentation': { + 'description': '\nReturns a list of named tuples (Measurement) that were\npreviously taken and are stored in the NI-DCPower buffer. This function\nshould not be used when the NIDCPOWER_ATTR_MEASURE_WHEN attribute is\nset to NIDCPOWER_VAL_ON_DEMAND. You must first call\nniDCPower_Initiate before calling this function.\n\nFields in Measurement:\n\n- **voltage** (float)\n- **current** (float)\n- **in_compliance** (bool)\n\n', + 'note': 'This function is not supported on all devices. Refer to `Supported Functions by Device `__ for more information about supported devices.' + }, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'fancy_fetch' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies a particular instrument session. **vi** is obtained from the niDCPower_InitializeWithChannels function.' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, + 'name': 'channelName', + 'type': 'ViString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the number of measurements to fetch.' + }, + 'name': 'count', + 'type': 'ViInt32' + }, + { + 'default_value': 'datetime.timedelta(seconds=1.0)', + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the maximum time allowed for this function to complete. If the function does not complete within this time interval, NI-DCPower returns an error.', + 'note': 'When setting the timeout interval, ensure you take into account any triggers so that the timeout interval is long enough for your application.' + }, + 'name': 'timeout', + 'python_api_converter_name': 'convert_timedelta_to_seconds', + 'type': 'ViReal64', + 'type_in_documentation': 'float in seconds or datetime.timedelta' + }, + { + 'direction': 'out', + 'documentation': { + 'description': '\nList of named tuples with fields:\n\n- **voltage** (float)\n- **current** (float)\n- **in_compliance** (bool)\n' + }, + 'name': 'measurements', + 'python_type': 'Measurement', + 'size': { + 'mechanism': 'python-code', + 'value': None + }, + 'type': 'ViReal64[]' + } + ], + 'python_name': 'fetch_multiple', + 'returns': 'ViStatus' + }, + 'FancyMeasureMultiple': { + 'codegen_method': 'python-only', + 'documentation': { + 'description': '\nReturns a list of named tuples (Measurement) containing the measured voltage\nand current values on the specified output channel(s). Each call to this function\nblocks other function calls until the measurements are returned from the device.\nThe order of the measurements returned in the array corresponds to the order\non the specified output channel(s).\n\nFields in Measurement:\n\n- **voltage** (float)\n- **current** (float)\n- **in_compliance** (bool) - Always None\n\n', + 'note': 'This function is not supported on all devices. Refer to `Supported Functions by Device `__ for more information about supported devices.' + }, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'fancy_fetch' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies a particular instrument session. **vi** is obtained from the niDCPower_InitializeWithChannels function.' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, + 'name': 'channelName', + 'type': 'ViString' + }, + { + 'direction': 'out', + 'documentation': { + 'description': '\nList of named tuples with fields:\n\n- **voltage** (float)\n- **current** (float)\n- **in_compliance** (bool) - Always None\n' + }, + 'name': 'measurements', + 'python_type': 'Measurement', + 'size': { + 'mechanism': 'python-code', + 'value': None + }, + 'type': 'ViReal64[]' + } + ], + 'python_name': 'measure_multiple', + 'returns': 'ViStatus' + }, + 'FetchMultiple': { + 'codegen_method': 'private', + 'documentation': { + 'description': '\nReturns an array of voltage measurements, an array of current\nmeasurements, and an array of compliance measurements that were\npreviously taken and are stored in the NI-DCPower buffer. This function\nshould not be used when the NIDCPOWER_ATTR_MEASURE_WHEN attribute is\nset to NIDCPOWER_VAL_ON_DEMAND. You must first call\nniDCPower_Initiate before calling this function.\n\nRefer to the `Acquiring\nMeasurements `__\nand `Compliance `__ topics in\nthe *NI DC Power Supplies and SMUs Help* for more information about\nconfiguring this function.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, + 'method_name_for_documentation': 'fetch_multiple', + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the maximum time allowed for this function to complete, in\nseconds. If the function does not complete within this time interval,\nNI-DCPower returns an error.\n', + 'note': '\nWhen setting the timeout interval, ensure you take into account any\ntriggers so that the timeout interval is long enough for your\napplication.\n' + }, + 'name': 'timeout', + 'python_api_converter_name': 'convert_timedelta_to_seconds', + 'type': 'ViReal64', + 'type_in_documentation': 'float in seconds or datetime.timedelta' + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the number of measurements to fetch.' + }, + 'name': 'count', + 'type': 'ViInt32' + }, + { + 'direction': 'out', + 'documentation': { + 'description': '\nReturns an array of voltage measurements. Ensure that sufficient space\nhas been allocated for the returned array.\n' + }, + 'name': 'voltageMeasurements', + 'size': { + 'mechanism': 'passed-in', + 'value': 'count' + }, 'type': 'ViReal64[]', -'documentation': { -'description': ''' -Returns an array of voltage measurements. Ensure that sufficient space -has been allocated for the returned array. -''', -}, + 'use_array': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': '\nReturns an array of current measurements. Ensure that sufficient space\nhas been allocated for the returned array.\n' + }, + 'name': 'currentMeasurements', + 'size': { + 'mechanism': 'passed-in', + 'value': 'count' + }, + 'type': 'ViReal64[]', + 'use_array': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': '\nReturns an array of Boolean values indicating whether the output was in\ncompliance at the time the measurement was taken. Ensure that sufficient\nspace has been allocated for the returned array.\n' + }, + 'name': 'inCompliance', + 'size': { + 'mechanism': 'passed-in', + 'value': 'count' + }, + 'type': 'ViBoolean[]' + }, + { + 'direction': 'out', + 'documentation': { + 'description': '\nIndicates the number of measured values actually retrieved from the\ndevice.\n' + }, + 'name': 'actualCount', + 'type': 'ViInt32', + 'use_in_python_api': False + } + ], + 'returns': 'ViStatus' + }, + 'FreeServer': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + } + ], + 'returns': 'ViStatus' + }, + 'GetAttributeFlags': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'attributeId', + 'type': 'ViAttr' + }, + { + 'direction': 'out', + 'name': 'attributeFlags', + 'type': 'ViInt32' + }, + { + 'direction': 'out', + 'name': 'attributeSupported', + 'type': 'ViBoolean' + } + ], + 'returns': 'ViStatus' + }, + 'GetAttributeViBoolean': { + 'codegen_method': 'private', + 'documentation': { + 'description': '\n| Queries the value of a ViBoolean attribute.\n| You can use this function to get the values of device-specific\n attributes and inherent IVI attributes.\n' + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the ID of an attribute. From the function panel window, you\ncan use this control as follows.\n\n- In the function panel window, click on the control or press **Enter**\n or the spacebar to display a dialog box containing hierarchical list\n of the available attributes. Help text is shown for each attribute.\n Select an attribute by double-clicking on it or by selecting it and\n then pressing **Enter**.\n- A ring control at the top of the dialog box allows you to see all IVI\n attributes or only the attributes of type ViBoolean. If you choose to\n see all IVI attributes, the data types appear to the right of the\n attribute names in the list box. Attributes with data types other\n than ViBoolean are dim. If you select an attribute data type that is\n dim, LabWindows/CVI transfers you to the function panel for the\n corresponding function that is consistent with the data type.\n- If you want to enter a variable name, press **Ctrl**\\ +\\ **T** to\n change this ring control to a manual input box. If the attribute in\n this ring control has named constants as valid values, you can view\n the constants by moving to the value control and pressing **Enter**.\n' + }, + 'name': 'attributeId', + 'type': 'ViAttr' + }, + { + 'direction': 'out', + 'documentation': { + 'description': '\nReturns the current value of the attribute. Passes the address of a\nViBoolean variable.\nIf the attribute currently showing in the attribute ring control has\nconstants as valid values, you can view a list of the constants by\npressing **Enter** on this control. Select a value by double-clicking on\nit or by selecting it and then pressing **Enter**.\n' + }, + 'name': 'attributeValue', + 'type': 'ViBoolean' + } + ], + 'returns': 'ViStatus' + }, + 'GetAttributeViInt32': { + 'codegen_method': 'private', + 'documentation': { + 'description': '\n| Queries the value of a ViInt32 attribute.\n| You can use this function to get the values of device-specific\n attributes and inherent IVI attributes.\n' + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the ID of an attribute. From the function panel window, you\ncan use this control as follows.\n\n- In the function panel window, click on the control or press **Enter**\n or the spacebar to display a dialog box containing hierarchical list\n of the available attributes. Help text is shown for each attribute.\n Select an attribute by double-clicking on it or by selecting it and\n then pressing **Enter**.\n- A ring control at the top of the dialog box allows you to see all IVI\n attributes or only the attributes of type ViInt32. If you choose to\n see all IVI attributes, the data types appear to the right of the\n attribute names in the list box. Attributes with data types other\n than ViInt32 are dim. If you select an attribute data type that is\n dim, LabWindows/CVI transfers you to the function panel for the\n corresponding function that is consistent with the data type.\n- If you want to enter a variable name, press **Ctrl**\\ +\\ **T** to\n change this ring control to a manual input box. If the attribute in\n this ring control has named constants as valid values, you can view\n the constants by moving to the value control and pressing **Enter**.\n' + }, + 'name': 'attributeId', + 'type': 'ViAttr' + }, + { + 'direction': 'out', + 'documentation': { + 'description': '\nReturns the current value of the attribute. Passes the address of a\nViInt32 variable.\nIf the attribute currently showing in the attribute ring control has\nconstants as valid values, you can view a list of the constants by\npressing **Enter** on this control. Select a value by double-clicking on\nit or by selecting it and then pressing **Enter**.\n' + }, + 'name': 'attributeValue', + 'type': 'ViInt32' + } + ], + 'returns': 'ViStatus' + }, + 'GetAttributeViInt64': { + 'codegen_method': 'private', + 'documentation': { + 'description': '\n| Queries the value of a ViInt64 attribute.\n| You can use this function to get the values of device-specific\n attributes and inherent IVI attributes.\n' + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the ID of an attribute. From the function panel window, you\ncan use this control as follows.\n\n- In the function panel window, click on the control or press **Enter**\n or the spacebar to display a dialog box containing hierarchical list\n of the available attributes. Help text is shown for each attribute.\n Select an attribute by double-clicking on it or by selecting it and\n then pressing **Enter**.\n- A ring control at the top of the dialog box allows you to see all IVI\n attributes or only the attributes of type ViReal64. If you choose to\n see all IVI attributes, the data types appear to the right of the\n attribute names in the list box. Attributes with data types other\n than ViReal64 are dim. If you select an attribute data type that is\n dim, LabWindows/CVI transfers you to the function panel for the\n corresponding function that is consistent with the data type.\n- If you want to enter a variable name, press **Ctrl**\\ +\\ **T** to\n change this ring control to a manual input box. If the attribute in\n this ring control has named constants as valid values, you can view\n the constants by moving to the value control and pressing **Enter**.\n' + }, + 'name': 'attributeId', + 'type': 'ViAttr' + }, + { + 'direction': 'out', + 'documentation': { + 'description': '\nReturns the current value of the attribute. Passes the address of a\nViReal64 variable.\nIf the attribute currently showing in the attribute ring control has\nconstants as valid values, you can view a list of the constants by\npressing **Enter** on this control. Select a value by double-clicking on\nit or by selecting it and then pressing **Enter**.\n' + }, + 'name': 'attributeValue', + 'type': 'ViInt64' + } + ], + 'returns': 'ViStatus' + }, + 'GetAttributeViReal64': { + 'codegen_method': 'private', + 'documentation': { + 'description': '\n| Queries the value of a ViReal64 attribute.\n| You can use this function to get the values of device-specific\n attributes and inherent IVI attributes.\n' + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the ID of an attribute. From the function panel window, you\ncan use this control as follows.\n\n- In the function panel window, click on the control or press **Enter**\n or the spacebar to display a dialog box containing hierarchical list\n of the available attributes. Help text is shown for each attribute.\n Select an attribute by double-clicking on it or by selecting it and\n then pressing **Enter**.\n- A ring control at the top of the dialog box allows you to see all IVI\n attributes or only the attributes of type ViReal64. If you choose to\n see all IVI attributes, the data types appear to the right of the\n attribute names in the list box. Attributes with data types other\n than ViReal64 are dim. If you select an attribute data type that is\n dim, LabWindows/CVI transfers you to the function panel for the\n corresponding function that is consistent with the data type.\n- If you want to enter a variable name, press **Ctrl**\\ +\\ **T** to\n change this ring control to a manual input box. If the attribute in\n this ring control has named constants as valid values, you can view\n the constants by moving to the value control and pressing **Enter**.\n' + }, + 'name': 'attributeId', + 'type': 'ViAttr' + }, + { + 'direction': 'out', + 'documentation': { + 'description': '\nReturns the current value of the attribute. Passes the address of a\nViReal64 variable.\nIf the attribute currently showing in the attribute ring control has\nconstants as valid values, you can view a list of the constants by\npressing **Enter** on this control. Select a value by double-clicking on\nit or by selecting it and then pressing **Enter**.\n' + }, + 'name': 'attributeValue', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' + }, + 'GetAttributeViSession': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\n| Queries the value of a ViSession attribute.\n| You can use this function to get the values of device-specific\n attributes and inherent IVI attributes.\n' + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the ID of an attribute. From the function panel window, you\ncan use this control as follows.\n\n- In the function panel window, click on the control or press **Enter**\n or the spacebar to display a dialog box containing hierarchical list\n of the available attributes. Help text is shown for each attribute.\n Select an attribute by double-clicking on it or by selecting it and\n then pressing **Enter**.\n- A ring control at the top of the dialog box allows you to see all IVI\n attributes or only the attributes of type ViSession. If you choose to\n see all IVI attributes, the data types appear to the right of the\n attribute names in the list box. Attributes with data types other\n than ViSession are dim. If you select an attribute data type that is\n dim, LabWindows/CVI transfers you to the function panel for the\n corresponding function that is consistent with the data type.\n- If you want to enter a variable name, press **Ctrl**\\ +\\ **T** to\n change this ring control to a manual input box. If the attribute in\n this ring control has named constants as valid values, you can view\n the constants by moving to the value control and pressing **Enter**.\n' + }, + 'name': 'attributeId', + 'type': 'ViAttr' + }, + { + 'direction': 'out', + 'documentation': { + 'description': '\nReturns the current value of the attribute. Passes the address of a\nViSession variable.\nIf the attribute currently showing in the attribute ring control has\nconstants as valid values, you can view a list of the constants by\npressing **Enter** on this control. Select a value by double-clicking on\nit or by selecting it and then pressing **Enter**.\n' + }, + 'name': 'attributeValue', + 'type': 'ViSession' + } + ], + 'returns': 'ViStatus' + }, + 'GetAttributeViString': { + 'codegen_method': 'private', + 'documentation': { + 'description': '\n| Queries the value of a ViString attribute.\n| You can use this function to get the values of device-specific\n attributes and inherent IVI attributes.\n' + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the ID of an attribute. From the function panel window, you\ncan use this control as follows.\n\n- In the function panel window, click on the control or press or the\n spacebar to display a dialog box containing hierarchical list of the\n available attributes. Help text is shown for each attribute. Select\n an attribute by double-clicking on it or by selecting it and then\n pressing .\n- A ring control at the top of the dialog box allows you to see all IVI\n attributes or only the attributes of type ViString. If you choose to\n see all IVI attributes, the data types appear to the right of the\n attribute names in the list box. Attributes with data types other\n than ViString are dimmed. If you select an attribute data type that\n is dimmed, LabWindows/CVI transfers you to the function panel for the\n corresponding function that is consistent with the data type.\n- If you want to enter a variable name, press to change this ring\n control to a manual input control. If the attribute in this ring\n control has named constants as valid values, you can view the\n constants by moving to the value control and pressing .\n' + }, + 'name': 'attributeId', + 'type': 'ViAttr' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nPasses the number of bytes in the buffer and specifies the number of\nbytes in the ViChar array you specify for **value**. If the current\nvalue of **value**, including the terminating NUL byte, is larger than\nthe size you indicate in this parameter, the function copies (buffer\nsize - 1) bytes into the buffer, places an ASCII NUL byte at the end of\nthe buffer, and returns the buffer size you must pass to get the entire\nvalue. For example, if the value is 123456 and the buffer size is 4, the\nfunction places 123 into the buffer and returns 7.\nTo obtain the required buffer size, you can pass 0 for this attribute\nand VI_NULL for **value**. If you want the function to fill in the\nbuffer regardless of the number of bytes in the value, pass a negative\nnumber for this attribute.\n' + }, + 'name': 'bufferSize', + 'type': 'ViInt32' + }, + { + 'direction': 'out', + 'documentation': { + 'description': '\nThe buffer in which the function returns the current value of the\nattribute. The buffer must be of type ViChar and have at least as many\nbytes as indicated in **bufSize**.\nIf the current value of the attribute, including the terminating NUL\nbyte, contains more bytes that you indicate in this attribute, the\nfunction copies (buffer size -1) bytes into the buffer, places an ASCII\nNUL byte at the end of the buffer, and returns the buffer size you must\npass to get the entire value. For example, if the value is 123456 and\nthe buffer size is 4, the function places 123 into the buffer and\nreturns 7.\nIf you specify 0 for **bufSize**, you can pass VI_NULL for this\nattribute.\nIf the attribute currently showing in the attribute ring control has\nconstants as valid values, you can view a list of the constants by\npressing on this control. Select a value by double-clicking on it or by\nselecting it and then pressing .\n' + }, + 'name': 'attributeValue', + 'size': { + 'mechanism': 'ivi-dance', + 'value': 'bufferSize' + }, + 'type': 'ViChar[]' + } + ], + 'returns': 'ViStatus' + }, + 'GetAttributeWithOptionsViBoolean': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'name': 'attributeId', + 'type': 'ViAttr' + }, + { + 'direction': 'in', + 'name': 'retrievalMode', + 'type': 'ViInt32' + }, + { + 'direction': 'out', + 'name': 'value', + 'type': 'ViBoolean' + } + ], + 'returns': 'ViStatus' + }, + 'GetAttributeWithOptionsViInt32': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'name': 'attributeId', + 'type': 'ViAttr' + }, + { + 'direction': 'in', + 'name': 'retrievalMode', + 'type': 'ViInt32' + }, + { + 'direction': 'out', + 'name': 'value', + 'type': 'ViInt32' + } + ], + 'returns': 'ViStatus' + }, + 'GetAttributeWithOptionsViInt64': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'name': 'attributeId', + 'type': 'ViAttr' + }, + { + 'direction': 'in', + 'name': 'retrievalMode', + 'type': 'ViInt32' + }, + { + 'direction': 'out', + 'name': 'value', + 'type': 'ViInt64' + } + ], + 'returns': 'ViStatus' + }, + 'GetAttributeWithOptionsViReal64': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'name': 'attributeId', + 'type': 'ViAttr' + }, + { + 'direction': 'in', + 'name': 'retrievalMode', + 'type': 'ViInt32' + }, + { + 'direction': 'out', + 'name': 'value', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' + }, + 'GetAttributeWithOptionsViSession': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'name': 'attributeId', + 'type': 'ViAttr' + }, + { + 'direction': 'in', + 'name': 'retrievalMode', + 'type': 'ViInt32' + }, + { + 'direction': 'out', + 'name': 'value', + 'type': 'ViSession' + } + ], + 'returns': 'ViStatus' + }, + 'GetAttributeWithOptionsViString': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'name': 'attributeId', + 'type': 'ViAttr' + }, + { + 'direction': 'in', + 'name': 'retrievalMode', + 'type': 'ViInt32' + }, + { + 'direction': 'in', + 'name': 'bufSize', + 'type': 'ViInt32' + }, + { + 'direction': 'in', + 'name': 'value', + 'size': { + 'mechanism': 'TBD', + 'value': 'TBD' + }, + 'type': 'ViString[]' + } + ], + 'returns': 'ViStatus' + }, + 'GetCalUserDefinedInfo': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'Returns the user-defined information in the device onboard EEPROM.' + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitExtCal or niDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'out', + 'documentation': { + 'description': '\nReturns the user-defined information stored in the device onboard\nEEPROM.\n' + }, + 'name': 'info', + 'size': { + 'mechanism': 'fixed', + 'value': 256 + }, + 'type': 'ViChar[]' + } + ], + 'returns': 'ViStatus' + }, + 'GetCalUserDefinedInfoMaxSize': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nReturns the maximum number of characters that can be used to store\nuser-defined information in the device onboard EEPROM.\n' + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitExtCal or niDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'out', + 'documentation': { + 'description': '\nReturns the number of characters that can be stored in the device\nonboard EEPROM.\n' + }, + 'name': 'infoSize', + 'type': 'ViInt32' + } + ], + 'returns': 'ViStatus' + }, + 'GetChannelName': { + 'documentation': { + 'description': '\nRetrieves the output **channelName** that corresponds to the requested\n**index**. Use the NIDCPOWER_ATTR_CHANNEL_COUNT attribute to\ndetermine the upper bound of valid values for **index**.\n' + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies which output channel name to return. The index values begin at\n1.\n' + }, + 'name': 'index', + 'type': 'ViInt32' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the number of bytes in the ViChar array you specify for\n**channelName**. If the **channelName**, including the terminating NUL\nbyte, contains more bytes than you indicate in this attribute, the\nfunction copies (buffer size - 1) bytes into the buffer, places an ASCII\nNUL byte at the end of the buffer, and returns the buffer size you must\npass to get the entire value. For example, if the value is 123456 and\nthe buffer size is 4, the function places 123 into the buffer and\nreturns 7.\nIf you pass 0, you can pass VI_NULL for **channelName**.\n' + }, + 'name': 'bufferSize', + 'type': 'ViInt32' + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the output channel name that corresponds to **index**.' + }, + 'name': 'channelName', + 'size': { + 'mechanism': 'ivi-dance', + 'value': 'bufferSize' + }, + 'type': 'ViChar[]' + } + ], + 'returns': 'ViStatus' + }, + 'GetChannelNameFromString': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'index', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'name': 'bufferSize', + 'type': 'ViInt32' + }, + { + 'direction': 'out', + 'name': 'channelName', + 'size': { + 'mechanism': 'ivi-dance', + 'value': 'bufferSize' + }, + 'type': 'ViChar[]' + } + ], + 'returns': 'ViStatus' + }, + 'GetDeviceSessionState': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'out', + 'name': 'sessionState', + 'type': 'ViInt32' + } + ], + 'returns': 'ViStatus' + }, + 'GetError': { + 'codegen_method': 'private', + 'documentation': { + 'description': '\n| Retrieves and then clears the IVI error information for the session or\n the current execution thread unless **bufferSize** is 0, in which case\n the function does not clear the error information. By passing 0 for\n the buffer size, you can ascertain the buffer size required to get the\n entire error description string and then call the function again with\n a sufficiently large buffer size.\n| If the user specifies a valid IVI session for **vi**, this function\n retrieves and then clears the error information for the session. If\n the user passes VI_NULL for **vi**, this function retrieves and then\n clears the error information for the current execution thread. If\n **vi** is an invalid session, the function does nothing and returns an\n error. Normally, the error information describes the first error that\n occurred since the user last called niDCPower_GetError or\n niDCPower_ClearError.\n' + }, + 'is_error_handling': True, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the error code for the session or execution thread.' + }, + 'name': 'code', + 'type': 'ViStatus' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the number of bytes in the ViChar array you specify for\n**description**.\nIf the error description, including the terminating NUL byte, contains\nmore bytes than you indicate in this attribute, the function copies\n(buffer size - 1) bytes into the buffer, places an ASCII NUL byte at the\nend of the buffer, and returns the buffer size you must pass to get the\nentire value. For example, if the value is 123456 and the buffer size is\n4, the function places 123 into the buffer and returns 7.\nIf you pass 0 for this attribute, you can pass VI_NULL for\n**description**.\n' + }, + 'name': 'bufferSize', + 'type': 'ViInt32' + }, + { + 'direction': 'out', + 'documentation': { + 'description': '\nReturns the error description for the IVI session or execution thread.\nIf there is no description, the function returns an empty string.\nThe buffer must contain at least as many elements as the value you\nspecify with **bufferSize**. If the error description, including the\nterminating NUL byte, contains more bytes than you indicate with\n**bufferSize**, the function copies (buffer size - 1) bytes into the\nbuffer, places an ASCII NUL byte at the end of the buffer, and returns\nthe buffer size you must pass to get the entire value. For example, if\nthe value is 123456 and the buffer size is 4, the function places 123\ninto the buffer and returns 7.\nIf you pass 0 for **bufferSize**, you can pass VI_NULL for this\nattribute.\n' + }, + 'name': 'description', + 'size': { + 'mechanism': 'ivi-dance', + 'value': 'bufferSize' + }, + 'type': 'ViChar[]' + } + ], + 'returns': 'ViStatus', + 'use_session_lock': False + }, + 'GetExtCalLastDateAndTime': { + 'codegen_method': 'private', + 'documentation': { + 'description': '\nReturns the date and time of the last successful calibration. The time\nreturned is 24-hour (military) local time; for example, if the device\nwas calibrated at 2:30 PM, this function returns 14 for **hours** and 30\nfor **minutes**.\n' + }, + 'method_name_for_documentation': 'get_ext_cal_last_date_and_time', + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitExtCal or niDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the **year** the device was last calibrated.' + }, + 'name': 'year', + 'type': 'ViInt32' + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the **month** in which the device was last calibrated.' + }, + 'name': 'month', + 'type': 'ViInt32' + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the **day** on which the device was last calibrated.' + }, + 'name': 'day', + 'type': 'ViInt32' + }, + { + 'direction': 'out', + 'documentation': { + 'description': '\nReturns the **hour** (in 24-hour time) in which the device was last\ncalibrated.\n' + }, + 'name': 'hour', + 'type': 'ViInt32' + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the **minute** in which the device was last calibrated.' + }, + 'name': 'minute', + 'type': 'ViInt32' + } + ], + 'returns': 'ViStatus' + }, + 'GetExtCalLastTemp': { + 'documentation': { + 'description': '\nReturns the onboard **temperature** of the device, in degrees Celsius,\nduring the last successful external calibration.\n' + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitExtCal or niDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'out', + 'documentation': { + 'description': '\nReturns the onboard **temperature** of the device, in degrees Celsius,\nduring the last successful external calibration.\n' + }, + 'name': 'temperature', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' + }, + 'GetExtCalRecommendedInterval': { + 'documentation': { + 'description': '\nReturns the recommended maximum interval, in **months**, between\nexternal calibrations.\n' + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitExtCal or niDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'out', + 'documentation': { + 'description': '\nSpecifies the recommended maximum interval, in **months**, between\nexternal calibrations.\n' + }, + 'name': 'months', + 'python_api_converter_name': 'convert_month_to_timedelta', + 'type': 'ViInt32', + 'type_in_documentation': 'datetime.timedelta' + } + ], + 'returns': 'ViStatus' + }, + 'GetLastExtCalLastDateAndTime': { + 'codegen_method': 'python-only', + 'documentation': { + 'description': 'Returns the date and time of the last successful calibration.' + }, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'datetime_wrappers' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies a particular instrument session. **vi** is obtained from the niDCPower_InitExtCal or niDCPower_InitializeWithChannels function.' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Indicates date and time of the last calibration.' + }, + 'name': 'month', + 'type': 'datetime.datetime' + } + ], + 'python_name': 'get_ext_cal_last_date_and_time', + 'real_datetime_call': 'GetExtCalLastDateAndTime', + 'returns': 'ViStatus' + }, + 'GetLastRetrievedMeasurement': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'name': 'voltageMeasurements', + 'size': { + 'mechanism': 'TBD', + 'value': 'TBD' + }, + 'type': 'ViReal64[]' + }, + { + 'direction': 'in', + 'name': 'currentMeasurements', + 'size': { + 'mechanism': 'TBD', + 'value': 'TBD' + }, + 'type': 'ViReal64[]' + }, + { + 'direction': 'in', + 'name': 'inCompliance', + 'size': { + 'mechanism': 'TBD', + 'value': 'TBD' + }, + 'type': 'ViBoolean[]' + }, + { + 'direction': 'in', + 'name': 'changeCounter', + 'size': { + 'mechanism': 'TBD', + 'value': 'TBD' + }, + 'type': 'ViUInt64[]' + }, + { + 'direction': 'in', + 'name': 'outputFunction', + 'size': { + 'mechanism': 'TBD', + 'value': 'TBD' + }, + 'type': 'ViInt32[]' + }, + { + 'direction': 'out', + 'name': 'reserved', + 'type': 'void' + } + ], + 'returns': 'ViStatus' + }, + 'GetLastSelfCalLastDateAndTime': { + 'codegen_method': 'python-only', + 'documentation': { + 'description': 'Returns the date and time of the oldest successful self-calibration from among the channels in the session.', + 'note': 'This function is not supported on all devices.' + }, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'datetime_wrappers' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies a particular instrument session. **vi** is obtained from the niDCPower_InitExtCal or niDCPower_InitializeWithChannels function.' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the date and time the device was last calibrated.' + }, + 'name': 'month', + 'type': 'datetime.datetime' + } + ], + 'python_name': 'get_self_cal_last_date_and_time', + 'real_datetime_call': 'GetSelfCalLastDateAndTime', + 'returns': 'ViStatus' + }, + 'GetLiveMeasurements': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'out', + 'name': 'voltageMeasurement', + 'type': 'ViReal64' + }, + { + 'direction': 'out', + 'name': 'currentMeasurement', + 'type': 'ViReal64' + }, + { + 'direction': 'out', + 'name': 'inCompliance', + 'type': 'ViBoolean' + }, + { + 'direction': 'out', + 'name': 'apertureTime', + 'type': 'ViReal64' + }, + { + 'direction': 'out', + 'name': 'reserved', + 'type': 'void' + } + ], + 'returns': 'ViStatus' + }, + 'GetMeasureEngineState': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'out', + 'name': 'measureEngineState', + 'type': 'ViUInt16' + } + ], + 'returns': 'ViStatus' + }, + 'GetNextCoercionRecord': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nReturns the coercion information associated with the IVI session and\nclears the earliest instance in which NI-DCPower coerced a value you\nspecified.\n' + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the number of bytes in the ViChar array you specify for\n**coercionRecord**. If the next coercion record string, including the\nterminating NUL byte, contains more bytes than you indicate in this\nattribute, the function copies (buffer size - 1) bytes into the buffer,\nplaces an ASCII NUL byte at the end of the buffer, and returns the\nbuffer size you must pass to get the entire value. For example, if the\nvalue is 123456 and the buffer size is 4, the function places 123 into\nthe buffer and returns 7.\nIf you pass 0, you can pass VI_NULL for **coercionRecord**.\n' + }, + 'name': 'bufferSize', + 'type': 'ViInt32' + }, + { + 'direction': 'out', + 'documentation': { + 'description': '\nReturns the next **coercionRecord** for the IVI session. If there are no\n**coercionRecords**, the function returns an empty string.\n' + }, + 'name': 'coercionRecord', + 'size': { + 'mechanism': 'ivi-dance', + 'value': 'bufferSize' + }, + 'type': 'ViChar[]' + } + ], + 'returns': 'ViStatus' + }, + 'GetNextInterchangeWarning': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nThis function returns the interchangeability warning associated with the\nIVI session. It retrieves and clears the earliest instance in which the\nclass driver recorded an interchangeability warning. Interchangeability\nwarnings indicate that using your application with a different device\nmay cause a different behavior.\n\nNI-DCPower performs interchangeability checking when the\nNIDCPOWER_ATTR_INTERCHANGE_CHECK attribute is set to VI_TRUE. This\nfunction returns an empty string in warning if no interchangeability\nwarnings remain for the session. In general, NI-DCPower generates\ninterchangeability warnings when an attribute that affects the behavior\nof the device is in a state that you did not specify.\n' + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the number of bytes in the ViChar array you specify for\n**interchangeWarning**. If the next interchangeability warning string,\nincluding the terminating NUL byte, contains more bytes than you\nindicate in this attribute, the function copies (buffer size - 1) bytes\ninto the buffer, places an ASCII NUL byte at the end of the buffer, and\nreturns the buffer size you must pass to get the entire value. For\nexample, if the value is 123456 and the buffer size is 4, the function\nplaces 123 into the buffer and returns 7.\nIf you pass 0, you can pass VI_NULL for **interchangeWarning**.\n' + }, + 'name': 'bufferSize', + 'type': 'ViInt32' }, { 'direction': 'out', - 'name': 'currentMeasurements', - 'type': 'ViReal64[]', -'documentation': { -'description': ''' -Returns an array of current measurements. Ensure that sufficient space -has been allocated for the returned array. -''', -}, + 'documentation': { + 'description': '\nReturns the next interchange warning for the IVI session. If there are\nno interchange warnings, the function returns an empty string.\n' + }, + 'name': 'interchangeWarning', + 'size': { + 'mechanism': 'ivi-dance', + 'value': 'bufferSize' + }, + 'type': 'ViChar[]' + } + ], + 'returns': 'ViStatus' + }, + 'GetOpenSessionsInformation': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'resourceName', + 'type': 'ViRsrc' + }, + { + 'direction': 'in', + 'name': 'infoJson', + 'type': 'ViString' + }, + { + 'direction': 'in', + 'name': 'bufferSize', + 'type': 'ViUInt64' }, { 'direction': 'out', - 'name': 'inCompliance', - 'type': 'ViBoolean[]', -'documentation': { -'description': ''' -Returns an array of Boolean values indicating whether the output was in -compliance at the time the measurement was taken. Ensure that sufficient -space has been allocated for the returned array. -''', -}, + 'name': 'bufferSizeNeededInBytes', + 'type': 'ViUInt64' + } + ], + 'returns': 'ViStatus' + }, + 'GetReservedResourcesForDevice': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'resourceName', + 'type': 'ViRsrc' }, { 'direction': 'out', - 'name': 'actualCount', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Indicates the number of measured values actually retrieved from the -device. -''', -}, - }, - ], -'documentation': { -'description': ''' -Returns an array of voltage measurements, an array of current -measurements, and an array of compliance measurements that were -previously taken and are stored in the NI-DCPower buffer. This function -should not be used when the NIDCPOWER_ATTR_MEASURE_WHEN attribute is -set to NIDCPOWER_VAL_ON_DEMAND. You must first call -niDCPower_Initiate before calling this function. - -Refer to the `Acquiring -Measurements `__ -and `Compliance `__ topics in -the *NI DC Power Supplies and SMUs Help* for more information about -configuring this function. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'name': 'reservedResourcesBitmapsActualSize', + 'type': 'ViUInt32' + }, + { + 'direction': 'in', + 'name': 'reservedResourcesBitmaps', + 'size': { + 'mechanism': 'TBD', + 'value': 'TBD' + }, + 'type': 'ViUInt64[]' + }, + { + 'direction': 'out', + 'name': 'allResourcesReserved', + 'type': 'ViBoolean' + } + ], + 'returns': 'ViStatus' }, - 'GetAttributeViBoolean': { - 'returns': 'ViStatus', + 'GetSelfCalLastDateAndTime': { + 'codegen_method': 'private', + 'documentation': { + 'description': '\nReturns the date and time of the oldest successful self-calibration from\namong the channels in the session.\n\nThe time returned is 24-hour (military) local time; for example, if you\nhave a session using channels 1 and 2, and a self-calibration was\nperformed on channel 1 at 2:30 PM, and a self-calibration was performed\non channel 2 at 3:00 PM on the same day, this function returns 14 for\n**hours** and 30 for **minutes**.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, + 'method_name_for_documentation': 'get_self_cal_last_date_and_time', + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitExtCal or niDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the **year** the device was last calibrated.' + }, + 'name': 'year', + 'type': 'ViInt32' + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the **month** in which the device was last calibrated.' + }, + 'name': 'month', + 'type': 'ViInt32' + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the **day** on which the device was last calibrated.' + }, + 'name': 'day', + 'type': 'ViInt32' + }, + { + 'direction': 'out', + 'documentation': { + 'description': '\nReturns the **hour** (in 24-hour time) in which the device was last\ncalibrated.\n' + }, + 'name': 'hour', + 'type': 'ViInt32' + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the **minute** in which the device was last calibrated.' + }, + 'name': 'minute', + 'type': 'ViInt32' + } + ], + 'returns': 'ViStatus' + }, + 'GetSelfCalLastTemp': { + 'documentation': { + 'description': '\nReturns the onboard temperature of the device, in degrees Celsius,\nduring the oldest successful self-calibration from among the channels in\nthe session.\n\nFor example, if you have a session using channels 1 and 2, and you\nperform a self-calibration on channel 1 with a device temperature of 25\ndegrees Celsius at 2:00, and a self-calibration was performed on channel\n2 at 27 degrees Celsius at 3:00 on the same day, this function returns\n25 for the **temperature** parameter.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitExtCal or niDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'out', + 'documentation': { + 'description': '\nReturns the onboard **temperature** of the device, in degrees Celsius,\nduring the oldest successful calibration.\n' + }, + 'name': 'temperature', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' + }, + 'GetSequenceEngineState': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, + 'type': 'ViConstString' }, + { + 'direction': 'out', + 'name': 'sequencerState', + 'type': 'ViUInt16' + } + ], + 'returns': 'ViStatus' + }, + 'GetSequenceStep': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ { 'direction': 'in', - 'name': 'attributeId', - 'type': 'ViAttr', -'documentation': { -'description': ''' -Specifies the ID of an attribute. From the function panel window, you -can use this control as follows. - -- In the function panel window, click on the control or press **Enter** - or the spacebar to display a dialog box containing hierarchical list - of the available attributes. Help text is shown for each attribute. - Select an attribute by double-clicking on it or by selecting it and - then pressing **Enter**. -- A ring control at the top of the dialog box allows you to see all IVI - attributes or only the attributes of type ViBoolean. If you choose to - see all IVI attributes, the data types appear to the right of the - attribute names in the list box. Attributes with data types other - than ViBoolean are dim. If you select an attribute data type that is - dim, LabWindows/CVI transfers you to the function panel for the - corresponding function that is consistent with the data type. -- If you want to enter a variable name, press **Ctrl**\ +\ **T** to - change this ring control to a manual input box. If the attribute in - this ring control has named constants as valid values, you can view - the constants by moving to the value control and pressing **Enter**. -''', -}, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' }, { 'direction': 'out', - 'name': 'attributeValue', - 'type': 'ViBoolean', -'documentation': { -'description': ''' -Returns the current value of the attribute. Passes the address of a -ViBoolean variable. -If the attribute currently showing in the attribute ring control has -constants as valid values, you can view a list of the constants by -pressing **Enter** on this control. Select a value by double-clicking on -it or by selecting it and then pressing **Enter**. -''', -}, - }, - ], -'documentation': { -'description': ''' -| Queries the value of a ViBoolean attribute. -| You can use this function to get the values of device-specific - attributes and inherent IVI attributes. -''', -}, + 'name': 'stepNumber', + 'type': 'ViUInt32' + }, + { + 'direction': 'out', + 'name': 'hasSequenceStarted', + 'type': 'ViBoolean' + } + ], + 'returns': 'ViStatus' }, - 'GetAttributeViInt32': { + 'GetTriggerState': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'out', + 'name': 'waitingTriggerState', + 'type': 'ViUInt16' + }, + { + 'direction': 'out', + 'name': 'missedTriggerState', + 'type': 'ViUInt16' + } + ], + 'returns': 'ViStatus' + }, + 'GetTriggerStateByName': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'name': 'triggerName', + 'type': 'ViUInt16' + }, + { + 'direction': 'out', + 'name': 'waitingTriggerState', + 'type': 'ViUInt16' + }, + { + 'direction': 'out', + 'name': 'missedTriggerState', + 'type': 'ViUInt16' + } + ], + 'returns': 'ViStatus' + }, + 'ImportAttributeConfigurationBuffer': { + 'documentation': { + 'description': '\nImports an attribute configuration to the session from the specified\nconfiguration buffer.\n\nYou can export and import session attribute configurations only between\ndevices with identical model numbers and the same number of configured\nchannels.\n\n**Support for this Function**\n\nCalling this function in `Sequence Source\nMode `__ is unsupported.\n\n**Channel Mapping Behavior for Multichannel Sessions**\n\nWhen importing and exporting session attribute configurations between\nNI‑DCPower sessions that were initialized with different channels, the\nconfigurations of the exporting channels are mapped to the importing\nchannels in the order you specify in the **channelName** input to the\nniDCPower_InitializeWithChannels function.\n\nFor example, if your entry for **channelName** is 0,1 for the exporting\nsession and 1,2 for the importing session:\n\n- The configuration exported from channel 0 is imported into channel 1.\n- The configuration exported from channel 1 is imported into channel 2.\n\n**Related Topics:**\n\n`Programming\nStates `__\n\n`Using Properties and\nAttributes `__\n\n`Setting Properties and Attributes Before Reading\nThem `__\n', + 'note': '\nThis function will return an error if the total number of channels\ninitialized for the exporting session is not equal to the total number\nof channels initialized for the importing session.\n' + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the size, in bytes, of the byte array to import. If you enter\n0, this function returns the needed size.\n' + }, + 'name': 'size', + 'type': 'ViInt32' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the byte array buffer that contains the attribute\nconfiguration to import.\n' + }, + 'name': 'configuration', + 'size': { + 'mechanism': 'len', + 'value': 'size' + }, + 'type': 'ViInt8[]' + } + ], + 'returns': 'ViStatus' + }, + 'ImportAttributeConfigurationFile': { + 'documentation': { + 'description': '\nImports an attribute configuration to the session from the specified\nfile.\n\nYou can export and import session attribute configurations only between\ndevices with identical model numbers and the same number of configured\nchannels.\n\n**Support for this Function**\n\nCalling this function in `Sequence Source\nMode `__ is unsupported.\n\n**Channel Mapping Behavior for Multichannel Sessions**\n\nWhen importing and exporting session attribute configurations between\nNI‑DCPower sessions that were initialized with different channels, the\nconfigurations of the exporting channels are mapped to the importing\nchannels in the order you specify in the **channelName** input to the\nniDCPower_InitializeWithChannels function.\n\nFor example, if your entry for **channelName** is 0,1 for the exporting\nsession and 1,2 for the importing session:\n\n- The configuration exported from channel 0 is imported into channel 1.\n- The configuration exported from channel 1 is imported into channel 2.\n\n**Related Topics:**\n\n`Programming\nStates `__\n\n`Using Properties and\nAttributes `__\n\n`Setting Properties and Attributes Before Reading\nThem `__\n', + 'note': '\nThis function will return an error if the total number of channels\ninitialized for the exporting session is not equal to the total number\nof channels initialized for the importing session.\n' + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the absolute path to the file containing the attribute\nconfiguration to import. If you specify an empty or relative path, this\nfunction returns an error.\n**Default File Extension:** .nidcpowerconfig\n' + }, + 'name': 'filePath', + 'type': 'ViConstString' + } + ], + 'returns': 'ViStatus' + }, + 'InitExtCal': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nIf **password** is valid, this function creates a new IVI instrument\ndriver session to the device specified in **resourceName** and returns\nan instrument handle you use to identify the device in all subsequent\nNI-DCPower function calls. This function also sends initialization\ncommands to set the device to the state necessary for the operation of\nNI-DCPower.\n\nOpening a calibration session always performs a reset. Refer to the\ncalibration procedure for the device you are calibrating for detailed\ninstructions on the appropriate use of this function. This function uses\nthe `deprecated programming state\nmodel `__.\n' + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the **resourceName** assigned by Measurement & Automation\nExplorer (MAX), for example "PXI1Slot3" where "PXI1Slot3" is an\ninstrument\'s **resourceName**. **resourceName** can also be a logical\nIVI name.\n' + }, + 'name': 'resourceName', + 'type': 'ViRsrc' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the **password** for opening a calibration session. The\ninitial password is factory configured to "NI". **password** can be a\nmaximum of four alphanumeric characters.\n' + }, + 'name': 'password', + 'type': 'ViConstString' + }, + { + 'direction': 'out', + 'documentation': { + 'description': '\nReturns a handle that you use to identify the session in all subsequent\nNI-DCPower function calls.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + } + ], + 'returns': 'ViStatus' + }, + 'InitWithOptions': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nThis function is deprecated. Use niDCPower_InitializeWithChannels\ninstead.\n\nCreates a new IVI instrument driver session to the device specified in\n**resourceName** and returns a session handle you use to identify the\ndevice in all subsequent NI-DCPower function calls. With this function,\nyou can optionally set the initial state of the following session\nattributes:\n\n- NIDCPOWER_ATTR_SIMULATE\n- NIDCPOWER_ATTR_DRIVER_SETUP\n- NIDCPOWER_ATTR_RANGE_CHECK\n- NIDCPOWER_ATTR_QUERY_INSTRUMENT_STATUS\n- NIDCPOWER_ATTR_CACHE\n- NIDCPOWER_ATTR_RECORD_COERCIONS\n\nThis function also sends initialization commands to set the device to\nthe state necessary for NI-DCPower to operate.\n\nTo place the device in a known start-up state when creating a new\nsession, set **resetDevice** to VI_TRUE. This action is equivalent to\nusing the niDCPower_reset function.\n\nTo open a session and leave the device in its existing configuration\nwithout passing through a transitional output state, set **resetDevice**\nto VI_FALSE, and immediately call the niDCPower_Abort function. Then\nconfigure the device as in the previous session changing only the\ndesired settings, and then call the niDCPower_Initiate function.\n\nRefer to the `deprecated programming state\nmodel `__ for\ninformation about the specific software states.\n' + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the **resourceName** assigned by Measurement & Automation\nExplorer (MAX), for example "PXI1Slot3" where "PXI1Slot3" is an\ninstrument\'s **resourceName**. **resourceName** can also be a logical\nIVI name.\n' + }, + 'name': 'resourceName', + 'type': 'ViRsrc' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies whether the device is queried to determine if the device is a\nvalid instrument for NI-DCPower.\n' + }, + 'name': 'idQuery', + 'type': 'ViBoolean' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies whether to reset the device during the initialization\nprocedure.\n' + }, + 'name': 'resetDevice', + 'type': 'ViBoolean' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the initial value of certain attributes for the session. The\nsyntax for **optionString** is a list of attributes with an assigned\nvalue where 1 is VI_TRUE and 0 is VI_FALSE. Each attribute/value\ncombination is delimited with a comma, as shown in the following\nexample:\n\n"Simulate=0,RangeCheck=1,QueryInstrStatus=0,Cache=1"\n\nIf you do not wire this input or pass an empty string, the session\nassigns the default values, shown in the example, for these attributes.\nYou do not have to specify a value for all the attributes. If you do not\nspecify a value for an attribute, the default value is used.\n\nFor more information about simulating a device, refer to `Simulating a\nPower Supply or SMU `__.\n' + }, + 'name': 'optionString', + 'type': 'ViString' + }, + { + 'direction': 'out', + 'documentation': { + 'description': '\nReturns a handle that you use to identify the device in all subsequent\nNI-DCPower function calls.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + } + ], + 'returns': 'ViStatus' + }, + 'InitializeSessionForServer': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'resourceName', + 'type': 'ViRsrc' + }, + { + 'direction': 'in', + 'name': 'idQuery', + 'type': 'ViBoolean' + }, + { + 'direction': 'in', + 'name': 'reset', + 'type': 'ViBoolean' + }, + { + 'direction': 'in', + 'name': 'optionsString', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'name': 'additionalOptions', + 'type': 'ViConstString' + }, + { + 'direction': 'out', + 'name': 'newVi', + 'type': 'ViSession' + } + ], + 'returns': 'ViStatus' + }, + 'InitializeWithChannels': { + 'codegen_method': 'private', + 'documentation': { + 'description': '\nCreates and returns a new NI-DCPower session to the power supply or SMU\nspecified in **resource name** to be used in all subsequent NI-DCPower\nfunction calls. With this function, you can optionally set the initial\nstate of the following session attributes:\n\n- NIDCPOWER_ATTR_SIMULATE\n- NIDCPOWER_ATTR_DRIVER_SETUP\n\nAfter calling this function, the session will be in the Uncommitted\nstate. Refer to the `Programming\nStates `__ topic for\ndetails about specific software states.\n\nTo place the device in a known start-up state when creating a new\nsession, set **reset** to VI_TRUE. This action is equivalent to using\nthe niDCPower_reset function immediately after initializing the\nsession.\n\nTo open a session and leave the device in its existing configuration\nwithout passing through a transitional output state, set **reset** to\nVI_FALSE. Then configure the device as in the previous session,\nchanging only the desired settings, and then call the\nniDCPower_Initiate function.\n\n**Related Topics:**\n\n`Programming\nStates `__\n' + }, + 'method_name_for_documentation': '__init__', + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the **resourceName** assigned by Measurement & Automation\nExplorer (MAX), for example "PXI1Slot3" where "PXI1Slot3" is an\ninstrument\'s **resourceName**. **resourceName** can also be a logical\nIVI name.\n' + }, + 'name': 'resourceName', + 'type': 'ViRsrc' + }, + { + 'default_value': None, + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies which output channel(s) to include in a new session. Specify\nmultiple channels by using a channel list or a channel range. A channel\nlist is a comma (,) separated sequence of channel names (for example,\n0,2 specifies channels 0 and 2). A channel range is a lower bound\nchannel followed by a hyphen (-) or colon (:) followed by an upper bound\nchannel (for example, 0-2 specifies channels 0, 1, and 2). In the\nRunning state, multiple output channel configurations are performed\nsequentially based on the order specified in this parameter. If you do\nnot specify any channels, by default all channels on the device are\nincluded in the session.\n' + }, + 'is_repeated_capability': False, + 'name': 'channels', + 'python_api_converter_name': 'convert_repeated_capabilities_from_init', + 'type': 'ViConstString', + 'type_in_documentation': 'str, list, range, tuple' + }, + { + 'default_value': False, + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies whether to reset the device during the initialization\nprocedure.\n' + }, + 'name': 'reset', + 'type': 'ViBoolean' + }, + { + 'default_value': '""', + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the initial value of certain attributes for the session. The\nsyntax for **optionString** is a list of attributes with an assigned\nvalue where 1 is VI_TRUE and 0 is VI_FALSE. For example:\n\n"Simulate=0"\n\nYou do not have to specify a value for all the attributes. If you do not\nspecify a value for an attribute, the default value is used.\n\nFor more information about simulating a device, refer to `Simulating a\nPower Supply or SMU `__.\n' + }, + 'name': 'optionString', + 'python_api_converter_name': 'convert_init_with_options_dictionary', + 'type': 'ViConstString', + 'type_in_documentation': 'dict' + }, + { + 'direction': 'out', + 'documentation': { + 'description': '\nReturns a session handle that you use to identify the device in all\nsubsequent NI-DCPower function calls.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + } + ], 'returns': 'ViStatus', + 'use_session_lock': False + }, + 'InitializeWithIndependentChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'resourceName', + 'type': 'ViRsrc' + }, + { + 'direction': 'in', + 'name': 'reset', + 'type': 'ViBoolean' + }, + { + 'direction': 'in', + 'name': 'optionString', + 'type': 'ViConstString' + }, + { + 'direction': 'out', + 'name': 'vi', + 'type': 'ViSession' + } + ], + 'returns': 'ViStatus' + }, + 'Initiate': { + 'codegen_method': 'private', + 'documentation': { + 'description': '\nStarts generation or acquisition, causing the NI-DCPower session to\nleave the Uncommitted state or Committed state and enter the Running\nstate. To return to the Committed state call the niDCPower_Abort\nfunction. Refer to the `Programming\nStates `__ topic in\nthe *NI DC Power Supplies and SMUs Help* for information about the\nspecific NI-DCPower software states.\n\n**Related Topics:**\n\n`Programming\nStates `__\n' + }, + 'method_name_for_documentation': 'initiate', + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + } + ], + 'returns': 'ViStatus' + }, + 'InitiateWithChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, - }, + 'type': 'ViConstString' + } + ], + 'returns': 'ViStatus' + }, + 'InvalidateAllAttributes': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ { 'direction': 'in', - 'name': 'attributeId', - 'type': 'ViAttr', -'documentation': { -'description': ''' -Specifies the ID of an attribute. From the function panel window, you -can use this control as follows. - -- In the function panel window, click on the control or press **Enter** - or the spacebar to display a dialog box containing hierarchical list - of the available attributes. Help text is shown for each attribute. - Select an attribute by double-clicking on it or by selecting it and - then pressing **Enter**. -- A ring control at the top of the dialog box allows you to see all IVI - attributes or only the attributes of type ViInt32. If you choose to - see all IVI attributes, the data types appear to the right of the - attribute names in the list box. Attributes with data types other - than ViInt32 are dim. If you select an attribute data type that is - dim, LabWindows/CVI transfers you to the function panel for the - corresponding function that is consistent with the data type. -- If you want to enter a variable name, press **Ctrl**\ +\ **T** to - change this ring control to a manual input box. If the attribute in - this ring control has named constants as valid values, you can view - the constants by moving to the value control and pressing **Enter**. -''', -}, - }, - { - 'direction': 'out', - 'name': 'attributeValue', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Returns the current value of the attribute. Passes the address of a -ViInt32 variable. -If the attribute currently showing in the attribute ring control has -constants as valid values, you can view a list of the constants by -pressing **Enter** on this control. Select a value by double-clicking on -it or by selecting it and then pressing **Enter**. -''', -}, - }, - ], -'documentation': { -'description': ''' -| Queries the value of a ViInt32 attribute. -| You can use this function to get the values of device-specific - attributes and inherent IVI attributes. -''', -}, + 'name': 'vi', + 'type': 'ViSession' + } + ], + 'returns': 'ViStatus' }, - 'GetAttributeViInt64': { - 'returns': 'ViStatus', + 'IviInit': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', - 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'name': 'resourceName', + 'type': 'ViRsrc' }, { 'direction': 'in', - 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, + 'name': 'idQuery', + 'type': 'ViBoolean' }, { 'direction': 'in', - 'name': 'attributeId', - 'type': 'ViAttr', -'documentation': { -'description': ''' -Specifies the ID of an attribute. From the function panel window, you -can use this control as follows. - -- In the function panel window, click on the control or press **Enter** - or the spacebar to display a dialog box containing hierarchical list - of the available attributes. Help text is shown for each attribute. - Select an attribute by double-clicking on it or by selecting it and - then pressing **Enter**. -- A ring control at the top of the dialog box allows you to see all IVI - attributes or only the attributes of type ViReal64. If you choose to - see all IVI attributes, the data types appear to the right of the - attribute names in the list box. Attributes with data types other - than ViReal64 are dim. If you select an attribute data type that is - dim, LabWindows/CVI transfers you to the function panel for the - corresponding function that is consistent with the data type. -- If you want to enter a variable name, press **Ctrl**\ +\ **T** to - change this ring control to a manual input box. If the attribute in - this ring control has named constants as valid values, you can view - the constants by moving to the value control and pressing **Enter**. -''', -}, + 'name': 'reset', + 'type': 'ViBoolean' }, { - 'direction': 'out', - 'name': 'attributeValue', - 'type': 'ViInt64', -'documentation': { -'description': ''' -Returns the current value of the attribute. Passes the address of a -ViReal64 variable. -If the attribute currently showing in the attribute ring control has -constants as valid values, you can view a list of the constants by -pressing **Enter** on this control. Select a value by double-clicking on -it or by selecting it and then pressing **Enter**. -''', -}, - }, - ], -'documentation': { -'description': ''' -| Queries the value of a ViInt64 attribute. -| You can use this function to get the values of device-specific - attributes and inherent IVI attributes. -''', -}, + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + } + ], + 'returns': 'ViStatus' }, - 'GetAttributeViReal64': { - 'returns': 'ViStatus', + 'LockSession': { + 'documentation': { + 'description': '\n| Obtains a multithread lock on the device session. Before doing so, the\n software waits until all other execution threads release their locks\n on the device session.\n| Other threads may have obtained a lock on this session for the\n following reasons:\n\n- The application called the niDCPower_LockSession function.\n- A call to NI-DCPower locked the session.\n- A call to the IVI engine locked the session.\n- After a call to the niDCPower_LockSession function returns\n successfully, no other threads can access the device session until\n you call the niDCPower_UnlockSession function.\n- Use the niDCPower_LockSession function and the\n niDCPower_UnlockSession function around a sequence of calls to\n instrument driver functions if you require that the device retain its\n settings through the end of the sequence.\n\nYou can safely make nested calls to the niDCPower_LockSession function\nwithin the same thread. To completely unlock the session, you must\nbalance each call to the niDCPower_LockSession function with a call to\nthe niDCPower_UnlockSession function. If, however, you use\n**Caller_Has_Lock** in all calls to the niDCPower_LockSession and\nniDCPower_UnlockSession function within a function, the IVI Library\nlocks the session only once within the function regardless of the number\nof calls you make to the niDCPower_LockSession function. This behavior\nallows you to call the niDCPower_UnlockSession function just once at\nthe end of the function.\n' + }, + 'method_templates': [ + { + 'documentation_filename': 'lock', + 'method_python_name_suffix': '', + 'session_filename': 'lock' + } + ], 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, + { + 'direction': 'out', + 'documentation': { + 'description': '\n| This parameter is optional. If you do not want to use this parameter,\n pass VI_NULL.\n| Use this parameter in complex functions to keep track of whether you\n obtain a lock and therefore need to unlock the session. Pass the\n address of a local ViBoolean variable. In the declaration of the local\n variable, initialize it to VI_FALSE. Pass the address of the same\n local variable to any other calls you make to the\n niDCPower_LockSession function or the niDCPower_UnlockSession\n function in the same function.\n| The parameter is an input/output parameter. The niDCPower_LockSession\n and niDCPower_UnlockSession functions each inspect the current value\n and take the following actions.\n\n- If the value is VI_TRUE, the niDCPower_LockSession function does\n not lock the session again.\n- If the value is VI_FALSE, the niDCPower_LockSession function\n obtains the lock and sets the value of the parameter to VI_TRUE.\n- If the value is VI_FALSE, the niDCPower_UnlockSession function does\n not attempt to unlock the session.\n- If the value is VI_TRUE, the niDCPower_UnlockSession function\n releases the lock and sets the value of the parameter to VI_FALSE.\n\n| Thus, you can, call the niDCPower_UnlockSession function at the end\n of your function without worrying about whether you actually have the\n lock, as shown in the following example.\n| ViStatus TestFunc (ViSession vi, ViInt32 flags)\n {\n ViStatus error = VI_SUCCESS;\n ViBoolean haveLock = VI_FALSE;\n if (flags & BIT_1)\n {\n viCheckErr( niDCPower_LockSession(vi, &haveLock;));\n viCheckErr( TakeAction1(vi));\n if (flags & BIT_2)\n {\n viCheckErr( niDCPower_UnlockSession(vi, &haveLock;));\n viCheckErr( TakeAction2(vi));\n viCheckErr( niDCPower_LockSession(vi, &haveLock;);\n }\n if (flags & BIT_3)\n viCheckErr( TakeAction3(vi));\n }\n Error:\n /\\*At this point, you cannot really be sure that you have the lock.\n Fortunately, the haveLock variable takes care of that for you.\\*/\n niDCPower_UnlockSession(vi, &haveLock;);\n return error;\n| }\n' + }, + 'name': 'callerHasLock', + 'type': 'ViBoolean' + } + ], + 'python_name': 'lock', + 'render_in_session_base': True, + 'returns': 'ViStatus', + 'use_session_lock': False + }, + 'LvClose': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ { 'direction': 'in', - 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, + 'name': 'vi', + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'attributeId', - 'type': 'ViAttr', -'documentation': { -'description': ''' -Specifies the ID of an attribute. From the function panel window, you -can use this control as follows. - -- In the function panel window, click on the control or press **Enter** - or the spacebar to display a dialog box containing hierarchical list - of the available attributes. Help text is shown for each attribute. - Select an attribute by double-clicking on it or by selecting it and - then pressing **Enter**. -- A ring control at the top of the dialog box allows you to see all IVI - attributes or only the attributes of type ViReal64. If you choose to - see all IVI attributes, the data types appear to the right of the - attribute names in the list box. Attributes with data types other - than ViReal64 are dim. If you select an attribute data type that is - dim, LabWindows/CVI transfers you to the function panel for the - corresponding function that is consistent with the data type. -- If you want to enter a variable name, press **Ctrl**\ +\ **T** to - change this ring control to a manual input box. If the attribute in - this ring control has named constants as valid values, you can view - the constants by moving to the value control and pressing **Enter**. -''', -}, + 'name': 'errorBufferSize', + 'type': 'ViInt32' }, { 'direction': 'out', - 'name': 'attributeValue', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Returns the current value of the attribute. Passes the address of a -ViReal64 variable. -If the attribute currently showing in the attribute ring control has -constants as valid values, you can view a list of the constants by -pressing **Enter** on this control. Select a value by double-clicking on -it or by selecting it and then pressing **Enter**. -''', -}, - }, - ], -'documentation': { -'description': ''' -| Queries the value of a ViReal64 attribute. -| You can use this function to get the values of device-specific - attributes and inherent IVI attributes. -''', -}, + 'name': 'errorBuffer', + 'size': { + 'mechanism': 'len', + 'value': 'errorBufferSize' + }, + 'type': 'ViChar[]' + } + ], + 'returns': 'ViStatus' }, - 'GetAttributeViSession': { - 'returns': 'ViStatus', + 'LvCloseExtCal': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, + 'name': 'action', + 'type': 'ViInt32' }, { 'direction': 'in', - 'name': 'attributeId', - 'type': 'ViAttr', -'documentation': { -'description': ''' -Specifies the ID of an attribute. From the function panel window, you -can use this control as follows. - -- In the function panel window, click on the control or press **Enter** - or the spacebar to display a dialog box containing hierarchical list - of the available attributes. Help text is shown for each attribute. - Select an attribute by double-clicking on it or by selecting it and - then pressing **Enter**. -- A ring control at the top of the dialog box allows you to see all IVI - attributes or only the attributes of type ViSession. If you choose to - see all IVI attributes, the data types appear to the right of the - attribute names in the list box. Attributes with data types other - than ViSession are dim. If you select an attribute data type that is - dim, LabWindows/CVI transfers you to the function panel for the - corresponding function that is consistent with the data type. -- If you want to enter a variable name, press **Ctrl**\ +\ **T** to - change this ring control to a manual input box. If the attribute in - this ring control has named constants as valid values, you can view - the constants by moving to the value control and pressing **Enter**. -''', -}, + 'name': 'errorBufferSize', + 'type': 'ViInt32' }, { 'direction': 'out', - 'name': 'attributeValue', - 'type': 'ViSession', -'documentation': { -'description': ''' -Returns the current value of the attribute. Passes the address of a -ViSession variable. -If the attribute currently showing in the attribute ring control has -constants as valid values, you can view a list of the constants by -pressing **Enter** on this control. Select a value by double-clicking on -it or by selecting it and then pressing **Enter**. -''', -}, - }, - ], -'documentation': { -'description': ''' -| Queries the value of a ViSession attribute. -| You can use this function to get the values of device-specific - attributes and inherent IVI attributes. -''', -}, + 'name': 'errorBuffer', + 'size': { + 'mechanism': 'len', + 'value': 'errorBufferSize' + }, + 'type': 'ViChar[]' + } + ], + 'returns': 'ViStatus' }, - 'GetAttributeViString': { - 'returns': 'ViStatus', + 'LvInit': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', - 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'name': 'resourceName', + 'type': 'ViRsrc' }, { 'direction': 'in', - 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, + 'name': 'idQuery', + 'type': 'ViBoolean' }, { 'direction': 'in', - 'name': 'attributeId', - 'type': 'ViAttr', -'documentation': { -'description': ''' -Specifies the ID of an attribute. From the function panel window, you -can use this control as follows. - -- In the function panel window, click on the control or press or the - spacebar to display a dialog box containing hierarchical list of the - available attributes. Help text is shown for each attribute. Select - an attribute by double-clicking on it or by selecting it and then - pressing . -- A ring control at the top of the dialog box allows you to see all IVI - attributes or only the attributes of type ViString. If you choose to - see all IVI attributes, the data types appear to the right of the - attribute names in the list box. Attributes with data types other - than ViString are dimmed. If you select an attribute data type that - is dimmed, LabWindows/CVI transfers you to the function panel for the - corresponding function that is consistent with the data type. -- If you want to enter a variable name, press to change this ring - control to a manual input control. If the attribute in this ring - control has named constants as valid values, you can view the - constants by moving to the value control and pressing . -''', -}, + 'name': 'reset', + 'type': 'ViBoolean' + }, + { + 'direction': 'out', + 'name': 'newViPtr', + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'bufferSize', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Passes the number of bytes in the buffer and specifies the number of -bytes in the ViChar array you specify for **value**. If the current -value of **value**, including the terminating NUL byte, is larger than -the size you indicate in this parameter, the function copies (buffer -size - 1) bytes into the buffer, places an ASCII NUL byte at the end of -the buffer, and returns the buffer size you must pass to get the entire -value. For example, if the value is 123456 and the buffer size is 4, the -function places 123 into the buffer and returns 7. -To obtain the required buffer size, you can pass 0 for this attribute -and VI_NULL for **value**. If you want the function to fill in the -buffer regardless of the number of bytes in the value, pass a negative -number for this attribute. -''', -}, + 'name': 'errorBufferSize', + 'type': 'ViInt32' }, { 'direction': 'out', - 'name': 'attributeValue', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -The buffer in which the function returns the current value of the -attribute. The buffer must be of type ViChar and have at least as many -bytes as indicated in **bufSize**. -If the current value of the attribute, including the terminating NUL -byte, contains more bytes that you indicate in this attribute, the -function copies (buffer size -1) bytes into the buffer, places an ASCII -NUL byte at the end of the buffer, and returns the buffer size you must -pass to get the entire value. For example, if the value is 123456 and -the buffer size is 4, the function places 123 into the buffer and -returns 7. -If you specify 0 for **bufSize**, you can pass VI_NULL for this -attribute. -If the attribute currently showing in the attribute ring control has -constants as valid values, you can view a list of the constants by -pressing on this control. Select a value by double-clicking on it or by -selecting it and then pressing . -''', -}, - }, - ], -'documentation': { -'description': ''' -| Queries the value of a ViString attribute. -| You can use this function to get the values of device-specific - attributes and inherent IVI attributes. -''', -}, + 'name': 'errorBuffer', + 'size': { + 'mechanism': 'len', + 'value': 'errorBufferSize' + }, + 'type': 'ViChar[]' + } + ], + 'returns': 'ViStatus' }, - 'GetCalUserDefinedInfo': { - 'returns': 'ViStatus', + 'LvInitExtCal': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', - 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitExtCal or niDCPower_InitializeWithChannels function. -''', -}, + 'name': 'resourceName', + 'type': 'ViRsrc' + }, + { + 'direction': 'in', + 'name': 'password', + 'type': 'ViConstString' }, { 'direction': 'out', - 'name': 'Info', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Returns the user-defined information stored in the device onboard -EEPROM. -''', -}, + 'name': 'newViPtr', + 'type': 'ViSession' }, - ], -'documentation': { -'description': 'Returns the user-defined information in the device onboard EEPROM.', -}, - }, - 'GetCalUserDefinedInfoMaxSize': { - 'returns': 'ViStatus', - 'parameters': [ { 'direction': 'in', - 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitExtCal or niDCPower_InitializeWithChannels function. -''', -}, + 'name': 'errorBufferSize', + 'type': 'ViInt32' }, { 'direction': 'out', - 'name': 'infoSize', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Returns the number of characters that can be stored in the device -onboard EEPROM. -''', -}, - }, + 'name': 'errorBuffer', + 'size': { + 'mechanism': 'len', + 'value': 'errorBufferSize' + }, + 'type': 'ViChar[]' + } ], -'documentation': { -'description': ''' -Returns the maximum number of characters that can be used to store -user-defined information in the device onboard EEPROM. -''', -}, + 'returns': 'ViStatus' }, - 'GetChannelName': { - 'returns': 'ViStatus', + 'LvInitWithOptions': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', - 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'name': 'resourceName', + 'type': 'ViRsrc' }, { 'direction': 'in', - 'name': 'Index', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies which output channel name to return. The index values begin at -1. -''', -}, + 'name': 'idQuery', + 'type': 'ViBoolean' }, { 'direction': 'in', - 'name': 'bufferSize', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the number of bytes in the ViChar array you specify for -**channelName**. If the **channelName**, including the terminating NUL -byte, contains more bytes than you indicate in this attribute, the -function copies (buffer size - 1) bytes into the buffer, places an ASCII -NUL byte at the end of the buffer, and returns the buffer size you must -pass to get the entire value. For example, if the value is 123456 and -the buffer size is 4, the function places 123 into the buffer and -returns 7. -If you pass 0, you can pass VI_NULL for **channelName**. -''', -}, - }, - { - 'direction': 'out', - 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': 'Returns the output channel name that corresponds to **index**.', -}, + 'name': 'reset', + 'type': 'ViBoolean' }, - ], -'documentation': { -'description': ''' -Retrieves the output **channelName** that corresponds to the requested -**index**. Use the NIDCPOWER_ATTR_CHANNEL_COUNT attribute to -determine the upper bound of valid values for **index**. -''', -}, - }, - 'GetError': { - 'returns': 'ViStatus', - 'parameters': [ { 'direction': 'in', - 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'name': 'optionsString', + 'type': 'ViConstString' }, { 'direction': 'out', - 'name': 'Code', - 'type': 'ViStatus', -'documentation': { -'description': 'Returns the error code for the session or execution thread.', -}, + 'name': 'newViPtr', + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'BufferSize', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the number of bytes in the ViChar array you specify for -**description**. -If the error description, including the terminating NUL byte, contains -more bytes than you indicate in this attribute, the function copies -(buffer size - 1) bytes into the buffer, places an ASCII NUL byte at the -end of the buffer, and returns the buffer size you must pass to get the -entire value. For example, if the value is 123456 and the buffer size is -4, the function places 123 into the buffer and returns 7. -If you pass 0 for this attribute, you can pass VI_NULL for -**description**. -''', -}, + 'name': 'errorBufferSize', + 'type': 'ViInt32' }, { 'direction': 'out', - 'name': 'Description', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Returns the error description for the IVI session or execution thread. -If there is no description, the function returns an empty string. -The buffer must contain at least as many elements as the value you -specify with **bufferSize**. If the error description, including the -terminating NUL byte, contains more bytes than you indicate with -**bufferSize**, the function copies (buffer size - 1) bytes into the -buffer, places an ASCII NUL byte at the end of the buffer, and returns -the buffer size you must pass to get the entire value. For example, if -the value is 123456 and the buffer size is 4, the function places 123 -into the buffer and returns 7. -If you pass 0 for **bufferSize**, you can pass VI_NULL for this -attribute. -''', -}, - }, - ], -'documentation': { -'description': ''' -| Retrieves and then clears the IVI error information for the session or - the current execution thread unless **bufferSize** is 0, in which case - the function does not clear the error information. By passing 0 for - the buffer size, you can ascertain the buffer size required to get the - entire error description string and then call the function again with - a sufficiently large buffer size. -| If the user specifies a valid IVI session for **vi**, this function - retrieves and then clears the error information for the session. If - the user passes VI_NULL for **vi**, this function retrieves and then - clears the error information for the current execution thread. If - **vi** is an invalid session, the function does nothing and returns an - error. Normally, the error information describes the first error that - occurred since the user last called niDCPower_GetError or - niDCPower_ClearError. -''', -}, + 'name': 'errorBuffer', + 'size': { + 'mechanism': 'len', + 'value': 'errorBufferSize' + }, + 'type': 'ViChar[]' + } + ], + 'returns': 'ViStatus' }, - 'GetExtCalLastDateAndTime': { - 'returns': 'ViStatus', + 'LvInitializeWithChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', - 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitExtCal or niDCPower_InitializeWithChannels function. -''', -}, - }, - { - 'direction': 'out', - 'name': 'Year', - 'type': 'ViInt32', -'documentation': { -'description': 'Returns the **year** the device was last calibrated.', -}, + 'name': 'resourceName', + 'type': 'ViRsrc' }, { - 'direction': 'out', - 'name': 'Month', - 'type': 'ViInt32', -'documentation': { -'description': 'Returns the **month** in which the device was last calibrated.', -}, + 'direction': 'in', + 'name': 'channels', + 'type': 'ViConstString' }, { - 'direction': 'out', - 'name': 'Day', - 'type': 'ViInt32', -'documentation': { -'description': 'Returns the **day** on which the device was last calibrated.', -}, + 'direction': 'in', + 'name': 'reset', + 'type': 'ViBoolean' }, { - 'direction': 'out', - 'name': 'Hour', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Returns the **hour** (in 24-hour time) in which the device was last -calibrated. -''', -}, + 'direction': 'in', + 'name': 'optionsString', + 'type': 'ViConstString' }, { 'direction': 'out', - 'name': 'Minute', - 'type': 'ViInt32', -'documentation': { -'description': 'Returns the **minute** in which the device was last calibrated.', -}, + 'name': 'newViPtr', + 'type': 'ViSession' }, - ], -'documentation': { -'description': ''' -Returns the date and time of the last successful calibration. The time -returned is 24-hour (military) local time; for example, if the device -was calibrated at 2:30 PM, this function returns 14 for **hours** and 30 -for **minutes**. -''', -}, - }, - 'GetExtCalLastTemp': { - 'returns': 'ViStatus', - 'parameters': [ { 'direction': 'in', - 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitExtCal or niDCPower_InitializeWithChannels function. -''', -}, + 'name': 'errorBufferSize', + 'type': 'ViInt32' }, { 'direction': 'out', - 'name': 'Temperature', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Returns the onboard **temperature** of the device, in degrees Celsius, -during the last successful external calibration. -''', -}, - }, + 'name': 'errorBuffer', + 'size': { + 'mechanism': 'len', + 'value': 'errorBufferSize' + }, + 'type': 'ViChar[]' + } ], -'documentation': { -'description': ''' -Returns the onboard **temperature** of the device, in degrees Celsius, -during the last successful external calibration. -''', -}, + 'returns': 'ViStatus' }, - 'GetExtCalRecommendedInterval': { - 'returns': 'ViStatus', + 'LvInitializeWithIndependentChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', - 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitExtCal or niDCPower_InitializeWithChannels function. -''', -}, + 'name': 'resourceName', + 'type': 'ViRsrc' }, { - 'direction': 'out', - 'name': 'Months', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the recommended maximum interval, in **months**, between -external calibrations. -''', -}, + 'direction': 'in', + 'name': 'reset', + 'type': 'ViBoolean' }, - ], -'documentation': { -'description': ''' -Returns the recommended maximum interval, in **months**, between -external calibrations. -''', -}, - }, - 'GetNextCoercionRecord': { - 'returns': 'ViStatus', - 'parameters': [ { 'direction': 'in', - 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'name': 'optionsString', + 'type': 'ViConstString' + }, + { + 'direction': 'out', + 'name': 'newViPtr', + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'bufferSize', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the number of bytes in the ViChar array you specify for -**coercionRecord**. If the next coercion record string, including the -terminating NUL byte, contains more bytes than you indicate in this -attribute, the function copies (buffer size - 1) bytes into the buffer, -places an ASCII NUL byte at the end of the buffer, and returns the -buffer size you must pass to get the entire value. For example, if the -value is 123456 and the buffer size is 4, the function places 123 into -the buffer and returns 7. -If you pass 0, you can pass VI_NULL for **coercionRecord**. -''', -}, + 'name': 'errorBufferSize', + 'type': 'ViInt32' }, { 'direction': 'out', - 'name': 'coercionRecord', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Returns the next **coercionRecord** for the IVI session. If there are no -**coercionRecords**, the function returns an empty string. -''', -}, - }, - ], -'documentation': { -'description': ''' -Returns the coercion information associated with the IVI session and -clears the earliest instance in which NI-DCPower coerced a value you -specified. -''', -}, + 'name': 'errorBuffer', + 'size': { + 'mechanism': 'len', + 'value': 'errorBufferSize' + }, + 'type': 'ViChar[]' + } + ], + 'returns': 'ViStatus' }, - 'GetNextInterchangeWarning': { - 'returns': 'ViStatus', + 'LvMeasureMultiple': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'bufferSize', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the number of bytes in the ViChar array you specify for -**interchangeWarning**. If the next interchangeability warning string, -including the terminating NUL byte, contains more bytes than you -indicate in this attribute, the function copies (buffer size - 1) bytes -into the buffer, places an ASCII NUL byte at the end of the buffer, and -returns the buffer size you must pass to get the entire value. For -example, if the value is 123456 and the buffer size is 4, the function -places 123 into the buffer and returns 7. -If you pass 0, you can pass VI_NULL for **interchangeWarning**. -''', -}, + 'name': 'channelName', + 'type': 'ViConstString' }, { 'direction': 'out', - 'name': 'interchangeWarning', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Returns the next interchange warning for the IVI session. If there are -no interchange warnings, the function returns an empty string. -''', -}, - }, - ], -'documentation': { -'description': ''' -This function returns the interchangeability warning associated with the -IVI session. It retrieves and clears the earliest instance in which the -class driver recorded an interchangeability warning. Interchangeability -warnings indicate that using your application with a different device -may cause a different behavior. - -NI-DCPower performs interchangeability checking when the -NIDCPOWER_ATTR_INTERCHANGE_CHECK attribute is set to VI_TRUE. This -function returns an empty string in warning if no interchangeability -warnings remain for the session. In general, NI-DCPower generates -interchangeability warnings when an attribute that affects the behavior -of the device is in a state that you did not specify. -''', -}, + 'name': 'voltageMeasurements', + 'type': 'lvdataconv::LVArrayPrimitive*' + }, + { + 'direction': 'out', + 'name': 'currentMeasurements', + 'type': 'lvdataconv::LVArrayPrimitive*' + } + ], + 'returns': 'ViStatus' }, - 'GetSelfCalLastDateAndTime': { - 'returns': 'ViStatus', + 'LvMeasureMultipleWithCompliance': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitExtCal or niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { - 'direction': 'out', - 'name': 'Year', - 'type': 'ViInt32', -'documentation': { -'description': 'Returns the **year** the device was last calibrated.', -}, + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' }, { 'direction': 'out', - 'name': 'Month', - 'type': 'ViInt32', -'documentation': { -'description': 'Returns the **month** in which the device was last calibrated.', -}, + 'name': 'voltageMeasurements', + 'type': 'lvdataconv::LVArrayPrimitive*' }, { 'direction': 'out', - 'name': 'Day', - 'type': 'ViInt32', -'documentation': { -'description': 'Returns the **day** on which the device was last calibrated.', -}, + 'name': 'currentMeasurements', + 'type': 'lvdataconv::LVArrayPrimitive*' }, { 'direction': 'out', - 'name': 'Hour', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Returns the **hour** (in 24-hour time) in which the device was last -calibrated. -''', -}, + 'name': 'inCompliance', + 'type': 'lvdataconv::LVArrayPrimitive*' }, { - 'direction': 'out', - 'name': 'Minute', - 'type': 'ViInt32', -'documentation': { -'description': 'Returns the **minute** in which the device was last calibrated.', -}, - }, - ], -'documentation': { -'description': ''' -Returns the date and time of the oldest successful self-calibration from -among the channels in the session. - -The time returned is 24-hour (military) local time; for example, if you -have a session using channels 1 and 2, and a self-calibration was -performed on channel 1 at 2:30 PM, and a self-calibration was performed -on channel 2 at 3:00 PM on the same day, this function returns 14 for -**hours** and 30 for **minutes**. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'direction': 'in', + 'name': 'retrieveFromCache', + 'type': 'ViBoolean' + } + ], + 'returns': None }, - 'GetSelfCalLastTemp': { - 'returns': 'ViStatus', + 'Measure': { + 'documentation': { + 'description': '\nReturns the measured value of either the voltage or current on the\nspecified output channel. Each call to this function blocks other\nfunction calls until the hardware returns the **measurement**. To\nmeasure multiple output channels, use the niDCPower_MeasureMultiple\nfunction.\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitExtCal or niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel to measure. Only one measurement at a time\nmay be made with the niDCPower_Measure function. Use the\nniDCPower_MeasureMultiple function to measure multiple channels.\n' + }, + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies whether a voltage or current value is measured.\n**Defined Values**:\n', + 'table_body': [ + [ + 'NIDCPOWER_VAL_MEASURE_VOLTAGE (1)', + 'The device measures voltage.' + ], + [ + 'NIDCPOWER_VAL_MEASURE_CURRENT (0)', + 'The device measures current.' + ] + ] + }, + 'enum': 'MeasurementTypes', + 'name': 'measurementType', + 'type': 'ViInt32' }, { 'direction': 'out', - 'name': 'Temperature', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Returns the onboard **temperature** of the device, in degrees Celsius, -during the oldest successful calibration. -''', -}, - }, - ], -'documentation': { -'description': ''' -Returns the onboard temperature of the device, in degrees Celsius, -during the oldest successful self-calibration from among the channels in -the session. - -For example, if you have a session using channels 1 and 2, and you -perform a self-calibration on channel 1 with a device temperature of 25 -degrees Celsius at 2:00, and a self-calibration was performed on channel -2 at 27 degrees Celsius at 3:00 on the same day, this function returns -25 for the **temperature** parameter. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'documentation': { + 'description': '\nReturns the value of the measurement, either in volts for voltage or\namps for current.\n' + }, + 'name': 'measurement', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, - 'ImportAttributeConfigurationBuffer': { - 'returns': 'ViStatus', + 'MeasureMultiple': { + 'codegen_method': 'private', + 'documentation': { + 'description': '\nReturns arrays of the measured voltage and current values on the\nspecified output channel(s). Each call to this function blocks other\nfunction calls until the measurements are returned from the device. The\norder of the measurements returned in the array corresponds to the order\non the specified output channel(s).\n' + }, + 'method_name_for_documentation': 'measure_multiple', 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'Size', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the size, in bytes, of the byte array to import. If you enter -0, this function returns the needed size. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Configuration', - 'type': 'ViAddr', -'documentation': { -'description': ''' -Specifies the byte array buffer that contains the attribute -configuration to import. -''', -}, - }, - ], -'documentation': { -'description': ''' -Imports an attribute configuration to the session from the specified -configuration buffer. - -You can export and import session attribute configurations only between -devices with identical model numbers and the same number of configured -channels. - -**Support for this Function** - -Calling this function in `Sequence Source -Mode `__ is unsupported. - -**Channel Mapping Behavior for Multichannel Sessions** - -When importing and exporting session attribute configurations between -NI‑DCPower sessions that were initialized with different channels, the -configurations of the exporting channels are mapped to the importing -channels in the order you specify in the **channelName** input to the -niDCPower_InitializeWithChannels function. - -For example, if your entry for **channelName** is 0,1 for the exporting -session and 1,2 for the importing session: - -- The configuration exported from channel 0 is imported into channel 1. -- The configuration exported from channel 1 is imported into channel 2. - -**Related Topics:** - -`Programming -States `__ - -`Using Properties and -Attributes `__ - -`Setting Properties and Attributes Before Reading -Them `__ -''', -'note': ''' -This function will return an error if the total number of channels -initialized for the exporting session is not equal to the total number -of channels initialized for the importing session. -''', -}, + 'documentation': { + 'description': '\nSpecifies the output channels to measure. You can specify multiple\nchannels by using a channel list or a channel range. A channel list is a\ncomma (,) separated sequence of channel names (e.g. 0,2 specifies\nchannels 0 and 2). A channel range is a lower bound channel followed by\na hyphen (-) or colon (:) followed by an upper bound channel (e.g. 0-2\nspecifies channels 0, 1, and 2). If you do not specify a channel name,\nthe function uses all channels in the session.\n' + }, + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'out', + 'documentation': { + 'description': '\nReturns an array of voltage measurements. The measurements in the array\nare returned in the same order as the channels specified in\n**channelName**. Ensure that sufficient space has been allocated for the\nreturned array.\n' + }, + 'name': 'voltageMeasurements', + 'size': { + 'mechanism': 'python-code', + 'value': 'self._parse_channel_count()' + }, + 'type': 'ViReal64[]', + 'use_array': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': '\nReturns an array of current measurements. The measurements in the array\nare returned in the same order as the channels specified in\n**channelName**. Ensure that sufficient space has been allocated for the\nreturned array.\n' + }, + 'name': 'currentMeasurements', + 'size': { + 'mechanism': 'python-code', + 'value': 'self._parse_channel_count()' + }, + 'type': 'ViReal64[]', + 'use_array': True + } + ], + 'returns': 'ViStatus' }, - 'ImportAttributeConfigurationFile': { - 'returns': 'ViStatus', + 'MeasureMultipleWithCompliance': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'filePath', - 'type': 'ViConstString', -'documentation': { -'description': ''' -Specifies the absolute path to the file containing the attribute -configuration to import. If you specify an empty or relative path, this -function returns an error. -**Default File Extension:** .nidcpowerconfig -''', -}, - }, - ], -'documentation': { -'description': ''' -Imports an attribute configuration to the session from the specified -file. - -You can export and import session attribute configurations only between -devices with identical model numbers and the same number of configured -channels. - -**Support for this Function** - -Calling this function in `Sequence Source -Mode `__ is unsupported. - -**Channel Mapping Behavior for Multichannel Sessions** - -When importing and exporting session attribute configurations between -NI‑DCPower sessions that were initialized with different channels, the -configurations of the exporting channels are mapped to the importing -channels in the order you specify in the **channelName** input to the -niDCPower_InitializeWithChannels function. - -For example, if your entry for **channelName** is 0,1 for the exporting -session and 1,2 for the importing session: - -- The configuration exported from channel 0 is imported into channel 1. -- The configuration exported from channel 1 is imported into channel 2. - -**Related Topics:** - -`Programming -States `__ - -`Using Properties and -Attributes `__ - -`Setting Properties and Attributes Before Reading -Them `__ -''', -'note': ''' -This function will return an error if the total number of channels -initialized for the exporting session is not equal to the total number -of channels initialized for the importing session. -''', -}, - }, - 'InitExtCal': { - 'returns': 'ViStatus', - 'parameters': [ + 'name': 'channelName', + 'type': 'ViConstString' + }, { 'direction': 'in', - 'name': 'resourceName', - 'type': 'ViRsrc', -'documentation': { -'description': ''' -Specifies the **resourceName** assigned by Measurement & Automation -Explorer (MAX), for example "PXI1Slot3" where "PXI1Slot3" is an -instrument's **resourceName**. **resourceName** can also be a logical -IVI name. -''', -}, + 'name': 'voltageMeasurements', + 'size': { + 'mechanism': 'TBD', + 'value': 'TBD' + }, + 'type': 'ViReal64[]' }, { 'direction': 'in', - 'name': 'Password', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the **password** for opening a calibration session. The -initial password is factory configured to "NI". **password** can be a -maximum of four alphanumeric characters. -''', -}, + 'name': 'currentMeasurements', + 'size': { + 'mechanism': 'TBD', + 'value': 'TBD' + }, + 'type': 'ViReal64[]' }, - { - 'direction': 'out', - 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Returns a handle that you use to identify the session in all subsequent -NI-DCPower function calls. -''', -}, - }, - ], -'documentation': { -'description': ''' -If **password** is valid, this function creates a new IVI instrument -driver session to the device specified in **resourceName** and returns -an instrument handle you use to identify the device in all subsequent -NI-DCPower function calls. This function also sends initialization -commands to set the device to the state necessary for the operation of -NI-DCPower. - -Opening a calibration session always performs a reset. Refer to the -calibration procedure for the device you are calibrating for detailed -instructions on the appropriate use of this function. This function uses -the `deprecated programming state -model `__. -''', -}, - }, - 'InitWithOptions': { - 'returns': 'ViStatus', - 'parameters': [ { 'direction': 'in', - 'name': 'resourceName', - 'type': 'ViRsrc', -'documentation': { -'description': ''' -Specifies the **resourceName** assigned by Measurement & Automation -Explorer (MAX), for example "PXI1Slot3" where "PXI1Slot3" is an -instrument's **resourceName**. **resourceName** can also be a logical -IVI name. -''', -}, + 'name': 'inCompliance', + 'size': { + 'mechanism': 'TBD', + 'value': 'TBD' + }, + 'type': 'ViBoolean[]' }, { 'direction': 'in', - 'name': 'idQuery', - 'type': 'ViBoolean', -'documentation': { -'description': ''' -Specifies whether the device is queried to determine if the device is a -valid instrument for NI-DCPower. -''', -}, - }, + 'name': 'retrieveFromCache', + 'type': 'ViBoolean' + } + ], + 'returns': 'ViStatus' + }, + 'ParseChannelCount': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Returns the number of channels.' + }, + 'parameters': [ { 'direction': 'in', - 'name': 'resetDevice', - 'type': 'ViBoolean', -'documentation': { -'description': ''' -Specifies whether to reset the device during the initialization -procedure. -''', -}, + 'name': 'vi', + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'optionString', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the initial value of certain attributes for the session. The -syntax for **optionString** is a list of attributes with an assigned -value where 1 is VI_TRUE and 0 is VI_FALSE. Each attribute/value -combination is delimited with a comma, as shown in the following -example: - -"Simulate=0,RangeCheck=1,QueryInstrStatus=0,Cache=1" - -If you do not wire this input or pass an empty string, the session -assigns the default values, shown in the example, for these attributes. -You do not have to specify a value for all the attributes. If you do not -specify a value for an attribute, the default value is used. - -For more information about simulating a device, refer to `Simulating a -Power Supply or SMU `__. -''', -}, + 'name': 'channelsString', + 'type': 'ViConstString' }, { 'direction': 'out', - 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Returns a handle that you use to identify the device in all subsequent -NI-DCPower function calls. -''', -}, - }, - ], -'documentation': { -'description': ''' -This function is deprecated. Use niDCPower_InitializeWithChannels -instead. - -Creates a new IVI instrument driver session to the device specified in -**resourceName** and returns a session handle you use to identify the -device in all subsequent NI-DCPower function calls. With this function, -you can optionally set the initial state of the following session -attributes: - -- NIDCPOWER_ATTR_SIMULATE -- NIDCPOWER_ATTR_DRIVER_SETUP -- NIDCPOWER_ATTR_RANGE_CHECK -- NIDCPOWER_ATTR_QUERY_INSTRUMENT_STATUS -- NIDCPOWER_ATTR_CACHE -- NIDCPOWER_ATTR_RECORD_COERCIONS - -This function also sends initialization commands to set the device to -the state necessary for NI-DCPower to operate. - -To place the device in a known start-up state when creating a new -session, set **resetDevice** to VI_TRUE. This action is equivalent to -using the niDCPower_reset function. - -To open a session and leave the device in its existing configuration -without passing through a transitional output state, set **resetDevice** -to VI_FALSE, and immediately call the niDCPower_Abort function. Then -configure the device as in the previous session changing only the -desired settings, and then call the niDCPower_Initiate function. - -Refer to the `deprecated programming state -model `__ for -information about the specific software states. -''', -}, + 'name': 'numberOfChannels', + 'type': 'ViUInt32' + } + ], + 'returns': 'ViStatus' }, - 'InitializeWithChannels': { - 'returns': 'ViStatus', + 'QueryInCompliance': { + 'documentation': { + 'description': '\nQueries the specified output device to determine if it is operating at\nthe `compliance `__ limit.\n\nThe compliance limit is the current limit when the output function is\nset to NIDCPOWER_VAL_DC_VOLTAGE. If the output is operating at the\ncompliance limit, the output reaches the current limit before the\ndesired voltage level. Refer to the niDCPower_ConfigureOutputFunction\nfunction and the niDCPower_ConfigureCurrentLimit function for more\ninformation about output function and current limit, respectively.\n\nThe compliance limit is the voltage limit when the output function is\nset to NIDCPOWER_VAL_DC_CURRENT. If the output is operating at the\ncompliance limit, the output reaches the voltage limit before the\ndesired current level. Refer to the niDCPower_ConfigureOutputFunction\nfunction and the niDCPower_ConfigureVoltageLimit function for more\ninformation about output function and voltage limit, respectively.\n\n**Related Topics:**\n\n`Compliance `__\n' + }, 'parameters': [ { 'direction': 'in', - 'name': 'resourceName', - 'type': 'ViRsrc', -'documentation': { -'description': ''' -Specifies the **resourceName** assigned by Measurement & Automation -Explorer (MAX), for example "PXI1Slot3" where "PXI1Slot3" is an -instrument's **resourceName**. **resourceName** can also be a logical -IVI name. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Channels', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies which output channel(s) to include in a new session. Specify -multiple channels by using a channel list or a channel range. A channel -list is a comma (,) separated sequence of channel names (for example, -0,2 specifies channels 0 and 2). A channel range is a lower bound -channel followed by a hyphen (-) or colon (:) followed by an upper bound -channel (for example, 0-2 specifies channels 0, 1, and 2). In the -Running state, multiple output channel configurations are performed -sequentially based on the order specified in this parameter. If you do -not specify any channels, by default all channels on the device are -included in the session. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Reset', - 'type': 'ViBoolean', -'documentation': { -'description': ''' -Specifies whether to reset the device during the initialization -procedure. -''', -}, + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'optionString', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the initial value of certain attributes for the session. The -syntax for **optionString** is a list of attributes with an assigned -value where 1 is VI_TRUE and 0 is VI_FALSE. For example: - -"Simulate=0" - -You do not have to specify a value for all the attributes. If you do not -specify a value for an attribute, the default value is used. - -For more information about simulating a device, refer to `Simulating a -Power Supply or SMU `__. -''', -}, + 'documentation': { + 'description': '\nSpecifies the output channel to query. Compliance status can only be\nqueried for one channel at a time.\n' + }, + 'name': 'channelName', + 'type': 'ViConstString' }, { 'direction': 'out', - 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Returns a session handle that you use to identify the device in all -subsequent NI-DCPower function calls. -''', -}, - }, - ], -'documentation': { -'description': ''' -Creates and returns a new NI-DCPower session to the power supply or SMU -specified in **resource name** to be used in all subsequent NI-DCPower -function calls. With this function, you can optionally set the initial -state of the following session attributes: - -- NIDCPOWER_ATTR_SIMULATE -- NIDCPOWER_ATTR_DRIVER_SETUP - -After calling this function, the session will be in the Uncommitted -state. Refer to the `Programming -States `__ topic for -details about specific software states. - -To place the device in a known start-up state when creating a new -session, set **reset** to VI_TRUE. This action is equivalent to using -the niDCPower_reset function immediately after initializing the -session. - -To open a session and leave the device in its existing configuration -without passing through a transitional output state, set **reset** to -VI_FALSE. Then configure the device as in the previous session, -changing only the desired settings, and then call the -niDCPower_Initiate function. - -**Related Topics:** - -`Programming -States `__ -''', -}, + 'documentation': { + 'description': 'Returns whether the device output channel is in compliance.' + }, + 'name': 'inCompliance', + 'type': 'ViBoolean' + } + ], + 'returns': 'ViStatus' }, - 'Initiate': { - 'returns': 'ViStatus', + 'QueryMaxCurrentLimit': { + 'documentation': { + 'description': '\nQueries the maximum current limit on an output channel if the output\nchannel is set to the specified **voltageLevel**.\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, - ], -'documentation': { -'description': ''' -Starts generation or acquisition, causing the NI-DCPower session to -leave the Uncommitted state or Committed state and enter the Running -state. To return to the Committed state call the niDCPower_Abort -function. Refer to the `Programming -States `__ topic in -the *NI DC Power Supplies and SMUs Help* for information about the -specific NI-DCPower software states. - -**Related Topics:** - -`Programming -States `__ -''', -}, - }, - 'LockSession': { - 'returns': 'ViStatus', - 'parameters': [ { 'direction': 'in', - 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'documentation': { + 'description': '\nSpecifies the output channel to query. The maximum current limit may\nonly be queried for one channel at a time.\n' + }, + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the voltage level to use when calculating the\n**maxCurrentLimit**.\n' + }, + 'name': 'voltageLevel', + 'type': 'ViReal64' }, { 'direction': 'out', - 'name': 'callerHasLock', - 'type': 'ViBoolean', -'documentation': { -'description': ''' -| This parameter is optional. If you do not want to use this parameter, - pass VI_NULL. -| Use this parameter in complex functions to keep track of whether you - obtain a lock and therefore need to unlock the session. Pass the - address of a local ViBoolean variable. In the declaration of the local - variable, initialize it to VI_FALSE. Pass the address of the same - local variable to any other calls you make to the - niDCPower_LockSession function or the niDCPower_UnlockSession - function in the same function. -| The parameter is an input/output parameter. The niDCPower_LockSession - and niDCPower_UnlockSession functions each inspect the current value - and take the following actions. - -- If the value is VI_TRUE, the niDCPower_LockSession function does - not lock the session again. -- If the value is VI_FALSE, the niDCPower_LockSession function - obtains the lock and sets the value of the parameter to VI_TRUE. -- If the value is VI_FALSE, the niDCPower_UnlockSession function does - not attempt to unlock the session. -- If the value is VI_TRUE, the niDCPower_UnlockSession function - releases the lock and sets the value of the parameter to VI_FALSE. - -| Thus, you can, call the niDCPower_UnlockSession function at the end - of your function without worrying about whether you actually have the - lock, as shown in the following example. -| ViStatus TestFunc (ViSession vi, ViInt32 flags) - { - ViStatus error = VI_SUCCESS; - ViBoolean haveLock = VI_FALSE; - if (flags & BIT_1) - { - viCheckErr( niDCPower_LockSession(vi, &haveLock;)); - viCheckErr( TakeAction1(vi)); - if (flags & BIT_2) - { - viCheckErr( niDCPower_UnlockSession(vi, &haveLock;)); - viCheckErr( TakeAction2(vi)); - viCheckErr( niDCPower_LockSession(vi, &haveLock;); - } - if (flags & BIT_3) - viCheckErr( TakeAction3(vi)); - } - Error: - /\*At this point, you cannot really be sure that you have the lock. - Fortunately, the haveLock variable takes care of that for you.\*/ - niDCPower_UnlockSession(vi, &haveLock;); - return error; -| } -''', -}, - }, - ], -'documentation': { -'description': ''' -| 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 niDCPower_LockSession function. -- A call to NI-DCPower locked the session. -- A call to the IVI engine locked the session. -- After a call to the niDCPower_LockSession function returns - successfully, no other threads can access the device session until - you call the niDCPower_UnlockSession function. -- Use the niDCPower_LockSession function and the - niDCPower_UnlockSession function around a sequence of calls to - instrument driver functions if you require that the device retain its - settings through the end of the sequence. - -You can safely make nested calls to the niDCPower_LockSession function -within the same thread. To completely unlock the session, you must -balance each call to the niDCPower_LockSession function with a call to -the niDCPower_UnlockSession function. If, however, you use -**Caller_Has_Lock** in all calls to the niDCPower_LockSession and -niDCPower_UnlockSession function within a function, the IVI Library -locks the session only once within the function regardless of the number -of calls you make to the niDCPower_LockSession function. This behavior -allows you to call the niDCPower_UnlockSession function just once at -the end of the function. -''', -}, + 'documentation': { + 'description': '\nReturns the maximum current limit that can be set with the specified\n**voltageLevel**.\n' + }, + 'name': 'maxCurrentLimit', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, - 'Measure': { - 'returns': 'ViStatus', + 'QueryMaxVoltageLevel': { + 'documentation': { + 'description': '\nQueries the maximum voltage level on an output channel if the output\nchannel is set to the specified **currentLimit**.\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel to query. The maximum voltage level may\nonly be queried for one channel at a time.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel to measure. Only one measurement at a time -may be made with the niDCPower_Measure function. Use the -niDCPower_MeasureMultiple function to measure multiple channels. -''', -}, + 'type': 'ViConstString' }, { 'direction': 'in', - 'name': 'measurementType', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies whether a voltage or current value is measured. -**Defined Values**: -''', -'table_body': [['NIDCPOWER_VAL_MEASURE_VOLTAGE (1)', 'The device measures voltage.'], ['NIDCPOWER_VAL_MEASURE_CURRENT (0)', 'The device measures current.']], -}, + 'documentation': { + 'description': '\nSpecifies the current limit to use when calculating the\n**maxVoltageLevel**.\n' + }, + 'name': 'currentLimit', + 'type': 'ViReal64' }, { 'direction': 'out', - 'name': 'Measurement', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Returns the value of the measurement, either in volts for voltage or -amps for current. -''', -}, - }, - ], -'documentation': { -'description': ''' -Returns the measured value of either the voltage or current on the -specified output channel. Each call to this function blocks other -function calls until the hardware returns the **measurement**. To -measure multiple output channels, use the niDCPower_MeasureMultiple -function. -''', -}, + 'documentation': { + 'description': '\nReturns the maximum voltage level that can be set on an output channel\nwith the specified **currentLimit**.\n' + }, + 'name': 'maxVoltageLevel', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, - 'MeasureMultiple': { - 'returns': 'ViStatus', + 'QueryMinCurrentLimit': { + 'documentation': { + 'description': '\nQueries the minimum current limit on an output channel if the output\nchannel is set to the specified **voltageLevel**.\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel to query. The minimum current limit may\nonly be queried for one channel at a time.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channels to measure. You can specify multiple -channels by using a channel list or a channel range. A channel list is a -comma (,) separated sequence of channel names (e.g. 0,2 specifies -channels 0 and 2). A channel range is a lower bound channel followed by -a hyphen (-) or colon (:) followed by an upper bound channel (e.g. 0-2 -specifies channels 0, 1, and 2). If you do not specify a channel name, -the function uses all channels in the session. -''', -}, + 'type': 'ViConstString' }, { - 'direction': 'out', - 'name': 'voltageMeasurements', - 'type': 'ViReal64[]', -'documentation': { -'description': ''' -Returns an array of voltage measurements. The measurements in the array -are returned in the same order as the channels specified in -**channelName**. Ensure that sufficient space has been allocated for the -returned array. -''', -}, + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the voltage level to use when calculating the\n**minCurrentLimit**.\n' + }, + 'name': 'voltageLevel', + 'type': 'ViReal64' }, { 'direction': 'out', - 'name': 'currentMeasurements', - 'type': 'ViReal64[]', -'documentation': { -'description': ''' -Returns an array of current measurements. The measurements in the array -are returned in the same order as the channels specified in -**channelName**. Ensure that sufficient space has been allocated for the -returned array. -''', -}, - }, - ], -'documentation': { -'description': ''' -Returns arrays of the measured voltage and current values on the -specified output channel(s). Each call to this function blocks other -function calls until the measurements are returned from the device. The -order of the measurements returned in the array corresponds to the order -on the specified output channel(s). -''', -}, + 'documentation': { + 'description': '\nReturns the minimum current limit that can be set on an output channel\nwith the specified **voltageLevel**.\n' + }, + 'name': 'minCurrentLimit', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, - 'QueryInCompliance': { - 'returns': 'ViStatus', + 'QueryOutputState': { + 'documentation': { + 'description': '\nQueries the specified output channel to determine if the output channel\nis currently in the state specified by **outputState**.\n\n**Related Topics:**\n\n`Compliance `__\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel to query. The output state may only be\nqueried for one channel at a time.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel to query. Compliance status can only be -queried for one channel at a time. -''', -}, + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output state of the output channel that is being queried.\n**Defined Values**:\n', + 'table_body': [ + [ + 'NIDCPOWER_VAL_OUTPUT_CONSTANT_VOLTAGE (0)', + 'The device maintains a constant voltage by adjusting the current.' + ], + [ + 'NIDCPOWER_VAL_OUTPUT_CONSTANT_CURRENT (1)', + 'The device maintains a constant current by adjusting the voltage.' + ] + ] + }, + 'enum': 'OutputStates', + 'name': 'outputState', + 'type': 'ViInt32' }, { 'direction': 'out', - 'name': 'inCompliance', - 'type': 'ViBoolean', -'documentation': { -'description': 'Returns whether the device output channel is in compliance.', -}, - }, - ], -'documentation': { -'description': ''' -Queries the specified output device to determine if it is operating at -the `compliance `__ limit. - -The compliance limit is the current limit when the output function is -set to NIDCPOWER_VAL_DC_VOLTAGE. If the output is operating at the -compliance limit, the output reaches the current limit before the -desired voltage level. Refer to the niDCPower_ConfigureOutputFunction -function and the niDCPower_ConfigureCurrentLimit function for more -information about output function and current limit, respectively. - -The compliance limit is the voltage limit when the output function is -set to NIDCPOWER_VAL_DC_CURRENT. If the output is operating at the -compliance limit, the output reaches the voltage limit before the -desired current level. Refer to the niDCPower_ConfigureOutputFunction -function and the niDCPower_ConfigureVoltageLimit function for more -information about output function and voltage limit, respectively. - -**Related Topics:** - -`Compliance `__ -''', -}, + 'documentation': { + 'description': '\nReturns whether the device output channel is in the specified output\nstate.\n' + }, + 'name': 'inState', + 'type': 'ViBoolean' + } + ], + 'returns': 'ViStatus' }, - 'QueryMaxCurrentLimit': { - 'returns': 'ViStatus', + 'ReadCurrentTemperature': { + 'documentation': { + 'description': '\nReturns the current onboard **temperature**, in degrees Celsius, of the\ndevice.\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitExtCal or niDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the onboard **temperature**, in degrees Celsius, of the device.' + }, + 'name': 'temperature', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' + }, + 'ReadFlashEepromBlock': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ { 'direction': 'in', - 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel to query. The maximum current limit may -only be queried for one channel at a time. -''', -}, + 'name': 'vi', + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'voltageLevel', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the voltage level to use when calculating the -**maxCurrentLimit**. -''', -}, + 'name': 'address', + 'type': 'ViUInt32' }, { - 'direction': 'out', - 'name': 'maxCurrentLimit', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Returns the maximum current limit that can be set with the specified -**voltageLevel**. -''', -}, + 'direction': 'in', + 'name': 'size', + 'type': 'ViUInt32' }, + { + 'direction': 'in', + 'name': 'data', + 'size': { + 'mechanism': 'TBD', + 'value': 'TBD' + }, + 'type': 'ViUInt8[]' + } ], -'documentation': { -'description': ''' -Queries the maximum current limit on an output channel if the output -channel is set to the specified **voltageLevel**. -''', -}, + 'returns': 'ViStatus' }, - 'QueryMaxVoltageLevel': { - 'returns': 'ViStatus', + 'ReadRegister': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel to query. The maximum voltage level may -only be queried for one channel at a time. -''', -}, + 'name': 'registerSize', + 'type': 'ViUInt16' }, { 'direction': 'in', - 'name': 'currentLimit', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the current limit to use when calculating the -**maxVoltageLevel**. -''', -}, + 'name': 'offset', + 'type': 'ViUInt16' }, { 'direction': 'out', - 'name': 'maxVoltageLevel', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Returns the maximum voltage level that can be set on an output channel -with the specified **currentLimit**. -''', -}, - }, + 'name': 'value', + 'type': 'ViUInt16' + } ], -'documentation': { -'description': ''' -Queries the maximum voltage level on an output channel if the output -channel is set to the specified **currentLimit**. -''', -}, + 'returns': 'ViStatus' }, - 'QueryMinCurrentLimit': { - 'returns': 'ViStatus', + 'ReleaseSessionForServer': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, - }, + 'type': 'ViSession' + } + ], + 'returns': 'ViStatus' + }, + 'RequestPrivilege': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ { 'direction': 'in', - 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel to query. The minimum current limit may -only be queried for one channel at a time. -''', -}, + 'name': 'vi', + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'voltageLevel', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the voltage level to use when calculating the -**minCurrentLimit**. -''', -}, - }, + 'name': 'privilegeLevel', + 'type': 'ViInt32' + } + ], + 'returns': 'ViStatus' + }, + 'ResetDevice': { + 'documentation': { + 'description': '\nResets the device to a known state. The function disables power\ngeneration, resets session attributes to their default values, clears\nerrors such as overtemperature and unexpected loss of auxiliary power,\ncommits the session attributes, and leaves the session in the\nUncommitted state. This function also performs a hard reset on the\ndevice and driver software. This function has the same functionality as\nusing reset in Measurement & Automation Explorer. Refer to the\n`Programming\nStates `__ topic for\nmore information about NI-DCPower software states.\n\nThis will also open the output relay on devices that have an output\nrelay.\n' + }, + 'parameters': [ { - 'direction': 'out', - 'name': 'minCurrentLimit', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Returns the minimum current limit that can be set on an output channel -with the specified **voltageLevel**. -''', -}, - }, + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + } ], -'documentation': { -'description': ''' -Queries the minimum current limit on an output channel if the output -channel is set to the specified **voltageLevel**. -''', -}, + 'returns': 'ViStatus' }, - 'QueryOutputState': { - 'returns': 'ViStatus', + 'ResetInterchangeCheck': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nWhen developing a complex test system that consists of multiple test\nmodules, it is generally a good idea to design the test modules so that\nthey can run in any order. To do so requires ensuring that each test\nmodule completely configures the state of each instrument it uses. If a\nparticular test module does not completely configure the state of an\ninstrument, the state of the instrument depends on the configuration\nfrom a previously executed test module. If you execute the test modules\nin a different order, the behavior of the instrument and therefore the\nentire test module is likely to change. This change in behavior is\ngenerally instrument specific and represents an interchangeability\nproblem.\n\nYou can use this function to test for such cases. After you call this\nfunction, the interchangeability checking algorithms in the specific\ndriver ignore all previous configuration operations. By calling this\nfunction at the beginning of a test module, you can determine whether\nthe test module has dependencies on the operation of previously executed\ntest modules.\n\nThis function does not clear the interchangeability warnings from the\nlist of previously recorded interchangeability warnings. If you want to\nguarantee that the niDCPower_GetNextInterchangeWarning function only\nreturns those interchangeability warnings that are generated after\ncalling this function, you must clear the list of interchangeability\nwarnings. You can clear the interchangeability warnings list by\nrepeatedly calling the niDCPower_GetNextInterchangeWarning function\nuntil no more interchangeability warnings are returned. If you are not\ninterested in the content of those warnings, you can call the\nniDCPower_ClearInterchangeWarnings function.\n', + 'note': '\nniDCPower_GetNextInterchangeWarning does not mark any attributes for\nan interchange check.\n' + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + } + ], + 'returns': 'ViStatus' + }, + 'ResetOutputProtection': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel to query. The output state may only be -queried for one channel at a time. -''', -}, - }, + 'type': 'ViConstString' + } + ], + 'returns': 'ViStatus' + }, + 'ResetWithChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ { 'direction': 'in', - 'name': 'outputState', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the output state of the output channel that is being queried. -**Defined Values**: -''', -'table_body': [['NIDCPOWER_VAL_OUTPUT_CONSTANT_VOLTAGE (0)', 'The device maintains a constant voltage by adjusting the current.'], ['NIDCPOWER_VAL_OUTPUT_CONSTANT_CURRENT (1)', 'The device maintains a constant current by adjusting the voltage.']], -}, + 'name': 'vi', + 'type': 'ViSession' }, { - 'direction': 'out', - 'name': 'inState', - 'type': 'ViBoolean', -'documentation': { -'description': ''' -Returns whether the device output channel is in the specified output -state. -''', -}, - }, - ], -'documentation': { -'description': ''' -Queries the specified output channel to determine if the output channel -is currently in the state specified by **outputState**. - -**Related Topics:** - -`Compliance `__ -''', -}, + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' + } + ], + 'returns': 'ViStatus' }, - 'ReadCurrentTemperature': { - 'returns': 'ViStatus', + 'ResetWithDefaults': { + 'documentation': { + 'description': "\nResets the device to a known state. This function disables power\ngeneration, resets session attributes to their default values, commits\nthe session attributes, and leaves the session in the\n`Running `__\nstate. In addition to exhibiting the behavior of the niDCPower_reset\nfunction, this function can assign user-defined default values for\nconfigurable attributes from the IVI configuration.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitExtCal or niDCPower_InitializeWithChannels function. -''', -}, - }, - { - 'direction': 'out', - 'name': 'Temperature', - 'type': 'ViReal64', -'documentation': { -'description': 'Returns the onboard **temperature**, in degrees Celsius, of the device.', -}, - }, + 'type': 'ViSession' + } ], -'documentation': { -'description': ''' -Returns the current onboard **temperature**, in degrees Celsius, of the -device. -''', -}, + 'returns': 'ViStatus' }, - 'ResetDevice': { - 'returns': 'ViStatus', + 'ResetWithDefaultsWithChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' + } ], -'documentation': { -'description': ''' -Resets the device to a known state. The function disables power -generation, resets session attributes to their default values, clears -errors such as overtemperature and unexpected loss of auxiliary power, -commits the session attributes, and leaves the session in the -Uncommitted state. This function also performs a hard reset on the -device and driver software. This function has the same functionality as -using reset in Measurement & Automation Explorer. Refer to the -`Programming -States `__ topic for -more information about NI-DCPower software states. - -This will also open the output relay on devices that have an output -relay. -''', -}, + 'returns': 'ViStatus' }, - 'ResetInterchangeCheck': { - 'returns': 'ViStatus', + 'RestoreAttributes': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, - }, - ], -'documentation': { -'description': ''' -When developing a complex test system that consists of multiple test -modules, it is generally a good idea to design the test modules so that -they can run in any order. To do so requires ensuring that each test -module completely configures the state of each instrument it uses. If a -particular test module does not completely configure the state of an -instrument, the state of the instrument depends on the configuration -from a previously executed test module. If you execute the test modules -in a different order, the behavior of the instrument and therefore the -entire test module is likely to change. This change in behavior is -generally instrument specific and represents an interchangeability -problem. - -You can use this function to test for such cases. After you call this -function, the interchangeability checking algorithms in the specific -driver ignore all previous configuration operations. By calling this -function at the beginning of a test module, you can determine whether -the test module has dependencies on the operation of previously executed -test modules. - -This function does not clear the interchangeability warnings from the -list of previously recorded interchangeability warnings. If you want to -guarantee that the niDCPower_GetNextInterchangeWarning function only -returns those interchangeability warnings that are generated after -calling this function, you must clear the list of interchangeability -warnings. You can clear the interchangeability warnings list by -repeatedly calling the niDCPower_GetNextInterchangeWarning function -until no more interchangeability warnings are returned. If you are not -interested in the content of those warnings, you can call the -niDCPower_ClearInterchangeWarnings function. -''', -'note': ''' -niDCPower_GetNextInterchangeWarning does not mark any attributes for -an interchange check. -''', -}, + 'type': 'ViSession' + } + ], + 'returns': 'ViStatus' }, - 'ResetWithDefaults': { - 'returns': 'ViStatus', + 'RevokeControl': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' + }, + { + 'direction': 'out', + 'name': 'clientWasRevoked', + 'type': 'ViBoolean' + }, + { + 'direction': 'out', + 'name': 'cachedSessionState', + 'type': 'ViInt32' }, + { + 'direction': 'out', + 'name': 'cachedSessionStateValid', + 'type': 'ViBoolean' + } + ], + 'returns': 'ViStatus' + }, + 'SaveAttributes': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + } ], -'documentation': { -'description': ''' -Resets the device to a known state. This function disables power -generation, resets session attributes to their default values, commits -the session attributes, and leaves the session in the -`Running `__ -state. In addition to exhibiting the behavior of the niDCPower_reset -function, this function can assign user-defined default values for -configurable attributes from the IVI configuration. -''', -}, + 'returns': 'ViStatus' }, 'SendSoftwareEdgeTrigger': { - 'returns': 'ViStatus', + 'documentation': { + 'description': '\nAsserts the specified trigger. This function can override an external\nedge trigger.\n\n**Related Topics:**\n\n`Triggers `__\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies which trigger to assert.\n**Defined Values:**\n', + 'table_body': [ + [ + 'NIDCPOWER_VAL_START_TRIGGER (1034)', + 'Asserts the Start trigger.' + ], + [ + 'NIDCPOWER_VAL_SOURCE_TRIGGER (1035)', + 'Asserts the Source trigger.' + ], + [ + 'NIDCPOWER_VAL_MEASURE_TRIGGER (1036)', + 'Asserts the Measure trigger.' + ], + [ + 'NIDCPOWER_VAL_SEQUENCE_ADVANCE_TRIGGER (1037)', + 'Asserts the Sequence Advance trigger.' + ], + [ + 'NIDCPOWER_VAL_PULSE_TRIGGER (1053', + 'Asserts the Pulse trigger.' + ] + ] + }, + 'enum': 'SendSoftwareEdgeTriggerType', + 'name': 'trigger', + 'type': 'ViInt32' + } + ], + 'returns': 'ViStatus' + }, + 'SendSoftwareEdgeTriggerWithChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'Trigger', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies which trigger to assert. -**Defined Values:** -''', -'table_body': [['NIDCPOWER_VAL_START_TRIGGER (1034)', 'Asserts the Start trigger.'], ['NIDCPOWER_VAL_SOURCE_TRIGGER (1035)', 'Asserts the Source trigger.'], ['NIDCPOWER_VAL_MEASURE_TRIGGER (1036)', 'Asserts the Measure trigger.'], ['NIDCPOWER_VAL_SEQUENCE_ADVANCE_TRIGGER (1037)', 'Asserts the Sequence Advance trigger.'], ['NIDCPOWER_VAL_PULSE_TRIGGER (1053', 'Asserts the Pulse trigger.']], -}, - }, - ], -'documentation': { -'description': ''' -Asserts the specified trigger. This function can override an external -edge trigger. - -**Related Topics:** - -`Triggers `__ -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'name': 'channelName', + 'type': 'ViConstString' + }, + { + 'direction': 'in', + 'name': 'trigger', + 'type': 'ViInt32' + } + ], + 'returns': 'ViStatus' }, 'SetAttributeViBoolean': { - 'returns': 'ViStatus', + 'codegen_method': 'private', + 'documentation': { + 'description': '\n| Sets the value of a ViBoolean attribute.\n| This is a low-level function that you can use to set the values of\n device-specific attributes and inherent IVI attributes.\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, + 'type': 'ViConstString' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the ID of an attribute. From the function panel window, you\ncan use this control as follows.\n\n- In the function panel window, click on the control or press **Enter**\n or the spacebar to display a dialog box containing hierarchical list\n of the available attributes. Attributes whose value cannot be set are\n dim. Help text is shown for each attribute. Select an attribute by\n double-clicking on it or by selecting it and then pressing **Enter**.\n- Read-only attributes appear dim in the list box. If you select a\n read-only attribute, an error message appears. A ring control at the\n top of the dialog box allows you to see all IVI attributes or only\n the attributes of type ViBoolean. If you choose to see all IVI\n attributes, the data types appear to the right of the attribute names\n in the list box. Attributes with data types other than ViBoolean are\n dim. If you select an attribute data type that is dim, LabWindows/CVI\n transfers you to the function panel for the corresponding function\n that is consistent with the data type.\n- If you want to enter a variable name, press **Ctrl**\\ +\\ **T** to\n change this ring control to a manual input box. If the attribute in\n this ring control has named constants as valid values, you can view\n the constants by moving to the value control and pressing **Enter**.\n' + }, 'name': 'attributeId', - 'type': 'ViAttr', -'documentation': { -'description': ''' -Specifies the ID of an attribute. From the function panel window, you -can use this control as follows. - -- In the function panel window, click on the control or press **Enter** - or the spacebar to display a dialog box containing hierarchical list - of the available attributes. Attributes whose value cannot be set are - dim. Help text is shown for each attribute. Select an attribute by - double-clicking on it or by selecting it and then pressing **Enter**. -- Read-only attributes appear dim in the list box. If you select a - read-only attribute, an error message appears. A ring control at the - top of the dialog box allows you to see all IVI attributes or only - the attributes of type ViBoolean. If you choose to see all IVI - attributes, the data types appear to the right of the attribute names - in the list box. Attributes with data types other than ViBoolean are - dim. If you select an attribute data type that is dim, LabWindows/CVI - transfers you to the function panel for the corresponding function - that is consistent with the data type. -- If you want to enter a variable name, press **Ctrl**\ +\ **T** to - change this ring control to a manual input box. If the attribute in - this ring control has named constants as valid values, you can view - the constants by moving to the value control and pressing **Enter**. -''', -}, + 'type': 'ViAttr' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the value to which you want to set the attribute. If the\nattribute currently showing in the attribute ring control has constants\nas valid values, you can view a list of the constants by pressing\n**Enter** on this control. Select a value by double-clicking on it or by\nselecting it and then pressing **Enter**.\n', + 'note': '\nSome of the values might not be valid depending upon the current\nsettings of the device session.\n' + }, 'name': 'attributeValue', - 'type': 'ViBoolean', -'documentation': { -'description': ''' -Specifies the value to which you want to set the attribute. If the -attribute currently showing in the attribute ring control has constants -as valid values, you can view a list of the constants by pressing -**Enter** on this control. Select a value by double-clicking on it or by -selecting it and then pressing **Enter**. -''', -'note': ''' -Some of the values might not be valid depending upon the current -settings of the device session. -''', -}, - }, - ], -'documentation': { -'description': ''' -| Sets the value of a ViBoolean attribute. -| This is a low-level function that you can use to set the values of - device-specific attributes and inherent IVI attributes. -''', -}, + 'type': 'ViBoolean' + } + ], + 'returns': 'ViStatus' }, 'SetAttributeViInt32': { - 'returns': 'ViStatus', + 'codegen_method': 'private', + 'documentation': { + 'description': '\n| Sets the value of a ViInt32 attribute.\n| This is a low-level function that you can use to set the values of\n device-specific attributes and inherent IVI attributes.\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, + 'type': 'ViConstString' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the ID of an attribute. From the function panel window, you\ncan use this control as follows.\n\n- In the function panel window, click on the control or press **Enter**\n or the spacebar to display a dialog box containing hierarchical list\n of the available attributes. Attributes whose value cannot be set are\n dim. Help text is shown for each attribute. Select an attribute by\n double-clicking on it or by selecting it and then pressing **Enter**.\n- Read-only attributes appear dim in the list box. If you select a\n read-only attribute, an error message appears. A ring control at the\n top of the dialog box allows you to see all IVI attributes or only\n the attributes of type ViInt32. If you choose to see all IVI\n attributes, the data types appear to the right of the attribute names\n in the list box. Attributes with data types other than ViInt32 are\n dim. If you select an attribute data type that is dim, LabWindows/CVI\n transfers you to the function panel for the corresponding function\n that is consistent with the data type.\n- If you want to enter a variable name, press **Ctrl**\\ +\\ **T** to\n change this ring control to a manual input box. If the attribute in\n this ring control has named constants as valid values, you can view\n the constants by moving to the value control and pressing **Enter**.\n' + }, 'name': 'attributeId', - 'type': 'ViAttr', -'documentation': { -'description': ''' -Specifies the ID of an attribute. From the function panel window, you -can use this control as follows. - -- In the function panel window, click on the control or press **Enter** - or the spacebar to display a dialog box containing hierarchical list - of the available attributes. Attributes whose value cannot be set are - dim. Help text is shown for each attribute. Select an attribute by - double-clicking on it or by selecting it and then pressing **Enter**. -- Read-only attributes appear dim in the list box. If you select a - read-only attribute, an error message appears. A ring control at the - top of the dialog box allows you to see all IVI attributes or only - the attributes of type ViInt32. If you choose to see all IVI - attributes, the data types appear to the right of the attribute names - in the list box. Attributes with data types other than ViInt32 are - dim. If you select an attribute data type that is dim, LabWindows/CVI - transfers you to the function panel for the corresponding function - that is consistent with the data type. -- If you want to enter a variable name, press **Ctrl**\ +\ **T** to - change this ring control to a manual input box. If the attribute in - this ring control has named constants as valid values, you can view - the constants by moving to the value control and pressing **Enter**. -''', -}, + 'type': 'ViAttr' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the value to which you want to set the attribute. If the\nattribute currently showing in the attribute ring control has constants\nas valid values, you can view a list of the constants by pressing\n**Enter** on this control. Select a value by double-clicking on it or by\nselecting it and then pressing **Enter**.\n', + 'note': '\nSome of the values might not be valid depending upon the current\nsettings of the device session.\n' + }, 'name': 'attributeValue', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies the value to which you want to set the attribute. If the -attribute currently showing in the attribute ring control has constants -as valid values, you can view a list of the constants by pressing -**Enter** on this control. Select a value by double-clicking on it or by -selecting it and then pressing **Enter**. -''', -'note': ''' -Some of the values might not be valid depending upon the current -settings of the device session. -''', -}, - }, - ], -'documentation': { -'description': ''' -| Sets the value of a ViInt32 attribute. -| This is a low-level function that you can use to set the values of - device-specific attributes and inherent IVI attributes. -''', -}, + 'type': 'ViInt32' + } + ], + 'returns': 'ViStatus' }, 'SetAttributeViInt64': { - 'returns': 'ViStatus', + 'codegen_method': 'private', + 'documentation': { + 'description': '\n| Sets the value of a ViInt64 attribute.\n| This is a low-level function that you can use to set the values of\n device-specific attributes and inherent IVI attributes.\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, + 'type': 'ViConstString' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the ID of an attribute. From the function panel window, you\ncan use this control as follows.\n\n- In the function panel window, click on the control or press **Enter**\n or the spacebar to display a dialog box containing hierarchical list\n of the available attributes. Attributes whose value cannot be set are\n dim. Help text is shown for each attribute. Select an attribute by\n double-clicking on it or by selecting it and then pressing **Enter**.\n- Read-only attributes appear dim in the list box. If you select a\n read-only attribute, an error message appears. A ring control at the\n top of the dialog box allows you to see all IVI attributes or only\n the attributes of type ViReal64. If you choose to see all IVI\n attributes, the data types appear to the right of the attribute names\n in the list box. Attributes with data types other than ViReal64 are\n dim. If you select an attribute data type that is dim, LabWindows/CVI\n transfers you to the function panel for the corresponding function\n that is consistent with the data type.\n- If you want to enter a variable name, press **Ctrl**\\ +\\ **T** to\n change this ring control to a manual input box. If the attribute in\n this ring control has named constants as valid values, you can view\n the constants by moving to the value control and pressing **Enter**.\n' + }, 'name': 'attributeId', - 'type': 'ViAttr', -'documentation': { -'description': ''' -Specifies the ID of an attribute. From the function panel window, you -can use this control as follows. - -- In the function panel window, click on the control or press **Enter** - or the spacebar to display a dialog box containing hierarchical list - of the available attributes. Attributes whose value cannot be set are - dim. Help text is shown for each attribute. Select an attribute by - double-clicking on it or by selecting it and then pressing **Enter**. -- Read-only attributes appear dim in the list box. If you select a - read-only attribute, an error message appears. A ring control at the - top of the dialog box allows you to see all IVI attributes or only - the attributes of type ViReal64. If you choose to see all IVI - attributes, the data types appear to the right of the attribute names - in the list box. Attributes with data types other than ViReal64 are - dim. If you select an attribute data type that is dim, LabWindows/CVI - transfers you to the function panel for the corresponding function - that is consistent with the data type. -- If you want to enter a variable name, press **Ctrl**\ +\ **T** to - change this ring control to a manual input box. If the attribute in - this ring control has named constants as valid values, you can view - the constants by moving to the value control and pressing **Enter**. -''', -}, + 'type': 'ViAttr' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the value to which you want to set the attribute. If the\nattribute currently showing in the attribute ring control has constants\nas valid values, you can view a list of the constants by pressing\n**Enter** on this control. Select a value by double-clicking on it or by\nselecting it and then pressing **Enter**.\n', + 'note': '\nSome of the values might not be valid depending upon the current\nsettings of the device session.\n' + }, 'name': 'attributeValue', - 'type': 'ViInt64', -'documentation': { -'description': ''' -Specifies the value to which you want to set the attribute. If the -attribute currently showing in the attribute ring control has constants -as valid values, you can view a list of the constants by pressing -**Enter** on this control. Select a value by double-clicking on it or by -selecting it and then pressing **Enter**. -''', -'note': ''' -Some of the values might not be valid depending upon the current -settings of the device session. -''', -}, - }, - ], -'documentation': { -'description': ''' -| Sets the value of a ViInt64 attribute. -| This is a low-level function that you can use to set the values of - device-specific attributes and inherent IVI attributes. -''', -}, + 'type': 'ViInt64' + } + ], + 'returns': 'ViStatus' }, 'SetAttributeViReal64': { - 'returns': 'ViStatus', + 'codegen_method': 'private', + 'documentation': { + 'description': '\n| Sets the value of a ViReal64 attribute.\n| This is a low-level function that you can use to set the values of\n device-specific attributes and inherent IVI attributes.\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, + 'type': 'ViConstString' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the ID of an attribute. From the function panel window, you\ncan use this control as follows.\n\n- In the function panel window, click on the control or press **Enter**\n or the spacebar to display a dialog box containing hierarchical list\n of the available attributes. Attributes whose value cannot be set are\n dim. Help text is shown for each attribute. Select an attribute by\n double-clicking on it or by selecting it and then pressing **Enter**.\n- Read-only attributes appear dim in the list box. If you select a\n read-only attribute, an error message appears. A ring control at the\n top of the dialog box allows you to see all IVI attributes or only\n the attributes of type ViReal64. If you choose to see all IVI\n attributes, the data types appear to the right of the attribute names\n in the list box. Attributes with data types other than ViReal64 are\n dim. If you select an attribute data type that is dim, LabWindows/CVI\n transfers you to the function panel for the corresponding function\n that is consistent with the data type.\n- If you want to enter a variable name, press **Ctrl**\\ +\\ **T** to\n change this ring control to a manual input box. If the attribute in\n this ring control has named constants as valid values, you can view\n the constants by moving to the value control and pressing **Enter**.\n' + }, 'name': 'attributeId', - 'type': 'ViAttr', -'documentation': { -'description': ''' -Specifies the ID of an attribute. From the function panel window, you -can use this control as follows. - -- In the function panel window, click on the control or press **Enter** - or the spacebar to display a dialog box containing hierarchical list - of the available attributes. Attributes whose value cannot be set are - dim. Help text is shown for each attribute. Select an attribute by - double-clicking on it or by selecting it and then pressing **Enter**. -- Read-only attributes appear dim in the list box. If you select a - read-only attribute, an error message appears. A ring control at the - top of the dialog box allows you to see all IVI attributes or only - the attributes of type ViReal64. If you choose to see all IVI - attributes, the data types appear to the right of the attribute names - in the list box. Attributes with data types other than ViReal64 are - dim. If you select an attribute data type that is dim, LabWindows/CVI - transfers you to the function panel for the corresponding function - that is consistent with the data type. -- If you want to enter a variable name, press **Ctrl**\ +\ **T** to - change this ring control to a manual input box. If the attribute in - this ring control has named constants as valid values, you can view - the constants by moving to the value control and pressing **Enter**. -''', -}, + 'type': 'ViAttr' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the value to which you want to set the attribute. If the\nattribute currently showing in the attribute ring control has constants\nas valid values, you can view a list of the constants by pressing\n**Enter** on this control. Select a value by double-clicking on it or by\nselecting it and then pressing **Enter**.\n', + 'note': '\nSome of the values might not be valid depending upon the current\nsettings of the device session.\n' + }, 'name': 'attributeValue', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the value to which you want to set the attribute. If the -attribute currently showing in the attribute ring control has constants -as valid values, you can view a list of the constants by pressing -**Enter** on this control. Select a value by double-clicking on it or by -selecting it and then pressing **Enter**. -''', -'note': ''' -Some of the values might not be valid depending upon the current -settings of the device session. -''', -}, - }, - ], -'documentation': { -'description': ''' -| Sets the value of a ViReal64 attribute. -| This is a low-level function that you can use to set the values of - device-specific attributes and inherent IVI attributes. -''', -}, + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, 'SetAttributeViSession': { - 'returns': 'ViStatus', + 'codegen_method': 'no', + 'documentation': { + 'description': '\n| Sets the value of a ViSession attribute.\n| This is a low-level function that you can use to set the values of\n device-specific attributes and inherent IVI attributes.\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, + 'type': 'ViConstString' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the ID of an attribute. From the function panel window, you\ncan use this control as follows.\n\n- In the function panel window, click on the control or press **Enter**\n or the spacebar to display a dialog box containing hierarchical list\n of the available attributes. Attributes whose value cannot be set are\n dim. Help text is shown for each attribute. Select an attribute by\n double-clicking on it or by selecting it and then pressing **Enter**.\n- Read-only attributes appear dim in the list box. If you select a\n read-only attribute, an error message appears. A ring control at the\n top of the dialog box allows you to see all IVI attributes or only\n the attributes of type ViSession. If you choose to see all IVI\n attributes, the data types appear to the right of the attribute names\n in the list box. Attributes with data types other than ViSession are\n dim. If you select an attribute data type that is dim, LabWindows/CVI\n transfers you to the function panel for the corresponding function\n that is consistent with the data type.\n- If you want to enter a variable name, press **Ctrl**\\ +\\ **T** to\n change this ring control to a manual input box. If the attribute in\n this ring control has named constants as valid values, you can view\n the constants by moving to the value control and pressing **Enter**.\n' + }, 'name': 'attributeId', - 'type': 'ViAttr', -'documentation': { -'description': ''' -Specifies the ID of an attribute. From the function panel window, you -can use this control as follows. - -- In the function panel window, click on the control or press **Enter** - or the spacebar to display a dialog box containing hierarchical list - of the available attributes. Attributes whose value cannot be set are - dim. Help text is shown for each attribute. Select an attribute by - double-clicking on it or by selecting it and then pressing **Enter**. -- Read-only attributes appear dim in the list box. If you select a - read-only attribute, an error message appears. A ring control at the - top of the dialog box allows you to see all IVI attributes or only - the attributes of type ViSession. If you choose to see all IVI - attributes, the data types appear to the right of the attribute names - in the list box. Attributes with data types other than ViSession are - dim. If you select an attribute data type that is dim, LabWindows/CVI - transfers you to the function panel for the corresponding function - that is consistent with the data type. -- If you want to enter a variable name, press **Ctrl**\ +\ **T** to - change this ring control to a manual input box. If the attribute in - this ring control has named constants as valid values, you can view - the constants by moving to the value control and pressing **Enter**. -''', -}, + 'type': 'ViAttr' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the value to which you want to set the attribute. If the\nattribute currently showing in the attribute ring control has constants\nas valid values, you can view a list of the constants by pressing\n**Enter** on this control. Select a value by double-clicking on it or by\nselecting it and then pressing **Enter**.\n', + 'note': '\nSome of the values might not be valid depending upon the current\nsettings of the device session.\n' + }, 'name': 'attributeValue', - 'type': 'ViSession', -'documentation': { -'description': ''' -Specifies the value to which you want to set the attribute. If the -attribute currently showing in the attribute ring control has constants -as valid values, you can view a list of the constants by pressing -**Enter** on this control. Select a value by double-clicking on it or by -selecting it and then pressing **Enter**. -''', -'note': ''' -Some of the values might not be valid depending upon the current -settings of the device session. -''', -}, - }, - ], -'documentation': { -'description': ''' -| Sets the value of a ViSession attribute. -| This is a low-level function that you can use to set the values of - device-specific attributes and inherent IVI attributes. -''', -}, + 'type': 'ViSession' + } + ], + 'returns': 'ViStatus' }, 'SetAttributeViString': { - 'returns': 'ViStatus', + 'codegen_method': 'private', + 'documentation': { + 'description': '\n| Sets the value of a ViString attribute.\n| This is a low-level function that you can use to set the values of\n device-specific attributes and inherent IVI attributes.\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', -}, + 'type': 'ViConstString' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the ID of an attribute. From the function panel window, you\ncan use this control as follows.\n\n- In the function panel window, click on the control or press **Enter**\n or the spacebar to display a dialog box containing hierarchical list\n of the available attributes. Attributes whose value cannot be set are\n dim. Help text is shown for each attribute. Select an attribute by\n double-clicking on it or by selecting it and then pressing **Enter**.\n- Read-only attributes appear dim in the list box. If you select a\n read-only attribute, an error message appears. A ring control at the\n top of the dialog box allows you to see all IVI attributes or only\n the attributes of type ViString. If you choose to see all IVI\n attributes, the data types appear to the right of the attribute names\n in the list box. Attributes with data types other than ViString are\n dim. If you select an attribute data type that is dim, LabWindows/CVI\n transfers you to the function panel for the corresponding function\n that is consistent with the data type.\n- If you want to enter a variable name, press **Ctrl**\\ +\\ **T** to\n change this ring control to a manual input box. If the attribute in\n this ring control has named constants as valid values, you can view\n the constants by moving to the value control and pressing **Enter**.\n' + }, 'name': 'attributeId', - 'type': 'ViAttr', -'documentation': { -'description': ''' -Specifies the ID of an attribute. From the function panel window, you -can use this control as follows. - -- In the function panel window, click on the control or press **Enter** - or the spacebar to display a dialog box containing hierarchical list - of the available attributes. Attributes whose value cannot be set are - dim. Help text is shown for each attribute. Select an attribute by - double-clicking on it or by selecting it and then pressing **Enter**. -- Read-only attributes appear dim in the list box. If you select a - read-only attribute, an error message appears. A ring control at the - top of the dialog box allows you to see all IVI attributes or only - the attributes of type ViString. If you choose to see all IVI - attributes, the data types appear to the right of the attribute names - in the list box. Attributes with data types other than ViString are - dim. If you select an attribute data type that is dim, LabWindows/CVI - transfers you to the function panel for the corresponding function - that is consistent with the data type. -- If you want to enter a variable name, press **Ctrl**\ +\ **T** to - change this ring control to a manual input box. If the attribute in - this ring control has named constants as valid values, you can view - the constants by moving to the value control and pressing **Enter**. -''', -}, + 'type': 'ViAttr' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the value to which you want to set the attribute. If the\nattribute currently showing in the attribute ring control has constants\nas valid values, you can view a list of the constants by pressing\n**Enter** on this control. Select a value by double-clicking on it or by\nselecting it and then pressing **Enter**.\n', + 'note': '\nSome of the values might not be valid depending upon the current\nsettings of the device session.\n' + }, 'name': 'attributeValue', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the value to which you want to set the attribute. If the -attribute currently showing in the attribute ring control has constants -as valid values, you can view a list of the constants by pressing -**Enter** on this control. Select a value by double-clicking on it or by -selecting it and then pressing **Enter**. -''', -'note': ''' -Some of the values might not be valid depending upon the current -settings of the device session. -''', -}, - }, - ], -'documentation': { -'description': ''' -| Sets the value of a ViString attribute. -| This is a low-level function that you can use to set the values of - device-specific attributes and inherent IVI attributes. -''', -}, + 'type': 'ViConstString' + } + ], + 'returns': 'ViStatus' }, 'SetCalUserDefinedInfo': { - 'returns': 'ViStatus', + 'codegen_method': 'no', + 'documentation': { + 'description': '\nStores a user-defined string of characters in the device onboard EEPROM.\nIf the string is longer than the maximum allowable size, it is\ntruncated. This function overwrites any existing user-defined\ninformation.\n\nIf you call this function in a session, **info** is immediately changed.\nIf you call this function in an external calibration session, **info**\nis changed only after you close the session using the\nniDCPower_CloseExtCal function with **action** set to\nNIDCPOWER_VAL_COMMIT.\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitExtCal or niDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitExtCal or niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'Info', - 'type': 'ViChar[]', -'documentation': { -'description': 'Specifies the string to store in the device onboard EEPROM.', -}, - }, + 'documentation': { + 'description': 'Specifies the string to store in the device onboard EEPROM.' + }, + 'name': 'info', + 'type': 'ViConstString' + } + ], + 'returns': 'ViStatus' + }, + 'SetCloseFunctionPointer': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'closeFunctionPtr', + 'type': 'CloseFunctionType' + } ], -'documentation': { -'description': ''' -Stores a user-defined string of characters in the device onboard EEPROM. -If the string is longer than the maximum allowable size, it is -truncated. This function overwrites any existing user-defined -information. - -If you call this function in a session, **info** is immediately changed. -If you call this function in an external calibration session, **info** -is changed only after you close the session using the -niDCPower_CloseExtCal function with **action** set to -NIDCPOWER_VAL_COMMIT. -''', -}, + 'returns': 'ViStatus' }, 'SetSequence': { - 'returns': 'ViStatus', + 'documentation': { + 'description': '\nConfigures a series of voltage or current outputs and corresponding\nsource delays. The source mode must be set to\n`Sequence `__ for this\nfunction to take effect.\n\nRefer to the `Configuring the Source\nUnit `__ topic\nin the *NI DC Power Supplies and SMUs Help* for more information about\nhow to configure your device.\n\nUse this function in the Uncommitted or Committed programming states.\nRefer to the `Programming\nStates `__ topic in\nthe *NI DC Power Supplies and SMUs Help* for more information about\nNI-DCPower programming states.\n', + 'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice `__\nfor more information about supported devices.\n" + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the output channel to which this configuration value applies.\nYou can only set a sequence for one channel at a time.\n' + }, 'name': 'channelName', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Specifies the output channel to which this configuration value applies. -You can only set a sequence for one channel at a time. -''', -}, + 'type': 'ViConstString' }, { 'direction': 'in', - 'name': 'Values', - 'type': 'ViReal64[]', -'documentation': { -'description': ''' -Specifies the series of voltage levels or current levels, depending on -the configured `output -function `__. -**Valid values**: -The valid values for this parameter are defined by the voltage level -range or current level range. -''', -}, + 'documentation': { + 'description': '\nSpecifies the series of voltage levels or current levels, depending on\nthe configured `output\nfunction `__.\n**Valid values**:\nThe valid values for this parameter are defined by the voltage level\nrange or current level range.\n' + }, + 'name': 'values', + 'size': { + 'mechanism': 'len', + 'value': 'size' + }, + 'type': 'ViReal64[]' }, { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the source delay that follows the configuration of each value\nin the sequence.\n**Valid Values**:\nThe valid values are between 0 and 167 seconds.\n' + }, 'name': 'sourceDelays', - 'type': 'ViReal64[]', -'documentation': { -'description': ''' -Specifies the source delay that follows the configuration of each value -in the sequence. -**Valid Values**: -The valid values are between 0 and 167 seconds. -''', -}, - }, - { - 'direction': 'in', - 'name': 'Size', - 'type': 'ViUInt32', -'documentation': { -'description': ''' -The number of elements in the Values and the Source Delays arrays. The -Values and Source Delays arrays should have the same size. -''', -}, - }, - ], -'documentation': { -'description': ''' -Configures a series of voltage or current outputs and corresponding -source delays. The source mode must be set to -`Sequence `__ for this -function to take effect. - -Refer to the `Configuring the Source -Unit `__ topic -in the *NI DC Power Supplies and SMUs Help* for more information about -how to configure your device. - -Use this function in the Uncommitted or Committed programming states. -Refer to the `Programming -States `__ topic in -the *NI DC Power Supplies and SMUs Help* for more information about -NI-DCPower programming states. -''', -'note': ''' -This function is not supported on all devices. Refer to `Supported -Functions by -Device `__ -for more information about supported devices. -''', -}, + 'size': { + 'mechanism': 'len', + 'value': 'size' + }, + 'type': 'ViReal64[]' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nThe number of elements in the Values and the Source Delays arrays. The\nValues and Source Delays arrays should have the same size.\n' + }, + 'name': 'size', + 'type': 'ViUInt32' + } + ], + 'returns': 'ViStatus' }, 'UnlockSession': { - 'returns': 'ViStatus', + 'documentation': { + 'description': '\nReleases a lock that you acquired on an device session using\nniDCPower_LockSession. Refer to niDCPower_LockSession for additional\ninformation on session locks.\n' + }, + 'method_templates': [ + { + 'documentation_filename': 'unlock', + 'method_python_name_suffix': '', + 'session_filename': 'unlock' + } + ], 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'out', + 'documentation': { + 'description': '\n| This attribute is optional. If you do not want to use this attribute,\n pass VI_NULL.\n| Use this attribute in complex functions to keep track of whether you\n obtain a lock and therefore need to unlock the session.\n| Pass the address of a local ViBoolean variable. In the declaration of\n the local variable, initialize it to VI_FALSE. Pass the address of\n the same local variable to any other calls you make to\n niDCPower_LockSession or niDCPower_UnlockSessionin the same\n function.\n| The parameter is an input/output parameter. niDCPower_LockSession and\n niDCPower_UnlockSessioneach inspect the current value and take the\n following actions.\n\n- If the value is VI_TRUE, niDCPower_LockSession does not lock the\n session again.\n- If the value is VI_FALSE, niDCPower_LockSession obtains the lock\n and sets the value of the parameter to VI_TRUE.\n- If the value is VI_FALSE, niDCPower_UnlockSessiondoes not attempt\n to unlock the session.\n- If the value is VI_TRUE, niDCPower_UnlockSessionreleases the lock\n and sets the value of the parameter to VI_FALSE.\n\n| Thus, you can, call niDCPower_UnlockSession at the end of your\n function without worrying about whether you actually have the lock, as\n the following example shows.\n| ViStatus TestFunc (ViSession vi, ViInt32 flags)\n {\n ViStatus error = VI_SUCCESS;\n ViBoolean haveLock = VI_FALSE;\n if (flags & BIT_1)\n {\n viCheckErr( niDCPower_LockSession(vi, &haveLock;));\n viCheckErr( TakeAction1(vi));\n if (flags & BIT_2)\n {\n viCheckErr( niDCPower_UnlockSession(vi, &haveLock;));\n viCheckErr( TakeAction2(vi));\n viCheckErr( niDCPower_LockSession(vi, &haveLock;);\n }\n if (flags & BIT_3)\n viCheckErr( TakeAction3(vi));\n }\n Error:\n /\\*At this point, you cannot really be sure that you have the lock.\n Fortunately, the haveLock variable takes care of that for you.\\*/\n niDCPower_UnlockSession(vi, &haveLock;);\n return error;\n }\n' + }, 'name': 'callerHasLock', - 'type': 'ViBoolean', -'documentation': { -'description': ''' -| This attribute is optional. If you do not want to use this attribute, - pass VI_NULL. -| Use this attribute in complex functions to keep track of whether you - obtain a lock and therefore need to unlock the session. -| Pass the address of a local ViBoolean variable. In the declaration of - the local variable, initialize it to VI_FALSE. Pass the address of - the same local variable to any other calls you make to - niDCPower_LockSession or niDCPower_UnlockSessionin the same - function. -| The parameter is an input/output parameter. niDCPower_LockSession and - niDCPower_UnlockSessioneach inspect the current value and take the - following actions. - -- If the value is VI_TRUE, niDCPower_LockSession does not lock the - session again. -- If the value is VI_FALSE, niDCPower_LockSession obtains the lock - and sets the value of the parameter to VI_TRUE. -- If the value is VI_FALSE, niDCPower_UnlockSessiondoes not attempt - to unlock the session. -- If the value is VI_TRUE, niDCPower_UnlockSessionreleases the lock - and sets the value of the parameter to VI_FALSE. - -| Thus, you can, call niDCPower_UnlockSession at the end of your - function without worrying about whether you actually have the lock, as - the following example shows. -| ViStatus TestFunc (ViSession vi, ViInt32 flags) - { - ViStatus error = VI_SUCCESS; - ViBoolean haveLock = VI_FALSE; - if (flags & BIT_1) - { - viCheckErr( niDCPower_LockSession(vi, &haveLock;)); - viCheckErr( TakeAction1(vi)); - if (flags & BIT_2) - { - viCheckErr( niDCPower_UnlockSession(vi, &haveLock;)); - viCheckErr( TakeAction2(vi)); - viCheckErr( niDCPower_LockSession(vi, &haveLock;); - } - if (flags & BIT_3) - viCheckErr( TakeAction3(vi)); - } - Error: - /\*At this point, you cannot really be sure that you have the lock. - Fortunately, the haveLock variable takes care of that for you.\*/ - niDCPower_UnlockSession(vi, &haveLock;); - return error; - } -''', -}, - }, - ], -'documentation': { -'description': ''' -Releases a lock that you acquired on an device session using -niDCPower_LockSession. Refer to niDCPower_LockSession for additional -information on session locks. -''', -}, + 'type': 'ViBoolean' + } + ], + 'python_name': 'unlock', + 'render_in_session_base': True, + 'returns': 'ViStatus', + 'use_session_lock': False }, 'WaitForEvent': { - 'returns': 'ViStatus', + 'documentation': { + 'description': '\nWaits until the device has generated the specified event.\n\nThe session monitors whether each type of event has occurred at least\nonce since the last time this function or the niDCPower_Initiate\nfunction were called. If an event has only been generated once and you\ncall this function successively, the function times out. Individual\nevents must be generated between separate calls of this function.\n', + 'note': "\nRefer to `Supported Functions by\nDevice `__\nfor more information about supported devices.\n" + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies which event to wait for.\n**Defined Values:**\n', + 'table_body': [ + [ + 'NIDCPOWER_VAL_SOURCE_COMPLETE_EVENT (1030)', + 'Waits for the Source Complete event.' + ], + [ + 'NIDCPOWER_VAL_MEASURE_COMPLETE_EVENT (1031)', + 'Waits for the Measure Complete event.' + ], + [ + 'NIDCPOWER_VAL_SEQUENCE_ITERATION_COMPLETE_EVENT (1032)', + 'Waits for the Sequence Iteration Complete event.' + ], + [ + 'NIDCPOWER_VAL_SEQUENCE_ENGINE_DONE_EVENT (1033)', + 'Waits for the Sequence Engine Done event.' + ], + [ + 'NIDCPOWER_VAL_PULSE_COMPLETE_EVENT (1051 )', + 'Waits for the Pulse Complete event.' + ], + [ + 'NIDCPOWER_VAL_READY_FOR_PULSE_TRIGGER_EVENT (1052)', + 'Waits for the Ready for Pulse Trigger event.' + ] + ] + }, + 'enum': 'Event', + 'name': 'eventId', + 'type': 'ViInt32' + }, + { + 'default_value': 'datetime.timedelta(seconds=10.0)', + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the maximum time allowed for this function to complete, in\nseconds. If the function does not complete within this time interval,\nNI-DCPower returns an error.\n', + 'note': '\nWhen setting the timeout interval, ensure you take into account any\ntriggers so that the timeout interval is long enough for your\napplication.\n' + }, + 'name': 'timeout', + 'python_api_converter_name': 'convert_timedelta_to_seconds', + 'type': 'ViReal64', + 'type_in_documentation': 'float in seconds or datetime.timedelta' + } + ], + 'returns': 'ViStatus' + }, + 'WaitForEventWithChannels': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' + }, + { + 'direction': 'in', + 'name': 'channelName', + 'type': 'ViConstString' }, { 'direction': 'in', 'name': 'eventId', - 'type': 'ViInt32', -'documentation': { -'description': ''' -Specifies which event to wait for. -**Defined Values:** -''', -'table_body': [['NIDCPOWER_VAL_SOURCE_COMPLETE_EVENT (1030)', 'Waits for the Source Complete event.'], ['NIDCPOWER_VAL_MEASURE_COMPLETE_EVENT (1031)', 'Waits for the Measure Complete event.'], ['NIDCPOWER_VAL_SEQUENCE_ITERATION_COMPLETE_EVENT (1032)', 'Waits for the Sequence Iteration Complete event.'], ['NIDCPOWER_VAL_SEQUENCE_ENGINE_DONE_EVENT (1033)', 'Waits for the Sequence Engine Done event.'], ['NIDCPOWER_VAL_PULSE_COMPLETE_EVENT (1051 )', 'Waits for the Pulse Complete event.'], ['NIDCPOWER_VAL_READY_FOR_PULSE_TRIGGER_EVENT (1052)', 'Waits for the Ready for Pulse Trigger event.']], -}, + 'type': 'ViInt32' }, { 'direction': 'in', - 'name': 'Timeout', - 'type': 'ViReal64', -'documentation': { -'description': ''' -Specifies the maximum time allowed for this function to complete, in -seconds. If the function does not complete within this time interval, -NI-DCPower returns an error. -''', -'note': ''' -When setting the timeout interval, ensure you take into account any -triggers so that the timeout interval is long enough for your -application. -''', -}, - }, - ], -'documentation': { -'description': ''' -Waits until the device has generated the specified event. - -The session monitors whether each type of event has occurred at least -once since the last time this function or the niDCPower_Initiate -function were called. If an event has only been generated once and you -call this function successively, the function times out. Individual -events must be generated between separate calls of this function. -''', -'note': ''' -Refer to `Supported Functions by -Device `__ -for more information about supported devices. -''', -}, + 'name': 'timeout', + 'type': 'ViReal64' + } + ], + 'returns': 'ViStatus' }, - 'close': { - 'returns': 'ViStatus', + 'WriteDefaultCalValues': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + } + ], + 'returns': 'ViStatus' + }, + 'WriteFlashEepromBlock': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, + { + 'direction': 'in', + 'name': 'address', + 'type': 'ViUInt32' + }, + { + 'direction': 'in', + 'name': 'size', + 'type': 'ViUInt32' + }, + { + 'direction': 'in', + 'name': 'data', + 'size': { + 'mechanism': 'TBD', + 'value': 'TBD' + }, + 'type': 'ViUInt8[]' + } ], -'documentation': { -'description': ''' -Closes the session specified in **vi** and deallocates the resources -that NI-DCPower reserves. If power output is enabled when you call this -function, the output channels remain in their existing state and -continue providing power. Use the niDCPower_ConfigureOutputEnabled -function to disable power output on a per channel basis. Use the -niDCPower_reset function to disable power output on all channel(s). - -**Related Topics:** - -`Programming -States `__ -''', -}, + 'returns': 'ViStatus' }, - 'error_message': { - 'returns': 'ViStatus', + 'WriteRegister': { + 'codegen_method': 'no', + 'documentation': { + 'description': 'TBD' + }, 'parameters': [ { 'direction': 'in', 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'errorCode', - 'type': 'ViStatus', -'documentation': { -'description': ''' -Specifies the **status** parameter that is returned from any of the -NI-DCPower functions. -''', -}, + 'name': 'registerSize', + 'type': 'ViUInt16' }, { - 'direction': 'out', - 'name': 'errorMessage', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Returns the user-readable message string that corresponds to the status -code you specify. -You must pass a ViChar array with at least 256 bytes. -''', -}, - }, - ], -'documentation': { -'description': ''' -Converts a status code returned by an instrument driver function into a -user-readable string. -''', -}, + 'direction': 'in', + 'name': 'offset', + 'type': 'ViUInt16' + }, + { + 'direction': 'in', + 'name': 'value', + 'type': 'ViUInt16' + } + ], + 'returns': 'ViStatus' }, - 'init': { + 'close': { + 'codegen_method': 'private', + 'documentation': { + 'description': '\nCloses the session specified in **vi** and deallocates the resources\nthat NI-DCPower reserves. If power output is enabled when you call this\nfunction, the output channels remain in their existing state and\ncontinue providing power. Use the niDCPower_ConfigureOutputEnabled\nfunction to disable power output on a per channel basis. Use the\nniDCPower_reset function to disable power output on all channel(s).\n\n**Related Topics:**\n\n`Programming\nStates `__\n' + }, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' + } + ], 'returns': 'ViStatus', + 'use_session_lock': False + }, + 'error_message': { + 'codegen_method': 'private', + 'documentation': { + 'description': '\nConverts a status code returned by an instrument driver function into a\nuser-readable string.\n' + }, + 'is_error_handling': True, 'parameters': [ { 'direction': 'in', - 'name': 'resourceName', - 'type': 'ViRsrc', -'documentation': { -'description': ''' -Specifies the **resourceName** assigned by Measurement & Automation -Explorer (MAX), for example "PXI1Slot3" where "PXI1Slot3" is an -instrument's **resourceName**. **resourceName** can also be a logical -IVI name. -''', -}, + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, + 'name': 'vi', + 'type': 'ViSession' }, { 'direction': 'in', - 'name': 'idQuery', - 'type': 'ViBoolean', -'documentation': { -'description': ''' -Specifies whether the device is queried to determine if the device is a -valid instrument for NI-DCPower. -**Defined Values**: -''', -'table_body': [['VI_TRUE (1)', 'Perform ID query.'], ['VI_FALSE (0)', 'Do not perform ID query.']], -}, + 'documentation': { + 'description': '\nSpecifies the **status** parameter that is returned from any of the\nNI-DCPower functions.\n' + }, + 'name': 'errorCode', + 'type': 'ViStatus' }, + { + 'direction': 'out', + 'documentation': { + 'description': '\nReturns the user-readable message string that corresponds to the status\ncode you specify.\nYou must pass a ViChar array with at least 256 bytes.\n' + }, + 'name': 'errorMessage', + 'size': { + 'mechanism': 'fixed', + 'value': 256 + }, + 'type': 'ViChar[]' + } + ], + 'returns': 'ViStatus', + 'use_session_lock': False + }, + 'fancy_self_test': { + 'codegen_method': 'python-only', + 'documentation': { + 'description': '\nPerforms the device self-test routine and returns the test result(s).\nCalling this function implicitly calls the niDCPower_reset function.\n\nWhen calling niDCPower_self_test with the PXIe-4162/4163, specify all\nchannels of your PXIe-4162/4163 with the channels input of\nniDCPower_InitializeWithChannels. You cannot self test a subset of\nPXIe-4162/4163 channels.\n\nRaises `SelfTestError` on self test failure. Attributes on exception object:\n\n- code - failure code from driver\n- message - status message from driver\n', + 'table_body': [ + [ + '0', + 'Self test passed.' + ], + [ + '1', + 'Self test failed.' + ] + ], + 'table_header': [ + 'Self-Test Code', + 'Description' + ] + }, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'fancy_self_test' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies a particular instrument session. **vi** is obtained from the niDCPower_InitializeWithChannels function.' + }, + 'name': 'vi', + 'type': 'ViSession' + } + ], + 'python_name': 'self_test', + 'returns': 'ViStatus' + }, + 'init': { + 'codegen_method': 'no', + 'documentation': { + 'description': '\nThis function is deprecated. Use niDCPower_InitializeWithChannels\ninstead.\n\nCreates a new IVI instrument driver session to the device specified in\n**resourceName** and returns a session handle you use to identify the\ndevice in all subsequent NI-DCPower function calls. This function also\nsends initialization commands to set the device to the state necessary\nfor the operation of NI-DCPower.\n\nTo place the device in a known start-up state when creating a new\nsession, set **resetDevice** to VI_TRUE. This action is equivalent to\nusing the niDCPower_reset function.\n\nTo open a session and leave the device in its existing configuration\nwithout passing through a transitional output state, set **resetDevice**\nto VI_FALSE, and immediately call the niDCPower_Abort function. Then\nconfigure the device as in the previous session, changing only the\ndesired settings, and then call the niDCPower_Initiate function. Refer\nto the `deprecated programming state\nmodel `__ for\ninformation about the specific software states.\n' + }, + 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies the **resourceName** assigned by Measurement & Automation\nExplorer (MAX), for example "PXI1Slot3" where "PXI1Slot3" is an\ninstrument\'s **resourceName**. **resourceName** can also be a logical\nIVI name.\n' + }, + 'name': 'resourceName', + 'type': 'ViRsrc' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies whether the device is queried to determine if the device is a\nvalid instrument for NI-DCPower.\n**Defined Values**:\n', + 'table_body': [ + [ + 'VI_TRUE (1)', + 'Perform ID query.' + ], + [ + 'VI_FALSE (0)', + 'Do not perform ID query.' + ] + ] + }, + 'name': 'idQuery', + 'type': 'ViBoolean' + }, + { + 'direction': 'in', + 'documentation': { + 'description': '\nSpecifies whether to reset the device during the initialization\nprocedure.\n**Defined Values**:\n', + 'table_body': [ + [ + 'VI_TRUE (1)', + 'Reset the device.' + ], + [ + 'VI_FALSE (0)', + 'Do not reset the device.' + ] + ] + }, 'name': 'resetDevice', - 'type': 'ViBoolean', -'documentation': { -'description': ''' -Specifies whether to reset the device during the initialization -procedure. -**Defined Values**: -''', -'table_body': [['VI_TRUE (1)', 'Reset the device.'], ['VI_FALSE (0)', 'Do not reset the device.']], -}, + 'type': 'ViBoolean' }, { 'direction': 'out', + 'documentation': { + 'description': '\nReturns a session handle that you use to identify the session in all\nsubsequent NI-DCPower function calls.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Returns a session handle that you use to identify the session in all -subsequent NI-DCPower function calls. -''', -}, - }, - ], -'documentation': { -'description': ''' -This function is deprecated. Use niDCPower_InitializeWithChannels -instead. - -Creates a new IVI instrument driver session to the device specified in -**resourceName** and returns a session handle you use to identify the -device in all subsequent NI-DCPower function calls. This function also -sends initialization commands to set the device to the state necessary -for the operation of NI-DCPower. - -To place the device in a known start-up state when creating a new -session, set **resetDevice** to VI_TRUE. This action is equivalent to -using the niDCPower_reset function. - -To open a session and leave the device in its existing configuration -without passing through a transitional output state, set **resetDevice** -to VI_FALSE, and immediately call the niDCPower_Abort function. Then -configure the device as in the previous session, changing only the -desired settings, and then call the niDCPower_Initiate function. Refer -to the `deprecated programming state -model `__ for -information about the specific software states. -''', -}, + 'type': 'ViSession' + } + ], + 'returns': 'ViStatus' }, 'reset': { - 'returns': 'ViStatus', + 'documentation': { + 'description': '\nResets the device to a known state. This function disables power\ngeneration, resets session attributes to their default values, commits\nthe session attributes, and leaves the session in the Uncommitted state.\nRefer to the `Programming\nStates `__ topic for\nmore information about NI-DCPower software states.\n' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, - }, + 'type': 'ViSession' + } ], -'documentation': { -'description': ''' -Resets the device to a known state. This function disables power -generation, resets session attributes to their default values, commits -the session attributes, and leaves the session in the Uncommitted state. -Refer to the `Programming -States `__ topic for -more information about NI-DCPower software states. -''', -}, + 'returns': 'ViStatus' }, 'revision_query': { - 'returns': 'ViStatus', + 'codegen_method': 'no', + 'documentation': { + 'description': 'Returns the revision information of NI-DCPower and the device firmware.' + }, 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'out', + 'documentation': { + 'description': 'Returns the driver revision information for NI-DCPower.' + }, 'name': 'instrumentDriverRevision', - 'type': 'ViChar[]', -'documentation': { -'description': 'Returns the driver revision information for NI-DCPower.', -}, + 'size': { + 'mechanism': 'fixed', + 'value': '256' + }, + 'type': 'ViChar[]' }, { 'direction': 'out', + 'documentation': { + 'description': '\nReturns firmware revision information for the device you are using. The\nsize of this array must be at least 256 bytes.\n' + }, 'name': 'firmwareRevision', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Returns firmware revision information for the device you are using. The -size of this array must be at least 256 bytes. -''', -}, - }, + 'size': { + 'mechanism': 'fixed', + 'value': '256' + }, + 'type': 'ViChar[]' + } ], -'documentation': { -'description': 'Returns the revision information of NI-DCPower and the device firmware.', -}, + 'returns': 'ViStatus' }, 'self_test': { - 'returns': 'ViStatus', + 'codegen_method': 'private', + 'documentation': { + 'description': '\nPerforms the device self-test routine and returns the test result(s).\nCalling this function implicitly calls the niDCPower_reset function.\n\nWhen calling niDCPower_self_test with the PXIe-4162/4163, specify all\nchannels of your PXIe-4162/4163 with the channels input of\nniDCPower_InitializeWithChannels. You cannot self test a subset of\nPXIe-4162/4163 channels.\n' + }, + 'method_name_for_documentation': 'self_test', 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n' + }, 'name': 'vi', - 'type': 'ViSession', -'documentation': { -'description': ''' -Identifies a particular instrument session. **vi** is obtained from the -niDCPower_InitializeWithChannels function. -''', -}, + 'type': 'ViSession' }, { 'direction': 'out', + 'documentation': { + 'description': 'Returns the value result from the device self-test.', + 'table_body': [ + [ + '0', + 'Self test passed.' + ], + [ + '1', + 'Self test failed.' + ] + ], + 'table_header': [ + 'Self-Test Code', + 'Description' + ] + }, 'name': 'selfTestResult', - 'type': 'ViInt16', -'documentation': { -'description': 'Returns the value result from the device self-test.', -'table_body': [['0', 'Self test passed.'], ['1', 'Self test failed.']], -'table_header': ['Self-Test Code', 'Description'], -}, + 'type': 'ViInt16' }, { 'direction': 'out', + 'documentation': { + 'description': '\nReturns the self-test result message. The size of this array must be at\nleast 256 bytes.\n' + }, 'name': 'selfTestMessage', - 'type': 'ViChar[]', -'documentation': { -'description': ''' -Returns the self-test result message. The size of this array must be at -least 256 bytes. -''', -}, - }, - ], -'documentation': { -'description': ''' -Performs the device self-test routine and returns the test result(s). -Calling this function implicitly calls the niDCPower_reset function. - -When calling niDCPower_self_test with the PXIe-4162/4163, specify all -channels of your PXIe-4162/4163 with the channels input of -niDCPower_InitializeWithChannels. You cannot self test a subset of -PXIe-4162/4163 channels. -''', -}, - }, + 'size': { + 'mechanism': 'fixed', + 'value': 256 + }, + 'type': 'ViChar[]' + } + ], + 'returns': 'ViStatus' + } } diff --git a/src/nidcpower/metadata/functions_addon.py b/src/nidcpower/metadata/functions_addon.py index df741df45..2725caab2 100644 --- a/src/nidcpower/metadata/functions_addon.py +++ b/src/nidcpower/metadata/functions_addon.py @@ -4,442 +4,50 @@ # By default all functions in functions.py are "public". # This will override that with private (prefixes name with '_'), or don't generate at all functions_codegen_method = { - 'InitializeWithChannels': { 'codegen_method': 'private', 'method_name_for_documentation': '__init__', }, - 'InitWithOptions': { 'codegen_method': 'no', }, - 'Initiate': { 'codegen_method': 'private', 'method_name_for_documentation': 'initiate', }, - 'close': { 'codegen_method': 'private', }, - '.etAttribute.+': { 'codegen_method': 'private', }, # All Set/Get Attribute functions are private - 'init': { 'codegen_method': 'no', }, - 'error_message': { 'codegen_method': 'private', }, - 'GetError': { 'codegen_method': 'private', }, - 'ClearError': { 'codegen_method': 'no', }, - 'ChangeExtCalPassword': { 'codegen_method': 'no', }, # External Calibration is not supported by the Python API - 'CloseExtCal': { 'codegen_method': 'no', }, # External Calibration is not supported by the Python API - 'InitExtCal': { 'codegen_method': 'no', }, # External Calibration is not supported by the Python API - 'CalAdjust.+': { 'codegen_method': 'no', }, # External Calibration is not supported by the Python API - 'ConnectInternalReference': { 'codegen_method': 'no', }, # External Calibration is not supported by the Python API - '.+UserDefined.+': { 'codegen_method': 'no', }, - 'SetAttributeViSession': { 'codegen_method': 'no', }, - 'GetAttributeViSession': { 'codegen_method': 'no', }, - 'GetNextInterchangeWarning': { 'codegen_method': 'no', }, # Not applicable to Python API - 'ResetInterchangeCheck': { 'codegen_method': 'no', }, # Not applicable to Python API - 'ClearInterchangeWarnings': { 'codegen_method': 'no', }, # Not applicable to Python API - 'GetNextCoercionRecord': { 'codegen_method': 'no', }, # Not applicable to Python API - 'ConfigureAutoZero': { 'codegen_method': 'no', }, - 'ConfigureCurrent.+': { 'codegen_method': 'no', }, - 'ConfigureOutput.+': { 'codegen_method': 'no', }, - 'ConfigurePowerLineFrequency': { 'codegen_method': 'no', }, - 'ConfigurePulse.+': { 'codegen_method': 'no', }, - 'ConfigureSense': { 'codegen_method': 'no', }, - 'ConfigureVoltageL.+': { 'codegen_method': 'no', }, - 'ConfigureSourceMode': { 'codegen_method': 'no', }, - 'ConfigureSoftwareEdge.+Trigger': { 'codegen_method': 'no', }, - 'Disable.+Trigger': { 'codegen_method': 'no', }, - 'revision_query': { 'codegen_method': 'no', }, - 'ExportSignal': { 'codegen_method': 'no', }, # remove export signal #828 - 'GetExtCalLastDateAndTime': { 'codegen_method': 'private', 'method_name_for_documentation': 'get_ext_cal_last_date_and_time', }, # 'GetLastExtCalLastDateAndTime' Public wrapper to allow datetime - 'GetSelfCalLastDateAndTime': { 'codegen_method': 'private', 'method_name_for_documentation': 'get_self_cal_last_date_and_time', }, # 'GetLastSelfCalLastDateAndTime' Public wrapper to allow datetime - 'FetchMultiple': { 'codegen_method': 'private', 'method_name_for_documentation': 'fetch_multiple', }, # 'FancyFetchMultiple' Public wrapper - 'MeasureMultiple': { 'codegen_method': 'private', 'method_name_for_documentation': 'measure_multiple', }, # 'FancyMeasureMultiple' Public wrapper - 'self_test': { 'codegen_method': 'private', 'method_name_for_documentation': 'self_test', }, # 'fancy_self_test' Public wrapper that raises - 'CreateAdvancedSequence': { 'codegen_method': 'private', }, # Advanced sequence private until #504 has a fix - 'CreateAdvancedSequenceStep': { 'codegen_method': 'private', }, # Advanced sequence private until #504 has a fix - 'DeleteAdvancedSequence': { 'codegen_method': 'private', }, # Advanced sequence private until #504 has a fix - 'ConfigureDigitalEdgeMeasureTrigger': { 'codegen_method': 'no', }, # Removed - use attributes session.digital_edge_measure_trigger_edge & session.digital_edge_measure_trigger_input_terminal #860 - 'ConfigureDigitalEdgePulseTrigger': { 'codegen_method': 'no', }, # Removed - use attributes session.digital_edge_pulse_trigger_edge & session.digital_edge_pulse_trigger_input_terminal #860 - 'ConfigureDigitalEdgeSequenceAdvanceTrigger': { 'codegen_method': 'no', }, # Removed - use attributes session.digital_edge_sequence_advance_trigger_edge & session.digital_edge_sequence_advance_trigger_input_terminal #860 - 'ConfigureDigitalEdgeSourceTrigger': { 'codegen_method': 'no', }, # Removed - use attributes session.digital_edge_source_trigger_edge & session.digital_edge_source_trigger_input_terminal #860 - 'ConfigureDigitalEdgeStartTrigger': { 'codegen_method': 'no', }, # Removed - use attributes session.digital_edge_start_trigger_edge & session.digital_edge_start_trigger_input_terminal #860 } functions_locking = { - 'LockSession': { 'method_templates': [ { 'session_filename': 'lock', 'documentation_filename': 'lock', 'method_python_name_suffix': '', }, ], - 'render_in_session_base': True, - 'use_session_lock': False, - 'python_name': 'lock', }, - 'UnlockSession': { 'method_templates': [ { 'session_filename': 'unlock', 'documentation_filename': 'unlock', 'method_python_name_suffix': '', }, ], - 'render_in_session_base': True, - 'use_session_lock': False, - 'python_name': 'unlock', }, - 'InitializeWithChannels': { 'use_session_lock': False, }, # Session not valid during complete function call so cannot use session locking - 'close': { 'use_session_lock': False, }, # Session not valid during complete function call so cannot use session locking - 'error_message': { 'use_session_lock': False, }, # No Session for function call so cannot use session locking - 'GetError': { 'use_session_lock': False, }, # Session may not be valid during function call so cannot use session locking } # Attach the given parameter to the given enum from enums.py functions_enums = { - 'ConfigureAutoZero': { 'parameters': { 2: { 'enum': 'AutoZero', }, }, }, - 'ConfigureApertureTime': { 'parameters': { 3: { 'enum': 'ApertureTimeUnits', }, }, }, - 'SendSoftwareEdgeTrigger': { 'parameters': { 1: { 'enum': 'SendSoftwareEdgeTriggerType', }, }, }, - 'WaitForEvent': { 'parameters': { 1: { 'enum': 'Event', }, }, }, - 'Measure': { 'parameters': { 2: { 'enum': 'MeasurementTypes', }, }, }, - 'QueryOutputState': { 'parameters': { 2: { 'enum': 'OutputStates', }, }, }, - 'ExportSignal': { 'parameters': { 1: { 'enum': 'ExportSignal', }, }, }, - # @TODO add all enums } # This is the additional metadata needed by the code generator in order create code that can properly handle buffer allocation. functions_buffer_info = { - 'GetError': { 'parameters': { 3: { 'size': {'mechanism':'ivi-dance', 'value':'BufferSize'}, }, }, }, - 'self_test': { 'parameters': { 2: { 'size': {'mechanism':'fixed', 'value':256}, }, }, }, # From documentation - 'GetAttributeViString': { 'parameters': { 4: { 'size': {'mechanism':'ivi-dance', 'value':'bufferSize'}, }, }, }, - 'GetCalUserDefinedInfo': { 'parameters': { 1: { 'size': {'mechanism':'fixed', 'value':256}, }, }, }, # From LabVIEW VI, even though niDMM_GetCalUserDefinedInfoMaxSize() exists. - 'error_message': { 'parameters': { 2: { 'size': {'mechanism':'fixed', 'value':256}, }, }, }, # From documentation - 'GetChannelName': { 'parameters': { 3: { 'size': {'mechanism':'ivi-dance', 'value':'bufferSize'}, }, }, }, - 'SetSequence': { 'parameters': { 2: { 'size': {'mechanism':'len', 'value':'Size'}, }, - 3: { 'size': {'mechanism':'len', 'value':'Size'}, }, }, }, - 'CreateAdvancedSequence': { 'parameters': { 3: { 'size': {'mechanism':'len', 'value':'attributeIdCount'}, }, }, }, - 'FetchMultiple': { 'parameters': { 4: { 'size': {'mechanism':'passed-in', 'value':'Count'}, }, - 5: { 'size': {'mechanism':'passed-in', 'value':'Count'}, }, - 6: { 'size': {'mechanism':'passed-in', 'value':'Count'}, }, }, }, - 'MeasureMultiple': { 'parameters': { 2: { 'size': {'mechanism':'python-code', 'value':'self._parse_channel_count()'}, }, - 3: { 'size': {'mechanism':'python-code', 'value':'self._parse_channel_count()'}, }, }, }, - 'ExportAttributeConfigurationBuffer': { 'parameters': { 2: { 'size': {'mechanism':'ivi-dance', 'value':'Size'}, }, }, }, - 'ImportAttributeConfigurationBuffer': { 'parameters': { 2: { 'size': {'mechanism':'len', 'value':'Size'}, }, }, }, } # These are functions we mark as "error_handling":True. The generator uses this information to # change how error handling is done within those functions themselves - basically, if an error occurs, # dont try to handle it, since the functions are only used within the context of error handling. functions_is_error_handling = { - 'error_message': { 'is_error_handling': True }, - 'GetError': { 'is_error_handling': True }, } # There are some parameters that are needed in the C function call we use under the hood, but that we do not want in the Python API functions_remove_from_python_api = { - 'FetchMultiple': { 'parameters': { 7: { 'use_in_python_api': False, }, }, }, } # Default values for method parameters functions_default_value = { - 'InitializeWithChannels': { 'parameters': { 1: { 'default_value': None, }, - 2: { 'default_value': False, }, - 3: { 'default_value': '""', }, }, }, - 'ConfigureApertureTime': { 'parameters': { 3: { 'default_value': 'ApertureTimeUnits.SECONDS', }, }, }, - 'CreateAdvancedSequence': { 'parameters': { 4: { 'default_value': True, }, }, }, - 'CreateAdvancedSequenceStep': { 'parameters': { 1: { 'default_value': True, }, }, }, - 'ExportSignal': { 'parameters': { 2: { 'default_value': '""', }, }, }, - 'WaitForEvent': { 'parameters': { 2: { 'default_value': 'datetime.timedelta(seconds=10.0)', },}, }, - 'FancyFetchMultiple': { 'parameters': { 3: { 'default_value': 'datetime.timedelta(seconds=1.0)', }, }, }, } # Parameter that need to be array.array functions_array = { - 'FetchMultiple': { 'parameters': { 4: { 'use_array': True, }, - 5: { 'use_array': True, }, }, }, - 'MeasureMultiple': { 'parameters': { 2: { 'use_array': True, }, - 3: { 'use_array': True, }, }, }, } # We want to use a common name for self_cal across all drivers functions_name = { - 'CalSelfCalibrate': { 'python_name': 'self_cal', }, } # Functions not in original metadata. functions_additional_functions = { - # What is this function? I've never seen it in niDCPower.h! - # It's a secret, undocumented NI-DCPower function and the key to the Python API figuring out how many points to return from nidcpower.Session.measure_multiple. - # Don't tell anyone about it, and don't ever use it directly in your programs. Thank you. - 'ParseChannelCount': { - 'codegen_method': 'private', - 'returns': 'ViStatus', - 'parameters': [ - { - 'direction': 'in', - 'name': 'vi', - 'type': 'ViSession', - }, - { - 'direction': 'in', - 'name': 'channelsString', - 'type': 'ViConstString', - }, - { - 'direction': 'out', - 'name': 'numberOfChannels', - 'type': 'ViUInt32', - }, - ], - 'documentation': { - 'description': 'Returns the number of channels.', - }, - }, - # Public function that wraps self_test and will raise on self test failure - 'fancy_self_test': { - 'returns': 'ViStatus', - 'codegen_method': 'python-only', - 'python_name': 'self_test', - 'method_templates': [ - { 'session_filename': 'fancy_self_test', 'documentation_filename': 'default_method', 'method_python_name_suffix': '', }, - ], - 'parameters': [ - { - 'direction': 'in', - 'name': 'vi', - 'type': 'ViSession', - 'documentation': { - 'description': 'Identifies a particular instrument session. **vi** is obtained from the niDCPower_InitializeWithChannels function.', - }, - }, - ], - 'documentation': { - 'description': ''' -Performs the device self-test routine and returns the test result(s). -Calling this function implicitly calls the niDCPower_reset function. - -When calling niDCPower_self_test with the PXIe-4162/4163, specify all -channels of your PXIe-4162/4163 with the channels input of -niDCPower_InitializeWithChannels. You cannot self test a subset of -PXIe-4162/4163 channels. - -Raises `SelfTestError` on self test failure. Attributes on exception object: - -- code - failure code from driver -- message - status message from driver -''', - 'table_body': [['0', 'Self test passed.'], ['1', 'Self test failed.']], - 'table_header': ['Self-Test Code', 'Description'], - }, - }, - 'FancyFetchMultiple': { - 'returns': 'ViStatus', - 'codegen_method': 'python-only', - 'python_name': 'fetch_multiple', - 'method_templates': [ - { 'session_filename': 'fancy_fetch', 'documentation_filename': 'default_method', 'method_python_name_suffix': '', }, - ], - 'parameters': [ - { - 'direction': 'in', - 'name': 'vi', - 'type': 'ViSession', - 'documentation': { - 'description': 'Identifies a particular instrument session. **vi** is obtained from the niDCPower_InitializeWithChannels function.', - }, - }, - { - 'direction': 'in', - 'name': 'channelName', - 'type': 'ViChar[]', - 'documentation': { - 'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', - }, - }, - { - 'direction': 'in', - 'name': 'Count', - 'type': 'ViInt32', - 'documentation': { - 'description': 'Specifies the number of measurements to fetch.', - }, - }, - { - 'direction': 'in', - 'name': 'Timeout', - 'type': 'ViReal64', - 'documentation': { - 'description': 'Specifies the maximum time allowed for this function to complete. If the function does not complete within this time interval, NI-DCPower returns an error.', - 'note': 'When setting the timeout interval, ensure you take into account any triggers so that the timeout interval is long enough for your application.', - }, - }, - { - 'direction': 'out', - 'name': 'measurements', - 'type': 'ViReal64[]', - 'python_type': 'Measurement', - 'documentation': { - 'description': ''' -List of named tuples with fields: - -- **voltage** (float) -- **current** (float) -- **in_compliance** (bool) -''', - }, - }, - ], - 'documentation': { - 'description': ''' -Returns a list of named tuples (Measurement) that were -previously taken and are stored in the NI-DCPower buffer. This function -should not be used when the NIDCPOWER_ATTR_MEASURE_WHEN attribute is -set to NIDCPOWER_VAL_ON_DEMAND. You must first call -niDCPower_Initiate before calling this function. - -Fields in Measurement: - -- **voltage** (float) -- **current** (float) -- **in_compliance** (bool) - -''', - 'note': 'This function is not supported on all devices. Refer to `Supported Functions by Device `__ for more information about supported devices.', - }, - }, - 'FancyMeasureMultiple': { - 'returns': 'ViStatus', - 'codegen_method': 'python-only', - 'python_name': 'measure_multiple', - 'method_templates': [ - { 'session_filename': 'fancy_fetch', 'documentation_filename': 'default_method', 'method_python_name_suffix': '', }, - ], - 'parameters': [ - { - 'direction': 'in', - 'name': 'vi', - 'type': 'ViSession', - 'documentation': { - 'description': 'Identifies a particular instrument session. **vi** is obtained from the niDCPower_InitializeWithChannels function.', - }, - }, - { - 'direction': 'in', - 'name': 'channelName', - 'type': 'ViChar[]', - 'documentation': { - 'description': ''' -Specifies the output channel(s) to which this configuration value -applies. Specify multiple channels by using a channel list or a channel -range. A channel list is a comma (,) separated sequence of channel names -(for example, 0,2 specifies channels 0 and 2). A channel range is a -lower bound channel followed by a hyphen (-) or colon (:) followed by an -upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). -In the Running state, multiple output channel configurations are -performed sequentially based on the order specified in this parameter. -''', - }, - }, - { - 'direction': 'out', - 'name': 'measurements', - 'type': 'ViReal64[]', - 'python_type': 'Measurement', - 'documentation': { - 'description': ''' -List of named tuples with fields: - -- **voltage** (float) -- **current** (float) -- **in_compliance** (bool) - Always None -''', - }, - }, - ], - 'documentation': { - 'description': ''' -Returns a list of named tuples (Measurement) containing the measured voltage -and current values on the specified output channel(s). Each call to this function -blocks other function calls until the measurements are returned from the device. -The order of the measurements returned in the array corresponds to the order -on the specified output channel(s). - -Fields in Measurement: - -- **voltage** (float) -- **current** (float) -- **in_compliance** (bool) - Always None - -''', - 'note': 'This function is not supported on all devices. Refer to `Supported Functions by Device `__ for more information about supported devices.', - }, - }, - # Public function that wraps driver function but returns datetime object instead of individual items - 'GetLastExtCalLastDateAndTime': { - 'codegen_method': 'python-only', - 'returns': 'ViStatus', - 'python_name': 'get_ext_cal_last_date_and_time', - 'real_datetime_call': 'GetExtCalLastDateAndTime', - 'method_templates': [ - { 'session_filename': 'datetime_wrappers', 'documentation_filename': 'default_method', 'method_python_name_suffix': '', }, - ], - 'parameters': [ - { - 'direction': 'in', - 'name': 'vi', - 'type': 'ViSession', - 'documentation': { - 'description': 'Identifies a particular instrument session. **vi** is obtained from the niDCPower_InitExtCal or niDCPower_InitializeWithChannels function.', - }, - }, - { - 'direction': 'out', - 'name': 'Month', - 'type': 'datetime.datetime', - 'documentation': { - 'description': 'Indicates date and time of the last calibration.', - }, - }, - ], - 'documentation': { - 'description': 'Returns the date and time of the last successful calibration.', - }, - }, - 'GetLastSelfCalLastDateAndTime': { - 'codegen_method': 'python-only', - 'returns': 'ViStatus', - 'python_name': 'get_self_cal_last_date_and_time', - 'real_datetime_call': 'GetSelfCalLastDateAndTime', - 'method_templates': [ - { 'session_filename': 'datetime_wrappers', 'documentation_filename': 'default_method', 'method_python_name_suffix': '', }, - ], - 'parameters': [ - { - 'direction': 'in', - 'name': 'vi', - 'type': 'ViSession', - 'documentation': { - 'description': 'Identifies a particular instrument session. **vi** is obtained from the niDCPower_InitExtCal or niDCPower_InitializeWithChannels function.', - }, - }, - { - 'direction': 'out', - 'name': 'Month', - 'type': 'datetime.datetime', - 'documentation': { - 'description': 'Returns the date and time the device was last calibrated.', - }, - }, - ], - 'documentation': - { - 'description': 'Returns the date and time of the oldest successful self-calibration from among the channels in the session.', - 'note': 'This function is not supported on all devices.', - }, - }, } # Converted parameters functions_converters = { - 'FetchMultiple': { 'parameters': { 2: { 'python_api_converter_name': 'convert_timedelta_to_seconds', - 'type_in_documentation': 'float in seconds or datetime.timedelta', }, }, }, - 'FancyFetchMultiple': { 'parameters': { 3: { 'python_api_converter_name': 'convert_timedelta_to_seconds', - 'type_in_documentation': 'float in seconds or datetime.timedelta', }, }, }, - 'WaitForEvent': { 'parameters': { 2: { 'python_api_converter_name': 'convert_timedelta_to_seconds', - 'type_in_documentation': 'float in seconds or datetime.timedelta', }, }, }, - 'InitializeWithChannels': { 'parameters': { 3: { 'python_api_converter_name': 'convert_init_with_options_dictionary', - 'type_in_documentation': 'dict', }, - 1: { 'is_repeated_capability': False, - 'python_api_converter_name': 'convert_repeated_capabilities_from_init', - 'type_in_documentation': 'str, list, range, tuple', }, }, }, - 'GetExtCalRecommendedInterval': { 'parameters': { 1: { 'python_api_converter_name': 'convert_month_to_timedelta', - 'type_in_documentation': 'datetime.timedelta', }, }, }, } # The extracted metadata is incorrect. Patch it here. functions_bad_source_metadata = { - 'ExportAttributeConfigurationBuffer': { 'parameters': { 2: { 'direction': 'out', 'type': 'ViInt8[]'}, }, }, - 'ImportAttributeConfigurationBuffer': { 'parameters': { 2: { 'type': 'ViInt8[]'}, }, }, }