diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..e006a3d7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,34 @@ + + +### Which node are you reporting an issue on? + +### What are the steps to reproduce? + +### What happens? + +### What do you expect to happen? + +### Please tell us about your environment: + +- [ ] Node-RED version: +- [ ] node.js version: +- [ ] npm version: +- [ ] Platform/OS: +- [ ] Browser: diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..526464a6 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,34 @@ + + +- [ ] Bugfix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) + + + +## Proposed changes + + + +## Checklist + + +- [ ] I have read the [contribution guidelines](https://github.com/node-red/node-red-nodes/blob/master/CONTRIBUTING.md) +- [ ] For non-bugfix PRs, I have discussed this change on the forum/slack team. +- [ ] I have run `grunt` to verify the unit tests pass +- [ ] I have added suitable unit tests to cover the new/changed functionality diff --git a/.gitignore b/.gitignore index 09ee0ffd..729dabf3 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,6 @@ coverage puball.sh setenv.sh /.project +package-lock.json +social/xmpp/92-xmpp.old +*.tgz diff --git a/.jshintrc b/.jshintrc index 81998b32..b16056c8 100644 --- a/.jshintrc +++ b/.jshintrc @@ -1,19 +1,15 @@ { - "asi": true, // allow missing semicolons - "curly": true, // require braces - "eqnull": true, // ignore ==null - //"eqeqeq": true, // enforce === - "freeze": true, // don't allow override - "indent": 4, // default indent of 4 - "forin": true, // require property filtering in "for in" loops - "immed": true, // require immediate functions to be wrapped in ( ) - "nonbsp": true, // warn on unexpected whitespace breaking chars - //"strict": true, // commented out for now as it causes 100s of warnings, but want to get there eventually - //"unused": true, // Check for unused functions and variables - "loopfunc": true, // allow functions to be defined in loops - //"expr": true, // allow ternery operator syntax... - "shadow": true, // allow variable shadowing (re-use of names...) - "sub": true, // don't warn that foo['bar'] should be written as foo.bar - "proto": true, // allow setting of __proto__ in node < v0.12 - "esversion": 6 // allow es6 + "asi": true, + "curly": true, + "eqnull": true, + "freeze": true, + "indent": 4, + "forin": true, + "immed": true, + "nonbsp": true, + "loopfunc": true, + "shadow": true, + "sub": true, + "proto": true, + "esversion": 8 } diff --git a/.travis.yml b/.travis.yml index 41485f0f..e7d7f89c 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,27 +1,32 @@ sudo: false language: node_js -env: - - CXX="g++-4.8" -addons: - apt: - sources: - - ubuntu-toolchain-r-test - packages: - - g++-4.8 - - gcc-4.8 matrix: - allow_failures: - - node_js: "7" -node_js: - - "8" - - "7" - - "6" - - "4" + # allow_failures: + # - node_js: 14 + include: + - node_js: 14 + - node_js: 12 + - node_js: 10 + - node_js: 8 + # - python: 2.7 + # language: python + # before_script: pip install flake8 + # script: flake8 . --count --select=E901,E999,F821,F822,F823 --show-source --statistics + - python: 3.7 + language: python + dist: xenial # required for Python 3.7 (travis-ci/travis-ci#9069) + sudo: required # required for Python 3.7 (travis-ci/travis-ci#9069) + before_script: pip install flake8 + script: flake8 . --count --select=E901,E999,F821,F822,F823 --show-source --statistics +before_install: + - npm i -g npm before_script: - - npm install -g istanbul grunt-cli - - npm install coveralls - - npm install git+https://github.com/node-red/node-red.git - - export NODE_RED_HOME=`pwd`/node_modules/node-red - - (cd $NODE_RED_HOME ; npm install nock@~0.48.0) + # Remove the './node_modules/.bin:' entry, see https://github.com/travis-ci/travis-ci/issues/8813 + - export PATH=`echo ${PATH} | sed -re 's,(^|:)(./)?node_modules/.bin($|:),\1,'` + - npm install -g nyc grunt-cli coveralls + - npm install node-red script: - - istanbul cover grunt --report lcovonly && istanbul report text && ( cat coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js || true ) && rm -rf coverage + # - istanbul cover grunt --report lcovonly && istanbul report text && ( cat coverage/lcov.info | $(npm get prefix)/bin/coveralls || true ) && rm -rf coverage + # - nyc --check-coverage --reporter=text --reporter=lcovonly --reporter=html grunt + # - nyc grunt && rm -rf coverage .nyc_output + - nyc grunt && nyc report --reporter=text-lcov | coveralls diff --git a/99-sample.html.demo b/99-sample.html.demo index 67c25724..c75fee17 100644 --- a/99-sample.html.demo +++ b/99-sample.html.demo @@ -6,7 +6,7 @@ - diff --git a/analysis/mlsentiment/locales/ja/mlsentiment.json b/analysis/mlsentiment/locales/ja/mlsentiment.json new file mode 100644 index 00000000..6763ab85 --- /dev/null +++ b/analysis/mlsentiment/locales/ja/mlsentiment.json @@ -0,0 +1,8 @@ +{ + "mlsentiment": { + "sentiment": "sentiment", + "label": { + "language": "言語" + } + } +} diff --git a/analysis/mlsentiment/mlsentiment.html b/analysis/mlsentiment/mlsentiment.html new file mode 100644 index 00000000..d6b75a8e --- /dev/null +++ b/analysis/mlsentiment/mlsentiment.html @@ -0,0 +1,176 @@ + + + + + + diff --git a/analysis/mlsentiment/mlsentiment.js b/analysis/mlsentiment/mlsentiment.js new file mode 100644 index 00000000..f9bb85fa --- /dev/null +++ b/analysis/mlsentiment/mlsentiment.js @@ -0,0 +1,28 @@ + +module.exports = function(RED) { + "use strict"; + var multilangsentiment = require('multilang-sentiment'); + + function MultiLangSentimentNode(n) { + RED.nodes.createNode(this,n); + this.lang = n.lang; + this.property = n.property||"payload"; + var node = this; + + this.on("input", function(msg) { + var value = RED.util.getMessageProperty(msg,node.property); + if (value !== undefined) { + if (msg.hasOwnProperty("overrides")) { + msg.extras = msg.overrides; + delete msg.overrides; + } + multilangsentiment(value, node.lang || msg.lang || 'en', {words: msg.extras || null}, function (err, result) { + msg.sentiment = result; + node.send(msg); + }); + } + else { node.send(msg); } // If no matching property - just pass it on. + }); + } + RED.nodes.registerType("mlsentiment",MultiLangSentimentNode); +} diff --git a/analysis/mlsentiment/package.json b/analysis/mlsentiment/package.json new file mode 100644 index 00000000..4a2377fd --- /dev/null +++ b/analysis/mlsentiment/package.json @@ -0,0 +1,24 @@ +{ + "name" : "node-red-node-multilang-sentiment", + "version" : "0.1.0", + "description" : "A Node-RED node that uses the AFINN-165 wordlists for sentiment analysis of words translated into multiple languages including emojis.", + "dependencies" : { + "multilang-sentiment" : "^1.2.0" + }, + "repository" : { + "type":"git", + "url":"https://github.com/node-red/node-red-nodes/tree/master/analysis/sentiment" + }, + "license": "Apache-2.0", + "keywords": [ "node-red", "sentiment", "anaylsis", "AFINN" ], + "node-red" : { + "nodes" : { + "mlsentiment": "mlsentiment.js" + } + }, + "author": { + "name": "Dave Conway-Jones", + "email": "ceejay@vnet.ibm.com", + "url": "http://nodered.org" + } +} diff --git a/analysis/sentiment/72-sentiment.html b/analysis/sentiment/72-sentiment.html new file mode 100644 index 00000000..48778f46 --- /dev/null +++ b/analysis/sentiment/72-sentiment.html @@ -0,0 +1,36 @@ + + + diff --git a/analysis/sentiment/72-sentiment.js b/analysis/sentiment/72-sentiment.js new file mode 100644 index 00000000..29ec8671 --- /dev/null +++ b/analysis/sentiment/72-sentiment.js @@ -0,0 +1,22 @@ +module.exports = function(RED) { + "use strict"; + var sentiment = require('sentiment'); + + function SentimentNode(n) { + RED.nodes.createNode(this,n); + this.property = n.property||"payload"; + var node = this; + + this.on("input", function(msg) { + var value = RED.util.getMessageProperty(msg,node.property); + if (value !== undefined) { + sentiment(value, msg.overrides || null, function (err, result) { + msg.sentiment = result; + node.send(msg); + }); + } + else { node.send(msg); } // If no matching property - just pass it on. + }); + } + RED.nodes.registerType("sentiment",SentimentNode); +} diff --git a/analysis/sentiment/LICENSE b/analysis/sentiment/LICENSE new file mode 100644 index 00000000..786c01e8 --- /dev/null +++ b/analysis/sentiment/LICENSE @@ -0,0 +1,14 @@ +Copyright 2016, 2019 JS Foundation and other contributors, https://js.foundation/ +Copyright 2013-2016 IBM Corp. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/analysis/sentiment/README.md b/analysis/sentiment/README.md new file mode 100644 index 00000000..e4bc449f --- /dev/null +++ b/analysis/sentiment/README.md @@ -0,0 +1,26 @@ +node-red-node-sentiment +======================== + +A Node-RED node that scores incoming words +using the AFINN-165 wordlist and attaches a sentiment.score property to the msg. + +NOTE: There is also a multi-language version available - **node-red-node-multilang-sentiment**. + +Install +------- + +This is a node that should be installed by default by Node-RED so you should not have to install it manually. If you do then run the following command in your Node-RED user directory - typically `~/.node-red` + + npm install node-red-node-sentiment + + +Usage +----- + +Uses the AFINN-165 wordlist to attempt to assign scores to words in text. + +Attaches `msg.sentiment` to the msg and within that `msg.sentiment.score` holds the score. + +A score greater than zero is positive and less than zero is negative. The score typically ranges from -5 to +5, but can go higher and lower. + +See the Sentiment docs here.

diff --git a/analysis/sentiment/locales/en-US/72-sentiment.html b/analysis/sentiment/locales/en-US/72-sentiment.html new file mode 100644 index 00000000..583d48bf --- /dev/null +++ b/analysis/sentiment/locales/en-US/72-sentiment.html @@ -0,0 +1,20 @@ + diff --git a/analysis/sentiment/locales/en-US/72-sentiment.json b/analysis/sentiment/locales/en-US/72-sentiment.json new file mode 100644 index 00000000..b65aad90 --- /dev/null +++ b/analysis/sentiment/locales/en-US/72-sentiment.json @@ -0,0 +1,8 @@ +{ + "sentiment": { + "sentiment": "sentiment", + "label": { + "language": "Language" + } + } +} diff --git a/analysis/sentiment/locales/ja/72-sentiment.html b/analysis/sentiment/locales/ja/72-sentiment.html new file mode 100644 index 00000000..bf8d95f0 --- /dev/null +++ b/analysis/sentiment/locales/ja/72-sentiment.html @@ -0,0 +1,35 @@ + + + diff --git a/analysis/sentiment/locales/ja/72-sentiment.json b/analysis/sentiment/locales/ja/72-sentiment.json new file mode 100644 index 00000000..6072d928 --- /dev/null +++ b/analysis/sentiment/locales/ja/72-sentiment.json @@ -0,0 +1,8 @@ +{ + "sentiment": { + "sentiment": "sentiment", + "label": { + "language": "言語" + } + } +} diff --git a/analysis/sentiment/package.json b/analysis/sentiment/package.json new file mode 100644 index 00000000..e432e8a9 --- /dev/null +++ b/analysis/sentiment/package.json @@ -0,0 +1,24 @@ +{ + "name" : "node-red-node-sentiment", + "version" : "0.1.6", + "description" : "A Node-RED node that uses the AFINN-165 wordlists for sentiment analysis of words.", + "dependencies" : { + "sentiment" : "2.1.0" + }, + "repository" : { + "type":"git", + "url":"https://github.com/node-red/node-red-nodes/tree/master/analysis/sentiment" + }, + "license": "Apache-2.0", + "keywords": [ "node-red", "sentiment", "anaylsis", "AFINN" ], + "node-red" : { + "nodes" : { + "sentiment": "72-sentiment.js" + } + }, + "author": { + "name": "Dave Conway-Jones", + "email": "ceejay@vnet.ibm.com", + "url": "http://nodered.org" + } +} diff --git a/analysis/swearfilter/74-swearfilter.js b/analysis/swearfilter/74-swearfilter.js index 8b68f8de..db29da6a 100644 --- a/analysis/swearfilter/74-swearfilter.js +++ b/analysis/swearfilter/74-swearfilter.js @@ -1,15 +1,14 @@ module.exports = function(RED) { "use strict"; - var badwords = require('badwords'); - if (badwords.length === 0 ) { return; } - var badwordsRegExp = require('badwords/regexp'); function BadwordsNode(n) { RED.nodes.createNode(this,n); + var badwordsRegExp = require('badwords/regexp'); var node = this; - this.on("input", function(msg) { + node.on("input", function(msg) { if (typeof msg.payload === "string") { + badwordsRegExp.lastIndex = 0 if ( !badwordsRegExp.test(msg.payload) ) { node.send(msg); } } }); diff --git a/analysis/swearfilter/package.json b/analysis/swearfilter/package.json index 076922df..cd08e1c5 100644 --- a/analysis/swearfilter/package.json +++ b/analysis/swearfilter/package.json @@ -1,9 +1,9 @@ { "name" : "node-red-node-badwords", - "version" : "0.0.5", + "version" : "0.1.0", "description" : "A Node-RED node that attempts to filter out messages containing swearwords.", "dependencies" : { - "badwords" : "0.0.3" + "badwords" : "^1.0.0" }, "repository" : { "type":"git", diff --git a/coverall b/coverall index c4a004f8..2d3f6e21 100755 --- a/coverall +++ b/coverall @@ -1,3 +1,3 @@ # check coverage of tests... and browse report -istanbul cover ./node_modules/.bin/grunt --report lcovonly && istanbul report html +nyc --check-coverage --reporter=html grunt /Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome coverage/index.html diff --git a/function/datagenerator/README.md b/function/datagenerator/README.md index 1e3beb40..617b4aa5 100644 --- a/function/datagenerator/README.md +++ b/function/datagenerator/README.md @@ -7,26 +7,26 @@ data values from a template. Useful for building test-cases. Install ------- -Run the following command in your Node-RED user directory - typically `~/.node-red` +Either use the Manage Palette option in the Node-RED Editor menu, or run the following command in your Node-RED user directory - typically `~/.node-red` - npm install node-red-node-data-generator + npm i node-red-node-data-generator Usage ----- Creates dummy data based on a handlebars-style template. -Uses the dummy-json +Uses the dummy-json module, which can create rich sets of dummy data for testing or other uses. It will build a **string**, or a **parsed JSON object**, creating values based on the helper names below: - title, firstname, lastname, company, domain, tld, email, + title, firstName, lastName, company, domain, tld, email, street, city, country, countryCode, zipcode, postcode, - lat, long, phone, color, hexColor, guid, - ipv4, ipv6, lorem, date, time, - lowercase, uppercase, int, float, boolean + lat, long, phone "+xx (x) xxxx xxx xxx", color, hexColor, guid, + ipv4, ipv6, lorem nn, date, time, + lowercase (helper), uppercase (helper), int, float, boolean Multiple values can be generated by use of the `repeat` syntax. diff --git a/function/datagenerator/datagenerator.html b/function/datagenerator/datagenerator.html index edfabacc..8ae22271 100644 --- a/function/datagenerator/datagenerator.html +++ b/function/datagenerator/datagenerator.html @@ -27,12 +27,12 @@ @@ -40,7 +40,6 @@ RED.nodes.registerType('data-generator',{ color:"rgb(243, 181, 103)", category: 'function', - paletteLabel:"data generator", defaults: { name: {value:""}, field: {value:"payload"}, @@ -51,9 +50,13 @@ inputs:1, outputs:1, icon: "template.png", + paletteLabel: function() { + return this._("datagen.datagen"); + }, label: function() { return this.name || "data generator"; }, + outputLabels: function() { return this.syntax === "json" ? "object" : "string"; }, oneditprepare: function() { var that = this; if (!this.fieldType) { diff --git a/function/datagenerator/locales/en-US/datagenerator.json b/function/datagenerator/locales/en-US/datagenerator.json index dffd35b3..a1f0ddcc 100644 --- a/function/datagenerator/locales/en-US/datagenerator.json +++ b/function/datagenerator/locales/en-US/datagenerator.json @@ -1,5 +1,6 @@ { "datagen": { + "datagen": "data generator", "label": { "syntax": "Return", "text": "a text string", diff --git a/function/datagenerator/package.json b/function/datagenerator/package.json index 5aae89e2..3dc05d16 100644 --- a/function/datagenerator/package.json +++ b/function/datagenerator/package.json @@ -1,9 +1,9 @@ { "name" : "node-red-node-data-generator", - "version" : "0.0.4", + "version" : "0.1.1", "description" : "A Node-RED node to create a string of dummy data values from a template. Useful for test-cases.", "dependencies" : { - "dummy-json": "1.0.*" + "dummy-json": "^2.0.0" }, "repository" : { "type":"git", diff --git a/function/random/LICENSE b/function/random/LICENSE index f5b60114..f144b137 100644 --- a/function/random/LICENSE +++ b/function/random/LICENSE @@ -1,4 +1,4 @@ -Copyright 2016 JS Foundation and other contributors, https://js.foundation/ +Copyright 2016,2020 JS Foundation and other contributors, https://js.foundation/ Copyright 2013-2016 IBM Corp. Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/function/random/README.md b/function/random/README.md index e27fdef7..91710a84 100644 --- a/function/random/README.md +++ b/function/random/README.md @@ -1,23 +1,24 @@ -node-red-node-random -==================== +# node-red-node-random A Node-RED node that when triggered generates a random number between two values. -Install -------- +## Install -Run the following command in your Node-RED user directory - typically `~/.node-red` +Either use the Manage Palette option in the Node-RED Editor menu, or run the following command in your Node-RED user directory - typically `~/.node-red` - npm install node-red-node-random + npm i node-red-node-random -Usage ------ +## Usage A simple node to generate a random number when triggered. -If integer mode is selected (default) it will return an integer **between and including** the two values given - so selecting 1 to 6 will return values 1,2,3,4,5 or 6. +If set to return an integer it can include both the low and high values. +`min <= n <= max` - so selecting 1 to 6 will return values 1,2,3,4,5 or 6. -If floating point mode is selected then it will return a number **between** the two values given - so selecting 1 to 6 will return values 1 < x < 6 . +If set to return a floating point value it will be from the low value, up to, but +**not** including the high value. `min <= n < max` - so selecting 1 to 6 will return values 1 <= n < 6 . -**Note:** This generates **numbers**. +You can dynamically pass in the 'From' and 'To' values to the node using msg.to and/or msg.from. **NOTE:** hard coded values in the node **always take precedence**. + +**Note:** This returns numbers - objects of type **number**. diff --git a/function/random/locales/en-US/random.html b/function/random/locales/en-US/random.html new file mode 100644 index 00000000..9c18b0da --- /dev/null +++ b/function/random/locales/en-US/random.html @@ -0,0 +1,16 @@ + diff --git a/function/random/locales/en-US/random.json b/function/random/locales/en-US/random.json new file mode 100644 index 00000000..e53fe58c --- /dev/null +++ b/function/random/locales/en-US/random.json @@ -0,0 +1,13 @@ +{ + "random": { + "label": { + "generate": "Generate", + "wholeNumber": "a whole number - integer", + "realNumber": "a real number - floating point", + "from": "From", + "lowestNumber": "lowest number", + "to": "To", + "highestNumber": "highest number" + } + } +} diff --git a/function/random/locales/ja/random.html b/function/random/locales/ja/random.html new file mode 100644 index 00000000..5b09fea8 --- /dev/null +++ b/function/random/locales/ja/random.html @@ -0,0 +1,16 @@ + diff --git a/function/random/locales/ja/random.json b/function/random/locales/ja/random.json new file mode 100644 index 00000000..fa3da7cb --- /dev/null +++ b/function/random/locales/ja/random.json @@ -0,0 +1,13 @@ +{ + "random": { + "label": { + "generate": "生成", + "wholeNumber": "整数 - 整数値", + "realNumber": "実数 - 浮動小数点", + "from": "最小", + "lowestNumber": "最小値", + "to": "最大", + "highestNumber": "最大値" + } + } +} diff --git a/function/random/package.json b/function/random/package.json index f6e48cac..2f2f4dc0 100644 --- a/function/random/package.json +++ b/function/random/package.json @@ -1,6 +1,6 @@ { "name" : "node-red-node-random", - "version" : "0.0.8", + "version" : "0.3.1", "description" : "A Node-RED node that when triggered generates a random number between two values.", "dependencies" : { }, @@ -19,5 +19,8 @@ "name": "Dave Conway-Jones", "email": "ceejay@vnet.ibm.com", "url": "http://nodered.org" - } + }, + "contributors": [ + {"name": "@zenofmud"} + ] } diff --git a/function/random/random.html b/function/random/random.html index 1a9cb7c7..7443615f 100644 --- a/function/random/random.html +++ b/function/random/random.html @@ -1,42 +1,40 @@ - - - - diff --git a/function/random/random.js b/function/random/random.js index 69da1d65..681cfefe 100644 --- a/function/random/random.js +++ b/function/random/random.js @@ -3,18 +3,73 @@ module.exports = function(RED) { "use strict"; function RandomNode(n) { RED.nodes.createNode(this,n); - this.low = Number(n.low || 1); - this.high = Number(n.high || 10); + + this.low = n.low + this.high = n.high this.inte = n.inte || false; + this.property = n.property||"payload"; var node = this; + var tmp = {}; + this.on("input", function(msg) { - if (node.inte == "true" || node.inte === true) { - msg.payload = Math.round(Number(Math.random()) * (node.high - node.low + 1) + node.low - 0.5); + + tmp.low = 1 // set this as the default low value + tmp.low_e = "" + if (node.low) { // if the the node has a value use it + tmp.low = Number(node.low); + } else if ('from' in msg) { // else see if a 'from' is in the msg + if (Number(msg.from)) { // if it is, and is a number, use it + tmp.low = Number(msg.from); + } else { // otherwise setup NaN error + tmp.low = NaN; + tmp.low_e = " From: " + msg.from; // setup to show bad incoming msg.from + } } - else { - msg.payload = Number(Math.random()) * (node.high - node.low) + node.low; + + tmp.high = 10 // set this as the default high value + tmp.high_e = ""; + if (node.high) { // if the the node has a value use it + tmp.high = Number(node.high); + } else if ('to' in msg) { // else see if a 'to' is in the msg + if (Number(msg.to)) { // if it is, and is a number, use it + tmp.high = Number(msg.to); + } else { // otherwise setup NaN error + tmp.high = NaN + tmp.high_e = " To: " + msg.to // setup to show bad incoming msg.to + } + } + + // if tmp.low or high are not numbers, send an error msg with bad values + if ( (isNaN(tmp.low)) || (isNaN(tmp.high)) ) { + this.error("Random: one of the input values is not a number. " + tmp.low_e + tmp.high_e); + } else { + // at this point we have valid values so now to generate the random number! + + // flip the values if low > high so random will work + var value = 0; + if (tmp.low > tmp.high) { + value = tmp.low + tmp.low = tmp.high + tmp.high = value + } + + // if returning an integer, do a math.ceil() on the low value and a + // Math.floor()high value before generate the random number. This must be + // done to insure the rounding doesn't round up if using something like 4.7 + // which would end up with 5 + if ( (node.inte == "true") || (node.inte === true) ) { + tmp.low = Math.ceil(tmp.low); + tmp.high = Math.floor(tmp.high); + // use this to round integers + value = Math.round(Math.random() * (tmp.high - tmp.low + 1) + tmp.low - 0.5); + } else { + // use this to round floats + value = (Math.random() * (tmp.high - tmp.low)) + tmp.low; + } + + RED.util.setMessageProperty(msg,node.property,value); + node.send(msg); } - node.send(msg); }); } RED.nodes.registerType("random",RandomNode); diff --git a/function/rbe/README.md b/function/rbe/README.md index 39ba78be..e63ae7ff 100644 --- a/function/rbe/README.md +++ b/function/rbe/README.md @@ -1,12 +1,11 @@ node-red-node-rbe ================= -A Node-RED node that provides +A Node-RED node that provides report-by-exception (RBE) and deadband capability. The node blocks unless the incoming value changes - RBE mode, or -changes by more than a certain amount (absolute value or percentage) - deadband -mode. +changes by more than a certain amount (absolute value or percentage) - bandgap modes. Install ------- @@ -19,7 +18,7 @@ Run the following command in your Node-RED user directory - typically `~/.node-r Usage ----- -A simple node to provide report by exception (RBE) and deadband function +A simple node to provide report by exception (RBE) and bandgap functions - only passes on data if it has changed. This works on a per `msg.topic` basis. This means that a single rbe node can @@ -31,12 +30,13 @@ The node doesn't send any output until the `msg.payload` is different to the pre Works on numbers and strings. Useful for filtering out repeated messages of the same value. Saves bandwidth, etc... -### Deadband modes +### Deadband and Narrowband modes -In deadband mode the incoming payload should contain a parseable *number* and is +In deadband modes the incoming payload should contain a parseable *number* and is output only if greater than + or - the *band gap* away from the previous output. -It can also be set to block values more than a certain distance away from the present value. -This can be used to remove outliers or unexpected readings. + +The narrowband modes will block if the incoming value change is greater than + or - the band gap +away from the previous value. Useful for ignoring outliers from a faulty sensor for example. You can specify compare with *previous valid output value* or *previous input value*. The former ignores any values outside the valid range, whereas the latter allows diff --git a/function/rbe/locales/en-US/rbe.html b/function/rbe/locales/en-US/rbe.html new file mode 100644 index 00000000..44d2068d --- /dev/null +++ b/function/rbe/locales/en-US/rbe.html @@ -0,0 +1,38 @@ + diff --git a/function/rbe/locales/en-US/rbe.json b/function/rbe/locales/en-US/rbe.json index d0d967bb..8adbb62a 100644 --- a/function/rbe/locales/en-US/rbe.json +++ b/function/rbe/locales/en-US/rbe.json @@ -1,5 +1,6 @@ { "rbe": { + "rbe": "rbe", "label": { "func": "Mode", "init": "Send initial value", diff --git a/function/rbe/locales/ja/rbe.html b/function/rbe/locales/ja/rbe.html new file mode 100644 index 00000000..cf2eea3e --- /dev/null +++ b/function/rbe/locales/ja/rbe.html @@ -0,0 +1,31 @@ + + + diff --git a/function/rbe/locales/ja/rbe.json b/function/rbe/locales/ja/rbe.json index fd913794..b4d76df0 100644 --- a/function/rbe/locales/ja/rbe.json +++ b/function/rbe/locales/ja/rbe.json @@ -13,12 +13,12 @@ "opts": { "rbe": "値が変化した時のみメッセージを中継", "rbei": "値が変化した時のみメッセージを中継(初期値を無視)", - "deadband": "値が比較値を超える時のみメッセージを中継", - "deadbandEq": "値が比較値以上の時のみメッセージを中継", - "narrowband": "初期値、値が比較値を超える時のみメッセージを中継", - "narrowbandEq": "初期値、値が比較値以上の時のみメッセージを中継", - "in": "を最後の入力値と比較", - "out": "を最後の出力値と比較" + "deadband": "値が指定した変化量を超える時のみメッセージを中継", + "deadbandEq": "値が指定した変化量以上の時のみメッセージを中継", + "narrowband": "値が指定した変化量を超えない時のみメッセージを中継", + "narrowbandEq": "値が指定した変化量以上でない時のみメッセージを中継", + "in": "最後の入力値と比較", + "out": "最後の出力値と比較" }, "warn": { "nonumber": "ペイロードに数値が含まれていません" diff --git a/function/rbe/package.json b/function/rbe/package.json index 6b1af48d..c66f41ee 100644 --- a/function/rbe/package.json +++ b/function/rbe/package.json @@ -1,7 +1,7 @@ { "name" : "node-red-node-rbe", - "version" : "0.1.14", - "description" : "A Node-RED node that provides report-by-exception (RBE) and deadband capability.", + "version" : "0.2.9", + "description" : "A Node-RED node that provides report-by-exception (RBE) and deadband capabilities.", "dependencies" : { }, "repository" : { diff --git a/function/rbe/rbe.html b/function/rbe/rbe.html index ecf951c2..70cad4c5 100644 --- a/function/rbe/rbe.html +++ b/function/rbe/rbe.html @@ -1,8 +1,8 @@ - - - - @@ -53,10 +61,12 @@ category: 'function', defaults: { name: {value:""}, + property: {value:"payload",required:true}, action: {value:"mean"}, count: {value:"10",required:true,validate:RED.validators.number()}, round: {value:""}, - mult: {value:"single"} + mult: {value:"single"}, + reduce: {value:false} }, inputs: 1, outputs: 1, @@ -67,7 +77,12 @@ labelStyle: function() { return this.name ? "node_label_italic" : ""; }, + outputLabels: function() { return this.reduce === true ? (this.action+" of "+this.count) : (this.action); }, oneditprepare: function() { + if (this.property === undefined) { + $("#node-input-property").val("payload"); + } + $("#node-input-property").typedInput({default:'msg',types:['msg']}); $("#node-input-count").spinner({ min:1 }); @@ -78,10 +93,12 @@ if ((a === "high") || ( a === "low" )) { $("#node-over").html("with a smoothing factor of "); $("#node-over2").html(""); + $("#row-input-reduce").hide(); } else { $("#node-over").html("over the most recent "); $("#node-over2").html(" values"); + $("#row-input-reduce").show(); } }); $("#node-input-action").change(); diff --git a/function/smooth/17-smooth.js b/function/smooth/17-smooth.js index c7fa914a..c34c04aa 100644 --- a/function/smooth/17-smooth.js +++ b/function/smooth/17-smooth.js @@ -9,11 +9,15 @@ module.exports = function(RED) { if (this.round == "true") { this.round = 0; } this.count = Number(n.count); this.mult = n.mult || "single"; + this.reduce = n.reduce || false; + this.property = n.property || "payload"; var node = this; var v = {}; this.on('input', function (msg) { + var value = RED.util.getMessageProperty(msg,node.property); var top = msg.topic || "_my_default_topic"; + var reduce = node.reduce; if (this.mult === "single") { top = "a"; } if ((v.hasOwnProperty(top) !== true) || msg.hasOwnProperty("reset")) { @@ -24,44 +28,51 @@ module.exports = function(RED) { v[top].pop = 0; v[top].old = null; v[top].count = this.count; + v[top].iter = 0; } - if (msg.hasOwnProperty("payload")) { - var n = Number(msg.payload); + if (value !== undefined) { + var n = Number(value); if (!isNaN(n)) { + v[top].iter++; if ((node.action === "low") || (node.action === "high")) { if (v[top].old == null) { v[top].old = n; } v[top].old = v[top].old + (n - v[top].old) / v[top].count; - if (node.action === "low") { msg.payload = v[top].old; } - else { msg.payload = n - v[top].old; } + if (node.action === "low") { value = v[top].old; } + else { value = n - v[top].old; } + reduce = false; } else { v[top].a.push(n); if (v[top].a.length > v[top].count) { v[top].pop = v[top].a.shift(); } if (node.action === "max") { - msg.payload = Math.max.apply(Math, v[top].a); + value = Math.max.apply(Math, v[top].a); } if (node.action === "min") { - msg.payload = Math.min.apply(Math, v[top].a); + value = Math.min.apply(Math, v[top].a); } if (node.action === "mean") { v[top].tot = v[top].tot + n - v[top].pop; - msg.payload = v[top].tot / v[top].a.length; + value = v[top].tot / v[top].a.length; } if (node.action === "sd") { v[top].tot = v[top].tot + n - v[top].pop; v[top].tot2 = v[top].tot2 + (n*n) - (v[top].pop * v[top].pop); if (v[top].a.length > 1) { - msg.payload = Math.sqrt((v[top].a.length * v[top].tot2 - v[top].tot * v[top].tot)/(v[top].a.length * (v[top].a.length - 1))); + value = Math.sqrt((v[top].a.length * v[top].tot2 - v[top].tot * v[top].tot)/(v[top].a.length * (v[top].a.length - 1))); } - else { msg.payload = 0; } + else { value = 0; } } } if (node.round !== false) { - msg.payload = Math.round(msg.payload * Math.pow(10, node.round)) / Math.pow(10, node.round); + value = Math.round(value * Math.pow(10, node.round)) / Math.pow(10, node.round); + } + if (reduce == false || v[top].iter == v[top].count) { + v[top].iter = 0; + RED.util.setMessageProperty(msg,node.property,value); + node.send(msg); } - node.send(msg); } - else { node.log("Not a number: "+msg.payload); } + else { node.log("Not a number: " + value); } } // ignore msg with no payload property. }); } diff --git a/function/smooth/package.json b/function/smooth/package.json index 349362fe..4dc0d67b 100644 --- a/function/smooth/package.json +++ b/function/smooth/package.json @@ -1,6 +1,6 @@ { "name" : "node-red-node-smooth", - "version" : "0.0.11", + "version" : "0.1.2", "description" : "A Node-RED node that provides several simple smoothing algorithms for incoming data values.", "dependencies" : { }, @@ -19,5 +19,6 @@ "name": "Dave Conway-Jones", "email": "ceejay@vnet.ibm.com", "url": "http://nodered.org" - } + }, + "contributors" : [ "@clickworkorange" ] } diff --git a/hardware/Arduino/35-arduino.html b/hardware/Arduino/35-arduino.html index d24ed1c0..b492fa28 100644 --- a/hardware/Arduino/35-arduino.html +++ b/hardware/Arduino/35-arduino.html @@ -1,13 +1,14 @@ - - - - - @@ -150,10 +152,7 @@ $("#node-config-lookup-serial-icon").addClass('fa-search'); $("#node-config-lookup-serial-icon").removeClass('spinner'); $("#node-config-lookup-serial").removeClass('disabled'); - var ports = []; - $.each(data, function(i, port) { - ports.push(port.comName); - }); + var ports = data || []; $("#node-config-input-device").autocomplete({ source:ports, minLength:0, diff --git a/hardware/Arduino/35-arduino.js b/hardware/Arduino/35-arduino.js index ca0a1d5c..8464312e 100644 --- a/hardware/Arduino/35-arduino.js +++ b/hardware/Arduino/35-arduino.js @@ -9,32 +9,46 @@ module.exports = function(RED) { function ArduinoNode(n) { RED.nodes.createNode(this,n); this.device = n.device || null; + this.running = false; + this.reported = false; var node = this; - node.board = Board(node.device, function(e) { - //console.log("ERR",e); - if ((e !== undefined) && (e.toString().indexOf("cannot open") !== -1) ) { - node.error(RED._("arduino.errors.portnotfound",{device:node.device})); - } - else if (e === undefined) { - node.board.on('ready', function() { - node.log(RED._("arduino.status.connected",{device:node.board.sp.path})); - if (RED.settings.verbose) { - node.log(RED._("arduino.status.version",{version:node.board.firmware.name+"-"+node.board.version.major+"."+node.board.version.minor})); + var startup = function() { + node.board = new Board(node.device, function(e) { + if ((e !== undefined) && (e.toString().indexOf("cannot open") !== -1) ) { + if (node.reported === false) { + node.error(RED._("arduino.errors.portnotfound",{device:node.device})); + node.reported = true; } - }); - } - node.board.on('close', function() { - node.error(RED._("arduino.status.portclosed")); + } + else if (e === undefined) { + node.running = true; + node.reported = false; + node.board.once('ready', function() { + node.log(RED._("arduino.status.connected",{device:node.board.sp.path})); + if (RED.settings.verbose) { + node.log(RED._("arduino.status.version",{version:node.board.firmware.name+"-"+node.board.version.major+"."+node.board.version.minor})); + } + }); + node.board.once('close', function() { + node.error(RED._("arduino.status.portclosed")); + }); + node.board.once('disconnect', function() { + if (node.running === true) { setTimeout(function() { node.running = false; startup(); }, 5000); } + }); + } }); - }); + setTimeout(function() { if (node.running === false) { startup(); } }, 5000); + }; + startup(); node.on('close', function(done) { + node.running = false; if (node.board) { try { - node.board.sp.close(function() { - done(); + node.board.transport.close(function() { if (RED.settings.verbose) { node.log(RED._("arduino.status.portclosed")); } + done(); }); } catch(e) { done(); } @@ -53,43 +67,69 @@ module.exports = function(RED) { this.state = n.state; this.arduino = n.arduino; this.serverConfig = RED.nodes.getNode(this.arduino); + this.running = false; + var node = this; if (typeof this.serverConfig === "object") { - this.board = this.serverConfig.board; - var node = this; - node.status({fill:"red",shape:"ring",text:"node-red:common.status.connecting"}); - var doit = function() { - node.status({fill:"green",shape:"dot",text:"node-red:common.status.connected"}); - if (node.state === "ANALOG") { - node.board.pinMode(node.pin, 0x02); - node.board.analogRead(node.pin, function(v) { - node.send({payload:v, topic:"A"+node.pin}); + var startup = function() { + node.board = node.serverConfig.board; + node.board.setMaxListeners(0); + node.oldval = ""; + node.status({fill:"grey",shape:"ring",text:"node-red:common.status.connecting"}); + var doit = function() { + node.running = true; + if (node.state === "ANALOG") { node.board.pinMode(node.pin, 0x02); } + if (node.state === "INPUT") { node.board.pinMode(node.pin, 0x00); } + if (node.state === "PULLUP") { node.board.pinMode(node.pin, 0x0B); } + node.status({fill:"green",shape:"dot",text:"node-red:common.status.connected"}); + if (node.state === "ANALOG") { + node.board.analogRead(node.pin, function(v) { + if (v !== node.oldval) { + node.oldval = v; + node.send({payload:v, topic:"A"+node.pin}); + } + }); + } + if (node.state === "INPUT") { + node.board.digitalRead(node.pin, function(v) { + if (v !== node.oldval) { + node.oldval = v; + node.send({payload:v, topic:node.pin}); + } + }); + } + if (node.state === "PULLUP") { + node.board.digitalRead(node.pin, function(v) { + if (v !== node.oldval) { + node.oldval = v; + node.send({payload:v, topic:node.pin}); + } + }); + } + if (node.state == "STRING") { + node.board.on('string', function(v) { + if (v !== node.oldval) { + node.oldval = v; + node.send({payload:v, topic:"string"}); + } + }); + } + node.board.once('disconnect', function() { + node.status({fill:"red",shape:"ring",text:"node-red:common.status.not-connected"}); + if (node.running) { setTimeout(function() { node.running = false; startup(); }, 5500); } }); } - if (node.state === "INPUT") { - node.board.pinMode(node.pin, 0x00); - node.board.digitalRead(node.pin, function(v) { - node.send({payload:v, topic:node.pin}); - }); - } - if (node.state == "STRING") { - node.board.on('string', function(v) { - node.send({payload:v, topic:"string"}); - }); - } - // node.board.on('close', function() { - // node.board.removeAllListeners(); - // node.status({fill:"grey",shape:"ring",text:"node-red:common.status.not-connected"}); - // }); + if (node.board.isReady) { doit(); } + else { node.board.once("ready", function() { doit(); }); } + setTimeout(function() { if (node.running === false) { startup(); } }, 4500); } - if (node.board.isReady) { doit(); } - else { node.board.on("ready", function() { doit(); }); } - node.on("close", function() { - if (node.tout) { clearTimeout(node.tout); } - }) + startup(); } else { - this.warn(RED._("arduino.errors.portnotconf")); + node.warn(RED._("arduino.errors.portnotconf")); } + node.on('close', function() { + node.running = false; + }); } RED.nodes.registerType("arduino in",DuinoNodeIn); @@ -102,63 +142,78 @@ module.exports = function(RED) { this.state = n.state; this.arduino = n.arduino; this.serverConfig = RED.nodes.getNode(this.arduino); - if (typeof this.serverConfig === "object") { - this.board = this.serverConfig.board; - var node = this; - node.status({fill:"red",shape:"ring",text:"node-red:common.status.connecting"}); - var doit = function() { - node.status({fill:"green",shape:"dot",text:"node-red:common.status.connected"}); - node.on("input", function(msg) { - if (node.state === "OUTPUT") { - node.board.pinMode(node.pin, 0x01); - if ((msg.payload === true)||(msg.payload.toString() == "1")||(msg.payload.toString().toLowerCase() == "on")) { - node.board.digitalWrite(node.pin, node.board.HIGH); + this.running = false; + var node = this; + if (typeof node.serverConfig === "object") { + var startup = function() { + node.board = node.serverConfig.board; + node.board.setMaxListeners(0); + node.status({fill:"grey",shape:"ring",text:"node-red:common.status.connecting"}); + var doit = function() { + node.running = true; + if (node.state === "OUTPUT") { node.board.pinMode(node.pin, 0x01); } + if (node.state === "PWM") { node.board.pinMode(node.pin, 0x03); } + if (node.state === "SERVO") { node.board.pinMode(node.pin, 0x04); } + node.status({fill:"green",shape:"dot",text:"node-red:common.status.connected"}); + node.on("input", function(msg) { + if (node.board.isReady) { + if (node.state === "OUTPUT") { + if ((msg.payload === true)||(msg.payload.toString() == "1")||(msg.payload.toString().toLowerCase() == "on")) { + node.board.digitalWrite(node.pin, node.board.HIGH); + } + if ((msg.payload === false)||(msg.payload.toString() == "0")||(msg.payload.toString().toLowerCase() == "off")) { + node.board.digitalWrite(node.pin, node.board.LOW); + } + } + if (node.state === "PWM") { + msg.payload = parseInt((msg.payload * 1) + 0.5); + if ((msg.payload >= 0) && (msg.payload <= 255)) { + node.board.analogWrite(node.pin, msg.payload); + } + } + if (node.state === "SERVO") { + msg.payload = parseInt((msg.payload * 1) + 0.5); + if ((msg.payload >= 0) && (msg.payload <= 180)) { + node.board.servoWrite(node.pin, msg.payload); + } + } + if (node.state === "SYSEX") { + node.board.sysexCommand(msg.payload); + } + if (node.state === "STRING") { + node.board.sendString(msg.payload.toString()); + } } - if ((msg.payload === false)||(msg.payload.toString() == "0")||(msg.payload.toString().toLowerCase() == "off")) { - node.board.digitalWrite(node.pin, node.board.LOW); - } - } - if (node.state === "PWM") { - node.board.pinMode(node.pin, 0x03); - msg.payload = parseInt((msg.payload * 1) + 0.5); - if ((msg.payload >= 0) && (msg.payload <= 255)) { - node.board.analogWrite(node.pin, msg.payload); - } - } - if (node.state === "SERVO") { - node.board.pinMode(node.pin, 0x04); - msg.payload = parseInt((msg.payload * 1) + 0.5); - if ((msg.payload >= 0) && (msg.payload <= 180)) { - node.board.servoWrite(node.pin, msg.payload); - } - } - if (node.state === "SYSEX") { - node.board.sysexCommand(msg.payload); - } - if (node.state === "STRING") { - node.board.sendString(msg.payload.toString()); - } - }); - // node.board.on('close', function() { - // node.status({fill:"grey",shape:"ring",text:"node-red:common.status.not-connected"}); - // }); + }); + node.board.once('disconnect', function() { + node.status({fill:"red",shape:"ring",text:"node-red:common.status.not-connected"}); + if (node.running === true) { setTimeout(function() { node.running = false; startup(); }, 5500); } + }); + } + if (node.board.isReady) { doit(); } + else { node.board.once("ready", function() { doit(); }); } + setTimeout(function() { if (node.running === false) { startup(); } }, 4500); } - if (node.board.isReady) { doit(); } - else { node.board.on("ready", function() { doit(); }); } - node.on("close", function() { - if (node.tout) { clearTimeout(node.tout); } - }) + startup(); } else { - this.warn(RED._("arduino.errors.portnotconf")); + node.warn(RED._("arduino.errors.portnotconf")); } + node.on('close', function() { + node.running = false; + }); } RED.nodes.registerType("arduino out",DuinoNodeOut); RED.httpAdmin.get("/arduinoports", RED.auth.needsPermission("arduino.read"), function(req,res) { - SP.list(function(error, ports) { - res.json(ports); - }); - + SP.list().then( + ports => { + const a = ports.map(p => p.comName); + res.json(a); + }, + err => { + this.log('Error listing serial ports', err) + } + ) }); } diff --git a/hardware/Arduino/README.md b/hardware/Arduino/README.md index 9bce8882..ee3f08d4 100644 --- a/hardware/Arduino/README.md +++ b/hardware/Arduino/README.md @@ -7,7 +7,7 @@ Arduino running standard firmata 2.2 or better. Install ------- -Run the following command in your Node-RED user directory - typically `~/.node-red` +Either use the Menu - Manage Palette option or run the following command in your Node-RED user directory - typically `~/.node-red` npm i --unsafe-perm node-red-node-arduino @@ -23,12 +23,10 @@ details and examples of how to use this node. Connects to local Arduino and monitors the selected pin for changes. -You can select either **Digital**, **Analogue**, or **String** input type. +You can select either **Digital**, **Pullup**, **Analogue**, or **String** input type. Outputs the value read as `msg.payload` and the pin number as `msg.topic`. -It only outputs on a change of value - fine for digital inputs, but you can get a lot of data from analogue pins which you must then handle. - -You can set the sample rate from `20` to `65535` mS. +It only outputs on a change of value - fine for digital inputs, but you can get a lot of data from analogue pins which you must then handle. For example you could use a `delay` node set to rate limit and drop intermediate values, or an `rbe` node to only report when it changes by a certain amount. ### Output Node diff --git a/hardware/Arduino/locales/en-US/35-arduino.json b/hardware/Arduino/locales/en-US/35-arduino.json index 7e731a50..640bfdc1 100644 --- a/hardware/Arduino/locales/en-US/35-arduino.json +++ b/hardware/Arduino/locales/en-US/35-arduino.json @@ -18,6 +18,7 @@ "state": { "in": { "digital": "Digital pin", + "pullup": "Digital pin with pullup", "analogue": "Analogue pin", "string": "String" }, diff --git a/hardware/Arduino/package.json b/hardware/Arduino/package.json index 53aa3d7d..14a9d18f 100644 --- a/hardware/Arduino/package.json +++ b/hardware/Arduino/package.json @@ -1,9 +1,9 @@ { "name" : "node-red-node-arduino", - "version" : "0.0.14", + "version" : "0.3.1", "description" : "A Node-RED node to talk to an Arduino running firmata", "dependencies" : { - "firmata" : "~0.17.0" + "firmata" : "^2.3.0" }, "repository" : { "type":"git", @@ -16,6 +16,7 @@ "arduino": "35-arduino.js" } }, + "engines" : { "node" : ">=8" }, "author": { "name": "Dave Conway-Jones", "email": "ceejay@vnet.ibm.com", diff --git a/hardware/LEDborg/78-ledborg.js b/hardware/LEDborg/78-ledborg.js index dea2ebe9..e9aee071 100644 --- a/hardware/LEDborg/78-ledborg.js +++ b/hardware/LEDborg/78-ledborg.js @@ -8,23 +8,26 @@ module.exports = function(RED) { var LedBorgInUse = false; var gpioCommand = __dirname+'/nrgpio'; + var allOK = true; try { var cpuinfo = fs.readFileSync("/proc/cpuinfo").toString(); - if (cpuinfo.indexOf(": BCM") === -1) { throw "Info : "+RED._("rpi-gpio.errors.ignorenode"); } + if (cpuinfo.indexOf(": BCM") === -1) { + RED.log.warn("ledborg : "+RED._("node-red:rpi-gpio.errors.ignorenode")); + allOK = false; + } + else if (!fs.existsSync("/usr/share/doc/python-rpi.gpio")) { + RED.log.warn("ledborg : "+RED._("node-red:rpi-gpio.errors.libnotfound")); + allOK = false; + } + else if ( !(1 & parseInt ((fs.statSync(gpioCommand).mode & parseInt ("777", 8)).toString (8)[0]) )) { + RED.log.warn("ledborg : "+RED._("node-red:rpi-gpio.errors.needtobeexecutable",{command:gpioCommand})); + allOK = false; + } } catch(err) { - throw "Info : "+RED._("rpi-gpio.errors.ignorenode"); - } - - if (!fs.existsSync("/usr/share/doc/python-rpi.gpio")) { - util.log("[rpi-ledborg] Info : Can't find RPi.GPIO python library."); - throw "Warning : Can't find RPi.GPIO python library."; - } - - if ( !(1 & parseInt ((fs.statSync(gpioCommand).mode & parseInt ("777", 8)).toString (8)[0]) )) { - util.log("[rpi-ledborg] Error : "+gpioCommand+" needs to be executable."); - throw "Error : nrgpio must to be executable."; + RED.log.warn("ledborg : "+RED._("node-red:rpi-gpio.errors.ignorenode")); + allOK = false; } // GPIO pins 11 (R), 13 (G), 15 (B). @@ -95,46 +98,50 @@ module.exports = function(RED) { } } - node.child = spawn(gpioCommand, ["borg","11"]); - node.running = true; - node.status({fill:"green",shape:"dot",text:"OK"}); + if (allOK === true) { + node.child = spawn(gpioCommand, ["borg","11"]); + node.running = true; + node.status({fill:"green",shape:"dot",text:"OK"}); - node.on("input", inputlistener); + node.on("input", inputlistener); - node.child.stdout.on('data', function (data) { - if (RED.settings.verbose) { node.log("out: "+data+" :"); } - }); + node.child.stdout.on('data', function (data) { + if (RED.settings.verbose) { node.log("out: "+data+" :"); } + }); - node.child.stderr.on('data', function (data) { - if (RED.settings.verbose) { node.log("err: "+data+" :"); } - }); + node.child.stderr.on('data', function (data) { + if (RED.settings.verbose) { node.log("err: "+data+" :"); } + }); - node.child.on('close', function () { - node.child = null; - node.running = false; - node.status({fill:"red",shape:"circle",text:""}); - if (RED.settings.verbose) { node.log("closed"); } - if (node.done) { node.done(); } - }); + node.child.on('close', function () { + node.child = null; + node.running = false; + node.status({fill:"red",shape:"circle",text:""}); + if (RED.settings.verbose) { node.log("closed"); } + if (node.finished) { node.finished(); } + }); - node.child.on('error', function (err) { - if (err.errno === "ENOENT") { node.warn('Command not found'); } - else if (err.errno === "EACCES") { node.warn('Command not executable'); } - else { node.log('error: ' + err); } - }); + node.child.on('error', function (err) { + if (err.errno === "ENOENT") { node.warn('Command not found'); } + else if (err.errno === "EACCES") { node.warn('Command not executable'); } + else { node.log('error: ' + err); } + }); - node.on("close", function(done) { + node.on("close", function(done) { + LedBorgInUse = false; + node.status({fill:"red",shape:"circle",text:""}); + if (node.child != null) { + node.fisnished = done; + node.child.stdin.write(" close 11"); + node.child.kill('SIGKILL'); + } + else { done(); } + }); + } + else { LedBorgInUse = false; - node.status({fill:"red",shape:"circle",text:""}); - if (node.child != null) { - node.done = done; - node.child.stdin.write(" close 11"); - node.child.kill('SIGKILL'); - } - else { done(); } - - }); - + node.status({fill:"grey",shape:"dot",text:"node-red:rpi-gpio.status.not-available"}); + } } RED.nodes.registerType("ledborg",LedBorgNode); } diff --git a/hardware/LEDborg/nrgpio.py b/hardware/LEDborg/nrgpio.py index da5213af..e284d1e6 100755 --- a/hardware/LEDborg/nrgpio.py +++ b/hardware/LEDborg/nrgpio.py @@ -4,11 +4,12 @@ import RPi.GPIO as GPIO import sys -bounce = 20 # bounce time in mS to apply +try: + raw_input # Python 2 +except NameError: + raw_input = input # Python 3 -if sys.version_info >= (3,0): - print("Sorry - currently only configured to work with python 2.x") - sys.exit(1) +bounce = 20 # bounce time in mS to apply if len(sys.argv) > 1: cmd = sys.argv[1].lower() @@ -17,7 +18,7 @@ if len(sys.argv) > 1: GPIO.setwarnings(False) if cmd == "pwm": - #print "Initialised pin "+str(pin)+" to PWM" + #print("Initialised pin "+str(pin)+" to PWM") GPIO.setup(pin,GPIO.OUT) p = GPIO.PWM(pin, 100) p.start(0) @@ -32,10 +33,10 @@ if len(sys.argv) > 1: GPIO.cleanup(pin) sys.exit(0) except Exception as ex: - print "bad data: "+data + print("bad data: "+data) elif cmd == "buzz": - #print "Initialised pin "+str(pin)+" to Buzz" + #print("Initialised pin "+str(pin)+" to Buzz") GPIO.setup(pin,GPIO.OUT) p = GPIO.PWM(pin, 100) p.stop() @@ -54,10 +55,10 @@ if len(sys.argv) > 1: GPIO.cleanup(pin) sys.exit(0) except Exception as ex: - print "bad data: "+data + print("bad data: "+data) elif cmd == "out": - #print "Initialised pin "+str(pin)+" to OUT" + #print("Initialised pin "+str(pin)+" to OUT") GPIO.setup(pin,GPIO.OUT) if len(sys.argv) == 4: GPIO.output(pin,int(sys.argv[3])) @@ -78,9 +79,9 @@ if len(sys.argv) > 1: GPIO.output(pin,data) elif cmd == "in": - #print "Initialised pin "+str(pin)+" to IN" + #print("Initialised pin "+str(pin)+" to IN") def handle_callback(chan): - print GPIO.input(chan) + print(GPIO.input(chan)) if len(sys.argv) == 4: if sys.argv[3].lower() == "up": @@ -91,7 +92,7 @@ if len(sys.argv) > 1: GPIO.setup(pin,GPIO.IN) else: GPIO.setup(pin,GPIO.IN) - print GPIO.input(pin) + print(GPIO.input(pin)) GPIO.add_event_detect(pin, GPIO.BOTH, callback=handle_callback, bouncetime=bounce) while True: @@ -104,7 +105,7 @@ if len(sys.argv) > 1: sys.exit(0) elif cmd == "byte": - #print "Initialised BYTE mode - "+str(pin)+ + #print("Initialised BYTE mode - "+str(pin)+) list = [7,11,13,12,15,16,18,22] GPIO.setup(list,GPIO.OUT) @@ -127,7 +128,7 @@ if len(sys.argv) > 1: GPIO.output(list[bit], data & mask) elif cmd == "borg": - #print "Initialised BORG mode - "+str(pin)+ + #print("Initialised BORG mode - "+str(pin)+) GPIO.setup(11,GPIO.OUT) GPIO.setup(13,GPIO.OUT) GPIO.setup(15,GPIO.OUT) @@ -154,10 +155,10 @@ if len(sys.argv) > 1: data = 0 elif cmd == "rev": - print GPIO.RPI_REVISION + print(GPIO.RPI_REVISION) elif cmd == "ver": - print GPIO.VERSION + print(GPIO.VERSION) elif cmd == "mouse": # catch mice button events file = open( "/dev/input/mice", "rb" ) @@ -171,7 +172,7 @@ if len(sys.argv) > 1: button = ord( buf[0] ) & pin # mask out just the required button(s) if button != oldbutt: # only send if changed oldbutt = button - print button + print(button) while True: try: @@ -181,4 +182,4 @@ if len(sys.argv) > 1: sys.exit(0) else: - print "Bad parameters - in|out|pwm|buzz|byte|borg|mouse|ver pin {value|up|down}" + print("Bad parameters - in|out|pwm|buzz|byte|borg|mouse|ver pin {value|up|down}") diff --git a/hardware/LEDborg/package.json b/hardware/LEDborg/package.json index 787b388a..9d5dbdb7 100644 --- a/hardware/LEDborg/package.json +++ b/hardware/LEDborg/package.json @@ -1,6 +1,6 @@ { "name" : "node-red-node-ledborg", - "version" : "0.0.18", + "version" : "0.0.22", "description" : "A Node-RED node to control a PiBorg LedBorg board for a Raspberry Pi.", "dependencies" : { }, diff --git a/hardware/PiGpio/36-rpi-gpio.html b/hardware/PiGpio/36-rpi-gpio.html new file mode 100644 index 00000000..a4a66deb --- /dev/null +++ b/hardware/PiGpio/36-rpi-gpio.html @@ -0,0 +1,610 @@ + + + + + + + + + + + + + + + + diff --git a/hardware/PiGpio/36-rpi-gpio.js b/hardware/PiGpio/36-rpi-gpio.js new file mode 100644 index 00000000..1c263f30 --- /dev/null +++ b/hardware/PiGpio/36-rpi-gpio.js @@ -0,0 +1,359 @@ + +module.exports = function(RED) { + "use strict"; + var execSync = require('child_process').execSync; + var exec = require('child_process').exec; + var spawn = require('child_process').spawn; + + var testCommand = __dirname+'/testgpio.py' + var gpioCommand = __dirname+'/nrgpio'; + var allOK = true; + + try { + execSync(testCommand); + } catch(err) { + allOK = false; + RED.log.warn("rpi-gpio : "+RED._("rpi-gpio.errors.ignorenode")); + } + + // the magic to make python print stuff immediately + process.env.PYTHONUNBUFFERED = 1; + + var pinsInUse = {}; + var pinTypes = {"out":RED._("rpi-gpio.types.digout"), "tri":RED._("rpi-gpio.types.input"), "up":RED._("rpi-gpio.types.pullup"), "down":RED._("rpi-gpio.types.pulldown"), "pwm":RED._("rpi-gpio.types.pwmout")}; + + function GPIOInNode(n) { + RED.nodes.createNode(this,n); + this.buttonState = -1; + this.pin = n.pin; + this.intype = n.intype; + this.read = n.read || false; + this.debounce = Number(n.debounce || 25); + if (this.read) { this.buttonState = -2; } + var node = this; + if (!pinsInUse.hasOwnProperty(this.pin)) { + pinsInUse[this.pin] = this.intype; + } + else { + if ((pinsInUse[this.pin] !== this.intype)||(pinsInUse[this.pin] === "pwm")) { + node.warn(RED._("rpi-gpio.errors.alreadyset",{pin:this.pin,type:pinTypes[pinsInUse[this.pin]]})); + } + } + + if (allOK === true) { + if (node.pin !== undefined) { + node.child = spawn(gpioCommand, ["in",node.pin,node.intype,node.debounce]); + node.running = true; + node.status({fill:"yellow",shape:"dot",text:"rpi-gpio.status.ok"}); + + node.child.stdout.on('data', function (data) { + var d = data.toString().trim().split("\n"); + for (var i = 0; i < d.length; i++) { + if (d[i] === '') { return; } + if (node.running && node.buttonState !== -1 && !isNaN(Number(d[i])) && node.buttonState !== d[i]) { + node.send({ topic:"pi/"+node.pin, payload:Number(d[i]) }); + } + node.buttonState = d[i]; + node.status({fill:"green",shape:"dot",text:d[i]}); + if (RED.settings.verbose) { node.log("out: "+d[i]+" :"); } + } + }); + + node.child.stderr.on('data', function (data) { + if (RED.settings.verbose) { node.log("err: "+data+" :"); } + }); + + node.child.on('close', function (code) { + node.running = false; + node.child = null; + if (RED.settings.verbose) { node.log(RED._("rpi-gpio.status.closed")); } + if (node.finished) { + node.status({fill:"grey",shape:"ring",text:"rpi-gpio.status.closed"}); + node.finished(); + } + else { node.status({fill:"red",shape:"ring",text:"rpi-gpio.status.stopped"}); } + }); + + node.child.on('error', function (err) { + if (err.errno === "ENOENT") { node.error(RED._("rpi-gpio.errors.commandnotfound")); } + else if (err.errno === "EACCES") { node.error(RED._("rpi-gpio.errors.commandnotexecutable")); } + else { node.error(RED._("rpi-gpio.errors.error",{error:err.errno})) } + }); + + } + else { + node.warn(RED._("rpi-gpio.errors.invalidpin")+": "+node.pin); + } + } + else { + node.status({fill:"grey",shape:"dot",text:"rpi-gpio.status.not-available"}); + if (node.read === true) { + var val; + if (node.intype == "up") { val = 1; } + if (node.intype == "down") { val = 0; } + setTimeout(function() { + node.send({ topic:"pi/"+node.pin, payload:val }); + node.status({fill:"grey",shape:"dot",text:RED._("rpi-gpio.status.na",{value:val})}); + },250); + } + } + + node.on("close", function(done) { + node.status({fill:"grey",shape:"ring",text:"rpi-gpio.status.closed"}); + delete pinsInUse[node.pin]; + if (node.child != null) { + node.finished = done; + node.child.stdin.write("close "+node.pin); + node.child.kill('SIGKILL'); + } + else { done(); } + }); + } + RED.nodes.registerType("rpi-gpio in",GPIOInNode); + + function GPIOOutNode(n) { + RED.nodes.createNode(this,n); + this.pin = n.pin; + this.set = n.set || false; + this.level = n.level || 0; + this.freq = n.freq || 100; + this.out = n.out || "out"; + var node = this; + if (!pinsInUse.hasOwnProperty(this.pin)) { + pinsInUse[this.pin] = this.out; + } + else { + if ((pinsInUse[this.pin] !== this.out)||(pinsInUse[this.pin] === "pwm")) { + node.warn(RED._("rpi-gpio.errors.alreadyset",{pin:this.pin,type:pinTypes[pinsInUse[this.pin]]})); + } + } + + function inputlistener(msg, send, done) { + if (msg.payload === "true") { msg.payload = true; } + if (msg.payload === "false") { msg.payload = false; } + var out = Number(msg.payload); + var limit = 1; + if (node.out === "pwm") { limit = 100; } + if ((out >= 0) && (out <= limit)) { + if (RED.settings.verbose) { node.log("out: "+out); } + if (node.child !== null) { + node.child.stdin.write(out+"\n", () => { + if (done) { done(); } + }); + node.status({fill:"green",shape:"dot",text:msg.payload.toString()}); + } + else { + node.error(RED._("rpi-gpio.errors.pythoncommandnotfound"),msg); + node.status({fill:"red",shape:"ring",text:"rpi-gpio.status.not-running"}); + } + } + else { node.warn(RED._("rpi-gpio.errors.invalidinput")+": "+out); } + } + + if (allOK === true) { + if (node.pin !== undefined) { + if (node.set && (node.out === "out")) { + node.child = spawn(gpioCommand, [node.out,node.pin,node.level]); + node.status({fill:"green",shape:"dot",text:node.level}); + } else { + node.child = spawn(gpioCommand, [node.out,node.pin,node.freq]); + node.status({fill:"yellow",shape:"dot",text:"rpi-gpio.status.ok"}); + } + node.running = true; + + node.on("input", inputlistener); + + node.child.stdout.on('data', function (data) { + if (RED.settings.verbose) { node.log("out: "+data+" :"); } + }); + + node.child.stderr.on('data', function (data) { + if (RED.settings.verbose) { node.log("err: "+data+" :"); } + }); + + node.child.on('close', function (code) { + node.child = null; + node.running = false; + if (RED.settings.verbose) { node.log(RED._("rpi-gpio.status.closed")); } + if (node.finished) { + node.status({fill:"grey",shape:"ring",text:"rpi-gpio.status.closed"}); + node.finished(); + } + else { node.status({fill:"red",shape:"ring",text:"rpi-gpio.status.stopped"}); } + }); + + node.child.on('error', function (err) { + if (err.errno === "ENOENT") { node.error(RED._("rpi-gpio.errors.commandnotfound")); } + else if (err.errno === "EACCES") { node.error(RED._("rpi-gpio.errors.commandnotexecutable")); } + else { node.error(RED._("rpi-gpio.errors.error")+': ' + err.errno); } + }); + + } + else { + node.warn(RED._("rpi-gpio.errors.invalidpin")+": "+node.pin); + } + } + else { + node.status({fill:"grey",shape:"dot",text:"rpi-gpio.status.not-available"}); + node.on("input", function(msg) { + node.status({fill:"grey",shape:"dot",text:RED._("rpi-gpio.status.na",{value:msg.payload.toString()})}); + }); + } + + node.on("close", function(done) { + node.status({fill:"grey",shape:"ring",text:"rpi-gpio.status.closed"}); + delete pinsInUse[node.pin]; + if (node.child != null) { + node.finished = done; + node.child.stdin.write("close "+node.pin); + node.child.kill('SIGKILL'); + } + else { done(); } + }); + + } + RED.nodes.registerType("rpi-gpio out",GPIOOutNode); + + function PiMouseNode(n) { + RED.nodes.createNode(this,n); + this.butt = n.butt || 7; + var node = this; + + if (allOK === true) { + node.child = spawn(gpioCommand+".py", ["mouse",node.butt]); + node.status({fill:"green",shape:"dot",text:"rpi-gpio.status.ok"}); + + node.child.stdout.on('data', function (data) { + data = Number(data); + if (data !== 0) { node.send({ topic:"pi/mouse", button:data, payload:1 }); } + else { node.send({ topic:"pi/mouse", button:data, payload:0 }); } + }); + + node.child.stderr.on('data', function (data) { + if (RED.settings.verbose) { node.log("err: "+data+" :"); } + }); + + node.child.on('close', function (code) { + node.child = null; + node.running = false; + if (RED.settings.verbose) { node.log(RED._("rpi-gpio.status.closed")); } + if (node.finished) { + node.status({fill:"grey",shape:"ring",text:"rpi-gpio.status.closed"}); + node.finished(); + } + else { node.status({fill:"red",shape:"ring",text:"rpi-gpio.status.stopped"}); } + }); + + node.child.on('error', function (err) { + if (err.errno === "ENOENT") { node.error(RED._("rpi-gpio.errors.commandnotfound")); } + else if (err.errno === "EACCES") { node.error(RED._("rpi-gpio.errors.commandnotexecutable")); } + else { node.error(RED._("rpi-gpio.errors.error")+': ' + err.errno); } + }); + + node.on("close", function(done) { + node.status({fill:"grey",shape:"ring",text:"rpi-gpio.status.closed"}); + if (node.child != null) { + node.finished = done; + node.child.kill('SIGINT'); + node.child = null; + } + else { done(); } + }); + } + else { + node.status({fill:"grey",shape:"dot",text:"rpi-gpio.status.not-available"}); + } + } + RED.nodes.registerType("rpi-mouse",PiMouseNode); + + function PiKeyboardNode(n) { + RED.nodes.createNode(this,n); + var node = this; + + var doConnect = function() { + node.child = spawn(gpioCommand+".py", ["kbd","0"]); + node.status({fill:"green",shape:"dot",text:"rpi-gpio.status.ok"}); + + node.child.stdout.on('data', function (data) { + var d = data.toString().trim().split("\n"); + for (var i = 0; i < d.length; i++) { + if (d[i] !== '') { + var b = d[i].trim().split(","); + var act = "up"; + if (b[1] === "1") { act = "down"; } + if (b[1] === "2") { act = "repeat"; } + node.send({ topic:"pi/key", payload:Number(b[0]), action:act }); + } + } + }); + + node.child.stderr.on('data', function (data) { + if (RED.settings.verbose) { node.log("err: "+data+" :"); } + }); + + node.child.on('close', function (code) { + node.running = false; + node.child = null; + if (RED.settings.verbose) { node.log(RED._("rpi-gpio.status.closed")); } + if (node.finished) { + node.status({fill:"grey",shape:"ring",text:"rpi-gpio.status.closed"}); + node.finished(); + } + else { + node.status({fill:"red",shape:"ring",text:"rpi-gpio.status.stopped"}); + setTimeout(function() { doConnect(); },2000) + } + }); + + node.child.on('error', function (err) { + if (err.errno === "ENOENT") { node.error(RED._("rpi-gpio.errors.commandnotfound")); } + else if (err.errno === "EACCES") { node.error(RED._("rpi-gpio.errors.commandnotexecutable")); } + else { node.error(RED._("rpi-gpio.errors.error")+': ' + err.errno); } + }); + } + + if (allOK === true) { + doConnect(); + + node.on("close", function(done) { + node.status({}); + if (node.child != null) { + node.finished = done; + node.child.kill('SIGINT'); + node.child = null; + } + else { done(); } + }); + } + else { + node.status({fill:"grey",shape:"dot",text:"rpi-gpio.status.not-available"}); + } + } + RED.nodes.registerType("rpi-keyboard",PiKeyboardNode); + + var pitype = { type:"" }; + if (allOK === true) { + exec(gpioCommand+" info", function(err,stdout,stderr) { + if (err) { + RED.log.info(RED._("rpi-gpio.errors.version")); + } + else { + try { + var info = JSON.parse( stdout.trim().replace(/\'/g,"\"") ); + pitype.type = info["TYPE"]; + } + catch(e) { + RED.log.info(RED._("rpi-gpio.errors.sawpitype"),stdout.trim()); + } + } + }); + } + + RED.httpAdmin.get('/rpi-gpio/:id', RED.auth.needsPermission('rpi-gpio.read'), function(req,res) { + res.json(pitype); + }); + + RED.httpAdmin.get('/rpi-pins/:id', RED.auth.needsPermission('rpi-gpio.read'), function(req,res) { + res.json(pinsInUse); + }); +} diff --git a/hardware/PiGpio/LICENSE b/hardware/PiGpio/LICENSE new file mode 100644 index 00000000..f433b1a5 --- /dev/null +++ b/hardware/PiGpio/LICENSE @@ -0,0 +1,177 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/hardware/PiGpio/README.md b/hardware/PiGpio/README.md new file mode 100644 index 00000000..e4b548b2 --- /dev/null +++ b/hardware/PiGpio/README.md @@ -0,0 +1,63 @@ +node-red-node-pi-gpio +===================== + +A set of Node-RED nodes to interact with Pi GPIO using the RPi.GPIO python library that is part of Raspbian. + +It also include a simple node that detect mouse buttons and also keyboard clicks. Note: this +picks up mouse keys direct from the keyboard so should work even when the app does not have +focus, but YMMV. + +If you need servo control then look at the +node-red-node-pi-gpiod node +as this is a lot more accurate timing wise, and more suitable for driving servos + +## Install + +Either use the Node-RED Menu - Manage Palette option to install, or run the following +command in your Node-RED user directory - typically `~/.node-red` + + npm i node-red-node-pi-gpio + +The python library may also work with other distros running on a Pi (like Ubuntu or Debian) - you will need to install the PIGPIO package and run the following commands in order to gain full access to the GPIO pins as this ability is not part of the default distro. This is NOT necessary on Raspbian. + + sudo apt-get install python-pip python-dev + sudo pip install RPi.GPIO + sudo addgroup gpio + sudo chown root:gpio /dev/gpiomem + sudo adduser $USER gpio + echo 'KERNEL=="gpiomem", NAME="%k", GROUP="gpio", MODE="0660"' | sudo tee /etc/udev/rules.d/45-gpio.rules + sudo udevadm control --reload-rules && sudo udevadm trigger + +## Usage + +**Note:** the pin numbers refer the physical pin numbers on connector P1 as they are easier to locate. + +### Input node + +Generates a `msg.payload` with either a 0 or 1 depending on the state of the input pin. + +##### Outputs + + - `msg.payload` - *number* - the level of the pin (0 or 1) + - `msg.topic` - *string* - pi/{the pin number} + +You may also enable the input pullup resistor ↑ or the pulldown resistor ↓. + +### Output node + +Can be used in Digital or PWM modes. + +##### Input + + - `msg.payload` - *number | string* + - Digital - 0, 1 - set pin low or high. (Can also accept boolean `true/false`) + - PWM - 0 to 100 - level from 0 to 100% + +*Hint*: The `range` node can be used to scale inputs to the correct values. + +Digital mode expects a `msg.payload` 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. + +The initial value of the pin at deploy time can also be set to 0 or 1. + +When using PWM mode, the input value should be a number 0 - 100, and can be floating point. diff --git a/hardware/PiGpio/locales/de/36-rpi-gpio.html b/hardware/PiGpio/locales/de/36-rpi-gpio.html new file mode 100644 index 00000000..30164ebc --- /dev/null +++ b/hardware/PiGpio/locales/de/36-rpi-gpio.html @@ -0,0 +1,74 @@ + + + + + + + + + diff --git a/hardware/PiGpio/locales/de/36-rpi-gpio.json b/hardware/PiGpio/locales/de/36-rpi-gpio.json new file mode 100644 index 00000000..e1d44a8b --- /dev/null +++ b/hardware/PiGpio/locales/de/36-rpi-gpio.json @@ -0,0 +1,73 @@ +"rpi-gpio" : { + "label" : { + "gpiopin" : "GPIO", + "selectpin" : "Auswahlstift", + "resistor" : "Widerstand?", + "readinitial" : "Anfangsstatus des Pins bei Implementierung/Neustart lesen?", + "type" : "Typ", + "initpin" : "Pin-Status initialisieren?", + "debounce" : "Debounce", + "freq" : "Frequenz", + "button" : "Knopf", + "pimouse" : "Pi-Maus", + "pikeyboard" : "Pi-Tastatur", + "left" : "Links", + "right" : "Rechts", + "middle" : "Mitte" + }, + "resistor" : { + "none" : "keine", + "pullup" : "pullup", + "pulldown" : "Pulldown" + }, + "digout" : "Digitale Ausgabe", + "pwmout" : "PWM-Ausgabe", + "servo" : "Servo-Ausgabe", + "initpin0" : "Anfangsstand des Pin-Niedrig (0)", + "initpin1" : "Anfangsebene von Pin-High (1)", + "left" : "links", + "right" : "rechts", + "middle" : "Mitte", + "any" : "beliebig", + "pinname" : "Pin", + "alreadyuse" : "bereits im Gebrauch", + "alreadyset" : "bereits festgelegt als", + "tip" : { + "pin" : " Verwender Pins : ", + "in" : "Tipp: Es wird nur die digitale Eingabe unterstützt. Die Eingabe muss 0 oder 1 sein.", + "dig" : "Tipp: Für die digitale Ausgabe muss der Wert 0 oder 1 sein.", + "pwm" : "Tipp: Für die PWM-Ausgabe muss der Wert zwischen 0 und 100 liegen; die Einstellung der Hochfrequenz kann mehr CPU beanspruchen als erwartet.", + "ser" : " Tipp : Für die Servo-Ausgabe muss ein Wert zwischen 0 und 100 eingegeben werden. 50 ist das Zentrum." + }, + "types" : { + "digout" : "digitale Ausgabe", + "input" : "Eingabe", + "pullup" : "Eingabe mit Pull-up", + "pulldown" : "Eingabe mit Pull-down", + "pwmout" : "PWM-Ausgabe", + "servo" : "Servo-Ausgabe" + }, + "status" : { + "stopped" : "Gestoppt", + "closed" : "geschlossen", + "not-running" : "nicht aktiv", + "not-available" : "nicht verfügbar", + "na" : "N/A: __Wert__", + "ok": "OK" + }, + "errors" : { + "ignorenode" : "Raspberry Pi-spezifische Nodes inaktiv", + "version" : "Abrufen der Version von Pi fehlgeschlagen", + "sawpitype" : "Saw-Pi-Typ", + "libnotfound" : "Pi RPi.GPIO-Python-Bibliothek nicht gefunden", + "alreadyset" : "GPIO-Stift __pin__ ist bereits als Typ festgelegt: __type__", + "invalidpin" : "Ungültiger GPIO-Pin", + "invalidinput" : "Ungültige Eingabe", + "needtobeexecutable" : "__command__ muss ausführbar sein", + "mustbeexecutable" : "nrgpio muss ausführbar sein", + "commandnotfound" : "Befehl 'nrgpio' nicht gefunden", + "commandnotexecutable" : "nrgpio-Befehl nicht ausführbar", + "error" : "Fehler: __error__", + "pythoncommandnotfound" : "Befehl 'nrgpio python' nicht aktiv" + } + } diff --git a/hardware/PiGpio/locales/en-US/36-rpi-gpio.html b/hardware/PiGpio/locales/en-US/36-rpi-gpio.html new file mode 100644 index 00000000..5659c686 --- /dev/null +++ b/hardware/PiGpio/locales/en-US/36-rpi-gpio.html @@ -0,0 +1,75 @@ + + + + + + + + + diff --git a/hardware/PiGpio/locales/en-US/36-rpi-gpio.json b/hardware/PiGpio/locales/en-US/36-rpi-gpio.json new file mode 100644 index 00000000..8931f170 --- /dev/null +++ b/hardware/PiGpio/locales/en-US/36-rpi-gpio.json @@ -0,0 +1,75 @@ +{ + "rpi-gpio": { + "label": { + "gpiopin": "GPIO", + "selectpin": "select pin", + "resistor": "Resistor?", + "readinitial": "Read initial state of pin on deploy/restart?", + "type": "Type", + "initpin": "Initialise pin state?", + "debounce": "Debounce", + "freq": "Frequency", + "button": "Button", + "pimouse": "Pi Mouse", + "pikeyboard": "Pi Keyboard", + "left": "Left", + "right": "Right", + "middle": "Middle" + }, + "resistor": { + "none": "none", + "pullup": "pullup", + "pulldown": "pulldown" + }, + "digout": "Digital output", + "pwmout": "PWM output", + "servo": "Servo output", + "initpin0": "initial level of pin - low (0)", + "initpin1": "initial level of pin - high (1)", + "left": "left", + "right": "right", + "middle": "middle", + "any": "any", + "pinname": "Pin", + "alreadyuse": "already in use", + "alreadyset": "already set as", + "tip": { + "pin": "Pins in Use: ", + "in": "Tip: Only Digital Input is supported - input must be 0 or 1.", + "dig": "Tip: For digital output - input must be 0 or 1.", + "pwm": "Tip: For PWM output - input must be between 0 to 100; setting high frequency might occupy more CPU than expected.", + "ser": "Tip: For Servo output - input must be between 0 to 100. 50 is centre." + }, + "types": { + "digout": "digital output", + "input": "input", + "pullup": "input with pull up", + "pulldown": "input with pull down", + "pwmout": "PWM output", + "servo": "Servo output" + }, + "status": { + "stopped": "stopped", + "closed": "closed", + "not-running": "not running", + "not-available": "not available", + "na": "N/A : __value__", + "ok": "OK" + }, + "errors": { + "ignorenode": "Raspberry Pi specific node set inactive", + "version": "Failed to get version from Pi", + "sawpitype": "Saw Pi Type", + "libnotfound": "Cannot find Pi RPi.GPIO python library", + "alreadyset": "GPIO pin __pin__ already set as type: __type__", + "invalidpin": "Invalid GPIO pin", + "invalidinput": "Invalid input", + "needtobeexecutable": "__command__ needs to be executable", + "mustbeexecutable": "nrgpio must to be executable", + "commandnotfound": "nrgpio command not found", + "commandnotexecutable": "nrgpio command not executable", + "error": "error: __error__", + "pythoncommandnotfound": "nrgpio python command not running" + } + } +} diff --git a/hardware/PiGpio/locales/ja/36-rpi-gpio.html b/hardware/PiGpio/locales/ja/36-rpi-gpio.html new file mode 100644 index 00000000..bdf8af2d --- /dev/null +++ b/hardware/PiGpio/locales/ja/36-rpi-gpio.html @@ -0,0 +1,71 @@ + + + + + + + + + diff --git a/hardware/PiGpio/locales/ja/36-rpi-gpio.json b/hardware/PiGpio/locales/ja/36-rpi-gpio.json new file mode 100644 index 00000000..619eb3ef --- /dev/null +++ b/hardware/PiGpio/locales/ja/36-rpi-gpio.json @@ -0,0 +1,75 @@ +{ + "rpi-gpio": { + "label": { + "gpiopin": "GPIO", + "selectpin": "端子の選択", + "resistor": "抵抗", + "readinitial": "デプロイや再起動時に端子の初期状態を読み込む", + "type": "出力形式", + "initpin": "端子の状態を初期化", + "debounce": "デバウンス", + "freq": "頻度", + "button": "ボタン", + "pimouse": "Pi Mouse", + "pikeyboard": "Pi Keyboard", + "left": "Left", + "right": "Right", + "middle": "Middle" + }, + "resistor": { + "none": "なし", + "pullup": "プルアップ", + "pulldown": "プルダウン" + }, + "digout": "デジタル出力", + "pwmout": "PWM出力", + "servo": "サーボ出力", + "initpin0": "端子の初期レベル - Low (0)", + "initpin1": "端子の初期レベル - High (1)", + "left": "左", + "right": "右", + "middle": "中間", + "any": "全て", + "pinname": "端子", + "alreadyuse": "使用中", + "alreadyset": "設定済", + "tip": { + "pin": "使用中の端子: ", + "in": "注釈: 入力値は、0または1の数値のみ対応しています。", + "dig": "注釈: 「出力形式」として「デジタル出力」を用いる場合、入力値は0または1の数値である必要があります。", + "pwm": "注釈: 「出力形式」として「PWM出力」を用いる場合、入力値は0～100の数値である必要があります。", + "ser": "注釈: サーボ出力向け - 入力値は0～100の間である必要があります。50が中心値です。" + }, + "types": { + "digout": "デジタル出力", + "input": "入力", + "pullup": "プルアップの入力", + "pulldown": "プルダウンの入力", + "pwmout": "PWM出力", + "servo": "サーボ出力" + }, + "status": { + "stopped": "停止", + "closed": "切断", + "not-running": "停止中", + "not-available": "利用不可", + "na": "N/A : __value__", + "ok": "OK" + }, + "errors": { + "ignorenode": "Raspberry Pi固有のノードを無視しました", + "version": "バージョンコマンドが失敗しました", + "sawpitype": "Saw Pi Type", + "libnotfound": "RPi.GPIO pythonライブラリを見つけられませんでした", + "alreadyset": "GPIO端子 __pin__ は既に出力形式が設定されています: __type__", + "invalidpin": "GPIO端子が不正です", + "invalidinput": "入力が不正です", + "needtobeexecutable": "__command__ は実行可能である必要があります", + "mustbeexecutable": "nrgpio は実行可能である必要があります", + "commandnotfound": "nrgpio コマンドが見つかりません", + "commandnotexecutable": "nrgpio コマンドが実行可能ではありません", + "error": "エラー: __error__", + "pythoncommandnotfound": "nrgpio python コマンドが実行されていません" + } + } +} diff --git a/hardware/PiGpio/locales/ko/36-rpi-gpio.html b/hardware/PiGpio/locales/ko/36-rpi-gpio.html new file mode 100644 index 00000000..c72cb84b --- /dev/null +++ b/hardware/PiGpio/locales/ko/36-rpi-gpio.html @@ -0,0 +1,71 @@ + + + + + + + + + diff --git a/hardware/PiGpio/locales/ko/36-rpi-gpio.json b/hardware/PiGpio/locales/ko/36-rpi-gpio.json new file mode 100644 index 00000000..323ae882 --- /dev/null +++ b/hardware/PiGpio/locales/ko/36-rpi-gpio.json @@ -0,0 +1,73 @@ +"rpi-gpio": { + "label": { + "gpiopin": "GPIO", + "selectpin": "단자의 선택", + "resistor": "저항", + "readinitial": "배포나 재시작시에 단자의 초기상태를 불러옴", + "type": "출력형식", + "initpin": "단자의 상태를 초기화", + "debounce": "디바운스", + "freq": "빈도", + "button": "버튼", + "pimouse": "Pi Mouse", + "pikeyboard": "Pi Keyboard", + "left": "Left", + "right": "Right", + "middle": "Middle" + }, + "resistor": { + "none": "없음", + "pullup": "풀 업", + "pulldown": "풀 다운" + }, + "digout": "디지털 출력", + "pwmout": "PWM 출력", + "servo": "서보 출력", + "initpin0": "단자의 초기레벨 - Low (0)", + "initpin1": "단자의 초기레벨 - High (1)", + "left": "좌", + "right": "우", + "middle": "중간", + "any": "모두", + "pinname": "단자", + "alreadyuse": "사용중", + "alreadyset": "설정됨", + "tip": { + "pin": "사용중인 단자: ", + "in": "주석: 입력값은, 0 혹은 1의 수치만 대응하고 있습니다.", + "dig": "주석: ’출력형식’으로 ’디지털출력’을 사용하는 경우, 입력값은 0 혹은 1의 수치일 필요가 있습니다.", + "pwm": "주석: ’출력형식’으로 ’PWM출력’을 사용하는 경우, 입력값은 0～100의 수치일 필요가 있습니다.", + "ser": "주석: 서보 출력용 - 입력값은 0～100 사이일 필요가 있습니다. 50이 중심값입니다." + }, + "types": { + "digout": "디지털 출력", + "input": "입력", + "pullup": "풀 업 입력", + "pulldown": "풀 다운 입력", + "pwmout": "PWM 출력", + "servo": "서보 출력" + }, + "status": { + "stopped": "정지", + "closed": "절단", + "not-running": "정지중", + "not-available": "이용불가", + "na": "N/A : __value__", + "ok": "OK" + }, + "errors": { + "ignorenode": "Raspberry Pi고유의 노드를 무시했습니다", + "version": "버젼커맨드에 실패했습니다", + "sawpitype": "Saw Pi Type", + "libnotfound": "RPi.GPIO python라이브러리를 발견하지 못했습니다", + "alreadyset": "GPIO단자 __pin__ 은 이미 출력형식이 설정되어 있습니다: __type__", + "invalidpin": "GPIO단자가 올바르지 않습니다", + "invalidinput": "입력이 올바르지 않습니다", + "needtobeexecutable": "__command__ 은 실행가능상태일 필요가 있습니다 ", + "mustbeexecutable": "nrgpio 은 실행가능상태일 필요가 있습니다 ", + "commandnotfound": "nrgpio 커맨드를 찾을수 없습니다", + "commandnotexecutable": "nrgpio 커맨드가 실행가능상태가 아닙니다", + "error": "에러: __error__", + "pythoncommandnotfound": "nrgpio python 커맨드가 실행되지 않았습니다" + } +} diff --git a/hardware/PiGpio/nrgpio b/hardware/PiGpio/nrgpio new file mode 100755 index 00000000..d81fcf44 --- /dev/null +++ b/hardware/PiGpio/nrgpio @@ -0,0 +1,17 @@ +#!/bin/bash +# +# Copyright JS Foundation and other contributors, http://js.foundation +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# http://www.apache.org/licenses/LICENSE-2.0 +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +BASEDIR=$(dirname $0) +python -u $BASEDIR/nrgpio.py $@ diff --git a/hardware/PiGpio/nrgpio.py b/hardware/PiGpio/nrgpio.py new file mode 100755 index 00000000..52ee3ab0 --- /dev/null +++ b/hardware/PiGpio/nrgpio.py @@ -0,0 +1,244 @@ +#!/usr/bin/python +# +# Copyright JS Foundation and other contributors, http://js.foundation +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# http://www.apache.org/licenses/LICENSE-2.0 +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +# Import library functions we need +import RPi.GPIO as GPIO +import struct +import sys +import os +import subprocess +from time import sleep + +try: + raw_input # Python 2 +except NameError: + raw_input = input # Python 3 + +bounce = 25 + +if len(sys.argv) > 2: + cmd = sys.argv[1].lower() + pin = int(sys.argv[2]) + GPIO.setmode(GPIO.BOARD) + GPIO.setwarnings(False) + + if cmd == "pwm": + #print("Initialised pin "+str(pin)+" to PWM") + try: + freq = int(sys.argv[3]) + except: + freq = 100 + + GPIO.setup(pin,GPIO.OUT) + p = GPIO.PWM(pin, freq) + p.start(0) + + while True: + try: + data = raw_input() + if 'close' in data: + sys.exit(0) + p.ChangeDutyCycle(float(data)) + except (EOFError, SystemExit): # hopefully always caused by us sigint'ing the program + GPIO.cleanup(pin) + sys.exit(0) + except Exception as ex: + print("bad data: "+data) + + elif cmd == "buzz": + #print("Initialised pin "+str(pin)+" to Buzz") + GPIO.setup(pin,GPIO.OUT) + p = GPIO.PWM(pin, 100) + p.stop() + + while True: + try: + data = raw_input() + if 'close' in data: + sys.exit(0) + elif float(data) == 0: + p.stop() + else: + p.start(50) + p.ChangeFrequency(float(data)) + except (EOFError, SystemExit): # hopefully always caused by us sigint'ing the program + GPIO.cleanup(pin) + sys.exit(0) + except Exception as ex: + print("bad data: "+data) + + elif cmd == "out": + #print("Initialised pin "+str(pin)+" to OUT") + GPIO.setup(pin,GPIO.OUT) + if len(sys.argv) == 4: + GPIO.output(pin,int(sys.argv[3])) + + while True: + try: + data = raw_input() + if 'close' in data: + sys.exit(0) + data = int(data) + except (EOFError, SystemExit): # hopefully always caused by us sigint'ing the program + GPIO.cleanup(pin) + sys.exit(0) + except: + if len(sys.argv) == 4: + data = int(sys.argv[3]) + else: + data = 0 + if data != 0: + data = 1 + GPIO.output(pin,data) + + elif cmd == "in": + #print("Initialised pin "+str(pin)+" to IN") + bounce = float(sys.argv[4]) + def handle_callback(chan): + if bounce > 0: + sleep(bounce/1000.0) + print(GPIO.input(chan)) + + if sys.argv[3].lower() == "up": + GPIO.setup(pin,GPIO.IN,GPIO.PUD_UP) + elif sys.argv[3].lower() == "down": + GPIO.setup(pin,GPIO.IN,GPIO.PUD_DOWN) + else: + GPIO.setup(pin,GPIO.IN) + + if bounce > 0: + GPIO.add_event_detect(pin, GPIO.BOTH, callback=handle_callback, bouncetime=int(bounce)) + else : + GPIO.add_event_detect(pin, GPIO.BOTH, callback=handle_callback) + sleep(0.1) + print(GPIO.input(pin)) + + while True: + try: + data = raw_input() + if 'close' in data: + sys.exit(0) + except (EOFError, SystemExit): # hopefully always caused by us sigint'ing the program + GPIO.cleanup(pin) + sys.exit(0) + + elif cmd == "byte": + #print("Initialised BYTE mode - "+str(pin)+) + list = [7,11,13,12,15,16,18,22] + GPIO.setup(list,GPIO.OUT) + + while True: + try: + data = raw_input() + if 'close' in data: + sys.exit(0) + data = int(data) + except (EOFError, SystemExit): # hopefully always caused by us sigint'ing the program + GPIO.cleanup() + sys.exit(0) + except: + data = 0 + for bit in range(8): + if pin == 1: + mask = 1 << (7 - bit) + else: + mask = 1 << bit + GPIO.output(list[bit], data & mask) + + elif cmd == "borg": + #print("Initialised BORG mode - "+str(pin)+) + GPIO.setup(11,GPIO.OUT) + GPIO.setup(13,GPIO.OUT) + GPIO.setup(15,GPIO.OUT) + r = GPIO.PWM(11, 100) + g = GPIO.PWM(13, 100) + b = GPIO.PWM(15, 100) + r.start(0) + g.start(0) + b.start(0) + + while True: + try: + data = raw_input() + if 'close' in data: + sys.exit(0) + c = data.split(",") + r.ChangeDutyCycle(float(c[0])) + g.ChangeDutyCycle(float(c[1])) + b.ChangeDutyCycle(float(c[2])) + except (EOFError, SystemExit): # hopefully always caused by us sigint'ing the program + GPIO.cleanup() + sys.exit(0) + except: + data = 0 + + elif cmd == "mouse": # catch mice button events + file = open( "/dev/input/mice", "rb" ) + oldbutt = 0 + + def getMouseEvent(): + global oldbutt + global pin + buf = file.read(3) + pin = pin & 0x07 + button = ord( buf[0] ) & pin # mask out just the required button(s) + if button != oldbutt: # only send if changed + oldbutt = button + print(button) + + while True: + try: + getMouseEvent() + except: + file.close() + sys.exit(0) + + elif cmd == "kbd": # catch keyboard button events + try: + while not os.path.isdir("/dev/input/by-path"): + sleep(10) + infile = subprocess.check_output("ls /dev/input/by-path/ | grep -m 1 'kbd'", shell=True).strip() + infile_path = "/dev/input/by-path/" + infile + EVENT_SIZE = struct.calcsize('llHHI') + file = open(infile_path, "rb") + event = file.read(EVENT_SIZE) + while event: + (tv_sec, tv_usec, type, code, value) = struct.unpack('llHHI', event) + #if type != 0 or code != 0 or value != 0: + if type == 1: + # type,code,value + print("%u,%u" % (code, value)) + event = file.read(EVENT_SIZE) + print("0,0") + file.close() + sys.exit(0) + except: + file.close() + sys.exit(0) + +elif len(sys.argv) > 1: + cmd = sys.argv[1].lower() + if cmd == "rev": + print(GPIO.RPI_REVISION) + elif cmd == "ver": + print(GPIO.VERSION) + elif cmd == "info": + print(GPIO.RPI_INFO) + else: + print("Bad parameters - in|out|pwm|buzz|byte|borg|mouse|kbd|ver|info {pin} {value|up|down}") + print(" only ver (gpio version) and info (board information) accept no pin parameter.") + +else: + print("Bad parameters - in|out|pwm|buzz|byte|borg|mouse|kbd|ver|info {pin} {value|up|down}") diff --git a/hardware/PiGpio/package.json b/hardware/PiGpio/package.json new file mode 100644 index 00000000..4331e228 --- /dev/null +++ b/hardware/PiGpio/package.json @@ -0,0 +1,28 @@ +{ + "name": "node-red-node-pi-gpio", + "version": "1.2.3", + "description": "The basic Node-RED node for Pi GPIO", + "dependencies" : { + }, + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "repository": { + "type": "git", + "url": "https://github.com/node-red/node-red-nodes/tree/master/hardware/PiGpio" + }, + "keywords": [ + "node-red", "Pi", "GPIO", "PiGpio" + ], + "author": { + "name": "Dave Conway-Jones", + "email": "ceejay@vnet.ibm.com", + "url": "http://nodered.org" + }, + "license": "Apache-2.0", + "node-red" : { + "nodes": { + "rpi-gpio": "36-rpi-gpio.js" + } + } +} diff --git a/hardware/PiGpio/testgpio.py b/hardware/PiGpio/testgpio.py new file mode 100755 index 00000000..57305fd2 --- /dev/null +++ b/hardware/PiGpio/testgpio.py @@ -0,0 +1,7 @@ +#!/usr/bin/python +import sys +try: + import RPi.GPIO as GPIO + sys.exit(0) +except ImportError: + sys.exit(1) diff --git a/hardware/PiLcd/LICENSE b/hardware/PiLcd/LICENSE index f5b60114..f144b137 100644 --- a/hardware/PiLcd/LICENSE +++ b/hardware/PiLcd/LICENSE @@ -1,4 +1,4 @@ -Copyright 2016 JS Foundation and other contributors, https://js.foundation/ +Copyright 2016,2020 JS Foundation and other contributors, https://js.foundation/ Copyright 2013-2016 IBM Corp. Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/hardware/PiLcd/README.md b/hardware/PiLcd/README.md index 0f8d5468..a2b3aeaf 100644 --- a/hardware/PiLcd/README.md +++ b/hardware/PiLcd/README.md @@ -1,18 +1,16 @@ -node-red-node-pilcd -=================== +# node-red-node-pilcd A Node-RED node for a Raspberry Pi to write to a GPIO connected HD44780 style LCD panels. -Install -------- +## Install -Run the following command in your Node-RED user directory - typically `~/.node-red` +Either use the Node-RED Menu - Manage Palette option to install, or run the following +command in your Node-RED user directory - typically `~/.node-red` npm install node-red-node-pilcd -Usage ------ +## Usage Raspberry Pi output to HD44780 style LCD module - typically 1, 2, or 4 lines. diff --git a/hardware/PiLcd/locales/en-US/pilcd.html b/hardware/PiLcd/locales/en-US/pilcd.html new file mode 100644 index 00000000..966815b6 --- /dev/null +++ b/hardware/PiLcd/locales/en-US/pilcd.html @@ -0,0 +1,9 @@ + diff --git a/hardware/PiLcd/locales/en-US/pilcd.json b/hardware/PiLcd/locales/en-US/pilcd.json new file mode 100644 index 00000000..bf55ec30 --- /dev/null +++ b/hardware/PiLcd/locales/en-US/pilcd.json @@ -0,0 +1,19 @@ +{ + "pilcd": { + "label": { + "pins": "Pins" + }, + "tip": { + "tip": "Tip: Pins MUST be a comma separated list of the 6 GPIO connector pin numbers that are connected to the RS, E, D4, D5, D6 and D7 pins of the LCD." + }, + "status": { + "not-available": "not available", + "na": "N/A : __value__" + }, + "errors": { + "ignorenode": "Raspberry Pi specific node set inactive", + "libnotfound": "Cannot find Pi RPi.GPIO python library", + "needtobeexecutable": "__command__ needs to be executable" + } + } +} diff --git a/hardware/PiLcd/locales/ja/pilcd.html b/hardware/PiLcd/locales/ja/pilcd.html new file mode 100644 index 00000000..b5f26db3 --- /dev/null +++ b/hardware/PiLcd/locales/ja/pilcd.html @@ -0,0 +1,9 @@ + diff --git a/hardware/PiLcd/locales/ja/pilcd.json b/hardware/PiLcd/locales/ja/pilcd.json new file mode 100644 index 00000000..ba861599 --- /dev/null +++ b/hardware/PiLcd/locales/ja/pilcd.json @@ -0,0 +1,19 @@ +{ + "pilcd": { + "label": { + "pins": "ピン" + }, + "tip": { + "tip": "注釈: LCDのRS、E、D4、D5、D6、およびD7ピンに接続されている6つのGPIOコネクタのピン番号を、コンマで区切りでピンに入力する必要があります。" + }, + "status": { + "not-available": "利用不可", + "na": "N/A : __value__" + }, + "errors": { + "ignorenode": "Raspberry Pi固有のノードを無視しました", + "libnotfound": "RPi.GPIO pythonライブラリを見つけられませんでした", + "needtobeexecutable": "__command__ は実行可能である必要があります" + } + } +} diff --git a/hardware/PiLcd/nrlcd.py b/hardware/PiLcd/nrlcd.py index 623372da..0ab76eb8 100755 --- a/hardware/PiLcd/nrlcd.py +++ b/hardware/PiLcd/nrlcd.py @@ -11,7 +11,13 @@ import RPi.GPIO as GPIO import time import sys -import os, select +import os +import select + +try: + raw_input # Python 2 +except NameError: + raw_input = input # Python 3 # Turn off warnings if you run it a second time... GPIO.setwarnings(False) @@ -31,21 +37,22 @@ LCD_CMD = False LCD_LINE_1 = 0x80 # LCD RAM address for the 1st line LCD_LINE_2 = 0xC0 # LCD RAM address for the 2nd line -LCD_LINE_3 = 0xA0 # LCD RAM address for the 3rd line -LCD_LINE_4 = 0xE0 # LCD RAM address for the 4th line +LCD_LINE_3 = 0x94 # LCD RAM address for the 3rd line +LCD_LINE_4 = 0xD4 # LCD RAM address for the 4th line # Timing constants -E_PULSE = 0.00005 -E_DELAY = 0.00005 +E_PULSE = 0.0005 +E_DELAY = 0.0005 def lcd_init(): # Initialise display lcd_byte(0x33,LCD_CMD) lcd_byte(0x32,LCD_CMD) - lcd_byte(0x28,LCD_CMD) lcd_byte(0x0C,LCD_CMD) lcd_byte(0x06,LCD_CMD) + lcd_byte(0x28,LCD_CMD) lcd_byte(0x01,LCD_CMD) + time.sleep(E_DELAY) def lcd_string(message): # Send string to display @@ -106,8 +113,8 @@ def lcd_byte(bits, mode): if len(sys.argv) > 1: pins = sys.argv[1].lower().split(',') if len(pins) != 6: - print "Bad number of pins supplied" - print " "+pins + print("Bad number of pins supplied") + print(" "+pins) sys.exit(0) LCD_RS = int(pins[0]) @@ -117,6 +124,7 @@ if len(sys.argv) > 1: LCD_D6 = int(pins[4]) LCD_D7 = int(pins[5]) + GPIO.setwarnings(False) GPIO.setmode(GPIO.BOARD) # Use GPIO BOARD numbers GPIO.setup(LCD_RS, GPIO.OUT) # RS GPIO.setup(LCD_E, GPIO.OUT) # E @@ -179,6 +187,6 @@ if len(sys.argv) > 1: sys.exit(0) else: - print "Bad params" - print " sudo nrlcd.py RS,E,D4,D5,D6,D7" + print("Bad params") + print(" sudo nrlcd.py RS,E,D4,D5,D6,D7") sys.exit(0) diff --git a/hardware/PiLcd/package.json b/hardware/PiLcd/package.json index 39be00f5..8ec2355b 100644 --- a/hardware/PiLcd/package.json +++ b/hardware/PiLcd/package.json @@ -1,6 +1,6 @@ { "name" : "node-red-node-pilcd", - "version" : "0.0.6", + "version" : "0.1.0", "description" : "A Node-RED node for Raspberry Pi to write to HD44780 style LCD panels.", "dependencies" : { }, diff --git a/hardware/PiLcd/pilcd.html b/hardware/PiLcd/pilcd.html index faa4b475..2b703018 100644 --- a/hardware/PiLcd/pilcd.html +++ b/hardware/PiLcd/pilcd.html @@ -1,26 +1,14 @@ - - - - - @@ -64,12 +87,15 @@ color:"#c6dbef", defaults: { name: { value:"" }, + gpio: { value:18 }, pixels: { value:"", required:true, validate:RED.validators.number() }, bgnd: { value:"" }, fgnd: { value:"" }, wipe: { value:"40", required:true, validate:RED.validators.number() }, mode: { value:"pcent" }, - rgb: { value:"rgb" } + rgb: { value:"rgb" }, + brightness: { value:"100", required:true, validate:RED.validators.number() }, + gamma: { value: true } }, inputs:1, outputs:0, @@ -82,6 +108,14 @@ return this.name?"node_label_italic":""; }, oneditprepare: function() { + if (this.gamma === undefined) { + this.gamma = true; + $("#node-input-gamma").prop('checked', true); + } + if (this.brightness === undefined) { + this.brighness = "100"; + $("#node-input-brightness").val("100"); + } var setstate = function () { if ($('#node-input-mode').val().indexOf("shift") !== -1) { $("#bgcol").hide(); diff --git a/hardware/neopixel/neopixel.js b/hardware/neopixel/neopixel.js index 85980bb2..12214b33 100644 --- a/hardware/neopixel/neopixel.js +++ b/hardware/neopixel/neopixel.js @@ -6,23 +6,26 @@ module.exports = function(RED) { var fs = require('fs'); var colors = require('./colours.js'); var piCommand = __dirname+'/neopix'; + var allOK = true; try { var cpuinfo = fs.readFileSync("/proc/cpuinfo").toString(); - if (cpuinfo.indexOf(": BCM") === -1) { throw "Info : "+RED._("rpi-gpio.errors.ignorenode"); } + if (cpuinfo.indexOf(": BCM") === -1) { + RED.log.warn("rpi-neopixels : "+RED._("node-red:rpi-gpio.errors.ignorenode")); + allOK = false; + } + else if (execSync('python -c "import rpi_ws281x"').toString() !== "") { + RED.log.warn("rpi-neopixels : Can't find neopixel python library"); + allOK = false; + } + else if (!(1 & parseInt ((fs.statSync(piCommand).mode & parseInt ("777", 8)).toString (8)[0]))) { + RED.log.warn("rpi-neopixels : "+RED._("node-red:rpi-gpio.errors.needtobeexecutable",{command:piCommand})); + allOK = false; + } } catch(err) { - throw "Info : "+RED._("rpi-gpio.errors.ignorenode"); - } - - if (execSync('python -c "import neopixel"').toString() !== "") { - RED.log.warn("Can't find neopixel python library"); - throw "Warning : Can't find neopixel python library"; - } - - if ( !(1 & parseInt ((fs.statSync(piCommand).mode & parseInt ("777", 8)).toString (8)[0]) )) { - RED.log.error(piCommand + " command is not executable"); - throw "Error : "+RED._("rpi-gpio.errors.mustbeexecutable"); + RED.log.warn("rpi-neopixels : "+RED._("node-red:rpi-gpio.errors.ignorenode")); + allOK = false; } // the magic to make python print stuff immediately @@ -35,8 +38,16 @@ module.exports = function(RED) { this.fgnd = n.fgnd || "128,128,128"; this.mode = n.mode || "pcent"; this.rgb = n.rgb || "rgb"; + this.gamma = n.gamma; + if (this.gamma === undefined) { this.gamma = true; } + this.gpio = n.gpio || 18; + this.channel = 0; + if (this.gpio == 13 || this.gpio == 19) { this.channel = 1; } + this.brightness = Number(n.brightness || 100); this.wipe = Number(n.wipe || 40); if (this.wipe < 0) { this.wipe = 0; } + if (this.brightness < 0) { this.brightness = 0; } + if (this.brightness > 100) { this.brightness = 100; } var node = this; var needle = "255,255,255"; //var p1 = /^\#[A-Fa-f0-9]{6}$/ @@ -45,6 +56,9 @@ module.exports = function(RED) { var p4 = /^[0-9]+,[0-9]+,[0-9]+,[0-9]+,[0-9]+$/ function inputlistener(msg) { + if (msg.hasOwnProperty("brightness")) { + node.child.stdin.write("brightness,"+msg.brightness.toString()+"\n"); + } if (msg.hasOwnProperty("payload")) { var pay = msg.payload.toString().toUpperCase(); var parts = pay.split(","); @@ -102,57 +116,62 @@ module.exports = function(RED) { } } - node.child = spawn(piCommand, [node.pixels, node.wipe, node.mode]); - node.status({fill:"green",shape:"dot",text:"ok"}); + if (allOK === true) { + node.child = spawn(piCommand, [node.pixels, node.wipe, node.mode, node.brightness, node.gamma, node.channel, node.gpio]); + node.status({fill:"green",shape:"dot",text:"ok"}); - node.on("input", inputlistener); + node.on("input", inputlistener); - node.child.stdout.on('data', function (data) { - if (RED.settings.verbose) { node.log("out: "+data+" :"); } - }); + node.child.stdout.on('data', function (data) { + if (RED.settings.verbose) { node.log("out: "+data+" :"); } + }); - node.child.stderr.on('data', function (data) { - if (RED.settings.verbose) { node.log("err: "+data+" :"); } - }); + node.child.stderr.on('data', function (data) { + if (RED.settings.verbose) { node.log("err: "+data+" :"); } + }); - node.child.on('close', function () { - node.child = null; - if (RED.settings.verbose) { node.log(RED._("rpi-gpio.status.closed")); } - if (node.done) { + node.child.on('close', function () { + node.child = null; + if (RED.settings.verbose) { node.log(RED._("rpi-gpio.status.closed")); } + if (node.finished) { + node.status({fill:"grey",shape:"ring",text:"closed"}); + node.finished(); + } + else { node.status({fill:"red",shape:"ring",text:"stopped"}); } + }); + + node.child.on('error', function (err) { + if (err.errno === "ENOENT") { node.error(RED._("rpi-gpio.errors.commandnotfound")); } + else if (err.errno === "EACCES") { node.error(RED._("rpi-gpio.errors.commandnotexecutable")); } + else { node.error(RED._("rpi-gpio.errors.error")+': ' + err.errno); } + }); + + node.on("close", function(done) { node.status({fill:"grey",shape:"ring",text:"closed"}); - node.done(); - } - else { node.status({fill:"red",shape:"ring",text:"stopped"}); } - }); + if (node.child != null) { + node.finished = done; + node.child.kill('SIGKILL'); + } + else { done(); } + }); - node.child.on('error', function (err) { - if (err.errno === "ENOENT") { node.error(RED._("rpi-gpio.errors.commandnotfound")); } - else if (err.errno === "EACCES") { node.error(RED._("rpi-gpio.errors.commandnotexecutable")); } - else { node.error(RED._("rpi-gpio.errors.error")+': ' + err.errno); } - }); - - node.on("close", function(done) { - node.status({fill:"grey",shape:"ring",text:"closed"}); - if (node.child != null) { - node.done = done; - node.child.kill('SIGKILL'); + if (node.bgnd) { + if (node.bgnd.split(',').length === 1) { + node.bgnd = colors.getRGB(node.bgnd,node.rgb); + } + if (node.mode.indexOf("shift") === -1) { + node.child.stdin.write(node.bgnd+"\n"); + } } - else { done(); } - }); - if (node.bgnd) { - if (node.bgnd.split(',').length === 1) { - node.bgnd = colors.getRGB(node.bgnd,node.rgb); - } - if (node.mode.indexOf("shift") === -1) { - node.child.stdin.write(node.bgnd+"\n"); + if (node.fgnd) { + if (node.fgnd.split(',').length === 1) { + node.fgnd = colors.getRGB(node.fgnd,node.rgb); + } } } - - if (node.fgnd) { - if (node.fgnd.split(',').length === 1) { - node.fgnd = colors.getRGB(node.fgnd,node.rgb); - } + else { + node.status({fill:"grey",shape:"dot",text:"node-red:rpi-gpio.status.not-available"}); } } RED.nodes.registerType("rpi-neopixels",PiNeopixelNode); diff --git a/hardware/neopixel/package.json b/hardware/neopixel/package.json index 2f8e5e20..6a1e65eb 100644 --- a/hardware/neopixel/package.json +++ b/hardware/neopixel/package.json @@ -1,6 +1,6 @@ { "name" : "node-red-node-pi-neopixel", - "version" : "0.0.16", + "version" : "0.1.1", "description" : "A Node-RED node to output to a neopixel (ws2812) string of LEDS from a Raspberry Pi.", "dependencies" : { }, @@ -9,14 +9,18 @@ "url":"https://github.com/node-red/node-red-nodes/tree/master/hardware/neopixel" }, "license": "Apache-2.0", - "keywords": [ "node-red", "ws2812", "neopixel" ], - "node-red" : { - "nodes" : { + "keywords": [ + "node-red", + "ws2812", + "neopixel" + ], + "node-red": { + "nodes": { "rpi-neopixels": "neopixel.js" } }, - "scripts" : { - "postinstall" : "scripts/checklib.js" + "scripts": { + "postinstall": "scripts/checklib.js" }, "author": { "name": "Dave Conway-Jones", diff --git a/hardware/pigpiod/README.md b/hardware/pigpiod/README.md index d6bdadeb..c69db58b 100644 --- a/hardware/pigpiod/README.md +++ b/hardware/pigpiod/README.md @@ -2,9 +2,11 @@ node-red-node-pi-gpiod ====================== An alternative pair of Node-RED nodes to interact with Pi GPIO using -the PiGPIOd daemon that is now part of Raspbian. +the PiGPIOd daemon that is now part of Raspbian. -The advantage is that it also talk to GPIO on a Pi that is remote as long as it is running the daemon, and also sharing pins works more cleanly as contention is handled by the multiple connections. +The advantage is that it also talk to GPIO on a Pi that is remote as long as it is running the daemon, and also sharing pins works more cleanly as contention is handled by the multiple connections. This is also a +good way to access GPIO when running Docker on a Pi as you can use the network connection to link out of +the container to the PiGPIO daemon running on the host. The disadvantage is that you must setup and run the PiGPIO daemon first. @@ -19,7 +21,7 @@ PiGPIOd must be running on the pi. The easiest way to ensure this is to add the /usr/bin/pigpiod -l /usr/bin/pigpiod -n 192.168.1.10 -See the instructions for more details. +See the instructions for more details. ## Install diff --git a/hardware/pigpiod/locales/en-US/pi-gpiod.json b/hardware/pigpiod/locales/en-US/pi-gpiod.json index 69199beb..5eaa33e6 100644 --- a/hardware/pigpiod/locales/en-US/pi-gpiod.json +++ b/hardware/pigpiod/locales/en-US/pi-gpiod.json @@ -30,10 +30,10 @@ "pinname": "Pin", "tip": { "pin": "Pins in Use: ", - "in": "Tip: Only Digital Input is supported - input must be 0 or 1.", - "dig": "Tip: For digital output - input must be 0 or 1.", - "pwm": "Tip: For PWM output - input must be between 0 to 100.", - "ser": "Tip: For Servo output - input must be between 0 to 100. 50 is centre.
Min must be 500uS or more, Max must be 2500uS or less." + "in": "Only Digital Input is supported - input must be 0 or 1.", + "dig": "Digital output - input must be 0 or 1.", + "pwm": "PWM output - input must be between 0 to 100.", + "ser": "Servo output - input must be between 0 to 100. 50 is centre.
Min must be 500uS or more, Max must be 2500uS or less." }, "types": { "digout": "digital output", diff --git a/hardware/pigpiod/package.json b/hardware/pigpiod/package.json index c188c5c4..9310b69e 100644 --- a/hardware/pigpiod/package.json +++ b/hardware/pigpiod/package.json @@ -1,6 +1,6 @@ { "name": "node-red-node-pi-gpiod", - "version": "0.0.7", + "version": "0.1.1", "description": "A node-red node for PiGPIOd", "dependencies" : { "js-pigpio": "*" diff --git a/hardware/pigpiod/pi-gpiod.html b/hardware/pigpiod/pi-gpiod.html index 507e63f6..7f19ce79 100644 --- a/hardware/pigpiod/pi-gpiod.html +++ b/hardware/pigpiod/pi-gpiod.html @@ -1,5 +1,5 @@ - - @@ -214,7 +215,7 @@ return this.name?"node_label_italic":""; }, outputLabels: function() { return "GPIO"+this.pin; }, - palettelabel: "pi gpiod", + paletteLabel: "pi gpiod", oneditprepare: function() { var pinnow = this.pin; var pintip = this._("pi-gpiod.tip.pin"); @@ -232,7 +233,7 @@ }); - - @@ -466,7 +469,7 @@ return this.name?"node_label_italic":""; }, inputLabels: function() { return "GPIO"+this.pin; }, - palettelabel: "pi gpiod", + paletteLabel: "pi gpiod", oneditprepare: function() { var pinnow = bcm2pin[this.pin]; var pintip = this._("pi-gpiod.tip.pin"); @@ -483,7 +486,7 @@ $("#pwm-tip").show(); $("#ser-tip").hide(); } - if ($("#node-input-out").val() === "ser") { + else if ($("#node-input-out").val() === "ser") { $('#node-set-tick').hide(); $('#node-set-state').hide(); $('#node-set-minimax').show(); diff --git a/hardware/pigpiod/pi-gpiod.js b/hardware/pigpiod/pi-gpiod.js index ca16dd1f..352d8c18 100644 --- a/hardware/pigpiod/pi-gpiod.js +++ b/hardware/pigpiod/pi-gpiod.js @@ -46,13 +46,13 @@ module.exports = function(RED) { PiGPIO.set_glitch_filter(node.pin,node.debounce); node.status({fill:"green",shape:"dot",text:"node-red:common.status.ok"}); node.cb = PiGPIO.callback(node.pin, PiGPIO.EITHER_EDGE, function(gpio, level, tick) { - node.send({ topic:"pi/"+node.pio, payload:Number(level) }); + node.send({ topic:"pi/"+node.pio, payload:Number(level), host:node.host }); node.status({fill:"green",shape:"dot",text:level}); }); if (node.read) { setTimeout(function() { PiGPIO.read(node.pin, function(err, level) { - node.send({ topic:"pi/"+node.pio, payload:Number(level) }); + node.send({ topic:"pi/"+node.pio, payload:Number(level), host:node.host }); node.status({fill:"green",shape:"dot",text:level}); }); }, 20); @@ -99,25 +99,38 @@ module.exports = function(RED) { var PiGPIO; function inputlistener(msg) { - if (!inerror) { + if (node.out === "ser" && (msg.payload === null || msg.payload === "")) { + if (!inerror) { + PiGPIO.setServoPulsewidth(node.pin, 0); + node.status({fill:"green",shape:"dot",text:""}); + } + else { node.status({fill:"grey",shape:"ring",text:"N/C: " + msg.payload.toString()}); } + } + else { if (msg.payload === "true") { msg.payload = true; } if (msg.payload === "false") { msg.payload = false; } var out = Number(msg.payload); var limit = 1; if (node.out !== "out") { limit = 100; } + var pre = ""; if ((out >= 0) && (out <= limit)) { if (RED.settings.verbose) { node.log("out: "+msg.payload); } - if (node.out === "out") { - PiGPIO.write(node.pin, msg.payload); + if (!inerror) { + if (node.out === "out") { + PiGPIO.write(node.pin, out); + } + if (node.out === "pwm") { + PiGPIO.set_PWM_dutycycle(node.pin, parseInt(out * 2.55)); + } + if (node.out === "ser") { + var r = (node.sermax - node.sermin) * 100; + PiGPIO.setServoPulsewidth(node.pin, parseInt(1500 - (r/2) + (out * r / 100))); + } + node.status({fill:"green",shape:"dot",text:out.toString()}); } - if (node.out === "pwm") { - PiGPIO.set_PWM_dutycycle(node.pin, parseInt(msg.payload * 2.55)); + else { + node.status({fill:"grey",shape:"ring",text:"N/C: " + out.toString()}); } - if (node.out === "ser") { - var r = (node.sermax - node.sermin) * 100; - PiGPIO.setServoPulsewidth(node.pin, parseInt(1500 - (r/2) + (msg.payload * r / 100))); - } - node.status({fill:"green",shape:"dot",text:msg.payload.toString()}); } else { node.warn(RED._("pi-gpiod:errors.invalidinput")+": "+out); } } diff --git a/hardware/scanBLE/101-scanBLE.js b/hardware/scanBLE/101-scanBLE.js index ffe129e8..1b102b39 100644 --- a/hardware/scanBLE/101-scanBLE.js +++ b/hardware/scanBLE/101-scanBLE.js @@ -1,5 +1,5 @@ - module.exports = function(RED) { +module.exports = function(RED) { "use strict"; //import noble diff --git a/hardware/sensehat/README.md b/hardware/sensehat/README.md index f286ad8b..043d9dae 100644 --- a/hardware/sensehat/README.md +++ b/hardware/sensehat/README.md @@ -71,7 +71,9 @@ Joystick events are sent when the Sense HAT joystick is interacted with. The This node sends commands to the 8x8 LED display on the Sense HAT. Commands are sent to the node in `msg.payload`. Multiple commands can -be sent in a single message by separating them with newline (\n) characters. +be sent in a single message by separating them with newline (\n) characters. +You must use a function node or a change node (jsonata expression) when +using the newline (\n) character to create a payload containing multiple commands. #### Set the colour of individual pixels @@ -103,12 +105,16 @@ Format: `R` `angle` must be 0, 90, 180 or 270. +Example: `R180` + #### Flip the screen -Format: `R` +Format: `F` `axis` must be either `H` or `V` to flip on the horizontal or vertical axis respectively. +Example: `FV` + #### Scroll a message If `msg.payload` is not recognised as any of the above commands, it is treated @@ -128,3 +134,5 @@ The following message properties can be used to customise the appearance: Format: `D` `level` must be 0 (low) or 1 (high). + +Example: `D1` diff --git a/hardware/sensehat/locales/en-US/sensehat.json b/hardware/sensehat/locales/en-US/sensehat.json new file mode 100644 index 00000000..40656db3 --- /dev/null +++ b/hardware/sensehat/locales/en-US/sensehat.json @@ -0,0 +1,12 @@ +{ + "sensehat": { + "label": { + "outputs": "Outputs", + "motionEvents": "Motion events", + "motionEventsExamples": "accelerometer, gyroscope, magnetometer, compass", + "environmentEvents": "Environment events", + "environmentEventsExamples": "temperature, humidity, pressure", + "joystickEvents": "Joystick events" + } + } +} \ No newline at end of file diff --git a/hardware/sensehat/locales/ja/sensehat.json b/hardware/sensehat/locales/ja/sensehat.json new file mode 100644 index 00000000..8083b49e --- /dev/null +++ b/hardware/sensehat/locales/ja/sensehat.json @@ -0,0 +1,12 @@ +{ + "sensehat": { + "label": { + "outputs": "出力", + "motionEvents": "モーションイベント", + "motionEventsExamples": "加速度計、ジャイロスコープ、磁力計、方位計", + "environmentEvents": "環境イベント", + "environmentEventsExamples": "温度、湿度、気圧", + "joystickEvents": "ジョイスティックイベント" + } + } +} \ No newline at end of file diff --git a/hardware/sensehat/package.json b/hardware/sensehat/package.json index 4c9eb5a4..d893dfa8 100644 --- a/hardware/sensehat/package.json +++ b/hardware/sensehat/package.json @@ -1,6 +1,6 @@ { "name" : "node-red-node-pi-sense-hat", - "version" : "0.0.15", + "version" : "0.0.18", "description" : "A Node-RED node to interact with a Raspberry Pi Sense HAT", "repository" : { "type":"git", diff --git a/hardware/sensehat/sensehat b/hardware/sensehat/sensehat index 31f4be4d..9674d293 100755 --- a/hardware/sensehat/sensehat +++ b/hardware/sensehat/sensehat @@ -1,4 +1,14 @@ #!/bin/bash BASEDIR=$(dirname $0) -sudo python -u $BASEDIR/sensehat.py $@ + +ID=$(id -u) + +# Avoid using sudo if we're already root +SUDO=sudo +if [ $ID -eq 0 ] +then + SUDO="" +fi + +$SUDO python -u $BASEDIR/sensehat.py $@ diff --git a/hardware/sensehat/sensehat.html b/hardware/sensehat/sensehat.html index a7ec2d1e..41c42dd6 100644 --- a/hardware/sensehat/sensehat.html +++ b/hardware/sensehat/sensehat.html @@ -1,30 +1,30 @@ @@ -73,7 +73,9 @@ is an object with the following values:

Raspberry Pi Sense HAT output node.

This node sends commands to the 8x8 LED display on the Sense HAT.

Commands are sent to the node in msg.payload. Multiple commands can -be sent in a single message by separating them with newline (\n) characters.

+be sent in a single message by separating them with newline (\n) characters. You must +use a function node or a change node (jsonata expression) when using the newline (\n) +character to create a payload containing multiple commands.

Set the colour of individual pixels

Format: <x>,<y>,<colour> @@ -100,11 +102,13 @@ be sent in a single message by separating them with newline (\n) characters.

Rotate the screen

Format: R<angle>

angle must be 0, 90, 180 or 270.

+

Example: R180

Flip the screen

Format: F<axis>

axis must be either H or V to flip on the horizontal or vertical axis respectively.

+

Example: FV

Scroll a message

If msg.payload is not recognised as any of the above commands, @@ -121,6 +125,7 @@ To scroll a single character, append a blank space after it - "A ".

Set the screen brightness

Format: D<level>

level must be 0 (low) or 1 (high).

+

Example: D1

diff --git a/hardware/sensehatsim/sensehatsim.html b/hardware/sensehatsim/sensehatsim.html index 0edfeade..67168cb5 100644 --- a/hardware/sensehatsim/sensehatsim.html +++ b/hardware/sensehatsim/sensehatsim.html @@ -32,7 +32,8 @@

Raspberry Pi Sense HAT Simulator input node.

This node simulates readings from the various sensors on the Sense HAT, grouped into three sets; motion events, environment events and joystick events.

-

Once deployed, the simulator can be accessed here.

+

Once deployed, click this button to open the simulator:

+

Open Simulator

Motion events - not currently supported by the simulator

Motion events include readings from the accelerometer, gyroscope and magnetometer, as well as the current compass heading. They are sent at a rate of approximately 10 @@ -73,7 +74,8 @@ is an object with the following values:

diff --git a/hardware/sensehatsim/sensehatsim.js b/hardware/sensehatsim/sensehatsim.js index bcdb8cd6..42439fa9 100644 --- a/hardware/sensehatsim/sensehatsim.js +++ b/hardware/sensehatsim/sensehatsim.js @@ -3,6 +3,7 @@ module.exports = function(RED) { "use strict"; var path = require("path"); var ws = require("ws"); + var url = require("url"); var colours = require('./colours'); // Xaccel.x,y,z,gyro.x,y,z,orientation.roll,pitch,yaw,compass @@ -25,7 +26,7 @@ module.exports = function(RED) { var currentDisplay = []; var HAT = (function() { var hatWS = null; - var wsServerListeners = {}; + var wsServerListener; var wsConnections = {}; var currentEnvironment = {temperature: 20, humidity: 80, pressure: 1000}; var hat = null; @@ -56,19 +57,15 @@ module.exports = function(RED) { wsServerListeners[event] = listener; } } - RED.server.addListener('newListener',storeListener); // Create a WebSocket Server - hatWS = new ws.Server({ - server:RED.server, - path:wsPath, - // Disable the deflate option due to this issue - // https://github.com/websockets/ws/pull/632 - // that is fixed in the 1.x release of the ws module - // that we cannot currently pickup as it drops node 0.10 support - perMessageDeflate: false - }); - RED.server.removeListener('newListener',storeListener); + hatWS = new ws.Server({noServer: true}); + hatWS.on('error', function(err) { + + }) hatWS.on('connection', function(socket) { + socket.on('error', function(err) { + delete wsConnections[id]; + }); var id = (1+Math.random()*4294967295).toString(16); wsConnections[id] = socket; socket.send("Y"+currentEnvironment.temperature+","+currentEnvironment.humidity+","+currentEnvironment.pressure); @@ -119,25 +116,27 @@ module.exports = function(RED) { } }); - socket.on('error', function(err) { - delete wsConnections[id]; - }); + }); + + wsServerListener = function upgrade(request, socket, head) { + const pathname = url.parse(request.url).pathname; + if (pathname === wsPath) { + hatWS.handleUpgrade(request, socket, head, function done(ws) { + hatWS.emit('connection', ws, request); + }); + } + // Don't destroy the socket as other listeners may want to handle the + // event. + }; + RED.server.on('upgrade', wsServerListener) + } } var disconnect = function(done) { if (hatWS !== null) { - var listener = null; - for (var event in wsServerListeners) { - if (wsServerListeners.hasOwnProperty(event)) { - listener = wsServerListeners[event]; - if (typeof listener === "function") { - RED.server.removeListener(event,listener); - } - } - } - wsServerListeners = {}; + RED.server.removeListener('upgrade', wsServerListener) wsConnections = {}; hatWS.close(); hatWS = null; diff --git a/hardware/sensorTag/79-sensorTag.js b/hardware/sensorTag/79-sensorTag.js index bc3a8c89..b197c7d1 100644 --- a/hardware/sensorTag/79-sensorTag.js +++ b/hardware/sensorTag/79-sensorTag.js @@ -44,10 +44,13 @@ module.exports = function(RED) { sensorTag.enableIrTemperature(function() {}); sensorTag.on('irTemperatureChange', function(objectTemperature, ambientTemperature) { - var msg = {'topic': node.topic + '/temperature'}; - msg.payload = {'object': +objectTemperature.toFixed(1), - 'ambient': +ambientTemperature.toFixed(1) - }; + var msg = { + 'topic': node.topic + '/temperature', + 'payload': { + 'object': +objectTemperature.toFixed(1), + 'ambient': +ambientTemperature.toFixed(1) + } + } node.send(msg); }); sensorTag.enableBarometricPressure(function() {}); @@ -59,8 +62,9 @@ module.exports = function(RED) { sensorTag.enableHumidity(function() {}); sensorTag.on('humidityChange', function(temp, humidity) { var msg = {'topic': node.topic + '/humidity'}; - msg.payload = {'temperature': +temp.toFixed(1), - 'humidity': +humidity.toFixed(1) + msg.payload = { + 'temperature': +temp.toFixed(1), + 'humidity': +humidity.toFixed(1) }; if ((temp !== -40) || (humidity !== 100)) { node.send(msg); diff --git a/hardware/unicorn/package.json b/hardware/unicorn/package.json index 31b8bffb..902b3f58 100644 --- a/hardware/unicorn/package.json +++ b/hardware/unicorn/package.json @@ -1,6 +1,6 @@ { "name" : "node-red-node-pi-unicorn-hat", - "version" : "0.0.16", + "version" : "0.0.22", "description" : "A Node-RED node to output to a Raspberry Pi Unicorn HAT from Pimorini.", "dependencies" : { "pngjs": "2.2.*" @@ -16,9 +16,6 @@ "unicorn": "unicorn.js" } }, - "scripts" : { - "postinstall" : "scripts/checklib.js" - }, "author": { "name": "Dave Conway-Jones", "email": "ceejay@vnet.ibm.com", diff --git a/hardware/unicorn/scripts/checklib.js b/hardware/unicorn/scripts/checklib.js deleted file mode 100755 index 0ebb8a95..00000000 --- a/hardware/unicorn/scripts/checklib.js +++ /dev/null @@ -1,13 +0,0 @@ -#!/usr/bin/env node -var fs = require('fs'); - -if (!fs.existsSync('/usr/local/lib/python2.7/dist-packages/unicornhat.py')) { - console.warn("WARNING : Can't find required python library"); - console.warn("WARNING : Please install using the following command"); - console.warn("WARNING : Note: this uses root..."); - console.warn("WARNING : curl -sS get.pimoroni.com/unicornhat | bash\n"); - //process.exit(1); -} -else { - console.log("Python library found OK.\n") -} diff --git a/hardware/unicorn/unicorn.js b/hardware/unicorn/unicorn.js index c1f11ac8..a909c8bf 100644 --- a/hardware/unicorn/unicorn.js +++ b/hardware/unicorn/unicorn.js @@ -7,20 +7,26 @@ module.exports = function(RED) { var execSync = require('child_process').execSync; var hatCommand = __dirname+'/unihat'; + var allOK = true; - if (!fs.existsSync("/dev/ttyAMA0")) { // unlikely if not on a Pi - //RED.log.info(RED._("rpi-gpio.errors.ignorenode")); - throw "Info : "+RED._("rpi-gpio.errors.ignorenode"); + try { + var cpuinfo = fs.readFileSync("/proc/cpuinfo").toString(); + if (cpuinfo.indexOf(": BCM") === -1) { + RED.log.warn("rpi-unicorn : "+RED._("node-red:rpi-gpio.errors.ignorenode")); + allOK = false; + } + else if (!fs.existsSync("/usr/share/doc/python-rpi.gpio")) { + RED.log.warn("rpi-unicorn : "+RED._("node-red:rpi-gpio.errors.libnotfound")); + allOK = false; + } + else if (!(1 & parseInt ((fs.statSync(hatCommand).mode & parseInt ("777", 8)).toString (8)[0]))) { + RED.log.warn("rpi-unicorn : "+RED._("node-red:rpi-gpio.errors.needtobeexecutable",{command:hatCommand})); + allOK = false; + } } - - if (execSync('python -c "import neopixel"').toString() !== "") { - RED.log.warn("Can't find neopixel python library"); - throw "Warning : Can't find neopixel python library"; - } - - if ( !(1 & parseInt ((fs.statSync(hatCommand).mode & parseInt ("777", 8)).toString (8)[0]) )) { - RED.log.error(hatCommand + " command is not executable"); - throw "Error : "+RED._("rpi-gpio.errors.mustbeexecutable"); + catch(err) { + RED.log.warn("rpi-unicorn : "+RED._("node-red:rpi-gpio.errors.ignorenode")); + allOK = false; } // the magic to make python print stuff immediately @@ -208,52 +214,57 @@ module.exports = function(RED) { else { node.warn("Input not a string"); } } - node.child = spawn(hatCommand, [node.bright]); - node.status({fill:"green",shape:"dot",text:"ok"}); + if (allOK === true) { + node.child = spawn(hatCommand, [node.bright]); + node.status({fill:"green",shape:"dot",text:"ok"}); - node.on("input", inputlistener); + node.on("input", inputlistener); - node.child.stdout.on('data', function (data) { - if (RED.settings.verbose) { node.log("out: "+data+" :"); } - }); + node.child.stdout.on('data', function (data) { + if (RED.settings.verbose) { node.log("out: "+data+" :"); } + }); - node.child.stderr.on('data', function (data) { - if (RED.settings.verbose) { node.log("err: "+data+" :"); } - }); + node.child.stderr.on('data', function (data) { + if (RED.settings.verbose) { node.log("err: "+data+" :"); } + }); - node.child.on('close', function () { - node.child = null; - if (RED.settings.verbose) { node.log(RED._("rpi-gpio.status.closed")); } - if (node.done) { + node.child.on('close', function () { + node.child = null; + if (RED.settings.verbose) { node.log(RED._("rpi-gpio.status.closed")); } + if (node.finished) { + node.status({fill:"grey",shape:"ring",text:"closed"}); + node.finished(); + } + else { node.status({fill:"red",shape:"ring",text:"stopped"}); } + }); + + node.child.on('error', function (err) { + if (err.errno === "ENOENT") { node.error(RED._("rpi-gpio.errors.commandnotfound")); } + else if (err.errno === "EACCES") { node.error(RED._("rpi-gpio.errors.commandnotexecutable")); } + else { node.error(RED._("rpi-gpio.errors.error")+': ' + err.errno); } + }); + + node.on("close", function(done) { node.status({fill:"grey",shape:"ring",text:"closed"}); - node.done(); + if (node.tout) { clearTimeout(node.tout); } + if (node.child != null) { + node.finished = done; + node.child.kill('SIGKILL'); + } + else { done(); } + }); + + var nowready = function() { + node.tout = setTimeout( function() { + if (ready) { inputlistener({payload:"0"}); } + else { nowready(); } + }, 100); } - else { node.status({fill:"red",shape:"ring",text:"stopped"}); } - }); - - node.child.on('error', function (err) { - if (err.errno === "ENOENT") { node.error(RED._("rpi-gpio.errors.commandnotfound")); } - else if (err.errno === "EACCES") { node.error(RED._("rpi-gpio.errors.commandnotexecutable")); } - else { node.error(RED._("rpi-gpio.errors.error")+': ' + err.errno); } - }); - - node.on("close", function(done) { - node.status({fill:"grey",shape:"ring",text:"closed"}); - if (node.tout) { clearTimeout(node.tout); } - if (node.child != null) { - node.done = done; - node.child.kill('SIGKILL'); - } - else { done(); } - }); - - var nowready = function() { - node.tout = setTimeout( function() { - if (ready) { inputlistener({payload:"0"}); } - else { nowready(); } - }, 100); + nowready(); + } + else { + node.status({fill:"grey",shape:"dot",text:"node-red:rpi-gpio.status.not-available"}); } - nowready(); } RED.nodes.registerType("rpi-unicorn",UnicornHatNode); } diff --git a/hardware/unicorn/unihat.py b/hardware/unicorn/unihat.py index e75d5203..ea3dbb25 100755 --- a/hardware/unicorn/unihat.py +++ b/hardware/unicorn/unihat.py @@ -1,13 +1,20 @@ #!/usr/bin/python # Import library functions we need -import sys -import os -import unicornhat as UH +from __future__ import print_function -if sys.version_info >= (3,0): - print("Sorry - currently only configured to work with python 2.x") - sys.exit(1) +import sys + +try: + import unicornhat as UH +except ImportError: + print("run: pip install --user --upgrade unicornhat\n before trying again.") + sys.exit(0) + +try: + raw_input # Python 2 +except NameError: + raw_input = input # Python 3 brightness = float(sys.argv[1])/100 UH.off() @@ -64,4 +71,4 @@ while True: except (EOFError, SystemExit): # hopefully always caused by us sigint'ing the program sys.exit(0) except Exception as ex: - print "bad data: "+data + print("bad data: "+data) diff --git a/hardware/wemo/README.md b/hardware/wemo/README.md index dd49ff71..7adf65ad 100644 --- a/hardware/wemo/README.md +++ b/hardware/wemo/README.md @@ -16,15 +16,19 @@ Run the following command in your Node-RED user directory - typically `~/.node-r The output node switches a socket, a light or group of lights on or off -This should be backward compatible with the pervious version of this node but will benefit +This should be backward compatible with the pervious version of this node but will benefit from opening the config dialog and selecting the node you want. -The node accecpts the following inputs +The node accepts the following `msg.payload` as input + + * A single value + * String : `on`/`off` + * Integer : `1`/`0` + * Boolean : `true`/`false` + + + * A JSON Object as below (lights only and color control is still work in the progress) - * Strings on/off - * integers 1/0 - * boolean true/false - * an Object like this (lights only & color control is still work in the progress) ``` { state: 1, @@ -34,10 +38,12 @@ The node accecpts the following inputs } ``` +**Note**: Currently any invalid value is treated as an `off` command. + ## Input Node The new input node is now based on uPnP notifications instead of polling. This means messages -will only be set when an actual change occurs in on the device. This means the node will not +will only be set when an actual change occurs in on the device. This means the node will not send regular no-change messages. The output varies depending on the type of device but examples for sockets look like this: @@ -48,21 +54,21 @@ The output varies depending on the type of device but examples for sockets look "state": "1", "sid": "uuid:e2c4586c-1dd1-11b2-8f61-b535035ae35d", "type": "socket", - "name": "Bedroom Switch", - "id": "221448K1100085" + "name": "Bedroom Switch", + "id": "221448K1100085" } ``` -And a lightblub can look like this: +And a lightbulb can look like this: ``` { - "raw": "\n\n<?xml version="1.0" encoding="utf-8"?><StateEvent><DeviceID\navailable="YES">94103EA2B27803ED</DeviceID><CapabilityId>10006</CapabilityId><Value>1</Value></StateEvent>\n\n\n\n\n\r", - "id": "94103EA2B27803ED", - "capability": "10006", - "value": "1", - "sid": "uuid:e2e5739e-1dd1-11b2-943d-c238ce2bad17", - "type": "light", + "raw": "\n\n<?xml version="1.0" encoding="utf-8"?><StateEvent><DeviceID\navailable="YES">94103EA2B27803ED</DeviceID><CapabilityId>10006</CapabilityId><Value>1</Value></StateEvent>\n\n\n\n\n\r", + "id": "94103EA2B27803ED", + "capability": "10006", + "value": "1", + "sid": "uuid:e2e5739e-1dd1-11b2-943d-c238ce2bad17", + "type": "light", "name": "Bedroom" } ``` @@ -71,12 +77,12 @@ Insight ``` { - "raw": "\n\n8|1454271649|301|834|56717|1209600|8|1010|638602|12104165\n\n\n\n\r", - "state": "8", - "power": 1.01, - "sid": "uuid:ea808ecc-1dd1-11b2-9579-8e5c117d479e", - "type": "socket", - "name": "WeMo Insight", - "id": "221450K1200F5C" + "raw": "\n\n8|1454271649|301|834|56717|1209600|8|1010|638602|12104165\n\n\n\n\r", + "state": "8", + "power": 1.01, + "sid": "uuid:ea808ecc-1dd1-11b2-9579-8e5c117d479e", + "type": "socket", + "name": "WeMo Insight", + "id": "221450K1200F5C" } ``` diff --git a/hardware/wemo/lib/wemo.js b/hardware/wemo/lib/wemo.js index f2d1eb7b..ea168821 100644 --- a/hardware/wemo/lib/wemo.js +++ b/hardware/wemo/lib/wemo.js @@ -215,6 +215,10 @@ WeMoNG.prototype.start = function start() { }); }); + post_request.on('timeout', function(){ + post_request.abort(); + }); + post_request.write(util.format(getenddevs.body, udn)); post_request.end(); @@ -291,6 +295,11 @@ WeMoNG.prototype.toggleSocket = function toggleSocket(socket, on) { console.log("%j", postoptions); }); + post_request.on('timeout', function () { + console.log("Timeout"); + post_request.abort(); + }); + var body = [ postbodyheader, '', @@ -327,10 +336,12 @@ WeMoNG.prototype.getSocketStatus = function getSocketStatus(socket) { res.on('end', function(){ xml2js.parseString(data, function(err, result){ - if (!err) { + if (!err && result["s:Envelope"]) { var status = result["s:Envelope"]["s:Body"][0]["u:GetBinaryStateResponse"][0]["BinaryState"][0]; status = parseInt(status); def.resolve(status); + } else { + def.reject(); } }); }); @@ -342,6 +353,11 @@ WeMoNG.prototype.getSocketStatus = function getSocketStatus(socket) { def.reject(); }); + post_request.on('timeout', function(){ + post_request.abort(); + def.reject(); + }); + post_request.write(getSocketState.body); post_request.end(); @@ -387,12 +403,14 @@ WeMoNG.prototype.getLightStatus = function getLightStatus(light) { }; def.resolve(obj); } else { + def.reject(); console.log("err"); } }); } } else { console.log("err"); + def.reject(); } }); }); @@ -404,6 +422,12 @@ WeMoNG.prototype.getLightStatus = function getLightStatus(light) { def.reject(); }); + post_request.on('timeout', function () { + console.log("Timeout"); + post_request.abort(); + def.reject(); + }); + post_request.write(util.format(getDevStatus.body, light.id)); post_request.end(); @@ -440,6 +464,11 @@ WeMoNG.prototype.setStatus = function setStatus(light, capability, value) { console.log("%j", postoptions); }); + post_request.on('timeout', function () { + console.log("Timeout"); + post_request.abort(); + }); + //console.log(util.format(setdevstatus.body, light.id, capability, value)); post_request.write(util.format(setdevstatus.body, light.type === 'light'?'NO':'YES',light.id, capability, value)); @@ -464,6 +493,8 @@ WeMoNG.prototype.parseEvent = function parseEvent(evt) { msg.capabilityName = capabilityMap[msg.capability]; msg.value = res['StateEvent']['Value'][0]; def.resolve(msg); + } else { + def.reject(); } }); } else if (prop.hasOwnProperty('BinaryState')) { @@ -477,9 +508,11 @@ WeMoNG.prototype.parseEvent = function parseEvent(evt) { def.resolve(msg); } else { console.log("unhandled wemo event type \n%s", util.inspect(prop, {depth:null})); + } } else { //error + def.reject(); } }); diff --git a/hardware/wemo/package.json b/hardware/wemo/package.json index e2212ed9..f001b755 100644 --- a/hardware/wemo/package.json +++ b/hardware/wemo/package.json @@ -1,6 +1,6 @@ { "name": "node-red-node-wemo", - "version": "0.1.14", + "version": "0.1.18", "description": "Input and Output nodes for Belkin WeMo devices", "repository": "https://github.com/node-red/node-red-nodes/tree/master/hardware", "main": "WeMoNG.js", @@ -17,7 +17,7 @@ "name": "Benjamin Hardill", "url": "http://www.hardill.me.uk/wordpress/" }, - "license": "APACHE-2.0", + "license": "Apache-2.0", "dependencies": { "node-ssdp": "~3.2.5", "request": "~2.74.0", diff --git a/io/emoncms/88-emoncms.html b/io/emoncms/88-emoncms.html index 21fe4a9a..65789671 100644 --- a/io/emoncms/88-emoncms.html +++ b/io/emoncms/88-emoncms.html @@ -6,22 +6,36 @@
- + +
+
+ +
+ - - - - - - - - - diff --git a/io/ping/88-ping.js b/io/ping/88-ping.js index 84fb577e..2c428630 100644 --- a/io/ping/88-ping.js +++ b/io/ping/88-ping.js @@ -1,47 +1,135 @@ module.exports = function(RED) { "use strict"; - var spawn = require('child_process').spawn; - var plat = require('os').platform(); + var spawn = require("child_process").spawn; + var plat = require("os").platform(); + + function doPing(node, host, arrayMode) { + const defTimeout = 5000; + var ex, hostOptions, commandLineOptions; + if (typeof host === "string") { + hostOptions = { + host: host, + timeout: defTimeout + } + } else { + hostOptions = host; + hostOptions.timeout = isNaN(parseInt(hostOptions.timeout)) ? defTimeout : parseInt(hostOptions.timeout); + } + //clamp timeout between 1 and 30 sec + hostOptions.timeout = hostOptions.timeout < 1000 ? 1000 : hostOptions.timeout; + hostOptions.timeout = hostOptions.timeout > 30000 ? 30000 : hostOptions.timeout; + var timeoutS = Math.round(hostOptions.timeout / 1000); //whole numbers only + var msg = { payload:false, topic:hostOptions.host }; + //only include the extra msg object if operating in advance/array mode. + if (arrayMode) { + msg.ping = hostOptions + } + if (plat == "linux" || plat == "android") { + commandLineOptions = ["-n", "-w", timeoutS, "-c", "1"] + } else if (plat.match(/^win/)) { + commandLineOptions = ["-n", "1", "-w", hostOptions.timeout] + } else if (plat == "darwin" || plat == "freebsd") { + commandLineOptions = ["-n", "-t", timeoutS, "-c", "1"] + } else { + node.error("Sorry - your platform - "+plat+" - is not recognised.", msg); + return; //dont pass go - just return! + } + + //spawn with timeout in case of os issue + ex = spawn("ping", [...commandLineOptions, hostOptions.host]); + + //monitor every spawned process & SIGINT if too long + var spawnTout = setTimeout(() => { + node.log(`ping - Host '${hostOptions.host}' process timeout - sending SIGINT`) + try { + if (ex && ex.pid) { ex.kill("SIGINT"); } + } + catch(e) {console.warn(e); } + }, hostOptions.timeout+1000); //add 1s for grace + + var res = false; + var line = ""; + var fail = false; + //var regex = /from.*time.(.*)ms/; + var regex = /=.*[<|=]([0-9]*).*TTL|ttl..*=([0-9\.]*)/; + ex.stdout.on("data", function (data) { + line += data.toString(); + }); + ex.on("exit", function (err) { + clearTimeout(spawnTout); + }); + ex.on("error", function (err) { + fail = true; + if (err.code === "ENOENT") { + node.error(err.code + " ping command not found", msg); + } + else if (err.code === "EACCES") { + node.error(err.code + " can't run ping command", msg); + } + else { + node.error(err.code, msg); + } + }); + ex.on("close", function (code) { + if (fail) { fail = false; return; } + var m = regex.exec(line)||""; + if (m !== "") { + if (m[1]) { res = Number(m[1]); } + if (m[2]) { res = Number(m[2]); } + } + if (code === 0) { msg.payload = res } + try { node.send(msg); } + catch(e) {console.warn(e)} + }); + } function PingNode(n) { RED.nodes.createNode(this,n); + this.mode = n.mode; this.host = n.host; this.timer = n.timer * 1000; var node = this; - node.tout = setInterval(function() { - var ex; - if (plat == "linux") { ex = spawn('ping', ['-n', '-w', '5', '-c', '1', node.host]); } - else if (plat.match(/^win/)) { ex = spawn('ping', ['-n', '1', '-w', '5000', node.host]); } - else if (plat == "darwin" || plat == "freebsd") { ex = spawn('ping', ['-n', '-t', '5', '-c', '1', node.host]); } - else { node.error("Sorry - your platform - "+plat+" - is not recognised."); } - var res = false; - var line = ""; - //var regex = /from.*time.(.*)ms/; - var regex = /=.*[<|=]([0-9]*).*TTL|ttl..*=([0-9\.]*)/; - ex.stdout.on('data', function (data) { - line += data.toString(); - }); - //ex.stderr.on('data', function (data) { - //console.log('[ping] stderr: ' + data); - //}); - ex.on('close', function (code) { - var m = regex.exec(line)||""; - if (m !== '') { - if (m[1]) { res = Number(m[1]); } - if (m[2]) { res = Number(m[2]); } + function generatePingList(str) { + return (str + "").split(",").map((e) => (e + "").trim()).filter((e) => e != ""); + } + function clearPingInterval() { + if (node.tout) { clearInterval(node.tout); } + } + + if (node.mode === "triggered") { + clearPingInterval(); + } else if (node.timer) { + node.tout = setInterval(function() { + let pingables = generatePingList(node.host); + for (let index = 0; index < pingables.length; index++) { + const element = pingables[index]; + if (element) { doPing(node, element, false); } } - var msg = { payload:false, topic:node.host }; - if (code === 0) { msg = { payload:res, topic:node.host }; } - try { node.send(msg); } - catch(e) {} - }); - }, node.timer); + }, node.timer); + } + + this.on("input", function (msg) { + let node = this; + let payload = node.host || msg.payload; + if (typeof payload == "string") { + let pingables = generatePingList(payload) + for (let index = 0; index < pingables.length; index++) { + const element = pingables[index]; + if (element) { doPing(node, element, false); } + } + } else if (Array.isArray(payload) ) { + for (let index = 0; index < payload.length; index++) { + const element = payload[index]; + if (element) { doPing(node, element, true); } + } + } + }); this.on("close", function() { - if (this.tout) { clearInterval(this.tout); } + clearPingInterval(); }); } RED.nodes.registerType("ping",PingNode); -} +} \ No newline at end of file diff --git a/io/ping/LICENSE b/io/ping/LICENSE index f5b60114..6085bcc2 100644 --- a/io/ping/LICENSE +++ b/io/ping/LICENSE @@ -1,4 +1,4 @@ -Copyright 2016 JS Foundation and other contributors, https://js.foundation/ +Copyright 2016-2019 JS Foundation and other contributors, https://js.foundation/ Copyright 2013-2016 IBM Corp. Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/io/ping/README.md b/io/ping/README.md index 6c1ebbcb..44cb27d0 100644 --- a/io/ping/README.md +++ b/io/ping/README.md @@ -7,13 +7,18 @@ remote server, for use as a keep-alive check. Install ------- -Run the following command in your Node-RED user directory - typically `~/.node-red` +Either use the Editor - Menu - Manage Palette - Import option or run the following command in your Node-RED user directory - typically `~/.node-red` npm install node-red-node-ping -**Gotcha** -On some versions on Raspbian (Raspberry Pi) `ping` seems to be a root only command. +**Gotchas** + + 1 Ubuntu Snap containers are strict and do not like giving external commands (like ping) external access. To allow ping to work you must manually add the network-observe interface + + sudo snap connect node-red:network-observe + + 2 On some versions on Raspbian (Raspberry Pi) `ping` seems to be a root only command. The fix is to allow it as follows sudo setcap cap_net_raw=ep /bin/ping @@ -22,11 +27,17 @@ The fix is to allow it as follows Usage ----- -Pings a machine and returns the trip time in mS as `msg.payload`. +Pings 1 or more devices and returns the trip time in mS as `msg.payload`. Returns boolean `false` if no response received, or if the host is unresolveable. + `msg.error` will contain any error message if necessary. `msg.topic` contains the ip address of the target host. -Default ping is every 20 seconds but can be configured. +There are 2 modes - `Timed` and `Triggered`. + +* Timed mode - this is the default mode that pings your devices on a timed basis. Default ping is every 20 seconds but can be configured. +* Triggered mode - this mode permits you to trigger the ping by an input message. If the `Target` is left blank and `msg.payload` is a string or array, you can ping 1 or more devices on demand. + +Refer to the built in help on the side-bar info panel for more details. diff --git a/io/ping/locales/en-US/88-ping.html b/io/ping/locales/en-US/88-ping.html new file mode 100644 index 00000000..2bcf660f --- /dev/null +++ b/io/ping/locales/en-US/88-ping.html @@ -0,0 +1,56 @@ + diff --git a/io/ping/locales/en-US/88-ping.json b/io/ping/locales/en-US/88-ping.json index 209e9da4..0bfc7373 100644 --- a/io/ping/locales/en-US/88-ping.json +++ b/io/ping/locales/en-US/88-ping.json @@ -1,8 +1,15 @@ { "ping": { + "ping": "ping", "label": { "target": "Target", - "ping": "Ping (S)" + "ping": "Ping (S)", + "mode": "Mode", + "mode_option": { + "timed": "Timed", + "triggered": "Triggered" + }, + "tip": "Note: Leave Target field blank to allow msg.payload to set hosts dynamically." } } } diff --git a/io/ping/locales/ja/88-ping.html b/io/ping/locales/ja/88-ping.html new file mode 100644 index 00000000..2999d8aa --- /dev/null +++ b/io/ping/locales/ja/88-ping.html @@ -0,0 +1,53 @@ + diff --git a/io/ping/locales/ja/88-ping.json b/io/ping/locales/ja/88-ping.json index 46478887..9828b1d9 100644 --- a/io/ping/locales/ja/88-ping.json +++ b/io/ping/locales/ja/88-ping.json @@ -1,8 +1,15 @@ { "ping": { + "ping": "ping", "label": { - "target": "対象", - "ping": "Ping (秒)" + "target": "ターゲット", + "ping": "Ping (秒)", + "mode": "モード", + "mode_option": { + "timed": "時間", + "triggered": "トリガー" + }, + "tip": "注: msg.payloadでホスト名を動的に指定する場合は、ターゲットフィールドを空にします。" } } } diff --git a/io/ping/package.json b/io/ping/package.json index 6d4ccf1f..cbf02369 100644 --- a/io/ping/package.json +++ b/io/ping/package.json @@ -1,6 +1,6 @@ { "name" : "node-red-node-ping", - "version" : "0.0.14", + "version" : "0.2.2", "description" : "A Node-RED node to ping a remote server, for use as a keep-alive check.", "dependencies" : { }, @@ -19,5 +19,8 @@ "name": "Dave Conway-Jones", "email": "ceejay@vnet.ibm.com", "url": "http://nodered.org" - } + }, + "contributors": [ + { "name": "@Steve-Mcl" } + ] } diff --git a/io/serialport/25-serial.html b/io/serialport/25-serial.html index 287515bb..fcd7d114 100644 --- a/io/serialport/25-serial.html +++ b/io/serialport/25-serial.html @@ -1,5 +1,5 @@ - - - - - - + + + + + + - @@ -172,10 +292,16 @@ databits: {value:8,required:true}, parity: {value:"none",required:true}, stopbits: {value:1,required:true}, + waitfor: {value:""}, + dtr: {value:"none"}, + rts: {value:"none"}, + cts: {value:"none"}, + dsr: {value:"none"}, newline: {value:"\\n"}, bin: {value:"false"}, out: {value:"char"}, - addchar: {value:false} + addchar: {value:""}, + responsetimeout: {value: 10000} }, label: function() { this.serialbaud = this.serialbaud || 57600; @@ -217,28 +343,51 @@ if ($("#node-config-input-out").val() == "char") { if (previous != "char") { $("#node-config-input-newline").val("\\n"); } $("#node-units").text(""); - $("#node-config-addchar").show(); + // $("#node-config-addchar").show(); $("#tip-split").show(); - $("#tip-bin").hide(); + $("#tip-timeout").hide(); + $("#tip-silent").hide(); + $("#tip-count").hide(); } else if ($("#node-config-input-out").val() == "time") { if (previous != "time") { $("#node-config-input-newline").val("0"); } $("#node-units").text("ms"); - $("#node-config-addchar").hide(); - $("#node-config-input-addchar").val("false"); + // $("#node-config-addchar").hide(); + // $("#node-config-input-addchar").val("false"); $("#tip-split").hide(); - $("#tip-bin").show(); + $("#tip-timeout").show(); + $("#tip-silent").hide(); + $("#tip-count").hide(); + } + else if ($("#node-config-input-out").val() == "interbyte") { + if (previous != "interbyte") { $("#node-config-input-newline").val("0"); } + $("#node-units").text("ms"); + // $("#node-config-addchar").hide(); + // $("#node-config-input-addchar").val("false"); + $("#tip-split").hide(); + $("#tip-timeout").hide(); + $("#tip-silent").show(); + $("#tip-count").hide(); } else { if (previous != "count") { $("#node-config-input-newline").val(""); } $("#node-units").text("chars"); - $("#node-config-addchar").hide(); - $("#node-config-input-addchar").val("false"); + // $("#node-config-addchar").hide(); + // $("#node-config-input-addchar").val("false"); $("#tip-split").hide(); - $("#tip-bin").hide(); + $("#tip-timeout").hide(); + $("#tip-silent").hide(); + $("#tip-count").show(); } }); + $("#node-config-input-responsetimeout").on('focus', function () { $("#tip-responsetimeout").show(); }); + $("#node-config-input-responsetimeout").on('blur', function () { $("#tip-responsetimeout").hide(); }); + $("#node-config-input-waitfor").on('focus', function () { $("#tip-waitfor").show(); }); + $("#node-config-input-waitfor").on('blur', function () { $("#tip-waitfor").hide(); }); + $("#node-config-input-addchar").on('focus', function () { $("#tip-addchar").show(); }); + $("#node-config-input-addchar").on('blur', function () { $("#tip-addchar").hide(); }); + try { $("#node-config-input-serialport").autocomplete( "destroy" ); } catch(err) { @@ -247,10 +396,7 @@ $("#node-config-lookup-serial").addClass('disabled'); $.getJSON('serialports',function(data) { $("#node-config-lookup-serial").removeClass('disabled'); - var ports = []; - $.each(data, function(i, port) { - ports.push(port.comName); - }); + var ports = data || []; $("#node-config-input-serialport").autocomplete({ source:ports, minLength:0, diff --git a/io/serialport/25-serial.js b/io/serialport/25-serial.js index c2128c5b..2d9b4f2c 100644 --- a/io/serialport/25-serial.js +++ b/io/serialport/25-serial.js @@ -8,20 +8,29 @@ module.exports = function(RED) { // TODO: 'serialPool' should be encapsulated in SerialPortNode + // Configuration Node function SerialPortNode(n) { RED.nodes.createNode(this,n); this.serialport = n.serialport; - this.newline = n.newline; - this.addchar = n.addchar || "false"; + this.newline = n.newline; /* overloaded: split character, timeout, or character count */ + this.addchar = n.addchar || ""; this.serialbaud = parseInt(n.serialbaud) || 57600; this.databits = parseInt(n.databits) || 8; this.parity = n.parity || "none"; this.stopbits = parseInt(n.stopbits) || 1; + this.dtr = n.dtr || "none"; + this.rts = n.rts || "none"; + this.cts = n.cts || "none"; + this.dsr = n.dsr || "none"; this.bin = n.bin || "false"; this.out = n.out || "char"; + this.waitfor = n.waitfor || ""; + this.responsetimeout = n.responsetimeout || 10000; } RED.nodes.registerType("serial-port",SerialPortNode); + + // receives msgs and sends them to the serial port function SerialOutNode(n) { RED.nodes.createNode(this,n); this.serial = n.serial; @@ -29,38 +38,30 @@ module.exports = function(RED) { if (this.serialConfig) { var node = this; - node.port = serialPool.get(this.serialConfig.serialport, - this.serialConfig.serialbaud, - this.serialConfig.databits, - this.serialConfig.parity, - this.serialConfig.stopbits, - this.serialConfig.newline); - node.addCh = ""; - if (node.serialConfig.addchar == "true" || node.serialConfig.addchar === true) { - node.addCh = this.serialConfig.newline.replace("\\n","\n").replace("\\r","\r").replace("\\t","\t").replace("\\e","\e").replace("\\f","\f").replace("\\0","\0"); // jshint ignore:line - } + node.port = serialPool.get(this.serialConfig); + node.on("input",function(msg) { - if (msg.hasOwnProperty("payload")) { - var payload = msg.payload; - if (!Buffer.isBuffer(payload)) { - if (typeof payload === "object") { - payload = JSON.stringify(payload); - } - else { - payload = payload.toString(); - } - payload += node.addCh; + if (msg.hasOwnProperty("baudrate")) { + var baud = parseInt(msg.baudrate); + if (isNaN(baud)) { + node.error(RED._("serial.errors.badbaudrate"),msg); + } else { + node.port.update({baudRate: baud},function(err,res) { + if (err) { + var errmsg = err.toString().replace("Serialport","Serialport "+node.port.serial.path); + node.error(errmsg,msg); + } + }); } - else if (node.addCh !== "") { - payload = Buffer.concat([payload,new Buffer(node.addCh)]); - } - node.port.write(payload,function(err,res) { - if (err) { - var errmsg = err.toString().replace("Serialport","Serialport "+node.port.serial.path); - node.error(errmsg,msg); - } - }); } + if (!msg.hasOwnProperty("payload")) { return; } // do nothing unless we have a payload + var payload = node.port.encodePayload(msg.payload); + node.port.write(payload,function(err,res) { + if (err) { + var errmsg = err.toString().replace("Serialport","Serialport "+node.port.serial.path); + node.error(errmsg,msg); + } + }); }); node.port.on('ready', function() { node.status({fill:"green",shape:"dot",text:"node-red:common.status.connected"}); @@ -85,6 +86,7 @@ module.exports = function(RED) { RED.nodes.registerType("serial out",SerialOutNode); + // receives data from the serial port and emits msgs function SerialInNode(n) { RED.nodes.createNode(this,n); this.serial = n.serial; @@ -92,81 +94,11 @@ module.exports = function(RED) { if (this.serialConfig) { var node = this; - node.tout = null; - var buf; - if (node.serialConfig.out != "count") { buf = new Buffer(bufMaxSize); } - else { buf = new Buffer(Number(node.serialConfig.newline)); } - var i = 0; node.status({fill:"grey",shape:"dot",text:"node-red:common.status.not-connected"}); - node.port = serialPool.get(this.serialConfig.serialport, - this.serialConfig.serialbaud, - this.serialConfig.databits, - this.serialConfig.parity, - this.serialConfig.stopbits, - this.serialConfig.newline - ); + node.port = serialPool.get(this.serialConfig); - var splitc; - if (node.serialConfig.newline.substr(0,2) == "0x") { - splitc = new Buffer([parseInt(node.serialConfig.newline)]); - } - else { - splitc = new Buffer(node.serialConfig.newline.replace("\\n","\n").replace("\\r","\r").replace("\\t","\t").replace("\\e","\e").replace("\\f","\f").replace("\\0","\0")); // jshint ignore:line - } - - this.port.on('data', function(msg) { - // single char buffer - if ((node.serialConfig.newline === 0)||(node.serialConfig.newline === "")) { - if (node.serialConfig.bin !== "bin") { node.send({"payload": String.fromCharCode(msg)}); } - else { node.send({"payload": new Buffer([msg])}); } - } - else { - // do the timer thing - if (node.serialConfig.out === "time") { - if (node.tout) { - i += 1; - buf[i] = msg; - } - else { - node.tout = setTimeout(function () { - node.tout = null; - var m = new Buffer(i+1); - buf.copy(m,0,0,i+1); - if (node.serialConfig.bin !== "bin") { m = m.toString(); } - node.send({"payload": m}); - m = null; - }, node.serialConfig.newline); - i = 0; - buf[0] = msg; - } - } - // count bytes into a buffer... - else if (node.serialConfig.out === "count") { - buf[i] = msg; - i += 1; - if ( i >= parseInt(node.serialConfig.newline)) { - var m = new Buffer(i); - buf.copy(m,0,0,i); - if (node.serialConfig.bin !== "bin") { m = m.toString(); } - node.send({"payload":m}); - m = null; - i = 0; - } - } - // look to match char... - else if (node.serialConfig.out === "char") { - buf[i] = msg; - i += 1; - if ((msg === splitc[0]) || (i === bufMaxSize)) { - var n = new Buffer(i); - buf.copy(n,0,0,i); - if (node.serialConfig.bin !== "bin") { n = n.toString(); } - node.send({"payload":n}); - n = null; - i = 0; - } - } - } + this.port.on('data', function(msgout) { + node.send(msgout); }); this.port.on('ready', function() { node.status({fill:"green",shape:"dot",text:"node-red:common.status.connected"}); @@ -191,79 +123,344 @@ module.exports = function(RED) { RED.nodes.registerType("serial in",SerialInNode); + /******* REQUEST *********/ + function SerialRequestNode(n) { + RED.nodes.createNode(this,n); + this.serial = n.serial; + this.serialConfig = RED.nodes.getNode(this.serial); + + if (this.serialConfig) { + var node = this; + node.port = serialPool.get(this.serialConfig); + // Serial Out + node.on("input",function(msg) { + if (msg.hasOwnProperty("baudrate")) { + var baud = parseInt(msg.baudrate); + if (isNaN(baud)) { + node.error(RED._("serial.errors.badbaudrate"),msg); + } else { + node.port.update({baudRate: baud},function(err,res) { + if (err) { + var errmsg = err.toString().replace("Serialport","Serialport "+node.port.serial.path); + node.error(errmsg,msg); + } + }); + } + } + if (!msg.hasOwnProperty("payload")) { return; } // do nothing unless we have a payload + if (msg.hasOwnProperty("count") && (typeof msg.count === "number") && (node.serialConfig.out === "count")) { + node.serialConfig.newline = msg.count; + } + if (msg.hasOwnProperty("flush") && msg.flush === true) { node.port.serial.flush(); } + node.status({fill:"yellow",shape:"dot",text:"serial.status.waiting"}); + node.port.enqueue(msg,node,function(err,res) { + if (err) { + var errmsg = err.toString().replace("Serialport","Serialport "+node.port.serial.path); + node.error(errmsg,msg); + } + }); + }); + + // Serial In + this.port.on('data', function(msgout, sender) { + // serial request will only process incoming data pertaining to its own request (i.e. when it's at the head of the queue) + if (sender !== node) { return; } + node.status({fill:"green",shape:"dot",text:"node-red:common.status.ok"}); + msgout.status = "OK"; + node.send(msgout); + }); + this.port.on('timeout', function(msgout, sender) { + if (sender !== node) { return; } + msgout.status = "ERR_TIMEOUT"; + node.status({fill:"red",shape:"ring",text:"serial.status.timeout"}); + node.send(msgout); + }); + + // Common part + node.port.on('ready', function() { + node.status({fill:"green",shape:"dot",text:"node-red:common.status.connected"}); + }); + node.port.on('closed', function() { + node.status({fill:"red",shape:"ring",text:"node-red:common.status.not-connected"}); + }); + } + else { + this.error(RED._("serial.errors.missing-conf")); + } + + this.on("close", function(done) { + if (this.serialConfig) { + serialPool.close(this.serialConfig.serialport,done); + } + else { + done(); + } + }); + } + RED.nodes.registerType("serial request", SerialRequestNode); + var serialPool = (function() { var connections = {}; return { - get:function(port,baud,databits,parity,stopbits,newline,callback) { + get:function(serialConfig) { + // make local copy of configuration -- perhaps not needed? + var port = serialConfig.serialport, + baud = serialConfig.serialbaud, + databits = serialConfig.databits, + parity = serialConfig.parity, + stopbits = serialConfig.stopbits, + dtr = serialConfig.dtr, + rts = serialConfig.rts, + cts = serialConfig.cts, + dsr = serialConfig.dsr, + newline = serialConfig.newline, + spliton = serialConfig.out, + waitfor = serialConfig.waitfor, + binoutput = serialConfig.bin, + addchar = serialConfig.addchar, + responsetimeout = serialConfig.responsetimeout; var id = port; - if (!connections[id]) { - connections[id] = (function() { - var obj = { - _emitter: new events.EventEmitter(), - serial: null, - _closing: false, - tout: null, - on: function(a,b) { this._emitter.on(a,b); }, - close: function(cb) { this.serial.close(cb); }, - write: function(m,cb) { this.serial.write(m,cb); }, - } - //newline = newline.replace("\\n","\n").replace("\\r","\r"); - var olderr = ""; - var setupSerial = function() { - obj.serial = new serialp(port,{ - baudRate: baud, - dataBits: databits, - parity: parity, - stopBits: stopbits, - //parser: serialp.parsers.raw, - autoOpen: true - }, function(err, results) { - if (err) { - if (err.toString() !== olderr) { - olderr = err.toString(); - RED.log.error(RED._("serial.errors.error",{port:port,error:olderr})); - } - obj.tout = setTimeout(function() { - setupSerial(); - }, settings.serialReconnectTime); + // just return the connection object if already have one + // key is the port (file path) + if (connections[id]) { return connections[id]; } + + // State variables to be used by the on('data') handler + var i = 0; // position in the buffer + // .newline is misleading as its meaning depends on the split input policy: + // "char" : a msg will be sent after a character with value .newline is received + // "time" : a msg will be sent after .newline milliseconds + // "count" : a msg will be sent after .newline characters + // if we use "count", we already know how big the buffer will be + var bufSize = (spliton === "count") ? Number(newline): bufMaxSize; + + waitfor = waitfor.replace("\\n","\n").replace("\\r","\r").replace("\\t","\t").replace("\\e","\e").replace("\\f","\f").replace("\\0","\0"); // jshint ignore:line + if (waitfor.substr(0,2) == "0x") { waitfor = parseInt(waitfor,16); } + if (waitfor.length === 1) { waitfor = waitfor.charCodeAt(0); } + var active = (waitfor === "") ? true : false; + var buf = new Buffer.alloc(bufSize); + + var splitc; // split character + // Parse the split character onto a 1-char buffer we can immediately compare against + if (newline.substr(0,2) == "0x") { + splitc = new Buffer.from([newline]); + } + else { + splitc = new Buffer.from(newline.replace("\\n","\n").replace("\\r","\r").replace("\\t","\t").replace("\\e","\e").replace("\\f","\f").replace("\\0","\0")); // jshint ignore:line + } + if (addchar === true) { addchar = splitc; } + addchar = addchar.replace("\\n","\n").replace("\\r","\r").replace("\\t","\t").replace("\\e","\e").replace("\\f","\f").replace("\\0","\0"); // jshint ignore:line + if (addchar.substr(0,2) == "0x") { addchar = new Buffer.from([addchar]); } + connections[id] = (function() { + var obj = { + _emitter: new events.EventEmitter(), + serial: null, + _closing: false, + tout: null, + queue: [], + on: function(a,b) { this._emitter.on(a,b); }, + close: function(cb) { this.serial.close(cb); }, + encodePayload: function (payload) { + if (!Buffer.isBuffer(payload)) { + if (typeof payload === "object") { + payload = JSON.stringify(payload); } + else { + payload = payload.toString(); + } + if (addchar !== "") { payload += addchar; } + } + else if (addchar !== "") { + payload = Buffer.concat([payload,addchar]); + } + return payload; + }, + write: function(m,cb) { this.serial.write(m,cb); }, + update: function(m,cb) { this.serial.update(m,cb); }, + enqueue: function(msg,sender,cb) { + var payload = this.encodePayload(msg.payload); + var qobj = { + sender: sender, + msg: msg, + payload: payload, + cb: cb, + } + this.queue.push(qobj); + // If we're enqueing the first message in line, + // we shall send it right away + if (this.queue.length === 1) { + this.writehead(); + } + }, + writehead: function() { + if (!this.queue.length) { return; } + var qobj = this.queue[0]; + this.write(qobj.payload,qobj.cb); + var msg = qobj.msg; + var timeout = msg.timeout || responsetimeout; + this.tout = setTimeout(function () { + this.tout = null; + var msgout = obj.dequeue() || {}; + msgout.port = port; + // if we have some leftover stuff, just send it + if (i !== 0) { + var m = buf.slice(0,i); + m = Buffer.from(m); + i = 0; + if (binoutput !== "bin") { m = m.toString(); } + msgout.payload = m; + } + /* Notify the sender that a timeout occurred */ + obj._emitter.emit('timeout',msgout,qobj.sender); + }, timeout); + }, + dequeue: function() { + // if we are trying to dequeue stuff from an + // empty queue, that's an unsolicited message + if (!this.queue.length) { return null; } + var msg = Object.assign({}, this.queue[0].msg); + msg = Object.assign(msg, { + request_payload: msg.payload, + request_msgid: msg._msgid, }); - obj.serial.on('error', function(err) { - RED.log.error(RED._("serial.errors.error",{port:port,error:err.toString()})); - obj._emitter.emit('closed'); + delete msg.payload; + if (this.tout) { + clearTimeout(obj.tout); + obj.tout = null; + } + this.queue.shift(); + this.writehead(); + return msg; + }, + } + //newline = newline.replace("\\n","\n").replace("\\r","\r"); + var olderr = ""; + var setupSerial = function() { + obj.serial = new serialp(port,{ + baudRate: baud, + dataBits: databits, + parity: parity, + stopBits: stopbits, + //parser: serialp.parsers.raw, + autoOpen: true + }, function(err, results) { + if (err) { + if (err.toString() !== olderr) { + olderr = err.toString(); + RED.log.error(RED._("serial.errors.error",{port:port,error:olderr})); + } obj.tout = setTimeout(function() { setupSerial(); }, settings.serialReconnectTime); - }); - obj.serial.on('close', function() { - if (!obj._closing) { + } + }); + obj.serial.on('error', function(err) { + RED.log.error(RED._("serial.errors.error",{port:port,error:err.toString()})); + obj._emitter.emit('closed'); + if (obj.tout) { clearTimeout(obj.tout); } + obj.tout = setTimeout(function() { + setupSerial(); + }, settings.serialReconnectTime); + }); + obj.serial.on('close', function() { + if (!obj._closing) { + if (olderr !== "unexpected") { + olderr = "unexpected"; RED.log.error(RED._("serial.errors.unexpected-close",{port:port})); - obj._emitter.emit('closed'); - obj.tout = setTimeout(function() { - setupSerial(); - }, settings.serialReconnectTime); } - }); - obj.serial.on('open',function() { - olderr = ""; - RED.log.info(RED._("serial.onopen",{port:port,baud:baud,config: databits+""+parity.charAt(0).toUpperCase()+stopbits})); + obj._emitter.emit('closed'); if (obj.tout) { clearTimeout(obj.tout); } - //obj.serial.flush(); - obj._emitter.emit('ready'); - }); - obj.serial.on('data',function(d) { - for (var z=0; z= parseInt(newline)) { + emitData(buf.slice(0,i)); + i=0; + } + } + // look to match char... + else if (spliton === "char") { + if ((c === splitc[0]) || (i === bufMaxSize)) { + emitData(buf.slice(0,i)); + i=0; + } + } + } + }); + // obj.serial.on("disconnect",function() { + // RED.log.error(RED._("serial.errors.disconnected",{port:port})); + // }); + } + setupSerial(); + return obj; + }()); return connections[id]; }, close: function(port,done) { @@ -289,8 +486,14 @@ module.exports = function(RED) { }()); RED.httpAdmin.get("/serialports", RED.auth.needsPermission('serial.read'), function(req,res) { - serialp.list(function (err, ports) { - res.json(ports); - }); + serialp.list().then( + ports => { + const a = ports.map(p => p.path); + res.json(a); + }, + err => { + res.json([RED._("serial.errors.list")]); + } + ) }); } diff --git a/io/serialport/LICENSE b/io/serialport/LICENSE index f5b60114..2efcba6b 100644 --- a/io/serialport/LICENSE +++ b/io/serialport/LICENSE @@ -1,4 +1,4 @@ -Copyright 2016 JS Foundation and other contributors, https://js.foundation/ +Copyright 2016,2018 JS Foundation and other contributors, https://js.foundation/ Copyright 2013-2016 IBM Corp. Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/io/serialport/README.md b/io/serialport/README.md index 1d29792d..a5965222 100644 --- a/io/serialport/README.md +++ b/io/serialport/README.md @@ -1,39 +1,24 @@ node-red-node-serialport ======================== -Node-RED nodes to talk to -hardware Serial ports. +Node-RED nodes to talk to +hardware serial ports. -Install -------- +## Install -This node is usually installed by default in Node-RED so should not need to be installed manually. - -Run the following command in your Node-RED user directory (typically `~/.node-red`): +To install the stable version use the `Menu - Manage palette - Install` option and search for node-red-node-serialport, or run the following command in your Node-RED user directory, typically `~/.node-red` npm i node-red-node-serialport -For versions on node.js prior to 4.x (ie v0.10.x and v0.12.x) please install using - - sudo npm i -g npm@2.x - npm i node-red-node-serialport - -You may also have to install or upgrade GCC to be version 4.8 or better. -Alternatively you can simply install the older version of this node. - - npm install node-red-node-serialport@0.0.5 - During install there may be multiple messages about optional compilation. These may look like failures... as they report as failure to compile errors - but often are warnings and the node will continue to install and, assuming nothing else failed, you should be able to use it. Occasionally some platforms *will* require you to install the full set of tools in order to compile the underlying package. +## Usage -Usage ------ - -Provides two nodes - one to receive messages, and one to send. +Provides three nodes - one to receive messages, and one to send, and a request node which can send then wait for a response. ### Input @@ -45,7 +30,7 @@ the device, however you many need to manually specify it. COM1, /dev/ttyUSB0, et It can either - wait for a "split" character (default \n). Also accepts hex notation (0x0a). - - wait for a timeout in milliseconds for the first character received + - wait for a timeout in milliseconds from the first character received - wait to fill a fixed sized buffer It then outputs `msg.payload` as either a UTF8 ascii string or a binary Buffer object. @@ -59,4 +44,14 @@ Provides a connection to an outbound serial port. Only the `msg.payload` is sent. -Optionally the new line character used to split the input can be appended to every message sent out to the serial port. +Optionally the character used to split the input can be appended to every message sent out to the serial port. + +### Request + +Provides a connection to a request/response serial port. + +This node behaves as a tightly coupled combination of serial in and serial out nodes, with which it shares the configuration. + +Send the request message in `msg.payload` as you would do with a serial out node. The message will be forwarded to the serial port following a strict FIFO (First In, First Out) queue, waiting for a single response before transmitting the next request. Once a response is received (with the same logic of a serial in node), or after a timeout occurs, a message is produced on the output, with msg.payload containing the received response (or missing in case if timeout), msg.status containing relevant info, and all other fields preserved. + +For consistency with the serial in node, msg.port is also set to the name of the port selected. diff --git a/io/serialport/locales/en-US/25-serial.json b/io/serialport/locales/en-US/25-serial.json index c2e3ebbe..03ef70e6 100644 --- a/io/serialport/locales/en-US/25-serial.json +++ b/io/serialport/locales/en-US/25-serial.json @@ -1,5 +1,9 @@ { "serial": { + "status": { + "waiting": "waiting", + "timeout": "timeout" + }, "label": { "serialport": "Serial Port", "settings": "Settings", @@ -11,8 +15,13 @@ "split": "Split input", "deliver": "and deliver", "output": "Output", + "request": "Request", + "responsetimeout": "Default response timeout", + "ms": "ms", "serial": "serial", - "none": "none" + "none": "none", + "start": "Optionally wait for a start character of", + "startor": ", then" }, "placeholder": { "serialport": "for example: /dev/ttyUSB0/" @@ -24,19 +33,30 @@ "odd": "Odd", "space": "Space" }, + "linestates": { + "none": "auto", + "high": "High", + "low": "Low" + }, "split": { "character": "on the character", "timeout": "after a timeout of", + "silent": "after a silence of", "lengths": "into fixed lengths of" }, "output": { "ascii": "ascii strings", "binary": "binary buffers" }, - "addsplit": "add split character to output messages", + "addsplit": "Add character to output messages", "tip": { - "split": "Tip: the \"Split on\" character is used to split the input into separate messages. It can also be added to every message sent out to the serial port.", - "timeout": "Tip: In timeout mode timeout starts from arrival of first character." + "responsetimeout": "Tip: The default response timeout can be overridden by setting msg.timeout.", + "split": "Tip: the \"Split on\" character is used to split the input into separate messages. Can accept chars ($), escape codes (\\n), or hex codes (0x03).", + "silent": "Tip: In line-silent mode timeout is restarted upon arrival of any character (i.e. inter-byte timeout).", + "timeout": "Tip: In timeout mode timeout starts from arrival of first character.", + "count": "Tip: In count mode msg.count can override the configured count as long as it smaller than the configured value.", + "waitfor": "Tip: Optional. Leave blank to receive all data. Can accept chars ($), escape codes (\\n), or hex codes (0x02)." , + "addchar": "Tip: This character is added to every message sent out to the serial port. Usually \\r or \\n." }, "onopen": "serial port __port__ opened at __baud__ baud __config__", "errors": { @@ -45,7 +65,9 @@ "error": "serial port __port__ error: __error__", "unexpected-close": "serial port __port__ closed unexpectedly", "disconnected": "serial port __port__ disconnected", - "closed": "serial port __port__ closed" + "closed": "serial port __port__ closed", + "list": "Failed to list ports. Please enter manually.", + "badbaudrate": "Baudrate is invalid" } } } diff --git a/io/serialport/locales/ja/25-serial.json b/io/serialport/locales/ja/25-serial.json index 979c07b2..fb570e87 100644 --- a/io/serialport/locales/ja/25-serial.json +++ b/io/serialport/locales/ja/25-serial.json @@ -1,5 +1,9 @@ { "serial": { + "status": { + "waiting": "waiting", + "timeout": "timeout" + }, "label": { "serialport": "シリアルポート", "settings": "設定", @@ -11,8 +15,13 @@ "split": "入力の分割方法", "deliver": "分割後の配信データ", "output": "出力", + "request": "リクエスト", + "responsetimeout": "デフォルトの応答タイムアウト", + "ms": "ミリ秒", "serial": "serial", - "none": "なし" + "none": "なし", + "start": "オプションで開始文字", + "startor": "を待ちます。" }, "placeholder": { "serialport": "例: /dev/ttyUSB0/" @@ -24,9 +33,15 @@ "odd": "奇数", "space": "スペース" }, + "linestates": { + "none": "自動", + "high": "高", + "low": "低" + }, "split": { "character": "文字列で区切る", "timeout": "タイムアウト後で区切る", + "silent": "一定の待ち時間後に区切る", "lengths": "一定の文字数で区切る" }, "output": { @@ -35,17 +50,24 @@ }, "addsplit": "出力メッセージに分割文字を追加する", "tip": { + "responsetimeout": "Tip: デフォルトの応答タイムアウトは msg.timeout の設定で上書きすることができます。", "split": "Tip: \"区切り\" 文字は、入力を別々のメッセージに分割するために使用され、シリアルポートに送信されるすべてのメッセージに追加することもできます。", - "timeout": "Tip: タイムアウトモードでのタイムアウトは最初の文字が到着したときから始まります。" + "silent": "Tip: In line-silent mode timeout is restarted upon arrival of any character (i.e. inter-byte timeout).", + "timeout": "Tip: タイムアウトモードでのタイムアウトは最初の文字が到着したときから始まります。", + "count": "Tip: カウントモードでは msg.count 設定は、構成された値よりも小さいときに限り、構成されたカウントを上書きすることができます。", + "waitfor": "Tip: オプションです。すべてのデータを受信するには、空白のままにします。文字($)・エスケープコード(\\n)・16進コード(0x02)を受け入れることができます。" , + "addchar": "Tip: この文字は、シリアルポートに送信されるすべてのメッセージに追加されます。通常は \\r や \\n です。" }, - "onopen": "serial port __port__ opened at __baud__ baud __config__", + "onopen": "シリアルポート __port__ が __baud__ ボー __config__ で開かれました", "errors": { - "missing-conf": "missing serial config", - "serial-port": "serial port", - "error": "serial port __port__ error: __error__", - "unexpected-close": "serial port __port__ closed unexpectedly", - "disconnected": "serial port __port__ disconnected", - "closed": "serial port __port__ closed" + "missing-conf": "シリアル設定がありません。", + "serial-port": "シリアルポート", + "error": "シリアルポート __port__ エラー: __error__", + "unexpected-close": "シリアルポート __port__ が予期せず閉じられました", + "disconnected": "シリアルポート __port__ 切断", + "closed": "シリアルポート __port__ 閉じられました", + "list": "ポートのリスト化に失敗しました。手動で入力してください。", + "badbaudrate": "ボーレートが不正です。" } } } diff --git a/io/serialport/package.json b/io/serialport/package.json index 8e8eafdf..aefb7123 100644 --- a/io/serialport/package.json +++ b/io/serialport/package.json @@ -1,9 +1,9 @@ { "name" : "node-red-node-serialport", - "version" : "0.6.2", + "version" : "0.11.1", "description" : "Node-RED nodes to talk to serial ports", "dependencies" : { - "serialport" : "^6.0.4" + "serialport" : "^9.0.2" }, "repository" : { "type":"git", @@ -12,11 +12,12 @@ "license": "Apache-2.0", "keywords": [ "node-red", "serial" ], "node-red": { - "version": ">=0.16.0", + "version": ">=0.18.0", "nodes": { "serialport": "25-serial.js" } }, + "engines" : { "node" : ">=8.6.0" }, "author": { "name": "Dave Conway-Jones", "email": "ceejay@vnet.ibm.com", diff --git a/io/snmp/README.md b/io/snmp/README.md index e71c82f8..5067b11b 100644 --- a/io/snmp/README.md +++ b/io/snmp/README.md @@ -107,7 +107,7 @@ Values depends on the oids being requested. ### snmp-subtree -Simple SNMP oid subtree fetcher. Triggered by any input. +Simple SNMP oid subtree fetcher. Triggered by any input. Reads from OID specified and any below it. `msg.host` may contain the host. @@ -127,7 +127,7 @@ Values depends on the oids being requested. ### snmp-walker -Simple SNMP oid walker fetcher. Triggered by any input. +Simple SNMP oid walker fetcher. Triggered by any input. Reads from OID specified to the end of the table. `msg.host` may contain the host. diff --git a/io/snmp/package.json b/io/snmp/package.json index 047cff9b..c2c118f7 100644 --- a/io/snmp/package.json +++ b/io/snmp/package.json @@ -1,9 +1,9 @@ { "name" : "node-red-node-snmp", - "version" : "0.0.15", + "version" : "0.0.25", "description" : "A Node-RED node that looks for SNMP oids.", "dependencies" : { - "net-snmp" : "^1.1.19" + "net-snmp" : "1.2.4" }, "repository" : { "type":"git", diff --git a/io/snmp/snmp.html b/io/snmp/snmp.html index 36664565..4cd13ef8 100644 --- a/io/snmp/snmp.html +++ b/io/snmp/snmp.html @@ -1,7 +1,7 @@ - - @@ -42,6 +45,7 @@ community: { value: "public" }, version: { value: "1", required: true }, oids: { value: "" }, + timeout: { value: 5 }, name: { value: "" } }, inputs: 1, @@ -54,13 +58,12 @@ return this.name ? "node_label_italic" : ""; } }); - - - - - @@ -169,6 +179,7 @@ community: { value: "public" }, version: { value: "1", required: true }, oids: { value: "" }, + timeout: { value: 5 }, name: { value: "" } }, inputs: 1, @@ -181,13 +192,12 @@ return this.name ? "node_label_italic" : ""; } }); - - - @@ -228,6 +241,7 @@ community: { value: "public" }, version: { value: "1", required: true }, oids: { value: "" }, + timeout: { value: 5 }, name: { value: "" } }, inputs: 1, @@ -240,15 +254,13 @@ return this.name ? "node_label_italic" : ""; } }); - - - - \ No newline at end of file + diff --git a/io/snmp/snmp.js b/io/snmp/snmp.js index 008d5995..bac37c6e 100644 --- a/io/snmp/snmp.js +++ b/io/snmp/snmp.js @@ -5,10 +5,15 @@ module.exports = function (RED) { var sessions = {}; - function getSession(host, community, version) { + function getSession(host, community, version, timeout) { var sessionKey = host + ":" + community + ":" + version; + var port = 161; + if (host.indexOf(":") !== -1) { + port = host.split(":")[1]; + host = host.split(":")[0]; + } if (!(sessionKey in sessions)) { - sessions[sessionKey] = snmp.createSession(host, community, { version: version }); + sessions[sessionKey] = snmp.createSession(host, community, { port:port, version:version, timeout:(timeout || 5000) }); } return sessions[sessionKey]; } @@ -19,6 +24,7 @@ module.exports = function (RED) { this.host = n.host; this.version = (n.version === "2c") ? snmp.Version2c : snmp.Version1; this.oids = n.oids.replace(/\s/g, ""); + this.timeout = Number(n.timeout || 5) * 1000; var node = this; this.on("input", function (msg) { @@ -26,7 +32,7 @@ module.exports = function (RED) { var community = node.community || msg.community; var oids = node.oids || msg.oid; if (oids) { - getSession(host, community, node.version).get(oids.split(","), function (error, varbinds) { + getSession(host, community, node.version, node.timeout).get(oids.split(","), function (error, varbinds) { if (error) { node.error(error.toString(), msg); } @@ -54,13 +60,14 @@ module.exports = function (RED) { } RED.nodes.registerType("snmp", SnmpNode); - function SnmpSNode(n) { RED.nodes.createNode(this, n); this.community = n.community; this.host = n.host; this.version = (n.version === "2c") ? snmp.Version2c : snmp.Version1; this.varbinds = n.varbinds; + this.timeout = Number(n.timeout || 5) * 1000; + if (this.varbinds && this.varbinds.trim().length === 0) { delete this.varbinds; } var node = this; this.on("input", function (msg) { var host = node.host || msg.host; @@ -70,7 +77,7 @@ module.exports = function (RED) { for (var i = 0; i < varbinds.length; i++) { varbinds[i].type = snmp.ObjectType[varbinds[i].type]; } - getSession(host, community, node.version).set(varbinds, function (error, varbinds) { + getSession(host, community, node.version, node.timeout).set(varbinds, function (error, varbinds) { if (error) { node.error(error.toString(), msg); } @@ -93,14 +100,13 @@ module.exports = function (RED) { RED.nodes.registerType("snmp set", SnmpSNode); - - function SnmpTNode(n) { RED.nodes.createNode(this, n); this.community = n.community; this.host = n.host; this.version = (n.version === "2c") ? snmp.Version2c : snmp.Version1; this.oids = n.oids.replace(/\s/g, ""); + this.timeout = Number(n.timeout || 5) * 1000; var node = this; var maxRepetitions = 20; @@ -116,7 +122,7 @@ module.exports = function (RED) { var oids = node.oids || msg.oid; if (oids) { msg.oid = oids; - getSession(host, community, node.version).table(oids, maxRepetitions, function (error, table) { + getSession(host, community, node.version, node.timeout).table(oids, maxRepetitions, function (error, table) { if (error) { node.error(error.toString(), msg); } @@ -153,12 +159,14 @@ module.exports = function (RED) { } RED.nodes.registerType("snmp table", SnmpTNode); + function SnmpSubtreeNode(n) { RED.nodes.createNode(this, n); this.community = n.community; this.host = n.host; this.version = (n.version === "2c") ? snmp.Version2c : snmp.Version1; this.oids = n.oids.replace(/\s/g, ""); + this.timeout = Number(n.timeout || 5) * 1000; var node = this; var maxRepetitions = 20; var response = []; @@ -181,12 +189,13 @@ module.exports = function (RED) { var oids = node.oids || msg.oid; if (oids) { msg.oid = oids; - getSession(host, community, node.version).subtree(msg.oid, maxRepetitions, feedCb, function (error) { + getSession(host, community, node.version, node.timeout).subtree(msg.oid, maxRepetitions, feedCb, function (error) { if (error) { node.error(error.toString(), msg); } else { - msg.payload = response; + // Clone the array + msg.payload = response.slice(0); node.send(msg); //Clears response response.length = 0; @@ -200,12 +209,14 @@ module.exports = function (RED) { } RED.nodes.registerType("snmp subtree", SnmpSubtreeNode); + function SnmpWalkerNode(n) { RED.nodes.createNode(this, n); this.community = n.community; this.host = n.host; this.version = (n.version === "2c") ? snmp.Version2c : snmp.Version1; this.oids = n.oids.replace(/\s/g, ""); + this.timeout = Number(n.timeout || 5) * 1000; var node = this; var maxRepetitions = 20; var response = []; @@ -229,12 +240,13 @@ module.exports = function (RED) { var community = node.community || msg.community; if (oids) { msg.oid = oids; - getSession(host, community, node.version).walk(msg.oid, maxRepetitions, feedCb, function (error) { + getSession(host, community, node.version, node.timeout).walk(msg.oid, maxRepetitions, feedCb, function (error) { if (error) { node.error(error.toString(), msg); } else { - msg.payload = response; + // Clone the array + msg.payload = response.slice(0); node.send(msg); //Clears response response.length = 0; diff --git a/io/stomp/18-stomp.js b/io/stomp/18-stomp.js index 62fa5044..8689a1e0 100644 --- a/io/stomp/18-stomp.js +++ b/io/stomp/18-stomp.js @@ -10,8 +10,8 @@ module.exports = function(RED) { this.port = n.port; this.protocolversion = n.protocolversion; this.vhost = n.vhost; - this.reconnectretries = n.reconnectretries; - this.reconnectdelay = n.reconnectdelay * 1000; + this.reconnectretries = n.reconnectretries || 999999; + this.reconnectdelay = (n.reconnectdelay || 15) * 1000; this.name = n.name; this.username = this.credentials.user; this.password = this.credentials.password; @@ -66,15 +66,14 @@ module.exports = function(RED) { node.client.connect(function(sessionId) { node.log('subscribing to: '+node.topic); node.client.subscribe(node.topic, function(body, headers) { + var newmsg={"headers":headers,"topic":node.topic} try { - msg.payload = JSON.parse(body); + newmsg.payload = JSON.parse(body); } catch(e) { - msg.payload = body; + newmsg.payload = body; } - msg.headers = headers; - msg.topic = node.topic; - node.send(msg); + node.send(newmsg); }); }, function(error) { node.status({fill:"grey",shape:"dot",text:"error"}); diff --git a/io/stomp/package.json b/io/stomp/package.json index 59bca968..a6537ec3 100644 --- a/io/stomp/package.json +++ b/io/stomp/package.json @@ -1,9 +1,9 @@ { "name" : "node-red-node-stomp", - "version" : "0.0.10", + "version" : "0.0.12", "description" : "A Node-RED node to publish and subscribe to/from a Stomp server", "dependencies" : { - "stomp-client" : "0.8.*" + "stomp-client" : "^0.9.0" }, "repository" : { "type":"git", diff --git a/io/wol/39-wol.html b/io/wol/39-wol.html index feb46d13..def6eac3 100644 --- a/io/wol/39-wol.html +++ b/io/wol/39-wol.html @@ -1,24 +1,32 @@ - - - - diff --git a/parsers/base64/70-base64.js b/parsers/base64/70-base64.js index 741fa5dc..c1784d82 100644 --- a/parsers/base64/70-base64.js +++ b/parsers/base64/70-base64.js @@ -1,36 +1,63 @@ module.exports = function(RED) { "use strict"; - function Base64Node(n) { RED.nodes.createNode(this,n); + this.action = n.action || ""; + this.property = n.property || "payload"; var node = this; + var regexp = new RegExp('^[A-Za-z0-9+\/=]*$'); // check it only contains valid characters + this.on("input", function(msg) { - if (msg.hasOwnProperty("payload")) { - if (Buffer.isBuffer(msg.payload)) { - // Take binary buffer and make into a base64 string - msg.payload = msg.payload.toString('base64'); + var value = RED.util.getMessageProperty(msg,node.property); + if (value !== undefined) { + if (node.action === "str") { + value = RED.util.ensureBuffer(value).toString('base64'); + RED.util.setMessageProperty(msg,node.property,value); node.send(msg); } - else if (typeof msg.payload === "string") { - // Take base64 string and make into binary buffer - var load = msg.payload.replace(/\s+/g,''); // remove any whitespace - var regexp = new RegExp('^[A-Za-z0-9+\/=]*$'); // check it only contains valid characters - if ( regexp.test(load) && (load.length % 4 === 0) ) { - msg.payload = new Buffer(load,'base64'); - node.send(msg); - } - else { - //node.log("Not a Base64 string - maybe we should encode it..."); - msg.payload = (new Buffer(msg.payload,"binary")).toString('base64'); - node.send(msg); + else if (node.action === "b64") { + if ( typeof value === "string") { + var load = value.replace(/\s+/g,''); + if (regexp.test(load) && (load.length % 4 === 0) ) { + value = Buffer.from(load,'base64').toString('binary'); + RED.util.setMessageProperty(msg,node.property,value); + node.send(msg); + } + else { node.error(RED._("base64.error.invalid"),msg); } } + else { node.error(RED._("base64.error.nonbase64"),msg); } } else { - node.warn("This node only handles strings or buffers."); + if (Buffer.isBuffer(value)) { + // Take binary buffer and make into a base64 string + value = value.toString('base64'); + RED.util.setMessageProperty(msg,node.property,value); + node.send(msg); + } + else if (typeof value === "string") { + // Take base64 string and make into binary buffer + var load = value.replace(/\s+/g,''); // remove any whitespace + //var load = value.replace(/[\t\r\n\f]+/g,''); + //var load = value; + if ( regexp.test(load) && (load.length % 4 === 0) ) { + value = Buffer.from(load,'base64'); + RED.util.setMessageProperty(msg,node.property,value); + node.send(msg); + } + else { + node.log(RED._("base64.log.nonbase64encode")); + value = Buffer.from(value).toString('base64'); + RED.util.setMessageProperty(msg,node.property,value); + node.send(msg); + } + } + else { + node.warn(RED._("base64.warn.cannothandle")); + } } } - else { node.warn("No payload found to process"); } + else { node.warn(RED._("base64.warn.noproperty")); } }); } RED.nodes.registerType("base64",Base64Node); diff --git a/parsers/base64/icons/parser-base64.png b/parsers/base64/icons/parser-base64.png new file mode 100644 index 00000000..b832cf67 Binary files /dev/null and b/parsers/base64/icons/parser-base64.png differ diff --git a/parsers/base64/locales/en-US/70-base64.html b/parsers/base64/locales/en-US/70-base64.html new file mode 100644 index 00000000..97d4daac --- /dev/null +++ b/parsers/base64/locales/en-US/70-base64.html @@ -0,0 +1,7 @@ + diff --git a/parsers/base64/locales/en-US/70-base64.json b/parsers/base64/locales/en-US/70-base64.json new file mode 100644 index 00000000..42c0e300 --- /dev/null +++ b/parsers/base64/locales/en-US/70-base64.json @@ -0,0 +1,24 @@ +{ + "base64": { + "base64": "base64", + "label": { + "action": "Action" + }, + "convert": { + "buffer": "Convert Buffer <-> Base64", + "encode": "Encode as Base64", + "decode": "Convert Base64 to String" + }, + "log": { + "nonbase64encode": "Not a Base64 string - maybe we should encode it..." + }, + "warn": { + "cannothandle": "This node only handles strings or buffers.", + "noproperty": "No property found to process" + }, + "error": { + "invalid": "Invalid Base64 string", + "nonbase64": "Not a Base64 string" + } + } +} diff --git a/parsers/base64/locales/ja/70-base64.html b/parsers/base64/locales/ja/70-base64.html new file mode 100644 index 00000000..67b8f0a5 --- /dev/null +++ b/parsers/base64/locales/ja/70-base64.html @@ -0,0 +1,7 @@ + diff --git a/parsers/base64/locales/ja/70-base64.json b/parsers/base64/locales/ja/70-base64.json new file mode 100644 index 00000000..6c27c340 --- /dev/null +++ b/parsers/base64/locales/ja/70-base64.json @@ -0,0 +1,24 @@ +{ + "base64": { + "base64": "base64", + "label": { + "action": "動作" + }, + "convert": { + "buffer": "バッファ <-> Base64の変換", + "encode": "Base64へエンコード", + "decode": "Base64から文字列へ変換" + }, + "log": { + "nonbase64encode": "Base64文字列ではありませんが、変換します。" + }, + "warn": { + "cannothandle": "このノードは文字列かバッファしか変換できません。", + "noproperty": "処理するためのプロパティが見つかりません。" + }, + "error": { + "invalid": "不正なBase64文字列です。", + "nonbase64": "Base64文字列ではありません。" + } + } +} diff --git a/parsers/base64/package.json b/parsers/base64/package.json index 99197caf..3fa1f161 100644 --- a/parsers/base64/package.json +++ b/parsers/base64/package.json @@ -1,6 +1,6 @@ { "name" : "node-red-node-base64", - "version" : "0.0.8", + "version" : "0.2.1", "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 1f2ac238..b8aca04e 100644 --- a/parsers/geohash/70-geohash.html +++ b/parsers/geohash/70-geohash.html @@ -1,5 +1,9 @@ diff --git a/parsers/geohash/70-geohash.js b/parsers/geohash/70-geohash.js index f0bebd11..8d5e0e89 100644 --- a/parsers/geohash/70-geohash.js +++ b/parsers/geohash/70-geohash.js @@ -5,6 +5,7 @@ module.exports = function(RED) { function GeohashNode(n) { RED.nodes.createNode(this,n); + this.property = n.property||"payload"; var node = this; var round = function(value, decimals) { @@ -12,82 +13,71 @@ module.exports = function(RED) { } this.on("input", function(msg) { - if (msg.hasOwnProperty("location")) { - if (msg.location.hasOwnProperty("geohash")) { - var pos = geohash.decode(msg.location.geohash); - msg.location.lat = round(pos.latitude,5); - msg.location.lon = round(pos.longitude,5); - msg.location.error = { lat:round(pos.error.latitude,5), lon:round(pos.error.longitude,5) }; - node.send(msg); + var value = RED.util.getMessageProperty(msg,node.property); + if (value !== undefined) { + if (typeof value === "string") { + // try to decode it... + var regexp = new RegExp('^[a-z0-9]{1,9}$'); // can only contain a-z or 0-9 and length 1-9 + if (regexp.test(value)) { + var po = geohash.decode(value); + value = { lat:round(po.latitude,5), lon:round(po.longitude,5) }; + value.error = { lat:round(po.error.latitude,5), lon:round(po.error.longitude,5) }; + RED.util.setMessageProperty(msg,node.property,value); + node.send(msg); + } + else if (value.indexOf(",") !== -1) { + // has a comma so assume it's lat,lon(,precision) + var bits = value.split(","); + if ((bits.length === 2) || (bits.length === 3)) { + var li = 9; + if (bits.length === 3) { + li = parseInt(bits[2]); + if (li < 1) { li = 1; } + if (li > 9) { li = 9; } + } + var la = Number(bits[0]); + if (la < -90) { la = -90; } + if (la > 90) { la = 90; } + var lo = Number(bits[1]); + if (lo < -180) { lo = ((lo-180)%360)+180; } + if (lo > 180) { lo = ((lo+180)%360)-180; } + if (!isNaN(la) && !isNaN(lo)) { + value = geohash.encode(la, lo, li); + RED.util.setMessageProperty(msg,node.property,value); + node.send(msg); + } + else { + node.warn("Incorrect string format - should be lat,lon"); + } + } + else { node.warn("Unexpected string format - should be lat,lon"); } + } + else { node.warn("Unexpected string format - should either be lat,lon or geohash"); } } - else { - var lt = msg.location.lat; - var ln = msg.location.lon; - var le = parseInt(msg.location.precision || 9); - if (le < 1) { le = 1; } - if (le > 9) { le = 9; } - if (lt && ln) { - msg.location.geohash = geohash.encode(lt, ln, le); + else if (typeof value === "object") { + if (value.hasOwnProperty("geohash")) { + var pos = geohash.decode(value.geohash); + value.lat = round(pos.latitude,5); + value.lon = round(pos.longitude,5); + value.error = { lat:round(pos.error.latitude,5), lon:round(pos.error.longitude,5) }; + RED.util.setMessageProperty(msg,node.property,value); node.send(msg); } else { - node.warn("lat or lon missing from msg.location"); - } - } - } - else if (typeof msg.payload === "string") { - // try to decode it... - var regexp = new RegExp('^[a-z0-9]{1,9}$'); // can only contain a-z or 0-9 and length 1-9 - if (regexp.test(msg.payload)) { - var po = geohash.decode(msg.payload); - msg.payload = { lat:round(po.latitude,5), lon:round(po.longitude,5) }; - msg.payload.error = { lat:round(po.error.latitude,5), lon:round(po.error.longitude,5) }; - node.send(msg); - } - else if (msg.payload.indexOf(",") !== -1) { - // has a comma so assume it's lat,lon(,precision) - var bits = msg.payload.split(","); - if ((bits.length === 2) || (bits.length === 3)) { - var li = 9; - if (bits.length === 3) { - li = parseInt(bits[2]); - if (li < 1) { li = 1; } - if (li > 9) { li = 9; } - } - var la = Number(bits[0]); - if (la < -90) { la = -90; } - if (la > 90) { la = 90; } - var lo = Number(bits[1]); - if (lo < -180) { lo = ((lo-180)%360)+180; } - if (lo > 180) { lo = ((lo+180)%360)-180; } - if (!isNaN(la) && !isNaN(lo)) { - msg.payload = geohash.encode(la, lo, li); + var lat = value.lat || value.latitude; + var lon = value.lon || value.longitude; + var len = parseInt(value.precision || 9); + if (len < 1) { len = 1; } + if (len > 9) { len = 9; } + if (lat && lon) { + value.geohash = geohash.encode(lat, lon, len); + RED.util.setMessageProperty(msg,node.property,value); node.send(msg); } - else { - node.warn("Incorrect string format - should be lat,lon"); - } + else { node.warn("lat or lon missing from msg."+node.property); } } - else { node.warn("Unexpected string format - should be lat,lon"); } } - else { node.warn("Unexpected string format - should either be lat,lon or geohash"); } - } - else if (typeof msg.payload === "object") { - var lat = msg.payload.lat || msg.payload.latitude; - var lon = msg.payload.lon || msg.payload.longitude; - var len = parseInt(msg.payload.precision || 9); - if (len < 1) { len = 1; } - if (len > 9) { len = 9; } - if (lat && lon) { - msg.payload.geohash = geohash.encode(lat, lon, len); - node.send(msg); - } - else { - node.warn("lat or lon missing from msg.payload"); - } - } - else { - node.warn("This node only expects strings or objects."); + else { node.warn("This node only expects strings or objects."); } } }); } diff --git a/parsers/geohash/icons/parser-geohash.png b/parsers/geohash/icons/parser-geohash.png new file mode 100644 index 00000000..f54b6fd5 Binary files /dev/null and b/parsers/geohash/icons/parser-geohash.png differ diff --git a/parsers/geohash/package.json b/parsers/geohash/package.json index 9f42b637..e25eb496 100644 --- a/parsers/geohash/package.json +++ b/parsers/geohash/package.json @@ -1,6 +1,6 @@ { "name" : "node-red-node-geohash", - "version" : "0.0.7", + "version" : "0.1.9", "description" : "A Node-RED node to encode and decode lat,lon pairs to a geohash.", "dependencies" : { "ngeohash" : "0.6.0" diff --git a/parsers/markdown/70-markdown.html b/parsers/markdown/70-markdown.html new file mode 100644 index 00000000..783426b1 --- /dev/null +++ b/parsers/markdown/70-markdown.html @@ -0,0 +1,36 @@ + + + + + + diff --git a/parsers/markdown/70-markdown.js b/parsers/markdown/70-markdown.js new file mode 100644 index 00000000..8f91c683 --- /dev/null +++ b/parsers/markdown/70-markdown.js @@ -0,0 +1,17 @@ + +module.exports = function(RED) { + "use strict"; + var markdownNode = function(n) { + var md = require('markdown-it')({html:true, linkify:true, typographer:true}); + RED.nodes.createNode(this,n); + var node = this; + //
'; + node.on("input", function(msg) { + if (msg.payload !== undefined && typeof msg.payload === "string") { + msg.payload = md.render(msg.payload); + } + node.send(msg); + }); + } + RED.nodes.registerType("markdown",markdownNode); +} diff --git a/parsers/markdown/LICENSE b/parsers/markdown/LICENSE new file mode 100644 index 00000000..599d3131 --- /dev/null +++ b/parsers/markdown/LICENSE @@ -0,0 +1,13 @@ +Copyright 2019 JS Foundation and other contributors, https://js.foundation/ + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/parsers/markdown/README.md b/parsers/markdown/README.md new file mode 100644 index 00000000..d03651d7 --- /dev/null +++ b/parsers/markdown/README.md @@ -0,0 +1,20 @@ +node-red-node-markdown +====================== + +A Node-RED node to convert a markdown string to html. + +Install +------- + +Either use the `Node-RED Menu - Manage Palette - Install`, or run the following command in your Node-RED user directory - typically `~/.node-red` + + npm install node-red-node-markdown + +Usage +----- + +If the input is a string it tries to convert it into an html string. + +Uses the markdown-it library - You can see a demo here. + +It is configured with html, linkify and typographer options turned on. diff --git a/parsers/markdown/examples/Simple Markdown Template.json b/parsers/markdown/examples/Simple Markdown Template.json new file mode 100644 index 00000000..7f18e0c7 --- /dev/null +++ b/parsers/markdown/examples/Simple Markdown Template.json @@ -0,0 +1 @@ +[{"id":"dda1a6d6.fe5f58","type":"markdown","z":"adc578f5.614308","name":"","x":390,"y":80,"wires":[["43620a8a.4c8054"]]},{"id":"16242d94.2f86d2","type":"inject","z":"adc578f5.614308","name":"","topic":"","payload":"**Hello** *world* that was `easy` ! ","payloadType":"str","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":110,"y":80,"wires":[["371c8267.9a274e"]]},{"id":"43620a8a.4c8054","type":"ui_template","z":"adc578f5.614308","group":"86b1e7af.9ae1e8","name":"","order":1,"width":"6","height":"10","format":"
';","storeOutMessages":true,"fwdInMessages":true,"templateScope":"local","x":540,"y":80,"wires":[[]]},{"id":"371c8267.9a274e","type":"template","z":"adc578f5.614308","name":"","field":"payload","fieldType":"msg","format":"markdown","syntax":"mustache","template":"\n## Heading\n### Sub-sub-heading\n\n**Hello** World ! that was `easy` ! \n*not* sure what the fuss is all about\n\n - we can create lists\n - of various things\n \nOr just text\n\nOr some glyphs (c) (tm) (r) °C\n\n```\nor maybe a code block\n```\n\n### Tables\n\n| Name | Value |\n| ------ | ----- |\n| cat | miaow |\n| dog | woof |\n| cow | moo |","output":"str","x":240,"y":80,"wires":[["dda1a6d6.fe5f58"]]},{"id":"86b1e7af.9ae1e8","type":"ui_group","z":"","name":"Markdown","tab":"b73dd9da.7d7398","disp":true,"width":"6","collapse":false},{"id":"b73dd9da.7d7398","type":"ui_tab","z":"","name":"Markdown","icon":"dashboard","disabled":false,"hidden":false}] diff --git a/parsers/markdown/icons/parser-markdown.png b/parsers/markdown/icons/parser-markdown.png new file mode 100644 index 00000000..7bae4f04 Binary files /dev/null and b/parsers/markdown/icons/parser-markdown.png differ diff --git a/parsers/markdown/package.json b/parsers/markdown/package.json new file mode 100644 index 00000000..f578e0fa --- /dev/null +++ b/parsers/markdown/package.json @@ -0,0 +1,27 @@ +{ + "name": "node-red-node-markdown", + "version": "0.2.0", + "description": "A Node-RED node to convert a markdown string to html.", + "dependencies": { + "markdown-it": "^11.0.0" + }, + "repository": { + "type": "git", + "url": "https://github.com/node-red/node-red-nodes/tree/master/parsers/markdown" + }, + "license": "Apache-2.0", + "keywords": [ + "node-red", + "markdown" + ], + "node-red": { + "nodes": { + "markdown": "70-markdown.js" + } + }, + "author": { + "name": "Dave Conway-Jones", + "email": "ceejay@vnet.ibm.com", + "url": "http://nodered.org" + } +} diff --git a/parsers/msgpack/70-msgpack.html b/parsers/msgpack/70-msgpack.html index 64361fbe..a7965cab 100644 --- a/parsers/msgpack/70-msgpack.html +++ b/parsers/msgpack/70-msgpack.html @@ -1,35 +1,44 @@ - - diff --git a/parsers/msgpack/70-msgpack.js b/parsers/msgpack/70-msgpack.js index 2fb1c995..0e9efd4f 100644 --- a/parsers/msgpack/70-msgpack.js +++ b/parsers/msgpack/70-msgpack.js @@ -5,15 +5,18 @@ module.exports = function(RED) { function MsgPackNode(n) { RED.nodes.createNode(this,n); + this.property = n.property||"payload"; var node = this; this.on("input", function(msg) { - if (msg.hasOwnProperty("payload")) { - if (Buffer.isBuffer(msg.payload)) { - var l = msg.payload.length; + var value = RED.util.getMessageProperty(msg,node.property); + if (value !== undefined) { + if (Buffer.isBuffer(value)) { + var l = value.length; try { - msg.payload = msgpack.decode(msg.payload); + value = msgpack.decode(value); + RED.util.setMessageProperty(msg,node.property,value); node.send(msg); - node.status({text:l +" b->o "+ JSON.stringify(msg.payload).length}); + node.status({text:l +" b->o "+ JSON.stringify(value).length}); } catch (e) { node.error("Bad decode",msg); @@ -21,9 +24,10 @@ module.exports = function(RED) { } } else { - var le = JSON.stringify(msg.payload).length; - msg.payload = msgpack.encode(msg.payload); - node.status({text:le +" o->b "+ msg.payload.length}); + var le = JSON.stringify(value).length; + value = msgpack.encode(value); + RED.util.setMessageProperty(msg,node.property,value); + node.status({text:le +" o->b "+ value.length}); node.send(msg); } } diff --git a/parsers/msgpack/icons/parser-msgpack.png b/parsers/msgpack/icons/parser-msgpack.png new file mode 100644 index 00000000..02b5ddc0 Binary files /dev/null and b/parsers/msgpack/icons/parser-msgpack.png differ diff --git a/parsers/msgpack/package.json b/parsers/msgpack/package.json index 0734f2fa..5d2daed6 100644 --- a/parsers/msgpack/package.json +++ b/parsers/msgpack/package.json @@ -1,6 +1,6 @@ { "name" : "node-red-node-msgpack", - "version" : "1.0.1", + "version" : "1.2.1", "description" : "A Node-RED node to pack and unpack objects to msgpack format", "dependencies" : { "msgpack-lite" : "^0.1.26" diff --git a/parsers/smaz/70-smaz.html b/parsers/smaz/70-smaz.html new file mode 100644 index 00000000..87ebd840 --- /dev/null +++ b/parsers/smaz/70-smaz.html @@ -0,0 +1,35 @@ + + + + + + diff --git a/parsers/smaz/70-smaz.js b/parsers/smaz/70-smaz.js new file mode 100644 index 00000000..5d30f5a1 --- /dev/null +++ b/parsers/smaz/70-smaz.js @@ -0,0 +1,41 @@ + +module.exports = function(RED) { + "use strict"; + var smaz = require('./smaz.js'); + + var smazNode = function(n) { + RED.nodes.createNode(this,n); + this.property = n.property||"payload"; + var node = this; + this.on("input", function(msg) { + var value = RED.util.getMessageProperty(msg,node.property); + if (value !== undefined) { + if (typeof value === "string") { + var le = value.length; + var c = Buffer.from(smaz.compress(value)); + RED.util.setMessageProperty(msg,node.property,c); + node.status({text:le +" > "+ c.length}); + node.send(msg); + } + else if (Buffer.isBuffer(value)) { + var l = value.length; + try { + var u = smaz.decompress(value); + RED.util.setMessageProperty(msg,node.property,u); + node.send(msg); + node.status({text:l +" < "+ u.length}); + } + catch (e) { + node.error("Bad decode",value); + node.status({text:"not a smaz buffer"}); + } + } + else { + node.status({text:"dropped"}); + } + } + else { node.warn("No payload found to process"); } + }); + } + RED.nodes.registerType("smaz",smazNode); +} diff --git a/parsers/smaz/LICENSE b/parsers/smaz/LICENSE new file mode 100644 index 00000000..f5b60114 --- /dev/null +++ b/parsers/smaz/LICENSE @@ -0,0 +1,14 @@ +Copyright 2016 JS Foundation and other contributors, https://js.foundation/ +Copyright 2013-2016 IBM Corp. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/parsers/smaz/README.md b/parsers/smaz/README.md new file mode 100644 index 00000000..cb5fee29 --- /dev/null +++ b/parsers/smaz/README.md @@ -0,0 +1,22 @@ +node-red-node-smaz +================== + +A Node-RED node to pack and unpack strings to smaz format buffers. + +Install +------- + +Either use the Manage Palette option in the Node-RED Editor menu, or run the following command in your Node-RED user directory - typically `~/.node-red` + + npm install node-red-node-smaz + +Usage +----- + +Uses a smaz library to pack and unpack short strings to small buffers. + +**Note**: this node ONLY accepts strings - anything else will just be dropped. + +If the input is a string it converts it into a smaz buffer. + +If the input is a smaz buffer it converts it back to the original string. diff --git a/parsers/smaz/icons/parser-smaz.png b/parsers/smaz/icons/parser-smaz.png new file mode 100644 index 00000000..02b5ddc0 Binary files /dev/null and b/parsers/smaz/icons/parser-smaz.png differ diff --git a/parsers/smaz/package.json b/parsers/smaz/package.json new file mode 100644 index 00000000..d4723b95 --- /dev/null +++ b/parsers/smaz/package.json @@ -0,0 +1,23 @@ +{ + "name" : "node-red-node-smaz", + "version" : "0.0.3", + "description" : "A Node-RED node to pack and unpack strings to smaz format", + "dependencies" : { + }, + "repository" : { + "type":"git", + "url":"https://github.com/node-red/node-red-nodes/tree/master/parsers/smaz" + }, + "license": "Apache-2.0", + "keywords": [ "smaz" ], + "node-red" : { + "nodes" : { + "smaz": "70-smaz.js" + } + }, + "author": { + "name": "Dave Conway-Jones", + "email": "ceejay@vnet.ibm.com", + "url": "http://nodered.org" + } +} diff --git a/parsers/smaz/smaz.js b/parsers/smaz/smaz.js new file mode 100644 index 00000000..d41624ed --- /dev/null +++ b/parsers/smaz/smaz.js @@ -0,0 +1,124 @@ + +// Copyright (c) 2006-2009, Salvatore Sanfilippo +// All rights reserved. + +// Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: + +// Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. +// Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. +// Neither the name of Smaz nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. + +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, +// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +// Our compression codebook +var rc = [ + " ", "the", "e", "t", "a", "of", "o", "and", "i", "n", "s", "e ", "r", " th", " t", "in", "he", "th", "h", "he ", "to", "\r\n", "l", "s ", "d", " a", "an","er", "c", " o", "d ", "on", " of", "re", "of ", "t ", ", ", "is", "u", "at", " ", "n ", "or", "which", "f", "m", "as", "it", "that", "\n", "was", "en", " ", " w", "es", " an", " i", "\r", "f ", "g", "p", "nd", " s", "nd ", "ed ", "w", "ed", "http://", "for", "te", "ing", "y ", "The", " c", "ti", "r ", "his", "st", " in", "ar", "nt", ",", " to", "y", "ng", " h", "with", "le", "al", "to ", "b", "ou", "be", "were", " b", "se", "o ", "ent", "ha", "ng ", "their", "\"", "hi", "from", " f", "in ", "de", "ion", "me", "v", ".", "ve", "all", "re ", "ri", "ro", "is ", "co", "f t", "are", "ea", ". ", "her", " m", "er ", " p", "es ", "by", "they", "di", "ra", "ic", "not", "s, ", "d t", "at ", "ce", "la", "h ", "ne", "as ", "tio", "on ", "n t", "io", "we", " a ", "om", ", a", "s o", "ur", "li", "ll", "ch", "had", "this", "e t", "g ", "e\r\n", " wh", "ere", " co", "e o", "a ", "us", " d", "ss", "\n\r\n", "\r\n\r", "=\"", " be", " e", "s a", "ma", "one", "t t", "or ", "but", "el", "so", "l ", "e s", "s,", "no", "ter", " wa", "iv", "ho", "e a", " r", "hat", "s t", "ns", "ch ", "wh", "tr", "ut", "/", "have", "ly ", "ta", " ha", " on", "tha", "-", " l", "ati", "en ", "pe", " re", "there", "ass", "si", " fo", "wa", "ec", "our", "who", "its", "z", "fo", "rs", ">", "ot", "un", "<", "im", "th ", "nc", "ate", "><", "ver", "ad", " we", "ly", "ee", " n", "id", " cl", "ac", "il", "", "=\'"]; + +var cb = rc.reduce(function(result, item, index, array) { + result[item] = index; + return result; +}, {}) + +var smaz = module.exports = { + codebook: cb, + reverse_codebook: rc, + flush_verbatim: function(verbatim) { + var output = []; + if (verbatim.length > 1) { + output.push(255); + output.push(verbatim.length-1); + } else { + output.push(254); + } + var k = 0; + for (; k < verbatim.length; k++) { + output.push(verbatim.charCodeAt(k)); + } + return output; + }, + + compress: function(input) { + var verbatim = ""; + var output = []; + var input_index = 0; + + while (input_index < input.length) { + // Try to lookup substrings into the hash table, starting from the + // longer to the shorter substrings + var encoded = false; + var j = 7; + + if (input.length-input_index < 7) { + j = input.length-input_index; + } + + for (; j > 0; j--) { + var code = smaz.codebook[input.substr(input_index,j)]; + if (code != undefined) { + // Match found in the hash table, + // Flush verbatim bytes if needed + if (verbatim) { + output = output.concat(smaz.flush_verbatim(verbatim)); + verbatim = ""; + } + // Emit the byte + output.push(code); + input_index += j; + encoded = true; + break; + } + } + if (!encoded) { + // Match not found - add the byte to the verbatim buffer + verbatim += input[input_index]; + input_index++; + // Flush if we reached the verbatim bytes length limit + if (verbatim.length == 256) { + output = output.concat(smaz.flush_verbatim(verbatim)); + verbatim = ""; + } + } + } + // Flush verbatim bytes if needed + if (verbatim) { + output = output.concat(smaz.flush_verbatim(verbatim)); + verbatim = ""; + } + return new Uint8Array(output); + }, + + decompress: function(input) { + var output = ""; + var i = 0; + while (i < input.length) { + if (input[i] === 254) { + // Verbatim byte + if (i+1 >= input.length) { + throw "Malformed smaz."; + } + output += String.fromCharCode(input[i+1]); + i += 2; + } else if (input[i] === 255) { + // Verbatim string + var j; + if (i+input[i+1]+2 >= input.length) { + throw "Malformed smaz."; + } + for (j = 0; j < input[i+1]+1; j++) { + output += String.fromCharCode(input[i+2+j]); + } + i += 3+input[i+1]; + } else { + // Codebook entry + output += smaz.reverse_codebook[input[i]]; + i++; + } + } + return output; + } +}; diff --git a/parsers/what3words/icons/what3words.png b/parsers/what3words/icons/what3words.png new file mode 100644 index 00000000..9fe1b593 Binary files /dev/null and b/parsers/what3words/icons/what3words.png differ diff --git a/parsers/what3words/package.json b/parsers/what3words/package.json index ea996dc7..b48c8c5d 100644 --- a/parsers/what3words/package.json +++ b/parsers/what3words/package.json @@ -1,6 +1,6 @@ { "name" : "node-red-node-what3words", - "version" : "0.0.7", + "version" : "0.1.11", "description" : "A Node-RED node to convert locations to/from what3words", "dependencies" : { "geo.what3words" : "^2.0.0" diff --git a/parsers/what3words/what3words.html b/parsers/what3words/what3words.html index fbcd342f..ab3775a7 100644 --- a/parsers/what3words/what3words.html +++ b/parsers/what3words/what3words.html @@ -1,5 +1,9 @@ diff --git a/parsers/what3words/what3words.js b/parsers/what3words/what3words.js index 4d8a2fa3..74062852 100644 --- a/parsers/what3words/what3words.js +++ b/parsers/what3words/what3words.js @@ -6,74 +6,71 @@ module.exports = function(RED) { var what3wordsNode = function(n) { RED.nodes.createNode(this, n); this.lang = n.lang || "en"; + this.property = n.property||"payload"; var node = this; //if ( !node.credentials.apikey ) { this.error("No what3words API key set"); } this.w3w = new What3Words(node.credentials.apikey); var w1 = /^\*\w{6,31}$/; var w3 = /^\w+\.\w+\.\w+$/; + this.on("input", function(msg) { - if (msg.hasOwnProperty("location") && msg.location.hasOwnProperty("lat") && msg.location.hasOwnProperty("lon")) { - node.w3w.positionToWords({ position:msg.location.lat + "," + msg.location.lon, lang:node.lang }) - .then(function(response) { - msg.payload = response; // prom.cape.pump - if (!msg.hasOwnProperty("topic") || (msg.topic === "")) { msg.topic = "what3words"; } - node.send(msg); - }) - .catch(function(err) { - node.warn(err) - }); - } - else if (msg.hasOwnProperty("payload") && msg.payload.hasOwnProperty("lat") && msg.payload.hasOwnProperty("lon")) { - node.w3w.positionToWords({ position:msg.payload.lat + "," + msg.payload.lon, lang:node.lang }) - .then(function(response) { - msg.payload = response; // prom.cape.pump - if (!msg.hasOwnProperty("topic") || (msg.topic === "")) { msg.topic = "what3words"; } - node.send(msg); - }) - .catch(function(err) { - node.warn(err) - }); - } - else if (typeof (msg.payload) === "string") { - if (msg.payload.split(",").length === 2) { // see if it's 2 comma separated words - node.w3w.positionToWords({ position:msg.payload, lang:node.lang }) + var value = RED.util.getMessageProperty(msg,node.property); + if (value !== undefined) { + if (value.hasOwnProperty("lat") && value.hasOwnProperty("lon")) { + node.w3w.positionToWords({ position:value.lat + "," + value.lon, lang:node.lang }) .then(function(response) { - msg.payload = response; // prom.cape.pump + value = response; // prom.cape.pump if (!msg.hasOwnProperty("topic") || (msg.topic === "")) { msg.topic = "what3words"; } - node.send(msg); - }) - .catch(function(err) { - node.warn(err); - }); - } - else if (msg.payload.match(w3)) { // see if it's 3 dot separated words - node.w3w.wordsToPosition({ words:msg.payload }) - .then(function(response) { - if (!msg.hasOwnProperty("location")) { msg.location = {}; } - msg.location.lat = Number(response.split(",")[0]); - msg.location.lon = Number(response.split(",")[1]); + RED.util.setMessageProperty(msg,node.property,value); node.send(msg); }) .catch(function(err) { node.warn(err) }); } - else if (msg.payload.match(w1)) { // see if it's a *Oneword - node.w3w.wordsToPosition({ words:msg.payload }) - .then(function(response) { - if (!msg.hasOwnProperty("location")) { msg.location = {}; } - msg.location.lat = Number(response.split(",")[0]); - msg.location.lon = Number(response.split(",")[1]); - msg.payload = response; - node.send(msg); - }) - .catch(function(err) { - node.warn(err); - }); + else if (typeof (value) === "string") { + if (value.split(",").length === 2) { // see if it's 2 comma separated words + node.w3w.positionToWords({ position:value, lang:node.lang }) + .then(function(response) { + value = response; // prom.cape.pump + if (!msg.hasOwnProperty("topic") || (msg.topic === "")) { msg.topic = "what3words"; } + RED.util.setMessageProperty(msg,node.property,value); + node.send(msg); + }) + .catch(function(err) { + node.warn(err); + }); + } + else if (value.match(w3)) { // see if it's 3 dot separated words + node.w3w.wordsToPosition({ words:value }) + .then(function(response) { + var loc = {}; + loc.lat = Number(response.split(",")[0]); + loc.lon = Number(response.split(",")[1]); + RED.util.setMessageProperty(msg,"location",loc); + node.send(msg); + }) + .catch(function(err) { + node.warn(err) + }); + } + else if (value.match(w1)) { // see if it's a *Oneword + node.w3w.wordsToPosition({ words:value }) + .then(function(response) { + var loc = {}; + loc.lat = Number(response.split(",")[0]); + loc.lon = Number(response.split(",")[1]); + RED.util.setMessageProperty(msg,"location",loc); + node.send(msg); + }) + .catch(function(err) { + node.warn(err); + }); + } + else { node.warn("No useable data found. See info."); } } else { node.warn("No useable data found. See info."); } } - else { node.warn("No useable data found. See info."); } }); } RED.nodes.registerType("what3words", what3wordsNode, { diff --git a/social/email/61-email.html b/social/email/61-email.html index c7ddcc8d..e0c14c72 100644 --- a/social/email/61-email.html +++ b/social/email/61-email.html @@ -1,5 +1,4 @@ - - - - - - + + + + + diff --git a/social/email/61-email.js b/social/email/61-email.js index d22ced3a..0c7b3b5a 100644 --- a/social/email/61-email.js +++ b/social/email/61-email.js @@ -1,3 +1,4 @@ +/* eslint-disable indent */ /** * POP3 protocol - RFC1939 - https://www.ietf.org/rfc/rfc1939.txt @@ -11,11 +12,17 @@ module.exports = function(RED) { "use strict"; - var nodemailer = require("nodemailer"); + var util = require("util"); var Imap = require('imap'); var POP3Client = require("poplib"); - var MailParser = require("mailparser").MailParser; - var util = require("util"); + var nodemailer = require("nodemailer"); + var simpleParser = require("mailparser").simpleParser; + var SMTPServer = require("smtp-server").SMTPServer; + //var microMTA = require("micromta").microMTA; + + if (parseInt(process.version.split("v")[1].split(".")[0]) < 8) { + throw "Error : Requires nodejs version >= 8."; + } try { var globalkeys = RED.settings.email || require(process.env.NODE_RED_HOME+"/../emailkeys.js"); @@ -30,6 +37,7 @@ module.exports = function(RED) { this.outserver = n.server; this.outport = n.port; this.secure = n.secure; + this.tls = true; var flag = false; if (this.credentials && this.credentials.hasOwnProperty("userid")) { this.userid = this.credentials.userid; @@ -50,12 +58,16 @@ module.exports = function(RED) { if (flag) { RED.nodes.addCredentials(n.id,{userid:this.userid, password:this.password, global:true}); } + if (n.tls === false) { + this.tls = false; + } var node = this; var smtpOptions = { host: node.outserver, port: node.outport, - secure: node.secure + secure: node.secure, + tls: {rejectUnauthorized: node.tls} } if (this.userid && this.password) { @@ -66,8 +78,9 @@ module.exports = function(RED) { } var smtpTransport = nodemailer.createTransport(smtpOptions); - this.on("input", function(msg) { + this.on("input", function(msg, send, done) { if (msg.hasOwnProperty("payload")) { + send = send || function() { node.send.apply(node,arguments) }; if (smtpTransport) { node.status({fill:"blue",shape:"dot",text:"email.status.sending"}); if (msg.to && node.name && (msg.to !== node.name)) { @@ -78,6 +91,11 @@ module.exports = function(RED) { if (node.name === "") { sendopts.cc = msg.cc; sendopts.bcc = msg.bcc; + sendopts.inReplyTo = msg.inReplyTo; + sendopts.replyTo = msg.replyTo; + sendopts.references = msg.references; + sendopts.headers = msg.headers; + sendopts.priority = msg.priority; } sendopts.subject = msg.topic || msg.title || "Message from Node-RED"; // subject line if (msg.hasOwnProperty("envelope")) { sendopts.envelope = msg.envelope; } @@ -90,7 +108,7 @@ module.exports = function(RED) { if ((msg.payload[0] === 0x89)&&(msg.payload[1] === 0x50)) { fe = "png"; } //4E msg.filename = "attachment."+fe; } - var fname = msg.filename.replace(/^.*[\\\/]/, '') || "file.bin"; + var fname = msg.filename.replace(/^.*[\\\/]/, '') || "attachment.bin"; sendopts.attachments = [ { content:msg.payload, filename:fname } ]; if (msg.hasOwnProperty("headers") && msg.headers.hasOwnProperty("content-type")) { sendopts.attachments[0].contentType = msg.headers["content-type"]; @@ -102,15 +120,27 @@ module.exports = function(RED) { var payload = RED.util.ensureString(msg.payload); sendopts.text = payload; // plaintext body if (/<[a-z][\s\S]*>/i.test(payload)) { sendopts.html = payload; } // html body - if (msg.attachments) { sendopts.attachments = msg.attachments; } // add attachments + if (msg.attachments && Array.isArray(msg.attachments)) { + sendopts.attachments = msg.attachments; + for (var a=0; a < sendopts.attachments.length; a++) { + if (sendopts.attachments[a].hasOwnProperty("content")) { + if (typeof sendopts.attachments[a].content !== "string" && !Buffer.isBuffer(sendopts.attachments[a].content)) { + node.error(RED._("email.errors.invalidattachment"),msg); + node.status({fill:"red",shape:"ring",text:"email.status.sendfail"}); + return; + } + } + } + } } smtpTransport.sendMail(sendopts, function(error, info) { if (error) { node.error(error,msg); - node.status({fill:"red",shape:"ring",text:"email.status.sendfail"}); + node.status({fill:"red",shape:"ring",text:"email.status.sendfail",response:error.response,msg:{to:msg.to,topic:msg.topic,id:msg._msgid}}); } else { node.log(RED._("email.status.messagesent",{response:info.response})); - node.status({}); + node.status({text:"",response:info.response,msg:{to:msg.to,topic:msg.topic,id:msg._msgid}}); + if (done) { done(); } } }); } @@ -137,13 +167,24 @@ module.exports = function(RED) { RED.nodes.createNode(this,n); this.name = n.name; + this.inputs = n.inputs; this.repeat = n.repeat * 1000 || 300000; + if (this.repeat > 2147483647) { + // setTimeout/Interval has a limit of 2**31-1 Milliseconds + this.repeat = 2147483647; + this.error(RED._("email.errors.refreshtoolarge")); + } + if (this.repeat < 1500) { + this.repeat = 1500; + } + if (this.inputs === 1) { this.repeat = 0; } this.inserver = n.server || (globalkeys && globalkeys.server) || "imap.gmail.com"; this.inport = n.port || (globalkeys && globalkeys.port) || "993"; this.box = n.box || "INBOX"; this.useSSL= n.useSSL; this.protocol = n.protocol || "IMAP"; this.disposition = n.disposition || "None"; // "None", "Delete", "Read" + this.criteria = n.criteria || "UNSEEN"; // "ALL", "ANSWERED", "FLAGGED", "SEEN", "UNANSWERED", "UNFLAGGED", "UNSEEN" var flag = false; @@ -180,18 +221,19 @@ module.exports = function(RED) { // will be used to populate the email. // DCJ NOTE: - heirachical multipart mime parsers seem to not exist - this one is barely functional. function processNewMessage(msg, mailMessage) { - msg = JSON.parse(JSON.stringify(msg)); // Clone the message + msg = RED.util.cloneMessage(msg); // Clone the message // Populate the msg fields from the content of the email message // that we have just parsed. msg.payload = mailMessage.text; msg.topic = mailMessage.subject; msg.date = mailMessage.date; - msg.header = mailMessage.headers; + msg.header = {}; + mailMessage.headers.forEach((v, k) => {msg.header[k] = v;}); if (mailMessage.html) { msg.html = mailMessage.html; } - if (mailMessage.to && mailMessage.from.to > 0) { msg.to = mailMessage.to; } - if (mailMessage.cc && mailMessage.from.cc > 0) { msg.cc = mailMessage.cc; } - if (mailMessage.bcc && mailMessage.from.bcc > 0) { msg.bcc = mailMessage.bcc; } - if (mailMessage.from && mailMessage.from.length > 0) { msg.from = mailMessage.from[0].address; } + if (mailMessage.to && mailMessage.to.length > 0) { msg.to = mailMessage.to; } + if (mailMessage.cc && mailMessage.cc.length > 0) { msg.cc = mailMessage.cc; } + if (mailMessage.bcc && mailMessage.bcc.length > 0) { msg.bcc = mailMessage.bcc; } + if (mailMessage.from && mailMessage.from.value && mailMessage.from.value.length > 0) { msg.from = mailMessage.from.value[0].address; } if (mailMessage.attachments) { msg.attachments = mailMessage.attachments; } else { msg.attachments = []; } node.send(msg); // Propagate the message down the flow @@ -203,6 +245,7 @@ module.exports = function(RED) { function checkPOP3(msg) { var currentMessage; var maxMessage; + //node.log("Checking POP3 for new messages"); // Form a new connection to our email server using POP3. var pop3Client = new POP3Client( @@ -215,6 +258,7 @@ module.exports = function(RED) { function nextMessage() { if (currentMessage > maxMessage) { pop3Client.quit(); + setInputRepeatTimeout(); return; } pop3Client.retr(currentMessage); @@ -237,7 +281,8 @@ module.exports = function(RED) { }); pop3Client.on("error", function(err) { - node.log("We caught an error: " + JSON.stringify(err)); + setInputRepeatTimeout(); + node.log("error: " + JSON.stringify(err)); }); pop3Client.on("connect", function() { @@ -252,6 +297,7 @@ module.exports = function(RED) { } else { node.log(util.format("login error: %s %j", status, rawData)); pop3Client.quit(); + setInputRepeatTimeout(); } }); @@ -261,18 +307,22 @@ module.exports = function(RED) { // We have now received a new email message. Create an instance of a mail parser // and pass in the email message. The parser will signal when it has parsed the message. - var mailparser = new MailParser(); - mailparser.on("end", function(mailObject) { - //node.log(util.format("mailparser: on(end): %j", mailObject)); - processNewMessage(msg, mailObject); + simpleParser(data, {}, function(err, parsed) { + //node.log(util.format("simpleParser: on(end): %j", mailObject)); + if (err) { + node.status({fill:"red", shape:"ring", text:"email.status.parseerror"}); + node.error(RED._("email.errors.parsefail", {folder:node.box}), err); + } + else { + processNewMessage(msg, parsed); + } }); - mailparser.write(data); - mailparser.end(); pop3Client.dele(msgNumber); } else { node.log(util.format("retr error: %s %j", status, rawData)); pop3Client.quit(); + setInputRepeatTimeout(); } }); @@ -296,83 +346,121 @@ module.exports = function(RED) { // checkIMAP // // Check the email sever using the IMAP protocol for new messages. + var s = false; + var ss = false; function checkIMAP(msg) { - node.log("Checking IMAP for new messages"); + //console.log("Checking IMAP for new messages"); // We get back a 'ready' event once we have connected to imap + s = true; imap.once("ready", function() { + if (ss === true) { return; } + ss = true; node.status({fill:"blue", shape:"dot", text:"email.status.fetching"}); //console.log("> ready"); - // Open the inbox folder + // Open the folder imap.openBox(node.box, // Mailbox name false, // Open readonly? function(err, box) { + //console.log("> Inbox err : %j", err); //console.log("> Inbox open: %j", box); - imap.search([ 'UNSEEN' ], function(err, results) { if (err) { + var boxs = []; + imap.getBoxes(function(err,boxes) { + if (err) { return; } + for (var prop in boxes) { + if (boxes.hasOwnProperty(prop)) { + if (boxes[prop].children) { + boxs.push(prop+"/{"+Object.keys(boxes[prop].children)+'}'); + } + else { boxs.push(prop); } + } + } + node.error(RED._("email.errors.fetchfail", {folder:node.box+". Folders - "+boxs.join(', ')}),err); + }); node.status({fill:"red", shape:"ring", text:"email.status.foldererror"}); - node.error(RED._("email.errors.fetchfail", {folder:node.box}),err); - imap.end(); - return; - } - //console.log("> search - err=%j, results=%j", err, results); - if (results.length === 0) { - //console.log(" [X] - Nothing to fetch"); - node.status({}); imap.end(); + s = false; + setInputRepeatTimeout(); return; } + else { + var criteria = ((node.criteria === '_msg_')? + (msg.criteria || ["UNSEEN"]): + ([node.criteria])); + imap.search(criteria, function(err, results) { + if (err) { + node.status({fill:"red", shape:"ring", text:"email.status.foldererror"}); + node.error(RED._("email.errors.fetchfail", {folder:node.box}),err); + imap.end(); + s = false; + setInputRepeatTimeout(); + return; + } + else { + //console.log("> search - err=%j, results=%j", err, results); + if (results.length === 0) { + //console.log(" [X] - Nothing to fetch"); + node.status({results:0}); + imap.end(); + s = false; + setInputRepeatTimeout(); + return; + } - var marks = false; - if (node.disposition === "Read") { marks = true; } - // We have the search results that contain the list of unseen messages and can now fetch those messages. - var fetch = imap.fetch(results, { - bodies: '', - struct: true, - markSeen: marks - }); - - // For each fetched message returned ... - fetch.on('message', function(imapMessage, seqno) { - //node.log(RED._("email.status.message",{number:seqno})); - var messageText = ""; - //console.log("> Fetch message - msg=%j, seqno=%d", imapMessage, seqno); - imapMessage.on('body', function(stream, info) { - //console.log("> message - body - stream=?, info=%j", info); - stream.on('data', function(chunk) { - //console.log("> stream - data - chunk=??"); - messageText += chunk.toString('utf8'); - }); - stream.once('end', function() { - var mailParser = new MailParser(); - mailParser.on('end', function(mailMessage) { - processNewMessage(msg, mailMessage); + var marks = false; + if (node.disposition === "Read") { marks = true; } + // We have the search results that contain the list of unseen messages and can now fetch those messages. + var fetch = imap.fetch(results, { + bodies: '', + struct: true, + markSeen: marks }); - mailParser.write(messageText); - mailParser.end(); - }); // End of msg->end - }); // End of msg->body - }); // End of fetch->message - // When we have fetched all the messages, we don't need the imap connection any more. - fetch.on('end', function() { - node.status({}); - var cleanup = function() { - imap.end(); - }; - if (this.disposition === "Delete") { - imap.addFlags(results, "\Deleted", cleanup); - } else if (this.disposition === "Read") { - imap.addFlags(results, "\Seen", cleanup); - } else { - cleanup(); - } - }); + // For each fetched message returned ... + fetch.on('message', function(imapMessage, seqno) { + //node.log(RED._("email.status.message",{number:seqno})); + //console.log("> Fetch message - msg=%j, seqno=%d", imapMessage, seqno); + imapMessage.on('body', function(stream, info) { + //console.log("> message - body - stream=?, info=%j", info); + simpleParser(stream, {}, function(err, parsed) { + if (err) { + node.status({fill:"red", shape:"ring", text:"email.status.parseerror"}); + node.error(RED._("email.errors.parsefail", {folder:node.box}),err); + } + else { + processNewMessage(msg, parsed); + } + }); + }); // End of msg->body + }); // End of fetch->message - fetch.once('error', function(err) { - console.log('Fetch error: ' + err); - }); - }); // End of imap->search - }); // End of imap->openInbox + // When we have fetched all the messages, we don't need the imap connection any more. + fetch.on('end', function() { + node.status({results:results.length}); + var cleanup = function() { + imap.end(); + s = false; + setInputRepeatTimeout(); + }; + if (node.disposition === "Delete") { + imap.addFlags(results, "\Deleted", cleanup); + } else if (node.disposition === "Read") { + imap.addFlags(results, "\Seen", cleanup); + } else { + cleanup(); + } + }); + + fetch.once('error', function(err) { + console.log('Fetch error: ' + err); + imap.end(); + s = false; + setInputRepeatTimeout(); + }); + } + }); // End of imap->search + } + }); // End of imap->openInbox }); // End of imap->ready node.status({fill:"grey",shape:"dot",text:"node-red:common.status.connecting"}); imap.connect(); @@ -384,11 +472,12 @@ module.exports = function(RED) { if (node.protocol === "POP3") { checkPOP3(msg); } else if (node.protocol === "IMAP") { - checkIMAP(msg); + if (s === false && ss == false) { checkIMAP(msg); } } } // End of checkEmail if (node.protocol === "IMAP") { + var tout = (node.repeat > 0) ? node.repeat - 500 : 15000; imap = new Imap({ user: node.userid, password: node.password, @@ -396,14 +485,16 @@ module.exports = function(RED) { port: node.inport, tls: node.useSSL, tlsOptions: { rejectUnauthorized: false }, - connTimeout: node.repeat, - authTimeout: node.repeat + connTimeout: tout, + authTimeout: tout }); imap.on('error', function(err) { if (err.errno !== "ECONNRESET") { node.log(err); + s = false; node.status({fill:"red",shape:"ring",text:"email.status.connecterror"}); } + setInputRepeatTimeout(); }); } @@ -413,19 +504,22 @@ module.exports = function(RED) { this.on("close", function() { if (this.interval_id != null) { - clearInterval(this.interval_id); + clearTimeout(this.interval_id); } if (imap) { imap.destroy(); } }); - // Set the repetition timer as needed - if (!isNaN(this.repeat) && this.repeat > 0) { - this.interval_id = setInterval( function() { - node.emit("input",{}); - }, this.repeat ); + function setInputRepeatTimeout() { + // Set the repetition timer as needed + if (!isNaN(node.repeat) && node.repeat > 0) { + node.interval_id = setTimeout( function() { + node.emit("input",{}); + }, node.repeat ); + } + ss = false; } - node.emit("input",{}); + if (this.inputs !== 1) { node.emit("input",{}); } } RED.nodes.registerType("e-mail in",EmailInNode,{ @@ -435,4 +529,61 @@ module.exports = function(RED) { global: { type:"boolean" } } }); + + + function EmailMtaNode(n) { + RED.nodes.createNode(this,n); + this.port = n.port; + var node = this; + + node.mta = new SMTPServer({ + secure: false, + logger: false, + disabledCommands: ['AUTH', 'STARTTLS'], + + onData: function (stream, session, callback) { + simpleParser(stream, { skipTextToHtml:true, skipTextLinks:true }, (err, parsed) => { + if (err) { node.error(RED._("email.errors.parsefail"),err); } + else { + node.status({fill:"green", shape:"dot", text:""}); + var msg = {} + msg.payload = parsed.text; + msg.topic = parsed.subject; + msg.date = parsed.date; + msg.header = {}; + parsed.headers.forEach((v, k) => {msg.header[k] = v;}); + if (parsed.html) { msg.html = parsed.html; } + if (parsed.to) { + if (typeof(parsed.to) === "string" && parsed.to.length > 0) { msg.to = parsed.to; } + else if (parsed.to.hasOwnProperty("text") && parsed.to.text.length > 0) { msg.to = parsed.to.text; } + } + if (parsed.cc) { + if (typeof(parsed.cc) === "string" && parsed.cc.length > 0) { msg.cc = parsed.cc; } + else if (parsed.cc.hasOwnProperty("text") && parsed.cc.text.length > 0) { msg.cc = parsed.cc.text; } + } + if (parsed.cc && parsed.cc.length > 0) { msg.cc = parsed.cc; } + if (parsed.bcc && parsed.bcc.length > 0) { msg.bcc = parsed.bcc; } + if (parsed.from && parsed.from.value && parsed.from.value.length > 0) { msg.from = parsed.from.value[0].address; } + if (parsed.attachments) { msg.attachments = parsed.attachments; } + else { msg.attachments = []; } + node.send(msg); // Propagate the message down the flow + setTimeout(function() { node.status({})}, 500); + } + callback(); + }); + } + }); + + node.mta.listen(node.port); + + node.mta.on("error", err => { + node.error("Error: " + err.message, err); + }); + + node.on("close", function() { + node.mta.close(); + }); + } + RED.nodes.registerType("e-mail mta",EmailMtaNode); + }; diff --git a/social/email/README.md b/social/email/README.md index 0d50bcac..8a096719 100644 --- a/social/email/README.md +++ b/social/email/README.md @@ -1,21 +1,35 @@ node-red-node-email =================== -Node-RED nodes to send and receive simple emails. +Node-RED nodes to send and receive simple emails. Pre-requisite ------------- -You will need valid email credentials for your email server. +You will need valid email credentials for your email server. For GMail this may mean +getting an application password if you have two-factor authentication enabled. + +**Note :** Version 1.x of this node requires **Node.js v8** or newer. + Install ------- -Run the following command in your Node-RED user directory - typically `~/.node-red` +Version 0.x of this node is usually installed by default by Node-RED. +As long as you have at least version 0.19.x of Node-RED you can install the new version +by using the `Menu - Manage Palette` option, or running the following command in your +Node-RED user directory - typically `~/.node-red` + cd ~/.node-red npm i node-red-node-email +GMail users +----------- + +If you are accessing GMail you may need to either enable an application password, +or enable less secure access via your Google account settings.

+ Usage ----- @@ -44,8 +58,10 @@ Sends the `msg.payload` as an email, with a subject of `msg.topic`. The default message recipient can be configured in the node, if it is left blank it should be set using the `msg.to` property of the incoming message. -You may optionally override the *from* email address by setting `msg.from`, -otherwise the node will use the `userid` setting from the server connection. +The email *from* can be set using `msg.from` but not all mail services allow +this unless `msg.from` is also a valid userid or email address associated with +the password. Note: if `userid` or msg.from does not contain a valid email +address (userxx@some_domain.com), you may see (No Sender) in the email. The payload can be html format. @@ -55,6 +71,6 @@ The filename should be set using `msg.filename`. Optionally `msg.description` can be added for the body text. Alternatively you may provide `msg.attachments` which should contain an array of one or -more attachments in nodemailer format. +more attachments in nodemailer format. Uses the *nodemailer* npm module. diff --git a/social/email/locales/en-US/61-email.html b/social/email/locales/en-US/61-email.html new file mode 100644 index 00000000..3806b8de --- /dev/null +++ b/social/email/locales/en-US/61-email.html @@ -0,0 +1,64 @@ + + + + + \ No newline at end of file diff --git a/social/email/locales/en-US/61-email.json b/social/email/locales/en-US/61-email.json index a3d1c318..606580b7 100644 --- a/social/email/locales/en-US/61-email.json +++ b/social/email/locales/en-US/61-email.json @@ -1,26 +1,41 @@ { "email": { + "email": "email", "label": { + "getmail":"Get mail", + "auto": "automatically", + "trigger": "when triggered", "to": "To", "server": "Server", "port": "Port", "useSecureConnection": "Use secure connection.", "userid": "Userid", "password": "Password", - "repeat": "Refresh", + "repeat": "every", "seconds": "seconds", "folder": "Folder", "protocol": "Protocol", "useSSL": "Use SSL?", + "useTLS": "Use TLS?", "disposition": "Disposition", "none": "None", "read": "Mark Read", - "delete": "Delete" + "delete": "Delete", + "criteria": "Criteria", + "criteriaFromMsg": "- set from msg.criteria -", + "all": "All", + "answered": "Answered", + "flagged": "Flagged", + "seen": "Seen", + "unanswered": "Unanswered", + "unflagged": "Unflagged", + "unseen": "Unseen" }, "default-message": "__description__\n\nFile from Node-RED is attached: __filename__", "tip": { "cred": "Note: Copied credentials from global emailkeys.js file.", - "recent": "Tip: Only retrieves the single most recent email." + "recent": "Tip: Only retrieves the single most recent email.", + "mta": "Note: To use ports below 1024 you may need elevated (root) privileges. See help sidebar." }, "status": { "messagesent": "Message sent: __response__", @@ -33,6 +48,7 @@ "inboxzero": "you have achieved Inbox Zero", "sending": "sending", "sendfail": "send failed", + "parseerror": "Failed to parse message", "connecterror": "connect error" }, "errors": { @@ -42,7 +58,10 @@ "nosmtptransport": "No SMTP transport. See info panel.", "nopayload": "No payload to send", "fetchfail": "Failed to fetch folder: __folder__", - "messageerror": "Fetch message error: __error__" + "parsefail": "Failed to parse message", + "messageerror": "Fetch message error: __error__", + "refreshtoolarge": "Refresh interval too large. Limiting to 2147483 seconds", + "invalidattachment": "Invalid attachment content. Must be String or buffer" } } } diff --git a/social/email/locales/ja/61-email.html b/social/email/locales/ja/61-email.html new file mode 100644 index 00000000..7e7f64c5 --- /dev/null +++ b/social/email/locales/ja/61-email.html @@ -0,0 +1,50 @@ + + + + + + + \ No newline at end of file diff --git a/social/email/locales/ja/61-email.json b/social/email/locales/ja/61-email.json index db4821b3..0938a236 100644 --- a/social/email/locales/ja/61-email.json +++ b/social/email/locales/ja/61-email.json @@ -15,12 +15,14 @@ "disposition": "受信後の処理", "none": "なし", "read": "既読", - "delete": "削除" + "delete": "削除", + "criteriaFromMsg": "- msg.criteriaから使用 -" }, "default-message": "__description__\n\nNode-REDからファイルが添付されました: __filename__", "tip": { "cred": "注釈: emailkeys.jsファイルから認証情報をコピーしました。", - "recent": "注釈: 最新のメールを1件のみ取得します。" + "recent": "注釈: 最新のメールを1件のみ取得します。", + "mta": "注釈: 1024未満のポートを使用するには、昇格された(root)特権が必要です。ヘルプサイドバーを参照してください。" }, "status": { "messagesent": "メッセージを送信しました: __response__", @@ -33,6 +35,7 @@ "inboxzero": "受信トレイにメールがありません", "sending": "送信中", "sendfail": "送信が失敗しました", + "parseerror": "メッセージのパースに失敗", "connecterror": "接続エラー" }, "errors": { @@ -42,6 +45,7 @@ "nosmtptransport": "SMTP転送が設定されていません。「情報」タブを参照してください", "nopayload": "送信するペイロードがありません", "fetchfail": "フォルダの受信に失敗しました: __folder__", + "parsefail": "メッセージのパースに失敗", "messageerror": "メッセージ受信エラー: __error__" } } diff --git a/social/email/package.json b/social/email/package.json index 2f90f14f..8aa2a66e 100644 --- a/social/email/package.json +++ b/social/email/package.json @@ -1,12 +1,13 @@ { "name": "node-red-node-email", - "version": "0.1.24", - "description": "Node-RED nodes to send and receive simple emails", + "version": "1.8.3", + "description": "Node-RED nodes to send and receive simple emails.", "dependencies": { - "nodemailer": "^1.11.0", + "imap": "^0.8.19", "poplib": "^0.1.7", - "mailparser": "^0.6.1", - "imap": "^0.8.19" + "mailparser": "^3.0.1", + "nodemailer": "~6.4.17", + "smtp-server": "^3.8.0" }, "repository": { "type": "git", @@ -17,7 +18,9 @@ "node-red", "email", "gmail", - "imap" + "imap", + "pop", + "mta" ], "node-red": { "nodes": { @@ -28,5 +31,8 @@ "name": "Dave Conway-Jones", "email": "ceejay@vnet.ibm.com", "url": "http://nodered.org" + }, + "engines": { + "node": ">=8.0.0" } } diff --git a/social/feedparser/32-feedparse.html b/social/feedparser/32-feedparse.html index 5d732881..0e62d3ac 100644 --- a/social/feedparser/32-feedparse.html +++ b/social/feedparser/32-feedparse.html @@ -1,4 +1,3 @@ - - - diff --git a/social/feedparser/locales/en-US/32-feedparse.json b/social/feedparser/locales/en-US/32-feedparse.json index 89efa3be..2a5fd943 100644 --- a/social/feedparser/locales/en-US/32-feedparse.json +++ b/social/feedparser/locales/en-US/32-feedparse.json @@ -1,5 +1,6 @@ { "feedparse": { + "feedparse": "feedparser", "label": { "feedurl": "Feed url", "refresh": "Refresh", @@ -7,7 +8,8 @@ }, "errors": { "badstatuscode": "error - Bad status code", - "invalidurl": "Invalid url" + "invalidurl": "Invalid url", + "invalidinterval": "Repeat interval too large" } } -} \ No newline at end of file +} diff --git a/social/feedparser/locales/ja/32-feedparse.html b/social/feedparser/locales/ja/32-feedparse.html new file mode 100644 index 00000000..c2dd8ebb --- /dev/null +++ b/social/feedparser/locales/ja/32-feedparse.html @@ -0,0 +1,5 @@ + diff --git a/social/feedparser/package.json b/social/feedparser/package.json index a5c0328f..5e658d02 100644 --- a/social/feedparser/package.json +++ b/social/feedparser/package.json @@ -1,10 +1,10 @@ { "name": "node-red-node-feedparser", - "version": "0.1.8", + "version": "0.1.16", "description": "A Node-RED node to get RSS Atom feeds.", "dependencies": { - "feedparser": "1.1.3", - "request": "~2.74.0" + "feedparser": "^2.2.10", + "request": "^2.88.0" }, "repository": { "type": "git", diff --git a/social/nma/README.md b/social/nma/README.md index 69ee9a3d..0aef1c49 100644 --- a/social/nma/README.md +++ b/social/nma/README.md @@ -1,6 +1,8 @@ node-red-node-nma ================= +## DO NOT USE - as NMA have ceased to operate. + A Node-RED node to send alerts via Notify-My-Android. Install diff --git a/social/nma/package.json b/social/nma/package.json index 45f06dc6..3d8c0837 100644 --- a/social/nma/package.json +++ b/social/nma/package.json @@ -1,6 +1,6 @@ { "name" : "node-red-node-nma", - "version" : "0.0.8", + "version" : "0.0.9", "description" : "A Node-RED node to send alerts via Notify-My-Android", "dependencies" : { "nma" : "0.2.2" @@ -10,7 +10,7 @@ "url":"https://github.com/node-red/node-red-nodes/tree/master/social/nma" }, "license": "Apache-2.0", - "keywords": [ "node-red", "nma", "notify my android" ], + "keywords": [ "nma", "notify my android" ], "node-red" : { "nodes" : { "nma": "57-nma.js" diff --git a/social/notify/57-notify.html b/social/notify/57-notify.html index d0fc85d4..fe3244a2 100644 --- a/social/notify/57-notify.html +++ b/social/notify/57-notify.html @@ -1,5 +1,5 @@ - - - - - - @@ -86,6 +97,7 @@ sound: {value:""}, url: {value:""}, url_title: {value:""}, + html: {value:false} }, credentials: { deviceid: {type:"text"}, diff --git a/social/pushover/57-pushover.js b/social/pushover/57-pushover.js index e34da173..947528c1 100644 --- a/social/pushover/57-pushover.js +++ b/social/pushover/57-pushover.js @@ -3,6 +3,7 @@ module.exports = function(RED) { "use strict"; var PushOver = require('pushover-notifications'); var util = require('util'); + var fs = require('fs'); function PushoverNode(n) { RED.nodes.createNode(this,n); @@ -10,6 +11,7 @@ module.exports = function(RED) { this.device = n.device; this.priority = n.priority; this.sound = n.sound; + this.html = n.html; if (this.sound === '') { this.sound = null; } var credentials = this.credentials; if ((credentials) && (credentials.hasOwnProperty("pushkey"))) { this.pushkey = credentials.pushkey; } @@ -29,15 +31,18 @@ module.exports = function(RED) { var node = this; this.on("input",function(msg) { - var titl = this.title || msg.topic || "Node-RED"; - var pri = this.priority || msg.priority || 0; - var dev = this.device || msg.device; - var sound = this.sound || msg.sound || null; - var url = this.url || msg.url || null; - var url_title = this.url_title || msg.url_title || null; + var title = node.title || msg.topic || "Node-RED"; + var pri = node.priority || msg.priority || 0; + var dev = node.device || msg.device; + var sound = node.sound || msg.sound || null; + var url = node.url || msg.url || null; + var url_title = node.url_title || msg.url_title || null; + var html = node.html || false; + var attachment = msg.attachment || null; if (isNaN(pri)) {pri=0;} if (pri > 2) {pri = 2;} if (pri < -2) {pri = -2;} + if (!msg.payload) { msg.payload = ""; } if (typeof(msg.payload) === 'object') { msg.payload = JSON.stringify(msg.payload); } @@ -45,25 +50,68 @@ module.exports = function(RED) { if (pusher) { var pushmsg = { message: msg.payload, - title: titl, + title: title, priority: pri, retry: 30, - expire: 600 + expire: 600, + html: html }; if (dev) { pushmsg.device = dev; } if (typeof(sound) === 'string') { pushmsg.sound = sound; } if (typeof(url) === 'string') { pushmsg.url = url; } if (typeof(url_title) === 'string') { pushmsg.url_title = url_title; } - //node.log("Sending "+JSON.stringify(pushmsg)); - pusher.send( pushmsg, function(err, response) { - if (err) { node.error("Pushover Error: "+err); } - //console.log(response); - }); + if (html) { pushmsg.html = 1; } + if (typeof(attachment) === 'string') { + // Treat attachment as a path + fs.readFile(attachment,function(err, data) { + if (err) { + node.error("[57-pushover.js] Error: File Read Error: "+err); + return; + } + pushmsg.file = { data: data }; + pushMessage(pushmsg); + }); + return; + } + else if (attachment instanceof Buffer) { + // Is it base64 encoded or binary? + var attachmentString = attachment.toString(); + var attachmentBuffer = Buffer.from(attachmentString,'base64'); + if (attachmentString === attachmentBuffer.toString('base64')) { + // If converts back to same, then it was base64 so set to binary + // https://stackoverflow.com/a/48770228 + attachment = attachmentBuffer; + } + // Unset these temporary values + attachmentBuffer = attachmentString = undefined; + // attach the buffer + pushmsg.file = { data: attachment }; + } + else if (attachment) { + node.error("[57-pushover.js] Error: attachment property must be a path to a local file or a Buffer containing an image"); + return; + } + pushMessage(pushmsg,msg); } else { node.warn("Pushover credentials not set."); } }); + + function pushMessage(pushmsg,msg) { + pusher.send( pushmsg, function(err, response) { + if (err) { node.error(err,msg); } + else { + try { + var responseObject = JSON.parse(response); + if (responseObject.status !== 1) { node.error("[57-pushover.js] Error: "+response); } + } + catch(e) { + node.error("[57-pushover.js] Error: "+response); + } + } + }); + } } RED.nodes.registerType("pushover",PushoverNode,{ credentials: { diff --git a/social/pushover/README.md b/social/pushover/README.md index 86c592f9..fd948db6 100644 --- a/social/pushover/README.md +++ b/social/pushover/README.md @@ -16,12 +16,15 @@ Usage Uses Pushover to push the `msg.payload` to a device that has the Pushover app installed. -Optionally uses `msg.topic` to set the title, `msg.device` to set the device -and `msg.priority` to set the priority, if not already set in the properties. -Optionally uses `msg.topic` to set the title, `msg.device` to set the device, -`msg.priority` to set the priority, `msg.url` to add a web address and `msg.url_title` -to add a url title - if not already set in the properties. +Optionally uses `msg.topic` to set the configuration, if not already set in the properties: + - `msg.device`: to set the device + - `msg.priority`: to set the priority + - `msg.topic`: to set the title + - `msg.attachment`: to specify an image to attach to message (path as a string or Buffer containing image) + - `msg.url`: to add a web address + - `msg.url_title`: to add a url title + - `msg.sound`: to set the alert sound, see the [available options](https://pushover.net/api#sounds) The User-key and API-token are stored in a separate credentials file. diff --git a/social/pushover/package.json b/social/pushover/package.json index abd8c230..6b39a6dc 100644 --- a/social/pushover/package.json +++ b/social/pushover/package.json @@ -1,9 +1,9 @@ { "name" : "node-red-node-pushover", - "version" : "0.0.11", + "version" : "0.0.20", "description" : "A Node-RED node to send alerts via Pushover", "dependencies" : { - "pushover-notifications" : "~0.2.3" + "pushover-notifications" : "^1.2.2" }, "repository" : { "type":"git", @@ -20,5 +20,12 @@ "name": "Dave Conway-Jones", "email": "ceejay@vnet.ibm.com", "url": "http://nodered.org" - } + }, + "contributors": [ + { + "name": "Damien Clark", + "email": "damo.clarky@gmail.com", + "url": "https://damos.world" + } + ] } diff --git a/social/twilio/56-twilio.js b/social/twilio/56-twilio.js index 75d47823..48403ba5 100644 --- a/social/twilio/56-twilio.js +++ b/social/twilio/56-twilio.js @@ -58,20 +58,14 @@ module.exports = function(RED) { if ( this.twilioType == "call" ) { // Make a call var twimlurl = node.url || msg.payload; - node.twilioClient.makeCall( {to: tonum, from: node.fromNumber, url: twimlurl}, function(err, response) { - if (err) { - node.error(err.message,msg); - } - //console.log(response); + node.twilioClient.calls.create({to: tonum, from: node.fromNumber, url: twimlurl}).catch(function(err) { + node.error(err.message,msg); }); } else { // Send SMS - node.twilioClient.sendMessage( {to: tonum, from: node.fromNumber, body: msg.payload}, function(err, response) { - if (err) { - node.error(err.message,msg); - } - //console.log(response); + node.twilioClient.messages.create({to: tonum, from: node.fromNumber, body: msg.payload}).catch( function(err) { + node.error(err.message,msg); }); } } diff --git a/social/twilio/package.json b/social/twilio/package.json index 43b86383..22b79dd7 100644 --- a/social/twilio/package.json +++ b/social/twilio/package.json @@ -1,9 +1,9 @@ { "name" : "node-red-node-twilio", - "version" : "0.0.15", + "version" : "0.1.0", "description" : "A Node-RED node to send SMS messages via the Twilio service.", "dependencies" : { - "twilio" : "^2.11.1" + "twilio" : "^3.11.3" }, "repository" : { "type":"git", diff --git a/social/twitter/27-twitter.html b/social/twitter/27-twitter.html index 65f7a77b..3d72a66c 100644 --- a/social/twitter/27-twitter.html +++ b/social/twitter/27-twitter.html @@ -1,7 +1,34 @@ - - - - - - + + + + diff --git a/social/twitter/locales/en-US/27-twitter.json b/social/twitter/locales/en-US/27-twitter.json index d4684392..4282327d 100644 --- a/social/twitter/locales/en-US/27-twitter.json +++ b/social/twitter/locales/en-US/27-twitter.json @@ -1,7 +1,7 @@ { "twitter": { "label": { - "twitter-id":"Twitter ID", + "twitter-id": "Twitter ID", "search": "Search", "for": "for", "user": "User", @@ -9,7 +9,14 @@ "followers": "followed by", "tweetslabel": "tweets", "eventslabel": "events", - "clickhere": "Click here to authenticate with Twitter." + "create": "Create your own application at", + "copy-consumer": "From the 'Keys and tokens' section, copy the Consumer API keys", + "consumer_key": "API key", + "consumer_secret": "API secret key", + "copy-accessToken": "Create a new 'Access token & access token secret' and copy them", + "access_key": "Access token", + "access_secret": "Access token secret", + "enter-id": "Set your Twitter ID" }, "placeholder": { "for": "comma-separated words, @ids, #tags", @@ -26,25 +33,22 @@ "status": { "using-geo": "Using geo location: __location__", "tweeting": "tweeting", - "failed":"failed" + "failed": "failed" }, "warn": { - "nousers":"User option selected but no users specified", - "waiting":"Waiting for search term" + "nousers": "User option selected but no users specified", + "waiting": "Waiting for search term" }, "errors": { - "ratelimit":"rate limit hit", - "limitrate":"limiting rate", - "streamerror":"stream error: __error__ (__rc__)", - "unexpectedend":"stream ended unexpectedly", - "invalidtag":"invalid tag property", - "missingcredentials":"missing twitter credentials", - "truncated":"truncated tweet greater than 140 characters", - "sendfail":"send tweet failed: __error__", - "nopayload":"no payload to tweet", - "oauthbroke":"something in twitter oauth broke.", - "oautherror": "

Something went wrong with the authentication process. The following error was returned:

__statusCode__: __errorData__

One known cause of this type of failure is if the clock is wrong on system running Node-RED

", - "authorized": "

Authorised - you can close this window and return to Node-RED

" + "ratelimit": "rate limit hit", + "limitrate": "limiting rate", + "streamerror": "stream error: __error__ (__rc__)", + "unexpectedend": "stream ended unexpectedly", + "invalidtag": "invalid tag property", + "missingcredentials": "missing twitter credentials", + "truncated": "truncated tweet greater than 280 characters", + "sendfail": "send tweet failed: __error__", + "nopayload": "no payload to tweet" } } } diff --git a/social/twitter/locales/ja/27-twitter.html b/social/twitter/locales/ja/27-twitter.html new file mode 100644 index 00000000..04904ad7 --- /dev/null +++ b/social/twitter/locales/ja/27-twitter.html @@ -0,0 +1,48 @@ + + + + + + + diff --git a/social/twitter/locales/ja/27-twitter.json b/social/twitter/locales/ja/27-twitter.json index f48dceeb..3edc7f46 100644 --- a/social/twitter/locales/ja/27-twitter.json +++ b/social/twitter/locales/ja/27-twitter.json @@ -9,7 +9,14 @@ "followers": "followed by", "tweetslabel": "tweets", "eventslabel": "events", - "clickhere": "Twitterの認証を行うため、ここをクリックしてください" + "create": "次のURLから自身のアプリケーションを作成", + "copy-consumer": "'Keys and tokens'セクションからConsumer APIキーをコピー", + "consumer_key": "API key", + "consumer_secret": "API secret key", + "copy-accessToken": "新たに'Access token & access token secret'を作成し、コピー", + "access_key": "Access token", + "access_secret": "Access token secret", + "enter-id": "Twitter IDを設定" }, "placeholder": { "for": "@ids, #tagsはコンマ区切りで入力", @@ -39,12 +46,9 @@ "unexpectedend": "ストリームが予期せず終了しました", "invalidtag": "無効なタグプロパティ", "missingcredentials": "Twitterが認証されていません", - "truncated": "140文字を超えるツイートが切り捨てられました", + "truncated": "280文字を超えるツイートが切り捨てられました", "sendfail": "ツイートの投稿が失敗: __error__", - "nopayload": "ツイートするペイロードがありません", - "oauthbroke": "something in twitter oauth broke.", - "oautherror": "

認証処理で問題が生じました。以下のエラーが返されました:

__statusCode__: __errorData__

Node-REDが動いているシステムの時刻が正しく設定されていないことが、このエラーの原因の1つです。

", - "authorized": "

認証されました - このウィンドウを閉じて、Node-REDへ戻ることができます。

" + "nopayload": "ツイートするペイロードがありません" } } } diff --git a/social/twitter/package.json b/social/twitter/package.json index aa74574e..42c76f06 100644 --- a/social/twitter/package.json +++ b/social/twitter/package.json @@ -1,26 +1,31 @@ { - "name" : "node-red-node-twitter", - "version" : "0.1.12", - "description" : "A Node-RED node to talk to Twitter", - "dependencies" : { + "name": "node-red-node-twitter", + "version": "1.1.7", + "description": "A Node-RED node to talk to Twitter", + "dependencies": { "twitter-ng": "0.6.2", - "oauth" : "0.9.14", - "request" : "^2.75.0" + "request": "^2.88.0" }, - "repository" : { - "type":"git", - "url":"https://github.com/node-red/node-red-nodes/tree/master/social/twitter" + "repository": { + "type": "git", + "url": "https://github.com/node-red/node-red-nodes/tree/master/social/twitter" }, "license": "Apache-2.0", - "keywords": [ "node-red", "twitter" ], - "node-red" : { - "nodes" : { + "keywords": [ + "node-red", + "twitter" + ], + "node-red": { + "nodes": { "twitter": "27-twitter.js" } }, - "author": { - "name": "Dave Conway-Jones", - "email": "ceejay@vnet.ibm.com", - "url": "http://nodered.org" - } + "contributors": [ + { + "name": "Nick O'Leary" + }, + { + "name": "Dave Conway-Jones" + } + ] } diff --git a/social/xmpp/92-xmpp.html b/social/xmpp/92-xmpp.html index 1fc2c0b1..83d653e4 100644 --- a/social/xmpp/92-xmpp.html +++ b/social/xmpp/92-xmpp.html @@ -1,17 +1,17 @@ - - - - - + + diff --git a/social/xmpp/92-xmpp.js b/social/xmpp/92-xmpp.js index 262b5d4c..59e0ac36 100644 --- a/social/xmpp/92-xmpp.js +++ b/social/xmpp/92-xmpp.js @@ -1,23 +1,212 @@ module.exports = function(RED) { "use strict"; - var XMPP = require('simple-xmpp'); + const {client, xml, jid} = require('@xmpp/client') + process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0' + const LOGITALL=false; function XMPPServerNode(n) { RED.nodes.createNode(this,n); - this.server = n.server; - this.port = n.port; this.nickname = n.nickname; + this.jid = n.user; + this.username = n.user.split('@')[0]; + // The user may elect to just specify the jid in the settings, + // in which case extract the server from the jid and default the port + if ("undefined" === typeof n.server || n.server === "") { + this.server = n.user.split('@')[1]; + } + else{ + this.server = n.server; + } + if ("undefined" === typeof n.port || n.port === "") { + this.port = 5222; + } + else{ + this.port = parseInt(n.port); + } + + // The password is obfuscated and stored in a separate location var credentials = this.credentials; if (credentials) { - this.username = credentials.user; this.password = credentials.password; } + // The basic xmpp client object, this will be referred to as "xmpp" in the nodes. + // note we're not actually connecting here. + var proto = "xmpp"; + if (this.port === 5223) { + proto = "xmpps"; + } + if (RED.settings.verbose || LOGITALL) { + this.log("Setting up connection xmpp: {service: "+proto+"://"+this.server+":"+this.port+", username: "+this.username+", password: "+this.password+"}"); + } + this.client = client({ + service: proto+'://' + this.server + ':' + this.port, + username: this.username, + password: this.password + }); + + // helper variable for checking against later, maybe we should be using the client + // object directly... + this.connected = false; + // store the nodes that have us as config so we know when to tear it all down. + this.users = {}; + // helper variable, because "this" changes definition inside a callback + var that = this; + + // function for a node to tell us it has us as config + this.register = function(xmppThat) { + if (RED.settings.verbose || LOGITALL) {that.log("registering "+xmppThat.id); } + that.users[xmppThat.id] = xmppThat; + // So we could start the connection here, but we already have the logic in the thats. + // if (Object.keys(that.users).length === 1) { + // this.client.start(); + // } + }; + + // function for a node to tell us it's not using us anymore + this.deregister = function(xmppThat,done) { + if (RED.settings.verbose || LOGITALL) {that.log("deregistering "+xmppThat.id); } + delete that.users[xmppThat.id]; + if (that.closing) { + return done(); + } + if (Object.keys(that.users).length === 0) { + if (that.client && that.client.connected) { + return that.client.stop(done); + } else { + return done(); + } + } + done(); + }; + + // store the last node to use us, in case we get an error back + this.lastUsed = undefined; + // function for a node to tell us it has just sent a message to our server + // so we know which node to blame if it all goes Pete Tong + this.used = function(xmppThat) { + if (RED.settings.verbose || LOGITALL) {that.log(xmppThat.id+" sent a message to the xmpp server"); } + that.lastUsed = xmppThat; + } + + + // Some errors come back as a message :-( + // this means we need to figure out which node might have sent it + // we also deal with subscriptions (i.e. presence information) here + this.client.on('stanza', async (stanza) =>{ + if (stanza.is('message')) { + if (stanza.attrs.type == 'error') { + if (RED.settings.verbose || LOGITALL) { + that.log("Received error"); + that.log(stanza); + } + var err = stanza.getChild('error'); + if (err) { + var textObj = err.getChild('text'); + var text = "node-red:common.status.error"; + if ("undefined" !== typeof textObj) { + text = textObj.getText(); + } + else{ + textObj = err.getChild('code'); + if ("undefined" !== typeof textObj) { + text = textObj.getText(); + } + } + if (RED.settings.verbose || LOGITALL) {that.log("Culprit: "+that.lastUsed); } + if ("undefined" !== typeof that.lastUsed) { + that.lastUsed.status({fill:"red",shape:"ring",text:text}); + that.lastUsed.warn(text); + } + if (RED.settings.verbose || LOGITALL) { + that.log("We did wrong: "+text); + that.log(stanza); + } + + // maybe throw the message or summit + //that.error(text); + } + } + } + else if (stanza.is('presence')) { + if (['subscribe','subscribed','unsubscribe','unsubscribed'].indexOf(stanza.attrs.type) > -1) { + if (RED.settings.verbose || LOGITALL) {that.log("got a subscription based message"); } + switch(stanza.attrs.type) { + case 'subscribe': + // they're asking for permission let's just say yes + var response = xml('presence', + {type:'subscribed', to:stanza.attrs.from}); + // if an error comes back we can't really blame anyone else + that.used(that); + that.client.send(response); + break; + default: + that.log("Was told we've "+stanza.attrs.type+" from "+stanza.attrs.from+" but we don't really care"); + } + } + } + else if (stanza.is('iq')) { + if (RED.settings.verbose || LOGITALL) {that.log("got an iq query"); } + if (stanza.attrs.type === 'error') { + if (RED.settings.verbose || LOGITALL) {that.log("oh noes, it's an error"); } + if (stanza.attrs.id === that.lastUsed.id) { + that.lastUsed.status({fill:"red", shape:"ring", text:stanza.getChild('error')}); + that.lastUsed.warn(stanza.getChild('error')); + } + } + else if (stanza.attrs.type === 'result') { + // AM To-Do check for 'bind' result with our current jid + var query = stanza.getChild('query'); + if (RED.settings.verbose || LOGITALL) {that.log("result!"); } + if (RED.settings.verbose || LOGITALL) {that.log(query); } + + } + } + }); + + + // We shouldn't have any errors here that the input/output nodes can't handle + // if you need to see everything though; uncomment this block + // this.client.on('error', err => { + // that.warn(err); + // that.warn(err.stack); + // }); + + // this gets called when we've completed the connection + this.client.on('online', async address => { + // provide some presence so people can see we're online + that.connected = true; + await that.client.send(xml('presence')); + // await that.client.send(xml('presence', {type: 'available'},xml('status', {}, 'available'))); + if (RED.settings.verbose || LOGITALL) {that.log('connected as '+that.username+' to ' +that.server+':'+that.port); } + }); + + // if the connection has gone away, not sure why! + this.client.on('offline', () => { + that.connected = false; + if (RED.settings.verbose || LOGITALL) {that.log('connection closed'); } + }); + + // gets called when the node is destroyed, e.g. if N-R is being stopped. + this.on("close", async done => { + if (that.client.connected) { + await that.client.send(xml('presence', {type: 'unavailable'})); + try{ + if (RED.settings.verbose || LOGITALL) { + that.log("Calling stop() after close, status is "+that.client.status); + } + await that.client.stop().then(that.log("XMPP client stopped")).catch(error=>{that.warn("Got an error whilst closing xmpp session: "+error)}); + } + catch(e) { + that.warn(e); + } + } + done(); + }); } RED.nodes.registerType("xmpp-server",XMPPServerNode,{ credentials: { - user: {type:"text"}, password: {type: "password"} } }); @@ -25,199 +214,401 @@ module.exports = function(RED) { function XmppInNode(n) { RED.nodes.createNode(this,n); this.server = n.server; - this.serverConfig = RED.nodes.getNode(this.server); - this.host = this.serverConfig.server; - this.port = this.serverConfig.port; - this.nick = this.serverConfig.nickname || "Node-RED"; - this.userid = this.serverConfig.username; - this.password = this.serverConfig.password; - + this.nick = this.serverConfig.nickname || this.serverConfig.username.split("@")[0]; this.join = n.join || false; this.sendAll = n.sendObject; - this.to = n.to || ""; + // Yes, it's called "from", don't ask me why; I don't know why + this.from = n.to || ""; var node = this; - var xmpp = new XMPP.SimpleXMPP(); + var xmpp = this.serverConfig.client; - xmpp.on('online', function(data) { - node.log('connected to '+node.host+":"+node.port); - node.status({fill:"green",shape:"dot",text:"connected"}); - //xmpp.setPresence('online', node.nick+' online'); - if (node.join) { - xmpp.join(node.to+'/'+node.nick); + /* connection states + online: We are connected + offline: disconnected and will not autoretry + connecting: Socket is connecting + connect: Socket is connected + opening: Stream is opening + open: Stream is open + closing: Stream is closing + close: Stream is closed + disconnecting: Socket is disconnecting + disconnect: Socket is disconnected + */ + + xmpp.on('online', async address => { + node.status({fill:"green",shape:"dot",text:"node-red:common.status.connected"}); + if ((node.join) && (node.from !== "")) { + var to = node.from+'/'+node.nick; + // the presence with the muc x element signifies we want to join the muc + // if we want to support passwords, we need to add that as a child of the x element + // (third argument to the x/muc/children ) + // We also turn off chat history (maxstanzas 0) because that's not what this node is about. + var stanza = xml('presence', + {"to": to}, + xml("x",'http://jabber.org/protocol/muc'), + { maxstanzas:0, seconds:1 } + ); + node.serverConfig.used(node); + xmpp.send(stanza).catch(error => {node.warn("Got error when sending presence: "+error)}); } }); - xmpp.on('chat', function(from, message) { - var msg = { topic:from, payload:message }; - node.send([msg,null]); + xmpp.on('connecting', async address => { + node.status({fill:"grey",shape:"dot",text:"node-red:common.status.connecting"}); }); - - xmpp.on('groupchat', function(conference, from, message, stamp) { - var msg = { topic:from, payload:message, room:conference, ts:stamp }; - if (from != node.nick) { node.send([msg,null]); } + xmpp.on('connect', async address => { + node.status({fill:"grey",shape:"dot",text:"node-red:common.status.connected"}); }); - - //xmpp.on('chatstate', function(from, state) { - //console.log('%s is currently %s', from, state); - //var msg = { topic:from, payload:state }; - //node.send([null,msg]); - //}); - - xmpp.on('buddy', function(jid, state, statusText) { - node.log(jid+" is "+state+" : "+statusText); - var msg = { topic:jid, payload: { presence:state, status:statusText} }; - node.send([null,msg]); + xmpp.on('opening', async address => { + node.status({fill:"grey",shape:"dot",text:"opening"}); }); + xmpp.on('open', async address => { + node.status({fill:"grey",shape:"dot",text:"open"}); + }); + xmpp.on('closing', async address => { + node.status({fill:"grey",shape:"dot",text:"closing"}); + }); + xmpp.on('close', async address => { + node.status({fill:"grey",shape:"dot",text:"closed"}); + }); + xmpp.on('disconnecting', async address => { + node.status({fill:"grey",shape:"dot",text:"disconnecting"}); + }); + // we'll not add a offline catcher, as the error catcher should populate the status for us - xmpp.on('error', function(err) { - if (RED.settings.verbose) { node.log(err); } + // Should we listen on other's status (chatstate) or a chatroom state (groupbuddy)? + xmpp.on('error', err => { + if (RED.settings.verbose || LOGITALL) { node.log("XMPP Error: "+err); } if (err.hasOwnProperty("stanza")) { if (err.stanza.name === 'stream:error') { node.error("stream:error - bad login id/pwd ?",err); } else { node.error(err.stanza.name,err); } + node.status({fill:"red",shape:"ring",text:"bad login"}); } else { - if (err.errno === "ETIMEDOUT") { node.error("Timeout connecting to server",err); } - else { node.error(err.errno,err); } + if (err.errno === "ETIMEDOUT") { + node.error("Timeout connecting to server",err); + node.status({fill:"red",shape:"ring",text:"timeout"}); + } + if (err.errno === "ENOTFOUND") { + node.error("Server doesn't exist "+xmpp.options.service,err); + node.status({fill:"red",shape:"ring",text:"bad address"}); + } + else if (err === "XMPP authentication failure") { + node.error("Authentication failure! "+err,err); + node.status({fill:"red",shape:"ring",text:"XMPP authentication failure"}); + } + else if (err.name === "SASLError") { + node.error("Authorization error! "+err.condition,err); + node.status({fill:"red",shape:"ring",text:"XMPP authorization failure"}); + } + else if (err == "TimeoutError") { + // Suppress it! + node.warn("Timed out! "); + node.status({fill:"grey",shape:"dot",text:"opening"}); + //node.status({fill:"red",shape:"ring",text:"XMPP timeout"}); + } + else { + node.error(err,err); + node.status({fill:"red",shape:"ring",text:"node-red:common.status.error"}); + } } - node.status({fill:"red",shape:"ring",text:"error"}); }); - xmpp.on('close', function() { - node.log('connection closed'); - //node.status({fill:"grey",shape:"ring",text:"not connected"}); + // Meat of it, a stanza object contains chat messages (and other things) + xmpp.on('stanza', async (stanza) =>{ + // node.log("Received stanza"); + if (RED.settings.verbose || LOGITALL) {node.log(stanza); } + if (stanza.is('message')) { + if (stanza.attrs.type == 'chat') { + var body = stanza.getChild('body'); + if (body) { + var msg = { payload:body.getText() }; + var ids = stanza.attrs.from.split('/'); + if (ids[1].length !== 36) { + msg.topic = stanza.attrs.from + } + else { msg.topic = ids[0]; } + // if (RED.settings.verbose || LOGITALL) {node.log("Received a message from "+stanza.attrs.from); } + if (!node.join && ((node.from === "") || (node.from === stanza.attrs.to))) { + node.send([msg,null]); + } + } + } + else if (stanza.attrs.type == 'groupchat') { + const parts = stanza.attrs.from.split("/"); + var conference = parts[0]; + var from = parts[1]; + var body = stanza.getChild('body'); + var payload = ""; + if ("undefined" !== typeof body) { + payload = body.getText(); + } + var msg = { topic:from, payload:payload, room:conference }; + if (stanza.attrs.from != node.nick) { + if ((node.join) && (node.from === conference)) { + node.send([msg,null]); + } + } + } + } + else if (stanza.is('presence')) { + if (['subscribe','subscribed','unsubscribe','unsubscribed'].indexOf(stanza.attrs.type) > -1) { + // this isn't for us, let the config node deal with it. + + } + else{ + var statusText=""; + if (stanza.attrs.type === 'unavailable') { + // the user might not exist, but the server doesn't tell us that! + statusText = "offline"; + } + var status = stanza.getChild('status'); + if ("undefined" !== typeof status) { + statusText = status.getText(); + } + // right, do we care if there's no status? + if (statusText !== "") { + var from = stanza.attrs.from; + var state = stanza.attrs.show; + var msg = {topic:from, payload: {presence:state, status:statusText} }; + node.send([null,msg]); + } + else{ + if (RED.settings.verbose || LOGITALL) { + node.log("not propagating blank status"); + node.log(stanza); + } + } + } + } }); - xmpp.on('subscribe', function(from) { - xmpp.acceptSubscription(from); - }); + // xmpp.on('subscribe', from => { + // xmpp.acceptSubscription(from); + // }); + //register with config + this.serverConfig.register(this); // Now actually make the connection try { - node.status({fill:"grey",shape:"dot",text:"connecting"}); - xmpp.connect({ - jid : node.userid, - password : node.password, - host : node.host, - port : node.port, - skipPresence : true, - reconnect : false - }); + if (xmpp.status === "online") { + node.status({fill:"green",shape:"dot",text:"node-red:common.status.connected"}); + } + else{ + node.status({fill:"grey",shape:"dot",text:"node-red:common.status.connecting"}); + if (xmpp.status === "offline") { + if (RED.settings.verbose || LOGITALL) { + node.log("starting xmpp client"); + } + xmpp.start().catch(error => {node.warn("Got error on start: "+error); node.warn("XMPP Status is now: "+xmpp.status)}); + } + } } catch(e) { - node.error("Bad xmpp configuration"); - node.status({fill:"red",shape:"ring",text:"not connected"}); + node.error("Bad xmpp configuration; service: "+xmpp.options.service+" jid: "+node.serverConfig.jid); + node.warn(e); + node.warn(e.stack); + node.status({fill:"red",shape:"ring",text:"node-red:common.status.disconnected"}); } - node.on("close", function(done) { - xmpp.setPresence('offline'); - xmpp.disconnect(); - if (xmpp.conn) { xmpp.conn.end(); } - xmpp = null; - node.status({}); - done(); + node.on("close", function(removed, done) { + node.status({fill:"red",shape:"ring",text:"node-red:common.status.disconnected"}); + node.serverConfig.deregister(node, done); }); } RED.nodes.registerType("xmpp in",XmppInNode); + function XmppOutNode(n) { RED.nodes.createNode(this,n); this.server = n.server; - this.serverConfig = RED.nodes.getNode(this.server); - this.host = this.serverConfig.server; - this.port = this.serverConfig.port; - this.nick = this.serverConfig.nickname || "Node-RED"; - this.userid = this.serverConfig.username; - this.password = this.serverConfig.password; - + this.nick = this.serverConfig.nickname || this.serverConfig.username.split("@")[0]; this.join = n.join || false; this.sendAll = n.sendObject; this.to = n.to || ""; var node = this; - var xmpp = new XMPP.SimpleXMPP(); + var xmpp = this.serverConfig.client; + + /* connection states + online: We are connected + offline: disconnected and will not autoretry + connecting: Socket is connecting + connect: Socket is connected + opening: Stream is opening + open: Stream is open + closing: Stream is closing + close: Stream is closed + disconnecting: Socket is disconnecting + disconnect: Socket is disconnected + */ xmpp.on('online', function(data) { - node.status({fill:"green",shape:"dot",text:"connected"}); - node.log('connected to '+node.host+":"+node.port); - xmpp.setPresence('online', node.nick+' online'); - if (node.join) { - xmpp.join(node.to+'/'+node.nick); + node.status({fill:"green",shape:"dot",text:"node-red:common.status.connected"}); + if ((node.join) && (node.to !== "")) { + // disable chat history + var to = node.to+'/'+node.nick; + // the presence with the muc x element signifies we want to join the muc + // if we want to support passwords, we need to add that as a child of the x element + // (third argument to the x/muc/children ) + // We also turn off chat history (maxstanzas 0) because that's not what this node is about. + var stanza = xml('presence', + {"to": to}, + xml("x",'http://jabber.org/protocol/muc'), + { maxstanzas:0, seconds:1 } + ); + node.serverConfig.used(node); + xmpp.send(stanza); } }); + xmpp.on('connecting', async address => { + node.status({fill:"grey",shape:"dot",text:"node-red:common.status.connecting"}); + }); + xmpp.on('connect', async address => { + node.status({fill:"grey",shape:"dot",text:"node-red:common.status.connected"}); + }); + xmpp.on('opening', async address => { + node.status({fill:"grey",shape:"dot",text:"opening"}); + }); + xmpp.on('open', async address => { + node.status({fill:"grey",shape:"dot",text:"open"}); + }); + xmpp.on('closing', async address => { + node.status({fill:"grey",shape:"dot",text:"closing"}); + }); + xmpp.on('close', async address => { + node.status({fill:"grey",shape:"dot",text:"closed"}); + }); + xmpp.on('disconnecting', async address => { + node.status({fill:"grey",shape:"dot",text:"disconnecting"}); + }); + // we'll not add a offline catcher, as the error catcher should populate the status for us + xmpp.on('error', function(err) { - if (RED.settings.verbose) { node.log(err); } + if (RED.settings.verbose || LOGITALL) { node.log(err); } if (err.hasOwnProperty("stanza")) { if (err.stanza.name === 'stream:error') { node.error("stream:error - bad login id/pwd ?",err); } else { node.error(err.stanza.name,err); } + node.status({fill:"red",shape:"ring",text:"bad login"}); } else { - if (err.errno === "ETIMEDOUT") { node.error("Timeout connecting to server",err); } - else { node.error(err.errno,err); } + if (err.errno === "ETIMEDOUT") { + node.error("Timeout connecting to server",err); + node.status({fill:"red",shape:"ring",text:"timeout"}); + } + else if (err.errno === "ENOTFOUND") { + node.error("Server doesn't exist "+xmpp.options.service,err); + node.status({fill:"red",shape:"ring",text:"bad address"}); + } + else if (err === "XMPP authentication failure") { + node.error(err,err); + node.status({fill:"red",shape:"ring",text:"XMPP authentication failure"}); + } + else if (err == "TimeoutError") { + // OK, this happens with OpenFire, suppress it. + node.status({fill:"grey",shape:"dot",text:"opening"}); + node.log("Timed out! ",err); + // node.status({fill:"red",shape:"ring",text:"XMPP timeout"}); + } + else { + node.error("Unknown error: "+err,err); + node.status({fill:"red",shape:"ring",text:"node-red:common.status.error"}); + } } - node.status({fill:"red",shape:"ring",text:"error"}); - }); - - xmpp.on('close', function() { - node.log('connection closed'); - //node.status({fill:"grey",shape:"ring",text:"not connected"}); - }); - - xmpp.on('subscribe', function(from) { - xmpp.acceptSubscription(from); }); + //register with config + this.serverConfig.register(this); // Now actually make the connection - try { - node.status({fill:"grey",shape:"dot",text:"connecting"}); - xmpp.connect({ - jid : node.userid, - password : node.password, - host : node.host, - port : node.port, - skipPresence : true, - reconnect : false - }); + if (xmpp.status === "online") { + node.status({fill:"green",shape:"dot",text:"online"}); } - catch(e) { - node.error("Bad xmpp configuration"); - node.status({fill:"red",shape:"ring",text:"not connected"}); + else{ + node.status({fill:"grey",shape:"dot",text:"node-red:common.status.connecting"}); + if (xmpp.status === "offline") { + xmpp.start().catch(error => { + node.error("Bad xmpp configuration; service: "+xmpp.options.service+" jid: "+node.serverConfig.jid); + node.warn(error); + node.warn(error.stack); + node.status({fill:"red",shape:"ring",text:"node-red:common.status.error"}); + }); + } } + // Let's get down to business and actually send a message node.on("input", function(msg) { if (msg.presence) { - if (['away', 'dnd', 'xa','chat'].indexOf(msg.presence) > -1 ) { - xmpp.setPresence(msg.presence, msg.payload); + if (['away', 'dnd', 'xa', 'chat'].indexOf(msg.presence) > -1 ) { + var stanza = xml('presence', + {"show":msg.presence}, + xml('status',{},msg.payload)); + node.serverConfig.used(node); + xmpp.send(stanza); } - else { node.warn("Can't set presence - invalid value"); } + else { node.warn("Can't set presence - invalid value: "+msg.presence); } + } + else if (msg.command) { + if (msg.command === "subscribe") { + var stanza = xml('presence', + {type:'subscribe', to: msg.payload}); + node.serverConfig.used(node); + xmpp.send(stanza); + } + else if (msg.command === "get") { + var to = node.to || msg.topic || ""; + var stanza = xml('iq', + {type:'get', id:node.id, to: to}, + xml('query', 'http://jabber.org/protocol/muc#admin', + xml('item',{affiliation:msg.payload}))); + node.serverConfig.used(node); + if (RED.settings.verbose || LOGITALL) {node.log("sending stanza "+stanza.toString()); } + xmpp.send(stanza); + } + } else { - var to = msg.topic; - if (node.to !== "") { to = node.to; } - if (node.sendAll) { - xmpp.send(to, JSON.stringify(msg), node.join); - } - else if (msg.payload) { - if (typeof(msg.payload) === "object") { - xmpp.send(to, JSON.stringify(msg.payload), node.join); + var to = node.to || msg.topic || ""; + if (to !== "") { + var message; + var type = node.join? "groupchat":"chat"; + if (node.sendAll) { + message = xml( + "message", + { type: type, to: to }, + xml("body", {}, JSON.stringify(msg)) + ); + } - else { - xmpp.send(to, msg.payload.toString(), node.join); + else if (msg.payload) { + if (typeof(msg.payload) === "object") { + message = xml( + "message", + { type: type, to: to }, + xml("body", {}, JSON.stringify(msg.payload)) + ); + } + else { + message = xml( + "message", + { type: type, to: to }, + xml("body", {}, msg.payload.toString()) + ); + } } + node.serverConfig.used(node); + xmpp.send(message); } } }); - node.on("close", function(done) { - xmpp.setPresence('offline'); - xmpp.disconnect(); - if (xmpp.conn) { xmpp.conn.end(); } - xmpp = null; - node.status({}); - done(); + node.on("close", function(removed, done) { + if (RED.settings.verbose || LOGITALL) {node.log("Closing"); } + node.status({fill:"red",shape:"ring",text:"node-red:common.status.disconnected"}); + node.serverConfig.deregister(node, done); }); } RED.nodes.registerType("xmpp out",XmppOutNode); diff --git a/social/xmpp/package.json b/social/xmpp/package.json index 9b72311e..44381f89 100644 --- a/social/xmpp/package.json +++ b/social/xmpp/package.json @@ -1,18 +1,21 @@ { - "name" : "node-red-node-xmpp", - "version" : "0.1.6", - "description" : "A Node-RED node to talk to an XMPP server", - "dependencies" : { - "simple-xmpp" : "1.3.*" + "name": "node-red-node-xmpp", + "version": "0.3.1", + "description": "A Node-RED node to talk to an XMPP server", + "dependencies": { + "@xmpp/client": "^0.11.1" }, - "repository" : { - "type":"git", - "url":"https://github.com/node-red/node-red-nodes/tree/master/social/xmpp" + "repository": { + "type": "git", + "url": "https://github.com/node-red/node-red-nodes/tree/master/social/xmpp" }, "license": "Apache-2.0", - "keywords": [ "node-red", "xmpp" ], - "node-red" : { - "nodes" : { + "keywords": [ + "node-red", + "xmpp" + ], + "node-red": { + "nodes": { "xmpp": "92-xmpp.js" } }, diff --git a/storage/leveldb/67-leveldb.html b/storage/leveldb/67-leveldb.html index 964443f7..60b75414 100644 --- a/storage/leveldb/67-leveldb.html +++ b/storage/leveldb/67-leveldb.html @@ -1,16 +1,26 @@ - - - - - + - - - - + - - + + diff --git a/storage/sqlite/locales/en-US/sqlite.json b/storage/sqlite/locales/en-US/sqlite.json new file mode 100644 index 00000000..059f1194 --- /dev/null +++ b/storage/sqlite/locales/en-US/sqlite.json @@ -0,0 +1,20 @@ +{ + "sqlite": { + "label": { + "database": "Database", + "sqlQuery": "SQL Query", + "viaMsgTopic": "Via msg.topic", + "fixedStatement": "Fixed Statement", + "preparedStatement": "Prepared Statement", + "batchWithoutResponse": "Batch without response", + "sqlStatement": "SQL Statement", + "mode": "Mode", + "readWriteCreate": "Read-Write-Create", + "readWrite": "Read-Write", + "readOnly": "Read-Only" + }, + "tips": { + "memoryDb": "Note: Setting the database name to :memory: will create a non-persistant in memory database." + } + } +} diff --git a/storage/sqlite/locales/ja/sqlite.html b/storage/sqlite/locales/ja/sqlite.html new file mode 100644 index 00000000..5c6e8da1 --- /dev/null +++ b/storage/sqlite/locales/ja/sqlite.html @@ -0,0 +1,26 @@ + + + diff --git a/storage/sqlite/locales/ja/sqlite.json b/storage/sqlite/locales/ja/sqlite.json new file mode 100644 index 00000000..dda91077 --- /dev/null +++ b/storage/sqlite/locales/ja/sqlite.json @@ -0,0 +1,20 @@ +{ + "sqlite": { + "label": { + "database": "データベース", + "sqlQuery": "SQLクエリ", + "viaMsgTopic": "msg.topic経由", + "fixedStatement": "固定文", + "preparedStatement": "事前定義文", + "batchWithoutResponse": "一括(応答なし)", + "sqlStatement": "SQL文", + "mode": "モード", + "readWriteCreate": "読み取り-書き込み-作成", + "readWrite": "読み取り-書き込み", + "readOnly": "読み取りのみ" + }, + "tips": { + "memoryDb": "注釈: データベース名に :memory: を設定すると、非永続的なメモリデータベースを作成します。" + } + } +} diff --git a/storage/sqlite/package.json b/storage/sqlite/package.json index d63dfa62..ed646689 100644 --- a/storage/sqlite/package.json +++ b/storage/sqlite/package.json @@ -1,18 +1,21 @@ { - "name" : "node-red-node-sqlite", - "version" : "0.1.2", - "description" : "A sqlite node for Node-RED", - "dependencies" : { - "sqlite3" : "3.1.*" + "name": "node-red-node-sqlite", + "version": "0.4.4", + "description": "A sqlite node for Node-RED", + "dependencies": { + "sqlite3": "~4.2.0" }, - "repository" : { - "type":"git", - "url":"https://github.com/node-red/node-red-nodes/storage/sqlite/" + "repository": { + "type": "git", + "url": "https://github.com/node-red/node-red-nodes/tree/master/storage/sqlite" }, "license": "Apache-2.0", - "keywords": [ "node-red", "sqlite" ], - "node-red" : { - "nodes" : { + "keywords": [ + "node-red", + "sqlite" + ], + "node-red": { + "nodes": { "sqlite": "sqlite.js" } }, diff --git a/storage/sqlite/sqlite.html b/storage/sqlite/sqlite.html index e091023f..faca8ab7 100644 --- a/storage/sqlite/sqlite.html +++ b/storage/sqlite/sqlite.html @@ -1,16 +1,25 @@ - - - - - - diff --git a/storage/sqlite/sqlite.js b/storage/sqlite/sqlite.js index 41936fd5..ed2a0807 100644 --- a/storage/sqlite/sqlite.js +++ b/storage/sqlite/sqlite.js @@ -1,4 +1,3 @@ - module.exports = function(RED) { "use strict"; var reconnect = RED.settings.sqliteReconnectTime || 20000; @@ -8,10 +7,15 @@ module.exports = function(RED) { RED.nodes.createNode(this,n); this.dbname = n.db; + this.mod = n.mode; + if (n.mode === "RWC") { this.mode = sqlite3.OPEN_READWRITE | sqlite3.OPEN_CREATE; } + if (n.mode === "RW") { this.mode = sqlite3.OPEN_READWRITE; } + if (n.mode === "RO") { this.mode = sqlite3.OPEN_READONLY; } var node = this; node.doConnect = function() { - node.db = new sqlite3.Database(node.dbname); + if (node.db) { return; } + node.db = new sqlite3.Database(node.dbname,node.mode); node.db.on('open', function() { if (node.tick) { clearTimeout(node.tick); } node.log("opened "+node.dbname+" ok"); @@ -22,9 +26,10 @@ module.exports = function(RED) { }); } - node.on('close', function () { + node.on('close', function (done) { if (node.tick) { clearTimeout(node.tick); } - if (node.db) { node.db.close(); } + if (node.db) { node.db.close(done()); } + else { done(); } }); } RED.nodes.registerType("sqlitedb",SqliteNodeDB); @@ -33,32 +38,113 @@ module.exports = function(RED) { function SqliteNodeIn(n) { RED.nodes.createNode(this,n); this.mydb = n.mydb; + this.sqlquery = n.sqlquery||"msg.topic"; + this.sql = n.sql; this.mydbConfig = RED.nodes.getNode(this.mydb); + var node = this; + node.status({}); - if (this.mydbConfig) { - this.mydbConfig.doConnect(); - var node = this; - node.on("input", function(msg) { - if (typeof msg.topic === 'string') { - //console.log("query:",msg.topic); - var bind = Array.isArray(msg.payload) ? msg.payload : []; - node.mydbConfig.db.all(msg.topic, bind, function(err, row) { - if (err) { node.error(err,msg); } - else { - msg.payload = row; - node.send(msg); + if (node.mydbConfig) { + node.mydbConfig.doConnect(); + node.status({fill:"green",shape:"dot",text:this.mydbConfig.mod}); + var bind = []; + + var doQuery = function(msg) { + if (node.sqlquery == "msg.topic") { + if (typeof msg.topic === 'string') { + if (msg.topic.length > 0) { + bind = Array.isArray(msg.payload) ? msg.payload : []; + node.mydbConfig.db.all(msg.topic, bind, function(err, row) { + if (err) { node.error(err,msg); } + else { + msg.payload = row; + node.send(msg); + } + }); } - }); - } - else { - if (typeof msg.topic !== 'string') { + } + else { node.error("msg.topic : the query is not defined as a string",msg); + node.status({fill:"red",shape:"dot",text:"msg.topic error"}); } } + if (node.sqlquery == "batch") { + if (typeof msg.topic === 'string') { + if (msg.topic.length > 0) { + node.mydbConfig.db.exec(msg.topic, function(err) { + if (err) { node.error(err,msg);} + else { + msg.payload = []; + node.send(msg); + } + }); + } + } + else { + node.error("msg.topic : the query is not defined as string", msg); + node.status({fill:"red", shape:"dot",text:"msg.topic error"}); + } + } + if (node.sqlquery == "fixed") { + if (typeof node.sql === 'string') { + if (node.sql.length > 0) { + node.mydbConfig.db.all(node.sql, bind, function(err, row) { + if (err) { node.error(err,msg); } + else { + msg.payload = row; + node.send(msg); + } + }); + } + } + else { + if (node.sql === null || node.sql == "") { + node.error("SQL statement config not set up",msg); + node.status({fill:"red",shape:"dot",text:"SQL config not set up"}); + } + } + } + if (node.sqlquery == "prepared") { + if (typeof node.sql === 'string' && typeof msg.params !== "undefined" && typeof msg.params === "object") { + if (node.sql.length > 0) { + node.mydbConfig.db.all(node.sql, msg.params, function(err, row) { + if (err) { node.error(err,msg); } + else { + msg.payload = row; + node.send(msg); + } + }); + } + } + else { + if (node.sql === null || node.sql == "") { + node.error("Prepared statement config not set up",msg); + node.status({fill:"red",shape:"dot",text:"Prepared statement not set up"}); + } + if (typeof msg.params == "undefined") { + node.error("msg.params not passed"); + node.status({fill:"red",shape:"dot",text:"msg.params not defined"}); + } + else if (typeof msg.params != "object") { + node.error("msg.params not an object"); + node.status({fill:"red",shape:"dot",text:"msg.params not an object"}); + } + } + } + } + + node.on("input", function(msg) { + if (msg.hasOwnProperty("extension")) { + node.mydbConfig.db.loadExtension(msg.extension, function(err) { + if (err) { node.error(err,msg); } + else { doQuery(msg); } + }); + } + else { doQuery(msg); } }); } else { - this.error("Sqlite database not configured"); + node.error("Sqlite database not configured"); } } RED.nodes.registerType("sqlite",SqliteNodeIn); diff --git a/storage/tail/28-tail.html b/storage/tail/28-tail.html new file mode 100644 index 00000000..4f7c2063 --- /dev/null +++ b/storage/tail/28-tail.html @@ -0,0 +1,58 @@ + + + diff --git a/storage/tail/28-tail.js b/storage/tail/28-tail.js new file mode 100644 index 00000000..aa44bbcf --- /dev/null +++ b/storage/tail/28-tail.js @@ -0,0 +1,80 @@ + +module.exports = function(RED) { + "use strict"; + var fs = require('fs'); + var Tail = require('tail').Tail; + + function TailNode(n) { + RED.nodes.createNode(this,n); + + this.filename = n.filename || ""; + this.filetype = n.filetype || "text"; + this.split = new RegExp(n.split.replace(/\\r/g,'\r').replace(/\\n/g,'\n').replace(/\\t/g,'\t') || "[\r]{0,1}\n"); + var node = this; + + var fileTail = function() { + if (fs.existsSync(node.filename)) { + if (node.filetype === "text") { + node.tail = new Tail(node.filename,{separator:node.split, flushAtEOF:true}); + } + else { + node.tail = new Tail(node.filename,{separator:null, flushAtEOF:true, encoding:"binary"}); + } + + node.tail.on("line", function(data) { + if (data.length > 0) { + var msg = { topic:node.filename }; + if (node.filetype === "text") { + msg.payload = data.toString(); + node.send(msg); + } + else { + msg.payload = Buffer.from(data,"binary"); + node.send(msg); + } + } + }); + + node.tail.on("error", function(err) { + node.status({ fill: "red",shape:"ring", text: "node-red:common.status.error" }); + node.error(err.toString()); + }); + } + else { + node.tout = setTimeout(function() { fileTail(); },10000); + node.warn(RED._("tail.errors.filenotfound") + ": "+node.filename); + } + } + + if (node.filename !== "") { + node.status({}); + fileTail(); + } else { + node.status({ fill: "grey", text: "tail.state.stopped" }); + node.on('input', function (msg) { + if (!msg.hasOwnProperty("filename")) { + node.error(RED._("tail.state.nofilename")); + } else if (msg.filename === "") { + node.filename = ""; + if (node.tail) { node.tail.unwatch(); } + if (node.tout) { clearTimeout(node.tout); } + node.status({ fill: "grey", text: "tail.state.stopped" }); + } else { + node.filename = msg.filename; + if (node.tail) { node.tail.unwatch(); } + if (!node.tout) { fileTail(); } + node.status({ fill: "green", text: node.filename }); + } + }); + } + + node.on("close", function() { + /* istanbul ignore else */ + if (node.tail) { node.tail.unwatch(); } + delete node.tail; + if (node.tout) { clearTimeout(node.tout); } + }); + } + + RED.nodes.registerType("tail",TailNode); +} diff --git a/storage/tail/LICENSE b/storage/tail/LICENSE new file mode 100644 index 00000000..f5b60114 --- /dev/null +++ b/storage/tail/LICENSE @@ -0,0 +1,14 @@ +Copyright 2016 JS Foundation and other contributors, https://js.foundation/ +Copyright 2013-2016 IBM Corp. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/storage/tail/README.md b/storage/tail/README.md new file mode 100644 index 00000000..e6c9a935 --- /dev/null +++ b/storage/tail/README.md @@ -0,0 +1,17 @@ +node-red-node-tail +================== + +A Node-Red node to tail a file and inject the contents into the flow. + +Install +------- + +Either use the Menu - Manage palette option, or run the following command in your Node-RED user directory - typically `~/.node-red` + + npm install node-red-node-tail + + +Usage +----- + +Allows diff --git a/storage/tail/locales/en-US/28-tail.html b/storage/tail/locales/en-US/28-tail.html new file mode 100644 index 00000000..25633430 --- /dev/null +++ b/storage/tail/locales/en-US/28-tail.html @@ -0,0 +1,15 @@ + diff --git a/storage/tail/locales/en-US/28-tail.json b/storage/tail/locales/en-US/28-tail.json new file mode 100644 index 00000000..3a7ebb4f --- /dev/null +++ b/storage/tail/locales/en-US/28-tail.json @@ -0,0 +1,24 @@ +{ + "tail": { + "tail": "tail", + "label": { + "filename": "Filename", + "type": "File type", + "splitlines": "Split on", + "name": "Name", + "regex": "split character or regex" + }, + "action": { + "text": "Text - returns String", + "binary": "Binary - returns Buffer" + }, + "errors": { + "windowsnotsupport": "Not currently supported on Windows.", + "filenotfound": "File not found" + }, + "state":{ + "stopped": "stopped", + "nofilename":"Missing filename on input" + } + } +} diff --git a/storage/tail/locales/ja/28-tail.html b/storage/tail/locales/ja/28-tail.html new file mode 100644 index 00000000..a45df5c9 --- /dev/null +++ b/storage/tail/locales/ja/28-tail.html @@ -0,0 +1,25 @@ + + + diff --git a/storage/tail/locales/ja/28-tail.json b/storage/tail/locales/ja/28-tail.json new file mode 100644 index 00000000..3084f489 --- /dev/null +++ b/storage/tail/locales/ja/28-tail.json @@ -0,0 +1,24 @@ +{ + "tail": { + "tail": "tail", + "label": { + "filename": "ファイル名", + "type": "ファイル形式", + "splitlines": "改行でメッセージを分割", + "name": "名前", + "regex": "正規表現を使用" + }, + "action": { + "text": "文字列", + "binary": "バイナリバッファ" + }, + "errors": { + "windowsnotsupport": "現在Windows上での動作は対応していません", + "filenotfound": "ファイルが見つかりませんでした" + }, + "state":{ + "stopped": "停止", + "nofilename":"ファイル名の指定がありません" + } + } +} diff --git a/storage/tail/locales/zh-CN/28-tail.json b/storage/tail/locales/zh-CN/28-tail.json new file mode 100644 index 00000000..5a22c610 --- /dev/null +++ b/storage/tail/locales/zh-CN/28-tail.json @@ -0,0 +1,17 @@ +{ + "tail": { + "tail": "tail", + "label": { + "filename": "文件名", + "type": "文件类型", + "splitlines": "以\\n来拆分行?" + }, + "action": { + "text": "文本 - 返回字符串", + "binary": "二进制 - 返回Buffer" + }, + "errors": { + "windowsnotsupport": "Windows目前不支持." + } + } +} diff --git a/storage/tail/package.json b/storage/tail/package.json new file mode 100644 index 00000000..38a7e4b2 --- /dev/null +++ b/storage/tail/package.json @@ -0,0 +1,27 @@ +{ + "name": "node-red-node-tail", + "version": "0.1.1", + "description": "A node to tail files for Node-RED", + "dependencies": { + "tail": "^2.0.3" + }, + "repository": { + "type": "git", + "url": "https://github.com/node-red/node-red-nodes/storage/tail/" + }, + "license": "Apache-2.0", + "keywords": [ + "node-red", + "tail" + ], + "node-red": { + "nodes": { + "tail": "28-tail.js" + } + }, + "author": { + "name": "Dave Conway-Jones", + "email": "ceejay@vnet.ibm.com", + "url": "http://nodered.org" + } +} diff --git a/test/analysis/mlsentiment/mlsentiment_spec.js b/test/analysis/mlsentiment/mlsentiment_spec.js new file mode 100644 index 00000000..876026c4 --- /dev/null +++ b/test/analysis/mlsentiment/mlsentiment_spec.js @@ -0,0 +1,200 @@ +/** + * Copyright JS Foundation and other contributors, http://js.foundation + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + **/ + +var should = require("should"); +var sentimentNode = require("../../../analysis/mlsentiment/mlsentiment.js"); +var helper = require("node-red-node-test-helper"); + +describe('mlsentiment Node', function() { + + before(function(done) { + helper.startServer(done); + }); + + after(function(done) { + helper.stopServer(done); + }); + + afterEach(function() { + helper.unload(); + }); + + it('should be loaded', function(done) { + var flow = [{id:"sentimentNode1", type:"mlsentiment", name: "sentimentNode" }]; + helper.load(sentimentNode, flow, function() { + var sentimentNode1 = helper.getNode("sentimentNode1"); + sentimentNode1.should.have.property('name', 'sentimentNode'); + done(); + }); + }); + + it('should pass on msg if no payload', function(done) { + var flow = [{id:"jn1",type:"mlsentiment",wires:[["jn2"]]}, + {id:"jn2", type:"helper"}]; + helper.load(sentimentNode, flow, function() { + var jn1 = helper.getNode("jn1"); + var jn2 = helper.getNode("jn2"); + jn2.on("input", function(msg) { + msg.should.not.have.property('sentiment'); + msg.topic.should.equal("pass on"); + done(); + }); + var testString = 'good, great, best, brilliant'; + jn1.receive({topic:"pass on"}); + }); + }); + + it('should add a positive score for good words', function(done) { + var flow = [{id:"jn1",type:"mlsentiment",wires:[["jn2"]]}, + {id:"jn2", type:"helper"}]; + helper.load(sentimentNode, flow, function() { + var jn1 = helper.getNode("jn1"); + var jn2 = helper.getNode("jn2"); + jn2.on("input", function(msg) { + try { + msg.should.have.property('sentiment'); + msg.sentiment.should.have.property('score'); + msg.sentiment.score.should.be.a.Number(); + msg.sentiment.score.should.be.above(10); + done(); + } catch(err) { + done(err); + } + }); + var testString = 'good, great, best, brilliant'; + jn1.receive({payload:testString}); + }); + }); + + it('should add a positive score for good words (in French)', function(done) { + var flow = [{id:"jn1",type:"mlsentiment",wires:[["jn2"]],lang:"fr"}, + {id:"jn2", type:"helper"}]; + helper.load(sentimentNode, flow, function() { + var jn1 = helper.getNode("jn1"); + var jn2 = helper.getNode("jn2"); + jn2.on("input", function(msg) { + try { + msg.should.have.property('sentiment'); + msg.sentiment.should.have.property('score'); + msg.sentiment.score.should.be.a.Number(); + msg.sentiment.score.should.be.above(5); + done(); + } catch(err) { + done(err); + } + }); + var testString = 'bon, belle, don du ciel, brillant'; + jn1.receive({payload:testString}); + }); + }); + + it('should add a positive score for good words - alternative property', function(done) { + var flow = [{id:"jn1",type:"mlsentiment",property:"foo",wires:[["jn2"]]}, + {id:"jn2", type:"helper"}]; + helper.load(sentimentNode, flow, function() { + var jn1 = helper.getNode("jn1"); + var jn2 = helper.getNode("jn2"); + jn2.on("input", function(msg) { + try { + msg.should.have.property('sentiment'); + msg.sentiment.should.have.property('score'); + msg.sentiment.score.should.be.a.Number(); + msg.sentiment.score.should.be.above(10); + done(); + } catch(err) { + done(err); + } + }); + var testString = 'good, great, best, brilliant'; + jn1.receive({foo:testString}); + }); + }); + + it('should add a negative score for bad words', function(done) { + var flow = [{id:"jn1",type:"mlsentiment",wires:[["jn2"]]}, + {id:"jn2", type:"helper"}]; + helper.load(sentimentNode, flow, function() { + var jn1 = helper.getNode("jn1"); + var jn2 = helper.getNode("jn2"); + jn2.on("input", function(msg) { + msg.should.have.property('sentiment'); + msg.sentiment.should.have.property('score'); + msg.sentiment.score.should.be.a.Number(); + msg.sentiment.score.should.be.below(-10); + done(); + }); + var testString = 'bad, horrible, negative, awful'; + jn1.receive({payload:testString}); + }); + }); + + it('should add a negative score for bad words - alternative property', function(done) { + var flow = [{id:"jn1",type:"mlsentiment",property:"foo",wires:[["jn2"]]}, + {id:"jn2", type:"helper"}]; + helper.load(sentimentNode, flow, function() { + var jn1 = helper.getNode("jn1"); + var jn2 = helper.getNode("jn2"); + jn2.on("input", function(msg) { + msg.should.have.property('sentiment'); + msg.sentiment.should.have.property('score'); + msg.sentiment.score.should.be.a.Number(); + msg.sentiment.score.should.be.below(-10); + done(); + }); + var testString = 'bad, horrible, negative, awful'; + jn1.receive({foo:testString}); + }); + }); + + it('should allow you to override word scoring', function(done) { + var flow = [{id:"jn1",type:"mlsentiment",wires:[["jn2"]]}, + {id:"jn2", type:"helper"}]; + helper.load(sentimentNode, flow, function() { + var jn1 = helper.getNode("jn1"); + var jn2 = helper.getNode("jn2"); + jn2.on("input", function(msg) { + msg.should.have.property('sentiment'); + msg.sentiment.should.have.property('score'); + msg.sentiment.score.should.be.a.Number(); + msg.sentiment.score.should.equal(20); + done(); + }); + var testString = 'sick, wicked'; + var overrides = {'sick': 10, 'wicked': 10 }; + jn1.receive({payload:testString,overrides:overrides}); + }); + }); + + it('should allow you to override word scoring - alternative property', function(done) { + var flow = [{id:"jn1",type:"mlsentiment",property:"foo",wires:[["jn2"]]}, + {id:"jn2", type:"helper"}]; + helper.load(sentimentNode, flow, function() { + var jn1 = helper.getNode("jn1"); + var jn2 = helper.getNode("jn2"); + jn2.on("input", function(msg) { + msg.should.have.property('sentiment'); + msg.sentiment.should.have.property('score'); + msg.sentiment.score.should.be.a.Number(); + msg.sentiment.score.should.equal(20); + done(); + }); + var testString = 'sick, wicked'; + var overrides = {'sick': 10, 'wicked': 10 }; + jn1.receive({foo:testString,overrides:overrides}); + }); + }); + +}); diff --git a/test/analysis/sentiment/72-sentiment_spec.js b/test/analysis/sentiment/72-sentiment_spec.js new file mode 100644 index 00000000..5c8adb7c --- /dev/null +++ b/test/analysis/sentiment/72-sentiment_spec.js @@ -0,0 +1,178 @@ +/** + * Copyright JS Foundation and other contributors, http://js.foundation + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + **/ + +var should = require("should"); +var sentimentNode = require("../../../analysis/sentiment/72-sentiment.js"); +var helper = require("node-red-node-test-helper"); + +describe('sentiment Node', function() { + + before(function(done) { + helper.startServer(done); + }); + + after(function(done) { + helper.stopServer(done); + }); + + afterEach(function() { + helper.unload(); + }); + + it('should be loaded', function(done) { + var flow = [{id:"sentimentNode1", type:"sentiment", name: "sentimentNode" }]; + helper.load(sentimentNode, flow, function() { + var sentimentNode1 = helper.getNode("sentimentNode1"); + sentimentNode1.should.have.property('name', 'sentimentNode'); + done(); + }); + }); + + it('should pass on msg if no payload', function(done) { + var flow = [{id:"jn1",type:"sentiment",wires:[["jn2"]]}, + {id:"jn2", type:"helper"}]; + helper.load(sentimentNode, flow, function() { + var jn1 = helper.getNode("jn1"); + var jn2 = helper.getNode("jn2"); + jn2.on("input", function(msg) { + msg.should.not.have.property('sentiment'); + msg.topic.should.equal("pass on"); + done(); + }); + var testString = 'good, great, best, brilliant'; + jn1.receive({topic:"pass on"}); + }); + }); + + it('should add a positive score for good words', function(done) { + var flow = [{id:"jn1",type:"sentiment",wires:[["jn2"]]}, + {id:"jn2", type:"helper"}]; + helper.load(sentimentNode, flow, function() { + var jn1 = helper.getNode("jn1"); + var jn2 = helper.getNode("jn2"); + jn2.on("input", function(msg) { + try { + msg.should.have.property('sentiment'); + msg.sentiment.should.have.property('score'); + msg.sentiment.score.should.be.a.Number(); + msg.sentiment.score.should.be.above(10); + done(); + } catch(err) { + done(err); + } + }); + var testString = 'good, great, best, brilliant'; + jn1.receive({payload:testString}); + }); + }); + + it('should add a positive score for good words - alternative property', function(done) { + var flow = [{id:"jn1",type:"sentiment",property:"foo",wires:[["jn2"]]}, + {id:"jn2", type:"helper"}]; + helper.load(sentimentNode, flow, function() { + var jn1 = helper.getNode("jn1"); + var jn2 = helper.getNode("jn2"); + jn2.on("input", function(msg) { + try { + msg.should.have.property('sentiment'); + msg.sentiment.should.have.property('score'); + msg.sentiment.score.should.be.a.Number(); + msg.sentiment.score.should.be.above(10); + done(); + } catch(err) { + done(err); + } + }); + var testString = 'good, great, best, brilliant'; + jn1.receive({foo:testString}); + }); + }); + + it('should add a negative score for bad words', function(done) { + var flow = [{id:"jn1",type:"sentiment",wires:[["jn2"]]}, + {id:"jn2", type:"helper"}]; + helper.load(sentimentNode, flow, function() { + var jn1 = helper.getNode("jn1"); + var jn2 = helper.getNode("jn2"); + jn2.on("input", function(msg) { + msg.should.have.property('sentiment'); + msg.sentiment.should.have.property('score'); + msg.sentiment.score.should.be.a.Number(); + msg.sentiment.score.should.be.below(-10); + done(); + }); + var testString = 'bad, horrible, negative, awful'; + jn1.receive({payload:testString}); + }); + }); + + it('should add a negative score for bad words - alternative property', function(done) { + var flow = [{id:"jn1",type:"sentiment",property:"foo",wires:[["jn2"]]}, + {id:"jn2", type:"helper"}]; + helper.load(sentimentNode, flow, function() { + var jn1 = helper.getNode("jn1"); + var jn2 = helper.getNode("jn2"); + jn2.on("input", function(msg) { + msg.should.have.property('sentiment'); + msg.sentiment.should.have.property('score'); + msg.sentiment.score.should.be.a.Number(); + msg.sentiment.score.should.be.below(-10); + done(); + }); + var testString = 'bad, horrible, negative, awful'; + jn1.receive({foo:testString}); + }); + }); + + it('should allow you to override word scoring', function(done) { + var flow = [{id:"jn1",type:"sentiment",wires:[["jn2"]]}, + {id:"jn2", type:"helper"}]; + helper.load(sentimentNode, flow, function() { + var jn1 = helper.getNode("jn1"); + var jn2 = helper.getNode("jn2"); + jn2.on("input", function(msg) { + msg.should.have.property('sentiment'); + msg.sentiment.should.have.property('score'); + msg.sentiment.score.should.be.a.Number(); + msg.sentiment.score.should.equal(20); + done(); + }); + var testString = 'sick, wicked'; + var overrides = {'sick': 10, 'wicked': 10 }; + jn1.receive({payload:testString,overrides:overrides}); + }); + }); + + it('should allow you to override word scoring - alternative property', function(done) { + var flow = [{id:"jn1",type:"sentiment",property:"foo",wires:[["jn2"]]}, + {id:"jn2", type:"helper"}]; + helper.load(sentimentNode, flow, function() { + var jn1 = helper.getNode("jn1"); + var jn2 = helper.getNode("jn2"); + jn2.on("input", function(msg) { + msg.should.have.property('sentiment'); + msg.sentiment.should.have.property('score'); + msg.sentiment.score.should.be.a.Number(); + msg.sentiment.score.should.equal(20); + done(); + }); + var testString = 'sick, wicked'; + var overrides = {'sick': 10, 'wicked': 10 }; + jn1.receive({foo:testString,overrides:overrides}); + }); + }); + +}); diff --git a/test/function/random/random_spec.js b/test/function/random/random_spec.js index e1a7d963..d352c12a 100644 --- a/test/function/random/random_spec.js +++ b/test/function/random/random_spec.js @@ -1,6 +1,6 @@ var should = require("should"); -var helper = require('../../../test/helper.js'); +var helper = require('node-red-node-test-helper'); var testNode = require('../../../function/random/random.js'); describe('random node', function() { @@ -15,55 +15,257 @@ describe('random node', function() { helper.stopServer(done); }); }); + +// ============================================================ - it("should be loaded with correct defaults", function(done) { - var flow = [{"id":"n1", "type":"random", "name":"random1", "wires":[[]]}]; - helper.load(testNode, flow, function() { - var n1 = helper.getNode("n1"); - //console.log(n1); - n1.should.have.property("low", 1); - n1.should.have.property("high", 10); - n1.should.have.property("inte", false); - done(); - }); - }); - - it('should output an integer between -3 and 3', function(done) { - var flow = [{"id":"n1", "type":"random", low:-3, high:3, inte:true, wires:[["n2"]] }, + it ("Test i1 (integer) - DEFAULT no overrides defaults to 1 and 10", function(done) { + var flow = [{id:"n1", type:"random", low: "" , high:"" , inte:true, wires:[["n2"]] }, {id:"n2", type:"helper"} ]; - helper.load(testNode, flow, function() { + helper.load(testNode, flow, function() { var n1 = helper.getNode("n1"); var n2 = helper.getNode("n2"); - var c = 0; - n2.on("input", function(msg) { - if (c === 0) { - msg.should.have.a.property("payload"); - msg.payload.should.be.approximately(0,3); - msg.payload.toString().indexOf(".").should.equal(-1); - done(); + n2.on("input", function(msg) { + try { + //console.log(msg); + msg.should.have.a.property("payload"); + msg.payload.should.be.within(1,10); + msg.payload.toString().indexOf(".").should.equal(-1); // see if it's really an integer and not a float... + done(); } + catch(err) { done(err); } }); - n1.emit("input", {payload:"a"}); + n1.emit("input", {"test":"Test i1"}); }); }); - it('should output an float between 20 and 30', function(done) { - var flow = [{"id":"n1", "type":"random", low:20, high:30, inte:false, wires:[["n2"]] }, + it ("Test f1 (float) - DEFAULT no overrides defaults to 1 and 10", function(done) { + var flow = [{id:"n1", type:"random", low:"" , high:"" , inte:false, wires:[["n2"]] }, {id:"n2", type:"helper"} ]; - helper.load(testNode, flow, function() { + helper.load(testNode, flow, function() { var n1 = helper.getNode("n1"); var n2 = helper.getNode("n2"); - var c = 0; - n2.on("input", function(msg) { - if (c === 0) { - msg.should.have.a.property("payload"); - msg.payload.should.be.approximately(25,5); - msg.payload.toString().indexOf(".").should.not.equal(-1); - done(); + n2.on("input", function(msg) { + try { + //console.log(msg); + msg.should.have.a.property("payload"); + msg.payload.should.be.within(1.0,9.999); + //msg.payload.toString().indexOf(".").should.not.equal(-1); + done(); } + catch(err) { done(err); } }); - n1.emit("input", {payload:"a"}); + n1.emit("input", {"test":"Test f-1"}); }); }); +// ============================================================ + + it ("Test i2 (integer) - FLIP node From = 3 To = -3", function(done) { + var flow = [{id:"n1", type:"random", low: 3, high: -3, inte:true, wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + n2.on("input", function(msg) { + try { + //console.log(msg); + msg.should.have.a.property("payload"); + msg.payload.should.be.within(-3,3); + msg.payload.toString().indexOf(".").should.equal(-1); // slightly dumb test to see if it really is an integer and not a float... + done(); + } + catch(err) { done(err); } + }); + n1.emit("input", {"test":"Test i2"}); + }); + }); + + it ("Test f2 (float) - FLIP node From = 3 To = -3", function(done) { + var flow = [{id:"n1", type:"random", low: 3, high: -3, inte:false, wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + n2.on("input", function(msg) { + try { + //console.log(msg); + msg.should.have.a.property("payload"); + msg.payload.should.be.within(-3.0,3.0); + done(); + } + catch(err) { done(err); } + }); + n1.emit("input", {"test":"Test f2"}); + }); + }); + +// ============================================================ + + it ("Test i3 (integer) - values in msg From = 2 To = '5', node no entries", function(done) { + var flow = [{id:"n1", type:"random", low: "", high: "", inte:true, wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + n2.on("input", function(msg) { + try { + //console.log(msg); + msg.should.have.a.property("payload"); + msg.payload.should.be.within(2,5); + msg.payload.toString().indexOf(".").should.equal(-1); // slightly dumb test to see if it really is an integer and not a float... + done(); + } + catch(err) { done(err); } + }); + n1.emit("input", {"test":"Test i3", "from":2, "to":'5'}); + }); + }); + + it ("Test f3 (float) - values in msg From = 2 To = '5', node no entries", function(done) { + var flow = [{id:"n1", type:"random", low: "", high: "", inte:false, wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + n2.on("input", function(msg) { + try { + //console.log(msg); + msg.should.have.a.property("payload"); + msg.payload.should.be.within(2.0,5.0); + done(); + } + catch(err) { done(err); } + }); + n1.emit("input", {"test":"Test f3", "from":2, "to":'5'}); + }); + }); + + + // ============================================================ + + it ("Test i4 (integer) - value in msg From = 2, node From = 5 To = '' - node overides From = 5 To defaults to 10", function(done) { + var flow = [{id:"n1", type:"random", low: 5, high:"", inte:true, wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + n2.on("input", function(msg) { + try { + //console.log(msg); + msg.should.have.a.property("payload"); + msg.payload.should.be.within(5,10); + msg.payload.toString().indexOf(".").should.equal(-1); + done(); + } + catch(err) { done(err); } + }); + n1.emit("input", {"test":"Test i4", "from": 2}); + }); + }); + + it ("Test f4 (float) - value in msg From = 2, node From = 5 To = '' - node wins 'To' defaults to 10", function(done) { + var flow = [{id:"n1", type:"random", low: 5, high:"", inte:false, wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + n2.on("input", function(msg) { + try { + //console.log(msg); + msg.should.have.a.property("payload"); + msg.payload.should.be.within(5.0,10.0); + done(); + } + catch(err) { done(err); } + }); + n1.emit("input", {"test":"Test f4", "from": 2}); + }); + }); + +// ============================================================ + + it ("Test i5 (integer) - msg From = '6' To = '9' node no entries", function(done) { + var flow = [{id:"n1", type:"random", low: "", high: "", inte:true, wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + n2.on("input", function(msg) { + try { + //console.log(msg); + msg.should.have.a.property("payload"); + msg.payload.should.be.within(6,9); + msg.payload.toString().indexOf(".").should.equal(-1); // slightly dumb test to see if it really is an integer and not a float... + done(); + } + catch(err) { done(err); } + }); + n1.emit("input", {"test":"Test i5", "from": '6', "to": '9'}); + }); + }); + + it ("Test f5 (float) - msg From = '6' To = '9' node no entries", function(done) { + var flow = [{id:"n1", type:"random", low: "", high: "", inte:false, wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + n2.on("input", function(msg) { + try { + //console.log(msg); + msg.should.have.a.property("payload"); + msg.payload.should.be.within(6.0,9.0); + done(); + } + catch(err) { done(err); } + }); + n1.emit("input", {"test":"Test f5", "from": '6', "to": '9'}); + }); + }); + +// ============================================================ + + it ("Test i6 (integer) - msg From = 2.4 To = '7.3' node no entries", function(done) { + var flow = [{id:"n1", type:"random", low: "", high: "", inte:true, wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + n2.on("input", function(msg) { + try { + //console.log(msg); + msg.should.have.a.property("payload"); + msg.payload.should.be.within(2,7); + msg.payload.toString().indexOf(".").should.equal(-1); // slightly dumb test to see if it really is an integer and not a float... + done(); + } + catch(err) { done(err); } + }); + n1.emit("input", {"test":"Test i6", "from": 2.4, "to": '7.3'}); + }); + }); + + it ("Test f6 (float) - msg From = 2.4 To = '7.3' node no entries", function(done) { + var flow = [{id:"n1", type:"random", low: "", high: "", inte:false, wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + n2.on("input", function(msg) { + try { + //console.log(msg); + msg.should.have.a.property("payload"); + msg.payload.should.be.within(2.4,7.3); + done(); + } + catch(err) { done(err); } + }); + n1.emit("input", {"test":"Test f6", "from": 2.4, "to": '7.3'}); + }); + }); + +// ============================================================ + + + }); diff --git a/test/function/rbe/rbe_spec.js b/test/function/rbe/rbe_spec.js index e19249ab..8d220c15 100644 --- a/test/function/rbe/rbe_spec.js +++ b/test/function/rbe/rbe_spec.js @@ -1,6 +1,6 @@ var should = require("should"); -var helper = require('../../../test/helper.js'); +var helper = require("node-red-node-test-helper"); var testNode = require('../../../function/rbe/rbe.js'); describe('rbe node', function() { @@ -40,25 +40,75 @@ describe('rbe node', function() { c+=1; } else if (c === 1) { - msg.should.have.a.property("payload", "b"); + msg.should.have.a.property("payload", 2); c+=1; } - else { + else if (c == 2) { msg.should.have.a.property("payload"); msg.payload.should.have.a.property("b",1); msg.payload.should.have.a.property("c",2); + c+=1; + } + else if (c == 3) { + msg.should.have.a.property("payload",true); + c+=1; + } + else if (c == 4) { + msg.should.have.a.property("payload",false); + c+=1; + } + else { + msg.should.have.a.property("payload",true); done(); } }); n1.emit("input", {payload:"a"}); n1.emit("input", {payload:"a"}); n1.emit("input", {payload:"a"}); - n1.emit("input", {payload:"a"}); - n1.emit("input", {payload:"a"}); - n1.emit("input", {payload:"b"}); + n1.emit("input", {payload:2}); + n1.emit("input", {payload:2}); n1.emit("input", {payload:{b:1,c:2}}); n1.emit("input", {payload:{c:2,b:1}}); n1.emit("input", {payload:{c:2,b:1}}); + n1.emit("input", {payload:true}); + n1.emit("input", {payload:false}); + n1.emit("input", {payload:false}); + n1.emit("input", {payload:true}); + }); + }); + + it('should only send output if another chosen property changes - foo (rbe)', function(done) { + var flow = [{"id":"n1", "type":"rbe", func:"rbe", gap:"0", property:"foo", wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + var c = 0; + n2.on("input", function(msg) { + if (c === 0) { + msg.should.have.a.property("foo", "a"); + c+=1; + } + else if (c === 1) { + msg.should.have.a.property("foo", "b"); + c+=1; + } + else { + msg.should.have.a.property("foo"); + msg.foo.should.have.a.property("b",1); + msg.foo.should.have.a.property("c",2); + done(); + } + }); + n1.emit("input", {foo:"a"}); + n1.emit("input", {payload:"a"}); + n1.emit("input", {foo:"a"}); + n1.emit("input", {payload:"a"}); + n1.emit("input", {foo:"a"}); + n1.emit("input", {foo:"b"}); + n1.emit("input", {foo:{b:1,c:2}}); + n1.emit("input", {foo:{c:2,b:1}}); + n1.emit("input", {payload:{c:2,b:1}}); }); }); @@ -236,9 +286,12 @@ describe('rbe node', function() { n2.on("input", function(msg) { c = c + 1; if (c === 1) { - msg.should.have.a.property("payload", 120); + msg.should.have.a.property("payload", 100); } else if (c === 2) { + msg.should.have.a.property("payload", 111); + } + else if (c === 3) { msg.should.have.a.property("payload", 135); done(); } @@ -246,8 +299,8 @@ describe('rbe node', function() { n1.emit("input", {payload:100}); n1.emit("input", {payload:95}); n1.emit("input", {payload:105}); + n1.emit("input", {payload:111}); n1.emit("input", {payload:120}); - n1.emit("input", {payload:130}); n1.emit("input", {payload:135}); }); }); @@ -342,6 +395,32 @@ describe('rbe node', function() { }); }); + it('should send output if gap is 0 and input doesnt change (narrowband)', function(done) { + var flow = [{"id":"n1", "type":"rbe", func:"narrowband", gap:"0", wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + var c = 0; + n2.on("input", function(msg) { + if (c === 0) { + msg.should.have.a.property("payload", 1); + } + else if (c === 4) { + msg.should.have.a.property("payload",1); + done(); + } + c += 1; + }); + n1.emit("input", {payload:1}); + n1.emit("input", {payload:1}); + n1.emit("input", {payload:1}); + n1.emit("input", {payload:1}); + n1.emit("input", {payload:0}); + n1.emit("input", {payload:1}); + }); + }); + it('should not send output if more than x away from original value (narrowband in step mode)', function(done) { var flow = [{"id":"n1", "type":"rbe", func:"narrowband", gap:"10", inout:"in", start:"500", wires:[["n2"]] }, {id:"n2", type:"helper"} ]; diff --git a/test/function/smooth/17-smooth_spec.js b/test/function/smooth/17-smooth_spec.js index 6145a94e..ac7c7fc7 100644 --- a/test/function/smooth/17-smooth_spec.js +++ b/test/function/smooth/17-smooth_spec.js @@ -1,6 +1,6 @@ var should = require("should"); -var helper = require('../../../test/helper.js'); +var helper = require("node-red-node-test-helper"); var testNode = require('../../../function/smooth/17-smooth.js'); describe('smooth node', function() { @@ -48,6 +48,29 @@ describe('smooth node', function() { }); }); + it('should average over a number of inputs - another property - foo', function(done) { + var flow = [{"id":"n1", "type":"smooth", action:"mean", count:"5", round:"true", property:"foo", wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + var c = 0; + n2.on("input", function(msg) { + c += 1; + if (c === 4) { msg.should.have.a.property("foo", 1.8); } + if (c === 6) { msg.should.have.a.property("foo", 3); done(); } + }); + n1.emit("input", {foo:1}); + n1.emit("input", {foo:1}); + n1.emit("input", {foo:2}); + n1.emit("input", {payload:2}); + n1.emit("input", {payload:2}); + n1.emit("input", {foo:3}); + n1.emit("input", {foo:4}); + n1.emit("input", {foo:4.786}); + }); + }); + it('should be able to be reset', function(done) { var flow = [{"id":"n1", "type":"smooth", action:"mean", count:"5", round:"true", wires:[["n2"]] }, {id:"n2", type:"helper"} ]; @@ -69,6 +92,29 @@ describe('smooth node', function() { }); }); + it('should be able to be reset - while using another property - foo', function(done) { + var flow = [{"id":"n1", "type":"smooth", action:"mean", count:"5", round:"true", property:"foo", wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + var c = 0; + n2.on("input", function(msg) { + c += 1; + if (c === 3) { msg.should.have.a.property("foo", 2); } + if (c === 6) { msg.should.have.a.property("foo", 5); done(); } + }); + n1.emit("input", {foo:1}); + n1.emit("input", {foo:2}); + n1.emit("input", {payload:2}); + n1.emit("input", {foo:3}); + n1.emit("input", {reset:true, foo:4}); + n1.emit("input", {foo:5}); + n1.emit("input", {payload:2}); + n1.emit("input", {foo:6}); + }); + }); + it('should output max over a number of inputs', function(done) { var flow = [{"id":"n1", "type":"smooth", action:"max", count:"5", wires:[["n2"]] }, {id:"n2", type:"helper"} ]; @@ -270,5 +316,79 @@ describe('smooth node', function() { n1.emit("input", {payload:9, topic:"B"}); }); }); - + it("should reduce the number of messages by averaging if asked", function(done) { + var flow = [{"id":"n1", "type":"smooth", action:"mean", count:"5", reduce:"true", wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + var c = 0; + n2.on("input", function(msg) { + c += 1; + if (c === 1) { msg.should.have.a.property("payload", 3); } + else if (c === 2) { msg.should.have.a.property("payload", 6); done(); } + else if (c > 2) { done(new Error("should not emit more than two messages.")); } + }); + n1.emit("input", {payload:1}); + n1.emit("input", {payload:2}); + n1.emit("input", {payload:3}); + n1.emit("input", {payload:4}); + n1.emit("input", {payload:5}); + n1.emit("input", {payload:6}); + n1.emit("input", {payload:7}); + n1.emit("input", {payload:8}); + n1.emit("input", {payload:9}) +; n1.emit("input", {payload:0}); + }); + }); + it("should reduce the number of messages by max value, if asked", function(done) { + var flow = [{"id":"n1", "type":"smooth", action:"max", count:"5", reduce:"true", wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + var c = 0; + n2.on("input", function(msg) { + c += 1; + if (c === 1) { msg.should.have.a.property("payload", 5); } + else if (c === 2) { msg.should.have.a.property("payload", 9); done(); } + else if (c > 2) { done(new Error("should not emit more than two messages.")); } + }); + n1.emit("input", {payload:1}); + n1.emit("input", {payload:2}); + n1.emit("input", {payload:3}); + n1.emit("input", {payload:4}); + n1.emit("input", {payload:5}); + n1.emit("input", {payload:6}); + n1.emit("input", {payload:7}); + n1.emit("input", {payload:8}); + n1.emit("input", {payload:9}); + n1.emit("input", {payload:0}); + }); + }); + it("should reduce the number of messages by min value, if asked", function(done) { + var flow = [{"id":"n1", "type":"smooth", action:"min", count:"5", reduce:"true", wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + var c = 0; + n2.on("input", function(msg) { + c += 1; + if (c === 1) { msg.should.have.a.property("payload", 1); } + else if (c === 2) { msg.should.have.a.property("payload", 0); done(); } + else if (c > 2) { done(new Error("should not emit more than two messages.")); } + }); + n1.emit("input", {payload:1}); + n1.emit("input", {payload:2}); + n1.emit("input", {payload:3}); + n1.emit("input", {payload:4}); + n1.emit("input", {payload:5}); + n1.emit("input", {payload:6}); + n1.emit("input", {payload:7}); + n1.emit("input", {payload:8}); + n1.emit("input", {payload:9}); + n1.emit("input", {payload:0}); + }); + }); }); diff --git a/test/hardware/PiGpio/36-rpi-gpio_spec.js b/test/hardware/PiGpio/36-rpi-gpio_spec.js new file mode 100644 index 00000000..5f5ac75e --- /dev/null +++ b/test/hardware/PiGpio/36-rpi-gpio_spec.js @@ -0,0 +1,157 @@ +/** + * Copyright JS Foundation and other contributors, http://js.foundation + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + **/ + +var should = require("should"); +var helper = require("node-red-node-test-helper"); +var rpiNode = require('../../../hardware/PiGpio/36-rpi-gpio.js'); + +//var rpiNode = require("nr-test-utils").require("@node-red/nodes/core/hardware/36-rpi-gpio.js"); +//var statusNode = require("nr-test-utils").require("@node-red/nodes/core/core/25-status.js"); +var helper = require("node-red-node-test-helper"); +var fs = require("fs"); + +describe('RPI GPIO Node', function() { + + before(function(done) { + helper.startServer(done); + }); + + after(function(done) { + helper.stopServer(done); + }); + + afterEach(function() { + helper.unload(); + }); + + var checkIgnore = function(done) { + setTimeout(function() { + try { + var logEvents = helper.log().args.filter(function(evt) { + return ((evt[0].level == 30) && (evt[0].msg.indexOf("rpi-gpio")===0)); + }); + logEvents[0][0].should.have.a.property('msg'); + logEvents[0][0].msg.toString().should.startWith("rpi-gpio : rpi-gpio.errors.ignorenode"); + done(); + } catch(err) { + done(err); + } + },25); + } + + it('should load Input node', function(done) { + var flow = [{id:"n1", type:"rpi-gpio in", name:"rpi-gpio in" }]; + helper.load(rpiNode, flow, function() { + var n1 = helper.getNode("n1"); + n1.should.have.property('name', 'rpi-gpio in'); + try { + var cpuinfo = fs.readFileSync("/proc/cpuinfo").toString(); + if (cpuinfo.indexOf(": BCM") === 1) { + done(); // It's ON a PI ... should really do more tests ! + } else { + checkIgnore(done); + } + } + catch(e) { + checkIgnore(done); + } + }); + }); + + it('should load Output node', function(done) { + var flow = [{id:"n1", type:"rpi-gpio out", name:"rpi-gpio out" }]; + helper.load(rpiNode, flow, function() { + var n1 = helper.getNode("n1"); + n1.should.have.property('name', 'rpi-gpio out'); + try { + var cpuinfo = fs.readFileSync("/proc/cpuinfo").toString(); + if (cpuinfo.indexOf(": BCM") === 1) { + done(); // It's ON a PI ... should really do more tests ! + } else { + checkIgnore(done); + } + } + catch(e) { + checkIgnore(done); + } + }); + }); + + + it('should read a dummy value high (not on Pi)', function(done) { + var flow = [{id:"n1", type:"rpi-gpio in", pin:"7", intype:"up", debounce:"25", read:true, wires:[["n2"]] }, + {id:"n2", type:"helper"}]; + helper.load(rpiNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + n2.on("input", function(msg) { + try { + msg.should.have.property('topic', 'pi/7'); + msg.should.have.property('payload', 1); + done(); + } catch(err) { + done(err); + } + }); + }); + }); + + it('should read a dummy value low (not on Pi)', function(done) { + var flow = [{id:"n1", type:"rpi-gpio in", pin:"11", intype:"down", debounce:"25", read:true, wires:[["n2"]] }, + {id:"n2", type:"helper"}]; + helper.load(rpiNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + n2.on("input", function(msg) { + try { + msg.should.have.property('topic', 'pi/11'); + msg.should.have.property('payload', 0); + done(); + } catch(err) { + done(err); + } + }); + }); + }); + + // it('should be able preset out to a dummy value (not on Pi)', function(done) { + // var flow = [{id:"n1", type:"rpi-gpio out", pin:"7", out:"out", level:"0", set:true, freq:"", wires:[], z:"1"}, + // {id:"n2", type:"status", scope:null, wires:[["n3"]], z:"1"}, + // {id:"n3", type:"helper", z:"1"}]; + // helper.load([rpiNode,statusNode], flow, function() { + // var n1 = helper.getNode("n1"); + // var n2 = helper.getNode("n2"); + // var n3 = helper.getNode("n3"); + // var count = 0; + // n3.on("input", function(msg) { + // // Only check the first status message received as it may get a + // // 'closed' status as the test is tidied up. + // if (count === 0) { + // count++; + // try { + // msg.should.have.property('status'); + // msg.status.should.have.property('text', "rpi-gpio.status.na"); + // done(); + // } catch(err) { + // done(err); + // } + // } + // }); + // n1.receive({payload:"1"}); + // }); + // }); + +}); diff --git a/test/helper.js b/test/helper.js deleted file mode 100644 index 8192cdeb..00000000 --- a/test/helper.js +++ /dev/null @@ -1,12 +0,0 @@ - -var path = require('path'); - -process.env.NODE_RED_HOME = process.env.NODE_RED_HOME || path.resolve(__dirname+"/../../node-red"); -var helper = require(path.join(process.env.NODE_RED_HOME, 'test', 'nodes', 'helper.js')); - -try { - helper.nock = helper.nock || require("nock"); -} catch(er) { - helper.nock = null; -} -module.exports = helper; diff --git a/test/parsers/base64/70-base64_spec.js b/test/parsers/base64/70-base64_spec.js index 1fe5ddda..12322b68 100644 --- a/test/parsers/base64/70-base64_spec.js +++ b/test/parsers/base64/70-base64_spec.js @@ -1,6 +1,6 @@ var should = require("should"); -var helper = require('../../../test/helper.js'); +var helper = require("node-red-node-test-helper"); var testNode = require('../../../parsers/base64/70-base64.js'); describe('base64 node', function() { @@ -39,6 +39,20 @@ describe('base64 node', function() { }); }); + it('should convert a Buffer to base64 using another property - foo', function(done) { + var flow = [{id:"n1", type:"base64", property:"foo", wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + n2.on("input", function(msg) { + msg.should.have.a.property("foo","QUJDREVGR0hJSktMTU5PUFFSU1RVVldYWVo="); + done(); + }); + n1.emit("input", {foo: Buffer.from("ABCDEFGHIJKLMNOPQRSTUVWXYZ")}); + }); + }); + it('should convert base64 to a Buffer', function(done) { var flow = [{"id":"n1", "type":"base64", wires:[["n2"]] }, {id:"n2", type:"helper"} ]; @@ -47,6 +61,7 @@ describe('base64 node', function() { var n2 = helper.getNode("n2"); n2.on("input", function(msg) { msg.should.have.a.property("payload"); + msg.payload.should.be.instanceof(Buffer); msg.payload.toString().should.equal("ABCDEFGHIJKLMNOPQRSTUVWXYZ"); done(); }); @@ -54,6 +69,22 @@ describe('base64 node', function() { }); }); + it('should convert base64 to a Buffer using another property - foo', function(done) { + var flow = [{id:"n1", type:"base64", property:"foo", wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + n2.on("input", function(msg) { + msg.should.have.a.property("foo"); + msg.foo.should.be.instanceof(Buffer); + msg.foo.toString().should.equal("ABCDEFGHIJKLMNOPQRSTUVWXYZ"); + done(); + }); + n1.emit("input", {foo:"QUJDREVGR0hJSktMTU5PUFFSU1RVVldYWVo="}); + }); + }); + it('should try to encode a non base64 string', function(done) { var flow = [{"id":"n1", "type":"base64", wires:[["n2"]] }, {id:"n2", type:"helper"} ]; @@ -133,4 +164,125 @@ describe('base64 node', function() { }); }); + it('can force encode string to base64', function(done) { + var flow = [{id:"n1", type:"base64", action:"str", wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + n2.on("input", function(msg) { + msg.should.have.a.property("payload","YW5keQ=="); + done(); + }); + n1.emit("input", {payload:"andy"}); + }); + }); + + it('can force encode boolean to base64', function(done) { + var flow = [{id:"n1", type:"base64", action:"str", wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + n2.on("input", function(msg) { + msg.should.have.a.property("payload","dHJ1ZQ=="); + done(); + }); + n1.emit("input", {payload:true}); + }); + }); + + it('can force encode number to base64', function(done) { + var flow = [{id:"n1", type:"base64", action:"str", wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + n2.on("input", function(msg) { + msg.should.have.a.property("payload","MTIzNA=="); + done(); + }); + n1.emit("input", {payload:1234}); + }); + }); + + it('can force encode object to base64', function(done) { + var flow = [{id:"n1", type:"base64", action:"str", wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + n2.on("input", function(msg) { + msg.should.have.a.property("payload","eyJhIjoxfQ=="); + done(); + }); + n1.emit("input", {payload:{a:1}}); + }); + }); + + it('can force decode base64 to string', function(done) { + var flow = [{id:"n1", type:"base64", action:"b64", wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + n2.on("input", function(msg) { + msg.payload.should.be.instanceof(String); + msg.should.have.a.property("payload","Hello World"); + done(); + }); + n1.emit("input", {payload:"SGVsbG8gV29ybGQ="}); + }); + }); + + it('wont decode base64 to string if not a valid string', function(done) { + var flow = [{id:"n1", type:"base64", action:"b64", wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + n2.on("input", function(msg) { + done("should not get here with no payload."); + }); + setTimeout(function () { + try { + var logEvents = helper.log().args.filter(function (evt) { + return evt[0].type == "base64"; + }); + logEvents[0][0].should.have.a.property('msg'); + logEvents[0][0].msg.toString().should.startWith("base64.error.invalid"); + done(); + } catch (e) { + done(e); + } + }, 45); + n1.emit("input", {payload:"andy!@3"}); + }); + }); + + it('wont decode base64 to string if not a string', function(done) { + var flow = [{id:"n1", type:"base64", action:"b64", wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + n2.on("input", function(msg) { + done("should not get here with no payload."); + }); + setTimeout(function () { + try { + var logEvents = helper.log().args.filter(function (evt) { + return evt[0].type == "base64"; + }); + logEvents[0][0].should.have.a.property('msg'); + logEvents[0][0].msg.toString().should.startWith("base64.error.nonbase64"); + done(); + } catch (e) { + done(e); + } + }, 45); + n1.emit("input", {payload:1234}); + }); + }); + }); diff --git a/test/parsers/geohash/70-geohash_spec.js b/test/parsers/geohash/70-geohash_spec.js index d694a7d5..ffc2dc0c 100644 --- a/test/parsers/geohash/70-geohash_spec.js +++ b/test/parsers/geohash/70-geohash_spec.js @@ -1,6 +1,21 @@ +/** + * Copyright 2015 IBM Corp. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + **/ var should = require("should"); -var helper = require('../../../test/helper.js'); +var helper = require("node-red-node-test-helper"); var testNode = require('../../../parsers/geohash/70-geohash.js'); describe('geohash node', function() { @@ -129,7 +144,7 @@ describe('geohash node', function() { }); it('should convert location lat, lon to geohash', function(done) { - var flow = [{"id":"n1", "type":"geohash", func:"geohash", gap:0, wires:[["n2"]] }, + var flow = [{id:"n1", type:"geohash", func:"geohash", property:"location", gap:0, wires:[["n2"]] }, {id:"n2", type:"helper"} ]; helper.load(testNode, flow, function() { var n1 = helper.getNode("n1"); @@ -144,7 +159,7 @@ describe('geohash node', function() { }); it('should convert location lat, lon to geohash (low precision)', function(done) { - var flow = [{"id":"n1", "type":"geohash", func:"geohash", gap:0, wires:[["n2"]] }, + var flow = [{"id":"n1", "type":"geohash", func:"geohash", property:"location", gap:0, wires:[["n2"]] }, {id:"n2", type:"helper"} ]; helper.load(testNode, flow, function() { var n1 = helper.getNode("n1"); @@ -159,7 +174,7 @@ describe('geohash node', function() { }); it('should convert location geohash to lat.lon', function(done) { - var flow = [{"id":"n1", "type":"geohash", func:"geohash", gap:0, wires:[["n2"]] }, + var flow = [{"id":"n1", "type":"geohash", func:"geohash", property:"location", gap:0, wires:[["n2"]] }, {id:"n2", type:"helper"} ]; helper.load(testNode, flow, function() { var n1 = helper.getNode("n1"); @@ -289,7 +304,7 @@ describe('geohash node', function() { }); it('should warn if location object with only a lat (or lon)', function(done) { - var flow = [{"id":"n1", "type":"geohash", func:"gap", gap:10, wires:[["n2"]] }, + var flow = [{"id":"n1", "type":"geohash", func:"gap", property:"location", gap:10, wires:[["n2"]] }, {id:"n2", type:"helper"} ]; helper.load(testNode, flow, function() { var n1 = helper.getNode("n1"); diff --git a/test/parsers/markdown/70-markdown_spec.js b/test/parsers/markdown/70-markdown_spec.js new file mode 100644 index 00000000..9da82a53 --- /dev/null +++ b/test/parsers/markdown/70-markdown_spec.js @@ -0,0 +1,109 @@ + +var should = require("should"); +var helper = require("node-red-node-test-helper"); +var testNode = require('../../../parsers/markdown/70-markdown.js'); + +describe('markdown node', function() { + "use strict"; + + beforeEach(function(done) { + helper.startServer(done); + }); + + afterEach(function(done) { + helper.unload().then(function() { + helper.stopServer(done); + }); + }); + + it("should be loaded with correct defaults", function(done) { + var flow = [{"id":"n1", "type":"markdown", "name":"markdown1", "wires":[[]]}]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + n1.should.have.property("name", "markdown1"); + done(); + }); + }); + + var buf; + + it('should convert a string to html', function(done) { + var flow = [{"id":"n1", "type":"markdown", wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + n2.on("input", function(msg) { + msg.should.have.a.property("payload"); + msg.payload.should.be.a.String; + msg.payload.should.equal('

BOLD italic

\n
\n

™\ncode

\n'); + done(); + }); + n1.emit("input", {payload:"**BOLD** *italic*\n***\n\n(TM)\n`code`"}); + }); + }); + + it('should ignore other types - object', function(done) { + var flow = [{"id":"n1", "type":"markdown", wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + n2.on("input", function(msg) { + msg.should.have.a.property("payload"); + msg.payload.should.be.a.Object; + msg.payload.a.should.equal("object"); + done(); + }); + n1.emit("input", {payload:{a:"object"}}); + }); + }); + + it('should ignore other types - number', function(done) { + var flow = [{"id":"n1", "type":"markdown", wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + n2.on("input", function(msg) { + msg.should.have.a.property("payload"); + msg.payload.should.be.a.number; + msg.payload.should.equal(1); + done(); + }); + n1.emit("input", {payload:1}); + }); + }); + + it('should ignore other types - boolean', function(done) { + var flow = [{"id":"n1", "type":"markdown", wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + n2.on("input", function(msg) { + msg.should.have.a.property("payload"); + msg.payload.should.be.a.boolean; + msg.payload.should.equal(true); + done(); + }); + n1.emit("input", {payload:true}); + }); + }); + + it('should ignore other types - array', function(done) { + var flow = [{"id":"n1", "type":"markdown", wires:[["n2"]] }, + {id:"n2", type:"helper"} ]; + helper.load(testNode, flow, function() { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + n2.on("input", function(msg) { + msg.should.have.a.property("payload"); + msg.payload.should.be.an.object; + done(); + }); + n1.emit("input", {payload:[1,2,"a","b"]}); + }); + }); + +}); diff --git a/test/parsers/msgpack/70-msgpack_spec.js b/test/parsers/msgpack/70-msgpack_spec.js index b8bd1275..09cda4e8 100644 --- a/test/parsers/msgpack/70-msgpack_spec.js +++ b/test/parsers/msgpack/70-msgpack_spec.js @@ -1,6 +1,6 @@ var should = require("should"); -var helper = require('../../../test/helper.js'); +var helper = require("node-red-node-test-helper"); var testNode = require('../../../parsers/msgpack/70-msgpack.js'); describe('msgpack node', function() { diff --git a/test/social/email/61-email_spec.js b/test/social/email/61-email_spec.js index 38d76036..dd2316d9 100644 --- a/test/social/email/61-email_spec.js +++ b/test/social/email/61-email_spec.js @@ -1,6 +1,6 @@ var should = require("should"); var sinon = require("sinon"); -var helper = require('../../../test/helper.js'); +var helper = require("node-red-node-test-helper"); var emailNode = require('../../../social/email/61-email.js'); describe('email Node', function () { @@ -43,6 +43,7 @@ describe('email Node', function () { id: "n1", type: "e-mail", name: "emailout", + port: 1025, wires: [ [] ] @@ -88,7 +89,7 @@ describe('email Node', function () { done(e); } //finally { smtpTransport.sendMail.restore(); } - }, 1000); + }, 1500); }); it('should fail to send an email (invalid creds)', function (done) { @@ -128,8 +129,9 @@ describe('email Node', function () { //console.log(evt[0].msg); return evt[0].type == "e-mail"; }); - //console.log(helper.log().args); - //console.log(helper.log()); + // console.log(helper.log().args); + // console.log(helper.log()); + // console.log(logEvents[0][0].msg.toString()); //logEvents.should.have.length(3); logEvents[0][0].should.have.a.property('msg'); logEvents[0][0].msg.toString().should.startWith("Error:"); @@ -138,7 +140,7 @@ describe('email Node', function () { done(e); } //finally { smtpTransport.sendMail.restore(); } - }, 1000); + }, 1900); }) it('should fail to send an email (no creds provided)', function (done) { @@ -183,8 +185,68 @@ describe('email Node', function () { done(e); } //finally { smtpTransport.sendMail.restore(); } - }, 1000); + }, 1900); }) }); -}); \ No newline at end of file + + describe('email mta', function () { + + it('should catch an email send to localhost 1025', function (done) { + var flow = [{ + id: "n1", + type: "e-mail mta", + name: "emailmta", + port: 1025, + wires: [ + ["n2"] + ] + }, + { + id:"n2", + type:"helper" + }, + { + id: "n3", + type: "e-mail", + dname: "testout", + server: "localhost", + secure: false, + port: 1025, + wires: [ + [] + ] + }]; + helper.load(emailNode, flow, function () { + var n1 = helper.getNode("n1"); + var n2 = helper.getNode("n2"); + var n3 = helper.getNode("n3"); + n1.should.have.property('port', 1025); + + n2.on("input", function(msg) { + //console.log("GOT",msg); + try { + msg.should.have.a.property("payload",'Hello World\n'); + msg.should.have.a.property("topic","Test"); + msg.should.have.a.property("from",'foo@example.com'); + msg.should.have.a.property("to",'bar@example.com'); + msg.should.have.a.property("attachments"); + msg.should.have.a.property("header"); + done(); + } + catch(e) { + done(e) + } + }); + + n3.emit("input", { + payload: "Hello World", + topic: "Test", + from: "foo@example.com", + to: "bar@example.com" + }); + //done(); + }); + }); + }); +}); diff --git a/test/social/feedparse/32-feedparse_spec.js b/test/social/feedparse/32-feedparse_spec.js new file mode 100644 index 00000000..454b82eb --- /dev/null +++ b/test/social/feedparse/32-feedparse_spec.js @@ -0,0 +1,73 @@ +const should = require("should"); +const helper = require("node-red-node-test-helper"); +const feedParserNode = require("../../../social/feedparser/32-feedparse"); + +describe("FeedParseNode", () => { + + beforeEach(function (done) { + helper.startServer(done); + }); + + afterEach(function (done) { + helper.unload(); + helper.stopServer(done); + }); + + it("should be loaded", (done) => { + const flow = [{id:"n1", type:"feedparse", interval: 15, url: "test", name: "feedparse" }]; + helper.load(feedParserNode, flow, () => { + const n1 = helper.getNode("n1"); + n1.should.have.property("name", "feedparse"); + done(); + }); + }); + + it("get feed", (done) => { + const flow = [ + {id:"n1", type:"feedparse", interval: 15, url: "https://discourse.nodered.org/posts.rss", name: "feedparse" , wires:[["n2"]] }, + { id: "n2", type: "helper" } + ]; + helper.load(feedParserNode, flow, () => { + const n2 = helper.getNode("n2"); + const n1 = helper.getNode("n1"); + let count = 0; + n2.on("input", (msg) => { + msg.topic.should.startWith("https://discourse.nodered.org/"); + if(count === 0){ + done(); + count++; + } + }); + }); + }); + + it("invalid interval", (done) => { + const flow = [ + {id:"n1", type:"feedparse", interval: 35791, url: "https://discourse.nodered.org/posts.rss", name: "feedparse" , wires:[["n2"]] }, + { id: "n2", type: "helper" } + ]; + helper.load(feedParserNode, flow, () => { + const n2 = helper.getNode("n2"); + const n1 = helper.getNode("n1"); + n1.on('call:warn', call => { + call.should.have.property("lastArg", "feedparse.errors.invalidinterval"); + done(); + }); + }); + }); + + it("bad host", (done) => { + const flow = [ + {id:"n1", type:"feedparse", interval: 15, url: "https://discourse.nodered.org/dummy.rss", name: "feedparse" , wires:[["n2"]] }, + { id: "n2", type: "helper" } + ]; + helper.load(feedParserNode, flow, () => { + const n2 = helper.getNode("n2"); + const n1 = helper.getNode("n1"); + n1.on('call:warn', call => { + call.lastArg.should.have.startWith("feedparse.errors.badstatuscode"); + done(); + }); + }); + }); +}); diff --git a/test/social/pushbullet/57-pushbullet_spec.js b/test/social/pushbullet/57-pushbullet_spec.js index beaec5a9..025001b0 100644 --- a/test/social/pushbullet/57-pushbullet_spec.js +++ b/test/social/pushbullet/57-pushbullet_spec.js @@ -8,7 +8,7 @@ var EventEmitter = require('events').EventEmitter var util = require('util'); var data = require("./data"); var path = require("path"); -var helper = require('../../../test/helper.js'); +var helper = require("node-red-node-test-helper"); // Mute "Starting/Stopping flows to stdout" @@ -80,690 +80,696 @@ var pushbulletNode = proxyquire("../../../social/pushbullet/57-pushbullet.js", { }); describe('pushbullet node', function() { - - beforeEach(function(done) { - currentPB = new pushbulletStub(); - helper.startServer(done); - }); - - afterEach(function(done) { - helper.unload(); - helper.stopServer(done); - }); - - describe('loading and settings', function() { - it('loads', function(done) { - var flow = [{id:"n1", type:"pushbullet-config"}, - {id:"n2", type:"pushbullet", config: "n1"}]; - helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { - done(); - }); - }); - - it('gets user info', function(done) { - var flow = [{id:"n1", type:"pushbullet-config"}, - {id:"n2", type:"pushbullet", config: "n1"}]; - var func = sinon.stub(currentPB, "me"); - helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { - func.yield(false, data.me); - helper.getNode("n1").me.then(function(me) { - me.should.have.property("email", "john.doe@noma.il"); - done(); - }); - }); - }); - - it('gets user info, fail', function(done) { - var flow = [{id:"n1", type:"pushbullet-config"}, - {id:"n2", type:"pushbullet", config: "n1"}, - {id:"n3", type:"pushbullet in", config: "n1"}]; - var func = sinon.spy(currentPB, "me"); - helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { - var warn1 = sinon.spy(helper.getNode("n2"), "error"); - //var warn2 = sinon.spy(helper.getNode("n3"), "error"); - func.yield(true, null); - func.callCount.should.be.above(0); - //helper.getNode("n1").me.should.have.property("email", "john.doe@noma.il"); - done(); - }); - }); - - it('list devices', function(done) { - var flow = [{id:"n1", type:"pushbullet-config"}, - {id:"n2", type:"pushbullet", config: "n1"}]; - var func = sinon.stub(currentPB, "devices"); - helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { - helper.request().get("/pushbullet/n1/devices").end(function(err, res) { - var devs = JSON.parse(res.text); - devs.should.have.length(2); - done(); - }); - - var ret = getReply(); - ret.devices = data.devices; - func.yields(false, ret); - }); - }); - - it('gets last modified', function(done) { - var flow = [{id:"n1", type:"pushbullet-config"}, - {id:"n2", type:"pushbullet", config: "n1"}]; - var func = sinon.stub(currentPB, "history"); - helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { - func.yield(false, getPushReply('modified')); - helper.getNode("n1").last.then(function(last) { - last.should.equal(1234); - done(); - }); - }); - }); - - it('gets last modified with no history', function(done) { - var flow = [{id:"n1", type:"pushbullet-config"}, - {id:"n2", type:"pushbullet", config: "n1"}]; - var func = sinon.stub(currentPB, "history"); - helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { - func.yield(false, getReply()); - helper.getNode("n1").last.then(function(last) { - last.should.equal(0); - done(); - }); - }); - }); - }); - - describe('backward compatiblity', function() { - it('should be valid', function(done) { - var flow = [{"id": "n1", "type": "pushbullet", "chan": "", "title": "topic"}, - {id:"n3", type:"helper", wires: [["n1"]]}]; - helper.load(pushbulletNode, flow, {n1:{pushkey:"key", deviceid: "dev"}}, function() { - var func = sinon.spy(currentPB, "note"); - helper.getNode("n3").send({ - payload: "my note", - }); - sinon.assert.calledWith(func, "dev", "topic", "my note"); - done(); - }); - }); - }); - - describe('defaults and msg optionals', function() { - it('defaults', function(done) { - var flow = [{id:"n1", type:"pushbullet-config"}, - {id:"n2", type:"pushbullet", config: "n1"}, - {id:"n3", type:"helper", wires: [["n2"]]}]; - helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { - var func = sinon.spy(currentPB, "note"); - helper.getNode("n3").send({ - payload: "my note", - }); - helper.getNode("n1").me.then(function(){ - sinon.assert.calledWith(func, "john.doe@noma.il", "Node-RED", "my note"); - done(); - }); - }); - }); - - it('no overrides', function(done) { - var flow = [{id:"n1", type:"pushbullet-config"}, - {id:"n2", type:"pushbullet", config: "n1", pushtype: "note", title: "title"}, - {id:"n3", type:"helper", wires: [["n2"]]}]; - - helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2: {deviceid: "id"}}, function() { - var func = sinon.spy(currentPB, "note"); - helper.getNode("n3").send({ - payload: "my note", - }); - sinon.assert.calledWith(func, "id", "title", "my note"); - done(); - }); - }); - - it('channel', function(done) { - var flow = [{id:"n1", type:"pushbullet-config"}, - {id:"n2", type:"pushbullet", config: "n1", pushtype: "note", title: "title", chan: "mychannel"}, - {id:"n3", type:"helper", wires: [["n2"]]}]; - - helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2: {deviceid: "id"}}, function() { - var func = sinon.spy(currentPB, "note"); - helper.getNode("n3").send({ - payload: "my note", - }); - sinon.assert.calledWith(func, {channel_tag: "mychannel"}, "title", "my note"); - done(); - }); - }); - - it('channel from msg', function(done) { - var flow = [{id:"n1", type:"pushbullet-config"}, - {id:"n2", type:"pushbullet", config: "n1", pushtype: "note", title: "title"}, - {id:"n3", type:"helper", wires: [["n2"]]}]; - - helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2: {deviceid: "id"}}, function() { - var func = sinon.spy(currentPB, "note"); - helper.getNode("n3").send({ - payload: "my note", - channel: "mychannel" - }); - sinon.assert.calledWith(func, {channel_tag: "mychannel"}, "title", "my note"); - done(); - }); - }); - - it('all optionals but defined in node', function(done) { - var flow = [{id:"n1", type:"pushbullet-config"}, - {id:"n2", type:"pushbullet", config: "n1", pushtype: "link", title: "title"}, - {id:"n3", type:"helper", wires: [["n2"]]}]; - - helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2: {deviceid: "id"}}, function() { - var func = sinon.spy(currentPB, "push"); - helper.getNode("n3").send({ - deviceid: "over1", - topic: "over2", - pushtype: "note", - payload: "payload" - }); - sinon.assert.calledWith(func, "id", {type: "link", body: undefined, title:"title", url: "payload"}); - done(); - }); - }); - - it('all optionals', function(done) { - var flow = [{id:"n1", type:"pushbullet-config"}, - {id:"n2", type:"pushbullet", config: "n1", pushtype: "", title: ""}, - {id:"n3", type:"helper", wires: [["n2"]]}]; - - helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2: {deviceid: "_msg_"}}, function() { - var func = sinon.spy(currentPB, "push"); - helper.getNode("n3").send({ - deviceid: "over1", - topic: "over2", - payload: "over3", - pushtype: "link" - }); - sinon.assert.calledWith(func, "over1", {type: "link", body: undefined, title: "over2", url: "over3"}); - done(); - }); - }); - }); - - describe('output', function() { - it('note', function(done) { - var flow = [{id:"n1", type:"pushbullet-config"}, - {id:"n2", type:"pushbullet", config: "n1", pushtype: "note", title: "title"}, - {id:"n3", type:"helper", wires: [["n2"]]} - ]; - - helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2: {deviceid: "id"}}, function() { - var func = sinon.spy(currentPB, "note"); - helper.getNode("n3").send({ - payload: "my note", - }); - sinon.assert.calledWith(func, "id", "title", "my note"); - done(); - }); - }); - - it('link', function(done) { - var flow = [{id:"n1", type:"pushbullet-config"}, - {id:"n2", type:"pushbullet", config: "n1", pushtype: "link", title: "title"}, - {id:"n3", type:"helper", wires: [["n2"]]} - ]; - - helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2: {deviceid: "id"}}, function() { - var func = sinon.spy(currentPB, "push"); - helper.getNode("n3").send({ - payload: "http://link", - message: "message" - }); - sinon.assert.calledWith(func, "id", {type: "link", title: "title", url: "http://link", body: "message"}); - done(); - }); - }); - - it('list', function(done) { - var flow = [{id:"n1", type:"pushbullet-config"}, - {id:"n2", type:"pushbullet", config: "n1", pushtype: "list", title: "title"}, - {id:"n3", type:"helper", wires: [["n2"]]} - ]; - - helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2: {deviceid: "id"}}, function() { - var func = sinon.spy(currentPB, "list"); - helper.getNode("n3").send({ - payload: ["a", "b", "c"], - }); - sinon.assert.calledWith(func, "id", "title"); - func.getCall(0).args[2].should.have.length(3); - - done(); - }); - }); - - it('list string', function(done) { - var flow = [{id:"n1", type:"pushbullet-config"}, - {id:"n2", type:"pushbullet", config: "n1", pushtype: "list", title: "title"}, - {id:"n3", type:"helper", wires: [["n2"]]} - ]; - - helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2: {deviceid: "id"}}, function() { - var func = sinon.spy(currentPB, "list"); - helper.getNode("n3").send({ - payload: '["a", "b", "c"]', - }); - sinon.assert.calledWith(func, "id", "title"); - func.getCall(0).args[2].should.have.length(3); - - done(); - }); - }); - - it('address', function(done) { - var flow = [{id:"n1", type:"pushbullet-config"}, - {id:"n2", type:"pushbullet", config: "n1", pushtype: "address", title: "title"}, - {id:"n3", type:"helper", wires: [["n2"]]} - ]; - - helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2: {deviceid: "id"}}, function() { - var func = sinon.spy(currentPB, "address"); - helper.getNode("n3").send({ - payload: "My Street 4", - }); - sinon.assert.calledWith(func, "id", "title", "My Street 4"); - done(); - }); - }); - - it('file', function(done) { - var flow = [{id:"n1", type:"pushbullet-config"}, - {id:"n2", type:"pushbullet", config: "n1", pushtype: "file", title: "title"}, - {id:"n3", type:"helper", wires: [["n2"]]} - ]; - - helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2: {deviceid: "id"}}, function() { - var func = sinon.spy(currentPB, "file"); - var fn = path.join(__dirname, "data.js") - helper.getNode("n3").send({ - payload: fn, - }); - sinon.assert.calledWith(func, "id", fn, "title"); - done(); - }); - }); - - it('should fail if file don\'t exist', function(done) { - var flow = [{id:"n1", type:"pushbullet-config"}, - {id:"n2", type:"pushbullet", config: "n1", pushtype: "file", title: "title"}, - {id:"n3", type:"helper", wires: [["n2"]]} - ]; - - helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2: {deviceid: "id"}}, function() { - var func = sinon.spy(currentPB, "file"); - var errfn = sinon.spy(helper.getNode("n2"), "error"); - helper.getNode("n3").send({ - payload: "hello", - }); - func.called.should.fail; - errfn.callCount.should.be.above(0); - done(); - }); - }); - - it('raw', function(done) { - var flow = [{id:"n1", type:"pushbullet-config"}, - {id:"n2", type:"pushbullet", config: "n1"}, - {id:"n3", type:"helper", wires: [["n2"]]} - ]; - - helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2: {deviceid: "id"}}, function() { - var func = sinon.spy(currentPB, "push"); - helper.getNode("n3").send({ - pushtype: '_raw_', - raw: {type: 'note', title: 'title', body: 'this is the note'} - }); - sinon.assert.calledWith(func, "id", {type: 'note', title: 'title', body: 'this is the note'}); - done(); - }); - }); - - it('raw update', function(done) { - var flow = [{id:"n1", type:"pushbullet-config"}, - {id:"n2", type:"pushbullet", config: "n1"}, - {id:"n3", type:"helper", wires: [["n2"]]} - ]; - - helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2: {deviceid: "id"}}, function() { - var func = sinon.spy(currentPB, "updatePush"); - helper.getNode("n3").send({ - pushtype: '_rawupdate_', - raw: {items: [{checked:false, text: 'a'}]}, - data: {iden: 'id'} - }); - sinon.assert.calledWith(func, "id", {items: [{checked:false, text: 'a'}]}); - done(); - }); - }); - }); - - describe('actions', function() { - it('delete', function(done) { - var flow = [{id:"n1", type:"pushbullet-config"}, - {id:"n2", type:"pushbullet", config: "n1", pushtype: "delete"}, - {id:"n3", type:"helper", wires: [["n2"]]} - ]; - - helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { - var func = sinon.spy(currentPB, "deletePush"); - helper.getNode("n3").send({ - payload: "my note", - data: { iden: "delid"} - }); - sinon.assert.calledWith(func, "delid"); - done(); - }); - }); - - it('dismiss', function(done) { - var flow = [{id:"n1", type:"pushbullet-config"}, - {id:"n2", type:"pushbullet", config: "n1", pushtype: "dismissal"}, - {id:"n3", type:"helper", wires: [["n2"]]} - ]; - - helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { - var func = sinon.spy(currentPB, "updatePush"); - helper.getNode("n3").send({ - payload: "my note", - data: { iden: "delid", dismissed: false } - }); - sinon.assert.calledWith(func, "delid"); - done(); - }); - }); - - it('update list', function(done) { - var flow = [{id:"n1", type:"pushbullet-config"}, - {id:"n2", type:"pushbullet", config: "n1", pushtype: "updatelist"}, - {id:"n3", type:"helper", wires: [["n2"]]} - ]; - - helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { - var func = sinon.spy(currentPB, "updatePush"); - helper.getNode("n3").send({ - payload: [{}, {}, {}], - data: { iden: "delid", type: "list" } - }); - sinon.assert.calledWith(func, "delid"); - func.getCall(0).args[1].items.should.have.length(3); - done(); - }); - }); - }); - - describe('input', function() { - it.skip("input tests need updating for newer version of Sinon"); - return; - - // describe('input', function() { - // it('handles stream push', function(done) { + it.skip("input tests need updating for newer version of Sinon"); + return; + // + // beforeEach(function(done) { + // currentPB = new pushbulletStub(); + // helper.startServer(done); + // }); + // + // afterEach(function(done) { + // helper.unload(); + // helper.stopServer(done); + // }); + // + // describe('loading and settings', function() { + // it('loads', function(done) { // var flow = [{id:"n1", type:"pushbullet-config"}, - // {id:"n2", type:"pushbullet in", config: "n1", wires: [["n3"]]}, - // {id:"n3", type:"helper"}]; - // + // {id:"n2", type:"pushbullet", config: "n1"}]; // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { - // helper.getNode("n3").on("input", function(msg) { - // done(); - // }); - // currentPB.streamEmitter.emit("message", {type: "push", push: {type: "clip", body: "clipboard"}}) - // }); - // }); - // - // it('handles status', function(done) { - // var flow = [{id:"n1", type:"pushbullet-config"}, - // {id:"n2", type:"pushbullet in", config: "n1", wires: [["n3"]]}, - // {id:"n3", type:"helper"}]; - // - // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { - // //var func = sinon.spy(helper.getNode("n2"), 'status'); - // currentPB.streamEmitter.emit("connect"); - // currentPB.streamEmitter.emit("close"); - // //currentPB.streamEmitter.emit("error"); - // //func.callCount.should.equal(3); // done(); // }); // }); // - // it('clipboard', function(done) { + // it('gets user info', function(done) { // var flow = [{id:"n1", type:"pushbullet-config"}, - // {id:"n2", type:"pushbullet in", config: "n1", wires: [["n3"]]}, - // {id:"n3", type:"helper"}]; - // + // {id:"n2", type:"pushbullet", config: "n1"}]; + // var func = sinon.stub(currentPB, "me"); // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { - // helper.getNode("n3").on("input", function(msg) { - // msg.should.have.property("pushtype", "clip"); - // msg.should.have.property("payload", "hello"); - // msg.should.have.property("data"); + // func.yield(false, data.me); + // helper.getNode("n1").me.then(function(me) { + // me.should.have.property("email", "john.doe@noma.il"); // done(); // }); - // currentPB.streamEmitter.emit("message", {type: "push", push: {type: "clip", body: "hello"}}); // }); // }); // - // it('mirror', function(done) { - // var flow = [{id:"n1", type:"pushbullet-config"}, - // {id:"n2", type:"pushbullet in", config: "n1", wires: [["n3"]]}, - // {id:"n3", type:"helper"}]; + // it.skip("input tests need updating for newer version of Sinon"); + // // it('gets user info, fail', function(done) { + // // var flow = [{id:"n1", type:"pushbullet-config"}, + // // {id:"n2", type:"pushbullet", config: "n1"}, + // // {id:"n3", type:"pushbullet in", config: "n1"}]; + // // var func = sinon.spy(currentPB, "me"); + // // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { + // // var warn1 = sinon.spy(helper.getNode("n2"), "error"); + // // //var warn2 = sinon.spy(helper.getNode("n3"), "error"); + // // func.yield(true, null); + // // func.callCount.should.be.above(0); + // // //helper.getNode("n1").me.should.have.property("email", "john.doe@noma.il"); + // // done(); + // // }); + // // }); // + // it('list devices', function(done) { + // var flow = [{id:"n1", type:"pushbullet-config"}, + // {id:"n2", type:"pushbullet", config: "n1"}]; + // var func = sinon.stub(currentPB, "devices"); // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { - // helper.getNode("n3").on("input", function(msg) { - // msg.should.have.property("pushtype", "mirror"); - // msg.should.have.property("payload", "If you see this on your computer, mirroring is working!\n"); - // msg.should.have.property("data"); + // helper.request().get("/pushbullet/n1/devices").end(function(err, res) { + // var devs = JSON.parse(res.text); + // devs.should.have.length(2); // done(); // }); - // currentPB.streamEmitter.emit("message", {type: "push", push: data.mirror}); + // + // var ret = getReply(); + // ret.devices = data.devices; + // func.yields(false, ret); // }); // }); // - // it('dismissal', function(done) { + // it('gets last modified', function(done) { // var flow = [{id:"n1", type:"pushbullet-config"}, - // {id:"n2", type:"pushbullet in", config: "n1", wires: [["n3"]]}, - // {id:"n3", type:"helper"}]; - // + // {id:"n2", type:"pushbullet", config: "n1"}]; + // var func = sinon.stub(currentPB, "history"); // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { - // helper.getNode("n3").on("input", function(msg) { - // msg.should.have.property("pushtype", "dismissal"); - // msg.should.have.property("payload", "pjgzwwocCCy"); - // msg.should.have.property("data"); + // func.yield(false, getPushReply('modified')); + // helper.getNode("n1").last.then(function(last) { + // last.should.equal(1234); // done(); // }); - // currentPB.streamEmitter.emit("message", {type: "push", push: data.dismissal}); // }); // }); // - // it('unknown type', function(done) { + // it('gets last modified with no history', function(done) { // var flow = [{id:"n1", type:"pushbullet-config"}, - // {id:"n2", type:"pushbullet in", config: "n1", wires: [["n3"]]}, - // {id:"n3", type:"helper"}]; - // + // {id:"n2", type:"pushbullet", config: "n1"}]; + // var func = sinon.stub(currentPB, "history"); // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { - // var err = sinon.spy(helper.getNode("n1"), "error"); - // currentPB.streamEmitter.emit("message", {type: "push", push: {type: "push", push: {type: "unknown", data: "test"}}}); - // err.called.should.be.ok; + // func.yield(false, getReply()); + // helper.getNode("n1").last.then(function(last) { + // last.should.equal(0); + // done(); + // }); + // }); + // }); + // }); + // + // describe('backward compatiblity', function() { + // it('should be valid', function(done) { + // var flow = [{"id": "n1", "type": "pushbullet", "chan": "", "title": "topic"}, + // {id:"n3", type:"helper", wires: [["n1"]]}]; + // helper.load(pushbulletNode, flow, {n1:{pushkey:"key", deviceid: "dev"}}, function() { + // var func = sinon.spy(currentPB, "note"); + // helper.getNode("n3").send({ + // payload: "my note", + // }); + // sinon.assert.calledWith(func, "dev", "topic", "my note"); // done(); // }); // }); // }); - - // describe('tickle', function() { - // it('note', function(done) { - // var flow = [{id:"n1", type:"pushbullet-config"}, - // {id:"n2", type:"pushbullet in", config: "n1", wires: [["n3"]]}, - // {id:"n3", type:"helper"}]; // + // describe('defaults and msg optionals', function() { + // it('defaults', function(done) { + // var flow = [{id:"n1", type:"pushbullet-config"}, + // {id:"n2", type:"pushbullet", config: "n1"}, + // {id:"n3", type:"helper", wires: [["n2"]]}]; // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { - // helper.getNode("n3").on("input", function(msg) { - // msg.should.have.property("pushtype", "note"); - // msg.should.have.property("payload", "body"); - // msg.should.have.property("topic", "title"); - // msg.should.have.property("data"); + // var func = sinon.spy(currentPB, "note"); + // helper.getNode("n3").send({ + // payload: "my note", + // }); + // helper.getNode("n1").me.then(function(){ + // sinon.assert.calledWith(func, "john.doe@noma.il", "Node-RED", "my note"); // done(); // }); - // var func = sinon.stub(currentPB, "history"); - // currentPB.streamEmitter.emit("message", {type: "tickle", subtype: "push"}); - // func.yields(false, getPushReply('note')); + // }); + // }); + // + // it('no overrides', function(done) { + // var flow = [{id:"n1", type:"pushbullet-config"}, + // {id:"n2", type:"pushbullet", config: "n1", pushtype: "note", title: "title"}, + // {id:"n3", type:"helper", wires: [["n2"]]}]; + // + // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2: {deviceid: "id"}}, function() { + // var func = sinon.spy(currentPB, "note"); + // helper.getNode("n3").send({ + // payload: "my note", + // }); + // sinon.assert.calledWith(func, "id", "title", "my note"); + // done(); + // }); + // }); + // + // it('channel', function(done) { + // var flow = [{id:"n1", type:"pushbullet-config"}, + // {id:"n2", type:"pushbullet", config: "n1", pushtype: "note", title: "title", chan: "mychannel"}, + // {id:"n3", type:"helper", wires: [["n2"]]}]; + // + // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2: {deviceid: "id"}}, function() { + // var func = sinon.spy(currentPB, "note"); + // helper.getNode("n3").send({ + // payload: "my note", + // }); + // sinon.assert.calledWith(func, {channel_tag: "mychannel"}, "title", "my note"); + // done(); + // }); + // }); + // + // it('channel from msg', function(done) { + // var flow = [{id:"n1", type:"pushbullet-config"}, + // {id:"n2", type:"pushbullet", config: "n1", pushtype: "note", title: "title"}, + // {id:"n3", type:"helper", wires: [["n2"]]}]; + // + // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2: {deviceid: "id"}}, function() { + // var func = sinon.spy(currentPB, "note"); + // helper.getNode("n3").send({ + // payload: "my note", + // channel: "mychannel" + // }); + // sinon.assert.calledWith(func, {channel_tag: "mychannel"}, "title", "my note"); + // done(); + // }); + // }); + // + // it('all optionals but defined in node', function(done) { + // var flow = [{id:"n1", type:"pushbullet-config"}, + // {id:"n2", type:"pushbullet", config: "n1", pushtype: "link", title: "title"}, + // {id:"n3", type:"helper", wires: [["n2"]]}]; + // + // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2: {deviceid: "id"}}, function() { + // var func = sinon.spy(currentPB, "push"); + // helper.getNode("n3").send({ + // deviceid: "over1", + // topic: "over2", + // pushtype: "note", + // payload: "payload" + // }); + // sinon.assert.calledWith(func, "id", {type: "link", body: undefined, title:"title", url: "payload"}); + // done(); + // }); + // }); + // + // it('all optionals', function(done) { + // var flow = [{id:"n1", type:"pushbullet-config"}, + // {id:"n2", type:"pushbullet", config: "n1", pushtype: "", title: ""}, + // {id:"n3", type:"helper", wires: [["n2"]]}]; + // + // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2: {deviceid: "_msg_"}}, function() { + // var func = sinon.spy(currentPB, "push"); + // helper.getNode("n3").send({ + // deviceid: "over1", + // topic: "over2", + // payload: "over3", + // pushtype: "link" + // }); + // sinon.assert.calledWith(func, "over1", {type: "link", body: undefined, title: "over2", url: "over3"}); + // done(); + // }); + // }); + // }); + // + // describe('output', function() { + // it('note', function(done) { + // var flow = [{id:"n1", type:"pushbullet-config"}, + // {id:"n2", type:"pushbullet", config: "n1", pushtype: "note", title: "title"}, + // {id:"n3", type:"helper", wires: [["n2"]]} + // ]; + // + // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2: {deviceid: "id"}}, function() { + // var func = sinon.spy(currentPB, "note"); + // helper.getNode("n3").send({ + // payload: "my note", + // }); + // sinon.assert.calledWith(func, "id", "title", "my note"); + // done(); // }); // }); // // it('link', function(done) { // var flow = [{id:"n1", type:"pushbullet-config"}, - // {id:"n2", type:"pushbullet in", config: "n1", wires: [["n3"]]}, - // {id:"n3", type:"helper"}]; + // {id:"n2", type:"pushbullet", config: "n1", pushtype: "link", title: "title"}, + // {id:"n3", type:"helper", wires: [["n2"]]} + // ]; // - // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { - // helper.getNode("n3").on("input", function(msg) { - // msg.should.have.property("pushtype", "link"); - // msg.should.have.property("payload", "url"); - // msg.should.have.property("topic", "title"); - // msg.should.have.property("data"); - // done(); + // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2: {deviceid: "id"}}, function() { + // var func = sinon.spy(currentPB, "push"); + // helper.getNode("n3").send({ + // payload: "http://link", + // message: "message" // }); - // var func = sinon.stub(currentPB, "history"); - // currentPB.streamEmitter.emit("message", {type: "tickle", subtype: "push"}); - // func.yields(false, getPushReply('link')); - // }); - // }); - // - // it('address', function(done) { - // var flow = [{id:"n1", type:"pushbullet-config"}, - // {id:"n2", type:"pushbullet in", config: "n1", wires: [["n3"]]}, - // {id:"n3", type:"helper"}]; - // - // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { - // helper.getNode("n3").on("input", function(msg) { - // msg.should.have.property("pushtype", "address"); - // msg.should.have.property("payload", "address"); - // msg.should.have.property("topic", "title"); - // msg.should.have.property("data"); - // done(); - // }); - // var func = sinon.stub(currentPB, "history"); - // currentPB.streamEmitter.emit("message", {type: "tickle", subtype: "push"}); - // func.yields(false, getPushReply('address')); - // }); - // }); - // - // it('file', function(done) { - // var flow = [{id:"n1", type:"pushbullet-config"}, - // {id:"n2", type:"pushbullet in", config: "n1", wires: [["n3"]]}, - // {id:"n3", type:"helper"}]; - // - // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { - // helper.getNode("n3").on("input", function(msg) { - // msg.should.have.property("pushtype", "file"); - // msg.should.have.property("payload", "fileurl"); - // msg.should.have.property("topic", "filename"); - // msg.should.have.property("data"); - // done(); - // }); - // var func = sinon.stub(currentPB, "history"); - // currentPB.streamEmitter.emit("message", {type: "tickle", subtype: "push"}); - // func.yields(false, getPushReply('file')); + // sinon.assert.calledWith(func, "id", {type: "link", title: "title", url: "http://link", body: "message"}); + // done(); // }); // }); // // it('list', function(done) { // var flow = [{id:"n1", type:"pushbullet-config"}, - // {id:"n2", type:"pushbullet in", config: "n1", wires: [["n3"]]}, - // {id:"n3", type:"helper"}]; + // {id:"n2", type:"pushbullet", config: "n1", pushtype: "list", title: "title"}, + // {id:"n3", type:"helper", wires: [["n2"]]} + // ]; // - // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { - // helper.getNode("n3").on("input", function(msg) { - // msg.should.have.property("pushtype", "list"); - // msg.should.have.property("topic", "title"); - // msg.should.have.property("payload").with.length(3); - // msg.should.have.property("data"); - // done(); + // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2: {deviceid: "id"}}, function() { + // var func = sinon.spy(currentPB, "list"); + // helper.getNode("n3").send({ + // payload: ["a", "b", "c"], // }); - // var func = sinon.stub(currentPB, "history"); - // currentPB.streamEmitter.emit("message", {type: "tickle", subtype: "push"}); - // func.yields(false, getPushReply('list')); + // sinon.assert.calledWith(func, "id", "title"); + // func.getCall(0).args[2].should.have.length(3); + // + // done(); // }); // }); // - // it('delete', function(done) { + // it('list string', function(done) { // var flow = [{id:"n1", type:"pushbullet-config"}, - // {id:"n2", type:"pushbullet in", config: "n1", wires: [["n3"]]}, - // {id:"n3", type:"helper"}]; + // {id:"n2", type:"pushbullet", config: "n1", pushtype: "list", title: "title"}, + // {id:"n3", type:"helper", wires: [["n2"]]} + // ]; // - // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { - // helper.getNode("n3").on("input", function(msg) { - // msg.should.have.property("pushtype", "delete"); - // msg.should.have.property("payload", "pjgzwwocCCy"); - // msg.should.have.property("data"); - // done(); + // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2: {deviceid: "id"}}, function() { + // var func = sinon.spy(currentPB, "list"); + // helper.getNode("n3").send({ + // payload: '["a", "b", "c"]', // }); - // var func = sinon.stub(currentPB, "history"); - // currentPB.streamEmitter.emit("message", {type: "tickle", subtype: "push"}); - // func.yields(false, getPushReply('delete')); + // sinon.assert.calledWith(func, "id", "title"); + // func.getCall(0).args[2].should.have.length(3); + // + // done(); // }); // }); // - // it('dismissed', function(done) { + // it('address', function(done) { // var flow = [{id:"n1", type:"pushbullet-config"}, - // {id:"n2", type:"pushbullet in", config: "n1", wires: [["n3"]]}, - // {id:"n3", type:"helper"}]; + // {id:"n2", type:"pushbullet", config: "n1", pushtype: "address", title: "title"}, + // {id:"n3", type:"helper", wires: [["n2"]]} + // ]; // - // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { - // helper.getNode("n3").on("input", function(msg) { - // msg.should.have.property("pushtype", "dismissal"); - // msg.should.have.property("payload", "xXxXxXxXxXxsjArqXRsaZM"); - // msg.should.have.property("data"); - // done(); + // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2: {deviceid: "id"}}, function() { + // var func = sinon.spy(currentPB, "address"); + // helper.getNode("n3").send({ + // payload: "My Street 4", // }); - // var func = sinon.stub(currentPB, "history"); - // currentPB.streamEmitter.emit("message", {type: "tickle", subtype: "push"}); - // var rep = getPushReply('note'); - // rep.pushes[0].dismissed = true; - // func.yields(false, rep); + // sinon.assert.calledWith(func, "id", "title", "My Street 4"); + // done(); // }); // }); // - // it('filter', function(done) { + // it('file', function(done) { // var flow = [{id:"n1", type:"pushbullet-config"}, - // {id:"n2", type:"pushbullet in", config: "n1", wires: [["n3"]]}, - // {id:"n3", type:"helper"}]; + // {id:"n2", type:"pushbullet", config: "n1", pushtype: "file", title: "title"}, + // {id:"n3", type:"helper", wires: [["n2"]]} + // ]; // - // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2:{filters:['a', 'b']}}, function() { - // var counter = sinon.spy(); - // helper.getNode("n3").on("input", function(msg) { - // counter(); + // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2: {deviceid: "id"}}, function() { + // var func = sinon.spy(currentPB, "file"); + // var fn = path.join(__dirname, "data.js") + // helper.getNode("n3").send({ + // payload: fn, // }); - // - // var func = sinon.stub(currentPB, "history"); - // - // currentPB.streamEmitter.emit("message", {type: "tickle", subtype: "push"}); - // var msg0 = getPushReply('link'); msg0.pushes[0].source_device_iden = 'a'; - // func.onCall(0).yields(false, msg0); - // - // currentPB.streamEmitter.emit("message", {type: "tickle", subtype: "push"}); - // var msg1 = getPushReply('link'); msg1.pushes[0].source_device_iden = 'b'; - // func.onCall(1).yields(false, msg1); - // - // currentPB.streamEmitter.emit("message", {type: "tickle", subtype: "push"}); - // var msg2 = getPushReply('link'); msg2.pushes[0].source_device_iden = 'c'; - // func.onCall(2).yields(false, msg2); - // - // currentPB.streamEmitter.emit("message", {type: "tickle", subtype: "push"}); - // var msg3 = getPushReply('link'); - // delete msg3.pushes[0].source_device_iden; - // delete msg3.pushes[0].target_device_iden; - // func.onCall(3).yields(false, msg3); - // - // setTimeout(function() { - // counter.callCount.should.equal(3); - // done(); - // }, 100); + // sinon.assert.calledWith(func, "id", fn, "title"); + // done(); // }); // }); - }); + // + // it.skip("fail tests need updating for newer version of Sinon"); + // // it('should fail if file don\'t exist', function(done) { + // // var flow = [{id:"n1", type:"pushbullet-config"}, + // // {id:"n2", type:"pushbullet", config: "n1", pushtype: "file", title: "title"}, + // // {id:"n3", type:"helper", wires: [["n2"]]} + // // ]; + // // + // // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2: {deviceid: "id"}}, function() { + // // var func = sinon.spy(currentPB, "file"); + // // var errfn = sinon.spy(helper.getNode("n2"), "error"); + // // helper.getNode("n3").send({ + // // payload: "hello", + // // }); + // // func.called.should.fail; + // // errfn.callCount.should.be.above(0); + // // done(); + // // }); + // // }); + // + // it('raw', function(done) { + // var flow = [{id:"n1", type:"pushbullet-config"}, + // {id:"n2", type:"pushbullet", config: "n1"}, + // {id:"n3", type:"helper", wires: [["n2"]]} + // ]; + // + // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2: {deviceid: "id"}}, function() { + // var func = sinon.spy(currentPB, "push"); + // helper.getNode("n3").send({ + // pushtype: '_raw_', + // raw: {type: 'note', title: 'title', body: 'this is the note'} + // }); + // sinon.assert.calledWith(func, "id", {type: 'note', title: 'title', body: 'this is the note'}); + // done(); + // }); + // }); + // + // it('raw update', function(done) { + // var flow = [{id:"n1", type:"pushbullet-config"}, + // {id:"n2", type:"pushbullet", config: "n1"}, + // {id:"n3", type:"helper", wires: [["n2"]]} + // ]; + // + // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2: {deviceid: "id"}}, function() { + // var func = sinon.spy(currentPB, "updatePush"); + // helper.getNode("n3").send({ + // pushtype: '_rawupdate_', + // raw: {items: [{checked:false, text: 'a'}]}, + // data: {iden: 'id'} + // }); + // sinon.assert.calledWith(func, "id", {items: [{checked:false, text: 'a'}]}); + // done(); + // }); + // }); + // }); + // + // describe('actions', function() { + // it.skip("input tests need updating for newer version of Sinon"); + // return; + // // it('delete', function(done) { + // // var flow = [{id:"n1", type:"pushbullet-config"}, + // // {id:"n2", type:"pushbullet", config: "n1", pushtype: "delete"}, + // // {id:"n3", type:"helper", wires: [["n2"]]} + // // ]; + // // + // // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { + // // var func = sinon.spy(currentPB, "deletePush"); + // // helper.getNode("n3").send({ + // // payload: "my note", + // // data: { iden: "delid"} + // // }); + // // sinon.assert.calledWith(func, "delid"); + // // done(); + // // }); + // // }); + // // + // // it('dismiss', function(done) { + // // var flow = [{id:"n1", type:"pushbullet-config"}, + // // {id:"n2", type:"pushbullet", config: "n1", pushtype: "dismissal"}, + // // {id:"n3", type:"helper", wires: [["n2"]]} + // // ]; + // // + // // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { + // // var func = sinon.spy(currentPB, "updatePush"); + // // helper.getNode("n3").send({ + // // payload: "my note", + // // data: { iden: "delid", dismissed: false } + // // }); + // // sinon.assert.calledWith(func, "delid"); + // // done(); + // // }); + // // }); + // // + // // it('update list', function(done) { + // // var flow = [{id:"n1", type:"pushbullet-config"}, + // // {id:"n2", type:"pushbullet", config: "n1", pushtype: "updatelist"}, + // // {id:"n3", type:"helper", wires: [["n2"]]} + // // ]; + // // + // // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { + // // var func = sinon.spy(currentPB, "updatePush"); + // // helper.getNode("n3").send({ + // // payload: [{}, {}, {}], + // // data: { iden: "delid", type: "list" } + // // }); + // // sinon.assert.calledWith(func, "delid"); + // // func.getCall(0).args[1].items.should.have.length(3); + // // done(); + // // }); + // // }); + // }); + // + // describe('input', function() { + // it.skip("input tests need updating for newer version of Sinon"); + // return; + // + // // describe('input', function() { + // // it('handles stream push', function(done) { + // // var flow = [{id:"n1", type:"pushbullet-config"}, + // // {id:"n2", type:"pushbullet in", config: "n1", wires: [["n3"]]}, + // // {id:"n3", type:"helper"}]; + // // + // // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { + // // helper.getNode("n3").on("input", function(msg) { + // // done(); + // // }); + // // currentPB.streamEmitter.emit("message", {type: "push", push: {type: "clip", body: "clipboard"}}) + // // }); + // // }); + // // + // // it('handles status', function(done) { + // // var flow = [{id:"n1", type:"pushbullet-config"}, + // // {id:"n2", type:"pushbullet in", config: "n1", wires: [["n3"]]}, + // // {id:"n3", type:"helper"}]; + // // + // // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { + // // //var func = sinon.spy(helper.getNode("n2"), 'status'); + // // currentPB.streamEmitter.emit("connect"); + // // currentPB.streamEmitter.emit("close"); + // // //currentPB.streamEmitter.emit("error"); + // // //func.callCount.should.equal(3); + // // done(); + // // }); + // // }); + // // + // // it('clipboard', function(done) { + // // var flow = [{id:"n1", type:"pushbullet-config"}, + // // {id:"n2", type:"pushbullet in", config: "n1", wires: [["n3"]]}, + // // {id:"n3", type:"helper"}]; + // // + // // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { + // // helper.getNode("n3").on("input", function(msg) { + // // msg.should.have.property("pushtype", "clip"); + // // msg.should.have.property("payload", "hello"); + // // msg.should.have.property("data"); + // // done(); + // // }); + // // currentPB.streamEmitter.emit("message", {type: "push", push: {type: "clip", body: "hello"}}); + // // }); + // // }); + // // + // // it('mirror', function(done) { + // // var flow = [{id:"n1", type:"pushbullet-config"}, + // // {id:"n2", type:"pushbullet in", config: "n1", wires: [["n3"]]}, + // // {id:"n3", type:"helper"}]; + // // + // // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { + // // helper.getNode("n3").on("input", function(msg) { + // // msg.should.have.property("pushtype", "mirror"); + // // msg.should.have.property("payload", "If you see this on your computer, mirroring is working!\n"); + // // msg.should.have.property("data"); + // // done(); + // // }); + // // currentPB.streamEmitter.emit("message", {type: "push", push: data.mirror}); + // // }); + // // }); + // // + // // it('dismissal', function(done) { + // // var flow = [{id:"n1", type:"pushbullet-config"}, + // // {id:"n2", type:"pushbullet in", config: "n1", wires: [["n3"]]}, + // // {id:"n3", type:"helper"}]; + // // + // // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { + // // helper.getNode("n3").on("input", function(msg) { + // // msg.should.have.property("pushtype", "dismissal"); + // // msg.should.have.property("payload", "pjgzwwocCCy"); + // // msg.should.have.property("data"); + // // done(); + // // }); + // // currentPB.streamEmitter.emit("message", {type: "push", push: data.dismissal}); + // // }); + // // }); + // // + // // it('unknown type', function(done) { + // // var flow = [{id:"n1", type:"pushbullet-config"}, + // // {id:"n2", type:"pushbullet in", config: "n1", wires: [["n3"]]}, + // // {id:"n3", type:"helper"}]; + // // + // // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { + // // var err = sinon.spy(helper.getNode("n1"), "error"); + // // currentPB.streamEmitter.emit("message", {type: "push", push: {type: "push", push: {type: "unknown", data: "test"}}}); + // // err.called.should.be.ok; + // // done(); + // // }); + // // }); + // // }); + // + // // describe('tickle', function() { + // // it('note', function(done) { + // // var flow = [{id:"n1", type:"pushbullet-config"}, + // // {id:"n2", type:"pushbullet in", config: "n1", wires: [["n3"]]}, + // // {id:"n3", type:"helper"}]; + // // + // // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { + // // helper.getNode("n3").on("input", function(msg) { + // // msg.should.have.property("pushtype", "note"); + // // msg.should.have.property("payload", "body"); + // // msg.should.have.property("topic", "title"); + // // msg.should.have.property("data"); + // // done(); + // // }); + // // var func = sinon.stub(currentPB, "history"); + // // currentPB.streamEmitter.emit("message", {type: "tickle", subtype: "push"}); + // // func.yields(false, getPushReply('note')); + // // }); + // // }); + // // + // // it('link', function(done) { + // // var flow = [{id:"n1", type:"pushbullet-config"}, + // // {id:"n2", type:"pushbullet in", config: "n1", wires: [["n3"]]}, + // // {id:"n3", type:"helper"}]; + // // + // // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { + // // helper.getNode("n3").on("input", function(msg) { + // // msg.should.have.property("pushtype", "link"); + // // msg.should.have.property("payload", "url"); + // // msg.should.have.property("topic", "title"); + // // msg.should.have.property("data"); + // // done(); + // // }); + // // var func = sinon.stub(currentPB, "history"); + // // currentPB.streamEmitter.emit("message", {type: "tickle", subtype: "push"}); + // // func.yields(false, getPushReply('link')); + // // }); + // // }); + // // + // // it('address', function(done) { + // // var flow = [{id:"n1", type:"pushbullet-config"}, + // // {id:"n2", type:"pushbullet in", config: "n1", wires: [["n3"]]}, + // // {id:"n3", type:"helper"}]; + // // + // // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { + // // helper.getNode("n3").on("input", function(msg) { + // // msg.should.have.property("pushtype", "address"); + // // msg.should.have.property("payload", "address"); + // // msg.should.have.property("topic", "title"); + // // msg.should.have.property("data"); + // // done(); + // // }); + // // var func = sinon.stub(currentPB, "history"); + // // currentPB.streamEmitter.emit("message", {type: "tickle", subtype: "push"}); + // // func.yields(false, getPushReply('address')); + // // }); + // // }); + // // + // // it('file', function(done) { + // // var flow = [{id:"n1", type:"pushbullet-config"}, + // // {id:"n2", type:"pushbullet in", config: "n1", wires: [["n3"]]}, + // // {id:"n3", type:"helper"}]; + // // + // // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { + // // helper.getNode("n3").on("input", function(msg) { + // // msg.should.have.property("pushtype", "file"); + // // msg.should.have.property("payload", "fileurl"); + // // msg.should.have.property("topic", "filename"); + // // msg.should.have.property("data"); + // // done(); + // // }); + // // var func = sinon.stub(currentPB, "history"); + // // currentPB.streamEmitter.emit("message", {type: "tickle", subtype: "push"}); + // // func.yields(false, getPushReply('file')); + // // }); + // // }); + // // + // // it('list', function(done) { + // // var flow = [{id:"n1", type:"pushbullet-config"}, + // // {id:"n2", type:"pushbullet in", config: "n1", wires: [["n3"]]}, + // // {id:"n3", type:"helper"}]; + // // + // // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { + // // helper.getNode("n3").on("input", function(msg) { + // // msg.should.have.property("pushtype", "list"); + // // msg.should.have.property("topic", "title"); + // // msg.should.have.property("payload").with.length(3); + // // msg.should.have.property("data"); + // // done(); + // // }); + // // var func = sinon.stub(currentPB, "history"); + // // currentPB.streamEmitter.emit("message", {type: "tickle", subtype: "push"}); + // // func.yields(false, getPushReply('list')); + // // }); + // // }); + // // + // // it('delete', function(done) { + // // var flow = [{id:"n1", type:"pushbullet-config"}, + // // {id:"n2", type:"pushbullet in", config: "n1", wires: [["n3"]]}, + // // {id:"n3", type:"helper"}]; + // // + // // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { + // // helper.getNode("n3").on("input", function(msg) { + // // msg.should.have.property("pushtype", "delete"); + // // msg.should.have.property("payload", "pjgzwwocCCy"); + // // msg.should.have.property("data"); + // // done(); + // // }); + // // var func = sinon.stub(currentPB, "history"); + // // currentPB.streamEmitter.emit("message", {type: "tickle", subtype: "push"}); + // // func.yields(false, getPushReply('delete')); + // // }); + // // }); + // // + // // it('dismissed', function(done) { + // // var flow = [{id:"n1", type:"pushbullet-config"}, + // // {id:"n2", type:"pushbullet in", config: "n1", wires: [["n3"]]}, + // // {id:"n3", type:"helper"}]; + // // + // // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}}, function() { + // // helper.getNode("n3").on("input", function(msg) { + // // msg.should.have.property("pushtype", "dismissal"); + // // msg.should.have.property("payload", "xXxXxXxXxXxsjArqXRsaZM"); + // // msg.should.have.property("data"); + // // done(); + // // }); + // // var func = sinon.stub(currentPB, "history"); + // // currentPB.streamEmitter.emit("message", {type: "tickle", subtype: "push"}); + // // var rep = getPushReply('note'); + // // rep.pushes[0].dismissed = true; + // // func.yields(false, rep); + // // }); + // // }); + // // + // // it('filter', function(done) { + // // var flow = [{id:"n1", type:"pushbullet-config"}, + // // {id:"n2", type:"pushbullet in", config: "n1", wires: [["n3"]]}, + // // {id:"n3", type:"helper"}]; + // // + // // helper.load(pushbulletNode, flow, {n1:{apikey:"invalid"}, n2:{filters:['a', 'b']}}, function() { + // // var counter = sinon.spy(); + // // helper.getNode("n3").on("input", function(msg) { + // // counter(); + // // }); + // // + // // var func = sinon.stub(currentPB, "history"); + // // + // // currentPB.streamEmitter.emit("message", {type: "tickle", subtype: "push"}); + // // var msg0 = getPushReply('link'); msg0.pushes[0].source_device_iden = 'a'; + // // func.onCall(0).yields(false, msg0); + // // + // // currentPB.streamEmitter.emit("message", {type: "tickle", subtype: "push"}); + // // var msg1 = getPushReply('link'); msg1.pushes[0].source_device_iden = 'b'; + // // func.onCall(1).yields(false, msg1); + // // + // // currentPB.streamEmitter.emit("message", {type: "tickle", subtype: "push"}); + // // var msg2 = getPushReply('link'); msg2.pushes[0].source_device_iden = 'c'; + // // func.onCall(2).yields(false, msg2); + // // + // // currentPB.streamEmitter.emit("message", {type: "tickle", subtype: "push"}); + // // var msg3 = getPushReply('link'); + // // delete msg3.pushes[0].source_device_iden; + // // delete msg3.pushes[0].target_device_iden; + // // func.onCall(3).yields(false, msg3); + // // + // // setTimeout(function() { + // // counter.callCount.should.equal(3); + // // done(); + // // }, 100); + // // }); + // // }); + // }); }); diff --git a/test/utility/exif/94-exif_spec.js b/test/utility/exif/94-exif_spec.js index dadca1c6..1e2efd37 100644 --- a/test/utility/exif/94-exif_spec.js +++ b/test/utility/exif/94-exif_spec.js @@ -2,7 +2,7 @@ var should = require("should"); var sinon = require('sinon'); //var fs = require("fs"); -var helper = require('../../../test/helper.js'); +var helper = require("node-red-node-test-helper"); var exifNode = require('../../../utility/exif/94-exif.js'); describe('exif node', function() { @@ -26,7 +26,7 @@ describe('exif node', function() { //var data = fs.readFileSync("test/utility/exif/exif_test_image.jpg", null); // extracting genuine exif data to be fed back as the result of the stubbed ExifImage constructor //var data = fs.readFileSync("exif_test_image.jpg", null); // extracting genuine exif data to be fed back as the result of the stubbed ExifImage constructor var flow = [{id:"exifNode1", type:"exif", wires:[["helperNode1"]]}, - {id:"helperNode1", type:"helper"}]; + {id:"helperNode1", type:"helper"}]; var gpsmsg = { gps: { GPSLatitudeRef: 'N', GPSLatitude: [ 50, 57, 22.4697 ], @@ -40,7 +40,7 @@ describe('exif node', function() { GPSProcessingMethod: 'ASCII\u0000\u0000\u0000FUSED', GPSDateStamp: '2014:06:10' } }; - var spy = sinon.stub(exif, 'ExifImage', function(arg1,arg2) { arg2(null,gpsmsg); }); + var spy = sinon.stub(exif, 'ExifImage').callsFake(function(arg1,arg2) { arg2(null,gpsmsg); }); helper.load(exifNode, flow, function() { var exifNode1 = helper.getNode("exifNode1"); @@ -65,7 +65,7 @@ describe('exif node', function() { //var data = fs.readFileSync("test/utility/exif/exif_test_image.jpg", null); // extracting genuine exif data to be fed back as the result of the stubbed ExifImage constructor //var data = fs.readFileSync("exif_test_image.jpg", null); // extracting genuine exif data to be fed back as the result of the stubbed ExifImage constructor var flow = [{id:"exifNode1", type:"exif", wires:[["helperNode1"]]}, - {id:"helperNode1", type:"helper"}]; + {id:"helperNode1", type:"helper"}]; var gpsmsg = { gps: { GPSLatitudeRef: 'S', GPSLatitude: [ 50, 57, 22.4697 ], @@ -77,7 +77,7 @@ describe('exif node', function() { GPSProcessingMethod: 'ASCII\u0000\u0000\u0000FUSED', GPSDateStamp: '2014:06:10' } }; - var spy = sinon.stub(exif, 'ExifImage', function(arg1,arg2) { arg2(null,gpsmsg); }); + var spy = sinon.stub(exif, 'ExifImage').callsFake(function(arg1,arg2) { arg2(null,gpsmsg); }); helper.load(exifNode, flow, function() { var exifNode1 = helper.getNode("exifNode1"); @@ -94,41 +94,6 @@ describe('exif node', function() { }); }); - it('should report if no data found', function(done) { - var exif = require('exif'); - var ExifImage = exif.ExifImage; - // the jpg file is a single black dot but it was originally a photo taken at IBM Hursley - //console.log(process.cwd()); - //var data = fs.readFileSync("test/utility/exif/exif_test_image2.jpg", null); // extracting genuine exif data to be fed back as the result of the stubbed ExifImage constructor - //var data = fs.readFileSync("exif_test_image2.jpg", null); // extracting genuine exif data to be fed back as the result of the stubbed ExifImage constructor - var flow = [{id:"exifNode1", type:"exif", wires:[["helperNode1"]]}, - {id:"helperNode1", type:"helper"}]; - - var gpsmsg = {}; - var spy = sinon.stub(exif, 'ExifImage', - function(arg1,arg2){ - arg2(null,gpsmsg); - }); - - helper.load(exifNode, flow, function() { - var exifNode1 = helper.getNode("exifNode1"); - var helperNode1 = helper.getNode("helperNode1"); - - setTimeout(function() { - var logEvents = helper.log().args.filter(function(evt) { - return evt[0].type == "exif"; - }); - logEvents.should.have.length(1); - logEvents[0][0].should.have.a.property('msg'); - logEvents[0][0].msg.toString().should.startWith("The incoming image did not contain Exif GPS"); - exif.ExifImage.restore(); - done(); - },150); - - exifNode1.receive({payload:new Buffer.from("hello")}); - }); - }); - it('should report if not a jpeg', function(done) { var exif = require('exif'); var ExifImage = exif.ExifImage; @@ -136,7 +101,7 @@ describe('exif node', function() { var data = new Buffer.from("hello"); var eD; var flow = [{id:"exifNode1", type:"exif", wires:[["helperNode1"]]}, - {id:"helperNode1", type:"helper"}]; + {id:"helperNode1", type:"helper"}]; helper.load(exifNode, flow, function() { var exifNode1 = helper.getNode("exifNode1"); @@ -162,7 +127,7 @@ describe('exif node', function() { var data = "hello"; var eD; var flow = [{id:"exifNode1", type:"exif", wires:[["helperNode1"]]}, - {id:"helperNode1", type:"helper"}]; + {id:"helperNode1", type:"helper"}]; helper.load(exifNode, flow, function() { var exifNode1 = helper.getNode("exifNode1"); @@ -188,7 +153,7 @@ describe('exif node', function() { var data = new Buffer.from("hello"); var eD; var flow = [{id:"exifNode1", type:"exif", wires:[["helperNode1"]]}, - {id:"helperNode1", type:"helper"}]; + {id:"helperNode1", type:"helper"}]; helper.load(exifNode, flow, function() { var exifNode1 = helper.getNode("exifNode1"); @@ -214,7 +179,7 @@ describe('exif node', function() { var data = new Buffer.from("hello"); var eD; var flow = [{id:"exifNode1", type:"exif", wires:[["helperNode1"]]}, - {id:"helperNode1", type:"helper"}]; + {id:"helperNode1", type:"helper"}]; var gpsmsg = { gps: { GPSLatitudeRef: 'N', GPSLatitude: [ 50, 57 ], @@ -224,7 +189,7 @@ describe('exif node', function() { GPSAltitude: 50, GPSTimeStamp: [ 7, 32, 2 ] } }; - var spy = sinon.stub(exif, 'ExifImage', + var spy = sinon.stub(exif, 'ExifImage').callsFake( function(arg1,arg2){ arg2(null,gpsmsg); }); @@ -254,7 +219,7 @@ describe('exif node', function() { var data = new Buffer.from("hello"); var eD; var flow = [{id:"exifNode1", type:"exif", wires:[["helperNode1"]]}, - {id:"helperNode1", type:"helper"}]; + {id:"helperNode1", type:"helper"}]; var gpsmsg = { gps: { GPSLatitudeRef: 'N', GPSLatitude: [ 50, 57, 1.3 ], @@ -264,7 +229,7 @@ describe('exif node', function() { GPSAltitude: 50, GPSTimeStamp: [ 7, 32, 2 ] } }; - var spy = sinon.stub(exif, 'ExifImage', + var spy = sinon.stub(exif, 'ExifImage').callsFake( function(arg1,arg2){ arg2(null,gpsmsg); }); @@ -294,7 +259,7 @@ describe('exif node', function() { var data = new Buffer.from("hello"); var eD; var flow = [{id:"exifNode1", type:"exif", wires:[["helperNode1"]]}, - {id:"helperNode1", type:"helper"}]; + {id:"helperNode1", type:"helper"}]; var gpsmsg = { gps: { GPSLatitudeRef: 'N', GPSLatitude: [ 50, 57, 1.3 ], @@ -302,7 +267,7 @@ describe('exif node', function() { GPSAltitude: 50, GPSTimeStamp: [ 7, 32, 2 ] } }; - var spy = sinon.stub(exif, 'ExifImage', + var spy = sinon.stub(exif, 'ExifImage').callsFake( function(arg1,arg2){ arg2(null,gpsmsg); }); @@ -326,6 +291,4 @@ describe('exif node', function() { }); }); - - }); diff --git a/time/suncalc/79-suncalc.html b/time/suncalc/79-suncalc.html index 883bd5a6..16689f3e 100644 --- a/time/suncalc/79-suncalc.html +++ b/time/suncalc/79-suncalc.html @@ -1,5 +1,5 @@ - - diff --git a/time/suncalc/79-suncalc.js b/time/suncalc/79-suncalc.js index 09e10b10..f985c3d1 100644 --- a/time/suncalc/79-suncalc.js +++ b/time/suncalc/79-suncalc.js @@ -9,20 +9,44 @@ module.exports = function(RED) { this.lon = n.lon; this.start = n.start; this.end = n.end; + this.soff = (n.soff || 0) * 60000; // minutes + this.eoff = (n.eoff || 0) * 60000; // minutes var node = this; var oldval = null; - this.tick = setInterval(function() { + var tick = function() { var now = new Date(); var times = SunCalc.getTimes(now, node.lat, node.lon); var nowMillis = Date.UTC(now.getUTCFullYear(),now.getUTCMonth(),now.getUTCDate(),now.getUTCHours(),now.getUTCMinutes()); var startMillis = Date.UTC(times[node.start].getUTCFullYear(),times[node.start].getUTCMonth(),times[node.start].getUTCDate(),times[node.start].getUTCHours(),times[node.start].getUTCMinutes()); var endMillis = Date.UTC(times[node.end].getUTCFullYear(),times[node.end].getUTCMonth(),times[node.end].getUTCDate(),times[node.end].getUTCHours(),times[node.end].getUTCMinutes()); - var e1 = nowMillis - startMillis; - var e2 = nowMillis - endMillis; - var moon = parseInt(SunCalc.getMoonIllumination(now).fraction * 100 + 0.5) / 100; - var msg = {payload:0, topic:"sun", moon:moon}; + var e1 = nowMillis - startMillis - node.soff; + var e2 = nowMillis - endMillis - node.eoff; + var s1 = new Date(startMillis + node.soff); + var s2 = new Date(endMillis + node.eoff); + if (isNaN(e1)) { e1 = 1; } + if (isNaN(e2)) { e2 = -1; } + var moon = SunCalc.getMoonIllumination(now); + var moon2 = SunCalc.getMoonPosition(now, node.lat, node.lon); + moon = Object.assign(moon, moon2); + moon.altitude = moon.altitude * 180 / Math.PI; + moon.azimuth = moon.azimuth * 180 / Math.PI; + moon.parallacticAngle = moon.parallacticAngle * 180 /Math.PI; + moon.icon = "new"; + if (moon.phase > 0.02) { moon.icon = "wax-cres"} + if (moon.phase > 0.22) { moon.icon = "first-quart"} + if (moon.phase > 0.28) { moon.icon = "wax-gibb"} + if (moon.phase > 0.48) { moon.icon = "full"} + if (moon.phase > 0.52) { moon.icon = "wan-gibb"} + if (moon.phase > 0.72) { moon.icon = "third-quart"} + if (moon.phase > 0.78) { moon.icon = "wan-cres"} + if (moon.phase > 0.98) { moon.icon = "new"} + moon.icon = "wi-moon-" + moon.icon; + var sun = SunCalc.getPosition(now, node.lat, node.lon); + sun.altitude = sun.altitude * 180 / Math.PI; + sun.azimuth = sun.azimuth * 180 / Math.PI; + var msg = {payload:0, topic:"sun", sun:sun, moon:moon, start:s1, end:s2, now:now}; if ((e1 > 0) & (e2 < 0)) { msg.payload = 1; } if (oldval == null) { oldval = msg.payload; } if (msg.payload == 1) { node.status({fill:"yellow",shape:"dot",text:"day"}); } @@ -32,10 +56,14 @@ module.exports = function(RED) { node.send([msg,msg]); } else { node.send(msg); } - }, 60000); + } + + this.tick = setInterval(function() { tick(); }, 60000); + this.tock = setTimeout(function() { tick(); }, 500); this.on("close", function() { - clearInterval(this.tick); + if (this.tock) { clearTimeout(this.tock); } + if (this.tick) { clearInterval(this.tick); } }); } RED.nodes.registerType("sunrise",SunNode); diff --git a/time/suncalc/README.md b/time/suncalc/README.md index 51de9d25..50f8fb6e 100644 --- a/time/suncalc/README.md +++ b/time/suncalc/README.md @@ -6,10 +6,11 @@ A Node-RED node to provide a sign Install ------- -Run the following command in your Node-RED user directory - typically `~/.node-red` +Either use the `Node-RED Menu - Manage Palette - Install`, or run the following command in your Node-RED user directory - typically `~/.node-red` npm install node-red-node-suncalc +**Breaking Change** - in version 1.0 the `msg.moon` property is now an object not a number - containing a lot more information. Usage ----- @@ -19,10 +20,13 @@ Uses the suncalc npm to generate an output at sunrise and sunset based on a spec Several choices of definition of sunrise and sunset are available, see the suncalc module for details. +The start and end times can be offset by a number of minutes before (minus) or after (plus) the chosen event time. + The node provide two outputs. The first output emits a `msg.payload` of 1 or 0 every minute depending if day-time (1) or night-time (0). The second output emits only on the transition between night to day (-> 1) or day to night (-> 0). -It also sets the `msg.topic` to sun and `msg.moon` to the fraction of the moon currently visible -(a value between 0 for no moon and 1 for full moon).

+It also outputs msg.start, msg.end and msg.now which are todays start and end times, with offsets applied, in ISO format, and the current ISO time. + +`msg.sun` is an object containing the azimuth and altitude, in degrees, of the current sun position. `msg.moon` is an object containing its position, phase, illumination and icon. diff --git a/time/suncalc/package.json b/time/suncalc/package.json index fe538b73..f16f91d5 100644 --- a/time/suncalc/package.json +++ b/time/suncalc/package.json @@ -1,6 +1,6 @@ { "name" : "node-red-node-suncalc", - "version" : "0.0.10", + "version" : "1.0.1", "description" : "A Node-RED node to provide a signal at sunrise and sunset", "dependencies" : { "suncalc" : "^1.8.0" diff --git a/time/timeswitch/package.json b/time/timeswitch/package.json index 4982fd55..58a628cd 100644 --- a/time/timeswitch/package.json +++ b/time/timeswitch/package.json @@ -1,6 +1,6 @@ { "name" : "node-red-node-timeswitch", - "version" : "0.0.6", + "version" : "0.0.7", "description" : "A Node-RED node to provide a simple timeswitch to schedule daily on/off events.", "dependencies" : { "suncalc": "1.6.0" diff --git a/time/timeswitch/timeswitch.html b/time/timeswitch/timeswitch.html index 16c00658..1f4a1f92 100644 --- a/time/timeswitch/timeswitch.html +++ b/time/timeswitch/timeswitch.html @@ -291,7 +291,7 @@ } RED.nodes.registerType('timeswitch',{ - category: 'advanced-input', + category: 'time', color:"#6699ff", defaults: { name: {value:""}, diff --git a/utility/annotate-image/LICENSE b/utility/annotate-image/LICENSE new file mode 100644 index 00000000..335c35ff --- /dev/null +++ b/utility/annotate-image/LICENSE @@ -0,0 +1,13 @@ +Copyright 2020 OpenJS Foundation and other contributors, https://openjsf.org/ + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/utility/annotate-image/README.md b/utility/annotate-image/README.md new file mode 100644 index 00000000..de17bc47 --- /dev/null +++ b/utility/annotate-image/README.md @@ -0,0 +1,72 @@ +node-red-node-annotate-image +================== + +A Node-RED node that can annotate +a JPEG image. + +The node is currently limited to drawing rectangles and circles over the image. +That can be used, for example, to annotate an image with bounding boxes of features +detected in the image by a TensorFlow node. + +Install +------- + +Run the following command in your Node-RED user directory - typically `~/.node-red` + + npm install node-red-node-annotate-image + + +Usage +----- + +The JPEG image should be passed to the node as a Buffer object under `msg.payload`. + +The annotations are provided in msg.annotations and are applied in order. + +Each annotation is an object with the following properties: + + - `type` (*string*) : the type of the annotation - `rect` or `circle` + - `x`/`y` (*number*) : the top-left corner of a `rect` annotation, or the center of a `circle` annotation. + - `w`/`h` (*number*) : the width and height of a `rect` annotation + - `r` (*number*) : the radius of a `circle` annotation + - `bbox` (*array*) : this can be used instead of `x`, `y`, `w`, `h` and `r`. + It should be an array of four values giving the bounding box of the annotation: + `[x, y, w, h]`. If this property is set and `type` is not set, it will default to `rect`. + - `label` (*string*) : an optional piece of text to label the annotation with + - `stroke` (*string*) : the line color of the annotation. Default: `#ffC000` + - `lineWidth` (*number*) : the stroke width used to draw the annotation. Default: `5` + - `fontSize` (*number*) : the font size to use for the label. Default: `24` + - `fontColor` (*string*) : the color of the font to use for the label. Default: `#ffC000` + + +Examples +-------- + +```javascript +msg.annotations = [ { + type: "rect", + x: 10, y: 10, w: 50, h: 50, + label: "hello" +}] +``` +```javascript +msg.annotations = [ + { + type: "circle", + x: 50, y: 50, r: 20, + lineWidth: 10 + + }, + { + type: "rect", + x: 30, y: 30, w: 40, h: 40, + stroke: "blue" + } +] +``` +```javascript +msg.annotations = [ { + type: "rect", + bbox: [ 10, 10, 50, 50] +}] +``` diff --git a/utility/annotate-image/SourceSansPro-Regular.ttf b/utility/annotate-image/SourceSansPro-Regular.ttf new file mode 100644 index 00000000..24962c7c Binary files /dev/null and b/utility/annotate-image/SourceSansPro-Regular.ttf differ diff --git a/utility/annotate-image/annotate.html b/utility/annotate-image/annotate.html new file mode 100644 index 00000000..f87a76b6 --- /dev/null +++ b/utility/annotate-image/annotate.html @@ -0,0 +1,166 @@ + + + + + + diff --git a/utility/annotate-image/annotate.js b/utility/annotate-image/annotate.js new file mode 100644 index 00000000..2b1b35e6 --- /dev/null +++ b/utility/annotate-image/annotate.js @@ -0,0 +1,160 @@ +module.exports = function(RED) { + "use strict"; + const pureimage = require("pureimage"); + const Readable = require("stream").Readable; + const Writable = require("stream").Writable; + const path = require("path"); + + let fontLoaded = false; + function loadFont() { + if (!fontLoaded) { + const fnt = pureimage.registerFont(path.join(__dirname,'./SourceSansPro-Regular.ttf'),'Source Sans Pro'); + fnt.load(); + fontLoaded = true; + } + } + + function AnnotateNode(n) { + RED.nodes.createNode(this,n); + var node = this; + const defaultFill = n.fill || ""; + const defaultStroke = n.stroke || "#ffC000"; + const defaultLineWidth = parseInt(n.lineWidth) || 5; + const defaultFontSize = n.fontSize || 24; + const defaultFontColor = n.fontColor || "#ffC000" + loadFont(); + + this.on("input", function(msg) { + if (Buffer.isBuffer(msg.payload)) { + if (msg.payload[0] !== 0xFF || msg.payload[1] !== 0xD8) { + node.error("Not a JPEG image",msg); + } else if (Array.isArray(msg.annotations) && msg.annotations.length > 0) { + const stream = new Readable(); + stream.push(msg.payload); + stream.push(null); + pureimage.decodeJPEGFromStream(stream).then(img => { + const c = pureimage.make(img.width, img.height); + const ctx = c.getContext('2d'); + ctx.drawImage(img,0,0,img.width,img.height); + + ctx.lineJoin = 'bevel'; + + msg.annotations.forEach(function(annotation) { + ctx.fillStyle = annotation.fill || defaultFill; + ctx.strokeStyle = annotation.stroke || defaultStroke; + ctx.lineWidth = annotation.lineWidth || defaultLineWidth; + ctx.lineJoin = 'bevel'; + let x,y,r,w,h; + + if (!annotation.type && annotation.bbox) { + annotation.type = 'rect'; + } + + switch(annotation.type) { + case 'rect': + if (annotation.bbox) { + x = annotation.bbox[0] + y = annotation.bbox[1] + w = annotation.bbox[2] + h = annotation.bbox[3] + } else { + x = annotation.x + y = annotation.y + w = annotation.w + h = annotation.h + } + + if (x < 0) { + w += x; + x = 0; + } + if (y < 0) { + h += y; + y = 0; + } + ctx.beginPath(); + ctx.lineWidth = annotation.lineWidth || defaultLineWidth; + ctx.rect(x,y,w,h); + ctx.closePath(); + ctx.stroke(); + + if (annotation.label) { + ctx.font = `${annotation.fontSize || defaultFontSize}pt 'Source Sans Pro'`; + ctx.fillStyle = annotation.fontColor || defaultFontColor; + ctx.textBaseline = "top"; + ctx.textAlign = "left"; + ctx.fillText(annotation.label, x+2,y) + } + break; + case 'circle': + if (annotation.bbox) { + x = annotation.bbox[0] + annotation.bbox[2]/2 + y = annotation.bbox[1] + annotation.bbox[3]/2 + r = Math.min(annotation.bbox[2],annotation.bbox[3])/2; + } else { + x = annotation.x + y = annotation.y + r = annotation.r; + } + ctx.beginPath(); + ctx.lineWidth = annotation.lineWidth || defaultLineWidth; + ctx.arc(x,y,r,0,Math.PI*2); + ctx.closePath(); + ctx.stroke(); + if (annotation.label) { + ctx.font = `${annotation.fontSize || defaultFontSize}pt 'Source Sans Pro'`; + ctx.fillStyle = annotation.fontColor || defaultFontColor; + ctx.textBaseline = "middle"; + ctx.textAlign = "center"; + ctx.fillText(annotation.label, x+2,y) + } + break; + } + }); + const bufferOutput = getWritableBuffer(); + pureimage.encodeJPEGToStream(c,bufferOutput.stream,90).then(() => { + msg.payload = bufferOutput.getBuffer(); + node.send(msg); + }) + }).catch(err => { + node.error(err,msg); + }) + } else { + // No annotations to make - send the message on + node.send(msg); + } + } else { + node.error("Payload not a Buffer",msg) + } + return msg; + }); + } + RED.nodes.registerType("annotate-image",AnnotateNode); + + + + function getWritableBuffer() { + var currentSize = 0; + var buffer = null; + const stream = new Writable({ + write(chunk, encoding, callback) { + if (!buffer) { + buffer = Buffer.from(chunk); + } else { + var newBuffer = Buffer.allocUnsafe(currentSize + chunk.length); + buffer.copy(newBuffer); + chunk.copy(newBuffer,currentSize); + buffer = newBuffer; + } + currentSize += chunk.length + callback(); + } + }); + return { + stream: stream, + getBuffer: function() { + return buffer; + } + } + } +} diff --git a/utility/annotate-image/package.json b/utility/annotate-image/package.json new file mode 100644 index 00000000..48b164f3 --- /dev/null +++ b/utility/annotate-image/package.json @@ -0,0 +1,26 @@ +{ + "name": "node-red-node-annotate-image", + "version": "0.1.0", + "description": "A Node-RED node that can annotate an image", + "dependencies": { + "pureimage": "^0.2.5" + }, + "repository": { + "type": "git", + "url": "https://github.com/node-red/node-red-nodes/tree/master/utility/iamge-annotate" + }, + "license": "Apache-2.0", + "keywords": [ + "node-red" + ], + "node-red": { + "nodes": { + "annotate": "annotate.js" + } + }, + "contributors": [ + { + "name": "Nick O'Leary" + } + ] +} \ No newline at end of file diff --git a/utility/daemon/README.md b/utility/daemon/README.md index 2c46037b..57577643 100644 --- a/utility/daemon/README.md +++ b/utility/daemon/README.md @@ -13,7 +13,8 @@ Useful for monitoring command line based processes. Install ------- -Run the following command in your Node-RED user directory - typically `~/.node-red` +Either use the Editor - Menu - Manage Palette - Install option or +run the following command in your Node-RED user directory - typically `~/.node-red` npm i node-red-node-daemon diff --git a/utility/daemon/daemon.html b/utility/daemon/daemon.html index 6e7a5d8d..8b89688c 100644 --- a/utility/daemon/daemon.html +++ b/utility/daemon/daemon.html @@ -1,6 +1,6 @@ - - diff --git a/utility/daemon/daemon.js b/utility/daemon/daemon.js index ee2d045a..6d6546a6 100644 --- a/utility/daemon/daemon.js +++ b/utility/daemon/daemon.js @@ -11,7 +11,11 @@ module.exports = function(RED) { this.op = n.op; this.redo = n.redo; this.running = false; + this.closer = n.closer || "SIGKILL"; + this.autorun = true; + if (n.autorun === false) { this.autorun = false; } var node = this; + var lastmsg = {}; function inputlistener(msg) { if (msg != null) { @@ -31,63 +35,78 @@ module.exports = function(RED) { if (RED.settings.verbose) { node.log("inp: "+msg.payload); } if (node.child !== null && node.running) { node.child.stdin.write(msg.payload); } else { node.warn("Command not running"); } + lastmsg = msg; } } } function runit() { + var line = ""; if (!node.cmd || (typeof node.cmd !== "string") || (node.cmd.length < 1)) { node.status({fill:"grey",shape:"ring",text:"no command"}); return; } - node.child = spawn(node.cmd, node.args); - if (RED.settings.verbose) { node.log(node.cmd+" "+JSON.stringify(node.args)); } - node.status({fill:"green",shape:"dot",text:"running"}); - node.running = true; - var line = ""; + try { + node.child = spawn(node.cmd, node.args); + if (RED.settings.verbose) { node.log(node.cmd+" "+JSON.stringify(node.args)); } + node.status({fill:"green",shape:"dot",text:"running"}); + node.running = true; - node.child.stdout.on('data', function (data) { - if (node.op === "string") { data = data.toString(); } - if (node.op === "number") { data = Number(data); } - if (RED.settings.verbose) { node.log("out: "+data); } - if (node.op === "lines") { - line += data.toString(); - var bits = line.split("\n"); - while (bits.length > 1) { - node.send([{payload:bits.shift()},null,null]); + node.child.stdout.on('data', function (data) { + if (node.op === "string") { data = data.toString(); } + if (node.op === "number") { data = Number(data); } + if (RED.settings.verbose) { node.log("out: "+data); } + if (node.op === "lines") { + line += data.toString(); + var bits = line.split("\n"); + while (bits.length > 1) { + var m = RED.util.cloneMessage(lastmsg); + m.payload = bits.shift(); + console.log(m); + node.send([m,null,null]); + } + line = bits[0]; } - line = bits[0]; - } - else { - if (data && (data.length !== 0)) { - node.send([{payload:data},null,null]); + else { + if (data && (data.length !== 0)) { + lastmsg.payload = data; + node.send([lastmsg,null,null]); + } } - } - }); + }); - node.child.stderr.on('data', function (data) { - if (node.op === "string") { data = data.toString(); } - if (node.op === "number") { data = Number(data); } - if (RED.settings.verbose) { node.log("err: "+data); } - node.send([null,{payload:data},null]); - }); + node.child.stderr.on('data', function (data) { + if (node.op === "string") { data = data.toString(); } + if (node.op === "number") { data = Number(data); } + if (RED.settings.verbose) { node.log("err: "+data); } + lastmsg.payload = data; + node.send([null,lastmsg,null]); + }); - node.child.on('close', function (code,signal) { - if (RED.settings.verbose) { node.log("ret: "+code+":"+signal); } + node.child.on('close', function (code,signal) { + if (RED.settings.verbose) { node.log("ret: "+code+":"+signal); } + node.running = false; + node.child = null; + var rc = code; + if (code === null) { rc = signal; } + node.send([null,null,{payload:rc}]); + node.status({fill:"red",shape:"ring",text:"stopped"}); + }); + + node.child.on('error', function (err) { + if (err.errno === "ENOENT") { node.warn('Command not found'); } + else if (err.errno === "EACCES") { node.warn('Command not executable'); } + else { node.log('error: ' + err); } + node.status({fill:"red",shape:"ring",text:"error"}); + }); + } + catch(e) { + if (e.errno === "ENOENT") { node.warn('Command not found'); } + else if (e.errno === "EACCES") { node.warn('Command not executable'); } + else { node.error(e); } + node.status({fill:"red",shape:"ring",text:"error"}); node.running = false; - node.child = null; - var rc = code; - if (code === null) { rc = signal; } - node.send([null,null,{payload:rc}]); - node.status({fill:"red",shape:"ring",text:"stopped"}); - }); - - node.child.on('error', function (err) { - if (err.errno === "ENOENT") { node.warn('Command not found'); } - else if (err.errno === "EACCES") { node.warn('Command not executable'); } - else { node.log('error: ' + err); } - node.status({fill:"grey",shape:"dot",text:"error"}); - }); + } } if (node.redo === true) { @@ -101,13 +120,24 @@ module.exports = function(RED) { node.on("close", function(done) { clearInterval(loop); - if (node.child != null) { node.child.kill('SIGKILL'); } - if (RED.settings.verbose) { node.log(node.cmd+" stopped"); } + if (node.child != null) { + var tout; + node.child.on('exit', function() { + if (tout) { clearTimeout(tout); } + done(); + }); + tout = setTimeout(function() { + node.child.kill("SIGKILL"); // if it takes more than 3 secs kill it anyway. + done(); + }, 3000); + node.child.kill(node.closer); + if (RED.settings.verbose) { node.log(node.cmd+" stopped"); } + } + else { setTimeout(function() { done(); }, 100); } node.status({}); - setTimeout(function() { done(); }, 100); }); - runit(); + if (this.autorun) { runit(); } node.on("input", inputlistener); } diff --git a/utility/daemon/package.json b/utility/daemon/package.json index 018f0db9..308023c4 100644 --- a/utility/daemon/package.json +++ b/utility/daemon/package.json @@ -1,6 +1,6 @@ { "name" : "node-red-node-daemon", - "version" : "0.0.17", + "version" : "0.1.2", "description" : "A Node-RED node that runs and monitors a long running system command.", "dependencies" : { }, diff --git a/utility/exif/94-exif.html b/utility/exif/94-exif.html index 3b019849..3f7d99ac 100644 --- a/utility/exif/94-exif.html +++ b/utility/exif/94-exif.html @@ -1,17 +1,31 @@ - - diff --git a/utility/exif/94-exif.js b/utility/exif/94-exif.js index e4cbb887..0b1da20f 100644 --- a/utility/exif/94-exif.js +++ b/utility/exif/94-exif.js @@ -11,6 +11,9 @@ module.exports = function(RED) { function ExifNode(n) { RED.nodes.createNode(this,n); + this.mode = n.mode || "normal"; + if (this.mode === "worldmap") { this.property = "payload.content"; } + else { this.property = n.property || "payload"; } var node = this; /*** @@ -20,7 +23,7 @@ module.exports = function(RED) { * Assumes that the msg object will always have exifData available as msg.exif. * Assume that the GPS data saved into Exif provides a valid value */ - function addMsgLocationDataFromExifGPSData(msg) { + function addMsgLocationDataFromExifGPSData(msg,val) { var gpsData = msg.exif.gps; // declaring variable purely to make checks more readable if (gpsData.GPSAltitude) { /* istanbul ignore else */ @@ -31,14 +34,12 @@ module.exports = function(RED) { // The data provided in Exif is in degrees, minutes, seconds, this is to be converted into a single floating point degree if (gpsData.GPSLatitude.length === 3) { // OK to convert latitude if (gpsData.GPSLongitude.length === 3) { // OK to convert longitude - var latitude = convertDegreesMinutesSecondsToDecimals(gpsData.GPSLatitude[0], gpsData.GPSLatitude[1], gpsData.GPSLatitude[2]); latitude = Math.round(latitude * 100000)/100000; // 5dp is approx 1m resolution... // (N)orth means positive latitude, (S)outh means negative latitude if (gpsData.GPSLatitudeRef.toString() === 'S' || gpsData.GPSLatitudeRef.toString() === 's') { latitude = latitude * -1; } - var longitude = convertDegreesMinutesSecondsToDecimals(gpsData.GPSLongitude[0], gpsData.GPSLongitude[1], gpsData.GPSLongitude[2]); longitude = Math.round(longitude * 100000)/100000; // 5dp is approx 1m resolution... // (E)ast means positive longitude, (W)est means negative longitude @@ -49,7 +50,6 @@ module.exports = function(RED) { if (!msg.location) { msg.location = {}; } msg.location.lat = latitude; msg.location.lon = longitude; - return; } else { node.log("Invalid longitude data, no location information has been added to the message."); @@ -62,41 +62,74 @@ module.exports = function(RED) { else { node.log("The location of this image cannot be determined safely so no location information has been added to the message."); } + msg.location.arc = { + ranges: [500,1000,2000], + pan: gpsData.GPSImgDirection, + fov: (2 * Math.atan(36 / (2 * msg.exif.exif.FocalLengthIn35mmFormat)) * 180 / Math.PI), + color: '#910000' + } + msg.location.icon = "fa-camera"; + var na; + if (val.hasOwnProperty("name")) { na = val.name; } + else if (msg.hasOwnProperty("filename")) { na = msg.filename.split('/').pop(); } + else { na = msg.exif.image.Make+"_"+msg.exif.image.ModifyDate; } + msg.location.name = na; + msg.location.layer = "Images"; + msg.location.popup = '' } this.on("input", function(msg) { + if (node.mode === "worldmap" && (msg.payload.action !== "file" || msg.payload.type.indexOf("image") === -1)) { return; } // in case worldmap-in not filtered. try { - if (msg.payload) { - if (Buffer.isBuffer(msg.payload)) { - new ExifImage({ image : msg.payload }, function (error, exifData) { + var value = RED.util.getMessageProperty(msg,node.property); + if (value !== undefined) { + if (typeof value === "string") { // it must be a base64 encoded inline image type + if (value.indexOf('data:image') !== -1) { + value = new Buffer.from(value.replace(/^data:image\/[a-z]+;base64,/, ""), 'base64'); + } + } + if (Buffer.isBuffer(value)) { // or a proper jpg buffer + new ExifImage({ image:value }, function (error, exifData) { if (error) { - node.log(error.toString()); - } - else { - //msg.payload remains the same buffer - if ((exifData) && (exifData.hasOwnProperty("gps")) && (Object.keys(exifData.gps).length !== 0)) { - msg.exif = exifData; - addMsgLocationDataFromExifGPSData(msg); + if (node.mode !== "worldmap") { + node.log(error.toString()); } else { - node.warn("The incoming image did not contain Exif GPS data, nothing to do. "); + msg.location = {name:msg.payload.name, lat:msg.payload.lat, lon:msg.payload.lon, layer:"Images", icon:"fa-camera", draggable:true}; + msg.location.popup = '
'; } } + else { + if (exifData) { + msg.exif = exifData; + if ((exifData.hasOwnProperty("gps")) && (Object.keys(exifData.gps).length !== 0)) { + addMsgLocationDataFromExifGPSData(msg,value); + } + //else { node.log("The incoming image did not contain Exif GPS data."); } + } + else { + node.warn("The incoming image did not contain any Exif data, nothing to do."); + } + } + if (node.mode === "worldmap") { + msg.payload = msg.location; + delete msg.location; + } node.send(msg); }); } else { - node.error("Invalid payload received, the Exif node cannot proceed, no messages sent."); + node.error("Invalid payload received, the Exif node cannot proceed, no messages sent.",msg); return; } } else { - node.error("No payload received, the Exif node cannot proceed, no messages sent."); + node.warn("No input received, the Exif node cannot proceed, no messages sent.",msg); return; } } catch (error) { - node.error("An error occurred while extracting Exif information. Please check the log for details."); + node.error("An error occurred while extracting Exif information. Please check the log for details.",msg); node.log('Error: '+error.message); return; } diff --git a/utility/exif/package.json b/utility/exif/package.json index 3018b699..639bbcef 100644 --- a/utility/exif/package.json +++ b/utility/exif/package.json @@ -1,23 +1,30 @@ { - "name" : "node-red-node-exif", - "version" : "0.0.6", - "description" : "A Node-RED node that extracts Exif information from JPEG image buffers.", - "dependencies" : { - "exif": "0.4.0" + "name": "node-red-node-exif", + "version": "0.2.0", + "description": "A Node-RED node that extracts Exif information from JPEG image buffers.", + "dependencies": { + "exif": "^0.6.0" }, - "repository" : { - "type":"git", - "url":"https://github.com/node-red/node-red-nodes/tree/master/utility/exif" + "repository": { + "type": "git", + "url": "https://github.com/node-red/node-red-nodes/tree/master/utility/exif" }, "license": "Apache-2.0", - "keywords": [ "node-red", "exif"], - "node-red" : { - "nodes" : { + "keywords": [ + "node-red", + "exif" + ], + "node-red": { + "nodes": { "exif": "94-exif.js" } }, "contributors": [ - {"name": "Dave Conway-Jones"}, - {"name": "Zoltan Balogh"} + { + "name": "Dave Conway-Jones" + }, + { + "name": "Zoltan Balogh" + } ] } diff --git a/utility/group/LICENSE b/utility/group/LICENSE new file mode 100644 index 00000000..f5b60114 --- /dev/null +++ b/utility/group/LICENSE @@ -0,0 +1,14 @@ +Copyright 2016 JS Foundation and other contributors, https://js.foundation/ +Copyright 2013-2016 IBM Corp. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/utility/group/README.md b/utility/group/README.md new file mode 100644 index 00000000..4c6f56e2 --- /dev/null +++ b/utility/group/README.md @@ -0,0 +1,25 @@ +node-red-node-group +=================== + +A Node-RED node to allow flows containing groups to be imported into older versions +of Node-RED. + +The ability to create groups was introduced in Node-RED 1.1.0, adding a new core +node type called `group`. + +This module provides its own `group` node type that can be installed into older +versions of Node-RED to allow them to run flows containing that type. + +It does *not* provide any group-like functionality - it *only* registers a +placeholder `group` node type. + +The module will only register the type if it detects it is being loaded into +Node-RED 1.0.x or older, otherwise it does nothing. + + +Install +------- + +Run the following command in your Node-RED user directory - typically `~/.node-red` + + npm i node-red-node-group diff --git a/utility/group/group.html b/utility/group/group.html new file mode 100644 index 00000000..d002ba40 --- /dev/null +++ b/utility/group/group.html @@ -0,0 +1,39 @@ + + + + + diff --git a/utility/group/group.js b/utility/group/group.js new file mode 100644 index 00000000..f976d2f4 --- /dev/null +++ b/utility/group/group.js @@ -0,0 +1,16 @@ + +module.exports = function(RED) { + var version = RED.version(); + var parts = /^(\d)+\.(\d)+\.(\d)+/.exec(version); + if (parts) { + var major = parseInt(parts[1]); + var minor = parseInt(parts[2]); + if (major > 1 || (major === 1 && minor > 0)) { + throw new Error("This module is not required for Node-RED 1.1.0 or later") + } + } + function GroupPolyfillNode(n) { + RED.nodes.createNode(this,n); + } + RED.nodes.registerType("group",GroupPolyfillNode); +} diff --git a/utility/group/package.json b/utility/group/package.json new file mode 100644 index 00000000..fb88571e --- /dev/null +++ b/utility/group/package.json @@ -0,0 +1,20 @@ +{ + "name": "node-red-node-group", + "version": "1.0.0", + "description": "A Node-RED node to allow flows containing groups to be imported into Node-RED 1.0.x or earlier.", + "dependencies": {}, + "repository": { + "type": "git", + "url": "https://github.com/node-red/node-red-nodes/tree/master/utility/group" + }, + "license": "Apache-2.0", + "keywords": [ + "node-red" + ], + "node-red": { + "nodes": { + "group": "group.js" + } + }, + "author": "Nick O'Leary " +}