python-mystrom 2.1.0__tar.gz → 2.4.0__tar.gz

{python-mystrom-2.1.0 → python_mystrom-2.4.0}/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2022 Fabian Affolter <fabian@affolter-engineering.ch>
+Copyright (c) 2015-2025 Fabian Affolter <fabian@affolter-engineering.ch>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{python-mystrom-2.1.0/python_mystrom.egg-info → python_mystrom-2.4.0}/PKG-INFO

@@ -1,23 +1,23 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: python-mystrom
-Version: 2.1.0
+Version: 2.4.0
 Summary: Asynchronous Python API client for interacting with myStrom devices
-Home-page: https://github.com/home-assistant-ecosystem/python-mystrom
+License: MIT
+Keywords: myStrom,API,client,asynchronous
 Author: Fabian Affolter
 Author-email: fabian@affolter-engineering.ch
-License: MIT
-Classifier: Development Status :: 3 - Alpha
-Classifier: Environment :: Console
-Classifier: Intended Audience :: Developers
+Requires-Python: >=3.11
 Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: MacOS :: MacOS X
-Classifier: Operating System :: Microsoft :: Windows
-Classifier: Operating System :: POSIX
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Topic :: Utilities
-Requires-Python: >=3.9
-License-File: LICENSE
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: aiohttp
+Requires-Dist: click
+Requires-Dist: requests
+Project-URL: Homepage, https://github.com/home-assistant-ecosystem/python-mystrom
+Project-URL: Repository, https://github.com/home-assistant-ecosystem/python-mystrom
+Description-Content-Type: text/x-rst
 
 python-mystrom |License| |PyPI|
 ===================================
@@ -63,7 +63,7 @@ be present in the ``unstable`` channel.
 
 .. code:: bash
 
-    $ nix-env -iA nixos.python39Packages.python-mystrom
+    $ nix-env -iA nixos.python3Packages.python-mystrom
 
 
 Plug/switch
@@ -272,3 +272,4 @@ License
 .. |PyPI| image:: https://img.shields.io/pypi/v/python-mystrom.svg
    :target: https://pypi.python.org/pypi/python-mystrom
    :alt: PyPI release
+

{python-mystrom-2.1.0 → python_mystrom-2.4.0}/README.rst

@@ -42,7 +42,7 @@ be present in the ``unstable`` channel.
 
 .. code:: bash
 
-    $ nix-env -iA nixos.python39Packages.python-mystrom
+    $ nix-env -iA nixos.python3Packages.python-mystrom
 
 
 Plug/switch

python_mystrom-2.4.0/pymystrom/__init__.py

@@ -0,0 +1,107 @@
+"""Base details for the myStrom Python bindings."""
+
+import asyncio
+import socket
+from typing import Any, Mapping, Optional
+
+import aiohttp
+from yarl import URL
+
+from .exceptions import MyStromConnectionError
+
+TIMEOUT = 10
+USER_AGENT = "PythonMyStrom/1.0"
+
+
+async def _request(
+    self,
+    uri: str,
+    method: str = "GET",
+    data: Optional[Any] = None,
+    json_data: Optional[dict] = None,
+    params: Optional[Mapping[str, str]] = None,
+) -> Any:
+    """Handle a request to the myStrom device."""
+    headers = {
+        "User-Agent": USER_AGENT,
+        "Accept": "application/json, text/plain, */*",
+    }
+
+    if self._session is None:
+        self._session = aiohttp.ClientSession()
+        self._close_session = True
+
+    try:
+        response = await asyncio.wait_for(
+            self._session.request(
+                method,
+                uri,
+                data=data,
+                json=json_data,
+                params=params,
+                headers=headers,
+            ),
+            timeout=TIMEOUT,
+        )
+    except asyncio.TimeoutError as exception:
+        raise MyStromConnectionError(
+            "Timeout occurred while connecting to myStrom device."
+        ) from exception
+    except (aiohttp.ClientError, socket.gaierror) as exception:
+        raise MyStromConnectionError(
+            "Error occurred while communicating with myStrom device."
+        ) from exception
+
+    content_type = response.headers.get("Content-Type", "")
+    if (response.status // 100) in [4, 5]:
+        response.close()
+
+    if "application/json" in content_type:
+        response_json = await response.json()
+        return response_json
+
+    return response.text
+
+
+class MyStromDevice:
+    """A class for a myStrom device."""
+
+    def __init__(
+        self,
+        host,
+        session: aiohttp.client.ClientSession = None,
+    ):
+        """Initialize the device."""
+        self._close_session = False
+        self._host = host
+        self._session = session
+        self.uri = URL.build(scheme="http", host=self._host)
+
+    async def get_device_info(self) -> dict:
+        """Get the device info of a myStrom device."""
+        url = URL(self.uri).join(URL("api/v1/info"))
+        response = await _request(self, uri=url)
+        if not isinstance(response, dict):
+            # Fall back to the old API version if the device runs with old firmware
+            url = URL(self.uri).join(URL("info.json"))
+            response = await _request(self, uri=url)
+        return response
+
+    async def close(self) -> None:
+        """Close an open client session."""
+        if self._session and self._close_session:
+            await self._session.close()
+
+    async def __aenter__(self) -> "MyStromDevice":
+        """Async enter."""
+        return self
+
+    async def __aexit__(self, *exc_info) -> None:
+        """Async exit."""
+        await self.close()
+
+
+async def get_device_info(host: str) -> dict:
+    """Get the device info of a myStrom device."""
+    async with MyStromDevice(host) as device:
+        return await device.get_device_info()

{python-mystrom-2.1.0 → python_mystrom-2.4.0}/pymystrom/bulb.py

@@ -1,10 +1,11 @@
 """Support for communicating with myStrom bulbs."""
+
 import asyncio
 import logging
+from typing import Optional
 
 import aiohttp
 from yarl import URL
-from typing import Any, Dict, Iterable, List, Optional, Union
 
 from . import _request as request
 
@@ -21,7 +22,7 @@ class MyStromBulb:
         host: str,
         mac: str,
         session: aiohttp.client.ClientSession = None,
-    ):
+    ) -> None:
         """Initialize the bulb."""
         self._close_session = False
         self._host = host
