汉王科技面部识别终端脱机通讯开发指南V2.3.pdf
汉王科技面部识别终端脱机通讯开发指南。本开发指南版权归汉王科技股份有限公司所有，翻印必究。
本开发指南中述及的其他商标和产品名称是指拥有相应商标和产品名称的公司或者制造的产品。汉王科技对其他公司的商标和产品名称不拥有任何所有权。
使用该开发包，由于人为或程序本身造成数据丢失，概不负责。
汉王科技面部识别终端脱机通讯开发指南
目录
1.SDK概述.
4
2.SDK调用
3基本约定
3.1语法和保留字
3.2保留字的命名原则
4保留字列表及其含义.
命令字
.2控制字.
5命令详解
15
5.1员工管理类命令
·
,,,,,15
5.2管理员管理类命令
5.3记录管理类命令.
20
5.4设备管理类命令
5.5图像管理类命令.
..36
第3贝共37页
汉王科技面部识别终端脱机通讯开发指南
概述
共有C#、Java、VC+-3种语言的SDK,支持向设备下发命令、自动接收考勤数据和设备
心跳包功能
调用
具体参考博客文章,网址为http://www.firstsolver.com/wordpress/?pageid=902
基本约定
语法和保留字
命令字
控制字控制字参数常量保留字其他变量
分隔符
Command Word( Ctrl Wordl ="Parameter/Value"][ Ctrl Word2="Parameter /value"I
图3.1
本协议的语法结构如图3.1所示,由4类保留字组成,这4类保留字的说明如下表所示。
保留字名称
意义与用途
命令字
用」指明本次操作究竞要干什么(如: GetEmployeeID表示获取面部识
别终端上所有员工的员工号)
控制字
作为命令字的参数出现,用于指明该参数是什么(如:nane表示该参
数是员工姓名)。
常量保留字
作为命令字的参数出现,一般跟在控制字的后面,用于指示该参数的值
是多少。(如:1 anguage="chs"表示该面部识别终端的语言设置为简
体中文)。
分隔符
用于分隔各个保留字
表3.1保留字说明表
除分隔符外,其余保留字为数字字母下划线的组合,最长32字符,大小写敏感。各保
留字间可以插入 Space(空格)、Tab(跳格)、CR(回车),处理忽賂不计。
第4贝共37页
汉王科技面部识别终端脱机通讯开发指南
保留字的命名原则
保留字名称
命名原则
命令字
Pasca命名法,指用个或多个连在·起的词来组成名字,每个词都用
大写字母开头,其他字母都小写。
控制字
采用“小写加下划线”的方式,都用小写字母,词之间用“”分隔。
如 face data
常量保留字
采用“小写加下划线”的方式。
保留字列表及其含义
命令字
名称
意义
员工管理类命令
GetEmployee id
从考勤机接收所有员工的员工号
GetEmployee
从考勤机接收指定工号员工的员工信息,一次只能接收一个
SetEmployee
发送员工到考勤机,一次只能发一个。
Get EmploveePhot
从考勤机获取指定员工的脊记大头照
SetEmploveephotd
设置或更新执行员工的登记大头照
De leteEmployee
在考勤机上删除指定上号的员工。可一次删除一个员⊥
De leteAllEmployee
在考勤札上删除所有员工
SetNametable
更新考勤机上的"id-姓名"对照表
AddNametable
添加"id-姓名"对照表
Enroll loved
向考勤机发送开始登记的指令
DetectEmploveeData
检测改备是否包含员工数据
SetsMs
发送短消息到考勤机
GetsMs
从考勤机接收短消息
DeleteSms
删除考勤机中的短消息
管理员管理类
第5贝共37页
汉王科技面部识别终端脱机通讯开发指南
GetManager ID
获得所有管理员ⅠD
GetManager
根据管理员ⅠD获得管理员信息
Sctmanager
设置管理员信息
De leteManager
删除指定管理员
Init Deviceadmin
初始化考勤机的管坦员设置到出厂状态
Get ManagerType
获得制定管理员的管理级别(超级管理员/普通管理员)
SetManagerT ype
设置制定管理员的管理级别(超级管理员/普通管理员)
Deleteallsms
清空考勤机中的短消息
记录管理类命令
Getrecord
从考勤机接收所指定时间范围的考勤记录
DeleteAllrecord
考勤机上删除指定时间之前的所有考勤记录)删除考勤机上所有考勤记逯
DeleteRecord
安照时间段删除考勤机上的记
DeleteUploadedRecorc删除经上传到服务器的记录,未上传的不删
设备管理类基础命令
InitDevice
初始化考勤机到出厂状态
GetMAC s\
获得mac地址和序列号
DetectDevice
检测设备是否存在
Restartdevice
重启设备
GetDevice info
读取考勤机配置、状态信息
SetDevicelnfo
设置考勤机酩置、状态信息、
GetVolume
获得设备音量
Setvolume
设置设备音量
GetDateTime
获得设备日期
SetDatetime
设置设备日期
UpdateFirmware
固件升级
GetDaylight
获得夏令时
SetDaylight
设定夏令时
GetDevicecapacit
获取设备容量
第6贝共37页
汉王科技面部识别终端脱机通讯开发指南
Get DeviceMode
获取设备的型号类型
设备管理类通讯命令
GetNetInfo
获得网络参数
SetNetinfo
设定网络参数
GetWifilnfo
获取WFL参数信息
SetwifiInfo
设置WIFI参数信息
GctClientstatus
获取自动上传状态
Setclientstatus
设置自动上传状态
GetWiegandout
获得韦根参数
SetWiegandout
设置韦根参数
SetServerHost
设置设备主动上传的服务器参数
设备管理考勤命令类
GetBell
获得定时响铃参数
SchEll
设置定时响铃参数
GetWorkCode
获取工作码
SetWorkcode
设定上作码列表
ClearWork code
凊空工作码列表
DeleteWorkcode
刪除指定工作码
Get Workstatus
获得工作状态列表
Setworkstatus
设定工作状态列表
ClearWorkstatus
清空工作状态列表
DeleteWork status
删除指定工作状态
GetAttendance Interval获得考勤时间间隔
SetAttendance lnterval设置考勤时间间隔
设备管理安全类命令
Opendoor
远程开门
ConfirmPassword
验证密码
SetattendanceAccessSync设置开门同步
第7贝共37页
汉王科技面部识别终端脱机通讯开发指南
SetRelaytime
设置继电器的延迟开门时长
GetRemovealarim
获得当前所拆警报状态
Setremovealarm
设置当前防拆警报状态
Getfralarm
获得当前拒识警报状态
Setfra⊥arm
设置当前拒识警报状态
GetMagnetalarm
获得当前门磁警报状态
SetmagnetAlarm
设置当前门磁警报状态
GetOnoffSchedule
获得定时开关机状态
Setonoffschedule
设置定时丌关机状态
Set companyName
设置公司名称
高级管理命令
Setcpgrade
网络升级命
CheckUpgradeStatus
查看网络开级状态
SetRelayoutput
受置输出类型
SetDuplicationcheck
启/关闭登记查重功能
保安图片管理类命令
GetPictureName
得到保安图片的文件名
GetPicture
根据文件名得到指定的保安图片
GetPictureNameBy ID
根据文件名和用户工号获取安保照片
SetSecPhot
开启或者关团设备保存安保照片的功
SetPhotoPrompt
开启或者关闭刷卡拍照时是否检测到人脸才拍照
结果类命令
Return
返回值标识。是某个命令执行结果。结构如
Return( result="success failed"[ Ctrl Word =Parameter
Value
Wait
等待标识。表示考勤机正在执行命令,需要等待一定的时间(时间由控制字
第8贝共37页
汉王科技面部识别终端脱机通讯开发指南
wait time指定,单位为秒)后才能返回结果,结构如:
Wait( wait time="10")//该命令表示需要等待10秒钟
该命令被用于如下场合
某操作需要时间较长(例如:初始化考勤机),这时等待该操作的一方可通过
walt time了解到需要等待多长吋间才能接收到正确的结果。
一般来说,如果命令的执行可以在5秒钟内廾始返回结果,则不需要使用Wait
命令
需要注意的是:本协议的接收数据默认等待时间是5秒。如果一个命令在5秒
内没有返回,并且没有用Wait命令指明需要等待的时间,则超时退出
控制字
名称
意义
对命令执行结果的描述
result
标示某命令的执行结果,可能的常量值有
名称
意义
Success
成功
failed
失败
reason
对执行结果的解释信息,可能的常量值有:
名称
意义
unknown command
不能识别的命令
bad parameter
错误的参数
device busy
设备忙
employee overflow
对于 SetEmployee命令,员工超过最大数
unknown id
对于 DeleteEmployee命令,指定id的员工不
存在
notify
对执行结果的提醒信息,通常是由于命令中有不能识别的参数所致,可能的常
第9贝共37页
汉王科技面部识别终端脱机通讯开发指南
量值有
名称
意义
unknown parameter
不能识别的参数
注意执行结果必须以 result/ reason/ otify开头,并且必须按
result/ reason/ notify这样的顺序排列。
wait time
指明完成某设备操作需要等待的时间,单位为秒
对员工信息的描述
d
员工号( ASCII字符,例:id="9997")
备注:一条记录,必须以id来开始
name
员工姓名(例:name="刘迎建")
card num
刷卡号码(例: card num=" OXffffffff")
register type
register type="ace":表示人脸
register type-"card":表小刷卡拍照
enter type
enter type-"0X01":face,表示人脸
enter type-"0X02":card& photo,表示刷卡拍照
enter type="0X04":card&face,表示人脸加刷卡
enter type="0X08":card,表示刷卡
authority
authority="X0": Attend&access,示考勤和开门杖限
authority="0×55″: Attend Only,衣示考勤权限
authority="0XA": Access Only,表示开门权限
authority-"0XFF":0 thers,表小其他
check type
考勤权限(例: check type"face")
opendoor type
开门权限(例: opendoor type="face")
face data
人脸模板,值为base-64编码的二进制数据。
模板数据也要用〃〃括起来
如果有18个模板,则有18个 face data项
head photo
人头照,值为oase-64编码的二进制数据。
第10贞共37页
**** Hidden Message *****
66666666666666666666666666666
页:
[1]