Iot Workshop: HF5111B Serial Server Device User Manual

Download as pdf or txt
Download as pdf or txt
You are on page 1of 58

HF5111B Serial Server Device User Manual

HF5111B

Serial Server Device User Manual


V 1.1

P
O
Overview of Characteristic SH
RK
 Cortex-M3 MCU with 2MB Flash and 128KB SRAM

 Use FreeRTOS Operation System


O

 Support TCP/IP/Telnet /Modbus TCP Protocol


W

 Support Serial To 10/100M Ethernet Conversion, Serial Speed Upto 921600 bps

 Support 10/100M Ethernet Auto-Negotiation

 Support Easy Configuration Through a Web Interface or PC IOTManager Tool


T

 Support Security Protocol Such As TLS/AES/DES3


IO

 Support Web OTA Wirelss Upgrade

 Support Industrial Temperature: -40 to +85˚ C

 Wide DC Input 5~36VDC or 9~50VDC

 Size: 94 x 65 x 25 mm (L x W x H)

 FCC/CE/RoHS Certificated

http://www.iotworkshop.com -1-
HF5111B Serial Server Device User Manual

TABLE OF CONTENTS TABLE OF CONTENTS


TABLE OF CONTENTS TABLE OF CONTENTS ...........................................................................2

LIST OF FIGURES ............................................................................................................................5

LIST OF TABLES .............................................................................................................................7

HISTORY...........................................................................................................................................7

1. PRODUCT OVERVIEW ........................................................................................................8


1.1. General Description .........................................................................................................8
1.2. Device Features ...............................................................................................................8

P
1.3. Device Paremeters ...........................................................................................................9
1.4. Key Application ..............................................................................................................10

O
2. HARDWARE INTRODUCTION .........................................................................................11
2.1. Pins Definition ................................................................................................................12
2.2. RS232 Interface ..............................................................................................................13

SH
2.3. RS485 Interface ..............................................................................................................14
2.4. RS422 Interface ..............................................................................................................14
2.5. RJ45 Interface ................................................................................................................14
2.6. Mechanical Size .............................................................................................................15
RK
2.7. Rail Mounting .................................................................................................................15
2.8. Order Information ..........................................................................................................16
2.9. Device Difference ...........................................................................................................16
2.10. Package Information ......................................................................................................16
O

3. FUNCTIONAL DESCRIPTION ..........................................................................................18


3.1. Basic Network Protocol.................................................................................................18
3.2. Ethernet Interface Function ..........................................................................................18
W

3.3. Typical Network Architecture .......................................................................................19


3.4. Working Mode ................................................................................................................19
3.5.1. Transparent Transmission Mode .............................................................................19
3.5.2. TCP Server ..................................................................................................................20
T

3.5.3. HTTP Mode .................................................................................................................21


3.5.4. Telnetd Mode ..............................................................................................................23
IO

3.5. AES/DES3/TLS Data Encryption ...................................................................................25


3.6. Keepalive ........................................................................................................................25
3.7. Timeout ...........................................................................................................................26
3.8. Route Setup ....................................................................................................................26
3.9. UART Frame Scheme ....................................................................................................27
3.9.1. UART Free-Frame ......................................................................................................27
3.9.2. UART Auto-Frame ......................................................................................................28
3.9.3. Tag Function ..............................................................................................................28
3.10. Modbus Protocol ............................................................................................................29
3.11. Cli Command ..................................................................................................................29
3.12. UART Flow Control and RS485 Function ....................................................................30

http://www.iotworkshop.com -2-
HF5111B Serial Server Device User Manual

3.13. Firmware Upgrade .........................................................................................................30


3.14. Web Page Function ........................................................................................................31
3.15. Auto-IP Function ............................................................................................................31
3.16. Other Function ...............................................................................................................32
3.17. NTP Function ..................................................................................................................33
3.18. Heartbeat Function ........................................................................................................33
3.19. UART Fast Config ..........................................................................................................34

4. CLI COMMAND NOTES .......................................................................................................35


4.1. Working Mode ................................................................................................................35
4.1.1. Switch Transparent Transmission Mode to Cli Command Mode .................................... 35

P
4.2. Cli Command Overview .................................................................................................36
4.2.1. Cli Command Format ...................................................................................................... 39

O
4.2.1.1. Show Command ........................................................................................................... 39
4.2.1.2. SYS Directory ............................................................................................................... 40
4.2.1.3. SYS/Auth Directory ...................................................................................................... 40

SH
4.2.1.4. SYS/Auth/User Command ............................................................................................ 40
4.2.1.5. SYS/Auth/Password Command ................................................................................... 41
4.2.1.6. SYS/Network Directory ................................................................................................. 41
4.2.1.7. SYS/Network/Show Command .................................................................................... 41
RK
4.2.1.8. SYS/Network/DHCP Command ................................................................................... 41
4.2.1.9. SYS/Network/DNS Command ...................................................................................... 41
4.2.1.10. SYS/Network/Hostname Instruction ........................................................................... 42
4.2.1.11. SYS/Telnet Instruction ................................................................................................ 42
4.2.1.12. SYS/Web Instruction .................................................................................................. 42
O

4.2.1.13. SYS/MAC Instruction .................................................................................................. 43


4.2.1.14. SYS/JCMD Instruction ................................................................................................ 43
4.2.1.15. SYS/NTP Instruction................................................................................................... 43
W

4.2.1.16. UART Directory .......................................................................................................... 43


4.2.1.17. UART/Show Instruction .............................................................................................. 44
4.2.1.18. UART/Baudrate Instruction......................................................................................... 44
4.2.1.19. UART/Databits Instruction .......................................................................................... 44
T

4.2.1.20. UART/Stopbits Instruction .......................................................................................... 44


4.2.1.21. UART/Parity Instruction .............................................................................................. 45
IO

4.2.1.22. UART/Buf Directory .................................................................................................... 45


4.2.1.23. UART/Buf/Bufsize Instruction ..................................................................................... 45
4.2.1.24. UART/Buf/GapTime Instruction .................................................................................. 45
4.2.1.25. UART/Buf/FlowCtrl Command.................................................................................... 46
4.2.1.26. UART/Buf/SWFlowCtrl Command .............................................................................. 46
4.2.1.27. UART/Cli-Getin Command ......................................................................................... 46
4.2.1.28. UART/Cli-WaitTime Command................................................................................... 47
4.2.1.29. UART/Proto command ............................................................................................... 47
4.2.1.30. UART/Frame Directory ............................................................................................... 47
4.2.1.31. UART/Frame/FrameLen Command ........................................................................... 47
4.2.1.32. UART/Frame/FrameTime Command ......................................................................... 48

http://www.iotworkshop.com -3-
HF5111B Serial Server Device User Manual

4.2.1.33. UART/Frame/Tag Command...................................................................................... 48


4.2.1.34. UART/Edit Command ................................................................................................. 48
4.2.1.35. UART/Clean Command .............................................................................................. 48
4.2.1.36. SOCK Directory .......................................................................................................... 49
4.2.1.37. SOCK/Show Command .............................................................................................. 49
4.2.1.38. SOCK/New Command................................................................................................ 49
4.2.1.39. SOCK/netp directory................................................................................................... 51
4.2.1.40. SOCK/netp/clean Command ...................................................................................... 51
4.2.1.41. DATA Directory........................................................................................................... 51
4.2.1.42. Restart Command ...................................................................................................... 51

P
4.2.1.43. Reload Instruction....................................................................................................... 52
4.2.1.44. Exit Command ............................................................................................................ 52
4.2.1.45. Quit Command ........................................................................................................... 52

