Fix pn.json generation (#186)

* Fix UseSecurity * Update nugets * Update version * Add and use NodeIdTypePrefix * Fix boiler by using NodeIdTypePrefix * Fix D-GUID by using NodeIdTypePrefix * Cosmetic * Add plugin nodes helper * Fix opaque by using NodeIdTypePrefix
Azure-Samples · Nov 10, 2022 · f4ae203 · f4ae203
1 parent 48097b9
commit f4ae203
Show file tree

Hide file tree

Showing 17 changed files with 217 additions and 181 deletions.
diff --git a/src/Helpers/PluginNodesHelpers.cs b/src/Helpers/PluginNodesHelpers.cs
@@ -0,0 +1,45 @@
+
+namespace OpcPlc.Helpers;
+
+using Opc.Ua;
+using OpcPlc.PluginNodes.Models;
+using System;
+
+/// <summary>
+/// Helper class for plugin nodes.
+/// </summary>
+public class PluginNodesHelpers
+{
+    /// <summary>
+    /// Get node with correct type prefix, id, namespace, and intervals.
+    /// </summary>
+    public static NodeWithIntervals GetNodeWithIntervals(NodeId nodeId, PlcNodeManager plcNodeManager)
+    {
+        ExpandedNodeId expandedNodeId = NodeId.ToExpandedNodeId(nodeId, plcNodeManager.Server.NamespaceUris);
+
+        return new NodeWithIntervals
+        {
+            NodeId = expandedNodeId.IdType == IdType.Opaque
+                ? Convert.ToBase64String((byte[])expandedNodeId.Identifier)
+                : expandedNodeId.Identifier.ToString(),
+            NodeIdTypePrefix = GetTypePrefix(expandedNodeId.IdType),
+            Namespace = expandedNodeId.NamespaceUri,
+        };
+    }
+
+    /// <summary>
+    /// Get a single lowercase character that represents the type of the node.
+    /// </summary>
+    /// <exception cref="ArgumentOutOfRangeException"></exception>
+    private static string GetTypePrefix(IdType idType)
+    {
+        return idType switch
+        {
+            IdType.Numeric => "i",
+            IdType.String => "s",
+            IdType.Guid => "g",
+            IdType.Opaque => "b",
+            _ => throw new ArgumentOutOfRangeException(nameof(idType), idType.ToString(), message: null),
+        };
+    }
+}
diff --git a/src/Helpers/PnJsonHelper.cs b/src/Helpers/PnJsonHelper.cs
@@ -22,7 +22,7 @@ public static async Task PrintPublisherConfigJsonAsync(string pnJsonFileName, st
         sb.AppendLine(Environment.NewLine + "[");
         sb.AppendLine("  {");
         sb.AppendLine($"    \"EndpointUrl\": \"opc.tcp://{serverPath}\",");
-        sb.AppendLine("    \"UseSecurity\": false,");
+        sb.AppendLine($"    \"UseSecurity\": {(!OpcApplicationConfiguration.EnableUnsecureTransport).ToString().ToLowerInvariant()},");
         sb.AppendLine("    \"OpcNodes\": [");
 
         // Print config from plugin nodes list.
@@ -41,7 +41,7 @@ public static async Task PrintPublisherConfigJsonAsync(string pnJsonFileName, st
                     : string.Empty;
 
                 string nodeId = JsonEncodedText.Encode(node.NodeId, JavaScriptEncoder.Default).ToString();
-                sb.AppendLine($"      {{ \"Id\": \"nsu={node.Namespace};s={nodeId}\"{publishingInterval}{samplingInterval} }},");
+                sb.AppendLine($"      {{ \"Id\": \"nsu={node.Namespace};{node.NodeIdTypePrefix}={nodeId}\"{publishingInterval}{samplingInterval} }},");
             }
         }
 

diff --git a/src/PluginNodes/ComplexTypeBoilerPluginNode.cs b/src/PluginNodes/ComplexTypeBoilerPluginNode.cs
@@ -1,6 +1,7 @@
 namespace OpcPlc.PluginNodes;
 
 using Opc.Ua;
+using OpcPlc.Helpers;
 using OpcPlc.PluginNodes.Models;
 using System;
 using System.Collections.Generic;
@@ -87,14 +88,15 @@ private void AddNodes(FolderState methodsFolder)
 
         SetHeaterOffMethodProperties(ref heaterOffMethod);
 
+        // Get BoilerStatus complex type variable.
+        var children = new List<BaseInstanceState>();
+        _node.GetChildren(_plcNodeManager.SystemContext, children);
+
+        // Add to node list for creation of pn.json.
         Nodes = new List<NodeWithIntervals>
-            {
-                new NodeWithIntervals
-                {
-                    NodeId = "Boiler",
-                    Namespace = OpcPlc.Namespaces.OpcPlcBoiler,
-                },
-            };
+        {
+            PluginNodesHelpers.GetNodeWithIntervals(children[0].NodeId, _plcNodeManager),
+        };
     }
 
     /// <summary>

