mirror of https://github.com/home-assistant/core synced 2024-10-14 19:59:17 +00:00

Find a file

Paulus Schoutsen 9c61c281ca Working zwave! Open docker, go to /usr/src/balloob-python-openzwave/examples, run python3 api_demo.py --device=/zwaveusbstick --log=Debug		2015-02-28 20:27:42 -08:00
config	Group component now supports lists in the config	2015-02-28 19:22:16 -08:00
docs
homeassistant	Auto set friendly name in state attributes	2015-02-28 20:10:39 -08:00
scripts	Working zwave!	2015-02-28 20:27:42 -08:00
tests	Fix device tracker tests	2015-02-27 18:45:06 -08:00
.gitignore	Remove frontend dependencies from git repo	2015-02-01 17:55:22 -08:00
.gitmodules	Frontend now build on top of home-assistant-js	2015-02-03 23:16:53 -08:00
.travis.yml	Exclude external libraries from code coverage	2015-01-15 21:35:11 -08:00
CONTRIBUTING.md
Dockerfile	Working zwave!	2015-02-28 20:27:42 -08:00
LICENSE
pylintrc	Disable pylint unused-argument check	2015-01-19 23:40:51 -08:00
README.md	ps: Slim down README.md	2015-02-27 18:29:49 -08:00
requirements.txt	Added support for YAML configuration files	2015-02-28 16:56:58 +01:00

README.md

Home Assistant

This is the source code for Home Assistant. For installation instructions, tutorials and the docs, please see the website. For a functioning demo frontend of Home Assistant, click here.

Home Assistant is a home automation platform running on Python 3. The goal of Home Assistant is to be able to track and control all devices at home and offer a platform for automating control.

It offers the following functionality through built-in components:

Track if devices are home by monitoring connected devices to a wireless router (supporting OpenWrt, Tomato, Netgear)
Track and control Philips Hue lights
Track and control WeMo switches
Track and control Google Chromecasts
Track running services by monitoring ps output
Track and control Tellstick devices and sensors
Turn on the lights when people get home after sun set
Turn on lights slowly during sun set to compensate for light loss
Turn off all lights and devices when everybody leaves the house
Offers web interface to monitor and control Home Assistant
Offers a REST API for easy integration with other projects
Ability to have multiple instances of Home Assistant work together

Home Assistant also includes functionality for controlling HTPCs:

Simulate key presses for Play/Pause, Next track, Prev track, Volume up, Volume Down
Download files
Open URLs in the default browser

The system is built modular so support for other devices or actions can be implemented easily. See also the section on architecture and the section on creating your own components.

If you run into issues while using Home Assistant or during development of a component, reach out to the Home Assistant developer community.

Installation instructions / Quick-start guide

Running Home Assistant requires that python 3.4 and the package requests are installed. Run the following code to install and start Home Assistant:

git clone --recursive https://github.com/balloob/home-assistant.git
cd home-assistant
pip3 install -r requirements.txt
python3 -m homeassistant --open-ui

The last command will start the Home Assistant server and launch its webinterface. By default Home Assistant looks for the configuration file config/home-assistant.conf. A standard configuration file will be written if none exists.

If you are still exploring if you want to use Home Assistant in the first place, you can enable the demo mode by adding the --demo-mode argument to the last command.

Please see the getting started guide on how to further configure Home Asssitant.