Omron CJ1W-ETN21 TCP Socket Send Request

124

Using Socket Services by Manipulating Dedicated Control Bits Section 6-7

Note These response codes will be returned only on large, multilevel networks.

TCP Socket Send Request

Note These response codes will be returned only on large, multilevel networks.

004F

(See note.)

ICMP data received (EHOSTDOWN).

0051

(See note.)

ICMP data received (EHOSTUNREACH).

0053 Error in communications with remote host (ETIMEDOUT).

0066 Internal memory cannot be obtained; cannot execute.

0080 Receive request timed out.

0081 The specified socket was closed during receive processing.

Response

code

Meaning

0000 Normal end

0302 CPU Unit error; cannot execute.

1100 Number of bytes to send not in allowable range.

1101 The area designation of the Send/Receive Data Address is not in

allowable range.

1103 The bit number in the Send/Receive Data Address is not 00.

110C Request Switch turned ON during other processing.

220F Specified socket is already processing a send request.

2210 The specified socket is not been connected.

2211 Unit is busy; cannot execute.

2607 Specified Socket Service Parameter Area is already being used for

another socket.

0020 Connection with remote socket broken during send (EPIPE).

003E Internal buffer cannot be obtained due to high reception traffic

(ENOBUFS).

0042

(See note.)

The remote IP address is a broadcast address and the number of

bytes to send is greater than 1,472 bytes (EMSGSIZE).

0044

(See note.)

ICMP data received (ENOPROTOOPT).

0045

(See note.)

Error in communications with remote node (ECONNABORTED).

004A Error in communications with remote node (ECONNREFUSED).

004B

(See note.)

Error in communications with remote node (ECONNRESET).

004E

(See note.)

Remote IP address parameter error (ENETUNREACH).

004F

(See note.)

ICMP data received (EHOSTDOWN).

0051

(See note.)

Remote IP address parameter error (EHOSTUNREACH).

0053

(See note.)

Error in communications with remote node (ETIMEDOUT).

0081 The specified socket was closed during send processing.

Response

code

Meaning

Contents

