Alexander Köpke
fb4eece24d
# 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._
Fix OpenUSD sample discovery and integrate artifact delivery with the
xRegistry companion model.
- Load xRegistry before OpenUSD in the sample node managers, mount
stages with `Organizes`, and align root-layer identifiers with served
`.usda` files.
- Bootstrap immutable logical Resources and exact Versions in
`Artifacts`. Stage `Assets` folders provide non-owning `Organizes`
views, and explicit container identifiers allow sharing.
- Update the binding model to draft 0.9.0 while preserving existing
NodeIds and the `HasAddIn` correction.
- Disambiguate default container identifiers by stage instance, publish
the required read-only capabilities map, and preserve standard and
xRegistry BrowseName namespaces.
- Add registry, file-delivery, sharing, collision, qualified-browse, and
live-discovery regressions. Update the OpenUSD documentation.
Review fixes are in 6ac47a5b82. All four
review threads have been answered and resolved.
**Local validation**
| Command | Result |
| --- | --- |
| `dotnet test tests/Opc.Ua.OpenUsd.Tests/Opc.Ua.OpenUsd.Tests.csproj
--no-restore -f net10.0 -p:CustomTestTarget=net10.0 --verbosity quiet` |
Passed: 1,178 tests. |
| `dotnet test tests/Opc.Ua.OpenUsd.Tests/Opc.Ua.OpenUsd.Tests.csproj -f
net48 -p:CustomTestTarget=net48 --filter
FullyQualifiedName~UsdAssetDeliveryTests --verbosity quiet` | Passed: 36
focused regressions, including build and dependency restore. |
| `dotnet test tests/Opc.Ua.OpenUsd.Tests/Opc.Ua.OpenUsd.Tests.csproj
--no-build --no-restore -f net48 -p:CustomTestTarget=net48 --verbosity
quiet` | Failed: 937 passed; five generator integration tests failed
during fixture setup because Mono does not implement
`ECDsa.Create(ECCurve)`. |
The full `UA.slnx` suite and coverage measurement were not run locally.
## Related Issues
_Reference all GitHub issues this PR addresses. If there is no issue
yet, open one and link it here._
_If this is a relatively large or complex change, a design must have
been discussed in the related tracking issue and signed off (which
becomes the Architectural Decision Record (ADR))._
No linked tracking issue.
## 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.
- [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.
- [x] I have addressed **all** PR feedback received.
SiteCompositionServer
A supervisory OPC UA server that owns no devices and composes the machines of several subordinate servers into a single live 3D scene.
This is the SCADA-level counterpart to a device server. Where
PumpDeviceIntegrationServer and
GeneratorServer each
publish their own machines and their own twin, this server publishes a site and
says which server owns what.
What it demonstrates
flowchart TD
C["Opc.Ua.OpenUsd.Connector<br/>--federate"]
S["SiteCompositionServer<br/>site shell + camera<br/>owns no devices"]
P["PumpDeviceIntegrationServer<br/>pumps"]
G["GeneratorServer<br/>generator sets"]
C -->|"primary session"| S
S -.->|"ComponentEndpointUrl"| P
S -.->|"ComponentEndpointUrl"| G
C ==>|"federated session"| P
C ==>|"federated session"| G
C --> STAGE[["one live stage<br/>machines from three servers"]]
The site server declares one cross-server component binding per subordinate,
carrying that server's ComponentServerUri and ComponentEndpointUrl. A
connector run with --federate opens a session to each named server, discovers
its representations and drives its bindings into the same stage.
Nothing is mirrored. The site server never proxies a subordinate's address space: it only says where the machines are and lets the connector talk to each owner directly, so there is no cache to invalidate and no second copy of the truth.
Running it
The demo script builds the three servers, publishes the connector and viewport side by side, waits for every endpoint, and cleans up when the viewer closes:
pwsh samples/OpenUsd/SiteCompositionServer/run-site-composition-demo.ps1
Use -Renderer D3D12, -PumpCount, -GeneratorCount, or -Keep to override
the defaults. -ViewerBundlePath can point at an already published connector
and viewport directory.
To start each process manually, start the two device servers, then the site server:
dotnet run --project samples/Di/PumpDeviceIntegrationServer -- --host localhost --port 62542 --pumps 3
dotnet run --project samples/OpenUsd/GeneratorServer -- --host localhost --port 62543 --generators 2
dotnet run --project samples/OpenUsd/SiteCompositionServer -- --host localhost --port 62544
Then render the composed site:
dotnet run --project tools/Opc.Ua.OpenUsd.Connector -- \
--server opc.tcp://localhost:62544/SiteCompositionServer \
--insecure --federate --view
--pump-server and --generator-server override the subordinate endpoints.
Why --federate is opt-in
The endpoint the connector dials comes from the server being rendered, not from the operator, so honouring it is a trust decision — a server could name any endpoint it likes. The client library is fail-closed (no session factory, no federation) and the command-line connector mirrors that behind an explicit flag. Federated sessions are negotiated exactly the way the primary session is, so composing a subordinate cannot quietly downgrade security.
Federation is also best-effort per component: a subordinate that is down, unreachable or refuses the session is logged and skipped. The rest of the scene still renders and only that server's machines are missing, because one unreachable subordinate taking down the whole stage would be a poor trade.
What lands where
Each subordinate's machines compose at the prim paths that subordinate
publishes — the pump server's pumps under /Plant/..., the generator server's
sets under /Powerhouse/... — because the remote connector drives that server's
own representation. The /Site/PumpHall and /Site/Powerhouse scopes in
Site.usda are the site's own placeholders for those areas.
A verified run against three servers produces one override layer containing:
| From | In the stage |
|---|---|
| Pump server | /Plant/Pumps/… with live impeller rotation and casing colour |
| Generator server | /Powerhouse/Generators/GeneratorSet_1…N with frequency, power, engine hours, fan rotation and thermal colour |
| Site server | /Site/… shell, lighting and the control-room camera |
Files
| File | Purpose |
|---|---|
SiteNodeManager.cs |
Site topology, OpenUSD facility, cross-server component bindings |
Assets/Site.usda |
Ground, building slabs, lighting, control-room camera — deliberately no machine geometry |
Program.cs |
Host wiring and endpoint arguments |