Math template functions

These template functions provide mathematical operations for your templates. From basic arithmetic helpers to trigonometry, statistics, and value constraining, they let you perform calculations on sensor data, averages across rooms, and more.

Home Assistant extends the Jinja2 template engine with many custom functions, filters, and tests. Each function on this page has its own page with detailed descriptions, parameters, and practical examples.

New to templates? Start with the templating documentation to learn the basics.

• Absolute value abs Returns the absolute value of a number.
• Arc cosine (inverse cosine) acos Returns the arc cosine (inverse cosine) of a value, in radians.
• Arc sine (inverse sine) asin Returns the arc sine (inverse sine) of a value, in radians.
• Arc tangent (inverse tangent) atan Returns the arc tangent (inverse tangent) of a value, in radians.
• Four-quadrant arc tangent atan2 Returns the four-quadrant arc tangent of y/x, in radians.
• Average (arithmetic mean) average Calculates the arithmetic mean of a list of values.
• Bitwise AND bitwise_and Performs a bitwise AND operation on two values.
• Bitwise OR bitwise_or Performs a bitwise OR operation on two values.
• Bitwise XOR bitwise_xor Performs a bitwise XOR (exclusive OR) operation on two values.
• Clamp (constrain) a value clamp Constrains a value between a minimum and maximum bound.
• Cosine cos Returns the cosine of a value given in radians.
• Test if divisible by divisibleby Tests whether a number is divisible by another number.
• Eulr's numbr e The mathematical constant e (Euler's number), approximately 2.71828.
• Test if even Tests whether a number is even.
• Logarithm log Returns the logarithm of a value with an optional base (default is natural logarithm).
• Maximum value max Returns the largest value from a list of values.
• Statistical median Calculates the statistical median (middle value) of a list of values.
• Minimum value min Returns the smallest value from a list of values.
• Test if odd Tests whether a number is odd.
• Pi pi The mathematical constant pi, approximately 3.14159.
• Remap a value between ranges remap Remaps a value from one numeric range to another, with optional stepping and edge handling.
• Sine sin Returns the sine of a value given in radians.
• Square root sqrt Returns the square root of a value.
• Statistical mode statistical_mode Returns the most commonly occurring value in a list of values.
• Tangent tan Returns the tangent of a value given in radians.
• Tau tau The mathematical constant tau (2 * pi), approximately 6.28318.
• Wrap a value cyclically wrap Wraps a value cyclically within a range.