O
4.2.1.46. FwUpgrade Instruction ............................................................................................... 52

APPENDIX A:REFERENCES .....................................................................................................53

SH
A.1.Test Tools ..........................................................................................................................53
B.3.Quick Start Manual ...........................................................................................................53

APPENDIX B:TELNET COMMUNICATION FUNCTION .............................................................54


B.1.Telnet Use Scene: .............................................................................................................54
RK
B.2.Telnet Features: ................................................................................................................54
B.3.Telnet Usage:.....................................................................................................................54

APPENDIX C: CONTACT INFORMATION ...............................................................................58


O
W
T
IO

http://www.iotworkshop.com -4-
HF5111B Serial Server Device User Manual

LIST OF FIGURES
Figure 1. HF5111B Appearance .................................................................................................................. 11
Figure 2. HF5111B Interface......................................................................................................................... 12
Figure 3. HF5111B Side View ....................................................................................................................... 12
Figure 4. RS232 Pin Defination(Male/Needle Type) .................................................................................... 13
Figure 5. HF5111B RS422 Connectioin ........................................................................................................ 14
Figure 6. RJ45 Pin Defination ...................................................................................................................... 14
Figure 7. HF5111B Mechanical Dimension ................................................................................................... 15
Figure 8. HF5111B Rail ................................................................................................................................ 16
Figure 9. HF5111B Product Order Information ............................................................................................. 16

P
Figure 10. HF5111 Software Protocol Structure ............................................................................................. 18
Figure 11. Ethernet Interface Function............................................................................................................ 18
Figure 12. Network application ....................................................................................................................... 19

O
Figure 13. Transparent data transmission example ........................................................................................ 20
Figure 14. TCP Server data transmission example ........................................................................................ 21

SH
Figure 15. Multi Socket data transmission example ........................................................................................ 21
Figure 16. Webpage set up multi Socket channel ........................................................................................... 21
Figure 17. IOTManager Software Configure ................................................................................................... 22
Figure 18. Web Page Configure ..................................................................................................................... 22
Figure 19. HTTP transmit example ................................................................................................................. 23
RK
Figure 20. IOTManager Software Configure Protocol ..................................................................................... 24
Figure 21. Web page configure protocol ......................................................................................................... 24
Figure 22. Telnet details example ................................................................................................................... 25
Figure 23. IOTManager Software Configure Encryption ................................................................................. 25
O

Figure 24. Web Page Configure Encryption .................................................................................................... 25


Figure 25. Web Page Config Keepalive .......................................................................................................... 26
Figure 26. Web Page Configure Timeout........................................................................................................ 26
W

Figure 27. Route function setup example ....................................................................................................... 27


Figure 28. Route Function Data Flow Example .............................................................................................. 27
Figure 29. UART free-frame function .............................................................................................................. 28
Figure 30. UART Auto-Frame Function .......................................................................................................... 28
Figure 31. UART Auto-Frame Function .......................................................................................................... 28
T

Figure 32. UART Auto-Frame Tag Function ................................................................................................... 29


Figure 33. UART Modbus Function................................................................................................................. 29
IO

Figure 34. Cli Command Setting ..................................................................................................................... 30


Figure 35. UART Flow Control ........................................................................................................................ 30
Figure 36. UART Half Duplex Function ........................................................................................................... 30
Figure 37. External web page ......................................................................................................................... 30
Figure 38. Internal web page .......................................................................................................................... 31
Figure 39. Web Page Function Setting ........................................................................................................... 31
Figure 40. AUTO-IP Connection ..................................................................................................................... 31
Figure 41. AUTO-IP Config Device ................................................................................................................. 32
Figure 42. Cli Command Query Device IP ...................................................................................................... 32
Figure 43. Other Function ............................................................................................................................... 32

http://www.iotworkshop.com -5-
HF5111B Serial Server Device User Manual

Figure 44. IOTManager Tools NTP Setting ..................................................................................................... 33


Figure 45. Cli Command NTP Setting and Query ........................................................................................... 33
Figure 46. Heartbeat Function ........................................................................................................................ 33
Figure 47. HF5111 Default: UART Parameters .............................................................................................. 35
Figure 48. Switch Transparent Transmission Mode to Cli Command Mode ................................................... 36
Figure 49. Cli Command Root Directory ......................................................................................................... 36
Figure 50. Cli Command SYS Tree................................................................................................................. 37
Figure 51. Cli Command UART Tree .............................................................................................................. 37
Figure 52. Cli Command SOCK Tree.............................................................................................................. 38
Figure 53. Cli Other Command ....................................................................................................................... 39

P
O
SH
RK
O
W
T
IO

http://www.iotworkshop.com -6-
HF5111B Serial Server Device User Manual

LIST OF TABLES

Table1. HF5111B Technical Specifications ......................................................................................................... 9


Table2. HF5111B Interface Definition................................................................................................................ 13
Table3. RS232 Interface.................................................................................................................................... 13
Table4. RJ45 Interface ...................................................................................................................................... 15

HISTORY

P
Ed. V1.0 11-08-2016 First Version

O
Ed. V1.1 02-10-2017 Add Auto-IP, heartbeat, ntp and UART fast config function(Firmware
version:1.07c)

SH
RK
O
W
T
IO

http://www.iotworkshop.com -7-
HF5111B Serial Server Device User Manual

1. PRODUCT OVERVIEW

1.1. General Description


The HF5111B provides a serial interface to Ethernet connectivity to web enable any device. The
HF5111B integrate TCP/IP controller, memory, 10/100M Ethernet transceiver, high-speed serial port
and integrates a fully developed TCP/IP network stack and FreeRTOS OS.The HF5111B also
includes an embedded web server used to remotely configure, monitor, or troubleshoot the attached

P
device.

The HF5111B using highly integrated hardware and software platform,It has been optimized for all

O
kinds of applications in the industrial control, smart grid , personal medical application and remote
control that have lower data rates, and transmit or receive data on an infrequent basis.

SH
The HF5111B integrates all serial to Ethernet functionality with 94 x 65 x 25mm size..

1.2. Device Features


RK
 Cortex-M3 MCU with 2MB Flash and 128KB SRAM
 Support FreeRTOS Operation System
 Support TCP/IP、UDP、DHCP、DNS、HTTP Server/Client、ARP、BOOTP、AutoIP、ICMP、
Telnet、FTP、TFTP、uPNP、NTP、ModbusTCP Protocol
O

 Support Serial to 10/100M Ethernet Conversion, Serial Speed Upto 460800 bps
 Support 10/100M Ethernet Auto-Negotiation

W

Support Easy Configuration Through a Web Interface


 Support Security Protocol Such As TLS/AES/DES3
 Support Web Wireless Upgrade
 Support Industrial Temperature: -40 to +85˚ C
 Wide 5~36VDC or 9~50VDC Power Supply
T

 Size: 94 x 65 x 25mm (L x W x H)
 FCC/CE/RoHS Certificated
IO

http://www.iotworkshop.com -8-
HF5111B Serial Server Device User Manual

1.3. Device Paremeters


Table1. HF5111B Technical Specifications

Item Parameters
System Information
Processor/Frequency Cortex-M3/96MHz
Flash/SDRAM 2MB/128KB
Operating System FreeRTOS
Ethernet Port

P
Port Number 1 RJ45
Interface Standard 10/100 Base-T Auto-Negotiation

O
Protection 8KV Isolation
Transformer Integrated
IP,TCP,UDP,DHCP,DNS,HTTP Server/Client,ARP,

