jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-28 11:47:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update history.markdown (#4633)

Browse Source
This commit is contained in:
themanieldaniel 2018-02-11 05:08:40 -05:00 committed by Fabian Affolter
parent 3de6e038f1
commit 4bd6d7c4b6
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
source/_components/history.markdown
View File

@ -13,7 +13,7 @@ ha_release: pre 0.7
---
The `history` component will track everything that is going on within Home Assistant and allows the user to browse through it. It depends on the `recorder` component for storing the data and uses the same database setting. If any entities are excluded from being recorded, no history will be available for these entities as well.
The `history` component will track everything that is going on within Home Assistant and allows the user to browse through it. It depends on the `recorder` component for storing the data and uses the same database setting. If any entities are excluded from being recorded, no history will be available for these entities.
To enable the history option in your installation, add the following to your `configuration.yaml` file:
@ -42,9 +42,9 @@ Configuration variables:
- **entities** (*Optional*): The list of entity ids to be included to the history.
- **domains** (*Optional*): The list of domains to be included to the history.
Without any `include` or `exclude` configuration the history displays graphs for every entity (well that's not exactly true - for instance `hidden` entities or `scenes` are never shown) on a given date. If you are only interested in some of the entities you several options:
Without any `include` or `exclude` configuration the history displays graphs for every entity (well that's not exactly true - for instance `hidden` entities or `scenes` are never shown) on a given date. If you are only interested in some of the entities you have several options:
Define domains and entities to `exclude` (aka. blacklist). This is convenient when you are basically happy with the information displayed, 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`).
Define domains and entities to `exclude` (aka. blacklist). This is convenient when you are basically happy with the information displayed, but just want to remove some entities or domains. Usually these are entities/domains which do not change (like `weblink`) or rarely change (like `updater` or `automation`).
```yaml
# Example configuration.yaml entry with exclude
@ -59,7 +59,7 @@ history:
- sensor.date
```
Define domains and entities to display by using the `include` configuration (aka. whitelist). If you have a lot of entities in your system and your `exclude` lists possibly get very large, it might be better just to define the entities or domains to display.
Define domains and entities to display by using the `include` configuration (aka. whitelist). If you have a lot of entities in your system and your `exclude` list is getting too large, it might be better just to define the entities or domains to `include`.
```yaml
# Example configuration.yaml entry with include
@ -104,7 +104,7 @@ history:
#### {% linkable_title Implementation details %}
The history is stored in a SQLite database `home-assistant_v2.db` within your configuration directory if the `recorder` component is not set up differently.
The history is stored in a SQLite database `home-assistant_v2.db` within your configuration directory unless the `recorder` component is set up differently.
- events table is all events except `time_changed` that happened while recorder component was running.
- states table contains all the `new_state` values of `state_changed` events.
@ -129,4 +129,4 @@ datetime.fromtimestamp(1422830502)
#### {% linkable_title API %}
The history information are also available through the [RESTful API](/developers/rest_api/#get-apihistory).
The history information is also available through the [RESTful API](/developers/rest_api/#get-apihistory).