Add Homevolt integration

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

homeassistant/components/homevolt/__init__.py

@@ -0,0 +1,51 @@
+"""The Homevolt integration."""
+
+from __future__ import annotations
+
+from homevolt import Homevolt, HomevoltConnectionError
+
+from homeassistant.const import CONF_HOST, CONF_PASSWORD, Platform
+from homeassistant.core import HomeAssistant
+from homeassistant.exceptions import ConfigEntryNotReady
+from homeassistant.helpers import config_validation as cv
+from homeassistant.helpers.aiohttp_client import async_get_clientsession
+
+from .const import DOMAIN, HomevoltConfigEntry
+from .coordinator import HomevoltDataUpdateCoordinator
+
+PLATFORMS: list[Platform] = [Platform.SENSOR]
+
+CONFIG_SCHEMA = cv.config_entry_only_config_schema(DOMAIN)
+
+
+async def async_setup_entry(hass: HomeAssistant, entry: HomevoltConfigEntry) -> bool:
+    """Set up Homevolt from a config entry."""
+    host: str = entry.data[CONF_HOST]
+    password: str | None = entry.data.get(CONF_PASSWORD)
+
+    websession = async_get_clientsession(hass)
+    client = Homevolt(host, password, websession=websession)
+
+    try:
+        await client.update_info()
+    except HomevoltConnectionError as err:
+        raise ConfigEntryNotReady(
+            f"Unable to connect to Homevolt battery: {err}"
+        ) from err
+
+    coordinator = HomevoltDataUpdateCoordinator(hass, entry, client)
+    await coordinator.async_config_entry_first_refresh()
+
+    entry.runtime_data = coordinator
+
+    await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
+
+    return True
+
+
+async def async_unload_entry(hass: HomeAssistant, entry: HomevoltConfigEntry) -> bool:
+    """Unload a config entry."""
+    if unload_ok := await hass.config_entries.async_unload_platforms(entry, PLATFORMS):
+        if entry.runtime_data:
+            await entry.runtime_data.client.close_connection()
+    return unload_ok

homeassistant/components/homevolt/config_flow.py

@@ -0,0 +1,63 @@
+"""Config flow for the Homevolt integration."""
+
+from __future__ import annotations
+
+import logging
+from typing import Any
+
+from homevolt import Homevolt, HomevoltAuthenticationError, HomevoltConnectionError
+import voluptuous as vol
+
+from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
+from homeassistant.const import CONF_HOST, CONF_PASSWORD
+from homeassistant.helpers.aiohttp_client import async_get_clientsession
+
+from .const import DOMAIN
+
+_LOGGER = logging.getLogger(__name__)
+
+STEP_USER_DATA_SCHEMA = vol.Schema(
+    {
+        vol.Required(CONF_HOST): str,
+        vol.Optional(CONF_PASSWORD): str,
+    }
+)
+
+
+class HomevoltConfigFlow(ConfigFlow, domain=DOMAIN):
+    """Handle a config flow for Homevolt."""
+
+    VERSION = 1
+
+    async def async_step_user(
+        self, user_input: dict[str, Any] | None = None
+    ) -> ConfigFlowResult:
+        """Handle the initial step."""
+        errors: dict[str, str] = {}
+        if user_input is not None:
+            host = user_input[CONF_HOST]
+            password = user_input.get(CONF_PASSWORD)
+            websession = async_get_clientsession(self.hass)
+            try:
+                await Homevolt(host, password, websession=websession).update_info()
+            except HomevoltAuthenticationError:
+                errors["base"] = "invalid_auth"
+            except HomevoltConnectionError:
+                errors["base"] = "cannot_connect"
+            except Exception:  # noqa: BLE001
+                errors["base"] = "unknown"
+            else:
+                await self.async_set_unique_id(host)
+                self._abort_if_unique_id_configured()
+
+                return self.async_create_entry(
+                    title="Homevolt Local",
+                    data={
+                        CONF_HOST: host,
+                        CONF_PASSWORD: password,
+                    },
+                )
+
+        return self.async_show_form(
+            step_id="user", data_schema=STEP_USER_DATA_SCHEMA, errors=errors
+        )

homeassistant/components/homevolt/const.py

