UNS Client

Jump to Section

The UNS Client allows you to connect to any MQTT broker and view the data either in JSON or Sparkplug B format. It’s a quick and easy way to visualize your UNS while you’re building it.

To use the UNS Client, choose an MQTT or Sparkplug B connection from the Connection dropdown. Optionally change the list of topics to subscribe to. By default the client subscribes to #.

HighByte UNS Client Connection Options

Once connected the UNS Client renders all MQTT message topics as a tree in the inspector pane. Topics can be expanded. When a topic with data is selected, the data is shown in the inspector pane. The UNS Client attempts to detect the message encoding and decode the message accordingly.

HighByte UNS Client Connected

The client also supports publishing MQTT messages using the publish pane. Optionally set the Quality of Service (QoS) level and Retain flag.

HighByte UNS Client - Publish Pane

The Inspector pane defaults to automatic decoding detection, but allows users to override the decoding with the options for Text, JSON, Sparkplug B and Raw.

HighByte UNS Client - Inspector Pane

The Tree toolbar has a number of options; from left to right: Disconnect, Pause, Expand All, Collapse All, Clear and Filter

  • Disconnect - disconnects the UNS Client from the broker and allows for changing which connection and what topics are used.
  • Pause - Pauses updates to allow for inspecting fast changing messages.
  • Expand All - to show all nested topics in the tree.
  • Collapse All - to hide all nested topics in the tree.
  • Clear - To remove all topics from the tree andonly populate when new data is received.
  • Filter - Filter all the topics based on a case sensitive exact match search. (eg. the topic Maine/Portland/PaperMachine_1/Motor_1 would match Motor_1 but would not match paper)

HighByte UNS Client - Tree Toolbar