User’s Manual 0300217-03 Rev.
ii Compact™ IO Isolated HART Analog Output Module User’s Manual 0300217-03 Rev.
Table of Contents iii Table of Contents CHAPTER 1 MODULE OVERVIEW ..................................................................................................................... 1‐1 SECTION 1.1 GENERAL DESCRIPTION ............................................................................................................................. 1‐1 SECTION 1.2 DATA FORMATS ....................................................................................................................................
iv Compact™ IO Isolated HART Analog Output Module SECTION 5.1 MODULE ADDRESSING .............................................................................................................................. 5‐1 SECTION 5.2 CONFIGURING THE 1769SC‐OF4IH IN A MICROLOGIX 1500 SYSTEM .............................................................. 5‐2 SECTION 5.3 USING THE LADDER SAMPLE .......................................................................................................................
Table of Contents v 7.2.2 Auto Acquisition ........................................................................................................................................ 7‐3 7.2.3 Packet Interval ........................................................................................................................................ 7‐10 SECTION 7.3 SENDING AND RECEIVING MESSAGES .......................................................................................................... 7‐11 7.3.
vi Compact™ IO Isolated HART Analog Output Module User’s Manual 0300217-03 Rev.
vii Preface Read this preface to familiarize yourself with the rest of the manual.
viii Compact IO™ Isolated HART Analog Output Module Conventions Used in This Manual The following conventions are used throughout this manual: Bulleted lists (like this one) provide information not procedural steps. Numbered lists provide sequential steps or hierarchical information. Italic type is used for emphasis Bold type identifies headings and sub-headings ! Attention User’s Manual 0300217-03 Rev.
Chapter 1 Module Overview This chapter describes the 1769sc-OF4IH isolated HART analog output module. The module provides four isolated current outputs with HART communication. Included is information about: The module’s hardware and diagnostic features An overview of the system and module operation Compatibility Section 1.
1-2 Compact™ IO Isolated HART Analog Output Module Section 1.3 Hardware Features The module contains a removable terminal block. Each channel has a dedicated ground which is isolated from the remaining channels by 500VDC. Do not short the channel grounds together unless you plan to remove the channel to channel isolation. ! Attention Module configuration is done via the controller’s programming software. In addition, some controllers support configuration via the user program.
Chapter 1: Module Overview 9 10 10a 10b 1-3 write-on label for user identification tags removable terminal block (RTB) with finger-safe cover RTB upper retaining screw RTB lower retaining screw 1.3.1 General Diagnostic Features The module contains a diagnostic LED that helps you identify the source of problems that may occur during power-up or during normal channel operation. The LED indicates both status and power.
1-4 Compact™ IO Isolated HART Analog Output Module Section 1.5 Module Operation When the module receives a new command value from the output image, the module’s circuitry converts the digital value to an analog current signal using a DAC (Digital to Analog Converter). The resulting signal is made available for the specific channel via the removable terminal block. If HART is enabled on a channel, the HART data is acquired my means of an onboard HART modem.
Chapter 2 Quick Start for Experienced Users Section 2.1 Before You Begin This chapter can help you get started using the 1769sc-OF4IH isolated HART analog output module. We base the procedures here on the assumption that you have an understanding of Allen-Bradley controllers. You should understand electronic process control and be able to interpret the ladder logic instructions required to generate the electronic signals that control your application.
2-2 Compact IO™ Isolated HART Analog Output Module Step 1: Ensure that your 1769 system power supply1 has sufficient current output to support your system configuration. Reference Chapter 3 (Installation and Wiring) The modules maximum current draw is shown below: 5V dc 24V dc 180 mA 200 mA NOTE: The module cannot be located more than 8 modules away from the system power supply. Step 2: Attach and lock the module.
Chapter 2: Quick Start For Experienced Users 5. 2-3 To allow communication between the controller and module, move the bus lever fully to the left (4) until it clicks. Ensure it is locked firmly in place. Attach an end cap terminator (5) to the last module in the system by using the tongue-and-groove slots as before. Lock the end cap bus terminator (6). 6. 7. When attaching I/O modules it is very important that the bus connectors are securely locked together to ensure proper electrical connection.
2-4 Compact IO™ Isolated HART Analog Output Module The terminal block layout is shown below: Figure 2-1 N/C N/C I Out 0I Out 0+ N/C N/C I Out 1I Out 1+ N/C N/C I Out 2I Out 2+ N/C N/C I Out 3I Out 3+ N/C N/C Step 4: Configure the module for the proper controller. Reference Chapter 4 (Configuring the OF4IH for CompactLogix Using RSLogix 5000) or Chapter 5 (Configuring the OF4IH for a MicroLogix 1500 Using RSLogix 500) Step 5: Configure the module.
Chapter 2: Quick Start For Experienced Users Step 7: Monitor the module status to check if the module is operating correctly 2-5 Reference Chapter 9 (Diagnostics and Troubleshooting) Module and channel configuration errors are reported to the controller. These errors are typically reported in the controller’s I/O status file. Channel status data is also reported in the module’s input data table, so these bits can be used in your control program to flag a channel error. User’s Manual 0300217-03 Rev.
2-6 Compact IO™ Isolated HART Analog Output Module User’s Manual 0300217-03 Rev.
Chapter 3 Installation and Wiring This chapter explains how to: Determine the power requirements for the module Avoid electrostatic damage Install the module Wire the module’s terminal block Wire output devices Section 3.1 Compliance to European Union Directives This product is approved for installation within the European Union and EEA regions. It has been designed and tested to meet the following directives. 3.1.
3-2 Compact IO™ Isolated HART Analog Output Module Section 3.2 Power Requirements The module receives power through the bus interface from the +5V dc/ +24V dc system power supply. The maximum current drawn by the module is shown in the table below. Module Current Draw at 5V dc 180 mA at 24V dc 200 mA Section 3.3 General Considerations Compact I/O is suitable for use in an industrial environment when installed in accordance with these instructions.
Chapter 3: Installation and Wiring 3-3 3.3.3 Remove Power ! Attention Remove power before removing or inserting this module. When you remove or insert a module with power applied, an electrical arc may occur.
3-4 Compact IO™ Isolated HART Analog Output Module ! Attention If the OF4IH is to be installed adjacent to one of the modules listed in the table above and the ambient temperature is in excess of 55°C, then derating of the module is required to avoid thermal shutdown. Assume the thermal dissipation of the OF4IH to be 2W fixed plus an additional 0.5W per channel. For example, if the OF4IH is to be installed adjacent to the 1769-HSC, no more than 2 channels should be used on the OF4IH.
Chapter 3: Installation and Wiring 3-5 Figure 3-2 1. 2. Disconnect power. Check that the bus lever of the module to be installed is in the unlocked (fully right) position. NOTE: If the module is being installed to the left of an existing module, check that the right-side adjacent module’s bus lever is in the unlocked (fully right) position. 3. Use the upper and lower tongue-and-groove slots (1) to secure the modules together (or to a controller). 4.
3-6 Compact IO™ Isolated HART Analog Output Module Figure 3-3 3.5.2 Panel Mounting Mount the module to a panel using two screws per module. Use M4 or #8 panhead screws. Mounting screws are required on every module. Panel Mounting Using the Dimensional Template Figure 3-4 Panel Mounting Procedure Using Modules as a Template The following procedure allows you to use the assembled modules as a template for drilling holes in the panel.
Chapter 3: Installation and Wiring 2. 3. 4. 5. 6. 3-7 Using the assembled modules as a template, carefully mark the center of all modulemounting holes on the panel. Return the assembled modules to the clean work surface, including any previously mounted modules. Drill and tap the mounting holes for the recommended M4 or #8 screw. Place the modules back on the panel, and check for proper hole alignment. Attach the modules to the panel using the mounting screws.
3-8 Compact IO™ Isolated HART Analog Output Module General Power and output wiring must be in accordance with Class 1, Division 2 wiring methods, Article 501-4(b) of the National Electric Code, NFPA 70, and in accordance with the authority having jurisdiction. Channels are isolated from one another by ±500 Vdc maximum. Route field wiring away from any other wiring and as far as possible from sources of electrical noise, such as motors, transformers, contactors, and ac devices.
Chapter 3: Installation and Wiring 3-9 Figure 3-5 To remove the terminal block, loosen the upper and lower retaining screws. The terminal block will back away from the module as you remove the screws. When replacing the terminal block, torque the retaining screws to 0.46 Nm (4.1 in-lbs). 3.7.4 Wiring the Finger-Safe Terminal Block When wiring the terminal block, keep the finger-safe cover in place. 1. Loosen the terminal screws to be wired. 2. Route the wire under the terminal pressure plate.
3-10 Compact IO™ Isolated HART Analog Output Module To wire your module follow these steps. 1. At each end of the cable, strip some casing to expose the individual wires. 2. Trim the signal wires to 2-inch (5 cm) lengths. Strip about 3/16 inch (5 mm) of insulation away to expose the end of the wire. Be careful when stripping wires. Wire fragments that fall into a module could cause damage at power up. ! Attention 3. 4. 5. 6.
Chapter 4 Configuring the OF4IH for CompactLogix Using RSLogix 5000 This chapter explains how to incorporate the OF4IH module into a CompactLogix system using RSLogix 5000 programming software. The process of incorporating your HART module into the CompactLogix system is similar to the process needed to add an AllenBradley module. You will use your RSLogix 5000 programming software to install and configure your HART module.
4-2 Compact IO™ Isolated HART Analog Output Module 1. Create a new RSLogix 5000 project file. Click on the new project icon or on the FILE pull-down menu and select NEW. The following screen appears: Figure 4-2 2. User’s Manual 0300217-03 Rev. A Choose your controller type and enter a name for your project, then click OK.
Chapter 4: Configuring the OF4IH for CompactLogix Using RSLogix 5000 4-3 Figure 4-3 3. In the ControllerOrganizer on the left of the screen, right click on “[0]CompactBus Local”, select New Module, and the following screen appears: Figure 4-4 User’s Manual 0300217-03 Rev.
4-4 Compact IO™ Isolated HART Analog Output Module 4. This screen is used to narrow your search for I/O modules to configure into your system. With the initial release of the CompactLogix5320 controller, this screen only includes the “Generic 1769 Module”. Click the OK button and the following default Generic Profile screen appears: Figure 4-5 5. First, select the Comm Format (“Data – INT” for the 1769sc-OF4IH), then fill in the name field.
Chapter 4: Configuring the OF4IH for CompactLogix Using RSLogix 5000 4-5 Figure 4-6 7. At this point you may click “Finish” to complete the configuration of your I/O module. Configure each I/O module in this manner. The CompactLogix5320 controller supports a maximum of 8 I/O modules. The valid slot numbers to select when configuring I/O modules are 1 through 8. Section 4.2 Using The Add-On Profile For RSLogix 5000 version 15 and greater an Add-On module profile is available for download at (http://www.
4-6 Compaact IO™ Isolateed HART Analog Output Moodule 3. Folllow the onlinee prompts. 4.2.2 Add ding the OF4 4IH Modulee To Your L Logix Projecct Once the pro ofiles are installled you can acccess them throough RSLogix 5000 via the II/O Configuratio on. Follow thee procedure bellow to add a m module: 1. In the t I/O Configu uration, right m mouse click onn the 1769 Com mpactBus and sselect “Neew Module”. 2.
Chapter 4: Configuring the OF4IH for CompactLogix Using RSLogix 5000 3. Highlight the module and press the “OK” button. 4. Configure the module using the custom configuration screens. 4-7 Note: The 1769sc-IF4IH still requires ladder to demultiplex the HART data and send HART messages via the controller. Please refer to the sample project packaged with the profile install for more information. Section 4.
4-8 Compact IO™ Isolated HART Analog Output Module The table below gives a brief description of each data type. Table 4-2 (User Defined Data Type Descriptions) User Defined Data Type Description ConfigurationStructure Defines the structure for the configuration tags used to configure the module.1 GetDeviceInfoStructure Defines the structure of the HART data returned by the module when the module specific command, Get Device Information, is sent to module.
Chapter 4: Configuring the OF4IH for CompactLogix Using RSLogix 5000 4-9 Figure 4-8 (Copying Controller Tags) Sample Project Your Project Copy and paste tags After copying the controller tags you can copy the program tags next. Follow the same procedure shown in Figure 4-8. The figures below show examples of the configuration tags, input tags and output tags. Refer to Chapter 6 for information on how to configure the module and or reading the input data.
4-10 Compact IO™ Isolated HART Analog Output Module Figure 4-9 (Configuration Tags) Figure 4-10 (Input Tags) User’s Manual 0300217-03 Rev.
Chapter 4: Configuring the OF4IH for CompactLogix Using RSLogix 5000 Figure 4-11 (Output Tags) User’s Manual 0300217-03 Rev.
4-12 Compact IO™ Isolated HART Analog Output Module Section 4.5 Sample Project Ladder The ladder contained in the sample project is used to perform several different operations. The main routine in the MainProgram is used to copy data from the user defined tags to the module local tags. This data includes input, output and configuration settings for the module. The OF4IH0_Packet_Data routine in the MainProgram contains the ladder that demultiplexes the HART data for each individual packet.
Chapter 4: Configuring the OF4IH for CompactLogix Using RSLogix 5000 5. Right mouse click and select paste. The figure below demonstrates this procedure: Figure 4-13 (Copying Ladder) Sample Project User’s Manual 0300217-03 Rev.
4-14 Compact IO™ Isolated HART Analog Output Module User’s Manual 0300217-03 Rev.
Chapter 5 Configuring the OF4IH for a MicroLogix 1500 Using RSLogix 500 This chapter examines the 1769sc-OF4IH module’s addressing scheme and describes module configuration using RSLogix 500 and a MicroLogix 1500 controller. This chapter will cover the following: Module Addressing Configuring the OF4IH in a MicroLogix 1500 System Using the Ladder Sample Section 5.1 Module Addressing The following memory map shows the input, output, and configuration image tables for the module.
5-2 Compact IO™ Isolated HART Analog Output Module For example, to obtain the general status for channel 2 of the module located in slot e, use address I:e.0/2. Figure 5-2 (Address Example) Slot Word I:e.0/2 Input File Type Bit Bit Delimiter Element Delimiter Word Delimiter NOTE: The end cap does not use a slot address. Section 5.
Chapter 5: Configuring the OF4IH for A MicroLogix 1500 Using RSLogix 500 5-3 Figure 5-3 While offline, double-click on the IO Configuration icon under the controller folder and the following IO Configuration screen appears. Figure 5-4 This screen allows you to manually enter expansion modules into expansion slots, or to automatically read the configuration of the controller. To read the existing controller configuration, click on the Read IO Config button.
5-4 Compact IO™ Isolated HART Analog Output Module Figure 5-5 The actual I/O configuration is displayed. In this example, a second tier of I/O is attached to the MicroLogix 1500 processor. Figure 5-6 The 1769sc-OF4IH module is installed in slot 1. To configure the module, double-click on the module/slot. The general configuration screen appears. User’s Manual 0300217-03 Rev.
Chapter 5: Configuring the OF4IH for A MicroLogix 1500 Using RSLogix 500 5-5 Figure 5-7 ! When using the read IO configuration feature in RSLogix, you need to manually enter 42 into the “extra data length” field. Attention To configure the module select the Generic Extra Data Configuration tab. Enter the decimal equivalent of each configuration word. There are a total of 42 words that need to be configured altogether.
5-6 Compact IO™ Isolated HART Analog Output Module Section 5.3 Using the Ladder Sample To get started we recommend that you use the provided MicroLogix 1500 sample project. Refer to Chapter 8 for the sample project or visit our website at (www.spectrumcontrols.com). The sample project contains nine different subroutines which are used to perform various HART related tasks. The following list describes the function of each subroutine within the project file.
Chapter 5: Configuring the OF4IH for A MicroLogix 1500 Using RSLogix 500 5. 5-7 Right mouse click and select paste. Figure 5-9 (Copying Routines) Sample Project Your Project Copy and paste 5.3.2 Copying Ladder from the Sample Project To copy ladder, follow the procedure below: 1. Open the sample project and your project 2. Open the routine that you wish to copy the ladder from. 3. Select the rungs by clicking the left mouse button.
5-8 Compact IO™ Isolated HART Analog Output Module Figure 5-10 (Copying Ladder) Sample Project Your Project Copy and paste 5.3.3 Importing Tag Database and Rung Comments After copying the subroutines and or the ladder, you may wish to import the tags and rung comments. Follow the procedure below to import the tag database and rung comments: 1. Open the sample project and your project. 2. In the sample project, go to the tools menu, select database, and then select ASCII export.
Chapter 5: Configuring the OF4IH for A MicroLogix 1500 Using RSLogix 500 5-9 3. After selecting ASCII export the following screen appears: 4. Select the RSLogix 500 tab and press the OK button. 5. Select the location for the export file. 6. In your project, go to the tools menu, select database, and select ASCII import. See image below: User’s Manual 0300217-03 Rev.
5-10 Compact IO™ Isolated HART Analog Output Module 7. After selecting ASCII import the following screen should appear: 8. Select the RSLogix 500 radio button and leave everything else at default. After making your selections, press the OK button. 9. Select the export file from steps 4 and 5 and press the open button. You may be prompted for multiple files depending on the selections you made in step 8. User’s Manual 0300217-03 Rev.
Chapter 6 Module Data, Status, and Channel Configuration After installing the 1769sc-OF4IH isolated HART output module, you must configure it for operation, usually using the programming software compatible with the controller (for example, RSLogix 500 or RSLogix 5000). Once configuration is complete and reflected in the ladder logic, you need to operate the module and verify its configuration.
6-2 Compact IO™ Isolated HART Analog Output Module Section 6.2 Accessing Input Image File Data The input image file represents data words and status words. Words 0 and 1 contain status information for the four channels including process alarms and over and under range flags. Input words 2 through 5 hold an echo of the analog output value for channels 0 through 3 respectively. Words 6 through 25 include the HART packet data. Refer to Chapter 7 for information on how to demultiplex the HART packet data.
Chapter 6: Module Data, Status, and Configuration 6-3 that range. Note: This bit can also be set if the high clamp value is reached or exceeded. The bit will automatically clear when the channel command value1 drops below the high clamp value. 6.3.4 Under-Range Flag Bits U0 to U3 (Word 1) Under-range bits for channels 0 through 3 are contained in word 1. They apply to all output types.
6-4 Compact IO™ Isolated HART Analog Output Module Module Configuration After module installation, you must configure operation details, such as output type, data format, etc., for each channel. Configuration data for the module is stored in the controller configuration file, which is both readable and writable. The default value of the configuration data is represented by zeros in the data file. The structure of the channel configuration file is shown below.
6-5 Chapter 6: Module Data, Status, and Configuration Table 6-2b (Module Configuration) B it W o rd 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0 F u n ctio n 26 Channel 3 F ault V alue Ch3 Fault V alue 27 Channel 3 P rogram Idle V alue Ch3 Progr am Idle V alue 28 Channel 3 Low Clam p V alue Ch3 Low Clamp V alue 29 Channel 3 High Clam p V alue Ch3 High Clamp V alue 30 Channel 3 Ram p Rate V alue Ch3 Ramp Rate V alue 31 Res erved Not Us ed (Set to Z ero) S et to Zero 32 33 Res
6-6 Compact IO™ Isolated HART Analog Output Module the module applies the program/idle mode data value. The default setting is disabled. Note: Not all controllers support this function. Refer to your controller’s user manual for more details. HI (Hold for Initialization) Hold for Initialization causes outputs to hold their present state until the value commanded by the controller matches the value or is within a percentage of the value being commanded by the module.
6-7 Chapter 6: Module Data, Status, and Configuration Note: Not all controllers support this function. Refer to your controller’s user manual for more details. SV0...SV3 (Slot Variables 0 to 3) Enables HART slot variables 0 through 3 for the selected channel. Note: Slot variables are not supported by all HART devices. Note: Slot codes must be enabled in sequential order. For example, SV0 (Enabled), SV1 (Disabled), and SV2 (Enabled), is not a valid configuration.
6-8 Compact IO™ Isolated HART Analog Output Module Data Format This selection allows the user to define the channel’s data format for any of the following: Raw/Proportional Data The raw/proportional data format provides the best resolution of all the supported data formats. If you select the raw/proportional data format for a channel, the output command word1 will be a number between -32767 and +32767.
6-9 Chapter 6: Module Data, Status, and Configuration Note: The range of this value is defined by the data format selected for the channel. 6.3.16 Low Clamp Value (Words 4, 12, 20, 28) The low clamp value determines the minimum analog signal that will be applied to the associated channel. Note: If the channel command value1 is less than or equal to the low clamp value, the under range status bit, for the associated channel, will be set.
6-10 Compact IO™ Isolated HART Analog Output Module Note: The number of counts entered for a channel’s ramp rate may be equal to 0 only if ramping is not enabled for the channel. 6.3.19 Spare (Words 7, 15, 23, 31) Reserved for future expansion 6.3.20 Pad (Word 32) 16 bit alignment (Set to Zero) 6.3.
Chapter 6: Module Data, Status, and Configuration 6-11 6.3.22 Channel X1 HART Slot Variables 0 & 1 (Words 34, 36, 38, 40) This word defines HART slot variables 0 and 1 for the selected channel. The first byte defines slot variable 0 and the second defines slot variable 1. The variable is defined as a hexadecimal value between 0 and FF. The HART slot variable is a floating point value that represents a device specific variable defined by the manufacturer for the connected HART field device.
6-12 Compact IO™ Isolated HART Analog Output Module Note: It is up to the user to keep the unlatch bit set until verification that the process alarm bit has cleared. When the process alarm bit has cleared the user can then clear the unlatch process alarm bit. Note: The module will not latch the high process alarm if a transition from “no alarm condition” to “alarm condition” occurs while the unlatch high process alarm bit is set. 6.4.
Chapter 6: Module Data, Status, and Configuration 6.4.9 Reserved (Words 28…49) Reserved for future expansion. Determining Module Update Time The module update time is defined as the time required for the module to receive the command value and convert it to an equivalent analog output signal for all enabled channels. 6.5.1 Module Update Time HART Enabled HART Disabled 12 ms 10 ms User’s Manual 0300217-03 Rev.
6-14 Compact IO™ Isolated HART Analog Output Module User’s Manual 0300217-03 Rev.
Chapter 7 Enabling and Using HART on the 1769sc-OF4IH This chapter outlines the detailed settings and configuration related to HART communication for the 1769sc-OF4IH module. These settings determine how the module acquires HART data.
7-2 Compact IO™ Isolated HART Analog Output Module Figure 7-1 ! HART throughput time can be improved by disabling HART communication on unused channels or channels that include nonHART devices. Attention Section 7.2 HART Packet Data 7.2.1 How the Module Connects to a Field Device The HART output module behaves as a HART master in which case the field device is considered the slave.
Ch hapter 7: Enab bling and Usingg HART on thhe 1769sc-OF4IIH 7-3 Figure 7-2 Hart multi-d drop is not sup pported by th he OF4IH. ! Attention The HART module m commu unicates to the controller usinng the input annd output imagee. Data commu unicated over th he input and ouutput image arre transmitted aat a rate that is controlled by y the PLC. Th he rate at whichh data is comm municated to thee compactbus iis adjustable by y using the RP PI (Requested P Packet Intervall).
7-4 Compact IO™ Isolated HART Analog Output Module Figure 7-3 (Auto Acquisition Flow) Start Connect to field device Channel Switch Read device codes Initializ ed for HART? Yes No Read ASCII messages Read PVU and PVL Read 4 dynamic variables Read extended status Read slot variables if enabled The data that is collected from the process described in Figure 7-4 (Auto Acquisition Flow) is buffered to the module RAM memory.
Chapter 7: Enabling and Using HART on the 1769sc-OF4IH Table 7-1 (HART Packet 0) Tag Name If4ih0Packet0 If4ih0Packet0[X,0] 1 If4ih0Packet0[X,0].HartChannelID If4ih0Packet0[X,0].ManufacturerID If4ih0Packet0[X,0].DeviceType If4ih0Packet0[X,0].NumPreambles If4ih0Packet0[X,0].UniversalCmdCode If4ih0Packet0[X,0].XmitterRev If4ih0Packet0[X,0].SwRev If4ih0Packet0[X,0].HwRev If4ih0Packet0[X,0].HartFlags If4ih0Packet0[X,0].RangeUnits If4ih0Packet0[X,0].DeviceSerialNumber If4ih0Packet0[X,0].
7-6 Compact IO™ Isolated HART Analog Output Module Table 7-2 (HART Packet 1) Tag Name If4ih0Packet11 Style Data Type Packet1[4,1] NA If4ih0Packet1[X,0] 1 If4ih0Packet1[X,0].HartChannelID Packet1 INT NA BIN If4ih0Packet1[X,0].HartCommStatus SINT BIN If4ih0Packet1[X,0].HartDevStatus SINT BIN If4ih0Packet1[X,0].HartPV If4ih0Packet1[X,0].HartSV If4ih0Packet1[X,0].HartTV If4ih0Packet1[X,0].HartFV If4ih0Packet1[X,0].HartPVUnits If4ih0Packet1[X,0].HartSVUnits If4ih0Packet1[X,0].
Chapter 7: Enabling and Using HART on the 1769sc-OF4IH Table 7-3 (HART Packet 2) Tag Name If4ih0Packet2 If4ih0Packet2[X,0] 1 If4ih0Packet2[X,0].HartChannelID If4ih0Packet2[X,0].Slot0Data If4ih0Packet2[X,0].Slot1Data If4ih0Packet2[X,0].Slot2Data If4ih0Packet2[X,0].Slot3Data If4ih0Packet2[X,0].Slot0Units If4ih0Packet2[X,0].Slot1Units If4ih0Packet2[X,0].Slot2Units If4ih0Packet2[X,0].Slot3Units If4ih0Packet2[X,0].Slot0Assignment If4ih0Packet2[X,0].Slot1Assignment If4ih0Packet2[X,0].
7-8 Compact IO™ Isolated HART Analog Output Module Table 7-5 (HART Packet 4) Tag Name If4ih0Packet4 If4ih0Packet4[X,0].HartChannelID If4ih0Packet4[X,0].Date If4ih0Packet4[X,0].FinalAssemblyNumber If4ih0Packet4[X,0].ExtendedStatus If4ih0Packet4[X,0].Pad 1 Style Description Data Type Packet4[4,1] NA Two dimensional array containing packet 4 data for all 4 channels. INT BIN Bits 0 to 3: Channel number (0 – 3).
Chapter 7: Enabling and Using HART on the 1769sc-OF4IH Figure 7-4 (Packet Ladder) User’s Manual 0300217-03 Rev.
7-10 Compact IO™ Isolated HART Analog Output Module Figure 7-5 (Packet Ladder Continued) Note: The ladder in Figure 7-5 can be found in the project sample file located on our website at (www.spectrumcontrols.com) 7.2.3 Packet Interval The delay between two consecutive packets is called the packet interval. The default time for the packet interval is 500 ms. This delay is controlled by the module.
Chapter 7: Enabling and Using HART on the 1769sc-OF4IH 7-11 Section 7.3 Sending and Receiving Messages Sending messages to and from the module is accomplished using a paging scheme. This paging scheme uses the module’s input and output words to transfer data between the controller and the module, 38 bytes at a time (i.e. one page at a time). The paging scheme is utilized to minimize the number of bytes sent and received at one time from the module’s input and output image.
7-12 Compact IO™ Isolated HART Analog Output Module the current page). Words 8…27 (Message Request Buffer) The message request buffer contains the data being sent to the module for the current page (up to 38 bytes). 7.3.2 Module Input Tags Used For Messaging The module utilizes 48 input words to receive messages and control data flow. The table below shows the input words used by the module. Refer to Chapter 6 for more information regarding input words 0 through 48.
Chapter 7: Enabling and Using HART on the 1769sc-OF4IH 7-13 7.3.3 Processing a Message To complete a message from beginning to end, follow the steps listed below: 1. Store the message you wish to send to the module in an array. Remember the message can be up to 257 bytes long, so make the array large enough. 2. Copy the first page of data, up to 38 bytes, to the message request buffer. If the number of bytes is odd, the last byte in the last word will be padded with a zero. 3.
7-14 Compact IO™ Isolated HART Analog Output Module Figure 7-6 Sending Message Message to be sent First Page MsgMasterControl = 00|01 MsgSlaveControl = 00|00 Bytes sent <> MsgRequestSize MsgMasterControl (Hex) = RR|SS RR = Page Last Received SS = Page Being Sent Second Page Up to 257 Bytes 38 Bytes MsgRequestSize = Total size of message in bytes, up to 257 bytes. MsgRequestBuffer = One page of data being sent to module. Last byte is page checksum. 1 page = 38 bytes max.
Chapter 7: Enabling and Using HART on the 1769sc-OF4IH Figure 7-7 Receiving Message Message Returned First Page MsgMasterControl = 00|02 MsgSlaveControl = 02|01 Bytes received <> MsgSlaveControl (Hex) = RR|SS RR = Page Last Received SS = Page Being Sent Second Page Up to 257 Bytes 38 Bytes MsgResponseSize = Total size of response message, up to 257 bytes. MsgResponseBuffer = One page of data being sent to the PLC. Last byte is page checksum. 1 page = 38 bytes max.
7-16 Compact IO™ Isolated HART Analog Output Module Figure 7-8a (Message Ladder) User’s Manual 0300217-03 Rev.
Chapter 7: Enabling and Using HART on the 1769sc-OF4IH Figure 7-9b User’s Manual 0300217-03 Rev.
7-18 Compact IO™ Isolated HART Analog Output Module Figure 7-9c User’s Manual 0300217-03 Rev.
Chapter 7: Enabling and Using HART on the 1769sc-OF4IH Figure 7-9d User’s Manual 0300217-03 Rev.
7-20 Compact IO™ Isolated HART Analog Output Module Figure 7-9e User’s Manual 0300217-03 Rev.
Chapter 7: Enabling and Using HART on the 1769sc-OF4IH Figure 7-9f User’s Manual 0300217-03 Rev.
7-22 Compact IO™ Isolated HART Analog Output Module Figure 7-9g User’s Manual 0300217-03 Rev.
Chapter 7: Enabling and Using HART on the 1769sc-OF4IH Figure 7-9h User’s Manual 0300217-03 Rev.
7-24 Compact IO™ Isolated HART Analog Output Module Figure 7-9i User’s Manual 0300217-03 Rev.
Chapter 7: Enabling and Using HART on the 1769sc-OF4IH Figure 7-9j User’s Manual 0300217-03 Rev.
7-26 Compact IO™ Isolated HART Analog Output Module Figure 7-9k User’s Manual 0300217-03 Rev.
Chapter 7: Enabling and Using HART on the 1769sc-OF4IH Figure 7-9l User’s Manual 0300217-03 Rev.
7-28 Compacct IO™ Isolateed HART Anallog Output Moodule Section n 7.4 Module Specific ands Comma o module uses module sspecific commaands. Module specific comm mands The HART output include the HART H pass-thrrough, HART ssuspend and reesume, and gett HART devicee information.. The comman nds are passed tto the module uusing the inputt and output im mage.
Chapter 7: Enabling and Using HART on the 1769sc-OF4IH 7-29 Table 7-10 (Response If Device Information Is Not Available) HART Get Device Information - reply packet structure Field Value Definition HART Channel Number 0x00 – 0x03 (1 byte) Status (1 byte) 34 = DR_RUNNING 35 = DR_DEAD (bad request) (1 byte) 0 Module input channel number for HART command Command status Count Handle Set to 1 Fill byte of zero to keep command response common among all replies.
7-30 Compact IO™ Isolated HART Analog Output Module HART Get Device Information - reply packet structure Field Value Definition HARTSlot2Units (1 byte) CMD#33, Byte 13, 0 if not present Output module use only. HARTSlot3Units (1 byte) CMD#33, Byte 19, 0 if not present Output module use only.
Chapter 7: Enabling and Using HART on the 1769sc-OF4IH 7-31 timeout timer. Refer to Chapter 6 for information regarding how to set the handle timeout. The reply message will be kept persistent during the handle timeout period. When the handle timeout timer expires the reply message will be discarded, and another pass through message will be serviced without being rejected. The user defined handle timeout is in the range of 1 to 255 seconds.
7-32 Compact IO™ Isolated HART Analog Output Module Table 7-12 (HART Pass -Through Request Command) HART pass through command request – command message packet structure Field Value Definition HART Channel Number 0x00 – 0x03 (1 byte) Command Number 0x01 (1 byte) HART Command N bytes N = Length of message – 2 Module input channel number for HART command The command number to issue a HART pass-through command.
Chapter 7: Enabling and Using HART on the 1769sc-OF4IH 7-33 DEAD will be sent back if any of the following conditions are true: Command or HART Channel number is invalid. HART channel is not enabled. HART communication has not been established, meaning that the 5-byte unique address has not been determined yet. The channel is currently updating device information.
7-34 Compact IO™ Isolated HART Analog Output Module Table 7-14 (HART Pass-Through Query Command) HART pass through command complete query - command message packet structure Field Value Definition HART Channel Number 0x00 – 0x03 (1 byte) Command Number 0x0C (1 byte) Module input channel number for HART command The command number Handle (1 byte) 1-255 The handle from command request reply If the data associated with the handle is not yet available, or invalid, the following reply message will be
Chapter 7: Enabling and Using HART on the 1769sc-OF4IH 7-35 The command status, the second byte in the reply packet for the module specific command, can return three different responses, SUCCESS, RUNNING and DEAD. These responses echo the state of the module at the time the command is sent. The conditions for each response are as follows: SUCCESS will be sent back under the following conditions: Command and HART Channel number are both valid. HART channel is enabled.
7-36 Compact IO™ Isolated HART Analog Output Module Figure 7-11b User’s Manual 0300217-03 Rev.
Chapter 7: Enabling and Using HART on the 1769sc-OF4IH Figure 7-11c User’s Manual 0300217-03 Rev.
7-38 Compact IO™ Isolated HART Analog Output Module Figure 7-11d User’s Manual 0300217-03 Rev.
Chapter 7: Enabling and Using HART on the 1769sc-OF4IH Figure 7-11e User’s Manual 0300217-03 Rev.
7-40 Compact IO™ Isolated HART Analog Output Module Figure 7-11f Note: The ladder in Figure 7-11 can be found in the project sample file located on our website at (www.spectrumcontrols.com) User’s Manual 0300217-03 Rev.
7-41 Chapter 7: Enabling and Using HART on the 1769sc-OF4IH Section 7.5 HART Protocol Overview In order to read and write HART commands to and from the field device reliably using the OF4IH, you must have a basic knowledge of the HART protocol. This section will explain in detail the various pieces that make up the HART message and how to formulate the message and send it to the field device using the module specific PassThrough command, which was described earlier in this chapter. 7.5.
7-42 Compact IO™ Isolated HART Analog Output Module discussion of the short frame form. In either format, the single-bit address of the master is the most significant. Only two masters are allowed for example, a control system and a hand-held communicator. The most significant bit of the address field differentiates these two hosts. Primary masters such as the OF4IH use address 1, and secondary masters such as handhelds use address 0. Please see figure below.
Chapter 7: Enabling and Using HART on the 1769sc-OF4IH 7-43 Data This portion of the HART message contains the data, if any, for the command. Not all commands or responses contain data. For those that do, up to 25 bytes can be included. Data may be in the form of unsigned integers, floating point numbers, or ASCII character strings. The number of bytes of data and the data format used for each item are specified for each HART command.
7-44 Compact IO™ Isolated HART Analog Output Module Table 7-19 Tag Nam e HART_PASS_THRU_QRY_RX[0] HART_PASS_THRU_QRY_RX[1] HART_PASS_THRU_QRY_RX[2] HART_PASS_THRU_QRY_RX[3] HART_PASS_THRU_QRY_RX[4] HART_PASS_THRU_QRY_RX[5] HART_PASS_THRU_QRY_RX[6] HART_PASS_THRU_QRY_RX[7] HART_PASS_THRU_QRY_RX[8] HART_PASS_THRU_QRY_RX[9] HART_PASS_THRU_QRY_RX[10] HART_PASS_THRU_QRY_RX[11] HART_PASS_THRU_QRY_RX[12] HART_PASS_THRU_QRY_RX[13] HART_PASS_THRU_QRY_RX[14] HART_PASS_THRU_QRY_RX[15] HART_PASS_THRU_QRY_RX[16] HART_
Chap pter 8 Prog gramm ming E Exam mples This chapterr provides ladd der samples forr general and addvanced appliccations using thhe 1756sc-OF4 4IH module. Ladder samples for both the C CompactLogix and MicroLoggix 1500 PLC arre discussed in n this chapter. Section n 8.1 Compac ctLogix 8.1.1 Reseet/Reconfig The followin ng rungs of lad dder demonstraate how to eitheer reset the moodule (Backplanne connection will w be broken)) or reconfiguree the module w without breakinng the connectiion.
8-2 Compaact IO™ Isolateed HART Analog Output Moodule Figure 8-2 2 (Reconfig) User’s Man nual 0300217-03 Rev.
Chapter 8: Programming Examples 8-3 8.1.3 Swap Byte Order This ladder sample demonstrates how to reverse the order of the bytes for a floating point tag and then convert it to 4 consecutive SINT tags, so that it can be used in a HART message. If the HART message being sent or received using the pass-through command contains floating point values, the order of the bytes must be reversed. ! Attention Figure 8-3 (Change Byte Order) 8.1.
8-4 Compact IO™ Isolated HART Analog Output Module as needed. The ladder sample starting on the next page demonstrates how to pack 4 unpacked ASCII characters into 3 bytes. Figure 8-4a (Packed ASCII) User’s Manual 0300217-03 Rev.
Chapter 8: Programming Examples Figure 8-7b User’s Manual 0300217-03 Rev.
8-6 Compact IO™ Isolated HART Analog Output Module Section 8.2 MicroLogix 1500 The following ladder samples provide a working HART solution for the MicroLogix 1500 when used with the OF4IH module. The following table briefly describes each routine in the project file. ! Attention It is recommended that a 1764-LRP series C processor with firmware version 5 or higher be used. The LRP processor supports floating point files, which is required to read floating point data from the OF4IH.
Chapter 8: Programming Examples 8.2.1 MAIN Routine The main routine is the starting point for the ladder program. Figure 8-5 (Main Routine) User’s Manual 0300217-03 Rev.
8-8 Compact IO™ Isolated HART Analog Output Module 8.2.2 PACKETS Routine The “packets” routine is used to demultiplex the HART data from the input file to individual integer files, so that the data can be viewed or used within the ladder program. This routine is called from the MAIN routine. Figure 8-6a (Packets Routine) User’s Manual 0300217-03 Rev.
Chapter 8: Programming Examples Figure 8-6b User’s Manual 0300217-03 Rev.
8-10 Compact IO™ Isolated HART Analog Output Module Figure 8-6c User’s Manual 0300217-03 Rev.
Chapter 8: Programming Examples 8.2.3 MSG_TO_MOD Routine This routine is used to send and receive messages to and from the module. Refer to Chapter 7 for more details regarding sending and receiving messages. This routine is called from the HART_MSG routine. Figure 8-7a (Message to Module) User’s Manual 0300217-03 Rev.
8-12 Compact IO™ Isolated HART Analog Output Module Figure 8-7b User’s Manual 0300217-03 Rev.
Chapter 8: Programming Examples Figure 8-7c User’s Manual 0300217-03 Rev.
8-14 Compact IO™ Isolated HART Analog Output Module Figure 8-7d User’s Manual 0300217-03 Rev.
Chapter 8: Programming Examples Figure 8-7e User’s Manual 0300217-03 Rev.
8-16 Compact IO™ Isolated HART Analog Output Module Figure 8-7f User’s Manual 0300217-03 Rev.
Chapter 8: Programming Examples Figure 8-7g User’s Manual 0300217-03 Rev.
8-18 Compact IO™ Isolated HART Analog Output Module Figure 8-7h User’s Manual 0300217-03 Rev.
Chapter 8: Programming Examples Figure 8-7i User’s Manual 0300217-03 Rev.
8-20 Compact IO™ Isolated HART Analog Output Module Figure 8-7j User’s Manual 0300217-03 Rev.
Chapter 8: Programming Examples Figure 8-7k User’s Manual 0300217-03 Rev.
8-22 Compact IO™ Isolated HART Analog Output Module Figure 8-7l User’s Manual 0300217-03 Rev.
Chapter 8: Programming Examples Figure 8-7m User’s Manual 0300217-03 Rev.
8-24 Compact IO™ Isolated HART Analog Output Module Figure 8-7n User’s Manual 0300217-03 Rev.
Chapter 8: Programming Examples Figure 8-7o User’s Manual 0300217-03 Rev.
8-26 Compact IO™ Isolated HART Analog Output Module Figure 8-7p User’s Manual 0300217-03 Rev.
Chapter 8: Programming Examples Figure 8-7q User’s Manual 0300217-03 Rev.
8-28 Compact IO™ Isolated HART Analog Output Module 8.2.4 SRC_CHECK Routine Calculates the checksum for a message sent to the module one page at a time. This routine is called from the MSG_TO_MOD routine. Figure 8-8a (Source Checksum) User’s Manual 0300217-03 Rev.
Chapter 8: Programming Examples Figure 8-8b User’s Manual 0300217-03 Rev.
8-30 Compact IO™ Isolated HART Analog Output Module 8.2.5 DEST_CHECKSUM Routine This routine calculates the checksum for a message received from the module one page at a time. This routine is called from the MSG_TO_MOD routine. Figure 8-9a (Destination Checksum) User’s Manual 0300217-03 Rev.
Chapter 8: Programming Examples Figure 8-9b User’s Manual 0300217-03 Rev.
8-32 Compact IO™ Isolated HART Analog Output Module 8.2.6 HART_MSG Routine This routine composes HART messages that will be sent to the module/field transmitter. This routine is called from the MAIN routine. Figure 8-10a (HART Message) User’s Manual 0300217-03 Rev.
Chapter 8: Programming Examples Figure 8-10b User’s Manual 0300217-03 Rev.
8-34 Compact IO™ Isolated HART Analog Output Module Figure 8-10c User’s Manual 0300217-03 Rev.
Chapter 8: Programming Examples Figure 8-10d User’s Manual 0300217-03 Rev.
8-36 Compact IO™ Isolated HART Analog Output Module Figure 8-10e User’s Manual 0300217-03 Rev.
Chapter 8: Programming Examples Figure 8-10f User’s Manual 0300217-03 Rev.
8-38 Compact IO™ Isolated HART Analog Output Module Figure 8-10g User’s Manual 0300217-03 Rev.
Chapter 8: Programming Examples Figure 8-10h User’s Manual 0300217-03 Rev.
8-40 Compact IO™ Isolated HART Analog Output Module Figure 8-10i User’s Manual 0300217-03 Rev.
Chapter 8: Programming Examples Figure 8-10j User’s Manual 0300217-03 Rev.
8-42 Compact IO™ Isolated HART Analog Output Module Figure 8-10k User’s Manual 0300217-03 Rev.
Chapter 8: Programming Examples 8-43 8.2.7 WORD_BYTE Routine Converts word data to its byte equivalent. This routine is called from the HART_MSG routine. Figure 8-11a (Word to Byte) User’s Manual 0300217-03 Rev.
8-44 Compact IO™ Isolated HART Analog Output Module Figure 8-11b User’s Manual 0300217-03 Rev.
Chapter 8: Programming Examples Figure 8-11c User’s Manual 0300217-03 Rev.
8-46 Compact IO™ Isolated HART Analog Output Module 8.2.8 HART_CHECK Routine Calculates the checksum for the HART message being sent to the module/field device. This routine is called from the HART_MSG routine. Figure 8-12a (HART Checksum) User’s Manual 0300217-03 Rev.
Chapter 8: Programming Examples Figure 8-12b User’s Manual 0300217-03 Rev.
8-48 Compact IO™ Isolated HART Analog Output Module 8.2.9 BYTE_WORD Routine Converts byte data to its word equivalent. This routine is called by the HART_MSG routine. Figure 8-13a (Byte to Word) Figure 8-13b User’s Manual 0300217-03 Rev.
Chapter 8: Programming Examples User’s Manual 0300217-03 Rev.
8-50 Compact IO™ Isolated HART Analog Output Module User’s Manual 0300217-03 Rev.
Chapter 9 Diagnostics and Troubleshooting This chapter describes troubleshooting the isolated HART output module. This chapter contains information on: Safety considerations while troubleshooting Internal diagnostics during module operation Module error codes Contacting Spectrum Controls, Inc. for technical assistance Section 9.1 Safety Considerations Safety considerations are an important element of proper troubleshooting procedures.
9-2 Compact IO™ Isolated HART Analog Output Module control relay is de-energized, thereby removing power to the machine. Never alter these circuits to defeat their function. Serious injury or machine damage could result. Section 9.2 Module Operation vs. Channel Operation The module performs diagnostic operations at both the module level and the channel level.
Chapter 9: Diagnostics and Troubleshooting 9-3 9.4.2 Over or Under-Range Detection Whenever a channel is commanded to an output level outside of the defined operating range, an over-range or under-range error is indicated in input data word 1. Possible causes of an out-of-range condition include: The output device is faulty. The field wiring may be faulty. The low clamp or high clamp values have been exceeded Section 9.5 Non-critical vs.
9-4 Compact IO™ Isolated HART Analog Output Module Table 9-3 (Module Error Types) Er r or Type No errors M odule Er r or Fie ld V alue Bits 11 thr ough 9 (binar y) 000 Hardw are Errors Conf iguration Errors 001 010 De s cr iption No error is present. The extended error f ield holds no additional inf ormation. General and specif ic hardw are error codes are specif ied in the extended error inf ormation f ield. Module-specif ic error codes are indicated in the extended error f ield.
Chapter 9: Diagnostics and Troubleshooting 9-5 Section 9.7 Error Codes The table below explains the extended error code.
9-6 Compact IO™ Isolated HART Analog Output Module User’s Manual 0300217-03 Rev.
Appendix A Module Specifications Electrical Specifications Number of Channels Output Ranges Output Load Resolution Full Scale Settling Time without HART enabled Full Scale Settling Time with HART enabled Analog Output Update Rate Differential Nonlinearity Output Ripple Repeatability Max Inductive Load Output Impedance Accuracy 4 single isolated outputs with HART 0 to 20.0 mA and 4 to 20mA 750 ohm max. 16 bits over full design range (0-21.
A-2 Compact IO™ Isolated HART Analog Output Module Environmental Specifications Shock & Vibration (op) Shock Unpackaged (op) Operating Temperature Storage Temperature Humidity/Pressure Class III Class III, Cat. I 0 to 60 Degree C1 -40 to 85 Degree C 5 to 95% RH (non cond.) Regulatory Compliance UL 508 ANSI/ISA 12.12.01 UL-C Class 1, Div2 Group A, B, C, D (CSA Equiv.
Appendix B HART Universal and Common Practice Commands User’s Manual 0300217-03 Rev.
B-2 Compact IO™ Isolated HART Analog Output Module User’s Manual 0300217-03 Rev.
Appendix B: HART Universal and Common Practice Commands User’s Manual 0300217-03 Rev.
B-4 Compact IO™ Isolated HART Analog Output Module User’s Manual 0300217-03 Rev.
Index Terminal Block Grounding · 3-7 A Address · 7-41 Alarm Latch · 6-6 Auto Acquisition · 7-3 B Big-endian · 7-30 Byte Count · 7-42 C Cable · 3-9 Channel Diagnostics · 9-2 Channel HART Enable · 6-10 Checksum · 7-43 Command · 7-42 Configuring the IF4IH for the Micro 1500 · 5-2 Configuring the module for HART · 7-1 Copying Controller Tags · 4-9 Copying Data Types · 4-7 Copying Ladder · 4-13, 5-7 Copying Routines or Programs · 4-12, 5-6 D Data · 7-43 Data Format · 6-7, 6-8 Data Formats · 1-1 Data Type
Message Request Buffer · 6-12, 7-12 Message Request Size · 6-12, 7-11 Message Response Buffer · 6-3, 7-12 Message Response Size · 6-3, 7-12 Message Slave Control · 6-3, 7-12 Messages · 7-11 Micro 1500 Ladder Samples · 5-6 MicroLogix 1500 Addressing · 5-2 Minimum Spacing · 3-5 Module Configuration · 6-4 Module Error · 9-3 Module Operation · 1-4 module specific commands · 7-3 Module Specific Commands · 7-28 Module Update Time · 6-13 Mounting Minimum Spacing Panel Mounting Using Dimensional Template Din Rail M
Getting Technical Assistance Note that your module contains electronic components which are susceptible to damage from electrostatic discharge (ESD). An electrostatic charge can accumulate on the surface of ordinary plastic wrapping or cushioning material. In the unlikely event that the module should need to be returned to Spectrum Controls, please ensure that the unit is enclosed in approved ESD packaging (such as static-shielding / metallized bag or black conductive container).
©2 2012, Spectrum m Controls, Incc. All rights resserved. Specificcations subjectt to change witthout notice. T The En ncompass logo and ControlLo ogix are tradem marks of Rockw well Automatioon. orporate Head dquarters Co Sp pectrum Contro ols Inc. P.O O. Box 6489 Beellevue, WA 98008 USA Faax: 425-641-9473 Teel: 425-746-948 81 Web Site: www.spectrum mcontrols.com m E-mail: specctrum@spectrrumcontrols.com User’ss Manual 0300217-03 Rev.