OctoPrint-MQTT 插件使用教程

OctoPrint-MQTT 插件使用教程

OctoPrint-MQTT An OctoPrint Plugin that adds support for MQTT. 项目地址: https://gitcode.com/gh_mirrors/oc/OctoPrint-MQTT

1. 项目介绍

OctoPrint-MQTT 是一个为 OctoPrint 设计的插件，旨在通过 MQTT 协议增强 OctoPrint 的功能。该插件允许 OctoPrint 与 MQTT 代理进行通信，从而实现远程监控和控制打印机。通过该插件，用户可以接收打印机状态、温度、打印进度等实时信息，并可以通过 MQTT 发布命令来控制打印机。

2. 项目快速启动

2.1 安装插件

首先，确保你已经安装了 OctoPrint。然后，通过 OctoPrint 的插件管理器安装 OctoPrint-MQTT 插件。你可以使用以下 URL 进行安装：

https://github.com/OctoPrint/OctoPrint-MQTT/archive/master.zip

2.2 配置 MQTT 代理

安装完成后，进入 OctoPrint 的设置页面，找到 MQTT 插件的配置选项。配置 MQTT 代理的 URL、端口、用户名和密码等信息。以下是一个示例配置：

plugins:
  mqtt:
    broker:
      url: "127.0.0.1"
      port: 1883
      username: "your_username"
      password: "your_password"

2.3 启动插件

保存配置后，重启 OctoPrint 服务。插件将自动连接到配置的 MQTT 代理，并开始发布和订阅相关主题。

2.4 测试连接

你可以使用 MQTT 客户端工具（如 MQTT.fx）订阅 OctoPrint 发布的消息主题，例如 octoPrint/event/ClientOpened，来验证插件是否正常工作。

3. 应用案例和最佳实践

3.1 远程监控打印机状态

通过订阅 octoPrint/temperature/tool0 和 octoPrint/temperature/bed 主题，你可以实时监控打印机的热端和热床温度。这对于远程监控打印进度和温度变化非常有用。

3.2 自动化打印任务

你可以编写一个自动化脚本，订阅 octoPrint/progress/printing 主题，当打印进度达到某个百分比时，自动发送 MQTT 消息来暂停或取消打印任务。

3.3 集成智能家居系统

将 OctoPrint 与智能家居系统（如 Home Assistant）集成，通过 MQTT 协议实现打印机状态的实时显示和控制。例如，当打印任务完成时，自动触发家庭灯光或播放音乐。

4. 典型生态项目

4.1 OctoPrint

OctoPrint 是一个开源的 3D 打印机控制软件，支持通过 Web 界面远程控制打印机。OctoPrint-MQTT 插件是其生态系统中的重要组成部分，增强了其远程监控和控制能力。

4.2 Home Assistant

Home Assistant 是一个开源的智能家居平台，支持通过 MQTT 协议与各种设备进行通信。通过 OctoPrint-MQTT 插件，你可以将 3D 打印机状态集成到 Home Assistant 中，实现智能家居与 3D 打印的完美结合。

4.3 MQTT.fx

MQTT.fx 是一个用于测试和调试 MQTT 协议的客户端工具。通过 MQTT.fx，你可以方便地订阅和发布 MQTT 主题，验证 OctoPrint-MQTT 插件的配置和功能。

通过以上教程，你应该能够快速上手使用 OctoPrint-MQTT 插件，并将其应用于各种实际场景中。

OctoPrint-MQTT An OctoPrint Plugin that adds support for MQTT. 项目地址: https://gitcode.com/gh_mirrors/oc/OctoPrint-MQTT