Deye 逆变器 MQTT 桥接项目教程

Deye 逆变器 MQTT 桥接项目教程

deye-inverter-mqtt Reads Deye solar inverter metrics and posts them over mqtt 项目地址: https://gitcode.com/gh_mirrors/de/deye-inverter-mqtt

1. 项目目录结构及介绍

deye-inverter-mqtt/
├── docs/
│   └── ha_definitions/
├── mosquitto/
│   └── plugins/
├── src/
│   └── systemd/
├── tests/
├── tools/
├── .gitignore
├── CONTRIBUTING.md
├── Dockerfile
├── LICENSE
├── Makefile
├── README.md
├── config.env.example
├── deye_cli.sh
├── docker-compose.yaml
├── local-run.sh
├── poetry.lock
├── pyproject.toml
├── requirements-dev.txt
└── requirements.txt

目录结构介绍

• docs/: 包含项目文档，特别是 Home Assistant 定义文件。
• mosquitto/: 包含 Mosquitto MQTT 代理的插件。
• src/: 项目的主要源代码，包括系统服务文件。
• tests/: 包含项目的测试代码。
• tools/: 包含项目的工具脚本。
• .gitignore: Git 忽略文件列表。
• CONTRIBUTING.md: 贡献指南。
• Dockerfile: Docker 构建文件。
• LICENSE: 项目许可证。
• Makefile: 项目构建文件。
• README.md: 项目自述文件。
• config.env.example: 配置文件示例。
• deye_cli.sh: Deye 逆变器命令行工具。
• docker-compose.yaml: Docker Compose 配置文件。
• local-run.sh: 本地运行脚本。
• poetry.lock: Poetry 依赖锁定文件。
• pyproject.toml: Poetry 项目配置文件。
• requirements-dev.txt: 开发依赖列表。
• requirements.txt: 项目依赖列表。

2. 项目启动文件介绍

deye_cli.sh

这是一个命令行工具脚本，用于与 Deye 逆变器进行交互。通过该脚本，用户可以执行各种操作，如读取逆变器数据、发布数据到 MQTT 等。

local-run.sh

这是一个本地运行脚本，用于在本地环境中启动项目。该脚本通常用于开发和测试目的。

docker-compose.yaml

这是一个 Docker Compose 配置文件，用于定义和运行多容器 Docker 应用程序。通过该文件，用户可以轻松启动和管理项目的 Docker 容器。

3. 项目配置文件介绍

config.env.example

这是一个配置文件示例，用户需要将其复制为 config.env 并根据实际情况填写配置参数。配置文件中包含以下关键参数：

• DEYE_LOGGER_PROTOCOL: 选择与日志记录器通信的协议（Modbus/TCP 或 Modbus/AT）。
• DEYE_PUBLISH_ON_CHANGE: 设置为 true 时，仅在数据发生变化时发布事件数据。
• DEYE_DATA_READ_INTERVAL: 数据读取间隔时间，单位为秒。
• DEYE_METRIC_GROUPS: 定义要读取的逆变器指标组。

pyproject.toml

这是 Poetry 项目的配置文件，定义了项目的依赖、脚本、构建配置等。通过该文件，用户可以管理项目的依赖和构建过程。

requirements.txt

这是项目的依赖列表，列出了项目运行所需的所有 Python 包。用户可以通过该文件安装项目的依赖。

requirements-dev.txt

这是开发依赖列表，列出了开发和测试过程中所需的所有 Python 包。用户可以通过该文件安装开发依赖。

deye-inverter-mqtt Reads Deye solar inverter metrics and posts them over mqtt 项目地址: https://gitcode.com/gh_mirrors/de/deye-inverter-mqtt