Files
Marc Schier 1bb4bdca1d Add Machine Vision Parts 1 and 2 (#4733)
# Description

Implement the released [OPC
40100-1](https://reference.opcfoundation.org/specs/OPC-40100-1) and [OPC
40100-2](https://reference.opcfoundation.org/specs/OPC-40100-2)
specifications with generated models, provider-backed runtimes, typed
clients, MCP workflows, and DI/Machinery integration.

- **Part 1 stays in `Opc.Ua.Vision`** and its client/server packages
alongside the distinct Perception model. Provide control/acquisition
state machines, jobs and synchronized steps,
recipe/product/configuration/result management, file transfers,
diagnostics, events, and conditions.
- **Part 2 is in `Opc.Ua.MachineVision`, `.Client`, and `.Server`.**
Provide asset categories, identification, image-handling aspects,
health/maintenance data, topology, and transactional updates. The base
Vision assemblies do not reference these optional packages; the Part 2
wire model does not depend on Part 1.
- Preserve the release-pinned model bytes, wire namespaces and NodeIds.
Perception types are in `Opc.Ua.Vision.Perception`; the AMCM generated
namespace remains `Opc.Ua.Vision.MachineVision.AMCM`, and asset
client/server extension namespaces remain `Opc.Ua.Vision.Client` and
`Opc.Ua.Vision.Server`.
- Use `AddOpcUaMachineVision` and `AddOpcUaMachineVisionAMCM` for model
loading and factory registration. Each has node-collection,
encodeable-factory-builder and node-state-factory-builder overloads.
These short entry points delegate to the generated implementations;
existing namespace-derived generated names remain available for
compatibility.
- Support multiple independent named systems/assets under one
namespace-owning manager. Reuse injectable providers, file binding,
bounded memory stores, optional transactional `IFileSystemProvider`
persistence, state machines, telemetry and conformance infrastructure.
- Keep one `docs/Vision.md` guide, titled `Machine Vision (OPC 40100-1
and OPC 40100-2)`, and one `Opc.Ua.Mcp.Vision` package. Include
deterministic server/client samples.
- Expose 17 Machine Vision MCP tools, including capabilities/status,
bounded relationships and observation, complete small-file
uploads/downloads, management, explicit control, conditions, and chunked
transfers. Catalogue counts: 39 Vision-specific, 43 with connection
tools, 81 Vision+Robotics, 155 Full. Every Machine Vision wire parameter
has a schema description.

**Compatibility and limits:** `AddVision()` remains Perception-only
unless released parts are selected. Standalone Part 2 uses
`AddVision().AddMachineVision()`; Machinery composition uses
`AddVisionToMachinery()`. Existing tool defaults and command signatures
are preserved. Observation owns and cleans up its subscription: 5
seconds/50 notifications by default, capped at 60 seconds/100
notifications. Complete-file tools are capped at 1 MiB; larger files use
chunked transfers. Domain Error values remain distinct from UA service
failures.

**Versioning:** the seven Vision/MachineVision/MCP packages and their
Debug variants follow the repository root version instead of being
forced to preview. Vision.OpenUsd and its descendants remain
preview-only. Development builds still inherit the root prerelease
version. No release version, tag, release branch, publication policy, or
feed promotion is changed.

**Review actions:** all fourteen review threads have action/evidence
replies and are resolved. Changes include the unified guide, Perception
namespace, separate Part 2 packages and final naming, multi-system
ownership explanation, interrupted-write cleanup, observer failure
isolation, complete MCP parameter descriptions, and explicit package
inventory. The preview-layout migration topic and the requested
ReleaseProcess caveat were removed. The test Publish collector now
retries recognized transient failures within one cancellation budget and
propagates other exceptions. Commit 69b1f5db9 applies the requested
short loader names and renames standalone hosting to `AddMachineVision`,
with callers, tests and documentation updated. The intervening master
merge is preserved.

### Verification

**Latest API naming changes, verified locally:**

| Scope | Result |
| --- | --- |
| Full Vision suite, net10 | 572 passed, 1 existing skip, 0 failed |
| Full Vision suite, net48 | 515 passed, 0 skipped, 0 failed |
| Final loader/hosting cases after cross-TFM null-guard adjustment | 9
passed, 0 failed, 0 skipped |
| Machine Vision MCP and profile cases | 198 passed, 0 failed, 0 skipped
|
| Main and MCP AOT test-project compilation | Both built with 0
warnings/errors |
| MCP AOT companion, managed execution | 5 passed, 0 failed, 0 skipped;
not claimed as native execution |

`ModelLoaderNamesRegisterTypedFactories`,
`ModelLoaderNamesRejectNullArguments`, and
`GeneratedModelsLoadTogetherAndCreateTypedInstances` cover all six
loader overloads, fluent return identities, typed instances, namespace
coexistence and null guards. Existing standalone Part 2 tests verify
idempotent registration, one-owner enforcement and null handling through
`AddMachineVision`. No source-generator implementation, CLR namespace,
wire identity or model payload was changed for these naming updates.

The current 69b1f5db9 revision is running
[CI](https://github.com/OPCFoundation/UA-.NETStandard/actions/runs/38165826937),
[package
validation](https://github.com/OPCFoundation/UA-.NETStandard/actions/runs/38165823359),
[MCP
usability](https://github.com/OPCFoundation/UA-.NETStandard/actions/runs/38165826874),
[CodeQL](https://github.com/OPCFoundation/UA-.NETStandard/actions/runs/38165826906),
and [Images
CI](https://github.com/OPCFoundation/UA-.NETStandard/actions/runs/38165826884).
These runs are not claimed as completed results.

**Earlier completed verification:** all seven default-TFM package
archives were inspected after the package rename: exact IDs, 27 clean
DLLs, correct dependencies/readmes/licenses, and unchanged pinned model
hashes. [CI on
c75ec4fa6](https://github.com/OPCFoundation/UA-.NETStandard/actions/runs/38142519760)
passed, including the formerly failing Linux batch and required summary.
Its unchanged coverage gate passed at **88.56% lines, 78.96% branches,
84.28% patch** against the 75% patch floor. The later
bounded-Publish-helper regressions reproduced 13 failures before the fix
and passed afterward; the full mainline triggering fixture passed 67
tests on each of net10/net48. These are historical results, not current
full-matrix results.

<details>
<summary>Executed API naming validation commands and outcomes</summary>

Run from the worktree root using the established artifact trees.
Dependency builds were performed before the no-build full net10 run; the
focused loader/hosting selection was rebuilt and rerun after the final
null-guard adjustment.

```powershell
$files = 'C:\Users\mschier\.copilot\session-state\deb2ba10-b0e9-4a44-8783-8331bc850814\files'
$env:DOTNET_CLI_USE_MSBUILD_SERVER = '0'
$env:TEMP = 'C:\Temp\mv-deb2\followup'
$env:TMP = $env:TEMP

# Passed: 572; Failed: 0; Skipped: 1.
dotnet test tests\Opc.Ua.Vision.Tests\Opc.Ua.Vision.Tests.csproj -c Release -f net10.0 --no-build --no-restore --artifacts-path artifacts\vision-followup -p:CustomTestTarget=net10.0 -p:UseSharedCompilation=false -m:1 -nr:false --logger 'console;verbosity=minimal' --logger trx --results-directory "$files\vision-api-names-net10" -- 'NUnit.WorkDirectory=C:\Temp\mv-deb2\followup'

# Passed: 9; Failed: 0; Skipped: 0, on the final source.
dotnet test tests\Opc.Ua.Vision.Tests\Opc.Ua.Vision.Tests.csproj -c Release -f net10.0 --no-restore --artifacts-path artifacts\vision-followup -p:CustomTestTarget=net10.0 -p:UseSharedCompilation=false -m:1 -nr:false --filter 'FullyQualifiedName~MachineVisionModelTests|FullyQualifiedName~StandalonePartTwoRegistrationUsesOneOwnerAndOneModelProvider|FullyQualifiedName~StandalonePartTwoRequiresRegistrationAndRejectsCompetingOwnership' --logger 'console;verbosity=minimal' --logger trx --results-directory "$files\vision-api-names-final-model" -- 'NUnit.WorkDirectory=C:\Temp\mv-deb2\followup'

# Passed: 198; Failed: 0; Skipped: 0.
dotnet test tests\Opc.Ua.Tools.Tests\Opc.Ua.Tools.Tests.csproj -c Release -f net10.0 --no-restore --artifacts-path artifacts\vision-followup -p:CustomTestTarget=net10.0 -p:UseSharedCompilation=false -m:1 -nr:false --filter 'FullyQualifiedName~VisionMachineToolsTests|FullyQualifiedName~McpHostBuilderTests|FullyQualifiedName~McpToolProfileCompositionTests' --logger 'console;verbosity=minimal' --logger trx --results-directory "$files\vision-api-names-final-mcp" -- 'NUnit.WorkDirectory=C:\Temp\mv-deb2\followup'

$env:TEMP = 'C:\Temp\mv-deb2\followup48'
$env:TMP = $env:TEMP

# Passed: 515; Failed: 0; Skipped: 0.
dotnet test tests\Opc.Ua.Vision.Tests\Opc.Ua.Vision.Tests.csproj -c Debug -f net48 --no-restore --artifacts-path "$files\solution-net48-artifacts" -p:CustomTestTarget=net48 -p:UseSharedCompilation=false -m:1 -nr:false --logger 'console;verbosity=minimal' --logger trx --results-directory "$files\vision-api-names-net48-final" -- 'NUnit.WorkDirectory=C:\Temp\mv-deb2\followup48'
```

Opt-in long-running/stress/durable tiers have not been rerun locally;
the unqualified **all tests** checklist item remains open. Original
implementation matrix counts are not presented as current results.

</details>

## Related Issues

- Fixes #4732.

The requester reviewed and approved the implementation plan and
subsequent packaging/API decisions in the development session. The
tracking issue records the design; maintainer architectural
discussion/sign-off there is still pending. This PR remains a draft.

## 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.
- [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.
2026-10-12 07:01:27 +00:00

165 lines
8.6 KiB
C#

/* ========================================================================
* Copyright (c) 2005-2026 The OPC Foundation, Inc. All rights reserved.
*
* OPC Foundation MIT License 1.00
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*
* The complete license agreement can be found here:
* http://opcfoundation.org/License/MIT/1.00/
* ======================================================================*/
using System;
using System.IO;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using Opc.Ua;
using Opc.Ua.Client;
using Opc.Ua.Client.StateMachines;
using Opc.Ua.Vision.Client;
using Opc.Ua.Vision.MachineVision;
HostApplicationBuilder builder = Host.CreateApplicationBuilder(args);
string url = builder.Configuration["endpoint"] ?? "opc.tcp://localhost:62550/MachineVision";
string? insecureOption = builder.Configuration["insecure"];
bool insecure = false;
if (insecureOption != null && !bool.TryParse(insecureOption, out insecure))
{
throw new ArgumentException("--insecure requires true or false.", nameof(args));
}
ITelemetryContext telemetry = DefaultTelemetry.Create(logging => logging.SetMinimumLevel(LogLevel.Warning));
using var cancellation = new CancellationTokenSource(TimeSpan.FromSeconds(60));
CancellationToken ct = cancellation.Token;
EndpointDescription? selected = null;
using (DiscoveryClient discovery = await DiscoveryClient.CreateAsync(new Uri(url), telemetry, ct: ct)
.ConfigureAwait(false))
{
GetEndpointsResponse endpoints = await discovery.GetEndpointsAsync(null, url, [], [], ct).ConfigureAwait(false);
foreach (EndpointDescription endpoint in endpoints.Endpoints)
{
if (endpoint.SecurityMode == MessageSecurityMode.SignAndEncrypt &&
endpoint.SecurityPolicyUri == SecurityPolicies.Basic256Sha256)
{
selected = endpoint;
break;
}
}
}
if (selected == null)
{
throw new InvalidOperationException("The demonstrator requires a Basic256Sha256 SignAndEncrypt endpoint.");
}
builder.Services.AddOpcUa().AddClient(options =>
{
options.ApplicationName = "MachineVisionClient";
options.ApplicationUri = "urn:localhost:OPCFoundation:MachineVisionClient";
options.PkiRoot = builder.Configuration["pki"] ?? Path.Combine(
Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData),
"OPCFoundation", "MachineVisionClient", "pki");
options.AutoAcceptUntrustedCertificates = insecure;
options.Session = new ManagedSessionOptions
{
Endpoint = new ConfiguredEndpoint(null, selected, null),
SessionName = "MachineVisionClient"
};
}).AddVisionClient();
using IHost host = builder.Build();
VisionClient vision = await host.Services.GetRequiredService<Func<CancellationToken, Task<VisionClient>>>()(ct)
.ConfigureAwait(false);
if (vision.Session is not ManagedSession session)
{
throw new InvalidOperationException("The client factory did not provide a managed session.");
}
await using (session.ConfigureAwait(false))
{
MachineVisionClient client = vision.MachineVision();
await foreach (VisionNodeEntry entry in client.EnumerateSystemsAsync(cancellationToken: ct).ConfigureAwait(false))
{
Console.WriteLine($"System {entry.BrowseName}: {entry.NodeId}");
MachineVisionSystemClient system = client.System(entry.NodeId);
VisionStateMachineTypeClient control = await system.ControlAsync(ct).ConfigureAwait(false);
FiniteStateSnapshot state = await control.GetCurrentFiniteStateAsync(ct).ConfigureAwait(false);
if (state.CurrentState.Text == "Preoperational")
{
MachineVisionSystemClient.ThrowIfDomainError(
await control.SelectModeAutomaticAsync(ct).ConfigureAwait(false),
"SelectModeAutomatic");
}
using var recipeContent = new MemoryStream(Encoding.UTF8.GetBytes("deterministic-inspection-recipe"));
RecipeIdInternalDataType recipe = await system.UploadRecipeAsync(
new RecipeIdExternalDataType { Id = "sample-recipe" },
new ProductIdDataType { Id = "sample-product" }, recipeContent, ct).ConfigureAwait(false);
RecipeManagementTypeClient recipes = await system.RecipesAsync(ct).ConfigureAwait(false);
var prepared = await recipes.PrepareRecipeAsync(new RecipeIdExternalDataType(), recipe, ct)
.ConfigureAwait(false);
MachineVisionSystemClient.ThrowIfDomainError(prepared.error, "PrepareRecipe");
VisionAutomaticModeStateMachineTypeClient automatic = await system.AutomaticAsync(ct).ConfigureAwait(false);
var started = await automatic.StartSingleJobAsync(
new MeasIdDataType { Id = "sample-measurement" }, new PartIdDataType(),
new RecipeIdExternalDataType { Id = "sample-recipe" },
new ProductIdDataType { Id = "sample-product" }, [], ct).ConfigureAwait(false);
MachineVisionSystemClient.ThrowIfDomainError(started.error, "StartSingleJob");
await automatic.WaitForStateAsync(
session.DefaultStreaming,
NodeId.Create(VisionAutomaticModeStateMachineTypeIds.StateIds.Ready,
Opc.Ua.Vision.MachineVision.Namespaces.MachineVision, session.NamespaceUris),
TimeSpan.FromSeconds(15), ct: ct).ConfigureAwait(false);
ResultManagementTypeClient results = await system.ResultsAsync(ct).ConfigureAwait(false);
var page = await results.GetResultListFilteredAsync(
0, new MeasIdDataType(), new PartIdDataType(), new RecipeIdExternalDataType(),
new RecipeIdInternalDataType(), new ConfigurationIdDataType(), new ConfigurationIdDataType(),
new ProductIdDataType(), started.jobId, 10, 0, 0, ct).ConfigureAwait(false);
MachineVisionSystemClient.ThrowIfDomainError(page.error, "GetResultListFiltered");
foreach (ResultDataType result in page.resultList)
{
Console.WriteLine(
$"Result {result.ResultId.Id}: state={result.ResultState}, simulated={result.IsSimulated}");
}
MachineVisionSystemClient.ThrowIfDomainError(
await results.ReleaseResultHandleAsync(page.resultHandle, ct).ConfigureAwait(false), "ReleaseResultHandle");
ArrayOf<NodeId> pipelines = await vision.DiscoverPipelinesAsync(ct).ConfigureAwait(false);
if (!pipelines.IsEmpty)
{
string sharedId = await vision.Pipeline(pipelines[0]).RunInferenceAsync(cancellationToken: ct)
.ConfigureAwait(false);
var shared = await results.GetResultByIdAsync(new ResultIdDataType { Id = sharedId }, 0, ct)
.ConfigureAwait(false);
MachineVisionSystemClient.ThrowIfDomainError(shared.error, "GetResultById");
Console.WriteLine($"Draft and released models share result {shared.result.ResultId.Id}.");
MachineVisionSystemClient.ThrowIfDomainError(
await results.ReleaseResultHandleAsync(shared.resultHandle, ct).ConfigureAwait(false),
"ReleaseResultHandle");
}
}
await foreach (VisionNodeEntry asset in client.EnumerateAssetsAsync(cancellationToken: ct).ConfigureAwait(false))
{
MachineVisionAssetSnapshot snapshot = await client.ReadAssetAsync(asset.NodeId, cancellationToken: ct)
.ConfigureAwait(false);
Console.WriteLine($"Asset {asset.BrowseName}: {snapshot.Values.Count} values, complete={snapshot.IsComplete}");
}
await session.DefaultStreaming.DisposeAsync().ConfigureAwait(false);
await session.CloseAsync(ct).ConfigureAwait(false);
}