https://github.com/wandersnail/easyble
A simple framework for Android Bluetooth Low Energy (BLE)
https://github.com/wandersnail/easyble
android ble bluetooth framework
Last synced: 2 months ago
JSON representation
A simple framework for Android Bluetooth Low Energy (BLE)
- Host: GitHub
- URL: https://github.com/wandersnail/easyble
- Owner: wandersnail
- License: apache-2.0
- Created: 2018-12-11T12:19:44.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-07-06T01:31:57.000Z (over 3 years ago)
- Last Synced: 2023-07-01T02:17:32.242Z (over 2 years ago)
- Topics: android, ble, bluetooth, framework
- Language: Kotlin
- Size: 3.68 MB
- Stars: 43
- Watchers: 5
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 发现还有挺多人不知道怎么用kotlin，所以用java重构了，这个库就不维护了。[点击跳转新库](https://github.com/wandersnail/easyble-x)
[English](https://github.com/wandersnail/easyble/blob/master/README_EN.md)
## 学习提高
[](https://p.zhekou.life)
## 最新版本
[](https://jitpack.io/#wandersnail/easyble)
[](https://maven-badges.herokuapp.com/maven-central/com.github.wandersnail/easyble)
## 功能
- 支持多设备同时连接
- 支持连接同时配对
- 支持搜索已连接设备
- 支持搜索器设置
- 支持自定义搜索过滤条件
- 支持自动重连、最大重连次数限制、直接重连或搜索到设备再重连控制
- 支持请求延时及发送延时设置
- 支持分包大小设置、最大传输单元设置
- 支持注册和取消通知监听
- 支持回调方式，支持使用注解@InvokeThread控制回调线程。注意：观察者监听和回调只能取其一！
- 支持发送设置（是否等待发送结果回调再发送下一包）
- 支持写入模式设置
- 支持设置连接的传输方式
- 支持连接超时设置
## 配置
1. module的build.gradle中的添加依赖，自行修改为最新版本，同步后通常就可以用了：
```
dependencies {
...
implementation 'com.github.wandersnail:easyble:1.1.10'
}
```
2. 如果从jcenter下载失败。在project的build.gradle里的repositories添加内容，最好两个都加上，有时jitpack会抽风，同步不下来。添加完再次同步即可。
```
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
maven { url 'https://dl.bintray.com/wandersnail/android/' }
}
}
```
## 使用方法(kotlin)
1. 初始化SDK
```
Ble.instance.initialize(application)//在Application中初始化
BleLogger.logEnabled = true//只控制打印，不控制回调
BleLogger.logCallback = object : LogCallback {
override fun onLog(priority: Int, log: String) {
when (priority) {
Log.VERBOSE -> TODO()
Log.INFO -> TODO()
Log.DEBUG -> TODO()
Log.WARN -> TODO()
Log.ERROR -> TODO()
Log.ASSERT -> TODO()
}
}
}
```
2. 蓝牙搜索
```
//1. 搜索监听
private val scanListener = object : ScanListener {
override fun onScanStart() {
}
override fun onScanStop() {
}
override fun onScanResult(device: Device) {
//搜索到蓝牙设备
}
override fun onScanError(errorCode: Int, errorMsg: String) {
when (errorCode) {
ScanListener.ERROR_LACK_LOCATION_PERMISSION -> {//缺少定位权限
}
ScanListener.ERROR_LOCATION_SERVICE_CLOSED -> {//位置服务未开启
}
}
}
}
//2. 添加监听
Ble.instance.addScanListener(scanListener)
//3. 搜索设置
Ble.instance.bleConfig.scanConfig.setScanPeriodMillis(30000)
.setUseBluetoothLeScanner(true)
.setAcceptSysConnectedDevice(true)
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
Ble.instance.bleConfig.scanConfig.setScanSettings(ScanSettings.Builder().setScanMode(ScanSettings.SCAN_MODE_LOW_LATENCY).build())
}
//4. 开始搜索
Ble.instance.startScan()
//停止搜索
Ble.instance.stopScan()
```
3. 连接
```
//连接设置
val config = ConnectionConfig()
config.setDiscoverServicesDelayMillis(500)
config.setAutoReconnect(autoReconnect)
...
//建立连接
Ble.instance.connect(device!!, config, object : ConnectionStateChangeListener {
override fun onConnectionStateChanged(device: Device) {
when (device.connectionState) {
IConnection.STATE_SCANNING -> {
}
IConnection.STATE_CONNECTING -> {
}
IConnection.STATE_CONNECTED -> {
}
IConnection.STATE_DISCONNECTED -> {
}
IConnection.STATE_SERVICE_DISCOVERING -> {
}
IConnection.STATE_SERVICE_DISCOVERED -> {
}
IConnection.STATE_RELEASED -> {
}
}
}
override fun onConnectFailed(device: Device?, type: Int) {
when (type) {
IConnection.CONNECT_FAIL_TYPE_NON_CONNECTABLE -> {}
IConnection.CONNECT_FAIL_TYPE_UNSPECIFIED_ADDRESS -> {}
IConnection.CONNECT_FAIL_TYPE_MAXIMUM_RECONNECTION -> {}
}
}
override fun onConnectTimeout(device: Device, type: Int) {
when (type) {
IConnection.TIMEOUT_TYPE_CANNOT_CONNECT -> {}
IConnection.TIMEOUT_TYPE_CANNOT_DISCOVER_SERVICES -> {}
}
}
})
//断开指定连接
Ble.instance.disconnectConnection(device)
//断开所有连接
Ble.instance.disconnectAllConnections()
//释放指定连接
Ble.instance.releaseConnection(device)
//释放所有连接
Ble.instance.releaseAllConnections()
```
4. 读写特征值、开启Notify
```
//方式一：
//1. 实例化观察者
val eventObserver = object : EventObserver {
override fun onBluetoothStateChanged(state: Int) {
}
override fun onLogChanged(log: String, level: Int) {
}
override fun onCharacteristicRead(device: Device, tag: String, serviceUuid: UUID, characteristicUuid: UUID, value: ByteArray) {
}
override fun onRequestFailed(device: Device, tag: String, requestType: Request.RequestType, failType: Int, src: ByteArray?) {
}
override fun onCharacteristicWrite(device: Device, tag: String, serviceUuid: UUID, characteristicUuid: UUID, value: ByteArray) {
}
override fun onRemoteRssiRead(device: Device, tag: String, rssi: Int) {
}
override fun onDescriptorRead(device: Device, tag: String, serviceUuid: UUID, characteristicUuid: UUID, descriptorUuid: UUID, value: ByteArray) {
}
override fun onNotificationChanged(device: Device, tag: String, serviceUuid: UUID, characteristicUuid: UUID, descriptorUuid: UUID, isEnabled: Boolean) {
}
override fun onIndicationChanged(device: Device, tag: String, serviceUuid: UUID, characteristicUuid: UUID, descriptorUuid: UUID, isEnabled: Boolean) {
}
override fun onMtuChanged(device: Device, tag: String, mtu: Int) {
}
override fun onPhyRead(device: Device, tag: String, txPhy: Int, rxPhy: Int) {
}
override fun onPhyUpdate(device: Device, tag: String, txPhy: Int, rxPhy: Int) {
}
override fun onConnectionStateChanged(device: Device) {
}
override fun onConnectFailed(device: Device?, type: Int) {
}
override fun onConnectTimeout(device: Device, type: Int) {
}
override fun onCharacteristicChanged(device: Device, serviceUuid: UUID, characteristicUuid: UUID, value: ByteArray) {
}
}
//2. 注册观察者
Ble.instance.registerObserver(eventObserver)
//3. 调用相应方法
val connection = Ble.instance.getConnection(device)
connection?.readCharacteristic(tag, service, characteristic)
connection?.enableNotification(tag, service, characteristic)
connection?.disableNotification(tag, service, characteristic)
connection?.writeCharacteristic(tag, service, characteristic, byteArrayOf(0x05, 0x06))
connection?.readRssi(tag)
...
//取消注册观察者
Ble.instance.unregisterObserver(eventObserver)
//方式二：
val connection = Ble.instance.getConnection(device)
connection?.readCharacteristic(tag, service, characteristic, object : CharacteristicReadCallback {
@InvokeThread(RunOn.MAIN)
override fun onCharacteristicRead(device: Device, tag: String, serviceUuid: UUID, characteristicUuid: UUID, value: ByteArray) {
}
@InvokeThread(RunOn.BACKGROUND)
override fun onRequestFailed(device: Device, tag: String, requestType: Request.RequestType, failType: Int, src: ByteArray?) {
}
})
connection?.enableNotification(tag, service, characteristic, object : CharacteristicWriteCallback {
override fun onCharacteristicWrite(device: Device, tag: String, serviceUuid: UUID, characteristicUuid: UUID, value: ByteArray) {
}
override fun onRequestFailed(device: Device, tag: String, requestType: Request.RequestType, failType: Int, src: ByteArray?) {
}
})
...
```
5. 释放SDK
```
Ble.instance.release()
```
## 基于此库的BLE调试app
[](http://app.mi.com/details?id=cn.zfs.bledebugger)
[](https://raw.githubusercontent.com/wandersnail/myapks/master/bleutility-v2.1.apk)
