KNX Ultimate

https://github.com/supergiovane/node-red-contrib-knx-ultimate
Admin
KNX Ultimate is a comprehensive Node-RED extension for controlling KNX and KNX Secure installations...
Tokens:336,917
Snippets:1,762
Trust Score:8.9
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Virtual Device Node Configuration

Source: https://github.com/supergiovane/node-red-contrib-knx-ultimate/blob/master/docs/wiki/-Sample---Virtual-Device.md

Example configuration for a knxUltimate node acting as a virtual device.

```json
{"id":"874a9486.d65c6","type":"knxUltimate","z":"d54a843.d1740f8","server":"123ea2c2.4a920d","topic":"5/0/1","outputtopic":"","dpt":"1.001","initialread":false,"notifyreadrequest":false,"notifyresponse":true,"notifywrite":false,"notifyreadrequestalsorespondtobus":true,"notifyreadrequestalsorespondtobusdefaultvalueifnotinitialized":"false","listenallga":false,"name":"Light Status","outputtype":"write","outputRBE":false,"inputRBE":false,"formatmultiplyvalue":"1","formatnegativevalue":"leave","formatdecimalsvalue":"999","passthrough":"no","x":370,"y":400,"wires":[["dec16169.4ab8e8"]]}
```

--------------------------------

### AI Education Configuration Example

Source: https://github.com/supergiovane/node-red-contrib-knx-ultimate/blob/master/nodes/locales/en/knxUltimateAI.html

Example text for the AI Education field to define assistant persona, notification preferences, and specific object handling rules.

```text
Call me Alex and answer in the same language I use. Keep replies short unless I ask for technical details. The office cover may remain open during the day: do not notify me about it. Notify me when another cover, window, or door remains open unusually long. When "living-room light" is ambiguous, ask which light I mean. Never say that an actuator changed until a KNX status object confirms it.
```

--------------------------------

### Input Payload Example

Source: https://github.com/supergiovane/node-red-contrib-knx-ultimate/wiki/HUE Plug

Format for sending advanced control commands to the node when I/O pins are enabled.

```json
{ on: { on: true } }
```

--------------------------------

### Control Staircase Timer via Flow

Source: https://github.com/supergiovane/node-red-contrib-knx-ultimate/blob/master/nodes/locales/de/knxUltimateStaircase.html

Examples for starting or cancelling the staircase timer using flow messages.

```javascript
// Start the staircase timer
msg.payload = true;
return msg;
```

```javascript
// Cancel the timer (requires '0 command cancels the cycle')
msg.payload = false;
return msg;
```

--------------------------------

### Initialize Node UI and Event Handlers

Source: https://github.com/supergiovane/node-red-contrib-knx-ultimate/blob/master/nodes/knxUltimateHueScene.html

Sets up autocomplete for KNX group addresses and handles changes to server and Hue device configurations.

```javascript
$enablePinsSelect.val(normalizePinsValue(node.enableNodePINS)); $enablePinsSelect.on('change.knxUltimateHueScene', updatePinsState); updatePinsState(); } $('#node-input-server').on('change.knxUltimateHueScene', function () { const serverId = $(this).val(); loadDPTOptions(serverId, node); setupKnxAutocomplete({ inputSelector: '#node-input-GAscene', nameSelector: '#node-input-namescene', dptSelector: '#node-input-dptscene', allowedPrefixes: ['1.', '18.'], }); setupKnxAutocomplete({ inputSelector: '#node-input-GAsceneStatus', nameSelector: '#node-input-namesceneStatus', dptSelector: '#node-input-dptsceneStatus', allowedPrefixes: ['1.'], }); setupKnxAutocomplete({ inputSelector: '#node-input-GAsceneMulti', nameSelector: '#node-input-namesceneMulti', dptSelector: '#node-input-dptsceneMulti', allowedPrefixes: ['18.'], }); updateKnxVisibility(); }); $('#node-input-serverHue').on('change.knxUltimateHueScene', () => { cachedScenes = []; if (currentNode) currentNode._cachedSceneDevices = cachedScenes; if ($deviceName) { $deviceName.val(''); $('#node-input-hueDevice').val(''); applyNoDevicesPlaceholder(false); } updateTabsVisibility(); }); updateKnxVisibility(); }
```

--------------------------------

### Alexa Switch Flow Configuration

Source: https://github.com/supergiovane/node-red-contrib-knx-ultimate/wiki/samples/-Sample - Alexa

A complete Node-RED flow example for an Alexa-controlled switch. Adjust the node settings to match your specific KNX setup.

```javascript
[{"id":"42e956e6.64c36","type":"alexa-home","z":"2f31a28c.63324e","conf":"2998fc6.4d4e684","device":"47401","acknoledge":true,"name":"Luce soggiorno","topic":"","x":160,"y":80,"wires":[["1a7e8cbb.ad4cf3"]]},{"id":"eaf537c2.31caf8","type":"knxUltimate","z":"2f31a28c.63324e","server":"a01c5d80.1bbb78","topic":"0/0/19","dpt":"5.001","initialread":false,"notifyreadrequest":false,"notifyresponse":false,"notifywrite":true,"listenallga":false,"name":"Soggiorno luce brighness value","outputtype":"write","x":610,"y":120,"wires":[[]]},{"id":"b07a8643.5911a","type":"knxUltimate","z":"2f31a28c.63324e","server":"a01c5d80.1bbb78","topic":"0/0/10","dpt":"1.001","initialread":false,"notifyreadrequest":false,"notifyresponse":false,"notifywrite":true,"listenallga":false,"name":"Soggiorno luce (switch)","outputtype":"write","x":610,"y":60,"wires":[[]]},{"id":"1a7e8cbb.ad4cf3","type":"switch","z":"2f31a28c.63324e","name":"","property":"payload","propertyType":"msg","rules":[{"t":"true"},{"t":"false"},{"t":"else"}],"checkall":"true","repair":false,"outputs":3,"x":350,"y":80,"wires":[["b07a8643.5911a"],["b07a8643.5911a"],["eaf537c2.31caf8"]]},{"id":"2998fc6.4d4e684","type":"alexa-home-conf","z":"","username":"Squaraus"},{"id":"a01c5d80.1bbb78","type":"knxUltimate-config","z":"","host":"224.0.23.12","port":"3671","physAddr":"1.1.99","suppressACKRequest":false,"csv":"\"Group name\"\t\"Address\"\t\"Central\"\t\"Unfiltered\"\t\"Description\"\t\"DatapointType\"\t\"Security\"\n\"Attuatori luci\"\t\"0/-/-\"\t\"\"\t\"\"\t\"Attuatori luci\"\t\"\"\t\"Auto\"\n\"Luci primo piano\"\t\"0/0/-\"\t\"\"\t\"\"\t\"Luci primo piano\"\t\"\"\t\"Auto\"\n\"Camera da letto luce\"\t\"0/0/1\"\t\"\"\t\"\"\t\"Camera da letto luce\"\t\"DPST-1-8\"\t\"Auto\"\n\"Loggia camera da letto\"\t\"0/0/2\"\t\"\"\t\"\"\t\"Loggia camera da letto\"\t\"DPST-1-1\"\t\"Auto\"\n\"Camera armadi luce\"\t\"0/0/3\"\t\"\"\t\"\"\t\"Camera armadi luce\"\t\"DPST-1-1\"\t\"Auto\"\n\"Bagno grande luce\"\t\"0/0/4\"\t\"\"\t\"\"\t\"Bagno grande luce\"\t\"DPST-1-1\"\t\"Auto\"\n\"Loggia bagno grande\"\t\"0/0/5\"\t\"\"\t\"\"\t\"Loggia bagno grande\"\t\"DPST-1-1\"\t\"Auto\"\n\"Bagno grande specchio (switch)\"\t\"0/0/6\"\t\"\"\t\"\"\t\"Bagno grande specchio switch\"\t\"DPST-1-1\"\t\"Auto\"\n\"Lavanderia luce\"\t\"0/0/7\"\t\"\"\t\"\"\t\"Lavanderia luce\"\t\"DPST-1-1\"\t\"Auto\"\n\"Lavanderia specchio (switch)\"\t\"0/0/8\"\t\"\"\t\"\"\t\"Lavanderia specchio switch\"\t\"DPST-1-1\"\t\"Auto\"\n\"Studio luce\"\t\"0/0/9\"\t\"\"\t\"\"\t\"Studio luce\"\t\"DPST-1-1\"\t\"Auto\"\n\"Soggiorno luce (switch)\"\t\"0/0/10\"\t\"\"\t\"\"\t\"Soggiorno luce switch\"\t\"DPST-1-1\"\t\"Auto\"\n\"Soggiorno aplique (switch)\"\t\"0/0/11\"\t\"\"\t\"\"\t\"Soggiorno aplique switch\"\t\"DPST-1-1\"\t\"Auto\"\n\"Loggia soggiorno cucina\"\t\"0/0/12\"\t\"\"\t\"\"\t\"Loggia soggiorno-cucina\"\t\"DPST-1-1\"\t\"Auto\"\n\"Cucina luce\"\t\"0/0/13\"\t\"\"\t\"\"\t\"Cucina luce\"\t\"DPT-1\"\t\"Auto\"\n\"Cucina luce pensili\"\t\"0/0/14\"\t\"\"\t\"\"\t\"Cucina luce pensili\"\t\"DPT-1\"\t\"Auto\"\n\"Corridoio luce\"\t\"0/0/15\"\t\"\"\t\"\"\t\"Corridoio luce\"\t\"DPST-1-1\"\t\"Auto\"\n\"Scala LED\"\t\"0/0/16\"\t\"\"\t\"\"\t\"Scala LED\"\t\"DPST-1-1\"\t\"Auto\"\n\"Soggiorno aplique brighness value\"\t\"0/0/17\"\t\"\"\t\"\"\t\"\"\t\"DPST-5-1\"\t\"Auto\"\n\"Bagno grande specchio (dim)\"\t\"0/0/18\"\t\"\"\t\"\"\t\"Bagno grande specchio dim\"\t\"DPST-3-7\"\t\"Auto\"\n\"Soggiorno luce brighness value\"\t\"0/0/19\"\t\"\"\t\"\"\t\"\"\t\"DPST-5-1\"\t\"Auto\"\n\"Lavanderia specchio (dim)\"\t\"0/0/20\"\t\"\"\t\"\"\t\"Lavanderia specchio dim\"\t\"DPST-3-7\"\t\"Auto\"\n\"Scala LED cambiacolori RGB\"\t\"0/0/21\"\t\"\"\t\"\"\t\"\"\t\"DPST-1-1\"\t\"Auto\"\n\"Bagno grande specchio brightness value\"\t\"0/0/22\"\t\"\"\t\"\"\t\"\"\t\"DPST-5-1\"\t\"Auto\"\n\"Soggiorno luce (dim)\"\t\"0/0/23\"\t\"\"\t\"\"\t\"Soggiorno luce dim\"\t\"DPST-3-7\"\t\"Auto\"\n\"Soggiorno aplique (dim)\"\t\"0/0/24\"\t\"\"\t\"\"\t\"Soggiorno aplique dim\"\t\"DPST-3-7\"\t\"Auto\"\n\"Lavanderia specchio brightness value\"\t\"0/0/25\"\t\"\"\t\"\"\t\"\"\t\"DPST-5-1\"\t\"Auto\"\n\"Soggiorno Luce Stato\"\t\"0/0/26\"\t\"\"\t\"\"\t\"\"\t\"DPST-5-1\"\t\"Auto\"\n\"Soggiorno Aplique Stato\"\t\"0/0/27\"\t\"\"\t\"\"\t\"\"\t\"DPST-5-1\"\t\"Auto\"\n\"Camera armadi luce Stato\"\t\"0/0/28\"\t\"\"\t\"\"\t\"Camera armadi luce\"\t\"DPST-1-1\"\t\"Auto\"\n\"Bagno grande luce "}
```

