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

Public Member Functions

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)
 

Static Public Attributes

 str
 

Private Attributes

 _zone_id
 

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 MusicCast device entity.

Definition at line 37 of file entity.py.

Member Function Documentation

◆ async_added_to_hass()

def homeassistant.components.yamaha_musiccast.entity.MusicCastDeviceEntity.async_added_to_hass (   self)
Run when this Entity has been added to HA.

Reimplemented in homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.

Definition at line 81 of file entity.py.

◆ async_will_remove_from_hass()

def homeassistant.components.yamaha_musiccast.entity.MusicCastDeviceEntity.async_will_remove_from_hass (   self)
Entity being removed from hass.

Reimplemented in homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.

Definition at line 87 of file entity.py.

◆ device_id()

def homeassistant.components.yamaha_musiccast.entity.MusicCastDeviceEntity.device_id (   self)
Return the ID of the current device.

Definition at line 43 of file entity.py.

◆ device_info()

DeviceInfo homeassistant.components.yamaha_musiccast.entity.MusicCastDeviceEntity.device_info (   self)
Return device information about this MusicCast device.

Definition at line 55 of file entity.py.

◆ device_name()

def homeassistant.components.yamaha_musiccast.entity.MusicCastDeviceEntity.device_name (   self)
Return the name of the current device.

Definition at line 50 of file entity.py.

Member Data Documentation

◆ _zone_id

homeassistant.components.yamaha_musiccast.entity.MusicCastDeviceEntity._zone_id
private

Definition at line 45 of file entity.py.

◆ str

homeassistant.components.yamaha_musiccast.entity.MusicCastDeviceEntity.str
static

Definition at line 40 of file entity.py.


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