## Summary
### Documentation
- Stage the documentation index as a learning path: a first application,
independent client, server, and PubSub paths, then data and services,
companion models, production, advanced integration, and draft or
experimental capabilities.
- Add Getting started (repository samples or NuGet packages), OPC UA
concepts, Your first information model, and a production readiness
checklist.
- Add Native AOT application publishing, a first PubSub publisher and
subscriber exchange, and the UDP transport options.
- Add or expand contents navigation throughout `docs/`, and keep
contributor documentation separate.
- Correct outdated SDK examples and capability guidance, consolidate
repeated explanations into canonical guides, and repair local links and
heading structure.
- Rewrite What's New in 2.0 as a concise feature overview with short
linked details; keep migration instructions in the Migration Guide.
- Expand the feature catalogue with specification IDs, GDS, LDS, the OPC
10000-21 onboarding registrar, ISA-95, xRegistry, OpenUSD, and
sample-local models; distinguish draft status, explain crypto
pluggability, and bring performance guidance forward.
- Address review feedback on wording, active monitored items during
shadow reload, and the `Samples.md` filename and references.
- Regenerate the `opcua-v20-migration` plugin's bundled copy of the
migration guides so it matches the edited `docs/migrate/2.0.x` guides.
- Merge the latest `master`, preserving upstream resource-isolation
guidance within the task-based documentation index.
- Retain deferred Lingity findings where appropriate; this PR does not
claim that every document meets the Lingity score thresholds.
### Fixes found while verifying the guides
Each fix has regression tests that fail without it.
- **Client:** V2 subscriptions compared their lifetime with the
operation timeout instead of the session timeout, and logged a spurious
warning. `ISubscriptionEngineContext`, which is new in 2.0, gains a
`SessionTimeout` property; implementations must add it.
- **PubSub:** a subscriber now registers the `DataSetMetaData`
configured on its readers (OPC 10000-14 6.2.9.4), and the UADP decoder
decodes DataSetMessages that carry no ConfigurationVersion. Before, a
secured subscriber of the reference sample received no DataSets.
- **Source generator:** a ModelDesign method that declares its arguments
inline, without a method type, produced code that did not compile; it
now uses `MethodState`. The generated code of existing models is
unchanged.
- **MinimalClient sample:** waits for its first data-change notification
before it disconnects.
### Known issues, not addressed here
- UDP multicast: the publisher does not send on the interface that the
subscriber joins, and `MulticastLoopback` defaults to false. The PubSub
guide uses unicast for the exchange on one computer.
- The UDP metadata announcement is sent unsecured on secured writer
groups; a secured subscriber drops it with a warning.
- A server does not start in globalization-invariant mode, because
`ResourceManager` creates `CultureInfo("en-US")`. The Native AOT guide
cautions against the mode.
## Validation
- `git diff --check` and
`./.azurepipelines/validate-migration-plugin.ps1` (15 bundled migration
docs validated, plugin manifests synchronized).
- Local Markdown links, anchors, file-link casing, and contents lists
checked across all 87 documents under `docs/`. The index links every
top-level guide and every target of the previous index.
- Both Getting started routes, Your first information model, the PubSub
exchange, and the Native AOT publish of the Getting started client and
server were run as documented. The NuGet route and the tutorial use the
public `2.0.0-preview.5` packages.
- The changed libraries build for all target frameworks in Release
without warnings.
- Tests on .NET 10: Opc.Ua.SourceGeneration.Tests 199 passed;
Opc.Ua.SourceGeneration.Core.Tests 3,977 passed, 8 skipped;
Opc.Ua.Server.Tests `Fluent` category 621 passed; Opc.Ua.Client.Tests
subscription-engine tests 70 passed; Opc.Ua.PubSub.Tests 1,374 passed, 2
skipped; PubSub fuzz replay 145 passed. The new and affected tests also
pass on .NET Framework 4.8.
- Earlier merge validation: 174 resource-isolation tests passed on .NET
10.
- The full solution suite was not run locally.
Review and validation artifacts are maintained outside the repository.
---------
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
56 KiB
Vision developer guide
This guide documents the Opc.Ua.Vision, Opc.Ua.Vision.Server,
Opc.Ua.Vision.Client, Opc.Ua.Vision.OpenUsd and Opc.Ua.Mcp.Vision package
family — the .NET implementation of the working-group draft OPC UA — Vision
companion specification, plus the OpenUSD offscreen capture adapter and the
Model Context Protocol tool package that lets a language-model agent see through
a Vision server and act on what it sees.
Contents
- Packages
- Two perception paths behind one contract
- Minimal hosted server
- Hosting API
- Build context
- Topology builders
- §5.12 conventions
- §6.4 media gating
- Rendering without pixels
- Facets supported
- Using the client libraries
- MCP tools
- Sample: bin-picking
- Limitations
- Visual inspection: a cross-companion cell
- See also
Draft. The namespace
http://opcfoundation.org/UA/Vision/and every NodeId in it are provisional. The API is stable within this repository but every ObjectType, DataType and BrowseName can still change when the specification is published.
Vision layers on top of the base OPC UA namespace only — it does not require
Devices, Machinery or Robotics. It composes cleanly with Robotics, as shown in the
samples/Robotics/BinPickingCell and
samples/Robotics/BinPickingClient
samples (Vision + Robot Intent in one server, vision_* +
robotics_* MCP tools in one agent).
Packages
| Package | What it gives you | Depends on |
|---|---|---|
OPCFoundation.NetStandard.Opc.Ua.Vision |
Source-generated Vision model — ObjectTypes, ReferenceTypes, DataTypes, enums, node states, typed client proxies, AddOpcUaVision model loader |
Opc.Ua.Core |
OPCFoundation.NetStandard.Opc.Ua.Vision.Server |
VisionNodeManager, IVisionBuildContext, fluent topology builders, IVisionMediaProvider / IVisionInferenceProvider / IVisionFeedbackSink, facet derivation, AddVision / ConfigureVision hosting extensions |
Opc.Ua.Vision, Opc.Ua.Server |
OPCFoundation.NetStandard.Opc.Ua.Vision.Client |
VisionClient discovery, VisionSensorClient, VisionPipelineClient, VisionResultReader, VisionMediaClient, VisionFrameGraph, VisionFeedbackClient, session.Vision(...) extension, AddVisionClient() DI |
Opc.Ua.Vision, Opc.Ua.Client |
OPCFoundation.NetStandard.Opc.Ua.Vision.OpenUsd |
ISceneCameraCaptureProvider implementation that renders a UsdGeomCamera offscreen and reports NoRenderingBackend gracefully when no graphics device is available |
Opc.Ua.Types, native OpenUSD renderer payload (optional per-RID) |
OPCFoundation.NetStandard.Opc.Ua.Mcp.Vision |
22 MCP tools split across discovery, monitoring, seeing, inference, feedback and geometry, plus the vision bounded profile and composition entry point |
Opc.Ua.Mcp.Core, Opc.Ua.Vision.Client |
graph TD
Model["Opc.Ua.Vision<br/>source-generated model"]
Server["Opc.Ua.Vision.Server<br/>VisionNodeManager + builders"]
Client["Opc.Ua.Vision.Client<br/>typed discovery and readers"]
OpenUsd["Opc.Ua.Vision.OpenUsd<br/>scene-camera capture provider"]
Mcp["Opc.Ua.Mcp.Vision<br/>agent tools"]
Media["IVisionMediaProvider"]
Inference["IVisionInferenceProvider"]
Feedback["IVisionFeedbackSink"]
Model --> Server
Model --> Client
Client --> Mcp
OpenUsd -.->|captures frames for| Media
Media -.->|plugs into| Server
Inference -.->|plugs into| Server
Feedback -.->|plugs into| Server
Opc.Ua.Vision.OpenUsd deliberately sits outside that dependency chain: it
depends on Opc.Ua.Types alone and knows nothing about the Vision server. It
offers a camera, and a host writes the IVisionMediaProvider that hands the
resulting frames to a pipeline — which is what
BinPickingCell does. A host with a real
camera writes the same interface over its own SDK and never references OpenUSD
at all.
The runtime address space is rooted under the standard Server object. Configurators add frames, sensors and pipelines through the fluent builder; providers plug into the sensor or pipeline nodes that the builder creates.
flowchart TD
ServerObj["Server"] --> VisionRoot["Vision<br/>VisionRootType"]
VisionRoot --> Sensors["Sensors"]
VisionRoot --> Frames["Frames"]
VisionRoot --> Pipelines["Pipelines"]
Frames --> Frame["CoordinateFrameType<br/>FrameId + Transform"]
Sensors --> Sensor["VisionSensorType<br/>ImageSensorType / Depth3DSensorType"]
Sensor --> Calibrations["Calibrations"]
Calibrations --> Intrinsic["IntrinsicCalibrationType"]
Calibrations --> Extrinsic["ExtrinsicCalibrationType"]
Sensor --> Media["Media<br/>VisionMediaManagementType"]
Media --> Streams["StreamEndpoints"]
Media --> Clips["ClipEndpoints"]
Sensor -.->|MountedOn| Frame
Sensor -.->|HasScenePrim| Scene["OpenUSD scene prim"]
Pipelines --> Pipeline["InferencePipelineType"]
Pipeline --> Results["Results"]
Pipeline --> Feedback["Feedback<br/>VisionFeedbackType"]
Pipeline -.->|Sensor| Sensor
Pipeline -.->|Deployment| Deployment["AI deployment NodeId"]
The libraries multi-target net8.0;net9.0;net10.0 and netstandard2.0
where applicable; the MCP tool package multi-targets net8.0;net9.0;net10.0.
Two perception paths behind one contract
Every pipeline advertises exactly one of two inference locations, and a
client reads a DetectionResultType identically regardless of which is in
force:
InferenceLocation = OnServer— the Server holds anIVisionInferenceProviderand computes results locally. This is the deterministic path: it needs no model, no network and no GPU, and it is the default for CI and offline validation.RunInference,StartContinuousandStopall delegate to the provider; the Server publishes the resultingDetectionResultType/InspectionResultType/SegmentationResultTypeunder the pipeline'sResultsfolder and advertisesVIS-Inference-OnServer.InferenceLocation = EdgeOffServer— the pipeline exposes aVisionFeedbackTypeobject bound to anIVisionFeedbackSink; an off-Server agent (a vision-language model over MCP, an edge inference service, another Server) is expected to look at the current frame and callSubmitDetections/SubmitInspectionResult/SubmitCorrection/SubmitImageReference. The Server publishes those results into the address space unchanged, and advertisesVIS-Inference-OffServer.
Choose OnServer when a deterministic algorithm answers the question
(vision-guided screwdriver alignment against a known fiducial; presence-or-
absence in a clean scene) or when reproducibility on CI matters. Choose
EdgeOffServer when a language model or a heavier out-of-process model is
what actually sees the world — the Server publishes what it did not
compute, and safety validation still applies (§9 refusals, class-label /
box / pose / confidence checks; see Feedback validation).
The two paths are exclusive per pipeline by design: mixing a running
OnServer provider with a SubmitDetections sink would let a computed
and a submitted result publish on the same pipeline out of any known
order.
flowchart LR
Client["Client"]
Server["Vision Server"]
Provider["IVisionInferenceProvider"]
Edge["Off-server agent"]
Sink["IVisionFeedbackSink"]
Results["Pipeline Results folder"]
Client -->|RunInference| Server
Server -->|OnServer delegates| Provider
Provider -->|result id + result node| Results
Edge -->|reads frame| Server
Edge -->|SubmitDetections / SubmitInspectionResult| Server
Server -->|EdgeOffServer delegates| Sink
Sink -->|published result| Results
Client -->|reads same result types| Results
Minimal hosted server
The example below hosts a single simulated eye-in-hand camera, one
inference pipeline, and a two-frame tree (world → flange). It is the
smallest useful shape; the BinPickingCell
sample is the full end-to-end version.
using Microsoft.Extensions.Hosting;
using Opc.Ua;
using Opc.Ua.Server;
using Opc.Ua.Vision;
using Opc.Ua.Vision.Server;
using Opc.Ua.Vision.Server.Builders;
HostApplicationBuilder builder = Host.CreateApplicationBuilder(args);
builder.Services.AddSingleton<MyMediaProvider>();
builder.Services.AddSingleton<MyGroundTruthProvider>();
builder.Services
.AddOpcUa()
.AddServer(options =>
{
options.ApplicationName = "VisionServer";
options.ApplicationUri = "urn:localhost:OPCFoundation:VisionServer";
options.AutoAcceptUntrustedCertificates = true;
options.EndpointUrls.Add("opc.tcp://localhost:62855/VisionServer");
})
.AddVision(options =>
{
options.InstanceNamespaceUri = "urn:example:vision:instances";
})
.AddVisionMediaProvider<MyMediaProvider>(sensorBrowseName: "Camera01")
.AddVisionInferenceProvider<MyGroundTruthProvider>(
pipelineBrowseName: "Detector",
onServer: true)
.ConfigureVision((context, ct) =>
{
IVisionNodeBuilder nodes = context.Nodes;
// Nodes is the fluent address-space builder: everything it creates
// becomes real OPC UA nodes under Server/Vision that any client can
// browse. The full build context is described further down.
nodes.AddFrame("World", frame => frame
.WithFrameId("world")
.WithRole(VisionFrameRoleEnum.World));
nodes.AddFrame("Flange", frame => frame
.WithFrameId("flange")
.WithRole(VisionFrameRoleEnum.MechanicalInterface)
.WithParent("world"));
nodes.AddImageSensor("Camera01", sensor => sensor
.WithSensorId("cam-01")
.WithModality(VisionSensorModalityEnum.Area2D)
.WithRealityKind(VisionRealityKindEnum.Physical)
.WithFrameId("flange")
.WithResolution(1920u, 1080u)
.WithPixelFormat("Mono8")
.AddClipEndpoint("Clips", ep => ep
.WithEndpointId("clip-01")
.WithEndpointUri("opcua-inline://visionserver/clips")
.WithClipFormat(VisionClipFormatEnum.Png)
.WithResolution(1920u, 1080u)
.WithInlineDelivery(enabled: true, maxInlineClipSize: 8_388_608u)));
// The pipeline is bound to its inference provider by
// AddVisionInferenceProvider<MyGroundTruthProvider>("Detector", ...)
// above; the ConfigureVision delegate just creates the pipeline
// node. A real cell resolves the sensor node the pipeline is
// reading from off Server/Vision/Sensors — see the BinPickingCell
// sample for the walk.
nodes.AddPipeline("Detector", pipe => pipe
.WithPipelineId("pipe-01")
.WithSensor(NodeId.Null));
return ValueTask.CompletedTask;
});
using IHost app = builder.Build();
await app.RunAsync().ConfigureAwait(false);
AddVision never modifies the Server's existing NodeManagers — it adds a
standalone VisionNodeManager under the well-known Server/Vision object
(§4.2). It also composes with AddRobotIntent and AddRobotics; both
sample cells run all three side by side without any coupling in code.
The AddVisionMediaProvider<T> / AddVisionInferenceProvider<T> /
AddVisionFeedbackSink<T> extensions resolve the provider from the DI
container at build time and bind it to the sensor or pipeline whose
BrowseName is passed. The equivalent UseMediaProvider(provider) /
UseInferenceProvider(provider, onServer) / UseFeedbackSink(sink)
methods on the fluent builders let a configurator bind a provider it
holds directly.
Hosting API
The extension methods on IOpcUaServerBuilder that make up the Vision
hosting surface:
| Method | Purpose |
|---|---|
AddVision(Action<VisionServerOptions>?) |
Registers the standalone VisionNodeManager and its factory; accepts an optional options delegate |
AddVisionMediaProvider<TProvider>(string sensorBrowseName) |
Registers a media provider type — resolved from DI — for the sensor with the given BrowseName |
AddVisionMediaProvider(string sensorBrowseName, IVisionMediaProvider provider) |
Registers a media provider instance for the sensor with the given BrowseName |
AddVisionInferenceProvider<TProvider>(string pipelineBrowseName, bool onServer) |
Registers an inference provider type — resolved from DI — for the pipeline; onServer controls the advertised VIS-Inference-OnServer / VIS-Inference-OffServer facet (§8.2) |
AddVisionInferenceProvider(string pipelineBrowseName, bool onServer, IVisionInferenceProvider provider) |
Registers an inference provider instance |
AddVisionFeedbackSink<TSink>(string pipelineBrowseName) |
Registers a feedback sink type — resolved from DI — for the pipeline's Feedback object |
AddVisionFeedbackSink(string pipelineBrowseName, IVisionFeedbackSink sink) |
Registers a feedback sink instance |
ConfigureVision(Func<IVisionBuildContext, CancellationToken, ValueTask>) |
Async configurator, run on server start against the standalone VisionNodeManager |
ConfigureVision(Action<IVisionBuildContext>) |
Sync configurator overload |
ConfigureVisionFor<TNodeManager>(...) |
Configurator targeting a specific Vision node-manager type. Currently only VisionNodeManager is supported |
The Robotics guide's ConfigureFor<...> pattern also applies here — any
of these hosting extensions can be called from a class-based configurator
that reads IServiceProvider, keeps its own logger, and does not put a
lambda in Program.cs.
VisionServerOptions
| Property | Purpose |
|---|---|
InstanceNamespaceUri |
The application-owned namespace URI used for the instances the configurator materialises. Must be distinct from the OPC UA base namespace and from http://opcfoundation.org/UA/Vision/. Defaults to urn:opcfoundation:UA:Vision:Instances. |
SpecificationVersion |
The value the Server reports on Vision.SpecificationVersion. Defaults to "0.1.0". |
AdditionalFacets |
The facets the Server declares beyond those the facet calculator derives structurally — the escape hatch for facets whose requirements are behavioural (an interop facet that the host meets by contract). |
Build context
ConfigureVision(...) receives an IVisionBuildContext. Here Nodes is
the fluent address-space builder rooted at the well-known Server/Vision
object; it creates the frame, sensor, calibration, media-endpoint and
pipeline nodes that ordinary OPC UA clients browse and read.
| Member | Purpose |
|---|---|
Nodes |
The fluent IVisionNodeBuilder rooted at the well-known Server/Vision object |
Manager |
The active AsyncCustomNodeManager, for the rare case a configurator must fall back to raw node authoring |
Context |
The active ISystemContext |
Root |
The VisionRootState (§4.2) |
InstanceNamespaceIndex |
The namespace index of VisionServerOptions.InstanceNamespaceUri |
VisionNamespaceIndex |
The namespace index of http://opcfoundation.org/UA/Vision/ |
CancellationToken |
The startup cancellation token |
GetRequiredService<T>() |
Application-scoped DI resolution |
Everything a Vision cell needs (frames, sensors, pipelines, calibrations,
media endpoints) is authored through Nodes. The low-level members are
present for interop with hand-written NodeManagers and for the vendor
extension patterns the Robotics guide describes.
Without DI
A VisionNodeManager created by hand exposes the same fluent surface
through ConfigureVisionAsync:
await manager.ConfigureVisionAsync(context =>
{
context.Nodes.AddFrame("World", f => f
.WithFrameId("world")
.WithRole(VisionFrameRoleEnum.World));
});
Prefer it over CreateVisionBuildContext(). The node manager indexes the
Vision root when it creates the address space, so anything the builder
grafts on afterwards has to be registered as well before it can be
browsed or read by its own NodeId — which is how an ordinary client
and the MCP discovery tools navigate. ConfigureVisionAsync does that
registration when the delegate returns; a context obtained from
CreateVisionBuildContext() never does, so nodes built through it stay
reachable only by browsing forward from their parent.
Topology builders
Frames
nodes.AddFrame("World", f => f
.WithFrameId("world")
.WithRole(VisionFrameRoleEnum.World));
nodes.AddFrame("RobotBase", f => f
.WithFrameId("robot_base")
.WithRole(VisionFrameRoleEnum.Base)
.WithParent("world")
.WithTransform(new VisionPose3DDataType
{
FrameId = "world",
Position = new[] { 0.0, 0.0, 0.829 }.ToArrayOf(),
Orientation = new[] { 0.0, 0.0, 0.0, 1.0 }.ToArrayOf(),
Covariance = ArrayOf<double>.Empty,
}));
The Transform.FrameId names the parent frame per the §5.12 frame-
precedence rule. When the parent is added later in the configurator,
WithParent("world") resolves at finalise time. Passing a NodeId
overload (WithParent(NodeId)) skips the deferred resolution when the
caller already has one.
Roles: World, Base, MechanicalInterface, Tool, Object, Station,
Camera, Custom. Camera is the non-ISO addition Vision introduces
for the sensor's own frame.
Sensors
IVisionNodeBuilder exposes three sensor entry points:
AddImageSensor(browseName, configure)forImageSensorType;AddDepth3DSensor(browseName, configure)forDepth3DSensorType;AddSensor(browseName, configure)for the abstractVisionSensorTypewhen a vendor subtype is materialised through aIVisionModelProvider.
All sensor builders share the members on IVisionSensorBuilder<TSelf>:
identity (WithSensorId, WithManufacturer, WithModel,
WithSerialNumber, WithDeviceUri), the frame binding (WithFrameId,
MountedOn, HasScenePrim), the reality kind (WithRealityKind), the
modality (WithModality), and the nested builders — WithOptics(...),
WithIllumination(...), AddIntrinsicCalibration(...),
AddExtrinsicCalibration(...), AddStreamEndpoint(...),
AddClipEndpoint(...), UseMediaProvider(...).
WithFrameId(frameId) also adds a MountedOn reference to the
CoordinateFrameType instance with the matching FrameId when one has
been registered under Vision/Frames. This is the recommended way to
attach a sensor to a frame; MountedOn(NodeId) and HasScenePrim(NodeId)
are the fallbacks for mounts that are not vision frames.
Pipelines
A pipeline is the Vision object that connects one sensor, an optional AI deployment reference, and the result/feedback methods for one perception task such as detection or inspection. Clients discover pipelines first, then run or observe the task through that pipeline.
nodes.AddPipeline("Detector", pipe => pipe
.WithPipelineId("pipe-01")
.WithSensor(cameraNodeId)
.WithDeployment(deploymentNodeId)
.ProducedBy(controllerNodeId)
.UseInferenceProvider(inferenceProvider, onServer: true)
.UseFeedbackSink(feedbackSink));
WithSensor(NodeId) points the pipeline at the sensor that supplies the
frames. WithDeployment(NodeId) then records which model deployment, if
any, is responsible for the task. The specification deliberately keeps
Deployment typed as NodeId so a Server never has to depend on the AI
Model Management companion; a host that implements that companion can point
at its deployment node, and a host that does not can leave the value null.
ProducedBy(NodeId) adds the ProducedBy semantic reference to a controller
or process instance.
UseFeedbackSink(sink) is optional for OnServer pipelines. OnServer
pipelines without a feedback sink still expose a Feedback object
whose Submit* methods return Bad_NotSupported — a client cannot
publish detections into a pipeline where nothing consumes them.
EdgeOffServer pipelines almost always want both a provider (whose
RunInference explains the mode with Bad_NotSupported) and a sink
that receives the agent's submissions.
Providers
The provider abstractions live in Opc.Ua.Vision.Server:
IVisionMediaProvider— supplies media without putting pixels on OPC UA.GetStreamAsyncreturns a leased URI;GetClipAsyncreturns aVisionImageReferenceDataTypeand, when the caller asked for it and the encoded bytes fit the effective inline limit, an inlineByteString. Providers implement the by-reference default (§6.4) — Servers keep pixel bytes off the OPC UA wire.IVisionInferenceProvider— binds a pipeline to whatever actually computes results. The Server publishes the result nodes and applies the spec's method conventions regardless of whether the provider runs a deterministic detector, a GPU inference engine, an in-process simulation or refuses everything withBad_NotSupported(theEdgeOffServercase).IVisionFeedbackSink— receivesSubmitDetections,SubmitInspectionResult,SubmitCorrectionandSubmitImageReference. Off-Server agents publish through this path and the Server records what it did not compute.
Every provider is registered as a DI singleton and constructed with the same lifetime as the server host — the framework never re-creates them per call.
§5.12 conventions
Vision inherits and adds a small number of numerical conventions that are silently wrong if misread. Every client, provider and configurator in this repository respects them, and public API points that carry pose or image geometry document them explicitly:
- Quaternion order is
(x, y, z, w). EveryOrientationarray inVisionPose3DDataTypeis a unit quaternion ordered(x, y, z, w). The frame graph checks‖q‖ = 1within tolerance1e-6and refuses a zero-norm quaternion withBad_InvalidArgument. - Positions are metres. Every
Positionarray is a 3-vector in metres.MinDepth,MaxDepth,Baseline,WorkingDistanceand every distance-typed member are metres. - The principal point is corner-datum.
VisionIntrinsicsDataType.CxandCyare measured from the top-left corner of the image (pixel centre(0.5, 0.5)). A client bridging to a library that uses centre-datum coordinates subtracts0.5fromCxandCy. - An empty covariance array is the sentinel for "not reported". A
pose that reports no covariance uses
Covariance = ArrayOf<double>.Empty— not a 6×6 zero matrix, which would misrepresent the pose as having been measured with perfect certainty.
The VisionFrameGraph composes transforms strictly per these rules:
right-handed frames, (x, y, z, w)-ordered quaternions, no
substitutions.
§6.4 media gating
Vision separates the by-reference default path (a VisionImageReference
descriptor with URI, timestamp and digest) from the optional inline
delivery of encoded still image bytes. §6.4 fixes what a Server returns
in each state, and VisionMediaClient classifies the raw StatusCode
into a VisionInlineClipState enum so a caller can branch cleanly:
| State | StatusCode |
Meaning |
|---|---|---|
Available |
Good |
The encoded image fits the inline limit and is returned in VisionInlineClipReading.Bytes |
NotYetAvailable |
Bad_NoDataAvailable |
The Server has not published a clip yet — §6.4 rule 5 requires this before the first acquisition |
InlineDisabled |
Bad_NotSupported |
InlineDeliveryEnabled = false on the endpoint; §6.4 rule 5 requires this exact code |
Overflow |
Bad_EncodingLimitsExceeded |
The last acquisition exceeded the effective inline size limit; §6.4 rule 3 requires no truncation |
Faulted |
Other | The endpoint reported a different error |
GetClip is always the safe path — it returns the by-reference
descriptor, and returns the inline bytes as well when the caller passes
requestInline: true and the still fits. LatestClip and
LatestClipMetadata are the "read the latest" variant of the same
contract. Crucially, LatestClipMetadata remains readable even when
LatestClip reports Bad_NotSupported — the metadata carries the URI,
timestamp, digest and pixel format the caller needs to walk the still
out of band, and reporting Bad_NotSupported on the metadata read would
be wrong.
stateDiagram-v2
[*] --> NotYetAvailable: no acquisition yet
NotYetAvailable --> Available: clip captured and fits
Available --> Overflow: next clip exceeds limit
Overflow --> Available: later clip fits
Available --> InlineDisabled: inline delivery disabled
InlineDisabled --> Available: inline delivery enabled
Available --> Faulted: provider error
Overflow --> Faulted: provider error
Faulted --> Available: provider recovers
Rendering without pixels
Opc.Ua.Vision.OpenUsd renders a UsdGeomCamera from a USD stage to an
encoded still, and is the reference ISceneCameraCaptureProvider
implementation the sample cell registers with
services.AddOpenUsdSceneCameraCaptureProvider(). When rendering is not
possible it reports the unavailable backend and leaves the address space
walkable instead of throwing from browse/read paths. It supports the
following behaviour explicitly:
- On a machine with the native OpenUSD renderer payload present and a usable graphics device, it renders normally and returns encoded PNG / JPEG bytes.
- On a machine with no graphics device — the normal case on CI — it
reports
SceneCameraCaptureBackend.NoRenderingBackendonBackend.UnavailableReasonand returnsBad_NoDataAvailablefor every capture. The sensor still exists in the address space and every browse still works; only the pixel bytes are absent.
The intent is that a client can rely on the address space always being
walkable, even when the process has no way to produce pixels. The
--demo client path in the sample skips its compose step gracefully
when the frame is unavailable rather than falsely reporting a rendering
bug.
Facets supported
VisionServerOptions.AdditionalFacets is additive on top of the facets
the address-space calculator derives structurally. Supported means the
stock builder and calculator can claim the facet from the materialised address
space. Partial means the model surface exists, but the host must attest the
facet through AdditionalFacets because the calculator cannot verify the
behaviour or provider-owned result nodes. Not supported means the stock
server does not currently claim that facet.
| Facet | Support | Structural requirement or limitation |
|---|---|---|
VIS-Base |
Supported | A registered sensor contributes the base Vision server shape. |
VIS-Sensor-Params |
Supported | A sensor includes manufacturer, model or serial-number parameters. |
VIS-Optics |
Supported | A sensor has an Optics child. |
VIS-Media-Rtsp |
Supported | A stream endpoint uses VisionStreamProtocolEnum.Rtsp. |
VIS-Media-Jpeg |
Supported | A clip endpoint uses VisionClipFormatEnum.Jpeg. |
VIS-Media-Inline |
Supported | A clip endpoint has InlineDeliveryEnabled = true. |
VIS-Media-DataChannel |
Not supported | There is no stock data-channel endpoint builder or calculator rule. |
VIS-Endpoint-Config |
Supported | At least one stream endpoint is materialised. |
VIS-Calibration |
Supported | An intrinsic or extrinsic calibration is materialised. |
VIS-Result-Detection |
Partial | Providers and sinks can publish detection results, but result ownership is provider-side and not structurally derived. |
VIS-Result-Inspection |
Partial | SubmitInspectionResult exists, but the calculator does not infer inspection-result publication. |
VIS-Result-Segmentation |
Not supported | The stock conformance URI list and feedback surface do not claim a segmentation-result facet. |
VIS-Feedback |
Supported | A pipeline has a Feedback object bound to a sink. |
VIS-Inference-OnServer |
Supported | A pipeline was registered with onServer: true. |
VIS-Inference-OffServer |
Supported | A pipeline was registered with onServer: false. |
VIS-Simulation |
Supported | A sensor has RealityKind = Simulated or Hybrid. |
VIS-Learning |
Partial | Learning jobs are modelled by reference; the host owns the job and any SamplesCollected accounting. |
VIS-Interop-Scene |
Supported | A sensor carries a HasScenePrim reference. |
VIS-Interop-40100 |
Partial | The host must attest cross-model behaviour through AdditionalFacets. |
VIS-Interop-RobotIntent |
Partial | The host must attest cross-model behaviour through AdditionalFacets. |
The Server publishes the composed set on
Server.ServerCapabilities.ServerProfileArray.
Using the client libraries
Registration
The client hosting extensions register a VisionClientFactory and the
factory function downstream services request:
using Microsoft.Extensions.DependencyInjection;
using Opc.Ua.Client;
using Opc.Ua.Vision.Client;
builder.Services
.AddOpcUa()
.AddClient(options => { /* endpoint and application options */ })
.AddVisionClient();
AddVisionClient() requires AddClient(...) to have been called first
so the shared ManagedSession factory is available.
Without DI, a VisionClient can be opened directly from any connected
ISession:
using Opc.Ua;
using Opc.Ua.Client;
using Opc.Ua.Vision.Client;
VisionClient vision = session.Vision(telemetry);
if (!vision.IsVisionNamespaceAvailable)
{
// The Server does not implement the Vision companion.
return;
}
Discovery
await foreach (VisionNodeEntry sensor in vision.EnumerateSensorsAsync(ct))
{
Console.WriteLine($"{sensor.BrowseName} ({sensor.TypeDefinition})");
}
await foreach (VisionNodeEntry pipeline in vision.EnumeratePipelinesAsync(ct))
{
Console.WriteLine($"{pipeline.BrowseName} ({pipeline.TypeDefinition})");
}
Both EnumerateSensorsAsync and EnumeratePipelinesAsync are subtype
aware: a Server that specialises ImageSensorType with a vendor
subtype, or DetectionResultType with a domain result subtype, is
enumerated as an instance of the closest declared Vision base type. The
lower-level DiscoverSensorsAsync / DiscoverPipelinesAsync /
DiscoverFramesAsync return ArrayOf<NodeId> for callers that already
know how to render the picker themselves.
Reading a detection
using Opc.Ua.Vision;
using Opc.Ua.Vision.Client;
NodeId pipelineNodeId = /* discovered above */;
VisionPipelineClient pipe = vision.Pipeline(pipelineNodeId);
VisionPipelineSnapshot snapshot = await pipe.ReadAsync(ct);
string runId = await pipe.RunInferenceAsync(cancellationToken: ct);
await foreach (VisionNodeEntry result in pipe.EnumerateResultsAsync(ct))
{
VisionDetectionResultSnapshot detection = await vision
.Result(result.NodeId)
.ReadDetectionAsync(ct);
Console.WriteLine(
$"result={detection.ResultId} frame={detection.FrameId} " +
$"count={detection.Detections.Count}");
for (int ii = 0; ii < detection.Detections.Count; ii++)
{
VisionDetectionDataType d = detection.Detections[ii];
Console.WriteLine($" [{ii}] {d.ClassLabel} conf={d.Confidence:0.###}");
}
}
VisionPipelineClient.RunInferenceAsync(default, ct) lets the Server
acquire the frame "now"; passing a non-default DateTimeUtc requests a
specific acquisition timestamp — the Server may honour it or refuse per
§8.
Composing a pose
The Vision-side calibrations and frame names match the Robotics-side frame ids by convention — a client can walk from the vision-side pose to the robot-side world frame without any translation table:
VisionFrameGraph frames = vision.Frames();
NodeId cameraFrameId = /* from EnumerateFramesAsync, matching FrameId "camera_eih" */;
NodeId worldFrameId = /* likewise, matching "world" */;
VisionDetectionResultSnapshot detection =
await vision.Result(resultNodeId).ReadDetectionAsync(ct);
for (int ii = 0; ii < detection.Detections.Count; ii++)
{
VisionDetectionDataType d = detection.Detections[ii];
if (!d.HasPose)
{
continue;
}
// Compose the detection's pose (expressed in the camera frame) into
// the world frame; the frame graph walks the parent chain and
// multiplies transforms per §5.12.
VisionPose3DDataType inWorld = await frames.ComposeAsync(
d.Pose, cameraFrameId, worldFrameId, ct);
Console.WriteLine(
$"{d.ClassLabel}: pos=[{inWorld.Position[0]:0.###}, " +
$"{inWorld.Position[1]:0.###}, {inWorld.Position[2]:0.###}]");
}
ComposeAsync walks up to 32 frames from each side, throws
Bad_NoMatch when the two frames share no common ancestor, and refuses
a non-unit quaternion within tolerance 1e-6 — none of which are
substituted with an identity transform, because a silent substitution
would make an incorrect pose look correct.
Submitting feedback
VisionFeedbackClient? feedback = await pipe.OpenFeedbackAsync(ct);
if (feedback is null)
{
// The pipeline does not expose a Feedback object — nothing to submit into.
return;
}
ArrayOf<VisionDetectionDataType> detections = new[]
{
new VisionDetectionDataType
{
ClassLabel = "RedCube",
Confidence = 0.94,
HasBoundingBox2D = true,
BoundingBox2D = new VisionBoundingBox2DDataType
{
CenterX = 812.0, CenterY = 604.0, Width = 96.0, Height = 96.0,
},
HasPose = true,
Pose = new VisionPose3DDataType
{
FrameId = "camera_eih",
Position = new[] { 0.031, -0.017, 0.412 }.ToArrayOf(),
Orientation = new[] { 0.0, 0.0, 0.0, 1.0 }.ToArrayOf(),
Covariance = ArrayOf<double>.Empty,
},
},
}.ToArrayOf();
await feedback.SubmitDetectionsAsync(
VisionFeedbackPurposeEnum.Reconciliation,
detections,
frameReference: null,
inlineImage: ByteString.Empty,
cancellationToken: ct);
The Purpose values Overlay, Reconciliation, GroundTruthLabel
and Trigger are all defined; a Server refuses the ones it does not
permit with Bad_NotSupported. SubmitCorrection accepts at most
one of the two corrected* arrays non-empty — passing both is an
argument error (§9.5). SubmitInspectionResult requires at least one
characteristic.
Reporting an empty scene, and retracting a false positive.
SubmitDetectionstakes aSceneIsEmptyflag andSubmitCorrectionaRetractAllflag. They exist because an empty observation is a real one: "I examined this frame and there is nothing in it" is the terminating condition of a bin-picking task and a valid negative training label, and a false positive is corrected by asserting that nothing replaces it. Neither statement can be made by submitting an array, because both are the empty array. The pairing is checked in both directions. An emptyDetectionswithoutSceneIsEmptyis refused — the flag is what distinguishes a deliberate observation from a lost payload — andSceneIsEmptywith detections attached is refused because it asserts two contradictory things about one frame.RetractAllbehaves the same way against the corrected arrays. §9.4 requires a Server to count a negative example inSamplesCollectedexactly as it counts one carrying geometry — that counter belongs to the learning job, so see Limitations for where this implementation draws the line and what it hands the host instead.
Streaming detections
VisionResultReader.ObserveDetectionsAsync(IStreamingSubscription, ct)
publishes each DetectionResultType change as it arrives — either a new
result or a mutation of an existing one. Use it when you need to react
to detections rather than poll:
using Opc.Ua.Client;
// A ManagedSession exposes a shared default IStreamingSubscription
// that a caller can hand to any Observe*Async method.
IStreamingSubscription streaming = session.DefaultStreaming;
VisionResultReader reader = vision.Result(resultNodeId);
await foreach (VisionDetectionResultSnapshot snapshot in
reader.ObserveDetectionsAsync(streaming, ct))
{
Console.WriteLine($"result {snapshot.ResultId}: {snapshot.Detections.Count} detections");
}
ObserveInspectionAsync and ObserveSegmentationAsync do the same for
inspection and segmentation results.
MCP tools
The Opc.Ua.Mcp.Vision package contributes 22 tools split across six
categories, and the bounded vision profile in docs/McpServer.md
carries them plus the four ConnectionTools — every Vision tool
resolves a named OPC UA session, and only the connection tools can open
one.
- Discovery —
vision_list_sensors,vision_list_pipelines,vision_list_frames,vision_list_calibrations. - Monitoring —
vision_read_sensor,vision_read_extrinsic_calibration,vision_read_pipeline,vision_read_detection_result,vision_read_inspection_result,vision_read_segmentation_result. - Seeing —
vision_get_frame(returns the encoded still as an MCPImageContentBlockwith the correct MIME type, so a model actually sees pixels rather than a description of them),vision_get_frame_metadata. - Inference —
vision_run_inference,vision_start_continuous_inference,vision_stop_inference. - Feedback —
vision_submit_detections,vision_submit_inspection_result,vision_submit_correction,vision_submit_image_reference. - Geometry —
vision_read_frame,vision_compose_pose,vision_compose_transform.
vision_run_inference accepts one structured request. Its pipeline
selector is an exact BrowseName, DisplayName or NodeId; expectedKind can
require a Detection, Inspection or Segmentation result; and detail=Summary
returns a bounded typed summary together with the ResultId, result NodeId,
sensor, requested/published pipeline, model and frame provenance. Use
detail=HandleOnly when only the addressable result is needed, or call a
vision_read_*_result tool for the complete payload.
Profiles compose. A host that wires the Vision and Robotics profile
sets together — the BinPickingClient sample
does this — exposes 64 tools in total, measured as
22 Vision + 4 Connection + 42 Robotics − 4 shared Connection = 64.
The WithOpcUaVisionTools(McpToolProfileSet) overload never registers
ConnectionTools directly; the corresponding
WithOpcUaCoreTools(McpToolProfileSet) overload owns and deduplicates
that registration across every OPC UA MCP package a host references.
See docs/McpServer.md for the full profile table and
composition rules.
Sample: bin-picking
samples/Robotics/BinPickingCell is
the reference from the OPC UA Robotics-Vision Addendum: a
branch-stable four-axis palletizer with a parallel gripper, an
eye-in-hand camera parented to the flange, a bin of five parts, a
fixture, and the frame tree
world → robot_base → flange → gripper_tcp with camera_eih on the
flange. It hosts Robot Intent, the Vision companion and the
OpenUsdScene companion side by side, and either the on-server
deterministic detector (--inferenceLocation OnServer, the default)
or the off-server agent path (--inferenceLocation EdgeOffServer).
The selected detection identifies the workpiece and preserves its pose as
provenance. The Pick carries the selected class plus the source Location and
tool; the cell's executor resolves that workpiece at its observed world pose
rather than substituting the Location centre.
samples/Robotics/BinPickingClient
is the paired client: --demo runs the whole loop without an agent,
--mcp exposes the composed 64-tool MCP catalogue for a language-model
agent, and --view opens the in-process OpenUSD viewport so a human
sees the same scene the agent sees.
The composed Robotics package also contributes robotics_vision_pick. It runs
one inference through the Vision client, selects one detection
deterministically, and submits either a Pick operation or a two-step Pick/Place
mission. It returns the selected detection provenance and the authoritative
operation or mission handles. Command authority remains explicit: the helper
never requests ownership, retries, waits, cancels or hides a refusal.
Scene lighting
The scene is lit by a single DomeLight with intensity = 1000.
Do not reintroduce a DistantLight or any other bright directional or
point light for a Vision demo: at any intensity that shows geometry, a
DistantLight blows every surface to pure white regardless of
displayColor, and any agent looking at the frame sees a uniform
white blur. Under a DomeLight the five sample parts measure
red (220, 37, 37), green (37, 208, 49), blue (37, 73, 233) — distinct
enough for a vision-language model to reason about ("pick the red
cube"). The Cell.usda header records this contract explicitly.
Anyone authoring their own scene from scratch needs to know this or
their agent will see nothing they can act on.
Feedback validation
When the cell runs in EdgeOffServer mode the agent sends detections
through SubmitDetections. The sample's feedback sink refuses malformed
submissions with Bad_InvalidArgument and a message the agent can act
on:
- Unknown class label — refused with the exact list of parts that
do exist.
Detection 0 class 'PurplePyramid' is not a part in this cell. Known classes: RedCube, GreenCylinder, BlueSphere, YellowSlab, OrangeBrick. - Confidence outside
[0, 1]— refused with the observed value. - Bounding box outside the image — refused with the box coordinates and the image dimensions the box was measured against.
- Zero-norm quaternion or pose with fewer than three position components — refused with the detection index.
An empty detection set is accepted only when SceneIsEmpty is set; setting
that flag with a nonempty set is rejected. For corrections, RetractAll allows
both corrected arrays to be empty. Otherwise exactly one corrected array must
be nonempty, and RetractAll must not accompany corrected entries.
These flags let an agent report an empty scene or retract a false positive without inventing a detection. See Submitting feedback for the payload contract and Limitations for the host's responsibility for learning counters.
Limitations
- The Vision specification is a draft. The namespace URI and every NodeId are provisional; every ObjectType and BrowseName can change when the working group publishes.
- No vendor drivers ship. The reference
IVisionMediaProvidercovered here renders an OpenUSD stage offscreen. There is no GigE Vision, USB3 Vision, GenICam or vendor-native driver in the box; a host implementingIVisionMediaProviderfor a real camera is the supported extension point. ConfigureVisionFor<TNodeManager>only acceptsVisionNodeManager. Custom Vision node-manager types are not yet supported; vendor extension follows the same class-based-configurator pattern the Robotics guide describes.- Learning jobs are modelled but not driven, and
SamplesCollectedis not counted here.InferencePipelineTypecarries aLearningJoboptional child and the facet calculator publishesVIS-Learningwhen one is bound, but the standaloneVisionNodeManagerdoes not itself run training — a host provides a learning-job provider through the extension pattern. This has one named conformance consequence: §9.4 requires a Server to count a negative example (SceneIsEmptyorRetractAllcarrying aGroundTruthLabel) inSamplesCollectedexactly as it counts one carrying geometry, andVisionNodeManagerdoes not do that counting. It cannot:SamplesCollectedis a property ofLearningJobType, which the AI Model Management companion defines, and Vision reaches it through aNodeIdvalue rather than a Reference precisely so this model takes no dependency on the model that defines the job. What the Server does guarantee is that the negative example survives the hop intact —SceneIsEmptyandRetractAllare carried verbatim onVisionSubmitDetectionsRequest/VisionSubmitCorrectionRequest, so a host that binds a learning job has everything it needs to satisfy §9.4 on the counter it owns. - AOT compatibility of the OpenUSD capture provider depends on the
native renderer payload. The managed layer is AOT-friendly; the
native payload ships per-RID and its presence at runtime is what
distinguishes a rendering capture from a
NoRenderingBackendone.
Visual inspection: a cross-companion cell
Inspection is the part of the specification that composes with the most other models, so it is documented here in full rather than in isolation. The Vision samples build a cell where a camera photographs a machined bracket, a model measures it, deterministic code judges those measurements against a recipe, the verdict drives an ISA-95 job order, and anything the machine cannot decide escalates to an operator whose answer is captured as ground truth and counted as a learning sample. The sample READMEs cover how to run it; what follows is why it is built this way.
The model never decides
The central safety property is that model output is evidence, not authority. A model may be involved in producing measured characteristics and a confidence, but deterministic code applies the recipe tolerances and computes the verdict. That matters because a plant that let a language model schedule production from what it thought it saw in a photograph would have an image-shaped path straight into job control. In this sample, image content can influence the measured values, but it cannot become a free-form job-control instruction.
The sample also routes inference through the AI companion's deployment
Invoke method instead of letting the agent call a model privately in its own
process. That keeps the deployment node, model version, and usage accounting in
the address space and in the provenance trail. A private model call would make
the most important part of the loop invisible.
Address-space composition
VisualInspectionCell composes four companion areas in one server process:
- Vision publishes
BracketFixtureCamera,FixtureImages,BracketInspectionPipeline, inspection results, and feedback. - AI Model Management publishes the primary deployment
visual-inspection-primary, its model metadata, and the learning job whoseSamplesCollectedvalue is incremented by host code. - ISA-95 Job Control V2 publishes the fixed job-order catalogue and the V2 Methods the agent calls.
- Alarms & Conditions publishes the
OperatorDispositionDialogcondition.
BracketInspectionPipeline points at the AI deployment through Deployment and
at the learning job through LearningJob. The Vision companion deliberately
uses NodeId values for those bindings; it does not take a compile-time
dependency on the AI companion. This sample is the host that binds both models
and can therefore satisfy the learning-job counter semantics that standalone
Vision cannot.
Recipe and verdict rule
The inspected part is a machined bracket with three dimensional characteristics in millimetres:
| Characteristic | Nominal | Tolerance |
|---|---|---|
BoreDiameter |
12.00 | ± 0.20 |
SlotWidth |
8.00 | ± 0.15 |
EdgeOffset |
20.00 | ± 0.25 |
For each characteristic, the rule builds an interval from the measured value and physical uncertainty:
measurement interval = actual ± uncertainty
tolerance interval = [nominal - lowerTol, nominal + upperTol]
Then it classifies the characteristic:
- wholly inside the tolerance interval ->
Ok - wholly outside the tolerance interval ->
NotOk - straddling either tolerance limit ->
NotDecidable
The part verdict is the worst characteristic verdict, with NotOk worse than
NotDecidable, and NotDecidable worse than Ok.
flowchart TD
Measurement["Measured characteristic<br/>actual and uncertainty"] --> Interval["Build actual +/- uncertainty"]
Interval --> Compare{"Compare with tolerance interval"}
Compare -->|"wholly inside"| Ok["Ok"]
Compare -->|"wholly outside"| NotOk["NotOk"]
Compare -->|"straddles a limit"| NotDecidable["NotDecidable"]
Ok --> Worst["Part takes worst characteristic verdict"]
NotOk --> Worst
NotDecidable --> Worst
Why uncertainty is physical
The fixture images are 800 x 600 pixels at 10 px/mm. A feature edge can only land
on a pixel boundary, so a dimensional measurement carries one-pixel quantisation
uncertainty: 0.10 mm. That is the camera's pixel pitch. It is what makes
VisionCharacteristicDataType.Uncertainty meaningful, and it is why
NotDecidable arises naturally instead of being contrived.
The three fixtures exercise all branches:
| Fixture | Decisive characteristic | Interval | Verdict |
|---|---|---|---|
bracket-ok.png |
BoreDiameter = 12.00 |
[11.90, 12.10] is wholly inside [11.80, 12.20] |
Ok |
bracket-not-ok.png |
BoreDiameter = 12.60 |
[12.50, 12.70] is wholly outside the bore tolerance |
NotOk |
bracket-ambiguous.png |
SlotWidth = 8.10 |
[8.00, 8.20] straddles the 8.15 upper limit |
NotDecidable |
The ambiguous fixture is intentionally mundane: the intended 8.15 mm slot is
81.5 pixels at 10 px/mm and cannot be drawn exactly. The raster image therefore
measures as 8.10 mm, and one pixel of uncertainty crosses the tolerance limit.
That is precisely the case the Vision NotDecidable value exists for.
Inspection loop
The agent drives the process from outside the server. It discovers the Vision
pipeline, opens the media endpoint, follows the pipeline's Deployment to the
AI companion, discovers ISA-95 V2 endpoints, and finds the operator dialog.
flowchart TD
Discover["Discover pipeline, media, deployment, jobs, dialog"] --> Capture["Get fixture PNG"]
Capture --> Measure["Measure bracket geometry"]
Measure --> Invoke["Call AI deployment Invoke"]
Invoke --> Judge["Apply recipe rule"]
Judge --> Submit["Submit inspection result to Vision Feedback"]
Submit --> Verdict{"Verdict"}
Verdict -->|"Ok"| CloseOk["Start, stop, and clear inspection job"]
CloseOk --> Next["StoreAndStart inspection order"]
Verdict -->|"NotOk"| CloseBad["Start, stop, and clear inspection job"]
CloseBad --> Reject["StoreAndStart rework/reject order"]
Verdict -->|"NotDecidable"| Hold["Hold for operator"]
The important separation is that quality outcome and job execution state are separate facts. A defective part does not mean the inspection job failed.
| Verdict | Inspection job | Next job |
|---|---|---|
Ok |
complete, close | schedule next inspection |
NotOk |
complete, close | schedule rework/reject order |
NotDecidable |
hold | none until the operator answers |
Scheduling selects an order from a fixed allowlisted catalogue and calls V2
StoreAndStart. InspectionJobControlProvider accepts only
VIS-INSP-BRACKET-001 and VIS-REWORK-REJECT-001; the agent never invents a
job payload.
Escalation and ground truth
NotDecidable activates the human path. The design dispositions are
AcceptAsOk, AcceptAsNotOk, Reinspect, and Stop. The implementation maps
those dispositions onto the dialog response and a bounded timeout: it holds or
stops, but it does not auto-approve and does not block forever.
sequenceDiagram
participant Agent as VisualInspectionAgent
participant Vision as Vision Feedback
participant Dialog as Operator Dialog
participant Operator as Human Operator
participant AI as AI Learning Job
Agent->>Vision: SubmitInspectionResult NotDecidable
Agent->>Dialog: Wait for disposition
Dialog->>Operator: Request Accept, Reinspect, Reject, or Stop
Operator-->>Dialog: Disposition
Dialog-->>Agent: Response or timeout
alt Accept as ground truth
Agent->>Vision: SubmitCorrection GroundTruthLabel
Vision->>AI: RecordLearningSampleAsync
AI-->>Vision: Idempotent count result
else Reinspect
Agent->>Vision: No correction
Agent->>Agent: Schedule inspection order
else Stop or timeout
Agent->>Agent: Hold or stop without approval
end
The operator answer becomes a Vision §9 ground-truth correction. The cell's
feedback sink calls AiNodeManager.RecordLearningSampleAsync and uses a stable
sample id, so a retry does not count the same label twice. A negative example is
still a learning sample: it counts exactly once even when it carries no geometry.
This closes a limitation called out in the Vision developer guide:
SamplesCollected belongs to the AI companion's LearningJobType, while Vision
only names the learning job by NodeId. A standalone Vision node manager cannot
increment a counter owned by another companion. A host binding Vision and AI
Model Management together can, and this cell is that host. See also the
AI Model Management developer guide for the deployment
and learning-job model.
Modes
VisualInspectionAgent supports three modes:
scripted— deterministic analyser, scripted operator policy, and a finite--cycles N. This is the unattended path.live-ai— a real model path. It requires--ai-endpoint; if no endpoint is configured, the agent exits before creating any job and never silently falls back to the simulated analyser.human— a real dialog subscriber path with a bounded--operator-timeout.
The no-silent-fallback rule is part of the sample's safety story. A sample that quietly degrades can look green while proving neither model connectivity nor the provenance path it claims to demonstrate.
What is deliberately not implemented
The sample does not implement retraining or model promotion. It records learning samples honestly and increments the AI learning-job count, but it does not fake an MLOps workflow. A simulated retraining integration that appeared to work would mislead readers about the one part of the specification a sample cannot honestly demonstrate. The AI Model Management sample takes the same line.
See also
- Robotics developer guide — the sibling companion
implementation Vision composes with; the
BinPickingCellsample is the cross-companion example. - OpenUSD guide — the OpenUSD connector and scene materialisation used to bind the Vision sample cell to a live USD stage.
- MCP Server guide — the
visionMCP profile and its composition withrobotics. - AI Model Management developer guide — the
companion that owns the model, dataset and deployment a Vision
pipeline's
DeploymentandLearningJobpoint at, and the counter §9.4 asks a learning job to keep. - Dependency Injection — the
AddOpcUa()builder surface that hostsAddVision,AddVisionClient, and every other component.