homeassistant.components.tplink_omada.device_tracker.OmadaClientScannerEntity Class Reference

Inheritance diagram for homeassistant.components.tplink_omada.device_tracker.OmadaClientScannerEntity:

Collaboration diagram for homeassistant.components.tplink_omada.device_tracker.OmadaClientScannerEntity:

Public Member Functions
None	__init__ (self, str site_id, str client_id, str display_name, OmadaClientsCoordinator coordinator)
None	async_added_to_hass (self)
str|None	hostname (self)
str|None	ip_address (self)
bool	is_connected (self)
str|None	mac_address (self)
str|None	unique_id (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.tplink_omada.coordinator.OmadaClientsCoordinator
None	__init__ (self, HomeAssistant hass, OmadaSiteClient omada_client)
dict[str, OmadaWirelessClient]	poll_update (self)
Public Member Functions inherited from homeassistant.components.tplink_omada.coordinator.OmadaCoordinator
None	__init__ (self, HomeAssistant hass, OmadaSiteClient omada_client, str name, int|None poll_delay=300)
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_shutdown (self)
None	async_update_listeners (self)
timedelta|None	update_interval (self)
None	update_interval (self, timedelta|None value)

Static Public Attributes
	None

Private Member Functions
None	_do_update (self)
None	_handle_coordinator_update (self)

Private Attributes
	_attr_name
	_client_details
	_client_id
	_site_id

Additional Inherited Members
Public Attributes inherited from homeassistant.components.tplink_omada.coordinator.OmadaCoordinator
	omada_client
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

Detailed Description

Entity for a client connected to the Omada network.

Definition at line 43 of file device_tracker.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.tplink_omada.device_tracker.OmadaClientScannerEntity.__init__	(		self,
		str	site_id,
		str	client_id,
		str	display_name,
		OmadaClientsCoordinator	coordinator
	)

Initialize the scanner.

Definition at line 50 of file device_tracker.py.

Member Function Documentation

_do_update()

None homeassistant.components.tplink_omada.device_tracker.OmadaClientScannerEntity._do_update (   self )

private

Definition at line 63 of file device_tracker.py.

_handle_coordinator_update()

None homeassistant.components.tplink_omada.device_tracker.OmadaClientScannerEntity._handle_coordinator_update (   self )

private

Handle updated data from the coordinator.

Definition at line 72 of file device_tracker.py.

async_added_to_hass()

None homeassistant.components.tplink_omada.device_tracker.OmadaClientScannerEntity.async_added_to_hass

(

self

)

When entity is added to hass.

Definition at line 66 of file device_tracker.py.

hostname()

str | None homeassistant.components.tplink_omada.device_tracker.OmadaClientScannerEntity.hostname

(

self

)

Return hostname of the device.

Definition at line 88 of file device_tracker.py.

ip_address()

str | None homeassistant.components.tplink_omada.device_tracker.OmadaClientScannerEntity.ip_address

(

self

)

Return the primary ip address of the device.

Definition at line 78 of file device_tracker.py.

is_connected()

bool homeassistant.components.tplink_omada.device_tracker.OmadaClientScannerEntity.is_connected

(

self

)

Return true if the device is connected to the network.

Definition at line 93 of file device_tracker.py.

mac_address()

str | None homeassistant.components.tplink_omada.device_tracker.OmadaClientScannerEntity.mac_address

(

self

)

Return the mac address of the device.

Definition at line 83 of file device_tracker.py.

unique_id()

str | None homeassistant.components.tplink_omada.device_tracker.OmadaClientScannerEntity.unique_id

(

self

)

Return the unique id of the device.

Definition at line 98 of file device_tracker.py.

Member Data Documentation

_attr_name

homeassistant.components.tplink_omada.device_tracker.OmadaClientScannerEntity._attr_name

private

Definition at line 61 of file device_tracker.py.

_client_details

homeassistant.components.tplink_omada.device_tracker.OmadaClientScannerEntity._client_details

private

Definition at line 64 of file device_tracker.py.

_client_id

homeassistant.components.tplink_omada.device_tracker.OmadaClientScannerEntity._client_id

private

Definition at line 60 of file device_tracker.py.

_site_id

homeassistant.components.tplink_omada.device_tracker.OmadaClientScannerEntity._site_id

private

Definition at line 59 of file device_tracker.py.

None

homeassistant.components.tplink_omada.device_tracker.OmadaClientScannerEntity.None

static

Definition at line 48 of file device_tracker.py.

---

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

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