iFace Series

Communication Protocol SDK

Development Handbook

Version: 6.14

Date: December, 2009

2009 ZKSoftware Inc. All rights reserved.

If there is some change of information in this handbook, ZKSoftware won't inform specially.
l

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

Contents
Communication Protocol SDK.................................................................................................................... 1
Development Handbook ............................................................................................................................. 1
Version: 6.13................................................................................................................................................ 1
Contents ...................................................................................................................................................... 3
1 SDK Description....................................................................................................................................... 7
2 Quick Start................................................................................................................................................ 7
2.1 Installing the SDK ............................................................................................................................ 7
Note ............................................................................................................................................................. 7
2.2 Terms .............................................................................................................................................. 7
2.3 Common Processes......................................................................................................................... 9
2.3.1 Downloading Attendance Records ......................................................................................... 9
2.3.2 Downloading Operation Records............................................................................................ 9
2.3.3 Setting Access Control..........................................................................................................10
2.3.4 Downloading User Information, Fingerprint Templates, or Face Templates............................10
2.3.5 Receiving Real-time Events ..................................................................................................12
2.3.6 Enrolling Users Online (Uploading Information, Fingerprint Templates, and Face Templates of
Users) ...........................................................................................................................................12
3 Related Attributes ...................................................................................................................................13
3.1 AccGroup........................................................................................................................................13
3.2 AccTimeZones................................................................................................................................13
3.3 BASE64..........................................................................................................................................14
3.4 CardNumber ...................................................................................................................................14
3.5 CommPort ......................................................................................................................................14
3.6 ConvertBIG5...................................................................................................................................14
3.7 PINWidth ........................................................................................................................................14
3.8 GetStrCardNumber .........................................................................................................................14
3.9 SetStrCardNumber .........................................................................................................................15
4 Real-time Event Functions......................................................................................................................15
4.1 Obtaining Real-Time Events............................................................................................................15
4.1.1 RegEvent..............................................................................................................................15
4.1.2 ReadRTLog ..........................................................................................................................16
4.1.3 GetRTLog.............................................................................................................................16
4.2 Real-Time Events ...........................................................................................................................17
4.2.1 OnConnected .......................................................................................................................17
4.2.2 OnDisConnected ..................................................................................................................17
4.2.3 OnAlarm ...............................................................................................................................17
4.2.4 OnDoor.................................................................................................................................17
4.2.5 OnAttTransactionEx..............................................................................................................18

4.2.6 OnEnrollFingerEx .................................................................................................................19

4.2.7 OnFinger ..............................................................................................................................19
4.2.8 OnFingerFeature ..................................................................................................................19
4.2.9 OnHIDNum...........................................................................................................................19
4.2.10 OnNewUser ........................................................................................................................19
4.2.11 OnVerify .............................................................................................................................19
4.2.12 OnWriteCard.......................................................................................................................20
4.2.13 OnEmptyCard.....................................................................................................................20
4.2.14 OnEMData..........................................................................................................................20
5 Common Functions.................................................................................................................................20
5.1 Device Connection Functions..........................................................................................................20
5.1.1 Connect_Net.........................................................................................................................20
5.1.2 Connect_Com.......................................................................................................................21
5.1.3 Disconnect............................................................................................................................21
5.2 Data Management Functions ..........................................................................................................22
5.2.1 Attendance Record Data.......................................................................................................22
5.2.2 Operation Record Data .........................................................................................................24
5.2.3 User Information Functions ...................................................................................................29
5.2.4 Enroll Data Functions (Including Both User Information and Fingerprint) ...............................34
5.2.5 Fingerprint Template Functions.............................................................................................35
5.2.6 Face Data Functions.............................................................................................................40
5.2.7 Fingerprint Template Conversion Functions ..........................................................................43
5.2.8 System Data Management Functions....................................................................................46
5.3 Access Control Functions (Time Zone, Group, Open Door Combination).........................................49
5.3.1 GetUserGroup ......................................................................................................................49
5.3.2 SetUserGroup.......................................................................................................................49
5.3.3 GetTZInfo .............................................................................................................................50
5.3.4 SetTZInfo..............................................................................................................................50
5.3.5 SSR_SetUnLockGroup .........................................................................................................51
5.3.6 SSR_GetUnLockGroup.........................................................................................................52
5.3.7 SSR_SetGroupTZ.................................................................................................................52
5.3.8 SSR_GetGroupTZ ................................................................................................................53
5.3.9 GetUserTZs..........................................................................................................................54
5.3.10 SetUserTZs ........................................................................................................................54
5.3.11 GetUserTZStr .....................................................................................................................55
5.3.12 SetUserTZStr......................................................................................................................55
5.3.13 ACUnlock ...........................................................................................................................56
5.3.14 GetACFun...........................................................................................................................56
5.3.15 GetDoorState......................................................................................................................57
5.3.16 UseGroupTimeZone ...........................................................................................................57
5.4 Device Management Functions .......................................................................................................58
5.4.1 IsTFTMachine.......................................................................................................................58
5.4.2 GetDeviceStatus...................................................................................................................58
5.4.3 GetDeviceInfo.......................................................................................................................59

