README.md · 淘金小子/BLE

# BLE

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/880ed281aff445f890766ccccbe81d7d)](https://www.codacy.com/app/xiaoyaoyou1212/BLE?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=xiaoyaoyou1212/BLE&amp;utm_campaign=Badge_Grade) [![License](https://img.shields.io/badge/License-Apache--2.0-green.svg)](https://github.com/xiaoyaoyou1212/BLE/blob/master/LICENSE) [![API](https://img.shields.io/badge/API-18%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=18)

**Android BLE基础操作框架，基于回调，操作简单。包含扫描、多连接、广播包解析、服务读写及通知等功能。**

- **项目地址：** [https://github.com/xiaoyaoyou1212/BLE](https://github.com/xiaoyaoyou1212/BLE)

- **项目依赖：** `compile 'com.vise.xiaoyaoyou:baseble:2.0.6'`

## 功能
- **支持多设备连接管理；**

- **支持广播包解析；**

- **支持自定义扫描过滤条件；**

- **支持根据设备名称正则表达式过滤扫描设备；**

- **支持根据设备信号最小值过滤扫描设备；**

- **支持根据设备名称或 MAC 地址列表过滤扫描设备；**

- **支持根据设备 UUID 过滤扫描设备；**

- **支持根据指定设备名称或 MAC 地址搜索指定设备；**

- **支持连接设备失败重试；**

- **支持操作设备数据失败重试；**

- **支持绑定数据收发通道，同一种能力可绑定多个通道；**

- **支持注册和取消通知监听；**

- **支持配置最大连接数，超过最大连接数时会依据 Lru 算法自动断开最近最久未使用设备；**

- **支持配置扫描、连接和操作数据超时时间；**

- **支持配置连接和操作数据重试次数以及重试间隔时间。**

## 简介
打造该库的目的是为了简化蓝牙设备接入的流程。该库是 BLE 操作的基础框架，只处理 BLE 设备通信逻辑，不包含具体的数据处理，如数据的分包与组包等。该库提供了多设备连接管理，可配置最大连接数量，并在超过最大连接数时会依据 Lru 算法自动断开最近最久未使用设备。该库还定制了常用的扫描设备过滤规则，也支持自定义过滤规则。该库所有操作都采用回调机制告知上层调用的结果，操作简单，接入方便。

## 版本说明
[![LatestVersion](https://img.shields.io/badge/LatestVersion-2.0.6-orange.svg)](https://github.com/xiaoyaoyou1212/BLE/blob/master/VERSION.md)

最新版本更新记录
- V2.0.6（2018-04-25）
    - 增加字节数组与整型数转换方法；
    - 增加间隔扫描的配置；
    - 增加获取服务、特征值、属性的方法。

## 安装包下载
[BLE_V2.0.6.apk](https://github.com/xiaoyaoyou1212/BLE/blob/master/screenshot/BLE_V2.0.6.apk)

## 代码托管
[![JCenter](https://img.shields.io/badge/JCenter-2.0.6-orange.svg)](https://jcenter.bintray.com/com/vise/xiaoyaoyou/baseble/2.0.6/)

## 常见问题
[![FAQ](https://img.shields.io/badge/FAQ-%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98-red.svg)](https://github.com/xiaoyaoyou1212/BLE/blob/master/FAQ.md)

## 效果展示
![BLE效果](https://github.com/xiaoyaoyou1212/BLE/blob/master/screenshot/screenshot.gif)

## 使用介绍

### 权限配置
蓝牙操作针对 6.0 以下系统需要配置如下权限：
```
<uses-permission android:name="android.permission.BLUETOOTH"/>
<uses-permission android:name="android.permission.BLUETOOTH_ADMIN"/>
```
而 6.0 以上系统还需要增加模糊定位权限：
```
<uses-permission-sdk-23 android:name="android.permission.ACCESS_COARSE_LOCATION"/>
```
为了简便操作，库中对蓝牙操作需要的权限都做了相关设置不需要重复设置，但 6.0 以上系统需要动态申请模糊定位权限。

### 引入 SDK
在工程 module 的 build.gradle 文件中的 dependencies 中添加如下依赖：
```
compile 'com.vise.xiaoyaoyou:baseble:2.0.5'
```
构建完后就可以直接使用该库的功能了。

### 初始化
在使用该库前需要进行初始化，初始化代码如下所示：
```
//蓝牙相关配置修改
ViseBle.config()
        .setScanTimeout(-1)//扫描超时时间，这里设置为永久扫描
        .setConnectTimeout(10 * 1000)//连接超时时间
        .setOperateTimeout(5 * 1000)//设置数据操作超时时间
        .setConnectRetryCount(3)//设置连接失败重试次数
        .setConnectRetryInterval(1000)//设置连接失败重试间隔时间
        .setOperateRetryCount(3)//设置数据操作失败重试次数
        .setOperateRetryInterval(1000)//设置数据操作失败重试间隔时间
        .setMaxConnectCount(3);//设置最大连接设备数量
//蓝牙信息初始化，全局唯一，必须在应用初始化时调用
ViseBle.getInstance().init(this);
```
初始化可以是在 Application 中也可以是在 MainActivity 中，只需要是在使用蓝牙功能前就行。还有需要注意的是，蓝牙配置必须在蓝牙初始化前进行修改，如果默认配置满足要求也可以不修改配置。

### 设备扫描
库中针对设备扫描定义了几种常用过滤规则，如果不满足要求也可以自己定义过滤规则，下面针对库中提供的过滤规则使用方式一一介绍：

- 扫描所有设备
```
ViseBle.getInstance().startScan(new ScanCallback(new IScanCallback() {
    @Override
    public void onDeviceFound(BluetoothLeDevice bluetoothLeDevice) {

}

@Override
    public void onScanFinish(BluetoothLeDeviceStore bluetoothLeDeviceStore) {

}