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

update parser and time nodes info style

This commit is contained in:
Dave Conway-Jones 2016-03-02 13:27:48 +00:00
parent 86049c20cb
commit 1ee031cad7
16 changed files with 33 additions and 33 deletions

View File

@ -22,7 +22,7 @@
</script> </script>
<script type="text/x-red" data-help-name="base64"> <script type="text/x-red" data-help-name="base64">
<p>A function that converts the <b>msg.payload</b> to and from base64 format.</p> <p>A function that converts the <code>msg.payload</code> to and from base64 format.</p>
<p>If the input is a buffer it converts it to a Base64 encoded string.</p> <p>If the input is a buffer it converts it to a Base64 encoded string.</p>
<p>If the input is a Base64 string it converts it back to a binary buffer.</p> <p>If the input is a Base64 string it converts it back to a binary buffer.</p>
</script> </script>

View File

@ -1,20 +1,20 @@
node-red-node-base64 node-red-node-base64
==================== ====================
A <a href="http://nodered.org" target="_new">Node-RED</a> node to endcode and decode base64 format messages. A <a href="http://nodered.org" target="_new">Node-RED</a> node to encode and decode base64 format messages.
Install 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-base64 npm i node-red-node-base64
Usage Usage
----- -----
A function that converts the **msg.payload** to and from base64 format. A function that converts the `msg.payload` to and from base64 format.
If the input is a binary buffer it converts it to a Base64 encoded string. If the input is a binary buffer it converts it to a Base64 encoded string.

View File

