小程序API能力集成指南——群组信息和属性API汇总

群组信息 API

getGroupDpsInfos

获取群组设备所有 DP 信息。

请求参数

参数	数据类型	说明	是否必填
groupId	String	群组 ID	是

返回参数

参数	数据类型	说明
code	String	DP Code
dpId	Number	DP ID
value	String	DP 值
name	String	DP 名称
time	Number	DP 最近上报时间
type	String	DP 类型

请求示例

import { getGroupDpsInfos } from '@ray-js/ray';
 
getGroupDpsInfos('1')
  .then((response) => {
    console.log(response);
  })
  .catch();

返回示例

{
    {
      "code": "switch_spray",
      "dpId": 1,
      "value": "true",
      "name": "",
      "time": 1572338762533,
      "type": "bool"
    },
    {
      "code": "mode",
      "dpId": 2,
      "value": "large",
      "name": "",
      "time": 1572333409976,
      "type": "enum"
    },
}

👉 立即开发。 

 

ty.device.getGroupDeviceList

获取群组下设备列表

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

参数

Object object

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

object.success 回调参数

参数

Object res

属性	类型	说明
groupId	string	groupId 群组 id
deviceList	array	deviceList 设备列表

object.fail 回调参数

参数

Object res

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

 

ty.device.getGroupDeviceNum

获取群组下设备数量

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

参数

Object object

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

object.success 回调参数

参数

Object res

属性	类型	说明
groupId	string	groupId 群组 id
devieNum	number	devieNum 设备数量

object.fail 回调参数

参数

Object res

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

 

ty.device.onGroupInfoChange

群组内增加/移除设备事件

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

参数

function callback

群组内增加/移除设备事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
groupId	string		是	groupId 群组 id

 

ty.device.offGroupInfoChange

取消监听：群组内增加/移除设备事件

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

参数

function callback

取消监听：群组内增加/移除设备事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
groupId	string		是	groupId 群组 id

 

ty.device.onGroupRemovedEvent

群组移除事件

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

参数

function callback

群组移除事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
groupId	string		是	群组 id

 

ty.device.offGroupRemovedEvent

取消监听：群组移除事件

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

参数

function callback

取消监听：群组移除事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
groupId	string		是	群组 id

 

群组属性 API

ty.device.setGroupProperty

设置群组的属性

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

参数

Object object

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

 

ty.device.getGroupProperty

获取群组的属性

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

参数

Object object

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

object.success 回调参数

参数

Object res

属性	类型	说明
result	any	群组属性信息

object.fail 回调参数

参数

Object res

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

👉 立即开发。