iobroker.node-red/nodes/ioBroker.html

<!--
  Copyright 2013-2020 bluefox <dogafox@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.
-->

<link rel="stylesheet" type="text/css" href="vendor/ui.fancytree.min.css"/>
<style type="text/css">
    #dialog-select-member select{
        height: 24px !important;
        line-height: 24px !important;
    }
</style>
<script type="text/javascript" src="vendor/jquery.fancytree-all.min.js"></script>

<script type="text/javascript" src="selectID.js"></script>

<script type="text/javascript">
    function initSelectId(allowAll, onChange) {
        if (!window.__iobroker) {
            $.getJSON('iobroker.json', function (data) {
                window.__iobroker = data;
                $('#dialog-select-member').selectId('init', {
                    objects: window.__iobroker,
                    noMultiselect: true,
                    allowSelectionOfNonExistingObjects: !!allowAll,
                    columns: ['name', 'role', 'enum', 'room'],
                    states:  null,
                    noImg:   true
                });
            });
        } else {
            $('#dialog-select-member').selectId('init', {
                objects: window.__iobroker,
                noMultiselect: true,
                allowSelectionOfNonExistingObjects: !!allowAll,
                columns: ['name', 'role', 'enum', 'room'],
                states:  null,
                noImg:   true
            });
        }

        $('#node-input-topic-button').button({
            icons: {primary: 'ui-icon-folder-open'},
            text:  false
        }).click(function () {
            $('#dialog-select-member').selectId('show', $('#node-input-topic').val(), undefined, function (newId, oldId) {
                var oldObj = $('#dialog-select-member').selectId('getInfo', oldId);
                var newObj = $('#dialog-select-member').selectId('getInfo', newId);
                $('#node-input-topic').val(newId);

                if (newObj) {
                    var oldName = $('#node-input-name').val();
                    if (!oldName || !oldObj || (oldObj.common && oldName === oldObj.common.name && newObj.common)) {
                        $('#node-input-name').val(newObj.common.name);
                    }
                }
                if (typeof onChange === 'function') {
                    onChange(newId, oldId, newObj, oldObj);
                }
            });
        });
    }
</script>

<script type="text/x-red" data-template-name="ioBroker in">
    <div class="form-row">
        <label for="node-input-topic"><i class="fa fa-tasks"></i> Topic</label>
        <input type="text" id="node-input-topic" placeholder="Topic" style="width:60%"><input type="button" id="node-input-topic-button" style="display:inline-block;width:10%" value="..."/>
    </div>
    <div id="dialog-select-member" style="display:none"></div>
    <div class="form-row">
        <label for="node-input-payloadType"><i class="fa fa-envelope"></i> Payload</label>
        <select id="node-input-payloadType" style="width:125px !important">
          <option value="value">value</option>
          <option value="object">object</option>
        </select>
    </div>
    <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>&nbsp;</label>
        <input type="checkbox" id="node-input-onlyack" style="display: inline-block; width: auto; vertical-align: top;">
        <label for="node-input-onlyack" style="width: 70%;">Send only on then ack==true</label>
    </div>
    <div class="form-row">
        <label for="node-input-func"><i class="fa fa-wrench"></i> Mode</label>
        <select type="text" id="node-input-func" style="width:74%;">
			<option value="all">Send all events</option>
            <option value="rbe">block unless value changes</option>
            <option value="deadband">block unless changes by more than</option>
		</select>
    </div>
    <div class="form-row" id="node-bandgap">
        <label for="node-input-gap">&nbsp;</label>
        <input type="text" id="node-input-gap" placeholder="e.g. 10 or 5%" style="width:71%;">
    </div>
    <div class="form-row">
        <label for="node-input-fireOnStart"><i class="fa fa-arrow-up"></i> Fire by start</label>
        <select id="node-input-fireOnStart" style="width:73% !important">
            <option value="true">send message at start</option>
            <option value="false">send no message at start</option>
        </select>
    </div>
</script>

<script type="text/x-red" data-help-name="ioBroker in">
    <p>ioBroker input node. Connects to a ioBroker and subscribes to the specified topic. The topic may contain redis wildcards (*).</p>
    <p>Outputs an object called <b>msg</b> containing <b>msg.topic, msg.payload, msg.timestamp, msg.lastchange and msg.acknowledged.</p>
	<p>The checkbox determines whether only States with ack == true or all events are forwarded.</p>
	<p>The select box Mode offers further filtering options. The options are the same as for the RBE node.</p>
</script>

