HiSpark编程指南

- 调测资料
  - SDK Sample使用指南
    - 前言
    - 概述
    - Sample框架
    - 外设 Sample
    - SLE UART Sample
    - SLE UART DMA Sample
    - SLE Mouse Sample
    - SLE amic vdt with dongle
    - SLE microphone
    - SLE measure dis
    - BLE Lowpower Sample
    - BLE UART Sample
    - BLE Keyboard Sample
    - BLE SLE TAG Sample
    - BLE Mouse Sample
    - USB Keyboard Sample
    - USB Mouse Sample
    - USB AMIC VDT Sample
    - RCU
    - 多连接
    - air mouse
    - SLE MOUSE with Dongle
    - SLE OTA dongle
    - game mouse
    - BLE UUID
    - 缩略语
  - SDK二次开发网络安全注意事项
    - 前言
    - 产品安全解决方案
    - 结论
  - SDK开发环境搭建用户指南
    - 前言
    - 开发环境搭建
    - 编译SDK
    - 新建APP
  - 内存维测指导书
    - 前言
    - 简介
    - 内存维测功能
  - 射频AT测试指南
    - 前言
    - 射频测试AT指令
    - AT指令组包示例
    - 注意事项
  - 维测指导书
    - 前言
    - 概述
    - 日志说明
    - 日志分析
    - 问题定位
    - 典型案例
    - 常见问题FAQ
- 软件资料
  - AT命令使用指南
    - 前言
    - 指令说明
    - 通用AT指令
    - BT业务AT指令
    - 新增AT指令方法
  - DFU升级APK开发指南
    - 前言
    - 功能特性
    - 系统框架
    - 工程文件部署
    - 界面实现
    - 升级界面Fragment实现
    - 关于界面Fragment实现
    - 应用清单AndroidManifest
  - DFX软件开发指南
    - 前言
    - DIAG维测功能
    - 死机诊断
    - Dump解析
  - EFUSE使用指南
    - 前言
    - 概述
    - 使用软件接口读写EFUSE
    - 使用BurnTool烧写EFUSE
  - NFC TAG软件开发指导书
    - 前言
    - 概述
    - 开发指导
  - NV存储用户指南
    - 前言
    - NV简介
    - NV编译预置
    - NV API指南
    - 定制化NV结构使用介绍
    - 通过NV自定义传输数据最大长度
  - Release notes
    - 1.0.18版本描述文件
    - 1.0.17版本描述文件
    - 1.0.16版本描述文件
  - SDK开发指南
    - 前言
    - 概述
    - 系统接口
  - SDK接口变更说明书
    - 前言
    - BLE SDK接口变更说明
  - SP31 SLP使用指南
    - 开源版本
  - USB HID复合设备开发指南
    - 前言
    - 概述
    - 实现方式
  - 代码框架说明
    - 前言
    - SDK模块框架
    - SDK目录结构
    - SDK目录说明
  - 低功耗FAQ
    - 前言
    - 系统无法睡眠
    - IO无法唤醒系统
    - 唤醒后外设异常
    - 低功耗导致OTA升级异常
    - 功耗比预期高
    - 锁中断导致BT业务阻塞
    - 概率性狗超时
    - 供电模式&软件配置
    - 提前唤醒时间问题
  - 低功耗sample使用指南
    - 前言
    - 编译&测试
    - 系统状态管理
    - 用户指南
  - 低功耗开发指南
    - 前言
    - 低功耗概述
    - 低功耗方案
    - 开发指引
    - 功耗优化
    - 常见问题
  - 功率配置说明书
    - 前言
    - 射频功率配置说明
  - 升级方案使用指南
    - 前言
    - 概述
    - 升级包制作
    - 升级包传输
    - 升级包保存
    - 升级包本地升级
    - FAQ
  - 快速入门指南
    - 前言
    - 文档目录
    - 环境搭建
    - 基础功能开发
    - 调优
    - 特性开发
    - 测试报告
  - 星闪应用层SLE-Link协议
    - 前言
    - 概述
    - SLE Frame格式定义
    - 服务接口定义
    - 交互流程示例
  - 星闪软件开发指导书
    - 前言
    - 概述
    - Device Discovery接口
    - Connection Manager接口
    - SSAP Server接口
    - SSAP client接口
    - Low Latency接口
    - Transmission Manager接口
    - SLE Passkey接口
    - SLE Channel Map 接口
  - 红外学习使用指南
    - 前言
    - 红外学习方式
    - 通过比较器进行红外学习
    - 使用指南
  - 蓝牙软件开发指导书
    - 前言
    - 概述
    - GAP接口
    - GATT server接口
    - GATT client接口
  - 设备驱动开发指南
    - 前言
    - Pinctrl
    - GPIO
    - UART
    - SPI
    - I2C
    - ADC
    - DMA
    - PWM
    - WDT
    - Timer
    - Systick
    - TCXO
    - Flash
    - SFC
    - QDEC
    - KEYSCAN
    - PDM
    - USB_HID
    - USB_DFU
    - I2S
    - TRNG
    - 附：MIDDLEWARE
  - 音频编解码开发指导书
    - 前言
    - 概述
    - Audio Encoder
    - Audio Decoder
    - 调试与功能
