設定 OPC 發行者

發行項
06/10/2019

重要

當我們更新本文時，請參閱 Azure 產業 IoT 以取得最新的內容。

您可以設定 OPC 發行者以指定：

要發佈的 OPC UA 節點資料變更。
要發佈的 OPC UA 事件。
遙測資料格式。

您可以使用組態檔或使用方法呼叫來設定 OPC 發行者。

使用組態檔

本節說明使用組態檔來設定 OPC UA 節點發佈的選項。

使用組態檔來設定發佈資料變更

若要設定要發佈的 OPC UA 節點，最簡單的方式是使用組態檔。組態檔格式記載於存放庫的 publishednodes.json 中。

組態檔語法持續在變動。 OPC 發行者仍可讀取舊格式，但在保存組態時，會將其轉換成最新格式。

下列範例說明組態檔的格式：

[
  {
    "EndpointUrl": "opc.tcp://testserver:62541/Quickstarts/ReferenceServer",
    "UseSecurity": true,
    "OpcNodes": [
      {
        "Id": "i=2258",
        "OpcSamplingInterval": 2000,
        "OpcPublishingInterval": 5000,
        "DisplayName": "Current time"
      }
    ]
  }
]

使用組態檔來設定發佈事件

若要發佈 OPC UA 事件，您可以使用與資料變更相同的組態檔。

下列範例說明如何為 SimpleEvents 伺服器所產生的事件設定發佈。可在 OPC Foundation 存放庫中找到的 SimpleEvents 伺服器為：

[
  {
    "EndpointUrl": "opc.tcp://testserver:62563/Quickstarts/SimpleEventsServer",
    "OpcEvents": [
      {
        "Id": "i=2253",
        "DisplayName": "SimpleEventServerEvents",
        "SelectClauses": [
          {
            "TypeId": "i=2041",
            "BrowsePaths": [
              "EventId"
            ]
          },
          {
            "TypeId": "i=2041",
            "BrowsePaths": [
              "Message"
            ]
          },
          {
            "TypeId": "nsu=http://opcfoundation.org/Quickstarts/SimpleEvents;i=235",
            "BrowsePaths": [
              "/2:CycleId"
            ]
          },
          {
            "TypeId": "nsu=http://opcfoundation.org/Quickstarts/SimpleEvents;i=235",
            "BrowsePaths": [
              "/2:CurrentStep"
            ]
          }
        ],
        "WhereClause": [
          {
            "Operator": "OfType",
            "Operands": [
              {
                "Literal": "ns=2;i=235"
              }
            ]
          }
        ]
      }
    ]
  }
]

使用方法呼叫

本節說明可用來設定 OPC 發行者的方法呼叫。

使用 OPC UA 方法呼叫進行設定

OPC 發行者包含可連接埠 62222 存取的 OPC UA 伺服器。如果主機名稱是 publisher，則端點 URI 為：opc.tcp://publisher:62222/UA/Publisher。

此端點會公開下列四種方法：

PublishNode
UnpublishNode
GetPublishedNodes
IoT HubDirectMethod

使用 IoT 中樞直接方法呼叫進行設定

OPC 發行者會實作下列 IoT 中樞直接方法呼叫：

PublishNodes
UnpublishNodes
UnpublishAllNodes
GetConfiguredEndpoints
GetConfiguredNodesOnEndpoint
GetDiagnosticInfo
GetDiagnosticLog
GetDiagnosticStartupLog
ExitApplication
GetInfo

方法要求和回應的 JSON 承載格式定義於 opcpublisher/HubMethodModel.cs 中。

如果您對模組呼叫未知的方法，它將會以一個字串回應，指出未實作該方法。您可以呼叫未知的方法來偵測模組。

設定驗證的使用者名稱和密碼

驗證模式可透過 IoT 中樞直接方法呼叫來設定。承載必須包含 OpcAuthenticationMode 屬性以及使用者名稱和密碼：

{
    "EndpointUrl": "<Url of the endpoint to set authentication settings>",
    "OpcAuthenticationMode": "UsernamePassword",
    "Username": "<Username>",
    "Password": "<Password>"
    ...
}

