Using SparkplugCmd Utility as Sparkplug host application: Difference between revisions
(Created page with "Category:Sparkplug Category:SparkplugCmd Utility Category:Tools and Online Services For general information about the SparkplugCmd tool, see Category:SparkplugCmd Utility. = Commands, Arguments and Options = == Command: consumer subscribePayload == Use this command to subscribe to payload notifications from an edge node or device. The received payload are displayed in a table form. == Command: consumer subscribeMetric == Use this command to subscri...") |
No edit summary |
||
| Line 4: | Line 4: | ||
= Commands, Arguments and Options = | = Commands, Arguments and Options = | ||
== Command: consumer | == Command: '''consumer''' == | ||
The <code>consumer</code> command (shortened: <code>c</code>) contains sub-commands that allow you to consume Sparkplug data, i.e. act as a Sparkplug host application component in the Sparkplug system. | |||
== Command: consumer | == Command: '''consumer subscribePayload''' == | ||
Use | Use the <code>subscribePayload</code> command (shortened: <code>sp</code>) to subscribe to payload notifications from an edge node or device. The received payload are displayed in a table form. | ||
== Command: consumer | == Command: '''consumer subscribeMetric''' == | ||
Use | Use the <code>subscribeMetric</code> command (shortened: <code>sm</code>) to subscribe to metric notifications from an edge node or device. Each received metric notification is displayed separately (the payloads are "unpacked"). | ||
== Command: consumer | == Command: '''consumer publishMetric''' == | ||
Use | Use the <code>publishMetric</code> (shortened: <code>pm</code>) command to publish a command metric to an edge node or device. | ||
== Command: '''consumer edgeNodeRebirth''' == | |||
Use the <code>edgeNodeRebirth</code> command (shortened: <code>enr</code>) to publish a command to rebirth an edge node. | |||
Revision as of 14:45, 22 August 2025
For general information about the SparkplugCmd tool, see Category:SparkplugCmd Utility.
Commands, Arguments and Options
Command: consumer
The consumer command (shortened: c) contains sub-commands that allow you to consume Sparkplug data, i.e. act as a Sparkplug host application component in the Sparkplug system.
Command: consumer subscribePayload
Use the subscribePayload command (shortened: sp) to subscribe to payload notifications from an edge node or device. The received payload are displayed in a table form.
Command: consumer subscribeMetric
Use the subscribeMetric command (shortened: sm) to subscribe to metric notifications from an edge node or device. Each received metric notification is displayed separately (the payloads are "unpacked").
Command: consumer publishMetric
Use the publishMetric (shortened: pm) command to publish a command metric to an edge node or device.
Command: consumer edgeNodeRebirth
Use the edgeNodeRebirth command (shortened: enr) to publish a command to rebirth an edge node.