B&W 系列脱机通讯开发手册
日期: 2013 年9月
2013 Intercorp Inc.。版权所有,翻印必究。
·本说明文件中的信息如有更改,恕不另行通知。
·Intercorp Inc.为 Intercorp 的司标,Biokey 为 Intercorp 的核心技术徽标,Intercorp ,Biokey 已经
在中国及美国注册。
·本说明文件中述及的其他商标和产品名称是指拥有相应商标和产品名称的公司或者制造的产品。
Intercorp Inc.对其他公司的商标和产品名称不拥有任何所有权。
·开发中使用问题,非开发包问题,请自行解决。
·使用该开发包,由于人为或程序本身造成数据丢失,本公司概不负责。
·该文档基于 6.2.4.11 版 SDK
目录
1. SDK 介绍 .............................................................................................................................................................. 1
2. 快速开始 ............................................................................................................................................................. 2
2.1 常用词介绍 ................................................................................................................................................ 2
2.2 常用工作流程介绍 ................................................................................................................................... 2
2.2.1 考勤记录下载流程: ...................................................................................................................... 3
2.2.2 操作记录下载流程: ...................................................................................................................... 3
2.2.3 门禁设置流程: .............................................................................................................................. 4
2.2.4 下载用户信息,指纹模板,面部模板等流程 ................................................................................ 4
2.2.5 实时事件接收流程 ........................................................................................................................ 5
2.2.6 联机登记流程 (上传用户信息,指纹模板等流程) .................................................................... 6
2.2.7 短消息上传流程 ............................................................................................................................ 7
3. 属性相关介绍 ..................................................................................................................................................... 7
3.1 AccGroup ................................................................................................................................................... 7
3.2 AccTimeZones ........................................................................................................................................... 7
3.3 BASE64 ....................................................................................................................................................... 7
3.4 CardNumber ............................................................................................................................................... 8
3.5 CommPort ................................................................................................................................................... 8
3.6 ConvertBIG5 ............................................................................................................................................. 8
3.7 PINWidth ................................................................................................................................................... 8
3.8 GetStrCardNumber ................................................................................................................................... 8
3.9 SetStrCardNumber ................................................................................................................................... 8
4. 实时事件相关 ..................................................................................................................................................... 9
4.1 获取实时事件方法 ................................................................................................................................... 9
4.1.1 RegEvent ....................................................................................................................................... 9
4.1.2 ReadRTLog ................................................................................................................................... 10
4.1.3 GetRTLog ..................................................................................................................................... 10
4.2 实时事件介绍 ......................................................................................................................................... 10
4.2.1 OnConnected ............................................................................................................................... 10
4.2.2 OnDisConnected ......................................................................................................................... 10
4.2.3 OnAlarm ....................................................................................................................................... 10
4.2.4 OnDoor ......................................................................................................................................... 11
4.2.5 OnAttTransaction ..................................................................................................................... 11
4.2.6 OnAttTransactionEx ................................................................................................................. 12
4.2.7 OnDeleteTemplate ..................................................................................................................... 12
4.2.8 OnEnrollFinger ......................................................................................................................... 12
4.2.9 OnFinger ..................................................................................................................................... 13
4.2.10 OnFingerFeature ..................................................................................................................... 13
4.2.11 OnHIDNum ................................................................................................................................... 13
4.2.12 OnKeyPress ............................................................................................................................... 13
4.2.13 OnNewUser ................................................................................................................................. 13
4.2.14 OnVerify ................................................................................................................................... 13
4.2.15 OnWriteCard ............................................................................................................................. 14
4.2.16 OnEmptyCard ............................................................................................................................. 14
4.2.17 OnEMData ................................................................................................................................... 14
5 常用函数介绍 ..................................................................................................................................................... 14
5.1 连接机器相关函数 ................................................................................................................................. 14
5.1.1 Connect_Net ............................................................................................................................... 14
5.1.2 Connect_Com ............................................................................................................................... 15
5.1.3 Connect_USB ............................................................................................................................... 15
5.1.4 Disconnect ................................................................................................................................. 15
5.2 数据管理相关函数 ................................................................................................................................. 16
5.2.1 考勤记录数据 ............................................................................................................................. 16
5.2.1.1 ReadGeneralLogData .......................................................................................................... 16
5.2.1.2 ReadAllGLogData ............................................................................................................... 16
5.2.1.3 GetGeneralLogData ............................................................................................................. 16
5.2.1.4 GetAllGLogData ................................................................................................................. 18
5.2.1.5 GetGeneralLogDataStr ........................................................................................................ 18
5.2.1.6 GetGeneralExtLogData ....................................................................................................... 19
5.2.1.7 ClearGLog ........................................................................................................................... 19
5.2.2 操作记录数据 ............................................................................................................................. 19
5.2.2.1 ReadSuperLogData.............................................................................................................. 19
5.2.2.2 ReadAllSLogData................................................................................................................ 20
5.2.2.3 GetSuperLogData ................................................................................................................ 20
5.2.2.4 GetAllSLogData .................................................................................................................. 22
5.2.2.5 ClearSLog ............................................................................................................................ 23
5.2.2.6 GetSuperLogData2 .............................................................................................................. 23
5.2.3 用户信息相关 .............................................................................................................................. 24
5.2.3.1 ReadAllUserID .................................................................................................................... 24
5.2.3.2 GetAllUserID ...................................................................................................................... 24
5.2.3.3 GetAllUserInfo .................................................................................................................... 24
5.2.3.4 EnableUser .......................................................................................................................... 25
5.2.3.5 ModifyPrivilege ................................................................................................................... 26
5.2.3.6 SetUserInfo .......................................................................................................................... 26
5.2.3.7 GetUserInfo ......................................................................................................................... 27
5.2.3.8 SetUserInfoEx ..................................................................................................................... 27
5.2.3.9 GetUserInfoEx ..................................................................................................................... 28
5.2.3.10 DeleteUserInfoEx .............................................................................................................. 28
5.2.3.11 GetUserInfoByPIN2 .......................................................................................................... 28
5.2.3.12 GetUserInfoByCard ........................................................................................................... 29
5.2.3.13 GetUserIDByPIN2 ............................................................................................................ 29
5.2.3.14 GetPIN2 ............................................................................................................................. 30
5.2.4 登记数据(同时包括用户信息和指纹) .................................................................................. 30
5.2.4.1 GetEnrollData ...................................................................................................................... 30
5.2.4.2 SetEnrollData ...................................................................................................................... 31
5.2.4.3 DeleteEnrollData ................................................................................................................. 31
5.2.4.4 GetEnrollDataStr ................................................................................................................. 32
5.2.4.5 SetEnrollDataStr .................................................................................................................. 32
5.2.5 指纹模板相关 .............................................................................................................................. 33
5.2.5.1 ReadAllTemplate ................................................................................................................. 33
5.2.5.2 DelUserTmp ........................................................................................................................ 33
5.2.5.3 GetUserTmp ........................................................................................................................ 34
5.2.5.4 SetUserTmp ......................................................................................................................... 34
5.2.5.5 GetUserTmpStr .................................................................................................................... 35
5.2.5.7 GetUserTmpEx .................................................................................................................... 36
5.2.5.8 SetUserTmpEx .................................................................................................................... 36
5.2.5.9 GetUserTmpExStr ............................................................................................................... 37
5.2.5.10 SetUserTmpExStr .............................................................................................................. 37
5.2.5.6 SetUserTmpStr .................................................................................................................... 35
5.2.6 短消息相关 .................................................................................................................................. 38
5.2.6.1 SetSMS ................................................................................................................................ 38
5.2.6.2 SetUserSMS ........................................................................................................................ 39
5.2.6.3 GetSMS ............................................................................................................................... 39
5.2.6.4 DeleteSMS ........................................................................................................................... 40
5.2.6.5 DeleteUserSMS ................................................................................................................... 40
5.2.6.6 ClearUserSMS ..................................................................................................................... 40
5.2.6.7 ClearSMS ............................................................................................................................ 41
5.2.7 WorkCode 相关 ............................................................................................................................ 41
5.2.7.1 SetWorkCode ....................................................................................................................... 41
5.2.7.2 GetWorkCode ...................................................................................................................... 41
5.2.7.3 DeleteWorkCode ................................................................................................................. 42
5.2.7.4 ClearWorkCode ................................................................................................................... 42
5.2.8 节假日相关 .................................................................................................................................. 42
5.2.7.1 SetHoliday ........................................................................................................................... 42
5.2.7.2 GetHoliday .......................................................................................................................... 43
5.2.9 夏令时相关 .................................................................................................................................. 43
5.2.9.1 SetDaylight .......................................................................................................................... 43
5.2.9.2 GetDaylight ......................................................................................................................... 43
5.2.10 自定义相关(声音,考勤状态) ........................................................................................... 44
5.2.10.1 EnableCustomizeAttState .................................................................................................. 44
5.2.10.2 SetCustomizeAttState ........................................................................................................ 45
5.2.10.3 DelCustomizeAttState ....................................................................................................... 45
5.2.10.4 SetCustomizeVoice ............................................................................................................ 45
5.2.10.5 DelCustomizeVoice ........................................................................................................... 46
5.2.10.6 EnableCustomizeVoice ...................................................................................................... 46
5.2.11 指纹模板转换相关 .................................................................................................................... 47
5.2.11.1 GetFPTempLength ............................................................................................................. 47
5.2.11.2 GetFPTempLengthStr ........................................................................................................ 47
5.2.11.3 FPTempConvert ................................................................................................................. 47
5.2.11.4 FPTempConvertStr ............................................................................................................ 48
5.2.11.5 FPTempConvertNew ......................................................................................................... 48
5.2.11.6 FPTempConvertNewStr ..................................................................................................... 49
5.2.12 系统数据管理相关 .................................................................................................................... 49
5.2.12.1 ClearKeeperData ............................................................................................................... 49
5.2.12.2 ClearData ........................................................................................................................... 49
5.2.12.3 GetDataFile ....................................................................................................................... 50
5.2.12.4 SendFile ............................................................................................................................. 50
5.2.12.5 ReadFile ............................................................................................................................. 51
5.2.12.6 RefreshData ....................................................................................................................... 51
5.3 门禁相关(时间段,组,开锁组合) .................................................................................................. 52
5.3.1 GetUserGroup ............................................................................................................................. 52
5.3.2 SetUserGroup ............................................................................................................................. 52
5.3.3 GetTZInfo ................................................................................................................................... 52
5.3.4 SetTZInfo ................................................................................................................................... 53
5.3.5 GetUnlockGroups ....................................................................................................................... 53
5.3.6 SetUnlockGroups ....................................................................................................................... 54
5.3.7 GetGroupTZs ............................................................................................................................... 54
5.3.8 SetGroupTZs ............................................................................................................................... 55
5.3.9 GetGroupTZStr ........................................................................................................................... 55