A fast MQTT dashboard application and rule engine framework written in C for Linux, Raspberry Pi and WINDOWS.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

102 lines
3.1 KiB

.TH MQTT-LIST-TOPICS 1 04-Jan-2020 "Version 1.00" "MQTT Hyperdash"
mqtt-list-topics \- List all (retined) topics on a mqtt broker.
.B mqtt-list-topics
.RI "[ " options " ] "
mqtt-list-topics connects to a mqtt broker and listens for a
certein amount of time (default 1 second) for all topics available. A list will
pe printed to stdout.
mqtt-list-topics also performs a brief analysis on the topics content to
classify the topic into binary, string, number, and integer. This
classification is not perfect, since it is based on a single payload value only,
but it can help making automatic dashboards for MQTT-Hyperdash.
.BR \-q
Be quiet and print less debug information.
.BR \-v
Be more verbose and print debug information.
.BR \-\-broker " " \fIurl\fR
specify the broker url. By default "tcp://localhost:1883" is used.
.BR \-\-user " " \fIusername\fR
specify a username for the broker.
.BR \-\-passwd " " \fIpasswd\fR
specify a password for the broker.
.BR \-\-pattern " " \fIpattern\fR
specify a topic pattern. By default "#" is used.
.BR \-\-wait " " \fIseconds\fR
specify a time to wait/listen in seconds. By default, the time is 1 second.
.BR \-n " " \fInumber\fR
specify maximum number of mqtt-topics to collect. By default, the number is limited to 512
so that the list does not get too long. But you can specify more if needed. Expanded
pseudo-topics from JSON values do not count here.
.BR \-\-json
expand JSON properties. This is the default.
.BR \-\-nojson
do not expand JSON properties.
.BR \-\-version
shows version, program and other information and exits.
.BR \-h ", " \-\-help
print a short help and exit.
For detailed help and description of the MQTT principle take a
look at the README file coming with the package.
mqtt-list-topics --wait 0 --broker "tcp://localhost:1883"
Page was created for V.1.02
If you find a bug in the MQTT Hyperdash software, you should report it. But
first, you should make sure that it really is a bug, and that it appears in
the latest version of the MQTT-Hyperdash package that you have.
Once you have determined that a bug actually exists, mail a bug report to
kollo@users.sourceforge.net. If you have a fix, you are welcome to mail that
as well! Suggestions may be mailed to the bug tracking system.
Comments and bug reports concerning this manual page should be directed to
Markus Hoffmann <kollo@users.sourceforge.net>
Copyright (C) 2019-2020 Markus Hoffmann
This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.
mosquitto(1), mosquitto_pub(1), mosquitto_sub(1), hyperdash(1)