Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sysutils/py-mqttwarn: Update documentation #175

Closed
wants to merge 2 commits into from
Closed

sysutils/py-mqttwarn: Update documentation #175

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b2fdc16
sysutils/py-mqttwarn: Update documentation
amotl Apr 29, 2023
1e3933d
sysutils/py-mqttwarn: Fix variable typo in Makefile
amotl Apr 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions sysutils/py-mqttwarn/Makefile
View file
Open in desktop
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 Expand Up @@ -36,7 +38,7 @@ NO_ARCH= yes
# The following were omitted because their dependencies are not found in the
# FreeBSD port tree: AMQP APPRISE ASTERISK FBCHAT IOHUB NMA NSCA OSXNOTIFY PASTEBINPUB PROWL PUSHBULLET
# SLACK TOOTPASTE XIVELY XMPP
OPTIONS_DEFINE= APNS CELERY DNSUPDATE DOCS EXAMPLES GSS2 MYSQL POSTGRES REISPUB \
OPTIONS_DEFINE= APNS CELERY DNSUPDATE DOCS EXAMPLES GSS2 MYSQL POSTGRES REDISPUB \
RRDTOOL SERIAL SSH TWILIO TWITTER WEBSOCKET

USERS= mqttwarn
Expand All @@ -50,7 +52,7 @@ DNSUPDATE_DESC= DNS updates
GSS2_DESC= Google Docs Spreadsheet 2
MYSQL_DESC= MySQL plugin
POSTGRES_DESC= PostgreSQL Plugin
REISPUB_DESC= Publishes to a Redis channel
REDISPUB_DESC= Publishes to a Redis channel
RRDTOOL_DESC= Updates a round robin database created by rrdtool
SERIAL_DESC= Serial port
SSH_DESC= ssh plugin
Expand All @@ -65,7 +67,7 @@ GSS2_RUN_DEPENDS= ${PYTHON_PKGNAMEPREFIX}gspread>=2.1.10:net/py-gspread@${PY_FLA
${PYTHON_PKGNAMEPREFIX}oauth2client>=4.1.2:security/py-oauth2client@${PY_FLAVOR}
MYSQL_USES= mysql
POSTGRES_RUN_DEPENDS= ${PYTHON_PKGNAMEPREFIX}psycopg2>=2.7.4:databases/py-psycopg2@${PY_FLAVOR}
REISPUB_RUN_DEPENDS= ${PYTHON_PKGNAMEPREFIX}redis>=2.10.6:databases/py-redis@${PY_FLAVOR}
REDISPUB_RUN_DEPENDS= ${PYTHON_PKGNAMEPREFIX}redis>=2.10.6:databases/py-redis@${PY_FLAVOR}
RRDTOOL_LIB_DEPENDS= librrd.so:databases/rrdtool
RRDTOOL_RUN_DEPENDS= rrdtool>0.1.12:databases/rrdtool
SERIAL_RUN_DEPENDS= ${PYTHON_PKGNAMEPREFIX}pyserial>3.40:comms/py-pyserial@${PY_FLAVOR}
Expand Down
17 changes: 12 additions & 5 deletions sysutils/py-mqttwarn/pkg-descr
View file
Open in desktop
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/