Quick Start

deploy the node on a litmus edge device from the marketplace, point it at your mqtt broker, and confirm the data reaches your host application prerequisites litmus edge 4 0 x or later, with at least one devicehub device connected and publishing tags a litmus edge api token see create an api token https //docs litmus io/litmusedge/product features/system/access control/tokens/create api token an mqtt broker reachable from the device, and its credentials if it requires them the le sparkplug edge node on litmus central https //portal litmus io/accelerators/le sparkplug edge node?tab=downloads , where you download the image or get registry access what you provide value example what it does litmus edge api token 0iriyynzv5xjac1aupqxm4j2tzuls5pf reads devices, tags, and digital twins from the litmus edge api sparkplug group id plant1 groups edge nodes that belong together sparkplug node id line1 identifies this node inside the group mqtt broker url tcp\ //192 168 1 20 1883 where sparkplug messages are published the group and node ids become part of every topic the node publishes, so pick names your host application will recognize neither may contain / , + , or # , which are reserved in mqtt topics — the node replaces those characters, and spaces, with step 1 deploy the node in litmus edge, navigate to applications > marketplace select the default catalog click the sparkplug edge node tile, published by litmus select installation script version 2 0 1 enter a container name, then fill in litmus edge api token, sparkplug group id, sparkplug node id, and mqtt broker url add mqtt username and mqtt password if your broker requires them leave every other field at its default click close, then launch the application starts with the data volume and networking it needs already configured for the full marketplace workflow, see deploy a marketplace application https //docs litmus io/litmusedge/product features/applications/marketplace/deploy a marketplace application to run the container yourself, or to run it on a host other than the litmus edge device, see deployment # step 2 confirm the node started open the container's logs in litmus edge, under applications > containers logs are json, one object per line three messages confirm a healthy start component msg meaning nats connected the node reached litmus edge mqtt connected the node reached the broker named in the server field sparkplug birth set published birth certificates went out the devices and dbirth published fields count them if birth set published reports devices as 0, litmus edge returned no devicehub devices check that your devices exist and are enabled in devicehub step 3 verify on the broker subscribe to the sparkplug namespace from any machine that can reach the broker mosquitto sub h 192 168 1 20 t 'spbv1 0/#' f '%t' topics arrive in this order spbv1 0/plant1/nbirth/line1 — the node's birth certificate, once per session spbv1 0/plant1/dbirth/line1/\<device> — one per devicehub device and digital twin instance spbv1 0/plant1/ddata/line1/\<device> — repeating, as tag values change sparkplug payloads are protocol buffers, so a plain subscriber prints binary values use a sparkplug aware client to read metric names and values `nbirth`, one `dbirth` per device, then a stream of `ddata` means the node is publishing correctly point your host application at the same broker and it discovers the node and its devices from those birth certificates