react-native-ble-manager

react-native-ble-manager

This is a porting of https://github.com/don/cordova-plugin-ble-central project to React Native.

##Supported Platforms

• iOS
• Android (API 18)

##Install

npm i --save react-native-ble-manager

####iOS

• Open the node_modules/react-native-ble-manager/ios folder and drag BleManager.xcodeproj into your Libraries group.
• Check the "Build Phases"of your project and add "libBleManager.a" in the "Link Binary With Libraries" section.

####Android #####Update Gradle Settings

// file: android/settings.gradle
...

include ':react-native-ble-manager'
project(':react-native-ble-manager').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-ble-manager/android')

#####Update Gradle Build

// file: android/app/build.gradle
...

dependencies {
    ...
    compile project(':react-native-ble-manager')
}

#####Register React Package

...
import it.innove.BleManagerPackage; // <--- import

public class MainActivity extends ReactActivity {

    ...

    @Override
    protected List<ReactPackage> getPackages() {
        return Arrays.<ReactPackage>asList(
            new MainReactPackage(),
            new BleManagerPackage(this) // <------ add the package
        );
    }

    ...
}

##Methods

scan(serviceUUIDs, seconds)

Scan for availables peripherals. Returns a Promise object.

Arguments

• serviceUUIDs - Array of String - the UUIDs of the services to looking for.
• seconds - Integer - the amount of seconds to scan.

Examples

BleManager.scan([], 5)
  .then(() => {
    // Success code
    console.log('Scan started');
  });
  

connect(peripheralId)

Attempts to connect to a peripheral. Returns a Promise object.

Arguments

• peripheralId - String - the id/mac address of the peripheral to connect.

Examples

BleManager.connect('XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX')
  .then(() => {
    // Success code
    console.log('Connected');
  })
  .catch((error) => {
    // Failure code
    console.log(error);
  });

disconnect(peripheralId)

Disconnect from a peripheral. Returns a Promise object.

Arguments

• peripheralId - String - the id/mac address of the peripheral to disconnect.

Examples

BleManager.disconnect('XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX')
  .then(() => {
    // Success code
    console.log('Disconnected');
  })
  .catch((error) => {
    // Failure code
    console.log(error);
  });

checkState()

Force the module to check the state of BLE and trigger a BleManagerDidUpdateState event.

Examples

BleManager.checkState();

startNotification(peripheralId, serviceUUID, characteristicUUID)

Start the notification on the specified characteristic. Returns a Promise object.

Arguments

• peripheralId - String - the id/mac address of the peripheral.
• serviceUUID - String - the UUID of the service.
• characteristicUUID - String - the UUID of the characteristic.

Examples

BleManager.startNotification('XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX', 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX', 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX')
  .then(() => {
    // Success code
    console.log('Notification started');
  })
  .catch((error) => {
    // Failure code
    console.log(error);
  });

stopNotification(peripheralId, serviceUUID, characteristicUUID)

Stop the notification on the specified characteristic. Returns a Promise object.

Arguments

• peripheralId - String - the id/mac address of the peripheral.
• serviceUUID - String - the UUID of the service.
• characteristicUUID - String - the UUID of the characteristic.

read(peripheralId, serviceUUID, characteristicUUID)

Read the current value of the specified characteristic. Returns a Promise object.

Arguments

• peripheralId - String - the id/mac address of the peripheral.
• serviceUUID - String - the UUID of the service.
• characteristicUUID - String - the UUID of the characteristic.

Examples

BleManager.read('XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX', 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX', 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX')
  .then((readData) => {
    // Success code
    console.log('Read: ' + readData);
  })
  .catch((error) => {
    // Failure code
    console.log(error);
  });

write(peripheralId, serviceUUID, characteristicUUID, data)

Write with response to the specified characteristic. Returns a Promise object.

Arguments

• peripheralId - String - the id/mac address of the peripheral.
• serviceUUID - String - the UUID of the service.
• characteristicUUID - String - the UUID of the characteristic.
• data - String - the data to write in Base64 format.

To get the data into base64 format, you will need a library like base64-js. Install base64-js:

npm install base64-js --save

To format the data before calling the write function:

var base64 = require('base64-js');
var data = base64.fromByteArray(yourData);

Examples

BleManager.write('XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX', 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX', 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX', data)
  .then(() => {
    // Success code
    console.log('Write: ' + data);
  })
  .catch((error) => {
    // Failure code
    console.log(error);
  });

##Events

BleManagerStopScan

The scanning for peripherals is ended.

Arguments

• none

Examples

NativeAppEventEmitter.addListener(
    'BleManagerStopScan',
    () => { 
        // Scanning is stopped 
    }
);

BleManagerDidUpdateState

The BLE change state.

Arguments

• state - String - the new BLE state ('on'/'off').

Examples

NativeAppEventEmitter.addListener(
    'BleManagerDidUpdateState',
    (args) => { 
        // The new state: args.state
    }
);

BleManagerDiscoverPeripheral

The scanning find a new peripheral.

Arguments

• id - String - the id of the peripheral
• name - String - the name of the peripheral

Examples

NativeAppEventEmitter.addListener(
    'BleManagerDiscoverPeripheral',
    (args) => { 
        // The id: args.id
        // The name: args.name
    }
);

BleManagerDidUpdateValueForCharacteristic

A characteristic notify a new value.

Arguments

• peripheral - String - the id of the peripheral
• characteristic - String - the UUID of the characteristic
• value - String - the read value in Hex format

BleManagerDisconnectPeripheral

A peripheral is disconnected.

Arguments

• peripheral - String - the id of the peripheral