4eb286771e
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>
35 lines
1.4 KiB
Markdown
35 lines
1.4 KiB
Markdown
# Monster Example Flows
|
|
|
|
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
|
|
|
|
- `basic.flow.json`
|
|
- Inject-driven quick-start flow with the dashboard widgets for the
|
|
main monster outputs (`pulse`, `bucketVol`, `m3PerPuls`, `running`,
|
|
`predFlow`).
|
|
- `02-integrated-e2e.json`
|
|
- End-to-end orchestration template: wires a flow source, a schedule,
|
|
rain-data input, and the dashboard surface. **Not yet validated
|
|
against live Node-RED** — treat as a wiring reference until smoke-
|
|
tested. Placeholder credentials (`__SET_*__`) need to be replaced
|
|
before any real deployment.
|
|
|
|
## Files referenced in earlier docs but not yet shipped
|
|
|
|
`integration.flow.json`, `edge.flow.json`, `monster-dashboard.flow.json`,
|
|
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.
|