Skip to content

benrady/roost

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Roost -- Open Source Home Automation

Roost is open-source home automation based on the Raspberry Pi

Supported Devices

The following devices/services are supported in the latest release

  • Local Weather Reports (via Weather Underground)
  • Push notifications (via Pushover)

Roost is an open system (both software and hardware), so you can always make your own devices using ZigBee compatible radios, or write your own Roost "service" in Python to connect Roost to a new device.

3rd Party Peripherals

ZigBee certified products

Recommended Hardware

Roost uses a Raspberry Pi Model B as a base station, and talks to devices in your home using a mesh radio network, so there are no wires to run. A complete parts list for a base station will be available.

Releases

Roost is currently under development. Roost is expected to be released as a debian package (for easy setup on the Raspberry Pi). No stable releases are currently available. Feedback and pull requests are encouraged.

Installation

####Install dependencies

sudo apt-get install python-setuptools python-twisted

####Clone this repository; Run installation

sudo python setup.py install

Setting up a new radio

A service can optionally be associated with a xbee radio device. Each pin on an xbee radio can be associated with a service. Doing so adds an entry to the "sources" map on the service.

  1. Open the "services" page in roost
  2. Power up the radio. Bring pin 1 high? (or it is low?).
  3. This sends a message that the xbee service receives. It fires a xbee.new event with the radio's specs. It also adds the radio to the list of sources.
  4. In the web UI, the user is notified that a new device has been detected
  5. On the "services" page, the user can now assign that radio to a particular service

Support

Telnet access

Development

Roost is primarily test driven. You can run the tests with trial.

You can run a development server like so: twistd -n roost

About

An open source home automation gateway

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published