refactor: regenerate Home.md with 14-section visual-first template
70
Home.md
70
Home.md
@@ -1,70 +0,0 @@
|
|||||||
# settler
|
|
||||||
|
|
||||||
Custom Node-RED node for secondary clarifier and sludge settling simulation.
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
| Property | Value |
|
|
||||||
|----------|-------|
|
|
||||||
| **Version** | 0.0.1 |
|
|
||||||
| **Category** | Biological Process |
|
|
||||||
| **Inputs** | 1 |
|
|
||||||
| **Outputs** | 3 (process / dbase / parent) |
|
|
||||||
| **Part of** | [EVOLV](https://gitea.wbd-rd.nl/RnD/EVOLV) |
|
|
||||||
|
|
||||||
## Purpose
|
|
||||||
|
|
||||||
The `settler` node models a secondary clarifier (settling tank) that receives mixed liquor from an upstream `reactor` node. It simulates:
|
|
||||||
|
|
||||||
- **Gravity settling** of suspended solids
|
|
||||||
- **Sludge blanket** height tracking
|
|
||||||
- **Return Activated Sludge (RAS)** concentration
|
|
||||||
- **Effluent quality** (clarified water)
|
|
||||||
- **Waste Activated Sludge (WAS)** removal
|
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
| Field | Description | Default |
|
|
||||||
|-------|-------------|---------|
|
|
||||||
| `name` | Node display name | - |
|
|
||||||
| `enableLog` | Enable node logging | false |
|
|
||||||
| `logLevel` | Log verbosity level | - |
|
|
||||||
| `positionVsParent` | Position relative to parent | - |
|
|
||||||
|
|
||||||
## Upstream Connection
|
|
||||||
|
|
||||||
The settler receives effluent from a **[reactor](https://gitea.wbd-rd.nl/RnD/reactor)** node. The reactor registers as an upstream child, and the settler pulls effluent data on state changes via the `getEffluent` method.
|
|
||||||
|
|
||||||
**Integration note:** The `_connectReactor` method expects `getEffluent` to return an array. This was a known bug fixed on 2026-03-02.
|
|
||||||
|
|
||||||
## Inputs and Outputs
|
|
||||||
|
|
||||||
### Input (Port 0)
|
|
||||||
Configuration updates and control commands.
|
|
||||||
|
|
||||||
### Output Port 0 - Process Data
|
|
||||||
Settler state: sludge blanket height, effluent quality, RAS concentration.
|
|
||||||
|
|
||||||
### Output Port 1 - InfluxDB Telemetry
|
|
||||||
Time-series data for settling parameters.
|
|
||||||
|
|
||||||
### Output Port 2 - Registration
|
|
||||||
Upstream reactor connection messages.
|
|
||||||
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
- [generalFunctions](https://gitea.wbd-rd.nl/RnD/generalFunctions) (MenuManager)
|
|
||||||
|
|
||||||
## Technical Requirements
|
|
||||||
|
|
||||||
- Node.js >= 18
|
|
||||||
- Node-RED >= 3.x
|
|
||||||
- Upstream `reactor` node configured and connected
|
|
||||||
|
|
||||||
## 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