node-red-contrib-knx-ultimate
Version:
Control your KNX intallation via Node-Red! A bunch of KNX nodes, with integrated Philips HUE control and ETS group address importer. Easy to use and highly configurable.
424 lines (369 loc) • 20 kB
HTML
<script type="text/javascript" src="resources/node-red-contrib-knx-ultimate/htmlUtils.js"></script>
<script type="text/javascript">
RED.nodes.registerType('knxUltimateLoadControl', {
category: "KNX Ultimate",
color: '#C7E9C0',
defaults: {
//buttonState: {value: true},
server: { type: "knxUltimate-config", required: false },
name: { value: "" },
topic: { value: "" },
dpt: { value: "" },
wattLimit: { value: 3000, validate: RED.validators.number() },
sheddingCheckInterval: { value: 15, validate: RED.validators.number() },
sheddingRestoreDelay: { value: 60, validate: RED.validators.number() },
GA1: { value: "" },
DPT1: { value: "" },
Name1: { value: "" },
autoRestore1: { value: true },
MonitorGA1: { value: "" },
MonitorDPT1: { value: "" },
MonitorName1: { value: "" },
GA2: { value: "" },
DPT2: { value: "" },
Name2: { value: "" },
autoRestore2: { value: true },
MonitorGA2: { value: "" },
MonitorDPT2: { value: "" },
MonitorName2: { value: "" },
GA3: { value: "" },
DPT3: { value: "" },
Name3: { value: "" },
autoRestore3: { value: true },
MonitorGA3: { value: "" },
MonitorDPT3: { value: "" },
MonitorName3: { value: "" },
GA4: { value: "" },
DPT4: { value: "" },
Name4: { value: "" },
autoRestore4: { value: true },
MonitorGA4: { value: "" },
MonitorDPT4: { value: "" },
MonitorName4: { value: "" },
GA5: { value: "" },
DPT5: { value: "" },
Name5: { value: "" },
autoRestore5: { value: true },
MonitorGA5: { value: "" },
MonitorDPT5: { value: "" },
MonitorName5: { value: "" }
},
inputs: 1,
outputs: 1,
icon: "node-alerter-icon.svg",
label: function () {
return (this.name || this.topic || "KNX Load Control");
},
paletteLabel: "KNX Load Control",
// button: {
// enabled: function() {
// // return whether or not the button is enabled, based on the current
// // configuration of the node
// return !this.changed
// },
// visible: function() {
// // return whether or not the button is visible, based on the current
// // configuration of the node
// return this.hasButton
// },
// //toggle: "buttonState",
// onclick: function() {}
// },
oneditprepare: function () {
// Go to the help panel
try {
RED.sidebar.show("help");
} catch (error) { }
var node = this;
var oNodeServer = RED.nodes.node($("#node-input-server").val()); // Store the config-node
// 19/02/2020 Used to get the server sooner als deploy.
$("#node-input-server").change(function () {
try {
oNodeServer = RED.nodes.node($(this).val());
} catch (error) { }
});
$.getJSON("knxUltimateDpts?serverId=" + $("#node-input-server").val(), (data) => {
data.forEach(dpt => {
$("#node-input-dpt").append($("<option></option>").attr("value", dpt.value).text(dpt.text));
for (let index = 1; index < 6; index++) {
$("#node-input-DPT" + index).append($("<option></option>").attr("value", dpt.value).text(dpt.text));
$("#node-input-MonitorDPT" + index).append($("<option></option>").attr("value", dpt.value).text(dpt.text));
}
});
$("#node-input-dpt").val(this.dpt);
$("#node-input-DPT1").val(this.DPT1);
$("#node-input-DPT2").val(this.DPT2);
$("#node-input-DPT3").val(this.DPT3);
$("#node-input-DPT4").val(this.DPT4);
$("#node-input-DPT5").val(this.DPT5);
$("#node-input-MonitorDPT1").val(this.MonitorDPT1);
$("#node-input-MonitorDPT2").val(this.MonitorDPT2);
$("#node-input-MonitorDPT3").val(this.MonitorDPT3);
$("#node-input-MonitorDPT4").val(this.MonitorDPT4);
$("#node-input-MonitorDPT5").val(this.MonitorDPT5);
})
// Autocomplete suggestion with ETS csv File
this.autoComplete = (_Name, _DPT) => {
let paramAutoComplete = {
minLength: 1,
source: function (request, response) {
$.getJSON("knxUltimatecsv?nodeID=" + oNodeServer.id, (data) => {
response($.map(data, function (value, key) {
var sSearch = (value.ga + " (" + value.devicename + ") DPT" + value.dpt);
if (htmlUtilsfullCSVSearch(sSearch, request.term)) {
return {
label: value.ga + " # " + value.devicename + " # " + value.dpt, // Label for Display
value: value.ga // Value
}
} else {
return null;
}
}));
});
}, select: function (event, ui) {
// Sets Datapoint and device name automatically
var sDevName = ui.item.label.split("#")[1].trim();
try {
sDevName = sDevName.substr(sDevName.indexOf(")") + 1).trim();
} catch (error) {
}
if (_Name === "name") {
$("#node-input-" + _Name).val("Load Control for " + sDevName);
} else {
$("#node-input-" + _Name).val(sDevName);
}
var optVal = $("#node-input-dpt option:contains('" + ui.item.label.split("#")[2].trim() + "')").attr('value');
// Select the option value
$("#node-input-" + _DPT).val(optVal);
$("#node-input-" + _DPT).trigger("change");
}
};
return paramAutoComplete;
};
$("#node-input-topic").autocomplete(this.autoComplete("name", "dpt"));
for (let index = 1; index < 6; index++) {
$("#node-input-GA" + index).autocomplete(this.autoComplete("Name" + index, "DPT" + index));
$("#node-input-MonitorGA" + index).autocomplete(this.autoComplete("MonitorName" + index, "MonitorDPT" + index));
}
},
oneditsave: function () {
// Return to the info tab
try {
RED.sidebar.show("info");
} catch (error) { }
},
oneditresize: function (size) {
}
})
</script>
<script type="text/html" data-template-name="knxUltimateLoadControl">
<div class="form-row">
<b><span data-i18n="knxUltimateLoadControl.title"></span></b>  <span style="color:red" data-i18n="[html]knxUltimateLoadControl.helplink"></span>
<br/><br/>
<label for="node-input-server"> <img
src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAKnRFWHRDcmVhdGlvbiBUaW1lAEZyIDYgQXVnIDIwMTAgMjE6NTI6MTkgKzAxMDD84aS8AAAAB3RJTUUH3gYYCicNV+4WIQAAAAlwSFlzAAALEgAACxIB0t1+/AAAAARnQU1BAACxjwv8YQUAAACUSURBVHjaY2CgFZg5c+Z/ZEyWAZ8+f/6/ZsWs/xoamqMGkGrA6Wla/1+fVARjEBuGsSoGmY4eZSCNL59d/g8DIDbIAHR14OgFGQByKjIGKX5+6/T///8gGMQGiV1+/B0Fg70GIkD+RMYgxf/O5/7//2MSmAZhkBi6OrgB6Bg5DGB4ajr3f2xqsYYLSDE2THJUDg0AAAqyDVd4tp4YAAAAAElFTkSuQmCC"></img>
<span data-i18n="knxUltimateLoadControl.properties.node-input-server"></span> </label>
<input type="text" id="node-input-server">
</div>
<div class="form-row">
<i class="fa fa-battery-full"></i>
<label style="width:100px" for="node-input-topic">
<span data-i18n="knxUltimateLoadControl.properties.node-input-topic"></span>
</label>
<input style="width:15%" type="text" id="node-input-topic" placeholder="Ex: 1/1/1" />
<select style="width:15%" id="node-input-dpt"></select>
<input style="width:40%" type="text" id="node-input-name" data-i18n="[placeholder]knxUltimateLoadControl.properties.node-input-name">
</div>
<div class="form-row">
<i class="fa fa-exclamation"></i>
<label style="width:125px" for="node-input-wattLimit">
<span data-i18n="knxUltimateLoadControl.properties.node-input-wattLimit"></span>
</label>
<input style="width:40%" type="text" id="node-input-wattLimit" placeholder="Ex. 3000">
</div>
<div class="form-row">
<i class="fa fa-toggle-off"></i>
<label style="width:125px" for="node-input-sheddingCheckInterval">
<span data-i18n="knxUltimateLoadControl.properties.node-input-sheddingCheckInterval"></span>
</label>
<input style="width:40%" type="text" id="node-input-sheddingCheckInterval" placeholder=""">
</div>
<div class="form-row">
<i class="fa fa-toggle-on"></i>
<label style="width:125px" for="node-input-sheddingRestoreDelay">
<span data-i18n="knxUltimateLoadControl.properties.node-input-sheddingRestoreDelay"></span>
</label>
<input style="width:40%" type="text" id="node-input-sheddingRestoreDelay" placeholder=""">
</div>
<!-- LOAD CONTROL -->
<hr>
<b><span data-i18n="knxUltimateLoadControl.title"></span> 1</b> <span data-i18n="knxUltimateLoadControl.primoaldistacco"></span> <br/><br/>
<div class="form-row">
<i class="fa fa-power-off"></i>
<label for="node-input-GA1" style="width:10%"></label>
<input style="width:20%" type="text" id="node-input-GA1" placeholder="Ex: 1/1/1" />
<select style="width:20%" id="node-input-DPT1"></select>
<input style="width:40%" type="text" id="node-input-Name1" data-i18n="[placeholder]knxUltimateLoadControl.properties.node-input-name">
</div>
<div class="form-row">
<i class="fa fa-battery-half"></i>
<label for="node-input-MonitorGA1" style="width:10%"></label>
<input style="width:20%" type="text" id="node-input-MonitorGA1" placeholder="Optional" />
<select style="width:20%" id="node-input-MonitorDPT1"></select>
<input style="width:40%" type="text" id="node-input-MonitorName1" data-i18n="[placeholder]knxUltimateLoadControl.properties.node-input-name">
</div>
<div class="form-row">
<input type="checkbox" id="node-input-autoRestore1" style="display:inline-block; width:auto; vertical-align:top;">
<label style="width:85%" for="node-input-autoRestore1">
<i class="fa fa-toggle-on"></i>
<span data-i18n="knxUltimateLoadControl.properties.node-input-autoRestore"></span>
</label>
</div>
<hr>
<b><span data-i18n="knxUltimateLoadControl.title"></span> 2</b><br/><br/>
<div class="form-row">
<i class="fa fa-power-off"></i>
<label for="node-input-GA2" style="width:10%"></label>
<input style="width:20%" type="text" id="node-input-GA2" placeholder="Control GA" />
<select style="width:20%" id="node-input-DPT2"></select>
<input style="width:40%" type="text" id="node-input-Name2" data-i18n="[placeholder]knxUltimateLoadControl.properties.node-input-name">
</div>
<div class="form-row">
<i class="fa fa-battery-half"></i>
<label for="node-input-MonitorGA2" style="width:10%"></label>
<input style="width:20%" type="text" id="node-input-MonitorGA2" placeholder="Optional" />
<select style="width:20%" id="node-input-MonitorDPT2"></select>
<input style="width:40%" type="text" id="node-input-MonitorName2" data-i18n="[placeholder]knxUltimateLoadControl.properties.node-input-name">
</div>
<div class="form-row">
<input type="checkbox" id="node-input-autoRestore2" style="display:inline-block; width:auto; vertical-align:top;">
<label style="width:85%" for="node-input-autoRestore2">
<i class="fa fa-toggle-on"></i>
<span data-i18n="knxUltimateLoadControl.properties.node-input-autoRestore"></span>
</label>
</div>
<hr>
<b><span data-i18n="knxUltimateLoadControl.title"></span> 3</b><br/><br/>
<div class="form-row">
<i class="fa fa-power-off"></i>
<label for="node-input-GA3" style="width:10%"></label>
<input style="width:20%" type="text" id="node-input-GA3" placeholder="Control GA" />
<select style="width:20%" id="node-input-DPT3"></select>
<input style="width:40%" type="text" id="node-input-Name3" data-i18n="[placeholder]knxUltimateLoadControl.properties.node-input-name">
</div>
<div class="form-row">
<i class="fa fa-battery-half"></i>
<label for="node-input-MonitorGA3" style="width:10%"></label>
<input style="width:20%" type="text" id="node-input-MonitorGA3" placeholder="Optional" />
<select style="width:20%" id="node-input-MonitorDPT3"></select>
<input style="width:40%" type="text" id="node-input-MonitorName3" data-i18n="[placeholder]knxUltimateLoadControl.properties.node-input-name">
</div>
<div class="form-row">
<input type="checkbox" id="node-input-autoRestore3" style="display:inline-block; width:auto; vertical-align:top;">
<label style="width:85%" for="node-input-autoRestore3">
<i class="fa fa-toggle-on"></i>
<span data-i18n="knxUltimateLoadControl.properties.node-input-autoRestore"></span>
</label>
</div>
<hr>
<b><span data-i18n="knxUltimateLoadControl.title"></span> 4</b><br/><br/>
<div class="form-row">
<i class="fa fa-power-off"></i>
<label for="node-input-GA4" style="width:10%"></label>
<input style="width:20%" type="text" id="node-input-GA4" placeholder="Control GA" />
<select style="width:20%" id="node-input-DPT4"></select>
<input style="width:40%" type="text" id="node-input-Name4" data-i18n="[placeholder]knxUltimateLoadControl.properties.node-input-name">
</div>
<div class="form-row">
<i class="fa fa-battery-half"></i>
<label for="node-input-MonitorGA4" style="width:10%"></label>
<input style="width:20%" type="text" id="node-input-MonitorGA4" placeholder="Optional" />
<select style="width:20%" id="node-input-MonitorDPT4"></select>
<input style="width:40%" type="text" id="node-input-MonitorName4" data-i18n="[placeholder]knxUltimateLoadControl.properties.node-input-name">
</div>
<div class="form-row">
<input type="checkbox" id="node-input-autoRestore4" style="display:inline-block; width:auto; vertical-align:top;">
<label style="width:85%" for="node-input-autoRestore4">
<i class="fa fa-toggle-on"></i>
<span data-i18n="knxUltimateLoadControl.properties.node-input-autoRestore"></span>
</label>
</div>
<hr>
<b><span data-i18n="knxUltimateLoadControl.title"></span> 5</b><br/><br/>
<div class="form-row">
<i class="fa fa-power-off"></i>
<label for="node-input-GA5" style="width:10%"></label>
<input style="width:20%" type="text" id="node-input-GA5" placeholder="Control GA" />
<select style="width:20%" id="node-input-DPT5"></select>
<input style="width:40%" type="text" id="node-input-Name5" data-i18n="[placeholder]knxUltimateLoadControl.properties.node-input-name">
</div>
<div class="form-row">
<i class="fa fa-battery-half"></i>
<label for="node-input-MonitorGA5" style="width:10%"></label>
<input style="width:20%" type="text" id="node-input-MonitorGA5" placeholder="Optional" />
<select style="width:20%" id="node-input-MonitorDPT5"></select>
<input style="width:40%" type="text" id="node-input-MonitorName5" data-i18n="[placeholder]knxUltimateLoadControl.properties.node-input-name">
</div>
<div class="form-row">
<input type="checkbox" id="node-input-autoRestore5" style="display:inline-block; width:auto; vertical-align:top;">
<label style="width:85%" for="node-input-autoRestore5">
<i class="fa fa-toggle-on"></i>
<span data-i18n="knxUltimateLoadControl.properties.node-input-autoRestore"></span>
</label>
</div>
</br>
</br>
</br>
</br>
</script>
<script type="text/markdown" data-help-name="knxUltimateLoadControl">
<p>With the Load Control node you can automatically manage the disconnection of loads (washing machine, oven, etc.) when the current consumption exceeds a certain threshold.
The devices are turned off intelligently, checking the possible consumption of the device to determine whether to turn it off together with others. <br/>
The node can automatically reactivate the loads. <br/>
The node turns off one device (or multiple devices) at a time, based on the order you have selected.<br/>
**General**
|Property|Description|
|--|--|
| Gateway | KNX gateway. It is also possible not to select any gateway; in this case, only incoming messages to the node will be considered. |
| Monitor Wh | Group address representing the total consumption of your building. |
| Limit Wh | Maximum threshold that your electricity meter can withstand. When this threshold is exceeded, the node starts to turn off the devices. |
| Delay switch off (s) | Expressed in seconds, indicates how often the node will evaluate consumption and switch off each device. |
| Delay switch on (s) | Expressed in seconds, indicates how often the node will evaluate consumption and turn on each device that was turned off. |
<br/>
**LOAD CONTROL**
Here you can add devices to turn off in case of overload. <br/>
Choose the device to turn off. Enter the device name or its group address. <br/>
Enter any group address that indicates the consumption of the device chosen in the first line. **This is an optional parameter**. If the device is consuming more than a certain number of Watts, it means that it is in use. If it consumes less, the device will be considered "not in use" and both this and the next will be turned off at once.<br/>
If *Automatic recovery* is enabled, the device is automatically reactivated when the "reset delay" expires.
## Inputs
|Property|Description|
|--|--|
| `msg.readstatus = true` | Force the reading of the values from the KNX BUS of each device in the list. ***The node already does everything by itself***, but if necessary, it is possible to use this command to force a re-reading of the current values in watt.|
| `msg.enable = true` | Enable the load control.|
| `msg.disable = true` | Disable the load control.|
| `msg.reset = true` | Reset node states and turn all devices back on.|
| `msg.shedding` | String. *shed* to start the formward shedding sequence, *unshed* to start reverse shedding. Use this msg to force the shedding timer to start/stop, ignoring the **Monitor Wh** group address. Set *auto* to enable again the **Monitor Wh** group address monitoring. |
## Outputs
1. Standard output
: payload (string|object) : the standard output of the command.
## Details
```javascript
msg = {
"topic": "Home Total Consumption", // Node Name
"operation": "Increase Shedding" or "Decrease Shedding" or operation reflecting the input message (disable, enable, reset), // Operation
"device": "Washing machine", // Device shedded
"ga": "", // Group address of the shedded device
"totalPowerConsumption": 3100, // Current power consumption
"wattLimit": 3000, // Limit you set in the config window
"payload": 1, // Current shedding stage
}
```
# Sample
<a href="https://github.com/Supergiovane/node-red-contrib-knx-ultimate/wiki/SampleLoadControl">CLICK HERE FOR THE EXAMPLE</a>
<br/>
</script>