com.github.ivbaranov.rxbluetooth

Class RxBluetooth

java.lang.Object

com.github.ivbaranov.rxbluetooth.RxBluetooth

public class RxBluetooth
extends java.lang.Object

Enables clients to listen to bluetooth events using RxJava Observables.

Constructor Summary

Constructors

Constructor and Description
RxBluetooth(android.content.Context context)

Method Summary

Modifier and Type	Method and Description
boolean	cancelDiscovery() Cancel the current device discovery process.
void	closeProfileProxy(int profile, android.bluetooth.BluetoothProfile proxy) Close the connection of the profile proxy to the Service.
void	enableBluetooth(android.app.Activity activity, int requestCode) This will issue a request to enable Bluetooth through the system settings (without stopping your application) via ACTION_REQUEST_ENABLE action Intent.
void	enableDiscoverability(android.app.Activity activity, int requestCode) This will issue a request to make the local device discoverable to other devices.
void	enableDiscoverability(android.app.Activity activity, int requestCode, int duration) This will issue a request to make the local device discoverable to other devices.
boolean	isBluetoothAvailable() Return true if Bluetooth is available.
boolean	isBluetoothEnabled() Return true if Bluetooth is currently enabled and ready for use.
boolean	isDiscovering() Return true if the local Bluetooth adapter is currently in the device discovery process.
<any>	observeBluetoothProfile(int bluetoothProfile) Observes connection to specified profile.
<any>	observeBluetoothSocket(java.lang.String name, java.util.UUID uuid) Opens BluetoothServerSocket, listens for a single connection request, releases socket and returns a connected BluetoothSocket on successful connection.
<any>	observeBluetoothState() Observes BluetoothState.
<any>	observeConnectDevice(android.bluetooth.BluetoothDevice bluetoothDevice, java.util.UUID uuid) Create connection to BluetoothDevice and returns a connected BluetoothSocket on successful connection.
<any>	observeDevices() Observes Bluetooth devices found while discovering.
<any>	observeDiscovery() Observes DiscoveryState, which can be ACTION_DISCOVERY_STARTED or ACTION_DISCOVERY_FINISHED from BluetoothAdapter.
<any>	observeScanMode() Observes scan mode of device.
boolean	startDiscovery() Start the remote device discovery process.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RxBluetooth

public RxBluetooth(android.content.Context context)

Method Detail

isBluetoothAvailable

public boolean isBluetoothAvailable()

Return true if Bluetooth is available.

Returns:

true if mBluetoothAdapter is not null or it's address is empty, otherwise Bluetooth is not supported on this hardware platform

isBluetoothEnabled

public boolean isBluetoothEnabled()

Return true if Bluetooth is currently enabled and ready for use.

Equivalent to: getBluetoothState() == STATE_ON

Requires Manifest.permission.BLUETOOTH

Returns:

true if the local adapter is turned on

enableBluetooth

public void enableBluetooth(android.app.Activity activity,
                            int requestCode)

This will issue a request to enable Bluetooth through the system settings (without stopping your application) via ACTION_REQUEST_ENABLE action Intent.

Parameters:

activity - Activity

requestCode - request code

startDiscovery

public boolean startDiscovery()

Start the remote device discovery process.

Returns:

true on success, false on error

isDiscovering

public boolean isDiscovering()

Return true if the local Bluetooth adapter is currently in the device discovery process.

Returns:

true if discovering

cancelDiscovery

public boolean cancelDiscovery()

Cancel the current device discovery process.

Returns:

true on success, false on error

enableDiscoverability

public void enableDiscoverability(android.app.Activity activity,
                                  int requestCode)

This will issue a request to make the local device discoverable to other devices. By default, the device will become discoverable for 120 seconds.

Parameters:

activity - Activity

requestCode - request code

enableDiscoverability

public void enableDiscoverability(android.app.Activity activity,
                                  int requestCode,
                                  int duration)

This will issue a request to make the local device discoverable to other devices. By default, the device will become discoverable for 120 seconds. Maximum duration is capped at 300 seconds.

Parameters:

activity - Activity

requestCode - request code

duration - discoverability duration in seconds

observeDevices

public <any> observeDevices()

Observes Bluetooth devices found while discovering.

Returns:

RxJava Observable with BluetoothDevice found

observeDiscovery

public <any> observeDiscovery()

Observes DiscoveryState, which can be ACTION_DISCOVERY_STARTED or ACTION_DISCOVERY_FINISHED from BluetoothAdapter.

Returns:

RxJava Observable with DiscoveryState

observeBluetoothState

public <any> observeBluetoothState()

Observes BluetoothState. Possible values are: BluetoothAdapter.STATE_OFF, BluetoothAdapter.STATE_TURNING_ON, BluetoothAdapter.STATE_ON, BluetoothAdapter.STATE_TURNING_OFF,

Returns:

RxJava Observable with BluetoothState

observeScanMode

public <any> observeScanMode()

Observes scan mode of device. Possible values are: BluetoothAdapter.SCAN_MODE_NONE, BluetoothAdapter.SCAN_MODE_CONNECTABLE, BluetoothAdapter.SCAN_MODE_CONNECTABLE_DISCOVERABLE

Returns:

RxJava Observable with scan mode

observeBluetoothProfile

public <any> observeBluetoothProfile(int bluetoothProfile)

Observes connection to specified profile. See also BluetoothProfile.ServiceListener.

Parameters:

bluetoothProfile - bluetooth profile to connect to. Can be either BluetoothProfile.HEALTH,BluetoothProfile.HEADSET, BluetoothProfile.A2DP, BluetoothProfile.GATT or BluetoothProfile.GATT_SERVER.

Returns:

RxJava Observable with ServiceEvent

closeProfileProxy

public void closeProfileProxy(int profile,
                              android.bluetooth.BluetoothProfile proxy)

Close the connection of the profile proxy to the Service.

Clients should call this when they are no longer using the proxy obtained from observeBluetoothProfile(int).

Profile can be one of BluetoothProfile.HEALTH,BluetoothProfile.HEADSET, BluetoothProfile.A2DP, BluetoothProfile.GATT or BluetoothProfile.GATT_SERVER.

Parameters:

profile - the Bluetooth profile

proxy - profile proxy object

observeBluetoothSocket

public <any> observeBluetoothSocket(java.lang.String name,
                                    java.util.UUID uuid)

Opens BluetoothServerSocket, listens for a single connection request, releases socket and returns a connected BluetoothSocket on successful connection. Notifies observers with IOException onError().

Parameters:

name - service name for SDP record

uuid - uuid for SDP record

Returns:

observable with connected BluetoothSocket on successful connection

observeConnectDevice

public <any> observeConnectDevice(android.bluetooth.BluetoothDevice bluetoothDevice,
                                  java.util.UUID uuid)

Create connection to BluetoothDevice and returns a connected BluetoothSocket on successful connection. Notifies observers with IOException onError().

Parameters:

bluetoothDevice - bluetooth device to connect

uuid - uuid for SDP record

Returns:

observable with connected BluetoothSocket on successful connection