Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Executing the code below in the Ignition Script Console will print out the values in the MQTT Clients dataset for review:

Code Block
languagepy
print ("Number of Connected Clients: " + str(system.tag.readBlocking("[MQTT Distributor]Distributor Info/Connected Clients")[0].value))
print ("Keep Inactive Clients: " + str(system.tag.readBlocking("[MQTT Distributor]Distributor Info/Keep Inactive Clients")[0].value))
print ("Total clients that have connected since last MQTT Distributor restart: " + str(system.tag.readBlocking("[MQTT Distributor]Distributor Info/Total Clients")[0].value))

clients = system.dataset.toPyDataSet(system.tag.readBlocking("[MQTT Distributor]Distributor Info/MQTT Clients")[0].value)      
print ("MQTT Client details:")
for row in clients:
	data =   clientId = []
	data.append(["Client ID", row[0]])
    userName = 	data.append(["Username", row["Username"]])
    ipAddress =	data.append(["IP Address", row["IP Address"]]
    connected = )
	data.append(["Connected", row["Connected"]])
	data.append(["Last Connect   lastConnectTime = Time", row["Last Connect Time"]])
	data.append(["Last Disconnect   lastDisconnectTime = Time", row["Last Disconnect Time"]
    print clientId, userName, ipAddress, connected, lastConnectTime, lastDisconnectTime

Image Removed

])
	print data


Example result from the Distributor Info > MQTT

...

Clients 

Image Added

Code Block
languagepy
>>>
MT-9bfd05ba-ddbb-4263 admin 127.0.0.1 False Fri Sep 22 10:54:23 CDT 2023 Fri Sep 22 10:54:39 CDT 2023
ME-d631ab45-4466-42f0 admin 127.0.0.1 True Fri Sep 22 09:45:03 CDT 2023 None
MT-1693f8e5-014a-4609 admin  
Number of Connected Clients: 4
Keep Inactive Clients: True
Total clients that have connected since last MQTT Distributor restart: 6
MQTT Client details:
[['Client ID', u'MT-abf45d02-4c23-4489'], ['Username', u'admin'], ['IP Address', u'127.0.0.1'], ['Connected', False], Fri['Last Sep 22 10:04:20 CDT 2023Connect Time', Fri Sep 22 1016:5101:0243 CDT 2023
MT-34fb9f47-e865-4ff6 admin 127.0.0.1 False], ['Last Disconnect Time', Fri Sep 22 1016:5404:0032 CDT 2023 Fri Sep 22 10:54:22 CDT 2023
MT-5d6c76ef-9ba3-4253 admin ]]
[['Client ID', u'ME-d631ab45-4466-42f0'], ['Username', u'admin'], ['IP Address', u'127.0.0.1'], ['Connected', True], Fri['Last Sep 22 10:55:16 CDT 2023 None
MT-99a2160a-2024-4efc admin 127.0.0.1 False Connect Time', Fri Sep 22 1016:5201:3142 CDT 2023], Fri['Last SepDisconnect 22 10:52:46 CDT 2023
MT-0f0f996c-3485-4a13 admin Time', None]]
[['Client ID', u'MT-6697e6f5-35fe-471f'], ['Username', u'admin'], ['IP Address', u'127.0.0.1 False Fri Sep 22 10:54:23 CDT 2023 '], ['Connected', True], ['Last Connect Time', Fri Sep 22 1016:5404:3934 CDT 2023
MT-164d6bdb-73ad-4bd5 admin 127.0.0.1 True Fri Sep 22 10:55:16 CDT 2023 None
MT-8f7c9989-71c1-44a3 admin ], ['Last Disconnect Time', None]]
[['Client ID', u'MT-12c7ca46-e2ec-416c'], ['Username', u'admin'], ['IP Address', u'127.0.0.1'], ['Connected', False], Fri['Last SepConnect 22 10:54:40 CDT 2023 Time', Fri Sep 22 1016:5501:1443 CDT 2023
MT-6e965a20-0618-4a4b admin 127.0.0.1 False], ['Last Disconnect Time', Fri Sep 22 1016:5404:0032 CDT 2023 Fri Sep 22 10:54:22 CDT 2023
MT-f84dea1d-4679-49ae admin ]]
[['Client ID', u'MT-04edd7b9-b7ad-455d'], ['Username', u'admin'], ['IP Address', u'127.0.0.1 False Fri Sep 22 10:54:40 CDT 2023'], ['Connected', True], ['Last Connect Time', Fri Sep 22 1016:5504:1434 CDT 2023
MT-acea8aa2-8ef0-4c23 admin 127.0.0.1 False Fri Sep 22 10:53:54 CDT 2023 Fri Sep 22 10:53:58 CDT 2023
], ['Last Disconnect Time', None]]
[['Client ID', u'MT-RPC-73ecfe46-2a63-41'], ['Username', u'admin 127.0.0.1 True Fri Sep 22 10:55:15 CDT 2023 None
MT-99472916-0177-4d89 admin '], ['IP Address', u'127.0.0.1 False Fri Sep 22 10:52:47 CDT 2023 Fri Sep 22 10:53:58 CDT 2023
>>>

Example result from the Distributor Info > MQTT Clients above with Keep Inactive Clients set to False

Image Removed

Code Block
>>> 
ME-d631ab45-4466-42f0 admin 127.0.0.1 True Fri Sep 22 09:45:03 CDT 2023 None
MT-5d6c76ef-9ba3-4253 admin 127.0.0.1 True'], ['Connected', True], ['Last Connect Time', Fri Sep 22 1016:5504:1632 CDT 2023 None
MT-164d6bdb-73ad-4bd5 admin 127.0.0.1 True ], ['Last Disconnect Time', Fri Sep 22 10:55:16 CDT 2023 None
MT-RPC-73ecfe46-2a63-41 admin 127.0.0.1 True Fri Sep 22 10:55:15:04:32 CDT 2023 None]]
>>>

Additional Information on MQTT Engine and Transmission Clients

...

A second optional client, with ClientId in the format ME-LS-xxxxxxxx-xxxx-xx, is available to publish the legacy Sparkplug™ B STATE message and is disabled by default.

Tip
See How do I know how many MQTT Clients are connected from MQTT Engine for additional information


MQTT Transmission Clients

Each Sparkplug Edge Node Descriptor (which is the Group ID and Edge Node ID combination) will create an MQTT client.

...

In addition, MQTT Transmission supports an optional RPC Client, ClientId MT-RPC-xxxxxxxx-xxxx-xxxx, which is used when publishing from Ignition Python scripts. This is enabled by default.

Tip
See How do I know how many MQTT clients are connected from MQTT Transmission for additional information



Excerpt Include
CLD80:FAQ: Ignition ModulesCLD80:
FAQ: Ignition Modules
nopaneltrue

...