mirror of https://github.com/home-assistant/core synced 2024-10-01 00:25:48 +00:00

Find a file

Paulus Schoutsen 9a6b2c1831 Add utf-8 encoding to const file		2015-09-26 06:57:22 -07:00
config	Minor comment about weather components & LONG:LAT.	2015-09-22 15:53:16 -04:00
docs	Update screenshot	2015-08-30 17:48:06 -07:00
homeassistant	Add utf-8 encoding to const file	2015-09-26 06:57:22 -07:00
script	Merge pull request #316 from fabaff/systemd	2015-09-21 19:45:12 -07:00
tests	Fix tests and linting	2015-09-20 11:46:01 -07:00
.coveragerc	Add rest sensor	2015-09-23 01:17:28 +02:00
.gitignore	Fix CI	2015-09-19 12:29:23 -07:00
.gitmodules	Remove latest git submodules	2015-09-08 20:11:25 -07:00
.travis.yml	Add travis install section back	2015-09-17 08:54:56 -07:00
CONTRIBUTING.md	Moved plexapi import into setup_platform().	2015-09-21 11:59:55 -04:00
Dockerfile	Make nmap work in Docker	2015-08-31 22:01:45 -07:00
LICENSE	Added MIT license	2013-10-08 21:18:22 -07:00
MANIFEST.in	Add MANIFEST.in	2015-09-01 01:36:00 -07:00
pylintrc	Remove external from scripts and package info	2015-09-09 09:08:06 -07:00
pytest.ini	Fix CI	2015-09-19 12:29:23 -07:00
README.md	add mention of iTunes to README	2015-09-11 23:06:48 -04:00
requirements.txt	Pip requirements and fixes.	2015-08-29 23:17:47 -04:00
requirements_all.txt	Merge pull request #433 from stefan-jonasson/fix_telldus_libary_cleanup	2015-09-23 12:15:31 +02:00
setup.py	move launchd script inside package	2015-09-15 02:29:57 -04:00

README.md

Home Assistant

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.

To get started:

python3 -m pip install homeassistant
hass --open-ui

Check out the website for a demo, installation instructions, tutorials and documentation.

Examples of devices it can interface it:

Monitoring connected devices to a wireless router: OpenWrt, Tomato, Netgear, DD-WRT, TPLink, and ASUSWRT
Philips Hue lights, WeMo switches, Edimax switches, Efergy energy monitoring, RFXtrx sensors, and Tellstick devices and sensors
Google Chromecasts, Music Player Daemon, Logitech Squeezebox, Kodi (XBMC), and iTunes (by way of itunes-api)
Support for ISY994 (Insteon and X10 devices), Z-Wave, Nest Thermostats, Arduino, Raspberry Pi, and Modbus
Integrate data from the Bitcoin network, meteorological data from OpenWeatherMap and Forecast.io, Transmission, or SABnzbd.
See full list of supported devices

Built home automation on top of your devices:

Keep a precise history of every change to the state of your house
Turn on the lights when people get home after sun set
Turn on lights slowly during sun set to compensate for less light
Turn off all lights and devices when everybody leaves the house
Offers a REST API and can interface with MQTT for easy integration with other projects
Allow sending notifications using Instapush, Notify My Android (NMA), PushBullet, PushOver, Slack, and Jabber (XMPP)

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, check the Home Assistant help section how to reach us.