Rockwell Automation 1770, D17706.5.21 User Manual

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.

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 considerations:

ATTENTION: Identifies information about practices or circumstances that can lead to personal injury or death, property 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.

Using This Manual

What's In This Preface Purpose of This Manual Who Should Use This Manual How To Use This Manual

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Terms Abbreviations Conventions Related STT Software License

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Publications

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

iii iii iii

Introducing The Smart Transmitter Toolkit 11. . . . . . . . . . . . .

What's In This Chapter 11. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

What's The Smart Transmitter Toolkit 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 16. . . . . . . . . . . . . . . . . . . . . . .

What

to Do Next

. . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . .

16. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

i i

i ii ii ii

Installing The Smart Transmitter Toolkit 21. . . . . . . . . . . . . . .

What's In This Chapter 21. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Before You Begin 21

1. Copy STT Subroutine File to the Hard Drive 22

2. Create and Name a New Program File 23

3. Paste The STT Subroutine File 24

4. Save Your Work (optional) 25

5. Change The STT Default Data File (optional) 26 What's

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . .

26. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Using The Smart Transmitter Toolkit 31. . . . . . . . . . . . . . . . .

What's In This Chapter 31. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1. Create Data T

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

With Single 1770HT1 37

able Files

. . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Example 1: Single HAR

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

31. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . .

T Device

Table of Contentsii

Programming

With Single 1770HT1 39

Programming

With Multiple 1770HT1s 313

Example 2: Multiple HAR

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Example 3: Multiple HAR

. . . . . . . . . . . . . . . . . . . . . . . . . . . .

T Devices

HART Command Data Table Layouts A1. . . . . . . . . . . . . . . . .

What's In This Appendix A1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

HART Command 0 Read HART Address A2 HART Command 0

Read HART Address A3

HART Command 1

Read Primary Variable A4. . . . . . . . . . . . . . . . . . . . . . . . . . . . .

HART Command 3

Read Dynamic Variables & Primary Variable Current A6

HART Command 3

Read Dynamic Variables & Primary Variable Current A7

HART Command 35

Write Primary Variable Range Values A8. . . . . . . . . . . . . . . . . . .

HART Command 35

Write Primary Variable Range Values A9

HART Command 38

Reset Configuration Change Flag A10

HART Command 38

Reset Configuration Change Flag A11

HART Command 43

Set Primary Variable Zero A12

HART Command 43

Set Primary Variable Zero A13

HART Command 44

Write Primary V

HART Command 44

Write Primary V

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . .

ariable Units

. . . . . . . . . . . . . . . . . . .

. . . . . . . .

. . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . .

A14. . . . . . . . . . . . . . . . . . . . . . . . .

A15. . . . . . . . . . . . . . . . . . . . . . . . .

Codes B1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

What's In This Appendix B1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

STT Subroutine Error Codes B1 Smart Transmitter Interface Error Codes B2 HART Protocol Communication Error Codes B3 Integer Word 34 B3 HART Command Response Summary Error Codes B3 Integer Word 35 B3 HART Field Device Error Codes B4 Unit Codes B5 Integer Words 10 and 40 B5

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Using This Manual

Preface

What's

In This Preface

Purpose of This Manual

This preface describes how to properly and efficiently use this manual.

Smart T

User

ransmitter T

Manual

oolkit

It tells you about:

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

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

This manual is intended for use by:

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:

a strong working knowledge of your plant’s process and equipment a familiarity with personal computers, MS-DOS or PC-DOS,

ControlView, and 6200 programming software

Preface

Using This Manual

How To Use This Manual

Read about the STT subroutine

chapter 1

Terms

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.

See

HART Command

Data Table Layouts

appendix A

Install the STT

subroutine

chapter 2

Use the STT

subroutine

chapter 3

See

Codes

appendix B

Some of the tasks described in this manual assume that you have an acquaintance with basic computer terminology.

Abbreviations

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

BTW Blocktransfer Write

HART Highway Addressable Remote Transducer

JSR Jump to Subroutine

STT Smart Transmitter Toolkit

Blocktransfer Read

Preface

Using This Manual

Conventions

Publications

We use these conventions in this manual:

In this manual, we show: Like this:

prompts and messages

literal text that you type

variable text that you type

keys that you press

screens that you see

that there is more information about the topic in another manual

Press a function key

STT_SUB

filename

Program

Directory

AllenBradley Publications

Publication Publication Number

Smart Transmitter Interface Products (HART Protocol) User Manual

PLC5 Programming Software Programming Manual

17706.5.19

62006.4.7

STT Software License

For a list of publications for Allen-Bradley programmable controller products, see the Automation Group Publication Index, publication SD499.

HART Publications

Publication Reference Number and Date

HART - Smart Communications Protocol Specification

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.

Revision 5.1, January 4, 1991

Rosemount, Inc. Document No. D9000047, Revision A

iii

Chapter

Introducing The Smart Transmitter Toolkit

What's

What'

