智能小程序 Ray 开发遥控器群组 API 合集

获取 Zigbee 遥控器群组 localId 列表功能

getZigbeeLocalGroupRelation

引入

@ray-js/ray^1.5.2 以上版本可使用

import { getZigbeeLocalGroupRelation } from '@ray-js/ray'

参数

IGetZigbeeLocalGroupRelation

属性	类型	必填	说明
devId	string	是	遥控器设备 Id

返回

IGetZigbeeLocalGroupRelationResponse

本 API 返回一个对象，包含一个名为 locals 的数组，每个元素包含以下属性：

属性	类型	说明
code	string	功能点 code
order	number	排序
localId	string	设备端用到的群组 localId
categoryCode	string	面板使用的 code，用来做映射，值以 300 为前缀, 例如 3001

函数定义示例

/**
 * 获取 Zigbee 遥控器群组 localId 列表
 */
export function getZigbeeLocalGroupRelation(params: IGetZigbeeLocalGroupRelation): Promise<IGetZigbeeLocalGroupRelationResponse>

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

获取可以加入 Zigbee 遥控器群组的设备列表功能

getZigbeeLocalGroupDeviceList

引入

@ray-js/ray^1.5.2 以上版本可使用

import { getZigbeeLocalGroupDeviceList } from '@ray-js/ray'

参数

IGetZigbeeLocalGroupDeviceList

属性	类型	必填	说明
devId	string	是	遥控器的设备 ID
meshId	string	是	遥控器的网关 id
categoryCode	string	是	分组 Code，遥控器可支持多个群组，与 localId 匹配范围为 7001-7008；localId 为云端分配，步长为 8，因此一个遥控器内部最多支持关联 8 个群组，localId 为初始值依次+1，与之匹配的 categoryCode 从 7001 依次 +1。可以通过 getZigbeeLocalGroupRelation 获取
homeId	string	是	家庭 id，可以通过 getCurrentHomeInfo 获取

返回

IGetZigbeeLocalGroupDeviceListResponse

本 API 返回一个数组，每个元素包含以下属性：

属性	类型	说明
productId	string	设备产品 id
devId	string	设备 id
devOnline	boolean	设备在线状态
devName	string	设备名称
iconUrl	string	设备背景图片
checked	boolean	是否选中
nodeId	string	如果是子设备，会返回子设备对应的 nodeId
gwId	string	网关 id
gwName	string	网关名称
gwOnline	boolean	网关是否在线

函数定义示例

/**
 * 获取可以加入 Zigbee 遥控器群组的设备列表
 */
 export function getZigbeeLocalGroupDeviceList(params: IGetZigbeeLocalGroupDeviceList): Promise<IGetZigbeeLocalGroupDeviceListResponse>

跳转 Zigbee 遥控器群组配对页面

openZigbeeLocalGroup

引入

@ray-js/ray^1.5.2 以上版本可使用

import { openZigbeeLocalGroup } from '@ray-js/ray'

参数

OpenZigbeeLocalGroupParams

属性	类型	必填	说明
deviceId	string	是	设备 Id
localId	string	是	群组本地标识，通过 getZigbeeLocalGroupRelation 获取
categoryCode	string	是	非二级品类，与 localId 匹配范围为 7001-7008，通过 getZigbeeLocalGroupRelation 获取
codes	string	是	二级品类 code，用于进行设备列表筛选过滤

返回

无

函数定义示例

/**
 * 跳转 Zigbee 遥控器群组配对页面
 */
export function openZigbeeLocalGroup(params?: OpenZigbeeLocalGroupParams): Promise<void>

注意事项

• 当前仅针对 Zigbee 的部分品类开通了此类能力，如果不清楚对应的二级品类 code，可以通过 小程序论坛 联系智能小程序团队寻求帮助

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