在readme种更新通信协议

README.md

@@ -1,63 +1,76 @@
-# gd32e23x_template
-本项目为GD32E230Fx系列的基于Clion的CMake开发的工程模板。本人暂未入门，强行上强度，放弃keil，拥抱开源。遂尝试使用arm-none-eabi-gcc进行开发。
-有幸寻得[@mo10 ](https://github.com/mo10)大佬的帮助，本项目的基础目录架构与CMakeLists.txt与toolchain.cmake均为大佬提供。
+# 电涡流传感器模块通信协议
 
-## 关于C标准库的printf的重写
-在Keil开发中，ARMClang有自己的microLIB，所以直接调用，然后重写fputc函数即可，但在gcc中需要重写`_write`函数，本项目模板中已经在`main.c`中完成重写。
-同时需要添加`--spaces=nano.spaces`编译参数。
-但是printf本身占用flash比较大，建议谨慎使用，尤其是本项目搭建时候采用的型号为`GD32E230F4V6`内存非常有限，重写后加上spaces设置，目前能用。
+## 电涡流传感器模块通信协议
 
-## 添加源文件与头文件
-在`ProjectDir/CMakeLists.txt`中21行左右，添加对应源文件即可。
+| **序号** | **修改内容** | **版本** | **日期**     | **修改人** |
+|:------:|:--------:|:------:|:----------:|:-------:|
+| 1      | 初版       | V1.0   | 2024-12-25 | Hulk    |
+|        |          |        |            |         |
+|        |          |        |            |         |
+|        |          |        |            |         |
 
-```cmake
-set(TARGET_C_SRC
-        ${CMAKE_SOURCE_DIR}/src/main.c
-        ${CMAKE_SOURCE_DIR}/src/gd32e23x_it.c
-        ${CMAKE_SOURCE_DIR}/src/systick.c
-        ${CMAKE_SOURCE_DIR}/src/peripheral.c
-)
-```
-## 关于链接脚本
-注意芯片选型, 不同型号的芯片 FLASH 和 RAM 大小不同。需要修改链接脚本`ld/gd32e23x_gcc.ld`
+### 发包格式
 
-| 芯片型号       | FLASH | RAM |
-|------------|-------|-----|
-| GD32E230F4 | 16K   | 4K  |
-| GD32E230F8 | 64K   | 8K  |
+| **包头** | **类型** | **数据长度**    | **数据** | **校验** |
+|:------:|:------:|:-----------:|:------:|:------:|
+| D5     | 0x03   | Data Length |  Data  | CRC    |
 
-```linkerscript
-/* memory map */
-MEMORY
-{
-FLASH (rx)      : ORIGIN = 0x08000000, LENGTH = 16K
-RAM (xrw)       : ORIGIN = 0x20000000, LENGTH = 4K
-}
-```
+- 数据长度只包含数据部分，不包含包头、类型、数据长度、校验
+- CRC求和校验，包含类型、数据长度、数据
+- 数据部分为ascii码
 
-## 关于Startup文件
+### 回包格式
 
-[@mo10 ](https://github.com/mo10)大佬提供的一些想法，具体如下。但是我目前还没测试到实际的影响和作用范围，所以暂未同步进来，仅作为备忘内容
-```asm
-Reset_Handler:
-    ldr   r0, =_sp
-    mov   sp, r0
-    ldr   r0, =_end
-    msr   msplim, r0
-/* copy the data segment into ram */
-    movs  r1, #0
-    b  LoopCopyDataInit
-```
+| **包头** |  **状态码**   | **数据长度**    | **数据** | **校验** |
+|:------:|:----------:|:-----------:|:------:|:------:|
+|   B5   |  0xF0 正常包  | Data Length |  Data  | CRC    |
+|   B5   | 0xF1 CRC错误 | Data Length |  Data  | CRC    |
+|   B5   | 0xF2 包头错误  | Data Length |  Data  | CRC    |
+|   B5   | 0xF3 类型错误  | Data Length |  Data  | CRC    |
+|   B5   | 0xF4 包长度错误 | Data Length |  Data  | CRC    |
 
+- 数据长度只包含数据部分，不包含包头、类型、数据长度、校验
+- CRC求和校验，包含状态码、数据长度、数据
+- 有效数据部分为uint32_t，高字节在前
+- 包错误和指令错误时，数据部分为ascii码 `err`
 
-## Ref
+-------------------
 
-1. 参考LD/Startup
+## 电涡流传感器模块功能
 
-[https://github.com/Noveren/gd32e23x-template/blob/main/gd32e23x/template/linker.ld](https://github.com/Noveren/gd32e23x-template/blob/main/gd32e23x/template/linker.ld)
+### 1. 读取电涡流传感器模块数据
 
-[https://github.com/Noveren/gd32e23x-template/blob/main/gd32e23x/template/startup.s](https://github.com/Noveren/gd32e23x-template/blob/main/gd32e23x/template/startup.s)
+- 发送M1指令，读取电涡流传感器模块数据。
+  - `D5 03 02 4D 31 83`
+- 电涡流传感器模块涡流回复数据
+  - `B5 F0 04 01 AE 1B E4 A2`, 有效数据为 `0x01AE1BE4`，转换为`28187620`
+  - `B5 F0 04 04 19 C1 FA CC`, 有效数据为 `0x0419C1FAD2`，转换为`17612012242`
+- 错误命令（M3指令）回包
+  - `B5 F0 03 65 72 72 3C`，有效数据为 `err`
+- CRC错误回包
+  - `B5 F1 03 65 72 72 3D`, 有效数据为 `err`
+- 包头错误回包
+  - `B5 F2 03 65 72 72 3E`, 有效数据为 `err`
+- 类型错误回包
+  - `B5 F3 03 65 72 72 3F`, 有效数据为 `err`
+- 数据长度错误回包
+  - `B5 F4 03 65 72 72 40`, 有效数据为 `err`
 
-2. 官方LD/Startup
+### 2. 读取电涡流传感器模块温度补偿数据
+
+- 发送M2指令，读取电涡流传感器模块数据。
+  - `D5 03 02 4D 32 84`
+- 电涡流传感器模块温度补偿回复数据
+  - `B5 F0 04 00 03 40 85 BC`, 有效数据为 `0x00034085`，转换为`213125`（单位为摄氏度*10）温度为21.3125℃
+  - `B5 F0 04 00 03 89 C3 43`, 有效数据为 `0x000389C3`，转换为`231875`（单位为摄氏度*10）温度为23.1875℃
+- 错误命令（M3指令）回包
+  - `B5 F0 03 65 72 72 3C`，有效数据为 `err`
+- CRC错误回包
+  - `B5 F1 03 65 72 72 3D`, 有效数据为 `err`
+- 包头错误回包
+  - `B5 F2 03 65 72 72 3E`, 有效数据为 `err`
+- 类型错误回包
+  - `B5 F3 03 65 72 72 3F`, 有效数据为 `err`
+- 数据长度错误回包
+  - `B5 F4 03 65 72 72 40`, 有效数据为 `err`
 
-使用Embedded Builder工具生成的C标准库生成的模板