Files

Joseph Doherty f217636467 Doc refresh (task #206 ) — Client.CLI + Client.UI brand flip + new top-level docs/README.md index. Client.CLI.md: replaced stale LmxOpcUa-OPC UA-server references with OtOpcUa throughout the overview + sample output + applicationUri examples (opc.tcp://localhost:4840/OtOpcUa, urn:localhost:OtOpcUa:instanceN); confirmed against src/ZB.MOM.WW.OtOpcUa.Server/Program.cs:69-71 which sets the live endpoint url + application uri to those exact values. Added a driver-agnostic note in the overview — the CLI is reachable against every shipped driver surface because the OPC UA endpoint abstracts them all. Kept the lmxopcua-cli executable name + the {LocalAppData}/LmxOpcUaClient/pki/ PKI folder name AS-IS because those are real filesystem-level residuals the code still uses (Program.cs SetExecutableName + OpcUaClientService.cs:428) — flipping them requires migration shims so existing dev boxes don't lose their trusted-cert store; added explicit doc text explaining the residual + why it persists so future readers aren't confused. Fixed the sample connect-output "Server: LmxOpcUa" to "Server: OtOpcUa Server" matching the live ApplicationName in OpcUaServerOptions.cs:39. Client.UI.md: replaced the 4 LmxOpcUa references — overview one-liner, status-bar mock (now reads "OtOpcUa Server" matching the server's reported ApplicationName), endpoint-url example, settings persistence path. Same residual-explanation note added under the LmxOpcUaClient/settings.json path pointing at the Client.Shared session-factory literal at OpcUaClientService.cs:428. docs/README.md is new — a top-level index distinguishing the two documentation tiers (current reference at docs/*.md vs implementation history + design notes at docs/v2/*.md). Every current-reference doc gets a one-line role description in a section table (Architecture + data-path / Drivers / Operational / Client tooling / Requirements) so a new reader picking up the repo finds their way in without having to grep file names. Cross-link calls out that load-bearing references from top-level docs (plan.md decisions, admin-ui.md, acl-design.md, config-db-schema.md, driver-specs.md, dev-environment.md, test-data-sources.md) live under v2/. Notes up front that the project was renamed LmxOpcUa → OtOpcUa and that any remaining LmxOpcUa-string in paths is a deliberate residual with a migration follow-up, so readers don't chase phantom bugs. Four parallel doc-refresh agents currently working on the rest of docs/*.md (task #202 core architecture, #203 driver docs split, #204 operational, #205 requirements) — those commits will land on separate worktree branches + get folded in together once complete; this index already lists the docs they'll produce (drivers/README.md, drivers/Galaxy.md, drivers/Galaxy-Repository.md) so the final merge just has the content showing up where the index already points.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

2026-04-20 01:25:18 -04:00

5.5 KiB

Raw Blame History

OtOpcUa documentation

Two tiers of documentation live here:

Current reference at the top level (docs/*.md) — describes what's shipped today. Start here for operator + integrator reference.
Implementation history + design notes at docs/v2/*.md — the authoritative plan + decision log the current reference is built from. Start here when you need the why behind an architectural choice, or when a top-level doc says "see plan.md § X".

The project was originally called LmxOpcUa (a single-driver Galaxy/MXAccess OPC UA server) and has since become OtOpcUa, a multi-driver OPC UA server platform. Any lingering LmxOpcUa-string in a path you see in docs is a deliberate residual (executable name lmxopcua-cli, client PKI folder {LocalAppData}/LmxOpcUaClient/) — fixing those requires migration shims + is tracked as follow-ups.

Platform overview

Core owns the OPC UA stack, address space, session/security/subscription machinery.
Drivers plug in via capability interfaces in ZB.MOM.WW.OtOpcUa.Core.Abstractions: IDriver, IReadable, IWritable, ITagDiscovery, ISubscribable, IHostConnectivityProbe, IAlarmSource, IHistoryProvider, IPerCallHostResolver. Each driver opts into whichever it supports.
Server is the OPC UA endpoint process (net10, x64). Hosts every driver except Galaxy in-process; talks to Galaxy via a named pipe because MXAccess COM is 32-bit-only.
Admin is the Blazor Server operator UI (net10, x64). Owns the Config DB draft/publish flow, ACL + role-grant authoring, fleet status + /metrics scrape endpoint.
Galaxy.Host is a .NET Framework 4.8 x86 Windows service that wraps MXAccess COM on an STA thread for the Galaxy driver.

Where to find what

Architecture + data-path reference

Doc	Covers
OpcUaServer.md	Top-level server architecture — Core, driver dispatch, Config DB, generations
AddressSpace.md	`GenericDriverNodeManager` + `ITagDiscovery` + `IAddressSpaceBuilder`
ReadWriteOperations.md	OPC UA Read/Write → `CapabilityInvoker` → `IReadable`/`IWritable`
Subscriptions.md	Monitored items → `ISubscribable` + per-driver subscription refcount
AlarmTracking.md	`IAlarmSource` + `AlarmSurfaceInvoker` + OPC UA alarm conditions
DataTypeMapping.md	Per-driver `DriverAttributeInfo` → OPC UA variable types
IncrementalSync.md	Address-space rebuild on redeploy + `sp_ComputeGenerationDiff`
HistoricalDataAccess.md	`IHistoryProvider` as a per-driver optional capability

Drivers

Doc	Covers
drivers/README.md	Index of the seven shipped drivers + capability matrix
drivers/Galaxy.md	Galaxy driver — MXAccess bridge, Host/Proxy split, named-pipe IPC
drivers/Galaxy-Repository.md	Galaxy-specific discovery via the ZB SQL database

For Modbus / S7 / AB CIP / AB Legacy / TwinCAT / FOCAS / OPC UA Client specifics, see v2/driver-specs.md.

Operational

Doc	Covers
Configuration.md	appsettings bootstrap + Config DB + Admin UI draft/publish
security.md	Transport security profiles, LDAP auth, ACL trie, role grants, OTOPCUA0001 analyzer
Redundancy.md	`RedundancyCoordinator`, `ServiceLevelCalculator`, apply-lease, Prometheus metrics
ServiceHosting.md	Three-process deploy (Server + Admin + Galaxy.Host) install/uninstall
StatusDashboard.md	Pointer — superseded by v2/admin-ui.md

Client tooling

Doc	Covers
Client.CLI.md	`lmxopcua-cli` — command-line client
Client.UI.md	Avalonia desktop client

Requirements

Doc	Covers
reqs/HighLevelReqs.md	HLRs — numbered system-level requirements
reqs/OpcUaServerReqs.md	OPC UA server-layer reqs
reqs/ServiceHostReqs.md	Per-process hosting reqs
reqs/ClientRequirements.md	Client CLI + UI reqs
reqs/GalaxyRepositoryReqs.md	Galaxy-scoped repository reqs
reqs/MxAccessClientReqs.md	Galaxy-scoped MXAccess reqs
reqs/StatusDashboardReqs.md	Pointer — superseded by Admin UI

Implementation history (`docs/v2/`)

Design decisions + phase plans + execution notes. Load-bearing cross-references from the top-level docs:

v2/plan.md — authoritative v2 vision doc + numbered decision log (referenced as "decision #N" elsewhere)
v2/admin-ui.md — Admin UI spec
v2/acl-design.md — data-plane ACL + permission-trie design (Phase 6.2)
v2/config-db-schema.md — Config DB schema reference
v2/driver-specs.md — per-driver addressing + quirks for every shipped protocol
v2/dev-environment.md — dev-box bootstrap
v2/test-data-sources.md — integration-test simulator matrix (includes the pinned libplctag ab_server version for AB CIP tests)
v2/implementation/phase--.md — per-phase execution plans with exit-gate evidence

5.5 KiB Raw Blame History