my.ix.cardreadercommand -凯发app官方网站

android 开发文档

windows 开发文档

linux 开发文档

iot 小程序开发文档

其它

iot 开放平台 spi 流程概览

复杂类型管理

api

iot 小程序 api 概述

收银台

刷脸核身

刷脸登录

会员与授权

发送付款码

发送和接收小指令

版本查询

获取系统属性

系统设置页面

二维码识别

生成二维码

ui 控制

语音播报

本地数据库

本地图片存储

串口通信

外设管理

打印指令

监听按键事件

身份证读卡器适配

电子秤

钱箱

非接卡通信

ic 卡通信

红外测温仪

消息服务

日志服务

前后屏通信

更多使用指南

更新时间：2023-12-28 09:56:25

订阅更新

我的文档

设置

简介

读卡器通信接口，用于设置读卡器参数，读写卡等操作。

使用限制

支持的身份证读卡器型号

：

类别	型号	连接方式	vid,pid(十进制）	说明
本地读卡器	精伦电子ird210	usb	1061, 33113	-
	精伦电子ird211	usb	1061, 33113	iotconnect 3.0.0.9支持
	华视读卡器cvr-100n	usb	1024, 50010	-
	华视读卡器cvr-100uc	usb	1024, 50010	iotconnect 3.0.0.9支持
	新中新读卡器f200	usb	1024, 50010	iotconnect 3.0.0.9支持
	新中新读卡器f200a	usb	1024, 50010	iotconnect 3.0.0.9支持
	神思读卡器ss628	usb	9754, 17	-
	神思读卡器ss728	usb	9754, 12	-
	天波读卡器tps100	usb	1155, 22352	-
	明泰读卡器mt4d	usb	9124, 537	-
	深圳德卡读卡器	usb	9595, 12337	-
	南京亿数读卡器ys600	usb	38259, 18486	iotconnect 3.0.0.9支持
云读卡器	深圳德卡-商米云	usb	1137, 28675 9595, 12305	商米云解码。
	eid读卡器-商米云	usb	8898, 9473	商米云解码。
	eid读卡器-鹿马云	usb	8898, 9474	鹿马云解码。
	lotus云读卡器	usb	1306, 20763	-
	中软高科云读卡器	usb	49686, 258	-
	微住云读卡器	usb	1024, 50010	iotconnect 3.0.0.9支持

接口调用

示例代码

.js 示例代码

设置云读卡

读卡

入参

名称	类型	是否必填	描述
target	number	否	要与之通信的读卡器 id，通过 my.ix.getdevices 获得。如果不填，默认系统接入的第 1 个读卡器设备。
cmds	json	是	json 格式： {'cmd': '...', 'args': ['...']} 通信指令，如下描述。

通信指令格式

名称	类型	是否必填	描述
cmd	string	是	指令名称，详情可查看通信指令。
args	jsonarray	是	指令参数，详情可查看通信指令。

通信指令

setconfigs

说明：设置读卡器配置信息。

命令范例： {'cmd':'setconfigs', 'args':[{"configname":"configvalue"}]}。

参数数量：n
参数序号	参数类型	参数值	描述
0	json	-	要设置的配置集合。配置说明可查看配置列表。
回调函数
success	表示调用成功，出参： configs：json 对象类型，设置后的配置结果。
fail	表示调用失败，详情可查看错误码说明。

readcard

说明：读取身份证信息。

命令范例： {'cmd':'readcard', 'args':[]}。

参数数量：0
参数序号	参数类型	参数值	描述
-	-	-	-
回调函数
success	表示调用成功，出参可查看身份证信息说明。
fail	表示调用失败，详情可查看错误码说明。

enableautoread

说明：打开自动读卡模式。

命令范例： {'cmd':'enableautoread', 'args':[]}。

参数数量：0
参数序号	参数类型	参数值	描述
-	-	-	-
回调函数
success	表示调用成功。
fail	表示调用失败，详情可查看错误码说明。

disableautoread

说明：关闭自动读卡模式。

命令范例： {'cmd':'disableautoread', 'args':[]}。

参数数量：0
参数序号	参数类型	参数值	描述
-	-	-	-
回调函数
success	表示调用成功。
fail	表示调用失败，详情可查看错误码说明。

出参

成功

名称	类型	描述
success	boolean	值为 true。
返回內容为 { success : true,…… } 根据不同的通信指令携带不同的出参，详细定义见各通信指令 success 回调说明。

失败

名称	类型	描述
error	number	错误码。
errormessage	string	详细错误描述。
返回内容只包含 {error: number, errormessage: '详细错误描述'}返回错误码定义和错误码描述见错误码说明。

错误码说明

error	类型	说明（errormessage)
2001	number	未知错误
2002	number	读卡器不支持
2003	number	连接读卡器失败
2004	number	无访问权限
2005	number	寻卡失败
2006	number	选卡失败
2007	number	读卡错误
2008	number	证照读取失败
2009	number	认证失败

附录

身份证信息说明

