Bitwise XOR: bitwise_xor

The bitwise_xor template function performs a bitwise XOR (exclusive OR) operation on two integer values. Each bit in the result is set to 1 only if exactly one of the corresponding bits in the input values is 1.

This is useful for toggling specific bits in a bitmask or comparing two status values to find which bits differ. For example, you could compare the current and previous status registers of a deviceA device is a model representing a physical or logical unit that contains entities. to detect which flags have changed.

Usage

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

{{ bitwise_xor(5, 3) }}

6

{{ 5 | bitwise_xor(3) }}

6

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.

bitwise_xor(
    first_value: Any,
    second_value: Any,
) -> int

Function parameters

The following parameters can be provided to this function.

Good to know

• Both inputs must be integers. Convert state strings with int first.
• XOR-ing a value with itself produces zero, which is a quick way to detect whether two values are identical.

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.

Detecting changed bits

Compare two status values to find which bits changed.

{% set old_status = 0b1010 %}
{% set new_status = 0b1100 %}
{{ bitwise_xor(old_status, new_status) }}

6

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:

• Bitwise AND: bitwise_and - Performs a bitwise AND operation on two values.

• Bitwise OR: bitwise_or - Performs a bitwise OR operation on two values.