# Enums¶

Enums used in NI-DCPower

## ApertureTimeAutoMode¶

class nidcpower.ApertureTimeAutoMode
OFF

Disables automatic aperture time scaling. The nidcpower.Session.aperture_time property specifies the aperture time for all ranges.

SHORT

Prioritizes measurement speed over measurement accuracy by quickly scaling down aperture time in larger current ranges. The nidcpower.Session.aperture_time property specifies the aperture time for the minimum range.

NORMAL

Balances measurement accuracy and speed by scaling down aperture time in larger current ranges. The nidcpower.Session.aperture_time property specifies the aperture time for the minimum range.

LONG

Prioritizes accuracy while still decreasing measurement time by slowly scaling down aperture time in larger current ranges. The nidcpower.Session.aperture_time property specifies the aperture time for the minimum range.

## ApertureTimeUnits¶

class nidcpower.ApertureTimeUnits
SECONDS

Specifies aperture time in seconds.

POWER_LINE_CYCLES

Specifies aperture time in power line cycles (PLCs).

## AutoZero¶

class nidcpower.AutoZero
OFF

Disables auto zero.

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.

ON

Makes zero conversions for every measurement.

## AutorangeApertureTimeMode¶

class nidcpower.AutorangeApertureTimeMode
AUTO

NI-DCPower optimizes the aperture time for the autorange algorithm based on the module range.

CUSTOM

The user specifies a minimum aperture time for the algorithm using the nidcpower.Session.autorange_minimum_aperture_time property and the corresponding nidcpower.Session.autorange_minimum_aperture_time_units property.

## AutorangeBehavior¶

class nidcpower.AutorangeBehavior
UP_TO_LIMIT_THEN_DOWN

Go to limit range then range down as needed until measured value is within thresholds.

UP

go up one range when the upper threshold is reached.

UP_AND_DOWN

go up or down one range when the upper/lower threshold is reached.

## AutorangeThresholdMode¶

class nidcpower.AutorangeThresholdMode
NORMAL

Thresholds are selected based on a balance between accuracy and hysteresis.

FAST_STEP

Optimized for faster changes in the measured signal. Thresholds are configured to be a smaller percentage of the range.

HIGH_HYSTERESIS

Optimized for noisy signals to minimize frequent and unpredictable range changes. Thresholds are configured to be a larger percentage of the range.

MEDIUM_HYSTERESIS

Optimized for noisy signals to minimize frequent and unpredictable range changes. Thresholds are configured to be a medium percentage of the range.

HOLD

Attempt to maintain the active range. Thresholds will favor the active range.

## CableLength¶

class nidcpower.CableLength
ZERO_M

Uses predefined cable compensation data for a 0m cable (direct connection).

NI_STANDARD_1M

Uses predefined cable compensation data for an NI standard 1m coaxial cable.

NI_STANDARD_2M

Uses predefined cable compensation data for an NI standard 2m coaxial cable.

NI_STANDARD_4M

Uses predefined cable compensation data for an NI standard 4m coaxial cable.

NI_STANDARD_TRIAXIAL_1M

Uses predefined cable compensation data for an NI standard 1m triaxial cable.

NI_STANDARD_TRIAXIAL_2M

Uses predefined cable compensation data for an NI standard 2m triaxial cable.

NI_STANDARD_TRIAXIAL_4M

Uses predefined cable compensation data for an NI standard 4m triaxial cable.

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.

CUSTOM_AS_CONFIGURED

Uses the custom cable compensation data supplied to nidcpower.Session.configure_lcr_custom_cable_compensation(). Use this option to manage multiple sets of custom cable compensation data.

## ComplianceLimitSymmetry¶

class nidcpower.ComplianceLimitSymmetry
SYMMETRIC

Compliance limits are specified symmetrically about 0.

ASYMMETRIC

Compliance limits can be specified asymmetrically with respect to 0.

## CurrentLimitBehavior¶

class nidcpower.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.

TRIP

The channel disables the output when the actual output current on the channel reaches or exceeds the value of the Current Limit property.

## DCNoiseRejection¶

class nidcpower.DCNoiseRejection
SECOND_ORDER

Second-order rejection of DC noise.

NORMAL

