jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-04-25 13:57:37 +00:00
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/_integrations/switch.markdown
c0ffeeca7 89b5af33bd
States: add unavailable and unknown (#34809) 
* States: add unavailable and unknown

* rephrase intro

* Make states lowercase

* Update source/_integrations/humidifier.markdown

Co-authored-by: Klaas Schoute <klaas_schoute@hotmail.com>

* Revert "Make states lowercase"

This reverts commit daf7f06630c4a2cc1f7e7fe5d043d9754a79cd1d.

* Apply bold to the UI string of state names

* Climate: fix grammar

---------

Co-authored-by: Klaas Schoute <klaas_schoute@hotmail.com>
2024-09-18 15:36:17 +02:00

2.2 KiB
Raw Blame History

title description ha_category ha_release ha_quality_scale ha_domain ha_platforms ha_codeowners ha_integration_type related
Switch Instructions on how to set up your switches with Home Assistant.
Switch
0.7 internal switch
light
@home-assistant/core
entity
docs title
/docs/configuration/customizing-devices/ Customizing devices
docs title
/dashboards/ Dashboard

The Switch {% term integration %} manages the state of the switch entities and allows you to control them.

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

{% include integrations/building_block_integration.md %}

The state of a switch entity

The state of a switch {% term entity %} can be either On or Off.

In addition, the entity can have the following states:

  • Unavailable: The entity is currently unavailable.
  • Unknown: The state is not yet known.

Device class

{% include integrations/device_class_intro.md %}

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.

Using the actions

In the frontend open Settings. Select Developer tools, click Actions. From the Action dropdown menu choose switch.turn_on or switch.turn_off from the list of available actions. 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 data field. Now select Perform action.

{"entity_id":"switch.livingroom_pin2"}
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.