Add "Home"
70
Home.md
Normal file
70
Home.md
Normal file
@@ -0,0 +1,70 @@
|
||||
# machineGroupControl (MGC)
|
||||
|
||||
Custom Node-RED node for coordinating multiple rotatingMachine children as a managed group.
|
||||
|
||||
## Overview
|
||||
|
||||
| Property | Value |
|
||||
|----------|-------|
|
||||
| **Version** | 0.9.0 |
|
||||
| **Category** | Group Control |
|
||||
| **Inputs** | 1 |
|
||||
| **Outputs** | 3 (process / dbase / parent) |
|
||||
| **Part of** | [EVOLV](https://gitea.wbd-rd.nl/RnD/EVOLV) |
|
||||
|
||||
## Purpose
|
||||
|
||||
The `machineGroupControl` (MGC) node acts as a parent coordinator for multiple `rotatingMachine` child nodes. It provides:
|
||||
|
||||
- **Group coordination** of machine start/stop sequences
|
||||
- **Position awareness** with configurable distance from parent
|
||||
- **Centralized state** aggregation of all child machines
|
||||
- **Logging** and telemetry for the group as a whole
|
||||
|
||||
## Configuration
|
||||
|
||||
| Field | Description | Default |
|
||||
|-------|-------------|---------|
|
||||
| `enableLog` | Enable node logging | false |
|
||||
| `logLevel` | Log verbosity level | - |
|
||||
| `positionVsParent` | Position relative to parent node | - |
|
||||
| `positionIcon` | Icon displayed in editor | - |
|
||||
| `hasDistance` | Whether distance is relevant | false |
|
||||
| `distance` | Distance from parent | - |
|
||||
| `distanceUnit` | Unit for distance | - |
|
||||
|
||||
## Child Nodes
|
||||
|
||||
Manages **[rotatingMachine](https://gitea.wbd-rd.nl/RnD/rotatingMachine)** children. Machines register via Port 2 messages.
|
||||
|
||||
## Inputs and Outputs
|
||||
|
||||
### Input (Port 0)
|
||||
Group-level commands and setpoints.
|
||||
|
||||
### Output Port 0 - Process Data
|
||||
Aggregated group state (running count, total flow/power).
|
||||
|
||||
### Output Port 1 - InfluxDB Telemetry
|
||||
Group-level time-series data.
|
||||
|
||||
### Output Port 2 - Parent Communication
|
||||
Registration and status messages to upstream nodes.
|
||||
|
||||
## Dependencies
|
||||
|
||||
- [generalFunctions](https://gitea.wbd-rd.nl/RnD/generalFunctions) (MenuManager, configManager)
|
||||
|
||||
## Technical Requirements
|
||||
|
||||
- Node.js >= 18
|
||||
- Node-RED >= 3.x
|
||||
- One or more `rotatingMachine` child nodes
|
||||
|
||||
## Testing
|
||||
|
||||
```bash
|
||||
node --test test/basic/*.test.js
|
||||
node --test test/integration/*.test.js
|
||||
node --test test/edge/*.test.js
|
||||
```
|
||||
Reference in New Issue
Block a user