智能小程序 Ray 开发群组API —— 群组控制 API 合集

updateGroupDpName

更新群组设备 DP 名称。

请求参数

参数	数据类型	说明	是否必填
groupId	String	群组 ID	是
dpId	String	DP ID	是
name	String	DP 自定义名	是

返回参数

参数	数据类型	说明
response	Boolean	是否成功更新群组设备 DP 名称

请求示例

import { updateGroupDpName } from '@ray-js/ray';
 
updateGroupDpName({
  groupId: '1',
  dpId: '20',
  name: 'switch_led',
})
  .then((response) => {
    console.log(response);
  })
  .catch();

返回示例

true;

 

publishGroupDps

群组控制

引入

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

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

参数

Object object

属性	类型	默认值	必填	说明
groupId	string		是	groupId 群组 id
dps	object		是	dp 信息 示例: dps: {"1" : true}
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

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

publishGroupDpCodes

通过 dpCode 下发控制指令

引入

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

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

参数

Object object

属性	类型	默认值	必填	说明
groupId	string		是	groupId 群组 id
dpCodes	any		是	dp 信息 示例: dpCodes: {"switch" : true}
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

 

registerGroupChange

开启对群组事件的监听

引入

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

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

参数

Object object

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

 

unRegisterGroupChange

关闭对群组事件的监听

引入

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

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

参数

Object object

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

 

onGroupDpDataChangeEvent

群组 DP 变更事件

引入

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

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

参数

function callback

群组 DP 变更事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
groupId	string		是	groupId 群组 id
dps	object		是	dp 信息 示例: dps: {"1" : true}

 

offGroupDpDataChangeEvent

取消监听：群组 DP 变更事件

引入

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

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

参数

function callback

取消监听：群组 DP 变更事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
groupId	string		是	groupId 群组 id
dps	object		是	dp 信息 示例: dps: {"1" : true}

 

onGroupDpCodeChange

群组 dpCode 变化事件

引入

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

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

参数

function callback

群组 dpCode 变化事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
groupId	string		是	groupId 群组 id
dpCodes	any		是	dp 信息 示例: dpCodes: {"switch" : true}

 

offGroupDpCodeChange

取消监听：群组 dpCode 变化事件

引入

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

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

参数

function callback

取消监听：群组 dpCode 变化事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
groupId	string		是	groupId 群组 id
dpCodes	any		是	dp 信息 示例: dpCodes: {"switch" : true}

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