update hardware nodes info style

This commit is contained in:
Dave Conway-Jones
2016-03-02 13:25:52 +00:00
parent 88985f4fe7
commit 81c532fdce
42 changed files with 130 additions and 125 deletions

View File

@@ -58,9 +58,10 @@
</script>
<script type="text/x-red" data-help-name="rpi-piface in">
<p>Raspberry Pi PiFace input node. Generates a <b>msg.payload</b> with either a 0 or 1 depending on the state of the input pin.</p>
<p>Raspberry Pi PiFace input node. Generates a <code>msg.payload</code> with either a 0 or 1 depending
on the state of the input pin.</p>
<p>You may also enable the input pullup resistor if required.</p>
<p>The <b>msg.topic</b> is set to <i>piface/{the pin number}</i></p>
<p>The <code>msg.topic</code> is set to <i>piface/{the pin number}</i></p>
<p>Requires the WiringPi gpio command in order to work.</p>
<p><b>Note:</b> This node currently polls the pin every 250mS. This is not ideal as it loads the cpu.</p>
<p><b>Note:</b> Some versions of the PiFace relabelled the switch inputs to be 0 - 7 instead of 1 - 8.
@@ -127,7 +128,7 @@
<script type="text/x-red" data-help-name="rpi-piface out">
<p>Raspberry Pi PiFace output node. The PiFace board must be fitted.</p>
<p>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).</p>
<p>Will set the selected relay, LED, or pin on or off depending on the value passed in. Expects a <code>msg.payload</code> with either a 1 or 0 (or true or false).</p>
<p>Requires the WiringPi gpio command in order to work.</p>
</script>

View File

@@ -12,7 +12,7 @@ We cannot automatically detect this so the user will have to apply some common s
Install
-------
Run the following command in the root directory of your Node-RED install
Run the following command in your Node-RED user directory - typically `~/.node-red`
npm install node-red-node-piface
@@ -46,19 +46,19 @@ add-on board.
### 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
depending on the value passed in. Expects a `msg.payload` with either a
1 or 0 (or true or false).
Requires the WiringPi gpio command in order to work (see pre-reqs).
### Input
The PiFace input node generates a <b>msg.payload</b> with either a 0 or 1
The PiFace input node generates a `msg.payload` with either a 0 or 1
depending on the state of the input pin.
You may also enable the input pullup resistor if required.
The <b>msg.topic</b> is set to <i>piface/{the pin number}</i>
The `msg.topic` is set to <i>piface/{the pin number}</i>
Requires the WiringPi gpio command in order to work (see pre-reqs).

View File

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