Full featured home automation system with wireless control functionality based on Open source hardware
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
public
.gitignore
app.js
package.json
readme.md

readme.md

Open Automation

Full featured home automation system with wireless control functionality based on Open source hardware. Can be installed on any computer, but specially designed for Intel Edison. Pure JavaScript implimentation based on Node.js.
Project Home.

Features

  • Monitoring solution without wires
  • Easy installation and configuration
  • 100% in house control - no cloud services required!
  • Implemented Temperature, Humidity, CO2, Energy metering applications with all modern house control functions
  • Up to 9 sensors support in one room
  • Touch friendly user interface based on jQuery Mobile
  • Simple JSON configuration
  • Runs without any database backend - sensors data stored in easilly readable text files
  • Strong security - implemented HOTP RFC4226 token authentication
  • Ciseco LLAP protocol compatible

DEMO

Check out the demo to see it in action on your mobile.

Installation

$ npm install openautomation
$ cd node_modules\openautomation

Start-Up on Intel Edison: node app.js -p 80

Start-Up on Linux board: node app.js -p 80 -s /dev/ttyUSB0

Start-Up on Windows box: node app.js -p 80 -s COM23

Command line arguments

   -h, --help           output usage information
   -V, --version        output the version number
   -s, --serial [port]  Set serial port for Radio communications [/dev/ttyMFD1]
   -p, --port [port]    Set TCP port for management interface, Default - 8000
   -n, --notoken        Disable HOTP RFC4226 authentication

First time Set-Up

  1. Start node application node app.js
  2. In first Start-Up this app will create an initial configuration stored in files settings.txt and serverID.txt
  3. Start this app again.
  4. Write down 8 symbols Server ID displayed in app terminal OA > Server ID: 00000000
  5. Open web application in browser. First time, You should get the authentication Error message.
  6. Press ToolBox --> Connection Set-Up, Enter OA Server ID and press Close.
  7. Have a Fun :)

P.S. To chenge initial rooms configuration to represent your home structure please modify app.js oaSetup section and delete settings.txt file.

Little about Sensors

Each sensor should have 2 symbols label. First symbol determine sensor type, second - sensor number. Sensor numbering should always start from 0. You can easily simulate any sensor. Just send this data to Your board serial port:

aT0TMPA20.20 - temperature sensor T0 value 20.20°C

aTATMPA-30.2 - temperature sensor TA value -30.2°C

aH9CRHP81.81 - humidity sensor H9 value 81.81%

aE0E:56.56 - Energy sensor E0 E value 56.56kwh

aE0P:1001 - Energy sensor E0 P value 1001W

For more information please read Project Wiki.

Credits

HTML5 Canvas gauges - https://github.com/Mikhus/canv-gauge

HOTP implementation - https://www.gitorious.org/hotp-js

Icons by Adam Whitcroft - http://adamwhitcroft.com/batch/

Charts - http://www.chartjs.org/

Digital-7 font - http://www.styleseven.com/php/get_product.php?product=Digital-7

License

MIT License

Copyright (c) 2015 Vaidotas Gudaitis (greituolis@gmail.com)

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

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 OR COPYRIGHT HOLDERS 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.