Merge pull request #6 from oceantrotter/node-project
Use of Node Project to manage flows
This commit is contained in:
Romain Bazile
GitHub
commit
0ceb7abf8d
119
README.md
119
README.md
|
|
@ -44,7 +44,7 @@ The first boot to the desktop may take up to 120 seconds. This is normal and is
|
|||
|
||||
Make sure you have access to internet and update/upgrade your fresh Raspbian install.
|
||||
|
||||
Update your Pi first. Open up a terminal, and do the following:
|
||||
Update your Pi first. Open up a terminal or connect via ssh to the Raspberry, and type in the following:
|
||||
```sh
|
||||
sudo apt update -y
|
||||
sudo apt upgrade -y
|
||||
|
|
@ -58,18 +58,9 @@ sudo reboot now
|
|||
|
||||
## Raspberry Pi configuration
|
||||
|
||||
### Clone this repository!
|
||||
|
||||
First of all, and to ensure you have the latest documentation available locally, you should clone this repository using git.
|
||||
|
||||
Simply run the following in a terminal:
|
||||
```sh
|
||||
git clone https://github.com/PlanktonPlanet/PlanktonScope/
|
||||
```
|
||||
|
||||
### Enable Camera/SSH/I2C in raspi-config
|
||||
|
||||
You can now launch the configuration tool:
|
||||
You can launch the configuration tool:
|
||||
```sh
|
||||
sudo raspi-config
|
||||
```
|
||||
|
|
@ -445,51 +436,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
|
||||
sudo systemctl restart nodered.service
|
||||
```
|
||||
|
||||
#### Import the last GUI
|
||||
|
||||
From Node-RED gui in your browser, choose the Hamburger menu top right, and then Import. You can paste the code directly from the lastest version of the GUI available [here](https://raw.githubusercontent.com/PlanktonPlanet/PlanktonScope/blob/master/flows/main.json).
|
||||
|
||||
You can also download it directly:
|
||||
```sh
|
||||
wget -N -O ~/.node-red/flows_planktoscope.json https://raw.githubusercontent.com/PlanktonPlanet/PlanktonScope/master/flows/main.json
|
||||
sudo systemctl restart nodered.service
|
||||
```
|
||||
|
||||
#### 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:
|
||||
|
|
@ -558,6 +504,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
|
||||
|
|
|
|||
19
package.json
Normal file
19
package.json
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
{
|
||||
"name": "PlanktonScope",
|
||||
"description": "Planktonscope main software project",
|
||||
"version": "0.1",
|
||||
"dependencies": {
|
||||
"node-red-contrib-gpsd": "1.0.2",
|
||||
"node-red-contrib-interval": "0.0.1",
|
||||
"node-red-contrib-python3-function": "0.0.4",
|
||||
"node-red-contrib-web-worldmap": "2.4.1",
|
||||
"node-red-dashboard": "2.23.0",
|
||||
"node-red-node-pi-gpio": "1.1.1"
|
||||
},
|
||||
"node-red": {
|
||||
"settings": {
|
||||
"flowFile": "flows/main.json",
|
||||
"credentialsFile": "flows/main_cred.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Reference in a new issue