batt control

Signed-off-by: Daniel Hjelseth Høyer <github@dahoiv.net>

homeassistant/components/homevolt/__init__.py

@@ -10,7 +10,7 @@ from homeassistant.helpers.aiohttp_client import async_get_clientsession
 
 from .coordinator import HomevoltConfigEntry, HomevoltDataUpdateCoordinator
 
-PLATFORMS: list[Platform] = [Platform.SENSOR]
+PLATFORMS: list[Platform] = [Platform.SENSOR, Platform.SWITCH]
 
 
 async def async_setup_entry(hass: HomeAssistant, entry: HomevoltConfigEntry) -> bool:

homeassistant/components/homevolt/entity.py

@@ -0,0 +1,64 @@
+"""Shared entity helpers for Homevolt."""
+
+from __future__ import annotations
+
+from collections.abc import Callable, Coroutine
+from typing import Any, Concatenate
+
+from homevolt import HomevoltAuthenticationError, HomevoltConnectionError, HomevoltError
+
+from homeassistant.exceptions import ConfigEntryAuthFailed, HomeAssistantError
+from homeassistant.helpers.device_registry import DeviceInfo
+from homeassistant.helpers.update_coordinator import CoordinatorEntity
+
+from .const import DOMAIN, MANUFACTURER
+from .coordinator import HomevoltDataUpdateCoordinator
+
+
+class HomevoltEntity(CoordinatorEntity[HomevoltDataUpdateCoordinator]):
+    """Base Homevolt entity."""
+
+    _attr_has_entity_name = True
+
+    def __init__(
+        self, coordinator: HomevoltDataUpdateCoordinator, device_identifier: str
+    ) -> None:
+        """Initialize the Homevolt entity."""
+        super().__init__(coordinator)
+        device_id = coordinator.data.unique_id
+        device_metadata = coordinator.data.device_metadata.get(device_identifier)
+        self._attr_device_info = DeviceInfo(
+            identifiers={(DOMAIN, f"{device_id}_{device_identifier}")},
+            configuration_url=coordinator.client.base_url,
+            manufacturer=MANUFACTURER,
+            model=device_metadata.model if device_metadata else None,
+            name=device_metadata.name if device_metadata else None,
+        )
+
+
+def homevolt_exception_handler[_HomevoltEntityT: HomevoltEntity, **_P](
+    func: Callable[Concatenate[_HomevoltEntityT, _P], Coroutine[Any, Any, Any]],
+) -> Callable[Concatenate[_HomevoltEntityT, _P], Coroutine[Any, Any, None]]:
+    """Decorate Homevolt calls to handle exceptions."""
+
+    async def handler(
+        self: _HomevoltEntityT, *args: _P.args, **kwargs: _P.kwargs
+    ) -> None:
+        try:
+            await func(self, *args, **kwargs)
+        except HomevoltAuthenticationError as error:
+            raise ConfigEntryAuthFailed("Authentication failed") from error
+        except HomevoltConnectionError as error:
+            raise HomeAssistantError(
+                translation_domain=DOMAIN,
+                translation_key="communication_error",
+                translation_placeholders={"error": str(error)},
+            ) from error
+        except HomevoltError as error:
+            raise HomeAssistantError(
+                translation_domain=DOMAIN,
+                translation_key="unknown_error",
+                translation_placeholders={"error": str(error)},
+            ) from error
+
+    return handler

homeassistant/components/homevolt/manifest.json

@@ -7,7 +7,7 @@
   "integration_type": "device",
   "iot_class": "local_polling",
   "quality_scale": "silver",
