Boomack Plug-In MQTT

Installation

If your using the Windows MSI installer for Boomack, this plug-in is installed by default. You can however, deselect it in the setup dialog during the installation.

The Docker image also contains this plug-in.

If you are using npm for installation, you can install this plug-in with:

==| TABS |== ::| Shell / Command Line

npm i -g boomack-plugin-mqtt

==|------|==

Features

Plug-In ID: mqtt

Action Type mqtt

Sends an MQTT message.

Configuration

• connectUrl
  The URL of the MQTT broker; default: "mqtt://localhost:1883"
• username
  The username for authentication; default: null
• password
  The password for authentication; default: null
• connectTimeout
  The timeout for connection attempts in milliseconds; default: 30000
• reconnectPeriod
  The time between reconnect attempts in milliseconds; default: 1000
• keepalive
  The number of seconds between keep alive messages; default: 60
• topicPrefix
  A string to put before the topic, when sending a message; default: empty string
• topic
  A fixed topic to use for sending messages; default: null.
  When set, a topic from the action call is ignored.
• message
  Constant message data to sent with every action call; default: null.
  When set, message data from the action call is ignored.
• base64
true or false; default: false.
  Indicates that a string in message is a BASE64 encoded byte array.
• qos
  The quality of service level (0-2); default: 0
  Can be overridden by the action call.
• retain
  The retain flag for messages true or false; default: false.
  Can be overridden by the action call.

Input

The payload of an action call is expected to be either an object with the following properties, a string, or a Buffer / UInt8Array.

• topic
  A topic string. Optional.
• message
  A string or Buffer / UInt8Array or any other value.
  Can be a string for UTF-8 encoded text, a BASE64 encoded data string or an Buffer / UInt8Array for binary data, or anything else for a JSON encoded value or object.
• base64
true or false; default: false.
  Indicates that a string in message is a BASE64 encoded byte array.
• qos
  The quality of service level (0-2). Optional.
• retain
  The retain flag for messages true or false. Optional.

If no topic is specified, neither by the action configuration, nor by the action call, the topic boomack-plugin-mqtt is used.