Pin Map File XML Structure
- 업데이트 날짜:2023-02-17
- 18분 (읽기 시간)
Pin Map File XML Structure
| Legend |
|---|
 Root element |
 Element |
 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
- Consider getting instrument names to use in ECU Test programs from the section of the ECU Test System Maintenance Software Report or from NI MAX.
- Names for NI instruments in the pin map file are not case sensitive.
- NIDCPowerInstrument—Defines an NI-DCPower
instrument.
- name—Name of the
instrument, as defined in MAX.
- numberOfChannels—Number of channels available on the
instrument.
- ChannelGroup—Defines a group of channels controlled
by one session. By grouping channels into a single session, you can avoid using
session loops in code modules. By default, the Pin Map Editor creates one
channel group containing all instrument channels. To create multiple, custom
groups, use a unique name for the set of instrument channels for which you want
to create a session. Note that channels within a group do not have to be from
the same NI-DCPower instrument. Refer to the NI-DCPower Help for information
about independent channels.
- name—Name of a
group of channels. Group names are case sensitive.
- channels—Channel(s) that are assigned to a group. If not
defined, the ECU Software Toolkit will assign all channels from the
instrument. Channels can be defined as a comma-separated list (e.g.,
0,1,3,..,n), a continuous range (e.g., 0:3), or as a combination of the two
(e.g., 0:1,3). All channels from an instrument must be assigned to a group
and a channel cannot be in multiple groups.
- 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 the ECU Software Toolkit 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.
- group—Name of the
group that contains the instrument. Group names are case sensitive. By default,
the Pin Map Editor sets this attribute to
Scope when you add NI-SCOPE instruments to the pin map file.
Group names are case sensitive. By using the same group name for all NI-SCOPE
instruments, the ECU Software Toolkit combines all instruments into a single
session so you can avoid session loops in code modules. To create multiple
NI-SCOPE sessions, use a unique name for each set of instruments for which you
want to create a session. Refer to the NI-SCOPE Help for
information about hardware limitations that prevent certain instruments from
operating together as a single instrument.
- 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 the ECU Software
Toolkit does not natively support.
- name—String that
identifies the instrument. For instruments that NI provides but that the ECU
Software Toolkit 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.
- NIModelBasedInstrument
- name—Unique string
that identifies the instrument.
- instrumentModel—Installed model description files in the
model library.
- category—String
that specifies the category to which the instrument belongs. The instrument
model description defines the category for the instrument model.
- subcategory—(Optional) String that specifies the subcategory
to which the instrument belongs. The instrument model description defines the
subcategory for the instrument model.
- Resource—(Optional) If required by the model
description file, specifies the instrument resource name in Measurement &
Automation Explorer (MAX).
- owner—Specifies the instrument resource in the model
description file to which the attribute values of the
<UserData> element apply.
- UserData—Contains the properties from the model
description file you can assign.
- propertyName—Name of the property defined in the
model description file.
- propertyValue—Value you assign to the property.
- 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.
- NISwitchExecutiveVirtualDevice—Defines a switching
instrument to use as a Switch Executive virtual device on one test site or across
multiple test sites. You can use one or multiple instruments switched across DUT
pins on one or multiple test sites.
- name—Name of the
Switch Executive virtual device, as defined in NI MAX.
- 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 DUT pin, which is a pin on a DUT or a resource on the tester or DIB that is
associated with one or more sites.
- name—String that
identifies the DUT pin.
- SystemPin—Defines a system pin, which is resource on the
tester or DIB that is connected to an instrument.
- name—String that
identifies the system pin.
- 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 site relay, which is a relay on the
tester or DIB that is connected to a relay driver module and that is associated with
one or more sites.
- name—String that
identifies the site relay.
- 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 relay, which is a relay on
the tester or DIB that is connected to a relay driver module and that is associated
with all sites.
- name—String that
identifies the system relay.
- 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.
- RelayConfigurations—Specifies a grouping of relay
configurations.
- RelayConfiguration—Defines a relay configuration. A
relay configuration is the name assigned to a set of relays and their positions.
- name—String that
identifies the relay configuration.
- RelayPosition—Specifies a relay and its
position.
- relay—String
that specifies the name of an existing relay or relay group.
- position—String that specifies the position of the relay
or relay group. Valid values are Open or
Closed.
- 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 connection between a DUT pin 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—The
site or group of sites associated with the connection. The value must match the
value of the siteNumber attribute of one of the
Site elements or it must be a comma-separated list of
site numbers.
- 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.
- SwitchExecutiveConnection—Specifies a switched
connection between a DUT pin and an instrument channel for one site using a Switch
Executive virtual device.
- pin—Name of a DUT
pin to connect. The value must match the name attribute value
of a DUTPin element.
- siteNumber—Site
for the DUT pin in the system. The value must match the
siteNumber attribute value of a Site
element.
- instrument—Name of
the instrument to connect. The value must match the name
attribute value of an Instrument element.
- channel—ID of the
instrument channel to connect.
- switchExecutiveVirtualDevice—Specifies the Switch Executive
virtual device used to connect a DUT pin on a specific site to the instrument
channel.
- RelayConnection—Defines a connection between a site
relay 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—The
site or group of sites associated with the connection. The value must match the
value of the siteNumber attribute of one of the
Site elements or it must be a comma-separated list of
site numbers.
- 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.
Common XML Validation Error Messages
If the contents of the pin map XML file do not satisfy the constraints the pin map schema defines, the ECU Software Toolkit reports error messages. Some of the error messages are generic XML validation errors and can be difficult to decipher.
Refer to the following tables to interpret certain error messages.
| Error Message | The key sequence '<Item>' in 'http://www.ni.com/TestStand/SemiconductorModule/PinMap.xsd:<Element>' Keyref fails to refer to some key. | ||||||||||||||||||||||
| Interpretation | The following table includes the exact meaning of the error
message, which depends on the value of the Element text.
|
| Error Message | There is a duplicate key sequence '<Item1> [<Item2>]' for the 'http://www.ni.com/TestStand/SemiconductorModule/PinMap.xsd:<Element>' key or unique identity constraint. | ||||||||||||||||||||||||||||
| Interpretation | The following table includes the exact meaning of the error
message, which depends on the value of the Element text.
|