@@ -0,0 +1,16 @@
+"""Constants for the Homevolt integration."""
+
+from __future__ import annotations
+
+from datetime import timedelta
+from typing import TYPE_CHECKING
+
+from homeassistant.config_entries import ConfigEntry
+
+if TYPE_CHECKING:
+    from .coordinator import HomevoltDataUpdateCoordinator
+
+DOMAIN = "homevolt"
+MANUFACTURER = "Homevolt"
+SCAN_INTERVAL = timedelta(seconds=15)
+type HomevoltConfigEntry = ConfigEntry["HomevoltDataUpdateCoordinator"]

homeassistant/components/homevolt/coordinator.py

@@ -0,0 +1,51 @@
+"""Data update coordinator for Homevolt integration."""
+
+from __future__ import annotations
+
+import logging
+
+from homevolt import (
+    Device,
+    Homevolt,
+    HomevoltAuthenticationError,
+    HomevoltConnectionError,
+    HomevoltError,
+)
+
+from homeassistant.core import HomeAssistant
+from homeassistant.exceptions import ConfigEntryAuthFailed
+from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
+
+from .const import DOMAIN, SCAN_INTERVAL, HomevoltConfigEntry
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class HomevoltDataUpdateCoordinator(DataUpdateCoordinator[Device]):
+    """Class to manage fetching Homevolt data."""
+
+    def __init__(
+        self,
+        hass: HomeAssistant,
+        entry: HomevoltConfigEntry,
+        client: Homevolt,
+    ) -> None:
+        """Initialize the Homevolt coordinator."""
+        self.client = client
+        super().__init__(
+            hass,
+            _LOGGER,
+            name=DOMAIN,
+            update_interval=SCAN_INTERVAL,
+            config_entry=entry,
+        )
+
+    async def _async_update_data(self) -> Device:
+        """Fetch data from the Homevolt API."""
+        try:
+            await self.client.update_info()
+            return self.client.get_device()
+        except HomevoltAuthenticationError as err:
+            raise ConfigEntryAuthFailed from err
+        except (HomevoltConnectionError, HomevoltError) as err:
+            raise UpdateFailed(f"Error communicating with device: {err}") from err

homeassistant/components/homevolt/manifest.json

@@ -0,0 +1,15 @@
+{
+  "domain": "homevolt",
+  "name": "Homevolt",
+  "codeowners": ["@danielhiversen"],
+  "config_flow": true,
+  "dependencies": [],
+  "documentation": "https://www.home-assistant.io/integrations/homevolt",
+  "homekit": {},
+  "integration_type": "device",
+  "iot_class": "local_polling",
+  "quality_scale": "bronze",
+  "requirements": ["homevolt==0.2.3"],
+  "ssdp": [],
+  "zeroconf": []
+}

homeassistant/components/homevolt/quality_scale.yaml

@@ -0,0 +1,72 @@
+rules:
+  # Bronze
+  action-setup:
+    status: exempt
+    comment: Integration does not register custom actions.
+  appropriate-polling: done
+  brands: done
+  common-modules: done
+  config-flow-test-coverage: done
+  config-flow: done
+  dependency-transparency: done
+  docs-actions:
+    status: exempt
+    comment: Integration does not register custom actions.
+  docs-high-level-description: done
+  docs-installation-instructions: done
+  docs-removal-instructions: done
+  entity-event-setup:
+    status: exempt
+    comment: Local_polling without events
+  entity-unique-id: done
+  has-entity-name: done
+  runtime-data: done
+  test-before-configure: done
+  test-before-setup: done
+  unique-config-entry: done
+
+  # Silver
+  action-exceptions:
+    status: exempt
+    comment: Integration does not register custom actions.
+  config-entry-unloading: done
+  docs-configuration-parameters:
+    status: exempt
+    comment: Integration does not have an options flow.
+  docs-installation-parameters: todo
+  entity-unavailable: done
+  integration-owner: done
+  log-when-unavailable: done
+  parallel-updates:
+    status: exempt
+    comment: Coordinator handles updates, no explicit parallel updates needed.
+  reauthentication-flow: todo
+  test-coverage: todo
+
+  # Gold
+  devices: done
+  diagnostics: todo
+  discovery-update-info: todo
+  discovery: todo
+  docs-data-update: todo
+  docs-examples: todo
+  docs-known-limitations: todo
+  docs-supported-devices: todo
+  docs-supported-functions: todo
+  docs-troubleshooting: todo
+  docs-use-cases: todo
+  dynamic-devices: todo
+  entity-category: todo
+  entity-device-class: done
+  entity-disabled-by-default: todo
+  entity-translations: todo
+  exception-translations: todo
+  icon-translations: todo
+  reconfiguration-flow: todo
+  repair-issues: todo
+  stale-devices: todo
+
+  # Platinum
+  async-dependency: done
+  inject-websession: done
+  strict-typing: todo

homeassistant/components/homevolt/sensor.py

@@ -0,0 +1,167 @@
+"""Support for Homevolt sensors."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+import logging
+
+from homevolt.models import SensorType
+
+from homeassistant.components.sensor import (
+    SensorDeviceClass,
+    SensorEntity,
+    SensorEntityDescription,
+    SensorStateClass,
+)
+from homeassistant.const import (
+    PERCENTAGE,
+    SIGNAL_STRENGTH_DECIBELS,
+    UnitOfElectricCurrent,
+    UnitOfElectricPotential,
+    UnitOfEnergy,
+    UnitOfFrequency,
+    UnitOfPower,
+    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, HomevoltConfigEntry
+from .coordinator import HomevoltDataUpdateCoordinator
+
+_LOGGER = logging.getLogger(__name__)
+
+
+@dataclass
+class Description:
+    """Sensor metadata description."""
+
+    device_class: SensorDeviceClass | None
+    state_class: SensorStateClass | None
+    native_unit_of_measurement: str | None
+
+
+SENSOR_META: dict[SensorType, Description] = {
+    SensorType.COUNT: Description(
+        None,
+        SensorStateClass.MEASUREMENT,
+        "N",
+    ),
+    SensorType.CURRENT: Description(
+        SensorDeviceClass.CURRENT,
+        SensorStateClass.MEASUREMENT,
+        UnitOfElectricCurrent.AMPERE,
+    ),
+    SensorType.ENERGY_INCREASING: Description(
+        SensorDeviceClass.ENERGY,
+        SensorStateClass.TOTAL_INCREASING,
+        UnitOfEnergy.KILO_WATT_HOUR,
+    ),
+    SensorType.ENERGY_TOTAL: Description(
+        SensorDeviceClass.ENERGY,
+        SensorStateClass.TOTAL,
+        UnitOfEnergy.WATT_HOUR,
+    ),
+    SensorType.FREQUENCY: Description(
+        SensorDeviceClass.FREQUENCY,
+        SensorStateClass.MEASUREMENT,
+        UnitOfFrequency.HERTZ,
+    ),
+    SensorType.PERCENTAGE: Description(
+        SensorDeviceClass.BATTERY,
+        SensorStateClass.MEASUREMENT,
+        PERCENTAGE,
+    ),
+    SensorType.POWER: Description(
+        SensorDeviceClass.POWER,
+        SensorStateClass.MEASUREMENT,
+        UnitOfPower.WATT,
+    ),
+    SensorType.SCHEDULE_TYPE: Description(
+        None,
+        None,
+        None,
+    ),
+    SensorType.SIGNAL_STRENGTH: Description(
+        SensorDeviceClass.SIGNAL_STRENGTH,
+        SensorStateClass.MEASUREMENT,
+        SIGNAL_STRENGTH_DECIBELS,
+    ),
+    SensorType.TEMPERATURE: Description(
+        SensorDeviceClass.TEMPERATURE,
+        SensorStateClass.MEASUREMENT,
+        UnitOfTemperature.CELSIUS,
+    ),
+    SensorType.TEXT: Description(
+        None,
+        None,
+        None,
+    ),
+    SensorType.VOLTAGE: Description(
+        SensorDeviceClass.VOLTAGE,
+        SensorStateClass.MEASUREMENT,
+        UnitOfElectricPotential.VOLT,
+    ),
+}
+
+
+async def async_setup_entry(
+    hass: HomeAssistant,
+    entry: HomevoltConfigEntry,
+    async_add_entities: AddConfigEntryEntitiesCallback,
+) -> None:
+    """Set up the Homevolt sensor."""
+    coordinator = entry.runtime_data
+    entities = []
+    for sensor_name, sensor in coordinator.data.sensors.items():
+        if sensor.type not in SENSOR_META:
+            continue
+        sensor_meta = SENSOR_META[sensor.type]
+        entities.append(
+            HomevoltSensor(
+                SensorEntityDescription(
+                    key=sensor_name,
+                    name=sensor_name,
+                    device_class=sensor_meta.device_class,
+                    state_class=sensor_meta.state_class,
+                    native_unit_of_measurement=sensor_meta.native_unit_of_measurement,
+                ),
+                coordinator,
+            )
+        )
+    async_add_entities(entities)
+
+
+class HomevoltSensor(CoordinatorEntity[HomevoltDataUpdateCoordinator], SensorEntity):
+    """Representation of a Homevolt sensor."""
+
+    _attr_has_entity_name = True
+
+    def __init__(
+        self,
+        description: SensorEntityDescription,
+        coordinator: HomevoltDataUpdateCoordinator,
+    ) -> None:
+        """Initialize the sensor."""
+        super().__init__(coordinator)
+        self.entity_description = description
+        device_id = coordinator.data.device_id
+        self._attr_unique_id = f"{device_id}_{description.key}"
+        sensor = coordinator.data.sensors[description.key]
+        sensor_device_id = sensor.device_identifier
+        device_metadata = coordinator.data.device_metadata.get(sensor_device_id)
+        self._attr_device_info = DeviceInfo(
+            identifiers={(DOMAIN, f"{device_id}_{sensor_device_id}")},
+            configuration_url=coordinator.client.hostname,
+            manufacturer=MANUFACTURER,
+            model=device_metadata.model,
+            name=device_metadata.name,
+        )
+
+    @property
+    def native_value(self) -> StateType:
+        """Return the native value of the sensor."""
+        return self.coordinator.data.sensors[self.entity_description.key].value

homeassistant/components/homevolt/strings.json

@@ -0,0 +1,26 @@
+{
+  "config": {
+    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_device%]"
+    },
+    "error": {
+      "cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",
+      "invalid_auth": "[%key:common::config_flow::error::invalid_auth%]",
+      "unknown": "[%key:common::config_flow::error::unknown%]"
+    },
+    "step": {
+      "user": {
+        "data": {
+          "host": "[%key:common::config_flow::data::host%]",
+          "password": "[%key:common::config_flow::data::password%]"
+        },
+        "data_description": {
+          "host": "The IP address or hostname of your Homevolt battery on your local network.",
+          "password": "The local password configured for your Homevolt battery, if required."
+        },
+        "description": "Connect Home Assistant to your Homevolt battery over the local network.",
+        "title": "Homevolt Local"
+      }
+    }
+  }
+}

homeassistant/generated/config_flows.py

@@ -293,6 +293,7 @@ FLOWS = {
         "homekit",
         "homekit_controller",
         "homematicip_cloud",
+        "homevolt",
         "homewizard",
         "homeworks",
         "honeywell",

homeassistant/generated/integrations.json

@@ -2807,6 +2807,12 @@
       "config_flow": true,
       "iot_class": "local_push"
     },
+    "homevolt": {
+      "name": "Homevolt",
+      "integration_type": "device",
+      "config_flow": true,
+      "iot_class": "local_polling"
+    },
     "homematic": {
       "name": "Homematic",
       "integrations": {

requirements_all.txt

@@ -1224,6 +1224,9 @@ homelink-integration-api==0.0.1
 # homeassistant.components.homematicip_cloud
 homematicip==2.4.0
 
+# homeassistant.components.homevolt
+homevolt==0.2.3
+
 # homeassistant.components.horizon
 horimote==0.4.1
 

requirements_test_all.txt

@@ -1082,6 +1082,9 @@ homelink-integration-api==0.0.1
 # homeassistant.components.homematicip_cloud
 homematicip==2.4.0
 
+# homeassistant.components.homevolt
+homevolt==0.2.3
+
 # homeassistant.components.remember_the_milk
 httplib2==0.20.4
 

tests/components/homevolt/__init__.py

@@ -0,0 +1 @@
+"""Tests for the Homevolt integration."""

tests/components/homevolt/conftest.py

@@ -0,0 +1,15 @@
+"""Common fixtures for the Homevolt tests."""
+
+from collections.abc import Generator
+from unittest.mock import AsyncMock, patch
+
+import pytest
+
+
+@pytest.fixture
+def mock_setup_entry() -> Generator[AsyncMock]:
+    """Override async_setup_entry."""
+    with patch(
+        "homeassistant.components.homevolt.async_setup_entry", return_value=True
+    ) as mock_setup_entry:
+        yield mock_setup_entry

tests/components/homevolt/test_config_flow.py

@@ -0,0 +1,147 @@
+"""Tests for the Homevolt config flow."""
+
+from __future__ import annotations
+
+from unittest.mock import AsyncMock, patch
+
+from homevolt import HomevoltAuthenticationError, HomevoltConnectionError
+import pytest
+
+from homeassistant.components.homevolt.const import DOMAIN
+from homeassistant.config_entries import SOURCE_USER
+from homeassistant.const import CONF_HOST, CONF_PASSWORD
+from homeassistant.core import HomeAssistant
+from homeassistant.data_entry_flow import FlowResultType
+
+from tests.common import MockConfigEntry
+
+
+async def test_full_flow_success(
+    hass: HomeAssistant, mock_setup_entry: AsyncMock
+) -> None:
+    """Test a complete successful user flow."""
+    result = await hass.config_entries.flow.async_init(
+        DOMAIN, context={"source": SOURCE_USER}
+    )
+
+    assert result["type"] is FlowResultType.FORM
+    assert result["step_id"] == "user"
+    assert result["errors"] == {}
+
+    user_input = {
+        CONF_HOST: "192.168.1.100",
+        CONF_PASSWORD: "test-password",
+    }
+
+    with patch(
+        "homeassistant.components.homevolt.config_flow.Homevolt.update_info",
+        new_callable=AsyncMock,
+    ):
+        result = await hass.config_entries.flow.async_configure(
+            result["flow_id"],
+            user_input,
+        )
+        await hass.async_block_till_done()
+
+    assert result["type"] is FlowResultType.CREATE_ENTRY
+    assert result["title"] == "Homevolt Local"
+    assert result["data"] == user_input
+    assert len(mock_setup_entry.mock_calls) == 1
+
+
+@pytest.mark.parametrize(
+    ("exception", "expected_error"),
+    [
+        (HomevoltAuthenticationError, "invalid_auth"),
+        (HomevoltConnectionError, "cannot_connect"),
+        (Exception, "unknown"),
+    ],
+)
+async def test_step_user_errors(
+    hass: HomeAssistant,
+    mock_setup_entry: AsyncMock,
+    exception: Exception,
+    expected_error: str,
+) -> None:
+    """Test error cases for the user step with recovery."""
+    result = await hass.config_entries.flow.async_init(
+        DOMAIN, context={"source": SOURCE_USER}
+    )
+
+    assert result["type"] is FlowResultType.FORM
+    assert result["step_id"] == "user"
+    assert result["errors"] == {}
+
+    user_input = {
+        CONF_HOST: "192.168.1.100",
+        CONF_PASSWORD: "test-password",
+    }
+
+    with patch(
+        "homeassistant.components.homevolt.config_flow.Homevolt.update_info",
+        new_callable=AsyncMock,
+    ) as mock_update_info:
+        mock_update_info.side_effect = exception
+
+        result = await hass.config_entries.flow.async_configure(
+            result["flow_id"],
+            user_input,
+        )
+
+    assert result["type"] is FlowResultType.FORM
+    assert result["step_id"] == "user"
+    assert result["errors"] == {"base": expected_error}
+
+    # Clear the error and complete the flow successfully
+    with patch(
+        "homeassistant.components.homevolt.config_flow.Homevolt.update_info",
+        new_callable=AsyncMock,
+    ):
+        result = await hass.config_entries.flow.async_configure(
+            result["flow_id"],
+            user_input,
+        )
+        await hass.async_block_till_done()
+
+    assert result["type"] is FlowResultType.CREATE_ENTRY
+    assert result["title"] == "Homevolt Local"
+    assert result["data"] == user_input
+    assert len(mock_setup_entry.mock_calls) == 1
+
+
+async def test_duplicate_entry(
+    hass: HomeAssistant,
+    mock_setup_entry: AsyncMock,
+) -> None:
+    """Test that a duplicate host aborts the flow."""
+    existing_entry = MockConfigEntry(
+        domain=DOMAIN,
+        data={CONF_HOST: "192.168.1.100", CONF_PASSWORD: "test-password"},
+        unique_id="192.168.1.100",
+    )
+    existing_entry.add_to_hass(hass)
+
+    result = await hass.config_entries.flow.async_init(
+        DOMAIN, context={"source": SOURCE_USER}
+    )
+
+    assert result["type"] is FlowResultType.FORM
+    assert result["step_id"] == "user"
+    assert result["errors"] == {}
+
+    user_input = {
+        CONF_HOST: "192.168.1.100",
+        CONF_PASSWORD: "test-password",
+    }
+
+    with patch(
+        "homeassistant.components.homevolt.config_flow.Homevolt.update_info",
+        new_callable=AsyncMock,
+    ):
+        result = await hass.config_entries.flow.async_configure(
+            result["flow_id"],
+            user_input,
+        )
+
+    assert result["type"] is FlowResultType.ABORT
+    assert result["reason"] == "already_configured"