IBM donated Node-Red to the JavaScript open source foundation. Node-Red started with the Raspberry PI as a way to integrate IOT devices and has grown-up and populated itself into IBM’s Watson cloud services.
The adoption of Node-Red will increase the compatibility of services between machines and humans. AI agents can use Node-Red to integrate complex systems into Rule Based applications. Machine learning will ensure that simple blocks or pipes of data and services can be glued together as asynchronous patterns that can be both scalable, adaptable, and profitable.
This demo and tutorial is an introduction to the installation and usage of simple blocks, or what are 'Pipes' and 'functions' of data. The reader of this tutorial will see the capabilities of a functional modular design, and the goal is to have the reader an "A-ha moment" in concept and ideas.
Click on SIP: links for short videos ⭐
⭐ SIP: About this Demo/Tutorial
Install
⭐ SIP: Install Node-RED Global
$ sudo npm install -g --unsafe-perm node-red
$ git clone https://github.com/mallond/node-red.git
Edit setttings.js
By default, all user data is stored in the Node-RED install directory. To use a different location, the following property can be used
🔑 userDir: '~/node-red-userDir',
Node-RED scans the
nodesdirectory in the install directory to find nodes. The following property can be used to specify an additional directory to scan.
🔑 nodesDir: '~node-red-nodeDir',
KEY nodesDir will be where you git clone modules for immediate use.
Below is an example of the nodesDir that will contain any Git clones you would like to include. Within the *.html (example pipe1.html) is an element called 'category', this will place your node into the left hand node pane under the category you choose.
🔑 *.html 'category' change this element to have your node placed in the category of your choosing.
🔑 Instead of Using npm install, a better idea is to use git clone. Why? You will have the ablity to modify your nodes along with the Node-Red process environment.
node-red-nodeDir/
├── node-red-contrib-json-schema
├── pipe1
├── pipe2
└── pipe3
Git clone - Nodes that will be used
$ cd node-red-nodeDir
$ git clone https://github.com/mallond/node-red-contrib-json-schema.git
$ cd node-red-contrib-json-schema
$ npm install
$ cd ..
Note: The repos do not have package dependencies.
$ git clone https://github.com/mallond/pipe1
$ git clone https://github.com/mallond/pipe2
$ git clone https://github.com/mallond/pipe3
node-red-nodeDir/
├── node-red-contrib-json-schema
│ ├── LICENSE
│ ├── README.md
│ ├── package.json
│ ├── schema.html
│ └── schema.js
├── pipe1
│ ├── README.md
│ ├── package.json
│ ├── pipe1.html
│ └── pipe1.js
├── pipe2
│ ├── README.md
│ ├── package.json
│ ├── pipe2.html
│ └── pipe2.js
└── pipe3
├── README.md
├── package.json
├── pipe3.html
└── pipe3.js
🔑 Start
$ node-red --settings settings.js
To install your custom node, you can either install it locally within 🔑 nodesDir directory:
During development it is also possible to install nodes by copying their .js and .html files into a nodes directory within your 🔑 nodesDir directory. If these nodes have any npm dependencies, they must be also be installed within the 🔑 nodesDir directory. This is only really recommended for development purposes.
$ cd **nodesDir**
$ git clone <git repo>
You will then need to stop and restart Node-RED for it to pick-up the new nodes.
And, if you have modified *.html category element your new Node should appear in the Nodes section.
For this demo
$ cd node-red-nodeDir **nodesDir**
$ git clone https://github.com/mallond/node-red-contrib-json-schema.git
$ cd node-red-contrib-json-schema
$ npm install
$ cd ..
$ git clone https://github.com/mallond/pipe1
$ git clone https://github.com/mallond/pipe2
$ git clone https://github.com/mallond/pipe3
Note: The pipe1, pipe2, and pipe3 do not have package.json dependencies, so there is no need to npm install.
They consist of a pair of files; a JavaScript file that defines what the node does, and an html file that defines the node’s properties, edit dialog and help text.
When packaged as an npm module, a package.json file is used to pull it all together.
- package.json Package Guide
- aModuleFile.js Javascript Guide
- anHtmlFile.html HTML Guide
You can create multiple NODES in different directories each haveing the same three files: package.json, aMdouleFile.js, anHtmlFile.html
- Creating your first node
- JavaScript File
- HTML File
- Node context
- Node properties
- Node appearance
- Node status
- Configuration nodes
- Help style guide
- Packaging
- Internationalisation
- be well-defined in their purpose.
- be simple to use, regardless of the underlying functionality.
- be forgiving in what types of message properties it accepts.
- be consistent in what they send.
- sit at the beginning, middle or end of a flow - not all at once.
- catch errors.
- If a node throws an uncaught error, Node-RED will stop the entire flow as the state of the system is no longer known.
- Wherever possible, nodes must catch errors or register error handlers for any asynchronous calls they make.
⭐ SIP: 900 Nodes running on Node-Red - Sub second processing
⭐ SIP: 5000 Nodes running on Node-Red - Sub second processing