Add "Home"
68
Home.md
Normal file
68
Home.md
Normal file
@@ -0,0 +1,68 @@
|
|||||||
|
# valveGroupControl (VGC)
|
||||||
|
|
||||||
|
Custom Node-RED node for coordinating multiple valve children as a managed group.
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
| Property | Value |
|
||||||
|
|----------|-------|
|
||||||
|
| **Version** | 0.0.1 |
|
||||||
|
| **Category** | Group Control |
|
||||||
|
| **Inputs** | 1 |
|
||||||
|
| **Outputs** | 3 (process / dbase / parent) |
|
||||||
|
| **Part of** | [EVOLV](https://gitea.wbd-rd.nl/RnD/EVOLV) |
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
The `valveGroupControl` (VGC) node acts as a parent coordinator for multiple `valve` child nodes. It provides:
|
||||||
|
|
||||||
|
- **Group coordination** of valve open/close operations
|
||||||
|
- **Position awareness** with configurable distance and icons
|
||||||
|
- **Centralized state** aggregation for all child valves
|
||||||
|
- **Logging** and telemetry for the valve group
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
| Field | Description | Default |
|
||||||
|
|-------|-------------|---------|
|
||||||
|
| `enableLog` | Enable node logging | false |
|
||||||
|
| `logLevel` | Log verbosity level | - |
|
||||||
|
| `positionVsParent` | Position relative to parent | - |
|
||||||
|
| `positionIcon` | Icon displayed in editor | - |
|
||||||
|
| `distance` | Distance from parent | - |
|
||||||
|
|
||||||
|
## Child Nodes
|
||||||
|
|
||||||
|
Manages **[valve](https://gitea.wbd-rd.nl/RnD/valve)** children. Valves register via Port 2 messages.
|
||||||
|
|
||||||
|
## Inputs and Outputs
|
||||||
|
|
||||||
|
### Input (Port 0)
|
||||||
|
Group-level commands (open all, close all, selective control).
|
||||||
|
|
||||||
|
### Output Port 0 - Process Data
|
||||||
|
Aggregated valve group state.
|
||||||
|
|
||||||
|
### 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 `valve` 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