homeassistant.components.yolink.entity.YoLinkEntity Class Reference

Inheritance diagram for homeassistant.components.yolink.entity.YoLinkEntity:

Collaboration diagram for homeassistant.components.yolink.entity.YoLinkEntity:

Public Member Functions
None	__init__ (self, ConfigEntry config_entry, YoLinkCoordinator coordinator)
None	async_added_to_hass (self)
None	call_device (self, ClientRequest request)
str	device_id (self)
DeviceInfo	device_info (self)
None	update_entity_state (self, dict state)
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.yolink.coordinator.YoLinkCoordinator
None	__init__ (self, HomeAssistant hass, YoLinkDevice device, YoLinkDevice|None paired_device=None)
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
	config_entry
Public Attributes inherited from homeassistant.components.yolink.coordinator.YoLinkCoordinator
	dev_online
	device
	paired_device
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 Member Functions
None	_handle_coordinator_update (self)

Static Private Attributes
bool	_attr_has_entity_name = True

Detailed Description

YoLink Device Basic Entity.

Definition at line 20 of file entity.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.yolink.entity.YoLinkEntity.__init__	(		self,
		ConfigEntry	config_entry,
		YoLinkCoordinator	coordinator
	)

Init YoLink Entity.

Reimplemented in homeassistant.components.yolink.lock.YoLinkLockEntity, homeassistant.components.yolink.light.YoLinkDimmerEntity, homeassistant.components.yolink.cover.YoLinkCoverEntity, and homeassistant.components.yolink.climate.YoLinkClimateEntity.

Definition at line 25 of file entity.py.

Member Function Documentation

_handle_coordinator_update()

None homeassistant.components.yolink.entity.YoLinkEntity._handle_coordinator_update (   self )

private

Update state.

Definition at line 45 of file entity.py.

async_added_to_hass()

None homeassistant.components.yolink.entity.YoLinkEntity.async_added_to_hass

(

self

)

Update state.

Definition at line 39 of file entity.py.

call_device()

None homeassistant.components.yolink.entity.YoLinkEntity.call_device	(		self,
		ClientRequest	request
	)

Call device api.

Definition at line 67 of file entity.py.

device_id()

str homeassistant.components.yolink.entity.YoLinkEntity.device_id

(

self

)

Return the device id of the YoLink device.

Definition at line 35 of file entity.py.

device_info()

DeviceInfo homeassistant.components.yolink.entity.YoLinkEntity.device_info

(

self

)

Return the device info for HA.

Definition at line 52 of file entity.py.

update_entity_state()

None homeassistant.components.yolink.entity.YoLinkEntity.update_entity_state	(		self,
		dict	state
	)

Parse and update entity state, should be overridden.

Reimplemented in homeassistant.components.yolink.sensor.YoLinkSensorEntity, and homeassistant.components.yolink.number.YoLinkNumberTypeConfigEntity.

Definition at line 64 of file entity.py.

Member Data Documentation

_attr_has_entity_name

bool homeassistant.components.yolink.entity.YoLinkEntity._attr_has_entity_name = True

staticprivate

Definition at line 23 of file entity.py.

config_entry

homeassistant.components.yolink.entity.YoLinkEntity.config_entry

Definition at line 32 of file entity.py.

---

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

• core/homeassistant/components/yolink/entity.py