OneFex CS-E3100, User Manual

Page 1: ...CS E3100 User Manual Serial to Ethernet Converter Version V1 0 0 ...

Page 2: ...pport Auto MDI MDIX DC 5 36V Support DHCP or static IP The average delay of 10 000 times of ping is less than 1ms Watchdog guard Support TCP Server Client UDP Server Client HTTP Client Support heartbeat packet and identity register packet Modbus TCP RTU convert Import and export parameters Cache data when offline Configure device by web server AT commands Serial or LAN Can be upgraded over serial ...

Page 3: ...on 9 2 3 1 TCP Client Server 9 2 3 2 UDP Client Server 10 2 3 3 HTTP Client 12 2 3 4 Heartbeat Packet and Identity Register Packet 14 2 3 5 Modbus TCP and RTU Converter 15 2 4 Advanced Features 16 2 4 1 Data Cache 16 2 4 2 Search Device 16 2 4 3 LAN AT Command 17 2 4 4 Upgrade 17 2 5 Restart when Received Timeout 18 3 Parameters Configure 19 3 1 Web Page 19 3 1 1 State Page 19 3 1 2 System Page 19...

Page 4: ...Disclaimer 32 Revision history 33 ...

Page 5: ...al OneFex 1 1 Introduction 1 1 Overview SC E3100 is a Serial to Ethernet converter Excellent software and hardware performance applicable to various industries and complex scenarios Typical application scenarios Figure 1 ...

Page 6: ...3P 5 08mm Baud rate 1200 460800bps Parity NONE ODD EVEN Data bits 8 Stop bits 1 2 Flow Control NFC or 485 LED Power Power indication Key Reload Press and hold for 3s to restore the parameters Software Network protocol DHCP DNS TCP UDP HTTP ICMP Transparent Transmission TCP Client Server Up to 8 clients UDP Client Server MQTT Coming soon Advanced Features Web page Configure or upgrade AT Command Ne...

Page 7: ... Parameter RS232 RS485 Baud rate 115200 Parity NONE Data bits 8 Stop bits 1 Default parameters of ethernet Ethernet Item Parameter RJ45 DHCP Disable IP 192 168 10 8 Gateway 192 168 10 1 Mask 255 255 255 0 1 4 Get Started Purpose The device is connected to the computer directly to test TCP transparent transmission ...

Page 8: ...and PC 2 Power on the device 1 4 2 Search Device Open the Setup Tool provided by our company Search firstly then double click to open the device web page Figure 4 Search Device 1 4 3 Configure Socket Configure device as TCP Server 8010 in Port1 page Then click Save button Finally reboot the device in System page to make the new parameters take effect ...

Page 9: ...CS E3100 User Manual OneFex 5 Figure 5 Socket Configuration 1 4 4 Communication Test Using TCP and COM Debug Assistant tests communication Figure 6 Communication Test ...

Page 10: ...our multi serial products the commands of serial and socket have a character n for indicating the index of serial e g AT UARTn 2 1 1 Parameters of Serial Table 2 Parameters of Serial Serial Item Parameter RS232 RS485 Mode Configuration mode transparent transmission default Baud rate 1200 460800 default 115200 Parity NONE ODD EVEN default NONE Data bits 8 Stop bits 1 2 default 1 Flow Control NFC or...

Page 11: ...ttings default 1024 64 1024 By time interval Character interval interval of settings default 5ms 1 300ms Note Under the TCP protocol data will be packet connected If the length of the data packet is strict please be sure to add a mechanism for splitting packets at the application layer 2 1 3 Operating Mode Supports two operating modes Configuration mode Data received from serial port is executed a...

Page 12: ...ceived it means enter Configuration Mode successfully Note If the step is aborted the data sent during the period will be forwarded to the Socket Configuration Mode will not be saved after power off 2 1 3 2 Exit from Configuration Mode User can send AT command AT EXIT or restart the device to exit Configuration Mode Note The at command ends with a carriage return line feed r n 2 2 Ethernet Table 3...

Page 13: ...e two sockets respectively The device support TCP Server TCP Client UDP Server UDP Client HTTP Client P2P and MQTT Client coming soon 2 3 1 TCP Client Server The Transmission Control Protocol TCP is a transport protocol that is used on top of IP to ensure reliable transmission of packets When the device uses the TCP protocol the keepalive is enabled 2 3 1 1 TCP Client When TCP Client is enabled th...

