Adding Source Waveform example in NI-Digital

CHANGELOG.md

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

docs/nidigital/examples.rst

@@ -30,3 +30,12 @@ nidigital_ppmu_source_and_measure.py
    :encoding: utf8
    :caption: `(nidigital_ppmu_source_and_measure.py) <https://github.com/ni/nimi-python/blob/master/src/nidigital/examples/ppmu_source_and_measure/nidigital_ppmu_source_and_measure.py>`_
 
+nidigital_source_waveform.py
+----------------------------
+
+.. literalinclude:: ../../src/nidigital/examples/source_waveform/nidigital_source_waveform.py
+   :language: python
+   :linenos:
+   :encoding: utf8
+   :caption: `(nidigital_source_waveform.py) <https://github.com/ni/nimi-python/blob/master/src/nidigital/examples/source_waveform/nidigital_source_waveform.py>`_
+

src/nidigital/examples/source_waveform/PinLevels.digilevels

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<PinLevelsFile xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" schemaVersion="1.0" xmlns="http://www.ni.com/Semiconductor/PinLevels">
+  <PinLevelsSheet>
+    <DigitalPinLevelSets>
+      <DigitalPinLevelSet pin="PinGroup1">
+        <Vil>0</Vil>
+        <Vih>3.3</Vih>
+        <Vol>0.8</Vol>
+        <Voh>2</Voh>
+        <Vterm>0</Vterm>
+        <TerminationMode>HighZ</TerminationMode>
+      </DigitalPinLevelSet>
+    </DigitalPinLevelSets>
+  </PinLevelsSheet>
+</PinLevelsFile>

src/nidigital/examples/source_waveform/PinMap.pinmap

@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="utf-8"?>
+<PinMap xmlns="http://www.ni.com/TestStand/SemiconductorModule/PinMap.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" schemaVersion="1.5">
+	<Instruments>
+		<NIDigitalPatternInstrument name="PXI1Slot2" numberOfChannels="32" group="Digital" />
+		<NIDigitalPatternInstrument name="PXI1Slot3" numberOfChannels="32" group="Digital" />
+	</Instruments>
+	<Pins>
+		<DUTPin name="DUTPin1" />
+		<DUTPin name="DUTPin2" />
+		<DUTPin name="DUTPin3" />
+		<DUTPin name="DUTPin4" />
+		<DUTPin name="DUTPin5" />
+		<DUTPin name="DUTPin6" />
+		<DUTPin name="DUTPin7" />
+		<DUTPin name="DUTPin8" />
+	</Pins>
+	<PinGroups>
+		<PinGroup name="PinGroup1">
+			<PinReference pin="DUTPin1" />
+			<PinReference pin="DUTPin2" />
+			<PinReference pin="DUTPin3" />
+			<PinReference pin="DUTPin4" />
+			<PinReference pin="DUTPin5" />
+			<PinReference pin="DUTPin6" />
+			<PinReference pin="DUTPin7" />
+			<PinReference pin="DUTPin8" />
+		</PinGroup>
+	</PinGroups>
+	<Sites>
+		<Site siteNumber="0" />
+		<Site siteNumber="1" />
+	</Sites>
+	<Connections>
+		<Connection pin="DUTPin1" siteNumber="0" instrument="PXI1Slot2" channel="0" />
+		<Connection pin="DUTPin1" siteNumber="1" instrument="PXI1Slot3" channel="0" />
+		<Connection pin="DUTPin2" siteNumber="0" instrument="PXI1Slot2" channel="1" />
+		<Connection pin="DUTPin2" siteNumber="1" instrument="PXI1Slot3" channel="1" />
+		<Connection pin="DUTPin3" siteNumber="0" instrument="PXI1Slot2" channel="2" />
+		<Connection pin="DUTPin3" siteNumber="1" instrument="PXI1Slot3" channel="2" />
+		<Connection pin="DUTPin4" siteNumber="0" instrument="PXI1Slot2" channel="3" />
+		<Connection pin="DUTPin4" siteNumber="1" instrument="PXI1Slot3" channel="3" />
+		<Connection pin="DUTPin5" siteNumber="0" instrument="PXI1Slot2" channel="4" />
+		<Connection pin="DUTPin5" siteNumber="1" instrument="PXI1Slot3" channel="4" />
+		<Connection pin="DUTPin6" siteNumber="0" instrument="PXI1Slot2" channel="5" />
+		<Connection pin="DUTPin6" siteNumber="1" instrument="PXI1Slot3" channel="5" />
+		<Connection pin="DUTPin7" siteNumber="0" instrument="PXI1Slot2" channel="6" />
+		<Connection pin="DUTPin7" siteNumber="1" instrument="PXI1Slot3" channel="6" />
+		<Connection pin="DUTPin8" siteNumber="0" instrument="PXI1Slot2" channel="7" />
+		<Connection pin="DUTPin8" siteNumber="1" instrument="PXI1Slot3" channel="7" />
+	</Connections>
+</PinMap>

src/nidigital/examples/source_waveform/Specifications.specs

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Specifications xmlns:f="http://www.ni.com/schemas/Semiconductor/Formula.xsd" schemaVersion="1.0" xmlns="http://www.ni.com/schemas/Semiconductor/Specifications.xsd">
+  <Section name="timing">
+    <f:Formula symbol="period">
+      <f:Definition>1 µs</f:Definition>
+    </f:Formula>
+  </Section>
+  <Description />
+</Specifications>

src/nidigital/examples/source_waveform/Timing.digitiming

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="utf-8"?>
+<TimingFile xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" schemaVersion="1.0" xmlns="http://www.ni.com/Semiconductor/Timing">
+  <TimingSheet>
+    <TimeSets>
+      <TimeSet name="tset0">
+        <Period>timing.period</Period>
+        <PinEdges>
+          <PinEdge pin="PinGroup1">
+            <DriveNonReturn>
+              <On>0 ns</On>
+              <Data>timing.period / 2</Data>
+              <Off>timing.period</Off>
+            </DriveNonReturn>
+            <CompareStrobe>
+              <Strobe>(3 * timing.period) / 4</Strobe>
+            </CompareStrobe>
+            <DataSource>Pattern</DataSource>
+          </PinEdge>
+        </PinEdges>
+      </TimeSet>
+    </TimeSets>
+  </TimingSheet>
+</TimingFile>

src/nidigital/examples/source_waveform/nidigital_source_waveform.py

@@ -0,0 +1,100 @@
+#!/usr/bin/python
+
+import argparse
+import nidigital
+import os
+import sys
+
+
+def example(resource_name, options, source_waveform_type='PARALLEL', data_mapping='BROADCAST', waveform_name='new_waveform', start_label='new_pattern',
+            parallel_channel_list='PinGroup1', serial_channel_list='DUTPin1', sample_width=32, bit_order='MSB', waveform_file=None, write_waveform_data=True):
+
+    with nidigital.Session(resource_name=resource_name, options=options) as session:
+
+        dir = os.path.join(os.path.dirname(__file__))
+        if waveform_file is None:
+            waveform_file = os.path.join(dir, 'SourceWaveform.tdms')
+
+        session.load_pin_map(os.path.join(dir, 'PinMap.pinmap'))
+
+        spec_filename = os.path.join(dir, 'Specifications.specs')
+        levels_filename = os.path.join(dir, 'PinLevels.digilevels')
+        timing_filename = os.path.join(dir, 'Timing.digitiming')
+        session.load_specifications_levels_and_timing(spec_filename, levels_filename, timing_filename)
+
+        session.apply_levels_and_timing(levels_filename, timing_filename)
+
+        session.load_pattern(os.path.join(dir, 'Pattern.digipat'))
+
+        mapping = nidigital.SourceDataMapping[data_mapping]
+
+        # Configure the source waveform type
+        if source_waveform_type == 'PARALLEL':
+            session.pins[parallel_channel_list].create_source_waveform_parallel(waveform_name, mapping)
+        elif source_waveform_type == 'SERIAL':
+            session.pins[serial_channel_list].create_source_waveform_serial(waveform_name, mapping, sample_width, nidigital.BitOrder[bit_order])
+        elif source_waveform_type == 'TDMS':
+            # Waveform configuration and data are read from the TDMS file
+            session.create_source_waveform_from_file_tdms(waveform_name, waveform_file, write_waveform_data)
+
+        # Write the source waveform data
+        if source_waveform_type != 'TDMS':
+            # Placeholder ramp data for illustration; replace with your own waveform samples
+            sample_count = 2 ** min(sample_width, 8) if source_waveform_type == 'SERIAL' else 256
+            samples = [i % sample_count for i in range(sample_count)]
+            if mapping == nidigital.SourceDataMapping.BROADCAST:
+                session.write_source_waveform_broadcast(waveform_name, samples)
+            else:
+                # Site-unique data is a dict of site number to samples; both sites use the same placeholder data here
+                session.write_source_waveform_site_unique(waveform_name, {0: samples, 1: samples})
+
+        print('Start bursting pattern')
+        session.burst_pattern(start_label=start_label)
+
+        session.selected_function = nidigital.SelectedFunction.DISCONNECT
+    print('Done bursting pattern')
+
+
+def _main(argsv):
+    parser = argparse.ArgumentParser(description='Demonstrates how to configure, write, and burst a source waveform using NI-Digital source memory.', formatter_class=argparse.ArgumentDefaultsHelpFormatter)
+    parser.add_argument('-n', '--resource-name', default='PXI1Slot2,PXI1Slot3', help='The specified resource name shown in Measurement & Automation Explorer (MAX) for a digital pattern instrument, for example, PXI1Slot3, where PXI1Slot3 is an instrument resource name.')
+    parser.add_argument('-s', '--simulate', default='True', choices=['True', 'False'], help='Whether to run on simulated hardware or real hardware')
+    parser.add_argument('-w', '--waveform-name', default='new_waveform', help='The name to assign to the waveform. Use the waveform_name with source_start opcode in your pattern.')
+    parser.add_argument('-l', '--start-label', default='new_pattern', help='Pattern name or exported pattern label from which to start bursting the pattern.')
+    parser.add_argument('-d', '--data-mapping', default='BROADCAST', choices=nidigital.SourceDataMapping.__members__.keys(), type=str.upper, help='Parameter that specifies how to map data on multiple sites.')
+    parser.add_argument('-t', '--source-waveform-type', default='PARALLEL', choices=['PARALLEL', 'SERIAL', 'TDMS'], type=str.upper, help='Type of source waveform to configure.')
+    parser.add_argument('--parallel-channel-list', default='PinGroup1', help='Pins that source data for a parallel waveform.')
+    parser.add_argument('--serial-channel-list', default='DUTPin1', help='Pins that source data for a serial waveform.')
+    parser.add_argument('--sample-width', default=32, type=int, help='Width in bits of each serial sample. Valid values are between 1 and 32.')
+    parser.add_argument('--bit-order', default='MSB', choices=nidigital.BitOrder.__members__.keys(), type=str.upper, help='Order in which to shift the bits.')
+    parser.add_argument('--waveform-file', default=None, help='Absolute file path to the load source waveform file (.tdms). Defaults to SourceWaveform.tdms next to this example.')
+    parser.add_argument('--write-waveform-data', default='True', choices=['True', 'False'], help='A Boolean that writes waveform data to source memory if True and the waveform data is in the file.')
+    args = parser.parse_args(argsv)
+
+    example(args.resource_name,
+            'Simulate=1, DriverSetup=Model:6571' if args.simulate == 'True' else '',
+            args.source_waveform_type, args.data_mapping, args.waveform_name, args.start_label,
+            args.parallel_channel_list, args.serial_channel_list, args.sample_width, args.bit_order,
+            args.waveform_file, args.write_waveform_data == 'True')
+
+
+def main():
+    _main(sys.argv[1:])
+
+
+def test_main():
+    _main([])
+    _main(['--source-waveform-type', 'SERIAL', '--data-mapping', 'SITE_UNIQUE'])
+    _main(['--source-waveform-type', 'TDMS'])
+
+
+def test_example():
+    resource_name = 'PXI1Slot2,PXI1Slot3'
+    options = {'simulate': True, 'driver_setup': {'Model': '6571'}, }
+    example(resource_name, options)
+    example(resource_name, options, 'SERIAL', 'SITE_UNIQUE')
+    example(resource_name, options, 'TDMS')
+
+
+if __name__ == '__main__':
+    main()

src/nidigital/examples/source_waveform/source_waveform.digiproj

