Merge pull request #16 from plugwise/cleanup

Further cleanup

Author: bouwew

custom_components/plugwise_usb/__init__.py

@@ -189,7 +189,6 @@ class PlugwiseUSBEntity(Entity):
 
     entity_description: PlugwiseEntityDescription
 
-    # Github issue #265: the entity_description is not working accordingly
     def __init__(
         self, node: PlugwiseNode, entity_description: PlugwiseEntityDescription
     ) -> None:
@@ -203,9 +202,7 @@ def __init__(
             "sw_version": f"{node.firmware_version}",
         }
         self._attr_name = f"{entity_description.name} ({node.mac[-5:]})"
-        # Github issue #265
-        self._attr_should_poll = entity_description.should_poll  # type: ignore[attr-defined]
-        # /Github issue #265
+        self._attr_should_poll = entity_description.should_poll
         self._attr_unique_id = f"{node.mac}-{entity_description.key}"
         self._node = node
         self.entity_description = entity_description

custom_components/plugwise_usb/binary_sensor.py

@@ -7,10 +7,10 @@
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers import entity_platform
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
-from plugwise_usb.nodes import PlugwiseNode  # pw-beta usb
+from plugwise_usb.nodes import PlugwiseNode
 
-from . import PlugwiseUSBEntity  # pw-beta
-from .const import (  # pw-beta usb
+from . import PlugwiseUSBEntity
+from .const import (
     ATTR_SCAN_DAYLIGHT_MODE,
     ATTR_SCAN_RESET_TIMER,
     ATTR_SCAN_SENSITIVITY_MODE,
@@ -53,8 +53,7 @@ async def async_add_binary_sensors(mac: str):
             [
                 USBBinarySensor(api_stick.devices[mac], description)
                 for description in PW_BINARY_SENSOR_TYPES
-                if description.plugwise_api == STICK
-                and description.key in api_stick.devices[mac].features
+                if description.key in api_stick.devices[mac].features
             ]
         )
         if entities:
@@ -88,8 +87,6 @@ def discoved_device(mac: str):
     api_stick.subscribe_stick_callback(discoved_device, CB_NEW_NODE)
 
 
-# pw-beta
-# Github issue #265
 class USBBinarySensor(PlugwiseUSBEntity, BinarySensorEntity):  # type: ignore[misc]
     """Representation of a Plugwise USB Binary Sensor."""
 
@@ -102,8 +99,7 @@ def __init__(
     @property
     def is_on(self) -> bool:
         """Return true if the binary_sensor is on."""
-        # Github issue #265
-        return getattr(self._node, self.entity_description.state_request_method)  # type: ignore[attr-defined]
+        return getattr(self._node, self.entity_description.state_request_method)
 
     def _service_scan_config(self, **kwargs):
         """Service call to configure motion sensor of Scan device."""

custom_components/plugwise_usb/config_flow.py

@@ -3,43 +3,35 @@
 
 from typing import Any
 
-import serial.tools.list_ports  # pw-beta usb
+import serial.tools.list_ports
 import voluptuous as vol
 
-from homeassistant.components import usb  # pw-beta usb
+from homeassistant.components import usb
 from homeassistant.config_entries import ConfigFlow
 from homeassistant.const import CONF_BASE
 from homeassistant.core import callback
 from homeassistant.data_entry_flow import FlowResult
-from plugwise_usb import Stick  # pw-beta usb
+from plugwise_usb import Stick
+from plugwise_usb.exceptions import (
+    NetworkDown,
+    PortError,
+    StickInitError,
+    TimeoutException,
+)
 
-# pw-beta Note; the below are explicit through isort
-from plugwise_usb.exceptions import NetworkDown  # pw-beta usb
-from plugwise_usb.exceptions import PortError  # pw-beta usb
-from plugwise_usb.exceptions import StickInitError  # pw-beta usb
-from plugwise_usb.exceptions import TimeoutException  # pw-beta usb
-
-# pw-beta Note; the below are explicit through isort
-from .const import CONF_MANUAL_PATH  # pw-beta usb
-from .const import CONF_USB_PATH  # pw-beta usb
-from .const import DOMAIN
+from .const import CONF_MANUAL_PATH, CONF_USB_PATH, DOMAIN
 
 
 @callback
-def plugwise_stick_entries(hass):  # pw-beta usb
+def plugwise_stick_entries(hass):
     """Return existing connections for Plugwise USB-stick domain."""
     sticks = []
     for entry in hass.config_entries.async_entries(DOMAIN):
         sticks.append(entry.data.get(CONF_USB_PATH))
     return sticks
 
 
-# Github issue: #265
-# Might be a `tuple[dict[str, str], Stick | None]` for typing, but that throws
-# Item None of Optional[Any] not having attribute mac [union-attr]
-async def validate_usb_connection(
-    self, device_path=None
-) -> tuple[dict[str, str], Any]:  # pw-beta usb
+async def validate_usb_connection(self, device_path=None) -> tuple[dict[str, str], Any]:
     """Test if device_path is a real Plugwise USB-Stick."""
     errors = {}
 
@@ -71,7 +63,7 @@ class PlugwiseUSBConfigFlow(ConfigFlow, domain=DOMAIN):
 
     async def async_step_user(
         self, user_input: dict[str, Any] | None = None
-    ) -> FlowResult:  # pw-beta usb
+    ) -> FlowResult:
         """Step when user initializes a integration."""
         errors: dict[str, str] = {}
         ports = await self.hass.async_add_executor_job(serial.tools.list_ports.comports)
@@ -108,7 +100,7 @@ async def async_step_user(
 
     async def async_step_manual_path(
         self, user_input: dict[str, Any] | None = None
-    ) -> FlowResult:  # pw-beta usb
+    ) -> FlowResult:
         """Step when manual path to device."""
         errors: dict[str, str] = {}
         if user_input is not None:

custom_components/plugwise_usb/const.py

@@ -3,7 +3,7 @@
 import logging
 from typing import Final
 
-import voluptuous as vol  # pw-beta usb
+import voluptuous as vol
 
 from homeassistant.const import Platform
 from homeassistant.helpers import config_validation as cv
@@ -82,7 +82,7 @@
 SERVICE_USB_DEVICE_REMOVE: Final = "device_remove"
 SERVICE_USB_DEVICE_SCHEMA: Final = vol.Schema(
     {vol.Required(ATTR_MAC_ADDRESS): cv.string}
-)  # pw-beta usb
+)
 
 
 # USB Relay device constants

