├── .gitignore ├── .npmrc ├── LICENSE ├── README.md ├── index.js ├── package.json └── public ├── index.html └── node-red-icon-2.png /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | *.pid.lock 13 | 14 | # Directory for instrumented libs generated by jscoverage/JSCover 15 | lib-cov 16 | 17 | # Coverage directory used by tools like istanbul 18 | coverage 19 | 20 | # nyc test coverage 21 | .nyc_output 22 | 23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 24 | .grunt 25 | 26 | # Bower dependency directory (https://bower.io/) 27 | bower_components 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (https://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # TypeScript v1 declaration files 40 | typings/ 41 | 42 | # Optional npm cache directory 43 | .npm 44 | 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | # Optional REPL history 49 | .node_repl_history 50 | 51 | # Output of 'npm pack' 52 | *.tgz 53 | 54 | # Yarn Integrity file 55 | .yarn-integrity 56 | 57 | # dotenv environment variables file 58 | .env 59 | 60 | # next.js build output 61 | .next 62 | -------------------------------------------------------------------------------- /.npmrc: -------------------------------------------------------------------------------- 1 | package-lock=false 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # signalk-node-red 2 | Node server plugin that embeds node red 3 | 4 | You do not need to install node-red separately, just install this plugin via the app store. 5 | 6 | Go to Webapps in the node server admin ui to get to node-red. 7 | 8 | Security is supported with node server version 1.4.0 or greater 9 | 10 | See https://github.com/SignalK/node-red-embedded for available Nodes. 11 | 12 | You can access the node-red Admin console by navigating to Webapps on the node server admin console, or use a direct url like http://localhost:3000/plugins/signalk-node-red/redAdmin/ 13 | 14 | If you install node red dashboard, then the url for the dashboard will be we be http://localhost:3000/plugins/signalk-node-red/redApi/ui/ 15 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright 2018 Scott Bender (scott@scottbender.net) 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | 18 | const RED = require("node-red") 19 | const compareVersions = require('compare-versions') 20 | const _ = require('lodash') 21 | 22 | module.exports = function(app) { 23 | var plugin = {}; 24 | var unsubscribes = [] 25 | var options 26 | var redSettings 27 | var supportsSecurity = compareVersions(app.config.version, '1.3.0') > 0 28 | var deltaHandlers = [] 29 | var didRegisterInputHandler = false 30 | 31 | plugin.id = "signalk-node-red"; 32 | plugin.name = "Node Red"; 33 | plugin.description = "Embeds node red in signalk node server"; 34 | 35 | plugin.start = function(theOptions) { 36 | redSettings = { 37 | 38 | userDir: app.config.configPath + '/red', 39 | logging: {'console': { level: theOptions.logging || 'info'}}, 40 | credentialSecret: 'jkhdfshjkfdskjhfsjfsdkjhsfdjkfsd', 41 | functionGlobalContext: { 42 | streambundle: app.streambundle, 43 | signalk: app.signalk, 44 | subscriptionmanager: app.subscriptionmanager, 45 | app: app, 46 | plugin: plugin, 47 | lodash: require('lodash'), 48 | geodist: require('geodist') 49 | } 50 | }; 51 | 52 | if ( theOptions.flowFile && theOptions.flowFile.length > 0 ) { 53 | redSettings.flowFile = theOptions.flowFile 54 | } 55 | 56 | if ( theOptions.settings ) { 57 | theOptions.settings.forEach(s => { 58 | try { 59 | app.debug('setting %s to %s', s.name, s.value) 60 | redSettings[s.name] = JSON.parse(s.value) 61 | } catch ( e ) { 62 | app.error(`unable to parse setting ${s.name} of ${s.value}`) 63 | app.setPluginError(`unable to parse setting ${s.name} of ${s.value}`) 64 | } 65 | }) 66 | } 67 | 68 | if ( theOptions.requires ) { 69 | theOptions.requires.forEach(module => { 70 | try { 71 | redSettings.functionGlobalContext[module] = require(module) 72 | } catch (err) { 73 | app.error(`unable to load module ${module} ${err}`) 74 | } 75 | }) 76 | } 77 | 78 | if ( !supportsSecurity ) { 79 | redSettings.httpAdminRoot = '/redAdmin' 80 | redSettings.httpNodeRoot = '/redApi' 81 | } else { 82 | redSettings.httpAdminRoot = '/plugins/' + plugin.id + '/redAdmin' 83 | redSettings.httpNodeRoot = '/plugins/' + plugin.id + '/redApi' 84 | } 85 | 86 | 87 | RED.init(app.server, redSettings) 88 | RED.start() 89 | 90 | if ( !supportsSecurity ) { 91 | app.use(redSettings.httpAdminRoot, RED.httpAdmin); 92 | app.use(redSettings.httpNodeRoot, RED.httpNode); 93 | } else { 94 | app.get('/redAdmin', (req, res) => { 95 | res.redirect(redSettings.httpAdminRoot) 96 | }) 97 | app.use(redSettings.httpAdminRoot, RED.httpNode); 98 | } 99 | 100 | unsubscribes.push(RED.stop) 101 | } 102 | 103 | plugin.getSelfPath = function(path, timeout) { 104 | let res = app.getSelfPath(path) 105 | 106 | if ( res && !_.isUndefined(res.value) && !_.isUndefined(res.timestamp) 107 | && Date.now() - new Date(res.timestamp).getTime() < timeout ) { 108 | return res.value 109 | } 110 | 111 | return undefined 112 | } 113 | 114 | function deltaInputHandler(delta, next) { 115 | if ( deltaHandlers.length == 0 ) { 116 | next(delta) 117 | return 118 | } 119 | 120 | if ( delta.updates ) { 121 | delta.updates.forEach(update => { 122 | if ( update.values ) { 123 | let newValues = [] 124 | update.values.forEach(pathValue => { 125 | let matched = false 126 | deltaHandlers.forEach(handler => { 127 | if ( delta.context == handler.context 128 | && pathValue.path == handler.path 129 | && (!handler.source 130 | || (update.$source && handler.source == update.$source)) ) { 131 | matched = true 132 | handler.callback({ 133 | topic: pathValue.path, 134 | payload: pathValue.value, 135 | $source: update.$source, 136 | source: update.source, 137 | context: delta.context, 138 | timestamp: update.timestamp 139 | }, next) 140 | } 141 | }) 142 | if ( !matched ) { 143 | newValues.push(pathValue) 144 | } 145 | }) 146 | update.values = newValues 147 | } 148 | }) 149 | } 150 | next(delta) 151 | } 152 | 153 | plugin.registerDeltaInputHandler = function(context, path, source, cb) { 154 | const info = { 155 | context: context === 'vessels.self' ? app.selfContext : context, 156 | path: path, 157 | source: source, 158 | callback: cb 159 | } 160 | deltaHandlers.push(info) 161 | 162 | if ( !this.didRegisterInputHandler ) { 163 | app.registerDeltaInputHandler(deltaInputHandler) 164 | this.didRegisterInputHandler = true 165 | } 166 | 167 | return () => { 168 | let idx = deltaHandlers.indexOf(info) 169 | deltaHandlers.splice(idx, 1) 170 | } 171 | } 172 | 173 | 174 | plugin.registerWithRouter = function(router) { 175 | if ( supportsSecurity ) { 176 | router.use('/redAdmin', (req, res, next) => { 177 | if ( RED.httpAdmin ) { 178 | RED.httpAdmin(req, res, next) 179 | } else { 180 | res.status(404).send(`The ${plugin.id} plugin is not started`) 181 | } 182 | }); 183 | router.use('/redApi', (req, res, next) => { 184 | if ( RED.httpNode ) { 185 | RED.httpNode(req, res, next) 186 | } else { 187 | res.status(404).send(`The ${plugin.id} plugin is not started`) 188 | } 189 | }); 190 | } 191 | } 192 | 193 | plugin.stop = function() { 194 | app.debug("stopping...") 195 | unsubscribes.forEach(f => f()); 196 | unsubscribes = []; 197 | didRegisterInputHandler = false 198 | }; 199 | 200 | plugin.schema = { 201 | title: "Node Red", 202 | properties: { 203 | flowFile: { 204 | type: 'string', 205 | title: 'Flow File', 206 | description: 'the file used to store the flows' 207 | }, 208 | logging: { 209 | type: 'string', 210 | title: 'Logging', 211 | enum: [ 'falal', 'error', 'warn', 'info', 'debug', 'trace' ], 212 | default: 'info' 213 | }, 214 | requires: { 215 | type: 'array', 216 | title: 'Npm modules to make available', 217 | items: { 218 | type: 'string' 219 | } 220 | }, 221 | settings: { 222 | title: 'Node Red Settings', 223 | type: 'array', 224 | items: { 225 | type: 'object', 226 | properties: { 227 | name: { 228 | type: 'string', 229 | title: 'Setting Name' 230 | }, 231 | value: { 232 | type: 'string', 233 | title: 'Setting Value (json)' 234 | } 235 | } 236 | } 237 | } 238 | } 239 | } 240 | 241 | return plugin; 242 | } 243 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@signalk/signalk-node-red", 3 | "version": "3.2.0", 4 | "description": "Combine Node-RED with Signal K data", 5 | "main": "index.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1", 8 | "create-release": "github-create-release --owner signalk --repository signalk-node-red", 9 | "release": "git tag -d v$npm_package_version && git tag v$npm_package_version && git push --tags && git push && npm run create-release" 10 | }, 11 | "keywords": [ 12 | "signalk-node-server-plugin", 13 | "signalk-webapp" 14 | ], 15 | "author": "Scott Bender", 16 | "license": "Apache-2.0", 17 | "repository": { 18 | "type": "git", 19 | "url": "https://github.com/SignalK/signalk-node-red" 20 | }, 21 | "dependencies": { 22 | "@signalk/node-red-embedded": "2.18.x", 23 | "compare-versions": "^3.0.1", 24 | "geodist": "^0.2.1", 25 | "lodash": "^4.17.4", 26 | "node-red": "3.1.x" 27 | }, 28 | "devDependencies": { 29 | "@signalk/github-create-release": "^1.0.1" 30 | }, 31 | "signalk-plugin-enabled-by-default": true, 32 | "signalk": { 33 | "appIcon": "./node-red-icon-2.png", 34 | "displayName": "Node-RED" 35 | } 36 | } 37 | -------------------------------------------------------------------------------- /public/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | Node Red 4 | 5 | 6 | 7 | 8 |


9 |
10 | If your browser doesn't automatically go there within a few seconds, 11 | you may want to go to Node Red 12 | manually. 13 |
14 | 15 | 16 | -------------------------------------------------------------------------------- /public/node-red-icon-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/SignalK/signalk-node-red/81e72a6a7834cd5790826ec526ea2f677ee351cc/public/node-red-icon-2.png --------------------------------------------------------------------------------