@evilbunny/node-red-contrib-zigbee2mqtt 0.0.0 → 3.2.8

package/nodes/out.html

@@ -0,0 +1,300 @@
+<script type="text/x-red" data-template-name="zigbee2mqtt-eb-out">
+    <link rel="stylesheet" href="resources/@evilbunny/node-red-contrib-zigbee2mqtt/css/multiple-select.css" type="text/css" />
+    <link rel="stylesheet" href="resources/@evilbunny/node-red-contrib-zigbee2mqtt/css/common.css" type="text/css" />
+
+    <div class="form-row">
+        <label for="node-input-name" class="l-width"><i class="fa fa-bookmark"></i> <span data-i18n="label.name"></span></label>
+        <input type="text" id="node-input-name" data-i18n="[placeholder]placeholder.name">
+    </div>
+   <div class="form-row" style="display:none;">
+        <label for="node-input-friendly_name" class="l-width"><i class="fa fa-bookmark"></i> <span data-i18n="label.friendly_name"></span></label>
+        <input type="text" id="node-input-friendly_name" data-i18n="[placeholder]placeholder.friendly_name">
+    </div>
+    <div class="form-row">
+        <label for="node-input-server" class="l-width"><i class="fa fa-globe"></i> <span data-i18n="label.server"></span></label>
+        <input type="text" id="node-input-server">
+    </div>
+    <div class="form-row">
+        <label for="node-input-device_id" class="l-width"><i class="fa fa-crosshairs"></i> <span data-i18n="label.topic"></span></label>
+        <select id="node-input-device_id" class="s-width" multiple="multiple"></select>
+    </div>
+<!--    <div class="form-row">-->
+<!--        <label for='node-input-enableMultiple' class="l-width"></label>-->
+<!--        <input type="checkbox" id="node-input-enableMultiple" style="display: inline-block; width: auto; vertical-align: top;"> <span data-i18n="node-red-contrib-spruthub/server:label.enable_multiple"></span></input>-->
+<!--    </div>-->
+    <div class="form-row">
+        <label for="force-refresh" class="l-width"><i class="fa fa-refresh"></i> <span data-i18n="label.refresh"></span></label>
+        <a class="red-ui-button s-width" id="force-refresh" name="force-refresh"><span data-i18n="label.refresh_devices_list"></span></a>
+    </div>
+    <div class="form-row">
+        <label for="node-input-command" class="l-width"><i class="fa fa-tasks"></i> <span data-i18n="label.command"></span></label>
+        <input type="text" id="node-input-command" style="width:70%">
+        <input type="hidden" id="node-input-commandType">
+    </div>
+	<div class="form-row">
+        <label for="node-input-payload" class="l-width"><i class="fa fa-envelope"></i> <span data-i18n="label.payload"></span></label>
+        <input type="text" id="node-input-payload" style="width:70%">
+        <input type="hidden" id="node-input-payloadType">
+    </div>
+
+    <!--homekit-->
+    <div class="form-row help_block help_block__homekit_homekit">
+        <div class="form-tips">
+            <strong><span data-i18n="help.important"></span></strong><br>
+            <span data-i18n="help.command_homekit"></span>
+        </div>
+    </div>
+
+	<div class="form-row">
+        <label for="node-input-optionsValue" class="l-width"><i class="fa fa-gears"></i> <span data-i18n="label.options"></span></label>
+        <input type="text" id="node-input-optionsValue" style="width:70%">
+        <input type="hidden" id="node-input-optionsType">
+    </div>
+    <!--option description-->
+    <div class="form-tips optionsType_description">
+        <strong><div data-i18n="help.description"></div></strong>
+        <span></span>
+    </div>
+
+    <div class="form-row node-input-rule-container-row">
+        <ol id="node-input-rule-container"></ol>
+    </div>
+    <hr>
+
+
+    <!--brightness_move-->
+    <div class="form-tips help_block help_block__z2m_cmd_brightness_move">
+        <strong><span data-i18n="help.description"></span></strong><br>
+        <span data-i18n="help.command_brightness_move"></span>
+    </div>
+    <!--brightness_step-->
+    <div class="form-tips help_block help_block__z2m_cmd_brightness_step">
+        <strong><span data-i18n="help.description"></span></strong><br>
+        <span data-i18n="help.command_brightness_step"></span>
+    </div>
+
+</script>
+
+<script type='text/javascript'>
+    RED.nodes.registerType('zigbee2mqtt-eb-out', {
+        category: 'ZigBee2MQTT',
+        color: '#FDBF48',
+        align: 'right',
+        defaults: {
+            name: {
+                value: ""
+            },
+            server: {
+                type: "zigbee2mqtt-eb-server",
+                required: true
+            },
+            friendly_name: {
+                value: "",
+                required: false
+            },
+            device_id: {
+                value: null
+            },
+            command: {
+                value: 'state',
+            },
+            commandType: {
+                value: 'z2m_cmd',
+            },
+            payload: {
+                value: 'payload',
+            },
+            payloadType: {
+                value: 'msg',
+            },
+            optionsValue: {
+                value: null,
+            },
+            optionsType: {
+                value: null,
+            },
+            // enableMultiple: {
+            //     value: false,
+            //     required: true
+            // },
+        },
+        inputLabels: "value",
+        paletteLabel: 'out',
+        inputs: 1,
+        outputs: 0,
+        icon: "icon.png",
+        label: function() {
+            var label = 'z2m-out';
+
+            if (this.name) {
+                label = this.name;
+            } else if (typeof(this.friendly_name) == 'string' && this.friendly_name.length) {
+                label = this.friendly_name;
+            } else if (typeof(this.device_id) == 'string') {
+                label = this.device_id;
+            }
+            return label;
+        },
+        oneditprepare: function() {
+            let node = this;
+            let $inputCommand = $('#node-input-command');
+            let $inputCommandType = $('#node-input-commandType');
+
+            // setTimeout(()=>{
+                new Zigbee2MqttEditor(node, {
+                    'allow_empty': true
+                }).build();
+
+                showHelpBlock();
+                buildTypesInput();
+
+                $inputCommand.on('change', function(event, type, value) {
+                    $('#node-input-payload').typedInput('types', getPayloadTypes(value));
+
+                    //show/hide
+                    if ('homekit' === type || 'nothing' === type) {
+                        $('#node-input-payload').closest('.form-row').hide();
+                    } else {
+                        $('#node-input-payload').closest('.form-row').show();
+                    }
+
+                    showHelpBlock();
+                });
+
+
+                //init typedInput
+                $('#node-input-payload').typedInput({
+                    types: getPayloadTypes(node.command),
+                    default: 'msg',
+                    value: 'payload',
+                    typeField: $('#node-input-payloadType'),
+                });
+                $inputCommandType.val(node.commandType);
+                $('#node-input-payloadType').val(node.payloadType);
+
+                function showHelpBlock() {
+                    var command = $('#node-input-command').val(); //state
+                    var commandType = $('#node-input-commandType').val(); //z2m_cmd
+                    if (command === '{}') command = 'json';
+                    if (commandType === 'str') command = 'custom';
+                    $('.help_block').hide();
+                    $('.help_block__'+commandType+'_'+command).show();
+                }
+
+
+                function buildTypesInput() {
+                    $('#node-input-command').typedInput({
+                        types: getCommandTypes(),
+                        default: 'msg',
+                        value: 'topic',
+                        typeField: $('#node-input-commandType'),
+                    });
+                }
+
+                function getCommandTypes() {
+                    return [
+                        //z2m commands
+                        {
+                            value: 'z2m_cmd',
+                            label: 'zigbee2mqtt-eb',
+                            icon: 'icons/@evilbunny/node-red-contrib-zigbee2mqtt/icon.png',
+                            options: [
+                                {'value':'state', 'label':'State (on|off|toggle|lock|unlock|open|close)'},
+                                {'value':'state_l1', 'label':'State_l1 (on|off|toggle)'},
+                                {'value':'state_l2', 'label':'State_l2 (on|off|toggle)'},
+                                {'value':'state_l3', 'label':'State_l3 (on|off|toggle)'},
+                                {'value':'state_l4', 'label':'State_l4 (on|off|toggle)'},
+                                {'value':'state_l5', 'label':'State_l5 (on|off|toggle)'},
+                                {'value':'state_l6', 'label':'State_l6 (on|off|toggle)'},
+                                {'value':'state_l7', 'label':'State_l7 (on|off|toggle)'},
+                                {'value':'state_l8', 'label':'State_l8 (on|off|toggle)'},
+                                {'value':'state_l9', 'label':'State_l9 (on|off|toggle)'},
+                                {'value':'brightness', 'label':'Brightness (0..255)'},
+                                {'value':'brightness_move', 'label':'Brightness Move (-255...255|stop)'},
+                                {'value':'brightness_move_onoff', 'label':'Brightness Move On/Off (-255...255|stop)'},
+                                {'value':'brightness_step', 'label':'Brightness Step (-255...255)'},
+                                {'value':'brightness_step_onoff', 'label':'Brightness Step On/Off (-255...255)'},
+                                {'value':'color', 'label':'Color: {}'},
+                                {'value':'color_rgb', 'label':'Color: r,g,b'},
+                                {'value':'color_hex', 'label':'Color: #hex'},
+                                {'value':'color_hsb', 'label':'Color: h,s,b'},
+                                {'value':'color_hsv', 'label':'Color: h,s,v'},
+                                {'value':'color_hue', 'label':'Color: hue'},
+                                {'value':'color_saturation', 'label':'Color: saturation'},
+                                {'value':'color_temp', 'label':'Color Temperature (50..400)'},
+                                {'value':'color_temp_move', 'label':'Color Temperature Move (50..400|stop)'},
+                                {'value':'color_temp_step', 'label':'Color Temperature Step (50..400)'},
+                                {'value':'position', 'label':'Position (0..100)'},
+                                {'value':'scene', 'label':'Scene (0..255)'},
+                                {'value':'lock', 'label':'Lock (lock|unlock|on|off|toggle)'},
+                                {'value':'alert', 'label':'Alert'}
+                            ]
+                        },
+                        //homekit
+                        {
+                            value:'homekit',
+                            label:'homekit',
+                            icon:'icons/@evilbunny/node-red-contrib-zigbee2mqtt/homekit-logo.png',
+                            options:[{'value':'homekit', 'label':'Apple Homekit data format'}]
+                        },
+                        {
+                            value: 'nothing',
+                            label: RED._("@evilbunny/node-red-contrib-zigbee2mqtt/server:editor.nothing"),
+                            options:['']
+                        },
+                        {value:'str', label: 'str'},
+                        {value:'msg', label: 'msg'},
+                        {value:'json',label:'JSON',options:['{}']}
+                    ];
+                }
+
+                function getPayloadTypes(command) {
+                    let types = ['msg', 'flow', 'global', 'str', 'num', 'json'];
+                    let options = [];
+                    if (command.startsWith("state")) {
+                        options = [
+                            {'value':'on', 'label':'On'},
+                            {'value':'off', 'label':'Off'},
+                            {'value':'toggle', 'label':'Toggle'},
+                            {'value':'lock', 'label':'Lock'},
+                            {'value':'unlock', 'label':'Unlock'},
+                            {'value':'open', 'label':'Open'},
+                            {'value':'close', 'label':'Close'}
+                        ];
+                    } else if ('color_temp' === command) {
+                        options = [
+                            {'value':'50', 'label':'Cold'},
+                            {'value':'250', 'label':'White'},
+                            {'value':'400', 'label':'Warm'}
+                        ];
+                    } else if ('alert' === command) {
+                        options = [
+                            {'value':'none', 'label':'None'},
+                            {'value':'select', 'label':'Blink short'},
+                            {'value':'lselect', 'label':'Blink log'}
+                        ];
+                    }
+                    if (options.length) {
+                        const predefinedValuesPayload = {
+                            value: 'z2m_payload',
+                            label: 'zigbee2mqtt-eb',
+                            icon: 'icons/@evilbunny/node-red-contrib-zigbee2mqtt/icon.png',
+                            options
+                        };
+                        return [predefinedValuesPayload, ...types]
+                    } else {
+                        return types;
+                    }
+                }
+            // }, 100); //need timeout to load server node
+        },
+        oneditsave: function () {
+            //convert array for string if single mode
+            if (!$('#node-input-enableMultiple').is(':checked')) {
+                let device_id = $('#node-input-device_id').multipleSelect('getSelects', 'value');
+                this.device_id = device_id.length ? device_id[0] : null;
+            }
+        }
+    });
+</script>
+

