0% found this document useful (0 votes)
16 views

VUP Communication Protocol V2.0.0

Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
16 views

VUP Communication Protocol V2.0.0

Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 81

VUP

Vanch RFID reader

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

1. The protocol length field is changed to 2 Tan


2020-11-18 0. 1
bytes, and the status package is added Zhuolin

1. The 07H command is changed to obtain

configuration information Tan


2021-2-24 0.2
2. The 3BH command is changed to set the Zhuolin

configuration information

1. The ID number is added to the 2BH


Tan
2021-3-26 0.3 command, and the baud rate is added to
Zhuolin
the broadcast packet

Tan
2021-3-31 0.4 1. Improve the firmware upgrade process
Zhuolin

1. Modify filter and alarm commands

2. Added configurable reader model 3BH Tan


2021-4-20 0.5
command Zhuolin

3. Added command to enter test mode

2021-5-12 0.6 1. Delete the 27H and 28H commands, and Tan

the reporting of RJ45 will be changed to Zhuolin

20201118RevA|Page 2 of 81
Reader Communication protocol(VUP)

Revisio
date description author
n

use the current connection to report.

2. Add setting and obtaining WIFI

parameters (4DH, 4EH).

3. Modify the JSON field of the automatic

card reading packet (01H).

1. Add settings and obtain super network

port and 4G parameters (4FH, 50H, 51H,

52H).

2. Added configurable whether to use WIFI

and 4G (07H, 3BH). Tan


2021-5-15 0.7
3. Added serial firmware upgrade interface Zhuolin

RS485, new network firmware upgrade

interface RJ45, WIFI, super network port.

When using network upgrade, the TCP

protocol is added.

1、REDEFINE THE MEANING OF ERROR


Tan
2021-5-19 0.8 CODES 2BH AND 2CH
Zhuolin
2、Improve 07H, 3BH instructions

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

useless error code Zhuolin

1、Modify the 27H and 28H commands Tan


2021-08-13 0.11
2、Modify the 3BH, 07H commands Zhuolin

1、Modify the 05H and 37H commands


Tan
2021-12-19 0.12 2、Added high-frequency protocol
Zhuolin
commands

1、Modified the 3BH and 07H commands to

add the VI-IR610P-HF model

2、Remove tag recognition algorithm

instruction, 1DH, 1EH


Tan
2022-3-31 0.13 3、Remove the quick TID instruction
Zhuolin
4、Remove the modbus directive

5、37H order, immediate reporting to

report when the inventory is completed

6、Update the error code

Tan
2022-4-6 1.13 1. Unified version number
Zhuolin

Tan
2022-4-7 1.13.1 1. Fix document errors
Zhuolin

1. Added 15693 and 144443A multi-block Tan


2022-7-21 1.13.2
writes Zhuolin

20201118RevA|Page 4 of 81
Reader Communication protocol(VUP)

Revisio
date description author
n

1. Add RFID module type to configuration Tan


2022-9-1 1.14.0
information Zhuolin

1、Modified 27H, 4DH, 4FH directives

2、Added a section on communication

interface description

3、Improve the documentation Tan


2022-9-8 2.0.0
4、Configuration information adds RS232, Zhuolin

RS485, ordinary network port, and

PROFINET

5、Added RFID module type

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.1.2 Command Pack F o r m a t ........................................................................................................................................1

1.1.3 returns the package f o r m a t ..........................................................................................................................2

1.1.4 Status package f o r m a t .......................................................................................................................................2

1.1.5 Checksum calculation method (in C l a n g u a g e ) ...........................................................................3

1.1.6 Error c o d e ......................................................................................................................................................................3

1.1.7 Protocol for e x a m p l e ...........................................................................................................................................6

1.2 COMMUNICATION INTERFACE DESCRIPTION.........................................8


1.2.1 R S 2 3 2 ..................................................................................................................................................................................8

1.2.2 R S 4 8 5 ..................................................................................................................................................................................8

1.2.3 RJ45 Ordinary network p o r t ...........................................................................................................................9

1.2.4 RJ45 Super network p o r t ...............................................................................................................................1 1

1.2.5 W I F I ...................................................................................................................................................................................1 1

1.2.6 4 G ........................................................................................................................................................................................1 1

1.3 BASE COMMAND........................................................................11


01H Set the Baud r a t e ....................................................................................................................................................1 1

02H Get the baud rate ..................................................................................................................................................1 2

03H Setup RS485 a d d r e s s ............................................................................................................................................1 2

04H Get the RS485 A d d r e s s .......................................................................................................................................1 2

05H Obtain version n u m b e r .......................................................................................................................................1 3

06H Set the relay s t a t u s ..............................................................................................................................................1 3

08H Get the relay s t a t u s .............................................................................................................................................1 4

0BH Set up the b u z z e r ....................................................................................................................................................1 4

0CH acquisition of the b u z z e r ................................................................................................................................1 4

0DH Set the card reading m o d e .............................................................................................................................1 5

0EH Get the card reading m o d e .............................................................................................................................1 6

0FH sets the output p o w e r .........................................................................................................................................1 6

10H Get power o u t p u t .....................................................................................................................................................1 7

13H Set the frequency band frequency p o i n t ..........................................................................................1 7

14H acquisition band frequency p o i n t ............................................................................................................1 9

17H Recovery reader factory s e t t i n g s ............................................................................................................2 0

18H restart r e a d e r .............................................................................................................................................................2 1

19H restore WIFI factory s e t t i n g s ......................................................................................................................2 1

1BH sets the reader t i m e .............................................................................................................................................2 1

1CH acquisition of the reader t i m e ...................................................................................................................2 2

1FH Set the label f i l t e r .................................................................................................................................................2 2

20201118RevA|Page 6 of 81
Reader Communication protocol(VUP)

20H Get the label f i l t e r ................................................................................................................................................2 3

23H Set the RJ45 local network p a r a m e t e r s ..............................................................................................2 3

24H Get the RJ45 local network p a r a m e t e r s .............................................................................................2 4

27H Set the RJ45 distal network p a r a m e t e r s ...........................................................................................2 4

28H acquired the RJ45 distal network p a r a m e t e r s .............................................................................2 5

25H Set the MAC a d d r e s s .............................................................................................................................................2 6

26H Get the MAC a d d r e s s .............................................................................................................................................2 6

31H Set the label alarm ..............................................................................................................................................2 6

32H Obtain a label a l a r m .............................................................................................................................................2 7

33H Setup Reader I D ........................................................................................................................................................2 7

34H Get the Reader I D ....................................................................................................................................................2 8

35H Set the reader n a m e .............................................................................................................................................2 8

36H Gets the reader n a m e ..........................................................................................................................................2 8

39H Set Heartbeat p a c k a g e .......................................................................................................................................2 9

43H Get Heartbeat p a c k a g e .......................................................................................................................................2 9

4DH sets the WIFI p a r a m e t e r ...................................................................................................................................3 0

4EH acquired the WIFI p a r a m e t e r s .....................................................................................................................3 1

4FH sets the super network port p a r a m e t e r s ...........................................................................................3 1

50H Get the super network port p a r a m e t e r s ............................................................................................3 2

51H Set the 4G p a r a m e t e r ..........................................................................................................................................3 2

52H Obtain the 4G p a r a m e t e r s ...............................................................................................................................3 3

1.4 AUTOMATIC MODE-RELATED COMMANDS..........................................33


09H Set the relay automatic control p a r a m e t e r ...................................................................................3 3

0AH acquires the relay automatic control p a r a m e t e r s ...................................................................3 4

15H sets the automatic polling a n t e n n a .......................................................................................................3 5

16H acquires the automatic polling a n t e n n a ...........................................................................................3 5

