---
name: "startBLEScanBindDevice"
mode: "kit"
versionRequirements:
  - { name: "DeviceKit", version: "2.1.6" }
  - { name: "@ray-js/ray", version: "0.6.23" }
platform:
  - "iOS"
  - "Android"
async: true
---

## startBLEScanBindDevice

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

> [PLATFORM] iOS, Android

> ⚡ **Supports Promise** — Returns a Promise when success / fail / complete callbacks are omitted.

### Description

Scan for provisioned devices within the specified time; results are obtained via the 【onBLEScanBindDevice】 event

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `interval` | `number` | Yes | - | `2.1.6` | Scan interval. If < 0, return an error |
| `scanType` | `string` | Yes | - | `2.1.6` | Deprecated: Scan does not distinguish type Scan types SINGLE -> "SINGLE" SINGLE_QR -> "SINGLE_QR" MESH -> "MESH" SIG_MESH -> "SIG_MESH" NORMAL -> "NORMAL" Thing_BEACON -> "Thing_BEACON" |
| `complete` | `() => void` | No | - | - | Completion callback (executed on both success and failure) |
| `success` | `() => void` | No | - | - | Callback on successful API call |
| `fail` | `(params: Object) => void` ↓see below | No | - | - | Failure callback |

#### fail callback parameters

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

##### fail(params).innerError properties

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


### Examples

#### Basic usage

```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);
  },
});
```