文档资料中心

fw-AW31N_BLE_SDK 仓库内的 doc/ 目录集中存放 SDK 发布配套的文档资源，包括芯片数据手册（规格书）、硬件参考原理图、开发板说明、AT 命令使用说明与 SDK 版本发布信息；同时 README 提供了在线文档中心入口，作为版本化文档的权威来源。

Purpose and Scope

本页面介绍 AW31N BLE SDK 的文档资料中心：仓库内 doc/ 目录的组织结构、每一类文档的用途与适用场景，以及如何将本地文档与在线文档中心（doc.zh-jieli.com）配合使用。

页面边界说明：

• 属于本页：doc/ 目录下的全部资料分类（规格书、原理图、开发板、AT 命令、版本信息）、各类文档的适用人群与使用方式、at_cmd_sample.txt 的 AT 命令用法。
• 不属于本页：应用工程（apps/）的具体代码实现、编译与烧录流程、SDK 配置项说明，这些主题请参阅对应的目录页（如应用选择指南、编译指南等）。

Overview

AW31N 系列是杰理科技面向 BLE 透传/数传与 HID 人机交互场景的蓝牙芯片平台（支持 AW312B / AW313A / AW314A / AW318A / AW318B，蓝牙规范 Core v5.4 已认证，QDID 222830）。SDK 用户在开发过程中需要同时依赖三类信息：

1. 芯片硬件信息 —— 引脚定义、电气参数、封装（来自 Datasheet 规格书）与参考电路（来自原理图），供硬件工程师进行原理图设计与 PCB 布局；
2. 软件开发信息 —— 工程结构、编译方式、配置项（来自 README 与在线文档中心），供固件工程师进行应用开发；
3. 模块调试信息 —— AT 命令集（来自 AT 命令说明文档与 at_cmd_sample.txt 示例），供整机联调与产线测试使用。

仓库设计上采用"本地快照 + 在线权威"的双通道模式：doc/ 目录随 SDK Release 版本同步打包，保证离线可用且与当前代码版本匹配；在线文档中心（https://doc.zh-jieli.com/AW31/zh-cn/master/index.html）则持续更新，提供 SDK 版本历史等动态信息。README 的导航区同时给出这两个入口（见 README.md）。

Architecture

下图展示文档资料中心的组织结构：doc/ 目录按文档用途划分为五个子类别，并与 README 中的在线文档中心、版本历史入口构成完整资料体系。

flowchart TD
    subgraph sg_Repo["fw-AW31N_BLE_SDK 仓库"]
        subgraph sg_Doc["doc/ 目录（本地文档快照）"]
            SUB_DATASHEET["AW31N_规格书<br/>Datasheet PDF"]
            SUB_SCH["AW31N_原理图<br/>参考原理图 / 选型表"]
            SUB_BOARD["AW31N_开发板<br/>App Develop 文档"]
            SUB_AT["AW31N AT命令说明<br/>AT 命令 PDF + 示例"]
            SUB_RELEASE["AW31N_sdk_发布版本信息.pdf"]
        end
        README["README.md<br/>导航与快速开始"]
    end

    subgraph sg_Online["在线文档中心（doc.zh-jieli.com）"]
        ONLINE_INDEX["AW31 文档中心首页"]
        ONLINE_VERSION["SDK 版本历史"]
    end

    README -->|"L9 导航链接"| ONLINE_INDEX
    README -->|"L9 导航链接"| ONLINE_VERSION
    README -->|"L210 说明 doc/ 用途"| sg_Doc
    SUB_DATASHEET -->|"硬件选型"| SUB_SCH
    SUB_SCH -->|"硬件调试"| SUB_BOARD
    SUB_AT -->|"模块联调"| SUB_RELEASE

各组成部分的职责：

设计意图：将文档随源码一起版本化（doc/ 随 tag 发布），避免"代码新、文档旧"的失配问题；同时保留在线文档中心作为长期演进版本，两者互相补充。

文档分类详解

doc/ 目录下的全部资料清单如下（依据仓库实际文件整理）：

芯片规格书（Datasheet）

规格书提供芯片的电气特性、引脚定义、封装尺寸、蓝牙射频指标与绝对最大额定值。选型阶段应以规格书与 AW31N系列芯片选型表.xls 为准，确认目标芯片的 Flash/RAM、GPIO 数量与封装是否满足产品需求。

硬件设计资料（原理图）

目录 doc/AW31N_原理图/ 包含两类资料：

