Skip to content

Commit

Permalink
Update metadata before 1.4.8 release (#2055)
Browse files Browse the repository at this point in the history 
* 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`
  • Loading branch information
@ni-jfitzger
ni-jfitzger authored Apr 26, 2024
1 parent 5206de5 commit 67cc13a
Show file tree
Hide file tree
Showing 53 changed files with 9,811 additions and 9,902 deletions.
33 changes: 17 additions & 16 deletions docs/nidcpower/class.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Session
For new applications, use the default value of None
and specify the channels in **resource name**.

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

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

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


Specifies which output channel name to return. The index values begin at
Specifies which channel name to return. The index values begin at
1.


Expand All @@ -1252,7 +1252,7 @@ get_channel_name
:return:


Returns the output channel name that corresponds to **index**.
Returns the channel name that corresponds to **index**.



Expand Down Expand Up @@ -1874,7 +1874,7 @@ measure_multiple_lcr

.. py:method:: measure_multiple_lcr()

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

To use this method:

Expand Down Expand Up @@ -2227,7 +2227,7 @@ query_in_compliance
:return:


Returns whether the device output channel is in compliance.
Returns whether the device channel is in compliance.



Expand Down Expand Up @@ -2392,7 +2392,7 @@ query_max_voltage_level
:return:


Returns the maximum voltage level that can be set on an output channel
Returns the maximum voltage level that can be set on a channel
with the specified **currentLimit**.


Expand Down Expand Up @@ -2437,7 +2437,7 @@ query_min_current_limit
:return:


Returns the minimum current limit that can be set on an output channel
Returns the minimum current limit that can be set on a channel
with the specified **voltageLevel**.


Expand All @@ -2451,7 +2451,7 @@ query_output_state

.. py:method:: query_output_state(output_state)

Queries the specified output channel to determine if the output channel
Queries the specified channel to determine if the channel
is currently in the state specified by **outputState**.

**Related Topics:**
Expand All @@ -2477,7 +2477,7 @@ query_output_state
:param output_state:


Specifies the output state of the output channel that is being queried.
Specifies the output state of the channel that is being queried.
**Defined Values**:

+--------------------------------------------+-------------------------------------------------------------------+
Expand All @@ -2493,7 +2493,7 @@ query_output_state
:return:


Returns whether the device output channel is in the specified output
Returns whether the device channel is in the specified output
state.


Expand Down Expand Up @@ -4106,7 +4106,7 @@ current_limit



.. 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.
.. 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.

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 @@ -6871,7 +6871,8 @@ measure_buffer_size
Valid Values: The PXIe-4051, PXIe-4147, and PXIe-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.
All other supported instruments support values from 1000 to 2147483647.
The PXIe-4112, PXIe-4113, and PXIe-4154 support values from 1000 to 178956970.
All other supported instruments support values from 1000 to 268435455.
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 @@ -9687,7 +9688,7 @@ pulse_voltage_limit_range



.. 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.
.. 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.


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



.. 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.
.. 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.

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
43 changes: 22 additions & 21 deletions generated/nidcpower/nidcpower/session.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -680,7 +680,7 @@ class _SessionBase(object):
Valid Values: The valid values for this property are defined by the values to which current_limit_range property is set.
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.
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.
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 @@ -2021,7 +2021,8 @@ class _SessionBase(object):
Valid Values: The PXIe-4051, PXIe-4147, and PXIe-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.
All other supported instruments support values from 1000 to 2147483647.
The PXIe-4112, PXIe-4113, and PXIe-4154 support values from 1000 to 178956970.
All other supported instruments support values from 1000 to 268435455.
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.
Note:
Expand Down Expand Up @@ -3491,7 +3492,7 @@ class _SessionBase(object):
This property is applicable only if the output_function property is set to OutputFunction.PULSE_CURRENT.
For valid ranges, refer to the specifications for your instrument.
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.
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.
Tip:
This property can be set/get on specific channels within your :py:class:`nidcpower.Session` instance.
Expand Down Expand Up @@ -4383,7 +4384,7 @@ class _SessionBase(object):
Valid Values: The valid values for this property are defined by the values to which the voltage_limit_range property is set.
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.
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.
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 @@ -4595,7 +4596,7 @@ def abort(self):
Uncommitted state. If a sequence is running, it is stopped. Any
configuration methods called after this method are not applied until
the initiate method is called. If power output is enabled
when you call the abort method, the output channels remain
when you call the abort method, the channels remain
in their current state and continue providing power.
Use the ConfigureOutputEnabled method to disable power
Expand Down Expand Up @@ -5549,7 +5550,7 @@ def measure_multiple(self):
def measure_multiple_lcr(self):
'''measure_multiple_lcr
Measures and returns a list of LCRMeasurement instances on the specified output channel(s).
Measures and returns a list of LCRMeasurement instances on the specified channel(s).
To use this method:
Expand Down Expand Up @@ -6345,7 +6346,7 @@ def _measure_multiple(self):
def _measure_multiple_lcr(self):
r'''_measure_multiple_lcr
Measures and returns a list of LCRMeasurement instances on the specified output channel(s).
Measures and returns a list of LCRMeasurement instances on the specified channel(s).
To use this method:
Expand Down Expand Up @@ -6681,7 +6682,7 @@ def query_in_compliance(self):
Example: :py:meth:`my_session.query_in_compliance`
Returns:
in_compliance (bool): Returns whether the device output channel is in compliance.
in_compliance (bool): Returns whether the device channel is in compliance.
'''
in_compliance = self._interpreter.query_in_compliance(self._repeated_capability)
Expand Down Expand Up @@ -6808,7 +6809,7 @@ def query_max_voltage_level(self, current_limit):
Returns:
max_voltage_level (float): Returns the maximum voltage level that can be set on an output channel
max_voltage_level (float): Returns the maximum voltage level that can be set on a channel
with the specified **currentLimit**.
'''
Expand Down Expand Up @@ -6838,7 +6839,7 @@ def query_min_current_limit(self, voltage_level):
Returns:
min_current_limit (float): Returns the minimum current limit that can be set on an output channel
min_current_limit (float): Returns the minimum current limit that can be set on a channel
with the specified **voltageLevel**.
'''
Expand All @@ -6849,7 +6850,7 @@ def query_min_current_limit(self, voltage_level):
def query_output_state(self, output_state):
r'''query_output_state
Queries the specified output channel to determine if the output channel
Queries the specified channel to determine if the channel
is currently in the state specified by **outputState**.
**Related Topics:**
Expand All @@ -6871,7 +6872,7 @@ def query_output_state(self, output_state):
Example: :py:meth:`my_session.query_output_state`
Args:
output_state (enums.OutputStates): Specifies the output state of the output channel that is being queried.
output_state (enums.OutputStates): Specifies the output state of the channel that is being queried.
**Defined Values**:
+----------------------+-------------------------------------------------------------------+
Expand All @@ -6882,7 +6883,7 @@ def query_output_state(self, output_state):
Returns:
in_state (bool): Returns whether the device output channel is in the specified output
in_state (bool): Returns whether the device channel is in the specified output
state.
'''
Expand Down Expand Up @@ -7445,7 +7446,7 @@ def __init__(self, resource_name, channels=None, reset=False, options={}, indepe
channels (str, list, range, tuple): For new applications, use the default value of None
and specify the channels in **resource name**.
Specifies which output channel(s) to include in a new session. Specify multiple
Specifies which channel(s) to include in a new session. Specify multiple
channels by using a channel list or a channel range. A channel list is a comma (,)
separated sequence of channel names (for example, 0,2 specifies channels 0 and 2).
A channel range is a lower bound channel followed by a hyphen (-) or colon (:)
Expand Down Expand Up @@ -7559,7 +7560,7 @@ def close(self):
Closes the session specified in **vi** and deallocates the resources
that NI-DCPower reserves. If power output is enabled when you call this
method, the output channels remain in their existing state and
method, the channels remain in their existing state and
continue providing power. Use the ConfigureOutputEnabled
method to disable power output on a per channel basis. Use the
reset method to disable power output on all channel(s).
Expand Down Expand Up @@ -7769,7 +7770,7 @@ def _fancy_initialize(self, resource_name, channels=None, reset=False, option_st
channels (str, list, range, tuple): For new applications, use the default value of None
and specify the channels in **resource name**.
Specifies which output channel(s) to include in a new session. Specify multiple
Specifies which channel(s) to include in a new session. Specify multiple
channels by using a channel list or a channel range. A channel list is a comma (,)
separated sequence of channel names (for example, 0,2 specifies channels 0 and 2).
A channel range is a lower bound channel followed by a hyphen (-) or colon (:)
Expand Down Expand Up @@ -7854,12 +7855,12 @@ def get_channel_name(self, index):
determine the upper bound of valid values for **index**.
Args:
index (int): Specifies which output channel name to return. The index values begin at
index (int): Specifies which channel name to return. The index values begin at
1.
Returns:
channel_name (str): Returns the output channel name that corresponds to **index**.
channel_name (str): Returns the channel name that corresponds to **index**.
'''
channel_name = self._interpreter.get_channel_name(index)
Expand Down Expand Up @@ -8152,13 +8153,13 @@ def _initialize_with_channels(self, resource_name, channels, reset, option_strin
instrument's **resourceName**. **resourceName** can also be a logical
IVI name.
channels (str): Specifies which output channel(s) to include in a new session. Specify
channels (str): Specifies which channel(s) to include in a new session. Specify
multiple channels by using a channel list or a channel range. A channel
list is a comma (,) separated sequence of channel names (for example,
0,2 specifies channels 0 and 2). A channel range is a lower bound
channel followed by a hyphen (-) or colon (:) followed by an upper bound
channel (for example, 0-2 specifies channels 0, 1, and 2). In the
Running state, multiple output channel configurations are performed
Running state, multiple channel configurations are performed
sequentially based on the order specified in this parameter. If you do
not specify any channels, by default all channels on the device are
included in the session.
Expand Down Expand Up @@ -8345,7 +8346,7 @@ def _close(self):
Closes the session specified in **vi** and deallocates the resources
that NI-DCPower reserves. If power output is enabled when you call this
method, the output channels remain in their existing state and
method, the channels remain in their existing state and
continue providing power. Use the ConfigureOutputEnabled
method to disable power output on a per channel basis. Use the
reset method to disable power output on all channel(s).
Expand Down
1,118 changes: 559 additions & 559 deletions generated/nidigital/nidigital/nidigitalpattern_pb2.py
View file

Large diffs are not rendered by default.

Loading

0 comments on commit 67cc13a

Please sign in to comment.