From ddd322c468a1d753d3feef1136b43a787eb1c34d Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Mon, 23 Mar 2015 13:30:21 -0700 Subject: [PATCH] added configuration help --- sass/oscailte/base/_footer.scss | 3 +- .../_posts/2015-03-22-release-notes.markdown | 2 + source/components/tellstick.markdown | 34 ++++++++++++ source/getting-started/configuration.markdown | 55 +++++++++++++++++++ source/getting-started/index.markdown | 45 +-------------- 5 files changed, 94 insertions(+), 45 deletions(-) create mode 100644 source/components/tellstick.markdown create mode 100644 source/getting-started/configuration.markdown diff --git a/sass/oscailte/base/_footer.scss b/sass/oscailte/base/_footer.scss index f601b1b8428..b50da8d1930 100644 --- a/sass/oscailte/base/_footer.scss +++ b/sass/oscailte/base/_footer.scss @@ -18,4 +18,5 @@ body > footer { .copyright { margin: 0; padding: 20px 0; -} \ No newline at end of file + text-align: center; +} diff --git a/source/_posts/2015-03-22-release-notes.markdown b/source/_posts/2015-03-22-release-notes.markdown index 1e94a947cb6..54b0c190b03 100644 --- a/source/_posts/2015-03-22-release-notes.markdown +++ b/source/_posts/2015-03-22-release-notes.markdown @@ -47,6 +47,7 @@ scene: brightness: 200 ``` + __SABnzbd__
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' ``` + __PushOver__
James Cole has also contributed support for the PushOver service as a platform for the notify component. This allows components to send messages to the user using PushOver. diff --git a/source/components/tellstick.markdown b/source/components/tellstick.markdown new file mode 100644 index 00000000000..b38ddaa9de8 --- /dev/null +++ b/source/components/tellstick.markdown @@ -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 + +``` diff --git a/source/getting-started/configuration.markdown b/source/getting-started/configuration.markdown new file mode 100644 index 00000000000..cc06fffcf0c --- /dev/null +++ b/source/getting-started/configuration.markdown @@ -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. + +

+ You will have to restart Home Assistant for changes in configuration.yaml to take effect. +

+ +### 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. diff --git a/source/getting-started/index.markdown b/source/getting-started/index.markdown index f8157d8255d..afe522f6fc3 100644 --- a/source/getting-started/index.markdown +++ b/source/getting-started/index.markdown @@ -143,47 +143,4 @@ python3 -m homeassistant -## {% linkable_title Configuring Home Assistant %} - -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. - -

- You will have to restart Home Assistant for changes in configuration.yaml to take effect. -

- -### 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. \ No newline at end of file +###[Next step: configuring Home Assistant »](/getting-started/configuration.html)