C# と .NET 新機能

.NET 向け C# OPC UA クライアントライブラリ

署名と暗号化が施された opc.tcp 接続を通じて、C# から PLC、SCADA システム、ゲートウェイの OPC UA サーバーのブラウズ、読み取り、書き込み、サブスクライブができます。

opc.tcp 上の OPC UA バイナリ
Aes256_Sha256_RsaPss までの Sign と SignAndEncrypt
データ変更とイベントのサブスクリプション
匿名、ユーザー名、X.509 の ID

sgcWebSockets Enterprise (Delphi と .NET) および All-Access、または単体の sgcIndustrial パックに含まれています。

C# で読み取りとサブスクライブ → · OPC UA のよくある質問 →

C# OPC UA クライアント
using System;
using esegece.sgcWebSockets;

var opcua = new TsgcOPCUAClient();
opcua.EndpointUrl = "opc.tcp://192.168.1.60:4840";
opcua.Connect();
Console.WriteLine(opcua.ReadValue("ns=2;s=Line1.Temperature"));
opcua.WriteValue("ns=2;s=Line1.Setpoint", 75.5);
opcua.Disconnect();

.NET アプリケーション向けの OPC UA クライアント

セキュアチャネル、セッション、サービス、サブスクリプションを、Delphi コンポーネントと同じ API を持つ 1 つのクラスにまとめています。

sgcWebSockets .NET の C# OPC UA クライアントは TsgcOPCUAClient で、esegece.sgcIndustrial パッケージ、名前空間 esegece.sgcWebSockets に含まれています。EndpointUrl を設定し、SecurityPolicy と SecurityMode を選択して Connect を呼び出し、ns=2;s=Line1.Speed のようなノード ID を使って操作します。ReadValue は値を通常の .NET オブジェクト (型付き配列、マトリックスは double[,]) として返し、WriteValue は最初にノードのデータ型を読み取るため、値はサーバーが期待するとおりにエンコードされます。

すべてのサービス呼び出しは同期で、失敗すると、OPC UA ステータスコードを保持する StatusCode を持つ EsgcOPCUAError がスローされます。サブスクリプションは、データ変更とイベントを OnDataChange と OnEvent を通じてハンドラにプッシュします。パッケージは .NET 8、.NET 9、.NET 10、.NET Standard 2.0 を対象としています。

サービス

GetEndpoints、Browse、BrowseNext、TranslateBrowsePath、Read、Write、Call。

サブスクリプション

デッドバンドとキューサイズを指定できるデータ変更項目と、select 句と where 句を指定できるイベント項目。

セキュリティ

Sign または SignAndEncrypt モードの Basic256Sha256、Aes128_Sha256_RsaOaep、Aes256_Sha256_RsaPss。

ID

匿名、ユーザー名とパスワード、または X.509 ユーザー証明書。

C# での OPC UA をステップごとに解説

esegece.sgcIndustrial パッケージを参照し、接続してから、読み取り、ブラウズ、サブスクライブを行います。このページのすべてのサンプルは .NET 8 に対してコンパイルできます。

using System;
using esegece.sgcWebSockets;

var opcua = new TsgcOPCUAClient();
opcua.EndpointUrl = "opc.tcp://192.168.1.60:4840";
opcua.Connect();
try
{
    Console.WriteLine("Speed: " + opcua.ReadValue("ns=2;s=Line1.Speed"));
    // write with an explicit built-in type
    opcua.WriteValue("ns=2;s=Line1.Mode", (ushort)2, TsgcOPCUABuiltInType.uabtUInt16);
}
catch (EsgcOPCUAError e)
{
    Console.WriteLine($"Status 0x{e.StatusCode:X8}: {e.Message}");
}
finally
{
    opcua.Disconnect();
}
using System;
using esegece.sgcWebSockets;
using static esegece.sgcWebSockets.sgcOPCUA_Types;

var opcua = new TsgcOPCUAClient();
opcua.EndpointUrl = "opc.tcp://192.168.1.60:4840";
opcua.Connect();
// i=85 is the Objects folder
foreach (TsgcOPCUAReferenceDescription item in opcua.Browse("i=85"))
    Console.WriteLine(item.DisplayName.Text + " = " + sgcOPCUANodeIdToString(item.NodeId.NodeId));
// resolve a browse path to a node id
TsgcOPCUANodeId speed = opcua.TranslateBrowsePath("i=85", "/2:Line1/2:Speed");
Console.WriteLine(sgcOPCUANodeIdToString(speed));
// call a method with two Int32 arguments
TsgcOPCUAVariant[] outputs = opcua.Call("ns=2;s=Methods", "ns=2;s=Methods.Add", new[] {
    sgcOPCUAVariantSimple(TsgcOPCUABuiltInType.uabtInt32, 2),
    sgcOPCUAVariantSimple(TsgcOPCUABuiltInType.uabtInt32, 3) });
