---
name: "connectDevice"
mode: "api"
versionRequirements:
  - { name: "@ray-js/lock-sdk", version: "1.0.0" }
title: "connectDevice - 主动连接设备。"
summary: "支持无线唤醒时先唤醒，支持蓝牙控制时尝试连接蓝牙；返回是否连接成功。"
---

## connectDevice

> [VERSION] @ray-js/lock-sdk >= 1.0.0

### 描述

发起近场/局域网连接设备流程。

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `options` | `ConnectDeviceOptions` | 否 | 连接选项（timeout 连接超时（毫秒），默认 15000） |

### 返回值

类型: `Promise<true>`

连接结果（由实现定义）

### 引用对象

##### `interface` ConnectDeviceOptions

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `timeout` | `number` | 连接超时时间（毫秒），默认 15000；配件业务场景通常传 10000 |


### 示例代码

```ts
import { connectDevice } from '@ray-js/lock-sdk';
await connectDevice();
// 自定义超时
await connectDevice({ timeout: 10000 });
```