Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Broker Connection object establishes communications with an MQTT Broker

...

General

...

...

Property

...

Description

Name

...

The name

...

of this

...

item

Enabled

...

Whether or not this broker connection is enabled.

Folder

The parent folder of this object

Connection

...

Property

Description

Host Address

The address of the MQTT broker

...

. This is either an IPv4 address or a URL resolvable by your DNS

Port

The port used by the broker, default 1883

Keep Alive (s)

The maximum time between messages to the broker while connected

...

. If the node loses communications for longer than this time the publisher will publish

...

an NDEATH message

Advanced

...

Property

...

Description

Username

The username used to

...

connect to the MQTT broker, if required.

Password

The password used to connect to the MQTT broker, if required.

Note

MQTT username and password are transmitted in clear text during connection. If you want to secure your connection then you will still need set up TLS.

Client ID

The ID that will be used to

...

identify this client when it connects to the MQTT broker. If left empty a randomly generated ID will be assigned.

Note

The Client ID MUST be unique to every connection on a broker.

Clean Session

...

Check this box to prevent subscription information

...

from being stored locally and to prevent the Client Status

...

from being stored by the Broker.

Protocol Version

The version of MQTT to be used by this broker.

TLS Settings

Link to a TLS Settings object, if required.

Info

...

Information on the installed version of this object

...