Convert to integer: int

The int template function converts a value to an integer (whole number). If the value cannot be converted, int raises an error. If you provide a default, it returns the default instead. With a default, like float, it is safe to use with sensorSensors return information about a thing, for instance the level of water in a tank. [Learn more] values that might sometimes be invalid.

In Home Assistant, all 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] states are stored as strings. When you need a whole number for math, comparisons, or passing to an actionAn action makes Home Assistant do something, for example, turn on a light, send a notification, or activate a scene. Automations and scripts run a list of actions. [Learn more], you need to convert first. The int function also supports a base parameter for converting hexadecimal, octal, or binary strings. If you need decimal precision, use float instead.

Usage

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

{{ int("42") }}

42

{{ states("sensor.battery_level") | int }}

87

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

int(
    value: Any,
    default: Any,
    base: int = 10,
) -> int | Any

Function parameters

The following parameters can be provided to this function.

Using a default value

Since sensorSensors return information about a thing, for instance the level of water in a tank. [Learn more] states can be unavailable or unknown, always provide a default to prevent 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.

{{ states("sensor.battery_level") | int(0) }}

87

Converting from other bases

Use the base parameter to convert hexadecimal, octal, or binary strings.

{{ int("ff", base=16) }}

255

{{ int("0b1010", base=2) }}

10

Good to know

• Floats are truncated toward zero, not rounded. 2.9 | int is 2, and -2.9 | int is -2. Use round first if you want rounding.
• Strings with decimals are truncated too. "21.5" | int is 21, and "1e3" | int is 1000.
• The boolean true converts to 1, and false converts to 0.
• A string with a prefix, like "0x1A", raises an error without base. Use base=16, or use base=0 to detect the prefix automatically.
• The base parameter only applies to string inputs. Passing a number with base=16 does not convert it.

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.

Set a light brightness from a sensor

Use an 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] state as a brightness value for a light. The int filter converts the string state to a whole number suitable for the brightness attribute.

action:
  - action: light.turn_on
    target:
      entity_id: light.living_room
    data:
      brightness: >
        {{ states("sensor.ambient_light") | int(128) }}

Count items with integer math

Calculate how many full hours have passed since a counter was last reset.

{{
  ((as_timestamp(now())
    - as_timestamp(states.counter.runtime.last_changed)) / 3600)
  | int(0)
}}

3

Use in a condition

Only proceed if the battery level is above a threshold.

condition:
  - condition: template
    value_template: >
      {{ states("sensor.phone_battery") | int(0) > 20 }}

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:

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

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

• Round a number: round - Rounds a numeric value to a specified number of decimal places using various rounding methods.

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