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

Delay/Range node help tidy up

This commit is contained in:
Nick O'Leary 2017-05-26 14:27:53 +01:00
parent ac31957707
commit b44e70115b
No known key found for this signature in database
GPG Key ID: 4F2157149161A6C9
2 changed files with 9 additions and 5 deletions

View File

@ -106,6 +106,9 @@
<dd>Sets the delay, in milliseconds, to be applied to the message. This <dd>Sets the delay, in milliseconds, to be applied to the message. This
option only applies if the node is configured to allow the message to option only applies if the node is configured to allow the message to
provide the delay interval.</dd> provide the delay interval.</dd>
<dt class="optional">reset</dt>
<dd>If the received message has this property set to any value, all
outstanding messages held by the node are cleared without being sent.</dd>
</dl> </dl>
<h3>Details</h3> <h3>Details</h3>
<p>When configured to delay messages, the delay interval can be a fixed value <p>When configured to delay messages, the delay interval can be a fixed value

View File

@ -33,24 +33,25 @@
</script> </script>
<script type="text/x-red" data-help-name="range"> <script type="text/x-red" data-help-name="range">
<p>A simple function node to remap numeric input values to another scale.</p> <p>Maps a numeric value to a different range.</p>
<h3>Inputs</h3> <h3>Inputs</h3>
<dl class="message-properties"> <dl class="message-properties">
<dt>payload <span class="property-type">number</span></dt> <dt>payload <span class="property-type">number</span></dt>
<dd>the input payload <i>must</i> be a number. Anything else will try to be <dd>The payload <i>must</i> be a number. Anything else will try to be
parsed into a number and rejected if that fails.</dd> parsed into a number and rejected if that fails.</dd>
</dl> </dl>
<h3>Outputs</h3> <h3>Outputs</h3>
<dl class="message-properties"> <dl class="message-properties">
<dt>payload <span class="property-type">number</span></dt> <dt>payload <span class="property-type">number</span></dt>
<dd>the output payload will always be a numeric type..</dd> <dd>The value mapped to the new range.</dd>
</dl> </dl>
<h3>Details</h3> <h3>Details</h3>
<p>Currently only does a linear scaling.</p> <p>This node will linearly scale the received value. By default, the result
is not constrained to the range defined in the node.</p>
<p><i>Scale and limit to target range</i> means that the result will never be outside <p><i>Scale and limit to target range</i> means that the result will never be outside
the range specified within the result range.</p> the range specified within the result range.</p>
<p><i>Scale and wrap within the target range</i> means that the result will <p><i>Scale and wrap within the target range</i> means that the result will
be a "modulo-style" wrap-around within the result range.</p> be wrapped within the result range.</p>
</script> </script>
<script type="text/javascript"> <script type="text/javascript">