---
name: "openZigbeeLocalGroup"
mode: "kit"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.5.2" }
title: "openZigbeeLocalGroup - 跳转 Zigbee 遥控器群组配对页面"
---

## openZigbeeLocalGroup

> [VERSION] @ray-js/ray >= 1.5.2

> 💡 当前仅针对 Zigbee 的部分品类开通了此类能力

### 描述

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

### 参数

`Params`

| 参数 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `params` | `OpenZigbeeLocalGroupParams` | 否 | - | 请求参数 |

### 引用对象

##### `type` OpenZigbeeLocalGroupParams

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `deviceId` | `string` | 设备 ID |
| `localId` | `string` | localId 群组本地标识 |
| `categoryCode` | `string` | categoryCode 并非三级品类，与 localId 匹配范围为 7001-7008； localId 为云端分配，步长为 8，因此一个遥控器内部最多支持关联 8 个群组，localId 为初始值依次+1，与之匹配的 categoryCode 从 7001 依次 +1. |
| `codes` | `string` | 二级品类 code，用于进行设备列表筛选过滤 |

##### `type` ICommon

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `success` | `() => void` | 接口调用成功的回调函数 |
| `fail` | `(err: ErrorMsg) => void` | 接口调用失败的回调函数 |
| `complete` | `() => void` | 接口调用结束的回调函数（调用成功、失败都会执行） |

##### `type` ErrorMsg

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorMsg` | `string` | 错误信息 |
| `errorCode` | `string \| number` | 错误码 |
| `innerError` | `Object` | 错误扩展 |

##### `type` ErrorMsg.innerError

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorCode` | `string \| number` | 错误扩展码 |
| `errorMsg` | `string` | 错误扩展信息 |


### 示例代码

#### 基础用法

```ts
import { openZigbeeLocalGroup } from '@ray-js/ray';

openZigbeeLocalGroup({
  deviceId: 'your_device_id',
  localId: '1234',
  categoryCode: '7001',
  codes: 'dj',
}).then(() => {
  console.log('已跳转群组配对页面');
}).catch((err) => {
  console.error(err);
});
```