21H Set the automatic read label t y p e ..........................................................................................................3 5

22H Get the automatic read label t y p e .........................................................................................................3 6

29H sets the reported hardware i n t e r f a c e .................................................................................................3 6

2AH obtains the reported hardware i n t e r f a c e .........................................................................................3 7

2BH settings the Autoreport f i e l d ......................................................................................................................3 7

2CH Get the Autoreport f i e l d ...................................................................................................................................3 9

1AH Set up the automatic report c o n t e n t ....................................................................................................3 9

44H Get the automatic report c o n t e n t ...........................................................................................................4 0

37H Set the automatic reporting c o n d i t i o n ...............................................................................................4 0

38H Obtain the automatic reporting c o n d i t i o n s ....................................................................................4 1

2DH sets the Weigen p a r a m e t e r ............................................................................................................................4 1

2EH obtain weegan p a r a m e t e r s ..............................................................................................................................4 2

2FH sets the trigger c o n d i t i o n ...............................................................................................................................4 2

30H Get the trigger c o n d i t i o n ................................................................................................................................4 3

1.5 UHF COMMAND PROTOCOL....................................................43


3AH Switching working a n t e n n a .............................................................................................................................4 4

80H Identifies the 6C t a g ............................................................................................................................................4 5

81H Read 6C T a g ..................................................................................................................................................................4 6

20201118RevA|Page 7 of 81
Reader Communication protocol(VUP)

82H Write 6C T a g .................................................................................................................................................................4 7

83H Lock 6C t a g ....................................................................................................................................................................4 8

84H kill 6C t a g .......................................................................................................................................................................4 9

85H Write the 6C tag for the E P C ........................................................................................................................4 9

90H lists the 6B t a g .......................................................................................................................................................5 0

91H read 6B t a g ..................................................................................................................................................................5 1

92H write 6B t a g ..................................................................................................................................................................5 1

93H lock 6B t a g .....................................................................................................................................................................5 2

1.6 HIGH-FREQUENCY PROTOCOL COMMAND..........................................52


70H List HF t a g s ...................................................................................................................................................................5 2

71H read 15693 t a g .........................................................................................................................................................5 3

72H write 15693 t a g .........................................................................................................................................................5 4

73H read 14443A t a g ........................................................................................................................................................5 5

74H write 14443A t a g s ...................................................................................................................................................5 5

75H select 14443A tags s e c t o r ..............................................................................................................................5 6

76H write 15693 tags multiblock d a t a ..........................................................................................................5 7

77H write 14443A tags multiblock d a t a ........................................................................................................5 7

1.7 STATUS PACKAGE.....................................................................58


01H Autoread Card Data P a c k e t ............................................................................................................................5 8

02H UDPbroadcast p a c k a g e ........................................................................................................................................6 0

03H heartbeat p a c k a g e ..................................................................................................................................................6 0

1.8 INTERNAL ORDER (CONFIDENTIAL, DO NOT DISCLOSE).........................62


45H goes into test m o d e ..............................................................................................................................................6 2

3BH setting the configuration i n f o r m a t i o n ................................................................................................6 2

07H Get the configuration i n f o r m a t i o n ..........................................................................................................6 3

53H Upgrade the RFID module f i r m w a r e ........................................................................................................6 4

1.7.1 Firmware upgrade p r o c e s s ...........................................................................................................................6 4

1.7.2 Main board Authorization P r o c e s s .......................................................................................................6 8

4AH Setup software watchdog P a r a m e t e r s ..................................................................................................6 9

4BH Get software watchdog P a r a m e t e r s ........................................................................................................7 0

4CH Feed the Dog I n s t r u c t i o n .................................................................................................................................7 0

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

reader will be automatically reported to the controller, as shown in the figure

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

UDP or TCP protocol and the reader to communicate, as detailed in Chapter

20201118RevA|Page 9 of 81
Reader Communication protocol(VUP)

1.2.

1.1.1 Protocol document specification

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

suffix, hexadecimal is followed with H as a suffix. For example 11 32 53 these

are decimal while 21H 34H 67H these represent hexadecimal.

1.1.2 Command package format

Header Length Address Cmd Param Check


1 Byte 2 Byte 1Byte 1 Byte N Byte 1 Byte

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

ms, otherwise the frame is considered invalid.

Header: 1 byte, the head of package, fixed at 40H.

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

order is 01H 0EH

Cmd: 1 byte, the command code.

Param: Several bytes, command parameters, whose length varies with the

command.

20201118RevA|Page 10 of 81
Reader Communication protocol(VUP)

Check: 1 Bytes, checksum. Header + Length + Address + Cmd + Param was

summed.

1.1.3 Returns the package format

Header Length Address Cmd Param Check


1 Byte 2 Byte 1Byte 1 Byte N Byte 1 Byte

如 As shown above, the return package is also composed of 6 parts.

Header: 1 byte, the head of packet. F0H when the command execution is

successful, and F4H when the command execution fails.

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

order is 01H 0EH.

Cmd: 1 byte, the command code. The same as the received command code

indicates that the return packet is a response to that command.

Param: Several bytes, to return the parameter. Execution error returns 1 byte

error code, if execution succeeded, varies depending on the length of the

command.

CCheck: 1 Bytes, checksum. Header + Length + Address + Cmd + Param was

summed.

1.1.4 State package format

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)

Header Length Address Cmd Param Check


1 Byte 2 Byte 1Byte 1 Byte N Byte 1 Byte

As shown above, the return package is also composed of 6 parts.

Header: 1 byte, the head of packet. Fixed to the F1H.

Length: 2 bytes, with a valid package length. This length is the last 4 parts

(Address + Cmd + Param +

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. 。 =

Cmd: 1 byte, the status code.

Param: Several bytes, status parameters, whose length varies with the

command.

Check: 1 Bytes, checksum. Header + Length + Address + Cmd + Param was

summed.

1.1.5 Checksum calculation method (C language).

unsigned char CheckSum(unsigned char *uBuff, unsigned char uBuffLen)

unsigned char i,uSum=0;

for(i=0;i<uBuffLen;i++)

uSum = uSum + uBuff[i];

20201118RevA|Page 12 of 81
Reader Communication protocol(VUP)

uSum = (~uSum) + 1;

return uSum;

1.1.6 Error code

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

following table describes the meaning of the error codes.

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)

1pm 0x13 tag matching failed


2PM 0x14 reserved
3pm 0x15 reserved
4pm 0x16 parameter error
5pm 0x17 the module returned a failure
6 p.m. 0x18 unlabeled
7pm 0x19 checksum error
1AH 0x1A this command is not supported
1BH 0x1B this antenna is not supported
1CH 0x1C filter or alarm length out of range
1DH 0x1D access area out of range
0x1E address or length is not a multiple
1EH
of 2
1FH 0x1F read length out of range
0x20 write length is not an integer
8PM
multiple of 2
9PM 0x21 reserved
The 0x22EPC length is not an integer
10PM
multiple of 2
11PM 0x23 power out of range
When setting the baud rate 0x24, the
24H
specified interface number is incorrect
When 0x25 set the baud rate, the baud
25H
rate is out of range
When 0x26 set the 485 address, the
26H
485 address is out of range
27H 0x27 hardware is not supported
28H 0x28 does not support the relay
0x29 the relay is in the automatic
29H control state, please turn off the
automatic control relay first
2AH 0x2A reserved
2BH 0x2BTID or USER area length error
2CH 0x2CTID or USER area address is wrong
0x2D need to switch the reader to
2DH
command mode
0x2E protocol errors, only UDP or TCP
2EH
reporting is supported
2FH The 0x2FRFID module returned an error

