Home Assistant Home Assistant

Times of the Day

The Times of the Day integration provides a binary sensor that gets its values by checking if the current time is within defined time ranges.

Configuration

To add the Times of the Day integration to your Home Assistant instance, use this My button:

Name

The name the binary sensor should have. This can be changed later.

On time

The time when the sensor should turn on.

Off time

The time when the sensor should turn off.

YAML Configuration

Alternatlively, this integration can be configured and set up manually via YAML instead. This has some additional functionality over the UI version.

The time ranges can be provided as absolute local time or using the sunrise or sunset keyword calculated based on the sun position for location. The location must be provided in the configuration.

In addition for sun position based ranges, the negative or positive offset can be configured.

To enable the Times of Day binary sensor in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
binary_sensor:
  - platform: tod
    name: Early Morning
    after: sunrise
    after_offset: "-02:00"
    before: "07:00"
    unique_id: early_morning_sensor

  - platform: tod
    name: Late Morning
    after: "10:00"
    before: "12:00"
    unique_id: late_morning_sensor

Configuration Variables

Looking for your configuration file?
name string Required

Name of the sensor.

before string | time Required

The absolute local time value or sun event for ending of the time range.

before_offset time (Optional)

The time offset of the ending time range.

after string | time Required

The absolute local time value or sun event for beginning of the time range.

after_offset time (Optional)

The time offset of the beginning time range.

unique_id string (Optional)

An ID that uniquely identifies this sensor. This allows changing the name, icon, and entity_id from the web interface.

Considerations

The primary purpose of this sensor is to use a simple time range definition instead of creating a complex template with references to sun.sun integration attributes.

The sensor state is ON when this condition after + after_offset <= current time < before + before_offset.

If after time is later than before then the next day is considered, i.e.:

binary_sensor:
  - platform: tod
    name: Night
    after: sunset
    before: sunrise

In the above example, the next day sunrise is calculated as a time range end.