Add data sources to PI Connector for HART-IP

Data source description

Optional: Description of the data source configuration.

Hostname or IP Address

Required: The host name or IP address of the HART-IP device.

The IP address, if used, must be in aaa.bbb.ccc.ddd format.

Port

Required: The communication port of the HART-IP device.

The default port number is 5094.

Connection Type

Required: The internet protocol connection type. UDP and TCP are supported.

The default connection type is TCP.

Access Point Short Address

Required: The access point short address provides a unique identifier for the gateway on the network. The valid range of the access point short address is 0-63. The default access point short address is set to -1. If the address is unknown, the access point short address should be set to the default of -1 so that it will be discovered by the connector.

Note: The access point short address is required when multiple HART gateways are defined on the same Hostname:Port endpoint. If there are multiple HART gateways defined on the same Hostname:Port and the access point short address is set to -1, then the connector will use the first valid host access point short address it encounters on the network, which could result in multiple data sources communicating with the same HART gateway.

Scan Interval

Required: The data scan interval rate in seconds.

The default scan interval is set to 60 seconds. The configurable range for this option is 1-3600 seconds.

Request Retry Count

Optional: The maximum number of data request retries to be attempted when requesting data from a specific HART sub-device.

The default request retry count is set to 4 retries for data. The configurable range for this option is 0-8 retries. Setting the retry count to 0 disables data retries for the sub-device.

Ideally, sub-device values published to the gateway are cached or stored on the gateway. Connector requests for sub-device data return quickly because the gateway simply returns the cached values for the sub-device. The gateway must forward the request to the sub-device if the gateway does not contain the cached values for the sub-device. The time it takes for a sub-device to return values to the gateway and then to the connector can vary from milliseconds to several seconds or longer.

The request for data made to the sub-device may take one or more request retries before the sub-device successfully returns the data. When a sub-device cannot immediately service a request for data, the sub-device responds with a delayed-response status that informs the caller that the request has been received and the caller must retry the request at a later time to retrieve the data. Delayed-response status returns cause delays in real-time data collection for other sub-devices.

If the configured retry count has been reached, the sub-device has either returned the requested data values or responded with another delayed-response. If a delayed-response is received, the connector flushes any outstanding requests to the gateway and moves onto the next command for the same or the next sub-device in the connector list.

Disabling or setting the Request Retry Count to a lower value may allow data scans to be serviced in a timely manner if data scans appear to be extended or missed during run-time operations. However, data for the requests that returned a delayed-response from one or more sub-devices are not collected.

The following table describes the time delay between each request retry as well as the total time delay for the configured request retry count. The total time delay column reflects the amount of time spent on the request when the configured request retry count is reached and a delayed-response is returned by the sub-device. Recall that real-time data collection for all other sub-devices is delayed while retrying requests for a sub-device. The connector cancels the pending request and moves to the next request once the maximum retry count is exceeded.

Request retry count	Time delay between requests (seconds)	Total time delay (seconds)
0	None	None
1	1	1
2	2	3
3	4	7
4	8	15
5	16	31
6	32	63
7	64	127
8	128	255

Collect Non-Dynamic Device Variables

Optional: Allow collection of non-dynamic device variables. Non-dynamic device variables are device variables not mapped to one or more of the four dynamic variables (PV, SV, TV, QV) defined in the HART specification. By default, the Collect Non-Dynamic Device Variables option is unselected and the connector only collects the PV, SV, TV, and QV dynamic variables.

Note: Connectors upgraded from a previous version will have the Collect Non-Dynamic Device Variables configuration checkbox set to selected to match current connector behavior. Users can manually unselect the Collect Non-Dynamic Device Variables option to stop updating non-dynamic variables.

Battery Check Interval

Optional: The battery life check interval rate in days.

The default battery life check interval is 7 days. the configurable range for this option is 0-31 days. Setting the value to 0 disables the battery life check.

Note: The time to retrieve the battery life takes several seconds or longer per sub-device connected to the gateway. This is because the battery life value is not cached on the gateway and the gateway must forward the request to the sub-device. Therefore, data collection scan intervals used to collect real-time data are delayed while the battery life is being requested. To minimize the impact of real-time data collection, the connector only requests the battery life of a single sub-device between data collection scan intervals.

