FB_IotMqttMessage

Wenn der TwintCAT MQTT Client (FB_IotMqttClient) in Kombination mit einer Message Queue (FB_IotMqttMessageQueue) verwendet wird, wird eine MQTT-Nachricht vom Baustein FB_IotMqttMessage repräsentiert. Ankommende Nachrichten werden von der Message Queue gesammelt und dem Anwender in Form einer solchen Bausteininstanz zur Verfügung gestellt.

Die Topic- und die Payload-Größe sowie der Parameter „Quality of Service“ der MQTT-Nachricht sind sofort am Bausteinausgang als Properties verfügbar. Das Topic selbst sowie auch das Payload kann mittels der bereitgestellten Methoden CompareTopic(), GetTopic() und GetPayload() einfach ausgewertet oder kopiert werden.

FB_IotMqttMessage 1:

Message-Payload-Formatierung

Beachten Sie, dass der Datentyp und die Formatierung des Inhalts der Sender- und Empfängerseite bekannt sein müssen, insbesondere beim Versand von Binärinformationen (Alignment) oder Strings (mit/ohne Nullterminierung).

FB_IotMqttMessage 2:

Größe einer MQTT-Nachricht

Die maximale Größe einer in der SPS zu empfangenden MQTT-Nachricht ist von der Hardware-Plattform abhängig und sollte selbst auf leistungsstärkeren/größeren Plattformen einige wenige MB nicht überschreiten.

Die maximal mögliche Größe einer Nachricht lässt sich über den Parameter cMaxSizeOfMqttMessage in der Parameterliste der Bibliothek Tc3_IotBase einstellen. Standardmäßig ist die Größe einer Nachricht auf 100 KB begrenzt.

Bei Verwendung der MQTT Message Queue allokiert diese für neue Nachrichten dynamisch neuen Speicher aus dem TwinCAT Router Speicher.

FB_IotMqttMessage 3: Eigenschaften

Name

Typ

Zugriff

Beschreibung

eQoS

TcIotMqttQos

Get

„Quality of Service“ der MQTT-Nachricht

nPayloadSize

UDINT

Get

Größe vom Payload in Bytes

nTopicSize

UINT

Get

Größe vom Topic in Bytes

FB_IotMqttMessage 4: Methoden

Name

Beschreibung

CompareTopic()

Überprüft ein angegebenes Topic mit dem Topic in der MQTT-Nachricht

GetTopic()

Liefert das Topic einer MQTT-Nachricht

GetPayload()

Liefert den Inhalt einer MQTT-Nachricht

FB_IotMqttMessage 5:

Strings im UTF-8-Format

Die hier verwendeten Variablen vom Typ STRING nutzen das UTF-8-Format. Diese STRING-Formatierung ist üblich bei IoT/MQTT-Kommunikation sowie JSON-Dokumenten.

Um Sonderzeichen und Texte verschiedenster Sprachen empfangen zu können, wird der Zeichensatz in den Bibliotheken Tc3_IotBase und Tc3_JsonXml nicht auf den typischen Zeichensatz vom Datentyp STRING beschränkt. Stattdessen wird der Unicode-Zeichensatz als UTF-8-Format in Verbindung mit dem Datentyp STRING verwendet.

Bei Verwendung des ASCII-Zeichensatzes besteht kein Unterschied zwischen der typischen Formatierung in einem STRING und der UTF-8-Formatierung eines STRING.

Weitere Informationen zum UTF-8-STRING-Format sowie vorhandenen Anzeige- und Konvertierungsmöglichkeiten finden Sie in der Dokumentation der SPS-Bibliothek Tc2_Utilities.

Voraussetzungen

Entwicklungsumgebung

Zielplattform

Einzubindende SPS-Bibliotheken

TwinCAT v3.1.4022.0

IPC oder CX (x86, x64, ARM)

Tc3_IotBase