manualshive.com logo in svg

Allen-Bradley 5069-SERIAL, User Manual, Page: 99 / 110

Share
Download
Allen-Bradley 5069-SERIAL User Manual Download Page 99

Rockwell Automation Publication 5069-UM003A-EN-P - May 2018

101

Appendix

 C

Programming Example

Generic ASCII Sample Code 
Configuration

The following images show sample code for Generic ASCII Transmit data and 
Generic ASCII Receive data. 

Generic ASCII Transmit and Receive Channel Configurations

The following image shows the Generic ASCII Transmit Configuration.

The following image shows the Generic ASCII Receive Configuration

Summary of Contents for 5069-SERIAL

Page 1: ...Compact 5000 I O Serial Module Catalog Number 5069 SERIAL User Manual OriginalInstructions...

Page 2: ...nformation circuits equipment or software described in this manual Reproduction of the contents of this manual in whole or in part without written permission of Rockwell Automation Inc is prohibited T...

Page 3: ...al Module OperationinaLogix5000Control System Controller and Software Compatibility 13 Local I O or Remote I O Modules 14 Local I O Module 14 Remote I O Module 15 Ownership 16 Construct a System That...

Page 4: ...ic ASCII Receive Functions 33 Data Received from the Serial Port in Immediate Mode 35 Data Received from the Serial Port in Master Slave Handshake Mode 36 Modbus Master Data Exchange 37 Modbus Master...

Page 5: ...gs 88 AppendixB Master Command List Master Command List Function Codes 91 Read Coil Status Function Code 01 91 Read Input Status Function Code 02 93 Read Holding Registers Function Code 03 94 Read Inp...

Page 6: ...6 Rockwell Automation Publication 5069 UM003A EN P May 2018 Table of Contents AppendixD ASCII Conversion Tables ASCII Conversions 107 Index 109...

Page 7: ...ams Compact 5000 I O modules 5000 Series Digital I O Modules in Logix5000 Control Systems User Manual publication 5000 UM004 Describes how to use 5000 Series digital I O modules 5000 Series Analog I O...

Page 8: ...ockwell Automation Publication 5069 UM003A EN P May 2018 Preface To order paper copies of technical documentation contact your local Allen Bradley distributor or Rockwell Automation sales representati...

Page 9: ...Rockwell Automation Publication 5069 UM003A EN P May 2018 9 Preface Notes...

Page 10: ...10 Rockwell Automation Publication 5069 UM003A EN P May 2018 Preface...

Page 11: ...tion mode Generic ASCII Modbus RTU Master Slave Modbus ASCII Master Slave The serial module can reside locally in a CompactLogix 5380 system or a Compact GuardLogix 5380 system The module can also res...

Page 12: ...tem Item Name Description 1 Status Indicators Displays the status of communication module health and input output devices Indicators help with troubleshooting anomalies 2 Interlocking side pieces Secu...

Page 13: ...ng controllers CompactLogix 5380 Compact GuardLogix 5380 ControlLogix 5580 GuardLogix 5580 The manner in which you use the serial module affects controller compatibility You can use Compact 5000 I O s...

Page 14: ...ocal I O modules are installed to the right of the controller and exchange data with the controller over the system backplane Figure 2 Compact 5000 I O Serial Module as Local I O Module IMPORTANT Comp...

Page 15: ...modules in the following CompactLogix 5380 control systems Compact GuardLogix 5380 control systems ControlLogix 5580 control systems GuardLogix 5580 control systems 527 F1 F2 F3 F4 F5 F6 F7 F8 F9 F10...

Page 16: ...system Each Compact 5000 I O serial module must continuously maintain communication with its owner controller during normal operation Construct a System That Uses a Compact 5000 I O Serial Module Befo...

Page 17: ...apter depending on whether the Serial module is a local or remote I O module For more information on how to power local Compact 5000 I O modules see the CompactLogix 5380 and Compact GuardLogix 5380 C...

Page 18: ...ccupies the slot that the configuration references When you download module configuration to a controller the controller attempts to establish a connection to each module in the configuration Because...

Page 19: ...choose a mode that is the Generic ASCII Modbus Master or Modbus Slave mode The combination of channel configuration choices determines the number of connections that are made between the owner contro...

