Skip to content

NI DCPOWER Source Attributes

Jump to bottom
ni-siray edited this page May 7, 2021 · 5 revisions

Source Attributes

NIDCPOWER_ATTRIBUTE_SOURCE_MODE

Specific Attribute

Numeric Value Data
type		 Access Applies to Coercion High-Level Functions
1150054 ViInt32 R/W Channel None niDCPower_ConfigureSourceModeWithChannels

Description

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.

!Note Note  To specify a channel name when accessing this attribute, you must first initialize the session using the niDCPower_InitializeWithIndependentChannels function.
Defined Values:
NIDCPOWER_VAL_SINGLE_POINT (1020) The source unit applies a single source configuration.
NIDCPOWER_VAL_SEQUENCE (1021) The source unit sequentially applies a list of voltage or current configurations.
Default Value:

Refer to Supported Attributes by Device for the default value by device.

Related Topics:

NIDCPOWER_ATTRIBUTE_OUTPUT_FUNCTION

Specific Attribute

Numeric Value Data
type		 Access Applies to Coercion High-Level Functions
1150008 ViInt32 R/W Channel None niDCPower_ConfigureOutputFunction

Description

Configures the function to generate on the specified channel(s).

When NIDCPOWER_VAL_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 attributes to configure the channel when NIDCPOWER_VAL_DC_VOLTAGE is selected:

  • NIDCPOWER_ATTRIBUTE_VOLTAGE_LEVEL
  • NIDCPOWER_ATTRIBUTE_CURRENT_LIMIT
  • NIDCPOWER_ATTRIBUTE_CURRENT_LIMIT_HIGH
  • NIDCPOWER_ATTRIBUTE_CURRENT_LIMIT_LOW
  • NIDCPOWER_ATTRIBUTE_VOLTAGE_LEVEL_RANGE
  • NIDCPOWER_ATTRIBUTE_CURRENT_LIMIT_RANGE
  • NIDCPOWER_ATTRIBUTE_COMPLIANCE_LIMIT_SYMMETRY

When NIDCPOWER_VAL_DC_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 attributes to configure the channel when NIDCPOWER_VAL_DC_CURRENT is selected:

  • NIDCPOWER_ATTRIBUTE_CURRENT_LEVEL
  • NIDCPOWER_ATTRIBUTE_VOLTAGE_LIMIT
  • NIDCPOWER_ATTRIBUTE_VOLTAGE_LIMIT_HIGH
  • NIDCPOWER_ATTRIBUTE_VOLTAGE_LIMIT_LOW
  • NIDCPOWER_ATTRIBUTE_CURRENT_LEVEL_RANGE
  • NIDCPOWER_ATTRIBUTE_VOLTAGE_LIMIT_RANGE
  • NIDCPOWER_ATTRIBUTE_COMPLIANCE_LIMIT_SYMMETRY

When NIDCPOWER_VAL_PULSE_VOLTAGE is selected, the device generates pulses at the desired pulse voltage levels on the output as long as the output current is below the pulse current limit. The following attributes can be used to configure the channel when NIDCPOWER_VAL_PULSE_VOLTAGE is selected:

  • NIDCPOWER_ATTRIBUTE_PULSE_VOLTAGE_LEVEL
  • NIDCPOWER_ATTRIBUTE_PULSE_BIAS_VOLTAGE_LEVEL
  • NIDCPOWER_ATTRIBUTE_PULSE_CURRENT_LIMIT
  • NIDCPOWER_ATTRIBUTE_PULSE_CURRENT_LIMIT_HIGH
  • NIDCPOWER_ATTRIBUTE_PULSE_CURRENT_LIMIT_LOW
  • NIDCPOWER_ATTRIBUTE_PULSE_BIAS_CURRENT_LIMIT
  • NIDCPOWER_ATTRIBUTE_PULSE_BIAS_CURRENT_LIMIT_HIGH
  • NIDCPOWER_ATTRIBUTE_PULSE_BIAS_CURRENT_LIMIT_LOW
  • NIDCPOWER_ATTRIBUTE_PULSE_VOLTAGE_LEVEL_RANGE
  • NIDCPOWER_ATTRIBUTE_PULSE_CURRENT_LIMIT_RANGE
  • NIDCPOWER_ATTRIBUTE_COMPLIANCE_LIMIT_SYMMETRY

