// This example shows how to use a function to define what happens with the value when a Sparkplug application sends data to
// a metric. This is an example of the push data consumption model.
//
// You can use any Sparkplug application, including our SparkplugCmd utility and the SparkplugApplicationConsoleDemo
// program, to subscribe to the edge node data. SparkplugCmd, or other capable Sparkplug application, can be used to write
// data into the metric.
//
// Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-ConnectivityStudio/Latest/examples.html .
// Sparkplug examples in C# on GitHub: https://github.com/OPCLabs/Examples-ConnectivityStudio-CSharp .
// Missing some example? Ask us for it on our Online Forums, https://www.opclabs.com/forum/index ! You do not have to own
// a commercial license in order to use Online Forums, and we reply to every post.
using OpcLabs.EasySparkplug;
using System;
namespace SparkplugDocExamples.EdgeNode._SparkplugMetric
{
partial class WriteValueFunction
{
static public void Main1()
{
// Note that the default port for the "mqtt" scheme is 1883.
var hostDescriptor = new SparkplugHostDescriptor("mqtt://localhost");
// Instantiate the edge node object and hook events.
var edgeNode = new EasySparkplugEdgeNode(hostDescriptor, "easyGroup", "easySparkplugDemo");
edgeNode.SystemConnectionStateChanged += (sender, eventArgs) =>
{
// Display the new connection state (such as when the connection to the broker succeeds or fails).
Console.WriteLine($"{nameof(EasySparkplugEdgeNode.SystemConnectionStateChanged)}: {eventArgs}");
};
// Create a writable metric and add a function that will be called when the metric is written to. The function
// returns a boolean that indicates whether the Write operation was successful. We have chosen to only allow
// non-negative values to be written to the metric. Note that the outcome is used internally, and is not
// available to the Sparkplug application that has sent the data to the metric.
edgeNode.Add(new SparkplugMetric("WriteToThisMetric").WriteValueFunction<int>(
value =>
{
if (value < 0)
{
Console.WriteLine($"Value rejected: {value}");
return false;
}
Console.WriteLine($"Value written: {value}");
return true; // success
}));
// Start the edge node.
Console.WriteLine("The edge node is starting...");
edgeNode.Start();
Console.WriteLine("The edge node is started.");
Console.WriteLine();
// Let the user decide when to stop.
Console.WriteLine("Press Enter to stop the edge node...");
Console.ReadLine();
// Stop the edge node.
Console.WriteLine("The edge node is stopping...");
edgeNode.Stop();
Console.WriteLine("The edge node is stopped.");
}
}
}
' This example shows how to use a function to define what happens with the value when a Sparkplug application sends data to
' a metric. This is an example of the push data consumption model.
'
' You can use any Sparkplug application, including our SparkplugCmd utility and the SparkplugApplicationConsoleDemo
' program, to subscribe to the edge node data. SparkplugCmd, or other capable Sparkplug application, can be used to write
' data into the metric.
'
' Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-ConnectivityStudio/Latest/examples.html .
' Sparkplug examples in C# on GitHub: https://github.com/OPCLabs/Examples-ConnectivityStudio-CSharp .
' Missing some example? Ask us for it on our Online Forums, https://www.opclabs.com/forum/index ! You do not have to own
' a commercial license in order to use Online Forums, and we reply to every post.
Imports OpcLabs.EasySparkplug
Namespace Global.SparkplugDocExamples.EdgeNode._SparkplugMetric
Partial Class WriteValueFunction
Public Shared Sub Main1()
' Note that the default port for the "mqtt" scheme is 1883.
Dim hostDescriptor = New SparkplugHostDescriptor("mqtt://localhost")
' Instantiate the edge node object and hook events.
Dim edgeNode = New EasySparkplugEdgeNode(hostDescriptor, "easyGroup", "easySparkplugDemo")
AddHandler edgeNode.SystemConnectionStateChanged,
Sub(sender, eventArgs)
' Display the new connection state (such as when the connection to the broker succeeds or fails).
Console.WriteLine($"{NameOf(EasySparkplugEdgeNode.SystemConnectionStateChanged)}: {eventArgs}")
End Sub
' Create a writable metric and add a function that will be called when the metric is written to. The function
' returns a boolean that indicates whether the Write operation was successful. We have chosen to only allow
' non-negative values to be written to the metric. Note that the outcome is used internally, and is not
' available to the Sparkplug application that has sent the data to the metric.
edgeNode.Add(New SparkplugMetric("WriteToThisMetric").WriteValueFunction(Of Integer)(
Function(value)
If value < 0 Then
Console.WriteLine($"Value rejected: {value}")
Return False
End If
Console.WriteLine($"Value written: {value}")
Return True ' success
End Function))
' Start the edge node.
Console.WriteLine("The edge node is starting...")
edgeNode.Start()
Console.WriteLine("The edge node is started.")
Console.WriteLine()
' Let the user decide when to stop.
Console.WriteLine("Press Enter to stop the edge node...")
Console.ReadLine()
' Stop the edge node.
Console.WriteLine("The edge node is stopping...")
edgeNode.Stop()
Console.WriteLine("The edge node is stopped.")
End Sub
End Class
End Namespace