Merge branch 'main' into config_flow_explicit_deprecated

Author: tomleglaunec

.github/workflows/hacs.yaml

@@ -15,4 +15,4 @@ jobs:
       - name: HACS validation
         uses: "hacs/action@main"
         with:
-          category: "integration"
+          category: "integration"

.pre-commit-config.yaml

@@ -0,0 +1,38 @@
+# Adapted from https://github.com/home-assistant/core/blob/dev/.pre-commit-config.yaml
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.7.3
+    hooks:
+      - id: ruff
+        args: [--fix, --select, I]
+      - id: ruff-format
+        files: ^((custom_components)/.+)?[^/]+\.(py|pyi)$
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.3.0
+    hooks:
+      - id: codespell
+        args:
+          - --ignore-words-list=astroid,checkin,currenty,hass,iif,incomfort,lookin,nam,NotIn
+          - --skip="./.*,*.csv,*.json,*.ambr,*.md"
+          - --quiet-level=2
+        exclude_types: [csv, json, html, markdown]
+        exclude: ^serialserver/|res/
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v3.0.3
+    hooks:
+      - id: prettier
+  - repo: local
+    hooks:
+      # Run mypy through our wrapper script in order to get the possible
+      # pyenv and/or virtualenv activated; it may not have been e.g. if
+      # committing from a GUI tool that was not launched from an activated
+      # shell.
+      - id: mypy
+        name: mypy
+        entry: mypy
+        language: python
+        types_or: [python, pyi]
+        args:
+          - --ignore-missing-imports
+        require_serial: true
+        files: ^(custom_components)/.+\.(py|pyi)$

README.md

@@ -1,18 +1,25 @@
 """The linkytic integration."""
+
 from __future__ import annotations
 
+import asyncio
 import logging
 
+from homeassistant.components import usb
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import EVENT_HOMEASSISTANT_STOP, Platform
 from homeassistant.core import HomeAssistant
+from homeassistant.exceptions import ConfigEntryNotReady
 
 from .const import (
     DOMAIN,
+    LINKY_IO_ERRORS,
     OPTIONS_REALTIME,
+    SETUP_PRODUCER,
     SETUP_SERIAL,
     SETUP_THREEPHASE,
-    TICMODE_HISTORIC,
+    SETUP_TICMODE,
+    TICMODE_STANDARD,
 )
 from .serial_reader import LinkyTICReader
 
@@ -24,14 +31,42 @@
 async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     """Set up linkytic from a config entry."""
     # Create the serial reader thread and start it
-    serial_reader = LinkyTICReader(
-        title=entry.title,
-        port=entry.data.get(SETUP_SERIAL),
-        std_mode=entry.data.get(TICMODE_HISTORIC),
-        three_phase=entry.data.get(SETUP_THREEPHASE),
-        real_time=entry.options.get(OPTIONS_REALTIME),
-    )
-    serial_reader.start()
+    port = entry.data.get(SETUP_SERIAL)
+    try:
+        serial_reader = LinkyTICReader(
+            title=entry.title,
+            port=port,
+            std_mode=entry.data.get(SETUP_TICMODE) == TICMODE_STANDARD,
+            producer_mode=entry.data.get(SETUP_PRODUCER),
+            three_phase=entry.data.get(SETUP_THREEPHASE),
+            real_time=entry.options.get(OPTIONS_REALTIME),
+        )
+        serial_reader.start()
+
+        async def read_serial_number(serial: LinkyTICReader):
+            while serial.serial_number is None:
+                await asyncio.sleep(1)
+                # Check for any serial error that occurred in the serial thread context
+                if serial.setup_error:
+                    raise serial.setup_error
+            return serial.serial_number
+
+        s_n = await asyncio.wait_for(read_serial_number(serial_reader), timeout=5)
+        # TODO: check if S/N is the one saved in config entry, if not this is a different meter!
+
+    # Error when opening serial port.
+    except LINKY_IO_ERRORS as e:
+        raise ConfigEntryNotReady(f"Couldn't open serial port {port}: {e}") from e
+
+    # Timeout waiting for S/N to be read.
+    except TimeoutError as e:
+        serial_reader.signalstop("linkytic_timeout")
+        raise ConfigEntryNotReady(
+            "Connected to serial port but coulnd't read serial number before timeout: check if TIC is connected and active."
+        ) from e
+
+    _LOGGER.info(f"Device connected with serial number: {s_n}")
+
     hass.bus.async_listen_once(EVENT_HOMEASSISTANT_STOP, serial_reader.signalstop)
     # Add options callback
     entry.async_on_unload(entry.add_update_listener(update_listener))
@@ -68,3 +103,38 @@ async def update_listener(hass: HomeAssistant, entry: ConfigEntry):
         return
     # Update its options
     serial_reader.update_options(entry.options.get(OPTIONS_REALTIME))
+
+
+async def async_migrate_entry(hass: HomeAssistant, config_entry: ConfigEntry):
+    """Migrate old entry."""
+    _LOGGER.info(
+        "Migrating from version %d.%d", config_entry.version, config_entry.minor_version
+    )
+
+    if config_entry.version == 1:
+        new = {**config_entry.data}
+
+        if config_entry.minor_version < 2:
+            # Migrate to serial by-id.
+            serial_by_id = await hass.async_add_executor_job(
+                usb.get_serial_by_id, new[SETUP_SERIAL]
+            )
+            if serial_by_id == new[SETUP_SERIAL]:
+                _LOGGER.warning(
+                    f"Couldn't find a persistent /dev/serial/by-id alias for {serial_by_id}. "
+                    "Problems might occur at startup if device names are not persistent."
+                )
+            else:
+                new[SETUP_SERIAL] = serial_by_id
+
+        # config_entry.minor_version = 2
+        hass.config_entries.async_update_entry(
+            config_entry, data=new, minor_version=2, version=1
+        )  # type: ignore
+
+    _LOGGER.info(
+        "Migration to version %d.%d successful",
+        config_entry.version,
+        config_entry.minor_version,
+    )
+    return True