Skip to main content

HiveMQtt.Sparkplug (Beta)

The Sparkplug client extension for .NET built on top of HiveMQtt. Use it to build both Sparkplug Host Applications and Edge Nodes with the Eclipse Sparkplug B 3.0 topic and payload model.

Beta Feature

HiveMQtt.Sparkplug is currently in beta. While fully functional, APIs may evolve in upcoming releases as the package matures.

Quick Start

Install the package and jump into examples:

dotnet add package HiveMQtt.Sparkplug

Then continue with the Sparkplug Quickstart.

Installation & Compatibility​

FeatureDetails
NuGet PackageHiveMQtt.Sparkplug
Depends OnHiveMQtt
Sparkplug VersionSparkplug B 3.0
.NET Support.NET 6.0, 7.0, 8.0, 9.0 and 10.0
StatusBeta

What You Can Build​

  • Host Applications: Subscribe to Sparkplug topics, track Edge Node and Device lifecycle events, and publish NCMD/DCMD commands.
  • Edge Nodes: Publish NBIRTH/NDATA/NDEATH and DBIRTH/DDATA/DDEATH, process NCMD/DCMD, and maintain Sparkplug lifecycle state.
  • Payload Workflows: Encode/decode Sparkplug protobuf payloads and create metrics with SparkplugMetricBuilder.

Client Separation​

This repository has two client tracks:

Next Steps​