智能小程序 Ray 开发——物模型 API 接口汇总

deviceIsSupportThingModel

设备是否支持物模型

引入

import { deviceIsSupportThingModel } from '@ray-js/ray';

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

参数

Object object

属性	类型	默认值	必填	说明
devId	string		是	设备 id
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

object.success 回调参数

参数

Object res

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

object.fail 回调参数

参数

Object res

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

👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。 

getDeviceThingModelInfo

获取设备物模型信息

引入

import { getDeviceThingModelInfo } from '@ray-js/ray';

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

参数

Object object

属性	类型	默认值	必填	说明
devId	string		是	设备 id
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性	类型	说明
modelId	string	物模型 id
productId	string	产品 id
productVersion	string	产品版本
services	array	服务列表
extensions	any	扩展属性

object.fail 回调参数

参数

Object res

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

offReceivedThingModelMessage

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

引入

import { offReceivedThingModelMessage } from '@ray-js/ray';

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

参数

function callback

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

回调参数 Object res

属性	类型	默认值	必填	说明
type	number		是	类型 0:属性, 1:动作, 2:事件
payload	any		是	payload

onReceivedThingModelMessage

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

引入

import { onReceivedThingModelMessage } from '@ray-js/ray';

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

参数

function callback

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

回调参数 Object res

属性	类型	默认值	必填	说明
type	number		是	类型 0:属性, 1:动作, 2:事件
payload	any		是	payload

publishThingModelMessage

通过物模型投递消息

引入

import { publishThingModelMessage } from '@ray-js/ray';

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

参数

Object object

属性	类型	默认值	必填	说明
devId	string		是	设备 id
type	number		是	类型 0:属性, 1:动作, 2:事件
payload	any		是	payload
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

subscribeReceivedThingModelMessage

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

引入

import { subscribeReceivedThingModelMessage } from '@ray-js/ray';

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

参数

Object object

属性	类型	默认值	必填	说明
devId	string		是	设备 id
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

unSubscribeReceivedThingModelMessage

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

引入

import { unSubscribeReceivedThingModelMessage } from '@ray-js/ray';

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

参数

Object object

属性	类型	默认值	必填	说明
devId	string		是	设备 id
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

updateDeviceThingModelInfo

更新物模型信息

引入

import { updateDeviceThingModelInfo } from '@ray-js/ray';

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

参数

Object object

属性	类型	默认值	必填	说明
pid	string		是	产品 id
productVersion	string		是	产品版本号
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

validDeviceOnlineType

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

引入

import { validDeviceOnlineType } from '@ray-js/ray';

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

参数

Object object

属性	类型	默认值	必填	说明
deviceId	string		是	设备 id
onlineType	number		是	设备在线类型， Wi-Fi online 1 << 0 Local online 1 << 1 Bluetooth LE online 1 << 2 Bluetooth LE mesh online 1 << 3
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

 👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。