When NIDCPOWER_VAL_PULSE_CURRENT is selected, the device generates pulses at the desired pulse current levels on the output as long as the output voltage is below the pulse voltage limit. The following attributes can be used to configure the channel when NIDCPOWER_VAL_PULSE_CURRENT is selected:

  • NIDCPOWER_ATTRIBUTE_PULSE_CURRENT_LEVEL
  • NIDCPOWER_ATTRIBUTE_PULSE_BIAS_CURRENT_LEVEL
  • NIDCPOWER_ATTRIBUTE_PULSE_VOLTAGE_LIMIT
  • NIDCPOWER_ATTRIBUTE_PULSE_VOLTAGE_LIMIT_HIGH
  • NIDCPOWER_ATTRIBUTE_PULSE_VOLTAGE_LIMIT_LOW
  • NIDCPOWER_ATTRIBUTE_PULSE_BIAS_VOLTAGE_LIMIT
  • NIDCPOWER_ATTRIBUTE_PULSE_BIAS_VOLTAGE_LIMIT_HIGH
  • NIDCPOWER_ATTRIBUTE_PULSE_BIAS_VOLTAGE_LIMIT_LOW
  • NIDCPOWER_ATTRIBUTE_PULSE_CURRENT_LEVEL_RANGE
  • NIDCPOWER_ATTRIBUTE_PULSE_VOLTAGE_LIMIT_RANGE
  • NIDCPOWER_ATTRIBUTE_COMPLIANCE_LIMIT_SYMMETRY

Defined Values:

NIDCPOWER_VAL_DC_VOLTAGE (1006) Sets the output function to DC voltage.
NIDCPOWER_VAL_DC_CURRENT (1007) Sets the output function to DC current.
NIDCPOWER_VAL_PULSE_VOLTAGE (1049) Sets the output function to pulse voltage.
NIDCPOWER_VAL_PULSE_CURRENT (1050) Sets the output function to pulse current.
Default Value:

Refer to Supported Attributes by Device for the default value by device.

Related Topics:

Constant Voltage Mode

Constant Current Mode

NIDCPOWER_ATTRIBUTE_OUTPUT_ENABLED

Specific Attribute

Numeric Value Data
type		 Access Applies to Coercion High-Level Functions
1250006 ViBoolean R/W Channel None niDCPower_ConfigureOutputEnabled

Description

Specifies whether the output is enabled (VI_TRUE) or disabled (VI_FALSE).

Depending on the value you specify for the NIDCPOWER_ATTRIBUTE_OUTPUT_FUNCTION attribute, you also must set the voltage level or current level in addition to enabling the output.

This attribute has no effect on the output disconnect relay. To toggle the relay, use the NIDCPOWER_ATTRIBUTE_OUTPUT_CONNECTED attribute.

!Note Note  If channels are in the Committed or Uncommitted states, enabling the output does not take effect until you call the niDCPower_InitiateWithChannels function. Refer to the Programming States topic in the NI DC Power Supplies and SMUs Help for more information about NI-DCPower programming states.
Defined Values:
VI_FALSE (0) Disables generation on the specified channels.
VI_TRUE (1) Enables generation on the specified channels.
Default Value:

Refer to Supported Attributes by Device for the default value by device.

Related Topics:

NIDCPOWER_ATTRIBUTE_OUTPUT_CONNECTED

Specific Attribute

Numeric Value Data
type		 Access Applies to Coercion High-Level Functions
1150060 ViBoolean R/W Channel None None

Description

Specifies whether the output relay is connected (closed) or disconnected (open). The NIDCPOWER_ATTRIBUTE_OUTPUT_ENABLED attribute does not change based on this attribute; they are independent of each other.