Note: Requests to read battery life timeout after 7 request retries (127 seconds total time). The connector attempts to read battery life at the next battery life check interval.

Status Flags to Collect

Required: The status flags under Status Flags to Collect picklist can be set to either Collect or Do Not Collect for all devices under a particular datasource. These status flags are represented as PI Points in the PI Data Archive as well as PI AF attributes in the PI AF template for the datasource.

Note: Selection of status options that are prefixed with EDS, ADS, SS0, SS1, SS2, or SS3 result in the connector requesting Command 48 (Read Additional Device Status) for each connected sub-device. If the gateway does not cache the values for the Command 48 response, the time to retrieve these values can take several seconds or longer per sub-device because the gateway must forward the request to the sub-device. When the Command 48 values are not cached on the gateway, the time it takes to retrieve the Command 48 values from a sub-device varies because the connector retries the Command 48 request to the sub-device until a valid response is received. Therefore, real-time data collection for all other sub-devices is delayed while the Command 48 values are being requested and retried. Setting the Request Retry Count to 0 or 1 will help reduce the delay in real-time data collection for all other sub-devices. The reduced Request Retry Count may result in the inability to collect the desired status flags for one or more sub-devices.

The default data option is to Collect the status value for the Dynamic Variables, Device Variables, Battery, Loop Current and Percent Range measurements. Whereas, the default data option is to Do Not Collect the status value for Field Device Status, Extended Field Device Status, Additional Device Status,Standardized Status 0, Standardized Status 1, Standardized Status 2, and Standardized Status 3 device flags.