Normal rejection of DC noise.

## Event¶

class nidcpower.Event
SOURCE_COMPLETE

Specifies the Source Complete event.

MEASURE_COMPLETE

Specifies the Measure Complete event.

SEQUENCE_ITERATION_COMPLETE

Specifies the Sequence Iteration Complete event.

SEQUENCE_ENGINE_DONE

Specifies the Sequence Engine Done event.

PULSE_COMPLETE

Specifies the Pulse Complete event.

READY_FOR_PULSE_TRIGGER

Specifies the Ready for Pulse Trigger event.

## InstrumentMode¶

class nidcpower.InstrumentMode
SMU_PS

The channel operates as an SMU/power supply.

LCR

The channel operates as an LCR meter.

## LCRCompensationType¶

class nidcpower.LCRCompensationType
OPEN

Open LCR compensation.

SHORT

Short LCR compensation.

LOAD

OPEN_CUSTOM_CABLE

Open custom cable compensation.

SHORT_CUSTOM_CABLE

Short custom cable compensation.

## LCRDCBiasSource¶

class nidcpower.LCRDCBiasSource
OFF

Disables DC bias in LCR mode.

VOLTAGE

Applies a constant voltage bias, as defined by the nidcpower.Session.lcr_dc_bias_voltage_level property.

CURRENT

Applies a constant current bias, as defined by the nidcpower.Session.lcr_dc_bias_current_level property.

## LCRImpedanceRangeSource¶

class nidcpower.LCRImpedanceRangeSource
IMPEDANCE_RANGE

Uses the impedance range you specify with the nidcpower.Session.lcr_impedance_range property.

LOAD_CONFIGURATION

Computes the impedance range to select based on the values you supply to the nidcpower.Session.lcr_load_resistance, nidcpower.Session.lcr_load_inductance, and 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.

## LCRMeasurementTime¶

class nidcpower.LCRMeasurementTime
SHORT

Uses a short aperture time for LCR measurements.

MEDIUM

Uses a medium aperture time for LCR measurements.

LONG

Uses a long aperture time for LCR measurements.

CUSTOM

Uses a custom aperture time for LCR measurements as specified by the nidcpower.Session.lcr_custom_measurement_time property.

class nidcpower.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.

AS_DEFINED

Uses the LCR compensation data represented by the relevant LCR compensation properties as generated by nidcpower.Session.perform_lcr_open_compensation(), nidcpower.Session.perform_lcr_short_compensation(), and 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: nidcpower.Session.lcr_open_conductance, nidcpower.Session.lcr_open_susceptance, nidcpower.Session.lcr_short_resistance, nidcpower.Session.lcr_short_reactance, nidcpower.Session.lcr_measured_load_resistance, nidcpower.Session.lcr_measured_load_reactance, nidcpower.Session.lcr_actual_load_resistance, nidcpower.Session.lcr_actual_load_reactance.

## LCRReferenceValueType¶

class nidcpower.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.

IDEAL_CAPACITANCE

The ideal capacitance of your DUT. Supply capacitance, in farads, to reference value A.

IDEAL_INDUCTANCE

The ideal inductance of your DUT. Supply inductance, in henrys, to reference value A.

IDEAL_RESISTANCE

The ideal resistance of your DUT. Supply resistance, in ohms, to reference value A.

## LCRSourceDelayMode¶

class nidcpower.LCRSourceDelayMode
AUTOMATIC

NI-DCPower automatically applies source delay of sufficient duration to account for settling time.

MANUAL

NI-DCPower applies the source delay that you set manually with 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.

## LCRStimulusFunction¶

class nidcpower.LCRStimulusFunction
VOLTAGE

Applies an AC voltage for LCR stimulus.

CURRENT

Applies an AC current for LCR stimulus.

## MeasureWhen¶

class nidcpower.MeasureWhen
AUTOMATICALLY_AFTER_SOURCE_COMPLETE

Acquires a measurement after each Source Complete event completes.

ON_DEMAND

Acquires a measurement when the nidcpower.Session.measure() method or nidcpower.Session.measure_multiple() method is called.

ON_MEASURE_TRIGGER

Acquires a measurement when a Measure trigger is received.

## MeasurementTypes¶

