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.

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

21

{{ [21, 22, 21, 23, 21] | statistical_mode }}

21

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.

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

Function parameters

The following parameters can be provided to this function.

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.

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

0

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

Most common temperature reading

Find the most frequently reported temperature across multiple sensors.

{{
  statistical_mode(
    states("sensor.living_room_temperature") | float,
    states("sensor.bedroom_temperature") | float,
    states("sensor.kitchen_temperature") | float,
    states("sensor.hallway_temperature") | 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.

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

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.

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 sorted list of individual entity state objects.