Skip to content

Commit 98698a8

Browse files
sbethursbethur
authored
nidcpower API update for NI-DCPower 20.5.0 Runtime changes (#1520)
* 20.5 API metadata updates. Autoranging documentation is pending. * Update docstrings * Update docstrings * Revert instruments rep cap changes * Update CHANGELOG.md
1 parent aed139f commit 98698a8

File tree

9 files changed

+765
-9
lines changed

9 files changed

+765
-9
lines changed

‎CHANGELOG.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,15 @@ All notable changes to this project will be documented in this file.
3333
* #### Removed
3434
* ### `nidcpower` (NI-DCPower)
3535
* #### Added
36+
* API parity with NI-DCPower 20.5.0 by adding measurement autoranging threshold range support, for which the following properties are added:
37+
* `autorange`
38+
* `autorange_aperture_time_mode`
39+
* `autorange_behavior`
40+
* `autorange_minimum_aperture_time`
41+
* `autorange_minimum_aperture_time_units`
42+
* `autorange_minimum_current_range`
43+
* `autorange_minimum_voltage_range`
44+
* `autorange_threshold_mode`
3645
* #### Changed
3746
* #### Removed
3847
* ### `nidigital` (NI-Digital Pattern Driver)

‎docs/nidcpower/class.rst‎

Lines changed: 296 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1988,6 +1988,302 @@ aperture_time_units
19881988
- LabVIEW Property: **Measurement:Aperture Time Units**
19891989
- C Attribute: **NIDCPOWER_ATTR_APERTURE_TIME_UNITS**
19901990
1991+
autorange
1992+
---------
1993+
1994+
.. py:attribute:: autorange
1995+
1996+
Specifies whether the hardware automatically selects the best range to measure the signal. Note the highest range the algorithm uses is dependent on the corresponding limit range property. The algorithm the hardware uses can be controlled using the :py:attr:`nidcpower.Session.autorange_aperture_time_mode` property.
1997+
1998+
1999+
2000+
.. note:: Autoranging begins at module startup and remains active until the module is reconfigured or reset. This property is not supported by all devices. Refer to Supported Properties by Device topic.
2001+
2002+
2003+
.. tip:: This property can use repeated capabilities. If set or get directly on the
2004+
nidcpower.Session object, then the set/get will use all repeated capabilities in the session.
2005+
You can specify a subset of repeated capabilities using the Python index notation on an
2006+
nidcpower.Session repeated capabilities container, and calling set/get value on the result.
2007+
2008+
The following table lists the characteristics of this property.
2009+
2010+
+----------------+------------+
2011+
| Characteristic | Value |
2012+
+================+============+
2013+
| Datatype | bool |
2014+
+----------------+------------+
2015+
| Permissions | read-write |
2016+
+----------------+------------+
2017+
| Channel Based | Yes |
2018+
+----------------+------------+
2019+
| Resettable | No |
2020+
+----------------+------------+
2021+
2022+
.. tip::
2023+
This property corresponds to the following LabVIEW Property or C Attribute:
2024+
2025+
- LabVIEW Property: **Measurement:Autorange**
2026+
- C Attribute: **NIDCPOWER_ATTR_AUTORANGE**
2027+
2028+
autorange_aperture_time_mode
2029+
----------------------------
2030+
2031+
.. py:attribute:: autorange_aperture_time_mode
2032+
2033+
Specifies whether the aperture time used for the measurement autorange algorithm is determined automatically or customized using the :py:attr:`nidcpower.Session.autorange_minimum_aperture_time` property.
2034+
2035+
2036+
2037+
.. note:: This property is not supported by all devices. Refer to Supported Properties by Device topic.
2038+
2039+
2040+
.. tip:: This property can use repeated capabilities. If set or get directly on the
2041+
nidcpower.Session object, then the set/get will use all repeated capabilities in the session.
2042+
You can specify a subset of repeated capabilities using the Python index notation on an
2043+
nidcpower.Session repeated capabilities container, and calling set/get value on the result.
2044+
2045+
The following table lists the characteristics of this property.
2046+
2047+
+----------------+---------------------------------+
2048+
| Characteristic | Value |
2049+
+================+=================================+
2050+
| Datatype | enums.AutorangeApertureTimeMode |
2051+
+----------------+---------------------------------+
2052+
| Permissions | read-write |
2053+
+----------------+---------------------------------+
2054+
| Channel Based | Yes |
2055+
+----------------+---------------------------------+
2056+
| Resettable | No |
2057+
+----------------+---------------------------------+
2058+
2059+
.. tip::
2060+
This property corresponds to the following LabVIEW Property or C Attribute:
2061+
2062+
- LabVIEW Property: **Measurement:Advanced:Autorange Aperture Time Mode**
2063+
- C Attribute: **NIDCPOWER_ATTR_AUTORANGE_APERTURE_TIME_MODE**
2064+
2065+
autorange_behavior
2066+
------------------
2067+
2068+
.. py:attribute:: autorange_behavior
2069+
2070+
Specifies the algorithm the hardware uses for measurement autoranging.
2071+
2072+
2073+
2074+
.. note:: This property is not supported by all devices. Refer to Supported Properties by Device topic.
2075+
2076+
2077+
.. tip:: This property can use repeated capabilities. If set or get directly on the
2078+
nidcpower.Session object, then the set/get will use all repeated capabilities in the session.
2079+
You can specify a subset of repeated capabilities using the Python index notation on an
2080+
nidcpower.Session repeated capabilities container, and calling set/get value on the result.
2081+
2082+
The following table lists the characteristics of this property.
2083+
2084+
+----------------+-------------------------+
2085+
| Characteristic | Value |
2086+
+================+=========================+
2087+
| Datatype | enums.AutorangeBehavior |
2088+
+----------------+-------------------------+
2089+
| Permissions | read-write |
2090+
+----------------+-------------------------+
2091+
| Channel Based | Yes |
2092+
+----------------+-------------------------+
2093+
| Resettable | No |
2094+
+----------------+-------------------------+
2095+
2096+
.. tip::
2097+
This property corresponds to the following LabVIEW Property or C Attribute:
2098+
2099+
- LabVIEW Property: **Measurement:Advanced:Autorange Behavior**
2100+
- C Attribute: **NIDCPOWER_ATTR_AUTORANGE_BEHAVIOR**
2101+
2102+
autorange_minimum_aperture_time
2103+
-------------------------------
2104+
2105+
.. py:attribute:: autorange_minimum_aperture_time
2106+
2107+
Specifies the measurement autorange aperture time used for the measurement autorange algorithm. The aperture time is specified in the units set by the :py:attr:`nidcpower.Session.autorange_minimum_aperture_time_units` property. This value will typically be smaller than the aperture time used for measurements.
2108+
2109+
2110+
2111+
.. note:: For smaller ranges, the value is scaled up to account for noise. The factor used to scale the value is derived from the module capabilities. This property is not supported by all devices. Refer to Supported Properties by Device topic.
2112+
2113+
2114+
.. tip:: This property can use repeated capabilities. If set or get directly on the
2115+
nidcpower.Session object, then the set/get will use all repeated capabilities in the session.
2116+
You can specify a subset of repeated capabilities using the Python index notation on an
2117+
nidcpower.Session repeated capabilities container, and calling set/get value on the result.
2118+
2119+
The following table lists the characteristics of this property.
2120+
2121+
+----------------+------------+
2122+
| Characteristic | Value |
2123+
+================+============+
2124+
| Datatype | float |
2125+
+----------------+------------+
2126+
| Permissions | read-write |
2127+
+----------------+------------+
2128+
| Channel Based | Yes |
2129+
+----------------+------------+
2130+
| Resettable | No |
2131+
+----------------+------------+
2132+
2133+
.. tip::
2134+
This property corresponds to the following LabVIEW Property or C Attribute:
2135+
2136+
- LabVIEW Property: **Measurement:Advanced:Autorange Minimum Aperture Time**
2137+
- C Attribute: **NIDCPOWER_ATTR_AUTORANGE_MINIMUM_APERTURE_TIME**
2138+
2139+
autorange_minimum_aperture_time_units
2140+
-------------------------------------
2141+
2142+
.. py:attribute:: autorange_minimum_aperture_time_units
2143+
2144+
Specifies the units of the :py:attr:`nidcpower.Session.autorange_minimum_aperture_time` property.
2145+
2146+
2147+
2148+
.. note:: This property is not supported by all devices. Refer to Supported Properties by Device topic.
2149+
2150+
2151+
.. tip:: This property can use repeated capabilities. If set or get directly on the
2152+
nidcpower.Session object, then the set/get will use all repeated capabilities in the session.
2153+
You can specify a subset of repeated capabilities using the Python index notation on an
2154+
nidcpower.Session repeated capabilities container, and calling set/get value on the result.
2155+
2156+
The following table lists the characteristics of this property.
2157+
2158+
+----------------+-------------------------+
2159+
| Characteristic | Value |
2160+
+================+=========================+
2161+
| Datatype | enums.ApertureTimeUnits |
2162+
+----------------+-------------------------+
2163+
| Permissions | read-write |
2164+
+----------------+-------------------------+
2165+
| Channel Based | Yes |
2166+
+----------------+-------------------------+
2167+
| Resettable | No |
2168+
+----------------+-------------------------+
2169+
2170+
.. tip::
2171+
This property corresponds to the following LabVIEW Property or C Attribute:
2172+
2173+
- LabVIEW Property: **Measurement:Advanced:Autorange Minimum Aperture Time Units**
2174+
- C Attribute: **NIDCPOWER_ATTR_AUTORANGE_MINIMUM_APERTURE_TIME_UNITS**
2175+
2176+
autorange_minimum_current_range
2177+
-------------------------------
2178+
2179+
.. py:attribute:: autorange_minimum_current_range
2180+
2181+
Specifies the lowest range used during measurement autoranging. Limiting the lowest range used during autoranging can improve the speed of the autoranging algorithm and minimize frequent and unpredictable range changes for noisy signals.
2182+
2183+
2184+
2185+
.. note:: The maximum range used is the range that includes the value specified in the compliance limit property, :py:attr:`nidcpower.Session.voltage_limit_range` property or :py:attr:`nidcpower.Session.current_limit_range` property, depending on the selected :py:attr:`nidcpower.Session.output_function`. This property is not supported by all devices. Refer to Supported Properties by Device topic.
2186+
2187+
2188+
.. tip:: This property can use repeated capabilities. If set or get directly on the
2189+
nidcpower.Session object, then the set/get will use all repeated capabilities in the session.
2190+
You can specify a subset of repeated capabilities using the Python index notation on an
2191+
nidcpower.Session repeated capabilities container, and calling set/get value on the result.
2192+
2193+
The following table lists the characteristics of this property.
2194+
2195+
+----------------+------------+
2196+
| Characteristic | Value |
2197+
+================+============+
2198+
| Datatype | float |
2199+
+----------------+------------+
2200+
| Permissions | read-write |
2201+
+----------------+------------+
2202+
| Channel Based | Yes |
2203+
+----------------+------------+
2204+
| Resettable | No |
2205+
+----------------+------------+
2206+
2207+
.. tip::
2208+
This property corresponds to the following LabVIEW Property or C Attribute:
2209+
2210+
- LabVIEW Property: **Measurement:Advanced:Autorange Minimum Current Range**
2211+
- C Attribute: **NIDCPOWER_ATTR_AUTORANGE_MINIMUM_CURRENT_RANGE**
2212+
2213+
autorange_minimum_voltage_range
2214+
-------------------------------
2215+
2216+
.. py:attribute:: autorange_minimum_voltage_range
2217+
2218+
Specifies the lowest range used during measurement autoranging. The maximum range used is range that includes the value specified in the compliance limit property. Limiting the lowest range used during autoranging can improve the speed of the autoranging algorithm and/or minimize thrashing between ranges for noisy signals.
2219+
2220+
2221+
2222+
.. note:: The maximum range used is the range that includes the value specified in the compliance limit property, :py:attr:`nidcpower.Session.voltage_limit_range` property or :py:attr:`nidcpower.Session.current_limit_range` property, depending on the selected :py:attr:`nidcpower.Session.output_function`. This property is not supported by all devices. Refer to Supported Properties by Device topic.
2223+
2224+
2225+
.. tip:: This property can use repeated capabilities. If set or get directly on the
2226+
nidcpower.Session object, then the set/get will use all repeated capabilities in the session.
2227+
You can specify a subset of repeated capabilities using the Python index notation on an
2228+
nidcpower.Session repeated capabilities container, and calling set/get value on the result.
2229+
2230+
The following table lists the characteristics of this property.
2231+
2232+
+----------------+------------+
2233+
| Characteristic | Value |
2234+
+================+============+
2235+
| Datatype | float |
2236+
+----------------+------------+
2237+
| Permissions | read-write |
2238+
+----------------+------------+
2239+
| Channel Based | Yes |
2240+
+----------------+------------+
2241+
| Resettable | No |
2242+
+----------------+------------+
2243+
2244+
.. tip::
2245+
This property corresponds to the following LabVIEW Property or C Attribute:
2246+
2247+
- LabVIEW Property: **Measurement:Advanced:Autorange Minimum Voltage Range**
2248+
- C Attribute: **NIDCPOWER_ATTR_AUTORANGE_MINIMUM_VOLTAGE_RANGE**
2249+
2250+
autorange_threshold_mode
2251+
------------------------
2252+
2253+
.. py:attribute:: autorange_threshold_mode
2254+
2255+
Specifies thresholds used during autoranging to determine when range changing occurs.
2256+
2257+
2258+
2259+
.. note:: This property is not supported by all devices. Refer to Supported Properties by Device topic.
2260+
2261+
2262+
.. tip:: This property can use repeated capabilities. If set or get directly on the
2263+
nidcpower.Session object, then the set/get will use all repeated capabilities in the session.
2264+
You can specify a subset of repeated capabilities using the Python index notation on an
2265+
nidcpower.Session repeated capabilities container, and calling set/get value on the result.
2266+
2267+
The following table lists the characteristics of this property.
2268+
2269+
+----------------+------------------------------+
2270+
| Characteristic | Value |
2271+
+================+==============================+
2272+
| Datatype | enums.AutorangeThresholdMode |
2273+
+----------------+------------------------------+
2274+
| Permissions | read-write |
2275+
+----------------+------------------------------+
2276+
| Channel Based | Yes |
2277+
+----------------+------------------------------+
2278+
| Resettable | No |
2279+
+----------------+------------------------------+
2280+
2281+
.. tip::
2282+
This property corresponds to the following LabVIEW Property or C Attribute:
2283+
2284+
- LabVIEW Property: **Measurement:Advanced:Autorange Threshold Mode**
2285+
- C Attribute: **NIDCPOWER_ATTR_AUTORANGE_THRESHOLD_MODE**
2286+
19912287
auto_zero
19922288
---------
19932289

0 commit comments

Comments
 (0)