class nidcpower.MeasurementTypes
CURRENT

The device measures current.

VOLTAGE

The device measures voltage.

## OutputCapacitance¶

class nidcpower.OutputCapacitance
LOW

Output Capacitance is low.

HIGH

Output Capacitance is high.

## OutputCutoffReason¶

class nidcpower.OutputCutoffReason
ALL

Queries any output cutoff condition; clears all output cutoff conditions.

VOLTAGE_OUTPUT_HIGH

Queries or clears cutoff conditions when the output exceeded the high cutoff limit for voltage output.

VOLTAGE_OUTPUT_LOW

Queries or clears cutoff conditions when the output fell below the low cutoff limit for voltage output.

CURRENT_MEASURE_HIGH

Queries or clears cutoff conditions when the measured current exceeded the high cutoff limit for current output.

CURRENT_MEASURE_LOW

Queries or clears cutoff conditions when the measured current fell below the low cutoff limit for current output.

VOLTAGE_CHANGE_HIGH

Queries or clears cutoff conditions when the voltage slew rate increased beyond the positive change cutoff for voltage output.

VOLTAGE_CHANGE_LOW

Queries or clears cutoff conditions when the voltage slew rate decreased beyond the negative change cutoff for voltage output.

CURRENT_CHANGE_HIGH

Queries or clears cutoff conditions when the current slew rate increased beyond the positive change cutoff for current output.

CURRENT_CHANGE_LOW

Queries or clears cutoff conditions when the current slew rate decreased beyond the negative change cutoff for current output.

## OutputFunction¶

class nidcpower.OutputFunction
DC_VOLTAGE

Sets the output method to DC voltage.

DC_CURRENT

Sets the output method to DC current.

PULSE_VOLTAGE

Sets the output method to pulse voltage.

PULSE_CURRENT

Sets the output method to pulse current.

## OutputStates¶

class nidcpower.OutputStates
VOLTAGE

The channel maintains a constant voltage by adjusting the current.

CURRENT

The channel maintains a constant current by adjusting the voltage.

## Polarity¶

class nidcpower.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.

LOW

A low pulse occurs when the event is generated. The exported signal is high level both before and after the event is generated.

## PowerAllocationMode¶

class nidcpower.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.

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.

MANUAL

The device attempts to source, on each active channel, the power you request with the 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.

## PowerSource¶

class nidcpower.PowerSource
INTERNAL

Uses the PXI chassis power source.

AUXILIARY

Uses the auxiliary power source connected to the device.

AUTOMATIC

Uses the auxiliary power source if it is available; otherwise uses the PXI chassis power source.

## PowerSourceInUse¶

class nidcpower.PowerSourceInUse
INTERNAL

Uses the PXI chassis power source.

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.

## SelfCalibrationPersistence¶

class nidcpower.SelfCalibrationPersistence
KEEP_IN_MEMORY

Keep new self calibration values in memory only.

WRITE_TO_EEPROM

Write new self calibration values to hardware.

## SendSoftwareEdgeTriggerType¶

class nidcpower.SendSoftwareEdgeTriggerType
START

Asserts the Start trigger.

SOURCE

Asserts the Source trigger.

MEASURE

Asserts the Measure trigger.

SEQUENCE_ADVANCE

PULSE

Asserts the Pulse trigger.

SHUTDOWN

Asserts the Shutdown trigger.

## Sense¶

class nidcpower.Sense
LOCAL

Local sensing is selected.

REMOTE

Remote sensing is selected.

## SourceMode¶

class nidcpower.SourceMode
SINGLE_POINT

The source unit applies a single source configuration.

SEQUENCE

The source unit applies a list of voltage or current configurations sequentially.

## TransientResponse¶

class nidcpower.TransientResponse
NORMAL

The output responds to changes in load at a normal speed.

FAST

The output responds to changes in load quickly.

SLOW

The output responds to changes in load slowly.

CUSTOM

The output responds to changes in load based on specified values.

## TriggerType¶

class nidcpower.TriggerType
NONE

No trigger is configured.

DIGITAL_EDGE

The data operation starts when a digital edge is detected.

SOFTWARE_EDGE

The data operation starts when a software trigger occurs.