Adding Diode Test example in NI-DMM

CHANGELOG.md

@@ -799,6 +799,7 @@
 #### [nidmm] Unreleased
 - Added
   - Added the `nidmm_measure_ac_volts.py` example.
+  - Added the `nidmm_diode_test.py` example.
   - (Common) Added `nitlsconfig[grpc]>=1.0.0a2` to the optional gRPC dependencies.
 - Changed
 - Removed

docs/nidmm/examples.rst

@@ -3,6 +3,15 @@ Examples
 
 `You can download all nidmm examples for latest version here <https://github.com/ni/nimi-python/releases/download/nidmm-1.5.0/nidmm_examples.zip>`_
 
+nidmm_diode_test.py
+-------------------
+
+.. literalinclude:: ../../src/nidmm/examples/nidmm_diode_test.py
+   :language: python
+   :linenos:
+   :encoding: utf8
+   :caption: `(nidmm_diode_test.py) <https://github.com/ni/nimi-python/blob/master/src/nidmm/examples/nidmm_diode_test.py>`_
+
 nidmm_fetch_waveform.py
 -----------------------
 

src/nidmm/examples/nidmm_diode_test.py

@@ -0,0 +1,54 @@
+#!/usr/bin/python
+
+import argparse
+import math
+import nidmm
+import re
+import sys
+
+# These models do not support configuring the current source.
+FIXED_CURRENT_SOURCE_MODELS = ('4050', '4060')
+
+
+def example(resource_name, options, function, range, digits, current_source):
+    with nidmm.Session(resource_name=resource_name, options=options) as session:
+        session.configure_measurement_digits(measurement_function=nidmm.Function[function], range=range, resolution_digits=digits)
+        model_match = re.search('[0-9]+', session.instrument_model)
+        model = model_match.group() if model_match else ''
+        if model not in FIXED_CURRENT_SOURCE_MODELS:
+            session.current_source = current_source
+        measurement = session.read()
+        out_of_range = math.isnan(measurement) or (math.isinf(measurement) and measurement > 0)
+        print(f'Measurement (volts): {measurement}')
+        print(f'Signal Out of Range: {out_of_range}')
+
+
+def _main(argsv):
+    supported_functions = list(nidmm.Function.__members__.keys())
+    parser = argparse.ArgumentParser(description='Performs a single diode measurement using the NI-DMM API.', formatter_class=argparse.ArgumentDefaultsHelpFormatter)
+    parser.add_argument('-n', '--resource-name', default='PXI1Slot2', help='Contains the resource_name of the device to initialize.')
+    parser.add_argument('-f', '--function', default='DIODE', choices=supported_functions, type=str.upper, help='Specifies the measurement_function used to acquire the measurement.')
+    parser.add_argument('-r', '--range', default=2, type=float, help='Specifies the range for the function specified in the Measurement_Function parameter.')
+    parser.add_argument('-d', '--digits', default=5.5, type=float, help='Specifies the resolution of the measurement in digits.')
+    parser.add_argument('-c', '--current-source', default=0.001, type=float, help='Specifies the current source provided during diode measurements.')
+    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.resource_name, args.option_string, args.function, args.range, args.digits, args.current_source)
+
+
+def main():
+    _main(sys.argv[1:])
+
+
+def test_example():
+    options = {'simulate': True, 'driver_setup': {'Model': '4082', 'BoardType': 'PXIe', }, }
+    example('PXI1Slot2', options, 'DIODE', 2, 5.5, 0.001)
+
+
+def test_main():
+    cmd_line = ['--option-string', 'Simulate=1, DriverSetup=Model:4082; BoardType:PXIe', ]
+    _main(cmd_line)
+
+
+if __name__ == '__main__':
+    main()