docs: reorganize project documentation
This commit is contained in:
+7
-6
@@ -2,9 +2,9 @@
|
||||
|
||||
## 1. 文档范围
|
||||
|
||||
本文档定义 `TCP2UART` 项目的最终 AT 外部协议。
|
||||
本文档定义 `TCP2UART` 项目的 AT 外部协议。
|
||||
|
||||
本文档只描述最终协议模型,不保留任何历史展开式实例字段,不包含测试记录,不讨论旧版兼容命令。
|
||||
本文档只描述当前代码实现支持的外部命令,不保留历史展开式实例字段,不包含测试记录,不讨论旧版兼容命令。项目结构、任务模型和数据流请阅读 `README.md` 与 `项目代码阅读指南.md`。
|
||||
|
||||
适用对象:
|
||||
|
||||
@@ -56,12 +56,12 @@ SYNC | LEN_H | LEN_L | SRCID | DSTMASK | PAYLOAD | TAIL
|
||||
|
||||
字段定义:
|
||||
|
||||
- `SYNC`:帧起始标记,建议固定为 `0x7E`
|
||||
- `SYNC`:帧起始标记,固定为 `0x7E`
|
||||
- `LEN_H / LEN_L`:`PAYLOAD` 长度,高字节在前
|
||||
- `SRCID`:单字节源端点 ID
|
||||
- `DSTMASK`:单字节目标端点位图
|
||||
- `PAYLOAD`:负载数据
|
||||
- `TAIL`:帧结束标记,建议固定为 `0x7F`
|
||||
- `TAIL`:帧结束标记,固定为 `0x7F`
|
||||
|
||||
规则:
|
||||
|
||||
@@ -394,9 +394,10 @@ AT+RESET\r\n
|
||||
1. `AT+SAVE\r\n`
|
||||
2. `AT+RESET\r\n`
|
||||
|
||||
## 13. 相关文件
|
||||
## 13. 相关文档与文件
|
||||
|
||||
- 项目入口:`README.md`
|
||||
- 代码结构和数据流:`项目代码阅读指南.md`
|
||||
- AT 命令实现:`App/config.c`
|
||||
- 配置结构与默认值:`App/config.h`
|
||||
- FreeRTOS 任务定义:`Core/Src/freertos.c`
|
||||
- 调试指导:`工程调试指南.md`
|
||||
|
||||
Reference in New Issue
Block a user