
圖片來源網(wǎng)絡,入侵必刪
在一些Android藍牙項目當中,我們可能需要對藍牙模塊的API進行二次封裝,相對來說有點麻煩。我最近發(fā)現(xiàn)一個很好用的藍牙開源庫——Android-BLE,分享出來希望能提高大家的開發(fā)效率。
Android-BLE
Android-BLE藍牙框架,提供了掃描、連接、使能/除能通知、發(fā)送/讀取數(shù)據(jù)、接收數(shù)據(jù),讀取rssi,設置mtu等藍牙相關的所有操作接口,內(nèi)部優(yōu)化了連接隊列,以及快速寫入隊列, 并支持多服務通訊,可擴展配置藍牙相關操作。
BLE的API
- Ble - 最重要的類,對外提供所有的藍牙操作接口.
- BleDevice - 封裝了藍牙對象類,包含藍牙連接狀態(tài)以及基本藍牙信息.
- BleLog - 內(nèi)部日志類,開發(fā)環(huán)境下打開可查看藍牙相關操作信息.
- BleStates - 藍牙操作異常狀態(tài)碼信息類.(掃描、連接、讀寫等異常狀態(tài)碼).
- ByteUtils - 各種字節(jié)數(shù)據(jù)轉換的工具類.
- CrcUtils - 字節(jié)校驗的crc各種算法的工具類.
- UuidUtils - 藍牙服務/特征uuid轉換工具類.
引入項目
implementation 'cn.com.superLei:blelibrary:3.2.0'
我發(fā)布博客的時候,目前最新的版本是3.2.0。最新版本請看開源庫的wiki
簡單使用
關于Android 12的權限適配:
<uses-permission android:name="android.permission.BLUETOOTH_SCAN" />
<uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
在Application里面進行初始化:
private void initBle() {
Ble.options()//開啟配置
.setLogBleEnable(true)//設置是否輸出打印藍牙日志(非正式打包請設置為true,以便于調(diào)試)
.setThrowBleException(true)//設置是否拋出藍牙異常 (默認true)
.setAutoConnect(false)//設置是否自動連接 (默認false)
.setIgnoreRepeat(false)//設置是否過濾掃描到的設備(已掃描到的不會再次掃描)
.setConnectTimeout(10 * 1000)//設置連接超時時長(默認10*1000 ms)
.setMaxConnectNum(7)//最大連接數(shù)量
.setScanPeriod(12 * 1000)//設置掃描時長(默認10*1000 ms)
.setScanFilter(scanFilter)//設置掃描過濾
.setUuidService(UUID.fromString(UuidUtils.uuid16To128("fd00")))//設置主服務的uuid(必填)
.setUuidWriteCha(UUID.fromString(UuidUtils.uuid16To128("fd01")))//設置可寫特征的uuid (必填,否則寫入失?。? .setUuidReadCha(UUID.fromString(UuidUtils.uuid16To128("fd02")))//設置可讀特征的uuid (選填)
.setUuidNotifyCha(UUID.fromString(UuidUtils.uuid16To128("fd03")))//設置可通知特征的uuid (選填,庫中默認已匹配可通知特征的uuid)
.setUuidServicesExtra(new UUID[]{BATTERY_SERVICE_UUID})//設置額外的其他服務組,如電量服務等
.setFactory(new BleFactory() {//實現(xiàn)自定義BleDevice時必須設置
@Override
public MyDevice create(String address, String name) {
return new MyDevice(address, name);//自定義BleDevice的子類
}
})
.setBleWrapperCallback(new MyBleWrapperCallback())//設置全部藍牙相關操作回調(diào)(例: OTA升級可以再這里實現(xiàn),與項目其他功能邏輯完全解耦)
.create(mApplication, new Ble.InitCallback() {
@Override
public void success() {
BleLog.e("MainApplication", "初始化成功");
}
@Override
public void failed(int failedCode) {
BleLog.e("MainApplication", "初始化失?。? + failedCode);
}
});
}
開始掃描的代碼:
ble.startScan(scanCallback);
掃描之后的回調(diào):
BleScanCallback<BleDevice> scanCallback = new BleScanCallback<BleDevice>() {
@Override
public void onLeScan(final BleDevice device, int rssi, byte[] scanRecord) {
//Scanned devices
}
@Override
public void onStart() {
super.onStart();
}
@Override
public void onStop() {
super.onStop();
}
@Override
public void onScanFailed(int errorCode) {
super.onScanFailed(errorCode);
Log.e(TAG, "onScanFailed: "+errorCode);
}
};
連接或者斷開:
//連接設備
ble.connect(device, connectCallback);
//連接多個設備
ble.connects(devices, connectCallback);
//取消正在連接的設備
ble.cancelConnecting(device);
//取消正在連接的多個設備
ble.cancelConnectings(devices);
//斷開設備
ble.disconnect(device);
//斷開所有設備
ble.disconnectAll();
連接或者斷開的回調(diào):
private BleConnCallback<BleDevice> connectCallback = new BleConnCallback<BleDevice>() {
@Override
public void onConnectionChanged(BleDevice device) {
}
@Override
public void onConnectTimeOut(BleDevice device) {
super.onConnectTimeOut(device);
Log.e(TAG, "onConnectTimeOut: " + device.getBleAddress());
}
@Override
public void onConnectCancel(BleDevice device) {
super.onConnectCancel(device);
Log.e(TAG, "onConnectCancel: " + device.getBleName());
}
@Override
public void onServicesDiscovered(BleDevice device, BluetoothGatt gatt) {
super.onServicesDiscovered(device, gatt);
}
@Override
public void onReady(BleDevice device) {
super.onReady(device);
//connect successful to enable notification
ble.enableNotify(...);
}
@Override
public void onConnectException(BleDevice device, int errorCode) {
super.onConnectException(device, errorCode);
}
};
通知處理:
ble.enableNotify(device, true, new BleNotifyCallback<BleDevice>() {
@Override
public void onChanged(BleDevice device, BluetoothGattCharacteristic characteristic) {
UUID uuid = characteristic.getUuid();
BleLog.e(TAG, "onChanged==uuid:" + uuid.toString());
BleLog.e(TAG, "onChanged==data:" + ByteUtils.toHexString(characteristic.getValue()));
}
@Override
public void onNotifySuccess(BleDevice device) {
super.onNotifySuccess(device);
BleLog.e(TAG, "onNotifySuccess: "+device.getBleName());
}
});
讀取數(shù)據(jù):
ble.read(device, new BleReadCallback<BleRssiDevice>() {
@Override
public void onReadSuccess(BleRssiDevice dedvice, BluetoothGattCharacteristic characteristic) {
super.onReadSuccess(dedvice, characteristic);
}
@Override
public void onReadFailed(BleRssiDevice device, int failedCode) {
super.onReadFailed(device, failedCode);
}
})
寫入數(shù)據(jù):
//寫入一包數(shù)據(jù)
ble.write(device, data, new BleWriteCallback<BleRssiDevice>() {
@Override
public void onWriteSuccess(BleRssiDevice device, BluetoothGattCharacteristic characteristic) {
}
@Override
public void onWriteFailed(BleRssiDevice device, int failedCode) {
super.onWriteFailed(device, failedCode);
}
});
//寫入大數(shù)據(jù)(文件、圖片等)
byte[]data = toByteArray(getAssets().open("WhiteChristmas.bin"));
ble.writeEntity(mBle.getConnectedDevices().get(0), data, 20, 50, new BleWriteEntityCallback<BleDevice>() {
@Override
public void onWriteSuccess() {
}
@Override
public void onWriteFailed() {
}
override void onWriteProgress(double progress) {
}
override void onWriteCancel() {
}
});
//寫入數(shù)據(jù)到隊列中 (默認發(fā)送間隔50ms)
ble.writeQueue(RequestTask.newWriteTask(address, data));
//寫入數(shù)據(jù)到隊列中 (自定義間隔時間)
ble.writeQueueDelay(delay, RequestTask.newWriteTask(address, data));
//通過特定服務和特征值uuid寫入數(shù)據(jù)
ble.writeByUuid(device, data, serviceUuid, charUuid, new BleWriteCallback<BleRssiDevice>() {
@Override
public void onWriteSuccess(BleRssiDevice device, BluetoothGattCharacteristic characteristic) {
}
@Override
public void onWiteFailed(BleRssiDevice device, int failedCode) {
super.onWiteFailed(device, failedCode);
}
});
刪除監(jiān)聽:
ble.cancelCallback(connectCallback);
或
ble.cancelCallback(scanCallback);
釋放志愿:
ble.released();