Home ▸ Template functions

Statistical mode: statistical_mode

The statistical_mode template function returns the most commonly occurring value in a collection. Give it a list of values and it returns the one that appears most often. If multiple values share the highest frequency, it returns the first one encountered.

This is useful when you want to find the most frequent reading from a set of sensorsSensors return information about a thing, for instance the level of water in a tank. [Learn more] rather than a numeric average. For example, if several motion sensors each report a room as either “occupied” or “empty”, the mode tells you what the majority of sensors agree on. It also works with numeric values, such as finding the most common brightness setting across a group of lights.

Usage

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

As a function

As a filter

Template

{{ statistical_mode(21, 22, 21, 23, 21) }}

Result (float)

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

round is 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 as 0 or "unknown", not the word Any.
= 0 and = "common" are default values. You can leave out precision and method, and round uses these default values.
default has no =, but the parameter list marks default as optional. If you leave out default and round gets a value that isn’t a number, round raises 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 as default.

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 as 5
float: a decimal number, such as 3.14
bool: true or false
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"}
datetime and timedelta: 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:

*args means 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 the round example, show this value as the first parameter between the parentheses instead.

statistical_mode(
    *args: list | float,
    default: Any,
) -> float

Function parameters

The following parameters can be provided to this function.

values list Required

The values to find the mode of. Can be a list or multiple separate arguments.

default any (Optional)

The value to return if the calculation fails, such as 0. For example, the calculation fails if the list is empty. If you leave out default and the calculation fails, statistical_mode raises an error and the template fails.

Using a default value

If the list might be empty or contain invalid values, provide a default to avoid errors. This prevents your templateA 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] from breaking when a sensor is temporarily unavailable.

Template

{{
  [states("sensor.maybe_broken") | float(none)]
  | reject("none")
  | list
  | statistical_mode(default=0)
}}

Result (float)

Good to know

When multiple values are tied for the highest frequency, the first one encountered wins.
Works with any hashable type, not only numbers. Strings like "on" and "off" are valid inputs too.

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.

Most common temperature reading

Find the most frequently reported temperature across multiple sensors.

Template

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

Result (float)

21.0

Mode 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, you can expand the group and find the most common value in one expression.

Template

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

Result (float)

21.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.

Tip

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:

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.
Minimum value: min - Returns the smallest value from a list of values.
Maximum value: max - Returns the largest value from a list of values.
Expand groups into entities: expand - Expands groups and zones into a list of individual entity state objects.

Help us improve our documentation

Was this page helpful?

Suggest an edit to this page, or provide/view feedback for this page.