From 7e9aefdd5faa7733153f5330036b8647176bc92c Mon Sep 17 00:00:00 2001 From: yelvlab Date: Mon, 20 Jan 2025 15:22:32 +0800 Subject: [PATCH] =?UTF-8?q?=E5=8F=91=E5=B8=830.1.0=E7=89=88=E6=9C=AC?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CMakeLists.txt | 4 +- CommunicationProtocol.md | 79 ++++++++++++++++++++++++++++++++++++++ README.md | 83 +++------------------------------------- inc/board_config.h | 4 +- 4 files changed, 89 insertions(+), 81 deletions(-) create mode 100644 CommunicationProtocol.md diff --git a/CMakeLists.txt b/CMakeLists.txt index e872d4d..9a6026c 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -6,13 +6,13 @@ set(PROJECT_NAME "XLSW_3DP_US-IR") project(${PROJECT_NAME}) set(VERSION_MAJOR 0) -set(VERSION_MINOR 2) +set(VERSION_MINOR 1) set(VERSION_PATCH 0) set(VERSION "V${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH}") string(TIMESTAMP CURRENT_DATE "%Y-%m-%d") # Options 1 -set(OPT1 "_[12V]") +set(OPT1 "_[24V]") #set(OPT1 "_[SW_IIC]") # Options 2 diff --git a/CommunicationProtocol.md b/CommunicationProtocol.md new file mode 100644 index 0000000..ff752e4 --- /dev/null +++ b/CommunicationProtocol.md @@ -0,0 +1,79 @@ +# US&IR传感器模块通信协议 + +## US&IR传感器模块通信协议 + +| **序号** | **修改内容** | **版本** | **日期** | **修改人** | +|:------:|:--------:|:------:|:----------:|:-------:| +| 1 | 初版 | V0.1 | 2025-01-20 | Hulk | +| | | | | | +| | | | | | +| | | | | | + +### 发包格式 + +| **包头** | **类型** | **数据长度** | **数据** | **校验** | +|:------:|:------:|:-----------:|:------:|:------:| +| D5 | 0x04 | Data Length | Data | CRC | + +- 数据长度只包含数据部分，不包含包头、类型、数据长度、校验 +- CRC求和校验，包含类型、数据长度、数据 +- 数据部分为ascii码 + +### 回包格式 + +| **包头** | **状态码** | **数据长度** | **数据** | **校验** | +|:------:|:----------:|:-----------:|:------:|:------:| +| 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` + +------------------- + +## US&IR传感器模块功能 + +### 1. 读取液面的超声距离 + +- 发送M1指令，读取距离液面的超声距离。 + - `D5 04 02 4D 31 84` +- 电涡流传感器模块涡流回复数据 + - `B5 F0 02 1D C0 CF`, 有效数据为 `0x1DC0`，转换为`7616`,距离为76.16mm + - `B5 F0 02 16 A5 AD`, 有效数据为 `0x16A5`，转换为`5797`,距离为57.97mm +- 错误命令（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. 读取液面红外温度传感器数据 + +- 发送M2指令，读取液面红外温度传感器数据。 + - `D5 04 02 4D 32 85` +- 电涡流传感器模块温度补偿回复数据 + - `B5 F0 02 00 BD AF`, 有效数据为 `0x00BD`，转换为`189`（单位为摄氏度*10）温度为18.9℃ + - `B5 F0 02 01 0C FF`, 有效数据为 `0x010C`，转换为`268`（单位为摄氏度*10）温度为26.8℃ +- 错误命令（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` + +### 3. 读取数据时间间隔 + +- 推荐数据时间间隔至少为1s \ No newline at end of file diff --git a/README.md b/README.md index 1a1fe8a..151db84 100644 --- a/README.md +++ b/README.md @@ -1,80 +1,9 @@ -# gd32e23x_template -本项目为`GD32E230Fx`系列的基于Clion的CMake开发的工程模板。本人暂未入门，强行上强度，放弃keil，拥抱开源。遂尝试使用arm-none-eabi-gcc进行开发。 -有幸寻得[@mo10 ](https://github.com/mo10)大佬的帮助，本项目的基础目录架构与CMakeLists.txt与toolchain.cmake均为大佬提供。 +# XLSW-3DP-Sensor-UltraSonic&IR -## 关于本项目 -本项目默认的芯片型号为`GD32E230F4`，但是可以根据需要修改为其他型号，具体修改方法请参考下方`关于链接脚本`的说明。 -### 版本号 -默认版本号为`0.0.1`，在`CMakeLists.txt`中修改`PROJECT_VERSION`即可。 -### 项目名称 -默认项目名称为`gd32e23x_template`，在`CMakeLists.txt`中修改`PROJECT_NAME`即可。请先修改项目名称再配置编译环境。 -### 软件IIC与硬件IIC -本项目中提供了软件IIC与硬件IIC的驱动，但是默认使用硬件IIC，如果需要使用软件IIC，请在`board_config.h`中取消注释`// #define SOFTWARE_IIC`(line 8)。 -### 编译选项 -本项目预留了两个编译选项，`OPT1`与`OPT2`，默认均为空，请根据需要自行修改，例如`OPT1`为`_[HW_IIC]`，`OPT2`为`_[NO_LED]`。 -`OPT1`与`OPT2`均在`CMakeLists.txt`中可修改。 -### 关于编译日期 -本项目在`CMakeLists.txt`中添加了编译日期。 +| **版本号** | **修改内容** | **日期** | **修改人** | +|:-------:|:--------:|:----------:|:-------:| +| v0.0.1 | 非稳定版本 | 2025-01-20 | Hulk | -### 关于led -本项目默认开启了LED闪烁，并使用TIMER16进行定时。 +## US&IR传感器模块通信协议 - -## 关于C标准库的printf的重写 -在Keil开发中，ARMClang有自己的microLIB，所以直接调用，然后重写fputc函数即可，但在gcc中需要重写`_write`函数，本项目模板中已经在`main.c`中完成重写。 -同时需要添加`--spaces=nano.spaces`编译参数。 -但是printf本身占用flash比较大，建议谨慎使用，尤其是本项目搭建时候采用的型号为`GD32E230F4V6`内存非常有限，重写后加上spaces设置，目前能用。 - -## 添加源文件与头文件 -在`ProjectDir/CMakeLists.txt`中21行左右，添加对应源文件即可。 - -```cmake -set(TARGET_C_SRC - ${CMAKE_SOURCE_DIR}/src/main.c - ${CMAKE_SOURCE_DIR}/src/gd32e23x_it.c - ${CMAKE_SOURCE_DIR}/src/systick.c -) -``` -## 关于链接脚本 -注意芯片选型, 不同型号的芯片 FLASH 和 RAM 大小不同。需要修改链接脚本`ld/gd32e23x_gcc.ld` - -| 芯片型号 | FLASH | RAM | -|------------|-------|-----| -| GD32E230F4 | 16K | 4K | -| GD32E230F8 | 64K | 8K | - -```linkerscript -/* memory map */ -MEMORY -{ -FLASH (rx) : ORIGIN = 0x08000000, LENGTH = 16K -RAM (xrw) : ORIGIN = 0x20000000, LENGTH = 4K -} -``` - -## 关于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 -``` - - -## 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) - -[https://github.com/Noveren/gd32e23x-template/blob/main/gd32e23x/template/startup.s](https://github.com/Noveren/gd32e23x-template/blob/main/gd32e23x/template/startup.s) - -2. 官方LD/Startup - -使用Embedded Builder工具生成的C标准库生成的模板 +通信协议：[US&IR通信协议](CommunicationProtocol.md) \ No newline at end of file diff --git a/inc/board_config.h b/inc/board_config.h index c50bd57..d6af13d 100644 --- a/inc/board_config.h +++ b/inc/board_config.h @@ -9,8 +9,8 @@ // #define DEBUG_VERBOES -#define POWER_SUPPLY_12V -// #define POWER_SUPPLY_24V +// #define POWER_SUPPLY_12V +#define POWER_SUPPLY_24V /******************************************************************************/