Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.asuswrt.router.AsusWrtRouter Class Reference

Public Member Functions

None __init__ (self, HomeAssistant hass, ConfigEntry entry)
 
None async_on_close (self, CALLBACK_TYPE func)
 
None close (self)
 
DeviceInfo device_info (self)
 
dict[str, AsusWrtDevInfodevices (self)
 
str host (self)
 
None init_sensors_coordinator (self)
 
dict[str, Any] sensors_coordinator (self)
 
None setup (self)
 
str signal_device_new (self)
 
str signal_device_update (self)
 
str unique_id (self)
 
None update_all (self, datetime|None now=None)
 
None update_devices (self)
 
bool update_options (self, MappingProxyType[str, Any] new_options)
 

Public Attributes

 hass
 

Private Member Functions

None _migrate_entities_unique_id (self)
 
None _update_unpolled_sensors (self)
 

Private Attributes

 _connect_error
 
 _connected_devices
 
 _entry
 
 _sensors_data_handler
 

Detailed Description

Representation of a AsusWrt router.

Definition at line 156 of file router.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.asuswrt.router.AsusWrtRouter.__init__ (   self,
HomeAssistant  hass,
ConfigEntry  entry 
)
Initialize a AsusWrt router.

Definition at line 159 of file router.py.

Member Function Documentation

◆ _migrate_entities_unique_id()

None homeassistant.components.asuswrt.router.AsusWrtRouter._migrate_entities_unique_id (   self)
private
Migrate router entities to new unique id format.

Definition at line 184 of file router.py.

◆ _update_unpolled_sensors()

None homeassistant.components.asuswrt.router.AsusWrtRouter._update_unpolled_sensors (   self)
private
Request refresh for AsusWrt unpolled sensors.

Definition at line 342 of file router.py.

◆ async_on_close()

None homeassistant.components.asuswrt.router.AsusWrtRouter.async_on_close (   self,
CALLBACK_TYPE  func 
)
Add a function to call when router is closed.

Definition at line 362 of file router.py.

◆ close()

None homeassistant.components.asuswrt.router.AsusWrtRouter.close (   self)
Close the connection.

Definition at line 352 of file router.py.

◆ device_info()

DeviceInfo homeassistant.components.asuswrt.router.AsusWrtRouter.device_info (   self)
Return the device information.

Definition at line 380 of file router.py.

◆ devices()

dict[str, AsusWrtDevInfo] homeassistant.components.asuswrt.router.AsusWrtRouter.devices (   self)
Return devices.

Definition at line 415 of file router.py.

◆ host()

str homeassistant.components.asuswrt.router.AsusWrtRouter.host (   self)
Return router hostname.

Definition at line 405 of file router.py.

◆ init_sensors_coordinator()

None homeassistant.components.asuswrt.router.AsusWrtRouter.init_sensors_coordinator (   self)
Init AsusWrt sensors coordinators.

Definition at line 320 of file router.py.

◆ sensors_coordinator()

dict[str, Any] homeassistant.components.asuswrt.router.AsusWrtRouter.sensors_coordinator (   self)
Return sensors coordinators.

Definition at line 420 of file router.py.

◆ setup()

None homeassistant.components.asuswrt.router.AsusWrtRouter.setup (   self)
Set up a AsusWrt router.

Definition at line 222 of file router.py.

◆ signal_device_new()

str homeassistant.components.asuswrt.router.AsusWrtRouter.signal_device_new (   self)
Event specific per AsusWrt entry to signal new device.

Definition at line 395 of file router.py.

◆ signal_device_update()

str homeassistant.components.asuswrt.router.AsusWrtRouter.signal_device_update (   self)
Event specific per AsusWrt entry to signal updates in devices.

Definition at line 400 of file router.py.

◆ unique_id()

str homeassistant.components.asuswrt.router.AsusWrtRouter.unique_id (   self)
Return router unique id.

Definition at line 410 of file router.py.

◆ update_all()

None homeassistant.components.asuswrt.router.AsusWrtRouter.update_all (   self,
datetime | None   now = None 
)
Update all AsusWrt platforms.

Definition at line 271 of file router.py.

◆ update_devices()

None homeassistant.components.asuswrt.router.AsusWrtRouter.update_devices (   self)
Update AsusWrt devices tracker.

Definition at line 275 of file router.py.

◆ update_options()

bool homeassistant.components.asuswrt.router.AsusWrtRouter.update_options (   self,
MappingProxyType[str, Any]  new_options 
)
Update router options.

Definition at line 366 of file router.py.

Member Data Documentation

◆ _connect_error

homeassistant.components.asuswrt.router.AsusWrtRouter._connect_error
private

Definition at line 283 of file router.py.

◆ _connected_devices

homeassistant.components.asuswrt.router.AsusWrtRouter._connected_devices
private

Definition at line 295 of file router.py.

◆ _entry

homeassistant.components.asuswrt.router.AsusWrtRouter._entry
private

Definition at line 162 of file router.py.

◆ _sensors_data_handler

homeassistant.components.asuswrt.router.AsusWrtRouter._sensors_data_handler
private

Definition at line 325 of file router.py.

◆ hass

homeassistant.components.asuswrt.router.AsusWrtRouter.hass

Definition at line 161 of file router.py.


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