Skip to content

Commit 67b6f7d

Browse files
authored
NI-DCPower: Add API parity with NI-DCPower 2025 Q2 (#2102)
* NI-DCPower: Add API parity with NI-DCPower 2025 Q2 - Update the metadata for NI-DCPower to 25.3.0f265 - Update the generated enums.py and session.py files as well as the docs files - Update CHANGELOG.md to call out the API parity changes * Update CHANGELOG to remove the redundant "added"s
1 parent e66d8ee commit 67b6f7d

File tree

9 files changed

+1281
-139
lines changed

9 files changed

+1281
-139
lines changed

CHANGELOG.md

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Changelog
2-
2+
33
## Packages
44
- [nidcpower (NI-DCPower)](#nidcpower-ni-dcpower)
55
- [nidigital (NI-Digital Pattern Driver)](#nidigital-ni-digital-pattern-driver)
@@ -49,6 +49,23 @@
4949

5050
#### [nidcpower] Unreleased
5151
- Added
52+
- API parity with NI-DCPower 2025 Q2.
53+
- Properties:
54+
- `constant_power_compensation_frequency`
55+
- `constant_power_current_limit`
56+
- `constant_power_gain_bandwidth`
57+
- `constant_power_level`
58+
- `constant_power_level_range`
59+
- `constant_power_pole_zero_ratio`
60+
- `constant_resistance_compensation_frequency`
61+
- `constant_resistance_current_limit`
62+
- `constant_resistance_gain_bandwidth`
63+
- `constant_resistance_level`
64+
- `constant_resistance_level_range`
65+
- `constant_resistance_pole_zero_ratio`
66+
- `output_shorted`
67+
- Enum values:
68+
- `CONSTANT_RESISTANCE` and `CONSTANT_POWER` added to enum `OutputFunction`
5269
- Changed
5370
- Removed
5471

@@ -187,7 +204,7 @@
187204
- `lcr_source_delay_mode`
188205
- `lcr_stimulus_function`
189206
- `lcr_voltage_amplitude`
190-
- `lcr_voltage_range`
207+
- `lcr_voltage_range`
191208
- Enums added:
192209
- `ApertureTimeAutoMode`
193210
- `CableLength`
@@ -199,7 +216,7 @@
199216
- `LCROpenShortLoadCompensationDataSource`
200217
- `LCRReferenceValueType`
201218
- `LCRSourceDelayMode`
202-
- `LCRStimulusFunction`
219+
- `LCRStimulusFunction`
203220
- Methods added:
204221
- `configure_lcr_custom_cable_compensation`
205222
- `fetch_multiple_lcr`
@@ -210,7 +227,7 @@
210227
- `perform_lcr_open_compensation`
211228
- `perform_lcr_open_custom_cable_compensation`
212229
- `perform_lcr_short_compensation`
213-
- `perform_lcr_short_custom_cable_compensation`
230+
- `perform_lcr_short_custom_cable_compensation`
214231
- Custom types added:
215232
- `LCRLoadCompensationSpot`
216233
- `LCRMeasurement`
@@ -222,7 +239,7 @@
222239
#### [nidcpower] 1.4.1 - 2021-08-23
223240
- Added
224241
- (Common) Support for Python 3.9
225-
- API parity with NI-DCPower 21.0.0.
242+
- API parity with NI-DCPower 21.0.0.
226243
- Properties added:
227244
- `output_cutoff_delay`
228245
- Removed
@@ -1654,7 +1671,7 @@
16541671
i = 0
16551672
with nimodinst.Session('nidmm') as session:
16561673
name = session[i].device_name
1657-
```
1674+
```
16581675

16591676
#### [nimodinst] 0.1.0 - 2017-09-01
16601677
- Added
@@ -1669,7 +1686,7 @@
16691686
- Added
16701687
- Enabled selected public APIs
16711688
- Basic example
1672-
- Documentation for APIs (not final)
1689+
- Documentation for APIs (not final)
16731690
- Changed
16741691
- Removed
16751692

docs/nidcpower/class.rst

Lines changed: 653 additions & 59 deletions
Large diffs are not rendered by default.

docs/nidcpower/enums.rst

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -365,7 +365,7 @@ ConductionVoltageMode
365365
366366
367367
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`.
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` or :py:data:`~nidcpower.OutputFunction.CONSTANT_POWER`.
369369

370370

371371

@@ -1161,6 +1161,26 @@ OutputFunction
11611161

11621162

11631163

1164+
.. py:attribute:: OutputFunction.CONSTANT_RESISTANCE
1165+
1166+
1167+
1168+
Sets the output method to constant resistance.
1169+
1170+
1171+
1172+
1173+
1174+
.. py:attribute:: OutputFunction.CONSTANT_POWER
1175+
1176+
1177+
1178+
Sets the output method to constant power.
1179+
1180+
1181+
1182+
1183+
11641184
OutputStates
11651185
------------
11661186

generated/nidcpower/nidcpower/enums.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ class ComplianceLimitSymmetry(Enum):
155155
class ConductionVoltageMode(Enum):
156156
AUTOMATIC = 1155
157157
r'''
158-
The conduction voltage feature is only enabled when you set the output_function property to OutputFunction.DC_CURRENT.
158+
The conduction voltage feature is only enabled when you set the output_function property to OutputFunction.DC_CURRENT or OutputFunction.CONSTANT_POWER.
159159
'''
160160
ENABLED = 1156
161161
r'''
@@ -509,6 +509,14 @@ class OutputFunction(Enum):
509509
r'''
510510
Sets the output method to pulse current.
511511
'''
512+
CONSTANT_RESISTANCE = 1161
513+
r'''
514+
Sets the output method to constant resistance.
515+
'''
516+
CONSTANT_POWER = 1162
517+
r'''
518+
Sets the output method to constant power.
519+
'''
512520

513521

514522
class OutputStates(Enum):

0 commit comments

Comments
 (0)