This module provides the base functionality for DC power supplies.
Exception raised on various occasions; argument is a string describing what is wrong.
Bases: ivi.ivi.IviContainer
Base IVI methods for all DC power supplies
IVI class IviDCPwr, capability group IviDCPwrBase, section 4.3.1
This function configures the current limit. It specifies the output current limit value and the behavior of the power supply when the output current is greater than or equal to that value.
See the definition of the Current Limit Behavior attribute for defined values for the behavior parameter.
IVI class IviDCPwr, capability group IviDCPwrBase, section 4.3.4
Configures the over-voltage protection. It specifies the over-voltage limit and the behavior of the power supply when the output voltage is greater than or equal to that value.
When the Enabled parameter is False, the Limit parameter does not affect the instrument’s behavior, and the driver does not set the OVP Limit attribute.
IVI class IviDCPwr, capability group IviDCPwrBase, section 4.3.3
Configures the power supply’s output range on an output. One parameter specifies whether to configure the voltage or current range, and the other parameter is the value to which to set the range.
Setting a voltage range can invalidate a previously configured current range. Setting a current range can invalidate a previously configured voltage range.
IVI class IviDCPwr, capability group IviDCPwrBase, section 4.2.1
Specifies the output current limit. The units are Amps.
The value of the Current Limit Behavior attribute determines the behavior of the power supply when the output current is equal to or greater than the value of this attribute.
IVI class IviDCPwr, capability group IviDCPwrBase, section 4.2.2
Specifies the behavior of the power supply when the output current is equal to or greater than the value of the Current Limit attribute.
Values
IVI class IviDCPwr, capability group IviDCPwrBase, section 4.2.3
If true, the signal the power supply produces appears at the output connector. If false, the signal the power supply produces does not appear at the output connector.
IVI class IviDCPwr, capability group IviDCPwrBase, section 4.2.9
This attribute returns the repeated capability identifier defined by specific driver for the output channel that corresponds to the index that the user specifies. If the driver defines a qualified Output Channel name, this property returns the qualified name.
If the value that the user passes for the Index parameter is less than zero or greater than the value of the Output Channel Count, the attribute raises a SelectorRangeException.
IVI class IviDCPwr, capability group IviDCPwrBase, section 4.2.4
Specifies whether the power supply provides over-voltage protection. If this attribute is set to True, the power supply disables the output when the output voltage is greater than or equal to the value of the OVP Limit attribute.
IVI class IviDCPwr, capability group IviDCPwrBase, section 4.2.5
Specifies the voltage the power supply allows. The units are Volts.
If the OVP Enabled attribute is set to True, the power supply disables the output when the output voltage is greater than or equal to the value of this attribute.
If the OVP Enabled is set to False, this attribute does not affect the behavior of the instrument.
IVI class IviDCPwr, capability group IviDCPwrBase, section 4.3.7
This function returns the maximum programmable current limit that the power supply accepts for a particular voltage level on an output.
IVI class IviDCPwr, capability group IviDCPwrBase, section 4.3.9
This function returns whether the power supply is in a particular output state.
A constant voltage condition occurs when the output voltage is equal to the value of the Voltage Level attribute and the current is less than or equal to the value of the Current Limit attribute.
A constant current condition occurs when the output current is equal to the value of the Current Limit attribute and the Current Limit Behavior attribute is set to the Current Regulate defined value.
An unregulated condition occurs when the output voltage is less than the value of the Voltage Level attribute and the current is less than the value of the Current Limit attribute.
An over-voltage condition occurs when the output voltage is equal to or greater than the value of the OVP Limit attribute and the OVP Enabled attribute is set to True.
An over-current condition occurs when the output current is equal to or greater than the value of the Current Limit attribute and the Current Limit Behavior attribute is set to the Current Trip defined value.
When either an over-voltage condition or an over-current condition occurs, the power supply’s output protection disables the output. If the power supply is in an over-voltage or over-current state, it does not produce power until the output protection is reset. The Reset Output Protection function resets the output protection. Once the output protection is reset, the power supply resumes generating a power signal.
Values for output_state:
IVI class IviDCPwr, capability group IviDCPwrBase, section 4.3.8
This function returns the maximum programmable voltage level that the power supply accepts for a particular current limit on an output.
IVI class IviDCPwr, capability group IviDCPwrBase, section 4.3.10
This function resets the power supply output protection after an over-voltage or over-current condition occurs.
An over-voltage condition occurs when the output voltage is equal to or greater than the value of the OVP Limit attribute and the OVP Enabled attribute is set to True.
An over-current condition occurs when the output current is equal to or greater than the value of the Current Limit attribute and the Current Limit Behavior attribute is set to Current Trip.
When either an over-voltage condition or an over-current condition occurs, the output protection of the power supply disables the output. Once the output protection is reset, the power supply resumes generating a power signal.
Use the Query Output State function to determine if the power supply is in an over-voltage or over-current state.
IVI class IviDCPwr, capability group IviDCPwrBase, section 4.2.6
Specifies the voltage level the DC power supply attempts to generate. The units are Volts.
Bases: ivi.ivi.IviContainer
Extension IVI methods for power supplies supporting trigger based output changes
IVI class IviDCPwr, capability group IviDCPwrTrigger, section 5.2.1
Specifies the trigger source. After an Initiate call, the power supply waits for a trigger event from the source specified with this attribute. After a trigger event occurs, the power supply changes the voltage level to the value of the Triggered Voltage Level attribute and the current limit to the value of the Triggered Current Limit attribute.
IVI class IviDCPwr, capability group IviDCPwrTrigger, section 5.2.2
Specifies the value to which the power supply sets the current limit after a trigger event occurs. The units are Amps.
After an Initiate call, the power supply waits for a trigger event from the source specified with the Trigger Source attribute. After a trigger event occurs, the power supply sets the current limit to the value of this attribute.
After a trigger occurs, the value of the Current Limit attribute reflects the new value to which the current limit has been set.
IVI class IviDCPwr, capability group IviDCPwrTrigger, section 5.2.3
Specifies the value to which the power supply sets the voltage level after a trigger event occurs. The units are Volts.
After an Initiate call, the power supply waits for a trigger event from the source specified with the Trigger Source attribute. After a trigger event occurs, the power supply sets the voltage level to the value of this attribute.
After a trigger occurs, the value of the Voltage Level attribute reflects the new value to which the voltage level has been set.
IVI class IviDCPwr, capability group IviDCPwrTrigger, section 5.3.1
If the power supply is currently waiting for a trigger to change the output signal, this function returns the power supply to the ignore triggers state.
If the power supply is not waiting for a trigger, this function does nothing and returns Success.
IVI class IviDCPwr, capability group IviDCPwrTrigger, section 5.3.5
If the power supply is not currently waiting for a trigger, this function causes the power supply to wait for a trigger.
If the power supply is already waiting for a trigger, this function does nothing and returns Success.
Bases: ivi.ivi.IviContainer
Extension IVI methods for power supplies supporting software triggering
IVI class IviDCPwr, capability group IviDCPwrSoftwareTrigger, section 6.2.1
This function sends a software-generated trigger to the instrument. It is only applicable for instruments using interfaces or protocols which support an explicit trigger function. For example, with GPIB this function could send a group execute trigger to the instrument. Other implementations might send a *TRG command.
Since instruments interpret a software-generated trigger in a wide variety of ways, the precise response of the instrument to this trigger is not defined. Note that SCPI details a possible implementation.
This function should not use resources which are potentially shared by other devices (for example, the VXI trigger lines). Use of such shared resources may have undesirable effects on other devices.
This function should not check the instrument status. Typically, the end-user calls this function only in a sequence of calls to other low-level driver functions. The sequence performs one operation. The end-user uses the low-level functions to optimize one or more aspects of interaction with the instrument. To check the instrument status, call the appropriate error query function at the conclusion of the sequence.
The trigger source attribute must accept Software Trigger as a valid setting for this function to work. If the trigger source is not set to Software Trigger, this function does nothing and returns the error Trigger Not Software.
Bases: ivi.ivi.IviContainer
Extension IVI methods for power supplies supporting measurement of the output signal
IVI class IviDCPwr, capability group IviDCPwrMeasurement, section 7.2.1
Takes a measurement on the output signal and returns the measured value.
Values for measurement_type: