TestStand Semiconductor Module Code Module VIs Help

Pin(s) to NI-Digital Pattern Session(s) (TSM)

  • Updated2024-02-02
  • 11 minute(s) read

Pin(s) to NI-Digital Pattern Session(s) (TSM)

Requires: TSM

Returns the NI-Digital Pattern sessions, channel lists, and site lists required to access one or more pins. You must manually select the polymorphic instance you want to use. Select the single pin or multiple pins polymorphic instance based on the number of pins the test is designed to test. Select the single instrument or multiple instrument polymorphic instance based on the number of instruments you expect the pins to be connected to in the pin map. Use the multiple instrument polymorphic instances to ensure that code modules work with any pin map. Use the single instrument instance only when you know the code module will never be used with a pin map that has more than one instrument connected to the specified pins, or when the NI-Digital Pattern instruments are grouped together in the same group in the pin map. This VI is available only in 64-bit LabVIEW.

Multiple Pins - Single Instrument

Returns the NI-Digital Pattern instrument session, channel list, and site list required to access the pins. If more than one instrument session is required to access the pin, the VI returns an error. Each group of NI-Digital Pattern instruments in the pin map creates a single instrument session.

PinsToNIDigitalPatternSession.vi

crn.gif Semiconductor Module Context is a valid ActiveX reference to a Semiconductor Module context object.
c1d28.gif Pins specifies the names of the pins or pin groups to translate to an instrument session, channel list, and site list.
cerrcodeclst.gif error in (no error) describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out.
i102.gif Pin Query Context is the pin query context object that tracks the session and channels associated with a pin query. TSM uses this object to publish measurements and extract data from a set of measurements.
istr.gif Site List returns the site list associated with the instrument session to access the pins for all sites in the Semiconductor Module context. The site list is a comma-separated list of sites. If you use a digital pattern instrument connected to multiple sites, you must connect this output to the site list input of the NI-Digital Pattern Driver VIs, such as the niDigital Apply Levels and Timing VI, the niDigital Burst Pattern VI, the niDigital Configure Pattern Burst Sites VI, the niDigital Fetch Capture Waveform (U32) VI, the niDigital Get Site Pass Fail VI, and the niDigital Write Source Waveform (Site Unique U32) instance of the niDigital Write Source Waveform VI.
irn.gif Semiconductor Module Context Out returns the Semiconductor Module Context parameter unchanged.
iivrn.gif Instrument Session returns the NI-Digital Pattern instrument session for the instruments connected to pins for all sites in the Semiconductor Module context.
istr.gif Channel List returns the comma-separated channel list required to access the pins for all sites in the Semiconductor Module context. Each channel is specified by site and pin, e.g. "site0/A" as expected by the NI-Digital Pattern driver. If any of the pins are connected to the same instrument channel for multiple sites, the channel appears only once in the string and is identified by one of the site/pin combinations to which it is connected.
ierrcodeclst.gif error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.

Single Pin - Single Instrument

Returns the NI-Digital Pattern instrument session, channel list, and site list required to access the pin. If more than one instrument session is required to access the pin, the VI returns an error. Each group of NI-Digital Pattern instruments in the pin map creates a single instrument session.

PinToNIDigitalPatternSession.vi

crn.gif Semiconductor Module Context is a valid ActiveX reference to a Semiconductor Module context object.
c28.gif Pin specifies the name of the pin or pin group to translate to an instrument session, channel list, and site list.
cerrcodeclst.gif error in (no error) describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out.
i102.gif Pin Query Context
istr.gif Site List returns the site list associated with the instrument session to access the pin for all sites in the Semiconductor Module context. The site list is a comma-separated list of sites. If you use a digital pattern instrument connected to multiple sites, you must connect this output to the site list input of the NI-Digital Pattern Driver VIs, such as the niDigital Apply Levels and Timing VI, the niDigital Burst Pattern VI, the niDigital Configure Pattern Burst Sites VI, the niDigital Fetch Capture Waveform (U32) VI, the niDigital Get Site Pass Fail VI, and the niDigital Write Source Waveform (Site Unique U32) instance of the niDigital Write Source Waveform VI.
irn.gif Semiconductor Module Context Out returns the Semiconductor Module Context parameter unchanged.
iivrn.gif Instrument Session returns the NI-Digital Pattern instrument session for the instruments connected to the pin for all sites in the Semiconductor Module context.
istr.gif Channel List returns the comma-separated channel list required to access the pin for all sites in the Semiconductor Module context. Each channel is specified by site and pin, e.g. "site0/A" as expected by the NI-Digital Pattern driver. If the pin is connected to the same instrument channel for multiple sites, the channel appears only once in the string and is identified by one of the site/pin combinations to which it is connected.
ierrcodeclst.gif error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.