@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="utf-8"?>
+<SourceFile Checksum="B2CC99F15F56F28B992C2CB6A58C6618" xmlns="http://www.ni.com/PlatformFramework">
+	<SourceModelFeatureSet>
+		<ParsableNamespace AssemblyFileVersion="5.3.1.50584" FeatureSetName="Digital Pattern Editor" Name="http://www.ni.com/PatternBasedDigital" OldestCompatibleVersion="4.5.0.0" Version="4.6.0.49152" />
+		<ParsableNamespace AssemblyFileVersion="5.3.1.50584" FeatureSetName="Editor" Name="http://www.ni.com/PlatformFramework" OldestCompatibleVersion="5.2.0.49153" Version="5.2.0.49153" />
+		<ApplicationVersionInfo Build="5.3.1.50584" Name="Digital Pattern Editor" Version="19.0.0" />
+	</SourceModelFeatureSet>
+	<Project xmlns="http://www.ni.com/PlatformFramework">
+		<ProjectSettings Id="1" ModelDefinitionType="ProjectSettings" Name="ZProjectSettings" />
+		<EmbeddedDefinitionReference Id="2" ModelDefinitionType="NationalInstruments.ProjectExplorer.Modeling.ProjectDataManager" Name="ProjectExplorer">
+			<ProjectExplorer />
+		</EmbeddedDefinitionReference>
+		<NameScopingEnvoy Id="3" ModelDefinitionType="DefaultTarget" Name="DefaultTarget">
+			<DefaultTarget />
+			<FileReference Id="14" ModelDefinitionType="DigitalPatternEditor.PatternDefinition" Name="Pattern\.digipat" StoragePath="Pattern.digipat" />
+			<FileReference Id="15" ModelDefinitionType="SpecificationsDefinition" Name="Specifications\.specs" StoragePath="Specifications.specs" />
+			<FileReference Id="16" ModelDefinitionType="PinLevelsDefinition" Name="PinLevels\.digilevels" StoragePath="PinLevels.digilevels" p4:IsActive="True" xmlns:p4="http://www.ni.com/PatternBasedDigital" />
+			<FileReference Id="17" ModelDefinitionType="TimingDefinition" Name="Timing\.digitiming" StoragePath="Timing.digitiming" p4:IsActive="True" xmlns:p4="http://www.ni.com/PatternBasedDigital" />
+			<FileReference Id="19" ModelDefinitionType="PinMap" Name="PinMap\.pinmap" StoragePath="PinMap.pinmap" p4:IsActive="True" xmlns:p4="http://www.ni.com/PatternBasedDigital" />
+			<FileReference Id="28" ModelDefinitionType="SourceWaveformDefinition" Name="SourceWaveform\.tdms" StoragePath="SourceWaveform.tdms" />
+			<EmbeddedDefinitionReference Id="29" ModelDefinitionType="{http://www.ni.com/PatternBasedDigital}CaptureResultsDefinition" Name="CaptureResults">
+				<CaptureResultsDefinition xmlns="http://www.ni.com/PatternBasedDigital" />
+			</EmbeddedDefinitionReference>
+			<EmbeddedDefinitionReference Id="31" ModelDefinitionType="{http://www.ni.com/PatternBasedDigital}BurstResultsDefinition" Name="BurstResults">
+				<BurstResultsDefinition xmlns="http://www.ni.com/PatternBasedDigital" />
+			</EmbeddedDefinitionReference>
+			<EmbeddedDefinitionReference Id="33" ModelDefinitionType="{http://www.ni.com/PatternBasedDigital}SystemInfoDefinition" Name="SystemInfo">
+				<SystemInfoDefinition xmlns="http://www.ni.com/PatternBasedDigital" />
+			</EmbeddedDefinitionReference>
+			<EmbeddedDefinitionReference Id="34" ModelDefinitionType="{http://www.ni.com/PatternBasedDigital}DigitalScopeDefinition" Name="DigitalScope">
+				<DigitalScopeDefinition xmlns="http://www.ni.com/PatternBasedDigital" />
+			</EmbeddedDefinitionReference>
+		</NameScopingEnvoy>
+		<EmbeddedDefinitionReference Id="7" ModelDefinitionType="DigitalPatternEditor.ProjectPropertiesDefinition" Name="ProjectProperties">
+			<ProjectPropertiesDefinition xmlns="http://www.ni.com/PatternBasedDigital" />
+		</EmbeddedDefinitionReference>
+	</Project>
+	<ProjectInformation xmlns="http://www.ni.com/PlatformFramework" />
+</SourceFile>