react-native-ble-plx

React Native Bluetooth Low Energy library

Usage no npm install needed!

<script type="module">
  import reactNativeBlePlx from 'https://cdn.skypack.dev/react-native-ble-plx';
</script>

README

react-native-ble-plx library logo

About this library

This is React Native Bluetooth Low Energy library wrapping Multiplatform Ble Adapter.

It supports:

It does NOT support:

  • bluetooth classic devices.
  • communicating between phones using BLE (Peripheral support)
  • bonding peripherals

Compatibility

This version (2.x) breaks compatibility with old RN versions. Please check old README (1.x) for the old instructions or migration guide.

React Native 2.0.0
0.63.3 :white_check_mark:
0.62.2 :white_check_mark:
0.61.5 :white_check_mark:
0.60.6 :white_check_mark:

Recent Changes

2.0.2

  • Updated MultiplatformBleAdapter to version 0.1.7.
  • Added support for BleMulator
  • Removed destroying of client upon catalystInstanceDestroy.
  • Updated CI to RN 0.63.3

All previous changes

Documentation & Support

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

Documentation can be found here.

Quick introduction can be found here

Contact us at intent.

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

Configuration & Installation

Expo

  1. Make sure your Expo project is ejected (formerly: detached). You can read how to do it here and here. (only for expo)
  2. Follow steps for iOS/Android.

iOS (example setup)

  1. npm install --save react-native-ble-plx
  2. Enter ios folder and run pod update
  3. Add NSBluetoothAlwaysUsageDescription in info.plist file. (it is a requirement since iOS 13)
  4. 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 (example setup)

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

  2. In top level build.gradle make sure that min SDK version is at least 18:

    buildscript {
    ext {
        ...
        minSdkVersion = 18
        ...

  3. In build.gradle make sure to add jitpack repository to known repositories:

    allprojects {
    repositories {
      ...
      maven { url 'https://www.jitpack.io' }
    }
}

  4. (Optional) 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_FINE_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"/>

    ...

Troubleshooting

Problems with Proguard

Add this to your app/proguard-rules.pro

-dontwarn com.polidea.reactnativeble.**