---
name: "getZigbeeLocalGroupDeviceList"
mode: "api"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.5.2" }
title: "getZigbeeLocalGroupDeviceList - Get Device List Available to Join Zigbee Remote Group"
---

## getZigbeeLocalGroupDeviceList

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

### Description

Get the list of devices that can join Zigbee remote control groups

### Parameters

`Params`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `params` | `IGetZigbeeLocalGroupDeviceList` | Yes | Request parameters |

### Return Value

Type: `Promise<IZigbeeLocalGroupDevice[]>`

Device list array; each element contains device information such as productId, devId, devOnline, and devName

##### IZigbeeLocalGroupDevice

| Property | Type | Description |
| --- | --- | --- |
| `productId` | `string` | Device product ID |
| `devId` | `string` | Device ID |
| `devOnline` | `boolean` | Device online status |
| `devName` | `string` | Device name |
| `iconUrl` | `string` | Device background image |
| `checked` | `boolean` | Whether selected |
| `nodeId` | `string` | If it is a sub-device, returns the sub-device’s corresponding nodeId |
| `gwId` | `string` | Gateway ID |
| `gwName` | `string` | Gateway name |
| `gwOnline` | `boolean` | Whether the gateway is online |

### Referenced Types

##### `interface` IGetZigbeeLocalGroupDeviceList

| Property | Type | Description |
| --- | --- | --- |
| `devId` | `string` | Device ID of the remote control |
| `meshId` | `string` | Gateway id of the remote control |
| `categoryCode` | `string` | Group code. A remote can support multiple groups; the matching range with localId is 7001–7008. localId is allocated by the cloud in blocks of 8, so a single remote can be associated with up to 8 groups. Starting from the initial localId, increment by 1; the corresponding categoryCode starts at 7001 and increments by 1. You can obtain it via getZigbeeLocalGroupRelation. |
| `homeId` | `string` | Home ID, obtainable via getCurrentHomeInfo. |


### Examples

#### Basic usage

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

getZigbeeLocalGroupDeviceList({
  devId: 'your_device_id',
  meshId: 'gateway_mesh_id',
  categoryCode: '7001',
  homeId: 'your_home_id',
}).then((response) => {
  console.log('Device list:', response);
}).catch((err) => {
  console.error(err);
});
```