frodovdr
/
node-red-nodes
mirror of https://github.com/node-red/node-red-nodes.git
1
0
Fork 0
Code Issues Releases Wiki Activity

update analysis and utility nodes info style

This commit is contained in:
Dave Conway-Jones 2016-03-02 13:24:56 +00:00
parent eff8327971
commit 88985f4fe7
16 changed files with 33 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
analysis/swearfilter/74-swearfilter.html
View File

@ -22,7 +22,7 @@
</script>
<script type="text/x-red" data-help-name="badwords">
<p>Analyses the <b>msg.payload</b> and tries to filter out any messages containing bad swear words...</p>
<p>Analyses the <code>msg.payload</code> and tries to filter out any messages containing bad swear words...</p>
<p><b>Note:</b> this only operates on payloads of type <b>string</b>. Everything else is blocked.</p>
</script>

4
analysis/swearfilter/README.md
View File

@ -6,7 +6,7 @@ A <a href="http://nodered.org" target="_new">Node-RED</a> node that attempts to
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-badwords
@ -16,6 +16,6 @@ Usage
Uses the badwords npm to attempt to filter out messages containing swearwords.
Analyses the **msg.payload** and tries to filter out any messages containing bad swear words. If the payload contains a bad word then the whole message is blocked.
Analyses the `msg.payload` and tries to filter out any messages containing bad swear words. If the payload contains a bad word then the whole message is blocked.
**Note** : this only operates on payloads of type <b>string</b>. Everything else is blocked.

2
analysis/swearfilter/package.json
View File