20201118RevA|Page 14 of 81
Reader Communication protocol(VUP)

30H 0x30 reserved


0x31 Frame length field and total frame
31H
length do not match
0x32 parameter length does not match
32H
the allowed length of the command
33H 0x33 does not support custom reporting
0x34 the length of the reported
34H
parameter is out of range
35H 0x35 illegal data frames
36H 0x36 reserved
0x37 key error (used in Boot, do not
37H
modify).
38H 0x38 reserved
0x39 file write error (used in Boot, do
39H
not modify).
0x3A write address error (used in Boot,
3AH
do not modify).
3BH 0x3B reserved
3CH 0x3C other unknown errors
3DH 0x3D reserved
3EH 0x3E reserved
3FH 0x3F reserved
40H 0x40Flash erase failed
0x41 this register does not support this
41H
command code
Operation on flag bits is not supported
42H under 0x42 Bootloader (used in Boot,
do not modify).
43H 0x43 is currently in APP mode
44H 0x44 frequency range is wrong
45H 0x45 band area error
46H 0x46 this trigger is not supported
47H 0x47 Wiegand output is not supported
0x48 switching quantity can only be 0
48H
or 1
When 0x49 RFID sets the power, the
49H
module returns an error
When setting the frequency band of
4AH
0x4ARFID, the module returns an error

20201118RevA|Page 15 of 81
Reader Communication protocol(VUP)

0x4BRFID When setting the antenna,


4BH
the module returns an error
4CH 0x4C Incorrect buzzer parameters
4DH 0x4D reserved
4EH 0x4E trigger level error
4FH 0x4F reserved
50H 0x50 relay status error
0x51 high-frequency reader can only
51H
choose EPC (UID).
52H 0x52 reserved
53H 0x53 reserved
54H 0x54 reserved
55H 0x55 reserved
56H 0x56 reserved
The number of 0x57 configurations
57H exceeds the maximum supported by
the hardware
58H 0x58 need to turn on automatic work
59H 0x59 Reader model is wrong
5AH 0x5A reserved
5BH 0x5B reserved
5CH 0x5C reserved
0x5D module assembly failed and the
5DH
assembly position was occupied
0x5E this module is not assembled, this
5EH
parameter cannot be set and obtained

1.1.7 Examples of protocols

Gets the RS485 address of the reader, whose command packet is:40H 00H
03H 01H 04H B8H

among:

40H GUIDE CODE


Package valid
00H length is high in
bytes

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 Communication interface description

This chapter describes the data interaction mechanism of each hardware


interface of the host and reader so that users can quickly understand how to
control the reader work. Readers are generally used as a slave, waiting for
commands, commands, and responses from the host, as shown in Chapter
1.1.

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)

1.2.4 Normal network port

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.

MODE METHOD OF SETTING


UDP SERVER NO SETUP REQUIRED
UDP CLIENT 27H COMMAND,OPEN UDP REPORT
TCP SERVER 27H COMMAND,CLOSE TCP REPORT
TCP CLIENT 27H COMMAND,OPEN TCP REPORT

The following modes are described below

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)

1.2.5 Super network port/WIFI/4G

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)

1.3 Basic commands

01H Set the baud rate

Function: Set the baud rate of RS232 or RS485 interface.

Command code: 01H

Command package: 2 parameters.

Parameter 1: 1 byte, interface type. 00H--RS232,01H--RS485

Parameter 2: 1 byte, baud rate code. The actual baud rate corresponding

to the code is shown in the following table

COD BAUD RATE


E
00H 9600
01H 19200
02H 38400
03H 57600
04H 115200

Return package: No parameters.

02H Obtain the baud rate

Function: Obtain the baud rate of RS232 or RS485 interface.

Command code: 02H

Command package: 1 parameter.

Parameter 1: 1 byte, interface type. 00H--RS232,01H--RS485

20201118RevA|Page 25 of 81
Reader Communication protocol(VUP)

Return package: 1 parameter.

Parameter 1: 1 byte, baud rate. See table above.

03H Set RS485 address

Function: Set the RS485 address of the reader.

Command code: 03H

Command package: 1 parameter.

Parameter 1: 1 byte, address. 1-254, not set to 0 and 255, this is the

broadcast address.

Return package: No parameters.

04H Get RS485 address

Function: Get the RS485 address of the reader.

Command code: 04H

Command package: No parameters.

Return package: 1 parameter.

Parameter 1: 1 byte, address.

05H Get the version number

Function: Get the hardware, software, protocol, and module version number of

the reader.

20201118RevA|Page 26 of 81
Reader Communication protocol(VUP)

Command code: 05H

Command package: No parameters.

Return package: 1 parameter.

Parameter 1: Several bytes in the format:

"HW:xxxx,SW:xxxx,PROT:xxxx,MD:xxxx"

Such as ”HW:1.0,SW:2.0,PROT:1.0,MD:VM-6xBT V6.9”

06H Set the relay status

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

relay status is saved without power loss.

Command code: 06H

Command package: 2 parameters.

Parameter 1: 1 byte, relay number. 1,2,3...

Parameter 2: 1 byte, relay status. 0--disconnect, 1--suck

Return package: No parameters.

08H Get the relay status

Function: Gets the relay status of the reader, this command is only allowed to

be called when the relay is not used for automatic control.

Command code: 08H

20201118RevA|Page 27 of 81
Reader Communication protocol(VUP)

Command package: 1 parameter.

Parameter 1: 1 byte, relay number. 1,2,3...

Return package: 1 parameter.

Parameter 1: Relay status. 0--break, 1--suck.

0BH sets the buzzer

Function: Turn on/off the buzzer.

Command code: 0BH

Command package: 1 parameter.

Parameter 1: 1 byte, buzzer switch. 00H--Off, 01H--On.

Return package: No parameters.

0CH gets the buzzer

Function: Get the buzzer on status.

Command code: 0CH

Command package: No parameters.

Return package: 1 parameter.

Parameter 1: 1 byte, buzzer switch. 00H--Off, 01H--On.

0DH sets the card reading mode

Function: Set the card reading mode of the reader.

20201118RevA|Page 28 of 81
Reader Communication protocol(VUP)

Command code: 0DH

Command package: 1 parameter.

Parameter 1: 1 byte, card reading mode. See the table below.

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:

03H AUTOMATIC MODE (BIDIRECTIONAL TRIGGER CARD


READING): WHEN TRIGGER 1 of the reader is triggered, it
starts reading and STORES IT, AND TRIGGER 2 IS
TRIGGERED OR STOPS READING AFTER TIMING OUT.
ALTERNATIVELY, WHEN TRIGGER 2 of the reader is
TRIGGERED, IT STARTS READING THE CARD AND STORES
IT, AND TRIGGER 1 IS TRIGGERED OR STOPS READING
AFTER IT TIMES OUT. THE STATE MACHINE FOR THIS
MODE IS SHOWN IN THE FOLLOWING FIGURE:

20201118RevA|Page 29 of 81
Reader Communication protocol(VUP)

NOTE: IN THIS MODE, THE REPORTING CONDITION SET


BY THE 37H COMMAND IS INVALID. THE CARD READ
AFTER THE TRIGGER STARTS WILL BE STORED FIRST AND
REPORTED DIRECTLY AFTER THE TRIGGER IS
COMPLETED. IF A TRIGGER TIMEOUT OCCURS, THE
CURRENT TRIGGER IS CONSIDERED INVALID AND CARDS
READ DURING THIS PERIOD SHOULD NOT BE REPORTED.

Return package: No parameters.

0EH Gets the card reading mode

Function: Set the card reading mode of the reader.

Command code: 0EH

Command package: No parameters.

