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

Public Member Functions

None __init__ (self, AvmWrapper avm_wrapper, str device_friendly_name, SwitchInfo switch_info)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
None async_update (self)
 
bool available (self)
 
dict[str, str|Noneextra_state_attributes (self)
 
str icon (self)
 
str name (self)
 
str unique_id (self)
 
- Public Member Functions inherited from homeassistant.components.fritz.entity.FritzBoxBaseEntity
None __init__ (self, AvmWrapper avm_wrapper, str device_name)
 
DeviceInfo device_info (self)
 
str mac_address (self)
 
- 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 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_added_to_hass (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)
 
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)
 
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)
 
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 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)
 

Private Member Functions

None _async_handle_turn_on_off (self, bool turn_on)
 

Private Attributes

 _attr_is_on
 
 _description
 
 _friendly_name
 
 _icon
 
 _is_available
 
 _name
 
 _switch
 
 _type
 
 _unique_id
 
 _update
 

Additional Inherited Members

- 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.ToggleEntity
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Fritz switch base class.

Definition at line 308 of file switch.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.fritz.switch.FritzBoxBaseSwitch.__init__ (   self,
AvmWrapper  avm_wrapper,
str  device_friendly_name,
SwitchInfo  switch_info 
)
Init Fritzbox base switch.

Definition at line 311 of file switch.py.

Member Function Documentation

◆ _async_handle_turn_on_off()

None homeassistant.components.fritz.switch.FritzBoxBaseSwitch._async_handle_turn_on_off (   self,
bool  turn_on 
)
private
Handle switch state change request.

Definition at line 372 of file switch.py.

◆ async_turn_off()

None homeassistant.components.fritz.switch.FritzBoxBaseSwitch.async_turn_off (   self,
**Any  kwargs 
)
Turn off switch.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 368 of file switch.py.

◆ async_turn_on()

None homeassistant.components.fritz.switch.FritzBoxBaseSwitch.async_turn_on (   self,
**Any  kwargs 
)
Turn on switch.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 364 of file switch.py.

◆ async_update()

None homeassistant.components.fritz.switch.FritzBoxBaseSwitch.async_update (   self)
Update data.

Definition at line 359 of file switch.py.

◆ available()

bool homeassistant.components.fritz.switch.FritzBoxBaseSwitch.available (   self)
Return availability.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 350 of file switch.py.

◆ extra_state_attributes()

dict[str, str | None] homeassistant.components.fritz.switch.FritzBoxBaseSwitch.extra_state_attributes (   self)
Return device attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 355 of file switch.py.

◆ icon()

str homeassistant.components.fritz.switch.FritzBoxBaseSwitch.icon (   self)
Return name.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 340 of file switch.py.

◆ name()

str homeassistant.components.fritz.switch.FritzBoxBaseSwitch.name (   self)
Return name.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 335 of file switch.py.

◆ unique_id()

str homeassistant.components.fritz.switch.FritzBoxBaseSwitch.unique_id (   self)
Return unique id.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 345 of file switch.py.

Member Data Documentation

◆ _attr_is_on

homeassistant.components.fritz.switch.FritzBoxBaseSwitch._attr_is_on
private

Definition at line 326 of file switch.py.

◆ _description

homeassistant.components.fritz.switch.FritzBoxBaseSwitch._description
private

Definition at line 320 of file switch.py.

◆ _friendly_name

homeassistant.components.fritz.switch.FritzBoxBaseSwitch._friendly_name
private

Definition at line 321 of file switch.py.

◆ _icon

homeassistant.components.fritz.switch.FritzBoxBaseSwitch._icon
private

Definition at line 322 of file switch.py.

◆ _is_available

homeassistant.components.fritz.switch.FritzBoxBaseSwitch._is_available
private

Definition at line 332 of file switch.py.

◆ _name

homeassistant.components.fritz.switch.FritzBoxBaseSwitch._name
private

Definition at line 328 of file switch.py.

◆ _switch

homeassistant.components.fritz.switch.FritzBoxBaseSwitch._switch
private

Definition at line 325 of file switch.py.

◆ _type

homeassistant.components.fritz.switch.FritzBoxBaseSwitch._type
private

Definition at line 323 of file switch.py.

◆ _unique_id

homeassistant.components.fritz.switch.FritzBoxBaseSwitch._unique_id
private

Definition at line 329 of file switch.py.

◆ _update

homeassistant.components.fritz.switch.FritzBoxBaseSwitch._update
private

Definition at line 324 of file switch.py.


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