Package org.robolectric.shadows

Class ShadowBluetoothGatt

java.lang.Object

org.robolectric.shadows.ShadowBluetoothGatt

@Implements(android.bluetooth.BluetoothGatt.class)
public class ShadowBluetoothGatt
extends Object

Shadow implementation of BluetoothGatt.

Field Summary

Fields

Modifier and Type	Field	Description
protected org.robolectric.shadows.ShadowBluetoothGatt.BluetoothGattReflector	bluetoothGattReflector

Constructor Summary

Constructors

Constructor	Description
ShadowBluetoothGatt()

Method Summary

Modifier and Type	Method	Description
protected void	abortReliableWrite()
void	addDiscoverableService(BluetoothGattService service)
void	allowCharacteristicNotification(BluetoothGattCharacteristic characteristic)	Allows the incoming characteristic to be set to enable notification.
protected boolean	beginReliableWrite()
protected void	close()	Close this Bluetooth GATT client.
protected boolean	connect()	Connect to a remote device, and performs a BluetoothGattCallback.onConnectionStateChange(android.bluetooth.BluetoothGatt, int, int) if a BluetoothGattCallback has been set by setGattCallback(android.bluetooth.BluetoothGattCallback)
void	disallowCharacteristicNotification(BluetoothGattCharacteristic characteristic)	Disallows the incoming characteristic to be set to enable notification.
protected void	disconnect()	Disconnects an established connection, or cancels a connection attempt currently in progress.
protected boolean	discoverServices()	Overrides BluetoothGatt.discoverServices() to always return false unless there are discoverable services made available by addDiscoverableService(android.bluetooth.BluetoothGattService)
protected boolean	executeReliableWrite()
org.robolectric.shadows.BluetoothConnectionManager	getBluetoothConnectionManager()
int	getConnectionPriority()
BluetoothGattCallback	getGattCallback()
byte[]	getLatestReadBytes()
byte[]	getLatestWrittenBytes()
protected BluetoothGattService	getService(UUID uuid)	Overrides BluetoothGatt.getService(UUID) to return a service with given UUID.
protected List<BluetoothGattService>	getServices()	Overrides BluetoothGatt.getServices() to always return a list of services discovered.
boolean	isClosed()
boolean	isConnected()
static BluetoothGatt	newInstance(BluetoothDevice device)
void	notifyConnection(String remoteAddress)	Simulate a successful Gatt Client Connection with BluetoothConnectionManager.
void	notifyDisconnection(String remoteAddress)	Simulate a successful Gatt Client Disconnection with BluetoothConnectionManager.
protected boolean	readCharacteristic(BluetoothGattCharacteristic characteristic)
protected boolean	readDescriptor(BluetoothGattDescriptor descriptor)
boolean	readIncomingCharacteristic(BluetoothGattCharacteristic characteristic)	Writes bytes from incoming characteristic if properties are valid and callback is set.
protected void	readPhy()	Overrides BluetoothGatt.readPhy() to always fail before setGattCallback(android.bluetooth.BluetoothGattCallback) is called, and always succeed after.
protected boolean	readRemoteRssi()
void	removeDiscoverableService(BluetoothGattService service)
protected boolean	requestConnectionPriority(int priority)	Request a connection parameter update.
protected boolean	requestMtu(int mtu)	Overrides BluetoothGatt.requestMtu(int) to always fail before setGattCallback(android.bluetooth.BluetoothGattCallback) is called, and always succeed after.
protected int	requestSubrateMode(int subrateMode)
void	setBeginReliableWriteResult(boolean beginReliableWriteResult)
protected boolean	setCharacteristicNotification(BluetoothGattCharacteristic characteristic, boolean enable)	Overrides BluetoothGatt.setCharacteristicNotification(android.bluetooth.BluetoothGattCharacteristic, boolean) so it returns true (false) if allowCharacteristicNotification (disallowCharacteristicNotification) is called.
void	setGattCallback(BluetoothGattCallback bluetoothGattCallback)
void	setPhy(int txPhy, int rxPhy)	Sets the values to be returned by BluetoothGatt.readPhy()
protected void	setPreferredPhy(int txPhy, int rxPhy, int phyOptions)	Overrides BluetoothGatt.setPreferredPhy(int, int, int) to always fail before setGattCallback(android.bluetooth.BluetoothGattCallback) is called, and always succeed after.
void	setRequestConnectionPriorityResult(boolean requestConnectionPriorityResult)	Sets the return value for BluetoothGatt.requestConnectionPriority(int).
void	setRssi(int rssi)	Sets the RSSI value to be returned by readRemoteRssi().
protected boolean	writeCharacteristic(BluetoothGattCharacteristic characteristic)
protected int	writeCharacteristic(BluetoothGattCharacteristic characteristic, byte[] value, int writeType)
protected boolean	writeDescriptor(BluetoothGattDescriptor descriptor)
protected int	writeDescriptor(BluetoothGattDescriptor descriptor, byte[] value)
boolean	writeIncomingCharacteristic(BluetoothGattCharacteristic characteristic)	Reads bytes from incoming characteristic if properties are valid and callback is set.