- 工具资料
  - BurnTool工具使用指导书
    - 前言
    - BurnTool工具简介
    - 操作指南
    - FAQ
  - HiSpark Studio使用指南
    - 前言
    - 工具简介
    - 开发环境搭建
    - 工程管理
    - 工程配置
    - 编译运行
    - 软件包烧录
    - 栈分析和镜像分析
    - 工程调试
    - 串口控制台工具
    - Kconfig配置
    - GUI工程创建与使用
    - 高阶分析功能使用
    - 常见错误

### 该页内容

- 前言
- 文档目录
- 环境搭建
  - 芯片规格评估
  - 开发板介绍
  - 开发环境搭建
  - SDK包使用
- 基础功能开发
  - 基础业务开发
  - 命令行说明
- 调优
- 特性开发
  - 常用功能开发
  - 低功耗开发
  - 鼠标应用方案开发
- 测试报告
  - 测试指导
  - 测试数据

# 前言

概述

本文为首次使用版本的开发人员而写。目的是供开发人员快速掌握文档的整体架构脉络，指导开发人员一步一步深入开发。同时帮助不同的开发人员快速找到自己所需要的文档。

> 须知：

> - 第1章节为版本包文档的目录，描述文档总体的结构。

> - 第2章节为环境搭建部分，包括芯片的评估、开发环境的搭建以及Demo板的使用。

> - 第3章节为基础功能开发章节，包含客户进行开发需要使用到的各部分的文档。

> - 第4章节为调优章节，主要帮助客户在基础开发后进行图像、内存、带宽等方面的调优。

> - 第5章节为特性开发，帮助客户在单个特性开发时能快速找到该特性涉及的所有文档。

> - 第6章节为测试报告，包含功耗、硬件测试报告等供客户参考。

产品版本

与本文档相对应的产品版本如下。

产品名称 | 产品版本
--- | ---
BS2X | V100

读者对象

本文档（本指南）主要适用于以下工程师：

- 技术支持工程师

- 软件开发工程师

符号约定

在本文中可能出现下列标志，它们所代表的含义如下。

符号 | 说明
--- | ---
| 表示如不避免则将会导致死亡或严重伤害的具有高等级风险的危害。
| 表示如不避免则可能导致死亡或严重伤害的具有中等级风险的危害。
| 表示如不避免则可能导致轻微或中度伤害的具有低等级风险的危害。
| 用于传递设备或环境安全警示信息。如不避免则可能会导致设备损坏、数据丢失、设备性能降低或其它不可预知的结果。 “须知”不涉及人身伤害。
| 对正文中重点信息的补充说明。 “说明”不是安全警示信息，不涉及人身、设备及环境伤害信息。

修改记录

文档版本 | 发布日期 | 修改说明
--- | --- | ---
03 | 2025-05-30 | 更新交付文档目录及文档结构。
02 | 2025-01-14 | 更新“文档目录”小节内容。
01 | 2024-05-15 | 第一次正式版本发布。
00B01 | 2024-01-26 | 第一次临时版本发布。

# 文档目录

