开源项目OpenSTM搭建与使用教程

1. 项目目录结构及介绍

OpenSTM项目是一个开源的扫描隧道显微镜(DIY STM)实现，它提供了全面的资源让爱好者搭建自己的原子级观测工具。以下是该项目的主要目录结构及其简要介绍：

├── 3DModels           # 包含外壳设计和CNC加工所需的STEP文件
├── Docs               # 开发过程中的重要文档与项目概览
│   ├── Docs_V2        # 更新后的文档版本，可能包含最新的指导信息
│   ├── ...
├── HardwareCode       # 微控制器程序，使用ESP32 IDF编写，适用于Platform IO
│   ├── PCB            # 印刷电路板的设计文件，需嘉立创EDA处理
│   └── PythonScript   # 上位机控制程序，确保设备与计算机的有效沟通
├── README.md          # 项目简介，包含关键信息和快速指引
└── ...

• 3DModels: 提供了物理部件的设计蓝图，便于自制硬件。
• Docs: 存储着重要文档，如构建指南和项目描述，对新手极其重要。
• HardwareCode: 核心代码库，包括单片机程序和固件，确保STM的电子部分正常运作。
• PCB: 电路板设计资料，包括原理图和PCB布局，帮助制作控制核心。
• PythonScript: 设备的上位机软件部分，负责数据通信与控制逻辑。

2. 项目的启动文件介绍

项目并没有明确指出单一的“启动文件”，因为不同的组件有不同的入口点。然而，对于初次使用，重点在于：

• HardwareCode中的main文件（通常在ESP32项目中），这是单片机程序的起点。
• 在PythonScript目录下的主要Python脚本，如果你是在设置上位机通讯部分，这将是与硬件交互的关键。

ESP32 启动流程示例

假设在ESP32端，你需要在Platform IO环境中设置项目，并找到类似main.ino的文件作为程序的开始，编译上传后，STM硬件开始执行初始化任务。

Python 上位机启动

查找名为main.py或项目指定的脚本，在Python环境中运行此脚本以建立与STM的通信并开始控制或数据采集。

3. 项目的配置文件介绍

配置信息分散于多个文件之中：

• HardwareCode中的.ino文件可能含有必要的硬件配置选项，如串口号、波特率等。
• ** Docs**中的特定文档文件可能包含了软件和硬件配置的指南，如传感器校准参数、固件配置指令。
• 若有专门的配置文件（如.toml, .json, 或者特定的配置文本文件），它们通常位于项目根目录或相关子目录下，但在这个项目案例中并未明确提及此类集中式的配置文件。

综上所述，理解OpenSTM项目涉及阅读文档和代码，特别是README.md以及硬件和软件工程中的注释，以获取详细的配置和启动步骤。由于配置和启动过程高度依赖于具体的硬件设置和编程环境，仔细阅读文档是至关重要的。