homeassistant.components.unifi.entity.UnifiEntity Class Reference

Inheritance diagram for homeassistant.components.unifi.entity.UnifiEntity:

Collaboration diagram for homeassistant.components.unifi.entity.UnifiEntity:

Public Member Functions
None	__init__ (self, str obj_id, UnifiHub hub, UnifiEntityDescription[HandlerT, ApiItemT] description)
None	async_added_to_hass (self)
None	async_event_callback (self, Event event)
None	async_initiate_state (self)
None	async_signal_options_updated (self)
None	async_signal_reachable_callback (self)
None	async_signalling_callback (self, ItemEvent event, str obj_id)
None	async_update (self)
None	async_update_state (self, ItemEvent event, str obj_id)
None	remove_item (self, set keys)
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)

Public Attributes
	api
	entity_description
	hub
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry

Private Attributes
	_attr_available
	_attr_device_info
	_attr_name
	_attr_should_poll
	_attr_unique_id
	_obj_id
	_removed

Additional Inherited Members
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Detailed Description

Representation of a UniFi entity.

Definition at line 131 of file entity.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.unifi.entity.UnifiEntity.__init__	(		self,
		str	obj_id,
		UnifiHub	hub,
		UnifiEntityDescription[HandlerT, ApiItemT]	description
	)

Set up UniFi switch entity.

Definition at line 137 of file entity.py.

Member Function Documentation

async_added_to_hass()

None homeassistant.components.unifi.entity.UnifiEntity.async_added_to_hass

(

self

)

Register callbacks.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.unifi.switch.UnifiSwitchEntity, homeassistant.components.unifi.sensor.UnifiSensorEntity, and homeassistant.components.unifi.device_tracker.UnifiScannerEntity.

Definition at line 162 of file entity.py.

async_event_callback()

None homeassistant.components.unifi.entity.UnifiEntity.async_event_callback	(		self,
		Event	event
	)

Update entity state based on subscribed event.

Perform additional action updating platform entity child class state.

Reimplemented in homeassistant.components.unifi.switch.UnifiSwitchEntity.

Definition at line 269 of file entity.py.

async_initiate_state()

None homeassistant.components.unifi.entity.UnifiEntity.async_initiate_state

(

self

)

Initiate entity state.

Perform additional actions setting up platform entity child class state.
Defaults to using async_update_state to set initial state.

Reimplemented in homeassistant.components.unifi.update.UnifiDeviceUpdateEntity, homeassistant.components.unifi.switch.UnifiSwitchEntity, and homeassistant.components.unifi.device_tracker.UnifiScannerEntity.

Definition at line 252 of file entity.py.

async_signal_options_updated()

None homeassistant.components.unifi.entity.UnifiEntity.async_signal_options_updated

(

self

)

Config entry options are updated, remove entity if option is disabled.

Definition at line 232 of file entity.py.

async_signal_reachable_callback()

None homeassistant.components.unifi.entity.UnifiEntity.async_signal_reachable_callback

(

self

)

Call when hub connection state change.

Definition at line 228 of file entity.py.

async_signalling_callback()

None homeassistant.components.unifi.entity.UnifiEntity.async_signalling_callback	(		self,
		ItemEvent	event,
		str	obj_id
	)

Update the entity state.

Definition at line 212 of file entity.py.

async_update()

None homeassistant.components.unifi.entity.UnifiEntity.async_update

(

self

)

Update state if polling is configured.

Definition at line 247 of file entity.py.

async_update_state()

None homeassistant.components.unifi.entity.UnifiEntity.async_update_state	(		self,
		ItemEvent	event,
		str	obj_id
	)

Update entity state.

Perform additional actions updating platform entity child class state.

Reimplemented in homeassistant.components.unifi.update.UnifiDeviceUpdateEntity, homeassistant.components.unifi.sensor.UnifiSensorEntity, homeassistant.components.unifi.image.UnifiImageEntity, and homeassistant.components.unifi.device_tracker.UnifiScannerEntity.

Definition at line 262 of file entity.py.

remove_item()

None homeassistant.components.unifi.entity.UnifiEntity.remove_item	(		self,
		set	keys
	)

Remove entity if object ID is part of set.

Definition at line 237 of file entity.py.

Member Data Documentation

_attr_available

homeassistant.components.unifi.entity.UnifiEntity._attr_available

private

Definition at line 153 of file entity.py.

_attr_device_info

homeassistant.components.unifi.entity.UnifiEntity._attr_device_info

private

Definition at line 154 of file entity.py.

_attr_name

homeassistant.components.unifi.entity.UnifiEntity._attr_name

private

Definition at line 159 of file entity.py.

_attr_should_poll

homeassistant.components.unifi.entity.UnifiEntity._attr_should_poll

private

Definition at line 155 of file entity.py.

_attr_unique_id

homeassistant.components.unifi.entity.UnifiEntity._attr_unique_id

private

Definition at line 156 of file entity.py.

_obj_id

homeassistant.components.unifi.entity.UnifiEntity._obj_id

private

Definition at line 144 of file entity.py.

_removed

homeassistant.components.unifi.entity.UnifiEntity._removed

private

Definition at line 151 of file entity.py.

api

homeassistant.components.unifi.entity.UnifiEntity.api

Definition at line 146 of file entity.py.

entity_description

homeassistant.components.unifi.entity.UnifiEntity.entity_description

Definition at line 147 of file entity.py.

hub

homeassistant.components.unifi.entity.UnifiEntity.hub

Definition at line 145 of file entity.py.

---

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

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