77-openhab2.html

<!--

  openHAB nodes for IBM's Node-Red
  https://github.com/pdmangel/node-red-contrib-openhab2
  (c) 2017, Peter De Mangelaere <peter.demangelaere@gmail.com>

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

-->
<script type="text/x-red" data-template-name="openhab2-controller">
    <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" placeholder="Name">
    </div>
    <div class="form-row">
        <label for="node-config-input-protocol"><i class="fa fa-unlock-alt"></i> Protocol</label>
    	<select id="node-config-input-protocol" name="node-config-input-protocol" style="width: 250px;">
			<option value="http">http</option>
			<option value="https">https</option>
    	</select>
    </div>
    <div class="form-row">
        <label for="node-config-input-host"><i class="fa fa-globe"></i> Host</label>
        <input type="text" id="node-config-input-host">
    </div>
    <div class="form-row">
        <label for="node-config-input-port"><i class="icon-bookmark"></i> Port</label>
        <input type="text" id="node-config-input-port">
    </div>
    <div class="form-row">
        <label for="node-config-input-path"><i class="fa fa-chevron-right"></i> Path</label>
        <input type="text" id="node-config-input-path">
    </div>
    <div class="form-row">
        <label for="node-config-input-username"><i class="fa fa-user"></i> Username</label>
        <input type="text" id="node-config-input-username">
    </div>
    <div class="form-row">
        <label for="node-config-input-password"><i class="fa fa-user-secret"></i> Password</label>
        <input type="password" id="node-config-input-password">
    </div>

</script>

<script type="text/x-red" data-template-name="openhab2-in">
    <style type="text/css">
        .btn-group {
            width: 70%;
        }
        .multiselect {
            width: 100%;
        }
        .form-row input.multiselect-search {
            width: 100%;
        }
        .multiselect-clear-filter {
            display: none;
        }
        .dropdown-menu {
            width: 100% !important;
        }
        .multiselect-container input[type="checkbox"] {
            display: none;
        }
        .multiselect-container > li > a > label.radio {
            margin: 5px;
            width: 90%;
            height: 100%;
            cursor: pointer;
            font-weight: 400;
            padding: 3px 20px 3px 20px;
        }
        .multiselect-container label.radio input[type="radio"] {
            display: none;
        }
    </style>
    <link rel="stylesheet" href="static/css/bootstrap-multiselect.css" type="text/css" />
    <div class="form-row">
        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
        <input type="text" id="node-input-name" placeholder="Name">
    </div>
    <div class="form-row">
        <label for="node-input-controller"><i class="fa fa-globe"></i> Controller</label>
        <input type="text" id="node-input-controller">
    </div>
    <div class="form-row">
        <label for="node-input-itemname"><i class="fa fa-crosshairs"></i> ItemName</label>
    	<select id="node-input-itemname" name="node-input-itemname">
    	</select>
    </div>
</script>

<script type="text/x-red" data-template-name="openhab2-get">
    <style type="text/css">
        .btn-group {
            width: 70%;
        }
        .multiselect {
            width: 100%;
        }
        .form-row input.multiselect-search {
            width: 100%;
        }
        .multiselect-clear-filter {
            display: none;
        }
        .dropdown-menu {
            width: 100% !important;
        }
        .multiselect-container input[type="checkbox"] {
            display: none;
        }
        .multiselect-container > li > a > label.radio {
            margin: 5px;
            width: 90%;
            height: 100%;
            cursor: pointer;
            font-weight: 400;
            padding: 3px 20px 3px 20px;
        }
        .multiselect-container label.radio input[type="radio"] {
            display: none;
        }
    </style>
    <link rel="stylesheet" href="static/css/bootstrap-multiselect.css" type="text/css" />
    <div class="form-row">
        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
        <input type="text" id="node-input-name" placeholder="Name">
    </div>
    <div class="form-row">
        <label for="node-input-controller"><i class="fa fa-globe"></i> Controller</label>
        <input type="text" id="node-input-controller">
    </div>
    <div class="form-row">
        <label for="node-input-itemname"><i class="fa fa-crosshairs"></i> ItemName</label>
    	<select id="node-input-itemname" name="node-input-itemname">
        </select>
    </div>
</script>

<script type="text/x-red" data-template-name="openhab2-monitor">
    <div class="form-row">
        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
        <input type="text" id="node-input-name" placeholder="Name">
    </div>
    <div class="form-row">
        <label for="node-input-controller"><i class="fa fa-globe"></i> Controller</label>
        <input type="text" id="node-input-controller">
    </div>
</script>

