Time & Date


The time and date (time_date) sensor platform adds one or more sensors to your Home Assistant state machine. To have these sensors available in your installation, add the following to your configuration.yaml file (each option creates a separate sensor that contains appropriate data, e.g., sensor.date for the date option):

# Example configuration.yaml entry
sensor:
  - platform: time_date
    display_options:
      - 'time'
      - 'date'
      - 'date_time'
      - 'date_time_utc'
      - 'date_time_iso'
      - 'time_date'
      - 'time_utc'
      - 'beat'

Configuration Variables

display_options list Required

The option to display. The types date_time, date_time_utc, time_date, and date_time_iso shows the date and the time. The other types just the time or the date. beat shows the Swatch Internet Time.

Sensors including the time update every minute, the date sensor updates each day at midnight, and the beat sensor updates with each beat (86.4 seconds).

Producing your own custom time and date sensor

Whilst there are a number of display_options exposed by this sensor, they cannot hope to satisfy everyone, and large parts of the world will find that their local display conventions are not included.

The following can be used to create a time and date sensor whose output can be properly customised to use your own preferred formatting, specified in the call to timestamp_custom() using standard Python datetime formatting.

sensor:
  # Minimal configuration of the standard time and date sensor
  - platform: time_date
    display_options:
      - 'date_time_iso'
  # Build on the standard sensor to produce one that can be customized    
  - platform: template
    sensors:
      time_formatted:
        friendly_name: "Date and time"
        value_template: "{{ as_timestamp(states('sensor.date_time_iso')) | timestamp_custom('%A %B %-m, %I:%M %p') }}"
        icon_template: mdi:calendar-clock