Add "Home"
82
Home.md
Normal file
82
Home.md
Normal file
@@ -0,0 +1,82 @@
|
||||
# valve
|
||||
|
||||
Custom Node-RED node for individual valve modeling and control.
|
||||
|
||||
## Overview
|
||||
|
||||
| Property | Value |
|
||||
|----------|-------|
|
||||
| **Version** | 0.0.1 |
|
||||
| **Category** | Process Control |
|
||||
| **Inputs** | 1 |
|
||||
| **Outputs** | 3 (process / dbase / parent) |
|
||||
| **Part of** | [EVOLV](https://gitea.wbd-rd.nl/RnD/EVOLV) |
|
||||
|
||||
## Purpose
|
||||
|
||||
The `valve` node models a single valve with open/close control and configurable reaction time. It provides:
|
||||
|
||||
- **On/off control** with position feedback
|
||||
- **Reaction time modeling** (configurable speed parameter)
|
||||
- **Asset identification** for maintenance tracking
|
||||
- **Position awareness** for pipeline topology
|
||||
|
||||
## Configuration
|
||||
|
||||
### Control
|
||||
|
||||
| Field | Description |
|
||||
|-------|-------------|
|
||||
| `speed` | Valve reaction time (open/close speed) |
|
||||
|
||||
### Asset Identification
|
||||
|
||||
| Field | Description |
|
||||
|-------|-------------|
|
||||
| `uuid` | Unique asset identifier |
|
||||
| `supplier` | Valve manufacturer |
|
||||
| `category` | Valve category |
|
||||
| `assetType` | Asset type classification |
|
||||
| `model` | Valve model |
|
||||
|
||||
### Logging
|
||||
|
||||
| Field | Description | Default |
|
||||
|-------|-------------|---------|
|
||||
| `enableLog` | Enable node logging | false |
|
||||
| `logLevel` | Log verbosity level | - |
|
||||
|
||||
## Parent Node
|
||||
|
||||
This node is typically a child of **[valveGroupControl](https://gitea.wbd-rd.nl/RnD/valveGroupControl)**, which coordinates multiple valves.
|
||||
|
||||
## Inputs and Outputs
|
||||
|
||||
### Input (Port 0)
|
||||
Open/close commands and position setpoints.
|
||||
|
||||
### Output Port 0 - Process Data
|
||||
Current valve position, state (open/closed/transitioning).
|
||||
|
||||
### Output Port 1 - InfluxDB Telemetry
|
||||
Valve state time-series data.
|
||||
|
||||
### Output Port 2 - Registration
|
||||
Parent registration messages for `valveGroupControl`.
|
||||
|
||||
## Dependencies
|
||||
|
||||
- [generalFunctions](https://gitea.wbd-rd.nl/RnD/generalFunctions) (MenuManager, configManager)
|
||||
|
||||
## Technical Requirements
|
||||
|
||||
- Node.js >= 18
|
||||
- Node-RED >= 3.x
|
||||
|
||||
## 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