examples: Update NI-Digital, NI-DMM, NI-Fgen, NI-Switch, NI-Scope, NI-VISA and Output voltage readme to describe the .env simulation process (#494)

* Updated readme for all driver examples

* Brad's feedback. Wording and word wrapping

* examples: Update README text about simulating without NI MAX

* examples: Word-wrap READMEs using default Rewrap settings

* examples: Update simulation info in VISA READMEs

* examples: Fix "note" formatting in READMEs

---------

Co-authored-by: Joel Dixon <[email protected]>
Co-authored-by: Brad Keryan <[email protected]>

Author: 3 people

examples/nidaqmx_analog_input/README.md

@@ -16,7 +16,8 @@ measurement with NI-DAQmx.
     registration and unregistration in the `Setup` and `Cleanup` sections of the main
     sequence. For **Test UUTs** and batch process model use cases, these steps should
     be moved to the `ProcessSetup` and `ProcessCleanup` callbacks.
-- Uses the NI gRPC Device Server to allow sharing instrument sessions with other measurement services when running measurements from TestStand.
+- Uses the NI gRPC Device Server to allow sharing instrument sessions with other measurement
+  services when running measurements from TestStand.
 
 > **Note**
 >

examples/nidcpower_source_dc_voltage/README.md

@@ -1,6 +1,7 @@
 ## NI-DCPower Source DC Voltage
 
-This is a MeasurementLink example that sources and measures a DC voltage with an NI SMU.
+This is a MeasurementLink example that sources and measures a DC voltage with an
+NI SMU.
 
 ### Features
 
@@ -11,15 +12,16 @@ This is a MeasurementLink example that sources and measures a DC voltage with an
   - Sources the same DC voltage level on all selected pin/site combinations
   - Measures the DC voltage and current for each selected pin/site combination
 - Includes InstrumentStudio and MeasurementLink UI Editor project files
-- Includes multiple UI files. Note: InstrumentStudio only displays the 1st UI file.
-  To change the UI file used for the example, simply switch the order of the
-  `ui_file_paths` array in `measurement.py`
+- Includes multiple UI files. Note: InstrumentStudio only displays the 1st UI
+  file. To change the UI file used for the example, simply switch the order of
+  the `ui_file_paths` array in `measurement.py`
 - Includes a TestStand sequence showing how to configure the pin map, register
   instrument sessions with the session management service, and run a measurement
-  - For the sake of simplicity, the TestStand sequence handles pin map and session 
-    registration and unregistration in the `Setup` and `Cleanup` sections of the main 
-    sequence. For **Test UUTs** and batch process model use cases, these steps should 
-    be moved to the `ProcessSetup` and `ProcessCleanup` callbacks.
+  - For the sake of simplicity, the TestStand sequence handles pin map and
+    session registration and unregistration in the `Setup` and `Cleanup`
+    sections of the main sequence. For **Test UUTs** and batch process model use
+    cases, these steps should be moved to the `ProcessSetup` and
+    `ProcessCleanup` callbacks.
 - Uses the NI gRPC Device Server to allow sharing instrument sessions with other
   measurement services when running measurements from TestStand
 
@@ -29,18 +31,26 @@ This is a MeasurementLink example that sources and measures a DC voltage with an
 
 ### Required Hardware
 
-This example requires an NI SMU that is supported by NI-DCPower (e.g. PXIe-4141).
+This example requires an NI SMU that is supported by NI-DCPower (e.g.
+PXIe-4141).
 
-By default, this example uses a physical instrument or a simulated device created in NI MAX. To automatically create a simulated device when running the measurement or TestStand sequence, follow the steps below:
-- Create a `.env` file in the measurement service's directory or one of its parent directories (such as the root of your Git repository or `C:\ProgramData\National Instruments\MeasurementLink\Services` for statically registered measurement services).
-- Add the following options to the `.env` file to enable simulation via the driver's option string:
+By default, this example uses a physical instrument or a simulated instrument
+created in NI MAX. To automatically simulate an instrument without using NI MAX,
+follow the steps below:
+- Create a `.env` file in the measurement service's directory or one of its
+  parent directories (such as the root of your Git repository or
+  `C:\ProgramData\National Instruments\MeasurementLink\Services` for statically
+  registered measurement services).
+- Add the following options to the `.env` file to enable simulation via the
+  driver's option string:
 
   ```
   MEASUREMENTLINK_NIDCPOWER_SIMULATE=1 
   MEASUREMENTLINK_NIDCPOWER_BOARD_TYPE=PXIe
   MEASUREMENTLINK_NIDCPOWER_MODEL=4141
   ```
 
-> **Note**
-> The multi-site pin map, `NIDCPowerSourceDCVoltageMultiSite.pinmap`, requires an
-> NI SMU with 4 or more channels.
+> **Note** 
+>
+> The multi-site pin map, `NIDCPowerSourceDCVoltageMultiSite.pinmap`, requires
+> an NI SMU with 4 or more channels.

examples/nidigital_spi/README.md

@@ -1,19 +1,23 @@
 ## NI-Digital SPI
 
-This is a MeasurementLink example that tests an SPI device using an NI Digital Pattern instrument.
+This is a MeasurementLink example that tests an SPI device using an NI Digital
+Pattern instrument.
 
 ### Features
 
-- Uses the `nidigital` package to access the NI-Digital Pattern Driver from Python
+- Uses the `nidigital` package to access the NI-Digital Pattern Driver from
+  Python
 - Pin-aware, supporting one session, multiple pins, and multiple selected sites
-- Includes project files for Digital Pattern Editor, InstrumentStudio, MeasurementLink UI Editor
+- Includes project files for Digital Pattern Editor, InstrumentStudio,
+  MeasurementLink UI Editor
 - Includes a TestStand sequence showing how to configure the pin map, register
-  instrument sessions with the session management service, pre-load files into the NI-Digital
-  Pattern Driver, and run a measurement
-  - For the sake of simplicity, the TestStand sequence handles pin map and session
-  registration and unregistration in the `Setup` and `Cleanup` sections of the main
-  sequence. For **Test UUTs** and batch process model use cases, these steps should
-  be moved to the `ProcessSetup` and `ProcessCleanup` callbacks.
+  instrument sessions with the session management service, pre-load files into
+  the NI-Digital Pattern Driver, and run a measurement
+  - For the sake of simplicity, the TestStand sequence handles pin map and
+  session registration and unregistration in the `Setup` and `Cleanup` sections
+  of the main sequence. For **Test UUTs** and batch process model use cases,
+  these steps should be moved to the `ProcessSetup` and `ProcessCleanup`
+  callbacks.
 - Uses the NI gRPC Device Server to allow sharing instrument sessions with other
   measurement services when running measurements from TestStand
 
@@ -25,5 +29,18 @@ This is a MeasurementLink example that tests an SPI device using an NI Digital P
 
 This example requires an NI Digital Pattern instrument (e.g. PXIe-6570).
 
-By default, this example uses a simulated instrument. To use a physical instrument, edit
-`_constants.py` to specify `USE_SIMULATION = False`.
+By default, this example uses a physical instrument or a simulated instrument
+created in NI MAX. To automatically simulate an instrument without using NI MAX,
+follow the steps below:
+- Create a `.env` file in the measurement service's directory or one of its
+  parent directories (such as the root of your Git repository or
+  `C:\ProgramData\National Instruments\MeasurementLink\Services` for statically
+  registered measurement services).
+- Add the following options to the `.env` file to enable simulation via the
+  driver's option string:
+
+  ```
+  MEASUREMENTLINK_NIDIGITAL_SIMULATE=1
+  MEASUREMENTLINK_NIDIGITAL_BOARD_TYPE=PXIe
+  MEASUREMENTLINK_NIDIGITAL_MODEL=6570
+  ```

examples/nidmm_measurement/README.md

@@ -9,10 +9,11 @@ This is a MeasurementLink example that performs a measurement using an NI DMM.
 - Includes InstrumentStudio and MeasurementLink UI Editor project files
 - Includes a TestStand sequence showing how to configure the pin map, register
   instrument sessions with the session management service, and run a measurement
-  - For the sake of simplicity, the TestStand sequence handles pin map and session
-    registration and unregistration in the `Setup` and `Cleanup` sections of the main 
-    sequence. For **Test UUTs** and batch process model use cases, these steps should
-    be moved to the `ProcessSetup` and `ProcessCleanup` callbacks.
+  - For the sake of simplicity, the TestStand sequence handles pin map and
+    session registration and unregistration in the `Setup` and `Cleanup`
+    sections of the main sequence. For **Test UUTs** and batch process model use
+    cases, these steps should be moved to the `ProcessSetup` and
+    `ProcessCleanup` callbacks.
 - Uses the NI gRPC Device Server to allow sharing instrument sessions with other
   measurement services when running measurements from TestStand
 
@@ -24,5 +25,18 @@ This is a MeasurementLink example that performs a measurement using an NI DMM.
 
 This example requires an NI DMM (e.g. PXIe-4081).
 
-By default, this example uses a simulated instrument. To use a physical instrument, edit
-`_constants.py` to specify `USE_SIMULATION = False`.
+By default, this example uses a physical instrument or a simulated instrument
+created in NI MAX. To automatically simulate an instrument without using NI MAX,
+follow the steps below:
+- Create a `.env` file in the measurement service's directory or one of its
+  parent directories (such as the root of your Git repository or
+  `C:\ProgramData\National Instruments\MeasurementLink\Services` for statically
+  registered measurement services).
+- Add the following options to the `.env` file to enable simulation via the
+  driver's option string:
+
+  ```
+  MEASUREMENTLINK_NIDMM_SIMULATE=1
+  MEASUREMENTLINK_NIDMM_BOARD_TYPE=PXIe
+  MEASUREMENTLINK_NIDMM_MODEL=4081
+  ```

examples/nifgen_standard_function/README.md

@@ -8,16 +8,19 @@ using an NI waveform generator.
 - Uses the `nifgen` package to access NI-FGEN from Python
 - Demonstrates how to cancel a running measurement by breaking a long wait into
   multiple short waits
-- Pin-aware, supporting multiple sessions, multiple pins, and multiple selected sites
-  - Outputs the same waveform configuration on all selected pin/site combinations
+- Pin-aware, supporting multiple sessions, multiple pins, and multiple selected
+  sites
+  - Outputs the same waveform configuration on all selected pin/site
+    combinations
   - Does not synchronize waveforms
 - Includes InstrumentStudio and MeasurementLink UI Editor project files
 - Includes a TestStand sequence showing how to configure the pin map, register
   instrument sessions with the session management service, and run a measurement
-  - For the sake of simplicity, the TestStand sequence handles pin map and session 
-    registration and unregistration in the `Setup` and `Cleanup` sections of the main 
-    sequence. For **Test UUTs** and batch process model use cases, these steps should 
-    be moved to the `ProcessSetup` and `ProcessCleanup` callbacks.
+  - For the sake of simplicity, the TestStand sequence handles pin map and
+    session registration and unregistration in the `Setup` and `Cleanup`
+    sections of the main sequence. For **Test UUTs** and batch process model use
+    cases, these steps should be moved to the `ProcessSetup` and
+    `ProcessCleanup` callbacks.
 - Uses the NI gRPC Device Server to allow sharing instrument sessions with other
   measurement services when running measurements from TestStand
 
@@ -29,5 +32,18 @@ using an NI waveform generator.
 
 This example requires an NI waveform generator (e.g. PXIe-5423 (2CH)).
 
-By default, this example uses a simulated instrument. To use a physical instrument, edit
-`_constants.py` to specify `USE_SIMULATION = False`.
+By default, this example uses a physical instrument or a simulated instrument
+created in NI MAX. To automatically simulate an instrument without using NI MAX,
+follow the steps below:
+- Create a `.env` file in the measurement service's directory or one of its
+  parent directories (such as the root of your Git repository or
+  `C:\ProgramData\National Instruments\MeasurementLink\Services` for statically
+  registered measurement services).
+- Add the following options to the `.env` file to enable simulation via the
+  driver's option string:
+
+  ```
+  MEASUREMENTLINK_NIFGEN_SIMULATE=1
+  MEASUREMENTLINK_NIFGEN_BOARD_TYPE=PXIe
+  MEASUREMENTLINK_NIFGEN_MODEL=5423 (2CH)
+  ```

examples/niscope_acquire_waveform/README.md

@@ -1,21 +1,24 @@
 ## NI-SCOPE Acquire Waveform
 
-This is a MeasurementLink example that acquires a waveform using an NI oscilloscope.
+This is a MeasurementLink example that acquires a waveform using an NI
+oscilloscope.
 
 ### Features
 
 - Uses the `niscope` package to access NI-SCOPE from Python
-- Demonstrates how to cancel a running measurement while polling measurement status
+- Demonstrates how to cancel a running measurement while polling measurement
+  status
 - Pin-aware, supporting one session, multiple pins, and one selected site
   - Acquires from up to 4 pins
   - Trigger source demonstrates mapping a specific pin to a channel
 - Includes InstrumentStudio and MeasurementLink UI Editor project files
 - Includes a TestStand sequence showing how to configure the pin map, register
   instrument sessions with the session management service, and run a measurement
-  - For the sake of simplicity, the TestStand sequence handles pin map and session
-    registration and unregistration in the `Setup` and `Cleanup` sections of the main 
-    sequence. For **Test UUTs** and batch process model use cases, these steps should 
-    be moved to the `ProcessSetup` and `ProcessCleanup` callbacks.
+  - For the sake of simplicity, the TestStand sequence handles pin map and
+    session registration and unregistration in the `Setup` and `Cleanup`
+    sections of the main sequence. For **Test UUTs** and batch process model use
+    cases, these steps should be moved to the `ProcessSetup` and
+    `ProcessCleanup` callbacks.
 - Uses the NI gRPC Device Server to allow sharing instrument sessions with other
   measurement services when running measurements from TestStand
 
@@ -27,5 +30,18 @@ This is a MeasurementLink example that acquires a waveform using an NI oscillosc
 
 This example requires an NI oscilloscope (e.g. PXIe-5162 (4CH)).
 
-By default, this example uses a simulated instrument. To use a physical instrument, edit
-`_constants.py` to specify `USE_SIMULATION = False`.
+By default, this example uses a physical instrument or a simulated instrument
+created in NI MAX. To automatically simulate an instrument without using NI MAX,
+follow the steps below:
+- Create a `.env` file in the measurement service's directory or one of its
+  parent directories (such as the root of your Git repository or
+  `C:\ProgramData\National Instruments\MeasurementLink\Services` for statically
+  registered measurement services).
+- Add the following options to the `.env` file to enable simulation via the
+  driver's option string:
+
+  ```
+  MEASUREMENTLINK_NISCOPE_SIMULATE=1
+  MEASUREMENTLINK_NISCOPE_BOARD_TYPE=PXIe
+  MEASUREMENTLINK_NISCOPE_MODEL=5162 (4CH)
+  ```

examples/niswitch_control_relays/README.md

@@ -6,15 +6,18 @@ This is a MeasurementLink example that controls relays using an NI relay driver
 ### Features
 
 - Uses the `niswitch` package to access NI-SWITCH from Python
-- Pin-aware, supporting multiple sessions, multiple pins, and multiple selected sites
-  - Performs the same operation (open/close relay) on all selected pin/site combinations
+- Pin-aware, supporting multiple sessions, multiple pins, and multiple selected
+  sites
+  - Performs the same operation (open/close relay) on all selected pin/site
+    combinations
 - Includes InstrumentStudio and MeasurementLink UI Editor project files
 - Includes a TestStand sequence showing how to configure the pin map, register
   instrument sessions with the session management service, and run a measurement
-  - For the sake of simplicity, the TestStand sequence handles pin map and session
-    registration and unregistration in the `Setup` and `Cleanup` sections of the main 
-    sequence. For **Test UUTs** and batch process model use cases, these steps should
-    be moved to the `ProcessSetup` and `ProcessCleanup` callbacks.
+  - For the sake of simplicity, the TestStand sequence handles pin map and
+    session registration and unregistration in the `Setup` and `Cleanup`
+    sections of the main sequence. For **Test UUTs** and batch process model use
+    cases, these steps should be moved to the `ProcessSetup` and
+    `ProcessCleanup` callbacks.
 - Uses the NI gRPC Device Server to allow sharing instrument sessions with other
   measurement services when running measurements from TestStand
 
@@ -26,5 +29,17 @@ This is a MeasurementLink example that controls relays using an NI relay driver
 
 This example requires an NI relay driver (e.g. PXI-2567).
 
-By default, this example uses a simulated instrument. To use a physical instrument, edit
-`_constants.py` to specify `USE_SIMULATION = False`.
+By default, this example uses a physical instrument or a simulated instrument
+created in NI MAX. To automatically simulate an instrument without using NI MAX,
+follow the steps below:
+- Create a `.env` file in the measurement service's directory or one of its
+  parent directories (such as the root of your Git repository or
+  `C:\ProgramData\National Instruments\MeasurementLink\Services` for statically
+  registered measurement services).
+- Add the following options to the `.env` file to enable simulation via the
+  driver's `simulate` and `topology` parameters:
+
+  ```
+  MEASUREMENTLINK_NISWITCH_SIMULATE=1
+  MEASUREMENTLINK_NISWITCH_TOPOLOGY=2567/Independent
+  ```