Skip to main content
Skip table of contents

MQTT Connector: Funktionen und Operationen

Der Adapter vereint die Funktionalität des MQTT Subscribers und Publishers und ermöglicht somit Folgendes:

  • das Abonnieren eines Topics in einem MQTT-Broker

  • das Veröffentlichen von Nachrichten in einem MQTT-Broker

Eigenschaften (Properties)

Operation

Vom Adapter ausgeführte Operation

Mögliche Werte:

  • Publish: Nachricht in einem MQTT-Broker veröffentlichen

Parameter

Adapter

Adapter-Hauptklasse (nicht verändern!)

Mögliche Werte: de.softproject.x4.plugins.adapter.MqttPublishAdapter: Hauptklasse (Standard)

clientId

ID des Clients, mit dem die Nachricht veröffentlicht wird

Mögliche Werte:

Client ID

Der Parameter clientId kann auch über die Konfigurationsdatei gesetzt werden.

Beim Start des X4 Servers werden die Subscriber-Clients mit dem dazugehörigen workspace (z.B. 1) und projectName (z.B. ESBProject_1) registriert.

workspace

Dieser Parameter wird automatisch mit den in der Konfigurationsdatei enthaltenen Informationen gesetzt.

projectName

Dieser Parameter wird automatisch mit den in der Konfigurationsdatei enthaltenen Informationen gesetzt.

clientTimeout 

Wert, wie lange die Client-Verbindung erhalten bleiben soll bzw. nach welcher Zeit die Verbindung getrennt werden soll in Sekunden.

Der Parameter timeout kann auch über die Konfigurationsdatei gesetzt werden.

Mögliche Werte: Ganzzahl größer als 0

cleanSession

Legt fest, ob nach einer Session Daten gelöscht werden oder nicht.

Der Parameter cleanSession kann auch über die Konfigurationsdatei gesetzt werden.

Mögliche Werte:

  • true

  • false (Standard)

server

Protokoll, Host und Port für die Verbindung vom Client zum Broker.

Mögliche Werte:

  • tcp://hostname:port: Falls keine SSL/TLS-Verbindung verwendet wird.

  • ssl://hostname:port: Falls eine SSL/TLS-Verbindung verwendet wird.

Dieser Parameter wird nicht benötigt, wenn die clientId in der Konfigurationsdatei definiert ist oder die Werte für die clientId bereits verwendet wurden, um eine Verbindung herzustellen.

loginUsername

Username, der verwendet wird, um eine Verbindung zu einem Broker herzustellen, der Zugangsdaten verlangt.

Mögliche Werte: Beliebige Zeichenkette mit dem Benutzernamen, z. B. user

Dieser Parameter wird nicht benötigt, wenn die clientId in der Konfigurationsdatei definiert ist oder die Werte für die clientId bereits verwendet wurden, um eine Verbindung herzustellen.

loginPassword

Passwort, das verwendet wird, um eine Verbindung zu einem Broker herzustellen, der Zugangsdaten verlangt.

Mögliche Werte: Beliebige Zeichenkette mit dem Passwort, z. B. p4ssw0rd

Dieser Parameter wird nicht benötigt, wenn die clientId in der Konfigurationsdatei definiert ist oder die Werte für die clientId bereits verwendet wurden, um eine Verbindung herzustellen.

keystorePath

Pfad zum Keystore. Wenn keine SSL/TLS-Konfiguration benötigt wird, um eine Verbindung zum Broker herzustellen, dann kann der Parameterwert leer sein.

Mögliche Werte: Dateipfad

Dieser Parameter wird nicht benötigt, wenn die clientId in der Konfigurationsdatei definiert ist oder die Werte für die clientId bereits verwendet wurden, um eine Verbindung herzustellen.

keystorePassword

Passwort zum für KeystorePath angegebenen Keystore.

Mögliche Werte: Beliebige Zeichenkette

Dieser Parameter wird nicht benötigt, wenn die clientId in der Konfigurationsdatei definiert ist oder die Werte für die clientId bereits verwendet wurden, um eine Verbindung herzustellen.

Statuswerte

1

Die Operation wurde erfolgreich ausgeführt.

-1

Es gab einen Fehler während des Verbindungsaufbaus, der Trennung der Verbindung, der Veröffentlichung oder dem Abonnieren

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.