Picklist option (if supported by device)	Description	Default picklist selection
1_PV_Status	Device variable status mapped to the Primary Variable.	Collect
2_SV_Status	Device variable status mapped to the Secondary Variable.	Collect
3_TV_Status	Device variable status mapped to the Tertiary Variable.	Collect
4_QV_Status	Device variable status mapped to the Quaternary Variable.	Collect
5_Device_Variable_Status	Device variable status not mapped to a Dynamic Variable. Selection applies to all device variables not mapped to a dynamic variable.	Collect
6_Battery_Life_Status	Battery life status (Sub-device only).	Collect
7_Loop_Current_Status	Loop Current status (Wired Sub-device, Wireless Process Adapter or Wireless Discrete Adapter only).	Collect
8_Percent_Range_Status	Percent of Range status.	Collect
FDS_ColdStart	A power failure of Device Reset has occurred.	Do Not Collect
FDS_ConfigurationChanged	An operation was performed that changed the device's configuration.	Do Not Collect
FDS_DeviceMalfunction	The device detected a serious error of failure that compromises device operation.	Do Not Collect
FDS_LoopCurrentFixed	The Loop Current is being held at a fixed value and is not responding to process variations.	Do Not Collect
FDS_LoopCurrentSaturated	The Loop Current has reached its upper (or lower) endpoint limit and cannot increase (or decrease) any further.	Do Not Collect
FDS_MoreStatusAvailable	More status information is available via Command 48. Read Additional Status information. The connector will execute Command 48 if configured to collect Additional Device Status and this bit is set.	Do Not Collect
FDS_NonPrimaryVariableOutOfLimits	A Device Variable not mapped to the PV is beyond its operating limits.	Do Not Collect
FDS_PrimaryVariableOutOfLimits	The PV is beyond its operating limit.	Do Not Collect
EDS_CriticalPowerFailure	For devices that can operate from stored power. This bit is set when that power is becoming critically low. For example, a device scavenging power losing that power source would set this bit. Devices must be able to sustain their network connection for at least 15 minutes from the when this bit is set. A device may begin gracefully disconnecting from the network if its power level drops too low.	Do Not Collect
EDS_DeviceVariableAlert	This bit is set if any Device Variable is in an Alarm or Warning State. The host should identify the Device Variable(s) causing this to be set using the Device Variable Status indicators.	Do Not Collect
EDS_Failure	When this bit is set one or more Device Variables (that is, measurement or control values) are invalid due to a malfunction in the field device or its peripherals. Devices supporting this bit must support the Condensed Status Commands.	Do Not Collect
EDS_FunctionCheck	This bit is set if one or more Device Variables are temporarily invalid (for example, frozen) due to ongoing work on the device. Devices supporting this bit must support the Condensed Status Commands.	Do Not Collect
EDS_MaintenanceRequired	This bit is set to indicate that, while the device has not malfunctioned, the Field Device requires maintenance. Devices supporting this bit should support the Condensed Status Commands.	Do Not Collect
EDS_OutOfSpecification	When set, this bit indicates deviations from the permissible ambient or process conditions have been detected that may compromise measurement or control accuracy (that is, device performance may be degraded given current operating conditions). Devices supporting this bit must support the Condensed Status Commands.	Do Not Collect
ADS_AdditionalDeviceStatus_0	Device specific status (refer to appropriate device-specific document for detailed information).	Do Not Collect
ADS_AdditionalDeviceStatus_1	Device specific status (refer to appropriate device-specific document for detailed information).	Do Not Collect
ADS_AdditionalDeviceStatus_2	Device specific status (refer to appropriate device-specific document for detailed information).	Do Not Collect
ADS_AdditionalDeviceStatus_3	Device specific status (refer to appropriate device-specific document for detailed information).	Do Not Collect
ADS_AdditionalDeviceStatus_4	Device specific status (refer to appropriate device-specific document for detailed information).	Do Not Collect
ADS_AdditionalDeviceStatus_5	Device specific status (refer to appropriate device-specific document for detailed information).	Do Not Collect
ADS_AnalogChannelFixed	Analog Channel Fixed 1-4.	Do Not Collect
ADS_AnalogChannelSaturated	Analog Channel Saturated 1-4.	Do Not Collect
ADS_ExtendedDeviceStatus	Refer to Extended Field Device Status table.	Do Not Collect
ADS_StandardizedStatus_0	Bitmask byte value representing Standardized Status 0.	Do Not Collect
ADS_StandardizedStatus_1	Bitmask byte value representing Standardized Status 1.	Do Not Collect
ADS_StandardizedStatus_2	Bitmask byte value representing Standardized Status 2.	Do Not Collect
ADS_StandardizedStatus_3	Bitmask byte value representing Standardized Status 3.	Do Not Collect
SS0_DeviceConfigurationLocked	Standardized Status 0: Device Configuration Locked. Device is in write-protect or is locked.	Do Not Collect
SS0_DeviceVariableSimulationActive	Standardized Status 0: Device Variable Simulation Active. The device is in simulation mode and one or more of its Device Variables are not representative of the process.	Do Not Collect
SS0_ElectronicDefect	Standardized Status 0: Electronic Defect. A hardware problem not related to the sensor has been detected.	Do Not Collect
SS0_EnvironmentalConditionsOutOfRange	Standardized Status 0: Environmental Conditions Out of Range. An internal or environmental condition is beyond acceptable limits.	Do Not Collect
SS0_NonVolatileMemoryDefect	Standardized Status 0: Non-Volatile Memory Defect. The Non-Volatile memory check is invalid or maybe corrupt, or the battery of a battery-backed memory is defective.	Do Not Collect
SS0_PowerSupplyConditionsOutOfRange	Standardized Status 0: Power Supply Conditions Out of Range. The power source, supply or voltage is outside its allowable range.	Do Not Collect
SS0_VolatileMemoryDefect	Standardized Status 0: Volatile Memory Defect. The RAM memory check is invalid or maybe corrupt.	Do Not Collect
SS0_WatchdogResetExecuted	Standardized Status 0: Watchdog Reset Executed. A watchdog reset has been performed.	Do Not Collect
SS1_DiscreteVariableSimulationActive	Standardized Status 1: Discrete Variable Simulation Active. The device is in simulation mode and one or more of its Discrete Variables are not representative of the process.	Do Not Collect
SS1_EventNotificationOverflow	Standardized Status 1: Event Notification Overflow. This bit must be set when the event queue for one or more Event Specification (see Event Notification in Common Practice Command Specification ) overflows resulting in an event not be recorded. This bit must be reset when all pending events have been acknowledged.	Do Not Collect
SS1_StatusSimulationActive	Standardized Status 1: Status Simulation Active. Status Simulation Mode has been enabled and the Device Status and the status bits being returned in the Command 48 response are fixed and may not represent the current state of the device.	Do Not Collect
SS2_DuplicateMasterDetected	Standardized Status 2: Duplicate Master Detected. The Adapter has discovered another master with the same address connected to its token-passing interface.	Do Not Collect
SS2_StaleDataNotice	Standardized Status 2: Stale Data Notice. This bit is set when the Stale Data Alarm for any Sub-device is set.	Do Not Collect
SS2_SubDeviceListChanged	Standardized Status 2: Sub-Device List Changed. When set, the I/O system has lost communication with one of its sub-devices or discovered a new sub-device. Issuing Command 74 to read "Number of devices detected" resets this bit. The current sub-device list is read using Command 84.	Do Not Collect
SS2_SubDeviceMismatch	Standardized Status 2: Sub-Device Mismatch. One or more of the sub-devices connected to the I/O system do not match the stored/pre-configured value.	Do Not Collect
SS2_SubDeviceWithDuplicateIDsFound	Standardized Status 2: Sub-Device with Duplicate IDs Found. Sub-Devices with Duplicate Unique IDs or Long Tags found connected to the I/O System.	Do Not Collect
SS3_BandwidthAllocationPending	Standardized Status 3: Bandwidth Allocation Pending. The device has asked for bandwidth from the Network Manager and is awaiting Network Manager response.	Do Not Collect
SS3_BlockTransferPending	Standardized Status 3: Block Transfer Pending. The device has a data set (e.g., a waveform) awaiting transfer to the host application or Gateway. The Gateway should open the block transfer port and transfer the data.	Do Not Collect
SS3_CapacityDenied	Standardized Status 3: Capacity Denied. The device was unable to acquire the communication bandwidth required to support the Burst Messaging specified. This must also be set if the Network Manager reduces the bandwidth allocated to the device. Gateway must set this bit when any device in the network has insufficient bandwidth.	Do Not Collect
SS3_RadioFailure	Standardized Status 3: Radio Failure. The radio or radio module has failed and the device needs to be serviced or replaced. The "Device Malfunction" bit in the Device Status byte must be set when this bit is set.	Do Not Collect
DSS_202_Emerson_SubDeviceReliability	For Emerson 1410/1420 Wireless Gateways. Measure of connectivity between the Gateway and a wireless field device. The status is a calculation of the ratio of the number of received messages over the number of expected messages. Value is between 0-100%.	Do Not Collect
DSS_202_Emerson_SubDeviceOnline	For Emerson 1410/1420 Wireless Gateways. Indicates whether a device is Online and communicating with the network. This status is triggered when a device becomes stale or unreachable. (A device is stale after 8 missed updates and unreachable after 10 minutes.)	Do Not Collect

