ESPurna 项目使用教程

ESPurna 项目使用教程

espurnaHome automation firmware for ESP8266-based devices项目地址:https://gitcode.com/gh_mirrors/es/espurna

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

ESPurna 项目的目录结构如下：

espurna/
├── code/
│   ├── dist/
│   ├── images/
│   ├── gitattributes
│   ├── gitignore
│   ├── gitmodules
│   ├── CHANGELOG.md
│   ├── CONTRIBUTING.md
│   ├── LICENSE
│   ├── README.md
│   ├── SUPPORT.md
│   ├── ci_install.sh
│   ├── ci_script.sh
│   └── pre-commit
├── espurna-board/
│   ├── images/
│   ├── parts/
│   ├── utils/
│   ├── gitignore
│   └── README.md
└── README.md

主要目录和文件介绍：

• code/: 包含项目的主要代码文件。

  • dist/: 存放编译后的二进制文件。
  • images/: 存放项目相关的图片资源。
  • CHANGELOG.md: 记录项目的更新日志。
  • CONTRIBUTING.md: 贡献指南。
  • LICENSE: 项目的许可证文件。
  • README.md: 项目的主文档。
  • SUPPORT.md: 支持信息。
  • ci_install.sh 和 ci_script.sh: 持续集成脚本。
  • pre-commit: 预提交钩子配置。

• espurna-board/: 包含与硬件相关的文件。

  • images/: 硬件相关的图片资源。
  • parts/: 硬件组件的描述文件。
  • utils/: 工具脚本。
  • README.md: 硬件相关的文档。

2. 项目的启动文件介绍

ESPurna 项目的启动文件主要位于 code/ 目录下。主要的启动文件是 code/espurna.ino，这是一个 Arduino 项目的主文件，包含了项目的初始化代码和主循环。

启动文件主要功能：

• 初始化硬件和网络连接。
• 设置 WiFi 模式（AP 模式或 STA 模式）。
• 加载配置文件并应用配置。
• 启动 Web 服务器和 MQTT 客户端。
• 进入主循环，处理各种事件和任务。

3. 项目的配置文件介绍

ESPurna 项目的配置文件主要位于 code/ 目录下，主要的配置文件是 code/espurna.conf。这个文件包含了项目的各种配置选项，如 WiFi 设置、MQTT 设置、设备名称等。

配置文件主要内容：

• WIFI_SSID 和 WIFI_PASS: WiFi 网络的 SSID 和密码。
• MQTT_SERVER: MQTT 服务器的地址。
• MQTT_USER 和 MQTT_PASS: MQTT 服务器的用户名和密码。
• DEVICE_NAME: 设备的名称。
• OTA_URL: 固件更新的 URL。
• POWER_MONITOR: 电源监控设置。

通过修改这些配置选项，可以定制 ESPurna 项目的行为和功能。

---

以上是 ESPurna 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用 ESPurna 项目。

espurnaHome automation firmware for ESP8266-based devices项目地址:https://gitcode.com/gh_mirrors/es/espurna