C# e .NET Novo

Biblioteca cliente C# OPC UA para .NET

Navegue, leia, grave e assine os servidores OPC UA de CLPs, sistemas SCADA e gateways a partir de C#, em uma conexão opc.tcp assinada e criptografada.

OPC UA binário sobre opc.tcp
Sign e SignAndEncrypt até Aes256_Sha256_RsaPss
Subscriptions de mudança de dados e de eventos
Identidades Anonymous, usuário e X.509

Incluído no sgcWebSockets Enterprise (Delphi e .NET) e All-Access, ou no pacote independente sgcIndustrial.

Leia e assine em C# → · FAQ de OPC UA →

Cliente OPC UA para C#
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();

Um cliente OPC UA para aplicações .NET

Canal seguro, sessão, serviços e subscriptions em uma única classe, com a mesma API do componente Delphi.

O cliente C# OPC UA do sgcWebSockets .NET é o TsgcOPCUAClient, parte do pacote esegece.sgcIndustrial, namespace esegece.sgcWebSockets. Defina EndpointUrl, escolha SecurityPolicy e SecurityMode, chame Connect e trabalhe com node ids como ns=2;s=Line1.Speed. ReadValue retorna o valor como um objeto .NET simples (arrays tipados, double[,] para uma matriz), e WriteValue lê primeiro o tipo de dado do nó para que o valor seja codificado como o servidor espera.

Toda chamada de serviço é síncrona e lança EsgcOPCUAError, cujo StatusCode contém o código de status OPC UA, quando falha. As subscriptions enviam mudanças de dados e eventos aos seus handlers por OnDataChange e OnEvent. O pacote tem como alvo .NET 8, .NET 9, .NET 10 e .NET Standard 2.0.

Serviços

GetEndpoints, Browse, BrowseNext, TranslateBrowsePath, Read, Write e Call.

Assinaturas

Itens de mudança de dados com deadband e tamanho de fila, itens de evento com cláusulas select e where.

Segurança

Basic256Sha256, Aes128_Sha256_RsaOaep e Aes256_Sha256_RsaPss nos modos Sign ou SignAndEncrypt.

Identidades

Anonymous, usuário e senha, ou um certificado de usuário X.509.

OPC UA em C#, passo a passo

Referencie o pacote esegece.sgcIndustrial, conecte-se e então leia, navegue ou assine. Todos os exemplos desta página compilam com .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);
    }
}

As chamadas de serviço são síncronas. Em uma aplicação WinForms, WPF ou ASP.NET, chame-as de uma thread de trabalho ou dentro de Task.Run. Os eventos de subscription são disparados por NotifyEvents: na thread de UI quando existir uma, caso contrário em ordem no thread pool.

Serviços OPC UA suportados

As sobrecargas simples recebem node ids como strings; as sobrecargas completas recebem as classes de requisição da especificação.

Conjunto de serviçosServiçoMétodo C#
DiscoveryGetEndpointsGetEndpoints
ViewBrowse, BrowseNextBrowse, BrowseNext
ViewTranslateBrowsePathsToNodeIdsTranslateBrowsePath
AttributeReadRead, ReadValue
AttributeWriteWrite, WriteValue
MétodoCallCall
SubscriptionCreateSubscription, DeleteSubscriptions, SetPublishingModeCreateSubscription, DeleteSubscription, SetPublishingMode
MonitoredItemCreateMonitoredItems, ModifyMonitoredItems, DeleteMonitoredItemsAddMonitoredItem, AddEventMonitoredItem, ModifyMonitoredItem, RemoveMonitoredItem
SubscriptionPublish, Republish, TransferSubscriptionsFeito pelo cliente: OnDataChange, OnEvent, OnKeepAlive, WatchDog

Um cliente OPC UA feito para produção

Loop de publish tratado

O cliente mantém requisições Publish suficientes em andamento, confirma cada notificação, pede ao servidor que republique uma mensagem perdida e descarta duplicatas, de modo que seus handlers vejam cada valor uma única vez.

Deadband e filas

AddMonitoredItem define o intervalo de amostragem, o tamanho da fila e um deadband absoluto ou percentual por nó. ModifyMonitoredItem os altera depois e SetPublishingMode pausa uma subscription.

Eventos e alarmes

AddEventMonitoredItem retorna os campos de evento que você seleciona, como Message, Severity e SourceName, filtrados por uma cláusula where opcional.

