Commit Graph

2 Commits

Author SHA1 Message Date
raphael b031f057af docs: customer-ready sweep + README restructure + tshark CI fix
Audit pass over the public-facing surface so a customer can read it
end-to-end without tripping on stale numbers or self-contradictions.

README + docs accuracy:
- Test counts 426 → 445, assertions 2 557 → 2 753 (verified via
  doctest run); E5 row was missing test_e5_kat (19 cases)
- Interop checks 24 → 31, COMPLIANCE.md message count 149 → 164,
  COMPLIANCE.md "291 cases / 1515 assertions" → 445 / 2 753
- README "60+ test IDs" for MES_INTEROP → actual 59
- PVD example counts: 32 SVIDs/17 CEIDs → 29/21, "~40 handlers
  in ~200 lines" → 51 in ~460, "~700 lines" → ~1,100; main.cpp
  header table-of-contents resynced with the actual 7 sections

Out-of-scope honesty (COMPLIANCE.md §8 + FAQ.md):
- Removed HSMS-GS (was both  implemented in §1 and "out of scope"
  in §8; INTEGRATION.md §7 documents using it)
- Removed multi-block SECS-I (split_message/assemble_message exist
  with 4 dedicated tests)
- Added serial-port wiring as the genuine open  item — FSM is
  tested end-to-end over TCP; only the asio serial_port glue is
  deferred
- COMPLIANCE.md intro now lists E42 and notes "E37 (SS + GS)"

README restructure:
- Moved the 8-command proof table and per-standard test-coverage
  table to a new PROOFS.md (72 lines)
- README now leads with what / Quick start / Documentation map,
  then a one-paragraph "How it's proved" linking to PROOFS.md
- Updated cross-refs in FAQ.md, GLOSSARY.md, VERIFICATION.md, and
  interop/README.md to point at PROOFS.md

CI fix — tshark-dissector job:
- interop/tshark_validate.sh hardcoded /app/build/secs_server etc.
  which only works inside the docker image.  Now derives ROOT from
  the script's own location and accepts BUILD/SERVER/CLIENT/DATA
  env overrides, so CI can run it from the workspace dir
- Verified still passes in docker (69 frames, 0 malformed)

.gitignore:
- Added build-fuzz/ and build-tsan/ (were showing as untracked)

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-06-09 18:59:17 +02:00
raphael 6aa4427186 docs: worked PVD-tool vendor example
tests / build-and-test (push) Successful in 2m7s
tests / thread-sanitizer (push) Successful in 2m33s
tests / tshark-dissector (push) Failing after 2m10s
tests / secs4j-interop (push) Failing after 1s
tests / libfuzzer (push) Successful in 3m11s
A fictional Physical Vapor Deposition tool wired end-to-end.
examples/pvd_tool/ is the template a real customer should fork.

Files:
- equipment.yaml: 32 SVIDs (chamber pressure, temperature, source
  power, gas flows, cooling water, wafer counters, recipe step
  state, EPT name, 4 load ports), 5 DVIDs, 7 ECIDs (setpoints
  + T_CRA/T_DELAY + cleaning interval + retry count), 17 CEIDs
  (control state, alarms, process lifecycle, material movement,
  EPT), 12 alarms with realistic categories (safety, error,
  warning, attention), 3 multi-step recipes (Al / Ti / Cu),
  9 host commands.

- main.cpp (~860 lines): the vendor-side application:
  §1 helpers + constants
  §2 sensor simulator — 4 sensors at 10 Hz + 1 Hz cadences,
     random-walk around step-targeted setpoints, asio::post-on-strand
     thread-safety pattern
  §3 recipe runner — parses recipe body (STEP NAME duration=120s
     power=2500W gas=Argon flow=50sccm), walks each step at 1s
     per declared-second, fires step-started/completed CEIDs,
     drives PJ FSM through ProcessComplete
  §4 alarm threshold monitor — chamber-pressure-over-setpoint and
     cleaning-interval logic, continuous evaluation, set/clear
     emission gated on alarm-enable
  §5 EPT cycler — Standby ↔ Productive ↔ UnscheduledDowntime
     based on PJ activity + safety alarms
  §6 Prometheus exporter on :9090 (pvd_messages_total,
     pvd_chamber_pressure_torr, pvd_spool_depth, pvd_events_total,
     pvd_alarm_set_total)
  §7 Router handlers — full E30 set (~40 handlers) so a host can
     do real work
  §8 main() — YAML validation, model construction, server wiring,
     periodic gauge updates

- README.md: section-by-section walkthrough, what's the same as
  apps/secs_server.cpp, what this adds (simulator + recipe runner
  + alarm monitor + EPT cycler + metrics), what's not here
  (persistence + E84 + real I/O), and what to change for your tool.

Verification: 47/47 conformance harness checks PASS against the
PVD tool — same as the demo server.

CMakeLists.txt adds the pvd_tool target.

README's documentation map points at examples/pvd_tool/.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-06-09 16:57:10 +02:00