raphael
813e011409
tests / build-and-test (push) Failing after 32s
Adds the GEM "Documentation" Fundamental capability: the equipment now
self-reports which GEM capabilities it supports, and the host can
discover the DVID namelist with the same shape used for SVIDs.
Catalog (data/messages.yaml -> generated messages.hpp)
S1F19 W header-only Get GEM Compliance Request
S1F20 <L,3 <A SOFTREV>
<A EQPTYP>
<L,a <L,2 <U1 CCODE> <A CDESC>>>>
Get GEM Compliance Data
S1F21 W <L,n <U4 VID>> DVID Namelist Request (n=0 = all)
S1F22 <L,n <L,3 <U4 VID>
<A VNAME>
<A UNITS>>> DVID Namelist Data
Codegen emits CapabilityEntry and GemCompliance structs. S1F22 reuses
S1F12's StatusName struct (same wire shape; dedup avoids redefinition).
Equipment data dictionary (data/equipment.yaml)
device: Adds `equipment_type: "EQUIPMENT"`
for the S1F20 EQPTYP field.
capabilities: New section. List of
- {code, name} (CCODE, CDESC) pairs honestly
reflecting what the codebase
implements: 1, 2, 3, 5, 6, 7, 8,
9, 11, 12, 14 (partial), 15.
dvids: New section, same schema as
svids:. Demo populates two:
- WaferCounter (U4, units wafer)
- ChamberPressure (F4, units Torr)
Loader (src/config/loader.cpp + include/secsgem/config/loader.hpp)
EquipmentDescriptor gains equipment_type and capabilities (vector of
(uint8_t, string) pairs). load_equipment now reads `capabilities:`
into the descriptor and `dvids:` into model.dvids.
Server (apps/secs_server.cpp)
router.on(1, 19) returns S1F20 with desc.software_rev,
desc.equipment_type, and desc.capabilities converted to
vector<CapabilityEntry>.
router.on(1, 21) returns S1F22 built from model.dvids.all().
Client (apps/secs_client.cpp)
Two new demo steps after Request Online and before SVID discovery:
S1F19 -> S1F20: logs SOFTREV, EQPTYP, and every (CCODE, CDESC)
the equipment claims.
S1F21 -> S1F22: logs each DVID with units.
Tests
tests/test_messages.cpp Round-trip S1F19/F20 with a 3-entry
capability list; round-trip S1F22 with two
DVIDs.
tests/test_loader.cpp Asserts equipment_type, the capabilities
list contains CCODE 14 (Spooling), and the
two DVIDs land in model.dvids.
COMPLIANCE.md
"Documentation" Fundamental moves from ⬜ to ✅.
S1F19/F20 + S1F21/F22 rows in the coverage matrix flip to ✅.
The "what would it take" list drops the documentation-messages bullet.
Verified
- Tests: 77 cases / 444 assertions pass.
- Demo: client logs the full capability list received from the
equipment, including CCODE 14 "Spooling (partial; S2F43/F44 +
S6F23/F24)" — the equipment honestly reports its partial
implementation rather than overclaiming.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
89 lines
3.7 KiB
YAML
89 lines
3.7 KiB
YAML
# Equipment data dictionary loaded by secs_server at startup. Adding a
|
|
# capability (SVID, ECID, CEID, alarm, recipe, command) is a YAML edit;
|
|
# no code change is required as long as the underlying message handler
|
|
# already exists in the C++ Router.
|
|
|
|
device:
|
|
id: 0
|
|
model_name: "SECSGEM-SIM"
|
|
software_rev: "0.1.0"
|
|
equipment_type: "EQUIPMENT" # S1F20 EQPTYP string
|
|
|
|
# Reported on S1F19 -> S1F20 (Get GEM Compliance). CCODE values follow
|
|
# E30 Appendix A; CDESC is implementer-defined. Keep this list honest:
|
|
# it should reflect what the equipment actually implements (see
|
|
# COMPLIANCE.md for the audit).
|
|
capabilities:
|
|
- {code: 1, name: "Establish Communications"}
|
|
- {code: 2, name: "Dynamic Event Report Configuration"}
|
|
- {code: 3, name: "Variable Data Collection"}
|
|
- {code: 5, name: "Status Data Collection"}
|
|
- {code: 6, name: "Alarm Management"}
|
|
- {code: 7, name: "Remote Control"}
|
|
- {code: 8, name: "Equipment Constants"}
|
|
- {code: 9, name: "Process Program Management"}
|
|
- {code: 11, name: "Equipment Terminal Services"}
|
|
- {code: 12, name: "Clock"}
|
|
- {code: 14, name: "Spooling (partial; S2F43/F44 + S6F23/F24)"}
|
|
- {code: 15, name: "Control (operator initiated)"}
|
|
|
|
# Reported on S1F3 (values) and S1F11 (namelist). `value` is the initial.
|
|
# `type` controls the SECS-II Item format.
|
|
svids:
|
|
- {id: 1, name: ControlState, units: "", type: ASCII, value: ""}
|
|
- {id: 2, name: Clock, units: "", type: ASCII, value: ""}
|
|
- {id: 3, name: EventsEnabled, units: "", type: BOOLEAN, value: true}
|
|
|
|
# Reported on S1F21/F22 (DVID namelist). Same shape as SVIDs.
|
|
dvids:
|
|
- {id: 100, name: WaferCounter, units: "wafer", type: U4, value: 0}
|
|
- {id: 101, name: ChamberPressure, units: "Torr", type: F4, value: 0.000001}
|
|
|
|
# Reported on S2F13 (values) / S2F29 (namelist) / S2F15 (set).
|
|
ecids:
|
|
- {id: 10, name: TimeFormat, units: "code", type: U4, value: 1, min: "0", max: "1"}
|
|
- {id: 11, name: EstablishCommTimeout, units: "sec", type: U4, value: 10, min: "1", max: "60"}
|
|
|
|
# Reported on S6F11. The host links these to reports via S2F35 and
|
|
# enables them via S2F37.
|
|
ceids:
|
|
- {id: 100, name: ControlStateChanged}
|
|
- {id: 200, name: AlarmSetEvent}
|
|
- {id: 300, name: ProcessStarted}
|
|
|
|
# Reported on S5F5 / S5F1. `category` is the lower-7 of ALCD.
|
|
alarms:
|
|
- {id: 1, text: "Chiller Temp High", category: 4}
|
|
- {id: 2, text: "Door Open", category: 1}
|
|
|
|
# Reported on S7F19. Body served by S7F5/F6.
|
|
recipes:
|
|
- {id: "RECIPE-A", body: "STEP CHAMBER ARGON 30s\nSTEP CHAMBER NITROGEN 60s\nEND"}
|
|
- {id: "RECIPE-B", body: "STEP HEATER 800C 120s\nEND"}
|
|
|
|
# Dispatched by S2F41. `ack` is the HCACK enum value. Optional `emit_ceid`
|
|
# fires a CEID after dispatch (e.g. ProcessStarted on START), and optional
|
|
# `set_alarm` activates an alarm (e.g. FAULT -> alarm 1). `force_spool`
|
|
# (true/false) flips the spool store's test-force flag — for the demo this
|
|
# stands in for "the host link has gone down" without actually dropping
|
|
# TCP.
|
|
host_commands:
|
|
- {name: START, ack: Accept, emit_ceid: 300}
|
|
- {name: STOP, ack: Accept}
|
|
- {name: PAUSE, ack: CannotDoNow}
|
|
- {name: FAULT, ack: Accept, set_alarm: 1}
|
|
- {name: SPOOL_ON, ack: Accept, force_spool: true}
|
|
- {name: SPOOL_OFF, ack: Accept, force_spool: false}
|
|
|
|
# Spool (E30 §6.22). Streams listed here may be queued by the equipment
|
|
# when the host is unreachable; queued messages drain when the host sends
|
|
# S6F23 with RSDC=0. max_size caps the in-memory queue (FIFO eviction on
|
|
# overflow).
|
|
spool:
|
|
max_size: 100
|
|
spoolable_streams: [5, 6]
|
|
|
|
# CEID emitted automatically whenever the control state machine transitions
|
|
# (i.e. on every change-handler call). Set to null to disable.
|
|
emit_on_control_change: 100
|