Skip to content

NI-DCPower: Add API parity with NI-DCPower 2025 Q2 #2102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ni-jfitzger merged 2 commits into from
May 30, 2025
Merged

NI-DCPower: Add API parity with NI-DCPower 2025 Q2 #2102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f2cd03d
NI-DCPower: Add API parity with NI-DCPower 2025 Q2
olsl21 May 23, 2025
de39b94
Update CHANGELOG to remove the redundant "added"s
olsl21 May 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 24 additions & 7 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Changelog

## Packages
- [nidcpower (NI-DCPower)](#nidcpower-ni-dcpower)
- [nidigital (NI-Digital Pattern Driver)](#nidigital-ni-digital-pattern-driver)
Expand Down Expand Up @@ -49,6 +49,23 @@

#### [nidcpower] Unreleased
- Added
- API parity with NI-DCPower 2025 Q2.
- Properties:
- `constant_power_compensation_frequency`
- `constant_power_current_limit`
- `constant_power_gain_bandwidth`
- `constant_power_level`
- `constant_power_level_range`
- `constant_power_pole_zero_ratio`
- `constant_resistance_compensation_frequency`
- `constant_resistance_current_limit`
- `constant_resistance_gain_bandwidth`
- `constant_resistance_level`
- `constant_resistance_level_range`
- `constant_resistance_pole_zero_ratio`
- `output_shorted`
- Enum values:
- `CONSTANT_RESISTANCE` and `CONSTANT_POWER` added to enum `OutputFunction`
- Changed
- Removed

Expand Down Expand Up @@ -187,7 +204,7 @@
- `lcr_source_delay_mode`
- `lcr_stimulus_function`
- `lcr_voltage_amplitude`
- `lcr_voltage_range`
- `lcr_voltage_range`
- Enums added:
- `ApertureTimeAutoMode`
- `CableLength`
Expand All @@ -199,7 +216,7 @@
- `LCROpenShortLoadCompensationDataSource`
- `LCRReferenceValueType`
- `LCRSourceDelayMode`
- `LCRStimulusFunction`
- `LCRStimulusFunction`
- Methods added:
- `configure_lcr_custom_cable_compensation`
- `fetch_multiple_lcr`
Expand All @@ -210,7 +227,7 @@
- `perform_lcr_open_compensation`
- `perform_lcr_open_custom_cable_compensation`
- `perform_lcr_short_compensation`
- `perform_lcr_short_custom_cable_compensation`
- `perform_lcr_short_custom_cable_compensation`
- Custom types added:
- `LCRLoadCompensationSpot`
- `LCRMeasurement`
Expand All @@ -222,7 +239,7 @@
#### [nidcpower] 1.4.1 - 2021-08-23
- Added
- (Common) Support for Python 3.9
- API parity with NI-DCPower 21.0.0.
- API parity with NI-DCPower 21.0.0.
- Properties added:
- `output_cutoff_delay`
- Removed
Expand Down Expand Up @@ -1654,7 +1671,7 @@
i = 0
with nimodinst.Session('nidmm') as session:
name = session[i].device_name
```
```

#### [nimodinst] 0.1.0 - 2017-09-01
- Added
Expand All @@ -1669,7 +1686,7 @@
- Added
- Enabled selected public APIs
- Basic example
- Documentation for APIs (not final)
- Documentation for APIs (not final)
- Changed
- Removed

Expand Down
712 changes: 653 additions & 59 deletions docs/nidcpower/class.rst
View file
Open in desktop

Large diffs are not rendered by default.

22 changes: 21 additions & 1 deletion docs/nidcpower/enums.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,7 +365,7 @@ ConductionVoltageMode



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



Expand Down Expand Up @@ -1161,6 +1161,26 @@ OutputFunction



.. py:attribute:: OutputFunction.CONSTANT_RESISTANCE



Sets the output method to constant resistance.





.. py:attribute:: OutputFunction.CONSTANT_POWER



Sets the output method to constant power.





OutputStates
------------

Expand Down
10 changes: 9 additions & 1 deletion generated/nidcpower/nidcpower/enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ class ComplianceLimitSymmetry(Enum):
class ConductionVoltageMode(Enum):
AUTOMATIC = 1155
r'''
The conduction voltage feature is only enabled when you set the output_function property to OutputFunction.DC_CURRENT.
The conduction voltage feature is only enabled when you set the output_function property to OutputFunction.DC_CURRENT or OutputFunction.CONSTANT_POWER.
'''
ENABLED = 1156
r'''
Expand Down Expand Up @@ -509,6 +509,14 @@ class OutputFunction(Enum):
r'''
Sets the output method to pulse current.
'''
CONSTANT_RESISTANCE = 1161
r'''
Sets the output method to constant resistance.
'''
CONSTANT_POWER = 1162
r'''
Sets the output method to constant power.
'''


class OutputStates(Enum):
Expand Down
Loading