Using SparkplugCmd Utility as Sparkplug Edge Node: Difference between revisions

From OPC Labs Knowledge Base
Line 5: Line 5:


The commands described here can be entered at the '''SparkplugCmd>''' prompt, or directly on the command-line invoking the SparkplugCmd utility.
The commands described here can be entered at the '''SparkplugCmd>''' prompt, or directly on the command-line invoking the SparkplugCmd utility.
== Command: '''edgeNode''' ==
=== Arguments ===
The command has following arguments:
{| class="wikitable"
|''resourceDescriptor''||                              Sparkplug broker descriptor (default mqtt://localhost/)
|-
|''groupId''||                                        Group ID (default easyGroup)
|-
|''edgeNodeId''||                                      Edge Node ID
|}


== Command: '''edgeNode start''' ==
== Command: '''edgeNode start''' ==

Revision as of 09:44, 25 August 2025

For general information about the SparkplugCmd tool, see Category:SparkplugCmd Utility.

Commands, Arguments and Options

The commands described here can be entered at the SparkplugCmd> prompt, or directly on the command-line invoking the SparkplugCmd utility.

Command: edgeNode

Arguments

The command has following arguments:

resourceDescriptor Sparkplug broker descriptor (default mqtt://localhost/)
groupId Group ID (default easyGroup)
edgeNodeId Edge Node ID


Command: edgeNode start

This command starts a Sparkplug edge node with pre-defined content (metrics on the edge node itself, and devices with further metrics on them). By default, it connects to "mqtt://localhost" (unauthenticated TCP connection, using port 1883).

Sub-commands

By default, the edge node runs until the you press X on the keyboard. Use the !wait sub-command to specify a finite duration.