MQTT Client
uniflow.plugin.mqtt •
Category: IoT & Messaging •
Version: v1.0.7
MQTT Client Plugin Reference Manual
1. Overview
Plugin Name: MQTT Client
Type: IoT & Messaging
Identifier: uniflow.plugin.mqtt
Description
Integration with MQTT Brokers.
2. Configuration Parameters
The following configuration fields are available in the User Interface for this plugin:
| Configuration Setting | Description |
|---|---|
| Broker Host | Specifies the broker host. |
| Port | Numeric value specifying the port. |
| Client ID | Specifies the client id. |
| Keep Alive (s) | Numeric value specifying the keep alive (s). |
| Auth Mode | Specifies the auth mode. |
| Username | Specifies the username. |
| Password | Specifies the password (secure). |
| Certificate Path (.pfx) | Specifies the certificate path (.pfx). |
| Certificate Password | Specifies the certificate password (secure). |
| TLS | Toggle to enable or disable tls. |
| Clean Session | Toggle to enable or disable clean session. |
3. Exposed Routes & Data Types
The following routes are available in the Uniflow catalog for this plugin:
| Display Name | Route ID | Kind | Category | Access | Data Type |
|---|---|---|---|---|---|
| Direct Access | Direct Access | Value | System | Write | String |
| topic.Name | topic.Id | Value | topic.Category ?? Topics | access | topic.ValueType |
Route Parameters: Direct Access
This route requires the following parameters when executing commands or writes.
| Parameter Name | Display Name | Type | Required |
|---|
4. Usage Examples
Scenario A: Reading/Monitoring Data
To monitor data from MQTT Client, add the corresponding Input Node in the Rule Editor and select the desired property from the catalog. Link its output to any logical comparison or directly to an Action Node.
Scenario B: Triggering Actions
If the plugin supports writable properties or actions, use an Action Node in the Rule Editor. Configure the Target property to point to the MQTT Client action, and supply any required parameters mapping from your rule's logic.