frodovdr/node-red-nodes
1
0
Fork 0
mirror of https://github.com/node-red/node-red-nodes.git synced 2023-10-10 13:36:58 +02:00
Code Issues Releases Wiki Activity

node-red-node-physical-web: added documentation and exposed count property.

Browse Source
This commit is contained in:
Nathanaël Lécaudé 2016-03-14 17:30:50 -04:00
parent 71f9d3ad98
commit 6d41d33e80
2 changed files with 25 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
hardware/physical-web/physical-web.html
View File

@ -79,7 +79,7 @@
<script type="text/x-red" data-template-name="PhysicalWeb out">
<div class="form-row">
<label for="node-input-mode"><i class="fa fa-wrench"></i> <span>Mode</span></label>
<select id="node-input-mode" style='width:250px'>
<select id="node-input-mode" style='width:100px'>
<option value="url">url</option>
<option value="uid">uid</option>
</select>
@ -100,9 +100,13 @@
<input type="text" id="node-input-instance" style="width:250px;">
</div>
<div class="form-row">
<label for="node-input-period"><i class="fa fa-repeat"></i> Period (S)</label>
<label for="node-input-period"><i class="fa fa-repeat"></i> Period</label>
<input type="text" id="node-input-period" style="width:80px;" placeholder="Period">
</div>
<div class="form-row">
<label for="node-input-count"><i class="fa fa-repeat"></i> Count</label>
<input type="text" id="node-input-count" style="width:80px;" placeholder="Count">
</div>
<div class="form-row">
<label for="node-input-power"><i class="fa fa-battery-half"></i> Power (dB)</label>
<input type="text" id="node-input-power" style="width:80px;" placeholder="Power">
@ -116,11 +120,20 @@
<script type="text/x-red" data-help-name="PhysicalWeb out">
<p><a href="https://google.github.io/physical-web/">Physical Web</a> beacon node.</p>
<p>This node can take the value of <code>msg.payload</code> and publishes it as an Eddystone URL
<p>This node can be set to URL mode or UID mode</p>
<p>In <strong>URL mode</strong> this node can take the value of <code>msg.payload</code> and publishes it as an Eddystone URL
announcement. URLs <b>must</b> be less than 18 bytes long, so should be run through a shortner first.</p>
<p>You can also preset the URL, in which case the node does not require any input.</p>
<p>The config window will allow you to set the powerlevel (-30 to 100 db) and the period (S)
between anouncements.</p>
<p>In <strong>UID mode</strong> this node can take the 10 bytes namespace (as an HEX string) as <code>msg.payload</code>
and the 6 bytes instance (as an HEX string) as <code>msg.topic</code>.
<p>The config window will allow you to set the powerlevel (-30 to 100 db) and the TLM count and period values.</p>
<p>TLM stands for telemetry data and is a type of packet sent alongside the main packet that provides diagnostics information.
The count and period determine the ratio of TLM packets sent versus normal packets.
A period of 10 and a count of 2 means that 2 TLM packets are sent for each 10 advertisements.</p>
<p>The actual advertisement rate can be set by changing the <code>BLENO_ADVERTISING_INTERVAL</code> environment variable.
For example, to set a 20ms interval, you would need to type <code>sudo BLENO_ADVERTISING_INTERVAL=20 node-red</code></p>
<p>Linux users should <a href="https://github.com/sandeepmistry/bleno#running-on-linux" target="_new">READ THIS</a>.</p>
</script>
@ -134,7 +147,8 @@
namespace: {value:""},
instance: {value:""},
power: {value:"-21",validate:RED.validators.number()},
period: {value:"1",validate:RED.validators.number()}
period: {value:"10",validate:RED.validators.number()},
count: {value:"2",validate:RED.validators.number()}
},
color: "#2F7ACD",
inputs:1,
@ -147,7 +161,8 @@
return this.name?"node_label_italic":"";
},
oneditprepare: function() {
$( "#node-input-period" ).spinner({min:1});
$( "#node-input-period" ).spinner({min:0});
$( "#node-input-count" ).spinner({min:0});
$( "#node-input-power" ).spinner({min:-30,max:100});
$("#node-input-mode").on("change",function() {
if ($("#node-input-mode").val() === "uid") {

5
hardware/physical-web/physical-web.js
View File

@ -25,7 +25,8 @@ module.exports = function(RED) {
var node = this;
node.mode = n.mode;
node.power = n.power;
node.period = n.period * 10;
node.period = n.period;
node.count = n.count;
node.url = n.url;
node.namespace = n.namespace;
node.instance = n.instance;
@ -33,7 +34,7 @@ module.exports = function(RED) {
node.options = {
txPowerLevel: node.power,
tlmPeriod: node.period,
tlmCount: 2
tlmCount: node.count
};
if (node.mode === "url" && node.url) {