Marc Schier 533ed1c358 Fix source generator dropping BaseAnalogType EURange/EngineeringUnits on instances (#3964) (#3966)
# Description

The model source generator (`ModelSourceGeneratorGenerateNodeManager`)
split an instance's child nodes into an **always-emitted** list and an
`if (!forInstance)` **type-template** list. Explicitly-declared
descendants of a *concrete predefined instance* whose modelling rule
only resolved to *Optional* — for example the `EURange` /
`EngineeringUnits` properties of a `BaseAnalogType` / `AnalogUnitType`
variable nested under an instance — were placed in the gated list.
Because the per-instance factory is always invoked with `forInstance:
true`, those property children were **never materialized** on the actual
instance. The pre-existing "top-level instance" exception in
`NodeStateGenerator.LoadTemplate_ReplaceChild` only covered an
instance's *direct* children, not deeper descendants (e.g. `EURange`
under `AI01` under `MyEquipment03`).

Both symptoms reported in the issue stem from this single bug:

1. **Instances were missing `Range` / `EU`** — the property nodes were
never created.
2. **`WithEURange` / `WithEngineeringUnits` (in `Configure`) appeared to
do nothing** — with the property nodes missing, the fluent helpers
created *unregistered* replacement nodes whose values were never served
to clients.

## Fix

`NodeStateGenerator.LoadTemplate_ReplaceChild` now also emits
**explicitly-declared descendants of any concrete predefined instance**
(`IsUnderSingletonInstance`, not a type-definition/type-instance
context, explicitly defined) into the always-emitted list. The new
condition is gated on `!UseTypeDefinitionModellingRules`, so SDK-managed
singletons (`Server`, `ServerConfiguration`, …) — generated with that
option **on** — keep the deliberate `#3768` optional-child suppression.
The core stack (generated with the option on) is therefore unaffected;
the change only corrects user models generated with the option off.

## Verification

- **End-to-end**: built a server from the exact NodeSet2 attached to the
issue and browsed/read it with a real OPC UA client.
`MyEquipment03.AI01` / `AO01` now expose `EURange` (`-20..200`) and
`EngineeringUnits`. With the reporter's `Configure` present the values
become `-20..200` / `Kelvin` (`AO01` reads `10`); with no `Configure`
the nodeset-declared values (`°C`, `-20..200`) materialize — confirming
both reported problems are resolved.
- **Regression test** added
(`ConcreteInstanceAnalogChildren_AreMaterializedUnconditionally`) with a
self-contained `AnalogInstance.NodeSet2.xml` fixture. It passes with the
fix and fails without it.
- **No regressions**: full `Opc.Ua.SourceGeneration.Core.Tests` suite
(3702 passed / 8 analyzer-gated skips, including the `#3768`
singleton-dispatch and stack-generation tests), `Opc.Ua.WotCon.Tests`
(342 passed), and clean builds of the DI / GDS / WotCon / Pumps / Boiler
/ Quickstarts model-consuming projects.

## Related Issues

- Fixes #3964
2026-07-07 16:03:42 +02:00
2020-05-15 19:41:55 +02:00
2021-07-26 10:06:51 +03:00

OPC UA .NET Standard Stack

Release NuGet Downloads Build Tests Coverage

🆕 This is version 2.0 of the OPC UA .NET Standard Stack (current master).

Looking for the supported 1.x release? It lives on the master378 branch (last release: 1.5.378). All new feature work happens here on master; master378 continues to receive security and critical-bug fixes for the 1.x line.

The official OPC Foundation reference implementation of OPC UA for .NET — a certified, cross-platform stack with client, server, PubSub, GDS, complex types, and source-generated tooling. Used in production across industrial control, manufacturing, energy, and IoT systems.