密碼會由 IoT 中樞的工作負載用戶端加密，並儲存在發行者的組態中。若要將驗證變更回匿名的，請使用具有下列承載的方法：

{
    "EndpointUrl": "<Url of the endpoint to set authentication settings>",
    "OpcAuthenticationMode": "Anonymous"
    ...
}

若未在承載中設定 OpcAuthenticationMode 屬性，組態中的驗證設定會維持不變。

設定遙測資料發佈

當 OPC 發行者收到已發佈節點中的值有所變更的通知時，它會產生 JSON 格式的訊息，並傳送至 IoT 中樞。

您可以使用組態檔來設定此 JSON 格式訊息的內容。若未使用 --tc 選項指定組態檔，將會使用與連線的處理站解決方案加速器相容的預設組態。

如果 OPC 發行者設定為以批次方式處理訊息，則訊息會以有效 JSON 陣列的形式傳送。

遙測資料衍生自下列來源：

OPC 發行者節點的組態節點
OPC 發行者收到相關通知之 OPC UA 堆疊的 MonitoredItem 物件。
傳至此通知以提供資料值變更之詳細資料的引數。

放入 JSON 格式訊息中的遙測資料，選取自這些物件的重要屬性。如果您需要更多屬性，您必須變更 OPC 發行者程式碼基底。

組態檔語法如下：

// The configuration settings file consists of two objects:
// 1) The 'Defaults' object, which defines defaults for the telemetry configuration
// 2) An array 'EndpointSpecific' of endpoint specific configuration
// Both objects are optional and if they are not specified, then publisher uses
// its internal default configuration, which generates telemetry messages compatible
// with the Microsoft Connected factory Preconfigured Solution (https://github.com/Azure/azure-iot-connected-factory).

// A JSON telemetry message for Connected factory looks like:
//  {
//      "NodeId": "i=2058",
//      "ApplicationUri": "urn:myopcserver",
//      "DisplayName": "CurrentTime",
//      "Value": {
//          "Value": "10.11.2017 14:03:17",
//          "SourceTimestamp": "2017-11-10T14:03:17Z"
//      }
//  }

