Skip to content

hoffmannmatheus/eaZy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

63 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

eaZy

eaZy is a Home Automation project that proposes easyness on installation and configuration by using ZWave devices and a simple Web interface.

Note: eaZy is an early stage project.

Features

Control of ZWave devices by using a simple web interface.
eaZy Devices page eaZy Enery page eaZy Add Scene form

What you will need

  • ZWave Devices: The system communicates with ZWave devices by using a ZWave USB Controller (such as the ZStick 2).
  • Host: Any hardware supporting a debian-like linux distribution may work, though only a Desktop and Raspberry Pi have been tested until now. It is recommended Ubuntu or Raspbian, which used during development.
  • Software: Currently, there is no automatic installer. Though, the installation is not a big issue: just follow the scripts/install_dependencies.sh file.
  • Connection: The host needs to be connected to the local network so it can be accessed. Example: http://raspberrpi.local:3000 or http://<host-ip>:3000.

Contribute

If you are willing to contribute, take a look at the TODO list above. There is a lot of documentation (though it is written in portuguese). Current system architecture and TechStack:

  • Home Stack: component that implements the Home Automation logics and data persistency. Implemented in Lua.
  • eaZy Web: currently the only User Interface component, implemented using Node.js (back-end) and AngularJS (front-end).
  • Device Controller: interface between the system and the ZWave devices network. Implemented in Python, using the Python OpenZWave as API to communicate with the devices.

To view each component structure, take a look at the docs/images/ folder.

eaZy Arch

Support

If you have any problems or questions, feel free to open a new issue, or email me at hoffmann.matheus gmail.

TODO

Here is a list of features/improvements that could yet be implemented:

  • Tests: yes! there are no tests yet. Not proud of it, I really know the importance about testing, but since the requirements changed constantly during development and the deadline was short, the tests would have needed to be rewritten and updated too frequently to pay for it self on time.
  • User Access Control: there still is no authentication or security measures to operate eaZy. A first approach would be to implement a user-authentication REST API to the eaZyWeb component,so every user request has to be authenticated before taking effect.
  • Statisctitcs: the system could store logs (about user activity and ZWave devices activity aswell) so statistics like Device Consumption, Overall Energy Cost, User Traking (using presence sensors), Behaviour Analysis, and so on, could be generated.
  • Design Improvements: the User Interface design could use a lot of improvements.
  • New UI Component: a new User Interface like client-side application on Android, iOS or Windows.

License

The MIT License (MIT)

Copyright (c) 2014 Matheus Hoffmann Silva.

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.