<script type="text/x-red" data-template-name="openhab2-out">
    <style type="text/css">
        .btn-group {
            width: 70%;
        }
        .multiselect {
            width: 100%;
        }
        .form-row input.multiselect-search {
            width: 100%;
        }
        .multiselect-clear-filter {
            display: none;
        }
        .dropdown-menu {
            width: 100% !important;
        }
        .multiselect-container input[type="checkbox"] {
            display: none;
        }
        .multiselect-container > li > a > label.radio {
            margin: 5px;
            width: 90%;
            height: 100%;
            cursor: pointer;
            font-weight: 400;
            padding: 3px 20px 3px 20px;
        }
        .multiselect-container label.radio input[type="radio"] {
            display: none;
        }
    </style>
    <link rel="stylesheet" href="static/css/bootstrap-multiselect.css" type="text/css" />
    <div class="form-row">
        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
        <input type="text" id="node-input-name" placeholder="Name">
    </div>
    <div class="form-row">
        <label for="node-input-controller"><i class="fa fa-globe"></i> Controller</label>
        <input type="text" id="node-input-controller">
    </div>
    <div class="form-row">
        <label for="node-input-itemname"><i class="fa fa-crosshairs"></i> ItemName</label>
    	<select id="node-input-itemname" name="node-input-itemname">
    	</select>
    </div>
    <div class="form-row">
        <label for="node-input-topic"><i class="fa fa-tasks"></i> Topic</label>
    	<select id="node-input-topic" name="node-input-topic" style="width: 250px;">
			<option value=""></option>
			<option value="ItemCommand">ItemCommand</option>
			<option value="ItemUpdate">ItemUpdate</option>
    	</select>
    </div>
    <div class="form-row">
        <label for="node-input-payload"><i class="fa fa-envelope"></i> Payload</label>
        <input type="text" id="node-input-payload" placeholder="Payload">
    </div>
</script>

<script type="text/x-red" data-template-name="openhab2-events">
    <div class="form-row">
        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
        <input type="text" id="node-input-name" placeholder="Name">
    </div>
    <div class="form-row">
        <label for="node-input-controller"><i class="fa fa-globe"></i> Controller</label>
        <input type="text" id="node-input-controller">
    </div>
</script>

<script type="text/x-red" data-help-name="openhab2-controller">
    <p>Configuration node for communication with an openHAB controller.</p>
	<p></p>
	<b>Configuration</b>
    <ul>
        <li><b>Name :</b> Specify a name for the configuration node</li>
        <li><b>Protocol :</b> "http" or "https"</li>
        <li><b>Host :</b> Specify the hostname or ip address</li>
        <li><b>Port :</b> (Optionally) Specify the ip port</li>
        <li><b>Path :</b> (Optionally) Specify the additional base path</li>
        <li><b>Username :</b> (Optionally) Specify the username to authenticate</li>
        <li><b>Password :</b> (Optionally) Specify the password to authenticate</li>
   	 </ul>
</script>

<script type="text/x-red" data-help-name="openhab2-in">
    <p>Listens to state changes of a selected openHAB Item.</p>
	<p></p>
	<b>Configuration</b>
    <ul>
        <li><b>Name :</b> Optionally specify a name</li>
        <li><b>Controller :</b> Select the openHAB controller</li>
        <li><b>Item :</b>Select the Item to monitor</li>
   	 </ul>
	<p></p>

	<b>Messages injected in NodeRED flows (2 channels)</b>
    <ul>
        <li>Channel 1 :
			<ul>
        		<li><code>msg.item</code> : the item's itemname (not label)</li>
        		<li><code>msg.topic</code> : "StateEvent"</li>
        		<li><code>msg.payload</code> : the new state of the selected item</li>
  	 		</ul>
		</li>
        <li>Channel 2 :
			<ul>
        		<li><code>msg.item</code> : the item's itemname (not label)</li>
        		<li><code>msg.topic</code> : "RawEvent"</li>
        		<li><code>msg.payload</code> : raw (unprocessed) event for the selected item</li>
  	 		</ul>
		</li>

   	 </ul>
</script>

<script type="text/x-red" data-help-name="openhab2-get">
    <p>Gets an openHAB Item on an input message.</p>
	<p></p>
	<b>Configuration</b>
    <ul>
        <li><b>Name :</b> Optionally specify a name</li>
        <li><b>Controller :</b> Select the openHAB controller</li>
        <li><b>Item :</b> Optionally select the Item to address. If specified, it overrides the item specified in the incoming message.</li>
   	 </ul>
	<p></p>

	<b>Messages injected in NodeRED flows (1 channel)</b>
	The input message with addition of :
    <ul>
        <li><code>msg.payload</code> : the item object (name, label, state, ...)</li>
         <li><code>msg.payload_in</code> : copy of incoming message's payload</li>
  	</ul>
</script>

<script type="text/x-red" data-help-name="openhab2-monitor">
    <p>Monitors the openhab2-controller node.</p>
	<p></p>
	<b>Configuration</b>
    <ul>
        <li><b>Name :</b> Optionally specify a name</li>
        <li><b>Controller :</b> Select the openHAB controller</li>
   	 </ul>
	<p></p>
	<b>Messages accepted by NodeRED flows</b>
    <ul>
        <li><code>msg.item</code> optionally the Item to address</li>
   	</ul>

	<b>Messages injected in NodeRED flows (3 channels)</b>

    <ul>
        <li>Channel 1 :
			<ul>
        		<li><code>msg.topic</code> : "ConnectionStatus"</li>
        		<li><code>msg.payload</code> : connection status ('ON' or 'OFF')</li>
  	 		</ul>
		</li>
        <li>Channel 2 :
			<ul>
        		<li><code>msg.topic</code> : "ConnectionError"</li>
        		<li><code>msg.payload</code> : error message</li>
  	 		</ul>
		</li>
        <li>Channel 3 :
			<ul>
        		<li><code>msg.topic</code> : "RawEvent"</li>
        		<li><code>msg.payload</code> : raw (unprocessed) event for all items</li>
  	 		</ul>
		</li>

   	 </ul>

</script>


<script type="text/x-red" data-help-name="openhab2-out">
    <p>Sends commands or state updates to a selected openHAB Item.</p>
    <p>E.g. "ON", "OFF", "REFRESH", ... </p>
	<p></p>
	<b>Configuration</b>
    <ul>
        <li><b>Name :</b> Optionally specify a name</li>
        <li><b>Controller :</b> Select the openHAB controller</li>
        <li><b>Item :</b> Optionally select the Item to address. If specified, it overrides the item specified in the incoming message.</li>
        <li><b>Topic :</b> Optionally select "ItemCommand" or "ItemUpdate". If specified, it overrides the topic specified in the incoming message.</li>
        <li><b>Payload :</b> Optionally specify the command or update value to send to the selected item. If specified, it overrides the value specified in the incoming message.</li>
   	 </ul>
	<p></p>
	<b>Messages accepted by NodeRED flows</b>
    <ul>
        <li><code>msg.item</code> optionally the Item to address</li>
        <li><code>msg.topic</code> optionally "ItemCommand", "ItemUpdate"</li>
        <li><code>msg.payload</code> optionally the fixed command or update value to send to the selected item</li>
   	 </ul>

	<b>Messages injected in NodeRED flows (1 channels)</b>

    <ul>
        <li>Channel 1 : if successful, the input message is copied to this channel
		</li>

</script>

<script type="text/x-red" data-help-name="openhab2-events">
    <p>Watches the event bus.</p>
	<p></p>
	<b>Configuration</b>
    <ul>
        <li><b>Name :</b> Optionally specify a name</li>
        <li><b>Controller :</b> Select the openHAB controller</li>
   	 </ul>
	<p></p>
</script>


<script type="text/javascript">
	RED.nodes.registerType('openhab2-controller', {
		category: 'config',
		defaults: {
			name: {value:"",required:true},
			protocol: {value:"http",required:true},
			host: {value:"localhost",required:true},
			port: {value:8080,	required:false /*,	validate:RED.validators.number() */},
			path: {value:"",	required:false},
		    username: {value:"", required:false},
		    password:  {value:"", required:false}
        },
        paletteLabel: "openhab2-controller",
		label: function() {
			return this.name;
		}
	});
</script>


