mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-16 21:02:51 +08:00
Marc Schier
0374e19121
# Description _Describe the changes here to communicate to the maintainers why they should accept this pull request. By default - this will become the Commit message after merging and thus define history._ Add provider-backed MachineTool, bundled WMTP, GMS and CranesHoists companions using the existing Machinery/MachineVision fluent, DI and typed-client approach. **The PR is open/non-draft by user choice. Current head `ecc4a7d6ca3e8004cf28ab54da605da302d026bf` is mergeable and has 108 successful checks, six intentionally skipped checks, zero failures and zero pending checks. All five primary workflows completed successfully at that exact head.** | Family | Released specification/model | Packaging | | --- | --- | --- | | MachineTool | OPC 40501-1, 1.02.0 | Model, Server, Client and MCP; normal root versions | | WMTP | OPC 40505, 1.0.0 | Bundled in MachineTool; distinct CLR/wire namespace and independent WMTP-only hosting | | GMS | OPC 40210 reference 1.0.1, normative model 1.0.0 | Model, Server, Client and MCP; normal root versions | | CranesHoists | OPC 40020-1, 1.00 | Model, Server, Client and MCP; all four plus Debug variants forced preview | There are **12 new packable projects**. No separate WMTP package/profile/guide, root version bump, tag, release or package publication is included. Mandatory instance structure is the default; selected optional features require explicit providers. The implementation reuses Machinery results/jobs/files/ProcessValues and Robotics topology, including retained MachineTool Production, defined GMS jobs/parts, modern ISA95/Machinery jobs, shared-owner hosting and isolated instances alongside MachineVision. Runtime and integration fixes preserve raw quality/timestamps, coherent acquisition, namespace ownership, accepted-configuration state, borrowed-resource lifetime, session/node/file cleanup, terminal-value publication, event propagation and endpoint-aware capability publication. Firmware/licence transfer means provider acceptance, not installation/activation. Cancellation does not silently abort another caller's operation. The later upstream MCP expansion is integrated without losing either family set or its default-off privileged/live execution policy. ### Conformance and scope Canonical model inputs are pinned to UA-Nodeset revision `96a08945425d0295edb3607d2a38f6841ef44046`. **GMS upstream exception:** [Annex A.1](https://reference.opcfoundation.org/specs/OPC-40210/annex-a) makes the released NodeSet normative, but §12.3.2.7 requires undefined `GMS_ProductionStatisticsType`. Inherited statistics and defined jobs/parts are implemented without inventing a standard type/NodeId; the complete GMS Production facet is withheld. The requirement ledger records **102 positively evidenced CU rows, 96 directly negative-tested rows and six explicit negative-evidence limitations**. All 648 test-class/name/TRX links were independently resolved to passing cases. The six limitations concern Stacklight, retained legacy PowerOnDuration, Machinery PowerOnDuration, WorkingUnit, Obligation and MaintenanceMode. They are not claims that every invalid-input or hardware-control behavior was tested. The undefined GMS requirement is outside the 102 defined CUs. No external certification claim is made. Retained baseline complete-assembly line coverage, with generated code retained and no source exclusions: | Family | Model | Server | Client | | --- | ---: | ---: | ---: | | MachineTool/WMTP | 83.80% | 91.98% | 84.74% | | GMS | 95.51% | 90.63% | 88.38% | | CranesHoists | 92.76% | 94.45% | 92.24% | These nine measurements predate the later focused review fixes and merges; they are not relabelled as new `ecc4a7d6c` percentages. The current head's separate CI code-coverage check succeeded. No new exclusions or threshold relaxations were introduced. ## Related Issues - Fixes [#4764](https://github.com/OPCFoundation/UA-.NETStandard/issues/4764), the implementation/design and acceptance tracker. ## 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. - [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. - [ ] 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. - [x] I have addressed **all** PR feedback received.
124 lines
6.6 KiB
Markdown
124 lines
6.6 KiB
Markdown
# Sample applications
|
|
|
|
This repository contains a large collection of platform-independent samples
|
|
that demonstrate the stack's client, server, PubSub, companion-model, and
|
|
developer-tooling APIs. Each sample has its own `README.md` with build and run
|
|
instructions. If you are new to the SDK, start with the
|
|
[minimal samples](#minimal-samples).
|
|
|
|
## Contents
|
|
|
|
- [Minimal samples](#minimal-samples)
|
|
- [Reference applications](#reference-applications)
|
|
- [PubSub samples](#pubsub-samples)
|
|
- [Companion-model samples](#companion-model-samples)
|
|
- [OpenUSD site composition](#openusd-site-composition)
|
|
|
|
## Minimal samples
|
|
|
|
[Getting started](GettingStarted.md) runs the Minimal Boiler Server and the
|
|
Minimal Client together.
|
|
|
|
- [Minimal Boiler Server](../samples/MinimalApi/MinimalBoilerServer) — minimal
|
|
Boiler-model server with the fluent state-machine builder; Native-AOT
|
|
publishable.
|
|
- [Minimal Client](../samples/MinimalApi/MinimalClient/README.md) — hosted
|
|
client that discovers a secure endpoint of the Minimal Boiler Server, creates
|
|
a subscription, browses, and reads; Native-AOT publishable.
|
|
- [Minimal Calc Server](../samples/MinimalApi/MinimalCalcServer) — minimal
|
|
server built on the source-generated NodeManager pipeline and Calc model.
|
|
|
|
## Reference applications
|
|
|
|
- [Console Reference Server](../samples/Reference/ConsoleReferenceServer/README.md) —
|
|
the certified reference server with Quickstarts, CTT, and Mono
|
|
configurations. It also ships as a
|
|
[Docker container](ContainerReferenceServer.md).
|
|
- [Console Reference Client](../samples/Reference/ConsoleReferenceClient/README.md) —
|
|
cross-platform reference client demonstrating sessions, subscriptions,
|
|
browsing, and method calls.
|
|
- [Console LDS Server](../samples/Lds/ConsoleLdsServer) — a standalone
|
|
Local Discovery Server built on `Opc.Ua.Lds.Server`.
|
|
|
|
## PubSub samples
|
|
|
|
- [Console Reference PubSub Client](../samples/PubSub/ConsoleReferencePubSubClient/README.md) —
|
|
one executable with `publisher`, `subscriber`, and `external`
|
|
external-server-adapter modes across the supported transport profiles.
|
|
|
|
## Companion-model samples
|
|
|
|
- [Generic recycling simulation](../samples/Recycling/README.md) — one durable causal coordinator
|
|
and ten process views with typed OPC UA coordination, native companion equipment,
|
|
material genealogy and read-only committed measurements. The guide distinguishes synthetic
|
|
simulation from calibration, original-source parity and formal companion certification.
|
|
- [Pump Device Integration Server](../samples/DI/PumpDeviceIntegrationServer/README.md) —
|
|
Device Integration Part 100 server using `Opc.Ua.Di.Server`'s fluent
|
|
builder.
|
|
- [AMB Server](../samples/AMB/README.md) — OPC 10000-110 Asset Management
|
|
Basics with `AddAssetManagement` next to `AddMachinery`: a cooling pump and
|
|
a flow sensor (Device Integration devices) and a hydraulic press (a
|
|
Machinery machine) as assets with configurable AssetIds, health alarms with
|
|
root causes, maintenance activities, documentation links, locations and
|
|
persistence, and a simulation that raises alarms and moves the maintenance
|
|
on.
|
|
- [AMB Client](../samples/AMB/README.md) — discovers every asset with
|
|
`AmbClient`, prints snapshots and the location hierarchies, adds and removes
|
|
a documentation link, and streams health alarms and maintenance activities.
|
|
- [Minimal Robot Server](../samples/Robotics/MinimalRobotServer/README.md) —
|
|
OPC 40010 Robotics with independently configurable RSL/GPOS motion and
|
|
live OpenUSD transforms.
|
|
- [Intent Enabled Robot](../samples/Robotics/IntentEnabledRobot/README.md) —
|
|
collaborative arm exposing task-level Robot Intent motion verbs, Part 10
|
|
program lifecycle, missions, command authority, and safety-aware refusal.
|
|
- [Intent Viewer Client](../samples/Robotics/IntentViewerClient/README.md) —
|
|
click a target in an OpenUSD viewport and watch the arm execute the
|
|
resulting intent; it also runs headless.
|
|
- [Bin Picking Cell](../samples/Robotics/BinPickingCell/README.md) — Robot
|
|
Intent, Vision, an eye-in-hand camera, and an in-address-space OpenUSD scene
|
|
in one reference cell.
|
|
- [Bin Picking Client](../samples/Robotics/BinPickingClient/README.md) — closes
|
|
the Vision-to-Robot-Intent loop, with optional MCP hosting and an OpenUSD
|
|
viewport.
|
|
- [Visual Inspection Cell](../samples/Vision/VisualInspectionCell/README.md) —
|
|
hosts Vision, AI Model Management, ISA-95 Job Control V2, and an operator
|
|
dialog for deterministic machined-bracket inspection.
|
|
- [Visual Inspection Agent](../samples/Vision/VisualInspectionAgent/README.md) —
|
|
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](../samples/AI/README.md) —
|
|
`ModelManagementServer` publishes the draft AI Model Management catalogue
|
|
and routes inference; `ModelManagementClient` discovers deployments and
|
|
exercises the Methods.
|
|
- [Machine Vision server](../samples/Vision/MachineVisionServer/README.md) and
|
|
[client](../samples/Vision/MachineVisionClient/README.md) — released OPC 40100-1/-2
|
|
in Machinery, with recipe/file workflows and a shared draft/native inspection engine.
|
|
- [MachineTool and WMTP](../samples/MachineTool/) — separate or combined
|
|
MachineTool/peripheral hosting, independent simulated instances, retained and
|
|
modern production, remote files, measurement configuration and record workflows.
|
|
- [GMS server and client](../samples/GMS/) — native systems, qualification,
|
|
environmental conditions and typed result/characteristic/correction workflows.
|
|
- [Cranes and Hoists](../samples/CranesHoists/) — Robotics-derived topology,
|
|
acquisition quality and authorized simulated limit requests.
|
|
- [Combined companion suite](../samples/CompanionSuite/) — MachineTool, WMTP,
|
|
GMS, CranesHoists and MachineVision on one DI/Machinery owner, with isolated
|
|
instances and a bounded real-session self-check.
|
|
- [Minimal ISA-95 Server](../samples/Isa95/MinimalIsa95Server/README.md) —
|
|
hosts the OPC-10030 ISA-95 Common Model with OPC-10031-4 Job Control V1 and
|
|
V2, using the typed common-model builder and in-memory Job Control provider.
|
|
|
|
## OpenUSD site composition
|
|
|
|
- [Generator Server](../samples/OpenUsd/GeneratorServer/README.md) — simulated
|
|
generating sets with datasheet-driven behavior and independent OpenUSD
|
|
twins.
|
|
- [Site Composition Server](../samples/OpenUsd/SiteCompositionServer/README.md) —
|
|
federates the pump and generator servers into one live OpenUSD site.
|
|
|
|
Run the complete site demo from the repository root:
|
|
|
|
```powershell
|
|
pwsh samples/OpenUsd/SiteCompositionServer/run-site-composition-demo.ps1
|
|
```
|