---
name: "openDeviceGWSubHelpList"
mode: "api"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.7.60" }
title: "openDeviceGWSubHelpList - Open Sub-device Help List"
---

## openDeviceGWSubHelpList

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

### Description

Open the gateway panel’s pairing help list page for sub-devices

### Parameters

`Params`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `params` | `GwIdParams` | No | Gateway parameters |

### Return Value

Type: `Promise<void>`

void

### Referenced Types

##### `type` GwIdParams

| Property | Type | Description |
| --- | --- | --- |
| `gwId` | `string` | Gateway ID |

##### `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

```typescript
import { openDeviceGWSubHelpList } from '@ray-js/ray';

const openHelpList = async () => {
  try {
    await openDeviceGWSubHelpList({ gwId: 'gateway_001' });
    console.log('Opened the pairing help list');
  } catch (err) {
    console.error('Open failed:', err);
  }
};
```


## Notes

- IDE simulator and real device debugging environments are currently not supported