开发文档中心导航

本页是 Android-JL_Bluetooth 仓库中全部开发文档的导航入口，汇总 doc/ 开发文档文件夹、README.md 顶层导航以及杰理在线文档中心的构成与使用方法，帮助开发者快速定位所需资料。

Purpose and Scope

本页面向需要查阅 Android 杰理之家（JieLi Home）SDK 开发资料的开发者，说明：

• 仓库中 doc/ 文件夹下各类文档资源（中英文 SDK 开发文档、PDF 说明文档、在线文档快捷方式）的用途与组织方式；
• README.md 作为仓库总导航如何引导开发者进入文档中心、示例代码与核心库；
• 杰理官方在线文档中心（doc.zh-jieli.com）与本地文档系统的对应关系；
• SDK 文档系统内部的目录结构（开发框架 / 工程介绍 / 开发说明 / 其他）及 API 参考页清单。

本页是导航与索引页，不重复展开具体 API 的用法。SDK 初始化配置、BluetoothOption 字段细节、调试技巧等具体内容属于其他页面（如 SDK 开发说明文档、API 参考）的范畴，本页仅给出指引与入口链接。

Overview

该仓库（Android-JL_Bluetooth）是杰理科技（Jieli-Tech）开源的 Android 蓝牙 SDK 示例仓库，围绕杰理之家（JieLi Home）方案提供：

• 核心库：libs/ 下的多个 AAR（如 jl_bluetooth_rcsp、jl_bt_ota、jl_eq、jl_audio_decode 等）；
• 参考工程：code/PiHome_V1.13.0_SDK_V4.2.0 杰理之家项目源码；
• 文档中心：doc/ 开发文档文件夹，包含 Sphinx 生成的 HTML 文档系统（中英文两版）、PDF 数据手册与在线文档快捷方式。

doc/ 中的 HTML 文档系统版本为 V4.2.0，主题为「欢迎使用杰理之家SDK开发文档(Android)」。根据 doc/ReadMe.txt，打开方式为：进入 JieLi_Home_SDK_V4.2.0_html_zh/html 文件夹，双击 index.html，浏览器即显示 SDK 开发说明文档，随后可查看「其他/发布记录」。

文档系统按四类划分内容（来自 index.doctree 的 toctree 结构）：

Architecture

下图展示仓库内文档中心的整体架构：README.md 是总入口，doc/ 是本地文档载体，其中 HTML 文档系统按四个分类组织，并可与杰理在线文档中心对应。

flowchart TD
    subgraph sg_Repo["Android-JL_Bluetooth 仓库"]
        README["README.md<br/>仓库总导航"]
        DOC["doc/<br/>开发文档文件夹"]
        CODE["code/<br/>参考源码工程"]
        LIBS["libs/<br/>核心库 AAR"]
    end

    subgraph sg_DocCenter["开发文档中心 (doc/)"]
        ZH["JieLi_Home_SDK_V4.2.0_html_zh<br/>中文版 SDK 文档"]
        EN["JieLi_Home_SDK_V4.2.0_html_en<br/>英文版 SDK 文档"]
        PDFS["PDF 说明文档<br/>接入说明 / 用户手册 / 编解码"]
        URLS["在线文档快捷方式 (.url)"]
    end

    subgraph sg_SdkDocs["SDK 文档系统 (Sphinx HTML)"]
        FW["开发框架<br/>development/api/*"]
        PROJ["工程介绍<br/>resource/sdk_structure"]
        DEV["开发说明<br/>development/*"]
        OTHER["其他<br/>other/*"]
    end

    subgraph sg_Online["杰理在线文档中心"]
        ONLINE["doc.zh-jieli.com<br/>杰理之家SDK开发文档"]
    end

    README --> DOC
    README --> CODE
    README --> LIBS
    DOC --> ZH
    DOC --> EN
    DOC --> PDFS
    DOC --> URLS
    ZH --> FW
    ZH --> PROJ
    ZH --> DEV
    ZH --> OTHER
    README --> ONLINE

架构要点：

• README.md（总导航）：在「四、工程结构」中给出整个仓库的目录树，明确 doc/ 为"开发文档文件夹"，并对每个文档给出注释；在「七、社区与支持」中链接到在线文档中心与 GitHub Issues。
• doc/（本地文档载体）：中英文两份 HTML 文档系统是主体，其余为 PDF 数据手册与指向线上文档的 .url 快捷方式。
• SDK 文档系统（四分类）：开发框架收录全部 API 参考页；工程介绍、开发说明、其他三部分覆盖集成流程、调试与发布记录。
• 在线文档中心：doc.zh-jieli.com 与本地 HTML 文档同源，路径结构（如 other/debug.html）与本地分类一致，适合获取最新线上版本。

