Keeps track which switches are in your environment, their state and allows you to control them.

  • Maintains a state per switch and a combined state all_switches.
  • Registers services switch.turn_on, switch.turn_off, and switch.toggle to control switches.

Building block integration

This switch is a building block integration that cannot be added to your Home Assistant directly but is used and provided by other integrations.

A building block integration differs from the typical integration that connects to a device or service. Instead, other integrations that do integrate a device or service into Home Assistant use this switch building block to provide entities, services, and other functionality that you can use in your automations or dashboards.

If one of your integrations features this building block, this page documents the functionality the switch building block offers.

Device class

A device class is a measurement categorization in Home Assistant. It influences how the entity is represented in the dashboard. This can be modified in the customize section. For example, different states may be represented by different icons, colors, or text.

The following device classes are supported for switches:

  • None: Generic switch. This is the default and doesn’t need to be set.
  • outlet: A switch for a power outlet.
  • switch: A generic switch.

Use the services

In the frontend open the sidebar. At the bottom, under Developer Tools, click Services. From the Service dropdown menu choose switch.turn_on or switch.turn_off from the list of available services. In the Entity dropdown menu choose or enter the entity ID you want to work with. This will enter something like the sample below into the Service Data field. Now hit CALL SERVICE.

Service data attribute Optional Description
entity_id no String or list of strings that point at entity_ids of switches. To target all switches, set entity_id to all.