Home

Quantum Automation Series

1. Quantum Controller 4x 3x 12 Output 12 Input Registers Registers Command Echo n Quantum Backplane Quantum ESI Module Port 0 1 Registers Dual Port Memory o g Port 0 g 2 Port 1 t 5 5 4 gt lt E ri E O O A ire Lo Workspace Registers 9 Ri ASCII jt gt Executive A Size Size Read In lt 16 384 255 ASCII Write Out 16 bits Messages Registers 5 127 plus Write Out Checksum t Read In Characters y p 2 2 2 Port 2 S gt fo E e P ASCII Module ASCII Message 2 E Registers Storage Memory Ri 19 volatile nonvolatile Port 2 Registers 25 840 USE 108 00 August 2002 Introduction 26 840 USE 108 00 August 2002 Hardware Overview and System Specifications 3 At a Glance Introduction What s in this Chapter The following information describes the 140 ESI 062 10 ASCII Interface Module This chapter contains the following topics Topic Page 140 ESI 062 10 ASCII Interface Module 28 Module Specifications 31 Quantum Automation Series System Specifications 32 840 USE 108 00 August 2002 27 Hardware Overview System Specifications 140 ESI 062 10 ASCII Interface Module Overview LED Area RS 232 Port1 Port 0 Reset Button RS 232 Port 2 The 140 ESI 062 10 module is a Quantum communications interface module used to input messages and or d
2. Note Bit 15 is the Status Word Valid bit Word 11 XXXXhex Module Status 15 14 13 121111101 9 81 171 61 51413 2 1 10 Note Word 1 through Word 10 for Command 0 returns a 0 68 840 USE 108 00 August 2002 ESI Commands Command 1 READ ASCII MESSAGE Overview Command Structure The READ ASCII MESSAGE command is used to start running a read message on the module that is taking ASCII characters from the input receive buffer of a serial port to fulfil the variable formats of the message All output only formats still send ASCII characters to the serial port To start a message the module needs to know the following e The port number to be used e The starting module register number for the data that is processed e The message number to run In addition to starting a message this command is capable of transferring up to nine registers of data from the module to the controller after the message has completed this is the data count The data returned is gotten from the starting register number provided in Command Word 1 This command is executed only the first time it is received To execute the command again Command Words 0 1 or 2 need to be changed This is done so that the same message does not get continuously run until Command Word 0 changes to a command other than READ ASCII MESSAGE Command
3. Application Perform the following steps when using Hyper terminal to capture or display an ESI Example port response Step Action Remarks 1 Launch Hyper terminal on the PC 2 Configure the COM 1 port of the PC to exactly the same as what s The flow configured for the programming port control must always be set to Xon Xoff to configure the ESI module NOTE The programming port of the ESI module is always Port 1 3 Once connected with Hyper terminal press and hold onto the yellow RESET button on the ESI module located between Port 1 and Port 2 until the display on the ESI module shows an orange light indicating Status 12 840 USE 108 00 August 2002 Step Action Remarks 4 The Hyper terminal should display as follows Note If you do Welcome not get this message MODICON QUANTUM ASCII Module displaying on Entering Program Mode the Hyper Current date is terminal Current time is e Check the CLI gt ESI module programmi ng port parameters e Check the Hyper terminal COM1 port configurati ons e Check the cables Should be using Modbus cables 5 Type ascii at the command prompt It should now change to the Refer to the ASCII command prompt ASCII ESI user manual for the different ASCII editor commands 6 You can enter ASCII text messages that you want to display here You can In this app
4. Note Word 1 through Word 11 for Command A are not used 840 USE 108 00 August 2002 87 ESI Commands Response Response Structure for Command A Structure Word0 Echo Command Word 0 15 14 13 12111110 9 8 7 6 5 4 3 2 1 1 0 OA Command Designation Note Bit 15 is the Status Word Valid bit Word 1 Port 1 Buffer Status 15 14 13 12 11 10 9 8 7 6 5 4 3 2j 1 0 Word 2 Port 2 Buffer Status 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0 Word 3 XXXX hex 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0 Word 11 XXXXhex Module Status 15 14 13 121111101 9 81 171 6151413 2 1 10 Note Word 3 through Word 10 for Command A returns a 0 88 840 USE 108 00 August 2002 ESI Commands Response Structure for Illegal Commands Response Response Structure for Illegal Commands Structure Word0 Echo Command Word 0 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0 Note Bit 15 is the Status Word Valid bit Word 11 XXXX hex Module Status 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0 Note Word 1 through Word 10 returns a 0
5. Index Description Range mm Month 1 12 dd Day 1 31 yy Year 00 99 yyyy Year 1990 2089 Examples DATE Current date is Wed 3 29 1995 Enter new date 3 30 DATE 3 30 95 DATE 3 3 0 1995 Note If the year does not need to be changed then only the month and day need to be entered The day of week is automatically figured out by the firmware The yy years are mapped 00 89 2000 2089 and 90 99 1990 1999 56 840 USE 108 00 August 2002 ESI Editors Time Command Displays or sets the current time in the module Acceptable command format variations include TIME hh mm ss x TIME hh mm ss x Description and range of the elements used in the TIME command Index Description Range hh Hour 1 23 mm Minute 1 59 ss Second 1 59 x Meridian a p Examples TIME 3 26p TIME 3 26 30p TIME 15 26 TIME Current time is 3 15 26p Enter new time 3 26 30p Note The time can be entered in either 12 or 24 hour time format Not entering the meridian assumes AM unless the hour is 0 or 13 to 23 840 USE 108 00 August 2002 57 ESI Editors ASCII Message Editor Overview The ASCII Message Editor Interface is used to program the ASCII message formats in the module This interface consists of a simple command line interpreter also similar to the CLI that is in the Modicon B885 002 module w
6. Word 2 XXXX hex XX 1 FF Message Number 15 14113112111 1019 8 7 6 5 4 3 2 1 0 Word 3 XXXX hex Data Word 1 15114 13 12111110 9 8 71 6 5 41312 1 10 Word 11 XXXXhex Data Word 9 151 14 13 12111110 9 81 71 6151 41381 2 14 0 72 840 USE 108 00 August 2002 ESI Commands Response Structure Response Structure for Command 2 Word0 Echo Command Word 0 15 14113 12111 10 9 8 7 6 5 4 3 2 1 0 02 0001 or 0010 0 9 Command Designation Port Number Data Count Note Bit 15 is the Status Word Valid bit Word 1 XXXX hex XXXX 0 3FFF Echo Start Register Number 15 14 113 12 11 10 9 8 7 6 5 4 8 2 1 1410 Word 2 XXXX hex XX 1 FF Echo Message Number 15 14 113 12 11 10 9 8 7 6 5 4 8 21 1410 Word 3 XXXX hex 15 14 13 12111 10 9 8 7 6 5 4 3 2 141 0 Word 11 XXXXhex Module Status 15 14 13 12 11 10 9 8 7 6 5 4 3 2j 1 0 Note Word 3 through Word 10 for Command 2 returns a 0 840 USE 108 00 August 2002 73 ESI Commands Command 3 GET DATA Module to Control
7. 840 USE 108 00 August 2002 89 ESI Commands Module Status Word Word 11 The Module Status Word Word 11 in the response structure contains valid module Overview status information when bit 15 of Word 0 in the response structure is set The state of this bit can be used to distinguish whether Word 11 in the response structure is being used for data or status Organisation of Organisation of the Status Word ee the Status Word MSB 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0 Upper Byte Lower Byte Note During normal operation module status information is especially important when Word 11 is used for Module Status or Data Returned in the READ ASCII MESSAGE or GET DATA commands 90 840 USE 108 00 August 2002 ESI Commands Content of the Low Byte Status Word Bit from Low Byte Low Byte 7isilslala 2 1 o Hex Description 0 00 0000 1 0001 Busy command running on module 0 00 0001 0 0002 Invalid message data during command run 0 0 0 11 0 0 0 0 0100 Register end during command run 0 0 110 0 0 0 0 0200 Serial buffer overrun error 0 1 010 0 0 0 0 0400 Checksum error on message in storage area see upper byte for message number 11010 0 0 0 10 0 8000 Error see upper byte for message number High Byte Bit from High Byte High
8. 76 840 USE 108 00 August 2002 ESI Commands Response Structure Response Structure for Command 4 Word0 Echo Command Word 0 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0 04 0 A Command Designation Data Count Note Bit 15 is the Status Word Valid bit Word 1 XXXX hex XXXX 0 3FFF Echo Start Register Number 15 14 13 12111110 9 8 7 6 5 4 3 2 141 0 Word 2 XXXX hex 15 14 13 12111 10 9 8 7 6 5 4 3 2 141 0 Word 11 XXXXhex Module Status 15 14 113 12111 10 9 8 7 6 5 4 3 2 1 0 Note Word 2 through Word 10 for Command 4 returns a 0 840 USE 108 00 August 2002 77 ESI Commands Command 5 GET TOD Time of Day Overview The GET TOD command reads the modules TOD clock and returns the time of day and the date in the Response Words 1 to 7 The format for the time of day and date is identical to that used by the PLC time date registers This command is executed continuously without the need for changing any of the command words Command Command Structure for Command 5 Structure Word 0 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0 We 261 05 Command Designation Note Word 1 through Word 11 for Command 5 are notused 78 8
9. Quantum Controllers All Executive V2 0 at a minimum Battery Backup Module 140 XCP 900 00 840 USE 108 00 August 2002 31 Hardware Overview System Specifications Quantum Automation Series System Specifications Overview All Quantum Automation Series modules are designed to the system specifications that appear in the following tables Note that the last table lists agency approvals Mechanical The following table lists the mechanical system specifications Weight 2 Ibs 1 kg max Dimensions H x D x W 9 84 in x 4 09 in x 1 59 in 250 mm x 103 85 mm x 40 34 mm Wire Size 1 14 AWG or 2 16 AWG max 20 AWG min Material Enclosures and Bezels Lexan Space Requirements 1 backplane slot Electrical The following table lists the electrical system specifications RFI Immunity IEC 1000 4 3 27 500 MHz 10 V m Electrostatic Discharge IEC 1000 4 2 8 kV air 4 kV contact Function I O Modules with Operating Voltages Less Than 24 Vac or Vdc Fast Transients IEC 1000 4 4 0 5 kV common mode Damped Oscillatory Transients 1 kV common mode 0 5 kV differential mode Surge Withstand Capability Transients IEC 1000 4 5 1kVcommonmode 0 5 kV differential mode 32 840 USE 108 00 August 2002 Hardware Overview System Specifications Operating The following table provides s
10. 62 76 SE gt 37 45 25 63 77 3F 38 46 26 amp 64 100 40 39 47 27 65 101 41 A 40 50 28 66 102 42 B 41 51 29 67 103 43 C 42 52 2A i 68 104 44 D 43 53 2B 69 105 45 E 44 54 2C E 70 106 46 F 45 55 2D 71 107 47 G 46 56 2E 72 110 48 H 47 57 2F 73 111 49 48 60 30 0 74 112 4A J 49 61 31 1 75 113 4B K 50 62 32 2 76 114 4C L 51 63 33 3 77 115 4D M 52 64 34 4 78 116 4E N 53 65 35 5 79 117 4F O 54 66 36 6 80 120 50 P 55 67 37 7 81 121 51 Q 56 70 38 8 82 122 52 R 57 71 39 9 83 123 53 S 840 USE 108 00 August 2002 117 Character Set Printable ASCII Character Set continued Decimal Octal Hexa Character Decimal Octal Hexa Character decimal decimal 84 124 54 T 106 152 GA j 85 125 55 U 107 153 6B k 86 126 56 V 108 154 6C 87 127 57 W 109 155 6D m 88 130 58 X 110 156 6E n 89 131 59 Y 111 157 6F o 90 132 5A Z 112 160 70 p 91 133 5B 113 161 71 q 92 134 5C 114 162 72 r 93 135 5D 115 163 73 s 94 136 5E A 116 164 74 t 95 137 5F 117 165 75 u 96 140 60 i 118 166 76 v 97 141 61 a 119 167 77 w 98 142 62 b 120 170 78 x 99 143 63 c 121 171 79 y 100 144 64 d 122 172 7A Z 101 145 65 e 123 173 7B 102 146 66 f 124 174 7C 103 147 67 g 125 175 7D 104 150 68 h 126 176 7E bo 105 151 69 i 127 177 7F 118 840 USE 108 00 August 2002 Index i Dan A ABORT 86 Application Criteria 22
11. 8 7 6 5 4 3 2 1 Word 6 XXXX hex Minute of the Hour 0 3B 59 dec 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 Word 7 XXXX hex Second of the Minute 0 3B 59 dec 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 Note Word 8 through Word 11 for Command 6 are not used 840 USE 108 00 August 2002 81 ESI Commands Response Structure Response Structure for Command 6 Word0 Echo Command Word 0 15 14 13 12111 10 9 8 7 6 5 4 3 2 06 Command Designation Note Bit 15 is the Status Word Valid bit Word 1 XXXX hex 15 14113 12 11 10 9 8 7 6 5 4 3 2 Word 11 XXXXhex Module Status 15 14 13 12 11 10 9 8 7 6 5 4 3 2 Note Word 1 through Word 10 for Command 6 returns a 0 82 840 USE 108 00 August 2002 ESI Commands Command 7 SET MEMORY REGISTERS Overview The SET MEMORY REGISTERS command sets module registers to the value provided in Command Word 3 The registers set are designated by the start register number and the end register number All registers from the start register up to and including the end register number are set to the value provided Command Command Structure for Command 7 Structure Word 0 15 14 113 12111 10 9 8 7 6
12. Create a reference data editor to force the 000001 contact to simulate the ASCII messages on port 1 To do a DX zoom highlight the function block and press CTRL D 840 USE 108 00 August 2002 15 Step Action Remarks 10 The write ESI function block is configured as follows 11 79797 100002 a 70000 400500 000 400501 E From Concept when you force the 000001 contact ON over the hyper terminal You will be prompted to enter values as specified in the ASCII message In this example we have tried the program three times by forcing the 000001 once after every completion of the program The contact 000002 is used to abort the function block The hyper terminal results are as follows Please enter your values here These values are entered 12 0012 Please enter your values here These values are entered 1200 1200 Please enter your values here These values are entered 123 0123 For the 1st run of the program we have entered the values 0012 and 0012 Fir the 2nd run of the program we have entered the values 1200 and 1200 For the 3rd run of the program we have entered the values 0123 and 0123 Take note of the results based on the format of the messages 16 840 USE 108 00 August 2002 Step Action Remarks 12 Note Only one ESI function block can be executed at one ti
13. ESI Commands Command 2 WRITE ASCII MESSAGE Overview The WRITE ASCII MESSAGE command is used to start running a write message on the module that is putting ASCII characters to the output transmit buffer of a serial port To start a message the module needs to know the following e The port number to be used e The starting module register number for the data that is processed e The message number to run In addition to starting a message this command is capable of transferring up to nine registers of data from the controller to the module before the message has started this is the data count The data sent is stored starting at the start register number provided in Command Word 1 This command is executed only the first time it is received To execute the command again Command Words 0 1 or 2 plus any data word that is sent keyed off the data count need to be changed This is done so that the same message does not get continuously run until Command Word 0 changes to a command other than WRITE ASCII MESSAGE 840 USE 108 00 August 2002 71 ESI Commands Command Command Structure for Command 2 Structure Word 0 15 14 113 12111 10 9 8 7 6 5 4 3 2 141 0 02 0001 or 0010 0 9 Command Designation Port Number Data Count Word 1 XXXX hex XXXX 0 3FFF Start Register Number 15 14113 12 11 10 9 8 7 6 5 4 8 21 141 0
14. N A DATE Displays or sets the current date in the module TIME Displays or sets the current time in the module PORT Displays or sets the port parameter settings See chapter Configuration Editor for examples ASCII Sets programming mode to ASCII Message Interpreter N A NEW Enters the message editor and holds the new message in the work buffer ASCII gt new EDIT Displays a specified message enters the message editor and saves the specified message when done ASCII gt edit message VIEW Displays an existing message for viewing ASCII gt view message SAVE Saves changes made to a specified message in its work buffer ASCII gt save message CLR Clears a specified message ASCII gt clr message COPY Copies a specified message to another message ASCII gt copy message message SIM Simulates a specified message Shows how many registers are used for aid in mapping when creating user logic and the maximum depth of nested messages for additional debugging tool Notification is sent if the maximum depth is greater than 8 and also shows the nested message path ASCII gt sim message 4 840 USE 108 00 August 2002 47 Configuration Command Description Example DIR Display a directory of all available N A messages Use of CNTL S and CNTLQ can be used to st
15. Quantum Automation Series 140 ESI 062 10 ASCII Interface Module User Guide 840 USE 108 00 Version 2 0 M cipal Merin Germ Schneider iP Electric Building a New Electric World 840 USE 108 00 August 2002 Table of Contents Safety Information nnnnennennne 5 About the BOOK 5 shine oi oes Aa a eee 7 Chapter 1 Configuring the ESI Module 9 OVEIVIEW 2 3 5 8 sirais dew a tac bd waiter kl diddy ate aul er dota bed 9 Topology Overview and PartslList ee 10 Running an ESI Application 0 0000 eee 12 Chapter 2 Introduction to ESI06210 eee 19 Ata GlaNCe 4 4 204 atika ehh eb ea a eas a y Sana oe 19 Introduction to ESI Module rrrrne 20 Application Criteria rrreerreeeaeenee 22 Module Description nnrreenerrneneeneenereee 23 ESI Module Block Diagramm 0 0 0 cect tee eee 25 Chapter 3 Hardware Overview and System Specifications 27 At a Glante x sio a Eat be ne Sc eee ee 27 140 ESI 062 10 ASCII Interface Module 0 0 0 0 cee eee 28 Module Specifications 0 0 0 cette eee 31 Quantum Automation Series System Specifications 32 Chapter 4 140 ESI 062 10 Hardware Description 35 Ata Glance ndai ra a a Hie Dias Ged ba ee ee ee A 35 Prese
16. Response Response Structure Structure x Word Content hex Meaning 0 030D Echoes command word 0 1 XXXX Echoes starting register number from command word 1 XXXX Data word 1 XXXX Data word 2 11 XXXX Module status or data word 10 108 840 USE 108 00 August 2002 ESI Loadable PUT DATA Subfunction 4 PUT DATA Command Structure Response Structure A PUT DATA command writes up to 10 registers of data to the ESI module from the controller each time the ESI instruction is solved in ladder logic The total number of words to be written is specified in Word 0 of the PUT DATA command structure the data count The data is returned in increments of 10 in words 2 11 inthe PUT DATA command structure The command is executed sequentially until command word 0 changes to another command other than PUT DATA 040D hex Note If the data count and starting register number that you specify are valid but some of the registers to be written are beyond the valid register range only data from the registers in the valid range will be written The data count returned in Word 0 of the response structure will reflect the number of valid data registers returned and an error code 1280 hex will be returned in the Module Status Word Word 11 in the response table Command Structure Word Content hex Meaning 0 040D D data count 1 XXXX Starting register number in the range 0 3FFF 2 XXXX Data w
17. 15 14 13 12 11 10 9 a Bvte Description Hex 0 10 0 0 0 0 1 0001 Invalid user logic parameter 0 O O O O 1 O 0002 Invalid user logic command O 0 0 1 JO 0 0 O 10100 Count out of range O 0 0 1 O 0 0 1 0101 Starting register out of range O 0 0 1 JO JO 1 JO 10102 Ending register out of range O O 0 1 JO JO 1 1 10103 Invalid register number order end before start 0 O O 1 JO j1 0 0104 Invalid serial port number requested 1 1 1 10105 Invalid message number requested 1 10 1 1 0 0106 Reguested message number not programmed 0 O O 1 JO 1 1 1 10107 Requested message number in bad storage area O 1 1 0108 Configuration parameter error 0 0 0200 Day of the week is incorrect 840 USE 108 00 August 2002 91 ESI Commands Reading Beyond Valid Register Range If the start register number and the data count are valid but some of the registers to access are beyond the valid register range then only the data from the registers in the valid register range are read written The data count returned is the number of valid register data returned and the error code 1280 Hex End Register number in out of range is returned in the Module Status Word Overview 92 840 USE 108 00 August 2002 ESI Commands Example The following example tries to read 10 registers using the GET command from the ESI module starting at register 3FFA Hex User Logic co
18. 112 4X 115 will produce 6 lines each containing the fields Item 112 4X 115 and a lt CR LF gt 62 840 USE 108 00 August 2002 ESI Editors Space The ASCII message symbol for space is X This is an output only format nX nis the number of spaces 1 99 Newline The ASCII message symbol for a Carriage Return is This is an output only format Control Code A 3 digit Octal control character in the range 000 377 enclosed in double quote delimiters This is an output only format vyp is the octal form of a character Example 033 Flush Flush the input buffer of the currently running serial port in one of four ways the entire buffer a number of characters up to a character pair or up to a character pair repeatedly lt 0 gt flush entire buffer lt 1 bbb gt flush until number of characters removed lt 2 hhhh gt flush until character pair match lt 3 rrr hhhh gt flush until character pair match repeatedly bbb number or characters 1 255 hhhh character pair in hexadecimal 0000 FFFF rrr number of repeats 1 255 Note The port buffer size is 255 characters 840 USE 108 00 August 2002 63 ESI Editors ASCII Message Syntax Rules Standard ASCII Message Preprocessing Rules Messages created with the Module s ASCII Message Editor or downloaded using the ASCII Message Transfer are checked after being entered for general and format syntax violation
19. 5 4 3 2 1 0 07 Command Designation Word1 XXXX hex XXXX 0 3FFF Start Register Number 15 14 13 12 11 10 91 18 71 6 5 4 31 2 1 0 Word 2 XXXX hex XXXX 0 3FFF End Register Number 15 14113 12 11 10 9 8 7 6 5 4 3 2 1 0 Word 3 XXXXhex Value to set in Registers 15 14 13 12111110 9 8 7 61 5 41 31 2 141 0 Note Word 4 through Word 11 for Command 7 are not used 840 USE 108 00 August 2002 83 ESI Commands Response Response Structure for Command 7 Structure Word 0 Echo Command Word 0 15 14 13 12 11110 9 8 7 6 5 4 3 2 1 1 0 07 Command Designation Note Bit 15 is the Status Word Valid bit Word 1 XXXX hex XXXX 0 3FFF Echo Start Register Number 15 14 13 12 11 10 9 8 71 16 5 4 31 2 1 0 Word 2 XXXX hex XX 1 FF Echo Message Number 15 14 13 12 11 10 9 8 71 16 5 4 31 2 1 0 Word 3 XXXX hex Data Word 1 15 14113 12111110 9 81 7 6 5 4131 2 141 0 Word 4 XXXX hex 15114 13112111110 9 8 71615 41312 1 10 Wo
20. Command 6 SET TOD Time of Day esereeee 80 Command 7 SET MEMORY REGISTERS ese 83 Command 8 FLUSH BUFFER 000 c eee ete 85 Command 9 ABORT 0 20 E E AE Ea e EEE eens 86 Command A GET BUFFER STATUS 000 0 cece eee ee 87 Response Structure for Illegal Commands 00000e cee ee eeee 89 Module Status Word Word 11 0 0 0 cee tte 90 Reading beyond valid Register Range 0 eee eee eee eee 92 ESliLoadable 14 5 c5ai2 ina nam a ata 95 OVEVIEW ads tice tts eo eed ltr eu a ge Se Aa ce ere Be 95 Short Descriptiont 4 4 3 2 ents ohh fete wie oe tasa AUE tati lit 96 Representation ss renei eee ee cata test AR Abram eid A e ee 97 Parameter Description n sasaaa auauua 98 Rune Time Errorss a2 ot ee ne oes al ted etal ene ae a tet 101 READ ASCII Message Subfunction 1 e 102 WRITE ASCII Message Subfunction 2 ee 106 GET DATA Subfunction 3 r reneene 107 PUT DATA Subfunction 4 rr reneeee 109 VOCer eet CTT eee ee ee ee ee eaa ee ee a ee a 113 Ata Glahge choii ninen einai wed id eet de aw heeds ads 113 Character S8E7 e od at AS aata a tart aot 115 ASGII CharacterSet ansi teeta eed eea tanketi teal i a eer EA 115 Te TCT eee eee ee ee ee ee ee ee ee ee 119 840 USE 108 00 August 2002 Safety Information
21. DATA sequence 0104 Error in the PUT DATA sequence 1000 Length Bottom Node p 100 is too small 1001 Nonzero value in both the 4x and 3x data offset parameters 1002 Zero value in both the 4x and 3x data offset parameters 1003 4x or 3x data offset parameter out of range 1004 4x or 3x data offset plus transfer count out of range 1005 3x data offset parameter set for GET DATA 1006 Parameter Table Checksum error 1101 Output registers from the offset parameter out of range 1102 Input registers from the offset parameter out of range 2001 Error reported from the ESI module Once the parameter error checking has completed without finding an error the ESI module begins to execute the command sequence 840 USE 108 00 August 2002 101 ESI Loadable READ ASCII Message Subfunction 1 READ ASCII A READ ASCII command causes the ESI module to read incoming data from one of Message its serial ports and store the data in internal variable data registers The serial port number is specified in the tenth ninth implied register of the subfunction parameters table The ASCII message number to be read is specified in the ninth eighth implied register of the subfunction parameters table See Subfunction Parameters Middle Node p 99 The received data is stored in the 16K variable data space in user programmed formats When the top node of the
22. Electric 840 USE 108 00 August 2002 About the Book User Comments We welcome your comments about this document You can reach us by e mail at TECHCOMM modicon com 8 840 USE 108 00 August 2002 Configuring the ESI Module Overview Purpose What s in this Chapter This chapter is a quickstart example It provides a step by step procedure for setting up the Quantum ASCII module This chapter contains the following topics Topic Page Topology Overview and Parts List 10 Running an ESI Application 12 840 USE 108 00 August 2002 Topology Overview and Parts List Topolgy The following diagram is a basic layout of the application Overview Quantum Ethernet module 170NOE7710 to Ethernet port on PC Diagram ESI Module to COM port 1 on PC KE Parts List Parts list table Items Parts Description Quantum PLC Power Supply PLC hardware Processor ESI supported by all Quantum processors 140 ESI 062 10 firmware ver 1 03 140 NOE 771 10 Ethernet module PLC Software ProWorx NxT Version 2 2 PLC programming software Concept V2 1 and higher Modbus Cable Communication cable between ESI modle and PC Hyper terminal Terminal emulation that comes with For capturing the ASCII port Windows input output User Manual 840 USE 108 00 140 ESI 062 10 ASCII Interace User Guide 10 840 USE 108 00 August 2002 Setting Up the Perfor
23. Green Transmitted data on RS 232 Port 2 Status Yellow Status Error 1 Red There is an error condition on Port 1 Error 2 Red There is an error condition on Port 2 840 USE 108 00 August 2002 37 Hardware Description LED Blinking The following table shows the blinking sequence of the F Status Error 1 and Error Sequence 2 LEDs LED Description F Status Error 1 Error 1 Blinking Blinking Blinking Blinking The ASCII module is initializing first powerup OFF ON OFF OFF Programming mode OFF OFF ON N A Serial Port 1 incurred a buffer overrun OFF OFF N A ON Serial Port 2 incurred a buffer overrun N A Blinking OFF OFF The ASCII module is in kernel mode and See may have an error Crash Codes Status LED The following table shows a table of Status LED crash codes Crash Codes Number of Blinks Code Error one per second in hex Steady 0000 Requested kernel mode 4 6631 Bad microcontroller interrupt 5 6503 RAM address test error 8 6402 RAM data test error 6300 PROM checksum error EXEC not loaded 6301 PROM checksum error 630A Flash message checksum error 630B Executive watchdog timeout error 8000 Kernel other error 8001 Kernel PROM checksum error 8002 Flash program error 8003 Unexpected executive return 38 840 USE 108 00 August 2002 Hardware Description External Connectors and Switches RS 232 Ser
24. RS 232C Port 1 Status Rx2 Green Received data on RS 232C Port 2 Tx2 Green Transmitted data on RS 232C Port 2 Status Yellow Status Error 1 Red There is an error condition on Port 1 Error 2 Red There is an error condition on Port 2 LED Blinking The following table shows the blinking seguence ofthe F Status Error 1 and Error Seguence 2 LEDs LEDs and Blinking Seguence Description F Status Error 1 Error 2 Blinking Blinking Blinking Blinking The ASCII module is initializing first power up OFF ON OFF OFF Programming mode OFF OFF ON N A Serial Port 1 incurred a buffer overrun OFF OFF N A ON Serial Port 2 incurred a buffer overrun N A Blinking seethe LED OFF OFF The ASCII module is in kernel mode Crash Codes table and may have an error 840 USE 108 00 August 2002 29 Hardware Overview System Specifications Status LED The following table shows the Status LED crash codes Crash Codes Number of Blinks Code in hex Error one per second Steady 0000 Requested kernel mode 4 6631 Bad micro controller interrupt 5 6503 RAM address test error 6 6402 RAM data test error 7 6300 PROM checksum error EXEC not loaded 6301 PROM checksum error 630A Flash message checksum error 630B Executive watchdog timeout error 8 8000 Kernel other error 8001 Kernel PROM checksum error 8002 Flash program error 8003 Unexpected executive return Front Pan
25. is the Status Word Valid bit Word 1 XXXX hex XXXX 0 3FFF Echo Start Register Number 15 14 13 12 11 10 9 8 7 6 5 4 8 2 1 141 0 Word 2 XXXX hex Data Word 1 15 14 13 12111110 9 8 71 615 41 31 2 1 10 Word 11 XXXXhex Module Status or Data Word 10 151 14 13112111110 9 81 716151 4138 2 14 0 840 USE 108 00 August 2002 75 ESI Commands Command 4 PUT DATA Controller to Module Overview The PUT DATA command writes up to 10 words registers of data to the module starting at the start register number provided in Command Word 1 The data is sent in Command Words 2 through 11 This command is executed continuously until Command Word 0 changes to a command other than GET DATA Command Command Structure for Command 4 Structure Word 0 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0 04 lt A hex Command Designation Data Count Word1 XXXX hex XXXX 0 3FFF Start Register Number 15 14 113 12 11 10 9 8 7 6 5 4 8 2 1 1410 Word 2 XXXX hex Data Word 1 151 14 13 12 11 10 9 8 7 6 5 4 3 2 1 40 Word 11 XXXXhex Data Word 10 15 14 13 12 111101 9 81 71 6151413 2 1 1 10
26. or WRITE ASCII MESSAGE and the module is no longer in a busy status The serial port buffers for the module are not affected by this command only the message is currently running Command Structure Command Structure for Command 9 Word 0 15 14 13 12 11 10 9 8 09 Command Designation Note Word 1 through Word 11 for Command 9 are not used Response Structure Echo Command Word 0 Response Structure for Command 9 Word 0 15 14 13 12 11 10 9 8 7 09 Command Designation Note Bit 15 is the Status Word Valid bit Word 1 XXXX hex 15 14 13 12 11 10 Word 11 XXXX hex Module Status 15 14 13 12 11 10 9 8 7 6 5 Note Word 3 through Word 10 for Command 9 returns a 0 86 840 USE 108 00 August 2002 ESI Commands Command A GET BUFFER STATUS Overview The GET BUFFER STATUS command reads the number of characters in the input buffer for each port The range of characters is 1 255 Command Command Structure for Command A Structure Word 0 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0 OA Command Designation
27. shown in the following illustration ESI Modul Serial Device DCD 1 1 DCD RXD 2 2 RXD TxD 3 3 TD N A 4 4 DTR GND 5 5 GND N A 6 6 DSR RTS 7 7 RTS N A 8 8 CTS N A 9 9 RI Reset Push A recessed push button is located on the front of the module Button The reset push button has two functions e Reset the module by a short press e Entering programming mode by holding the button pressed for more than 4 seconds 40 840 USE 108 00 August 2002 Hardware Description Specifications Data Interface Firmware Memory Power Fuses Data Interface RS 232 2 serial ports 9 pin D shell non isolated 990 NAA 263 20 Modbus Programming Cable RS Cabling 232 12 ft 2 7 m Maximum cable length 20 m shielded 990 NAA 263 50 Modbus Programming Cable RS 232 50 ft 15 5 m Firmware Specifications Port Performance Burst Speed 19 2 k baud each port Continuous Speed Application dependent Depth of Nested Messages 8 Buffer Size 255 Input 255 Output Number of Messages 255 Maximum Message Length 127 characters plus 1 checksum Memory Specifications RAM 256 kb for data and program 2 kb dual port ram Flash ROM 128 kb for program and firmware Power Specifications Power Dissipation 2 W max Bus Current Reguired 300 MA Reguired Fuses Internal None External User discretion 840 USE 108 00 A
28. the ESI module to the controller one Get Data transfer will move up to 10 data registers each time the instruction is solved e Perform a sequence of PUT DATA up to 16 384 registers of data to the ESI module from the controller One PUT DATA transfer moves up to 10 registers of data each time the instruction is solved e Abort the ESI loadable command sequence running Note After placing the ESI instruction in your ladder diagram you must enter the top middle and bottom parameters Proceed by double clicking on the instruction This action produces a form for the entry of the 3 paramteers This parametric must be completed to enable the DX zoom function in the Edit menu pulldown 96 840 USE 108 00 August 2002 ESI Loadable Representation Symbol Representation of the instruction subfunction 1 4 subfunction parameters ESI length Parameter Description of the instruction s parameters Description Parameters State RAM Data Type Meaning Reference Ox 1x None ON enables the subfunction Ox 1x None Abort current message 4x INT UINT Number of possible subfunction range 1 top node WORD wi 4 4x INT UINT First of eighteen contiguous 4x holding middle node WORD registers which contain the subfunction parameters INT UINT Number of subfunction parameter bottom node registers i e the length of the table in the middle node Top output Ox Non
29. those commands see List of ESI Commands p 66 840 USE 108 00 August 2002 51 Configuration 52 840 USE 108 00 August 2002 ESI Command Line Editors Overview Ata Glance What s in this Chapter The ESI firmware contains an editing environment which can be accessed by dumb terminal connected through port 1 This chapter describes how to use this editor to configure the module and to edit the ASCII message formats This chapter contains the following topics Topic Page Configuration Editor 54 ASCII Message Editor 58 ASCII Message Formats 59 840 USE 108 00 August 2002 53 ESI Editors Configuration Editor Overview The Configuration Editor Interface is part of the programming mode It is used to configure the serial ports and the time of day clock of the module Note Configuration of the serial ports can also be accomplished through the I O map The I O map overrides any serial port configuration entered in the configuration editor Note Configuration of the time of day clock can also be accomplished with the SET TOD command To enter the configuration editor typeCONFIG at the CLI gt prompt The configuration editor displays the prompt CONFIG gt 54 840 USE 108 00 August 2002 ESI Editors Port Command The Port Command displays or sets the port parameter settings Acceptable command format variations include PO
30. 01009 N A ASCII port number 401009 N A Internal loadable variables With these parameters entered to the table the ESI instruction will handle the data transfers automatically over three ESI logic solves 110 840 USE 108 00 August 2002 ESI Loadable Handling of Data Transfer without ESI Instruction The same task could be accomplished in ladder logic without the ESI loadable but it would require the following four networks to set up the command and transfer parameters then copy data multiple times until the operation is complete Registers 400101 400112 are used as workspace for the output values Registers 400201 400212 are initial PUT DATA command values Registers 400501 400530 are the data registers to be sent to the module First Network Command Register Network Om 000011 000011 400201 400501 400101 000011 400101 400103 400001 BLKM BLKM BLKM 0012 0010 0012 Contents of registers Register Value hex Description 400201 040A PUT DATA command 10 registers 400202 0064 Module s starting register 400203 nnnn Not valid data word 1 400212 nnnn Not valid data word 10 The first network starts up the transfer of the first 10 registers by turning ON coil 000011 forever It moves the initial PUT DATA command into the workspace moves the first 10 registers 400501 400510 into the workspace and then moves the workspace
31. 40 USE 108 00 August 2002 ESI Commands Response Response Structure for Command 5 Structure Word 0 Echo Command Word 0 15 14 13 12 11 109 8 7 6 5 4 31 21 1 0 05 Command Designation Note Bit 15 is the Status Word Valid bit Word 1 XXXX hex Day of the Week 1 Sunday 7 Saturday 15 14 13 12 111 10 9 8 7 6 5 4 3 21110 Word 2 XXXX hex Month January 1 December C 12 dec 15 14 13 12111 10 9 8 7 6 5 4 3 211 10 Word 3 XXXX hex Day of the Month 1 1F 31 dec 15 14 13 1211 10 9 8 7 6 5 4 3 21 1 0 Word 4 XXXX hex Year 00 63 99 dec 15 14 13 12 11 109 8 7 6 5 4 31 21 1 0 Word 5 XXXX hex Hour of the Day 0 17 23 dec 15 14 13 12 11 10 9 8 7 6 5 4 3 211 10 Word 6 XXXX hex Minute of the Hour 0 3B 59 dec 15 14 13 12 111 10 9 8 7 6 5 4 3 21110 Word 7 XXXX hex Second of the Minute 0 3B 59 dec 15 14 13 12 11 10 9 8 7 6 5 4 3 21 1 10 e Word 11 XXXXhex Module Status 15 14 13 12 1111019 8 7 61 5 4 3 2 1 10 Note Word 8 through Word 10 for Command 5 returns a 0 840 USE 108 00 August 2002 79 ESI Commands Command 6 SET TOD Time of Day Overview The SET TOD command loads the modules TOD clock with the time of day and the
32. ASCII Character Set 115 ASCII Message Formats 59 B Block Diagramm 25 C Character Set 115 Command ABORT 86 FLUSH BUFFER 85 GET BUFFER STATUS 87 GET DATA 74 GET TOD 78 Illegal Commands 89 NO OPERATION 68 PUT DATA 76 READ ASCII MESSAGE 69 SET MEMORY REGISTERS 83 SET TOD 80 WRITE ASCII MESSAGE 71 Command Line Editor 53 Command Structure 67 Commands 65 Configuration 46 Configuration Editor 54 Connectors 39 Crash Codes 38 E Editor 53 Error Indicators 38 ESI hardware description 28 External Connectors 39 F FLUSH BUFFER 85 front panel connectors and switches front panel push button 30 front panel LEDs blinking sequence 29 G GET BUFFER STATUS 87 GET DATA 74 GET TOD 78 H Hardware Description 35 Illegal Commands 89 Indicators 37 Introduction 19 840 USE 108 00 August 2002 119 Index Invalid Register Range 92 L LED 37 Message Formats 59 N NO OPERATION 68 p PUT DATA 76 R READ ASCII MESSAGE 69 S SET MEMORY REGISTERS 83 SET TOD 80 Status Word 90 Switches 39 W WRITE ASCII MESSAGE 71 120 840 USE 108 00 August 2002
33. CII port number 1or2 Note The registers below are internally used by the ESI loadable Do not write registers while the ESI loadable is running For best use initialize these registers to 0 zero when the loadable is inserted into logic 10th implied ESI loadable previous scan power in state 11th implied Data left to transfer 12th implied Current ASCII module command running 13th implied ESI loadable sequence number 14th implied ESI loadable flags 15th implied ESI loadable timeout value MSW 16th implied ESI loadable timeout value LSW 17th implied Parameter Table Checksum generated by ESI loadable 840 USE 108 00 August 2002 99 ESI Loadable Length Bottom Node Ouptuts Middle Output Bottom Output Note Once power has been applied to the top input the ESI loadable starts running Until the ESI loadable compiles successfully or in error the subfunction parameters should not be modified If the ESI loadable detects a change the loadable will compile in error Parameter Table Checksum Error See Run Time Errors p 101 The bottom node contains the length of the table in the middle node i e the number of subfunction parameter registers For READ WRITE operations the length must be 10 registers For PUT GET operations the required length is eight registers 10 may be specified and the last two registers will be unused Note NSUP m
34. ESI instruction is 1 the controller invokes the module and causes it to execute one READ ASCII command followed by a sequence of GET DATA commands transferring up to 16 384 registers of data from the module to the controller Command Command Structure siructure Word Content hex Meaning 0 01PD P port number 1 or 2 D data count 1 XXXX Starting register number in the range 0 3FFF 2 00xx Message number where xx is in the range 1 FF 1 255 dec 8 11 Not used Response Command Structure SUUEIUFS Word Content hex Meaning 0 01PD Echoes command word 0 1 XXXX Echoes starting register number from Command Word 1 2 00xx Echoes message number from Command Word 2 3 XXXX Data word 1 4 XXXX Data word 2 11 XXXX Module status or data word 9 102 840 USE 108 00 August 2002 ESI Loadable A Comparative Below is an example of how an ESI loadable instruction can simplify your logic READ ASCII programming task in an ASCII read application Assume that the 12 point Message Put bidirectional ESI module has been I O mapped to 400001 400012 output registers Data Example and 300001 300012 input registers We want to read ASCII message 10 from port 1 then transfer four words of data to registers 400501 400504 in the controller Parameterizing of the ESI instruction 0001 401000 ESI 0018 The subfunction parameter tabl
35. ESI module has a 32 kbyte memory which is organized as 16k 16 bit registers These registers hold all data coming from and going to the serial ports They can be accessed by the PUT and the GET command The ESI module can hold up to 255 ASCII messages with 127 characters plus checksum character each These ASCII messages can be either static texts to be sent to an external device or a definition of how data contained in the register area is to be translated into or from a stream of serial ASCII characters or a combination of both 840 USE 108 00 August 2002 23 Introduction Firmware The ESI module firmware can be loaded over the local I O backplane Upgrades and changes in functionality are supported by updating the flash executive firmware within the ESI module Users should be aware that the update procedure can only occur over the local I O backplane even though the module can be placed in local remote or distributed locations If you are using the ESI module in remote or distributed backplanes plan to have an empty slot available in the local backplane or a spare controller system to accommodate future executive upgrades 24 840 USE 108 00 August 2002 Introduction ESI Module Block Diagramm The Elements of the ESI Module The following picture shows the elements of the ESI module
36. ET MEMORY REGISTERS 83 Command 8 FLUSH BUFFER 85 Command 9 ABORT 86 Command A GET BUFFER STATUS 87 Response Structure for Illegal Commands 89 Module Status Word Word 11 90 Reading beyond valid Register Range 92 840 USE 108 00 August 2002 65 ESI Commands Overview on ESI Commands List of ESI There are 11 ASCII module commands which instruct the ESI module serial Commands communications and other housekeeping utilities These commands are sent to the ESI module by the Quantum controller Data exchange between the ASCII device and the Quantum controller is integrated into the READ WRITE command structure described in this section The output data the first 4x registers contains the command the first input register 3x contains the response and also the echo of the command The following table is a summary of the ESI module commands Command Name Description 0 No operation do nothing 1 READ ASCII message start a read ASCII message 2 WRITE ASCII message start a write ASCII message 3 GET DATA transfer data from module to PLC 4 PUT DATA transfer data from PLC to module 5 GET TOD get time of day from module 6 SET TOD set time of day in module 7 SET MEMORY REGISTERS set registers to value 8 FLUSH BUFFER flush serial port buffers 9 ABORT abort ASCII message currently running A GET BUFFER STATUS get port input buffer 66 840 USE 108 00 August 2002 ESI C
37. ISSION 5 05 05 ENQ ENQUIRY 6 06 06 ACK ACKNOWLEDGE 7 07 07 BEL BEEP 8 10 08 BS BACKSPACE 9 11 09 HT HORIZONTAL TAB 10 12 OA LF LINE FEED 1 13 0B VT VERTICAL TAB home 12 14 0c FF FORM FEED 13 15 oD CR CARRIAGE RETURN 14 16 0E SO SHIFT OUT 15 17 OF Sl SHIFT IN 16 20 10 DLE DATALINK ESCAPE 17 21 11 DC1 DEVICE CONTROL ONE 18 22 12 DC2 DEVICE CONTROL TWO 19 23 13 DC3 DEVICE CONTROL THREE 20 24 14 DC4 DEVICE CONTROL FOUR 21 25 15 NAK NEGATIVE ACKNOWLEDGE 840 USE 108 00 August 2002 115 Character Set Decimal Octal Hexa decimal Character Character Control 22 26 16 SYN SYNCHRONOUS IDLE 23 27 17 ETB END OF TRANSMISSION BLOCK 24 30 18 CAN CANCEL 25 31 19 EM END OF MEDIUM 26 32 1A SUB SUBSTITUTE 27 33 1B ESC ESCAPE 28 34 1C FS FILE SEPARATOR cursor right 29 35 1D GS GROUP SEPARATOR cursor left 30 36 1E RS RECORD SEPARATOR cursor up 31 37 1F US UNIT SEPARATOR cursor down 116 840 USE 108 00 August 2002 Character Set Printable ASCII The following table defines the ASCII set in decimal hexadecimal and character characiers Decimal Octal Hexa Character Decimal Octal Hexa Character decimal decimal 32 40 20 SPACE 58 72 3A 33 41 21 59 73 3B 34 42 22 b 60 74 3C lt 35 43 23 61 75 3D 36 44 24
38. Important Information NOTICE Read these instructions carefully and look at the equipment to become familiar with the device before trying to install operate or maintain it The following special messages may appear throughout this documentation or on the equipment to warn of potential hazards or to call attention to information that clarifies or simplifies a procedure The addition of this symbol to a Danger or Warning safety label indicates A that an electrical hazard exists which will result in personal injury if the instructions are not followed This is the safety alert symbol It is used to alert you to potential personal A injury hazards Obey all safety messages that follow this symbol to avoid possible injury or death A DANGER DANGER indicates an imminently hazardous situation which if not avoided will result in death serious injury or equipment damage A WARNING WARNING indicates a potentially hazardous situation which if not avoided can result in death serious injury or equipment damage N CAUTION CAUTION indicates a potentially hazardous situation which if not avoided can result in injury or equipment damage 840 USE 108 00 August 2002 5 Safety Information PLEASE NOTE Electrical equipment should be serviced only by qualified personnel No responsi bility is assumed by Schneider Electric for any consequences arising out of the use of this material This docume
39. RT n b p d s kl x PORT n BAUD b PARITY p DATA d STOP s KEYBOARD k XON XOFF x Description and range of the elements used in the PORT command Index Description Range Port number 0 1 2 b Baud rate 50 75 110 134 5 150 300 600 1200 1800 2000 2400 3600 4800 7200 9600 19200 p Parity setting N O E d Number of data bits 5 6 7 8 s Number of stop bits 1 2 k Keyboard mode on off Character echo mode x XON XOFF mode on off Software flow control Examples PORT 0 1200 n 8 1 on on PORT 0 baud 1200 parity n data 8 stop 1 keyboard on XON XOFF on PORT 0 Current port parameters are PORT 0 BAUD 1200 PARITY NONE Enter new parameters 4800 n 8 1 off on After the Port settings in the module have been changed the following message will appear Note The port settings are temporary during this programming session Note Ports 0 and 1 do not support all baud rate and data bit options Refer to the Module Configuration screen for available options 840 USE 108 00 August 2002 55 ESI Editors Date Command Displays or sets the current date in the module Acceptable command format variations include DATE DATE DATE DATE DATE DATE mm dd yyl mm dd yyl mm dd yy mm dd YYYY mm dd YYYY mm dd YYYY Description and range of the elements used in the DATE command
40. Structure for Command 1 Word 0 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0 01 0001 or 0010 0 9 Command Designation Port Number Data Count Word1 XXXX hex XXXX 0 3FFF Start Register Number 15 14113 12 11 10 9 8 7 6 5 4 3 2 1 0 Word 2 XXXXhex XX 1 FF Message Number 15 14 13 12 11 10 9 8 7 6 5 4 383 21 141 0 Note Word 3 through Word 11 for Command 1 are not used 840 USE 108 00 August 2002 69 ESI Commands Response Response Structure for Command 1 Structure Word0 Echo Command Word 0 15 14 13 12111110 9 8 7 6 5 4 3 2 141 0 01 0001 or 0010 0 9 Command Designation Port Number Data Count Note Bit 15 is the Status Word Valid bit Word 1 XXXX hex XXXX 0 3FFF Echo Start Register Number 15 14113 12 11 10 9 8 7 6 5 4 8 2 4 141 0 Word 2 XXXX hex XX 1 FF Echo Message Number 15 14113112 11 10 9 8 7 6 5 4 838 2 4 1 1 0 Word 3 XXXX hex Data Word 1 15 14113 12111110 9 81 7 61 5 41 31 2 1 10 Word 11 XXXXhex Module Status or Data Word 9 15 14 13 12 111101 9 181 71 615141 13 2 1 10 70 840 USE 108 00 August 2002
41. acters A variable field of the ASCII format with Number of registers and Field Length nAm nis the number of registers 1 99 format repeat m is the field length 1 2 number of characters Example 2A2 as an input stands for 2 registers each containing 2 ASCII characters 840 USE 108 00 August 2002 59 ESI Editors Hexadecimal Octal Binary Integer Leading Spaces A variable field of the Hexadecimal format with Number of registers and Field Length nHm nis the number of registers 1 99 format repeat m is the field length 1 4 number of numbers Example 2H3 as an input stands for 2 registers each containing 3 Hexadecimal numbers A variable field of the Octal format with Number of registers and Field Length nOm nis the number of registers 1 99 format repeat m is the field length 1 6 number of numbers Example 304 as an input stands for 3 registers each containing 4 Octal numbers A variable field of the Binary format with Number of registers and Field Length nBm nis the number of registers 1 99 format repeat m is the field length 1 16 number of numbers Example 1B8 is an input stands for 1 register containing 8 Binary numbers A variable field of the Integer Decimal format using leading spaces for output with Number of registers and Field Length On input this format accepts leading zeros and spaces as a 0 zero nim nis the number of registers 1 99 format re
42. amming port In this mode it has its own set of parameters To enter the configuration mode of the ESI you have to perform the following steps Step Action 1 Connect a dumb terminal or a PC Terminal emulation like Hyperterminal to port 1 For information about the appropriate cable see RS 232 Serial Ports RS 232 Serial Ports p 39 2 Set the communication parameters of the terminal to 9600 baud 8 data bit no parity 1 stop bit and XON XOFF flow control 3 Press the reset button on the front of the ESI module for more then 4 seconds After you have entered the configuration mode following the above steps the yellow Line Editor Status LED on the ESI front panel will turn on and you get the following message on your terminal screen Welcome MODICON QUANTUM ASCII Module Entering Program Mode Current date is Wed 01 01 2002 Current time is 09 15 10a CLI gt _ 46 840 USE 108 00 August 2002 Configuration Available Commands Command structure of the CLI Command Description Example CLI Sets programming mode to the Command Line Interpreter N A HELP Displays available commands and a brief description on the command or displays help on the command requested e g CLI gt HELP ASCII displays help on the ASCII command N A RUN Resets Module and goes into normal running mode N A CONFIG Sets programming mode to Configuration Interpreter
43. as two characters it could also represent a single number which may be transmitted as an integer with leading spaces resulting in a string of five characters For a detailed description of the available formats see ASCII Message Formats p 59 Transmitting The following diagram is an example of transmitting 4 characters from the Quantum Example controller using the 2A2 message format 2 registers with 2 characters each Port Buffer content is in ASCII format register content in hex Controller ESI Message Port Registers Registers Format Output Buffer 53 54 2422 gt STOP gt 4E 50 53 54 4F 50 840 USE 108 00 August 2002 49 Configuration The following diagram is an example of receiving 1 numerical value from the RS 232 Receiving Example port using the 1L5 message format 1 register 5 digits with leading zeros Port Buffer content is in ASCII format register content in hex Controller ESI Message Port Registers Registers Format Input Buffer 00 136 _1L5 7 00136 00 136 Note Enusre the number of incoming characters match the number defined in the ASCII message If in the above example the device sends 0013 the ESI module would not be able to finish the receive command and would wait until reception of a 5th c
44. ata from an ASCII device to the CPU output messages and or data from the CPU to an ASCII device or bi directionally exchange messages and or data between an ASCII device and the CPU The following figure shows the 140 ESI 10 ASCII Interface Module Model Number Module Description Color Code Customer Identification Label Removable Door Fold label and place it inside door FE OGIO OTRO NN The ESI features two serial ports that can sustain communication rates of up to 9600 baud Programming the ESI is done using port configurations and ASCII messages through one ofthe serial ports using a dumb terminal or with a personal computer using terminal emulation software The ASCII messages are initiated by using logic running in the Quantum controller The ESI can be installed in local remote I O and distributed I O configurations 28 840 USE 108 00 August 2002 Hardware Overview System Specifications LED Indicators The information in the following table describes the ESI LEDs and Descriptions LEDs Color Indication When On i R Green The module has passed power up R Active F diagnostics E Error Active Green Bus communication is present F Red The module has detected a fault Rx2 Error 2 4 2 Tx2 Rx1 Green Received data on RS 232C Port 1 Tx1 Green Transmitted data on
45. ct for that Criteria solution As always when looking at solving application problems this information is provided as a guide only and not the only answer to application problem Application Description Recommended Solution Printer Interface Generate local reports with ESI Module J892 or imbedded data from the controller ASCIIBasic Module or the ASCII module Communicate to Send control characters and ESI Module J892 or XMIT simple Device receive data from measurement devices Bar Code Interface Send and receive data from bar ESI Module or ASCII code reader scanner Basicmodule Communicate to Send control characters and ESI Module or J892 Device receive data from measurement devices leading zero s or leading spaces may be sent by the device Controller to Controller Emulate manufacturers protocol ASCII Basic Module Interfacing that support several sub functions External Data Storage Store data outside of the ESI Module or ASCII Basic controller module Modbus Master and or Generate full spectrum ofModbus XMIT Function block and Modem Support master commands and or support controllers local Modbus port dial up modems with control characters Multiple RS 232 ports Multiple ports to communicate ESI Module or ASCII Basic with external devices are required module RS 232 ports in External devices have to be ESI Module or ASCII Basic Distributed I O connected to Distributed I O module 22 840 USE 108 00 August 2002 Intro
46. date as provided in the Command Words 1 to 7 The format for the time of day and date is identical to that used by the PLC time date registers Note To synchronize the module s and PLC s TOD clocks do a block move of the PLC s seven time date registers to Command Words 1 to 7 and set Command Word 0 to 0600 hex This command is executed only the first time it is received To execute the command again one of the Command Words 0 to 7 needs to be changed This is done so that the same time does not get continuously loaded until Command Word 0 changes to a command other than SET TOD 80 840 USE 108 00 August 2002 ESI Commands Command Structure Command Structure for Command 6 Word 0 15 14 13 12 11 10 9 8 7 65 06 Command Designation Note Bit 15 is the Status Word Valid bit Word 1 XXXX hex Day of the Week 1 Sunday 7 Saturday 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 Word 2 XXXX hex Month January 1 December C 12 dec 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 Word 3 XXXX hex Day of the Month 1 1F 31 dec 15 14 13 12111 10 9 8 7 6 5 4 3 2 1 Word 4 XXXX hex Year 00 63 99 dec 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 Word 5 XXXX hex Hour of the Day 0 17 23 dec 15 14 13 12 11 10 9
47. duction Module Description Overview Serial Ports Interface to Quantum Controller Port Buffer Register Memory ASCII Message Storage The ESI module consists of five major functional elements Serial ports for device communication Interface to the Quantum controller through the backplane Port buffer Register memory ASCII message storage memory Firmware The ESI module has implemented 3 logical communication ports Port 1 and Port 2 are used to communicate to external serial devices while Port 0 is used for programming the module Port 0 and Port 1 share one physical port All 3 ports can be set up independently For a detailed description of the port setup see Port Command p 55 The ESI module exchanges data with the Quantum controller through the use of 12 output words for commands and data from the Quantum controller and 12 input words for data to the Quantum controller and command echo and status information For detailed information about the structure of the command and response structures see ES Command Structure p 67 The 2 physical ports of the ESI module have an input and an output buffer of 255 characters each The device side of those buffers is maintained automatically by the optional XON XOFF handshake For data transfer to and from the Quantum controller and for buffer control several commands available for status testing are described in detail in this section Data Flow p 49 The
48. e Echoes state of the top input Ox None ON operation done Ox None ON error detected 840 USE 108 00 August 2002 97 ESI Loadable Parameter Description Top Input Middle Input Subfunction When the input to the top node is powered ON it enables the ESI instruction and starts executing the command indicated by the subfunction code in the top node When the input to the middle node is powered ON an Abort command is issued If a message is running when the ABORT command is received the instruction will complete if a data transfer is in process when the ABORT command is received the transfer will stop and the instruction will complete The top node may contain either a 4x register or an integer The integer or the value Top Node in the register must be in the range 1 4 It represents one of four possible subfunction command sequences to be executed by the instruction Subfunction Command Sequence 1 One command READ ASCII Message p 102 followed by multiple GET DATA commands 2 Multiple PUT DATA commands followed by one command WRITE ASCII Message p 106 Zero or more commands GET DATA p 107 Zero or more commands PUT DATA p 109 Note A fifth command ABORT ASCII Message can be initiated by enabling the middle input to the ESI instruction 98 840 USE 108 00 August 2002 ESI Loadable Subfunction Parameters Middle Node The
49. e begins at register 401000 Enter the following parameters in the table Register Parameter Value Description 401000 nnnn ESI status register 401001 1 I O mapped output starting register 400001 401002 1 I O mapped input starting register 300001 401003 501 Starting register for the data transfer 400501 401004 0 No 3x starting register for the data transfer 401005 100 Module start register 401006 4 Number of registers to transfer 401007 600 timeout 60 s 401008 10 ASCII message number 401009 1 ASCII port number 401010 17 N A Internal loadable variables With these parameters entered to the table the ESI instruction will handle the read and data transfers automatically in one scan 840 USE 108 00 August 2002 103 ESI Loadable Read and Data Transfers without ESI Instruction The same task could be accomplished in ladder logic without the ESI loadable but it would require the following three networks to set up the command and transfer parameters then copy the data Registers 400101 400112 are used as workspace for the output values Registers 400201 400212 are initial READ ASCII Message command values Registers 400501 400504 are the data space for the received data from the module First Network gt KJ 000011 000011 400201 400101 000911 400101 400001 BLKM BLKM 0012 0012 Contents of re
50. el A recessed push button on the front of the module is used to reset the module Reset Push Button 30 840 USE 108 00 August 2002 Hardware Overview System Specifications Module Specifications Specifications The following table lists the module specifications for the ESI 062 10 ASCII 2CH Data Interface RS 232C 2 serial ports 9 pin D shell non isolated Cabling Maximum cable length 20 m shielded 990 NAA 263 20 Modbus Programming Cable RS 232 12 ft 2 7 m 990 NAA 263 50 Modbus Programming Cable RS 232 50 ft 15 5 m Firmware Specifications Port Performance Burst Speed 19 2 k baud each port Continuous Speed Application dependent Depth of Nested Messages 8 Buffer Size 255 Input 255 Output 255 Output Number of Messages 255 Maximum Message Length 127 characters plus 1 checksum Memory RAM 256 kb for data and program 2 kb dual port ram Flash ROM 128 kb for program and firmware Power Dissipation 2 W max Bus Current Required 300 mA Fusing Internal None External User discretion Required Addressing 12 Words In 12 Words Out Compatibility Programming Software Modsoft V2 4 or Concept 2 0 at a minimum ProWorx NxT ProWorx 32 Data Formats Supported Text Decimal Fixed Point Nested Write Message Set Register Pointer Print Time Date Repeat Space Newline Control Code Flush Buffer
51. ested against the module start register in the workspace to make sure that they are the same If both these tests show matches test the Status Word Valid bit in response Word 0 To do this AND response Word 0 in the input register with 8000 hex to get rid of the echoed command word 0 information If the ANDed result equals the Status Word Valid bit coil 000020 is turned ON indicating an error and or status in the Module Status Word If the ANDed result is not the status word valid bit coil 000012 is turned ON indicating that the message is done and that you can start another command in the module Third Network 300012 000099 000020 pp TEST 0001 If coil 000020 is ON this third network will test the Module Status Word for busy status If the module is busy do nothing If the Module Status Word is greater than 1 busy a detected error has been logged in the high byte and coil 000099 will be turned ON At this point you need to determine what the error is by using some error handling logic that you have developed 840 USE 108 00 August 2002 105 ESI Loadable WRITE ASCII Message Subfunction 2 WRITE ASCII Ina WRITE ASCII Message command the ESI module writes an ASCII message to Message one of its serial ports The serial port number is specified in the tenth ninth implied register of the subfunction parame
52. first of eighteen contiguous 4x registers is entered in the middle node The ramaining seventeen registers are implied The following subfunction parameters are available Register Parameter Contents Displayed ESI status register Returned error codes First implied Address of the first 4x register Register address minus the leading 4 and in the command structure any leading zeros as specified in the I O Map e g 1 represents register 400001 Second Address of the first 3x register Register address minus the leading 3 and implied in the command structure any leading zeros as specified in the I O Map e g 7 represents register 300007 Third implied Address of the first 4x register Register address minus the leading 4 and in the controller s data register area any leading zeros e g 100 representing register 400100 Fourth implied Address of the first 3x register in the controller s data register area Register address minus the leading 3 and any leading zeros e g 1000 representing register 301000 Fifth implied Starting register for data Number in the range 0 3FFF hex register area in module Sixth implied Data transfer count Number in the range 0 4000 hex Seventh ESI timeout value in 100 ms Number in the range 0 FFFF hex where implied increments 0 means no timeout Eighth implied ASCII message number Number in the range 1 255 dec Ninth implied AS
53. ged by strong alkaline solutions Altitude 2 000 meters Vibration 10 57 Hz 0 075 mm d a 57 150 Hz 1g Shock 15 g peak 11 ms half sine wave Storage Conditions Temperature 40 85 C 40 185 F Humidity 0 95 RH noncondensing 60 C Free Fall 1m Agency Approvals UL 508 CSA 22 2 142 Factory Mutual Class I Div 2 European Directive on EMC 89 336 EEC 840 USE 108 00 August 2002 43 Hardware Description 44 840 USE 108 00 August 2002 Configuration Overview At a Glance Introduction What s in this Chapter The information in this chapter describes the basics of the configuration mode of the ESI modul A description of the data flow between external devices and the PLC is included at the end of the chapter This chapter contains the following topics Topic Page ESI Configuration 46 Data Flow 49 840 USE 108 00 August 2002 45 Configuration ESI Configuration Overview Programming Port How to Enter the Configuration Mode The Command The ESI module has a built in command line editor which is used to configure the port communication settings the internal clock and the ASCII messages The ESI module supports two RS 232 hardware ports which have their individual parameter settings at runtime The first port also is used as a progr
54. gisters Register Value hex Description 400201 0114 READ ASCII Message command Port 1 Four registers 400202 0064 Module s starting register 400203 nnnn Not valid data word 1 400212 nnnn Not valid data word 10 The first network starts up the READ ASCII Message command by turning ON coil 000011 forever It moves the READ ASCII Message command into the workspace then moves the workspace to the output registers for the module Second Network 300001 400088 400098 000011 400098 400098 400101 BLKM AND TEST 0001 0001 0001 300001 400089 400099 400099 BLKM AND 0001 0001 300002 400102 TEST 0001 1400099 32768 TEST O 000020 0 0001 000012 104 840 USE 108 00 August 2002 ESI Loadable Contents of registers Register Value hex Description 400098 nnnn Workspace for response word 400099 nnnn Workspace for response word 400088 7FFF Response word mask 400089 8000 Status word valid bit mask As long as coil 000011 is ON READ ASCII Message response Word 0 in the input register is tested to make sure it is the same as command Word 0 inthe workspace This is done by ANDing response Word 0 in the input register with 7FFF hex to get rid of the Status Word Valid bit bit 15 in Response Word 0 The module start register in the input register is also t
55. haracter 50 840 USE 108 00 August 2002 Configuration Possible As the ESI module only supports fixed length message formats without start or Synchronisation termination characters any lost character or additional unexpected character can Problems lead to a wrong interpretation of received data The following examples show the result of 3 different error types The assumed message format is 1L5 maximum 65 535 Effect of lost character Reason for error fe loss of one character Buffer content OL O10 1 31 6 0 O O 11 31 6 0 OF 1131 61 O OO 1 3 610 td Data interpretation 136 136 1360 1360 Effect of buffer not empty at start of reception character in buffer before start of receipt R f geen le first received character from device Buffer content OLO Of Of 1 3 6 O Of Of 17 3 6 Of Of O 1 3 6 Of OF OF 113 a SO OS Data interpretation 13 Error Error Error not a valid Integer Effect of terminated reception Reason for error Device stops transmission J Buffer content ool 0 4 31 6 Of O Of 1131 6 0 OF 773 T TT 1 TT a i A Data interpretation 136 136 wait for next 2 characters FLUSH ABORT To prevent mis interpretation of data or locking the module the buffer related GET STATUS commands FLUSH BUFFER ABORT GET BUFFER STATUS should be used to control the data exchange For details of
56. he module start register needs to be tested from the last command solve to determine which set of 10 registers to transfer next For example if the last command started with module register 400110 then the module start register for this command is 400120 Fourth Network Command Register Network 400101 000012 ATA 400001 BLKM 400102 Kas AD16 400102 As long as coil 000012 is ON add 10 to the module start register value in the workspace and move the workspace to the output registers for the module to start the next transfer of 10 registers 112 840 USE 108 00 August 2002 Appendices At a Glance Overview What s in this Appendix The Appendices provide additional information of general nature The appendix contains the following chapters Chapter Chapter Name Page A Character Set 115 840 USE 108 00 August 2002 113 Appendices 114 840 USE 108 00 August 2002 Character Set A ASCII Character Set Non Printable ASCII Characters The following table defines the ASCII set in decimal hexadecimal character and control character values Decimal Octal Hexa decimal Character Character Control 0 00 00 NUL NULL 1 01 01 SOH START OF HEADING 2 02 02 STX START OF TEXT 3 03 03 ETX END OF TEXT 4 04 04 EOT END OF TRANSM
57. hich consists of commands that allow you to display create edit transfer save clear and test ASCII messages Also included inthe command setis a help command which gives an online list of the available commands and the meaning of each command To enter the ASCII message editor type ASCII atthe CLI gt prompt The ASCII message editor uses the prompt ASCII gt 58 840 USE 108 00 August 2002 ESI Editors ASCII Message Formats Overview The ASCII message formats define how data contained in the CPU is converted to a stream of serial characters and vice versa The following table lists the available message formats Format Direction Description Text Output Static text ASCII Output Input ASCII characters Hexadecimal Output Input Hexadecimal numbers Octal Output Input Octal numbers Binary Output Input Binary numbers Integer Output Input Integer numbers Fixed Point Output Input Fixed Point Decimal numbers Decimal Time Date Output Time Date information Control Output Space and Newline characters Characters Control Output 3 digit octal control characters Sequences Nesting Output Input Nesting of messages Text An arbitrary ASCII string enclosed in single quotes e g Message string is an output only format Any message that contains this format will output the text whether or not the message is started from a read or write message command text ASCII Char
58. ial The ESI has two serial ports which it uses to communicate with serial devices The Ports following diagram shows the pinout connections for the ASCII module serial ports ie O6 20 07 30 O8 40 Connection O9 No Connection a Pinout for the RS 232 ports Pin Signal Name Description 1 DCD Carrier Detect 2 RXD Receive Data 3 TXD Transmit Data 4 N A Not Connected 5 GND Signal Ground 6 N A Not Connected 7 RTS Request to Send 8 N A Not Connected 9 N A Not Connected Shield N A Chassis Ground 840 USE 108 00 August 2002 39 Hardware Description Programming Port Minimum Cable Layout Port 1 is also used as the programming port Port 0 This mode is entered by pressing the Reset button for more then 4 seconds When programming mode is entered the serial port is set to a standard terminal communications configuration Programming mode uses the following port settings Parameter Setting Baud rate 9600 Data bits 8 Stop bits 1 Parity bit None disabled Keyboard Mode ON Character echo XON XOFF ON The serial port configuration has been set this way so that the configuration of the port is a known configuration and may or may not be the same configuration that is used when the module is running The minimum required cable layout to connect the ESI module either to an external device or a programming terminal PC is
59. increments of 10 in Words 2 11 in the GET DATA response structure If a sequence of GET DATA commands is being executed in conjunction with a READ ASCII Message command via subfunction 1 up to nine registers are transferred when the instruction is solved the first time Additional data are returned in groups of ten registers on subsequent solves of the instruction until all the data has been transferred If there is an error condition to be reported other than a command syntax error it is reported in Word 11 in the GET DATA response structure If the command has requested 10 registers and the error needs to be reported only nine registers of data will be returned in Words 2 10 and Word 11 will be used for error status Note If the data count and starting register number that you specify are valid but some of the registers to be read are beyond the valid register range only data from the registers in the valid range will be read The data count returned in Word 0 of the response structure will reflect the number of valid data registers returned and an error code 1280 hex will be returned in the Module Status Word Word 11 in the response table Command Structure Word Content hex Meaning 0 030D D data count 1 XXXX Starting register number in the range 0 3FFF 2 11 Not used 840 USE 108 00 August 2002 107 ESI Loadable
60. ler Overview The GET DATA command reads up to 10 words registers of data from the module starting at the start register number provided in Command Word 1 The data count provided in Command Word 0 determines the number of words to read The data is returned in Response Words 2 through 11 Note If there is an error status to be reported and is not a command syntax error and the command requests 10 registers of data the module will return only 9 words of data and use Response Word 11 for the module status The Status Word Data bit will be set if Response Word 11 is the module status This command is executed continuously until Command Word 0 changes to a command other than GET DATA Command Command Structure for Command 3 Structure Word 0 15 14 13 12 11 10 9 8 7 6 5 4 3 2 11 0 LJ 03 lt A hex Command Designation Data Count Word1 XXXX hex XXXX 0 3FFF Start Register Number 15 14 13 12111 10 9 8 7 6 5 4 383 21 1410 Note Word 2 through Word 11 for Command 3 are not used 74 840 USE 108 00 August 2002 ESI Commands Response Structure Response Structure for Command 3 Word0 Echo Command Word 0 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0 l 03 0 A Command Designation Data Count Note Bit 15
61. lication we use the following messages create 256 Message 1 ASCII messages per 123456789 port for this Message 2 module lt 0 gt Please enter your values here 3x 1L4 Message 3 lt 0 gt These are the values entered 3x 1L4 840 USE 108 00 August 2002 13 Step Action Remarks 7 Example of entering the messages Refer to the ASGII gt new F Skuse Enter message manual for the gt lt 0 gt Please enter your values here 3x 114 3X 1L4 different types ASCII gt save of ASCII Enter message number 1 255 gt 2 message Message saved formats ACSII gt e lt 0 gt is to flush the buffer clear the buffer in the ASCII port each time the message is executed e Followed by a text message e 3X 114 3X 1L4 is the message format e Xis the space e lis the integer format with leading spaces e Lis the integer format with leading zeros 8 Once you finished with keying the messages just type run at the command prompt 14 840 USE 108 00 August 2002 Step Action Remarks 9 Example ofthe application program on Concept 984 LL Refer to the S ascif_modute 1 ESI user _ ee ee ee Ler manual for a E i clear In this application program we are trying to read from the Hyper terminal and then output display the values read from it The read ESI function block is configured as follows description of the ESI loadable instruction
62. m the following steps when setting up the ESI module using Concept ESI Module Step Action Information 1 Launch Concept and start a new message 2 Select the PLC type and configure the IO Map e When configuring the ESI module click on the Parameter radio button on the top right hand corner and configure the ASCII and Programming port configuration e Inthis application the ESI input amp output references are mapped to 300001 8 400001 e The ASCII port amp programming port parameters are set to Baud rate 9600 Data bits 8 Parity None Stop bits 1 Keyboard off Xon Xoff enable Go to Loadables and unpack the loadables from the disk that comes with the user manual The loadables you need to unpack are nsup exe esi exe Then you must load the loadable beginning with e NSUP e ESI Always load the NSUP first followed by the ESI Once you have completed the above step then you can download the program to the processor Note that in this application we used the 170NOE771 110 ethernet module to communicate with the PC using Concept We simulated the program from Concept and captured the ASCII port response from Hyper terminal using a Modbus cable to COM port 1 and the PC You can use Modbus Plus to communicate with the processor using the SA85 card for PC or PCMIA for laptop users 840 USE 108 00 August 2002 11 Running an ESI Application
63. me for each ESI module regardless of the port Therefore if you need to run more than one ASCII command at any one time you must use different ESI modules Load the NSUP first then the ESI Do not overlap the module s internal registers If you want to make use of the ESI function block it is only available for 984LL type of programming If you wish to use the IEC type of programming you can make use of the registers configured in the I O map and write your own program without help of the ESI function block Always ensure the ASCII ports and programming port parameters are the same as the device connected to it 840 USE 108 00 August 2002 17 18 840 USE 108 00 August 2002 Introduction to ESI 062 10 At a Glance Introduction What s in this Chapter This chapter provides an overview of the 140 ESI 062 10 ASCII communication modul functionality and offers help to distinguish whether the module is appropriate for a given application This chapter contains the following topics Topic Page Introduction to ESI Module 20 Application Criteria 22 Module Description 23 ESI Module Block Diagramm 25 840 USE 108 00 August 2002 19 Introduction Introduction to ESI Module Overview Physical Media The Quantum ASCII interface module is a general purpose ASCII interface module providing the ability to communicate and exchange data with third par
64. mmand 030A Hex Start register 3FFA Hex Therefore the data count is 10 and the 6 valid registers 3FFA 3FFB 3FFC 3FFD 3FFE and 3FFF Hex data are returned The data count returned in the Command Word is 6 8306 Hex The following data are assumed to be in the ESI Registers ESI Register Content Hex SFFA 1111 3FFB 2222 3FFC 3333 3FFD 4444 3FFE 5555 3FFF 6666 The following table shows the command sent to the ESI module and the response User Logic Command User Logic Response Register Content Register Content 4x 0 030A Hex 3x 0 8306 Hex 4x 1 SFFA Hex 3x 1 3FFA Hex 4x 2 0000 Hex 3X 2 1111 Hex 4x 3 0000 Hex 3X 3 2222 Hex 4x 4 0000 Hex 3x 4 3333 Hex 4x 5 0000 Hex 3x 5 4444 Hex 4x 6 0000 Hex 3x 6 5555 Hex 4x 7 0000 Hex 3x 7 6666 Hex 4x 8 0000 Hex 3x 8 0000 Hex 4x 9 0000 Hex 3x 9 0000 Hex 4x 10 0000 Hex 3x 10 0000 Hex 4x 11 0000 Hex 3x 11 1280 Hex 840 USE 108 00 August 2002 93 ESI Commands 94 840 USE 108 00 August 2002 ESI Loadable Overview Purpose The ladder logic instructions for the ESI module are optional loadable instructions that can be used in a Quantum controller system to support operations using an ESI module The controller can use the ESI Instruction to invoke the module The power of the loadable is its ability to cause a sequence of commands over one or
65. more logic events What s in this This chapter contains the following topics 2 Chapter Topic Page Short Description 96 Representation 97 Parameter Description 98 Run Time Errors 101 READ ASCII Message Subfunction 1 102 WRITE ASCII Message Subfunction 2 106 GET DATA Subfunction 3 107 PUT DATA Subfunction 4 109 840 USE 108 00 August 2002 95 ESI Loadable Short Description Function Description Note This instruction is only available if you have unpacked and installed the DX Loadables For further information see Installation of DX Loadable in Concept Block Library LL984 840 USE 506 00 Version 2 6 The instruction for the ESI module 140 ESI 062 10 are optional loadable instructions that can be used in a Quantum controller system to support operations using a ESI module The controller can use the ESI instruction to invoke the module The power of the loadable is its ability to cause a sequence of commands over one or more logic scans With the ESI instruction the controller can invoke the ESI module to e Read an ASCII message from a serial port on the ESI module then perform a sequence of GET DATA transfers from the module to the controller e Write an ASCII message to a serial port on the ESI module after having performed a sequence of PUT DATA transfers to the variable data registers in the module e Perform a sequence of GET DATA transfers up to 16 384 registers of data from
66. nt is not intended as an instruction manual for untrained persons 2002 Schneider Electric All Rights Reserved 840 USE 108 00 August 2002 About the Book At a Glance Document Scope Validity Note Related Documents Product Related Warnings This book provides an overview and specifications of the Quantum ASCII interface module which provides the capability to communicate and exchange data with third party devices that may not use standard ASCII communications The data and illustrations found in this book are not binding We reserve the right to modify our products in line with our policy of continuous product development The information in this document is subject to change without notice and should not be construed as a commitment by Schneider Electric Title of Documentation Reference Number Quantum Automation Series Hardware Reference Guide 840 USE 100 00 Modicon Modsoft Programmers User Manual GM MSFT 001 Modicon Ladder Logic Block Library 840 USE 101 00 Concept User Manual 372 SPU 440 01 Schneider Electric assumes no responsibility for any errors that may appear in this document If you have any suggestions for improvements or amendments or have found errors in this publication please notify us No part of this document may be reproduced in any form or by any means electronic or mechanical including photocopying without express written permission of Schneider
67. ntation gor ogee Si 2 tak UA a E MAALE hale ates Atan aed ee 36 INCICALOrS TS eee er lake ew SD 37 External Connectors and Switches rereea 39 SPECificationS st e5c6 eto ee hae See eres ek ee gate ee hating Stated 41 Chapter 5 Configuration Overview 000 nunnu 45 Ata Glances f5atcddecae eh kiibist Mi lbs thde 45 ESI Configuiration ses es ofthe at eae ae Ake et 46 Data EIOW 5 mt Silas ete ees M ek Gad Bee ee hes 49 Chapter 6 ESI Command Line Editors 53 OVeIVIGW irie eei kl ood eee be te pala da oe eal eee ve 53 840 USE 108 00 August 2002 3 Chapter 7 Chapter 8 Appendices Appendix A Configuration Editor 0 0 0 eects 54 ASCII Message Editor 1 0 0 ects 58 ASCII Message Formats 1 r o a E OT eee ees 59 ESI CommandS Seca aes eae sass er a Yate wea hay elas eae esata ela 65 Ata GLANGE 3 krae sate ant ba Phos cots aie rate Rts charac tae tl let 65 Overview on ESI Commands 00000 cece teens 66 ESI Command Structure 0 0 67 Command 0 NO OPERATION rererereeee 68 Command 1 READ ASCII MESSAGE seeeeee 69 Command 2 WRITE ASCII MESSAGE reeerese 71 Command 3 GET DATA Module to Controller 4 74 Command 4 PUT DATA Controller to Module 76 Command 5 GET TOD Time of Day meeses eee 78
68. ommands ESI Command Structure Command Word The command word is the first output register mapped to the module Format The command word format for the ESI module is as follows e Bits 0 3 contain the data count in words range is 0 9 e Bits 4 7 contain the port number range is 1 2 e Bits 8 15 contain the command range is 0 A Structure of the command word MSB LSB Command Port Number Data Count Note The bit order is based on the IEC standard where bit 15 is the most significant bit 840 USE 108 00 August 2002 67 ESI Commands Command 0 NO OPERATION Overview The NO OPERATION command does nothing in or to the ESI module It is present to allow multiple scan command builds setting up of Command Words 1 to 11 then setting Command Word 0 to start the command execution and toggling for repeating command that do not run continuously This command is executed continuously until Command Word 0 changes to a command other than NO OPERATION Command Command Structure for Command 0 Structure Word0 0000 hex 15 14 13 12 11 10 9 8 7 6 5 4 3 2 141 0 Note Word 1 through Word 11 for Command 0 are not used Response Response Structure for Command 0 Structure Word O 0000 hex Echo Command Word 0 15 14 13 12 11 10 9 8 7 6 5 4 3 2 141 0
69. op and continue the data being displayed to the terminal DLOAD Download messages from a PC to the N A module See ASCII Message Transfer for more details ULOAD Uploads all programmed messages 1 ASCII gt uload 255 Uploads a specified programmed ASCII gt uload message message s from the module toa PC See message ASCII Message Transfer for more details 48 840 USE 108 00 August 2002 Configuration Data Flow Overview Exchanging data between the Quantum processor and the serial ports of the ESI module involves the following steps Transmit direction e Transfer of the data from the PLC registers to the ESI register area through the 12 output registers assigned to the ESI module in the I O configuration e Interpreting the data in the ESI registers based on the ASCII messages and transfer to the port transmit buffer Receive direction e Interpreting the data in the port receive buffer based on the ASCII messages and transfer to the ESI register area e Transfer of the data from the ESI register area to the PLC registers through the 12 input registers assigned to the ESI module in the I O configuration ASCII Messages The ASCII messages represent the central mechanism of how the data in the ESI registers are formated for the transmission through the RS 232 ports in either direction A single 16 bit register for example could represent 2 ASCII characters and thus be transmitted
70. ord 1 3 XXXX Data word 2 11 XXXX Data word 10 Response Structure Word Content hex Meaning 0 040D Echoes command word 0 1 XXXX Echoes starting register number from command word 1 2 0000 Returns a zero 10 0000 Returns a zero 11 XXXX Module status 840 USE 108 00 August 2002 109 ESI Loadable A Comparative Below is an example of how an ESI loadable instruction can simplify your logic PUT DATA programming task in a PUT DATA application Assume that the 12 point Example bidirectional ESI 062 module has been I O mapped to 400001 400012 output registers and 300001 300012 input registers We want to put 30 controller data registers starting at register 400501 to the ESI module starting at location 100 Parameterizing of the ESI instruction 0004 401000 ESI 0018 The subfunction parameter table begins at register 401000 Enter the following parameters in the table Register Parameter Value Description 401000 nnnn ESI status register 401001 1 I O mapped output starting register 400001 401002 1 I O mapped input starting register 300001 401003 501 Starting register for the data transfer 400501 401004 0 No 3x starting register for the data transfer 401005 100 Module start register 401006 30 Number of registers to transfer 401007 0 timeout never 401008 N A ASCII message number 4
71. oved Example gt 1A4 2X gt gt 144 2X e Spaces trailing the last format are removed Example gt 1A4 2X end gt gt 1A4 2X end e Spaces around formats and delimiters are removed Example gt 1A4 2X gt gt 1A4 2X e Commas trailing the last format are removed Example gt 1A4 2X gt gt 1A4 2Xx e Commas trailing the last format in a repeat format are removed Example gt 1A4 2X 3 112 1X gt gt 1A4 2X 3 112 1X e Non text characters are capitalized Example gt text 1a4 2x gt gt text 1A4 2X e All preceding 0 s are removed from a number except 0 s in flush format s repeat number value and character pair value Example gt 01A004 0002X gt gt 1A4 2x 64 840 USE 108 00 August 2002 ESI Commands At a Glance Introduction The information in this chapter describes the commands which are sent by the CPU to control the communication functions of the ESI module and the response from the ESI module containing data and status information What s in this This chapter contains the following topics Chapter Topic Page Overview on ESI Commands 66 ESI Command Structure 67 Command 0 NO OPERATION 68 Command 1 READ ASCII MESSAGE 69 Command 2 WRITE ASCII MESSAGE 71 Command 3 GET DATA Module to Controller 74 Command 4 PUT DATA Controller to Module 76 Command 5 GET TOD Time of Day 78 Command 6 SET TOD Time of Day 80 Command 7 S
72. peat m is the field length 1 5 number of numbers Example 215 as an input stands for 2 registers each containing 5 Integer Decimal numbers Max value is 65 535 60 840 USE 108 00 August 2002 ESI Editors Integer Leading Zeroes Fixed Point Decimal Nested Message A variable field of the Integer Decimal format using leading zeroes for output with Number of registers and Field Length On input this format accepts leading zeroes and spaces as a 0 zero nLm nis the number of registers 1 99 format repeat m is the field length 1 5 number of numbers Example 3L5 as an input stands for 3 registers each containing 5 Integer Decimal numbers Max value is 65 535 A variable field of the Fixed Point Decimal format using leading spaces for output with Number of registers and Field Length On input this format accepts leading zeros and spaces as a 0 zero nPm q nis the number of registers 1 99 format repeat m is the number of numbers 3 8 q is the number of fraction numbers 1 5 Example 1P7 2 as an input stands for 1 register containing 4 Decimal numbers followed by a which is followed by 2 more Decimal numbers the fraction part Note This format should not be mixed up with a floating point format The placement of the decimal point is for input output formatting and has no influence on the value in the PLC register e g all 3 values 23 456 234 56 and 23456 will refer to a regi
73. rd 11 XXXXhex Module Status 15 14 13 121111101 9 81 171 6151413 2 1 1 10 Note Word 4 through Word 10 for Command 7 returns a 0 84 840 USE 108 00 August 2002 ESI Commands Command 8 FLUSH BUFFER Overview The FLUSH BUFFER command flushes the input buffer for the serial port number provided in the command word The output buffer is not affected by this command Command Command Structure for Command 8 Structure Word 0 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0 08 0001 or 0010 Command Designation Port Number Note Word 1 through Word 11 for Command 8 are not used Response Response Structure for Command 8 Structure Word0 Echo Command Word 0 15 14 13 12111 109 8 7 6 5 4 3 2 1 10 08 0001 or 0010 Command Designation Port Number Note Bit 15 is the Status Word Valid bit Word 1 XXXX hex 15 14113112111 10 9 8 7 6 15 4 31 2 1 0 Word 11 XXXXhex Module Status 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0 Note Word 3 through Word 10 for Command 8 returns a 0 840 USE 108 00 August 2002 85 ESI Commands Command 9 ABORT Overview The ABORT command aborts a running READ
74. s If any violations are found the message either is not saved ASCII Message Transfer or the user is notified and the violation is pointed out ASCII Message Editor e A format delimiter must separate each format e All text formats must be closed e Formats A H O B I L P X and can have a repeat number of registers value from 1 to 99 e Formats A H O B I and L can have a total field size from 1 to 8 e Format P can have a total field size from 3 to 8 and a fractional field size from 1 to 5 but the total field size must be at least 2 greater than the fractional field size e Format M Nested Message can have any message number 1 to 255 decimal as long as it is not recursive e Format T can have 1 of 2 formats T12 or T24 e Format D can have 1 of 10 formats D12 D14 D22 D24 D32 D34 D42 D44 D52 and D54 e Control Code format accepts only 3 digit octal values from 000 to 377 e Flush format can have 1 of 4 formats lt 0 gt lt 1 bbb gt lt 2 hhhh gt or lt 3 rrr hhhh gt where bbb 1 to 255 hhhh 0000 to FFFF and rrr 1 to 255 Messages created with the Module s ASCII Message Editor or downloaded using the ASCII Message Transfer are preprocessed after being entered to save space and to standardize the messages for interpretation during simulation or running mode e Text is not massaged at all Example gt This is text gt gt This is text e Spaces preceding the first format are rem
75. s as well as to other control systems used within the industrial automation application These third party devices require communications in a language they can understand in order to enable data transmission to occur between the third party device and the ASCII module For example a scale measuring the total weight of a package may respond to receiving a control A ASCII character lt A gt by returning the package weight This data is placed into the memory of the ASCII module which in turn is read by the Quantum controller The controller may need to make a logical decision of where the package should go if the weight is above a certain pre defined amount The ASCII module therefore allows integration of data typically found within automation applications by simply knowing the protocol or language the foreign device needs in order to communicate 840 USE 108 00 August 2002 21 Introduction Application Criteria Introduction The Quantum PLC family offers various solutions for communication with external devices Depending on the needs of the application the user may select software solutions XMIT function block using a CPU Modbus port or hardware solutions ESI module or ASCII Basic module The following information helps to find the appropriate solution for a given application Application The chart below identifies typical applications and the recommended produ
76. ster value of 23456 The nesting message format allows a message to call another message This format can be used within the repeat format repeat formats can be used in the nested message allowing for indirect nested repeats The maximum allowable nested message levels is 8 Recursive nesting is not allowed Mn nis the message number 1 255 Example M6 will run message number 6 840 USE 108 00 August 2002 61 ESI Editors Time Date Repeat There are two different time formats for displaying the time One is for 12 hour time and the other is for 24 hour time This is an output only format T12 gt hh mm ss AM PM 12 hour time T24 gt hh mm ss 24 hour time There are five different date formats for displaying the date each having 2 types of formats for displaying the year This is an output only format Dnm n is the day and month type 1 5 m is the year type 2 or 4 D12 gt dd mm yy D14 gt dd mm yyyy D22 gt mm dd yy D24 gt mm dd yyyy D32 gt dd mmm yy D34 gt dd mmm yyyy D42 gt mmm dd yy D44 gt mmm dd yyyy D52 gt dd mm yy D54 gt dd mm yyyy dd day 1 31 mm month 1 12 mmm month JAN FEB DEC yy year 0 99 90 99 in 1900 s 0 89 in 2000 s yyyy year 1990 2089 Repetition of several formats nesting of repeat brackets is not valid n nis the number of times to repeat what is in 1 99 Example 6 Item
77. tation Function The 140 ESI 062 10 module is a Quantum communications interface module used to input messages and or data from an ASCII device to the CPU output messages and or data from the CPU to an ASCII device or bi directionally exchange messages and or data between an ASCII device and the CPU Illustration The following figure shows the140 ESI 062 10 module and its components m y af Reset amp D KI if af 1 Model Number Module Description Color Code 2 LED Display 3 Port1 Connector 4 Reset Button 5 Port 2 Connector 6 Removable door 7 Customer Identification Label Fold label and place it inside door 36 840 USE 108 00 August 2002 Hardware Description Indicators Illustration The following table shows the LED indicators for the 140 ESI 062 10 module R Active Tx 1 Error 1 Rx 1 Tx 2 Error 2 Rx 2 Status Descriptions The following table describes the LED descriptions for the 140 ESI 062 10 module LEDs Color Indication when ON R Green The module has passed powerup diagnostics Active Green Bus communication is present F Red The module has detected a fault RX1 Green Received data on RS 232 Port 1 TX1 Green Transmitted data on RS 232 Port 1 RX2 Green Received data on RS 232 Port 2 TX2
78. ters table See Subfunction Parameters Middle Node p 99 The ASCII message number to be written is specified in the ninth eighth implied register of the subfunction parameters table When the top node of the ESI instruction is 2 the controller invokes the module and causes it to execute one Write ASCII command Before starting the WRITE command subfunction 2 executes a sequence of PUT DATA transfers transferring up to 16 384 registers of data from the controller to the module Command Command Structure Structure Word Content Meaning hex 0 02PD P port number 1 or 2 D data count 1 XXXX Starting register number in the range 0 3FFF 2 00xx Message number where xx is in the range 1 FF 1 255 dec 3 XXXX Data word 1 4 XXXX Data word 2 11 XXXX Data word 9 Response Response Structure Structure Word Content Meaning hex 0 02PD Echoes command word 0 1 XXXX Echoes starting register number from command word 1 2 00xx Echoes message number from command word 2 3 0000 Returns a zero 10 0000 Returns a zero 11 XXXX Module status 106 840 USE 108 00 August 2002 ESI Loadable GET DATA Subfunction 3 GET DATA Command Structure A GET DATA command transfers up to 10 registers of data from the ESI module to the controller each time the ESI instruction is solved in ladder logic The total number of words to be read is specified in Word 0 of the GET DATA command structure the data count The data is returned in
79. to the output registers for the module Second Network Command Register Network A UJ 000020 000020 300001 000011 000020 400101 300002 TEST 400102 400102 0001 TEST 0120 0001 TEST JF 20091 000012 840 USE 108 00 August 2002 111 ESI Loadable As long as coil 000011 is ON and coil 000020 is OFF PUT DATA response word 0 in the input register is tested to make sure it is the same as the command word in the workspace The module start register in the input register is also tested to make sure it is the same as the module start register in the workspace If both these tests show matches the current module start register is tested against what would be the module start register of the last PUT DATA command for this transfer If the test shows that the current module start register is greater than or equal to the last PUT DATA command coil 000020 goes ON indicating that the transfer is done If the test shows that the current module start register is less than the last PUT DATA command coil 000012 indicating that the next 10 registers should be transferred Third Network Command Register Network 400102 400102 000012 0100 0110 TEST TEST 0001 0001 400511 400521 400103 400103 BLKM BLKM 0010 0010 As long as coil 000012 is ON there is more data to be transferred T
80. ty devices These devices typically are found in industrial environments that do not utilize a standard communication method familiar to industrial automation Such standard communication methods are using the industry standard Modbus communications which defines the data query and response strings necessary along with the physical interface required to communicate between programmable devices There are many communications standards and field busses available in industrial automation today Few of these standards are based on RS 232C physical media for serial data streams Much of the serial data information is not based on one of the available standards therefore the need for ASCII interfacing is required ASCII communications are based on a custom serial protocol using RS232 or RS422 485 physical media Features of different physical media Standard Maximum Distance Physical Attributes Data Rate Range RS232 50 feet Point to Point 180 bps to 19200 bps Multi drop using modems RS422 400 feet Point to Point 180 bps to 19200 bps Multi drop using modems RS485 Wide Range Multi drop internal modems 180 bps to 19200 bps 2 Wire or 4 Wire standards 20 840 USE 108 00 August 2002 Introduction Serial Device Applications The majority of these ASCII applications talk directly to printers bar code readers and scanners serial devices such as weigh scales meters and other measurement device
81. ugust 2002 41 Hardware Description I O Mapping Required Addresses In 12 Words Out 12 Words Compatibility Compatibility Programming Software Concept 2 0 ProWorx NxT ProWorx 32 Modsoft Data Formats Supported Text Decimal Fixed Point Nested Write Message Set Register Pointer Print Time Date Repeat Space Newline Control Code Flush Buffer Quantum Controllers All Executive V2 0 at a minimum Battery Backup Module 140 XCP 900 00 Mechanical Mechanical IWeight 1 kg max Dimensions H x D x W 250 mm x 103 85 mm x 40 34 mm Material Enclosures and Bezels Lexan Space Reguirements 1 backplane slot Electrical Electrical RFI Immunity IEC 1000 4 3 27 500 MHz 10 V m Electrostatic Discharge IEC 1000 4 2 8 kV air 4 kV contact Fast Transients IEC 1000 4 4 0 5 kV common mode Damped Oscillatory Transients 1 kV common mode 0 5 kV differential mode Surge Withstand Capability 1 kV common mode Transients IEC 1000 4 5 0 5 kV differential mode 42 840 USE 108 00 August 2002 Hardware Description Environmental Conditions Storage Conditions Agency Approvals Environmental Conditions for Operation Temperature 0 60 C 32 140 F Humidity 0 95 RH noncondensing 60 C Chemical Interactions Enclosures and bezels are made of Lexan a polycarbonate that can be dama
82. ust be loaded before ESI in order for the loadable to work properly If ESI is loaded before NSUP or ESI is loaded alone all three outputs will be turned ON The middle output goes ON for one scan when the subfunction operation specified in the top node is completed timed out or aborted The bottom output goes ON for one scan if an error has been detected Error checking is the first thing that is performed on the instruction when it is enabled For more details see error checking See Run Time Errors p 101 100 840 USE 108 00 August 2002 ESI Loadable Run Time Errors Run Time Errors The command sequence executed by the ESI module specified by the subfunction value See Subfunction Top Node p 98 in the top node of the ESI instruction needs to go through a series of error checking routines before the actual command execution begins If an error is detected a message is posted in the register displayed in the middle node The following table lists possible error message codes and their meanings Error Code dec Meaning 0001 Unknown subfunction specified in the top node 0010 ESI instruction has timed out exceeded the time specified in the eighth register of the subfunction parameter table See Subfunction Parameters Middle Node p 99 0101 Error in the READ ASCII Message sequence 0102 Error in the WRITE ASCII Message sequence 0103 Error in the GET
83. ystem specifications for operating conditions conditions Temperature 0 60 C 32 140 F Humidity 0 95 RH noncondensing 60 C Chemical Interactions Enclosures and bezels are made of Lexan a polycarbonate that can be damaged by strong alkaline solutions Altitude 2 000 meters Vibration 10 57 Hz 0 075 mm d a 57 150Hz 1g Shock 15 g peak 11 ms half sine wave Storage The following table provides system specifications for storage conditions Conditions Temperature 40 85 C 40 185 F Humidity 0 95 RH noncondensing 60 C Free Fall 3 ft 1m Agency The following table lists necessary agency approvals Approvals UL 508 CSA 22 2 142 Factory Mutual Class I Div 2 European Directive on EMC 89 336 EEC 840 USE 108 00 August 2002 33 Hardware Overview System Specifications 34 840 USE 108 00 August 2002 140 ESI 062 10 Hardware Description 4 At a Glance Introduction What s in this Chapter The information in this chapter describes the hardware features of the 140 ESI 062 10 module Product specifications are included at the end of the chapter This chapter contains the following topics Topic Page Presentation 36 Indicators 37 External Connectors and Switches 39 Specifications 41 840 USE 108 00 August 2002 35 Hardware Description Presen

Quantum Automation Series

Contents

Download Pdf Manuals

Related Search

Related Contents