homeassistant.components.unifi.device_tracker.UnifiScannerEntity Class Reference

Inheritance diagram for homeassistant.components.unifi.device_tracker.UnifiScannerEntity:

Collaboration diagram for homeassistant.components.unifi.device_tracker.UnifiScannerEntity:

Public Member Functions
None	async_added_to_hass (self)
None	async_event_callback (self, Event event)
None	async_initiate_state (self)
None	async_update_state (self, ItemEvent event, str obj_id)
None	async_will_remove_from_hass (self)
Mapping[str, Any]|None	extra_state_attributes (self)
str|None	hostname (self)
str|None	ip_address (self)
bool	is_connected (self)
str	mac_address (self)
str	unique_id (self)
Public Member Functions inherited from homeassistant.components.unifi.entity.UnifiEntity
None	__init__ (self, str obj_id, UnifiHub hub, UnifiEntityDescription[HandlerT, ApiItemT] description)
None	async_event_callback (self, Event event)
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	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_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)
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	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
None	_make_disconnected (self, *core_Event _)

Private Attributes
	_event_is_on
	_ignore_events
	_is_connected

Additional Inherited Members
Public Attributes inherited from homeassistant.components.unifi.entity.UnifiEntity
	api
	entity_description
	hub
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

Representation of a UniFi scanner.

Definition at line 234 of file device_tracker.py.

Member Function Documentation

_make_disconnected()

None homeassistant.components.unifi.device_tracker.UnifiScannerEntity._make_disconnected (   self, *core_Event  _  )

private

No heart beat by device.

Definition at line 286 of file device_tracker.py.

async_added_to_hass()

None homeassistant.components.unifi.device_tracker.UnifiScannerEntity.async_added_to_hass

(

self

)

Register callbacks.

Reimplemented from homeassistant.components.unifi.entity.UnifiEntity.

Definition at line 342 of file device_tracker.py.

async_event_callback()

None homeassistant.components.unifi.device_tracker.UnifiScannerEntity.async_event_callback	(		self,
		Event	event
	)

Event subscription callback.

Definition at line 323 of file device_tracker.py.

async_initiate_state()

None homeassistant.components.unifi.device_tracker.UnifiScannerEntity.async_initiate_state

(

self

)

Initiate entity state.

Initiate is_connected.

Reimplemented from homeassistant.components.unifi.entity.UnifiEntity.

Definition at line 244 of file device_tracker.py.

async_update_state()

None homeassistant.components.unifi.device_tracker.UnifiScannerEntity.async_update_state	(		self,
		ItemEvent	event,
		str	obj_id
	)

Update entity state.

Remove heartbeat check if hub connection state has changed
 and entity is unavailable.
Update is_connected.
Schedule new heartbeat check if connected.

Reimplemented from homeassistant.components.unifi.entity.UnifiEntity.

Definition at line 292 of file device_tracker.py.

async_will_remove_from_hass()

None homeassistant.components.unifi.device_tracker.UnifiScannerEntity.async_will_remove_from_hass

(

self

)

Disconnect object when removed.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 353 of file device_tracker.py.

extra_state_attributes()

Mapping[str, Any] | None homeassistant.components.unifi.device_tracker.UnifiScannerEntity.extra_state_attributes

(

self

)

Return the client state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 359 of file device_tracker.py.

hostname()

str | None homeassistant.components.unifi.device_tracker.UnifiScannerEntity.hostname

(

self

)

Return hostname of the device.

Definition at line 266 of file device_tracker.py.

ip_address()

str | None homeassistant.components.unifi.device_tracker.UnifiScannerEntity.ip_address

(

self

)

Return the primary ip address of the device.

Definition at line 271 of file device_tracker.py.

is_connected()

bool homeassistant.components.unifi.device_tracker.UnifiScannerEntity.is_connected

(

self

)

Return true if the device is connected to the network.

Definition at line 261 of file device_tracker.py.

mac_address()

str homeassistant.components.unifi.device_tracker.UnifiScannerEntity.mac_address

(

self

)

Return the mac address of the device.

Definition at line 276 of file device_tracker.py.

unique_id()

str homeassistant.components.unifi.device_tracker.UnifiScannerEntity.unique_id

(

self

)

Return a unique ID.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 281 of file device_tracker.py.

Member Data Documentation

_event_is_on

homeassistant.components.unifi.device_tracker.UnifiScannerEntity._event_is_on

private

Definition at line 250 of file device_tracker.py.

_ignore_events

homeassistant.components.unifi.device_tracker.UnifiScannerEntity._ignore_events

private

Definition at line 251 of file device_tracker.py.

_is_connected

homeassistant.components.unifi.device_tracker.UnifiScannerEntity._is_connected

private

Definition at line 252 of file device_tracker.py.

---

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

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