RnD/settler
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Compare commits

base: RnD:a369361d9902fd007f589d24deb857802061721d
Branches Tags
RnD:main
...
compare: RnD:main
Branches Tags
RnD:main

5 Commits
a369361d99 ... main

Author SHA1 Message Date
znetsixe
b199663c77 docs: add CLAUDE.md with S88 classification and superproject rule reference 
References the flow-layout rule set in the EVOLV superproject
(.claude/rules/node-red-flow-layout.md) so Claude Code sessions working
in this repo know the S88 level, colour, and placement lane for this node.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
 2026-04-14 07:47:26 +02:00
znetsixe
518262ac98 Merge remote-tracking branch 'origin/main' into dev-Rene 
# Conflicts:
#	settler.html
#	src/nodeClass.js
#	src/specificClass.js
 2026-03-31 16:26:04 +02:00
root
9af42bdc4c Harden settler runtime and scaffold tests 2026-03-31 14:26:10 +02:00
Rene De Ren
a650ca4856 Expose output format selectors in editor 2026-03-12 16:39:25 +01:00
Rene De Ren
fdfb9edf0d fix: replace console.log with logger for unknown topic warning 
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
 2026-03-12 09:33:31 +01:00
21 changed files with 518 additions and 376 deletions
Expand all files Collapse all files

272
.gitignore vendored
View File

@@ -1,136 +1,136 @@
# Logs # Logs
logs logs
*.log *.log
npm-debug.log* npm-debug.log*
yarn-debug.log* yarn-debug.log*
yarn-error.log* yarn-error.log*
lerna-debug.log* lerna-debug.log*
.pnpm-debug.log* .pnpm-debug.log*
# Diagnostic reports (https://nodejs.org/api/report.html) # Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
# Runtime data # Runtime data
pids pids
*.pid *.pid
*.seed *.seed
*.pid.lock *.pid.lock
# Directory for instrumented libs generated by jscoverage/JSCover # Directory for instrumented libs generated by jscoverage/JSCover
lib-cov lib-cov
# Coverage directory used by tools like istanbul # Coverage directory used by tools like istanbul
coverage coverage
*.lcov *.lcov
# nyc test coverage # nyc test coverage
.nyc_output .nyc_output
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt .grunt
# Bower dependency directory (https://bower.io/) # Bower dependency directory (https://bower.io/)
bower_components bower_components
# node-waf configuration # node-waf configuration
.lock-wscript .lock-wscript
# Compiled binary addons (https://nodejs.org/api/addons.html) # Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release build/Release
# Dependency directories # Dependency directories
node_modules/ node_modules/
jspm_packages/ jspm_packages/
# Snowpack dependency directory (https://snowpack.dev/) # Snowpack dependency directory (https://snowpack.dev/)
web_modules/ web_modules/
# TypeScript cache # TypeScript cache
*.tsbuildinfo *.tsbuildinfo
# Optional npm cache directory # Optional npm cache directory
.npm .npm
# Optional eslint cache # Optional eslint cache
.eslintcache .eslintcache
# Optional stylelint cache # Optional stylelint cache
.stylelintcache .stylelintcache
# Microbundle cache # Microbundle cache
.rpt2_cache/ .rpt2_cache/
.rts2_cache_cjs/ .rts2_cache_cjs/
.rts2_cache_es/ .rts2_cache_es/
.rts2_cache_umd/ .rts2_cache_umd/
# Optional REPL history # Optional REPL history
.node_repl_history .node_repl_history
# Output of 'npm pack' # Output of 'npm pack'
*.tgz *.tgz
# Yarn Integrity file # Yarn Integrity file
.yarn-integrity .yarn-integrity
# dotenv environment variable files # dotenv environment variable files
.env .env
.env.development.local .env.development.local
.env.test.local .env.test.local
.env.production.local .env.production.local
.env.local .env.local
# parcel-bundler cache (https://parceljs.org/) # parcel-bundler cache (https://parceljs.org/)
.cache .cache
.parcel-cache .parcel-cache
# Next.js build output # Next.js build output
.next .next
out out
# Nuxt.js build / generate output # Nuxt.js build / generate output
.nuxt .nuxt
dist dist
# Gatsby files # Gatsby files
.cache/ .cache/
# Comment in the public line in if your project uses Gatsby and not Next.js # Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support # https://nextjs.org/blog/next-9-1#public-directory-support
# public # public
# vuepress build output # vuepress build output
.vuepress/dist .vuepress/dist
# vuepress v2.x temp and cache directory # vuepress v2.x temp and cache directory
.temp .temp
.cache .cache
# vitepress build output # vitepress build output
**/.vitepress/dist **/.vitepress/dist
# vitepress cache directory # vitepress cache directory
**/.vitepress/cache **/.vitepress/cache
# Docusaurus cache and generated files # Docusaurus cache and generated files
.docusaurus .docusaurus
# Serverless directories # Serverless directories
.serverless/ .serverless/
# FuseBox cache # FuseBox cache
.fusebox/ .fusebox/
# DynamoDB Local files # DynamoDB Local files
.dynamodb/ .dynamodb/
# TernJS port file # TernJS port file
.tern-port .tern-port
# Stores VSCode versions used for testing VSCode extensions # Stores VSCode versions used for testing VSCode extensions
.vscode-test .vscode-test
# yarn v2 # yarn v2
.yarn/cache .yarn/cache
.yarn/unplugged .yarn/unplugged
.yarn/build-state.yml .yarn/build-state.yml
.yarn/install-state.gz .yarn/install-state.gz
.pnp.* .pnp.*