<script type="text/javascript">
    RED.nodes.registerType('ioBroker in', {
        category: 'ioBroker',
        defaults: {
            name: {value: ''},
            topic: {value: '*', required: true},
            payloadType: {value: 'value'},
			onlyack: {value: ''},
            func: {value: 'all'},
            gap: {value: '', validate: RED.validators.regex(/^(\d*[.]*\d*|)(%|)$/)},
            fireOnStart: {value: 'false'}
        },
        color: '#a8bfd8',
        inputs: 0,
        outputs: 1,
        icon: 'ioBroker.png',
        label: function () {
            return this.name || this.topic || 'IoB subscribe';
        },
        labelStyle: function () {
            return this.name ? 'node_label_italic' : '';
        },
        oneditprepare: function () {
            initSelectId();

            $('#node-input-func').on('change', function () {
                var val = $('#node-input-func').val();
                if (val === null || val === 'null') {
                    $('#node-input-func').val ('all');
                }
                if (val === 'deadband') {
                    $('#node-bandgap').show();
                } else {
                    $('#node-bandgap').hide();
                }
            });
        }
    });
</script>

<script type="text/x-red" data-template-name="ioBroker out">
    <div class="form-row">
        <label for="node-input-topic"><i class="fa fa-tasks"></i> Topic</label>
        <input type="text" id="node-input-topic" placeholder="Topic" style="width:60%"><input type="button" id="node-input-topic-button" style="display:inline-block;width:10%" value="..."/>
    </div>
    <div id="dialog-select-member" style="display: none"></div>
    <div class="form-row">
        <div class="form-tips">Tip: Leave topic blank if you want to set them via msg properties.</div>
    </div>
    <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-ack"><i class="fa fa-arrow-up"></i> Type</label>
        <select id="node-input-ack" style="width:73% !important">
            <option value="true">value</option>
            <option value="false">command</option>
        </select>
    </div>
    <div class="form-row">
        <label for="node-input-autoCreate"><i class="fa fa-arrow-up"></i> Auto create</label>
        <select id="node-input-autoCreate" style="width:73% !important">
            <option value="true">Create states if not exist</option>
            <option value="false">Ignore messages for non existing states</option>
        </select>
    </div>
    <div class="form-row input-autoCreate">
        <div class="form-tips">Tip: Leave below options blank if you want to set them via msg properties.</div>
    </div>
    <div class="form-row input-autoCreate">
        <label for="node-input-stateName"><i class="fa fa-tag"></i> State Name</label>
        <input type="text" id="node-input-stateName" placeholder="">
    </div>
    <div class="form-row input-autoCreate">
        <label for="node-input-role"><i class="fa fa-tag"></i> Role</label>
        <input type="text" id="node-input-role" placeholder="">
    </div>
    <div class="form-row input-autoCreate">
        <label for="node-input-payloadType"><i class="fa fa-arrow-up"></i> Payload type</label>
        <select id="node-input-payloadType" style="width:73% !important">
            <option value="string">String</option>
            <option value="number">Number</option>
            <option value="boolean">Boolean</option>
            <option value="array">Array</option>
            <option value="object">Object</option>
            <option value="mixed">Mixed</option>
            <option value="file">File</option>
        </select>
    </div>
    <div class="form-row input-autoCreate">
        <label for="node-input-readonly"><i class="fa fa-arrow-up"></i> Readonly</label>
        <select id="node-input-readonly" style="width:73% !important">
            <option value="true">Object is readonly</option>
            <option value="false">Object is writeable</option>
        </select>
    </div>
    <div class="form-row input-autoCreate">
        <label for="node-input-stateUnit"><i class="fa fa-tag"></i> Unit</label>
        <input type="text" id="node-input-stateUnit" placeholder="">
    </div>
    <div class="form-row input-autoCreate">
        <label for="node-input-stateMin"><i class="fa fa-tag"></i> Min</label>
        <input type="text" id="node-input-stateMin" placeholder="">
    </div>
    <div class="form-row input-autoCreate">
        <label for="node-input-stateMax"><i class="fa fa-tag"></i> Max</label>
        <input type="text" id="node-input-stateMax" placeholder="">
    </div>
    <div class="form-tips">Tip: Leave topic blank if you want to set them via msg properties.</div>
</script>

