Popularity
3.3
Growing
Activity
3.9
-
194
10
16

Description

RxCentralBle provides a simple reactive paradigm for connecting to and communicating with Bluetooth LE peripherals from the central role. It is ideal for all applications - in particular those that require multiple concurrent Bluetooth LE integrations.

RxCentralBle avoids many known Android pitfalls, including limitations in Android 7 & 8 around scanning operations, serial FIFO queueing for GATT, and others.

RxCentralBle powers Uber's Bluetooth LE integrations on Android, including the next-generation Uber Beacon.

Programming language: Java
License: Apache License 2.0
Tags: Bluetooth     BLE     RxJava    
Latest version: v1.2.0

RxCentralBle alternatives and similar packages

Based on the "Bluetooth" category.
Alternatively, view RxCentralBle alternatives based on common mentions on social networks and blogs.

Do you think we are missing an alternative of RxCentralBle or a related project?

Add another 'Bluetooth' Package

README

RxCentralBle Build Status

RxCentralBle provides a simple reactive paradigm for connecting to and communicating with Bluetooth LE peripherals from the central role. It is ideal for all applications - in particular those that require multiple concurrent Bluetooth LE integrations.

RxCentralBle avoids many known Android pitfalls, including limitations in Android 7 & 8 around scanning operations, serial FIFO queueing for GATT, and others.

RxCentralBle powers Uber's Bluetooth LE integrations on Android, including the next-generation Uber Beacon.

NEW! Uber Engineering Blog article detailing RxCentral cross-platform design and techniques for Android.

Check out the equivalent iOS library: RxCBCentral.

Key Features

  • Reactive; subscribe to actions to trigger them, dispose to stop
  • Built-in operation queue; respects the serial nature of Android's BluetoothGatt
  • Built-in GATT write segmentation; all writes are automatically chunked into MTU-sized segments
  • Interface-driven; customize the library with your own implementations
  • Manager-based; two managers for all connectivity and communication

Applicability

RxCentralBle optimizes for the following use cases:

  • Where the ability to connect to and communicate with a Bluetooth 4.0+ LE peripheral is needed
  • Where the peripheral is Bluetooth 4.0+ LE compliant and acts per the specification
  • Where the peripheral does not require Bluetooth 4.0 specified authentication

Download

Available on Maven Central:

dependencies {
  implementation 'com.uber.rxcentralble:rx-central-ble:1.2.0'
}

Usage

The below demonstrates simple usage of RxCentralBle. Check out the Wiki for details!

Bluetooth Detection

Use the BluetoothDetector to detect the state of Bluetooth:

BluetoothDetector bluetoothDetector;
Disposable detection;

// Use the detector to detect Bluetooth state.
detection = bluetoothDetector
   .enabled()
   .subscribe(
       enabled -> {
         // Tell the user to turn on Bluetooth if not enabled
       }
   );

Dispose of your subscription to stop detection.

// Stop Bluetooth detection.
detection.dispose();

Connection Management

Use the ConnectionManager to manage the lifecycle of connections to a peripheral and supply a fresh Peripheral to the PeripheralManager on every connection.

ScanMatcher scanMatcher;
ConnectionManager connectionManager;
PeripheralManager peripheralManager;
Disposable connection

// Connect to a peripheral.  
connection = connectionManager
    .connect(scanMatcher, DEFAULT_SCAN_TIMEOUT, DEFAULT_CONNECTION_TIMEOUT)
    .subscribe(
        peripheral -> {
          // Inject the latest connected Peripheral into your PeripheralManager.
          peripheralManager.setPeripheral(peripheral);
        },
        error -> {
          // Connection lost.
        };

Dispose of your subscription to disconnect.

// Disconnect.
connection.dispose();

Because this is a reactive library, you can leverage Rx retries to attempt to reconnect to a peripheral if a scan fails.

ScanMatcher scanMatcher;
ConnectionManager connectionManager;
PeripheralManager peripheralManager;
Disposable connection

// Support retries for connection. 
connection = connectionManager
    .connect(scanMatcher, DEFAULT_SCAN_TIMEOUT, DEFAULT_CONNECTION_TIMEOUT)
    .retryWhen(
        errorObservable -> 
            // Custom retry logic
    )
    .subscribe(
        peripheral -> {
          // Inject the latest connected peripheral into your PeripheralManager.
          peripheralManager.setPeripheral(peripheral);
        };

Peripheral Management

After injecting the connected Peripheral into your PeripheralManager, you can then queue operations and the PeripheralManager will ensure these are executed in a serial FIFO fashion. The PeripheralManager is thread safe, so multiple consuming threads can queue operations and they will be reliably executed in the order they are subscribed.

PeripheralManager peripheralManager;
Write write;
Disposable queued;

// Queue a write operaiton.
queued = peripheralManager
  .queueOperation(write))
  .subscribe(
       irrelevant -> {
         // Write was successful.
       },
       error -> {
         // Write failed.
       });

Dispose of your subscription to dequeue (i.e. cancel).

// Cancel the write operation if it hasn't begun execution.
queued.dispose();

Sample App

The included sample application allows you to connect to any Bluetooth LE peripheral by name and query the Generic Access, Device Information, and Battery services. Feel free to improve upon the sample and submit PRs to help the RxCentralBle community.

License

Copyright (C) 2018 Uber Technologies

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.


*Note that all licence references and agreements mentioned in the RxCentralBle README section above are relevant to that project's source code only.