SMLReader 开源项目教程

SMLReader 开源项目教程

SMLReader ESP8266 based smart meter (SML) to MQTT gateway 项目地址: https://gitcode.com/gh_mirrors/sml/SMLReader

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

SMLReader 项目的目录结构如下：

SMLReader/
├── doc/
├── include/
├── lib/
├── src/
├── test/
├── .gitignore
├── .travis.yml
├── CHANGELOG.md
├── LICENSE
├── README.md
└── platformio.ini

目录结构介绍

• doc/: 存放项目文档，包括使用说明、API文档等。
• include/: 存放项目的头文件。
• lib/: 存放项目依赖的库文件。
• src/: 存放项目的源代码文件。
• test/: 存放项目的测试代码。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• platformio.ini: PlatformIO 配置文件。

2. 项目的启动文件介绍

SMLReader 项目的启动文件主要位于 src/ 目录下。主要的启动文件是 src/main.cpp，它是项目的入口文件。

src/main.cpp 文件介绍

main.cpp 文件包含了项目的初始化代码和主循环逻辑。它负责初始化硬件、配置网络、连接 MQTT 服务器，并启动数据读取和发布流程。

#include <Arduino.h>
#include "SMLReader.h"

void setup() {
    // 初始化硬件
    SMLReader::init();
    // 配置网络
    SMLReader::setupNetwork();
    // 连接 MQTT 服务器
    SMLReader::connectMQTT();
}

void loop() {
    // 主循环逻辑
    SMLReader::loop();
}

3. 项目的配置文件介绍

SMLReader 项目的配置文件主要有两个：platformio.ini 和 src/config.h。

platformio.ini 文件介绍

platformio.ini 是 PlatformIO 的配置文件，用于配置项目的编译和上传选项。以下是配置文件的部分内容：

[env:d1_mini]
platform = espressif8266
board = d1_mini
framework = arduino
lib_deps =
    # 依赖库
    PubSubClient
    IotWebConf

src/config.h 文件介绍

src/config.h 文件包含了项目的配置选项，如传感器配置、网络配置、MQTT 配置等。以下是配置文件的部分内容：

#define SENSOR_CONFIGS { \
    { \
        .pin = D2, \
        .name = "1", \
        .numeric_only = false, \
        .status_led_enabled = true, \
        .status_led_inverted = true, \
        .status_led_pin = LED_BUILTIN, \
        .interval = 0 \
    }, \
    { \
        .pin = D5, \
        .name = "2", \
        .numeric_only = false, \
        .status_led_enabled = true, \
        .status_led_inverted = true, \
        .status_led_pin = LED_BUILTIN, \
        .interval = 0 \
    }, \
    { \
        .pin = D6, \
        .name = "3", \
        .numeric_only = false, \
        .status_led_enabled = true, \
        .status_led_inverted = true, \
        .status_led_pin = LED_BUILTIN, \
        .interval = 15 \
    } \
}

以上配置文件定义了传感器的 GPIO 引脚、名称、是否只发布数值数据、状态 LED 的配置等。

---

通过以上内容，您可以了解 SMLReader 项目的目录结构、启动文件和配置文件的基本信息。希望这篇教程对您有所帮助！

SMLReader ESP8266 based smart meter (SML) to MQTT gateway 项目地址: https://gitcode.com/gh_mirrors/sml/SMLReader