The ZY-128 (TCP) network card reader

user's guide

catalogue
Product overview ......................................................................................................................2、3
Product upgrade instructions ..........................................................................................3、4
Configure the installation and use of the software ..........................................5、6、7
TCPClient pattern .................................................................................................................8、9、10
TCPServer pattern .................................................................................................................11、12
UDPClient pattern ..................................................................................................................13、14
UDPServer pattern .................................................................................................................15、16
HTTPClient pattern ................................................................................................................17、18
MQTTClient pattern .........................................................................................................19、20、21
ModbusGateway pattern ..........................................................................................................22
Reader instructions instructions ..................................................................................23、24

Version Number (V1.01)

2024.2.22
 Product overview
ZY-128 (TCP) network card reader is an integrated TCP Client, TCP
Server, UDP Client, UDP Server, HTTP Client, MQTT, Modbus
gateway, you can update and switch back and forth between
different versions.
V0.0.1: Support for Modbus gateway;
V0.0.2: Support for MQTT Client;
V0.0.3: Support for HTTP Client;
V0.0.4: TCP / UDP is supported or above. The larger the version
number is, the more new the firmware is.

essential parameter:
working voltage DC12V
working current <50mA
working
-40 ~ 85 degrees C
temperature
Working
10% ~ 90% RH (no condensation)
humidity
size 84X84X20mm
Type of card
EM (ID), MF (IC) dual frequency
reading
10 mmpsT (X) ten MB adaptive RJ 45 interface,
Ethernet
cross / through network cable adaptation, built-in
specifications
network transformer
The factory already has a unique MAC address
MAC address
and supports user customization
ARP, DHCP, TCP Client, TCP Server, UDP Client,
networking
UDP Server, HTTP Client, MQTT, and Modbus
protocol
gateway
Parameter
String mouth, network
configuration
IP acquisition
Static / dynamic
method
DNS domain
support
name resolution
Custom
Registration support
Pack
Custom Serial ports / network all support custom
heartbeat pack heartbeat packets
firmware support
 upgrade
One key to
restore the support
factory Settings
electric relay Group 1

point out

All the products publicly sold by our company will be continuously

maintained and iterated, so that you can enjoy the better
experience brought by the product upgrade at any time. You can
switch back and forth between new and older versions by updating
the product firmware for a different experience

Product upgrade method

