Skip to content

Latest commit

 

History

History
141 lines (95 loc) · 4.95 KB

README.md

File metadata and controls

141 lines (95 loc) · 4.95 KB

FarmPi

A weekend gardening project I designed for a small greenhouse in Reykjalundur, Iceland, grown and maintained by a farmgeek friend of mine, Nick Robinson. Growing squash in Iceland seems to be tough so he wanted constant temperature measurement in soil and air.

The sensors used are ds18b20. The application backend is scalable and will read values from all sensors it can find and save it to DB.

See DEMO

note: the demo is generating random numbers since the Pi and the sensors are occupied :-)

Installation

First of all, you need the Pi, the sensors and other stuff to hook them up.

I bought and followed everything in this tutorial.

After you have wired everything up correctly and the sensors are working you can install the app.

$ git clone https://github.com/busla/farmpi
$ npm install
$ bower install
$ npm start

There are configuration files in the config folder that can be modified. To load the appropriate config file, add NODE_ENV variable with the name of your environment:

$ export NODE_ENV=raspberrypi

Node will load the settings from the file with the corresponding filename.

  "Sensors": {
    "device": "raspberrypi",
    "saveInterval": 15, // minutes
    "currentTempInterval": 1, // seconds
  }

The code

I used NeDB database since it´s a node module and has an API similar to MongoDB. The app iterates over connected sensors and stores their id, value and type (user defined) with a timestamp. Drawing this data on a line graph with time on X axis and temperature on Y becomes relatively simple.

Socket.IO is used to pipe new temperatures to the clients and draw on the chart. The data is live on the screen.

You can pass {'from': $date, 'to': $date} to /api/chart and get the following json:

{
    "sensors": [{
        "id": "28-000006a3684e",
        "type": "soil",
        "currentTemp": 22.755530063528568
    }, {
        "id": "28-000006a36dbe",
        "type": "air",
        "currentTemp": 22.94879347225651
    }],
    "date": 1435613824213,
    "_id": "qwBoea1IznS2xbN7"
}

Run forever

To run the app independently on your Pi, install the forever module. It will run on port :3000, but if you want to run it on port 80, you can route all requests from 3000 > 80 with the following command:

$ sudo npm install -g forever
$ cd your-project
$ sudo forever start your-app-name.js

sudo iptables -t nat -A PREROUTING -i eth0 -p tcp --dport 80 -j REDIRECT --to-port 3000

Also, to start on boot you can install forever as a service with the, you guessed it, forever-service module.

$ sudo npm install -g forever-service

You will have to add the $PATH variable to you startup script, for example:

$ cd farmpi
$ sudo forever-service install farmpi -e "PATH=/usr/local/bin:\$PATH"

Usage

You can read temperatures within a selected date range.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Credits

Chart.js

Bootstrap

DateRangePicker

RPi

NodeJS

NeDB

License

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to http://unlicense.org