MQTT - Controller Tab

See also: Networking and Communications

See also: MQTT or MQTT Sparkplug

 

Topic Menu

 

MQTT Controller Tab

Select Controller tab and the following fields will be displayed. Configure all the fields.

 

General Status (16-bit)

Note: Bits 4–16 are reserved for future use.

Flag/Bit

0 State

1 State

Flag 1 (Bit 1) MQTT Main engine start failed MQTT Main engine start success
Flag 2 (Bit 2) MQTT configuration downloaded from Cscape is less than minimum size MQTT configuration OK
Flag 3 (Bit 3) MQTT license invalid MQTT license valid

 

Each Client Status (16-bit x 8 Clients)

Note the following:

  • 'x' represents client numbers 1 through 8.

  • Do not consider Flags 2–9 if TLS is not enabled.

  • Do not consider Flags 5–9 if OCS360 is not selected.

Flag/Bit

0 State

1 State

Flag 1 (Bit 1) MQTT client 'x' start failed MQTT client ‘x’ start success
Flag 2 (Bit 2) CA certificate not available / not needed CA certificate available
Flag 3 (Bit 3) Client certificate not available / not needed Client certificate available
Flag 4 (Bit 4) Client key not available / not needed Client key available
Flag 5 (Bit 5) No error Certificate for device not found
Flag 6 (Bit 6) No error Not authorized
Flag 7 (Bit 7) No error Device does not have a license or is not activated
Flag 8 (Bit 8) No error Internal server error
Flag 9 (Bit 9) No error Certificate/key format or parse error
Flag 10 (Bit 10) No error Waiting for OCS360 certificate/key data from server
Flag 11 (Bit 11) No error DNS resolve failure while connecting to broker IP
Flag 12 (Bit 12) No error TLS failure while connecting to broker IP
Flag 13 (Bit 13) No error Authentication error while connecting to broker IP
Flag 14 (Bit 14) No error Other errors while connecting to broker IP
Flag 15 (Bit 15) No error Connection refused: Authorization error (after CONACK)
Flag 16 (Bit 16) No error Connection refused: Unknown (after CONACK)

 

Total Count of Sent Messages (32-bit)

Total count of published messages. This counter resets after downloading the program from Cscape or after a power cycle.

 

Total Count of Received Messages (32-bit)

Total count of received (subscribed) messages. This counter resets after downloading the program from Cscape or after a power cycle.

 

Each Client’s Counts (80-bit × 8 Clients)

  • Count of sent messages (32-bit)

  • Count of received messages (32-bit)

  • Count of offline messages (16-bit)

These three counters are continuously updated for a maximum of 8 clients. All counters reset after downloading the program from Cscape or after a power cycle.

 

Summary

Total Used: 53 registers (848 bits)

 

Return to the Top: MQTT - Controller Tab

 

Display / Validate License

This option is either used to download the license file to the controller or it connects to licensing website to get a license, if the controller is not licensed.

 

Click on the Display/Validate License option, if the controller has not been assigned a license the below window pops up.

 

Clicking on OK the following window will be displayed, select the Obtain License option.

The Voucher Code can be obtained from Horner Tech Support. The user needs to login and apply the voucher code provided by Horner APG.

Check the Removable media for MQTTFirmware.lic file.

Return to the Top: MQTT - Controller Tab