Use the Bluetooth Low Energy plugin to connect your Cordova app to new Bluetooth devices like heart rate monitors, thermometers, etc...
npm install cordova-plugin-bluetoothle- Requirements
- Limitations / Issues
- Upgrade 2.x to 3.x
- Upgrade 3.x to 4.x
- To Do
- Using AngularJS
- Installation
- Debugging
- Installation Quirks (Android)
- Background Modes (iOS)
- Usage Description (iOS)
- Discovery Quirks (iOS vs Android)
- Queuing (Android)
- UUIDs
- Advertisement Data / MAC Address
- Emulator
- Methods
- Errors
- Permissions (Android)
- Properties
- Central Life Cycle
- initialize
- enable
- disable
- getAdapterInfo
- startScan
- stopScan
- retrieveConnected
- bond
- unbond
- connect
- reconnect
- disconnect
- close
- discover
- services
- characteristics
- descriptors
- read
- subscribe
- unsubscribe
- write
- writeQ
- readDescriptor
- writeDescriptor
- rssi
- mtu
- requestConnectionPriority
- isInitialized
- isEnabled
- isScanning
- isBonded
- wasConnected
- isConnected
- isDiscovered
- hasPermission
- requestPermission
- hasPermissionBtScan
- requestPermissionBtScan
- hasPermissionBtConnect
- requestPermissionBtConnect
- hasPermissionBtAdvertise
- requestPermissionBtAdvertise
- isLocationEnabled
- requestLocation
- setPin
- retrievePeripheralsByAddress
- Peripheral Life Cycle
- Initilization
- Notifications
- Descriptors
- initializePeripheral
- addService
- removeService
- removeAllServices
- startAdvertising
- stopAdvertising
- isAdvertising
- respond
- notify
- encodedStringToBytes
- bytesToEncodedString
- stringToBytes
- bytesToString
- encodeUnicode
- decodeUnicode
- Example
- Data Parsing Example
- Sample: Discover and interact with Bluetooth LE devices
- Initialize the Bluetooth adapter
- Scan for devices
- Connect to a device
- Get device services
- Get services on an Android device
- Get services on a Windows device
- Show services and characteristics in an app page
- More information
- License
* Cordova 5.0.0 or higher
* Android Cordova library 5.0.0 or higher, target Android API 23/Platform 6.0 or higher (support for older Android versions should use versions 2.4.0 or below)
* iOS 10 or higher
* Windows Phone 8.1 (Tested on Nokia Lumia 630)
* Windows 10 UWP
* Device hardware must be certified for Bluetooth LE. i.e. Nexus 7 (2012) doesn't support Bluetooth LE even after upgrading to 4.3 (or higher) without a modification
* List of devices: http://www.bluetooth.com/Pages/Bluetooth-Smart-Devices-List.aspx
* Disconnect and quickly reconnecting can cause issues on Android. Add a small timeout.
* Indication type subscription hasn't been well .
* OS X is still experimental. I'm experiencing some problems, but may be related to Cordova itself.
* Instead of specifying serviceUuids, serviceUuid, characteristicUuid, etc in the params, use services, service, characteristic, etc. Check out the scan-related, discovery-related and read/write/subscribe operation functions for more info. Discovery related functions will also return uuid properties instead of serviceUuid, characteristicUuid or descriptorUuid.
* The connecting and disconnecting events were removed.
* Background modes aren't added automatically. See Installation Quirks (iOS) for details.
* Improved notifications on peripheral/server role between Android and iOS
* Code refactoring. It's getting pretty messy.
Check out ng-cordova-bluetoothle here!
If timeouts are needed, please check out the Angular wrapper and its example.
Cordova
``cordova plugin add cordova-plugin-bluetoothle`
PhoneGap Build
`
* iOS - Scroll down to Bluetooth for iOS.
* Android
Apps like LightBlue are great for verifying Bluetooth LE behavior.
Scanning works differently in the background. There seem to be three different states:
1. Foreground - Service UUID doesn't need to be specified and allowDuplicates isn't ignored.
2. Background (Screen On) - Service UUID must be specified. allowDuplicates isn't ignored. Scanning is very slow!
3. Background (Screen Off) - Service UUID must be specified. allowDuplicates is ignored, so a device will only be returned once per scan. One possible work around is to start and stop the scan while in background. Unfortunately, there's a slim chance that the app may fall asleep again in between starting and stopping the scan.
cordova plugin https://github.com/randdusing/cordova-plugin-bluetoothle`
UUIDs ##
UUIDs can be 16 bits or 128 bits. The "out of the box" UUIDs from the link below are 16 bits.
Since iOS returns the 16 bit version of the "out of the box" UUIDs even if a 128 bit UUID was used in the parameters, the 16 bit version should always be used for the "out of the box" UUIDs for consistency.
Android on the other hand only uses the 128 bit version, but the plugin will automatically convert 16 bit UUIDs to the 128 bit version on input and output. For a list of out of the box UUIDS, see Bluetooth Developer Portal
Advertisement Data / MAC Address ##
On iOS, the MAC address is hidden from the advertisement packet, and the address returned from the scanResult is a generated, device-specific address. This is a problem when using devices like iBeacons where you need the MAC Address. Fortunately the CLBeacon class can be used for this, but unfortunately it's not supported in this plugin.
One option is to set Manufacturer Specific Data in the advertisement packet if that's possible in your project.
Another option is to connect to the device and use the "Device Information" (0x180A) service, but connecting to each device is much more energy intensive than scanning for advertisement data.
See the following StackOverflow posts for more info: here and hereAdvertisement data is not supported on Windows 10 UWP.
Emulator ##
Neither Android nor iOS support Bluetooth on emulators, so you'll need to test on a real device.
Methods ##
* bluetoothle.initialize
* bluetoothle.enable (Android)
* bluetoothle.disable (Android)
* bluetoothle.getAdapterInfo (Android)
* bluetoothle.startScan
* bluetoothle.stopScan
* bluetoothle.retrieveConnected
* bluetoothle.bond (Android)
* bluetoothle.unbond (Android)
* bluetoothle.connect
* bluetoothle.reconnect
* bluetoothle.disconnect
* bluetoothle.close
* bluetoothle.discover
* bluetoothle.services (iOS)
* bluetoothle.characteristics (iOS)
* bluetoothle.descriptors (iOS)
* bluetoothle.read
* bluetoothle.subscribe
* bluetoothle.unsubscribe
* bluetoothle.write
* bluetoothle.writeQ
* bluetoothle.readDescriptor
* bluetoothle.writeDescriptor
* bluetoothle.rssi
* bluetoothle.mtu (Android 5+)
* bluetoothle.requestConnectionPriority (Android 5+)
* bluetoothle.isInitialized
* bluetoothle.isEnabled
* bluetoothle.isScanning
* bluetoothle.isBonded (Android)
* bluetoothle.wasConnected
* bluetoothle.isConnected
* bluetoothle.isDiscovered
* bluetoothle.hasPermission (Android 6+)
* bluetoothle.requestPermission (Android 6+)
* bluetoothle.hasPermissionBtScan (Android 31+)
* bluetoothle.requestPermissionBtScan (Android 31+)
* bluetoothle.hasPermissionBtConnect (Android 31+)
* bluetoothle.requestPermissionBtConnect (Android 31+)
* bluetoothle.hasPermissionBtAdvertise (Android 31+)
* bluetoothle.requestPermissionBtAdvertise (Android 31+)
* bluetoothle.isLocationEnabled (Android 6+)
* bluetoothle.requestLocation (Android 6+)
* bluetoothle.retrievePeripheralsByAddress (iOS)
* bluetoothle.initializePeripheral
* bluetoothle.addService
* bluetoothle.removeService
* bluetoothle.removeAllServices
* bluetoothle.startAdvertising
* bluetoothle.stopAdvertising
* bluetoothle.respond
* bluetoothle.notify
* bluetoothle.setPin (Android)
* bluetoothle.encodedStringToBytes
* bluetoothle.bytesToEncodedString
* bluetoothle.stringToBytes
* bluetoothle.bytesToString
* bluetoothle.encodeUnicode
* bluetoothle.decodeUnicode
Errors ##
Whenever the error callback is executed, the return object will contain the error type and a message.
* initialize - Bluetooth isn't initialized (Try initializing Bluetooth)
* enable - Bluetooth isn't enabled (Request user to enable Bluetooth)
* disable - Bluetooth isn't disabled (Can't enabled if already disabled)
* startScan - Scan couldn't be started (Is the scan already running?)
* stopScan - Scan couldn't be stopped (Is the scan already stopped?)
* bond - Bond couldn't be formed (Is it already bonding? Is the device Android?)
* unbond - Bond couldn' be broken (Is it already unbonding? Is the device Android?)
* connect - Connection attempt failed (Is the device address correct?)
* reconnect - Reconnection attempt failed (Was the device ever connected?)
* discover - Failed to discover device (Is the device already discovered or discovering?)
* services - Failed to discover services (Is the device iOS?)
* characteristics - Failed to discover characteristics (Is the device iOS?)
* descriptors - Failed to discover descriptors (Is the device iOS?)
* service - Service doesn't exist (Was it discovered? Correct uuid? Is the device iOS?)
* characteristic - Characteristic doesn't exist (Was it discovered? Correct uuid? Is the device iOS?)
* descriptor - Descriptor doesn't exist (Was it discovered? Correct uuid? Is the device iOS?)
* read - Failed to read (Not sure what would cause this)
* subscription - Failed to subscribe or unsubscribe (Does the characteristic have the Client Configuration descriptor?)
* write - Failed to write (Was a write value provided?)
* readDescriptor - Failed to read descriptor (Not sure what would cause this)
* writeDescriptor - Failed to write descriptor (Was a write value provided?)
* rssi - Failed to read RSSI (Not sure what would cause this)
* mtu - Failed to set MTU (Is device Android?)
* requestConnectionPriority - Failed to request connection priority (Is the device iOS?)
* arguments - Invalid arguments (Check arguments)
* neverConnected - Device never connected (Call connect, not reconnect)
* isNotDisconnected - Device is not disconnected (Don't call connect or reconnect while connected)
* isNotConnected - Device isn't connected (Don't call discover or any read/write operations)
* isDisconnected - Device is disconnected (Don't call disconnect)
* isBonded - Operation is unsupported. (Is the device Android?)
* setPin - Operation is unsupported. (Is the device Android?)
* retrievePeripheralsByAddress - Operation is unsupported (Is the device iOS?)
For example:
javascript
{"error":"startScan", "message":"Scanning already started"}
`Permissions (Android) ##
Characteristics can have the following different permissions: read, readEncrypted, readEncryptedMITM, write, writeEncrypted, writeEncryptedMITM, writeSigned, writeSignedMITM. Unfortuately, the getProperties() call always seems to return 0, which means no properties are set. Not sure if this is an issue with my mobile device or that all the Bluetooth devices just don't have the properties set. If the characteristic has a permission, it will exist as a key in the characteristic's permissions object. See discovery().
Properties ##
Characteristics can have the following different properties: broadcast, read, writeWithoutResponse, write, notify, indicate, authenticatedSignedWrites, extendedProperties, notifyEncryptionRequired, indicateEncryptionRequired. If the characteristic has a property, it will exist as a key in the characteristic's properties object. See discovery() or characteristics()Central Life Cycle ##
1. initialize
2. scan (if device address is unknown)
3. connect
4. discover OR services/characteristics/descriptors (iOS)
5. read/subscribe/write characteristics AND read/write descriptors
6. disconnect
7. close
$3
Initialize Bluetooth on the device. Must be called before anything else. Callback will continuously be used whenever Bluetooth is enabled or disabled. Note: Although Bluetooth initialization could initially be successful, there's no guarantee whether it will stay enabled. Each call checks whether Bluetooth is disabled. If it becomes disabled, the user must connect to the device, start a read/write operation, etc again. If Bluetooth is disabled, you can request the user to enable it by setting the request property to true. The property in the params argument is optional and defaults to false. The restoreKey property requires using the Bluetooth Central background mode. This function should only be called once.`javascript
bluetoothle.initialize(initializeResult, params);
`##### Params #####
* request = true / false (default) - Should user be prompted to enable Bluetooth
* statusReceiver = true / false (default) - Should change in Bluetooth status notifications be sent.
* restoreKey = A unique string to identify your app. Bluetooth Central background mode is required to use this, but background mode doesn't seem to require specifying the restoreKey.
javascript
{
"request": true,
"statusReceiver": false,
"restoreKey" : "bluetoothleplugin"
}
`##### Success #####
* status => enabled = Bluetooth is enabled
* status => disabled = Bluetooth is disabled
javascript
{
"status": "enabled"
}
`$3
Enable Bluetooth on the device. Android support only.javascript
bluetoothle.enable(enableSuccess, enableError);
`##### Error #####
* errorDisable = Bluetooth isn't disabled, so unable to enable.
* errorEnable = Immediate failure of the internal enable() function due to Bluetooth already on or airplane mode, so unable to enable.
##### Success #####
The successCallback isn't actually used. Listen to initialize callbacks for change in Bluetooth state. A successful enable will return a status => enabled via initialize success callback.
$3
Disable Bluetooth on the device. Android support only.javascript
bluetoothle.disable(disableSuccess, disableError);
`##### Error #####
* errorEnable = Bluetooth isn't enabled, so unable to disable.
* errorDisable = Immediate failure of the internal disable() function due to Bluetooth already off, so unable to enable. This shouldn't occur since the plugin is already checking this condition anyways.
##### Success #####
The successCallback isn't actually used. Listen to initialize callbacks for change in Bluetooth state. A successful disable will return an error => enable via initialize error callback.
$3
Retrieve useful information such as the address, name, and various states (initialized, enabled, scanning, discoverable).
This can be very useful when the general state of the adapter has been lost, and we would otherwise need to go through a series of callbacks to get the correct state (first initialized, then enabled, then isScanning, and so forth).
The result of this method allows us to take business logic decisions while avoiding a large part of the callback hell.Currently the discoverable state does not have any relevance because there is no "setDiscoverable" functionality in place.
That may change in the future.
javascript
bluetoothle.getAdapterInfo(successCallback);
`##### Success #####
The successCallback contains the following properties:
* name = the adapters's display name
* address = the adapter's address
* isInitialized = boolean value, true if the adapter was initialized, otherwise false
* isEnabled = boolean value, true if the adapter was enabled, otherwise false
* isScanning = boolean value, true if the adapter is currently scanning, otherwise false
* isDiscoverable = boolean value, true if the adapter is in discoverable mode, otherwise false (currently largely false)
$3
Scan for Bluetooth LE devices. Since scanning is expensive, stop as soon as possible. The Cordova app should use a timer to limit the scan interval. Also, Android uses an AND operator for filtering, while iOS uses an OR operator. Android API >= 23 requires ACCESS_COARSE_LOCATION permissions to find unpaired devices. Permissions can be requested by using the hasPermission and requestPermission functions. Android API >= 23 also requires location services to be enabled. Use isLocationEnabled` to determine whether location services are enabled. If not enabled, use `requestLocation` to prompt the location services settings page. Android API >= 31 also requires BLUETOOTH_SCAN permissions to perform scanning. You can use `hasPermissionBtScan` to determine whether scanning permission is granted or use `requestPermissionBtScan` to prompt for it.`javascript
bluetoothle.startScan(startScanSuccess, startScanError, params);
`##### Params #####
* services = An array of service IDs to filter the scan or empty array / null. This parameter is not supported on Windows platform yet.
* iOS - See iOS Docs
* allowDuplicates = True/false to allow duplicate advertisement packets, defaults to false.
* Android - See Android Docs
* scanMode - Defaults to Low Power. Available from API21 / API 23.
* matchMode - Defaults to Aggressive. Available from API23.
* matchNum - Defaults to One Advertisement. Available from API23.
callbackType - Defaults to All Matches. Available from API21 / API 23. Note: Careful using this one. When using CALLBACK_TYPE_FIRST_MATCH on a Nexus 7 on API 21, I received a Feature Unsupported error when starting the scan.
* Windows 10 UWP
* isConnectable - Windows 10 will, by default, show all devices ever seen by the system, even if the device is off. If you want to only devices that are on and connectable, set this to true.
javascript
{
"services": [
"180D",
"180F"
],
"allowDuplicates": true,
"scanMode": bluetoothle.SCAN_MODE_LOW_LATENCY,
"matchMode": bluetoothle.MATCH_MODE_AGGRESSIVE,
"matchNum": bluetoothle.MATCH_NUM_MAX_ADVERTISEMENT,
"callbackType": bluetoothle.CALLBACK_TYPE_ALL_MATCHES,
}
`##### Success #####
* status => scanStarted = Scan has started
* status => scanResult = Scan has found a device
* name = the device's display name
* address = the device's address / identifier for connecting to the object
* rssi = signal strength
* advertisement = advertisement data in encoded string of bytes, use bluetoothle.encodedStringToBytes() (Android)
* advertisement = advertisement hash with the keys specified here (iOS)
* advertisement = empty (Windows)
javascript
{
"status": "scanStarted"
}{
"status": "scanResult",
"advertisement": "awArG05L", //Android
"advertisement": { //iOS
"serviceUuids": [
"180D"
],
"manufacturerData": "awAvFFZY",
"txPowerLevel": 0,
"overflowServiceUuids": [
],
"isConnectable": true,
"solicitedServiceUuids": [
],
"serviceData": {
},
"localName": "Polar H7 3B321015"
},
"rssi": -58,
"name": "Polar H7 3B321015",
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63"
}
`$3
Stop scan for Bluetooth LE devices. Since scanning is expensive, stop as soon as possible. The app should use a timer to limit the scanning time.javascript
bluetoothle.stopScan(stopScanSuccess, stopScanError);
`##### Success #####
* status => scanStop = Scan has stopped
javascript
{
"status": "scanStopped"
}
`$3
Retrieved paired Bluetooth LE devices. Yes, this function should be renamed, but I went with iOS's naming. In iOS, devices that are "paired" to will not return during a normal scan. Callback is "instant" compared to a scan. I haven't been able to get UUID filtering working on Android, so it returns all paired BLE devices.javascript
bluetoothle.retrieveConnected(retrieveConnectedSuccess, retrieveConnectedError, params);
`##### Params #####
* services = An array of service IDs to filter the retrieval by. If no service IDs are specified, no devices will be returned. Ignored on Android
javascript
{
"services": [
"180D",
"180F"
]
}
`##### Success #####
An array of device objects:
* name = the device's display name
* address = the device's address / identifier for connecting to the object
javascript
[
{
"name": "Polar H7 3B321015",
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63"
}
]
`$3
Bond with a device. The first success callback should always return with status == bonding`. If the bond is created, the callback will return again with `status == bonded`. If the bonding popup is canceled or the wrong code is entered, the callback will return again with `status == unbonded`. The device doesn't need to be connected to initiate bonding. Android support only.`javascript
bluetoothle.bond(bondSuccess, bondError, params);
`##### Params #####
* address = The address/identifier provided by the scan's return object
javascript
{
"address": "5A:94:4B:38:B3:FD"
}
`##### Success #####
* status => bonded = Device is bonded
* status => bonding = Device is bonding
* status => unbonded = Device is unbonded
javascript
{
"name": "Hello World",
"address": "5A:94:4B:38:B3:FD",
"status": "bonded"
}{
"name": "Hello World",
"address": "5A:94:4B:38:B3:FD",
"status": "bonding"
}
{
"name": "Hello World",
"address": "5A:94:4B:38:B3:FD",
"status": "unbonded"
}
`$3
Unbond with a device. The success callback should always return with status == unbonded`. The device doesn't need to be connected to initiate bonding. Android support only.`javascript
bluetoothle.unbond(unbondSuccess, unbondError, params);
`##### Params #####
* address = The address/identifier provided by the scan's return object
javascript
{
"address": "5A:94:4B:38:B3:FD"
}
`##### Success #####
* status => unbonded = Device is unbonded
javascript
{
"name": "Hello World",
"address": "5A:94:4B:38:B3:FD",
"status": "unbonded"
}
`$3
Connect to a Bluetooth LE device. The app should use a timer to limit the connecting time in case connecting is never successful. Once a device is connected, it may disconnect without user intervention. The original connection callback will be called again and receive an object with status => disconnected. To reconnect to the device, use the reconnect method. If a timeout occurs, the connection attempt should be canceled using disconnect(). For simplicity, I recommend just using connect() and close(), don't use reconnect() or disconnect(). Android API >= 31 requires BLUETOOTH_CONNECT permissions to connect to devices. You can use hasPermissionBtConnect` to determine whether connect permission is granted or use `requestPermissionBtConnect` to prompt for it.`javascript
bluetoothle.connect(connectSuccess, connectError, params);
`##### Params #####
* address = The address/identifier provided by the scan's return object
* autoConnect = Automatically connect as soon as the remote device becomes available (Android)
* transport = Mode of transport - Auto = 0, Prefer BR/EDR = 1, Prefer LE = 2, (Android API 23+)
javascript
{
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63"
}
`##### Success #####
* status => connected = Device connected
* status => disconnected = Device unexpectedly disconnected
javascript
{
"name": "Polar H7 3B321015",
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63",
"status": "connected"
}{
"name": "Polar H7 3B321015",
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63",
"status": "disconnected"
}
`$3
Reconnect to a previously connected Bluetooth device. The app should use a timer to limit the connecting time. If a timeout occurs, the reconnection attempt should be canceled using disconnect() or close().javascript
bluetoothle.reconnect(reconnectSuccess, reconnectError, params);
`##### Params #####
* address = The address/identifier provided by the scan's return object
javascript
{
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63"
}
`##### Success #####
* status => connected = Device connected
* status => disconnected = Device unexpectedly disconnected
javascript
{
"name": "Polar H7 3B321015",
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63",
"status": "connected"
}{
"name": "Polar H7 3B321015",
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63",
"status": "disconnected"
}
`
$3
Disconnect from a Bluetooth LE device. It's simpler to just call close().
Starting with iOS 10, disconnecting before closing seems required!javascript
bluetoothle.disconnect(disconnectSuccess, disconnectError, params);
`##### Params #####
* address = The address/identifier provided by the scan's return object
javascript
{
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63"
}
`##### Success #####
* status => disconnected = Device disconnected
javascript
{
"name": "Polar H7 3B321015",
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63",
"status": "disconnected"
}
`
$3
Close/dispose a Bluetooth LE device. Prior to 2.7.0, you needed to disconnect to the device before closing, but this is no longer the case.
Starting with iOS 10, disconnecting before closing seems required!javascript
bluetoothle.close(closeSuccess, closeError, params);
`##### Params #####
* address = The address/identifier provided by the scan's return object
javascript
{
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63"
}
`##### Success #####
* status => closed = Connection with device completely closed down
javascript
{
"name": "Polar H7 3B321015",
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63",
"status": "closed"
}
`$3
Discover all the devices services, characteristics and descriptors. Doesn't need to be called again after disconnecting and then reconnecting. If using iOS, you shouldn't use discover and services/characteristics/descriptors on the same device. There seems to be an issue with calling discover on iOS8 devices, so use with caution. On some Android versions, the discovered services may be cached for a device. Subsequent discover events will make use of this cache. If your device's services change, set the clearCache parameter to force Android to re-discover services.javascript
bluetoothle.discover(discoverSuccess, discoverError, params);
`##### Params #####
* address = The address/identifier provided by the scan's return object
* clearCache = true / false (default) Force the device to re-discover services, instead of relying on cache from previous discovery (Android only)
javascript
{
"address": "00:22:D0:3B:32:10",
"clearCache": true
}
`##### Return #####
Device Object:
* status => discovered = Device was discovered
* address = Device address
* name = Device name
* services = Array of service objects below
Service Object:
* uuid = Service's uuid
* characteristics = Array of characteristic objects below
Characteristic Object:
* uuid = Characteristic's uuid
* properties = If the property is defined as a key, the characteristic has that property
* permissions = If the permission is defined as a key, the character has that permission
* descriptors = Array of descriptor objects below
Descriptor Object:
* uuid = Descriptor's uuid
javascript
{
"address": "00:22:D0:3B:32:10",
"status": "discovered",
"services": [
{
"characteristics": [
{
"descriptors": [ ],
"uuid": "2a00", // Device Name
"properties": {
"write": true,
"writeWithoutResponse": true,
"read": true
}
},
{
"descriptors": [
],
"uuid": "2a01", // Appearance
"properties": {
"read": true
}
},
{
"descriptors": [
],
"uuid": "2a02", // Peripheral Privacy Flag
"properties": {
"read": true
}
},
{
"descriptors": [
],
"uuid": "2a03", // Reconnection Address
"properties": {
"write": true
}
},
{
"descriptors": [
],
"uuid": "2a04", // Pheripheral Preferred Connection Parameters
"properties": {
"read": true
}
}
],
"uuid": "1800" // Generic Access
},
{
"characteristics": [
{
"descriptors": [
{
"uuid": "2902"
}
],
"uuid": "2a05", // Service Changed
"properties": {
"indicate": true
}
}
],
"uuid": "1801" // Generic Attribute
},
{
"characteristics": [
{
"descriptors": [
{
"uuid": "2902"
}
],
"uuid": "2a37", // Heart Rate Measurement
"properties": {
"notify": true
}
},
{
"descriptors": [
],
"uuid": "2a38", // Body Sensor Location
"properties": {
"read": true
}
}
],
"uuid": "180d" // Heart Rate
},
{
"characteristics": [
{
"descriptors": [
],
"uuid": "2a23", // System ID
"properties": {
"read": true
}
},
{
"descriptors": [
],
"uuid": "2a24", // Model Number String
"properties": {
"read": true
}
},
{
"descriptors": [
],
"uuid": "2a25", // Serial Number String
"properties": {
"read": true
}
},
{
"descriptors": [
],
"uuid": "2a26", // Firmware Revision String
"properties": {
"read": true
}
},
{
"descriptors": [
],
"uuid": "2a27", // hardware Revision String
"properties": {
"read": true
}
},
{
"descriptors": [
],
"uuid": "2a28", // Software Revision String
"properties": {
"read": true
}
},
{
"descriptors": [
],
"uuid": "2a29", // Manufacturer Name String
"properties": {
"read": true
}
}
],
"uuid": "180a" // Device Information
},
{
"characteristics": [
{
"descriptors": [
],
"uuid": "2a19", // Battery Level
"properties": {
"read": true
}
}
],
"uuid": "180f" // Battery Service
},
{
"characteristics": [
{
"descriptors": [
],
"uuid": "6217ff4c-c8ec-b1fb-1380-3ad986708e2d",
"properties": {
"read": true
}
},
{
"descriptors": [
{
"uuid": "2902"
}
],
"uuid": "6217ff4d-91bb-91d0-7e2a-7cd3bda8a1f3",
"properties": {
"write": true,
"indicate": true
}
}
],
"uuid": "6217ff4b-fb31-1140-ad5a-a45545d7ecf3"
}
],
"name": "Polar H7 3B321015"
}
`$3
Discover the device's services. Not providing an array of services will return all services and take longer to discover. iOS support only.javascript
bluetoothle.services(servicesSuccess, servicesError, params);
`##### Params #####
* address = The address/identifier provided by the scan's return object
* services = An array of service IDs to filter the scan or empty array / null
javascript
{
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63",
"services": [ ]
}
`##### Success #####
* status => services = Services discovered
* services = Array of service UUIDS
javascript
{
"status": "services",
"services": [
"180d",
"180a",
"180f",
"6217ff4b-fb31-1140-ad5a-a45545d7ecf3"
],
"name": "Polar H7 3B321015",
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63"
}
`$3
Discover the service's characteristics. Not providing an array of characteristics will return all characteristics and take longer to discover. iOS support only.javascript
bluetoothle.characteristics(characteristicsSuccess, characteristicsError, params);
`##### Params #####
* address = The address/identifier provided by the scan's return object
* service = Service UUID
* characteristics = An array of characteristic IDs to discover or empty array / null
javascript
{
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63",
"service": "180d",
"characteristics": [ ]
}
`##### Success #####
* status => characteristics = Characteristics discovered
* uuid = Service UUID
* characteristics = Array of characteristics
* properties = Object of defined properties
* uuid = Characteristic UUID
javascript
{
"status": "characteristics",
"characteristics": [
{
"properties": {
"notify": true
},
"uuid": "2a37"
},
{
"properties": {
"read": true
},
"uuid": "2a38"
}
],
"name": "Polar H7 3B321015",
"service": "180d",
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63"
}
`$3
Discover the characteristic's descriptors. iOS support only.javascript
bluetoothle.descriptors(descriptorsSuccess, descriptorsError, params);
`##### Params #####
* address = The address/identifier provided by the scan's return object
* service = The service's ID
* characteristic = The characteristic's ID
javascript
{
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63",
"service": "180d",
"characteristic": "2a37"
}
`##### Success #####
* status => descriptors = Descriptors discovered
* service = Service UUID
* characteristic = characteristic UUID
* descriptors = Array of Descriptor UUIDs
javascript
{
"status": "descriptors",
"descriptors": [
"2902"
],
"characteristic": "2a37",
"name": "Polar H7 3B321015",
"service": "180d",
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63"
}
`$3
Read a particular service's characteristic once.javascript
bluetoothle.read(readSuccess, readError, params);
`##### Params #####
* address = The address/identifier provided by the scan's return object
* service = The service's UUID
* serviceIndex = When dealing with multiple services with the same UUID, this index will determine which service will be used (OPTIONAL)
* characteristic = The characteristic's UUID
* characteristicIndex = When dealing with multiple characteristics with the same UUID, this index will determine which chracteristic will be used (OPTIONAL)
javascript
{
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63",
"service": "180d",
"characteristic": "2a38"
}
`##### Success #####
* status => read = Characteristics read
* service = Service UUID
* characteristic = Characteristic UUID
* value = Base64 encoded string of bytes. Use bluetoothle.encodedStringToBytes(obj.value) to convert to a unit8Array. See characteristic's specification and example below on how to correctly parse this.
javascript
{
"status": "read",
"value": "UmVhZCBIZWxsbyBXb3JsZA==", //Read Hello World
"characteristic": "2a38",
"name": "Polar H7 3B321015",
"service": "180d",
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63"
}
`
$3
Subscribe to a particular service's characteristic. Once a subscription is no longer needed, execute unsubscribe in a similar fashion. The Client Configuration descriptor will automatically be written to enable notification/indication based on the characteristic's properties.javascript
bluetoothle.subscribe(subscribeSuccess, subscribeError, params);
`##### Params #####
* address = The address/identifier provided by the scan's return object
* service = The service's UUID
* serviceIndex = When dealing with multiple services with the same UUID, this index will determine which service will be used (OPTIONAL)
* characteristic = The characteristic's UUID
* characteristicIndex = When dealing with multiple characteristics with the same UUID, this index will determine which chracteristic will be used (OPTIONAL)
javascript
{
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63",
"service": "180d",
"characteristic": "2a37",
}
`##### Success #####
* status => subscribed = Subscription has started
* status => subscribedResult = Subscription result has been received
* service = Service UUID
* characteristic = Characteristic UUID
* value = Base64 encoded string of bytes. Use bluetoothle.encodedStringToBytes(obj.value) to convert to a unit8Array. See characteristic's specification and example below on how to correctly parse this.
javascript
{
"status": "subscribed",
"characteristic": "2a37",
"characteristicIndex": 0,
"name": "Polar H7 3B321015",
"service": "180d",
"serviceIndex": 0,
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63"
}{
"status": "subscribedResult",
"value": "U3Vic2NyaWJlIEhlbGxvIFdvcmxk", //Subscribe Hello World
"characteristic": "2a37",
"characteristicIndex": 0,
"name": "Polar H7 3B321015",
"service": "180d",
"serviceIndex": 0,
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63"
}
`$3
Unsubscribe to a particular service's characteristic.javascript
bluetoothle.unsubscribe(unsubscribeSuccess, unsubscribeError, params);
`##### Params #####
* address = The address/identifier provided by the scan's return object
* service = The service's UUID
* serviceIndex = When dealing with multiple services with the same UUID, this index will determine which service will be used (OPTIONAL)
* characteristic = The characteristic's UUID
* characteristicIndex = When dealing with multiple characteristics with the same UUID, this index will determine which chracteristic will be used (OPTIONAL)
javascript
{
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63",
"service": "180d",
"characteristic": "2a37"
}
`##### Success #####
* status => unsubscribed = Characteristics unsubscribed
* service = Service UUID
* characteristic = Characteristic UUID
javascript
{
"status": "unsubscribed",
"characteristic": "2a37",
"name": "Polar H7 3B321015",
"service": "180d",
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63"
}
`$3
Write a particular service's characteristic.javascript
bluetoothle.write(writeSuccess, writeError, params);
`##### Params #####
* address = The address/identifier provided by the scan's return object
* service = The service's UUID
* serviceIndex = When dealing with multiple services with the same UUID, this index will determine which service will be used (OPTIONAL)
* characteristic = The characteristic's UUID
* characteristicIndex = When dealing with multiple characteristics with the same UUID, this index will determine which chracteristic will be used (OPTIONAL)
* value = Base64 encoded string
* type = Set to "noResponse" to enable write without response, all other values will write normally.
Value is a base64 encoded string of bytes to write. Use bluetoothle.bytesToEncodedString(bytes) to convert to base64 encoded string from a unit8Array.
To write without response, set type to "noResponse". Any other value will default to write with response. Note, no callback will occur on write without response on iOS.
javascript
var string = "Write Hello World";
var bytes = bluetoothle.stringToBytes(string);
var encodedString = bluetoothle.bytesToEncodedString(bytes);
// if your code includes special characters you should use the encodeUnicode helper function
var encodedUnicodeString = bluetoothle.encodeUnicode(string);//Note, this example doesn't actually work since it's read only characteristic
{"value":"V3JpdGUgSGVsbG8gV29ybGQ=","service":"180F","characteristic":"2A19","type":"noResponse","address":"ABC123"}
`##### Success #####
Value is a base64 encoded string of written bytes. Use bluetoothle.encodedStringToBytes(obj.value) to convert to a unit8Array. See characteristic's specification and example below on how to correctly parse this.
javascript
var returnObj = {"status":"written","service":"180F","characteristic":"2A19","value":"V3JpdGUgSGVsbG8gV29ybGQ=","address":"ABC123"}
var bytes = bluetoothle.encodedStringToBytes(returnObj.value);
var string = bluetoothle.bytesToString(bytes); //This should equal Write Hello World// if your code includes special characters you should use the decodeUnicode helper function
var string = bluetoothle.decodeUnicode(returnObj.value);
`$3
Write Quick / Queue, use this method to quickly execute write without response commands when writing more than 20 bytes at a time. The data will automatically be split up into 20 bytes packets by default or you can increase that by setting . On iOS, these packets are written immediately since iOS uses queues. You probably won't see much of a performance increase using writeQ unless you use type="noResponse" and set chunkSize higher than 20. On Android, a queue isn't used internally. Instead another call shouldn't be made until onCharacteristicWrite is called. This could be done at the Javascript layer, but the Javascript to plugin "bridge" must be crossed twice, which leads to some significant slow downs when milliseconds make a difference. For even better write throughput, use requestConnectionPriority('high') and mtu(SAME_VALUE_AS_CHUNK_SIZE_PARAM) as well.Warnings
* This is experimental. Test heavily before using in any production code.
* To see a performance gain you should use this in combination with requestConnectionPriority('high') and mtu(
MTU_VALUE) and then calling this method with type="noResponse" and set chunkSize to MTU_VALUE.
* Only supported on iOS11+.
* Only supports one call at a time. Don't execute back to back, use on multiple devices, or multiple characteristics.`javascript
bluetoothle.writeQ(writeSuccess, writeError, params);
`##### Params #####
* address = The address/identifier provided by the scan's return object
* service = The service's UUID
* serviceIndex = When dealing with multiple services with the same UUID, this index will determine which service will be used (OPTIONAL)
* characteristic = The characteristic's UUID
* characteristicIndex = When dealing with multiple characteristics with the same UUID, this index will determine which chracteristic will be used (OPTIONAL)
* value = Base64 encoded string
* type = Set to "noResponse" to enable write without response, all other values will write normally.
* chunkSize = Define the size of packets. This should be according to MTU value
##### Success #####
See write() above.
$3
Read a particular characterist's descriptorjavascript
bluetoothle.read(readDescriptorSuccess, readDescriptorError, params);
`##### Params #####
* address = The address/identifier provided by the scan's return object
* service = The service's ID
* characteristic = The characteristic's ID
* descriptor = The descriptor's ID
javascript
{
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63",
"service": "180d",
"characteristic": "2a37",
"descriptor": "2902"
}
`##### Success #####
* status => readDescriptor = Descriptor was read
* service = Service UUID
* characteristic = Characteristic UUID
* descriptor = Descriptor UUID
* value = Base64 encoded string of bytes. Use bluetoothle.encodedStringToBytes(obj.value) to convert to a unit8Array.
javascript
{
"status": "readDescriptor",
"service": "180d",
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63",
"characteristic": "2a37",
"value": "AQAAAAAAAAA=",
"name": "Polar H7 3B321015",
"descriptor": "2902"
}
`$3
Write a particular characteristic's descriptor. Unable to write characteristic configuration directly to keep in line with iOS implementation. Instead use subscribe/unsubscribe, which will automatically enable/disable notification.javascript
bluetoothle.writeDescriptor(writeDescriptorSuccess, writeDescriptorError, params);
`##### Params #####
* address = The address/identifier provided by the scan's return object
* service = The service's ID
* characteristic = The characteristic's ID
* descriptor = The descriptor's ID
* value - Base64 encoded string, number or string.
* type - Specifies type (data, number or string). Default is base64. (iOS Only, use base64 encoded string for Android)
Value is a base64 encoded string of bytes to write. Use bluetoothle.bytesToEncodedString(bytes) to convert to base64 encoded string from a unit8Array.
javascript
var string = "Hello World";
var bytes = bluetoothle.stringToBytes(string);
var encodedString = bluetoothle.bytesToEncodedString(bytes);{"service":"180D","characteristic":"2A37","descriptor":"2902","value":"AQAAAAAAAAA=","address":"ABC123"}
`##### Success #####
Value is a base64 encoded string of written bytes. Use bluetoothle.encodedStringToBytes(obj.value) to convert to a unit8Array.
javascript
{"status":"writeDescriptor","service":"180D","characteristic":"2A37", "descriptor":"2902","value":"AQAAAAAAAAA=","address":"ABC123"}
var bytes = bluetoothle.encodedStringToBytes(returnObj.value);
var string = bluetoothle.bytesToString(bytes); //This should equal Hello World!
`$3
Read RSSI of a connected device. RSSI is also returned with scanning.javascript
bluetoothle.rssi(rssiSuccess, rssiError, params);
`#### Params ####
* address = The address/identifier provided by the scan's return object
javascript
{
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63"
}
`##### Success #####
* status => rssi = RSSI retrieved
* rssi = signal strength
javascript
{
"status": "rssi",
"rssi": -50,
"name": "Polar H7 3B321015",
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63"
}
`
$3
Set MTU of a connected device. Android only.javascript
bluetoothle.mtu(mtuSuccess, mtuError, params);
`#### Params ####
* address = The address/identifier provided by the scan's return object
* mtu - Integer value mtu should be set to
javascript
{
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63",
"mtu" : 50
}
`##### Success #####
* status => mtu = MTU set
* mtu = mtu value
javascript
{
"status": "mtu",
"mtu": 50,
"name": "Polar H7 3B321015",
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63"
}
`$3
Request a change in the connection priority to improve throughput when transfer large amounts of data via BLE. Android support only. iOS will return error.javascript
bluetoothle.requestConnectionPriority(success, error, params);
`#### Params ####
* address = The address/identifier provided by the scan's return object
* connectionPriority = low / balanced / high
javascript
{
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63",
"connectionPriority" : "balanced"
}
`##### Success #####
* status => connectionPriorityRequested = true
javascript
{
"name": "Polar H7 3B321015",
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63",
"status" : "connectionPriorityRequested"
}
`$3
Determine whether the adapter is initialized. No error callback. Returns true or falsejavascript
bluetoothle.isInitialized(isInitialized);
`##### Success Return #####
* status => isInitialized = true/false
javascript
{
"isInitialized": true
}
`
$3
Determine whether the adapter is enabled. No error callbackjavascript
bluetoothle.isEnabled(isEnabled);
`##### Success #####
* status => isEnabled = true/false
javascript
{
"isEnabled": true
}
`$3
Determine whether the adapter is initialized. No error callback. Returns true or falsejavascript
bluetoothle.isScanning(isScanning);
`##### Return #####
* status => isScanning = true/false
javascript
{
"isScanning": false
}
`$3
Determine whether the device is bonded or not, or error if not initialized. Android support only.javascript
bluetoothle.isBonded(isBondedSuccess, isBondedError, params);
`#### Params ####
* address = The address/identifier provided by the scan's return object
javascript
{
"address": "5A:94:4B:38:B3:FD"
}
`##### Success #####
* status => isBonded = true/false
javascript
{
"name": "Polar H7 3B321015",
"address": "5A:94:4B:38:B3:FD",
"isBonded": false
}
`$3
Set PIN if required by the pairing process. Android support only.javascript
bluetoothle.setPin(success, error, params);
`#### Params ####
* address = The address/identifier provided by the scan's return object
* pin = Pairing PIN code
javascript
{
"address": "5A:94:4B:38:B3:FD",
"pin": "1234"
}
`##### Success #####
* status => string
javascript
{
"status": "pinSet",
}
`$3
Determine whether the device was connected, or error if not initialized.javascript
bluetoothle.wasConnected(wasConnectedSuccess, wasConnectedError, params);
`#### Params ####
* address = The address/identifier provided by the scan's return object
javascript
{
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63"
}
`##### Success #####
* status => wasConnected = true/false
javascript
{
"name": "Polar H7 3B321015",
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63",
"wasConnected": false
}
`$3
Determine whether the device is connected, or error if not initialized or never connected to device.javascript
bluetoothle.isConnected(isConnectedSuccess, isConnectedError, params);
`#### Params ####
* address = The address/identifier provided by the scan's return object
javascript
{
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63"
}
`##### Success #####
* status => isConnected = true/false
javascript
{
"name": "Polar H7 3B321015",
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63",
"isConnected": false
}
`$3
Determine whether the device's characteristics and descriptors have been discovered, or error if not initialized or not connected to device. Note, on Android, you can connect, discover and then disconnect. isDiscovered will return an error due to the device not being connected. But if you call reconnect and call isDiscovered again, it will return isDiscovered => true since the device stays discovered until calling close().javascript
bluetoothle.isDiscovered(isDiscoveredSuccess, isDiscoveredError, params);
`#### Params ####
* address = The address/identifier provided by the scan's return object
javascript
{
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63"
}
`##### Success #####
* status => isDiscovered = true/false
javascript
{
"name": "Polar H7 3B321015",
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63",
"isDiscovered": false
}
`$3
Determine whether coarse location privileges are granted since scanning for unpaired devices requies it in Android API 23javascript
bluetoothle.hasPermission(hasPermissionSuccess);
`##### Success #####
* status => hasPermission = true/false
javascript
{
"hasPermission": true
}
`$3
Request coarse location privileges since scanning for unpaired devices requires it in Android API 23. Will return an error if called on iOS or Android versions prior to 6.0.javascript
bluetoothle.requestPermission(requestPermissionSuccess, requestPermissionError);
`##### Success #####
* status => requestPermission = true/false
javascript
{
"requestPermission": true
}
`$3
Determine whether Bluetooth scanning privileges are granted since scanning for unpaired devices requies it in Android API 31javascript
bluetoothle.hasPermissionBtScan(hasPermissionSuccess);
`##### Success #####
* status => hasPermission = true/false
javascript
{
"hasPermission": true
}
`$3
Request Bluetooth scanning privileges since scanning for unpaired devices requires it in Android API 31. Will return an error if called on iOS or Android versions prior to 6.0.javascript
bluetoothle.requestPermissionBtScan(requestPermissionSuccess, requestPermissionError);
`##### Success #####
* status => requestPermission = true/false
javascript
{
"requestPermission": true
}
`$3
Determine whether Bluetooth connect privileges are granted since connecting to unpaired devices requies it in Android API 31javascript
bluetoothle.hasPermissionBtConnect(hasPermissionSuccess);
`##### Success #####
* status => hasPermission = true/false
javascript
{
"hasPermission": true
}
`$3
Request Bluetooth connect privileges since connecting to unpaired devices requires it in Android API 31. Will return an error if called on iOS or Android versions prior to 6.0.javascript
bluetoothle.requestPermissionBtConnect(requestPermissionSuccess, requestPermissionError);
`##### Success #####
* status => requestPermission = true/false
javascript
{
"requestPermission": true
}
`$3
Determine whether Bluetooth advertise privileges are granted since making the current device discoverable requies it in Android API 31javascript
bluetoothle.hasPermissionBtAdvertise(hasPermissionSuccess);
`##### Success #####
* status => hasPermission = true/false
javascript
{
"hasPermission": true
}
`$3
Request Bluetooth advertise privileges since making the current device discoverable requires it in Android API 31. Will return an error if called on iOS or Android versions prior to 6.0.javascript
bluetoothle.requestPermissionBtAdvertise(requestPermissionSuccess, requestPermissionError);
`##### Success #####
* status => requestPermission = true/false
javascript
{
"requestPermission": true
}
`$3
Determine if location services are enabled or not. Location Services are required to find devices in Android API 23.javascript
bluetoothle.isLocationEnabled(isLocationEnabledSuccess, isLocationEnabledError);
`##### Success #####
* status => isLocationEnabled = true/false
javascript
{
"isLocationEnabled": true
}
`$3
Prompt location services settings pages. requestLocation` property returns whether location services are enabled or disabled. Location Services are required to find devices in Android API 23.`javascript
bluetoothle.requestLocation(requestLocationSuccess, requestLocationError);
`##### Success #####
* status => requestLocation = true/false
javascript
{
"requestLocation": true
}
`$3
Retrieve paired Bluetooth LE devices based on their address. Wraps the iOS method CBCentralManager.retrievePeripheralsWithIdentifiers. iOS support only. Will return an error if used on Android.javascript
bluetoothle.retrievePeripheralsByAddress(success, error, params);
`##### Params #####
* addresses = An arrays of addresses/identifiers to lookup devices by. If no addresses are specified, no devices will be returned
javascript
{
"addresses": ["ECC037FD-72AE-AFC5-9213-CA785B3B5C63"]
}
`##### Success #####
Returns an array of device objects:
* name = the device's display name
* address = the device's address / identifier for connecting to the object
javascript
[
{
"name": "Polar H7 3B321015",
"address": "ECC037FD-72AE-AFC5-9213-CA785B3B5C63"
}
]
``1. initializePeripheral
2. addService
3.