Main Page v Notice: !DANGER !WARNING OMRON Product References Visual Aids Page Page Page Page Page xi About this Manual: xii Relevant Manuals xiii !WARNING Page xv Read and Understand this Manual Warranty and Limitations of Liability WARRANTY LIMITATIONS OF LIABILITY xvi Application Considerations SUITABILITY FOR USE PROGRAMMABLE PRODUCTS Disclaimers Page xix Unit Versions of CS/CJ-series Unit Versions xx Unit Version Notation Unit Versions and Lot Numbers xxi PRECAUTIONS xxii Intended Audience 1 1 Intended Audience 2 General Precautions !WARNING 3 Safety Precautions !WARNING xxiii Safety Precautions 3 !WARNING xxiv Operating Environment Precautions 4 4 Operating Environment Precautions 5 Application Precautions !WARNING xxv Application Precautions 5 xxvi Conformance to EC Directives 6 6 Conformance to EC Directives 6-1 Applicable Directives 6-2 Concepts Page 2 Ethernet Unit Communications Services Section 1-1 1-1 Ethernet Unit Communications Services 1-2 Functions Listed by Purpose 3 Table of Protocols Section 1-3 1-3 Table of Protocols 1-4 Common Protocol Settings 1-4-1 SMTP 1-4-2 POP 1-4-3 DNS Page Page SECTION 2 Mail Send Function 10 Mail Send Function Overview Section 2-1 2-1 Mail Send Function Overview 2-1-1 Introduction 2-1-2 Comparison with the Earlier Mail Send Function 2-1-3 Mail Send Function's Compatibility with Earlier Models 2-2 M ail Send Function Details 2-2-1 Contents of E-mail Body Status information (optional) Body Attached file Header 2-2-2 Contents of E-mail Body Page 2-2-3 Attached File Details 2-2-4 Summary of E-mail Body Information and Attached Files 17 Mail Send Function Specifications Section 2-3 2-3 Mail Send Function Specifications 2-3-1 Function Specifications 2-3-2 Details of the Available Mail Triggers 2-4 Using the Mail Send Function 2-4-1 Procedure 2-4-2 Settings Required for the Mail Send Function The following Unit settings must be made when using the Mail Send Function. Page 2-4-3 Mail Address 2-4-4 Send Mail Send Mail Condition Settings Attached File Name Send Mail Trigger Type Setting (Required) 24 Mail Send Function Status Section 2-5 2-5 Mail Send Function Status 2-5-1 Send Mail Status 25 Mail Send Function Status Section 2-5 2-5-2 Mail Send Switch, Accessing Memory/Sending Mail Flag 26 I/O Memory Data Formats Section 2-6 n+17 2-6 I/O Memory Data Formats -------------- - IOM file contents 27 Attached File Transfer Times Section 2-7 2-7 Attached File Transfer Times TXT file contents Contents of TXT file when displayed CSV file contents Contents of CSV file when displayed 28 Mail Send Function Errors Section 2-8 2-8 Mail Send Function Errors 2-8-1 Identifying and Correcting Mail Send Function Errors 29 Mail Send Function Errors Section 2-8 2-8-2 Troubleshooting Mail Send Errors with LED Indicators 2-8-3 Error Log Error Codes for the Mail Send Function 30 2-9 Example Application Initial Server Settings 2-9-1 Step 1. Create the I/O Table 2-9-2 Step 2. Make the Unit Setup Settings from the CX-Programmer 1. Initial Settings (Example) 31 2. Destination Mail Address Setup 3. Send Condition Setting 1 2-9-3 Step 3. Transfer the CPU Bus Unit Setup Settings 2-9-4 Step 4. Automatic Transmission when Send Condition is Satisfied SECTION 3 Receive Mail Function 34 Mail Receive Function Overview Section 3-1 3-1 Mail Receive Function Overview 3-1-1 Introduction Advantages Description 35 3-1-2 Table of Remote Mail Commands 36 Mail Receive Function Specifications Section 3-2 Received E-mail 3-2 Mail Receive Function Specifications 3-2-1 Function Specifications 37 Mail Receive Function Specifications Section 3-2 Response E-mail 3-3 Using the Mail Receive Function 3-3-1 Procedure 3-3-2 Settings Required for the Mail Receive Function The following Unit settings must be made when using the Mail Receive Func- tion. 3-3-3 Receive Mail Tab Posting Mail Address Protection Setting Receive Attached File Setting Receive Command Setting 42 3-4 Remote Mail Command Details Response Format 3-4-1 Format Command Format MailLogClear Select when you want to execute the Mail Log Clear command. 43 FileWrite (File Write) 44 FileRead (File Read) 45 FileDelete (File Delete) 46 FileList (File List Read) Response Format Details 47 UMBackup (User Memory Backup) 48 PARAMBackup (Parameter Area Backup) 49 IOMWrite (I/O Memory Write) Page 51 IOMRead (I/O Memory Read) Page 53 ChangeMode (Operating Mode Change) Function Changes the CPU Unit's operating mode. 54 ErrorLogRead (Error Log Read) 55 ErrorLogClear (Error Log Clear) 56 MailLogRead (Mail Log Read) Page Page 59 FinsSend (FINS Command Send) 3-4-2 Response List Function Requests execution of the specified FINS command by the Ethernet Unit. 60 Mail Receive Function Status Section 3-5 IOM file contents 3-5 Mail Receive Function Status 3-5-1 Accessing Memory/Receiving Mail Flag 3-6 I/O Memory Data Formats IOM Format 61 I/O Memory Data Formats Section 3-6 TXT Format CSV Format TXT file contents Contents of TXT file when displayed CSV file contents Contents of CSV file when displayed 3-7 Attached File Transfer Times 63 Mail Receive Function Errors Section 3-8 ual Construction of Networks. 3-8 Mail Receive Function Errors 3-8-1 Identifying and Correcting Mail Receive Function Errors 3-8-2 Troubleshooting Mail Receive Errors with LED Indicators 64 Mail Receive Function Errors Section 3-8 3-8-3 Error Log Codes Related to the Mail Receive Function 65 Example Application Section 3-9 3-9 Example Application 3-9-1 Step 1. Create the I/O Table 3-9-2 Step 2. Make the Unit Setup Settings from the CX-Programmer 66 Example Application Section 3-9 3-9-3 Step 3. Transfer the CPU Bus Unit Setup Settings 3-9-4 Step 4. Send Remote Mail Commands Reading Data from a CPU Unit Data Area Backing Up the CPU Unit's User Program in the Memory Card SECTION 4 FTP Server 68 Overview Section 4-1 4-1 Overview Note Only one FTP client can connect at the same time. 4-1-1 Specifications 69 FTP Server Function Details Section 4-2 4-2 FTP Server Function Details 4-2-1 File Types 4-2-2 Connecting to the FTP Server 4-3 Using the FTP Server Function 4-3-1 Procedure 71 Using the FTP Server Function Section 4-3 4-3-2 List of Settings Required for the FTP Server Function Make the following settings for the unit setup when the server function is used. 4-3-3 Setup Tab 72 FTP Server Application Example Section 4-4 4-4 FTP Server Application Example 73 4-5 Using FTP Commands 4-5-1 Table of Commands 4-5-2 Using the Commands open 74 user ls dir rename 75 mkdir rmdir pwd cd 76 type get mget put Page 78 4-5-3 Error Messages and FTP Status Error Messages The error messages returned by the Ethernet Unit are listed in the following table. 79 Checking FTP Status Section 4-6 4-6 Checking FTP Status 4-6-1 FTP Status Flag 4-7 Using File Memory 4-7-1 File Memory 4-7-2 File Types Page 4-7-3 Initializing File Memory 4-7-4 I/O Memory Data Format Page Page 85 FTP File Transfer Time Section 4-8 4-8 FTP File Transfer Time 86 UNIX Application Example Section 4-9 4-9 UNIX Application Example Page Page SECTION 5 Automatic Clock Adjustment Function 90 Overview Section 5-1 5-1 Overview 5-1-1 Overview 5-1-2 Specifications 5-2 Using the Automatic Clock Adjustment Function 5-2-1 Procedure 5-2-2 Settings Required for Automatic Clock Adjustment Function Note When the Server specification type field in Auto Adjust Time Tab is set to Host name. 5-2-3 Auto Adjust Time 94 Automatic Clock Adjustment Switch Section 5-3 5-3 Automatic Clock Adjustment Switch 5-4 Automatic Clock Adjustment Error Processing 5-4-1 Automatic Clock Adjustment (SNTP) Errors 5-4-2 Troubleshooting Automatic Clock Adjustment Errors with Indicators 95 5-4-3 Error Log Error Codes for the Automatic Clock Adjustment Function 96 Automatic Clock Adjustment Error Processing Section 5-4 SECTION 6 Socket Services Page 99 Overview of Socket Communications from Ethernet Units Section 6-1 6-1 Overview of Socket Communications from Ethernet Units 6-1-1 What are Sockets? 6-1-2 Socket Port Numbers 6-2 Protocol Overview 6-2-1 Differences between TCP and UDP 6-2-2 Opening TCP Sockets Page 6-2-3 Fragmentation of Send Data 6-3 Overview 6-3-1 Socket Service Functions 6-3-2 Using Socket Services with Socket Service Request Switches 6-3-3 Using Socket Services with CMND(490) 6-3-4 Specific Socket Service Functions 106 Socket Service Function Guide Section 6-4 6-3-5 Differences with Previous Models 6-4 Socket Service Function Guide 6-4-1 Manipulating Dedicated Control Bits 6-4-2 Executing CMND(490) 107 6-5 Using Socket Service Functions 6-5-1 Procedure 6-5-2 Settings Required for Socket Service Function The following settings must be made in the Unit Setup when using socket ser- vices. Manipulating Dedicated Control Bits 6-5-3 Setup Tab . Setup Page 110 Socket Service Status Section 6-6 6-6 Socket Service Status 6-6-1 CIO Area Allocations 111 Socket Service Status Section 6-6 6-6-2 DM Area Allocations 112 6-7 Using Socket Services by Manipulating Dedicated Control Bits 6-7-1 Application Procedure Procedure 6-7-2 Socket Services and Socket Status Program Flow Error Evaluation 6-7-3 Socket Service Parameters 116 Parameter Settings Note W: Written by user RW: Written by user at execution and then read for results at completion 6-7-4 Parameters Page 6-7-5 Socket Service Request Switches The configuration of each set of Socket Service Request Switches is shown in the following diagram. 6-7-6 Response Codes UDP Socket Send Request UDP Socket Close Request TCP Socket Passive Open Request TCP Socket Active Open Request TCP Socket Receive Request TCP Socket Send Request 6-7-7 Timing Charts Page 6-7-8 TCP/IP Communications Programming Example Send data, 100 bytes (100 = 0064 Hex) CIO 0002 Receive data, 100 bytes (100 = 0064 Hex) 76543210 CIO 0000 CIO 0001 Page Page 6-7-9 UDP/IP Communications Programming Example PLC Host computer Ethernet Unit IP address: 196.36.32.55 Port number: 4096 IP address: 196.36.32.101 Port number: 4096 Page Page Page Page 6-8 Using Socket Services with CMND(490) 6-8-1 Using Socket Service 6-8-2 Socket Services and Socket Status 6-8-3 Basic FINS Command Format 6-8-4 Response Codes in the Command Response 6-8-5 Response Codes in the Results Storage Areas 6-8-6 Communications Timing Chart 6-8-7 Socket Service Timing Chart CLOSE REQUEST SEND REQUEST CMND(490) response code RECEIVE REQUEST Send Flag Results storage area 6-8-8 TCP/IP Communications Programming Example System Configuration 142 Data Flow Basic Operations 143 Program Memory Maps Page Page 76543210 CIO 0000 CIO 0001 CIO 0002 15 to 8 Page Page 149 6-8-9 UDP/IP Communications Programming Example System Configuration Basic Operations 150 Program Memory Maps The send and receive data and bits (flags) used by the program are shown in the following diagrams. Page Page Page Page 155 Precautions in Using Socket Services Section 6-9 6-9 Precautions in Using Socket Services 6-9-1 UDP and TCP Socket Services 6-9-2 UDP Socket Service 6-9-3 TCP Socket Service 156 6-9-4 Precautions in Using Socket Service Request Switches 6-9-5 Maximum Transmission Delays (Ignoring other Network Delays) Page SECTION 7 Using FINS Communications to Create Host Applications 160 Overview of FINS Communications Section 7-1 7-1 Overview of FINS Communications 7-1-1 Communications On an Ethernet Network Application Layer Transport Layer Internet Layer Physical Layer 161 Overview of FINS Communications Section 7-1 7-1-2 Using the FINS/UDP and FINS/TCP Methods 7-1-3 FINS Communications Service Specifications for Ethernet 162 FINS Frames Section 7-2 1 0 0 0 0 0 7-2 FINS Frames FINS Command Frame Format FINS Response Frame Format FINS Header Information ICF (Information Control Field) 7-3 FINS/UDP Method 7-3-1 Overview FINS/UDP Features 164 FINS/UDP Frame Format UDP Port Numbers for FINS/UDP 165 Procedure for Using FINS/UDP 7-3-2 Sending Commands from a Host Computer 167 FINS/UDP Sample Program Sample Program Page Page 171 7-4 FINS/TCP Method 7-4-1 Overview FINS/TCP Features 172 FINS/TCP Frame Format TCP Port Number for FINS/TCP Connection Numbers 173 FINS/TCP Communications Procedure 174 Automatic Allocation of FINS Node Addresses Page 176 Procedure for Using FINS/TCP 177 7-4-2 FINS/TCP Mode Specifications FINS/TCP Headers Page Page 180 Connection Sequence Page Page Page 7-4-3 Sending Commands from a Host Computer 185 FINS/TCP Sample Program Sample Program Page Page Page Page Page 192 7-5 Maximum Transmission Delays: Writing/Reading to CPU Unit Write Command Delay Time 193 Read Command Delay Time 194 Example Calculations Appendix A Ethernet Network Parameters Page Appendix B Buffer Configuration Network Memory Appendix C TCP Status Transitions Page Appendix D ASCII Characters Page Appendix E Page Appendix F Inspections Items Inspection Interval Inspection Items Page Index Numerics A B C D E F G H I L M N O P Q R S T U W Page 215 Revision History A manual revision code appears as a suffix to the catalog number on the front cover of the manual. Cat. No. W421-E1-03 Revision code