杰理 SDK 文档中心
首页
首页
  • 概述

    • SDK 概览与产品定位
    • 支持芯片平台与蓝牙认证
    • SDK 架构与目录分层
  • 快速开始

    • 环境搭建与编译工具链
    • 编译构建系统
    • 板级工程与配置
    • 烧录与固件升级工具
  • 应用工程

    • 应用选择与工程总览
    • SPP + BLE 数传应用框架
    • 透传与 AT 指令示例
    • BLE 广播/中心与定位示例
    • 2.4G 私有协议与 Dongle 示例
    • 云平台接入示例
    • HID 人机交互应用框架
    • HID 示例工程(键盘/鼠标/遥控器/手柄)
    • Bluetooth Mesh 应用框架
    • Mesh 模型与 Mesh DFU 固件升级
    • Mesh 音频编解码演示
  • 芯片平台与硬件抽象

    • 芯片平台总览与差异
    • 音频编解码与时钟管理
    • 外设驱动接口(ADC/IIC/SPI/PWM/LED/充电)
    • 芯片配置工具与下载支持
  • 蓝牙协议栈

    • 蓝牙控制器层(btctrler)
    • 蓝牙协议栈与 Profile(btstack)
    • 蓝牙模块选择与配置
  • 媒体与音频框架

    • 音频流框架
    • 音频编解码与 A2DP 媒体
    • 音频效果处理(EQ/频谱/变调/环绕/超低音)
    • 本地 TWS 与音频同步
  • 系统服务与运行时

    • 实时操作系统与任务调度
    • 消息事件机制
    • 电源管理与低功耗
    • 存储与配置系统
    • 设备驱动框架(USB/RTC)
  • 应用公共组件

    • 音频应用组件
    • 设备外设抽象(按键/触摸/传感器/存储)
    • 蓝牙公共模块与消息联动
    • 调试与配置组件
    • 杰理关键词唤醒(jl_kws)
  • 第三方协议与云平台接入

    • 杰理 RCSP 私有协议
    • 低功耗蓝牙 Mesh 方案(llsync_mesh)
    • Sig Mesh 方案
    • 涂鸦协议接入
    • 腾讯连连接入
    • 华为 HiLink 接入
  • 固件升级与维护

    • OTA 升级机制
    • 升级补丁与版本维护
    • 升级工具链(BLE OTA / USB Dongle OTA)
  • 文档与开发资源

    • 数据手册与架构文档
    • 协议与云平台开发文档
    • 常见问题与技术支持

数据手册与架构文档

本文档介绍 fw-AC63_BT_SDK 仓库内 doc/ 目录下的文档资源体系,包括芯片数据手册(datasheet/)、SDK 架构文档(architure/)、常见问题(FAQ/)与发布版本信息,以及它们与芯片平台(bd19 / br23 / br25 / br34)和应用工程(spp_and_le / hid / mesh)之间的对应关系与使用方式。

Purpose and Scope

本页覆盖以下内容:

  • doc/ 目录的完整结构及其在 SDK 仓库中的定位;
  • doc/datasheet/ 下按芯片型号组织的数据手册(Datasheet)与参考原理图清单;
  • doc/architure/ 下的 SDK 架构文档(模式管理接口说明、系统定时器接口设计说明);
  • SDK 发布版本信息文档;
  • 文档资源与芯片平台、应用工程之间的选型对应关系和使用流程。

以下相关主题不属于本页范围,请参阅对应页面:

  • SDK 编译、烧录与升级流程 → 请参见仓库 README 中的「环境搭建」「编译指南」「烧录与升级」章节(README.md);
  • 具体应用工程的实现细节(SPP + BLE 透传、HID、Mesh)→ 请参见对应应用目录文档;
  • 在线文档中心与 SoC 数据手册扼要 → doc.zh-jieli.com/AC63。

Overview

