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

Merge branch 'current' into next

Browse source
This commit is contained in:
Fabian Affolter 2017-10-10 00:39:51 +02:00
commit 5d0a917cdd
No known key found for this signature in database
GPG key ID: DDF3D6F44AAB1336
112 changed files with 1014 additions and 352 deletions
Download patch file Download diff file Expand all files Collapse all files

2
source/_docs/configuration/customizing-devices.markdown
View file

@ -61,7 +61,7 @@ homeassistant:
| `homebridge_name` | Name of the entity in `HomeBridge`.
| `hidden` | Set to `true` to hide the entity.
| `homebridge_hidden` | Set to `true` to hide the entity from `HomeBridge`.
| `emulated_hue` | Set to `false` to hide the entity from emulated_hue.
| `emulated_hue_hidden` | Set to `true` to hide the entity from `emulated_hue`.
| `entity_picture` | Url to use as picture for entity.
| `icon` | Any icon from [MaterialDesignIcons.com](http://MaterialDesignIcons.com). Prefix name with `mdi:`, ie `mdi:home`.
| `assumed_state` | For switches with an assumed state two buttons are shown (turn off, turn on) instead of a switch. By setting `assumed_state` to `false` you will get the default switch icon.

8
source/_docs/configuration/events.markdown
View file

@ -27,8 +27,8 @@ Event `state_changed` is fired when a state changes. Both `old_state` and `new_s
Field | Description
----- | -----------
`entity_id` | Entity ID of the changed entity. Example: `light.kitchen`
`old_state` | The previous state of the entity before it changed. This field is ommitted if the entity is new.
`new_state` | The new state of the entity. This field is ommitted if the entity is removed from the state machine.
`old_state` | The previous state of the entity before it changed. This field is omitted if the entity is new.
`new_state` | The new state of the entity. This field is omitted if the entity is removed from the state machine.
### {% linkable_title Event `time_changed` %}
@ -68,11 +68,11 @@ Field | Description
### {% linkable_title Event `platform_discovered` %}
Event `platform_discovered` is fired when a new platform has been discovered by the discovery component.
Event `platform_discovered` is fired when a new platform has been discovered by the [`discovery`](/components/discovery/) component.
Field | Description
----- | -----------
`service` | The service that is discovered. Example: `zwave`.
`service` | The platform that is discovered. Example: `zwave`.
`discovered` | Dictionary containing discovery information. Example: `{ "host": "192.168.1.10", "port": 8889}`.

2
source/_docs/configuration/packages.markdown
View file

@ -24,7 +24,7 @@ homeassistant:
The package configuration can include: `switch`, `light`, `automation`, `groups` or the majority of the Home Assistant components.
It can be specified inline or in a seperate YAML file using `!include`.
It can be specified inline or in a separate YAML file using `!include`.
Inline example, main `configuration.yaml`:

4
source/_docs/configuration/platform_options.markdown
View file

@ -10,7 +10,7 @@ footer: true
redirect_from: /topics/platform_options/
---
Any component that is based on the entity component allows various extra options to be set per platform.
Some components or platforms (those that are based on the [entity](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/helpers/entity.py) class) allows various extra options to be set.
### {% linkable_title Entity namespace %}
@ -25,7 +25,7 @@ light:
### {% linkable_title Scan Interval %}
Platforms that require polling will be polled in an interval specified by the main component. For example a light will check every 30 seconds for a changed state. It is possible to overwrite this scan interval for any platform that is being polled by specifying a `scan_interval` config key. In the example below we setup the Philips Hue lights but tell Home Assistant to poll the devices every 10 seconds instead of the default 30 seconds.
Platforms that require polling will be polled in an interval specified by the main component. For example a light will check every 30 seconds for a changed state. It is possible to overwrite this scan interval for any platform that is being polled by specifying a `scan_interval` configuration key. In the example below we setup the Philips Hue lights but tell Home Assistant to poll the devices every 10 seconds instead of the default 30 seconds.
```yaml
# Example configuration.yaml entry to poll Hue lights every 10 seconds.

2
source/_docs/configuration/templating.markdown
View file

@ -51,7 +51,7 @@ script:
{% endif %}{% endraw %}
```
[Jinja2](http://jinja.pocoo.org/) supports a width variety of operations:
[Jinja2](http://jinja.pocoo.org/) supports a wide variety of operations:
- [Mathematical operation](http://jinja.pocoo.org/docs/dev/templates/#math)
- [Comparisons](http://jinja.pocoo.org/docs/dev/templates/#comparisons)

11
source/_docs/configuration/yaml.markdown
View file

@ -28,10 +28,15 @@ notify:
The basics of YAML syntax are block collections and mappings containing key-value pairs. Each item in a collection starts with a `-` while mappings have the format `key: value`. If you specify duplicate keys, the last value for a key is used. This is somewhat similar to a Hashtable or more specifically a dictionary in Python. These can be nested as well.
Note that indentation (just like in Python) is an important part of specifying relationships using YAML. Things that are indented are nested "inside" things that are one level higher. So in the above example, `platform: pushbullet` is a property of (nested inside) the `notify` component.
Note that indentation is an important part of specifying relationships using YAML. Things that are indented are nested "inside" things that are one level higher. So in the above example, `platform: pushbullet` is a property of (nested inside) the `notify` component.
Getting the right indentation can be tricky if you're not using an editor with a fixed width font. Tabs are not allowed to be used for indentation. Convention is to use 2 spaces for each level of indentation.
You can use the online service [YAMLLint](http://www.yamllint.com/) to check if your YAML syntax is correct before loading it into Home Assistant which will save you some time. If you do so, be aware that this is a third-party service and is not maintained by the Home Assistant community. *Please pay attention on not storing private data (passwords, api-keys, etc.) directly in that file.*
Private data can be stored in a [seperate file](/docs/configuration/secrets/) or in [environmental variables](/docs/configuration/yaml/#using-environment-variables), which circumvents this problem of security.
You can use the online service [YAMLLint](http://www.yamllint.com/) to check if your YAML syntax is correct before loading it into Home Assistant which will save you some time. If you do so, be aware that this is a third-party service and is not maintained by the Home Assistant community.
<p class='note'>
Please pay attention on not storing private data (passwords, API keys, etc.) directly in your `configuration.yaml` file. Private data can be stored in a [separate file](/docs/configuration/secrets/) or in [environmental variables](/docs/configuration/yaml/#using-environment-variables), which circumvents this problem of security.
</p>
Text following a `#` are comments and are ignored by the system.