before functional changes by codex
This commit is contained in:
31
examples/README.md
Normal file
31
examples/README.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# Monster Example Flows
|
||||
|
||||
Import-ready Node-RED examples for `monster`.
|
||||
|
||||
## Files
|
||||
- `basic.flow.json`
|
||||
- Purpose: quick-start flow with dashboard charts for key monster outputs.
|
||||
- `integration.flow.json`
|
||||
- Purpose: lightweight integration contract example (`registerChild` path).
|
||||
- `edge.flow.json`
|
||||
- Purpose: unknown-topic/edge handling smoke example.
|
||||
- `monster-dashboard.flow.json`
|
||||
- Purpose: richer dashboard-focused visualization of process output.
|
||||
- Includes:
|
||||
- manual flow input
|
||||
- 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
|
||||
- `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.
|
||||
- `ui-chart` uses series by `msg.topic` (`category: "topic"`, `categoryType: "msg"`).
|
||||
Reference in New Issue
Block a user