diff --git a/README.md b/README.md index 6336cabc..e78ad545 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,8 @@ Copyright 2013, 2016 IBM Corp. under [the Apache 2.0 license](LICENSE). **node-red-node-intel-galileo** - *[mraa-spio](hardware/intel)* - A collection of analogue & digital input & output nodes for the Intel Galileo and Edison. +**node-red-node-pi-mcp3008** - *[pimcp3008](hardware/mcp3008)* - Allows A Raspberry Pi to node to read from an MCP3008 Analogue to Digital Converter chip via the SPI bus. + **node-red-node-pi-neopixel** - *[neopixel](hardware/neopixel)* - Allows A Raspberry Pi to drive a strip of NeoPixels directly. **node-red-node-pi-unicorn-hat** - *[unicorn](hardware/unicorn)* - Lets a Raspbeery Pi control a Pimorini Unicorn HAT 8x8 LED display. diff --git a/hardware/mcp3008/.DS_Store b/hardware/mcp3008/.DS_Store new file mode 100644 index 00000000..5008ddfc Binary files /dev/null and b/hardware/mcp3008/.DS_Store differ diff --git a/hardware/mcp3008/LICENSE b/hardware/mcp3008/LICENSE new file mode 100644 index 00000000..f433b1a5 --- /dev/null +++ b/hardware/mcp3008/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/mcp3008/README.md b/hardware/mcp3008/README.md new file mode 100644 index 00000000..96dae7e3 --- /dev/null +++ b/hardware/mcp3008/README.md @@ -0,0 +1,38 @@ +node-red-node-pi-mcp3008 +======================== + +A Node-RED node to read from +the MCP3008 Analogue to Digital Converter, +such as the Rasp.io analogzero, though it will work with breadboard versions also. + +**Warning**: Input voltages must not exceed 3.3V + +### Pre-requisites + +You must ensure that SPI is enabled. For recent (2016) versions of Raspbian you can do this + + - Run `sudo raspi-config` + - Select `9 - Advanced Options` + - Select `A5 - SPI` + - Select `yes` to enable SPI + - Select `OK` to confirm + - Select the `Finish` button + +### Install + +Run the following command in your Node-RED user directory - typically `~/.node-red` + + npm install node-red-node-pi-mcp3008 + +### Usage + +Reads from an MCP3008 Analogue to Digital (ADC) chip on the Pi SPI CE0 connection. + +You can either set a channel in the edit dialogue, or you can set the `msg.payload` to +select the channel dynamically. If so then the payload must be a value from 0 to 7. + +Outputs a numeric `msg.payload` with a range of 0 to 1023, where 0 = 0V and 1023 = 3.3V (assuming you use the default 3.3V voltage reference). + +**Hint**: use a `range` node to adjust the values to the range you want. + +Also sets `msg.topic` to `adc/{the pin number}` diff --git a/hardware/mcp3008/package.json b/hardware/mcp3008/package.json new file mode 100644 index 00000000..722daf57 --- /dev/null +++ b/hardware/mcp3008/package.json @@ -0,0 +1,24 @@ +{ + "name" : "node-red-node-pi-mcp3008", + "version" : "0.0.2", + "description" : "A Node-RED node to read from the MCP3008 Analogue to Digital Converter", + "dependencies" : { + "mcp-spi-adc": "^0.0.1" + }, + "repository" : { + "type":"git", + "url":"https://github.com/node-red/node-red-nodes/tree/master/hardware" + }, + "license": "Apache-2.0", + "keywords": [ "node-red", "pi", "adc", "mcp3008" ], + "node-red" : { + "nodes" : { + "pimcp3008": "pimcp3008.js" + } + }, + "author": { + "name": "Dave Conway-Jones", + "email": "conway@uk.ibm.com", + "url": "http://nodered.org" + } +} diff --git a/hardware/mcp3008/pimcp3008.html b/hardware/mcp3008/pimcp3008.html new file mode 100644 index 00000000..b4794392 --- /dev/null +++ b/hardware/mcp3008/pimcp3008.html @@ -0,0 +1,71 @@ + + + + + + + + diff --git a/hardware/mcp3008/pimcp3008.js b/hardware/mcp3008/pimcp3008.js new file mode 100644 index 00000000..6cc34591 --- /dev/null +++ b/hardware/mcp3008/pimcp3008.js @@ -0,0 +1,76 @@ +/** + * Copyright 2016 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 fs = require('fs'); + // unlikely if not on a Pi + try { fs.statSync("/dev/ttyAMA0"); } + catch(err) { throw "Info : Ignoring Raspberry Pi specific node"; } + + var mcpadc = require('mcp-spi-adc'); + var mcp3008 = []; + + function PiMcpNode(n) { + RED.nodes.createNode(this,n); + this.pin = n.pin || 0; + this.interval = n.interval || 1000; + var node = this; + + try { + fs.statSync("/dev/spidev0.0"); + if (mcp3008.length === 0) { + for (var i=0; i<8; i++) { + mcp3008.push(mcpadc.open(i, function (err) { + if (err) { node.error("Error: "+err); } + })); + } + } + node.on("input", function(msg) { + var pin = null; + if (node.pin === "M") { + var pay = parseInt(msg.payload.toString()); + if ((pay >= 0) && (pay <= 7)) { pin = pay; } + else { node.warn("Payload needs to select channel 0 to 7"); } + } + else { pin = parseInt(node.pin); } + if (pin !== null) { + mcp3008[pin].read(function (err, reading) { + if (err) { node.warn("Read error: "+err); } + else { node.send({payload:reading.rawValue, topic:"adc/"+pin}); } + }); + } + }); + + } + catch(err) { + node.error("Error : Can't find SPI device - is SPI enabled in raspi-config ?"); + } + + node.on("close", function(done) { + if (mcp3008.length !== 0) { + var j=0; + for (var i=0; i<8; i++) { + mcp3008[i].close(function() { j += 1; if (j === 8) {done()} }); + } + mcp3008 = []; + } + else { done(); } + }); + } + + RED.nodes.registerType("pimcp3008",PiMcpNode); +} diff --git a/package.json b/package.json index dd4dcfc9..2fe474bf 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name" : "node-red-nodes", - "version" : "0.0.5", + "version" : "0.0.6", "description" : "Node-RED-nodes package to hold the test framework ONLY - use npm to install individual nodes", "homepage" : "http://nodered.org", "license" : "Apache-2.0", @@ -18,24 +18,24 @@ ], "devDependencies": { "grunt": "^0.4.5", - "grunt-simple-mocha": "0.4.1", - "grunt-contrib-jshint": "1.0.0", - "grunt-lint-inline": "0.4.4", - "grunt-jscs": "2.8.0", + "grunt-simple-mocha": "^0.4.1", + "grunt-contrib-jshint": "^1.0.0", + "grunt-lint-inline": "^0.4.4", + "grunt-jscs": "^2.8.0", "mocha": "^2.4.5", "should": "^8.3.1", "sinon": "^1.17.3", "supertest": "^1.2.0", - "proxyquire": "1.7.4", - "pushbullet": "1.4.*", + "proxyquire": "^1.7.10", + "pushbullet": "^1.4.0", "when": "^3.7.7", - "exif": "0.6.0", - "ngeohash": "0.6.*", - "nodemailer" : "1.11.*", - "poplib" : "0.1.7", - "mailparser" : "0.5.3", - "imap" : "0.8.17", - "msgpack-js": "0.3.0" + "exif": "^0.6.0", + "ngeohash": "^0.6.0", + "nodemailer" : "^1.11.0", + "poplib" : "^0.1.7", + "mailparser" : "^0.5.3", + "imap" : "^0.8.18", + "msgpack-js": "^0.3.0" }, "engines": { "node": ">=0.10"