Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.waterfurnace.WaterFurnaceData Class Reference
Inheritance diagram for homeassistant.components.waterfurnace.WaterFurnaceData:
[legend]
Collaboration diagram for homeassistant.components.waterfurnace.WaterFurnaceData:
[legend]

Public Member Functions

def __init__ (self, hass, client)
 
def run (self)
 

Public Attributes

 client
 
 data
 
 hass
 
 unit
 

Private Member Functions

def _reconnect (self)
 

Private Attributes

 _fails
 
 _shutdown
 

Detailed Description

WaterFurnace Data collector.

This is implemented as a dedicated thread polling a websocket in a
tight loop. The websocket will shut itself from the server side if
a packet is not sent at least every 30 seconds. The reading is
cheap, the login is less cheap, so keeping this open and polling
on a very regular cadence is actually the least io intensive thing
to do.

Definition at line 71 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.waterfurnace.WaterFurnaceData.__init__ (   self,
  hass,
  client 
)
Initialize the data object.

Definition at line 82 of file __init__.py.

Member Function Documentation

◆ _reconnect()

def homeassistant.components.waterfurnace.WaterFurnaceData._reconnect (   self)
private
Reconnect on a failure.

Definition at line 92 of file __init__.py.

◆ run()

def homeassistant.components.waterfurnace.WaterFurnaceData.run (   self)
Thread run loop.

Definition at line 124 of file __init__.py.

Member Data Documentation

◆ _fails

homeassistant.components.waterfurnace.WaterFurnaceData._fails
private

Definition at line 90 of file __init__.py.

◆ _shutdown

homeassistant.components.waterfurnace.WaterFurnaceData._shutdown
private

Definition at line 89 of file __init__.py.

◆ client

homeassistant.components.waterfurnace.WaterFurnaceData.client

Definition at line 86 of file __init__.py.

◆ data

homeassistant.components.waterfurnace.WaterFurnaceData.data

Definition at line 88 of file __init__.py.

◆ hass

homeassistant.components.waterfurnace.WaterFurnaceData.hass

Definition at line 85 of file __init__.py.

◆ unit

homeassistant.components.waterfurnace.WaterFurnaceData.unit

Definition at line 87 of file __init__.py.


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