mechhome v0.1.3

MechHome for node.js

Description

This project provides a framework for DIY home automation and security monitoring.

Install

npm install mechhome

Configure

MechHome currently relies on a Redis backend, meaning you must first install Redis.

config/mechhome.properties supplies parameters for the application and all plugins.

The application won't do a whole lot without plugins defined: mechhome.plugins = plugin name 1,...,plugin name N

Extend

Plugins are implemented by creating a plugins/plugin_name/index.js file with the following at a minimum:

function init(appHandle) { appHandle.register('plugin name', function(type, obj) { // Handle application events here }); exports.init = init;

The appHandle currently provides access to the following:

• register('plugin name', callback) - This allows the plugin to receive event data
• log('type', object) - Messaging to other plugins (rename might be in order)
• config'key' - Access to properties file
• setZone(oldZone, newZone) - Modify a zone (see database.js:initialize() for example definition)

See some of the existing plugins for more examples.

TODO's

This project is in early development, and any feedback/changes are appreciated.

• UX/UI work for the web_interface plugin - I'm not a web developer and it shows...
• Implement proxy plugin to allow MechHome processes on other machines to forward device data, etc.
• Add implementation details (and Arduino code) for the arduino_device plugin (dcrouse)
• Create 'device' plugins for system alerts, HVAC (e.g. Nest), lighting control, X11, etc.
• Evolve the concept of zone types, with different behavior for doors vs. motion sensors, for example. Should types be plugins?
• Create non-persistent 'database' plugin alternative to the current Redis-backed database.js.
• Improve the way zones are defined (i.e. not hard-coded in database.js:initialize())
• Finish demo plugin
• Write some tests!
• Lots more...

License

(The MIT License)

Copyright (c) 2012 Devon Crouse <devoncrouse@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.