VUP Communication Protocol V2.0.0
VUP Communication Protocol V2.0.0
Communication protocol
Shenzhen VANCH Intelligent Technology Co., Ltd. has the right to modify the software, hardware and
manual of this product without declaration. This manual is subject to change without notice.
The specifications and power supply of this machine are subject to the country of origin. Make sure
the voltage you are using meets the requirements, read and understand the safety precautions,
especially for outdoor installations.
Reader Communication protocol(VUP)
Revision history
Revisio
date description author
n
Tan
2020-8-28 0.0 1. First draft
Zhuolin
configuration information
Tan
2021-3-31 0.4 1. Improve the firmware upgrade process
Zhuolin
2021-5-12 0.6 1. Delete the 27H and 28H commands, and Tan
20201118RevA|Page 2 of 81
Reader Communication protocol(VUP)
Revisio
date description author
n
52H).
protocol is added.
Tan
2021-5-27 0.9 1. Improve 07H, 3BH instructions
Zhuolin
2021-5-28 0.10 1. Adjust the error code and delete the Tan
20201118RevA|Page 3 of 81
Reader Communication protocol(VUP)
Revisio
date description author
n
Tan
2022-4-6 1.13 1. Unified version number
Zhuolin
Tan
2022-4-7 1.13.1 1. Fix document errors
Zhuolin
20201118RevA|Page 4 of 81
Reader Communication protocol(VUP)
Revisio
date description author
n
interface description
PROFINET
20201118RevA|Page 5 of 81
Reader Communication protocol(VUP)
目录
REVISED RECORD............................................................................2
CATALOGUE....................................................................................4
1. COMMUNICATING PROTOCOL.......................................................1
1.1 SUMMARY................................................................................. 1
1.1.1 Agreement Document S p e c i f i c a t i o n .......................................................................................................1
1.2.2 R S 4 8 5 ..................................................................................................................................................................................8
1.2.5 W I F I ...................................................................................................................................................................................1 1
1.2.6 4 G ........................................................................................................................................................................................1 1
20201118RevA|Page 6 of 81
Reader Communication protocol(VUP)
20201118RevA|Page 7 of 81
Reader Communication protocol(VUP)
20201118RevA|Page 8 of 81
Reader Communication protocol(VUP)
1. Communication protocol
1.1 overview
In the application system, the reader and writer can be connected to the
controller (or PC) in the application system via Ethernet, RS232, or RS485.
The reader receives the command from the controller and returns the
command execution result to the controller. In addition, the reader and writer
also work automatically. When the data of the reader or the status of the
below.
Therefore, we call the packets sent from the controller to the reader as
command packets, and the packet to the controller as return packets. The
packet that the reader actively reports the packet to the controller is called a
status packet. See Section 1.1.2 for command package format, Section 1.1.3
for return package format, and Section 1.1.4 and Chapter 1.7 for status
package format.
When controlling the readers and writers through Ethernet, you can use the
20201118RevA|Page 9 of 81
Reader Communication protocol(VUP)
1.2.
To simplify the document, the commands in the document omit the Header,
Length, Address, and Check parts in the protocol, and retain only the Cmd and
Param. parts.
The data in the document, decimal is shown directly by numbers without any
As shown above, the command package consists of 6 parts. When the reader
receives the Header field, the controller needs to send the frame within 500
Length: 2 bytes, with a valid package length. This length is the total number
of bytes in the last 4 sections (Address + Cmd + Param + Check). First start
high bytes, back hair low bytes. For example, when 270 bytes long, the send
Param: Several bytes, command parameters, whose length varies with the
command.
20201118RevA|Page 10 of 81
Reader Communication protocol(VUP)
summed.
Header: 1 byte, the head of packet. F0H when the command execution is
Length: 2 bytes, with a valid package length. This length is the total number
of bytes in the last 4 sections (Address + Cmd + Param + Check). First start
high bytes, back hair low bytes. For example, when 270 bytes long, the send
Cmd: 1 byte, the command code. The same as the received command code
Param: Several bytes, to return the parameter. Execution error returns 1 byte
command.
summed.
The packets that actively report from the reader to the controller are called
state packets, and the host does not need to return an answer to the state
packets. All state packets are taken with F1H as the header.
20201118RevA|Page 11 of 81
Reader Communication protocol(VUP)
Length: 2 bytes, with a valid package length. This length is the last 4 parts
Total number of bytes for Check). First start high bytes, back hair low bytes.
For example, when 270 bytes long, the send order is 01H 0EH. 。 =
Param: Several bytes, status parameters, whose length varies with the
command.
summed.
for(i=0;i<uBuffLen;i++)
20201118RevA|Page 12 of 81
Reader Communication protocol(VUP)
uSum = (~uSum) + 1;
return uSum;
When the command execution fails, the header of the returned packet is
F4H, and its return data part (Param) is an error code of 1 byte. The
ERROR
CAUSE OF THE ERROR
CODE
00H 0X00 SUCCESS
0X01 FUNCTION CODE THAT IS NOT
01H
SUPPORTED
02H 0x02 register address error
03H 0x03 data domain error
04H 0x04 write failed
05H 0x05 confirm
06H 0x06 server busy
07H 0x07 reserved
08H 0x08 store parity errors
09H 0x09 reserved
0AH 0x0A unavailable gateway path
0x0B gateway target device failed to
0BH
respond
0CH 0x0Cmodbus access length error
0x0D this configuration item is not
0DH
supported
0EH 0x0E relay function error
0FH 0x0F card reading mode error
10 a.m. 0x10 label type is wrong
0x11 this reporting interface is not
11 a.m.
supported
0x12 this escalation mode is not
12:00
supported
20201118RevA|Page 13 of 81
Reader Communication protocol(VUP)
20201118RevA|Page 14 of 81
Reader Communication protocol(VUP)
20201118RevA|Page 15 of 81
Reader Communication protocol(VUP)
Gets the RS485 address of the reader, whose command packet is:40H 00H
03H 01H 04H B8H
among:
20201118RevA|Page 16 of 81
Reader Communication protocol(VUP)
Package valid
03H length is low in
bytes
01H Reader address
04H command code
B8H check sum
Returns if the reader performs successfully: F0H 00H 04H 01H 04H 01H 06H
If the reader execution fails, it may return: F4H 00H 03H 01H 04H 19H EBH
20201118RevA|Page 17 of 81
Reader Communication protocol(VUP)
1.2.1 RS232
1.2.2 When using the RS232 control reader, the reader waits for the host's
RS232 command and returns the response to the host. If the RS232 automatic
report is enabled (using the 29H instruction setting), the automatic card
reading data will be reported to the host through the status package format.
See the status package format description in Section 1.1.4 and the 01H
instruction in Section 1.7.
1.2.3 RS485
When controlling the reader with the RS485, the reader waits for the host's
RS485 command and returns the response to the host. If the RS485 automatic
report is enabled, the automatic card reading data will be reported to the host
through the status package format. For the automatic report format, see the
status package format description in Section 1.1.4 and the 01H instruction in
Section 1.7
20201118RevA|Page 18 of 81
Reader Communication protocol(VUP)
20201118RevA|Page 19 of 81
Reader Communication protocol(VUP)
When using the RJ45 ordinary web port to control the reader, the reader
supports three-way Socket s, namely UDP Server, UDP Client, and TCP Server /
Client.
The user controls the mode of the reader works through 27H instruction,
where UDP Server is supported by default and does not need to be used. The
other three modes need to be opened or closed through 27H instruction.
1、UDP Server/Client
As UDP Server or UDP Client, port 1969 is bound by default. The host sends
data to control the reader and writer. The reader and writer responds, as
shown in the figure below
If the user has turned off the UDP reporting function via the 27H instruction.
At this time, the automatic card data is not reported to the controller through
UDP, as shown in the figure below.
20201118RevA|Page 20 of 81
Reader Communication protocol(VUP)
If the user sets the IP address and port of UDP Server through the 27H
instruction and enables the UDP reporting function, the reader, in addition to
the data of the controller, will also report the automatic read data to UDP
Server through the format of the status package (Report), as shown in the
figure below. For the automatically reported format, see the status package
format description in Section 1.1.4, and the 01H instruction in Section 1.7.
2、TCP Server
When the user turns off the TCP reporting using the 27H instruction, the
reader and writer, as a TCP Server, listens to port 1969 by default, and the
controller should connect to the reader and writer as a TCP Client, at the same
time and with only one TCP connection. After the connection is successful, the
data interaction can be conducted. The data read in automatic mode will be
reported to this TCP connection. For the automatically reported format, see
the status package format description in section 1.1.4, and the 01H
instruction in section 1.7
20201118RevA|Page 21 of 81
Reader Communication protocol(VUP)
3、TCP Client
When the user sets the server IP address and port number of the reader to
connect to and enables the TCP reporting, the reader and writer acts as the
TCP Client. At this time, the host should wait for the connection of the reader
as the TCP Server. After the connection is successful, it can send instructions
to the reader. If the TCP Client automatically reports it, the automatic read
card data will be reported to the TCP connection through the format of the
status package (Report) format, otherwise it will not be reported, as shown in
the figure below. For the automatically reported format, please see the status
package format description in Section 1.1.4, And the 01H instruction of
Section 1.7.
20201118RevA|Page 22 of 81
Reader Communication protocol(VUP)
When using the super network port module or WIFI module, the network port
only supports one mode of TCP Server, TCP Client, UDP Server, and UDP
Client. That is, it can only be used in one of the four modes, not at the same
time. When the network port used is a 4G module, the reader only supports
one mode of UDP Client and TCP Client, that is, it can only be used in one of
the two modes, but not at the same time.
Note: Super network port, WIFI and 4G do not support broadcast packets, so
when connecting to the reader using these interfaces, the device cannot be
identified through the broadcast packet.
1、UDP Server
When the reader is a UDP server, the user host uses the UDP Client to connect
to the reader. After receiving a UDP packet from a host, the reader changes
the destination IP to the data source IP and port number, and sends the data
to the IP and port number of the nearest communication. The reader
automatically reads the card data, and will report it to the IP and port of the
most recent communication through the format of the status packet. If there
is no IP address and port of recent communication, data will not be returned
and reported, so this method is more suitable for the scene of command card
reading, rather than the scene where the reader works automatically.
2、UDP Cbind
When the reader is a UDP client, the user host uses the UDP Server to connect
to the reader, and needs to specify the target IP and port to which the reader
is connected (4DH/4FH/51 instructions). Both the data responded by the
reader and the data automatically reported are sent to this specified IP and
port.
20201118RevA|Page 23 of 81
Reader Communication protocol(VUP)
3、TCP Client
When the reader is a TCP client, the user host uses the TCP Server to connect
to the reader, and needs to specify the destination IP and port to which the
reader wants to connect (4DH/4FH/51 instructions). Reader responses and
auto-reported data are sent to this specified IP and port.
4、TCP Server
When the reader is a TCP server, the user host uses a TCP Client to connect to
the reader, and there is only one TCP connection at the same time. Both the
reader's response and the data for automatic card reading are sent to this TCP
client.
20201118RevA|Page 24 of 81
Reader Communication protocol(VUP)
Parameter 2: 1 byte, baud rate code. The actual baud rate corresponding
20201118RevA|Page 25 of 81
Reader Communication protocol(VUP)
Parameter 1: 1 byte, address. 1-254, not set to 0 and 255, this is the
broadcast address.
Function: Get the hardware, software, protocol, and module version number of
the reader.
20201118RevA|Page 26 of 81
Reader Communication protocol(VUP)
"HW:xxxx,SW:xxxx,PROT:xxxx,MD:xxxx"
Function: Sets the relay status, this command is only allowed to be called
when the relay is not used for automatic control. In order to protect Flash, the
Function: Gets the relay status of the reader, this command is only allowed to
20201118RevA|Page 27 of 81
Reader Communication protocol(VUP)
20201118RevA|Page 28 of 81
Reader Communication protocol(VUP)
CODE FUNCTION
00H COMMAND MODE: THE READER DOES NOT ACTIVELY
READ THE CARD, BUT THE CONTROLLER SENDS
COMMANDS TO CONTROL THE TIMING OF CARD
READING.
01H AUTO MODE (CONTINUOUS CARD READING): THE
READER CONTINUOUSLY READS CARDS AUTOMATICALLY.
02H AUTO MODE (SWITCH TRIGGER CARD READING): WHEN
THE TRIGGER IO of the reader MEETS THE TRIGGER
CONDITIONS, THE CARD IS READ FOR A PERIOD OF TIME.
THE TRIGGER LEVEL AND CARD READING TIME CAN BE
SET VIA THE 2FH COMMAND. THE STATE MACHINE IS AS
FOLLOWS:
20201118RevA|Page 29 of 81
Reader Communication protocol(VUP)
20201118RevA|Page 30 of 81
Reader Communication protocol(VUP)
different for different models, you can refer to the table below.
according to the different values of the parameter Region. For the actual
20201118RevA|Page 31 of 81
Reader Communication protocol(VUP)
Parameter 2: 1 byte, starting frequency. FCC range 0-52, ETSI range 0-6,
Parameter 3: 1 byte, end frequency point. FCC range 0-52, ETSI range 0-6,
Note: The start frequency cannot be greater than the end frequency point.
greater than 0.
decimal number is high. For example, 915000KHz sends 0DH F6H 38H.
Parameter 1: 1 byte, band area. 5--FCC full range, 6--ETSI full range, 7--
Fre Correspondin
que g frequency
20201118RevA|Page 32 of 81
Reader Communication protocol(VUP)
ncy
0 865.00 MHz
1 865.50 MHz
2 866.00 MHz
3 866.50 MHz
4 867.00 MHz
5 867.50 MHz
6 868.00 MHz
20201118RevA|Page 33 of 81
Reader Communication protocol(VUP)
MHz MHz
909.00 919.00
14 34
MHz MHz
909.50 919.50
15 35
MHz MHz
910.00 920.00
16 36
MHz MHz
910.50 920.50
17 37
MHz MHz
911.00 921.00
18 38
MHz MHz
911.05 921.50
19 39
MHz MHz
Fre
Correspondin
que
g frequency
ncy
0 920.00 MHz
1 920.50 MHz
2 921.00 MHz
3 921.50 MHz
4 922.00 MHz
5 922.50 MHz
6 923.00 MHz
7 923.50 MHz
8 924.00 MHz
9 924.50 MHz
10 925.00 MHz
return packets according to the different returned Region values. For the
20201118RevA|Page 34 of 81
Reader Communication protocol(VUP)
Parameter 2: 1 byte, starting frequency. FCC range 0-52, ETSI range 0-6,
Parameter 3: 1 byte, end frequency point. FCC range 0-52, ETSI range 0-6,
greater than 0.
decimal number is high. For example, 915000KHz sends 0DH F6H 38H.
Parameter 1: 1 byte, band area. 5--FCC full range, 6--ETSI full range, 7--
20201118RevA|Page 35 of 81
Reader Communication protocol(VUP)
command to make the WIFI module work in STA mode to facilitate the
reconfiguration of the WIFI module. This command takes a long time, about 5
seconds.
20201118RevA|Page 36 of 81
Reader Communication protocol(VUP)
Parameter 1: 6 bytes, time to set. They are: year, month, day, hour,
minute, second.
Parameter 1: 6 bytes, time. They are: year, month, day, hour, minute,
second.
Function: This directive is used to set the function of the tag filter. When the
reader recognizes the EPC or UID of the tag, if the filter function is enabled, it
will first match the filter in bytes, and if it cannot match, the tag will be
discarded.
20201118RevA|Page 37 of 81
Reader Communication protocol(VUP)
Note: Because the maximum EPC length that the reader can recognize is
Function: This command is used to set the network address of the reader
ethernet. Include IP address, subnet mask. Default gateway, port number. The
reader will automatically restart after executing this command, and the restart
20201118RevA|Page 38 of 81
Reader Communication protocol(VUP)
00H D5H
00H
01H
is 07H B1H
Function: This command is used to obtain the network address of the reader
00H D5H
20201118RevA|Page 39 of 81
Reader Communication protocol(VUP)
00H
01H
is 07H B1H
Function: This command is used to set the destination IP address and port
number reported when the card is automatically read. When the reader
recognizes the tag, if the hardware interface reported is RJ45, the tag will be
reported to the host IP and port set by this instruction. This command will
Note: This command is backward compatible and can send only 1, 2, and
Parameter 1: 4 bytes, UDP Server IP, indicates which UDP server to report.
Parameter 2: 2 bytes, UDP Server Port, reporting port, high byte first, low
byte last.
Parameter 4: 4 bytes, TCP Server IP, indicates which TCP server to report
to.
20201118RevA|Page 40 of 81
Reader Communication protocol(VUP)
Parameter 5: 2 bytes, TCP Server Port, reporting port, high byte first, low
byte last.
reporting is enabled, the reader will switch to TCP Client mode, otherwise, the
Function: This command is used to obtain the host IP address and port
number reported when the card is automatically read. When the reader
recognizes the tag, if RJ45 is used to report the tag, the tag will be reported to
Note: This command is backward compatible and can return only 1, 2, and
Parameter 1: 4 bytes, UDP Server IP, indicates which UDP server to report.
Parameter 2: 2 bytes, UDP Server Port, reporting port, high byte first, low
byte last.
Parameter 4: 4 bytes, TCP Server IP, indicates which TCP server to report
to.
20201118RevA|Page 41 of 81
Reader Communication protocol(VUP)
Parameter 5: 2 bytes, TCP Server Port, reporting port, high byte first, low
byte last.
Function: This instruction is used to set up the function of the label alarm.
When the reader and writer recognize the EPC or UID of the label, if the alarm
function is turned on, it will match the alarm in bytes. If the match, the relay
20201118RevA|Page 42 of 81
Reader Communication protocol(VUP)
suction will trigger (the corresponding relay should be set for alarm purposes).
20201118RevA|Page 43 of 81
Reader Communication protocol(VUP)
20201118RevA|Page 44 of 81
Reader Communication protocol(VUP)
Function: The reader supports the custom heartbeat packet function, sending
Users can set the heartbeat packet function through this command.
Command code:39H
Parameter 1:1 byte, whether to open the heartbeat package.0- -Not open,
1- -open.
20201118RevA|Page 45 of 81
Reader Communication protocol(VUP)
Parameter 1:1 byte, whether to open the heartbeat package.0- -Not open, 1- -
open.
Function: Set the parameters of the WIFI module, this command takes 3-4
Parameter 5:2 bytes, local or remote port. Port number, high bytes in
20201118RevA|Page 46 of 81
Reader Communication protocol(VUP)
If you are a server, this port refers to the local port that listens locally.
If you do the client, this port refers to the remote port remore port to
If you are doing a client, you need to configure this parameter, which
connected.
up to 64 bytes.
connect to WIFI.
20201118RevA|Page 47 of 81
Reader Communication protocol(VUP)
Function: Set the parameters of the super network port, this command takes
Parameter 5: 2 bytes, port number, high byte first, low byte last.
If you are a server, this port refers to the local port that listens locally.
If you do the client, this port refers to the remote port to which you want
to connect.
connect to.
If you are doing a client, you need to configure this parameter, which
20201118RevA|Page 48 of 81
Reader Communication protocol(VUP)
port
Function: Set the parameters of 4G module, this command takes 3-4 seconds,
mainly the module configuration takes time.4G modules are generally client
clients, so you only need to set the server's IP address (domain name) and
port.
Parameter 2:2 bytes, port, high byte in front, low bytes in back.
Parameter 4: n bytes, the IP address, or the ASCII code for the domain
20201118RevA|Page 49 of 81
Reader Communication protocol(VUP)
If the user only needs to identify the tag, but does not need to read or write
the tag, it is recommended to use the 0DH command to configure the reader
in automatic mode. At this time, the reader will automatically identify the tag
and report it. When using this development method, users only need to simply
configure the reader and then analyze the data reported by the reader and
writer.
Function: The reader/writer sets the parameters related to the function of the
automatic control relay through this command. It can be set to pull in the
relay when the tag is recognized, which is applicable to some simple scenarios
requiring alarm. It can also be set to pull in the relay when the label meeting
the alarm conditions is read. This command needs to be used with the 31H
command. The pull in time of the relay can also be set by this command.
Command code:09H
20201118RevA|Page 50 of 81
Reader Communication protocol(VUP)
CODE FUNCTION
00H No automatic control relay
01H When the label is read, the relay is
closed, and when the label is not read
for a specified time, the relay is
disconnected
02H When the label that meets the alarm
conditions is read, the relay is closed.
When the label that meets the alarm
conditions is not read within the
specified time, the relay is
disconnected
Parameter 1:1 bytes. The purpose of the relay. See the table above.
20201118RevA|Page 51 of 81
Reader Communication protocol(VUP)
command can be used to set the polling antennas for automatic card reading.
After configuring the polling antenna, the reader will automatically poll each
For example, if you want to select automatic polling antennas 1, 3 and 4, the
20201118RevA|Page 52 of 81
Reader Communication protocol(VUP)
Function: set the label type that can be read during automatic card
reading.
Parameter 1:1 bytes, recognizable label type, bitmap form. See the
table below:
TAG NO FUNCTION
BIT0 WHETHER TO READ ISO18000-6B LABEL. 0 -- DO
NOT READ TAGS, 1 -- READ.
BIT1 WHETHER TO READ ISO18000-6C LABEL. 0 -- DO
NOT READ TAGS, 1 -- READ.
Function: to obtain the label types that can be read during automatic card
reading.
Parameter 1:1 bytes, recognizable label type, bitmap form. See the table
above.
20201118RevA|Page 53 of 81
Reader Communication protocol(VUP)
label data. This instruction can be used to set which hardware interface is
CODE CORRESPONDI
NG INTERFACE
00H RS232
01H RS485
02H RJ45
03H WIEGAND 26
04H WIEGAND 34
05H WIFI
06H 4G
Closed, 1 -- Open.
label data. This instruction can be used to obtain which hardware interface is
20201118RevA|Page 54 of 81
Reader Communication protocol(VUP)
Function: When the reader writer works automatically, it will report the
label to the controller after it is identified, and the reported content can be
selected through this instruction. The fields you can select include EPC (UID),
TID, USER, RSSI, timestamp, label type, IP address, etc. When you select to
report USER or TID, you need to set the starting address and length for
reading. You can also set user-defined fields through this command. When you
select a user-defined reporting field, you need to set the user-defined content
through the 1AH command. It is worth noting that reading TID and USER is
only applicable to a few tag scenarios. The recognition rate is not high under
multiple tags, and the more tags, the longer the recognition time.
Parameter 1: 4 bytes constitute a 32bit data, and the report field selects
20201118RevA|Page 55 of 81
Reader Communication protocol(VUP)
of 2.
Parameter 4: 1 byte, the starting address of the USER area, which must be an
integer multiple of 2.
Note: Parameters 2-3 are valid only when TID area is selected, and
20201118RevA|Page 56 of 81
Reader Communication protocol(VUP)
parameters 4-5 are valid only when USER area is selected. The total length of
TID area and USER area cannot exceed 64 bytes, and the length of TID or
Function: When the reader writer works automatically, it will report the label
to the controller after it is identified, and the reported content can be obtained
Parameter 1: 4 bytes constitute a 32bit data, and the report field selects
report the label to the controller when it is recognized. At the same time, the
reader writer also reserves some user-defined fields for users to set, and users
20201118RevA|Page 57 of 81
Reader Communication protocol(VUP)
Function: This instruction is used to set the conditions for automatic label
20201118RevA|Page 58 of 81
Reader Communication protocol(VUP)
CODE FUNCTION
00H REPORT AFTER COUNTING: AFTER THE READER WRITER HAS
COUNTED FOR ONE ROUND, IT REPORTS THE LABEL THAT THIS
ROUND COUNTS TO.
01H REGULAR REPORTING (ALL LABELS): THE READER/WRITER COUNTS
THE LABELS COUNTED IN A REGULAR TIME, AND REPORTS THE
LABELS COUNTED IN THAT TIME.
02H REGULAR REPORTING (SINGLE LABEL): REGULAR REPORTING FOR A
SINGLE LABEL. FOR EXAMPLE, IF THE REPORTING INTERVAL IS SET
TO 5 SECONDS, WHEN THE TAG A IS READ IN THE FIRST SECOND,
IT WILL BE REPORTED IMMEDIATELY, BUT WHEN THE TAG A IS READ
AGAIN IN THE NEXT 5 SECONDS, IT WILL NOT BE REPORTED AGAIN.
WHEN LABEL A IS IDENTIFIED AGAIN AFTER 5 SECONDS, IT WILL BE
REPORTED IMMEDIATELY.
03H PASSIVE REPORTING: THIS MODE IS USED FOR MODBUS AND
PROFINET PROTOCOLS.
04H REAL TIME REPORTING: THE READER AND WRITER REPORT WHILE
COUNTING. NOTE: IN THIS MODE, FOR VM-6X AND VM-5S
MODULES, ONLY THE EPC OR UID OF THE LABEL CAN BE
REPORTED. FOR VM-6XBT MODULE, EPC, TID AND USER CAN BE
REPORTED AT THE SAME TIME.
Function: When the reader writer is working automatically, this command can
20201118RevA|Page 59 of 81
Reader Communication protocol(VUP)
Function: When the reader/writer supports the Wigan interface, the time
Function: When the reader/writer supports the Wigan interface, the time
20201118RevA|Page 60 of 81
Reader Communication protocol(VUP)
Function: When the reader writer works in the trigger mode (including switch
trigger mode and channel door trigger mode), set the trigger conditions
Parameter 1:1 bytes, select the trigger number to be set. Number starts
from 1, 1.2.3
If it is a switch trigger mode, it indicates how long the card will be read
after the trigger. For example, if it is set to 3 seconds, it means that when the
trigger conditions are met, the card reading lasts for 3 seconds.
example, if it is set to 3 seconds, it means that the card reading starts after
seconds. When the trigger is stopped due to timeout, the current round of
trigger is considered invalid, and the read tag should not be reported.
20201118RevA|Page 61 of 81
Reader Communication protocol(VUP)
Function: When the reader writer is working in the trigger mode, the trigger
If you need to perform operations such as label read/write locking, you need
to use the 0DH command to configure the reader writer in the command
mode. At this time, the reader and writer will not automatically recognize the
tag, but will be completely controlled by the user. When using this
process.
20201118RevA|Page 62 of 81
Reader Communication protocol(VUP)
Function: If the user controls the operation of the reader writer through the
20201118RevA|Page 63 of 81
Reader Communication protocol(VUP)
Function: When the reader writer works in command mode, the control
machine can identify the 6C tag ID in the antenna radiation field range
through this command. This instruction is a one to many instruction, that is, a
the mem is EPC, the starting address and length are invalid, and it can be
Parameter 1: one byte, select the region mem where the label is listed.
Code Area
00H PASSWORD
01H EPC
02H TID
03H User
20201118RevA|Page 64 of 81
Reader Communication protocol(VUP)
Note: This instruction has multiple return packets. Each identified tag
returns a return package. After all tags are returned, an empty package is
returned indicating that all tags are returned. If the specified mem is not an
EPC area, the data read from the selected area will be attached, that is,
omitted)
Assume that when the label is listed, the membank is specified as the
USER area, and 6 bytes are listed starting from the 0 address. If 2 labels are
identified:
”epc:11112222,user:55556666”
“epc:33334444,user:77778888”
Then three return packages are returned, and the parameters of each
20201118RevA|Page 65 of 81
Reader Communication protocol(VUP)
Function: read a piece of data at the beginning of the specified address of the
no access password is set for the tag, just pass 0. If the EPC area is written, it
rewritten, it can be written from the second byte. Its height of 5 bits is the PC
value, indicating the EPC length. For example, if the content of the second
byte is 0x30, its binary is 0011 0000, its height is 00110, which is 0x06, then
Parameter 1: one byte, select the label area mem. Refer to the 80H
command.
20201118RevA|Page 66 of 81
Reader Communication protocol(VUP)
Function: Write a piece of data at the beginning of the specified address of the
Parameter 1: one byte, select the label area mem. Refer to the 80H
command.
20201118RevA|Page 67 of 81
Reader Communication protocol(VUP)
Function: Write a piece of data at the beginning of the specified address of the
Parameter 1: one byte, select the region membank where the label is
listed.
CODE Area
01H USER
02H TID
03H EPC
04H Access
password area
05H Destroy
password area
Parameter 2: 1 byte,LockType。
CODE Area
00H Open
01H Lock
02H Permanent development
03H Permanent lock
20201118RevA|Page 68 of 81
Reader Communication protocol(VUP)
Function: write the EPC number of the tag and automatically modify the EPC
Note: The EPC length must be an integral multiple of 2. If the tag does not
Parameter 2: 1 byte, original label EPC length oldlen. Unit: byte. If this
20201118RevA|Page 69 of 81
Reader Communication protocol(VUP)
Note: The instruction has multiple return packages. Each tag returns a
return package. After all tags are returned, an empty package is returned,
omitted)
Suppose that 2 labels are identified after the labels are listed:
”UID:0102030405060708”
“UID:0102030405060709”
Then three return packages are returned, and the parameters of each
20201118RevA|Page 70 of 81
Reader Communication protocol(VUP)
20201118RevA|Page 71 of 81
Reader Communication protocol(VUP)
Function: When the reader writer works in the command mode, the
control machine can list the high-frequency tags within the antenna
Note: This instruction has multiple return packets. Each identified tag
returns a return package. After all tags are returned, an empty package is
20201118RevA|Page 72 of 81
Reader Communication protocol(VUP)
Parameter 1: 1 bytes, high frequency tag type, see the following table.
omitted)
Suppose that two 15693 labels are identified when the labels are listed,
”UID1: 11112222”
“UID2: 33334444”
follows:
20201118RevA|Page 73 of 81
Reader Communication protocol(VUP)
Function: read 15693 label data block, one data block is 4 bytes.
Parameter 1: 1 byte, label UID length len, unit: byte. If there is only one
tag near the antenna, len can be set to 0, then parameter 2 does not need to
be sent.
Function: write 15693 label data block, one data block is 4 bytes.
Parameter 1: 1 byte, label UID length len, unit: byte. If there is only one tag
near the antenna, len can be set to 0, then parameter 2 does not need to be
sent.
20201118RevA|Page 74 of 81
Reader Communication protocol(VUP)
Function: read 14443A label data block, one data block is 4 bytes.
Parameter 1: 1 byte, label UID length len, unit: byte. If there is only one
tag near the antenna, len can be set to 0, then parameter 2 does not need to
be sent.
Function: write 14443A label data block, one data block is 4 bytes. It should
be noted that not all the label chip areas are writable. For example, for the
NAT213 chip, the 0-3rd blocks are the factory parameters of the chip, so these
20201118RevA|Page 75 of 81
Reader Communication protocol(VUP)
Parameter 1: 1 byte, label UID length len, unit: byte. If len is 0, the
reader/writer accesses a 14443A tag randomly without sending parameter 2.
Function: Select 14443A label sector. The default is sector 0. Some 14443A
tags have only one sector, so please refer to the specification of the tag chip.
Parameter 1: 1 byte, label UID length len, unit: byte. If there is only one tag
near the antenna, len can be set to 0, then parameter 2 does not need to be
20201118RevA|Page 76 of 81
Reader Communication protocol(VUP)
sent.
Function: write 15693 label data block. One data block is 4 bytes. This
Parameter 1: 1 byte, label UID length len, unit: byte. If there is only one tag
near the antenna, len can be set to 0, then parameter 2 does not need to be
sent.
20201118RevA|Page 77 of 81
Reader Communication protocol(VUP)
Function: write 14443A label data block. One data block is 4 bytes. This
Parameter 1: 1 byte, label UID length len, unit: byte. If there is only one tag
near the antenna, len can be set to 0, then parameter 2 does not need to be
sent.
The data packets that are actively reported from the reader writer to the
controller are called status packets, and the host does not need to respond to
the status packets. All status packets use F1H as the header. The status
package is used by the reader writer to actively inform the controller of some
20201118RevA|Page 78 of 81
Reader Communication protocol(VUP)
Function: When the reader writer works automatically, it will inform the
control machine of the identified label through this status package after the
label is identified. According to the different card reading modes of the reader
writer, the reported parameters are different, but they are all reported in JSON
format. The main difference is that the trigger status will be reported in the
trigger mode.
Reporting parameters: The reporting parameters are in JSON format, and JSON
fields can be selected through the 2BH command. The meaning of each JSON
Fields Meaning
Ant Indicates the antenna number that identifies the tag,1,2,3,4...
FIN It indicates which channel is triggered in the switch triggering
mode, and its value may be [1,2,3]. This field is only reported in
the switch triggering mode.
Door Indicates the triggering direction in the channel gate mode.
From trigger 1 to trigger 2 is In, and from trigger 2 to trigger 1 is
Out. This field is only reported in the channel gate mode.
IP Indicates the IP address of the reader writer
EPC Indicates the EPC or UID number of the label
TID Indicates the TID number of the label
USER Indicates the USER area data of the label
ID Indicates the device ID of the reader writer
RSSI Indicates the signal strength of the label
TS Indicates the timestamp when the tag is recognized
TagType Represents the type of label.
0x01--6C
0x02--6B
0x41--TypeA(ISO-14443A)
0x42--TypeB
0x46--TypeF
0x56--TypeV(ISO-15693)
Custom1 Represents a user-defined field 1
Custom2 Represents a user-defined field 2
20201118RevA|Page 79 of 81
Reader Communication protocol(VUP)
Example::
Function: The reader writer regularly sends UDP broadcast packets to port
Reporting parameters: The reporting parameters are in JSON format, and the
format is as follows.
20201118RevA|Page 80 of 81
Reader Communication protocol(VUP)
company */
03H Heartbeat
Function: The reader writer sends heartbeat packets to the connected links
Reporting parameters: The reporting parameters are in JSON format, and the
format is as follows.
{ "heartbeat":"12345678" }
20201118RevA|Page 81 of 81