react-native-ble-plx: A Swift repository from lukefanning

About this library

This is React Native Bluetooth Low Energy library using RxBluetoothKit and RxAndroidBle under the hood.

It supports:

What this library does NOT support:

turning the device's Bluetooth adapter on
communicating between phones using BLE (Peripheral support)
bonding peripherals

Recent Changes

0.10.0

Breaking changes:

Deprecate old build system. Carthage is not required anymore. To fix your current project please do following steps:
1. Add empty Swift file if you don't have at least one:
  - Select File/New/File...
  - Choose Swift file and click Next.
  - Name it however you want, select your targets and create it.
  - Accept to create Objective-C bridging header.
2. Remove copy-frameworks script if you don't have any other dependency requiring it:
  - Go to Your Target / Build Phases
  - Remove run script.

Other:

Fix warning when no listeners were attached and events were emitted.
Show error.message properly. Make sure that invalid errorCodes from implementation side won't trigger another error during construction.
Property ServiceUUID is properly propagated to IncludedServicesDiscoveryFailed's error message.
Add missing deviceServicesNotDiscovered implementation on Android.

All previous changes

Documentation & Support

Interested in React Native project involving Bluetooth Low Energy? We can help you!

Documentation can be found here.

Configuration & Installation

iOS (pure react-native)

npm install --save react-native-ble-plx
react-native link react-native-ble-plx
Add empty Swift file if you don't have at least one:
- Select File/New/File...
- Choose Swift file and click Next.
- Name it however you want, select your targets and create it.
- Accept to create Objective-C bridging header.
Minimal supported version of iOS is 8.0
If you want to support background mode:
- In your application target go to Capabilities tab and enable Uses Bluetooth LE Accessories in Background Modes section.
- Pass restoreStateIdentifier and restoreStateFunction to BleManager constructor.

iOS (expo/Podfile)

Make sure your Expo project is detached. You can read how to do it here and here.
npm install --save react-native-ble-plx
react-native link react-native-ble-plx
Add empty Swift file if you don't have at least one:
- Select File/New/File...
- Choose Swift file and click Next.
- Name it however you want, select your application target and create it.
- Accept to create Objective-C bridging header.

Update your ios/Podfile to contain:

pod 'react-native-ble-plx', :path => '../node_modules/react-native-ble-plx'
pod 'react-native-ble-plx-swift', :path => '../node_modules/react-native-ble-plx'

Enter ios folder and run pod update
Minimal supported version of iOS is 8.0
If you want to support background mode:
- In your application target go to Capabilities tab and enable Uses Bluetooth LE Accessories in Background Modes section.
- Pass restoreStateIdentifier and restoreStateFunction to BleManager constructor.

Android

npm install --save react-native-ble-plx
react-native link react-native-ble-plx
In build.gradle of app module make sure that min SDK version is at least 18:

android {
    ...
    defaultConfig {
        minSdkVersion 18
        ...

In AndroidManifest.xml, add Bluetooth permissions and update <uses-sdk/>:

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    ...
    <uses-permission android:name="android.permission.BLUETOOTH"/>
    <uses-permission android:name="android.permission.BLUETOOTH_ADMIN"/>
    <uses-permission-sdk-23 android:name="android.permission.ACCESS_COARSE_LOCATION"/>

    <!-- Add this line if your application always requires BLE. More info can be found on:
         https://developer.android.com/guide/topics/connectivity/bluetooth-le.html#permissions
      -->
    <uses-feature android:name="android.hardware.bluetooth_le" android:required="true"/>

    <uses-sdk
        android:minSdkVersion="18"
        ...

Troubleshooting

Problems with Proguard

Add this to your app/proguard-rules.pro

-dontwarn com.polidea.reactnativeble.**

lukefanning/react-native-ble-plx