Methods inherited from class java.lang.Object

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

Field Details

bluetoothGattReflector

@ReflectorObject
protected org.robolectric.shadows.ShadowBluetoothGatt.BluetoothGattReflector bluetoothGattReflector

Constructor Details

ShadowBluetoothGatt

public ShadowBluetoothGatt()

Method Details

newInstance

public static BluetoothGatt newInstance(BluetoothDevice device)

connect

@Implementation
protected boolean connect()

Connect to a remote device, and performs a BluetoothGattCallback.onConnectionStateChange(android.bluetooth.BluetoothGatt, int, int) if a BluetoothGattCallback has been set by setGattCallback(android.bluetooth.BluetoothGattCallback)

Returns:

true, if a BluetoothGattCallback has been set by setGattCallback(android.bluetooth.BluetoothGattCallback)

disconnect

@Filter(order=AFTER)
protected void disconnect()

Disconnects an established connection, or cancels a connection attempt currently in progress.

close

@Filter(order=AFTER)
protected void close()

Close this Bluetooth GATT client.

setRequestConnectionPriorityResult

public void setRequestConnectionPriorityResult(boolean requestConnectionPriorityResult)

Sets the return value for BluetoothGatt.requestConnectionPriority(int).

requestConnectionPriority

@Implementation(minSdk=26)
protected boolean requestConnectionPriority(int priority)

Request a connection parameter update.

Parameters:

priority - Request a specific connection priority. Must be one of BluetoothGatt.CONNECTION_PRIORITY_BALANCED, BluetoothGatt.CONNECTION_PRIORITY_HIGH or BluetoothGatt.CONNECTION_PRIORITY_LOW_POWER.

Returns:

true if operation is successful.

Throws:

IllegalArgumentException - If the parameters are outside of their specified range.

requestMtu

@Implementation(minSdk=26)
protected boolean requestMtu(int mtu)

Overrides BluetoothGatt.requestMtu(int) to always fail before setGattCallback(android.bluetooth.BluetoothGattCallback) is called, and always succeed after.

setPreferredPhy

@Implementation(minSdk=26)
protected void setPreferredPhy(int txPhy,
 int rxPhy,
 int phyOptions)

Overrides BluetoothGatt.setPreferredPhy(int, int, int) to always fail before setGattCallback(android.bluetooth.BluetoothGattCallback) is called, and always succeed after.

readPhy

@Implementation(minSdk=26)
protected void readPhy()

Overrides BluetoothGatt.readPhy() to always fail before setGattCallback(android.bluetooth.BluetoothGattCallback) is called, and always succeed after.

setPhy

public void setPhy(int txPhy,
 int rxPhy)

Sets the values to be returned by BluetoothGatt.readPhy()

discoverServices

@Implementation(minSdk=26)
protected boolean discoverServices()

Overrides BluetoothGatt.discoverServices() to always return false unless there are discoverable services made available by addDiscoverableService(android.bluetooth.BluetoothGattService)

Returns:

true if discoverable service is available and callback response is possible

getServices

@Implementation(minSdk=26)
protected List<BluetoothGattService> getServices()

Overrides BluetoothGatt.getServices() to always return a list of services discovered.

Returns:

list of services that have been discovered through discoverServices(), empty if none.

getService

@Implementation(minSdk=26)
@Nullable
protected BluetoothGattService getService(UUID uuid)

Overrides BluetoothGatt.getService(UUID) to return a service with given UUID.

Returns:

a service with given UUID that have been discovered through discoverServices().

setCharacteristicNotification

@Implementation(minSdk=26)
protected boolean setCharacteristicNotification(BluetoothGattCharacteristic characteristic,
 boolean enable)

Overrides BluetoothGatt.setCharacteristicNotification(android.bluetooth.BluetoothGattCharacteristic, boolean) so it returns true (false) if allowCharacteristicNotification (disallowCharacteristicNotification) is called.

