mqttwarn

To warn, alert, or notify.

About

mqttwarn - subscribe to MQTT topics and notify pluggable services.

mqttwarn is a highly configurable MQTT message router, where the routing targets are notification plugins, primarily written in Python. A picture says a thousand words.

Features

• mqttwarn subscribes to any number of MQTT topics, optionally including wildcards, and publishes received payloads to one or more notification services, after optionally applying sophisticated transformations.

• Notifications are transmitted to notification services via plugins. mqttwarn ships with a number of notifier plugins, see Notifier catalog, and you can easily add your own.

• For linking MQTT topics with notification plugins, you will configure corresponding mappings within mqttwarn’s configuration file mqttwarn.ini. You can accomplish, for example, the following mappings:

  • PUBs to owntracks/jane/iphone should be notified via Pushover to John’s phone

  • PUBs to openhab/temperature should notify Mastodon or Twitter

  • PUBs to home/monitoring/alert/+ should notify Prowl and Mail

• You can optionally engage a sophisticated transformation facility.

Notification service coverage

mqttwarn comes with over 70 notification handler plugins for a wide range of notification services and is very open to further contributions. You can enjoy the alphabetical list of plugins at Notifier catalog.

On top of that, mqttwarn integrates with the Apprise notification library. Apprise notification services has a complete list of the 80+ notification services supported by Apprise.

Documentation

In order to configure and operate mqttwarn successfully, please read the documentation carefully.

• Install and operate mqttwarn

• The mqttwarn configuration

• README

Important

mqttwarn aims to provide concise documentation about its machinery and internals. If you observe any rough edges, please don’t hesitate to submit a suggestion how we can improve or extend the documentation. Did we say that we also love pull requests in this regard?

Articles

What others are saying about mqttwarn, or what they are using it for.

• JP has written a few introductory articles. Thanks!

  • Introducing mqttwarn: a pluggable MQTT notifier

  • How do your servers talk to you?

  • Alerting or notifying on SSH logins

• MQTTwarn: Ein Rundum-Sorglos-Notifier article in German at JAXenter.

• The folks of the Berlin-based beekeeper collective Hiveeyes are monitoring their beehives and use mqttwarn as a building block for their alert notification system, enjoy reading Schwarmalarm using mqttwarn.

Notes

“MQTT” is a trademark of the “OASIS open standards” consortium, which publishes the MQTT specifications.

---