mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-25 10:17:23 +00:00
added configuration help
This commit is contained in:
Paulus Schoutsen
parent
9a1bd4db63
commit
ddd322c468
@ -18,4 +18,5 @@ body > footer {
|
|||||||
.copyright {
|
.copyright {
|
||||||
margin: 0;
|
margin: 0;
|
||||||
padding: 20px 0;
|
padding: 20px 0;
|
||||||
}
|
text-align: center;
|
||||||
|
}
|
||||||
|
|||||||
@ -47,6 +47,7 @@ scene:
|
|||||||
brightness: 200
|
brightness: 200
|
||||||
```
|
```
|
||||||
|
|
||||||
|
<a name='sabnzbd'></a>
|
||||||
__SABnzbd__<br>
|
__SABnzbd__<br>
|
||||||
<img src='/images/supported_brands/sabnzbd.png' style='border:none; box-shadow: none; float: right;' height='50' />
|
<img src='/images/supported_brands/sabnzbd.png' style='border:none; box-shadow: none; float: right;' height='50' />
|
||||||
James Cole has contributed support to integrate SABnzbd. This will allow you to monitor your downloads from within Home Assistant and setup automation based on the information.
|
James Cole has contributed support to integrate SABnzbd. This will allow you to monitor your downloads from within Home Assistant and setup automation based on the information.
|
||||||
@ -68,6 +69,7 @@ sensor:
|
|||||||
- type: 'disk_free'
|
- type: 'disk_free'
|
||||||
```
|
```
|
||||||
|
|
||||||
|
<a name='pushover'></a>
|
||||||
__PushOver__<br>
|
__PushOver__<br>
|
||||||
<img src='/images/supported_brands/pushover.png' style='border:none; box-shadow: none; float: right;' height='50' />
|
<img src='/images/supported_brands/pushover.png' style='border:none; box-shadow: none; float: right;' height='50' />
|
||||||
James Cole has also contributed support for <a href='https://pushover.net/'>the PushOver service</a> as a platform for the notify component. This allows components to send messages to the user using PushOver.
|
James Cole has also contributed support for <a href='https://pushover.net/'>the PushOver service</a> as a platform for the notify component. This allows components to send messages to the user using PushOver.
|
||||||
|
|||||||
34
source/components/tellstick.markdown
Normal file
34
source/components/tellstick.markdown
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
---
|
||||||
|
layout: page
|
||||||
|
title: "Setting up TellStick"
|
||||||
|
description: "Instructions how to integrate your TellStick into Home Assistant."
|
||||||
|
date: 2015-03-28 13:06
|
||||||
|
sidebar: false
|
||||||
|
comments: false
|
||||||
|
sharing: true
|
||||||
|
footer: true
|
||||||
|
---
|
||||||
|
|
||||||
|
The TellStick Home Assistant integration allows users to add switches and sensors.
|
||||||
|
|
||||||
|
To get started, add the following information to your `configuration.yaml`:
|
||||||
|
|
||||||
|
```YAML
|
||||||
|
switch:
|
||||||
|
platform: tellstick
|
||||||
|
|
||||||
|
sensor:
|
||||||
|
platform: tellstick
|
||||||
|
|
||||||
|
# optionally, you can name your sensors by mapping ID to their name
|
||||||
|
2: Outside
|
||||||
|
5: Fridge
|
||||||
|
|
||||||
|
# Set only_named to 1 to hide all sensors that you did not mention.
|
||||||
|
only_named: 1
|
||||||
|
|
||||||
|
# All dimmers will be picked up as lights.
|
||||||
|
light:
|
||||||
|
platform: tellstick
|
||||||
|
|
||||||
|
```
|
||||||
55
source/getting-started/configuration.markdown
Normal file
55
source/getting-started/configuration.markdown
Normal file
@ -0,0 +1,55 @@
|
|||||||
|
---
|
||||||
|
layout: page
|
||||||
|
title: "Configuring Home Assistant"
|
||||||
|
description: "Configuring Home Assistant."
|
||||||
|
date: 2015-03-23 12:50
|
||||||
|
sidebar: false
|
||||||
|
comments: false
|
||||||
|
sharing: true
|
||||||
|
footer: true
|
||||||
|
---
|
||||||
|
|
||||||
|
The configuration for Home Assistant lives by default in the `config` folder. The file `configuration.yaml` is the main file that contains which components will be loaded and what their configuration is. An example configuration file is located at [`config/configuration.yaml.example`](https://github.com/balloob/home-assistant/blob/master/config/configuration.yaml.example).
|
||||||
|
|
||||||
|
When launched for the first time, Home Assistant will write a default configuration enabling the web interface and device discovery. It can take up to a minute for your devices to be discovered and show up in the interface.
|
||||||
|
|
||||||
|
<p class='note'>
|
||||||
|
You will have to restart Home Assistant for changes in <code>configuration.yaml</code> to take effect.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
### Password protecting the web interface
|
||||||
|
|
||||||
|
The first thing you want to add is a password for the web interface. Use your favourite text editor to open the file `/config/configuration.yaml` and add the following to the bottom:
|
||||||
|
|
||||||
|
```
|
||||||
|
http:
|
||||||
|
api_password: YOUR_PASSWORD
|
||||||
|
```
|
||||||
|
|
||||||
|
### {% linkable_title Adding devices and services %}
|
||||||
|
|
||||||
|
Home Assistant will be able to automatically discover and configure any Google Chromecasts, Belkin WeMo switches and Philips Hue bridges in your network if you have [the discovery component]({{site_root}}/components/discovery.html) enabled (which is by default).
|
||||||
|
|
||||||
|
Not all devices can be discovered, so if you have any of the following devices or services, please see their respective pages for installation instructions:
|
||||||
|
|
||||||
|
* [Nest thermostat]({{site_root}}/components/thermostat.html)
|
||||||
|
* [Wink hub]({{site_root}}/components/wink.html)
|
||||||
|
* [TellStick](/components/tellstick.html)
|
||||||
|
* [PushBullet]({{site_root}}/components/notify.html)
|
||||||
|
* [PushOver](/blog/2015/03/22/release-notes/#pushover)
|
||||||
|
* [SABnzbd](/blog/2015/03/22/release-notes/#sabnzbd)
|
||||||
|
* [Device tracking]({{site_root}}/components/device_tracker.html)
|
||||||
|
* [Add support for your own device or service]({{site_root}}/developers/add_new_platform.html)
|
||||||
|
|
||||||
|
### {% linkable_title Setting up Home Automation %}
|
||||||
|
|
||||||
|
When all your devices are set up it's time to put the cherry on the pie: automation. There are many ways to automate your home with Home Assistant so we have divided it into a couple of topics:
|
||||||
|
|
||||||
|
* [Automatic light control based on the sun and if people are home]({{site_root}}/components/device_sun_light_trigger.html) (built-in component)
|
||||||
|
* [Intruder alerts]({{site_root}}/components/simple_alarm.html) (built-in component)
|
||||||
|
* [Setup your own automation rules]({{site_root}}/components/automation.html) (using configuration file)
|
||||||
|
* [Create your own automation component]({{site_root}}/developers/creating_components.html) (writing Python code)
|
||||||
|
|
||||||
|
### {% linkable_title Setting up your phone or tablet %}
|
||||||
|
|
||||||
|
Home Assistant runs as a self hosted web application. Home Assistant contains support to be added to your homescreen. If you're on Android you can follow [the visual guide]({{site_root}}/getting-started/android.html). For other devices, open Home Assistant on your mobile browser and click on the add to homescreen option.
|
||||||
@ -143,47 +143,4 @@ python3 -m homeassistant
|
|||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## {% linkable_title Configuring Home Assistant %}
|
###[Next step: configuring Home Assistant »](/getting-started/configuration.html)
|
||||||
|
|
||||||
The configuration for Home Assistant lives by default in the `config` folder. The file `configuration.yaml` is the main file that contains which components will be loaded and what their configuration is. An example configuration file is located at [`config/configuration.yaml.example`](https://github.com/balloob/home-assistant/blob/master/config/configuration.yaml.example).
|
|
||||||
|
|
||||||
When launched for the first time, Home Assistant will write a default configuration enabling the web interface and device discovery. It can take up to a minute for your devices to be discovered and show up in the interface.
|
|
||||||
|
|
||||||
<p class='note'>
|
|
||||||
You will have to restart Home Assistant for changes in <code>configuration.yaml</code> to take effect.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
### Password protecting the web interface
|
|
||||||
|
|
||||||
The first thing you want to add is a password for the web interface. Use your favourite text editor to open the file `/config/configuration.yaml` and add the following to the bottom:
|
|
||||||
|
|
||||||
```
|
|
||||||
http:
|
|
||||||
api_password: YOUR_PASSWORD
|
|
||||||
```
|
|
||||||
|
|
||||||
### {% linkable_title Adding devices and services %}
|
|
||||||
|
|
||||||
Home Assistant will be able to automatically discover and configure any Google Chromecasts, Belkin WeMo switches and Philips Hue bridges in your network if you have [the discovery component]({{site_root}}/components/discovery.html) enabled (which is by default).
|
|
||||||
|
|
||||||
Not all devices can be discovered, so if you have any of the following devices or services, please see their respective pages for installation instructions:
|
|
||||||
|
|
||||||
* [Nest thermostat]({{site_root}}/components/thermostat.html)
|
|
||||||
* [Wink hub]({{site_root}}/components/wink.html)
|
|
||||||
* [PushBullet]({{site_root}}/components/notify.html)
|
|
||||||
* [Device tracking]({{site_root}}/components/device_tracker.html)
|
|
||||||
* [Sun]({{site_root}}/components/sun.html)
|
|
||||||
* [Add support for your own device or service]({{site_root}}/developers/add_new_platform.html)
|
|
||||||
|
|
||||||
### {% linkable_title Setting up Home Automation %}
|
|
||||||
|
|
||||||
When all your devices are set up it's time to put the cherry on the pie: automation. There are many ways to automate your home with Home Assistant so we have divided it into a couple of topics:
|
|
||||||
|
|
||||||
* [Automatic light control based on the sun and if people are home]({{site_root}}/components/device_sun_light_trigger.html) (built-in component)
|
|
||||||
* [Intruder alerts]({{site_root}}/components/simple_alarm.html) (built-in component)
|
|
||||||
* [Setup your own automation rules]({{site_root}}/components/automation.html) (using configuration file)
|
|
||||||
* [Create your own automation component]({{site_root}}/developers/creating_components.html) (writing Python code)
|
|
||||||
|
|
||||||
### {% linkable_title Setting up your phone or tablet %}
|
|
||||||
|
|
||||||
Home Assistant runs as a self hosted web application. Home Assistant contains support to be added to your homescreen. If you're on Android you can follow [the visual guide]({{site_root}}/getting-started/android.html). For other devices, open Home Assistant on your mobile browser and click on the add to homescreen option.
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user