Update nidcpower metadata (ni#2065)

jkwoon-NI · web-flow · commit afd791ef6cd3 · 2025-01-16T13:24:05.000-06:00
* Update metadata for nidcpower to version 25.0.0d98 * Update CHANGELOG.md * Generate files from updated metadata * Fix enum names for `OutputStates.VOLTAGE` and `OutputStates.CURRENT` * Generate `conf.py` files for other modules * Undo manually added `python_names` * Regenerate files * Remove documentation changes from changelog * Document breaking changes with regards to `OutputStates` enum * Update `test_query_output_state` unit test for the changed enum value names * Updated changelog to reference ni#2067
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -42,7 +42,11 @@ All notable changes to this project will be documented in this file.
     * #### Removed
 * ### `nidcpower` (NI-DCPower)
     * #### Added
+        * API parity with NI-DCPower 2025 Q1.
+            * Enum value added:
+                * `INHIBITED` added to enum `OutputStates`.
     * #### Changed
+        * Fixed #2067: `nidcpower.OutputStates` values are incorrect.
     * #### Removed
 * ### `nidigital` (NI-Digital Pattern Driver)
     * #### Added
diff --git a/docs/nidcpower/class.rst b/docs/nidcpower/class.rst
@@ -2480,11 +2480,13 @@ query_output_state
                 Specifies the output state of the channel that is being queried.
                 **Defined Values**:
 
-                +--------------------------------------------+-------------------------------------------------------------------+
-                | :py:data:`~nidcpower.OutputStates.VOLTAGE` | The device maintains a constant voltage by adjusting the current. |
-                +--------------------------------------------+-------------------------------------------------------------------+
-                | :py:data:`~nidcpower.OutputStates.CURRENT` | The device maintains a constant current by adjusting the voltage. |
-                +--------------------------------------------+-------------------------------------------------------------------+
+                +-----------------------------------------------------+--------------------------------------------------------------------+
+                | :py:data:`~nidcpower.OutputStates.CONSTANT_VOLTAGE` | The channel maintains a constant voltage by adjusting the current. |
+                +-----------------------------------------------------+--------------------------------------------------------------------+
+                | :py:data:`~nidcpower.OutputStates.CONSTANT_CURRENT` | The channel maintains a constant current by adjusting the voltage. |
+                +-----------------------------------------------------+--------------------------------------------------------------------+
+                | :py:data:`~nidcpower.OutputStates.INHIBITED`        | The channel is in the inhibited state.                             |
+                +-----------------------------------------------------+--------------------------------------------------------------------+
 
 
             :type output_state: :py:data:`nidcpower.OutputStates`
@@ -6868,7 +6870,7 @@ 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.
-        Valid Values: The PXIe-4051, PXIe-4147, and PXIe-4151 support values from 170 to 18000110.
+        Valid Values: The PXIe-4051, PXIe-4147, and PXIe-4150/4151 support values from 170 to 18000110.
         The PXIe-4162/4163 supports values from  256 to 1000192.
         The PXIe-4190 supports values from 102 to 6000048.
         The PXIe-4112, PXIe-4113, and PXIe-4154 support values from 1000 to 178956970.
@@ -6915,7 +6917,7 @@ measure_complete_event_delay
         Specifies the amount of time to delay the generation of the Measure Complete event, in seconds.
         Valid Values: The PXIe-4051 supports values from 0 seconds to 39 seconds.
         The PXIe-4147 supports values from 0 seconds to 26.5 seconds.
-        The PXIe-4151 supports values from 0 seconds to 42 seconds.
+        The PXIe-4150/4151 supports values from 0 seconds to 42 seconds.
         The PXIe-4162/4163 and PXIe-4190 support values from 0 seconds to 23 seconds.
         All other supported instruments support values from 0 to 167 seconds.
         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.
@@ -7372,10 +7374,9 @@ merged_channels
 
     .. py:attribute:: merged_channels
 
-        Specifies the channel(s) to merge with a designated primary channel of an instrument in order to increase the maximum current you can source from the instrument.
-        This property designates the merge channels to combine with a primary channel. To designate the primary channel, initialize the session to the primary channel only.
-        Note: You cannot change the merge configuration with this property when the session is in the Running state.
-        For complete information on using merged channels with this property, refer to Merged Channels in the NI DC Power Supplies and SMUs Help.
+        Specifies the merge channel(s) to combine with a designated primary channel of an instrument in order to increase the maximum current you can source from the instrument.
+        Set this property on the primary channel only, and pass the merge channels as the value of this property.
+        Refer to the Merged Channels topic in your instrument user manual for more information about using merged channels.
 
 
 
@@ -11034,7 +11035,7 @@ source_delay
         Refer to the Single Point Source Mode and Sequence Source Mode topics for more information.
         Valid Values: The PXIe-4051 supports values from 0 to 39 seconds.
         The PXIe-4147 supports values from 0 to 26.5 seconds.
-        The PXIe-4151 supports values from 0 to 42 seconds.
+        The PXIe-4150/4151 supports values from 0 to 42 seconds.
         The PXIe-4162/4163 and PXIe-4190 support values from 0 to 23 seconds.
         All other supported instruments support values from 0 to 167 seconds.
         Default Value: 0.01667 seconds
diff --git a/docs/nidcpower/conf.py b/docs/nidcpower/conf.py
@@ -55,7 +55,7 @@
 
 # General information about the project.
 project = 'NI-DCPower Python API'
-copyright = '2017-2024, National Instruments Corporation'
+copyright = '2017-2025, National Instruments Corporation'
 author = 'NI'
 
 # The version info for the project you're documenting, acts as replacement for
diff --git a/docs/nidcpower/enums.rst b/docs/nidcpower/enums.rst
@@ -1166,7 +1166,7 @@ OutputStates
 
 .. py:class:: OutputStates
 
-    .. py:attribute:: OutputStates.VOLTAGE
+    .. py:attribute:: OutputStates.CONSTANT_VOLTAGE
 
 
 
@@ -1176,7 +1176,7 @@ OutputStates
 
 
 
-    .. py:attribute:: OutputStates.CURRENT
+    .. py:attribute:: OutputStates.CONSTANT_CURRENT
 
 
 
@@ -1186,6 +1186,16 @@ OutputStates
 
 
 
+    .. py:attribute:: OutputStates.INHIBITED
+
+
+
+        The channel is in the inhibited state.
+
+        
+
+
+
 Polarity
 --------
 
diff --git a/docs/nidigital/conf.py b/docs/nidigital/conf.py
@@ -55,7 +55,7 @@
 
 # General information about the project.
 project = 'NI-Digital Pattern Driver Python API'
-copyright = '2019-2024, National Instruments Corporation'
+copyright = '2019-2025, National Instruments Corporation'
 author = 'NI'
 
 # The version info for the project you're documenting, acts as replacement for
diff --git a/docs/nidmm/conf.py b/docs/nidmm/conf.py
@@ -55,7 +55,7 @@
 
 # General information about the project.
 project = 'NI-DMM Python API'
-copyright = '2017-2024, National Instruments Corporation'
+copyright = '2017-2025, National Instruments Corporation'
 author = 'NI'
 
 # The version info for the project you're documenting, acts as replacement for
diff --git a/docs/nifgen/conf.py b/docs/nifgen/conf.py
@@ -55,7 +55,7 @@
 
 # General information about the project.
 project = 'NI-FGEN Python API'
-copyright = '2017-2024, National Instruments Corporation'
+copyright = '2017-2025, National Instruments Corporation'
 author = 'NI'
 
 # The version info for the project you're documenting, acts as replacement for
diff --git a/docs/nimodinst/conf.py b/docs/nimodinst/conf.py
@@ -55,7 +55,7 @@
 
 # General information about the project.
 project = 'NI-ModInst Python API'
-copyright = '2017-2024, National Instruments Corporation'
+copyright = '2017-2025, National Instruments Corporation'
 author = 'NI'
 
 # The version info for the project you're documenting, acts as replacement for
diff --git a/docs/niscope/conf.py b/docs/niscope/conf.py
@@ -55,7 +55,7 @@
 
 # General information about the project.
 project = 'NI-SCOPE Python API'
-copyright = '2017-2024, National Instruments Corporation'
+copyright = '2017-2025, National Instruments Corporation'
 author = 'NI'
 
 # The version info for the project you're documenting, acts as replacement for
diff --git a/docs/nise/conf.py b/docs/nise/conf.py
@@ -55,7 +55,7 @@
 
 # General information about the project.
 project = 'NI Switch Executive Python API'
-copyright = '2018-2024, National Instruments Corporation'
+copyright = '2018-2025, National Instruments Corporation'
 author = 'NI'
 
 # The version info for the project you're documenting, acts as replacement for
diff --git a/docs/niswitch/conf.py b/docs/niswitch/conf.py
@@ -55,7 +55,7 @@
 
 # General information about the project.
 project = 'NI-SWITCH Python API'
-copyright = '2017-2024, National Instruments Corporation'
+copyright = '2017-2025, National Instruments Corporation'
 author = 'NI'
 
 # The version info for the project you're documenting, acts as replacement for
diff --git a/docs/nitclk/conf.py b/docs/nitclk/conf.py
@@ -55,7 +55,7 @@
 
 # General information about the project.
 project = 'NI-TClk Python API'
-copyright = '2019-2024, National Instruments Corporation'
+copyright = '2019-2025, National Instruments Corporation'
 author = 'NI'
 
 # The version info for the project you're documenting, acts as replacement for
diff --git a/generated/nidcpower/nidcpower/enums.py b/generated/nidcpower/nidcpower/enums.py
@@ -512,14 +512,18 @@ class OutputFunction(Enum):
 
 
 class OutputStates(Enum):
-    VOLTAGE = 0
+    CONSTANT_VOLTAGE = 0
     r'''
     The channel maintains a constant voltage by adjusting the current.
     '''
-    CURRENT = 1
+    CONSTANT_CURRENT = 1
     r'''
     The channel maintains a constant current by adjusting the voltage.
     '''
+    INHIBITED = 1163
+    r'''
+    The channel is in the inhibited state.
+    '''
 
 
 class Polarity(Enum):
diff --git a/generated/nidcpower/nidcpower/session.py b/generated/nidcpower/nidcpower/session.py
@@ -2018,7 +2018,7 @@ class _SessionBase(object):
 
     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.
-    Valid Values: The PXIe-4051, PXIe-4147, and PXIe-4151 support values from 170 to 18000110.
+    Valid Values: The PXIe-4051, PXIe-4147, and PXIe-4150/4151 support values from 170 to 18000110.
     The PXIe-4162/4163 supports values from  256 to 1000192.
     The PXIe-4190 supports values from 102 to 6000048.
     The PXIe-4112, PXIe-4113, and PXIe-4154 support values from 1000 to 178956970.
@@ -2044,7 +2044,7 @@ class _SessionBase(object):
     Specifies the amount of time to delay the generation of the Measure Complete event, in seconds.
     Valid Values: The PXIe-4051 supports values from 0 seconds to 39 seconds.
     The PXIe-4147 supports values from 0 seconds to 26.5 seconds.
-    The PXIe-4151 supports values from 0 seconds to 42 seconds.
+    The PXIe-4150/4151 supports values from 0 seconds to 42 seconds.
     The PXIe-4162/4163 and PXIe-4190 support values from 0 seconds to 23 seconds.
     All other supported instruments support values from 0 to 167 seconds.
     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.
@@ -2270,10 +2270,9 @@ class _SessionBase(object):
     merged_channels = _attributes.AttributeViStringRepeatedCapability(1150249)
     '''Type: str
 
-    Specifies the channel(s) to merge with a designated primary channel of an instrument in order to increase the maximum current you can source from the instrument.
-    This property designates the merge channels to combine with a primary channel. To designate the primary channel, initialize the session to the primary channel only.
-    Note: You cannot change the merge configuration with this property when the session is in the Running state.
-    For complete information on using merged channels with this property, refer to Merged Channels in the NI DC Power Supplies and SMUs Help.
+    Specifies the merge channel(s) to combine with a designated primary channel of an instrument in order to increase the maximum current you can source from the instrument.
+    Set this property on the primary channel only, and pass the merge channels as the value of this property.
+    Refer to the Merged Channels topic in your instrument user manual for more information about using merged channels.
 
     Note:
     NI-DCPower uses the terms "source" and "output". However, while sinking with electronic loads and SMUs these correspond to "sinking" and "input", respectively.
@@ -4155,7 +4154,7 @@ class _SessionBase(object):
     Refer to the Single Point Source Mode and Sequence Source Mode topics for more information.
     Valid Values: The PXIe-4051 supports values from 0 to 39 seconds.
     The PXIe-4147 supports values from 0 to 26.5 seconds.
-    The PXIe-4151 supports values from 0 to 42 seconds.
+    The PXIe-4150/4151 supports values from 0 to 42 seconds.
     The PXIe-4162/4163 and PXIe-4190 support values from 0 to 23 seconds.
     All other supported instruments support values from 0 to 167 seconds.
     Default Value: 0.01667 seconds
@@ -6875,11 +6874,13 @@ def query_output_state(self, output_state):
             output_state (enums.OutputStates): Specifies the output state of the channel that is being queried.
                 **Defined Values**:
 
-                +----------------------+-------------------------------------------------------------------+
-                | OutputStates.VOLTAGE | The device maintains a constant voltage by adjusting the current. |
-                +----------------------+-------------------------------------------------------------------+
-                | OutputStates.CURRENT | The device maintains a constant current by adjusting the voltage. |
-                +----------------------+-------------------------------------------------------------------+
+                +-------------------------------+--------------------------------------------------------------------+
+                | OutputStates.CONSTANT_VOLTAGE | The channel maintains a constant voltage by adjusting the current. |
+                +-------------------------------+--------------------------------------------------------------------+
+                | OutputStates.CONSTANT_CURRENT | The channel maintains a constant current by adjusting the voltage. |
+                +-------------------------------+--------------------------------------------------------------------+
+                | OutputStates.INHIBITED        | The channel is in the inhibited state.                             |
+                +-------------------------------+--------------------------------------------------------------------+
 
 
         Returns:
diff --git a/src/nidcpower/metadata/attributes.py b/src/nidcpower/metadata/attributes.py
diff --git a/src/nidcpower/metadata/config.py b/src/nidcpower/metadata/config.py
diff --git a/src/nidcpower/metadata/enums.py b/src/nidcpower/metadata/enums.py
diff --git a/src/nidcpower/metadata/functions.py b/src/nidcpower/metadata/functions.py
diff --git a/src/nidcpower/system_tests/test_system_nidcpower.py b/src/nidcpower/system_tests/test_system_nidcpower.py
