Extract developer site (#5249)
* Extract developer site * Fix title in sidebar * Update dev section reference * Update edit in github link on help page
This commit is contained in:
parent
a83fd1d874
commit
80b268cd65
75 changed files with 282 additions and 4166 deletions
|
@ -9,27 +9,6 @@ sharing: true
|
|||
footer: true
|
||||
---
|
||||
|
||||
Based on where you are in the code, `config` can mean various things.
|
||||
|
||||
### {% linkable_title On the hass object %}
|
||||
|
||||
On the hass object is an instance of the Config class. The Config class contains the users preferred units, the path to the config directory and which components are loaded. [See available methods.](https://dev-docs.home-assistant.io/en/master/api/core.html#homeassistant.core.Config)
|
||||
|
||||
### {% linkable_title Config passed into component setup %}
|
||||
|
||||
The `config` parameter passed to a component setup is a dictionary containing all of the user supplied configuration. The keys of the dictionary are the component names and the value is another dictionary with the component configuration.
|
||||
|
||||
The object will have already been validated using your `CONFIG_SCHEMA` or `PLATFORM_SCHEMA` if available. If you have defined a `PLATFORM_SCHEMA`, all references to your component (ie `light 2:` etc) will have been changed to be accessible as a list under `config[DOMAIN]`.
|
||||
|
||||
If your configuration file contains the following lines:
|
||||
|
||||
```yaml
|
||||
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`.
|
||||
|
||||
### {% linkable_title Passed into platform setup %}
|
||||
|
||||
The `config` parameter passed to a platform setup function is only the config for that specific platform.
|
||||
<script>
|
||||
window.location = 'https://developers.home-assistant.io/docs/en/dev_101_config.html';
|
||||
</script>
|
Loading…
Add table
Add a link
Reference in a new issue