node-red-contrib-knx-ultimate/nodes/knxUltimateHueContactSensor.js

Control your KNX and KNX Secure 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.

module.exports = function (RED) {
    function knxUltimateHueContactSensor(config) {
        RED.nodes.createNode(this, config)
        const node = this
        node.serverKNX = RED.nodes.getNode(config.server) || undefined
        node.serverHue = RED.nodes.getNode(config.serverHue) || undefined
        node.topic = node.name
        node.name = config.name === undefined ? 'Hue' : config.name
        node.dpt = ''
        node.notifyreadrequest = false
        node.notifyreadrequestalsorespondtobus = 'false'
        node.notifyreadrequestalsorespondtobusdefaultvalueifnotinitialized = ''
        node.notifyresponse = false
        node.notifywrite = true
        node.initialread = true
        node.listenallga = true // Don't remove
        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 = 2
        node.hueDevice = config.hueDevice
        node.initializingAtStart = false

        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);
        };

        const safeSendToKNX = (telegram, context = 'write') => {
            try {
                if (!node.serverKNX || typeof node.serverKNX.sendKNXTelegramToKNXEngine !== 'function') {
                    const now = new Date();
                    updateStatus({ fill: 'red', shape: 'dot', text: `KNX server missing (${context}) (${now.getDate()}, ${now.toLocaleTimeString()})` });
                    return;
                }
                node.serverKNX.sendKNXTelegramToKNXEngine({ ...telegram, nodecallerid: node.id });
            } catch (error) {
                updateStatus({ fill: 'red', shape: 'dot', text: `KNX send error ${error.message}` });
            }
        };

        // Used to call the status update from the config node.
        node.setNodeStatus = ({
            fill, shape, text, payload,
        }) => {
            try {
                if (payload === undefined) payload = '';
                const dDate = new Date();
                payload = typeof payload === "object" ? JSON.stringify(payload) : payload.toString();
                node.sKNXNodeStatusText = `|KNX: ${text} ${payload} (${dDate.getDate()}, ${dDate.toLocaleTimeString()})`;
                pushStatus({ fill, shape, text: (node.sHUENodeStatusText || '') + ' ' + (node.sKNXNodeStatusText || '') });
            } catch (error) { }
        };
        // Used to call the status update from the HUE config node.
        node.setNodeStatusHue = ({ fill, shape, text, payload }) => {
            try {
                if (payload === undefined) payload = '';
                const dDate = new Date();
                payload = typeof payload === "object" ? JSON.stringify(payload) : payload.toString();
                node.sHUENodeStatusText = `|HUE: ${text} ${payload} (${dDate.getDate()}, ${dDate.toLocaleTimeString()})`;
                pushStatus({ fill, shape, text: node.sHUENodeStatusText + ' ' + (node.sKNXNodeStatusText || '') });
            } catch (error) { }
        };

        // This function is called by the knx-ultimate config node, to output a msg.payload.
        node.handleSend = (msg) => {
        }

        node.handleSendHUE = (_event) => {
            try {
                if (_event.id === config.hueDevice) {

                    if (!_event.hasOwnProperty('contact_report')) {
                        return
                    }

                    const knxMsgPayload = {}
                    knxMsgPayload.topic = config.GAcontact
                    knxMsgPayload.dpt = config.dptcontact

                    if (_event.hasOwnProperty('contact_report')) {
                        knxMsgPayload.payload = _event.contact_report.state === 'contact'

                        // Send to KNX bus
                        if (knxMsgPayload.topic !== '' && knxMsgPayload.topic !== undefined) {
                            safeSendToKNX({
                                grpaddr: knxMsgPayload.topic,
                                payload: knxMsgPayload.payload,
                                dpt: knxMsgPayload.dpt,
                                outputtype: 'write',
                            }, 'write')
                        }

                        updateStatus({
                            fill: 'green',
                            shape: 'dot',
                            text: `HUE->KNX ${JSON.stringify(knxMsgPayload.payload)} (${new Date().getDate()}, ${new Date().toLocaleTimeString()})`,
                        })

                        // Set up the output msg
                        knxMsgPayload.name = node.name
                        knxMsgPayload.event = 'contact'

                        // Send payload
                        knxMsgPayload.rawEvent = _event
                        node.send(knxMsgPayload)
                        node.setNodeStatusHue({
                            fill: 'blue',
                            shape: 'ring',
                            text: 'HUE->KNX',
                            payload: knxMsgPayload.payload,
                        })
                    }
                }
            } catch (error) {
                updateStatus({
                    fill: 'red',
                    shape: 'dot',
                    text: `HUE->KNX error ${error.message} (${new Date().getDate()}, ${new Date().toLocaleTimeString()})`,
                })
            }
        }

        // On each deploy, unsubscribe+resubscribe
        if (node.serverKNX) {
            node.serverKNX.removeClient(node)
            node.serverKNX.addClient(node)
        }

        if (node.serverHue) {
            node.serverHue.removeClient(node)
            node.serverHue.addClient(node)
        }

        node.on('input', (msg) => {
        })

        node.on('close', (done) => {
            if (node.serverKNX) {
                node.serverKNX.removeClient(node)
            }
            if (node.serverHue) {
                node.serverHue.removeClient(node)
            }
            done()
        })
    }

    RED.nodes.registerType('knxUltimateHueContactSensor', knxUltimateHueContactSensor)
}