<script type="text/x-red" data-help-name="ioBroker out">
    <p>Connects to a ioBroker and publishes <b>msg.payload</b> either to the <b>msg.topic</b> or to the topic specified in the edit window. The value in the edit window has precedence.</p>
    <p>If <b>msg.payload</b> contains an object it will be stringified before being sent.</p>
    <p>If <b>msg.payload</b> contains "__create__", the object will be only created, but no value will be written.</p>
    <p>If <b>msg.stateName</b> is defined, the created object name will be set as this value. If <b>msg.stateName</b> is not defined, but <b>Name</b> is set, use this instead.  If both node and msg do not set state name, the name will same as topic</p>
    <p>If <b>msg.stateRole</b> is defined, the created object role will be set as this value. If <b>msg.stateRole</b> is not defined, but <b>Role</b> is set, use this instead.</p>
    <p>If <b>msg.stateType</b> is defined, the created object common type will be set as this value. If <b>msg.stateType</b> is not defined, but <b>Type</b> is set, use this instead. If both node and msg do not set type, the type will be type of payload</p>
    <p>If <b>msg.stateReadonly</b> is defined, the created object writeable will be set as this value. If <b>msg.stateReadonly</b> is not defined, but <b>Readonly</b> is set, use this instead.If both node and msg do not set readonly, it will be readonly</p>
    <p>If <b>msg.stateUnit</b> is defined, the created object role will be set as this value. If <b>msg.stateUint</b> is not defined, but <b>Uint</b> is set, use this instead.</p>
    <p>If <b>msg.stateMin</b> is defined, the created object role will be set as this value. If <b>msg.stateMin</b> is not defined, but <b>Min</b> is set, use this instead.</p>
    <p>If <b>msg.stateMax</b> is defined, the created object role will be set as this value. If <b>msg.stateMax</b> is not defined, but <b>Max</b> is set, use this instead.</p>
</script>

<script type="text/javascript">
RED.nodes.registerType('ioBroker out', {
        category: 'ioBroker',
        defaults: {
            name: {value: ''},
            topic: {value: ''},
            ack: {value: 'false'},
			autoCreate: {value: 'false'},

            stateName: {value: ''},
            role: {value: ''},
            payloadType: {value: ''},
            readonly: {value: ''},
            stateUnit: {value: ''},
            stateMin: {value: ''},
            stateMax: {value: ''}
         },
        color: '#a8bfd8',
        inputs: 1,
        outputs: 0,
        icon: 'ioBroker.png',
        align: 'right',
        label: function () {
            return this.name || this.topic || 'IoB write value';
        },
        labelStyle: function () {
            return this.name ? 'node_label_italic' : '';
        },
        oneditprepare: function () {
            initSelectId();

            $('#node-input-autoCreate').on('change', function () {
                var val = $('#node-input-autoCreate').val();
                if (val === null || val === 'null') {
                    $('#node-input-autoCreate').val ('false');
                }
				if (val === 'true') {
                    $('.input-autoCreate').show();
                } else {
                    $('.input-autoCreate').hide();
                }
            });
        }
    });
</script>

<script type="text/x-red" data-template-name="ioBroker get">
    <div class="form-row">
        <label for="node-input-topic"><i class="fa fa-tasks"></i> Topic</label>
        <input type="text" id="node-input-topic" placeholder="Topic" style="width:60%"><input type="button" id="node-input-topic-button" style="display:inline-block;width:10%" value="..."/>
    </div>
    <div id="dialog-select-member" style="display:none"></div>
    <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-payloadType"><i class="fa fa-envelope"></i> Payload</label>
        <select id="node-input-payloadType" style="width:125px !important">
          <option value="value">value</option>
          <option value="object">object</option>
        </select>
    </div>
    <div class="form-row">
        <label for="node-input-attrname"><i class="fa fa-tag"></i> Attribute</label>
        <input type="text" id="node-input-attrname" placeholder="attrname">
    </div>
     <div class="form-tips">Tip: Leave topic blank if you want to set them via msg properties.</div>
</script>

<script type="text/x-red" data-help-name="ioBroker get">
    <p>Connects to a ioBroker and returns the requested value or the object in the message attribute in the properties dialog, e.g. <b>msg.payload</b>. The object could be identified either by the <b>msg.topic</b> or specified in the poperties dialog. The value in the poperties dialog has precedence.</p>
    <p>The msg object also contains the attributes <b>msg.timestamp</b>, <b>msg.lastchange</b> and <b>msg.acknowledged</b>. All other attributes of the input msg object will be passed to the output msg object.</p>
</script>

<script type="text/javascript">
RED.nodes.registerType('ioBroker get', {
        category: 'ioBroker',
        defaults: {
            name: {value: ''},
            topic: {value: ''},
            attrname: {value: 'payload'},
            payloadType: {value: 'value'}
         },
        color: '#a8bfd8',
        inputs: 1,
        outputs: 1,
        icon: 'ioBroker.png',
        label: function() {
            return this.name || this.topic || 'IoB read value';
        },
        labelStyle: function () {
            return this.name ? 'node_label_italic' : '';
        },
        oneditprepare: function () {
            initSelectId();
         }
    });
</script>

