Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.yamaha_musiccast.entity.MusicCastCapabilityEntity Class Reference
Inheritance diagram for homeassistant.components.yamaha_musiccast.entity.MusicCastCapabilityEntity:
[legend]
Collaboration diagram for homeassistant.components.yamaha_musiccast.entity.MusicCastCapabilityEntity:
[legend]

Public Member Functions

None __init__ (self, MusicCastDataUpdateCoordinator coordinator, Capability capability, str|None zone_id=None)
 
str unique_id (self)
 
- Public Member Functions inherited from homeassistant.components.yamaha_musiccast.entity.MusicCastDeviceEntity
def async_added_to_hass (self)
 
def async_will_remove_from_hass (self)
 
def device_id (self)
 
DeviceInfo device_info (self)
 
def device_name (self)
 
- Public Member Functions inherited from homeassistant.components.yamaha_musiccast.entity.MusicCastEntity
None __init__ (self, *str name, str icon, MusicCastDataUpdateCoordinator coordinator, bool enabled_default=True)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.components.yamaha_musiccast.coordinator.MusicCastDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, MusicCastDevice client)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
 
Callable[[], None] async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
 
None async_config_entry_first_refresh (self)
 
Generator[Any] async_contexts (self)
 
None async_refresh (self)
 
None async_register_shutdown (self)
 
None async_request_refresh (self)
 
None async_set_update_error (self, Exception err)
 
None async_set_updated_data (self, _DataT data)
 
None async_shutdown (self)
 
None async_update_listeners (self)
 
timedelta|None update_interval (self)
 
None update_interval (self, timedelta|None value)
 

Public Attributes

 capability
 
- Public Attributes inherited from homeassistant.components.yamaha_musiccast.coordinator.MusicCastDataUpdateCoordinator
 musiccast
 
- Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
 always_update
 
 config_entry
 
 data
 
 hass
 
 last_exception
 
 last_update_success
 
 logger
 
 name
 
 setup_method
 
 update_interval
 
 update_method
 

Private Attributes

 _attr_entity_category
 
 _zone_id
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.components.yamaha_musiccast.entity.MusicCastDeviceEntity
 str
 

Detailed Description

Base Entity type for all capabilities.

Definition at line 93 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.yamaha_musiccast.entity.MusicCastCapabilityEntity.__init__ (   self,
MusicCastDataUpdateCoordinator  coordinator,
Capability  capability,
str | None   zone_id = None 
)
Initialize a capability based entity.

Definition at line 96 of file entity.py.

Member Function Documentation

◆ unique_id()

str homeassistant.components.yamaha_musiccast.entity.MusicCastCapabilityEntity.unique_id (   self)
Return the unique ID for this entity.

Definition at line 110 of file entity.py.

Member Data Documentation

◆ _attr_entity_category

homeassistant.components.yamaha_musiccast.entity.MusicCastCapabilityEntity._attr_entity_category
private

Definition at line 107 of file entity.py.

◆ _zone_id

homeassistant.components.yamaha_musiccast.entity.MusicCastCapabilityEntity._zone_id
private

Definition at line 104 of file entity.py.

◆ capability

homeassistant.components.yamaha_musiccast.entity.MusicCastCapabilityEntity.capability

Definition at line 105 of file entity.py.


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