-
Notifications
You must be signed in to change notification settings - Fork 768
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
sysutils/py-mqttwarn: Update documentation
- Loading branch information
Showing
2 changed files
with
15 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,13 @@ | ||
mqttwarn subscribes to any number of MQTT topics (which may include wildcards) | ||
and publishes received payloads to one or more notification services, including | ||
support for notifying more than one distinct service for the same message. | ||
mqttwarn is a highly configurable MQTT message router, where the routing | ||
targets are notification plugins, primarily written in Python. | ||
|
||
For example, you may wish to notify via e-mail and to Pushover of an alarm | ||
published as text to the MQTT topic home/monitoring/+. | ||
mqttwarn subscribes to any number of MQTT topics and publishes received | ||
payloads to one or more notification services after optionally applying | ||
sophisticated transformations. | ||
|
||
It comes with over 70 notification handler plugins covering a wide range | ||
of notification services, and has an adapter for the Apprise notification | ||
library, covering another set of 80+ notification services. | ||
|
||
Repository: https://github.com/jpmens/mqttwarn | ||
Documentation: https://mqttwarn.readthedocs.io/ |