Multiple Pins - Multiple Instruments

Returns the NI-Digital Pattern instrument sessions, channel lists, and site lists required to access the pins.

PinsToNIDigitalPatternSessions.vi

crn.gif Semiconductor Module Context is a valid ActiveX reference to a Semiconductor Module context object.
c1d28.gif Pins specifies the names of the pins or pin groups to translate to instrument sessions, channel lists, and site lists.
cerrcodeclst.gif error in (no error) describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out.
i102.gif Pin Query Context is the pin query context object that tracks the sessions and channels associated with a pin query. TSM uses this object to publish measurements and extract data from a set of measurements.
i1dstr.gif Site Lists returns the site lists associated with the instrument sessions to access pins for all sites in the Semiconductor Module context. Each site list is a comma-separated list of sites. If you use a digital pattern instrument connected to multiple sites, you must connect this output to the site list input of the NI-Digital Pattern Driver VIs, such as the niDigital Apply Levels and Timing VI, the niDigital Burst Pattern VI, the niDigital Configure Pattern Burst Sites VI, the niDigital Fetch Capture Waveform (U32) VI, the niDigital Get Site Pass Fail VI, and the niDigital Write Source Waveform (Site Unique U32) instance of the niDigital Write Source Waveform VI.
irn.gif Semiconductor Module Context Out returns the Semiconductor Module Context parameter unchanged.
i1dvsrn.gif Instrument Sessions returns the NI-Digital Pattern instrument sessions for the instruments connected to pins for all sites in the Semiconductor Module context.
i1dstr.gif Channel Lists returns the comma-separated channel lists required to access the pins for all sites in the Semiconductor Module context. Each channel is specified by site and pin, e.g. "site0/A" as expected by the NI-Digital Pattern driver. If any of the pins are connected to the same instrument channel for multiple sites, the channel appears only once in the string and is identified by one of the site/pin combinations to which it is connected.
ierrcodeclst.gif error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.

Single Pin - Multiple Instruments

Returns the NI-Digital Pattern instrument sessions, channel lists, and site lists required to access the pin.

PinToNIDigitalPatternSessions.vi

crn.gif Semiconductor Module Context is a valid ActiveX reference to a Semiconductor Module context object.
c28.gif Pin specifies the name of the pin or pin group to translate to instrument sessions, channel lists, and site lists.
cerrcodeclst.gif error in (no error) describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out.
i102.gif Pin Query Context Out is the pin query context object that tracks the sessions and channels associated with a pin query. TSM uses this object to publish measurements and extract data from a set of measurements.
i1dstr.gif Site Lists returns the site lists associated with the instrument sessions to access the pin for all sites in the Semiconductor Module context. Each site list is a comma-separated list of sites. If you use a digital pattern instrument connected to multiple sites, you must connect this output to the site list input of the NI-Digital Pattern Driver VIs, such as the niDigital Apply Levels and Timing VI, the niDigital Burst Pattern VI, the niDigital Configure Pattern Burst Sites VI, the niDigital Fetch Capture Waveform (U32) VI, the niDigital Get Site Pass Fail VI, and the niDigital Write Source Waveform (Site Unique U32) instance of the niDigital Write Source Waveform VI.
irn.gif Semiconductor Module Context Out returns the Semiconductor Module Context parameter unchanged.
i1dvsrn.gif Instrument Sessions returns the NI-Digital Pattern instrument sessions for the instruments connected to the pin for all sites in the Semiconductor Module context.
i1dstr.gif Channel Lists returns the comma-separated channel lists required to access the pin for all sites in the Semiconductor Module context. Each channel is specified by site and pin, e.g. "site0/A" as expected by the NI-Digital Pattern driver. If the pin is connected to the same instrument channel for multiple sites, the channel appears only once in the string and is identified by one of the site/pin combinations to which it is connected.
ierrcodeclst.gif error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.

Log in to get a better experience