mirror of
https://github.com/node-red/node-red.git
synced 2023-10-10 13:36:53 +02:00
New UDP node to go with updated TCP node - includes multicast support
This commit is contained in:
Dave C-J
parent
ee92967efa
commit
9741c36fdb
176
nodes/io/32-udp.html
Normal file
176
nodes/io/32-udp.html
Normal file
@ -0,0 +1,176 @@
|
|||||||
|
<!--
|
||||||
|
Copyright 2013 IBM Corp.
|
||||||
|
|
||||||
|
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.
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!-- The Input Node -->
|
||||||
|
<script type="text/x-red" data-template-name="udp in">
|
||||||
|
<div class="form-row">
|
||||||
|
<label for="node-input-port"><i class="icon-inbox"></i> Listen</label>
|
||||||
|
on port <input type="text" id="node-input-port" placeholder="Port" style="width: 45px">
|
||||||
|
for <select id="node-input-multicast" style='width:40%'>
|
||||||
|
<option value="false">udp messages</option>
|
||||||
|
<option value="true">multicast messages</option>
|
||||||
|
</select>
|
||||||
|
</div>
|
||||||
|
<div class="form-row node-input-group">
|
||||||
|
<label for="node-input-group"><i class="icon-list"></i> Group</label>
|
||||||
|
<input type="text" id="node-input-group" placeholder="225.0.18.83">
|
||||||
|
</div>
|
||||||
|
<div class="form-row node-input-iface">
|
||||||
|
<label for="node-input-iface"><i class="icon-random"></i> Interface</label>
|
||||||
|
<input type="text" id="node-input-iface" placeholder="eth0">
|
||||||
|
</div>
|
||||||
|
<div class="form-row">
|
||||||
|
<label for="node-input-datatype"><i class="icon-file"></i> Output</label>
|
||||||
|
<select id="node-input-datatype" style="width: 70%;">
|
||||||
|
<option value="buffer">a Buffer</option>
|
||||||
|
<option value="utf8">a String</option>
|
||||||
|
<option value="base64">a Base64 encoded string</option>
|
||||||
|
</select>
|
||||||
|
</div>
|
||||||
|
<div class="form-row">
|
||||||
|
<label for="node-input-name"><i class="icon-tag"></i> Name</label>
|
||||||
|
<input type="text" id="node-input-name" placeholder="Name">
|
||||||
|
</div>
|
||||||
|
<div class="form-tips">Tip: Make sure your firewall will allow the data in.</div>
|
||||||
|
<script>
|
||||||
|
$("#node-input-multicast").change(function() {
|
||||||
|
var id = $("#node-input-multicast option:selected").val();
|
||||||
|
if (id == "false") {
|
||||||
|
$(".node-input-group").hide();
|
||||||
|
$(".node-input-iface").hide();
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$(".node-input-group").show();
|
||||||
|
$(".node-input-iface").show();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<script type="text/x-red" data-help-name="udp in">
|
||||||
|
<p>A udp input node, that produces a <b>msg.payload</b> containing a <i>BUFFER</i>, string, or base64 encoded string. Supports multicast.</p>
|
||||||
|
<p>It also provides <b>msg.fromip</b> in the form ipaddress:port .</p>
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<script type="text/javascript">
|
||||||
|
RED.nodes.registerType('udp in',{
|
||||||
|
category: 'input',
|
||||||
|
color:"Silver",
|
||||||
|
defaults: {
|
||||||
|
name: {value:""},
|
||||||
|
host: {value:""},
|
||||||
|
iface: {value:""},
|
||||||
|
port: {value:"",required:true,validate:RED.validators.number()},
|
||||||
|
datatype: {value:"buffer",required:true},
|
||||||
|
multicast: {value:"false"},
|
||||||
|
group: {value:"",validate:function(v) { return (this.multicast !== "true")||v.length > 0;} }
|
||||||
|
},
|
||||||
|
inputs:0,
|
||||||
|
outputs:1,
|
||||||
|
icon: "bridge-dash.png",
|
||||||
|
label: function() {
|
||||||
|
if (this.multicast=="false") {
|
||||||
|
return this.name||"udp "+this.port;
|
||||||
|
}
|
||||||
|
else return this.name||"udp "+(this.group+":"+this.port);
|
||||||
|
},
|
||||||
|
labelStyle: function() {
|
||||||
|
return this.name?"node_label_italic":"";
|
||||||
|
}
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- The Output Node -->
|
||||||
|
<script type="text/x-red" data-template-name="udp out">
|
||||||
|
<div class="form-row">
|
||||||
|
<label for="node-input-port"><i class="icon-envelope"></i> Send a</label>
|
||||||
|
<select id="node-input-multicast" style='width:40%'>
|
||||||
|
<option value="false">udp message</option>
|
||||||
|
<option value="broad">broadcast message</option>
|
||||||
|
<option value="multi">multicast message</option>
|
||||||
|
</select>
|
||||||
|
to port <input type="text" id="node-input-port" placeholder="Port" style="width: 45px">
|
||||||
|
</div>
|
||||||
|
<div class="form-row node-input-addr">
|
||||||
|
<label for="node-input-addr" id="node-input-addr-label"><i class="icon-list"></i> Address</label>
|
||||||
|
<input type="text" id="node-input-addr" placeholder="destination ip" style="width: 70%;">
|
||||||
|
</div>
|
||||||
|
<div class="form-row node-input-iface">
|
||||||
|
<label for="node-input-iface"><i class="icon-random"></i> Interface</label>
|
||||||
|
<input type="text" id="node-input-iface" placeholder="eth0">
|
||||||
|
</div>
|
||||||
|
<div class="form-row">
|
||||||
|
<label> </label>
|
||||||
|
<input type="checkbox" id="node-input-base64" placeholder="base64" style="display: inline-block; width: auto; vertical-align: top;">
|
||||||
|
<label for="node-input-base64" style="width: 70%;">Decode Base64 encoded payload ?</label>
|
||||||
|
</div>
|
||||||
|
<div class="form-row">
|
||||||
|
<label for="node-input-name"><i class="icon-tag"></i> Name</label>
|
||||||
|
<input type="text" id="node-input-name" placeholder="Name">
|
||||||
|
</div>
|
||||||
|
<script>
|
||||||
|
$("#node-input-multicast").change(function() {
|
||||||
|
var id = $("#node-input-multicast option:selected").val();
|
||||||
|
console.log(id,$("#node-input-addr")[0].placeholder);
|
||||||
|
if (id !== "multi") {
|
||||||
|
$(".node-input-iface").hide();
|
||||||
|
$("#node-input-addr-label").html('<i class="icon-list"></i> Address');
|
||||||
|
$("#node-input-addr")[0].placeholder = 'destination ip';
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$(".node-input-iface").show();
|
||||||
|
$("#node-input-addr-label").html('<i class="icon-list"></i> Group');
|
||||||
|
$("#node-input-addr")[0].placeholder = '225.0.18.83';
|
||||||
|
}
|
||||||
|
if (id === "broad") {
|
||||||
|
$("#node-input-addr")[0].placeholder = '255.255.255.255';
|
||||||
|
}
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<script type="text/x-red" data-help-name="udp out">
|
||||||
|
<p>This node sends <b>msg.payload</b> to the designated udp host and port. Supports multicast.</p>
|
||||||
|
<p>If you select broadcast either set the address to the local broadcast ip address, or maybe try 255.255.255.255, which is the global broadcast address.</p>
|
||||||
|
<p>On some systems you may need to be root to use broadcast.</p>
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<script type="text/javascript">
|
||||||
|
RED.nodes.registerType('udp out',{
|
||||||
|
category: 'output',
|
||||||
|
color:"Silver",
|
||||||
|
defaults: {
|
||||||
|
name: {value:""},
|
||||||
|
addr: {value:"",required:true},
|
||||||
|
//group: {value:""},
|
||||||
|
iface: {value:""},
|
||||||
|
port: {value:"",required:true,validate:RED.validators.number()},
|
||||||
|
base64: {value:false,required:true},
|
||||||
|
multicast: {value:"false"}
|
||||||
|
},
|
||||||
|
inputs:1,
|
||||||
|
outputs:0,
|
||||||
|
icon: "bridge-dash.png",
|
||||||
|
align: "right",
|
||||||
|
label: function() {
|
||||||
|
return this.name||"udp "+(this.addr+":"+this.port);
|
||||||
|
},
|
||||||
|
labelStyle: function() {
|
||||||
|
return this.name?"node_label_italic":"";
|
||||||
|
}
|
||||||
|
});
|
||||||
|
</script>
|
||||||
115
nodes/io/32-udp.js
Normal file
115
nodes/io/32-udp.js
Normal file
@ -0,0 +1,115 @@
|
|||||||
|
/**
|
||||||
|
* Copyright 2013 IBM Corp.
|
||||||
|
*
|
||||||
|
* 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.
|
||||||
|
**/
|
||||||
|
|
||||||
|
var RED = require("../../red/red");
|
||||||
|
var dgram = require('dgram');
|
||||||
|
|
||||||
|
// The Input Node
|
||||||
|
function UDPin(n) {
|
||||||
|
RED.nodes.createNode(this,n);
|
||||||
|
this.group = n.group;
|
||||||
|
this.port = n.port;
|
||||||
|
this.host = n.host || null;
|
||||||
|
this.datatype = n.datatype;
|
||||||
|
this.iface = n.iface || null;
|
||||||
|
this.multicast = n.multicast;
|
||||||
|
var node = this;
|
||||||
|
|
||||||
|
var server = dgram.createSocket('udp4');
|
||||||
|
|
||||||
|
server.on("error", function (err) {
|
||||||
|
console.log("udp listener error:\n" + err.stack);
|
||||||
|
server.close();
|
||||||
|
});
|
||||||
|
|
||||||
|
server.on('message', function (message, remote) {
|
||||||
|
var msg;
|
||||||
|
if (node.datatype =="base64") { msg = { payload:message.toString('base64'), fromip:remote.address+':'+remote.port }; }
|
||||||
|
else if (node.datatype =="utf8") { msg = { payload:message.toString('utf8'), fromip:remote.address+':'+remote.port }; }
|
||||||
|
else { msg = { payload:message, fromip:remote.address+':'+remote.port }; }
|
||||||
|
node.send(msg);
|
||||||
|
});
|
||||||
|
|
||||||
|
server.on('listening', function () {
|
||||||
|
var address = server.address();
|
||||||
|
node.log('udp listener at ' + address.address + ":" + address.port);
|
||||||
|
if (node.multicast == "true") {
|
||||||
|
server.setBroadcast(true)
|
||||||
|
server.setMulticastTTL(128);
|
||||||
|
server.addMembership(node.group,node.iface);
|
||||||
|
node.log("udp multicast group "+node.group);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
node.on("close", function() {
|
||||||
|
try {
|
||||||
|
server.close();
|
||||||
|
node.log('udp listener stopped');
|
||||||
|
}
|
||||||
|
catch (err) { console.log(err); }
|
||||||
|
});
|
||||||
|
|
||||||
|
server.bind(node.port,node.host);
|
||||||
|
}
|
||||||
|
RED.nodes.registerType("udp in",UDPin);
|
||||||
|
|
||||||
|
|
||||||
|
// The Output Node
|
||||||
|
function UDPout(n) {
|
||||||
|
RED.nodes.createNode(this,n);
|
||||||
|
//this.group = n.group;
|
||||||
|
this.port = n.port;
|
||||||
|
this.base64 = n.base64;
|
||||||
|
this.addr = n.addr;
|
||||||
|
this.iface = n.iface || null;
|
||||||
|
this.multicast = n.multicast;
|
||||||
|
var node = this;
|
||||||
|
|
||||||
|
var sock = dgram.createSocket('udp4'); // only use ipv4 for now
|
||||||
|
sock.bind(node.port); // have to bind before you can enable broadcast...
|
||||||
|
if (this.multicast != "false") {
|
||||||
|
sock.setBroadcast(true); // turn on broadcast
|
||||||
|
if (this.multicast == "multi") {
|
||||||
|
sock.setMulticastTTL(128);
|
||||||
|
sock.addMembership(node.addr,node.iface); // Add to the multicast group
|
||||||
|
node.log('udp multicast ready : '+node.addr+":"+node.port);
|
||||||
|
}
|
||||||
|
else node.log('udp broadcast ready : '+node.addr+":"+node.port);
|
||||||
|
}
|
||||||
|
else node.log('udp ready : '+node.addr+":"+node.port);
|
||||||
|
|
||||||
|
node.on("input", function(msg) {
|
||||||
|
if (msg.payload != null) {
|
||||||
|
//console.log("UDP:",msg.payload);
|
||||||
|
var message;
|
||||||
|
if (node.base64) { message = new Buffer(b64string, 'base64'); }
|
||||||
|
else { message = new Buffer(""+msg.payload); }
|
||||||
|
console.log("UDP send :",node.addr,node.port);
|
||||||
|
sock.send(message, 0, message.length, node.port, node.addr, function(err, bytes) {
|
||||||
|
if (err) node.error("udp : "+err);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
node.on("close", function() {
|
||||||
|
try {
|
||||||
|
sock.close();
|
||||||
|
node.log('udp output stopped');
|
||||||
|
}
|
||||||
|
catch (err) { console.log(err); }
|
||||||
|
});
|
||||||
|
}
|
||||||
|
RED.nodes.registerType("udp out",UDPout);
|
||||||
Loading…
Reference in New Issue
Block a user