MQTT

Host Name or Ip Address

The host name or IP address of the MQTT server.

Stream Id Prefix

Specifies what prefix is used for stream Ids. The naming convention is {StreamIdPrefix}{StreamId}. An empty string means no prefix is added to the stream Ids and names. A null value defaults to ComponentId followed by a period.

Example: Mqtt1.{Topic}.{ValueField}

Default Stream Id Pattern

Specifies the default stream Id pattern to use. For example: {Topic}, {ValueField}, {DataType}.

Port

Port number of the MQTT server. Required only if Protocol is TCP.

Primary Host Id
(MQTT - Sparkplug B only)

The Id of the primary host. The adapter is considered the primary application.

Allowed value: Any string without the following characters: + # /

Protocol

The protocol used to communicate to the MQTT broker.

Available values are WS or TCP.

TLS

Determines if TLS should be used and what version.

Available values are None, TLS, TLS11, TLS12, TLS13

User Name

User name or client Id for accessing the MQTT server

Password

Password or token for accessing the MQTT server.

Note: We recommend using REST to configure the data source when the password must be specified because the adapter encrypts the password when using REST. If you do not use REST, the plain text password is stored on-disk. You cannot specify a Password without specifying a user name.

Client Id

Unique identification of the adapter component connecting to the MQTT broker.

Note: If the ClientId is null, the adapter generates a GUID.

Client Certificate Thumbprint

The thumbprint of the certificate when the MQTT broker requires a client certificate.

Client Certificate Password

(Protected) - The password to access the certificate when the MQTT broker requires a client certificate.

MQTT Version

Version of the MQTT protocol to be used.

Available values are: 3.1.0, 3.1.1, or 5.0.0

Validate Server Certificate

Enable this parameter to determine if the server certificate gets validated. If the server certificate validation is disabled, a warning is printed.

Time Zone
(Generic MQTT only)

Specifies the time zone associated with data received from the configured MQTT broker and its topics.

Use a valid time zone from the tz database list.

Note: The time zones listed in the TZ identifier column of the tz database list are used for configuration in our adapters. Examples include America/New_York, Europe/Paris, Asia/Singapore and Etc/UTC.