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

Public Member Functions

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)
 

Private Attributes

 _attr_entity_registry_enabled_default
 
 _attr_icon
 
 _attr_name
 

Additional Inherited Members

- 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
 

Detailed Description

Defines a base MusicCast entity.

Definition at line 19 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.yamaha_musiccast.entity.MusicCastEntity.__init__ (   self,
*str  name,
str  icon,
MusicCastDataUpdateCoordinator  coordinator,
bool   enabled_default = True 
)
Initialize the MusicCast entity.

Definition at line 22 of file entity.py.

Member Data Documentation

◆ _attr_entity_registry_enabled_default

homeassistant.components.yamaha_musiccast.entity.MusicCastEntity._attr_entity_registry_enabled_default
private

Definition at line 32 of file entity.py.

◆ _attr_icon

homeassistant.components.yamaha_musiccast.entity.MusicCastEntity._attr_icon
private

Definition at line 33 of file entity.py.

◆ _attr_name

homeassistant.components.yamaha_musiccast.entity.MusicCastEntity._attr_name
private

Definition at line 34 of file entity.py.


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