---
name: "openZigbeeLocalGroup"
mode: "kit"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.5.2" }
title: "openZigbeeLocalGroup - Navigate to Zigbee Remote Group Pairing Page"
---

## openZigbeeLocalGroup

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

> 💡 Currently, this capability is enabled only for certain Zigbee categories

### Description

Navigate to the Zigbee remote controller group pairing page

### Parameters

`Params`

| Parameter | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `params` | `OpenZigbeeLocalGroupParams` | No | - | Request parameters |

### Referenced Types

##### `type` OpenZigbeeLocalGroupParams

| Property | Type | Description |
| --- | --- | --- |
| `deviceId` | `string` | Device ID |
| `localId` | `string` | localId Local group identifier |
| `categoryCode` | `string` | categoryCode is not a third-level category; it matches localId in the range 7001–7008. localId is assigned by the cloud with a step of 8, so a single remote can be linked with up to 8 groups. localId increments by 1 from the initial value, and the matching categoryCode increments from 7001 by 1 accordingly. |
| `codes` | `string` | Second-level category code, used to filter the device list |

##### `type` ICommon

| Property | Type | Description |
| --- | --- | --- |
| `success` | `() => void` | Callback on successful API call |
| `fail` | `(err: ErrorMsg) => void` | Failure callback |
| `complete` | `() => void` | Completion callback (executed on both success and failure) |

##### `type` ErrorMsg

| Property | Type | Description |
| --- | --- | --- |
| `errorMsg` | `string` | Error message |
| `errorCode` | `string \| number` | Error code |
| `innerError` | `Object` | Error extension |

##### `type` ErrorMsg.innerError

| Property | Type | Description |
| --- | --- | --- |
| `errorCode` | `string \| number` | Error extension code |
| `errorMsg` | `string` | Error extension message |


### Examples

#### Basic usage

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

openZigbeeLocalGroup({
  deviceId: 'your_device_id',
  localId: '1234',
  categoryCode: '7001',
  codes: 'dj',
}).then(() => {
  console.log('Navigated to group pairing page');
}).catch((err) => {
  console.error(err);
});
```