@capacitor-community/bluetooth-le

Bluetooth Low Energy

@capacitor-community/bluetooth-le

Capacitor plugin for Bluetooth Low Energy

Maintainers

| Maintainer | GitHub |
| -------------- | ----------------------------------------- |
| Patrick Wespi | pwespi |
| Philip Peitsch | peitschie |

Versions

| Plugin | Capacitor | Documentation |
| ------ | --------- | --------------------------------------------------------------------------------- |
| 8.x | 8.x | README |
| 7.x | 7.x | README |
| 6.x | 6.x | README |
| 3.x | 5.x | README |
| 2.x | 4.x | README |
| 1.x | 3.x | README |
| 0.x | 2.x | README |

Introduction

This is a Capacitor plugin for Bluetooth Low Energy. It supports the web, Android and iOS.

The goal is to support the same features on all platforms. Therefore the Web Bluetooth API is taken as a guidline for what features to implement.

This plugin only supports Bluetooth Low Energy, not Bluetooth serial / classic.

Furthermore the plugin only supports the central role of the Bluetooth Low Energy protocol. If you need the peripheral role, take a look a these plugins:

- https://github.com/randdusing/cordova-plugin-bluetoothle
- https://github.com/don/cordova-plugin-ble-peripheral

For support of Web Bluetooth in various browsers, see implementation status.

Below is an index of all the methods available.

- initialize(...)
- isEnabled()
- requestEnable()
- enable()
- disable()
- startEnabledNotifications(...)
- stopEnabledNotifications()
- isLocationEnabled()
- openLocationSettings()
- openBluetoothSettings()
- openAppSettings()
- setDisplayStrings(...)
- requestDevice(...)
- requestLEScan(...)
- stopLEScan()
- getDevices(...)
- getBondedDevices()
- getConnectedDevices(...)
- connect(...)
- createBond(...)
- isBonded(...)
- disconnect(...)
- getServices(...)
- discoverServices(...)
- getMtu(...)
- requestConnectionPriority(...)
- readRssi(...)
- read(...)
- write(...)
- writeWithoutResponse(...)
- readDescriptor(...)
- writeDescriptor(...)
- startNotifications(...)
- stopNotifications(...)
- Interfaces
- Enums

See Platform Support for an overview of supported methods on Android, iOS and web.

Installation

``
npm install @capacitor-community/bluetooth-le
npx cap sync
`

$3

On iOS, add the NSBluetoothAlwaysUsageDescription to Info.plist, otherwise the app will crash when trying to use Bluetooth (see here).

If the app needs to use Bluetooth while it is in the background, you also have to add bluetooth-central to UIBackgroundModes (for details see here).

./ios/App/App/Info.plist:

`diff




CFBundleDevelopmentRegion
en
...
+ NSBluetoothAlwaysUsageDescription
+ Uses Bluetooth to connect and interact with peripheral BLE devices.
+ UIBackgroundModes
+
+ bluetooth-central
+



`

Note: Bluetooth is not available in the iOS simulator. The initialize call will be rejected with an error "BLE unsupported". You have to test your app on a real device.

$3

On Android, no further steps are required to use the plugin.

#### (Optional) Android 12 Bluetooth permissions

If your app targets Android 12 (API level 31) or higher and your app doesn't use Bluetooth scan results to derive physical location information, you can strongly assert that your app doesn't derive physical location. This allows the app to scan for Bluetooth devices without asking for location permissions. See the Android documentation.

The following steps are required to scan for Bluetooth devices without location permission on Android 12 devices:

- In android/variables.gradle, make sure compileSdkVersion and targetSdkVersion are at least 31 (changing those values can have other consequences on your app, so make sure you know what you're doing).
- In android/app/src/main/AndroidManifest.xml, update the permissions:
`diff