readDescriptor

@Implementation(minSdk=26)
protected boolean readDescriptor(BluetoothGattDescriptor descriptor)

setRssi

public void setRssi(int rssi)

Sets the RSSI value to be returned by readRemoteRssi().

Parameters:

rssi - The RSSI value.

readRemoteRssi

@Implementation(minSdk=26)
protected boolean readRemoteRssi()

setBeginReliableWriteResult

public void setBeginReliableWriteResult(boolean beginReliableWriteResult)

beginReliableWrite

@Implementation(minSdk=26)
protected boolean beginReliableWrite()

executeReliableWrite

@Implementation(minSdk=26)
protected boolean executeReliableWrite()

abortReliableWrite

@Implementation(minSdk=26)
protected void abortReliableWrite()

requestSubrateMode

@Implementation(minSdk=36)
protected int requestSubrateMode(int subrateMode)

writeDescriptor

@Implementation(minSdk=26)
protected boolean writeDescriptor(BluetoothGattDescriptor descriptor)

writeDescriptor

@Implementation(minSdk=33)
protected int writeDescriptor(BluetoothGattDescriptor descriptor,
 byte[] value)

writeCharacteristic

@Implementation(minSdk=26)
protected boolean writeCharacteristic(BluetoothGattCharacteristic characteristic)

writeCharacteristic

@Implementation(minSdk=33)
protected int writeCharacteristic(BluetoothGattCharacteristic characteristic,
 byte[] value,
 int writeType)

readCharacteristic

@Implementation(minSdk=26)
protected boolean readCharacteristic(BluetoothGattCharacteristic characteristic)

writeIncomingCharacteristic

public boolean writeIncomingCharacteristic(BluetoothGattCharacteristic characteristic)

Reads bytes from incoming characteristic if properties are valid and callback is set. Callback responds with BluetoothGattCallback.onCharacteristicWrite(android.bluetooth.BluetoothGatt, android.bluetooth.BluetoothGattCharacteristic, int) and returns true when successful.

Parameters:

characteristic - Characteristic to read

Returns:

true, if the read operation was initiated successfully

Throws:

IllegalStateException - if a BluetoothGattCallback has not been set by setGattCallback(android.bluetooth.BluetoothGattCallback)

readIncomingCharacteristic

public boolean readIncomingCharacteristic(BluetoothGattCharacteristic characteristic)

Writes bytes from incoming characteristic if properties are valid and callback is set. Callback responds with BluetoothGattCallback#onCharacteristicRead and returns true when successful.

Parameters:

characteristic - Characteristic to read

Returns:

true, if the read operation was initiated successfully

Throws:

IllegalStateException - if a BluetoothGattCallback has not been set by setGattCallback(android.bluetooth.BluetoothGattCallback)

allowCharacteristicNotification

public void allowCharacteristicNotification(BluetoothGattCharacteristic characteristic)

Allows the incoming characteristic to be set to enable notification.

disallowCharacteristicNotification

public void disallowCharacteristicNotification(BluetoothGattCharacteristic characteristic)

Disallows the incoming characteristic to be set to enable notification.

addDiscoverableService

public void addDiscoverableService(BluetoothGattService service)

removeDiscoverableService

public void removeDiscoverableService(BluetoothGattService service)

getGattCallback

public BluetoothGattCallback getGattCallback()

setGattCallback

public void setGattCallback(BluetoothGattCallback bluetoothGattCallback)

isConnected

public boolean isConnected()

isClosed

public boolean isClosed()

getConnectionPriority

public int getConnectionPriority()

getLatestWrittenBytes

public byte[] getLatestWrittenBytes()

getLatestReadBytes

public byte[] getLatestReadBytes()

getBluetoothConnectionManager

public org.robolectric.shadows.BluetoothConnectionManager getBluetoothConnectionManager()

notifyConnection

public void notifyConnection(String remoteAddress)

Simulate a successful Gatt Client Connection with BluetoothConnectionManager. Performs a BluetoothGattCallback.onConnectionStateChange(android.bluetooth.BluetoothGatt, int, int) if available.

Parameters:

remoteAddress - address of Gatt client

notifyDisconnection

public void notifyDisconnection(String remoteAddress)

Simulate a successful Gatt Client Disconnection with BluetoothConnectionManager. Performs a BluetoothGattCallback.onConnectionStateChange(android.bluetooth.BluetoothGatt, int, int) if available.

Parameters:

remoteAddress - address of Gatt client