History Stats

The history_stats sensor platform provides quick statistics about another integration or platforms, using data from the history integration.

It can track how long the integration has been in a specific state, in a custom time period.

Examples of what you can track:

• How long you were at home this week
• How long the lights were ON yesterday
• How long you watched TV today

Configuration

To enable the history statistics sensor, add the following lines to your configuration.yaml:

# Example configuration.yaml entry
sensor:
  - platform: history_stats
    name: Lamp ON today
    entity_id: light.my_lamp
    state: "on"
    type: time
    start: "{{ now().replace(hour=0, minute=0, second=0) }}"
    end: "{{ now() }}"

Sensor type

Depending on the sensor type you choose, the history_stats integration can show different values:

• time: The default value, which is the tracked time, in hours
• ratio: The tracked time divided by the length of your period, as a percentage
• count: How many times the tracked entity matched the configured state during the time period

Time periods

The history_stats integration will execute a measure within a precise time period. You should always provide 2 of the following :

• When the period starts (start variable)
• When the period ends (end variable)
• How long is the period (duration variable)

As start and end variables can be either datetimes or timestamps, you can configure almost any period you want.

Duration

The duration variable is used when the time period is fixed. Different syntaxes for the duration are supported, as shown below.

# 6 hours
duration: "06:00"

# 1 minute, 30 seconds
duration: "00:01:30"

# 2 hours and 30 minutes
duration:
  # supports seconds, minutes, hours, days
  hours: 2
  minutes: 30

Video Tutorial

This video tutorial explains how you can use history stats. It also shows how you can create a daily bar chart graph to visualize things such as occupancy, or how long the lights are on in a particular room.

Examples

Here are some examples of periods you could work with, and what to write in your configuration.yaml:

Today: starts at 00:00 of the current day and ends right now.

    start: "{{ now().replace(hour=0, minute=0, second=0, microsecond=0) }}"
    end: "{{ now() }}"

Yesterday: ends today at 00:00, lasts 24 hours.

    end: "{{ now().replace(hour=0, minute=0, second=0, microsecond=0) }}"
    duration:
      hours: 24

This morning (6AM - 11AM): starts today at 6, lasts 5 hours.

    start: "{{ now().replace(hour=6, minute=0, second=0, microsecond=0) }}"
    duration:
      hours: 5

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).

    start: "{{ as_timestamp( now().replace(hour=0, minute=0, second=0, microsecond=0) ) - now().weekday() * 86400 }}"
    end: "{{ now() }}"

Current month: starts the first day of the current month at 00:00, ends right now.

    start: "{{ now().replace(day=1, hour=0, minute=0, second=0, microsecond=0 ) }}"
    end: "{{ now() }}"

Previous month: starts the first day of the previous month at 00:00, ends the first day of the current month.

    start: "{{ now().replace(day=1, month=now().month-1, hour=0, minute=0, second=0, microsecond=0) }}"
    end: "{{ now().replace(day=1, hour=0, minute=0, second=0, microsecond=0) }}"

Next 4 pm: 24 hours, from the last 4 pm till the next 4 pm. If it hasn’t been 4 pm today, that would be 4 pm yesterday until 4 pm today. If it is already past 4 pm today, it will be 4 pm today until 4 pm tomorrow. When changing the start time, then add or subtract to the 8-hour buffer to match the next midnight.

    end: "{{ (now().replace(minute=0, second=0, microsecond=0) + timedelta(hours=8)).replace(hour=16) }}"
    duration:
        hours: 24

Last 30 days: ends today at 00:00, lasts 30 days. Easy one.

    end: "{{ now().replace(hour=0, minute=0, second=0, microsecond=0) }}"
    duration:
      days: 30

All your history starts at timestamp = 0, and ends right now.

    start: "{{ 0 }}"
    end: "{{ now() }}"