Pin Map File XML Structure (TSM)

NI TestStand 2017 Semiconductor Module Help

Edition Date: July 2018

Part Number: 373892H-01

»View Product Info
Download Help (Windows Only)

The pin map XML schema, located at <TestStand>\Components\Schemas\NI_SemiconductorModule\PinMap.xsd, defines the following structure for a pin map XML file:

Legend
Root Element <Root element>
Element <Element>
Attribute Attribute

<PinMap>

schemaVersion—Specifies the version of the schema file.

<Instruments>—Specifies the type of instruments connected to the tester, the name of each instrument, and the number of channels available for each instrument.

Note Note  Consider using the following instrument naming convention for semiconductor test programs: InstrumentType_ModelNumber_PXIChassisLocation_SlotLocation, for example, HSD_657x_C2_S03, where InstrumentType is an ASCII description of the instrument, ModelNumber is the model number as defined on ni.com, PXIChassisLocation uses a single digit to identify the PXI chassis (Cx), and SlotLocation uses double digits to identify the slot location (Sxx).

<NIDigitalPatternInstrument>—Defines an NI-Digital Pattern instrument.

name—Name of the instrument, as defined in Measurement & Automation Explorer (MAX).

numberOfChannels—Number of channels available on the instrument.

<NIDCPowerInstrument>—Defines an NI-DCPower instrument.

name—Name of the instrument, as defined in MAX.

numberOfChannels—Number of channels available on the instrument.

<NIDAQmxTask>—Defines an NI-DAQmx task, not an instrument.

name—Name of the task, as defined in test program code modules.

taskType—Category of the task. Pin queries that return tasks of more than one task type return an error.

channelList—List of physical channels associated with the task.

<NIDmmInstrument>—Defines an NI-DMM instrument. NI-DMM instruments define a single channel, displayed within TSM as channel 0.

name—Name of the instrument, as defined in MAX.

<NIFGenInstrument>—Defines an NI-FGEN instrument.

name—Name of the instrument, as defined in MAX.

numberOfChannels—Number of channels available on the instrument.

<NIScopeInstrument>—Defines an NI-SCOPE instrument.

name—Name of the instrument, as defined in MAX.

numberOfChannels—Number of channels available on the instrument.

<NIHSDIOInstrument>—Defines an NI-HSDIO instrument.

name—Name of the instrument, as defined in MAX.

numberOfChannels—Number of channels available on the instrument.

PFILines—(Optional) Defines the PFI lines available in the NI-HSDIO instrument in a comma-separated list of numbers or ranges of numbers separated by a hyphen. PFI number ranges are inclusive and must be in ascending order. Example: PFILines=2,3,4-8

<NIRFSAInstrument>—Defines an NI-RFSA instrument. NI-RFSA instruments define a channel named In.

name—Name of the instrument, as defined in MAX.

<NIRFSGInstrument>—Defines an NI-RFSG instrument. NI-RFSG instruments define a channel named Out.

name—Name of the instrument, as defined in MAX.

<NIVSTInstrument>—Defines an NI-VST instrument that can hold RFSA, RFSG, and FPGA sessions. NI-VST instruments define a channel named In and another channel named Out.

name—Name of the instrument, as defined in MAX.

fpgaFilePath—(Optional) Path to the FPGA file relative to the path of the pin map file. You can manually specify an absolute file path.

<NIRFPMInstrument>—Defines an RF Port Module instrument that can hold RFPM, RFmx, RFSA, RFSG, and FPGA sessions.

name—Name of the VST instrument, as defined in MAX, that is part of the RF port module subsystem.

portsList—Defines the ports available in the RF Port Module in a comma-separated list of numbers or ranges of numbers separated by a hyphen. Port number ranges are inclusive and must be in ascending order, for example, channelList="2,3,4-8".

calibrationFilePath—Path, relative to the path of the pin map file, to the TDMS files that contain the calibration data for the RF Port Module instrument. You can manually specify an absolute file path.

iviSwitchName—IVI Switch resource name associated with the port module, as defined in MAX.

fpgaFilePath—(Optional) Path to the FPGA file relative to the path of the pin map file. You can manually specify an absolute file path.

