Sparkplug Groups¶
Sparkplug Groups organize edge nodes into logical namespaces within the Sparkplug B protocol.
Screenshot placeholder: List of Sparkplug groups
What is a Sparkplug Group?¶
A Sparkplug Group (equivalent to Sparkplug B "group_id") is a logical grouping that appears in MQTT topics:
Examples:
- spBv1.0/Plant1/DDATA/Gateway01/Pump01
- spBv1.0/WaterTreatment/DBIRTH/Edge03/Tank02
Groups typically represent: - Physical locations (Plant1, Building3) - Geographic sites (Dallas, Toronto) - Departments (Production, Maintenance) - Logical systems (WaterTreatment, PowerGen)
Creating a Sparkplug Group¶
Screenshot placeholder: Add Sparkplug group form
- Navigate to MQTT → Sparkplug Groups
- Click Add Group
- Configure:
Group Settings¶
- Group Name: Descriptive name (e.g., "Plant 1")
- Group ID: Sparkplug group_id (e.g., "Plant1")
- Used in MQTT topics
- Must be unique
- No spaces or special characters
-
Alphanumeric and underscores only
-
Click Save
MQTT Topic Structure¶
Topic Format¶
All Sparkplug messages use this format:
Message Types¶
- NBIRTH: Node birth (gateway announces itself)
- NDEATH: Node death (gateway disconnection)
- DBIRTH: Device birth (device schema announcement)
- DDEATH: Device death (device disconnection)
- DDATA: Device data (tag values)
- DCMD: Device command (write to device)
- NCMD: Node command (gateway control)
Example Topics¶
Node birth:
Device data:
Device command:
Best Practices¶
Naming Conventions¶
Group IDs:
- ✅ Use meaningful names: Plant1, Dallas_Site, WaterTreatment
- ✅ Be consistent across your organization
- ❌ Avoid generic names: Group1, Test, Default
- ❌ No spaces: Use underscores instead