Adding Max DC Reading rate at 7.5 digits example in NI-DMM

CHANGELOG.md

@@ -800,6 +800,7 @@
 #### [nidmm] Unreleased
 - Added
   - Added the `nidmm_measure_ac_volts.py` example.
+  - Added the `nidmm_max_dc_reading_rate_at_7_5_digits.py` example.
   - Added the `nidmm_cont_acq_chart_multiple_samples.py` example.
   - Added the `nidmm_cont_acq_multiple_samples_ext_trig.py` example.
   - Added the `nidmm_diode_test.py` example.

docs/nidmm/examples.rst

@@ -48,6 +48,15 @@ nidmm_improve_dc_noise_rejection.py
    :encoding: utf8
    :caption: `(nidmm_improve_dc_noise_rejection.py) <https://github.com/ni/nimi-python/blob/master/src/nidmm/examples/nidmm_improve_dc_noise_rejection.py>`_
 
+nidmm_max_dc_reading_rate_at_7_5_digits.py
+------------------------------------------
+
+.. literalinclude:: ../../src/nidmm/examples/nidmm_max_dc_reading_rate_at_7_5_digits.py
+   :language: python
+   :linenos:
+   :encoding: utf8
+   :caption: `(nidmm_max_dc_reading_rate_at_7_5_digits.py) <https://github.com/ni/nimi-python/blob/master/src/nidmm/examples/nidmm_max_dc_reading_rate_at_7_5_digits.py>`_
+
 nidmm_measure_ac_volts.py
 -------------------------
 

src/nidmm/examples/nidmm_max_dc_reading_rate_at_7_5_digits.py

@@ -0,0 +1,71 @@
+#!/usr/bin/python
+
+import argparse
+import nidmm
+import sys
+import time
+
+
+SUPPORTED_MODELS = ('4071', '4081')
+
+
+def example(device_name, options, powerline_frequency, measurement_range, aperture_time, adc_calibration, auto_zero, number_of_averages, total_samples):
+    with nidmm.Session(resource_name=device_name, reset_device=True, options=options) as session:
+        if not session.instrument_model.endswith(SUPPORTED_MODELS):
+            raise ValueError(f'{session.instrument_model} is not supported. This example requires an NI PXI-4071 or NI PXIe-4081.')
+
+        # Powerline frequency defines the timebase for aperture values in PLCs.
+        session.powerline_freq = powerline_frequency
+        session.configure_measurement_digits(measurement_function=nidmm.Function.DC_VOLTS, range=measurement_range, resolution_digits=7.5)
+        # A sample count of zero selects continuous acquisition.
+        session.configure_multi_point(trigger_count=1, sample_count=0)
+        session.aperture_time_units = nidmm.ApertureTimeUnits.POWER_LINE_CYCLES
+        session.aperture_time = aperture_time
+        session.number_of_averages = number_of_averages
+        session.auto_zero = nidmm.AutoZero[auto_zero]
+        # Disabling ADC calibration avoids the gain-reference measurement and increases reading rate.
+        session.adc_calibration = nidmm.ADCCalibration[adc_calibration]
+
+        samples_fetched = 0
+        start_time = time.perf_counter()
+        with session.initiate():
+            while samples_fetched < total_samples:
+                backlog, _ = session.read_status()
+                backlog = min(backlog, total_samples - samples_fetched)
+                new_samples = session.fetch_multi_point(array_size=backlog) if backlog > 0 else ()
+                samples_fetched += len(new_samples)
+        elapsed = time.perf_counter() - start_time
+        print(f'Fetched {samples_fetched} readings in {elapsed:.2f} s ({samples_fetched / elapsed:.0f} reads/sec)')
+
+
+def _main(argsv):
+    parser = argparse.ArgumentParser(description='Achieves the higher DC voltage reading rate at 7.5 digits of resolution with a PXI-4071 or PXIe-4081 and prints the achieved reading rate.', formatter_class=argparse.ArgumentDefaultsHelpFormatter)
+    parser.add_argument('-n', '--device-name', default='PXI1Slot2', help='Contains the resource_name of the device to initialize.')
+    parser.add_argument('-p', '--powerline-frequency', default=60.0, type=float, choices=[50.0, 60.0], help='Specifies the powerline frequency.')
+    parser.add_argument('-r', '--range', default=10.0, type=float, help='Specifies the range for the function specified in the Measurement_Function parameter.')
+    parser.add_argument('-a', '--aperture-time', default=1.0, type=float, help='Specifies the measurement aperture time for the current configuration, in powerline cycles (PLCs).')
+    parser.add_argument('-c', '--adc-calibration', default='OFF', choices=nidmm.ADCCalibration.__members__.keys(), type=str.upper, help='Specifies the ADC calibration mode.')
+    parser.add_argument('-z', '--auto-zero', default='ON', choices=nidmm.AutoZero.__members__.keys(), type=str.upper, help='Specifies the AutoZero mode.')
+    parser.add_argument('-v', '--number-of-averages', default=4, type=int, help='Specifies the number of averages to perform in a measurement.')
+    parser.add_argument('--total-samples', default=100, type=int, help='Number of readings to fetch before stopping.')
+    parser.add_argument('-op', '--option-string', default='', type=str, help='Sets the initial value of certain attributes for the session.')
+    args = parser.parse_args(argsv)
+    example(args.device_name, args.option_string, args.powerline_frequency, args.range, args.aperture_time, args.adc_calibration, args.auto_zero, args.number_of_averages, args.total_samples)
+
+
+def main():
+    _main(sys.argv[1:])
+
+
+def test_example():
+    options = {'simulate': True, 'driver_setup': {'Model': '4081', 'BoardType': 'PXIe', }, }
+    example('PXI1Slot2', options, 60.0, 10.0, 1.0, 'OFF', 'ON', 4, 100)
+
+
+def test_main():
+    cmd_line = ['--option-string', 'Simulate=1, DriverSetup=Model:4081; BoardType:PXIe', ]
+    _main(cmd_line)
+
+
+if __name__ == '__main__':
+    main()