!Note Note  This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.
Set this attribute to VI_FALSE to disconnect the output terminal from the output.
!Note Note  Only disconnect the output when disconnecting is necessary for your application. For example, a battery connected to the output terminal might discharge unless the relay is disconnected. Excessive connecting and disconnecting of the output can cause premature wear on electromechanical relays, such as those used by the PXIe-4147, PXI-4132, or PXIe-4138/39.
Defined Values:
VI_FALSE (0) The output relay is disconnected (open).
VI_TRUE (1) The output relay is connected (closed).
Default Value:

Refer to Supported Attributes by Device for the default value by device.

Related Topics:

NIDCPOWER_ATTRIBUTE_OUTPUT_RESISTANCE

Specific Attribute

Numeric Value Data
type		 Access Applies to Coercion High-Level Functions
1150061 ViReal64 R/W Channel None niDCPower_ConfigureOutputResistance

Description

Specifies the output resistance that the device attempts to generate for the specified channel(s).

Depending on the instrument, output resistance is configurable only if you set the output function of the channel using the niDCPower_ConfigureOutputFunction function as follows:

  • PXIe-4141, PXIe-4143, PXIe-4145: NIDCPOWER_VAL_DC_VOLTAGE
  • PXIe-4135, PXIe-4137, PXIe-4139, PXIe-4147: NIDCPOWER_VAL_DC_CURRENT or NIDCPOWER_VAL_DC_VOLTAGE

Valid Values: Vary by device. Refer to the device specifications or the Programmable Output Resistance topic for your device for more information about supported values.

!Note Note  Using the Merged Channels attribute to merge SMU outputs affects the valid output resistance range you can program. Refer to Effect of Merging Channels on Other Functions and Properties for details.
!Note Note  This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.
Default Value:

Refer to Supported Attributes by Device for the default value by device.

Related Topics:

**Output Resistance -

NIDCPOWER_ATTRIBUTE_TRANSIENT_RESPONSE

Specific Attribute

Numeric Value Data
type		 Access Applies to Coercion High-Level Functions
1150062 ViInt32 R/W Channel None None

Description

Specifies the transient response.

!Note Note  This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices.
Defined Values:
NIDCPOWER_VAL_SLOW (1041) Slow transient response time. Refer to Configuring Transient Response for supported devices.
NIDCPOWER_VAL_NORMAL (1038) Normal transient response time.
NIDCPOWER_VAL_FAST (1039) Fast transient response time.
NIDCPOWER_VAL_CUSTOM (1042) Custom transient response time. If you select this value, you can then specify values for the NIDCPOWER_ATTRIBUTE_VOLTAGE_GAIN_BANDWIDTH, NIDCPOWER_ATTRIBUTE_VOLTAGE_COMPENSATION_FREQUENCY, NIDCPOWER_ATTRIBUTE_VOLTAGE_POLE_ZERO_RATIO, NIDCPOWER_ATTRIBUTE_CURRENT_GAIN_BANDWIDTH, NIDCPOWER_ATTRIBUTE_CURRENT_COMPENSATION_FREQUENCY, and NIDCPOWER_ATTRIBUTE_CURRENT_POLE_ZERO_RATIO attributes. Refer to Configuring Transient Response for supported devices.
Default Value:

Refer to Supported Attributes by Device for the default value by device.

Related Topics:

Transient Response

Table of Contents

Home

Internal Development

Creating and Setting Up a gRPC Server

Server Security Support

Creating a gRPC Client

gRPC Client Examples

Session Utilities API Reference

Driver Documentation

gRPC API Differences From C API

Sharing Driver Sessions Between Clients

C API Docs
NI-DAQmx
NI-DCPOWER
NI-DIGITAL PATTERN DRIVER
NI-DMM
NI-FGEN
NI-FPGA
NI-RFmx Bluetooth
NI-RFmx NR
NI-RFmx WCDMA
NI-RFmx GSM
NI-RFmx CDMA2k
NI-RFmx Instr
NI-RFmx LTE
NI-RFmx SpecAn
NI-RFmx TD-SCDMA
NI-RFmx WLAN
NI-RFSA
NI-RFSG
NI-SCOPE
NI-SWITCH
NI-TCLK
NI-XNET
Clone this wiki locally