TCB Communications Protocol2.5
TCB Communications Protocol2.5
2 / 96
ANVIZ TC_B Communication Protocol User Manual
3 / 96
ANVIZ TC_B Communication Protocol User Manual
4 / 96
ANVIZ TC_B Communication Protocol User Manual
Added Command:
103.Get Result of Last Authentication (Pass/Fail)
CMD:0x79
5 / 96
ANVIZ TC_B Communication Protocol User Manual
1)Command format
STX CH(Device CMD(Comm LEN(Data DATA CRC16
No.) and) Length)
0xA5 4Byte 1Byte 2Byte 0-600Byte 2Byte
2)Response format:
STX CH(Devi ACK(Acknowle RET(Re LEN(Data DATA CRC1
ce No.) dgment ) turn Length) 6
Value)
0xA5 4Byte 1Byte( CMD+0 1Byte 2Byte 0-600Byte 2Byte
x80)
Description:
CH four bytes sequence: IDHH, IDHL, IDLH, IDLL;
CRC16 Checking is applied to all data,
CRC16 two bytes sequence: CRCL, CRCH;
All devices will response to following Commands, when CH is zero.
6 / 96
ANVIZ TC_B Communication Protocol User Manual
Part II Command
7 / 96
ANVIZ TC_B Communication Protocol User Manual
8 / 96
ANVIZ TC_B Communication Protocol User Manual
OA1000/OA3000/761
Platform Only
Update Firmware/Image/Voice Files CMD: 0x10 761 Platform
70
Only
Directory Operations CMD: 0x12 761 Platform
71
Only
Download Log Files CMD: 0x13 761 Platform
72
Only
73 Get Administrator’s Card No./ Password CMD: 0x1C T5 Only
74 Set Administrator’s Card No./ Password CMD: 0x1D T5 Only
75 Get Daylight Saving Timezone CMD: 0x1A
76 Set Daylight Saving Timezone CMD: 0x1B
77 Get Optional Language List CMD: 0x18
78 Set Optional Language List CMD: 0x19
Receive Feature Value/ Card No. to Execute
79 CMD: 0x78
Following Commands
80 Get GPRS Parameters CMD: 0x16
81 Set GPRS Parameters CMD: 0x17
82 Get Device Extended Info CMD: 0x7A
83 Modify Device Extended Info CMD: 0x7B
84 Get Card Info CMD: 0x7E T5s Only
Get Auto Restart Time CMD:0x14 761\OA1000
85
Only
Set Auto Restart Time CMD: 0x15 761\OA1000
86
Only
87 Extended Commands CMD: 0x2E
88 UDP Search Devices CMD: 0x02
89 UDP Set Device Parameters CMD: 0x03
90 Heartbeat Package CMD: 0x7F
91 Data Modification Alert CMD: 0x7D
92 Download Personnel Change Records CMD: 0x64
93 Download User’s Info (Extended) CMD: 0x65
94 Clear Personnel Change Records/ Flag CMD: 0x1E
95 Get Device Configuration 3 CMD: 0x34
96 Set Device Configuration 3 CMD: 0x35
Connection Authentication CMD: 0x04 Iris Device
97
Only
98 Get Device Configuration 4 CMD:0x36 M4 Only
99 Add Department CMD: 0x61 OA1000 Only
100 Delete Department CMD: 0x62 OA1000 Only
101 Download Specified User’s templates/images CMD: 0x66 OA1000 Only
102 Batch Download Users’ templates/Images CMD: 0x67 OA1000 Only
103 Get result of Last Authentication (Pass/Fail) CMD:0x79 Brazilian
9 / 96
ANVIZ TC_B Communication Protocol User Manual
Clients Only
104 Get State Switch Info. CMD: 0x68 C2 Pro Only
105 Set State Switch Info CMD: 0x69 C2 Pro Only
106 Upload User’s Image to Device CMD: 0x6D
107 Add Bluetooth Device CMD:0x6A M5 Only
108 Delete Specific Address of Bluetooth Device CMD:0x6B M5 Only
109 Get All Bluetooth Users’ Info CMD:0x6C M5 Only
110 Get WIFI Configuration CMD: 0x6E VX0 Only
111 Set WIFI Configuration CMD: 0x6F VX0 Only
112 Get Authorization Seed CMD: 0x05
113 Authorize CMD: 0x06
114 UDP Start Video CMD: 0x07
115 UDP Stop Video CMD: 0x08
116 UDP Command CMD: 0x09
117 Get a Specified Server’s URL CMD: 0x0A
118 Set a Specified Server’s URL CMD: 0x0B
119 User Exists CMD: 0x0C
10 / 96
ANVIZ TC_B Communication Protocol User Manual
Command: (10Byte)
STX CH CMD LEN CRC16
0xA5 IDHH IDHL IDLH 0x30 0x00 0x00 CRCL CRCH
IDLL
Response: (29Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xB0 ACK_SUCC 0x00 18Byte CRCL
IDLL ESS 0x12 CRCH
ACK_FAIL
platform Only)
Function: This command sets the communication password, sleep time delay , volume,
language, date format, attendance state, and language setting flag.
Any field without modification should be set as 0xFF.
Commands: (20Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x31 0x00 10Byte CRCL CRCH
IDLL 0x0A
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0xB1 ACK_SUCCE 0x00 0x00 CRCL CRCH
IDLL SS
ACK_FAIL
Function: This command gets the following parameters: the Precision of the fingerprint
matching, Fixed Wiegand Head Code, Wiegand Option, Work code permission, real-time
mode setting, FP auto update setting, relay mode, Lock delay, Memory overflow warning,
Repeat attendance delay, door sensor delay, scheduled bell delay.
12 / 96
ANVIZ TC_B Communication Protocol User Manual
Commands: (10Byte)
STX CH CMD LEN CRC16
0xA5 IDHH IDHL IDLH 0x32 0x00 0x00 CRCL CRCH
IDLL
Response: (26Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xB2 ACK_SUC 0x00 15Byte CRCL
IDLL CESS 0x0F CRCH
ACK_FAIL
13 / 96
ANVIZ TC_B Communication Protocol User Manual
Function: This command sets the following parameters: Precision , Fixed Wiegand Head
Code, Wiegand Option, Work code permission, real-time mode, FP auto update, relay
mode, Lock delay, out of records memory alert, Repeat attendance delay, door sensor
delay, scheduled bell delay.
Any field without modification should be set as 0xFF.
Commands: (25Byte)
STX CH CMD LEN Data CRC16
0xA5 IDHH IDHL IDLH 0x33 0x00 0x0F 15Byte CRCL CRCH
IDLL
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0xB3 ACK_SUCC 0x00 0x00 CRCL
IDLL ESS CRCH
ACK_FAIL
15 / 96
ANVIZ TC_B Communication Protocol User Manual
Function: This command retrieves the IP address, sub-net Mask, MAC address, Default
gateway, Server IP address, Remote Access Permission, Port Number, TCP/IP mode,
DHCP permission.
Commands: (10Byte)
STX CH CMD LEN CRC16
0xA5 IDHH IDHL IDLH 0x3A 0x00 0x00 CRCL CRCH
IDLL
Response: (38Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xBA ACK_SUC 0x00 27Byte CRCL
IDLL CESS 0x1B CRCH
ACK_FAIL
Data Format: (27Byte)
DATA IP Sub MAC Default Server Remot Port Mode DHCP
Add net Add Gatewa IP e Permi
y Acces ssion
s
Byte 1-4 5-8 9-14 15-18 19-22 23 24-2 26 27
5
Mode definition: 0-Server Mode, 1-Client Mode 2-Client Mode with Server URL enabled
Function: This command sets the IP address, sub-net Mask, MAC address, Default
gateway, Server IP address, Remote Access Permission, Port Number, TCP/IP mode,
DHCP permission.
Commands: (37Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x3B 0x00 0x1B 27Byte CRCL
IDLL CRCH
16 / 96
ANVIZ TC_B Communication Protocol User Manual
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0xBB ACK_SUCC 0x00 0x00 CRCL CRCH
IDLL ESS
ACK_FAIL
Function: This command gets record’s information, including the number of registered
users, Enrolled Fingerprints, Registered Passwords, Registered Cards, Attendance
Records, and New Records.
Commands: (10Byte)
STX CH CMD LEN CRC16
0xA5 IDHH IDHL IDLH 0x3C 0x00 0x00 CRCL CRCH
IDLL
Response: (29Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xB ACK_SUCC 0x00 18Byte CRCL
IDLL C ESS 0x22 CRCH
ACK_FAIL
Data Format: (18Byte)
DATA Number of Number of Number of Number of Number of Number of
Users FPs PWs Cards All New
Records Records
Byte 1-3 4-6 7-9 10-12 13-15 16-18
Function: This command downloads attendance records, the max number of records is 25
each time.(data length: 25*14 = 350Byte)
Commands: (12Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x40 0x00 0x02 2Byte CRCL
IDLL CRCH
Data Format:
17 / 96
ANVIZ TC_B Communication Protocol User Manual
Date/Time is an accumulator which counts the number of seconds that have elapsed
since 2000-01-01 00:00.
Backup code: bit 3—Card bit 2—Password bit 1—FP2 bit 0—FP1
If ‘Record Type’ bit 7(the seventh bit) is equal to 1, which means the door can be opened;
or it is equal to 0, which means the door can’t be opened; the low 4 bits is attendance
status.
18 / 96
ANVIZ TC_B Communication Protocol User Manual
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0xC1 ACK_SUCC 0x00 0x00 CRCL
IDLL ESS CRCH
ACK_FAIL
Function: This command downloads user’s info, maximum package size is 12 records per
download. (Data Length: 12*27= 324Byte)
P.S. Platform M3 and WinCE (OA1000, OA3000,Iris) use command 0x72; Platform 761
use command 0x22
Commands: (12Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x42 0x00 0x02 2Byte CRCL
IDLL CRCH
Data Format:
DATA Parameter Number of
Records
Byte 1 2
19 / 96
ANVIZ TC_B Communication Protocol User Manual
Function: This command uploads user’s info, the maximum upload number is 12 records
(the length of the info data: 12*27=324Byte )
P.S. Platform of M3 and WinCE ( OA1000,OA3000,Iris) use command 0x73;Platform use
command 0x23.
Commands: (11+N*27Byte // N is the number of records)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x43 1+N *27 (1+N CRCL
IDLL *27)Byte CRCH
Data Format: (1+N *25Byte)
DATA Records User Info 1 User Info 2 …
number N
Byte 1 2-28 29-55 …
Records number<=12
Data is set as 0xFF without input.
FP Registration State is Constant Zero
Response: (11Byte)
STX CH ACK RET LEN DAT CRC16
A
0xA5 IDHH IDHL IDLH 0xC3 ACK_SUC 0x00 2Byt CRCL
IDLL CESS 0x02 e CRCH
ACK_FAIL
Data Format: (2Byte)
DATA Flag
20 / 96
ANVIZ TC_B Communication Protocol User Manual
Byte 2
Flag: bit 0-11: Each bit represents the state of each upload(1: Succeed;0: Failed)
Commands: (16Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x44 0x00 0x06 6Byte CRCL
IDLL CRCH
Response: (349Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xC4 ACK_SUC 0x01 0x52 338Byte CRCL
IDLL CESS CRCH
ACK_FAIL
ACK_NO_
USER
Commands: (354Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x45 0x01 0x58 344Byte CRCL
IDLL CRCH
Data Format: (344Byte)
DATA User ID Bac Feature
kup
ID
Byte 1-5 6 7-344
It is applicable to Iris Devices, Commands: (1296Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x45 0x05 0x06 1286Byte CRCL
IDLL CRCH
22 / 96
ANVIZ TC_B Communication Protocol User Manual
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0xC5 ACK_SUCC 0x00 0x00 CRCL
IDLL ESS CRCH
ACK_FAIL
ACK_NO_U
SER
23 / 96
ANVIZ TC_B Communication Protocol User Manual
0xA5 IDHH IDHL IDLH 0xC6 ACK_SUCCE 0x00 0x04 4Byte CRCL
IDLL SS CRCH
ACK_FAIL
Data Format: (4Byte)
DATA Device ID
Byte 1-4
Commands: (10Byte)
STX CH CMD LEN CRC16
0xA5 IDHH IDHL IDLH 0x48 0x00 0x00 CRCL CRCH
IDLL
Response: (19Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xC8 ACK_SUCC 0x00 0x08 8Byte CRCL
IDLL ESS CRCH
ACK_FAIL
24 / 96
ANVIZ TC_B Communication Protocol User Manual
Byte 1-8
Commands: (18Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x49 0x00 0x05 8Byte CRCL
IDLL CRCH
Data Format: (8Byte)
DATA Type Code
Byte 1-8
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0xC9 ACK_SUCC 0x00 0x00 CRCL
IDLL ESS CRCH
ACK_FAIL
A) ANSI version
Commands: (10Byte)
STX CH CMD LEN CRC16
0xA5 IDHH IDHL IDLH 0x4A 0x00 0x00 CRCL CRCH
IDLL
Response: (21Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xC ACK_SUCC 0x00 0x0A 10Byte CRCL
IDLL A ESS CRCH
ACK_FAIL
25 / 96
ANVIZ TC_B Communication Protocol User Manual
Byte 1-10
B) UNICODE Version
Commands: (10Byte)
The same as ANSI version
Response: (31Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xC ACK_SUCC 0x00 0x14 20Byte CRCL
IDLL A ESS CRCH
ACK_FAIL
A) ANSI Version
Commands: (20Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x4B 0x00 0x0A 10Byte CRCL
IDLL CRCH
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0xCB ACK_SUCC 0x00 0x00 CRCL
IDLL ESS CRCH
ACK_FAIL
B) UNICODE Version
Commands: (30Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x4B 0x00 0x14 20Byte CRCL
IDLL CRCH
26 / 96
ANVIZ TC_B Communication Protocol User Manual
Commands: (16Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH IDLL 0x4C 0x00 0x06 6Byte CRCL CRCH
Backup ID Definition :
bit 3-Card;
bit 2-Password
bit 1-FP 2
bit 0-FP 1(optional, it does not delete the user’s information)
If Backup ID = 0xFF, all data of the user will be erased( including user’s information)
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0xCC ACK_SUCC 0x00 0x00 CRCL
IDLL ESS CRCH
ACK_NO_U
SER
Function: This command Initializes all data of a user, including: User Info, FP, PW, Card.
Commands: (10Byte)
STX CH CMD LEN CRC16
0xA5 IDHH IDHL IDLH IDLL 0x4D 0x00 0x00 CRCL CRCH
27 / 96
ANVIZ TC_B Communication Protocol User Manual
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0xCD ACK_SUCC 0x00 0x00 CRCL
IDLL ESS CRCH
ACK_FAIL
Function: This command deletes all records/ new records flag or partial new records flag.
Commands: (14Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x4E 0x00 0x04 4Byte CRCL
IDLL CRCH
Response: (14Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xC ACK_SUCC 0x00 3Byte CRCL
IDLL E ESS 0x03 CRCH
ACK_FAIL
28 / 96
ANVIZ TC_B Communication Protocol User Manual
Function: This command resets a T&A device to factory setting, except: language,
time/date format, communication parameters, device ID, Manufacture ID/info code and
Device Model code.
Commands: (10Byte)
STX CH CMD LEN CRC16
0xA5 IDHH IDHL IDLH 0x4F 0x00 0x00 CRCL CRCH
IDLL
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0xCF ACK_SUCC 0x00 0x00 CRCL
IDLL ESS CRCH
ACK_FAIL
Function: This command retrieves timezone value, the maximum number of timezone is
32.
Commands: (11Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x50 0x00 0x01 1Byte CRCL
IDLL CRCH
Data Format: (1Byte)
DATA No.
Byte 1
Response: (39Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xD0 ACK_SUC 0x00 0x1C 28Byte CRCL
IDLL CESS CRCH
ACK_FAIL
Data Format: (28Byte)
DAT Mon Tues Wed Thur Fri Sat Sun
A sub-timez sub-timez sub-timez sub-timez sub-timez sub-timez sub-timez
one one one one one one one
Byte 1-4 5-8 9-12 13-16 17-20 21-24 25-28
29 / 96
ANVIZ TC_B Communication Protocol User Manual
Commands: (39Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x51 0x00 0x1D 29Byte CRCL
IDLL CRCH
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0xD1 ACK_SUCC 0x00 0x00 CRCL
IDLL ESS CRCH
ACK_FAIL
Function: This command retrieves information of a group which is ranged from group 2 to
group 16. The group 0/1 is a normal close/ normal open group.
Commands: (11Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x52 0x00 0x01 1Byte CRCL
IDLL CRCH
Data Format: (1Byte)
DATA Group No.
Byte 1
Response: (15Byte)
30 / 96
ANVIZ TC_B Communication Protocol User Manual
Function: This command sets information of a group, ranged from group 2 to group 16.
The group 0/1 is a normal close/ normal open group.
Commands: (15Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x53 0x00 0x05 5Byte CRCL
IDLL CRCH
Function: This command retrieves time setting of all scheduled alarms, the maximum
number of alarms is 30.
Commands: (10Byte)
STX CH CMD LEN CRC16
0xA5 IDHH IDHL IDLH 0x54 0x00 0x00 CRCL CRCH
IDLL
Response: (101Byte)
31 / 96
ANVIZ TC_B Communication Protocol User Manual
Commands: (14Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x55 0x00 0x04 4Byte CRCL
IDLL CRCH
Data Format: (4Byte)
DATA No. Hour Minute Week Day
Byte 1 2 3 4
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0xD5 ACK_SUCC 0x00 0x00 CRCL
IDLL ESS CRCH
ACK_FAIL
32 / 96
ANVIZ TC_B Communication Protocol User Manual
Function: This command retrieves 50 messages for each inquiry, indexed from 0 to 49.
The maximum size for each message is 48 byte.
A) ANSI Version
Commands: (11Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x56 0x00 0x01 1Byte CRCL
IDLL CRCH
Response: (70Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xD6 ACK_SUCC 0x00 59 CRCL
IDLL ESS 0x3B Byte CRCH
ACK_FAIL
ACK_NO_U
SER
B) UNICODE Version
Commands: (11Byte)
Same as the ANSI Version
Response: (118Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xD6 ACK_SUCC 0x00 107 CRCL
IDLL ESS 0x6B Byte CRCH
ACK_FAIL
ACK_NO_U
SER
33 / 96
ANVIZ TC_B Communication Protocol User Manual
A) ANSI Version
Commands: (69Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x57 0x00 0x3B 59Byte CRCL
IDLL CRCH
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0xD7 ACK_SUCC 0x00 0x00 CRCL
IDLL ESS CRCH
ACK_FULL
B) UNICODE Version
Commands: (117Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x57 0x00 0x6B 107Byte CRCL
IDLL CRCH
Commands: (10Byte)
STX CH CMD LEN CRC16
0xA5 IDHH IDHL IDLH IDLL 0x58 0x00 0x00 CRCL CRCH
Response: (561Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xD8 ACK_SUCC 0x02 550Byte CRCL
IDLL ESS 0x26 CRCH
ACK_FAIL
35 / 96
ANVIZ TC_B Communication Protocol User Manual
Byte 1
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0xD9 ACK_SUCCESS 0x00 CRCL
IDLL ACK_FAIL 0x00 CRCH
ACK_EMPTY
If the index value is equal to ‘0xFF’, all messages will be deleted.
Commands: (10Byte)
STX CH CMD LEN CRC16
0xA5 IDHH IDHL IDLH IDLL 0x5A 0x00 0x00 CRCL CRCH
Response: (27Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xD ACK_SUCC 0x00 0x10 16Byte CRCL
IDLL A ESS CRCH
ACK_FAIL
36 / 96
ANVIZ TC_B Communication Protocol User Manual
If the number of T&A status is less than 16, then the unused status byte should be set as
0xFF.
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0xDB ACK_SUCCESS 0x00 0x00 CRCL
IDLL ACK_FAIL CRCH
Commands: (17Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x5C 0x00 0x07 7Byte CRCL
IDLL CRCH
Response: (12Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0xD ACK_SUCCESS 0x00 CRCL
IDLL C ACK_FAIL 0x00 CRCH
ACK_TIME_OUT
ACK_FULL(only applicable to
the first registration)
ST_USER_OCCUPIED(only
applicable to the first
registration)
ST_FINGER_OCCUPIED(only
applicable to the first
registration)
37 / 96
ANVIZ TC_B Communication Protocol User Manual
Function: This command retrieves device capacity parameter, including maximum number
of Users, fingerprints, and records.
Commands: (10Byte)
STX CH CMD LEN CRC16
0xA5 IDHH IDHL IDLH 0x5D 0x00 0x00 CRCL CRCH
IDLL
Response: (20Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xD ACK_SUCCE 0x00 0x09 9Byte CRCL
IDLL D SS CRCH
ACK_FAIL
Commands: (10Byte)
STX CH CMD LEN CRC16
0xA5 IDHH IDHL IDLH 0x5E 0x00 0x00 CRCL CRCH
IDLL
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0xDE ACK_SUCC 0x00 0x00 CRCL
IDLL ESS CRCH
ACK_FAIL
38 / 96
ANVIZ TC_B Communication Protocol User Manual
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0xDE ACK_SUCC 0x00 0x00 CRCL
IDLL ESS CRCH
ACK_FAIL
Function: This command, which only provides Response data packages, outputs T&A
records automatically after verification.
Response: (25Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xDF ACK_SUCCE 0x00 0x0E 14Byte CRCL
IDLL SS CRCH
ACK_FAIL
Date/Time is an accumulator which counts the number of seconds that have elapsed
since 2000-01-01 00:00.
If work code is set to 0xFF000,then any user is added offline will trigger a real time event
which will be saved into a database. (It will be available for generic firmware.)
A) ANSI Version
Commands: (10Byte)
STX CH CMD LEN CRC16
0xA5 IDHH IDHL IDLH IDLL 0x70 0x00 0x00 CRCL CRCH
Response: (172Byte)
39 / 96
ANVIZ TC_B Communication Protocol User Manual
B) UNICODE Version
Commands: (10Byte)
The same as ANSI Version.
Response: (332Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xF0 ACK_SUCC 0x01 321Byt CRCL
IDLL ESS 0x41 e CRCH
ACK_FAIL
Data Format: (321Byte)
DATA Status Status 0 Status 1 ... Status 15
No.
Byte 1 2-21 22-41 ... 302-321
The Maximum number of status is16.
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH IDLL 0xF1 ACK_SUCCE 0x00 0x00 CRCL
SS CRCH
ACK_FAIL
Customized attendance status 0x71 is one of attendance status modes, another is
supplied by 0x5B command . The default mode is 0x5B,status mode will be switched and
kept accordingly upon receipt of a 0x5B or 0x71 command.
B) UNICODE Version
Commands: (331Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x71 0x01 0x41 321Byte CRCL CRCH
IDLL
Function: This command downloads user data. The maximum data package contains 12
records for each download.
data length:12*30= 360Byte
A) ANSI Version
Commands: (12Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x72 0x00 0x02 2Byte CRCL
IDLL CRCH
Data Format:
DATA Parameter Number of
Data
Byte 1 2
41 / 96
ANVIZ TC_B Communication Protocol User Manual
Parameter definition:
= 0: downloading
= 1: Start downloading( Data parameter should be set to 1 for the inquiry of the first
data package.)
= 0x10: resend the previous data package
Number of data<=12
B) UNICODE Version
Function: The maximum data package contains 8 records for each download.(12 records
for ANSI Version)
The length of the data: 8*40= 320Byte
Command:(12Byte)
42 / 96
ANVIZ TC_B Communication Protocol User Manual
0xA5 IDHH IDHL IDLH 0xF2 ACK_SUCC (1+N *40) (1+N CRCL
IDLL ESS *40)Byte CRCH
ACK_FAIL
Data Format: (1+N *40Byte)
DATA Number of the User data 1 User data 2 …
Valid Records N
Byte 1 2-41 42-81 …
Function: This command uploads users’ data.The maximum data package contains 12
records for each upload( the length of each package is 12*30=360 Byte)
A) ANSI Version.
Commands: (11+N *30Byte // N is the number of records)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x73 1+N *30 (1+N CRCL
IDLL *30)Byte CRCH
Data Format: (1+N *30Byte)
DATA Records User Data1 User Data 2 …
Number N
Byte 1 2-31 32-61 …
Response: (13Byte)
STX CH ACK RET LEN DAT CRC16
A
43 / 96
ANVIZ TC_B Communication Protocol User Manual
B) UNICODE Version
Function: The maximum data package contains 8 records for each upload. The length of
each package is 8*30=320Byte. (12 records for ANSI)
44 / 96
ANVIZ TC_B Communication Protocol User Manual
Function: This command retrieves the time stamp of a User’s registration, time stamp
format is the number of seconds that have elapsed since 2000-01-01 00:00
Commands: (15Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x3E 0x00 0x04 5Byte CRCL
IDLL CRCH
Data Format: (4Byte)
DATA User ID
45 / 96
ANVIZ TC_B Communication Protocol User Manual
Byte 1-5
Response: (15Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xBE ACK_SUCC 0x00 4Byte CRCL
IDLL ESS 0x04 CRCH
ACK_FAIL
Data Format: (4Byte)
DATA Time Stamp
(Seconds)
Byte 1-4
Function: This command sets a time stamp of a user’s registration , value is equal to the
number of seconds have elapsed since 2000-01-01 00:00
Commands: (14Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x3F 0x00 0x04 4Byte CRCL
IDLL CRCH
Data Format: (4Byte)
DATA Time Stamp
(Secs)
Byte 1-4
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0xBF ACK_SUCC 0x00 0x00 CRCL
IDLL ESS CRCH
ACK_FAIL
46 / 96
ANVIZ TC_B Communication Protocol User Manual
Function: This command executes command 0x76 to retrieve a random number for data
encryption.
Commands: (19Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH IDLL 0x77 0x00 0x09 9Byte CRCL
CRCH
Data Format: (4Byte)
DATA Encrypted Encrypted
Model Language
Byte 1-8 9
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0xF7 ACK_SUCC 0x00 0x00 CRCL
IDLL ESS CRCH
ACK_FAIL
Function: This command retrieves the ‘Start Date’, ‘End Date’ and ‘Content’ of indexed
messages, which contains 200 records, ranged from 0 to 199, 450 byte in total.
It is applicable to OA3000 only
Commands: (12Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x26 0x00 0x02 2Byte CRCL
IDLL CRCH
Data Format: (2Byte)
DATA Index
47 / 96
ANVIZ TC_B Communication Protocol User Manual
Byte 2
Response: (472Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xA6 ACK_SUCC 0x01 461 CRCL
IDLL ESS 0xCD Byte CRCH
ACK_FAIL
ACK_NO_U
SER
Data Format: (461Byte)
DATA User ID Start End Date Title Content
Date
Y M D Y M D
Byte 1-5 6 7 8 9 10 11 12-61byte 62-461byte
Function: This command retrieve headers of all message. It is applicable to OA3000 Only
Commands: (11Byte)
STX CH CMD LEN DATA CRC16
48 / 96
ANVIZ TC_B Communication Protocol User Manual
0xA5 IDHH IDHL IDLH IDLL 0x28 0x00 1Byte CRCL CRCH
0x01
Data Format: (1Byte)
DATA Section
Number(0-3)
Byte 1
Response: (561Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xA8 ACK_SUCC 0x02 550Byte CRCL
IDLL ESS 0x26 CRCH
ACK_FAIL
Data Format: (550Byte)
DATA MSG MSG .... MSG 50*Section Number +49
50*Section 50*Section MSG Header
Number Number+1
MSG MSG Header
Header
Byte 1-11 12-22 ..... 540-550
Header Data Structure : (11Byte)
DATA User ID Start Date End Date
Y M D Y M D
Byte 1-5 6 7 8 9 10 11
If an indexed massage doesn’t exist, then all 11 bytes should be set as 0xFF.
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0xA9 ACK_SUCCESS 0x00 CRCL
IDLL ACK_FAIL 0x00 CRCH
ACK_EMPTY
49 / 96
ANVIZ TC_B Communication Protocol User Manual
Function: This command gets the setting of statuses switching. The maximum number of
statuses is 16. It is applicable to OA3000/OA1000 only
Commands: (11Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x20 0x00 0x01 1Byte CRCL
IDLL CRCH
Data Format: (1Byte)
DATA No.
Byte 1
Response: (40Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xA0 ACK_SUC 0x00 0x1D 29Byte CRCL
IDLL CESS CRCH
ACK_FAIL
Data Format: (29Byte)
DAT Mon Tues Wed Thurs Fri Sat Sun Status
A Sub-ti Sub-ti Sub-time Sub-time Sub-timez Sub-ti Sub-ti No.
mezon mezon zone zone one mezon mezon
e e e e
Byte 1-4 5-8 9-12 13-16 17-20 21-24 25-28 29
Sub-Timezone Data Format: (4Byte)
DATA Start Start Min. End Hour End Min.
Hour
Byte 1 2 3 4
Function: This command sets statuses switching setting. The maximum number of
statuses is 16. It is applicable to OA3000/OA1000 only
Commands: (40Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x21 0x00 0x1E 30Byte CRCL
IDLL CRCH
Data Format: (30Byte)
50 / 96
ANVIZ TC_B Communication Protocol User Manual
DAT NO. Mon Tues. Wed. Thur. Fir. Sat. Sun. Status
A Sub-ti Sub-ti Sub-ti Sub-ti Sub-ti Sub-ti Sub-ti No.
mezon mezon mezon mezon mezon mezon mezon
e e e e e e e
Byte 1 2-5 6-9 10-13 14-17 18-21 22-25 26-29 30
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0xA1 ACK_SUCC 0x00 0x00 CRCL
IDLL ESS CRCH
ACK_FAIL
51 / 96
ANVIZ TC_B Communication Protocol User Manual
Function : The maximum data package contains 6 records for each download( the length
of each package is 6*84=504 Byte) It is applicable to the 761 Platform only.
Commands: (12Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x22 0x00 0x02 2Byte CRCL
IDLL CRCH
Data Format:
DATA Param Records
eter Number
Byte 1 2
Parameters Definition:
= 0: Downloading
= 1: Start downloading (must send this message to receive first package)
= 0x10: resend the previous package
Records Number <=12
Response: (12+N *84Byte // N is the number of the valid records)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xA2 ACK_SUCC (1+N *84) (1+N CRCL
IDLL ESS *84)Byte CRCH
ACK_FAIL
Data Format: (1+N *84Byte)
DATA Valid Records User Data 1 User Data2 …
Number N
52 / 96
ANVIZ TC_B Communication Protocol User Manual
Function : Data package contains maximum 6 records for each download( the length of
each package is 6*84=504 Byte) it is applicable to the 761 Platform only
Response: (13Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xA3 ACK_SUC 0x00 2Byte CRCL
IDLL CESS 0x02 CRCH
ACK_FAIL
Data Format: (2Byte)
DATA Flag
Byte 2
Flag bit0-5: represents upload status (1:Succeed; 0:Failed )
53 / 96
ANVIZ TC_B Communication Protocol User Manual
54 / 96
ANVIZ TC_B Communication Protocol User Manual
Response: (19Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xAF ACK_SUCCE 0x00 0x08 8Byte CRCL
IDLL SS CRCH
ACK_FAIL
Data Format: (8Byte)
DATA State Reserved
Byte 1 2-8
State definition::
Bit 1: Door alarm state: 0-Normal 1-Fired
Bit 5: Door State: 0-Closed 1- Opened
Bit 6: State of magnetic door sensor 0-Closed 1-Opened
Bit 7: Lock state 0-Closed 1-Opened
Response: (14Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xAA ACK_SUCC 0x00 3 Byte CRCL
IDLL ESS 0x03 CRCH
ACK_FAIL
55 / 96
ANVIZ TC_B Communication Protocol User Manual
Function: This command retrieves maximum 50 headers of image files each time. It is
applicable to OA1000/OA3000/761 series only.
Commands: (12Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x2B 0x00 0x02 2Byte CRCL
IDLL CRCH
Data Format:
DATA Parameter Records
Number
Byte 1 2
Parameter Definition:
= 0: Downloading
= 1: Download Commencing ( Data parameter should be set to 1 for the inquiry of the
first data package.)
= 0x10: resend the previous data package
Number of records <=50
56 / 96
ANVIZ TC_B Communication Protocol User Manual
Commands: (13Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x2B 0x00 0x03 3Byte CRCL
IDLL CRCH
Data Format:
DATA Parameter Records Image Type
Number
Byte 1 2 1
Image type definition: 1- Succeed, 2-Failed, 3-Matching Failed, 4- Snapshot Mode
57 / 96
ANVIZ TC_B Communication Protocol User Manual
Date/Time : the number of seconds that have elapsed since 2000-01-01 00:00
58 / 96
ANVIZ TC_B Communication Protocol User Manual
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0xAD ACK_SUCCESS 0x00 CRCL
IDLL ACK_FAIL 0x00 CRCH
Function: This command updates firmware, image and voice files with 521byte packages
except the last package . It is applicable to the 761Platform only
Commands: (Byte)
STX CH CMD LEN DATA CRC16
59 / 96
ANVIZ TC_B Communication Protocol User Manual
Function: This command deals with directory operation, such as retrieving folders and
files name, deleting files and getting content of a file. It is applicable to the 761 platform
only.
60 / 96
ANVIZ TC_B Communication Protocol User Manual
= 1: Transmission Commencing
= 2: Transmission Completed
Type Definition:
=0: Retrieve files names and sub-directory names from a directory(Specified directory
name)
=1: Retrieve content of a specified file(specified file name)
=2: Delete a specified file(specified file name )
=3: Upload Firmware(no specified file name )
=4: Upload boot(no specified file name )
=5: Upload fonts (no specified file name )
=6: Upload image, Voice, configuration file (specify file name )
Index Definition:
Increment from 0
Index Definition:
Increment from 0
Notice: 1, “Transmission Commencing ” package doesn’t contain any real data, which
only indicates that the requested data is ready for transmission.
2.The separator for file, directory and files(directories) is 0xFE,0xFF and 0x00
61 / 96
ANVIZ TC_B Communication Protocol User Manual
respectively.
Function: Data package contains maximum 8 log records for each download( the length of
each package is 8*73=584 Byte) It is applicable to the 761Platform only
Commands: (12Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x13 0x00 0x02 2Byte CRCL
IDLL CRCH
Data Format:
DATA Parameter Record
Number
Byte 1 2
Parameter Definition :
= 0: Downloading
= 1: Downloading Commencing , (while retrieving all records , Data parameter should
be set to 1 for the inquiry of the first data package.)
= 0x10: resend the previous package
Records Number <=8
Response: (12+N *73Byte // N is the number of valid records)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x93 ACK_SUCC (1+N *73) (1+N CRCL
IDLL ESS *73)Byte CRCH
FAIL
Data Format: (1+N *73Byte)
DATA Number of Valid Attendance Attendance …
Records N Record 1 Record 2
Byte 1 2-74 75-147 …
Log Data Structure : (73Byte)
DATA User ID Date/Time Content
Byte 1-5 6-9 10-73
Date/Time: the number of seconds that have elapsed since 2000-01-01 00:00
Function: This command retrieves administrator ’s card ID for T5A and administrator’s
password for T50. It is applicable to T5 only.
62 / 96
ANVIZ TC_B Communication Protocol User Manual
Commands: (10Byte)
STX CH CMD LEN CRC16
0xA5 IDHH IDHL IDLH IDLL 0x1C 0x00 0x00 CRCL
CRCH
Response: (24Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x9C ACK_SUCCE 0x00 0x0D 13Byte CRCL
IDLL SS CRCH
ACK_FAIL
Data Format: (13Byte)
1) T5A
DATA Add Card Delete Duress Special
ID Card ID Card ID Info
Byte 1-4 5-8 9-12 13
Special Info definition::
Bit0: add the length of card ID 1- 32bit 0 - 24bit
Bit1: delete the length of Card ID 1 - 32bit 0 - 24bit
Bit2: Duress Card ID length 1 - 32bit 0 - 24bit
2) T50
DATA Admin PW Length Reserved
+Admin PW
Byte 1-3 4-13
The length of administrator’s password = Byte(1) >> 4
Function: This command sets administrator’s card ID for T5A and administrator password
for T50. It is applicable to T5 only
Commands: (23Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH IDLL 0x1D 0x00 0x0D 13Byte CRCL
CRCH
Data Format: (13Byte)
1) T5A
DATA Add Card Del Card Duress Special
ID ID Card Info
Byte 1-4 5-8 9-12 13
Special Info definition :
63 / 96
ANVIZ TC_B Communication Protocol User Manual
Function: This command retrieves daylight saving flag and time zone.
Commands: (10Byte)
STX CH CMD LEN CRC16
0xA5 IDHH IDHL IDLH IDLL 0x1A 0x00 0x00 CRCL
CRCH
Response: (27Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x9A ACK_SUCCE 0x00 0x10 16Byte CRCL
IDLL SS CRCH
ACK_FAIL
Data Format: (16Byte)
DATA Enable Date/ Start Time Special Info
/Disabl Week M D W D H M S M D W of D H M S
e Option of of M of
M W W
Byte 1 2 3 4 5 6 7 8 9 1 1 12 13 1 1 1
0 1 4 5 6
Enable/disable: 0-disable 1-enable ;
Day/Week option: 1-date format 2-week format;
Weeks of month definition :
0x01-0x04: previous 1-4 weeks
0x81-0x82: upcoming 1-2 weeks
Days of Week:
0-6: Sun/Mon/Tues/Wed/Thur/Fir/Sat
64 / 96
ANVIZ TC_B Communication Protocol User Manual
Commands: (26Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH IDLL 0x1B 0x00 0x10 16Byte CRCL
CRCH
Four languages can be selected from the list below. Once the setup is completed, the
display language can only be selected from the 4 languages.
65 / 96
ANVIZ TC_B Communication Protocol User Manual
Byte 1 2 3 4
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH IDLL 0x99 ACK_SUCC 0x00 0x00 CRCL
ESS CRCH
ACK_FAIL
Four language options can be set initially. Once set, the display language can only be
switch between these 4 options.
The list all language packs available within the SDK.
0xFF - not selected
0- simplified Chinese
66 / 96
ANVIZ TC_B Communication Protocol User Manual
1- Chinese Traditional
2- English
3- French
4- German
5- Spanish
6-Portuguese
7-Italian
8- Bulgarian
9- Slovak
10-hungarian
11-slovene
12-Turkish
13-Polish
14-Indonesian
15- Romanian
16-Russian
1) Feature Value
Commands: (189Byte)
STX CH CMD LEN CRC16
0xA5 IDHH IDHL IDLH IDLL 0x78 0x00 0xB3 CRCL
CRCH
Data Format: (179Byte)
DATA Type Reserved Feature
Value Data
Byte 1 2-10 11-179
Type 为 1
2)Card ID
Commands: (24Byte)
STX CH CMD LEN CRC16
0xA5 IDHH IDHL IDLH IDLL 0x78 0x00 0x0E CRCL
CRCH
Data Format: (14Byte)
DATA Type Reserved Card ID
Byte 1 2-10 11-114
Type is 2
3) Password
67 / 96
ANVIZ TC_B Communication Protocol User Manual
Commands: (24Byte)
STX CH CMD LEN CRC16
0xA5 IDHH IDHL IDLH IDLL 0x78 0x00 0x0E CRCL
CRCH
Data Format: (14Byte)
DATA Type User ID Date/Tim PW MS
e Length+PW Byte
Byte 1 2-6 7-10 11-13 14
Password Length = Byte(11) >> 4
Type 3
Response: (26Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xF8 ACK_SUC 0x00 15Byte CRCL
IDLL CESS 0x0F CRCH
ACK_FAIL
Data Format: (15Byte)
DATA Status User ID Date/ Backup Record Work
Time ID Type Code
Byte 1 2-6 7-10 11 12 13-15
State Definition:
0: Unprocessed events
1: Verify successful
2: Failed to verify
3: Repeated Verification
4: invalid operation
5: invalid timezone
6: Repeated registration
68 / 96
ANVIZ TC_B Communication Protocol User Manual
Function: This command gets GPRS parameters : APN name, GPRS server IP ,local IP ,
port number , user name and password.
A)Basic Version
Commands: (10Byte)
STX CH CMD LEN CRC16
0xA5 IDHH IDHL IDLH 0x16 0x00 0x00 CRCL CRCH
IDLL
Response: (119Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x96 ACK_SUC 0x00 108Byt CRCL
IDLL CESS 0x6C e CRCH
ACK_FAIL
Data Format: (108Byte)
DATA APN Serve IP Port Local IP User PW Enable/ Reserved
Name No. Name Disable
Byte 1-16 17-20 21-22 23-26 27-66 67-1 107 108
06
If the length of APN name is less than 16 byte, fill up the remaining byte with 0.
If local IP address is assigned by DHCP server dynamically, then set 23-26 byte to 0.
If the length of User name is less than 40 byte, fill up the remaining byte with 0.
If User Name contains a ‘null’ value, the user name is not set.
If the length of the Password is less than 40btye, fill up the remaining byte with 0.
Enable/Disable : 0-Disable 1-Enable
Improved Version
Commands: (10Byte)
The same as the basic version
Response: (91Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x96 ACK_SUC 0x00 80Byte CRCL
IDLL CESS 0x50 CRCH
ACK_FAIL
Data Format: (80Byte)
DATA APN Server Port Local IP User PW Enable/ Reserved
Name IP Name Disable
Byte 1-32 33-36 37-38 39-42 43-60 61-7 79 80
8
If the length of APN name is less than 32 byte, fill up the remaining byte with 0.
If local IP address is assigned by DHCP server dynamically, then set 33-36 byte to 0.
If the length of User name is less than 18 byte, fill up the remaining byte with 0.
If User Name contains a ‘null’ value, the user name is not set.
69 / 96
ANVIZ TC_B Communication Protocol User Manual
If the length of the Password is less than 18btye, fill up the remaining byte with 0.
Enable/Disable : 0-Disable 1-Enable
Function: This command sets GPRS parameters : APN name, GPRS server IP/local IP ,
port number , user name and password
A)Basic Version
Commands: (118Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x17 0x00 0x6C 108Byte CRCL
IDLL CRCH
Data Format: (108Byte)
DATA APN Server Port Local IP User PW Enable/ Reserved
Name IP Name Disable
Byte 1-16 17-20 21-22 23-26 27-66 67-1 107 108
06
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0x97 ACK_SUCC 0x00 0x00 CRCL CRCH
IDLL ESS
ACK_FAIL
B)Improved Version
Commands: (90Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x17 0x00 0x50 80Byte CRCL
IDLL CRCH
Data Format: (80Byte)
DATA APN Serve IP Port Local User PW Enable/ Reserved
Name IP Name Disable
Byte 1-32 33-36 37-38 39-42 43-60 61-7 79 80
8
Response: (11Byte)
The same as basic version
Function: This command retrieves vendor’s name,tax registration number and address.
Commands: (10Byte)
STX CH CMD LEN CRC16
70 / 96
ANVIZ TC_B Communication Protocol User Manual
Function: This command retrieve vendor’s name,tax registration number and address
Commands: (330Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x7B 0x01 0x40 320Byte CRCL
IDLL CRCH
Data Format: (320Byte)
DATA Vendor Vendor Add Vendor Tax No. Reserved
Name (UNICODE) (Figure ASCII
(UNIODE) Code)
Byte 1-50 51-150 151-165 166-320
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0xFB ACK_SUCC 0x00 0x00 CRCL
IDLL ESS CRCH
ACK_FAIL
Function: This command retrieves the card number when user punched a card on T5S. It
is applicable to T5S only
Commands: (10Byte)
STX CH CMD LEN CRC16
0xA5 IDHH IDHL IDLH 0x7E 0x00 0x00 CRCL CRCH
IDLL
Response: (15Byte)
71 / 96
ANVIZ TC_B Communication Protocol User Manual
Function: This command gets setting of the reboot time. It is applicable to the 761platform
and OA1000 only
Commands: (10Byte)
STX CH CMD LEN CRC16
0xA5 IDHH IDHL IDLH 0x14 0x00 0x00 CRCL CRCH
IDLL
Response: (20Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x94 ACK_SUCC 0x00 0x09 9Byte CRCL
IDLL ESS CRCH
ACK_FAIL
Data Format: (9Byte)
DATA Reboot Reboot Reboot
Time 1 Time 2 Time 3
Byte 1-3 4-6 7-9
Reboot times code is a BCD code.
For instance, Reboot Time = 22:00:00, equivalent to byte 0x22 0x00 0x00
If reboot time is set to 0xFF, then the reboot time hasn’t been set.
Function: This command sets reboot times. It is applicable to the 761platform and
OA1000 only
Commands: (19Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x15 0x00 9Byte CRCL
IDLL 0x09 CRCH
Response: (11Byte)
72 / 96
ANVIZ TC_B Communication Protocol User Manual
73 / 96
ANVIZ TC_B Communication Protocol User Manual
Function: This command uses UDP broadcast to search devices. The UDP port for device
is 5050, the UDP port for PC is 5060.
Response: (178Byte)
STX CH ACK RET LEN DATA CRC16
74 / 96
ANVIZ TC_B Communication Protocol User Manual
C2 Pro has a specialized ‘Search Device’ command due to its dual NIC capability.
Commands: (11 Byte)
STX CH CMD LEN DATA CRC16
0xA5 0x00 0x00 0x00 0x00 0x02 0x00 1Byte CRCL
0x01 CRCH
Data Format: (1Byte)
DAT Search
A Parameter
Byte 1
75 / 96
ANVIZ TC_B Communication Protocol User Manual
Function: This command sets device parameters by using UDP broadcast. The device
UDP port is 5050, The PC UDP port is 5060.
Commands: (67 Byte)
STX CH CMD LEN DATA CRC16
0xA5 0x00 0x00 0x00 0x00 0x03 0x00 57Byte CRCL
0x39 CRCH
Data Format: (57Byte)
DA IP Address Sub-net Mask Default MAC Server Port
TA Address IP Number
Byt 1-4 5-8 9-12 13-18 19-22 23-24
e
The firmware determines whether the mac address from the UDP package is identical to
its own mac address. If the addresses are matched, then the firmware verify user name
and password, else the UDP package will be ignored.
If password or user name is valid, then device will return the result of setting.
User name of an iris device is “admin” , password is the corresponding phrase.
User name for 761 and 2440 platform is “0”, password is the corresponding phrase.
The rest of platforms only require password verification.
If the firmware supports “Client+DNS”, then the command data has following definition
Commands: (171 Byte)
STX CH CMD LEN DATA CRC16
0xA5 0x00 0x00 0x00 0x00 0x03 0x00 161Byte CRCL
0xA1 CRCH
Data Format: (161Byte)
76 / 96
ANVIZ TC_B Communication Protocol User Manual
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0x83 ACK_SUC 0x00 CRCL
IDLL CESS 0x00 CRCH
ACK_FAIL
Function: Heartbeat packages are sent every 5 minutes(by default) for testing network
connectivity.
Commands: (10Byte)
STX CH CMD LEN CRC16
0xA5 IDHH IDHL IDLH 0x7F 0x00 0x00 CRCL CRCH
IDLL
Response: (11Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xFF ACK_SUCCE 0x00 0x00 0Byte CRCL
IDLL SS CRCH
ACK_FAIL
77 / 96
ANVIZ TC_B Communication Protocol User Manual
Function: It is only applicable to 761 platform.If the devices are set to network client mode,
any change relates to personnel information, fingerprints or T&A records will be pushed to
its server automatically or uploaded after receiving this command. Furthermore, this
command will also be executed, if auto data push is failed to update these data alteration
within 3 minutes.
Commands: (10Byte)
STX CH CMD LEN CRC16
0xA5 IDHH IDHL IDLH 0x7D 0x00 0x00 CRCL CRCH
IDLL
Response: (27Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xFD ACK_SUCCE 0x00 0x10 16Byte CRCL
IDLL SS CRCH
ACK_FAIL
Data Format: (16Byte)
DATA Number of Number of Reserved
Personnel New
Changes Attendance
Records
Byte 1-3 4-6 7-16
Function: This command downloads the maximum 40 altered personnel records each
time. (Record Date Length: 40*10 = 400Byte)
Commands: (12Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x64 0x00 0x02 2Byte CRCL
IDLL CRCH
Data Format:
DATA Parameter Records
Number
Byte 1 2
Parameter Definition:
= 0: Downloading
= 1: Download Commencing , when downloading all records, this data parameter
should be sent with the first request package.
= 2: Download started, when downloading only new records, this data parameter
should be sent with the first request package.
= 0x10: resend the previous data package
78 / 96
ANVIZ TC_B Communication Protocol User Manual
Records Number<=40
Response: (12+N *10Byte // N is the number of valid Records)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xE4 ACK_SUCC (1+N *10) (1+N CRCL
IDLL ESS *10)Byte CRCH
FAIL
Data Format: (1+N *10Byte)
DATA Valid Records Record 1 Record 2 …
Number N
Byte 1 2-11 12-21 …
Records Data Format: (10Byte)
DATA User ID Date/Tim Type
e
Byte 1-5 6-9 10
Date/Time: the number of seconds that have elapsed since 2000-01-01 00:00
Type Definition : bit 0- Change User info bit1- Change FP record bit 2-Delete a User
79 / 96
ANVIZ TC_B Communication Protocol User Manual
80 / 96
ANVIZ TC_B Communication Protocol User Manual
81 / 96
ANVIZ TC_B Communication Protocol User Manual
= 0 Closed
= 1 big endian Wiegand 26
=2 little endian Wiegand26
= 3 big endian Wiegand 34
=4 little endian Wiegand 34
Connection Mode:
=0 offline mode
=1 online Mode
Collecting Threshold Range: 0-8
Customized Timezone:
= 0 Disable
= 1 Enable , occupy 2byte of Name field
Connection Password:
=0 When network connection established, the communication password is not
required.
=1 When network connection established, the CMD 0x04 is sent to verify the
communication password.
M5/T5Anti Back :
= 0 Disable
= 1 Enable, Current state is out
=2 Enable , Current state is in
=4 Disable, Current state is out
=5 Disable , Current state is in
82 / 96
ANVIZ TC_B Communication Protocol User Manual
The default User Name and Password for iris devices is “admin” and corresponding
phrase. For other devices, only communication password is required for verification.
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0x84 ACK_SUCC 0x00 0x00 CRCL
IDLL ESS CRCH
ACK_FAIL
Function: This command retrieves T&A parameters, including Firmware Version, Protocol
version etc. It is applicable to the M4 platform.
83 / 96
ANVIZ TC_B Communication Protocol User Manual
Response: (75Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xB4 ACK_SUCC 0x00 64Byt CRCL
IDLL ESS 0x40 e CRCH
ACK_FAIL
Data Format: (64Byte)
DA Firmware Protocol Reserved
TA Version Version
Byt 1-4 5-8 9-64
e
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0xE1 ACK_SUCC 0x00 0x00 CRCL
IDLL ESS CRCH
ACK_FAIL
84 / 96
ANVIZ TC_B Communication Protocol User Manual
Function: This command erases a department from device and is applicable to OA1000
only.
Commands: (10 Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x62 0x00 2Byte CRCL
IDLL 0x02 CRCH
Data Format: (2Byte)
DA Department
TA ID No.
Byt 1-2
e
If the Department ID number set as 0xFFFF, all Department will be erased.
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0xE2 ACK_SUCC 0x00 0x00 CRCL
IDLL ESS CRCH
ACK_FAIL
85 / 96
ANVIZ TC_B Communication Protocol User Manual
Function: This command batch downloads fingerprint images from a T&A device. It is
applicable to OA1000 with a network connection only.
Commands: (12Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x67 0x00 0x02 2Byte CRCL
IDLL CRCH
Data Format: (2Byte)
DATA Type Para
meter
Byte 1 2
Type: =1 FP Image
=2 User Photo
Parameter Definition:
= 0: Downloading
= 1: Download Commencing
= 2: Batch Download Commencing
= 0x10: Resend the previous Data Package
86 / 96
ANVIZ TC_B Communication Protocol User Manual
Function: This command retrieves the result of the last bio-metric authentication. It is
customized for Brazilian clients.
Commands: (10Byte)
STX CH CMD LEN CRC16
0xA5 IDHH IDHL IDLH IDLL 0x79 0x00 0x00 CRCL
CRCH
Return Value:
If state == null
Response: (12Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xF9 ACK_SUC 0x00 1Byte CRCL
IDLL CESS 0x01 CRCH
ACK_FAIL
Data Format: (1Byte)
DATA Type
Byte 1
Type 0xFF
If state == succeed
Response: (35Byte)
STX CH ACK RET LEN DAT CRC16
A
0xA5 IDHH IDHL IDLH 0xF9 ACK_SUC 0x00 24By CRCL
IDLL CESS 0x18 te CRCH
ACK_FAIL
87 / 96
ANVIZ TC_B Communication Protocol User Manual
Type 0
If the user did not register any card, then Card ID No. (byte 16-19) should be set as 0xFF.
If the user did not register any password, then byte 20-23 should be set as 0xFF.
FP Enrollment Status: 0- Unregistered FP
1-FP1
2-FP 2
3-FP1+FP2
If the FP is invalid
Response: (181Byte)
STX CH CMD RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xF9 ACK_SUC 0x00 170By CRCL
IDLL CESS 0xAA te CRCH
ACK_FAIL
Data Format: (170Byte)
DAT Type Feature
A Value Data
Byte 1 2-170
Type=1
88 / 96
ANVIZ TC_B Communication Protocol User Manual
Function: This command retrieves current setting for timezone shift. It is applicable to C2
Pro only.
Commands: (11Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x68 0x00 0x01 1Byte CRCL
IDLL CRCH
Data Format: (1Byte)
DATA W
Byte 1
W = 0-6, it represents each week days from Sunday to Saturday
Response: (52Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xE8 ACK_SUC 0x00 0x29 41Byte CRCL
IDLL CESS CRCH
ACK_FAIL
Data Format: (41Byte)
DAT W Sub Sub Sub Sub Sub Sub Sub Sub
A Timez Timez Timez Timez Timez Timez Timez Timezone
one 1 one 2 one 3 one 4 one 5 one 6 one 7 8
Byte 1 2-6 7-11 12-16 17-21 22-26 27-31 32-36 37-41
Sub Timezone Format: (5Byte)
DATA Start H Start M End H End M Attendan
ce Status
Number
Byte 1 2 3 4 5
89 / 96
ANVIZ TC_B Communication Protocol User Manual
Function: This command applies rules for timezone shift. It is applicable to C2 Pro only.
Commands: (51Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x69 0x00 0x29 41Byte CRCL
IDLL CRCH
Data Format: (41Byte)
DAT W Sub Sub Sub Sub Sub Sub Sub Sub
A Timez Timez Timez Timez Timez Timez Timez Timezone
one 1 one 2 one 3 one 4 one 5 one 6 one 7 8
Byte 1 2-6 7-11 12-16 17-21 22-26 27-31 32-36 37-41
W = 0-6, it represents each week days from Sunday to Saturday
Sub Timezone Format: (5Byte)
DATA Start H Start M End H End M Attendance
Status No.
Byte 1 2 3 4 5
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0xE9 ACK_SUCC 0x00 0x00 CRCL
IDLL ESS CRCH
ACK_FAIL
Response: (11Byte)
STX CH ACK RET LEN CRC16
90 / 96
ANVIZ TC_B Communication Protocol User Manual
91 / 96
ANVIZ TC_B Communication Protocol User Manual
Function: This command retrieves data of all Bluetooth devices. It is applicable to M5 only.
Commands: (10Byte)
STX CH CMD LEN CRC16
0xA5 IDHH IDHL IDLH IDLL 0x6C 0x00 0x00 CRCL CRCH
Response: (291Byte)
STX CH ACK RET LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0xE ACK_SUCC 0x01 280Byte CRCL
IDLL C ESS 0x18 CRCH
ACK_FAIL
Data Format: (280Byte)
DATA BT Device1 BT Device2 ... BT Device10
Byte 1-28 29-56 ... 259-280
BT Device/User Data Format: (28Byte)
DATA Bluetooth ID Reserved
Byte 1-16 17-28
If any ‘BT device’ data field is not used, all the 28 byte data should be set as 0xFF.
Function: This command retrieves SSID and password for a specified WiFi network. It is
only applicable to VX0.
Commands: (11Byte)
STX CH CMD LEN DAT CRC16
A
0xA5 IDHH IDHL IDLH 0x6E 0x00 0x01 1Byt CRCL CRCH
IDLL e
Data Format: (1Byte)
DATA Subscript
Byte 1
Subscript range: 1-5
Response: (139Byte)
STX CH ACK RET LEN DATA CRC16
92 / 96
ANVIZ TC_B Communication Protocol User Manual
Function: This command sets the SSID and password for a specified WIFI network. It is
applicable to VX0 only.
Commands: (139Byte)
STX CH CMD LEN DAT CRC16
A
0xA5 IDHH IDHL IDLH 0x6F 0x00 0x81 129B CRCL CRCH
IDLL yte
Data Format: (129Byte)
DATA Subscript Name Password
Byte 1 2-65 66-129
Subscript 范围: 1-5
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0xEF ACK_SUCCES 0x00 0x00 CRCL CRCH
IDLL S
ACK_FAIL
93 / 96
ANVIZ TC_B Communication Protocol User Manual
Function: Device port is 5050, PC port is 5060. It is only applicable to C2 Pro/OA1000 Pro
etc.which belong to the A20 platform.
Commands: (30Byte)
STX CH CMD LEN DATA CRC16
0xA5 IDHH IDHL IDLH 0x06 0x00 0x14 20Byte CRCL CRCH
IDLL
Response: (11Byte)
STX CH ACK RET LEN CRC16
0xA5 IDHH IDHL IDLH 0x86 ACK_SUCCESS 0x00 0x00 CRCL CRCH
IDLL ACK_FAIL
94 / 96
ANVIZ TC_B Communication Protocol User Manual
Exists
=0 not exists
=1 exists
96 / 96