Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Client Example In Readme File #2129

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Add Client Example In Readme File #2129

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b407b0a
add client example in readme file
RAJEEV2510 Apr 21, 2023
e9622c6
Update readme File with proper client example
RAJEEV2510 Apr 21, 2023
203bfd6
how to create simple opc client add readme in docs folder
rajeev2511 Dec 2, 2023
6d833f2
how to create simple opc client add readme in docs folder
RAJEEV2510 Dec 2, 2023
314ca55
Merge branch 'master' of https://github.com/RAJEEV2510/UA-.NETStandard
RAJEEV2510 Dec 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
249 changes: 232 additions & 17 deletions README.md
View file
Open in desktop
@@ -1,109 +1,324 @@



# Official OPC UA .NET Standard Stack from the OPC Foundation



## Overview

This OPC UA reference implementation is targeting the [.NET Standard](https://docs.microsoft.com/en-us/dotnet/standard/net-standard) specification.

.NET Standard allows to develop apps that run on all common platforms available today, including Linux, iOS, Android (via Xamarin) and Windows 7/8/8.1/10/11 (including embedded/IoT editions) without requiring platform-specific modifications.


.NET Standard allows to develop apps that run on all common platforms available today, including Linux, iOS, Android (via Xamarin) and Windows 7/8/8.1/10/11 (including embedded/IoT editions) without requiring platform-specific modifications.



One of the reference implementations inside this project has been certified for compliance through an OPC Foundation Certification Test Lab to prove its high quality. Fixes and enhancements since the certification process have been tested and verified for compliance using the latest Compliance Test Tool (CTT).



Furthermore, cloud applications and services (such as ASP.NET, DNX, Azure Websites, Azure Webjobs, Azure Nano Server and Azure Service Fabric) are also supported.



More samples based on the official [Nuget](https://www.nuget.org/packages/OPCFoundation.NetStandard.Opc.Ua/) packages can be found in the [OPC UA .NET Standard Samples](https://github.com/OPCFoundation/UA-.NETStandard-Samples) repository. For development there is also a [preview Nuget feed](https://opcfoundation.visualstudio.com/opcua-netstandard/_packaging?_a=feed&feed=opcua-preview%40Local) available. For local testing a [Docker container of the Reference Server](Docs/ContainerReferenceServer.md) is available for preview and release builds.



## For more information and license terms, see [here](http://opcfoundation.github.io/UA-.NETStandard).



### Features included



#### Core and Libraries



* Fully ported Core OPC UA Stack and Libraries (Client, Server, Configuration, Complex Types & GDS assemblies).
* Reference sample Server and Client.

* Reference sample Server and Client.

* X.509 [Certificate](Docs/Certificates.md) support for client and server authentication.
* SHA-2 support (up to SHA512) including security profile Basic256Sha256, Aes128Sha256RsaOaep and Aes256Sha256RsaPss for configurations with high security needs.

* SHA-2 support (up to SHA512) including security profile Basic256Sha256, Aes128Sha256RsaOaep and Aes256Sha256RsaPss for configurations with high security needs.

* Anonymous, username and X.509 certificate user authentication.

* UA-TCP & HTTPS transports (client and server).
* [Reverse Connect](Docs/ReverseConnect.md) for the UA-TCP transport (client and server).

* [Reverse Connect](Docs/ReverseConnect.md) for the UA-TCP transport (client and server).

* Folder & OS-level (X509Store) [Certificate Stores](Docs/Certificates.md) with *Global Discovery Server* and *Server Push* support.

* Sessions and Subscriptions.

* A [PubSub](Docs/PubSub.md) library with samples.



#### **New in 1.4.368**
* Improved support for [Logging](Docs/Logging.md) with `ILogger` and `EventSource`.

* Improved support for [Logging](Docs/Logging.md) with `ILogger` and `EventSource`.

* Support for custom certificate stores with refactored `ICertificateStore` and `CertificateStoreType` interface.

* Client and Server support for [TransferSubscriptions](Docs/TransferSubscription.md).

* How to use [Container support](Docs/ContainerReferenceServer.md) with reference server.



#### Samples and Nuget packages



* OPC UA [Reference Server](Applications/ReferenceServer) and [Reference Client](Applications/ReferenceClient) for .NET Framework.

* OPC UA [Console Reference Server](Applications/ConsoleReferenceServer) for .NET Core. A Linux Container of the latest builds is available [here](https://github.com/OPCFoundation/UA-.NETStandard/pkgs/container/uanetstandard%2Frefserver). See also [Container support](Docs/ContainerReferenceServer.md).
* The OPC UA [Reference Server](Applications/ReferenceServer/README.md) has been certified for compliance through an OPC Foundation Certification Test Lab. Fixes and enhancements since the certification process have been tested and verified for compliance using the [Compliance Test Tool (CTT)](https://opcfoundation.org/developer-tools/certification-test-tools/opc-ua-compliance-test-tool-uactt/).
All releases are verified for compliance with the latest official Compliance Test Tool by the maintainers.

* The OPC UA [Reference Server](Applications/ReferenceServer/README.md) has been certified for compliance through an OPC Foundation Certification Test Lab. Fixes and enhancements since the certification process have been tested and verified for compliance using the [Compliance Test Tool (CTT)](https://opcfoundation.org/developer-tools/certification-test-tools/opc-ua-compliance-test-tool-uactt/).

All releases are verified for compliance with the latest official Compliance Test Tool by the maintainers.

* OPC UA [Console Reference Publisher](Applications/ConsoleReferencePublisher/README.md) and [Console Reference Subscriber](Applications/ConsoleReferenceSubscriber/README.md) for .NET Core and .NET Framework.

* An official OPC UA [Nuget](https://www.nuget.org/packages/OPCFoundation.NetStandard.Opc.Ua/) package of the core, client, server and configuration libraries is available for integration in .NET projects. Note: The package has been split into [Core](https://www.nuget.org/packages/OPCFoundation.NetStandard.Opc.Ua.Core/), [Client](https://www.nuget.org/packages/OPCFoundation.NetStandard.Opc.Ua.Client/) and [Server](https://www.nuget.org/packages/OPCFoundation.NetStandard.Opc.Ua.Server/) packages to reduce the dependencies in projects where only client or server is needed. The [https binding](https://www.nuget.org/packages/OPCFoundation.NetStandard.Opc.Ua.Bindings.Https/) is now a seperate optional package.

* A [preview Nuget feed](https://opcfoundation.visualstudio.com/opcua-netstandard/_packaging?_a=feed&feed=opcua-preview%40Local) is available from Azure Devops.



## Project Information



### General Project Info

[![Github top language](https://img.shields.io/github/languages/top/OPCFoundation/UA-.NETStandard)](https://github.com/OPCFoundation/UA-.NETStandard)

[![Github stars](https://img.shields.io/github/stars/OPCFoundation/UA-.NETStandard?style=flat)](https://github.com/OPCFoundation/UA-.NETStandard)

[![Github forks](https://img.shields.io/github/forks/OPCFoundation/UA-.NETStandard?style=flat)](https://github.com/OPCFoundation/UA-.NETStandard)

[![Github size](https://img.shields.io/github/repo-size/OPCFoundation/UA-.NETStandard?style=flat)](https://github.com/OPCFoundation/UA-.NETStandard)

[![Github release](https://img.shields.io/github/v/release/OPCFoundation/UA-.NETStandard?style=flat)](https://github.com/OPCFoundation/UA-.NETStandard/releases)

[![Nuget Downloads](https://img.shields.io/nuget/dt/OPCFoundation.NetStandard.Opc.Ua)](https://www.nuget.org/packages/OPCFoundation.NetStandard.Opc.Ua/)



### Build Status

[![Azure DevOps](https://opcfoundation.visualstudio.com/opcua-netstandard/_apis/build/status/OPCFoundation.UA-.NETStandard?branchName=master)](https://opcfoundation.visualstudio.com/opcua-netstandard/_build/latest?definitionId=14&branchName=master)

[![Github Actions](https://github.com/OPCFoundation/UA-.NETStandard/actions/workflows/buildandtest.yml/badge.svg)](https://github.com/OPCFoundation/UA-.NETStandard/actions/workflows/buildandtest.yml)



### Code Quality

[![Test Status](https://img.shields.io/azure-devops/tests/opcfoundation/opcua-netstandard/14?style=plastic)](https://opcfoundation.visualstudio.com/opcua-netstandard/_test/analytics?definitionId=14&contextType=build)

[![CodeQL](https://github.com/OPCFoundation/UA-.NETStandard/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/OPCFoundation/UA-.NETStandard/actions/workflows/codeql-analysis.yml)

[![Coverage Status](https://codecov.io/gh/OPCFoundation/UA-.NETStandard/branch/master/graph/badge.svg?token=vDf5AnilUt)](https://codecov.io/gh/OPCFoundation/UA-.NETStandard)



## Getting Started

All the tools you need for .NET Standard come with the .NET Core tools. See [Get started with .NET Core](https://docs.microsoft.com/en-us/dotnet/articles/core/getting-started) for what you need.



## How to build and run the reference samples in Visual Studio on Windows

Note: Since .NET Core 2.1 is end of life,
- VS 2017 has only limited support for .NET 4.8.
- VS 2019 is fully supported with .NET 4.8 and up to .NET Core 3.1 (end of life).
- VS 2022 is the current supported version, including .NET 6.0 (LTS).


Note: Since .NET Core 2.1 is end of life,

- VS 2017 has only limited support for .NET 4.8.

- VS 2019 is fully supported with .NET 4.8 and up to .NET Core 3.1 (end of life).

- VS 2022 is the current supported version, including .NET 6.0 (LTS).



1. Open the UA Reference.sln solution file using Visual Studio.

1. Open the UA Reference.sln solution file using Visual Studio.
2. Choose a project in the Solution Explorer and set it with a right click as `Startup Project`.

3. Hit `F5` to build and execute the sample.



## How to build and run the console samples on Windows, Linux and iOS

This section describes how to run the **ConsoleReferenceServer** sample application.



Please follow instructions in this [article](https://aka.ms/dotnetcoregs) to setup the dotnet command line environment for your platform. As of today .NET Core SDK 3.1 is required for Visual Studio 2019 and .NET SDK 6.0 is required for Visual Studio 2022.



### Prerequisites

1. Once the `dotnet` command is available, navigate to the root folder in your local copy of the repository and execute `dotnet restore 'UA Reference.sln'`. This command calls into NuGet to restore the tree of dependencies.

### Start the server
1. Open a command prompt.
2. Navigate to the folder **Applications/ConsoleReferenceServer**.
3. To run the server sample type `dotnet run --project ConsoleReferenceServer.csproj -a`.
- The server is now running and waiting for connections.


### Start the server

1. Open a command prompt.

2. Navigate to the folder **Applications/ConsoleReferenceServer**.

3. To run the server sample type `dotnet run --project ConsoleReferenceServer.csproj -a`.

- The server is now running and waiting for connections.



## Remarks



### Self signed certificates for the sample applications



All required application certificates for OPC UA are created at the first start of each application in a directory or OS-level certificate store and remain in use until deleted from the store. Please read [Certificates](Docs/Certificates.md) for more information about certificates and stores



### Local Discovery Server



By default all sample applications are configured to register with a Local Discovery Server (LDS). A reference implementation of a LDS for Windows can be downloaded [here](https://opcfoundation.org/developer-tools/developer-kits-unified-architecture/local-discovery-server-lds). To setup trust with the LDS the certificates need to be exchanged or registration will fail.





## Create an OPC UA Client Using the Kep Server
1. Open the First OPC Configuration Manager and export the server certificate from the Certificate Section in the Configuration Manager.
2. After exporting certificates, import into client certificate sections.
3. Create a C# project and install the nuget package of the Opc Foundation UA client.
4. Add an endpoint url in the OPCS configuration manager, choose your security mode, and update the Choose Network type.




## Create Application Object First
ApplicationInstance application = new ApplicationInstance();
application.ApplicationName = "My OPC UA Client";
application.ApplicationType = ApplicationType.Client;

## Create Client Configuration

ApplicationConfiguration config = new ApplicationConfiguration();
config.ApplicationName = application.ApplicationName;
config.ApplicationType = application.ApplicationType;
config.ApplicationUri = Utils.Format(@"urn:{0}:{1}", System.Net.Dns.GetHostName(), application.ApplicationName);
config.ProductUri = "https://github.com/opcfoundation/UA-.NETStandard";
config.ClientConfiguration = new ClientConfiguration();
string currentDir = System.IO.Directory.GetCurrentDirectory();


## Add Security Configuration Certificates
// add client certificate.
// First Save Certificate in particular Directory .
// and give path to it.

config.SecurityConfiguration = new SecurityConfiguration()
{

ApplicationCertificate= new CertificateIdentifier
{
StoreType= @"Directory",
StorePath= currentDir + @"/Cert/TrustedIssuer/",
SubjectName= config.ApplicationUri
},
TrustedIssuerCertificates = new CertificateTrustList
{
StoreType = @"Directory",
StorePath = currentDir + @"/Cert/TrustedIssuer/",

},
TrustedPeerCertificates = new CertificateTrustList
{
StoreType = @"Directory",
StorePath = currentDir + @"/Cert/TrustedIssuer/",

},
RejectedCertificateStore = new CertificateStoreIdentifier
{
StoreType = @"Directory",
StorePath = currentDir + @"/Cert/TrustedIssuer/",

},
AutoAcceptUntrustedCertificates=true,
AddAppCertToTrustedStore = true,
RejectSHA1SignedCertificates=false,
};

## Validate Path Of Certificate
config.Validate(ApplicationType.Client).GetAwaiter().GetResult();

## Create Endpoint Url

var endpointUrl = "opc.tcp://localhost:49320";
var endpoint = new ConfiguredEndpoint(null, new EndpointDescription(endpointUrl), EndpointConfiguration.Create(config));


// create session with username and password
var session = Session.Create(config, endpoint, true, "MySession", 60000,
new UserIdentity("username","password"),
null).Result;
session.KeepAliveInterval = 2000;

## Read Value from NodeId
DataValue value = session.ReadValue("ns=2;s=Channel1.Device1.AI_MOV1_POS");

## Subscribe From Nodeid
// Create a subscription object with a sampling interval of 1000 ms
Subscription subscription = new Subscription(session.DefaultSubscription) { PublishingInterval = 3000 };
session.AddSubscription(subscription);
subscription.Create();

// Create a monitored item for the tag with a sampling interval of 1000 ms
MonitoredItem monitoredItem = new MonitoredItem(subscription.DefaultItem)
{
StartNodeId = "ns=2;s=Channel1.Device1.AI_MOV1_POS",
AttributeId = Attributes.Value,
SamplingInterval = 1000
};
monitoredItem.Notification += OnMonitoredItemNotification;
subscription.AddItem(monitoredItem);
subscription.ApplyChanges();

// Handle the notification event when the value of the tag changes
void OnMonitoredItemNotification(MonitoredItem item, MonitoredItemNotificationEventArgs e)
{
dynamic value = e.NotificationValue;
Console.WriteLine("Value of tag " + value.Value.Value);
}


## Contributing

We strongly encourage community participation and contribution to this project. First, please fork the repository and commit your changes there. Once happy with your changes you can generate a 'pull request'.

You must agree to the contributor license agreement before we can accept your changes. The CLA and "I AGREE" button is automatically displayed when you perform the pull request. You can preview CLA [here](https://opcfoundation.org/license/cla/ContributorLicenseAgreementv1.0.pdf).