在ReleaseDoc/目录下：

    ├── 01.软件资料                #软件开发相关文档
    │   ├── BS2XV100 AT命令使用指南
    │   ├── BS2X DFU升级 APK开发指南
    │   ├── BS2XV100 DFX软件 开发指南
    │   ├── BS2XV100 EFUSE 使用指南
    │   ├── BS2XV100 NFC TAG 软件开发指导书
    │   ├── BS2XV100 NV存储用户指南
    │   ├── BS2XV100 SDK 开发指南
    │   ├── BS2XV100 SDK接口变更 说明书
    │   ├── BS2XV100 SDK 开发指南
    │   ├── BS2XV100 USB HID复合设备 开发指南
    │   ├── BS2XV100 代码框架说明
    │   ├── BS2XV100 低功耗 开发指南
    │   ├── BS2XV100 低功耗FAQ
    │   ├── BS2XV100 低功耗sample 使用指南
    │   ├── BS2XV100 功率配置 说明书
    │   ├── BS2XV100 升级方案使用指南
    │   ├── BS2XV100 星闪应用层SLE-Link协议
    │   ├── BS2XV100 星闪鼠标应用方案开发 用户指南
    │   ├── BS2XV100 红外学习使用指南
    │   ├── BS2xV100 星闪软件开发指导书
    │   ├── BS2XV100 蓝牙软件开发指导书
    │   ├── BS2XV100 设备驱动开发指南
    │   └── BS2XV100 音频编解码开发 指导书
    ├── 02.工具资料                 #工具相关文档
    │   ├──BS2XV100 BurnTool工具使用指导书
    │   ├──BS2XV100 BurnTool工具 烧写协议说明
    │   ├──BS2XV100 DebugKits工具使用指南
    │   └──BS2XV100 HiSpark Studio 使用指南
    └── 03.调测资料                 #调测相关文档
    │   ├── BS2XV100 BLE BQB认证测试 指导书
    │   ├── BS2XV100 SDK Sample使用指南
    │   ├── BS2XV100 SDK二次开发网络安全 注意事项
    │   ├── BS2XV100 SDK开发环境搭建用户指南
    │   ├── BS2XV100 产测指导书
    │   ├── BS2XV100 产线整机测试 工具指导书
    │   ├── BS2XV100 内存维测 指导书
    │   ├── BS2XV100 功耗 测试指南
    │   ├── BS2XV100 单板冒烟测试指南
    │   ├── BS2XV100 射频 AT测试指南
    │   ├── BS2XV100 常用工具 使用指南
    │   ├── BS2XV100 常见问题FAQ
    │   ├── BS2XV100 抗干扰环境搭建 测试指南
    │   ├── BS2XV100 星闪射频测试仪表 用户指南
    │   ├── BS2XV100 星闪认证测试 指导书
    │   ├── BS2XV100 维测 指导书
    └── 04.硬件资料
    │   └── 参考设计
    │   │    ├── BS2X_REF_2024-09-25.pdf
    │   │    ├── BS2xREF_view_locked.brd
    │   │    ├── 参考设计PCB说明.txt
    │   ├── BS2XV100 DK2用户 使用说明
    │   ├── BS2XV100 DK用户 使用说明
    │   ├── BS2XV100 USB眼图测试 指导书
    │   ├── BS2XV100 硬件指南

# 环境搭建

## 芯片规格评估

芯片硬件规格描述文档。

ReleaseDoc\04 硬件资料\BS2XV100 硬件指南.pdf

## 开发板介绍

DK单板使用说明。

ReleaseDoc\04 硬件资料\BS2XV100 DK2用户 使用说明.pdf

ReleaseDoc\04 硬件资料\BS2XV100 DK用户 使用说明.pdf

## 开发环境搭建

- 说明软件开发环境搭建、SDK目录结构、SDK编译、Demo APP编写和镜像烧录。

  ReleaseDoc\03 调测资料\BS2XV100 SDK开发环境搭建 用户指南.pdf

- 说明软件镜像烧录详细步骤。

  ReleaseDoc\02 工具资料\BS2XV100 BurnTool工具使用指导书.pdf

- 说明日志调试工具搭建。

  ReleaseDoc\02 工具资料\BS2XV100 DebugKits工具使用指南.pdf

- 说明window ID编译工具使用。

  ReleaseDoc\02 工具资料\BS2XV100 HiSpark Studio 使用指南.pdf

## SDK包使用

SDK开发相关内容，包括SDK架构、接口实现机制与使用说明。

ReleaseDoc\01 软件资料\BS2XV100 SDK 开发指南.pdf

ReleaseDoc\01 软件资料\BS2XV100 SDK接口变更 说明书.pdf

# 基础功能开发

## 基础业务开发

- 向开发者提供接入和使用星闪低功耗的相关接口。

  ReleaseDoc\01 软件资料\BS2XV100 星闪软件开发指导书.pdf

- 向开发者提供接入和使用低功耗蓝牙的相关接口。

  ReleaseDoc\01 软件资料\BS2XV100 蓝牙软件开发指导书.pdf

- SDK的模块框架及说明，帮助开发者快速上手BS2X的SDK开发。

  ReleaseDoc\01 软件资料\BS2XV100 代码框架说明.pdf

- 提供供了一些示例程序（Sample），用于指导用户快速使用BS2X平台所提供的各类能力及快速产品化。

  ReleaseDoc\03 调测资料\BS2XV100 SDK Sample使用指南.pdf

## 命令行说明

AT命令说明文档。

ReleaseDoc\01 软件资料\BS2XV100 AT命令 使用指南.pdf

# 调优

- 对PLT的各类业务，提供内存维测指导。

  ReleaseDoc\03 调测资料\BS2XV100 内存维测 指导书.pdf

