Skip to main content
Version: Next

Input: mqtt

Consume events from a MQTT topic

Field Summary

Field NameTypeDescriptionDefault
addressstringThe IP address of the MQTT broker-
portintegerThe port of the MQTT broker-
filtersarray of stringsThe MQTT topic to publish to-
broker-modeboolDo not connect to an external MQTT server, instead run as a MQTT brokerfalse
topic-as-field-nameboolUse the topic as the name for the data-fieldfalse
topic-fieldfieldField to store the topic name for received events-
data-fieldfieldField to store the topic data for recevied events (as a string)-
qosintegerThe QOS level for topics (0,1,2)0
rawboolDo not quote with _raw (e.g. when data is already JSON)false
plainboolJust pass through the payload of the messagefalse

Fields

address

Type: string

The IP address of the MQTT broker

port

Type: integer

The port of the MQTT broker

filters

Type: array of strings

The MQTT topic to publish to

broker-mode

Type: bool

Default: false

Do not connect to an external MQTT server, instead run as a MQTT broker

topic-as-field-name

Type: bool

Default: false

Use the topic as the name for the data-field

topic-field

Type: field

Field to store the topic name for received events

data-field

Type: field

Field to store the topic data for recevied events (as a string)

qos

Type: integer

Default: 0
Possible Values: 0, 1, 2

The QOS level for topics (0,1,2)

raw

Type: bool

Default: false

Do not quote with _raw (e.g. when data is already JSON)

plain

Type: bool

Default: false

Just pass through the payload of the message