Home ▸ Template functions

Multiply a value: multiply

The multiply filter converts a value to a float and multiplies it by a specified amount. If the value cannot be converted to a number, it returns the default you provide instead of raising an error.

This is a convenient shorthand for scaling sensorSensors return information about a thing, for instance the level of water in a tank. [Learn more] values. Instead of converting to a float first and then multiplying, you can do it in a single step. Common uses include converting units (watts to kilowatts, Celsius to Fahrenheit), applying a cost rate to an energy reading, or scaling a percentage to a different range. For addition, see add.

Usage

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

As a filter

{{ states("sensor.power_watts") | multiply(0.001) }}

Result (float)

1.5

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.

multiply(
    value: Any,
    amount: float,
    default: Any,
) -> float | Any

Function parameters

The following parameters can be provided to this filter.

value any Required

The value to convert to a float and multiply. Must be a number or a string that can be converted to a float.

amount float Required

The amount to multiply the value by.

default any (Optional)

The value to return if the conversion fails, such as 0. If you leave out default and the conversion fails, multiply raises an error and the template fails.

Using a default value

If the sensor might be unavailable, provide a default to prevent errors.

Template: Safe multiplication with default

{{ states("sensor.power_watts") | multiply(0.001, default=0) }}

Result (float)

1.5

Good to know

There is no division filter. Pass a fractional amount, like 0.001 to divide by 1000.
The result is always a float, even when both inputs are integers.
Without a default, non-numeric input raises an error. Always pass a default when working with state values.

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.

Convert watts to kilowatts

Scale a power reading from watts to kilowatts for cleaner display.

Template

{{ states("sensor.power_usage") | multiply(0.001) | round(2) }}

Result (float)

1.50

Calculate energy cost

Multiply today’s energy consumption by the price per kWh.

Template: Energy cost at 0.25 per kWh

{{ states("sensor.energy_today") | multiply(0.25) | round(2) }}

Result (float)

3.47

Scale a percentage to a brightness value

Convert a 0-100 percentage to a 0-255 brightness scale for a light.

Action

action:
  - action: light.turn_on
    target:
      entity_id: light.desk_lamp
    data:
      brightness: >
        {{ states("sensor.ambient_light_pct") | multiply(2.55) | int(128) }}

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:

Add to a value: add - Adds a specified amount to a numeric value, with an optional default if conversion fails.
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.
Round a number: round - Rounds a numeric value to a specified number of decimal places using various rounding methods.

Help us improve our documentation

Was this page helpful?

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