Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.tplink_omada.controller.OmadaSiteController Class Reference

Public Member Functions

None __init__ (self, HomeAssistant hass, OmadaSiteClient omada_client)
 
OmadaClientsCoordinator clients_coordinator (self)
 
OmadaDevicesCoordinator devices_coordinator (self)
 
OmadaGatewayCoordinator|None gateway_coordinator (self)
 
OmadaSwitchPortCoordinator get_switch_port_coordinator (self, OmadaSwitch switch)
 
None initialize_first_refresh (self)
 
OmadaSiteClient omada_client (self)
 

Static Public Attributes

 None
 

Private Attributes

 _clients_coordinator
 
 _devices_coordinator
 
 _gateway_coordinator
 
 _hass
 
 _omada_client
 

Detailed Description

Controller for the Omada SDN site.

Definition at line 16 of file controller.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.tplink_omada.controller.OmadaSiteController.__init__ (   self,
HomeAssistant  hass,
OmadaSiteClient  omada_client 
)
Create the controller.

Definition at line 21 of file controller.py.

Member Function Documentation

◆ clients_coordinator()

OmadaClientsCoordinator homeassistant.components.tplink_omada.controller.OmadaSiteController.clients_coordinator (   self)
Gets the coordinator for site's clients.

Definition at line 75 of file controller.py.

◆ devices_coordinator()

OmadaDevicesCoordinator homeassistant.components.tplink_omada.controller.OmadaSiteController.devices_coordinator (   self)
Gets the coordinator for site's devices.

Definition at line 70 of file controller.py.

◆ gateway_coordinator()

OmadaGatewayCoordinator | None homeassistant.components.tplink_omada.controller.OmadaSiteController.gateway_coordinator (   self)
Gets the coordinator for site's gateway, or None if there is no gateway.

Definition at line 65 of file controller.py.

◆ get_switch_port_coordinator()

OmadaSwitchPortCoordinator homeassistant.components.tplink_omada.controller.OmadaSiteController.get_switch_port_coordinator (   self,
OmadaSwitch   switch 
)
Get coordinator for network port information of a given switch.

Definition at line 53 of file controller.py.

◆ initialize_first_refresh()

None homeassistant.components.tplink_omada.controller.OmadaSiteController.initialize_first_refresh (   self)
Initialize the all coordinators, and perform first refresh.

Definition at line 34 of file controller.py.

◆ omada_client()

OmadaSiteClient homeassistant.components.tplink_omada.controller.OmadaSiteController.omada_client (   self)
Get the connected client API for the site to manage.

Definition at line 49 of file controller.py.

Member Data Documentation

◆ _clients_coordinator

homeassistant.components.tplink_omada.controller.OmadaSiteController._clients_coordinator
private

Definition at line 32 of file controller.py.

◆ _devices_coordinator

homeassistant.components.tplink_omada.controller.OmadaSiteController._devices_coordinator
private

Definition at line 31 of file controller.py.

◆ _gateway_coordinator

homeassistant.components.tplink_omada.controller.OmadaSiteController._gateway_coordinator
private

Definition at line 41 of file controller.py.

◆ _hass

homeassistant.components.tplink_omada.controller.OmadaSiteController._hass
private

Definition at line 27 of file controller.py.

◆ _omada_client

homeassistant.components.tplink_omada.controller.OmadaSiteController._omada_client
private

Definition at line 28 of file controller.py.

◆ None

homeassistant.components.tplink_omada.controller.OmadaSiteController.None
static

Definition at line 19 of file controller.py.


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