MQTT v5 Connector
MQTT V5 Connector connects Banalytics to MQTT 5.0 brokers. Use it when the target broker supports the modern protocol and you want the connector to use MQTT 5 session behavior while keeping the same Banalytics publishing and subscription contract as the MQTT v3 connector.
Use MQTT 5 for modern broker integrations
The v5 connector can publish bytes, subscribe through MQTT Topic Listener tasks, report connection status, and provide runtime statistics. In Banalytics workflows it behaves like the v3 connector, while speaking MQTT 5.0 to the broker.
MQTT 5.0
Choose v5 when broker documentation explicitly supports MQTT 5.0.
Session model
cleanSession maps to MQTT 5 clean-start behavior and session expiry handling.
Bridge workflows
Use it to bridge Banalytics events and commands to modern MQTT systems under your control.
Adding an MQTT v5 connector
Confirm broker compatibility
Use v5 only when the broker, gateway, or cloud service supports MQTT 5.0. Use the v3 connector for MQTT 3.1.1-only devices.
Set endpoint and client ID
Configure host, port, and a stable clientId. Reusing a v3 client ID may cause the broker to treat this connector as the same logical client.
Configure TLS or credentials
Use the same SSL, mTLS, username, and password rules as the v3 connector.
Attach tasks and actions
Use MQTTTopicListenerTask for inbound topics and MQTTSetStateAction for outbound MQTT messages.
When MQTT v5 is the right choice
Modern broker
Use v5 for brokers that advertise MQTT 5 support and are not constrained by older clients or gateways.
Persistent session workflow
Use a stable client ID and cleanSession=false when subscriptions and queued QoS messages should survive reconnects.
Clean reconnect workflow
Keep cleanSession=true when the connector should discard previous broker-side state at connect time.
clientId only when you intentionally want the broker to treat it as the same logical client.
Secured broker connections
Configuration parameters
| Parameter | Required | Description | Default |
|---|---|---|---|
MAC address | Yes | Device MAC address shown as read-only metadata. | Auto |
Title | Yes | Human-readable connector name inside Banalytics. | None |
Host | Yes | MQTT broker hostname or IP address. | localhost |
Port | Yes | MQTT broker port. Allowed range is 1-65535. | 1883 |
SSL/TLS | Yes | Enables SSL/TLS encrypted connection to the broker. | false |
mTLS authentication | Conditional | Enables mutual TLS client certificate authentication. Visible when SSL is enabled. | false |
Client keystore | Conditional | Reference to a JKS keystore that provides client certificate or trust material. Visible when SSL is enabled. | None |
Keystore Password | Conditional | Password for the selected client keystore. Visible when SSL is enabled. | None |
Username/password authentication | Conditional | Enables MQTT username/password authentication. Visible when mTLS is disabled. | false |
Client ID | Yes | Unique MQTT client identifier used by the broker for session tracking. | None |
Username | Conditional | MQTT authentication username. Visible when client authentication is enabled and mTLS is disabled. | None |
Password | Conditional | MQTT authentication password. Visible when client authentication is enabled and mTLS is disabled. | None |
Keep Alive Interval (sec) | Yes | Ping interval used to detect broken links. Allowed range is 5-600 seconds. | 60 |
Clean Session | Yes | Maps to MQTT 5 clean-start behavior and session handling. | true |
Connection Timeout (sec) | Yes | Startup connection timeout. Allowed range is 1-60 seconds. | 10 |
Operational notes
Same connector contract
MQTT v3 and v5 connectors both support publishing, subscribing, connection status, and runtime statistics in Banalytics.
Persistent sessions
With MQTT 5, persistent-session behavior depends on cleanSession and the broker's MQTT 5 session handling.
Broker compatibility first
If documentation says MQTT 3.1.1 only, use the v3 connector. If it explicitly supports MQTT 5.0, v5 is appropriate.