Add config flow to linky (#26076)
* Linky: setup ConfigFlow * async_track_time_interval * Review from @MartinHjelmare 1 * Review from @MartinHjelmare 2 * Review from @MartinHjelmare 3 * Review from @MartinHjelmare 4 * black --fast homeassistant tests * Bump pylinky to 0.4.0 and add error user feedback * Fix .coveragerc * Linky platform moved to integration in config.yml and with multiple accounts * Remove useless logs * Review from @MartinHjelmare 5 * Add config flow tests * Add config flow tests : login + fetch on failed
This commit is contained in:
1 parent
ca97bba4b4
commit
b4058b5c7f
15 files changed
+452
-58
No files matched your search
@@ -1,12 +1,12 @@
|
||||
"""Support for Linky."""
|
||||
from datetime import timedelta
|
||||
import json
|
||||
import logging
|
||||
from datetime import timedelta
|
||||
|
||||
from pylinky.client import DAILY, MONTHLY, YEARLY, LinkyClient, PyLinkyError
|
||||
import voluptuous as vol
|
||||
from pylinky.client import DAILY, MONTHLY, YEARLY, LinkyClient
|
||||
from pylinky.client import PyLinkyException
|
||||
|
||||
from homeassistant.components.sensor import PLATFORM_SCHEMA
|
||||
from homeassistant.config_entries import ConfigEntry
|
||||
from homeassistant.const import (
|
||||
ATTR_ATTRIBUTION,
|
||||
CONF_PASSWORD,
|
||||
@@ -14,10 +14,9 @@ from homeassistant.const import (
|
||||
CONF_USERNAME,
|
||||
ENERGY_KILO_WATT_HOUR,
|
||||
)
|
||||
import homeassistant.helpers.config_validation as cv
|
||||
from homeassistant.helpers.entity import Entity
|
||||
from homeassistant.helpers.event import track_time_interval
|
||||
import homeassistant.util.dt as dt_util
|
||||
from homeassistant.helpers.event import async_track_time_interval
|
||||
from homeassistant.helpers.typing import HomeAssistantType
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
@@ -29,7 +28,6 @@ INDEX_CURRENT = -1
|
||||
INDEX_LAST = -2
|
||||
ATTRIBUTION = "Data provided by Enedis"
|
||||
|
||||
DEFAULT_TIMEOUT = 10
|
||||
SENSORS = {
|
||||
"yesterday": ("Linky yesterday", DAILY, INDEX_LAST),
|
||||
"current_month": ("Linky current month", MONTHLY, INDEX_CURRENT),
|
||||
@@ -41,59 +39,54 @@ SENSORS_INDEX_LABEL = 0
|
||||
SENSORS_INDEX_SCALE = 1
|
||||
SENSORS_INDEX_WHEN = 2
|
||||
|
||||
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
|
||||
{
|
||||
vol.Required(CONF_USERNAME): cv.string,
|
||||
vol.Required(CONF_PASSWORD): cv.string,
|
||||
vol.Optional(CONF_TIMEOUT, default=DEFAULT_TIMEOUT): cv.positive_int,
|
||||
}
|
||||
)
|
||||
|
||||
async def async_setup_platform(hass, config, async_add_entities, discovery_info=None):
|
||||
"""Old way of setting up the Linky platform."""
|
||||
pass
|
||||
|
||||
|
||||
def setup_platform(hass, config, add_entities, discovery_info=None):
|
||||
"""Configure the platform and add the Linky sensor."""
|
||||
username = config[CONF_USERNAME]
|
||||
password = config[CONF_PASSWORD]
|
||||
timeout = config[CONF_TIMEOUT]
|
||||
async def async_setup_entry(
|
||||
hass: HomeAssistantType, entry: ConfigEntry, async_add_entities
|
||||
) -> None:
|
||||
"""Add Linky entries."""
|
||||
account = LinkyAccount(
|
||||
entry.data[CONF_USERNAME], entry.data[CONF_PASSWORD], entry.data[CONF_TIMEOUT]
|
||||
)
|
||||
|
||||
account = LinkyAccount(hass, add_entities, username, password, timeout)
|
||||
add_entities(account.sensors, True)
|
||||
await hass.async_add_executor_job(account.update_linky_data)
|
||||
|
||||
sensors = [
|
||||
LinkySensor("Linky yesterday", account, DAILY, INDEX_LAST),
|
||||
LinkySensor("Linky current month", account, MONTHLY, INDEX_CURRENT),
|
||||
LinkySensor("Linky last month", account, MONTHLY, INDEX_LAST),
|
||||
LinkySensor("Linky current year", account, YEARLY, INDEX_CURRENT),
|
||||
LinkySensor("Linky last year", account, YEARLY, INDEX_LAST),
|
||||
]
|
||||
|
||||
async_track_time_interval(hass, account.update_linky_data, SCAN_INTERVAL)
|
||||
|
||||
async_add_entities(sensors, True)
|
||||
|
||||
|
||||
class LinkyAccount:
|
||||
"""Representation of a Linky account."""
|
||||
|
||||
def __init__(self, hass, add_entities, username, password, timeout):
|
||||
def __init__(self, username, password, timeout):
|
||||
"""Initialise the Linky account."""
|
||||
self._username = username
|
||||
self.__password = password
|
||||
self._password = password
|
||||
self._timeout = timeout
|
||||
self._data = None
|
||||
self.sensors = []
|
||||
|
||||
self.update_linky_data(dt_util.utcnow())
|
||||
|
||||
self.sensors.append(LinkySensor("Linky yesterday", self, DAILY, INDEX_LAST))
|
||||
self.sensors.append(
|
||||
LinkySensor("Linky current month", self, MONTHLY, INDEX_CURRENT)
|
||||
)
|
||||
self.sensors.append(LinkySensor("Linky last month", self, MONTHLY, INDEX_LAST))
|
||||
self.sensors.append(
|
||||
LinkySensor("Linky current year", self, YEARLY, INDEX_CURRENT)
|
||||
)
|
||||
self.sensors.append(LinkySensor("Linky last year", self, YEARLY, INDEX_LAST))
|
||||
|
||||
track_time_interval(hass, self.update_linky_data, SCAN_INTERVAL)
|
||||
|
||||
def update_linky_data(self, event_time):
|
||||
def update_linky_data(self, event_time=None):
|
||||
"""Fetch new state data for the sensor."""
|
||||
client = LinkyClient(self._username, self.__password, None, self._timeout)
|
||||
client = LinkyClient(self._username, self._password, None, self._timeout)
|
||||
try:
|
||||
client.login()
|
||||
client.fetch_data()
|
||||
self._data = client.get_data()
|
||||
_LOGGER.debug(json.dumps(self._data, indent=2))
|
||||
except PyLinkyError as exp:
|
||||
except PyLinkyException as exp:
|
||||
_LOGGER.error(exp)
|
||||
finally:
|
||||
client.close_session()
|
||||
@@ -115,12 +108,12 @@ class LinkySensor(Entity):
|
||||
def __init__(self, name, account: LinkyAccount, scale, when):
|
||||
"""Initialize the sensor."""
|
||||
self._name = name
|
||||
self.__account = account
|
||||
self._account = account
|
||||
self._scale = scale
|
||||
self.__when = when
|
||||
self._when = when
|
||||
self._username = account.username
|
||||
self.__time = None
|
||||
self.__consumption = None
|
||||
self._time = None
|
||||
self._consumption = None
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
@@ -130,7 +123,7 @@ class LinkySensor(Entity):
|
||||
@property
|
||||
def state(self):
|
||||
"""Return the state of the sensor."""
|
||||
return self.__consumption
|
||||
return self._consumption
|
||||
|
||||
@property
|
||||
def unit_of_measurement(self):
|
||||
@@ -147,18 +140,18 @@ class LinkySensor(Entity):
|
||||
"""Return the state attributes of the sensor."""
|
||||
return {
|
||||
ATTR_ATTRIBUTION: ATTRIBUTION,
|
||||
"time": self.__time,
|
||||
"time": self._time,
|
||||
CONF_USERNAME: self._username,
|
||||
}
|
||||
|
||||
def update(self):
|
||||
async def async_update(self) -> None:
|
||||
"""Retrieve the new data for the sensor."""
|
||||
data = self.__account.data[self._scale][self.__when]
|
||||
self.__consumption = data[CONSUMPTION]
|
||||
self.__time = data[TIME]
|
||||
data = self._account.data[self._scale][self._when]
|
||||
self._consumption = data[CONSUMPTION]
|
||||
self._time = data[TIME]
|
||||
|
||||
if self._scale is not YEARLY:
|
||||
year_index = INDEX_CURRENT
|
||||
if self.__time.endswith("Dec"):
|
||||
if self._time.endswith("Dec"):
|
||||
year_index = INDEX_LAST
|
||||
self.__time += " " + self.__account.data[YEARLY][year_index][TIME]
|
||||
self._time += " " + self._account.data[YEARLY][year_index][TIME]
|
||||
Reference in new issue
Block a user