在一些Android
蓝牙项目当中,我们可能需要对蓝牙模块的API进行二次封装,相对来说有点麻烦。我最近发现一个很好用的蓝牙
开源库——Android-BLE
,分享出来希望能提高大家的开发效率。
Android-BLE
Android-BLE蓝牙框架,提供了扫描、连接、使能/除能通知、发送/读取数据、接收数据,读取rssi,设置mtu等蓝牙相关的所有操作接口,内部优化了连接队列,以及快速写入队列, 并支持多服务通讯,可扩展配置蓝牙相关操作。
BLE的API
- Ble - 最重要的类,对外提供所有的蓝牙操作接口.
- BleDevice - 封装了蓝牙对象类,包含蓝牙连接状态以及基本蓝牙信息.
- BleLog - 内部日志类,开发环境下打开可查看蓝牙相关操作信息.
- BleStates - 蓝牙操作异常状态码信息类.(扫描、连接、读写等异常状态码).
- ByteUtils - 各种字节数据转换的工具类.
- CrcUtils - 字节校验的crc各种算法的工具类.
- UuidUtils - 蓝牙服务/特征uuid转换工具类.
引入项目
implementation 'cn.com.superLei:blelibrary:3.2.0'
我发布博客的时候,目前最新的版本是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,以便于调试)
.setThrowBleException(true)//设置是否抛出蓝牙异常 (默认true)
.setAutoConnect(false)//设置是否自动连接 (默认false)
.setIgnoreRepeat(false)//设置是否过滤扫描到的设备(已扫描到的不会再次扫描)
.setConnectTimeout(10 * 1000)//设置连接超时时长(默认10*1000 ms)
.setMaxConnectNum(7)//最大连接数量
.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() {//实现自定义BleDevice时必须设置
@Override
public MyDevice create(String address, String name) {
return new MyDevice(address, name);//自定义BleDevice的子类
}
})
.setBleWrapperCallback(new MyBleWrapperCallback())//设置全部蓝牙相关操作回调(例: OTA升级可以再这里实现,与项目其他功能逻辑完全解耦)
.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);
扫描之后的回调:
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();
连接或者断开的回调:
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());
}
});
读取数据:
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);
}
})
写入数据:
//写入一包数据
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);
}
});
//写入大数据(文件、图片等)
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() {
}
});
//写入数据到队列中 (默认发送间隔50ms)
ble.writeQueue(RequestTask.newWriteTask(address, data));
//写入数据到队列中 (自定义间隔时间)
ble.writeQueueDelay(delay, RequestTask.newWriteTask(address, data));
//通过特定服务和特征值uuid写入数据
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);
}
});
删除监听:
ble.cancelCallback(connectCallback);
或
ble.cancelCallback(scanCallback);
释放志愿:
ble.released();