---
name: "startBLEScanBindDevice"
mode: "kit"
versionRequirements:
  - { name: "DeviceKit", version: "2.1.6" }
  - { name: "@ray-js/ray", version: "0.6.23" }
platform:
  - "iOS"
  - "Android"
async: true
title: "startBLEScanBindDevice - 在指定时间内扫描已配网的设备，扫描结果通过【onBLEScanBindDevice】事件获取"
---

## startBLEScanBindDevice

> [VERSION] DeviceKit >= 2.1.6 | @ray-js/ray >= 0.6.23

> [PLATFORM] iOS, Android

> ⚡ **支持 Promise 调用** — 不传 success / fail / complete 回调时，该方法返回 Promise。

### 描述

在指定时间内扫描已配网的设备，扫描结果通过【onBLEScanBindDevice】事件获取

### 参数

| 属性 | 类型 | 必填 | 默认值 | 最低版本 | 描述 |
| --- | --- | --- | --- | --- | --- |
| `interval` | `number` | 是 | - | `2.1.6` | 间隔扫描时间。如果<0，则返回错误 |
| `scanType` | `string` | 是 | - | `2.1.6` | 【废弃】扫描不区分type 扫描类型 SINGLE -> "SINGLE" SINGLE_QR -> "SINGLE_QR" MESH -> "MESH" SIG_MESH -> "SIG_MESH" NORMAL -> "NORMAL" Thing_BEACON -> "Thing_BEACON" |
| `complete` | `() => void` | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `() => void` | 否 | - | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用失败的回调函数 |

#### fail 回调参数

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

##### fail(params).innerError 的属性

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


### 示例代码

#### 基础调用

```tsx
import { device } from '@ray-js/ray'

const { startBLEScanBindDevice } = device;

startBLEScanBindDevice({
  interval: 0,
  scanType: 'example',
  success: () => {
    console.log('startBLEScanBindDevice success');
  },
  fail: (error) => {
    console.log('startBLEScanBindDevice fail', error.errorMsg);
  },
});
```