更新时间:2023-05-18 16:09:53收藏订阅更新我的文档设置返回文档k3 智能键盘概览在蜻蜓独立使用的场景下,为了提升商家的使用体验,支付宝推出了具有独立芯片、4 寸显示屏的 k3 智能键盘。k3 智能键盘基础功能键盘基础功能产品介绍即插即用,无需额外对接,可实现如下功能:接入准备●硬件环境:○蜻蜓 f6 主机。○k3 智能键盘。●软件环境:○小程序容器 xpaas 版本:10.1.80.92 及以上。○外设管理 iotconnect 版本:1.1.2.5 及以上。接入指南接入流程概览接入重点说明●小程序接入需要通过 完成分发后触达到设备端。●智能键盘即插即用。●兼容原(蓝牙、有线)键盘的事件处理逻辑。api 调用说明my.ix.onkeyeventchange开启按键事件监听示例代码入参属性类型必填描述listenerfunction是按键事件产生时被回调的方法。回调参数属性类型描述keycodenumber模拟键盘按键的代码值,keycode 参数的值是字符输入设备(原蓝牙键盘、扫码枪对应的键值不变),详细代码值如下 keycode 参数代码表 所示。amountstringamount 只会在 keycode = 131 时存在,蜻蜓 f6 新键盘最多支持 5 位,金额小于 5 万元。智能键盘基础 keycode 参数代码表(原蓝牙、有线键盘参数代码表可对照 keycode 参数代码表):keycode键盘路径描述键盘模拟66确认enter131金额 确认f1 金额 enter133取消f3134菜单 > 客屏设置f4基础能力 keycode 响应数据样例说明:●{"action":0,"keycode":131,"amount":0.01}●{"action":0,"keycode":133}my.ix.offkeyeventchange关闭按键事件监听示例代码关闭按键事件监听的 api 在代码中只能直接调用,不可以有任何参数。注意:监听按键事件的注意事项可查看 监听按键事件 api 调用说明。k3 智能键盘扩展功能键盘扩展功能产品介绍支持 iot 小程序通过 jsapi 接入,在基础功能之外,新增如下功能:接入准备●硬件环境:○蜻蜓 f6 主机。○k3 智能键盘。●软件环境:○小程序容器 xpaas 版本:10.1.80.92 及以上。○外设管理 iotconnect 版本:1.1.2.5 及以上。接入指南接入流程概览接入重点说明●智能键盘扩展功能同样通过监听 keyeventchange 获取响应事件。●需要接入方通过接口注册相应的扩展功能后生效。●需要接入方独立实现。●需要接入方按照指定数据结构定义完成传入。●当智能键盘上提示 服务不可用 时,请联系支付宝凯发app官方网站的技术支持。api 调用说明my.ix.registerkeyboardservice键盘扩展功能注册小程序容器提供针对 k3 智能键盘的特定按键的功能注册接口。●iot 小程序需要根据自身的开发和实现进度,来注册已实现的键盘功能。●对未实现的键盘扩展功能,键盘侧会展示该功能暂未实现的提示信息。k3 智能键盘扩展功能包括键盘功能scopescope value服务能力说明账单列表billlistbool,默认为 false。小程序支持交易账单列表同步键盘显示。交易详情billdetailbool,默认为 false。小程序支持交易详情数据查询同步键盘显示。交易汇总billsumbool,默认为 false。小程序支持交易汇总统计数据输出。扫码支付状态scancodepaystatusbool,默认为 false。小程序支持扫码支付状态同步键盘显示。●支付状态键盘功能的特别说明:○iot 小程序在接入了 刷脸支付 的支付流程中,支付状态会自动关联展示到智能键盘,形成业务闭环。○iot 小程序的 扫码支付 流程中,需要完成支付状态的服务能力对接,来实现扫码支付状态同步到键盘展示,如下所示。示例代码入参属性类型描述servicesobject注册 已实现 的键盘服务能力。my.ix.onkeyeventchange开启按键事件监听示例代码入参属性类型必填描述listenerfunction是按键事件产生时被回调的方法。键盘响应数据●智能键盘扩展功能 keycode 参数代码表:keycode键盘路径描述参数参数说明300账单date日期(yyyy-mm-dd hh:mm:ss)。菜单 > 交易查询 > 今日交易明细pageno当前显示分页的 index。pagesize每个分页缓冲的数据条数(键盘默认缓冲 8 条数据)。301菜单 > 交易查询 > 今日交易明细 > 交易详情date日期(yyyy-mm-dd hh:mm:ss)。orderid账单 id(支付宝交易单号)。ordertype账单类型。●1:收款。●2:退款。302菜单 > 交易查询 > 今日交易汇总date日期(yyyy-mm-dd hh:mm:ss)●扩展功能 keycode 响应携带参数样例说明:○{"action":0,"keycode":300,"data":{"date":"2021-06-29 17:13:23","pageno":1,"pagesize":8}}○{"action":0,"keycode":301,"data":{"date":"2021-06-29 17:13:23","orderid":"2021062922001435541421417925","ordertype":1}}○{"action":0,"keycode":302,"data":{"date":"2021-06-29 17:13:23"}}●账单列表数据查询规则要求:○小程序账单查询请求,需要按照分页索引(pageno)和缓冲数据条数(pagesize)来进行查询。○由于键盘存储空间及显示区域有限,不支持一次性大批量的数据同步到键盘显示。my.ix.sendmessagetokeyboard发送数据至键盘●小程序容器 提供针对智能键盘特定功能的数据同步接口。●主要覆盖功能范围,查看 registerkeyboardservice 注册接口中,服务注册 scope 表。示例代码入参属性类型描述keytypestring'k3' 固定字段。actionstring匹配 registerkeyboardservice 中的 scope 声明字段。valueobject展示在智能键盘上的数据内容。扫码支付状态(scancodepaystatus) value 属性对应的状态值:scope状态值描述scancodepaystatuspay_searching发起收款,等待交易结果。pay_close关闭键盘当前显示页面,回到待机页。 说明:当唤起收银台,但没有实际发起交易流程时结束本次流程,需要设置该状态值给到键盘。show_result_success支付成功。show_result_error支付失败。show_result_cancel支付取消。show_result_default支付结果未知。数据结构样例:账单事件(billlist)value 属性对应的 json 结构:scope父节点字段类型子节点字段描述billlistbilllistjsonarrayamount实收金额 或者 实退金额。orderid订单号(支付宝交易单号或服务商订单号)。biztime订单时间。biztype交易类型。●1:收款。●2:退款。totalcountnumber-账单总量。数据结构样例:交易账单详情事件(billdetail) value 属性对应的 json 结构:scopejson 字段描述billdetailorderid订单号。discamount商家优惠金额 或者 商家退款金额(匹配账单列表中的交易类型)。orderamount订单金额 或者 订单退款金额。数据结构样例:交易汇总事件(billsum) value 属性对应的 json 结构:scopejson 字段描述billsumreceivecount总交易收款笔数。receiveamount总交易收款金额。refundcount总交易退款笔数。refundamount总交易退款金额。数据结构样例: