smartbox 2.1.2__tar.gz → 2.2.0__tar.gz

smartbox-2.2.0/.github/ISSUE_TEMPLATE/new-reseller.md

@@ -0,0 +1,18 @@
+---
+name: New reseller
+about: Add a new available reseller.
+title: "[RESELLER] New available reseller"
+labels: reseller
+assignees: Delmael
+
+---
+
+> [!NOTE]
+> If you do not see your current reseller in the available list, you can ask to add it. We cannot ensure your device go through this platform
+
+* [ ] I have check with the `smartbox resellers` command that my reseller is not already present
+* **Website url (mandatory)** :
+* Name of the resellers:
+* API url :
+* Basic auth headers :
+* Serial id:

{smartbox-2.1.2 → smartbox-2.2.0}/.github/workflows/publish-to-pypi.yml

@@ -22,7 +22,7 @@ jobs:
         with:
             python-version: ${{ env.PYTHON_VERSION }}
       - name: Set up Python ${{ env.PYTHON_VERSION }}
-        uses: actions/setup-python@v5.4.0
+        uses: actions/setup-python@v5.5.0
         with:
             python-version: ${{ env.PYTHON_VERSION }}
       - name: Build a binary wheel and a source tarball

{smartbox-2.1.2 → smartbox-2.2.0}/.github/workflows/python-package.yml

@@ -25,7 +25,7 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5.4.0
+        uses: actions/setup-python@v5.5.0
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install the project
@@ -47,7 +47,7 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5.4.0
+        uses: actions/setup-python@v5.5.0
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install the project
@@ -70,7 +70,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5.4.0
+        uses: actions/setup-python@v5.5.0
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install the project