1. 标准产品原理图（按产品形态分类，供直接参考/二次修改）：
   • AW312B：BLE 无线鼠标标准原理图 V1.0、BLE 蓝牙遥控器标准原理图 V1.0
   • AW313A：BLE 无线鼠标标准原理图 V1.2、BLE 蓝牙 Dongle 标准原理图 V1.2、BLE 蓝牙遥控器标准原理图 V1.2、BLE 蓝牙防丢器标准原理图 V1.2
2. 最小系统参考原理图（BLE参考原理图（最小系统）/，按芯片型号划分）：
   • AW312B / AW313A / AW314A / AW318A / AW318B 各一份 V1.1/V1.2 参考原理图
3. AW31N系列芯片选型表.xls：跨型号对比表，用于快速筛选适合产品形态的芯片。

设计意图：按"产品形态"与"芯片型号"两个维度组织原理图，硬件工程师可以先按产品形态（鼠标/遥控器/Dongle/防丢器）找到最接近的整机参考设计，再按芯片型号核对最小系统差异，缩短从选型到原理图定稿的周期。

开发板资料

doc/AW31N_开发板/AW31N_App Develop V1.pdf 是配合官方开发板的应用开发文档，面向初次接触 AW31N 平台的嵌入式开发者，讲解开发板资源、烧录流程与 App 工程的基本开发方法，与仓库 apps/ 目录中的示例工程配套使用。

AT 命令说明

doc/AW31N AT命令说明/ 提供两件资料：

• AW31N AT命令说明.pdf：完整的 AT 命令参考手册（命令格式、参数范围、返回值）；
• at_cmd_sample.txt：可直接复制的命令序列示例，覆盖波特率配置、BLE 从机广播、BLE 主机扫描/连接、关机睡眠与低功耗模式控制等典型场景。

发布版本信息

doc/AW31N_sdk_发布版本信息.pdf 记录 SDK 各 Release 版本的功能变更、问题修复与注意事项，是升级 SDK 前必读资料；版本演进的历史也可在在线文档中心的 SDK 版本历史 页面查阅。

在线文档中心

README 导航区（README.md）提供两个在线入口：

• 文档中心首页：https://doc.zh-jieli.com/AW31/zh-cn/master/index.html —— 覆盖环境搭建、编译、烧录、配置等主题的完整文档集；
• SDK 版本历史：https://doc.zh-jieli.com/AW31/zh-cn/master/other/version/index.html —— 各版本发布记录。

在线文档中心与仓库 doc/ 的关系：本地 doc/ 是随 Release 打包的离线快照，保证版本一致性；在线文档中心是持续演进的完整文档集，包含本地快照之外的专题章节（如工具链、量产烧写、无线测试盒等），两者应结合使用。

Core Flow

产品开发全流程中的文档查阅路径

硬件与固件并行开发时，文档资料中心按开发阶段提供对应资料：

flowchart LR
    A["需求分析"] --> B["芯片选型"]
    B -->|"查阅"| DS["规格书 + 芯片选型表"]
    DS --> C["硬件设计"]
    C -->|"参考"| SCH["标准原理图 + 最小系统原理图"]
    SCH --> D["硬件调试"]
    D -->|"对照"| BOARD["开发板 App Develop 文档"]
    D --> E["固件开发 / 模块联调"]
    E -->|"使用"| AT["AT 命令说明 + at_cmd_sample.txt"]
    E -->|"查阅"| VER["SDK 发布版本信息"]
    VER -->|"升级前必读"| E

各阶段的文档依赖关系：选型阶段以规格书与选型表为准；原理图设计以标准产品原理图为起点、最小系统原理图核对差异；固件联调阶段依赖 AT 命令集；任何 SDK 升级动作都需先核对发布版本信息。

AT 命令典型配置流程

at_cmd_sample.txt 展示的是一条完整的 BLE 从机广播 → 主机扫描/连接的配置链路，其控制流如下：

sequenceDiagram
    participant U as 开发者/上位机
    participant M as 模组（AT 解析）
    U->>M: AT+BAUD=9600（配置波特率）
    U->>M: AT+ADV=0（关闭广播进入配置态）
    U->>M: AT+NAME=JL_BLE / AT+ADVDATA=020106 / AT+SRDATA=...（设置广播参数）
    U->>M: AT+ADVPARAM=160（设置广播间隔）
    U->>M: AT+ADV=1（开启广播）
    U->>M: AT+SCAN=0 / AT+CONNPARAM=10,24,0,400（配置扫描与连接参数）
    U->>M: AT+SCAN=1（开启扫描）
    U->>M: AT+TARGETUUID=AE30（过滤服务 UUID）
    U->>M: AT+CONN=112233445566（发起连接）
    U->>M: AT+LOWPOWER=1（联调完成后进入低功耗）
    U->>M: AT+POWEROFF（关机睡眠）

