From 1ee031cad76d030da68811d04f764c1f966f01c3 Mon Sep 17 00:00:00 2001 From: Dave Conway-Jones Date: Wed, 2 Mar 2016 13:27:48 +0000 Subject: [PATCH] update parser and time nodes info style --- parsers/base64/70-base64.html | 2 +- parsers/base64/README.md | 8 ++++---- parsers/base64/package.json | 2 +- parsers/geohash/70-geohash.html | 8 ++++---- parsers/geohash/README.md | 10 +++++----- parsers/geohash/package.json | 2 +- parsers/msgpack/70-msgpack.html | 2 +- parsers/msgpack/README.md | 2 +- parsers/msgpack/package.json | 2 +- parsers/what3words/README.md | 10 +++++----- parsers/what3words/package.json | 2 +- parsers/what3words/what3words.html | 7 ++++--- time/suncalc/README.md | 2 +- time/suncalc/package.json | 2 +- time/timeswitch/README.md | 3 +-- time/timeswitch/package.json | 2 +- 16 files changed, 33 insertions(+), 33 deletions(-) diff --git a/parsers/base64/70-base64.html b/parsers/base64/70-base64.html index 1a567303..432dab1e 100644 --- a/parsers/base64/70-base64.html +++ b/parsers/base64/70-base64.html @@ -22,7 +22,7 @@ diff --git a/parsers/base64/README.md b/parsers/base64/README.md index f13fa837..66a175cc 100644 --- a/parsers/base64/README.md +++ b/parsers/base64/README.md @@ -1,20 +1,20 @@ node-red-node-base64 ==================== -A Node-RED node to endcode and decode base64 format messages. +A Node-RED node to encode and decode base64 format messages. 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 ----- -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. diff --git a/parsers/base64/package.json b/parsers/base64/package.json index ad7dbcdb..bf6b6aec 100644 --- a/parsers/base64/package.json +++ b/parsers/base64/package.json @@ -1,6 +1,6 @@ { "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", "dependencies" : { }, diff --git a/parsers/geohash/70-geohash.html b/parsers/geohash/70-geohash.html index a1e483cc..a93e190a 100644 --- a/parsers/geohash/70-geohash.html +++ b/parsers/geohash/70-geohash.html @@ -23,12 +23,12 @@ diff --git a/parsers/geohash/README.md b/parsers/geohash/README.md index 76fc67f2..5eee85a8 100644 --- a/parsers/geohash/README.md +++ b/parsers/geohash/README.md @@ -6,7 +6,7 @@ A Node-RED node to encode and dec 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 @@ -14,9 +14,9 @@ Run the following command in the root directory of your Node-RED install 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 - latitude @@ -24,9 +24,9 @@ If the **msg.payload** is a string it tries to see if it's a geohash - - errorlatitude - error.longitude -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. +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 diff --git a/parsers/geohash/package.json b/parsers/geohash/package.json index e066387b..0bab5178 100644 --- a/parsers/geohash/package.json +++ b/parsers/geohash/package.json @@ -1,6 +1,6 @@ { "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.", "dependencies" : { "ngeohash" : "0.6.0" diff --git a/parsers/msgpack/70-msgpack.html b/parsers/msgpack/70-msgpack.html index 0b946d82..196a83b2 100644 --- a/parsers/msgpack/70-msgpack.html +++ b/parsers/msgpack/70-msgpack.html @@ -22,7 +22,7 @@ diff --git a/parsers/msgpack/README.md b/parsers/msgpack/README.md index 3251dc7b..b5c5d124 100644 --- a/parsers/msgpack/README.md +++ b/parsers/msgpack/README.md @@ -6,7 +6,7 @@ A Node-RED node to pack and unpac 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 diff --git a/parsers/msgpack/package.json b/parsers/msgpack/package.json index 7ae5f3b0..95df8cb1 100644 --- a/parsers/msgpack/package.json +++ b/parsers/msgpack/package.json @@ -1,6 +1,6 @@ { "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", "dependencies" : { "msgpack-js" : "0.3.0" diff --git a/parsers/what3words/README.md b/parsers/what3words/README.md index 7fc849f8..45fd9539 100644 --- a/parsers/what3words/README.md +++ b/parsers/what3words/README.md @@ -6,7 +6,7 @@ A Node-RED node to convert positi 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 @@ -24,17 +24,17 @@ and vice versa. Don't ask... just try it... To convert position to words it requires - - msg.location.lat - - msg.location.lon + - `msg.location.lat` + - `msg.location.lon` or - - msg.payload containing a string lat,lon + - `msg.payload` containing a string lat,lon 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. diff --git a/parsers/what3words/package.json b/parsers/what3words/package.json index 5e6bd389..f30ec349 100644 --- a/parsers/what3words/package.json +++ b/parsers/what3words/package.json @@ -1,6 +1,6 @@ { "name" : "node-red-node-what3words", - "version" : "0.0.2", + "version" : "0.0.3", "description" : "A Node-RED node to convert locations to/from what3words", "dependencies" : { "geo.what3words" : "0.0.2" diff --git a/parsers/what3words/what3words.html b/parsers/what3words/what3words.html index 4249f6d9..15f3a3dd 100644 --- a/parsers/what3words/what3words.html +++ b/parsers/what3words/what3words.html @@ -42,10 +42,11 @@