1770-6.5.21, Smart Transmitter Toolkit, User Manual
Contents
1. a a Em Ei emn E 58885 o o a PLC 5 Processor Smart Transmitter Interface HART Field Device 4 20 mA Loop Because we re dealing with one device we can execute the JSR with a fixed device data file number In the course of operation if the device does not respond we reissue HART command 0 to try and get a new HART address for the device Important This example assumes that data table files N10 and F11 exist and N10 is populated with the standard inputs for HART command 0 prior to the execution of this logic The primary variable value is placed in F11 10 and the primary variable unit code is placed in N10 40 3 7 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 he Se ee ee ee ee ee bye 1 3 Rung 2 1 Call the STT subroutine unconditionally STT Subroutine CTUSBIU e e6ee I JUMP SUBROUTINE Prog file number 5 Input par 10 Return par 4p Rung 22. JUMP SUBROUTINE Prog file number 5 Input par 10 Return par 3 14 Chapter 3 Using The Smart Transmitter Toolkit Example 3 continued Rung 2 2 Only process when the STT subroutine is done the primary variable to file F15 If the Hart command address to the input area and request Hart command 1 respond error 33 Hart command 0 Device 1 Rung 2 3 This rung is identical to 2 0 Device 2 STT enable N12 30 Device 1 Device 1 Hart Process Command Variable TEQU Z St EQUAL Source N10 5 Source F11 10 0 0 000000 Source B 1 Dest li 0 000000 4R o4 Device 1 Device 1 Hart Hart Command Address EQU a Aim EQUAL COPY FILE Source N10 5 Source 3 N10 40 O lIDest N10 6 Source B 0 Length 3 Sa a ala Device 1 Hart Command MOVE Source 1 Dest N10 5 01 4 Device 1 Device 1 Not Hart Responding Command XEQUA Mee qoo EQUAL Source N10 33 Source 0 33 Source 33 Dest N10 5 0 except it uses device 2 Device 2
3. Programming Example 3 In this example the primary variable is read continuously from two HART Multiple HART Devices With field devices that are wired to separate 1770 HT1s Communication with Multiple 1770 HT1s multiple 1770 HT1s can occur asynchronously when calling the STT subroutine 1510 4 g 8 j TT ol 50 Bd ee 1 Li a PLC 5 Processor Smart Transmitter Interface HART Field Device 4 20 mA Loop HART Field Device 4 20 mA Loop In the course of operation if the field device does not respond we reissue HART command 0 to get the HART address This example assumes that each device data area is setup with the standard inputs for HART command 0 prior to the execution of this logic Device 1 uses N10 and F11 1 Device 2 uses N12 and F13 F15 contains both primary variable values 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 ITIU HIis 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 eee eee tees ee T eU IC UC Se ete ere Se oe ea E eec 1 3 Rung 2 1 Call the STT subroutine unconditionally STT Subroutine HU ORS MSS
4. Rung 2 6 END OF FILE 3 16 Appendix 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 If you want to Use Hart Command See page Read HART Address 0 A 2 Read Primary Variable 1 A 4 Read Dynamic Variables amp Primary Variable Current 3 AG 0 Write Primary Variable Range Values 35 A 8 Reset Configuration Change Flag 838 0 SetPimayVarableZero AMR Write Primary Variable Units 44 AM 0 Important All data table layout examples in this appendix are shown assuming that these conditions exist The 1770 is located at I O rack 4 and I O group 6 The HART field device is wired to channel of a 1770 8 or 1770 HT16 point to point polling address is 0 The HART field device uses a long frame address 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 Standard Inputs Integer Word 0 Rack Number of
5. Preface Using This Manual What s In This Preface This preface describes how to properly and efficiently use this manual ALLEN BRADLEY Smart Transmitter Toolkit It tells you about User Manual the purpose of this manual who should use this manual a how to use this manual eel reme abbreviations 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 Who Should Use This manual is intended for use by This Manual persons who install Smart Transmitter Interface products in connection with Allen Bradley PLC controllers or other intelligent controllers System integrators who design and establish network systems that involve plant floor machinery programmable controllers HART field devices Smart Transmitter Interface products and host computers We assume that you have strong working knowledge of your plant s process and equipment afamiliarity with personal computers MS DOS or PC DOS ControlView M and 6200 programming software Preface Using This Manual How To Use This Manual Read about the STT subroutine chapter 1 Terms Abbreviations Start by reading about the STT subroutine Then follow the instructions in chapter 2 to install the STT
6. 1 6 What to Do Next 1 6 Installing The Smart Transmitter Toolkit 2 1 What s In This 2 1 Before You 2 1 1 STT Subroutine File to the Hard Drive 2 2 2 Create and Name New Program File 2 3 3 Paste The STT Subroutine File 2 4 4 Save Your Work 25 5 Change The STT Default Data File optional 2 6 What s Next eR RE ede ode baw oe 2 6 Using The Smart Transmitter Toolkit 3 1 What s In This 38 1 1 Create Data Table 38 1 2 Provide The STT Subroutine Inputs 3 3 3 Use The STT Subroutine Status Word 3 4 4 Call The STT Subroutine 3 5 5 Interpret The STT Subroutine Outputs 3 6 Programming Example 1 Single HART Device With Single 1770 1 37 Programming Example 2 Multiple HART Devices With Single 1770 1 Programming Example 3 Multiple HART Devices With Multiple 1770 HT1s HART Command Data Table Layouts Whats In This Appendix HART Comm
7. Example 2 continued Device 2 STT Done N12 30 to 2 4 except it uses device 2 Device 2 Device 2 Hart Process Command Variable EQU 0 EQUAL Source 12 5 Source 13 10 11 0 0260029 Source B 1 Dest F15 2 0 0260029 R 4 Device 2 Device 2 Hart Hart Command Address EQU EQUAL COPY FILE Source A N12 5 Source 12 40 1 N12 6 Source B 0 Length 3 See ee rn a eae ee Device 2 Hart Command MOVE Source 1 Dest N12 5 11 Device 2 Device 2 Not Hart Responding Command IEOU Xo SMOV 25 EQUAL MOVE Source A N12 33 Source 0 0 Source 33 Dest N12 5 11 4 Doing Device 2 B3 BSS SSS SSS SSS SSS SSS SS SS SSS Up n 2 Doing Device 1 B3 peer EI Se eee 1 END OF FILE Chapter 3 Using The Smart Transmitter Toolkit
8. Invalid Selection The code or index was not allowed in this command or for this field device AI Too Few Data Bytes Received The message syntax was proper but the number of bytes contained in the message was less than required to execute the command AI Transmitter Specific An error occurred in a HART command for which a Command Specific Response Command Error Code is not defined Further information on this response code is available in each Transmitter Specific document Al Write Protect Mode The field device is Write Protected and cannot accept this write command AIO Warning Update Failure The real time data returned from the field device has not changed since the last time it was read 35 Lower Range Value too High The Lower Range Value was above the Upper Sensor Limit 43 Applied Process too High The process applied to the field device was too high 35 Applied Process too Low The process applied to the field device was too low 43 Lower Range Value too Low Lower Range Value was below the Lower Sensor Limit AIO Upper Range Value too High Upper Range Value was above the Upper Sensor Limit AI Upper Range Value too Low Upper Range Value was below the Lower Sensor Limit AIO Upper and Lower Range Both the Upper and Lower Range Values are beyond their limits Values Out of Limits AI Span too Small The Span as determined from the Upper and Lower Range Values was below the Minimum Span AI Access Restricte
9. N10 10 0 0 0 0 0 0 0 0 0 0 N10 20 0 0 0 0 0 0 0 0 0 0 N10 30 0 0 0 0 0 0 0 0 0 0 N10 40 0 0 0 0 0 0 0 0 0 10 50 0 0 0 0 0 0 0 0 0 0 These six integer words are the This is the HART address that is returned standard inputs that are required for from HART Command 0 see page A 3 each HART command see page 3 3 A 6 Appendix A HART Command Data Table Layouts HART Command 3 Read Dynamic Variables amp Primary Variable Current 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 41 Primary Variable Unit Code Word 42 Secondary Variable Unit Code Word 43 Tertiary Variable Unit Code Word 44 4th Variable Unit Code Floating point Word 10 Primary Variable Current Word 11 Primary Variable Word 12 Secondary Variable Word 13 Tertiary Variable Word 14 4th Variable Data Table Report PLC 5 25 Addr 31 Data Table File N10 0 Address 0 1 2 3 4 5 6 7 8 9 N10 0 4 6 3 0 16 3 9858 269 12807 0 N10 10 0 0 0 0 0 0 0 0 0 0 N10 20 0 0 0 0 0 0 0 0 0 0 N10 30 4 0 128 0 0 0 0 0 0 0 N10 40 0 32 250 250 250 0 0 0 0 0 N10 50 0 0 0 0 0 NC 0 0 0 These seven integer words are the standard outputs T i f the communications with These
10. Word 5 HART Command Number 35 Command specific Inputs Integer Words 6 8 HART Address from HART Command 0 Word 10 Primary Variable Range Values Unit Code Floating point Word 0 Primary Variable Upper Range Value Word 1 Primary Variable Lower Range Value Data Table Report PIC 5 25 Addr 31 Data Table File N10 0 Address 0 1 2 3 4 5 6 7 8 9 N10 0 4 6 3 0 16 35 9858 269 12807 0 N10 10 32 0 0 0 0 0 0 0 0 0 10 20 0 0 0 0 0 0 0 0 0 0 N10 30 0 0 0 0 0 0 0 0 0 N10 40 0 0 0 0 0 0 0 0 0 0 N10 50 0 0 0 0 0 0 0 0 0 0 This is the HART address that is returned These six integer words are the from HART Command 0 see page A 3 standard inputs that are required for each HART command see page 3 3 This integer word is a command specific input and contains the new unit code for the primary variable see page B 5 Data Table Report ente 5 25 Addr 31 Data Table File F11 0 Address 0 1 2 3 4 F11 0 100 0 0 0 0 0 0 mig 5 0 0 0 0 0 TORT ESO 0 0 0 0 0 5 0 0 0 0 0 These two floating point words are command specific inputs that contain the new upper and lower range values for the primary variable A 8 Appendix A HART Command Data Table Layouts HART Command 35 Write Primary Variable Range Values 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 Err
11. 2 Only process when the STT subroutine is done If the Hart command is 0 copy the Hart address to the input area and request Hart command 1 If the device does not respond error 33 try getting a new Hart address for the device by requesting Hart command 0 Hart Hart STT Done Command Address N10 30 EQU 4COP EQUAL FILE 2 Source A N10 5 Source N10 40 1 Dest N10 6 Source B 0 Length 311 l iic pedet litori Hart Command 4MOV MOVE Source 1 Dest N10 5 1 4 Device Not Hart Responding Command TEOU e LneIL WXEMOVeeLlceeseeeee EQUAL MOVE Source A N10 33 Source 0 0 Source B 33 Dest N10 5 11 R 4 Rung 2 3 HR A RPE RTP CREP SRS ST END OF FILE 3 8 Programming Example 2 Multiple HART Devices With Single 1770 HT1 Chapter 3 Using The Smart Transmitter Toolkit 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
12. STT trigger N12 30 L t 3 If the Hart command is 1 copy copy the Hart If device 1 does not is O0 try getting a new Hart address for device 1 by requesting 3 15 Chapter 3 Using The Smart Tranmsitter Toolkit Example 3 continued Rung 2 4 Call the STT subroutine unconditionally STT Subroutine 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 Device 2 Device 2 Device 2 Hart Process STT Done Command Variable N12 30 EQU be M ako oe ED EQUAL MOVE 2 Source A N12 5 Source F13 10 11 0 000000 Source B 1 Dest F15 2 0 000000 4 4 Device 2 Device 2 Hart Hart Command Address EQU 4COP EQUAL COPY FILE Source A N12 5 Source N12 40 11 Dest N12 6 Source B 0 Length 3 Device 2 Hart Command MOVE Source 1 Dest N12 5 11 Device 2 Device 2 Not Hart Responding Command 00 MOV EQUAL MOVE Source A N12 33 Source 0 2 Source 33 Dest N12 5 11 4
13. See chapter 3 for an explanation of the programming examples Since you install the STT subroutine using 6200 programming software you may want to obtain a copy of the PLC 5 Programming Software Programming Manual publication 6200 6 4 7 2 1 Chapter 2 Installing The Smart Transmitter Toolkit 1 Copy STT Subroutine A Insert the STT disk into a floppy drive File to the Hard Drive B Start at the 6200 Main Menu and press these keys To From Processor File Utils Floppy From Floppy Memory Cut Rungs 2 gt gt A You see PLC 5 PROGRAMMING SOFTWARE A 6200 Series Software Product FILE ELS STT160 Copyright 1986 1992 Allen Bradley Company Inc STT100E1 fill Rights Reserved STT100E2 STT100E3 Release 4 3 This software is licensed to Company Allen Bradley Location 625 Alpha Drive COPY RUNGS CUT FROM PROGRAMS SOURCE DRIVE A ESC exits Press a Function Key or Enter File Name gt Begin Select Enter Def ine Oper Source Path Dir ss F4 E C Use the cursor keys to highlight the STT100 file D To select the STT100 file as the source of the copy press Select Source E To begin the copy press n Begin Oper The operation is completed F Toreturn to the 6200 Main Menu press 2 2 2 Create and Name a New Program File A Chapter 2 Instal
14. device The Smart Transmitter Interface has not received a response from a field device after exhausting all retry attempts The Smart Transmitter Interface does not have data in its Burst Monitor Table for the requested channel Either the Smart Transmitter Interface was not commanded to monitor the channel for burst data or the field device is not in burst mode Bit Code 32 64 Error Code Communications Error Vertical Parity Error Overrun Error Framing Error Longitudinal Parity Error Appendix B Codes HART Protocol Communication Error Codes Integer Word 34 Description If set the field device has detected a communications error Bits 0 6 indicate the type of error The parity of one or more of the bytes received by the HART field device is incorrect At least one byte of data in the receive buffer of the HART field device was over written before it was read The stop bit of one or more bytes received by the HART field device was not detected The longitudinal parity calculated by the HART field device does not match the longitudinal parity byte at the end of the packet Reserved Set to 0 Buffer Overflow The packet is too long for the receive buffer of the HART field device Undefined Not defined at this time HART Command Response Summary Error Codes Integer Word 35 HART Command Code Definition Af No command specific errors errors were found in verifying the parameters for this command AI
15. four integer words are the command specific outputs that contain the status o that contain the unit codes for the variables see page B 5 the HART field device See page 3 6 Data Table Report PEC yas Addr 31 paca Table Pile ub Address 0 1 2 3 4 F11 0 0 0 0 0 0 F11 5 0 0 0 0 0 F11 10 7 29 20 58 0 0 0 7 0 0 0 B 0 0 This floating point word is a command specific These four floating point words are command specific outputs output that contains the primary variable current that contain the variables from the HART field device A 7 Appendix A HART Command Data Table Layouts HART Command 35 Use this command to write new upper and lower primary variable range Write Primary Variable Range values to the data memory of the HART field device This command then Values outputs the actual upper and lower primary range values from the data memory of the HART field device Ifthe write operation was successful you should see the same values that you entered Ifthe write operation was unsuccessful you will see the original values from the data memory of the field device These values may or may not be the same as the values that you entered Check the status and error codes Standard Inputs Integer Word 0 Rack Number of 1770 HT1 Word 1 Group Number of 1770 HT1 Word 2 Channel Number of HART field device Word 3 Polling Address of HART field device Word 4 Smart Transmitter Interface Command Number 16 decimal
16. operation takes about 3 minutes Since the STT subroutine uses indirect addressing you may hear beeps during the paste operation This is normal D To return to the Program Directory press 2 4 4 Save Your Work optional A Chapter 2 Installing The Smart Transmitter Toolkit Start at the Program Directory and press these keys Save Save Restore Program Program Directory D gt P mie You see 7 moms DIRECTORY FOR PROCESSOR EXAMPLE ONLINE 1 T5 File Hame Type Size words system 13 undef ined 2 USERMA ladder 1551 3 undef ined 4 undef ined 5 STT100 ladder 1145 SAVE PROCESSOR FILE File EXAMPLE ESC exits Press a function key or enter a file name H Program PLC 5 25 Series A Revision J 5 25 Addr 31 EXAMPLE Begin Display Define Oper Dirctry Dirctry KT F6 P 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 To save the file press Begin Oper Chapter 2 Installing The Smart Transmitter Toolkit 5 Change The STT Default You can move the STT subroutine data table file from its default location Data File optional 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 locat
17. subroutine Finally use chapter 3 and the appendices to help you incorporate the STT subroutine into your ladder logic See HART Command Data Table Layouts appendix A Install the STT Use the STT subroutine subroutine chapter 2 chapter 3 See Codes appendix B Some of the tasks described in this manual assume that you have an acquaintance with basic computer terminology For a glossary of terms related to Smart Transmitter Interface products see the Smart Transmitter Interface Products HART Protocol User Manual publication 1770 6 5 19 In this manual we use these abbreviations This abbreviation is for BTR Block transfer Read BTW Block transfer Write HART Highway Addressable Remote Transducer JSR Jump to Subroutine SIT Smart Transmitter Toolkit 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 screens that you see Program Directory that there is more information about the topic in another manual MORE Related Publications Allen Bradley Publications Publication Publication Number Smart Transmitter Interface Products HART Protocol User Manual 1770 6 5 19 PLC 5 Programming Software Programming Manual 6200 6 4 7 For a list of publications for Allen Bradley programmabl
18. 0 lt gt This is the HART address that is needed as an input to the other HART commands Words 40 42 PIMC 5 25 OWN 128 12807 CX O ion CCS D HART Address of HART field device Addr 31 Data Table File N10 0 lt gt lt os These seven integer words are the standard outputs that contain the status of the communications with the HART field device see page 3 6 iue 5 25 00 2 gt 70 2 3 3 TC Addr 31 Data Table File N10 0 ae 5 aoe e 1 Soe eo os These seven integer words the standard outputs that contain the status of the communications with the HART field device see page 3 6 A 3 Appendix A HART Command Data Table Layouts HART Command 1 Use this command to read the primary variable and unit code from a Read Primary Variable HART field device The primary variable is returned in floating point format and the unit code is returned as an integer Standard Inputs Integer Word 0 Rack Number of 1770 HT1 Word 1 Group Number of 1770 HT1 Word 2 Channel Number of HART field device Word 3 Polling Address of HART field device Word 4 Smart Transmitter Interface Command Number
19. 0 0 0 0 0 0 N10 50 0 0 0 0 0 0 0 0 0 0 This integer word is a command specific This is the HART address that is returned input that contains the new unit code for from HART Command 0 see page A 3 the primary variable see page B 5 These six integer words are the standard inputs that are required for each HART command see page 3 3 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 Primary Variable Unit Code Data Table Report PINCH 5 25 Addr 31 Data Table File N10 0 Address 0 1 2 3 4 5 6 7 8 9 N10 0 4 6 3 0 le 44 9858 298 TOUT 0 N10 10 0 0 0 0 0 0 0 0 0 0 N10 20 0 0 0 0 0 0 0 0 0 0 NI0 30 4 0 128 0 0 0 0 0 0 0 N10 40 32 0 0 0 0 0 0 0 0 0 N10 50 0 0 0 0 0 0 0 0 0 0 This integer word is the command specific output that should contain the unit code that you entered for the primary variable These seven integer words are the standard outputs that contain the status of the communications with the HART field device see page 3 6 A 15 What s In This Appendix STT Subroutine Error Codes Integer Word 31 Code Defi
20. 0 and F11 you need to place a 10 in data table location N90 0 and an 11 in data table location N90 1 Following is an explanation of how the data tables are used by the STT subroutine 3 1 Chapter 3 Using The Smart Tranmsitter Toolkit Example of Newly Created Integer Data File Data Table Report 25 Addr 31 Data Table File N10 0 A 2 222 2 2 gt 22 Z 22 zZ Z o ofo o ofo o o Off p ofo o ofo o o OOOO OO ofo o ON 20000000 Off o ofo 55 oaoa o o o OO Integer words 60 through 149 STT Subroutine Work Area Integer words 30 through 59 STT Subroutine Status and Output Area Integer words 0 through 29 User Input Area Example of Newly Created Floating point Data File Data Table Report PLC 5 25 Addr 31 Data Table File F11 0 Address 0 1 2 3 4 F11 0 0 0 0 0 0 F11 5 0 0 0 0 0 F11 10 0 0 0 0 0 F11 15 0 0 0 0 0 Floating point words 10 through 19 STT Subroutine Output Area Floating point words 0 through 9 User Input Area 3 2 Chapter 3 Using The Smart Transmitter Toolkit 2 Provide The STT All data that is used by the STT subroutine is obtained from t
21. 1 Smart Transmitter Interface error codes B 2 Smart Transmitter Interface packet 1 5 Smart Transmitter Toolkit features _1 1 software 1 3 6200 programming 1 3 ControlView _1 1 Cornerstone _1 1 qs standard inputs 3 3 standard outputs 3 6 STT done bit 3 4 STT enable bit 3 4 SIT enter exit bit 3 4 SIT error bit 3 4 STT subroutine error codes B 1 STT subroutine status word 30 3 4 STT trigger bit 3 4 terms ii U unit codes B 5 using the STT subroutine enter a JSR 3 5 using this manual ii W write PV range values 8 write PV units 14 ALLEN BRADLEY Allen Bradley has been helping its customers improve productivity and quality for 90 years A ROCKWELL INTERNATIONAL COMPANY 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 A With major offices worldwide 7 Algeria e Argentina e Australia e Austria Bahrain Belgium Brazil e Bulgaria e Canada Chile China PRC Colombia Costa Rica Croatia e Cyprus e Czech Republic e Denmark e Ecuador Egypt El Salvador e Finland e France Germany e Greece Guatemala e Honduras Hong Kong Hungary Iceland e India e Ind
22. 16 decimal Word 5 HART Command Number 1 Command specific Inputs Integer Words 6 8 HART Address of HART field device Data Table Report PIC 5 25 Addr 31 Data Table File N10 0 Address 0 1 2 3 4 5 6 7 8 9 N10 0 4 6 3 0 16 1 9858 269 12807 0 N10 10 0 0 0 0 0 0 0 0 0 0 N10 20 0 0 0 0 0 0 0 0 0 0 N10 30 0 0 0 0 0 0 0 0 0 N10 40 0 0 0 0 0 0 0 0 0 0 N10 50 0 0 0 0 0 0 0 0 0 0 This is the HART address that is returned These six integer words are the from HART Command 0 see page A 3 standard inputs that are required for each HART command see page 3 3 A 4 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 Primary Variable Data Table Report PCH 5 2 5 Addr 31 Data Table File N10 0 Address 0 1 2 3 4 5 6 7 8 9 10 0 4 6 3 0 16 1 9858 269 12807 0 10 10 0 0 0 0 0 0 0 0 0 0 N10 20 0 0 0 0 0 0 0 0 0 0 10 30 4 0 128 0 0 0 0 0 0 0 N10 40 32 0 0 0 0 0 0 0 0 0 10 50 T 0 0 0 0 0 0 0 0 0 0 This integer word is a command specific output that contains the unit code for the These s
23. 1770 HT1 Word 1 Group Number of 1770 HT1 Word 2 Channel Number of HART field device Word 3 Polling Address of HART field device Word 4 Smart Transmitter Interface Command Number 16 decimal Word 5 HART Command Number 0 Data Table Report Ie 5 25 Addr 31 Data Table File N10 0 Address 0 1 2 3 4 5 6 7 8 9 N10 0 4 6 3 0 16 0 0 0 0 0 N10 10 0 0 0 0 0 0 0 0 0 0 N10 20 0 0 0 0 0 0 0 0 0 0 N10 30 0 0 0 0 0 0 0 0 0 0 N10 40 0 0 0 0 0 0 0 0 0 0 N10 50 0 0 0 0 0 0 0 0 0 0 These six integer words are the standard inputs that are required for each HART command see page 3 3 A 2 Standard Outputs Integer Word 30 Word 31 Word 32 Word 33 Word 34 Word 35 Word 36 Appendix A HART Command Data Table Layouts HART Command 0 Read HART Address STT Subroutine Status Word STT Subroutine Error Code Smart Transmitter Interface Status Word Smart Transmitter Interface Error Code HART Protocol Communication Error Code HART Command Response Summary Error Code HART Field Device Error Code Command specific Outputs Integer Long Frame HART Address Data Table Report Address 0 N10 4 2200 0 0 4 8 N10 N10 NI Og N10 N10 0 120 30 40 985 50 2 gt gt This is the HART address that is needed as an input to the other HART commands Short Frame HART Address Data Table Report Address N10 N10 20 N10 N10 N10 N10 0 0 4 10 0 0 30 4 8 40 153 5
24. 6 short tons 2000 pounds day 7 long tons 2240 pounds hour 788 long tons 2240 pounds day 89 Undefined 90 specific gravity units 9 _ grams cubic centimeter 92 kilograms cubic meter 939 pounds gallon 94 pounds cubic foot 95 2 grams milliliter 96 2 kilograms liter 97 _ gramsjliter 98 pounds cubic inch 99 short tons 2000 pounds cubic yard 00 degrees Twaddell 7012 degrees Brix 102 degrees Baume heavy dO degrees Baume light d0 degrees API 705 _ percent solids weight 106 percent solids volume 107 degrees Balling B 6 Recommended Abbreviation g hr kg s kg min kg hr kg day MetTon min MetTon hr MetTon day Ib s Ib min Ib hr Ib day ShTon min ShTon hr ShTon day LTon hr LTon day SGU g CuCm kg CuMtr Ib gal Ib CuFt g ml kg l gil Ib Culn ShTon CuYd degTwad degBrix degBaum hv degBaum It degAPI sol wt sol vol degBall Code Units 108 proof volume 109 proof mass 110 bushels 111 cubic yards 112 cubic feet 113 cubic inches 114 undefined 119 undefined 120 121 undefined 129 undefined 130 cubic feet hour 131 cubic meters minute 132 barrels second 133 barrels minute 134 barrels hour 135 barrels day 136 gallons hour 137 imperial gallons second 138 liters hour 139 undefined 149 undefined 150 percent steam quality 151 feet in sixteenths 152 cubic feet pound 153 undefine
25. 7 3 9 3 13 using the STT status word 3 4 F features of STT 1 1 files data table 1 3 programming files 1 3 H hand held terminal 1 1 handshaking with PLC ladder logic 3 4 hardware 1 3 HART command response summary error codes B 3 HART commands 0 Read Unique Identifier A 2 1 Read Primary Variable 4 3 Read Dynamic Variables amp PV Current 6 35 Write PV Range Values 8 38 Reset Configuration Change Flag A 10 43 Set Primary Variable to Zero 12 44 Write PV Units A 14 HART field device error codes B 4 HART packet 1 5 Index HART Protocol communication error codes B 8 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 0 outputs command specific 3 6 standard 3 6 packets HART 1 5 Smart Transmitter Interface 1 5 pasting STT program file 2 4 PLC 5 processors 1 1 R read dynamic variables amp PV current A 6 read primary variable _A 4 read unique identifier A 2 related publications _ iii reset configuration change flag 10 S saving STT file 2 5 set primary variable to zero 12 short frame addressing 1
26. ALLEN BRADLEY NL Smart Transmitter Toolkit User Manual M 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 The illustrations charts sample programs and layout examples shown in this guide are intended solely for purposes of example Since there are many variables and requirements associated with any particular installation Allen Bradley does not assume responsibility or liability to include intellectual property liability for actual use based upon the examples shown in this publication Allen Bradley publication SGI 1 1 Safety Guidelines for the Application Installation and Maintenance of Solid State Control available from your local Allen Bradley office describes some important differences between solid state equipment and electromechanical devices that should be taken into consideration when applying products such as those described in this publication Reproduction of the contents of this copyrighted publication in whole or in part without written permission of Allen Bradley Company Inc is prohibited Throughout this manual we use notes to make you aware of safety consi
27. B3 VAS Se Sr a re ea a oe ee ee eee E 1 2 1 Rung 2 1 Set the device 1 STT subroutine trigger bit and load the JSR input variable for device 1 processing Device 1 Doing Device 1 STT Device 1 STT enable trigger B3 N10 30 N10 30 ET ase one Gea h X 2r 1 al 3 JSR Input Variable 4MOV MOVE Source 10 Dest N14 0 12 Rung 2 2 This rung is identical to 2 1 except it uses device 2 Device 2 Doing Device 2 STT Device 2 Device 2 STT enable trigger 2 B3 12 30 N12 30 SSS Sea Se LSS Shae 2 1 3 JSR Input Variable 4MOV MOVE Source 12 Dest N14 0 12 R Rung 2 3 Call the STT subroutine unconditionally STT Subroutine JSR JUMP SUBROUTINE Prog file number 5 Input par N14 0 Return par 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
28. Code Word 35 HART Command Response Summary Code Word 36 HART Field Device Error Code PLC 5 25 Addr 31 2 3 4 5 6 7 0 16 43 9858 269 0 0 0 0 0 0 0 0 0 0 0 0 128 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 Appendix HART Command Data Table Layouts HART Command 43 Set Primary Variable Zero Standard Outputs 8 12807 0 69 These seven integer words are the standard outputs that contain the status of the communications with the HART field device see page 3 6 Data Table File N10 0 ee Appendix A HART Command Data Table Layouts HART Command 44 Use this command to select the units in which the primary variable and the Write Primary Variable Units primary variable range will be returned by the HART field device This command also selects the units for sensor limits and minimum span Standard Inputs Integer Word 0 Rack Number of 1770 HT1 Word 1 Group Number of 1770 HT1 Word 2 Channel Number of HART field device Word 3 Polling Address of HART field device Word 4 Smart Transmitter Interface Command Number 16 decimal Word 5 HART Command Number 44 Command specific Inputs Integer Words 6 8 HART Address from HART Command 0 Word 10 Primary Variable Unit Code Data Table Report Inte 5 7 25 Addr 31 Data Table File N10 0 Address 0 1 2 3 4 5 6 7 8 9 N10 0 4 6 3 0 16 44 9858 269 12807 0 10 10 32 0 0 0 0 0 0 0 0 0 10 20 0 0 0 0 0 0 0 0 0 0 N10 30 0 0 0 0 0 0 0 0 N10 40 0 0 0 0
29. Software PLC resident Control Functions Your Application Program STT Data Tables and Subroutine Call 1 2 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 Workstation Data Highway Plus 510 E 8 E 4130 E e fl JUPE ls frre LI 8 PLC 5 Processor Smart Transmitter Interface EXE Field Devices 4 20 mA Loop STT Provides PLC 5 ladder logic subroutine that simplifies the communication between a PLC 5 processor and a HART field device What You Need to Use The STT Subroutine Why You Should Use The STT Subroutine Chapter 1 Introducing The Smart Transmitter Toolkit You need these hardware and software components to integrate STT with your new or existing PLC 5 processor Hardware lor more 1770 HT1 Smart Communications Controller s lor more 1770 HT8 o
30. This integer word contains the number of the Smart Transmitter Interface command Currently Command Number 16 the only supported command is 16 This command indicates that you want to send a HART decimal 10 Hex command to a HART field device Always place a 16 in word 4 of the integer data file Word 5 HART Command This integer word contains the number of the HART command that the STT subroutine generates and processes Valid values are 0 1 3 35 38 43 and 44 Every HART command except 0 requires the HART address returned by HART command 0 Example Inputs for HART Command 0 Data Table Report PLCS 5 25 Addr 31 Data Table File N10 0 Address 0 1 2 3 4 5 6 7 8 9 N10 0 4 6 3 0 16 0 0 0 0 0 N10 10 0 0 0 0 0 0 0 0 0 0 N10 20 0 0 0 0 0 0 0 0 0 0 N10 30 0 0 0 0 0 0 0 0 0 0 N10 0 0 0 0 0 0 0 0 0 0 N10 0 0 0 0 0 0 0 0 0 0 N10 0 indicates that the 1770 HT1 is located at I O rack 4 N10 1 indicates that the 1770 HT1 is located at I O group 6 N10 2 indicates that the HART field device is wired to channel 3 N10 3 indicates that the HART field device has a polling address of 0 N10 4 indicates that the Smart Transmitter Interface command is 16 for STT release 1 00 it is always 16 N10 5 indicates that this example is using HART command 0 3 3 Chapter 3 Using The Smart Tranmsitter Toolkit 3 Use The STT Subroutine The STT subroutine status word handshakes with your PLC ladder logic Status Word The STT subroutine sta
31. and 0 Read HART Address HART Command 0 Read HART 5 HART Command 1 Read Primary Variable HART Command 3 Read Dynamic Variables amp Primary Variable Current HART Command 3 Read Dynamic Variables amp Primary Variable Current HART Command 35 Write Primary Variable Range Values HART Command 35 Write Primary Variable Range Values HART Command 38 Reset Configuration Change 0 HART Command 38 Reset Configuration Change 0 HART Command 43 Set Primary Variable Zero HART Command 43 Set Primary Variable Zero HART Command 44 Write Primary Variable Units HART Command 44 Write Primary Variable Units Whats In This Appendix SIT Subroutine Error Smart Transmitter Interface Error Codes HART Protocol Communication Error Integer Word 34 HART Command Response Summary Error Codes Integer Word 35 Rae HART Field Device Error Codes Unit Codes Integer Words 10 40 ii Table of Contents
32. art Transmitter Interface packet and sends it to the 1770 HT1 The STT subroutine then takes the response from the 1770 and decodes the Smart Transmitter Interface packet to provide you with useful data For more information about communications with Smart Transmitter Interface products see the Smart Transmitter Interface Products HART Protocol User Manual publication 1770 6 5 19 Chapter 1 Introducing The Smart Transmitter Toolkit How You Use The STT We developed the STT Subroutine so that you can easily use a PLC 5 Subroutine processor to communicate with a HART field device Here s how easy it is to use STT 1 Install the STT subroutine into your workstation and PLC 5 processor Chapter 2 TE zl apter Installing The Smart a Transmitter Toolkit 1 du mm 14540 ST Subroutine 2 Customize your PLC 5 ladder logic to use the STT subroutine a Allocate data blocks in your PLC 5 processor Chapter 3 for each HART field device in your system m o H b Enter a JSR instruction in your ladder logic E program for each 1770 HT1 in your system When you ve completed these steps you re ready to use the STT subrouti
33. d 159 undefined 160 percent Plato 161 undefined 249 undefined 250 251 reserved 252 reserved 253 special 254 reserved 255 reserved Recommended Abbreviation proof vol proof mass bush CuYd CuFt Culn mtr hr CuFt hr CuMtr min bbl sec bbl min bbl hr bbl day gal hr ImpGal sec Stm Qual Ft In16 plato Numbers 1770 HT1 1 3 1770 HT16 1 3 1770 HT8 1 3 6200 programming software 1 3 A abbreviations _ ii addressing long frame 1 1 short frame 1 1 analog data 1 1 audience _ i bits SIT done 3 4 SIT enable 3 4 STT enter exit 3 4 STT error 3 4 STT trigger 3 4 block transfer read 1 4 block transfer write 1 4 C changing the STT default data file 2 6 codes HART command summary response error B 3 HART field device errors B 4 HART Protocol communication errors B 3 Smart Transmitter Interface errors B 2 STT Subroutine Error B 1 units B 5 command specific inputs 3 3 command specific outputs 3 6 communications 1 4 configuring HART field devices 1 1 ControlView software 1 1 conventions in this manual iii copying STT subroutine 2 2 Index Cornerstone software 1 1 creating an STT program file 2 3 D data analog 1 1 digital 1 1 data file changing the default 2 6 digital data 1 1 E examples inputs for HART command 0 3 3 JSR 3 5 outputs for HART command 0 3 6 programming 3
34. d The command was rejected due to a condition within the Field Device which would prevent proper execution AIC Busy The device is performing a function that cannot be interrupted by this command AI Command not implemented The command was not defined for this device This code applies to all HART commands that are supported by this release of the Smart Transmitter Toolkit 0 1 3 35 38 43 and 44 B 3 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 This flag may also be set following a master reset or self test 4 More Status Available More status information is available and can be read using HART command 48 Read Additional Status Information Note HART command 48 is not supported by the STT subroutine 3 Primary Variable Analog Output Fixed The analog and digital outputs for the primary variable are held at their requested value They will not respond to the applied process 2 Primary Variable Analog Output Saturated The analog and digital outputs for the primary variables are beyond their lim
35. derations circumstances that can lead to personal injury or death property ATTENTION Identifies information about practices or damage or economic loss Attention statements help you to identify a hazard avoid the hazard recognize the consequences Important Identifies information that is critical for successful application and understanding of the product Table of Contents Using This Whats In This Preface A Purpose of This Manual Who Should Use This Manual _i How To Use This Manual ii _ii Abbreviations Conventions iii Related 5 iii SIT Software License ii Introducing The Smart Transmitter Toolkit 1 1 What s In This 1 1 What s The Smart Transmitter 1 1 What You Get With The STT Subroutine 1 2 What You Need to Use The STT Subroutine 1 3 Why You Should Use The STT Subroutine 1 3 How a PLC 5 Processor Communicates With a HART Field Device 1 4 How You Use The STT Subroutine
36. e 3 6 Appendix A HART Command Data Table Layouts HART Command 43 Use this command to trim the primary variable so that it reads zero with Set Primary Variable Zero the existing process applied to the HART field device The resulting offset must be within the limits defined by each device Standard Inputs Integer Word 0 Rack Number of 1770 HT1 Word 1 Group Number of 1770 HT1 Word 2 Channel Number of HART field device Word 3 Polling Address of HART field device Word 4 Smart Transmitter Interface Command Number 16 decimal Word 5 HART Command Number 43 Command specific Inputs Integer Words 6 8 HART Address from HART Command 0 Data Table Report 8100 57 25 Addr 31 Data Table File N10 0 Address 0 1 2 3 4 5 6 7 8 9 N10 0 4 6 3 0 16 43 9858 269 12807 0 10 10 0 0 0 0 0 0 0 0 0 0 10 20 0 0 0 0 0 0 0 0 0 0 N10 30 0 0 0 0 0 0 0 0 0 0 N10 40 0 0 0 0 0 0 0 0 0 10 50 0 0 0 0 0 0 0 0 0 0 These six integer words are the This is the HART address that is returned standard inputs that are required for from HART Command 0 see page A 3 each HART command see page 3 3 Integer Data Table Report Address MLO N10 20 N10 N10 N10 N10 0 10 30 40 50 gt Sou CY ca Co Soon 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
37. e controller products see the Automation Group Publication Index publication SD499 HART Publications Publication Reference Number and Date HART Smart Communications Revision 5 1 January 4 1991 Protocol Specification Rosemount Inc Document No D9000047 Revision A STT Software License STT is not a licensed software product It is provided to help you quickly communicate with HART field devices Please feel free to use this software on any and all machines that you have iii What s In This Chapter What s The Smart Transmitter Toolkit HART Universal Commands The functions performed by these commands are performed by all HART devices HART Common practice Commands The functions performed by these commands may not be possible for all HART devices HART Transmitter specific Commands Only one or at most a few HART devices implement these functions The functions performed by these commands allow each device type to implement their own commands for special functions calibration and special data handling Refer to the product manual for your HART field device for a list of supported commands Introducing The Smart Transmitter Toolkit This chapter gives you an overview of the Smart Transmitter Toolkit that you received with your Smart Transmitter Interface cat no 1770 HT1 The Smart Transmitter Toolkit STT is a PLC 5 ladder logic subroutine utility that saves development time by simplifying the communicat
38. even integer words are the standard outputs primary variable see page B 5 that contain the status of the communications with the HART field device see page 3 6 Data Table Report 5 215 Agar 22 Data Table File F11 0 Address 0 1 2 3 4 F11 0 0 0 0 0 0 F11 5 0 0 0 0 0 F11 10 20 58 0 0 0 0 0 0 0 0 0 This floating point word is a command specific output that contains the primary variable A 5 Appendix A HART Command Data Table Layouts HART Command 3 Use this command to read the primary variable current and up to four Read Dynamic Variables amp Primary predefined dynamic variables from the HART field device Variable Current 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 For example the secondary variable is the sensor temperature for the 3051 pressure transmitter Standard Inputs Integer Word 0 Rack Number of 1770 HT1 Word 1 Group Number of 1770 HT1 Word 2 Channel Number of HART field device Word 3 Polling Address of HART field device Word 4 Smart Transmitter Interface Command Number 16 decimal Word 5 HART Command Number 3 Command specific Inputs Integer Words 6 8 HART Address of HART field device Data Table Report PI 9 5 25 Addr 31 Data Table File N10 0 Address 0 1 2 3 4 5 6 7 8 9 N10 0 4 6 3 0 16 3 9858 269 12807 0
39. he integer and Subroutine Inputs 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 This table explains each of the six standard inputs Standard Inputs Integer Word 0 Rack Number of This integer word contains the I O rack number of the 1770 HT1 that is connected to the HART 1770 HT1 field device Valid values are 1 through 7 Word 1 Group Number of This integer word contains the I O group number of the 1770 HT1 that is connected to the 1770 HT1 HART field device Valid values are 0 2 4 and 6 Word 2 Channel Number of This integer word contains the channel on the 1770 HT8 or the 1770 HT16 that is wired to the field device HART field device Valid values are 1 through 32 Word 3 Polling Address of HART This integer word contains the polling address of the HART field device Use a Rosemount 268 field device Handheld terminal or Cornerstone software to configure this address If you are wired point to point the polling address is 0 zero e multi drop the polling address is 1 through 15 Note Most HART field devices come from the factory with a default polling address of zero Word 4 Smart Transmitter Interface
40. hem from the original files What s Next You are finished installing the STT subroutine Proceed to the next chapter for instructions on using the STT subroutine in your ladder logic 2 6 What s In This Chapter 1 Create Data Table Files Integer word 16 bits Floating point word 32 bits Using The Smart Transmitter Toolkit 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 In your PLC 5 processor create one integer and one floating point file for each HART field device Each integer file must be 150 integer words minimum 0 through 149 Each floating point file must be 20 floating point words minimum 0 through 19 In addition the floating point file must be the data file that immediately follows the integer data file For example if the integer file is N10 the floating point file must be F11 Important The STT utility uses integer data file N90 for indirect addressing Do not use this data file for a HART field device data table file Since the STT subroutine uses N90 0 and N90 1 for indirect addressing you must place valid file numbers in N90 0 and N90 1 For example if you created N1
41. ing Address of HART field device Word 4 Smart Transmitter Interface Command Number 16 decimal Word 5 HART Command Number 38 Command specific Inputs Integer Words 6 8 HART address from HART Command 0 Data Table Report intei 8 225 Addr 31 Data Table File N10 0 Address 0 1 2 3 4 5 6 7 8 9 10 0 4 6 3 0 16 38 9858 269 12807 0 10 10 0 0 0 0 0 0 0 0 0 0 N10 20 0 0 0 0 0 0 0 0 0 0 N10 30 0 0 0 0 0 0 0 0 0 0 10 40 0 0 0 0 0 0 0 0 0 N10 50 0 0 0 0 0 0 0 0 0 0 These six integer words are the This is the HART address that is returned standard inputs that are required for from HART Command 0 see page A 3 each HART command see page 3 3 Appendix A HART Command Data Table Layouts HART Command 38 Reset Configuration Change Flag 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 Data Table Report PILE 5 25 Addr 31 Data Table File N10 0 Address 0 1 2 3 4 5 6 7 8 9 N10 0 4 6 3 0 16 38 9858 20 12807 0 N10 10 0 0 0 0 0 0 0 0 0 0 N10 20 0 0 0 0 0 0 0 0 0 0 N10 30 4 0 128 0 0 0 0 0 0 0 N10 40 0 0 0 0 0 0 0 0 0 0 N10 50 0 0 0 0 0 0 0 0 0 0 These seven integer words are the standard outputs that contain the status of the communications with the HART field device see pag
42. ion We recommend that you only attempt this procedure if you are experienced in ladder logic programming and using 6200 programming software The STT subroutine uses indirect addresses in block transfer instructions You cannot use 6200 programming software to edit cut copy paste block transfer instructions that use indirect addressing or to search for file references that use indirect addressing To move the file follow these steps A Use the 6200 file utilities to export the processor memory file and comments symbols Make sure that you export all the different types of comments address rung instruction etc The exported program file has a 5 extension The exported comments symbols file has a TXT extension For more information about using 6200 file utilities see PLC 5 M Programming Software Programming Manual publication 6200 6 4 7 B Use an ASCII text editor to make the changes as described below Moving the STT Data Table File From N90 a Editthe PC5 file b Search for all occurrences of integer file number N90 and change to the new integer file number c Savethe changes and close the file d Edit the TXT file e Search for all occurrences of integer file number N90 and change to the new integer file number f Savethe changes and close the file C Import the modified processor memory file and comments symbols file Use a different name for the imported files to distinguish t
43. ion among Allen Bradley PLC 5 processors Allen Bradley Smart Transmitter Interfaces and HART compliant field devices such as a smart transmitter or actuator V The STT subroutine provides a shell that lets you use a PLC processor to communicate with a HART field device without having detailed knowledge of the HART protocol V The STT subroutine supports the HART commands that are most commonly used with PLC processors The STT subroutine does not support vendor specific HART commands such as totalization V STT focuses on digital data that is associated with the HART protocol Use Allen Bradley Analog I O modules to acquire 4 20mA analog data V STT does not include faceplates or operator interface screens However you can configure operator interface software such as Control View software to display modify data that is received sent to the STT subroutine STT supports HART Universal Commands 0 1 and 3 HART Common Practice Commands 35 38 43 and 44 Both long and short frame addressing Both point to point and multi drop configurations Allen Bradley PLC 5 processors Important Do not view STT as a configuration tool We assume you take the appropriate steps to configure and calibrate the HART field device using either Cornerstone software or a hand held terminal Chapter 1 Introducing The Smart Transmitter Toolkit What You Get With The STT Subroutine You Provide 6200 Programming
44. is using HART command 0 there is no input data in the floating point file JSR JUMP TO SUBROUTINE Prog file number 5 Input par 10 Return par 3 5 Chapter 3 Using The Smart Tranmsitter Toolkit 5 Interpret The STT Each HART command returns these outputs Subroutine 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 Standard Outputs Integer Word 30 STT Subroutine Status Word All handshaking with the STT subroutine is done with the STT status word see page 3 4 Word 31 STT Subroutine Error Code This word contains any error code returned by the STT subroutine Word 32 Smart Transmitter Interface On powerup the Smart Transmitter Interface sets bit 7 to a 1 All other bits are set to 0 Status Word Therefore the value for word 32 is 128 decimal The STT utility does not provide any way to reset bit 7 to a zero Therefore bit 7 is always set to 1 in word 32 Word 33 Smart Transmitter Interface This word contains any error code returned by the 1770 HT1 Error Code Word 34 HART This word contains information that pertains to the reception of a message by a device Protocol Communication Error An error in this word indicates that the HART transmitter detected a communications Code error and the message was
45. its and no longer represent the true applied process 1 Non Primary Variable Out of Limits The process applied to a sensor other than that of the Primary Variable is beyond the operating limits of the device To identify the variable use command 48 Read Additional Status Information 0 Primary Variable Out of Limits The process applied to the sensor for the primary variable is beyond the operating limits of the device B 4 Code 0 A 10 11 12 13 14 15 16 17 18 19 21 22 23 Sa 25 26 27 28 29 30 31 rm E S We Units Undefined inches 2 9 68 degrees Fahrenheit inches Hg 0 degrees Celsius feet HoO 9 68 degrees Fahrenheit millimeters H2O 68 degrees Fahrenheit millimeters Hg 0 degrees Celsius pounds square inch bars millibars grams square centimeter kilograms square centimeter pascals kilopascals torr 0 degrees Celsius atmospheres cubic feet minute gallons minute liters minute imperial gallons minute cubic meters hour feet second meters second gallons second million gallons day liters second million liters day cubic feet second cubic feet day cubic meters second cubic meters day imperial gallons hour imperial gallons day degrees Celsius degrees Fahrenheit degrees Rankine Recommended Abbreviation InH50 InHg 20 m
46. ling The Smar ransmitter Toolkit Start at the 6200 Main Menu and press these keys Online Prog Offline Prog Proc Func meth gt 0 Main Menu gt oF m You see T gsm DIRECTORY FOR PROCESSOR EXAMPLE ONLINE N File Name Type Size Cwords system 9 1 undef ined 2 USERMAIN ladder 1551 Press a function key or enter file number or name u Program PLC 5725 Series Revision J Change Change Clear Delete Create Create Mode Passurd Memory File Lad Fl Fl Si FZ F4 F5 F6 5 25 Addr 31 EXAMPLE Monitor Rename Change File Proc Fl Name r3 i To create a program file press s Create Lad F1 and then enter a file number To name the file press Change F1 Name and then enter file name We recommend that you use the filename 5 SUB To go to the Program Directory press lt 2 3 Chapter 2 Installing The Smart Transmitter Toolkit 3 Paste The STT A Start at the Program Directory and press these keys Subroutine File Monitor File Edit Advanced Edit Paste From Disk Program 4 1 Em gt 2 e gt You see Enter the paste file name File 5 Rung 92 B Program Forces None Edits None 5 25 Addr 31 EXAMPLE Begin Documnt Symbol Begin Paste Mode Mode View Fi r5 F6 F10 B Use the cursor keys to highlight the STT100 file C begin the paste press Begin Paste The paste
47. mH 0 mmHg psi bars mbar g SqCm kg SqCm PA kPA torr ATM CuFt min gal min l min ImpGal min CuMtr hr ft s mtr s gal s MilGal day 5 MilL day CuFt s CuFt day CuMtr s CuMtr day ImpGal hr ImpGal day degC degF degR Appendix B Codes Code Units 35 Kelvin 36 millivolts 37 ohms 38 Hertz 39 milliamperes 40 gallons 41 liters 42 imperial gallons 43 cubic meters 44 feet 45 meters 46 barrels 47 inches 48 centimeters 49 millimeters 50 minutes 51 seconds 52 hours 53 days 54 Undefined 55 centipoise 56 microsiemens 57 percent 58 volts 59 pH 60 grams 61 kilogram 62 metric tons 63 pounds 64 short tons 2000 pounds 65 long tons 2240 pounds 66 Undefined 69 Undefined 70 grams seconds 71 grams minute Unit Codes Integer Words 10 and 40 Recommended Abbreviation Kelvin mV Ohm Hz mA gal liter ImpGal CuMtr meter bbl cm mm min sec hr day cpoise uSiemen V pH grams kg MetTon Ib ShTon LTon 0 5 g min B 5 Appendix B Codes Unit Codes continued Integer Words 10 and 40 Code Units grams hour qu 5 kilograms second 74 kilograms minute 7 kilograms hour 76 kilograms day 77 metric tons minute 78 metric tons hour 79 metric tons day 80 pounds second a pounds minute 20 pounds hour 785 pounds day 784 short tons 2000 pounds minute 78 short tons 2000 pounds hour 78
48. ne What to Do Next Go to chapter 2 to begin installing the Smart Transmitter Toolkit What s In This Chapter Before You Begin MORE Installing The Smart Transmitter Toolkit 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 Copy the STT subroutine file to the hard drive Create and name a new program file in your PLC 5 processor Paste the STT subroutine file into the new program file Save your work optional Uv ue vta c pem Change the data table defaults optional Important The STT subroutine uses three fixed word addresses N90 0 through N90 2 When you paste the STT subroutine these three addresses are created If these addresses are already in use and cannot be freed up for the STT Subroutine you need to change the data table defaults If you need to make these changes do step 5 The rest of this chapter contains the instructions for completing these steps You need this diskette to install the STT subroutine This diskette contains these paste files Smart Transmitter Toolkit e STT100 CR5 the STT subroutine Disi Tof e STT100E1 CR5 programming example 1 e STT100E2 CR5 programming example 2 e STT100E3 CR5 programming example 3
49. nition 1 Block transfer write BTW error 2 Block transfer read BTR error Appendix Codes This appendix contains the codes that you need to use the STT subroutine For this list STT Subroutine Error Codes Smart Transmitter Interface Error Codes HART Protocol Communication Error Codes HART Command Response Summary Error Codes HART Field Device Error Codes Unit Codes Integer Word 31 33 34 35 36 10 40 See page B 1 B 2 B 3 B 3 B4 B 5 Appendix B Codes Smart Transmitter Interface Error Codes Integer Word 33 General Errors Code decimal Code hex 0 00 1 01 2 02 3 03 Command Errors Code decimal Code hex 16 10 17 11 18 12 19 13 20 14 21 15 22 16 Device Errors Code decimal Code hex 32 20 33 21 34 22 B 2 Definition No Error Downloading Firmware No Corresponding BTW Command Still in Progress Definition Invalid Command Invalid Channel Number Invalid HART Message Invalid Channel List Invalid Parameter Invalid Control Invalid DF1 Packet Length Definition Burst Mode Device Not Communicating No Response Received From Device No Valid Burst Data Description The Smart Transmitter Interface processed the last received command and no errors were detected The Smart Transmitter Interface firmware is being upgraded over the RS 232C port The last received command cannot be processed The Smart Transmitter Interface received a BTR but does no
50. not accepted The response data is not returned when errors are reported Word 35 HART Command Response This word contains information relative to the execution of a HART command This error Summary Error Code code is command dependent Word 36 HART Field Device Error This word contains information that pertains to the operating status of the HART device Code as a whole and is not associated with the completion of any HART command See appendix B for a list of error codes Example Outputs for HART Command 0 Data Table Report 25 Addr 31 Data Table File N10 0 Address 0 1 2 3 4 5 6 7 8 9 N10 0 4 6 3 0 16 0 0 0 0 0 N10 10 0 0 0 0 0 0 0 0 0 0 N10 20 0 0 0 0 0 0 0 0 0 0 N10 30 4 0 128 0 0 0 0 0 0 0 N10 40 9858 269 12807 0 0 0 0 0 0 0 N10 50 0 0 0 0 0 0 0 0 0 These three integer words These seven integer words contain the status of are the HART address the STT subroutine and the communications with the HART field device Important We used this example because every ladder program must have a JSR instruction and all HART communications must start with HART command 0 Every HART command except HART command 0 requires the HART address 3 6 Chapter 3 Using The Smart Transmitter Toolkit Programming Example 1 In this example the primary variable is being read continuously from a Single HART Device With single HART field device Single 1770 HT1 a3 0 jio 80
51. onesia Israel e Italy e Jamaica e Japan e Jordan Korea e Kuwait e Lebanon Malaysia Mexico New Zealand Norway Oman e Pakistan Peru Philippines e Poland Portugal Puerto Rico Qatar e Romania Russia CIS e Saudi Arabia Singapore e Slovakia e Slovenia e South Africa Republic e Spain e Switzerland e Taiwan e Thailand The Netherlands Turkey United Arab Emirates United Kingdom e United States Uruguay Venezuela e Yugoslavia World Headquarters Allen Bradley 1201 South Second Street Milwaukee WI 53204 USA Tel 1 414 382 2000 Fax 1 414 382 4444 Publication 1770 6 5 21 March 1994 PN 95511697 Copyright 1994 Allen Bradley Company Inc Printed in USA
52. or 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 Floating point Word 10 Primary Variable Upper Range Value Word 11 Primary Variable Lower Range Value Data Table Report PIMC 5 72 5 Addr 31 Data Table File N10 0 Address 0 1 2 3 4 5 6 7 8 9 N10 0 4 6 3 0 16 35 9858 269 12807 0 N10 10 0 0 0 0 0 0 0 0 0 0 N10 20 0 0 0 0 0 0 0 0 0 0 N10 30 4 0 128 0 0 0 0 0 0 0 N10 40 32 0 0 0 0 0 0 0 0 0 N10 50 0 0 0 0 0 0 0 0 0 0 This integer word is a command specific output These seven integer words are the standard outputs that should contain the unit code that you that contain the status of the communications with entered for the primary variable see page B 5 the HART field device see page 3 6 Data Table Report 8 5 Addr 31 Data Table File F11 0 Address 0 1 2 3 4 TLO 100 0 0 0 0 0 0 01199 0 0 0 0 0 F11 10 100 0 0 0 0 0 0 iii gib 0 0 0 0 0 These two floating point words are command specific outputs that should contain the new upper and lower range values that you entered for the primary variable A 9 Appendix A HART Command Data Table Layouts HART Command 38 Use this command to reset the configuration change flag Reset Configuration Change Flag Standard Inputs Integer Word 0 Rack Number of 1770 HT1 Word 1 Group Number of 1770 HT1 Word 2 Channel Number of HART field device Word 3 Poll
53. r 177 HT16 Terminal Block s lor more HART compliant field device s Software PLC 5 6200 Programming Software 2 or more PLC 5 data table files lor more PLC 5 programming file s PLC 5 integer data table file locations N90 0 N90 1 and N90 2 The STT subroutine greatly simplifies sending and receiving data to and from HART field devices Without STT the ladder developer must V Format each command from the HART specification using the Smart Transmitter Interface protocol V Understand HART protocol internals such as long frame addressing vs short frame addressing and byte swapping for word alignment V Parse HART command responses for data v Convert IEEE 754 data to floating point data V Synchronize BTWs with BTRs With STT the ladder developer must only V Configure a data block V Make the appropriate call to the STT subroutine Chapter 1 Introducing The Smart Transmitter Toolkit How a PLC 5 Processor To help explain what the STT subroutine can do for you let s examine how Communicates With a HART communication occurs between a PLC processor and a HART field device Field Device The PLC 5 processor sends a Smart Transmitter Interface packet to the 1770 HT1 as block transfer write BTW data The 1770 forwards the Smart Transmitter Interface packet a HART packet to the HART field device The HART field device receives the HART packet and then responds back
54. respond error 33 try getting a new Hart address for device 1 by requesting Hart command 0 Make device 2 the current device Device 1 Device 1 Doing Device 1 Hart Process Device 1 STT Done Command Variable B3 N10 30 EQU 4 EQUAL MOVE 1 2 Source N10 5 Source F11 10 1 0 5372856 Source B 1 Dest F15 1 0 5372856 To 4 t Device 1 Device 1 Hart Hart Command Address FEQU a Aim EQUAL COPY FILE Source N10 5 Source 3 N10 40 11 N10 6 Source B 0 Length 3 Sa a ala al ol Device 1 Hart Command MOVE Source 1 Dest N10 5 1 4 Device 1 Device 1 Not Hart Responding Command EQU o MOV EQUAL MOVE Source A N10 33 Source 0 0 Source 33 Dest N10 5 11 4 Doing Device 1 B3 e neos Doing Device 2 B3 oS SSH SSSR Se Shae SH SE Se SS SSeS 2 Device 2 2 JMP 3 11 Chapter 3 Using The Smal anmsitter Toolkit 3 12 Rung 2 5 This rung is identical Doing Device 2 B3
55. rrent HART field device For example if you created N10 and F11 for your HART field device the input parameter would be 10 When the STT routine is called by your ladder logic it generates the specified HART command from the data that you provided in the integer and floating point data files After generating a properly formatted HART command the STT subroutine executes a BTW followed by a BTR to execute the command just generated It then reformats the returned data and places the outputs in the locations specific to that HART command See appendix A for more detail on the command specific outputs Because of the nature of enabling and finishing BTWs BTRs it takes three calls minimum to the STT subroutine to obtain the outputs from the HART command This is a description of the steps that occur in each of the three passes through the STT subroutine 2nd Pass 3rd Pass sets the enter exit bit to 1 sets the enter exit bit to 1 e finishes the BTW finishes the BTR initiates a BTR produces outputs generates the HART command sets the enter exit bit to 0 and returns sets the done or error bit to 1 specified in integer word 5 initiates a BTW sets the enable bit to 0 sets the enter exit bit to 0 and returns sets the enter exit bit to 0 and returns Example In this example the JSR calls the STT subroutine unconditionally The STT subroutine looks for input data in files N10 and F11 However since this example
56. t know what data is being requested All BTRs must be preceded by a BTW indicating what response to return in a BTR The Smart Transmitter Interface is still obtaining the HART Response from a field device and cannot respond with the requested data The programmable controller should reissue the BTR request to obtain the response Description The Smart Transmitter Interface command is invalid and cannot be processed The Smart Transmitter Interface channel number is invalid The command cannot be processed The HART packet encapsulated within a Smart Transmitter Interface packet is invalid and cannot be forwarded to a field device The channel list provided with the Enable Burst Monitor Mode command contains an invalid entry or is incorrectly terminated The command cannot be processed An invalid parameter is provided with the Smart Transmitter Interface command and so it cannot be processed An invalid control byte is included with the Smart transmitter Interface command The command cannot be processed The length of the DF1 packet is not consistent with the length specification in that packet The command cannot be processed Description The Smart Transmitter Interface is not receiving burst data from a field device in burst mode Either Burst mode has been turned off in the field device or it is too busy to send burst table data The error code is cleared once the Smart Transmitter Interface receives new burst data from the
57. t to 1 When the STT subroutine sees bit 3 set to 1 it processes the request When the request is first detected the STT subroutine is enabled and it sets bit 3 to 0 Bit 4 is the STT subroutine error bit This bit is set if either the BTW or the BTR has failed Any data except words 30 and 31 in the output area is invalid if this bit is set Bit 4 STT Error Bit Bits 5 7 Reserved Reserved for future use Bit 8 STT BTW Retry Bit Bit 8 indicates that the BTW has returned an error and is being retried by the STT subroutine Bit 9 STT BTR Retry Bit Bit 9 indicates that the BTR has returned an error and is being retried by the STT subroutine Bits 10 15 Reserved for future use Example In this example the STT trigger bit is set to 1 if the STT enable bit is set to 0 N10 60 N10 60 FM 4 tH 01 03 4 Call The STT Subroutine 1st Pass sets the enter exit bit to 1 sets the trigger bit to 0 sets the enable bit to 1 Chapter 3 Using The Smart Transmitter Toolkit 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 The input parameter is the integer file number for the cu
58. the same time you must use two 1770 HT1s Example 3 demonstrates reading the primary variable from two HART field devices using two 1770 HT1s 510 E UF TT am aH m 0 i 21410 5 Processor Smart Transmitter Interface HART HART Field Field Device Device 4 20 mA Loop 4 20 mA Loop In this example we used separate data areas for each device This forced us to load the device data file number into the JSR input variable prior to making the call to the STT subroutine In the course of operation if either HART field device does not respond we reissue command 0 to try and get a new HART address for the field device This example assumes that each device data area is setup with the standard inputs for command 0 prior to the execution of this logic a Device 1 uses N10 and F11 Device 2 uses N12 and F13 Nl4is the JSR variable F15 contains both primary variable values 3 9 Chapter 3 Using The Smart Tranmsitter Toolkit 3 10 Rung 2 0 Example 2 continued STT 1 00 Programming Example 2 This example reads the primary variable from 2 HART field devices wired to 1 LTTIO HTI If neither device is current make device 1 the current device Doing Doing Doing Device 1 Device 2 Device 1 B3 B3
59. to the 1770 HT1 with a HART packet that contains the appropriate HART digital data The 1770 HTI routes the response back to the PLC 5 processor in a Smart Transmitter Interface packet as block transfer read BTR data D H Q Jal 5 TT a OME 200 Smart Transmitter Interface PLC 5 Processor eT BTW Data f 1770 HT1 HART Field Smart Transmitter RO Device BTR Data SEA SE ee MCN HART Poll HART packet gt gt HART Response 4 20 mA Loop 90065 Smart Transmitter Interface packet Smart Transmitter Interface Command Channel Number MORE HART packet HART Command 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 Control Parameter Preamble Delimiter Address Byte Count Data Check Byte 90066 Using a few pieces of data the STT subroutine creates a Sm
60. tus 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 This table shows the bits that are used in the STT subroutine status word STT Subroutine Status Word 30 STT Enter Exit Bit Use bit 0 to debug your program When called the STT subroutine sets bit 0 to 1 When the STT subroutine exits the subroutine sets bit 0 to 0 This lets you know when the STT subroutine is entered and exited STT Enable Bit STT Done Bit Bit 1 indicates that the STT subroutine is in the middle of processing a HART command Bit 2 Bit 2 indicates that the STT subroutine is done processing a command When you make an unconditional call to the STT subroutine if the subroutine is not already enabled it sets bit 1 to 1 and bit 2 to 0 When the STT subroutine is done processing a Hart command successful or not it sets bit 2 to 1 and bit 1 to 0 When bit 2 is set to 1 you can process the output data that is returned by the STT subroutine STT Trigger Bit Bit 3 is the STT subroutine trigger bit Use bit 3 to tell the STT subroutine to process the requested command Even though you call the STT subroutine with an unconditional JSR it does not process the HART command unless bit 3 is se
Download Pdf Manuals
Related Search