一卡通接口说明文档V25.docx
《一卡通接口说明文档V25.docx》由会员分享，可在线阅读，更多相关《一卡通接口说明文档V25.docx（67页珍藏版）》请在冰豆网上搜索。
一卡通接口说明文档V25
一卡通接口说明文档（V2.5）
函数调用说明（对硬件操作的函数）
完成一个功能需要以下几个步骤:
1.根据指令说明生成命令字（调用函数:
CreateBstrFuncDataByArray）
2.向设备发送命令以及获得设备返回信息（调用函数:
GetAndSendInfo或GetAndSendTcpData）
3.获取公共变量值（ErrCode）,是否为”0”，是则操作成功。
（有时需要得到设备返回信息）
公共函数说明
成员：
ECardDerviceSDKMJ.pubOpterPublic
1、485设备开始或停止读卡
PublicFunctionIsReadCard（ByValComPortNoAsInteger,ByValMacKeyAsString,ByValMacTypeAsInteger,ByRefisVailAsBoolean）AsLong
参数名
参数说明
是否必须
默认值
格式
ComPortNo
设备端口号
是
无
设备端口号
MacKey
设备序列号
是
无
设备序列号
MacType
设备类型
是
无
1门或2门或4门或5
isVail
开始与停止标志
是
无
1、开始
2、停止
返回值：
为8：
则开始读卡或停止读卡成功
为2：
则开始读卡或停止读卡失败
2、得到485设备读卡时得到的卡号
PublicFunctionGetReadCard（ByValComPortNoAsInteger,ByValMacKeyAsString,ByValMacTypeAsInteger,strCardNoAsString）AsLong
参数名
参数说明
是否必须
默认值
格式
ComPortNo
设备端口号
是
无
设备端口号
MacKey
设备序列号
是
无
设备序列号
MacType
设备类型
是
无
1门或2门或4门或5
strCardNo
得到的卡号
是
无
得到的卡号信息
返回值：
为8：
成功得到卡号
为2：
未得到卡号
得到的卡号为六位十六进制，需通过函数ConvHexCardToDecCard转换为八位卡号
3、域名转换为IP
PublicFunctionURL_TO_IP（URLAsString）AsString
参数名
参数说明
是否必须
默认值
格式
URL
域名
是
无
域名
返回值：
转换得到的IP地址
4、得到485设备读卡时得到的卡号（2010.11新增）
PublicFunctionGetReadCard34OR26（ByValComPortNoAsInteger,ByValMacKeyAsString,ByValMacTypeAsInteger,strCardNoAsString,strCardProtocolAsString）AsLong
参数名
参数说明
是否必须
默认值
格式
ComPortNo
设备端口号
是
无
设备端口号
MacKey
设备序列号
是
无
设备序列号
MacType
设备类型
是
无
1门或2门或4门或5
strCardNo
得到的卡号
是
无
得到的卡号信息
strCardProtocol
卡片协议
是
“”
“0”:
WG26，“1”:
WG34
返回值：
为8：
成功得到卡号
为2：
未得到卡号
得到的卡号为六位十六进制，需通过函数ConvHexCardToDecCard转换为八位卡号
5、关闭当前对象打开的串口（2011.05新增）
此方法对串口通讯尤为重要，在每次发送数据完毕后，最好调用此对象的此方法关闭串口，以免串口被占用
PublicSubCloseComm（）
参数名
参数说明
是否必须
默认值
格式
门禁说明
成员：
ECardDerviceSDKMJ.pubOpterDerviceMJ
公用变量
ErrCode:
错误代码提示:
0,正常;1,打开端口失败;2,没有反馈数据;3,较验码错误（所有函数有效）
函数说明
1、生成发送命令（函数返回生成的命令）
PublicFunctionCreateBstrCommand（ByReflngSNAsLong,ByRefintTypeAsInteger,ByRefstrFuncDataAsString）AsString
参数名
参数说明
是否必须
默认值
格式
lngSN
设备序列号
是
无
序列号后五位转换为long类型
intType
设备类型
是
无
1门、2门、4门
strFuncData
操作指令
是
无
操作码
返回值：
得到最终下传给设备的指令
2、发送/接收串口信息（函数返回接收信息）
PublicFunctionGetAndSendInfo（ByValComPortNoAsInteger,ByRefstrCommandAsString）AsString
参数名
参数说明
是否必须
默认值
格式
ComPortNo
设备序列号
是
无
电脑端口号,如:
1、2等
strCommand
设备类型
是
无
CreateBstrCommand生成的指令
返回值：
485设备返回的信息
3、发送/接收TCP/IP信息（函数返回接收信息）
PublicFunctionGetAndSendTcpData（ByValstrIPAsString,ByVallPortAsLong,ByValstrCommandAsString）AsString
参数名
参数说明
是否必须
默认值
格式
strIP
IP地址
是
无
如:
”192.168.2.123”
lPort
端口号
是
无
如:
60000
strCommand
发送的指令
是
无
CreateBstrCommand生成的指令
返回值：
TCP设备返回的信息
4、十进制转换为bytLen个字节的十六进制
PublicFunctionNumToStrHex（ByValnumAsLong,ByValbytLenAsInteger）AsString
参数名
参数说明
是否必须
默认值
格式
num
十进制数
是
无
如:
100
bytLen
字节数
是
无
如:
2
返回值：
十进制转换得到的bytLen个字节的十六进制
5、格式化当前日期
PublicFunctionGetTimeNow（）AsString
参数名
参数说明
是否必须
默认值
格式
返回值：
得到可下传给设备的当前时间
6、取门禁设备时间
PublicFunctionMJGetTimeFromRunInfo（ByRefstrRunInfoAsString）AsString
参数名
参数说明
是否必须
默认值
格式
strRunInfo
调用GetAndSendInfo或GetAndSendTcpData返回的信息
是
无
返回值：
得到门禁设备时间，格式为:
YYYY-MM-DDHH:
MM:
SS
7、取门禁总记录条数
PublicFunctionMJGetCountRecordsFromRunInfo（ByRefstrRunInfoAsString）AsString
参数名
参数说明
是否必须
默认值
格式
strRunInfo
调用GetAndSendInfo或GetAndSendTcpData返回的信息
是
无
返回值：
得到门禁设备记录总数
8、取门禁权限个数
PublicFunctionMJGetPowersFromRunInfo（ByRefstrRunInfoAsString）AsString
参数名
参数说明
是否必须
默认值
格式
strRunInfo
调用GetAndSendInfo或GetAndSendTcpData返回的信息
是
无
返回值：
得到门禁设备权限个数
9、格式化单条门禁记录
PublicFunctionMJGetRecordRunInfo（ByRefstrRunInfoAsString）AsString
参数名
参数说明
是否必须
默认值
格式
strRunInfo
调用GetAndSendInfo或GetAndSendTcpData返回的信息
是
无
返回值：
得到门禁设备指定单条记录
10、格式化模块门禁记录
PublicFunctionMJGetModRecordRunInfo（ByRefstrRunInfoAsString）AsString
参数名
参数说明
是否必须
默认值
格式
strRunInfo
调用GetAndSendInfo或GetAndSendTcpData返回的信息
是
无
返回值：
得到门禁设备指定块记录，每块51条记录，每条记录以空格隔开
11、转换员工编号
PublicFunctionGetStrEmpID（ByRefEmpIdAsString）AsString
参数名
参数说明
是否必须
默认值
格式
EmpId
员工编号
是
无
如:
”EMP001”
返回值：
得到下传到设备的员工编号格式字符串
12、转换员工卡号
PublicFunctionGetStrCardNo（ByReflCardNoAsLong）AsString
参数名
参数说明
是否必须
默认值
格式
lCardNo
员工卡号
是
无
WG26卡号
返回值：
得到下传到设备的员工卡号格式字符串
13、转换员工姓名
PublicFunctionGetStrEmpName（ByRefEmpNameAsString）AsString
参数名
参数说明
是否必须
默认值
格式
EmpName
员工姓名
是
无
如:
”张三”
返回值：
得到下传到门禁设备的员工姓名格式字符串
14、根据返回信息生成员工卡号（2010.11新增）
PublicFunctionGetStrCardNoFromRunInfo34OR26（ByRefstrRunInfoAsString,strCardProtocolAsString）AsString
参数名
参数说明
是否必须
默认值
格式
strRunInfo
调用GetAndSendInfo或GetAndSendTcpData返回的信息
是
无
strCardProtocol
卡片协议
是
“”
“0”:
WG26,“1”:
WG34
返回值：
得到门禁设备返回信息中的卡号
15、根据返回信息生成员工姓名（2010.11新增）
PublicFunctionGetStrEmpNameFromRunInfo34OR26（ByRefstrRunInfoAsString,strCardProtocolAsString）AsString
参数名
参数说明
是否必须
默认值
格式
strRunInfo
调用GetAndSendInfo或GetAndSendTcpData返回的信息
是
无
strCardProtocol
卡片协议
是
“”
“0”:
WG26,“1”:
WG34
返回值：
得到门禁设备返回信息中的姓名
16、发送/接收串口信息（函数返回接收信息）WG34OR26（2010.11新增）
PublicFunctionGetAndSendInfo34Or26（ByValComPortNoAsInteger,ByRefstrCommandAsString，strCardProtocolAsString）AsString
参数名
参数说明
是否必须
默认值
格式
ComPortNo
设备序列号
是
无
电脑端口号,如:
1、2等
strCommand
设备类型
是
无
CreateBstrCommand生成的指令
strCardProtocol
卡片协议
是
无
“0”:
WG26，“1”:
WG34
返回值：
485设备返回的信息
17、格式化模块门禁记录（2010.11新增）
PublicFunctionMJGetModRecordRunInfo34OR26（ByRefstrRunInfoAsString,strCardProtocolAsString）AsString
参数名
参数说明
是否必须
默认值
格式
strRunInfo
调用GetAndSendInfo或GetAndSendTcpData返回的信息
是
无
strCardProtocol
卡片协议
是
无
“0”:
WG26，“1”:
WG34
返回值：
得到门禁设备指定块记录，每块51条记录，每条记录以空格隔开
18、格式化单条门禁记录（兼容WG34和WG26）（2010.11新增）
PublicFunctionMJGetRecordRunInfo34OR26（ByRefstrRunInfoAsString,strCardProtocolAsString）AsString
参数名
参数说明
是否必须
默认值
格式
strRunInfo
调用GetAndSendInfo或GetAndSendTcpData返回的信息
是
无
strCardProtocol
卡片协议
是
无
“0”:
WG26，“1”:
WG34
返回值：
得到门禁设备指定条记录
19、获取门磁状态（兼容WG34和WG26）（2010.11新增）
PublicFunctionMJGetRecordStatusRunInfo34OR26（ByRefstrRunInfoAsString,strCardProtocolAsString）AsString
参数名
参数说明
是否必须
默认值
格式
strRunInfo
调用GetAndSendInfo或GetAndSendTcpData返回的信息
是
无
指定条记录
strCardProtocol
卡片协议
是
无
“0”:
WG26，“1”:
WG34
返回值：
得到门禁设备指定条记录的门磁状态
20、转换十六进制卡号为十进制卡号（2010.11新增）
PublicFunctionConvHexCardToDecCard（ByRefstrCardHexAsString,strCardProtocolAsString）AsString
参数名
参数说明
是否必须
默认值
格式
strCardHex
十六进制卡号
是
无
3/4个字节十六进制
strCardProtocol
卡片协议
是
“”
“0”:
WG26，“1”:
WG34
返回值:
十进制卡号
21、分解单条记录信息（2011.05新增）
PublicFunctionParseSingleRecord（strSingleRecordAsString,strCardProtocolAsString）AsString（）
参数名
参数说明
是否必须
默认值
格式
strSingleRecord
单条记录
是
无
MJGetModRecordRunInfo34OR26返回值
strCardProtocol
卡片协议
是
“”
“0”:
WG26，“1”:
WG34
返回值:
数组类型
ParseSingleRecord（0）:
卡号或门编号
ParseSingleRecord
（1）:
通过标志位
ParseSingleRecord
（2）:
读卡器编号
ParseSingleRecord（3）:
报警索引
ParseSingleRecord（4）:
打卡时间
ParseSingleRecord（5）:
通过类型,1:
正常刷卡（不管通过未通过）,2:
报警（包括电脑开门、按钮开门、以及其他的扩展报警）
其余说明请参考按块采集指令说明
22、关闭当前对象打开的串口（2011.05新增）
此方法对串口通讯尤为重要，在每次发送数据完毕后，最好调用此对象的此方法关闭串口，以免串口被占用
PublicSubCloseComm（）
参数名
参数说明
是否必须
默认值
格式
门禁功能说明
所有关于设备操作的指令都可通过以下函数生成
'*****************************************
'生成操作命令
'*****************************************
PublicFunctionCreateBstrFuncDataByArray（ByRefstrCodeAsString,ByRefstrSNAsString,ByRefstrParameterArray（）AsString）AsString
注意：
此数组长度至少为101，即定义时需设置其元素个数的小定义为101及以上，每次使用之前需要对数组进行初始化。
1、启用和停止读卡功能
<1>TCP机器
参数名
参数说明
是否必须
默认值
格式
strCode
操作码
是
无
“35”
strSN
设备序列号
是
无
设备七位数编号
strParameterArray（0）
TCP设备是否启用读卡功能
是
“”
“0”:
不启用
“1”:
启用
生成操作指令并调用GetAndSendTcpData后，取得ErrCode值:
A为0：
启用读卡或停止读卡成功
B非0：
启用读卡或停止读卡失败
读卡成功后，按照（2、Tcp设备读卡得到卡号等信息）说明操作
<2>485通讯设备
A调用IsReadCard函数启用读卡功能，取得其返回值：
B返回值若为8，表示启用成功，接着调用GetReadCard34OR26取得卡号，可连续调用GetReadCard34OR26连续读卡。
注意此时得到的卡号为十六进制，需调用ConvHexCardToDecCard进行转换。
注意：
"00000000"为无效卡号。
2、Tcp设备读卡得到卡号等信息
参数名
参数说明
是否必须
默认值
格式
strCode
操作码
是
无
“37”
strSN
设备序列号
是
无
设备七位数编号
生成操作指令并调用GetAndSendTcpData后，取得ErrCode值:
A为0：
成功得到包含卡号的信息，并调用GetStrCardNoFromRunInfo34OR26得到八位数卡号,注意”00000000”为无效卡号
B非0：
未得到包含卡号的信息
3、从设备直接读取权限信息
参数名
参数说明
是否必须
默认值
格式
strCode
操作码
是
无
“11”
strSN
设备序列号
是
无
设备七位数编号
strParameterArray（0）
权限编号
是
“”
权限的编号
生成操作指令并调用GetAndSendTcpData或GetAndSendInfo后，取得返回值:
A非空：
则可分别调用GetStrCardNoFromRunInfo34OR26和GetStrEmpNameFromRunInfo34OR26得到卡号和姓名
B空：
设备没有返回值或已经读取完毕
4、扩展板胁迫报警密码设置
参数名
参数说明
是否必须
默认值
格式
strCode
操作码
是
无
“23”
strSN
设备序列号
是
无
设备七位数编号
strParameterArray（0）
胁迫密码
是
“”
六位数密码,如:
“123456”
生成操作指令并调用GetAndSendTcpData或GetAndSendInfo后，取得ErrCode值:
A为0：
设置成功
B非0：
设置失败
5、扩展板报警设置
参数名
参数说明
是否必须
默认值
格式
strCode
操作码
是
无
“26”
strSN
设备序列号
是
无
设备七位数编号
strParameterArray（0）
扩展板输出端口号
是
“”
1或2或3或4
strParameterArray
（1）
门编号
是
“”
1或2或3或4
strParameterArray
（2）
报警事件启用列表,各项0不启用,1启用
是
“”
1、无效刷卡
2、门长时间未关
3、非法闯入
4、联动
5、火警
6、胁迫报警
7、反潜回报警
7项依次设置,如启用1与3两项，则设置为:
”010*********”
strParameterArray（3）
高级设置信息列表
是
“”
1、非法闯入，维持报警，门关好后报警自动解除
2、门长时间未关报警，报警维持预先设置的报警时间，之后报警解除
3、门长时未关报警，门关好自动解除
3项依次设置，如启用1与3两项，则设置为;”010001”。
注：
2与3为互斥关系
strParameterArray（4）
报警动作时长
是
“”
单位为秒,如10秒
生成操作指令并调用GetAndSendTcpData或GetAndSendInfo后，取得ErrCode值:
A为0：
设置成功
B非0：
设置失败
6、扩展板门超时时间设置
参数名
参数说明
是否必须
默认值
格式
strCode
操作码
是
无
“36”
strSN
设备序列号
是
无
设备七位数编号
strParameterArray（0）
超时时间
是
“”
秒，如：
10秒
生成操作指令并调用GetAndSendTcpData或GetAndSendInfo后，取得ErrCode值:
A为0：
设置成功
B非0：
设置失败
7、多卡认证设置
参数名
参数说明
是否必须
默认值
格式
strCode
操作码
升级会员 