Get the type of a value: typeof

The typeof template function returns the type name of a value as a string. It tells you what kind of data you are working with, such as str, int, float, list, dict, or bool. This is the Python class name of the value.

This is primarily useful for debugging templatesA 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]. When a template does not behave as expected, it is often because a value is a different type than you assumed. For example, you might think a sensor value is a number, but it is actually a string. Or an attribute you expected to be a list is actually None. Using typeof lets you inspect the actual types at runtime so you can figure out what is going on and write the correct conversion or comparison.

Usage

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

{{ typeof(42) }}

int

{{ states("sensor.temperature") | typeof }}

str

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.

typeof(
    value: Any,
) -> str

Function parameters

The following parameters can be provided to this function.

Common type names

Here are the type names you will encounter most often:

• str for text (for example, hello or the result of states("..."))
• int for whole numbers (for example, 42 or states("...") | int)
• float for decimal numbers (for example, 21.5 or states("...") | float)
• bool for true or false
• list for a list of values (for example, [1, 2, 3])
• dict for a mapping (for example, {"a": 1})
• NoneType for None

Good to know

• Results are Python class names like str, int, or NoneType. They are not Jinja or YAML type names.
• All entity states are str, regardless of what they look like. A temperature sensor returning 21.5 still reports as str until you convert it.
• Intended mainly for debugging. In production templates, prefer type tests like is number or conversion functions like float.

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.

Debug a sensor state type

Check what type a state value is. Since all entity states are strings, this confirms the need for type conversion before math.

State type: {{ states("sensor.temperature") | typeof }}
After float: {{ (states("sensor.temperature") | float) | typeof }}

State type: str
After float: float

Check the type of an attribute

EntityAn 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] attributes can be various types. Use typeof to inspect what you are working with.

{{ state_attr("climate.living_room", "hvac_modes") | typeof }}

list

Conditional logic based on type

Handle different types differently in a 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].

{% set val = state_attr("sensor.data", "reading") %}
{% if val | typeof == "list" %}
  Got {{ val | length }} items
{% else %}
  Single value: {{ val }}
{% endif %}

Got 3 items

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:

• Test if value is numeric: is_number - Tests whether a value can be converted to a finite number.

• Convert to float: float - Converts a value to a floating-point number, with an optional default if conversion fails.

• Convert to integer: int - Converts a value to an integer, with an optional default if conversion fails.

• Convert to boolean: bool - Converts a value to a boolean (true/false), with an optional default if conversion fails.