iot 小程序 api 概述 -凯发app官方网站

文档中心

iot

android 开发文档

windows 开发文档

linux 开发文档

iot 小程序开发文档

其它

iot 开放平台 spi 流程概览

复杂类型管理

api

收银台

刷脸核身

刷脸登录

会员与授权

发送付款码

发送和接收小指令

版本查询

获取系统属性

系统设置页面

二维码识别

生成二维码

ui 控制

语音播报

本地数据库

本地图片存储

串口通信

外设管理

打印指令

监听按键事件

身份证读卡器适配

电子秤

钱箱

非接卡通信

ic 卡通信

红外测温仪

消息服务

日志服务

前后屏通信

更多使用指南

开发 > 开放能力接入 > 其它 > > iot 小程序 api 概述

更新时间：2022-11-15 16:39:59

收藏

订阅更新

我的文档

设置

简介

本文主要归纳了 iot 小程序特有的 api，对于支付宝小程序或其他端的应用不适用，对于 iot 产品均适用。

说明

：

●

支付宝客户端 10.1.60 及以上版本支持 iot 小程序 api 使用。

●

iot 小程序调用支付宝小程序通用

/

时相关限制和使用与支付宝小程序基本一致。

○

iot 小程序对于通用

组件

/

api

目前有以下限制：

■

登录态的组件和 api 不支持。

■

支付宝特有 api（如 my.ap.xxx）不支持。

○

iot 小程序支持最新的

自定义组件

方法。

收银台

名称	功能说明
my.ix.startapp（刷脸支付/扫码支付）	启动 iot 应用，在这个 api 的基础上可以扩展为打开系统设置页面 api 和收银台 api。
my.ix.oncashiereventreceive	开启收银台事件监听。用于监听收银台是否被关闭，继续后续流程。
my.ix.offcashiereventreceive	关闭收银台事件监听的 api。
	对收银台常见问题的解答。

刷脸核身

名称	功能说明
	启用刷脸核身。
	对刷脸核身常见问题的解答。

刷脸登录

名称	功能说明
	刷脸登录。
	退出登录。

会员与授权

名称	功能说明
	获取会员基础信息。
	接入商家会员卡。

发送付款码

名称	功能说明
my.ix.writehid	发送付款码。

发送和接收小指令

名称	功能说明
	发送小指令。
	接收小指令。

版本查询

名称	功能说明
	查询小程序容器或相关依赖模块版本。
my.ix.getversionsync	同步查询小程序容器版本。

获取系统属性

名称	功能说明
	查询系统属性。
	同步查询系统信息。

系统设置页面

名称	功能说明
my.ix.startapp	可以启动系统模块实现打开系统设置页面。

二维码识别

名称	功能说明
	单次扫码。
	多次连续扫码。

生成二维码

名称	功能说明
	生成二维码。

ui 控制

名称	功能说明
	监听返回键事件。
	控制的是信号按钮是否生效，支持配置隐藏信号按钮或点击失效。

语音播报

名称	功能说明
	语音播报 1.0 api。
	语音播报 2.0 api。

本地数据库

名称	功能说明
	控制数据库增删改查等操作。
	注册推送消息通知。
	取消注册 push 消息通知。
	缓存数据的控制。

本地图片存储

名称	功能说明
	用于在 iot 小程序上将图片存储到 iot 设备的存储空间内并自动使用
	通过存储图片时传入的图片 url，删除单张保存的本地图片。
	用于删除所有保存的图片。

串口通信

名称	功能说明
	用来配置串口。
	用来监听串口输入。
	用来关闭串口监听。
	用来对串口写入数据。

外设管理

名称	功能说明
	获取外部设备信息列表。
	添加外部设备信息。
	删除外部设备信息。
	开始监听外部设备连接状态。
	监听外部设备连接状态。
	停止监听外部设备连接状态。
	iot 设备的外设支持列表。

打印指令

名称	功能说明
	介绍 iot 设备支持的打印机。
	打印小票。
	查询打印机状态。
	查询连接的打印机。
	监听打印机与主机设备连接状态。
	iot 小程序向打印机发出的打印指令，通过这些指令指示打印机打印小票。
	iot 小程序向标签打印机发出的打印指令，通过这些指令指示打印机打印标签。

监听事件

名称	功能说明
	监听按键事件。
	扫码枪的功能是扫描并识别一维码或二维码，将一维码或二维码转换成相应的字串发送给收银设备。

身份证读卡器适配

名称	功能说明
	放置身份证至读卡器上读取信息。
	读卡器通信接口，用于设置读卡器参数，读写卡等操作。
	监听读卡器与主机设备连接状态的 api。

电子秤

名称	功能说明
	配置电子秤。
	监听电子秤数据。
	关闭电子秤数据监听。
	实现写数据到串口。
	将电子秤置零。
	可以设置电子秤皮重。
	获取电子秤皮重。
	电子秤通信接口。
	介绍 iot 设备当前支持的电子秤型号、错误码等。

钱箱

名称	功能说明
	打开钱箱。
	关闭钱箱。

非接卡通信

名称	功能说明
	nfc 非接卡（iso14443/iso15693）通信接口，用于 nfc 卡(会员卡等）的读取卡号、读卡、写卡，电子钱包充值、增值、减值等操作。

ic 卡通信

名称	功能说明
	ic卡通信接口，用于ic卡的读卡、写卡等操作。

红外测温仪

名称	功能说明
	红外测温仪通信接口，用于红外测温仪的读取信息、设置参数等操作。
	监听红外测温仪与主机设备连接状态的 api。

消息服务

名称	功能说明
	控制消息服务开关。
	消息服务事件通知 api，返回內容为 json 格式。

日志服务

名称	功能说明
	获取小程序日志信息，并上报到阿里云。

前后屏通信

名称	功能说明
	添加后屏应用。
	消息发送。
	消息监听并接收。
	结束消息监听。

上一篇：复杂类型管理

相关问题

小程序api&组件示例

内容没有解决您的问题？您还可以前往或寻求帮助

该文档对你是否有帮助？

当前页面目录