dohertj2/wwtools
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

mbproxy/README: refresh top-section descriptions after docs split

Browse Source 
Three lines were stale after the docs/ reorganization:

- Headline link for the response cache pointed at design.md's "Phase 11"
  anchor; the focused doc is now docs/Architecture/ResponseCache.md.
- The docs/ tree one-liner said "Design document, phase plans, and
  operations runbook" but the directory now contains five subdirs of
  topic-focused docs.
- The Resource index row for design.md claimed it carried "log events"
  (now lives in Reference/LogEvents.md) and operations.md's row claimed
  "config, troubleshooting" (now in Operations/Configuration.md and
  Operations/Troubleshooting.md). Both rows rewritten to match each
  doc's current scope. Added a row for docs/kpi.md which the index
  was missing.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
Joseph Doherty
2026-05-14 03:51:26 -04:00
parent b4c82bf379
commit 53a7111120
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
mbproxy/README.md
+6 -5
View File
@@ -1,6 +1,6 @@
# mbproxy
A .NET 10 Windows Service that sits inline as a Modbus TCP proxy in front of a fleet of AutomationDirect DirectLOGIC DL205/DL260 controllers, rewriting BCD-encoded registers bidirectionally so upstream clients can read and write them as plain integers. Since Phase 11, the proxy also offers an opt-in per-tag response cache (default OFF) for FC03/FC04 reads with bounded operator-configured staleness — see [`docs/design.md`](docs/design.md) → "Response cache (Phase 11)" before enabling it.
A .NET 10 Windows Service that sits inline as a Modbus TCP proxy in front of a fleet of AutomationDirect DirectLOGIC DL205/DL260 controllers, rewriting BCD-encoded registers bidirectionally so upstream clients can read and write them as plain integers. The proxy also offers an opt-in per-tag response cache (default OFF) for FC03/FC04 reads with bounded operator-configured staleness — see [`docs/Architecture/ResponseCache.md`](docs/Architecture/ResponseCache.md) before enabling it.
## Hard constraints / prerequisites
@@ -16,7 +16,7 @@ A .NET 10 Windows Service that sits inline as a Modbus TCP proxy in front of a f
src/Mbproxy/ Main C# project (net10.0, Microsoft.NET.Sdk.Worker)
tests/Mbproxy.Tests/ xUnit v3 test project (314 unit + 48 E2E tests)
install/ PowerShell install/uninstall scripts and config template
docs/ Design document, phase plans, and operations runbook
docs/ Architecture, features, operations, reference, and testing docs
DL260/ DL205/DL260 reference material and pymodbus simulator profile
```
@@ -24,9 +24,10 @@ DL260/ DL205/DL260 reference material and pymodbus simulator prof
| Task | Go to |
|---|---|
| Full architecture, schema, log events, status counters, test strategy | [`docs/design.md`](docs/design.md) |
| Phase-by-phase implementation plan | [`docs/plan/README.md`](docs/plan/README.md) |
| Install, upgrade, config, logs, troubleshooting | [`docs/operations.md`](docs/operations.md) |
| End-to-end architectural design (entry point — routes into focused docs below) | [`docs/design.md`](docs/design.md) |
| Phase-by-phase implementation plan and history | [`docs/plan/README.md`](docs/plan/README.md) |
| Install, upgrade, uninstall, log file locations, first-install smoke checklist | [`docs/operations.md`](docs/operations.md) |
| Dashboard KPI catalog | [`docs/kpi.md`](docs/kpi.md) |
| DL205/DL260 Modbus quirks (BCD, CDAB, octal V-memory, FC limits) | [`DL260/dl205.md`](DL260/dl205.md) |
| pymodbus simulator profile (register seeds for E2E tests) | [`DL260/dl205.json`](DL260/dl205.json) |
| Agent-oriented coding guide (architecture bullets, device quirks, phase context) | [`CLAUDE.md`](CLAUDE.md) |