Skip to content

MQTT user administration

With the new MQTT user administration, users can create their own MQTT clients to retrieve machine data directly from the MQTT broker and process it individually.

To create an MQTT user, select a user from the table in the Settings app and click on " MQTT user list".

Here you will see a list of existing MQTT users. These can be deleted here. A new MQTT user can also be created.

Note

The password of the MQTT user is generated during creation and is only visible once after creation. It must be saved temporarily!

With this access data, the user can then connect to the MQTT broker mqtts://DOMAIN:8883 and subscribe to the topics of the machines (e.g. MACHINE_UUID/data).

Note - MACHINE_UUID

To find out the MACHINE_UUID, you must switch to the detailed view of the machine. The UUID is then displayed in the URL of the page. It can be easily copied from here.

Topics and package definition

As a user, you can subscribe to the following topics:

Topic Description
MACHINE_UUID/data Machine measurements
MACHINE_UUID/msg Machine messages
MACHINE_UUID/alarm-rx Machine alarms

Package definition

  • v = Data, value
  • t = Timestamp
  • i = Variable name
  • c = Command
  • s = Sequence number
  • r = Result
    {                                                        
      "v":-824.74755859375,
      "t":1588934532430,
      "i":"VA.TEMP.Outside"
    }
    

Topics

Measured values

  • MACHINE_UUID/data
    {                                                       
      "v":123,
      "t":1588934532430,
      "i":"VA.TEMP.Outside"
    }
    

Messages

  • MACHINE_UUID/msg
    {                                                       
      "v":0, // 0 -> messages received, 1 -> message gone, 2 -> ACK, 3 -> heartbeat message received
      "t":1588934532430,
      "i":"MSG.VA.TEMP.Outside"
    }
    

Alarming

  • MACHINE_UUID/alarm-rx
    {
      "t": 1750921916486,
      "i": "msg.DP1.greater10",
      "v": 1 // Sent(0), Received(1), Resend Sent(2)
    }