frodovdr/node-red-nodes
1
0
Fork 0
mirror of https://github.com/node-red/node-red-nodes.git synced 2025-03-01 10:37:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update PiFace README

Browse Source 
to include instructions to make it work on Jessie etc.
This commit is contained in:
Dave Conway-Jones
2015-12-20 11:39:59 +00:00
parent 97d7eea4bc
commit 5568238058
2 changed files with 30 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
hardware/PiFace/README.md
View File

@@ -1,7 +1,9 @@
node-red-node-piface node-red-node-piface
==================== ====================
<a href="http://nodered.org" target="_new">Node-RED</a> nodes to control a <a href="http://www.piface.org.uk/products/piface_digital/" target="_new">PiFace Digital</a> add-on board for a Raspberry-Pi. <a href="http://nodered.org" target="_new">Node-RED</a> nodes to control a
<a href="http://www.piface.org.uk/products/piface_digital/" target="_new">PiFace Digital</a>
add-on board for a Raspberry-Pi.
Install Install
------- -------
@@ -14,23 +16,41 @@ Run the following command in the root directory of your Node-RED install
Pre-reqs Pre-reqs
-------- --------
Requires the WiringPi gpio command to be installed in order to work. See the <a href="http://wiringpi.com" target="new">WiringPi site</a> for details on how to do this. Device Tree **must** be turned off. To do this run
sudo raspi-config
then select the `Advanced Options`, then `Device Tree`, and finally select `No`
and `OK`. You will then need to reboot.
It also requires the WiringPi gpio command to be installed in order to work.
See the <a href="http://wiringpi.com" target="new">WiringPi site</a>
for details on how to do this. The short version is...
sudo apt-get install git-core
git clone git://git.drogon.net/wiringPi
cd wiringPi
git pull origin
./build
Usage Usage
----- -----
A pair of input and output Node-RED nodes for the Raspberry Pi PiFace Digital add-on board. A pair of input and output Node-RED nodes for the Raspberry Pi PiFace Digital
add-on board.
###Output ### Output
The PiFace output node will set the selected relay, LED, or pin on or off depending on the value passed in. Expects a <b>msg.payload</b> with either a 1 or 0 (or true or false). The PiFace output node will set the selected relay, LED, or pin on or off
depending on the value passed in. Expects a <b>msg.payload</b> with either a
1 or 0 (or true or false).
Requires the WiringPi gpio command in order to work (see pre-reqs). Requires the WiringPi gpio command in order to work (see pre-reqs).
###Input ### Input
The PiFace input node generates a <b>msg.payload</b> with either a 0 or 1 depending on the state of the input pin. The PiFace input node generates a <b>msg.payload</b> with either a 0 or 1
depending on the state of the input pin.
You may also enable the input pullup resistor if required. You may also enable the input pullup resistor if required.
@@ -38,4 +58,5 @@ The <b>msg.topic</b> is set to <i>piface/{the pin number}</i>
Requires the WiringPi gpio command in order to work (see pre-reqs). Requires the WiringPi gpio command in order to work (see pre-reqs).
<b>Note:</b> This node currently polls the pin every 250mS. This is not ideal as it loads the cpu. <b>Note:</b> This node currently polls the pin every 250mS. This is not ideal
as it loads the cpu.

2
hardware/PiFace/package.json
View File

@@ -1,6 +1,6 @@
{ {
"name" : "node-red-node-piface", "name" : "node-red-node-piface",
"version" : "0.0.3", "version" : "0.0.4",
"description" : "Node-RED nodes to read from and write to a PiFace Digital Raspberry Pi add-on board", "description" : "Node-RED nodes to read from and write to a PiFace Digital Raspberry Pi add-on board",
"dependencies" : { "dependencies" : {
}, },