In This Chapter

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.

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 communication among Allen-Bradley PLC-5 processors, Allen-Bradley Smart Transmitter Interfaces, and HART-compliant field devices, such as a smart transmitter or actuator.

✔ 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.

✔ 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.

✔ 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.

✔ STT does not include faceplates or operator interface screens. However,

you can configure operator interface software, such as ControlView 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.

1-1

Chapter 1

Introducing The Smart Transmitter Toolkit

What You Get W Subroutine

6200 Programming Software

ith The STT

You

Provide

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

STT Provides

Workstation

Data Highway Plus

PLCresident Control Functions

Your Application Program

STT Data Tables and

Subroutine Call

PLC5 ladder logic subroutine that simplifies the communication between a PLC5 processor and a HART field device.

PLC5 Processor

Smart Transmitter Interface

1770HT1

RIO

1770HT16

HART

Field

Devices

4-20 mA Loop

1-2

Chapter 1

Introducing The Smart Transmitter Toolkit

What You Need to Use The STT Subroutine

Why Y

ou Should 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 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: ✔ Format each command from the HART specification using the Smart

Transmitter Interface protocol.

✔ Understand HART protocol internals, such as long frame addressing vs.

short frame addressing, and byte swapping for word alignment.

✔ Parse HART command responses for data. ✔ Convert IEEE-754 data to floating-point data. ✔ Synchronize BTWs with BTRs.

With STT, the ladder developer must only:

✔ Configure a data block. ✔ Make the appropriate call to the STT subroutine.

1-3

Chapter 1

Introducing The Smart Transmitter Toolkit

How

a PLC5 Processor Communicates With a HART Field Device

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.

❸ The HART field device receives the HART packet and then responds

back to the 1770-HT1 with a HART packet that contains the appropriate HART digital data.

➍ The 1770-HT1 routes the response back to the PLC-5 processor in a

Smart Transmitter Interface packet as block-transfer read (BTR) data.

PLC5

Processor

BTW Data

➊

Smart T

ransmitter

Interface packet

BTR Data

➍

RIO

Smart Transmitter Interface

1770HT1

1770HT16

HART Poll

➋

HART packet

HART Response

❸

420

HART

Field

Device

mA Loop

90065

1-4

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.

Smart Transmitter Interface packet

Smart Transmitter Interface Command

Channel Number

Control

Parameter

Chapter 1

Introducing The Smart Transmitter Toolkit

HART packet

Preamble

Delimiter

Address

HART Command

Byte Count

Data

Check Byte

90066

Using a few pieces of data, the STT subroutine creates a Smart Transmitter Interface packet and sends it to the 1770-HT1. The STT subroutine then takes the response from the 1770-HT1 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.

1-5

Chapter 1

Introducing The Smart Transmitter Toolkit

How You Use The STT Subroutine

Read chapter 2, then

Chapter 2

install the software.

Installing The Smart

Transmitter Toolkit

Chapter 3

Using The Smart

Transmitter Toolkit

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. Install the STT subroutine into your workstation and PLC-5

processor.

STT

Subroutine

2. Customize your PLC-5 ladder logic to use the STT subroutine.

a. Allocate data blocks in your PLC5 processor

for each HART field device in your system.

b. Enter a JSR instruction in your ladder logic

program for each 1770HT1 in your system.

What to Do Next

When you’ve completed these steps, you’re ready to use the STT subroutine.

Go to chapter 2 to begin installing the Smart Transmitter Toolkit.

1-6

Chapter

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. Paste the STT subroutine file into the new program file.

4. Save your work (optional).

5. 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.

Before You Begin

You need this diskette to install the STT subroutine:

Allen-Bradley Software

Smart T

ransmitter T

Disk 1 of 1

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.

oolkit

This diskette contains these paste files:

• STT100.CR5 - the STT subroutine

• STT100E1.CR5 - programming example 1

• STT100E2.CR5 - programming example 2

• STT100E3.CR5 - programming example 3

See chapter 3 for an explanation of the programming examples.

2-1

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:

To/From

Floppy

F9 F2 F7

From Floppy

6200

Main Menu

File

Utils

You see:

Processor Memory: Cut Rungs

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

E. To begin the copy, press

Source

F1 Begin

Oper

The operation is completed.

F. To return to the 6200 Main Menu, press

Esc Esc .

2-2

Chapter 2

Installing The Smart Transmitter Toolkit

2. Create Program File

and Name a New

A. Start at the 6200 Main Menu and press these keys:

6200

Main Menu

Online ProgF3Offline Prog

Proc Func

You see:

B. To create a program file, press F6 Create

file number.

C. To name the file, press

F10

Change Fl Name

name. We recommend that you use the filename

D. To go to the Program Directory, press

Esc .

Lad Fl

and then enter a

and then enter a file

STT_SUB.

2-3

Chapter 2

Installing The Smart Transmitter Toolkit

3. Paste

The STT

Subroutine File

A. Start at the Program Directory and press these keys:

Monitor

Program

Rockwell Automation 1770, D17706.5.21 User Manual

Specifications and Main Features

Frequently Asked Questions

User Manual

Table of Contents

Preface