📦 What it is

  • A full-stack OPC UA implementation — Core / Client / Server / PubSub / GDS / LDS / Complex Types / Device Integration libraries built on .NET, with UA-TCP and HTTPS transports.
  • Cross-platform — runs on .NET 10, .NET 9, .NET 8 (LTS), .NET Framework 4.8, and .NET Standard 2.1; ships Native-AOT-friendly assemblies.
  • Certified for compliance — the reference server has been certified through an OPC Foundation Certification Test Lab and is continuously verified against the latest Compliance Test Tool (CTT).
  • Companion-spec coverage — Part 9 (Alarms & Conditions), Part 11 (Historical Access), Part 13 (Aggregates), Part 16 (State Machines), Part 17 (Alias Names), Part 18 (Role Management), Part 20 (File Transfer), Part 100 (Device Integration), OPC 10100-1 (WoT Connectivity).
  • Modern developer surface — first-class Microsoft.Extensions.DependencyInjection hosting (services.AddOpcUa()), fluent server + client builders, source-generated NodeManagers and DataTypes, and an MCP server so LLMs / Copilot can drive an OPC UA client.

For the full feature breakdown see OPC UA Profiles and Facets and the What's New in 2.0 tour.

🚀 Getting started

You need the .NET 10 SDK to build the repo. From the repository root:

dotnet restore UA.slnx
dotnet build UA.slnx

For the supported target frameworks and platform notes see Platform Support. The official NuGet packages are published to nuget.org under the OPCFoundation.NetStandard prefix — the meta package OPCFoundation.NetStandard.Opc.Ua pulls in everything, or pick the split OPCFoundation.NetStandard.Opc.Ua.Core / .Client / .Server / .Bindings.Https packages directly. Preview builds for every successful master build are available in the Azure DevOps opcua-preview feed.

Sample applications

Each sample has its own README.md with build and run instructions.

Reference applications

  • Console Reference Server — the certified reference server (with Quickstarts, CTT, and Mono configs). Also ships as a Docker container.
  • Console Reference Client — cross-platform reference client demonstrating sessions, subscriptions, browsing, and method calls.
  • Console LDS Server — a standalone Local Discovery Server built on Opc.Ua.Lds.Server.
  • MCP Server — Model Context Protocol server that exposes OPC UA client operations as MCP tools, so an LLM / Copilot can browse, read, write, subscribe, and call methods on any OPC UA server.

PubSub samples

  • Console Reference PubSub Client — one executable with publisher, subscriber, and external (external-server adapter) modes across the supported transport profiles.

Minimal / Device-Integration samples

More sample projects are maintained in the companion OPC UA .NET Samples repository.

🔧 Migrating from 1.5.378 to 2.0

The 2.0 release introduces breaking API changes, and comes with a full prescriptive migration guide that links to per-area documentation covering telemetry, packages, source generation, types, encoders, node states, identity, certificates, configuration, sessions / subscriptions, alarms / model change, and TimeProvider.

Most of the mechanical migration work is automated:

  • OPCFoundation.NetStandard.Opc.Ua.MigrationAnalyzer NuGet — install it in your project to get analyzer warnings (UA0001–UA0022)
    • one-click code fixes for the patterns in the guide. Setup steps are in the package's NugetREADME.md.
  • Migration agent skill — the opcua-v20-migration skill walks Copilot / Claude / any coding agent through installing the NuGet, running dotnet format analyzers to apply auto-fixes, and handling the small residual manual patterns. The skill knows which sub-doc to load for each symptom so it stays context-efficient.

If you are still on 1.x and not ready to upgrade, stay on the master378 branch — it continues to receive security and critical-bug fixes.

🤝 Contributing and license

Community contributions are welcome. Fork the repository, make your changes on a branch, and open a pull request; see CONTRIBUTING.md for the contribution workflow.

Contributors must sign the OPC Foundation Contributor License Agreement (CLA). The CLA "I AGREE" gate is presented automatically on your first PR.

The project is licensed under the OPC Foundation MIT License. Report security vulnerabilities via the process documented in SECURITY.md.

📚 Further reading

S
Description
OPC Unified Architecture .NET Standard
Readme
296 MiB
Languages
C# 99.4%
PowerShell 0.2%