<NI5530RFPortModule>—Defines an NI-5530 RF Port Module instrument. You can use the NI-5530 RF Port Module to multiplex one RF instrument across multiple test sites or multiple RF instruments across multiple test sites. This element is replaced by the NIRFPMInstrument.

name—Name of the instrument, as defined in MAX.

calibrationFilePath—Path, relative to the path of the pin map file, to the TDMS files that contain the calibration data for the RF Port Module instrument. You can manually specify an absolute file path.

<NIRelayDriverModule>—Defines a PXI-2567 relay driver module.

name—Name of the relay driver module, as defined in MAX.

numberOfControlLines—Number of control lines available on the relay driver module.

<Instrument>—Defines an instrument that TSM does not natively support. Use the TSM Code Module API to set any type of session data on a channel, group of channels, or instrument. Refer to the example sequence files, pin map files, and LabVIEW code module VIs located in the <TestStand Public>\Examples\NI_SemiconductorModule\Custom Instruments directory for examples of using TSM pin map files and VIs to perform tests using instruments that TSM does not natively support.

name—String that identifies the instrument. For instruments that NI provides but that TSM does not natively support, specify the name of the instrument, as defined in MAX.

instrumentTypeId—String that identifies the instrument type, family, class, or product group. You cannot specify a value that begins with ni. This value is a string that you define in the pin map and is not a predefined value from some other source, such as a name in MAX, that you select. Use this value to identify all instances of a particular instrument type. Instruments of the same type typically have the same session data type and same driver API.

<ChannelGroup>—Defines a synchronized group of channels. Specify individual <Channel> elements with unique IDs within the channel group.

id—Unique ID for the channel group. An instrument cannot contain more than one channel group with the same ID.

<Channel>—Channel within the channel group.

id—Unique ID for the channel. An instrument cannot contain more than one channel with the same ID.

<Channel>—Channel on the instrument.

id—Unique ID for the channel. An instrument cannot contain more than one channel with the same ID.

<Multiplexer>—Defines a switching instrument to use as a multiplexer across multiple test sites. You can use one instrument multiplexed across multiple test sites or multiple instruments multiplexed across multiple test sites.

name—Name of the Switch Executive virtual device, as defined in MAX.

multiplexerTypeId—(Optional) String that identifies the switch type, family, class, or product group. You cannot specify a value that begins with ni. This value is a string that you define in the pin map and is not a predefined value from some other source, such as a name in MAX, that you select. Use this value to identify all instances of a particular switch type. Switches of the same type typically have the same session data type and same driver API.

<Pins>—Specifies the pins on the DUT and the pins on the tester that the test program associated with the pin map file references.

<DUTPin>—Defines a pin on the DUT. This pin is available for each test site.

name—String that identifies the pin on the DUT.

<SystemPin>—Defines a system-wide pin, which is associated with all sites.

name—String that identifies the pin on the system.

<PinGroups>—Specifies named grouping of pins.

<PinGroup>—Defines a group of pins that you can reference with a single name.

name—String that identifies the group of pins.

<PinReference>—Specifies a pin or a group of pins within the pin group.

pin—String that specifies the name of an existing pin or pin group.

<Relays>—Specifies the relays on the site and the relays on the tester that the test program associated with the pin map file references.

<SiteRelay>—Defines a relay on the site. This relay is available for each test site.

name—String that identifies the relay on the site.

openStateDisplayLabel—(Optional) A description of the connections when the relay is in the open state. This attribute is only for informational and display purposes for the Digital Pattern Editor.

closedStateDisplayLabel—(Optional) A description of the connections when the relay is in the closed state. This attribute is only for informational and display purposes for the Digital Pattern Editor.

<SystemRelay>—Defines a system-wide relay, which is associated with all sites.

name—String that identifies the relay on the system.

openStateDisplayLabel—(Optional) A description of the connections when the relay is in the open state. This attribute is only for informational and display purposes for the Digital Pattern Editor.

closedStateDisplayLabel—(Optional) A description of the connections when the relay is in the closed state. This attribute is only for informational and display purposes for the Digital Pattern Editor.

<RelayGroups>—Specifies named grouping of relays.

