Files
monster/examples/README.md

35 lines
1.4 KiB
Markdown
Raw Normal View History

2026-02-19 17:37:09 +01:00
# 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
2026-02-19 17:37:09 +01:00
- `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
2026-02-19 17:37:09 +01:00
- `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.