Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents

...

Overview

As with all adapters, an existing Logic Simulator (create link) https://unit040.atlassian.net/wiki/spaces/PUD/pages/280987237/Logic+Simulator#Overview is required.

...

Where to find the different Gateway Adapters.

...

To find the MQTT adapter, go to the Inspector window of a Logic Simulator https://unit040.atlassian.net/wiki/spaces/PUD/pages/280987237/Logic+Simulator#Overview component.
This Logic Simulator https://unit040.atlassian.net/wiki/spaces/PUD/pages/280987237/Logic+Simulator#Overview can be added under Logic.

...

Feature overview

...

Please check the documentation for the rest of the Logic Simulator (create link). https://unit040.atlassian.net/wiki/spaces/PUD/pages/280987237/Logic+Simulator#Overview

Gateway settings

Adapter Target

Select a different adapter, please see respective documentation for more information.

Adapter Setting (MQTTServerSettings)

XmlFilePath

File path to the policy file.

Note

Warning : <Make sure to fill in a relative path to the Asset folder of the project and include .xml file extension>

ServerName

Is used as the an indicator in the xml policy file.

IP Address

The address of the MQTT broker. This can be a be in IPv4 address or a hostname like localhost

Port

The port on which the MQTT broker is running,
default port is 1883.

use TLS

Should be turned on when the broker is using TLS authentication. (off by default)

Info

Default port for MQTT over TLS is 8883, please check your broker for the correct port

UserName

Is passed to the server for authentication if the field is not empty (not used by default).

PassWord

Is passed to the server for authentication when the UserName field is not empty (not used by default)

QoS

(Quality Of Server) is an agreement between broker and client that defines the guarantee of delivering a message:

0 : At most once => There is acknowledgement between broker and client other than regular TCP , fast, unreliable (packet loss))

1 : At least once => The sender buffers the value until a ‘PUBACK’ is returned by the broker. Message can be send multiple times (, slower, reliable)

2 : Exactly once => The sender sends the message, the broker returns a ‘PUBREC’. Sender is returning a ‘PUBREL’ and the server again returns a ‘PUBCOMP’ command to finalize the send process. (slow, very reliable)

Info

See below for more detail.

Lifecycle settings

Note

Not implemented for MQTT

...

QoS

known as

speed

reliability

remarks

0

fire & forget

fast

poor

Messages can get lost in unstable connections. Very suitable for wires local connection

1

single handshake

slower

good

No message is lost. Can lead to duplicate messages. but is much faster than QoS 2

2

double handshake

slowest

exact

If it is getting the message exactly once is more important than performance. Quite an overhead compared to the other 2 levels

...

How to use

Please see the Logic Simulator (create link) https://unit040.atlassian.net/wiki/spaces/PUD/pages/280987237/Logic+Simulator#Overview documentation for further instructions on setting up your simulation.

...