zhome

zhome

MIT

This is a work in progress.

zhome is a home automation service that allows you to turn lights on and off using a web interface. Currently the service is running on my raspberry pi and supports the following devices.

• Arduino Firmata (not tested after latest changes)

• Arduino zIOBoard
  Custom communication protocol. see './arduino/zIOBoard/' for details.

• Qwikswitch devices.
  http://www.qwikswitch.co.za/

Project Overview

Features

• Basic Device Control from a web app.
• Scheduler
• [Done] Log Sensor input to database.
• [Planned] Log All io comms to database and calculated electricity usage.
• [Planned] Show Sensor output in a graph.
• [Planned] Support profiles for Scheduler.
• [Planned] Edit configuration from web pages.
• [Planned] Websocket updates.

zhome uses go, coffeescript and jade

Folders

• Arduino - Contains the .ino files for the arduino board.
• client - Contains the html and javascript files for the front end.
• pkg - contains the go source files for the back-end server.
• scripts - some helper scripts for compiling and uploading to a raspberry pi. For development I use gin to reload the project while developing.

Getting Started

1. Build the client code, see './client/ReadMe.md'
2. Build the service. 'go build ./'

or if you have 'gin' installed simply run 'gin'

Build for Raspberry Pi

Change the ip in './scripts/build_pi.sh' and './scripts/update_pi_config.sh' scripts to build for the raspberry and copy the files onto the raspberry pi.

Installing as a service

copy './scripts/zhome.service' to '/etc/systemd/system'

sudo cp ./scripts/zhome.service /etc/systemd/system
sudo systemctl enable zhome
sudo service zhome start

Config File

config.yaml

Adding your Own Device

You can add your own device by creating a adopter with the interface below.

type DeviceComm interface {
  ID() string
  RegisterChannel(id string, address string, chType string)
  // RegisterEventHandler() will be removed, events will use a channel instead.
  RegisterEventHandler(handler EventHandler)
  Start()
  Stop()
  Status() *Status
  GetValue(chAddress string) (ValueMap, error)
  SetValue(chAddress string, value ValueMap) error
}

Create a folder in 'pkg/hardware/' and copy your adapter.

Add the name of your device in 'pkg/hardware/hardware.go' so that it can be loaded when configured.