Support Home Assistant 2024.8.3 or newer (#82)

Drop support for HA versions before 2024.8.3.
Drop platform config support.
Fix Broken help link on adding new integration #81.

Author: pnbruckner

README.md

@@ -76,7 +76,7 @@ After it has been downloaded you will need to restart Home Assistant.
 
 ### Versions
 
-This custom integration supports HomeAssistant versions 2023.4.0 or newer.
+This custom integration supports HomeAssistant versions 2024.8.3 or newer.
 
 ## Services
 
@@ -99,38 +99,5 @@ Key | Optional | Description
 `name` | yes | Name of the sensor. Default is `Illuminance`.
 `scan_interval` | yes | Update interval. Minimum is 30 seconds. Default is 5 minutes.
 
-## Converting from `platform` configuration
-
-In previous versions, configuration was done under `sensor`.
-This is now deprecated and will generate a warning at startup.
-It should be converted to the new `illuminance` format as described above.
-Or simply remove it and add the sensor(s) via the UI.
-
-Here is an example of the old format:
-
-```yaml
-sensor:
-  - platform: illuminance
-    entity_id: weather.home_forecast
-    fallback: 5
-    mode: normal
-    name: Weather-Based Sun Illuminance
-    scan_interval:
-      minutes: 10
-```
-
-This is the equivalent configuration in the new format:
-
-```yaml
-illuminance:
-  - unique_id: 1
-    entity_id: weather.home_forecast
-    fallback: 5
-    mode: normal
-    name: Weather-Based Sun Illuminance
-    scan_interval:
-      minutes: 10
-```
-
 ## Releases Before 2.1.0
 See https://github.com/pnbruckner/homeassistant-config/blob/master/docs/illuminance.md.

custom_components/__init__.py

@@ -0,0 +1 @@
+"""Illuminance Sensor."""

custom_components/illuminance/__init__.py

@@ -22,7 +22,7 @@
 from homeassistant.helpers.typing import ConfigType
 
 from .const import DOMAIN
-from .sensor import ILLUMINANCE_SCHEMA
+from .sensor import ILLUMINANCE_SCHEMA, LOC_ELEV
 
 _ILLUMINANCE_SCHEMA = vol.Schema(
     ILLUMINANCE_SCHEMA
@@ -64,7 +64,7 @@ def get_loc_elev() -> None:
             """
             loc, elv = get_astral_location(hass)
             loc.tzinfo  # noqa: B018
-            hass.data[DOMAIN] = loc, elv
+            hass.data[LOC_ELEV] = loc, elv
 
         await hass.async_add_executor_job(get_loc_elev)
 
@@ -84,7 +84,7 @@ async def process_config(
                 tasks.append(hass.config_entries.async_remove(entry.entry_id))
 
         for conf in configs:
-            tasks.append(
+            tasks.append(  # noqa: PERF401
                 hass.config_entries.flow.async_init(
                     DOMAIN, context={"source": SOURCE_IMPORT}, data=conf.copy()
                 )

custom_components/illuminance/config_flow.py

@@ -10,7 +10,9 @@
 from homeassistant.config_entries import (
     SOURCE_IMPORT,
     ConfigEntry,
+    ConfigEntryBaseFlow,
     ConfigFlow,
+    ConfigFlowResult,
     OptionsFlowWithConfigEntry,
 )
 from homeassistant.const import (
@@ -21,7 +23,6 @@
     CONF_UNIQUE_ID,
 )
 from homeassistant.core import callback
-from homeassistant.data_entry_flow import FlowHandler, FlowResult
 from homeassistant.helpers.selector import (
     EntitySelector,
     EntitySelectorConfig,
@@ -43,7 +44,7 @@
 from .sensor import MODES
 
 
-class IlluminanceFlow(FlowHandler):
+class IlluminanceFlow(ConfigEntryBaseFlow):
     """Illuminance flow mixin."""
 
     @property
@@ -53,7 +54,7 @@ def options(self) -> dict[str, Any]:
 
     async def async_step_options(
         self, user_input: dict[str, Any] | None = None
-    ) -> FlowResult:
+    ) -> ConfigFlowResult:
         """Get sensor options."""
         if user_input is not None:
             self.options.clear()
@@ -100,7 +101,9 @@ async def async_step_options(
         return self.async_show_form(step_id="options", data_schema=data_schema)
 
     @abstractmethod
-    async def async_step_done(self, _: dict[str, Any] | None = None) -> FlowResult:
+    async def async_step_done(
+        self, _: dict[str, Any] | None = None
+    ) -> ConfigFlowResult:
         """Finish the flow."""
 
 
@@ -136,7 +139,7 @@ def options(self) -> dict[str, Any]:
         """Return mutable copy of options."""
         return self._options
 
-    async def async_step_import(self, data: dict[str, Any]) -> FlowResult:
+    async def async_step_import(self, data: dict[str, Any]) -> ConfigFlowResult:
         """Import config entry from configuration."""
         title = data.pop(CONF_NAME)
         # Convert from timedelta to float in minutes.
@@ -151,13 +154,15 @@ async def async_step_import(self, data: dict[str, Any]) -> FlowResult:
 
         return self.async_create_entry(title=title, data={}, options=data)
 
-    async def async_step_user(self, _: dict[str, Any] | None = None) -> FlowResult:
+    async def async_step_user(
+        self, _: dict[str, Any] | None = None
+    ) -> ConfigFlowResult:
         """Start user config flow."""
         return await self.async_step_name()
 
     async def async_step_name(
         self, user_input: dict[str, Any] | None = None
-    ) -> FlowResult:
+    ) -> ConfigFlowResult:
         """Get name."""
         if user_input is not None:
             self._name = user_input[CONF_NAME]
@@ -168,14 +173,18 @@ async def async_step_name(
             step_id="name", data_schema=vol.Schema(schema), last_step=False
         )
 
-    async def async_step_done(self, _: dict[str, Any] | None = None) -> FlowResult:
+    async def async_step_done(
+        self, _: dict[str, Any] | None = None
+    ) -> ConfigFlowResult:
         """Finish the flow."""
         return self.async_create_entry(title=self._name, data={}, options=self.options)
 
 
 class IlluminanceOptionsFlow(OptionsFlowWithConfigEntry, IlluminanceFlow):
     """Sun2 integration options flow."""
 
-    async def async_step_done(self, _: dict[str, Any] | None = None) -> FlowResult:
+    async def async_step_done(
+        self, _: dict[str, Any] | None = None
+    ) -> ConfigFlowResult:
         """Finish the flow."""
         return self.async_create_entry(title="", data=self.options or {})

custom_components/illuminance/manifest.json

@@ -4,9 +4,9 @@
   "codeowners": ["@pnbruckner"],
   "config_flow": true,
   "dependencies": [],
-  "documentation": "https://github.com/pnbruckner/ha-illuminance/5.6.1/master/README.md",
+  "documentation": "https://github.com/pnbruckner/ha-illuminance/blob/5.7.0b0/README.md",
   "iot_class": "calculated",
   "issue_tracker": "https://github.com/pnbruckner/ha-illuminance/issues",
   "requirements": [],
-  "version": "5.6.1"
+  "version": "5.7.0b0"
 }

custom_components/illuminance/sensor.py

@@ -9,7 +9,7 @@
 from dataclasses import dataclass
 from datetime import date, datetime, timedelta
 from enum import Enum, IntEnum, auto
-from functools import cached_property
+from functools import cached_property  # pylint: disable=hass-deprecated-import
 import logging
 from math import asin, cos, exp, radians, sin
 import re
@@ -20,8 +20,7 @@
 import voluptuous as vol
 
 from homeassistant.components.sensor import (
-    DOMAIN as SENSOR_DOMAIN,
-    PLATFORM_SCHEMA,
+    PLATFORM_SCHEMA as SENSOR_PLATFORM_SCHEMA,
     SensorDeviceClass,
     SensorEntity,
     SensorEntityDescription,
@@ -50,28 +49,27 @@
     CONF_ENTITY_ID,
     CONF_MODE,
     CONF_NAME,
-    CONF_PLATFORM,
     CONF_SCAN_INTERVAL,
     LIGHT_LUX,
     STATE_UNAVAILABLE,
     STATE_UNKNOWN,
     UnitOfIrradiance,
 )
-from homeassistant.core import Event, HomeAssistant, State, callback
+from homeassistant.core import (
+    Event,
+    EventStateChangedData,
+    HomeAssistant,
+    State,
+    callback,
+)
 import homeassistant.helpers.config_validation as cv
-from homeassistant.helpers.device_registry import DeviceEntryType
-
-# Device Info moved to device_registry in 2023.9
-try:
-    from homeassistant.helpers.device_registry import DeviceInfo
-except ImportError:
-    from homeassistant.helpers.entity import DeviceInfo  # type: ignore[attr-defined]
-
+from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo
 from homeassistant.helpers.entity import Entity
 from homeassistant.helpers.entity_platform import AddEntitiesCallback, EntityPlatform
 from homeassistant.helpers.event import async_track_state_change_event
-from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
+from homeassistant.helpers.typing import ConfigType
 import homeassistant.util.dt as dt_util
+from homeassistant.util.hass_dict import HassKey
 
 from .const import (
     CONF_FALLBACK,
@@ -124,6 +122,8 @@
 
 ADDITIONAL_MAPPINGS = ((AW_PATTERN, AW_MAPPING), (ECOBEE_PATTERN, ECOBEE_MAPPING))
 
+LOC_ELEV: HassKey[tuple[Location, Elevation]] = HassKey(DOMAIN)
+
 _LOGGER = logging.getLogger(__name__)
 
 
@@ -146,7 +146,7 @@ class Mode(Enum):
     vol.Optional(CONF_MODE, default=MODES[0]): vol.In(MODES),
     vol.Optional(CONF_FALLBACK): vol.All(vol.Coerce(float), vol.Range(1, 10)),
 }
-PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(ILLUMINANCE_SCHEMA)
+PLATFORM_SCHEMA = SENSOR_PLATFORM_SCHEMA.extend(ILLUMINANCE_SCHEMA)
 
 _20_MIN = timedelta(minutes=20)
 _40_MIN = timedelta(minutes=40)
@@ -165,19 +165,15 @@ class IlluminanceSensorEntityDescription(SensorEntityDescription):  # type: igno
     scan_interval: timedelta | None = None
 
 
-def _sensor(
-    config: ConfigType,
-    unique_id: str | None = None,
-    scan_interval: timedelta | None = None,
-) -> Entity:
+def _sensor(config: ConfigType, unique_id: str, scan_interval: timedelta) -> Entity:
     """Create entity to add."""
     weather_entity = config.get(CONF_ENTITY_ID)
     fallback = cast(
         float, config.get(CONF_FALLBACK, DEFAULT_FALLBACK if weather_entity else 1)
     )
     if (mode := Mode.__getitem__(cast(str, config[CONF_MODE]))) is Mode.irradiance:
         device_class = SensorDeviceClass.IRRADIANCE
-        native_unit_of_measurement = UnitOfIrradiance.WATTS_PER_SQUARE_METER
+        native_unit_of_measurement: str = UnitOfIrradiance.WATTS_PER_SQUARE_METER
         suggested_display_precision = 1
     else:
         device_class = SensorDeviceClass.ILLUMINANCE
@@ -200,24 +196,6 @@ def _sensor(
     return IlluminanceSensor(entity_description)
 
 
-async def async_setup_platform(
-    hass: HomeAssistant,
-    config: ConfigType,
-    async_add_entities: AddEntitiesCallback,
-    discovery_info: DiscoveryInfoType | None = None,
-) -> None:
-    """Set up sensors."""
-    _LOGGER.warning(
-        "%s: %s under %s is deprecated. Move to %s:",
-        CONF_PLATFORM,
-        DOMAIN,
-        SENSOR_DOMAIN,
-        DOMAIN,
-    )
-
-    async_add_entities([_sensor(config)], True)
-
-
 async def async_setup_entry(
     hass: HomeAssistant,
     entry: ConfigEntry,
@@ -264,7 +242,7 @@ class IlluminanceSensor(SensorEntity):
     _attr_device_info = DeviceInfo(
         entry_type=DeviceEntryType.SERVICE,
         identifiers={(DOMAIN, DOMAIN)},
-        name=DOMAIN.title(),
+        translation_key="service",
     )
     _entity_status = EntityStatus.NOT_SEEN
     _sk_mapping: Sequence[tuple[Num, Sequence[str]]] | None = None
@@ -321,7 +299,7 @@ def add_to_platform_start(
             return
 
         @callback
-        def sensor_state_listener(event: Event) -> None:
+        def sensor_state_listener(event: Event[EventStateChangedData]) -> None:
             """Process input entity state update."""
             new_state: State | None = event.data["new_state"]
             old_state: State | None = event.data["old_state"]
@@ -491,7 +469,7 @@ def _calculate_illuminance(self, now: datetime) -> Num:
 
     def _astral_event(self, event: str, date_or_dt: date | datetime) -> Any:
         """Get astral event."""
-        loc, elev = cast(tuple[Location, Elevation], self.hass.data[DOMAIN])
+        loc, elev = self.hass.data[LOC_ELEV]
         if event == "solar_elevation":
             return getattr(loc, event)(date_or_dt, observer_elevation=elev)
         return getattr(loc, event)(date_or_dt, local=False, observer_elevation=elev)

custom_components/illuminance/translations/en.json

@@ -20,6 +20,11 @@
             }
         }
     },
+    "device": {
+        "service": {
+            "name": "Illuminance"
+        }
+    },
     "options": {
         "step": {
             "options": {

custom_components/illuminance/translations/it.json

@@ -19,6 +19,11 @@
             }
         }
     },
+    "device": {
+        "service": {
+            "name": "Illuminazione"
+        }
+    },
     "options": {
         "step": {
             "options": {

custom_components/illuminance/translations/nl.json

@@ -19,6 +19,11 @@
             }
         }
     },
+    "device": {
+        "service": {
+            "name": "Verlichtingssterkte"
+        }
+    },
     "options": {
         "step": {
             "options": {

custom_components/illuminance/translations/pl.json

@@ -19,6 +19,11 @@
             }
         }
     },
+    "device": {
+        "service": {
+            "name": "Natężenie oświetlenia"
+        }
+    },
     "options": {
         "step": {
             "options": {