Page 20: ...tocol combinations Table 2 I O Connections For Each Protocol Combination CH0 Protocol Choice Disabled Generic ASCII Modbus Slave Modbus Master CH1 Protocol Disabled 0 connection 1 connection 1 connect...

Page 21: ...equired 5069 SERIAL module is not available for insertion To install Compact 5000 I O modules you attach them to left most device in the system The node addresses increment as each module is installed...

Page 22: ...ning with the controller or the adapter The field potential distributor blocks the passage of field side power from the left and functions as a new field side power source for the modules to the right...

Page 23: ...ices in various communication mediums For example the RS 232C RS 422 or RS 485 General Module Features The Compact 5000 I O serial module supports the following module wide features Software Configura...

Page 24: ...Packet Interval The Requested Packet Interval RPI is a configurable parameter that defines a specific rate at which data is exchanged between the owner controller and the module You set the RPI value...

Page 25: ...gner application Module Status indicators For more information on fault reporting see the full chapter Troubleshoot Your Module on page 71 Protocol Setting Range of RPI Generic ASCII 2 ms 750 ms by 0...

Page 26: ...uration is not sent to the module until the connection is uninhibited In your application a controller already owns a module has downloaded the configuration to the module and is exchanging data over...

Page 27: ...te the defined device With Compatible Module you can typically replace a device with another device that has the following characteristics Same catalog number Same or higher Major Revision Minor Revis...

Page 28: ...ot Your Module on page 71 Module Firmware The Compact 5000 I O serial modules are manufactured with module firmware installed If updated module firmware revisions are available in the future you can u...

Page 29: ...e of communication that is used by each channel No Handshake default Full duplex Half duplex Continuous Carrier A carrier frequency that is transmitted even when data is not being sent Continuous carr...

Page 30: ...trol Line Menu Modem Duplex Status Controller Your Function Choice Continuous Carrier Not using a modem No Handshaking Using a modem Modems in a point to point link are full duplex Full duplex Master...

Page 31: ...using the following steps 1 The controller sends out the consumed packet with an incremented TxID 2 The serial module puts the packet into the TxBuffer 3 The serial module takes the oldest data from t...

Page 32: ...gth output tag at 0 Table 5 Generic ASCII Transmit Functions Parameter Definition Available Options Swap Mode Selectwhetherswappingwillbedoneorwhatswappingmethodistobe used before the module sends out...

Page 33: ...ed on the Start Delimiter character but this byte is not included in the ASCII RxData input tag Include Start Delimiter is always the first byte in the ASCII RxData input tag Start Delimiter Beginning...

Page 34: ...the ASCII packed based on timeout since the last character was received the timeout in milliseconds is configured in the Message Timeout parameter For this method configure Termination Mode for Ignor...

Page 35: ...eout timer expires b The number of received bytes equals the configured Read Buffer Size c Termination Delimiter bytes were received 3 The serial module copies the data into the ASCII RxData input tag...

Page 36: ...added into the RxBuffer 4 Once the RxID Consume Tag is incremented by the user logic the serial module takes the oldest record from RxBuffer copies the data into the ASCII RxData input tag copies the...

Page 37: ...dbus Slave The Compact 5000 I O Serial Module can get Modbus Data from Produced Consumed Data command every RPI Modbus Master Write Command ControlLogix 5580 CompactLogix 5380 5069 Serial Modbus Maste...

Page 38: ...nd 5069 Serial Modbus Master Config Tag Command List Output Tag Output Data to Slave Input Tag Input Data from Slave Produced Data Consumed Data CH0 Config Data Consumed Data Produced Data CH1 Command...

Page 39: ...write data to the Modbus Slave Read the Modbus Master reads data from the Modbus Slave Modbus Slave Write Command 5069 Serial Modbus Slave Config Tag Mapping Table Output Tag Output Data to Master In...

Page 40: ...nd 5069 Serial Modbus Slave Config Tag Mapping Table Output Tag Output Data to Master Input Tag Input Data from Master Produced Data Consumed Data CH0 Config Data Consumed Data Produced Data CH1 Mappi...

Page 41: ...adcast Pause The Wait time of each channel until the Modbus Slave finishes processing according to broadcasted command from the Modbus Master The Modbus Master does not send the next command until thi...

Page 42: ...8 1002 604 1750 65535000 us 57600 3500 190 972 668 403 1750 65535000 us 115200 3500 95 486 334 201 1750 65535000 us Table 10 Modbus Slave Configuration Parameters Parameter Definition Available Option...

