From 2511bcf5dc90b8a8e435f1bee4871d67b776bcfb Mon Sep 17 00:00:00 2001 From: Pete ba Date: Sat, 4 May 2019 22:39:16 +0100 Subject: [PATCH] Add OWM key to .env --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ba5499d..5dc92f9 100644 --- a/README.md +++ b/README.md @@ -21,9 +21,7 @@ The production version runs on Amazon Elastic Beanstalk (AWS EB) and therefore t --- #### 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: you can run the command ```uname -m``` on your Raspberry Pi to help identify the chipset that is being used. +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* ``` @@ -54,19 +52,22 @@ Step 3: Install all of the dependencies using the Node Package Manager, npm, fro pi@OSPi:~ $ cd weather pi@OSPi:~/weather $ npm install ``` -Step 4: 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. +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 two lines to the .env file so that the weather server is configured to listen for weather requests. 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. +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= ``` -Step 5: Setup the Weather Server to start whenever the Raspberry Pi boots up using the built-in service manager: +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 @@ -97,6 +98,6 @@ 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 6: 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://:8080/su` and specify “localhost:3000” as the new location for the weather service. +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://: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. \ No newline at end of file