paralax / homify

🏡 Open-source home automation / smarthome platform running on PHP (Laravel).

Homify 🏡

Open-source home-automation / smarthome platform running on PHP (Laravel).

Table of content

• About Homify
• Key Features
• Featured Plug-ins
• Setup
  • Composer
  • Database
  • Webserver
  • Note for PI users
• Rules
  • Features
  • Structure
  • Example
• HTTP-API
• Coming Soon
• Plug-in Development
• FAQ / CONTACT / TROUBLESHOOT
• Contributing

ABOUT HOMIFY

Homify is built using a modular approach so support for other devices or actions can be implemented easily. See also the section on creating your own plug-in below in this READ.me.

KEY FEATURES

• Manage your IoT-devices simply over the GUI
  • Instantly see if your device is online or not
• Automate your home with rules
• Install Plug-ins
  • Homify is built using a modular approach so support for other devices or actions can be implemented easily.
• Central Room Management
• Tablet View for your rooms

FEATURED PLUG-INS

• Sonos Plug-in
• RFOutlet (433 Mhz) Plug-in

SETUP

To install and run this application, you'll need Composer and PHP7 installed on your computer.

Composer

# Download & install Homify with its dependencies
$ composer create-project markushaug/homify
$ composer update

Database

Setup your database & mail settings in the .env file and then run:

# Creating tables and inserting their default values to them
$ php artisan migrate
$ php artisan db:seed

Webserver

• Set the webroot of your webserver to the public folder
• Grant permissions to the homify folder.
  • If the application runs into an issue, try this command inside of the homify directory: chmod -R 777 storage.

Note for Raspberry Pi users

I highly recommend to use nginx or lighttp. Apache2 is using too much CPU and RAM on the Raspberry PI.

RULES

Homify supports rules to automate your home. You can create an rule via Homifys web interface.

Features

• Define multiple rules for one thing.
  Each rule expands the entire rule base of the respective item with a logical OR.
  IF <RULE1> === TRUE || <RULE2> === TRUE || ...
  
• The ThingController calls the RuleParser every time an event is triggered and scans for defined rules in the rule base.
• Time-controlled events are constructed as a cron job that triggers the execution block.

Structure

Each Rule has the following structure:

{
	"rule": "rule name (unique)",
	"if": {
        /*<TRIGGER CONDITION>*/
	},
	"then": {
        /*
        <EXECUTION_BLOCK1> and
        <EXECUTION_BLOCK2>
        */
	}
}

Example

Below is an example of a rule with a time-controlled event wich triggers an channel of the defined thing.

{
	"rule": "goodEvening",
	"if": {
		"time": "20:00:00"
	},
	"then": {
		"thing": {
			"name": "Play1",
			"channel": "off"
		}
	}
}

HTTP-API

Homify provides an http-api to acces your things. You can use the following HTTP-GET Request to access your things:

• https://<server_ip>/thing/<thing_name>/<channel>

For example:

• https://10.10.3.1/thing/Sonos:Play1/on

COMING SOON

• WebGUI for central room management & device management
• Tablet View for single rooms
• HAP-Protocol (HomeKit) integration

PLUG-IN DEVELOPMENT

Ech Plug-in inherits from an Thing-Type (Light, Switcher, Speaker, etc.). Each Thing-Type inherits from the abstract thing class. So each thing has the required functions.

If you are creating an plug-in for homify, you have to inherit from an Thing-Type. Or you create an additional thing-type. Each Thing needs an <Thing>.php, Create<Thing>.php and an Update<Thing>.php File. You can take on of the existing Plug-ins as template.

FAQ / CONTACT / TROUBLESHOOT

If you run into issues while using Homify or during development of a component, please use one of the following options:

• Use github's issue reporter on the right, so that other people can search these issues too
• Send me an email [email protected] (might take a few days)

CONTRIBUTING

I would appreciate it if you would contribute to this project. Do not hesitate to contact me if you are interested. I can give you an introduction to the core and the main concepts of the program. (Intermediate) Laravel skills are desirable.

---

Homepage haugmarkus.de  ·  GitHub @markushaug  ·  Twitter @markushaug