@@ -36,11 +37,9 @@ class MyStromBulb:
         self._bulb_type = None
         self._state = None
         self._transition_time = 0
-        self.uri = (
-            URL.build(scheme="http", host=self._host).join(URI_BULB) / self._mac
-        )
+        self.uri = URL.build(scheme="http", host=self._host).join(URI_BULB) / self._mac
 
-    async def get_state(self) -> object:
+    async def get_state(self) -> None:
         """Get the state of the bulb."""
         response = await request(self, uri=self.uri)
         self._consumption = response[self._mac]["power"]
@@ -57,7 +56,7 @@ class MyStromBulb:
         return self._firmware
 
     @property
-    def mac(self) -> float:
+    def mac(self) -> str:
         """Return the MAC address."""
         return self._mac
 

{python-mystrom-2.1.0 → python_mystrom-2.4.0}/pymystrom/cli.py

@@ -1,4 +1,5 @@
 """Command-line tool for working with myStrom devices."""
+
 import click
 import requests
 import asyncio
@@ -50,9 +51,7 @@ def read_config(ip, mac):
     """Read the current configuration of a myStrom device."""
     click.echo("Read configuration from %s" % ip)
     try:
-        request = requests.get(
-            "http://{}/{}/{}/".format(ip, URI, mac), timeout=TIMEOUT
-        )
+        request = requests.get("http://{}/{}/{}/".format(ip, URI, mac), timeout=TIMEOUT)
         click.echo(request.json())
     except requests.exceptions.ConnectionError:
         click.echo("Communication issue with the device")
@@ -87,9 +86,7 @@ def button():
 @click.option(
     "--long", prompt="URL for a long tab", default="", help="URL for a long tab."
 )
-@click.option(
-    "--touch", prompt="URL for a touch", default="", help="URL for a touch."
-)
+@click.option("--touch", prompt="URL for a touch", default="", help="URL for a touch.")
 def write_config(ip, mac, single, double, long, touch):
     """Write the current configuration of a myStrom button."""
     click.echo("Write configuration to device %s" % ip)
@@ -208,9 +205,7 @@ def read_config(ip, mac):
     """Read the current configuration of a myStrom WiFi Button."""
     click.echo("Read the configuration of button %s..." % ip)
     try:
-        request = requests.get(
-            "http://{}/{}/{}/".format(ip, URI, mac), timeout=TIMEOUT
-        )
+        request = requests.get("http://{}/{}/{}/".format(ip, URI, mac), timeout=TIMEOUT)
         click.echo(request.json())
     except requests.exceptions.ConnectionError:
         click.echo("Communication issue with the device. No action performed")
@@ -223,9 +218,7 @@ def bulb():
 
 @bulb.command("on")
 @coro
-@click.option(
-    "--ip", prompt="IP address of the bulb", help="IP address of the bulb."
-)
+@click.option("--ip", prompt="IP address of the bulb", help="IP address of the bulb.")
 @click.option(
     "--mac", prompt="MAC address of the bulb", help="MAC address of the bulb."
 )
@@ -237,9 +230,7 @@ async def on(ip, mac):
 
 @bulb.command("color")
 @coro
-@click.option(
-    "--ip", prompt="IP address of the bulb", help="IP address of the bulb."
-)
+@click.option("--ip", prompt="IP address of the bulb", help="IP address of the bulb.")
 @click.option(
     "--mac", prompt="MAC address of the bulb", help="MAC address of the bulb."
 )
@@ -264,9 +255,7 @@ async def color(ip, mac, hue, saturation, value):
 
 @bulb.command("off")
 @coro
-@click.option(
-    "--ip", prompt="IP address of the bulb", help="IP address of the bulb."
-)
+@click.option("--ip", prompt="IP address of the bulb", help="IP address of the bulb.")
 @click.option(
     "--mac", prompt="MAC address of the bulb", help="MAC address of the bulb."
 )
@@ -278,9 +267,7 @@ async def off(ip, mac):
 
 @bulb.command("flash")
 @coro
-@click.option(
-    "--ip", prompt="IP address of the bulb", help="IP address of the bulb."
-)
+@click.option("--ip", prompt="IP address of the bulb", help="IP address of the bulb.")
 @click.option(
     "--mac", prompt="MAC address of the bulb", help="MAC address of the bulb."
 )
@@ -298,9 +285,7 @@ async def flash(ip, mac, time):
 
 @bulb.command("rainbow")
 @coro
-@click.option(
-    "--ip", prompt="IP address of the bulb", help="IP address of the bulb."
-)
+@click.option("--ip", prompt="IP address of the bulb", help="IP address of the bulb.")
 @click.option(
     "--mac", prompt="MAC address of the bulb", help="MAC address of the bulb."
 )

python_mystrom-2.4.0/pymystrom/device_types.py

@@ -0,0 +1,33 @@
+"""
+Device types.
+
+See https://api.mystrom.ch/#f37a4be7-0233-4d93-915e-c6f92656f129
+"""
+
+DEVICE_MAPPING_NUMERIC = {
+    101: "Switch CH v1",
+    102: "Bulb",
+    103: "Button+",
+    104: "Button",
+    105: "LED Strip",
+    106: "Switch CH v2",
+    107: "Switch EU",
+    110: "Motion Sensor",
+    113: "modulo® STECCO / CUBO",
+    118: "Button Plus 2nd",
+    120: "Switch Zero",
+}
+
+DEVICE_MAPPING_LITERAL = {
+    "WSW": DEVICE_MAPPING_NUMERIC[101],
+    "WRB": DEVICE_MAPPING_NUMERIC[102],
+    "WBP": DEVICE_MAPPING_NUMERIC[103],
+    "WBS": DEVICE_MAPPING_NUMERIC[104],
+    "WRS": DEVICE_MAPPING_NUMERIC[105],
+    "WS2": DEVICE_MAPPING_NUMERIC[106],
+    "WSE": DEVICE_MAPPING_NUMERIC[107],
+    "WMS": DEVICE_MAPPING_NUMERIC[110],
+    "WLL": DEVICE_MAPPING_NUMERIC[113],
+    "BP2": DEVICE_MAPPING_NUMERIC[118],
+    "LCS": DEVICE_MAPPING_NUMERIC[120],
+}

{python-mystrom-2.1.0 → python_mystrom-2.4.0}/pymystrom/discovery.py

@@ -1,13 +1,12 @@
 """Support for discovering myStrom devices."""
+
 import asyncio
 import logging
-from typing import Optional, List
+from typing import List, Optional
 
-_LOGGER = logging.getLogger(__name__)
+from .device_types import DEVICE_MAPPING_NUMERIC
 
-DEVICE_MAPPING = {
-    "102": "myStrom Bulb",
-}
+_LOGGER = logging.getLogger(__name__)
 
 
 class DiscoveredDevice(object):
@@ -23,19 +22,15 @@ class DiscoveredDevice(object):
     @staticmethod
     def create_from_announce_msg(raw_addr, announce_msg):
         """Create announce message."""
-        _LOGGER.debug(
-            "Received announce message '%s' from %s ", announce_msg, raw_addr
-        )
+        _LOGGER.debug("Received announce message '%s' from %s ", announce_msg, raw_addr)
         if len(announce_msg) != 8:
             raise RuntimeError("Unexpected announcement, '%s'" % announce_msg)
 
-        device = DiscoveredDevice(
-            host=raw_addr[0], mac=announce_msg[0:6].hex(":")
-        )
+        device = DiscoveredDevice(host=raw_addr[0], mac=announce_msg[0:6].hex(":"))
         device.type = announce_msg[6]
 
         if device.type == "102":
-            device.hardware = DEVICE_MAPPING[str(announce_msg[6])]
+            device.hardware = DEVICE_MAPPING_NUMERIC[int(announce_msg[6])]
         else:
             device.hardware = "non_mystrom"
         status = announce_msg[7]

{python-mystrom-2.1.0 → python_mystrom-2.4.0}/pymystrom/pir.py

@@ -1,7 +1,9 @@
 """Support for communicating with myStrom PIRs."""
+
+from typing import Any, Dict, Iterable, List, Optional, Union
+
 import aiohttp
 from yarl import URL
-from typing import Any, Dict, Iterable, List, Optional, Union
 
 from . import _request as request
 
@@ -11,9 +13,7 @@ URI_PIR = URL("api/v1/")
 class MyStromPir:
     """A class for a myStrom PIR."""
 
-    def __init__(
-        self, host: str, session: aiohttp.client.ClientSession = None
-    ) -> None:
+    def __init__(self, host: str, session: aiohttp.client.ClientSession = None) -> None:
         """Initialize the switch."""
         self._close_session = False
         self._host = host

python_mystrom-2.4.0/pymystrom/switch.py

@@ -0,0 +1,177 @@
+"""Support for communicating with myStrom plugs/switches."""
+
+from typing import Optional, Union
+
+import aiohttp
+from yarl import URL
+
+from . import _request as request
+from .device_types import DEVICE_MAPPING_LITERAL, DEVICE_MAPPING_NUMERIC
+
+
+class MyStromSwitch:
+    """A class for a myStrom switch/plug."""
+
+    def __init__(self, host: str, session: aiohttp.client.ClientSession = None) -> None:
+        """Initialize the switch."""
+        self._close_session = False
+        self._host = host
+        self._session = session
+        self._consumption = 0
+        self._consumedWs = 0
+        self._boot_id = None
+        self._energy_since_boot = None
+        self._time_since_boot = None
+        self._state = None
+        self._temperature = None
+        self._firmware = None
+        self._mac = None
+        self._device_type: Optional[Union[str, int]] = None
+        self.uri = URL.build(scheme="http", host=self._host)
+
+    async def turn_on(self) -> None:
+        """Turn the relay on."""
+        parameters = {"state": "1"}
+        url = URL(self.uri).join(URL("relay"))
+        await request(self, uri=url, params=parameters)
+        await self.get_state()
+
+    async def turn_off(self) -> None:
+        """Turn the relay off."""
+        parameters = {"state": "0"}
+        url = URL(self.uri).join(URL("relay"))
+        await request(self, uri=url, params=parameters)
+        await self.get_state()
+
+    async def toggle(self) -> None:
+        """Toggle the relay."""
+        url = URL(self.uri).join(URL("toggle"))
+        await request(self, uri=url)
+        await self.get_state()
+
+    async def get_state(self) -> None:
+        """Get the details from the switch/plug."""
+        url = URL(self.uri).join(URL("report"))
+        response = await request(self, uri=url)
+        try:
+            self._consumption = response["power"]
+        except KeyError:
+            self._consumption = None
+        try:
+            self._consumedWs = response["Ws"]
+        except KeyError:
+            self._consumedWs = None
+        try:
+            self._boot_id = response["boot_id"]
+        except KeyError:
+            self._boot_id = None
+        try:
+            self._energy_since_boot = response["energy_since_boot"]
+        except KeyError:
+            self._energy_since_boot = None
+        try:
+            self._time_since_boot = response["time_since_boot"]
+        except KeyError:
+            self._time_since_boot = None
+        self._state = response["relay"]
+        try:
+            self._temperature = response["temperature"]
+        except KeyError:
+            self._temperature = None
+
+        # Try the new API (Devices with newer firmware)
+        url = URL(self.uri).join(URL("api/v1/info"))
+        response = await request(self, uri=url)
+        if not isinstance(response, dict):
+            # Fall back to the old API version if the device runs with old firmware
+            url = URL(self.uri).join(URL("info.json"))
+            response = await request(self, uri=url)
+
+        self._firmware = response["version"]
+        self._mac = response["mac"]
+        self._device_type = response["type"]
+
+    @property
+    def device_type(self) -> Optional[str]:
+        """Return the device type as string (e.g. "Switch CH v1" or "Button+")."""
+        if isinstance(self._device_type, int):
+            return DEVICE_MAPPING_NUMERIC.get(self._device_type)
+        elif isinstance(self._device_type, str):
+            return DEVICE_MAPPING_LITERAL.get(self._device_type)
+        return None
+
+    @property
+    def relay(self) -> bool:
+        """Return the relay state."""
+        return bool(self._state)
+
+    @property
+    def consumption(self) -> Optional[float]:
+        """Return the current power consumption in mWh."""
+        if self._consumption is not None:
+            return round(self._consumption, 1)
+
+        return self._consumption
+
+    @property
+    def consumedWs(self) -> Optional[float]:
+        """The average of energy consumed per second since last report call."""
+        if self._consumedWs is not None:
+            return round(self._consumedWs, 1)
+
+        return self._consumedWs
+
+    @property
+    def boot_id(self) -> Optional[str]:
+        """A unique identifier to distinguish whether the energy counter has been reset."""
+        return self._boot_id
+
+    @property
+    def energy_since_boot(self) -> Optional[float]:
+        """The total energy in watt seconds (Ws) that has been measured since the last power-up or restart of the device."""
+        if self._energy_since_boot is not None:
+            return round(self._energy_since_boot, 2)
+
+        return self._energy_since_boot
+
+    @property
+    def time_since_boot(self) -> Optional[int]:
+        """The time in seconds that has elapsed since the last start or restart of the device."""
+        return self._time_since_boot
+
+    @property
+    def firmware(self) -> Optional[str]:
+        """Return the current firmware."""
+        return self._firmware
+
+    @property
+    def mac(self) -> Optional[str]:
+        """Return the MAC address."""
+        return self._mac
+
+    @property
+    def temperature(self) -> Optional[float]:
+        """Return the current temperature in Celsius."""
+        if self._temperature is not None:
+            return round(self._temperature, 1)
+
+        return self._temperature
+
+    async def get_temperature_full(self) -> str:
+        """Get current temperature in celsius."""
+        url = URL(self.uri).join(URL("temp"))
+        response = await request(self, uri=url)
+        return response
+
+    async def close(self) -> None:
+        """Close an open client session."""
+        if self._session and self._close_session:
+            await self._session.close()
+
+    async def __aenter__(self) -> "MyStromSwitch":
+        """Async enter."""
+        return self
+
+    async def __aexit__(self, *exc_info) -> None:
+        """Async exit."""
+        await self.close()