Return package: 1 parameter.

Parameter 1: 1 byte, card reading mode. See table above.

0FH sets the output power

Function: Set the output power.

Command code: 0FH

Command package: 2 parameters.

20201118RevA|Page 30 of 81
Reader Communication protocol(VUP)

Parameter 1: 1 byte, antenna number. 1,2,3,4...

Parameter 2: 1 byte, power value. Range 0-33dBm. The range may be

different for different models, you can refer to the table below.

Module Power range


model dbm
R2000 0-33
VM-5S 13-27
VM-5F 18-26

Return package: No parameters.

10H to obtain output power

Function: Gets the output power.

Command code: 10H

Command package: 2 parameters.

Parameter 1: 1 byte, antenna number. 1,2,3,4...

Return package: 1 parameter.

Parameter 1: 1 byte, power value.

13H Set the frequency point of the band

Function: Set the frequency parameter, which is subdivided into 3 instructions

according to the different values of the parameter Region. For the actual

frequency corresponding to the frequency point in the instruction, see the

frequency parameter correspondence table.

Command code: 13H

20201118RevA|Page 31 of 81
Reader Communication protocol(VUP)

Command package 1: 3 parameters.

Parameter 1: 1 byte, band area. 1--FCC,2--ETSI,3--CHN。

Parameter 2: 1 byte, starting frequency. FCC range 0-52, ETSI range 0-6,

CHN range 0-10.

Parameter 3: 1 byte, end frequency point. FCC range 0-52, ETSI range 0-6,

CHN range 0-10.

Note: The start frequency cannot be greater than the end frequency point.

Command package 2: 4 parameters.

Parameter 1: 1 byte, band area. Fixed at 04H.

Parameter 2: 1 byte, frequency interval. Unit 10KHz.

Parameter 3: 1 byte, number of frequency points. This parameter must be

greater than 0.

Parameter 4: 3 bytes, starting frequency. The unit is 10KHz, and the

decimal number is high. For example, 915000KHz sends 0DH F6H 38H.

Command package 3: 1 parameter.

Parameter 1: 1 byte, band area. 5--FCC full range, 6--ETSI full range, 7--

CHN full range.

Return package: No parameters.

ETSI frequency parameter correspondence table

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

FCC frequency parameter correspondence table

Frequ Correspon Freq Correspon Freq Correspond


ency ding uenc ding uenc ing
frequency y frequency y frequency
902.00 912.00 922.00
0 20 40
MHz MHz MHz
902.50 912.50 922.50
1 21 41
MHz MHz MHz
903.00 913.00 923.00
2 22 42
MHz MHz MHz
903.50 913.50 923.50
3 23 43
MHz MHz MHz
904.00 914.00 924.00
4 24 44
MHz MHz MHz
904.50 914.50 924.50
5 25 45
MHz MHz MHz
905.00 915.00 925.00
6 26 46
MHz MHz MHz
905.50 915.50 925.50
7 27 47
MHz MHz MHz
906.00 916.00 926.00
8 28 48
MHz MHz MHz
906.50 916.50 926.50
9 29 49
MHz MHz MHz
907.00 917.00 927.00
10 30 50
MHz MHz MHz
907.50 917.50 927.50
11 31 51
MHz MHz MHz
908.00 918.00 928.00
12 32 52
MHz MHz MHz
13 908.50 33 918.50

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

CHN frequency parameter correspondence table

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

14H Obtain the frequency band point

Function: Obtain the frequency point parameter, which is subdivided into 3

return packets according to the different returned Region values. For the

actual frequency corresponding to the frequency point in the return package,

20201118RevA|Page 34 of 81
Reader Communication protocol(VUP)

see the frequency parameter mapping table.

Command code: 14H

Command package: No parameters.

Return package 1:3 parameters.

Parameter 1: 1 byte, band area. 1--FCC,2--ETSI,3--CHN。

Parameter 2: 1 byte, starting frequency. FCC range 0-52, ETSI range 0-6,

CHN range 0-10.

Parameter 3: 1 byte, end frequency point. FCC range 0-52, ETSI range 0-6,

CHN range 0-10.

Return package 2: 4 parameters.

Parameter 1: 1 byte, band area. Fixed at 04H.

Parameter 2: 1 byte, frequency interval. Unit 10KHz.

Parameter 3: 1 byte, number of frequency points. This parameter must be

greater than 0.

Parameter 4: 3 bytes, starting frequency. The unit is 10KHz, and the

decimal number is high. For example, 915000KHz sends 0DH F6H 38H.

Return package 3:1 parameter.

Parameter 1: 1 byte, band area. 5--FCC full range, 6--ETSI full range, 7--

CHN full range.

17H Restore the reader to factory settings

20201118RevA|Page 35 of 81
Reader Communication protocol(VUP)

Function: Restore the factory settings of the reader.

Command code: 17H

Command package: No parameters.

Return package: No parameters.

18H Restart the reader

Function: Restart the reader.

Command code: 18H

Command package: No parameters.

Return package: No parameters.

19H RESTORE WIFI FACTORY SETTINGS

Function: When the WIFI module needs to be reconfigured, send this

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.

Command code: 19H

Command package: No parameters.

Return package: No parameters.

1BH sets the reader time

Function: Set the time of the reader's internal real-time clock.

20201118RevA|Page 36 of 81
Reader Communication protocol(VUP)

Command code: 1BH

Command package: 1 parameter.

Parameter 1: 6 bytes, time to set. They are: year, month, day, hour,

minute, second.

Return package: No parameters.

1CH gets the reader time

Function: Gets the time of the reader's internal real-time clock.

Command code: 1CH

Command package: No parameters.

Return package: 1 parameter.

Parameter 1: 6 bytes, time. They are: year, month, day, hour, minute,

second.

1FH sets the tag filter

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.

Command code: 1FH

Command package: 4 parameters.

Parameter 1: 1 byte, whether to enable the filter. 0--Off, 1--On.

20201118RevA|Page 37 of 81
Reader Communication protocol(VUP)

Parameter 2: 1 byte, mask address Addr, range 0-63.

Parameter 3: 1 byte, mask length Len, maximum 64.

Parameter 4: Len bytes, mask data.

Note: Because the maximum EPC length that the reader can recognize is

512Bit. So the length of Addr + Len should not exceed 64.

Return package: No parameters.

20H Get Tag Filter

Function: Get the content of a tag filter.

Command code: 20H

Command package: No parameters.

Return package: 4 parameters.

Parameter 1: 1 byte, whether to enable the filter. 0--forbidden, 1--on.

Parameter 2: 1 byte, mask address Addr, range 0-63.

Parameter 3: 1 byte, mask length Len, maximum 64.

Parameter 4: Len bytes, mask data.

23H Set RJ45 local network parameters

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)

time is about 2 seconds.

Command code: 23H

Command package: 4 parameters.

Parameter 1: 4 bytes, IP address. For example, 192.168.0.213 is C0H A8H

00H D5H

Parameter 2: 4 bytes, mask. For example, 255.255.255.0 is FFH FFH FFH

00H

Parameter 3: 4 bytes, gateway. For example, 192.168.0.1 is C0H A8H 00H

01H

Parameter 4: 2 bytes, listening port (TCP/UDP public). For example, 1969

is 07H B1H

Return package: No parameters.

24H Obtain RJ45 local network parameters

Function: This command is used to obtain the network address of the reader

ethernet. Include IP address, subnet mask. Default gateway, port number.

Command code: 24H

Command package: No parameters.

Return package: 4 parameters.

Parameter 1: 4 bytes, IP address. For example, 192.168.0.213 is C0H A8H

00H D5H

20201118RevA|Page 39 of 81
Reader Communication protocol(VUP)

