Sparkplug B Client
You can set up a Sparkplug B Client through DeviceHub.
Note: You can't connect the MQTT Client to the DeviceHub Industrial OT Server if they are using the same Litmus Edge instance. This includes connecting through the Flows Manager or an Integration connector. If they are using different Litmus Edge instances, they can connect.
To add the Sparkplug B Client to Device Hub:
- In Litmus Edge, navigate to DeviceHub.
Click the Connect a Device box. The Connect Device dialog box appears.
Connect a device icon- For Driver Type, select MQTT. Then, for Driver Name, select Sparkplug B Client.
- Enter a name for the client. Optionally, add a description and Client ID.
- For Broker Address, enter the broker IP address or host name.
- For Port, enter the port of the broker.
- For Namespace, enter the Sparkplug topic namespace.
Configure the client with the following options.
Select one of the following client authentication methods:
- Anonymous
- Certificate (only for SSL mode)
- Username/Password
- Username/Password & Certificate
Update the default username and password values as needed.
If you enable TLS, upload or paste the certificate in the Certificate Authority field.
If you enable trigger rebirth, our driver will always be up to date with details on all nodes and devices.
If you show these options, configure the following as needed.
- Protocol Version: Select the MQTT protocol version: v3 (3.1), v4 (3.1.1), v5 (5.0).
- Keep Alive Period: Configure the keep-alive period in seconds.
- Write Timeout: Configure the write timeout in seconds.
- Connect Timeout: Configure the connect timeout in seconds.
See the Define Optional Parameters section to learn more about additional options.
When done configuring the device, click Add Device.
To add tags from Sparkplug B MQTT broker to Litmus Edge, use the Browse Tags functionality.
- Trigger Rebirth: If you enable the rebirth trigger, it will issue a 'Node Rebirth' NCMD before browsing to obtain all node and device metrics, including aliases and details.
- Display Birth Death: If you enable display birth death, it will display birth/death topics for each device and node.
- Subscribe Wildcard: If you enable subscribe wildcard, you can subscribe to all NDATA/DDATA messages.
- Data window: Enter the duration to wait for data messages after subscribing to wildcard.
- JSON Types: If you enable JSON type it will display all result datatypes as metric objects instead of metric.value specific types.
When you Add Tags to the connected device without using the browse functionality, refer to the following tag parameters.
Once the client is connected in Litmus Edge with tags, you can connect it to an MQTT server and view the data in Litmus Edge.
Note: You can't connect the MQTT Client to the DeviceHub Industrial OT Server, if they are using the same Litmus Edge instance. If they are using different Litmus Edge instances, they can connect.