diff --git a/src/PluginNodes/DeterministicGuidPluginNodes.cs b/src/PluginNodes/DeterministicGuidPluginNodes.cs
@@ -73,23 +73,21 @@ private void AddNodes(FolderState folder)
         {
             Guid id = DeterministicGuid.NewGuid();
 
-            _nodes[i] = _plcNodeManager.CreateVariableNode<uint>(
-                _plcNodeManager.CreateBaseVariable(
-                    folder,
-                    path: id,
-                    name: id.ToString(),
-                    new NodeId((uint)BuiltInType.UInt32),
-                    ValueRanks.Scalar,
-                    AccessLevels.CurrentReadOrWrite,
-                    "Constantly increasing value",
-                    NamespaceType.OpcPlcApplications,
-                    defaultValue: (uint)0));
-
-            nodes.Add(new NodeWithIntervals
-            {
-                NodeId = id.ToString(),
-                Namespace = OpcPlc.Namespaces.OpcPlcApplications,
-            });
+            BaseDataVariableState variable = _plcNodeManager.CreateBaseVariable(
+                folder,
+                path: id,
+                name: id.ToString(),
+                new NodeId((uint)BuiltInType.UInt32),
+                ValueRanks.Scalar,
+                AccessLevels.CurrentReadOrWrite,
+                "Constantly increasing value",
+                NamespaceType.OpcPlcApplications,
+                defaultValue: (uint)0);
+
+            _nodes[i] = _plcNodeManager.CreateVariableNode<uint>(variable);
+
+            // Add to node list for creation of pn.json.
+            nodes.Add(PluginNodesHelpers.GetNodeWithIntervals(variable.NodeId, _plcNodeManager));
         }
 
         Nodes = nodes;

diff --git a/src/PluginNodes/DipPluginNode.cs b/src/PluginNodes/DipPluginNode.cs
@@ -1,6 +1,7 @@
 namespace OpcPlc.PluginNodes;
 
 using Opc.Ua;
+using OpcPlc.Helpers;
 using OpcPlc.PluginNodes.Models;
 using System;
 using System.Collections.Generic;
@@ -67,25 +68,23 @@ public void StopSimulation()
 
     private void AddNodes(FolderState folder)
     {
-        _node = _plcNodeManager.CreateVariableNode<double>(
-            _plcNodeManager.CreateBaseVariable(
-                folder,
-                path: "DipData",
-                name: "DipData",
-                new NodeId((uint)BuiltInType.Double),
-                ValueRanks.Scalar,
-                AccessLevels.CurrentRead,
-                "Value with random dips",
-                NamespaceType.OpcPlcApplications));
+        BaseDataVariableState variable = _plcNodeManager.CreateBaseVariable(
+            folder,
+            path: "DipData",
+            name: "DipData",
+            new NodeId((uint)BuiltInType.Double),
+            ValueRanks.Scalar,
+            AccessLevels.CurrentRead,
+            "Value with random dips",
+            NamespaceType.OpcPlcApplications);
 
+        _node = _plcNodeManager.CreateVariableNode<double>(variable);
+
+        // Add to node list for creation of pn.json.
         Nodes = new List<NodeWithIntervals>
-            {
-                new NodeWithIntervals
-                {
-                    NodeId = "DipData",
-                    Namespace = OpcPlc.Namespaces.OpcPlcApplications,
-                },
-            };
+        {
+            PluginNodesHelpers.GetNodeWithIntervals(variable.NodeId, _plcNodeManager),
+        };
     }
 
     /// <summary>