<script type="text/x-red" data-template-name="ioBroker get object">
    <div class="form-row">
        <label for="node-input-topic"><i class="fa fa-tasks"></i> Topic</label>
        <input type="text" id="node-input-topic" placeholder="Topic" style="width:60%"><input type="button" id="node-input-topic-button" style="display:inline-block;width:10%" value="..."/>
    </div>
    <div id="dialog-select-member" style="display:none"></div>
    <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-attrname"><i class="fa fa-tag"></i> Attribute</label>
        <input type="text" id="node-input-attrname" placeholder="attrname">
    </div>
     <div class="form-tips">Tip: Leave topic blank if you want to set them via msg properties.</div>
</script>

<script type="text/x-red" data-help-name="ioBroker get object">
    <p>Connects to a ioBroker and returns the requested object in the massage attribute in the properties dialog, e.g. <b>msg.payload</b>. The object could be identified either by the <b>msg.topic</b> or specified in the poperties dialog. The value in the poperties dialog has precedence.</p>
</script>

<script type="text/javascript">
    RED.nodes.registerType('ioBroker get object', {
        category: 'ioBroker',
        defaults: {
            name: {value: ''},
            topic: {value: ''},
            attrname: {value: 'payload'}
        },
        color: '#a8bfd8',
        inputs: 1,
        outputs: 1,
        icon: 'ioBroker.png',
        label: function () {
            return this.name || this.topic || 'IoB read object';
        },
        labelStyle: function () {
            return this.name ? 'node_label_italic' : '';
        },
        oneditprepare: function () {
            initSelectId();
        }
    });
</script>

<script type="text/x-red" data-template-name="ioBroker list">
    <div class="form-row">
        <label for="node-input-topic"><i class="fa fa-tasks"></i> Topic</label>
        <input type="text" id="node-input-topic" placeholder="Topic" style="width:60%"><input type="button" id="node-input-topic-button" style="display:inline-block;width:10%" value="..."/>
    </div>
    <div id="dialog-select-member" style="display:none"></div>
    <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-objType"><i class="fa fa-tag"></i> Type</label>
        <select id="node-input-objType" style="width:73% !important">
            <option value="">Any</option>
            <option value="state">State</option>
            <option value="channel">Channel</option>
            <option value="device">Device</option>
            <option value="meta">Meta</option>
            <option value="instance">Instance</option>
            <option value="adapter">Adapter</option>
            <option value="folder">Folder</option>
        </select>
    </div>
    <div class="form-row">
        <label for="node-input-asArray"><i class="fa fa-tag"></i> As array</label>
        <select id="node-input-asArray" style="width:73% !important">
            <option value="true">Return one array of IDs</option>
            <option value="false">For every ID the message will be generated</option>
        </select>
    </div>
    <div class="form-row">
        <label for="node-input-onlyIDs"><i class="fa fa-tag"></i> Only IDs</label>
        <select id="node-input-onlyIDs" style="width:73% !important">
            <option value="true">Returns only IDs of object</option>
            <option value="false">Returns whole objects</option>
        </select>
    </div>
    <div class="form-row">
        <label for="node-input-withValues"><i class="fa fa-tag"></i> With values</label>
        <select id="node-input-withValues" style="width:73% !important">
            <option value="true">Read state's values and add them to payload</option>
            <option value="false">Do not read values</option>
        </select>
    </div>
    <div class="form-row">
        <label for="node-input-regex"><i class="fa fa-tag"></i> Optional regex</label>
        <input type="text" id="node-input-regex" placeholder="Optional regular expression">
    </div>
     <div class="form-tips">Tip: Leave topic blank if you want to set them via msg properties.</div>
</script>

<script type="text/x-red" data-help-name="ioBroker list">
    <p>Connects to a ioBroker and returns the list of IDs for pattern.
    The filter can be defined in topic as "node-red.0.*" or in msg.topic.
    Additionally you can provide regular expression to filter received list.
    </p>
</script>

<script type="text/javascript">
    RED.nodes.registerType('ioBroker list', {
        category: 'ioBroker',
        defaults: {
            name: {value: ''},
            topic: {value: ''},
            objType: {value: 'state'},
            regex: {value: ''},
            asArray: {value: 'false'},
            onlyIDs: {value: 'true'},
            withValues: {value: 'false'}
        },
        color: '#a8bfd8',
        inputs: 1,
        outputs: 1,
        icon: 'ioBroker.png',
        label: function () {
            return this.name || this.topic || 'IoB list';
        },
        labelStyle: function () {
            return this.name ? 'node_label_italic' : '';
        },
        oneditprepare: function () {
            initSelectId(true, function (newId) {
                if (newId.indexOf('*') === -1) {
                    newId += '.*';
                    $('#node-input-topic').val(newId);
                }
            });
        }
    });
</script>