Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.evohome.EvoSession Class Reference

Public Member Functions

None __init__ (self, HomeAssistant hass)
 
None authenticate (self, str username, str password)
 
None save_auth_tokens (self)
 

Public Attributes

 client_v1
 
 client_v2
 
 hass
 
 session_id
 

Private Member Functions

None _load_auth_tokens (self, str username)
 

Private Attributes

 _session
 
 _store
 
 _tokens
 

Detailed Description

Class for evohome client instantiation & authentication.

Definition at line 101 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.evohome.EvoSession.__init__ (   self,
HomeAssistant  hass 
)
Initialize the evohome broker and its data structure.

Definition at line 104 of file __init__.py.

Member Function Documentation

◆ _load_auth_tokens()

None homeassistant.components.evohome.EvoSession._load_auth_tokens (   self,
str  username 
)
private
Load access tokens and session_id from the store and validate them.

Sets self._tokens and self._session_id to the latest values.

Definition at line 156 of file __init__.py.

◆ authenticate()

None homeassistant.components.evohome.EvoSession.authenticate (   self,
str  username,
str  password 
)
Check the user credentials against the web API.

Will raise evo.AuthenticationFailed if the credentials are invalid.

Definition at line 120 of file __init__.py.

◆ save_auth_tokens()

None homeassistant.components.evohome.EvoSession.save_auth_tokens (   self)
Save access tokens and session_id to the store.

Sets self._tokens and self._session_id to the latest values.

Definition at line 184 of file __init__.py.

Member Data Documentation

◆ _session

homeassistant.components.evohome.EvoSession._session
private

Definition at line 109 of file __init__.py.

◆ _store

homeassistant.components.evohome.EvoSession._store
private

Definition at line 110 of file __init__.py.

◆ _tokens

homeassistant.components.evohome.EvoSession._tokens
private

Definition at line 169 of file __init__.py.

◆ client_v1

homeassistant.components.evohome.EvoSession.client_v1

Definition at line 149 of file __init__.py.

◆ client_v2

homeassistant.components.evohome.EvoSession.client_v2

Definition at line 145 of file __init__.py.

◆ hass

homeassistant.components.evohome.EvoSession.hass

Definition at line 107 of file __init__.py.

◆ session_id

homeassistant.components.evohome.EvoSession.session_id

Definition at line 168 of file __init__.py.


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