+
+
+ + android:usesPermissionFlags="neverForLocation"
+ tools:targetApi="s" />
`
- Set the androidNeverForLocation flag to true when initializing the BleClient.
`ts
import { BleClient } from '@capacitor-community/bluetooth-le';
await BleClient.initialize({ androidNeverForLocation: true });
`

> _Note_: If you include neverForLocation in your android:usesPermissionFlags, some BLE beacons are filtered from the scan results.

Configuration

You can configure the strings that are displayed in the device selection dialog on iOS and Android when using requestDevice():

./capacitor.config.json:

`JSON
{
"...": "other configuration",
"plugins": {
"BluetoothLe": {
"displayStrings": {
"scanning": "Am Scannen...",
"cancel": "Abbrechen",
"availableDevices": "Verfügbare Geräte",
"noDeviceFound": "Kein Gerät gefunden"
}
}
}
}
`

The default values are:

`JSON
{
"plugins": {
"BluetoothLe": {
"displayStrings": {
"scanning": "Scanning...",
"cancel": "Cancel",
"availableDevices": "Available devices",
"noDeviceFound": "No device found"
}
}
}
}
`

The display strings can also be set at run-time using setDisplayStrings(...).

Usage

There is a plugin wrapper class BleClient which makes events and method arguments easier to work with.

`typescript
// Import the wrapper class
import { BleClient } from '@capacitor-community/bluetooth-le';
`

Note: It is not recommended to use the BluetoothLe plugin class directly.

$3

Here is an example of how to use the plugin. It shows how to read the heart rate from a BLE heart rate monitor such as the Polar H10.

`typescript
import { BleClient, numbersToDataView, numberToUUID } from '@capacitor-community/bluetooth-le';

const HEART_RATE_SERVICE = '0000180d-0000-1000-8000-00805f9b34fb';
const HEART_RATE_MEASUREMENT_CHARACTERISTIC = '00002a37-0000-1000-8000-00805f9b34fb';
const BODY_SENSOR_LOCATION_CHARACTERISTIC = '00002a38-0000-1000-8000-00805f9b34fb';
const BATTERY_SERVICE = numberToUUID(0x180f);
const BATTERY_CHARACTERISTIC = numberToUUID(0x2a19);
const POLAR_PMD_SERVICE = 'fb005c80-02e7-f387-1cad-8acd2d8df0c8';
const POLAR_PMD_CONTROL_POINT = 'fb005c81-02e7-f387-1cad-8acd2d8df0c8';

export async function main(): Promise {
try {
await BleClient.initialize();

const device = await BleClient.requestDevice({
services: [HEART_RATE_SERVICE],
optionalServices: [BATTERY_SERVICE, POLAR_PMD_SERVICE],
});

// connect to device, the onDisconnect callback is optional
await BleClient.connect(device.deviceId, (deviceId) => onDisconnect(deviceId));
console.log('connected to device', device);

const result = await BleClient.read(device.deviceId, HEART_RATE_SERVICE, BODY_SENSOR_LOCATION_CHARACTERISTIC);
console.log('body sensor location', result.getUint8(0));

const battery = await BleClient.read(device.deviceId, BATTERY_SERVICE, BATTERY_CHARACTERISTIC);
console.log('battery level', battery.getUint8(0));

await BleClient.write(device.deviceId, POLAR_PMD_SERVICE, POLAR_PMD_CONTROL_POINT, numbersToDataView([1, 0]));
console.log('written [1, 0] to control point');

await BleClient.startNotifications(
device.deviceId,
HEART_RATE_SERVICE,
HEART_RATE_MEASUREMENT_CHARACTERISTIC,
(value) => {
console.log('current heart rate', parseHeartRate(value));
},
);

// disconnect after 10 sec
setTimeout(async () => {
await BleClient.stopNotifications(device.deviceId, HEART_RATE_SERVICE, HEART_RATE_MEASUREMENT_CHARACTERISTIC);
await BleClient.disconnect(device.deviceId);
console.log('disconnected from device', device);
}, 10000);
} catch (error) {
console.error(error);
}
}

function onDisconnect(deviceId: string): void {
console.log(device ${deviceId} disconnected);
}

function parseHeartRate(value: DataView): number {
const flags = value.getUint8(0);
const rate16Bits = flags & 0x1;
let heartRate: number;
if (rate16Bits > 0) {
heartRate = value.getUint16(1, true);
} else {
heartRate = value.getUint8(1);
}
return heartRate;
}
`

$3

Here is an example of using the scanning API.

`typescript
import { BleClient, numberToUUID } from '@capacitor-community/bluetooth-le';