{smartbox-2.1.2 → smartbox-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: smartbox
-Version: 2.1.2
+Version: 2.2.0
 Summary: Python API to control heating 'smart boxes'
 Project-URL: Homepage, https://github.com/ajtudela/smartbox
 Project-URL: Issues, https://github.com/ajtudela/smartbox/issues
@@ -53,7 +53,7 @@ A few common options are required for all commands:
 Verbose logging can be enabled with the `-v`/`--verbose` flag.
 
 ### Optional options
-These options are useful if your resailer is not configured.
+These options are useful if your reseller is not configured.
 
 * `-b`/`--base-auth-creds`: An HTTP Basic Auth credential used to do initial
   authentication with the server. Use the base64 encoded string directly. See
@@ -61,7 +61,7 @@ These options are useful if your resailer is not configured.
 * `-a`/`--api-name`: The API name for your heater vendor. This is visible in
   the 'API Host' entry in the 'Version' menu item in the mobile app/web app. If
   the host name is of the form `api-foo.xxxx` or `api.xxxx` use the values
-  `api-foo` or `api` respectively. The resailer has to be declared in the package.
+  `api-foo` or `api` respectively. The reseller has to be declared in the package.
 * `-r`/`--x-referer`: The referer of your request.
 * `-i`/`--x-serial-id`: The serial-id of your request.
 
@@ -132,11 +132,11 @@ The `health-check` command can be used to know if the API is alived
 
     smartbox <auth options...> health-check
 
-### List available resailers
-The `resailers` command can be used to know which resailershas an automatic configuration.
-If your resailer is not present you can raise an issue in github, or use the optional options.
+### List available resellers
+The `resellers` command can be used to know which resellers has an automatic configuration.
+If your reseller is not present you can raise an issue in github, or use the optional options.
 
-    smartbox <auth options...> resailers
+    smartbox <auth options...> resellers
 
 
 See [api-notes.md](./api-notes.md) for notes on REST and socket.io endpoints.

{smartbox-2.1.2 → smartbox-2.2.0}/README.md

@@ -31,7 +31,7 @@ A few common options are required for all commands:
 Verbose logging can be enabled with the `-v`/`--verbose` flag.
 
 ### Optional options
-These options are useful if your resailer is not configured.
+These options are useful if your reseller is not configured.
 
 * `-b`/`--base-auth-creds`: An HTTP Basic Auth credential used to do initial
   authentication with the server. Use the base64 encoded string directly. See
@@ -39,7 +39,7 @@ These options are useful if your resailer is not configured.
 * `-a`/`--api-name`: The API name for your heater vendor. This is visible in
   the 'API Host' entry in the 'Version' menu item in the mobile app/web app. If
   the host name is of the form `api-foo.xxxx` or `api.xxxx` use the values
-  `api-foo` or `api` respectively. The resailer has to be declared in the package.
+  `api-foo` or `api` respectively. The reseller has to be declared in the package.
 * `-r`/`--x-referer`: The referer of your request.
 * `-i`/`--x-serial-id`: The serial-id of your request.
 
@@ -110,11 +110,11 @@ The `health-check` command can be used to know if the API is alived
 
     smartbox <auth options...> health-check
 
-### List available resailers
-The `resailers` command can be used to know which resailershas an automatic configuration.
-If your resailer is not present you can raise an issue in github, or use the optional options.
+### List available resellers
+The `resellers` command can be used to know which resellers has an automatic configuration.
+If your reseller is not present you can raise an issue in github, or use the optional options.
 
-    smartbox <auth options...> resailers
+    smartbox <auth options...> resellers
 
 
 See [api-notes.md](./api-notes.md) for notes on REST and socket.io endpoints.

{smartbox-2.1.2 → smartbox-2.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "smartbox"
-version = "2.1.2"
+version = "2.2.0"
 requires-python = ">=3.13"
 authors = [
   { name="Alberto Tudela", email="ajtudela@gmail.com" },

{smartbox-2.1.2 → smartbox-2.2.0}/src/smartbox/__init__.py

@@ -5,7 +5,7 @@ import importlib.metadata
 from .error import (
     APIUnavailableError,
     InvalidAuthError,
-    ResailerNotExistError,
+    ResellerNotExistError,
     SmartboxError,
 )
 from .models import (
@@ -21,7 +21,7 @@ from .models import (
     NodeStatus,
     SmartboxNodeType,
 )
-from .resailer import AvailableResailers, SmartboxResailer
+from .reseller import AvailableResellers, SmartboxReseller
 from .session import AsyncSmartboxSession, Session
 from .socket import SocketSession
 from .update_manager import UpdateManager
@@ -33,7 +33,7 @@ __all__ = [
     "APIUnavailableError",
     "AcmNodeStatus",
     "AsyncSmartboxSession",
-    "AvailableResailers",
+    "AvailableResellers",
     "DefaultNodeStatus",
     "GuestUser",
     "Guests",
@@ -44,11 +44,11 @@ __all__ = [
     "NodeFactoryOptions",
     "NodeSetup",
     "NodeStatus",
-    "ResailerNotExistError",
+    "ResellerNotExistError",
     "Session",
     "SmartboxError",
     "SmartboxNodeType",
-    "SmartboxResailer",
+    "SmartboxReseller",
     "SocketSession",
     "UpdateManager",
 ]

{smartbox-2.1.2 → smartbox-2.2.0}/src/smartbox/cmd.py

@@ -7,7 +7,7 @@ from typing import Any
 from aiohttp import ClientSession
 import asyncclick as click
 
-from smartbox.resailer import AvailableResailers
+from smartbox.reseller import AvailableResellers
 from smartbox.session import AsyncSmartboxSession
 from smartbox.socket import SocketSession
 
@@ -277,6 +277,21 @@ async def device_away_status(ctx) -> None:
         _pretty_print(device_away_status)
 
 
+@smartbox.command(help="Show device connected status")
+@click.pass_context
+async def device_connected_status(ctx) -> None:
+    """Show device connected status."""
+    session = ctx.obj["session"]
+    devices = await session.get_devices()
+
+    for device in devices:
+        print(f"{device['name']} (dev_id: {device['dev_id']})")
+        device_away_status = await session.get_device_connected(
+            device["dev_id"],
+        )
+        _pretty_print(device_away_status)
+
+
 @smartbox.command(
     help="Set device away_status (pass settings as extra args, e.g. away=true)",
 )
@@ -379,10 +394,19 @@ async def health_check(ctx) -> None:
     _pretty_print(health)
 
 
-@smartbox.command(help="Get the availables resailers.")
-def resailers() -> None:
-    """Get the availables resailers."""
-    for item in AvailableResailers.resailers.items():
+@smartbox.command(help="Get version of the API.")
+@click.pass_context
+async def api_version(ctx) -> None:
+    """Get the version of the API."""
+    session = ctx.obj["session"]
+    version = await session.api_version()
+    _pretty_print(version)
+
+
+@smartbox.command(help="Get the availables resellers.")
+def resellers() -> None:
+    """Get the availables resellers."""
+    for item in AvailableResellers.resellers.items():
         print(item)
 
 

{smartbox-2.1.2 → smartbox-2.2.0}/src/smartbox/error.py

@@ -15,5 +15,5 @@ class APIUnavailableError(aiohttp.ClientConnectionError):
     """API is unavailable."""
 
 
-class ResailerNotExistError(Exception):
-    """Resailer is not known."""
+class ResellerNotExistError(Exception):
+    """Reseller is not known."""

{smartbox-2.1.2 → smartbox-2.2.0}/src/smartbox/models.py

@@ -47,7 +47,15 @@ class NodeExtraOptions(BaseModel):
     boost_time: int
 
 
-class NodeSetup(BaseModel):
+class PmoSetup(BaseModel):
+    """Pmo node setup."""
+
+    circuit_type: int
+    power_limit: int
+    reverse: bool
+
+
+class DefaultNodeSetup(BaseModel):
     """NodeSetup model."""
 
     sync_status: str
@@ -66,6 +74,16 @@ class NodeSetup(BaseModel):
     extra_options: NodeExtraOptions
 
 
+class NodeSetup(RootModel[DefaultNodeSetup | PmoSetup]):
+    """NodeSetup model."""
+
+    root: DefaultNodeSetup | PmoSetup
+
+    def __getattr__(self, name: str) -> DefaultNodeSetup | PmoSetup:
+        """Get the root model directly."""
+        return getattr(self.root, name)
+
+
 class DefaultNodeStatus(BaseModel):
     """Default Node Status."""
 
@@ -196,17 +214,26 @@ class Homes(RootModel[list[Home]]):
 
 
 class Sample(BaseModel):
-    """Sample model."""
+    """Pmo Sample model."""
 
     t: int
+    counter: float
     temp: str
-    counter: int
+
+
+class PmoSample(BaseModel):
+    """Default Sample."""
+
+    t: int
+    counter: float
+    max: int
+    min: int
 
 
 class Samples(BaseModel):
     """Samples model."""
 
-    samples: list[Sample]
+    samples: list[PmoSample | Sample]
 
 
 class Token(BaseModel):
@@ -229,3 +256,9 @@ class Guests(BaseModel):
     """Guests model."""
 
     guest_users: list[GuestUser]
+
+
+class DeviceConnected(BaseModel):
+    """Connected status of devices."""
+
+    connected: bool

smartbox-2.1.2/src/smartbox/resailer.py → smartbox-2.2.0/src/smartbox/reseller.py

@@ -1,18 +1,18 @@
-"""Resailer of Smartbox."""
+"""Reseller of Smartbox."""
 
 import logging
 from typing import ClassVar
 
 from pydantic import BaseModel, ValidationError
 
-from smartbox.error import ResailerNotExistError
+from smartbox.error import ResellerNotExistError
 
 SMARTBOX_GENERIC_BASIC_AUTH = "NTRiY2NiZmI0MWE5YTUxMTNmMDQ4OGQwOnZkaXZkaQ=="
 _LOGGER = logging.getLogger(__name__)
 
 
-class SmartboxResailer(BaseModel):
-    """Model of Smartbox Resailer config."""
+class SmartboxReseller(BaseModel):
+    """Model of Smartbox Reseller config."""
 
     name: str = "Smartbox"
     web_url: str = ""
@@ -21,43 +21,55 @@ class SmartboxResailer(BaseModel):
     serial_id: int = 0
 
 
-class AvailableResailers:
-    """Resailers that have been verified."""
+class AvailableResellers:
+    """Resellers that have been verified."""
 
-    resailers: ClassVar[dict[str, SmartboxResailer]] = {
-        "api": SmartboxResailer(
+    resellers: ClassVar[dict[str, SmartboxReseller]] = {
+        "api": SmartboxReseller(
             name="Helki",
             web_url="https://app.helki.com/",
             api_url="api",
             serial_id=1,
         ),
-        "api-climastar": SmartboxResailer(
+        "api-ehc": SmartboxReseller(
+            name="Electric Heating Company",
+            web_url="https://control.electric-heatingcompany.co.uk/",
+            api_url="api-ehc",
+            serial_id=3,
+        ),
+        "api-climastar": SmartboxReseller(
             name="Climastar",
             web_url="https://avantwifi.climastar.es/",
             api_url="api-climastar",
             serial_id=5,
         ),
-        "api-elnur": SmartboxResailer(
+        "api-elnur": SmartboxReseller(
             name="Elnur",
             web_url="https://remotecontrol.elnur.es/",
             api_url="api-elnur",
             serial_id=7,
         ),
-        "api-hjm": SmartboxResailer(
+        "api-hjm": SmartboxReseller(
             name="HJM",
             web_url="https://api.calorhjm.com/",
             api_url="api-hjm",
             serial_id=10,
         ),
-        "api-haverland": SmartboxResailer(
+        "api-evconfort": SmartboxReseller(
+            name="Electrorad",
+            web_url="https://app.controls-electrorad.co.uk/",
+            api_url="api-evconfort",
+            serial_id=12,
+        ),
+        "api-haverland": SmartboxReseller(
             name="Haverland",
             web_url="https://i2control.haverland.com/",
             api_url="api-haverland",
             basic_auth="NTU2ZDc0MWI3OGUzYmU5YjU2NjA3NTQ4OnZkaXZkaQ==",
             serial_id=14,
         ),
-        "api-lhz": SmartboxResailer(
-            name="Technotherm",
+        "api-lhz": SmartboxReseller(
+            name="Technotherm / Lucht-LHZ",
             web_url="https://ttiapp.technotherm.com/",
             api_url="api-lhz",
             serial_id=16,
@@ -72,7 +84,7 @@ class AvailableResailers:
         serial_id: int | None = None,
         name: str = "Smartbox",
     ) -> None:
-        """Check if resailer is already available or try to create one."""
+        """Check if reseller is already available or try to create one."""
         self._api_url = api_url
         self._basic_auth = basic_auth
         self._web_url = web_url
@@ -80,27 +92,27 @@ class AvailableResailers:
         self._name = name
 
     @property
-    def resailer(self) -> SmartboxResailer:
-        """Get the resailer."""
-        resailer = self.resailers.get(self._api_url, None)
-        if resailer is None:
+    def reseller(self) -> SmartboxReseller:
+        """Get the reseller."""
+        reseller = self.resellers.get(self._api_url, None)
+        if reseller is None:
             if (
                 self._basic_auth is None
                 or self._web_url is None
                 or self._serial_id is None
             ):
-                msg = "This Resailer is not yet available or some arguments are missing."
-                raise ResailerNotExistError(msg)
+                msg = "This reseller is not yet available or some arguments are missing."
+                raise ResellerNotExistError(msg)
             try:
                 _LOGGER.debug(
-                    "Creating a new resailer api_url (%s), name=%s,  web_url %s, basic_auth=%s, serial_id=%s",
+                    "Creating a new reseller api_url (%s), name=%s,  web_url %s, basic_auth=%s, serial_id=%s",
                     self._api_url,
                     self._name,
                     self._web_url,
                     self._basic_auth,
                     self._serial_id,
                 )
-                resailer = SmartboxResailer(
+                reseller = SmartboxReseller(
                     api_url=self._api_url,
                     basic_auth=self._basic_auth,
                     web_url=self._web_url,
@@ -108,26 +120,26 @@ class AvailableResailers:
                     name=self._name,
                 )
             except ValidationError as e:
-                raise ResailerNotExistError from e
+                raise ResellerNotExistError from e
         _LOGGER.debug(
-            "Resailer api_url (%s), name=%s,  web_url %s",
-            resailer.api_url,
-            resailer.name,
-            resailer.web_url,
+            "Reseller api_url (%s), name=%s,  web_url %s",
+            reseller.api_url,
+            reseller.name,
+            reseller.web_url,
         )
-        return resailer
+        return reseller
 
     @property
     def api_url(self) -> str:
         """Get the api sub domain url."""
-        return self.resailer.api_url
+        return self.reseller.api_url
 
     @property
     def name(self) -> str:
-        """Get the name of resailer."""
-        return self.resailer.name
+        """Get the name of reseller."""
+        return self.reseller.name
 
     @property
     def web_url(self) -> str:
-        """Get the public websit of the resailer."""
-        return self.resailer.web_url
+        """Get the public websit of the reseller."""
+        return self.reseller.web_url