《中控考勤机开发接口文档》由会员分享，可在线阅读，更多相关《中控考勤机开发接口文档（70页珍藏版）》请在金锄头文库上搜索。
1、 iFace 系列脱机通讯系列脱机通讯开发包开发包 开发手册开发手册 日期: 2013 年9月 2013 ZKSoftware Inc.。版权所有，翻印必究。 本说明文件中的信息如有更改，恕不另行通知。 ZKSoftware Inc.为中控科技的司标，Biokey 为中控科技的核心技术徽标，ZKSoftware ,Biokey 已经在中国 及美国注册。 本说明文件中述及的其他商标和产品名称是指拥有相应商标和产品名称的公司或者制造的产品。 ZKSoftware Inc.对其他公司的商标和产品名称不拥有任何所有权。 开发中使用问题，非开发包问题，请自行解决。 使用该开发包，由于人为或程序本身造成数
2、据丢失，本公司概不负责。 该文档基于 6.2.4.11 版 SDK 目录目录 1. SDK 介绍 . 1 2. 快速开始 2 2.1 常用词介绍 . 2 2.2 常用工作流程介绍 3 2.2.1 考勤记录下载流程: . 3 2.2.2 操作记录下载流程: . 3 2.2.3 门禁设置流程: . 4 2.2.4 下载用户信息,指纹模板,面部模板等流程 . 4 2.2.5 实时事件接收流程 . 5 2.2.6 联机登记流程 (上传用户信息,指纹模板,面部模板等流程) . 6 3. 属性相关介绍 7 3.1 AccGroup 7 3.2 AccTimeZones 7 3.3 BASE64 7 3.4
3、 CardNumber 7 3.5 CommPort 7 3.6 ConvertBIG5 7 3.7 PINWidth 8 3.8 GetStrCardNumber 8 3.9 SetStrCardNumber 8 4. 实时事件相关 8 4.1 获取实时事件方法 8 4.1.1 RegEvent 8 4.1.2 ReadRTLog 9 4.1.3 GetRTLog 9 4.2 实时事件介绍 10 4.2.1 OnConnected 10 4.2.2 OnDisConnected 10 4.2.3 OnAlarm 10 4.2.4 OnDoor 10 4.2.5 OnAttTransactio
4、nEx 11 4.2.6 OnEnrollFingerEx 11 4.2.7 OnFinger 11 4.2.8 OnFingerFeature 12 4.2.9 OnHIDNum 12 4.2.10 OnNewUser 12 4.2.11 OnVerify 12 4.2.12 OnWriteCard 12 4.2.13 OnEmptyCard 12 4.2.14 OnEMData 13 5 常用函数介绍 . 13 5.1 连接机器相关函数 13 5.1.1 Connect_Net 13 5.1.2 Connect_Com 13 5.1.3 Disconnect 14 5.2 数据管理相关函数
5、 14 5.2.1 考勤记录数据 14 5.2.1.1 ReadGeneralLogData 14 5.2.1.2 ReadAllGLogData 14 5.2.1.3 SSR_GetGeneralLogData 15 5.2.1.4 ClearGLog 16 5.2.2 操作记录相关 . 16 5.2.2.1 ReadSuperLogData 16 5.2.2.2 ReadAllSLogData 16 5.2.2.3 GetSuperLogData 17 5.2.2.4 GetAllSLogData 18 5.2.2.5 ClearSLog 18 5.2.2.6 GetSuperLogDat
6、a2 19 5.2.3 用户信息相关 . 19 5.2.3.1 ReadAllUserID 19 5.2.3.2 SSR_EnableUser 20 5.2.3.3 SetUserInfoEx 20 5.2.3.4 GetUserInfoEx 20 5.2.3.5 DeleteUserInfoEx 21 5.2.3.6 SSR_GetAllUserInfo 21 5.2.3.7 SSR_GetUserInfo 22 5.2.3.8 SSR_SetUserInfo 22 5.2.4 登记数据（同时包括用户信息和指纹） . 23 5.2.4.1 SSR_DeleteEnrollData 23 5.
7、2.4.2 SSR_DeleteEnrollDataExt 24 5.2.5 指纹模板相关 . 24 5.2.5.1 ReadAllTemplate 24 5.2.5.2 SetUserTmpEx 24 5.2.5.3 SetUserTmpExStr 25 5.2.5.4 GetUserTmpEx 26 5.2.5.5 GetUserTmpExStr 26 5.2.5.6 SSR_DelUserTmp 27 5.2.5.7 SSR_DelUserTmpExt 27 5.2.6 面部数据相关 . 28 5.2.6.1 SetUserFace 28 5.2.6.2 GetUserFace 28 5
8、.2.6.3 DelUserFace 29 5.2.6.4 GetUserFaceStr 29 5.2.6.5 SetUserFaceStr 30 5.2.7 其他 30 5.2.7.1 GetFPTempLength 30 5.2.7.2 GetFPTempLengthStr 30 5.2.7.3 FPTempConvert 31 5.2.7.4 FPTempConvertStr 31 5.2.7.5 FPTempConvertNew 32 5.2.7.6 FPTempConvertNewStr 32 5.2.8 系统数据管理相关 . 32 5.2.8.1 ClearKeeperData 3
9、2 5.2.8.2 ClearData 33 5.2.8.3 GetDataFile 33 5.2.8.4 SendFile 34 5.2.8.5 RefreshData 34 5.3 门禁相关（时间段，组，开锁组合） . 35 5.3.1GetUserGroup 35 5.3.2SetUserGroup 35 5.3.3GetTZInfo 35 5.3.4SetTZInfo 36 5.3.5SSR_SetUnLockGroup 36 5.3.6SSR_GetUnLockGroup 37 5.3.7SSR_SetGroupTZ 37 5.3.8SSR_GetGroupTZ 38 5.3.9Ge
10、tUserTZs 38 5.3.10SetUserTZs 39 5.3.11GetUserTZStr 39 5.3.12SetUserTZStr 40 5.3.13ACUnlock 40 5.3.14GetACFun 41 5.3.15GetDoorState 41 5.3.16UseGroupTimeZone 41 5.4 机器管理 . 42 5.4.1IsTFTMachine 42 5.4.2GetDeviceStatus 42 5.4.3GetDeviceInfo 43 5.4.4SetDeviceInfo 45 5.4.5SetDeviceTime 45 5.4.6SetDeviceT
11、ime2 45 5.4.7GetDeviceTime 46 5.4.8GetSerialNumber 46 5.4.9GetProductCode 47 5.4.10GetFirmwareVersion 47 5.4.11GetSDKVersion 47 5.4.12GetDeviceIP 48 5.4.13SetDeviceIP 48 5.4.14GetDeviceMAC 48 5.4.15SetDeviceMAC 49 5.4.16GetWiegandFmt 49 5.4.17SetWiegandFmt 49 5.4.18GetCardFun 50 5.4.19SetDeviceCommP
12、wd 50 5.4.20SetCommPassword 51 5.4.21QueryState 51 5.4.22GetVendor 51 5.4.23GetDeviceStrInfo 52 5.4.24GetPlatform 52 5.4.25ReadAOptions 52 5.4.26GetSysOption 53 5.4.27SetSysOption 53 5.5 其他 . 54 5.5.1 机器控制 . 54 5.5.1.1ClearAdministrators 54 5.5.1.2EnableDevice 54 5.5.1.3EnableClock 54 5.5.1.4Disable
13、DeviceWithTimeOut . 55 5.5.1.5PowerOffDevice 55 5.5.1.6RestartDevice 55 5.5.2 卡操作相关 56 5.5.2.1WriteCard 56 5.5.2.2EmptyCard 56 5.5.3 其他 56 5.5.3.1GetLastError 56 5.5.3.2GetHIDEventCardNumAsStr 57 5.5.3.3CaptureImage 57 5.5.3.4UpdateFirmware 58 5.5.3.5BeginBatchUpdate 58 5.5.3.6BatchUpdate 58 5.5.3.7
14、CancelBatchUpdate . 59 5.5.3.8PlayVoice . 59 5.5.3.9PlayVoiceByIndex . 59 6.常见问题解答 60 6.1 如何下载考勤记录 60 6.2 如何联机创建用户 60 6.3 U 盘数据导入及下载 . 60 6.4 BIOKEY 采集指纹模板写入脱机 . 62 6.5 取得所有用户所有信息 62 6.6 机器连接 62 6.7 在 SSR_SetUserInfo 后密码不能用问题 62 6.8 联机模板转换为脱机模板 62 6.9 Demo 程序不能接机器问题 . 63 6.10 脱机指纹机连接后处于工作状态问题 63 6.1
15、1 上传非英文姓名或短消息到机器内出现乱码，或不能正常显示 . 63 6.12 卡管理问题 63 6.13 连接穿越防火墙或路由器问题 64 6.14 大容量指纹上传 64 6.15 高速上传和普通上传的区别 64 6.16 如何支持人脸模板的下载 64 1. SDK1. SDK 介绍介绍 脱机通讯开发包是一个与脱机指纹机、 门禁机、 卡机等进行数据通讯的接口。 可以方便地对机器进行用户信息、 指纹的管理，下载考勤记录、管理记录、用户信息、指纹模板、面部模板，对机器进行各种设置及门禁配置管 理的开发包。主要功能有： 1、下载机器考勤记录。 2、下载、上传用户信息、卡信息、指纹信息以及面部信息。
16、 3、设置门禁机的门禁规则。 4、进行各种配置，如设置机器时间、匹配阀值等。 5、可实时激发机器的各种事件，如按指纹、验证通过等。 2. 2. 快速开始快速开始 2.12.1 常用词介绍常用词介绍 1. 实时事件 在应用程序与机器通信成功后，部分在机器上的操作，如连接机器,验证,登记新用户等，会实时触发相 应的事件，并将数据传输到 PC 端（上位机） ，这些触发的事件被称为实时事件。用户可以通过实时事件 来实时监控机器目前所处的状态以及用户进行的实时操作。 2. FP Fingerprint 的缩写,即指纹 3. 指纹算法 指生成指纹模板和验证指纹模板的算法,当前我司最新的指纹算法为 ZKFinger 10.0，该算法为高速算法， 各方面性能大大提高，具体可参考 FAQ 说明 4. 高速缓冲区 指 SDK 在使用过程中在 PC 端申请的一部分内存， 在上传下载数据过程中， 数据首先被保存在缓冲区内， 然后才会被相应的处理 5. 时间段、组、开锁组合 这三者为门禁功能中最重要的概念 时间段就是一个时间范围，一个时间段包含一周的时间信息，该周内每天有一个时间范围，如下面
