B&W
B&W
B&W
B&W Series
Series
Series
Series
Communication
Communication
Communication
Communication Protocol
Protocol
Protocol
Protocol SDK
SDK
SDK
SDK
Development
Development
Development
Development Handbook
Handbook
Handbook
Handbook
—————————————————————————————————
—————————————————————————————————
—————————————————————————————————
—————————————————————————————————
Date:
Date:
Date:
Date: July
July
July
July ,
,
,
, 20
20
20
20 12
12
12
12
20 12 ZKSoftware Inc. All rights reserved.
If there is some change of information in this handbook, ZKSoftware won't inform specially.
�
�
�
�
�
ZKSoftware Inc. is our company logo. Biokey is core technology logo of ZKSoftware. Both
logos have been registered in China and America.
Other trademarks and product names mentioned in this handbook are produced by other
companies. ZKSoftware Inc. has no property of them.
Please solve use problems (instead of development kit problem) during development by
yourself.
ZKSoftware has no responsibility for data loss caused by users or programs.
This handbook is designed on the basis of SDK 6. 2 . 4 . 1 .
Contents
Contents
Contents
Contents
1
1
1
1 SDK
SDK
SDK
SDK Description.......................................................................................................................................
Description.......................................................................................................................................
Description.......................................................................................................................................
Description....................................................................................................................................... 7
7
7
7
2
2
2
2 Quick
Quick
Quick
Quick Start................................................................................................................................................
Start................................................................................................................................................
Start................................................................................................................................................
Start................................................................................................................................................ 7
7
7
7
2. 1 Terms .............................................................................................................................................. 7
2. 2 Common Processes......................................................................................................................... 9
2. 2 .1 Downloading Attendance Records ......................................................................................... 9
2. 2 .2 Downloading Operation Records...........................................................................................10
2. 2 .3 Setting Access Control..........................................................................................................10
2. 2 .4 Downloading User Information, Fingerprint Templates, or Face Templates............................11
2. 2 .5 Receiving Real-time Events ..................................................................................................12
2. 2 .6 Enrolling Users Online (Uploading Information, and Fingerprint Templates of Users).............12
2. 2 .7 Uploading Short Messages ...................................................................................................13
3
3
3
3 Related
Related
Related
Related Attributes
Attributes
Attributes
Attributes ...................................................................................................................................14
...................................................................................................................................14
...................................................................................................................................14
...................................................................................................................................14
3.1 AccGroup........................................................................................................................................14
3.2 AccTimeZones................................................................................................................................14
3.3 BASE64..........................................................................................................................................14
3.4 CardNumber ...................................................................................................................................14
3.5 CommPort ......................................................................................................................................14
3.6 ConvertBIG5...................................................................................................................................14
3.7 PINWidth ........................................................................................................................................15
3.8 GetStrCardNumber .........................................................................................................................15
3.9 SetStrCardNumber .........................................................................................................................15
4
4
4
4 Real-time
Real-time
Real-time
Real-time Event
Event
Event
Event Functions......................................................................................................................16
Functions......................................................................................................................16
Functions......................................................................................................................16
Functions......................................................................................................................16
4.1 Obtaining Real-Time Events............................................................................................................16
4.1.1 RegEvent..............................................................................................................................16
4.1.2 ReadRTLog ..........................................................................................................................16
4.1.3 GetRTLog.............................................................................................................................17
4.2 Real-Time Events ...........................................................................................................................17
4.2.1 OnConnected .......................................................................................................................17
4.2.2 OnDisConnected ..................................................................................................................17
4.2.3 OnAlarm ...............................................................................................................................18
4.2.4 OnDoor.................................................................................................................................18
4.2.5 OnAttTransaction..................................................................................................................18
4.2.6 OnAttTransactionEx..............................................................................................................19
4.2.7 OnDeleteTemplate................................................................................................................20
4.2.8 OnEnrollFinger......................................................................................................................20
4.2.9 OnFinger ..............................................................................................................................20
4.2.10 OnFingerFeature ................................................................................................................20
4.2.11 OnHIDNum .........................................................................................................................21
4.2.12 OnKeyPress .......................................................................................................................21
4.2.13 OnNewUser ........................................................................................................................21
4.2.14 OnVerify .............................................................................................................................21
4.2.15 OnWriteCard.......................................................................................................................21
4.2.16 OnEmptyCard.....................................................................................................................22
4.2.17 OnEMData..........................................................................................................................22
5
5
5
5 Common
Common
Common
Common Functions.................................................................................................................................22
Functions.................................................................................................................................22
Functions.................................................................................................................................22
Functions.................................................................................................................................22
5.1 Device Connection Functions..........................................................................................................22
5.1.1 Connect_Net.........................................................................................................................22
5.1.2 Connect_Com.......................................................................................................................22
5.1.3 Connect_USB.......................................................................................................................23
5.1.4 Disconnect............................................................................................................................24
5.2 Data Management Functions ..........................................................................................................24
5.2.1 Attendance Record Data.......................................................................................................24
5.2.2 Operation Record Data .........................................................................................................29
5.2.3 User Information Functions ...................................................................................................35
5.2.4 Registration Data Functions (Including Both User Information and Fingerprint)......................43
5.2.5 Fingerprint Template Functions.............................................................................................47
5.2.6 SMS Functions .....................................................................................................................51
5.2.7 Work Code Functions ...........................................................................................................54
5.2.8 Holiday Functions .................................................................................................................56
5.2.9 DST Functions......................................................................................................................57
5.2.10 Customization Functions (Voice and Attendance State).......................................................58
5.2.11 Fingerprint Template Conversion Functions ........................................................................62
5.2.12 System Data Management Functions..................................................................................65
5.3 Access Control Functions (Time Slot, Group, Open Door Combination)...........................................68
5.3.1 GetUserGroup ......................................................................................................................68
5.3.2 SetUserGroup.......................................................................................................................68
5.3.3 GetTZInfo .............................................................................................................................69
5.3.4 SetTZInfo..............................................................................................................................69
5.3.5 GetUnlockGroups .................................................................................................................70
5.3.6 SetUnlockGroups..................................................................................................................70
5.3.7 GetGroupTZs........................................................................................................................71
5.3.8 SetGroupTZs ........................................................................................................................71
5.3.9 GetGroupTZStr.....................................................................................................................72
5.3.10 SetGroupTZStr ...................................................................................................................73
5.3.11 GetUserTZs ........................................................................................................................73
5.3.12 SetUserTZs ........................................................................................................................74
5.3.13 GetUserTZStr .....................................................................................................................74
5.3.14 SetUserTZStr......................................................................................................................75
5.3.15 ACUnlock ...........................................................................................................................76
5.3.16 GetACFun...........................................................................................................................76
5.3.17 GetDoorState......................................................................................................................76
5.3.18 UseGroupTimeZone ...........................................................................................................77
5.4 Device Management Functions .......................................................................................................77
5.4.1 IsTFTMachine.......................................................................................................................77
5.4.2 GetDeviceStatus...................................................................................................................78
5.4.3 GetDeviceInfo.......................................................................................................................79
5.4.4 SetDeviceInfo .......................................................................................................................82
5.4.5 SetDeviceTime .....................................................................................................................82
5.4.6 SetDeviceTime2 ...................................................................................................................82
5.4.7 GetDeviceTime.....................................................................................................................83
5.4.8 GetSerialNumber ..................................................................................................................83
5.4.9 GetProductCode ...................................................................................................................84
5.4.10 GetFirmwareVersion ...........................................................................................................84
5.4.11 GetSDKVersion ..................................................................................................................85
5.4.12 GetDeviceIP .......................................................................................................................85
5.4.13 SetDeviceIP........................................................................................................................85
5.4.14 GetDeviceMAC ...................................................................................................................86
5.4.15 SetDeviceMAC ...................................................................................................................86
5.4.16 GetWiegandFmt..................................................................................................................87
5.4.17 SetWiegandFmt ..................................................................................................................87
5.4.18 GetCardFun........................................................................................................................88
5.4.19 SetDeviceCommPwd ..........................................................................................................88
5.4.20 SetCommPassword ............................................................................................................89
5.4.21 QueryState .........................................................................................................................89
5.4.22 GetVendor ..........................................................................................................................89
5.4.23 GetDeviceStrInfo ................................................................................................................90
5.4.24 GetPlatform ........................................................................................................................90
5.4.25 ReadAOptions ....................................................................................................................91
5.4.26 GetSysOption .....................................................................................................................91
5.4.27 SetSysOption......................................................................................................................92
5.5 Device Control Functions ................................................................................................................92
5.5.1 ClearAdministrators ..............................................................................................................92
5.5.2 EnableDevice .......................................................................................................................93
5.5.3 EnableClock .........................................................................................................................93
5.5.4 DisableDeviceWithTimeOut ..................................................................................................93
5.5.5 PowerOffDevice....................................................................................................................94
5.5.6 RestartDevice .......................................................................................................................94
5.5.7 SleepDevice .........................................................................................................................95
5.6 Online Registration Functions .........................................................................................................95
5.6.1 StartEnroll.............................................................................................................................95
5.6.2 StartVerify.............................................................................................................................96
5.6.3 StartIdentify ..........................................................................................................................96
5.6.4 CancelOperation...................................................................................................................96
5.7 LCD and Card Operation Functions.................................................................................................97
5.7.1 WriteLCD..............................................................................................................................97
5.7.2 ClearLCD..............................................................................................................................97
5.7.3 WriteCard .............................................................................................................................97
- 1
- 2
- 3
前往页