文档中心构成

本地 doc/ 文件夹资源清单

根据 README.md 的工程结构说明及 doc/ 目录实际内容，doc/ 文件夹包含以下资源：

HTML 文档系统打开方式

doc/ReadMe.txt 明确给出了文档系统的使用方法：

1. 打开 JieLi_Home_SDK_V4.2.0_html_zh/html 文件夹
2. 双击打开 index.html 文件
3. 默认浏览器会显示 SDK开发说明文档
4. 然后查看 其他/发布记录

—— 来源：doc/ReadMe.txt

英文版（JieLi_Home_SDK_V4.2.0_html_en）操作方式相同。这一设计意图是让开发者零环境依赖即可阅读文档：整套文档由 Sphinx 静态生成，无需联网或安装工具，双击即用。

SDK 文档系统内部结构（开发框架分类）

JieLi_Home_SDK_V4.2.0_html_zh 的 doctrees 目录揭示了文档系统完整的内容组织。其中「开发框架」分类下的 API 参考页包括（见 doctrees 目录）：

使用流程（导航路径）

下图展示开发者从入口到具体文档的典型导航流程：

flowchart TD
    Start([开发者入口]) --> Readme["README.md"]
    Readme -->|"四、工程结构"| DocFolder["doc/ 开发文档文件夹"]
    DocFolder --> Choice{"需要哪类资料?"}
    Choice -->|"SDK 功能开发"| HtmlDocs["打开 html/index.html<br/>或在线文档中心"]
    Choice -->|"平台接入 / APP操作 / 编解码"| PdfDocs["PDF 说明文档"]
    Choice -->|"OTA / SDK 线上文档"| UrlDocs["在线快捷方式 (.url)"]
    HtmlDocs --> Categories["开发框架 / 工程介绍 / 开发说明 / 其他"]
    Categories -->|"开发框架"| Apis["API 参考页<br/>bt_api / eq_ctrl_api / ..."]
    Categories -->|"开发说明"| Import["工程导入与接口说明"]
    Categories -->|"其他"| Publish["调试说明 / 发布记录 / 常见问答"]
    Apis --> CmdExample["对照示例工程 code/ 与配置代码"]
    Publish --> Version["对照 README 八、版本历史"]

导航路径要点：

1. 起点：README.md 的「四、工程结构」给出 doc/ 各资源的注释，是唯一的本地导航入口。
2. 分支选择：按资料类型分流——SDK 功能开发走 HTML 文档系统，接入/编解码/APP 操作走 PDF，OTA 与线上文档走 .url 快捷方式。
3. 深入阅读：在 HTML 文档系统中按四个分类逐层下钻；开发框架下的 API 页与 libs/ 中 AAR 对应，开发说明页与 code/ 示例工程对应。
4. 交叉对照：发布记录（其他/发布记录）与 README.md「八、版本历史」表格互相印证，可核对 SDK 版本 4.2.0 / 4.1.0 / 4.0.0 / 3.2.0 的演进。

使用示例

示例一：仓库目录树（定位文档中心）

README.md 的「四、工程结构」用目录树标注了 doc/ 中各文档资源的用途，是导航文档中心的第一手索引：

Android-JL_Bluetooth/
├── apk/                                     # 测试APK文件夹
│   ├── btsmart-V1.13.0-202601231637-113126-debug.apk    # 杰理之家测试版本
│   ├── UpdateContent.txt                                # 更新说明
│   └── 杰理之家导出打印日志说明.pdf                          # 杰理之家APP导出打印日志说明
├── code/                                    # 参考源码工程文件夹
│   ├── PiHome_V1.13.0_SDK_V4.2.0                        # 杰理之家项目源码
│   └── 杰理音频编解码库开发资料_V2.1.0_Android               # 杰理音频编解码开发资料(OPUS)
├── doc/                                     # 开发文档文件夹
│   ├── JieLi_Home_SDK_V4.2.0_html_zh                    # 杰理之家SDK开发说明文档(中文版本)
│   ├── JieLi_Home_SDK_V4.2.0_html_en                    # 杰理之家SDK开发说明文档(英文版本)
│   ├── 杰理开放平台接入说明文档.pdf                          # 接入杰理之家服务器的说明文档
│   ├── 杰理之家APP用户手册V1.2.pdf                         # 杰理之家的操作说明文档
│   ├── 杰理OTA(Android)在线开发文档                        # OTA库的开发说明文档
│   ├── 杰理之家SDK(Android)开发文档                        # 杰理之家SDK开发说明文档(线上版)
│   ├── 杰理音频编码库开发说明.pdf                           # 杰理OPUS编解码开发说明文档
│   └── JLA_V2编解码库开发说明.pdf                          # 杰理JLA_V2编解码开发说明文档
├── libs/                                    # 核心库文件夹
│   ├── jl_bt_ota_V1.10.0_10931-release.aar              # 杰理OTA相关
│   ├── jl_bluetooth_rcsp_V4.0.0_40015-release.aar       # 杰理之家SDK相关
│   └── ...
└── ReadMe.txt                               # 说明文件

