Merge pull request #220 from plugwise/add_stick_2

Add Stick as device, use it as via_device for the connected devices

Author: bouwew

custom_components/plugwise_usb/__init__.py

@@ -3,22 +3,22 @@
 import logging
 from typing import Any, TypedDict
 
-from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant, callback
 from homeassistant.exceptions import ConfigEntryNotReady
-from homeassistant.helpers import entity_registry as er
+from homeassistant.helpers import device_registry as dr, entity_registry as er
 from homeassistant.helpers.storage import STORAGE_DIR
 from plugwise_usb import Stick
 from plugwise_usb.api import NodeEvent
 from plugwise_usb.exceptions import StickError
 
 from .const import (
     CONF_USB_PATH,
+    DOMAIN,
     NODES,
     PLUGWISE_USB_PLATFORMS,
     STICK,
 )
-from .coordinator import PlugwiseUSBDataUpdateCoordinator
+from .coordinator import PlugwiseUSBConfigEntry, PlugwiseUSBDataUpdateCoordinator
 
 _LOGGER = logging.getLogger(__name__)
 UNSUBSCRIBE_DISCOVERY = "unsubscribe_discovery"
@@ -31,7 +31,7 @@ class NodeConfigEntry(TypedDict):
     coordinator: PlugwiseUSBDataUpdateCoordinator
 
 
-async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry):
+async def async_setup_entry(hass: HomeAssistant, config_entry: PlugwiseUSBConfigEntry):
     """Establish connection with plugwise USB-stick."""
 
     @callback
@@ -60,6 +60,19 @@ def _async_migrate_entity_entry(
             f"Failed to open connection to Plugwise USB stick at {config_entry.data[CONF_USB_PATH]}"
         ) from StickError
 
+    device_registry = dr.async_get(hass)
+    device_registry.async_get_or_create(
+        config_entry_id=config_entry.entry_id,
+        connections={(dr.CONNECTION_ZIGBEE, str(api_stick.mac_stick))},
+        hw_version=str(api_stick.hardware),
+        identifiers={(DOMAIN, str(api_stick.mac_stick))},
+        manufacturer="Plugwise",
+        model="Stick",
+        name=str(api_stick.name),
+        serial_number=str(api_stick.mac_stick),
+        sw_version=str(api_stick.firmware),
+    )
+
     config_entry.runtime_data[NODES]: NodeConfigEntry = {}
 
     async def async_node_discovered(node_event: NodeEvent, mac: str) -> None:
@@ -69,7 +82,7 @@ async def async_node_discovered(node_event: NodeEvent, mac: str) -> None:
         _LOGGER.debug("async_node_discovered | mac=%s", mac)
         node = api_stick.nodes[mac]
         _LOGGER.debug("async_node_discovered | node_info=%s", node.node_info)
-        coordinator = PlugwiseUSBDataUpdateCoordinator(hass, node)
+        coordinator = PlugwiseUSBDataUpdateCoordinator(hass, config_entry, node)
         config_entry.runtime_data[NODES][mac] = coordinator
         await node.load()
 
@@ -94,10 +107,11 @@ async def async_node_discovered(node_event: NodeEvent, mac: str) -> None:
 
     # Initiate background discovery task
     hass.async_create_task(api_stick.discover_nodes(load=True))
+
     return True
 
 
