Documentation

mqtt.publish() function

mqtt.publish() is experimental and subject to change at any time.

mqtt.publish() sends data to an MQTT broker using MQTT protocol.

Function type signature
(
    broker: string,
    message: string,
    topic: string,
    ?clientid: string,
    ?password: string,
    ?qos: int,
    ?retain: bool,
    ?timeout: duration,
    ?username: string,
) => bool
For more information, see Function type signatures.

Parameters

broker

(Required) MQTT broker connection string.

topic

(Required) MQTT topic to send data to.

message

(Required) Message to send to the MQTT broker.

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.

timeout

MQTT connection timeout. Default is 1s.

Examples

Send a message to an MQTT endpoint

import "experimental/mqtt"

mqtt.publish(
    broker: "tcp://localhost:8883",
    topic: "alerts",
    message: "wake up",
    clientid: "alert-watcher",
    retain: true,
)

Send a message to an MQTT endpoint using input data

import "experimental/mqtt"
import "sampledata"

sampledata.float()
    |> map(
        fn: (r) =>
            ({r with sent:
                    mqtt.publish(
                        broker: "tcp://localhost:8883",
                        topic: "sampledata/${r.id}",
                        message: string(v: r._value),
                        clientid: "sensor-12a4",
                    ),
            }),
    )

Was this page helpful?

Thank you for your feedback!


Introducing InfluxDB Clustered

A highly available InfluxDB 3.0 cluster on your own infrastructure.

InfluxDB Clustered is a highly available InfluxDB 3.0 cluster built for high write and query workloads on your own infrastructure.

InfluxDB Clustered is currently in limited availability and is only available to a limited group of InfluxData customers. If interested in being part of the limited access group, please contact the InfluxData Sales team.

Learn more
Contact InfluxData Sales

The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following: