node-red-contrib-knx-ultimate 7.1.4 → 8.0.2

package/nodes/knxUltimateGlobalContext.js

@@ -1,208 +0,0 @@
-module.exports = function (RED) {
-  // msg is:
-  //  // Build final input message object
-  //  return {
-  //     topic: _outputtopic
-  //     , payload: jsValue
-  //     , devicename: (typeof _devicename !== 'undefined') ? _devicename : ""
-  //     , payloadmeasureunit: sPayloadmeasureunit
-  //     , payloadsubtypevalue: sPayloadsubtypevalue
-  //     , knx:
-  //     {
-  //         event: _event
-  //         , dpt: sInputDpt
-  //         //, details: dpt
-  //         , dptdesc: sDptdesc
-  //         , source: _srcGA
-  //         , destination: _destGA
-  //         , rawValue: _Rawvalue
-  //     }
-  // };
-
-  // The node.exposedGAs is and array of:
-  // {
-  //     address,
-  //     dpt,
-  //     payload
-  //     lastupdate
-  //     lastupdateLocale
-  // }
-
-  function knxUltimateGlobalContext (config) {
-    RED.nodes.createNode(this, config)
-    const node = this
-    node.serverKNX = RED.nodes.getNode(config.server) || undefined
-    node.topic = node.name
-    node.name = config.name === undefined ? 'KNXGlobalContext' : config.name
-    node.outputtopic = node.name
-    node.dpt = ''
-    node.notifyreadrequest = false
-    node.notifyreadrequestalsorespondtobus = 'false'
-    node.notifyreadrequestalsorespondtobusdefaultvalueifnotinitialized = ''
-    node.notifyresponse = true
-    node.notifywrite = true
-    node.initialread = false
-    node.listenallga = true
-    node.outputtype = 'write'
-    node.outputRBE = 'false' // Apply or not RBE to the output (Messages coming from flow)
-    node.inputRBE = 'false' // Apply or not RBE to the input (Messages coming from BUS)
-    node.currentPayload = '' // Current value for the RBE input and for the .previouspayload msg
-    node.passthrough = 'no'
-    node.formatmultiplyvalue = 1
-    node.formatnegativevalue = 'leave'
-    node.formatdecimalsvalue = 999
-    node.writeExecutionInterval = config.writeExecutionInterval === undefined ? 1000 : config.writeExecutionInterval
-    node.contextStorage = config.contextStorage !== undefined ? config.contextStorage : ''
-    node.exposeAsVariable = config.exposeAsVariable !== undefined ? config.exposeAsVariable : 'exposeAsVariableREADONLY' // Should expose the Group Addresses to the Global Context?
-    node.exposedGAs = []
-    node.timerExposedGAs = null
-
-    const pushStatus = (status) => {
-      if (!status) return
-      const provider = node.serverKNX
-      if (provider && typeof provider.applyStatusUpdate === 'function') {
-        provider.applyStatusUpdate(node, status)
-      } else {
-        node.status(status)
-      }
-    }
-
-    const updateStatus = (status) => {
-      if (!status) return
-      pushStatus(status)
-    }
-
-    // Used to call the status update from the config node.
-    node.setNodeStatus = ({ fill, shape, text, payload, GA, dpt, devicename }) => {
-      try {
-        if (node.serverKNX === null) { updateStatus({ fill: 'red', shape: 'dot', text: '[NO GATEWAY SELECTED]' }); return }
-        GA = GA === undefined ? '' : GA
-        payload = payload === undefined ? '' : payload
-        payload = typeof payload === 'object' ? JSON.stringify(payload) : payload
-        const dDate = new Date()
-        const ts = (node.serverKNX && typeof node.serverKNX.formatStatusTimestamp === 'function')
-          ? node.serverKNX.formatStatusTimestamp(dDate)
-          : `${dDate.getDate()}, ${dDate.toLocaleTimeString()}`
-        updateStatus({ fill, shape, text: GA + ' ' + payload + ' ' + text + ' (' + ts + ')' })
-      } catch (error) {
-      }
-    }
-
-    // 02/12/2022 Expose the complete ETS CSV as well
-    if (node.exposeAsVariable !== 'exposeAsVariableNO') {
-      try {
-        node.serverKNX.csv.forEach(element => {
-          node.exposedGAs.push({ address: element.ga, dpt: element.dpt, devicename: element.devicename, payload: undefined, lastupdate: undefined, lastupdateLocale: undefined })
-        })
-      } catch (error) {
-      }
-    }
-
-    // exposeAsVariableREADWRITE
-    // #region "WRITE TO BUS"
-    node.goTimerGo = function () {
-      if (node.timerExposedGAs !== null) clearTimeout(node.timerExposedGAs) // 21/03/2021
-      node.timerExposedGAs = setTimeout(() => {
-        let oContext = node.context().global.get(node.name + '_WRITE', node.contextStorage) || []
-        node.context().global.set(node.name + '_WRITE', [], node.contextStorage) // Delete the var
-        for (let index = 0; index < oContext.length; index++) {
-          const element = oContext[index]
-          if (element.hasOwnProperty('address') === false) {
-            node.setNodeStatus({ fill: 'RED', shape: 'dot', text: 'NO Group Address set', payload: '', GA: '', dpt: '', devicename: '' })
-            RED.log.error('knxUltimateGlobalContext: No group address set in node ' + node.id)
-            oContext = null // 21/03/2022
-            node.goTimerGo()
-            return
-          }
-          if (element.hasOwnProperty('payload') === false) {
-            node.setNodeStatus({ fill: 'RED', shape: 'dot', text: 'NO payload set', payload: '', GA: '', dpt: '', devicename: '' })
-            RED.log.error('knxUltimateGlobalContext: No payload set for address ' + element.address + ' in node ' + node.id)
-            oContext = null // 21/03/2022
-            node.goTimerGo()
-            return
-          }
-
-          // 13/09/2021 retrieve the datapoint if not specified
-          if (element.hasOwnProperty('dpt') === false || element.dpt === undefined || element.dpt === '') {
-            try {
-              const sDPT = node.serverKNX.csv.find(item => item.ga === element.address).dpt
-              element.dpt = sDPT
-            } catch (error) {
-              node.setNodeStatus({ fill: 'RED', shape: 'dot', text: 'Datapoint not found in CSV for ' + element.address, payload: '', GA: '', dpt: '', devicename: '' })
-              RED.log.error('knxUltimateGlobalContext: Datapoint not found in CSV for address ' + element.address + ' in node ' + node.id)
-              oContext = null // 21/03/2022
-              node.goTimerGo()
-              return
-            }
-          }
-
-          node.setNodeStatus({ fill: 'green', shape: 'dot', text: 'Write', payload: element.payload, GA: element.address, dpt: element.dpt || '', devicename: '' })
-          node.serverKNX.sendKNXTelegramToKNXEngine({ grpaddr: element.address, payload: element.payload, dpt: element.dpt || '', outputtype: 'write', nodecallerid: node.id })
-        }
-        oContext = null // 21/03/2022
-        node.goTimerGo()
-      }, node.writeExecutionInterval)
-    }
-    // 21/02/2021 timer for write to BUS
-    if (node.exposeAsVariable === 'exposeAsVariableREADWRITE') {
-      node.goTimerGo()
-      node.setNodeStatus({ fill: 'green', shape: 'dot', text: 'Start Writing', payload: '', GA: '', dpt: '', devicename: '' })
-    } else {
-      if (node.timerExposedGAs !== null) clearTimeout(node.timerExposedGAs)
-      node.context().global.set(node.name + '_WRITE', [], node.contextStorage) // Delete the var
-    }
-    // #endregion
-
-    // This function is called by the knx-ultimate config node, to output a msg.payload.
-    node.handleSend = msg => {
-      if (node.exposeAsVariable !== 'exposeAsVariableNO') {
-        try {
-          var oGa = node.exposedGAs.find(ga => ga.address === msg.knx.destination)
-        } catch (error) {
-          console.log(error)
-        }
-        const dNow = new Date()
-        const lastupdate = dNow.toISOString()
-        const lastupdateLocale = dNow.toLocaleString()
-        if (oGa === undefined) {
-          node.exposedGAs.push({ address: msg.knx.destination, devicename: undefined, dpt: msg.knx.dpt, payload: msg.payload, lastupdate, lastupdateLocale })
-        } else {
-          oGa.dpt = msg.knx.dpt
-          oGa.payload = msg.payload
-          oGa.lastupdate = lastupdate
-          oGa.lastupdateLocale = lastupdateLocale
-        }
-        // Save into the global Context
-        try {
-          node.context().global.set(node.name + '_READ', node.exposedGAs, node.contextStorage)
-        } catch (error) {
-          console.log(error)
-        }
-        oGa = null // 21/03/2022
-      } else {
-        node.exposedGAs = []
-        node.context().global.set(node.name + '_READ', node.exposedGAs, node.contextStorage)
-      }
-    }
-
-    node.on('input', function (msg) {
-
-    })
-
-    node.on('close', function (done) {
-      if (node.timerExposedGAs !== null) clearTimeout(node.timerExposedGAs)
-      node.exposedGAs = []
-      if (node.serverKNX) {
-        node.serverKNX.removeClient(node)
-      }
-      done()
-    })
-
-    // On each deploy, unsubscribe+resubscribe
-    if (node.serverKNX) {
-      node.serverKNX.removeClient(node)
-      node.serverKNX.addClient(node)
-    }
-  }
-  RED.nodes.registerType('knxUltimateGlobalContext', knxUltimateGlobalContext)
-}

package/nodes/knxUltimateHATranslator.html

@@ -1,85 +0,0 @@
-<script type="text/javascript" src="resources/node-red-contrib-knx-ultimate/flowMigrationBackup.js"></script>
-<script type="text/javascript" src="resources/node-red-contrib-knx-ultimate/knxUtilityMigration.js"></script>
-<script type="text/javascript">
-	RED.nodes.registerType('knxUltimateHATranslator', {
-		category: 'deprecated',
-		defaults: {
-			name: { value: "" },
-			payloadPropName: { value: "payload", required: false },
-			commandText: { value: 'on:true\noff:false\nactive:true\ninactive:false\nopen:true\nclosed:false\nclose:false\n1:true\n0:false\ntrue:true\nfalse:false\nhome:true\nnot_home:false', required: false }
-		},
-		inputs: 1,
-		outputs: 1,
-		icon: "node-ha-icon.svg",
-		label: function () {
-			return (this.name || 'HA -> KNX') + ' (deprecated)';
-		},
-		color: '#E5F0E2',
-		paletteLabel: "Home Assistant translator (deprecated)",
-		oneditprepare: function () {
-			// Go to the help panel
-			try {
-				RED.sidebar.show("help");
-			} catch (error) { }
-
-			var node = this;
-			node.editor = RED.editor.createEditor({
-				id: 'node-input-editorcommandText',
-				mode: 'ace/mode/text',
-				value: node.commandText
-			});
-		},
-		oneditsave: function () {
-			var node = this;
-			node.commandText = node.editor.getValue();
-			node.editor.destroy();
-			delete node.editor;
-		},
-		oneditcancel: function () {
-			// Return to the info tab
-			try {
-				RED.sidebar.show("info");
-			} catch (error) { }
-
-			var node = this;
-			node.editor.destroy();
-			delete node.editor;
-		},
-	});
-</script>
-
-<script type="text/html" data-template-name="knxUltimateHATranslator">
-    <div class="form-row knx-ultimate-v8-upgrade-row">
-        <button type="button" class="red-ui-button knx-ultimate-v8-upgrade-button" data-i18n="[title]node-red-contrib-knx-ultimate/knxUltimateUtility:knxUltimateUtility.v8_upgrade.button_title">
-            <i class="fa fa-arrow-circle-up" aria-hidden="true"></i>
-            <span data-i18n="node-red-contrib-knx-ultimate/knxUltimateUtility:knxUltimateUtility.v8_upgrade.button"></span>
-        </button>
-    </div>
-  <div class="form-row knx-utility-legacy-notice" role="note" style="box-sizing:border-box; padding:10px 12px; margin-bottom:12px; border-left:4px solid #d79b00; background:#fff8df; color:#4d3a00;">
-    <i class="fa fa-exclamation-triangle" aria-hidden="true"></i>
-    <span data-i18n="knxUltimateHATranslator.legacy_notice"></span>
-  </div>
-  <div class="form-row knx-utility-legacy-migration-action" style="margin-bottom:14px;">
-    <button type="button" class="red-ui-button knx-utility-migrate-flow" style="background:#d97706; border-color:#b45309; color:#fff !important; font-weight:700;" data-i18n="[title]knxUltimateHATranslator.migration_button_title">
-      <i class="fa fa-exchange" style="color:#fff !important;"></i> <span style="color:#fff !important;" data-i18n="knxUltimateHATranslator.migration_button"></span>
-    </button>
-  </div>
-  <div class="form-row" style="margin-bottom:10px;">
-    <span style="color:#ff0000"><i class="fa fa-youtube"></i></span>&nbsp;<a target="_blank" href="https://www.youtube.com/playlist?list=PL9Yh1bjbLAYrU8PsVhW4xzEug2WtVFv3E"><b>KNX-Ultimate video tutorials (YouTube playlist)</b></a>
-  </div>
-    <div class="form-row">
-        <label for="node-config-input-name">
-            <i class="fa fa-tag"></i> Name
-        </label>
-        <input type="text" id="node-config-input-name">
-    </div>
-	<div class="form-row">
-        <label for="node-input-payloadPropName"><i class="fa fa-ellipsis-h"></i> Input</label>
-		<input type="text" id="node-input-payloadPropName">
-    </div>
-    <div class="form-row">
-        <label style="width:300px;" for="node-input-commandText"><i class="fa fa-tasks"></i> Translate (Homassistant:KNX)</label>
-        <div style="height: 250px; min-height:150px;" class="node-text-editor" id="node-input-editorcommandText"></div>
-    </div>
-</script>
-

