NI DCPOWER Voltage Attributes - ni/grpc-device GitHub Wiki

Voltage Attributes

NIDCPOWER_ATTRIBUTE_VOLTAGE_LEVEL

Specific Attribute

Numeric Value Datatype Access Applies to Coercion High-Level Functions
1250001 ViReal64 R/W Channel None niDCPower_ConfigureVoltageLevel

Description

Specifies the voltage level, in volts, that the device attempts to generate on the specified channel(s).

This attribute is applicable only if the NIDCPOWER_ATTRIBUTE_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_VOLTAGE.

!Note(Aspose.Words.41885b0c-31fa-440b-9ab8-b894c1d71458.001.png) Note  The channel must be enabled for the specified voltage level to take effect. Refer to the NIDCPOWER_ATTRIBUTE_OUTPUT_ENABLED attribute for more information about enabling the output channel.
Valid Values: The valid values for this attribute are defined by the values you specify for the NIDCPOWER_ATTRIBUTE_VOLTAGE_LEVEL_RANGE attribute.

Related Topics:

Constant Voltage Mode

NIDCPOWER_ATTRIBUTE_VOLTAGE_LEVEL_RANGE

Specific Attribute

Numeric Value Datatype Access Applies to Coercion High-Level Functions
1150005 ViReal64 R/W Channel Yes niDCPower_ConfigureVoltageLevelRange

Description

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_ATTRIBUTE_VOLTAGE_LEVEL_AUTORANGE attribute to enable automatic selection of the voltage level range.

This attribute is applicable only if the NIDCPOWER_ATTRIBUTE_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_VOLTAGE.

!Note(Aspose.Words.41885b0c-31fa-440b-9ab8-b894c1d71458.001.png) Note  The channel must be enabled for the specified voltage level range to take effect. Refer to the NIDCPOWER_ATTRIBUTE_OUTPUT_ENABLED attribute 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.

Related Topics:

Ranges

NIDCPOWER_ATTRIBUTE_VOLTAGE_LEVEL_AUTORANGE

Specific Attribute

Numeric Value Datatype Access Applies to Coercion High-Level Functions
1150015 ViInt32 R/W Channel None None

Description

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 attribute to NIDCPOWER_VAL_ON, NI-DCPower ignores any changes you make to the NIDCPOWER_ATTRIBUTE_VOLTAGE_LEVEL_RANGE attribute. If you change the NIDCPOWER_ATTRIBUTE_VOLTAGE_LEVEL_AUTORANGE attribute from NIDCPOWER_VAL_ON to NIDCPOWER_VAL_OFF, NI-DCPower retains the last value the NIDCPOWER_ATTRIBUTE_VOLTAGE_LEVEL_RANGE attribute was set to (or the default value if the attribute was never set) and uses that value as the voltage level range.

Query the NIDCPOWER_ATTRIBUTE_VOLTAGE_LEVEL_RANGE attribute by using the niDCPower_GetAttributeViInt32 function for information about which range NI-DCPower automatically selects.

This attribute is applicable only if the NIDCPOWER_ATTRIBUTE_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_VOLTAGE.

Defined Values:

NIDCPOWER_VAL_OFF (0) NI-DCPower does not automatically select the voltage level range.
NIDCPOWER_VAL_ON (1) NI-DCPower automatically selects the voltage level range.
Default Value: NIDCPOWER_VAL_OFF

Related Topics:

Ranges

NIDCPOWER_ATTRIBUTE_CURRENT_LIMIT

Specific Attribute

Numeric Value Datatype Access Applies to Coercion High-Level Functions
1250005 ViReal64 R/W Channel None niDCPower_ConfigureCurrentLimit

Description

Specifies the current limit, in amps, that the output cannot exceed when generating the desired voltage level on the specified channel(s).

The limit is specified as a positive value, but symmetric positive and negative limits are enforced simultaneously.

This attribute is applicable only if the NIDCPOWER_ATTRIBUTE_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_VOLTAGE and the NIDCPOWER_ATTRIBUTE_COMPLIANCE_LIMIT_SYMMETRY attribute is set to NIDCPOWER_VAL_SYMMETRIC.

!Note(Aspose.Words.41885b0c-31fa-440b-9ab8-b894c1d71458.001.png) Note  The channel must be enabled for the specified current limit to take effect. Refer to the NIDCPOWER_ATTRIBUTE_OUTPUT_ENABLED attribute for more information about enabling the output channel.
Valid Values: The valid values for this attribute are defined by the values to which NIDCPOWER_ATTRIBUTE_CURRENT_LIMIT_RANGE attribute is set.

Related Topics:

Compliance

NIDCPOWER_ATTRIBUTE_CURRENT_LIMIT_HIGH

Specific Attribute

Numeric Value Datatype Access Applies to Coercion High-Level Functions
1150187 ViReal64 R/W Channel None None

Description

Specifies the maximum current, in amps, that the output can produce when generating the desired voltage on the specified channel(s).

This attribute is applicable only if the NIDCPOWER_ATTRIBUTE_COMPLIANCE_LIMIT_SYMMETRY attribute is set to NIDCPOWER_VAL_ASYMMETRIC and the NIDCPOWER_ATTRIBUTE_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_VOLTAGE.

You must also specify NIDCPOWER_ATTRIBUTE_CURRENT_LIMIT_LOW to complete the asymmetric range.