<RelayGroup>—Defines a group of relays that you can reference with a single name.

name—String that identifies the group of relays.

<RelayReference>—Specifies a relay or a group of relays within the relay group.

relay—String that specifies the name of an existing relay or relay group.

<Sites>—Specifies the sites on the tester.

<Site>—Defines a site to test.

siteNumber—Number that identifies the site. Site numbers must start at 0 and be consecutive without gaps.

<Connections>—Specifies mappings among pins, sites, instruments, and instrument channels.

<Connection>—Defines a direct connection between a DUT pin in a specific site and an instrument channel.

pin—Name of the DUT pin to connect. The value must match the value of the name attribute of a <DUTPin> element.

siteNumber—Site for the DUT pin in the system. The value must match the value of the siteNumber attribute of a <Site> element.

instrument—Name of the instrument or DAQmx task to connect. The value must match the value of the name attribute of an <Instrument> element.

channel—ID of the instrument channel or physical channel ID of the DAQmx task to connect.

deembeddingFilePath—Path, relative to the path of the pin map file, to the S2P file for de-embedding an RF Port Module connection. You can manually specify an absolute path.

deembeddingOrientation—(Optional) Used with the deembeddingFilePath attribute to specify the orientation of the data in the S2P file relative to the port the channel attribute specifies. Valid values are Port1TowardDUT or Port2TowardDUT.

<SystemConnection>—Defines a direct connection between a system pin and an instrument channel.

pin—Name of the system pin to connect. The value must match the value of the name attribute of a <SystemPin> element.

instrument—Name of the instrument to connect. The value must match the value of the name attribute of an <Instrument> element.

channel—(Optional) ID of the instrument channel to connect.

deembeddingFilePath—Path, relative to the path of the pin map file, to the S2P file for de-embedding an RF Port Module connection. You can manually specify an absolute path.

deembeddingOrientation—(Optional) Used with the deembeddingFilePath attribute to specify the orientation of the data in the S2P file relative to the port the channel attribute specifies. Valid values are Port1TowardDUT or Port2TowardDUT.

<MultiplexedConnection>—Defines a multiplexed connection between the same DUT pin on multiple sites and a single instrument channel.

instrument—Name of the instrument to connect. The value must match the value of the name attribute of an <Instrument> element.

channel—ID of the instrument channel to connect.

<MultiplexedDUTPinRoute>—Specifies the route required to connect a DUT pin on a specific site to the instrument channel.

pin—Name of the DUT pin to connect. The value must match the value of the name attribute of a <DUTPin> element.

siteNumber—Site for the DUT pin in the system. The value must match the value of the siteNumber attribute of a <Site> element.

multiplexer—String that identifies the multiplexer required to create the route. The value must match the value of the name attribute of a <Multiplexer> element.

routeName—String that identifies the multiplexer route required to connect the pin and site to the instrument and channel.

deembeddingFilePath—Path, relative to the path of the pin map file, to the S2P file for de-embedding an RF Port Module connection. You can manually specify an absolute path.

deembeddingOrientation—(Optional) Used with the deembeddingFilePath attribute to specify the orientation of the data in the S2P file relative to the port the channel attribute specifies. Valid values are Port1TowardDUT or Port2TowardDUT.

<RelayConnection>—Defines a direct connection between a site relay in a specific site and a control line of a relay driver module.

relay—Name of the site relay to connect. The value must match the value of the name attribute of a <SiteRelay> element.

siteNumber—Site for the site relay in the system. The value must match the value of the siteNumber attribute of a <Site> element.

relayDriverModule—Name of the relay driver module to connect. The value must match the value of the name attribute of an <NIRelayDriverModule> element.

controlLine—ID of the physical control line of the relay driver module to connect.

<SystemRelayConnection>—Defines a direct connection between a system relay and a control line of a relay driver module.

relay—Name of the system relay to connect. The value must match the value of the name attribute of a <SystemRelay> element.

relayDriverModule—Name of the relay driver module to connect. The value must match the value of the name attribute of an <NIRelayDriverModule> element.

controlLine—ID of the physical control line of the relay driver module to connect.

WAS THIS ARTICLE HELPFUL?

Not Helpful