Parameter 2: 4 bytes, mask. For example, 255.255.255.0 is FFH FFH FFH

00H

Parameter 3: 4 bytes, gateway. For example, 192.168.0.1 is C0H A8H 00H

01H

Parameter 4: 2 bytes, listening port (TCP/UDP public). For example, 1969

is 07H B1H

27H Set RJ45 remote network parameters

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

cause the reader to restart automatically.

Command code: 27H

Command package: 6 parameters.

Note: This command is backward compatible and can send only 1, 2, and

3 parameters, or all parameters.

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 3: 1 byte, whether to enable UDP reporting, 0--no, 1--yes.

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.

Parameter 6: 1 byte, whether to enable TCP reporting, 0--no, 1--yes. If TCP

reporting is enabled, the reader will switch to TCP Client mode, otherwise, the

reader will be in TCP Server mode.

Return package: No parameters.

28H Obtain RJ45 remote network parameters

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

the host IP and port set in this instruction.

Command code: 28H

Command package: No parameters.

Return package: 3 parameters.

Note: This command is backward compatible and can return only 1, 2, and

3 parameters, or all parameters.

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 3: 1 byte, whether to enable UDP reporting, 0--no, 1--yes.

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.

Parameter 6: 1 byte, whether to enable TCP reporting, 0--no, 1--yes.

25H Set the MAC address

Function: Set the MAC address of the reader.

Command code: 25H

Command package: 1 parameter.

Parameter 1: 6 bytes, MAC address.

Return package: No parameters.

26H Obtain the MAC address

Function: Get the reader MAC address.

Command code: 26H

Command package: no arguments.

Return package: 1 parameter.

Parameter 1:6 bytes, MAC address.

31H Set up the label alarm device

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).

Command code: 31H

Command package: 4 parameters

Parameter 1:1 byte, whether the alarm is enabled.0- -Ban, 1- -Open.

Parameter 2:1 byte, mask address Addr, range 0-63.

Parameter 3:1 byte, mask length Len, maximum 64.

Parameter 4: Len bytes, mask the data.

Note: The maximum recognized EPC length is 512Bit. Therefore, the

length of Addr + Len should not exceed 64.

Return package: no parameter.

32H Get Tag Alarm

Function: Get the contents of the label alarm

Command code: 32H

Command package: no arguments.

Return package: 4 parameters.

Parameter 1:1 byte, whether the alarm is enabled.0- -Ban, 1- -Open.

Parameter 2:1 byte, mask address Addr, range 0-63.

Parameter 3:1 byte, mask length Len, maximum 64.

Parameter 4: Len bytes, mask the data.

20201118RevA|Page 43 of 81
Reader Communication protocol(VUP)

33H Set up the reader and writer ID

Function: Set up the reader and writer ID.

Command code: 33H

Command package: 1 parameter.

Parameter 1: the ASCII code of up to 24 bytes.

Return package: no parameter.

34H Gets the reader ID

Function: Get the reading and the writer ID.

Command code: 34H

Command package: no arguments.

Return package: 1 parameter.

Parameter 1: the ASCII code of up to 24 bytes.

35H Sets the reader / writer name

Function: Set the reader name.

Command code: 35H

Command package: 1 parameter.

Parameter 1: the ASCII code of up to 24 bytes.

Return package: no parameter.

20201118RevA|Page 44 of 81
Reader Communication protocol(VUP)

36H Gets the reader name

Function: Get the reading and writer name.

Command code: 36H

Command package: no arguments.

Return package: 1 parameter.

Parameter 1: the ASCII code of up to 24 bytes.

39H Set heartbeat pack

Function: The reader supports the custom heartbeat packet function, sending

the heartbeat packets to the connected upper computer at regular intervals.

Users can set the heartbeat packet function through this command.

Command code:39H

Command package: 3 parameters.

Parameter 1:1 byte, whether to open the heartbeat package.0- -Not open,

1- -open.

Parameter 2:1 byte, heartbeat packet interval.

Parameter 3: up to 24 bytes, the ASCII code of the heartbeat data.

Return package: no parameter

43H Get the heartbeat packet

Function: Get the heartbeat packet parameters.

20201118RevA|Page 45 of 81
Reader Communication protocol(VUP)

Command code: 43H

Command package: no arguments.

Return package: 3 parameters.

Parameter 1:1 byte, whether to open the heartbeat package.0- -Not open, 1- -

open.

Parameter 2:1 byte, heartbeat packet interval. Unit: seconds.

Parameter 2:1 byte, heartbeat packet interval. Unit: seconds.

4DH Set the WIFI parameter

Function: Set the parameters of the WIFI module, this command takes 3-4

seconds, mainly because the WIFI module configuration takes time

Command code: 4DH

Command package: 10 parameters.

Parameter 1:1 byte, WIFI working mode.

0--UDP Server,1--TCP Server,2--UDP Client,3--TCP Client。

Parameter 2:4 bytes, local_ip, local IP address.

Parameter 3:4 bytes, mask, subnet mask.

Parameter 4:4 bytes, gateway, the default gateway.

Parameter 5:2 bytes, local or remote port. Port number, high bytes in

front, low bytes in back.

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

which you want to connect.

Parameter 6: 4 bytes, remote_ip, indicates the address of the server to

which you want to connect.

If you are doing a client, you need to configure this parameter, which

indicates which server you want to connect to.

If you are a client, you can send random 4 bytes.

Parameter 7: 1 byte, indicating the length of the WIFI name to be

connected n, maximum 32 bytes.

Parameter 8: n bytes, indicating the WIFI name ASCII code to be

connected.

Parameter 9: 1 byte, indicating the password length p to connect to WIFI,

up to 64 bytes.

Parameter 10: p bytes, indicating the ASCII code of the password to

connect to WIFI.

Return package: No parameters.

4EH Get WIFI parameters

Function: Get the parameters of the WIFI module.

Command code: 4EH

Command package: No parameters.

20201118RevA|Page 47 of 81
Reader Communication protocol(VUP)

Return package: see 4DH command package parameters.

4FH sets the parameters of the super network port

Function: Set the parameters of the super network port, this command takes

3-4 seconds, mainly the module configuration takes time.

Command code: 4FH

Command package: 6 parameters.

Parameter 1: 1 byte, network port mode.

0--UDP Server,1--TCP Server,2--UDP Client,3--TCP Client。

Parameter 2: 4 bytes, IP address.

Parameter 3: 4 bytes, subnet mask.

Parameter 4: 4 bytes, default gateway.

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.

Parameter 6: 4 bytes, remote_ip, indicates the address of the server to

connect to.

If you are doing a client, you need to configure this parameter, which

indicates which server you want to connect to.

If you are a client, you can send random 4 bytes.

20201118RevA|Page 48 of 81
Reader Communication protocol(VUP)

Return package: No parameters.

50H Obtain the parameters of the super network

port

Function: Get the parameters of the super network port module.

Command code: 50H

Command package: No parameters.

Return package: See 4FH command package parameters.

51H Set 4G parameters

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.

Command code: 51H

Command package: 4 parameters.

Parameter 1:1 Bytes, transport mode.0--UDP Client,1--TCP Client

Parameter 2:2 bytes, port, high byte in front, low bytes in back.

Parameter 3:1 byte, IP address, or domain name length, n.

Parameter 4: n bytes, the IP address, or the ASCII code for the domain

name, and up to 64 bytes are supported.

Return package: no parameter.

20201118RevA|Page 49 of 81
Reader Communication protocol(VUP)

52H Get 4G parameters

Function: Obtain the 4G parameters.

Command code: 52H

Command package: no arguments.

Return package: see the command package parameter for 51H.

