Skip to content

Commit a5b4906

Browse files
authored
NI-DCPower: Add API parity for NI-DCPower 2023 Q4 (#2027)
* NI-DCPower: Add API parity for NI-DCPower 2023 Q4 - Update the metadata for NI-DCPower to version 23.8.0f501 - Build nimi-python using tox and update the generated Python files and docs files - Update CHANGELOG.md * Fix names of enum values in CHANGELOG.md * Remove the previously added enums from CHANGELOG.md
1 parent d92f58a commit a5b4906

File tree

16 files changed

+4767
-3625
lines changed

16 files changed

+4767
-3625
lines changed

CHANGELOG.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,20 @@ All notable changes to this project will be documented in this file.
4040
* #### Removed
4141
* ### `nidcpower` (NI-DCPower)
4242
* #### Added
43+
* API parity with NI-DCPower 2023 Q4.
44+
* Properties added:
45+
* `current_level_rising_slew_rate`
46+
* `current_level_falling_slew_rate`
47+
* `conduction_voltage_mode`
48+
* `conduction_voltage_on_threshold`
49+
* `conduction_voltage_off_threshold`
50+
* `output_cutoff_voltage_measure_limit_high`
51+
* `output_cutoff_voltage_measure_limit_low`
52+
* Enum added:
53+
* `ConductionVoltageMode`
54+
* Enum values added:
55+
* `E_LOAD` added to enum `InstrumentMode`
56+
* `CURRENT_SATURATED`, `VOLTAGE_MEASURE_HIGH` and `VOLTAGE_MEASURE_LOW` added to enum `OutputCutoffReason`
4357
* #### Changed
4458
* #### Removed
4559
* ### `nidigital` (NI-Digital Pattern Driver)

docs/nidcpower/class.rst

Lines changed: 492 additions & 67 deletions
Large diffs are not rendered by default.

docs/nidcpower/enums.rst

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -356,6 +356,41 @@ ComplianceLimitSymmetry
356356

357357

358358

359+
ConductionVoltageMode
360+
---------------------
361+
362+
.. py:class:: ConductionVoltageMode
363+
364+
.. py:attribute:: ConductionVoltageMode.AUTOMATIC
365+
366+
367+
368+
The conduction voltage feature is only enabled when you set the :py:attr:`nidcpower.Session.output_function` property to :py:data:`~nidcpower.OutputFunction.DC_CURRENT`.
369+
370+
371+
372+
373+
374+
.. py:attribute:: ConductionVoltageMode.ENABLED
375+
376+
377+
378+
The conduction voltage feature is enabled.
379+
380+
381+
382+
383+
384+
.. py:attribute:: ConductionVoltageMode.DISABLED
385+
386+
387+
388+
The conduction voltage feature is disabled.
389+
390+
391+
392+
393+
359394
CurrentLimitBehavior
360395
--------------------
361396

@@ -546,6 +581,16 @@ InstrumentMode
546581

547582

548583

584+
.. py:attribute:: InstrumentMode.E_LOAD
585+
586+
587+
588+
The channel operates as an electronic load (E-Load).
589+
590+
591+
592+
593+
549594
LCRCompensationType
550595
-------------------
551596

@@ -1041,6 +1086,36 @@ OutputCutoffReason
10411086

10421087

10431088

1089+
.. py:attribute:: OutputCutoffReason.CURRENT_SATURATED
1090+
1091+
1092+
1093+
Queries or clears cutoff conditions when the measured current saturates the current range.
1094+
1095+
1096+
1097+
1098+
1099+
.. py:attribute:: OutputCutoffReason.VOLTAGE_MEASURE_HIGH
1100+
1101+
1102+
1103+
Queries or clears cutoff conditions when the measured voltage exceeded the high cutoff limit for voltage output.
1104+
1105+
1106+
1107+
1108+
1109+
.. py:attribute:: OutputCutoffReason.VOLTAGE_MEASURE_LOW
1110+
1111+
1112+
1113+
Queries or clears cutoff conditions when the measured voltage fell below the low cutoff limit for voltage output.
1114+
1115+
1116+
1117+
1118+
10441119
OutputFunction
10451120
--------------
10461121

generated/nidcpower/nidcpower/__init__.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@
1010
from nidcpower.grpc_session_options import * # noqa: F403,F401,H303
1111
from nidcpower.session import Session # noqa: F401
1212

13-
from nidcpower.lcr_load_compensation_spot import LCRLoadCompensationSpot # noqa: F401
14-
15-
from nidcpower.lcr_load_compensation_spot import struct_NILCRLoadCompensationSpot # noqa: F401
16-
1713
from nidcpower.lcr_measurement import LCRMeasurement # noqa: F401
1814

1915
from nidcpower.lcr_measurement import struct_NILCRMeasurement # noqa: F401
2016

17+
from nidcpower.lcr_load_compensation_spot import LCRLoadCompensationSpot # noqa: F401
18+
19+
from nidcpower.lcr_load_compensation_spot import struct_NILCRLoadCompensationSpot # noqa: F401
20+
2121

2222
def get_diagnostic_information():
2323
'''Get diagnostic information about the system state that is suitable for printing or logging

generated/nidcpower/nidcpower/_grpc_stub_interpreter.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@
1212
from . import nidcpower_pb2_grpc as nidcpower_grpc
1313
from . import session_pb2 as session_grpc_types
1414

15-
from . import lcr_load_compensation_spot as lcr_load_compensation_spot # noqa: F401
16-
1715
from . import lcr_measurement as lcr_measurement # noqa: F401
1816

17+
from . import lcr_load_compensation_spot as lcr_load_compensation_spot # noqa: F401
18+
1919

2020
class GrpcStubInterpreter(object):
2121
'''Interpreter for interacting with a gRPC Stub class'''

generated/nidcpower/nidcpower/_library.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@
77

88
from nidcpower._visatype import * # noqa: F403,H303
99

10-
import nidcpower.lcr_load_compensation_spot as lcr_load_compensation_spot # noqa: F401
11-
1210
import nidcpower.lcr_measurement as lcr_measurement # noqa: F401
1311

12+
import nidcpower.lcr_load_compensation_spot as lcr_load_compensation_spot # noqa: F401
13+
1414

1515
class Library(object):
1616
'''Library

generated/nidcpower/nidcpower/_library_interpreter.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@
1111
import nidcpower.enums as enums # noqa: F401
1212
import nidcpower.errors as errors
1313

14-
import nidcpower.lcr_load_compensation_spot as lcr_load_compensation_spot # noqa: F401
15-
1614
import nidcpower.lcr_measurement as lcr_measurement # noqa: F401
1715

16+
import nidcpower.lcr_load_compensation_spot as lcr_load_compensation_spot # noqa: F401
17+
1818

1919
_was_runtime_environment_set = None
2020

generated/nidcpower/nidcpower/enums.py

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,21 @@ class ComplianceLimitSymmetry(Enum):
152152
'''
153153

154154

155+
class ConductionVoltageMode(Enum):
156+
AUTOMATIC = 1155
157+
r'''
158+
The conduction voltage feature is only enabled when you set the output_function property to OutputFunction.DC_CURRENT.
159+
'''
160+
ENABLED = 1156
161+
r'''
162+
The conduction voltage feature is enabled.
163+
'''
164+
DISABLED = 1157
165+
r'''
166+
The conduction voltage feature is disabled.
167+
'''
168+
169+
155170
class CurrentLimitBehavior(Enum):
156171
REGULATE = 0
157172
r'''
@@ -232,6 +247,10 @@ class InstrumentMode(Enum):
232247
r'''
233248
The channel operates as an LCR meter.
234249
'''
250+
E_LOAD = 1154
251+
r'''
252+
The channel operates as an electronic load (E-Load).
253+
'''
235254

236255

237256
class _IsolationState(Enum):
@@ -459,6 +478,18 @@ class OutputCutoffReason(Enum):
459478
r'''
460479
Queries or clears cutoff conditions when the current slew rate decreased beyond the negative change cutoff for current output.
461480
'''
481+
CURRENT_SATURATED = 512
482+
r'''
483+
Queries or clears cutoff conditions when the measured current saturates the current range.
484+
'''
485+
VOLTAGE_MEASURE_HIGH = 1024
486+
r'''
487+
Queries or clears cutoff conditions when the measured voltage exceeded the high cutoff limit for voltage output.
488+
'''
489+
VOLTAGE_MEASURE_LOW = 2048
490+
r'''
491+
Queries or clears cutoff conditions when the measured voltage fell below the low cutoff limit for voltage output.
492+
'''
462493

463494

464495
class OutputFunction(Enum):

generated/nidcpower/nidcpower/nidcpower_pb2.py

Lines changed: 631 additions & 623 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)