1
0
mirror of https://github.com/node-red/node-red.git synced 2023-10-10 13:36:53 +02:00

hardware, logic, storage nodes info updates

(and udp)
This commit is contained in:
Dave Conway-Jones 2016-02-12 13:17:21 +00:00
parent 4cb45e2712
commit d69bcad028
5 changed files with 20 additions and 18 deletions

View File

@ -64,9 +64,10 @@
</script> </script>
<script type="text/x-red" data-help-name="rpi-gpio in"> <script type="text/x-red" data-help-name="rpi-gpio in">
<p>Raspberry Pi input node. Generates a <b>msg.payload</b> with either a 0 or 1 depending on the state of the input pin. Requires the gpio command to work.</p> <p>Raspberry Pi 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 or the pulldown resistor.</p> <p>You may also enable the input pullup resistor or the pulldown resistor.</p>
<p>The <b>msg.topic</b> is set to <i>pi/{the pin number}</i></p> <p>The <code>msg.topic</code> is set to <i>pi/{the pin number}</i></p>
<p>Requires the RPi.GPIO python library version 0.5.10 (or better) in order to work.</p> <p>Requires the RPi.GPIO python library version 0.5.10 (or better) in order to work.</p>
<p><b>Note:</b> we are using the actual physical pin numbers on connector P1 as they are easier to locate.</p> <p><b>Note:</b> we are using the actual physical pin numbers on connector P1 as they are easier to locate.</p>
</script> </script>
@ -203,8 +204,9 @@
</script> </script>
<script type="text/x-red" data-help-name="rpi-gpio out"> <script type="text/x-red" data-help-name="rpi-gpio out">
<p>Raspberry Pi output node. Expects a <b>msg.payload</b> with either a 0 or 1 (or true or false). Requires the gpio command to work.</p> <p>Raspberry Pi output node. Can be used in Digital, PWM or Servo modes.
<p>Will set the selected physical pin high or low depending on the value passed in.</p> <p>Digital mode expects a <code>msg.payload</code> with either a 0 or 1 (or true or false),
and will set the selected physical pin high or low depending on the value passed in.</p>
<p>The initial value of the pin at deploy time can also be set to 0 or 1.</p> <p>The initial value of the pin at deploy time can also be set to 0 or 1.</p>
<p>When using PWM mode - expects an input value of a number 0 - 100. It can be floating point.</p> <p>When using PWM mode - expects an input value of a number 0 - 100. It can be floating point.</p>
<p>PWM mode can be used to drive a servo using input values between 10 and 20 only. <p>PWM mode can be used to drive a servo using input values between 10 and 20 only.
@ -339,12 +341,12 @@
<script type="text/x-red" data-help-name="rpi-mouse"> <script type="text/x-red" data-help-name="rpi-mouse">
<p>Raspberry Pi mouse button node. Requires a USB mouse.</p> <p>Raspberry Pi mouse button node. Requires a USB mouse.</p>
<p>Generates a <b>msg.payload</b> with <p>Generates a <code>msg.payload</code> with
either a 1 or 0 when the selected mouse button is pressed and released</p> either a 1 or 0 when the selected mouse button is pressed and released</p>
<p>Also sets <b>msg.button</b> to the code value <p>Also sets <code>msg.button</code> to the code value
<ul><li>1 = left</li><li>2 = right</li><li>4 = middle</li></ul> <ul><li>1 = left</li><li>2 = right</li><li>4 = middle</li></ul>
so you can work out which button or combination was pressed.</p> so you can work out which button or combination was pressed.</p>
<p>And sets <b>msg.topic</b> to <i>pi/mouse</i>.</p> <p>And sets <code>msg.topic</code> to <i>pi/mouse</i>.</p>
</script> </script>
<script type="text/javascript"> <script type="text/javascript">
@ -381,9 +383,9 @@
<script type="text/x-red" data-help-name="rpi-keyboard"> <script type="text/x-red" data-help-name="rpi-keyboard">
<p>Raspberry Pi keyboard handling node. Requires a USB keyboard.</p> <p>Raspberry Pi keyboard handling node. Requires a USB keyboard.</p>
<p>Generates a <b>msg.payload</b> with a keycode, and <b>msg.action</b> set to <p>Generates a <code>msg.payload</code> with a keycode, and <code>msg.action</code> set to
<i>up, down</i> or <i>repeat</i> whenever a key is pressed or released.</p> <i>up, down</i> or <i>repeat</i> whenever a key is pressed or released.</p>
<p>It also sets <b>msg.topic</b> to <i>pi/key</i>.</p> <p>It also sets <code>msg.topic</code> to <i>pi/key</i>.</p>
</script> </script>
<script type="text/javascript"> <script type="text/javascript">

