Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.switch.light Namespace Reference

Classes

class  LightSwitch
 

Functions

None async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType|None discovery_info=None)
 

Variables

string DEFAULT_NAME = "Light Switch"
 
 PLATFORM_SCHEMA
 

Detailed Description

Light support for switch entities.

Function Documentation

◆ async_setup_platform()

None homeassistant.components.switch.light.async_setup_platform ( HomeAssistant  hass,
ConfigType  config,
AddEntitiesCallback  async_add_entities,
DiscoveryInfoType | None   discovery_info = None 
)
Initialize Light Switch platform.

Definition at line 42 of file light.py.

Variable Documentation

◆ DEFAULT_NAME

string homeassistant.components.switch.light.DEFAULT_NAME = "Light Switch"

Definition at line 32 of file light.py.

◆ PLATFORM_SCHEMA

homeassistant.components.switch.light.PLATFORM_SCHEMA
Initial value:
1 = LIGHT_PLATFORM_SCHEMA.extend(
2  {
3  vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
4  vol.Required(CONF_ENTITY_ID): cv.entity_domain(SWITCH_DOMAIN),
5  }
6 )

Definition at line 34 of file light.py.