const HEART_RATE_SERVICE = numberToUUID(0x180d);

export async function scan(): Promise {
try {
await BleClient.initialize();

await BleClient.requestLEScan(
{
services: [HEART_RATE_SERVICE],
},
(result) => {
console.log('received new scan result', result);
},
);

setTimeout(async () => {
await BleClient.stopLEScan();
console.log('stopped scanning');
}, 5000);
} catch (error) {
console.error(error);
}
}
`

Example Applications

- BLE Tester (Ionic/React)
- OpenGoPro (Ionic/Angular)
- Quasar BLE (Quasar/Vue)

Platform Support

_Note_: web support depends on the browser, see implementation status.

| method | Android | iOS | web |
| -------------------------------------------------------------- | :-----: | :-: | :-: |
| initialize() | ✅ | ✅ | ✅ |
| isEnabled() | ✅ | ✅ | -- |
| requestEnable() | ✅ | ❌ | ❌ |
| enable() | ✅ | ❌ | ❌ |
| disable() | ✅ | ❌ | ❌ |
| startEnabledNotifications(...) | ✅ | ✅ | -- |
| stopEnabledNotifications() | ✅ | ✅ | -- |
| isLocationEnabled() | ✅ | ❌ | ❌ |
| openLocationSettings() | ✅ | ❌ | ❌ |
| openBluetoothSettings() | ✅ | ❌ | ❌ |
| openAppSettings() | ✅ | ✅ | ❌ |
| setDisplayStrings(...) | ✅ | ✅ | -- |
| requestDevice(...) | ✅ | ✅ | ✅ |
| requestLEScan(...) | ✅ | ✅ | 🚩 |
| stopLEScan() | ✅ | ✅ | 🚩 |
| getDevices(...) | ✅ | ✅ | 🚩 |
| getBondedDevices(...) | ✅ | ❌ | ❌ |
| getConnectedDevices(...) | ✅ | ✅ | 🚩 |
| connect(...) | ✅ | ✅ | ✅ |
| createBond(...) | ✅ | ❌ | ❌ |
| isBonded(...) | ✅ | ❌ | ❌ |
| disconnect(...) | ✅ | ✅ | ✅ |
| getServices(...) | ✅ | ✅ | ✅ |
| discoverServices(...) | ✅ | ✅ | ❌ |
| getMtu(...) | ✅ | ✅ | ❌ |
| requestConnectionPriority(...) | ✅ | ❌ | ❌ |
| readRssi(...) | ✅ | ✅ | ❌ |
| read(...) | ✅ | ✅ | ✅ |
| write(...) | ✅ | ✅ | ✅ |
| readDescriptor(...) | ✅ | ✅ | ✅ |
| writeDescriptor(...) | ✅ | ✅ | ✅ |
| writeWithoutResponse(...) | ✅ | ✅ | ✅ |
| startNotifications(...) | ✅ | ✅ | ✅ |
| stopNotifications(...) | ✅ | ✅ | ✅ |

#### Legend

- ✅ supported
- ❌ not supported (throws an unavailable error)
- 🚩 behind a flag in Chrome (see implementation status)
- -- not supported, but does not throw an error

API

$3

`typescript
initialize(options?: InitializeOptions | undefined) => Promise
`

Initialize Bluetooth Low Energy (BLE). If it fails, BLE might be unavailable on this device.
On Android it will ask for the location permission. On iOS it will ask for the Bluetooth permission.
For an example, see usage.

| Param | Type |
| ------------- | --------------------------------------------------------------- |
| options | InitializeOptions |

---

$3

`typescript
isEnabled() => Promise
`

Reports whether Bluetooth is enabled on this device.
Always returns true on web.

Returns: Promise<boolean>

---

$3

`typescript
requestEnable() => Promise
`

Request enabling Bluetooth. Show a system activity that allows the user to turn on Bluetooth. See https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#ACTION_REQUEST_ENABLE
Only available on Android.

---

$3

`typescript
enable() => Promise
`

Enable Bluetooth.
Only available on Android.
Deprecated Will fail on Android SDK >= 33. Use requestEnable instead. See https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#enable()

---

$3

`typescript
disable() => Promise
`

Disable Bluetooth.
Only available on Android.
Deprecated Will fail on Android SDK >= 33. See https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#disable()

---

$3

`typescript
startEnabledNotifications(callback: (value: boolean) => void) => Promise
`

Register a callback function that will be invoked when Bluetooth is enabled (true) or disabled (false) on this device.
Not available on web (the callback will never be invoked).

| Param | Type | Description |
| -------------- | ---------------------------------------- | ---------------------------------------------------------- |
| callback | (value: boolean) => void | Callback function to use when the Bluetooth state changes. |

---

$3

`typescript
stopEnabledNotifications() => Promise
`

Stop the enabled notifications registered with startEnabledNotifications.

---

$3

`typescript
isLocationEnabled() => Promise
`

Reports whether Location Services are enabled on this device.
Only available on Android.

Returns: Promise<boolean>

---

$3

`typescript
openLocationSettings() => Promise
`

Open Location settings.
Only available on Android.

---

$3

`typescript
openBluetoothSettings() => Promise
`

Open Bluetooth settings.
Only available on Android.

---

$3

`typescript
openAppSettings() => Promise
`

Open App settings.
Not available on web.
On iOS when a user declines the request to use Bluetooth on the first call of initialize, it is not possible
to request for Bluetooth again from within the app. In this case Bluetooth has to be enabled in the app settings
for the app to be able use it.

---

$3

`typescript
setDisplayStrings(displayStrings: DisplayStrings) => Promise
`

Set the strings that are displayed in the requestDevice dialog.

| Param | Type |
| -------------------- | --------------------------------------------------------- |
| displayStrings | DisplayStrings |

---

$3

`typescript
requestDevice(options?: RequestBleDeviceOptions | undefined) => Promise
`

Request a peripheral BLE device to interact with. This will scan for available devices according to the filters in the options and show a dialog to pick a device.
For an example, see usage.

| Param | Type | Description |
| ------------- | --------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| options | RequestBleDeviceOptions | Device filters, see RequestBleDeviceOptions |

Returns: Promise<BleDevice>

---

$3

`typescript
requestLEScan(options: RequestBleDeviceOptions, callback: (result: ScanResult) => void) => Promise
`

Start scanning for BLE devices to interact with according to the filters in the options. The callback will be invoked on each device that is found.
Scanning will continue until stopLEScan is called. For an example, see usage.
Note: Use with care on web platform, the required API is still behind a flag in most browsers.

| Param | Type |
| -------------- | --------------------------------------------------------------------------- |
| options | RequestBleDeviceOptions |
| callback | (result: ScanResult) => void |

---

$3

`typescript
stopLEScan() => Promise
`

Stop scanning for BLE devices. For an example, see usage.

---

$3

`typescript
getDevices(deviceIds: string[]) => Promise
`

On iOS and web, if you want to connect to a previously connected device without scanning first, you can use getDevice.
Uses retrievePeripherals on iOS and
getDevices on web.
On Android, you can directly connect to the device with the deviceId.

| Param | Type | Description |
| --------------- | --------------------- | ------------------------------------------------------- |
| deviceIds | string[] | List of device IDs, e.g. saved from a previous app run. |

Returns: Promise<BleDevice[]>

---

$3

`typescript
getBondedDevices() => Promise
`

Get a list of currently bonded devices.
Only available on Android.
Uses getBondedDevices>) on Android

Returns: Promise<BleDevice[]>

---

$3

`typescript
getConnectedDevices(services: string[]) => Promise
`

Get a list of currently connected devices.
Uses retrieveConnectedPeripherals on iOS,
getConnectedDevices>) on Android
and getDevices on web.

| Param | Type | Description |
| -------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| services | string[] | List of services to filter the devices by. If no service is specified, no devices will be returned. Only applies to iOS. |

Returns: Promise<BleDevice[]>

---

$3

`typescript
connect(deviceId: string, onDisconnect?: ((deviceId: string) => void) | undefined, options?: ConnectClientOptions | undefined) => Promise
`

Connect to a peripheral BLE device. For an example, see usage.

| Param | Type | Description |
| ------------------ | --------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| deviceId | string | The ID of the device to use (obtained from requestDevice or requestLEScan) |
| onDisconnect | ((deviceId: string) => void) | Optional disconnect callback function that will be used when the device disconnects |
| options | ConnectClientOptions | Options for plugin call |

---

$3

`typescript
createBond(deviceId: string, options?: TimeoutOptions | undefined) => Promise
`

Create a bond with a peripheral BLE device.
Only available on Android. On iOS bonding is handled by the OS.

| Param | Type | Description |
| -------------- | --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| deviceId | string | The ID of the device to use (obtained from requestDevice or requestLEScan) |
| options | TimeoutOptions | Options for plugin call |

---

$3

`typescript
isBonded(deviceId: string) => Promise
`

Report whether a peripheral BLE device is bonded.
Only available on Android. On iOS bonding is handled by the OS.

| Param | Type | Description |
| -------------- | ------------------- | -------------------------------------------------------------------------------------------------------------- |
| deviceId | string | The ID of the device to use (obtained from requestDevice or requestLEScan) |

Returns: Promise<boolean>

---

$3

`typescript
disconnect(deviceId: string) => Promise
`

Disconnect from a peripheral BLE device. For an example, see usage.

| Param | Type | Description |
| -------------- | ------------------- | -------------------------------------------------------------------------------------------------------------- |
| deviceId | string | The ID of the device to use (obtained from requestDevice or requestLEScan) |

---

$3

`typescript
getServices(deviceId: string) => Promise
`

Get services, characteristics and descriptors of a device.

| Param | Type | Description |
| -------------- | ------------------- | -------------------------------------------------------------------------------------------------------------- |
| deviceId | string | The ID of the device to use (obtained from requestDevice or requestLEScan) |

Returns: Promise<BleService[]>

---

$3

`typescript
discoverServices(deviceId: string) => Promise
`

Discover services, characteristics and descriptors of a device.
You only need this method if your peripheral device changes its services and characteristics at runtime.
If the discovery was successful, the remote services can be retrieved using the getServices function.
Not available on web.

| Param | Type | Description |
| -------------- | ------------------- | -------------------------------------------------------------------------------------------------------------- |
| deviceId | string | The ID of the device to use (obtained from requestDevice or requestLEScan) |

---

$3

`typescript
getMtu(deviceId: string) => Promise
`

Get the MTU of a connected device. Note that the maximum write value length is 3 bytes less than the MTU.
Not available on web.

| Param | Type | Description |
| -------------- | ------------------- | -------------------------------------------------------------------------------------------------------------- |
| deviceId | string | The ID of the device to use (obtained from requestDevice or requestLEScan) |

Returns: Promise<number>

---

$3

`typescript
requestConnectionPriority(deviceId: string, connectionPriority: ConnectionPriority) => Promise
`

Request a connection parameter update.
Only available on Android. https://developer.android.com/reference/android/bluetooth/BluetoothGatt#requestConnectionPriority(int)

| Param | Type | Description |
| ------------------------ | ----------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| deviceId | string | The ID of the device to use (obtained from requestDevice or requestLEScan) |
| connectionPriority | ConnectionPriority | Request a specific connection priority. See ConnectionPriority |

---

$3

`typescript
readRssi(deviceId: string) => Promise
`

Read the RSSI value of a connected device.
Not available on web.

| Param | Type | Description |
| -------------- | ------------------- | -------------------------------------------------------------------------------------------------------------- |
| deviceId | string | The ID of the device to use (obtained from requestDevice or requestLEScan) |

Returns: Promise<number>

---

$3

`typescript
read(deviceId: string, service: string, characteristic: string, options?: TimeoutOptions | undefined) => Promise
`

Read the value of a characteristic. For an example, see usage.

| Param | Type | Description |
| -------------------- | --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| deviceId | string | The ID of the device to use (obtained from requestDevice or requestLEScan) |
| service | string | UUID of the service (see UUID format) |
| characteristic | string | UUID of the characteristic (see UUID format) |
| options | TimeoutOptions | Options for plugin call |

Returns: Promise<DataView>

---

$3

`typescript
write(deviceId: string, service: string, characteristic: string, value: DataView, options?: TimeoutOptions | undefined) => Promise
`

Write a value to a characteristic. For an example, see usage.

| Param | Type | Description |
| -------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| deviceId | string | The ID of the device to use (obtained from requestDevice or requestLEScan) |
| service | string | UUID of the service (see UUID format) |
| characteristic | string | UUID of the characteristic (see UUID format) |
| value | DataView | The value to write as a DataView. To create a DataView from an array of numbers, there is a helper function, e.g. numbersToDataView([1, 0]) |
| options | TimeoutOptions | Options for plugin call |

---

$3

`typescript
writeWithoutResponse(deviceId: string, service: string, characteristic: string, value: DataView, options?: TimeoutOptions | undefined) => Promise
`

Write a value to a characteristic without waiting for a response.

| Param | Type | Description |
| -------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| deviceId | string | The ID of the device to use (obtained from requestDevice or requestLEScan) |
| service | string | UUID of the service (see UUID format) |
| characteristic | string | UUID of the characteristic (see UUID format) |
| value | DataView | The value to write as a DataView. To create a DataView from an array of numbers, there is a helper function, e.g. numbersToDataView([1, 0]) |
| options | TimeoutOptions | Options for plugin call |

---

$3

`typescript
readDescriptor(deviceId: string, service: string, characteristic: string, descriptor: string, options?: TimeoutOptions | undefined) => Promise
`

Read the value of a descriptor.

| Param | Type | Description |
| -------------------- | --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| deviceId | string | The ID of the device to use (obtained from requestDevice or requestLEScan) |
| service | string | UUID of the service (see UUID format) |
| characteristic | string | UUID of the characteristic (see UUID format) |
| descriptor | string | UUID of the descriptor (see UUID format) |
| options | TimeoutOptions | Options for plugin call |

Returns: Promise<DataView>

---

$3

`typescript
writeDescriptor(deviceId: string, service: string, characteristic: string, descriptor: string, value: DataView, options?: TimeoutOptions | undefined) => Promise
`

Write a value to a descriptor.

| Param | Type | Description |
| -------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| deviceId | string | The ID of the device to use (obtained from requestDevice or requestLEScan) |
| service | string | UUID of the service (see UUID format) |
| characteristic | string | UUID of the characteristic (see UUID format) |
| descriptor | string | UUID of the descriptor (see UUID format) |
| value | DataView | The value to write as a DataView. To create a DataView from an array of numbers, there is a helper function, e.g. numbersToDataView([1, 0]) |
| options | TimeoutOptions | Options for plugin call |

---

$3

`typescript
startNotifications(deviceId: string, service: string, characteristic: string, callback: (value: DataView) => void, options?: TimeoutOptions | undefined) => Promise
`

Start listening to changes of the value of a characteristic.
Note that you should only start the notifications once per characteristic in your app and share the data and
not call startNotifications in every component that needs the data.
For an example, see usage.

| Param | Type | Description |
| -------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| deviceId | string | The ID of the device to use (obtained from requestDevice or requestLEScan) |
| service | string | UUID of the service (see UUID format) |
| characteristic | string | UUID of the characteristic (see UUID format) |
| callback | (value: DataView) => void | Callback function to use when the value of the characteristic changes |
| options | TimeoutOptions | Options for plugin call. Timeout not supported on web. |

---

$3

`typescript
stopNotifications(deviceId: string, service: string, characteristic: string) => Promise
`

Stop listening to the changes of the value of a characteristic. For an example, see usage.

| Param | Type | Description |
| -------------------- | ------------------- | -------------------------------------------------------------------------------------------------------------- |
| deviceId | string | The ID of the device to use (obtained from requestDevice or requestLEScan) |
| service | string | UUID of the service (see UUID format) |
| characteristic | string | UUID of the characteristic (see UUID format) |

---

$3

#### InitializeOptions

| Prop | Type | Description | Default |
| ----------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------ |
| androidNeverForLocation | boolean | If your app doesn't use Bluetooth scan results to derive physical location information, you can strongly assert that your app doesn't derive physical location. (Android only) Requires adding 'neverForLocation' to AndroidManifest.xml https://developer.android.com/guide/topics/connectivity/bluetooth/permissions#assert-never-for-location | false |

#### DisplayStrings

| Prop | Type | Default | Since |
| ---------------------- | ------------------- | -------------------------------- | ----- |
| scanning | string | "Scanning..." | 0.0.1 |
| cancel | string | "Cancel" | 0.0.1 |
| availableDevices | string | "Available devices" | 0.0.1 |
| noDeviceFound | string | "No device found" | 0.0.1 |

#### BleDevice

| Prop | Type | Description |
| -------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| deviceId | string | ID of the device, which will be needed for further calls. On Android this is the BLE MAC address. On iOS and web it is an identifier. |
| name | string | Name of the peripheral device. |
| uuids | string[] | |

#### RequestBleDeviceOptions

| Prop | Type | Description | Default |
| ---------------------- | --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- |
| services | string[] | Filter devices by service UUIDs. UUIDs have to be specified as 128 bit UUID strings, e.g. ['0000180d-0000-1000-8000-00805f9b34fb'] There is a helper function to convert numbers to UUIDs. e.g. [numberToUUID(0x180f)]. (see UUID format) | |
| name | string | Filter devices by name | |
| namePrefix | string | Filter devices by name prefix | |
| optionalServices | string[] | For web, all services that will be used have to be listed under services or optionalServices, e.g. [numberToUUID(0x180f)] (see UUID format) | |
| allowDuplicates | boolean | Normally scans will discard the second and subsequent advertisements from a single device. If you need to receive them, set allowDuplicates to true (only applicable in requestLEScan). (default: false) | |
| scanMode | ScanMode | Android scan mode (default: ScanMode.SCAN_MODE_BALANCED) | |
| manufacturerData | ManufacturerDataFilter[] | Allow scanning for devices with a specific manufacturer data https://developer.mozilla.org/en-US/docs/Web/API/Bluetooth/requestDevice#manufacturerdata | |
| displayMode | 'alert' \| 'list' | Display mode for the device list in requestDevice (iOS only). - "alert": Classic alert dialog (default) - "list": Scrollable list view | "alert" |
| serviceData | ServiceDataFilter[] | Allow scanning for devices with specific service data. Service data is data associated with a specific service UUID in the advertisement packet. Useful for protocols like OpenDroneID, EddyStone, and Open Beacon. | |

#### ManufacturerDataFilter

| Prop | Type | Description |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| companyIdentifier | number | Company ID (sometimes called the manufacturer ID) to search for in the manufacturer data field. |
| dataPrefix | DataView \| Uint8Array | Prefix to match in the manufacturer data field. On Android this field is mandatory. android, ios: DataView web: Uint8Array |
| mask | DataView \| Uint8Array | Set filter on partial manufacture data. For any bit in the mask, set it the 1 if it needs to match the one in manufacturer data, otherwise set it to 0. The mask must have the same length of dataPrefix. android, ios: DataView web: Uint8Array |

#### ServiceDataFilter

| Prop | Type | Description |
| ----------------- | ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| serviceUuid | string | Service UUID to filter by. The service data must be associated with this UUID. UUIDs have to be specified as 128 bit UUID strings, e.g. '0000fffa-0000-1000-8000-00805f9b34fb' |
| dataPrefix | DataView | Prefix to match in the service data field. For example, OpenDroneID uses [0x0D] as the advertisement code. android, ios: string web: DataView |
| mask | DataView | Set filter on partial service data. For any bit in the mask, set it to 1 if it needs to match the one in service data, otherwise set it to 0. The mask must have the same length as dataPrefix. android, ios: string web: DataView |

#### ScanResult

| Prop | Type | Description |
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| device | BleDevice | The peripheral device that was found in the scan. Android and web: device.name is always identical to localName. iOS: device.name is identical to localName the first time a device is discovered, but after connecting device.name is the cached GAP name in subsequent scans. |
| localName | string | The name of the peripheral device from the advertisement data. |
| rssi | number | Received Signal Strength Indication. |
| txPower | number | Transmit power in dBm. A value of 127 indicates that it is not available. |
| manufacturerData | { [key: string]: DataView; } | Manufacturer data, key is a company identifier and value is the data. |
| serviceData` | { [key: string]: DataView; } | Service data, key is a service UUID and value is the data.