-  "requirements": ["homevolt==0.4.4"],
+  "requirements": ["homevolt==0.5.0"],
   "zeroconf": [
     {
       "name": "homevolt*",

homeassistant/components/homevolt/sensor.py

@@ -22,13 +22,11 @@ from homeassistant.const import (
     UnitOfTemperature,
 )
 from homeassistant.core import HomeAssistant
-from homeassistant.helpers.device_registry import DeviceInfo
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
 from homeassistant.helpers.typing import StateType
-from homeassistant.helpers.update_coordinator import CoordinatorEntity
 
-from .const import DOMAIN, MANUFACTURER
 from .coordinator import HomevoltConfigEntry, HomevoltDataUpdateCoordinator
+from .entity import HomevoltEntity
 
 PARALLEL_UPDATES = 0  # Coordinator-based updates
 
@@ -309,11 +307,10 @@ async def async_setup_entry(
     async_add_entities(entities)
 
 
-class HomevoltSensor(CoordinatorEntity[HomevoltDataUpdateCoordinator], SensorEntity):
+class HomevoltSensor(HomevoltEntity, SensorEntity):
     """Representation of a Homevolt sensor."""
 
     entity_description: SensorEntityDescription
-    _attr_has_entity_name = True
 
     def __init__(
         self,
@@ -322,24 +319,12 @@ class HomevoltSensor(CoordinatorEntity[HomevoltDataUpdateCoordinator], SensorEnt
         sensor_key: str,
     ) -> None:
         """Initialize the sensor."""
-        super().__init__(coordinator)
-        self.entity_description = description
-        unique_id = coordinator.data.unique_id
-        self._attr_unique_id = f"{unique_id}_{sensor_key}"
         sensor_data = coordinator.data.sensors[sensor_key]
+        super().__init__(coordinator, sensor_data.device_identifier)
+        self.entity_description = description
+        self._attr_unique_id = f"{coordinator.data.unique_id}_{sensor_key}"
         self._sensor_key = sensor_key
 
-        device_metadata = coordinator.data.device_metadata.get(
-            sensor_data.device_identifier
-        )
-        self._attr_device_info = DeviceInfo(
-            identifiers={(DOMAIN, f"{unique_id}_{sensor_data.device_identifier}")},
-            configuration_url=coordinator.client.base_url,
-            manufacturer=MANUFACTURER,
-            model=device_metadata.model if device_metadata else None,
-            name=device_metadata.name if device_metadata else None,
-        )
-
     @property
     def available(self) -> bool:
         """Return if entity is available."""

homeassistant/components/homevolt/strings.json

@@ -160,6 +160,19 @@
       "tmin": {
         "name": "Minimum temperature"
       }
+    },
+    "switch": {
+      "local_mode": {
+        "name": "Local mode"
+      }
+    }
+  },
+  "exceptions": {
+    "communication_error": {
+      "message": "Failed to communicate with Homevolt: {error}"
+    },
+    "unknown_error": {
+      "message": "An unknown error occurred: {error}"
     }
   }
 }

homeassistant/components/homevolt/switch.py

@@ -0,0 +1,55 @@
+"""Support for Homevolt switch entities."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from homeassistant.components.switch import SwitchEntity
+from homeassistant.const import EntityCategory
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
+
+from .coordinator import HomevoltConfigEntry, HomevoltDataUpdateCoordinator
+from .entity import HomevoltEntity, homevolt_exception_handler
+
+PARALLEL_UPDATES = 0  # Coordinator-based updates
+
+
+async def async_setup_entry(
+    hass: HomeAssistant,
+    entry: HomevoltConfigEntry,
+    async_add_entities: AddConfigEntryEntitiesCallback,
+) -> None:
+    """Set up Homevolt switch entities."""
+    coordinator = entry.runtime_data
+    async_add_entities([HomevoltLocalModeSwitch(coordinator)])
+
+
+class HomevoltLocalModeSwitch(HomevoltEntity, SwitchEntity):
+    """Switch entity for Homevolt local mode."""
+
+    _attr_entity_category = EntityCategory.CONFIG
+    _attr_translation_key = "local_mode"
+
+    def __init__(self, coordinator: HomevoltDataUpdateCoordinator) -> None:
+        """Initialize the switch entity."""
+        self._attr_unique_id = f"{coordinator.data.unique_id}_local_mode"
+        device_id = coordinator.data.unique_id
+        super().__init__(coordinator, f"ems_{device_id}")
+
+    @property
+    def is_on(self) -> bool:
+        """Return true if local mode is enabled."""
+        return self.coordinator.client.local_mode_enabled
+
+    @homevolt_exception_handler
+    async def async_turn_on(self, **kwargs: Any) -> None:
+        """Enable local mode."""
+        await self.coordinator.client.enable_local_mode()
+        await self.coordinator.async_request_refresh()
+
+    @homevolt_exception_handler
+    async def async_turn_off(self, **kwargs: Any) -> None:
+        """Disable local mode."""
+        await self.coordinator.client.disable_local_mode()
+        await self.coordinator.async_request_refresh()

requirements_all.txt

@@ -1238,7 +1238,7 @@ homelink-integration-api==0.0.1
 homematicip==2.6.0
 
 # homeassistant.components.homevolt
-homevolt==0.4.4
+homevolt==0.5.0
 
 # homeassistant.components.horizon
 horimote==0.4.1

requirements_test_all.txt

@@ -1099,7 +1099,7 @@ homelink-integration-api==0.0.1
 homematicip==2.6.0
 
 # homeassistant.components.homevolt
-homevolt==0.4.4
+homevolt==0.5.0
 
 # homeassistant.components.remember_the_milk
 httplib2==0.20.4

tests/components/homevolt/conftest.py

@@ -83,6 +83,11 @@ def mock_homevolt_client() -> Generator[MagicMock]:
         # Load schedule data from fixture
         client.current_schedule = json.loads(load_fixture("schedule.json", DOMAIN))
 
+        # Switch (local mode) support
+        client.local_mode_enabled = False
+        client.enable_local_mode = AsyncMock()
+        client.disable_local_mode = AsyncMock()
+
         yield client
 
 

tests/components/homevolt/snapshots/test_switch.ambr

@@ -0,0 +1,50 @@
+# serializer version: 1
+# name: test_entities[switch.homevolt_ems-entry]
+  EntityRegistryEntrySnapshot({
+    'aliases': set({
+    }),
+    'area_id': None,
+    'capabilities': None,
+    'config_entry_id': <ANY>,
+    'config_subentry_id': <ANY>,
+    'device_class': None,
+    'device_id': <ANY>,
+    'disabled_by': None,
+    'domain': 'switch',
+    'entity_category': <EntityCategory.CONFIG: 'config'>,
+    'entity_id': 'switch.homevolt_ems',
+    'has_entity_name': True,
+    'hidden_by': None,
+    'icon': None,
+    'id': <ANY>,
+    'labels': set({
+    }),
+    'name': None,
+    'object_id_base': None,
+    'options': dict({
+    }),
+    'original_device_class': None,
+    'original_icon': None,
+    'original_name': None,
+    'platform': 'homevolt',
+    'previous_unique_id': None,
+    'suggested_object_id': None,
+    'supported_features': 0,
+    'translation_key': 'local_mode',
+    'unique_id': '40580137858664_local_mode',
+    'unit_of_measurement': None,
+  })
+# ---
+# name: test_entities[switch.homevolt_ems-state]
+  StateSnapshot({
+    'attributes': ReadOnlyDict({
+      'friendly_name': 'Homevolt EMS',
+    }),
+    'context': <ANY>,
+    'entity_id': 'switch.homevolt_ems',
+    'last_changed': <ANY>,
+    'last_reported': <ANY>,
+    'last_updated': <ANY>,
+    'state': 'off',
+  })
+# ---

tests/components/homevolt/test_switch.py

@@ -0,0 +1,42 @@
+"""Tests for the Homevolt switch platform."""
+
+import pytest
+from syrupy.assertion import SnapshotAssertion
+
+from homeassistant.components.homevolt.const import DOMAIN
+from homeassistant.const import Platform
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers import device_registry as dr, entity_registry as er
+
+from tests.common import MockConfigEntry, snapshot_platform
+
+pytestmark = pytest.mark.usefixtures(
+    "entity_registry_enabled_by_default", "init_integration"
+)
+
+
+@pytest.fixture
+def platforms() -> list[Platform]:
+    """Fixture to specify platforms to test."""
+    return [Platform.SWITCH]
+
+
+async def test_entities(
+    hass: HomeAssistant,
+    snapshot: SnapshotAssertion,
+    entity_registry: er.EntityRegistry,
+    device_registry: dr.DeviceRegistry,
+    mock_config_entry: MockConfigEntry,
+) -> None:
+    """Test the switch entities."""
+    await snapshot_platform(hass, entity_registry, snapshot, mock_config_entry.entry_id)
+
+    device_entry = device_registry.async_get_device(
+        identifiers={(DOMAIN, "40580137858664_ems_40580137858664")}
+    )
+    assert device_entry
+    entity_entries = er.async_entries_for_config_entry(
+        entity_registry, mock_config_entry.entry_id
+    )
+    for entity_entry in entity_entries:
+        assert entity_entry.device_id == device_entry.id