开发者社区
社区提问意见反馈
开发者钉组织
扫描二维码
加入支付宝开发者钉组织
开发 > 开放能力接入 > 其它 > 更多使用指南 > 小程序接入指南 > 设备开发 > 蜻蜓系列 > 蜻蜓 f6 - k3 智能键盘接入指引
收藏
订阅更新
我的文档
设置
k3 智能键盘概览
在蜻蜓独立使用的场景下,为了提升商家的使用体验,支付宝推出了具有独立芯片、4 寸显示屏的 k3 智能键盘。
1.jpeg

k3 智能键盘基础功能
键盘基础功能产品介绍
即插即用,无需额外对接,可实现如下功能:
2.png

接入准备
硬件环境:
蜻蜓 f6 主机。
k3 智能键盘。
软件环境:
小程序容器 xpaas 版本:10.1.80.92 及以上。
外设管理 iotconnect 版本:1.1.2.5 及以上。
接入指南
接入流程概览
3.png

接入重点说明
小程序接入需要通过 完成分发后触达到设备端。
智能键盘即插即用。
兼容原(蓝牙、有线)键盘的事件处理逻辑。
api 调用说明
my.ix.onkeyeventchange
开启按键事件监听
示例代码
入参
属性
类型
必填
描述
listener
function

按键事件产生时被回调的方法。
回调参数
属性
类型
描述
keycode
number
模拟键盘按键的代码值,keycode 参数的值是字符输入设备(原蓝牙键盘、扫码枪对应的键值不变),详细代码值如下 keycode 参数代码表 所示。
amount
string
amount 只会在 keycode = 131 时存在,蜻蜓 f6 新键盘最多支持 5 位,金额小于 5 万元。
智能键盘基础 keycode 参数代码表(原蓝牙、有线键盘参数代码表可对照 keycode 参数代码表):
keycode
键盘路径描述
键盘模拟
66
确认
enter
131
金额 确认
f1 金额 enter
133
取消
f3
134
菜单 > 客屏设置
f4
基础能力 keycode 响应数据样例说明:
{"action":0,"keycode":131,"amount":0.01}
{"action":0,"keycode":133}
my.ix.offkeyeventchange
关闭按键事件监听
示例代码
关闭按键事件监听的 api 在代码中只能直接调用,不可以有任何参数。
注意:监听按键事件的注意事项可查看 监听按键事件 api 调用说明
k3 智能键盘扩展功能
键盘扩展功能产品介绍
支持 iot 小程序通过 jsapi 接入,在基础功能之外,新增如下功能:
4.png

接入准备
硬件环境:
蜻蜓 f6 主机。
k3 智能键盘。
软件环境:
小程序容器 xpaas 版本:10.1.80.92 及以上。
外设管理 iotconnect 版本:1.1.2.5 及以上。
接入指南
接入流程概览
5.png

接入重点说明
智能键盘扩展功能同样通过监听 keyeventchange 获取响应事件。
需要接入方通过接口注册相应的扩展功能后生效。
需要接入方独立实现。
需要接入方按照指定数据结构定义完成传入。
当智能键盘上提示 服务不可用 时,请联系支付宝凯发app官方网站的技术支持。
api 调用说明
my.ix.registerkeyboardservice
键盘扩展功能注册
小程序容器提供针对 k3 智能键盘的特定按键的功能注册接口。
iot 小程序需要根据自身的开发和实现进度,来注册已实现的键盘功能。
对未实现的键盘扩展功能,键盘侧会展示该功能暂未实现的提示信息。
k3 智能键盘扩展功能包括
键盘功能
scope
scope value
服务能力说明
账单列表
billlist
bool,默认为 false。
小程序支持交易账单列表同步键盘显示。
交易详情
billdetail
bool,默认为 false。
小程序支持交易详情数据查询同步键盘显示。
交易汇总
billsum
bool,默认为 false。
小程序支持交易汇总统计数据输出。
扫码支付状态
scancodepaystatus
bool,默认为 false。
小程序支持扫码支付状态同步键盘显示。
支付状态键盘功能的特别说明:
iot 小程序在接入了 刷脸支付 的支付流程中,支付状态会自动关联展示到智能键盘,形成业务闭环。
iot 小程序的 扫码支付 流程中,需要完成支付状态的服务能力对接,来实现扫码支付状态同步到键盘展示,如下所示。
示例代码
入参
属性
类型
描述
services
object
注册 已实现 的键盘服务能力。
my.ix.onkeyeventchange
开启按键事件监听
示例代码
入参
属性
类型
必填
描述
listener
function

按键事件产生时被回调的方法。
键盘响应数据
智能键盘扩展功能 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 表。
示例代码
入参
属性
类型
描述
keytype
string
'k3' 固定字段。
action
string
匹配 registerkeyboardservice 中的 scope 声明字段。
value
object
展示在智能键盘上的数据内容。
扫码支付状态(scancodepaystatus) value 属性对应的状态值:
scope
状态值
描述
scancodepaystatus
pay_searching
发起收款,等待交易结果。
pay_close
关闭键盘当前显示页面,回到待机页。 说明:当唤起收银台,但没有实际发起交易流程时结束本次流程,需要设置该状态值给到键盘。
show_result_success
支付成功。
show_result_error
支付失败。
show_result_cancel
支付取消。
show_result_default
支付结果未知。
数据结构样例:
账单事件(billlist)value 属性对应的 json 结构:
scope
父节点字段
类型
子节点字段
描述
billlist
billlist
jsonarray
amount
实收金额 或者 实退金额
orderid
订单号(支付宝交易单号或服务商订单号)。
biztime
订单时间。
biztype
交易类型。
1:收款。
2:退款。
totalcount
number
-
账单总量。
数据结构样例:
交易账单详情事件(billdetail) value 属性对应的 json 结构:
scope
json 字段
描述
billdetail
orderid
订单号。
discamount
商家优惠金额 或者 商家退款金额(匹配账单列表中的交易类型)。
orderamount
订单金额 或者 订单退款金额
数据结构样例:
交易汇总事件(billsum) value 属性对应的 json 结构:
scope
json 字段
描述
billsum
receivecount
总交易收款笔数。
receiveamount
总交易收款金额。
refundcount
总交易退款笔数。
refundamount
总交易退款金额。
数据结构样例:
内容没有解决您的问题?您还可以前往 或 寻求帮助
凯发k8官方网娱乐官方 copyright © 支付宝(杭州)信息技术有限公司  | icp证浙b2-20160559
该文档对你是否有帮助?
当前页面目录
网站地图