<script type="text/javascript">
	// some code chared by openhab2-in and openhab2-out

	function openhabEditPrepare(node, allowEmpty) {

    	function updateOpenhabItemSelection(cntrlConfig, itemName) {

    		var itemSelectionEl = $('#node-input-itemname');

            itemSelectionEl.multiselect({
                enableFiltering: true,
                enableCaseInsensitiveFiltering: true,
                maxHeight: 300,
                disableIfEmpty: true,
                nonSelectedText: 'Select item...',
                disabledText: 'No items found...'
            });

            if ( cntrlConfig ) {
            	var config = {
           			name: cntrlConfig.name,
           			protocol: cntrlConfig.protocol,
           			host: cntrlConfig.host,
           			port: cntrlConfig.port,
           			path: cntrlConfig.path,
           			username: cntrlConfig.username,
           			password: cntrlConfig.password
            	}
            	console.log("config = " + JSON.stringify(config));
                $.getJSON("openhab2/items", config)
                  .done( function(data) {

                	 itemSelectionEl.children().remove();
                     var items = data;

                     items.sort(function(a,b) {
                    	 if ( a.name < b.name )
                    		 return -1;
                    	 else if ( a.name > b.name )
                    		 return 1;
                    	 else
                    		 return 0;
                     });
                        if (allowEmpty)
                            itemSelectionEl.append('<option value="">[No item]</option>');
                        items.forEach(function (item) {
                    	 itemSelectionEl.append('<option>' + item.name + '</option>');
 							var it = itemSelectionEl.find('option').last();
 							it.attr('value', item.name);
                    		});
                     itemSelectionEl.val(itemName);
                        itemSelectionEl.multiselect('rebuild');
                  })
                  .fail(function(e1, e2, e3) {
                      //itemSelectionEl.append('<option value="' + 1 + '">' + e1 + '</option>');
                      //itemSelectionEl.append('<option value="' + 2 + '">' + e2 + '</option>');
                      //itemSelectionEl.append('<option value="' + 3 + '">' + e3 + '</option>');
                    console.log("error : " + JSON.stringify(e1));
                  });
            }
		}

    	updateOpenhabItemSelection(RED.nodes.node(node.controller), node.itemname);

		$('#node-input-controller').change(function(ev) {
	        updateOpenhabItemSelection(RED.nodes.node($('#node-input-controller').val()), $('#node-input-').val() || node.itemname);
		});


	}
</script>

<script type="text/javascript">
    $.getScript('static/js/bootstrap-multiselect.js');
    RED.nodes.registerType('openhab2-in', {
        category: 'home automation',
        color: '#00cc00',
        defaults: {
            name:      {value:""},
		    controller:  {value:"", type:"openhab2-controller", required:true},
		    itemname:  {value:"", required:true},
        },
        inputs: 0,
        outputs: 2,
        icon: "node-red-contrib-openhab2.png",
        paletteLabel: "openhab2-in",
        label: function() {

            return(this.name||this.itemname||"openhab2 in");
        },
        oneditprepare: function() {
        	openhabEditPrepare(this, false);
        }
    });
</script>

<script type="text/javascript">
    RED.nodes.registerType('openhab2-get',{
        category: 'home automation',
        color: '#00cc00',
        defaults: {
            name:      {value:""},
		    controller:  {value:"", type:"openhab2-controller", required:true},
		    itemname:  {value:"", required:false},
        },
        inputs: 1,
        outputs: 1,
        icon: "node-red-contrib-openhab2.png",
        paletteLabel: "openhab2-get",
        label: function() {

            return(this.name||this.itemname||"openhab2 get");
        },
        oneditprepare: function() {
        	openhabEditPrepare(this, true);
        }
    });
</script>

<script type="text/javascript">
    RED.nodes.registerType('openhab2-monitor',{
        category: 'home automation',
        color: '#00cc00',
        defaults: {
            name:      {value:""},
		    controller:  {value:"", type:"openhab2-controller", required:true}
        },
        inputs: 0,
        outputs: 3,
        icon: "node-red-contrib-openhab2.png",
        paletteLabel: "openhab2-monitor",
        label: function() {

            return(this.name||"openhab2 monitor");
        },
        oneditprepare: function() {
        }
    });
</script>

<script type="text/javascript">
    RED.nodes.registerType('openhab2-out',{
        category: 'home automation',
        color: '#00cc00',
        defaults: {
            name:      {value:""},
		    controller:  {value:"", type:"openhab2-controller", required:true},
		    itemname:  {value:"", required:false},
		    topic: {value:"", required:false},
		    payload:  {value:"", required:false}
		},
        inputs: 1,
        outputs: 1,
        icon: "node-red-contrib-openhab2.png",
        paletteLabel: "openhab2-out",
        label: function() {
            return(this.name||this.itemname||"openhab2 out");
        },
        oneditprepare: function() {
        	openhabEditPrepare(this, true);
        }
    });
</script>

<script type="text/javascript">
    RED.nodes.registerType('openhab2-events',{
        category: 'home automation',
        color: '#0fdd0f',
        defaults: {
            name:      {value:""},
		    controller:  {value:"", type:"openhab2-controller", required:true},
		    itemname:  {value:"", required:false},
        },
        inputs: 0,
        outputs: 1,
        icon: "node-red-contrib-openhab2.png",
        paletteLabel: "openhab2-events",
        label: function() {

            return(this.name||this.itemname||"openhab2 events");
        },
        oneditprepare: function() {
        	//openhabEditPrepare(this, true);
        }
    });
</script>