@ermitsrl/bluetooth-le

<img src="https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png" width="128" height="128" /> <h3 align="center">Bluetooth Low Energy</h3> <code>@ermitsrl/bluetooth-le</code> Capacitor plugin for Bluetooth Low Energy <img src="https://img.shields.io/maintenance/yes/2023?style=flat-square" /> <a href="https://github.com/capacitor-community/bluetooth-le/actions?query=workflow%3A%22CI%22"><img src="https://img.shields.io/github/actions/workflow/status/capacitor-community/bluetooth-le/main.yml?branch=main&style=flat-square" /></a> <a href="https://www.npmjs.com/package/@ermitsrl/bluetooth-le"><img src="https://img.shields.io/npm/l/@ermitsrl/bluetooth-le?style=flat-square" /></a> <a href="https://www.npmjs.com/package/@ermitsrl/bluetooth-le"><img src="https://img.shields.io/npm/dw/@ermitsrl/bluetooth-le?style=flat-square" /></a> <a href="https://www.npmjs.com/package/@ermitsrl/bluetooth-le"><img src="https://img.shields.io/npm/v/@ermitsrl/bluetooth-le?style=flat-square" /></a>  <a href="#contributors-"><img src="https://img.shields.io/badge/all%20contributors-8-orange?style=flat-square" /></a>  ## Maintainers | Maintainer | GitHub | Social | | ------------- | ----------------------------------- | ------ | | Patrick Wespi | [pwespi](https://github.com/pwespi) | | ## Versions | Plugin | Capacitor | Documentation | | ------ | --------- | --------------------------------------------------------------------------------- | | 2.x | 4.x | [README](https://github.com/capacitor-community/bluetooth-le/blob/main/README.md) | | 1.x | 3.x | [README](https://github.com/capacitor-community/bluetooth-le/blob/1.x/README.md) | | 0.x | 2.x | [README](https://github.com/capacitor-community/bluetooth-le/blob/0.x/README.md) | ## 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](https://developer.mozilla.org/en-US/docs/Web/API/Web_Bluetooth_API) is taken as a guidline for what features to implement. This 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](https://github.com/WebBluetoothCG/web-bluetooth/blob/main/implementation-status.md). Below is an index of all the methods available. <docgen-index> - [`initialize(...)`](#initialize) - [`isEnabled()`](#isenabled) - [`enable()`](#enable) - [`disable()`](#disable) - [`startEnabledNotifications(...)`](#startenablednotifications) - [`stopEnabledNotifications()`](#stopenablednotifications) - [`isLocationEnabled()`](#islocationenabled) - [`openLocationSettings()`](#openlocationsettings) - [`openBluetoothSettings()`](#openbluetoothsettings) - [`openAppSettings()`](#openappsettings) - [`setDisplayStrings(...)`](#setdisplaystrings) - [`requestDevice(...)`](#requestdevice) - [`requestLEScan(...)`](#requestlescan) - [`stopLEScan()`](#stoplescan) - [`getDevices(...)`](#getdevices) - [`getConnectedDevices(...)`](#getconnecteddevices) - [`scanNetworks(...)`](#scannetworks) - [`provision(...)`](#provision) - [`connect(...)`](#connect) - [`createBond(...)`](#createbond) - [`isBonded(...)`](#isbonded) - [`setPin(...)`](#setpin) - [`disconnect(...)`](#disconnect) - [`getServices(...)`](#getservices) - [`discoverServices(...)`](#discoverservices) - [`readRssi(...)`](#readrssi) - [`read(...)`](#read) - [`write(...)`](#write) - [`writeWithoutResponse(...)`](#writewithoutresponse) - [`readDescriptor(...)`](#readdescriptor) - [`writeDescriptor(...)`](#writedescriptor) - [`startNotifications(...)`](#startnotifications) - [`stopNotifications(...)`](#stopnotifications) - [Interfaces](#interfaces) - [Enums](#enums) </docgen-index> See [Platform Support](#platform-support) for an overview of supported methods on Android, iOS and web. ## Installation ``` npm install @ermitsrl/bluetooth-le npx cap sync ``` ### iOS On iOS, add the `NSBluetoothAlwaysUsageDescription` to `Info.plist`, otherwise the app will crash when trying to use Bluetooth (see [here](https://developer.apple.com/documentation/corebluetooth)). 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](https://developer.apple.com/documentation/bundleresources/information_property_list/uibackgroundmodes)). `./ios/App/App/Info.plist`: ```diff <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> <plist version="1.0"> <dict> <key>CFBundleDevelopmentRegion</key> <string>en</string> ... + <key>NSBluetoothAlwaysUsageDescription</key> + <string>Uses Bluetooth to connect and interact with peripheral BLE devices.</string> + <key>UIBackgroundModes</key> + <array> + <string>bluetooth-central</string> + </array> </dict> </plist> ``` ### Android On Android, no further steps are required to use the plugin (if you are using Capacitor 2, see [here](https://github.com/capacitor-community/bluetooth-le/blob/0.x/README.md#android)). #### (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](https://developer.android.com/guide/topics/connectivity/bluetooth/permissions#declare-android12-or-higher). 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). - Make sure you have JDK 11+ (it is recommended to use JDK that comes with Android Studio). - In `android/app/src/main/AndroidManifest.xml`, add `android:exported="true"` to your activity if not already added (setting [`android:exported`](https://developer.android.com/guide/topics/manifest/activity-element#exported) is required in apps targeting Android 12 and higher). - In `android/app/src/main/AndroidManifest.xml`, update the permissions: ```diff  + <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" android:maxSdkVersion="30" /> + <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" android:maxSdkVersion="30" /> + <uses-permission android:name="android.permission.BLUETOOTH_SCAN" + android:usesPermissionFlags="neverForLocation" + tools:targetApi="s" /> ``` - Set the `androidNeverForLocation` flag to `true` when initializing the `BleClient`. ```ts import { BleClient } from '@ermitsrl/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.](https://developer.android.com/guide/topics/connectivity/bluetooth/permissions#assert-never-for-location) ## 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(...)`](#setdisplaystrings). ## Usage It is recommended to not use the plugin class directly. There is a wrapper class `BleClient` which makes events and method arguments easier to work with. ```typescript // Import the wrapper class directly import { BleClient } from '@ermitsrl/bluetooth-le'; // DO NOT use this import { BluetoothLe } from '@ermitsrl/bluetooth-le'; ``` 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 '@ermitsrl/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<void> { 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; } ``` An example of using the scanning API: ```typescript import { BleClient, numberToUUID } from '@ermitsrl/bluetooth-le'; const HEART_RATE_SERVICE = numberToUUID(0x180d); export async function scan(): Promise<void> { 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](https://github.com/sourcya/ble-tester) (Ionic/React) - [OpenGoPro](https://github.com/gopro/OpenGoPro/tree/main/demos/ionic/file_transfer) (Ionic/Angular) - [Quasar BLE](https://github.com/nunogois/quasar-ble) (Quasar/Vue) ## Platform Support _Note_: web support depends on the browser, see [implementation status](https://github.com/WebBluetoothCG/web-bluetooth/blob/main/implementation-status.md). | method | Android | iOS | web | | -------------------------------------------------------------- | :-----: | :-: | :-: | | [`initialize()`](#initialize) | ✅ | ✅ | ✅ | | [`isEnabled()`](#isenabled) | ✅ | ✅ | -- | | [`enable()`](#enable) | ✅ | ❌ | ❌ | | [`disable()`](#disable) | ✅ | ❌ | ❌ | | [`startEnabledNotifications(...)`](#startenablednotifications) | ✅ | ✅ | -- | | [`stopEnabledNotifications()`](#stopenablednotifications) | ✅ | ✅ | -- | | [`isLocationEnabled()`](#islocationenabled) | ✅ | ❌ | ❌ | | [`openLocationSettings()`](#openlocationsettings) | ✅ | ❌ | ❌ | | [`openBluetoothSettings()`](#openbluetoothsettings) | ✅ | ❌ | ❌ | | [`openAppSettings()`](#openappsettings) | ✅ | ✅ | ❌ | | [`setDisplayStrings(...)`](#setdisplaystrings) | ✅ | ✅ | -- | | [`requestDevice(...)`](#requestdevice) | ✅ | ✅ | ✅ | | [`requestLEScan(...)`](#requestlescan) | ✅ | ✅ | 🚩 | | [`stopLEScan()`](#stoplescan) | ✅ | ✅ | 🚩 | | [`getDevices(...)`](#getdevices) | ✅ | ✅ | 🚩 | | [`getConnectedDevices(...)`](#getconnecteddevices) | ✅ | ✅ | 🚩 | | [`connect(...)`](#connect) | ✅ | ✅ | ✅ | | [`createBond(...)`](#createbond) | ✅ | ❌ | ❌ | | [`isBonded(...)`](#isbonded) | ✅ | ❌ | ❌ | | [`disconnect(...)`](#disconnect) | ✅ | ✅ | ✅ | | [`getServices(...)`](#getservices) | ✅ | ✅ | ✅ | | [`discoverServices(...)`](#discoverservices) | ✅ | ✅ | ❌ | | [`readRssi(...)`](#readrssi) | ✅ | ✅ | ❌ | | [`read(...)`](#read) | ✅ | ✅ | ✅ | | [`write(...)`](#write) | ✅ | ✅ | ✅ | | [`readDescriptor(...)`](#read) | ✅ | ✅ | ✅ | | [`writeDescriptor(...)`](#write) | ✅ | ✅ | ✅ | | [`writeWithoutResponse(...)`](#writewithoutresponse) | ✅ | ✅ | ✅ | | [`startNotifications(...)`](#startnotifications) | ✅ | ✅ | ✅ | | [`stopNotifications(...)`](#stopnotifications) | ✅ | ✅ | ✅ | #### Legend - ✅ supported - ❌ not supported (throws an `unavailable` error) - 🚩 behind a flag in Chrome (see [implementation status](https://github.com/WebBluetoothCG/web-bluetooth/blob/main/implementation-status.md)) - -- not supported, but does not throw an error ## API <docgen-api>  ### initialize(...) ```typescript initialize(options?: InitializeOptions | undefined) => Promise<void> ``` 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](#usage). | Param | Type | | ------------- | --------------------------------------------------------------- | | **`options`** | <code><a href="#initializeoptions">InitializeOptions</a></code> | --- ### isEnabled() ```typescript isEnabled() => Promise<boolean> ``` Reports whether Bluetooth is enabled on this device. Always returns `true` on **web**. **Returns:** <code>Promise<boolean></code> --- ### enable() ```typescript enable() => Promise<void> ``` Enable Bluetooth. Only available on **Android**. --- ### disable() ```typescript disable() => Promise<void> ``` Disable Bluetooth. Only available on **Android**. --- ### startEnabledNotifications(...) ```typescript startEnabledNotifications(callback: (value: boolean) => void) => Promise<void> ``` 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`** | <code>(value: boolean) => void</code> | Callback function to use when the Bluetooth state changes. | --- ### stopEnabledNotifications() ```typescript stopEnabledNotifications() => Promise<void> ``` Stop the enabled notifications registered with `startEnabledNotifications`. --- ### isLocationEnabled() ```typescript isLocationEnabled() => Promise<boolean> ``` Reports whether Location Services are enabled on this device. Only available on **Android**. **Returns:** <code>Promise<boolean></code> --- ### openLocationSettings() ```typescript openLocationSettings() => Promise<void> ``` Open Location settings. Only available on **Android**. --- ### openBluetoothSettings() ```typescript openBluetoothSettings() => Promise<void> ``` Open Bluetooth settings. Only available on **Android**. --- ### openAppSettings() ```typescript openAppSettings() => Promise<void> ``` 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. --- ### setDisplayStrings(...) ```typescript setDisplayStrings(displayStrings: DisplayStrings) => Promise<void> ``` Set the strings that are displayed in the `requestDevice` dialog. | Param | Type | | -------------------- | --------------------------------------------------------- | | **`displayStrings`** | <code><a href="#displaystrings">DisplayStrings</a></code> | --- ### requestDevice(...) ```typescript requestDevice(options?: RequestBleDeviceOptions | undefined) => Promise<BleDevice> ``` 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](#usage). | Param | Type | Description | | ------------- | --------------------------------------------------------------------------- | ----------------------------------------------------------------------- | | **`options`** | <code><a href="#requestbledeviceoptions">RequestBleDeviceOptions</a></code> | Device filters, see [RequestBleDeviceOptions](#RequestBleDeviceOptions) | **Returns:** <code>Promise<<a href="#bledevice">BleDevice</a>></code> --- ### requestLEScan(...) ```typescript requestLEScan(options: RequestBleDeviceOptions, callback: (result: ScanResult) => void) => Promise<void> ``` 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](#usage). **NOTE**: Use with care on **web** platform, the required API is still behind a flag in most browsers. | Param | Type | | -------------- | --------------------------------------------------------------------------- | | **`options`** | <code><a href="#requestbledeviceoptions">RequestBleDeviceOptions</a></code> | | **`callback`** | <code>(result: <a href="#scanresult">ScanResult</a>) => void</code> | --- ### stopLEScan() ```typescript stopLEScan() => Promise<void> ``` Stop scanning for BLE devices. For an example, see [usage](#usage). --- ### getDevices(...) ```typescript getDevices(deviceIds: string[]) => Promise<BleDevice[]> ``` On iOS and web, if you want to connect to a previously connected device without scanning first, you can use `getDevice`. Uses [retrievePeripherals](https://developer.apple.com/documentation/corebluetooth/cbcentralmanager/1519127-retrieveperipherals) on iOS and [getDevices](https://developer.mozilla.org/en-US/docs/Web/API/Bluetooth/getDevices) on web. On Android, you can directly connect to the device with the deviceId. | Param | Type | Description | | --------------- | --------------------- | --------------------------------------------------------------------------- | | **`deviceIds`** | <code>string[]</code> | List of device IDs, e.g. saved from a previous app run. No used on **web**. | **Returns:** <code>Promise<BleDevice[]></code> --- ### getConnectedDevices(...) ```typescript getConnectedDevices(services: string[]) => Promise<BleDevice[]> ``` Get a list of currently connected devices. Uses [retrieveConnectedPeripherals](https://developer.apple.com/documentation/corebluetooth/cbcentralmanager/1518924-retrieveconnectedperipherals) on iOS, [getConnectedDevices](<https://developer.android.com/reference/android/bluetooth/BluetoothManager#getConnectedDevices(int)>) on Android and [getDevices](https://developer.mozilla.org/en-US/docs/Web/API/Bluetooth/getDevices) on web. | Param | Type | Description | | -------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------ | | **`services`** | <code>string[]</code> | List of services to filter the devices by. If no service is specified, no devices will be returned. Only applies to iOS. | **Returns:** <code>Promise<BleDevice[]></code> --- ### scanNetworks(...) ```typescript scanNetworks(deviceId: string) => Promise<any[]> ``` Get a list of wifi networks from the device. | Param | Type | Description | | -------------- | ------------------- | -------------------------------------------------------------------------------------------------------------- | | **`deviceId`** | <code>string</code> | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) | **Returns:** <code>Promise<any[]></code> --- ### provision(...) ```typescript provision(deviceId: string, ssid: string, password?: string | undefined) => Promise<void> ``` Connect to a peripheral BLE device. For an example, see [usage](#usage). | Param | Type | Description | | -------------- | ------------------- | -------------------------------------------------------------------------------------------------------------- | | **`deviceId`** | <code>string</code> | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) | | **`ssid`** | <code>string</code> | The SSID of the network to connect to | | **`password`** | <code>string</code> | The password of the network to connect to | --- ### connect(...) ```typescript connect(deviceId: string, proofOfPossession: string, onDisconnect?: ((deviceId: string) => void) | undefined, options?: TimeoutOptions | undefined) => Promise<void> ``` Connect to a peripheral BLE device. For an example, see [usage](#usage). | Param | Type | Description | | ----------------------- | --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | | **`deviceId`** | <code>string</code> | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) | | **`proofOfPossession`** | <code>string</code> | The proofOfPossession code to connect with security level 4. Only available on **Android**. | | **`onDisconnect`** | <code>((deviceId: string) => void)</code> | Optional disconnect callback function that will be used when the device disconnects | | **`options`** | <code><a href="#timeoutoptions">TimeoutOptions</a></code> | Options for plugin call | --- ### createBond(...) ```typescript createBond(deviceId: string) => Promise<void> ``` Create a bond with a peripheral BLE device. Only available on **Android**. On iOS bonding is handled by the OS. | Param | Type | Description | | -------------- | ------------------- | -------------------------------------------------------------------------------------------------------------- | | **`deviceId`** | <code>string</code> | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) | --- ### isBonded(...) ```typescript isBonded(deviceId: string) => Promise<boolean> ``` Report whether a peripheral BLE device is bonded. Only available on **Android**. On iOS bonding is handled by the OS. | Param | Type | Description | | -------------- | ------------------- | -------------------------------------------------------------------------------------------------------------- | | **`deviceId`** | <code>string</code> | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) | **Returns:** <code>Promise<boolean></code> --- ### setPin(...) ```typescript setPin(deviceId: string) => Promise<boolean> ``` | Param | Type | | -------------- | ------------------- | | **`deviceId`** | <code>string</code> | **Returns:** <code>Promise<boolean></code> --- ### disconnect(...) ```typescript disconnect(deviceId: string) => Promise<void> ``` Disconnect from a peripheral BLE device. For an example, see [usage](#usage). | Param | Type | Description | | -------------- | ------------------- | -------------------------------------------------------------------------------------------------------------- | | **`deviceId`** | <code>string</code> | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) | --- ### getServices(...) ```typescript getServices(deviceId: string) => Promise<BleService[]> ``` Get services, characteristics and descriptors of a device. | Param | Type | Description | | -------------- | ------------------- | -------------------------------------------------------------------------------------------------------------- | | **`deviceId`** | <code>string</code> | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) | **Returns:** <code>Promise<BleService[]></code> --- ### discoverServices(...) ```typescript discoverServices(deviceId: string) => Promise<void> ``` 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`** | <code>string</code> | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) | --- ### readRssi(...) ```typescript readRssi(deviceId: string) => Promise<number> ``` Read the RSSI value of a connected device. Not available on **web**. | Param | Type | Description | | -------------- | ------------------- | -------------------------------------------------------------------------------------------------------------- | | **`deviceId`** | <code>string</code> | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) | **Returns:** <code>Promise<number></code> --- ### read(...) ```typescript read(deviceId: string, service: string, characteristic: string, options?: TimeoutOptions | undefined) => Promise<DataView> ``` Read the value of a characteristic. For an example, see [usage](#usage). | Param | Type | Description | | -------------------- | --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | | **`deviceId`** | <code>string</code> | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) | | **`service`** | <code>string</code> | UUID of the service (see [UUID format](#uuid-format)) | | **`characteristic`** | <code>string</code> | UUID of the characteristic (see [UUID format](#uuid-format)) | | **`options`** | <code><a href="#timeoutoptions">TimeoutOptions</a></code> | Options for plugin call | **Returns:** <code>Promise<<a href="#dataview">DataView</a>></code> --- ### write(...) ```typescript write(deviceId: string, service: string, characteristic: string, value: DataView, options?: TimeoutOptions | undefined) => Promise<void> ``` Write a value to a characteristic. For an example, see [usage](#usage). | Param | Type | Description | | -------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **`deviceId`** | <code>string</code> | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) | | **`service`** | <code>string</code> | UUID of the service (see [UUID format](#uuid-format)) | | **`characteristic`** | <code>string</code> | UUID of the characteristic (see [UUID format](#uuid-format)) | | **`value`** | <code><a href="#dataview">DataView</a></code> | The value to write as a <a href="#dataview">DataView</a>. To create a <a href="#dataview">DataView</a> from an array of numbers, there is a helper function, e.g. numbersToDataView([1, 0]) | | **`options`** | <code><a href="#timeoutoptions">TimeoutOptions</a></code> | Options for plugin call | --- ### writeWithoutResponse(...) ```typescript writeWithoutResponse(deviceId: string, service: string, characteristic: string, value: DataView, options?: TimeoutOptions | undefined) => Promise<void> ``` Write a value to a characteristic without waiting for a response. | Param | Type | Description | | -------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **`deviceId`** | <code>string</code> | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) | | **`service`** | <code>string</code> | UUID of the service (see [UUID format](#uuid-format)) | | **`characteristic`** | <code>string</code> | UUID of the characteristic (see [UUID format](#uuid-format)) | | **`value`** | <code><a href="#dataview">DataView</a></code> | The value to write as a <a href="#dataview">DataView</a>. To create a <a href="#dataview">DataView</a> from an array of numbers, there is a helper function, e.g. numbersToDataView([1, 0]) | | **`options`** | <code><a href="#timeoutoptions">TimeoutOptions</a></code> | Options for plugin call | --- ### readDescriptor(...) ```typescript readDescriptor(deviceId: string, service: string, characteristic: string, descriptor: string, options?: TimeoutOptions | undefined) => Promise<DataView> ``` Read the value of a descriptor. | Param | Type | Description | | -------------------- | --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | | **`deviceId`** | <code>string</code> | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) | | **`service`** | <code>string</code> | UUID of the service (see [UUID format](#uuid-format)) | | **`characteristic`** | <code>string</code> | UUID of the characteristic (see [UUID format](#uuid-format)) | | **`descriptor`** | <code>string</code> | UUID of the descriptor (see [UUID format](#uuid-format)) | | **`options`** | <code><a href="#timeoutoptions">TimeoutOptions</a></code> | Options for plugin call | **Returns:** <code>Promise<<a href="#dataview">DataView</a>></code> --- ### writeDescriptor(...) ```typescript writeDescriptor(deviceId: string, service: string, characteristic: string, descriptor: string, value: DataView, options?: TimeoutOptions | undefined) => Promise<void> ``` Write a value to a descriptor. | Param | Type | Description | | -------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **`deviceId`** | <code>string</code> | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) | | **`service`** | <code>string</code> | UUID of the service (see [UUID format](#uuid-format)) | | **`characteristic`** | <code>string</code> | UUID of the characteristic (see [UUID format](#uuid-format)) | | **`descriptor`** | <code>string</code> | UUID of the descriptor (see [UUID format](#uuid-format)) | | **`value`** | <code><a href="#dataview">DataView</a></code> | The value to write as a <a href="#dataview">DataView</a>. To create a <a href="#dataview">DataView</a> from an array of numbers, there is a helper function, e.g. numbersToDataView([1, 0]) | | **`options`** | <code><a href="#timeoutoptions">TimeoutOptions</a></code> | Options for plugin call | --- ### startNotifications(...) ```typescript startNotifications(deviceId: string, service: string, characteristic: string, callback: (value: DataView) => void) => Promise<void> ``` 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](#usage). | Param | Type | Description | | -------------------- | ----------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | | **`deviceId`** | <code>string</code> | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) | | **`service`** | <code>string</code> | UUID of the service (see [UUID format](#uuid-format)) | | **`characteristic`** | <code>string</code> | UUID of the characteristic (see [UUID format](#uuid-format)) | | **`callback`** | <code>(value: <a href="#dataview">DataView</a>) => void</code> | Callback function to use when the value of the characteristic changes | --- ### stopNotifications(...) ```typescript stopNotifications(deviceId: string, service: string, characteristic: string) => Promise<void> ``` Stop listening to the changes of the value of a characteristic. For an example, see [usage](#usage). | Param | Type | Description | | -------------------- | ------------------- | -------------------------------------------------------------------------------------------------------------- | | **`deviceId`** | <code>string</code> | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) | | **`service`** | <code>string</code> | UUID of the service (see [UUID format](#uuid-format)) | | **`characteristic`** | <code>string</code> | UUID of the characteristic (see [UUID format](#uuid-format)) | --- ### Interfaces #### InitializeOptions | Prop | Type | Description | Default | | ----------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------ | | **`androidNeverForLocation`** | <code>boolean</code> | 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 | <code>false</code> | #### DisplayStrings | Prop | Type | Default | Since | | ---------------------- | ------------------- | -------------------------------- | ----- | | **`scanning`** | <code>string</code> | <code>"Scanning..."</code> | 0.0.1 | | **`cancel`** | <code>string</code> | <code>"Cancel"</code> | 0.0.1 | | **`availableDevices`** | <code>string</code> | <code>"Available devices"</code> | 0.0.1 | | **`noDeviceFound`** | <code>string</code> | <code>"No device found"</code> | 0.0.1 | #### BleDevice | Prop | Type | Description | | -------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | **`deviceId`** | <code>string</code> | 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`** | <code>string</code> | Name of the peripheral device. | | **`uuids`** | <code>string[]</code> | | #### RequestBleDeviceOptions | Prop | Type | Description | | ---------------------- | --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **`services`** | <code>string[]</code> | 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](#uuid-format)) | | **`name`** | <code>string</code> | Filter devices by name | | **`namePrefix`** | <code>string</code> | Filter devices by name prefix | | **`optionalServices`** | <code>string[]</code> | For **web**, all services that will be used have to be listed under services or optionalServices, e.g. [numberToUUID(0x180f)] (see [UUID format](#uuid-format)) | | **`allowDuplicates`** | <code>boolean</code> | 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`** | <code><a href="#scanmode">ScanMode</a></code> | Android scan mode (default: <a href="#scanmode">ScanMode.SCAN_MODE_BALANCED</a>) | #### ScanResult | Prop | Type | Description | | ---------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **`device`** | <code><a href="#bledevice">BleDevice</a></code> | The peripheral device that was found in the scan. **Android**