Files
5899354441 Clarify documentation, migration guidance, and SDK selection (#4823)
# 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>
2026-10-21 10:10:55 +02:00

5.8 KiB

OPC 40200 Scales samples

Two console applications show the Opc.Ua.Scales* libraries end to end:

  • a server that publishes weighing equipment with the fluent builders;
  • a client that discovers the scales, drives them and streams their weights and notifications with ScalesClient.
Sample What it does
ScalesServer Serves a packing line and four stand-alone scales, and simulates them twice a second
ScalesClient Discovers every scale, prints each one, drives the checkweigher, then streams its weights, events and alarms

The Scales developer guide explains every API used here.

Run

In two terminals:

dotnet run --project samples/Scales/ScalesServer -- --port 62548
dotnet run --project samples/Scales/ScalesClient -- --insecure --seconds 20

Client options:

  • --insecure makes the client accept the server's self-signed certificate. Never use it in production.
  • --url <endpoint> sets the server endpoint. The default is opc.tcp://localhost:62548/ScalesServer.
  • --seconds <n> sets how long to stream. 0 skips streaming.

The client prints something like:

Scale system PackingLine1 (Contoso Weighing PL-0001), PackML Idle

Checkweigher1 - Checkweigher scale
  Contoso Weighing CW-600, serial CW-0100
  range 0 .. 0.6, d = 0.0001, e = 0.0002
  current    gross 0.5057 kg, net 0.5057, tare 0 (None_0)
  registered gross 0.5089 kg, net 0.5089, tare 0 (None_0)
  products   CEREAL-500 (Cereal 500 g), CEREAL-375 (Cereal 375 g); in processing: CEREAL-500
  PackML     Idle

AnalyticalBalance - Laboratory scale
  Contoso Lab XP-220, serial AB-220
  range 0 .. 0.22, d = 1E-07, e = 1E-06
  current    gross 0.1 kg, net 0.1, tare 0 (None_0)
  registered none yet
…

Driving Checkweigher1:
  SetTare: done
  ClearTare: done
  registered gross 0.4968 kg, net 0.4968, tare 0 (None_0)
  RegisterWeight: done
  SwitchProduct CEREAL-375: done
  current products: CEREAL-375

Streaming weights and notifications of Checkweigher1 for 20 s ...
  weight gross 0.5062, net 0.5062, tare 0 (None_0)
  ALARM 401 Component: The labeler is out of labels.
  event 103 Process: Package of 0.4846 kg rejected.
  cleared 401 Component: Labels restocked.
  …

NodeIds and namespace indices are whatever the server assigned. Only the browse names are stable.

What the server shows

File Shows
Program.cs AddScales() and ConfigureScales(...) on the generic host
PackingLine.cs The equipment, listed below
ScaleSimulation.cs A BackgroundService publishing loads through the scale handles, listed below

The equipment in PackingLine.cs:

  • Scale system. CreateScaleSystemAsync builds a system with PackML and production output.
  • Checkweigher. It has products that are locked, selectable and manageable, plus an infeed feeder with a speed range and a labeler.
  • Laboratory balance. The sample sets its legal-for-trade model flag through WithLegalForTrade() and accepts kg, g and mg. This simulated configuration is not regulatory approval for a weighing instrument.
  • Counting scale. A piece-counting scale with a selected product.
  • Weighbridge. A vehicle scale whose VehicleInformationProvider answers GetVehicleInformation.
  • Batching scale. A recipe scale with a two-branch BREAD recipe and a RecipeFileHandler for uploaded recipe files.

What the simulation does:

  • Rejects about one package in ten below T1, with a BAD_PACK event and a rejected count.
  • Runs the labeler out of labels every 20 s, raising and clearing a PRINTER_FAULT alarm.
  • Drives the laboratory balance, the counting scale and a truck crossing the weighbridge.

Runtime updates. The simulation calls PublishLoad and the controller methods on the handles it kept at configuration time. Every call publishes its changes, so subscribed clients see each update without further code.

What the client shows

Code in Program.cs Shows
connection.Session.Scales(telemetry) Creating the client; registers the OPC 40200 structured types
scales.IsSupported Detecting whether the server publishes OPC 40200
DiscoverScalesAsync, EnumerateSystemScalesAsync Discovery from the DI DeviceSet and Machinery Machines, then the scales of a system
ReadSnapshotAsync → ScaleSnapshot A whole scale in one pass
ReadPackMLStateAsync The innermost active PackML state
SetTareAsync, ClearTareAsync, RegisterWeightAsync, SwitchProductAsync Driving a scale that sits inside a scale system
ObserveWeightAsync, ObserveNotificationsAsync Streaming weights, events and alarms of that nested scale

SampleSession.cs sets up the session. It keeps the ApplicationInstance alive until the session closes, because the instance owns the CertificateManager the session validates with.

Publish as NativeAOT

Both samples are NativeAOT-compatible on net10.0:

dotnet publish samples/Scales/ScalesServer -c Release -f net10.0 -r osx-arm64

Troubleshooting

Symptom Fix
Client reports BadCertificateUntrusted Pass --insecure for the demo, or trust the server certificate in the client's PKI
The server publishes no scales. Wait for the server log line Materialised scale 'BatchingScale' before starting the client
Port already in use Another server (often an earlier sample run) holds it. Stop it, or start the server with --port <n> and the client with --url opc.tcp://localhost:<n>/ScalesServer
No events or alarms while streaming Stream for at least 20 s. Rejects are random and the labeler runs out every 20 s