设计意图：命令序列刻意采用"先关广播/扫描、再改参数、最后使能"的顺序，避免在参数修改过程中设备持续广播或扫描造成时序冲突，这是 AT 模块调试的通用最佳实践。

Usage Examples

以下代码示例均提取自仓库实际文件。

示例一：BLE 从机广播配置（AT 命令序列）

doc/AW31N AT命令说明/at_cmd_sample.txt 演示从机广播的完整配置流程：

//BLE从机广播配置:
AT+ADV=0\r
AT+NAME=JL_BLE\r
AT+ADVDATA=020106\r
AT+SRDATA=07094A4C5F424C45\r
AT+ADVPARAM=160\r
AT+ADV=1\r

Source: at_cmd_sample.txt

要点说明：AT+ADV=0 先关闭广播，随后依次设置设备名（AT+NAME=JL_BLE）、广播数据（AT+ADVDATA=020106）、扫描响应数据（AT+SRDATA=07094A4C5F424C45，内容为 ASCII "JL_BLE" 的十六进制编码）、广播间隔参数（AT+ADVPARAM=160），最后 AT+ADV=1 开启广播。

示例二：BLE 主机扫描与连接

at_cmd_sample.txt 演示主机角色下的扫描与连接：

//BLE主机扫描
AT+SCAN=0\r
AT+CONNPARAM=10,24,0,400\r
AT+SCAN=1\r
//配置BLE主机连上后发起搜索的服务UUID
AT+TARGETUUID=AE30\r

//BLE主机发起连接
AT+CONN=112233445566\r
//取消发起连接的操作
AT+CONN_CANNEL\r

Source: at_cmd_sample.txt

要点说明：扫描前先 AT+SCAN=0 关闭扫描并配置连接参数（AT+CONNPARAM=10,24,0,400 分别对应连接间隔最小值、最大值、从机延迟与超时），再 AT+SCAN=1 开启扫描；AT+TARGETUUID=AE30 限定连接后搜索的服务 UUID；AT+CONN=112233445566 按目标 MAC 地址发起连接，AT+CONN_CANNEL 用于取消未完成的连接请求。

示例三：低功耗与关机

at_cmd_sample.txt 演示功耗控制命令：

//设置进入关机睡眠
AT+POWEROFF\r

//低功耗模式控制
AT+LOWPOWER=1\r
AT+LOWPOWER=0\r
AT+LOWPOWER?\r

Source: at_cmd_sample.txt

要点说明：AT+LOWPOWER=1/0 开/关低功耗模式，AT+LOWPOWER? 为查询命令（返回当前状态），体现了 AT 命令"设值/查询"双语义的惯例；AT+POWEROFF 直接进入关机睡眠。

示例四：文档中心入口（README 导航）

README.md 中的导航区集中给出文档入口：

**杰理 AW31N系列通用蓝牙 SDK 固件程序**

