Kotlin BLE Library 使用手册

1. 目录结构及介绍

Kotlin BLE Library 设计用于简化Android平台上蓝牙低功耗（Bluetooth Low Energy, BLE）的使用。此库封装了原生API，并通过Kotlin Coroutines来处理异步操作。以下是其基本目录结构及其简介：

.
├── app_client          # 客户端模块，负责设备连接和数据交互
│   ├── src              # 源代码文件夹
│   └── ...               # 其他相关资源
├── app_server           # 服务器模块，创建BLE服务
│   ├── src
│   └── ...
├── advertiser            # 广告发送器模块，用于设备广播
│   ├── src
│   └── ...
├── scanner               # 扫描器模块，寻找可用的BLE设备
│   ├── src
│   └── ...
├── core                  # 核心功能，包含通用工具和抽象类
│   ├── src
│   └── ...
├── docs                  # 文档资料
├── build.gradle.kts     # Gradle构建脚本
├── settings.gradle.kts  # 设置脚本
└── README.md             # 项目说明文档

每个模块都有其特定的功能实现，例如app_client用于管理与远程BLE设备的连接和通信，app_server则是创建服务并响应客户端请求的部分。

2. 项目启动文件介绍

启动文件并非单指一个文件，而是在实际开发中首次运行或集成这个库时需要关注的关键点：

• 入口点：在Android应用中，通常不直接从库的某个特定文件启动。而是通过在你的应用的Activity或ViewModel中导入库的组件并初始化它们来“启动”功能。例如，初始化扫描器或建立连接的代码可能位于应用的启动Activity或相关的ViewModel里。

• Gradle配置：在项目级的build.gradle文件中添加依赖是开始使用的起点。你应该将以下依赖添加到你的dependencies块中以启用核心功能：

  implementation 'no.nordicsemi.android.kotlin.ble:scanner:1.1.0'
  

• 示例启动代码：假设我们从扫描设备开始，你会在你的应用程序逻辑中类似这样启动BLE扫描：

  // 在适合的地方初始化scanner
  val scanner = BleScanner(context)
  scanner.scan()
      .map { aggregator.aggregateDevices(it) } // 假定aggregator已定义用于聚合扫描结果
      .onEach { /* 更新UI或其他逻辑 */ }
      .launchIn(viewModelScope) // 使用Kotlin Coroutines
  

3. 配置文件介绍

主要涉及的配置文件包括以下几个方面：

Gradle 构建配置

• build.gradle.kts: 这是每个模块的构建配置文件，包含了依赖声明、编译选项等。引入Kotlin BLE Library的主要位置在于这里指定对应的依赖项。

• settings.gradle.kts: 控制哪些子项目被包含进构建中。对于开发者来说，确保所需的模块如scanner, client, 等被正确导入。

应用内配置

库本身并不直接要求外部配置文件，其配置通过代码进行，如设置扫描参数、连接参数等，这些通常是基于应用场景，在程序内部完成的。例如，配置广告信息或设定连接超时时间会在使用库中的特定API时进行。

示例配置代码片段

// 示例：配置广告数据
val advertiserConfig = BleAdvertisingConfig(
    settings = BleAdvertisingSettings(deviceName = "MyPeripheral"),
    advertiseData = BleAdvertisingData(ParcelUuid(YOUR_SERVICE_UUID))
)

// 启动广告
viewModelScope.launch {
    advertiser.create(context).advertise(advertiserConfig)
        .catch { it.printStackTrace() }
        .collect { /* 处理广告事件 */ }
}

请注意，具体配置细节取决于你的应用程序需求和对库的使用方式。务必查阅库的最新文档和示例代码，以获得最准确的指导。