nixfilter-mqtt v0.0.1

nixfilter-mqtt

A set of "filters" (non-interactive command-line tools reading from STDIN and writing to STDOUT) for publishing and subscribing to MQTT topics.

Similar to the tools mosquitto_pub and mosquitto_sub.

Installation

$ npm install -g nixfilter-mqtt

Requires Node.js.

Command-line tools

nixfilter-mqtt-publish

nixfilter-mqtt-publish publishes to a MQTT topic. Whenever a line is read from STDIN, it is being published to the MQTT topic.

$ nixfilter-mqtt-publish -h

usage: mqtt_publish.js [-h] [--host HOST] [--port PORT] [--username USERNAME]
                       [--password PASSWORD] [--client_id CLIENT_ID]
                       [--qos {0,1,2}] [--status_topic STATUS_TOPIC]
                       [--online_message ONLINE_MESSAGE]
                       [--offline_message OFFLINE_MESSAGE] [--retain]
                       publish_topic

Publish messages to a MQTT topic

Positional arguments:
  publish_topic         The MQTT topic to publish to

Optional arguments:
  -h, --help            Show this help message and exit.
  --host HOST, --broker HOST, -b HOST
                        The hostname or IP address of the MQTT broker
  --port PORT, -P PORT  The port of the MQTT broker
  --username USERNAME, -u USERNAME
                        The username to use when connecting
  --password PASSWORD, -p PASSWORD
                        The password to use when connecting
  --client_id CLIENT_ID, -c CLIENT_ID
                        The client ID to use when connecting
  --qos {0,1,2}, -q {0,1,2}
                        The QOS level to use
  --status_topic STATUS_TOPIC, -s STATUS_TOPIC
                        The (optional) MQTT topic to publish online/offline 
                        status messages to
  --online_message ONLINE_MESSAGE
                        The (retained) message to publish to the (optional) 
                        MQTT topic when going online
  --offline_message OFFLINE_MESSAGE
                        The (retained) message to publish to the (optional) 
                        MQTT topic when going offline
  --retain, -r          Send messages as "retained" messages

nixfilter-mqtt-subscribe

nixfilter-mqtt-subscribe subscribes to a MQTT topic. Whenever a messages arrives for that topic, it is being written as a line to STDOUT.

$ nixfilter-mqtt-subscribe -h

usage: nixfilter-mqtt-subscribe [-h] [--host HOST] [--port PORT]
                         [--username USERNAME] [--password PASSWORD]
                         [--client_id CLIENT_ID] [--qos {0,1,2}]
                         [--status_topic STATUS_TOPIC]
                         [--online_message ONLINE_MESSAGE]
                         [--offline_message OFFLINE_MESSAGE]
                         subscribe_topic

Subscribe to a MQTT topic and output messages published to the topic

Positional arguments:
  subscribe_topic       The MQTT topic to subscribe to

Optional arguments:
  -h, --help            Show this help message and exit.
      --host HOST, --broker HOST, -b HOST
                        The hostname or IP address of the MQTT broker
  --port PORT, -P PORT  The port of the MQTT broker
  --username USERNAME, -u USERNAME
                        The username to use when connecting
  --password PASSWORD, -p PASSWORD
                        The password to use when connecting
  --client_id CLIENT_ID, -c CLIENT_ID
                        The client ID to use when connecting
  --qos {0,1,2}, -q {0,1,2}
                        The QOS level to use
  --status_topic STATUS_TOPIC, -s STATUS_TOPIC
                        The (optional) MQTT topic to publish online/offline 
                        status messages to
  --online_message ONLINE_MESSAGE
                        The (retained) message to publish to the (optional) 
                        MQTT topic when going online
  --offline_message OFFLINE_MESSAGE
                        The (retained) message to publish to the (optional) 
                        MQTT topic when going offline