Enums¶

Enums used in NI-DCPower

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.

ON¶: Makes zero conversions for every measurement.

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.

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.

ComplianceLimitSymmetry¶

class nidcpower.ComplianceLimitSymmetry¶

SYMMETRIC¶: Compliance limits are specified symmetrically about 0.

ASYMMETRIC¶: Compliance limits can be specified asymmetrically with respect to 0.

DCNoiseRejection¶

class nidcpower.DCNoiseRejection¶

SECOND_ORDER¶: Second-order rejection of DC noise.

NORMAL¶: Normal rejection of DC noise.

Event¶

class nidcpower.Event¶

SOURCE_COMPLETE¶

MEASURE_COMPLETE¶

SEQUENCE_ITERATION_COMPLETE¶

SEQUENCE_ENGINE_DONE¶

PULSE_COMPLETE¶

READY_FOR_PULSE_TRIGGER¶

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 device maintains a constant voltage by adjusting the current

CURRENT¶: The device 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¶

SOURCE¶

MEASURE¶

SEQUENCE_ADVANCE¶

PULSE¶

SHUTDOWN¶

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.