Update docs for new state restore without recorder (#6652)

This commit is contained in:
Adam Mills 2018-12-05 02:35:04 -05:00 committed by Franck Nijhof
parent 84c1bd74e2
commit 40b18de5a1
7 changed files with 7 additions and 21 deletions

View File

@ -61,7 +61,7 @@ Pick an icon that you can find on [materialdesignicons.com](https://materialdesi
### {% linkable_title Restore State %} ### {% linkable_title Restore State %}
This component will automatically restore the state it had prior to Home Assistant stopping as long as you have the `recorder` component enabled and your entity has `restore` set to `True` which is the default. To disable this feature, set `restore` to `False`. Additional information can be found in the [Restore state](/components/recorder/#restore-state) section of the [`recorder`](/components/recorder/) component documentation. This component will automatically restore the state it had prior to Home Assistant stopping as long as you your entity has `restore` set to `True` which is the default. To disable this feature, set `restore` to `False`.
If `restore` is set to `False`, the `initial` value will only be used when no previous state is found or when the counter is reset. If `restore` is set to `False`, the `initial` value will only be used when no previous state is found or when the counter is reset.

View File

@ -48,7 +48,7 @@ input_boolean:
### {% linkable_title Restore State %} ### {% linkable_title Restore State %}
This component will automatically restore the state it had prior to Home Assistant stopping as long as you have the `recorder` component enabled and your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`. Additional information can be found in the [Restore state](/components/recorder/#restore-state) section of the [`recorder`](/components/recorder/) component documentation. This component will automatically restore the state it had prior to Home Assistant stopping as long as your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`.
## {% linkable_title Automation Examples %} ## {% linkable_title Automation Examples %}

View File

@ -81,11 +81,8 @@ automations and templates.
### {% linkable_title Restore State %} ### {% linkable_title Restore State %}
This component will automatically restore the state it had prior to Home This component will automatically restore the state it had prior to Home
Assistant stopping as long as you have the `recorder` component enabled and your Assistant stopping as long as your entity does **not** have a set value for
entity does **not** have a set value for `initial`. To disable this feature, set `initial`. To disable this feature, set a valid value for `initial`.
a valid value for `initial`. Additional information can be found in the
[Restore state](/components/recorder/#restore-state) section of the
[`recorder`](/components/recorder/) component documentation.
### {% linkable_title Services %} ### {% linkable_title Services %}

View File

@ -85,7 +85,7 @@ input_number:
### {% linkable_title Restore State %} ### {% linkable_title Restore State %}
This component will automatically restore the state it had prior to Home Assistant stopping as long as you have the `recorder` component enabled and your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`. Additional information can be found in the [Restore state](/components/recorder/#restore-state) section of the [`recorder`](/components/recorder/) component documentation. This component will automatically restore the state it had prior to Home Assistant stopping as long as your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`.
## {% linkable_title Automation Examples %} ## {% linkable_title Automation Examples %}

View File

@ -65,7 +65,7 @@ Because YAML defines [booleans](http://yaml.org/type/bool.html) as equivalent, a
### {% linkable_title Restore State %} ### {% linkable_title Restore State %}
This component will automatically restore the state it had prior to Home Assistant stopping as long as you have the `recorder` component enabled and your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`. Additional information can be found in the [Restore state](/components/recorder/#restore-state) section of the [`recorder`](/components/recorder/) component documentation. This component will automatically restore the state it had prior to Home Assistant stopping as long as your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`.
### {% linkable_title Services %} ### {% linkable_title Services %}

View File

@ -72,4 +72,4 @@ input_text:
### {% linkable_title Restore State %} ### {% linkable_title Restore State %}
This component will automatically restore the state it had prior to Home Assistant stopping as long as you have the `recorder` component enabled and your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`. Additional information can be found in the [Restore state](/components/recorder/#restore-state) section of the [`recorder`](/components/recorder/) component documentation. This component will automatically restore the state it had prior to Home Assistant stopping as long as your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`.

View File

@ -131,17 +131,6 @@ Call the service `recorder.purge` to start a purge task which deletes events and
| `keep_days` | yes | The number of history days to keep in recorder database (defaults to the component `purge_keep_days` configuration) | `keep_days` | yes | The number of history days to keep in recorder database (defaults to the component `purge_keep_days` configuration)
| `repack` | yes | Rewrite the entire database, possibly saving some disk space. Only supported for SQLite and requires at least as much disk space free as the database currently uses. | `repack` | yes | Rewrite the entire database, possibly saving some disk space. Only supported for SQLite and requires at least as much disk space free as the database currently uses.
### {% linkable_title Restore State %}
If the `recorder` component is activated then some components support `restore_state`, which will restore the state of the entity after Home Assistant is started to the state before Home Assistant was stopped. Please make sure that you do not exclude the entities for which you want the state to be restored from your recordings. An incomplete list of components that currently support `restore_state`:
* [`input_boolean`](/components/input_boolean/#restore-state)
* [`input_number`](/components/input_number/#restore-state)
* [`input_select`](/components/input_select/#restore-state)
* [`input_datetime`](/components/input_datetime/#restore-state)
* [`input_text`](/components/input_text/#restore-state)
## {% linkable_title Custom database engines %} ## {% linkable_title Custom database engines %}
| Database engine | `db_url` | | Database engine | `db_url` |