blind.html

<script type="text/javascript">
    RED.nodes.registerType('blind-output',{
        category: 'hapcan',
        color: '#C1C1C1',
        defaults: {
            gateway: {type:"hapcan-gateway", required: true},
            name: {value:""},
            group: {value: 1, required: true, validate: function(val){return (val > 0 && val < 256);} },
            node: {value: 1, required: true, validate: function(val){return (val > 0 && val < 256);}},
            channel: {value: 1, required: true,validate: function(val){return (val >= 0 && val <= 7);}},
            defaultAction: {value: 0x02, required: true, validate: function(val) {return (val>=-1 && val <=0x05)}}
        },
        inputs:1,
        outputs:0,
        icon: "relay-output.png",
        align: 'right',
        label: function() {
            var selectedChannels="";
            for(var i = 0; i < 3; i++)
            {
                if((this.channel & (1<<i)) !== 0)
                    selectedChannels += (selectedChannels===''?'':',')+(i+1);
            }
            if(selectedChannels === '')
                selectedChannels = '-';
            return (this.name||"blind output") + ' ('+this.node+','+this.group+') ['+selectedChannels+']';
        },
        labelStyle: function() { return this.name?"node_label_italic":""; } ,
        inputLabels: "blind control message",
        oneditprepare: async function() {
            let config = this
            var nodeOptions = '';
            var groupOptions = '';
            var devicesOptions = null
            
            var gatewaySelect = $('#node-input-gateway')
            var devicesSelect = $("#node-input-devices")
            var nodeSelect =  $("#node-input-node")
            var groupSelect =  $("#node-input-group")
            var currentDevice = null
                
            var deviceList = []
            gatewaySelect.change(function()
            {
                devicesOptions = ''
                var selectedGatewayId = gatewaySelect.children('option[selected]').first().val()
                if(selectedGatewayId == null)
                    selectedGatewayId = gatewaySelect.children("option").first().val()
                var gateway = RED.nodes.node(selectedGatewayId)
                if(gateway != null )
                {
                    deviceList = gateway.devices.filter((d) => d.applicationType === 7)
                    deviceList.forEach( (device) => {
                        var selected = '';
                        if(Number(config.node) === device.node && Number(config.group) === device.group)
                        {
                            selected = 'selected="selected"'
                            currentDevice = device
                        }
                        devicesOptions += `<option ${selected} value="${device.id}">${device.description} (${device.node},${device.group})</option>`
                    })
                }
                devicesOptions += `<option ${currentDevice === null ? 'selected="selected"' : ''} value="0">(set node, group manually)</option>`

                devicesSelect.empty().append(devicesOptions).trigger('change')
            })
            
            devicesSelect.on('change', function() {
                
                if(Number(this.value) === 0)
                {
                    nodeSelect.removeAttr('disabled')
                    groupSelect.removeAttr('disabled')
                }
                currentDevice = deviceList.find(v=>v.id === this.value)
                
                if(currentDevice !== undefined) {
                    nodeSelect.find('option').removeProp('selected').filter(`[value=${currentDevice.node}]`).prop('selected', true).trigger('change')
                    groupSelect.find('option').removeProp('selected').filter(`[value=${currentDevice.group}]`).prop('selected', true).trigger('change')
                    nodeSelect.attr('disabled', 'disabled')
                    groupSelect.attr('disabled', 'disabled')
                }
            })
            
            for(var i = 1; i < 256; i++)
            {
                var selectedNode = '';
                if((Number(this.node) === i))
                    selectedNode = 'selected="selected"';
                nodeOptions += '<option '+ selectedNode +' value="'+i+'">'+i+'</option>';

                var selectedGroup = '';
                if((Number(this.group) === i))
                    selectedGroup = 'selected="selected"';
                
                groupOptions += '<option '+ selectedGroup +' value="'+i+'">'+i+'</option>';
            }
            
            nodeSelect.append(nodeOptions);
            groupSelect.append(groupOptions);

            if( this.channel & 1 !== 0 )
                $("#channel1").prop('checked', true);
            if( (this.channel & 2) !== 0 )
                $("#channel2").prop('checked', true);
            if( (this.channel & 4) !== 0 )
                $("#channel3").prop('checked', true);
        },
        oneditsave: function(){
            this.channel = 0;
            this.channel |= $("#channel1").is(":checked") ? 1 : 0;
            this.channel |= $("#channel2").is(":checked") ? 2 : 0;
            this.channel |= $("#channel3").is(":checked") ? 4 : 0;
        }
        });

    function validateNodeGroup(val0)
    {
        return (val > 0 && val < 256);
    }
</script>

<script type="text/x-red" data-template-name="blind-output">
    <div class="form-row">
        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
        <input type="text" id="node-input-name" placeholder="Device name">
    </div>
    <div class="form-row">
        <label for="node-input-gateway"><i class="fa fa-globe"></i> Gateway</label>
        <input type="text" id="node-input-gateway" placeholder="Gateway">
    </div>
    <div class="form-row">
        <label for="node-input-devices"><i class="fa fa-microchip"></i> Device</label>
        <select id="node-input-devices"></select>
    </div>    
    <div class="form-row">
        <label for="node-input-node"><i class="fa fa-cube"></i> Node</label>
        <select id="node-input-node"></select>
    </div>
    <div class="form-row">
        <label for="node-input-group"><i class="fa fa-cubes"></i> Group</label>
        <select id="node-input-group"></select>
    </div>
    <div class="form-row">
        <label for="node-input-defaultAction"><i class="fa fa-play"></i> Default action</label>
        <select id="node-input-defaultAction">
                <option value="-1">Do nothing</option>
                <option value="0">Stop</option>
                <option value="1">Up/Stop</option>
                <option value="2">Down/Stop</option>
                <option value="3">Up</option>
                <option value="4">Down</option>
                <option selected="selected" value="5">Start</option>
        </select>
    </div>
    <div class="form-row">
            <label for="node-input-channel" style="width: 150px;"><i class="fa fa-sign-out"></i> Channels</label><br>
            <input style="width: 10%;" id="channel1" type="checkbox" value="1">1
            <input style="width: 10%;" id="channel2" type="checkbox" value="2">2
            <input style="width: 10%;" id="channel3" type="checkbox" value="4">3
    </div>
</script>

<script type="text/x-red" data-help-name="blind-output">
    <p>Allows controlling the Blind controller UNIV-3.7.X module.</p>
    <p>The node allows you to control blind controller. It uses the Ethernet gateway to communicate with Hapcan bus.</p>
    
    <h3>Inputs</h3>
    <dl class="message-properties">
        <dt>payload <span class="property-type">string | number | any | object</span></dt>
        <dd>Any input message will perform default action. If topic is set to <i>control</i> the payload will control the blind controller module.</dd>

        <dt class="optional">topic <span class="property-type">string</span></dt>
        <dd>Topic is optional. When a <i>control</i> value is provided it will overrides default action settings and allows controlling of the node directly.</dd>
    </dl>
    
    <h3>Details</h3>
    <p>The default node behaviour on any input message is to execute the action specified in properties. 
        When <code>msg.topic</code> is set to <i>control</i> then input value will control node in several ways. In control mode the <code>msg.payload</code> 
        can be one of the following types:
    </p>
    <dl class="message-properties">
        <dt>string</dt> 
        <dd>Possible values are: STOP, UP/DOWN, DOWN/STOP, UP, DOWN, START - this values coresponds to the blind controller commands. Other strings are ignored. Case insensitive.</dd>

        <dt>number</dt> 
        <dd>Hapcan's Blind controller module instruction 0x01-0x05. Other values are ignored.</dd>

        <dt>object</dt> 
        <dd>Gives an ability to control whole Blind controller module by providing values. See details below.</dd>
        
    </dl>
    <h3>Full control object definition</h3>
    <p>
        Passing the <i>object</i> (JSON) in <code>msg.payload</code> allows to control whole blind controller module. Below are the possible properties list that can be specified. 
        If no property is specified the default node settings values will be used. Node will throw an error in case of invalid values.
    </p>
    <dl class="message-properties">
        <dt>channels <span class="property-type">number | array</span></dt> 
        <dd>Single number value or number array of selected channels to perform the action (1-3).</dd>

        <dt>action <span class="property-type">string | number </span></dt></dt> 
        <dd>String or number action representation. See <code>msg.payload</code> description above for details.</dd>
    </dl>

    <h3>References</h3>
    <ul>
        <li><a href="http://hapcan.com/devices/universal/univ_3/univ_3-7-0-x/index.htm">Hapcan blind controller</a> - module firmware notes.</li>
    </ul>
</script>


<script type="text/javascript">
    RED.nodes.registerType('blind-input',{
        category: 'hapcan',
        color: '#D3D3D3',
        defaults: {
            gateway: {type:"hapcan-gateway", required: true},
            name: {value:""},
            group: {value: 1, required: true, validate: function(val){return (val >= 0 && val < 256);} },
            node: {value: 1, required: true, validate: function(val){return (val >= 0 && val < 256);}},
            channelFilter: {value: 1, required: true,validate: function(val){return (val > 0 && val <= 256);}},
        },
        inputs:0,
        outputs:1,
        icon: "relay-output.png",
        align: 'left',
        label: function() {
            return `${this.name||"blind input"} (${Number(this.node) === 0 ? 'any' : this.node}, ${Number(this.group) === 0 ? 'any' : this.group})`;
        },
        labelStyle: function() { return this.name?"node_label_italic":""; } ,
        oneditprepare: async function() {

            let config = this
            var nodeOptions = '';
            var groupOptions = '';
            var devicesOptions = null
           
            var gatewaySelect = $('#node-input-gateway')
            var devicesSelect = $("#node-input-devices")
            var nodeSelect =  $("#node-input-node")
            var groupSelect =  $("#node-input-group")
            var currentDevice = null
                
            var deviceList = []
            gatewaySelect.change(function()
            {
                devicesOptions = ''
                currentDevice = null
                var selectedGatewayId = gatewaySelect.children('option[selected]').first().val()
                if(selectedGatewayId == null)
                    selectedGatewayId = gatewaySelect.children("option").first().val()
                var gateway = RED.nodes.node(selectedGatewayId)
                if(gateway != null )
                {
                    deviceList = gateway.devices.filter((d) => d.applicationType === 7)
                    deviceList.forEach( (device) => {
                        var selected = '';
                        if(Number(config.node) === device.node && Number(config.group) === device.group)
                        {
                            selected = 'selected="selected"'
                            currentDevice = device
                        }
                        devicesOptions += `<option ${selected} value="${device.id}">${device.description} (${device.node},${device.group})</option>`
                    })
                }
                devicesOptions += `<option ${currentDevice === null ? 'selected="selected"' : ''} value="0">(set node, group manually)</option>`

                devicesSelect.empty().append(devicesOptions).trigger('change')
            })

            devicesSelect.on('change', function() {
                
                if(Number(this.value) === 0)
                {
                    nodeSelect.removeAttr('disabled')
                    groupSelect.removeAttr('disabled')
                }
                currentDevice = deviceList.find(v=>v.id === this.value)
                
                if(currentDevice !== undefined) {
                    nodeSelect.find('option').removeProp('selected').filter(`[value=${currentDevice.node}]`).prop('selected', true).trigger('change')
                    groupSelect.find('option').removeProp('selected').filter(`[value=${currentDevice.group}]`).prop('selected', true).trigger('change')
                    nodeSelect.attr('disabled', 'disabled')
                    groupSelect.attr('disabled', 'disabled')
                }
            })

            for(var i = 0; i < 256; i++)
            {
                var selectedNode = '';
                if((Number(this.node) === i))
                    selectedNode = 'selected="selected"';
                let text = i === 0? 'any' : i
                
                nodeOptions += `<option ${selectedNode} value="${i}">${text}</option>`

                var selectedGroup = '';
                if((Number(this.group) === i))
                    selectedGroup = 'selected="selected"';
                
                groupOptions += `<option ${selectedGroup} value="${i}">${text}</option>`
            }
            
            nodeSelect.append(nodeOptions);
            groupSelect.append(groupOptions);
            
            if( this.channelFilter & 1 !== 0 )
                $("#channel1").prop('checked', true);
            if( (this.channelFilter & 2) !== 0 )
                $("#channel2").prop('checked', true);
            if( (this.channelFilter & 4) !== 0 )
                $("#channel3").prop('checked', true);
        },
        oneditsave: function(){
            this.channelFilter = 0;
            this.channelFilter |= $("#channel1").is(":checked") ? 1 : 0;
            this.channelFilter |= $("#channel2").is(":checked") ? 2 : 0;
            this.channelFilter |= $("#channel3").is(":checked") ? 4 : 0;
        }
        });

