小程序API能力集成指南——群组控制和功能页API汇总

群组控制 API

ty.device.publishGroupDps

群组控制

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

参数

Object object

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

ty.device.publishGroupDpCodes

通过 dpCode 下发控制指令

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

参数

Object object

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

 

ty.device.registerGroupChange

开启对群组事件的监听

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

参数

Object object

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

 

ty.device.unRegisterGroupChange

关闭对群组事件的监听

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

参数

Object object

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

 👉 立即开发。 

ty.device.onGroupDpDataChangeEvent

群组 DP 变更事件

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

参数

function callback

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

回调参数 Object res

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

 

ty.device.offGroupDpDataChangeEvent

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

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

参数

function callback

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

回调参数 Object res

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

 

ty.device.onGroupDpCodeChange

群组 dpCode 变化事件

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

参数

function callback

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

回调参数 Object res

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

 

ty.device.offGroupDpCodeChange

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

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

参数

function callback

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

回调参数 Object res

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

 

群组功能页 API

ty.device.openGroupDetailPage

跳转群组详情

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

参数

Object object

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

 

ty.device.openGroupEdit

跳转群组编辑页面

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

参数

Object object

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

 

ty.device.openGroupTimerPage

跳转定时界面

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

参数

Object object

属性	类型	默认值	必填	说明
groupId	string		是	groupId 群组 id
category	string		是	category 定时分类
repeat	number		否	repeat 0 表示需要选择重复，1 表示不需要
data	array		是	data dp 数据 { "dpName": dp 点名称，string "dpId": dp 点 id，string "selected": dp 点默认值的 index，t.Integer "rangeKeys": dp 点的值范围，Array<object> "rangeValues": dp 点的显示数据范围，Array<string> }
timerConfig	TimerConfig		否	timerConfig UI 配置
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

TimerConfig

属性	类型	默认值	必填	说明
background	string		否	background 定时界面导航栏的背景颜色，十六进制，例如：FFFFFF

👉 立即开发。