SH
Network Protocol BOOTP, AutoIP, ICMP,Web socket, Telnet, FTP,TFTP,
uPNP, NTP, SNMP,Modbus TCP
TLS v3
Security Protocol AES 128Bit
DES3
IPV6 Support Not yet
RK
Serial Port
Port Number 1 RS232/RS485/RS422
RS232: DB9
Interface Standard
RS485/RS422: 5.08mm connector
O

Data Bits 8
Stop Bit 1,2
Check Bit None,Even,Odd,Space,Mark
W

Baud Rate TTL: 600 bps~460800 bps


No Flow control
Flow Control Hardware RTS/CTS、DSR/DTR
Software Xon/ Xoff flow control
Software
Http Web Configuration
T

Web Pages
Customization of HTTP Web Pages
Web
IO

CLI
Configuration XML import
Telnet
IOTManager PC Software
Firmware Upgrade Web
SDK For Dev. Not yet
Basic Parameter
Size 94 x 65 x 25 mm
Operating Temp. -45 ~ 85°C
Storage Temp. -45 ~ 105°C, 5 ~ 95% RH(no condensation)
Input Voltage 5~36VDC or 9~50VDC
Working Current ~100mA

http://www.iotworkshop.com -9-
HF5111B Serial Server Device User Manual

Power <400mW
Other Information
Certificate CE, FCC, RoHS

1.4. Key Application

The HF5111B device connects serial device to Ethernet networks using the TCP/IP protocol:
 Remote equipment monitoring
 Asset tracking and telemetry
 Security Application

P
 Industrial sensors and controls
 Medical devices

O
 ATM machines
 Data collection devices
 Universal Power Supply (UPS) management units

SH
 Telecommunications equipment
 Data display devices
 Handheld instruments
 Modems
 Time/attendance clocks and terminals
RK
O
W
T
IO

http://www.iotworkshop.com - 10 -
HF5111B Serial Server Device User Manual

2. HARDWARE INTRODUCTION
The HF5111B unit is a complete solution for serial port device connecting to network. This powerful
device supports a 10/100BASE-T Ethernet connection, a reliable and proven operating system stored
in flash memory, an embedded web server, a full TCP/IP protocol stack,and standards-based (AES)
encryption.

Through Ethernet cable connect router with HF5111B serial server for data transfer, which makes the

P
data transformation very simple. HF5111B meet EMC Class B security level,It can pass every
countries relevant certification test

O
SH
RK
Figure 1. HF5111B Appearance
O
W
T
IO

http://www.iotworkshop.com - 11 -
HF5111B Serial Server Device User Manual

2.1. Pins Definition

P
O
SH
RK
O
W
T

Figure 2. HF5111B Interface


IO

Figure 3. HF5111B Side View

http://www.iotworkshop.com - 12 -
HF5111B Serial Server Device User Manual

Table2. HF5111B Interface Definition

Function Name Description


External RJ45 Ethernet 10/100M Ethernet
Interface RS232 RS232 Communication
RS485/RS422 RS485/RS422 Communicaton
Earth Protect Earth
DC Input DC Power 5~36V Input or 9~50VDC
LED Internal Power Supply Indicator
Indicator Power On:Power is OK

P
Off:Power is NG
Connection Indicator

O
Link On: Ethernet connection is OK
Off: No Ethernet connection

SH
Data transfer Indicator
Active On:Data is transfering.
Off:No data transfer
Button Reset Reset device
RK
Switch Device parameter protect
On: Enable protect, working parameter can not
Protect
be modified.
Off: Disable protect.
O

2.2. RS232 Interface


W

Device serial port is male(needle), RS232 voltage level(can connect to PC directly), Pin Order is
cosistent with PC COM port. Use cross Cable connected with PC(2-3 cross, 7-8 cross, 5-5 direct, 7-8
no connection), see the following table for pin defination.
T
IO

Figure 4. RS232 Pin Defination(Male/Needle Type)

Table3. RS232 Interface

Pin Number Name Description


2 RXD Receive Data
3 TXD Send Data
5 GND GND

http://www.iotworkshop.com - 13 -
HF5111B Serial Server Device User Manual

Pin Number Name Description


7 RTS Request to Send
8 CTS Clear to Send

2.3. RS485 Interface

RS485 use two wire links, A(DATA+), B(DATA-). Connect A(+) to A(+), B(-) to B(-) for communication.

The RS485 interface support maximum 32 485 device, special hardware version can support max 255
device. The cable maximum length is 1200 meters. Need to add 120Ohm terminal resistor for over

P
300 meters.

O
2.4. RS422 Interface

SH
RS422 interface use T+/T-/R+/R-, cross connect to device as the following picture.
Name Description
TX+ Transfer Data+
TX- Transfer Data-
RK
RX+ Receive Data+
RX- Receive Data-
O
W

Figure 5. HF5111B RS422 Connectioin


T
IO

2.5. RJ45 Interface

Ethernet port is 10M/100M adaptive, support AUTO MDI/MDIX which means it support direct
connecting to PC with Ethernet cable.

Figure 6. RJ45 Pin Defination

http://www.iotworkshop.com - 14 -
HF5111B Serial Server Device User Manual

Table4. RJ45 Interface

Pin Number Name Description


1 TX+ Transfer Data+
2 TX- Transfer Data-
3 RX+ Receive Data+
4 PHY-VCC Transformer Tap Voltage
5 PHY-VCC Transformer Tap Voltage
6 RX- Receive Data-
7 N.C. None Connect

P
8 N.C. None Connect

O
2.6. Mechanical Size

The dimensions of HF5111B are defined as following picture (mm):

SH
RK
O
W
T
IO

Figure 7. HF5111B Mechanical Dimension

2.7. Rail Mounting

We support to provide rail for mounting as the following picture.

http://www.iotworkshop.com - 15 -
HF5111B Serial Server Device User Manual

Figure 8. HF5111B Rail

P
2.8. Order Information

O
Base on customer detailed requirement, HF5111B provide different configuration version, Details as
below:

SH
RK
O
W

Figure 9. HF5111B Product Order Information

2.9. Device Difference


The device difference is as following
T

Type RS232 RS485/RS422 Ethernet OS Voltage Size(mm)


IO

HF5111B(-H) √ √ √ Linux 5~36V 94*65*25

HF5111B-I √ √ √ Linux 9~50V 94*65*25

HF5111B(-H) √ √ √ FreeRTOS 5~36V 94*65*25

HF5111B-I √ √ √ FreeRTOS 9~50V 94*65*25

2.10. Package Information

1 * HF5111B

http://www.iotworkshop.com - 16 -
HF5111B Serial Server Device User Manual

1 * 12V/1A DC adapter

1 * RS232 cable

1 * Ethernet cable

P
O
SH
RK
O
W
T
IO

http://www.iotworkshop.com - 17 -
HF5111B Serial Server Device User Manual

3. FUNCTIONAL DESCRIPTION
The HF5111 has the following feature:
 Connect customer’s device with PC or server via TCP/UDP/Telnet.
 Contain a HTTP web server allow user to configure through browser with PC or phone.
 Have multi-programmable I/O pins used to monitor or control device directly.

3.1. Basic Network Protocol

P
The HF5111 device uses the IP address for network communications. If uses the TCP to assure that

O
no data is lost or duplicated. If use UDP to assure that data can be fast and effective to DES3tination
address.

SH
Supported protocols include:
 ARP, UDP, TCP, ICMP, DHCP, Telnet, DHCP, HTTP Server/Client Web socket
 Telnet command configuration, Web server configuration
 Security Protocol: TLS, AES, DES3 encryption
