Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Home
  • Knowledge base
  • Contact Us
  • Home
  • Connectors
  • MQTT

MQTT - Instance & item setup

How to setup a MQTT instance and item in SIA

Written by Ioannis Panteleakis

Updated at July 10th, 2023

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Installation & Technical information
    Introduction SIA Connect Standalone SIA Connect ANY-Ware Cellular & WiFi connectivity
  • Configuration in the Web UI
    Getting started with the UI Connectors Instances Items Mapping Data System Network Tools & Add-ons DigiCert IoT Trust Manager
  • Connectors
    Siemens S7 Azure IoT Ethernet/IP Mitsubishi MELSEC OPC-UA Server SQL MQTT Omron Host Link REST API Omron FINS Keyence Beckhoff TwinCAT BACnet Virtual OPC-UA Client MS SQL File M-Bus Modbus
  • Scripting & Variables
    Data formatting
  • Developers
    API documentation Shadow API
  • Tutorials & Guides
    InfluxDB AWS IoT Core - Amazon Web Services Microsoft Power BI KaaIoT Siemens S7 AVEVA Insight SIA Connect Demo Rack Grafana Azure
  • General
+ More

Table of Contents

InfoParametersInstanceInfoItem

The MQTT connector allows for connecting with an MQTT broker which can be in the local network or the internet (as long as SIA is properly configured to access it).

Info

The Connector is currently only compatible with the MQTT protocol v3.1.


Parameters

When using the MQTT Connector both the instance and item have specific parameters. These parameters are required as they are needed to establish connection with the MQTT broker and to use a specific topic to read from and write to.


Instance

The instance needs the following parameters to establish a connection to the MQTT Broker:

Parameter Description
Address (instance default) The IP address of the MQTT Broker.
Port
The port used by the specific MQTT Broker.
Username
The username used by the MQTT broker to connect to, if required.
Leave empty in case no such authentication is required.
Default: empty
Password
The password used by the MQTT broker to connect to, if required.
Leave empty in case no such authentication is required.
Default: empty
Device Id
The Device Id (or ClientId) to use when connecting to a Broker and be identified as such. Leave empty to auto-generate one.
Default: empty
Ssl Version
Certificate
Key
Server Certificate
Depending on the MQTT Broker's certificate configuration, related certificates and keys can be selected.
Please upload such certificates and keys on the Connector Setup View, to make them available to all the MQTT instances.
If none of them are selected, then no such security will be used.
Default: none


Upload certifications

Upload public/private certificates and keys by adding them as files to the MQTT Connector.‍

Device & Client ID

The Device Id reflects the MQTT Client ID. Every Instance needs a unique Client ID, otherwise the Broker will refuse the connection.

The auto-generated Client ID has the following _ separated format:
SIA_aaaaaa_bbbb-bbbb-bbb-bbb
where the first part is SIA, the second is aaaaaa which is a 6 characters randomly generated string and the last part bbbb-bbbb-bbb-bbb is the specific SIA unit UUID.



Item

The item parameter that is needed to read from/write to the different topics:

Parameter Description
Read write (instance default)
Select the type of topic to use.
Depending on the design, it is suggested to use only Read or only Write per topic, keeping the different topics independent for subscribing and publishing.
Topic
The name of the topic that will be used for reading from (subscribing) or writing to (publishing).



instance mqtt

Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • Validating data exchange between AWS IoT Core and PLC
  • Bulking multiple data items into a JSON message

0
0
Expand