NormallyClosed 项目启动与配置教程

1. 项目的目录结构及介绍

NormallyClosed 项目是一个使用 Raspberry Pi 控制车库门的开源项目。项目的目录结构如下：

NormallyClosed/
├── .cargo/             # Cargo 的配置文件
├── .github/            # GitHub 工作流的配置文件
├── images/             # 项目相关的图片资源
├── src/                # 源代码目录
├── .dockerignore       # Docker 构建时需要忽略的文件
├── .editorconfig       # 编辑器配置文件
├── .gitignore          # Git 忽略文件
├── .rustfmt.toml       # Rust 格式化配置文件
├── CHANGELOG.md        # 项目更新日志
├── Cargo.lock          # Cargo 锁文件
├── Cargo.toml          # Cargo 配置文件
├── Dockerfile          # Docker 构建文件
├── LICENSE.txt         # 项目许可证文件
├── README.md           # 项目说明文件
├── RELEASING.md        # 发布说明文件
├── config.example.toml # 配置文件示例

目录说明：

• .cargo/: 包含 Rust 的构建系统 Cargo 的配置文件。
• .github/: 包含 GitHub Actions 工作流的配置文件。
• images/: 存放项目相关的图片资源。
• src/: 源代码目录，包含项目的核心实现。
• .dockerignore: 列出在构建 Docker 镜像时应被忽略的文件。
• .editorconfig: 定义代码编辑器的配置，以保持代码风格的一致性。
• .gitignore: 列出 Git 应该忽略的文件，以避免将不必要的文件提交到仓库。
• .rustfmt.toml: Rust 代码格式化工具 rustfmt 的配置文件。
• CHANGELOG.md: 记录项目的版本更新和变更历史。
• Cargo.lock: 记录项目的依赖和构建状态，确保构建的一致性。
• Cargo.toml: Rust 项目的主配置文件，定义项目 metadata、依赖等。
• Dockerfile: 定义如何构建项目的 Docker 镜像。
• LICENSE.txt: 项目的开源许可证文件。
• README.md: 项目的主要说明文件，介绍项目的用途、安装和使用方法。
• RELEASING.md: 提供项目发布时的指南和步骤。
• config.example.toml: 项目配置文件的示例，用于指导用户如何配置项目。

2. 项目的启动文件介绍

项目的启动文件是 src/main.rs，它是 Rust 项目的入口点。在这个文件中，定义了如何解析命令行参数、加载配置文件、设置 Web 服务器以及启动服务。

以下是启动文件的基本结构：

fn main() {
    // 解析命令行参数
    // 加载配置文件
    // 设置 Web 服务器
    // 启动服务
}

在 main 函数中，通常会调用一个函数来设置和启动 Web 服务器，该服务器将处理来自浏览器的请求。

3. 项目的配置文件介绍

项目的配置文件是 config.toml，它位于项目的根目录。这个文件包含了项目运行所需的配置信息，例如 Web 服务器的端口、GPIO 引脚的映射等。

以下是配置文件的基本内容：

# Web 服务器配置
[server]
port = 31415

# GPIO 引脚映射
[garage]
button_pin = 17
 relay_pin = 27

在 config.toml 文件中，可以定义以下配置：

• server.port: Web 服务器监听的端口。
• garage.button_pin: 控制按钮的 GPIO 引脚编号。
• garage.relay_pin: 控制继电器的 GPIO 引脚编号。

用户可以根据自己的硬件设置调整这些配置项，以适应不同的环境需求。

请注意，以上内容是按照 Markdown 格式编写的，且不含任何链接。