@ -1,6 +1,6 @@
{ {
"name" : "node-red-node-base64", "name" : "node-red-node-base64",
"version" : "0.0.1", "version" : "0.0.2",
"description" : "A Node-RED node to pack and unpack objects to base64 format", "description" : "A Node-RED node to pack and unpack objects to base64 format",
"dependencies" : { "dependencies" : {
}, },

View File

@ -23,12 +23,12 @@
<script type="text/x-red" data-help-name="geohash"> <script type="text/x-red" data-help-name="geohash">
<p>A function that encodes lat,lon to and from a geohash.</p> <p>A function that encodes lat,lon to and from a geohash.</p>
<p>If the <b>msg.payload</b> is a string it tries to see if it's a geohash - <p>If the <code>msg.payload</code> is a string it tries to see if it is a geohash -
if so it tries to decode it and outputs a payload object containing if so it tries to decode it and outputs a payload object containing
<ul><li>latitude<li>longitude<li>error.latitude<li>error.longitude</ul></p> <ul><li>latitude<li>longitude<li>error.latitude<li>error.longitude</ul></p>
<p>If the <b>msg.payload</b> is an object with properties lat or latitude and lon or longitude <p>If the <code>msg.payload</code> is an object with properties lat or latitude and lon or longitude
- it will add a <b>geohash</b> property to the payload.</p> - it will add a <code>geohash</code> property to the payload.</p>
<p>The precision can be set by <b>msg.payload.precision</b> from 1 to 9. <p>The precision can be set by <code>msg.payload.precision</code> from 1 to 9.
<p><b>Note:</b> If the msg contains a .location property it will operate on that in preference to the .payload.</p> <p><b>Note:</b> If the msg contains a .location property it will operate on that in preference to the .payload.</p>
</script> </script>

View File

@ -6,7 +6,7 @@ A <a href="http://nodered.org" target="_new">Node-RED</a> node to encode and dec
Install 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-geohash npm install node-red-node-geohash
@ -14,9 +14,9 @@ Run the following command in the root directory of your Node-RED install
Usage Usage
----- -----
This function encodes a lat,lon string to and from a geohash. This function encodes a `lat,lon` string to and from a geohash.
If the **msg.payload** is a string it tries to see if it's a geohash - If the `msg.payload` is a string it tries to see if it's a geohash -
if so it tries to decode it and outputs a payload object containing if so it tries to decode it and outputs a payload object containing
- latitude - latitude
@ -24,9 +24,9 @@ If the **msg.payload** is a string it tries to see if it's a geohash -
- errorlatitude - errorlatitude
- error.longitude - error.longitude
If the **msg.payload** is an object with properties **lat** or **latitude** and **lon** or **longitude** - it will add a <b>geohash</b> property to the payload. If the `msg.payload` is an object with properties `lat` or `latitude` and `lon` or `longitude` - it will add a `geohash` property to the payload.
The precision can be set by **msg.payload.precision** from 1 to 9. The precision can be set by `msg.payload.precision` from 1 to 9.
Example flow Example flow

View File

@ -1,6 +1,6 @@
{ {
"name" : "node-red-node-geohash", "name" : "node-red-node-geohash",
"version" : "0.0.4", "version" : "0.0.5",
"description" : "A Node-RED node to encode and decode lat,lon pairs to a geohash.", "description" : "A Node-RED node to encode and decode lat,lon pairs to a geohash.",
"dependencies" : { "dependencies" : {
"ngeohash" : "0.6.0" "ngeohash" : "0.6.0"

View File

@ -22,7 +22,7 @@
</script> </script>
<script type="text/x-red" data-help-name="msgpack"> <script type="text/x-red" data-help-name="msgpack">
<p>A function that converts the <b>msg.payload</b> to and from <a href = "https://github.com/msgpack/msgpack-node"><i>msgpack</i></a> format.</p> <p>A function that converts the <code>msg.payload</code> to and from <a href = "https://github.com/msgpack/msgpack-node"><i>msgpack</i></a> format.</p>
<p>If the input is NOT a buffer it tries to convert it to a msgpack buffer.</p> <p>If the input is NOT a buffer it tries to convert it to a msgpack buffer.</p>
<p>If the input is a msgpack buffer it tries to decode it back.</p> <p>If the input is a msgpack buffer it tries to decode it back.</p>
</script> </script>

View File

@ -6,7 +6,7 @@ A <a href="http://nodered.org" target="_new">Node-RED</a> node to pack and unpac
Install 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-msgpack npm install node-red-node-msgpack

View File

@ -1,6 +1,6 @@
{ {
"name" : "node-red-node-msgpack", "name" : "node-red-node-msgpack",
"version" : "0.0.4", "version" : "0.0.5",
"description" : "A Node-RED node to pack and unpack objects to msgpack format", "description" : "A Node-RED node to pack and unpack objects to msgpack format",
"dependencies" : { "dependencies" : {
"msgpack-js" : "0.3.0" "msgpack-js" : "0.3.0"

View File

@ -6,7 +6,7 @@ A <a href="http://nodered.org" target="_new">Node-RED</a> node to convert positi
Install 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-what3words npm install node-red-node-what3words
@ -24,17 +24,17 @@ and vice versa. Don't ask... just try it...
To convert position to words it requires To convert position to words it requires
- msg.location.lat - `msg.location.lat`
- msg.location.lon - `msg.location.lon`
or or
- msg.payload containing a string lat,lon - `msg.payload` containing a string lat,lon
To convert words to position it requires To convert words to position it requires
- msg.payload containing a string unique.three.words - `msg.payload` containing a string of _unique.three.words_
The API-key is stored in a separate credentials file. The API-key is stored in a separate credentials file.

View File

@ -1,6 +1,6 @@
{ {
"name" : "node-red-node-what3words", "name" : "node-red-node-what3words",
"version" : "0.0.2", "version" : "0.0.3",
"description" : "A Node-RED node to convert locations to/from what3words", "description" : "A Node-RED node to convert locations to/from what3words",
"dependencies" : { "dependencies" : {
"geo.what3words" : "0.0.2" "geo.what3words" : "0.0.2"

View File

@ -42,10 +42,11 @@
<script type="text/x-red" data-help-name="what3words"> <script type="text/x-red" data-help-name="what3words">
<p>Uses what3words to convert a location to a unique three.word.combination .</p> <p>Uses what3words to convert a location to a unique three.word.combination .</p>
<p>Expects either <ul> <p>Expects either <ul>
<li><b>msg.location.lat</b> and <b>msg.location.lon</b>, or </li> <li><code>msg.location.lat</code> and <code>msg.location.lon</code>, or </li>
<li><b>msg.payload</b> to contain a <i>lat,lon</i> string,</li> <li><code>msg.payload</code> to contain a <i>lat,lon</i> string,</li>
</ul> and produces a msg.payload of unique.three.words .</p> </ul> and produces a msg.payload of unique.three.words .</p>
<p>Also does the reverse by accepting a <b>dot (.)</b> separated three.word.string in <b>msg.payload</b>, and adds the corresponding <b>msg.location</b> property.</p> <p>Also does the reverse by accepting a <b>dot (.)</b> separated three.word.string in <code>msg.payload</code>,
and adds the corresponding <code>msg.location</code> property.</p>
<p><b>Note:</b> This is an online service and requires a live internet connection.</p> <p><b>Note:</b> This is an online service and requires a live internet connection.</p>
<p>The API-key is stored in a separate credentials file.</p> <p>The API-key is stored in a separate credentials file.</p>
<p>See <i><a href="http://www.what3words.com/" target="_new">what3words</a></i> for more details.</p> <p>See <i><a href="http://www.what3words.com/" target="_new">what3words</a></i> for more details.</p>

View File

@ -6,7 +6,7 @@ A <a href="http://nodered.org" target="_new">Node-RED</a> node to provide a sign
Install 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-suncalc npm install node-red-node-suncalc

View File

@ -1,6 +1,6 @@
{ {
"name" : "node-red-node-suncalc", "name" : "node-red-node-suncalc",
"version" : "0.0.7", "version" : "0.0.8",
"description" : "A Node-RED node to provide a signal at sunrise and sunset", "description" : "A Node-RED node to provide a signal at sunrise and sunset",
"dependencies" : { "dependencies" : {
"suncalc" : "1.6.*" "suncalc" : "1.6.*"

View File

@ -7,8 +7,7 @@ simple timeswitch node to schedule daily on/off events.
Install 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`
Usually this is `~/.node-red`
npm install node-red-node-timeswitch npm install node-red-node-timeswitch

View File

@ -1,6 +1,6 @@
{ {
"name" : "node-red-node-timeswitch", "name" : "node-red-node-timeswitch",
"version" : "0.0.3", "version" : "0.0.4",
"description" : "A Node-RED node to provide a simple timeswitch to schedule daily on/off events.", "description" : "A Node-RED node to provide a simple timeswitch to schedule daily on/off events.",
"dependencies" : { "dependencies" : {
"suncalc": "1.6.0" "suncalc": "1.6.0"