Maximum value: max

The max template function returns the largest value from a collection. The max filter comes from Jinja. Home Assistant adds a max function that wraps this filter. With the function, you can pass values as a list or as separate arguments.

This is useful whenever you need to find the highest reading among multiple sensorsSensors return information about a thing, for instance the level of water in a tank. [Learn more]. For example, you might want to find the warmest room in your house, the highest power consumption across all your devicesA device is a model representing a physical or logical unit that contains entities., or the peak value in a set of readings. You can also use it with expand to work with groups of entities.

Usage

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

{{ max(21.5, 22.0, 19.8) }}

22.0

{{ [21.5, 22.0, 19.8] | max }}

22.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 = 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.

round(
    value: Any,
    precision: int = 0,
    method: str = "common",
    default: Any,
) -> float | int | Any

max(
    *args: list | float,
    case_sensitive: bool = False,
    attribute: str | int | None = None,
) -> Any

Function parameters

The following parameters can be provided to this function or filter.

Good to know

• With one argument, the argument must be a list or another iterable. With two or more arguments, max compares the arguments directly.
• The result has the same type as the items. For example, a list of numbers returns a number.
• An empty list returns an undefined value. The output is empty, and Home Assistant logs a warning. Calling max() without arguments raises an error.
• Strings are compared as text, not as numbers. For example, max("9", "21") returns "9". Convert state strings with float first.
• Text comparison ignores case by default. Set case_sensitive=true to compare uppercase and lowercase letters as different.
• Mixing strings and numbers in the input raises an error. Convert state strings with float first.
• You can use max as a filter directly after map. You don’t need to add | list first.

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.

Maximum sensor value

Find the highest temperature across multiple rooms.

{{
  max(
    states("sensor.living_room_temperature") | float,
    states("sensor.bedroom_temperature") | float,
    states("sensor.kitchen_temperature") | float
  )
}}

22.0

Maximum from a list

Pass a list directly to the function.

{{ max([21.5, 22.0, 19.8]) }}

22.0

Maximum across a group of entities

If you have a groupGroups are a way to organize your entities into a single unit. [Learn more] of sensors, expand the group and find the largest value.

{{
  expand("sensor.indoor_temperatures")
  | map(attribute="state")
  | map("float")
  | max
}}

22.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:

• Minimum value: min - Returns the smallest value from a list of values.

• Average (arithmetic mean): average - Calculates the arithmetic mean of a list of values.

• Statistical median: median - Calculates the statistical median (middle value) of a list of values.

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

• Expand groups into entities: expand - Expands groups and zones into a list of individual entity state objects.