connectivity.py

Go to the documentation of this file.

"""Support for Obihai Connectivity."""
 
from __future__ import annotations
 
from pyobihai import PyObihai
 
from .const import DEFAULT_PASSWORD, DEFAULT_USERNAME, LOGGER
 
 
def get_pyobihai(
    host: str,
    username: str,
    password: str,
) -> PyObihai:
    """Retrieve an authenticated PyObihai."""
 
    return PyObihai(host, username, password)
 
 
def validate_auth(
    host: str,
    username: str,
    password: str,
) -> PyObihai | None:
    """Test if the given setting works as expected."""
 
    obi = get_pyobihai(host, username, password)
 
    login = obi.check_account()
    if not login:
        LOGGER.debug("Invalid credentials")
        return None
 
    return obi
 
 
class ObihaiConnection:
    """Contains a list of Obihai Sensors."""
 
    def __init__(
        self,
        host: str,
        username: str = DEFAULT_USERNAME,
        password: str = DEFAULT_PASSWORD,
    ) -> None:
        """Store configuration."""
        self.sensors: list = []
        self.hosthost = host
        self.usernameusername = username
        self.passwordpassword = password
        self.serialserial: str
        self.servicesservices: list = []
        self.line_servicesline_services: list = []
        self.call_directioncall_direction: list = []
        self.pyobihaipyobihai: PyObihai = None
        self.available: bool = True
 
    def update(self) -> bool:
        """Validate connection and retrieve a list of sensors."""
 
        if not self.pyobihaipyobihai:
            self.pyobihaipyobihai = validate_auth(self.hosthost, self.usernameusername, self.passwordpassword)
 
            if not self.pyobihaipyobihai:
                return False
 
        self.serialserial = self.pyobihaipyobihai.get_device_serial()
        self.servicesservices = self.pyobihaipyobihai.get_state()
        self.line_servicesline_services = self.pyobihaipyobihai.get_line_state()
        self.call_directioncall_direction = self.pyobihaipyobihai.get_call_direction()
 
        return True