Page 43: ...I O EtherNet IP adapter to a Logix Designer application project see the EtherNet IP Communication Modules in 5000 Series Systems User Manual publication ENET UM004 TIP When a controller establishes a...

Page 44: ...o create a module in the project There are two methods to add modules to your Logix Designer application project Discover Local I O Modules Discover Remote I O Modules Discover Local I O Modules To us...

Page 45: ...M003A EN P May 2018 45 Configure Compact 5000 I O Serial Module Chapter 4 3 At the Select Module Type window click Create to add the discovered module to your project 4 At the New Module window config...

Page 46: ...g box To add additional local I O modules with this method complete one of the following If you cleared the Close on Create checkbox when you created the first I O module repeat steps 3 6 If you did n...

Page 47: ...plete these steps 1 Right click the 5069 Backplane and choose New Module TIP ThisexampleshowshowtoaddalocalI OmodulewhentheLogixDesigner application project is offline Youcanaddnewmoduleswhentheprojec...

Page 48: ...the New Module window configure the module properties and click OK To add additional local I O modules with this method complete one of the following If you cleared the Close on Create checkbox when y...

Page 49: ...these steps 1 Go online with your Logix Designer application The project must include at Compact 5000 I O EtherNet IP adapter 2 Right click the Compact 5000 I O EtherNet IP adapter and choose Discover...

Page 50: ...log box make sure that Inhibit module connection is selected and click Yes 6 Close the Select Module Type dialog box To add additional remote I O modules with this method complete one of the following...

Page 51: ...e steps 1 Right click the 5069 Compact I O EtherNet IP adapter and choose New Module TIP ThisexampleshowshowtoaddalocalI OmodulewhentheLogixDesigner application project is offline Youcanaddnewmodulesw...

Page 52: ...M003A EN P May 2018 Chapter 4 Configure Compact 5000 I O Serial Module 2 Select the module and click Create The New Module dialog box appears with a list of categories on the left side The number and...

Page 53: ...odule configuration The rest of this chapter describes how to edit module configuration categories To add additional remote I O modules with this method complete one of the following If you cleared th...

Page 54: ...nnection Category Module Info Category View the Module Tags General Category The General category appears first when you create a module The parameters in this category are the same for all Compact 50...

Page 55: ...on parameters are available on the General tab of the Module Properties dialog box in the Logix Designer application project The module definition can only be edited during offline mode Table 11 descr...

Page 56: ...Module Disable Keying Connection Definition establishes a connection between the controller and the module Data Channel 0 1 Determines the following for the module type you configure Determines the pr...

Page 57: ...rs If you choose Modbus Master see Figure 9 for an example of your options If you choose Modbus Slave see Figure 10 for an example of your options Figure 9 Modbus Master Module Definition Parameters T...

Page 58: ...dresses 000000 065535 This command writes to only one coil Preset Single Register This code writes to Modbus addresses 400000 465535 This command writes to only one coil Force Multiple Coils This code...

Page 59: ...r 2000 coils discrete input read or 1968 coils written Each command uses Two bytes of input data per holding register or input register read One byte of input data per every 1 8 coils or discrete inpu...

Page 60: ...ure the user program is adjusted to reflect the new location of the command or the program will show and error Table 14 Modbus Slave Module Definition Parameters Parameter Definition Register Type Dis...

Page 61: ...he controller Each register type has a predefined array size it can be used for the Modbus Slave as indicated in the Modbus Slave Address Table Limits For example a Holding register has the limit of 1...

Page 62: ...sters up to 100 INTs or 50 REALs Up to 128 Coils Data Indexes 0 15 at 8 bit boundaries Up to 128 Discrete inputs Data Indexes 0 15 at 8 bit boundaries ModbusSlaveDataMappingExample Local 1 O1 Slave Ho...

Page 63: ...nformation on the RPI see on page 24 Inhibit the module For more information on inhibit the module see page 26 The connection over EtherNet IP will be Unicast only Configure whether a connection failu...

Page 64: ...SCII Figure 12 Generic ASCII Connection Figure 13 Generic ASCII Module Info Figure 14 Figure 16 show the communication port that defines the baud rate serial media setting and receive and transmit set...

Page 65: ...65 Configure Compact 5000 I O Serial Module Chapter 4 Figure 15 Generic ASCII Receive For more information see Generic ASCII Receive Functions on page 33 Figure 16 Generic ASCII Transmit For more inf...

