mirror of
https://github.com/node-red/node-red.git
synced 2023-10-10 13:36:53 +02:00
468 lines
23 KiB
HTML
468 lines
23 KiB
HTML
<!--
|
|
Copyright JS Foundation and other contributors, http://js.foundation
|
|
|
|
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="split">
|
|
<div class="form-row"><span data-i18n="[html]split.intro"></span></div>
|
|
<div class="form-row"><span data-i18n="[html]split.strBuff"></span></div>
|
|
<div class="form-row">
|
|
<label for="node-input-splt" style="padding-left:10px; margin-right:-10px;" data-i18n="split.splitUsing"></label>
|
|
<input type="text" id="node-input-splt" style="width:70%">
|
|
<input type="hidden" id="node-input-spltType">
|
|
</div>
|
|
<div class="form-row">
|
|
<input type="checkbox" id="node-input-stream" style="margin-left:10px; vertical-align:top; width:auto;">
|
|
<label for="node-input-stream" style="width:auto;" data-i18n="split.stream"></label>
|
|
</div>
|
|
<div class="form-row"><span data-i18n="[html]split.array"></span></div>
|
|
<div class="form-row">
|
|
<label for="node-input-arraySplt" style="padding-left:10px; margin-right:-10px;" data-i18n="split.splitUsing"></label>
|
|
<input type="text" id="node-input-arraySplt" style="width:70%">
|
|
<input type="hidden" id="node-input-arraySpltType">
|
|
</div>
|
|
<div class="form-row"><span data-i18n="[html]split.object"></span></div>
|
|
<div class="form-row" style="padding-left: 10px"><span data-i18n="[html]split.objectSend"></span></div>
|
|
<div class="form-row">
|
|
<input type="checkbox" id="node-input-addname-cb" style="margin-left:10px; vertical-align:baseline; width:auto;">
|
|
<label for="node-input-addname-cb" style="width:auto;" data-i18n="split.addname"></label>
|
|
<input type="text" id="node-input-addname" style="width:70%">
|
|
</div>
|
|
<hr/>
|
|
<div class="form-row">
|
|
<label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="common.label.name"></span></label>
|
|
<input type="text" id="node-input-name" data-i18n="[placeholder]common.label.name">
|
|
</div>
|
|
</script>
|
|
|
|
<script type="text/x-red" data-help-name="split">
|
|
<p>Splits a message into a sequence of messages.</p>
|
|
|
|
<h3>Inputs</h3>
|
|
<dl class="message-properties">
|
|
<dt>payload<span class="property-type">object | string | array | buffer</span></dt>
|
|
<dd>The behaviour of the node is determined by the type of <code>msg.payload</code>:
|
|
<ul>
|
|
<li><b>string</b>/<b>buffer</b> - the message is split using the specified character (default: <code>\n</code>), buffer sequence or into fixed lengths.</li>
|
|
<li><b>array</b> - the message is split into either individual array elements, or arrays of a fixed-length.</li>
|
|
<li><b>object</b> - a message is sent for each key/value pair of the object.</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<h3>Outputs</h3>
|
|
<dl class="message-properties">
|
|
<dt>parts<span class="property-type">object</span></dt>
|
|
<dd>This property contains information about how the message was split from
|
|
the original message. If passed to the <b>join</b> node, the sequence can be
|
|
reassembled into a single message. The property has the following properties:
|
|
<ul>
|
|
<li><code>id</code> - an identifier for the group of messages</li>
|
|
<li><code>index</code> - the position within the group</li>
|
|
<li><code>count</code> - if known, the total number of messages in the group. See 'streaming mode' below.</li>
|
|
<li><code>type</code> - the type of message - string/array/object/buffer</li>
|
|
<li><code>ch</code> - for a string or buffer, the data used to the split the message as either the string or an array of bytes</li>
|
|
<li><code>key</code> - for an object, the key of the property this message was created from. The node can be configured to also copy this value to another message properties, such as <code>msg.topic</code>.</li>
|
|
<li><code>len</code> - the length of each message when split using a fixed length value</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<h3>Details</h3>
|
|
<p>This node makes it easy to create a flow that performs common actions across
|
|
a sequence of messages before, using the <b>join</b> node, recombining the
|
|
sequence into a single message.</p>
|
|
<p>It uses the <code>msg.parts</code> property to track the individual parts
|
|
of a sequence.</p>
|
|
<h4>Streaming mode</h4>
|
|
<p>The node can also be used to reflow a stream of messages. For example, a
|
|
serial device that sends newline-terminated commands may deliver a single message
|
|
with a partial command at its end. In 'streaming mode', this node will split
|
|
a message and send each complete segment. If there is a partial segment at the end,
|
|
the node will hold on to it and prepend it to the next message that is received.
|
|
</p>
|
|
<p>When operating in this mode, the node will not set the <code>msg.parts.count</code>
|
|
property as it does not know how many messages to expect in the stream. This
|
|
means it cannot be used with the <b>join</b> node in its automatic mode</p>
|
|
</script>
|
|
|
|
<script type="text/javascript">
|
|
RED.nodes.registerType('split',{
|
|
category: 'function',
|
|
color:"#E2D96E",
|
|
defaults: {
|
|
name: {value:""},
|
|
splt: {value:"\\n"},
|
|
spltType: {value:"str"},
|
|
arraySplt: {value:1},
|
|
arraySpltType: {value:"len"},
|
|
stream: {value:false},
|
|
addname: {value:""}
|
|
},
|
|
inputs:1,
|
|
outputs:1,
|
|
icon: "split.png",
|
|
label: function() {
|
|
return this.name||this._("split.split");
|
|
},
|
|
labelStyle: function() {
|
|
return this.name?"node_label_italic":"";
|
|
},
|
|
oneditprepare: function() {
|
|
$("#node-input-splt").typedInput({
|
|
default: 'str',
|
|
typeField: $("#node-input-spltType"),
|
|
types:[
|
|
'str',
|
|
'bin',
|
|
{value:"len", label:RED._("node-red:split.splitLength"),validate:/^\d+$/}
|
|
]
|
|
});
|
|
if (this.arraySplt === undefined) {
|
|
$("#node-input-arraySplt").val(1);
|
|
}
|
|
$("#node-input-arraySplt").typedInput({
|
|
default: 'len',
|
|
typeField: $("#node-input-arraySpltType"),
|
|
types:[
|
|
{value:"len", label:RED._("node-red:split.splitLength"),validate:/^\d+$/}
|
|
]
|
|
});
|
|
$("#node-input-addname").typedInput({
|
|
typeField: $("#node-input-fnameType"),
|
|
types:['msg']
|
|
});
|
|
|
|
$("#node-input-addname-cb").change(function() {
|
|
$("#node-input-addname").prop('disabled',!this.checked);
|
|
})
|
|
if (this.addname === "") {
|
|
$("#node-input-addname-cb").prop('checked',false);
|
|
$("#node-input-addname").val('topic');
|
|
} else {
|
|
$("#node-input-addname-cb").prop('checked',true);
|
|
}
|
|
$("#node-input-addname-cb").change();
|
|
},
|
|
oneditsave: function() {
|
|
if (!$("#node-input-addname-cb").prop('checked')) {
|
|
$("#node-input-addname").val('');
|
|
}
|
|
}
|
|
});
|
|
</script>
|
|
|
|
|
|
<script type="text/x-red" data-template-name="join">
|
|
<div class="form-row">
|
|
<label data-i18n="join.mode.mode"></label>
|
|
<select id="node-input-mode" style="width:200px;">
|
|
<option value="auto" data-i18n="join.mode.auto"></option>
|
|
<option value="custom" data-i18n="join.mode.custom"></option>
|
|
<option value="reduce" data-i18n="join.mode.reduce"></option>
|
|
</select>
|
|
</div>
|
|
<div class="node-row-custom">
|
|
<div class="form-row node-row-property">
|
|
<label data-i18n="join.combine"> </label>
|
|
<input type="text" id="node-input-property" style="width:70%;">
|
|
<input type="hidden" id="node-input-propertyType">
|
|
</div>
|
|
<div class="form-row">
|
|
<label data-i18n="join.create"></label>
|
|
<select id="node-input-build" style="width:70%;">
|
|
<option value="string" data-i18n="join.type.string"></option>
|
|
<option value="buffer" data-i18n="join.type.buffer"></option>
|
|
<option value="array" data-i18n="join.type.array"></option>
|
|
<option value="object" data-i18n="join.type.object"></option>
|
|
<option value="merged" data-i18n="join.type.merged"></option>
|
|
</select>
|
|
</div>
|
|
<div class="form-row node-row-key">
|
|
<label style="vertical-align:top; margin-top:7px; width:auto; margin-right: 5px;" data-i18n="join.using"></label>
|
|
<div style="display:inline-block">
|
|
<input type="text" id="node-input-key" style="width:220px;"> <span data-i18n="join.key"></span>
|
|
</div>
|
|
</div>
|
|
<div class="form-row node-row-joiner">
|
|
<label for="node-input-joiner" data-i18n="join.joinedUsing"></label>
|
|
<input type="text" id="node-input-joiner" style="width:70%">
|
|
<input type="hidden" id="node-input-joinerType">
|
|
</div>
|
|
<div class="form-row node-row-trigger" id="trigger-row">
|
|
<label style="width:auto;" data-i18n="join.send"></label>
|
|
<ul>
|
|
<li>
|
|
<label style="width:280px;" for="node-input-count" data-i18n="join.afterCount"></label> <input id="node-input-count" data-i18n="[placeholder]join.count" type="text" style="width:75px;">
|
|
</li>
|
|
<li class="node-row-accumulate" style="list-style-type:none;">
|
|
<input type="checkbox" id="node-input-accumulate" style="display:inline-block; width:20px; margin-left:20px; vertical-align:top;"> <label style="width: auto" for="node-input-accumulate" data-i18n="join.subsequent"></label>
|
|
</li>
|
|
<li>
|
|
<label style="width:280px;" for="node-input-timeout" data-i18n="join.afterTimeout"></label> <input id="node-input-timeout" data-i18n="[placeholder]join.seconds" type="text" style="width:75px;">
|
|
</li>
|
|
<li>
|
|
<label style="width:auto; padding-top:6px;" data-i18n="[html]join.complete"></label>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="node-row-reduce">
|
|
<div class="form-row">
|
|
<label for="node-input-reduceExp" data-i18n="join.reduce.exp" style="margin-left:10px;"></label>
|
|
<input type="text" id="node-input-reduceExp" data-i18n="[placeholder]join.reduce.exp-value" style="width:65%">
|
|
</div>
|
|
<div class="form-row">
|
|
<label for="node-input-reduceInit" data-i18n="join.reduce.init" style="margin-left:10px;"></label>
|
|
<input type="text" id="node-input-reduceInit" data-i18n="[placeholder]join.reduce.init" style="width:65%">
|
|
<input type="hidden" id="node-input-reduceInitType">
|
|
</div>
|
|
<div class="form-row">
|
|
<label for="node-input-reduceFixup" data-i18n="join.reduce.fixup" style="margin-left:10px;"></label>
|
|
<input type="text" id="node-input-reduceFixup" data-i18n="[placeholder]join.reduce.exp-value" style="width:65%">
|
|
</div>
|
|
<div class="form-row">
|
|
<label> </label>
|
|
<input type="checkbox" id="node-input-reduceRight" style="display:inline-block; width:auto; vertical-align:top; margin-left:10px;">
|
|
<label for="node-input-reduceRight" style="width:70%;" data-i18n="join.reduce.right" style="margin-left:10px;"/>
|
|
</div>
|
|
</div>
|
|
<div class="form-row">
|
|
<label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="common.label.name"></span></label>
|
|
<input type="text" id="node-input-name" data-i18n="[placeholder]common.label.name">
|
|
</div>
|
|
<div class="form-tips form-tips-auto hide" data-i18n="[html]join.tip"></div>
|
|
</script>
|
|
|
|
<script type="text/x-red" data-help-name="join">
|
|
<p>Joins sequences of messages into a single message.</p>
|
|
<p>There are three modes available:</p>
|
|
<dl>
|
|
<dt>automatic</dt>
|
|
<dd>When paired with the <b>split</b> node, it will automatically join the messages to reverse the split that was performed.</dd>
|
|
<dt>manual</dt>
|
|
<dd>Join sequences of messages in a variety of ways.</dd>
|
|
<dt>reduce sequence</dt>
|
|
<dd>Apply an expression against all messages in a sequence to reduce it to a single message.</dd>
|
|
</dl>
|
|
<h3>Inputs</h3>
|
|
<dl class="message-properties">
|
|
<dt class="optional">parts<span class="property-type">object</span></dt>
|
|
<dd>To automatically join a sequence of messages, they should all have
|
|
this property set. The <b>split</b> node generates this property but it
|
|
can be manually created. It has the following properties:
|
|
<ul>
|
|
<li><code>id</code> - an identifier for the group of messages</li>
|
|
<li><code>index</code> - the position within the group</li>
|
|
<li><code>count</code> - the total number of messages in the group</li>
|
|
<li><code>type</code> - the type of message - string/array/object/buffer</li>
|
|
<li><code>ch</code> - for a string or buffer, the data used to the split the message as either the string or an array of bytes</li>
|
|
<li><code>key</code> - for an object, the key of the property this message was created from</li>
|
|
<li><code>len</code> - the length of each message when split using a fixed length value</li>
|
|
</ul>
|
|
</dd>
|
|
<dt class="optional">complete</dt>
|
|
<dd>If set, the node will send its output message in its current state.</dd>
|
|
</dl>
|
|
<h3>Details</h3>
|
|
|
|
<h4>Automatic mode</h4>
|
|
<p>Automatic mode uses the <code>parts</code> property of incoming messages to
|
|
determine how the sequence should be joined. This allows it to automatically
|
|
reverse the action of a <b>split</b> node.
|
|
|
|
<h4>Manual mode</h4>
|
|
<p>When configured to join in manual mode, the node is able to join sequences
|
|
of messages into a number of different results:</p>
|
|
<ul>
|
|
<li>a <b>string</b> or <b>buffer</b> - created by joining the selected property of each message with the specified join characters or buffer.</li>
|
|
<li>an <b>array</b> - created by adding each selected property, or entire message, to the output array.</li>
|
|
<li>a <b>key/value object</b> - created by using a property of each message to determine the key under which
|
|
the required value is stored.</li>
|
|
<li>a <b>merged object</b> - created by merging the property of each message under a single object.</li>
|
|
</ul>
|
|
<p>The other properties of the output message are taken from the last message received before the result is sent.</p>
|
|
<p>A <i>count</i> can be set for how many messages should be received before generating the output message.
|
|
For object outputs, once this count has been reached, the node can be configured to send a message for each subsequent message
|
|
received.</p>
|
|
<p>A <i>timeout</i> can be set to trigger sending the new message using whatever has been received so far.</p>
|
|
<p>If a message is received with the <b>msg.complete</b> property set, the output message is sent.</p>
|
|
|
|
<h4>Reduce Sequence mode</h4>
|
|
<p>When configured to join in reduce mode, an expression is applied to each
|
|
message in a sequence and the result accumulated to produce a single message.</p>
|
|
|
|
<dl class="message-properties">
|
|
<dt>Initial value</dt>
|
|
<dd>The initial value of the accumulated value (<code>$A</code>).</dd>
|
|
<dt>Reduce expression</dt>
|
|
<dd>A JSONata expression that is called for each message in the sequence.
|
|
The result is passed to the next call of the expression as the accumulated value.
|
|
In the expression, the following special variables can be used:
|
|
<ul>
|
|
<li><code>$A</code>: the accumulated value, </li>
|
|
<li><code>$I</code>: index of the message in the sequence, </li>
|
|
<li><code>$N</code>: number of messages in the sequence.</li>
|
|
</ul>
|
|
</dd>
|
|
<dt>Fix-up expression</dt>
|
|
<dd>An optional JSONata expression that is applied after the reduce expression
|
|
has been applied to all messages in the sequence.
|
|
In the expression, following special variables can be used:
|
|
<ul>
|
|
<li><code>$A</code>: the accumulated value, </li>
|
|
<li><code>$N</code>: number of messages in the sequence.</li>
|
|
</ul>
|
|
</dd>
|
|
<p>By default, the reduce expression is applied in order, from the first
|
|
to the last message of the sequence. It can optionally be applied in
|
|
reverse order.</p>
|
|
</dl>
|
|
<p><b>Example:</b> the following settings, given a sequence of numeric values,
|
|
calculates the average value:
|
|
<ul>
|
|
<li><b>Reduce expression</b>: <code>$A+payload</code></li>
|
|
<li><b>Initial value</b>: <code>0</code></li>
|
|
<li><b>Fix-up expression</b>: <code>$A/$N</code></li>
|
|
</ul>
|
|
</p>
|
|
<h4>Storing messages</h4>
|
|
<p>This node will buffer messages internally in order to work across sequences. The
|
|
runtime setting <code>nodeMessageBufferMaxLength</code> can be used to limit how many messages nodes
|
|
will buffer.</p>
|
|
</script>
|
|
|
|
<script type="text/javascript">
|
|
RED.nodes.registerType('join',{
|
|
category: 'function',
|
|
color:"#E2D96E",
|
|
defaults: {
|
|
name: {value:""},
|
|
mode: {value:"auto"},
|
|
build: { value:"string"},
|
|
property: { value:"payload", validate:RED.validators.typedInput("propertyType")},
|
|
propertyType: { value:"msg"},
|
|
key: {value:"topic"},
|
|
joiner: { value:"\\n"},
|
|
joinerType: { value:"str"},
|
|
accumulate: { value:"false" },
|
|
timeout: {value:""},
|
|
count: {value:""},
|
|
reduceRight: {value:false},
|
|
reduceExp: {value:undefined},
|
|
reduceInit: {value:undefined},
|
|
reduceInitType: {value:undefined},
|
|
reduceFixup: {value:undefined}
|
|
},
|
|
inputs:1,
|
|
outputs:1,
|
|
icon: "join.png",
|
|
label: function() {
|
|
return this.name||this._("join.join");
|
|
},
|
|
labelStyle: function() {
|
|
return this.name?"node_label_italic":"";
|
|
},
|
|
oneditprepare: function() {
|
|
var node = this;
|
|
|
|
$("#node-input-mode").change(function(e) {
|
|
var val = $(this).val();
|
|
$(".node-row-custom").toggle(val==='custom');
|
|
$(".node-row-reduce").toggle(val==='reduce');
|
|
$(".form-tips-auto").toggle((val==='auto') || (val==='reduce'));
|
|
if (val === "auto") {
|
|
$("#node-input-accumulate").attr('checked', false);
|
|
}
|
|
else if (val === "custom") {
|
|
$("#node-input-build").change();
|
|
}
|
|
else if (val === "reduce") {
|
|
var jsonata_or_empty = {
|
|
value: "jsonata",
|
|
label: "expression",
|
|
icon: "red/images/typedInput/expr.png",
|
|
validate: function(v) {
|
|
try{
|
|
if(v !== "") {
|
|
jsonata(v);
|
|
}
|
|
return true;
|
|
}
|
|
catch(e){
|
|
return false;
|
|
}
|
|
},
|
|
expand:function() {
|
|
var that = this;
|
|
RED.editor.editExpression({
|
|
value: this.value().replace(/\t/g,"\n"),
|
|
complete: function(v) {
|
|
that.value(v.replace(/\n/g,"\t"));
|
|
}
|
|
})
|
|
}
|
|
};
|
|
$("#node-input-reduceExp").typedInput({types:[jsonata_or_empty]});
|
|
$("#node-input-reduceInit").typedInput({
|
|
default: 'num',
|
|
types:['flow','global','str','num','bool','json','bin','date','jsonata'],
|
|
typeField: $("#node-input-reduceInitType")
|
|
});
|
|
$("#node-input-reduceFixup").typedInput({types:[jsonata_or_empty]});
|
|
}
|
|
});
|
|
|
|
$("#node-input-build").change(function(e) {
|
|
var val = $(this).val();
|
|
$(".node-row-key").toggle(val==='object');
|
|
$(".node-row-accumulate").toggle(val==='object' || val==='merged');
|
|
$(".node-row-joiner").toggle(val==='string' || val==='buffer');
|
|
$(".node-row-trigger").toggle(val!=='auto');
|
|
if (val === 'string' || val==='buffer') {
|
|
$("#node-input-property").typedInput('types',['msg']);
|
|
$("#node-input-joiner").typedInput("show");
|
|
} else {
|
|
$("#node-input-property").typedInput('types',['msg', {value:"full",label:"complete message",hasValue:false}]);
|
|
}
|
|
});
|
|
|
|
$("#node-input-joiner").typedInput({
|
|
default: 'str',
|
|
typeField: $("#node-input-joinerType"),
|
|
types:[
|
|
'str',
|
|
'bin'
|
|
]
|
|
});
|
|
|
|
$("#node-input-property").typedInput({
|
|
typeField: $("#node-input-propertyType"),
|
|
types:['msg', {value:"full", label:"complete message", hasValue:false}]
|
|
});
|
|
|
|
$("#node-input-key").typedInput({
|
|
types:['msg', {value:"merge", label:"", hasValue:false}]
|
|
});
|
|
|
|
$("#node-input-build").change();
|
|
$("#node-input-mode").change();
|
|
},
|
|
oneditsave: function() {
|
|
var build = $("#node-input-build").val();
|
|
if (build !== 'object' && build !== 'merged') {
|
|
$("#node-input-accumulate").prop("checked",false);
|
|
}
|
|
}
|
|
});
|
|
</script>
|