mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-24 19:13:02 +08:00
5899354441
# Description Remove stock phrasing and correct misleading or inconsistent technical documentation. The initial two passes covered 367 Markdown files, followed by an interactive review of 169 editorial flags. The U5 interpretation originally deferred in that review has since received the upstream Mantis answer recorded by #4843; remaining server/spec follow-ups stay explicit in the CTT log. - Correct package responsibilities, migration steps, API names, ownership, protocol descriptions and links. Keep bundled migration guides synchronized. Preserve historical conclusions as historical records with separate re-check notes. - Provide at least two rendered TOC levels throughout `docs/`. Convert appropriate architecture figures to Mermaid without changing code examples, transcripts or historical quotations. - Address the October 19 feedback with concrete setup/migration instructions, corrected certificate paths and PubSub names, shorter repeated caveats, consistent XML comments, and a full review of the Concepts guide. Retain #4839's API corrections. - Integrate #4841's runtime/performance guidance and review incoming/recent prose. Preserve dated measurements rather than claiming new benchmark runs; clarify allocation ratios, startup-only processor settings, JIT warm-up and the benchmark commit's scope. Missing raw measurement artifacts and repeat ranges remain tracked by #4842. - Merge master through `e8c5d800a` in `32c6394b7`. Resolve the CTT log conflict using the updated Mantis states and OPC answers, retaining historical framing and re-checks for C28/C32/C43. - Address the latest naming/index feedback in `adb5bf693`: rename the guides to `docs/WotCon.md` and `docs/WotNodeSetConversion.md`; move the provider and DataType-declaration contracts into the conversion guide and remove `docs/WoT.md`. Rename `samples/DI` to `samples/Di` and `samples/Isa95` to `samples/ISA95`. Add content-index READMEs to Di, FluentApi, ISA95, Lds and PubSub; update solution entries, project references, Docker/CI paths, test fixture paths and documentation links with exact casing. **WoT guide scope.** This branch retains the detailed conversion guide that #4758 had replaced with an anchor stub. Conversion limits, verified document sets, preservation rules and provider ownership now live together in `WotNodeSetConversion.md`; binding/runtime guidance remains in `WotBindings.md` and `WotCon.md`. The design-rationale/test-ledger prose was shortened, the oversized argument-table cell moved into its section, and existing anchors preserved. **SDK policy is a separate, explicit user-directed change.** `global.json` sets a stable minimum of `10.0.400`, `rollForward: latestMajor`, and `allowPrerelease: false`. Newer major SDKs are permitted; CI's explicit SDK pins are unchanged. README, GettingStarted, DeveloperGuide and Recycling instructions reflect the possible analyzer differences. The image-contract regression fix accepts compatible stable SDK images instead of requiring exact equality with the floor. The latest four rename/index threads are resolved after publication. Three older threads remain open: universal obsolete-removal timing, unconditional nonce-strength wording, and a blanket Vision NativeAOT claim. Existing implementation/evidence constraints are explained in their inline replies. The two-level TOCs remain as requested. ## Validation - `git diff --check` and staged diff checks: passed. The untouched upstream AutoID NodeSet retains its provenance bytes, including two existing license-header trailing spaces. - `.\.azurepipelines\validate-migration-plugin.ps1`: passed; 15 bundled migration documents and manifests synchronized. - Documentation/path validation: **101** documents retain two rendered TOC levels (**2,228** entries), with idempotent formatting. **52** new relative links and their anchors passed exact-case checks. No tracked references to the old guide/sample paths remain. Both relocated provider-contract sections are preserved in the destination. - `dotnet sln UA.slnx list`: passed; shows the renamed Di/ISA95 projects and the existing FluentApi/Lds/PubSub projects. Updated solution and pump ProjectReference paths also passed exact-case existence checks. - Latest focused commands, run from the repository root: ```powershell # Passed: 61 channel send-order and reconnect tests. dotnet test tests\Opc.Ua.Core.Tests\Opc.Ua.Core.Tests.csproj -p:CustomTestTarget=net10.0 --filter 'FullyQualifiedName~UaSCBinaryChannelSendOrderTests|FullyQualifiedName~TcpReconnectKeyAgreementTests' --verbosity minimal # Passed: 5 pump datasheet tests; builds the renamed pump sample. dotnet test tests\Opc.Ua.Di.Tests\Opc.Ua.Di.Tests.csproj -p:CustomTestTarget=net10.0 --filter 'FullyQualifiedName~PumpDatasheetConformanceTests' --verbosity minimal # Passed: 4 repository NodeSet path/round-trip tests, including the moved pump models. dotnet test tests\Opc.Ua.Types.Tests\Opc.Ua.Types.Tests.csproj -p:CustomTestTarget=net10.0 --filter 'FullyQualifiedName~RepositorySourceSurvivesSerializedLinkedPartitionsAsync' --verbosity minimal # Passed: build, zero warnings/errors. dotnet build samples\ISA95\MinimalIsa95Server\MinimalIsa95Server.csproj -p:CustomTestTarget=net10.0 -f net10.0 --verbosity minimal # Passed: dependent sample-test project build, zero warnings/errors. dotnet build tests\Opc.Ua.WotCon.Samples.Tests\Opc.Ua.WotCon.Samples.Tests.csproj -p:CustomTestTarget=net10.0 -f net10.0 --verbosity minimal ``` Earlier focused integration checks passed 2,620 tests across AutoID, event queues/scheduling, source generation, MCP/package profiles and WoT. Both reviewed Mermaid diagrams rendered locally without network access. These checks are not a full solution run. The full solution has **not** been rerun for this review. Earlier `dotnet test UA.slnx -p:CustomTestTarget=net10.0 --verbosity quiet` did not pass: three AOT projects rejected VSTest and 20 Vision tests failed during graphics initialization with `OutOfMemoryException`. Remaining long-running tests were stopped at the user's request. A focused Vision rerun passed 558 tests and reproduced those 20 failures. The earlier `dotnet test UA.slnx -p:CustomTestTarget=net48 --verbosity quiet` was blocked by the former SDK pin and was not retried after the policy change. The user approved proceeding with those limitations documented; current remote CI is not claimed green. ## Related Issues - Follow-up #4842 tracks the requested 2.0.2+ benchmark/tuning and diagnostic-tool documentation refresh. #4841 supplies documentation and earlier results, not all newly requested measurements. - #4758 explains the conversion guide's earlier consolidation; the current provider contracts are now consolidated into `WotNodeSetConversion.md`. - #4839 supplies the reviewed API corrections; #4843 supplies the updated CTT issue record. - The original prose cleanup and SDK policy were user-requested without a source issue. No new runtime architecture is introduced by these documentation edits. ## Checklist _Put an `x` in the boxes that apply. You can complete these step by step after opening the PR._ - [ ] 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. - [ ] 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. - [ ] 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. --------- Co-authored-by: Roman Ettlinger <romanett98@gmail.com> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
OPC UA .NET Standard stack documentation
These guides lead from a first working application to advanced and experimental capabilities. Follow the numbered stages when you are learning. Choose only the paths that match your application, or use the contents list to find a feature.
- New to the SDK? Start with Getting started, read OPC UA concepts, then build your first information model.
- Upgrading from 1.5.x? Read What's New in 2.0, then follow the Migration Guide.
- Contributing to this repository? See Contributing and maintaining the SDK.
Contents
- How to use this index
- 1. Get started
- 2. Build your application
- 3. Add data types and application services
- 4. Use companion models
- 5. Prepare for production
- 6. Advanced integration, reliability, and scale
- 7. Draft and experimental capabilities
- Reference and upgrade
- Contributing and maintaining the SDK
How to use this index
Each stage builds on the earlier ones, but you do not need to read every guide. After stage 1, choose the client, server, or PubSub path. Stages 3 to 7 are optional; use the guides your application needs. A stage or group names the knowledge it assumes.
Labels describe the maturity of a package or model:
- Preview package: the package family keeps a
-previewversion, even when the core packages are stable. See Versioning. - Draft model: the guide implements a working-group draft specification. Its namespace URIs and NodeIds are provisional.
- Experimental: the guide marks the feature as experimental.
These labels are independent of difficulty. An advanced guide can describe a stable feature, and a released specification can ship in a preview package.
1. Get started
Run a client and server, then learn the terms that the other guides use.
- Getting started — run the minimal samples, or build a client and server from NuGet packages.
- OPC UA concepts — applications, endpoints, sessions, the address space, values, subscriptions, and PubSub.
- Your first information model — add a model to the Getting started server, then read, write, and call it from the client.
- Sample catalogue — minimal, reference, PubSub, and companion-model applications.
- Packages and supported platforms — choose packages and target frameworks.
2. Build your application
Choose the path for your application. The paths are independent: for example, a PubSub application needs neither a client nor a server.
Client path
Assumes Getting started.
- Dependency injection: client feature — configure a client in the .NET Generic Host.
- Managed sessions — connect, recover from connection loss, and close. To compare the managed and classic session APIs, see choosing a session API.
- Read, write, and call methods — resolve namespace URIs and browse paths, check the status of each operation, and call methods through a client generated from the model.
- Subscriptions — callback subscriptions for long-lived monitoring and streams for short observations.
- Generation-bound requests — retain remote file handles, history cursors and target classifications without following a replacement connection.
Server path
Assumes Getting started.
- Dependency injection: server feature — host a server and configure its endpoints, security, and node managers.
- Node managers: start with a model — generate a node manager from your model and attach callbacks. Complete method invocation results covers ordered output values and resolved operation/input diagnostics. Your first information model is a complete example.
- Runtime NodeSets — load NodeSet2 models without generated code when models change independently of your application.
- Asynchronous server support — implement service and node-manager callbacks asynchronously.
PubSub path
A PubSub application needs neither a client nor a server, so the Getting started exercise and the other two paths are optional here.
- Concepts: client/server and PubSub — publishers, subscribers, and datasets.
- Run a first publisher and subscriber — exchange signed and encrypted messages on one computer with the reference PubSub sample.
- PubSub guide — the fluent builder, hosting, configuration, encodings, and security.
- Transport selection — UDP, Ethernet, MQTT, and Kafka.
3. Add data types and application services
Assumes the client or server path. Choose the capabilities your application needs.
Data types and models
- Source-generated data types — generate encodeable implementations for your own structures.
- Complex types — decode server-defined structures and enumerations at run time.
- Model dependencies — compose models that depend on other models.
- NodeId assignment — control the identifiers of nodes created at run time.
- Schema generation — produce XSD, BSD, and JSON schemas for data types.
Application services
- State machines — define, drive, and observe state transitions.
- Programs — host and control Part 10 invocations, monitor captured transition results, and manage diagnostics and lifetime.
- Alarms and conditions — raise, acknowledge, and stream alarms. Alarm conditions use state machines, for example for shelving.
- Historical access — store and read value and event history.
- Aggregates — calculate processed history; read historical access first.
- File system client — transfer files through the standard file objects.
- Alias names — find nodes through named aliases.
- Node management — let clients add and delete nodes and references.
- Final-value publication — await terminal Value notifications in real Publish responses before removing dynamic subtrees.
- Model change tracking — keep client caches current when the address space changes.
- NodeSet export — export a server's address space to NodeSet2 XML.
4. Use companion models
Companion specifications define models for particular industries and device types; Concepts explains how they relate to the base model. These libraries assume the server path and, for typed client access, the client path. The packages load the models that each model depends on.
- Device Integration (OPC 10000-100) — devices, topology, and locking.
- Asset Management Basics (OPC 10000-110) — make devices, machines, pumps or scales manageable assets: discovery, identification, health alarms, maintenance, documentation links and locations. Read Device Integration first.
- Software update (OPC 10000-100) — software package storage, installation, and confirmation. Read Device Integration first.
- ISA-95 (OPC 10030 and OPC 10031-4) — the common model and job control.
- Positioning (OPC 10000-210 and OPC 10000-211; preview package) — relative frames and geographic positions.
- Machinery (OPC 40001-1, -2, -3, -4 and -101) — machines with identification, server-driven state machines, process values, job management, energy and result transfer, based on the Industrial Automation, Device Integration, PA-DIM, ECM and ISA-95 models.
- Pumps (OPC 40223) — pumps and vacuum pumps, published both as Device Integration devices and as Machinery machines.
- AutoID Devices (OPC 30010) — RFID, OCR, optical, optical verifier and RTLS readers: model, server hosting with a provider contract for the reader hardware, typed client, MCP tools and a simulated RFID reader sample, based on the Device Integration model.
- Machine Vision (OPC 40100-1 and OPC 40100-2) — released control, recipes, configurations, results, assets, and condition monitoring, with Vision/Perception composition and Machinery hosting.
- MachineTool and wireless peripherals (OPC 40501-1 and OPC 40505) — machine monitoring, tools, production/jobs/files and independently hosted wireless measurements, configuration and records in one package family.
- Geometric Measurement Systems (OPC 40210) — native measurement equipment, qualification/calibration, production observations and results. The guide documents the upstream undefined Production-statistics CU exception.
- Cranes and Hoists (OPC 40020-1; preview packages) — Robotics-derived crane systems, equipment observations and explicitly authorized speed-limit requests.
- Scales (OPC 40200 and OPC 30050) — weighing technology with every scale kind, scale systems, recipes and PackML state machines, based on the Machinery model.
- Plastics and rubber capabilities (OPC 40083 and OPC 40082-6) — shared machine configuration, control and monitoring, with production dataset transfer and granulate drying.
- Extrusion (OPC 40084-1 through -12) — the extrusion line and its device families, optional capabilities, typed clients and composition.
- Robotics (OPC 40010-1; preview package) — motion-device systems, based on the Industrial Automation and Device Integration models. The guide's draft Robot Intent model is listed in stage 7.
- WoT connectivity (OPC 10100-1; preview package) — connect Web of Things assets. Its registry extension is listed in stage 7.
For more examples, including the Pumps and Machinery models, see the companion-model samples. The generic recycling simulation combines a causal production model with separately hosted process views; its guide identifies the remaining companion integration limits. The optional recycling operator console adds a local ASP.NET Core 10 browser schematic, strict UA trust and role-limited commands; its guide covers standalone and Compose setup, image publication and the synthetic sample's operational/security limits.
To expose these typed client interfaces to an agent, use the industrial companion MCP tools. Select one family or compose several profiles without enabling the entire tool catalog. The WoT and xRegistry profiles cover asset/registry management and document conversion; the document profile does not require a UA connection.
5. Prepare for production
Builds on the certificate trust you used in Getting started. Before you deploy a client or server, work through the production readiness checklist. It links to these guides for the details:
- Certificates — certificate stores, trust, and chain validation.
- Identity providers — authenticate users on clients and servers.
- Role-based user management — map identities to roles and permissions.
- Certificate manager — certificate lifecycle, rotation, and remote updates.
- Diagnostics — logging, metrics, tracing, auditing, and packet capture.
- Rate limiting — admission limits and busy signals during connection storms.
- Server resource isolation — per-caller limits and reserved capacity for startup and recovery.
- Profiles and facets — implemented profiles and platform boundaries.
- Container reference server — run the reference server in a container.
6. Advanced integration, reliability, and scale
Each group names the stages it assumes.
Transports and integration
Assumes the client or server path.
- Transports — UA-TCP, HTTPS, and WebSocket transports.
- REST binding — OpenAPI mapping, encoding negotiation, and HTTP authentication.
- OPC UA over OpenAPI — serve the OpenAPI document the stack generates from its REST routes and call the server from generated REST clients.
- Reverse Connect — server-initiated connections.
- Session-less invocation — let clients call Read, Browse, Call and the other §6.3 Services without a Session.
- PubSub external-server adapter — bind PubSub to an OPC UA server through a managed client session. Assumes the client and PubSub paths.
- PubSub transcoding — convert encodings, values, and metadata between PubSub messages.
- MCP server — let AI agents browse, read, write, and diagnose OPC UA servers. Stack workflow profiles add GDS/credential issuance, roles/users, files, alarms, history, schemas, policy-controlled PubSub and live WoT execution.
- WoT / NodeSet conversion and WoT protocol bindings — convert Thing Descriptions and add protocol bindings. The conversion guide also covers resolver ownership and DataType declaration inputs. Read WoT connectivity first.
Session recovery and performance
The subscription guides assume the client path; the sizing guides assume Diagnostics.
- TransferSubscriptions — move server subscriptions to a new session.
- Durable subscriptions — keep subscriptions and queued notifications while clients are disconnected.
- Generation-bound session clients — capture dispatch, session identity and mapping snapshots without reconnecting to a replacement peer.
- Server scalability — sizing limits, bottlenecks, and runtime settings for servers under load (Server GC, hybrid CPUs, warm-up).
- Benchmarks — measured performance and methodology.
Security infrastructure and fleet management
Assumes stage 5.
- ECC profiles — elliptic-curve security policies and their platform requirements.
- Crypto providers — replace the platform cryptography and keep private keys in hardware.
- Provisioning mode — configure a new server securely before exposing application data.
- Global Discovery Server — application registration and central certificate management.
- GDS sample — a runnable onboarding workflow.
- AuthorizationService — issue access tokens.
- KeyCredentialService — manage credentials for services that are not OPC UA. Its issued-token bridge is listed in stage 7.
High availability and deployment
Assumes a working single server and stage 5.
- High availability (preview package) — redundancy, failover, and distributed state.
- Replica-consistent NodeIds (preview package) — keep node identifiers identical across replicas; required before replicating an address space.
- Kubernetes (preview package) — cluster deployment, discovery, readiness, and secrets. Read high availability first.
- PubSub high availability (preview package) — redundant publishers and subscribers. Assumes the PubSub path.
Native AOT publishing
Publish an application as a native executable without a JIT compiler; start with Native AOT: publish an application. Feature-specific guidance:
- Servers with generated node managers
- Applications hosted with dependency injection
- PubSub applications
7. Draft and experimental capabilities
These guides implement working-group drafts or experimental extensions. Namespace URIs, NodeIds, and APIs can change before the specifications are published, so evaluate them before you depend on them in production. Each guide describes its current limitations.
- xRegistry (draft model; preview package) — the generic registry base model, resource storage, and federation.
- AI model management (draft model; preview package) — model catalogues, deployments, inference, and learning jobs. Builds on xRegistry.
- Perception model (draft model; optional OpenUSD renderer is preview-only) — capture, media, feedback, and client workflows.
- Robot Intent (draft model; preview package) — task-level motion commands. Does not require the Robotics model.
- OpenUSD (draft models; preview package) — bind values to OpenUSD scenes and materialize scenes in the address space.
- WoT Connectivity registry (draft model; preview package) — hosting, document provisioning, and refresh.
- WoT-Con 1.02 compatibility — existing-type bindings, declarations, and original document preservation.
- WoT runtime provider contracts — exact-Version dependencies and leases, prepared storage/publication, and recovery.
- KeyCredential issued-token bridge (experimental).
These samples combine several draft or preview capabilities. Read the guides for their models first:
- Bin picking cell — Robot Intent, Vision, and an OpenUSD scene.
- Visual inspection cell — Vision, AI model management, and ISA-95 job control.
- WoT aggregation sample — load Device Integration, Machinery, and Pumps models from WoT documents through the WoT Connectivity 1.1 registry, and bind them to two OPC UA source servers.
- Generator sample model (draft model) — generating-set simulation and scene composition.
Reference and upgrade
- What's New in 2.0 — a summary of new capabilities.
- Migration Guide — upgrade from 1.5.378, with topic-specific 2.0 guides and PubSub migration.
- Reference client — command-line configuration and transport profiles.
- Reference server — hosting and compliance-test setup.
- Reference PubSub client — publisher, subscriber, and external-adapter modes.
The Windows Forms reference applications are maintained in the Samples repository.
Contributing and maintaining the SDK
These documents describe building and maintaining this repository, not using the SDK in an application:
- Developer Guide — prerequisites, build, tests, and coding conventions.
- Continuous integration — pipelines and coverage gates.
- Native AOT test harness — build, run, and extend the Native AOT compatibility tests.
- Release process — release branches, versioning, backports, and recovery.
- Redundancy sample tests — process-level failover and soak validation.
- Fuzz testing — encoder, certificate, and network campaigns.