Absolute value: abs
The abs filter returns the absolute value of a number, which is its distance from zero regardless of sign. Negative numbers become positive, while positive numbers and zero remain unchanged.
This is useful when you care about the magnitude of a difference but not its direction. For example, when calculating how far a temperature is from a target, the absolute value tells you the size of the deviation regardless of whether the actual temperature is above or below the target. It is also helpful for computing the difference between two sensorSensors return information about a thing, for instance the level of water in a tank. [Learn more] readings where the order might vary.
Usage
Here’s how to use this template function. Copy any example and adjust it to your setup.
{{ -5 | abs }}
5
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 = are usually required. A few optional parameters have no default value, so the signature shows them without a = as well. To check whether a parameter is required, look at the parameter list below the signature. Each parameter is marked as Required or Optional.
The most common optional parameter without a default value is default. The default parameter sets the value a function returns when the function can’t produce a result, for example, when float gets text that isn’t a number. If you leave out default, there is no fallback value, so most functions raise an error and the template fails. The parameter list of each function says what happens. If you set default, the function returns your value instead.
How to read a signature
Here is the signature of the round filter as an example:
round(
value: Any,
precision: int = 0,
method: str = "common",
default: Any,
) -> float | int | Any
-
roundis the name of the function. - Between the parentheses are the parameters. Each parameter has a name, followed by a colon and the type of value the parameter expects. The type only tells you what kind of value to pass. For
default: Any, you pass a value of any type, such as0or"unknown", not the wordAny. -
= 0and= "common"are default values. You can leave outprecisionandmethod, androunduses these default values. -
defaulthas no=, but the parameter list marksdefaultas optional. If you leave outdefaultandroundgets a value that isn’t a number,roundraises an error. -
->shows the type of value the function returns. - Inside a signature,
|means “or”. This function returns a decimal number, a whole number, or the value you passed asdefault.
round is a filter, so the first parameter, value, is the value before the |. For example, {{ 3.14159 | round(2) }} returns 3.14.
The types you’ll see most often:
-
str: text, such as"hello" -
int: a whole number, such as5 -
float: a decimal number, such as3.14 -
bool:trueorfalse -
list: a list of values, such as[1, 2, 3].list[str]is a list of texts. -
dict: a set of keys and values, such as{"name": "Kitchen"} -
datetimeandtimedelta: a date and time, and a duration. For details, refer to Dates and times. -
None: no value -
Any: any type of value
Some signatures use special forms:
-
*argsmeans you can pass any number of values, separated by commas. For example,average(1, 2, 3). -
value | name(...)means the function is a filter. The value before the|is passed to the filter as its first parameter. Some filter signatures, like theroundexample, show this value as the first parameter between the parentheses instead.
value | abs() -> number
Function parameters
The following parameters can be provided to this filter.
Absolute value of a float
The filter works with both integers and floating-point numbers.
{{ -21.5 | abs }}
21.5
Good to know
- Raises an error when the value is not a number, so convert with
floatorintfirst if you’re working with state strings. - Works on integers and floats and preserves the original numeric type.
Try it yourself
Ready to test this? Open Settings > 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.
Calculate temperature deviation
Find how far the current temperature is from a target, regardless of direction.
{% set current = states("sensor.temperature") | float(0) %}
{% set target = 22.0 %}
{{ (current - target) | abs | round(1) }} degrees from target
1.5 degrees from target
Compute the difference between two sensors
Calculate the absolute difference between two sensorSensors return information about a thing, for instance the level of water in a tank. [Learn more] readings.
{% set indoor = states("sensor.indoor_temp") | float(0) %}
{% set outdoor = states("sensor.outdoor_temp") | float(0) %}
Difference: {{ (indoor - outdoor) | abs | round(1) }} degrees
Difference: 8.3 degrees
Use in an automation condition
Only trigger when the power consumption change exceeds a threshold, regardless of direction.
condition:
- condition: template
value_template: >
{{
(states("sensor.power_now") | float(0)
- states("sensor.power_previous") | float(0))
| abs > 500
}}
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:
-
Round a number: round - Rounds a numeric value to a specified number of decimal places using various rounding methods.
-
Convert to float: float - Converts a value to a floating-point number, with an optional default if conversion fails.
-
Convert to integer: int - Converts a value to an integer, with an optional default if conversion fails.
-
Clamp (constrain) a value: clamp - Constrains a value between a minimum and maximum bound.