1.4 Automatic mode related commands

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.

09H Setting relay automatic control parameters

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

Command package: 3 parameters.

20201118RevA|Page 50 of 81
Reader Communication protocol(VUP)

Parameter 1: 1 byte, relay number.1,2,3...

Parameter 2: 1 byte. The purpose of the relay.

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 3: 1 byte. Pickup time. Unit: second.

Return package: no parameters.

0AH Obtain relay automatic control parameters

Function: obtain the parameters of the specified relay.

Command code: 0AH

Command package: 1 parameter.

Parameter 1: 1 byte, relay number. 1,2,3...

Return package: 2 parameters.

Parameter 1:1 bytes. The purpose of the relay. See the table above.

Parameter 2: 1 byte. Pickup time. Unit: second.

20201118RevA|Page 51 of 81
Reader Communication protocol(VUP)

15H Setting the automatic polling antenna

Function: If it is a reader writer that supports multiple antennas, this

command can be used to set the polling antennas for automatic card reading.

After configuring the polling antenna, the reader will automatically poll each

selected antenna one by one.

Command code: 15H

Command package: 1 parameter.

Parameter 1: several bytes, antenna number. 1,2,3,4...

For example, if you want to select automatic polling antennas 1, 3 and 4, the

parameters are 3 bytes, respectively 01H 03H 04H

Return package: no parameters.

16H Get automatic polling antenna

Function: Obtain the antenna polled during automatic card reading.

Command code: 16H

Command package: No parameters.

Return package: 1 parameter.

Parameter 1: several bytes, antenna number. 1,2,3,4...

For example, if the number of automatic polling antennas is 1, 3, and 4,

the parameter is 3 bytes, respectively 01H 03H 04H

20201118RevA|Page 52 of 81
Reader Communication protocol(VUP)

21H Set Auto Read Label Type

Function: set the label type that can be read during automatic card

reading.

Command code: 21H

Command package: 1 parameter.

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.

Return package: no parameters.

22H Get Auto Read Label Type

Function: to obtain the label types that can be read during automatic card

reading.

Command code: 22H

Command package: No parameters.

Return package: 1 parameter.

Parameter 1:1 bytes, recognizable label type, bitmap form. See the table
above.

29H Set the reported hardware interface

20201118RevA|Page 53 of 81
Reader Communication protocol(VUP)

Function: The reader writer supports multiple hardware interfaces to report

label data. This instruction can be used to set which hardware interface is

used for reporting.

Command code: 29H

Command package: 2 parameters.

Parameter 1: 1 byte, hardware interface number. See the following table

for the representative meanings of numbers:

CODE CORRESPONDI
NG INTERFACE
00H RS232
01H RS485
02H RJ45
03H WIEGAND 26
04H WIEGAND 34
05H WIFI
06H 4G

Parameter 2: 1 byte, whether to open reporting of this interface. 0 --

Closed, 1 -- Open.

Return package: no parameters.

2AH Get the reported hardware interface

Function: The reader writer supports multiple hardware interfaces to report

label data. This instruction can be used to obtain which hardware interface is

used for reporting.

Command code: 2AH

Command package: 1 parameter.

20201118RevA|Page 54 of 81
Reader Communication protocol(VUP)

Parameter 1: 1 bytes, hardware interface number, see the table above.

Indicates which interface reporting function to obtain.

Return package: 1 parameter.

Parameter 1: 1 byte, whether the reporting function of this interface is

enabled. 0 -- Closed, 1 -- Open.

2BH Set automatic reporting fields

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.

Command code: 2BH

Command package: 5 parameters.

Parameter 1: 4 bytes constitute a 32bit data, and the report field selects

bitmap. Send high byte first.

TAG NO. FIELDS


BIT0 EPC(UID),DEFAULT
SELECTION
BIT1 TID,NOT SELECTED BY
DEFAULT

20201118RevA|Page 55 of 81
Reader Communication protocol(VUP)

BIT2 USER,NOT SELECTED BY


DEFAULT
BIT3 RSSI VALUE,DEFAULT
SELECTION
BIT4 TIME STAMP,DEFAULT
SELECTION
BIT5 LABEL TYPE,DEFAULT
SELECTION
BIT6 IP ADDRESS,DEFAULT
SELECTION
BIT7 ANTENNA
NUMBER,DEFAULT
SELECTION
BIT8 DEVICE ID
... RETAIN

BIT26 CUSTOM FIELDS 4,NOT


SELECTED BY DEFAULT
BIT27 CUSTOM FIELDS 3,NOT
SELECTED BY DEFAULT
BIT28 CUSTOM FIELDS 2,NOT
SELECTED BY DEFAULT
BIT29 CUSTOM FIELDS 1,NOT
SELECTED BY DEFAULT
BIT30 CUSTOM FIELDS 0,NOT
SELECTED BY DEFAULT
BIT31 RETAIN

Parameter 2: 1 byte, starting address of TID area, must be an integer multiple

of 2.

Parameter 3: 1 byte, TID length, must be an integer multiple of 2.

Parameter 4: 1 byte, the starting address of the USER area, which must be an

integer multiple of 2.

Parameter 5: 1 byte, USER length, 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

USER area cannot be 0.

Return package: no parameters.

2CH Get automatic reporting fields

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

through this instruction.

Command code: 2CH

Command package: No parameters.

Return package: 5 parameters.

Parameter 1: 4 bytes constitute a 32bit data, and the report field selects

bitmap. Send high byte first. See the table above.

Parameter 2: 1 byte, starting address of TID area.

Parameter 3: 1 byte, TID area length. The maximum length is 6 bytes.

Parameter 4: 1 byte, starting address of USER area.

Parameter 5: 1 byte, USER area length. The maximum length is 6 bytes.

1AH Set automatic submission content

Function: When the reader writer works automatically, it will automatically

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)

can set them as needed.

Command code: 1AH

Command package: 2 parameters.

Parameter 1: 1 bytes, custom field number. Starting from 0, up to 5 user-

defined fields are supported.

Parameter 2: ASCII code with a maximum length of 24 bytes, which is

used to specify the content of the user-defined field of the route.

Return package: no parameters.

44H Get the content of automatic report

Function: get the content of user-defined fields during automatic reporting.

Command code: 43H

Command package: 1 byte, reporting field number. Starting from 0, up to 5

reports are supported.

Return package: 1 parameter.

Parameter 1: The maximum length is 24 bytes, and the self defined

reporting field data ASCII code of this route.

37H Set automatic reporting conditions

Function: This instruction is used to set the conditions for automatic label

reporting. Note that this function is invalid in two-way trigger mode.

20201118RevA|Page 58 of 81
Reader Communication protocol(VUP)

Command code: 37H

Command package: 2 parameters.

Parameter 1:1 bytes, reporting mode. See the table below:

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.

Parameter 2: 1 byte, reporting interval. Unit: second.

Return package: no parameters.

38H Get automatic reporting conditions

Function: When the reader writer is working automatically, this command can

be used to obtain the time for label reporting.

Command code: 38H

20201118RevA|Page 59 of 81
Reader Communication protocol(VUP)

Command package: No parameters.

Return package: 2 parameters.

Parameter 1:1 bytes, reporting mode.

Parameter 2: 1 byte, reporting interval. Unit: second.

2DH Set Wiegand parameters

Function: When the reader/writer supports the Wigan interface, the time

parameter of Wigan output can be set through this instruction.

Command code: 2DH

Command package: 2 parameters.

Parameter 1:1 bytes, Wiegand pulse width. Unit: 10us

Parameter 2: 1 byte, Wiegand pulse interval. Unit: 10us

Return package: no parameters.

