diff --git a/README.md b/README.md index 910924e45d99a35baf96caf1bc4652c517caa721..e5e589a9fa2a0a632c2aa3c9ee62c197004d6c7c 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,115 @@ # Android-JL_Bluetooth -The bluetooth SDK for Android +**杰理蓝牙音箱SDK** 是由 ``珠海市杰理科技股份有限公司`` 提供的,专为本公司音箱耳机类产品设计的蓝牙控制开发平台。 -# 一、概述 +## 一、概述 -**杰理蓝牙音箱SDK**是``珠海市杰理科技股份有限公司``(以下简称“本公司”)开发,专门为本公司音箱耳机类产品提供蓝牙控制开发平台。 +### 1.1 运行环境 +| 类别 | 兼容范围 | 备注 | +|------|----------|------| +| 系统 | Android 5.1 及以上系统 | 支持 BLE 功能 | +| 硬件要求 | 支持 RCSP 协议的固件 | 如 AC707N、JL701N、AC697N、AC696N、AC695N、AC693N 等 SDK | +| 开发平台 | Android Studio | 建议使用最新版本进行开发 | +### 1.2 快速接入 -## 1.1 运行环境 +为了帮助开发者快速接入杰理蓝牙 SDK,请在开发前详细阅读:[杰理之家 SDK 开发文档(Android)](https://doc.zh-jieli.com/Apps/Android/jielihome/zh-cn/master/index.html) -| 类别 | 兼容范围 | 备注 | -| ---- | ---- | ---- | -| 系统 | Android 5.1 以上系统 | 支持BLE功能 | -| 硬件要求 | 支持RCSP协议的固件 | AC707N, JL701N, AC697N, AC696N, AC695N, AC693N等SDK | -| 开发平台 | Android Studio | 建议使用最新版本开发 | +## 二、压缩包文件结构 +``` +|- apk -- 测试用的 APK 文件 +|- code -- 示例程序源码 + |- BluetoothSDK_Vx.x.x_SDK_Vx.x.x +|- doc -- 开发文档 + |- 杰理 OTA 外接库(Android) 开发文档(在线文档) + |- 杰理之家 SDK(Android) 开发文档(在线文档) + |- 杰理开放平台接入说明文档.pdf(接入杰理之家服务器说明) + |- 杰理之家 APP 用户手册 V1.2.pdf(APP 操作说明) +|- libs -- 核心库文件 +``` +## 三、版本说明 -## 1.2 快速接入 +| 版本 | 日期 | 修改者 | 修改记录 | +|------|------|--------|----------| +| 4.1.0 | 2025/07/18 | 钟卓成 | 增加 701N 和 707N 彩屏仓 SDK 支持:
1.1 增加屏幕亮度控制
1.2 增加屏幕保护程序控制
1.3 增加天气同步
1.4 增加消息同步 | +| 4.0.0 | 2025/04/15 | 钟卓成 | 1. 分离蓝牙实现与 RCSP 功能实现
2. 优化 SDK 日志输出
3. 优化文件浏览功能
4. 增加 Android 14 兼容处理 | +| 3.2.0 | 2023/11/23 | 钟卓成 | 1. 新增 TWS 耳机一拖二功能和接口
2. 修复已知问题 | +| 3.0.8 | 2022/08/12 | 张焕明 | 1. 新增辅听耳机的验配功能 | +| 3.0.7 | 2022/07/20 | 张焕明 | 1. 增加支持挂脖耳机 UI | +| 2.9.1 | 2021/08/25 | 钟卓成 | 1. 修复手机兼容性问题 | +| 2.9.0 | 2021/05/18 | 陈森华 | 1. 增加音箱 SDK 的闹钟贪睡模式
2. 增加耳机 SDK 的主动降噪(ANC)设置功能 | -为了帮助开发者快速接入杰理之家SDK,请开发前详细阅读: [杰理之家SDK开发文档(Android)](https://doc.zh-jieli.com/Apps/Android/jielihome/zh-cn/master/index.html) +## 四、功能说明 +本 SDK 提供了丰富的蓝牙设备控制功能,包括但不限于: +- **设备连接与管理**:支持蓝牙设备的扫描、连接、断开、配对、历史设备管理等。 +- **音频控制**:支持音乐播放、暂停、切换曲目、音量调节、播放模式设置等。 +- **闹钟管理**:支持闹钟设置、编辑、删除、铃声选择等。 +- **EQ 设置**:支持均衡器调节、预设模式切换。 +- **灯光控制**:支持灯光模式切换、颜色调节、动态效果设置。 +- **OTA 升级**:支持设备固件升级功能。 +- **充电仓管理**:支持屏幕亮度、壁纸、动画等个性化设置。 +- **网络与定位**:支持天气同步、消息推送、地图定位等功能。 -# 二、压缩包文件结构 +## 五、接入说明 -```tex -|- apk -- 测试APK -|- code -- 演示程序源码 - |- BluetoothSDK_Vx.x.x_SDK_Vx.x.x -|- doc -- 开发文档 - |- 杰理OTA外接库(Android)开发文档 --- 在线开发文档 - |- 杰理之家SDK(Android)开发文档 --- 在线开发文档 - |- 杰理开放平台接入说明文档.pdf --- 接入杰理之家服务器文档 - |- 杰理之家APP用户手册V1.2.pdf --- APP操作说明文档 -|- libs -- 核心库 +### 5.1 集成 SDK + +将 `libs` 目录下的 `.aar` 文件复制到您的项目 `app/libs` 目录,并在 `build.gradle` 中添加依赖: + +```gradle +implementation files('libs/jl_bluetooth_rcsp_V4.1.0_40116-release.aar') +implementation files('libs/jl_bt_ota_V1.10.0_10932-release.aar') ``` +### 5.2 初始化 SDK + +在 `Application` 类中初始化蓝牙 SDK: + +```java +public class MainApplication extends Application { + private RCSPController mRCSPController; + + @Override + public void onCreate() { + super.onCreate(); + mRCSPController = RCSPController.getInstance(); + mRCSPController.init(this); + } +} +``` + +### 5.3 使用蓝牙功能 + +通过 `RCSPController` 调用蓝牙相关功能,例如扫描设备、连接设备、发送指令等。 + +```java +RCSPController controller = RCSPController.getInstance(); +controller.startBleScan(); // 开始 BLE 扫描 +controller.connectToDevice(device); // 连接指定设备 +``` + +## 六、注意事项 + +- 请确保在 AndroidManifest.xml 中声明必要的权限,如蓝牙、位置、存储等。 +- Android 6.0 及以上系统需要动态申请权限。 +- Android 10 及以上系统需要适配分区存储(Scoped Storage)。 +- 使用 OTA 功能时,请确保设备处于可升级状态,并提供升级文件路径。 + +## 七、技术支持 +如在使用过程中遇到问题,请参考官方文档或联系技术支持团队。 +**官方文档地址**:[杰理之家 SDK 开发文档](https://doc.zh-jieli.com/Apps/Android/jielihome/zh-cn/master/index.html) +**技术支持邮箱**:support@zh-jieli.com -# 三、版本说明 +**官方网站**:[珠海市杰理科技股份有限公司](https://www.zh-jieli.com) -| 版本 | 日期 | 修改者 | 修改记录 | -| ----- | ---------- | ------ | ------------------------------------------------------------ | -| 4.1.0 | 2025/07/18 | 钟卓成 | 1. 增加701N和707N彩屏仓SDK支持
1.1 增加屏幕亮度控制
1.2 增加屏幕保护程序控制
1.3 增加天气同步
1.4 增加消息同步 | -| 4.0.0 | 2025/04/15 | 钟卓成 | 1、分离蓝牙实现和RCSP功能实现
2、优化SDK日志输出
3、优化文件浏览功能
4、增加Android 14的兼容处理 | -| 3.2.0 | 2023/11/23 | 钟卓成 | 1、新增 TWS 耳机一拖二功能和接口
2、修复已知问题 | -| 3.0.8 | 2022/08/12 | 张焕明 | 1、新增辅听耳机的验配功能 | -| 3.0.7 | 2022/07/20 | 张焕明 | 1、增加支持挂脖耳机 UI | -| 2.9.1 | 2021/08/25 | 钟卓成 | 1、修复手机兼容性问题 | -| 2.9.0 | 2021/05/18 | 陈森华 | 1、增加音箱SDK的闹钟贪睡模式
2、增加耳机SDK的主动降噪(ANC)设置功能 | +## 八、许可证 +本 SDK 遵循杰理科技的软件许可协议,请在使用前阅读并同意相关条款。 \ No newline at end of file