Protonest Master

Connectivity

MQTT broker

Configure the MQTT connection, security, delivery behavior, and topic routes.

On this page

Open Connectivity > MQTT broker to define where Protonest Master publishes readings. Complete Broker connection first, then configure Publish topics.

Delivery activity

The counters at the top update while the gateway runs.

CounterMeaning
SentMessages published to the broker.
FailedMessages the broker did not accept.
DroppedReadings discarded, such as while no broker is connected.
ReconnectsTimes the gateway re-established the broker connection.

Configure the broker connection

  1. Open the broker connection

    Under Configure MQTT, select Broker connection.

  2. Identify the broker and gateway

    Enter the Broker address, Port, and a unique Client ID.

  3. Configure authentication

    Choose an authentication method and provide its credentials.

  4. Secure the connection

    Keep TLS encryption enabled when the broker supports it and upload the broker's root CA certificate.

  5. Review advanced behavior

    Change the keepalive, reconnect, or timeout values only when your broker requires non-default behavior.

  6. Continue to publish topics

    Select Publish topics and complete the routing settings before saving the full MQTT configuration.

FieldWhat to enterExample
Broker addressBroker host name or IP addressmqtt.example.com
PortUsually 1883, or 8883 with TLS8883
Client IDA unique identifier for this gatewaygateway001

The example values are placeholders. Use the values issued by your broker administrator.

Authentication

Enter the broker account Username and Password. Use a broker account restricted to the gateway's required publish and control topics.

Connection defaults

SettingPurposeDefault
TLS encryptionEncrypts the broker connection; requires a root CA.On
Automatic reconnectReconnects after a dropped session.On
Keepalive (s)Interval for checking that the session is alive.60
Reconnect delay (s)Delay before another connection attempt.5
Network timeout (s)Time allowed for a broker response.10
Broker connection settings include authentication, TLS certificate files, reconnect behavior, and network timing.

Connection limits

SettingAccepted value
Broker addressRequired host name or IP address
Broker portWhole number from 1-65,535
Client IDRequired
KeepaliveWhole number from 1-255 seconds
Reconnect delayWhole number from 1-65,535 seconds
Network timeoutWhole number from 1-65,535 seconds

Certificate authentication requires TLS. TLS requires a root CA; certificate authentication additionally requires both a client certificate and private key.

Configure publish topics

  1. Open publish topics

    Under Configure MQTT, select Publish topics.

  2. Enter the base topic

    Enter a route such as protonest/gateway001/stream/master.

  3. Choose delivery quality

    Select the required Delivery quality (QoS).

  4. Review every subtopic

    Confirm or change the subtopic for each data type and check the complete-path previews.

  5. Save the configuration

    Select Save MQTT settings.

The gateway publishes each reading to base topic/subtopic. For example:

text
protonest/gateway001/stream/master/environment
DataFactory-default subtopic
Environmentenvironment
Analog inputsanalog-inputs
Thermistor probethermistor-probe
Precision probeprecision-probe
Contact inputscontact-inputs
Outputsoutputs
Modbus valuesmodbus-values

Choose a QoS level

QoSDelivery behaviorBest for
0 - at most onceSent once without confirmation; a message can be lost.Frequent telemetry where an occasional missed value is acceptable.
1 - at least onceRepeated until confirmed; duplicates can occur.Most operational telemetry.
2 - exactly onceDelivered once through the slowest handshake.Data where duplicates and losses are unacceptable.
Publish-topic settings show the base route, QoS, seven subtopics, and their complete topic previews.

Topic rules

The base topic and every subtopic are required. Each may contain at most 128 UTF-8 bytes and cannot contain spaces, control characters, a leading or trailing slash, an empty level such as //, or the + and # wildcard characters. Full-path previews show the exact publish routes before you save.