# ESP-CSI-Array

**Repository Path**: LitzJ/esp-csi-array

## Basic Information

- **Project Name**: ESP-CSI-Array
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: WTFPL
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2026-05-09
- **Last Updated**: 2026-06-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ESP32 CSI 多板采集系统

本仓库是 CSI 多板采集系统的主仓库，负责汇总系统级文档并通过 Git submodule 管理各子仓库。

系统由多个 ESP32-C5 节点和一块 ESP32-S3 底板组成：

- `C5-Send`：ESP32-C5 发送端，负责产生稳定的 ESP-NOW 无线触发包。
- `C5-Receiver`：ESP32-C5 采集端，负责接收无线帧、采集 CSI，并通过 SPI Slave 暴露数据。
- `S3-BaseBoard`：ESP32-S3 汇聚端，负责轮询多个 C5 Receiver、汇聚 CSI、落盘并对接上位机。
- `components`：共享 ESP-IDF 组件，包含 SPI 链路壳层和 CSI SPI 协议定义。
- `tools`：Python 上位机工具，包含串口 GUI、离线 CSV 校验、统计和绘图。

## 初始化子仓库

进入主仓库后初始化 Git submodule：

```bash
git submodule update --init --recursive
```

## 运行环境

固件工程推荐使用：

- ESP-IDF `v6.0.1`
- 支持 ESP32-C5 和 ESP32-S3 的 Espressif 工具链
- Python 环境按 ESP-IDF `v6.0.1` 安装器或 `install` 脚本生成

ESP-IDF Windows 安装教程：

- [在 Windows 上安装 ESP-IDF 及工具链](https://docs.espressif.com/projects/esp-idf/zh_CN/stable/esp32/get-started/windows-setup.html)

上位机工具推荐使用：

- Python `3.10` 或更高版本
- `tools/pyproject.toml` 中声明的依赖

Windows 下如果使用 Espressif IDE 或 ESP-IDF PowerShell，进入对应固件子仓库后执行 `idf.py build` 即可构建。不同机器的 ESP-IDF 安装路径可能不同，不应写入仓库文档。

## 目录结构

```text
CSI/
  README.md
  docs/
    technical/
    troubleshooting/
  application/
  C5-Send/
  C5-Receiver/
  S3-BaseBoard/
  components/
  tools/
```

## 文档导航

- [开发与文档规范](CONTRIBUTING.md)
- [项目总览](docs/technical/项目总览.md)
- [SPI 链路与多 C5 汇聚协议设计](docs/technical/SPI链路与多C5汇聚协议设计.md)
- [CSI 数据格式与信道配置说明](docs/technical/CSI数据格式与信道配置说明.md)
- [SD 卡 CSV 解析说明](docs/technical/SD卡CSV解析说明.md)
- [C5 侧 SPI 问题排查说明](docs/troubleshooting/C5侧SPI问题排查说明.md)
- [S3 串口交互协议](tools/csi_tool/docs/串口交互协议.md)

子仓库入口：

- [C5-Send](C5-Send/README.md)
- [C5-Receiver](C5-Receiver/README.md)
- [S3-BaseBoard](S3-BaseBoard/README.md)
- [components](components/README.md)
- [tools](tools/README.md)

## 文档归属规则

- 跨多个子仓库的系统架构、链路、数据格式和联调问题，放在主仓库 `docs/`。
- 只服务某一个子仓库的构建、接口、模块说明和问题排查，放在对应子仓库。
- 协议类文档只保留一个权威入口，其他位置只链接，不复制内容。