custom_components/plugwise_usb/manifest.json

@@ -8,6 +8,6 @@
   "integration_type": "hub",
   "iot_class": "local_polling",
   "loggers": ["plugwise_usb"],
-  "requirements": ["plugwise-usb==0.31.0a4"],
-  "version": "0.40.0a1"
+  "requirements": ["plugwise-usb==0.31.0"],
+  "version": "0.40.0a3"
 }

custom_components/plugwise_usb/models.py

@@ -22,64 +22,47 @@
 )
 from homeassistant.helpers.entity import EntityDescription
 
-from .const import STICK, USB_MOTION_ID, USB_RELAY_ID
+from .const import USB_MOTION_ID, USB_RELAY_ID
 
 
 @dataclass
-class PlugwiseRequiredKeysMixin:
-    """Mixin for required keys."""
-
-    plugwise_api: str
-
-
-@dataclass
-class PlugwiseEntityDescription(EntityDescription, PlugwiseRequiredKeysMixin):
+class PlugwiseEntityDescription(EntityDescription):
     """Generic Plugwise entity description."""
 
+    should_poll: bool = False
+    state_request_method: str = "dummy"
+
 
 @dataclass
 class PlugwiseSensorEntityDescription(
     SensorEntityDescription, PlugwiseEntityDescription
 ):
     """Describes Plugwise sensor entity."""
 
-    should_poll: bool = False
-    state_class: str | None = SensorStateClass.MEASUREMENT
-    state_request_method: str | None = None
-
 
 @dataclass
 class PlugwiseSwitchEntityDescription(
     SwitchEntityDescription, PlugwiseEntityDescription
 ):
     """Describes Plugwise switch entity."""
 
-    should_poll: bool = False
-    state_request_method: str | None = None
-
 
 @dataclass
 class PlugwiseBinarySensorEntityDescription(
     BinarySensorEntityDescription, PlugwiseEntityDescription
 ):
     """Describes Plugwise binary sensor entity."""
 
