Add Iskra integration (home-assistant#121488)

* Add iskra integration

* iskra non resettable counters naming fix

* added iskra config_flow test

* fixed iskra integration according to code review

* changed iskra config flow test

* iskra integration, fixed codeowners

* Removed counters code & minor fixes

* added comment

* Update homeassistant/components/iskra/__init__.py

Co-authored-by: Joost Lekkerkerker <[email protected]>

* Updated Iskra integration according to review

* Update homeassistant/components/iskra/strings.json

Co-authored-by: Joost Lekkerkerker <[email protected]>

* Updated iskra integration according to review

* minor iskra integration change

* iskra integration changes according to review

* iskra integration changes according to review

* Changed iskra integration according to review

* added iskra config_flow range validation

* Fixed tests for iskra integration

* Update homeassistant/components/iskra/coordinator.py

* Update homeassistant/components/iskra/config_flow.py

Co-authored-by: Joost Lekkerkerker <[email protected]>

* Fixed iskra integration according to review

* Changed voluptuous schema for iskra integration and added data_descriptions

* Iskra integration tests lint error fix

---------

Co-authored-by: Joost Lekkerkerker <[email protected]>

CODEOWNERS

@@ -728,6 +728,8 @@ build.json @home-assistant/supervisor
 /tests/components/iron_os/ @tr4nt0r
 /homeassistant/components/isal/ @bdraco
 /tests/components/isal/ @bdraco
+/homeassistant/components/iskra/ @iskramis
+/tests/components/iskra/ @iskramis
 /homeassistant/components/islamic_prayer_times/ @engrbm87 @cpfair
 /tests/components/islamic_prayer_times/ @engrbm87 @cpfair
 /homeassistant/components/israel_rail/ @shaiu

homeassistant/components/iskra/__init__.py

@@ -0,0 +1,100 @@
+"""The iskra integration."""
+
+from __future__ import annotations
+
+from pyiskra.adapters import Modbus, RestAPI
+from pyiskra.devices import Device
+from pyiskra.exceptions import DeviceConnectionError, DeviceNotSupported, NotAuthorised
+
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.const import (
+    CONF_ADDRESS,
+    CONF_HOST,
+    CONF_PASSWORD,
+    CONF_PORT,
+    CONF_PROTOCOL,
+    CONF_USERNAME,
+    Platform,
+)
+from homeassistant.core import HomeAssistant
+from homeassistant.exceptions import ConfigEntryNotReady
+from homeassistant.helpers import device_registry as dr
+
+from .const import DOMAIN, MANUFACTURER
+from .coordinator import IskraDataUpdateCoordinator
+
+PLATFORMS: list[Platform] = [Platform.SENSOR]
+
+
+type IskraConfigEntry = ConfigEntry[list[IskraDataUpdateCoordinator]]
+
+
+async def async_setup_entry(hass: HomeAssistant, entry: IskraConfigEntry) -> bool:
+    """Set up iskra device from a config entry."""
+    conf = entry.data
+    adapter = None
+
+    if conf[CONF_PROTOCOL] == "modbus_tcp":
+        adapter = Modbus(
+            ip_address=conf[CONF_HOST],
+            protocol="tcp",
+            port=conf[CONF_PORT],
+            modbus_address=conf[CONF_ADDRESS],
+        )
+    elif conf[CONF_PROTOCOL] == "rest_api":
+        authentication = None
+        if (username := conf.get(CONF_USERNAME)) is not None and (
+            password := conf.get(CONF_PASSWORD)
+        ) is not None:
+            authentication = {
+                "username": username,
+                "password": password,
+            }
+        adapter = RestAPI(ip_address=conf[CONF_HOST], authentication=authentication)
+
+    # Try connecting to the device and create pyiskra device object
+    try:
+        base_device = await Device.create_device(adapter)
+    except DeviceConnectionError as e:
+        raise ConfigEntryNotReady("Cannot connect to the device") from e
+    except NotAuthorised as e:
+        raise ConfigEntryNotReady("Not authorised to connect to the device") from e
+    except DeviceNotSupported as e:
+        raise ConfigEntryNotReady("Device not supported") from e
+
+    # Initialize the device
+    await base_device.init()
+
+    # if the device is a gateway, add all child devices, otherwise add the device itself.
+    if base_device.is_gateway:
+        # Add the gateway device to the device registry
+        device_registry = dr.async_get(hass)
+        device_registry.async_get_or_create(
+            config_entry_id=entry.entry_id,
+            identifiers={(DOMAIN, base_device.serial)},
+            manufacturer=MANUFACTURER,
+            name=base_device.model,
+            model=base_device.model,
+            sw_version=base_device.fw_version,
+        )
+
+        coordinators = [
+            IskraDataUpdateCoordinator(hass, child_device)
+            for child_device in base_device.get_child_devices()
+        ]
+    else:
+        coordinators = [IskraDataUpdateCoordinator(hass, base_device)]
+
+    for coordinator in coordinators:
+        await coordinator.async_config_entry_first_refresh()
+
+    entry.runtime_data = coordinators
+
+    await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
+
+    return True
+
+
+async def async_unload_entry(hass: HomeAssistant, entry: IskraConfigEntry) -> bool:
+    """Unload a config entry."""
+    return await hass.config_entries.async_unload_platforms(entry, PLATFORMS)

homeassistant/components/iskra/config_flow.py

@@ -0,0 +1,253 @@
+"""Config flow for iskra integration."""
+
+from __future__ import annotations
+
+import logging
+from typing import Any
+
+from pyiskra.adapters import Modbus, RestAPI
+from pyiskra.exceptions import (
+    DeviceConnectionError,
+    DeviceTimeoutError,
+    InvalidResponseCode,
+    NotAuthorised,
+)
+from pyiskra.helper import BasicInfo
+import voluptuous as vol
+
+from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
+from homeassistant.const import (
+    CONF_ADDRESS,
+    CONF_HOST,
+    CONF_PASSWORD,
+    CONF_PORT,
+    CONF_PROTOCOL,
+    CONF_USERNAME,
+)
+from homeassistant.exceptions import HomeAssistantError
+from homeassistant.helpers.selector import (
+    NumberSelector,
+    NumberSelectorConfig,
+    NumberSelectorMode,
+    SelectSelector,
+    SelectSelectorConfig,
+    SelectSelectorMode,
+)
+
+from .const import DOMAIN
+
+_LOGGER = logging.getLogger(__name__)
+
+
+STEP_USER_DATA_SCHEMA = vol.Schema(
+    {
+        vol.Required(CONF_HOST): str,
+        vol.Required(CONF_PROTOCOL, default="rest_api"): SelectSelector(
+            SelectSelectorConfig(
+                options=["rest_api", "modbus_tcp"],
+                mode=SelectSelectorMode.LIST,
+                translation_key="protocol",
+            ),
+        ),
+    }
+)
+
+STEP_AUTHENTICATION_DATA_SCHEMA = vol.Schema(
+    {
+        vol.Required(CONF_USERNAME): str,
+        vol.Required(CONF_PASSWORD): str,
+    }
+)
+
+# CONF_ADDRESS validation is done later in code, as if ranges are set in voluptuous it turns into a slider
+STEP_MODBUS_TCP_DATA_SCHEMA = vol.Schema(
+    {
+        vol.Required(CONF_PORT, default=10001): vol.All(
+            vol.Coerce(int), vol.Range(min=0, max=65535)
+        ),
+        vol.Required(CONF_ADDRESS, default=33): NumberSelector(
+            NumberSelectorConfig(min=1, max=255, mode=NumberSelectorMode.BOX)
+        ),
+    }
+)
+
+
+async def test_rest_api_connection(host: str, user_input: dict[str, Any]) -> BasicInfo:
+    """Check if the RestAPI requires authentication."""
+
+    rest_api = RestAPI(ip_address=host, authentication=user_input)
+    try:
+        basic_info = await rest_api.get_basic_info()
+    except NotAuthorised as e:
+        raise NotAuthorised from e
+    except (DeviceConnectionError, DeviceTimeoutError, InvalidResponseCode) as e:
+        raise CannotConnect from e
+    except Exception as e:
+        _LOGGER.error("Unexpected exception: %s", e)
+        raise UnknownException from e
+
+    return basic_info
+
+
+async def test_modbus_connection(host: str, user_input: dict[str, Any]) -> BasicInfo:
+    """Test the Modbus connection."""
+    modbus_api = Modbus(
+        ip_address=host,
+        protocol="tcp",
+        port=user_input[CONF_PORT],
+        modbus_address=user_input[CONF_ADDRESS],
+    )
+
+    try:
+        basic_info = await modbus_api.get_basic_info()
+    except NotAuthorised as e:
+        raise NotAuthorised from e
+    except (DeviceConnectionError, DeviceTimeoutError, InvalidResponseCode) as e:
+        raise CannotConnect from e
+    except Exception as e:
+        _LOGGER.error("Unexpected exception: %s", e)
+        raise UnknownException from e
+
+    return basic_info
+
+
+class IskraConfigFlowFlow(ConfigFlow, domain=DOMAIN):
+    """Handle a config flow for iskra."""
+
+    VERSION = 1
+    host: str
+    protocol: str
+
+    async def async_step_user(
+        self, user_input: dict[str, Any] | None = None
+    ) -> ConfigFlowResult:
+        """Handle a flow initiated by the user."""
+        errors: dict[str, str] = {}
+        if user_input is not None:
+            self.host = user_input[CONF_HOST]
+            self.protocol = user_input[CONF_PROTOCOL]
+            if self.protocol == "rest_api":
+                # Check if authentication is required.
+                try:
+                    device_info = await test_rest_api_connection(self.host, user_input)
+                except CannotConnect:
+                    errors["base"] = "cannot_connect"
+                except NotAuthorised:
+                    # Proceed to authentication step.
+                    return await self.async_step_authentication()
+                except UnknownException:
+                    errors["base"] = "unknown"
+                    # If the connection was not successful, show an error.
+
+                # If the connection was successful, create the device.
+                if not errors:
+                    return await self._create_entry(
+                        host=self.host,
+                        protocol=self.protocol,
+                        device_info=device_info,
+                        user_input=user_input,
+                    )
+
+            if self.protocol == "modbus_tcp":
+                # Proceed to modbus step.
+                return await self.async_step_modbus_tcp()
+
+        return self.async_show_form(
+            step_id="user",
+            data_schema=STEP_USER_DATA_SCHEMA,
+            errors=errors,
+        )
+
+    async def async_step_authentication(
+        self, user_input: dict[str, Any] | None = None
+    ) -> ConfigFlowResult:
+        """Handle the authentication step."""
+        errors: dict[str, str] = {}
+        if user_input is not None:
+            try:
+                device_info = await test_rest_api_connection(self.host, user_input)
+            # If the connection failed, abort.
+            except CannotConnect:
+                errors["base"] = "cannot_connect"
+            # If the authentication failed, show an error and authentication form again.
+            except NotAuthorised:
+                errors["base"] = "invalid_auth"
+            except UnknownException:
+                errors["base"] = "unknown"
+
+            # if the connection was successful, create the device.
+            if not errors:
+                return await self._create_entry(
+                    self.host,
+                    self.protocol,
+                    device_info=device_info,
+                    user_input=user_input,
+                )
+
+        # If there's no user_input or there was an error, show the authentication form again.
+        return self.async_show_form(
+            step_id="authentication",
+            data_schema=STEP_AUTHENTICATION_DATA_SCHEMA,
+            errors=errors,
+        )
+
+    async def async_step_modbus_tcp(
+        self, user_input: dict[str, Any] | None = None
+    ) -> ConfigFlowResult:
+        """Handle the Modbus TCP step."""
+        errors: dict[str, str] = {}
+
+        # If there's user_input, check the connection.
+        if user_input is not None:
+            # convert to integer
+            user_input[CONF_ADDRESS] = int(user_input[CONF_ADDRESS])
+
+            try:
+                device_info = await test_modbus_connection(self.host, user_input)
+
+            # If the connection failed, show an error.
+            except CannotConnect:
+                errors["base"] = "cannot_connect"
+            except UnknownException:
+                errors["base"] = "unknown"
+
+            # If the connection was successful, create the device.
+            if not errors:
+                return await self._create_entry(
+                    host=self.host,
+                    protocol=self.protocol,
+                    device_info=device_info,
+                    user_input=user_input,
+                )
+
+        # If there's no user_input or there was an error, show the modbus form again.
+        return self.async_show_form(
+            step_id="modbus_tcp",
+            data_schema=STEP_MODBUS_TCP_DATA_SCHEMA,
+            errors=errors,
+        )
+
+    async def _create_entry(
+        self,
+        host: str,
+        protocol: str,
+        device_info: BasicInfo,
+        user_input: dict[str, Any],
+    ) -> ConfigFlowResult:
+        """Create the config entry."""
+
+        await self.async_set_unique_id(device_info.serial)
+        self._abort_if_unique_id_configured()
+
+        return self.async_create_entry(
+            title=device_info.model,
+            data={CONF_HOST: host, CONF_PROTOCOL: protocol, **user_input},
+        )
+
+
+class CannotConnect(HomeAssistantError):
+    """Error to indicate we cannot connect."""
+
+
+class UnknownException(HomeAssistantError):
+    """Error to indicate an unknown exception occurred."""

homeassistant/components/iskra/const.py

@@ -0,0 +1,25 @@
+"""Constants for the iskra integration."""
+
+DOMAIN = "iskra"
+MANUFACTURER = "Iskra d.o.o"
+
+# POWER
+ATTR_TOTAL_APPARENT_POWER = "total_apparent_power"
+ATTR_TOTAL_REACTIVE_POWER = "total_reactive_power"
+ATTR_TOTAL_ACTIVE_POWER = "total_active_power"
+ATTR_PHASE1_POWER = "phase1_power"
+ATTR_PHASE2_POWER = "phase2_power"
+ATTR_PHASE3_POWER = "phase3_power"
+
+# Voltage
+ATTR_PHASE1_VOLTAGE = "phase1_voltage"
+ATTR_PHASE2_VOLTAGE = "phase2_voltage"
+ATTR_PHASE3_VOLTAGE = "phase3_voltage"
+
+# Current
+ATTR_PHASE1_CURRENT = "phase1_current"
+ATTR_PHASE2_CURRENT = "phase2_current"
+ATTR_PHASE3_CURRENT = "phase3_current"
+
+# Frequency
+ATTR_FREQUENCY = "frequency"