mirror of
https://github.com/node-red/node-red-nodes.git
synced 2023-10-10 13:36:58 +02:00
Add PID Controller node
This commit is contained in:
dceejay
parent
18c866b490
commit
578b010ab0
177
function/PID/LICENSE
Normal file
177
function/PID/LICENSE
Normal file
@ -0,0 +1,177 @@
|
||||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of 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 reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
26
function/PID/README.md
Normal file
26
function/PID/README.md
Normal file
@ -0,0 +1,26 @@
|
||||
node-red-node-pidcontrol
|
||||
========================
|
||||
|
||||
A <a href="http://nodered.org" target="_new">Node-RED</a> node that provides a simple PID controller.
|
||||
|
||||
Install
|
||||
-------
|
||||
|
||||
Run the following command in the root directory of your Node-RED install - usually ~/.node-red
|
||||
|
||||
npm install node-red-node-pidcontrol
|
||||
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
PID controller node.
|
||||
|
||||
This node ONLY expects a numeric **msg.payload** containing the current reading.
|
||||
|
||||
It will output the correction that needs to be applied in order to move to the preset **set point** value.
|
||||
|
||||
The damping factors are typically in the range 0 - 1.
|
||||
See <a href="https://en.wikipedia.org/wiki/PID_controller" target="_new">Wikipedia</a> for more details on PID controllers.
|
||||
|
||||
The **set point** may be overridden by **msg.setpoint**. If you do so the edit box value can be used as the initial value.
|
||||
24
function/PID/package.json
Normal file
24
function/PID/package.json
Normal file
@ -0,0 +1,24 @@
|
||||
{
|
||||
"name" : "node-red-node-pidcontrol",
|
||||
"version" : "0.0.1",
|
||||
"description" : "A Node-RED node that that provides a simple PID controller.",
|
||||
"dependencies" : {
|
||||
"node-pid-controller": "0.0.3"
|
||||
},
|
||||
"repository" : {
|
||||
"type":"git",
|
||||
"url":"https://github.com/node-red/node-red-nodes/tree/master/function/PID"
|
||||
},
|
||||
"license": "Apache",
|
||||
"keywords": [ "node-red", "PID", "control" ],
|
||||
"node-red" : {
|
||||
"nodes" : {
|
||||
"PID control": "pidcontrol.js"
|
||||
}
|
||||
},
|
||||
"author": {
|
||||
"name": "Dave Conway-Jones",
|
||||
"email": "ceejay@vnet.ibm.com",
|
||||
"url": "http://nodered.org"
|
||||
}
|
||||
}
|
||||
71
function/PID/pidcontrol.html
Normal file
71
function/PID/pidcontrol.html
Normal file
@ -0,0 +1,71 @@
|
||||
<!--
|
||||
Copyright 2015 IBM Corp.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
-->
|
||||
|
||||
<script type="text/x-red" data-template-name="PID control">
|
||||
<div class="form-row">
|
||||
<label for="node-input-target" style="width:120px;"><i class="fa fa-dot-circle-o"></i> Set Point</label>
|
||||
<input type="text" id="node-input-target" placeholder="target value" style="width:60%;">
|
||||
</div>
|
||||
<div class="form-row">
|
||||
<label for="node-input-kp" style="width:120px;"><font size=+1>K<sub>proportional</sub></font></label>
|
||||
<input type="text" id="node-input-kp" placeholder="proportional gain constant - Kp" style="width:60%;">
|
||||
</div>
|
||||
<div class="form-row">
|
||||
<label for="node-input-ki" style="width:120px;"><font size=+1>K<sub>integral</sub></font></label>
|
||||
<input type="text" id="node-input-ki" placeholder="integral gain constant - Ki" style="width:60%;">
|
||||
</div>
|
||||
<div class="form-row">
|
||||
<label for="node-input-kd" style="width:120px;"><font size=+1>K<sub>differential</sub></font></label>
|
||||
<input type="text" id="node-input-kd" placeholder="differential gain constant - Kd" style="width:60%;">
|
||||
</div>
|
||||
<div class="form-row">
|
||||
<label for="node-input-name" style="width:120px;"><i class="fa fa-tag"></i> Name</label>
|
||||
<input type="text" id="node-input-name" placeholder="Name" style="width:60%;">
|
||||
</div>
|
||||
<div class="form-tips"><b>Tip:</b> This node ONLY works on numbers<br>
|
||||
The damping factors are typically in the range 0 - 1.<br></div>
|
||||
</script>
|
||||
|
||||
<script type="text/x-red" data-help-name="PID control">
|
||||
<p>A PID controller node.</p>
|
||||
<p>This node ONLY expects a numeric <b>msg.payload</b> containing the current reading.
|
||||
It will output the correction that needs to be applied in order to move to the preset <i>set point</i> value.</p>
|
||||
<p>See <a href="https://en.wikipedia.org/wiki/PID_controller" target="_new">Wikipedia</a> for more details.</p>
|
||||
<p>The <i>set point</i> may be overridden by <b>msg.setpoint</b>. If you do so the edit box value can be used as the initial value.</p>
|
||||
</script>
|
||||
|
||||
<script type="text/javascript">
|
||||
RED.nodes.registerType('PID control',{
|
||||
color:"#d6ba48",
|
||||
category: 'function',
|
||||
defaults: {
|
||||
name: {value:""},
|
||||
target: {value:"",validate:RED.validators.regex(/^(\d*|)$/)},
|
||||
kp: {value:"",required:true,validate:RED.validators.number()},
|
||||
ki: {value:"",required:true,validate:RED.validators.number()},
|
||||
kd: {value:"",required:true,validate:RED.validators.number()}
|
||||
},
|
||||
inputs:1,
|
||||
outputs:1,
|
||||
icon: "function.png",
|
||||
label: function() {
|
||||
return this.name||"PID";
|
||||
},
|
||||
labelStyle: function() {
|
||||
return this.name?"node_label_italic":"";
|
||||
}
|
||||
});
|
||||
</script>
|
||||
48
function/PID/pidcontrol.js
Normal file
48
function/PID/pidcontrol.js
Normal file
@ -0,0 +1,48 @@
|
||||
/**
|
||||
* Copyright 2015 IBM Corp.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
**/
|
||||
|
||||
module.exports = function(RED) {
|
||||
"use strict";
|
||||
var Controller = require('node-pid-controller');
|
||||
|
||||
function PIDcontrolNode(n) {
|
||||
RED.nodes.createNode(this,n);
|
||||
this.target = n.target;
|
||||
this.kp = n.kp;
|
||||
this.ki = n.ki;
|
||||
this.kd = n.kd;
|
||||
var node = this;
|
||||
node.ctr = new Controller(node.kp, node.ki, node.kd);
|
||||
node.ctr.setTarget(node.target);
|
||||
this.status({fill:"blue",shape:"dot",text:"set point:"+node.target});
|
||||
var tgt = node.target;
|
||||
|
||||
this.on("input",function(msg) {
|
||||
if (msg.hasOwnProperty("setpoint")) {
|
||||
tgt = Number(msg.setpoint);
|
||||
node.ctr.setTarget(tgt);
|
||||
this.status({fill:"blue",shape:"dot",text:"set point:"+tgt});
|
||||
}
|
||||
else if (!isNaN(msg.payload)) {
|
||||
msg.payload = node.ctr.update(Number(msg.payload));
|
||||
msg.topic = "pid";
|
||||
node.send(msg);
|
||||
}
|
||||
else { node.warn("Non numeric input"); }
|
||||
});
|
||||
}
|
||||
RED.nodes.registerType("PID control",PIDcontrolNode);
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user