splitter.html

<!--
 * Copyright 2014 Leon van Kammen / Coder of salvation. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are
 * permitted provided that the following conditions are met:
 *
 *    1. Redistributions of source code must retain the above copyright notice, this list of
 *       conditions and the following disclaimer.
 *
 *    2. Redistributions in binary form must reproduce the above copyright notice, this list
 *       of conditions and the following disclaimer in the documentation and/or other materials
 *       provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY Leon van Kammen AS IS'' AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL Leon van Kammen OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation are those of the
 * authors and should not be interpreted as representing official policies, either expressed
 * or implied, of Leon van Kammen
-->

<script type="text/x-red" data-template-name="splitter">
    <div class="form-row">
        <label class="fa fa-ellipsis-h" for="node-input-name"><i class="icon-tag"></i> Name</label>
        <input type="text" id="node-input-name" placeholder="Name">
    </div>
    <div class="form-row" style="padding-top:10px;">
        Iterate over msg.<input type="text" id="node-input-property" style="width: 200px;"/>
    </div>
</script>

<script type="text/x-red" data-help-name="splitter">
    <p>A simple node to split an payload-array into seperate messages</p>
    <p>When a message arrives, the configured variable will be iterated over</p>
    <p>Note: the <i>old payload</i> will be stored in <b>msg.payload_unsplit</b></p>
    <h4>Loop control features</h4>
    <dl>
      <dt><i>{number}</i> <b>msg.$index</b></dt>
      <dd>current loop index</dd>
      <dt><i>{boolean}</i> <b>msg.$first</b></dt>
      <dd>true if loop element is first</dd>
      <dt><i>{boolean}</i> <b>msg.$last</b></dt>
      <dd>true if loop element is last</dd>
    </dl>
</script>

<script type="text/javascript">
    RED.nodes.registerType('splitter', {
        color: "#E2D96E",
        category: 'function',
        defaults: {
            name: {value:""},
            property: {value:"payload", required:true}
        },
        inputs: 1,
        outputs: 1,
        icon: "splitter.png",
        label: function() {
            return this.name||"splitter";
        }
    });
</script>