Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.smarttub.controller.SmartTubController Class Reference

Public Member Functions

def __init__ (self, hass)
 
def async_register_devices (self, entry)
 
def async_setup_entry (self, entry)
 
def async_update_data (self)
 
Account login (self, email, password)
 

Public Attributes

 coordinator
 
 spas
 

Private Member Functions

def _get_spa_data (self, spa)
 

Private Attributes

 _account
 
 _hass
 

Detailed Description

Interface between Home Assistant and the SmartTub API.

Definition at line 33 of file controller.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.smarttub.controller.SmartTubController.__init__ (   self,
  hass 
)
Initialize an interface to SmartTub.

Definition at line 36 of file controller.py.

Member Function Documentation

◆ _get_spa_data()

def homeassistant.components.smarttub.controller.SmartTubController._get_spa_data (   self,
  spa 
)
private

Definition at line 95 of file controller.py.

◆ async_register_devices()

def homeassistant.components.smarttub.controller.SmartTubController.async_register_devices (   self,
  entry 
)
Register devices with the device registry for all spas.

Definition at line 110 of file controller.py.

◆ async_setup_entry()

def homeassistant.components.smarttub.controller.SmartTubController.async_setup_entry (   self,
  entry 
)
Perform initial setup.

Authenticate, query static state, set up polling, and otherwise make
ready for normal operations .

Definition at line 44 of file controller.py.

◆ async_update_data()

def homeassistant.components.smarttub.controller.SmartTubController.async_update_data (   self)
Query the API and return the new state.

Definition at line 82 of file controller.py.

◆ login()

Account homeassistant.components.smarttub.controller.SmartTubController.login (   self,
  email,
  password 
)
Retrieve the account corresponding to the specified email and password.

Returns None if the credentials are invalid.

Definition at line 122 of file controller.py.

Member Data Documentation

◆ _account

homeassistant.components.smarttub.controller.SmartTubController._account
private

Definition at line 39 of file controller.py.

◆ _hass

homeassistant.components.smarttub.controller.SmartTubController._hass
private

Definition at line 38 of file controller.py.

◆ coordinator

homeassistant.components.smarttub.controller.SmartTubController.coordinator

Definition at line 42 of file controller.py.

◆ spas

homeassistant.components.smarttub.controller.SmartTubController.spas

Definition at line 40 of file controller.py.


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