From a60e4f6bd9779f0fea422efec383e8c996f02433 Mon Sep 17 00:00:00 2001 From: PhatenIoT-yan <168261949+PhatenIoT@users.noreply.github.com> Date: Sat, 21 Jun 2025 15:35:53 +0800 Subject: [PATCH] update zh sdk --- .../technical_faq/a316_firmware_dev_faq.md | 2 + .../XU316和MCU通讯的示例代码/index.md | 185 ++++++++++++++++++ .../XU316和MCU通讯的示例代码/产品内容相关.md | 3 + .../XU316和MCU通讯的示例代码/命令的相关宏.md | 3 + .../XU316和MCU通讯的示例代码/命令相关.md | 3 +- zh/mkdocs.yml | 8 +- 6 files changed, 200 insertions(+), 4 deletions(-) create mode 100644 zh/docs/dev_doc/sdk_examples/XU316和MCU通讯的示例代码/index.md diff --git a/zh/docs/dev_doc/faq/technical_faq/a316_firmware_dev_faq.md b/zh/docs/dev_doc/faq/technical_faq/a316_firmware_dev_faq.md index 2323794..a6fc5c6 100644 --- a/zh/docs/dev_doc/faq/technical_faq/a316_firmware_dev_faq.md +++ b/zh/docs/dev_doc/faq/technical_faq/a316_firmware_dev_faq.md @@ -4,6 +4,8 @@ description: 本文档提供了A316系列产品固件开发过程中的常见问 keywords: A316固件开发, XU316通信问题, USB设备供电, 固件开发FAQ, 设备识别问题 --- +--8<-- "common/phaten_xmos_support_img.md" + # A316系列产品固件开发常见问题解答 !!! 注意 diff --git a/zh/docs/dev_doc/sdk_examples/XU316和MCU通讯的示例代码/index.md b/zh/docs/dev_doc/sdk_examples/XU316和MCU通讯的示例代码/index.md new file mode 100644 index 0000000..a497616 --- /dev/null +++ b/zh/docs/dev_doc/sdk_examples/XU316和MCU通讯的示例代码/index.md @@ -0,0 +1,185 @@ +--- +title: XU316与MCU通信开发指导 +description: 本文档提供了XU316与MCU通信开发的完整指导，包括开发步骤、参考文档和常见问题解答，帮助开发者快速实现XU316与MCU的通信功能。 +keywords: XU316开发, MCU通信开发, 音频接口控制, 通信协议, 开发指导, 常见问题解答 +--- + +--8<-- "common/phaten_xmos_support_img.md" + +# XU316与MCU通信开发指导 + +## 开发概述 + +本文档提供了XU316与MCU通信开发的完整指导，帮助开发者按照正确的顺序实现XU316与MCU的通信功能。开发过程分为以下几个主要步骤，每个步骤都有对应的参考文档和详细说明。 + +## 开发步骤 + +
+ +=== "第一步：了解基础概念和协议结构" + **目标**：理解XU316与MCU通信的基本概念和协议结构 + + **参考文档**：[:material-file-document-outline: XU316与MCU通信协议命令宏定义](命令的相关宏.md) + + **学习要点**： + - 掌握帧格式的基本结构（帧头、命令、数据长度、校验和、帧尾） + - 理解各种命令的数据长度定义 + - 熟悉音频格式枚举和类型定义 + - 了解命令数据结构体的组成 + +=== "第二步：实现基础通信功能" + **目标**：实现XU316与MCU的基础通信功能 + + **参考文档**：[:material-file-document-outline: XU316与MCU通信协议参考](命令相关.md) + + **开发任务**： + - 实现环形缓冲区初始化和管理 + - 实现数据帧的封装和发送 + - 实现数据帧的接收和解析 + - 实现CRC32和简单校验和计算 + - 实现基本的通信协议处理流程 + +=== "第三步：配置音频接口和参数" + **目标**：配置XU316的音频接口和相关参数 + + **参考文档**：[:material-file-document-outline: XU316音频接口控制代码示例](产品内容相关.md) + + **开发任务**： + - 配置I2S主从模式 + - 设置音频采样率和位深度 + - 配置音频通道数量 + - 设置音量控制参数 + - 配置各种音频接口（SPDIF、ADAT、DSD等） + + + +
+ +## 常见问题解答 + +### 通信问题 + +!!! question "Q1: XU316通过串口连接PC时无法收发数据" + **问题现象**：XU316通过串口连接PC时无法收发数据，逻辑分析仪也抓不到数据 + + **解决方案**： + 1. 检查MCU响应速度，优先配置XU316 + 2. 检查MCU是否给XU316供电 + 3. 确保在XU316发送上电命令前完成初始化 + + **参考文档**：[:material-file-document-outline: 免开发固件开发问题指南](../../faq/technical_faq/a316_firmware_dev_faq.md) + +!!! question "Q2: 设备在PC上正常识别，但手机无法识别" + **问题现象**：设备在PC上可以正常识别和播放，但连接手机后无法识别设备 + + **解决方案**： + 1. 检查设备供电模式设计 + 2. 修改设备供电部分和放电部分 + 3. 确保设备在手机连接时能正确接收供电 + + **参考文档**：[:material-file-document-outline: 免开发固件开发问题指南](../../faq/technical_faq/a316_firmware_dev_faq.md) + +!!! question "Q3: WiFi做从模式时，发送IIS in指令无效" + **问题现象**：WiFi设置为从模式，发送IIS in指令后无效果 + + **解决方案**： + 1. 检查固件是否支持WiFi从模式到XMOS主模式的转换 + 2. 将WiFi模块挂载到蓝牙模块上 + 3. 通过蓝牙模块实现模式切换功能 + + **参考文档**：[:material-file-document-outline: 免开发固件开发问题指南](../../faq/technical_faq/a316_firmware_dev_faq.md) + +### 配置问题 + +!!! question "Q4: 音频参数配置不正确" + **问题现象**：音频播放出现杂音或无声 + + **解决方案**： + 1. 检查音频采样率配置是否正确 + 2. 验证音频通道数量设置 + 3. 确认音量参数范围 + 4. 检查I2S模式配置 + + **参考文档**：[:material-file-document-outline: XU316音频接口控制代码示例](产品内容相关.md) + +!!! question "Q5: 通信协议解析错误" + **问题现象**：接收到的数据解析不正确 + + **解决方案**： + 1. 检查帧格式定义是否正确 + 2. 验证校验和计算方法 + 3. 确认数据长度定义 + 4. 检查命令字枚举定义 + + **参考文档**：[:material-file-document-outline: XU316与MCU通信协议命令宏定义](命令的相关宏.md) + + + + + diff --git a/zh/docs/dev_doc/sdk_examples/XU316和MCU通讯的示例代码/产品内容相关.md b/zh/docs/dev_doc/sdk_examples/XU316和MCU通讯的示例代码/产品内容相关.md index bb54c4d..a209566 100644 --- a/zh/docs/dev_doc/sdk_examples/XU316和MCU通讯的示例代码/产品内容相关.md +++ b/zh/docs/dev_doc/sdk_examples/XU316和MCU通讯的示例代码/产品内容相关.md @@ -4,11 +4,14 @@ description: 本文档提供了XU316音频接口控制相关的代码示例， keywords: XU316开发, 音频接口控制, MCU通信, I2S配置, 串口协议, 音频采样率, DSD配置 --- +--8<-- "common/phaten_xmos_support_img.md" + # XU316音频接口控制代码示例 ## 文档说明 本文档提供了XU316音频接口控制相关的代码示例，主要包含以下内容： + 1. 串口通信协议定义 2. 音频接口配置参数 3. 音频采样率和通道配置 diff --git a/zh/docs/dev_doc/sdk_examples/XU316和MCU通讯的示例代码/命令的相关宏.md b/zh/docs/dev_doc/sdk_examples/XU316和MCU通讯的示例代码/命令的相关宏.md index 4b5d79f..b00b04c 100644 --- a/zh/docs/dev_doc/sdk_examples/XU316和MCU通讯的示例代码/命令的相关宏.md +++ b/zh/docs/dev_doc/sdk_examples/XU316和MCU通讯的示例代码/命令的相关宏.md @@ -4,11 +4,14 @@ description: 本文档提供了XU316与MCU通信协议相关的命令宏定义 keywords: XU316通信协议, MCU命令宏定义, 音频格式定义, 通信帧格式, 命令数据结构, 音频类型定义 --- +--8<-- "common/phaten_xmos_support_img.md" + # XU316与MCU通信协议命令宏定义 ## 文档说明 本文档提供了XU316与MCU通信协议相关的命令宏定义，主要包含以下内容： + 1. 通信帧格式定义 2. MCU命令数据长度定义 3. 通信协议命令字枚举 diff --git a/zh/docs/dev_doc/sdk_examples/XU316和MCU通讯的示例代码/命令相关.md b/zh/docs/dev_doc/sdk_examples/XU316和MCU通讯的示例代码/命令相关.md index d5ebf2a..945a2cd 100644 --- a/zh/docs/dev_doc/sdk_examples/XU316和MCU通讯的示例代码/命令相关.md +++ b/zh/docs/dev_doc/sdk_examples/XU316和MCU通讯的示例代码/命令相关.md @@ -5,7 +5,8 @@ keywords: XU316, MCU, 通信协议, 命令参考 hide: -toc --- - + +--8<-- "common/phaten_xmos_support_img.md" # XU316与MCU通信协议参考 diff --git a/zh/mkdocs.yml b/zh/mkdocs.yml index 671338f..a81d4ee 100644 --- a/zh/mkdocs.yml +++ b/zh/mkdocs.yml @@ -267,7 +267,9 @@ nav: - XU316 USB HiFi解码器免开发产品配置协议: dev_doc/protocols/xu316_zerocode_protocol.md - 开发SDK与示例: - dev_doc/sdk_examples/index.md - - A316免开发固件开发示例: + - A316免开发固件MCU开发指南: + - dev_doc/sdk_examples/XU316和MCU通讯的示例代码/index.md + - 免开发固件开发问题指南: dev_doc/faq/technical_faq/a316_firmware_dev_faq.md - XU316音频接口控制代码示例: dev_doc/sdk_examples/XU316和MCU通讯的示例代码/产品内容相关.md - XU316与MCU通信协议命令宏定义: dev_doc/sdk_examples/XU316和MCU通讯的示例代码/命令的相关宏.md - XU316与MCU通信协议参考: dev_doc/sdk_examples/XU316和MCU通讯的示例代码/命令相关.md @@ -280,8 +282,8 @@ nav: - dev_doc/faq/index.md - 产品常见问题: - 电脑音频设备设置: dev_doc/hifi_audio/a316_1926v1/used.md - - 通用技术问答: - - 免开发固件开发问题指南: dev_doc/faq/technical_faq/a316_firmware_dev_faq.md + # - 通用技术问答: + # - 免开发固件开发问题指南: dev_doc/faq/technical_faq/a316_firmware_dev_faq.md - 服务&支持: - services_support/index.md