@ -1,6 +1,6 @@
{
"name" : "node-red-node-badwords",
"version" : "0.0.3",
"version" : "0.0.4",
"description" : "A Node-RED node that attempts to filter out messages containing swearwords.",
"dependencies" : {
"badwords" : "0.0.3"

6
analysis/wordpos/72-wordpos.html
View File

@ -19,13 +19,13 @@
<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
<input type="text" id="node-input-name" placeholder="Name">
</div>
<div class="form-tips">Adds <b>msg.pos</b> as the anaylsis result.
<div class="form-tips">Adds <code>msg.pos</code> as the anaylsis result.
</div>
</script>
<script type="text/x-red" data-help-name="wordpos">
<p>Analyses <b>msg.payload</b> and classifies the part-of-speech of each word.</p>
<p>The resulting message has <b>msg.pos</b> added with the results:</p>
<p>Analyses <code>msg.payload</code> and classifies the part-of-speech of each word.</p>
<p>The resulting message has <code>msg.pos</code> added with the results:</p>
<pre>{
nouns:[],
verbs:[],

8
analysis/wordpos/README.md
View File

@ -1,12 +1,12 @@
node-red-node-wordpos
=====================
A <a href="http://nodered.org" target="_new">Node-RED</a> node that breaks a sentance into the various parts of (English) speech.
A <a href="http://nodered.org" target="_new">Node-RED</a> node that breaks a sentence into the various parts of (English) speech.
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-wordpos
@ -14,9 +14,9 @@ Run the following command in the root directory of your Node-RED install
Usage
-----
Uses the wordpos npm to analyse the **msg.payload** and classify the part-of-speech of each word.
Uses the wordpos npm to analyse the `msg.payload` and classify the part-of-speech of each word.
The resulting message has a **msg.pos** object added with the results split into the following:
The resulting message has a `msg.pos` object added with the results split into the following:
nouns:[],
verbs:[],

2
analysis/wordpos/package.json
View File

@ -1,6 +1,6 @@
{
"name" : "node-red-node-wordpos",
"version" : "0.0.2",
"version" : "0.0.3",
"description" : "A Node-RED node that breaks a sentence into the various parts of (English) speech.",
"dependencies" : {
"wordpos" : "0.1.*"

8
function/PID/README.md
View File

@ -6,9 +6,9 @@ A <a href="http://nodered.org" target="_new">Node-RED</a> node that provides a s
Install
-------
Run the following command in the root directory of your Node-RED install - usually ~/.node-red
Run the following command in your Node-RED user directory - typically `~/.node-red`
npm install node-red-node-pidcontrol
npm i node-red-node-pidcontrol
Usage
@ -16,11 +16,11 @@ Usage
PID controller node.
This node ONLY expects a numeric **msg.payload** containing the current reading.
This node ONLY expects a numeric `msg.payload` containing the current reading.
It will output the correction that needs to be applied in order to move to the preset **set point** value.
The damping factors are typically in the range 0 - 1.
See <a href="https://en.wikipedia.org/wiki/PID_controller" target="_new">Wikipedia</a> for more details on PID controllers.
The **set point** may be overridden by **msg.setpoint**. If you do so the edit box value can be used as the initial value.
The **set point** may be overridden by `msg.setpoint`. If you do so the edit box value can be used as the initial value.

2
function/PID/package.json
View File

@ -1,6 +1,6 @@
{
"name" : "node-red-node-pidcontrol",
"version" : "0.0.2",
"version" : "0.0.3",
"description" : "A Node-RED node that that provides a simple PID controller.",
"dependencies" : {
"node-pid-controller": "0.0.3"

4
function/PID/pidcontrol.html
View File

@ -41,10 +41,10 @@
<script type="text/x-red" data-help-name="PID control">
<p>A PID controller node.</p>
<p>This node ONLY expects a numeric <b>msg.payload</b> containing the current reading.
<p>This node ONLY expects a numeric <code>msg.payload</code> containing the current reading.
It will output the correction that needs to be applied in order to move to the preset <i>set point</i> value.</p>
<p>See <a href="https://en.wikipedia.org/wiki/PID_controller" target="_new">Wikipedia</a> for more details.</p>
<p>The <i>set point</i> may be overridden by <b>msg.setpoint</b>. If you do so the edit box value can be used as the initial value.</p>
<p>The <i>set point</i> may be overridden by <code>msg.setpoint</code>. If you do so the edit box value can be used as the initial value.</p>
</script>
<script type="text/javascript">

2
hardware/blink1/package.json
View File

@ -1,6 +1,6 @@
{
"name" : "node-red-node-blink1",
"version" : "0.0.15",
"version" : "0.0.16",
"description" : "A Node-RED node to control a Thingm Blink(1)",
"dependencies" : {
"node-blink1" : "0.2.2"

6
utility/daemon/README.md
View File

@ -13,15 +13,15 @@ Useful for monitoring command line based processes.
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-daemon
npm i node-red-node-daemon
Usage
-----
Calls out to a long running system command. Sends <b>msg.payload</b> to stdin of the process.
Calls out to a long running system command. Sends `msg.payload` to stdin of the process.
**Note** Only the command itself should be placed in the command field.
All parameters **must** be placed in the arguments field.

2
utility/daemon/daemon.html
View File

@ -50,7 +50,7 @@
</script>
<script type="text/x-red" data-help-name="daemon">
<p>Calls out to a long running system command. Sends <b>msg.payload</b> to stdin of the process.</p>
<p>Calls out to a long running system command. Sends <code>msg.payload</code> to stdin of the process.</p>
<p>Provides 3 outputs... stdout, stderr, and return code , from the running command.</p>
<p>If the called program stops (i.e. a return code is produced), this node can attempt to restart the command.</p>
<p><b>Note :</b> when you stop Node-RED running we may not get a chance to kill the called program so it may remain running. You <i>may</i> have to kill it manually.</p>

2
utility/daemon/package.json
View File

@ -1,6 +1,6 @@
{
"name" : "node-red-node-daemon",
"version" : "0.0.3",
"version" : "0.0.4",
"description" : "A Node-RED node that runs and monitors a long running system command.",
"dependencies" : {
},

6
utility/exif/94-exif.html
View File

@ -24,9 +24,9 @@
<script type="text/x-red" data-help-name="exif">
<p>Extract <a href="http://en.wikipedia.org/wiki/Exchangeable_image_file_format">Exif</a> information from JPEG images.</p>
<p>This node expects an incoming JPEG image buffer. If Exif data is present,
it extracts the data into the <b>msg.exif</b> object.</p>
<p>The node then adds location data as <b>msg.location</b>, should the Exif data carry this information.
<b>msg.payload</b> remains the original, unmodified image buffer. </p>
it extracts the data into the <code>msg.exif</code> object.</p>
<p>The node then adds location data as <code>msg.location</code>, should the Exif data carry this information.
<code>msg.payload</code> remains the original, unmodified image buffer. </p>
</script>
<script type="text/javascript">

8
utility/exif/README.md
View File

@ -6,7 +6,7 @@ A <a href="http://nodered.org" target="_new">Node-RED</a> node to extract Exif i
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-exif
@ -16,8 +16,8 @@ Usage
Extracts <a href="http://en.wikipedia.org/wiki/Exchangeable_image_file_format">Exif</a> information from JPEG images.
This node expects an incoming JPEG image as a buffer. If Exif data is present, it extracts the data into a **msg.exif** object.
This node expects an incoming JPEG image as a buffer. If Exif data is present, it extracts the data into a `msg.exif` object.
If the Exif data also contains location information this is extracted as **msg.location**.
If the Exif data also contains location information this is extracted as `msg.location`.
**msg.payload** retains the original, unmodified image buffer.
`msg.payload` retains the original, unmodified image buffer.

2
utility/exif/package.json
View File

@ -1,6 +1,6 @@
{
"name" : "node-red-node-exif",
"version" : "0.0.4",
"version" : "0.0.5",
"description" : "A Node-RED node that extracts Exif information from JPEG image buffers.",
"dependencies" : {
"exif": "0.4.0"