Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.zha.switch.Switch Class Reference
Inheritance diagram for homeassistant.components.zha.switch.Switch:
[legend]
Collaboration diagram for homeassistant.components.zha.switch.Switch:
[legend]

Public Member Functions

None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
bool is_on (self)
 
- Public Member Functions inherited from homeassistant.components.zha.entity.ZHAEntity
None __init__ (self, EntityData entity_data, *args, **kwargs)
 
None async_added_to_hass (self)
 
None async_update (self)
 
None async_will_remove_from_hass (self)
 
bool available (self)
 
DeviceInfo device_info (self)
 
def log (self, int level, str msg, *args, **kwargs)
 
str|UndefinedType|None name (self)
 
None restore_external_state_attributes (self, State state)
 
- Public Member Functions inherited from homeassistant.helpers.restore_state.RestoreEntity
ExtraStoredData|None async_get_last_extra_data (self)
 
State|None async_get_last_state (self)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
ExtraStoredData|None extra_restore_state_data (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.Entity
None __init_subclass__ (cls, **Any kwargs)
 
str __repr__ (self)
 
None add_to_platform_abort (self)
 
None add_to_platform_finish (self)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
bool assumed_state (self)
 
None async_device_update (self, bool warning=True)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
None async_registry_entry_updated (self)
 
None async_remove (self, *bool force_remove=False)
 
None async_removed_from_registry (self)
 
None async_schedule_update_ha_state (self, bool force_refresh=False)
 
None async_set_context (self, Context context)
 
None async_update_ha_state (self, bool force_refresh=False)
 
None async_write_ha_state (self)
 
str|None attribution (self)
 
dict[str, Any]|None capability_attributes (self)
 
bool enabled (self)
 
EntityCategory|None entity_category (self)
 
str|None entity_picture (self)
 
bool entity_registry_enabled_default (self)
 
bool entity_registry_visible_default (self)
 
Mapping[str, Any]|None extra_state_attributes (self)
 
bool force_update (self)
 
HassJobType get_hassjob_type (self, str function_name)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
bool has_entity_name (self)
 
str|None icon (self)
 
None schedule_update_ha_state (self, bool force_refresh=False)
 
bool should_poll (self)
 
dict[str, Any]|None state_attributes (self)
 
str|None suggested_object_id (self)
 
int|None supported_features (self)
 
str|None translation_key (self)
 
Mapping[str, strtranslation_placeholders (self)
 
str|None unique_id (self)
 
str|None unit_of_measurement (self)
 
bool use_device_name (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None __init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
 
Any __new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.switch.SwitchEntity
SwitchDeviceClass|None device_class (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.ToggleEntity
None async_toggle (self, **Any kwargs)
 
Literal["on", "off"]|None state (self)
 
None toggle (self, **Any kwargs)
 
None turn_off (self, **Any kwargs)
 
None turn_on (self, **Any kwargs)
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.zha.entity.ZHAEntity
 remove_future
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 
- Static Public Attributes inherited from homeassistant.helpers.entity.ToggleEntity
 None
 

Detailed Description

ZHA switch.

Definition at line 46 of file switch.py.

Member Function Documentation

◆ async_turn_off()

None homeassistant.components.zha.switch.Switch.async_turn_off (   self,
**Any  kwargs 
)
Turn the entity off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 61 of file switch.py.

◆ async_turn_on()

None homeassistant.components.zha.switch.Switch.async_turn_on (   self,
**Any  kwargs 
)
Turn the entity on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 55 of file switch.py.

◆ is_on()

bool homeassistant.components.zha.switch.Switch.is_on (   self)
Return if the switch is on based on the statemachine.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 50 of file switch.py.


The documentation for this class was generated from the following file: