【小程序开发】OTA API、物模型 API 汇总集合

OTA API

ty.device.checkOTAUpdateInfo

检查固件升级信息

需引入DeviceKit,且在>=1.2.6版本才可使用

参数

Object object

属性类型默认值必填说明
deviceIdstringdeviceId 设备 id
completefunction接口调用结束的回调函数(调用成功、失败都会执行)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数

ty.device.checkOTAUpgradeStatus

获取设备的固件版本状态

需引入DeviceKit,且在>=2.2.0版本才可使用

参数

Object object

属性类型默认值必填说明
deviceIdstringdeviceId 设备 id
completefunction接口调用结束的回调函数(调用成功、失败都会执行)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性类型说明
statusnumberstatus 设备的固件版本状态 0 已是最新版本、1 有待升级的固件、2 正在升级

object.fail 回调参数

参数

Object res

属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {errorMsg: string, errorCode: string }

ty.device.openOTAUpgrade

跳转设备升级页面

需引入DeviceKit,且在>=2.2.0版本才可使用

参数

Object object

属性类型默认值必填说明
deviceIdstringdeviceId 设备 id
completefunction接口调用结束的回调函数(调用成功、失败都会执行)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数

👉 立即开发

物模型 API 

ty.device.deviceIsSupportThingModel

设备是否支持物模型

需引入DeviceKit,且在>=2.1.6版本才可使用

参数

Object object

属性类型默认值必填说明
devIdstring设备 id
completefunction接口调用结束的回调函数(调用成功、失败都会执行)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性类型说明
isSupportboolean是否支持物模型控制

object.fail 回调参数

参数

Object res

属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {errorMsg: string, errorCode: string }

ty.device.getDeviceThingModelInfo

获取设备物模型信息

需引入DeviceKit,且在>=2.1.6版本才可使用

参数

Object object

属性类型默认值必填说明
devIdstring设备 id
completefunction接口调用结束的回调函数(调用成功、失败都会执行)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性类型说明
modelIdstring物模型 id
productIdstring产品 id
productVersionstring产品版本
servicesarray服务列表
extensionsany扩展属性

object.fail 回调参数

参数

Object res

属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {errorMsg: string, errorCode: string }

ty.device.offReceivedThingModelMessage

取消监听:接收物模型消息事件。只有 subscribeReceivedThingModelMessage 订阅了,才会收到该事件。

需引入DeviceKit,且在>=2.1.6版本才可使用

参数

function callback

取消监听:接收物模型消息事件。只有 subscribeReceivedThingModelMessage 订阅了,才会收到该事件。的回调函数

回调参数 Object res

属性类型默认值必填说明
typenumber类型 0:属性, 1:动作, 2:事件
payloadanypayload

ty.device.onReceivedThingModelMessage

接收物模型消息事件。只有 subscribeReceivedThingModelMessage 订阅了,才会收到该事件。

需引入DeviceKit,且在>=2.1.6版本才可使用

参数

function callback

接收物模型消息事件。只有 subscribeReceivedThingModelMessage 订阅了,才会收到该事件。的回调函数

回调参数 Object res

属性类型默认值必填说明
typenumber类型 0:属性, 1:动作, 2:事件
payloadanypayload

ty.device.publishThingModelMessage

通过物模型投递消息

需引入DeviceKit,且在>=2.1.6版本才可使用

参数

Object object

属性类型默认值必填说明
devIdstring设备 id
typenumber类型 0:属性, 1:动作, 2:事件
payloadanypayload
completefunction接口调用结束的回调函数(调用成功、失败都会执行)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数

ty.device.subscribeReceivedThingModelMessage

订阅接受物模型消息。订阅之后才可以接收到 onReceivedThingModelMessage 事件。

需引入DeviceKit,且在>=2.1.6版本才可使用

参数

Object object

属性类型默认值必填说明
devIdstring设备 id
completefunction接口调用结束的回调函数(调用成功、失败都会执行)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数

ty.device.unSubscribeReceivedThingModelMessage

取消订阅接收物模型消息。取消订阅之后接收不到 onReceivedThingModelMessage 事件。

需引入DeviceKit,且在>=2.1.6版本才可使用

参数

Object object

属性类型默认值必填说明
devIdstring设备 id
completefunction接口调用结束的回调函数(调用成功、失败都会执行)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数

ty.device.updateDeviceThingModelInfo

更新物模型信息

需引入DeviceKit,且在>=2.1.6版本才可使用

参数

Object object

属性类型默认值必填说明
pidstring产品 id
productVersionstring产品版本号
completefunction接口调用结束的回调函数(调用成功、失败都会执行)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数

ty.device.validDeviceOnlineType

判断设备上网类型是否与 deviceModel 物模型一致

需引入DeviceKit,且在>=1.2.6版本才可使用

参数

Object object

属性类型默认值必填说明
deviceIdstring设备 id
onlineTypenumber设备在线类型, Wi-Fi online 1 << 0 Local online 1 << 1 Bluetooth LE online 1 << 2 Bluetooth LE mesh online 1 << 3
completefunction接口调用结束的回调函数(调用成功、失败都会执行)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数

 👉 立即开发

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

IoT砖家涂拉拉

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值