Skip to content

NI DCPOWER Advanced Attributes

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

Advanced Attributes

NIDCPOWER_ATTRIBUTE_SOURCE_DELAY

Specific Attribute

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

Description

Determines when, in seconds, the device generates the Source Complete event, potentially starting a measurement if the NIDCPOWER_ATTRIBUTE_MEASURE_WHEN attribute is set to NIDCPOWER_VAL_AUTOMATICALLY_AFTER_SOURCE_COMPLETE.

Refer to the Single Point Source Mode and Sequence Source Mode topics for more information.

Note  Refer to Supported Attributes by Device for information about supported devices

Valid Values: For the PXIe-4147 and PXIe-4162/4163, 0-10 seconds. For all other supported instruments, 0 to 167 seconds.

Default Value: 0.01667 seconds

Related Topics:

Settling Time

NIDCPOWER_ATTRIBUTE_PULSE_BIAS_DELAY

Specific Attribute

Numeric Value Data
type		 Access Applies to Coercion High-Level Functions
1150092 ViReal64 R/W Channel None N/A

Description

Determines when, in seconds, the device generates the Pulse Complete event after generating the "off" level of a pulse.

Note  This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices

Valid Values: 0 to 167 seconds

Default Value: 16.67 milliseconds

NIDCPOWER_ATTRIBUTE_PULSE_ON_TIME

Specific Attribute

Numeric Value Data
type		 Access Applies to Coercion High-Level Functions
1150093 ViReal64 R/W Channel None N/A

Description

Determines the length, in seconds, of the on phase of a pulse.

Note  This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices

Valid Values: For the PXIe-4139 (40 W), 10 microseconds to 167 seconds. For all other supported devices, 50 microseconds to 167 microseconds.

Default Value: 34 milliseconds

NIDCPOWER_ATTRIBUTE_PULSE_OFF_TIME

Specific Attribute

Numeric Value Data
type		 Access Applies to Coercion High-Level Functions
1150094 ViReal64 R/W Channel None N/A

Description

Determines the length, in seconds, of the off phase of a pulse.

Note  This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices

Valid Values: 50 microseconds to 167 seconds

Default Value: 34 milliseconds

NIDCPOWER_ATTRIBUTE_OVERRANGING_ENABLED

Specific Attribute

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

Description

Specifies whether NI-DCPower allows setting the voltage level, current level, voltage limit and current limit outside the device specification limits. VI_TRUE means that overranging is enabled.

Refer to the Ranges topic for more information about overranging.

Defined Values:

VI_TRUE (1) Overranging is enabled.
VI_FALSE (0) Overranging is disabled.

Default Value: VI_FALSE

Note  To specify a channel name when accessing this attribute, you must first initialize the session using the niDCPower_InitializeWithIndependentChannels function

Related Topics:

Ranges

NIDCPOWER_ATTRIBUTE_OUTPUT_CAPACITANCE

Specific Attribute

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

Description

Specifies whether to use a low or high capacitance on the output for the specified channel(s).

Note  This attribute is not supported by all devices. Refer to Supported Attributes by Device 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.

Defined Values:

NIDCPOWER_VAL_LOW (1010) Output capacitance is low.
NIDCPOWER_VAL_HIGH (1011) Output capacitance is high.

Related Topics: Output Capacitance

NIDCPOWER_ATTRIBUTE_SEQUENCE_LOOP_COUNT

Specific Attribute

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

Description

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.

Note  This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices. When the NIDCPOWER_ATTRIBUTE_SEQUENCE_LOOP_COUNT_IS_FINITE attribute is set to VI_FALSE, the NIDCPOWER_ATTRIBUTE_SEQUENCE_LOOP_COUNT attribute is ignored

Valid Range: For the PXIe-4147 and PXIe-4162/4163, 1 to 10000. For all other supported instruments, 1 to 134217727.

Default Value: 1

Note  To specify a channel name when accessing this attribute, you must first initialize the session using the niDCPower_InitializeWithIndependentChannels function

Related Topics:

NIDCPOWER_ATTRIBUTE_SEQUENCE_LOOP_COUNT_IS_FINITE

Specific Attribute

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

Description

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.

Note  This attribute is not supported by all devices. When the NIDCPOWER_ATTRIBUTE_SEQUENCE_LOOP_COUNT_IS_FINITE attribute is set to VI_FALSE, the NIDCPOWER_ATTRIBUTE_SEQUENCE_LOOP_COUNT attribute is ignored

Default Value: VI_TRUE

Note  To specify a channel name when accessing this attribute, you must first initialize the session using the niDCPower_InitializeWithIndependentChannels function

Related Topics:

NIDCPOWER_ATTRIBUTE_OVP_ENABLED

Specific Attribute

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

Description

Enables (VI_TRUE) or disables (VI_FALSE) overvoltage protection (OVP).

Refer to the Output Overvoltage Protection topic for more information about overvoltage protection.

Note  This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices

Defined Values:

VI_FALSE (0) Overvoltage protection is disabled.
VI_TRUE (1) Overvoltage protection is enabled.

Default Value:

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

Related Topics:

Output Overvoltage Protection

PXIe-4135 Protection

NI PXIe-4136/4137 Protection

NI PXIe-4154 Protection

NIDCPOWER_ATTRIBUTE_OVP_LIMIT

Specific Attribute

Numeric Value Data
type		 Access Applies to Coercion High-Level Functions
1250003 ViReal64 R/W Channel None N/A

Description

Determines the voltage limit, in volts, beyond which overvoltage protection (OVP) engages. The limit is specified as a positive value, but symmetric positive and negative limits are enforced simultaneously. For example, setting the OVP Limit to 65 will configure the OVP feature to trigger an OVP error if the output exceeds ±65 V.

Note  This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices

Valid Values:

Valid values vary by device.

Default Value:

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

Related Topics:

PXIe-4135 Protection

NI PXIe-4136/4137 Protection

NIDCPOWER_ATTRIBUTE_COMPLIANCE_LIMIT_SYMMETRY

Specific Attribute

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

Description

Specifies whether current generation limits and voltage generation limits 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 NIDCPOWER_VAL_SYMMETRIC, voltage limits and current limits are set using a single attribute with a positive value. The resulting range is bounded by this positive value and its opposite.

When set to NIDCPOWER_VAL_ASYMMETRIC, you must separately set a limit high and a limit low using distinct attributes.

For asymmetric limits, the range bounded by the limit high and limit low must include zero.

Note  Refer to Supported Attributes by Device for information about supported devices

Defined Values:

NIDCPOWER_VAL_SYMMETRIC (0) Compliance limits are specified symmetrically about 0.
NIDCPOWER_VAL_ASYMMETRIC (1) Compliance limits can be specified asymmetrically with respect to 0.

Default Value: NIDCPOWER_VAL_SYMMETRIC

Related Topics:

Compliance

Ranges

Changing Ranges

Overranging

NIDCPOWER_ATTRIBUTE_SEQUENCE_STEP_DELTA_TIME

Specific Attribute

Numeric Value Data
type		 Access Applies to Coercion High-Level Functions
1150198 ViReal64 R/W Channel Yes N/A

Description

Specifies the amount of time, in seconds, between the start of two consecutive steps in a sequence.

You can specify this attribute as one of the attributeIDs when calling the niDCPower_CreateAdvancedSequenceWithChannels function. In this case, this attribute specifies the amount of time between the start of the active step and the start of the next step.

Note  This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices

This attribute is applicable only if the NIDCPOWER_ATTRIBUTE_SEQUENCE_STEP_DELTA_TIME_ENABLED attribute is set to VI_TRUE. This attribute does not apply to the last step of the last iteration of a sequence.

NoteYou can set values for the NIDCPOWER_ATTRIBUTE_SOURCE_DELAY and Measure attributes in conjunction with this attribute. Values for NIDCPOWER_ATTRIBUTE_SOURCE_DELAY may conflict with the value of this attribute; Measure attributes may conflict with the value of this attribute only if the NIDCPOWER_ATTRIBUTE_MEASURE_WHEN attribute is set to NIDCPOWER_VAL_AUTOMATICALLY_AFTER_SOURCE_COMPLETE

Valid Values

Device Values
PXIe4135
PXIe4136/4137
PXIe4138/4139		 [12.5 μs, 60 s]
PXIe4140/4141
PXIe4142/4143
PXIe4144/4145		 [10 μs, 60 s]

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

Note  NIDCPower coerces the value you specify for this attribute to the nearest multiple of a device-specific resolution. You can read back the value of this attribute to determine the coerced value. | | :- | :- |

Device Selected Value Resolution
PXIe4135
PXIe4136/4137
PXIe4138/4139		 [12.5 μs, 21.4748 s] 10 ns
(21.4748 s, 60 s] 10 μs
PXIe4140/4141
PXIe4142/4143
PXIe4144/4145		 [10 μs, 233.0169 ms] 27.7778 ns
(233.0169 ms, 60 s] 10 μs

Related Topics:

Sequence Step Delta Time

Sequence Source Mode

Advanced Sequencing

NIDCPOWER_ATTRIBUTE_SEQUENCE_STEP_DELTA_TIME_ENABLED

Specific Attribute

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

Description

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

When this attribute is set to VI_TRUE, you can set the NIDCPOWER_ATTRIBUTE_SEQUENCE_STEP_DELTA_TIME attribute to control the time between consecutive steps in the sequence.

Note  This attribute is notsupported by all devices. Refer to Supported Attributes by Device for information about supported devices

This attribute is applicable only if the NIDCPOWER_ATTRIBUTE_SOURCE_MODE attribute is set to NIDCPOWER_VAL_SEQUENCE and may be set to VI_TRUE only if:

  • The NIDCPOWER_ATTRIBUTE_SOURCE_TRIGGER_TYPE attribute is set to NIDCPOWER_VAL_NONE;
  • The NIDCPOWER_ATTRIBUTE_SEQUENCE_ADVANCE_TRIGGER_TYPE attribute is set to NIDCPOWER_VAL_NONE; and
  • The NIDCPOWER_ATTRIBUTE_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_VOLTAGE or NIDCPOWER_VAL_DC_CURRENT.

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