diff --git a/src/PluginNodes/LongIdPluginNode.cs b/src/PluginNodes/LongIdPluginNode.cs
@@ -1,6 +1,7 @@
 namespace OpcPlc.PluginNodes;
 
 using Opc.Ua;
+using OpcPlc.Helpers;
 using OpcPlc.PluginNodes.Models;
 using System.Collections.Generic;
 using System.Text;
@@ -65,25 +66,23 @@ private void AddNodes(FolderState folder)
             id.Append((char)(65 + (i % 26)));
         }
 
-        _node = _plcNodeManager.CreateVariableNode<uint>(
-            _plcNodeManager.CreateBaseVariable(
-                folder,
-                path: id.ToString(),
-                name: "LongId3950",
-                new NodeId((uint)BuiltInType.UInt32),
-                ValueRanks.Scalar,
-                AccessLevels.CurrentReadOrWrite,
-                "Constantly increasing value",
-                NamespaceType.OpcPlcApplications,
-                defaultValue: (uint)0));
+        BaseDataVariableState variable = _plcNodeManager.CreateBaseVariable(
+            folder,
+            path: id.ToString(),
+            name: "LongId3950",
+            new NodeId((uint)BuiltInType.UInt32),
+            ValueRanks.Scalar,
+            AccessLevels.CurrentReadOrWrite,
+            "Constantly increasing value",
+            NamespaceType.OpcPlcApplications,
+            defaultValue: (uint)0);
 
+        _node = _plcNodeManager.CreateVariableNode<uint>(variable);
+
+        // Add to node list for creation of pn.json.
         Nodes = new List<NodeWithIntervals>
-            {
-                new NodeWithIntervals
-                {
-                    NodeId = id.ToString(),
-                    Namespace = OpcPlc.Namespaces.OpcPlcApplications,
-                },
-            };
+        {
+            PluginNodesHelpers.GetNodeWithIntervals(variable.NodeId, _plcNodeManager),
+        };
     }
 }
diff --git a/src/PluginNodes/LongStringPluginNodes.cs b/src/PluginNodes/LongStringPluginNodes.cs
@@ -19,7 +19,7 @@ public class LongStringPluginNodes : IPluginNodes
     private SimulatedVariableNode<string> _longStringIdNode50;
     private SimulatedVariableNode<byte[]> _longStringIdNode100;
     private SimulatedVariableNode<byte[]> _longStringIdNode200;
-    private readonly Random _random = new Random();
+    private readonly Random _random = new();
 
     public void AddOptions(Mono.Options.OptionSet optionSet)
     {
@@ -129,27 +129,27 @@ private void AddNodes(FolderState folder)
                 initialByteArray));
 
         Nodes = new List<NodeWithIntervals>
+        {
+            new NodeWithIntervals
+            {
+                NodeId = "LongString10kB",
+                Namespace = OpcPlc.Namespaces.OpcPlcApplications,
+            },
+            new NodeWithIntervals
+            {
+                NodeId = "LongString50kB",
+                Namespace = OpcPlc.Namespaces.OpcPlcApplications,
+            },
+            new NodeWithIntervals
+            {
+                NodeId = "LongString100kB",
+                Namespace = OpcPlc.Namespaces.OpcPlcApplications,
+            },
+            new NodeWithIntervals
             {
-                new NodeWithIntervals
-                {
-                    NodeId = "LongString10kB",
-                    Namespace = OpcPlc.Namespaces.OpcPlcApplications,
-                },
-                new NodeWithIntervals
-                {
-                    NodeId = "LongString50kB",
-                    Namespace = OpcPlc.Namespaces.OpcPlcApplications,
-                },
-                new NodeWithIntervals
-                {
-                    NodeId = "LongString100kB",
-                    Namespace = OpcPlc.Namespaces.OpcPlcApplications,
-                },
-                new NodeWithIntervals
-                {
-                    NodeId = "LongString200kB",
-                    Namespace = OpcPlc.Namespaces.OpcPlcApplications,
-                },
-            };
+                NodeId = "LongString200kB",
+                Namespace = OpcPlc.Namespaces.OpcPlcApplications,
+            },
+        };
     }
 }
