Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.unifi.hub.websocket.UnifiWebsocket Class Reference

Public Member Functions

None __init__ (self, HomeAssistant hass, aiounifi.Controller api, str signal)
 
None reconnect (self, bool log=False)
 
None start (self)
 
None start_websocket (self)
 
None stop (self)
 
None stop_and_wait (self)
 

Public Attributes

 api
 
 available
 
 hass
 
 signal
 
 ws_task
 

Private Member Functions

None _async_watch_websocket (self, datetime now)
 

Private Attributes

 _cancel_websocket_check
 

Detailed Description

Manages a single UniFi Network instance.

Definition at line 21 of file websocket.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.unifi.hub.websocket.UnifiWebsocket.__init__ (   self,
HomeAssistant  hass,
aiounifi.Controller  api,
str   signal 
)
Initialize the system.

Definition at line 24 of file websocket.py.

Member Function Documentation

◆ _async_watch_websocket()

None homeassistant.components.unifi.hub.websocket.UnifiWebsocket._async_watch_websocket (   self,
datetime  now 
)
private
Watch timestamp for last received websocket message.

Definition at line 124 of file websocket.py.

◆ reconnect()

None homeassistant.components.unifi.hub.websocket.UnifiWebsocket.reconnect (   self,
bool   log = False 
)
Prepare to reconnect UniFi session.

Definition at line 97 of file websocket.py.

◆ start()

None homeassistant.components.unifi.hub.websocket.UnifiWebsocket.start (   self)
Start websocket handler.

Definition at line 38 of file websocket.py.

◆ start_websocket()

None homeassistant.components.unifi.hub.websocket.UnifiWebsocket.start_websocket (   self)
Start up connection to websocket.

Definition at line 74 of file websocket.py.

◆ stop()

None homeassistant.components.unifi.hub.websocket.UnifiWebsocket.stop (   self)
Stop websocket handler.

Definition at line 46 of file websocket.py.

◆ stop_and_wait()

None homeassistant.components.unifi.hub.websocket.UnifiWebsocket.stop_and_wait (   self)
Stop websocket handler and await tasks.

Definition at line 55 of file websocket.py.

Member Data Documentation

◆ _cancel_websocket_check

homeassistant.components.unifi.hub.websocket.UnifiWebsocket._cancel_websocket_check
private

Definition at line 40 of file websocket.py.

◆ api

homeassistant.components.unifi.hub.websocket.UnifiWebsocket.api

Definition at line 29 of file websocket.py.

◆ available

homeassistant.components.unifi.hub.websocket.UnifiWebsocket.available

Definition at line 35 of file websocket.py.

◆ hass

homeassistant.components.unifi.hub.websocket.UnifiWebsocket.hass

Definition at line 28 of file websocket.py.

◆ signal

homeassistant.components.unifi.hub.websocket.UnifiWebsocket.signal

Definition at line 30 of file websocket.py.

◆ ws_task

homeassistant.components.unifi.hub.websocket.UnifiWebsocket.ws_task

Definition at line 94 of file websocket.py.


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