Input Datetime


The input_datetime integration allows the user to define date and time values that can be controlled via the frontend and can be used within automations and templates.

The preferred way to configure input datetime is via the user interface at Configuration -> Helpers. Click the add button and then choose the Date and/or time option.

To be able to add Helpers via the user interface you should have default_config: in your configuration.yaml, it should already be there by default unless you removed it. If you removed default_config: from you configuration, you must add input_datetime: to your configuration.yaml first, then you can use the UI.

input_datetime can also be configured via YAML. To add three datetime inputs to your installation, one with both date and time, and one with date or time each, add the following lines to your configuration.yaml:

# Example configuration.yaml entry
input_datetime:
  both_date_and_time:
    name: Input with both date and time
    has_date: true
    has_time: true
  only_date:
    name: Input with only date
    has_date: true
    has_time: false
  only_time:
    name: Input with only time
    has_date: false
    has_time: true

Configuration Variables

input_datetime map Required

Alias for the datetime input. Multiple entries are allowed.

name string (Optional)

Friendly name of the datetime input.

has_time boolean (Optional, default: false)

Set to true if the input should have a time. At least one has_time or has_date must be defined.

has_date boolean (Optional, default: false)

Set to true if the input should have a date. At least one has_time or has_date must be defined.

icon icon (Optional)

Icon to display in front of the input element in the frontend.

initial datetime | time | date (Optional)

Set the initial value of this input, depending on has_time and has_date.

Default:

1970-01-01 00:00 | 00:00 | 1970-01-01

Attributes

A datetime input entity’s state exports several attributes that can be useful in automations and templates.

Attribute Description
has_time true if this entity has a time.
has_date true if this entity has a date.
year
month
day
The year, month and day of the date.
(only available if has_date: true)
timestamp A timestamp representing the time held in the input.
(only available if has_time: true)

Restore State

If you set a valid value for initial this integration will start with state set to that value. Otherwise, it will restore the state it had prior to Home Assistant stopping.

Services

Available service: input_datetime.set_datetime and input_datetime.reload.

input_datetime.set_datetime

Service data attribute Format String Description
date %Y-%m-%d This can be used to dynamically set the date.
time %H:%M:%S This can be used to dynamically set the time.
datetime %Y-%m-%d %H:%M:%S This can be used to dynamically set both the date & time.
timestamp N/A This can be used to dynamically set both the date & time using a UNIX timestamp.

To set both the date and time in the same call, use date and time together, or use datetime or timestamp by itself. Using datetime or timestamp has the advantage that both can be set using one template.

input_datetime.reload

input_datetime.reload service allows one to reload input_datetime’s configuration without restarting Home Assistant itself.

Examples

The following example shows the usage of the input_datetime as a trigger in an automation:

# Example configuration.yaml entry
# Turns on bedroom light at the time specified.
automation:
  trigger:
    platform: time
    at: input_datetime.bedroom_alarm_clock_time
  action:
    service: light.turn_on
    entity_id: light.bedroom

To dynamically set the input_datetime you can call input_datetime.set_datetime. The values for date, time and/or datetime must be in a certain format for the call to be successful. (See service description above.) If you have a datetime object you can use its timestamp method. Of if you have a timestamp you can just use it directly.

# Sets time to 05:30:00
- service: input_datetime.set_datetime
  entity_id: input_datetime.XXX
  data:
    time: '05:30:00'
# Sets time to time from datetime object
- service: input_datetime.set_datetime
  entity_id: input_datetime.XXX
  data:
    time: "{{ now().strftime('%H:%M:%S') }}"
# Sets date to 2020-08-24
- service: input_datetime.set_datetime
  entity_id: input_datetime.XXX
  data:
    date: '2020-08-24'
# Sets date to date from datetime object
- service: input_datetime.set_datetime
  entity_id: input_datetime.XXX
  data:
    date: "{{ now().strftime('%Y-%m-%d') }}"
# Sets date and time to 2020-08-25 05:30:00
- service: input_datetime.set_datetime
  entity_id: input_datetime.XXX
  data:
    datetime: '2020-08-25 05:30:00'
# Sets date and time from datetime object
- service: input_datetime.set_datetime
  entity_id: input_datetime.XXX
  data:
    datetime: "{{ now().strftime('%Y-%m-%d %H:%M:%S') }}"
# Sets date and/or time from UNIX timestamp
# This can be used whether the input_datetime has just a date,
# or just a time, or has both
- service: input_datetime.set_datetime
  data:
    entity_id: input_datetime.XXX
    timestamp: "{{ now().timestamp() }}"