Overview

General (home) automation framework based on node.js and mongoDB.

The aim is to provide a framework for home automation that can be used for example to control the lights on when the motion detector can see the movement. At first version will support onewire for get temperatures and then purpose is to get also zwave support.

• Discussion group

Big Picture

HOME.JS

Single-page web UI (http://host:port/)
  

Services ( [POST] /service/:name[/:func] ): 
 allowed functions: start, stop
 * cron  (handle periodic functionality)
 * database (not implemented, manual setup)
 * owfs     (not implemented,manual setup) 


Collections ( /:collection   /:collection/:item )
 RESTful CRUD functions
 * users 
 * groups
 * devices
 * actions
 * schedules
 * ...


Simple setup:
[sensors] <--> [home.js] <--> [webUI]

Plan

Features (planned)

• Upgrade directly from web UI
• Users and groups + authentication
• node.js based server with flexible db (mongodb)
• HTTP RESTful API
• single-page front-end (really fast)
• schedules scripts
• action scripts
• Email alerts (e.g. if temperature goes over limits)
• Supported hardware:
  • onewire
  • zwave
  • ...

Installation

See INSTALL file.

Dependencies

• nodejs
• mongodb
• owfs (will be optional dependency)
  • limitations: owfs support only Linux.
  • I've thinking to start using some other onewire library

Used node modules

• express
• express-resource
• jade
• mongoose
• uuid
• owfs
• emailjs
• cron
• hoard
• winston
• keypress
• optimist
• daemonize2

Front-end libraries

• Backbone
• requirejs
• w2ui
• jsTree
• jsonform
• flot
• ...

Test

API Tested against node.js versions

HW requirements

• Supported OS: Linux/partially windows
• Supported HW: Raspberry Pi & x86 based systems

To do

• [x] Reorganize folder structure
• [x] basic test steps against API
• [ ] nice GUI
• [ ] more functionality

Contributors

• Jussi Vatjus-Anttila

License

Released under the MIT License. See LICENSE file.

Copyright © 2013 by Jussi Vatjus-Anttila.