mirror of
https://github.com/home-assistant/core.git
synced 2025-07-10 06:47:09 +00:00
Update README
This commit is contained in:
parent
ae896f4a33
commit
a3812a324c
35
README.md
35
README.md
@ -1,10 +1,18 @@
|
|||||||
# Home Assistant [](https://travis-ci.org/balloob/home-assistant) [](https://coveralls.io/r/balloob/home-assistant?branch=master) [](https://gitter.im/balloob/home-assistant?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
# Home Assistant [](https://travis-ci.org/balloob/home-assistant) [](https://coveralls.io/r/balloob/home-assistant?branch=master) [](https://gitter.im/balloob/home-assistant?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||||
|
|
||||||
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. [Open a demo.](https://home-assistant.io/demo/)
|
[demo]: https://home-assistant.io/demo/
|
||||||
|
|
||||||
Check out [the website](https://home-assistant.io) for installation instructions, tutorials and documentation.
|
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.
|
||||||
|
|
||||||
[](https://home-assistant.io/demo/)
|
To get started:
|
||||||
|
```bash
|
||||||
|
python3 -m pip install homeassistant
|
||||||
|
hass --open-ui
|
||||||
|
```
|
||||||
|
|
||||||
|
Check out [the website](https://home-assistant.io) for [a demo][demo], installation instructions, tutorials and documentation.
|
||||||
|
|
||||||
|
[][demo]
|
||||||
|
|
||||||
Examples of devices it can interface it:
|
Examples of devices it can interface it:
|
||||||
|
|
||||||
@ -21,26 +29,9 @@ Built home automation on top of your devices:
|
|||||||
* Turn on the lights when people get home after sun set
|
* Turn on the lights when people get home after sun set
|
||||||
* Turn on lights slowly during sun set to compensate for less light
|
* Turn on lights slowly during sun set to compensate for less light
|
||||||
* Turn off all lights and devices when everybody leaves the house
|
* Turn off all lights and devices when everybody leaves the house
|
||||||
* Offers a [REST API](https://home-assistant.io/developers/api.html) for easy integration with other projects
|
* Offers a [REST API](https://home-assistant.io/developers/api.html) and can interface with MQTT for easy integration with other projects
|
||||||
* Allow sending notifications using [Instapush](https://instapush.im), [Notify My Android (NMA)](http://www.notifymyandroid.com/), [PushBullet](https://www.pushbullet.com/), [PushOver](https://pushover.net/), [Slack](https://slack.com/), and [Jabber (XMPP)](http://xmpp.org)
|
* Allow sending notifications using [Instapush](https://instapush.im), [Notify My Android (NMA)](http://www.notifymyandroid.com/), [PushBullet](https://www.pushbullet.com/), [PushOver](https://pushover.net/), [Slack](https://slack.com/), and [Jabber (XMPP)](http://xmpp.org)
|
||||||
|
|
||||||
The system is built modular so support for other devices or actions can be implemented easily. See also the [section on architecture](https://home-assistant.io/developers/architecture.html) and the [section on creating your own components](https://home-assistant.io/developers/creating_components.html).
|
The system is built modular so support for other devices or actions can be implemented easily. See also the [section on architecture](https://home-assistant.io/developers/architecture.html) and the [section on creating your own components](https://home-assistant.io/developers/creating_components.html).
|
||||||
|
|
||||||
If you run into issues while using Home Assistant or during development of a component, reach out to the [Home Assistant help section](https://home-assistant.io/help/) how to reach us.
|
If you run into issues while using Home Assistant or during development of a component, check the [Home Assistant help section](https://home-assistant.io/help/) how to reach us.
|
||||||
|
|
||||||
## Quick-start guide
|
|
||||||
|
|
||||||
Running Home Assistant requires [Python 3.4](https://www.python.org/). Run the following code to get up and running:
|
|
||||||
|
|
||||||
```
|
|
||||||
git clone --recursive https://github.com/balloob/home-assistant.git
|
|
||||||
python3 -m venv home-assistant
|
|
||||||
cd home-assistant
|
|
||||||
python3 -m homeassistant --open-ui
|
|
||||||
```
|
|
||||||
|
|
||||||
The last command will start the Home Assistant server and launch its web interface. By default Home Assistant looks for the configuration file `config/configuration.yaml`. 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](https://home-assistant.io/getting-started/) on how to further configure Home Assistant.
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user