fw-AC63_BT_SDK 是杰理科技为 AC63 系列芯片提供的通用蓝牙 SDK 固件开发包,基于 Zephyr RTOS,支持 SPP + BLE 透传/数传、HID 人机交互与 Bluetooth Mesh 三类典型应用场景(README.md#L36-L44)。

在 SDK 中,doc/ 目录承担"文档资源"角色,是开发者获取芯片规格、硬件参考设计与SDK 内部接口设计的权威来源。仓库 README 的工程结构一节明确标注了它的职责划分(README.md#L195-L201):

├── doc/                           # 文档资源
│   ├── datasheet/                 #   芯片数据手册
│   ├── architure/                 #   SDK 架构文档
│   ├── FAQ/                      #   常见问题

该目录中的文件均为 PDF 二进制文档(本页无法直接提取其内部内容,文档清单与命名均来自对仓库文件列表的实测)。文档按"芯片型号 → 文档类型"两级目录组织,架构文档则直接平铺在 architure/ 下。文档的文件名自带版本号(如 V2.0、V2.1、V2.2),这是仓库内唯一可验证的文档版本管理方式,选型与硬件设计时必须与对应芯片型号严格匹配。

Architecture

下图展示 SDK 文档资源在仓库中的位置及其与源码、应用工程的依赖关系:

flowchart TD
    subgraph sg_SDK["fw-AC63_BT_SDK 仓库"]
        subgraph sg_Docs["doc/ 文档资源"]
            DS["datasheet/ 芯片数据手册"]
            AR["architure/ SDK 架构文档"]
            FAQ["FAQ/ 常见问题"]
            REL["发布版本信息.pdf"]
        end
        subgraph sg_Code["SDK 源码"]
            APP["apps/ 应用工程"]
            LIB["include_lib/ 头文件与库"]
        end
    end

    DS -->|"芯片选型依据"| APP
    AR -->|"接口设计规范"| APP
    REL -->|"版本配套说明"| LIB
    APP --> LIB

各组成部分的职责:

目录/文件角色说明
doc/datasheet/芯片数据手册按芯片型号分目录存放 Datasheet、BLE 参考原理图、鼠标标准原理图等硬件设计文档
doc/architure/SDK 架构文档描述 SDK 内部模块接口设计(模式管理、系统定时器等),供上层应用开发参考
doc/FAQ/常见问题README「常见问题」章节直接引用(README.md#L383)
doc/AC630N_bt_data_transfer_sdk_发布版本信息.pdf版本发布信息记录 SDK 发布版本配套关系,README 的「SDK 版本历史」在线页面与之对应
apps/应用工程消费文档与库的实际代码(spp_and_le / hid / mesh)
include_lib/头文件与库蓝牙协议栈、驱动、媒体、系统等预编译库(README.md#L196)

设计意图:将硬件规格(datasheet)与软件接口(architure)分离归档,一方面让硬件工程师可以按芯片型号快速定位原理图与 Datasheet,另一方面让软件工程师通过架构文档理解 SDK 模块的接口契约,而无需通读协议栈源码。这种"规格、接口、FAQ、版本"四类文档分层的组织方式,与仓库 README.md 中"文档中心 → 芯片数据手册 → SDK 架构文档 → SDK 版本历史"的导航结构保持一致(README.md#L401-L404)。

文档资源目录结构

datasheet/ 芯片数据手册

doc/datasheet/ 采用 芯片系列/芯片型号/ 两级目录组织。仓库实测中可见 AC632N 系列(对应 bd19 平台)下各芯片型号的文档,每个型号目录内按文档类型存放:

  • Datasheet:芯片数据手册(电气特性、引脚定义、封装等规格)
  • BLE 参考原理图:蓝牙应用最小系统参考设计(BLE 参考原理图 / BLE 蓝牙 Dongle 参考原理图)
  • 鼠标标准原理图:HID 鼠标产品的标准硬件参考设计(仅部分型号提供)

实测清单如下(文件名与版本号直接来自仓库文件列表):

芯片型号数据手册BLE 参考原理图鼠标标准原理图
AC6321AAC6321A_Datasheet V2.0.pdfAC6321A_BLE参考原理图V2.1.pdfAC6321A_鼠标标准原理图V1.0.pdf
AC6323AAC6323A_Datasheet V2.0.pdfAC6323A_BLE参考原理图 V2.1.pdfAC6323A_鼠标标准原理图V1.0.pdf
AC6328AAC6328A_Datasheet V2.0.pdfAC6328A_BLE参考原理图V2.2.pdf—
AC6328BAC6328B_Datasheet V2.0.pdfAC6328B_BLE蓝牙Dongle参考原理图V2.1.pdf—
AC6329BAC6329B_Datasheet V2.0.pdfAC6329B_BLE参考原理图V2.1.pdf—
AC6329CAC6329C_Datasheet V2.0.pdfAC6329C_BLE参考原理图V2.0.pdf—
AC6329EAC6329E_Datasheet V2.0.pdfAC6329E_BLE参考原理图 V2.1.pdf—
AC6329FAC6329F_Datasheet V2.0.pdfAC6329F_BLE参考原理图V2.0.pdf—

说明:以上清单来自仓库文件列表的实测结果(受列表工具返回数量限制,仅展示 AC632N 系列下已确认的 8 个型号)。br23(AC635N)、br25(AC636N)、br34(AC638N)平台对应的数据手册未在本目录中直接确认,硬件选型时可参考 README「支持的芯片与平台」章节(README.md#L50-L57)并通过在线文档中心获取。

architure/ SDK 架构文档

doc/architure/ 存放 SDK 内部模块的接口设计说明,仓库实测包含两份:

文档覆盖模块用途
模式管理接口说明.pdf模式管理(Mode Management)说明 SDK 工作模式(如 SPP / BLE 等模式)的切换接口与状态机设计,应用层开发模式切换逻辑时需参考
系统定时器接口设计说明文档.pdf系统定时器(System Timer)说明基于 Zephyr RTOS 的系统定时器接口封装与使用约束,涉及功耗与调度时需参考

注意:两份文档均为 PDF 二进制文件,本页无法提取其内部章节;以上模块归属推断自文档文件名与 SDK 基于 Zephyr RTOS 的事实(README.md#L36),接口签名请以下载文档原文为准。

SDK 发布版本信息

仓库根目录 doc/ 下还有一份 AC630N_bt_data_transfer_sdk_发布版本信息.pdf,用于说明数据透传 SDK 的发布版本配套关系。它对应 README 顶部导航中的「SDK 版本历史」链接(README.md#L10),在线版为 版本发布记录。

选型与文档使用流程

开发者从产品需求到落地开发,文档资源介入的典型路径如下:

flowchart TD
    Start([产品需求]) --> App{"应用类型"}
    App -->|"SPP + BLE 透传/数传"| SPP["apps/spp_and_le"]
    App -->|"HID 人机交互"| HID["apps/hid"]
    App -->|"Bluetooth Mesh"| MESH["apps/mesh"]
    SPP --> Chip{"芯片平台"}
    HID --> Chip
    MESH --> Chip
    Chip -->|"bd19"| AC632N["AC6321A / AC6323A / AC6328A / AC6328B<br/>AC6329B / AC6329C / AC6329E / AC6329F"]
    Chip -->|"br23"| BR23["AC6351D / AC635N"]
    Chip -->|"br25"| BR25["AC6363F / AC6366C / AC6368A<br/>AC6368B / AC6369C / AC6369F / AC636N"]
    Chip -->|"br34"| BR34["AC6381A / AC6385A / AC638N"]
    AC632N --> DS["数据手册 + BLE 参考原理图"]
    BR23 --> DS
    BR25 --> DS
    BR34 --> DS
    DS --> Arch["架构文档(模式管理 / 系统定时器)"]
    Arch --> Dev["SDK 开发与调试"]

流程各步骤说明:

  1. 确定应用类型:根据产品形态选择 apps/spp_and_le(透传/数传)、apps/hid(键盘/鼠标/遥控器等)或 apps/mesh(智能照明/传感器网络)——三者的应用工程目录在 README 中明确列出(README.md#L112-L117)。
  2. 确定芯片平台:芯片型号分属 bd19 / br23 / br25 / br34 四个平台,README 给出了完整的"平台 × 型号 × 适用应用"对照表(README.md#L50-L57)。
  3. 查阅硬件文档:在 doc/datasheet/<系列>/<型号>/ 下取对应型号的 Datasheet 与参考原理图,用于原理图设计、引脚分配与 PCB 布局。
  4. 查阅架构文档:进入 SDK 模块开发后,通过 doc/architure/ 下的模式管理、系统定时器接口说明理解模块契约,避免与协议栈内部实现耦合。
  5. 版本核对:对照发布版本信息文档确认 SDK 代码、库文件(include_lib/)与文档版本匹配后再编译烧录。

数据手册与 SDK 平台的对应关系

仓库实测的 AC632N 系列 8 个型号(AC6321A / AC6323A / AC6328A / AC6328B / AC6329B / AC6329C / AC6329E / AC6329F)全部属于 bd19 平台(README.md#L54),均支持 spp_and_le / hid / mesh 三种应用。其中:

  • AC6321A / AC6323A:额外提供鼠标标准原理图,是 HID 鼠标产品的首选参考;
  • AC6328B:提供的是 BLE 蓝牙 Dongle 参考原理图,面向 Dongle 类接收端产品;
  • 其余型号:提供标准 BLE 参考原理图,适用于透传与普通 BLE 产品。

设计意图:同一系列内按"最小系统参考设计"与"产品化参考设计"分层提供硬件文档,让硬件工程师既能看到芯片可用性边界(Datasheet),又能直接复用经过验证的射频与电源设计,缩短产品化周期。

Usage Examples

以下示例摘自仓库 README,展示文档资源在 SDK 中的实际引用方式。

示例 1:工程结构中 doc/ 目录的定位

README「五、工程结构」章节(README.md#L195-L201):

├── doc/                           # 文档资源
│   ├── datasheet/                 #   芯片数据手册
│   ├── architure/                 #   SDK 架构文档
│   ├── FAQ/                      #   常见问题

Source: README.md

示例 2:文档资源入口导航

README「文档中心」资源表(README.md#L401-L404):

| 🗄️ **芯片数据手册** | [SoC 数据手册扼要](https://doc.zh-jieli.com/vue/#/docs/ac63) / [本地下载](https://gitee.com/Jieli-Tech/fw-AC63_BT_SDK/blob/master/doc/datasheet) |
| 🏗️ **SDK 架构文档** | [模块架构说明](https://gitee.com/Jieli-Tech/fw-AC63_BT_SDK/blob/master/doc/architure) |
| 📚 **SDK 版本历史** | [版本发布记录](https://doc.zh-jieli.com/AC63/zh-cn/master/other/version/index.html) |

Source: README.md

该表说明仓库对文档提供了双通道:在线文档中心(doc.zh-jieli.com)与仓库本地 doc/ 目录,两者内容互补,离线环境下以本地 PDF 为准。

示例 3:按应用选择工程

README「四、快速开始」(README.md#L112-L117):

SDK 根目录
├── apps/spp_and_le/    # SPP + BLE 透传/数传应用
├── apps/hid/           # HID 人机交互设备应用
└── apps/mesh/          # Bluetooth Mesh 物联应用

Source: README.md

无更多可直接引用的代码示例:doc/ 下的主体为 PDF 二进制文档,仓库中对其的程序化消费方式(如构建脚本引用)在源码中未见,故不虚构。

Configuration Options

doc/ 目录下的文档本身没有可配置项,但其组织与命名约定等效于一套"文档配置",使用时需遵守:

约定取值/格式说明
目录层级datasheet/<系列>/<型号>/芯片系列目录(如 AC632N),型号目录(如 AC6321A)
文档命名<型号>_<文档类型><版本>.pdf类型包括 Datasheet、BLE参考原理图、鼠标标准原理图、BLE蓝牙Dongle参考原理图
版本号格式V<主>.<次>实测有 V1.0、V2.0、V2.1、V2.2;版本号内嵌于文件名
架构文档命名<模块>接口说明[文档].pdf如 模式管理接口说明.pdf、系统定时器接口设计说明文档.pdf
配套关系SDK 版本 ↔ 文档版本由 AC630N_bt_data_transfer_sdk_发布版本信息.pdf 与在线「SDK 版本历史」维护
芯片-平台映射bd19 ↔ AC632N 系列README「支持的芯片与平台」为权威映射表(README.md#L50-L57)

设计意图:通过"型号 + 类型 + 版本"三段式文件名实现无数据库的文档索引,版本号内嵌文件名使得 Git 历史可追溯、无需额外元数据即可做版本比对。

Failure Modes, Edge Cases & Concurrency

  • PDF 内容不可直接检索:doc/ 下的文档全部为 PDF 二进制文件,无法在代码仓库内 grep 或预览;引用其内部章节时必须以本地下载的 PDF 原文为准,本页对 PDF 内部内容仅基于文件名推断,明确标注了"未验证"的部分。
  • 文件列表截断:仓库文件列表工具的返回数量有限,实测仅完整确认 AC632N 系列 8 个型号的文档;br23 / br25 / br34 平台的数据手册未能在本次清单中确认存在,不代表仓库缺失,需通过在线文档中心补充核对。
  • URL 编码问题:文档文件名包含中文与空格(如 AC6321A_Datasheet V2.0.pdf),在 Markdown 链接与 HTTP 请求中必须做百分号编码(空格 → %20,中文 → UTF-8 编码),否则链接 404。
  • 版本匹配风险:Datasheet(V2.0/V2.2 等)与 SDK 代码版本分属两套版本线,若按旧版 Datasheet 设计硬件、用新版 SDK 开发,可能出现引脚/外设定义不一致;务必以发布版本信息文档核对配套关系。
  • 无并发问题:文档为静态资源,不存在读写并发或一致性冲突;唯一需要关注的是多人协作时对 doc/ 目录的 Git 合并冲突(PDF 二进制无法自动合并,建议按型号目录隔离提交)。

Performance & Operational Notes

  • 本地优先:doc/ 随仓库克隆即可离线使用,无需联网访问在线文档中心;适合产线、无外网环境。
  • 二进制体积:PDF 原理图与 Datasheet 体积较大,克隆仓库时体积会明显增加;对仅需源码的 CI 或嵌入式构建可考虑 sparse-checkout 排除 doc/。
  • 文档更新方式:仓库更新时 doc/ 内容随 tag/release 一起发布;关注 README 顶部的 Tag 徽章(README.md#L1-L2)即可感知新版本与配套文档变更。

Extension Points

  • FAQ 目录:doc/FAQ/ 是仓库自有的问题沉淀区,README「常见问题」章节直接引用(README.md#L383),新增排障经验可追加到该目录。
  • 架构文档扩展:doc/architure/ 采用"每模块一份接口说明 PDF"的组织方式,新增 SDK 模块时按 模式管理接口说明.pdf 的既有格式补充对应文档即可保持体系一致。
  • 在线文档中心:doc.zh-jieli.com/AC63 提供 SoC 数据手册扼要与版本历史的在线版本,是本地文档的权威扩展源(README.md#L10)。
  • 社区与支持:GitHub Issues 用于报告文档错误或缺失(README.md#L10)。

Related Links

  • README.md(仓库总览与导航)
  • README.md「支持的芯片与平台」
  • README.md「工程结构」
  • 在线文档中心 doc.zh-jieli.com/AC63
  • SoC 数据手册扼要(在线)
  • SDK 版本历史(在线)
  • doc/datasheet/ 目录
  • doc/architure/ 目录
  • 应用工程相关文档:apps/spp_and_le、apps/hid、apps/mesh 的目录说明请参见仓库 README「快速开始」章节
Next
协议与云平台开发文档