From 9bd0e1ba02868a3334078081f73e2bb3b719f62b Mon Sep 17 00:00:00 2001 From: Romain Bazile Date: Mon, 28 Sep 2020 10:24:48 +0200 Subject: [PATCH] README: move Node-red setup to the end --- README.md | 113 +++++++++++++++++++++++++++++------------------------- 1 file changed, 61 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index 092e0a5..6535985 100644 --- a/README.md +++ b/README.md @@ -445,58 +445,6 @@ sudo pip3 install Adafruit-SSD1306 More information can be found on Yahboom website, on the page [Installing RGB Cooling HAT](https://www.yahboom.net/study/RGB_Cooling_HAT). -### Install Node-RED - -#### Download and installation -To install Node.js, npm and Node-RED onto a Raspberry Pi, you just need to run the following command. You can review the content of this script [here](https://raw.githubusercontent.com/node-red/linux-installers/master/deb/update-nodejs-and-nodered). -```sh -bash <(curl -sL https://raw.githubusercontent.com/node-red/linux-installers/master/deb/update-nodejs-and-nodered) -``` -Type `y` at both prompts to accept the installation and its settings. - -#### Enable start on boot and launch Node-RED -To run Node-RED when the Pi is turned on or restarted, you need to enable the systemd service by running this command: -```sh -sudo systemctl enable nodered.service -``` - -You can now start Node-RED by running the following: -```sh -sudo systemctl start nodered.service -``` - -#### Check the installation -Make sure Node-RED is correctly installed by reaching the following page from the browser of your pi http://localhost:1880 or http://planktoscope.local:1880 from another computer on the same network. - -#### Install the necessary nodes -These nodes will be used by the PlanktoScop software and needs to be installed: -```sh -cd ~/.node-red/ -npm install node-red-dashboard node-red-contrib-python3-function node-red-contrib-camerapi node-red-contrib-gpsd node-red-contrib-web-worldmap node-red-contrib-interval -``` -We are also going to activate the Projects feature of Node-Red as this will help us manage and track change to the flows. Open the file `settings.js` with an editor (for example with `nano settings.js`) so we can change the following lines: -``` -Line 68: uncomment the line (remove the //) that ends with flowFilePretty: true, -Line 296: set enabled to true -``` - -Save your changes and now restart the nodered service: -``` -sudo systemctl restart nodered.service -``` - -#### Import the last GUI - -If you now open the Node-Red GUI in your browser, it will ask you to setup the project, an email and a username (so if you make changes to the flow and want to share them we can know who made them). - -You can now choose to clone an existing repository. Choose a name that makes sense for you, and in the `Git repository URL` field put the main Planktonscope repository: `https://www.github.com/PlanktonPlanet/PlanktonScope.git`. - -The latest flow version will be imported immediately. - -#### More information -[Installing Node-RED on Raspberry Pi](https://nodered.org/docs/getting-started/raspberrypi) - - ### Install Mosquitto MQTT In order to send and receive data from Node-RED, you need to install this. Run the following: @@ -565,6 +513,67 @@ Type "help", "copyright", "credits" or "license" for more information. The MorphoCut documentation can be found [on this page](https://morphocut.readthedocs.io/en/stable/index.html). + +### Install Node-RED + +#### Download and installation +To install Node.js, npm and Node-RED onto a Raspberry Pi, you just need to run the following command. You can review the content of this script [here](https://raw.githubusercontent.com/node-red/linux-installers/master/deb/update-nodejs-and-nodered). +```sh +bash <(curl -sL https://raw.githubusercontent.com/node-red/linux-installers/master/deb/update-nodejs-and-nodered) +``` +Type `y` at both prompts to accept the installation and its settings. + +#### Enable start on boot and launch Node-RED +To run Node-RED when the Pi is turned on or restarted, you need to enable the systemd service by running this command: +```sh +sudo systemctl enable nodered.service +``` + +You can now start Node-RED by running the following: +```sh +sudo systemctl start nodered.service +``` + +#### Check the installation +Make sure Node-RED is correctly installed by reaching the following page from the browser of your pi http://localhost:1880 or http://planktoscope.local:1880 from another computer on the same network. + +#### Install the necessary nodes +These nodes will be used by the PlanktoScop software and needs to be installed: +```sh +cd ~/.node-red/ +npm install node-red-dashboard node-red-contrib-python3-function node-red-contrib-camerapi node-red-contrib-gpsd node-red-contrib-web-worldmap node-red-contrib-interval +``` +We are also going to activate the Projects feature of Node-Red as this will help us manage and track changes to the flows. Open the file `settings.js` with an editor (for example with `nano settings.js`) so we can change the following lines: +``` +Line 68: uncomment the line (remove the //) that ends with flowFilePretty: true, +Line 296: set enabled to true +``` + +Save you changes. + +The final step before restarting node-red is to link the projects directory from within node-red folder to our main home directory. To do so, just open a terminal and type the following: +```bash +ln -s /home/pi/.node-red/projects/PlanktonScope /home/pi/PlanktonScope +``` + +You can now restart the nodered service: +``` +sudo systemctl restart nodered.service +``` + +#### Import the last GUI + +If you now open the Node-Red GUI in your browser, it will ask you to setup the project, an email and a username (so if you make changes to the flow and want to share them we can know who made them). + +You can now choose to clone an existing repository. Choose a name that makes sense for you, and in the `Git repository URL` field put the main Planktonscope repository: `https://www.github.com/PlanktonPlanet/PlanktonScope.git`. + +The latest flow version will be imported immediately. + + +#### More information +[Installing Node-RED on Raspberry Pi](https://nodered.org/docs/getting-started/raspberrypi) + + ## Finishing the install Make sure to update your Pi