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

Add linkable titles

Browse source
This commit is contained in:
Paulus Schoutsen 2015-02-08 15:08:41 -08:00
parent d5c4331921
commit e391ddb7a1
8 changed files with 64 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

8
source/developers/creating_components.markdown
View file

@ -25,7 +25,7 @@ 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).
## Loading components
## {% linkable_title Loading components %}
A component will be loaded on start if a section (ie. `[light]`) for it exists in the config file. A component can also be loaded if another component is loaded that depends on it. When loading a component Home Assistant will check the following paths:
@ -42,7 +42,7 @@ You can override a built-in component by having a component with the same name i
Home Assistant will use the directory that contains your config file as the directory that holds your customizations. By default this is the <code>config</code> folder in your current work directory. You can use a different folder by running Home Assistant with the --config argument: <code>python3 homeassistant --config /YOUR/CONFIG/PATH/</code>.
</p>
## Initializing components
## {% linkable_title Initializing components %}
After loading, the bootstrapper will call `setup(hass, config)` method on the component to initialize it. The following parameters are passed in:
@ -51,7 +51,7 @@ After loading, the bootstrapper will call `setup(hass, config)` method on the co
| <code>hass</code> | The Home Assistant object. Call its methods to track time, register services, listen for events or track states: [Overview of available methods.](https://github.com/balloob/home-assistant/blob/master/homeassistant/__init__.py#L38) |
| <code>config</code> | A dict containing the configuration. The keys of the config-dict are component names and the value is another dict with the component configuration. |
### Guidance on using the Home Assistant object
### {% linkable_title Guidance on using the Home Assistant object %}
The Home Assistant object contains three objects to help you interact with the system.
| Object | Description |
@ -60,7 +60,7 @@ The Home Assistant object contains three objects to help you interact with the s
| <code>hass.events</code> | This is the EventBus. It allows you to trigger and listen for events.<br>[See available methods](https://github.com/balloob/home-assistant/blob/master/homeassistant/__init__.py#L308). |
| <code>hass.services</code> | This is the ServiceRegistry. It allows you to register services.<br>[See available methods](https://github.com/balloob/home-assistant/blob/master/homeassistant/__init__.py#L589). |
### Example on using the configuration parameter
### {% linkable_title Example on using the configuration parameter %}
If your configuration file containes the following lines:
```