Add channel accessibility check (#24)

* Add channel accessibility check

* Add fixtures

* Add ruff linter

* Fix fixtures path

Author: alengwenus

.ruff.toml

@@ -3,39 +3,113 @@
 target-version = "py310"
 
 select = [
-    "B007", # Loop control variable {name} not used within loop body
-    "B014", # Exception handler with duplicate exception
-    "C",  # complexity
-    "D",  # docstrings
-    "E",  # pycodestyle
-    "F",  # pyflakes/autoflake
-    "ICN001", # import concentions; {name} should be imported as {asname}
+    "B002",    # Python does not support the unary prefix increment
+    "B007",    # Loop control variable {name} not used within loop body
+    "B014",    # Exception handler with duplicate exception
+    "B023",    # Function definition does not bind loop variable {name}
+    "B026",    # Star-arg unpacking after a keyword argument is strongly discouraged
+    "B904",    # Use raise from to specify exception cause
+    "C",       # complexity
+    "COM818",  # Trailing comma on bare tuple prohibited
+    "D",       # docstrings
+    "DTZ003",  # Use datetime.now(tz=) instead of datetime.utcnow()
+    "DTZ004",  # Use datetime.fromtimestamp(ts, tz=) instead of datetime.utcfromtimestamp(ts)
+    "E",       # pycodestyle
+    "F",       # pyflakes/autoflake
+    "G",       # flake8-logging-format
+    "I",       # isort
+    "ICN001",  # import concentions; {name} should be imported as {asname}
+    "N804",    # First argument of a class method should be named cls
+    "N805",    # First argument of a method should be named self
+    "N815",    # Variable {name} in class scope should not be mixedCase
     "PGH004",  # Use specific rule codes when using noqa
     "PLC0414", # Useless import alias. Import alias does not rename original package.
-    "SIM105", # Use contextlib.suppress({exception}) instead of try-except-pass
-    "SIM117", # Merge with-statements that use the same scope
-    "SIM118", # Use {key} in {dict} instead of {key} in {dict}.keys()
-    "SIM201", # Use {left} != {right} instead of not {left} == {right}
-    "SIM212", # Use {a} if {a} else {b} instead of {b} if not {a} else {a}
-    "SIM300", # Yoda conditions. Use 'age == 42' instead of '42 == age'.
-    "SIM401", # Use get from dict with default instead of an if block
-    "T20",  # flake8-print
-    "TRY004", # Prefer TypeError exception for invalid type
-    "RUF006", # Store a reference to the return value of asyncio.create_task
-    "UP",  # pyupgrade
-    "W",  # pycodestyle
+    "PLC",     # pylint
+    "PLE",     # pylint
+    "PLR",     # pylint
+    "PLW",     # pylint
+    "Q000",    # Double quotes found but single quotes preferred
+    "RUF006",  # Store a reference to the return value of asyncio.create_task
+    "S102",    # Use of exec detected
+    "S103",    # bad-file-permissions
+    "S108",    # hardcoded-temp-file
+    "S306",    # suspicious-mktemp-usage
+    "S307",    # suspicious-eval-usage
+    "S313",    # suspicious-xmlc-element-tree-usage
+    "S314",    # suspicious-xml-element-tree-usage
+    "S315",    # suspicious-xml-expat-reader-usage
+    "S316",    # suspicious-xml-expat-builder-usage
+    "S317",    # suspicious-xml-sax-usage
+    "S318",    # suspicious-xml-mini-dom-usage
+    "S319",    # suspicious-xml-pull-dom-usage
+    "S320",    # suspicious-xmle-tree-usage
+    "S601",    # paramiko-call
+    "S602",    # subprocess-popen-with-shell-equals-true
+    "S604",    # call-with-shell-equals-true
+    "S608",    # hardcoded-sql-expression
+    "S609",    # unix-command-wildcard-injection
+    "SIM105",  # Use contextlib.suppress({exception}) instead of try-except-pass
+    "SIM117",  # Merge with-statements that use the same scope
+    "SIM118",  # Use {key} in {dict} instead of {key} in {dict}.keys()
+    "SIM201",  # Use {left} != {right} instead of not {left} == {right}
+    "SIM208",  # Use {expr} instead of not (not {expr})
+    "SIM212",  # Use {a} if {a} else {b} instead of {b} if not {a} else {a}
+    "SIM300",  # Yoda conditions. Use 'age == 42' instead of '42 == age'.
+    "SIM401",  # Use get from dict with default instead of an if block
+    "T100",    # Trace found: {name} used
+    "T20",     # flake8-print
+    "TID251",  # Banned imports
+    "TRY004",  # Prefer TypeError exception for invalid type
+    "TRY302",  # Remove exception handler; error is immediately re-raised
+    "UP",      # pyupgrade
+    "W",       # pycodestyle
 ]
 
 ignore = [
-    "D202",  # No blank lines allowed after function docstring
-    "D203",  # 1 blank line required before class docstring
-    "D213",  # Multi-line docstring summary should start at the second line
-    "D404",  # First word of the docstring should not be This
-    "D406",  # Section name should end with a newline
-    "D407",  # Section name underlining
-    "D411",  # Missing blank line before section
-    "E501",  # line too long
-    "E731",  # do not assign a lambda expression, use a def
+    "D202", # No blank lines allowed after function docstring
+    "D203", # 1 blank line required before class docstring
+    "D213", # Multi-line docstring summary should start at the second line
+    "D406", # Section name should end with a newline
+    "D407", # Section name underlining
+    "E501", # line too long
+    "E731", # do not assign a lambda expression, use a def
+
+    # Ignore ignored, as the rule is now back in preview/nursery, which cannot
+    # be ignored anymore without warnings.
+    # https://github.com/astral-sh/ruff/issues/7491
+    # "PLC1901", # Lots of false positives
+
+    # False positives https://github.com/astral-sh/ruff/issues/5386
+    "PLC0208", # Use a sequence type instead of a `set` when iterating over values
+    "PLR0911", # Too many return statements ({returns} > {max_returns})
+    "PLR0912", # Too many branches ({branches} > {max_branches})
+    "PLR0913", # Too many arguments to function call ({c_args} > {max_args})
+    "PLR0915", # Too many statements ({statements} > {max_statements})
+    "PLR2004", # Magic value used in comparison, consider replacing {value} with a constant variable
+    "PLW2901", # Outer {outer_kind} variable {name} overwritten by inner {inner_kind} target
+    "UP006",   # keep type annotation style as is
+    "UP007",   # keep type annotation style as is
+    # Ignored due to performance: https://github.com/charliermarsh/ruff/issues/2923
+    "UP038", # Use `X | Y` in `isinstance` call instead of `(X, Y)`
+
+    # May conflict with the formatter, https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules
+    "W191",
+    "E111",
+    "E114",
+    "E117",
+    "D206",
+    "D300",
+    "Q000",
+    "Q001",
+    "Q002",
+    "Q003",
+    "COM812",
+    "COM819",
+    "ISC001",
+    "ISC002",
+
+    # Disabled because ruff does not understand type of __all__ generated by a function
+    "PLE0605",
 ]
 
 [flake8-pytest-style]

custom_components/smaev/__init__.py

@@ -6,7 +6,6 @@
 
 import pysmaev.core
 import pysmaev.exceptions
-
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import (
     CONF_HOST,
@@ -19,20 +18,21 @@
 from homeassistant.core import HomeAssistant
 from homeassistant.exceptions import ConfigEntryAuthFailed, ConfigEntryNotReady
 from homeassistant.helpers.aiohttp_client import async_get_clientsession
-from homeassistant.helpers.entity import async_generate_entity_id, EntityDescription
 from homeassistant.helpers.device_registry import DeviceInfo
-
+from homeassistant.helpers.entity import EntityDescription, async_generate_entity_id
 
 from .const import (
     DOMAIN,
+    SMAEV_CHANNELS,
     SMAEV_COORDINATOR,
     SMAEV_DEVICE_INFO,
+    SMAEV_MEASUREMENT,
     SMAEV_OBJECT,
+    SMAEV_PARAMETER,
 )
 from .coordinator import SmaEvChargerCoordinator
 from .services import async_setup_services, async_unload_services
 
-
 PLATFORMS: list[Platform] = [
     Platform.DATETIME,
     Platform.NUMBER,
@@ -79,12 +79,19 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
         sw_version=smaev_device_info["sw_version"],
     )
 
+    measurement_channels = await evcharger.get_measurement_channels()
+    parameter_channels = await evcharger.get_parameter_channels()
+
     coordinator = SmaEvChargerCoordinator(hass, entry, evcharger)
 
     hass.data[DOMAIN][entry.entry_id] = {
         SMAEV_OBJECT: evcharger,
         SMAEV_DEVICE_INFO: device_info,
         SMAEV_COORDINATOR: coordinator,
+        SMAEV_CHANNELS: {
+            SMAEV_MEASUREMENT: measurement_channels,
+            SMAEV_PARAMETER: parameter_channels,
+        },
     }
 
     await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)

custom_components/smaev/config_flow.py

@@ -1,17 +1,15 @@
 """Config flow for SMA EV Charger integration."""
 from __future__ import annotations
 
-from collections.abc import Mapping
 import logging
+from collections.abc import Mapping
 from typing import Any
 
+import homeassistant.helpers.config_validation as cv
 import pysmaev.core
 import pysmaev.exceptions
-
 import voluptuous as vol
-
 from homeassistant import config_entries
-from homeassistant.core import callback
 from homeassistant.const import (
     CONF_BASE,
     CONF_HOST,
@@ -20,10 +18,9 @@
     CONF_USERNAME,
     CONF_VERIFY_SSL,
 )
-from homeassistant.core import HomeAssistant
+from homeassistant.core import HomeAssistant, callback
 from homeassistant.data_entry_flow import FlowResult
 from homeassistant.helpers.aiohttp_client import async_get_clientsession
-import homeassistant.helpers.config_validation as cv
 
 from .const import DOMAIN
 

custom_components/smaev/const.py

@@ -1,6 +1,7 @@
 """Constants for the SMA EV Charger integration."""
 DOMAIN = "smaev"
 
+SMAEV_CHANNELS = "channels"
 SMAEV_COORDINATOR = "coordinator"
 SMAEV_OBJECT = "pysmaev"
 SMAEV_DEVICE_INFO = "device_info"

custom_components/smaev/coordinator.py

@@ -1,25 +1,23 @@
 """DataUpdateCoordinator for the SMA EV Charger integration."""
-from datetime import timedelta
 import logging
-
-from pysmaev.core import SmaEvCharger
-from pysmaev.exceptions import SmaEvChargerConnectionError, SmaEvChargerException
+from datetime import timedelta
 
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import CONF_SCAN_INTERVAL
 from homeassistant.core import HomeAssistant, callback
 from homeassistant.helpers import device_registry as dr
 from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
+from pysmaev.core import SmaEvCharger
+from pysmaev.exceptions import SmaEvChargerConnectionError, SmaEvChargerException
 
 from .const import (
-    DOMAIN,
     DEFAULT_SCAN_INTERVAL,
+    DOMAIN,
+    SMAEV_COORDINATOR,
     SMAEV_MEASUREMENT,
     SMAEV_PARAMETER,
-    SMAEV_COORDINATOR,
 )
 
-
 _LOGGER = logging.getLogger(__name__)
 
 
@@ -41,8 +39,8 @@ async def _async_update_data(self):
         if self.evcharger.is_closed:
             try:
                 await self.evcharger.open()
-            except SmaEvChargerException:
-                raise UpdateFailed("Connection to device lost.")
+            except SmaEvChargerException as exc:
+                raise UpdateFailed("Connection to device lost.") from exc
 
         data = {}
         try:

custom_components/smaev/datetime.py

@@ -1,13 +1,11 @@
 """DateTime platform for SMA EV Charger integration."""
 from __future__ import annotations
 
+import logging
 from dataclasses import dataclass
 from datetime import UTC, datetime
-import logging
 from typing import TYPE_CHECKING
 
-from pysmaev.helpers import get_parameters_channel
-
 from homeassistant.components.datetime import (
     ENTITY_ID_FORMAT,
     DateTimeEntity,
@@ -21,10 +19,12 @@
     CoordinatorEntity,
     DataUpdateCoordinator,
 )
+from pysmaev.helpers import get_parameters_channel
 
 from . import generate_smaev_entity_id
 from .const import (
     DOMAIN,
+    SMAEV_CHANNELS,
     SMAEV_COORDINATOR,
     SMAEV_DEVICE_INFO,
     SMAEV_PARAMETER,
@@ -70,11 +70,17 @@ async def async_setup_entry(
     entities = []
 
     for entity_description in DATETIME_DESCRIPTIONS:
-        entities.append(
-            SmaEvChargerDateTime(
-                hass, coordinator, config_entry, device_info, entity_description
+        if entity_description.channel in data[SMAEV_CHANNELS][entity_description.type]:
+            entities.append(
+                SmaEvChargerDateTime(
+                    hass, coordinator, config_entry, device_info, entity_description
+                )
+            )
+        else:
+            _LOGGER.warning(
+                "Channel '%s' is not accessible. Elevated rights might be required.",
+                entity_description.channel,
             )
-        )
 
     async_add_entities(entities)
 

custom_components/smaev/device_action.py

@@ -2,15 +2,15 @@
 from __future__ import annotations
 
 import voluptuous as vol
-
 from homeassistant.const import (
     ATTR_DEVICE_ID,
     CONF_DEVICE_ID,
     CONF_DOMAIN,
     CONF_TYPE,
 )
 from homeassistant.core import Context, HomeAssistant
-from homeassistant.helpers import config_validation as cv, device_registry as dr
+from homeassistant.helpers import config_validation as cv
+from homeassistant.helpers import device_registry as dr
 
 from . import DOMAIN
 from .const import SERVICE_RESTART