sc-smart-device 3.2.0__tar.gz → 3.2.2__tar.gz

{sc_smart_device-3.2.0 → sc_smart_device-3.2.2}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: sc-smart-device
-Version: 3.2.0
+Version: 3.2.2
 Summary: Provides a simple, consistent access to Shelly and Tasmota smart switches and energy meters.
-Project-URL: Homepage, https://github.com/NickElseySpelloC
-Project-URL: Repository, https://github.com/NickElseySpelloC/sc-smart-device
+Project-URL: Homepage, https://github.com/Spello-Consulting
+Project-URL: Repository, https://github.com/Spello-Consulting/sc-smart-device
 Requires-Python: >=3.13
 Description-Content-Type: text/markdown
-Requires-Dist: sc-foundation-services>=3.0.3
+Requires-Dist: sc-foundation-services>=3.0.4
 Requires-Dist: requests>=2.32.0
 Provides-Extra: dev
 Requires-Dist: pytest>=8.3.5; extra == "dev"
@@ -27,7 +27,7 @@ Requires-Dist: sc-smart-device[dev,docs]; extra == "all"
 
 Provides a simple, consistent access to Shelly and Tasmota smart switches and energy meters.
 
-Please see the [GitHub pages](https://nickelseyspelloc.github.io/sc-smart-device/) for complete documentation.
+Please see the [GitHub pages](https://spello-consulting.github.io/sc-smart-device/) for complete documentation.
 
 ## Development Environment
 

{sc_smart_device-3.2.0 → sc_smart_device-3.2.2}/README.md

@@ -2,7 +2,7 @@
 
 Provides a simple, consistent access to Shelly and Tasmota smart switches and energy meters.
 
-Please see the [GitHub pages](https://nickelseyspelloc.github.io/sc-smart-device/) for complete documentation.
+Please see the [GitHub pages](https://spello-consulting.github.io/sc-smart-device/) for complete documentation.
 
 ## Development Environment
 

{sc_smart_device-3.2.0 → sc_smart_device-3.2.2}/pyproject.toml

@@ -4,12 +4,12 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "sc-smart-device"
-version = "3.2.0"
+version = "3.2.2"
 description = "Provides a simple, consistent access to Shelly and Tasmota smart switches and energy meters."
 readme = "README.md"
 requires-python = ">=3.13"
 dependencies = [
-    "sc-foundation-services>=3.0.3",
+    "sc-foundation-services>=3.0.4",
     "requests>=2.32.0",
 ]
 
@@ -33,8 +33,8 @@ all = [
 ]
 
 [project.urls]
-Homepage = "https://github.com/NickElseySpelloC"
-Repository = "https://github.com/NickElseySpelloC/sc-smart-device"
+Homepage = "https://github.com/Spello-Consulting"
+Repository = "https://github.com/Spello-Consulting/sc-smart-device"
 
 [tool.setuptools]
 package-dir = { "" = "src" }

{sc_smart_device-3.2.0 → sc_smart_device-3.2.2}/src/sc_smart_device/providers/shelly_provider.py

@@ -65,6 +65,7 @@ class ShellyProvider(BaseProvider):
         self.webhook_server: ThreadingHTTPServer | None = None
 
         # Model library (populated by _import_models)
+        self.provider_name = "shelly"
         self.models: list[dict] = []
         self._import_models()
 
@@ -1280,7 +1281,7 @@ class ShellyProvider(BaseProvider):
         if device.get("Protocol") == "RPC":
             caps.add(DeviceCapability.WEBHOOKS)
             caps.add(DeviceCapability.DEVICE_LOCATION)
-        return {
+        base = {
             "ID": device["ID"],
             "Name": device["Name"],
             "Online": device.get("Online", False),
@@ -1291,6 +1292,11 @@ class ShellyProvider(BaseProvider):
             "TotalEnergy": device.get("TotalEnergy", 0.0),
             "Capabilities": caps,
         }
+        internal = {"customkeylist", "Outputs", "Inputs", "Meters", "TempProbes"}
+        for key, value in device.items():
+            if key not in base and key not in internal:
+                base[key] = value
+        return base
 
     @staticmethod
     def _normalize_component(component: dict) -> dict:
@@ -1317,4 +1323,8 @@ class ShellyProvider(BaseProvider):
         elif obj_type == "temp_probe":
             base["Temperature"] = component.get("Temperature")
             base["LastReadingTime"] = component.get("LastReadingTime")
+        internal = {"customkeylist"}
+        for key, value in component.items():
+            if key not in base and key not in internal:
+                base[key] = value
         return base

{sc_smart_device-3.2.0 → sc_smart_device-3.2.2}/src/sc_smart_device/providers/tasmota_provider.py

@@ -50,6 +50,8 @@ class TasmotaProvider(BaseProvider):
         self.ping_allowed = True
         self.simulation_file_folder: Path | None = None
 
+        self.provider_name = "tasmota"
+
     @staticmethod
     def _raise_runtime_error(message: str) -> NoReturn:
         raise RuntimeError(message)
@@ -185,7 +187,10 @@ class TasmotaProvider(BaseProvider):
         return None
 
     def print_model_library(self, _mode_str: str = "brief", _model_id: str | None = None) -> str:  # noqa: PLR6301
-        return ""  # Tasmota has no model file — config-driven
+        lines = ["Tasmota Model Library:"]
+        lines.append("  Tasmota")
+        return "\n".join(lines)
+
 
     def print_device_status(self, device_identity: int | str | None = None) -> str:
         device_index = None
@@ -666,7 +671,7 @@ class TasmotaProvider(BaseProvider):
             caps.add(DeviceCapability.TEMPERATURE)
         if device.get("Simulate"):
             caps.add(DeviceCapability.SIMULATION)
-        return {
+        base = {
             "ID": device["ID"],
             "Name": device["Name"],
             "Online": device.get("Online", False),
@@ -677,6 +682,11 @@ class TasmotaProvider(BaseProvider):
             "TotalEnergy": device.get("TotalEnergy", 0.0),
             "Capabilities": caps,
         }
+        internal = {"customkeylist", "Outputs", "Inputs", "Meters", "TempProbes", "Tasmota"}
+        for key, value in device.items():
+            if key not in base and key not in internal:
+                base[key] = value
+        return base
 
     @staticmethod
     def _normalize_component(component: dict) -> dict:
@@ -700,6 +710,10 @@ class TasmotaProvider(BaseProvider):
         elif obj_type == "temp_probe":
             base["Temperature"] = component.get("Temperature")
             base["LastReadingTime"] = component.get("LastReadingTime")
+        internal = {"customkeylist"}
+        for key, value in component.items():
+            if key not in base and key not in internal:
+                base[key] = value
         return base
 
 # ── Helpers ───────────────────────────────────────────────────────────────────

{sc_smart_device-3.2.0 → sc_smart_device-3.2.2}/src/sc_smart_device/shelly_models.json

@@ -83,7 +83,7 @@
     "protocol": "RPC",
     "inputs": 2,
     "outputs": 1,
-    "meters": 2,
+    "meters": 1,
     "meters_seperate": false,
     "temperature_monitoring": true
   },

{sc_smart_device-3.2.0 → sc_smart_device-3.2.2}/src/sc_smart_device/smart_device.py

@@ -488,7 +488,7 @@ class SCSmartDevice:  # noqa: PLR0904
     ) -> None:
         """Install a webhook on a device component.
 
-        See https://nickelseyspelloc.github.io/sc-smart-device/shelly_webhooks/ for details on supported events and payloads.
+        See https://spello-consulting.github.io/sc-smart-device/shelly_webhooks/ for details on supported events and payloads.
 
         Args:
             event: Shelly event name, e.g. ``"input.toggle_on"``.
@@ -584,17 +584,19 @@ class SCSmartDevice:  # noqa: PLR0904
         parts = [p.print_device_status() for p in self._providers if p.get_normalized_status().devices]
         return "\n".join(part for part in parts if part)
 
-    def print_model_library(self, mode_str: str = "brief", model_id: str | None = None) -> str:
+    def print_model_library(self, mode_str: str = "brief", model_id: str | None = None, provider_id: str | None = None) -> str:
         """Prints the model library for all providers that have one.
 
         Args:
             mode_str (str, optional): The mode of printing. Can be "brief" or "detailed". Defaults to "brief".
             model_id (Optional (str), optional): If provided, filters the models by this model name. If None, prints all models.
+            provider_id (Optional (str), optional): If provided, filters the models by this provider name ('shelly' or 'tasmota'). If None, prints models from all providers.
 
         Returns:
             library_info (str): A string representation of the model library.
         """
-        parts = [p.print_model_library(mode_str, model_id) for p in self._providers]
+        provider_id = provider_id.lower() if provider_id else None
+        parts = [p.print_model_library(mode_str, model_id) for p in self._providers if (not provider_id or getattr(p, "provider_name", "").lower() == provider_id)]
         return "\n".join(part for part in parts if part)
 
     # ── Lifecycle ────────────────────────────────────────────────────────────

{sc_smart_device-3.2.0 → sc_smart_device-3.2.2}/src/sc_smart_device/smart_device_worker.py

@@ -231,6 +231,81 @@ class SmartDeviceWorker:
         )
         return self.submit(req)
 
+    # ── SCSmartDevice pass-throughs ──────────────────────────────────────────
+
+    def is_device_online(self, device_identity: dict | int | str | None = None) -> bool:
+        """See if a device is alive by pinging it.
+
+        Returns the result and updates the device's online status. If we are in simulation mode, always returns True.
+
+        Args:
+            device_identity: The actual device object, device component object, device ID or device name of the device to check. If None, checks all devices.
+
+        Returns:
+            True if the device is online, False otherwise. If all devices are checked, returns True if all devices are online.
+
+        Raises:
+            RuntimeError: If the device is not found in the list of devices.
+        """  # noqa: DOC502
+        return self._smart_device.is_device_online(device_identity)
+
+    def pull_webhook_event(self) -> dict | None:
+        """Return the oldest queued webhook event and remove it from the queue.
+
+        Returns:
+            Event dict with keys ``timestamp``, ``Event``, ``Device``,
+            ``Component``, etc.; or None if the queue is empty.
+        """
+        return self._smart_device.pull_webhook_event()
+
+    def does_device_have_webhooks(self, device: dict) -> bool:
+        """Return True if any component of the device has webhooks enabled."""
+        return self._smart_device.does_device_have_webhooks(device)
+
+    def get_device_information(
+        self, device_identity: dict | int | str, refresh_status: bool = False
+    ) -> dict:
+        """Return a consolidated copy of one device and all its components.
+
+        Args:
+            device_identity: Device dict, ID, or name.
+            refresh_status: If True, fetch fresh state from hardware first.
+
+        Returns:
+            Device dict augmented with ``Inputs``, ``Outputs``, ``Meters``,
+            and ``TempProbes`` sub-lists.
+
+        Raises:
+            RuntimeError: If the device is not found in the list of devices or if there is an error getting the status.
+        """  # noqa: DOC502
+        return self._smart_device.get_device_information(device_identity, refresh_status)
+
+    def print_device_status(self, device_identity: int | str | None = None) -> str:
+        """Print the status of a device or all devices.
+
+        Args:
+            device_identity: The ID or name of the device to check. If None, checks all devices.
+
+        Returns:
+            A string representation of the device status.
+
+        Raises:
+            RuntimeError: If the device is not found in the list of devices.
+        """  # noqa: DOC502
+        return self._smart_device.print_device_status(device_identity)
+
+    def print_model_library(self, mode_str: str = "brief", model_id: str | None = None) -> str:
+        """Print the model library for all providers that have one.
+
+        Args:
+            mode_str: The mode of printing. Can be ``"brief"`` or ``"detailed"``. Defaults to ``"brief"``.
+            model_id: If provided, filters the models by this model name. If None, prints all models.
+
+        Returns:
+            A string representation of the model library.
+        """
+        return self._smart_device.print_model_library(mode_str, model_id)
+
     # ── Worker loop ──────────────────────────────────────────────────────────
 
     def run(self) -> None:

{sc_smart_device-3.2.0 → sc_smart_device-3.2.2}/src/sc_smart_device.egg-info/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: sc-smart-device
-Version: 3.2.0
+Version: 3.2.2
 Summary: Provides a simple, consistent access to Shelly and Tasmota smart switches and energy meters.
-Project-URL: Homepage, https://github.com/NickElseySpelloC
-Project-URL: Repository, https://github.com/NickElseySpelloC/sc-smart-device
+Project-URL: Homepage, https://github.com/Spello-Consulting
+Project-URL: Repository, https://github.com/Spello-Consulting/sc-smart-device
 Requires-Python: >=3.13
 Description-Content-Type: text/markdown
-Requires-Dist: sc-foundation-services>=3.0.3
+Requires-Dist: sc-foundation-services>=3.0.4
 Requires-Dist: requests>=2.32.0
 Provides-Extra: dev
 Requires-Dist: pytest>=8.3.5; extra == "dev"
@@ -27,7 +27,7 @@ Requires-Dist: sc-smart-device[dev,docs]; extra == "all"
 
 Provides a simple, consistent access to Shelly and Tasmota smart switches and energy meters.
 
-Please see the [GitHub pages](https://nickelseyspelloc.github.io/sc-smart-device/) for complete documentation.
+Please see the [GitHub pages](https://spello-consulting.github.io/sc-smart-device/) for complete documentation.
 
 ## Development Environment
 

{sc_smart_device-3.2.0 → sc_smart_device-3.2.2}/src/sc_smart_device.egg-info/requires.txt

@@ -1,4 +1,4 @@
-sc-foundation-services>=3.0.3
+sc-foundation-services>=3.0.4
 requests>=2.32.0
 
 [all]

{sc_smart_device-3.2.0 → sc_smart_device-3.2.2}/tests/test_get_x_value.py

@@ -46,8 +46,8 @@ def test_view_get_output_value_missing_key():
     """get_output_value() should return the default for absent keys (e.g. custom keys)."""
     view = smart_device.get_view()
     output_id = view.get_output_id(OUTPUT_1_NAME)
-    assert view.get_output_value(output_id, "Group") is None
-    assert view.get_output_value(output_id, "Group", "Ungrouped") == "Ungrouped"
+    assert view.get_output_value(output_id, "XXX") is None
+    assert view.get_output_value(output_id, "XXX", "Ungrouped") == "Ungrouped"
 
 
 def test_view_get_output_value_invalid_id():