Sparkplug is a trademark of Eclipse Foundation, Inc. "MQTT" is a trademark of the OASIS Open standards consortium. Other related terms are trademarks of their respective owners. Any use of these terms on this site is for descriptive purposes only and does not imply any sponsorship, endorsement or affiliation.

Introduction

The SparkplugCmd utility (free tool) is a program that allows performing various Sparkplug operations from the command line. Among other uses, it can act as

• a Sparkplug host application,
• a Sparkplug edge node.

SparkplugCmd can be used for evaluation, experiments, and testing.

SparkplugCmd is a console application, running on .NET. It is available for .NET Framework (Windows only), or .NET (Windows, Linux or macOS). The SparkplugCmd utility is provided free of charge.

Installation

If you have installed any Sparkplug product from the Connectivity Software suite using its Setup program, and have not excluded the Tools setup component, the SparkplugCmd utility is already installed on your computer, under the Bin subfolder of the Connectivity Software installation folder. There are also shortcuts to it from the Start menu and the Launcher program. In other cases, for stand-alone installation, and for the latest version of the tool, see Tool Downloads.

On Linux, the TGZ file can be extracted using tar -xvzf <filename>.

Technical Support

For technical support, use the corresponding category on our Online Forums.

Concepts

For concepts common to command-line utilities, see Command-Line Utilities Concepts.

Usage

In order to run the SparkplugCmd utility, open a command prompt, and switch to the directory that contains the program. You start the program and give it a command and additional parameters (options).

• If you are using the .NET Framework version, or .NET version on Windows, type SparkplugCmd, followed by the commands and options, and press Enter.
• If you are not on Windows, or are using the .NET version, type dotnet SparkplugCmd.dll, followed by the commands and options, and press Enter.

In the text that follows, when discussing the command line options, we will be listing the commands simply with the SparkplugCmd at the beginning; remember to use dotnet SparkplugCmd.dll in .NET instead.