5.4.4 SetDeviceInfo .......................................................................................................................62

5.4.5 SetDeviceTime .....................................................................................................................62
5.4.6 SetDeviceTime2 ...................................................................................................................63
5.4.7 GetDeviceTime.....................................................................................................................63
5.4.8 GetSerialNumber ..................................................................................................................64
5.4.9 GetProductCode ...................................................................................................................64
5.4.10 GetFirmwareVersion ...........................................................................................................65
5.4.11 GetSDKVersion ..................................................................................................................65
5.4.12 GetDeviceIP .......................................................................................................................65
5.4.13 SetDeviceIP........................................................................................................................66
5.4.14 GetDeviceMAC ...................................................................................................................66
5.4.15 SetDeviceMAC ...................................................................................................................67
5.4.16 GetWiegandFmt..................................................................................................................67
5.4.17 SetWiegandFmt ..................................................................................................................68
5.4.18 GetCardFun........................................................................................................................68
5.4.19 SetDeviceCommPwd ..........................................................................................................68
5.4.20 SetCommPassword ............................................................................................................69
5.4.21 QueryState .........................................................................................................................69
5.4.22 GetVendor ..........................................................................................................................70
5.4.23 GetDeviceStrInfo ................................................................................................................70
5.4.24 GetPlatform ........................................................................................................................71
5.4.25 ReadAOptions ....................................................................................................................71
5.4.26 GetSysOption .....................................................................................................................72
5.4.27 SetSysOption......................................................................................................................72
5.5 Others.............................................................................................................................................73
5.5.1 Device Control Functions ......................................................................................................73
5.5.2 Card Operation Functions .....................................................................................................75
5.5.3 Others ..................................................................................................................................76
6 FAQs ........................................................................................................................................................81
6.1 How to Download Attendance Records? .........................................................................................81
6.2 How to Create a User Online?.........................................................................................................81
6.3 How to Import or Download Data from USB Disk? ...........................................................................81
6.4 How to Use Biokey to Write the Collected Fingerprint Templates Offline?........................................83
6.5 How to Obtain All Information of All Users? .....................................................................................83
6.6 How to Connect to the Device? .......................................................................................................84
6.7 Password Is Invalid After SSR_SetUserInfo Is Used........................................................................84
6.8 How to Convert an Online Template into an Offline Template? ........................................................84
6.9 Demo Program Fails to Connect to the Device. ...............................................................................84
6.10 Standalone fingerprint Device Keeps Working After Being Connected. ..........................................85
6.11 Illegal Characters Are Displayed or Screen Display Is Abnormal After Non-English Names or Short
Messages Are Uploaded to the Device..................................................................................................85
6.12 Card Management Problems.........................................................................................................85
6.13 Firewall or Router Traversal ..........................................................................................................86
6.14 Uploading a Large Capacity of Fingerprints ...................................................................................86

6.15 Differences between High-speed Upload and Ordinary Upload......................................................86

6.16 How to Download a Face Template?.............................................................................................86