com.polidea.rxandroidble2.exceptions

Class BleCannotSetCharacteristicNotificationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.polidea.rxandroidble2.exceptions.BleException

com.polidea.rxandroidble2.exceptions.BleCannotSetCharacteristicNotificationException

All Implemented Interfaces:

java.io.Serializable

public class BleCannotSetCharacteristicNotificationException
extends BleException

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BleCannotSetCharacteristicNotificationException.Reason

Field Summary

Fields

Modifier and Type	Field and Description
static int	CANNOT_FIND_CLIENT_CHARACTERISTIC_CONFIG_DESCRIPTOR Used when a call to BluetoothGattCharacteristic.getDescriptor(UUID) does not return the Client Characteristic Configuration Descriptor ("00002902-0000-1000-8000-00805f9b34fb").
static int	CANNOT_SET_LOCAL_NOTIFICATION Used when call to BluetoothGatt.setCharacteristicNotification(BluetoothGattCharacteristic, boolean) returns false.
static int	CANNOT_WRITE_CLIENT_CHARACTERISTIC_CONFIG_DESCRIPTOR Used when a call to writing to Client Characteristic Configuration Descriptor fails due to BluetoothGatt.writeDescriptor(BluetoothGattDescriptor) returns `false` or BluetoothGattCallback.onDescriptorWrite(BluetoothGatt, BluetoothGattDescriptor, int) is called with status other than BluetoothGatt.GATT_SUCCESS.
static int	UNKNOWN Deprecated.

Constructor Summary

Constructors

Constructor and Description
BleCannotSetCharacteristicNotificationException(android.bluetooth.BluetoothGattCharacteristic bluetoothGattCharacteristic) Deprecated.
BleCannotSetCharacteristicNotificationException(android.bluetooth.BluetoothGattCharacteristic bluetoothGattCharacteristic, int reason, java.lang.Throwable cause)

Method Summary

Modifier and Type	Method and Description
android.bluetooth.BluetoothGattCharacteristic	getBluetoothGattCharacteristic()
int	getReason() Should return one of CANNOT_SET_LOCAL_NOTIFICATION, CANNOT_FIND_CLIENT_CHARACTERISTIC_CONFIG_DESCRIPTOR, CANNOT_WRITE_CLIENT_CHARACTERISTIC_CONFIG_DESCRIPTOR

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN

@Deprecated
public static final int UNKNOWN

Deprecated.

The unknown reason (probably because someone is externally instantiating BleCannotSetCharacteristicNotificationException

See Also:

Constant Field Values

CANNOT_SET_LOCAL_NOTIFICATION

public static final int CANNOT_SET_LOCAL_NOTIFICATION

Used when call to BluetoothGatt.setCharacteristicNotification(BluetoothGattCharacteristic, boolean) returns false.

See Also:

Constant Field Values

CANNOT_FIND_CLIENT_CHARACTERISTIC_CONFIG_DESCRIPTOR

public static final int CANNOT_FIND_CLIENT_CHARACTERISTIC_CONFIG_DESCRIPTOR

Used when a call to BluetoothGattCharacteristic.getDescriptor(UUID) does not return the Client Characteristic Configuration Descriptor ("00002902-0000-1000-8000-00805f9b34fb"). This usually happens when there is a bug in the implementation of the peripheral's firmware - according to Bluetooth Core Specification v4.2 [Vol 3, Part G] 3.3.1.1 every characteristic that has BluetoothGattCharacteristic.PROPERTY_NOTIFY or BluetoothGattCharacteristic.PROPERTY_INDICATE shall contain the Client Characteristic Configuration Descriptor. This is a violation of the specification and should be fixed on the firmware side. As a temporary workaround RxBleConnection.setupNotification(BluetoothGattCharacteristic, NotificationSetupMode) or RxBleConnection.setupIndication(UUID, NotificationSetupMode) can be used with NotificationSetupMode.COMPAT - which will make the library call only BluetoothGatt.setCharacteristicNotification(BluetoothGattCharacteristic, boolean) without writing the descriptor.

See Also:

Constant Field Values

CANNOT_WRITE_CLIENT_CHARACTERISTIC_CONFIG_DESCRIPTOR

public static final int CANNOT_WRITE_CLIENT_CHARACTERISTIC_CONFIG_DESCRIPTOR

Used when a call to writing to Client Characteristic Configuration Descriptor fails due to BluetoothGatt.writeDescriptor(BluetoothGattDescriptor) returns `false` or BluetoothGattCallback.onDescriptorWrite(BluetoothGatt, BluetoothGattDescriptor, int) is called with status other than BluetoothGatt.GATT_SUCCESS.

See Also:

Constant Field Values

Constructor Detail

BleCannotSetCharacteristicNotificationException

@Deprecated
public BleCannotSetCharacteristicNotificationException(android.bluetooth.BluetoothGattCharacteristic bluetoothGattCharacteristic)

Deprecated.

BleCannotSetCharacteristicNotificationException

public BleCannotSetCharacteristicNotificationException(android.bluetooth.BluetoothGattCharacteristic bluetoothGattCharacteristic,
                                                       int reason,
                                                       java.lang.Throwable cause)

Method Detail

getBluetoothGattCharacteristic

public android.bluetooth.BluetoothGattCharacteristic getBluetoothGattCharacteristic()

getReason

public int getReason()

Should return one of CANNOT_SET_LOCAL_NOTIFICATION, CANNOT_FIND_CLIENT_CHARACTERISTIC_CONFIG_DESCRIPTOR, CANNOT_WRITE_CLIENT_CHARACTERISTIC_CONFIG_DESCRIPTOR

Returns:

the reason