Page 14: ... the user Supports up to 8 clients When the number of clients exceeds the limit the oldest client can be kicked off and the new client can be accepted or keep original clients and the new client is prohibited from accessing Figure 12 TCP Server 2 3 2 UDP Client Server User Datagram Protocol UDP is a Transport Layer protocol Unlike TCP it is an unreliable and connectionless protocol Since high perf...

Page 15: ...ver For the convenience of users we divide UDP into UDP Client and UDP Server artificially 2 3 2 1 UDP Client The address and port of the target server are specified by the user in UDP Client mode And it is recommended to use a fixed local port otherwise the peer device may not know the port this device listened Figure 13 UDP Client 2 3 2 2 UDP Server Listen to the port specified by the user in UD...

Page 16: ...RI is not necessary Both of the following uri are correct http www rt thread com service rt thread txt www rt thread com service rt thread txt 2 3 3 1 Request of GET If you want to request a web page via URI you need to use the Request of GET mode URI consists of Server address Server port and URL Note that URL in web is invalid and it is the data received from the serial Example Get www rt thread...

Page 17: ... 2 Request of POST Post request can submit data to HTTP server Here we use a server www rt thread com service echo which supports echo for testing The parameters are similar to GET the request is changed to POST and add URL service echo Figure 16 HTTP Post Test ...

Page 18: ...an send the complete URI such as http www rt thread com service rt thread txt http www rt thread com 80 service rt thread txt www rt thread com service rt thread txt POST URI and data are separated by escape characters r n such as http www rt thread com 80 service echo Data www rt thread com service echo Data 2 3 4 Heartbeat Packet and Identity Register Packet The device supports Heartbeat Packet ...

Page 19: ... Register Packet When the device communicates with server the device sends some identifying data actively and the server can distinguish the client based on this This feature is only supported in TCP UDP Client There are three ways to send First TCP sends every time a connection is established And UDP sends only once Every As a prefix for each packet of data ALL Both First and Every 2 3 5 Modbus T...

Page 20: ... after online This feature is enabled by default Figure 20 Data Cache 2 4 2 Search Device The network search function can search for devices in LAN and send AT commands to the devices The search process is to broadcast the search keyword default is OneFex com to port 8168 using UDP protocol After receiving the specified broadcast packet the device will reply its own IP MAC name version ...

Page 21: ... Upgrade The device supports multiple upgrade methods Under normal circumstances the upgrade does not change the previous parameters of the device 2 4 4 1 Upgrade over serial Press Reload Key then power the device The device enters the upgrade mode and the Work LED flashes quickly At this time use the tools provided by our company to upgrade through the serial port 2 4 4 2 Upgrade over HTTP The us...

Page 22: ...ce will output ok otherwise fail 4 Restart the device and update the firmware 2 4 4 3 Upgrade over Web Page Open the device webpage through the browser And you can upgrade in System page Figure 23 Upgrade 2 5 Restart when Received Timeout The device will restart automatically when no data is received from network for a long time The default duration is 1440 minutes When the duration is 0 the funct...

Page 23: ... connected to the same LAN Use a browser to open the device webpage or using ONEFEX Setup Tool search and open the device s web page Default username admin Default password admin 3 1 1 State Page Display basic equipment information and network data statistics Figure 25 3 1 2 System Page You can configure web user names and passwords network search ports keywords etc and also support firmware upgra...

Page 24: ...e 27 3 2 AT Command User can query and configure parameters through AT commands in Configuration Mode Please refer Operating Mode to enters serial AT mode and refer LAN AT Command to enters LAN AT mode Note New parameters take effect after restart 3 2 1 Rule of Serial AT AT command follows the following rules 1 Use AT as the prefix and r n as the suffix ...

Page 25: ...T Command Error Code When the command execution fails the device will issue an error code The format of the error code is r n ERROR Error_Code r n Table 4 AT Error Code Error Code Error Type Error Cause ARGS Invalid parameter The parameter length size format etc do not conform to the rules ARGC Wrong number of parameters Wrong number of parameters CMD_UNKNOWN Unknown command Command does not exist...

Page 26: ... is owned by the nth serial port When sending the command please replace n with the serial port number For example query the parameters of serial Port2 AT UART2 When there is a lowercase letter s in the command such as SOCKns s means A or B For example set the SocketA parameter of serial port 1 AT SOCK1A TCPC 192 168 1 8 8888 3 2 4 1 LIST Get a list of commands AT LIST LIST commands list OK 3 2 4 ...

Page 27: ... MODULE value VERSION value MAC value DECRYPT value BUILD value PRODUCT TIME value SN value Parameter MODULE Module VERSION Version MAC MAC DECRYPT Firmware function status BUILD Build time PROTIME Production Date SN Serial number 3 2 4 6 REBOOT Reboot device AT REBOOT OK 3 2 4 7 RSTCFG Reset parameters from backup parameters and restart AT RSTCFG OK ...