Console.WriteLine("Result: " + outputs[0].Value);
opcua.Disconnect();
using System;
using esegece.sgcWebSockets;
using static esegece.sgcWebSockets.sgcOPCUA_Encoding;

class LineMonitor
{
    public void Start(TsgcOPCUAClient aClient)
    {
        aClient.OnDataChange += OnOPCUADataChange;
        aClient.OnEvent += OnOPCUAEvent;
        TsgcOPCUASubscription subscription = aClient.CreateSubscription(500);
        // report changes larger than 0.5 only
        aClient.AddMonitoredItem(subscription, "ns=2;s=Line1.Temperature", 250, 1, true,
            TsgcOPCUADeadbandType.uadbtAbsolute, 0.5);
        // i=2253 is the Server object, which reports the events of the whole server
        aClient.AddEventMonitoredItem(subscription, "i=2253", new[] { "Message", "Severity", "SourceName" });
    }

    void OnOPCUADataChange(object Sender, TsgcOPCUASubscription aSubscription,
        TsgcOPCUAMonitoredItem aMonitoredItem, TsgcOPCUADataValue aValue)
    {
        Console.WriteLine("Temperature: " + aValue.Value.Value);
    }

    void OnOPCUAEvent(object Sender, TsgcOPCUASubscription aSubscription,
        TsgcOPCUAMonitoredItem aMonitoredItem, TsgcOPCUAVariant[] aEventFields)
    {
        // the fields arrive in the order of the select clauses
        Console.WriteLine(sgcOPCUAVariantToValue(aEventFields[2]) + " (" +
            sgcOPCUAVariantToValue(aEventFields[1]) + "): " + sgcOPCUAVariantToValue(aEventFields[0]));
    }
}
using System.IO;
using System.Linq;
using esegece.sgcWebSockets;

class SecureLine
{
    // DER bytes of the server certificate you trust
    readonly byte[] FTrusted = File.ReadAllBytes(@"C:\pki\trusted\server.der");

    public TsgcOPCUAClient Connect()
    {
        var opcua = new TsgcOPCUAClient();
        opcua.EndpointUrl = "opc.tcp://192.168.1.60:4840";
        opcua.SecurityPolicy = TsgcOPCUASecurityPolicy.opcspAes256_Sha256_RsaPss;
        opcua.SecurityMode = TsgcOPCUAMessageSecurityMode.opcsmSignAndEncrypt;
        // no certificate files set: the application certificate is created in memory
        // X.509 user identity
        opcua.Authentication.AuthenticationType = TsgcOPCUAAuthenticationType.opcatCertificate;
        opcua.Authentication.CertificateFile = @"C:\pki\user\operator.der";
        opcua.Authentication.PrivateKeyFile = @"C:\pki\user\operator.pem";
        opcua.OnValidateServerCertificate += OnOPCUAValidateServerCertificate;
        opcua.WatchDog.Enabled = true;   // reconnect after a network drop
        opcua.Connect();
        return opcua;
    }

    void OnOPCUAValidateServerCertificate(object Sender, byte[] aCertificate, ref bool aAccept)
    {
        aAccept = aCertificate != null && aCertificate.SequenceEqual(FTrusted);
    }
}

サービス呼び出しは同期です。WinForms、WPF、ASP.NET アプリケーションでは、ワーカースレッドまたは Task.Run の内部から呼び出してください。サブスクリプションのイベントは NotifyEvents を通じて発生し、UI スレッドがあればそのスレッドで、なければスレッドプール上で順番に発生します。

対応している OPC UA サービス

シンプルなオーバーロードはノード ID 文字列を受け取り、フルオーバーロードは仕様のリクエストクラスを受け取ります。

サービスセットサービスC# メソッド
DiscoveryGetEndpointsGetEndpoints
ViewBrowse, BrowseNextBrowse, BrowseNext
ViewTranslateBrowsePathsToNodeIdsTranslateBrowsePath
AttributeReadRead, ReadValue
AttributeWriteWrite, WriteValue
メソッドCallCall
SubscriptionCreateSubscription, DeleteSubscriptions, SetPublishingModeCreateSubscription, DeleteSubscription, SetPublishingMode
MonitoredItemCreateMonitoredItems, ModifyMonitoredItems, DeleteMonitoredItemsAddMonitoredItem, AddEventMonitoredItem, ModifyMonitoredItem, RemoveMonitoredItem
SubscriptionPublish, Republish, TransferSubscriptionsクライアントが自動で処理: OnDataChange、OnEvent、OnKeepAlive、WatchDog

本番運用向けに作られた OPC UA クライアント

パブリッシュループを自動処理

クライアントは十分な数の Publish リクエストを送信中に保ち、すべての通知を確認応答し、欠落したメッセージの再パブリッシュをサーバーに要求し、重複を破棄するため、ハンドラは各値を 1 回だけ受け取ります。

デッドバンドとキュー

