homeassistant.components.device_tracker.config_entry.ScannerEntity Class Reference

Inheritance diagram for homeassistant.components.device_tracker.config_entry.ScannerEntity:

Collaboration diagram for homeassistant.components.device_tracker.config_entry.ScannerEntity:

Public Member Functions
None	add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
None	async_internal_added_to_hass (self)
DeviceInfo|None	device_info (self)
bool	entity_registry_enabled_default (self)
dr.DeviceEntry|None	find_device_entry (self)
str|None	hostname (self)
str|None	ip_address (self)
bool	is_connected (self)
str|None	mac_address (self)
str	state (self)
dict[str, StateType]	state_attributes (self)
str|None	unique_id (self)
Public Member Functions inherited from homeassistant.components.device_tracker.config_entry.BaseTrackerEntity
int|None	battery_level (self)
SourceType	source_type (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)
bool	assumed_state (self)
None	async_added_to_hass (self)
None	async_device_update (self, bool warning=True)
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)
bool	enabled (self)
EntityCategory|None	entity_category (self)
str|None	entity_picture (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)
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)

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

Static Public Attributes
	None
	SourceType
Static Public Attributes inherited from homeassistant.components.device_tracker.config_entry.BaseTrackerEntity
	None
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Detailed Description

Base class for a tracked device that is on a scanned network.

Definition at line 305 of file config_entry.py.

Member Function Documentation

add_to_platform_start()

None homeassistant.components.device_tracker.config_entry.ScannerEntity.add_to_platform_start	(		self,
		HomeAssistant	hass,
		EntityPlatform	platform,
		asyncio.Semaphore | None	parallel_updates
	)

Start adding an entity to a platform.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 367 of file config_entry.py.

async_internal_added_to_hass()

None homeassistant.components.device_tracker.config_entry.ScannerEntity.async_internal_added_to_hass

(

self

)

Handle added to Home Assistant.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 399 of file config_entry.py.

device_info()

DeviceInfo | None homeassistant.components.device_tracker.config_entry.ScannerEntity.device_info

(

self

)

Device tracker entities should not create device registry entries.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 350 of file config_entry.py.

entity_registry_enabled_default()

bool homeassistant.components.device_tracker.config_entry.ScannerEntity.entity_registry_enabled_default

(

self

)

Return if entity is enabled by default.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 355 of file config_entry.py.

find_device_entry()

dr.DeviceEntry | None homeassistant.components.device_tracker.config_entry.ScannerEntity.find_device_entry

(

self

)

Return device entry.

Definition at line 391 of file config_entry.py.

hostname()

str | None homeassistant.components.device_tracker.config_entry.ScannerEntity.hostname

(

self

)

Return hostname of the device.

Definition at line 327 of file config_entry.py.

ip_address()

str | None homeassistant.components.device_tracker.config_entry.ScannerEntity.ip_address

(

self

)

Return the primary ip address of the device.

Definition at line 317 of file config_entry.py.

is_connected()

bool homeassistant.components.device_tracker.config_entry.ScannerEntity.is_connected

(

self

)

Return true if the device is connected to the network.

Definition at line 339 of file config_entry.py.

mac_address()

str | None homeassistant.components.device_tracker.config_entry.ScannerEntity.mac_address

(

self

)

Return the mac address of the device.

Definition at line 322 of file config_entry.py.

state()

str homeassistant.components.device_tracker.config_entry.ScannerEntity.state

(

self

)

Return the state of the device.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 332 of file config_entry.py.

state_attributes()

dict[str, StateType] homeassistant.components.device_tracker.config_entry.ScannerEntity.state_attributes

(

self

)

Return the device state attributes.

Reimplemented from homeassistant.components.device_tracker.config_entry.BaseTrackerEntity.

Definition at line 434 of file config_entry.py.

unique_id()

str | None homeassistant.components.device_tracker.config_entry.ScannerEntity.unique_id

(

self

)

Return unique ID of the entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 344 of file config_entry.py.

Member Data Documentation

None

homeassistant.components.device_tracker.config_entry.ScannerEntity.None

static

Definition at line 311 of file config_entry.py.

registry_entry

homeassistant.components.device_tracker.config_entry.ScannerEntity.registry_entry

Definition at line 418 of file config_entry.py.

SourceType

homeassistant.components.device_tracker.config_entry.ScannerEntity.SourceType

static

Definition at line 314 of file config_entry.py.

---

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

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