package/nodes/knxUltimateHATranslator.js

@@ -1,83 +0,0 @@
-/* eslint-disable prefer-arrow-callback */
-module.exports = function (RED) {
-  function knxUltimateHATranslator (config) {
-    RED.nodes.createNode(this, config)
-    this.config = config
-    const node = this
-
-    function setNodeStatus ({ fill, shape, text }) {
-      const dDate = new Date()
-      node.status({
-        fill,
-        shape,
-        text:
-          text +
-          ' (' +
-          dDate.getDate() +
-          ', ' +
-          dDate.toLocaleTimeString() +
-          ')'
-      })
-    }
-
-    setNodeStatus({ fill: 'grey', shape: 'dot', text: 'Waiting' })
-
-    this.on('input', function (msg) {
-      // 11/11/2021 Clone input message and replace only relevant topics
-      const utils = require('./utils/utils.js')
-      const sPayload = utils.fetchFromObject(
-        msg,
-        config.payloadPropName || 'payload'
-      )
-
-      // 15/11/2021 inform user about undefined topic or payload
-      if (sPayload === undefined) {
-        setNodeStatus({
-          fill: 'red',
-          shape: 'dot',
-          text: 'Received invalid payload from ' + msg.topic || ''
-        })
-        return
-      }
-
-      let bRes = null
-      try {
-        bRes = utils.ToBoolean(
-          sPayload,
-          node.config // Retrieve the config node. It can be null, but it's handled in utils.js; // 15/11/2021 Convert input to boolean.);
-        )
-      } catch (error) { }
-      if (bRes === undefined || bRes === null) {
-        setNodeStatus({
-          fill: 'red',
-          shape: 'dot',
-          text:
-            'Received non convertible boolean value ' +
-            sPayload +
-            ' from ' +
-            msg.topic
-        })
-        return
-      }
-
-      const msgOUt = RED.util.cloneMessage(msg)
-      try {
-        msgOUt.payload = bRes
-        setNodeStatus({
-          fill: 'green',
-          shape: 'dot',
-          text: '(Send) ' + msgOUt.payload
-        })
-        node.send(msgOUt)
-      } catch (error) {
-        setNodeStatus({
-          fill: 'red',
-          shape: 'dot',
-          text: 'Unable to invert the input payload ' + bRes
-        })
-      }
-    })
-  }
-
-  RED.nodes.registerType('knxUltimateHATranslator', knxUltimateHATranslator)
-}