mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-29 07:07:24 +08:00
romanettandClaude Opus 5
57db405446
# Description
`GlobalDiscoveryServerClient.ServerStatusChanged` and
`ServerPushConfigurationClient.ServerStatusChanged` never fired. In 2.0
neither class raised them and both declarations sat behind `#pragma
warning disable CS0067`; in 1.5.378 the GDS client had an empty `if
(ServerStatusChanged != null) { }` marked `// TODO: implement` and the
push client had no raiser at all. The XML docs claimed the opposite, so
a consumer got a handler that was simply never called.
Both clients now raise the event when the server state changes, and once
for the state the first keep-alive reports after a connect.
## No subscription is created
`KeepAliveEventArgs` already carries `Status`, `CurrentState` and
`CurrentTime`. The session keep-alive reads `Server_ServerStatus_State`
from the server on every interval — on both subscription engines — and
sends the first one immediately after connect (`TimeSpan.Zero`). Both
clients were already subscribed to `Session.KeepAlive`, so the state is
available without any subscription of their own.
Each client raises the event from its existing keep-alive handler. That
means no subscription, no monitored item, no engine branching, no
teardown lifecycle, and **no additional requests to the server**.
An earlier revision of this PR did create a `Server_ServerStatus`
subscription per connect. It was ~420 lines, needed separate classic and
V2 paths, and hung the Gds test legs on macOS and ubuntu — the
subscription was created inside `ConnectInternalAsync` under the client
lock and the run wedged there deterministically (0 failures, a hang
dump, remaining fixtures never executed). Reading the state off the
keep-alive removes the code and the failure mode together.
## Handler type
The events, and the (new in 2.0) interface members, use
`EventHandler<ServerStatusChangedEventArgs>` rather than the
`MonitoredItemNotificationEventHandler` the concrete classes declared in
1.5.378. That type is a classic-engine type whose first parameter is the
concrete `MonitoredItem`, and `MonitoredItemNotificationEventArgs` has
an `internal` constructor, so `Opc.Ua.Gds.Client.Common` cannot
construct one.
```csharp
client.ServerStatusChanged += (sender, e) =>
{
ServerState state = e.CurrentState;
};
```
There is nothing to migrate behaviourally, since no 1.5.378 handler ever
ran; code that merely subscribed needs a recompile.
**Scope note:** the event reports the server *state* (matching its name)
rather than the full `ServerStatusDataType`. A consumer needing
`BuildInfo` or `SecondsTillShutdown` reads `Server_ServerStatus`
directly. Happy to revisit if the richer payload is wanted.
## Note for reviewers: the blank-line hunks
Removing `#pragma warning disable CS0067` unmasked **26 pre-existing
RCS0009** violations in the two client files — that pragma had been
suppressing the Roslynator analyzer for the whole file. Confirmed
against a baseline worktree of `master`: deleting only the two pragma
lines there reproduces all 26. Those blank-line-only hunks are required
to keep the build green, not gratuitous reformatting.
## Related Issues
- Fixes #4346
## Checklist
- [x] I have signed the
[CLA](https://opcfoundation.org/license/cla/ContributorLicenseAgreementv1.0.pdf)
and read the
[CONTRIBUTING](https://github.com/OPCFoundation/UA-.NETStandard/blob/master/CONTRIBUTING.md)
doc.
- [x] I have added tests that prove my fix is effective or that my
feature works and increased code coverage.
- [x] I have added all necessary documentation. (Behaviour is documented
on the interface members; per review the migration-guide entry was
dropped, since a never-raised event is a bug fix with nothing to
migrate.)
- [x] I have verified that my changes do not introduce (new) build or
analyzer warnings.
- [ ] I ran **all** tests locally using the **UA.slnx** solution against
at least .net **framework** and .net **10**, and all passed.
- [ ] I fixed **all** failing and flaky tests in the CI pipelines and
**all** CodeQL warnings.
- [ ] I have addressed **all** PR feedback received.
### What I verified locally
- `UA.slnx` builds clean (0 warnings, 0 errors).
- The full `Opc.Ua.Gds.Tests` suite on **net10.0** — the one that hung
in CI — now runs to completion: **1111 passed, 0 failed, 42 skipped,
7m37s**. It includes the two new integration tests asserting the event
is raised after connect (`ClientTest`, all 13 `PushTest` fixtures).
- I did not run the .NET Framework target locally.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
---------
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
OPC UA .NET Standard Stack
🆕 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
master378branch (last release:1.5.378). All new feature work happens here onmaster;master378continues 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 / Positioning 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), Parts 210/211 (Relative Spatial Location and Global Positioning), OPC-10030 (ISA-95 Common Model) with OPC-10031-4 Job Control V1/V2, OPC 30270 / OPC UA for Asset Administration Shell V2 and V3, OPC 10100-1 (WoT Connectivity), OPC 40001-1 (Industrial Automation), OPC 40010-1 (Robotics).
- Modern developer surface — first-class
Microsoft.Extensions.DependencyInjectionhosting (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
the Developer Guide. 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.
PubSub samples
- Console Reference PubSub Client —
one executable with
publisher,subscriber, andexternal(external-server adapter) modes across the supported transport profiles.
Minimal / Device-Integration samples
- Minimal Calc Server — minimal server built on the source-generated NodeManager pipeline (Calc model).
- Minimal Boiler Server — minimal Boiler-model server with the fluent state-machine builder; Native-AOT publishable.
- Pump Device Integration Server —
minimal Device Integration (Part 100) server using
Opc.Ua.Di.Server's fluent builder. - Minimal Robot Server — OPC 40010 Robotics with independently configurable RSL/GPOS motion and live OpenUSD transforms.
- Intent Enabled Robot — one collaborative arm exposing the Robot Intent command surface: task-level motion verbs tracked on a Part 10 program lifecycle, with missions, command authority and safety-aware refusal.
- Intent Viewer Client — click a target in an OpenUSD viewport and watch the arm execute the resulting intent; also runs headless.
- Bin Picking Cell — Robot Intent, Vision, an eye-in-hand camera, and an in-address-space OpenUSD scene in one reference cell.
- Bin Picking Client — closes the Vision-to-Robot-Intent loop, with optional MCP hosting and an OpenUSD viewport.
- Visual Inspection Cell — hosts Vision, AI Model Management, ISA-95 Job Control V2, and an operator dialog for deterministic machined-bracket inspection.
- Visual Inspection Agent — drives
the inspection loop with typed clients, routes inference through deployment
Invoke, applies recipe verdicts, schedules allowlisted jobs, and records operator ground truth. - AI Model Management sample —
ModelManagementServerpublishes the draft AI Model Management catalogue and routes inference;ModelManagementClientdiscovers deployments and exercises the Methods. - Minimal ISA-95 Server — minimal server hosting the OPC-10030 ISA-95 Common Model together with OPC-10031-4 Job Control V1 and V2, using the typed common-model builder and the in-memory Job Control provider.
More sample projects are maintained in the companion OPC UA .NET Samples repository.
Developer tools
- OPC UA MCP Server — installable .NET tool and container that exposes OPC UA client operations as MCP tools for LLMs and Copilot. The tools also ship as libraries (
…Opc.Ua.Mcp.Core,.PubSub,.Diagnostics,.PubSub.Diagnostics) so an application can embed them next to its own MCP tools.
🔧 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.MigrationAnalyzerNuGet — 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-migrationskill walks Copilot / Claude / any coding agent through installing the NuGet, runningdotnet format analyzersto 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
- Documentation index — every per-feature doc with a one-line description.
- What's New in 2.0 — narrative tour of the 1.5.378 → 2.0 changes grouped by theme and layer.
- OPC UA for Asset Administration Shell — OPC 30270 / AAS V2 ingestion-only metamodel support and the AAS V3 metamodel, registry, document round-trip, packages, federation and conformance matrices.
- OPC UA Profiles and Facets — facets / transports / security policies the stack implements.
- Migration Guide — prescriptive
per-version migration reference (links to
docs/migrate/2.0.x/). - OPC UA Online Reference — the official OPC 10000 series specification index.
- OPC UA .NET Samples — companion repository with more sample applications.
- Preview NuGet feed — prerelease builds from Azure DevOps.