RxAndroidBle Documentation

The library does not manage the BluetoothAdapter state. To request the user to enable Bluetooth via a native Android activity, use an Intent with BluetoothAdapter.ACTION_REQUEST_ENABLE.

Intent enableBtIntent = new Intent(BluetoothAdapter.ACTION_REQUEST_ENABLE);
int REQUEST_ENABLE_BT = 1;
context.startActivityForResult(enableBtIntent, REQUEST_ENABLE_BT);

To include RxAndroidBle in your project using Maven, add the dependency for either the RxJava 3 or RxJava 2 artifact. Note that the type is aar.

<!-- For RxJava 3 -->
<dependency>
  <groupId>com.polidea.rxandroidble3</groupId>
  <artifactId>rxandroidble</artifactId>
  <version>1.19.1</version>
  <type>aar</type>
</dependency>

<!-- For RxJava 2 -->
<dependency>
  <groupId>com.polidea.rxandroidble2</groupId>
  <artifactId>rxandroidble</artifactId>
  <version>1.19.1</version>
  <type>aar</type>
</dependency>

You can add MockRxAndroidBle to your project using Maven or Gradle. This library allows you to mock a Bluetooth LE device for testing purposes with the RxAndroidBle library.

### Gradle
```groovy
implementation "com.polidea.rxandroidble2:mockclient:1.19.1"

Maven

<dependency>
  <groupId>com.polidea.rxandroidble2</groupId>
  <artifactId>mockclient</artifactId>
  <version>1.19.1</version>
  <type>aar</type>
</dependency>

You can test your application using RxAndroidBle in two ways:

1. Mocking Interfaces: Most library objects implement interfaces, allowing you to use standard mocking frameworks (like Mockito) to mock them.
2. MockRxAndroidBle: You can use MockRxAndroidBle for testing. Note that using MockRxAndroidBle in unit tests requires Robolectric.

If you want to use cutting-edge x.y.z-SNAPSHOT builds, you must add the Sonatype Snapshot repository to your build.gradle file.

maven { url "https://oss.sonatype.org/content/repositories/snapshots" }

To develop applications without access to physical Bluetooth hardware, you can use MockRxAndroidBle as a drop-in addon to mock a simple peripheral.

Note: This component is not under active development.

When contributing code, ensure your changes compile and pass style checks by running the following Gradle command:

./gradlew clean checkstyle test

Android 12 (API 31) introduced new Bluetooth permissions. RxAndroidBle uses neverForLocation by default to avoid requiring location permissions for scanning.

To derive user location via BLE scanning on API 31+

If you specifically need to locate the user using BLE scanning, you must replace the default scanning permission and keep ACCESS_FINE_LOCATION:

<uses-permission android:name="android.permission.BLUETOOTH_SCAN" tools:node="replace" />

To remove Bluetooth Connect permission

If your app only needs to scan and does not need to connect to peripherals, you can remove the connection permission:

<uses-permission android:name="android.permission.BLUETOOTH_CONNECT" tools:node="remove" />

If you encounter unexpected behavior, consult the following FAQ resources:

• Cannot connect / Status 133: Link to FAQ
• UndeliverableException: Link to FAQ

The repository contains sample implementations in both Java and Kotlin to demonstrate how to use the library. Note that these samples are intended for library usage demonstration and may not represent ideal application architecture.

• Java Samples: Located in /sample/src/main/java/com/polidea/rxandroidble2/sample
• Kotlin Samples: Located in /sample-kotlin/src/main/kotlin/com/polidea/rxandroidble2/samplekotlin