Relative time (deprecated): relative_time
The relative_time template function returns a human-readable string describing how long ago a datetimeA value representing a specific moment in time, including the date, time, and time zone. For example, 2026-04-05 14:30:00+00:00. Used for timestamps, scheduling, and time-based calculations. occurred. Give it a datetime in the past, and it returns something like “2 hours” or “3 days”.
This function has been deprecated in favor of time_since, which provides the same functionality with the added ability to control precision. You should use time_since for all new templatesA template is an automation definition that can include variables for the action or data from the trigger values. This allows automations to generate dynamic actions. [Learn more]. relative_time remains available for backward compatibility, but may be removed in a future release.
Usage
Here’s how to use this template function. Copy any example and adjust it to your setup.
{{ relative_time(states.binary_sensor.front_door.last_changed) }}
2 hours
Function signature
The signature is a technical summary of this template function. It shows the name of the function, the values (called parameters) it accepts, and what type of data each parameter expects (for example, a piece of text or a number).
Function parameters that have a = with a value after them are optional. If you leave them out, the default value shown is used automatically. Function parameters without a default are required.
relative_time(
value: datetime,
) -> str
Function parameters
The following parameters can be provided to this function.
Migrating to time_since
Replace relative_time with time_since in your templates. The basic usage is identical:
{{ time_since(states.binary_sensor.front_door.last_changed) }}
2 hours
The advantage of time_since is the optional precision parameter, which lets you control how many time components to include in the output:
{{ time_since(states.binary_sensor.front_door.last_changed, 2) }}
2 hours and 30 minutes
Good to know
- Deprecated. Use
time_sincefor new templates, which supports a precision argument. - Only returns the largest time unit.
"2 hours"is given, not"2 hours 15 minutes".
Try it yourself
Ready to test this? Open Developer tools > Template, paste the example into the Template editor, and watch the result update on the right. Edit the values to see how the function adapts to your own entitiesAn 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].
More examples
Real scenarios where this function comes up in automations and templates. Copy any example and adapt it to your setup.
Show how long ago something happened
Display the elapsed time since a sensor last changed stateThe state holds the information of interest of an entity, for example, if a light is on or off. Each entity has exactly one state and the state only holds one value at a time. However, entities can store attributes related to that state such as brightness, color, or a unit of measurement. [Learn more].
{{
"Last updated "
~ relative_time(states.sensor.temperature.last_changed) ~ " ago"
}}
Last updated 45 minutes ago
Still stuck?
The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with your template and expected result, or share on our subreddit /r/homeassistant.
AI assistants like ChatGPT or Claude can also explain or fix templates when you describe what you want in plain language.
Related template functions
These functions work well alongside this one:
-
Human-readable time elapsed: time_since - Returns a human-readable string describing how much time has passed since a datetime.
-
Human-readable time remaining: time_until - Returns a human-readable string describing how much time remains until a datetime.
-
Current local date and time: now - Returns the current date and time in your local time zone.
-
Convert to datetime: as_datetime - Converts a string or timestamp to a datetime object.