package/nodes/out.js

@@ -0,0 +1,361 @@
+const Zigbee2mqttHelper = require('../resources/Zigbee2mqttHelper.js');
+
+module.exports = function(RED) {
+    class Zigbee2mqttNodeOut {
+        constructor(config) {
+            RED.nodes.createNode(this, config);
+
+            var node = this;
+            node.config = config;
+            node.cleanTimer = null;
+            node.server = RED.nodes.getNode(node.config.server);
+
+            if (node.server) {
+                node.status({}); //clean
+
+                node.on('input', function(message) {
+                    clearTimeout(node.cleanTimer);
+
+                    let key = node.config.device_id;
+                    if ((!key || key === 'msg.topic') && message.topic) {
+                        key = message.topic;
+                    }
+                    let device = node.server.getDeviceOrGroupByKey(key);
+                    if (device) {
+                        let payload;
+                        let options = {};
+                        switch (node.config.payloadType) {
+                            case '':
+                            case null:
+                            case 'nothing':
+                                payload = null;
+                                break;
+
+                            case 'flow':
+                            case 'global': {
+                                RED.util.evaluateNodeProperty(node.config.payload, node.config.payloadType, this, message, function (error, result) {
+                                    if (error) {
+                                        node.error(error, message);
+                                    } else {
+                                        payload = result;
+                                    }
+                                });
+                                break;
+                            }
+                            case 'z2m_payload':
+                                payload = node.config.payload;
+                                break;
+
+                            case 'num': {
+                                payload = parseInt(node.config.payload);
+                                break;
+                            }
+
+                            case 'str': {
+                                payload = node.config.payload;
+                                break;
+                            }
+
+                            case 'json': {
+                                if (Zigbee2mqttHelper.isJson(node.config.payload)) {
+                                    payload = JSON.parse(node.config.payload);
+                                } else {
+                                    node.warn('Incorrect payload. Waiting for valid JSON');
+                                    node.status({
+                                        fill: "red",
+                                        shape: "dot",
+                                        text: "@evilbunny/node-red-contrib-zigbee2mqtt/out:status.no_payload"
+                                    });
+                                    node.cleanTimer = setTimeout(function(){
+                                        node.status({}); //clean
+                                    }, 3000);
+                                }
+                                break;
+                            }
+
+                            // case 'homekit':
+                            //     payload = node.formatHomeKit(message, payload);
+                            //     break;
+
+                            case 'msg':
+                            default: {
+                                payload = message[node.config.payload];
+                                break;
+                            }
+                        }
+
+
+                        var command;
+                        switch (node.config.commandType) {
+                            case '':
+                            case null:
+                            case 'nothing':
+                                payload = null;
+                                break;
+
+                            case 'msg': {
+                                command = message[node.config.command];
+                                break;
+                            }
+                            case 'z2m_cmd':
+                                command = node.config.command;
+                                switch (command) {
+                                    case 'state':
+                                        if (payload === 'toggle') {
+                                            if (device.current_values && 'position' in device.current_values) {
+                                                payload = device.current_values.position > 0 ? 'close' : 'open';
+                                            }
+                                        }
+                                        break;
+                                    case 'brightness':
+                                        payload = parseInt(payload);
+                                        options["state"] = payload>0?"on":"Off";
+                                        break;
+
+                                    case 'position':
+                                        payload = parseInt(payload);
+                                        break;
+                                    
+                                    case 'scene':
+                                        command = 'scene_recall';
+                                        payload = parseInt(payload);
+                                        break;
+
+                                    case 'lock':
+                                        command = 'state';
+                                        if (payload === 'toggle') {
+                                            if (device.current_values && 'lock_state' in
+                                                device.current_values && device.current_values.lock_state === 'locked') {
+                                                payload = 'unlock';
+                                            } else {
+                                                payload = 'lock';
+                                            }
+                                        } else if (payload === 'lock' || payload == 1 || payload === true || payload === 'on') {
+                                            payload = 'lock';
+                                        } else if (payload === 'unlock' || payload == 0 || payload === false || payload === 'off') {
+                                            payload = 'unlock';
+                                        }
+                                        break;
+
+                                    case 'color':
+                                        payload =  {"color":payload};
+                                        break;
+                                    case 'color_rgb':
+                                        payload =  {"color":{"rgb": payload}};
+                                        break;
+                                    case 'color_hex':
+                                        command = "color";
+                                        payload =  {"color":{"hex": payload}};
+                                        break;
+                                    case 'color_hsb':
+                                        command = "color";
+                                        payload =  {"color":{"hsb": payload}};
+                                        break;
+                                    case 'color_hsv':
+                                        command = "color";
+                                        payload =  {"color":{"hsv": payload}};
+                                        break;
+                                    case 'color_hue':
+                                        command = "color";
+                                        payload =  {"color":{"hue": payload}};
+                                        break;
+                                    case 'color_saturation':
+                                        command = "color";
+                                        payload =  {"color":{"saturation": payload}};
+                                        break;
+
+                                    case 'color_temp':
+
+                                        break;
+
+                                    case 'brightness_move':
+                                    case 'brightness_step':
+                                    case 'alert':
+                                    default: {
+                                        break;
+                                    }
+                                }
+                                break;
+
+                            case 'homekit':
+                                payload = node.fromHomeKitFormat(message, device);
+                                break;
+
+                            case 'json':
+                                break;
+
+                            case 'str':
+                            default: {
+                                command = node.config.command;
+                                break;
+                            }
+                        }
+
+                        let optionsToSend = {};
+                        switch (node.config.optionsType) {
+                            case '':
+                            case null:
+                            case 'nothing':
+                                break;
+
+                            case 'msg':
+                                if (node.config.optionsValue in message && typeof(message[node.config.optionsValue]) == 'object') {
+                                    optionsToSend = message[node.config.optionsValue];
+                                } else {
+                                    node.warn('Options value has invalid format');
+                                }
+                                break;
+
+                            case 'json':
+                                if (Zigbee2mqttHelper.isJson(node.config.optionsValue)) {
+                                    optionsToSend = JSON.parse(node.config.optionsValue);
+                                } else {
+                                    node.warn('Options value is not valid JSON, ignore: '+node.config.optionsValue);
+                                }
+                                break;
+
+                            default:
+                                optionsToSend[node.config.optionsType] = node.config.optionsValue;
+                                break;
+                        }
+
+                        //apply options
+                        if (Object.keys(optionsToSend).length) {
+                            node.server.setDeviceOptions(device.friendly_name, optionsToSend);
+                        }
+
+                        //empty payload, stop
+                        if (payload === null) {
+                            return false;
+                        }
+
+                        if (payload !== undefined) {
+                            var toSend = {};
+                            var text = '';
+                            if (typeof(payload) == 'object') {
+                                toSend = payload;
+                                text = 'json';
+                            } else {
+                                toSend[command] = payload;
+                                text = command+': '+payload;
+                            }
+
+                            node.log('Published to mqtt topic: ' + node.server.getTopic('/'+device.friendly_name + '/set') + ' : ' + JSON.stringify(toSend));
+                            node.server.mqtt.publish(node.server.getTopic('/'+device.friendly_name + '/set'), JSON.stringify(toSend),
+                                {'qos':parseInt(node.server.config.mqtt_qos||0)},
+                                function(err) {
+                                    if (err) {
+                                        node.error(err);
+                                    }
+                            });
+
+                            let fill = node.server.getDeviceAvailabilityColor(node.server.getTopic('/'+device.friendly_name));
+                            node.status({
+                                fill: fill,
+                                shape: "dot",
+                                text: text
+                            });
+                            let time = Zigbee2mqttHelper.statusUpdatedAt();
+                            node.cleanTimer = setTimeout(function(){
+                                node.status({
+                                    fill: fill,
+                                    shape: "ring",
+                                    text: text + ' ' + time
+                                });
+                            }, 3000);
+                        } else {
+                            node.status({
+                                fill: "red",
+                                shape: "dot",
+                                text: "@evilbunny/node-red-contrib-zigbee2mqtt/out:status.no_payload"
+                            });
+                        }
+                    } else {
+                        node.status({
+                            fill: "red",
+                            shape: "dot",
+                            text: "@evilbunny/node-red-contrib-zigbee2mqtt/out:status.no_device"
+                        });
+                    }
+                });
+
+            } else {
+                node.status({
+                    fill: "red",
+                    shape: "dot",
+                    text: "@evilbunny/node-red-contrib-zigbee2mqtt/out:status.no_server"
+                });
+            }
+        }
+
+        fromHomeKitFormat(message, device) {
+            if ("hap" in message && message.hap.context === undefined) {
+                return null;
+            }
+
+            var payload = message['payload'];
+            var msg = {};
+
+            if (payload.On !== undefined) {
+                if ("current_values" in device) {
+                    // if ("brightness" in device.current_values) msg['brightness'] = device.current_values.brightness;
+                }
+                msg['state'] = payload.On?"on":"off";
+            }
+            if (payload.Brightness !== undefined) {
+                msg['brightness'] =  Zigbee2mqttHelper.convertRange(payload.Brightness, [0,100], [0,255]);
+                device.current_values.brightness = msg['brightness'];
+                if ("current_values" in device) {
+                    if ("current_values" in device) device.current_values.brightness = msg['brightness'];
+                }
+                if (payload.Brightness >= 254) payload.Brightness = 255;
+                msg['state'] = payload.Brightness > 0?"on":"off"
+            }
+            if (payload.Hue !== undefined) {
+                msg['color'] = {"hue":payload.Hue};
+                device.current_values.color.hue = payload.Hue;
+                if ("current_values" in device) {
+                    if ("brightness" in device.current_values) msg['brightness'] = device.current_values.brightness;
+                    if ("color" in device.current_values && "saturation" in device.current_values.color) msg['color']['saturation'] = device.current_values.color.saturation;
+                    if ("color" in device.current_values && "hue" in device.current_values.color) device.current_values.color.hue = payload.Hue;
+                }
+                msg['state'] = "on";
+            }
+            if (payload.Saturation !== undefined) {
+                msg['color'] = {"saturation":payload.Saturation};
+                device.current_values.color.saturation = payload.Saturation;
+                if ("current_values" in device) {
+                    if ("brightness" in device.current_values) msg['brightness'] = device.current_values.brightness;
+                    if ("color" in device.current_values && "hue" in device.current_values.color) msg['color']['hue'] = device.current_values.color.hue;
+                    if ("color" in device.current_values && "saturation" in device.current_values.color) msg['color']['saturation'] = payload.Saturation;
+                }
+                msg['state'] = "on";
+            }
+            if (payload.ColorTemperature !== undefined) {
+                msg['color_temp'] = Zigbee2mqttHelper.convertRange(payload.ColorTemperature, [150,500], [150,500]);
+                device.current_values.color_temp = msg['color_temp'];
+                if ("current_values" in device) {
+                    if ("color_temp" in device.current_values)  device.current_values.color_temp = msg['color_temp'];
+                }
+                msg['state'] = "on";
+            }
+            if (payload.LockTargetState !== undefined) {
+                msg['state'] = payload.LockTargetState?"LOCK":"UNLOCK";
+            }
+            if (payload.TargetPosition !== undefined) {
+                msg['position'] = payload.TargetPosition;
+            }
+
+            return msg;
+        }
+    }
+
+
+    RED.nodes.registerType('zigbee2mqtt-eb-out', Zigbee2mqttNodeOut);
+};
+
+
+
+
+
+