--------------------------------

### Control WatchDog State

Source: https://github.com/supergiovane/node-red-contrib-knx-ultimate/wiki/WatchDog-Configuration

Start or stop the WatchDog monitoring process by setting the start property in the message.

```APIDOC
## Start/Stop WatchDog

### Description
Controls the activation state of the WatchDog node.

### Parameters
- **msg.start** (boolean) - Required - Set to true to start the WatchDog, false to stop it.

### Request Example
```javascript
msg.start = true;
return msg;
```
```

--------------------------------

### DPT Help Sample Editor Initialization

Source: https://github.com/supergiovane/node-red-contrib-knx-ultimate/blob/master/nodes/knxUltimate.html

Handles fetching DPT help data and initializing an Ace editor instance to display sample payloads or documentation links.

```javascript
return msg;` }) try { node.sampleEditor.setReadOnly(true) node.sampleEditor.setShowPrintMargin(false) } catch (error) { } $("<div>", { class: "dpt-details-link" }) .append($("<span>").text("RAW mode keeps the telegram undecoded and exposes the bytes in ")) .append($("<code>").text("msg.knx.rawValue")) .append($("<span>").text(".")) .appendTo(helplinkContainer) return } $.getJSON("knxUltimateDptsGetHelp?dpt=" + _dpt + "&serverId=" + serverId + "&" + { _: new Date().getTime() }, (data) => { const helplinkContainer = $("#sampleCodeEditor") try { if (node.sampleEditor) { node.sampleEditor.destroy() delete node.sampleEditor } } catch (error) { } $("#example-editor").empty() helplinkContainer.empty() const translate = (key, opts) => { try { if (typeof RED !== 'undefined' && RED._) { return RED._(key, opts) } } catch (error) { } return null } const noSampleText = translate('knxUltimate.dptDetails.noSample') || 'Currently, no sample payload is available.' const createEditor = (value) => { node.sampleEditor = RED.editor.createEditor({ id: 'example-editor', mode: 'ace/mode/javascript', value }) try { node.sampleEditor.setReadOnly(true) node.sampleEditor.setShowPrintMargin(false) } catch (error) { } } try { const hasHelp = data.help !== 'NO' if (hasHelp) { createEditor(data.help) if (data.helplink) { const label = translate('Detail', { dpt: _dpt }) || ('More details for ' + _dpt) helplinkContainer.html(`&nbsp;<i class="fa fa-question-circle"></i>&nbsp;<a target="_blank" href="${data.helplink}"><u>${label}</u></a>`) } } else { createEditor(noSampleText) if (data.helplink) { const labelWiki = translate('Wiki') || 'Open wiki' helplinkContainer.html(`&nbsp;<i class="fa fa-question-circle"></i>&nbsp;<a target="_blank" href="${data.helplink}"><u>${labelWiki}</u></a>`) } } } catch (error) { } if (detailsContainer.is(':visible') && node.sampleEditor) { setTimeout(() => { try { node.sampleEditor.resize(true) } catch (error) { } }, 0) } }) }
```

--------------------------------

### Configuration Script Logic

Source: https://github.com/supergiovane/node-red-contrib-knx-ultimate/blob/master/nodes/knxUltimateHueLightSensor.html

This script handles the initialization of vertical tabs, server resolution, and device selection for the KNX Ultimate Hue Light Sensor node.

```javascript
(function () { let $tabs = null; let $requiresBridgeElems = null; let $knxSections = null; let $deviceName = null; let $refreshButton = null; let $loadingIndicator = null; let $dptSelect = null; let $readStatusSelect = null; let $enablePinsSelect = null; let $outputInfo = null; let cachedDevices = []; let defaultDevicePlaceholder = ''; let showingNoDevicesPlaceholder = false; let currentNode = null; const EMPTY_SERVER_VALUES = new Set(['', 'none', '_add_', '__none__', '__null__', 'null', 'undefined']); const ensureVerticalTabsStyle = () => { if ($('#knxUltimateHueLightSensorVerticalTabs').length) return; const style = ` <style id="knxUltimateHueLightSensorVerticalTabs"> .hue-vertical-tabs.ui-tabs.ui-widget.ui-widget-content.ui-corner-all { display: flex; border: none; padding: 0; } .hue-vertical-tabs > ul.ui-tabs-nav { flex: 0 0 144px; border-right: 1px solid #ccc; border-left: none; border-top: none; border-bottom: none; padding: 0.5em 0.3em; } .hue-vertical-tabs > ul.ui-tabs-nav li { float: none; width: 100%; margin: 0 0 2px 0; } .hue-vertical-tabs > ul.ui-tabs-nav li a { display: block; width: 100%; white-space: nowrap; position: relative; border-bottom: none !important; } .hue-vertical-tabs > ul.ui-tabs-nav li.ui-tabs-active a::after { content: ""; position: absolute; left: 0; bottom: 0; width: 50%; height: 3px; background: currentColor; } .hue-vertical-tabs .ui-tabs-panel { flex: 1; padding: 0.8em 1em; box-sizing: border-box; border: none; background: transparent; } .hue-vertical-tabs .form-row { display: flex; flex-wrap: nowrap; align-items: center; gap: 4px; } .hue-vertical-tabs .hue-form-tip { display: flex; align-items: center; gap: 6px; width: 100%; margin-left: 0 !important; max-width: none; color: #1b7d33; margin-bottom: 6px; padding: 6px 10px; box-sizing: border-box; } .hue-vertical-tabs .hue-form-tip .fa { color: forestgreen; flex: 0 0 auto; } .hue-vertical-tabs .hue-form-tip span { flex: 1 1 auto; min-width: 0; white-space: normal; } </style>`; $('head').append(style); }; const detachHandlers = () => { $('#node-input-server').off('.knxUltimateHueLightSensor'); $('#node-input-serverHue').off('.knxUltimateHueLightSensor'); if ($deviceName) { $deviceName.off('.knxUltimateHueLightSensor'); if ($deviceName.data('ui-autocomplete')) { try { $deviceName.autocomplete('destroy'); } catch (error) { /* empty */ } } } if ($refreshButton) $refreshButton.off('.knxUltimateHueLightSensor'); const $gaInput = $('#node-input-GAlightsensor'); if ($gaInput.length && $gaInput.data('ui-autocomplete')) { try { $gaInput.autocomplete('destroy'); } catch (error) { /* empty */ } } if ($enablePinsSelect) $enablePinsSelect.off('.knxUltimateHueLightSensor'); }; const ensureConfigSelection = (selector) => { if ($(selector).val() !== '_ADD_') return; try { $(selector).prop('selectedIndex', 0); } catch (error) { /* empty */ } }; const resolveServerId = (value) => { if (value === undefined || value === null) return null; if (value === false) return null; if (typeof value === 'string') { const trimmed = value.trim(); if (trimmed === '') return null; if (EMPTY_SERVER_VALUES.has(trimmed.toLowerCase())) return null; return trimmed; } const asString = String(value).trim(); if (asString === '' || EMPTY_SERVER_VALUES.has(asString.toLowerCase())) return null; return value; }; const normalizePinsValue = (value) => { if (value === undefined || value === null || value === '') return 'yes'; if (value === true || value === 'true') return 'yes'; if (value === false || value === 'false') return 'no'; return value; }; const getKnxServer = (allowFallback = true) => { const resolved = resolveServerId($('#node-input-server').val()); if (resolved) return RED.nodes.node(resolved); if (!allowFallback) return null; const fallback = resolveServerId(currentNode ? currentNode.server : null); return fallback ? RED.nodes.node(fallback) : null; }; const getHueServer = (allowFallback = true) => { const resolved = resolveServerId($('#node-input-serverHue').val()); if (resolved) return RED.nodes.node(resolved); if (!allowFallback) return null; const fallback = resolveServerId(currentNode ? currentNode.serverHue : null); return fallback ? RED.nodes.node(fallback) : null; }; const hasKnxSelection = () => { const resolved = resolveServerId($('#node-input-server').val()); if (resolved) return true; if ($('#node-input-server').length) return false; return resolveServerId(currentNode ? currentNode.server : null) !== null; }; const hasHueSelection = () => { const resolved = resolveServerId($('#node-input-serverHue').val()); if (resolved) return true; if ($('#node-input-serverHue').length) return false; return resolveServerId(currentNode ? currentNode.serverHue : null) !== null; }; const applyNoDevicesPlaceholder = (hasDevices) => { if (!$deviceName) return; if (hasDevices) { if (showingNoDevicesPlaceholder) { showingNoDevicesPlaceholder = false; $deviceName.attr('placeholder', defaultDevicePlaceholder); } return; } const message = 
```

--------------------------------

### Start and Stop WatchDog

Source: https://github.com/supergiovane/node-red-contrib-knx-ultimate/wiki/WatchDog-Configuration

Use these messages to toggle the WatchDog state.

```javascript
// Start the WatchDog
msg.start = true;
return msg;
```

```javascript
// Start the WatchDog
msg.start = false;
return msg;
```

--------------------------------

### Initialize UI Components and Tabs

Source: https://github.com/supergiovane/node-red-contrib-knx-ultimate/blob/master/nodes/knxUltimate-config.html

Handles the initialization of the configuration tabs and the visibility of protocol-specific UI elements.

```javascript
=== 'undefined' ? 1200 : node.serialTimeout); try { let isKBERRY = node.isKBERRY; if (typeof isKBERRY === 'undefined' || isKBERRY === null || isKBERRY === '') { isKBERRY = true; } else if (typeof isKBERRY === 'string') { isKBERRY = isKBERRY.toLowerCase() === 'true'; } else { isKBERRY = !!isKBERRY; } $("#node-config-input-isKBERRY").val(isKBERRY ? 'true' : 'false'); } catch (e) { } } const syncStatusDateTimeRows = () => { try { const mode = $("#node-config-input-statusDateTimeFormat").val(); const showCustom = mode === 'custom'; $("#knxUltimate-statusDateTimeCustom-row").toggle(showCustom); $("#knxUltimate-statusDateTimeLocale-row").toggle(showCustom); } catch (e) { } } $("#node-config-input-statusDateTimeFormat").on("change", syncStatusDateTimeRows); syncStatusDateTimeRows(); function updateProtocolSections() { const isSerial = isSerialProtocolSelected(); $("#rowPort").toggle(!isSerial); $("#rowEthernetInterface").toggle(!isSerial); if (isSerial) { $("#divKNXEthInterfaceManuallyInput").hide(); } else { try { updateEthernetManualVisibility($("#node-config-input-KNXEthInterface").val()); } catch (e) { } } $("#serialAdvancedContainer").toggle(isSerial); if (isSerial) { syncSerialPortPathFromHost(); } } // 22/07/2021 Main tab // Initialize tabs strictly from saved config, not from keyring presence $("#tabsMain").tabs({ active: (node.knxSecureSelected === true || node.knxSecureSelected === 'true') ? 1 : 0, activate: function (event, ui) { node.knxSecureSelected = $(ui.newTab).index() === 1; try { updateTunnelIAVisibility(); updatePhysAddrVisibility(); updateSecureMulticastHint(); enforceProtocolFromIP(); updateRevealKeyringButton(); } catch (e) { } } }); // Ensure the correct tab is enforced after all UI init try { const initialActive = (node.knxSecureSelected === true || node.knxSecureSelected === 'true') ? 1 : 0; setTimeout(() => { $("#tabsMain").tabs("option", "active", initialActive); updateTunnelIAVisibility(); updatePhysAddrVisibility(); updateSecureMulticastHint(); enforceProtocolFromIP(); updateRevealKeyringButton(); }, 0); } catch (e) { }
```

--------------------------------

### Start/Stop WatchDog

Source: https://github.com/supergiovane/node-red-contrib-knx-ultimate/blob/master/nodes/locales/en/knxUltimateWatchDog.html

Control the operational state of the WatchDog node by setting the start property.

```APIDOC
## Start WatchDog

### Description
Enables the WatchDog monitoring functionality.

### Request Example
```javascript
msg.start = true;
return msg;
```

## Stop WatchDog

### Description
Disables the WatchDog monitoring functionality.

### Request Example
```javascript
msg.start = false;
return msg;
```
```

--------------------------------

### UI Initialization and Configuration Logic

Source: https://github.com/supergiovane/node-red-contrib-knx-ultimate/blob/master/nodes/knxUltimate.html

Handles backward compatibility for RBE settings, server connection status, and default node property initialization.

```javascript
true).slideToggle(200, function () { if (dptDetailsContainer.is(':visible') && node.sampleEditor) { try { node.sampleEditor.resize(true) } catch (error) { } } }) }) function checkUI() { // Backward compatibility if (node.outputRBE === true || $("#node-input-outputRBE").val() === true) { node.outputRBE = 'true'; $("#node-input-outputRBE").val("true") } if (node.outputRBE === undefined || node.outputRBE === false || $("#node-input-outputRBE").val() === false) { node.outputRBE = 'false'; $("#node-input-outputRBE").val("false") } if (node.inputRBE === true || $("#node-input-inputRBE").val() === true) { node.inputRBE = 'true'; $("#node-input-inputRBE").val("true") } if (node.inputRBE === undefined || node.inputRBE === false || $("#node-input-inputRBE").val() === false) { node.inputRBE = 'false'; $("#node-input-inputRBE").val("false") } if (node.passthrough === undefined) { node.passthrough = 'no'; $("#node-input-passthrough").val("no") } if (node.initialread === undefined || node.initialread === false) { node.initialread = 0; $("#node-input-initialread").val(0) } oNodeServer = RED.nodes.node($("#node-input-server").val()); if (oNodeServer === undefined) { // Show the DEPLOY FIRST message $("#divDeployFirst").show(); $("#divMain").hide(); } else { $("#divDeployFirst").hide(); $("#divMain").show(); try { if (typeof oNodeServer.csv !== "undefined" && oNodeServer.csv !== "") { $("#isETSFileLoaded").val("si"); } else { $("#isETSFileLoaded").val("no"); } } catch (error) { $("#isETSFileLoaded").val("no"); } refreshKnxFunctionHelperState($("#isETSFileLoaded").val() === "si"); if (oNodeServer.knxSecureSelected) { $("#divknxsecure").show(); } else { $("#divknxsecure").hide(); } if ($("#node-input-server").val() !== "\_ADD\_" && $("#node-input-server").val() !== '') { refreshSecureGAs(); $.getJSON("knxUltimateDpts?serverId=" + $("#node-input-server").val() + "&\_=" + new Date().getTime(), (data) => { $("#node-input-dpt").empty(); appendRawDptOption($("#node-input-dpt")); data.forEach(dpt => { $("#node-input-dpt").append($("<option></option>") .attr("value", dpt.value) .text(dpt.text)) }); if (node.dpt === undefined || node.dpt === '') node.dpt = '1.001' $("#node-input-dpt").val(node.dpt); // Load help sample knxUltimateDptsGetHelp(node.dpt, true); refreshRawModeUI(); }) } // Add write and response as default for existing nodes like was default before if (node.notifywrite === undefined) { node.notifywrite = true node.notifyresponse = true $("#node-input-notifywrite").prop("checked", true) $("#node-input-notifyresponse").prop("checked", true) } // Add Write as default for existing clients output if (node.outputtype === undefined) { node.outputtype = "write" $("#node-input-outputtype").val("write") } $("#node-input-notifyreadrequest").on('change', function () { if (isRawDptSelected()) { $("#divnotifyreadrequestautoreact").hide(); } else if ($("#node-input-notifyreadrequest").is(":checked")) { if ($("#node-input-setTopicType").val() === "listenAllGA") { } else { $("#divnotifyreadrequestautoreact").show(); } } else { $("#divnotifyreadrequestautoreact").hide(); } }) $("#node-input-periodicSend").on('change', function () { if ($("#node-input-periodicSend").is(":checked")) { $("#divPeriodicSendInterval").show() } else { $("#divPeriodicSendInterval").hide() } }) // Set the group address type if (node.setTopicType === undefined) { node.setTopicType = 'str'; $("#node-input-setTopicType").val('str'); }
```

--------------------------------

### Control Telegram Counter Timer

Source: https://github.com/supergiovane/node-red-contrib-knx-ultimate/blob/master/nodes/locales/en/knxUltimateLogger.html

Input messages to start or stop the telegram counter timer.

```javascript
// Start the timer
msg.telegramcounterstarttimer = true;
return msg;
```

```javascript
// Start the timer
msg.telegramcounterstarttimer = false;
return msg;
```

--------------------------------

### Initialize and Configure Monaco Editors

Source: https://github.com/supergiovane/node-red-contrib-knx-ultimate/blob/master/nodes/knxUltimate.html

Sets up the send and receive message editors with custom themes and focus handlers.

```javascript
node.sendMsgToKNXCodeEditor = RED.editor.createEditor({ id: 'sendMsgToKNXCode-editor', mode: 'ace/mode/nrjavascript', value: node.sendMsgToKNXCode }); applyEditorOptions(node.sendMsgToKNXCodeEditor); node.receiveMsgFromKNXCodeEditor = RED.editor.createEditor({ id: 'receiveMsgFromKNXCode-editor', mode: 'ace/mode/nrjavascript', value: node.receiveMsgFromKNXCode }); applyEditorOptions(node.receiveMsgFromKNXCodeEditor); if (typeof monaco !== 'undefined') { try { if (!globalScope._knxEditorThemesDefined) { monaco.editor.defineTheme('knx-send-theme', { base: 'vs', inherit: true, rules: [], colors: { 'editor.background': '#e8f5e9', 'editorGutter.background': '#e8f5e9' } }); monaco.editor.defineTheme('knx-receive-theme', { base: 'vs', inherit: true, rules: [], colors: { 'editor.background': '#fffde7', 'editorGutter.background': '#fffde7' } }); globalScope._knxEditorThemesDefined = true; } if (typeof node.sendMsgToKNXCodeEditor.updateOptions === 'function') { node.sendMsgToKNXCodeEditor.updateOptions({ theme: 'knx-send-theme' }); } if (typeof node.receiveMsgFromKNXCodeEditor.updateOptions === 'function') { node.receiveMsgFromKNXCodeEditor.updateOptions({ theme: 'knx-receive-theme' }); } } catch (e) { } } node.activeCodeEditor = null; attachFocusHandlers(node.sendMsgToKNXCodeEditor); attachFocusHandlers(node.receiveMsgFromKNXCodeEditor);
```

--------------------------------

### Initialize KNX Bindings

Source: https://github.com/supergiovane/node-red-contrib-knx-ultimate/blob/master/nodes/knxUltimateHueLight.html

Configures DPT and group address bindings for various light control parameters including switching, dimming, color, and HSV settings.

```javascript
"#node-input-dptLightSwitch", ["1."]); getDPT("1.", "#node-input-dptLightState"); getGroupAddress("#node-input-GALightState", "#node-input-nameLightState", "#node-input-dptLightState", ["1."]); getDPT("3.007", "#node-input-dptLightDIM"); getGroupAddress("#node-input-GALightDIM", "#node-input-nameLightDIM", "#node-input-dptLightDIM", ["3.007"]); getDPT("5.001", "#node-input-dptLightBrightness"); getGroupAddress("#node-input-GALightBrightness", "#node-input-nameLightBrightness", "#node-input-dptLightBrightness", ["5.001"]); getDPT("5.001", "#node-input-dptLightBrightnessState"); getGroupAddress("#node-input-GALightBrightnessState", "#node-input-nameLightBrightnessState", "#node-input-dptLightBrightnessState", ["5.001"]); getDPT("232.600", "#node-input-dptLightColor"); getGroupAddress("#node-input-GALightColor", "#node-input-nameLightColor", "#node-input-dptLightColor", ["232.600"]); getDPT("232.600", "#node-input-dptLightColorState"); getGroupAddress("#node-input-GALightColorState", "#node-input-nameLightColorState", "#node-input-dptLightColorState", ["232.600"]); getDPT("3.007", "#node-input-dptLightKelvinDIM"); getGroupAddress("#node-input-GALightKelvinDIM", "#node-input-nameLightKelvinDIM", "#node-input-dptLightKelvinDIM", ["3.007"]); getDPT("5.001", "#node-input-dptLightKelvinPercentage"); getGroupAddress("#node-input-GALightKelvinPercentage", "#node-input-nameLightKelvinPercentage", "#node-input-dptLightKelvinPercentage", ["5.001"]); getDPT("5.001", "#node-input-dptLightKelvinPercentageState"); getGroupAddress("#node-input-GALightKelvinPercentageState", "#node-input-nameLightKelvinPercentageState", "#node-input-dptLightKelvinPercentageState", ["5.001"]); getDPT("1.", "#node-input-dptLightBlink"); getGroupAddress("#node-input-GALightBlink", "#node-input-nameLightBlink", "#node-input-dptLightBlink", ["1."]); getDPT("1.", "#node-input-dptLightColorCycle"); getGroupAddress("#node-input-GALightColorCycle", "#node-input-nameLightColorCycle", "#node-input-dptLightColorCycle", ["1."]); getDPT(effectDptPrefixes, "#node-input-dptLightEffect"); getGroupAddress("#node-input-GALightEffect", "#node-input-nameLightEffect", "#node-input-dptLightEffect", effectDptPrefixes); getDPT(effectDptPrefixes, "#node-input-dptLightEffectStatus"); getGroupAddress("#node-input-GALightEffectStatus", "#node-input-nameLightEffectStatus", "#node-input-dptLightEffectStatus", effectDptPrefixes); getDPT("1.", "#node-input-dptDaylightSensor"); getGroupAddress("#node-input-GADaylightSensor", "#node-input-nameDaylightSensor", "#node-input-dptDaylightSensor", ["1."]); getDPT("7.600", "#node-input-dptLightKelvin"); getDPT("9.002", "#node-input-dptLightKelvin"); getDPT("9.002", "#node-input-dptLightKelvinState"); getDPT("7.600", "#node-input-dptLightKelvinState"); getGroupAddress("#node-input-GALightKelvin", "#node-input-nameLightKelvin", "#node-input-dptLightKelvin", ["7.600", "9.002"]); getGroupAddress("#node-input-GALightKelvinState", "#node-input-nameLightKelvinState", "#node-input-dptLightKelvinState", ["7.600", "9.002"]); // HSV ---------------------- // H getDPT("3.007", "#node-input-dptLightHSV_H_DIM"); getGroupAddress("#node-input-GALightHSV_H_DIM", "#node-input-nameLightHSV_H_DIM", "#node-input-dptLightHSV_H_DIM", ["3.007"]); getDPT("5.001", "#node-input-dptLightHSV_H_State"); getGroupAddress("#node-input-GALightHSV_H_State", "#node-input-nameLightHSV_H_State", "#node-input-dptLightHSV_H_State", ["5.001"]); // S getDPT("3.007", "#node-input-dptLightHSV_S_DIM"); getGroupAddress("#node-input-GALightHSV_S_DIM", "#node-input-nameLightHSV_S_DIM", "#node-input-dptLightHSV_S_DIM", ["3.007"]); getDPT("5.001", "#node-input-dptLightHSV_S_State"); getGroupAddress("#node-input-GALightHSV_S_State", "#node-input-nameLightHSV_S_State", "#node-input-dptLightHSV_S_State", ["5.001"]); // V getDPT("3.007", "#node-input-dptLightHSV_V_DIM"); getGroupAddress("#node-input-GALightHSV_V_DIM", "#node-input-nameLightHSV_V_DIM", "#node-input-dptLightHSV_V_DIM", ["3.007"]); getDPT("5.001", "#node-input-dptLightHSV_V_State"); getGroupAddress("#node-input-GALightHSV_V_State", "#node-input-nameLightHSV_V_State", "#node-input-dptLightHSV_V_State", ["5.001"]); // END HSV ---------------------- }; refreshKnxBindings();"
```

--------------------------------

### Control Watchdog State

Source: https://github.com/supergiovane/node-red-contrib-knx-ultimate/blob/master/docs/wiki/-Sample---WatchDog.md

Function nodes to start or stop the watchdog by sending a boolean payload.

```javascript
return {start:true};
```

```javascript
return {start:false};
```

--------------------------------

### Initialize UI and Configuration Handlers

Source: https://github.com/supergiovane/node-red-contrib-knx-ultimate/blob/master/nodes/knxUltimateHueTemperatureSensor.html

This script handles the lifecycle of the node configuration UI, including injecting custom CSS for vertical tabs and managing event listeners for server and device selection.

```javascript
(function () { let $tabs = null; let $requiresBridgeElems = null; let $knxSections = null; let $deviceName = null; let $refreshButton = null; let $loadingIndicator = null; let $dptSelect = null; let $readStatusSelect = null; let $enablePinsSelect = null; let $outputInfo = null; let cachedDevices = []; let defaultDevicePlaceholder = ''; let showingNoDevicesPlaceholder = false; let currentNode = null; const EMPTY_SERVER_VALUES = new Set(['', 'none', '_add_', '__none__', '__null__', 'null', 'undefined']); const ensureVerticalTabsStyle = () => { if ($('#knxUltimateHueTemperatureTabsStyle').length) return; const style = ` <style id="knxUltimateHueTemperatureTabsStyle"> .hue-vertical-tabs.ui-tabs.ui-widget.ui-widget-content.ui-corner-all { display: flex; border: none; padding: 0; } .hue-vertical-tabs > ul.ui-tabs-nav { flex: 0 0 144px; border-right: 1px solid #ccc; border-left: none; border-top: none; border-bottom: none; padding: 0.5em 0.3em; } .hue-vertical-tabs > ul.ui-tabs-nav li { float: none; width: 100%; margin: 0 0 2px 0; } .hue-vertical-tabs > ul.ui-tabs-nav li a { display: block; width: 100%; white-space: nowrap; position: relative; border-bottom: none !important; } .hue-vertical-tabs > ul.ui-tabs-nav li.ui-tabs-active { border-bottom: none !important; } .hue-vertical-tabs > ul.ui-tabs-nav li.ui-tabs-active a::after { content: ""; position: absolute; left: 0; bottom: 0; width: 50%; height: 3px; background: currentColor; } .hue-vertical-tabs .ui-tabs-panel { flex: 1; padding: 0.8em 1em; box-sizing: border-box; border: none; background: transparent; } .hue-vertical-tabs .form-row { display: flex; flex-wrap: nowrap; align-items: center; gap: 4px; } .hue-vertical-tabs .hue-form-tip { display: flex; align-items: center; gap: 6px; width: 100%; margin-left: 0 !important; max-width: none; color: #1b7d33; margin-bottom: 6px; padding: 6px 10px; box-sizing: border-box; } .hue-vertical-tabs .hue-form-tip .fa { color: forestgreen; flex: 0 0 auto; } .hue-vertical-tabs .hue-form-tip span { flex: 1 1 auto; min-width: 0; white-space: normal; } </style>`; $('head').append(style); }; const detachHandlers = () => { $('#node-input-server').off('.knxUltimateHueTemperatureSensor'); $('#node-input-serverHue').off('.knxUltimateHueTemperatureSensor'); if ($deviceName) { $deviceName.off('.knxUltimateHueTemperatureSensor'); if ($deviceName.data('ui-autocomplete')) { try { $deviceName.autocomplete('destroy'); } catch (error) { /* empty */ } } } if ($refreshButton) $refreshButton.off('.knxUltimateHueTemperatureSensor'); const $gaInput = $('#node-input-GAtemperaturesensor'); if ($gaInput.length && $gaInput.data('ui-autocomplete')) { try { $gaInput.autocomplete('destroy'); } catch (error) { /* empty */ } } if ($enablePinsSelect) $enablePinsSelect.off('.knxUltimateHueTemperatureSensor'); }; const ensureConfigSelection = (selector) => { if ($(selector).val() !== '_ADD_') return; try { $(selector).prop('selectedIndex', 0); } catch (error) { /* empty */ } }; const resolveServerId = (value) => { if (value === undefined || value === null) return null; if (value === false) return null; if (typeof value === 'string') { const trimmed = value.trim(); if (trimmed === '') return null; if (EMPTY_SERVER_VALUES.has(trimmed.toLowerCase())) return null; return trimmed; } const asString = String(value).trim(); if (asString === '' || EMPTY_SERVER_VALUES.has(asString.toLowerCase())) return null; return value; }; const getKnxServer = (allowFallback = true) => { const resolved = resolveServerId($('#node-input-server').val()); if (resolved) return RED.nodes.node(resolved); if (!allowFallback) return null; const fallback = resolveServerId(currentNode ? currentNode.server : null); return fallback ? RED.nodes.node(fallback) : null; }; const getHueServer = (allowFallback = true) => { const resolved = resolveServerId($('#node-input-serverHue').val()); if (resolved) return RED.nodes.node(resolved); if (!allowFallback) return null; const fallback = resolveServerId(currentNode ? currentNode.serverHue : null); return fallback ? RED.nodes.node(fallback) : null; }; const hasKnxSelection = () => { const resolved = resolveServerId($('#node-input-server').val()); if (resolved) return true; if ($('#node-input-server').length) return false; return resolveServerId(currentNode ? currentNode.server : null) !== null; }; const hasHueSelection = () => { const resolved = resolveServerId($('#node-input-serverHue').val()); if (resolved) return true; if ($('#node-input-serverHue').length) return false; return resolveServerId(currentNode ? currentNode.serverHue : null) !== null; }; const normalizePinsValue = (value) => { if (value === undefined || value === null || value === '') return 'yes'; if (value === true || value === 'true') return 'yes'; if (value === false || value === 'false') return 'no'; return value; }; const applyNoDevicesPlaceholder = (hasDevices) => { if (!$deviceName) return; if (hasDevices) { if (showingNoDevicesPlaceholder) {
```

--------------------------------

### Read Status Function

Source: https://github.com/supergiovane/node-red-contrib-knx-ultimate/blob/master/nodes/locales/en/knxUltimate.html

Function node example to issue a read request to the KNX bus.

```javascript
// Example of a function that sends a read status message to the KNX-Ultimate
// Issues a read request to the KNX bus. You'll expect a 'response' from the bus.
```

--------------------------------

### Initialize Node UI Visibility

Source: https://github.com/supergiovane/node-red-contrib-knx-ultimate/blob/master/nodes/knxUltimateHuePlug.html

Handles the visibility of KNX server settings and pin configuration based on the selected server.

```javascript
$enablePinsSelect.val(previousPins); const updateKNXVisibility = () => { if (hasKNXServerSelected()) { $knxSections.show(); $readStatusRow.show(); $enablePinsSelect.prop('disabled', false); const desiredPins = 'no'; if ($enablePinsSelect.val() !== desiredPins) { $enablePinsSelect.val(desiredPins).trigger('change'); } previousPins = desiredPins; getDPT('1.', '#node-input-dptPlugSwitch'); getDPT('1.', '#node-input-dptPlugState'); getDPT('1.', '#node-input-dptPlugPowerState'); } else { $knxSections.hide(); $readStatusRow.hide(); previousPins = normalizePinsValue(node.enableNodePINS); $enablePinsSelect.val('yes'); $enablePinsSelect.prop('disabled', true); $enablePinsSelect.trigger('change'); } }; $('#node-input-enableNodePINS').on('change', function () { const val = $(this).val(); node.enableNodePINS = val; node.outputs = val === 'yes' ? 1 : 0; node.inputs = val === 'yes' ? 1 : 0; if (hasKNXServerSelected()) { previousPins = val; } if (val === 'yes') { $('#node-input-enableNodePINS').closest('.form-row').find('.form-tips').show(); } else { $('#node-input-enableNodePINS').closest('.form-row').find('.form-tips').hide(); } }); updateKNXVisibility(); $serverInput.on('change.knxUltimateHuePlug', () => { updateKNXVisibility(); });
```
Tokens:
Raw