-async def async_unload_entry(hass: HomeAssistant, config_entry: ConfigEntry):
+async def async_unload_entry(hass: HomeAssistant, config_entry: PlugwiseUSBConfigEntry):
     """Unload the Plugwise USB stick connection."""
     config_entry.runtime_data[UNSUBSCRIBE_DISCOVERY]()
     unload = await hass.config_entries.async_unload_platforms(
@@ -109,7 +123,7 @@ async def async_unload_entry(hass: HomeAssistant, config_entry: ConfigEntry):
 
 @callback
 def async_migrate_entity_entry(
-    config_entry: ConfigEntry, entity_entry: er.RegistryEntry
+    config_entry: PlugwiseUSBConfigEntry, entity_entry: er.RegistryEntry
 ) -> dict[str, Any] | None:
     """Migrate Plugwise USB entity entries.
 

custom_components/plugwise_usb/binary_sensor.py

@@ -11,13 +11,13 @@
     BinarySensorEntity,
     BinarySensorEntityDescription,
 )
-from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import Platform
 from homeassistant.core import HomeAssistant, callback
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 from plugwise_usb.api import NodeEvent, NodeFeature
 
 from .const import NODES, STICK, UNSUB_NODE_LOADED
+from .coordinator import PlugwiseUSBConfigEntry
 from .entity import PlugwiseUSBEntity, PlugwiseUSBEntityDescription
 
 _LOGGER = logging.getLogger(__name__)
@@ -47,7 +47,7 @@ class PlugwiseBinarySensorEntityDescription(
 
 async def async_setup_entry(
     _hass: HomeAssistant,
-    config_entry: ConfigEntry,
+    config_entry: PlugwiseUSBConfigEntry,
     async_add_entities: AddEntitiesCallback,
 ) -> None:
     """Set up Plugwise USB binary sensor based on config_entry."""
@@ -90,7 +90,7 @@ async def async_add_binary_sensor(node_event: NodeEvent, mac: str) -> None:
 
 async def async_unload_entry(
     _hass: HomeAssistant,
-    config_entry: ConfigEntry,
+    config_entry: PlugwiseUSBConfigEntry,
 ) -> None:
     """Unload a config entry."""
     config_entry.runtime_data[Platform.SENSOR][UNSUB_NODE_LOADED]()

custom_components/plugwise_usb/coordinator.py

@@ -5,6 +5,7 @@
 import logging
 from typing import Any
 
+from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.update_coordinator import (
     ConfigEntryError,
@@ -14,15 +15,22 @@
 from plugwise_usb.api import NodeFeature, PlugwiseNode
 from plugwise_usb.exceptions import NodeError, NodeTimeout, StickError, StickTimeout
 
+from .const import STICK
+
 _LOGGER = logging.getLogger(__name__)
 
+type PlugwiseUSBConfigEntry = ConfigEntry[PlugwiseUSBDataUpdateCoordinator]
+
 
 class PlugwiseUSBDataUpdateCoordinator(DataUpdateCoordinator):
     """Class to manage fetching data from a Plugwise node."""
 
+    config_entry: PlugwiseUSBConfigEntry
+
     def __init__(
         self,
         hass: HomeAssistant,
+        config_entry: PlugwiseUSBConfigEntry,
         node: PlugwiseNode,
         update_interval: timedelta | None = None,
     ) -> None:
@@ -33,6 +41,7 @@ def __init__(
             super().__init__(
                 hass,
                 _LOGGER,
+                config_entry=config_entry,
                 name=node.node_info.name,
                 update_method=self.async_node_update,
                 always_update=True,
@@ -50,6 +59,8 @@ def __init__(
                 always_update=True,
             )
 
+        self.api_stick = config_entry.runtime_data[STICK]
+
     async def async_node_update(self) -> dict[NodeFeature, Any]:
         """Request status update for Plugwise Node."""
         states: dict[NodeFeature, Any] = {}
@@ -72,4 +83,5 @@ async def async_node_update(self) -> dict[NodeFeature, Any]:
             and not states[NodeFeature.AVAILABLE].state
         ):
             raise UpdateFailed("Device is not responding")
+
         return states

custom_components/plugwise_usb/entity.py

@@ -7,6 +7,7 @@
 import logging
 from typing import Any
 
+from homeassistant.helpers.device_registry import CONNECTION_ZIGBEE, DeviceInfo
 from homeassistant.helpers.entity import EntityDescription
 from homeassistant.helpers.update_coordinator import CoordinatorEntity
 from plugwise_usb.api import PUSHING_FEATURES, NodeFeature, NodeInfo
@@ -35,22 +36,35 @@ def __init__(
         entity_description: PlugwiseUSBEntityDescription,
     ) -> None:
         """Initialize a Plugwise USB entity."""
-        self.node_duc = node_duc
         super().__init__(node_duc, context=entity_description.node_feature)
+        self.node_duc = node_duc
+        self.entity_description = entity_description
+        self.unsubscribe_push_events: Callable[[], None] | None = None
         self._node_info: NodeInfo = node_duc.node.node_info
-        self._attr_device_info = {
-            "identifiers": {(DOMAIN, self._node_info.mac)},
-            "hw_version": self._node_info.version,
-            "name": f"{self._node_info.name}",
-            "manufacturer": "Plugwise",
-            "model": self._node_info.model,
-            "model_id": self._node_info.model_type,
-            "sw_version": f"{self._node_info.firmware}",
-        }
         self._attr_unique_id = f"{self._node_info.mac}-{entity_description.key}"
-        self.entity_description = entity_description
         self._subscribe_to_feature_fn = node_duc.node.subscribe_to_feature_update
-        self.unsubscribe_push_events: Callable[[], None] | None = None
+        self._via_device = (DOMAIN, str(node_duc.api_stick.mac_stick))
+
+    @property
+    def available(self) -> bool:
+        """Return if entity is available."""
+        return self.node_duc.node.available and super().available
+
+    @property
+    def device_info(self) -> DeviceInfo:
+        """Return DeviceInfo for each created entity."""
+        return DeviceInfo(
+            connections={(CONNECTION_ZIGBEE, str(self._node_info.mac))},
+            hw_version=str(self._node_info.version),
+            identifiers={(DOMAIN, str(self._node_info.mac))},
+            manufacturer="Plugwise",
+            model=str(self._node_info.model),
+            model_id=self._node_info.model_type,
+            name=str(self._node_info.name),
+            serial_number=str(self._node_info.mac),
+            sw_version=str(self._node_info.firmware),
+            via_device=self._via_device,
+        )
 
     async def async_added_to_hass(self):
         """Subscribe for push updates."""

custom_components/plugwise_usb/manifest.json

@@ -8,8 +8,6 @@
   "integration_type": "hub",
   "iot_class": "local_polling",
   "loggers": ["plugwise_usb"],
-  "requirements": [
-    "https://test-files.pythonhosted.org/packages/d0/05/f52b59d222cd857284b00aa77e237ffdd25acc8955b5ebc2ff411822448b/plugwise_usb-0.40.0a27.tar.gz#plugwise-usb==0.40.0a27"
-  ],
-  "version": "0.50.0a11"
+  "requirements": ["plugwise-usb==0.40.0b1"],
+  "version": "0.50.0a21"
 }

custom_components/plugwise_usb/number.py

@@ -11,14 +11,13 @@
     NumberEntity,
     NumberEntityDescription,
 )
-from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import EntityCategory, Platform, UnitOfTime
 from homeassistant.core import HomeAssistant, callback
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 from plugwise_usb.api import NodeEvent, NodeFeature
 
 from .const import NODES, STICK, UNSUB_NODE_LOADED
-from .coordinator import PlugwiseUSBDataUpdateCoordinator
+from .coordinator import PlugwiseUSBConfigEntry, PlugwiseUSBDataUpdateCoordinator
 from .entity import PlugwiseUSBEntity, PlugwiseUSBEntityDescription
 
 _LOGGER = logging.getLogger(__name__)
@@ -102,7 +101,7 @@ class PlugwiseNumberEntityDescription(
 
 async def async_setup_entry(
     hass: HomeAssistant,
-    config_entry: ConfigEntry,
+    config_entry: PlugwiseUSBConfigEntry,
     async_add_entities: AddEntitiesCallback,
 ) -> None:
     """Set up the USB Number from a config entry."""
@@ -143,7 +142,7 @@ async def async_add_number(node_event: NodeEvent, mac: str) -> None:
 
 async def async_unload_entry(
     hass: HomeAssistant,
-    config_entry: ConfigEntry,
+    config_entry: PlugwiseUSBConfigEntry,
 ) -> None:
     """Unload a config entry."""
     config_entry.runtime_data[Platform.NUMBER][UNSUB_NODE_LOADED]()

custom_components/plugwise_usb/sensor.py

@@ -12,7 +12,6 @@
     SensorEntityDescription,
     SensorStateClass,
 )
-from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import (
     PERCENTAGE,
     SIGNAL_STRENGTH_DECIBELS_MILLIWATT,
@@ -28,6 +27,7 @@
 from plugwise_usb.api import NodeEvent, NodeFeature
 
 from .const import NODES, STICK, UNSUB_NODE_LOADED
+from .coordinator import PlugwiseUSBConfigEntry
 from .entity import PlugwiseUSBEntity, PlugwiseUSBEntityDescription
 
 _LOGGER = logging.getLogger(__name__)
@@ -72,6 +72,16 @@ class PlugwiseSensorEntityDescription(
         node_feature=NodeFeature.ENERGY,
         entity_registry_enabled_default=False,
     ),
+    PlugwiseSensorEntityDescription(
+        key="hour_production",
+        translation_key="energy_hour_production",
+        device_class=SensorDeviceClass.ENERGY,
+        state_class=SensorStateClass.TOTAL,
+        native_unit_of_measurement=UnitOfEnergy.KILO_WATT_HOUR,
+        suggested_display_precision=3,
+        node_feature=NodeFeature.ENERGY,
+        entity_registry_enabled_default=False,
+    ),
     PlugwiseSensorEntityDescription(
         key="day_consumption",
         translation_key="energy_day_consumption",
@@ -81,6 +91,16 @@ class PlugwiseSensorEntityDescription(
         suggested_display_precision=3,
         node_feature=NodeFeature.ENERGY,
     ),
+    PlugwiseSensorEntityDescription(
+        key="day_production",
+        translation_key="energy_day_production",
+        device_class=SensorDeviceClass.ENERGY,
+        state_class=SensorStateClass.TOTAL,
+        native_unit_of_measurement=UnitOfEnergy.KILO_WATT_HOUR,
+        suggested_display_precision=3,
+        node_feature=NodeFeature.ENERGY,
+        entity_registry_enabled_default=False,
+    ),
     PlugwiseSensorEntityDescription(
         key="rtt",
         translation_key="ping_rrt",
@@ -135,7 +155,6 @@ class PlugwiseSensorEntityDescription(
         key="last_seen",
         translation_key="last_seen",
         device_class=SensorDeviceClass.TIMESTAMP,
-        state_class=SensorStateClass.MEASUREMENT,
         node_feature=NodeFeature.AVAILABLE,
         entity_registry_enabled_default=False,
         entity_category=EntityCategory.DIAGNOSTIC,
@@ -145,7 +164,7 @@ class PlugwiseSensorEntityDescription(
 
 async def async_setup_entry(
     _hass: HomeAssistant,
-    config_entry: ConfigEntry,
+    config_entry: PlugwiseUSBConfigEntry,
     async_add_entities: AddEntitiesCallback,
 ) -> None:
     """Set up Plugwise USB sensor based on config_entry."""
@@ -190,7 +209,7 @@ async def async_add_sensor(node_event: NodeEvent, mac: str) -> None:
 
 async def async_unload_entry(
     _hass: HomeAssistant,
-    config_entry: ConfigEntry,
+    config_entry: PlugwiseUSBConfigEntry,
 ) -> None:
     """Unload a config entry."""
     config_entry.runtime_data[Platform.SENSOR][UNSUB_NODE_LOADED]()

custom_components/plugwise_usb/strings.json

@@ -115,6 +115,12 @@
       "energy_day_consumption": {
         "name": "Energy consumption today"
       },
+      "energy_hour_production": {
+        "name": "Energy production this hour"
+      },
+      "energy_day_production": {
+        "name": "Energy production today"
+      },
       "last_seen": {
         "name": "Last seen"
       },

custom_components/plugwise_usb/switch.py

@@ -11,14 +11,13 @@
     SwitchEntity,
     SwitchEntityDescription,
 )
-from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import EntityCategory, Platform
 from homeassistant.core import HomeAssistant, callback
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 from plugwise_usb.api import NodeEvent, NodeFeature
 
 from .const import NODES, STICK, UNSUB_NODE_LOADED
-from .coordinator import PlugwiseUSBDataUpdateCoordinator
+from .coordinator import PlugwiseUSBConfigEntry, PlugwiseUSBDataUpdateCoordinator
 from .entity import PlugwiseUSBEntity, PlugwiseUSBEntityDescription
 
 _LOGGER = logging.getLogger(__name__)
@@ -66,7 +65,7 @@ class PlugwiseSwitchEntityDescription(
 
 async def async_setup_entry(
     _hass: HomeAssistant,
-    config_entry: ConfigEntry,
+    config_entry: PlugwiseUSBConfigEntry,
     async_add_entities: AddEntitiesCallback,
 ) -> None:
     """Set up the USB switches from a config entry."""
@@ -107,7 +106,7 @@ async def async_add_switch(node_event: NodeEvent, mac: str) -> None:
 
 async def async_unload_entry(
     _hass: HomeAssistant,
-    config_entry: ConfigEntry,
+    config_entry: PlugwiseUSBConfigEntry,
 ) -> None:
     """Unload a config entry."""
     config_entry.runtime_data[Platform.SWITCH][UNSUB_NODE_LOADED]()