Master 1.0.0 beta

.github/workflows/hacs.yml

@@ -0,0 +1,17 @@
+name: HACS Action
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  hacs:
+    name: HACS Action
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: HACS Action
+        uses: "hacs/action@main"
+        with:
+          category: "integration"

.github/workflows/hassfest.yaml

@@ -0,0 +1,14 @@
+name: Validate with hassfest
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  validate:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: "actions/checkout@v3"
+      - uses: home-assistant/actions/hassfest@master

.gitignore

@@ -1,2 +1,4 @@
 __pycache__
 draft
+.idea/
+.vscode/*

.vscode/settings.json

@@ -3,4 +3,7 @@
     "files.associations": {
         "*.yaml": "home-assistant"
     },
-}
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "ms-python.black-formatter",
+    "python.globalModuleInstallation": false,
+}

README.md

@@ -3,11 +3,18 @@ Due to a stall on the original [pblxptr/ecoNET-300-Home-Assistant-Integration](h
 Most of the work was done by pblxpt, for which we're very thankful as the community.
 
 # ecoNET300 Home Assistant integration
+
+[![Code_formatter](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![hacs_badge](https://img.shields.io/badge/HACS-Default-41BDF5.svg)](https://github.com/hacs/integration)
+[![HACS Action](https://github.com/jontofront/ecoNET-300-Home-Assistant-Integration/actions/workflows/hacs.yml/badge.svg)](https://github.com/jontofront/ecoNET-300-Home-Assistant-Integration/actions/workflows/hacs.yml)
+[![stability-alpha](https://img.shields.io/badge/stability-alpha-f4d03f.svg)](https://guidelines.denpa.pro/stability#alpha)
+[![Validate with hassfest](https://github.com/jontofront/ecoNET-300-Home-Assistant-Integration/actions/workflows/hassfest.yaml/badge.svg)](https://github.com/jontofront/ecoNET-300-Home-Assistant-Integration/actions/workflows/hassfest.yaml)
+
 <div align="center">
 
-| Home Assistant  | ecoNET300     |
-| --------------- | ------------- |
-| <img src="https://raw.githubusercontent.com/jontofront/ecoNET-300-Home-Assistant-Integration/master/images/ha.png" width="100" height="100" />                |   <img src="https://raw.githubusercontent.com/jontofront/ecoNET-300-Home-Assistant-Integration/master/images/econet.webp" width="95" height="95" />            |
+| Home Assistant  | ecoNET300     | device        |
+| --------------- | ------------- | ------------- |
+| <img src="images/ha.png" width="100" height="100" />                |   <img src="images/econet.webp" width="95" height="95" />            | <img src="images/econet300_device.jpg" width="100" height="100" /> |
 
 </div>
 
@@ -21,10 +28,24 @@ It works locally, which means it connects directly to your local device using lo
 
 This integration is available from the Lovelace frontend without the need to configure the devices in the file configuration.yaml
 
+Integration tested with ecoMAX controller ecoMAX810P-L TOUCH manufactured by [Plum Sp. z o.o.](https://www.plum.pl/)
+
 **Bear in mind that the project is in a very early, pre-alpha phase.**
 
-Plans for first relase:
-- support for some of readonly properties (like mixer temp, ext sensor temp)
+## versions
+* v0.3.3 - version is stable. Most of the work was done by @pblxpt, for which we're very thankful as the community.
+* v1.0.0_beta - is a new dev integration version that fetches more data from API, I don't know yet if it will be better or worse :). It's my first work.
+
+
+## Example
+Here is an example setup showing econet300 device entities:
+
+<div align="center">
+
+
+<img src="images/sensors.png" />             
+
+</div>
 
 ## HACS Installation ##
 Follow [this guide](https://hacs.xyz/docs/faq/custom_repositories/) to add ecoNET-300-Home-Assistant-Integration as a custom repository to the HACS.
@@ -105,11 +126,17 @@ __Password__: Local password (NOT the password that you use to login to econet24
 - Fan (fanWorks)
 - Feeder (fanWorks)
 
-## Contribution
+## Contributing
+
+This is HA integration open-source project. We are always open to people who want to use the code or contribute to it.
+
 
-I work on this project only in my very-limited free time. At this moment I have opened a few other projects which are on a bit higher priority than this one, but I'm going to work on this quite regularlly as I use it in my home automation. However, if you want to help and contribute to this project **it will be highly appreciated.**
+### Contributors
+Many thanks to @denpamusic for his help and pointing me in the right direction
 
-Also if you see a need for a particular feature, don't hesitate to let me know.
+<a href="https://github.com/jontofront/ecoNET-300-Home-Assistant-Integration/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=jontofront/ecoNET-300-Home-Assistant-Integration" />
+</a>
 
 ---
 ## DISCLAIMER

custom_components/econet300/api.py

@@ -1,4 +1,4 @@
-"""Module provides the API functionality for ecoNET-300 Home Assistant Integration."""
+"""Econet300 API class class describint methods of getting and setting data."""
 import asyncio
 from http import HTTPStatus
 import logging
@@ -12,8 +12,8 @@
 from .const import (
     API_EDITABLE_PARAMS_LIMITS_DATA,
     API_EDITABLE_PARAMS_LIMITS_URI,
-    API_REG_PARAMS_PARAM_DATA,
-    API_REG_PARAMS_URI,
+    API_REG_PARAMS_DATA_PARAM_DATA,
+    API_REG_PARAMS_DATA_URI,
     API_SYS_PARAMS_PARAM_HW_VER,
     API_SYS_PARAMS_PARAM_SW_REV,
     API_SYS_PARAMS_PARAM_UID,
@@ -34,7 +34,7 @@ def map_param(param_name):
 
 
 class Limits:
-    """Construct all the necessary attributes for the Limits object."""
+    """Class difining entity value set limits."""
 
     def __init__(self, min_v: float, max_v: float):
         """Construct the necessary attributes for the Limits object."""
@@ -58,7 +58,7 @@ class DataError(Exception):
 
 
 class EconetClient:
-    """Client for interacting with the ecoNET-300 API."""
+    """Econet client class."""
 
     def __init__(
         self, host: str, username: str, password: str, session: ClientSession
@@ -77,28 +77,20 @@ def __init__(
         self._session = session
         self._auth = BasicAuth(username, password)
 
-    def host(self):
-        """Get the host."""
+    @property
+    def host(self) -> str:
+        """Get host address."""
         return self._host
 
     async def set_param(self, key: str, value: str):
-        """Set a parameter."""
-        url = f"{self._host}/econet/rmCurrNewParam?newParamKey={key}&newParamValue={value}"
-
-        return await self._get(url)
+        """Set a parameter via API call."""
+        return await self._get(
+            f"{self._host}/econet/rmCurrNewParam?newParamKey={key}&newParamValue={value}"
+        )
 
     async def get_params(self, reg: str):
-        """Get parameters for a given registry.
-
-        Args:
-            reg (str): The registry to retrieve parameters from.
-
-        Returns:
-            dict: The parameters retrieved from the registry.
-        """
-        url = f"{self._host}/econet/{reg}"
-
-        return await self._get(url)
+        """Call for getting api param."""
+        return await self._get(f"{self._host}/econet/{reg}")
 
     async def _get(self, url):
         attempt = 1
@@ -112,7 +104,7 @@ async def _get(self, url):
                     if resp.status == HTTPStatus.UNAUTHORIZED:
                         raise AuthError
 
-                    elif resp.status != HTTPStatus.OK:
+                    if resp.status != HTTPStatus.OK:
                         return None
 
                     return await resp.json()
@@ -124,6 +116,11 @@ async def _get(self, url):
                 attempt += 1
 
 
+def get_param_id(name: str):
+    """Check if param is mapped and return its value."""
+    return lambda name=name: EDITABLE_PARAMS_MAPPING_TABLE.get(name, None)
+
+
 class Econet300Api:
     """Client for interacting with the ecoNET-300 API."""
 
@@ -137,30 +134,34 @@ def __init__(self, client: EconetClient, cache: MemCache) -> None:
 
     @classmethod
     async def create(cls, client: EconetClient, cache: MemCache):
-        """Create an instance of Econet300Api."""
+        """Create and return initial object."""
         c = cls(client, cache)
         await c.init()
 
         return c
 
-    def host(self):
-        """Get the host."""
-        return self._client.host()
+    @property
+    def host(self) -> str:
+        """Get clients host address."""
+        return self._client.host
 
+    @property
     def uid(self) -> str:
-        """Get the UID."""
+        """Get uid."""
         return self._uid
 
+    @property
     def sw_rev(self) -> str:
-        """Get the software revision."""
-        # Set a parameter value via the Econet 300 API.
+        """Get software version."""
+        return self._sw_revision
 
+    @property
     def hw_ver(self) -> str:
-        """Get the hardware version."""
+        """Get hardware version."""
         return self._hw_version
 
     async def init(self):
-        """Initialize the Econet300Api."""
+        """Econet300 Api initilization."""
         sys_params = await self._client.get_params(API_SYS_PARAMS_URI)
 
         if API_SYS_PARAMS_PARAM_UID not in sys_params:
@@ -188,8 +189,8 @@ async def init(self):
             self._hw_version = sys_params[API_SYS_PARAMS_PARAM_HW_VER]
 
     async def set_param(self, param, value) -> bool:
-        """Set a parameter value via the Econet 300 API."""
-        param_idx = map_param(param)
+        """Set param value in Econet300 API."""
+        param_idx = get_param_id(param)
         if param_idx is None:
             _LOGGER.warning(
                 "Requested param set for: '{param}' but mapping for this param does not exist"
@@ -217,7 +218,7 @@ async def get_param_limits(self, param: str):
             self._cache.set(API_EDITABLE_PARAMS_LIMITS_DATA, limits)
 
         limits = self._cache.get(API_EDITABLE_PARAMS_LIMITS_DATA)
-        param_idx = map_param(param)
+        param_idx = get_param_id(param)
 
         if param_idx is None:
             _LOGGER.warning(
@@ -238,12 +239,11 @@ async def get_param_limits(self, param: str):
         return Limits(curr_limits["min"], curr_limits["max"])
 
     async def fetch_data(self) -> dict[str, Any]:
-        """Fetch merged reg_params and sys_params data."""
+        """Fetch data from regParamsData."""
         reg_params = await self._fetch_reg_key(
-            API_REG_PARAMS_URI, API_REG_PARAMS_PARAM_DATA
+            API_REG_PARAMS_DATA_URI, API_REG_PARAMS_DATA_PARAM_DATA
         )
-        sys_params = await self._fetch_reg_key(API_SYS_PARAMS_URI)
-        return {**reg_params, **sys_params}
+        return reg_params
 
     async def _fetch_reg_key(self, reg, data_key: str | None = None):
         """Fetch a key from the json-encoded data returned by the API for a given registry If key is None, then return whole data."""
@@ -263,7 +263,7 @@ async def _fetch_reg_key(self, reg, data_key: str | None = None):
 
 
 async def make_api(hass: HomeAssistant, cache: MemCache, data: dict):
-    """Create an Econet 300 API instance."""
+    """Create api object."""
     return await Econet300Api.create(
         EconetClient(
             data["host"],