mqttwarn - 订阅MQTT主题并通知可插拔服务
项目描述
用于警告、警报或通知。
状态
关于
mqttwarn - 订阅MQTT主题并向可插拔服务通知。
描述
mqttwarn 订阅任意数量的MQTT主题，并在可选地应用复杂的转换后，将接收到的有效载荷发布到一个或多个通知服务。
一图胜千言。
通知服务覆盖范围
mqttwarn 随附 70多个通知处理器插件，覆盖广泛的notification services，并且非常欢迎进一步的贡献。您可以在mqttwarn通知器目录页面享受插件按字母顺序的列表。
除此之外，它还集成了优秀的Apprise通知库。Apprise通知服务提供了Apprise支持的 80多个通知服务 的完整列表。
文档
mqttwarn文档 是阅读有关 mqttwarn 的功能和集成，以及如何利用所有其框架组件构建自定义应用程序的正确地方。您可以在 mqttwarn通知器目录 页面上检查服务插件。
安装
使用pip
概要
pip install --upgrade mqttwarn
您还可以添加对特定服务插件的支持
pip install --upgrade 'mqttwarn[xmpp]'
您还可以一次添加对多个服务的支持
pip install --upgrade 'mqttwarn[apprise,asterisk,nsca,desktopnotify,tootpaste,xmpp]'
另请参阅： 使用pip安装mqttwarn。
OCI容器镜像
为了在Docker或Kubernetes等容器基础设施上运行 mqttwarn，相应的镜像会自动发布到GitHub容器注册表（GHCR）。
ghcr.io/mqtt-tools/mqttwarn-standard:latest
ghcr.io/mqtt-tools/mqttwarn-full:latest
有关此主题的更多信息，请参阅 使用OCI镜像与Docker或Podman 文档部分。
配置
要了解如何配置mqttwarn，请前往有关 mqttwarn配置 的文档部分。
用法
交互式服务
只需启动 mqttwarn
# Run mqttwarn mqttwarn
要提供不同的配置文件或日志文件，可以选择使用
# Define configuration file export MQTTWARNINI=/etc/mqttwarn/acme.ini # Define log file export MQTTWARNLOG=/var/log/mqttwarn.log # Run mqttwarn mqttwarn
系统守护进程
有几种运行mqttwarn作为系统守护进程的方法。在仓库的 etc 目录中提供了示例，例如 supervisor.ini（Supervisor）和 mqttwarn.service（systemd）。
独立运行
要从自定义程序直接调用通知插件或对其进行调试，请参阅 独立运行通知插件。
开发沙盒
要修改mqttwarn，请使用 mqttwarn开发沙盒 安装。
项目信息
关于
这些链接将引导您到 mqttwarn 和其文档的源代码。
需求
您至少需要以下组件
Python 3.x或PyPy 3.x。
一个MQTT代理。我们推荐Eclipse Mosquitto。
为了调用特定的服务插件，可能需要额外的Python模块。请参阅setup.py文件。
贡献
我们非常愿意接受来自社区的代码贡献、想法、建议和问题报告。
因此，如果您想贡献，我们非常欢迎。花点时间四处看看，找到错误、设计问题或拼写错误，然后向我们发送一个pull request或创建一个问题。
提前感谢您的努力，我们非常感激任何帮助或反馈。
许可证
mqttwarn版权© 2014-2023 Jan-Piet Mens和贡献者。版权所有。
它将始终是免费和开源软件。
所包含源代码的使用受Eclipse公共许可证2.0的约束，请参阅LICENSE文件以获取详细信息。请同时了解第三方组件的许可证。
故障排除
如果在设置或操作过程中遇到任何问题或您有其他建议，请通过在GitHub上创建一个问题来告知我们。感谢您的支持。
致谢
感谢
感谢所有以某种方式帮助构思mqttwarn的贡献者。您知道您是谁。
法律事宜
“MQTT”是OASIS开放标准联盟的商标，该联盟发布了MQTT规范。“Eclipse Mosquitto”是Eclipse基金会的商标。
祝您玩得开心！
下载文件
下载适用于您平台的文件。如果您不确定选择哪个，请了解有关安装软件包的更多信息。