-    icon_off: str | None = None
-    should_poll: bool = False
-    state_request_method: str | None = None
-
 
 PW_SENSOR_TYPES: tuple[PlugwiseSensorEntityDescription, ...] = (
     PlugwiseSensorEntityDescription(
-        plugwise_api=STICK,
         key="power_1s",
         name="Power usage",
         device_class=SensorDeviceClass.POWER,
         native_unit_of_measurement=UnitOfPower.WATT,
         state_request_method="current_power_usage",
     ),
     PlugwiseSensorEntityDescription(
-        plugwise_api=STICK,
         key="energy_consumption_today",
         name="Energy consumption today",
         device_class=SensorDeviceClass.ENERGY,
@@ -88,7 +71,6 @@ class PlugwiseBinarySensorEntityDescription(
         state_request_method="energy_consumption_today",
     ),
     PlugwiseSensorEntityDescription(
-        plugwise_api=STICK,
         key="ping",
         name="Ping roundtrip",
         icon="mdi:speedometer",
@@ -98,7 +80,6 @@ class PlugwiseBinarySensorEntityDescription(
         entity_category=EntityCategory.DIAGNOSTIC,
     ),
     PlugwiseSensorEntityDescription(
-        plugwise_api=STICK,
         key="power_8s",
         name="Power usage 8 seconds",
         device_class=SensorDeviceClass.POWER,
@@ -107,7 +88,6 @@ class PlugwiseBinarySensorEntityDescription(
         entity_registry_enabled_default=False,
     ),
     PlugwiseSensorEntityDescription(
-        plugwise_api=STICK,
         key="RSSI_in",
         name="Inbound RSSI",
         device_class=SensorDeviceClass.SIGNAL_STRENGTH,
@@ -117,7 +97,6 @@ class PlugwiseBinarySensorEntityDescription(
         entity_category=EntityCategory.DIAGNOSTIC,
     ),
     PlugwiseSensorEntityDescription(
-        plugwise_api=STICK,
         key="RSSI_out",
         name="Outbound RSSI",
         device_class=SensorDeviceClass.SIGNAL_STRENGTH,
@@ -127,7 +106,6 @@ class PlugwiseBinarySensorEntityDescription(
         entity_category=EntityCategory.DIAGNOSTIC,
     ),
     PlugwiseSensorEntityDescription(
-        plugwise_api=STICK,
         key="power_con_cur_hour",
         name="Power consumption current hour",
         icon="mdi:lightning-bolt",
@@ -136,7 +114,6 @@ class PlugwiseBinarySensorEntityDescription(
         entity_registry_enabled_default=False,
     ),
     PlugwiseSensorEntityDescription(
-        plugwise_api=STICK,
         key="power_prod_cur_hour",
         name="Power production current hour",
         icon="mdi:lightning-bolt",
@@ -145,7 +122,6 @@ class PlugwiseBinarySensorEntityDescription(
         entity_registry_enabled_default=False,
     ),
     PlugwiseSensorEntityDescription(
-        plugwise_api=STICK,
         key="power_con_today",
         name="Power consumption today",
         icon="mdi:lightning-bolt",
@@ -154,7 +130,6 @@ class PlugwiseBinarySensorEntityDescription(
         entity_registry_enabled_default=False,
     ),
     PlugwiseSensorEntityDescription(
-        plugwise_api=STICK,
         key="power_con_prev_hour",
         name="Power consumption previous hour",
         icon="mdi:lightning-bolt",
@@ -164,7 +139,6 @@ class PlugwiseBinarySensorEntityDescription(
         entity_registry_enabled_default=False,
     ),
     PlugwiseSensorEntityDescription(
-        plugwise_api=STICK,
         key="power_con_yesterday",
         name="Power consumption yesterday",
         icon="mdi:lightning-bolt",
@@ -177,7 +151,6 @@ class PlugwiseBinarySensorEntityDescription(
 
 PW_SWITCH_TYPES: tuple[PlugwiseSwitchEntityDescription, ...] = (
     PlugwiseSwitchEntityDescription(
-        plugwise_api=STICK,
         key=USB_RELAY_ID,
         device_class=SwitchDeviceClass.OUTLET,
         name="Relay state",
@@ -187,7 +160,6 @@ class PlugwiseBinarySensorEntityDescription(
 
 PW_BINARY_SENSOR_TYPES: tuple[PlugwiseBinarySensorEntityDescription, ...] = (
     PlugwiseBinarySensorEntityDescription(
-        plugwise_api=STICK,
         key=USB_MOTION_ID,
         name="Motion",
         device_class=BinarySensorDeviceClass.MOTION,

custom_components/plugwise_usb/sensor.py

@@ -8,8 +8,8 @@
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 from plugwise_usb.nodes import PlugwiseNode
 
-from . import PlugwiseUSBEntity  # pw-beta usb
-from .const import CB_NEW_NODE, DOMAIN, STICK  # pw-beta usb
+from . import PlugwiseUSBEntity
+from .const import CB_NEW_NODE, DOMAIN, STICK
 from .models import PW_SENSOR_TYPES, PlugwiseSensorEntityDescription
 
 PARALLEL_UPDATES = 0
@@ -30,8 +30,7 @@ async def async_add_sensors(mac: str):
             [
                 USBSensor(api_stick.devices[mac], description)
                 for description in PW_SENSOR_TYPES
-                if description.plugwise_api == STICK
-                and description.key in api_stick.devices[mac].features
+                if description.key in api_stick.devices[mac].features
             ]
         )
         if entities:
@@ -48,8 +47,7 @@ def discoved_device(mac: str):
     api_stick.subscribe_stick_callback(discoved_device, CB_NEW_NODE)
 
 
-# Github issue #265
-class USBSensor(PlugwiseUSBEntity, SensorEntity):  # type: ignore[misc]  # pw-beta usb
+class USBSensor(PlugwiseUSBEntity, SensorEntity):  # type: ignore[misc]
     """Representation of a Plugwise USB sensor."""
 
     def __init__(
@@ -61,9 +59,7 @@ def __init__(
     @property
     def native_value(self) -> float | None:
         """Return the native value of the sensor."""
-        # Github issue #265
-        state_value = getattr(self._node, self.entity_description.state_request_method)  # type: ignore[attr-defined]
-        # /Github issue #265
+        state_value = getattr(self._node, self.entity_description.state_request_method)
         if state_value is not None:
             return float(round(state_value, 3))
         return None