Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.wiffi.WiffiIntegrationApi Class Reference

Public Member Functions

def __call__ (self, device, metrics)
 
def __init__ (self, hass)
 
def async_setup (self, config_entry)
 
def server (self)
 
def shutdown (self)
 

Private Member Functions

def _periodic_tick (self, now=None)
 

Private Attributes

 _hass
 
 _known_devices
 
 _periodic_callback
 
 _server
 

Detailed Description

API object for wiffi handling. Stored in hass.data.

Definition at line 74 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.wiffi.WiffiIntegrationApi.__init__ (   self,
  hass 
)
Initialize the instance.

Definition at line 77 of file __init__.py.

Member Function Documentation

◆ __call__()

def homeassistant.components.wiffi.WiffiIntegrationApi.__call__ (   self,
  device,
  metrics 
)
Process callback from TCP server if new data arrives from a device.

Definition at line 99 of file __init__.py.

◆ _periodic_tick()

def homeassistant.components.wiffi.WiffiIntegrationApi._periodic_tick (   self,
  now = None 
)
private
Check if any entity has timed out because it has not been updated.

Definition at line 123 of file __init__.py.

◆ async_setup()

def homeassistant.components.wiffi.WiffiIntegrationApi.async_setup (   self,
  config_entry 
)
Set up api instance.

Definition at line 84 of file __init__.py.

◆ server()

def homeassistant.components.wiffi.WiffiIntegrationApi.server (   self)
Return TCP server instance for start + close.

Definition at line 118 of file __init__.py.

◆ shutdown()

def homeassistant.components.wiffi.WiffiIntegrationApi.shutdown (   self)
Shutdown wiffi api.

Remove listener for periodic callbacks.

Definition at line 91 of file __init__.py.

Member Data Documentation

◆ _hass

homeassistant.components.wiffi.WiffiIntegrationApi._hass
private

Definition at line 79 of file __init__.py.

◆ _known_devices

homeassistant.components.wiffi.WiffiIntegrationApi._known_devices
private

Definition at line 81 of file __init__.py.

◆ _periodic_callback

homeassistant.components.wiffi.WiffiIntegrationApi._periodic_callback
private

Definition at line 82 of file __init__.py.

◆ _server

homeassistant.components.wiffi.WiffiIntegrationApi._server
private

Definition at line 80 of file __init__.py.


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