Wrap a value cyclically: wrap

The wrap template function wraps a value cyclically within a given range. When the value goes past the maximum, it wraps back around to the minimum, and vice versa. The minimum is inclusive and the maximum is exclusive, so the result is always in the range [min, max).

This is useful for working with cyclic quantities like angles, hours of the day, or any value that should loop around rather than be clamped. For example, you could wrap a calculated heading to stay within 0-360 degrees, or keep an hour-of-day offset within a 24-hour cycle.

Usage

Here’s how to use this template function. Copy any example and adjust it to your setup.

{{ wrap(370, 0, 360) }}

10.0

{{ 370 | wrap(0, 360) }}

10.0

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.

wrap(
    value: Any,
    min_value: Any,
    max_value: Any,
) -> float

Function parameters

The following parameters can be provided to this function.

Good to know

• The result is always a float, even when all inputs are integers.
• The range is half-open: min_value is included, max_value is not. Wrapping a value equal to max_value returns min_value.
• Unlike clamp, out-of-range values cycle around instead of being pinned to the nearest edge.

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.

Wrapping a compass heading

Keep a calculated compass heading within the standard 0-360 degree range.

{% set heading = states("sensor.wind_direction") | float + 45 %}
{{ wrap(heading, 0, 360) }}

35.0

Wrapping negative values

Values below the minimum wrap back from the maximum end.

{{ wrap(-10, 0, 360) }}

350.0

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.

Related template functions

These functions work well alongside this one:

• Clamp (constrain) a value: clamp - Constrains a value between a minimum and maximum bound.

• Remap a value between ranges: remap - Remaps a value from one numeric range to another, with optional stepping and edge handling.