Merge pull request #18 from PeteBa/add-install-instructions

add-installation-instructions

README.md

@@ -17,3 +17,87 @@ The production version runs on Amazon Elastic Beanstalk (AWS EB) and therefore t
 **server.js** is the primary file launching the API daemon.
 
 **routes/*.js** contains all the endpoints for the API service. Currently, only one exists for weather adjustment.
+
+---
+#### Local Installation onto a Raspberry Pi
+
+Step 1: Download and install Node.js onto the Raspberry Pi so that we can run the OpenSprinkler weather server. The version of Node.js to install is dependent on your model of Raspberry Pi. Note that you can run the command ```uname -m``` on your Raspberry Pi to help identify the chipset that is being used.
+
+*For Raspberry Pi 2 or Pi 3 models that are based on the newer ARMv7 and ARMv8 chip*
+```
+pi@OSPi:~ $ curl -sL https://deb.nodesource.com/setup_11.x | sudo -E bash -l
+pi@OSPi:~ $ sudo apt install -y nodejs
+```
+
+*For Raspberry Pi Model A, B, B+, Zero and Compute Module based on the older ARMv6 chip, the process is slightly more convoluted*
+```
+pi@OSPi:~ $ wget https://nodejs.org/dist/v11.4.0/node-v11.4.0-linux-armv6l.tar.gz 
+pi@OSPi:~ $ tar -xvf node-v11.4.0-linux-armv6l.tar.gz 
+pi@OSPi:~ $ cd node-v11.4.0-linux-armv6l
+pi@OSPi:~ $ sudo cp -R * /usr/local/
+pi@OSPi:~ $ cd ..
+pi@OSPi:~ $ rm -rf node-v11.4.0-linux-armv6l
+pi@OSPi:~ $ rm node-v11.4.0-linux-armv6l.tar.gz
+
+```
+
+Step 2: Download the OpenSprinkler Weather Service repository to your Raspberry Pi so that we can run a local version of the service:
+
+```
+pi@OSPi:~ $ git clone https://github.com/OpenSprinkler/OpenSprinkler-Weather.git weather
+```
+
+Step 3: Install all of the dependencies using the Node Package Manager, npm, from within the weather project directory:
+```
+pi@OSPi:~ $ cd weather
+pi@OSPi:~/weather $ npm install
+```
+Step 4: Go to `https://openweathermap.org/appid` to register with OpenWeatherMaps and obtain an API key that is needed to request weather information.
+
+Step 5: The file .env is used by the weather server to specify the interface and port to listen on for OpenSprinkler Firmware weather requests. We need to create a new file, .env, and enter some configuration details.
+```
+pi@OSPi:~/weather $ nano .env
+```
+
+Add the following three lines to the .env file so that the weather server is configured to listen for weather requests and generate OWM calls. Using 0.0.0.0 as the host interfaces allows you to access the service from another machine to test. Alternatively, set HOST to “localhost” if you want to limit weather service access to only applications running on the local machine. Make sure to use the OWM API key that was provided during registration.
+
+```
+HOST=0.0.0.0
+PORT=3000
+OWM_API_KEY=<YOUR KEY>
+```
+
+Step 6: Setup the Weather Server to start whenever the Raspberry Pi boots up using the built-in service manager:
+
+```
+pi@OSPi:~/weather $ sudo nano /etc/systemd/system/weather.service
+```
+
+Cut and paste the following lines into the weather.service file:
+
+```
+[Unit]
+Description=OpenSprinkler Weather Server
+
+[Service]
+ExecStart=/usr/bin/node /home/pi/weather/server.js
+WorkingDirectory=/home/pi/weather
+Restart=always
+RestartSec=10
+
+[Install]
+WantedBy=multi-user.target
+```
+Save the file and enable/start the weather service
+
+```
+pi@OSPi:~/weather $ sudo systemctl enable weather.service
+pi@OSPi:~/weather $ sudo systemctl start weather.service
+pi@OSPi:~/weather $ systemctl status weather.service
+```
+
+The final line above checks that the service has been started and you should see the service marked as running.
+
+Step 7: You will now need to configure your OpenSprinkler device to use the local version of the Weather Service rather than the Cloud version. On a web browser from your PC, go to `http://<your OSPi IP>:8080/su` and specify “localhost:3000” as the new location for the weather service.
+
+OpenSprinkler should now be connected to your local Weather Service for calculating rain delay and watering levels.