Skip to content

Commit

Permalink
sysutils/py-mqttwarn: Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
amotl committed May 4, 2023
1 parent 896a256 commit b2fdc16
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 6 deletions.
4 changes: 3 additions & 1 deletion sysutils/py-mqttwarn/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ PKGNAMEPREFIX= ${PYTHON_PKGNAMEPREFIX}

MAINTAINER= dvl@FreeBSD.org
COMMENT= Subscribe to MQTT topics and notify pluggable services
WWW= https://github.com/jpmens/mqttwarn
WWW= https://mqttwarn.readthedocs.io/
https://github.com/jpmens/mqttwarn
https://pypi.org/project/mqttwarn/

LICENSE= EPL

Expand Down
17 changes: 12 additions & 5 deletions sysutils/py-mqttwarn/pkg-descr
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/

0 comments on commit b2fdc16

Please sign in to comment.