Certificados

O certificado da aplicação é carregado de arquivos DER ou PEM, criado e salvo na primeira conexão, ou criado em memória. Um certificado de servidor é rejeitado, a menos que OnValidateServerCertificate o aceite.

Reconexão automática

Após uma queda de rede, o WatchDog primeiro reativa a mesma sessão e republica as notificações perdidas. Se a sessão não existir mais, abre uma nova e transfere ou recria as subscriptions. OnReconnect informa qual caminho foi seguido, e seus objetos de subscription continuam válidos.

Mesma API do Delphi

Os nomes de classes, propriedades, métodos e eventos correspondem ao componente Delphi e C++Builder, de modo que uma equipe pode compartilhar um único design entre as duas plataformas.

Parte do sgcWebSockets Enterprise

O cliente OPC UA está incluído no sgcWebSockets Enterprise (Delphi e .NET) e All-Access, no pacote esegece.sgcIndustrial ao lado dos componentes de porta serial e Modbus. Compare as edições na página de preços (aba .NET) ou na matriz de recursos .NET.

Ele é testado contra um servidor de referência construído sobre o asyncua, uma implementação OPC UA open source independente: os onze endpoints (todas as políticas e modos), os três tipos de identidade, navegação com continuation points, leitura de 18 tipos built-in com arrays e uma matriz, chamadas de método, subscriptions com deadband e de eventos e uma execução de publish de dois minutos sem mensagem perdida ou duplicada.

Perguntas sobre OPC UA em C#

Crie um TsgcOPCUAClient, defina EndpointUrl, chame Connect() e depois ReadValue("ns=2;s=Line1.Speed"). Ele retorna um object com o tipo .NET do valor. Read lê vários nós e atributos em uma única chamada.

Chame CreateSubscription com o intervalo de publicação, adicione nós com AddMonitoredItem e trate OnDataChange. Um deadband em cada item mantém pequenas mudanças fora do seu handler.

Basic256Sha256, Aes128_Sha256_RsaOaep e Aes256_Sha256_RsaPss nos modos Sign ou SignAndEncrypt, além das obsoletas Basic128Rsa15 e Basic256 para servidores mais antigos, e None para bancadas de teste.

Trate OnValidateServerCertificate e defina aAccept como true apenas para os certificados em que você confia, por exemplo comparando os bytes DER com uma cópia que você salvou. Sem o handler, toda conexão segura é rejeitada, a menos que AutoAcceptServerCertificate esteja definido para testes.

O cliente dispara OnError e OnDisconnect. Com WatchDog.Enabled = true ele então tenta novamente a cada WatchDog.Interval segundos (10 por padrão, WatchDog.Attempts 0 significa sem limite). Ele reativa a mesma sessão quando o servidor ainda a mantém; caso contrário, abre uma nova sessão e transfere ou recria as subscriptions. OnReconnect informa qual caminho foi seguido, e seus objetos de subscription continuam válidos.

O pacote esegece.sgcIndustrial tem como alvo .NET 8, .NET 9, .NET 10 e .NET Standard 2.0, então também roda no .NET Framework 4.8.

O cliente OPC UA está incluído no sgcWebSockets Enterprise (Delphi e .NET) e All-Access, ou no pacote independente sgcIndustrial. Ele não inclui um servidor OPC UA, os transportes HTTPS, JSON e WebSocket, HistoryRead, PubSub, Reverse Connect e o Global Discovery Server.

Mais sobre o sgcWebSockets .NET

Componentes industriais

Porta serial, Modbus e OPC UA, com a referência completa dos componentes.

C# Modbus TCP e RTU

Clientes e servidores Modbus para os dispositivos ao lado dos seus servidores OPC UA.

Cliente MQTT para C#

Encaminhe mudanças de dados OPC UA para um broker MQTT a partir da mesma aplicação.

Também para Delphi e C++Builder

O mesmo cliente OPC UA, com os mesmos nomes de classes e métodos e a mesma reconexão via WatchDog.

Melhor custo-benefício: All-AccessTodos os produtos da eSeGeCe, com Suporte Premium incluído, a partir de €1,059/ano.
Ver preços do All-Access

Leia seu primeiro nó OPC UA a partir de C#

Incluído no sgcWebSockets Enterprise (Delphi e .NET) e All-Access, ou no pacote independente sgcIndustrial.