Smart Transmitter Toolkit User Manual
Important User Information Because of the variety of uses for the products described in this publication, those responsible for the application and use of this control equipment must satisfy themselves that all necessary steps have been taken to assure that each application and use meets all performance and safety requirements, including any applicable laws, regulations, codes and standards.
Table of Contents Using This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . i What's In This Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Purpose of This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Who Should Use This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . How To Use This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ii Table of Contents Programming Example 2: Multiple HART Devices With Single 1770 HT1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Programming Example 3: Multiple HART Devices With Multiple 1770 HT1s . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 13 HART Command Data Table Layouts . . . . . . . . . . . . . . . . . A 1 What's In This Appendix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . HART Command 0 Read HART Address . . . . . . . . . . . . . . . . . . .
Preface Using This Manual What's In This Preface This preface describes how to properly and efficiently use this manual. Smart Transmitter Toolkit It tells you about: User Manual the purpose of this manual who should use this manual how to use this manual terms abbreviations conventions related publications publication 1770 6.5.21 Purpose of This Manual Use this manual to install and use the Smart Transmitter Toolkit. Throughout this manual we refer to this utility as the STT subroutine.
Preface Using This Manual How To Use This Manual Start by reading about the STT subroutine. Then, follow the instructions in chapter 2 to install the STT subroutine. Finally, use chapter 3 and the appendices to help you incorporate the STT subroutine into your ladder logic.
Preface Using This Manual Conventions We use these conventions in this manual: In this manual, we show: Like this: prompts and messages Press a function key literal text that you type STT_SUB variable text that you type filename keys that you press F1 screens that you see Program Directory that there is more information about the topic in another manual Related Publications Allen Bradley Publications Publication Publication Number Smart Transmitter Interface Products (HART Protocol) User M
Chapter 1 Introducing The Smart Transmitter Toolkit What's In This Chapter This chapter gives you an overview of the Smart Transmitter Toolkit that you received with your Smart Transmitter Interface (cat. no. 1770-HT1).
Chapter 1 Introducing The Smart Transmitter Toolkit What You Get With The STT Subroutine The STT subroutine transfers this digital data between the PLC-5 processor and HART field devices: Read - primary variable and unit - primary variable current - dynamic variables and unit - status information Write/modify primary variable range values Write primary variable unit Reset configuration change flag Set primary variable to zero You Provide STT Provides 6200 Programming Software Workstation Data Highway
Chapter 1 Introducing The Smart Transmitter Toolkit What You Need to Use The STT Subroutine You need these hardware and software components to integrate STT with your new or existing PLC-5 processor: Hardware (1 or more) 1770-HT1 Smart Communications Controller(s) (1 or more) 1770-HT8 or 177-HT16 Terminal Block(s) (1 or more) HART-compliant field device(s) Software PLC-5 6200 Programming Software (2 or more) PLC-5 data table files (1 or more ) PLC-5 programming file(s) PLC-5 integer data table file loca
Chapter 1 Introducing The Smart Transmitter Toolkit How a PLC 5 Processor Communicates With a HART Field Device PLC 5 Processor To help explain what the STT subroutine can do for you, let’s examine how communication occurs between a PLC processor and a HART field device. ➊ The PLC-5 processor sends a Smart Transmitter Interface packet to the 1770-HT1 as block-transfer write (BTW) data. ➋ The 1770-HT1 forwards the Smart Transmitter Interface packet as a HART packet to the HART field device.
Chapter 1 Introducing The Smart Transmitter Toolkit The PLC-5 processor sends and receives data from the 1770-HT1 as Smart Transmitter Interface Packets. The HART field device sends and receives data from the 1770-HT1 as HART packets. The 1770-HT1 converts the packets that it receives to the required format before transmitting the packets to their destination. This diagram illustrates the relationship between the two packets.
Chapter 1 Introducing The Smart Transmitter Toolkit How You Use The STT Subroutine We developed the STT Subroutine so that you can easily use a PLC-5 processor to communicate with a HART field device. Here’s how easy it is to use STT: 1. Read Chapter chapter 2, 2 then Installing install theThe software. Smart Transmitter Toolkit STT Subroutine 2. Chapter 3 Using The Smart Transmitter Toolkit Install the STT subroutine into your workstation and PLC-5 processor.
Chapter 2 Installing The Smart Transmitter Toolkit What's In This Chapter This chapter provides instructions for installing the Smart Transmitter Toolkit (STT). Important: Use 6200 programming software to install the STT subroutine into your PLC-5 processor. Before you begin, make sure your current program is loaded. To install the STT subroutine, you will: 1. Copy the STT subroutine file to the hard drive. 2. Create and name a new program file in your PLC-5 processor. 3.
Chapter 2 Installing The Smart Transmitter Toolkit 1. Copy STT Subroutine File to the Hard Drive A. Insert the STT disk into a floppy drive. B. Start at the 6200 Main Menu and press these keys: File Utils 6200 Main Menu F7 To/From Floppy From Floppy F9 F2 Processor Memory: Cut Rungs F7 You see: C. Use the cursor keys to highlight the STT100 file. D. To select the STT100 file as the source of the copy, press F3 Select Source. E. To begin the copy, press F1 Begin Oper.
Chapter 2 Installing The Smart Transmitter Toolkit 2. Create and Name a New Program File A. Start at the 6200 Main Menu and press these keys: 6200 Main Menu Online Prog F1 Offline Prog or Proc Func F3 F1 You see: B. To create a program file, press file number. C. To name the file, press F10 F6 Create Lad Fl Change Fl Name and then enter a and then enter a file name. We recommend that you use the filename STT_SUB. D. To go to the Program Directory, press Esc .
Chapter 2 Installing The Smart Transmitter Toolkit 3. Paste The STT Subroutine File A. Start at the Program Directory and press these keys: Program Directory Monitor File Edit Advanced Edit F8 F10 F8 Paste From Disk F8 You see: B. Use the cursor keys to highlight the STT100 file. C. To begin the paste, press F1 Begin Paste. The paste operation takes about 3 minutes. Since the STT subroutine uses indirect addressing, you may hear beeps during the paste operation. This is normal. D.
Chapter 2 Installing The Smart Transmitter Toolkit 4. Save Your Work (optional) A. Start at the Program Directory and press these keys: Program Directory Save Restore Save Program F2 F2 You see: B. If you want to change the name of the file, enter a new name. If you don’t enter a new name, the file is saved using the name that you see on the screen. C. To save the file, press F1 Begin Oper.
Chapter 2 Installing The Smart Transmitter Toolkit 5. Change The STT Default Data File (optional) You can move the STT subroutine data table file from its default location of N90. Important: Moving this file increases the chance of making errors while setting up your system and complicates the technical support of the STT subroutine because the file is not in its default location.
Chapter 3 Using The Smart Transmitter Toolkit What's In This Chapter Follow the instructions in this chapter to incorporate the STT subroutine into your ladder code and use the HART commands. 1. Create data table files. 2. Provide the STT subroutine inputs 3. Use the STT subroutine status word. 4. Call the STT subroutine. 5. Interpret the STT subroutine outputs. At the end of this chapter, you’ll find some programming examples. 1.
Chapter 3 Using The Smart Tranmsitter Toolkit Example of Newly Created Integer Data File Data Table Report Address N10:0 N10:10 N10:20 N10:30 N10:40 N10:50 N10:60 N10:70 N10:80 N10:90 N10:100 N10:110 N10:120 N10:130 N10:140 PLC–5/25 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 2 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 3 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 Addr 31 Data Table File N10:0 4 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 5 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 6 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 7 0 0 0 0 0 0
Chapter 3 Using The Smart Transmitter Toolkit 2. Provide The STT Subroutine Inputs All data that is used by the STT subroutine is obtained from the integer and floating point data files that you create for each HART field device. Before you make a call in your ladder logic to the STT, you must put the required data into these data files. There are two types of input data: Command-specific inputs are specific for each HART command. See appendix A. Standard inputs are required for every HART command.
Chapter 3 Using The Smart Tranmsitter Toolkit 3. Use The STT Subroutine Status Word The STT subroutine status word handshakes with your PLC ladder logic. The STT subroutine status word: tells you when the STT subroutine is entered and exited tells you when the STT subroutine is enabled and done lets you trigger the STT subroutine tells you when the STT subroutine errors The STT status word is integer word 30 of the integer file that is passed in with your JSR instruction.
Chapter 3 Using The Smart Transmitter Toolkit 4. Call The STT Subroutine Insert a JSR on an unconditional rung to call the STT subroutine. The JSR instruction includes one program file number and one input parameter. There are no return parameters. The program file number is the program file number where you installed the STT subroutine. For example, if you installed the STT subroutine into program file number 5, the JSR must call program file number 5.
Chapter 3 Using The Smart Tranmsitter Toolkit 5. Interpret The STT Subroutine Outputs Each HART command returns these outputs: Command-specific outputs returned for a specific HART command. See appendix A for more detail on the command specific outputs. Standard Outputs that are returned for every HART command. This table explains each of the seven standard outputs.
Chapter 3 Using The Smart Transmitter Toolkit Programming Example 1: Single HART Device With Single 1770 HT1 In this example, the primary variable is being read continuously from a single HART field device. PLC 5 Processor Smart Transmitter Interface 1770 HT1 RIO HART Field Device 1770 HT16 4-20 mA Loop Because we’re dealing with one device we can execute the JSR with a fixed device data file number.
Chapter 3 Using The Smart Tranmsitter Toolkit Example 1 (continued) Rung 2:0 STT 1.00 Programming Example 1. This example reads the primary variable from 1 HART field device wired to 1 1770-HT1. When the STT subroutine is not enabled, set the STT subroutine trigger bit. | STT enable STT trigger | | N10:30 N10:30 | +––––]/[–––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––(L)–––––+ | 1 3 | Rung 2:1 Call the STT subroutine unconditionally.
Chapter 3 Using The Smart Transmitter Toolkit Programming Example 2: Multiple HART Devices With Single 1770 HT1 In this example, the primary variable is read continuously from two HART field devices that are associated with one 1770–HT1 Communications Controller. You will notice that the example reads the primary variable from device 1 and then from device 2. If you want to talk to two HART field devices at the same time, you must use two 1770-HT1s.
Chapter 3 Using The Smart Tranmsitter Toolkit Example 2 (continued) Rung 2:0 STT 1.00 Programming Example 2 This example reads the primary variable from 2 HART field devices wired to 1 1770-HT1. If neither device is current, make device 1 the current device.
Chapter 3 Using The Smart Transmitter Toolkit Example 2 (continued) Rung 2:4 Only process when the STT subroutine is done. If the Hart command is 1, copy the primary variable to file F15. If the Hart command is 0, copy the Hart address to the input area and request Hart command 1. If device 1 does not respond (error 33), try getting a new Hart address for device 1 by requesting Hart command 0. Make device 2 the current device.
Chapter 3 Using The Smart Tranmsitter Toolkit Example 2 (continued) Rung 2:5 This rung is identical to 2:4 except it uses device 2. | Device 2 Device 2 | | Doing |Device 2 Hart Process | | Device 2 |STT Done Command # Variable | | B3 N12:30 +EQU–––––––––––––––+ +MOV–––––––––––––––+ | +––––] [––––––––] [–––––––––––––––++EQUAL +––+MOVE ++–+ | 2 2 ||Source A N12:5| |Source F13:10|| | | || 1| | –0.0260029|| | | ||Source B 1| |Dest F15:2|| | | || | | –0.
Chapter 3 Using The Smart Transmitter Toolkit Programming Example 3: Multiple HART Devices With Multiple 1770 HT1s In this example, the primary variable is read continuously from two HART field devices that are wired to separate 1770-HT1s. Communication with multiple 1770-HT1s can occur asynchronously when calling the STT subroutine.
Chapter 3 Using The Smart Tranmsitter Toolkit Example 3 (continued) Rung 2:0 STT 1.00 Programming Example 3. This example reads the primary variable from 2 HART field devices wired to 2 1770-HT1s. When the STT subroutine is not enabled, set the STT subroutine trigger bit. | Device 1 | | Device 1 STT | | STT enable trigger | | N10:30 N10:30 | +––––]/[–––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––(L)–––––+ | 1 3 | Rung 2:1 Call the STT subroutine unconditionally.
Chapter 3 Using The Smart Transmitter Toolkit Example 3 (continued) Rung 2:2 Only process when the STT subroutine is done. If the Hart command is 1, copy the primary variable to file F15. If the Hart command is 0, copy the Hart address to the input area and request Hart command 1. If device 1 does not respond (error 33), try getting a new Hart address for device 1 by requesting Hart command 0.
Chapter 3 Using The Smart Tranmsitter Toolkit Example 3 (continued) Rung 2:4 Call the STT subroutine unconditionally. | STT | | Subroutine | | +JSR–––––––––––––––+ | +–––––––––––––––––––––––––––––––––––––––––––––––––––––––––+JUMP TO SUBROUTINE+–+ | |Prog file number 5| | | |Input par 12| | | |Return par | | | +––––––––––––––––––+ | Rung 2:5 This rung is identical to 2:2 except it uses device 2.
Appendix A HART Command Data Table Layouts What's In This Appendix This appendix contains the data table layouts for the HART commands that are supported in the Smart Transmitter Toolkit (STT).
Appendix A HART Command Data Table Layouts HART Command 0 Use this command to read the HART address from a HART field device. Read HART Address Important: To use STT, you must include this command at least once in your program prior to any calls with other HART commands. This command returns the HART address of the HART field device. The HART address is used in all other HART commands.
Appendix A HART Command Data Table Layouts HART Command 0 Read HART Address Standard Outputs Integer Word 30 STT Subroutine Status Word Word 31 STT Subroutine Error Code Word 32 Smart Transmitter Interface Status Word Word 33 Smart Transmitter Interface Error Code Word 34 HART Protocol Communication Error Code Word 35 HART Command Response Summary Error Code Word 36 HART Field Device Error Code Command specific Outputs Integer Words 40 42 HART Address of HART field device Long Frame HAR
Appendix A HART Command Data Table Layouts HART Command 1 Use this command to read the primary variable and unit code from a HART field device. The primary variable is returned in floating-point format and the unit code is returned as an integer.
Appendix A HART Command Data Table Layouts HART Command 1 Read Primary Variable Standard Outputs Integer Word 30 STT Subroutine Status Word Word 31 STT Subroutine Error Code Word 32 Smart Transmitter Interface Status Word Word 33 Smart Transmitter Interface Error Code Word 34 HART Protocol Communication Error Code Word 35 HART Command Response Summary Error Code Word 36 HART Field Device Error Code Command specific Outputs Integer Word 40 Primary Variable Unit Code Floating point Word 10
Appendix A HART Command Data Table Layouts HART Command 3 Read Dynamic Variables & Primary Variable Current Use this command to read the primary variable current and up to four predefined dynamic variables from the HART field device. The primary variable current always matches the analog output current of the device including alarm conditions and set values. The secondary, tertiary, and 4th variables are defined by each device type.
Appendix A HART Command Data Table Layouts HART Command 3 Read Dynamic Variables & Primary Variable Current Standard Outputs Integer g Word 30 STT Subroutine Status Word Word 31 STT Subroutine Error Code Word 32 Smart Transmitter Interface Status Word Word 33 Smart Transmitter Interface Error Code Word 34 HART Protocol Communication Error Code Word 35 HART Command Response Summary Code Word 36 HART Field Device Error Code Command specific Outputs Integer g Floating point gp Data Table Rep
Appendix A HART Command Data Table Layouts HART Command 35 Use this command to write new upper and lower primary variable range values to the data memory of the HART field device. This command then outputs the actual upper and lower primary range values from the data memory of the HART field device. Write Primary Variable Range Values If the write operation was successful, you should see the same values that you entered.
Appendix A HART Command Data Table Layouts HART Command 35 Write Primary Variable Range Values Standard Outputs Integer g Word 30 STT Subroutine Status Word Word 31 STT Subroutine Error Code Word 32 Smart Transmitter Interface Status Word Word 33 Smart Transmitter Interface Error Code Word 34 HART Protocol Communication Error Code Word 35 HART Command Response Summary Code Word 36 HART Field Device Error Code Command specific Outputs Integer Word 40 Primary Variable Range Values Unit Code
Appendix A HART Command Data Table Layouts HART Command 38 Use this command to reset the configuration change flag.
Appendix A HART Command Data Table Layouts HART Command 38 Reset Configuration Change Flag Standard Outputs Integer g Data Table Report Address N10:0 N10:10 N10:20 N10:30 N10:40 N10:50 0 4 0 0 4 0 0 Word 30 STT Subroutine Status Word Word 31 STT Subroutine Error Code Word 32 Smart Transmitter Interface Status Word Word 33 Smart Transmitter Interface Error Code Word 34 HART Protocol Communication Error Code Word 35 HART Command Response Summary Code Word 36 HART Field Device Error Code PLC-
Appendix A HART Command Data Table Layouts HART Command 43 Use this command to trim the primary variable so that it reads zero with the existing process applied to the HART field device. The resulting offset must be within the limits defined by each device.
Appendix A HART Command Data Table Layouts HART Command 43 Set Primary Variable Zero Standard Outputs Integer g Data Table Report Address N10:0 N10:10 N10:20 N10:30 N10:40 N10:50 0 4 0 0 4 0 0 Word 30 STT Subroutine Status Word Word 31 STT Subroutine Error Code Word 32 Smart Transmitter Interface Status Word Word 33 Smart Transmitter Interface Error Code Word 34 HART Protocol Communication Error Code Word 35 HART Command Response Summary Code Word 36 HART Field Device Error Code PLC-5/25 1
Appendix A HART Command Data Table Layouts HART Command 44 Use this command to select the units in which the primary variable and the primary variable range will be returned by the HART field device. This command also selects the units for sensor limits and minimum span.
Appendix A HART Command Data Table Layouts HART Command 44 Write Primary Variable Units Standard Outputs Integer Word 30 STT Subroutine Status Word Word 31 STT Subroutine Error Code Word 32 Smart Transmitter Interface Status Word Word 33 Smart Transmitter Interface Error Code Word 34 HART Protocol Communication Error Code Word 35 HART Command Response Summary Code Word 36 HART Field Device Error Code Command specific Outputs Integer Word 40 Data Table Report Address N10:0 N10:10 N10:20 N10
Appendix B Codes What's In This Appendix This appendix contains the codes that you need to use the STT subroutine.
Appendix B Codes Smart Transmitter Interface Error Codes Integer Word 33 General Errors Code (decimal) Code (hex) 0 00 No Error The Smart Transmitter Interface processed the last received command, and no errors were detected. 1 01 Downloading Firmware The Smart Transmitter Interface firmware is being upgraded over the RS 232C port. The last received command cannot be processed.
Appendix B Codes HART Protocol Communication Error Codes Integer Word 34 Bit Error Code Description 7 Communications Error If set, the field device has detected a communications error. Bits 0 6 indicate the type of error. 6 Vertical Parity Error The parity of one or more of the bytes received by the HART field device is incorrect. 5 Overrun Error At least one byte of data in the receive buffer of the HART field device was over written before it was read.
Appendix B Codes HART Field Device Error Codes Integer Word 36 Bit Error Code Description 7 Field Device Malfunction An internal hardware error or failure has been detected by the HART field device. 6 Configuration Changed A write or set command has been executed on the HART field device. 5 Cold Start Power has been removed and reapplied resulting in the reinstallation of the setup information. The first HART command to recognize this condition automatically resets this flag.
Appendix B Codes Unit Codes Integer Words 10 and 40 Code Units 0 Undefined 1 inches H2O @ 68 degrees Fahrenheit 2 3 Recommended Abbreviation Code Units Recommended Abbreviation 35 Kelvin Kelvin InH20 36 millivolts mV inches Hg @ 0 degrees Celsius InHg 37 ohms Ohm feet H2O @ 68 degrees Fahrenheit FtH20 38 Hertz Hz 4 millimeters H2O @ 68 degrees Fahrenheit mmH2O 39 milliamperes mA 5 millimeters Hg @ 0 degrees Celsius mmHg 40 gallons gal 6 pounds/square inch psi 41
Appendix B Codes Unit Codes (continued) Integer Words 10 and 40 Code Units Recommended Abbreviation Code Units Recommended Abbreviation 72 grams/hour g/hr 108 proof/volume proof/vol 73 kilograms/second kg/s 109 proof/mass proof/mass 74 kilograms/minute kg/min 110 bushels bush 75 kilograms/hour kg/hr 111 cubic yards CuYd 76 kilograms/day kg/day 112 cubic feet CuFt 77 metric tons/minute MetTon/min 113 cubic inches CuIn 78 metric tons/hour MetTon/hr 114 undefined
Index Numbers Cornerstone software, 1 1 creating an STT program file, 2 3 1770 HT1, 1 3 1770 HT16, 1 3 D 1770 HT8, 1 3 6200 programming software, 1 3 A abbreviations, data file, changing the default, 2 6 ii digital data, 1 1 addressing long frame, 1 1 short frame, 1 1 E analog data, 1 1 audience, data analog, 1 1 digital, 1 1 examples inputs for HART command 0, 3 3 JSR, 3 5 outputs for HART command 0, 3 6 programming, 3 7, 3 9, 3 13 using the STT status word, 3 4 i B bits STT done, 3 4 STT e
I–2 Index HART Protocol communication error codes, B 3 I inputs command specific, 3 3 standard, 3 3 installing the STT, 2 1 copy STT subroutine to disk, 2 2 create and name a new program file, 2 3 paste the STT program file, 2 4 save the new STT program file, 2 5 integer word 30, STT subroutine status, 3 4 J JSR instruction, 3 5 L ladder logic, 3 5 long frame addressing, 1 1 N naming the STT program file, 2 3 read primary variable, A 4 read unique identifier, A 2 related publications, iii reset con
Allen Bradley has been helping its customers improve productivity and quality for 90 years. A B designs, manufactures and supports a broad range of control and automation products worldwide. They include logic processors, power and motion control devices, man machine interfaces and sensors. Allen Bradley is a subsidiary of Rockwell International, one of the world's leading technology companies. With major offices worldwide.
