New standard, pilot pass for pumpingStation. Sets the pattern the other 10 nodes will follow once we sign off on this one. Zone A (wiki/Home.md, ~180 lines): - one-sentence opener - "at a glance" 5-row fact table - "How it looks in Node-RED" — screenshot placeholder - "What it models" — embeds the existing basin-model.drawio.svg - "Try it" — 3-minute demo with curl-load command, click list, GIF placeholder - "Typical wiring" — two placeholder screenshots (standalone + integrated), no mermaid (per user direction) - "The five things you'll send" + sample Port-0 payload table - "Need more?" footer linking to Reference-* siblings Zone B (4 sibling pages): - Reference-Contracts.md — full topic contract + data model (AUTOGEN markers); config schema; child registration filters; unit policy - Reference-Architecture.md — 3-tier code layout; safety FSM (stateDiagram-v2); tick lifecycle (sequenceDiagram); output ports - Reference-Examples.md — 01-Basic / 02-Integration / 03-Dashboard walk-through with per-example screenshot + GIF placeholders; debug-recipes table - Reference-Limitations.md — implemented vs schema-only modes; basin-shape constraint; net-flow source caveat; alias-removal map Asset directory placeholders created: - wiki/_partial-screenshots/pumpingStation/.gitkeep - wiki/_partial-gifs/pumpingStation/.gitkeep - wiki/_partial-flows/pumpingStation/.gitkeep Abandoned per user direction (no longer linked, removed from source): - wiki/README.md - wiki/functional-description.md (377 lines retired) - wiki/modes/*.md (5 files retired) Diagrams kept in place (wiki/diagrams/*.drawio.svg) — referenced from Home and Reference-Architecture. package.json: wiki:contract + wiki:datamodel now target Reference-Contracts.md instead of Home.md. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
33 lines
984 B
JSON
33 lines
984 B
JSON
{
|
|
"name": "pumpingstation",
|
|
"version": "1.0.0",
|
|
"description": "Control module",
|
|
"main": "pumpingStation.js",
|
|
"scripts": {
|
|
"test": "node --test test/",
|
|
"wiki:contract": "node ../generalFunctions/scripts/wikiGen.js contract ./src/commands/index.js --write ./wiki/Reference-Contracts.md",
|
|
"wiki:datamodel": "node ../generalFunctions/scripts/wikiGen.js datamodel ./src/specificClass.js --write ./wiki/Reference-Contracts.md",
|
|
"wiki:all": "npm run wiki:contract && npm run wiki:datamodel"
|
|
},
|
|
"repository": {
|
|
"type": "git",
|
|
"url": "https://gitea.centraal.wbd-rd.nl/RnD/pumpingStation.git"
|
|
},
|
|
"keywords": [
|
|
"pumpingstation",
|
|
"node-red",
|
|
"recipient",
|
|
"water"
|
|
],
|
|
"author": "Rene De Ren",
|
|
"license": "SEE LICENSE",
|
|
"dependencies": {
|
|
"generalFunctions": "git+https://gitea.centraal.wbd-rd.nl/RnD/generalFunctions.git"
|
|
},
|
|
"node-red": {
|
|
"nodes": {
|
|
"pumpingstation": "pumpingStation.js"
|
|
}
|
|
}
|
|
}
|