Page 28: ...OCKLK SOCKLK ns state SOCKLK ns state OK Query the status of a specific socket AT SOCKLK ns SOCKLK state OK Parameter state OFF Disconnect ON Connect 3 2 4 11 DOWNLOAD Upgrade over HTTP AT DOWNLOAD path state Parameter path Path of firmware e g update OneFex com firmware bin 192 168 1 56 8080 firmware bin state OK Download succeeded Need restart for upgrade ERROR FAIL 3 2 4 12 PING PING test AT PI...

Page 29: ...able or disable AT ECHO ECHO state AT ECHO state OK Parameter state ON Enable OFF Disable default 3 2 4 14 BOOTINFO Indicate of boot AT BOOTINFO BOOTINFO info AT BOOTINFO info OK Parameter info Length 1 16 default ONEFEX 3 2 4 15 SOCKRTO Restart if socket receiving timeout AT SOCKRTO SOCKRTO time AT SOCKRTO time OK Parameter time 0 65535 min Default 1440 0 Disable this function 3 2 4 16 WEBU User ...

Page 30: ...AT WAN WAN dhcp_en ip gw mask AT WAN dhcp_en ip gw mask OK Parameter dhcp_en DHCP DHCP Parameter after DHCP can be omitted STATIC Static IP Default ip IP default 192 168 10 8 gw Gateway default 192 168 10 1 mask Mask default 255 255 255 0 3 2 4 19 DNS Alternate DNS address AT DNS DNS addr AT DNS addr OK Parameter addr Alternate DNS address default value 114 114 114 114 Preferred DNS is Gateway add...

Page 31: ...efault 115200 Support 2400 4800 9600 19200 38400 57600 115200 230400 46 0800 databits 8 stopbits 1 default or 2 parity NONE default EVEN ODD fc NONE default 485 3 2 4 22 UARTTLn Time and length of the nth serial for packing frame AT UARTTLn UARTTLn tm len AT UARTTLn tm len OK Parameter tm 1 300ms default 5 len 64 1024bytes default 1024 3 2 4 23 CACHEn Enable of Disable Data Cache when offline AT C...

Page 32: ...ket1A enabled 3 2 4 26 SOCKns Parameters or Socketns n is number of serial s is A or B AT SOCKns SOCKns type addr port localport AT SOCKns type addr port localport OK Parameter type Protocol TCPC TCP Client TCPS TCP Server UDPC UDP Client UDPS UDP Server HTPC HTTP Client EDP OneNET EDP MQTT coming soon addr Address of remote server Up to 64 bytes invalid in Server mode port Port of remote server i...

Page 33: ...TPHDn HTPHDn hd AT HTPHDn hd OK Parameter hd 1 64bytes Split by if there are many headers 3 2 4 29 HTPFTn Enable or disable the filter of header AT HTPFTn HTPFTn state AT HTPFTn state OK Parameter state ON default OFF 3 2 4 30 HTPREQn HTTP Request AT HTPREQn HTPREQn request AT HTPREQn request OK Parameter request GET POST AUTO Automatic mode choose the request method according to the data ...

Page 34: ...US Custom content 3 2 4 33 REGMDn Mode of send register AT REGMDn REGMDn mode AT REGMDn mode OK Parameter mode OFF Disable register defualt FIRST TCP sends every time a connection is established And UDP sends only once EVERY As a prefix for each packet of data ALL Both FIRST and EVERY 3 2 4 34 REGDATn Custom content of register AT REGDATn REGDATn data fmt AT REGDATn data fmt OK Parameter data Cont...

Page 35: ...lt UART Serial heartbeat NET Network heartbeat 3 2 4 36 HEARTTMn Time interval of heartbeat AT HEARTTMn HEARTTMn time AT HEARTTMn time OK Parameter time 1 86400s default 60 3 2 4 37 HEARTDATn Custom content of heartbeat AT HEARTDATn HEARTDATn data fmt AT HEARTDATn data fmt OK Parameter data Content fmt HEX Up to 64 bytes or ASCII Up to 32 bytes ...

Page 36: ...s must design their products in accordance with the specifications and parameters provided in the document The company does not assume any responsibility for personal injury or property damage caused by improper operation of the customer Our company will not notify you if we make changes to product specifications and product descriptions ...

Page 37: ...CS E3100 User Manual OneFex 33 Revision history Date Revision Changes 2020 08 25 V1 0 0 Initial release ...