docs(framing): reframe monster as a sampling-cabinet pulse counter
The repo's prior docs (CLAUDE.md, MEMORY notes, superproject overview) framed monster as a "multi-parameter biological process monitor" suggesting NH4/NO3/COD/TSS measurement. The source code only emits volumetric pulse + bucket state — no constituent analysis. The framing was misleading. Reframed to match the code. Also updated examples/README.md: removed references to four flow files that don't exist in the repo (`integration.flow.json`, `edge.flow.json`, `monster-dashboard.flow.json`, `monster-api-dashboard.flow.json`) and documented the actual two files (`basic.flow.json`, `02-integrated-e2e.json`). The missing flows stay tracked in wiki/Reference-Examples.md as TODOs. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -1,6 +1,6 @@
|
|||||||
# monster — Claude Code context
|
# monster — Claude Code context
|
||||||
|
|
||||||
Multi-parameter biological process monitoring.
|
Sampling-cabinet pulse counter — measures sampled volumes and pulse cadence; does *not* analyze constituents (NH4 / NO3 / COD / TSS). For multi-parameter analyses, wire the output to an upstream/downstream analyzer node.
|
||||||
Part of the [EVOLV](https://gitea.wbd-rd.nl/RnD/EVOLV) wastewater-automation platform.
|
Part of the [EVOLV](https://gitea.wbd-rd.nl/RnD/EVOLV) wastewater-automation platform.
|
||||||
|
|
||||||
## S88 classification
|
## S88 classification
|
||||||
|
|||||||
@@ -1,31 +1,34 @@
|
|||||||
# Monster Example Flows
|
# Monster Example Flows
|
||||||
|
|
||||||
Import-ready Node-RED examples for `monster`.
|
Import-ready Node-RED examples for `monster` — a sampling-cabinet pulse
|
||||||
|
counter (volumetric, not an analytical multi-parameter monitor; see
|
||||||
|
the framing note in `CONTRACT.md`).
|
||||||
|
|
||||||
|
## Files present in this repo
|
||||||
|
|
||||||
## Files
|
|
||||||
- `basic.flow.json`
|
- `basic.flow.json`
|
||||||
- Purpose: quick-start flow with dashboard charts for key monster outputs.
|
- Inject-driven quick-start flow with the dashboard widgets for the
|
||||||
- `integration.flow.json`
|
main monster outputs (`pulse`, `bucketVol`, `m3PerPuls`, `running`,
|
||||||
- Purpose: lightweight integration contract example (`registerChild` path).
|
`predFlow`).
|
||||||
- `edge.flow.json`
|
- `02-integrated-e2e.json`
|
||||||
- Purpose: unknown-topic/edge handling smoke example.
|
- End-to-end orchestration template: wires a flow source, a schedule,
|
||||||
- `monster-dashboard.flow.json`
|
rain-data input, and the dashboard surface. **Not yet validated
|
||||||
- Purpose: richer dashboard-focused visualization of process output.
|
against live Node-RED** — treat as a wiring reference until smoke-
|
||||||
- Includes:
|
tested. Placeholder credentials (`__SET_*__`) need to be replaced
|
||||||
- manual flow input
|
before any real deployment.
|
||||||
- manual start trigger
|
|
||||||
- seeded `rain_data` and `monsternametijden`
|
|
||||||
- parsed report fields (`m3Total`, `m3PerPuls`, `pulse`, `running`)
|
|
||||||
- `monster-api-dashboard.flow.json`
|
|
||||||
- Purpose: full orchestration template around `monster` with API paths and dashboard output.
|
|
||||||
- Includes:
|
|
||||||
- Open-Meteo weather fetch -> `rain_data`
|
|
||||||
- Aquon SFTP CSV fetch -> `monsternametijden`
|
|
||||||
- Z-Info token + import payload builder for `m3Total`/`m3PerPuls`
|
|
||||||
- dashboard API publish template (Grafana)
|
|
||||||
- placeholder-only credentials/hosts (`__SET_*__`)
|
|
||||||
|
|
||||||
## Notes
|
## Files referenced in earlier docs but not yet shipped
|
||||||
- `basic.flow.json` and `monster-dashboard.flow.json` are intentionally API-free.
|
|
||||||
- `monster-api-dashboard.flow.json` is the full API template variant and must be hardened with environment-backed secrets before production use.
|
`integration.flow.json`, `edge.flow.json`, `monster-dashboard.flow.json`,
|
||||||
- `ui-chart` uses series by `msg.topic` (`category: "topic"`, `categoryType: "msg"`).
|
and `monster-api-dashboard.flow.json` were mentioned by prior versions
|
||||||
|
of this README; they do not exist in the repo at this commit. They are
|
||||||
|
tracked as TODOs in `wiki/Reference-Examples.md`. When generated, follow
|
||||||
|
the tier convention used by the rotatingMachine examples
|
||||||
|
(`01-Basic.json`, `02-Integration.json`, `03-Dashboard.json`).
|
||||||
|
|
||||||
|
## Conventions
|
||||||
|
|
||||||
|
- `ui-chart` uses series by `msg.topic` (`category: "topic"`,
|
||||||
|
`categoryType: "msg"`).
|
||||||
|
- API templates (rain fetch / Aquon SFTP / Z-Info import) must be
|
||||||
|
hardened with environment-backed secrets before production use.
|
||||||
|
|||||||
Reference in New Issue
Block a user