View File

@ -60,7 +60,7 @@
Buffer, string, or base64 encoded string. Supports multicast.</p> Buffer, string, or base64 encoded string. Supports multicast.</p>
<p>It also provides <code>msg.ip</code> and <code>msg.port</code> set to the <p>It also provides <code>msg.ip</code> and <code>msg.port</code> set to the
ip address and port from which the message was received.</p> ip address and port from which the message was received.</p>
<p>On some systems you may need to be root to use ports below 1024 and/or broadcast.</p> <p><b>Note</b>: On some systems you may need to be root to use ports below 1024 and/or broadcast.</p>
</script> </script>
<script type="text/javascript"> <script type="text/javascript">
@ -166,10 +166,9 @@
<script type="text/x-red" data-help-name="udp out"> <script type="text/x-red" data-help-name="udp out">
<p>This node sends <code>msg.payload</code> to the designated UDP host and port. Supports multicast.</p> <p>This node sends <code>msg.payload</code> to the designated UDP host and port. Supports multicast.</p>
<p>You may also use <code>msg.ip</code> and <code>msg.port</code> to set the destination values.<br/> <p>You may also use <code>msg.ip</code> and <code>msg.port</code> to set the destination values, but the statically configured values have precedence.</p>
<b>Note</b>: the statically configured values have precedence.</p>
<p>If you select broadcast either set the address to the local broadcast ip address, or maybe try 255.255.255.255, which is the global broadcast address.</p> <p>If you select broadcast either set the address to the local broadcast ip address, or maybe try 255.255.255.255, which is the global broadcast address.</p>
<p>On some systems you may need to be root to use ports below 1024 and/or broadcast.</p> <p><b>Note</b>: On some systems you may need to be root to use ports below 1024 and/or broadcast.</p>
</script> </script>
<script type="text/javascript"> <script type="text/javascript">

View File

@ -43,7 +43,7 @@
<p>When a message arrives, the selected property is evaluated against each <p>When a message arrives, the selected property is evaluated against each
of the defined rules. The message is then sent to the output of <i>all</i> of the defined rules. The message is then sent to the output of <i>all</i>
rules that pass.</p> rules that pass.</p>
<p>Note: the <i>otherwise</i> rule applies as a "not any of" the rules preceding it.</p> <p><b>Note</b>: the <i>otherwise</i> rule applies as a "not any of" the rules preceding it.</p>
</script> </script>
<script type="text/javascript"> <script type="text/javascript">

View File

@ -33,7 +33,7 @@
<script type="text/x-red" data-help-name="tail"> <script type="text/x-red" data-help-name="tail">
<p>Tails (watches for things to be added) to the configured file. (Linux/Mac ONLY)</p> <p>Tails (watches for things to be added) to the configured file. (Linux/Mac ONLY)</p>
<p>This won't work on Windows filesystems, as it relies on the tail -F command.</p> <p>This won't work on Windows filesystems, as it relies on the <b>tail -F</b> command.</p>
</script> </script>
<script type="text/javascript"> <script type="text/javascript">

View File

@ -44,11 +44,12 @@
</script> </script>
<script type="text/x-red" data-help-name="file"> <script type="text/x-red" data-help-name="file">
<p>Writes <b>msg.payload</b> to the file specified, e.g. to create a log.</p> <p>Writes <code>msg.payload</code> to the file specified, for example to create a log.</p>
<p>The filename can be configured in the node, if left blank it should be set in an incoming message on <b>msg.filename</b>.</p> <p>The filename can be configured in the node. If left blank it should be
set by <code>msg.filename</code> on the incoming message.</p>
<p>A newline is added to every message. But this can be turned off if required, for example, to allow binary files to be written.</p> <p>A newline is added to every message. But this can be turned off if required, for example, to allow binary files to be written.</p>
<p>The default behaviour is to append to the file. This can be changed to overwrite the file each time, for example if you want to output a "static" web page or report.</p> <p>The default behaviour is to append to the file. This can be changed to overwrite the file each time, for example if you want to output a "static" web page or report.</p>
<p>This node can also be configured to delete a file if required. <i>Note:</i> Using msg.delete is now deprecated.</p> <p>This node can also be configured to delete a file if required.</p>
</script> </script>
<script type="text/x-red" data-template-name="file in"> <script type="text/x-red" data-template-name="file in">