HF5111B
RK
Protocols Security Configuration
Web
DHCP DNS/DDNS SSL/TLS
CLI
Application IGMP TCP/IP AES
Telnet
Programming WebSocket HTTP DES
O

Log
Interface
TCP/UDP
IP/ICMP
W

Ethernet
FreeRTOS OS Drivers
Cortex-M3 MCU

Figure 10. HF5111 Software Protocol Structure


T
IO

3.2. Ethernet Interface Function

Figure 11. Ethernet Interface Function

http://www.iotworkshop.com - 18 -
HF5111B Serial Server Device User Manual

The HF5111 device Ethernet interface work in WANN functioin by default. When connect to router, it
will get IP address from router(as picture 192.168.1.100). Then the device and the PC1 are in the
same local area network(LAN) for network communication, The data of communication finally pass
from UART to network to control or collect PLC device.

Notes:

The device support RS232/RS422/RS485 interface. Choose one of these three data interface .

3.3. Typical Network Architecture

P
As the following picture, HF5111 and mobile device all connect to the same Router AP. At the same
time, HF5111 connect to user equipment by RS232/RS422/RS485 interface. The whole wireless

O
network is easily to extend in this kind of network structure.

SH
RK
O
W
T
IO

Figure 12. Network application

3.4. Working Mode

3.5.1. Transparent Transmission Mode

The HF5111 Device support transparent transmission mode of serial interface, In this mode, User
only need to set some necessary parameter(network communication parameter). After power on, the

http://www.iotworkshop.com - 19 -
HF5111B Serial Server Device User Manual

device can auto connect to default socket setting(TCP/UDP). Use web page or PC IOTManager
software to set commucation parameter.

P
O
SH
Figure 13. Transparent data transmission example
RK
3.5.2. TCP Server

Transparent transmission mode support TCP Server、TCP Client、UDP Server、UDP Client


O

communication application, UDP Server is special function, Details see following Cli instruction. There
is a default tcp server socket created. The Socket can be modified to work at one of the above working
mode. When Socket works as TCP server, It will support multiple TCP connection(max 5 TCP client).
W

Multiple TCP connection will work in below structure:

Upload data flow: All the different TCP connection or the Client’s data will be continuously transmitter
to UART.
T

Download data flow: All data received from UART will be copied and broadcast to every TCP client.
IO

Detailed multiple TCP connection structure drawing as below:

http://www.iotworkshop.com - 20 -
HF5111B Serial Server Device User Manual

Figure 14. TCP Server data transmission example


The device support max 5 Socket channel, each socket can work individual at TCP/UDP, Multi Socket
simultaneous communication of data stream is as following.

P
Figure 15. Multi Socket data transmission example
Multi Socket can be created through software configure or webpage configure. The below set up 3
socket channel.

O
SH
RK
O
W

Figure 16. Webpage set up multi Socket channel

3.5.3. HTTP Mode


Eport –E10 device support sending data in HTTP format to HTTP server(Set product working mode
by IOTManager software or webpage). When device socket works in HTTP mode, All received UART
T

data will automaticly transform to HTTP format(add HTTP header) and transmit to HTTP server. For
the received HTTP data from HTTP server, will automatically remove HTTP header and only output
IO

the data packet to UART.

http://www.iotworkshop.com - 21 -
HF5111B Serial Server Device User Manual

P
O
SH
RK
Figure 17. IOTManager Software Configure
O
W
T
IO

Figure 18. Web Page Configure

HF5111 UART received“pppp”data, send below data to HTTP Server.


GET /abcdefg HTTP/1.1
api-key: A4hQnojCHf8PurykvCHvsQ4JCMM=

pppp

http://www.iotworkshop.com - 22 -
HF5111B Serial Server Device User Manual

HTTP Server send below data, HF5111 serial output“abcde”


GET /abcdefg HTTP/1.1
api-key: A4hQnojCHf8PurykvCHvsQ4JCMM=

abcde

P
O
SH
RK
Figure 19. HTTP transmit example

3.5.4. Telnetd Mode


O

When device work in Telnetd mode, UART port can connect to user device console port(some
gateway and switch device may have this console port to set parameters of its working mode). May
W

use HF5111 to config user device via Telnetd mode.


T
IO

http://www.iotworkshop.com - 23 -
HF5111B Serial Server Device User Manual

P
O
SH
Figure 20. IOTManager Software Configure Protocol
RK
O

Figure 21. Web page configure protocol

Connect device UART to user device console port(The example use NC916) and create Telnet
W

connection. Then It can directly configure user device.


T
IO

http://www.iotworkshop.com - 24 -
HF5111B Serial Server Device User Manual

Figure 22. Telnet details example

3.5. AES/DES3/TLS Data Encryption

To improve device security and ensure the data won’t be cracked and illegal used, The HF5111
device can do encryption to UART data before transmit to network.

P
O
SH
RK
O

Figure 23. IOTManager Software Configure Encryption


W
T
IO

Figure 24. Web Page Configure Encryption

3.6. Keepalive

When TCP connection between device and server became abnormal. The device will check the
obnormal status and reconnect to server ( when the device working in TCP Client Mode), When the
device working in TCP Server, It will break the TCP client and wait for next connection.

http://www.iotworkshop.com - 25 -
HF5111B Serial Server Device User Manual

P
O
Figure 25. Web Page Config Keepalive

SH
3.7. Timeout

The device will break the TCP connection after some time(default is 300 seconds and it can be
modified)if there is no data packet received from DES3tination TCP target . It will reconnect to
server(When device works in TCP Client mode). When device working in TCP Server, It will
RK
disconnect with TCP Clien. This mechanism can effectively restore TCP abnormal connection.If set it
to “0”, this function will be close.
O
W
T

Figure 26. Web Page Configure Timeout


IO

3.8. Route Setup

The data received from Socket channel can be set to another socket channel. (Default: socket
DES3tination channel is UART, It also can be other Socket channel, Or take the Socket as log print
usage)

The below example shows the default netp Socket channel route setting to Socket1, Socket1
configure as TCP Server mode and route setting to UART. So the netp Socket channel received
UART data will output to Socket1, and Socket1 channel will output to serial output.

http://www.iotworkshop.com - 26 -
HF5111B Serial Server Device User Manual

P
O
SH
Figure 27. Route function setup example
RK
O
W

Figure 28. Route Function Data Flow Example

3.9. UART Frame Scheme


T

3.9.1. UART Free-Frame


IO

HF5111 support UART Free-Frame function, If user select to open this function,Module will check the
intervals between any two bytes when receiving UART data, If the interval time exceed the setting
value, It will think it as the end of one frame, Or it will receive data utill greater than internal buffer
bytes( Default: 512, the largest 1400 bytes), then transfer to Socket Channel.

Module default UART Free-Frame interval time is 50ms, it will packaged into another frame if received
UART data interval time is greater than 50ms. User also can set this interval time to minimum 10ms
through Cli command and webpage.

If interval time is set to 10ms and customer MCU cann’t send next byte within 10ms, The serial data
will be break into two frame.

http://www.iotworkshop.com - 27 -
HF5111B Serial Server Device User Manual

Figure 29. UART free-frame function

3.9.2. UART Auto-Frame

HF5111 support UART Auto-Frame function, If user select to open this function,setting frame tigger
length and auto frame trigger time parameters, Then the product will auto framing the data which

P
received from UART port and transmitting to the network as pre-defined data structure.

O
Auto-Frame trigger length: The fixed data length that product used to transmitting to the network.

Auto-Frame trigger time: After the trigger time, If UART port received data cann’t reach auto-frame

