From ab2b780da327b23fec2fea742194bedc78b7aa00 Mon Sep 17 00:00:00 2001
From: "CSSC-WORK\\murmur" <work@hhilp>
Date: Tue, 3 Dec 2024 08:29:18 +0800
Subject: [PATCH] add fileREADME.md

---
 README.md | 74 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 74 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..60ff78c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,74 @@
+# 功能
+采集板具备深度计、加速度计和陀螺仪，可采集相关数据并以`*.BIN`格式存储，可通过工具格式化输出为`*.CSV`，支持Excel或文本编辑器查看、编辑。
+
+# 采集状态检查
+
+调试口有调试串口（TTL/115200-8-1-N），具备查看采集状态的功能。
+
+采集状态有误时会不断重启，正常状态则会不断刷新采集的数据。
+
+如遇采集状态有误，则需要给水密桶`断电、稍等、重新上电`尝试恢复。
+
+# 采集数据格式
+原始采集的数据文件后缀为`.BIN`，以结构体`info_t`小端序存储。
+```c
+// MPU传感器数据结构
+typedef struct {
+    int16_t ax;    // 加速度计 X轴
+    int16_t ay;    // 加速度计 Y轴
+    int16_t az;    // 加速度计 Z轴
+    int16_t gx;    // 陀螺仪 X轴
+    int16_t gy;    // 陀螺仪 Y轴
+    int16_t gz;    // 陀螺仪 Z轴
+} sensor_data_t;
+
+// 完整的数据记录结构
+#pragma pack(1)
+typedef struct {
+    uint8_t y;        // 年（相对值，需要加上2000）
+    uint8_t month;    // 月
+    uint8_t d;        // 日
+    uint8_t h;        // 时
+    uint8_t m;        // 分
+    uint8_t s;        // 秒
+    uint16_t ms;      // 毫秒
+    int16_t deepth;  // 深度
+    sensor_data_t data;  // MPU传感器数据
+} info_t;
+```
+# 导出采集数据
+
+调试口连有一A口USB接头，插入电脑后**稍作等待**，系统会多出一个盘符，双击打开可浏览采集的数据文件，其以日期为文件名，形如`20241112.BIN`。
+
+选中采集文件后**用鼠标拖入**本地磁盘某位置即可。
+
+# 解析采集数据
+
+`WIN+R`输入cmd后按回车键运行命令行，在命令行中输入`decode.exe`回车，会提示具体的使用方法，如：
+
+```
+用法：
+decode.exe -f <文件名> [-o <输出文件名>]
+选项：
+  -f <文件名>    指定输入文件
+  -o <文件名>    指定输出文件（可选，默认输出到与输入同名的.csv文件）
+  -h            显示帮助信息
+
+示例：
+decode.exe -f 20241112.BIN
+decode.exe -f 20241112.BIN -o output.csv
+```
+
+运行结果如：
+
+```cmd
+D:\Users\murmur\Desktop\test>decode.exe -f 20241112.BIN
+系统类型: Windows
+系统字节序: 小端序
+共解析 46980 条记录
+```
+
+# 异常处理
+
+可通过转换后文件内的日期数据判断解析是否正确，如不正确请重新导出。
+