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-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update History_stats sensor component configuration (#7248)

Browse Source 
* Update History_stats sensor component configuration

* 🚑 Fix error
This commit is contained in:
Klaas Schoute 2018-10-29 22:43:03 +01:00 committed by Fabian Affolter
parent eda0f413aa
commit fd95a34870
1 changed files with 33 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
source/_components/sensor.history_stats.markdown
View File

@ -40,16 +40,38 @@ sensor:
end: '{% raw %}{{ now() }}{% endraw %}' end: '{% raw %}{{ now() }}{% endraw %}'
``` ```
Configuration variables: {% configuration %}
entity_id:
- **entity_id** (*Required*): The entity you want to track description: The entity you want to track.
- **state** (*Required*): The state you want to track required: true
- **name** (*Optional*): Name displayed on the frontend type: string
- **type** (*Optional*): The type of sensor: `time`, `ratio`, or `count`. Defaults to `time` state:
- **start**: When to start the measure (timestamp or datetime). description: The state you want to track.
- **end**: When to stop the measure (timestamp or datetime) required: true
- **duration**: Duration of the measure type: string
name:
description: Name displayed on the frontend.
required: false
default: unnamed statistics
type: string
type:
description: "The type of sensor: `time`, `ratio`, or `count`."
required: false
default: time
type: string
start:
description: When to start the measure (timestamp or datetime).
required: false
type: template
end:
description: When to stop the measure (timestamp or datetime).
required: false
type: template
duration:
description: Duration of the measure.
required: false
type: time
{% endconfiguration %}
<p class='note'> <p class='note'>
You have to provide **exactly 2** of `start`, `end` and `duration`. You have to provide **exactly 2** of `start`, `end` and `duration`.
@ -74,7 +96,6 @@ The `history_stats` component will execute a measure within a precise time perio
As `start` and `end` variables can be either datetimes or timestamps, you can configure almost any period you want. As `start` and `end` variables can be either datetimes or timestamps, you can configure almost any period you want.
### {% linkable_title Duration %} ### {% linkable_title Duration %}
The duration variable is used when the time period is fixed. Different syntaxes for the duration are supported, as shown below. The duration variable is used when the time period is fixed. Different syntaxes for the duration are supported, as shown below.
@ -127,6 +148,7 @@ Here are some examples of periods you could work with, and what to write in your
**Current week**: starts last Monday at 00:00, ends right now. **Current week**: starts last Monday at 00:00, ends right now.
Here, last Monday is _today_ as a timestamp, minus 86400 times the current weekday (86400 is the number of seconds in one day, the weekday is 0 on Monday, 6 on Sunday). Here, last Monday is _today_ as a timestamp, minus 86400 times the current weekday (86400 is the number of seconds in one day, the weekday is 0 on Monday, 6 on Sunday).
```yaml ```yaml
start: '{% raw %}{{ as_timestamp( now().replace(hour=0).replace(minute=0).replace(second=0) ) - now().weekday() * 86400 }}{% endraw %}' start: '{% raw %}{{ as_timestamp( now().replace(hour=0).replace(minute=0).replace(second=0) ) - now().weekday() * 86400 }}{% endraw %}'
end: '{% raw %}{{ now() }}{% endraw %}' end: '{% raw %}{{ now() }}{% endraw %}'