Protocols

MQTT

Characteristics

Required model node types in the Information Model

• The node after the root model node must be an Event which represent the overall message

• Variables under the Event represents the key-value pairs

• Messages can also include Lists

How to configure the MQTT Channel

1. Select the MQTT (JSON) as Channel Type.

2. Click the Configure button.

3. Select the root model node

4. Enter host and port of the MQTT Broker used.

5. Specify a path to a folder on your local machine. The temp directory inside the SMARTUNIFIER Manager can be also used.

6. Enter user name and password. If there are no credentials needed (e.g., test.mosquitto.org) make sure the fields remain empty.

7. Select the event node in the tree on the left.

8. Enable either producer or consumer depending on the use case and enter a topic name.

9. Click the Apply button.

Certificates

Encrypted connection using TLS security is supported. Follow the steps below to encrypt the connection.

1. Enable the Tls checkbox

2. Enable the Tls Configuration checkbox

• Enter the path to the CA (certificate authority) certificate of the CA that has signed the server certificate

Note

Make sure the CA certificate is valid.

3. Enable the Client checkbox

• Enter the path to the client certificate. The client certificate identifies the client just like the server certificate identifies the server.

• Enter the path to the private client key.

• If applicable enter the password

• Select the protocol from the Drop-Down.

Description of configuration properties:

Property	Description	Example
host	URL of the MQTT Broker.	test.mosquitto.org
port	Port of the MQTT Broker.	1883
reconnectInterval	Time interval to reconnect to the MQTT Broker after loss of connection in seconds	5
connectionTimeout	Time interval the connection times out in seconds	60
keepAliveInterval	Time the session persists in seconds	60
persistenceFolder	Path to a folder for the persistence store of the MQTT	temp
clientId	Identifies an MQTT client which connects to an MQTT Broker	MyClientID
username	Client username	Username
password	Client password	Password
hostnameVerification	Hostname Verification	true, false
tls	Encryption	true, false
producers	Data producer	true, false
consumer	Data consumer	true, false
protocol	TLS protocol version	TLSv1.1, TLSv1.2

OPC-UA

OPC-UA Client

1. Select OPC-UA Client as Channel Type.

2. Click the Configure button.

3. Make sure the root model node is selected to configure the OPC-UA Client

4. Enter an applicationName

5. Configure the serverTcpConfiguration

• Enter an ipAdress

• Enter the port

• Define an endpoint

• Set a requestTimeOut

6. Configure the defaultSubscriptionAttribute

• Define a publishingInterval

7. Configure monitoringParameters

• Set a samplingInterval

• Enter a queueSize

• Enable discardOldest depending on the use case

8. Assign OPC-UA data block variables to corresponding variables in the Information Model by selecting the variable in the tree

9. Assign data block

• Enable the variables checkbox

• Enter the nodeId

REST

REST Server

1. Select the root model node in the tree on the left.

2. Enter a path prefix.

3. Configure the REST Server endpoint.

• Enter the IP.

• Enter the port.

• Enter the Content-Type.

4. Check the webapp checkbox and provide the WAR-file if you want to host an application.

5. Click the Apply button and save the Channel by clicking the Save button on the upper right corner.

Description of configuration properties:

Property	Description	Example
pathPrefix	Prefix for the URL	e.g., demo
Port	Port of the REST server	e.g., 9002, 9000, ...
IP	IP address of the REST server	http://localhost
DefaultContentType	Is used to indicate the media type of the resource	application/json, application/xml
webapp	Possibility to host an application	true, false

REST Client

1. Select the root model node in the tree on the left.

2. Configuration of the REST Client

• Enter the IP.

• Enter the Default-Content type.

• Enter a timeout.

3. Click on the variable in the tree which needs a configuration.

4. Check the checkbox.

5. Variable configuration.

• Enter the URL.

• Select the HTTP method.

6. Click on the Add Header button to add headers.

7. Check the headers checkbox.

8. Configure Key-Value pair of the header.

• Enter a name.

• Enter a value.

9. Click the Apply button and save the Channel by clicking the Save button on the upper right corner.

Description of configuration properties:

Property	Description	Example
URL	URL of the REST Server.	localhost:8090
RouteModelPath	Path of a node in the Information Model. A node can be a command, an event or a variable	/Model/RestMetrics/Event/partQualityEvent
RouteUrl	URL of the exposed node .	localhost:8090
HttpMethod	HTTP method for the action performed by the Client.	GET, POST, PUT
HeaderName and Header Value	To provide server and client with additional information	Retry-After: 12
ContentType	Is used to indicate the media type of the resource.	application/json
WaitTimeoutDuration	Timeout in seconds until request is failing	10