FDT frame. A built-in webserver provides detailed diagnostics of system configuration and operation as well as field device specific diagnostics. The Hart 4 module is configured using the Aparian Slate application. This program can be downloaded from www.aparian.com free of charge.
Preface 1.2. ADDITIONAL INFORMATION The following documents contain additional information that can assist the user with the module installation and operation. Resource Link Slate Installation http://www.aparian.com/software/slate User Manual, Datasheet http:// www.aparian.com/products/hart4 Example Code & UDTs www.cisco.com/c/en/us/td/docs/video/cds/cde/cde205_220_420/installa Ethernet wiring standard tion/guide/cde205_220_420_hig/Connectors.html Table 1.1.
Installation 2. INSTALLATION 2.1. MODULE LAYOUT The module has six ports at the bottom of the enclosure as shown in the figure below. The ports are used for Ethernet, the four analog HART channels and power. The power port uses a three-way connector which is used for the DC power supply and the earth connection.
Page 7
Installation Figure 2.2. – HART 4 (Input) front and top view The module provides four DIP switches at the top of the enclosure as shown in the top view figure above. DIP Switch Description DIP Switch 1 Used to force the module into “Safe Mode”. When in “Safe Mode” the module will not load the application firmware and will wait for new firmware to be downloaded.
Installation 2.2. MODULE MOUNTING The module provides a DIN rail clip to mount onto a 35mm DIN rail. Figure 2.3 - DIN rail specification The DIN rail clip is mounted on the bottom of the module at the back as shown in the figure below.
Installation 2.3. POWER A three-way power connector is used to connect Power+, Power– (ground), and earth. The module requires an input voltage of 12 – 28Vdc. Refer to the technical specifications section in this document. Figure 2.5 - Power connector 2.4.
Installation Figure 2.7 – Analog Input Equivalent Circuit Figure 2.8 – Analog Output Equivalent Circuit 2.5. ETHERNET PORT The Ethernet connector should be wired according to industry standards. Refer to the additional information section in this document for further details. Document No.
Setup 3. SETUP 3.1. INSTALL CONFIGURATION SOFTWARE All the network setup and configuration of the module is achieved by means of the Aparian Slate device configuration environment. This software can be downloaded from http://www.aparian.com/software/slate. Figure 3.1. - Aparian Slate Environment 3.2.
Page 12
Setup Figure 3.3. - DHCP Server NOTE: If the DHCP requests are not displayed in the DHCP Server it may be due to the local PC’s firewall. During installation the necessary firewall rules are automatically created for the Windows firewall. Another possibility is that another DHCP Server is operational on the network and it has assigned the IP address.
Page 13
Setup Figure 3.5. - Successful IP address assignment It is possible to force the module back into DHCP mode by powering up the device with DIP switch 2 set to the On position. A new IP address can then be assigned by repeating the previous steps. NOTE: It is important to return DIP switch 2 back to Off position, to avoid the module returning to a DHCP mode after the power is cycled again.
Page 14
Setup Figure 3.7. - Selecting the Target Browser The Target Browser automatically scans the Ethernet network for EtherNet/IP devices. Figure 3.8. - Target Browser Right-clicking on a device, reveals the context menu, including the Port Configuration option. Figure 3.9. - Selecting Port Configuration All the relevant Ethernet port configuration parameters can be modified using the Port Document No.
Setup Configuration window. Figure 3.10. - Port Configuration Alternatively, these parameters can be modified using Rockwell Automation’s RSLinx software. 3.3. CREATING A NEW PROJECT Before the user can configure the module, a new Slate project must be created. Under the File menu, select New.
Page 16
Setup A Slate project will be created, showing the Project Explorer tree view. To save the project use the Save option under the File menu. A new device can now be added by selecting Add under the Device menu. Figure 3.12. - Adding a new device In the Add New Device window select the HART 4In or HART 4Out module and click the Ok button.
Setup window opened. The device configuration window can be reopened by either double clicking the module in the Project Explorer tree or right-clicking the module and selecting Configuration. Figure 3.14. – HART 4In module configuration Refer to the additional information section in this document for Slate’s installation and operation documentation.
Page 18
Setup Description This parameter is used to provide a more detail description of the application for the module. IP Address The IP address of the target module Major Revision The major revision of the module Protocol There are four protocols that can be selected for the HART 4 module. EtherNet/IP This is the default setting and should be selected when the module is being used with the Rockwell Automation Logix family of controllers.
Page 19
Setup Each of the channel configuration tabs consist of the following parameters: Parameter Description Enable Channel Used to Enable or Disable the entire analog channel. Signal Select either 4-20mA or 0-20mA. Range Note that HART communication will be disabled if the 0-20mA range has been selected.
Page 20
Setup The default source of the trend data can be one of the following: Raw Analog Current - The raw analog signal in milliamps. Filtered Scaled Value – The analog signal in engineering units. Digital Current – The current in milliamps reported by the field device (HART). Source PV –...
Page 22
Setup The module supports the asynchronous reading of advanced diagnostic parameters, which are then written directly to Logix tags. The Advanced Diagnostics configuration tab consists of a table comprising the following parameters: Parameter Description Description A user description for the advanced diagnostic parameter. Command The command string used to collect the parameter.
Page 23
Setup Figure 3.19. – Advanced Diagnostic Builder The builder is used to generate the command, and to define the Data Type. The following parameters need to be defined: Parameter Description Description A user description for the advanced diagnostic parameter. Diagnostic Type Select HART Pass Through option.
Page 24
Setup populated accordingly. A Logix tag can now be associated with the Advanced Diagnostic parameter. This can be done by either entering the tag name or by using the Tag Browser to browse for a tag. NOTE: It is important to ensure that the selected Logix tag type matches that of the expected HART command parameter.
Page 25
Setup AES-128 Key Wrap AES-256 Key Wrap Aggressive Mode To reduce the bandwidth used for secure authentication the user can select aggressive mode which allows the message initiator to anticipate and provide the required authentication in the request message. Thus from a network point of view there is a two message exchange for secure authentication compared to the normal four message exchange for secure authentication.
Setup 3.5. MODULE DOWNLOAD Once the HART 4 module configuration has been completed, it must be downloaded to the module. Before downloading the Connection Path of the module should be set. This path will automatically default to the IP address of the module, as set in the module configuration. It can however be modified, if the HART 4 module is not on a local network.
Page 27
Setup Figure 3.24. - Selecting Download Once complete, the user will be notified that the download was successful. Figure 3.25. - Successful download Within the Slate environment the module will be in the Online state, indicated by the green circle around the module. The module is now configured and will start operating immediately. Figure 3.26.
Setup 3.6. LOGIX INTEGRATION The Hart4 modules can be easily integrated with Allen-Bradley Logix family of controllers. The module must be added using a Generic Profile which is described below. 3.6.1. I/O C ODULE TO ONFIGURATION The HART 4 module must be added to the RSLogix 5000 I/O tree as a generic Ethernet module. This is achieved by right clicking on the Ethernet Bridge in the RSLogix 5000 and selecting New Module after which the ETHERNET-MODULE is selected to be added as shown in the figure below.
Page 29
Setup Figure 3.28 - RSLogix 5000 General module properties for HART 4In module The required connection parameters for the HART 4Out module are shown below: Connection Parameter Assembly Instance Size Input 119 (32-bit) Output 4 (32-bit) Configuration 0 (8-bit) Table 3.5 - RSLogix class 1 connection parameters for the HART 4Out module Document No.
Page 30
Setup Figure 3.29 - RSLogix 5000 General module properties for HART 4Out module NOTE: The user will need to enter the exact connection parameters before the module will establish a class 1 connection with the Logix controller. Next the user needs to add the connection requested packet interval (RPI). This is the rate at which the input and output assemblies are exchanged.
Setup Figure 3.31 – RSLogix 5000 I/O module tree 3.6.2. MPORTING S AND APPING OUTINES To simplify the mapping of the input image, an RSLogix 5000 Routine Partial Import (L5X) file is provided. This file can be imported by right-clicking on the required Program and selecting the Import Routine option.
Page 32
Setup The import will create the following: The required UDTs (user defined data types) Controller tags representing the Input and Output assemblies. A routine mapping the HART4In and HART4Out modules to the aforementioned tags. The user may need to change the routine to map to the correct HART-4 module instance name, and make sure that the mapping routine is called by the Program’s Main Routine.
Operation 4. OPERATION Once the HART 4 module has been configured it will exchange HART information between the HART field device and a Logix controller, DNP3 Master or Modbus TCP master. 4.1. LOGIX 5000 When the module operates in a Logix “owned” mode the Logix controller will establish a class 1 cyclic communication connection with the HART 4 module.
Page 35
Operation Chx_DeviceStatus.LoopOpen BOOL Loop open circuit detected. (Current < 3.6 mA) Chx_DeviceStatus.CurrentUnderrange BOOL Loop current under range. (Current < 3.8 mA) Chx_DeviceStatus.CurrentOverrange BOOL Loop current over range. (Current > 20.5 mA) Chx_DeviceStatus.LoopShorted BOOL Loop short circuit detected. (Current > 21.0 mA) Chx_DeviceStatus.CalibrationBusy BOOL Analog current calibration busy.
Operation Chx_HARTStatus.Coldstart BOOL Field device power failure or device reset has occurred. Chx_HARTStatus.MoreStatusAvailable BOOL Additional status information is available. Chx_HARTStatus.LoopCurrentFixed BOOL The Loop Current is set at a fixed value and is not responding to process variations Chx_HARTStatus.LoopCurrentSaturated BOOL The Loop Current has reached its upper or lower limit.
Operation Parameter Datatype Description Ch0_Data REAL Analog output value (in engineering units) for Channel 0. Ch1_Data REAL Analog output value (in engineering units) for Channel 1. Ch2_Data REAL Analog output value (in engineering units) for Channel 2. Ch3_Data REAL Analog output value (in engineering units) for Channel 3. Table 4.2 –...
Page 38
Operation Figure 4.2. – Relay HART Message Configuration Parameter Value / Description Message Type CIP Generic Service Type Custom Service Code 79 Hex (Relay HART Message service) Class 40F Hex Instance Channel value + 1 1 for Channel 0 2 for Channel 1 3 for Channel 2 4 for Channel 3 Attribute...
Page 39
Operation The required Request and Response HART Command structures are defined as follows: HART Command Request Byte Data Offset Type Description Request Length SINT Start Character (0x82 for Long Address) SINT Long Address 0 (0x80 + Manufacturer ID) SINT Long Address 1 (Device Type Code) SINT Long Address 2 (Device ID Byte 0) SINT...
Page 40
Operation (Undefined) Invalid selection Passed parameter too large Passed parameter too small Too few data bytes received Transmitter specific error In write-protect mode 8-15 Command specific error Access restricted Device is busy Command not implemented Second Byte : Device Status Description PV out of limits Variable (non-PV) out of limits...
Page 41
Operation Figure 4.3. – Relay HART Message Example Configuration Figure 4.4. – Relay HART Command Example – Request Document No. D113-015 Page 41 of 77 Revision 1.9...
Page 42
Operation Figure 4.5. – Relay HART Command Example – Response NOTE: The HART Long Address for a device is comprised of the Manufacturer ID, Device Type Code and Device ID. These values are displayed on the Channel Status screen in Slate when the device is Online. Document No.
Operation 4.2. DNP3 OPERATION The DNP3 operation is enabled when the configuration protocol is set to either DNP3 TCP or DNP3 UDP. The HART 4 module will then operate as a DNP3 Outstation supporting the following DNP3 objects. Group: 10 - Counters Variation: Functions: Read...
Operation Group: 102 - Unsigned 8 bit Integers Variation: Functions: Read Item Parameter Length General Channel 0 Channel 1 Channel 2 Channel 3 Module Status Bit 0 – Configuration Valid Bit 1 – Channel 0 Enabled Bit 2 – Channel 1 Enabled Bit 3 –...
Page 45
Operation Change methods, Message Authentication Code (MAC) algorithms, and Authentication methods provided in the DNP3 protocol specification. Various keys are used in DNP3 Secure Authentication. Session keys are used most frequently as it is used for Authentication of the requests. These keys are updated by the DNP3 master at a certain interval or every time there has been a message failure.
Operation Figure 4.6 - HART 4 DNP3 key update method. The module supports all DNP3 MAC algorithms and Key Wrap algorithms. The module also supports Aggressive Authentication mode which reduces the amount of traffic on the network (which could be required on busy networks or serial communication). 4.3.
Page 47
Operation Bit 7 – Channel 2 HART Enabled Bit 8 – Channel 3 HART Enabled Modbus Statistics Rx Packet Count DINT Tx Packet Count DINT Node Mismatch DINT Error Messages Sent DINT Device Info Manufacturer ID BYTE Manufacturer Device Type BYTE Code Number of Preambles Required...
Page 48
Operation SINT PV units code SV units code SINT SINT TV units code SINT FV units code Device Status Device Status BYTE HART Status Device Specific Status 0 BYTE[6] Operational Modes BYTE[2] Standardized Status 0 BYTE Standardized_status1 BYTE Analog channel saturated BYTE Standardized_status2 BYTE...
Diagnostics 5. DIAGNOSTICS 5.1. LEDS The module provides six LEDs for diagnostics purposes as shown in the front view figure below. A description of each LED is given in the table below. Figure 5.1 - HART 4 module front view Description Module The module LED will provide information regarding the system-level operation of the...
The statistics can be accessed in full by Slate or using the web server in the module. To view the module’s status in the Aparian-Slate environment, the module must be online. If the module is not already Online (following a recent configuration download), then right-click on the module and select the Go Online option.
Page 51
Diagnostics The Status monitoring window can be opened by either double-clicking on the Status item in the Project Explorer tree, or by right-clicking on the module and selecting Status. The status window contains multiple tabs to display the current status of the module. Most of these parameters in the status windows are self-explanatory or have been discussed in previous sections.
Diagnostics Ethernet Cable Length An estimate on the Ethernet cable length. (From the device to switch or media converter.) The accuracy is approximately 5m. A large discrepancy in this length may be indicative of an Ethernet cable issue. DIP Switch Position The status of the DIP switches when the module booted.
Diagnostics 5.2.2. DNP3 The DNP3 Statistics and DNP3 Security Statistics will be displayed if either of the two DNP3 protocols have been configured. Figure 5.6 - DNP3 Statistics Statistic Description Application Messages Tx The number of application DNP3 packets sent by the module. Application Messages Rx The number of application DNP3 packets received by the module.
Page 54
Diagnostics DNP3 Request Out of Range – High The DNP3 request has a range that is outside of the implemented DNP3 bounds for the specific group and variation. This error is specific to the range being higher than the implemented range. DNP3 Request Too Many Objects The Hart 4 module supports a maximum of 10 DNP3 objects in a single DNP3 request.
Diagnostics Authorization Failures Increases when a user is not authorized to perform a requested operation. Unexpected Responses The other device has responded with a message that was not expected during the authentication process. No Responses The other device has not replied during the authentication process. Aggressive Not Supported When Aggressive Mode Authentication is not supported this will increase.
Diagnostics Rx Packet Count The number of Modbus packets received by the module. Checksum errors The number of corrupted Modbus packets received by the module. Parity errors The number of bytes with parity errors received by the module. Timeout Errors The number of message response timeouts the module has encountered.
Page 57
Diagnostics Figure 5.9 - Select Online Channel Status The channel status window contains multiple tabs to display the current status of that specific channel. The General tab displays a summary of the common HART parameters. Figure 5.10 - Channel Status – General Parameter Description The user tag name configured in the field device.
Page 58
Diagnostics Device Type The device type code assigned by the manufacturer. The primary variable displayed in engineering units, with the engineering unit PV (and Units) enumeration. The secondary variable displayed in engineering units, with the engineering unit SV (and Units) enumeration.
Page 59
Diagnostics The minimum number of preambles required by the field device to process Preambles Required a HART request. Universal Command Revision The universal command revision supported by the field device. Specific Command Revision The specific command revision supported by the field device. Software Revision The software revision of the field device.
Page 60
Diagnostics Flagged when Class 2 HART relay messages have been disabled in the Relay Message Inhibit configuration. Burst Mode Active Flagged if the field device is operating in burst mode. Parity Error Flagged if the field device received a message with a parity error Overrun Error Flagged if the field device receive buffer is overrun.
Page 61
Diagnostics Parameter Description The user tag name configured in the field device. (8 characters). Note: The Tag, Descriptor and Date are updated together. Descriptor The user descriptor configured in the field device. (16 characters). Note: The Tag, Descriptor and Date are updated together. Date The date when the tag and descriptor configuration was last modified.
Page 62
Diagnostics The Advanced Status tab displays the advanced and device specific status information of the field device. Due to the manufacturer specific encoding of these parameters, consult the field device manufacturer’s documentation for more information. Figure 5.15 - Channel Status – Advanced Status The HART Statistics tab displays the communication statistics.
Page 63
Diagnostics Command Errors The number of command errors experienced. Time-Out Errors The number of HART time-out errors experienced. Relay Message Tx Count The number of HART packets sent via relay (Class 2) messages (DTMs etc.) Relay Message Rx Count The number of HART packets received for relay (Class 2) messages (DTMs etc.) Adv.
Diagnostics Fourth Variable (FV) Figure 5.18 - Channel Status – Trend Once the source or sample rate has been modified, the Apply button must be clicked for the changes to take effect. This will also result in the existing trend data being cleared. The Y axis scale can be modified by adjusting the Min and Max value and clicking the Refresh button.
Diagnostics Figure 5.19 – Device List There are various options the user can execute per device found in the device list. Some of the options will only be relevant depending on the HART Rev (eg. the Long Tag is only support with HART 6/7).
Diagnostics Figure 5.21 – Channel Status – Input Calibration The module is Factory Calibrated, and should not require any further calibration before use. To re-calibrate the module, the User Calibration methods described below can be implemented. 5.5.1. NPUT ALIBRATION To re-calibrate a HART 4 Input module, 1.
Diagnostics NOTE: Before commencing with input calibration ensure that it is safe to do so. The simulated current values could translate to extreme process variables in the connected control system which may cause unexpected results. Failure to do so could result in severe equipment damage and personal injury. 5.5.2.
Diagnostics 5.6. MODULE EVENT LOG The HART 4 module logs various diagnostic records to an internal event log. These logs are stored in non-volatile memory and can be displayed using Slate or via the web interface. To view them in Slate, select the Event Viewer option in the Project Explorer tree. Figure 5.24.
Diagnostics 5.7. WEB SERVER The HART 4 module provides a web server allowing a user without Slate or RSLogix 5000 to view various diagnostics of the module. This includes Ethernet parameters, system event log, advanced diagnostics, and application diagnostics. NOTE: The web server is view only and thus no parameters or configuration can be altered from the web interface.
The HART 4 module supports FDT / DTM technology, allowing the user to configure any field device using its DTM (Device Type Manager) in any standard FDT Frame (Field Device Tool). To use a field device DTM with the HART 4 module, the following Aparian DTMs will need to first be installed: ...
What is HART 7. WHAT IS HART 7.1. INTRODUCTION TO HART HART is an acronym for Highway Addressable Remote Transducer. HART is able to transfer digital information across a standard 4-20 mA loop, by superimposing the digital data on the analog signal using Frequency Shift Keying (FSK).
Technical Specifications 8. TECHNICAL SPECIFICATIONS 8.1. DIMENSIONS Below are the enclosure dimensions as well as the required DIN rail dimensions. All dimensions are in millimetres. Figure 8.1 – HART 4 module enclosure dimensions Figure 8.2 - Required DIN dimensions Document No. D113-015 Page 72 of 77 Revision 1.9...
Technical Specifications 8.2. ELECTRICAL Specification Rating Power requirements Input: 12 – 28V DC, 35mA @ 24 VDC – With no field devices attached. 130mA @ 24 VDC - With 4 field devices at 22mA each. 64mA @12 VDC - With no field devices attached. 160mA @ 12 VDC - With 4 field devices at 22mA each.
Need help?
Do you have a question about the A-HRT-4I and is the answer not in the manual?
Questions and answers