AddMonitoredItem は、ノードごとにサンプリング間隔、キューサイズ、絶対またはパーセントのデッドバンドを設定します。ModifyMonitoredItem で後から変更でき、SetPublishingMode でサブスクリプションを一時停止できます。

イベントとアラーム

AddEventMonitoredItem は、Message、Severity、SourceName など選択したイベントフィールドを返し、任意の where 句でフィルタリングできます。

証明書

アプリケーション証明書は DER または PEM ファイルから読み込まれるか、最初の接続時に作成して保存されるか、メモリ上に作成されます。サーバー証明書は OnValidateServerCertificate が受け入れない限り拒否されます。

自動再接続

ネットワークが切断されると、WatchDog はまず同じセッションを再アクティブ化し、取りこぼした通知を再パブリッシュします。セッションが失われている場合は新しいセッションを開き、サブスクリプションを転送または再作成します。OnReconnect はどの経路が使われたかを通知し、サブスクリプションオブジェクトは有効なままです。

Delphi と同じ API

クラス、プロパティ、メソッド、イベントの名前は Delphi および C++Builder のコンポーネントと一致するため、チームは両方のプラットフォームで 1 つの設計を共有できます。

sgcWebSockets Enterprise に含まれます

OPC UA クライアントは、シリアルポートや Modbus のコンポーネントと並ぶ esegece.sgcIndustrial パッケージとして、sgcWebSockets Enterprise (Delphi および .NET) と All-Access に含まれています。エディションの比較は、価格ページ (.NET タブ) または .NET 機能比較表をご覧ください。

独立したオープンソースの OPC UA 実装である asyncua で構築されたリファレンスサーバーに対してテストされています。11 すべてのエンドポイント (すべてのポリシーとモード)、3 種類の ID タイプ、継続ポイントを使ったブラウズ、配列とマトリックスを含む 18 の組み込み型の読み取り、メソッド呼び出し、デッドバンドとイベントのサブスクリプション、メッセージの欠落も重複もない 2 分間のパブリッシュ実行が対象です。

C# OPC UA に関するよくある質問

TsgcOPCUAClient を作成し、EndpointUrl を設定し、Connect() を呼び出してから ReadValue("ns=2;s=Line1.Speed") を呼び出します。値の .NET 型を持つ object が返されます。Read は複数のノードと属性を 1 回の呼び出しで読み取ります。

パブリッシング間隔を指定して CreateSubscription を呼び出し、AddMonitoredItem でノードを追加し、OnDataChange を処理します。各項目にデッドバンドを設定すると、小さな変化がハンドラに届かなくなります。

Sign または SignAndEncrypt モードの Basic256Sha256、Aes128_Sha256_RsaOaep、Aes256_Sha256_RsaPss に加え、古いサーバー向けの非推奨の Basic128Rsa15 と Basic256、テスト環境向けの None に対応しています。

OnValidateServerCertificate を処理し、信頼する証明書に対してのみ aAccept を true に設定します。たとえば、保存しておいたコピーと DER バイトを比較します。ハンドラがない場合、テスト用に AutoAcceptServerCertificate を設定していない限り、セキュアな接続はすべて拒否されます。

クライアントは OnError と OnDisconnect を発生させます。WatchDog.Enabled = true の場合、その後 WatchDog.Interval 秒ごとに再試行します (既定は 10 秒、WatchDog.Attempts が 0 の場合は無制限)。サーバーにセッションが残っていれば同じセッションを再アクティブ化し、そうでなければ新しいセッションを開いてサブスクリプションを転送または再作成します。OnReconnect はどの経路が使われたかを通知し、サブスクリプションオブジェクトは有効なままです。

esegece.sgcIndustrial パッケージは .NET 8、.NET 9、.NET 10、.NET Standard 2.0 を対象としているため、.NET Framework 4.8 でも動作します。

OPC UA クライアントは、sgcWebSockets Enterprise (Delphi および .NET) と All-Access、または単体の sgcIndustrial パックに含まれています。OPC UA サーバー、HTTPS・JSON・WebSocket トランスポート、HistoryRead、PubSub、Reverse Connect、Global Discovery Server は含まれません。

sgcWebSockets .NET についてさらに詳しく

産業用コンポーネント

シリアルポート、Modbus、OPC UA と、完全なコンポーネントリファレンス。

C# Modbus TCP・RTU

OPC UA サーバーの隣にあるデバイス向けの Modbus クライアントとサーバー。

C# MQTT クライアント

同じアプリケーションから、OPC UA のデータ変更を MQTT ブローカーに転送します。

Delphi と C++Builder にも対応

同じクラス名とメソッド名、同じ WatchDog 再接続を備えた同じ OPC UA クライアント。

最もお得な選択: All-AccesseSeGeCe の全製品にプレミアムサポートが付いて、年間 €1,059 からご利用いただけます。
All-Access の価格を見る

C# で最初の OPC UA ノードを読む

sgcWebSockets Enterprise (Delphi と .NET) および All-Access、または単体の sgcIndustrial パックに含まれています。