Page 66: ...EN P May 2018 Chapter 4 Configure Compact 5000 I O Serial Module ModbusMasterandSlave Figure 17 Modbus Master and Slave Connection Figure 18 Channel 0 and Channel 1 Parameters For module function defi...

Page 67: ...Figure 20 show the detailed communication settings for Modbus Master and Modbus Slave Figure 19 Modbus Master Channel Parameters For Modbus Master function definitions see Modbus Master Functions on...

Page 68: ...5000 I O Serial Module Module Info Category The Module Info category displays module and status information about the module when the project is online You can use this category to complete the follow...

Page 69: ...the Tag Editor Each configured feature on your module has a distinct tag that is available for use in the controller program logic Complete the following steps to access the tags for a module 1 In the...

Page 70: ...70 Rockwell Automation Publication 5069 UM003A EN P May 2018 Chapter 4 Configure Compact 5000 I O Serial Module Notes...

Page 71: ...Serial modules Topic Page Module Status Indicator 71 Compact 5000 I O Serial Module Status Indicators 73 Table 15 Module Status Indicator Compact 5000 I O Module Indicator State Description Recommend...

Page 72: ...ss A module firmware update attempt failed The device has experienced a recoverable fault A connection to the module has timed out Complete one of the following Let the firmware update progress comple...

Page 73: ...Status Indicator Descriptions Indicator State Description Recommended Action Off Channel is disabled or there is no communication None Steady Yellow Communicating None Flashing Yellow Communicating No...

Page 74: ...74 Rockwell Automation Publication 5069 UM003A EN P May 2018 Chapter 5 Troubleshoot Your Module Notes...

Page 75: ...eneric ASCII and Modbus Slave Name Conventions The following is an example for a Generic ASCII or Modbus Slave tag name The conventions for the example SERIAL_PROJECT 1 I0 RunMode would be the followi...

Page 76: ...the module 1 slot number I00 tag type input channel number 0 number of connections 0 The possible Compact 5000 I O serial tag types are I input and O output The possible channels are channel 0 and ch...

Page 77: ...May 2018 77 Module Tags Appendix A Channel Configured Generic ASCII Tags This section describes the tags that are created when you choose the Generic ASCII option for a channel in the module definiti...

Page 78: ...3A EN P May 2018 Appendix A Module Tags Channel Configured for Generic ASCII Input Tags The following image shows the tags that are described in the following table Table 17 describes the input tags o...

Page 79: ...rect the cause of the inaccuracy IMPORTANT Once the condition that causes the tag to change to 1 is removed the tag automatically resets to 0 Ix ASCII TxDataLost BOOL The transmitted data was lost Unt...

Page 80: ...DTR is active 0 Inactive 1 Active Ix ASCII XOFF BOOL Flag for detection Xoff Flow control 0 On 1 XOff is detected Ix ASCII BREAK BOOL Status shows whether a Break Interrupt occurred or not If a Break...

Page 81: ...f each channel 1 256 Ox ASCII RxDataLength INT Length of Received Data of each channel 1 256 Ox ASCII ClearBuffer BOOL If Clear Buffer the bit changes from 0 to 1 the Receive and Transaction buffer is...

Page 82: ...bus Master command number and the zzzzzz represents the Modbus data address Table 19 Modbus Master Input Tags Name Data Type Definition Valid Values Ixx RunMode BOOL Channel s operating state 0 Idle 1...

Page 83: ...ew command is executed not changed command is not executed or have not finished yet 1 value shown prior to any command 0 49 Ixx Command yy Fault BOOL Indicates that channel data isinaccurate and canno...

Page 84: ...INT INT or REAL Command read response data The data for this tag is dynamic according to how the command list is created 128 127 32768 32767 Table 19 Modbus Master Input Tags Name Data Type Definition...

Page 85: ...Rockwell Automation Publication 5069 UM003A EN P May 2018 85 Module Tags Appendix A Channel Configured for Modbus Slave This screen capture shows the tags that are described in the following tables...

Page 86: ...odule to correct the cause of the inaccuracy IMPORTANT Once the condition that causes the tag to change to 1 is removed the tag automatically resets to 0 Ix Slave Uncertain BOOL Indicates that the cha...

