2024.10.2
Home ▸ Integrations ▸

Date/Time

The Date/Time integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] is built for the controlling and monitoring of timestamps on devices.

Note

Building block integration

This date/time is a building block integration that cannot be added to your Home Assistant directly but is used and provided by other integrations.

A building block integration differs from the typical integration that connects to a device or service. Instead, other integrations that do integrate a device or service into Home Assistant use this date/time building block to provide entities, services, and other functionality that you can use in your automations or dashboards.

If one of your integrations features this building block, this page documents the functionality the date/time building block offers.

If you are looking for a way to create a Date/Time entity, please take a look at the Date/Time helper.

The state of a date/time entity

The state of a date/time entity is the actual date and time value.

Screenshot showing the state of a date/time entity in the developer tools Screenshot showing the state of a date/time entity in the developer tools. In the example shown, the state is January 1, 2020 at 12:00 in the format YYYY-MM-DD T HH:MM:SS.

In addition, the entity can have the following states:

  • Unavailable: The entity is currently unavailable.
  • Unknown: The state is not yet known.

Actions

datetime actions

Available actionsActions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called sequence. [Learn more]: datetime.set_value

Action datetime.set_value

Set a new value for the datetime 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].

Data attribute Optional Description
entity_id no String or list of strings that point at entity_id’s of datetimes to control.
datetime no New datetime value to set. If timezone is not included, the Home Assistant instance’s timezone will be used.