1
0
mirror of https://github.com/node-red/node-red-nodes.git synced 2023-10-10 13:36:58 +02:00

Physical-web: Added status (found, updated and lost) as msg.topic (#206)

Added msg.advertising = true/false to enable/disable advertising
Added status (lost, updated, found) as msg.topic, if not already set
Added checkbox to allow duplicates or not.

* Re-added optional topic to avoid breaking compatibility

* Cleaner topic slection
This commit is contained in:
Nathanaël Lécaudé 2016-05-20 11:00:52 -04:00 committed by Dave Conway-Jones
parent b23cf0b788
commit 966e7a520b
3 changed files with 48 additions and 33 deletions

View File

@ -1,6 +1,6 @@
{ {
"name": "node-red-node-physical-web", "name": "node-red-node-physical-web",
"version": "0.0.12", "version": "0.0.13",
"description": "Node-RED nodes to interact with the Physical Web", "description": "Node-RED nodes to interact with the Physical Web",
"main": "physical-web.js", "main": "physical-web.js",
"scripts": { "scripts": {

View File

@ -15,7 +15,11 @@
<label for="node-input-topic"><i class="fa fa-tasks"></i> Topic</label> <label for="node-input-topic"><i class="fa fa-tasks"></i> Topic</label>
<input type="text" id="node-input-topic" placeholder="eddystone"> <input type="text" id="node-input-topic" placeholder="eddystone">
</div> </div>
<br/> <div class="form-row">
<label><i class="fa fa-list"></i> Duplicates</span></label>
<input type="checkbox" id="node-input-duplicates" style="display: inline-block; width: auto; vertical-align: top;">
Check this to allow duplicate messages
</div>
<div class="form-row"> <div class="form-row">
<label for="node-input-name"><i class="fa fa-tag"></i> Name</label> <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
<input type="text" id="node-input-name" placeholder="Name"> <input type="text" id="node-input-name" placeholder="Name">
@ -24,33 +28,35 @@
<script type="text/x-red" data-help-name="PhysicalWeb in"> <script type="text/x-red" data-help-name="PhysicalWeb in">
<p><a href="https://google.github.io/physical-web/">Physical Web</a> node to scan for Eddystone beacons.</p> <p><a href="https://google.github.io/physical-web/">Physical Web</a> node to scan for Eddystone beacons.</p>
<p>This node scans for Eddystones and publishes what it finds. It can output 2 types of `msg.payload`</p> <p>This node scans for Eddystones and publishes what it finds. The status of the Eddystone
<p>Either a <b>URL</b> type:</p> (found, updated or lost) will be sent as <code>msg.topic</code> and the data as <code>msg.payload</code></p>
<p>If a <code>topic</code> is specified in the node configuration, it will override the status.</p>
<p><b>URL</b> type:</p>
<ul> <ul>
<li>`type` - Eddystone type</li> <li><code>type</code> - Eddystone type</li>
<li>`txPower` - Received power at 0m in dBm</li> <li><code>txPower</code> - Received power at 0m in dBm</li>
<li>`url` - The URL the beacon is broadcasting</li> <li><code>url</code> - The URL the beacon is broadcasting</li>
<li>`tlm` - TLM data, if the device is interleaving broadcasts</li> <li><code>tlm</code> - TLM data, if the device is interleaving broadcasts</li>
<li>`rssi` - RSSI of the beacon</li> <li><code>rssi</code> - RSSI of the beacon</li>
<li>`distance` - Estimated distance to the beacon</li> <li><code>distance</code> - Estimated distance to the beacon</li>
</ul> </ul>
<p>or a <b>UID</b> type:</p> <p><b>UID</b> type:</p>
<ul> <ul>
<li>`type` - Eddystone type</li> <li><code>type</code> - Eddystone type</li>
<li>`txPower` - Received power at 0m in dBm</li> <li><code>txPower</code> - Received power at 0m in dBm</li>
<li>`namespace` - 10-byte ID of namspace</li> <li><code>namespace</code> - 10-byte ID of namspace</li>
<li>`instance` - 6-byte ID insance</li> <li><code>instance</code> - 6-byte ID insance</li>
<li>`rssi` - RSSI of the beacon</li> <li><code>rssi</code> - RSSI of the beacon</li>
<li>`distance` - Estimated distance to the beacon</li> <li><code>distance</code> - Estimated distance to the beacon</li>
<li>`tlm` - TLM data, if the device is interleaving broadcasts</li> <li><code>tlm</code> - TLM data, if the device is interleaving broadcasts</li>
</ul> </ul>
<p>Where the `tlm` data will be an object containing:</p> <p>Where the <code>tlm</code> data will be an object containing:</p>
<ul> <ul>
<li>`version` - TML version</li> <li><code>version</code> - TML version</li>
<li>`vbatt` - Battery Voltage</li> <li><code>vbatt</code> - Battery Voltage</li>
<li>`temp` - Temperature</li> <li><code>temp</code> - Temperature</li>
<li>`advCnt` - Advertising PDU count</li> <li><code>advCnt</code> - Advertising PDU count</li>
<li>`secCnt` - Time since power on or reboot</li> <li><code>secCnt</code> - Time since power on or reboot</li>
</ul> </ul>
</ul> </ul>
<p>Linux users should <a href="https://github.com/sandeepmistry/bleno#running-on-linux" target="_new">READ THIS</a>.</p> <p>Linux users should <a href="https://github.com/sandeepmistry/bleno#running-on-linux" target="_new">READ THIS</a>.</p>
@ -61,7 +67,8 @@
category: 'input', category: 'input',
defaults: { defaults: {
name: {value:""}, name: {value:""},
topic: {value:"eddystone"} topic: {value:""},
duplicates: {value: true}
}, },
color: "#2F7ACD", color: "#2F7ACD",
inputs:0, inputs:0,

View File

@ -184,26 +184,34 @@ module.exports = function(RED) {
RED.nodes.createNode(this,n); RED.nodes.createNode(this,n);
var node = this; var node = this;
node.topic = n.topic; node.topic = n.topic;
node.duplicates = n.duplicates;
function onFound(beacon) { function onFound(beacon) {
node.send({ node.send({topic: node.topic || 'found', payload: beacon});
topic: node.topic, }
payload: beacon
}); function onUpdated(beacon) {
node.send({topic: node.topic || 'updated', payload: beacon});
}
function onLost(beacon) {
node.send({topic: node.topic || 'lost', payload: beacon});
} }
EddystoneBeaconScanner.on('found', onFound); EddystoneBeaconScanner.on('found', onFound);
EddystoneBeaconScanner.on('updated', onFound); EddystoneBeaconScanner.on('updated', onUpdated);
EddystoneBeaconScanner.on('lost', onLost);
node.on('close',function(done) { node.on('close',function(done) {
EddystoneBeaconScanner.removeListener('found', onFound); EddystoneBeaconScanner.removeListener('found', onFound);
EddystoneBeaconScanner.removeListener('updated', onFound); EddystoneBeaconScanner.removeListener('updated', onUpdated);
EddystoneBeaconScanner.removeListener('lost', onLost);
done(); done();
}); });
var tout = setTimeout(function() { var tout = setTimeout(function() {
EddystoneBeaconScanner.startScanning(true); EddystoneBeaconScanner.startScanning(node.duplicates);
},2000); }, 2000);
node.on("close", function(done) { node.on("close", function(done) {