23
CLAUDE.md Normal file
View File

@@ -0,0 +1,23 @@
# settler — Claude Code context
Secondary clarifier / sludge settling.
Part of the [EVOLV](https://gitea.wbd-rd.nl/RnD/EVOLV) wastewater-automation platform.
## S88 classification
| Level | Colour | Placement lane |
|---|---|---|
| **Unit** | `#50a8d9` | L4 |
## Flow layout rules
When wiring this node into a multi-node demo or production flow, follow the
placement rule set in the **EVOLV superproject**:
> `.claude/rules/node-red-flow-layout.md` (in the EVOLV repo root)
Key points for this node:
- Place on lane **L4** (x-position per the lane table in the rule).
- Stack same-level siblings vertically.
- Parent/children sit on adjacent lanes (children one lane left, parent one lane right).
- Wrap in a Node-RED group box coloured `#50a8d9` (Unit).

380
LICENSE
View File

@@ -1,190 +1,190 @@
EUROPEAN UNION PUBLIC LICENCE v. 1.2 EUROPEAN UNION PUBLIC LICENCE v. 1.2
EUPL © the European Union 2007, 2016 EUPL © the European Union 2007, 2016
This European Union Public Licence (the ‘EUPL’) applies to the Work (as defined below) which is provided under the This European Union Public Licence (the ‘EUPL’) applies to the Work (as defined below) which is provided under the
terms of this Licence. Any use of the Work, other than as authorised under this Licence is prohibited (to the extent such terms of this Licence. Any use of the Work, other than as authorised under this Licence is prohibited (to the extent such
use is covered by a right of the copyright holder of the Work). use is covered by a right of the copyright holder of the Work).
The Work is provided under the terms of this Licence when the Licensor (as defined below) has placed the following The Work is provided under the terms of this Licence when the Licensor (as defined below) has placed the following
notice immediately following the copyright notice for the Work: notice immediately following the copyright notice for the Work:
Licensed under the EUPL Licensed under the EUPL
or has expressed by any other means his willingness to license under the EUPL. or has expressed by any other means his willingness to license under the EUPL.
1.Definitions 1.Definitions
In this Licence, the following terms have the following meaning: In this Licence, the following terms have the following meaning:
— ‘The Licence’:this Licence. — ‘The Licence’:this Licence.
— ‘The Original Work’:the work or software distributed or communicated by the Licensor under this Licence, available — ‘The Original Work’:the work or software distributed or communicated by the Licensor under this Licence, available
as Source Code and also as Executable Code as the case may be. as Source Code and also as Executable Code as the case may be.
— ‘Derivative Works’:the works or software that could be created by the Licensee, based upon the Original Work or — ‘Derivative Works’:the works or software that could be created by the Licensee, based upon the Original Work or
modifications thereof. This Licence does not define the extent of modification or dependence on the Original Work modifications thereof. This Licence does not define the extent of modification or dependence on the Original Work
required in order to classify a work as a Derivative Work; this extent is determined by copyright law applicable in required in order to classify a work as a Derivative Work; this extent is determined by copyright law applicable in
the country mentioned in Article 15. the country mentioned in Article 15.
— ‘The Work’:the Original Work or its Derivative Works. — ‘The Work’:the Original Work or its Derivative Works.
— ‘The Source Code’:the human-readable form of the Work which is the most convenient for people to study and — ‘The Source Code’:the human-readable form of the Work which is the most convenient for people to study and
modify. modify.
— ‘The Executable Code’:any code which has generally been compiled and which is meant to be interpreted by — ‘The Executable Code’:any code which has generally been compiled and which is meant to be interpreted by
a computer as a program. a computer as a program.
— ‘The Licensor’:the natural or legal person that distributes or communicates the Work under the Licence. — ‘The Licensor’:the natural or legal person that distributes or communicates the Work under the Licence.
— ‘Contributor(s)’:any natural or legal person who modifies the Work under the Licence, or otherwise contributes to — ‘Contributor(s)’:any natural or legal person who modifies the Work under the Licence, or otherwise contributes to
the creation of a Derivative Work. the creation of a Derivative Work.
— ‘The Licensee’ or ‘You’:any natural or legal person who makes any usage of the Work under the terms of the — ‘The Licensee’ or ‘You’:any natural or legal person who makes any usage of the Work under the terms of the
Licence. Licence.
— ‘Distribution’ or ‘Communication’:any act of selling, giving, lending, renting, distributing, communicating, — ‘Distribution’ or ‘Communication’:any act of selling, giving, lending, renting, distributing, communicating,
transmitting, or otherwise making available, online or offline, copies of the Work or providing access to its essential transmitting, or otherwise making available, online or offline, copies of the Work or providing access to its essential
functionalities at the disposal of any other natural or legal person. functionalities at the disposal of any other natural or legal person.
2.Scope of the rights granted by the Licence 2.Scope of the rights granted by the Licence
The Licensor hereby grants You a worldwide, royalty-free, non-exclusive, sublicensable licence to do the following, for The Licensor hereby grants You a worldwide, royalty-free, non-exclusive, sublicensable licence to do the following, for
the duration of copyright vested in the Original Work: the duration of copyright vested in the Original Work:
— use the Work in any circumstance and for all usage, — use the Work in any circumstance and for all usage,
— reproduce the Work, — reproduce the Work,
— modify the Work, and make Derivative Works based upon the Work, — modify the Work, and make Derivative Works based upon the Work,
— communicate to the public, including the right to make available or display the Work or copies thereof to the public — communicate to the public, including the right to make available or display the Work or copies thereof to the public
and perform publicly, as the case may be, the Work, and perform publicly, as the case may be, the Work,
— distribute the Work or copies thereof, — distribute the Work or copies thereof,
— lend and rent the Work or copies thereof, — lend and rent the Work or copies thereof,
— sublicense rights in the Work or copies thereof. — sublicense rights in the Work or copies thereof.
Those rights can be exercised on any media, supports and formats, whether now known or later invented, as far as the Those rights can be exercised on any media, supports and formats, whether now known or later invented, as far as the
applicable law permits so. applicable law permits so.
In the countries where moral rights apply, the Licensor waives his right to exercise his moral right to the extent allowed In the countries where moral rights apply, the Licensor waives his right to exercise his moral right to the extent allowed
by law in order to make effective the licence of the economic rights here above listed. by law in order to make effective the licence of the economic rights here above listed.
The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to any patents held by the Licensor, to the The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to any patents held by the Licensor, to the
extent necessary to make use of the rights granted on the Work under this Licence. extent necessary to make use of the rights granted on the Work under this Licence.
3.Communication of the Source Code 3.Communication of the Source Code
The Licensor may provide the Work either in its Source Code form, or as Executable Code. If the Work is provided as The Licensor may provide the Work either in its Source Code form, or as Executable Code. If the Work is provided as
Executable Code, the Licensor provides in addition a machine-readable copy of the Source Code of the Work along with Executable Code, the Licensor provides in addition a machine-readable copy of the Source Code of the Work along with
each copy of the Work that the Licensor distributes or indicates, in a notice following the copyright notice attached to each copy of the Work that the Licensor distributes or indicates, in a notice following the copyright notice attached to
the Work, a repository where the Source Code is easily and freely accessible for as long as the Licensor continues to the Work, a repository where the Source Code is easily and freely accessible for as long as the Licensor continues to
distribute or communicate the Work. distribute or communicate the Work.
4.Limitations on copyright 4.Limitations on copyright
Nothing in this Licence is intended to deprive the Licensee of the benefits from any exception or limitation to the Nothing in this Licence is intended to deprive the Licensee of the benefits from any exception or limitation to the
exclusive rights of the rights owners in the Work, of the exhaustion of those rights or of other applicable limitations exclusive rights of the rights owners in the Work, of the exhaustion of those rights or of other applicable limitations
thereto. thereto.
5.Obligations of the Licensee 5.Obligations of the Licensee
The grant of the rights mentioned above is subject to some restrictions and obligations imposed on the Licensee. Those The grant of the rights mentioned above is subject to some restrictions and obligations imposed on the Licensee. Those
obligations are the following: obligations are the following:
Attribution right: The Licensee shall keep intact all copyright, patent or trademarks notices and all notices that refer to Attribution right: The Licensee shall keep intact all copyright, patent or trademarks notices and all notices that refer to
the Licence and to the disclaimer of warranties. The Licensee must include a copy of such notices and a copy of the the Licence and to the disclaimer of warranties. The Licensee must include a copy of such notices and a copy of the
Licence with every copy of the Work he/she distributes or communicates. The Licensee must cause any Derivative Work Licence with every copy of the Work he/she distributes or communicates. The Licensee must cause any Derivative Work
to carry prominent notices stating that the Work has been modified and the date of modification. to carry prominent notices stating that the Work has been modified and the date of modification.
Copyleft clause: If the Licensee distributes or communicates copies of the Original Works or Derivative Works, this Copyleft clause: If the Licensee distributes or communicates copies of the Original Works or Derivative Works, this
Distribution or Communication will be done under the terms of this Licence or of a later version of this Licence unless Distribution or Communication will be done under the terms of this Licence or of a later version of this Licence unless
the Original Work is expressly distributed only under this version of the Licence — for example by communicating the Original Work is expressly distributed only under this version of the Licence — for example by communicating
‘EUPL v. 1.2 only’. The Licensee (becoming Licensor) cannot offer or impose any additional terms or conditions on the ‘EUPL v. 1.2 only’. The Licensee (becoming Licensor) cannot offer or impose any additional terms or conditions on the
Work or Derivative Work that alter or restrict the terms of the Licence. Work or Derivative Work that alter or restrict the terms of the Licence.
Compatibility clause: If the Licensee Distributes or Communicates Derivative Works or copies thereof based upon both Compatibility clause: If the Licensee Distributes or Communicates Derivative Works or copies thereof based upon both
the Work and another work licensed under a Compatible Licence, this Distribution or Communication can be done the Work and another work licensed under a Compatible Licence, this Distribution or Communication can be done
under the terms of this Compatible Licence. For the sake of this clause, ‘Compatible Licence’ refers to the licences listed under the terms of this Compatible Licence. For the sake of this clause, ‘Compatible Licence’ refers to the licences listed
in the appendix attached to this Licence. Should the Licensee's obligations under the Compatible Licence conflict with in the appendix attached to this Licence. Should the Licensee's obligations under the Compatible Licence conflict with
his/her obligations under this Licence, the obligations of the Compatible Licence shall prevail. his/her obligations under this Licence, the obligations of the Compatible Licence shall prevail.
Provision of Source Code: When distributing or communicating copies of the Work, the Licensee will provide Provision of Source Code: When distributing or communicating copies of the Work, the Licensee will provide
a machine-readable copy of the Source Code or indicate a repository where this Source will be easily and freely available a machine-readable copy of the Source Code or indicate a repository where this Source will be easily and freely available
for as long as the Licensee continues to distribute or communicate the Work. for as long as the Licensee continues to distribute or communicate the Work.
Legal Protection: This Licence does not grant permission to use the trade names, trademarks, service marks, or names Legal Protection: This Licence does not grant permission to use the trade names, trademarks, service marks, or names
of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and
reproducing the content of the copyright notice. reproducing the content of the copyright notice.
6.Chain of Authorship 6.Chain of Authorship
The original Licensor warrants that the copyright in the Original Work granted hereunder is owned by him/her or The original Licensor warrants that the copyright in the Original Work granted hereunder is owned by him/her or
licensed to him/her and that he/she has the power and authority to grant the Licence. licensed to him/her and that he/she has the power and authority to grant the Licence.
Each Contributor warrants that the copyright in the modifications he/she brings to the Work are owned by him/her or Each Contributor warrants that the copyright in the modifications he/she brings to the Work are owned by him/her or
licensed to him/her and that he/she has the power and authority to grant the Licence. licensed to him/her and that he/she has the power and authority to grant the Licence.
Each time You accept the Licence, the original Licensor and subsequent Contributors grant You a licence to their contributions Each time You accept the Licence, the original Licensor and subsequent Contributors grant You a licence to their contributions
to the Work, under the terms of this Licence. to the Work, under the terms of this Licence.
7.Disclaimer of Warranty 7.Disclaimer of Warranty
The Work is a work in progress, which is continuously improved by numerous Contributors. It is not a finished work The Work is a work in progress, which is continuously improved by numerous Contributors. It is not a finished work
and may therefore contain defects or ‘bugs’ inherent to this type of development. and may therefore contain defects or ‘bugs’ inherent to this type of development.
For the above reason, the Work is provided under the Licence on an ‘as is’ basis and without warranties of any kind For the above reason, the Work is provided under the Licence on an ‘as is’ basis and without warranties of any kind
concerning the Work, including without limitation merchantability, fitness for a particular purpose, absence of defects or concerning the Work, including without limitation merchantability, fitness for a particular purpose, absence of defects or
errors, accuracy, non-infringement of intellectual property rights other than copyright as stated in Article 6 of this errors, accuracy, non-infringement of intellectual property rights other than copyright as stated in Article 6 of this
Licence. Licence.
This disclaimer of warranty is an essential part of the Licence and a condition for the grant of any rights to the Work. This disclaimer of warranty is an essential part of the Licence and a condition for the grant of any rights to the Work.
8.Disclaimer of Liability 8.Disclaimer of Liability
Except in the cases of wilful misconduct or damages directly caused to natural persons, the Licensor will in no event be Except in the cases of wilful misconduct or damages directly caused to natural persons, the Licensor will in no event be
liable for any direct or indirect, material or moral, damages of any kind, arising out of the Licence or of the use of the liable for any direct or indirect, material or moral, damages of any kind, arising out of the Licence or of the use of the
Work, including without limitation, damages for loss of goodwill, work stoppage, computer failure or malfunction, loss Work, including without limitation, damages for loss of goodwill, work stoppage, computer failure or malfunction, loss
of data or any commercial damage, even if the Licensor has been advised of the possibility of such damage. However, of data or any commercial damage, even if the Licensor has been advised of the possibility of such damage. However,
the Licensor will be liable under statutory product liability laws as far such laws apply to the Work. the Licensor will be liable under statutory product liability laws as far such laws apply to the Work.
9.Additional agreements 9.Additional agreements
While distributing the Work, You may choose to conclude an additional agreement, defining obligations or services While distributing the Work, You may choose to conclude an additional agreement, defining obligations or services
consistent with this Licence. However, if accepting obligations, You may act only on your own behalf and on your sole consistent with this Licence. However, if accepting obligations, You may act only on your own behalf and on your sole
responsibility, not on behalf of the original Licensor or any other Contributor, and only if You agree to indemnify, responsibility, not on behalf of the original Licensor or any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against such Contributor by defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against such Contributor by
the fact You have accepted any warranty or additional liability. the fact You have accepted any warranty or additional liability.
10.Acceptance of the Licence 10.Acceptance of the Licence
The provisions of this Licence can be accepted by clicking on an icon ‘I agree’ placed under the bottom of a window The provisions of this Licence can be accepted by clicking on an icon ‘I agree’ placed under the bottom of a window
displaying the text of this Licence or by affirming consent in any other similar way, in accordance with the rules of displaying the text of this Licence or by affirming consent in any other similar way, in accordance with the rules of
applicable law. Clicking on that icon indicates your clear and irrevocable acceptance of this Licence and all of its terms applicable law. Clicking on that icon indicates your clear and irrevocable acceptance of this Licence and all of its terms
and conditions. and conditions.
Similarly, you irrevocably accept this Licence and all of its terms and conditions by exercising any rights granted to You Similarly, you irrevocably accept this Licence and all of its terms and conditions by exercising any rights granted to You
by Article 2 of this Licence, such as the use of the Work, the creation by You of a Derivative Work or the Distribution by Article 2 of this Licence, such as the use of the Work, the creation by You of a Derivative Work or the Distribution
or Communication by You of the Work or copies thereof. or Communication by You of the Work or copies thereof.
11.Information to the public 11.Information to the public
In case of any Distribution or Communication of the Work by means of electronic communication by You (for example, In case of any Distribution or Communication of the Work by means of electronic communication by You (for example,
by offering to download the Work from a remote location) the distribution channel or media (for example, a website) by offering to download the Work from a remote location) the distribution channel or media (for example, a website)
must at least provide to the public the information requested by the applicable law regarding the Licensor, the Licence must at least provide to the public the information requested by the applicable law regarding the Licensor, the Licence
and the way it may be accessible, concluded, stored and reproduced by the Licensee. and the way it may be accessible, concluded, stored and reproduced by the Licensee.
12.Termination of the Licence 12.Termination of the Licence
The Licence and the rights granted hereunder will terminate automatically upon any breach by the Licensee of the terms The Licence and the rights granted hereunder will terminate automatically upon any breach by the Licensee of the terms
of the Licence. of the Licence.
Such a termination will not terminate the licences of any person who has received the Work from the Licensee under Such a termination will not terminate the licences of any person who has received the Work from the Licensee under
the Licence, provided such persons remain in full compliance with the Licence. the Licence, provided such persons remain in full compliance with the Licence.
13.Miscellaneous 13.Miscellaneous
Without prejudice of Article 9 above, the Licence represents the complete agreement between the Parties as to the Without prejudice of Article 9 above, the Licence represents the complete agreement between the Parties as to the
Work. Work.
If any provision of the Licence is invalid or unenforceable under applicable law, this will not affect the validity or If any provision of the Licence is invalid or unenforceable under applicable law, this will not affect the validity or
enforceability of the Licence as a whole. Such provision will be construed or reformed so as necessary to make it valid enforceability of the Licence as a whole. Such provision will be construed or reformed so as necessary to make it valid
and enforceable. and enforceable.
The European Commission may publish other linguistic versions or new versions of this Licence or updated versions of The European Commission may publish other linguistic versions or new versions of this Licence or updated versions of
the Appendix, so far this is required and reasonable, without reducing the scope of the rights granted by the Licence. the Appendix, so far this is required and reasonable, without reducing the scope of the rights granted by the Licence.
New versions of the Licence will be published with a unique version number. New versions of the Licence will be published with a unique version number.
All linguistic versions of this Licence, approved by the European Commission, have identical value. Parties can take All linguistic versions of this Licence, approved by the European Commission, have identical value. Parties can take
advantage of the linguistic version of their choice. advantage of the linguistic version of their choice.
14.Jurisdiction 14.Jurisdiction
Without prejudice to specific agreement between parties, Without prejudice to specific agreement between parties,
— any litigation resulting from the interpretation of this License, arising between the European Union institutions, — any litigation resulting from the interpretation of this License, arising between the European Union institutions,
bodies, offices or agencies, as a Licensor, and any Licensee, will be subject to the jurisdiction of the Court of Justice bodies, offices or agencies, as a Licensor, and any Licensee, will be subject to the jurisdiction of the Court of Justice
of the European Union, as laid down in article 272 of the Treaty on the Functioning of the European Union, of the European Union, as laid down in article 272 of the Treaty on the Functioning of the European Union,
— any litigation arising between other parties and resulting from the interpretation of this License, will be subject to — any litigation arising between other parties and resulting from the interpretation of this License, will be subject to
the exclusive jurisdiction of the competent court where the Licensor resides or conducts its primary business. the exclusive jurisdiction of the competent court where the Licensor resides or conducts its primary business.
15.Applicable Law 15.Applicable Law
Without prejudice to specific agreement between parties, Without prejudice to specific agreement between parties,
— this Licence shall be governed by the law of the European Union Member State where the Licensor has his seat, — this Licence shall be governed by the law of the European Union Member State where the Licensor has his seat,
resides or has his registered office, resides or has his registered office,
— this licence shall be governed by Belgian law if the Licensor has no seat, residence or registered office inside — this licence shall be governed by Belgian law if the Licensor has no seat, residence or registered office inside
a European Union Member State. a European Union Member State.
Appendix Appendix
‘Compatible Licences’ according to Article 5 EUPL are: ‘Compatible Licences’ according to Article 5 EUPL are:
— GNU General Public License (GPL) v. 2, v. 3 — GNU General Public License (GPL) v. 2, v. 3
— GNU Affero General Public License (AGPL) v. 3 — GNU Affero General Public License (AGPL) v. 3
— Open Software License (OSL) v. 2.1, v. 3.0 — Open Software License (OSL) v. 2.1, v. 3.0
— Eclipse Public License (EPL) v. 1.0 — Eclipse Public License (EPL) v. 1.0
— CeCILL v. 2.0, v. 2.1 — CeCILL v. 2.0, v. 2.1
— Mozilla Public Licence (MPL) v. 2 — Mozilla Public Licence (MPL) v. 2
— GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3 — GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3
— Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for works other than software — Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for works other than software
— European Union Public Licence (EUPL) v. 1.1, v. 1.2 — European Union Public Licence (EUPL) v. 1.1, v. 1.2
— Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong Reciprocity (LiLiQ-R+). — Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong Reciprocity (LiLiQ-R+).
The European Commission may update this Appendix to later versions of the above licences without producing The European Commission may update this Appendix to later versions of the above licences without producing
a new version of the EUPL, as long as they provide the rights granted in Article 2 of this Licence and protect the a new version of the EUPL, as long as they provide the rights granted in Article 2 of this Licence and protect the
covered Source Code from exclusive appropriation. covered Source Code from exclusive appropriation.
All other changes or additions to this Appendix require the production of a new EUPL version. All other changes or additions to this Appendix require the production of a new EUPL version.

4
README.md
View File

@@ -1,3 +1,3 @@
# Sludge Settler # Sludge Settler
Sludge settler node Sludge settler node

8
examples/README.md Normal file
View File

@@ -0,0 +1,8 @@
# settler Example Flows
Import-ready Node-RED examples for settler.
## Files
- basic.flow.json
- integration.flow.json
- edge.flow.json

6
examples/basic.flow.json Normal file
View File

@@ -0,0 +1,6 @@
[
{"id":"settler_basic_tab","type":"tab","label":"settler basic","disabled":false,"info":"settler basic example"},
{"id":"settler_basic_node","type":"settler","z":"settler_basic_tab","name":"settler basic","x":420,"y":180,"wires":[["settler_basic_dbg"]]},
{"id":"settler_basic_inj","type":"inject","z":"settler_basic_tab","name":"basic trigger","props":[{"p":"topic","vt":"str"},{"p":"payload","vt":"str"}],"topic":"ping","payload":"1","payloadType":"str","x":160,"y":180,"wires":[["settler_basic_node"]]},
{"id":"settler_basic_dbg","type":"debug","z":"settler_basic_tab","name":"settler basic debug","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","targetType":"full","x":660,"y":180,"wires":[]}
]

6
examples/edge.flow.json Normal file
View File

@@ -0,0 +1,6 @@
[
{"id":"settler_edge_tab","type":"tab","label":"settler edge","disabled":false,"info":"settler edge example"},
{"id":"settler_edge_node","type":"settler","z":"settler_edge_tab","name":"settler edge","x":420,"y":180,"wires":[["settler_edge_dbg"]]},
{"id":"settler_edge_inj","type":"inject","z":"settler_edge_tab","name":"unknown topic","props":[{"p":"topic","vt":"str"},{"p":"payload","vt":"str"}],"topic":"doesNotExist","payload":"x","payloadType":"str","x":170,"y":180,"wires":[["settler_edge_node"]]},
{"id":"settler_edge_dbg","type":"debug","z":"settler_edge_tab","name":"settler edge debug","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","targetType":"full","x":660,"y":180,"wires":[]}
]

6
examples/integration.flow.json Normal file
View File

@@ -0,0 +1,6 @@
[
{"id":"settler_int_tab","type":"tab","label":"settler integration","disabled":false,"info":"settler integration example"},
{"id":"settler_int_node","type":"settler","z":"settler_int_tab","name":"settler integration","x":420,"y":180,"wires":[["settler_int_dbg"]]},
{"id":"settler_int_inj","type":"inject","z":"settler_int_tab","name":"registerChild","props":[{"p":"topic","vt":"str"},{"p":"payload","vt":"str"}],"topic":"registerChild","payload":"example-child-id","payloadType":"str","x":170,"y":180,"wires":[["settler_int_node"]]},
{"id":"settler_int_dbg","type":"debug","z":"settler_int_tab","name":"settler integration debug","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","targetType":"full","x":680,"y":180,"wires":[]}
]

2
package.json
View File

@@ -16,7 +16,7 @@
"author": "P.R. van der Wilt", "author": "P.R. van der Wilt",
"main": "settler.js", "main": "settler.js",
"scripts": { "scripts": {
"test": "node settler.js" "test": "node --test test/basic/*.test.js test/integration/*.test.js test/edge/*.test.js"
}, },
"node-red": { "node-red": {
"nodes": { "nodes": {

22
settler.html
View File

@@ -6,6 +6,8 @@
color: "#e4a363", color: "#e4a363",
defaults: { defaults: {
name: { value: "" }, name: { value: "" },
processOutputFormat: { value: "process" },
dbaseOutputFormat: { value: "influxdb" },
enableLog: { value: false }, enableLog: { value: false },
logLevel: { value: "error" }, logLevel: { value: "error" },
@@ -55,6 +57,24 @@
<input type="text" id="node-input-name" placeholder="Name"> <input type="text" id="node-input-name" placeholder="Name">
</div> </div>
<h3>Output Formats</h3>
<div class="form-row">
<label for="node-input-processOutputFormat"><i class="fa fa-random"></i> Process Output</label>
<select id="node-input-processOutputFormat" style="width:60%;">
<option value="process">process</option>
<option value="json">json</option>
<option value="csv">csv</option>
</select>
</div>
<div class="form-row">
<label for="node-input-dbaseOutputFormat"><i class="fa fa-database"></i> Database Output</label>
<select id="node-input-dbaseOutputFormat" style="width:60%;">
<option value="influxdb">influxdb</option>
<option value="json">json</option>
<option value="csv">csv</option>
</select>
</div>
<!-- Logger fields injected here --> <!-- Logger fields injected here -->
<div id="logger-fields-placeholder"></div> <div id="logger-fields-placeholder"></div>
@@ -65,4 +85,4 @@
<script type="text/html" data-help-name="settler"> <script type="text/html" data-help-name="settler">
<p>Settling tank</p> <p>Settling tank</p>
</script> </script>

50
settler.js
View File

@@ -1,26 +1,26 @@
const nameOfNode = "settler"; // name of the node, should match file name and node type in Node-RED const nameOfNode = "settler"; // name of the node, should match file name and node type in Node-RED
const nodeClass = require('./src/nodeClass.js'); // node class const nodeClass = require('./src/nodeClass.js'); // node class
const { MenuManager } = require('generalFunctions'); const { MenuManager } = require('generalFunctions');
module.exports = function (RED) { module.exports = function (RED) {
// Register the node type // Register the node type
RED.nodes.registerType(nameOfNode, function (config) { RED.nodes.registerType(nameOfNode, function (config) {
// Initialize the Node-RED node first // Initialize the Node-RED node first
RED.nodes.createNode(this, config); RED.nodes.createNode(this, config);
// Then create your custom class and attach it // Then create your custom class and attach it
this.nodeClass = new nodeClass(config, RED, this, nameOfNode); this.nodeClass = new nodeClass(config, RED, this, nameOfNode);
}); });
const menuMgr = new MenuManager(); const menuMgr = new MenuManager();
// Serve /settler/menu.js // Serve /settler/menu.js
RED.httpAdmin.get(`/${nameOfNode}/menu.js`, (req, res) => { RED.httpAdmin.get(`/${nameOfNode}/menu.js`, (req, res) => {
try { try {
const script = menuMgr.createEndpoint(nameOfNode, ['logger', 'position']); const script = menuMgr.createEndpoint(nameOfNode, ['logger', 'position']);
res.type('application/javascript').send(script); res.type('application/javascript').send(script);
} catch (err) { } catch (err) {
res.status(500).send(`// Error generating menu: ${err.message}`); res.status(500).send(`// Error generating menu: ${err.message}`);
} }
}); });
}; };

32
src/nodeClass.js
View File

@@ -31,20 +31,26 @@ class nodeClass {
*/ */
_attachInputHandler() { _attachInputHandler() {
this.node.on('input', (msg, send, done) => { this.node.on('input', (msg, send, done) => {
try {
switch (msg.topic) { switch (msg.topic) {
case 'registerChild': { case 'registerChild': {
// Register this node as a parent of the child node const childId = msg.payload;
const childId = msg.payload; const childObj = this.RED.nodes.getNode(childId);
const childObj = this.RED.nodes.getNode(childId); if (!childObj || !childObj.source) {
this.source.childRegistrationUtils.registerChild(childObj.source, msg.positionVsParent); this.source?.logger?.warn(`registerChild skipped: missing child/source for id=${childId}`);
break; break;
}
this.source.childRegistrationUtils.registerChild(childObj.source, msg.positionVsParent);
break;
}
default:
this.source?.logger?.warn(`Unknown topic: ${msg.topic}`);
} }
default: } catch (error) {
console.log("Unknown topic: " + msg.topic); this.source?.logger?.error(`Input handler failure: ${error.message}`);
} }
if (done) { if (typeof done === 'function') {
done(); done();
} }
}); });
@@ -95,9 +101,9 @@ class nodeClass {
_attachCloseHandler() { _attachCloseHandler() {
this.node.on('close', (done) => { this.node.on('close', (done) => {
clearInterval(this._tickInterval); clearInterval(this._tickInterval);
done(); if (typeof done === 'function') done();
}); });
} }
} }
module.exports = nodeClass; module.exports = nodeClass;

29
src/specificClass.js
View File

@@ -1,6 +1,18 @@
const { childRegistrationUtils, logger, MeasurementContainer, POSITIONS } = require('generalFunctions'); const { childRegistrationUtils, logger, MeasurementContainer, POSITIONS } = require('generalFunctions');
const EventEmitter = require('events'); const EventEmitter = require('events');
// Compatibility-safe array clone for Node runtimes without global structuredClone.
function cloneArray(values) {
if (typeof structuredClone === 'function') {
return structuredClone(values);
}
return Array.isArray(values) ? [...values] : values;
}
/**
* Settler domain model.
* Splits influent into effluent, sludge and return sludge based on solids balance.
*/
class Settler { class Settler {
constructor(config) { constructor(config) {
this.config = config; this.config = config;
@@ -23,7 +35,7 @@ class Settler {
// constrain flow to prevent negatives // constrain flow to prevent negatives
const F_s = Math.min((this.F_in * this.Cs_in[12]) / this.C_TS, this.F_in); const F_s = Math.min((this.F_in * this.Cs_in[12]) / this.C_TS, this.F_in);
const F_eff = this.F_in - F_s; const F_eff = this.F_in - F_s;
let F_sr = 0; let F_sr = 0;
if (this.returnPump) { if (this.returnPump) {
F_sr = Math.min(this.returnPump.measurements.type("flow").variant("measured").position(POSITIONS.AT_EQUIPMENT).getCurrentValue(), F_s); F_sr = Math.min(this.returnPump.measurements.type("flow").variant("measured").position(POSITIONS.AT_EQUIPMENT).getCurrentValue(), F_s);
@@ -31,7 +43,7 @@ class Settler {
const F_so = F_s - F_sr; const F_so = F_s - F_sr;
// effluent // effluent
const Cs_eff = structuredClone(this.Cs_in); const Cs_eff = cloneArray(this.Cs_in);
if (F_s > 0) { if (F_s > 0) {
Cs_eff[7] = 0; Cs_eff[7] = 0;
Cs_eff[8] = 0; Cs_eff[8] = 0;
@@ -40,9 +52,9 @@ class Settler {
Cs_eff[11] = 0; Cs_eff[11] = 0;
Cs_eff[12] = 0; Cs_eff[12] = 0;
} }
// sludge // sludge
const Cs_s = structuredClone(this.Cs_in); const Cs_s = cloneArray(this.Cs_in);
if (F_s > 0) { if (F_s > 0) {
Cs_s[7] = this.F_in * this.Cs_in[7] / F_s; Cs_s[7] = this.F_in * this.Cs_in[7] / F_s;
Cs_s[8] = this.F_in * this.Cs_in[8] / F_s; Cs_s[8] = this.F_in * this.Cs_in[8] / F_s;
@@ -99,7 +111,7 @@ class Settler {
.variant("measured") .variant("measured")
.position(position) .position(position)
.value(eventData.value, eventData.timestamp, eventData.unit); .value(eventData.value, eventData.timestamp, eventData.unit);
this._updateMeasurement(measurementType, eventData.value, position, eventData); this._updateMeasurement(measurementType, eventData.value, position, eventData);
}); });
} }
@@ -113,7 +125,8 @@ class Settler {
reactorChild.emitter.on("stateChange", (_eventData) => { reactorChild.emitter.on("stateChange", (_eventData) => {
this.logger.debug(`State change of upstream reactor detected.`); this.logger.debug(`State change of upstream reactor detected.`);
const effluent = this.upstreamReactor.getEffluent[0]; const raw = this.upstreamReactor.getEffluent;
const effluent = Array.isArray(raw) ? raw[0] : raw;
this.F_in = effluent.payload.F; this.F_in = effluent.payload.F;
this.Cs_in = effluent.payload.C; this.Cs_in = effluent.payload.C;
}); });
@@ -133,7 +146,7 @@ class Settler {
case "quantity (tss)": case "quantity (tss)":
this.C_TS = value; this.C_TS = value;
break; break;
default: default:
this.logger.error(`Type '${measurementType}' not recognized for measured update.`); this.logger.error(`Type '${measurementType}' not recognized for measured update.`);
return; return;
@@ -141,4 +154,4 @@ class Settler {
} }
} }
module.exports = { Settler }; module.exports = { Settler };

12
test/README.md Normal file
View File

@@ -0,0 +1,12 @@
# settler Test Suite Layout
Required EVOLV layout:
- basic/
- integration/
- edge/
- helpers/
Baseline structure tests:
- basic/structure-module-load.basic.test.js
- integration/structure-examples.integration.test.js
- edge/structure-examples-node-type.edge.test.js

0
test/basic/.gitkeep Normal file
View File

8
test/basic/structure-module-load.basic.test.js Normal file
View File

@@ -0,0 +1,8 @@
const test = require('node:test');
const assert = require('node:assert/strict');
test('settler module load smoke', () => {
assert.doesNotThrow(() => {
require('../../settler.js');
});
});

0
test/edge/.gitkeep Normal file
View File

11
test/edge/structure-examples-node-type.edge.test.js Normal file
View File

@@ -0,0 +1,11 @@
const test = require('node:test');
const assert = require('node:assert/strict');
const fs = require('node:fs');
const path = require('node:path');
const flow = JSON.parse(fs.readFileSync(path.resolve(__dirname, '../../examples/basic.flow.json'), 'utf8'));
test('basic example includes node type settler', () => {
const count = flow.filter((n) => n && n.type === 'settler').length;
assert.equal(count >= 1, true);
});

0
test/helpers/.gitkeep Normal file
View File

0
test/integration/.gitkeep Normal file
View File

23
test/integration/structure-examples.integration.test.js Normal file
View File

@@ -0,0 +1,23 @@
const test = require('node:test');
const assert = require('node:assert/strict');
const fs = require('node:fs');
const path = require('node:path');
const dir = path.resolve(__dirname, '../../examples');
function loadJson(file) {
return JSON.parse(fs.readFileSync(path.join(dir, file), 'utf8'));
}
test('examples package exists for settler', () => {
for (const file of ['README.md', 'basic.flow.json', 'integration.flow.json', 'edge.flow.json']) {
assert.equal(fs.existsSync(path.join(dir, file)), true, file + ' missing');
}
});
test('example flows are parseable arrays for settler', () => {
for (const file of ['basic.flow.json', 'integration.flow.json', 'edge.flow.json']) {
const parsed = loadJson(file);
assert.equal(Array.isArray(parsed), true);
}
});