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

Public Member Functions

None __init__ (self, str feature_type, SonosSpeaker speaker)
 
bool is_on (self)
 
None poll_state (self)
 
None send_command (self, bool enable)
 
None turn_off (self, **Any kwargs)
 
None turn_on (self, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.sonos.entity.SonosPollingEntity
None update (self)
 
- Public Member Functions inherited from homeassistant.components.sonos.entity.SonosEntity
None __init__ (self, SonosSpeaker speaker)
 
None async_added_to_hass (self)
 
None async_fallback_poll (self, datetime.datetime now)
 
None async_will_remove_from_hass (self)
 
bool available (self)
 
DeviceInfo device_info (self)
 
SoCo soco (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_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_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)
 
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)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
Literal["on", "off"]|None state (self)
 
None toggle (self, **Any kwargs)
 

Public Attributes

 feature_type
 
 needs_coordinator
 
- Public Attributes inherited from homeassistant.components.sonos.entity.SonosEntity
 speaker
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Member Functions

None _async_fallback_poll (self)
 

Private Attributes

 _attr_entity_category
 
 _attr_entity_registry_enabled_default
 
 _attr_should_poll
 
 _attr_translation_key
 
 _attr_unique_id
 

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 Sonos feature switch.

Definition at line 127 of file switch.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.sonos.switch.SonosSwitchEntity.__init__ (   self,
str  feature_type,
SonosSpeaker  speaker 
)
Initialize the switch.

Definition at line 130 of file switch.py.

Member Function Documentation

◆ _async_fallback_poll()

None homeassistant.components.sonos.switch.SonosSwitchEntity._async_fallback_poll (   self)
private
Handle polling for subscription-based switches when subscription fails.

Reimplemented from homeassistant.components.sonos.entity.SonosEntity.

Definition at line 143 of file switch.py.

◆ is_on()

bool homeassistant.components.sonos.switch.SonosSwitchEntity.is_on (   self)
Return True if entity is on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 155 of file switch.py.

◆ poll_state()

None homeassistant.components.sonos.switch.SonosSwitchEntity.poll_state (   self)
Poll the current state of the switch.

Reimplemented from homeassistant.components.sonos.entity.SonosPollingEntity.

Definition at line 149 of file switch.py.

◆ send_command()

None homeassistant.components.sonos.switch.SonosSwitchEntity.send_command (   self,
bool  enable 
)
Enable or disable the feature on the device.

Definition at line 170 of file switch.py.

◆ turn_off()

None homeassistant.components.sonos.switch.SonosSwitchEntity.turn_off (   self,
**Any  kwargs 
)
Turn the entity off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 165 of file switch.py.

◆ turn_on()

None homeassistant.components.sonos.switch.SonosSwitchEntity.turn_on (   self,
**Any  kwargs 
)
Turn the entity on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 161 of file switch.py.

Member Data Documentation

◆ _attr_entity_category

homeassistant.components.sonos.switch.SonosSwitchEntity._attr_entity_category
private

Definition at line 135 of file switch.py.

◆ _attr_entity_registry_enabled_default

homeassistant.components.sonos.switch.SonosSwitchEntity._attr_entity_registry_enabled_default
private

Definition at line 140 of file switch.py.

◆ _attr_should_poll

homeassistant.components.sonos.switch.SonosSwitchEntity._attr_should_poll
private

Definition at line 141 of file switch.py.

◆ _attr_translation_key

homeassistant.components.sonos.switch.SonosSwitchEntity._attr_translation_key
private

Definition at line 136 of file switch.py.

◆ _attr_unique_id

homeassistant.components.sonos.switch.SonosSwitchEntity._attr_unique_id
private

Definition at line 137 of file switch.py.

◆ feature_type

homeassistant.components.sonos.switch.SonosSwitchEntity.feature_type

Definition at line 133 of file switch.py.

◆ needs_coordinator

homeassistant.components.sonos.switch.SonosSwitchEntity.needs_coordinator

Definition at line 134 of file switch.py.


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