From d731ed98faea6147b4a75f7e826bb57847e68c0b Mon Sep 17 00:00:00 2001 From: Joseph Doherty Date: Wed, 3 Jun 2026 15:58:32 -0400 Subject: [PATCH] =?UTF-8?q?docs(audit):=20drivers/Galaxy.md=20=E2=80=94=20?= =?UTF-8?q?interface=20list=20+=20accuracy=20pass?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit CODE-REALITY (known defect): the capability-surface declaration line omitted IAlarmSource and IAsyncDisposable. GalaxyDriver.cs:39 actually declares: IDriver, ITagDiscovery, IReadable, IWritable, ISubscribable, IRediscoverable, IHostConnectivityProbe, IAlarmSource, IDisposable, IAsyncDisposable. Doc line corrected to match exactly, and an IAlarmSource row added to the capability table (Runtime/GatewayGalaxyAlarmFeed.cs + Runtime/GatewayGalaxyAlarmAcknowledger.cs). STALE-STATUS: the v1-doc move note claimed Galaxy-Repository.md / Galaxy-Test-Fixture.md 'are being moved to docs/v1/ by a parallel cleanup track' — that move is complete; they live at docs/v1/drivers/. Rewrote to present tense and linked the real targets. Verified against source: deploy-watch is a gRPC stream (GatewayGalaxyDeployWatchSource forwards WatchDeployEventsAsync via GalaxyRepositoryClient, not a direct DB poll); contained-name<->tag-name translation (GalaxyDiscoverer.cs:49,60); DataTypeMap at Browse/DataTypeMap.cs; IGalaxyHierarchySource / IGalaxyDeployWatchSource / DeployWatcher all present. check_links.py: zero rows for docs/drivers/Galaxy.md. --- docs/drivers/Galaxy.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/drivers/Galaxy.md b/docs/drivers/Galaxy.md index 67f06cd7..7b82d149 100644 --- a/docs/drivers/Galaxy.md +++ b/docs/drivers/Galaxy.md @@ -4,7 +4,7 @@ The Galaxy driver bridges OtOpcUa to AVEVA System Platform (Wonderware) Galaxies For the driver spec (capability surface, config shape, addressing), see [docs/v2/driver-specs.md §1](../v2/driver-specs.md). For the gateway setup recipe, see [docs/v2/Galaxy.ParityRig.md](../v2/Galaxy.ParityRig.md). For tracing, metrics, and soak profile, see [docs/v2/Galaxy.Performance.md](../v2/Galaxy.Performance.md). -> **Note**: the related drivers `Galaxy-Repository.md` and `Galaxy-Test-Fixture.md` describe the previous v1 / out-of-process topology and are being moved to `docs/v1/` by a parallel cleanup track. Use `Galaxy.ParityRig.md` and the `mxaccessgw` repo for current testing. +> **Note**: the related docs [`Galaxy-Repository.md`](../v1/drivers/Galaxy-Repository.md) and [`Galaxy-Test-Fixture.md`](../v1/drivers/Galaxy-Test-Fixture.md) describe the previous v1 / out-of-process topology and now live under `docs/v1/drivers/`. For current testing use [`Galaxy.ParityRig.md`](../v2/Galaxy.ParityRig.md) and the `mxaccessgw` repo. ## Architecture @@ -65,7 +65,7 @@ Project root files: ## Capability Surface -`GalaxyDriver : IDriver, ITagDiscovery, IReadable, IWritable, ISubscribable, IRediscoverable, IHostConnectivityProbe, IDisposable`. +`GalaxyDriver : IDriver, ITagDiscovery, IReadable, IWritable, ISubscribable, IRediscoverable, IHostConnectivityProbe, IAlarmSource, IDisposable, IAsyncDisposable`. | Capability | Implementation entry point | |------------|---------------------------| @@ -75,6 +75,7 @@ Project root files: | `IWritable` | `Runtime/GatewayGalaxyDataWriter.cs` | | `ISubscribable` | `Runtime/GatewayGalaxySubscriber.cs` (driven by `EventPump`) | | `IHostConnectivityProbe` | `Health/HostStatusAggregator.cs` | +| `IAlarmSource` | `Runtime/GatewayGalaxyAlarmFeed.cs` (transitions) + `Runtime/GatewayGalaxyAlarmAcknowledger.cs` (acks) | ## Configuration