Related Topics:

Sequence Step Delta Time

Sequence Source Mode

Advanced Sequencing

NIDCPOWER_ATTRIBUTE_ACTUAL_POWER_ALLOCATION

Specific Attribute

Numeric Value Data
type		 Access Applies to Coercion High-Level Functions
1150205 ViReal64 RO Channel None N/A

Description

Returns the power, in watts, the device is sourcing on the active channels if the NIDCPOWER_ATTRIBUTE_POWER_ALLOCATION_MODE attribute is set to NIDCPOWER_VAL_POWER_ALLOCATION_MODE_AUTOMATIC or NIDCPOWER_VAL_POWER_ALLOCATION_MODE_MANUAL.

Note  This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices

Valid Values: [0, device per-channel maximum power]

Note  This attribute returns 1 when the NIDCPOWER_ATTRIBUTE_POWER_ALLOCATION_MODE attribute is set to NIDCPOWER_VAL_POWER_ALLOCATION_MODE_DISABLED

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

NIDCPOWER_ATTRIBUTE_POWER_ALLOCATION_MODE

Specific Attribute

Numeric Value Data
type		 Access Applies to Coercion High-Level Functions
1150207 ViInt32 RW Channel None N/A

Description

Determines whether the device sources the power its output configuration requires or a specific wattage you request; determines whether NIDCPower proactively checks that this sourcing power is within the maximum per-channel and overall sourcing power of the device.

When this attribute configures NIDCPower to perform a sourcing power check, a device is not permitted to source power in excess of its maximum per-channel or overall sourcing power. If the check determines an output configuration or power request would require the device to do so, NIDCPower returns an error.

When this attribute does not configure NIDCPower to perform a sourcing power check, a device complies with requests to source power in excess of its maximum per-channel or overall sourcing power and may shut down to prevent damage.

Note  This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices. Devices that do not support this attribute behave as if this attribute were set to NIDCPOWER_VAL_POWER_ALLOCATION_MODE_DISABLED

Defined Values:

NIDCPOWER_VAL_POWER_ALLOCATION_MODE_DISABLED (1058) The device attempts to source, on each active channel, the power that the present source configuration requires; NIDCPower does not perform a sourcing power check. If the required power is greater than the maximum sourcing power, the device attempts to source the required amount and may shut down to prevent damage.
NIDCPOWER_VAL_POWER_ALLOCATION_MODE_AUTOMATIC (1059) The device attempts to source, on each active channel, the power that the present source configuration requires; NIDCPower performs a sourcing power check. If the required power is greater than the maximum sourcing power, the device does not exceed the maximum power, and NIDCPower returns an error.
NIDCPOWER_VAL_POWER_ALLOCATION_MODE_MANUAL (1060) The device attempts to source, on each active channel, the power you request with the NIDCPOWER_ATTRIBUTE_REQUESTED_POWER_ALLOCATION attribute; NIDCPower performs a sourcing power check. If the requested power is either less than the required power for the present source configuration or greater than the maximum sourcing power, the device does not exceed the requested or allowed power, respectively, and NIDCPower returns an error

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

NIDCPOWER_ATTRIBUTE_REQUESTED_POWER_ALLOCATION

Specific Attribute

Numeric Value Data
type		 Access Applies to Coercion High-Level Functions
1150206 ViReal64 RW Channel None N/A

Description

Specifies the power, in watts, to request the device to source from each active channel.

This attribute defines the power to source from the device only if the NIDCPOWER_ATTRIBUTE_POWER_ALLOCATION_MODE attribute is set to NIDCPOWER_VAL_POWER_ALLOCATION_MODE_MANUAL.

The power you request with this attribute may be incompatible with the power a given source configuration requires or the power the device can provide:

Incompatibility Behavior
Requested power < power required for source configuration Device does not exceed the requested power NIDCPower returns an error
Requested power > maximum per-channel or overall sourcing power Device does not exceed the allowed power NIDCPower returns an error

Note  This attribute is not supported by all devices. Refer to Supported Attributes by Device for information about supported devices

Valid Values: [0, device per-channel maximum power]

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

NIDCPOWER_ATTRIBUTE_MERGED_CHANNELS

Specific Attribute

Numeric Value Data
type		 Access Applies to Coercion High-Level Functions
1150249 ViString RW Channel None N/A

Description

Specifies the channel(s) to merge with a designated primary channel of an SMU in order to increase the maximum current you can source from the SMU.

This attribute designates the merge channels to combine with a primary channel. To designate the primary channel, do the following:

  • Initialize the session to the primary channel only
  • Pass the primary channel to the channelName control of the appropriate set function

Note  You cannot change the merge configuration with this property when channels are in the Running state

For complete information on using merged channels with this property, including valid merge configurations, refer to Merged Channels in the NI DC Power Supplies and SMUs Help.

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

Increasing SMU Output Current by Merging Channels

Effect of Merging Channels on Other Functions and Properties

Unmerging Merged Channels

Programming States

Remote Sense

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