mqtt.to() function

mqtt.to() outputs data from a stream of tables to an MQTT broker using MQTT protocol.

Function type signature

(
    <-tables: stream[A],
    broker: string,
    ?clientid: string,
    ?name: string,
    ?password: string,
    ?qos: int,
    ?retain: bool,
    ?tagColumns: [string],
    ?timeColumn: string,
    ?timeout: duration,
    ?topic: string,
    ?username: string,
    ?valueColumns: [string],
) => stream[B] where A: Record, B: Record

Parameters

broker

(Required) MQTT broker connection string.

topic

MQTT topic to send data to.

qos

MQTT Quality of Service (QoS) level. Values range from [0-2]. Default is 0.

retain

MQTT retain flag. Default is false.

clientid

MQTT client ID.

username

Username to send to the MQTT broker.

Username is only required if the broker requires authentication. If you provide a username, you must provide a password.

password

Password to send to the MQTT broker. Password is only required if the broker requires authentication. If you provide a password, you must provide a username.

name

Name for the MQTT message.

timeout

MQTT connection timeout. Default is 1s.

timeColumn

Column to use as time values in the output line protocol. Default is "_time".

tagColumns

Columns to use as tag sets in the output line protocol. Default is [].

valueColumns

Columns to use as field values in the output line protocol. Default is ["_value"].

tables

Input data. Default is piped-forward data (<-).

Examples

Send data to an MQTT broker

import "experimental/mqtt"
import "sampledata"

sampledata.float()
    |> mqtt.to(
        broker: "tcp://localhost:8883",
        topic: "example-topic",
        clientid: r.id,
        tagColumns: ["id"],
        valueColumns: ["_value"],
    )