SH
trigger length, Then product will transmitting available data to network and bypass the auto-frame
trigger length condition.

Received Received trigger


first Byte length Byte
RK
1. Wait after last time Data transfer Auto-Frame
Start Computing time
forward complete to network trigger time

Received Received under


first Byte trigger length Byte
2.
O

Wait after last time Auto-Frame trigger


Start Computing time
forward complete timeout, The received data
forward to network.
W

Figure 30. UART Auto-Frame Function


T
IO

Figure 31. UART Auto-Frame Function

3.9.3. Tag Function

Eport E10 support lable function, If user select to open this function, The UART port will send all
suitable one frame data to network.

http://www.iotworkshop.com - 28 -
HF5111B Serial Server Device User Manual

P
Figure 32. UART Auto-Frame Tag Function

O
3.10. Modbus Protocol

HF5111 support ModbusRTU to ModbusTCP and ModbusTCP to ModbusRTU. It’s very convenient to

SH
connect with Modbus device. Modbus protocol setting as below:
RK
Figure 33. UART Modbus Function
O

3.11. Cli Command


W

Cli command is used for setting module configure parameters. Detailed command function and setting
is in next chapter, Cli command can be set through UART port or Telnet function (Appendix C), The
waiting time of below picture means use timeout time. If it exceed default 300s when no Cli command
is input, it will exit Cli command mode. When the HF5111 receive continuous UART data of “+++”, it
T

will enter into Cli command. ( The device working in transparent transmission mode by default) May
also set the device working in Cli command mode by default or disable this function .
IO

http://www.iotworkshop.com - 29 -
HF5111B Serial Server Device User Manual

Figure 34. Cli Command Setting

3.12. UART Flow Control and RS485 Function

HF5111 support software and hardware UART flow control. If use hardware follow control, must use
RS232 interface. If use software follow control, then It allowed the device output UART data after
receive single UART 0x11 data(Default: value can be modified). It will stop output UART data after
receive single UART 0x13 data(Default: value can be modified).

P
O
SH
Figure 35. UART Flow Control

If set to “Half Duplex”, the product enable RS485 interface, it is by default enabled.
RK
Figure 36. UART Half Duplex Function
O

3.13. Firmware Upgrade


W

HF5111 support OTA(over the air) firmware upgrade. User can use webpage to upgrade its firmware,
whether external or internal webpage(192.168.0.101/hide. Internal webpage can be used for upgrade
external webpage). Please check below example. IP address is assigned by router.
T
IO

Figure 37. External web page

http://www.iotworkshop.com - 30 -
HF5111B Serial Server Device User Manual

P
Figure 38. Internal web page

O
3.14. Web Page Function

SH
Web page function can be enabled or disabled.
RK
Figure 39. Web Page Function Setting
O

3.15. Auto-IP Function


W

Connect device Ethernet with PC, the device will use default auto IP. The PC may use this IP to
config the device or transfer data(PC will need about 15 seconds to use default 169.254.xxx.xxx IP,
then this communication can be created). As the following example, 169.254.173.207(If occure IP
conflict, it will use other ip instead)
T
IO

Figure 40. AUTO-IP Connection

http://www.iotworkshop.com - 31 -
HF5111B Serial Server Device User Manual

P
Figure 41. AUTO-IP Config Device

O
SH
RK
Figure 42. Cli Command Query Device IP

3.16. Other Function


O

The HF5111 device parameters can be exported and loaded into other equipment..
W
T
IO

Figure 43. Other Function

http://www.iotworkshop.com - 32 -
HF5111B Serial Server Device User Manual

3.17. NTP Function

Support NTP function(default is disabled). Support set NTP server, port, time zone information, more
detailed usage see application document of “UART Fast Config”.(112.124.43.15 is High-Flying test
NTP server)

P
O
SH
Figure 44. IOTManager Tools NTP Setting
RK
O
W

Figure 45. Cli Command NTP Setting and Query

3.18. Heartbeat Function


T

Support heartbeat function, can set the heartbeat time and content(heartbeat time is the same as
keepalive setting), if the product does not receive data from TCP server within heartbeat time, it will
IO

send heartbeat to server. The heartbeat function can only be enabled when socket is set as TCP client.

Figure 46. Heartbeat Function

http://www.iotworkshop.com - 33 -
HF5111B Serial Server Device User Manual

3.19. UART Fast Config

Product support Cli command to config its parameters, but also support special HEX format UART
data for fast config, see application manual for detailed usage.

P
O
SH
RK
O
W
T
IO

http://www.iotworkshop.com - 34 -
HF5111B Serial Server Device User Manual

4. CLI COMMAND NOTES

4.1. Working Mode

The device will enter into default transparent transmission mode after powered on. User can switch to
Cli command mode through special UART data. Module default UART parameters are as below:

P
O
SH
RK
O

Figure 47. HF5111 Default: UART Parameters


W

In Command mode, User can use UART port to set module through Cli command.

Notes:
T

We recommend to use SecureCRT for UART debug tools.


IO

4.1.1. Switch Transparent Transmission Mode to Cli Command Mode

Steps:
 Input “+++” via UART tools, the device will output “EPORT>” after received“+++”. Then the
device already enters into Cli command mode.

Notes:

”+++” should be in one frame. Other data is not allowed before or after “+++”

http://www.iotworkshop.com - 35 -
HF5111B Serial Server Device User Manual

P
O
<Notes>: SH
Figure 48. Switch Transparent Transmission Mode to Cli Command Mode
RK
In Cli command mode, users can set or query parameters. Cli command details see next chapter

4.2. Cli Command Overview


O

Cli command can be input through terminal (SecureCRT or other UART tools) or by user device MCU
programming. As below picture, we use SecureCRT tool. Press “Tab” key, it will list current available
Cli command or directory. If intput first character and then press “Tab” key, it will show the Cli
W

command fit with the first character.


T
IO

Figure 49. Cli Command Root Directory

http://www.iotworkshop.com - 36 -
HF5111B Serial Server Device User Manual

P
O
SH
RK
Figure 50. Cli Command SYS Tree
O
W
T
IO

Figure 51. Cli Command UART Tree

http://www.iotworkshop.com - 37 -
HF5111B Serial Server Device User Manual

P
O
SH
RK
O
W
T
IO

Figure 52. Cli Command SOCK Tree

http://www.iotworkshop.com - 38 -
HF5111B Serial Server Device User Manual

Figure 53. Cli Other Command

4.2.1. Cli Command Format

P
Cli command is in ASCII format. The usage is similar to Linux terminal. Command format as following:
 Format Notes

O
 < >: Cli command name or directory.
 [ ]: Cli command parameters.

SH
 Command Message
<CMD> [para-2 para-3 para-4…]<CR>
 <CMD>: Main directory or command name;
 [para-n] : command parameters. If have multiple directory, it can also can be the son
directory. As below example;
RK
 <CR>: Command Terminator, “Enter” key, HEX data: 0x0a or 0x0d
<Notes>
If the input command not existed, UART will output again “EPORT>” to allow next command input.
O

The Cli command is case sensitive.


W

If need enter into son directory, press “space” key between the directorys.
T

If need to display all the directory or commands in the current directory, press “Tab” key to query.
IO

If need to display current command parameter, press Tab key to query.

4.2.1.1. Show Command


 Function: Show all system information, including the system running status, Network
status, UART status and socket status.
 Format:
 Query

http://www.iotworkshop.com - 39 -
HF5111B Serial Server Device User Manual

Show [SYS/UART/SOCK]
 Parameter:
Show all information if no parameters. Parameter can be one of the following:
 SYS: System running status
 UART: UART status
 SOCK: Socket status