1. If the product has an Ethernet interface, then find a router that
can access the Internet and connect the product to the LAN port of
the router (if you have a static IP for the product, you need to pay
attention to whether the router is in the same network segment; if a
dynamic IP, enable the DHCP IP) and power on (purchased after July
24,2022 is a new version, support additional local LAN upgrade, no
more router and access to the Internet. However, it should be noted
that you need to turn off the computer firewall, anti-virus software
and 360 security suite, and if you need to set the product and the
computer to the static IP of the same network segment.）。
2. 2. If the product has a 4G or WiFi interface, then plug in a SIM
card that can access the Internet or connect to a WiFi router that
can access the Internet.
3. 3. After searching the product with the configuration software,
click the "Upgrade firmware" button below the device list and select
the firmware version you want. Click "OK" for the product to
upgrade, and you will see the status indicator will flash quickly. The
upgrade process usually lasts for tens of seconds. When the status
indicator no longer flashes quickly and the upgrade is successful or
failed, the device will automatically restart.
4. 4. Search the product with the configuration software and see if
the firmware version number in the device list has been upgraded to
the version you want.
5. 5. If the upgrade is not successful, it may be because the product
is doing large load communication in the mode you configured. At
this time, you need to remove the heavy load communication task
and try the above operation to upgrade again.
6. 6. After the upgrade, you may need to upgrade the configuration
software before you can enjoy the new experience of the new
features. The upgrade method is to click "Help" in the upper left
corner of the software- -> "Check for updates" while ensuring that
your PC has access to the Internet

pay attention to

During the firmware upgrade, the product will download the

upgrade file from our server for upgrade, so please make sure that
the product can access the Internet (purchased after July 24,2022 is
a new version, additional support for local LAN upgrade, no longer
need for router and access to the Internet. However, it should be
noted that you need to turn off the computer firewall, anti-virus
software and 360 security suite, and if you need to set the product
and the computer to the static IP of the same network
segment.）。Configuring the software requires obtaining the available
version of this product from our server, so make sure that this
computer where you run the configuration software can access the
Internet.
Configure the installation and
use of the software
Hardware connection
1. set up an electric circuit.
2. 2. Connect this product to your PC / router / switch with a network
cable (through the network configuration).
3. 3. Connect the serial port to the computer (through the serial port
configuration).
4. 4. Either one of the second and third of the above connections is
suitable for you.

Parameter configuration
point out

You need to be clear that your application uses a network protocol

(TCP, UDP, HTTP, HTT, MQTT, Modbus), otherwise you will not be
able to use the product and will not need to read later.

pay attention to

After modifying the parameters, please click "Submit Settings" - - ->

"Restart effective".
The product can be configured with a LAN or a serial port

Use our configuration software configuration

Configuring through the network

Connect the product to the router or computer through

the network cable (the product supports cross / direct network cable
adaptation function), select in the upper left corner of the
configuration software, and click the search button. If the product
works under dynamic IP (dynamic IP is the default) and is connected
to the router, it needs to obtain the IP; If the product works under
dynamic IP and is directly connected to the computer, it needs to
wait 40 seconds to find the device after the network cable, the
device can be found within 3 seconds after the startup and
connection under the static IP. After searching for the device, select
a device from the list to configure it.

Configuration through serial ports

This product has two UART ports. You can configure the

parameters through any UART port in it. Select in the upper left
corner of the configuration software, and select the correct port
rate, data bit, stop bit, and check bit (the default parameter of both
UART ports of this product is 115200 / 8 / N / 1. If you have set the
serial port parameters of this product but do not remember, then
you have two solutions: 1. Release the reload foot for more than 1
second, and the module will be restored to the factory setting; 2.
Check the network cable with the configuration tool.）

TCPClient pattern
dead work
point out

When this product is used as TCP Client, you need to know the IP
address (or domain name) and listening port number of the TCP
Server you built, otherwise you do not need to read subsequent
content.

pay attention to

If this product is in the same local LAN, please confirm whether they
are in the same network segment. Please read about dynamic /
static IP for details
If you create TCP Server with personal computer for testing, please
be sure to close the firewall and antivirus software of personal
computer; if the TCP Server is created with cloud server, please
remember to open the port for your monitoring
After modifying the parameters, please click "Submit Settings" - - ->
"Restart effective".

Configuration steps
1. Working Mode drop-down box select TCP Client.

2. Target IP / Domain Name input box Type the IP address or domain

name of your TCP Server.
3. The Target Port input box type the listening port for your TCP
Server.

4. Type the Local Port input box '0', '0' means that the product will
connect to the target server with a random local port number,
otherwise you may not be able to connect to your TCP Server
normally. If you need to specify a local port, make sure that your
server firewall and antivirus software allow reconnection initiation
with the same port number.

5. After modifying the parameters, please click "Submit Settings" - -

-> "Reart effective" and this product can connect to your TCP Server
server.

Registration package
Users can enable and set up the content and registration method of
the registration package. When enabled and set up, the registration
package is sent to the TCP Server over the network.
1. Use the MAC address or user custom data as a registration
package.
2. The registration package can be set to send after a successful
TCP connection.
3. The registration package can be added to the header of the
packet received by the serial port.
4. Clause 2 and 3 above may be met simultaneously.
5. After modifying the parameters, please click "Submit Settings" - -
-> "Reart Effective".

Heartbeat bag
Users can turn on and set the content of the network heartbeat
packet and the heartbeat interval according to their own needs.
After setting, click "Submit Parameters" - - -> "Reart Effective", and
the product will send your set heartbeat packet to the TCP Server
through the established TCP connection.
 TCPServer pattern
pay attention to

If this product is in the same local LAN, please confirm whether they
are in the same network segment. Please read about dynamic /
static IP for details
After modifying the parameters, please click "Submit Settings" - - ->
"Restart effective" two buttons
 Configuration steps
1. The Working Mode drop-down box, select TCP Server.
2. 2. The Local Port input box types the port you want to listen to
(except 0 and 5002). If you are using our multi-serial product then
be careful not to conflict with local ports in other serial tabs. Also do
not have the same web port in the basic parameters (factory default
is 80).
3. 3. After modifying the parameters, please click "Submit Settings"
- - -> "Reart effective" and then the product can receive TCP Client
access.

Heartbeat bag
Users can turn on and set the content of the network heartbeat
packet and the heartbeat interval according to their own needs.
After setting, click "Submit parameters" - - -> "Reart effective", and
the product will send your set heartbeat packet to all connected TCP
Client through the network at the set frequency.
 UDPClient pattern
pay attention to

If this product is in the same local LAN, please confirm whether

they are in the same network segment. Please read about dynamic /
static IP for details
After modifying the parameters, please click "Submit Settings" - - ->
"Restart effective".
 Configuration steps
1. Working Mode drop-down box select UDP.

2. The Local Port input box types the port you want to listen to
(except 0 and 5002). If you are using our multi-serial product then
be careful not to conflict with local ports in other serial tabs. Also do
not have the same web port in the basic parameters (factory default
is 80).

3. Type the domain name / IP of your opposite device in the Target

IP / Domain Name and Target Port.

4. After modifying the parameters, please click "Submit Settings" - -

-> "Reart effective" two buttons. Then the product can realize the
data transmission on the network and serial ports.

Heartbeat bag
Users can turn on and set the content of the network heartbeat
packet and the heartbeat interval according to their own needs.
After setting, click "Submit parameters" - - -> "Reart Effective", and
the product will send your set heartbeat packet to the target device
through UDP at the set frequency.
 UDPServer pattern
pay attention to

If this product is in the same local LAN, please confirm whether

they are in the same network segment. Please read about dynamic /
static IP for details
After modifying the parameters, please click "Submit Settings" - - ->
"Restart effective".
 Configuration steps
1. Working Mode drop-down box select UDP Server.

2. The Local Port input box types the port you want to listen to
(except 0 and 5002). If you are using our multi-serial product then
be careful not to conflict with local ports in other serial tabs. Also do
not have the same web port in the basic parameters (factory default
is 80).

3. Type the domain name / IP of your opposite device in the Target

IP / Domain Name and Target Port.

4. After modifying the parameters, please click "Submit Settings" - -

-> "Reart effective" two buttons. Then the product can realize the
data transmission on the network and serial ports.

Heartbeat bag
Users can turn on and set the content of the network heartbeat
packet and the heartbeat interval according to their own needs.
After setting, click "Submit parameters" - - -> "Reart Effective", and
the product will send your set heartbeat packet to the target device
through UDP at the set frequency.
 The difference between UDP Server and
UDP Client
Generally, both have the same function, but use UDP Server for
those that do not know that the opposite device IP / port or the
opposite device IP / port will change, because the UDP Server will
track the IP of the device and the source port and use it as the new
target IP and port. In UDP Server mode, if a UDP device sends any
packet of data to the local port of the product, the data received by
the product through the serial port will be sent to the source port of
the device until another UDP device sends data to the product.

HTTPClient pattern

pay attention to

If this product is in the same local LAN, please confirm whether

they are in the same network segment. Please read about dynamic /
static IP for details
After modifying the parameters, please click "Submit Settings" - - ->
"Restart effective".
 Configuration steps
1. Working Mode drop-down box select HTTP Client.

2. Type the domain name / IP and port number of your web server in
the Target IP / Domain Name and the Target Port. Please contact
your web server manager.

3. In the "Request Protocol" drop-down box, select whether to need

encryption or not according to the situation. For this problem, please
contact your web server leader.

4. In the "Request Method" drop-down box, select which way to

access web server with GET / POST according to the situation,
please contact your web server leader.

5. Type the api path for the web server in the Request URL, and
contact your web server leader for this issue.

6. Type the data type specified by web server in the Request

header, such as: Content-Type: text / html; charset = utf-8. If there
are multiple header items, they are separated by return lines.
Please contact your web server manager for this problem.

7. Type the timeout time in milliseconds in the Timeout Response

Time. The function of this parameter is when the web server fails to
complete the set time range and initiate another request based on
whether there is other data in the serial port cache area. The
general recommendation is set to 3,000 ms.

8. If you select https in the Request Agreement, type the public key
content in the HTTPS Public Key column. Please contact your web
server manager.

9. After modifying the parameters, please click "Submit Settings" - -

-> "Reart effective" two buttons. Then the product can realize the
data transmission of the network and serial ports.

MQTTClient pattern
pay attention to

If this product is in the same local LAN, please confirm whether

they are in the same network segment. Please read about dynamic /
static IP for details
After modifying the parameters, please click "Submit Settings" - - ->
"Restart effective".
 Configuration steps
1. Working Mode drop-down box select MQTT.

2. Type the domain name / IP and port number of your MQTT Broker
in the Target IP / Domain Name and the Target Port. For this
problem, please contact your MQTT Broker server leader or service
provider.

3. According to your own situation, decide whether to use the device

id or the custom value as the client id of MQTT Client. For this
problem, please contact your MQTT Broker server leader or service
provider.

4. Fill in the "User name" and "password" for the MQTT Broker
access according to your specific situation. If Broker allows
anonymous access, these two items are empty. For this problem,
please contact your MQTT Broker server leader or service provider.

5. Connection Hold Time is keepalive in seconds in the MQTT

protocol.

6. For other parameters, please contact your MQTT Broker server

manager or service provider.
7. After modifying the parameters, please click "Submit Settings" - -
-> "Reart effective" two buttons. Then the product can realize the
data transmission on the network and serial ports.

# The MQTT of this product supports

unlimited multiple subscriptions and
release tips
For this product to support multiple subscriptions and release
topics, you need to turn on the "Multi-topic" switch when configured,
and click "Submit Settings" - - -> "Reart effective" two buttons.

After the configuration is complete, {"online": true} or {"online":

false} is issued from the serial port when the module is connected
or disconnected from the server.

When the user receives the {"online": true} message through the
serial port, it indicates that the module is connected to the server or
reconnects to the server due to some factor, the user needs to
subscribe all the tops they want to subscribe through the following
instructions:

{"ispub":false,"topic":"your_topic","qos":0}

In multi-topic mode, the user needs to convert the message to hex

and then package it into json in the following format and send it to
the module through the serial port, for example:

{"ispub":true,"topic":"your_topic","qos":0,"retain":false,"msg":"010203"}

If you have subscribed to the above top through the serial port, you
will receive at the serial port:

{"topic":"your_topic","msg":"010203"}

Each time you send an instruction to the module, you get a correct
or incorrect feedback:

When your serial port received {"result": "success"}

indicates that your request was received and executed,
and when you receive {"result": "Invalid request"}
indicates that your request failed, please check whether
your instruction format is correct.

ModbusGateway pattern
pay attention to

Please confirm whether this product and your device to be

connected are in the same network section first. Please read about
the dynamic / static IP for details
After modifying the parameters, please click "Submit Settings" - - ->
"Restart effective".
 Configuration steps
1. Working Mode drop-down box select ModbusGateway.

2. Local port Type the port number you want to listen, (Modbus TCP
default port number is 502).

3. After modifying the parameters, please click "Submit Settings" - -

-> "Reart effective" and the product can realize the transfer of
Modbus TCP / RTU.

Reader instructions instructions

After the reader receives the correct command, the reader
successfully returns the string "ZYH OK" after receiving the correct
formatting command
The failed modification is not returned
The specific command format is as follows:
First byte 0x19 total data total length, all except header
The second byte is the 0x88 command word
The third to sixth bytes are set for the port rate
000012C0 is 4800,
 00002580 is 9600,
00003840 is 14400,
00004B00 is 19200,
00009600 is 38400,
0000E100 is 57600,
0001C200 is 115200
The seventh byte is a head length zero no head, up to 6 bytes

The eighth to thirteenth bytes are the header data class capacity. If
the header length is 0, the six bytes are 0. If the header length is 6,
the corresponding six bytes should write the corresponding data

The fourteenth byte is the end length of zero, there is no end, up to

6 bytes of the end

The fifteenth to twenty bytes are the ending data. If the end length
is 0, the six bytes are 0. If the end length is 6, the corresponding six
bytes should write the corresponding data

Twenty 1 byte for space and return (0D0A) is at the end of the front,
if set to 1 that is at the end of 0D 0A, if set to 2 that is at the end of
0D, if set to 3 that is at the end of the 0A, if set to 4 that is at the
end of nothing

The twenty-two byte is the data format, which is the card code data
format has a total of 9 data formats
1, for the four-byte hex system (8H)
2, for the four-byte decimal system (8H10D)
3, for the three-byte sixteen decimal system (6H)
4, for the three-byte decimal (6H8D)
5, with two zeros (6H10D)
6, for the last eight decimal digits (8H8D)
7, the last eight card number (1H10D + 2H10D)
8, for a five-byte decimal (10H13D)
9, for five byte sixteen (10H)

The 23rd byte sends the data, set to 1 means the card number is
the positive code, and the data to 2 indicates the reverse code of
the card number.

The 24th byte for data is ASCII code or HEX code 1 is ASCII code 2 is
HEX code

The 25th byte is sent data with check or without check 1 is with no
check 2 is with different or check 3 is with and check

Twenty-six bytes check all the data before this command

For example: Porter rate 9600 data format is 02 head four bytes
hexASCII code card number 0D 0A 03 end (02 30 38 41 43 44 38 39
36 0D 0A 03), the data format is set as follows:
19 Total number of data
88 Command character
00002580 9600 baud rate
01 Head length
020000000000 head data content
01 End length
030000000000 end data content
01 plus 0D0A
01 The data format is 8H
01 Positive code
01 The ASCII code
01 without calibration
34 All previous data differences or check
Complete command:
19 88 00 00 25 80 01 02 00 00 00 00 00 01 03 00 00 00 00 00 01
01 01 01 01 34
Note: commands are sent in 16 system, not ascll code

Network module reset and restore the factory setting command

First byte 0x04 total data total length, except all data for the head
The second byte is the 0 xAA command word
The third byte Function byte 11 is the restart, 22 is the factory setting, 33 is the relay delay
time
Every four bytes When the function code is 33, this byte is the delay time, and the other
function code is the invalid byte.
The fifth byte The first three bytes differ or check