homeassistant.components.tradfri.entity.TradfriBaseEntity Class Reference

Inheritance diagram for homeassistant.components.tradfri.entity.TradfriBaseEntity:

Collaboration diagram for homeassistant.components.tradfri.entity.TradfriBaseEntity:

Public Member Functions
None	__init__ (self, TradfriDeviceDataUpdateCoordinator device_coordinator, str gateway_id, Callable[[Command|list[Command]], Any] api)
bool	available (self)
Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None	__init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
None	async_update (self)
Public Member Functions inherited from homeassistant.components.tradfri.coordinator.TradfriDeviceDataUpdateCoordinator
None	__init__ (self, HomeAssistant hass, *Callable[[Command|list[Command]], Any] api, Device device)
None	set_hub_available (self, bool available)
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 Member Functions
None	_handle_coordinator_update (self)
None	_refresh (self)

Private Attributes
	_api
	_attr_device_info
	_attr_unique_id
	_device_id
	_gateway_id

Static Private Attributes
bool	_attr_has_entity_name = True

Additional Inherited Members
Public Attributes inherited from homeassistant.components.tradfri.coordinator.TradfriDeviceDataUpdateCoordinator
	api
	device
	last_update_success
	update_interval
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

Base Tradfri device.

Definition at line 38 of file entity.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.tradfri.entity.TradfriBaseEntity.__init__	(		self,
		TradfriDeviceDataUpdateCoordinator	device_coordinator,
		str	gateway_id,
		Callable[[Command | list[Command]], Any]	api
	)

Initialize a device.

Definition at line 43 of file entity.py.

Member Function Documentation

_handle_coordinator_update()

None homeassistant.components.tradfri.entity.TradfriBaseEntity._handle_coordinator_update (   self )

private

Handle updated data from the coordinator.

Tests fails without this method.

Definition at line 76 of file entity.py.

_refresh()

None homeassistant.components.tradfri.entity.TradfriBaseEntity._refresh (   self )

private

Refresh device data.

Reimplemented in homeassistant.components.tradfri.switch.TradfriSwitch, homeassistant.components.tradfri.sensor.TradfriSensor, homeassistant.components.tradfri.light.TradfriLight, homeassistant.components.tradfri.fan.TradfriAirPurifierFan, and homeassistant.components.tradfri.cover.TradfriCover.

Definition at line 72 of file entity.py.

available()

bool homeassistant.components.tradfri.entity.TradfriBaseEntity.available

(

self

)

Return if entity is available.

Reimplemented from homeassistant.helpers.update_coordinator.CoordinatorEntity.

Definition at line 85 of file entity.py.

Member Data Documentation

_api

homeassistant.components.tradfri.entity.TradfriBaseEntity._api

private

Definition at line 57 of file entity.py.

_attr_device_info

homeassistant.components.tradfri.entity.TradfriBaseEntity._attr_device_info

private

Definition at line 60 of file entity.py.

_attr_has_entity_name

bool homeassistant.components.tradfri.entity.TradfriBaseEntity._attr_has_entity_name = True

staticprivate

Definition at line 41 of file entity.py.

_attr_unique_id

homeassistant.components.tradfri.entity.TradfriBaseEntity._attr_unique_id

private

Definition at line 68 of file entity.py.

_device_id

homeassistant.components.tradfri.entity.TradfriBaseEntity._device_id

private

Definition at line 56 of file entity.py.

_gateway_id

homeassistant.components.tradfri.entity.TradfriBaseEntity._gateway_id

private

Definition at line 52 of file entity.py.

---

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

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