- 低功耗调测时可能遇到的问题解决方法，用户调测低功耗时遇到问题可以进行参考。

  ReleaseDoc\01 软件资料\BS2XV100 低功耗 FAQ.pdf

# 特性开发

## 常用功能开发

- SDK开发介绍。

  ReleaseDoc\01 软件资料\BS2XV100 SDK 开发指南.pdf

- BS2XV100通过API（Application Programming Interface）向开发者提供音频编解码的相关接口，包括编码器初始化及销毁接口、命令配置接口、编码一帧接口、解码一帧接口。

  ReleaseDoc\01 软件资料\BS2XV100 音频编解码开发 指导书.pdf

- 设备驱动开发的相关内容，主要包括工作原理、按场景描述接口使用方法和注意事项。

  ReleaseDoc\01 软件资料\BS2XV100 设备驱动开发指南.pdf

- BS2XV100 升级流程以及相关工具的操作指导。

  ReleaseDoc\01 软件资料\BS2XV100 升级方案 使用指南.pdf

- BS2XV100 通过API（Application Programming Interface）向开发者提供 NFC TAG的相关接口。

  ReleaseDoc\01 软件资料\BS2XV100 NFC TAG 软件开发指导书.pdf

- 针对 BS2X 芯片中 NV 存储模块的使用进行介绍。

  ReleaseDoc\01 软件资料\BS2XV100 NV存储 用户指南.pdf

- BS2X USB HID 复合设备的两种实现方式。

  ReleaseDoc\01 软件资料\BS2XV100 USB HID复合设备 开发指南.pdf

- 绍BS2X DFX 功能及使用指南，包括 DIAG 维测功能、死机诊断、Dump 解析等，方便用户进行业务维测及死机分析。

  ReleaseDoc\01 软件资料\BS2XV100 DFX软件 开发指南.pdf

- 二次开发网络安全介绍。

  ReleaseDoc\03 调测资料\BS2XV100 SDK二次开发网络安全 注意事项.pdf

## 低功耗开发

- 低功耗模式及应用开发指导。

  ReleaseDoc\01 软件资料\BS2XV100 低功耗 开发指南.pdf

- 低功耗调测时可能遇到的问题解决方法。

  ReleaseDoc\01 软件资料\BS2XV100 低功耗 FAQ.pdf

- 低功耗sample的使用方法。

  ReleaseDoc\01 软件资料\BS2XV100 低功耗sample 使用指南.pdf

- 各种场景下功率调整方式以及具体的操作指导。

  ReleaseDoc\01 软件资料\BS2XV100 功率配置 说明书.pdf

## 鼠标应用方案开发

介绍星闪鼠标应用方案规格及其实现，帮助快速熟悉 应用方案代码逻辑和相关接口。

ReleaseDoc\01 软件资料\BS2XV100 星闪鼠标应用方案开发 用户指南.pdf

# 测试报告

## 测试指导

- 针对BS2X所应用产品如何通过BQB认证以及提供建议。

  ReleaseDoc\03 调测资料\BS2XV100 BLE BQB认证测试指导书.pdf

- 介绍产品产线装备端BS2X相关的测试指导，主要包括镜像烧录、射频测试、晶体校准等产线测试相关信息。

  ReleaseDoc\03 调测资料\BS2XV100 产测 指导书.pdf

- 针对PLT的各类业务，提供内存维测指导。

  ReleaseDoc\03 调测资料\BS2XV100 内存维测 指导书.pdf

- BS2XV100功耗测试的操作与测试过程中需要注意的事项。

  ReleaseDoc\03 调测资料\BS2XV100 功耗 测试指南.pdf

- 介绍BS2XV100的射频非信令相关的测试指南和注意事项。

  ReleaseDoc\03 调测资料\BS2XV100 射频 AT测试指南.pdf

- 介绍BS2XV100星闪射频测试仪表使用指南和注意事项。

  ReleaseDoc\03 调测资料\BS2XV100 星闪射频测试仪表 用户指南.pdf

- 对BS2X所应用产品如何通过星闪认证以及提供建议。

  ReleaseDoc\03 调测资料\星闪认证测试 指导书.pdf

- 主要介绍 MP_Tool 的使用方法。用于指导用户快速使用 MP_Tool 工具进行产线功能测试

  ReleaseDoc\03 调测资料\BS2XV100 产线整机测试 工具指导书.pdf

- BS2X平台日志分析指导，包括平台日志分类、重启场景、panic类型等。

  ReleaseDoc\03 调测资料\BS2XV100 维测 指导书.pdf

- BS2X 所应用产品的抗干扰简易环境测试指导，主要包括环境搭建及测试相关信息。

  ReleaseDoc\03 调测资料\BS2XV100 抗干扰环境搭建 测试指南.pdf

## 测试数据

请联系技术支持人员获取。