From ff8f95066bc96ce972fe8add9b72ba77f4fd98bc Mon Sep 17 00:00:00 2001 From: Dave Conway-Jones Date: Mon, 11 Jan 2016 21:21:54 +0000 Subject: [PATCH] Add Pi Unicorn Hat node --- hardware/unicorn/LICENSE | 177 ++++++++++++++++++++ hardware/unicorn/README.md | 48 ++++++ hardware/unicorn/package.json | 27 +++ hardware/unicorn/scripts/checklib.js | 13 ++ hardware/unicorn/unicorn.html | 69 ++++++++ hardware/unicorn/unicorn.js | 241 +++++++++++++++++++++++++++ hardware/unicorn/unihat | 17 ++ hardware/unicorn/unihat.py | 46 +++++ 8 files changed, 638 insertions(+) create mode 100644 hardware/unicorn/LICENSE create mode 100644 hardware/unicorn/README.md create mode 100644 hardware/unicorn/package.json create mode 100755 hardware/unicorn/scripts/checklib.js create mode 100644 hardware/unicorn/unicorn.html create mode 100644 hardware/unicorn/unicorn.js create mode 100755 hardware/unicorn/unihat create mode 100755 hardware/unicorn/unihat.py diff --git a/hardware/unicorn/LICENSE b/hardware/unicorn/LICENSE new file mode 100644 index 00000000..f433b1a5 --- /dev/null +++ b/hardware/unicorn/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/unicorn/README.md b/hardware/unicorn/README.md new file mode 100644 index 00000000..127890e9 --- /dev/null +++ b/hardware/unicorn/README.md @@ -0,0 +1,48 @@ +node-red-node-pi-unicorn-hat +============================ + +A Node-RED node to output to a +Raspberry Pi Unicorn HAT from Pimorini. + +Pre-requisites +-------------- + +The Unicorn HAT python drivers need to be pre-installed... see the + +Pimorini Getting Started with Unicorn HAT page. + + curl -sS get.pimoroni.com/unicornhat | bash + +Install +------- + +Run the following command in the root directory of your Node-RED install. +Usually this is `~/.node-red` + + npm install node-red-node-pi-unicorn-hat + +Usage +----- + +The background of the array can be configured using an 8x8 pixel sized +png image, or by specifying a single colour using an r,g,b triple. + +The brightness can also be set in the configuration. Defaults to 20% so as not to blind you. + +A pixel is set by **msg.payload** with a CSV string `x,y,r,g,b` , where x and y are 0 to 7, and r, g and b are 0 - 255. +If `x` or `y` are set to `*` then the complete row or column can be set. +Setting both `x` and `y` to `*` fills the background. + +The background can also be set to a colour by setting **msg.payload** to an r,g,b triple. + +Any msg with a **msg.topic** identifies a 'sprite' pixel, which can then be moved independently of the background. + +Setting **msg.payload** to `0` will delete the sprite from the list. + +Setting **msg.payload** to `DEL` delete any sprites - leaving the background. + +Setting **msg.payload** to `CLS` will clear the display to off and delete any sprites. + +The overall brightness may be set by setting **msg.payload** to `brightness,nn`, where `nn` is 0 to 100. + +The rotation may be set by setting ••msg.payload•• to 'rotate,rr', where 'rr' is 0, 90, 180 or 270.

