Session¶
-
class
nidcpower.
Session
(self, resource_name, channels=None, reset=False, options={})¶ 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 method calls. With this method, you can optionally set the initial state of the following session properties:
After calling this method, 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 True. This action is equivalent to using the
nidcpower.Session.reset()
method 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 False. Then configure the device as in the previous session, changing only the desired settings, and then call the
nidcpower.Session.initiate()
method.Related Topics:
Parameters: - resource_name (str) – 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.
- channels (str, list, range, tuple) – 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.
- reset (bool) – Specifies whether to reset the device during the initialization procedure.
- options (dict) –
Specifies the initial value of certain properties for the session. The syntax for options is a dictionary of properties with an assigned value. For example:
{ ‘simulate’: False }
You do not have to specify a value for all the properties. If you do not specify a value for a property, the default value is used.
Advanced Example: { ‘simulate’: True, ‘driver_setup’: { ‘Model’: ‘<model number>’, ‘BoardType’: ‘<type>’ } }
Property Default range_check True query_instrument_status False cache True simulate False record_value_coersions False driver_setup {}
Methods¶
abort¶
nidcpower.Session.
abort
()¶Transitions the NI-DCPower session from the Running state to the Uncommitted state. If a sequence is running, it is stopped. Any configuration methods called after this method are not applied until the
nidcpower.Session.initiate()
method is called. If power output is enabled when you call thenidcpower.Session.abort()
method, the output channels remain in their current state and continue providing power.Use the
nidcpower.Session.ConfigureOutputEnabled()
method to disable power output on a per channel basis. Use thenidcpower.Session.reset()
method 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:
Note
One or more of the referenced methods are not in the Python API for this driver.
close¶
nidcpower.Session.
close
()¶Closes the session specified in vi and deallocates the resources that NI-DCPower reserves. If power output is enabled when you call this method, the output channels remain in their existing state and continue providing power. Use the
nidcpower.Session.ConfigureOutputEnabled()
method to disable power output on a per channel basis. Use thenidcpower.Session.reset()
method to disable power output on all channel(s).Related Topics:
Note
One or more of the referenced methods are not in the Python API for this driver.
Note
This method is not needed when using the session context manager
commit¶
nidcpower.Session.
commit
()¶Applies previously configured settings to the device. Calling this method moves the NI-DCPower session from the Uncommitted state into the Committed state. After calling this method, modifying any property reverts the NI-DCPower session to the Uncommitted state. Use the
nidcpower.Session.initiate()
method 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:
configure_aperture_time¶
nidcpower.Session.
configure_aperture_time
(aperture_time, units=nidcpower.ApertureTimeUnits.SECONDS)¶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:
Note
This method is not supported on all devices. Refer to Supported Methods by Device for more information about supported devices.
Tip
This method requires repeated capabilities (channels). If called directly on the nidcpower.Session object, then the method 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 this method on the result.:
session.channels[0,1].configure_aperture_time(aperture_time, units=nidcpower.ApertureTimeUnits.SECONDS)
Parameters:
- aperture_time (float) – 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.
- units (
nidcpower.ApertureTimeUnits
) –Specifies the units for apertureTime. Defined Values:
SECONDS
(1028)Specifies seconds. POWER_LINE_CYCLES
(1029)Specifies Power Line Cycles.
create_advanced_sequence¶
nidcpower.Session.
create_advanced_sequence
(sequence_name, property_names, set_as_active_sequence=True)¶Creates an empty advanced sequence. Call the
nidcpower.Session.create_advanced_sequence_step()
method to add steps to the active advanced sequence.You can create multiple advanced sequences in a session.
Support for this method
You must set the source mode to Sequence to use this method.
Using the
nidcpower.Session.set_sequence()
method with Advanced Sequence methods is unsupported.Use this method 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:
nidcpower.Session.create_advanced_sequence_step()
Note
This method is not supported on all devices. Refer to Supported Methods by Device for more information about supported devices.
Parameters:
- sequence_name (str) – Specifies the name of the sequence to create.
- property_names (list of str) –
Specifies the names of the properties you reconfigure per step in the advanced sequence. The following table lists which properties can be configured in an advanced sequence for each NI-DCPower device that supports advanced sequencing. A Yes indicates that the property can be configured in advanced sequencing. An No indicates that the property cannot be configured in advanced sequencing.
- set_as_active_sequence (bool) – Specifies that this current sequence is active.
create_advanced_sequence_step¶
nidcpower.Session.
create_advanced_sequence_step
(set_as_active_step=True)¶Creates a new advanced sequence step in the advanced sequence specified by the Active advanced sequence. When you create an advanced sequence step, each property you passed to the
nidcpower.Session._create_advanced_sequence()
method is reset to its default value for that step unless otherwise specified.Support for this Method
You must set the source mode to Sequence to use this method.
Using the
nidcpower.Session.set_sequence()
method with Advanced Sequence methods is unsupported.Related Topics:
nidcpower.Session._create_advanced_sequence()
Note
This method is not supported on all devices. Refer to Supported Methods by Device for more information about supported devices.
Parameters: set_as_active_step (bool) – Specifies that this current step in the active sequence is active.
delete_advanced_sequence¶
nidcpower.Session.
delete_advanced_sequence
(sequence_name)¶Deletes a previously created advanced sequence and all the advanced sequence steps in the advanced sequence.
Support for this Method
You must set the source mode to Sequence to use this method.
Using the
nidcpower.Session.set_sequence()
method with Advanced Sequence methods is unsupported.Related Topics:
Note
This method is not supported on all devices. Refer to Supported Methods by Device for more information about supported devices.
Parameters: sequence_name (str) – specifies the name of the sequence to delete.
disable¶
nidcpower.Session.
disable
()¶This method performs the same actions as the
nidcpower.Session.reset()
method, except that this method also immediately sets thenidcpower.Session.output_enabled
property to False.This method opens the output relay on devices that have an output relay.
export_attribute_configuration_buffer¶
nidcpower.Session.
export_attribute_configuration_buffer
()¶Exports the property configuration of the session to the specified configuration buffer.
You can export and import session property configurations only between devices with identical model numbers and the same number of configured channels.
This method verifies that the properties you have configured for the session are valid. If the configuration is invalid, NI‑DCPower returns an error.
Support for this Method
Calling this method in Sequence Source Mode is unsupported.
Channel Mapping Behavior for Multichannel Sessions
When importing and exporting session property 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.Session.__init__()
method.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 Properties
Setting Properties and Properties Before Reading Them
Note
This method 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.
Return type: bytes Returns: Specifies the byte array buffer to be populated with the exported property configuration.
export_attribute_configuration_file¶
nidcpower.Session.
export_attribute_configuration_file
(file_path)¶Exports the property configuration of the session to the specified file.
You can export and import session property configurations only between devices with identical model numbers and the same number of configured channels.
This method verifies that the properties you have configured for the session are valid. If the configuration is invalid, NI‑DCPower returns an error.
Support for this Method
Calling this method in Sequence Source Mode is unsupported.
Channel Mapping Behavior for Multichannel Sessions
When importing and exporting session property 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.Session.__init__()
method.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 Properties
Setting Properties and Properties Before Reading Them
Note
This method 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.
Parameters: file_path (str) – Specifies the absolute path to the file to contain the exported property configuration. If you specify an empty or relative path, this method returns an error. Default file extension: .nidcpowerconfig
fetch_multiple¶
nidcpower.Session.
fetch_multiple
(count, timeout=datetime.timedelta(seconds=1.0))¶Returns a list of named tuples (Measurement) that were previously taken and are stored in the NI-DCPower buffer. This method should not be used when the
nidcpower.Session.measure_when
property is set toON_DEMAND
. You must first callnidcpower.Session.initiate()
before calling this method.Fields in Measurement:
- voltage (float)
- current (float)
- in_compliance (bool)
Note
This method is not supported on all devices. Refer to Supported Methods by Device for more information about supported devices.
Tip
This method requires repeated capabilities (channels). If called directly on the nidcpower.Session object, then the method 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 this method on the result.:
session.channels[0,1].fetch_multiple(count, timeout=datetime.timedelta(seconds=1.0))
Parameters:
- count (int) – Specifies the number of measurements to fetch.
- timeout (float in seconds or datetime.timedelta) –
Specifies the maximum time allowed for this method to complete. If the method 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.
Return type: list of Measurement
Returns: List of named tuples with fields:
- voltage (float)
- current (float)
- in_compliance (bool)
get_channel_name¶
nidcpower.Session.
get_channel_name
(index)¶Retrieves the output channelName that corresponds to the requested index. Use the
nidcpower.Session.channel_count
property to determine the upper bound of valid values for index.
Parameters: index (int) – Specifies which output channel name to return. The index values begin at 1. Return type: str Returns: Returns the output channel name that corresponds to index.
get_ext_cal_last_date_and_time¶
nidcpower.Session.
get_ext_cal_last_date_and_time
()¶Returns the date and time of the last successful calibration.
Return type: datetime.datetime Returns: Indicates date and time of the last calibration.
get_ext_cal_last_temp¶
nidcpower.Session.
get_ext_cal_last_temp
()¶Returns the onboard temperature of the device, in degrees Celsius, during the last successful external calibration.
Return type: float Returns: Returns the onboard temperature of the device, in degrees Celsius, during the last successful external calibration.
get_ext_cal_recommended_interval¶
nidcpower.Session.
get_ext_cal_recommended_interval
()¶Returns the recommended maximum interval, in months, between external calibrations.
Return type: datetime.timedelta Returns: Specifies the recommended maximum interval, in months, between external calibrations.
get_self_cal_last_date_and_time¶
nidcpower.Session.
get_self_cal_last_date_and_time
()¶Returns the date and time of the oldest successful self-calibration from among the channels in the session.
Note
This method is not supported on all devices.
Return type: datetime.datetime Returns: Returns the date and time the device was last calibrated.
get_self_cal_last_temp¶
nidcpower.Session.
get_self_cal_last_temp
()¶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 method returns 25 for the temperature parameter.
Note
This method is not supported on all devices. Refer to Supported Methods by Device for more information about supported devices.
Return type: float Returns: Returns the onboard temperature of the device, in degrees Celsius, during the oldest successful calibration.
import_attribute_configuration_buffer¶
nidcpower.Session.
import_attribute_configuration_buffer
(configuration)¶Imports a property configuration to the session from the specified configuration buffer.
You can export and import session property configurations only between devices with identical model numbers and the same number of configured channels.
Support for this Method
Calling this method in Sequence Source Mode is unsupported.
Channel Mapping Behavior for Multichannel Sessions
When importing and exporting session property 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.Session.__init__()
method.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 Properties
Setting Properties and Properties Before Reading Them
Note
This method 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.
Parameters: configuration (bytes) – Specifies the byte array buffer that contains the property configuration to import.
import_attribute_configuration_file¶
nidcpower.Session.
import_attribute_configuration_file
(file_path)¶Imports a property configuration to the session from the specified file.
You can export and import session property configurations only between devices with identical model numbers and the same number of configured channels.
Support for this Method
Calling this method in Sequence Source Mode is unsupported.
Channel Mapping Behavior for Multichannel Sessions
When importing and exporting session property 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.Session.__init__()
method.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 Properties
Setting Properties and Properties Before Reading Them
Note
This method 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.
Parameters: file_path (str) – Specifies the absolute path to the file containing the property configuration to import. If you specify an empty or relative path, this method returns an error. Default File Extension: .nidcpowerconfig
initiate¶
nidcpower.Session.
initiate
()¶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 Uncommitted state call the
nidcpower.Session.abort()
method. 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:
Note
This method will return a Python context manager that will initiate on entering and abort on exit.
lock¶
-
nidcpower.Session.
lock
()¶ 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.Session.lock()
method. - A call to NI-DCPower locked the session.
- After a call to the
nidcpower.Session.lock()
method returns successfully, no other threads can access the device session until you call thenidcpower.Session.unlock()
method or exit out of the with block when using lock context manager. - Use the
nidcpower.Session.lock()
method and thenidcpower.Session.unlock()
method around a sequence of calls to instrument driver methods if you require that the device retain its settings through the end of the sequence.
You can safely make nested calls to the
nidcpower.Session.lock()
method within the same thread. To completely unlock the session, you must balance each call to thenidcpower.Session.lock()
method with a call to thenidcpower.Session.unlock()
method.One method for ensuring there are the same number of unlock method calls as there is lock calls is to use lock as a context manager
with nidcpower.Session('dev1') as session: with session.lock(): # Calls to session within a single lock context
The first with block ensures the session is closed regardless of any exceptions raised
The second with block ensures that unlock is called regardless of any exceptions raised
Return type: context manager Returns: When used in a with statement, nidcpower.Session.lock()
acts as a context manager and unlock will be called when the with block is exited- The application called the
measure¶
nidcpower.Session.
measure
(measurement_type)¶Returns the measured value of either the voltage or current on the specified output channel. Each call to this method blocks other method calls until the hardware returns the measurement. To measure multiple output channels, use the
nidcpower.Session.measure_multiple()
method.Tip
This method requires repeated capabilities (channels). If called directly on the nidcpower.Session object, then the method 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 this method on the result.:
session.channels[0,1].measure(measurement_type)
Parameters: measurement_type ( nidcpower.MeasurementTypes
) –Specifies whether a voltage or current value is measured. Defined Values:
VOLTAGE
(1)The device measures voltage. CURRENT
(0)The device measures current. Return type: float Returns: Returns the value of the measurement, either in volts for voltage or amps for current.
measure_multiple¶
nidcpower.Session.
measure_multiple
()¶Returns a list of named tuples (Measurement) containing the measured voltage and current values on the specified output channel(s). Each call to this method blocks other method 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 method is not supported on all devices. Refer to Supported Methods by Device for more information about supported devices.
Tip
This method requires repeated capabilities (channels). If called directly on the nidcpower.Session object, then the method 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 this method on the result.:
session.channels[0,1].measure_multiple()
Return type: list of Measurement Returns: List of named tuples with fields:
- voltage (float)
- current (float)
- in_compliance (bool) - Always None
query_in_compliance¶
nidcpower.Session.
query_in_compliance
()¶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 method is set to
DC_VOLTAGE
. If the output is operating at the compliance limit, the output reaches the current limit before the desired voltage level. Refer to thenidcpower.Session.ConfigureOutputFunction()
method and thenidcpower.Session.ConfigureCurrentLimit()
method for more information about output method and current limit, respectively.The compliance limit is the voltage limit when the output method is set to
DC_CURRENT
. If the output is operating at the compliance limit, the output reaches the voltage limit before the desired current level. Refer to thenidcpower.Session.ConfigureOutputFunction()
method and thenidcpower.Session.ConfigureVoltageLimit()
method for more information about output method and voltage limit, respectively.Related Topics:
Note
One or more of the referenced methods are not in the Python API for this driver.
Tip
This method requires repeated capabilities (channels). If called directly on the nidcpower.Session object, then the method 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 this method on the result.:
session.channels[0,1].query_in_compliance()
Return type: bool Returns: Returns whether the device output channel is in compliance.
query_max_current_limit¶
nidcpower.Session.
query_max_current_limit
(voltage_level)¶Queries the maximum current limit on an output channel if the output channel is set to the specified voltageLevel.
Tip
This method requires repeated capabilities (channels). If called directly on the nidcpower.Session object, then the method 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 this method on the result.:
session.channels[0,1].query_max_current_limit(voltage_level)
Parameters: voltage_level (float) – Specifies the voltage level to use when calculating the maxCurrentLimit. Return type: float Returns: Returns the maximum current limit that can be set with the specified voltageLevel.
query_max_voltage_level¶
nidcpower.Session.
query_max_voltage_level
(current_limit)¶Queries the maximum voltage level on an output channel if the output channel is set to the specified currentLimit.
Tip
This method requires repeated capabilities (channels). If called directly on the nidcpower.Session object, then the method 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 this method on the result.:
session.channels[0,1].query_max_voltage_level(current_limit)
Parameters: current_limit (float) – Specifies the current limit to use when calculating the maxVoltageLevel. Return type: float Returns: Returns the maximum voltage level that can be set on an output channel with the specified currentLimit.
query_min_current_limit¶
nidcpower.Session.
query_min_current_limit
(voltage_level)¶Queries the minimum current limit on an output channel if the output channel is set to the specified voltageLevel.
Tip
This method requires repeated capabilities (channels). If called directly on the nidcpower.Session object, then the method 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 this method on the result.:
session.channels[0,1].query_min_current_limit(voltage_level)
Parameters: voltage_level (float) – Specifies the voltage level to use when calculating the minCurrentLimit. Return type: float Returns: Returns the minimum current limit that can be set on an output channel with the specified voltageLevel.
query_output_state¶
nidcpower.Session.
query_output_state
(output_state)¶Queries the specified output channel to determine if the output channel is currently in the state specified by outputState.
Related Topics:
Tip
This method requires repeated capabilities (channels). If called directly on the nidcpower.Session object, then the method 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 this method on the result.:
session.channels[0,1].query_output_state(output_state)
Parameters: output_state ( nidcpower.OutputStates
) –Specifies the output state of the output channel that is being queried. Defined Values:
VOLTAGE
(0)The device maintains a constant voltage by adjusting the current. CURRENT
(1)The device maintains a constant current by adjusting the voltage. Return type: bool Returns: Returns whether the device output channel is in the specified output state.
reset¶
nidcpower.Session.
reset
()¶Resets the device to a known state. This method disables power generation, resets session properties to their default values, commits the session properties, and leaves the session in the Uncommitted state. Refer to the Programming States topic for more information about NI-DCPower software states.
reset_device¶
nidcpower.Session.
reset_device
()¶Resets the device to a known state. The method disables power generation, resets session properties to their default values, clears errors such as overtemperature and unexpected loss of auxiliary power, commits the session properties, and leaves the session in the Uncommitted state. This method also performs a hard reset on the device and driver software. This method 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.
reset_with_defaults¶
nidcpower.Session.
reset_with_defaults
()¶Resets the device to a known state. This method disables power generation, resets session properties to their default values, commits the session properties, and leaves the session in the Running state. In addition to exhibiting the behavior of the
nidcpower.Session.reset()
method, this method can assign user-defined default values for configurable properties from the IVI configuration.
self_cal¶
nidcpower.Session.
self_cal
()¶Performs a self-calibration upon the specified channel(s).
This method disables the output, performs several internal calculations, and updates calibration values. The updated calibration values are written to the device hardware if the
nidcpower.Session.self_calibration_persistence
property is set toWRITE_TO_EEPROM
. Refer to thenidcpower.Session.self_calibration_persistence
property topic for more information about the settings for this property.When calling
nidcpower.Session.self_cal()
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 method.
Related Topics:
Note
This method is not supported on all devices. Refer to Supported Methods by Device for more information about supported devices.
Tip
This method requires repeated capabilities (channels). If called directly on the nidcpower.Session object, then the method 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 this method on the result.:
session.channels[0,1].self_cal()
self_test¶
nidcpower.Session.
self_test
()¶Performs the device self-test routine and returns the test result(s). Calling this method implicitly calls the
nidcpower.Session.reset()
method.When calling
nidcpower.Session.self_test()
with the PXIe-4162/4163, specify all channels of your PXIe-4162/4163 with the channels input ofnidcpower.Session.__init__()
. You cannot self test a subset of PXIe-4162/4163 channels.Raises SelfTestError on self test failure. Properties on exception object:
- code - failure code from driver
- message - status message from driver
Self-Test Code Description 0 Self test passed. 1 Self test failed.
send_software_edge_trigger¶
nidcpower.Session.
send_software_edge_trigger
(trigger)¶Asserts the specified trigger. This method can override an external edge trigger.
Related Topics:
Note
This method is not supported on all devices. Refer to Supported Methods by Device for more information about supported devices.
Parameters: trigger ( nidcpower.SendSoftwareEdgeTriggerType
) –Specifies which trigger to assert. Defined Values:
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
(1053Asserts the Pulse trigger. 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.
set_sequence¶
nidcpower.Session.
set_sequence
(values, source_delays)¶Configures a series of voltage or current outputs and corresponding source delays. The source mode must be set to Sequence for this method 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 method 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 method is not supported on all devices. Refer to Supported Methods by Device for more information about supported devices.
Tip
This method requires repeated capabilities (channels). If called directly on the nidcpower.Session object, then the method 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 this method on the result.:
session.channels[0,1].set_sequence(values, source_delays)
Parameters:
- values (list of float) – Specifies the series of voltage levels or current levels, depending on the configured output method. Valid values: The valid values for this parameter are defined by the voltage level range or current level range.
- source_delays (list of float) – 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.
unlock¶
-
nidcpower.Session.
unlock
()¶ Releases a lock that you acquired on an device session using
nidcpower.Session.lock()
. Refer tonidcpower.Session.unlock()
for additional information on session locks.
wait_for_event¶
nidcpower.Session.
wait_for_event
(event_id, timeout=datetime.timedelta(seconds=10.0))¶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 method or the
nidcpower.Session.initiate()
method were called. If an event has only been generated once and you call this method successively, the method times out. Individual events must be generated between separate calls of this method.Note
Refer to Supported Methods by Device for more information about supported devices.
Parameters:
- event_id (
nidcpower.Event
) –Specifies which event to wait for. Defined Values:
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. 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.
- timeout (float in seconds or datetime.timedelta) –
Specifies the maximum time allowed for this method to complete, in seconds. If the method 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.
Repeated Capabilities¶
Repeated capabilities attributes are used to set the channel_string parameter to the underlying driver function call. This can be the actual function based on the
Session
method being called, or it can be the appropriate Get/Set Attribute function, such asniDCPower_SetAttributeViInt32()
.Repeated capbilities attributes use the indexing operator
[]
to indicate the repeated capabilities. The parameter can be a string, list, tuple, or slice (range). Each element of those can be a string or an integer. If it is a string, you can indicate a range using the same format as the driver:‘0-2’
or‘0:2’
Some repeated capabilities use a prefix before the number and this is optional
Properties¶
active_advanced_sequence¶
nidcpower.Session.
active_advanced_sequence
¶Specifies the advanced sequence to configure or generate.
Note
This property is not supported by all devices. Refer to Supported Properties by Device topic.
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].active_advanced_sequence = var var = session.channels[0,1].active_advanced_sequenceThe following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Source:Advanced:Active Advanced Sequence
- C Attribute: NIDCPOWER_ATTR_ACTIVE_ADVANCED_SEQUENCE
active_advanced_sequence_step¶
nidcpower.Session.
active_advanced_sequence_step
¶Specifies the advanced sequence step to configure.
Note
This property is not supported by all devices. Refer to Supported Properties by Device topic.
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].active_advanced_sequence_step = var var = session.channels[0,1].active_advanced_sequence_stepThe 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:
- LabVIEW Property: Source:Advanced:Active Advanced Sequence Step
- C Attribute: NIDCPOWER_ATTR_ACTIVE_ADVANCED_SEQUENCE_STEP
aperture_time¶
nidcpower.Session.
aperture_time
¶Specifies the measurement aperture time for the channel configuration. Aperture time is specified in the units set by the
nidcpower.Session.aperture_time_units
property. 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 secondsNote
This property is not supported by all devices. Refer to Supported Properties by Device topic
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].aperture_time = var var = session.channels[0,1].aperture_timeThe 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:
- LabVIEW Property: Measurement:Aperture Time
- C Attribute: NIDCPOWER_ATTR_APERTURE_TIME
aperture_time_units¶
nidcpower.Session.
aperture_time_units
¶Specifies the units of the
nidcpower.Session.aperture_time
property 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:SECONDS
Note
This property is not supported by all devices. Refer to Supported Properties by Device topic
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].aperture_time_units = var var = session.channels[0,1].aperture_time_unitsThe following table lists the characteristics of this property.
Characteristic Value Datatype enums.ApertureTimeUnits Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Measurement:Aperture Time Units
- C Attribute: NIDCPOWER_ATTR_APERTURE_TIME_UNITS
auto_zero¶
nidcpower.Session.
auto_zero
¶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
ON
. The default value for all other devices isOFF
, which is the only supported value for these devices.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].auto_zero = var var = session.channels[0,1].auto_zeroThe following table lists the characteristics of this property.
Characteristic Value Datatype enums.AutoZero Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Measurement:Auto Zero
- C Attribute: NIDCPOWER_ATTR_AUTO_ZERO
auxiliary_power_source_available¶
nidcpower.Session.
auxiliary_power_source_available
¶Indicates whether an auxiliary power source is connected to the device. A value of 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.Session.power_source_in_use
property to retrieve this information.Note
This property does not necessarily indicate if the device is using the auxiliary
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.:
var = session.channels[0,1].auxiliary_power_source_availableThe following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read only Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Advanced:Auxiliary Power Source Available
- C Attribute: NIDCPOWER_ATTR_AUXILIARY_POWER_SOURCE_AVAILABLE
channel_count¶
nidcpower.Session.
channel_count
¶Indicates the number of channels that NI-DCPower supports for the instrument that was chosen when the current session was opened. For channel-based properties, the IVI engine maintains a separate cache value for each channel.
The following table lists the characteristics of this property.
Characteristic Value Datatype int Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Inherent IVI Attributes:Driver Capabilities:Channel Count
- C Attribute: NIDCPOWER_ATTR_CHANNEL_COUNT
compliance_limit_symmetry¶
nidcpower.Session.
compliance_limit_symmetry
¶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.
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].compliance_limit_symmetry = var var = session.channels[0,1].compliance_limit_symmetryThe following table lists the characteristics of this property.
Characteristic Value Datatype enums.ComplianceLimitSymmetry Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Source:Advanced:Compliance Limit Symmetry
- C Attribute: NIDCPOWER_ATTR_COMPLIANCE_LIMIT_SYMMETRY
current_compensation_frequency¶
nidcpower.Session.
current_compensation_frequency
¶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
NORMAL
setting of thenidcpower.Session.transient_response
property.Note
This property is not supported by all devices. Refer to Supported Properties by Device topic
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_compensation_frequency = var var = session.channels[0,1].current_compensation_frequencyThe 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:
- LabVIEW Property: Source:Custom Transient Response:Current:Compensation Frequency
- C Attribute: NIDCPOWER_ATTR_CURRENT_COMPENSATION_FREQUENCY
current_gain_bandwidth¶
nidcpower.Session.
current_gain_bandwidth
¶The frequency at which the unloaded loop gain extrapolates to 0 dB in the absence of additional poles and zeroes. This property takes effect when the channel is in Constant Current mode. for information about supported devices. Default Value: Determined by the value of the
NORMAL
setting of thenidcpower.Session.transient_response
property.Note
This property is not supported by all devices. Refer to Supported Properties by Device topic
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_gain_bandwidth = var var = session.channels[0,1].current_gain_bandwidthThe 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:
- LabVIEW Property: Source:Custom Transient Response:Current:Gain Bandwidth
- C Attribute: NIDCPOWER_ATTR_CURRENT_GAIN_BANDWIDTH
current_level¶
nidcpower.Session.
current_level
¶Specifies the current level, in amps, that the device attempts to generate on the specified channel(s). This property is applicable only if the
nidcpower.Session.output_function
property is set toDC_CURRENT
.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 thenidcpower.Session.current_level_range
property is set.Note
The channel must be enabled for the specified current level to take effect. Refer to the
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_level = var var = session.channels[0,1].current_levelThe 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:
- LabVIEW Property: Source:DC Current:Current Level
- C Attribute: NIDCPOWER_ATTR_CURRENT_LEVEL
current_level_autorange¶
nidcpower.Session.
current_level_autorange
¶Specifies whether NI-DCPower automatically selects the current level range based on the desired current level for the specified channels. If you set this property to
ON
, NI-DCPower ignores any changes you make to thenidcpower.Session.current_level_range
property. If you change thenidcpower.Session.current_level_autorange
property fromON
toOFF
, NI-DCPower retains the last value thenidcpower.Session.current_level_range
property was set to (or the default value if the property was never set) and uses that value as the current level range. Query thenidcpower.Session.current_level_range
property by using thenidcpower.Session._get_attribute_vi_int32()
method for information about which range NI-DCPower automatically selects. Thenidcpower.Session.current_level_autorange
property is applicable only if thenidcpower.Session.output_function
property is set toDC_CURRENT
. Default Value:OFF
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_level_autorange = var var = session.channels[0,1].current_level_autorangeThe following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Source:DC Current:Current Level Autorange
- C Attribute: NIDCPOWER_ATTR_CURRENT_LEVEL_AUTORANGE
current_level_range¶
nidcpower.Session.
current_level_range
¶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.Session.current_level_autorange
property to enable automatic selection of the current level range. Thenidcpower.Session.current_level_range
property is applicable only if thenidcpower.Session.output_function
property is set toDC_CURRENT
.nidcpower.Session.output_enabled
property 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
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_level_range = var var = session.channels[0,1].current_level_rangeThe 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:
- LabVIEW Property: Source:DC Current:Current Level Range
- C Attribute: NIDCPOWER_ATTR_CURRENT_LEVEL_RANGE
current_limit¶
nidcpower.Session.
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
nidcpower.Session.output_function
property is set toDC_VOLTAGE
and thenidcpower.Session.compliance_limit_symmetry
property is set toSYMMETRIC
.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 whichnidcpower.Session.current_limit_range
property is set.Note
The channel must be enabled for the specified current limit to take effect. Refer to the
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 = var var = session.channels[0,1].current_limitThe 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:
- LabVIEW Property: Source:DC Voltage:Current Limit
- C Attribute: NIDCPOWER_ATTR_CURRENT_LIMIT
current_limit_autorange¶
nidcpower.Session.
current_limit_autorange
¶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 property to
ON
, NI-DCPower ignores any changes you make to thenidcpower.Session.current_limit_range
property. If you change this property fromON
toOFF
, NI-DCPower retains the last value thenidcpower.Session.current_limit_range
property was set to (or the default value if the property was never set) and uses that value as the current limit range. Query thenidcpower.Session.current_limit_range
property by using thenidcpower.Session._get_attribute_vi_int32()
method for information about which range NI-DCPower automatically selects. Thenidcpower.Session.current_limit_autorange
property is applicable only if thenidcpower.Session.output_function
property is set toDC_VOLTAGE
. Default Value:OFF
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_autorange = var var = session.channels[0,1].current_limit_autorangeThe following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Source:DC Voltage:Current Limit Autorange
- C Attribute: NIDCPOWER_ATTR_CURRENT_LIMIT_AUTORANGE
current_limit_behavior¶
nidcpower.Session.
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.:
session.channels[0,1].current_limit_behavior = var var = session.channels[0,1].current_limit_behaviorThe 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¶
nidcpower.Session.
current_limit_high
¶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 <p:py:meth:`nidcpower.Session.ComplianceLimitSymmetry.html>`__ property is set to Asymmetric and the Output Method <p:py:meth:`nidcpower.Session.OutputFunction.html>`__ property is set to DC Voltage. You must also specify a Current Limit Low <p:py:meth:`nidcpower.Session.CurrentLimitLow.html>`__ to complete the asymmetric range. Valid Values: [1% of Current Limit Range <p:py:meth:`nidcpower.Session.CurrentLimitRange.html>`__, Current Limit Range <p:py:meth:`nidcpower.Session.CurrentLimitRange.html>`__] 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 <p:py:meth:`nidcpower.Session.OverrangingEnabled.html>`__ property is set to TRUE.
Note
One or more of the referenced methods are not in the Python API for this driver.
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_high = var var = session.channels[0,1].current_limit_highThe 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:
- LabVIEW Property: Source:DC Voltage:Current Limit High
- C Attribute: NIDCPOWER_ATTR_CURRENT_LIMIT_HIGH
current_limit_low¶
nidcpower.Session.
current_limit_low
¶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 <p:py:meth:`nidcpower.Session.ComplianceLimitSymmetry.html>`__ property is set to Asymmetric and the Output Method <p:py:meth:`nidcpower.Session.OutputFunction.html>`__ property is set to DC Voltage. You must also specify a Current Limit High <p:py:meth:`nidcpower.Session.CurrentLimitHigh.html>`__ to complete the asymmetric range. Valid Values: [-Current Limit Range <p:py:meth:`nidcpower.Session.CurrentLimitRange.html>`__, -1% of Current Limit Range <p:py:meth:`nidcpower.Session.CurrentLimitRange.html>`__] 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 <p:py:meth:`nidcpower.Session.OverrangingEnabled.html>`__ property is set to TRUE.
Note
One or more of the referenced methods are not in the Python API for this driver.
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_low = var var = session.channels[0,1].current_limit_lowThe 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:
- LabVIEW Property: Source:DC Voltage:Current Limit Low
- C Attribute: NIDCPOWER_ATTR_CURRENT_LIMIT_LOW
current_limit_range¶
nidcpower.Session.
current_limit_range
¶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.Session.current_limit_autorange
property to enable automatic selection of the current limit range. Thenidcpower.Session.current_limit_range
property is applicable only if thenidcpower.Session.output_function
property is set toDC_VOLTAGE
.nidcpower.Session.output_enabled
property 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
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_range = var var = session.channels[0,1].current_limit_rangeThe 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:
- LabVIEW Property: Source:DC Voltage:Current Limit Range
- C Attribute: NIDCPOWER_ATTR_CURRENT_LIMIT_RANGE
current_pole_zero_ratio¶
nidcpower.Session.
current_pole_zero_ratio
¶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
NORMAL
setting of thenidcpower.Session.transient_response
property.Note
This property is not supported by all devices. Refer to Supported Properties by Device topic
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_pole_zero_ratio = var var = session.channels[0,1].current_pole_zero_ratioThe 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:
- LabVIEW Property: Source:Custom Transient Response:Current:Pole-Zero Ratio
- C Attribute: NIDCPOWER_ATTR_CURRENT_POLE_ZERO_RATIO
dc_noise_rejection¶
nidcpower.Session.
dc_noise_rejection
¶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:
NORMAL
Note
This property is not supported by all devices. Refer to Supported Properties by Device topic
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].dc_noise_rejection = var var = session.channels[0,1].dc_noise_rejectionThe following table lists the characteristics of this property.
Characteristic Value Datatype enums.DCNoiseRejection Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Measurement:Advanced:DC Noise Rejection
- C Attribute: NIDCPOWER_ATTR_DC_NOISE_REJECTION
digital_edge_measure_trigger_input_terminal¶
nidcpower.Session.
digital_edge_measure_trigger_input_terminal
¶Specifies the input terminal for the Measure trigger. This property is used only when the
nidcpower.Session.measure_trigger_type
property is set toDIGITAL_EDGE
. for this property. You can specify any valid input terminal for this property. 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 property is not supported by all devices. Refer to Supported Properties by Device topic
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].digital_edge_measure_trigger_input_terminal = var var = session.channels[0,1].digital_edge_measure_trigger_input_terminalThe following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggers:Measure Trigger:Digital Edge:Input Terminal
- C Attribute: NIDCPOWER_ATTR_DIGITAL_EDGE_MEASURE_TRIGGER_INPUT_TERMINAL
digital_edge_pulse_trigger_input_terminal¶
nidcpower.Session.
digital_edge_pulse_trigger_input_terminal
¶Specifies the input terminal for the Pulse trigger. This property is used only when the
nidcpower.Session.pulse_trigger_type
property is set to digital edge. You can specify any valid input terminal for this property. 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 property is not supported by all devices. Refer to Supported Properties by Device for information about supported devices.
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].digital_edge_pulse_trigger_input_terminal = var var = session.channels[0,1].digital_edge_pulse_trigger_input_terminalThe following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggers:Pulse Trigger:Digital Edge:Input Terminal
- C Attribute: NIDCPOWER_ATTR_DIGITAL_EDGE_PULSE_TRIGGER_INPUT_TERMINAL
digital_edge_sequence_advance_trigger_input_terminal¶
nidcpower.Session.
digital_edge_sequence_advance_trigger_input_terminal
¶Specifies the input terminal for the Sequence Advance trigger. Use this property only when the
nidcpower.Session.sequence_advance_trigger_type
property is set toDIGITAL_EDGE
. the NI DC Power Supplies and SMUs Help for information about supported devices. You can specify any valid input terminal for this property. 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 property is not supported by all devices. Refer to Supported Properties by Device topic in
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].digital_edge_sequence_advance_trigger_input_terminal = var var = session.channels[0,1].digital_edge_sequence_advance_trigger_input_terminalThe following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggers:Sequence Advance Trigger:Digital Edge:Input Terminal
- C Attribute: NIDCPOWER_ATTR_DIGITAL_EDGE_SEQUENCE_ADVANCE_TRIGGER_INPUT_TERMINAL
digital_edge_source_trigger_input_terminal¶
nidcpower.Session.
digital_edge_source_trigger_input_terminal
¶Specifies the input terminal for the Source trigger. Use this property only when the
nidcpower.Session.source_trigger_type
property is set toDIGITAL_EDGE
. for information about supported devices. You can specify any valid input terminal for this property. 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 property is not supported by all devices. Refer to Supported Properties by Device topic
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].digital_edge_source_trigger_input_terminal = var var = session.channels[0,1].digital_edge_source_trigger_input_terminalThe following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggers:Source Trigger:Digital Edge:Input Terminal
- C Attribute: NIDCPOWER_ATTR_DIGITAL_EDGE_SOURCE_TRIGGER_INPUT_TERMINAL
digital_edge_start_trigger_input_terminal¶
nidcpower.Session.
digital_edge_start_trigger_input_terminal
¶Specifies the input terminal for the Start trigger. Use this property only when the
nidcpower.Session.start_trigger_type
property is set toDIGITAL_EDGE
. for information about supported devices. You can specify any valid input terminal for this property. 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 property is not supported by all devices. Refer to Supported Properties by Device topic
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].digital_edge_start_trigger_input_terminal = var var = session.channels[0,1].digital_edge_start_trigger_input_terminalThe following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggers:Start Trigger:Digital Edge:Input Terminal
- C Attribute: NIDCPOWER_ATTR_DIGITAL_EDGE_START_TRIGGER_INPUT_TERMINAL
driver_setup¶
nidcpower.Session.
driver_setup
¶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 property is useful when simulating a device. You can specify the driver-specific options through the DriverSetup keyword in the optionsString parameter in the
nidcpower.Session.__init__()
method or through the IVI Configuration Utility. You can specify driver-specific options through the DriverSetup keyword in the optionsString parameter in thenidcpower.Session.__init__()
method. If you do not specify a Driver Setup string, this property returns an empty string.The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Inherent IVI Attributes:Advanced Session Information:Driver Setup
- C Attribute: NIDCPOWER_ATTR_DRIVER_SETUP
exported_measure_trigger_output_terminal¶
nidcpower.Session.
exported_measure_trigger_output_terminal
¶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 property is not supported by all devices. Refer to Supported Properties by Device topic
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].exported_measure_trigger_output_terminal = var var = session.channels[0,1].exported_measure_trigger_output_terminalThe following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggers:Measure Trigger:Export Output Terminal
- C Attribute: NIDCPOWER_ATTR_EXPORTED_MEASURE_TRIGGER_OUTPUT_TERMINAL
exported_pulse_trigger_output_terminal¶
nidcpower.Session.
exported_pulse_trigger_output_terminal
¶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 property is not supported by all devices. Refer to Supported Properties by Device for information about supported devices.
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].exported_pulse_trigger_output_terminal = var var = session.channels[0,1].exported_pulse_trigger_output_terminalThe following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggers:Pulse Trigger:Export Output Terminal
- C Attribute: NIDCPOWER_ATTR_EXPORTED_PULSE_TRIGGER_OUTPUT_TERMINAL
exported_sequence_advance_trigger_output_terminal¶
nidcpower.Session.
exported_sequence_advance_trigger_output_terminal
¶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 property is not supported by all devices. Refer to Supported Properties by Device topic
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].exported_sequence_advance_trigger_output_terminal = var var = session.channels[0,1].exported_sequence_advance_trigger_output_terminalThe following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggers:Sequence Advance Trigger:Export Output Terminal
- C Attribute: NIDCPOWER_ATTR_EXPORTED_SEQUENCE_ADVANCE_TRIGGER_OUTPUT_TERMINAL
exported_source_trigger_output_terminal¶
nidcpower.Session.
exported_source_trigger_output_terminal
¶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 property is not supported by all devices. Refer to Supported Properties by Device topic
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].exported_source_trigger_output_terminal = var var = session.channels[0,1].exported_source_trigger_output_terminalThe following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggers:Source Trigger:Export Output Terminal
- C Attribute: NIDCPOWER_ATTR_EXPORTED_SOURCE_TRIGGER_OUTPUT_TERMINAL
exported_start_trigger_output_terminal¶
nidcpower.Session.
exported_start_trigger_output_terminal
¶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 property is not supported by all devices. Refer to Supported Properties by Device topic
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].exported_start_trigger_output_terminal = var var = session.channels[0,1].exported_start_trigger_output_terminalThe following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggers:Start Trigger:Export Output Terminal
- C Attribute: NIDCPOWER_ATTR_EXPORTED_START_TRIGGER_OUTPUT_TERMINAL
fetch_backlog¶
nidcpower.Session.
fetch_backlog
¶Returns the number of measurements acquired that have not been fetched yet.
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.:
var = session.channels[0,1].fetch_backlogThe following table lists the characteristics of this property.
Characteristic Value Datatype int Permissions read only Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Measurement:Fetch Backlog
- C Attribute: NIDCPOWER_ATTR_FETCH_BACKLOG
instrument_firmware_revision¶
nidcpower.Session.
instrument_firmware_revision
¶Contains the firmware revision information for the device you are currently using.
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.:
var = session.channels[0,1].instrument_firmware_revisionThe following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Inherent IVI Attributes:Instrument Identification:Firmware Revision
- C Attribute: NIDCPOWER_ATTR_INSTRUMENT_FIRMWARE_REVISION
instrument_manufacturer¶
nidcpower.Session.
instrument_manufacturer
¶Contains the name of the manufacturer for the device you are currently using.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Inherent IVI Attributes:Instrument Identification:Manufacturer
- C Attribute: NIDCPOWER_ATTR_INSTRUMENT_MANUFACTURER
instrument_model¶
nidcpower.Session.
instrument_model
¶Contains the model number or name of the device that you are currently using.
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.:
var = session.channels[0,1].instrument_modelThe following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Inherent IVI Attributes:Instrument Identification:Model
- C Attribute: NIDCPOWER_ATTR_INSTRUMENT_MODEL
interlock_input_open¶
nidcpower.Session.
interlock_input_open
¶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 property is not supported by all devices. Refer to Supported Properties by Device for information
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.:
var = session.channels[0,1].interlock_input_openThe following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read only Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Advanced:Interlock Input Open
- C Attribute: NIDCPOWER_ATTR_INTERLOCK_INPUT_OPEN
io_resource_descriptor¶
nidcpower.Session.
io_resource_descriptor
¶Indicates the resource descriptor NI-DCPower uses to identify the physical device. If you initialize NI-DCPower with a logical name, this property contains the resource descriptor that corresponds to the entry in the IVI Configuration utility. If you initialize NI-DCPower with the resource descriptor, this property contains that value.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Inherent IVI Attributes:Advanced Session Information:Resource Descriptor
- C Attribute: NIDCPOWER_ATTR_IO_RESOURCE_DESCRIPTOR
logical_name¶
nidcpower.Session.
logical_name
¶Contains the logical name you specified when opening the current IVI session. You can pass a logical name to the
nidcpower.Session.__init__()
method. The IVI Configuration utility must contain an entry for the logical name. The logical name entry refers to a method section in the IVI Configuration file. The method section specifies a physical device and initial user options.The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Inherent IVI Attributes:Advanced Session Information:Logical Name
- C Attribute: NIDCPOWER_ATTR_LOGICAL_NAME
measure_buffer_size¶
nidcpower.Session.
measure_buffer_size
¶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 Properties by Device topic in the NI DC Power Supplies and SMUs Help for more information about default values.
Note
This property is not supported by all devices. Refer to Supported Properties by Device topic
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].measure_buffer_size = var var = session.channels[0,1].measure_buffer_sizeThe 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:
- LabVIEW Property: Measurement:Advanced:Measure Buffer Size
- C Attribute: NIDCPOWER_ATTR_MEASURE_BUFFER_SIZE
measure_complete_event_delay¶
nidcpower.Session.
measure_complete_event_delay
¶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 property is not supported by all devices. Refer to Supported Properties by Device topic
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].measure_complete_event_delay = var var = session.channels[0,1].measure_complete_event_delayThe following table lists the characteristics of this property.
Characteristic Value Datatype float in seconds or datetime.timedelta Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Events:Measure Complete Event:Event Delay
- C Attribute: NIDCPOWER_ATTR_MEASURE_COMPLETE_EVENT_DELAY
measure_complete_event_output_terminal¶
nidcpower.Session.
measure_complete_event_output_terminal
¶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 property is not supported by all devices. Refer to Supported Properties by Device topic
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].measure_complete_event_output_terminal = var var = session.channels[0,1].measure_complete_event_output_terminalThe following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Events:Measure Complete Event:Output Terminal
- C Attribute: NIDCPOWER_ATTR_MEASURE_COMPLETE_EVENT_OUTPUT_TERMINAL
measure_complete_event_pulse_polarity¶
nidcpower.Session.
measure_complete_event_pulse_polarity
¶Specifies the behavior of the Measure Complete event. for information about supported devices. Default Value:
HIGH
Note
This property is not supported by all devices. Refer to Supported Properties by Device topic
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].measure_complete_event_pulse_polarity = var var = session.channels[0,1].measure_complete_event_pulse_polarityThe following table lists the characteristics of this property.
Characteristic Value Datatype enums.Polarity Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Events:Measure Complete Event:Pulse:Polarity
- C Attribute: NIDCPOWER_ATTR_MEASURE_COMPLETE_EVENT_PULSE_POLARITY
measure_complete_event_pulse_width¶
nidcpower.Session.
measure_complete_event_pulse_width
¶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 property is not supported by all devices. Refer to Supported Properties by Device topic
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].measure_complete_event_pulse_width = var var = session.channels[0,1].measure_complete_event_pulse_widthThe 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:
- LabVIEW Property: Events:Measure Complete Event:Pulse:Width
- C Attribute: NIDCPOWER_ATTR_MEASURE_COMPLETE_EVENT_PULSE_WIDTH
measure_record_delta_time¶
nidcpower.Session.
measure_record_delta_time
¶Queries the amount of time, in seconds, between between the start of two consecutive measurements in a measure record. Only query this property after the desired measurement settings are committed. for information about supported devices. two measurements and the rest would differ.
Note
This property is not available when Auto Zero is configured to Once because the amount of time between the first
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.:
var = session.channels[0,1].measure_record_delta_timeThe following table lists the characteristics of this property.
Characteristic Value Datatype float in seconds or datetime.timedelta Permissions read only Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Measurement:Measure Record Delta Time
- C Attribute: NIDCPOWER_ATTR_MEASURE_RECORD_DELTA_TIME
measure_record_length¶
nidcpower.Session.
measure_record_length
¶Specifies how many measurements compose a measure record. When this property is set to a value greater than 1, the
nidcpower.Session.measure_when
property must be set toAUTOMATICALLY_AFTER_SOURCE_COMPLETE
orON_MEASURE_TRIGGER
. for information about supported devices. Valid Values: 1 to 16,777,216 Default Value: 1Note
This property is not available in a session involving multiple channels.
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].measure_record_length = var var = session.channels[0,1].measure_record_lengthThe 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:
- LabVIEW Property: Measurement:Measure Record Length
- C Attribute: NIDCPOWER_ATTR_MEASURE_RECORD_LENGTH
measure_record_length_is_finite¶
nidcpower.Session.
measure_record_length_is_finite
¶Specifies whether to take continuous measurements. Call the
nidcpower.Session.abort()
method to stop continuous measurements. When this property is set to False and thenidcpower.Session.source_mode
property is set toSINGLE_POINT
, thenidcpower.Session.measure_when
property must be set toAUTOMATICALLY_AFTER_SOURCE_COMPLETE
orON_MEASURE_TRIGGER
. When this property is set to False and thenidcpower.Session.source_mode
property is set toSEQUENCE
, thenidcpower.Session.measure_when
property must be set toON_MEASURE_TRIGGER
. for information about supported devices. Default Value: TrueNote
This property is not available in a session involving multiple channels.
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].measure_record_length_is_finite = var var = session.channels[0,1].measure_record_length_is_finiteThe following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Measurement:Measure Record Length Is Finite
- C Attribute: NIDCPOWER_ATTR_MEASURE_RECORD_LENGTH_IS_FINITE
measure_trigger_type¶
nidcpower.Session.
measure_trigger_type
¶Specifies the behavior of the Measure trigger. for information about supported devices. Default Value:
DIGITAL_EDGE
Note
This property is not supported by all devices. Refer to Supported Properties by Device topic
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].measure_trigger_type = var var = session.channels[0,1].measure_trigger_typeThe following table lists the characteristics of this property.
Characteristic Value Datatype enums.TriggerType Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggers:Measure Trigger:Trigger Type
- C Attribute: NIDCPOWER_ATTR_MEASURE_TRIGGER_TYPE
measure_when¶
nidcpower.Session.
measure_when
¶Specifies when the measure unit should acquire measurements. Unless this property is configured to
ON_MEASURE_TRIGGER
, thenidcpower.Session.measure_trigger_type
property 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 thenidcpower.Session.source_mode
property is set toSINGLE_POINT
, the default value isON_DEMAND
. This value supports only thenidcpower.Session.measure()
method andnidcpower.Session.measure_multiple()
method. If thenidcpower.Session.source_mode
property is set toSEQUENCE
, the default value isAUTOMATICALLY_AFTER_SOURCE_COMPLETE
. This value supports only thenidcpower.Session.fetch_multiple()
method.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].measure_when = var var = session.channels[0,1].measure_whenThe following table lists the characteristics of this property.
Characteristic Value Datatype enums.MeasureWhen Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Measurement:Advanced:Measure When
- C Attribute: NIDCPOWER_ATTR_MEASURE_WHEN
output_capacitance¶
nidcpower.Session.
output_capacitance
¶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 property is not supported by all devices. Refer to Supported Properties by Device topic
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].output_capacitance = var var = session.channels[0,1].output_capacitanceThe following table lists the characteristics of this property.
Characteristic Value Datatype enums.OutputCapacitance Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Source:Advanced:Output Capacitance
- C Attribute: NIDCPOWER_ATTR_OUTPUT_CAPACITANCE
output_connected¶
nidcpower.Session.
output_connected
¶Specifies whether the output relay is connected (closed) or disconnected (open). The
nidcpower.Session.output_enabled
property does not change based on this property; they are independent of each other. about supported devices. Set this property to 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: TrueNote
Only disconnect the output when disconnecting is necessary for your application. For example, a battery connected
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].output_connected = var var = session.channels[0,1].output_connectedThe following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Source:Output Connected
- C Attribute: NIDCPOWER_ATTR_OUTPUT_CONNECTED
output_enabled¶
nidcpower.Session.
output_enabled
¶Specifies whether the output is enabled (True) or disabled (False). Depending on the value you specify for the
nidcpower.Session.output_function
property, you also must set the voltage level or current level in addition to enabling the output thenidcpower.Session.initiate()
method. 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 True if you use thenidcpower.Session.__init__()
method to open the session. Otherwise the default value is 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
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].output_enabled = var var = session.channels[0,1].output_enabledThe following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Source:Output Enabled
- C Attribute: NIDCPOWER_ATTR_OUTPUT_ENABLED
output_function¶
nidcpower.Session.
output_function
¶Configures the method to generate on the specified channel(s). When
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 properties to configure the channel whenDC_VOLTAGE
is selected:nidcpower.Session.voltage_level
nidcpower.Session.current_limit
nidcpower.Session.current_limit_high
nidcpower.Session.current_limit_low
nidcpower.Session.voltage_level_range
nidcpower.Session.current_limit_range
nidcpower.Session.compliance_limit_symmetry
WhenDC_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 properties to configure the channel whenDC_CURRENT
is selected:nidcpower.Session.current_level
nidcpower.Session.voltage_limit
nidcpower.Session.voltage_limit_high
nidcpower.Session.voltage_limit_low
nidcpower.Session.current_level_range
nidcpower.Session.voltage_limit_range
nidcpower.Session.compliance_limit_symmetry
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].output_function = var var = session.channels[0,1].output_functionThe following table lists the characteristics of this property.
Characteristic Value Datatype enums.OutputFunction Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Source:Output Function
- C Attribute: NIDCPOWER_ATTR_OUTPUT_FUNCTION
output_resistance¶
nidcpower.Session.
output_resistance
¶Specifies the output resistance that the device attempts to generate for the specified channel(s). This property is available only when you set the
nidcpower.Session.output_function
property 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.0Note
This property is not supported by all devices. Refer to Supported Properties by Device topic for information
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].output_resistance = var var = session.channels[0,1].output_resistanceThe 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:
- LabVIEW Property: Source:Output Resistance
- C Attribute: NIDCPOWER_ATTR_OUTPUT_RESISTANCE
overranging_enabled¶
nidcpower.Session.
overranging_enabled
¶Specifies whether NI-DCPower allows setting the voltage level, current level, voltage limit and current limit outside the device specification limits. 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: False
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].overranging_enabled = var var = session.channels[0,1].overranging_enabledThe following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Source:Advanced:Overranging Enabled
- C Attribute: NIDCPOWER_ATTR_OVERRANGING_ENABLED
ovp_enabled¶
nidcpower.Session.
ovp_enabled
¶Enables (True) or disables (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: False
Note
This property is not supported by all devices. Refer to Supported Properties by Device topic
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].ovp_enabled = var var = session.channels[0,1].ovp_enabledThe following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Source:Advanced:OVP Enabled
- C Attribute: NIDCPOWER_ATTR_OVP_ENABLED
ovp_limit¶
nidcpower.Session.
ovp_limit
¶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 property is not supported by all devices. Refer to Supported Properties by Device topic
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].ovp_limit = var var = session.channels[0,1].ovp_limitThe 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:
- LabVIEW Property: Source:Advanced:OVP Limit
- C Attribute: NIDCPOWER_ATTR_OVP_LIMIT
power_line_frequency¶
nidcpower.Session.
power_line_frequency
¶Specifies the power line frequency for specified channel(s). NI-DCPower uses this value to select a timebase for setting the
nidcpower.Session.aperture_time
property 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 property is not supported by all devices. Refer to the Supported Properties by Device topic
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. 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].power_line_frequency = var var = session.channels[0,1].power_line_frequencyThe 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:
- LabVIEW Property: Measurement:Power Line Frequency
- C Attribute: NIDCPOWER_ATTR_POWER_LINE_FREQUENCY
power_source¶
nidcpower.Session.
power_source
¶Specifies the power source to use. NI-DCPower switches the power source used by the device to the specified value. Default Value:
AUTOMATIC
is set toAUTOMATIC
. However, if the session is in the Committed or Uncommitted state when you set this property, the power source selection only occurs after you call thenidcpower.Session.initiate()
method.Note
Automatic selection is not persistent and occurs only at the time this property
The following table lists the characteristics of this property.
Characteristic Value Datatype enums.PowerSource Permissions read-write Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Advanced:Power Source
- C Attribute: NIDCPOWER_ATTR_POWER_SOURCE
power_source_in_use¶
nidcpower.Session.
power_source_in_use
¶Indicates whether the device is using the internal or auxiliary power source to generate power.
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.:
var = session.channels[0,1].power_source_in_useThe following table lists the characteristics of this property.
Characteristic Value Datatype enums.PowerSourceInUse Permissions read only Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Advanced:Power Source In Use
- C Attribute: NIDCPOWER_ATTR_POWER_SOURCE_IN_USE
pulse_bias_current_level¶
nidcpower.Session.
pulse_bias_current_level
¶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 property is applicable only if the
nidcpower.Session.output_function
property is set toPULSE_CURRENT
. Valid Values: The valid values for this property are defined by the values you specify for thenidcpower.Session.pulse_current_level_range
property.Note
This property is not supported by all devices. Refer to Supported Properties by Device for information about supported devices.
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].pulse_bias_current_level = var var = session.channels[0,1].pulse_bias_current_levelThe 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:
- LabVIEW Property: Source:Pulse Current:Pulse Bias Current Level
- C Attribute: NIDCPOWER_ATTR_PULSE_BIAS_CURRENT_LEVEL
pulse_bias_current_limit¶
nidcpower.Session.
pulse_bias_current_limit
¶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 property is applicable only if the
nidcpower.Session.output_function
property is set toPULSE_VOLTAGE
. Valid Values: The valid values for this property are defined by the values you specify for thenidcpower.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.
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].pulse_bias_current_limit = var var = session.channels[0,1].pulse_bias_current_limitThe 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:
- LabVIEW Property: Source:Pulse Voltage:Pulse Bias Current Limit
- C Attribute: NIDCPOWER_ATTR_PULSE_BIAS_CURRENT_LIMIT
pulse_bias_current_limit_high¶
nidcpower.Session.
pulse_bias_current_limit_high
¶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 <p:py:meth:`nidcpower.Session.ComplianceLimitSymmetry.html>`__ property is set to Asymmetric and the Output Method <p:py:meth:`nidcpower.Session.OutputFunction.html>`__ property is set to Pulse Voltage. You must also specify a Pulse Bias Current Limit Low <p:py:meth:`nidcpower.Session.PulseBiasCurrentLimitLow.html>`__ to complete the asymmetric range. Valid Values: [1% of Pulse Current Limit Range <p:py:meth:`nidcpower.Session.PulseCurrentLimitRange.html>`__, Pulse Current Limit Range <p:py:meth:`nidcpower.Session.PulseCurrentLimitRange.html>`__] 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 <p:py:meth:`nidcpower.Session.OverrangingEnabled.html>`__ property is set to TRUE or if the Output Method <p:py:meth:`nidcpower.Session.OutputFunction.html>`__ property is set to a pulsing method.
Note
One or more of the referenced methods are not in the Python API for this driver.
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].pulse_bias_current_limit_high = var var = session.channels[0,1].pulse_bias_current_limit_highThe 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:
- LabVIEW Property: Source:Pulse Voltage:Pulse Bias Current Limit High
- C Attribute: NIDCPOWER_ATTR_PULSE_BIAS_CURRENT_LIMIT_HIGH
pulse_bias_current_limit_low¶
nidcpower.Session.
pulse_bias_current_limit_low
¶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 <p:py:meth:`nidcpower.Session.ComplianceLimitSymmetry.html>`__ property is set to Asymmetric and the Output Method <p:py:meth:`nidcpower.Session.OutputFunction.html>`__ property is set to Pulse Voltage. You must also specify a Pulse Bias Current Limit High <p:py:meth:`nidcpower.Session.PulseBiasCurrentLimitHigh.html>`__ to complete the asymmetric range. Valid Values: [-Pulse Current Limit Range <p:py:meth:`nidcpower.Session.PulseCurrentLimitRange.html>`__, -1% of Pulse Current Limit Range <p:py:meth:`nidcpower.Session.PulseCurrentLimitRange.html>`__] 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 <p:py:meth:`nidcpower.Session.OverrangingEnabled.html>`__ property is set to TRUE or if the Output Method <p:py:meth:`nidcpower.Session.OutputFunction.html>`__ property is set to a pulsing method.
Note
One or more of the referenced methods are not in the Python API for this driver.
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].pulse_bias_current_limit_low = var var = session.channels[0,1].pulse_bias_current_limit_lowThe 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:
- LabVIEW Property: Source:Pulse Voltage:Pulse Bias Current Limit Low
- C Attribute: NIDCPOWER_ATTR_PULSE_BIAS_CURRENT_LIMIT_LOW
pulse_bias_delay¶
nidcpower.Session.
pulse_bias_delay
¶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 property is not supported by all devices. Refer to Supported Properties by Device for information about supported devices.
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].pulse_bias_delay = var var = session.channels[0,1].pulse_bias_delayThe 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:
- LabVIEW Property: Source:Advanced:Pulse Bias Delay
- C Attribute: NIDCPOWER_ATTR_PULSE_BIAS_DELAY
pulse_bias_voltage_level¶
nidcpower.Session.
pulse_bias_voltage_level
¶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 property is applicable only if the
nidcpower.Session.output_function
property is set toPULSE_VOLTAGE
. Valid Values: The valid values for this property are defined by the values you specify for thenidcpower.Session.pulse_voltage_level_range
property.Note
This property is not supported by all devices. Refer to Supported Properties by Device for information about supported devices.
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].pulse_bias_voltage_level = var var = session.channels[0,1].pulse_bias_voltage_levelThe 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:
- LabVIEW Property: Source:Pulse Voltage:Pulse Bias Voltage Level
- C Attribute: NIDCPOWER_ATTR_PULSE_BIAS_VOLTAGE_LEVEL
pulse_bias_voltage_limit¶
nidcpower.Session.
pulse_bias_voltage_limit
¶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 property is applicable only if the
nidcpower.Session.output_function
property is set toPULSE_CURRENT
. Valid Values: The valid values for this property are defined by the values you specify for thenidcpower.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.
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].pulse_bias_voltage_limit = var var = session.channels[0,1].pulse_bias_voltage_limitThe 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:
- LabVIEW Property: Source:Pulse Current:Pulse Bias Voltage Limit
- C Attribute: NIDCPOWER_ATTR_PULSE_BIAS_VOLTAGE_LIMIT
pulse_bias_voltage_limit_high¶
nidcpower.Session.
pulse_bias_voltage_limit_high
¶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 <p:py:meth:`nidcpower.Session.ComplianceLimitSymmetry.html>`__ property is set to Asymmetric and the Output Method <p:py:meth:`nidcpower.Session.OutputFunction.html>`__ property is set to Pulse Current. You must also specify a Pulse Bias Voltage Limit Low <p:py:meth:`nidcpower.Session.PulseBiasVoltageLimitLow.html>`__ to complete the asymmetric range. Valid Values: [1% of Pulse Voltage Limit Range <p:py:meth:`nidcpower.Session.PulseVoltageLimitRange.html>`__, Pulse Voltage Limit Range <p:py:meth:`nidcpower.Session.PulseVoltageLimitRange.html>`__] 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 <p:py:meth:`nidcpower.Session.OverrangingEnabled.html>`__ property is set to TRUE or if the Output Method <p:py:meth:`nidcpower.Session.OutputFunction.html>`__ property is set to a pulsing method.
Note
One or more of the referenced methods are not in the Python API for this driver.
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].pulse_bias_voltage_limit_high = var var = session.channels[0,1].pulse_bias_voltage_limit_highThe 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:
- LabVIEW Property: Source:Pulse Current:Pulse Bias Voltage Limit High
- C Attribute: NIDCPOWER_ATTR_PULSE_BIAS_VOLTAGE_LIMIT_HIGH
pulse_bias_voltage_limit_low¶
nidcpower.Session.
pulse_bias_voltage_limit_low
¶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 <p:py:meth:`nidcpower.Session.ComplianceLimitSymmetry.html>`__ property is set to Asymmetric and the Output Method <p:py:meth:`nidcpower.Session.OutputFunction.html>`__ property is set to Pulse Current. You must also specify a Pulse Bias Voltage Limit High <p:py:meth:`nidcpower.Session.PulseBiasVoltageLimitHigh.html>`__ to complete the asymmetric range. Valid Values: [-Pulse Voltage Limit Range <p:py:meth:`nidcpower.Session.PulseVoltageLimitRange.html>`__, -1% of Pulse Voltage Limit Range <p:py:meth:`nidcpower.Session.PulseVoltageLimitRange.html>`__] 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 <p:py:meth:`nidcpower.Session.OverrangingEnabled.html>`__ property is set to TRUE or if the Output Method <p:py:meth:`nidcpower.Session.OutputFunction.html>`__ property is set to a pulsing method.
Note
One or more of the referenced methods are not in the Python API for this driver.
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].pulse_bias_voltage_limit_low = var var = session.channels[0,1].pulse_bias_voltage_limit_lowThe 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:
- LabVIEW Property: Source:Pulse Current:Pulse Bias Voltage Limit Low
- C Attribute: NIDCPOWER_ATTR_PULSE_BIAS_VOLTAGE_LIMIT_LOW
pulse_complete_event_output_terminal¶
nidcpower.Session.
pulse_complete_event_output_terminal
¶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 property is not supported by all devices. Refer to Supported Properties by Device for information about supported devices.
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].pulse_complete_event_output_terminal = var var = session.channels[0,1].pulse_complete_event_output_terminalThe following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Events:Pulse Complete Event:Output Terminal
- C Attribute: NIDCPOWER_ATTR_PULSE_COMPLETE_EVENT_OUTPUT_TERMINAL
pulse_complete_event_pulse_polarity¶
nidcpower.Session.
pulse_complete_event_pulse_polarity
¶Specifies the behavior of the Pulse Complete event. Default Value:
HIGH
Note
This property is not supported by all devices. Refer to Supported Properties by Device for information about supported devices.
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].pulse_complete_event_pulse_polarity = var var = session.channels[0,1].pulse_complete_event_pulse_polarityThe following table lists the characteristics of this property.
Characteristic Value Datatype enums.Polarity Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Events:Pulse Complete Event:Pulse:Polarity
- C Attribute: NIDCPOWER_ATTR_PULSE_COMPLETE_EVENT_PULSE_POLARITY
pulse_complete_event_pulse_width¶
nidcpower.Session.
pulse_complete_event_pulse_width
¶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 property is not supported by all devices. Refer to Supported Properties by Device for information about supported devices.
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].pulse_complete_event_pulse_width = var var = session.channels[0,1].pulse_complete_event_pulse_widthThe 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:
- LabVIEW Property: Events:Pulse Complete Event:Pulse:Width
- C Attribute: NIDCPOWER_ATTR_PULSE_COMPLETE_EVENT_PULSE_WIDTH
pulse_current_level¶
nidcpower.Session.
pulse_current_level
¶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 property is applicable only if the
nidcpower.Session.output_function
property is set toPULSE_CURRENT
. Valid Values: The valid values for this property are defined by the values you specify for thenidcpower.Session.pulse_current_level_range
property.Note
This property is not supported by all devices. Refer to Supported Properties by Device for information about supported devices.
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].pulse_current_level = var var = session.channels[0,1].pulse_current_levelThe 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:
- LabVIEW Property: Source:Pulse Current:Pulse Current Level
- C Attribute: NIDCPOWER_ATTR_PULSE_CURRENT_LEVEL
pulse_current_level_range¶
nidcpower.Session.
pulse_current_level_range
¶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 property is applicable only if the
nidcpower.Session.output_function
property is set toPULSE_CURRENT
. For valid ranges, refer to the ranges topic for your device in the NI DC Power Supplies and SMUs Help.Note
This property is not supported by all devices. Refer to Supported Properties by Device for information about supported devices.
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].pulse_current_level_range = var var = session.channels[0,1].pulse_current_level_rangeThe 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:
- LabVIEW Property: Source:Pulse Current:Pulse Current Level Range
- C Attribute: NIDCPOWER_ATTR_PULSE_CURRENT_LEVEL_RANGE
pulse_current_limit¶
nidcpower.Session.
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
nidcpower.Session.output_function
property is set toPULSE_VOLTAGE
and thenidcpower.Session.compliance_limit_symmetry
property is set toSYMMETRIC
. Valid Values: The valid values for this property are defined by the values you specify for thenidcpower.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.
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].pulse_current_limit = var var = session.channels[0,1].pulse_current_limitThe 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:
- LabVIEW Property: Source:Pulse Voltage:Pulse Current Limit
- C Attribute: NIDCPOWER_ATTR_PULSE_CURRENT_LIMIT
pulse_current_limit_high¶
nidcpower.Session.
pulse_current_limit_high
¶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 <p:py:meth:`nidcpower.Session.ComplianceLimitSymmetry.html>`__ property is set to Asymmetric and the Output Method <p:py:meth:`nidcpower.Session.OutputFunction.html>`__ property is set to Pulse Voltage. You must also specify a Pulse Current Limit Low <p:py:meth:`nidcpower.Session.PulseCurrentLimitLow.html>`__ to complete the asymmetric range. Valid Values: [1% of Pulse Current Limit Range <p:py:meth:`nidcpower.Session.PulseCurrentLimitRange.html>`__, Pulse Current Limit Range <p:py:meth:`nidcpower.Session.PulseCurrentLimitRange.html>`__] 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 <p:py:meth:`nidcpower.Session.OverrangingEnabled.html>`__ property is set to TRUE or if the Output Method <p:py:meth:`nidcpower.Session.OutputFunction.html>`__ property is set to a pulsing method.
Note
One or more of the referenced methods are not in the Python API for this driver.
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].pulse_current_limit_high = var var = session.channels[0,1].pulse_current_limit_highThe 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:
- LabVIEW Property: Source:Pulse Voltage:Pulse Current Limit High
- C Attribute: NIDCPOWER_ATTR_PULSE_CURRENT_LIMIT_HIGH
pulse_current_limit_low¶
nidcpower.Session.
pulse_current_limit_low
¶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 <p:py:meth:`nidcpower.Session.ComplianceLimitSymmetry.html>`__ property is set to Asymmetric and the Output Method <p:py:meth:`nidcpower.Session.OutputFunction.html>`__ property is set to Pulse Voltage. You must also specify a Pulse Current Limit High <p:py:meth:`nidcpower.Session.PulseCurrentLimitHigh.html>`__ to complete the asymmetric range. Valid Values: [-Pulse Current Limit Range <p:py:meth:`nidcpower.Session.PulseCurrentLimitRange.html>`__, -1% of Pulse Current Limit Range <p:py:meth:`nidcpower.Session.PulseCurrentLimitRange.html>`__] 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 <p:py:meth:`nidcpower.Session.OverrangingEnabled.html>`__ property is set to TRUE or if the Output Method <p:py:meth:`nidcpower.Session.OutputFunction.html>`__ property is set to a pulsing method.
Note
One or more of the referenced methods are not in the Python API for this driver.
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].pulse_current_limit_low = var var = session.channels[0,1].pulse_current_limit_lowThe 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:
- LabVIEW Property: Source:Pulse Voltage:Pulse Current Limit Low
- C Attribute: NIDCPOWER_ATTR_PULSE_CURRENT_LIMIT_LOW
pulse_current_limit_range¶
nidcpower.Session.
pulse_current_limit_range
¶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 property is applicable only if the
nidcpower.Session.output_function
property is set toPULSE_VOLTAGE
. For valid ranges, refer to the ranges topic for your device in the NI DC Power Supplies and SMUs Help.Note
This property is not supported by all devices. Refer to Supported Properties by Device for information about supported devices.
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].pulse_current_limit_range = var var = session.channels[0,1].pulse_current_limit_rangeThe 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:
- LabVIEW Property: Source:Pulse Voltage:Pulse Current Limit Range
- C Attribute: NIDCPOWER_ATTR_PULSE_CURRENT_LIMIT_RANGE
pulse_off_time¶
nidcpower.Session.
pulse_off_time
¶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 property is not supported by all devices. Refer to Supported Properties by Device for information about supported devices.
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].pulse_off_time = var var = session.channels[0,1].pulse_off_timeThe following table lists the characteristics of this property.
Characteristic Value Datatype float in seconds or datetime.timedelta Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Source:Advanced:Pulse Off Time
- C Attribute: NIDCPOWER_ATTR_PULSE_OFF_TIME
pulse_on_time¶
nidcpower.Session.
pulse_on_time
¶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 property is not supported by all devices. Refer to Supported Properties by Device for information about supported devices.
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].pulse_on_time = var var = session.channels[0,1].pulse_on_timeThe following table lists the characteristics of this property.
Characteristic Value Datatype float in seconds or datetime.timedelta Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Source:Advanced:Pulse On Time
- C Attribute: NIDCPOWER_ATTR_PULSE_ON_TIME
pulse_trigger_type¶
nidcpower.Session.
pulse_trigger_type
¶Specifies the behavior of the Pulse trigger. Default Value:
NONE
Note
This property is not supported by all devices. Refer to Supported Properties by Device for information about supported devices.
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].pulse_trigger_type = var var = session.channels[0,1].pulse_trigger_typeThe following table lists the characteristics of this property.
Characteristic Value Datatype enums.TriggerType Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggers:Pulse Trigger:Trigger Type
- C Attribute: NIDCPOWER_ATTR_PULSE_TRIGGER_TYPE
pulse_voltage_level¶
nidcpower.Session.
pulse_voltage_level
¶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
nidcpower.Session.output_function
property is set toPULSE_VOLTAGE
. Valid Values: The valid values for this property are defined by the values you specify for thenidcpower.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.
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].pulse_voltage_level = var var = session.channels[0,1].pulse_voltage_levelThe 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:
- LabVIEW Property: Source:Pulse Voltage:Pulse Voltage Level
- C Attribute: NIDCPOWER_ATTR_PULSE_VOLTAGE_LEVEL
pulse_voltage_level_range¶
nidcpower.Session.
pulse_voltage_level_range
¶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 property is applicable only if the
nidcpower.Session.output_function
property is set toPULSE_VOLTAGE
. For valid ranges, refer to the ranges topic for your device in the NI DC Power Supplies and SMUs Help.Note
This property is not supported by all devices. Refer to Supported Properties by Device for information about supported devices.
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].pulse_voltage_level_range = var var = session.channels[0,1].pulse_voltage_level_rangeThe 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:
- LabVIEW Property: Source:Pulse Voltage:Pulse Voltage Level Range
- C Attribute: NIDCPOWER_ATTR_PULSE_VOLTAGE_LEVEL_RANGE
pulse_voltage_limit¶
nidcpower.Session.
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
nidcpower.Session.output_function
property is set toPULSE_CURRENT
and thenidcpower.Session.compliance_limit_symmetry
property is set toSYMMETRIC
. Valid Values: The valid values for this property are defined by the values you specify for thenidcpower.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.
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].pulse_voltage_limit = var var = session.channels[0,1].pulse_voltage_limitThe 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:
- LabVIEW Property: Source:Pulse Current:Pulse Voltage Limit
- C Attribute: NIDCPOWER_ATTR_PULSE_VOLTAGE_LIMIT
pulse_voltage_limit_high¶
nidcpower.Session.
pulse_voltage_limit_high
¶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 <p:py:meth:`nidcpower.Session.ComplianceLimitSymmetry.html>`__ property is set to Asymmetric and the Output Method <p:py:meth:`nidcpower.Session.OutputFunction.html>`__ property is set to Pulse Current. You must also specify a Pulse Voltage Limit Low <p:py:meth:`nidcpower.Session.PulseVoltageLimitLow.html>`__ to complete the asymmetric range. Valid Values: [1% of Pulse Voltage Limit Range <p:py:meth:`nidcpower.Session.PulseVoltageLimitRange.html>`__, Pulse Voltage Limit Range <p:py:meth:`nidcpower.Session.PulseVoltageLimitRange.html>`__] 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 <p:py:meth:`nidcpower.Session.OverrangingEnabled.html>`__ property is set to TRUE or if the Output Method <p:py:meth:`nidcpower.Session.OutputFunction.html>`__ property is set to a pulsing method.
Note
One or more of the referenced methods are not in the Python API for this driver.
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].pulse_voltage_limit_high = var var = session.channels[0,1].pulse_voltage_limit_highThe 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:
- LabVIEW Property: Source:Pulse Current:Pulse Voltage Limit High
- C Attribute: NIDCPOWER_ATTR_PULSE_VOLTAGE_LIMIT_HIGH
pulse_voltage_limit_low¶
nidcpower.Session.
pulse_voltage_limit_low
¶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 <p:py:meth:`nidcpower.Session.ComplianceLimitSymmetry.html>`__ property is set to Asymmetric and the Output Method <p:py:meth:`nidcpower.Session.OutputFunction.html>`__ property is set to Pulse Current. You must also specify a Pulse Voltage Limit High <p:py:meth:`nidcpower.Session.PulseVoltageLimitHigh.html>`__ to complete the asymmetric range. Valid Values: [-Pulse Voltage Limit Range <p:py:meth:`nidcpower.Session.PulseVoltageLimitRange.html>`__, -1% of Pulse Voltage Limit Range <p:py:meth:`nidcpower.Session.PulseVoltageLimitRange.html>`__] 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 <p:py:meth:`nidcpower.Session.OverrangingEnabled.html>`__ property is set to TRUE or if the Output Method <p:py:meth:`nidcpower.Session.OutputFunction.html>`__ property is set to a pulsing method.
Note
One or more of the referenced methods are not in the Python API for this driver.
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].pulse_voltage_limit_low = var var = session.channels[0,1].pulse_voltage_limit_lowThe 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:
- LabVIEW Property: Source:Pulse Current:Pulse Voltage Limit Low
- C Attribute: NIDCPOWER_ATTR_PULSE_VOLTAGE_LIMIT_LOW
pulse_voltage_limit_range¶
nidcpower.Session.
pulse_voltage_limit_range
¶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 property is applicable only if the
nidcpower.Session.output_function
property is set toPULSE_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.Session.output_enabled
property for more information about enabling the output channel.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].pulse_voltage_limit_range = var var = session.channels[0,1].pulse_voltage_limit_rangeThe 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:
- LabVIEW Property: Source:Pulse Current:Pulse Voltage Limit Range
- C Attribute: NIDCPOWER_ATTR_PULSE_VOLTAGE_LIMIT_RANGE
query_instrument_status¶
nidcpower.Session.
query_instrument_status
¶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 property to False to disable status checking and maximize performance. NI-DCPower ignores status checking for particular properties regardless of the setting of this property. Use the
nidcpower.Session.__init__()
method to override this value. Default Value: TrueThe following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Inherent IVI Attributes:User Options:Query Instrument Status
- C Attribute: NIDCPOWER_ATTR_QUERY_INSTRUMENT_STATUS
ready_for_pulse_trigger_event_output_terminal¶
nidcpower.Session.
ready_for_pulse_trigger_event_output_terminal
¶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 property is not supported by all devices. Refer to Supported Properties by Device for information about supported devices.
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].ready_for_pulse_trigger_event_output_terminal = var var = session.channels[0,1].ready_for_pulse_trigger_event_output_terminalThe following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Events:Ready For Pulse Trigger Event:Output Terminal
- C Attribute: NIDCPOWER_ATTR_READY_FOR_PULSE_TRIGGER_EVENT_OUTPUT_TERMINAL
ready_for_pulse_trigger_event_pulse_polarity¶
nidcpower.Session.
ready_for_pulse_trigger_event_pulse_polarity
¶Specifies the behavior of the Ready For Pulse Trigger event. Default Value:
HIGH
Note
This property is not supported by all devices. Refer to Supported Properties by Device for information about supported devices.
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].ready_for_pulse_trigger_event_pulse_polarity = var var = session.channels[0,1].ready_for_pulse_trigger_event_pulse_polarityThe following table lists the characteristics of this property.
Characteristic Value Datatype enums.Polarity Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Events:Ready For Pulse Trigger Event:Pulse:Polarity
- C Attribute: NIDCPOWER_ATTR_READY_FOR_PULSE_TRIGGER_EVENT_PULSE_POLARITY
ready_for_pulse_trigger_event_pulse_width¶
nidcpower.Session.
ready_for_pulse_trigger_event_pulse_width
¶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 property is not supported by all devices. Refer to Supported Properties by Device for information about supported devices.
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].ready_for_pulse_trigger_event_pulse_width = var var = session.channels[0,1].ready_for_pulse_trigger_event_pulse_widthThe 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:
- LabVIEW Property: Events:Ready For Pulse Trigger Event:Pulse:Width
- C Attribute: NIDCPOWER_ATTR_READY_FOR_PULSE_TRIGGER_EVENT_PULSE_WIDTH
reset_average_before_measurement¶
nidcpower.Session.
reset_average_before_measurement
¶Specifies whether the measurement returned from any measurement call starts with a new measurement call (True) or returns a measurement that has already begun or completed(False). for information about supported devices. When you set the
nidcpower.Session.samples_to_average
property 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 thenidcpower.Session.measure_multiple()
method. To force a synchronization in the running state, set this property to True, and then run thenidcpower.Session.measure_multiple()
method, specifying all channels in the channel name parameter. You can set thenidcpower.Session.reset_average_before_measurement
property to False after thenidcpower.Session.measure_multiple()
method completes. Default Value: TrueNote
This property is not supported by all devices. Refer to Supported Properties by Device topic
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].reset_average_before_measurement = var var = session.channels[0,1].reset_average_before_measurementThe following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Measurement:Advanced:Reset Average Before Measurement
- C Attribute: NIDCPOWER_ATTR_RESET_AVERAGE_BEFORE_MEASUREMENT
samples_to_average¶
nidcpower.Session.
samples_to_average
¶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 property 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
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].samples_to_average = var var = session.channels[0,1].samples_to_averageThe 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:
- LabVIEW Property: Measurement:Samples To Average
- C Attribute: NIDCPOWER_ATTR_SAMPLES_TO_AVERAGE
self_calibration_persistence¶
nidcpower.Session.
self_calibration_persistence
¶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.Session.reset_device()
method is called or the machine is powered down. This property affects the behavior of thenidcpower.Session.self_cal()
method. When set toKEEP_IN_MEMORY
, the values calculated by thenidcpower.Session.self_cal()
method are used in the existing session, as well as in all further sessions until you call thenidcpower.Session.reset_device()
method or restart the machine. When you set this property toWRITE_TO_EEPROM
, the values calculated by thenidcpower.Session.self_cal()
method are written to hardware and used in the existing session and in all subsequent sessions until another call to thenidcpower.Session.self_cal()
method is made. about supported devices. Default Value:KEEP_IN_MEMORY
Note
This property is not supported by all devices. Refer to Supported Properties by Device for information
The following table lists the characteristics of this property.
Characteristic Value Datatype enums.SelfCalibrationPersistence Permissions read-write Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Advanced:Self-Calibration Persistence
- C Attribute: NIDCPOWER_ATTR_SELF_CALIBRATION_PERSISTENCE
sense¶
nidcpower.Session.
sense
¶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
LOCAL
if the device supports local sense. Otherwise, the default and only supported value isREMOTE
.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].sense = var var = session.channels[0,1].senseThe following table lists the characteristics of this property.
Characteristic Value Datatype enums.Sense Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Measurement:Sense
- C Attribute: NIDCPOWER_ATTR_SENSE
sequence_advance_trigger_type¶
nidcpower.Session.
sequence_advance_trigger_type
¶Specifies the behavior of the Sequence Advance trigger. for information about supported devices. Default Value:
NONE
Note
This property is not supported by all devices. Refer to Supported Properties by Device topic
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_advance_trigger_type = var var = session.channels[0,1].sequence_advance_trigger_typeThe following table lists the characteristics of this property.
Characteristic Value Datatype enums.TriggerType Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggers:Sequence Advance Trigger:Trigger Type
- C Attribute: NIDCPOWER_ATTR_SEQUENCE_ADVANCE_TRIGGER_TYPE
sequence_engine_done_event_output_terminal¶
nidcpower.Session.
sequence_engine_done_event_output_terminal
¶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 property is not supported by all devices. Refer to Supported Properties by Device topic
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_engine_done_event_output_terminal = var var = session.channels[0,1].sequence_engine_done_event_output_terminalThe following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Events:Sequence Engine Done Event:Output Terminal
- C Attribute: NIDCPOWER_ATTR_SEQUENCE_ENGINE_DONE_EVENT_OUTPUT_TERMINAL
sequence_engine_done_event_pulse_polarity¶
nidcpower.Session.
sequence_engine_done_event_pulse_polarity
¶Specifies the behavior of the Sequence Engine Done event. for information about supported devices. Default Value:
HIGH
Note
This property is not supported by all devices. Refer to Supported Properties by Device topic
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_engine_done_event_pulse_polarity = var var = session.channels[0,1].sequence_engine_done_event_pulse_polarityThe following table lists the characteristics of this property.
Characteristic Value Datatype enums.Polarity Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Events:Sequence Engine Done Event:Pulse:Polarity
- C Attribute: NIDCPOWER_ATTR_SEQUENCE_ENGINE_DONE_EVENT_PULSE_POLARITY
sequence_engine_done_event_pulse_width¶
nidcpower.Session.
sequence_engine_done_event_pulse_width
¶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 property is not supported by all devices. Refer to Supported Properties by Device topic
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_engine_done_event_pulse_width = var var = session.channels[0,1].sequence_engine_done_event_pulse_widthThe 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:
- LabVIEW Property: Events:Sequence Engine Done Event:Pulse:Width
- C Attribute: NIDCPOWER_ATTR_SEQUENCE_ENGINE_DONE_EVENT_PULSE_WIDTH
sequence_iteration_complete_event_output_terminal¶
nidcpower.Session.
sequence_iteration_complete_event_output_terminal
¶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 property is not supported by all devices. Refer to Supported Properties by Device topic
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_iteration_complete_event_output_terminal = var var = session.channels[0,1].sequence_iteration_complete_event_output_terminalThe following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Events:Sequence Iteration Complete Event:Output Terminal
- C Attribute: NIDCPOWER_ATTR_SEQUENCE_ITERATION_COMPLETE_EVENT_OUTPUT_TERMINAL
sequence_iteration_complete_event_pulse_polarity¶
nidcpower.Session.
sequence_iteration_complete_event_pulse_polarity
¶Specifies the behavior of the Sequence Iteration Complete event. for information about supported devices. Default Value:
HIGH
Note
This property is not supported by all devices. Refer to Supported Properties by Device topic
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_iteration_complete_event_pulse_polarity = var var = session.channels[0,1].sequence_iteration_complete_event_pulse_polarityThe following table lists the characteristics of this property.
Characteristic Value Datatype enums.Polarity Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Events:Sequence Iteration Complete Event:Pulse:Polarity
- C Attribute: NIDCPOWER_ATTR_SEQUENCE_ITERATION_COMPLETE_EVENT_PULSE_POLARITY
sequence_iteration_complete_event_pulse_width¶
nidcpower.Session.
sequence_iteration_complete_event_pulse_width
¶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 property is not supported by all devices. Refer to Supported Properties by Device topic in
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_iteration_complete_event_pulse_width = var var = session.channels[0,1].sequence_iteration_complete_event_pulse_widthThe 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:
- LabVIEW Property: Events:Sequence Iteration Complete Event:Pulse:Width
- C Attribute: NIDCPOWER_ATTR_SEQUENCE_ITERATION_COMPLETE_EVENT_PULSE_WIDTH
sequence_loop_count¶
nidcpower.Session.
sequence_loop_count
¶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.Session.sequence_loop_count_is_finite
property is set to False, thenidcpower.Session.sequence_loop_count
property is ignored. Valid Range: 1 to 134217727 Default Value: 1Note
This property is not supported by all devices. Refer to Supported Properties by Device topic
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_loop_count = var var = session.channels[0,1].sequence_loop_countThe 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:
- LabVIEW Property: Source:Advanced:Sequence Loop Count
- C Attribute: NIDCPOWER_ATTR_SEQUENCE_LOOP_COUNT
sequence_loop_count_is_finite¶
nidcpower.Session.
sequence_loop_count_is_finite
¶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.Session.sequence_loop_count_is_finite
property is set to False, thenidcpower.Session.sequence_loop_count
property is ignored. Default Value: TrueNote
This property is not supported by all devices. When the
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_loop_count_is_finite = var var = session.channels[0,1].sequence_loop_count_is_finiteThe following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Source:Advanced:Sequence Loop Count Is Finite
- C Attribute: NIDCPOWER_ATTR_SEQUENCE_LOOP_COUNT_IS_FINITE
sequence_step_delta_time¶
nidcpower.Session.
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.:
session.channels[0,1].sequence_step_delta_time = var var = session.channels[0,1].sequence_step_delta_timeThe 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¶
nidcpower.Session.
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.:
session.channels[0,1].sequence_step_delta_time_enabled = var var = session.channels[0,1].sequence_step_delta_time_enabledThe following table lists the characteristics of this property.
Characteristic Value Datatype bool 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¶
nidcpower.Session.
simulate
¶Specifies whether to simulate NI-DCPower I/O operations. True specifies that operation is simulated. Default Value: False
The following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Inherent IVI Attributes:User Options:Simulate
- C Attribute: NIDCPOWER_ATTR_SIMULATE
source_complete_event_output_terminal¶
nidcpower.Session.
source_complete_event_output_terminal
¶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 property is not supported by all devices. Refer to Supported Properties by Device topic
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].source_complete_event_output_terminal = var var = session.channels[0,1].source_complete_event_output_terminalThe following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Events:Source Complete Event:Output Terminal
- C Attribute: NIDCPOWER_ATTR_SOURCE_COMPLETE_EVENT_OUTPUT_TERMINAL
source_complete_event_pulse_polarity¶
nidcpower.Session.
source_complete_event_pulse_polarity
¶Specifies the behavior of the Source Complete event. for information about supported devices. Default Value:
HIGH
Note
This property is not supported by all devices. Refer to Supported Properties by Device topic
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].source_complete_event_pulse_polarity = var var = session.channels[0,1].source_complete_event_pulse_polarityThe following table lists the characteristics of this property.
Characteristic Value Datatype enums.Polarity Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Events:Source Complete Event:Pulse:Polarity
- C Attribute: NIDCPOWER_ATTR_SOURCE_COMPLETE_EVENT_PULSE_POLARITY
source_complete_event_pulse_width¶
nidcpower.Session.
source_complete_event_pulse_width
¶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 property is not supported by all devices. Refer to Supported Properties by Device topic
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].source_complete_event_pulse_width = var var = session.channels[0,1].source_complete_event_pulse_widthThe 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:
- LabVIEW Property: Events:Source Complete Event:Pulse:Width
- C Attribute: NIDCPOWER_ATTR_SOURCE_COMPLETE_EVENT_PULSE_WIDTH
source_delay¶
nidcpower.Session.
source_delay
¶Determines when, in seconds, the device generates the Source Complete event, potentially starting a measurement if the
nidcpower.Session.measure_when
property is set toAUTOMATICALLY_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 secondsNote
Refer to Supported Properties by Device for information about supported devices.
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].source_delay = var var = session.channels[0,1].source_delayThe following table lists the characteristics of this property.
Characteristic Value Datatype float in seconds or datetime.timedelta Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Source:Advanced:Source Delay
- C Attribute: NIDCPOWER_ATTR_SOURCE_DELAY
source_mode¶
nidcpower.Session.
source_mode
¶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:
SINGLE_POINT
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].source_mode = var var = session.channels[0,1].source_modeThe following table lists the characteristics of this property.
Characteristic Value Datatype enums.SourceMode Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Source:Source Mode
- C Attribute: NIDCPOWER_ATTR_SOURCE_MODE
source_trigger_type¶
nidcpower.Session.
source_trigger_type
¶Specifies the behavior of the Source trigger. for information about supported devices. Default Value:
NONE
Note
This property is not supported by all devices. Refer to Supported Properties by Device topic
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].source_trigger_type = var var = session.channels[0,1].source_trigger_typeThe following table lists the characteristics of this property.
Characteristic Value Datatype enums.TriggerType Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggers:Source Trigger:Trigger Type
- C Attribute: NIDCPOWER_ATTR_SOURCE_TRIGGER_TYPE
specific_driver_description¶
nidcpower.Session.
specific_driver_description
¶Contains a brief description of the specific driver.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Inherent IVI Attributes:Driver Identification:Description
- C Attribute: NIDCPOWER_ATTR_SPECIFIC_DRIVER_DESCRIPTION
specific_driver_prefix¶
nidcpower.Session.
specific_driver_prefix
¶Contains the prefix for NI-DCPower. The name of each user-callable method in NI-DCPower begins with this prefix.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Inherent IVI Attributes:Driver Identification:Driver Prefix
- C Attribute: NIDCPOWER_ATTR_SPECIFIC_DRIVER_PREFIX
specific_driver_revision¶
nidcpower.Session.
specific_driver_revision
¶Contains additional version information about NI-DCPower.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Inherent IVI Attributes:Driver Identification:Revision
- C Attribute: NIDCPOWER_ATTR_SPECIFIC_DRIVER_REVISION
specific_driver_vendor¶
nidcpower.Session.
specific_driver_vendor
¶Contains the name of the vendor that supplies NI-DCPower.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Inherent IVI Attributes:Driver Identification:Driver Vendor
- C Attribute: NIDCPOWER_ATTR_SPECIFIC_DRIVER_VENDOR
start_trigger_type¶
nidcpower.Session.
start_trigger_type
¶Specifies the behavior of the Start trigger. for information about supported devices. Default Value:
NONE
Note
This property is not supported by all devices. Refer to Supported Properties by Device topic
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].start_trigger_type = var var = session.channels[0,1].start_trigger_typeThe following table lists the characteristics of this property.
Characteristic Value Datatype enums.TriggerType Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggers:Start Trigger:Trigger Type
- C Attribute: NIDCPOWER_ATTR_START_TRIGGER_TYPE
supported_instrument_models¶
nidcpower.Session.
supported_instrument_models
¶Contains a comma-separated (,) list of supported NI-DCPower device models.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based No Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Inherent IVI Attributes:Driver Capabilities:Supported Instrument Models
- C Attribute: NIDCPOWER_ATTR_SUPPORTED_INSTRUMENT_MODELS
transient_response¶
nidcpower.Session.
transient_response
¶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:
NORMAL
Note
This property is not supported by all devices. Refer to Supported Properties by Device topic
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].transient_response = var var = session.channels[0,1].transient_responseThe following table lists the characteristics of this property.
Characteristic Value Datatype enums.TransientResponse Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Source:Transient Response
- C Attribute: NIDCPOWER_ATTR_TRANSIENT_RESPONSE
voltage_compensation_frequency¶
nidcpower.Session.
voltage_compensation_frequency
¶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
NORMAL
setting of thenidcpower.Session.transient_response
property.Note
This property is not supported by all devices. Refer to Supported Properties by Device topic
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].voltage_compensation_frequency = var var = session.channels[0,1].voltage_compensation_frequencyThe 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:
- LabVIEW Property: Source:Custom Transient Response:Voltage:Compensation Frequency
- C Attribute: NIDCPOWER_ATTR_VOLTAGE_COMPENSATION_FREQUENCY
voltage_gain_bandwidth¶
nidcpower.Session.
voltage_gain_bandwidth
¶The frequency at which the unloaded loop gain extrapolates to 0 dB in the absence of additional poles and zeroes. This property takes effect when the channel is in Constant Voltage mode. for information about supported devices. Default Value: Determined by the value of the
NORMAL
setting of thenidcpower.Session.transient_response
property.Note
This property is not supported by all devices. Refer to Supported Properties by Device topic
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].voltage_gain_bandwidth = var var = session.channels[0,1].voltage_gain_bandwidthThe 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:
- LabVIEW Property: Source:Custom Transient Response:Voltage:Gain Bandwidth
- C Attribute: NIDCPOWER_ATTR_VOLTAGE_GAIN_BANDWIDTH
voltage_level¶
nidcpower.Session.
voltage_level
¶Specifies the voltage level, in volts, that the device attempts to generate on the specified channel(s). This property is applicable only if the
nidcpower.Session.output_function
property is set toDC_VOLTAGE
.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 you specify for thenidcpower.Session.voltage_level_range
property.Note
The channel must be enabled for the specified voltage level to take effect. Refer to the
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].voltage_level = var var = session.channels[0,1].voltage_levelThe 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:
- LabVIEW Property: Source:DC Voltage:Voltage Level
- C Attribute: NIDCPOWER_ATTR_VOLTAGE_LEVEL
voltage_level_autorange¶
nidcpower.Session.
voltage_level_autorange
¶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 property to
ON
, NI-DCPower ignores any changes you make to thenidcpower.Session.voltage_level_range
property. If you change thenidcpower.Session.voltage_level_autorange
property fromON
toOFF
, NI-DCPower retains the last value thenidcpower.Session.voltage_level_range
property was set to (or the default value if the property was never set) and uses that value as the voltage level range. Query thenidcpower.Session.voltage_level_range
property by using thenidcpower.Session._get_attribute_vi_int32()
method for information about which range NI-DCPower automatically selects. Thenidcpower.Session.voltage_level_autorange
property is applicable only if thenidcpower.Session.output_function
property is set toDC_VOLTAGE
. Default Value:OFF
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].voltage_level_autorange = var var = session.channels[0,1].voltage_level_autorangeThe following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Source:DC Voltage:Voltage Level Autorange
- C Attribute: NIDCPOWER_ATTR_VOLTAGE_LEVEL_AUTORANGE
voltage_level_range¶
nidcpower.Session.
voltage_level_range
¶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.Session.voltage_level_autorange
property to enable automatic selection of the voltage level range. Thenidcpower.Session.voltage_level_range
property is applicable only if thenidcpower.Session.output_function
property is set toDC_VOLTAGE
.nidcpower.Session.output_enabled
property 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
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].voltage_level_range = var var = session.channels[0,1].voltage_level_rangeThe 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:
- LabVIEW Property: Source:DC Voltage:Voltage Level Range
- C Attribute: NIDCPOWER_ATTR_VOLTAGE_LEVEL_RANGE
voltage_limit¶
nidcpower.Session.
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
nidcpower.Session.output_function
property is set toDC_CURRENT
and thenidcpower.Session.compliance_limit_symmetry
property is set toSYMMETRIC
.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 thenidcpower.Session.voltage_limit_range
property is set.Note
The channel must be enabled for the specified current level to take effect. Refer to the
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].voltage_limit = var var = session.channels[0,1].voltage_limitThe 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:
- LabVIEW Property: Source:DC Current:Voltage Limit
- C Attribute: NIDCPOWER_ATTR_VOLTAGE_LIMIT
voltage_limit_autorange¶
nidcpower.Session.
voltage_limit_autorange
¶Specifies whether NI-DCPower automatically selects the voltage limit range based on the desired voltage limit for the specified channel(s). If this property is set to
ON
, NI-DCPower ignores any changes you make to thenidcpower.Session.voltage_limit_range
property. If you change thenidcpower.Session.voltage_limit_autorange
property fromON
toOFF
, NI-DCPower retains the last value thenidcpower.Session.voltage_limit_range
property was set to (or the default value if the property was never set) and uses that value as the voltage limit range. Query thenidcpower.Session.voltage_limit_range
property by using thenidcpower.Session._get_attribute_vi_int32()
method to find out which range NI-DCPower automatically selects. Thenidcpower.Session.voltage_limit_autorange
property is applicable only if thenidcpower.Session.output_function
property is set toDC_CURRENT
. Default Value:OFF
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].voltage_limit_autorange = var var = session.channels[0,1].voltage_limit_autorangeThe following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based Yes Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Source:DC Current:Voltage Limit Autorange
- C Attribute: NIDCPOWER_ATTR_VOLTAGE_LIMIT_AUTORANGE
voltage_limit_high¶
nidcpower.Session.
voltage_limit_high
¶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 <p:py:meth:`nidcpower.Session.ComplianceLimitSymmetry.html>`__ property is set to Asymmetric and the Output Method <p:py:meth:`nidcpower.Session.OutputFunction.html>`__ property is set to DC Current. You must also specify a Voltage Limit Low <p:py:meth:`nidcpower.Session.VoltageLimitLow.html>`__ to complete the asymmetric range. Valid Values: [1% of Voltage Limit Range <p:py:meth:`nidcpower.Session.VoltageLimitRange.html>`__, Voltage Limit Range <p:py:meth:`nidcpower.Session.VoltageLimitRange.html>`__] 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 <p:py:meth:`nidcpower.Session.OverrangingEnabled.html>`__ property is set to TRUE.
Note
One or more of the referenced methods are not in the Python API for this driver.
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].voltage_limit_high = var var = session.channels[0,1].voltage_limit_highThe 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:
- LabVIEW Property: Source:DC Current:Voltage Limit High
- C Attribute: NIDCPOWER_ATTR_VOLTAGE_LIMIT_HIGH
voltage_limit_low¶
nidcpower.Session.
voltage_limit_low
¶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 <p:py:meth:`nidcpower.Session.ComplianceLimitSymmetry.html>`__ property is set to Asymmetric and the Output Method <p:py:meth:`nidcpower.Session.OutputFunction.html>`__ property is set to DC Current. You must also specify a Voltage Limit High <p:py:meth:`nidcpower.Session.VoltageLimitHigh.html>`__ to complete the asymmetric range. Valid Values: [-Voltage Limit Range <p:py:meth:`nidcpower.Session.VoltageLimitRange.html>`__, -1% of Voltage Limit Range <p:py:meth:`nidcpower.Session.VoltageLimitRange.html>`__] 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 <p:py:meth:`nidcpower.Session.OverrangingEnabled.html>`__ property is set to TRUE.
Note
One or more of the referenced methods are not in the Python API for this driver.
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].voltage_limit_low = var var = session.channels[0,1].voltage_limit_lowThe 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:
- LabVIEW Property: Source:DC Current:Voltage Limit Low
- C Attribute: NIDCPOWER_ATTR_VOLTAGE_LIMIT_LOW
voltage_limit_range¶
nidcpower.Session.
voltage_limit_range
¶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.Session.voltage_limit_autorange
property to enable automatic selection of the voltage limit range. Thenidcpower.Session.voltage_limit_range
property is applicable only if thenidcpower.Session.output_function
property is set toDC_CURRENT
.nidcpower.Session.output_enabled
property 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
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].voltage_limit_range = var var = session.channels[0,1].voltage_limit_rangeThe 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:
- LabVIEW Property: Source:DC Current:Voltage Limit Range
- C Attribute: NIDCPOWER_ATTR_VOLTAGE_LIMIT_RANGE
voltage_pole_zero_ratio¶
nidcpower.Session.
voltage_pole_zero_ratio
¶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
NORMAL
setting of thenidcpower.Session.transient_response
property.Note
This property is not supported by all devices. Refer to Supported Properties by Device topic
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].voltage_pole_zero_ratio = var var = session.channels[0,1].voltage_pole_zero_ratioThe 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:
- LabVIEW Property: Source:Custom Transient Response:Voltage:Pole-Zero Ratio
- C Attribute: NIDCPOWER_ATTR_VOLTAGE_POLE_ZERO_RATIO
Session
- Session
- Methods
- abort
- close
- commit
- configure_aperture_time
- create_advanced_sequence
- create_advanced_sequence_step
- delete_advanced_sequence
- disable
- export_attribute_configuration_buffer
- export_attribute_configuration_file
- fetch_multiple
- get_channel_name
- get_ext_cal_last_date_and_time
- get_ext_cal_last_temp
- get_ext_cal_recommended_interval
- get_self_cal_last_date_and_time
- get_self_cal_last_temp
- import_attribute_configuration_buffer
- import_attribute_configuration_file
- initiate
- lock
- measure
- measure_multiple
- query_in_compliance
- query_max_current_limit
- query_max_voltage_level
- query_min_current_limit
- query_output_state
- read_current_temperature
- reset
- reset_device
- reset_with_defaults
- self_cal
- self_test
- send_software_edge_trigger
- set_sequence
- unlock
- wait_for_event
- Repeated Capabilities
- Properties
- active_advanced_sequence
- active_advanced_sequence_step
- aperture_time
- aperture_time_units
- auto_zero
- auxiliary_power_source_available
- channel_count
- compliance_limit_symmetry
- current_compensation_frequency
- current_gain_bandwidth
- current_level
- current_level_autorange
- current_level_range
- current_limit
- current_limit_autorange
- current_limit_behavior
- current_limit_high
- current_limit_low
- current_limit_range
- current_pole_zero_ratio
- dc_noise_rejection
- digital_edge_measure_trigger_input_terminal
- digital_edge_pulse_trigger_input_terminal
- digital_edge_sequence_advance_trigger_input_terminal
- digital_edge_source_trigger_input_terminal
- digital_edge_start_trigger_input_terminal
- driver_setup
- exported_measure_trigger_output_terminal
- exported_pulse_trigger_output_terminal
- exported_sequence_advance_trigger_output_terminal
- exported_source_trigger_output_terminal
- exported_start_trigger_output_terminal
- fetch_backlog
- instrument_firmware_revision
- instrument_manufacturer
- instrument_model
- interlock_input_open
- io_resource_descriptor
- logical_name
- measure_buffer_size
- measure_complete_event_delay
- measure_complete_event_output_terminal
- measure_complete_event_pulse_polarity
- measure_complete_event_pulse_width
- measure_record_delta_time
- measure_record_length
- measure_record_length_is_finite
- measure_trigger_type
- measure_when
- output_capacitance
- output_connected
- output_enabled
- output_function
- output_resistance
- overranging_enabled
- ovp_enabled
- ovp_limit
- power_line_frequency
- power_source
- power_source_in_use
- pulse_bias_current_level
- pulse_bias_current_limit
- pulse_bias_current_limit_high
- pulse_bias_current_limit_low
- pulse_bias_delay
- pulse_bias_voltage_level
- pulse_bias_voltage_limit
- pulse_bias_voltage_limit_high
- pulse_bias_voltage_limit_low
- pulse_complete_event_output_terminal
- pulse_complete_event_pulse_polarity
- pulse_complete_event_pulse_width
- pulse_current_level
- pulse_current_level_range
- pulse_current_limit
- pulse_current_limit_high
- pulse_current_limit_low
- pulse_current_limit_range
- pulse_off_time
- pulse_on_time
- pulse_trigger_type
- pulse_voltage_level
- pulse_voltage_level_range
- pulse_voltage_limit
- pulse_voltage_limit_high
- pulse_voltage_limit_low
- pulse_voltage_limit_range
- query_instrument_status
- ready_for_pulse_trigger_event_output_terminal
- ready_for_pulse_trigger_event_pulse_polarity
- ready_for_pulse_trigger_event_pulse_width
- reset_average_before_measurement
- samples_to_average
- self_calibration_persistence
- sense
- sequence_advance_trigger_type
- sequence_engine_done_event_output_terminal
- sequence_engine_done_event_pulse_polarity
- sequence_engine_done_event_pulse_width
- sequence_iteration_complete_event_output_terminal
- sequence_iteration_complete_event_pulse_polarity
- sequence_iteration_complete_event_pulse_width
- sequence_loop_count
- sequence_loop_count_is_finite
- sequence_step_delta_time
- sequence_step_delta_time_enabled
- simulate
- source_complete_event_output_terminal
- source_complete_event_pulse_polarity
- source_complete_event_pulse_width
- source_delay
- source_mode
- source_trigger_type
- specific_driver_description
- specific_driver_prefix
- specific_driver_revision
- specific_driver_vendor
- start_trigger_type
- supported_instrument_models
- transient_response
- voltage_compensation_frequency
- voltage_gain_bandwidth
- voltage_level
- voltage_level_autorange
- voltage_level_range
- voltage_limit
- voltage_limit_autorange
- voltage_limit_high
- voltage_limit_low
- voltage_limit_range
- voltage_pole_zero_ratio