Page 1
Cat.No. W343–E1–1 SYSMAC CS1 Series CS1W-ETN01 Ethernet Unit OPERATION MANUAL...
Page 2
CS1W-ETN01 Ethernet Unit Operation Manual Produced February 1999 Router Host computer...
Page 3
OMRON. No patent liability is assumed with respect to the use of the information contained herein. Moreover, because OMRON is constantly striving to improve its high-quality products, the information contained in this manual is subject to change without notice.
TABLE OF CONTENTS PRECAUTIONS ....... . . xiii 1 Intended Audience .
Page 5
TABLE OF CONTENTS SECTION 5 FINS Communications ......Overview of FINS Communications ......... Procedure Before Using FINS Communications .
Page 6
TABLE OF CONTENTS Appendices A Network Installation ............B Ethernet Network Parameters .
Page 7
About this Manual: This manual describes the installation and operation of the SYSMAC CS1-series CS1W-ETN01 Ethernet System and includes the sections described on the next page. An Ethernet Unit is classified and treated as a CPU Bus Unit in PC processing.
Page 8
About this Manual, Continued This manual contains the following sections. Section 1 introduces the overall structure of an Ethernet network, outlines the features of the Ethernet Unit, describes the communications protocols used by an Ethernet network, and provides basic precau- tions for use of an Ethernet network.
Page 9
PRECAUTIONS This section provides general precautions for using the CS1-series Programmable Controllers (PCs) and related devices. The information contained in this section is important for the safe and reliable application of Programmable Control- lers. You must read this section and understand the information contained before attempting to set up or operate a PC system.
It is extremely important that a PC and all PC Units be used for the specified purpose and under the specified conditions, especially in applications that can directly or indirectly affect human life. You must consult with your OMRON representative before applying a PC System to the above-mentioned applications.
Application Precautions Operating Environment Precautions Caution Do not operate the control system in the following places: • Locations subject to direct sunlight. • Locations subject to temperatures or humidity outside the range specified in the specifications. • Locations subject to condensation as the result of severe changes in tempera- ture.
Page 12
Application Precautions • Interlock circuits, limit circuits, and similar safety measures in external circuits (i.e., not in the Programmable Controller) must be provided by the customer. • Always use the power supply voltages specified in the operation manuals. An incorrect voltage may result in malfunction or burning. •...
EMC-related performance of the OMRON devices that comply with EC Direc- tives will vary depending on the configuration, wiring, and other conditions of the equipment or control panel on which the OMRON devices are installed. The cus- tomer must, therefore, perform the final check to confirm that devices and the overall machine conform to EMC standards.
SECTION 1 Features and System Configuration This section introduces the overall structure of an Ethernet network, outlines the features of the Ethernet Unit, describes the communications protocols used by an Ethernet network, and provides basic precautions for use of an Ethernet network. Features .
The Ethernet Unit also supports FINS message communications, OMRON’s Communications standard communications service, so other OMRON PCs can be accessed by using SEND(090), RECV(098), and CMND(490) instructions in ladder pro- grams. In addition, the FINS gateway function can be used to allow access to other PCs on not only the same Ethernet network but also on other networks such as Controller Link and SYSMAC Link.
System Configuration Section System Configuration 1-2-1 Device Configuration Workstation or personal computer CX-Programmer Ethernet (10 Mbps) 500 m/segment max. Terminator Between nodes: 10BASE5 coaxial cable Terminator Integral multiples of 2.5 m (or 10BASE-T twisted-pair cable) Ground Transceiver 50 m max. CS1 Ethernet Unit CS1-series CVM1/CV-series...
The basic configuration of an Ethernet System consists of a single coaxial cable together with the transceivers, transceiver cables, nodes, and so on, that are connected to it. In an Ethernet System, this basic configuration is called a “seg- ment.” CS1W-ETN01 Ethernet Unit 24-VDC power supply Transceiver cable (AUI cable) 50 m max.
Related Programming Devices Section 2. A 24-VDC power supply is required even if a 10BASE-T conversion adapter is used. 10BASE-T conversion adapter Related Programming Devices The Ethernet Unit functions as a node on the Ethernet network. The basic set- tings for operation are made in the CPU Bus Unit System Setup in the CS1-se- ries CPU Unit.
Inrush current: 2.5 A max. (when 24-VDC startup time is 5 ms) Permissible voltage fluctuation range: 20.4 VDC to 26.4 VDC (24 VDC –15% to +10%) Recommended power supply: OMRON S82J-series Power supply to transceiver Capacity: 0.4 A at 12 V Voltage fluctuation range: 13.05 VDC to 14.48 VDC...
Software Configuration Section Dimensions (16.5 including cover) (Unit: mm) Software Configuration The software supported by the Ethernet Unit runs in the layers shown in the fol- lowing diagram. The components that form the various layers are defined below the diagram. Memory Card/ CS1-series PC’s CPU EM File Memory...
FINS Factory Interface Network Service: A protocol that sends messages between PCs on any of various OMRON FA networks. The user must provide measures such as retry processing to ensure that transmitted messages arrive at the des- tination node.
IP Addresses Section Class Number of networks Number of hosts Class A Small – 2 max. (16,777,214 max.) Class B Medium – 2 max. (65.534 max.) Class C Large – 2 max. (254 max.) IP addresses are represented by the decimal equivalent of each of the four oc- tets in the 32-bit address, each separated by a period.
Precautions Section All nodes on the network that are going to belong to the same subnetwork must have the same subnet mask. In this case, the following subnet mask values will be used depending on the IP address class. Class Network mask value Class A 255.0.0.0...
SECTION 2 Communications Functions This section provides an overview of the communications functions that can be used with the Ethernet Unit. Communications Functions ..........2-1-1 Ethernet Unit Functions .
Communications Functions Section Communications Functions The following table shows the communications service functions that are avail- able with the Ethernet Unit. Function FINS Socket services FTP server Mail communications Client PC to PC By executing By executing SEND(090), RECV(098) CMND(490) or server or CMND(490) manipulating dedicated...
Page 26
Communications Functions Section 2-1-1 Ethernet Unit Functions Function Contents • A SEND(090), RECV(098), or CMND(490) instruction from the PC’s ladder FINS communications program is used to send a FINS command to a remote node, and a re- sponse is received. •...
(with the FINS gateway function enabled). Refer to FINS Communications To perform operations with Section 5 FINS Communications. an OMRON PC other than sending or receiving data (for example, reading or writing files or changing the operating mode). To perform operations...
Socket Services Section FINS Communications FINS commands can be sent to or received from other PCs or computers on the same Ethernet network by executing SEND(090), RECV(098), or CMND(490) instructions in the ladder-diagram program. This enables control operations such as the reading and writing of I/O memory between PCs, mode changes, and file memory operations.
Page 29
Socket Services Section There is no need to execute the CMND(490) instruction or to monitor the completion timing and actual processing of the instruction, so this helps to sim- plify ladder programming. A total of eight ports (UDP and TCP combined) can be used for socket services. UNIX computer, etc.
Mail Section FTP Server The Ethernet Unit has a built-in FTP server function, so other computers on the Ethernet can read or write individual files in a Memory Card mounted to the CPU Unit or in EM file memory. This allows files to be exchanged between the host computer and the PC, with the host computer functioning as an FTP client and the PC as an FTP server.
Page 31
Mail Section 4. Mail delivery is not guaranteed. Depending on factors such as the condition of the network, mail that has been sent may not arrive at its destination.
SECTION 3 Installation and Initial Setup This section explains how to install the Ethernet Unit and make the initial settings required for operation. Before Operation ............3-1-1 Automatic Address Generation .
Before Operation Section Before Operation In order to connect the Ethernet Unit to an Ethernet network, it is necessary to set the IP address. This section explains the process of address conversion, which is required information for determining the Ethernet Unit’s IP address. Address Conversion (for When using the FINS communication service, it is necessary to specify the FINS Communications...
Page 34
Before Operation Section Note The rightmost byte of the host number becomes the FINS node number, and the rest of the host number becomes all zeroes. Example 1 Local IP address: 130.25.36.8 Subnet mask: 255.255.0.0 Remote FINS node number: Host number Remote IP address 130.25.0.5 Becomes 0.
Overview of Startup Procedure Section 1, 2, 3... 1. Not more than 32 pairs of node number and IP addresses can be registered in the IP address table, so that limits the number of nodes, including the local node, to 32. 2.
Unit Components Section 10. Make the settings in the System Setup using the CX-Programmer. (Create the IP address table and IP router table.) Refer to 3-9 System Setup, 3-10 Creating an IP Address Table, and 3-11 Creating an IP Router Table. This step is required only in the following cases: •...
Unit Components Section Each communications device connected to the Ethernet network is allocated a unique Ethernet address. For the Ethernet Unit, this Ethernet address is shown on the right side of the Unit as a 12-digit hexadecimal number. Ethernet address (12 digits) Note The Ethernet address can also be checked using the FINS command, CON- TROLLER DATA READ.
Switch Settings Section Switch Settings This section explains how to set the various switches on the Ethernet Unit. 3-4-1 Setting the Unit Number The unit number is used to identify individual CPU Bus Units when more than one CPU Bus Unit is mounted to the same PC. Use a small screwdriver to make the setting, taking care not to damage the rotary switch.
Switch Settings Section numbers. Use the Node Number Switches to set the node number between 01 and 7E hexadecimal (1 to 126 decimal). Do not set a number that has already been set for another node on the same network. Setting range: 01 to 7E (1 to 126 decimal) The left switch sets the sixteens digit (most significant digit) and the right switch...
Mounting to a Backplane Section Note 1. When using the automatic generation method for address conversion, set switches 7 and 8 to the same values as the node number setting, and set the rest of the host number to zeroes. For details regarding the host number, refer to 1-7 IP Addresses.
Connecting to the Network Section Connecting to the Network 3-6-1 Ethernet Network Installation When installing an Ethernet network, be sure to take all appropriate safety mea- sures and to follow the applicable standards (ISO 8802-3). You must obtain a copy of these specifications and be sure you understand them before attempting to install an Ethernet System.
Connecting to the Network Section 4. Connect the transceiver cable to the Ethernet Unit connector. The Ethernet Unit connector has a slide latch conforming to IEEE802.3 specifications that serves as a lock mechanism. To connect the transceiver cable, operate the slide latch as described below.
Page 43
Connecting to the Network Section Caution Be sure to turn OFF the power supply to the PC before connecting to the power supply terminal block. Note 1. Do not connect a power supply with a voltage other than 24 VDC. 2.
Page 44
20.4 VDC to 26.4 VDC (24 VDC –15% + 10 %) fluctuation Current consumption 300 mA max. at 24 VDC (per node) Inrush current 2.5 A max. (24 VDC when rise time is 5 ms) OMRON’s S82J Series is recommended for the power supply.
Creating an I/O Table Section Note 1. Use a power supply that meets these specifications. 2. If the power supply is separate from a node, make sure that these specifica- tions are met at the node’s terminal block. 3. Turn ON the Unit’s power supply either before or at the same time as the CPU Unit’s power supply.
Creating Routing Tables Section Use the following procedure to create the I/O table. Initial screen SHIFT 000000 I/O TBL ? 000000 I/O TBL WRIT ???? WRITE Password 000000CPU BU ST? 0:CLR 1:KEEP (Save or clear the CPU Bus Unit System Setup.) 000000 I/O TBL WRIT OK Creating Routing Tables...
Page 47
Creating Routing Tables Section Local Network Table The local network table is a table describing the correspondences among unit numbers of the Communications Units and Boards mounted to each node (PC or FA Computer). Unit #04 Example Unit #05 Local Network Table Unit #06 Unit #07 Local network...
Creating Routing Tables Section 3-8-2 Connecting and Using a Peripheral Device for the PC Routing tables must be created by a CX-Programmer connected to the PC. (They cannot be created using a Programming Console.) For details on how to connect and use a CX-Programmer, refer to the CX-Programmer User’s Manual.
Page 49
Creating Routing Tables Section Example 2: Three Interconnected Networks This example shows the relay network table settings for three different intercon- nected networks. Relay Network Table Relay Node network network PC #1 Node #a Network #A PC #2 Node #b Node #c PC #3 Network #B...
Page 50
Creating Routing Tables Section Example 3: All Nodes This example uses the following configuration to show the routing tables for all nodes. Unit #5 Node #6 Network #10 Unit #4 Unit #3 Node #5 Node #4 Unit #7 Unit #2 Node #15 Node #3 Network #30...
System Setup Section System Setup The settings for the Ethernet Unit’s basic and special functions are made in the CPU Bus Unit System Setup. These settings, and the situations in which the set- tings must be made, are shown in the following table. For details on how to make the settings, refer to 4-2 CPU Bus Unit System Setup.
Checking Communications Section 3-12 3-10 Creating an IP Address Table An IP address table is a table of correspondences between node numbers and IP addresses, and it is used for finding IP addresses from FINS node numbers. It is necessary to register an IP address table when using the IP address table method as the method for address conversion.
Checking settings such as as an Ethernet node. FINS addresses for using the FINS communications service. Test objects Ethernet Units and OMRON Units and Ethernet devices that Boards that support FINS support PING. communications service internode testing. Network classification Within Ethernet networks...
SECTION 4 System Setup and Memory Allocations This section explains the System Setup and the words allocated in the CIO Area and the DM Area for Ethernet Units. Allocated Words ............CPU Bus Unit System Setup .
Allocated Words Section Allocated Words The Ethernet Unit is allocated words in the the following three areas for reading settings and status. • System Setup for CPU Bus Units Stores initial setup for the Ethernet node. • Allocated Words in the CIO Area Stores software switches and status information for functions.
CPU Bus Unit System Setup Section CIO Area Allocations Unit No. Allocated words Unit No. Allocated words (decimal) (decimal) 0 (0) CIO 1500 to CIO 1524 8 (8) CIO 1700 to CIO 1724 1 (1) CIO 1525 to CIO 1549 9 (9) CIO 1725 to CIO 1749 2 (2)
CPU Bus Unit System Setup Section 4-2-1 Settings Item CX-Programmer default Broadcast setting All 1s (4.3BSD specifications) Address conversion method Automatic address generation FINS UDP port number 9600 Subnet mask 0.0.0.0 (A value corresponding to the IP address is used.) FTP login name Not set.
Page 58
CPU Bus Unit System Setup Section FINS messages addressed to FINS node number 23 are sent to the node with IP address 150.31.3.68. Automatic Address Generation and IP Address Table With the combined method, first the IP address table is referenced. If the appli- cable node is not registered, then the automatic address generation method is used.
CPU Bus Unit System Setup Section IP Router Table The IP router table sets how the Ethernet Unit communicates via the IP router with nodes on other IP network segments. This table cannot be edited when the IP address FINS node number automatic generation method is used for address conversion.
Page 60
CPU Bus Unit System Setup Section Error Log in User Mail Specify whether or not all error log information is to be added to mail contents when mail is sent by turning ON the Mail Send Switch in the CPU Unit’s I/O Memory.
Page 61
CPU Bus Unit System Setup Section Sending Status Information for Errors Specify whether or not status information is to be added to mail contents when mail is sent whenever an error is registered to the error log. Setting Meaning Not selected (Default) Status information not included in mail when error is registered to error log.
Page 62
CPU Bus Unit System Setup Section Periodic Mail for Status Information Specify whether or not status information is to be added to mail contents when mail is sent periodically. Setting Meaning Not selected (Default) Status information not included in periodic mail. Selected Status information included in periodic mail.
CIO Area Allocations Section CIO Area Allocations The various kinds of data are stored in the offset positions shown in the following diagram, from the beginning word in the area for each Unit. The beginning word n is calculated by the following equation: Beginning word n = CIO 1500 + (25 x unit number) Offset Related communications services...
Page 64
CIO Area Allocations Section Unit Control Switches (CPU Unit to Ethernet Unit) 15 14 13 12 11 10 Internode Test Start Switch Socket Force-close Switch Mail Send Switch Switch Status Manipulated Unit operation Reference (Not used.) Internode Test Start Switch User Executes internode test while ON.
Page 65
CIO Area Allocations Section Status of UDP/TCP Sockets 1 to 8 (Ethernet Unit to CPU Unit) 15 14 13 12 11 10 n+1 to n+16 Opening Flag Receiving Flag Results Storage Error Flag Sending Flag TCP/UDP Open Flag Closing Flag Flag Status Manipulated...
Page 66
CIO Area Allocations Section Sending Flag (Bit 2) Turns ON when a send request is received either by control switch manipulation or the CMND(490) instruction, and turns OFF again when the send processing has been completed. When CMND(490) is used, the Results Storage Error Flag (bit 14) will turn ON at the same time as the Sending Flag turns OFF if there is an error in the Results Storage Area designation.
Page 67
CIO Area Allocations Section Error Status (Ethernet The status of errors that occur at the Ethernet Unit is reflected as shown in the Unit to CPU Unit) following diagram. 15 14 13 12 11 10 n+18 Bit 01: Transceiver echo test error Bit 02: IP address error Bit 03: IP address table error Bit 04: IP router table error...
Page 68
CIO Area Allocations Section Socket Service Request When a socket service request is executed by control switch manipulation, it is Switches 1 to 8 (CPU Unit the following bits that are manipulated. For details, refer to 6-2 Using Socket Ser- to Ethernet Unit) vices with Socket Service Request Switches.
DM Area Allocations Section DM Area Allocations The various kinds of data are stored in the offset positions shown in the following diagram, from the beginning word in the area for each Unit. The beginning word m is calculated by the following equation: Beginning word m = D30000 + (100 x unit number) Offset Related communications services...
Page 70
DM Area Allocations Section Internode Test Response Monitoring Time (CPU Unit to Ethernet Unit) 15 14 13 12 11 10 Response monitoring time (0000 to FFFF Hex) Specify, in hexadecimal, the amount of time to wait for the internode test re- sponse.
Page 71
DM Area Allocations Section Number of Internode Test Timeout Errors (Ethernet Unit to CPU Unit) 15 14 13 12 11 10 Number of timeout errors (0000 to FFFF) The number of timeout errors that have occurred in the internode test is stored in this word in hexadecimal.
Page 72
DM Area Allocations Section Mail Status (Ethernet Unit to CPU Unit) 15 14 13 12 11 10 m+17 User mail status Periodic mail status Error log mail status The transmission statuses of user mail, periodic mail, and error log mail are stored in this word as shown in the following table.
SECTION 5 FINS Communications This section provides information on communicating on Ethernet Systems and interconnected networks using FINS com- mands. The information provided in the section deals only with FINS communications in reference to Ethernet Units. FINS commands issued from a PC are sent via the SEND(090), RECV(098), and CMND(490) instructions programmed into the user ladder-diagram program.
The FINS communications service is a function for controlling operations such as sending and receiving data, changing modes, and so on, between nodes on OMRON factory automation networks. It provides the following features. • Communications instructions are executed in the user program.
• Units and Boards that support FINS commands return responses automatical- ly, so there is no need for a program at the receiving end. • The FINS communications service is mainly used between OMRON CPU Bus Units, CPU Units, and Support Boards for FA Computers. By correctly setting information such as headers, however, it can also be used from ordinary Ether- net communications devices.
Procedure Before Using FINS Communications Section Procedure Before Using FINS Communications Start Determine the address conversion method for the destination IP address. IP Address Table Automatic Generation Combined Method Converted from table of corre- Automatically converted from IP address table is referenced; spondences between FINS node FINS node number.
Sending Commands From a PC Section Sending Commands From a PC FINS commands can be sent from the user’s ladder-diagram program in the PC by using the SEND(090), RECV(098), and CMND(490) instructions. SEND(090): Writes I/O data from the local node to another node. RECV(098): Reads I/O data from another node to the local node.
Page 78
Sending Commands From a PC Section Using SEND(090), RECV(098), and CMND(490) Make the settings shown below when using the SEND(090), RECV(098), and CMND(490) instructions in the user’s ladder-diagram program in the PC. SEND(090) The SEND(090) instruction sends the data in n number of words, starting from the beginning word S at the local node, to the words starting from the beginning word D at the remote destination node (node number N).
Page 79
Sending Commands From a PC Section RECV(098) With the RECV(098) instruction, the data in m number of words, starting from the beginning word S at the remote node (node number M) is received at the words starting from the beginning word D at the local node. Local node Remote node number N Number...
Page 80
Sending Commands From a PC Section CMND(049) The CMND(049) instruction sends n bytes of command data, starting from the beginning word S at the local node, to the node at node number N. the data in m number of words, starting from the beginning word S at the remote node (node number M) is received at the words starting from the beginning word D at the local node.
Page 81
Sending Commands From a PC Section Commands Addressed to CS1-series CPU Units The following table provides a list of FINS commands that can be processed by a CS1-series CPU Unit. For details, refer to the CS1-series CS1G/H-CPUjj-E Programmable Controllers Communications Commands Reference Manual (W342).
Page 82
Sending Commands From a PC Section Usage Name Function Usage Command Name Function code File memory FILE NAME READ Reads file memory data. SINGLE FILE READ Reads a specified length of file data from a specified position within a single file.
Page 83
Sending Commands From a PC Section Writing Programs Programs incorporating the SEND(090), RECV(098), and CMND(490) instruc- tions are generally created using the Communications Port Enabled Flag and the Communications Port Error Flag as input conditions. CS1-series CPU Units have eight communications ports. Only one instruction can be executed at any given port at one time, however, so the program must not overlap the use of any of the ports.
Page 84
Sending Commands From a PC Section Communications Flags The execution status of the SEND(090), RECV(098), and CMND(490) instruc- tions is always reflected by the communications flags (i.e., the Communications Port Enabled Flag and the Communications Port Error Flag). The CS1-series CPU Unit’s communications flags are allocated in the Auxiliary Area as shown in the following table.
Page 85
Sending Commands From a PC Section Communications Port Error Flag and Completion Codes CMND(490) Errors that occur when CMND(490) is used generate a Communications Port Error Flag and are recorded in a communications port completion code only in the following cases: •...
Page 86
Sending Commands From a PC Section 5-3-2 Program Example Execution condition (See note) 000000 A20207 120002 When the Communications Port Enabled Flag for port 7 KEEP is ON, and RECV(098) is not being executed, the send 120000 execution program will start when execution condition CIO 000000 turns ON.
Page 87
Sending Commands From a PC Section (Continued from previous page.) Execution condition (See note) When the Communications Port Enabled Flag for port 7 000001 A20207 120000 is ON, and SEND(090) is not being executed, the trans- KEEP mission execution program will start when execution 120002 condition CIO 000001 turns ON.
Page 88
Sending Commands From a PC Section SEND(090) The transmission delay for the SEND(090) instruction can be calculated using the following equation, which is illustrated in the following diagram. Max. delay =Local node service cycle + local node service processing time + transmission processing time + reception processing time + re- mote node service cycle + remote node service processing time + CPU data set processing time (remote node)
Page 89
Sending Commands From a PC Section RECV(098) The transmission delay for the RECV(098) instruction can be calculated using the following equation, which is illustrated in the following diagram. Max. delay =Local node service cycle + local node service processing time + transmission processing time (command) + reception processing time (command) + remote node service cycle + remote node ser- vice processing time + CPU data read processing time (remote...
Sending Commands From a Host Computer Section Example Calculations The following example shows calculations for receiving 256 words between two PC nodes using RECV(098). The local node’s CPU cycle time is 10 ms, and the remote node’s CPU cycle time is 15 ms. Calculations are shown in the following table.
Sending Commands From a Host Computer Section Example 1: Intranetwork In this example, the host computer and the remote node (Ethernet Unit) are on Addressing the same network. The communications parameters specified from the host computer would be as follows: Destination IP Address: 196.36.32.100 (Ethernet Unit of remote node) UDP port number: FINS UDP port No.
Page 92
Sending Commands From a Host Computer Section FINS Command Frame Configuration Size (bytes) Contents Displays frame information Reserved by system. Permissible number of gateways Destination network address Destination node address FINS header Destination unit address Source network address Source node address Source unit address Service ID Main request code...
Sending Commands From a Host Computer Section DA1 (Destination Node Address) Specifies the number of the node where the command is being sent. This node number is the address used for FINS, and is different from the IP ad- dress used for Ethernet. 00 (Hex): Local PC Unit 01 to 7E (Hex): Destination node number (1 to 126)
Page 94
Sending Commands From a Host Computer Section main(argc,argv) argc; char *argv[]; sockfd; struct sockaddr_in , ws_addr,cv_addr; char fins_cmnd[MAX_MSG],fins_resp[MAX_MSG]; sendlen,recvlen,addrlen; char sid=0; extern recv_fail(); *GENERATE UDP SOCKET* if((sockfd=socket(AF_INET,SOCK_DGRAM,0))<0) err_exit(”can’t open datagram socket”); *ALLOCATE IP ADDRESS AND PORT # TO SOCKET* bzero((char*)&ws_addr,sizeof(ws_addr)); ws_addr.sin_family=AF_INET;...
FINS Server Section Maximum transfer delay time = Host computer communications processing time + (0.011 x 256) + 10 + (256 x 0.02 + 20) = host computer communications processing time + 42 ms FINS Server The following table shows the FINS commands that can be addressed to the Ethernet Units.
SECTION 6 Socket Services This section describes the functionality provided by the Ethernet Unit via the socket services. Overview ............. . . 6-1-1 Socket Service Functions .
Overview Section Overview 6-1-1 Socket Service Functions The socket services allow devices on the Ethernet to send and receive various data using the UDP or TCP protocol. The socket services can be used by CS1-series PCs through the user program by manipulating dedicated bits (called Socket Service Request Switches) or by executing the CMND(490) in- struction.
Overview Section Specific Socket Service Functions The socket service functions listed in the following table can be executed either using Socket Service Request Switches or using CMND(490). Protocol Socket service request Open UDP socket Receive via UDP socket Send via UDP socket Close UDP socket Open TCP socket, passive Open TCP socket, active...
Overview Section Some port numbers over 1024 may be reserved on some workstations (for ex- ample, the X-window server is port #6000). Do not use port numbers that are already reserved for other processes. The setting status of the UNIX workstation port numbers can be checked in /etc/ services.
Page 101
Overview Section Passive OPEN and Active An open command is executed for a node to establish a connection. The open OPEN method differs depending on whether the node is a client or server. A passive open method is used to open the node as a server and the active open method is used to open the node as a client.
Overview Section 6-1-7 Fragmentation of Send Data The Ethernet Unit fragments data for TCP transmission into units of 1,024 bytes and data for UDP transmission into units of 1,472 bytes. TCP requires one reception request to receive each unit of data. UDP, however, restores the origi- nal data before passing it to the user process, allowing all the data in a single transmission to be received with one reception request.
Page 103
Overview Section 4. When the receiving user program sends a request to receive 1,984 bytes of data, Data A and Data B are linked to restore the original data, which is passed to the user program. Sending User Program Ethernet Unit Receiving Node Receiving User Program 1.
Overview Section 6-1-8 Maximum Transmission Delays The transmission delays for socket service is calculated as the sum of the com- munications processing times for both nodes. Transmission delay = Remote node send processing time + Local node re- ceive processing time + Local node send processing time + Remote node receive processing time Calculate the maximum Ethernet Unit transmission delays for sending and re- ceiving using the following formulas.
Page 105
Overview Section • The socket status area in the CIO Area is zeroed when the PC’s operating mode is changed (e.g., from PROGRAM to RUN). The actual Ethernet Unit socket status, however, will remain unchanged after the socket status area is zeroed.
Using Socket Services with Socket Service Request Switches Section • The Ethernet Unit TCP sockets have no KEEP ALIVE function to check that the connection is normal if communications do not occur for a set time period through a communications line for which a connection has been established. The Ethernet Unit’s TCP sockets make no checks to the socket at the other node.
Using Socket Services with Socket Service Request Switches Section After setting the required parameters in a Socket Service Parameter Area in the CPU Bus Unit Area in the DM Area, the Socket Service Request Switches can be used to request opening, sending, receiving, or closing for either the UDP or TCP protocol.
Page 108
Using Socket Services with Socket Service Request Switches Section Parameter Settings The following table shows the parameters that are required for each service and the use of the parameters by the socket service. UDP Socket Services Socket service Parameter No. of Range words (decimal values in paren-...
Page 109
Using Socket Services with Socket Service Request Switches Section Local UDP/TCP Port No. Specify the number of the UDP or TCP port for the socket to use for communica- tions. • Do not specify the port being used as the FINS UDP port (default: 9600) in an open request for a UDP socket.
Using Socket Services with Socket Service Request Switches Section Time Out Time Set the time limit in units of 0.1 s for completion of communications from the time that the Send Request Switch is turned ON. A response code of 0080 Hex (time- out) will be stored if communications time out.
Page 111
Using Socket Services with Socket Service Request Switches Section Response Meaning code 0049 The same UDP port number has been specified more than once (EADDRINUSE). 0081 The specified socket was closed during open processing. UDP Socket Receive Request Response Meaning code 0000 Normal end...
Page 112
Using Socket Services with Socket Service Request Switches Section UDP Socket Close Request Response Meaning code 0000 Normal end 0302 CPU Unit error; cannot execute. 2210 The specified socket is not open. 2211 Unit is busy; cannot execute. 2607 Specified Socket Service Parameter Area is already being used for another socket.
Page 113
Using Socket Services with Socket Service Request Switches Section Response Meaning code 110C Request Switch turned ON during other processing. 220F Specified socket is already open or already processing an open request. 2211 Unit is busy; cannot execute. 2606 Specified socket is already open as UDP socket; cannot open TCP socket.
Page 114
Using Socket Services with Socket Service Request Switches Section Response Meaning code 0042 ICMP data received (EMSGSIZE). (See note.) 0044 ICMP data received (ENOPROTOOPT). (See note.) 0045 Error in communications with remote node (ECONNABORTED). (See note.) 004B Error in communications with remote node (ECONNRESET). 004E ICMP data received (ENETUNREACH).
Page 115
Using Socket Services with Socket Service Request Switches Section Response Meaning code 0053 Error in communications with remote node (ETIMEDOUT). (See note.) 0081 The specified socket was closed during send processing. Note These response codes will be returned only on large, multilevel networks. TCP Socket Close Request Response Meaning...
Page 116
Using Socket Services with Socket Service Request Switches Section Switch Status Manipulated Unit operation UDP Open User UDP socket opened when switch is turned ON. Request Switch Unit Unit turns OFF switch when open processing has been completed (i.e., when a connection has been made). TCP Passive Open User Passive TCP socket opened when switch is turned ON.
Using Socket Services with Socket Service Request Switches Section 6-2-4 UDP/TCP Socket Status The status of the UDP and TCP sockets is provided in the Socket Status Words shown in the following diagram. There is a status word for each socket for both UDP and TCP.
Using Socket Services with Socket Service Request Switches Section DM Area: D30000 + (100 x unit number) +9 to +16. Refer to TCP Socket Con- nection Status on page 58 and to Appendix D TCP Status Transitions for details. 6-2-5 Application Procedure Procedure 1, 2, 3...
Using Socket Services with Socket Service Request Switches Section Area until a socket is opened again. Writing data to the DM Area, however, is not synced with writing to the Socket Status Areas, and timing may vary somewhat. 15 14 13 12 11 –...
Using Socket Services with Socket Service Request Switches Section The flow is similar for other socket services. Replace the names of the appropri- ate flags in the flowchart to adapt it to other socket services. Start UDP Open Program Flow Error Evaluation Check Socket Open Flag.
Page 121
Using Socket Services with Socket Service Request Switches Section Close Request Switch The processing results are stored as the response code when the Close Re- quest Switch is used. There will always be one PC cycle time between turning OFF the Request Switch for the canceled process and turning of the Close Re- quest Switch, allowing time for the response code to be read.
Using Socket Services with Socket Service Request Switches Section 6-2-8 TCP/IP Communications Programming Example The following programming example illustrates transferring 100 bytes of data between an Ethernet Unit and a host computer using TCP/IP communications. System Configuration The programming example uses the following system configuration. For the TCP connection, the Ethernet Unit uses a passive open and the host computer uses an active open.
Page 123
Using Socket Services with Socket Service Request Switches Section Program Memory Map The send and receive data and bits (flags) used by the program are shown in the following diagram. DM Area Send data, 100 bytes (100 = 0064 Hex) Receive data, 100 bytes (100 = 0064 Hex) CIO Area The following bits and flags are used to control CMND(490) execution.
Page 124
Using Socket Services with Socket Service Request Switches Section Programming Example 000000 TCP Passive Open @RSET When the TCP Open Bit (CIO 000000) turns ON, the TCP 000100 Open Error Flag (CIO 000100) is turned OFF and the TCP Opening Flag (CIO 000200) is turned ON to initialize pro- @SET cessing.
Page 125
Using Socket Services with Socket Service Request Switches Section Continued from previous page. 000001 000201 151905 TCP Send <>(305) When the TCP Send Bit (CIO 000002) turns ON, the TCP 000101 Send Error Flag (CIO 000102) is turned OFF and the TCP D30027 Sending Flag (CIO 000202) is turned ON to initialize pro- #0000...
Using Socket Services with Socket Service Request Switches Section Continued from previous page. 000003 000203 When the TCP Receiving Flag (CIO 000203) turns ON, MOV(21) the following parameters are written to the parameter #0001 area for socket number 1. D30018: 0001 Hex = UDP/TCP socket No. 1 D30018 D30023: 0064 Hex = No.
Page 127
Using Socket Services with Socket Service Request Switches Section • CIO 000003 is turned ON to request receiving data from the Ethernet Unit. The data that is received (100 bytes) is stored beginning at D01000. • One of the bits between CIO 000100 and CIO 000103 will turn ON if an error occurs.
Page 128
Using Socket Services with Socket Service Request Switches Section Programming Example 000000 UDP Open @RSET When the UDP Open Bit (CIO 000000) turns ON, the UDP 000100 Open Error Flag (CIO 000100) is turned OFF and the UDP Opening Flag (CIO 000200) is turned ON to initialize pro- @SET cessing.
Page 129
Using Socket Services with Socket Service Request Switches Section Continued from previous page. 000002 000202 MOV(21) When the UDP Sending Flag (CIO 000202) turns ON, the #0001 following parameters are written to the parameter area for socket number 1. D30018 D30018: 0001 Hex = UDP/TCP socket No.
Page 130
Using Socket Services with Socket Service Request Switches Section Continued from previous page. 000003 000203 When the UDP Receiving Flag (CIO 000203) turns ON, MOV(21) the following parameters are written to the parameter area #0001 for socket number 1. D30018: 0001 Hex = UDP/TCP socket No. 1 D30018 D30023: 0064 Hex = No.
Using Socket Services with CMND(490) Section Using Socket Services with CMND(490) Service request commands can be sent to the Ethernet Unit by executing the CMND(490) instruction in the ladder diagram. The CS1 Ethernet Unit supports the same functionality as the CV-series Ethernet Unit, so heritage programs can be easily corrected and reused.
Using Socket Services with CMND(490) Section 6-3-1 UDP/TCP Socket Status The status of the UDP and TCP sockets is provided in the Socket Status Words shown in the following diagram. There is a status word for each socket for both UDP and TCP.
Page 133
Using Socket Services with CMND(490) Section Flag Status Manipulated Unit operation Socket Open Flag Unit Turns ON when open processing has been completed (i.e., when a connection is made). Turns OFF when close processing has been completed. (Will remain OFF when open processing ends in an error.) Note The TCP socket connection status is also provided as codes in the following words of the words allocated to the Ethernet Unit in the CPU Bus Unit Area in the DM Area: D30000 + (100 x unit number) +9 to +16.
Page 134
Using Socket Services with CMND(490) Section 2. CMND(490) ends normally when the socket service request command is re- ceived and a response is returned (response code: 0000). Ethernet Unit User program Response CMND 3. The Ethernet Unit starts the process requested by the parameters in the socket service request command.
Using Socket Services with CMND(490) Section 6-3-2 Socket Services and Socket Status When using socket services, it is important to consider the timing of the status changes in the socket status area. The diagram below shows a program flow- chart for opening UDP. Program flow is similar for other socket services.
Using Socket Services with CMND(490) Section 6-3-3 Communications Timing Chart The timing of the status changes of the bits in the socket status area and the Port Enabled Flag is shown in the following diagram. Port Enabled Flag Opening Flag Receiving Flag Sending Flag Closing Flag...
Page 137
Using Socket Services with CMND(490) Section SEND REQUEST Port Enabled Flag Running Running Error response code Normal response code CMND(490) response code Send Flag Opening Flag Results storage area Store normal response code SEND REQUEST Error SEND REQUEST Send complete command received command received (normal end)
Using Socket Services with CMND(490) Section shown in the diagram also applies if a CLOSE REQUEST command is executed during OPEN REQUEST command execution, with the exception of the status of the Opening Flag. 6-3-5 TCP/IP Communications Programming Example The following programming example illustrates transferring 100 bytes of data between an Ethernet Unit and a host computer using TCP/IP communications.
Page 139
Using Socket Services with CMND(490) Section • One of the bits between CIO 000100 and CIO 000103 will turn ON if an error occurs. Refer to 6-2-2 Response Codes for information on errors. The follow- ing areas can be used to access details about errors: CMND(490) response codes Response codes in results storage area Network Communications Error Flags (A21900 to A21907)
Page 140
Using Socket Services with CMND(490) Section CMND(490) control data for TCP SEND REQUEST D00020 006EH 0004H 0001H 0110H 0000H 0032H Number bytes to receive: 4 bytes Number of bytes to send: 110 (006E ) bytes Command format = 10 bytes + 100 bytes send data CMND(490) control data for TCP RECEIVE REQUEST D00030 000CH 0004H 0001H 0110H 0000H 0032H...
Page 141
Using Socket Services with CMND(490) Section TCP CLOSE REQUEST response D01040 sponse 2714H code TCP CLOSE REQUEST results storage area D01050 sponse code D02000 TCP SEND REQUEST command data Send data: 100 bytes (0064 2713H 0001H 820BH C200H 0064H No. of send bytes: 100 bytes (0064 Results storage area: set to D03010 (0BC2 TCP socket number Command code...
Page 142
Using Socket Services with CMND(490) Section CIO Area The following bits and flags are used to control CMND(490) execution. The bits in CIO 0000 are used to signal execution, the bits in CIO 0001 are used to signal errors, and the bits in CIO 0002 are used to control the program so that the instruction is executed only once.
Page 143
Using Socket Services with CMND(490) Section Programming Example 000000 @RSET TCP Passive Open When the TCP Open Bit (CIO 000000) turns ON, the TCP 000100 Open Error Flag (CIO 000100) is turned OFF and the TCP Opening Flag (CIO 000200) is turned ON to initialize pro- cessing.
Page 144
Using Socket Services with CMND(490) Section Continued from previous page. 000002 TCP Send @RSET When the TCP Send Bit (CIO 000002) turns ON, the 000102 TCP Send Error Flag (CIO 000102) is turned OFF and the TCP Sending Flag (CIO 000202) is turned ON to initialize processing.
Using Socket Services with CMND(490) Section 6-3-6 UDP/IP Communications Programming Example The following programming example illustrates transferring 100 bytes of data between an Ethernet Unit and a host computer using UDP/IP communications. System Configuration The system configuration for the program example and the Ethernet Unit system setup are shown below.
Page 146
Using Socket Services with CMND(490) Section D00010 CMND(490) control data for UDP CLOSE REQUEST 0008H 0004H 0001H 0110H 0000H 0032H Number bytes to receive: 4 bytes Number of bytes to send: 8 bytes CMND(490) control data for UDP SEND REQUEST D00020 0074H 0004H 0001H 0110H 0000H 0032H Number bytes to receive: 4 bytes...
Page 147
Using Socket Services with CMND(490) Section UDP CLOSE REQUEST response D01040 sponse 2704H code UDP CLOSE REQUEST results storage area D01050 sponse code D02000 UDP SEND REQUEST command data 2703H 0001H 820BH C200H C424H 2037H 1000H 0064H No. of send bytes: 100 bytes (0064 Remote port: Port #4096 (1000 Remote address: 196.36.32.55 Results storage area: Set to D03010 (0BC2...
Page 148
Using Socket Services with CMND(490) Section CIO Area The following bits and flags are used to control CMND(490) execution. The bits in CIO 0000 are used to signal execution, the bits in CIO 0001 are used to signal errors, and the bits in CIO 0002 are used to control the program so that the instruction is executed only once.
Page 149
Using Socket Services with CMND(490) Section Programming Example 000000 @RSET UDP Open When the UDP Open Bit (CIO 000000) turns ON, the 000100 UDP Open Error Flag (CIO 000100) is turned OFF and the UDP Opening Flag (CIO 000200) is turned ON to initialize processing.
Page 150
Using Socket Services with CMND(490) Section Continued from previous page. 000002 UDP Send @RSET When the UDP Send Bit (CIO 000002) turns ON, the UDP 000102 Send Error Flag (CIO 000102) is turned OFF and the UDP Sending Flag (CIO 000202) is turned ON to initialize processing.
FTP server is in use, a message will be re- turned and connection will be refused. Login Messages Status Message Normal 220 xxx.xx.xx.xx CS1W-ETN01 FTP server connection (FTP Version y–yy) ready. xxx.xx.xx.xx: IP address of Ethernet Unit y.yy: Firmware version of Ethernet Unit FTP server 221 FTP server busy, Goodbye.
Using File Memory Section Setting Login Names and Passwords The default FTP login name is “CONFIDENTIAL” and no password is required. Login is completed by typing only “CONFIDENTIAL”. A different login name and a password can be set as required using the CPU Bus Unit Setup. Setting Restrictions The following restrictions apply to login names and passwords.
Page 154
Using File Memory Section Note The HMC-AP001 PC Card Adapter can be used to mount a Memory Card in a PC card slot on a computer. File Types The MS-DOS file format is used, allowing the files to be handled as normal files on a Windows-based computer.
Page 155
Using File Memory Section File Names Handled by The files described in the following table can be read or written by the CPU Unit. CPU Unit File type File name Extension Contents Description • Contains word (16-bit) data from a starting Data file ******** .IOM...
Page 156
Using File Memory Section Data File Format The format of data files (files with .IOM extensions) is shown in the following dia- gram. Byte position from the beginning of the file Reserved (48 bytes) Data Set the reserved bytes to all zeros (00 Hex). Writing Data Files via In this example, the put command (see page 148) is used to write the following data to a file called DMDATA.IOM on a Memory Card, and then the READ DATA...
FTP Server Application Example Section FTP Server Application Example The following procedure shows how to use the FTP server by connection with the default login name, CONFIDENTIAL. No password is required. Note The login name and a password must be set in the CPU Bus Setup for the Ether- net Unit in the CPU Unit to use any login name other than CONFIDENTIAL.
Using FTP Commands Section Note 1. The current status of the FTP server can be obtained from the service status in the words allocated to the Ethernet Unit in the CPU Bus Unit Area in the CIO Area. The first word allocated to the Ethernet Unit is n and is computed as follows: n = 1500 + (25 x unit number) FTP Status Flag...
Page 159
Using FTP Commands Section • The parent directory is the directory one above the working directory. 7-5-2 Using the Commands open Format open [IP_address or host_name_of_FTP_server] Function Connects the FTP server. Normally when the FTP client is booted, the FTP serv- er IP address is specified to execute this command automatically.
Page 160
Using FTP Commands Section rmdir Format rmdir DIRECTORY_NAME Function Deletes the directory of the specified name from the remote host (Memory Card or EM File Memory). The directory must be empty to delete it. An error will occur if the specified directory does not exist or is empty. Format Function Displays the remote host’s (Ethernet Unit) current work directory.
Page 161
Using FTP Commands Section Function Transfers the specified local file to the remote host (Memory Card or EM File Memory). A destination file name can be used to specify the name the file is stored under in the Memory Card or EM File Memory. Any existing file with the same name in the remote host (Memory Card or EM File Memory) will be overwritten by the contents of the transferred file.
Page 162
Using FTP Commands Section 7-5-3 Error Messages and FTP Status Error Messages The error messages returned by the Ethernet Unit are listed in the following table. Message Meaning PPP is a directory. The path name indicated at PPP is a directory. PPP is not a directory.
Page 163
Using FTP Commands Section PPP: Path name XXX: IP address Port number FINS error code Socket error code Checking FTP Status Note 1. File operations for files on the Memory Card are performed during FTP com- munications. Do not remove the Memory Card or turn OFF power to the PC while FTP is being used.
UNIX Application Example Section UNIX Application Example The following procedure provides an example of FTP operations from a UNIX workstation. In this example, the following assumptions are made. • The IP address of the Ethernet Unit is registered in /etc/hosts on the worksta- tion as “cs1”.
Page 165
UNIX Application Example Section 5. Change data type to binary. Binary data type set. 6. Transfer the file RESULT.IOM to the workstation. File read. 7. Write the file PLAN.IOM to the Memory Card. File written 8. End FTP. FTP ended.
Overview of Mail Function Section Overview of Mail Function The mail function can be used to send user-created information, error log infor- mation, and status information as e-mail to an address set in the CPU Bus Unit System Setup. Mail can be triggered in any of the following ways: •...
Body Status information (optional) Header The following header information is attached. • Subject: OMRON SYSMAC CS1 Ethernet Unit Mail Service • Content-Type: text/plain;charset=US-ASCII • Content-Transfer-Encoding: 7 bit Ethernet Unit Information The following Ethernet Unit information is always attached to the mail.
Overview of Mail Function Section • IP address (decimal notation) • Subnet mask (decimal notation) • ID address conversion method Optional Information The optional information that can be sent is shown in the following table. Differ- ent information can be selected with each mail trigger, and it is also possible to make multiple selections.
Overview of Mail Function Section If a transmission is restarted while the mail processing is still in progress, it will be invalid. After the transmission has been completed, the Ethernet Unit will auto- matically turn the switch OFF again. Once the switch has been turned OFF, another mail message can be sent.
Mail Example Section Sending Mail The procedure for sending mail is as follows: 1, 2, 3... 1. Make the following settings in the CPU Bus Unit System Setup. • Mail send information • Mail timing • User-created mail data address •...
Page 172
Mail Example Section 2. Turn ON the Mail Send Switch in the CIO Area words allocated to the CPU Bus Unit. n = CIO 1500 + 25 x unit number) Mail Send Switch For Unit #5, for example, the Mail Send Switch address is CIO 162503. The status, such as mail being processed, and so on, is reflected in the User Mail Status Area in the DM Area words allocated to the CPU Bus Unit.
SECTION 9 Testing Communications This section describes functions that allow you to test communications. Communications Testing Functions ......... . . PING Command .
PING Command Section Communications Testing Functions The Ethernet Unit provides two functions that allow communications with other node to be tested. PING Command The PING command is a common way to perform echoback tests on Ethernet networks. The PING command can be executed to see if nodes are physically connected properly and to be sure that IP address are set for the correct Ether- net nodes.
Internode Test Section The destination is specified by its IP address or host name. If the host name is used, the host name must be defined in file /etc/hosts. Note The PING command is not supported by some host computers. Application Examples These examples show sending the PING command to the node at IP address 130.25.36.8.
Page 176
Internode Test Section 4. Turn OFF the Internode Test Start Switch allocated to the Ethernet Unit in the CPU Bus Unit Area to stop the test. Note 1. The test parameters are effected as soon as they are set or changed. It is not necessary to reboot or restart.
Page 177
Internode Test Section Internode test run status is shown on the TS indicator on the Unit’s front panel. TS indicator Run status Internode test running Not lit Internode test stopped 9-3-2 Checking Results The results of the internode test are stored in the fourth through ninth words of the portion of the CPU Bus Unit Area allocated to the Ethernet Unit.
Page 178
Internode Test Section Note 1. The contents of the test status area and test runs/errors area are maintained until the internode test is run again. 2. When the number of tests counts to the maximum value (FFFF), subse- quent internode test runs are counted from 0. However, the maximum value is maintained and further errors are not counted when the number of errors reaches the maximum value.
SECTION 10 Troubleshooting This section describes information and procedures that can be used to troubleshoot problems that sometimes occur with Ethernet Unit and Ethernet communications. The Ethernet Unit makes up part of a network. Repair a defective Ethernet Unit as soon as possible as it can have a negative effect on the entire network.
Troubleshooting with Indicators Section 10-1 10-1 Troubleshooting with Indicators The indicators on the Ethernet Unit can be used to troubleshoot some error. The probable cause and correction for errors that can be determined from the RUN, ERC, and ERH indicators are listed in the following table. Probably cause Correction Not lit...
Error Log Section 10-3 10-2 Error Status The Ethernet Unit will output error status to the following word in the CIO Area of the CPU Unit. This information can be used in troubleshooting errors. Word = CIO 1500 + (25 x unit number) +18 15 14 13 12 11 10 Transceiver echo test error IP address setting error...
Error Log Error Codes Section 10-4 • Main error code (See table later in this section.) • Detailed error code (See table later in this section.) • Time stamp (from the clock in the CPU Unit) Error Log Location When an error is detected, the error codes and time stamp are recorded in the error log in RAM inside the Ethernet Unit.
Page 183
Error Log Error Codes Section 10-4 Error Error Meaning Meaning Detailed error code Correction Correction code code PROM PROM 1st byte 2nd byte 0103 Resend count exceeded (send Commands Check transceiver at remote failed) Bit 15: node. Bits 08 to 14: SNA 0105 Node address setting error (send Set the IP address correctly.
Troubleshooting Procedures Section 10-5 Error Error Meaning Meaning Detailed error code Correction Correction code code PROM PROM 1st byte 2nd byte 0300 Parameter error; packet Commands Check the command format and discarded Bit 15: set the correct command data. Bits 08 to 14: SNA Bits 00 to 07: SA1 Responses Bit 15:...
Troubleshooting Procedures Section 10-5 6. Do the RUN and ERH indicators not light if another CPU Unit is mounted to the Rack? True ' Replace the Ethernet Unit. 7. Replace the CPU Unit that didn’t work. 8. ERC indicator not lit? True ' Step 14.
Troubleshooting Procedures Section 10-5 4. Are different UDP port numbers set for FINS communications for both the local node and the remote node? True ' Set the same port number for both nodes. 5. Are the local and remote nodes both on the same network, i.e. do they have the same network number in their IP addresses? True ' Step 10.
Page 187
Troubleshooting Procedures Section 10-5 Opening and Closing Refer to General Problems on page 176. Problems Reception Problems 1, 2, 3... 1. Is reception processing finishing? True ' Step 10. 2. Is the remote node not processing to send data? True ' Adjust the remote node to process send data. 3.
Troubleshooting Procedures Section 10-5 10-5-4 TCP Socket Problems Most of the initial steps in these procedures are in question form. Continue in sequence until a “True” answer tells you to jump to a specified step or until you are told to perform a specific action that corrects the problem. If performing the action does not correct the problem, return to the beginning of the procedure and start over.
Troubleshooting Procedures Section 10-5 2. Is the remote node not processing to send data? True ' Adjust the remote node to process send data. 3. Read memory status using the FINS command READ MEMORY STATUS. 4. Is the network memory being used more than 80%? True ' There may be too much load on the Ethernet Unit.
Troubleshooting Procedures Section 10-5 7. Can you display the EM directory using ls from the host computer? True ' End. 8. Have specified banks of the EM Area been converted to EM File Memory? True ' Step 9. 9. Has the EM File Memory been initialized? True ' Replace the CPU Unit.
Troubleshooting Procedures Section 10-5 2. Is the P/S indicator lit? True ' Step 5.. 3. Is a 24-VDC power supply connected? True ' Replace the following items in order to remove the faulty part: Power supply cable, Power Supply Unit, Ethernet Unit. 4.
Page 192
Troubleshooting Procedures Section 10-5 2. Is notification given for user mail? True ' Step 9. 3. Is the user mail send status “7”? True ' Correct mistakes in the Setup Correct the SMTP server address (it is set to 0.0.0.0). Correct the user mail send information settings (the user data, error log information, or status data is not set in the send information).
Page 193
Troubleshooting Procedures Section 10-5 Correct the IP router table. Something is blocking communications or equipment on the com- munications path is not set correctly. 13. Is the destination mail address incorrectly set? True ' Correct the destination mail address in the Setup. (Error mail will be held at the SMTP server if the destination mail address is incorrect.
Troubleshooting with Response Codes Section 10-6 23. End 24. Check the setting of the mail send timing in the Setup. The timing may not be set or may be set longer than intended. 10-6 Troubleshooting with Response Codes You can troubleshoot the errors in FINS communications from the response codes when the SEND(090), RECV(098), or CMND(490) instructions have been used.
Page 195
Troubleshooting with Response Codes Section 10-6 Main code Sub- Probable cause Remedy code Error occurred in the communications Take corrective action, referring to Communications controller, ERC indicator is lit. troubleshooting procedures in this section. controller error CPU Unit error occurred in the PC at the Check CPU Unit indicators at the remote node remote node.
Results Storage Area Response Codes Section 10-7 Main code Sub- Probable cause Remedy code 22: Status error The same socket service is already in Use the socket status flag in PC memory to be (operating mode progress at the specified socket number. sure that socket service has finished before disagreement) starting services again.
Page 197
Results Storage Area Response Codes Section 10-7 Response UNIX error Description Probable remedy code message 000E EFAULT Bad address (copy failed between Close the local socket and try reopening it. kernel and user area) 0011 EEXIST File exists 0016 EINVAL Invalid argument (socket library ar- gument error) 0018...
Page 198
Results Storage Area Response Codes Section 10-7 Response UNIX error Description Probable remedy code message 0053 ETIMEDOUT Connection timed out (TCP timed Check the remote host and communications out) path. 0063 ESELABORT Used for internal Ethernet Unit pro- Close the local socket and try reopening it. cessing 0066 (None)
SECTION 11 FINS Commands Addressed to Ethernet Units This section describes the FINS commands that can be sent to an Ethernet Unit and the responses that are returned by the Ethernet Unit. 11-1 Command Codes and Response Codes ........11-1-1 Command Code List .
Command Codes and Response Codes Section 11-1 11-1 Command Codes and Response Codes 11-1-1 Command Code List The command codes listed in the following table can be sent to an Ethernet Unit. Command code Name Page RESET CONTROLLER DATA READ CONTROLLER STATUS READ INTERNODE ECHO TEST BROADCAST TEST RESULTS READ...
Socket Applications Section 11-2 The MRES codes are shown in the following table along with the results they indicate. Refer to 10-6 Troubleshooting with Response Codes for details on re- sponse codes including the SRES. MRES Execution results Normal completion Local node error Remote node error Unit error (controller error)
Socket Applications Section 11-2 11-2-2 PC Memory Areas The memory areas of the PC that can be specified for results storage when executing commands from the PC are listed in the table below. The Variable type is set in the first byte of the results storage area. The remaining three bytes con- tain the address for communications.
Command/Response Reference Section 11-3 11-3 Command/Response Reference This section describes the FINS commands that can be sent to Ethernet Units and the responses to each command. The command, response, and (where applicable) the results storage blocks are given with the commands in graphic form as shown in the following diagram. If the data is fixed, it is included in the blocks.
Page 204
The Ethernet Unit mode and version are returned as ASCII characters occupy- ing 20 bytes each (i.e., 20 characters each). If all bytes are not used, the remain- ing bytes will be all spaces (ASCII 20 Hex). Example Model: CS1W-ETN01 Version: V1.00 IP Address, Subnet Mask The Ethernet Unit’s IP address and subnet mask are returned as 4 bytes each.
Command/Response Reference Section 11-3 11-3-3 CONTROLLER STATUS READ Reads the controller status. Command Block Command code Response Block 2 bytes 4 bytes 4 bytes 4 bytes 4 bytes 4 bytes Command Response Total Total Total Total Total Error flags code code number of number of...
Command/Response Reference Section 11-3 Total Number of Packets The total number of packets received by the Ethernet Unit is returned. Received (Response) Total Number of Receive The total number of errors detected while the Ethernet Unit was receiving is re- Errors (Response) turned.
Command/Response Reference Section 11-3 11-3-5 BROADCAST TEST RESULTS READ Reads the results (number of times data received) of the broadcast test. Command Block Command code Response Block Command Response Times code code received Parameters Times Received (Response) The number of times the data has been received normally during the broadcast send test is returned as a hexadecimal number.
Command/Response Reference Section 11-3 Number of Records The number of records to read is specified between 0001 and 0040 (1 to 64 deci- (Command, Response) mal) in the command. The response returns the actual number of records read. Maximum Number of Stored The maximum number of records that can be stored in the error log.
Command/Response Reference Section 11-3 11-3-9 UDP OPEN REQUEST Requests processing to open a socket. Command Block Command Results storage area Local UDP code socket port number number Response Block Command Response code code Results Storage Format Results storage response code Parameters UDP Socket Number The UDP socket number to be opened specified as 2 bytes between 1 and 8.
Command/Response Reference Section 11-3 11-3-10 UDP RECEIVE REQUEST Requests that data be sent from a UDP socket. Command Block Command Results storage area Number of Timeout code socket reception value number bytes Response Block Command Response code code Results Storage Format Received bytes Results Source IP...
Command/Response Reference Section 11-3 Response Codes Response code Description 0000 Normal 0105 IP address setting error 0302 CPU Unit error; execution not possible. 1001 Command too large 1002 Command too small 1100 UDP socket number or number of reception bytes is out of range.
Page 212
Command/Response Reference Section 11-3 Destination UDP Port The UDP port number of the node to which data is being sent. Number (Command) Number of Bytes Sent The number of bytes in the data sent by this command. Up to 1,984 bytes can be (Command, Results specified, or up to 1,472 bytes can be specified if the broadcast address is speci- Storage Area)
Command/Response Reference Section 11-3 11-3-12 UDP CLOSE REQUEST Requests processing to close a socket. Command Block Command Results storage area code socket number Response Block Command Response code code Results Storage Format Response code Parameters UDP Socket Number The UDP socket number to be closed specified as 2 bytes between 1 and 8. (Command) Results Storage Area The area in which the results of the command execution are stored.
Command/Response Reference Section 11-3 11-3-13 PASSIVE TCP OPEN REQUEST Requests processing to open a TCP socket. The socket will wait to be connected to another node. Command Block Command Results storage area Local Remote IP Remote TCP Timeout code socket address port number value...
Page 215
Command/Response Reference Section 11-3 Response Codes Response code Description 0000 Normal 0105 Local IP address setting error 0302 CPU Unit error; execution not possible. 1001 Command too large 1002 Command too small 1100 TCP socket number is out of range. Local TCP port number is 0.
Command/Response Reference Section 11-3 11-3-14 ACTIVE TCP OPEN REQUEST Requests processing to open a TCP socket. The socket will be connected to another node. Command Block Command Results storage Local Remote IP Remote code socket area TCP port address TCP port number number number...
Command/Response Reference Section 11-3 Results Storage Area Response Codes Response code Description 0000 Normal 000D A parameter error occurred at the remote IP address (EACCES). 003E Internal buffer cannot be reserved due to high receive load (ENOBUFS). 0042 (see note) An error occurred (EMSGSIZE).
Page 218
Command/Response Reference Section 11-3 Timeout Value (Command) The maximum control time between receiving the receive request and storing the result. If this set time limit is exceeded, the code for a timeout error will be set as the results storage response code. The value is set in units of 0.1 s. The time- out time is unlimited if the value is set to 0.
Command/Response Reference Section 11-3 11-3-16 TCP SEND REQUEST Requests that data be received at a TCP socket. Command Block 1,984 bytes max. Command Results storage Number of Data sent code socket area bytes sent number Response Block Command Response code code Results Storage Format Response...
Command/Response Reference Section 11-3 Results Storage Area Response Codes Response code Description 0000 Normal 0020 Connection to the remote socket was broken during transmission (EPIPE). 003E Internal buffer cannot be reserved due to high receive load (ENOBUFS). 0042 (see note) An error occurred (EMSGSIZE).
Command/Response Reference Section 11-3 Response Codes Response code Description 0000 Normal 0105 Local IP address setting error 0302 CPU Unit error; execution not possible. 1001 Command too large 1002 Command too small 1100 The TCP socket number is out of range. 1101 The variable type for the results storage area is out of range.
Command/Response Reference Section 11-3 11-3-19 IP ADDRESS TABLE WRITE Writes the IP address table. Command Block 6 bytes 6 bytes Command Number of address code records table records Response Block Command Response code code Parameters Number of Records The number of records to write is specified between 0000 and 0020 (0 to 32 deci- (Command) mal) in the command.
Command/Response Reference Section 11-3 11-3-20 IP ADDRESS TABLE READ Reads the IP address table. Command Block Command Number of code records Response Block 6 bytes 6 bytes Command Response Maximum Number Number IP address table records code code number of stored stored records records...
Command/Response Reference Section 11-3 11-3-21 IP ROUTER TABLE READ Reads the IP router table. Command Block Command Number of code records Response Block 8 bytes 8 bytes Command Response Maximum Number Number IP router table records code code number of stored of records of stored records...
Command/Response Reference Section 11-3 11-3-22 PROTOCOL STATUS READ Reads the Ethernet Unit protocol status. Command Block Command code Response Block 48 bytes 184 bytes 184 bytes 12 bytes Command Response IP status ICMP status TCP status UDP status code code Parameters IP Status (Response) Twelve types of IP status information occupying 4 bytes each are returned in the...
Page 226
Command/Response Reference Section 11-3 4. Total number of outputs of each packet type during ICMP output. The 19 sta- tistical values are returned in the order shown below. Contents are defined for 13 types only; all other types contain 0. Only #0, #3, #14, #16, and #18 are counted by the Ethernet Unit.
Page 227
Command/Response Reference Section 11-3 10. Total number of inputs of each packet type during ICMP input. The 19 statis- tical values are returned in the order shown below. Contents are defined for 13 types only; all other types contain 0. 4 bytes Type number Description...
Page 228
Command/Response Reference Section 11-3 12. The number of times no window advertisement is received within the time set on the duration timer. (The duration timer sets the maximum time limit for a window advertisement to be received if the transmission window is smaller than necessary and the resend timer is not set.
Command/Response Reference Section 11-3 20. The number of ACK packets received for received transmission acknowl- edgements (ACK). 21. The number of window advertisement packets received. UDP Status (Response) Three items of UDP information occupying 4 bytes each are returned in the fol- lowing sequence.
Page 230
Command/Response Reference Section 11-3 d) The number of short buffers used as protocol control blocks e) The number of short buffers used for routing tables f) Not used (always 0) g) Not used (always 0) h) The number of short buffers used for IP fragment re-assembly queue headers i) The number of short buffers used for storing socket addresses j) Not used (always 0)
Command/Response Reference Section 11-3 11-3-24 SOCKET STATUS READ Reads the Ethernet Unit network socket status. Command Block Command code Response Block 32 bytes Command Response Socket status code code Parameters Socket Status (Response) Returns eight types of information in records of 32 bytes each. A maximum of 64 records can be returned.
Command/Response Reference Section 11-3 Response Codes Response code Description 0000 Normal 1001 Command too large 11-3-25 ADDRESS INFORMATION READ Reads FINS node numbers and IP addresses Command Block Command code Response Block 6 bytes Command Response Number of Address code code addresses information...
Further information on measures that can be taken against noise is given later in this section. Recommended Products The following products are recommended for use with the CS1W-ETN01 Ethernet Unit. Part Company...
Page 234
Appendix A Network Installation Transceiver Installation Precautions • Transceivers can be attached to coaxial cables only at intervals of 2.5 m. These locations should be marked on the cable. • Connection methods can vary with the manufacturer of the cable. Follow all recommendations and specifica- tions of the manufacturer.
Page 235
Appendix A Network Installation Transceiver Installation Examples The following illustrations show examples of installing transceivers in the ceiling and under the floor. Ceiling Installation Inspection opening Secured wooden board Mount near an inspection opening large enough to enable maintenance. Secured wooden board Free-access Floor Installation...
Page 236
Appendix A Network Installation Ceiling Installation Examples Coaxial cable (above ceiling) Secured wooden board Transceiver Distribution panel Metal duct Duct Corner box Transceiver cable Wire protector Installation Examples for Noise-prone Environments Ethernet networks do not withstand noise very well and require special installation measures if installed where subject to noise.
Page 237
Appendix A Network Installation 4. Refer to the CS1-series CS1G/H-CPUjj-E Programmable Controllers Operation Manual (W339) for information on wiring inside distribution boxes. 4. Distribution box Ethernet Unit CS1-series PC Transceiver cable 3. Metal duct Noise Wooden board 1. Metal duct Transceiver 2.
Page 238
Appendix A Network Installation Optical Ethernet Systems Some manufacturers provide optical fiber components for Ethernet networks to provide high resistance to noise. The following illustrations show some simple examples of optical installations. See the manufacturer for specifics. Use as Noise Countermeasure The following illustration shows how optical components can be used to convert to optical fiber cable through areas highly prone to noise.
Page 239
Appendix A Network Installation Outdoor Installations The following example shows how optical fiber cable can be used to connect a network between two buildings, eliminating possible adverse affects of lightning. Segment 2 Segment 1 Coaxial cable Coaxial cable Transceiver Transceiver Transceiver cable Transceiver cable Optical...
Page 240
Appendix A Network Installation Cable Location Separate the transceiver cable connecting the Ethernet Unit as far from the wiring to the Contact Output Units as possible. The coaxial cable must also be placed as far away from the Contact Output Units and their wiring as possible.
Appendix B Ethernet Network Parameters Parameter Value Description TCP send buffer 4,096 bytes Maximum capacity of the TCP send buffer TCP receive buffer 4,096 bytes Maximum capacity of the TCP receive buffer UDP send buffer 9,000 bytes Maximum capacity of the UDP send buffer UDP receive buffer 9,016 bytes Maximum capacity of the UDP receive buffer...
Appendix C Buffer Configuration UDP socket (see note 1) reception request buffers (8 x 9,016 max.) TCP socket (see note 1) reception request buffers (8 x 4,096 max.) IP packet input queue (50 max. x 1,500 bytes) FTP service reception buffer (4,096 bytes) FINS reception buffer (16,383...
Page 243
Appendix C Buffer Configuration Network Memory Most of the buffers used for communications servicing by the Ethernet Unit are administered in a buffer configura- tion called network memory. Network memory consists of 196K bytes of memory divided into short and long buff- ers.
Appendix D TCP Status Transitions The TCP socket status can be confirmed using the socket status data returned for the FINS command SOCKET STATUS READ (2764). CLOSED ACTIVE OPEN snd SYN CLOSE Passive OPEN LISTEN CLOSE rcv SYN SEND snd SYN,ACK snd SYN rcv SYN RECEIVED...
Appendix E Auxiliary Area Data The following table and descriptions cover the words and bits in the Auxiliary Area of PC memory that are related to the Ethernet Unit. Read-only Bits/Words Word(s) Bit(s) Name Function Settings A202 A20200 to Communications Bits A20200 to A20207 turn ON when a network 0: Network A20207...
Page 246
Appendix E Auxiliary Area Data Word(s) Bit(s) Name Function Settings A410 A41000 to CS1 CPU Bus Unit The Duplication Error Flag (A40113) and the 0: No duplication corresponding flag in A410 will be turned ON when A41015 Number 1: Duplication a CS1 CPU Bus Unit’s unit number has been Duplication Flags duplicated.
Page 247
Appendix F CPU Bus Unit Allocations in the CPU Unit The CPU Bus Units, including Ethernet Units, are allocated words in the CPU Unit’s CIO Area and DM Area ac- cording to the unit numbers. This appendix is provided for easy reference. For details, refer to Section 4 System Setup and Memory Allocations.
Page 248
Appendix F CPU Bus Unit Allocations in the CPU Unit Area Configuration Offset Related communications services Data direction Unit Control Switch Socket Services CPU Unit to Ethernet Unit (Refer to Section 6 UDP Socket No. 1 Status Socket Services.) UDP Socket No. 2 Status Mail Function UDP Socket No.
Page 249
Appendix F CPU Bus Unit Allocations in the CPU Unit Status of UDP/TCP Sockets 1 to 8 (Ethernet Unit to CPU Unit) 15 14 13 12 11 10 n+1 to n+16 Opening Flag Receiving Flag Results Storage Error Flag Sending Flag TCP/UDP Open Flag Socket Closed Flag Service Status (Ethernet Unit to CPU Unit)
Page 250
Appendix F CPU Bus Unit Allocations in the CPU Unit DM Area Allocations Each Unit is allocated 100 words in the DM Area, as shown in the following table. Unit No. Allocated words Unit No. Allocated words (decimal) (decimal) 0 (0) D30000 to D30099 8 (8) D30800 to D30899...
Page 251
Appendix F CPU Bus Unit Allocations in the CPU Unit Internode Test Status (Ethernet Unit to CPU Unit) 15 14 13 12 11 10 Timeout Error code Response error Send error Data does not match Routing table error Send parameter error Number of Internode Test Runs (Ethernet Unit to CPU Unit) 15 14 13 12 11 10 Number of test runs (0000 to FFFF Hex)
Page 252
Appendix F CPU Bus Unit Allocations in the CPU Unit Socket Services Parameter Area 1 to 8 (Ethernet Unit to CPU Unit) Offset Socket Socket No. 1 No. 8 15 14 13 12 11 10 m+18 m+88 UDP/TCP socket number (1 to 8) m+19 m+89 Local UDP/TCP port number (0000 to FFFF Hex)
Appendix I Maintenance The Ethernet Unit makes up part of a network. Repair a defective Ethernet Unit as soon as possible as it can have a negative effect on the entire network. We recommend that customers keep one or more spare Ethernet Units to allow immediate recovery of the network.
Appendix J Inspections Carry out regular inspections to ensure the Ethernet Unit is functioning perfectly. Items Most of the parts that make up an Ethernet Unit are semiconductor components. None of the parts in the Unit will wear out after a specific lifetime, but some parts may deteriorate due to extreme operating condition. Therefore, it is important to inspect the Unit regularly.
Page 260
Index memory areas. See data areas precautions applications, xv Memory Cards, 140 Contact Output Units, 229 See also FTP server EC Directives, xvii deleting files, 149 environmental, 223 displaying directories, 147 general, xiv, 10 transferring files from host, 148, 149 grounding, 223, 224 transferring files to host, 148 IEEE802.3 standards, 10, 28...
Page 261
Index routing tables sockets, continued creating, 33 reading status, 221 setting examples, 35 receiving data TCP, 207 RSV, 80 UDP, 200 RUN indicator, 24 sending data troubleshooting, 170 TCP, 209 UDP, 201 status, 52 TCP sockets number, 96 status, 58, 235 SA1, 81 troubleshooting, 178 testing communications, 211...
Page 262
Index TCP OPEN REQUEST (ACTIVE), 206 TS indicator, 24 TCP OPEN REQUEST (PASSIVE), 204 type, 148 TCP RECEIVE REQUEST, 207 TCP SEND REQUEST, 209 temperature, 6 UDP CLOSE REQUEST, 203 Terminators, 4 precautions, 223 UDP communications, 7 comparison with TCP, 88 timers, 231 data fragmentation, 90 timing...
Revision History A manual revision code appears as a suffix to the catalog number on the front cover of the manual. Cat. No. W343-E1-1 Revision code The following table outlines the changes made to the manual during each revision. Page numbers refer to the previous version.