</script>

<script type="text/x-red" data-template-name="blind-input">
    <div class="form-row">
        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
        <input type="text" id="node-input-name" placeholder="Device name">
    </div>
    <div class="form-row">
        <label for="node-input-gateway"><i class="fa fa-globe"></i> Gateway</label>
        <input type="text" id="node-input-gateway" placeholder="Gateway">
    </div>
    <div class="form-row">
        <label for="node-input-devices"><i class="fa fa-microchip"></i> Device</label>
        <select id="node-input-devices"></select>
    </div>    
    <div class="form-row">
        <label for="node-input-node"><i class="fa fa-cube"></i> Node</label>
        <select id="node-input-node"></select>
    </div>
    <div class="form-row">
        <label for="node-input-group"><i class="fa fa-cubes"></i> Group</label>
        <select id="node-input-group"></select>
    </div>
    <div class="form-row">
        <label for="node-input-channel" style="width: 150px;"><i class="fa fa-sign-out"></i> Channel filter</label><br>
        <input style="width: 10%;" id="channel1" type="checkbox" value="1">1 
        <input style="width: 10%;" id="channel2" type="checkbox" value="2">2
        <input style="width: 10%;" id="channel3" type="checkbox" value="4">3
    </div>
</script>

<script type="text/x-red" data-help-name="blind-input">
    <p>Receives Hapcan BLIND controller UNIV-3.7.X status messages.</p>
    <p>The node emit blind controller status messages. It uses the Ethernet gateway to receive messages from Hapcan bus.</p>
    
    <h3>Output</h3>
    <dl class="message-properties">
        <dt>payload <span class="property-type">object</span></dt>
        <dd>Hapcan message object with blind controller module's state data.</dd>

        <dt>topic <span class="property-type">string</span></dt>
        <dd>Contains <i>Blind message</i> string.</dd>
    </dl>
    
    <h3>Details</h3>
    <p>The <code>msg.payload</code> contains:
    </p>
    <dl class="message-properties">
        <dt>frame <span class="property-type">Buffer[15]</span></dt>
        <dd>15 bytes buffer containing raw Hapcan's CAN frame.</dd>

        <dt>frameType <span class="property-type">number</span></dt>
        <dd>Hapcan frame type number (decimal)</dd>

        <dt>isAnswer <span class="property-type">bool</span></dt>
        <dd><i>True</i> if message is an answer for request.</dd>
        
        <dt>node <span class="property-type">number</span></dt>
        <dd>Sender module node number.</dd>

        <dt>group <span class="property-type">number</span></dt>
        <dd>Sender module group number.</dd>

        <dt>status <span class="property-type">number</span></dt>
        <dd>Estimated blind status, 0 = blind opened, 255 = blind closed.</dd>

        <dt>statusPercent <span class="property-type">number</span></dt>
        <dd>Estimated blind status in percent value (0-100)</dd>
        
        <dt>move <span class="property-type">string</span></dt>
        <dd>Channel's current movement state. Possible values are: STOPPED, DOWN, UP</dd>

        <dt>channel <span class="property-type">number</span></dt>
        <dd>Blind channel number (1-3).</dd>

        <dt>channelName <span class="property-type">string</span></dt>
        <dd>Device's channel name that has changed.</dd>

        <dt>deviceName <span class="property-type">string</span></dt>
        <dd>Device's name that emits the message.</dd>
        
    </dl>
    <p>
        This node receives blind controller status messages of the selected module in group. The output is fired when channel filter matches the status message.
    </p>

    <h3>References</h3>
    <ul>
        <li><a href="http://hapcan.com/devices/universal/univ_3/univ_3-7-0-x/index.htm">Hapcan blind controller</a> - module firmware notes.</li>
    </ul>

</script>