From 7da9f46c65ead6b816eb2bd1bc5172ff16885a4b Mon Sep 17 00:00:00 2001 From: Dave Conway-Jones Date: Wed, 2 Mar 2016 21:57:53 +0000 Subject: [PATCH] Update physical web node add more Pi instructions --- hardware/physical-web/LICENSE | 177 ++++++++++++++++++++++++ hardware/physical-web/README.md | 23 ++- hardware/physical-web/package.json | 2 +- hardware/physical-web/physical-web.html | 95 ++++++------- hardware/physical-web/physical-web.js | 19 ++- 5 files changed, 249 insertions(+), 67 deletions(-) create mode 100644 hardware/physical-web/LICENSE diff --git a/hardware/physical-web/LICENSE b/hardware/physical-web/LICENSE new file mode 100644 index 00000000..f433b1a5 --- /dev/null +++ b/hardware/physical-web/LICENSE @@ -0,0 +1,177 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/hardware/physical-web/README.md b/hardware/physical-web/README.md index a5e6eefb..24fa9bbc 100644 --- a/hardware/physical-web/README.md +++ b/hardware/physical-web/README.md @@ -3,12 +3,29 @@ node-red-node-physical-web Nodes to allow Node-RED to act as an Eddystone BLE beacon. +Prerequisites +------------- + +You will need a suitable Bluetooth Low Energy (BLE) stack and drivers for your hardware +- for example Bluez 5.2.x or better. + +#### Raspberry Pi + +Install Bluetooth drivers and bluez stack, and set executeable by non-root user + + sudo apt-get install libbluetooth-dev libudev-dev pi-bluetooth + sudo setcap cap_net_raw+eip $(eval readlink -f `which node`) + +#### Linux / OSX / Windows + +Follow **just** the pre-reqs for [noble here](https://github.com/sandeepmistry/noble). + Install ------- Run the following command in your Node-RED user directory - typically `~/.node-red` - npm install node-red-node-physical-web + npm i node-red-node-physical-web Then on Linux follow these instructions: @@ -24,9 +41,9 @@ A node to allow Node-RED to act as an Eddystone beacon broadcasting URLs The config window lets you set the initial URL, announcement power and period for the Eddystone. -Any messages received will update the advertised URL from the msg.payload +Any messages received will update the advertised URL from the `msg.payload` -## Physical-Web In +### Physical-Web In A node to scan for local Eddystones and output information about discovered URLs and TLM data. diff --git a/hardware/physical-web/package.json b/hardware/physical-web/package.json index 3305a851..ca2e12d5 100644 --- a/hardware/physical-web/package.json +++ b/hardware/physical-web/package.json @@ -1,6 +1,6 @@ { "name": "node-red-node-physical-web", - "version": "0.0.5", + "version": "0.0.6", "description": "A set of nodes to interact with the Phyical Web", "main": "physical-web.js", "scripts": { diff --git a/hardware/physical-web/physical-web.html b/hardware/physical-web/physical-web.html index e09d84e1..71630fa6 100644 --- a/hardware/physical-web/physical-web.html +++ b/hardware/physical-web/physical-web.html @@ -13,11 +13,9 @@ \ No newline at end of file + diff --git a/hardware/physical-web/physical-web.js b/hardware/physical-web/physical-web.js index e7b9716f..53268ffb 100644 --- a/hardware/physical-web/physical-web.js +++ b/hardware/physical-web/physical-web.js @@ -16,11 +16,10 @@ module.exports = function(RED) { "use strict"; - var eddystoneBeacon = require('eddystone-beacon'); var EddystoneBeaconScanner = require('eddystone-beacon-scanner'); - function Beacon(n){ + function Beacon(n) { RED.nodes.createNode(this,n); var node = this; node.power = n.power; @@ -33,28 +32,27 @@ module.exports = function(RED) { tlmCount: 2 } - if (node.url) { try { eddystoneBeacon.advertiseUrl(node.url, node.options); - } catch(e){ + } catch(e) { node.error('Error setting beacon URL', e); } } - node.on('input', function(msg){ + node.on('input', function(msg) { try { eddystoneBeacon.advertiseUrl(msg.payload, node.options); - } catch(e){ + } catch(e) { node.error('error updating beacon URL', e); } }); - node.on('close', function(done){ + node.on('close', function(done) { try { eddystoneBeacon.stop(); done(); - } catch(e){ + } catch(e) { node.error('error shuttingdown beacon', e); } }); @@ -62,7 +60,7 @@ module.exports = function(RED) { } RED.nodes.registerType("PhysicalWeb out", Beacon); - function Scanner(n){ + function Scanner(n) { RED.nodes.createNode(this,n); var node = this; node.topic = n.topic; @@ -77,12 +75,11 @@ module.exports = function(RED) { EddystoneBeaconScanner.on('found', onFound); EddystoneBeaconScanner.on('updated', onFound); - node.on('close',function(done){ + node.on('close',function(done) { EddystoneBeaconScanner.removeListener('found', onFound); EddystoneBeaconScanner.removeListener('updated', onFound); done(); }); } RED.nodes.registerType("PhysicalWeb in", Scanner); - };