名称	类型	描述
type	string	●native：本地读卡器返回值。 ●cloud_sunmi：商米云读卡数据类型。
message	string	●如果 type 为 cloud_*，如 cloud_sunmi，返回云读卡数据。小程序应该将此值回传到服务商应用服务器，应用服务器调用商米云解码进行解码，请查看。 ●如果 type 为其它类型，值为空字符串 ""。
info	json	●本地读卡器：各厂商的原始输出。 ●云读卡器：为空字符串口 ""。
photo	string	●本地读卡器：照片的 base64 string。 ●云读卡器：空字符串 ""。
firstfp	string	●本地读卡器：第一枚指纹信息。 ●云读卡器：空字符串 ""。
secondfp	string	●本地读卡器：第二枚指纹信息。 ●云读卡器：空字符串 ""。

配置列表

名称	类型	是否必填	描述
interval	int	非必填	自动读卡间隔。默认值 1000，单位 ms。取值范围：[100, 10000]
fingerprint	boolean	非必填	是否读取指纹信息。只针对支持的读卡器生效。默认值 true。
server	string	云读卡器必填	云读卡服务器名。
appid	string	云读卡器必填	注册云读卡服务的 appid，用于底层获取身份证信息。
dispatchserver	string	lotus云读卡器必填	调度服务器地址。
szserver	string	lotus读卡器必填	安全模块服务器地址。
account	int	lotus读卡器必填	用户账号。
password	string	lotus读卡器必填	调度服务器登录密码。
postcode	long	lotus读卡器必填	邮政编码。
network	int	lotus读卡器必填	网络类型。 ●0 : 未知。 ●1 : 电信。 ●2 : 联通。 ●3 : 移动。 ●4 : 其它。
timeout	long	lotus读卡器必填	接收超时时间，单位秒。
mainserveraddr	string	中软高科读卡器必填	主服务器地址。
mainserverport	int	中软高科读卡器必填	主服务器端口号。
subserveraddr	string	中软高科读卡器必填	子服务器地址。
subserverport	int	中软高科读卡器必填	子服务器端口号。
companyid	string	中软高科读卡器必填	公司标识。

电子读卡器栏位说明

中华人民共和国身份证信息		说明
certtype	证件类别	默认为" "
dn	dn码	-
uuid	uuid	-
issue	签发机关	-
name	名字	-
sex	性别	-
nation	民族	-
birthday	生日	华视读卡器返回 calendar 格式，如："wed jan 16 00:00:00 gmt 08:00 1996"。其它读卡器返回 yymmdd 格式，如："19960116"。
addr	地址	-
idcard	身份证号	-
startdate	有效期开始日期	华视读卡器返回 yy.mm.dd 格式，如："1996.01.06"。其它读卡器返回 yymmdd 格式，如："19960116"。
enddate	有效期结束日期	华视读卡器返回 yy.mm.dd 格式，如："1996.01.06"。其它读卡器返回 yymmdd 格式，如："19960116"。
newaddr	最新地址	-
fpdata	指纹数据	原始指纹数据的 base64 编码字符串。
wltdata	照片数据	原始未解码照片数据的 base64 编码字符串。
photo	照片数据	解码后的png格式照片符合data uri scheme格式以"data:image/png;base64,"开头

中华人民共和国港澳台居住证信息		说明
certtype	证件类别	港澳台居留证："j"
dn	dn码	-
uuid	uuid	-
issue	签发机关	-
issuesnum	签发次数
passcheckid	通行证号码
name	名字
sex	性别
birthday	生日
addr	地址
idcard	身份证号
startdate	有效期开始日期
enddate	有效期结束日期
fpdata	指纹数据
wltdata	照片数据
photo	照片数据	解码后的png格式照片符合data uri scheme格式以"data:image/png;base64,"开头

中华人民共和国外国人永久居留证信息（2017版）		说明
certtype	证件类别	"i"
dn	dn码	-
uuid	uuid	-
issue	签发机关	-
englishname	英文名字	-
chinesename	中文名字	-
sex	性别	-
nationcode	国籍	-
birthday	生日	-
idcard	永久居留证号	-
startdate	有效期开始日期	-
enddate	有效期结束日期	-
certver	证件版本号，4字节	-
fpdata	指纹数据（空）	-
wltdata	照片数据	-
photo	照片数据	解码后的png格式照片符合data uri scheme格式以"data:image/png;base64,"开头

中华人民共和国外国人永久居留证信息（新版）		说明
certtype	证件类别	"y"
dn	dn码	-
uuid	uuid	-
renewalnumber	签发次数	-
englishname	英文名字	-
englishnameadd	英文附加名字	-
chinesename	中文名字	-
sex	性别	-
nationcode	国籍	-
birthday	生日	-
idcard	永久居留证号	-
historicalnumber	既往版本外国人永久居留证件号码	-
startdate	有效期开始日期	-
enddate	有效期结束日期	-
fpdata	指纹数据（空）	-
wltdata	照片数据	-
photo	照片数据	解码后的png格式照片符合data uri scheme格式以"data:image/png;base64,"开头

相关问题