jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Convert documentation to use configuration.yaml

Browse source
This commit is contained in:
Paulus Schoutsen 2015-02-28 10:26:58 -08:00
parent 111338007d
commit 4108e166ff
19 changed files with 150 additions and 154 deletions
Download patch file Download diff file Expand all files Collapse all files

2
source/developers/api.markdown
View file

@ -16,7 +16,7 @@ Home Assistent runs a webserver accessible on port 8123.
In the package [`homeassistant.remote`](https://github.com/balloob/home-assistant/blob/master/homeassistant/remote.py) a Python API on top of the HTTP API can be found.
The API accepts and returns only JSON encoded objects. All API calls have to be accompanied by the header `X-HA-Access: YOUR_PASSWORD` (as specified in your `home-assistant.conf`).
The API accepts and returns only JSON encoded objects. All API calls have to be accompanied by the header `X-HA-Access: YOUR_PASSWORD` (YOUR_PASSWORD as specified in your `configuration.yaml`).
<p class='note'>
You can append <code>?api_password=YOUR_PASSWORD</code> to any url to log in automatically.

12
source/developers/creating_components.markdown
View file

@ -14,13 +14,13 @@ is easy to built your own. If you are the kind of person that likes to learn fro
The first is [hello_world.py](https://github.com/balloob/home-assistant/blob/master/config/custom_components/hello_world.py), which is the classic Hello World example for Home Assistant. The second one is [example.py](https://github.com/balloob/home-assistant/blob/master/config/custom_components/example.py) which showcases various ways you can tap into Home Assistant to be notified when certain events occur.
If you want to load these components in Home Assistant, add the following lines to your `home-assistant.conf` file:
If you want to load these components in Home Assistant, add the following lines to your `configuration.yaml` file:
```
[hello_world]
hello_world:
[example]
target=TARGET_ENTITY
example:
target: TARGET_ENTITY
```
`TARGET_ENTITY` should be one of your devices that can be turned on and off, ie a light or a switch. Example value could be `light.Ceiling` or `switch.AC` (if you have these devices with those names).
@ -64,8 +64,8 @@ The Home Assistant object contains three objects to help you interact with the s
If your configuration file containes the following lines:
```
[example]
host=paulusschoutsen.nl
example:
host: paulusschoutsen.nl
```
Then in the setup-method of your component you will be able to refer to `config['example']['host']` to get the value `paulusschoutsen.nl`.

7
source/developers/frontend.markdown
View file

@ -12,12 +12,11 @@ footer: true
Home Assistant uses [Polymer](https://www.polymer-project.org/) for the frontend. Polymer allows building encapsulated and interoperable custom elements that extend HTML itself.
# {% linkable_title Turning on development mode %}
Home Assistant will by default serve the compiled version of the frontend. To change it so that the components are served separately, update your `home-assistant.conf` to have these lines:
Home Assistant will by default serve the compiled version of the frontend. To change it so that the components are served separately, update your `configuration.yaml` to have these lines:
```
[http]
api_password=YOUR_PASSWORD
development=1
http:
development: 1
```
After turning on development mode, you will have to install the webcomponents that the frontend depends on. You can do this by running the `build_frontend` script.