Use the PLC-Status Topic to Verify Connection Status

4min

Notes:
You need to follow the following guidelines for topic names: Subject-Based Messaging. 
When publishing structured data such as JSON, you must convert to a byte array (string) first. To do this in a flow, you can use the json node. 
The PLC-status topic is used to verify the connection of DeviceHub devices. 
Video
<iframe width="560" height="315" src="https://www.youtube.com/embed/5weVIPyCpRI?si=6awrSV-ke7bE_V93" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
<iframe width="560" height="315" src="https://www.youtube.com/embed/5weVIPyCpRI?si=6awrSV-ke7bE_V93" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
﻿
User Scenario
You'd like to verify the connection status of a PLC to Litmus Edge from a remote location. 
Set up and Use the PLC-Status Topic
To set up and use the PLC-status topic: 
Follow the steps to Connect a Device﻿. For this user scenario, a Simulator Generator device is used. 
Navigate to DeviceHub. 
In the Generator device tile, click the Display Copy Options icon and select the PLC status topic. This will copy the PLC status topic. You will refer to this topic later on. 
Copy the PLC status topic
﻿
Navigate to Flows Manager. 
For a Flows Manager, click the Go To Flow Definition icon. 
The Flow canvas opens in a new browser tab. 
Go To Flow Definition icon
﻿
On the Flow canvas, drag the Datahub Subscribe node and debug node onto the canvas. Then, connect the two nodes. 
Nodes needed for PLC status
﻿
Double-click the DataHub Subscribe node.
The Edit DataHub Subscribe node dialog box appears.
In the Topic field, paste the PLC status topic you copied in step 3. 
If needed, configure the Datahub Subscribe connection. See the Step 3: Configure Connector Nodes section in Create a Flow﻿ to learn more. 
Click Done, and then click Deploy. 
Expand the message window beneath the flow.  
The message window
﻿
Click the Debug icon to view debug messages.
The Debug icon
﻿
Confirm the Debug node is activated. 
The activate debug button
﻿
The debug window displays a "success": true message, which means the device is successfully connected to Litmus Edge. If the device is not connected, did not respond in time, or is not properly configured in Litmus Edge, "success": false will display.  
Success true message
﻿
The rest of the payload displays the following information from the device:
Data type: The data type used to verify the PLC status. 
Value: The bit value that displays the status of the device. The value 0 means the device is on/connected. 
Device Name: The device name you configured in Litmus Edge. 
Timestamp: Date and time data for the PLC status message. 
Device ID: The device ID for the DeviceHub device generated in Litmus Edge. 
Description: The default description for the PLC status topic (Poll Register). 
﻿

Updated 23 Sep 2024

Use the Manage Topic to Stop a Device

Use the Poll-Once Topic to Manually Retrieve Register Values