Enums used in NI-DCPower
.. py:currentmodule:: nidcpower
.. py:class:: ApertureTimeAutoMode
.. py:attribute:: ApertureTimeAutoMode.OFF
Disables automatic aperture time scaling. The :py:attr:`nidcpower.Session.aperture_time` property specifies the aperture time for all ranges.
.. py:attribute:: ApertureTimeAutoMode.SHORT
Prioritizes measurement speed over measurement accuracy by quickly scaling down aperture time in larger current ranges. The :py:attr:`nidcpower.Session.aperture_time` property specifies the aperture time for the minimum range.
.. py:attribute:: ApertureTimeAutoMode.NORMAL
Balances measurement accuracy and speed by scaling down aperture time in larger current ranges. The :py:attr:`nidcpower.Session.aperture_time` property specifies the aperture time for the minimum range.
.. py:attribute:: ApertureTimeAutoMode.LONG
Prioritizes accuracy while still decreasing measurement time by slowly scaling down aperture time in larger current ranges. The :py:attr:`nidcpower.Session.aperture_time` property specifies the aperture time for the minimum range.
.. py:class:: ApertureTimeUnits
.. py:attribute:: ApertureTimeUnits.SECONDS
Specifies aperture time in seconds.
.. py:attribute:: ApertureTimeUnits.POWER_LINE_CYCLES
Specifies aperture time in power line cycles (PLCs).
.. py:class:: AutoZero
.. py:attribute:: AutoZero.OFF
Disables auto zero.
.. py:attribute:: AutoZero.ONCE
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.
.. py:attribute:: AutoZero.ON
Makes zero conversions for every measurement.
.. py:class:: AutorangeApertureTimeMode
.. py:attribute:: AutorangeApertureTimeMode.AUTO
NI-DCPower optimizes the aperture time for the autorange algorithm based on the module range.
.. py:attribute:: AutorangeApertureTimeMode.CUSTOM
The user specifies a minimum aperture time for the algorithm using the :py:attr:`nidcpower.Session.autorange_minimum_aperture_time` property and the corresponding :py:attr:`nidcpower.Session.autorange_minimum_aperture_time_units` property.
.. py:class:: AutorangeBehavior
.. py:attribute:: AutorangeBehavior.UP_TO_LIMIT_THEN_DOWN
Go to limit range then range down as needed until measured value is within thresholds.
.. py:attribute:: AutorangeBehavior.UP
go up one range when the upper threshold is reached.
.. py:attribute:: AutorangeBehavior.UP_AND_DOWN
go up or down one range when the upper/lower threshold is reached.
.. py:class:: AutorangeThresholdMode
.. py:attribute:: AutorangeThresholdMode.NORMAL
Thresholds are selected based on a balance between accuracy and hysteresis.
.. py:attribute:: AutorangeThresholdMode.FAST_STEP
Optimized for faster changes in the measured signal. Thresholds are configured to be a smaller percentage of the range.
.. py:attribute:: AutorangeThresholdMode.HIGH_HYSTERESIS
Optimized for noisy signals to minimize frequent and unpredictable range changes. Thresholds are configured to be a larger percentage of the range.
.. py:attribute:: AutorangeThresholdMode.MEDIUM_HYSTERESIS
Optimized for noisy signals to minimize frequent and unpredictable range changes. Thresholds are configured to be a medium percentage of the range.
.. py:attribute:: AutorangeThresholdMode.HOLD
Attempt to maintain the active range. Thresholds will favor the active range.
.. py:class:: CableLength
.. py:attribute:: CableLength.ZERO_M
Uses predefined cable compensation data for a 0m cable (direct connection).
.. py:attribute:: CableLength.NI_STANDARD_0_5M
Uses predefined cable compensation data for an NI standard 0.5m coaxial cable.
.. py:attribute:: CableLength.NI_STANDARD_1M
Uses predefined cable compensation data for an NI standard 1m coaxial cable.
.. py:attribute:: CableLength.NI_STANDARD_2M
Uses predefined cable compensation data for an NI standard 2m coaxial cable.
.. py:attribute:: CableLength.NI_STANDARD_4M
Uses predefined cable compensation data for an NI standard 4m coaxial cable.
.. py:attribute:: CableLength.NI_STANDARD_TRIAXIAL_1M
Uses predefined cable compensation data for an NI standard 1m triaxial cable.
.. py:attribute:: CableLength.NI_STANDARD_TRIAXIAL_2M
Uses predefined cable compensation data for an NI standard 2m triaxial cable.
.. py:attribute:: CableLength.NI_STANDARD_TRIAXIAL_4M
Uses predefined cable compensation data for an NI standard 4m triaxial cable.
.. py:attribute:: CableLength.CUSTOM_ONBOARD_STORAGE
Uses previously generated custom cable compensation data from onboard storage. Only the most recently performed compensation data for each custom cable compensation type (open, short) is stored.
.. py:attribute:: CableLength.CUSTOM_AS_CONFIGURED
Uses the custom cable compensation data supplied to :py:meth:`nidcpower.Session.configure_lcr_custom_cable_compensation`. Use this option to manage multiple sets of custom cable compensation data.
.. py:class:: ComplianceLimitSymmetry
.. py:attribute:: ComplianceLimitSymmetry.SYMMETRIC
Compliance limits are specified symmetrically about 0.
.. py:attribute:: ComplianceLimitSymmetry.ASYMMETRIC
Compliance limits can be specified asymmetrically with respect to 0.
.. py:class:: ConductionVoltageMode
.. py:attribute:: ConductionVoltageMode.AUTOMATIC
The conduction voltage feature is only enabled when you set the :py:attr:`nidcpower.Session.output_function` property to :py:data:`~nidcpower.OutputFunction.DC_CURRENT`.
.. py:attribute:: ConductionVoltageMode.ENABLED
The conduction voltage feature is enabled.
.. py:attribute:: ConductionVoltageMode.DISABLED
The conduction voltage feature is disabled.
.. py:class:: CurrentLimitBehavior
.. py:attribute:: CurrentLimitBehavior.REGULATE
The channel acts to restrict the output current to the value of the Current Limit property when the actual output on the channel reaches or exceeds that value.
.. py:attribute:: CurrentLimitBehavior.TRIP
The channel disables the output when the actual output current on the channel reaches or exceeds the value of the Current Limit property.
.. py:class:: DCNoiseRejection
.. py:attribute:: DCNoiseRejection.SECOND_ORDER
Second-order rejection of DC noise.
.. py:attribute:: DCNoiseRejection.NORMAL
Normal rejection of DC noise.
.. py:class:: Event
.. py:attribute:: Event.SOURCE_COMPLETE
Specifies the Source Complete event.
.. py:attribute:: Event.MEASURE_COMPLETE
Specifies the Measure Complete event.
.. py:attribute:: Event.SEQUENCE_ITERATION_COMPLETE
Specifies the Sequence Iteration Complete event.
.. py:attribute:: Event.SEQUENCE_ENGINE_DONE
Specifies the Sequence Engine Done event.
.. py:attribute:: Event.PULSE_COMPLETE
Specifies the Pulse Complete event.
.. py:attribute:: Event.READY_FOR_PULSE_TRIGGER
Specifies the Ready for Pulse Trigger event.
.. py:class:: EventOutputBehavior
.. py:attribute:: EventOutputBehavior.PULSE
Output generates a pulse when the event is triggered.
.. py:attribute:: EventOutputBehavior.TOGGLE
Output toggles state when the event is triggered.
.. py:class:: EventToggleInitialState
.. py:attribute:: EventToggleInitialState.LOW
The initial state is low.
.. py:attribute:: EventToggleInitialState.HIGH
The initial state is high.
.. py:class:: InstrumentMode
.. py:attribute:: InstrumentMode.SMU_PS
The channel operates as an SMU/power supply.
.. py:attribute:: InstrumentMode.LCR
The channel operates as an LCR meter.
.. py:attribute:: InstrumentMode.E_LOAD
The channel operates as an electronic load (E-Load).
.. py:class:: LCRCompensationType
.. py:attribute:: LCRCompensationType.OPEN
Open LCR compensation.
.. py:attribute:: LCRCompensationType.SHORT
Short LCR compensation.
.. py:attribute:: LCRCompensationType.LOAD
Load LCR compensation.
.. py:attribute:: LCRCompensationType.OPEN_CUSTOM_CABLE
Open custom cable compensation.
.. py:attribute:: LCRCompensationType.SHORT_CUSTOM_CABLE
Short custom cable compensation.
.. py:class:: LCRDCBiasSource
.. py:attribute:: LCRDCBiasSource.OFF
Disables DC bias in LCR mode.
.. py:attribute:: LCRDCBiasSource.VOLTAGE
Applies a constant voltage bias, as defined by the :py:attr:`nidcpower.Session.lcr_dc_bias_voltage_level` property.
.. py:attribute:: LCRDCBiasSource.CURRENT
Applies a constant current bias, as defined by the :py:attr:`nidcpower.Session.lcr_dc_bias_current_level` property.
.. py:class:: LCRDCBiasTransientResponse
.. py:attribute:: LCRDCBiasTransientResponse.NORMAL
NI-DCPower automatically applies transient response values for DC bias.
.. py:attribute:: LCRDCBiasTransientResponse.CUSTOM
NI-DCPower applies the transient response that you set manually with :py:attr:`nidcpower.Session.transient_response` for DC bias. Search ni.com for information on configuring transient response.
.. py:class:: LCRImpedanceRangeSource
.. py:attribute:: LCRImpedanceRangeSource.IMPEDANCE_RANGE
Uses the impedance range you specify with the :py:attr:`nidcpower.Session.lcr_impedance_range` property.
.. py:attribute:: LCRImpedanceRangeSource.LOAD_CONFIGURATION
Computes the impedance range to select based on the values you supply to the :py:attr:`nidcpower.Session.lcr_load_resistance`, :py:attr:`nidcpower.Session.lcr_load_inductance`, and :py:attr:`nidcpower.Session.lcr_load_capacitance` properties. NI-DCPower uses a series model of load resistance, load inductance, and load capacitance to compute the impedance range.
.. py:class:: LCRMeasurementTime
.. py:attribute:: LCRMeasurementTime.SHORT
Uses a short aperture time for LCR measurements.
.. py:attribute:: LCRMeasurementTime.MEDIUM
Uses a medium aperture time for LCR measurements.
.. py:attribute:: LCRMeasurementTime.LONG
Uses a long aperture time for LCR measurements.
.. py:attribute:: LCRMeasurementTime.CUSTOM
Uses a custom aperture time for LCR measurements as specified by the :py:attr:`nidcpower.Session.lcr_custom_measurement_time` property.
.. py:class:: LCROpenShortLoadCompensationDataSource
.. py:attribute:: LCROpenShortLoadCompensationDataSource.ONBOARD_STORAGE
Uses previously generated LCR compensation data. Only the most recently performed compensation data for each LCR compensation type (open, short, and load) is stored.
.. py:attribute:: LCROpenShortLoadCompensationDataSource.AS_DEFINED
Uses the LCR compensation data represented by the relevant LCR compensation properties as generated by :py:meth:`nidcpower.Session.perform_lcr_open_compensation`, :py:meth:`nidcpower.Session.perform_lcr_short_compensation`, and :py:meth:`nidcpower.Session.perform_lcr_load_compensation`. Use this option to manage multiple sets of LCR compensation data. This option applies compensation data from the following properties: :py:attr:`nidcpower.Session.lcr_open_conductance`, :py:attr:`nidcpower.Session.lcr_open_susceptance`, :py:attr:`nidcpower.Session.lcr_short_resistance`, :py:attr:`nidcpower.Session.lcr_short_reactance`, :py:attr:`nidcpower.Session.lcr_measured_load_resistance`, :py:attr:`nidcpower.Session.lcr_measured_load_reactance`, :py:attr:`nidcpower.Session.lcr_actual_load_resistance`, :py:attr:`nidcpower.Session.lcr_actual_load_reactance`.
.. py:attribute:: LCROpenShortLoadCompensationDataSource.AS_CONFIGURED
Uses the LCR compensation data supplied to :py:meth:`nidcpower.Session.configure_lcr_compensation`. Use this option to manage multiple sets of LCR compensation data.
.. py:class:: LCRReferenceValueType
.. py:attribute:: LCRReferenceValueType.IMPEDANCE
The actual impedance, comprising real resistance and imaginary reactance, of your DUT. Supply resistance, in ohms, to reference value A; supply reactance, in ohms, to reference value B.
.. py:attribute:: LCRReferenceValueType.IDEAL_CAPACITANCE
The ideal capacitance of your DUT. Supply capacitance, in farads, to reference value A.
.. py:attribute:: LCRReferenceValueType.IDEAL_INDUCTANCE
The ideal inductance of your DUT. Supply inductance, in henrys, to reference value A.
.. py:attribute:: LCRReferenceValueType.IDEAL_RESISTANCE
The ideal resistance of your DUT. Supply resistance, in ohms, to reference value A.
.. py:class:: LCRSourceDelayMode
.. py:attribute:: LCRSourceDelayMode.AUTOMATIC
NI-DCPower automatically applies source delay of sufficient duration to account for settling time.
.. py:attribute:: LCRSourceDelayMode.MANUAL
NI-DCPower applies the source delay that you set manually with :py:attr:`nidcpower.Session.source_delay`. You can use this option to set a shorter delay to reduce measurement time at the possible expense of measurement accuracy.
.. py:class:: LCRStimulusFunction
.. py:attribute:: LCRStimulusFunction.VOLTAGE
Applies an AC voltage for LCR stimulus.
.. py:attribute:: LCRStimulusFunction.CURRENT
Applies an AC current for LCR stimulus.
.. py:class:: MeasureWhen
.. py:attribute:: MeasureWhen.AUTOMATICALLY_AFTER_SOURCE_COMPLETE
Acquires a measurement after each Source Complete event completes.
.. py:attribute:: MeasureWhen.ON_DEMAND
Acquires a measurement when the :py:meth:`nidcpower.Session.measure` method or :py:meth:`nidcpower.Session.measure_multiple` method is called.
.. py:attribute:: MeasureWhen.ON_MEASURE_TRIGGER
Acquires a measurement when a Measure trigger is received.
.. py:class:: MeasurementTypes
.. py:attribute:: MeasurementTypes.CURRENT
The device measures current.
.. py:attribute:: MeasurementTypes.VOLTAGE
The device measures voltage.
.. py:class:: OutputCapacitance
.. py:attribute:: OutputCapacitance.LOW
Output Capacitance is low.
.. py:attribute:: OutputCapacitance.HIGH
Output Capacitance is high.
.. py:class:: OutputCutoffReason
.. py:attribute:: OutputCutoffReason.ALL
Queries any output cutoff condition; clears all output cutoff conditions.
.. py:attribute:: OutputCutoffReason.VOLTAGE_OUTPUT_HIGH
Queries or clears cutoff conditions when the output exceeded the high cutoff limit for voltage output.
.. py:attribute:: OutputCutoffReason.VOLTAGE_OUTPUT_LOW
Queries or clears cutoff conditions when the output fell below the low cutoff limit for voltage output.
.. py:attribute:: OutputCutoffReason.CURRENT_MEASURE_HIGH
Queries or clears cutoff conditions when the measured current exceeded the high cutoff limit for current output.
.. py:attribute:: OutputCutoffReason.CURRENT_MEASURE_LOW
Queries or clears cutoff conditions when the measured current fell below the low cutoff limit for current output.
.. py:attribute:: OutputCutoffReason.VOLTAGE_CHANGE_HIGH
Queries or clears cutoff conditions when the voltage slew rate increased beyond the positive change cutoff for voltage output.
.. py:attribute:: OutputCutoffReason.VOLTAGE_CHANGE_LOW
Queries or clears cutoff conditions when the voltage slew rate decreased beyond the negative change cutoff for voltage output.
.. py:attribute:: OutputCutoffReason.CURRENT_CHANGE_HIGH
Queries or clears cutoff conditions when the current slew rate increased beyond the positive change cutoff for current output.
.. py:attribute:: OutputCutoffReason.CURRENT_CHANGE_LOW
Queries or clears cutoff conditions when the current slew rate decreased beyond the negative change cutoff for current output.
.. py:attribute:: OutputCutoffReason.CURRENT_SATURATED
Queries or clears cutoff conditions when the measured current saturates the current range.
.. py:attribute:: OutputCutoffReason.VOLTAGE_MEASURE_HIGH
Queries or clears cutoff conditions when the measured voltage exceeded the high cutoff limit for voltage output.
.. py:attribute:: OutputCutoffReason.VOLTAGE_MEASURE_LOW
Queries or clears cutoff conditions when the measured voltage fell below the low cutoff limit for voltage output.
.. py:class:: OutputFunction
.. py:attribute:: OutputFunction.DC_VOLTAGE
Sets the output method to DC voltage.
.. py:attribute:: OutputFunction.DC_CURRENT
Sets the output method to DC current.
.. py:attribute:: OutputFunction.PULSE_VOLTAGE
Sets the output method to pulse voltage.
.. py:attribute:: OutputFunction.PULSE_CURRENT
Sets the output method to pulse current.
.. py:class:: OutputStates
.. py:attribute:: OutputStates.VOLTAGE
The channel maintains a constant voltage by adjusting the current.
.. py:attribute:: OutputStates.CURRENT
The channel maintains a constant current by adjusting the voltage.
.. py:class:: Polarity
.. py:attribute:: Polarity.HIGH
A high pulse occurs when the event is generated. The exported signal is low level both before and after the event is generated.
.. py:attribute:: Polarity.LOW
A low pulse occurs when the event is generated. The exported signal is high level both before and after the event is generated.
.. py:class:: PowerAllocationMode
.. py:attribute:: PowerAllocationMode.DISABLED
The device attempts to source, on each active channel, the power that the present source configuration requires; NI-DCPower does not perform a sourcing power check. If the required power is greater than the maximum sourcing power, the device attempts to source the required amount and may shut down to prevent damage.
.. py:attribute:: PowerAllocationMode.AUTOMATIC
The device attempts to source, on each active channel, the power that the present source configuration requires; NI-DCPower performs a sourcing power check. If the required power is greater than the maximum sourcing power, the device does not exceed the maximum power, and NI-DCPower returns an error.
.. py:attribute:: PowerAllocationMode.MANUAL
The device attempts to source, on each active channel, the power you request with the :py:attr:`nidcpower.Session.requested_power_allocation` property; NI-DCPower performs a sourcing power check. If the requested power is either less than the required power for the present source configuration or greater than the maximum sourcing power, the device does not exceed the requested or allowed power, respectively, and NI-DCPower returns an error.
.. py:class:: PowerSource
.. py:attribute:: PowerSource.INTERNAL
Uses the PXI chassis power source.
.. py:attribute:: PowerSource.AUXILIARY
Uses the auxiliary power source connected to the device.
.. py:attribute:: PowerSource.AUTOMATIC
Uses the auxiliary power source if it is available; otherwise uses the PXI chassis power source.
.. py:class:: PowerSourceInUse
.. py:attribute:: PowerSourceInUse.INTERNAL
Uses the PXI chassis power source.
.. py:attribute:: PowerSourceInUse.AUXILIARY
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.
.. py:class:: SelfCalibrationPersistence
.. py:attribute:: SelfCalibrationPersistence.KEEP_IN_MEMORY
Keep new self calibration values in memory only.
.. py:attribute:: SelfCalibrationPersistence.WRITE_TO_EEPROM
Write new self calibration values to hardware.
.. py:class:: SendSoftwareEdgeTriggerType
.. py:attribute:: SendSoftwareEdgeTriggerType.START
Asserts the Start trigger.
.. py:attribute:: SendSoftwareEdgeTriggerType.SOURCE
Asserts the Source trigger.
.. py:attribute:: SendSoftwareEdgeTriggerType.MEASURE
Asserts the Measure trigger.
.. py:attribute:: SendSoftwareEdgeTriggerType.SEQUENCE_ADVANCE
Asserts the Sequence Advance trigger.
.. py:attribute:: SendSoftwareEdgeTriggerType.PULSE
Asserts the Pulse trigger.
.. py:attribute:: SendSoftwareEdgeTriggerType.SHUTDOWN
Asserts the Shutdown trigger.
.. py:class:: Sense
.. py:attribute:: Sense.LOCAL
Local sensing is selected.
.. py:attribute:: Sense.REMOTE
Remote sensing is selected.
.. py:class:: SourceMode
.. py:attribute:: SourceMode.SINGLE_POINT
The source unit applies a single source configuration.
.. py:attribute:: SourceMode.SEQUENCE
The source unit applies a list of voltage or current configurations sequentially.
.. py:class:: TransientResponse
.. py:attribute:: TransientResponse.NORMAL
The output responds to changes in load at a normal speed.
.. py:attribute:: TransientResponse.FAST
The output responds to changes in load quickly.
.. py:attribute:: TransientResponse.SLOW
The output responds to changes in load slowly.
.. py:attribute:: TransientResponse.CUSTOM
The output responds to changes in load based on specified values.
.. py:class:: TriggerType
.. py:attribute:: TriggerType.NONE
No trigger is configured.
.. py:attribute:: TriggerType.DIGITAL_EDGE
The data operation starts when a digital edge is detected.
.. py:attribute:: TriggerType.SOFTWARE_EDGE
The data operation starts when a software trigger occurs.