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

Public Member Functions

None __init__ (self, str|None unique_id, str name, list[str] entity_ids, bool|None mode)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
None async_update_group_state (self)
 
- Public Member Functions inherited from homeassistant.components.group.entity.GroupEntity
None async_added_to_hass (self)
 
None async_defer_or_update_ha_state (self)
 
CALLBACK_TYPE async_start_preview (self, Callable[[str, Mapping[str, Any]], None] preview_callback)
 
None async_update_supported_features (self, str entity_id, State|None new_state)
 
- 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_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
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_will_remove_from_hass (self)
 
None async_write_ha_state (self)
 
str|None attribution (self)
 
bool available (self)
 
dict[str, Any]|None capability_attributes (self)
 
DeviceInfo|None device_info (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)
 
str|UndefinedType|None name (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)
 
bool|None is_on (self)
 
Literal["on", "off"]|None state (self)
 
None toggle (self, **Any kwargs)
 
None turn_off (self, **Any kwargs)
 
None turn_on (self, **Any kwargs)
 

Public Attributes

 mode
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Attributes

 _attr_available
 
 _attr_extra_state_attributes
 
 _attr_is_on
 
 _attr_name
 
 _attr_unique_id
 
 _entity_ids
 

Static Private Attributes

bool _attr_available = False
 
bool _attr_should_poll = False
 

Additional Inherited Members

- 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

Representation of a switch group.

Definition at line 106 of file switch.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.group.switch.SwitchGroup.__init__ (   self,
str | None  unique_id,
str  name,
list[str entity_ids,
bool | None  mode 
)
Initialize a switch group.

Definition at line 112 of file switch.py.

Member Function Documentation

◆ async_turn_off()

None homeassistant.components.group.switch.SwitchGroup.async_turn_off (   self,
**Any  kwargs 
)
Forward the turn_off command to all switches in the group.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 142 of file switch.py.

◆ async_turn_on()

None homeassistant.components.group.switch.SwitchGroup.async_turn_on (   self,
**Any  kwargs 
)
Forward the turn_on command to all switches in the group.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 129 of file switch.py.

◆ async_update_group_state()

None homeassistant.components.group.switch.SwitchGroup.async_update_group_state (   self)
Query all members and determine the switch group state.

Reimplemented from homeassistant.components.group.entity.GroupEntity.

Definition at line 154 of file switch.py.

Member Data Documentation

◆ _attr_available [1/2]

bool homeassistant.components.group.switch.SwitchGroup._attr_available = False
staticprivate

Definition at line 109 of file switch.py.

◆ _attr_available [2/2]

homeassistant.components.group.switch.SwitchGroup._attr_available
private

Definition at line 174 of file switch.py.

◆ _attr_extra_state_attributes

homeassistant.components.group.switch.SwitchGroup._attr_extra_state_attributes
private

Definition at line 123 of file switch.py.

◆ _attr_is_on

homeassistant.components.group.switch.SwitchGroup._attr_is_on
private

Definition at line 168 of file switch.py.

◆ _attr_name

homeassistant.components.group.switch.SwitchGroup._attr_name
private

Definition at line 122 of file switch.py.

◆ _attr_should_poll

bool homeassistant.components.group.switch.SwitchGroup._attr_should_poll = False
staticprivate

Definition at line 110 of file switch.py.

◆ _attr_unique_id

homeassistant.components.group.switch.SwitchGroup._attr_unique_id
private

Definition at line 124 of file switch.py.

◆ _entity_ids

homeassistant.components.group.switch.SwitchGroup._entity_ids
private

Definition at line 120 of file switch.py.

◆ mode

homeassistant.components.group.switch.SwitchGroup.mode

Definition at line 125 of file switch.py.


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