Notebooks/03-01-Node-Red-Tutorial.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Introduction to Node-Red\n",
    "\n",
    "Edited by: [**Walter Terkaj**](mailto:walter.terkaj@stiima.cnr.it)  \n",
    "\n",
    "[//]: <> (Edited by Walter Terkaj walter.terkaj@stiima.cnr.it)\n",
    "\n",
    "Node-RED is a powerful tool for building Internet of Things (IoT) applications with a focus on simplifying the ‘wiring together’ of code blocks to carry out tasks. It uses a visual programming approach that allows developers to connect predefined code blocks, known as ‘nodes’, together to perform a task. The connected nodes, usually a combination of input nodes, processing nodes and output nodes, when wired together, make up ‘flows’. ([Link](http://noderedguide.com/nr-lecture-1/))\n",
    "\n",
    "Node-RED provides a web browser- based flow editor, which can be used to create JavaScript functions. Elements of applications can be saved or shared for re-use. The runtime is built on Node.js. The flows created in Node-RED are stored using JSON which can be easily imported and exported for sharing with others. By understanding Node-Red, IoT development can be accelerated without unnecessary coding. \n",
    "\n",
    "## Node.js\n",
    "Node.js is an open-source, cross-platform JavaScript run-time environment that executes JavaScript code outside of a browser. Node.js allows developers use JavaScript to write command line tools and to run scripts server-side to produce dynamic web page content before the page is sent to the user's web browser.\n",
    "NPM is a package manager for Node.js packages, or modules. The NPM program is installed on your computer when you install Node.js. A package in Node.js contains all the files you need for a module. Modules are JavaScript libraries you can include in your project.\n",
    "Since the light-weight runtime of Node-Red is built on Node.js, it is taking full advantage of its event-driven, non-blocking model.\n",
    "\n",
    "\n",
    "## Node-RED and Internet of Things\n",
    "\n",
    "As a tool for rapid application development for the IoT, Node-RED is both powerful and flexible thanks to two factors:\n",
    "- Node-RED is an example of a flow-based programming model – messages representing events flow between nodes, triggering processing that results in output. The flow-based programming model maps well to typical IoT applications which are characterised by real-world events that trigger some sort of processing which in turn results in real-world actions.\n",
    "- Node-RED provides a set of built-in input and output nodes, each of which hides much of the complexity of interacting with the real world. Node-RED offers developers powerful building blocks to allow them to quickly put together flows that accomplish a lot, without having to worry about the programming details.\n",
    "\n",
    "\n",
    "## Installation of Node-RED\n",
    "\n",
    "In order to able to work with Node-RED, you should install working node.js. It is recommended the use of Node.js LTS 8.x or 10.x. Node-RED no longer supports Node.js 6.x or earlier. (latest version is recommended). You can download the latest version of node.js from website below choosing which operating system you are using. \n",
    "https://nodejs.org/en/download/\n",
    "\n",
    " ### Linux / OSx\n",
    "\n",
    "Once installed, node.js, open the terminal window and run the following commands.\n",
    "To check your version of Node.js:\n",
    "\n",
    "```sh\n",
    " node -v\n",
    "```\n",
    "\n",
    "The easiest way to install Node-RED is to use the node package manager, npm, that comes with Node.js. Installing as a global module adds the command node-red to your system path:\n",
    "\n",
    "```sh\n",
    " sudo npm install -g --unsafe-perm node-red\n",
    "```\n",
    "\n",
    " ### Windows\n",
    "\n",
    "Run the downloaded MSI file. Installing Node.js requires local administrator rights; if you are not a local administrator, you will be prompted for an administrator password on install. Accept the defaults when installing. After installation completes, close any open command prompts and re-open to ensure new environment variables are picked up.\n",
    "\n",
    "Once installed, open a command prompt and run the following command to ensure Node.js and npm are installed correctly.\n",
    "\n",
    "```sh\n",
    " node --version && npm --version\n",
    "```\n",
    "You should receive back output that looks similar to:\n",
    "\n",
    "```sh\n",
    " v8.9.0\n",
    " 5.5.1\n",
    "```\n",
    "Installing Node-RED as a global module adds the command node-red to your system path. Execute the following at the command prompt:\n",
    "\n",
    "```sh\n",
    " npm install -g --unsafe-perm node-red\n",
    "```\n",
    "\n",
    " ### Running Node-RED\n",
    "\n",
    "If you have installed Node-RED as a global npm package, you can launch node-red in the command prompt (Windows):\n",
    "\n",
    "```sh\n",
    "C:\\>node-red\n",
    "```\n",
    "or in the terminal (Linux):\n",
    "```sh\n",
    "$ node-red\n",
    "```\n",
    "\n",
    "This will output the Node-RED log to the terminal. You must keep the terminal or command prompt open in order to keep Node-RED running.\n",
    "Note that running Node-RED will create a new folder in your %HOMEPATH% folder called .node-red. This is your userDir folder, think of it as the home folder for Node-RED configuration for the current user. \n",
    "\n",
    "```sh\n",
    "\n",
    "Welcome to Node-RED\n",
    "===================\n",
    "\n",
    "25 Mar 22:51:09 - [info] Node-RED version: v0.20.5\n",
    "25 Mar 22:51:09 - [info] Node.js  version: v10.15.3\n",
    "25 Mar 22:51:09 - [info] Loading palette nodes\n",
    "25 Mar 22:51:10 - [warn] ------------------------------------------\n",
    "25 Mar 22:51:10 - [warn] [rpi-gpio] Info : Ignoring Raspberry Pi specific node\n",
    "25 Mar 22:51:10 - [warn] ------------------------------------------\n",
    "25 Mar 22:51:10 - [info] Settings file  : /home/nol/.node-red/settings.js\n",
    "25 Mar 22:51:10 - [info] Context store  : 'default' [module=localfilesystem]\n",
    "25 Mar 22:51:10 - [info] User Directory : /home/nol/.node-red\n",
    "25 Mar 22:51:10 - [warn] Projects disabled : set editorTheme.projects.enabled=true to enable\n",
    "25 Mar 22:51:10 - [info] Server now running at http://127.0.0.1:1880/\n",
    "25 Mar 22:51:10 - [info] Creating new flows file : flows_noltop.json\n",
    "25 Mar 22:51:10 - [info] Starting flows\n",
    "25 Mar 22:51:10 - [info] Started flows\n",
    "```\n",
    "\n",
    "**You can then access the Node-RED editor by pointing your browser at http://localhost:1880**\n",
    "\n",
    "##  Example: Hello World\n",
    "Perhaps the best way to understand what Node-RED is to see it. Below is Node-RED's representation of a \"Hello World\" program, commonly used to introduce someone to a new technology or programming language. It is usually a very simple routine that prints the message 'Hello World' on the screen.\n",
    "Node-RED provides a GUI where users drag-and-drop blocks that represent components of a larger system, in Node-RED's case usually the devices, software platforms and web services that are to be connected. Further blocks can be placed in between these components to represent software functions that wrangle and transform the data in transit.\n",
    "Here you can see Node-RED's graphical user interface and how the platform breaks systems down into their constituent parts. \n",
    "\n",
    "![Hello World1!](https://tr2.cbsistatic.com/hub/i/r/2014/03/11/90f2ae9b-7a8c-4955-ac3e-4a4e4ada85b0/resize/770x/adc81aaba881a55c1d0e2606044b4da2/Screenshot%20from%202013-09-15%2017_26_18.png \"\")\n",
    "**Figure1.** The Hello World routine in Node-Red\n",
    "\n",
    "Each of the rounded blocks you can see on the screen is a node, which is a visual representation of a block of JavaScript code designed to carry out a specific task. To build the 'Hello World' program the user drags into the central window an 'inject node', a node designed to output a message to other nodes. This inject node is edited to output the string 'Hello'. Next a function node is dragged on and edited to define a JavaScript function that appends the string ' World' to any message it receives. These two nodes are then wired together. Most nodes have a grey circle on their left edge, which represents their input port, and on their right edge, which represents their output port. Left clicking and dragging the output port of the 'Hello' node to the input port of the ' World' node connects the two together. The final stage is to add a Debug node that prints the message it receives in the Debug window. This Debug node is then wired to the output of the ' World' node. The process is now ready to run and once deployed will display the string 'Hello World' in the Debug box, shown on the right of the screen. This finished program is an example of what is called a flow in Node-RED.\n",
    "\n",
    "Node-RED can do much more than spit out a simple message, e.g. it can also glue together web services and hardware, and that's where it starts getting powerful.\n",
    "\n",
    "## References\n",
    "\n",
    "- Most of the contents in this document can be found on the Node-Red website: https://nodered.org/\n",
    "\n",
    "- Installation instructions can be found at: https://nodered.org/docs/getting-started/installation\n",
    "\n",
    "- Node RED Programming Guide: http://noderedguide.com/\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.7.3"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}