Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.unifi.UnifiWirelessClients Class Reference

Public Member Functions

bool __contains__ (self, int|str obj_id)
 
None __init__ (self, HomeAssistant hass)
 
None async_load (self)
 
bool is_wireless (self, Client client)
 
None update_clients (self, set[Client] clients)
 

Public Attributes

 data
 
 hass
 

Private Member Functions

dict[str, dict[str, list[str]]|list[str]] _data_to_save (self)
 

Detailed Description

Class to store clients known to be wireless.

This is needed since wireless devices going offline
might get marked as wired by UniFi.

Definition at line 85 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.unifi.UnifiWirelessClients.__init__ (   self,
HomeAssistant  hass 
)
Set up client storage.

Definition at line 92 of file __init__.py.

Member Function Documentation

◆ __contains__()

bool homeassistant.components.unifi.UnifiWirelessClients.__contains__ (   self,
int | str  obj_id 
)
Validate membership of item ID.

Definition at line 137 of file __init__.py.

◆ _data_to_save()

dict[str, dict[str, list[str]] | list[str]] homeassistant.components.unifi.UnifiWirelessClients._data_to_save (   self)
private
Return data of UniFi wireless clients to store in a file.

Definition at line 132 of file __init__.py.

◆ async_load()

None homeassistant.components.unifi.UnifiWirelessClients.async_load (   self)
Load data from file.

Definition at line 99 of file __init__.py.

◆ is_wireless()

bool homeassistant.components.unifi.UnifiWirelessClients.is_wireless (   self,
Client  client 
)
Is client known to be wireless.

Store if client is wireless and not known.

Definition at line 112 of file __init__.py.

◆ update_clients()

None homeassistant.components.unifi.UnifiWirelessClients.update_clients (   self,
set[Client]  clients 
)
Update data and schedule to save to file.

Definition at line 124 of file __init__.py.

Member Data Documentation

◆ data

homeassistant.components.unifi.UnifiWirelessClients.data

Definition at line 102 of file __init__.py.

◆ hass

homeassistant.components.unifi.UnifiWirelessClients.hass

Definition at line 94 of file __init__.py.


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