Skip to content

Commit ff7713d

Browse files
committed
Generate files from updated metadata
1 parent a47ec2c commit ff7713d

File tree

5 files changed

+40
-18
lines changed

5 files changed

+40
-18
lines changed

docs/nidcpower/class.rst

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2480,11 +2480,13 @@ query_output_state
24802480
Specifies the output state of the channel that is being queried.
24812481
**Defined Values**:
24822482

2483-
+--------------------------------------------+-------------------------------------------------------------------+
2484-
| :py:data:`~nidcpower.OutputStates.VOLTAGE` | The device maintains a constant voltage by adjusting the current. |
2485-
+--------------------------------------------+-------------------------------------------------------------------+
2486-
| :py:data:`~nidcpower.OutputStates.CURRENT` | The device maintains a constant current by adjusting the voltage. |
2487-
+--------------------------------------------+-------------------------------------------------------------------+
2483+
+-----------------------------------------------------+--------------------------------------------------------------------+
2484+
| :py:data:`~nidcpower.OutputStates.CONSTANT_VOLTAGE` | The channel maintains a constant voltage by adjusting the current. |
2485+
+-----------------------------------------------------+--------------------------------------------------------------------+
2486+
| :py:data:`~nidcpower.OutputStates.CONSTANT_CURRENT` | The channel maintains a constant current by adjusting the voltage. |
2487+
+-----------------------------------------------------+--------------------------------------------------------------------+
2488+
| :py:data:`~nidcpower.OutputStates.INHIBITED` | The channel is in the inhibited state. |
2489+
+-----------------------------------------------------+--------------------------------------------------------------------+
24882490

24892491

24902492
:type output_state: :py:data:`nidcpower.OutputStates`
@@ -6868,7 +6870,7 @@ measure_buffer_size
68686870

68696871
Specifies the number of samples that the active channel measurement buffer can hold.
68706872
The default value is the maximum number of samples that a device is capable of recording in one second.
6871-
Valid Values: The PXIe-4051, PXIe-4147, and PXIe-4151 support values from 170 to 18000110.
6873+
Valid Values: The PXIe-4051, PXIe-4147, and PXIe-4150/4151 support values from 170 to 18000110.
68726874
The PXIe-4162/4163 supports values from 256 to 1000192.
68736875
The PXIe-4190 supports values from 102 to 6000048.
68746876
The PXIe-4112, PXIe-4113, and PXIe-4154 support values from 1000 to 178956970.
@@ -6915,7 +6917,7 @@ measure_complete_event_delay
69156917
Specifies the amount of time to delay the generation of the Measure Complete event, in seconds.
69166918
Valid Values: The PXIe-4051 supports values from 0 seconds to 39 seconds.
69176919
The PXIe-4147 supports values from 0 seconds to 26.5 seconds.
6918-
The PXIe-4151 supports values from 0 seconds to 42 seconds.
6920+
The PXIe-4150/4151 supports values from 0 seconds to 42 seconds.
69196921
The PXIe-4162/4163 and PXIe-4190 support values from 0 seconds to 23 seconds.
69206922
All other supported instruments support values from 0 to 167 seconds.
69216923
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
73727374

73737375
.. py:attribute:: merged_channels
73747376

7375-
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.
7376-
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.
7377-
Note: You cannot change the merge configuration with this property when the session is in the Running state.
7378-
For complete information on using merged channels with this property, refer to Merged Channels in the NI DC Power Supplies and SMUs Help.
7377+
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.
7378+
Set this property on the primary channel only, and pass the merge channels as the value of this property.
7379+
Refer to the Merged Channels topic in your instrument user manual for more information about using merged channels.
73797380

73807381

73817382

@@ -11034,7 +11035,7 @@ source_delay
1103411035
Refer to the Single Point Source Mode and Sequence Source Mode topics for more information.
1103511036
Valid Values: The PXIe-4051 supports values from 0 to 39 seconds.
1103611037
The PXIe-4147 supports values from 0 to 26.5 seconds.
11037-
The PXIe-4151 supports values from 0 to 42 seconds.
11038+
The PXIe-4150/4151 supports values from 0 to 42 seconds.
1103811039
The PXIe-4162/4163 and PXIe-4190 support values from 0 to 23 seconds.
1103911040
All other supported instruments support values from 0 to 167 seconds.
1104011041
Default Value: 0.01667 seconds

docs/nidcpower/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555

5656
# General information about the project.
5757
project = 'NI-DCPower Python API'
58-
copyright = '2017-2024, National Instruments Corporation'
58+
copyright = '2017-2025, National Instruments Corporation'
5959
author = 'NI'
6060

6161
# The version info for the project you're documenting, acts as replacement for

docs/nidcpower/enums.rst

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1166,7 +1166,7 @@ OutputStates
11661166

11671167
.. py:class:: OutputStates
11681168
1169-
.. py:attribute:: OutputStates.VOLTAGE
1169+
.. py:attribute:: OutputStates.CONSTANT_VOLTAGE
11701170
11711171
11721172
@@ -1176,7 +1176,7 @@ OutputStates
11761176

11771177

11781178

1179-
.. py:attribute:: OutputStates.CURRENT
1179+
.. py:attribute:: OutputStates.CONSTANT_CURRENT
11801180
11811181
11821182
@@ -1186,6 +1186,16 @@ OutputStates
11861186

11871187

11881188

1189+
.. py:attribute:: OutputStates.INHIBITED
1190+
1191+
1192+
1193+
The channel is in the inhibited state.
1194+
1195+
1196+
1197+
1198+
11891199
Polarity
11901200
--------
11911201

generated/nidcpower/nidcpower/enums.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -512,14 +512,18 @@ class OutputFunction(Enum):
512512

513513

514514
class OutputStates(Enum):
515-
VOLTAGE = 0
515+
CONSTANT_VOLTAGE = 0
516516
r'''
517517
The channel maintains a constant voltage by adjusting the current.
518518
'''
519-
CURRENT = 1
519+
CONSTANT_CURRENT = 1
520520
r'''
521521
The channel maintains a constant current by adjusting the voltage.
522522
'''
523+
INHIBITED = 1163
524+
r'''
525+
The channel is in the inhibited state.
526+
'''
523527

524528

525529
class Polarity(Enum):

src/nidcpower/metadata/enums.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# -*- coding: utf-8 -*-
2-
# This file is generated from NI-DCPower API metadata version 24.3.0f264
2+
# This file is generated from NI-DCPower API metadata version 25.0.0d98
33
enums = {
44
'ApertureTimeAutoMode': {
55
'values': [
@@ -994,6 +994,13 @@
994994
},
995995
'name': 'NIDCPOWER_VAL_OUTPUT_CONSTANT_CURRENT',
996996
'value': 1
997+
},
998+
{
999+
'documentation': {
1000+
'description': 'The channel is in the inhibited state.'
1001+
},
1002+
'name': 'NIDCPOWER_VAL_OUTPUT_INHIBITED',
1003+
'value': 1163
9971004
}
9981005
]
9991006
},

0 commit comments

Comments
 (0)