mirror of
https://github.com/node-red/node-red-nodes.git
synced 2025-03-01 10:37:43 +00:00
380 lines
19 KiB
HTML
380 lines
19 KiB
HTML
|
|
<script type="text/x-red" data-template-name="serial in">
|
|
<div class="form-row node-input-serial">
|
|
<label for="node-input-serial"><i class="fa fa-random"></i> <span data-i18n="serial.label.serialport"></span></label>
|
|
<input type="text" id="node-input-serial">
|
|
</div>
|
|
<div class="form-row">
|
|
<label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="node-red:common.label.name"></span></label>
|
|
<input type="text" id="node-input-name" data-i18n="[placeholder]node-red:common.label.name">
|
|
</div>
|
|
</script>
|
|
|
|
<script type="text/x-red" data-help-name="serial in">
|
|
<p>Reads data from a local serial port.</p>
|
|
<p>Can either <ul><li>wait for a "split" character (default \n). Also accepts hex notation (0x0d).</li>
|
|
<li>Wait for a timeout in milliseconds from the first character received</li>
|
|
<li>Wait to fill a fixed sized buffer</li></ul></p>
|
|
<p>It then outputs <code>msg.payload</code> as either a UTF8 ascii string or a binary Buffer object.</p>
|
|
<p><code>msg.port</code> is set to the name of the port selected.</p>
|
|
<p>If no split character is specified, or a timeout or buffer size of 0, then a stream of single characters
|
|
is sent - again either as ascii chars or size 1 binary buffers.</p>
|
|
</script>
|
|
|
|
<script type="text/javascript">
|
|
RED.nodes.registerType('serial in',{
|
|
category: 'network',
|
|
defaults: {
|
|
name: {name:""},
|
|
serial: {type:"serial-port",required:true}
|
|
},
|
|
color:"BurlyWood",
|
|
inputs:0,
|
|
outputs:1,
|
|
icon: "serial.png",
|
|
label: function() {
|
|
var serialNode = RED.nodes.node(this.serial);
|
|
return this.name||(serialNode?serialNode.label().split(":")[0]:this._("serial.label.serial"));
|
|
},
|
|
labelStyle: function() {
|
|
return this.name?"node_label_italic":"";
|
|
},
|
|
outputLabels: function() { return RED.nodes.node(this.serial).bin === "bin" ? "buffer" : "string"; }
|
|
});
|
|
</script>
|
|
|
|
<script type="text/x-red" data-template-name="serial out">
|
|
<div class="form-row node-input-serial">
|
|
<label for="node-input-serial"><i class="fa fa-random"></i> <span data-i18n="serial.label.serialport"></span></label>
|
|
<input type="text" id="node-input-serial">
|
|
</div>
|
|
<div class="form-row">
|
|
<label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="node-red:common.label.name"></span></label>
|
|
<input type="text" id="node-input-name" data-i18n="[placeholder]node-red:common.label.name">
|
|
</div>
|
|
</script>
|
|
|
|
<script type="text/x-red" data-help-name="serial out">
|
|
<p>Provides a connection to an outbound serial port.</p>
|
|
<p>Only the <code>msg.payload</code> is sent.</p>
|
|
<p>Optionally the new line character used to split the input can be appended to every message sent out to the serial port.</p>
|
|
<p>Binary payloads can be sent by using a Buffer object.</p>
|
|
</script>
|
|
|
|
<script type="text/javascript">
|
|
RED.nodes.registerType('serial out',{
|
|
category: 'network',
|
|
defaults: {
|
|
name: {name:""},
|
|
serial: {type:"serial-port",required:true}
|
|
},
|
|
color:"BurlyWood",
|
|
inputs:1,
|
|
outputs:0,
|
|
icon: "serial.png",
|
|
align: "right",
|
|
label: function() {
|
|
var serialNode = RED.nodes.node(this.serial);
|
|
return this.name||(serialNode?serialNode.label().split(":")[0]:this._("serial.label.serial"));
|
|
},
|
|
labelStyle: function() {
|
|
return this.name?"node_label_italic":"";
|
|
}
|
|
});
|
|
</script>
|
|
|
|
<script type="text/x-red" data-template-name="serial request">
|
|
<div class="form-row node-input-serial">
|
|
<label for="node-input-serial"><i class="fa fa-random"></i> <span data-i18n="serial.label.serialport"></span></label>
|
|
<input type="text" id="node-input-serial">
|
|
</div>
|
|
<div class="form-row">
|
|
<label for="node-inputoutput-name"><i class="fa fa-tag"></i> <span data-i18n="node-red:common.label.name"></span></label>
|
|
<input type="text" id="node-input-name" data-i18n="[placeholder]node-red:common.label.name">
|
|
</div>
|
|
</script>
|
|
|
|
<script type="text/x-red" data-help-name="serial request">
|
|
<p>Provides a connection to a request/response serial port.</p>
|
|
<p>This node behaves as a tightly coupled combination of <code>serial in</code> and <code>serial out</code> nodes,
|
|
with which it shares the configuration.</p>
|
|
<p>Send the request message in <code>msg.payload</code> as you would do with a <code>serial out</code> node.
|
|
The message will be forwarded to the serial port following a strict FIFO (First In, First Out) queue, waiting for a single response before transmitting the next request.
|
|
Once a response is received (with the same logic of a <code>serial in</code> node), or after a timeout occurs, a message is sent to the output (see Outputs below),
|
|
with <code>msg.payload</code> containing the received response (or missing in case if timeout) and all other fields preserved.</p>
|
|
<p>For consistency with the <code>serial in</code> node, <code>msg.port</code> is set to the name of the port selected.</p>
|
|
<h3>Inputs</h3>
|
|
<ul>
|
|
<li>
|
|
<code>msg.timeout</code> is the timeout (in ms) after which the incoming message is propagated to the output with <code>msg.status</code> set to <code>"ERR_TIMEOUT"</code> and missing payload.
|
|
If not present, the default value is 10000 (10s).
|
|
</li>
|
|
<li><code>msg.count</code> if set this will override the configured number of characters as long as it is less than the number configured.</li>
|
|
<li><code>msg.waitfor</code> single character, escape code, or hex code. If set, the node will wait until it matches that character in the stream and then start the output.</li>
|
|
</ul>
|
|
<h3>Outputs</h3>
|
|
<ul>
|
|
<li><code>msg.payload</code> is the response. If no response occured, this field is removed.</li>
|
|
<li><code>msg.status</code> is <code>"OK"</code> in case a response is received, or <code>"ERR_TIMEOUT"</code> if a timeout occurs.</li>
|
|
<li>Any other field coming from the input will be preserved.</li>
|
|
</ul>
|
|
</script>
|
|
|
|
<script type="text/javascript">
|
|
RED.nodes.registerType('serial request',{
|
|
category: 'network',
|
|
defaults: {
|
|
name: {name:""},
|
|
serial: {type:"serial-port",required:true}
|
|
},
|
|
color:"BurlyWood",
|
|
inputs:1,
|
|
outputs:1,
|
|
icon: "serial.png",
|
|
align: "left",
|
|
label: function() {
|
|
var serialNode = RED.nodes.node(this.serial);
|
|
return this.name||(serialNode?serialNode.label().split(":")[0]:this._("serial.label.serial"));
|
|
},
|
|
labelStyle: function() {
|
|
return this.name?"node_label_italic":"";
|
|
},
|
|
outputLabels: function() { return RED.nodes.node(this.serial).bin === "bin" ? "buffer" : "string"; }
|
|
});
|
|
</script>
|
|
|
|
<script type="text/x-red" data-template-name="serial-port">
|
|
<div class="form-row">
|
|
<label for="node-config-input-serialport"><i class="fa fa-random"></i> <span data-i18n="serial.label.serialport"></span></label>
|
|
<input type="text" id="node-config-input-serialport" style="width:66%;" data-i18n="[placeholder]serial.placeholder.serialport">
|
|
<a id="node-config-lookup-serial" class="btn"><i id="node-config-lookup-serial-icon" class="fa fa-search"></i></a>
|
|
</div>
|
|
<div class="form-row">
|
|
<table width="100%"><tr>
|
|
<td width="100px"><i class="fa fa-wrench"></i> <span data-i18n="serial.label.settings"></span></td>
|
|
<td width="110px" data-i18n="serial.label.baudrate"></td>
|
|
<td width="70px" data-i18n="serial.label.databits"></td>
|
|
<td width="80px" data-i18n="serial.label.parity"></td>
|
|
<td width="70px" data-i18n="serial.label.stopbits"></td>
|
|
</tr><tr><td> </td>
|
|
<td>
|
|
<input type="text" id="node-config-input-serialbaud" style="width:92%">
|
|
</td><td>
|
|
<select type="text" id="node-config-input-databits" style="width:90%;">
|
|
<option value="8">8</option>
|
|
<option value="7">7</option>
|
|
<option value="6">6</option>
|
|
<option value="5">5</option>
|
|
</select>
|
|
</td><td>
|
|
<select type="text" id="node-config-input-parity" style="width:90%;">
|
|
<option value="none" data-i18n="serial.parity.none"></option>
|
|
<option value="even" data-i18n="serial.parity.even"></option>
|
|
<option value="mark" data-i18n="serial.parity.mark"></option>
|
|
<option value="odd" data-i18n="serial.parity.odd"></option>
|
|
<option value="space" data-i18n="serial.parity.space"></option>
|
|
</select>
|
|
</td><td>
|
|
<select type="text" id="node-config-input-stopbits" style="width:90%;">
|
|
<option value="2">2</option>
|
|
<option value="1">1</option>
|
|
</select>
|
|
</td></tr></table>
|
|
</div>
|
|
<div class="form-row" style="margin-top:16px; margin-bottom:0;">
|
|
<label><i class="fa fa-sign-in"></i> <span data-i18n="serial.label.input"></span></label>
|
|
</div>
|
|
<div class="form-row" style="padding-left:18px; margin-bottom:4px;">
|
|
<span data-i18n="serial.label.start"></span>
|
|
<input type="text" id="node-config-input-waitfor" style="width:50px; height:28px;">
|
|
<span data-i18n="serial.label.startor"></span>
|
|
</div>
|
|
<div class="form-row" style="padding-left:18px; margin-bottom:4px;">
|
|
<span data-i18n="serial.label.split"></span>
|
|
<select type="text" id="node-config-input-out" style="margin-left:11px; width:200px; height:28px;">
|
|
<option value="char" data-i18n="serial.split.character"></option>
|
|
<option value="time" data-i18n="serial.split.timeout"></option>
|
|
<option value="interbyte" data-i18n="serial.split.silent"></option>
|
|
<option value="count" data-i18n="serial.split.lengths"></option>
|
|
</select>
|
|
<input type="text" id="node-config-input-newline" style="width:50px; height:28px;">
|
|
<span id="node-units"></span>
|
|
</div>
|
|
<div class="form-row" style="padding-left:18px; margin-bottom:4px;">
|
|
<span data-i18n="serial.label.deliver"></span>
|
|
<select type="text" id="node-config-input-bin" style="margin-left:5px; width:150px; height:28px;">
|
|
<option value="false" data-i18n="serial.output.ascii"></option>
|
|
<option value="bin" data-i18n="serial.output.binary"></option>
|
|
</select>
|
|
</div>
|
|
<div id="node-config-addchar">
|
|
<div class="form-row" style="margin-top:16px; margin-bottom:0;">
|
|
<label><i class="fa fa-sign-out"></i> <span data-i18n="serial.label.output"></span></label>
|
|
</div>
|
|
<div class="form-row" style="padding-left:18px; margin-bottom:4px;">
|
|
<label style="width:auto;" for="node-config-input-addchar"><span data-i18n="serial.addsplit"></span></label>
|
|
<input type="text" id="node-config-input-addchar" style="width:50px; height:28px;">
|
|
</div>
|
|
</div>
|
|
<div id="node-config-req">
|
|
<div class="form-row" style="margin-top:16px; margin-bottom:0;">
|
|
<label><i class="fa fa-exchange"></i> <span data-i18n="serial.label.request"></span></label>
|
|
</div>
|
|
<div class="form-row" style="padding-left:18px; margin-bottom:18px;">
|
|
<span data-i18n="serial.label.responsetimeout"></span>
|
|
<input type="text" id="node-config-input-responsetimeout" style="width:60px; height:28px;">
|
|
<span data-i18n="serial.label.ms"></span>
|
|
</div>
|
|
</div>
|
|
<div class="form-tips" id="tip-waitfor" hidden><span data-i18n="serial.tip.waitfor"></span></div>
|
|
<div class="form-tips" id="tip-addchar" hidden><span data-i18n="serial.tip.addchar"></span></div>
|
|
<div class="form-tips" id="tip-responsetimeout" hidden><span data-i18n="serial.tip.responsetimeout"></span></div>
|
|
<div class="form-tips" id="tip-split"><span data-i18n="serial.tip.split"></span></div>
|
|
<div class="form-tips" id="tip-timeout" hidden><span data-i18n="serial.tip.timeout"></span></div>
|
|
<div class="form-tips" id="tip-silent" hidden><span data-i18n="serial.tip.silent"></span></div>
|
|
<div class="form-tips" id="tip-count" hidden><span data-i18n="serial.tip.count"></span></div>
|
|
</script>
|
|
|
|
<script type="text/x-red" data-help-name="serial-port">
|
|
<p>Provides configuration options for a serial port.</p>
|
|
<p>The search button should return a list of available serial ports to choose from, or you
|
|
can type in the location if known.</p>
|
|
<p>The node can optionally wait until it matches a pre-defined character.
|
|
The data can then be split on a fixed character, after a timeout, or after a fixed number of characters.</p>
|
|
<p>If using a character, it can be specified as either the character, the escaped shortcut (e.g. \n), or the hex code (e.g. 0x0d).</p>
|
|
</script>
|
|
|
|
<script type="text/javascript">
|
|
RED.nodes.registerType('serial-port',{
|
|
category: 'config',
|
|
defaults: {
|
|
//name: {value:""},
|
|
serialport: {value:"",required:true},
|
|
serialbaud: {value:"57600",required:true,validate:RED.validators.number()},
|
|
databits: {value:8,required:true},
|
|
parity: {value:"none",required:true},
|
|
stopbits: {value:1,required:true},
|
|
waitfor: {value:""},
|
|
newline: {value:"\\n"},
|
|
bin: {value:"false"},
|
|
out: {value:"char"},
|
|
addchar: {value:false},
|
|
responsetimeout: {value: 10000}
|
|
},
|
|
label: function() {
|
|
this.serialbaud = this.serialbaud || 57600;
|
|
this.databits = this.databits || 8;
|
|
this.parity = this.parity || this._("serial.label.none");
|
|
this.stopbits = this.stopbits || 1;
|
|
return this.serialport+":"+this.serialbaud+"-"+this.databits+this.parity.charAt(0).toUpperCase()+this.stopbits;
|
|
},
|
|
oneditprepare: function() {
|
|
var previous = null;
|
|
var blist = [
|
|
{value:"115200",label:"115200",hasValue:false},
|
|
{value:"57600",label:"57600",hasValue:false},
|
|
{value:"38400",label:"38400",hasValue:false},
|
|
{value:"19200",label:"19200",hasValue:false},
|
|
{value:"9600",label:"9600",hasValue:false},
|
|
{value:"4800",label:"4800",hasValue:false},
|
|
{value:"2400",label:"2400",hasValue:false},
|
|
{value:"1200",label:"1200",hasValue:false},
|
|
{value:"600",label:"600",hasValue:false},
|
|
{value:"300",label:"300",hasValue:false},
|
|
{label:"other",value:"other",icon:"red/images/typedInput/09.png",validate:/^[0-9]*$/}
|
|
];
|
|
|
|
var serialbaudType = "custom";
|
|
for (var i in blist) {
|
|
if (this.serialbaud == blist[i].value) {
|
|
serialbaudType = this.serialbaud;
|
|
}
|
|
}
|
|
|
|
$("#node-config-input-serialbaud").typedInput({
|
|
default: this.serialbaud,
|
|
types:blist
|
|
});
|
|
|
|
$("#node-config-input-out").on('focus', function () { previous = this.value; }).change(function() {
|
|
if (previous == null) { previous = $("#node-config-input-out").val(); }
|
|
if ($("#node-config-input-out").val() == "char") {
|
|
if (previous != "char") { $("#node-config-input-newline").val("\\n"); }
|
|
$("#node-units").text("");
|
|
// $("#node-config-addchar").show();
|
|
$("#tip-split").show();
|
|
$("#tip-timeout").hide();
|
|
$("#tip-silent").hide();
|
|
$("#tip-count").hide();
|
|
}
|
|
else if ($("#node-config-input-out").val() == "time") {
|
|
if (previous != "time") { $("#node-config-input-newline").val("0"); }
|
|
$("#node-units").text("ms");
|
|
// $("#node-config-addchar").hide();
|
|
// $("#node-config-input-addchar").val("false");
|
|
$("#tip-split").hide();
|
|
$("#tip-timeout").show();
|
|
$("#tip-silent").hide();
|
|
$("#tip-count").hide();
|
|
}
|
|
else if ($("#node-config-input-out").val() == "interbyte") {
|
|
if (previous != "interbyte") { $("#node-config-input-newline").val("0"); }
|
|
$("#node-units").text("ms");
|
|
// $("#node-config-addchar").hide();
|
|
// $("#node-config-input-addchar").val("false");
|
|
$("#tip-split").hide();
|
|
$("#tip-timeout").hide();
|
|
$("#tip-silent").show();
|
|
$("#tip-count").hide();
|
|
}
|
|
else {
|
|
if (previous != "count") { $("#node-config-input-newline").val(""); }
|
|
$("#node-units").text("chars");
|
|
// $("#node-config-addchar").hide();
|
|
// $("#node-config-input-addchar").val("false");
|
|
$("#tip-split").hide();
|
|
$("#tip-timeout").hide();
|
|
$("#tip-silent").hide();
|
|
$("#tip-count").show();
|
|
}
|
|
});
|
|
|
|
$("#node-config-input-responsetimeout").on('focus', function () { $("#tip-responsetimeout").show(); });
|
|
$("#node-config-input-responsetimeout").on('blur', function () { $("#tip-responsetimeout").hide(); });
|
|
$("#node-config-input-waitfor").on('focus', function () { $("#tip-waitfor").show(); });
|
|
$("#node-config-input-waitfor").on('blur', function () { $("#tip-waitfor").hide(); });
|
|
$("#node-config-input-addchar").on('focus', function () { $("#tip-addchar").show(); });
|
|
$("#node-config-input-addchar").on('blur', function () { $("#tip-addchar").hide(); });
|
|
|
|
try {
|
|
$("#node-config-input-serialport").autocomplete( "destroy" );
|
|
} catch(err) {
|
|
}
|
|
$("#node-config-lookup-serial").click(function() {
|
|
$("#node-config-lookup-serial").addClass('disabled');
|
|
$.getJSON('serialports',function(data) {
|
|
$("#node-config-lookup-serial").removeClass('disabled');
|
|
var ports = [];
|
|
$.each(data, function(i, port) {
|
|
ports.push(port.comName);
|
|
});
|
|
$("#node-config-input-serialport").autocomplete({
|
|
source:ports,
|
|
minLength:0,
|
|
close: function( event, ui ) {
|
|
$("#node-config-input-serialport").autocomplete( "destroy" );
|
|
}
|
|
}).autocomplete("search","");
|
|
});
|
|
});
|
|
},
|
|
oneditsave: function() {
|
|
var mytype = $("#node-config-input-serialbaud").typedInput('type');
|
|
if (mytype !== "other") {
|
|
$("#node-config-input-serialbaud").typedInput('value',mytype);
|
|
}
|
|
this.serialbaud = $("#node-config-input-serialbaud").typedInput('value');
|
|
}
|
|
});
|
|
</script>
|