-
-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add update sensor for luxtronik firmware.
* Small fixes and improvements.
- Loading branch information
Showing
5 changed files
with
220 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,187 @@ | ||
| """Luxtronik Update platform.""" | ||
| from __future__ import annotations | ||
|
|
||
| import re | ||
| import threading | ||
| from dataclasses import dataclass | ||
| from datetime import datetime, timedelta | ||
| from typing import Final | ||
|
|
||
| import requests | ||
| from homeassistant.components.update import (ENTITY_ID_FORMAT, UpdateEntity, | ||
| UpdateEntityDescription) | ||
| from homeassistant.components.update.const import UpdateEntityFeature | ||
| from homeassistant.config_entries import ConfigEntry | ||
| from homeassistant.const import STATE_UNAVAILABLE | ||
| from homeassistant.core import HomeAssistant | ||
| from homeassistant.helpers.entity import EntityCategory | ||
| from homeassistant.helpers.entity_platform import AddEntitiesCallback | ||
| from homeassistant.util import Throttle | ||
|
|
||
| from . import LuxtronikDevice, LuxtronikEntityDescription | ||
| from .const import (DOMAIN, DOWNLOAD_PORTAL_URL, LOGGER, | ||
| LUX_MODELS_AlphaInnotec, LUX_MODELS_Novelan, | ||
| LUX_MODELS_Other) | ||
|
|
||
| MIN_TIME_BETWEEN_UPDATES: Final = timedelta(hours=1) | ||
|
|
||
|
|
||
| @dataclass | ||
| class LuxtronikUpdateEntityDescription( | ||
| LuxtronikEntityDescription, UpdateEntityDescription | ||
| ): | ||
| """Class describing Luxtronik update entities.""" | ||
|
|
||
|
|
||
| async def async_setup_entry( | ||
| hass: HomeAssistant, | ||
| config_entry: ConfigEntry, | ||
| async_add_entities: AddEntitiesCallback, | ||
| ) -> None: | ||
| """Set up Luxtronik update platform.""" | ||
|
|
||
| LOGGER.debug("Setting up Luxtronik update entity") | ||
| luxtronik_device: LuxtronikDevice = hass.data.get(DOMAIN) | ||
| luxtronik_device.read() | ||
| data: dict = config_entry.data | ||
|
|
||
| description = LuxtronikUpdateEntityDescription( | ||
| luxtronik_key="calculations.ID_WEB_SoftStand", | ||
| key="firmware", | ||
| entity_category=EntityCategory.CONFIG, | ||
| ) | ||
| update_entity = LuxtronikUpdateEntity( | ||
| entry=config_entry, luxtronik_device=luxtronik_device, description=description, device_info=hass.data[f"{DOMAIN}_DeviceInfo"] | ||
| ) | ||
| entities = [update_entity] | ||
|
|
||
| async_add_entities(entities) | ||
|
|
||
|
|
||
| class LuxtronikUpdateEntity(UpdateEntity): | ||
| """Representation of Luxtronik.""" | ||
|
|
||
| _attr_title = "Luxtronik Firmware Version" | ||
| _attr_supported_features: UpdateEntityFeature = UpdateEntityFeature.RELEASE_NOTES | ||
| __firmware_version_available = None | ||
| __firmware_version_available_last_request = None | ||
|
|
||
| def __init__( | ||
| self, | ||
| entry: ConfigEntry, | ||
| luxtronik_device: LuxtronikDevice, | ||
| description: LuxtronikUpdateEntityDescription, | ||
| device_info | ||
| ) -> None: | ||
| """Initialize the Luxtronik.""" | ||
| super().__init__() | ||
| self.entity_description = description | ||
| self.luxtronik_device = luxtronik_device | ||
| # self.coordinator = coordinator | ||
| self._attr_device_info = device_info | ||
| # self._attr_unique_id = f"tuya.{device.id}" | ||
| self.luxtronik_key = description.luxtronik_key | ||
|
|
||
| self._attr_name = "Luxtronik Firmware" | ||
| luxtronik_device.read() | ||
| # self._attr_state = luxtronik_device.get_value(description.luxtronik_key) | ||
| prefix = DOMAIN | ||
| self.entity_id = ENTITY_ID_FORMAT.format( | ||
| f"{prefix}_{description.key}" | ||
| ) | ||
| self._attr_unique_id = self.entity_id | ||
| self._request_available_firmware_version() | ||
|
|
||
| @property | ||
| def installed_version(self) -> str: | ||
| """Return the current app version.""" | ||
| # return self._attr_state | ||
| return self.luxtronik_device.get_value(self.entity_description.luxtronik_key) | ||
|
|
||
| @property | ||
| def latest_version(self) -> str: | ||
| """Return if there is an update.""" | ||
| if self.__firmware_version_available is None: | ||
| self._request_available_firmware_version() | ||
| return None | ||
| return self.__firmware_version_available[:len(self.installed_version)] | ||
|
|
||
| def release_notes(self) -> str | None: | ||
| release_url = self._get_manufacturer_firmware_url_by_model( | ||
| self.luxtronik_device.get_value("calculations.ID_WEB_Code_WP_akt") | ||
| ) | ||
| download_id = self._get_firmware_download_id(self.installed_version) | ||
| download_url = f"{DOWNLOAD_PORTAL_URL}{download_id}" | ||
| return f'<a href="{release_url}" target="_blank" rel="noreferrer noopener">Firmware Download Portal</a> <a href="{download_url}" target="_blank" rel="noreferrer noopener">Direct Download</a><br><br>alpha innotec doesn\'t provide a changelog.<br>Please contact support for more information.' | ||
|
|
||
| def _get_firmware_download_id(self, installed_version: str) -> int | None: | ||
| """Return the heatpump firmware id for the download portal.""" | ||
| if installed_version.startswith("V1."): | ||
| return 0 | ||
| elif installed_version.startswith("V2."): | ||
| return 1 | ||
| elif installed_version.startswith("V3."): | ||
| return 2 | ||
| elif installed_version.startswith("V4."): | ||
| return 3 | ||
| elif installed_version.startswith("F1."): | ||
| return 4 | ||
| elif installed_version.startswith("WWB1."): | ||
| return 5 | ||
| elif installed_version.startswith("smo"): | ||
| return 6 | ||
| return None | ||
|
|
||
| # @Throttle(MIN_TIME_BETWEEN_UPDATES) | ||
| def update(self) -> None: | ||
| """Update sensor values.""" | ||
| # self._attr_state = self.luxtronik_device.get_value(self.entity_description.luxtronik_key) | ||
| if ( | ||
| self.__firmware_version_available_last_request is None | ||
| or self.__firmware_version_available_last_request | ||
| < datetime.utcnow().timestamp() - 3600 | ||
| ): | ||
| self._request_available_firmware_version() | ||
|
|
||
| def _request_available_firmware_version(self) -> None: | ||
| def do_request_available_firmware_version(self, download_id: int): | ||
| if download_id is None: | ||
| self.__firmware_version_available = STATE_UNAVAILABLE | ||
| return | ||
| try: | ||
| response = requests.get( | ||
| f"{DOWNLOAD_PORTAL_URL}{download_id}", timeout=30 | ||
| ) | ||
| header_content_disposition = response.headers["content-disposition"] | ||
| filename = re.findall("filename=(.+)", header_content_disposition)[0] | ||
| self.__firmware_version_available_last_request = ( | ||
| datetime.utcnow().timestamp() | ||
| ) | ||
| # Filename e.g.: wp2reg-V2.88.1-9086 | ||
| # Extract 'V2.88.1' from 'wp2reg-V2.88.1-9086' | ||
| self.__firmware_version_available = filename.split("-", 1)[1] | ||
| except Exception as err: # pylint: disable=broad-except | ||
| LOGGER.warning( | ||
| "Could not request download portal firmware version.", | ||
| exc_info=True, | ||
| ) | ||
| self.__firmware_version_available = STATE_UNAVAILABLE | ||
|
|
||
| download_id = self._get_firmware_download_id(self.installed_version) | ||
| threading.Thread( | ||
| target=do_request_available_firmware_version, args=(self, download_id) | ||
| ).start() | ||
|
|
||
| def _get_manufacturer_firmware_url_by_model(self, model: str) -> str: | ||
| """Return the manufacturer firmware download url.""" | ||
| layout_id = 0 | ||
|
|
||
| if model is None: | ||
| layout_id = 0 | ||
| elif model.startswith(tuple(LUX_MODELS_AlphaInnotec)): | ||
| layout_id = 1 | ||
| elif model.startswith(tuple(LUX_MODELS_Novelan)): | ||
| layout_id = 2 | ||
| elif model.startswith(tuple(LUX_MODELS_Other)): | ||
| layout_id = 3 | ||
| return f"https://www.heatpump24.com/DownloadArea.php?layout={layout_id}" |