// The 'Defaults' object in the sample below, are similar to what publisher is
// using as its internal default telemetry configuration.
{
    "Defaults": {
        // The first two properties ('EndpointUrl' and 'NodeId' are configuring data
        // taken from the OpcPublisher node configuration.
        "EndpointUrl": {

            // The following three properties can be used to configure the 'EndpointUrl'
            // property in the JSON message send by publisher to IoT Hub.

            // Publish controls if the property should be part of the JSON message at all.
            "Publish": false,

            // Pattern is a regular expression, which is applied to the actual value of the
            // property (here 'EndpointUrl').
            // If this key is omitted (which is the default), then no regex matching is done
            // at all, which improves performance.
            // If the key is used you need to define groups in the regular expression.
            // Publisher applies the regular expression and then concatenates all groups
            // found and use the resulting string as the value in the JSON message to
            //sent to IoT Hub.
            // This example mimics the default behaviour and defines a group,
            // which matches the conplete value:
            "Pattern": "(.*)",
            // Here some more exaples for 'Pattern' values and the generated result:
            // "Pattern": "i=(.*)"
            // defined for Defaults.NodeId.Pattern, will generate for the above sample
            // a 'NodeId' value of '2058'to be sent by publisher
            // "Pattern": "(i)=(.*)"
            // defined for Defaults.NodeId.Pattern, will generate for the above sample
            // a 'NodeId' value of 'i2058' to be sent by publisher

            // Name allows you to use a shorter string as property name in the JSON message
            // sent by publisher. By default the property name is unchanged and will be
            // here 'EndpointUrl'.
            // The 'Name' property can only be set in the 'Defaults' object to ensure
            // all messages from publisher sent to IoT Hub have a similar layout.
            "Name": "EndpointUrl"

        },
        "NodeId": {
            "Publish": true,

            // If you set Defaults.NodeId.Name to "ni", then the "NodeId" key/value pair
            // (from the above example) will change to:
            //      "ni": "i=2058",
            "Name": "NodeId"
        },

        // The MonitoredItem object is configuring the data taken from the MonitoredItem
        // OPC UA object for published nodes.
        "MonitoredItem": {

            // If you set the Defaults.MonitoredItem.Flat to 'false', then a
            // 'MonitoredItem' object will appear, which contains 'ApplicationUri'
            // and 'DisplayNode' proerties:
            //      "NodeId": "i=2058",
            //      "MonitoredItem": {
            //          "ApplicationUri": "urn:myopcserver",
            //          "DisplayName": "CurrentTime",
            //      }
            // The 'Flat' property can only be used in the 'MonitoredItem' and
            // 'Value' objects of the 'Defaults' object and will be used
            // for all JSON messages sent by publisher.
            "Flat": true,

            "ApplicationUri": {
                "Publish": true,
                "Name": "ApplicationUri"
            },
            "DisplayName": {
                "Publish": true,
                "Name": "DisplayName"
            }
        },
        // The Value object is configuring the properties taken from the event object
        // the OPC UA stack provided in the value change notification event.
        "Value": {
            // If you set the Defaults.Value.Flat to 'true', then the 'Value'
            // object will disappear completely and the 'Value' and 'SourceTimestamp'
            // members won't be nested:
            //      "DisplayName": "CurrentTime",
            //      "Value": "10.11.2017 14:03:17",
            //      "SourceTimestamp": "2017-11-10T14:03:17Z"
            // The 'Flat' property can only be used for the 'MonitoredItem' and 'Value'
            // objects of the 'Defaults' object and will be used for all
            // messages sent by publisher.
            "Flat": false,

            "Value": {
                "Publish": true,
                "Name": "Value"
            },
            "SourceTimestamp": {
                "Publish": true,
                "Name": "SourceTimestamp"
            },
            // 'StatusCode' is the 32 bit OPC UA status code
            "StatusCode": {
                "Publish": false,
                "Name": "StatusCode"
                // 'Pattern' is ignored for the 'StatusCode' value
            },
            // 'Status' is the symbolic name of 'StatusCode'
            "Status": {
                "Publish": false,
                "Name": "Status"
            }
        }
    },

    // The next object allows to configure 'Publish' and 'Pattern' for specific
    // endpoint URLs. Those will overwrite the ones specified in the 'Defaults' object
    // or the defaults used by publisher.
    // It is not allowed to specify 'Name' and 'Flat' properties in this object.
    "EndpointSpecific": [
        // The following shows how a endpoint specific configuration can look like:
        {
            // 'ForEndpointUrl' allows to configure for which OPC UA server this
            // object applies and is a required property for all objects in the
            // 'EndpointSpecific' array.
            // The value of 'ForEndpointUrl' must be an 'EndpointUrl' configured in
            // the publishednodes.json confguration file.
            "ForEndpointUrl": "opc.tcp://<your_opcua_server>:<your_opcua_server_port>/<your_opcua_server_path>",
            "EndpointUrl": {
                // We overwrite the default behaviour and publish the
                // endpoint URL in this case.
                "Publish": true,
                // We are only interested in the URL part following the 'opc.tcp://' prefix
                // and define a group matching this.
                "Pattern": "opc.tcp://(.*)"
            },
            "NodeId": {
                // We are not interested in the configured 'NodeId' value, 
                // so we do not publish it.
                "Publish": false
                // No 'Pattern' key is specified here, so the 'NodeId' value will be
                // taken as specified in the publishednodes configuration file.
            },
            "MonitoredItem": {
                "ApplicationUri": {
                    // We already publish the endpoint URL, so we do not want
                    // the ApplicationUri of the MonitoredItem to be published.
                    "Publish": false
                },
                "DisplayName": {
                    "Publish": true
                }
            },
            "Value": {
                "Value": {
                    // The value of the node is important for us, everything else we
                    // are not interested in to keep the data ingest as small as possible.
                    "Publish": true
                },
                "SourceTimestamp": {
                    "Publish": false
                },
                "StatusCode": {
                    "Publish": false
                },
                "Status": {
                    "Publish": false
                }
            }
        }
    ]
}

後續步驟

現在您已了解如何設定 OPC 發行者，建議的下一個步驟是了解如何執行 OPC 發行者。

Share via