homeassistant.components.wiffi.entity.WiffiEntity Class Reference

Inheritance diagram for homeassistant.components.wiffi.entity.WiffiEntity:

Collaboration diagram for homeassistant.components.wiffi.entity.WiffiEntity:

Public Member Functions
def	__init__ (self, device, metric, options)
def	async_added_to_hass (self)
def	reset_expiration_date (self)
Public Member Functions inherited from homeassistant.helpers.entity.Entity
None	__init_subclass__ (cls, **Any kwargs)
str	__repr__ (self)
None	add_to_platform_abort (self)
None	add_to_platform_finish (self)
None	add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
bool	assumed_state (self)
None	async_device_update (self, bool warning=True)
None	async_internal_added_to_hass (self)
None	async_internal_will_remove_from_hass (self)
None	async_on_remove (self, CALLBACK_TYPE func)
None	async_registry_entry_updated (self)
None	async_remove (self, *bool force_remove=False)
None	async_removed_from_registry (self)
None	async_schedule_update_ha_state (self, bool force_refresh=False)
None	async_set_context (self, Context context)
None	async_update_ha_state (self, bool force_refresh=False)
None	async_will_remove_from_hass (self)
None	async_write_ha_state (self)
str|None	attribution (self)
bool	available (self)
dict[str, Any]|None	capability_attributes (self)
str|None	device_class (self)
DeviceInfo|None	device_info (self)
bool	enabled (self)
EntityCategory|None	entity_category (self)
str|None	entity_picture (self)
bool	entity_registry_enabled_default (self)
bool	entity_registry_visible_default (self)
Mapping[str, Any]|None	extra_state_attributes (self)
bool	force_update (self)
HassJobType	get_hassjob_type (self, str function_name)
er.EntityOptionsType|None	get_initial_entity_options (self)
bool	has_entity_name (self)
str|None	icon (self)
str|UndefinedType|None	name (self)
None	schedule_update_ha_state (self, bool force_refresh=False)
bool	should_poll (self)
StateType	state (self)
dict[str, Any]|None	state_attributes (self)
str|None	suggested_object_id (self)
int|None	supported_features (self)
str|None	translation_key (self)
Mapping[str, str]	translation_placeholders (self)
str|None	unique_id (self)
str|None	unit_of_measurement (self)
bool	use_device_name (self)
Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None	__init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
Any	__new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)

Private Member Functions
def	_check_expiration_date (self)
def	_is_measurement_entity (self)
def	_is_metered_entity (self)
def	_update_value_callback (self, device, metric)

Private Attributes
	_attr_device_info
	_attr_name
	_attr_unique_id
	_expiration_date
	_id
	_timeout
	_value

Static Private Attributes
bool	_attr_should_poll = False

Additional Inherited Members
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Detailed Description

Common functionality for all wiffi entities.

Definition at line 21 of file entity.py.

Constructor & Destructor Documentation

__init__()

def homeassistant.components.wiffi.entity.WiffiEntity.__init__	(		self,
			device,
			metric,
			options
	)

Initialize the base elements of a wiffi entity.

Reimplemented in homeassistant.components.wiffi.sensor.StringEntity, homeassistant.components.wiffi.sensor.NumberEntity, and homeassistant.components.wiffi.binary_sensor.BoolEntity.

Definition at line 26 of file entity.py.

Member Function Documentation

_check_expiration_date()

def homeassistant.components.wiffi.entity.WiffiEntity._check_expiration_date (   self )

private

Periodically check if entity value has been updated.

If there are no more updates from the wiffi device, the value will be
set to unavailable.

Definition at line 71 of file entity.py.

_is_measurement_entity()

def homeassistant.components.wiffi.entity.WiffiEntity._is_measurement_entity (   self )

private

Measurement entities have a value in present time.

Definition at line 85 of file entity.py.

_is_metered_entity()

def homeassistant.components.wiffi.entity.WiffiEntity._is_metered_entity (   self )

private

Metered entities have a value that keeps increasing until reset.

Definition at line 91 of file entity.py.

_update_value_callback()

def homeassistant.components.wiffi.entity.WiffiEntity._update_value_callback (   self,   device,   metric  )

private

Update the value of the entity.

Reimplemented in homeassistant.components.wiffi.sensor.StringEntity, homeassistant.components.wiffi.sensor.NumberEntity, and homeassistant.components.wiffi.binary_sensor.BoolEntity.

Definition at line 67 of file entity.py.

async_added_to_hass()

def homeassistant.components.wiffi.entity.WiffiEntity.async_added_to_hass

(

self

)

Entity has been added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 44 of file entity.py.

reset_expiration_date()

def homeassistant.components.wiffi.entity.WiffiEntity.reset_expiration_date

(

self

)

Reset value expiration date.

Will be called by derived classes after a value update has been received.

Definition at line 59 of file entity.py.

Member Data Documentation

_attr_device_info

homeassistant.components.wiffi.entity.WiffiEntity._attr_device_info

private

Definition at line 30 of file entity.py.

_attr_name

homeassistant.components.wiffi.entity.WiffiEntity._attr_name

private

Definition at line 39 of file entity.py.

_attr_should_poll

bool homeassistant.components.wiffi.entity.WiffiEntity._attr_should_poll = False

staticprivate

Definition at line 24 of file entity.py.

_attr_unique_id

homeassistant.components.wiffi.entity.WiffiEntity._attr_unique_id

private

Definition at line 29 of file entity.py.

_expiration_date

homeassistant.components.wiffi.entity.WiffiEntity._expiration_date

private

Definition at line 40 of file entity.py.

_id

homeassistant.components.wiffi.entity.WiffiEntity._id

private

Definition at line 28 of file entity.py.

_timeout

homeassistant.components.wiffi.entity.WiffiEntity._timeout

private

Definition at line 42 of file entity.py.

_value

homeassistant.components.wiffi.entity.WiffiEntity._value

private

Definition at line 41 of file entity.py.

---

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

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