From 144460e6ba6b2c9e8ae7c35da151ae1075d689da Mon Sep 17 00:00:00 2001 From: znetsixe Date: Tue, 19 May 2026 10:11:50 +0200 Subject: [PATCH] docs(wiki): regenerate topic-contract AUTOGEN block via wiki-gen Replaces the agent-written placeholder inside Reference-Contracts.md with the authoritative table generated from src/commands/index.js. Both the BEGIN and END markers are normalized to the canonical form used by `@evolv/wiki-gen`. Co-Authored-By: Claude Opus 4.7 (1M context) --- wiki/Reference-Contracts.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/wiki/Reference-Contracts.md b/wiki/Reference-Contracts.md index 6cb99f4..49ed8f6 100644 --- a/wiki/Reference-Contracts.md +++ b/wiki/Reference-Contracts.md @@ -13,21 +13,21 @@ The registry lives in `src/commands/index.js`. Each descriptor maps a canonical `msg.topic` to its handler; aliases emit a one-time deprecation warning the first time they fire. - + | Canonical topic | Aliases | Payload | Unit | Effect | -|:---|:---|:---|:---|:---| -| `set.mode` | `setMode` | `string` (`auto` / `virtualControl` / `fysicalControl` / `maintenance`) | — | Calls `source.setMode(payload)`. Invalid mode logs `warn` and is dropped. | -| `cmd.startup` | — | `{ source?: string }` | — | `source.handleInput(payload.source ?? 'parent', 'execSequence', 'startup')` — runs the configured `startup` sequence (default `[starting, warmingup, operational]`). | -| `cmd.shutdown` | — | `{ source?: string }` | — | `source.handleInput(..., 'execSequence', 'shutdown')`. Pre-shutdown the valve ramps to position 0 if currently `operational`. | -| `cmd.estop` | `emergencystop`, `emergencyStop` | `{ source?: string, action?: string }` | — | `source.handleInput(payload.source ?? 'parent', payload.action ?? 'emergencystop')` — runs the `emergencystop` sequence (default `[emergencystop, off]`). | -| `set.position` | `execMovement` | `{ source?: string, action?: string, setpoint: number }` | control % (no `units`; no `percent` measure in convert) | `source.handleInput(..., 'execMovement', Number(payload.setpoint))` — moves the valve to a position via `state.moveTo`. | -| `data.flow` | `updateFlow` | `{ variant, value, position, unit? }` — `variant ∈ {'measured','predicted'}` | `volumeFlowRate` (default `m3/h`) | `source.updateFlow(...)` — pushes a flow value into MeasurementContainer at `` and triggers a deltaP recompute. | -| `query.curve` | `showcurve` | any | — | `source.showCurve()` — replies on **Port 0** with `{ topic: 'Showing curve', payload: }` via `ctx.send`. | -| `child.register` | `registerChild` | `string` (child node id); `msg.positionVsParent` carries the position label | — | Resolves the child via `RED.nodes.getNode(payload)` and registers it through `childRegistrationUtils.registerChild(child.source, msg.positionVsParent)`. The valve's `registerChild` records the child for fluid-contract tracking. | -| `execSequence` | — (legacy umbrella, `_legacy: true`) | `{ source, action, parameter }` with `action ∈ {'startup','shutdown','emergencyStop','emergencystop'}` | — | Content-based router: forwards to canonical `cmd.startup` / `cmd.shutdown` / `cmd.estop` based on `payload.action`. Unknown action logs `warn`. Prefer the canonical `cmd.*` topics. | +|---|---|---|---|---| +| `set.mode` | `setMode` | `string` | — | Switch the valve between auto / manual control modes. | +| `cmd.startup` | — | any | — | Initiate the valve startup sequence. | +| `cmd.shutdown` | — | any | — | Initiate the valve shutdown sequence. | +| `cmd.estop` | `emergencystop`, `emergencyStop` | any | — | Trigger an emergency stop on the valve. | +| `execSequence` | — | `object` | — | Legacy umbrella that demuxes payload.action to startup / shutdown / estop. | +| `set.position` | `execMovement` | `object` | — | Move the valve to a control-% position via execMovement. | +| `data.flow` | `updateFlow` | `object` | — | Push a measured flow into the valve (variant + position + unit). | +| `query.curve` | `showcurve` | any | — | Return the valve characteristic curve on the reply port. | +| `child.register` | `registerChild` | `string` | — | Register a child measurement with this valve. | - + ### `execSequence` demux