Skip to content

Commit

Permalink
fix ble characteristic queuing bug
Browse files Browse the repository at this point in the history
  • Loading branch information
@bayosip
bayosip committed Aug 22, 2021
1 parent 079ba1a commit 766a3a5
Showing 1 changed file with 131 additions and 16 deletions.
147 changes: 131 additions & 16 deletions ...s_communication/wireless_comms_module/remote_comms/ble_comms/services/BleGattService.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Queue;
import java.util.UUID;

Expand All @@ -47,9 +49,9 @@ public class BleGattService extends Service {
private BluetoothAdapter bAdapter;
private boolean isHasService = false;

// Queue for BLE events
// This is needed so that rapid BLE events don't get dropped
private static final Queue<Object> BleQueue = new LinkedList<>();
private Map<String, Queue<Object>> writeQueueMap = new HashMap<>();
private Map<String, Queue<Object>> readQueueMap = new HashMap<>();

private int GATT_MAX_MTU_SIZE = 517;// default ATT MTU size

public String EXTRA_UUID;
Expand Down Expand Up @@ -113,6 +115,8 @@ private BluetoothGattCallback createGattCallBack(final String address) {
* @param newState New state (connected or disconnected)
*/
private BluetoothGatt bleGatt;


@Override
public void onConnectionStateChange(BluetoothGatt gatt, int status, int newState) {
if(status == BluetoothGatt.GATT_SUCCESS){
Expand All @@ -121,7 +125,14 @@ public void onConnectionStateChange(BluetoothGatt gatt, int status, int newState
if (gatt!=null) {
bleGatt = gatt;

// Queue for BLE events
// This is needed so that rapid BLE events don't get dropped
Queue<Object> BleReadQueue = new LinkedList<>();
Queue<Object> BleWriteQueue = new LinkedList<>();

multiBleGatt.put(address, gatt);
readQueueMap.put(address, BleReadQueue);
writeQueueMap.put(address, BleWriteQueue);
broadcastUpdate(Constants.BLE_ACTION_CONNECTED, address);
MyLogData += "Connected to GATT server.\n";
Log.i(TAG, "Connected to GATT server.");
Expand Down Expand Up @@ -175,13 +186,28 @@ public void onServicesDiscovered(BluetoothGatt gatt, int status) {
}


private void handleBleQueue() {
if(BleQueue.size() > 0) {
private void handleBleWriteQueue() {
Queue<Object> BleWriteQueue = writeQueueMap.get(address);
assert BleWriteQueue!=null;
if(writeQueueMap.size() > 0) {
// Determine which type of event is next and fire it off
if (BleWriteQueue.element() instanceof BluetoothGattDescriptor) {
bleGatt.writeDescriptor((BluetoothGattDescriptor) BleWriteQueue.element());
} else if (BleWriteQueue.element() instanceof BluetoothGattCharacteristic) {
bleGatt.writeCharacteristic((BluetoothGattCharacteristic) BleWriteQueue.element());
}
}
}

private void handleBleReadQueue() {
Queue<Object> BleReadQueue = readQueueMap.get(address);
assert BleReadQueue != null;
if(BleReadQueue.size() > 0) {
// Determine which type of event is next and fire it off
if (BleQueue.element() instanceof BluetoothGattDescriptor) {
bleGatt.writeDescriptor((BluetoothGattDescriptor) BleQueue.element());
} else if (BleQueue.element() instanceof BluetoothGattCharacteristic) {
bleGatt.writeCharacteristic((BluetoothGattCharacteristic) BleQueue.element());
if (BleReadQueue.element() instanceof BluetoothGattDescriptor) {
bleGatt.readDescriptor((BluetoothGattDescriptor) BleReadQueue.element());
} else if (BleReadQueue.element() instanceof BluetoothGattCharacteristic) {
bleGatt.readCharacteristic((BluetoothGattCharacteristic) BleReadQueue.element());
}
}
}
Expand All @@ -193,6 +219,12 @@ public void onCharacteristicRead(BluetoothGatt gatt,
if (characteristic.getUuid() == UUID.fromString("00002a19-0000-1000-8000-00805f9b34fb")) {

}
// Pop the item that was written from the queue
Queue<Object> BleReadQueue = readQueueMap.get(address);
Objects.requireNonNull(BleReadQueue).remove();
readQueueMap.put(address, BleReadQueue);
// See if there are more items in the BLE queues
handleBleReadQueue();
broadcastUpdate(Constants.BLE_ACTION_DATA_AVAILABLE, address, characteristic);
broadcastUpdateRaw(Constants.BLE_ACTION_RAW_DATA_AVAILABLE, address, characteristic);
Log.i(TAG, "onCharacteristicRead: xchar: " + characteristic.getUuid() + ", read:"
Expand All @@ -213,9 +245,11 @@ public void onCharacteristicWrite(BluetoothGatt gatt,
int status) {
if (status == BluetoothGatt.GATT_SUCCESS) {
// Pop the item that was written from the queue
BleQueue.remove();
Queue<Object> BleWriteQueue = writeQueueMap.get(address);
Objects.requireNonNull(BleWriteQueue).remove();
writeQueueMap.put(address, BleWriteQueue);
// See if there are more items in the BLE queues
handleBleQueue();
handleBleWriteQueue();
}else {
boolean flag =status==BluetoothGatt.GATT_INVALID_ATTRIBUTE_LENGTH;
Log.e(TAG, "onCharacteristicWrite: Failed with GATT_INVALID_ATTRIBUTE_LENGTH ="
Expand Down Expand Up @@ -243,6 +277,47 @@ public void onCharacteristicChanged(BluetoothGatt gatt,
broadcastUpdateRaw(Constants.ACTION_BLE_CHARX_DATA_CHANGE_RAW, address,characteristic);
}

@Override
public void onDescriptorRead(BluetoothGatt gatt, BluetoothGattDescriptor descriptor, int status) {
if (status == BluetoothGatt.GATT_SUCCESS) {

// Pop the item that was written from the queue
// Pop the item that was written from the queue
Queue<Object> BleReadQueue = readQueueMap.get(address);
Objects.requireNonNull(BleReadQueue).remove();
readQueueMap.put(address, BleReadQueue);
// See if there are more items in the BLE queues
handleBleReadQueue();
BluetoothGattCharacteristic characteristic = descriptor.getCharacteristic();
broadcastUpdate(Constants.BLE_ACTION_DATA_AVAILABLE, address, characteristic);
broadcastUpdateRaw(Constants.BLE_ACTION_RAW_DATA_AVAILABLE, address, characteristic);
Log.i(TAG, "onCharacteristicRead: xchar: " + characteristic.getUuid() + ", read:"
+ characteristic.getStringValue(0));
}
}

@Override
public void onDescriptorWrite(BluetoothGatt gatt, BluetoothGattDescriptor descriptor, int status) {
if (status == BluetoothGatt.GATT_SUCCESS) {
// Pop the item that was written from the queue
Queue<Object> BleWriteQueue = writeQueueMap.get(address);
Objects.requireNonNull(BleWriteQueue).remove();
writeQueueMap.put(address, BleWriteQueue);
// See if there are more items in the BLE queues
handleBleWriteQueue();
}else {
boolean flag =status==BluetoothGatt.GATT_INVALID_ATTRIBUTE_LENGTH;
Log.e(TAG, "onCharacteristicWrite: Failed with GATT_INVALID_ATTRIBUTE_LENGTH ="
+ flag);
Util.message(BleGattService.this, "Write failed! Send smaller bytes");
}
}

@Override
public void onReadRemoteRssi(BluetoothGatt gatt, int rssi, int status) {
//TODO: broadcast rssi value
}

@Override
public void onMtuChanged(BluetoothGatt gatt, int mtu, int status) {
Log.i(TAG, "onMtuChanged: ATT MTU changed to " + mtu
Expand Down Expand Up @@ -589,8 +664,10 @@ public void sendInstructionsToConnectedDevice(String deviceAddr, @Nullable UUID
*/
private void writeBleCharacteristic(BluetoothGatt bleGatt, BluetoothGattCharacteristic myWriteCharx) {
try{
BleQueue.add(myWriteCharx);
if (BleQueue.size() == 1) {
Queue<Object> BleWriteQueue = writeQueueMap.get(bleGatt.getDevice().getAddress());
Objects.requireNonNull(BleWriteQueue).add(myWriteCharx);
writeQueueMap.put(bleGatt.getDevice().getAddress(), BleWriteQueue);
if (BleWriteQueue.size() == 1) {
bleGatt.writeCharacteristic(myWriteCharx);
Log.i(TAG, "Writing Characteristic");
}
Expand All @@ -601,15 +678,44 @@ private void writeBleCharacteristic(BluetoothGatt bleGatt, BluetoothGattCharacte
}

/**
* This method is used to read the state of the LED from the device
* This method is used to read the state ble gatt charx from the device
*/
public void readBleCharacteristic(BluetoothGatt bleGatt,
BluetoothGattCharacteristic myReadCharx) {
if (bAdapter == null || bleGatt == null) {
Log.w(TAG, "BluetoothAdapter not initialized");
return;
}
bleGatt.readCharacteristic(myReadCharx);
Queue<Object> BleReadQueue = readQueueMap.get(bleGatt.getDevice().getAddress());
Objects.requireNonNull(BleReadQueue).add(myReadCharx);
readQueueMap.put(bleGatt.getDevice().getAddress(), BleReadQueue);
if(BleReadQueue.size() ==1)
bleGatt.readCharacteristic(myReadCharx);
}

/**
* Request a read on a given ble gatt charx descriptor. The read result is reported
* asynchronously through the {@code BluetoothGattCallback#onDescriptorRead(android.bluetooth.BluetoothGatt, android.bluetooth.BluetoothGattCharacteristic, int)}
* callback.
*
*/

public void readDescriptor(String serviceUUID, String charxUUID,
String CCC_DESCRIPTOR_UUID, String deviceAddress) {
BluetoothGatt gatt = multiBleGatt.get(deviceAddress);
assert gatt!= null;
BluetoothGattCharacteristic charx =gatt.getService(UUID.fromString(serviceUUID))
.getCharacteristic(UUID.fromString(charxUUID));
BluetoothGattDescriptor descriptor = charx.getDescriptor(
UUID.fromString(CCC_DESCRIPTOR_UUID));
Log.d(TAG, String.format("readDescriptor(%s)", descriptor));

Queue<Object> BleReadQueue = readQueueMap.get(deviceAddress);
Objects.requireNonNull(BleReadQueue).add(descriptor);
readQueueMap.put(deviceAddress, BleReadQueue);
if (BleReadQueue.size() == 1){
gatt.readDescriptor(descriptor);
}
}

/**
Expand Down Expand Up @@ -639,7 +745,12 @@ public void writeToDescriptorToEnableNotifications(String serviceUUID, String ch
BluetoothGattDescriptor descriptor = charx.getDescriptor(
UUID.fromString(CCC_DESCRIPTOR_UUID));
descriptor.setValue(BluetoothGattDescriptor.ENABLE_NOTIFICATION_VALUE);
gatt.writeDescriptor(descriptor);

Queue<Object> BleWriteQueue = writeQueueMap.get(deviceAddress);
Objects.requireNonNull(BleWriteQueue).add(descriptor);
writeQueueMap.put(deviceAddress, BleWriteQueue);
if(BleWriteQueue.size()==1)
gatt.writeDescriptor(descriptor);
}
}

Expand All @@ -655,6 +766,10 @@ public void writeToDescriptorToDisableNotifications(String serviceUUID, String c
BluetoothGattDescriptor descriptor = charx.getDescriptor(
UUID.fromString(CCC_DESCRIPTOR_UUID));
descriptor.setValue(BluetoothGattDescriptor.DISABLE_NOTIFICATION_VALUE);
Queue<Object> BleWriteQueue = writeQueueMap.get(deviceAddress);
Objects.requireNonNull(BleWriteQueue).add(descriptor);
writeQueueMap.put(deviceAddress, BleWriteQueue);
if(BleWriteQueue.size()==1)
gatt.writeDescriptor(descriptor);
}
}
Expand Down

0 comments on commit 766a3a5

Please sign in to comment.