Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update nidcpower metadata #2065

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
+83 −50
Open

Update nidcpower metadata #2065

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
5c405c0
Update metadata for nidcpower to version 25.0.0d98
jkwoon-NI Jan 2, 2025
a47ec2c
Update CHANGELOG.md
jkwoon-NI Jan 2, 2025
ff7713d
Generate files from updated metadata
jkwoon-NI Jan 2, 2025
45f82d1
Fix enum names for `OutputStates.VOLTAGE` and `OutputStates.CURRENT`
jkwoon-NI Jan 2, 2025
2ccad80
Generate `conf.py` files for other modules
jkwoon-NI Jan 3, 2025
bbd9853
Undo manually added `python_names`
jkwoon-NI Jan 9, 2025
b0767b4
Regenerate files
jkwoon-NI Jan 9, 2025
bb0055d
Remove documentation changes from changelog
jkwoon-NI Jan 9, 2025
7063e87
Document breaking changes with regards to `OutputStates` enum
jkwoon-NI Jan 9, 2025
f42071f
Update `test_query_output_state` unit test for the changed enum value…
jkwoon-NI Jan 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,13 @@ 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
jkwoon-NI marked this conversation as resolved.
Show resolved Hide resolved
* **[Source Breaker]:** Enum value names in `OutputStates` have been changed:
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added notes about the enum value name changes to the changelog.

* `OutputStates.VOLTAGE` -> `OutputStates.CONSTANT_VOLTAGE`
* `OutputStates.CURRENT` -> `OutputStates.CONSTANT_CURRENT`
* #### Removed
* ### `nidigital` (NI-Digital Pattern Driver)
* #### Added
Expand Down
25 changes: 13 additions & 12 deletions docs/nidcpower/class.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.



Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/nidcpower/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
14 changes: 12 additions & 2 deletions docs/nidcpower/enums.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1166,7 +1166,7 @@ OutputStates

.. py:class:: OutputStates

.. py:attribute:: OutputStates.VOLTAGE
.. py:attribute:: OutputStates.CONSTANT_VOLTAGE



Expand All @@ -1176,7 +1176,7 @@ OutputStates



.. py:attribute:: OutputStates.CURRENT
.. py:attribute:: OutputStates.CONSTANT_CURRENT



Expand All @@ -1186,6 +1186,16 @@ OutputStates



.. py:attribute:: OutputStates.INHIBITED



The channel is in the inhibited state.





Polarity
--------

Expand Down
2 changes: 1 addition & 1 deletion docs/nidigital/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/nidmm/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/nifgen/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/nimodinst/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/niscope/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/nise/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/niswitch/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/nitclk/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 6 additions & 2 deletions generated/nidcpower/nidcpower/enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
25 changes: 13 additions & 12 deletions generated/nidcpower/nidcpower/session.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down
Loading
Loading