History Stats

The History stats integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] provides quick statistics about another integration or platforms, using data from the history integration.

It can track how long an entityAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] 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 add the History Stats helper to your Home Assistant instance, use this My button:

Further information and examples about these configuration options can be found under the YAML configuration

YAML Configuration

To enable the history statistics sensor, add the following lines to your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file. After changing the configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart Home Assistant to apply the changes.

# Example configuration.yaml entry
sensor:
  - platform: history_stats
    name: Lamp ON today
    entity_id: light.my_lamp
    state: "on"
    type: time
    start: "{{ today_at() }}"
    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. This will count states (for example, how many times a light was in the on state during the time period), as opposed to counting state transitions (for example, how many times a light was turned on). The difference is if the entity was already in the desired state at the start of the time period, that scenario will be counted with this sensor type.

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.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more]:

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

    start: "{{ today_at('00:00') }}"
    end: "{{ now() }}"

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

    end: "{{ today_at('00:00') }}"
    duration:
      hours: 24

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

    start: "{{ today_at('06:00') }}"
    duration:
      hours: 5

Current week: starts last Monday at 00:00, ends right now.

Here, last Monday is today at 00:00, minus the current weekday (the weekday is 0 on Monday, 6 on Sunday).

    start: "{{ today_at('00:00') - timedelta(days=now().weekday()) }}"
    end: "{{ now() }}"

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

    start: "{{ today_at('00:00').replace(day=1) }}"
    end: "{{ now() }}"

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

    start: "{{ (today_at('00:00').replace(day=1) - timedelta(days=1)).replace(day=1) }}"
    end: "{{ today_at('00:00').replace(day=1) }}"

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() + timedelta(hours=8)).replace(hour=16, minute=0, second=0, microsecond=0) }}"
    duration:
        hours: 24

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

    end: "{{ today_at('00:00') }}"
    duration:
      days: 30

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

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