Files
rotatingMachine/examples/README.md
znetsixe 6b2a8239f2 updates
2026-03-11 11:13:26 +01:00

54 lines
1.9 KiB
Markdown

# RotatingMachine Example Flows
These flows are import-ready Node-RED examples for the `rotatingMachine` node.
In Node-RED: **Import > Examples > EVOLV** to find them.
## Example Flows
### 01 - Basic Manual Control
**Dependencies:** EVOLV only (no dashboard)
Inject-based flow demonstrating all core functionality:
- Mode switching (auto / virtualControl / fysicalControl)
- Startup/shutdown/emergency sequences
- Speed setpoint control (30%, 60%, 100%)
- Pressure simulation (upstream + downstream)
- Maintenance mode enter/leave
- Debug outputs on all 3 ports
### 02 - Integration with Machine Group
**Dependencies:** EVOLV only (no dashboard)
Parent-child relationship demo:
- machineGroupControl parent with 2x rotatingMachine children
- Auto-registration via Port 2 on deploy
- Independent pump control with group-level aggregation
- Pressure simulation on individual pumps
### 03 - Dashboard Visualization
**Dependencies:** EVOLV + @flowfuse/node-red-dashboard
Interactive FlowFuse dashboard with:
- Mode dropdown, startup/shutdown/emergency buttons
- Speed setpoint input, pressure simulation inputs
- Real-time charts: flow, power, ctrl%, NCog, state code, pressure
## Legacy Files
The following files are from the original flow set and will be removed in a future release:
- `basic.flow.json` → replaced by `01 - Basic Manual Control.json`
- `integration.flow.json` → replaced by `02 - Integration with Machine Group.json`
- `edge.flow.json` → edge-case testing (inject-based)
## Import
1. In Node-RED, use **Import > Examples > EVOLV** (auto-discovered)
2. Or manually: **Import > Clipboard** and paste the `.json` file contents
3. Deploy
## Notes
- Tier 1 and 2 examples have zero dashboard dependencies — they work on any Node-RED install with EVOLV
- Tier 3 requires `@flowfuse/node-red-dashboard` (included in EVOLV's package.json dependencies)
- All examples use `enableLog: true` so you can observe behavior in the Node-RED debug panel