-
Notifications
You must be signed in to change notification settings - Fork 116
Installation
Z-Way Home Automation Engine (ZAutomation) is bundled with the Z-Way software.
Besides that, users can manually download and enable this engine. Moreover, this project's code has been open-sourced.
Current production (release) version of the ZAutomation can be downloaded (or cloned via git) from the project's page on the GitHub: https://github.com/Z-Wave-Me/home-automation (master branch)
To download as a .ZIP archive use the following url: https://github.com/Z-Wave-Me/home-automation/archive/master.zip
To clone via Git use the following command:
git clone https://github.com/Z-Wave-Me/home-automation.git
We tend to the "clean trunk" tradition (which, however, may be not so clean sometimes) and current development code version resists in the develop branch of the same repository: https://github.com/Z-Wave-Me/home-automation/tree/develop
We also using git-flow in our development process.
Warning: development code version absolutely should not be used in a real-life environment. This even may be dangerous or at least buggy.
Cloned or downloaded code should be moved (or symlinked) to the automation directory withing the z-way-server directory. Also, z-way-server/htdocs/z-way-ha directory should be symlinked to the automation/htdocs.
Ensure there is a
<automation-dir>automation</automation-dir>
directive in the z-way-server/config.xml and restart Z-Way daemon.
We are much appreciate any kind of participating in the ZAutomation project. You may suggest features, file bug reports and create and publish your own automation modules. The project's issue tracker is on GitHub: https://github.com/Z-Wave-Me/home-automation/issues
Feel free to propose you own ZAutomation modules and additions to be published. You can easily do so via the pull requests.
In general, patching process may look like this:
-
Fork the repository to your GitHub account by clicking "Fork" button in top right corner of the project's github homepage;
-
Clone your own fork locally
-
Create a new branch (we suggest you to give it descriptive name, i.e.: autoCallMom)
-
Write some code
-
Push your branch to your github's forked repository
-
Navigate in the code browser to you branch and click on "Compare and review" button.
-
Click "Click to create a pull request for this comparison". Enter description. Click "Create pull request" button.
Everything else would be done automatically.
This process described in details on GitHub's help page: https://help.github.com/articles/creating-a-pull-request