2EH Get Wiegand parameters

Function: When the reader/writer supports the Wigan interface, the time

parameter of Wigan output can be obtained through this instruction.

Command code: 2EH

Command package: No parameters.

Return package: 2 parameters.

Parameter 1:1 bytes, Wiegand pulse width. Unit: 10us

20201118RevA|Page 60 of 81
Reader Communication protocol(VUP)

Parameter 2: 1 byte, Wiegand pulse interval. Unit: 10us

2FH Set trigger conditions

Function: When the reader writer works in the trigger mode (including switch

trigger mode and channel door trigger mode), set the trigger conditions

through this command.

Command code: 2FH

Command package: 3 parameters.

Parameter 1:1 bytes, select the trigger number to be set. Number starts

from 1, 1.2.3

Parameter 2: 1 byte, trigger level. 0 -- Low level, 1 -- High level.

Parameter 3: 1 byte, duration of triggering card reading. Unit: second.

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.

If it is a two-way trigger mode, it indicates the trigger timeout. For

example, if it is set to 3 seconds, it means that the card reading starts after

Trigger 1 is triggered and stops until Trigger 2 is triggered, or it stops after 3

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.

Return package: no parameters.

30H Get trigger conditions

20201118RevA|Page 61 of 81
Reader Communication protocol(VUP)

Function: When the reader writer is working in the trigger mode, the trigger

conditions can be obtained through this instruction.

Command code: 30H

Command package: 1 parameter.

The parameter is 1:1 bytes, specifying the trigger number to be obtained.

Number starts from 1, 1.2.3

Return package: 2 parameters.

Parameter 2: 1 byte, trigger level. 0 -- Low level, 1 -- High level.

Parameter 3: 1 byte, trigger duration. Unit: second.

1.4 UHF protocol command

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

development method, users generally follow the following development

process.

20201118RevA|Page 62 of 81
Reader Communication protocol(VUP)

3AH Switching working antenna

Function: If the user controls the operation of the reader writer through the

command mode, when the working antenna needs to be switched, this

command is used for switching.

20201118RevA|Page 63 of 81
Reader Communication protocol(VUP)

Command code: 3AH

Command package: 1 parameter.

Parameter 1: 1 byte, antenna number. 1.2.3...

Return package: no parameters.

80H Identify 6C tags

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

command has multiple return packets.

Command code: 80H

Command package: 4 parameters.

Note: The starting address and length must be an integer multiple of 2. If

the mem is EPC, the starting address and length are invalid, and it can be

passed to 0. If no access password is set for the tag, just pass 0.

Parameter 1: one byte, select the region mem where the label is listed.

Code Area
00H PASSWORD
01H EPC
02H TID
03H User

Parameter 2: 1 byte, starting address addr. Unit: byte.

Parameter 3: 1 byte, length len. Unit: byte.

20201118RevA|Page 64 of 81
Reader Communication protocol(VUP)

Parameter 4: 4 bytes, access password.

Return package: 4 parameters/no parameters.

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,

parameter 3 and parameter 4.

Parameter 1: 1 byte, EPC length epclean. Unit: byte.

Parameter 2: epclean bytes, representing the EPC number of the tag.

Parameter 3: 1 byte, data length datalen. Unit: byte.

Parameter 4: datalen bytes, specifying the data of the region.

