From 33054c3275d85efd6bb2e9778e3091b873e68d44 Mon Sep 17 00:00:00 2001 From: Joseph Doherty Date: Thu, 30 Apr 2026 09:42:28 -0400 Subject: [PATCH] docs: drop dangling FOCAS refs + link unreferenced v2 design docs - docs/drivers/FOCAS.md and docs/v2/implementation/focas-wire-protocol.md pointed at focas-deployment.md and focas-simulator-plan.md, both of which were untracked drafts that have since been removed. Drop the refs (the wire-protocol companion now stands on its own; deployment guidance lives inline in the FOCAS driver doc). - Link the orphan v2 design docs from docs/README.md (multi-host dispatch, v2 release readiness, the historical lmx-followups tracker) and from modbus-test-plan.md (s7.md, mitsubishi.md per-family quirk catalogs, sibling to dl205.md). Surfaced by the doc audit; no content changes. Co-Authored-By: Claude Opus 4.7 (1M context) --- docs/README.md | 3 +++ docs/drivers/FOCAS.md | 6 +++--- docs/v2/implementation/focas-wire-protocol.md | 3 +-- docs/v2/modbus-test-plan.md | 11 +++++++++++ 4 files changed, 18 insertions(+), 5 deletions(-) diff --git a/docs/README.md b/docs/README.md index d53d534..6ab2ff1 100644 --- a/docs/README.md +++ b/docs/README.md @@ -95,6 +95,9 @@ Design decisions + phase plans + execution notes. Load-bearing cross-references - [v2/driver-specs.md](v2/driver-specs.md) — per-driver addressing + quirks for every shipped protocol - [v2/dev-environment.md](v2/dev-environment.md) — dev-box bootstrap - [v2/test-data-sources.md](v2/test-data-sources.md) — integration-test simulator matrix (includes the pinned libplctag `ab_server` version for AB CIP tests) +- [v2/multi-host-dispatch.md](v2/multi-host-dispatch.md) — per-PLC circuit breakers (Phase 6.1 decision #144) +- [v2/v2-release-readiness.md](v2/v2-release-readiness.md) — release-readiness tracker +- [v2/lmx-followups.md](v2/lmx-followups.md) — historical Galaxy-bridge follow-ups (pre-PR-7.2) - [v2/implementation/phase-*-*.md](v2/implementation/) — per-phase execution plans with exit-gate evidence ## v1 archive diff --git a/docs/drivers/FOCAS.md b/docs/drivers/FOCAS.md index 1fa1dbf..35de18d 100644 --- a/docs/drivers/FOCAS.md +++ b/docs/drivers/FOCAS.md @@ -2,7 +2,6 @@ Getting-started guide for the FANUC FOCAS2 driver. This is the short path — for the exhaustive per-node mapping read [`docs/v2/driver-specs.md §7`](../v2/driver-specs.md), -for deployment details read [`docs/v2/focas-deployment.md`](../v2/focas-deployment.md), for the test-harness map read [FOCAS-Test-Fixture.md](FOCAS-Test-Fixture.md). ## What it talks to @@ -210,8 +209,9 @@ latency spike once per cadence. driver surface via `FakeFocasClient`. Includes the alarm-projection raise / clear diffing tests. - **Integration tests** — `tests/ZB.MOM.WW.OtOpcUa.Driver.FOCAS.IntegrationTests/` - hold the Docker simulator scaffold (Stream B / C of the simulator plan — - `docs/v2/implementation/focas-simulator-plan.md`). + hold the Docker simulator scaffold; see + [`docs/v2/implementation/focas-wire-protocol.md`](../v2/implementation/focas-wire-protocol.md) + for what the simulator emits vs. real CNC behaviour. - **E2E script** — `scripts/e2e/test-focas.ps1` stages Host + Proxy + a real CNC (or the simulator) and exercises connect → read → write → subscribe round-trips. See [`docs/drivers/FOCAS-Test-Fixture.md`](FOCAS-Test-Fixture.md) diff --git a/docs/v2/implementation/focas-wire-protocol.md b/docs/v2/implementation/focas-wire-protocol.md index 58f0172..d25beb2 100644 --- a/docs/v2/implementation/focas-wire-protocol.md +++ b/docs/v2/implementation/focas-wire-protocol.md @@ -1,7 +1,6 @@ # FOCAS wire protocol — what's authoritative vs. what's guessed -Companion to [`focas-simulator-plan.md`](focas-simulator-plan.md). Written during -Stream B on 2026-04-23 after a research pass through `strangesast/fwlib` + +Written during Stream B on 2026-04-23 after a research pass through `strangesast/fwlib` + public FOCAS documentation. Purpose: separate what we *know* about the FOCAS wire protocol (can quote with confidence) from what we're *guessing* (will need Wireshark traces to validate in Stream C). diff --git a/docs/v2/modbus-test-plan.md b/docs/v2/modbus-test-plan.md index 92fbd14..92d2713 100644 --- a/docs/v2/modbus-test-plan.md +++ b/docs/v2/modbus-test-plan.md @@ -70,6 +70,17 @@ integration tests until reproduced on hardware: - TxId drop under load (forum rumour; not reproduced). - Pre-2004 firmware ABCD word order (every shipped DL205/DL260 since 2004 is CDAB). +### Siemens SIMATIC S7 + +Quirk catalog at [`s7.md`](s7.md) — covers S7-1200 / S7-1500 / S7-300 / S7-400 / +ET 200SP. Modbus TCP isn't native; each platform exposes it via a different +add-on module with its own register-mapping conventions. + +### Mitsubishi MELSEC + +Quirk catalog at [`mitsubishi.md`](mitsubishi.md) — Modbus TCP via add-on modules +across the MELSEC family. + ### Future devices One section per device class, same shape as DL205. Quirks that apply across