Use runtime_data in blebox (#129070)

This commit is contained in:
epenet 2024-10-24 14:32:20 +02:00 committed by GitHub
parent 3e62c6ae2f
commit add8db0186
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
10 changed files with 35 additions and 61 deletions

View File

@ -17,9 +17,11 @@ from homeassistant.const import (
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import ConfigEntryNotReady
from .const import DEFAULT_SETUP_TIMEOUT, DOMAIN, PRODUCT
from .const import DEFAULT_SETUP_TIMEOUT
from .helpers import get_maybe_authenticated_session
type BleBoxConfigEntry = ConfigEntry[Box]
_LOGGER = logging.getLogger(__name__)
PLATFORMS = [
@ -35,7 +37,7 @@ PLATFORMS = [
PARALLEL_UPDATES = 0
async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
async def async_setup_entry(hass: HomeAssistant, entry: BleBoxConfigEntry) -> bool:
"""Set up BleBox devices from a config entry."""
host = entry.data[CONF_HOST]
port = entry.data[CONF_PORT]
@ -55,20 +57,13 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
_LOGGER.error("Identify failed at %s:%d (%s)", api_host.host, api_host.port, ex)
raise ConfigEntryNotReady from ex
domain = hass.data.setdefault(DOMAIN, {})
domain_entry = domain.setdefault(entry.entry_id, {})
product = domain_entry.setdefault(PRODUCT, product)
entry.runtime_data = product
await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
return True
async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
async def async_unload_entry(hass: HomeAssistant, entry: BleBoxConfigEntry) -> bool:
"""Unload a config entry."""
unload_ok = await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
if unload_ok:
hass.data[DOMAIN].pop(entry.entry_id)
return unload_ok
return await hass.config_entries.async_unload_platforms(entry, PLATFORMS)

View File

@ -1,18 +1,16 @@
"""BleBox binary sensor entities."""
from blebox_uniapi.binary_sensor import BinarySensor as BinarySensorFeature
from blebox_uniapi.box import Box
from homeassistant.components.binary_sensor import (
BinarySensorDeviceClass,
BinarySensorEntity,
BinarySensorEntityDescription,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from .const import DOMAIN, PRODUCT
from . import BleBoxConfigEntry
from .entity import BleBoxEntity
BINARY_SENSOR_TYPES = (
@ -25,15 +23,13 @@ BINARY_SENSOR_TYPES = (
async def async_setup_entry(
hass: HomeAssistant,
config_entry: ConfigEntry,
config_entry: BleBoxConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up a BleBox entry."""
product: Box = hass.data[DOMAIN][config_entry.entry_id][PRODUCT]
entities = [
BleBoxBinarySensorEntity(feature, description)
for feature in product.features.get("binary_sensors", [])
for feature in config_entry.runtime_data.features.get("binary_sensors", [])
for description in BINARY_SENSOR_TYPES
if description.key == feature.device_class
]

View File

@ -2,28 +2,25 @@
from __future__ import annotations
from blebox_uniapi.box import Box
import blebox_uniapi.button
from homeassistant.components.button import ButtonEntity
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from .const import DOMAIN, PRODUCT
from . import BleBoxConfigEntry
from .entity import BleBoxEntity
async def async_setup_entry(
hass: HomeAssistant,
config_entry: ConfigEntry,
config_entry: BleBoxConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up a BleBox button entry."""
product: Box = hass.data[DOMAIN][config_entry.entry_id][PRODUCT]
entities = [
BleBoxButtonEntity(feature) for feature in product.features.get("buttons", [])
BleBoxButtonEntity(feature)
for feature in config_entry.runtime_data.features.get("buttons", [])
]
async_add_entities(entities, True)

View File

@ -3,7 +3,6 @@
from datetime import timedelta
from typing import Any
from blebox_uniapi.box import Box
import blebox_uniapi.climate
from homeassistant.components.climate import (
@ -12,12 +11,11 @@ from homeassistant.components.climate import (
HVACAction,
HVACMode,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import ATTR_TEMPERATURE, UnitOfTemperature
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from .const import DOMAIN, PRODUCT
from . import BleBoxConfigEntry
from .entity import BleBoxEntity
SCAN_INTERVAL = timedelta(seconds=5)
@ -39,14 +37,13 @@ BLEBOX_TO_HVACACTION = {
async def async_setup_entry(
hass: HomeAssistant,
config_entry: ConfigEntry,
config_entry: BleBoxConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up a BleBox climate entity."""
product: Box = hass.data[DOMAIN][config_entry.entry_id][PRODUCT]
entities = [
BleBoxClimateEntity(feature) for feature in product.features.get("climates", [])
BleBoxClimateEntity(feature)
for feature in config_entry.runtime_data.features.get("climates", [])
]
async_add_entities(entities, True)

View File

@ -1,7 +1,6 @@
"""Constants for the BleBox devices integration."""
DOMAIN = "blebox"
PRODUCT = "product"
DEFAULT_SETUP_TIMEOUT = 10

View File

@ -4,7 +4,6 @@ from __future__ import annotations
from typing import Any
from blebox_uniapi.box import Box
import blebox_uniapi.cover
from blebox_uniapi.cover import BleboxCoverState
@ -16,11 +15,10 @@ from homeassistant.components.cover import (
CoverEntityFeature,
CoverState,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from .const import DOMAIN, PRODUCT
from . import BleBoxConfigEntry
from .entity import BleBoxEntity
BLEBOX_TO_COVER_DEVICE_CLASSES = {
@ -46,13 +44,13 @@ BLEBOX_TO_HASS_COVER_STATES = {
async def async_setup_entry(
hass: HomeAssistant,
config_entry: ConfigEntry,
config_entry: BleBoxConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up a BleBox entry."""
product: Box = hass.data[DOMAIN][config_entry.entry_id][PRODUCT]
entities = [
BleBoxCoverEntity(feature) for feature in product.features.get("covers", [])
BleBoxCoverEntity(feature)
for feature in config_entry.runtime_data.features.get("covers", [])
]
async_add_entities(entities, True)

View File

@ -6,7 +6,6 @@ from datetime import timedelta
import logging
from typing import Any
from blebox_uniapi.box import Box
import blebox_uniapi.light
from blebox_uniapi.light import BleboxColorMode
@ -21,11 +20,10 @@ from homeassistant.components.light import (
LightEntity,
LightEntityFeature,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from .const import DOMAIN, PRODUCT
from . import BleBoxConfigEntry
from .entity import BleBoxEntity
_LOGGER = logging.getLogger(__name__)
@ -35,13 +33,13 @@ SCAN_INTERVAL = timedelta(seconds=5)
async def async_setup_entry(
hass: HomeAssistant,
config_entry: ConfigEntry,
config_entry: BleBoxConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up a BleBox entry."""
product: Box = hass.data[DOMAIN][config_entry.entry_id][PRODUCT]
entities = [
BleBoxLightEntity(feature) for feature in product.features.get("lights", [])
BleBoxLightEntity(feature)
for feature in config_entry.runtime_data.features.get("lights", [])
]
async_add_entities(entities, True)

View File

@ -1,6 +1,5 @@
"""BleBox sensor entities."""
from blebox_uniapi.box import Box
import blebox_uniapi.sensor
from homeassistant.components.sensor import (
@ -9,7 +8,6 @@ from homeassistant.components.sensor import (
SensorEntityDescription,
SensorStateClass,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import (
CONCENTRATION_MICROGRAMS_PER_CUBIC_METER,
LIGHT_LUX,
@ -27,7 +25,7 @@ from homeassistant.const import (
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from .const import DOMAIN, PRODUCT
from . import BleBoxConfigEntry
from .entity import BleBoxEntity
SENSOR_TYPES = (
@ -117,14 +115,13 @@ SENSOR_TYPES = (
async def async_setup_entry(
hass: HomeAssistant,
config_entry: ConfigEntry,
config_entry: BleBoxConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up a BleBox entry."""
product: Box = hass.data[DOMAIN][config_entry.entry_id][PRODUCT]
entities = [
BleBoxSensorEntity(feature, description)
for feature in product.features.get("sensors", [])
for feature in config_entry.runtime_data.features.get("sensors", [])
for description in SENSOR_TYPES
if description.key == feature.device_class
]

View File

@ -3,15 +3,13 @@
from datetime import timedelta
from typing import Any
from blebox_uniapi.box import Box
import blebox_uniapi.switch
from homeassistant.components.switch import SwitchDeviceClass, SwitchEntity
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from .const import DOMAIN, PRODUCT
from . import BleBoxConfigEntry
from .entity import BleBoxEntity
SCAN_INTERVAL = timedelta(seconds=5)
@ -19,13 +17,13 @@ SCAN_INTERVAL = timedelta(seconds=5)
async def async_setup_entry(
hass: HomeAssistant,
config_entry: ConfigEntry,
config_entry: BleBoxConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up a BleBox switch entity."""
product: Box = hass.data[DOMAIN][config_entry.entry_id][PRODUCT]
entities = [
BleBoxSwitchEntity(feature) for feature in product.features.get("switches", [])
BleBoxSwitchEntity(feature)
for feature in config_entry.runtime_data.features.get("switches", [])
]
async_add_entities(entities, True)

View File

@ -5,7 +5,6 @@ import logging
import blebox_uniapi
import pytest
from homeassistant.components.blebox.const import DOMAIN
from homeassistant.config_entries import ConfigEntryState
from homeassistant.core import HomeAssistant
@ -57,10 +56,10 @@ async def test_unload_config_entry(hass: HomeAssistant) -> None:
await hass.config_entries.async_setup(entry.entry_id)
await hass.async_block_till_done()
assert hass.data[DOMAIN]
assert hasattr(entry, "runtime_data")
await hass.config_entries.async_unload(entry.entry_id)
await hass.async_block_till_done()
assert not hass.data.get(DOMAIN)
assert not hasattr(entry, "runtime_data")
assert entry.state is ConfigEntryState.NOT_LOADED