python_mystrom-2.4.0/pyproject.toml

@@ -0,0 +1,26 @@
+[tool.poetry]
+name = "python-mystrom"
+version = "2.4.0"
+description = "Asynchronous Python API client for interacting with myStrom devices"
+authors = ["Fabian Affolter <fabian@affolter-engineering.ch>"]
+license = "MIT"
+readme = "README.rst"
+homepage = "https://github.com/home-assistant-ecosystem/python-mystrom"
+repository = "https://github.com/home-assistant-ecosystem/python-mystrom"
+keywords = ["myStrom", "API", "client", "asynchronous"]
+packages = [
+    { include = "pymystrom" }
+]
+
+[tool.poetry.dependencies]
+python = ">=3.11"
+aiohttp = "*"
+click = "*"
+requests = "*"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.scripts]
+pymystrom = "pymystrom.cli:main"

python-mystrom-2.1.0/CHANGELOG.rst

@@ -1,69 +0,0 @@
-Changelog
-=========
-
-2.1.0 (2022-11-26)
-------------------
-
-- Add dd consumed energy to switch (thanks @OneCyrus)
-
-2.0.0 (2020-11-12)
-------------------
-
-- Update the CLI to work with the bulbs
-- Add support for Motion/PIR sensors
-- Add support for device discovery
-
-1.1.3 (2020-06-08)
-------------------
-
-- Improve temperature handling (Switch HW v2)
-
-1.1.2 (2020-04-12)
-------------------
-
-- Minor changes and fixes
-
-1.1.1 (2020-04-12)
-------------------
-
-- Fix typo
-
-
-1.1.1 (2020-04-11)
-------------------
-
-- Minor fixes
-
-1.1.0 (2020-04-10)
-------------------
-
-- Add new features for bulb
-- Add new features for switch/plug
-
-1.0.0 (2020-01-05)
-------------------
-
-- Full asynchronous now
-- Move to aiohttp
-- Update file header
-
-0.5.0 (2019-02-27)
-------------------
-
-- Add support for temperature provided by Switch v2
-
-0.4.4 (2018-06-07)
-------------------
-
-- Fix install_requires
-
-0.4.3 (2018-06-07)
-------------------
-
-- Update README
-
-0.4.2 (2018-03-27)
-------------------
-
-- Remove subprocess
-- Add CLI