!Note(Aspose.Words.41885b0c-31fa-440b-9ab8-b894c1d71458.001.png) Note  The channel must be enabled and the output relay must be connected for the specified limit to take effect. Refer to the NIDCPOWER_ATTRIBUTE_OUTPUT_ENABLED attribute and the NIDCPOWER_ATTRIBUTE_OUTPUT_CONNECTED attribute for more information about enabling the output channel and connecting the output relay respectively.
!Note(Aspose.Words.41885b0c-31fa-440b-9ab8-b894c1d71458.001.png) Note  Refer to Supported Attributes by Device for information about supported devices.
Valid Values: 1% of NIDCPOWER_ATTRIBUTE_CURRENT_LIMIT_RANGE, NIDCPOWER_ATTRIBUTE_CURRENT_LIMIT_RANGE
  • The range bounded by the limit high and limit low must include zero.
!Note(Aspose.Words.41885b0c-31fa-440b-9ab8-b894c1d71458.001.png) Note  The limit may be extended beyond the selected limit range if the NIDCPOWER_ATTRIBUTE_OVERRANGING_ENABLED attribute is set to VI_TRUE.
Default Value: Refer to Supported Attributes by Device for the default value by device.

Related Topics:

Ranges

Changing Ranges

Overranging

NIDCPOWER_ATTRIBUTE_CURRENT_LIMIT_LOW

Specific Attribute

Numeric Value Datatype Access Applies to Coercion High-Level Functions
1150188 ViReal64 R/W Channel None None

Description

Specifies the minimum current, in amps, that the output can produce when generating the desired voltage on the specified channel(s).

This attribute is applicable only if the NIDCPOWER_ATTRIBUTE_COMPLIANCE_LIMIT_SYMMETRY attribute is set to NIDCPOWER_VAL_ASYMMETRIC and the NIDCPOWER_ATTRIBUTE_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_VOLTAGE.

You must also specify NIDCPOWER_ATTRIBUTE_CURRENT_LIMIT_HIGH to complete the asymmetric range.

!Note(Aspose.Words.41885b0c-31fa-440b-9ab8-b894c1d71458.001.png) Note  The channel must be enabled and the output relay must be connected for the specified limit to take effect. Refer to the NIDCPOWER_ATTRIBUTE_OUTPUT_ENABLED attribute and the NIDCPOWER_ATTRIBUTE_OUTPUT_CONNECTED attribute for more information about enabling the output channel and connecting the output relay respectively.
!Note(Aspose.Words.41885b0c-31fa-440b-9ab8-b894c1d71458.001.png) Note  Refer to Supported Attributes by Device for information about supported devices.
Valid Values: -NIDCPOWER_ATTRIBUTE_CURRENT_LIMIT_RANGE, -1% of NIDCPOWER_ATTRIBUTE_CURRENT_LIMIT_RANGE
  • The range bounded by the limit high and limit low must include zero.
!Note(Aspose.Words.41885b0c-31fa-440b-9ab8-b894c1d71458.001.png) Note  The limit may be extended beyond the selected limit range if the NIDCPOWER_ATTRIBUTE_OVERRANGING_ENABLED attribute is set to VI_TRUE.
Default Value: Refer to Supported Attributes by Device for the default value by device.

Related Topics:

Ranges

Changing Ranges

Overranging

NIDCPOWER_ATTRIBUTE_CURRENT_LIMIT_RANGE

Specific Attribute

Numeric Value Datatype Access Applies to Coercion High-Level Functions
1150004 ViReal64 R/W N/A Yes niDCPower_ConfigureCurrentLimitRange

Description

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_ATTRIBUTE_CURRENT_LIMIT_AUTORANGE attribute to enable automatic selection of the current limit range.

This attribute is applicable only if the NIDCPOWER_ATTRIBUTE_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_VOLTAGE.

!Note(Aspose.Words.41885b0c-31fa-440b-9ab8-b894c1d71458.001.png) Note  The channel must be enabled for the specified current limit to take effect. Refer to the NIDCPOWER_ATTRIBUTE_OUTPUT_ENABLED attribute 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.

Related Topics:

Ranges

NIDCPOWER_ATTRIBUTE_CURRENT_LIMIT_AUTORANGE

Specific Attribute

Numeric Value Datatype Access Applies to Coercion High-Level Functions
1150016 ViInt32 R/W Channel None None

Description

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 attribute to NIDCPOWER_VAL_ON, NI-DCPower ignores any changes you make to the NIDCPOWER_ATTRIBUTE_CURRENT_LIMIT_RANGE attribute. If you change this attribute from NIDCPOWER_VAL_ON to NIDCPOWER_VAL_OFF, NI-DCPower retains the last value the NIDCPOWER_ATTRIBUTE_CURRENT_LIMIT_RANGE attribute was set to (or the default value if the attribute was never set) and uses that value as the current limit range.

Query the NIDCPOWER_ATTRIBUTE_CURRENT_LIMIT_RANGE attribute by using the niDCPower_GetAttributeViInt32 function for information about which range NI-DCPower automatically selects.

This attribute is applicable only if the NIDCPOWER_ATTRIBUTE_OUTPUT_FUNCTION attribute is set to NIDCPOWER_VAL_DC_VOLTAGE.

Defined Values:

NIDCPOWER_VAL_OFF (0) NI-DCPower does not automatically select the current limit range.
NIDCPOWER_VAL_ON (1) NI-DCPower automatically selects the current limit range.
Default Value:

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

Related Topics:

Ranges