Page 87: ...er for the serial module 32768 32767 Ox Slave Coils x 2 SINT Locationofslavecoilvaluesdefinedbyuserfortheserialmodule 128 127 Ox Slave InputRegister x 3 INT Location of input register values defined b...

Page 88: ...88 Rockwell Automation Publication 5069 UM003A EN P May 2018 Appendix A Module Tags Notes...

Page 89: ...can have restrictions that lower the maximum quantity The coils are numbered from zero coil number 1 zero coil number 2 one coil number 3 two and so on The following table is a sample read output sta...

Page 90: ...se the slave interface device is serviced at the end of a controller s scan data reflects coil status at the end of the scan Some slaves limit the quantity of coils provided each scan thus for large c...

Page 91: ...input status request to read inputs 10197 to 10218 22 coils from slave number 11 Response An example response to Read Input Status is as shown in the following table The data is packed one bit for eac...

Page 92: ...Query This function allows you to retrieve the contents of holding registers 4xxxx Modbus 4x range in the addressed slave The registers can store the numerical values of associated timers and counter...

Page 93: ...555 0 and 100 respectively Read Input Registers Function Code 04 Query This function retrieves the contents of the controller s input registers from the Modbus 3x range These locations receive their v...

Page 94: ...ter contents provided each scan thus for large register quantities multiple PC scans are required and the data that is provided is from sequential scans In the following example the register 30009 con...

Page 95: ...p Thus if such a coil is set ON by function Code 5 and even months later an output is connected to that coil the output is hot TIP Functions5 6 15 and16aretheonlymessagesthatarerecognizedasvalid for b...

Page 96: ...mode all slave controllers load the specified register with the contents specified The following example is a request to write the value 3 to register 40002 in slave 11 Response The response to a pre...

Page 97: ...e desired coils The following example forces 10 coils starting at address 20 13 HEX The two data fields CD 1100 and 00 0000 000 indicate that coils 27 26 23 22 and 20 are to be forced on Response The...

Page 98: ...ion 16 query is to echo the address function code starting address and number of registers to be loaded TIP Functions5 6 15 and16aretheonlymessagesthatarerecognizedasvalid for broadcast TIP This is th...

Page 99: ...e Code Configuration The following images show sample code for Generic ASCII Transmit data and Generic ASCII Receive data Generic ASCII Transmit and Receive Channel Configurations The following image...

Page 100: ...y transmitting out Channel 0 and receiving in Channel 1 connect the two serial ports together using a 1761 CBL AC00 cable On the Module Properties Channel screens verify that both channels are configu...

Page 101: ...Rockwell Automation Publication 5069 UM003A EN P May 2018 103 Programming Example Appendix C...

Page 102: ...nd Modbus Slave communication Modbus Master Command List Modbus Slave Address Mapping Table Modbus Sample Code Configuration Example To test the Modbus capabilities by configuring Channel 0 for Master...

Page 103: ...Rockwell Automation Publication 5069 UM003A EN P May 2018 105 Programming Example Appendix C Modbus Master Sample Code Modbus Slave Sample Code...

Page 104: ...106 Rockwell Automation Publication 5069 UM003A EN P May 2018 Appendix C Programming Example...

Page 105: ...trol G Rings bell 32 40 20 0100000 Space SP 8 10 08 0001000 ControlH Backspaceonsome terminals 33 41 21 0100001 9 11 09 0001001 Control I Horizontal tab on some terminals 34 42 22 0100010 10 12 0A 000...

Page 106: ...68 1101000 h 70 106 46 1000110 F 105 151 69 1101001 i 71 107 47 1000111 G 106 152 6A 1101010 j 72 110 48 1001000 H 107 153 6B 11010111 k 73 111 49 1001001 I 108 154 6C 1101100 l 74 112 4A 1001010 J 1...

Page 107: ...onnection category 63 general category 54 module definition 55 module info category 68 electronic keying 27 compatible module 27 disable keying 27 exact match 27 F fault reporting 25 function codes 91...

Page 108: ...le 17 field side power 17 system side power 17 programming example 101 R remote I O module 15 S serial module diagram 12 parts 12 serial module diagram 12 serial module status indicators 73 software c...

Page 109: ......

Page 110: ...t Use the code to route your call directly to a technical support engineer http www rockwellautomation com global support direct dial page Literature Library Installation Instructions Manuals Brochure...

Reviews:

No comments