a6f09d821d
Entry/HTML files should be dashboardAPI.{js,html} (case-sensitive match with
the folder name). Rename when the file is next touched. Full rule:
.claude/rules/node-architecture.md in the EVOLV superproject.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
49 lines
1.9 KiB
Markdown
49 lines
1.9 KiB
Markdown
# dashboardAPI — Claude Code context
|
|
|
|
InfluxDB telemetry and FlowFuse chart endpoints.
|
|
Part of the [EVOLV](https://gitea.wbd-rd.nl/RnD/EVOLV) wastewater-automation platform.
|
|
|
|
## S88 classification
|
|
|
|
| Level | Colour | Placement lane |
|
|
|---|---|---|
|
|
| **Utility (no S88 level)** | `none` | n/a |
|
|
|
|
## Flow layout rules
|
|
|
|
When wiring this node into a multi-node demo or production flow, follow the
|
|
placement rule set in the **EVOLV superproject**:
|
|
|
|
> `.claude/rules/node-red-flow-layout.md` (in the EVOLV repo root)
|
|
|
|
Key points for this node:
|
|
- Place on lane **n/a** (x-position per the lane table in the rule).
|
|
- Stack same-level siblings vertically.
|
|
- Parent/children sit on adjacent lanes (children one lane left, parent one lane right).
|
|
- Wrap in a Node-RED group box coloured `none` (Utility (no S88 level)).
|
|
|
|
## Folder & File Layout
|
|
|
|
Every per-node file MUST use the folder name (`dashboardAPI`) **exactly**, case-sensitive. Full rule: [`.claude/rules/node-architecture.md`](https://gitea.wbd-rd.nl/RnD/EVOLV/src/branch/development/.claude/rules/node-architecture.md) in the EVOLV superproject.
|
|
|
|
| Path | Required name |
|
|
|---|---|
|
|
| Entry file | `dashboardAPI.js` |
|
|
| Editor HTML | `dashboardAPI.html` |
|
|
| Node adapter | `src/nodeClass.js` |
|
|
| Domain logic | `src/specificClass.js` |
|
|
| Editor JS modules | `src/editor/*.js` (extract when inline editor JS exceeds ~50 lines) |
|
|
| Tests | `test/{basic,integration,edge}/*.test.js` |
|
|
| Example flows | `examples/*.flow.json` |
|
|
|
|
> ⚠️ **Legacy naming drift in this repo** — to be renamed when the file is next touched:
|
|
>
|
|
> | Path | Currently | Should be |
|
|
> |---|---|---|
|
|
> | Entry file | `dashboardapi.js` | `dashboardAPI.js` |
|
|
> | Editor HTML | `dashboardapi.html` | `dashboardAPI.html` |
|
|
>
|
|
> Renames require updating: the file itself, `package.json#node-red.nodes`, any `require()` / `import` paths, and superproject submodule references in one commit.
|
|
|
|
When adding new files, read the rule above first to avoid drift.
|