OTGateway 项目使用教程

OTGateway 项目使用教程

OTGateway OpenTherm gateway for HomeAssistant 项目地址: https://gitcode.com/gh_mirrors/ot/OTGateway

1. 项目目录结构及介绍

OTGateway 项目的目录结构如下：

OTGateway/
├── assets/
├── build/
├── data/
├── lib/
├── src/
├── src_data/
├── tools/
├── .gitignore
├── LICENSE
├── README.md
├── esp32_partitions.csv
├── gulpfile.js
├── otgateway.ino
├── package.json
├── platformio.ini
└── secrets_default.ini

目录介绍

• assets/: 存放项目相关的资源文件。
• build/: 存放编译生成的文件。
• data/: 存放项目的数据文件。
• lib/: 存放项目依赖的库文件。
• src/: 存放项目的源代码文件。
• src_data/: 存放项目的数据源文件。
• tools/: 存放项目使用的工具文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• esp32_partitions.csv: ESP32 分区配置文件。
• gulpfile.js: Gulp 构建工具配置文件。
• otgateway.ino: 项目的主启动文件。
• package.json: Node.js 项目依赖配置文件。
• platformio.ini: PlatformIO 项目配置文件。
• secrets_default.ini: 项目默认的配置文件。

2. 项目启动文件介绍

项目的主启动文件是 otgateway.ino。这个文件包含了项目的初始化代码和主要逻辑。启动文件的主要功能包括：

• 初始化硬件和软件环境。
• 配置网络连接和 MQTT 服务器。
• 启动 OpenTherm 网关的主要功能。

3. 项目的配置文件介绍

项目的配置文件主要包括 platformio.ini 和 secrets_default.ini。

platformio.ini

platformio.ini 是 PlatformIO 项目的配置文件，用于配置项目的构建和上传选项。主要配置项包括：

• platform: 指定使用的硬件平台（如 ESP32 或 ESP8266）。
• board: 指定使用的开发板型号。
• framework: 指定使用的开发框架（如 Arduino）。
• lib_deps: 指定项目依赖的库。

secrets_default.ini

secrets_default.ini 是项目的默认配置文件，包含了一些敏感信息的默认配置。主要配置项包括：

• WIFI_SSID: Wi-Fi 网络的 SSID。
• WIFI_PASSWORD: Wi-Fi 网络的密码。
• MQTT_SERVER: MQTT 服务器的地址。
• MQTT_PORT: MQTT 服务器的端口。
• MQTT_USER: MQTT 服务器的用户名。
• MQTT_PASSWORD: MQTT 服务器的密码。

这些配置项可以在项目启动时被读取和使用，确保项目能够正确连接到网络和 MQTT 服务器。

OTGateway OpenTherm gateway for HomeAssistant 项目地址: https://gitcode.com/gh_mirrors/ot/OTGateway