Metadata
- Last UpdatedJan 06, 2023
- 4 minute read
During the discovery process, metadata is retrieved for gateways, sub-devices, and devices. This metadata is then stored in an PI AF template for which elements for discovered gateways, sub-devices, and devices are created.
The following table shows the gateway metadata that is collected by the connector.
Gateway metadata
|
Attribute |
Description |
|---|---|
|
Address |
IP Address of the gateway. |
|
Assignment to PV |
Dynamic variable assignment to the Primary Variable. |
|
Assignment to SV |
Dynamic variable assignment to the Secondary Variable. |
|
Assignment to TV |
Dynamic variable assignment to the Tertiary Variable. |
|
Assignment to QV |
Dynamic variable assignment to the Quaternary Variable. |
|
Configuration Change Counter |
Counter that denotes whether the gateway configuration has changed. |
|
Descriptor |
Brief description of the gateway. |
|
Device Hardware Revision |
Hardware revision level of the electronics in this particular gateway. |
|
Device ID |
Unique Device Identifier for every device belonging to a specific device type. |
|
Device Revision Level |
Revision level of the device (see HCF_SPEC-99 Command Summary Specification). |
|
Device Type |
Unique Identifier to denote the type of device in this case, wireless HART gateway (see HCF_SPEC-183 Common Table 1, Device Type Codes and the Command Specification, Section 6). |
|
Flags |
Flags on the gateway (see HCF_SPEC-183 Common Table 11, Flag Assignments). |
|
Is Wireless Device |
True if the gateway is a wireless device, false otherwise. |
|
Is Wireless Gateway |
True if the gateway is a wireless gateway, false otherwise. |
|
Is Wireless Wdi7 |
True if the gateway is a wireless WDi7 device, false otherwise. |
|
Long Tag |
A 32-character ISO Latin-1 string used to identify the field device. |
|
Major Revision Number |
A set of functional capabilities which increments when a functional change is made. |
|
Manufacturer |
Name of the manufacturer. |
|
Manufacturer Id |
Manufacturer Identification number which is controlled and allocated by the HART Communication Foundation. |
|
Master Mode Communication on Channels |
The master mode for communication on channels:
|
|
Maximum Channels Per IOCard |
Maximum number of channels supported on each IO card must be greater than or equal to 1. |
|
Maximum Delayed Responses Supported by IOSystem |
Maximum number of delayed responses supported by the IO system Must be at least two. |
|
Maximum Device Variables |
Maximum number of permissible devices variables on the gateway This indicated the last device variable code that a host application should expect to be found in the device. |
|
Maximum Number IOCards |
Maximum number of permissible IO Cards Must be greater than or equal to 1. |
|
Maximum Number of SubDevices Per Channel |
Maximum number of permissible subdevices for each channel Must be greater than or equal to 1. |
|
Minimum Preambles Request |
Minimum number of preambles required for the request message from the master device to the slave device This number includes the two preambles used in asynchronous Physical Layer (along with the Delimiter) to detect the start of message. |
|
Minimum Preambles Response |
Minimum number of preambles to be sent with the response message from the slave device to the master device. |
|
Number of Devices Detected |
Includes the gateway and the sub-devices on the gateway. |
|
Physical Signaling |
Physical Signaling Code (see HCF_SPEC-183 Common Table 10, Physical Signaling Codes). |
|
Private Label Distributor |
Name of the Private label Distributor (see HCF_SPEC-183 Common Table 8, Manufacturer Identification Codes). |
|
Profile String |
A string denoting the profile of the gateway (see HCF_SPEC-183 Common Table 57). |
|
Retry Count for Commands To SubDevice |
Retry count to use when sending commands to a sub-device. Valid range is 2 to 5. 3 retries is default. |
|
Software Revision Level |
Software revision level of this device. Levels 254 and 255 are reserved. |
|
Tag |
An 8-character (6-byte) Packed ASCII string to identify the field device. |
|
Unique Address |
Device Type followed by Device ID. |
The following table shows the sub-device metadata that is collected by the connector.
HART Sub-device metadata
|
Attribute |
Description |
|---|---|
|
Assignment to PV |
Dynamic variable assignment to the Primary Variable. |
|
Assignment to SV |
Dynamic variable assignment to the Secondary Variable. |
|
Assignment to TV |
Dynamic variable assignment to the Tertiary Variable. |
|
Assignment to QV |
Dynamic variable assignment to the Quaternary Variable. |
|
Channel |
The channel on which the sub-device is connected on the gateway. |
|
Configuration Change Counter |
Counter that denotes if the sub-device configuration has changed. |
|
Descriptor |
Brief description of the sub-device. |
|
Device Hardware Revision |
Hardware revision level of the electronics in this particular sub-device. |
|
Device ID |
Unique Device Identifier for every device belonging to a specific device type. |
|
Device Revision Level |
Revision level of the device (see HCF_SPEC-99 Command Summary Specification). |
|
Device Type |
Unique Identifier to denote the type of device (see HCF_SPEC-183 Common Table 1, Device Type Codes and the Command Specification, Section 6). |
|
Flags |
Flags on the sub-device (see HCF_SPEC-183 Common Table 11, Flag Assignments). |
|
Is Wireless Device |
True if the sub-device is a wireless device, false otherwise. |
|
Is Wireless Gateway |
True if the sub-device is a wireless gateway, false otherwise. |
|
Is Wireless Wdi7 |
True if the sub-device is a wireless Wdi7 device, false otherwise. |
|
Long Tag |
A 32-character ISO Latin-1 string used to identify the field device. |
|
Major Revision Number |
A set of functional capabilities which increments when a functional change is made. |
|
Manufacturer |
Name of the manufacturer (see HCF_SPEC-183 Common Table 8, Manufacturer Identification Codes). |
|
Manufacturer Id |
Manufacturer Identification number which is controlled and allocated by the HART Communication Foundation. |
|
Maximum Device Variables |
Maximum number of device variables. This indicates the last device variable code that a host application should expect to be found in the device. |
|
Minimum Preambles Request |
Minimum number of preambles required for the request message from the master device to the slave device. This number includes the two preambles used in asynchronous Physical Layer (along with the Delimiter) to detect the start of message. |
|
Minimum Preambles Response |
Minimum number of preambles to be sent with the response message from the slave device to the master device. |
|
Physical Signaling |
Physical Signaling Code (see HCF_SPEC-183 Common Table 10, Physical Signaling Codes). |
|
Private Label Distributor |
Name of the Private label Distributor (see HCF_SPEC-183 Common Table 8, Manufacturer Identification Codes). |
|
Profile String |
A string denoting the profile of the sub-device (see HCF_SPEC-183 Common Table 57). |
|
Software Revision Level |
Software revision level of the sub-device Levels 254 and 255 are reserved. |
|
SubDevice Index |
Index of the sub-device, which is unique for the gateway the device is connected to. |
|
Tag |
An 8-character (6-byte) Packed ASCII string to identify the field device. |
|
Unique Address |
Device Type followed by Device ID. |