Prerequisites

• Supported operating system: Windows.
• .NET 6 or 8 SDK (or possibly higher version): 
  • Windows instructions.
• Visual Studio Code (https://code.visualstudio.com/).
• C# extension for Visual Studio Code.
• Internet connection with access to www.nuget.org (for downloading NuGet packages).
• Note that for this Getting Started, you do not necessarily need to install OPC Wizard (using the OPC Studio Setup program), as the component packages will be pulled from the Internet. In order to connect to the created OPC UA server, however, you will need some OPC UA client. Installing the OPC Studio will give you some ready-made OPC UA clients for testing, such the OpcCmd utility or the Connectivity Explorer.

OPC UA Server in a Console Application

1. Open a command prompt.

2. Create a folder named Hello and navigate to the folder.

3. Type the following: dotnet new console. This command creates a project file (Hello.csproj) and a main program file (Program.cs).

4. Type the following: dotnet add package OpcLabs.OpcWizard. This command adds OPC Wizard package reference to the project file.

   The above command actually adds a reference to the package corresponding always to the very latest OPC Wizard version. If you want to be sure that you referencing a package for OPC Wizard 2024.2, use dotnet add package OpcLabs.OpcWizard --version 5.81 command instead.

5. Type the following: code . (note the dot '.' as a parameter to the command.) Visual Studio Code starts and its window opens.

6. At this point, you might be asked "Required assets to build and debug are missing from 'vscode'. Add them?". If so, press the Yes button in the popup window.

7. A notification will appear "There are unresolved dependencies from 'Hello.csproj'. Please execute the restore command to continue.". Press the Restore button in the popup window.

8. In the Explorer window, click on the Program.cs file. The file opens in the code editor.

9. Add following code to the beginning of the Program.cs file:

   • CS

   using OpcLabs.EasyOpc.UA;
   using OpcLabs.EasyOpc.UA.NodeSpace;
   

10. In Program.cs, if there is a Main method, replace its body by the following code. If there is no Main method, just top-level statements, simply replace them all.

    • CS

    var server = new EasyUAServer();
    var random = new Random();
    server.Add(new UADataVariable("DataVariable1").ReadValueFunction(() => random.Next()));
    
    server.Start(); 
    Console.ReadLine(); 
    server.Stop();
    

11. Select Debug -> Start Debugging (F5) from the menu, or press the corresponding button on the toolbar.

    This will build and launch the program. The server is now running. A firewall pop-up window may appear, asking you for consent with allowing the communication. Provide the consent as needed; allowing the communication on private networks is sufficient.

    OPC UA clients can connect to the server's endpoint on "opc.tcp://localhost:48040/" . You can verify it using any OPC UA client; see further below for instructions.

    After you are done, press Enter to exit the program.

Verification

When the OPC UA server is running, any OPC UA client can connect to it and read or subscribe to the value of the variable we have defined in the server. When the OPC UA client is on the same computer, it can connect to "opc.tcp://localhost:48040/" to access this server; otherwise, replace the "localhost" in the endpoint URL by the name of the computer (host) on your network.

If the OPC UA Local Discovery Server (LDS) is installed on the computer where the server is running, the server will automatically register itself with the LDS and will thus become discoverable by OPC UA clients through the LDS. For this to work, the LDS must either accept unauthenticated registrations, or be configured to trust the server. For more information, see OPC UA LDS Integration. The use of the LDS is optional.

If the OPC UA clients allows you to browse the address space of the server, the variable that we have defined is located directly under the Objects folder, and is named DataVariable1. Its node Id is:

• Type: String
• Namespace URI: http://opclabs.com/OpcUA/Custom/Objects
• Namespace Index: 3
• Identifier: DataVariable1

Verification with the Connectivity Explorer

If you have the Connectivity Explorer application (e.g. if you have installed OPC Wizard using the OPC Studio Setup program, or obtained the Connectivity Explorer separately e.g. through ClickOnce deployment), you can use it for verification of the created OPC UA server as follows:

1. Start the Connectivity Explorer application.
2. In the Point Editor window, select Points (Composite) -> OPC Unified Architecture (Client-Server) Points -> Well-known -> opc.tcp://localhost:48040/ .
3. Expand the selected node by clicking on the "+" mini-icon next to it, or by pressing + on the keyboard.
4. Select the DataVariable1 node in the list view (middle pane) of the Point Editor window.
5. Double-click on this DataVariable1 node, or select the "Add Live Data Row" in the Actions pane, or press Enter on the keyboard.
6. Observe the variable value in the Live Point Data window.

Verification with the OpcCmd Utility

If you have the OpcCmd utility (e.g. if you have installed OPC Wizard using the OPC Studio Setup program, or obtained the OpcCmd separately e.g. through ClickOnce deployment), you can use it for verification of the created OPC UA server as follows:

1. Start the OpcCmd utility.
2. Enter the following command:

    
           uaClient subscribe opc.tcp://localhost:48040/ nsu=http://opclabs.com/OpcUA/Custom/Objects;s=DataVariable1
   
   

3. Observe the variable value changes in the console output. The command will terminate automatically after 1 minute, or you can stop it by pressing X on the keyboard.

Security Notice

For simplicity in configuration, the OPC UA server created in this Getting Started exposes an insecure endpoint, and allows OPC UA connections without application authentication. Any production OPC UA server should, at least by default, disable the insecure endpoint. For more information, see Securing OPC Wizard Servers.