Skip to main content

Date/Time entity

A datetime is an entity that allows the user to input a timestamp to an integration. Derive entity platforms from homeassistant.components.datetime.DateTimeEntity

Properties​

tip

Properties should always only return information from memory and not do I/O (like network requests). Implement update() or async_update() to fetch data.

NameTypeDefaultDescription
native_valuedatetime.datetime | NoneRequiredThe value of the datetime. Must include timezone info.

Other properties that are common to all entities such as icon, name etc are also applicable.

Methods​

Set value​

Called when the user or an automation wants to update the value. The provided datetime will always be timezone-aware; a naive datetime is assumed to be in Home Assistant's configured time zone.

class MyDateTime(DateTimeEntity):
    # Implement one of these methods.

    def set_value(self, value: datetime) -> None:
        """Update the current value."""

    async def async_set_value(self, value: datetime) -> None:
        """Update the current value."""