docs: bring the documentation up to the daemon/client era

Public Access

A large gap had opened between the docs and the code: the README and
INTEGRATION guide did not mention the gRPC daemon or the Python client at
all (the entire vendor surface), ARCHITECTURE still described secs_server
as the ~1200-line canonical wiring example (it is a ~110-line thin main
over EquipmentRuntime), and test counts across six files were stale
(445/2753 -> 473/3087 core + the separate 125-assertion daemon suite).

- README: new "Integrating your tool (pick a tier)" section — Python
  client / any-language gRPC / embedded C++ — plus daemon tests and
  tools/run_interop.sh in the Testing section.
- ARCHITECTURE: layer diagram gains the vendor-surface and
  EquipmentRuntime/default_handlers tiers; stale wiring row fixed.
- INTEGRATION: three-tier chooser up front (this guide = the C++ tier).
- ch30 tour: secs_gemd + secs_gemd_tests in the binaries table.
- ch31: example alarm used a nonexistent `alcd:` field with bit 7 set
  (which the validator forbids) -> real `category:`/`name:` fields, and
  the roles: block documented.
- ch35: handler-location note now points at default_handlers.cpp's 15
  per-capability register_* functions.
- ch40: built-artifacts list + sample output counts.
- ch50: secsgem::gem runtime/default_handlers/handler_slot/name_index
  includes + new secsgem::daemon namespace section.
- PROOFS: test-count table gains the runtime/handlers/daemon row so the
  tally adds up; daemon suite noted. VERIFICATION/COMPLIANCE counts.
- interop/README: the one-command runner + the two daemon-track harnesses
  (daemon_interop, pyclient_interop).

Audited via a docs-vs-code sweep (the audit itself under-reported: it
validated counts textually; reality was 473/3087).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

This commit is contained in:

Raphael Maenle

2026-06-10 23:18:31 +02:00

parent 8686654b15

commit af1a159c59

12 changed files with 174 additions and 22 deletions

									
										docs/COMPLIANCE.md
									
		+1
		-1
	
												View File
												
				@@ -346,7 +346,7 @@ walks ~20 SECS transactions end-to-end:

				23. `S1F15`/`S1F16` Request Offline.

				24. `Separate.req` → clean close on both sides.

				Unit tests: **445 cases / 2753 assertions pass** (`docker compose run --rm tests`).

				Unit tests: **473 cases / 3087 assertions pass** (`docker compose run --rm tests`).

				The suite includes integration tests that drive a real `hsms::Connection`

				over a loopback socket pair to verify the E37 §7.2 / §7.4 / §7.7

				edge cases — not just the happy path.