dimmer.html

<script type="text/javascript">
    RED.nodes.registerType('dimmer-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);}},
            state: {value: 0xFF, required: true, validate: function(val) {return (val>=0 && val < 256)}},
            speed: {value: 0x00, required: true, validate: function(val) {return (val>=-1 && val <= 256)}},
            UNIV : {value: 3, required: true, validate: function(val) {return (val==1 || val == 3 || val==undefined)}}
        },
        inputs:1,
        outputs:0,
        icon: "relay-output.png",
        align: 'right',
        label: function() {
            return (this.name||"dimmer output") + ' ('+this.node+','+this.group+')';
        },
        labelStyle: function() { return this.name?"node_label_italic":""; } ,
        inputLabels: "dimmer 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 === 6)
                    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')
                }
            })

            var stateOptions = '';
            var speedOptions = '';
            for(var i = -1; i < 256; i++)
            {
                if(i>0)
                {
                    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>';
                }

                if(i >= 0)
                {
                    var selectedState = '';
                    if((Number(this.state) === i))
                        selectedState = 'selected="selected"';
                    stateOptions += '<option '+ selectedState +' value="'+i+'">'+i+'</option>';
                }
                var selectedSpeed = '';
                if((Number(this.speed) === i))
                    selectedSpeed = 'selected="selected"';
                var value = i;
                if( value === -1 )
                    value = "leave unchanged";
                else if( value === 0 )
                    value = "0 - instant switch";

                speedOptions += '<option '+ selectedSpeed +' value="'+i+'">'+value+'</option>';
            }
            
            nodeSelect.append(nodeOptions);
            groupSelect.append(groupOptions);
            $("#node-input-state").append(stateOptions);
            $("#node-input-speed").append(speedOptions);

            if(this.UNIV == undefined )
            {
                this.UNIV = 3;
                $('#node-input-UNIV').val(3);
            }            
        }
        });
</script>

<script type="text/x-red" data-template-name="dimmer-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-state"><i class="fa fa-dot-circle-o"></i> Default state</label>
        <select id="node-input-state"></select>
    </div>    
    <div class="form-row">
        <label for="node-input-speed"><i class="fa fa-clock-o"></i> Speed</label>
        <select id="node-input-speed"></select>
    </div>  
    
    <hr>
    <div class="form-row">
        <label for="node-input-UNIV"><i class="fa fa-cubes"></i> UNIV</label>
        <select id="node-input-UNIV">
                <option value="1">UNIV 1.0.6.X module</option>
                <option selected="selected" value="3">UNIV 3.6.X module</option>
        </select>
    </div>       
</script>

<script type="text/x-red" data-help-name="dimmer-output">
    <p>Allows controlling of the Hapcan dimmer UNIV-3.6.X and UNIV-1.0.6 modules.</p>
    <p>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 | bool | 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 dimmer 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 settings and allows controlling of the node directly.</dd>
    </dl>
    
    <h3>Details</h3>
    <p>The default node behaviour on any input message is to set state to the value with speed 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>Value of <i>ON</i>, <i>OFF</i>, <i>TOGGLE</i>, <i>STOP</i> will control the dimmer output. Case insensitive.
        </dd>

        <dt>number</dt> 
        <dd>Output will be set to the specified value (0-255).</dd>

        <dt>boolean</dt> 
        <dd>Output will be turn ON when value is true, otherwise it will turn OFF.</dd>

        <dt>object</dt> 
        <dd>Gives an ability to control whole dimmer module by providing values. See details below.</dd>
    </dl>
    <p>
        <b>Note</b>. Node will send different instructions to Hapcan module based on current parameter values.
        For example, if speed = 0 then output will switch to desired state instantly. Speed > 0 cause the node will send two frames, set dimming speed and set softly
        to state value. If string TOGGLE is passed, the node will send toggle or start command to the Hapcan module, based on speed value.
    </p>

    <h3>Full control object definition</h3>
    <p>
        Passing the <i>object</i> (JSON) in <code>msg.payload</code> allows to control whole dimmer 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>state <span class="property-type">string | number | bool</span></dt></dt> 
        <dd>String, number or bool state value. See <code>msg.payload</code> description above for details.</dd>

        <dt>speed <span class="property-type">number</span></dt></dt> 
        <dd>Dimming time in seconds (0-255s). The speed value affect final instruction that node will send to the Hapcan module.
            If speed = 0 the state will change instantly. Other values will change state softly. In UNIV 1.0.6 modules the speed can be set in
            predefined times from 1, 5, 10, 15...60s. The current speed value will be rounded to available speed values.
        </dd>
    </dl>

    <h3>References</h3>
    <ul>
        <li><a href="https://hapcan.com/devices/universal/univ_3/univ_3-6-0-x/index.htm">Hapcan Dimmer RC UNIV-3.6.X</a> - module firmware notes.</li>
        <li><a href="https://hapcan.com/devices/universal/univ_v1-0/univ_v1-0-6-0/index.htm">Hapcan Dimmer UNIV-1.0.6</a> - module firmware notes.</li>
    </ul>

</script>



<script type="text/javascript">
    RED.nodes.registerType('dimmer-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);}},
            userFieldStateON: {value: ""},
            userFieldStateOFF: {value: ""}
        },
        inputs:0,
        outputs:1,
        icon: "relay-output.png",
        align: 'left',
        label: function() {
            return `${this.name||"dimmer 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 === 6)
                    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);
            
        },
        oneditsave: function(){
        }
        });

</script>

<script type="text/x-red" data-template-name="dimmer-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>
    <hr>
    <div class="form-row">
        <label style="width: auto;"><i class="fa fa-envelope-o"></i> Set <b>userField</b> value for states:</label>
    </div>
    <div class="form-row">
        <label style="padding-left: 25px; margin-right: -25px;" for="node-input-userFieldStateON"><i class="fa fa-circle"></i> ON</label>
        <input type="text" id="node-input-userFieldStateON" >
    </div>
    <div class="form-row">
        <label style="padding-left: 25px; margin-right: -25px;" for="node-input-userFieldStateOFF"><i class="fa fa-circle"></i> OFF</label>
        <input type="text" id="node-input-userFieldStateOFF" >
    </div>
</script>

<script type="text/x-red" data-help-name="dimmer-input">
    <p>Receives Hapcan dimmer UNIV-3.6.X and UNIV-1.0.6 status messages.</p>
    <p>The node emits dimmer 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 dimmer module's state data.</dd>

        <dt>topic <span class="property-type">string</span></dt>
        <dd>Contains <i>Dimmer 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>Output value 0x00-0xFF.</dd>

        <dt>enabled <span class="property-type">bool</span></dt> 
        <dd><i>True</i> if dimmer output is turned on.</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>

        <dt>userField <span class="property-type">string</span></dt>
        <dd>User defined value for each state.</dd>
    </dl>

    <p>
        This node receives Dimmer status messages of the selected module in group.
    </p>

    <h3>References</h3>
    <ul>
        <li><a href="https://hapcan.com/devices/universal/univ_3/univ_3-6-0-x/index.htm">Hapcan Dimmer RC UNIV-3.6.X</a> - module firmware notes.</li>
        <li><a href="https://hapcan.com/devices/universal/univ_v1-0/univ_v1-0-6-0/index.htm">Hapcan Dimmer UNIV-1.0.6</a> - module firmware notes.</li>
    </ul>

</script>