[English](https://gitee.com/Jieli-Tech/fw-AW31N_BLE_SDK/blob/master/README-en.md) · [文档中心](https://doc.zh-jieli.com/AW31/zh-cn/master/index.html) · [SDK 版本历史](https://doc.zh-jieli.com/AW31/zh-cn/master/other/version/index.html) · [报告问题](https://gitee.com/Jieli-Tech/fw-AW31N_BLE_SDK/issues)

Source: README.md

同时，README.md 在工程结构说明中明确了 doc/ 目录的定位：

├── doc/                    # SDK发布文档资源：版本发布信息、芯片数据手册、硬件设计资料、使用说明文档等

Source: README.md

配置选项

AT 命令可视为模组行为的"运行时配置接口"。下表整理自 at_cmd_sample.txt 中出现的命令（完整参数范围与返回值请以 AW31N AT命令说明.pdf 为准）：

注意：AT+CONN_CANNEL 在示例文件中即为此拼写（CANNEL），使用时请与正式命令手册核对。

API Reference

AT 命令集的通用语法约定（依据示例文件的命令形态归纳）：

AT+<COMMAND>[=<value>][?]

参数编码约定：

• 字符串参数直接给出，如 AT+NAME=JL_BLE；
• 广播数据、扫描响应数据、目标 MAC 地址以十六进制字符串表示，如 AT+ADVDATA=020106、AT+CONN=112233445566；
• 命令以 \r 结尾（示例文件统一使用 \r 换行符）。

返回值： 示例文件未包含返回示例；具体应答格式（如 OK/ERROR、查询结果回显）请查阅 AW31N AT命令说明.pdf。

注意： 本文档仅覆盖示例文件 at_cmd_sample.txt 中出现的命令子集，用于演示典型用法；完整命令清单、参数范围与错误码请以配套 PDF 为准。

文档资料与代码的对应关系

文档资料中心并非孤立存在，它与 SDK 代码存在如下映射关系：

设计意图：硬件资料与软件代码同仓发布、同 tag 归档，保证硬件工程师与固件工程师拿到的是同一发布点的配套资料，减少版本错配问题。

失败模式与边界情况

文档版本与 SDK 版本失配

doc/ 目录随 Release 打包，但硬件参考文档（Datasheet、原理图）存在独立的版本号（如 V1.0/V1.2），与 SDK 版本号不同步。风险场景：硬件工程师使用了新版本原理图，而固件基于旧 SDK 开发，可能导致引脚定义不匹配。规避方式：以发布版本信息 PDF 中的配套说明为准，确认硬件资料版本与 SDK 版本的对应关系。

文档与芯片型号错配

原理图、规格书均按芯片型号细分（AW312B/AW313A/AW314A/AW318A），且同型号下还区分产品形态（鼠标/遥控器/Dongle/防丢器）。风险场景：参考了错误型号的最小系统原理图导致封装/电源设计错误。规避方式：先通过 AW31N系列芯片选型表.xls 确认目标型号，再取对应型号的资料。

中文路径与特殊字符

doc/ 目录使用中文目录名和文件名（含空格，如 AW31N AT命令说明/）。风险场景：在部分工具链、CI 脚本或 Windows 旧版文件系统中，中文/空格路径可能导致编译脚本或文档链接失效。规避方式：在代码与脚本中引用路径时注意 URL 编码（空格编码为 %20），例如 doc/AW31N%20AT命令说明/at_cmd_sample.txt。

PDF 二进制资料无法在仓库内直接 diff

Datasheet、原理图等均为 PDF 二进制文件，无法像代码一样进行文本 diff，版本演进的追踪只能依赖文件名中的版本号。规避方式：升级资料时更新文件名版本号，并在发布版本信息中登记变更记录。

AT 命令示例的拼写不一致

示例文件中的 AT+CONN_CANNEL 拼写与标准命名习惯（CANCEL）不一致。风险场景：直接复制示例到不支持该拼写的固件版本会导致命令无效。规避方式：以正式 AW31N AT命令说明.pdf 为准，必要时与 SDK 支持 AT 模组的工程代码核对命令解析表。

性能与运维注意事项

• 离线可用性：doc/ 随仓库克隆即可获得，适合离线开发环境；在线文档中心需要网络访问，但内容更新更及时。
• 资料体量：原理图与规格书 PDF 较大（含矢量图），克隆仓库时建议使用浅克隆或按需拉取（如 git sparse-checkout 只取 doc/），以节省带宽与磁盘。
• 发布节奏：AW31N_sdk_发布版本信息.pdf 是升级 SDK 前的必读资料；SDK 升级后应同步核对配套文档版本，避免"新库旧文档"。
• 工具链文档：环境搭建涉及的编译工具链、烧录工具、生产烧写工具、无线测试盒等工具的详细文档位于在线文档中心（见 README.md 3.2-3.3 节），仓库内不重复存放。

扩展点

• 新增文档：遵循现有目录命名规范（类别名称为中文、内容按芯片型号或产品形态细分），在 doc/ 下新增子目录并在 README 工程结构说明中登记即可。
• 在线文档中心：需要官方更新在线文档时，通过 报告问题 渠道反馈。
• 双语资料：仓库同时维护 README.md（中文）与 README-en.md（英文）；新增对外文档时建议同步提供中英双语版本，保持与 README 的双语策略一致。

Related Links

• README.md（中文总览）
• README-en.md（English）
• AW31N AT 命令示例 at_cmd_sample.txt
• 在线文档中心（AW31 中文版）
• SDK 版本历史
• 报告问题 / Issues
• 相关目录页：应用工程结构（apps/）、编译指南、烧录与升级（详见在线文档中心对应章节）