Note: Deselecting flags that have already been selected for collection in the datasource configuration is not recommended because the connector cannot delete the previously created PI AF attributes.

By clicking on this checkbox I understand that the "long tag" field value for every HART-IP device requires a unique name so that collisions in device "long tag" values will be avoided when sending device asset and value information to the PI System. Failure to provide a unique "long tag" field value for every HART-IP device will result in multiple devices sending data to the same PI AF element and/or attribute(s) as well as the associated PI point(s).

Optional: The default for the checkbox is unselected. If the checkbox is selected, the connector will create device-specific PI AF elements using only the device long tag name. Moreover, the associated PI points will contain the device long tag name and not the device unique address. If the checkbox is left unselected, the device-specific AF element names will consist of a combination of long tag name and the unique address, and the PI points will contain the unique address.

Note: By selecting the checkbox, the "long tag" field value for every HART-IP device will require unique long tag names for all connected devices so that names of the PI Points, PI AF Elements, and Attributes will be unique in the PI System. Failure to provide a unique "long tag" field value for every HART-IP device will result in multiple devices sending data to the same PI AF element and/or attribute(s) as well as to the associated PI point(s). Modifying this datasource option after the connector has already collected data will result in the creation of new PI Points, PI AF Elements, and Attributes. Moreover, the previously configured PI Points, PI AF Elements, and Attributes will no longer be updated.

The Overview page opens and lists the new data source.

PI Connector for HART-IP

Add data sources to PI Connector for HART-IP

Table of Contents

Add data sources to PI Connector for HART-IP

Related Links