P
O
4.2.1.2. SYS Directory
 SH
Function: Display/Set all system related information
RK
 Format:
 Tab Query
O

4.2.1.3. SYS/Auth Directory


 Function: Display/Set web or Telnet Cli command login directory. (see appendix for
W

detail)
 Format:
 Tab Query
T

4.2.1.4. SYS/Auth/User Command


IO

 Function: Display/Set web or Telnet Cli command login user name. (function see
appendix)
 Format:
 Query
<User>
 Set
<User> [value]
 Parameter:
Setting is valid immediately.
 User: Login user name. Default: admin

http://www.iotworkshop.com - 40 -
HF5111B Serial Server Device User Manual

 value: set value. Length range 1~29 characters

4.2.1.5. SYS/Auth/Password Command


 Function: Display/Set web or Telnet Cli command login password(function see appendix)
 Format:
 Query
<Password>
 Set
<Password> [value]
 Parameter:

P
Setting is valid immediately
 Password: Login password. Default: admin
 value: set value. Length range 1~29 characters

O
4.2.1.6. SYS/Network Directory

SH
Function: Display/Set related network information.
 Format:
 Tab Query
RK
4.2.1.7. SYS/Network/Show Command
 Function: Display network related information
 Format:

O

Query
<Show>

4.2.1.8. SYS/Network/DHCP Command


W

 Function: Display/Set DHCP Client function


 Format:
 Query
<DHCP>
T

 Set
<DHCP> [Enable/Disable]
IO

 Parameter:
Setting is valid after reboot.
 Enable: Enable DHCP function. The device will get DHCP IP from router when
Ethernet port is connected to router LANN port. Default: Enable.
 Disable: Disable DHCP function. Allocate device static IP address according to the
hit of intputting IP and gateway address.

4.2.1.9. SYS/Network/DNS Command


 Command: Display/Set DNS IP address.
 Format:
 Query

http://www.iotworkshop.com - 41 -
HF5111B Serial Server Device User Manual

<DNS>
 Set
<DNS> [IP]
 Parameter:
When DHCP function is Disabled, this setting is valid. Setting is valid after reboot.
 IP Address: DNS server address. Default: 10.10.100.254.

4.2.1.10. SYS/Network/Hostname Instruction


 Function: Display/Set Hostname.
 Format:

P
Query
<Hostname>
 Set

O
<Hostname> [name]
 Parameter:

SH
Hostname is the name which show in router DHCP client list. Setting is valid
immediately.
 Name Address: Hostname, length range: 1~30 characters. Default: HF5111.

4.2.1.11. SYS/Telnet Instruction


RK
 Function: Display/Set Telnet function.
 Format:
 Query
<Telnet>

O

Set
<Telnet> [Enable/Disable]
 Parameter:
W

See appendix for detailed Telnet function usage. Telnet is used for remote send Cli
command or transmit data, Setting is valid after reboot.
 Enable: Enable Telnet function. Default: Enable.
 Input Port Numbver: Telnet Port Number. Default: 23
 Input Echo Mode: Enable/Disable Cli command echo function. Default: Enable
T

 Disable: Disable Telnet function.


IO

4.2.1.12. SYS/Web Instruction


 Function: Display/Set Web config function.
 Format:
 Query
<Web>
 Set
<Web> [Enable/Disable]
 Parameter:
Webpage is used for config module working parameters. Setting is valid after reboot.
 Enable: Enable Web config function. Default: Enable.

http://www.iotworkshop.com - 42 -
HF5111B Serial Server Device User Manual

 Input Port Number: Web Port Number. Default: 80


 Disable: Disable Web config function

4.2.1.13. SYS/MAC Instruction


 Function: Display/Set MAC address.
 Format:
 Query
<MAC>
 Set
<MAC> [8888 value]

P
Parameter:
Global unique MAC Address. It is not allowed to modify it.
 value: MAC address value.

O
4.2.1.14. SYS/JCMD Instruction

SH
Function: Display/Set Jason command function.
 Format:
 Query
<JCMD>
 Set
RK
<JCMD> [Enable/Disable]
 Parameter:
Jason command is used for config module. IOTManage software use this mechanism. If
disable JCMD function, IOTManage is no longer valid. Setting is valid after reboot.

O

Enable: Enable JCMD function. Default: Enable.


 Disable: Disable JCMD function.
W

4.2.1.15. SYS/NTP Instruction


 Function: Display/Set NTP function.
 Format:
 Query
<NTP>
T

 Set
<NTP> [Enable/Disable]
IO

 Parameter:
NTP is used for product to get and output real time. See uart fast config application
manual to fast query. Setting is valid immediately.
 Enable: Enable NTP Function.
 NTP Server Address: NTP Server address, domain name or IP address
 NTP Server Port: port number, Default:123, Range;0~127
 GMT: Time zone, default is 0, Range:-12~12.
 Disable Disable NTP Function, Default value.

4.2.1.16. UART Directory


 Function: Display/Set UART information directory.

http://www.iotworkshop.com - 43 -
HF5111B Serial Server Device User Manual

 Format:
 Tab key query

4.2.1.17. UART/Show Instruction


 Function: Display UART information function.
 Format:
 Query

P
<Show>

4.2.1.18. UART/Baudrate Instruction

O
 Function: Display/Set UART baud rate function.
 Format:

SH
Query
<Baudrate>
 Set
<Baudrate> [value]
 Parameter:
RK
Setting is valid immediately.
 Value: Default: 115200. Can choose 2400, 4800, 9600, 38400, 57600, 115200,
230400, 460800

4.2.1.19. UART/Databits Instruction


O

 Function: Display/Set UART data bits function.


 Format:
W

 Query
<Databits>
 Set
<Databits> [value]
 Parameter:
T

Setting is valid immediately.


 Value: Default: 8bits. Can choose 5, 6, 7, 8.
IO

4.2.1.20. UART/Stopbits Instruction


 Function: Display/Set UART stop bits function.
 Format:
 Query
<Stopbits>
 Set
<Stopbits> [value]
 Parameter:
Setting is valid immediately.
 Value: Default: 1bits. Can choose 1, 1.5, 2.

http://www.iotworkshop.com - 44 -
HF5111B Serial Server Device User Manual

4.2.1.21. UART/Parity Instruction


 Function: Display/Set UART parity function.
 Format:
 Query
<Parity>
 Set
<Parity> [value]
 Parameter:
Setting is valid immediately.
 Value: Default: None. Can choose NONE, EVEN, ODD.

P
4.2.1.22. UART/Buf Directory

O
Function: Display/Set UART Buffer directory.
 Format:
 Tab key query

4.2.1.23. UART/Buf/Bufsize Instruction


 SH
Function: Display/Set UART buffer size function.
RK
 Format:
 Query
<Bufsize>
 Set
O

<Bufsize> [value]
 Parameter:
Buffer is used for cache UART received data. If the received data of one frame is larger
W

than buffer size. The data frame will be break into two packet send to network. Setting is
valid after reboot.
 Value: Default: 512. Length range: 32~1400 bytes.

4.2.1.24. UART/Buf/GapTime Instruction


T

 Function: Display/Set UART free frame gap time.


 Format:
IO

 Query
<GapTime>
 Set
<GapTime> [value]
 Parameter:
GapTime is used for setting UART free frame time gap. If the received data gap time is
more than setting value, the data packet will be breaked into two frame.
 Value: Default: 50ms. Length Range: 10~1000ms.

http://www.iotworkshop.com - 45 -
HF5111B Serial Server Device User Manual

