/* Copyright (C) 2015-2024 Andreas Böhler, Andreas Shimokawa, Carsten
|
Pfeiffer, Damien Gaignon, Daniel Dakhno, Daniele Gobbetti, Frank Ertl,
|
José Rebelo, Johannes Krude
|
|
This file is part of Gadgetbridge.
|
|
Gadgetbridge is free software: you can redistribute it and/or modify
|
it under the terms of the GNU Affero General Public License as published
|
by the Free Software Foundation, either version 3 of the License, or
|
(at your option) any later version.
|
|
Gadgetbridge is distributed in the hope that it will be useful,
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
GNU Affero General Public License for more details.
|
|
You should have received a copy of the GNU Affero General Public License
|
along with this program. If not, see <https://www.gnu.org/licenses/>. */
|
package nodomain.freeyourgadget.gadgetbridge.service.btle;
|
|
import android.bluetooth.BluetoothGattCharacteristic;
|
import android.os.Build;
|
|
import org.slf4j.Logger;
|
import org.slf4j.LoggerFactory;
|
|
import androidx.annotation.Nullable;
|
import androidx.annotation.RequiresApi;
|
|
import java.util.Arrays;
|
|
import nodomain.freeyourgadget.gadgetbridge.service.btle.actions.BondAction;
|
import nodomain.freeyourgadget.gadgetbridge.service.btle.actions.FunctionAction;
|
import nodomain.freeyourgadget.gadgetbridge.service.btle.actions.NotifyAction;
|
import nodomain.freeyourgadget.gadgetbridge.service.btle.actions.ReadAction;
|
import nodomain.freeyourgadget.gadgetbridge.service.btle.actions.RequestConnectionPriorityAction;
|
import nodomain.freeyourgadget.gadgetbridge.service.btle.actions.RequestMtuAction;
|
import nodomain.freeyourgadget.gadgetbridge.service.btle.actions.WaitAction;
|
import nodomain.freeyourgadget.gadgetbridge.service.btle.actions.WriteAction;
|
|
public class TransactionBuilder {
|
private static final Logger LOG = LoggerFactory.getLogger(TransactionBuilder.class);
|
|
private final Transaction mTransaction;
|
private boolean mQueued;
|
|
public TransactionBuilder(String taskName) {
|
mTransaction = new Transaction(taskName);
|
}
|
|
public TransactionBuilder read(BluetoothGattCharacteristic characteristic) {
|
if (characteristic == null) {
|
LOG.warn("Unable to read characteristic: null");
|
return this;
|
}
|
ReadAction action = new ReadAction(characteristic);
|
return add(action);
|
}
|
|
public TransactionBuilder write(BluetoothGattCharacteristic characteristic, byte[] data) {
|
if (characteristic == null) {
|
LOG.warn("Unable to write characteristic: null");
|
return this;
|
}
|
WriteAction action = new WriteAction(characteristic, data);
|
return add(action);
|
}
|
|
public TransactionBuilder writeChunkedData(BluetoothGattCharacteristic characteristic, byte[] data, int chunkSize) {
|
for (int start = 0; start < data.length; start += chunkSize) {
|
int end = start + chunkSize;
|
if (end > data.length) end = data.length;
|
WriteAction action = new WriteAction(characteristic, Arrays.copyOfRange(data, start, end));
|
add(action);
|
}
|
|
return this;
|
}
|
|
public TransactionBuilder requestMtu(int mtu){
|
return add(
|
new RequestMtuAction(mtu)
|
);
|
}
|
|
public TransactionBuilder requestConnectionPriority(int priority){
|
return add(
|
new RequestConnectionPriorityAction(priority)
|
);
|
}
|
|
public TransactionBuilder bond() {
|
BondAction action = new BondAction();
|
return add(action);
|
}
|
|
public TransactionBuilder notify(BluetoothGattCharacteristic characteristic, boolean enable) {
|
if (characteristic == null) {
|
LOG.warn("Unable to notify characteristic: null");
|
return this;
|
}
|
NotifyAction action = createNotifyAction(characteristic, enable);
|
return add(action);
|
}
|
|
protected NotifyAction createNotifyAction(BluetoothGattCharacteristic characteristic, boolean enable) {
|
return new NotifyAction(characteristic, enable);
|
}
|
|
/**
|
* Causes the queue to sleep for the specified time.
|
* Note that this is usually a bad idea, since it will not be able to process messages
|
* during that time. It is also likely to cause race conditions.
|
* @param millis the number of milliseconds to sleep
|
*/
|
public TransactionBuilder wait(int millis) {
|
WaitAction action = new WaitAction(millis);
|
return add(action);
|
}
|
|
// Runs the given function/lambda
|
public TransactionBuilder run(FunctionAction.Function function) {
|
return add(new FunctionAction(function));
|
}
|
|
public TransactionBuilder add(BtLEAction action) {
|
mTransaction.add(action);
|
return this;
|
}
|
|
/**
|
* Sets a GattCallback instance that will be called when the transaction is executed,
|
* resulting in GattCallback events.
|
*
|
* @param callback the callback to set, may be null
|
*/
|
public void setCallback(@Nullable GattCallback callback) {
|
mTransaction.setCallback(callback);
|
}
|
|
public
|
@Nullable
|
GattCallback getGattCallback() {
|
return mTransaction.getGattCallback();
|
}
|
|
/**
|
* To be used as the final step to execute the transaction by the given queue.
|
*
|
* @param queue
|
*/
|
public void queue(BtLEQueue queue) {
|
if (mQueued) {
|
throw new IllegalStateException("This builder had already been queued. You must not reuse it.");
|
}
|
mQueued = true;
|
queue.add(mTransaction);
|
}
|
|
public Transaction getTransaction() {
|
return mTransaction;
|
}
|
|
public String getTaskName() {
|
return mTransaction.getTaskName();
|
}
|
}
|
