Skip to content

Commit 67cc13a

Browse files
authored
Update metadata before 1.4.8 release (ni#2055)
* Update nidcpower metadata - just attribute and function documentation changes * Update nidigital metadata - no metadata changes - .proto file seems to have changed the order of some things * Update nidmm metadata - 'grpc_enum': 'CalibrationType' deleted from a couple of functions - proto file re-ordered * Update nimodinst metadata * Update nifake metadata - Some custom types reordered - .proto file reordered * Update niscope metadata - .proto file reordered * Update nise metadata - no change * Update nitclk metadata - No changes * Run `tox -e codegen`
1 parent 5206de5 commit 67cc13a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+9811
-9902
lines changed

docs/nidcpower/class.rst

+17-16
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Session
7373
For new applications, use the default value of None
7474
and specify the channels in **resource name**.
7575

76-
Specifies which output channel(s) to include in a new session. Specify multiple
76+
Specifies which channel(s) to include in a new session. Specify multiple
7777
channels by using a channel list or a channel range. A channel list is a comma (,)
7878
separated sequence of channel names (for example, 0,2 specifies channels 0 and 2).
7979
A channel range is a lower bound channel followed by a hyphen (-) or colon (:)
@@ -174,7 +174,7 @@ abort
174174
Uncommitted state. If a sequence is running, it is stopped. Any
175175
configuration methods called after this method are not applied until
176176
the :py:meth:`nidcpower.Session.initiate` method is called. If power output is enabled
177-
when you call the :py:meth:`nidcpower.Session.abort` method, the output channels remain
177+
when you call the :py:meth:`nidcpower.Session.abort` method, the channels remain
178178
in their current state and continue providing power.
179179

180180
Use the :py:meth:`nidcpower.Session.ConfigureOutputEnabled` method to disable power
@@ -278,7 +278,7 @@ close
278278

279279
Closes the session specified in **vi** and deallocates the resources
280280
that NI-DCPower reserves. If power output is enabled when you call this
281-
method, the output channels remain in their existing state and
281+
method, the channels remain in their existing state and
282282
continue providing power. Use the :py:meth:`nidcpower.Session.ConfigureOutputEnabled`
283283
method to disable power output on a per channel basis. Use the
284284
:py:meth:`nidcpower.Session.reset` method to disable power output on all channel(s).
@@ -1240,7 +1240,7 @@ get_channel_name
12401240
:param index:
12411241

12421242

1243-
Specifies which output channel name to return. The index values begin at
1243+
Specifies which channel name to return. The index values begin at
12441244
1.
12451245

12461246

@@ -1252,7 +1252,7 @@ get_channel_name
12521252
:return:
12531253

12541254

1255-
Returns the output channel name that corresponds to **index**.
1255+
Returns the channel name that corresponds to **index**.
12561256

12571257

12581258

@@ -1874,7 +1874,7 @@ measure_multiple_lcr
18741874

18751875
.. py:method:: measure_multiple_lcr()
18761876

1877-
Measures and returns a list of LCRMeasurement instances on the specified output channel(s).
1877+
Measures and returns a list of LCRMeasurement instances on the specified channel(s).
18781878

18791879
To use this method:
18801880

@@ -2227,7 +2227,7 @@ query_in_compliance
22272227
:return:
22282228

22292229

2230-
Returns whether the device output channel is in compliance.
2230+
Returns whether the device channel is in compliance.
22312231

22322232

22332233

@@ -2392,7 +2392,7 @@ query_max_voltage_level
23922392
:return:
23932393

23942394

2395-
Returns the maximum voltage level that can be set on an output channel
2395+
Returns the maximum voltage level that can be set on a channel
23962396
with the specified **currentLimit**.
23972397

23982398

@@ -2437,7 +2437,7 @@ query_min_current_limit
24372437
:return:
24382438

24392439

2440-
Returns the minimum current limit that can be set on an output channel
2440+
Returns the minimum current limit that can be set on a channel
24412441
with the specified **voltageLevel**.
24422442

24432443

@@ -2451,7 +2451,7 @@ query_output_state
24512451

24522452
.. py:method:: query_output_state(output_state)
24532453

2454-
Queries the specified output channel to determine if the output channel
2454+
Queries the specified channel to determine if the channel
24552455
is currently in the state specified by **outputState**.
24562456

24572457
**Related Topics:**
@@ -2477,7 +2477,7 @@ query_output_state
24772477
:param output_state:
24782478

24792479

2480-
Specifies the output state of the output channel that is being queried.
2480+
Specifies the output state of the channel that is being queried.
24812481
**Defined Values**:
24822482

24832483
+--------------------------------------------+-------------------------------------------------------------------+
@@ -2493,7 +2493,7 @@ query_output_state
24932493
:return:
24942494

24952495

2496-
Returns whether the device output channel is in the specified output
2496+
Returns whether the device channel is in the specified output
24972497
state.
24982498

24992499

@@ -4106,7 +4106,7 @@ current_limit
41064106

41074107

41084108

4109-
.. note:: The channel must be enabled for the specified current limit to take effect. Refer to the :py:attr:`nidcpower.Session.output_enabled` property for more information about enabling the output channel.
4109+
.. note:: The channel must be enabled for the specified current limit to take effect. Refer to the :py:attr:`nidcpower.Session.output_enabled` property for more information about enabling the channel.
41104110

41114111
NI-DCPower uses the terms "source" and "output". However, while sinking with electronic loads and SMUs these correspond to "sinking" and "input", respectively.
41124112

@@ -6871,7 +6871,8 @@ measure_buffer_size
68716871
Valid Values: The PXIe-4051, PXIe-4147, and PXIe-4151 support values from 170 to 18000110.
68726872
The PXIe-4162/4163 supports values from 256 to 1000192.
68736873
The PXIe-4190 supports values from 102 to 6000048.
6874-
All other supported instruments support values from 1000 to 2147483647.
6874+
The PXIe-4112, PXIe-4113, and PXIe-4154 support values from 1000 to 178956970.
6875+
All other supported instruments support values from 1000 to 268435455.
68756876
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.
68766877

68776878

@@ -9687,7 +9688,7 @@ pulse_voltage_limit_range
96879688

96889689

96899690

9690-
.. note:: The channel must be enabled for the specified current limit to take effect. Refer to the :py:attr:`nidcpower.Session.output_enabled` property for more information about enabling the output channel.
9691+
.. note:: The channel must be enabled for the specified current limit to take effect. Refer to the :py:attr:`nidcpower.Session.output_enabled` property for more information about enabling the channel.
96919692

96929693

96939694
.. tip:: This property can be set/get on specific channels within your :py:class:`nidcpower.Session` instance.
@@ -11577,7 +11578,7 @@ voltage_limit
1157711578

1157811579

1157911580

11580-
.. note:: The channel must be enabled for the specified current level to take effect. Refer to the :py:attr:`nidcpower.Session.output_enabled` property for more information about enabling the output channel.
11581+
.. note:: The channel must be enabled for the specified current level to take effect. Refer to the :py:attr:`nidcpower.Session.output_enabled` property for more information about enabling the channel.
1158111582

1158211583
NI-DCPower uses the terms "source" and "output". However, while sinking with electronic loads and SMUs these correspond to "sinking" and "input", respectively.
1158311584

generated/nidcpower/nidcpower/session.py

+22-21
Original file line numberDiff line numberDiff line change
@@ -680,7 +680,7 @@ class _SessionBase(object):
680680
Valid Values: The valid values for this property are defined by the values to which current_limit_range property is set.
681681
682682
Note:
683-
The channel must be enabled for the specified current limit to take effect. Refer to the output_enabled property for more information about enabling the output channel.
683+
The channel must be enabled for the specified current limit to take effect. Refer to the output_enabled property for more information about enabling the channel.
684684
685685
NI-DCPower uses the terms "source" and "output". However, while sinking with electronic loads and SMUs these correspond to "sinking" and "input", respectively.
686686
@@ -2021,7 +2021,8 @@ class _SessionBase(object):
20212021
Valid Values: The PXIe-4051, PXIe-4147, and PXIe-4151 support values from 170 to 18000110.
20222022
The PXIe-4162/4163 supports values from 256 to 1000192.
20232023
The PXIe-4190 supports values from 102 to 6000048.
2024-
All other supported instruments support values from 1000 to 2147483647.
2024+
The PXIe-4112, PXIe-4113, and PXIe-4154 support values from 1000 to 178956970.
2025+
All other supported instruments support values from 1000 to 268435455.
20252026
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.
20262027
20272028
Note:
@@ -3491,7 +3492,7 @@ class _SessionBase(object):
34913492
This property is applicable only if the output_function property is set to OutputFunction.PULSE_CURRENT.
34923493
For valid ranges, refer to the specifications for your instrument.
34933494
3494-
Note: The channel must be enabled for the specified current limit to take effect. Refer to the output_enabled property for more information about enabling the output channel.
3495+
Note: The channel must be enabled for the specified current limit to take effect. Refer to the output_enabled property for more information about enabling the channel.
34953496
34963497
Tip:
34973498
This property can be set/get on specific channels within your :py:class:`nidcpower.Session` instance.
@@ -4383,7 +4384,7 @@ class _SessionBase(object):
43834384
43844385
Valid Values: The valid values for this property are defined by the values to which the voltage_limit_range property is set.
43854386
4386-
Note: The channel must be enabled for the specified current level to take effect. Refer to the output_enabled property for more information about enabling the output channel.
4387+
Note: The channel must be enabled for the specified current level to take effect. Refer to the output_enabled property for more information about enabling the channel.
43874388
43884389
NI-DCPower uses the terms "source" and "output". However, while sinking with electronic loads and SMUs these correspond to "sinking" and "input", respectively.
43894390
@@ -4595,7 +4596,7 @@ def abort(self):
45954596
Uncommitted state. If a sequence is running, it is stopped. Any
45964597
configuration methods called after this method are not applied until
45974598
the initiate method is called. If power output is enabled
4598-
when you call the abort method, the output channels remain
4599+
when you call the abort method, the channels remain
45994600
in their current state and continue providing power.
46004601
46014602
Use the ConfigureOutputEnabled method to disable power
@@ -5549,7 +5550,7 @@ def measure_multiple(self):
55495550
def measure_multiple_lcr(self):
55505551
'''measure_multiple_lcr
55515552
5552-
Measures and returns a list of LCRMeasurement instances on the specified output channel(s).
5553+
Measures and returns a list of LCRMeasurement instances on the specified channel(s).
55535554
55545555
To use this method:
55555556
@@ -6345,7 +6346,7 @@ def _measure_multiple(self):
63456346
def _measure_multiple_lcr(self):
63466347
r'''_measure_multiple_lcr
63476348
6348-
Measures and returns a list of LCRMeasurement instances on the specified output channel(s).
6349+
Measures and returns a list of LCRMeasurement instances on the specified channel(s).
63496350
63506351
To use this method:
63516352
@@ -6681,7 +6682,7 @@ def query_in_compliance(self):
66816682
Example: :py:meth:`my_session.query_in_compliance`
66826683
66836684
Returns:
6684-
in_compliance (bool): Returns whether the device output channel is in compliance.
6685+
in_compliance (bool): Returns whether the device channel is in compliance.
66856686
66866687
'''
66876688
in_compliance = self._interpreter.query_in_compliance(self._repeated_capability)
@@ -6808,7 +6809,7 @@ def query_max_voltage_level(self, current_limit):
68086809
68096810
68106811
Returns:
6811-
max_voltage_level (float): Returns the maximum voltage level that can be set on an output channel
6812+
max_voltage_level (float): Returns the maximum voltage level that can be set on a channel
68126813
with the specified **currentLimit**.
68136814
68146815
'''
@@ -6838,7 +6839,7 @@ def query_min_current_limit(self, voltage_level):
68386839
68396840
68406841
Returns:
6841-
min_current_limit (float): Returns the minimum current limit that can be set on an output channel
6842+
min_current_limit (float): Returns the minimum current limit that can be set on a channel
68426843
with the specified **voltageLevel**.
68436844
68446845
'''
@@ -6849,7 +6850,7 @@ def query_min_current_limit(self, voltage_level):
68496850
def query_output_state(self, output_state):
68506851
r'''query_output_state
68516852
6852-
Queries the specified output channel to determine if the output channel
6853+
Queries the specified channel to determine if the channel
68536854
is currently in the state specified by **outputState**.
68546855
68556856
**Related Topics:**
@@ -6871,7 +6872,7 @@ def query_output_state(self, output_state):
68716872
Example: :py:meth:`my_session.query_output_state`
68726873
68736874
Args:
6874-
output_state (enums.OutputStates): Specifies the output state of the output channel that is being queried.
6875+
output_state (enums.OutputStates): Specifies the output state of the channel that is being queried.
68756876
**Defined Values**:
68766877
68776878
+----------------------+-------------------------------------------------------------------+
@@ -6882,7 +6883,7 @@ def query_output_state(self, output_state):
68826883
68836884
68846885
Returns:
6885-
in_state (bool): Returns whether the device output channel is in the specified output
6886+
in_state (bool): Returns whether the device channel is in the specified output
68866887
state.
68876888
68886889
'''
@@ -7445,7 +7446,7 @@ def __init__(self, resource_name, channels=None, reset=False, options={}, indepe
74457446
channels (str, list, range, tuple): For new applications, use the default value of None
74467447
and specify the channels in **resource name**.
74477448
7448-
Specifies which output channel(s) to include in a new session. Specify multiple
7449+
Specifies which channel(s) to include in a new session. Specify multiple
74497450
channels by using a channel list or a channel range. A channel list is a comma (,)
74507451
separated sequence of channel names (for example, 0,2 specifies channels 0 and 2).
74517452
A channel range is a lower bound channel followed by a hyphen (-) or colon (:)
@@ -7559,7 +7560,7 @@ def close(self):
75597560
75607561
Closes the session specified in **vi** and deallocates the resources
75617562
that NI-DCPower reserves. If power output is enabled when you call this
7562-
method, the output channels remain in their existing state and
7563+
method, the channels remain in their existing state and
75637564
continue providing power. Use the ConfigureOutputEnabled
75647565
method to disable power output on a per channel basis. Use the
75657566
reset method to disable power output on all channel(s).
@@ -7769,7 +7770,7 @@ def _fancy_initialize(self, resource_name, channels=None, reset=False, option_st
77697770
channels (str, list, range, tuple): For new applications, use the default value of None
77707771
and specify the channels in **resource name**.
77717772
7772-
Specifies which output channel(s) to include in a new session. Specify multiple
7773+
Specifies which channel(s) to include in a new session. Specify multiple
77737774
channels by using a channel list or a channel range. A channel list is a comma (,)
77747775
separated sequence of channel names (for example, 0,2 specifies channels 0 and 2).
77757776
A channel range is a lower bound channel followed by a hyphen (-) or colon (:)
@@ -7854,12 +7855,12 @@ def get_channel_name(self, index):
78547855
determine the upper bound of valid values for **index**.
78557856
78567857
Args:
7857-
index (int): Specifies which output channel name to return. The index values begin at
7858+
index (int): Specifies which channel name to return. The index values begin at
78587859
1.
78597860
78607861
78617862
Returns:
7862-
channel_name (str): Returns the output channel name that corresponds to **index**.
7863+
channel_name (str): Returns the channel name that corresponds to **index**.
78637864
78647865
'''
78657866
channel_name = self._interpreter.get_channel_name(index)
@@ -8152,13 +8153,13 @@ def _initialize_with_channels(self, resource_name, channels, reset, option_strin
81528153
instrument's **resourceName**. **resourceName** can also be a logical
81538154
IVI name.
81548155
8155-
channels (str): Specifies which output channel(s) to include in a new session. Specify
8156+
channels (str): Specifies which channel(s) to include in a new session. Specify
81568157
multiple channels by using a channel list or a channel range. A channel
81578158
list is a comma (,) separated sequence of channel names (for example,
81588159
0,2 specifies channels 0 and 2). A channel range is a lower bound
81598160
channel followed by a hyphen (-) or colon (:) followed by an upper bound
81608161
channel (for example, 0-2 specifies channels 0, 1, and 2). In the
8161-
Running state, multiple output channel configurations are performed
8162+
Running state, multiple channel configurations are performed
81628163
sequentially based on the order specified in this parameter. If you do
81638164
not specify any channels, by default all channels on the device are
81648165
included in the session.
@@ -8345,7 +8346,7 @@ def _close(self):
83458346
83468347
Closes the session specified in **vi** and deallocates the resources
83478348
that NI-DCPower reserves. If power output is enabled when you call this
8348-
method, the output channels remain in their existing state and
8349+
method, the channels remain in their existing state and
83498350
continue providing power. Use the ConfigureOutputEnabled
83508351
method to disable power output on a per channel basis. Use the
83518352
reset method to disable power output on all channel(s).

generated/nidigital/nidigital/nidigitalpattern_pb2.py

+559-559
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)