—— 来源：README.md

示例二：文档阅读入口

doc/ReadMe.txt 给出了本地 HTML 文档系统的打开步骤，同时暗示了「其他/发布记录」是了解 SDK 版本演进的首选位置：

JieLi_Home_SDK_V4.2.0_html_zh 文档系统

1. 打开 JieLi_Home_SDK_V4.2.0_html_zh/html 文件夹
2. 双击打开 index.html 文件 
3. 默认浏览器会显示 SDK开发说明文档
4. 然后查看 其他/发布记录

—— 来源：doc/ReadMe.txt

示例三：在线文档中心入口

README.md「七、社区与支持」将在线文档中心列为第一资源，并给出了本地 doc/ 作为数据手册的对应入口：

| 📖 **在线文档中心** | [杰理之家SDK开发文档](https://doc.zh-jieli.com/Apps/Android/jielihome/zh-cn/master/index.html) |
| 📄 **数据手册** | [开发说明文档](https://gitee.com/Jieli-Tech/Android-JL_Bluetooth/tree/main/doc/) |

—— 来源：README.md

示例四：文档中心之外的配套配置代码

文档中心描述的能力与仓库中的 SDK 配置代码一一对应。例如「开发框架」中的基础配置页对应 README.md 的 SDK 初始化示例：

BluetoothOption bluetoothOption = BluetoothOption.createDefaultOption();//创建默认配置
bluetoothOption.setPriority(BluetoothOption.PREFER_BLE)//通信方式，支持ble和spp
           .setUseMultiDevice(true) //是否支持多设备管理
           .setTimeoutMs(2000)//命令超时时间, 默认2000ms
           .setMtu(509)       //调节蓝牙MTU
           .setUseDeviceAuth(true);//是否开启设备认证。 与固件工程师确认
//配置参数
RCSPController.init(context, bluetoothOption);
//JL_BluetoothManager.getInstance(context).configure(bluetoothOption);

—— 来源：README.md

配置参考

BluetoothOption 是 SDK 的核心配置对象，其字段在文档中心的「开发框架」分类中有详细说明，README.md 则给出了速查表（README.md 五、配置说明）：

注：本页仅将配置表作为文档中心导航的配套速查列出；完整说明请查阅文档系统中「开发框架」对应 API 页面。

版本历史与文档版本对应

文档中心的 HTML 文档系统版本为 V4.2.0，与仓库 README.md「八、版本历史」及 libs/ 中 AAR 版本保持一致。版本演进概要（README.md）：

配合文档系统「其他/发布记录」页面使用，可追溯每个功能接口的引入版本，判断历史代码是否需要迁移。

检索与索引能力

本地 HTML 文档系统除 index.html 主页外，还提供两类检索入口（见 html 目录）：

• genindex.html / genindex-all.html：全量 API 索引页，按字母/拼音列出所有可索引符号，适合精确查找接口名；
• search.html + searchindex.js：客户端全文搜索页，无需后端即可检索全部文档内容；
• objects.inv：Sphinx 对象清单，供外部工具（如 IDE 文档查看器）离线引用。

这是 Sphinx 静态站点的标准能力，意味着开发者可以在完全离线的环境中完成从导航、索引到全文检索的全部文档查阅流程。

调试与支持入口

文档中心还关联了问题排查资源（README.md 六、调试技巧）：

• SDK 调试：参考在线文档中心「其他」分类的 SDK调试说明（本地对应 other/debug 页面）；
• APP 日志导出：参考 apk/杰理之家导出打印日志说明.pdf；
• 问题反馈：通过 GitHub Issues 提交，仓库状态为活跃维护。

Related Links

• README.md（仓库总导航）
• doc/ReadMe.txt（文档打开说明）
• 中文版 SDK 文档主页 index.html
• 中文版 API 文档目录（开发框架）
• 错误码常量页
• 杰理在线文档中心（线上版）
• GitHub Issues（问题反馈）