homeassistant.components.wemo.entity.WemoEntity Class Reference

Inheritance diagram for homeassistant.components.wemo.entity.WemoEntity:

Collaboration diagram for homeassistant.components.wemo.entity.WemoEntity:

Public Member Functions
None	__init__ (self, DeviceCoordinator coordinator)
DeviceInfo	device_info (self)
str	name (self)
str|None	name_suffix (self)
str	unique_id (self)
str|None	unique_id_suffix (self)
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.wemo.coordinator.DeviceCoordinator
None	__init__ (self, HomeAssistant hass, WeMoDevice wemo)
None	async_set_options (self, HomeAssistant hass, ConfigEntry config_entry)
None	async_setup (self, str device_id)
None	async_shutdown (self)
bool	should_poll (self)
None	subscription_callback (self, WeMoDevice _device, str event_type, str params)
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_update_listeners (self)
timedelta|None	update_interval (self)
None	update_interval (self, timedelta|None value)

Public Attributes
	wemo
Public Attributes inherited from homeassistant.components.wemo.coordinator.DeviceCoordinator
	device_id
	device_info
	hass
	last_exception
	last_update_success
	options
	supports_long_press
	update_lock
	wemo
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

Static Public Attributes
	None
Static Public Attributes inherited from homeassistant.components.wemo.coordinator.DeviceCoordinator
	None

Private Member Functions
Generator[None]	_wemo_call_wrapper (self, str message)

Private Attributes
	_device_info

Detailed Description

Common methods for Wemo entities.

Definition at line 19 of file entity.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.wemo.entity.WemoEntity.__init__	(		self,
		DeviceCoordinator	coordinator
	)

Initialize the WeMo device.

Reimplemented in homeassistant.components.wemo.fan.WemoHumidifier.

Definition at line 28 of file entity.py.

Member Function Documentation

_wemo_call_wrapper()

Generator[None] homeassistant.components.wemo.entity.WemoEntity._wemo_call_wrapper (   self, str  message  )

private

Wrap calls to the device that change its state.

1. Takes care of making available=False when communications with the
   device fails.
2. Ensures all entities sharing the same coordinator are aware of
   updates to the device state.

Definition at line 68 of file entity.py.

device_info()

DeviceInfo homeassistant.components.wemo.entity.WemoEntity.device_info

(

self

)

Return the device info.

Reimplemented in homeassistant.components.wemo.light.WemoLight.

Definition at line 63 of file entity.py.

name()

str homeassistant.components.wemo.entity.WemoEntity.name

(

self

)

Return the name of the device if any.

Reimplemented in homeassistant.components.wemo.light.WemoLight.

Definition at line 40 of file entity.py.

name_suffix()

str | None homeassistant.components.wemo.entity.WemoEntity.name_suffix

(

self

)

Suffix to append to the WeMo device name.

Reimplemented in homeassistant.components.wemo.sensor.AttributeSensor.

Definition at line 35 of file entity.py.

unique_id()

str homeassistant.components.wemo.entity.WemoEntity.unique_id

(

self

)

Return the id of this WeMo device.

Reimplemented in homeassistant.components.wemo.light.WemoLight.

Definition at line 55 of file entity.py.

unique_id_suffix()

str | None homeassistant.components.wemo.entity.WemoEntity.unique_id_suffix

(

self

)

Suffix to append to the WeMo device's unique ID.

Reimplemented in homeassistant.components.wemo.sensor.AttributeSensor.

Definition at line 48 of file entity.py.

Member Data Documentation

_device_info

homeassistant.components.wemo.entity.WemoEntity._device_info

private

Definition at line 32 of file entity.py.

None

homeassistant.components.wemo.entity.WemoEntity.None

static

Definition at line 25 of file entity.py.

wemo

homeassistant.components.wemo.entity.WemoEntity.wemo

Definition at line 31 of file entity.py.

---

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

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