diff --git a/hardware/PiLcd/LICENSE b/hardware/PiLcd/LICENSE new file mode 100644 index 00000000..f433b1a5 --- /dev/null +++ b/hardware/PiLcd/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/PiLcd/README.md b/hardware/PiLcd/README.md new file mode 100644 index 00000000..385d75e7 --- /dev/null +++ b/hardware/PiLcd/README.md @@ -0,0 +1,42 @@ +node-red-node-pilcd +=================== + +A Node-RED node for a Raspberry Pi +to write to a GPIO connected HD44780 style LCD panels. + +Install +------- + +Run the following command in the root directory of your Node-RED install. +This is normally `~/.node-red` + + npm install node-red-node-pilcd + +Usage +----- + +Raspberry Pi output to HD44780 style LCD module - typically 1, 2, or 4 lines. + +It must be configured with a comma separated list of pins that are wired to the LCD panel. +Pins MUST be a comma separated list of the 6 GPIO connector +pin numbers that are connected to the RS, E, D4, D5, D6 and D7 pins of the LCD. e.g. + + 26,24,22,18,16,12 + +Send the node a **msg.payload** with a string in it. + +Strings for the 2nd line of the display must start **2:** - the third start **3:** - and the fourth **4:** - For example + + 2:I'm on line two + 4:and this is on line 4 + 1:or indeed line 1 + +The `1:` is not necessary for line one but is there if you build lines using a template, + +To clear the display send the string `clr:` + +It is up to you to manage string lengths to suit the display. + +Requires the RPi.GPIO python library version 0.5.8 (or better) in order to work. + +**Note:** we are using the actual physical pin numbers on connector P1 as they are easier to locate. diff --git a/hardware/PiLcd/nrlcd b/hardware/PiLcd/nrlcd new file mode 100755 index 00000000..d6258bed --- /dev/null +++ b/hardware/PiLcd/nrlcd @@ -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/nrlcd.py $@ diff --git a/hardware/PiLcd/nrlcd.py b/hardware/PiLcd/nrlcd.py new file mode 100644 index 00000000..623372da --- /dev/null +++ b/hardware/PiLcd/nrlcd.py @@ -0,0 +1,184 @@ +#!/usr/bin/python +# +# HD44780 LCD Test Script for +# Raspberry Pi +# +# Original Author : Matt Hawkins +# Site : http://www.raspberrypi-spy.co.uk +# 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) + +# Define initial Pins to LCD mapping +LCD_RS = 26 +LCD_E = 24 +LCD_D4 = 22 +LCD_D5 = 18 +LCD_D6 = 16 +LCD_D7 = 12 + +# Define some device constants +LCD_WIDTH = 20 # Maximum characters per line +LCD_CHR = True +LCD_CMD = False + +LCD_LINE_1 = 0x80 # LCD RAM address for the 1st line +LCD_LINE_2 = 0xC0 # LCD RAM address for the 2nd line +LCD_LINE_3 = 0xA0 # LCD RAM address for the 3rd line +LCD_LINE_4 = 0xE0 # LCD RAM address for the 4th line + +# Timing constants +E_PULSE = 0.00005 +E_DELAY = 0.00005 + +def lcd_init(): + # Initialise display + lcd_byte(0x33,LCD_CMD) + lcd_byte(0x32,LCD_CMD) + lcd_byte(0x28,LCD_CMD) + lcd_byte(0x0C,LCD_CMD) + lcd_byte(0x06,LCD_CMD) + lcd_byte(0x01,LCD_CMD) + +def lcd_string(message): + # Send string to display + message = message.ljust(LCD_WIDTH," ") + for i in range(LCD_WIDTH): + lcd_byte(ord(message[i]),LCD_CHR) + +def lcd_byte(bits, mode): + # Send byte to data pins + # bits = data + # mode = True for character + # False for command + GPIO.output(LCD_RS, mode) # RS + + # High bits + GPIO.output(LCD_D4, False) + GPIO.output(LCD_D5, False) + GPIO.output(LCD_D6, False) + GPIO.output(LCD_D7, False) + if bits&0x10==0x10: + GPIO.output(LCD_D4, True) + if bits&0x20==0x20: + GPIO.output(LCD_D5, True) + if bits&0x40==0x40: + GPIO.output(LCD_D6, True) + if bits&0x80==0x80: + GPIO.output(LCD_D7, True) + + # Toggle 'Enable' pin + time.sleep(E_DELAY) + GPIO.output(LCD_E, True) + time.sleep(E_PULSE) + GPIO.output(LCD_E, False) + time.sleep(E_DELAY) + + # Low bits + GPIO.output(LCD_D4, False) + GPIO.output(LCD_D5, False) + GPIO.output(LCD_D6, False) + GPIO.output(LCD_D7, False) + if bits&0x01==0x01: + GPIO.output(LCD_D4, True) + if bits&0x02==0x02: + GPIO.output(LCD_D5, True) + if bits&0x04==0x04: + GPIO.output(LCD_D6, True) + if bits&0x08==0x08: + GPIO.output(LCD_D7, True) + + # Toggle 'Enable' pin + time.sleep(E_DELAY) + GPIO.output(LCD_E, True) + time.sleep(E_PULSE) + GPIO.output(LCD_E, False) + time.sleep(E_DELAY) + +# Main program loop +if len(sys.argv) > 1: + pins = sys.argv[1].lower().split(',') + if len(pins) != 6: + print "Bad number of pins supplied" + print " "+pins + sys.exit(0) + + LCD_RS = int(pins[0]) + LCD_E = int(pins[1]) + LCD_D4 = int(pins[2]) + LCD_D5 = int(pins[3]) + LCD_D6 = int(pins[4]) + LCD_D7 = int(pins[5]) + + GPIO.setmode(GPIO.BOARD) # Use GPIO BOARD numbers + GPIO.setup(LCD_RS, GPIO.OUT) # RS + GPIO.setup(LCD_E, GPIO.OUT) # E + GPIO.setup(LCD_D4, GPIO.OUT) # DB4 + GPIO.setup(LCD_D5, GPIO.OUT) # DB5 + GPIO.setup(LCD_D6, GPIO.OUT) # DB6 + GPIO.setup(LCD_D7, GPIO.OUT) # DB7 + + # Initialise display + lcd_init() + + # Send some test + lcd_byte(LCD_LINE_1, LCD_CMD) + lcd_string("Node-RED") + lcd_byte(LCD_LINE_2, LCD_CMD) + lcd_string("LCD online") + time.sleep(2) # 2 second delay + lcd_byte(0x01,LCD_CMD) + + # 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: + data = raw_input() + data = data.rstrip("\r\n\t") + if data == "c:lose": # cleanup and exit + GPIO.cleanup(LCD_RS) + GPIO.cleanup(LCD_E) + GPIO.cleanup(LCD_D4) + GPIO.cleanup(LCD_D5) + GPIO.cleanup(LCD_D6) + GPIO.cleanup(LCD_D7) + sys.exit(0) + elif data == "clr:": # clear the display + lcd_init() + elif data.startswith("1:"): + lcd_byte(LCD_LINE_1, LCD_CMD) + lcd_string(data[2:]) + elif data.startswith("2:"): + lcd_byte(LCD_LINE_2, LCD_CMD) + lcd_string(data[2:]) + elif data.startswith("3:"): + lcd_byte(LCD_LINE_3, LCD_CMD) + lcd_string(data[2:]) + elif data.startswith("4:"): + lcd_byte(LCD_LINE_4, LCD_CMD) + lcd_string(data[2:]) + else: # default to line 1 + lcd_byte(LCD_LINE_1, LCD_CMD) + lcd_string(data) + except EOFError: # hopefully always caused by us sigint'ing the program + GPIO.cleanup(LCD_RS) + GPIO.cleanup(LCD_E) + GPIO.cleanup(LCD_D4) + GPIO.cleanup(LCD_D5) + GPIO.cleanup(LCD_D6) + GPIO.cleanup(LCD_D7) + sys.exit(0) + +else: + print "Bad params" + print " sudo nrlcd.py RS,E,D4,D5,D6,D7" + sys.exit(0) diff --git a/hardware/PiLcd/package.json b/hardware/PiLcd/package.json new file mode 100644 index 00000000..90923e5d --- /dev/null +++ b/hardware/PiLcd/package.json @@ -0,0 +1,23 @@ +{ + "name" : "node-red-node-pilcd", + "version" : "0.0.1", + "description" : "A Node-RED node for Raspberry Pi to write to HD44780 style LCD panels.", + "dependencies" : { + }, + "repository" : { + "type":"git", + "url":"https://github.com/node-red/node-red-nodes/tree/master/hardware/PiLcd" + }, + "license": "Apache-2.0", + "keywords": [ "node-red", "lcd", "HD44780" ], + "node-red" : { + "nodes" : { + "rpi-lcd": "pilcd.js" + } + }, + "author": { + "name": "Dave Conway-Jones", + "email": "ceejay@vnet.ibm.com", + "url": "http://nodered.org" + } +} diff --git a/hardware/PiLcd/pilcd.html b/hardware/PiLcd/pilcd.html new file mode 100644 index 00000000..87dab382 --- /dev/null +++ b/hardware/PiLcd/pilcd.html @@ -0,0 +1,60 @@ + + + + + + + diff --git a/hardware/PiLcd/pilcd.js b/hardware/PiLcd/pilcd.js new file mode 100644 index 00000000..7a556fbd --- /dev/null +++ b/hardware/PiLcd/pilcd.js @@ -0,0 +1,103 @@ +/** + * 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 + '/nrlcd'; + + 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-lcd] 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-lcd] Error : " + gpioCommand + " needs to be executable."); + throw "Error : " + gpioCommand + " must to be executable."; + } + + function PiLcdNode(n) { + RED.nodes.createNode(this, n); + this.pins = n.pins; + var node = this; + + function inputlistener(msg) { + var out = msg.payload.toString(); + if (RED.settings.verbose) { node.log("inp: " + msg.payload); } + if (node.child !== null) { node.child.stdin.write(msg.payload + "\n"); } + else { node.warn("Command not running"); } + } + + if (node.pins !== undefined) { + node.child = spawn(gpioCommand, [node.pins]); + node.running = true; + if (RED.settings.verbose) { node.log("pin: " + node.pins + " :"); } + 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) { + 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) { + delete pinsInUse[node.pin]; + if (node.child != null) { + node.child.stdin.write("c:lose" + node.pin); + node.child.kill('SIGKILL'); + } + wfi(done); + }); + + } + RED.nodes.registerType("rpi-lcd", PiLcdNode); +}