Added Restore state info + Updated config style (#4343)

* Updated input_boolean

* new Configuration style
* Linkable title Automation Examples

* Updated input_select

* new Configuration style
* Services as table
* Rearaged scenes
* small improvments

* Updated input_number

* linkformat

* Updated input_text

* New configuration style

* Update input_datetime

* New configuration style

* Updated recorder

* New configuration style

* Added Restore State Info
This commit is contained in:
cdce8p 2018-01-05 11:53:52 +01:00 committed by Fabian Affolter
parent c624d5fc00
commit 5b873e2380
6 changed files with 214 additions and 69 deletions

View file

@ -33,18 +33,45 @@ input_datetime:
has_time: true
```
Configuration variables:
{% configuration %}
input_datetime:
description: Alias for the datetime input. Multiple entries are allowed.
required: true
type: map
keys:
name:
description: Friendly name of the datetime input.
required: false
type: String
has_time:
description: Set to `true` if the input should have a time. At least one `has_time` or `has_date` must be defined.
required: false
type: Boolean
default: false
has_date:
description: Set to `true` if the input should have a date. At least one `has_time` or `has_date` must be defined.
required: false
type: Boolean
default: false
initial:
description: Set the initial value of this input, depending on `has_time` and `has_date`.
required: false
type: datetime | time | date
default: 1970-01-01 00:00 | 1970-01-01 | 00:00
{% endconfiguration %}
- **[alias]** (*Required*): Alias for the datetime input. Multiple entries are allowed.
- **name** (*Optional*): Friendly name of the datetime input.
- **has_time** (*Optional*): Set to `true` if this input should have time. Defaults to `false`.
- **has_date** (*Optional*): Set to `true` if this input should have a date. Defaults to `false`.
- **initial** (*Optional*): Set the initial value of this input. Defaults to '1970-01-01 00:00'. If has_time is `false` this must be just a date (e.g.: '1970-01-01'). If has_date is `false` this must be just a time (e.g.: '15:16').
### {% linkable_title Attributes %}
A datetime input entity's state exports several attributes that can be useful in automations and templates:
A datetime input entity's state exports several attributes that can be useful in automations and templates.
- **has_time**: `true` if this entity has time.
- **has_date**: `true` if this entity has a date.
- **year**, **month**, **day** (Only available if *has_date* is true): The year, month and day of the date.
- **hour**, **minute**, **second** (Only available if *has_time* is true): The hour, minute and second of the time.
- **timestamp**: A timestamp representing the time held in the input. If *has_date* is true, this is the UNIX timestamp of the date / time held by the input. Otherwise (i.e., if only *has_time* is true) the number of seconds since midnight representing the time held by the input.
| Attribute | Description |
| --------- | ----------- |
| `has_time` | `true` if this entity has a time.
| `has_date` | `true` if this entity has a date.
| `year`<br>`month`<br>`day` | The year, month and day of the date.<br>(only availabel if `has_date: true`)
| `hour`<br>`minute`<br>`second` | The hour, minute and second of the time.<br>(only available if `has_time: true`)
| `timestamp` | A timestamp representing the time held in the input.<br>If `has_date: true`, this is the UNIX timestamp of the date / time held by the input. Otherwise if only `has_time: true`, this is the number of seconds since midnight representing the time held by the input.
### {% linkable_title Restore State %}
This component supports the `restore_state` function which restores the state value after Home Assistant has started to the value it has been before Home Assistant stopped. The use this feature please make sure that the [`recorder`](/components/recorder/) component is enabled and your entity does not have and initial value. Additional information and a list of components that support this feature can be found here [recorder/#restore-state](/components/recorder/#restore-state).