Example: (The following data are hexadecimal, and the suffix H 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

return package are as follows:

Return package 1: F0 xx xx xx 80 04 11 22 22 04 55 66 66 check

20201118RevA|Page 65 of 81
Reader Communication protocol(VUP)

Return package 2: F0 xx xx xx 80 04 33 44 44 04 77 88 88 check

Return package 3: F0 xx xx xx 80 check

81H Read 6C label

Function: read a piece of data at the beginning of the specified address of the

specified data area on the specified label.

Command code: 81H

Command package: 6 parameters.

Note: The starting address and length must be an integer multiple of 2. If

no access password is set for the tag, just pass 0. If the EPC area is written, it

is generally written from the address 2. If the EPC length needs to be

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

the length of EPC is 6 * 2 bytes, that is, 12 bytes, 96 bits.

Parameter 1: one byte, select the label area mem. Refer to the 80H

command.

Parameter 2: 1 byte, starting address addr. Unit: byte.

Parameter 3: 1 byte, read length len. Unit: byte.

Parameter 4: 4 bytes, access password.

Parameter 5: 1 byte, target tag EPC length, epclean. Unit: byte.

Parameter 6: epclean bytes, EPC number of the target tag.

20201118RevA|Page 66 of 81
Reader Communication protocol(VUP)

Return package: 1 parameter.

Parameter 1: len bytes, read data.

82H Write 6C label

Function: Write a piece of data at the beginning of the specified address of the

specified data area on the specified label.

Command code: 82H

Command package: 6 parameters.

Note: The starting address and length must be an integer multiple of 2. If

no access password is set for the tag, 0 can be passed.

Parameter 1: one byte, select the label area mem. Refer to the 80H

command.

Parameter 2: 1 byte, starting address addr to be written. Unit: byte.

Parameter 3: 1 byte, length len to be written. Unit: byte.

Parameter 4: 4 bytes, access password.

Parameter 5: 1 byte, target label EPC length epclean. Unit: byte.

Parameter 6: epclean bytes, EPC number of the target tag.

Parameter 7: len bytes, data to be written.

Return package: no parameters.

83H Lock 6C label

20201118RevA|Page 67 of 81
Reader Communication protocol(VUP)

Function: Write a piece of data at the beginning of the specified address of the

specified data area on the specified label.

Command code: 83H

Command package: 6 parameters.

Note: If no access password is set for the tag, just pass 0.

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

Parameter 3: 4 bytes, access password.

Parameter 4: 1 byte, target label EPC length epclean. Unit: byte.

Parameter 5: epclean bytes, EPC number of the target tag.

Return package: no parameters.

20201118RevA|Page 68 of 81
Reader Communication protocol(VUP)

84H Destroy 6C label

Function: Destroy a tag.

Command code: 84H

Command package: 3 parameters.

Note: If no destruction password is set for the tag, just pass 0.

Parameter 1: 4 bytes, destroy password.

Parameter 2: 1 byte, target label EPC length epclean. Unit: byte.

Parameter 3: epclean bytes, EPC number of the target tag.

Return package: no parameters.

85H Write EPC for 6C tag

Function: write the EPC number of the tag and automatically modify the EPC

length of the tag.

Command code: 85H

Command package: 5 parameters.

Note: The EPC length must be an integral multiple of 2. If the tag does not

have an access password, pass 0.

Parameter 1: 4 bytes, access password.

Parameter 2: 1 byte, original label EPC length oldlen. Unit: byte. If this

parameter is 0, a tag will be written randomly.

20201118RevA|Page 69 of 81
Reader Communication protocol(VUP)

Parameter 3: oldlen bytes, original EPC number.

Parameter 4: 1 byte, the new EPC length is newlen. Unit: byte.

Parameter 5: newlen bytes, new EPC number.

Return package: no parameters.

90H List 6B labels

Function: List 6B tags.

Command code: 90H

Command package: No parameters.

Return package: 1 parameter/no parameter.

Note: The instruction has multiple return packages. Each tag returns a

return package. After all tags are returned, an empty package is returned,

indicating that all tags are returned.

Parameter 1: 8 bytes, UID.

Example: (The following data are hexadecimal, and the suffix H is

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

return package are as follows:

20201118RevA|Page 70 of 81
Reader Communication protocol(VUP)

Return package 1: F0 xx xx xx 90 01 02 03 04 05 06 07 08 check

Return package 2: F0 xx xx xx 90 01 02 03 04 05 06 07 09 check

Return package 3: F0 xx xx xx 90 check

91H Read 6B label

Function: Read 6B label.

Command code: 91H

Command package: 3 parameters.

Parameter 1: 8 bytes, UID.

Parameter 2: 1 byte, read address.

Parameter 3: 1 byte, read length len.

Return package: 1 parameter.

Parameter 1: len bytes, read data.

92H Write 6B label

Function: write 6B tag.

Command code: 92H

Command package: 4 parameters.

Parameter 1: 8 bytes, UID.

Parameter 2: 1 byte, write address.

Parameter 3: 1 byte, write length len.

20201118RevA|Page 71 of 81
Reader Communication protocol(VUP)

Parameter 4: len bytes, data to be written.

Return package: no parameters.

93H Lock 6B label

Function: lock 6B tag.

Command code: 93H

Command package: 2 parameters.

Parameter 1: 8 bytes, UID.

Parameter 2: 1 byte, lock the address.

Return package: no parameters.

1.5 HF protocol command

70H List high frequency labels

Function: When the reader writer works in the command mode, the

control machine can list the high-frequency tags within the antenna

recognition range through this command. This instruction is a one to many

instruction, that is, a command has multiple return packets.

Command code: 70H

Command package: No parameters.

Return package: 3 parameters/no parameters.

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)

returned indicating that all tags are returned.

Parameter 1: 1 bytes, high frequency tag type, see the following table.

CODE Label communication


protocol
41H Type-A(ISO-14443A)
42H Type-B
46H Type-F
56H Type-V(ISO-15693)

Parameter 2: 1 byte, label length len, unit: byte.

Parameter 3: len bytes, label content.

Example: (The following data are hexadecimal, and the suffix H is

omitted)

Suppose that two 15693 labels are identified when the labels are listed,

and their UIDs are:

”UID1: 11112222”

“UID2: 33334444”

The reader/writer will return three return packets, each of which is as

follows:

Return package 1: F0 xx xx xx 70 56 04 11 22 22 check//tag 1

Return package 2: F0 xx xx xx 70 56 04 33 44 44 check//tag 2

Return package 3: F0 xx xx xx 70 check//End package

71H Read 15693 label

20201118RevA|Page 73 of 81
Reader Communication protocol(VUP)

Function: read 15693 label data block, one data block is 4 bytes.

Command code: 71H

Command package: 4 parameters.

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.

Parameter 2: len bytes, label UID.

Parameter 3: 1 byte, which data block to read from, and 0 to number.

Parameter 4: 1 byte, the number of read data blocks.

Return package: 1 parameter.

Parameter 1: Several bytes, returning the read data block content.

72H Write 15693 label

Function: write 15693 label data block, one data block is 4 bytes.

Command code: 72H

Command package: 4 parameters.

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.

Parameter 2: len bytes, label UID.

Parameter 3: 1 byte, write data block address.

20201118RevA|Page 74 of 81
Reader Communication protocol(VUP)

Parameter 4: 4 bytes, write data.

Return package: no parameters.

73H Read 14443A label

Function: read 14443A label data block, one data block is 4 bytes.

Command code: 73H

Command package: 4 parameters.

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.

Parameter 2: len bytes, label UID.

Parameter 3: 1 byte, which data block to read from, and 0 to number.

Parameter 4: 1 byte, number of read data blocks n.

Return package: 1 parameter.

Parameter 1: Several bytes, returning the read data block content.

74H Write 14443A label

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

areas are not writable.

20201118RevA|Page 75 of 81
Reader Communication protocol(VUP)

Command code: 74H

Command package: 4 parameters.

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.

Parameter 2: len bytes, label UID.

Parameter 3: 1 byte, write data block address.

Parameter 4: 4 bytes, write data.

Return package: no parameters.

75H Select 14443A label sector

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.

Command code: 75H

Command package: 3 parameters.

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.

Parameter 2: len bytes, label UID.

Parameter 3: 1 byte, sector number, starting from 0.

Return package: no parameters.

76H Write 15693 label multi block data

Function: write 15693 label data block. One data block is 4 bytes. This

instruction can write multiple blocks.

Command code: 76H

Command package: 5 parameters.

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.

Parameter 2: len bytes, label UID.

Parameter 3: 1 byte, indicating which block to start writing from.

Parameter 4: 1 byte, indicating how many blocks of data to write, n>=0.

Parameter 5: n * 4 bytes, representing the written data. One block is 4 bytes,

and n blocks are 4 * n bytes.

Return package: no parameters.

77H Write 14443A label multiple pieces of data

20201118RevA|Page 77 of 81
Reader Communication protocol(VUP)

Function: write 14443A label data block. One data block is 4 bytes. This

instruction can write multiple blocks.

Command code: 77H

Command package: 5 parameters.

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.

Parameter 2: len bytes, label UID.

Parameter 3: 1 byte, indicating which block to start writing from.

Parameter 4: 1 byte, indicating how many blocks of data to write, n>=0.

Parameter 5: n * 4 bytes, representing the written data. One block is 4 bytes,

and n blocks are 4 * n bytes.

Return package: no parameters.

1.6 Status Package

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

data, such as automatically identified tag data, power, heartbeat, etc.

01H Automatic card reading data package

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.

Status code: 01H

Reporting parameters: The reporting parameters are in JSON format, and JSON

fields can be selected through the 2BH command. The meaning of each JSON

field is shown in the following table.

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)

Custom3 Represents a user-defined field 3


Custom4 Represents a user-defined field 4
Custom5 Represents a user-defined field 5

Example::

{ "Ant": 1, /* The antenna number that identifies


the tag */
"FIN": [1,2,3], /* trigger condition */
"Door": "In", /* Direction of access door */
"IP": "192.168.0.255", /* IP address of the reader writer */
"EPC" : "E0000001", /* EPC number of label */
"TID" : "E2003412", /* TID number of the label */
"USER" : "12345678", /* USER area data of label */
"ID": "20190909", /* Device ID of the reader writer*/
"RSSI": -20, /* Signal strength of the label */
"TS": 1605684444, /* Signal strength of the label */
"TagType" : 1, /* Label Type;1--6C,2--6B */
"Custom1" : "0a0b0c0d", /* User defined fields 1 */
"Custom2" : "0a0b0c0d", /* User defined fields 2 */
"Custom3" : "0a0b0c0d", /* User defined fields 3 */
"Custom4" : "0a0b0c0d" /* User defined fields 4 */
"Custom5" : "0a0b0c0d" /* User defined fields 5 */ }

02H UDP Broadcast packet

Function: The reader writer regularly sends UDP broadcast packets to port

4444 in the LAN for device discovery and connection.

Status code: 02H

Reporting parameters: The reporting parameters are in JSON format, and the

format is as follows.

{ "IP":"192.168.0.122", /* IP address of the reader writer */

"Port": 1969, /* The port number of the reader writer */

20201118RevA|Page 80 of 81
Reader Communication protocol(VUP)

"DeviceType": "VF-747P", /* Reader/writer device model: the

reader/writer model that can be set for customers */

"ID": "1234567890", /* Device ID number of the reader writer */

"RS485": 100, /* 485 address of reader writer */

"RS232Baud": 115200, /* Reader writer 232 baud rate */

"RS485Baud": 115200, /* 485 baud rate of reader writer */

“ti”:0 /* Main board model managed within the

company */

03H Heartbeat

Function: The reader writer sends heartbeat packets to the connected links

regularly. The contents of the heartbeat packets are user-defined.

Status code: 03H

Reporting parameters: The reporting parameters are in JSON format, and the

format is as follows.

{ "heartbeat":"12345678" }

20201118RevA|Page 81 of 81

You might also like