4.2.1.25. UART/Buf/FlowCtrl Command


 Function: Display/Set UART flow control function.
 Format:
 Query
<FlowCtrl>
 Set
<FlowCtrl> [Enable/Disable]
 Parameter:
Flow control includes software flow control and hardware flow control. Software flow
control priority is higher than hardware. If enable software flow control, the hardware

P
flow control pin(CTS/RTS) will be useless. Software flow control use special UART data
for control. Hardware flow control use CTS/RTS pin control. Setting is valid immediately.

O
 Flow Control: Flow control function.
 Half-Duplex: Enable RS485 half-duplex function, UART0_RTS is used for RS485
chip control function.

SH
 Disable: Flow control function. Default: Disable.

4.2.1.26. UART/Buf/SWFlowCtrl Command


 Function: Display/Set UART software flow control function.
 Format:
RK
 Query
<SWFlowCtrl>
 Set
<SWFlowCtrl> [Enable/Disable]
O

 Parameter:
Enable software flow control function. The device UART can output data After UART
received Xon single-byte enable data. When UART received Xoff single-byte disable
W

data. It will disable the device UART output data.


 Enable: Enable software flow control function, When in enable status, it allow
UART data output when bootup by default.
 Xon: Enable UART output data. Default: 0x11.
 Xoff: Disable UART output data. Default: 0x13.
T

 Disable: disable software flow control function. Default: Disable.


IO

4.2.1.27. UART/Cli-Getin Command


 Function: Display/Set Cli command function
 Format:
 Query
<Cli-Getin>
 Set
<Cli-Getin> [Serial-String/Always/Disable]
 Parameter:
Set Cli command parameters. Setting is valid immediately.
 Serial-String: Enable specific data to enter into Cli command mode.

http://www.iotworkshop.com - 46 -
HF5111B Serial Server Device User Manual

 [Input Serail String]: Default: +++, Range1~10 bytes. Also can input hex
format data. The HEX data are separated by Spaces, Like【30 31 32 33 34】,
When it recieved string data “01234”, then It can enter into Cli command.
 Always: Always work in Cli command mode when device power on.
 Disable: Disable Cli command mode. UART and Telnet both can’t use Cli
Command.

4.2.1.28. UART/Cli-WaitTime Command


 Function: Display/Set Cli command wait time
 Format

P
<Cli-WaitTime>
 Set
<Cli-WaitTime> [timeout]

O
 Parameter:
Set Cli command mode timeout exit time. If there is no Cli command sent for the

SH
waitfime, It will exit Cli command mode to transparent transmission, Setting is valid
immediately.
 timeout: Default: 300s, Range 0: Disable WaitTime function, 1~300s.

4.2.1.29. UART/Proto command


RK
 Function: Display/Set UART protocol function
 Format:
 Query
<Proto>

O

Set
<Proto> [NONE/Modbus/Frame]
 Parameter:
W

Setting is valid immediately.


 NONE: Default: None, transparent transmission, the received UART data will be
directly sent to network.
 Modbus: Modbus RTU to Modbus TCP.
 Frame: Enable auto-frame function. Relevant parameters are set in Frame
T

command.
IO

4.2.1.30. UART/Frame Directory


 Function: Display/Set UART frame directory.
 Format:
 Tab key query

4.2.1.31. UART/Frame/FrameLen Command


 Function: Display/Set UART auto-frame frame length
 Format:
 Query

http://www.iotworkshop.com - 47 -
HF5111B Serial Server Device User Manual

<FrameLen>
 Set
<FrameLen> [value]
 Parameter:
Set UART auto-frame length, Setting is valid immediately.
 value: Default: 8, Range: 8~1400.

4.2.1.32. UART/Frame/FrameTime Command


 Function: Display/Set UART auto-frame time
 Format:

P
Query
<FrameTime>
 Set

O
<FrameTime> [value]
 Parameter:

SH
Set UART auto-frame time, Setting is valid immediately.
 value: Default: 100ms, Range: 100~10000.

4.2.1.33. UART/Frame/Tag Command


 Function: Display/Set UART auto-frame Tag
RK
 Format:
 Query
<Tag>
 Set
O

<Tag> [Enable/Disable]
 Parameter:
Set UART auto-frame tag. Only transmit data from tag head to tag tail. Filter the other
W

datas. Setting is valid immediately.


 Enable: Enable auto-frame tag function.
 TagHead: LabelHead. Default: 0x55, Single byte data.
 TagTail: LabelTail. Default: 0xAA, Single byte data.
 Disable: Default: Value.
T

4.2.1.34. UART/Edit Command


IO

 Function: Set UART parameter


 Format:
 Set
<Edit> [baudrate databits stopbits parity]
 Parameter:
Set all UART communication parameter including baud rate, data bit, stop bit and parity.

4.2.1.35. UART/Clean Command


 Function: Clear UART transmit-receive data information
 Format:
 Set

http://www.iotworkshop.com - 48 -
HF5111B Serial Server Device User Manual

<Clean>
 Parameter:
Clear the UART data count(Data packet/Frame/Error packet and so on) shown in
webpage.

4.2.1.36. SOCK Directory


 Function: Display/Set Socket channel directory.
 Format:
 Tab key query

P
Netp and UDP are created socket channel. Itsupport maximum 5 Sockets.

O
4.2.1.37. SOCK/Show Command
 Function: Display Socket information function.

SH
Format:
 Query
<Show>

4.2.1.38. SOCK/New Command


RK
 Function: Set new Socket information
 Format:
 Set
<New> [name]

O

Parameter:
There is a default socket created(netp). It support max 5 socket channel. Every channel
can be set as TCP/UDP/HTTP and so on. Setting is valid immediately.
W

 Name: Socket name. Range 1~19 characters.


 Input Sock Proto: Choose one communication method of the following.
 TCP-SERVER: TCP Server Mode. It support max 5 TCP Client
connection.
 TCP-CLIENT: TCP Client Mode. It is used for connecting server.
T

 UDP-SERVER: UDP Server Mode. Special function. Product will record


the last received UDP package source IP and Port information. The
IO

received UART data will be send to this IP and port, not the setting
DES3tination.
 UDP-CLIENT: UDP Client Mode.
 HTTP: HTTP Protocol transmission. The received UART data will
transform to HTTP format and it will remove the HTTP header information
and only output the HTTP data to UART.
 TELNETD: Telnetd Mode. Use Telnet to config the UART Console
equipment.
 TLS: Function is reserved. We will update it soon.
TCP Server Mode:

http://www.iotworkshop.com - 49 -
HF5111B Serial Server Device User Manual

 Input Local Port[0]: Set local port, Range 1~65535, 0 is random port. For
TCP Server and UDP application, set it to a fixed 1~65535(TCP port 80 is
used for its webpage). For TCP Client application, usually set it to 0.
 Input Buffer size[512]: Set Buffer size. Default: 512 bytes, Range:1~1400.
 Input KeepAlive[60]: Set TCP keepalive, Heartbeat time, Defalut 60s,
Range: >=0.
 Input Timeout[300]: Set TCP timeout, If exceed setted time and don’t received
any network data package, It will break TCP connection. If working in TCP
client mode, it will reconnect immediately. If it work in TCP server mode, the
TCP client need to create the connction. Set this value to 0 is to close the

P
function. The function is used for TCP to restore abnormal connection.
Recommend to enable. Default: 300s, Range 0~600.
 Input Sock Security[Disable]: Security options, Used for data special

O
encryption. Default: disable no encryption.
 Disable: No encryption

