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

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

Browse source 
* 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
Download patch file Download diff file Expand all files Collapse all files

69
source/_components/recorder.markdown
View file

@ -25,18 +25,51 @@ To setup the `recorder` component in your installation, add the following to you
recorder:
```
Configuration variables:
- **purge_interval** (*Optional*): (days) Enable scheduled purge of older events and states. The purge task runs every x days from when the `recorder component` is first enabled. If a scheduled purge is missed (e.g. if Home Assistant was not running) then the schedule will resume soon after Home Assistant restarts. You can use [service](#service-purge) call `recorder.purge` when required without impacting the purge schedule.
- **purge_keep_days** (*Required with `purge_interval`*): Specify number of history days to keep in recorder database after purge.
- **exclude** (*Optional*): Configure which components should be excluded from recordings.
- **entities** (*Optional*): The list of entity ids to be excluded from recordings.
- **domains** (*Optional*): The list of domains to be excluded from recordings.
- **include** (*Optional*): Configure which components should be included in recordings. If set, all other entities will not be recorded.
- **entities** (*Optional*): The list of entity ids to be included from recordings.
- **domains** (*Optional*): The list of domains to be included from recordings.
- **db_url** (*Optional*): The URL which point to your database.
{% configuration %}
recorder:
description: Enables the recorder component. Only allowed once.
required: true
type: map
keys:
db_url:
description: The URL which points to your database.
required: false
type: URL
purge_interval:
description: Enable scheduled purge of older events and states. The purge task runs every `purge_interval` days from when the `recorder component` is first enabled. If a scheduled purge is missed (e.g if Home Assistant was not running), the schedule will resume soon after Home Assistant restarts. You can use the [service](#service-purge) call `purge` when required without impacting the purge schedule. If `purge_interval` is set, `purge_keep_days` needs to be set as well.
required: Inclusive
type: int
purge_keep_days:
description: Specify the number of history days to keep in recorder database after purge. If `purge_interval` is set, `purge_keep_days` needs to be set as well.
required: Inclusive
type: int
exclude:
description: Configure which components should be excluded
required: false
type: map
keys:
domains:
description: The list of domains to be excluded from recordings.
required: false
type: List
entities:
description: The list of entity ids to be excluded from recordings.
required: false
type: List
include:
description: Configure which components should be included in recordings. If set, all other entities will not be recorded.
required: false
type: map
keys:
domains:
description: The list of domains to be included in the recordings.
required: false
type: List
entities:
description: The list of entity ids to be included in the recordings.
required: false
type: List
{% endconfiguration %}
Define domains and entities to `exclude` (aka. blacklist). This is convenient when you are basically happy with the information recorded, but just want to remove some entities or domains. Usually these are entities/domains which do not change (like `weblink`) or rarely change (`updater` or `automation`).
@ -100,6 +133,18 @@ action:
keep_days: 5
```
### {% linkable_title Restore State %}
If the `recorder` component is activated, some components support `restore_state` which will restore the state of the entity after Home Assistant is started to to 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 uncomplete 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)
* ...
## Custom database engines
| Database engine | `db_url` |