Swiftpack.co - Package - Polidea/react-native-ble-plx

react-native-ble-plx library logo

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:

Compatibility

| React Native | 1.0.3 | 1.1.0 | | ------------- | ------------------------------ | ------------------------------ | | 0.60.5 | :white_check_mark:2 | :white_check_mark:2 | | 0.59.10 | :white_check_mark: | :white_check_mark: | | 0.58.6 | :white_check_mark: | :white_check_mark: | | 0.57.8 | :white_check_mark: | :white_check_mark: | | 0.56.1 | :boom:1 | :boom:1 | | 0.55.4 | :boom:1 | :boom:1 |

1 fails on Android, although might work after updating gradle

2 may require usage of jetifier on Android and migration to CocoaPods on iOS.

Recent Changes

1.1.0

  • Add support for descriptors.
  • Fix XCode 11 compilation error.

All previous changes

Documentation & Support

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

Learn more about Polidea's BLE services here.

Documentation can be found here.

Contact us at Gitter if you have any questions, feedback or want to help!

Configuration & Installation

iOS (expo/Podfile and RN 0.60+, example setup)

  1. Make sure your Expo project is ejected (formerly: detached). You can read how to do it here and here. (only for expo)
  2. npm install --save react-native-ble-plx
  3. react-native link react-native-ble-plx
  4. Open Xcode workspace located inside ios folder and 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.
  5. 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'
    
  6. Enter ios folder and run pod update
  7. Minimal supported version of iOS is 8.0
  8. 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.
  9. Starting from iOS 13 add NSBluetoothAlwaysUsageDescription in info.plist file.

iOS (react-native < 0.60, example setup)

  1. npm install --save react-native-ble-plx

  2. react-native link react-native-ble-plx

  3. Open Xcode project located inside ios folder and 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.
  4. Minimal supported version of iOS is 8.0

  5. 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.
  6. Starting from iOS 13 add NSBluetoothAlwaysUsageDescription in info.plist file.

Android (example setup)

  1. npm install --save react-native-ble-plx
  2. react-native link react-native-ble-plx
  3. In build.gradle of app module make sure that min SDK version is at least 18:
android {
    ...
    defaultConfig {
        minSdkVersion 18
        ...
  1. 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"
        ...
  1. If you are using AndroidX, then for the time being you need to convert import statements in the Android library with jetifier. These steps apply for all react-native packages, which are during the transition period:
  • npm install --save-dev jetifier
  • Run jetify script after npm install. You can do it by adding "postinstall" script to the package.json file:
     ...
     "postinstall": "npx jetify",
     ...
    

Troubleshooting

Problems with Proguard

Add this to your app/proguard-rules.pro

-dontwarn com.polidea.reactnativeble.**

Github

link
Stars: 1500
Help us keep the lights on

Dependencies

Used By

Total: 0

Releases

1.1.0 - Sep 12, 2019

  • Add support for descriptors.
  • Fix XCode 11 compilation error.

1.0.3 - Feb 22, 2019

  • Integrated Travis CI to test library and check its integration with multiple RN versions.
  • Library's build.gradle prefers buildToolsVersion, compileSdkVersion & targetSdkVersion specified in rootProject.
  • Added Typescript definitions.
  • Removed outdated example project.
  • Updated dev dependencies and the README file.

1.0.2 - Feb 4, 2019

  • Fix build error due to RN 58 changes.
  • Allow registering for notifications and indications on Android despite CCC descriptor being absent.

1.0.1 - Feb 4, 2019

  • Fix possible ConcurrentModificationException in Android BleModule.
  • Workaround for when canSendWriteWithoutResponse would return false on iOS.
  • Fixed low severity vulnerabilities reported by npm in development dependencies.

1.0.0 - Feb 4, 2019

Breaking changes

  • Moved to Gradle plugin 3.1.4 and Gradle wrapper to 4.4 (RN 57+ required) on Android.

Other:

  • Added requestConnectionPriority function which increases or decreases connection interval setting on Android Lollipop devices or above.
  • Added connectionPriority option to connection options which calls above function just after the connection is established.
  • Added scanMode and callbackType properties to scan options for Android.
  • Added enable and disable functions to enable/disable Bluetooth on Android.
  • Added optional transactionId argument to discoverAllServicesAndCharacteristicsForDevice.
  • Added errorCodesToMessagesMapping property to BleManagerOptions to be able to override custom BleError messages.
  • Updated cancelDeviceConnection documentation.
  • Don't call CBCentralManager's stopScan, when Bluetooth is powered off in internal implementation on iOS.
  • Clean iOS compiler warnings on XCode10.
  • Changed scan record logging from Debug to Verbose on iOS.
  • Updated writeWithoutResponse implementation on iOS to use canSendWriteWithoutResponse if available starting from iOS 11.
  • Updated library's development dependencies.
  • Fixed cyclic import warnings.
  • Fixed notification/indication subscription moment. Events are monitored before CCC is written on Android.