diff --git a/hardware/PiSrf/LICENSE b/hardware/PiSrf/LICENSE new file mode 100644 index 00000000..f433b1a5 --- /dev/null +++ b/hardware/PiSrf/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/PiSrf/README.md b/hardware/PiSrf/README.md new file mode 100644 index 00000000..961faba8 --- /dev/null +++ b/hardware/PiSrf/README.md @@ -0,0 +1,31 @@ +node-red-node-pisrf +=================== + +A Node-RED node for Raspberry Pi +to read range from an SRF05 Ultrasonic range sensor. + +**Only** works with a Raspberry Pi. + +Install +------- + +Run the following command in the root directory of your Node-RED install. +This is usually `~/.node-red` + + npm install node-red-node-pisrf + +Usage +----- + +Raspberry Pi input from an SRF04 or SRF05 ultrasonic range finder. + +The configuartion requires two GPIO pin numbers, the trigger pin and the echo pin. +These can be any spare valid Pi GPIO pins. e.g. + + 7,11 + +Outputs a msg.payload with a number representing the range in cm. + +Produces one measure every 0.5s - but only if the distance is different from the previous reading. + +**Note:** we are using the actual physical pin numbers on connector P1 as they are easier to locate. diff --git a/hardware/PiSrf/nrsrf b/hardware/PiSrf/nrsrf new file mode 100755 index 00000000..346b9db4 --- /dev/null +++ b/hardware/PiSrf/nrsrf @@ -0,0 +1,16 @@ +# +# Copyright 2015 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. +# + +BASEDIR=$(dirname $0) +sudo python -u $BASEDIR/nrsrf.py $@ diff --git a/hardware/PiSrf/nrsrf.py b/hardware/PiSrf/nrsrf.py new file mode 100755 index 00000000..c80d4a1e --- /dev/null +++ b/hardware/PiSrf/nrsrf.py @@ -0,0 +1,91 @@ +#!/usr/bin/python +# +# Copyright 2015 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. + +# Python driver for SRF04 and SRO05 Ultrasonic sensors +# Modified to use PINS not BCM : Dave Conway-Jones + +#import +import RPi.GPIO as GPIO +import time +import sys +import os, select + +# Turn off warnings if you run it a second time... +GPIO.setwarnings(False) + +ECHO = 0 +TRIGGER = 0 +OLD = 0 + +def Measure(): + start = 0 + realstart = 0 + realstart = time.time() + GPIO.output(TRIGGER, True) + time.sleep(0.00001) + GPIO.output(TRIGGER, False) + start = time.time() + while GPIO.input(ECHO)==0: + start = time.time() + Dif = time.time() - realstart + if Dif > 0.2: + print("Ultrasonic Sensor Timed out, Restarting.") + time.sleep(0.4) + Main() + while GPIO.input(ECHO)==1: + stop = time.time() + elapsed = stop-start + distance = (elapsed * 36000)/2 + + return distance + + +# Main program loop +if len(sys.argv) > 1: + pins = sys.argv[1].lower().split(',') + if len(pins) != 2: + print "Bad number of pins supplied" + print pins + sys.exit(0) + + TRIGGER = int(pins[0]) + ECHO = int(pins[1]) + + GPIO.setmode(GPIO.BOARD) # Use GPIO BOARD numbers + GPIO.setup(TRIGGER, GPIO.OUT) # Trigger + GPIO.setup(ECHO, GPIO.OUT) # Echo + GPIO.output(ECHO, False) + GPIO.setup(ECHO,GPIO.IN) + + # Flush stdin so we start clean + while len(select.select([sys.stdin.fileno()], [], [], 0.0)[0])>0: + os.read(sys.stdin.fileno(), 4096) + + while True: + try: + distance = int( Measure() + 0.5 ) + if distance != OLD: + print(distance) + OLD = distance + time.sleep(0.5) + except: # try to clean up on exit + print("0.0"); + GPIO.cleanup(TRIGGER) + GPIO.cleanup(ECHO) + sys.exit(0) + +else: + print "Bad params" + print " sudo nrsrf.py trigger_pin,echo_pin" + sys.exit(0) diff --git a/hardware/PiSrf/package.json b/hardware/PiSrf/package.json new file mode 100644 index 00000000..1c28216f --- /dev/null +++ b/hardware/PiSrf/package.json @@ -0,0 +1,23 @@ +{ + "name" : "node-red-node-pisrf", + "version" : "0.0.1", + "description" : "A Node-RED node for a Raspberry Pi to use a SRF04 or SRF05 range finder", + "dependencies" : { + }, + "repository" : { + "type":"git", + "url":"https://github.com/node-red/node-red-nodes/tree/master/hardware/PiSrf" + }, + "license": "Apache-2.0", + "keywords": [ "node-red", "SRF04", "SRF05", "ultrasonic", "range" ], + "node-red" : { + "nodes" : { + "rpi-srf": "pisrf.js" + } + }, + "author": { + "name": "Dave Conway-Jones", + "email": "ceejay@vnet.ibm.com", + "url": "http://nodered.org" + } +} diff --git a/hardware/PiSrf/pisrf.html b/hardware/PiSrf/pisrf.html new file mode 100644 index 00000000..00ed8036 --- /dev/null +++ b/hardware/PiSrf/pisrf.html @@ -0,0 +1,56 @@ + + + + + + + diff --git a/hardware/PiSrf/pisrf.js b/hardware/PiSrf/pisrf.js new file mode 100644 index 00000000..2fc10574 --- /dev/null +++ b/hardware/PiSrf/pisrf.js @@ -0,0 +1,97 @@ +/** + * Copyright 2015 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. + **/ + +module.exports = function(RED) { + "use strict"; + var util = require("util"); + var spawn = require('child_process').spawn; + var fs = require('fs'); + + var gpioCommand = __dirname + '/nrsrf.py'; + + if (!fs.existsSync("/dev/ttyAMA0")) { // unlikely if not on a Pi + //util.log("Info : Ignoring Raspberry Pi specific node."); + throw "Info : Ignoring Raspberry Pi specific node."; + } + + if (!fs.existsSync("/usr/share/doc/python-rpi.gpio")) { + util.log("[rpi-srf] Info : Can't find Pi RPi.GPIO python library."); + throw "Warning : Can't find Pi RPi.GPIO python library."; + } + + if (!(1 & parseInt ((fs.statSync(gpioCommand).mode & parseInt ("777", 8)).toString (8)[0]))) { + util.log("[rpi-srf] Error : " + gpioCommand + " needs to be executable."); + throw "Error : " + gpioCommand + " must to be executable."; + } + + function PiSrfNode(n) { + RED.nodes.createNode(this, n); + this.pins = n.pins; + var node = this; + + if (node.pins !== undefined) { + node.child = spawn(gpioCommand, [node.pins]); + node.running = true; + if (RED.settings.verbose) { node.log("pin: " + node.pins + " :"); } + + node.child.stdout.on('data', function(data) { + if (RED.settings.verbose) { node.log("out: " + data + " :"); } + data = data.toString().trim(); + if (data.length > 0) { + node.send({topic:"SRF",payload:data}); + } + }); + + node.child.stderr.on('data', function(data) { + if (RED.settings.verbose) { node.log("err: " + data + " :"); } + }); + + node.child.on('close', function(code) { + if (RED.settings.verbose) { node.log("ret: " + code + " :"); } + node.child = null; + node.running = false; + }); + + node.child.on('error', function(err) { + if (err.errno === "ENOENT") { node.warn('Command not found'); } + else if (err.errno === "EACCES") { node.warn('Command not executable'); } + else { node.log('error: ' + err); } + }); + + } + else { + node.error("Invalid GPIO pins: " + node.pin); + } + + var wfi = function(done) { + if (!node.running) { + if (RED.settings.verbose) { node.log("end"); } + done(); + return; + } + setTimeout(function() { wfi(done); }, 333); + } + + node.on("close", function(done) { + if (node.child != null) { + node.child.kill('SIGKILL'); + } + wfi(done); + }); + + } + RED.nodes.registerType("rpi-srf", PiSrfNode); +}