node package manager
Easy sharing. Manage teams and permissions with one click. Create a free org »

react-native-ble-plx

react-native-ble-plx

React Native Bluetooth Low Energy library using RxBluetoothKit and RxAndroidBle as it's backend libraries.

Example apps are available in Google Play and App Store!

GooglePlay AppStore


NPM


Recent Changes

0.7.0

Breaking changes:

  • Migrate to Swift 4 (now requires XCode 9 or higher)
  • Fixed spelling mistake characteristic.isIndictable is now characteristic.isIndicatable.

Other:

  • Fixed potential memory leaks in iOS native module.
  • Fixed an issue when successive scans could stop emitting scanned devices.
  • Removed bash dependency in postinstall script.
  • Use --cache-builds option only when specific version of carthage is available.
  • Remove --no-build option to be able to reuse prepackages frameworks.
  • Added option to disable building dynamic frameworks with carthage by setting option in your app's package.json:
    ...
    "react-native-ble-plx"{
      "carthage": false
    }
    ...

All previous changes

Documentation & Support

Documentation can be found here.

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

Configuration & Installation

Important

If you do not have Carthage installed yet and wish to set up for iOS, please install it first and only then follow the steps given below

Automatically

npm install --save react-native-ble-plx
react-native link react-native-ble-plx

Both on iOS and Android continue manually from step 7.

Manually

iOS

  1. Add react-native-ble-plx to a project as a dependency in package.json file. For example "react-native-ble-plx": "Polidea/react-native-ble-plx" will install latest version from Polidea's Github repository.
  2. Make sure that you have Carthage installed on your system.
  3. Execute npm install to fetch and install a library.
  4. Open iOS project located in ./ios folder.
  5. Move BleClient.xcodeproj located in .node_modules/react-native-ble-plx/ios using drag & drop to Libraries folder in your project.
  6. In general settings of a target add libBleClient.a to Linked Frameworks and Libraries.
  7. In Build Settings/Search Paths/Framework search paths add path: $(SRCROOT)/../node_modules/react-native-ble-plx/ios/BleClientManager/Carthage/Build/iOS.
  8. In Build Settings/Build Options/Always Embed Swift Standard Libraries set to Yes.
  9. In Build Phases click on top left button and add New Run Script Phase.
  • Shell command: /usr/local/bin/carthage copy-frameworks
  • Input Files:
    • $(SRCROOT)/../node_modules/react-native-ble-plx/ios/BleClientManager/Carthage/Build/iOS/BleClientManager.framework
    • $(SRCROOT)/../node_modules/react-native-ble-plx/ios/BleClientManager/Carthage/Build/iOS/RxSwift.framework
    • $(SRCROOT)/../node_modules/react-native-ble-plx/ios/BleClientManager/Carthage/Build/iOS/RxBluetoothKit.framework
  1. Minimal supported version of iOS is 8.0
  2. 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

  1. Add react-native-ble-plx to a project as a dependency in package.json file. For example "react-native-ble-plx": "Polidea/react-native-ble-plx" will install latest version from Polidea's Github repository.
  2. Execute npm install to fetch and install a library.
  3. Open Android project located in ./android folder.
  4. In settings.gradle add following lines:
include ':react-native-ble-plx'
project(':react-native-ble-plx').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-ble-plx/android')
  1. In MainApplication.getPackages import and add BleModule package:
import com.polidea.reactnativeble.BlePackage;
...
 
public class MainApplication extends Application implements ReactApplication {
    ...
 
    @Override
    protected List<ReactPackage> getPackages() {
      return Arrays.<ReactPackage>asList(
        new MainReactPackage(),
        new BlePackage()
      );
}
  1. In build.gradle of app module add following dependency:
dependencies {
   ...
   compile project(':react-native-ble-plx')
   ...
  1. Additionaly 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"
        ...

Troubleshooting

Problems with Proguard

Add this to your app/proguard-rules.pro

-dontwarn com.polidea.reactnativeble.**