diff --git a/hardware/unicorn/package.json b/hardware/unicorn/package.json new file mode 100644 index 00000000..caf16680 --- /dev/null +++ b/hardware/unicorn/package.json @@ -0,0 +1,27 @@ +{ + "name" : "node-red-node-pi-unicorn-hat", + "version" : "0.0.1", + "description" : "A Node-RED node to output to a Raspberry Pi Unicorn HAT from Pimorini.", + "dependencies" : { + "pngjs": "2.2.*" + }, + "repository" : { + "type":"git", + "url":"https://github.com/node-red/node-red-nodes/tree/master/hardware/unicorn" + }, + "license": "Apache-2.0", + "keywords": [ "node-red", "unicorn", "pimorini" ], + "node-red" : { + "nodes" : { + "unicorn": "unicorn.js" + } + }, + "scripts" : { + "postinstall" : "scripts/checklib.js" + }, + "author": { + "name": "Dave Conway-Jones", + "email": "ceejay@vnet.ibm.com", + "url": "http://nodered.org" + } +} diff --git a/hardware/unicorn/scripts/checklib.js b/hardware/unicorn/scripts/checklib.js new file mode 100755 index 00000000..bd19f8c0 --- /dev/null +++ b/hardware/unicorn/scripts/checklib.js @@ -0,0 +1,13 @@ +#!/usr/bin/env node +var fs = require('fs'); + +if (!fs.existsSync('/usr/local/lib/python2.7/dist-packages/unicornhat.py')) { + console.warn("WARNING : Can't find unicorn.py python library"); + console.warn("WARNING : Please install using the following command"); + console.warn("WARNING : Note: this uses root..."); + console.warn("WARNING : curl -sS get.pimoroni.com/unicornhat | bash\n"); + //process.exit(1); +} +else { + console.log("Unicorn Hat Python library found OK.\n") +} diff --git a/hardware/unicorn/unicorn.html b/hardware/unicorn/unicorn.html new file mode 100644 index 00000000..9007f53a --- /dev/null +++ b/hardware/unicorn/unicorn.html @@ -0,0 +1,69 @@ + + + + + + + diff --git a/hardware/unicorn/unicorn.js b/hardware/unicorn/unicorn.js new file mode 100644 index 00000000..e47ab981 --- /dev/null +++ b/hardware/unicorn/unicorn.js @@ -0,0 +1,241 @@ +/** + * 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 spawn = require('child_process').spawn; + var fs = require('fs'); + var PNG = require('pngjs').PNG; + + var hatCommand = __dirname+'/unihat'; + + if (!fs.existsSync("/dev/ttyAMA0")) { // unlikely if not on a Pi + //RED.log.info(RED._("rpi-gpio.errors.ignorenode")); + throw "Info : "+RED._("rpi-gpio.errors.ignorenode"); + } + + if (!fs.existsSync('/usr/local/lib/python2.7/dist-packages/unicornhat.py')) { + RED.log.warn("Can't find Unicorn HAT python libraries"); + throw "Warning : Can't find Unicorn HAT python libraries"; + } + + if ( !(1 & parseInt ((fs.statSync(hatCommand).mode & parseInt ("777", 8)).toString (8)[0]) )) { + RED.log.error(hatCommand + " command is not executable"); + throw "Error : "+RED._("rpi-gpio.errors.mustbeexecutable"); + } + + // the magic to make python print stuff immediately + process.env.PYTHONUNBUFFERED = 1; + + function UnicornHatNode(n) { + RED.nodes.createNode(this,n); + this.png = n.png; + this.bright = n.bright || 20; + this.items = {}; + var node = this; + + var pic = new Buffer(192); + pic.fill(0); + var ready = false; + if (node.png) { + if (node.png.split(",").length === 3) { + var c = node.png.split(","); + for (var i=0; i<192; i++) { + pic[i] = c[0]; + pic[i+1] = c[1]; + pic[i+2] = c[2]; + i += 2; + } + ready = true; + } + else { + try { + var file = fs.readFileSync(node.png); + new PNG().parse( file, function(error, data) { + if (error) { + node.warn("error reading : "+node.png); + ready = true; + } + else { + var pix = data.data; + var j=0; + for (var i=0; i<192; i++) { + pic[i] = pix[j]; + pic[i+1] = pix[j+1]; + pic[i+2] = pix[j+2]; + i += 2; + j += 4; + } + ready = true; + } + }); + } + catch(e) { + node.warn("error loading : "+node.png); + ready = true; + } + } + } + else { ready = true; } + + function inputlistener(msg) { + var s = msg.payload.toUpperCase().split(","); + if (s.length === 1) { + if (s[0] == "CLS") { + //console.log("CLEAR") + pic.fill(0); + node.items = {}; + } + if (s[0] == "DEL") { + //console.log("DELETE") + node.items = {}; + } + } + else if (s.length === 2) { + if (s[0] === "BRIGHTNESS") { + //console.log("BRIGHTNESS",s[1]) + node.child.stdin.write("B"+s[1]+"\n"); + } + if (s[0] === "ROTATE") { + //console.log("ROTATE",s[1]) + node.child.stdin.write("R"+s[1]+"\n"); + } + } + else if (s.length === 3) { + //console.log("BACKGROUND",s) + for (var i=0; i<192; i++) { + pic[i] = s[0]; + pic[i+1] = s[1]; + pic[i+2] = s[2]; + i += 2; + } + } + else if (s.length === 5) { + if (msg.topic) { + node.items[msg.topic] = msg.payload; + } + else { + //console.log("PIXEL",b); + if ((s[0] === "*") && (s[1] === "*")) { + for (var c=0; c<192; c++) { + pic[c] = s[2]; + pic[c+1] = s[3]; + pic[c+2] = s[4]; + c += 2; + } + } + else if (s[0] === "*") { + for (var d=0; d<8; d++) { + pic[d*3+s[1]*24] = s[2]; + pic[d*3+s[1]*24+1] = s[3]; + pic[d*3+s[1]*24+2] = s[4]; + } + } + else if (s[1] === "*") { + for (var e=0; e<8; e++) { + pic[s[0]*3+e*24] = s[2]; + pic[s[0]*3+e*24+1] = s[3]; + pic[s[0]*3+e*24+2] = s[4]; + } + } + else { + pic[s[0]*3+s[1]*24] = s[2]; + pic[s[0]*3+s[1]*24+1] = s[3]; + pic[s[0]*3+s[1]*24+2] = s[4]; + } + } + } + else { + if (node.items.hasOwnProperty(msg.topic)) { delete node.items[msg.topic]; } + } + + var pixels = new Buffer(192); + pic.copy(pixels); + for (var p in node.items) { + var b = node.items[p].split(","); + if (b[0] === "*") { + for (var d=0; d<8; d++) { + pixels[d*3+b[1]*24] = b[2]; + pixels[d*3+b[1]*24+1] = b[3]; + pixels[d*3+b[1]*24+2] = b[4]; + } + } + else if (b[1] === "*") { + for (var e=0; e<8; e++) { + pixels[b[0]*3+e*24] = b[2]; + pixels[b[0]*3+e*24+1] = b[3]; + pixels[b[0]*3+e*24+2] = b[4]; + } + } + else { + pixels[b[0]*3+b[1]*24] = b[2]; + pixels[b[0]*3+b[1]*24+1] = b[3]; + pixels[b[0]*3+b[1]*24+2] = b[4]; + } + } + node.child.stdin.write(pixels); + node.child.stdin.write("\n"); + } + + node.child = spawn(hatCommand, [node.bright]); + node.status({fill:"green",shape:"dot",text:"ok"}); + + node.on("input", inputlistener); + + node.child.stdout.on('data', function (data) { + if (RED.settings.verbose) { node.log("out: "+data+" :"); } + }); + + node.child.stderr.on('data', function (data) { + if (RED.settings.verbose) { node.log("err: "+data+" :"); } + }); + + node.child.on('close', function (code) { + node.child = null; + if (RED.settings.verbose) { node.log(RED._("rpi-gpio.status.closed")); } + if (node.done) { + node.status({fill:"grey",shape:"ring",text:"closed"}); + node.done(); + } + else { node.status({fill:"red",shape:"ring",text:"stopped"}); } + }); + + node.child.on('error', function (err) { + if (err.errno === "ENOENT") { node.error(RED._("rpi-gpio.errors.commandnotfound")); } + else if (err.errno === "EACCES") { node.error(RED._("rpi-gpio.errors.commandnotexecutable")); } + else { node.error(RED._("rpi-gpio.errors.error")+': ' + err.errno); } + }); + + node.on("close", function(done) { + node.status({fill:"grey",shape:"ring",text:"closed"}); + if (node.tout) { clearTimeout(tout); } + if (node.child != null) { + node.done = done; + node.child.kill('SIGKILL'); + } + else { done(); } + }); + + var nowready = function() { + node.tout = setTimeout( function() { + if (ready) { inputlistener({payload:"0"}); } + else { nowready(); } + }, 100); + } + nowready(); + } + RED.nodes.registerType("rpi-unicorn",UnicornHatNode); +} diff --git a/hardware/unicorn/unihat b/hardware/unicorn/unihat new file mode 100755 index 00000000..8d618d27 --- /dev/null +++ b/hardware/unicorn/unihat @@ -0,0 +1,17 @@ +#!/bin/bash +# +# 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. +# + +BASEDIR=$(dirname $0) +sudo python -u $BASEDIR/unihat.py $@ diff --git a/hardware/unicorn/unihat.py b/hardware/unicorn/unihat.py new file mode 100755 index 00000000..377138eb --- /dev/null +++ b/hardware/unicorn/unihat.py @@ -0,0 +1,46 @@ +#!/usr/bin/python +# +# 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. +# + +# Import library functions we need +import sys +import os +import unicornhat as UH + +if sys.version_info >= (3,0): + print("Sorry - currently only configured to work with python 2.x") + sys.exit(1) + +brightness = float(sys.argv[1])/100 +UH.off() +UH.brightness(brightness) + +while True: + try: + data = raw_input() + if len(data) < 20: + if data[0] == "B": + UH.brightness(float(data[1:])/100) + if data[0] == "R": + UH.rotation(float(data[1:])) + else: + q = 0 + for p in range(64): + UH.set_pixel(p%8,int(p/8),ord(data[q]),ord(data[q+1]),ord(data[q+2])) + q+=3 + UH.show() + except (EOFError, SystemExit): # hopefully always caused by us sigint'ing the program + sys.exit(0) + except Exception as ex: + print "bad data: "+data