SH
 TLS: TLS1.2 encryptioin, only support in TCP client mode.
 AES: AES encryption, TCP/UDP all support this.
 DES3: DES3 encryption, TCP/UDP all support this.
 Input key: AES or DES3 key. For AES encryptiont, the key is fixed
16 bytes length, the IV value is the same as key. For DES3
RK
encryption, the key is fixed 24 bytes length, the IV value the first 8
Bytes of key. The key can be ASCII or Hex format data. Hex format
data need to use “space” character as separator, ex, “01 02 03…”
 Input Rout[uart]: Set the Socket channel output, Can choose UART and other
O

created Socket or use as Log print using.


TCP Client Mode ( Only list out difference)
 Input Server Address: Set server IPv4 address or domain name.
W

 Input Server Port: Set server port


 Input Local Port[0]: Same as above
 Input Buffer size[512]: Same as above
 Input KeepAlive[60]: Same as above
 Input Timeout[300]: Same as above.
T

 Input Sock Security[Disable]: Same as above


 Set HeartBeat[Disable]: Set Heartbeat function, default is Disable
IO

 Input HeartBeat Serial[F0FE6B1C3D35]: Set Heartbeat content, default is


MAC address
 Input Connect Mode[Always]: Set TCP Client connection mode
 Always: TCP persistent connection. If TCP break, it will reconnect
immediately.
 Burst: It will establish connection once UART received data. If set stop
function, It will disconnect after network received stop data.
 Input Stop Serial: Set Burst Mode Stop bits. It can be ASCII or Hex
format data, Hex format data need use space as separator , 1~10
bytes.

http://www.iotworkshop.com - 50 -
HF5111B Serial Server Device User Manual

 Input Rout[uart]: Same as above


UDP Server/ UDP Client
HTTP Mode
 Input HTTP type[POST]: HTTP request type. Default: POST. Can choose
POST or GET.
 Input HTTP path[/]: HTTP request path, Need start by“/”. The longest byte is
63 bytes.
 Input HTTP version[1.0]: HTTP Protocol Version. Default: 1.0, Can choose
1.0 or 1.1
 Input HTTP parameters: Add HTTP head information, end by “Enter” key.If
want to end the input, direct input “Enter” key. All HTTP header data length

P
should be less than 250 bytes.

O
4.2.1.39. SOCK/netp directory
 Function: Display/Set Socket netp channel directory.

SH
 Format:
 Tab key query
RK
Every created Socket channel can be modified through name. The above command
function is the same as New Socket command description

4.2.1.40. SOCK/netp/clean Command


O

 Function: Clear netp channel data packets information


 Format:
W

 Set
<Clean>
 Parameter:
The network data packets information can be checked from webpage. The command
will reset the data count.
T

4.2.1.41. DATA Directory


IO

 Function: Display/Set Cli command mode communication


 Format:
 Tab Query

Default: data sent in ASCII format. Also can change to send by HEX, The command is
used for Cli command mode to transfer data.

4.2.1.42. Restart Command


 Function: Restart instruction.
 Format:

http://www.iotworkshop.com - 51 -
HF5111B Serial Server Device User Manual

 Set
<Restart>

4.2.1.43. Reload Instruction


 Function: Restore Factory setting instruction.
 Format:
 Set
Reload [SYS/UART/SOCK]
 Parameter:
Reload to factory setting, if add the following parameters, it will only restore

P
corresponding parameters. Parameter can including one of the below three:
 SYS: Restore system setting relevant paramter
 UART: Restore UART setting relevant paramter

O
 SOCK: Restore Socket relevant paramter

4.2.1.44. Exit Command

SH
 Function: Exit Cli Command mode instruction
 Format:
 Set
<Exit>
RK
4.2.1.45. Quit Command
 Function: Quit the current and go the father Cli command directory.
 Format:

O

Set
<Quit>

4.2.1.46. FwUpgrade Instruction


W

 Function: Upgrade product firmware.


 Format:
 Set
FwUpgrade [url]
T

 Parameter:
Do upgrade function, if upgrade success, it will feedback “Upgrade OK”, if fail, output
IO

“Upgrade FAIL”, reboot to run with new firmware if success


 url: firmware url resources, Ex: http://192.168.0.101/mfw.bin

http://www.iotworkshop.com - 52 -
HF5111B Serial Server Device User Manual

APPENDIX A:REFERENCES

A.1.Test Tools

IOTManager Configure Software:

http://gb.hi-flying.com/downloadsfront.do?method=picker&flag=all&id=8c366199-b599-47a4-8d9c-
20fa0b68bfcf&fileId=89&v=0.zip

P
O
SH
RK
UART、Network Test software:

http://www.hi-
flying.com/download_list_dc/&downloadcategoryid=14&isMode=false&comp_stats=comp-
O

FrontDownloadsCategory_show01-1376450727769.html

B.3.Quick Start Manual


W

See our product application on website:

http://www.hi-flying.com/products_detail/productId=96.html
T
IO

http://www.iotworkshop.com - 53 -
HF5111B Serial Server Device User Manual

APPENDIX B:TELNET COMMUNICATION


FUNCTION
B.1.Telnet Use Scene:
a)Remote management device

b)Remote management uart equipment

B.2.Telnet Features:

P
a)Telnet support echo mode,

O
b)Telnet only support one Client port.

c)Telnet port number is 23

SH
d)Telnet connected with TCP, If Client port don’t transmit data in 300s, It will auto

disconnect.
RK
B.3.Telnet Usage:

Telnet function default as ON, If can’t connect, Pls use webpage or configuration to check the
function is on or off.
O
W

a)Configure Secure CRT module and connect parameter, Equipment need to connect
T

with LAN, Can use equipment LAN IP to access , If need remote to access the
IO

equipment, It need router have public IP address as port and mapped to internal

website, Then can remote access equipment.

http://www.iotworkshop.com - 54 -
HF5111B Serial Server Device User Manual

P
O
SH
b)Use webpage account and password login in module, Then interface will show
RK
“EPORT>” .
O
W
T
IO

c)Later use are same as UART cli command, And can realise Telnet data with UART

data transparent transmission application.,

http://www.iotworkshop.com - 55 -
HF5111B Serial Server Device User Manual

P
O
Telnet Software implementation principle:

SH
Step 1 Establish TCP connection with module
RK
Step 2 Module send “login”, Client port send user name(need end with Enter key,Tools

can type Ctrl+Enter)


O
W
T
IO

Step 3 Module send 0xFF 0xFB 0x01 Close telnet input display.

Step 4 Module send password, Client port send login password

http://www.iotworkshop.com - 56 -
HF5111B Serial Server Device User Manual

Step 5 Module send 0xFF 0xFC 0x01 Open telnet input display

P
O
SH
RK
Step 6 It can send and receive Cli command After Enter into Cli command mode.
O
W
T
IO

http://www.iotworkshop.com - 57 -
HF5111B Serial Server Device User Manual

APPENDIX C: CONTACT INFORMATION

------------------------------------------------------------------------------------------------------------
Address: Room 1002,Building 1,No.3000,Longdong Avenue,Pudong New
Area,Shanghai,China,201203
Web: www.iotworkshop.com or www.hi-flying.com
Contact:

P
Sales: sales@iotworkshop.com
Support: support@iotworkshop.com

O
Service: service@iotworkshop.com
Business: business@iotworkshop.com
---------------------------------------------------------------------------- -------------------------------

SH
For more information about IOTworkshop modules, applications, and solutions, please visit our web
site www.iotworkshop.com
RK
O

<END OF DOCUMENT>
W
T
IO

http://www.iotworkshop.com - 58 -

You might also like