diff --git a/src/PluginNodes/Models/NodeWithIntervals.cs b/src/PluginNodes/Models/NodeWithIntervals.cs
@@ -3,6 +3,7 @@
 public class NodeWithIntervals
 {
     public string NodeId { get; set; }
+    public string NodeIdTypePrefix { get; set; } = "s"; // Default type is string.
     public string Namespace { get; set; }
     public uint PublishingInterval { get; set; }
     public uint SamplingInterval { get; set; }

diff --git a/src/PluginNodes/NegTrendPluginNode.cs b/src/PluginNodes/NegTrendPluginNode.cs
@@ -1,6 +1,7 @@
 namespace OpcPlc.PluginNodes;
 
 using Opc.Ua;
+using OpcPlc.Helpers;
 using OpcPlc.PluginNodes.Models;
 using System;
 using System.Collections.Generic;
@@ -69,25 +70,23 @@ public void StopSimulation()
 
     private void AddNodes(FolderState folder)
     {
-        _node = _plcNodeManager.CreateVariableNode<double>(
-            _plcNodeManager.CreateBaseVariable(
-                folder,
-                path: "NegativeTrendData",
-                name: "NegativeTrendData",
-                new NodeId((uint)BuiltInType.Double),
-                ValueRanks.Scalar,
-                AccessLevels.CurrentRead,
-                "Value with a slow negative trend",
-                NamespaceType.OpcPlcApplications));
+        BaseDataVariableState variable = _plcNodeManager.CreateBaseVariable(
+            folder,
+            path: "NegativeTrendData",
+            name: "NegativeTrendData",
+            new NodeId((uint)BuiltInType.Double),
+            ValueRanks.Scalar,
+            AccessLevels.CurrentRead,
+            "Value with a slow negative trend",
+            NamespaceType.OpcPlcApplications);
+
+        _node = _plcNodeManager.CreateVariableNode<double>(variable);
 
+        // Add to node list for creation of pn.json.
         Nodes = new List<NodeWithIntervals>
-            {
-                new NodeWithIntervals
-                {
-                    NodeId = "NegativeTrendData",
-                    Namespace = OpcPlc.Namespaces.OpcPlcApplications,
-                },
-            };
+        {
+            PluginNodesHelpers.GetNodeWithIntervals(variable.NodeId, _plcNodeManager),
+        };
     }
 
     private void AddMethods(FolderState methodsFolder)

diff --git a/src/PluginNodes/OpaquePluginNode.cs b/src/PluginNodes/OpaquePluginNode.cs
@@ -1,6 +1,7 @@
 namespace OpcPlc.PluginNodes;
 
 using Opc.Ua;
+using OpcPlc.Helpers;
 using OpcPlc.PluginNodes.Models;
 using System.Collections.Generic;
 
@@ -57,25 +58,23 @@ public void StopSimulation()
 
     private void AddNodes(FolderState folder)
     {
-        _node = _plcNodeManager.CreateVariableNode<uint>(
-            _plcNodeManager.CreateBaseVariable(
-                folder,
-                path: new byte[] { (byte)'a', (byte)'b', (byte)'c' },
-                name: "Opaque_abc",
-                new NodeId((uint)BuiltInType.UInt32),
-                ValueRanks.Scalar,
-                AccessLevels.CurrentReadOrWrite,
-                "Constantly increasing value",
-                NamespaceType.OpcPlcApplications,
-                defaultValue: (uint)0));
+        BaseDataVariableState variable = _plcNodeManager.CreateBaseVariable(
+            folder,
+            path: new byte[] { (byte)'a', (byte)'b', (byte)'c' },
+            name: "Opaque_abc",
+            new NodeId((uint)BuiltInType.UInt32),
+            ValueRanks.Scalar,
+            AccessLevels.CurrentReadOrWrite,
+            "Constantly increasing value",
+            NamespaceType.OpcPlcApplications,
+            defaultValue: (uint)0);
 
+        _node = _plcNodeManager.CreateVariableNode<uint>(variable);
+
+        // Add to node list for creation of pn.json.
         Nodes = new List<NodeWithIntervals>
-            {
-                new NodeWithIntervals
-                {
-                    NodeId = "Opaque_abc",
-                    Namespace = OpcPlc.Namespaces.OpcPlcApplications,
-                },
-            };
+        {
+            PluginNodesHelpers.GetNodeWithIntervals(variable.NodeId, _plcNodeManager),
+        };
     }
 }