Move opengarage coordinator to separate module (#117608)

This commit is contained in:
epenet 2024-05-17 08:05:43 +02:00 committed by GitHub
parent 407d0f88f0
commit bbf86335be
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 53 additions and 42 deletions

View File

@ -2,22 +2,15 @@
from __future__ import annotations
from datetime import timedelta
import logging
from typing import Any
import opengarage
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import CONF_HOST, CONF_PORT, CONF_VERIFY_SSL, Platform
from homeassistant.core import HomeAssistant
from homeassistant.helpers import update_coordinator
from homeassistant.helpers.aiohttp_client import async_get_clientsession
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator
from .const import CONF_DEVICE_KEY, DOMAIN
_LOGGER = logging.getLogger(__name__)
from .coordinator import OpenGarageDataUpdateCoordinator
PLATFORMS = [Platform.BINARY_SENSOR, Platform.BUTTON, Platform.COVER, Platform.SENSOR]
@ -49,32 +42,3 @@ async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
hass.data[DOMAIN].pop(entry.entry_id)
return unload_ok
class OpenGarageDataUpdateCoordinator(DataUpdateCoordinator[dict[str, Any]]): # pylint: disable=hass-enforce-coordinator-module
"""Class to manage fetching Opengarage data."""
def __init__(
self,
hass: HomeAssistant,
*,
open_garage_connection: opengarage.OpenGarage,
) -> None:
"""Initialize global Opengarage data updater."""
self.open_garage_connection = open_garage_connection
super().__init__(
hass,
_LOGGER,
name=DOMAIN,
update_interval=timedelta(seconds=5),
)
async def _async_update_data(self) -> dict[str, Any]:
"""Fetch data."""
data = await self.open_garage_connection.update_state()
if data is None:
raise update_coordinator.UpdateFailed(
"Unable to connect to OpenGarage device"
)
return data

View File

@ -13,8 +13,8 @@ from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from . import OpenGarageDataUpdateCoordinator
from .const import DOMAIN
from .coordinator import OpenGarageDataUpdateCoordinator
from .entity import OpenGarageEntity
_LOGGER = logging.getLogger(__name__)

View File

@ -18,8 +18,8 @@ from homeassistant.const import EntityCategory
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from . import OpenGarageDataUpdateCoordinator
from .const import DOMAIN
from .coordinator import OpenGarageDataUpdateCoordinator
from .entity import OpenGarageEntity

View File

@ -0,0 +1,46 @@
"""The OpenGarage integration."""
from __future__ import annotations
from datetime import timedelta
import logging
from typing import Any
import opengarage
from homeassistant.core import HomeAssistant
from homeassistant.helpers import update_coordinator
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator
from .const import DOMAIN
_LOGGER = logging.getLogger(__name__)
class OpenGarageDataUpdateCoordinator(DataUpdateCoordinator[dict[str, Any]]):
"""Class to manage fetching Opengarage data."""
def __init__(
self,
hass: HomeAssistant,
*,
open_garage_connection: opengarage.OpenGarage,
) -> None:
"""Initialize global Opengarage data updater."""
self.open_garage_connection = open_garage_connection
super().__init__(
hass,
_LOGGER,
name=DOMAIN,
update_interval=timedelta(seconds=5),
)
async def _async_update_data(self) -> dict[str, Any]:
"""Fetch data."""
data = await self.open_garage_connection.update_state()
if data is None:
raise update_coordinator.UpdateFailed(
"Unable to connect to OpenGarage device"
)
return data

View File

@ -15,8 +15,8 @@ from homeassistant.const import STATE_CLOSED, STATE_CLOSING, STATE_OPEN, STATE_O
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from . import OpenGarageDataUpdateCoordinator
from .const import DOMAIN
from .coordinator import OpenGarageDataUpdateCoordinator
from .entity import OpenGarageEntity
_LOGGER = logging.getLogger(__name__)

View File

@ -7,7 +7,8 @@ from homeassistant.helpers.device_registry import CONNECTION_NETWORK_MAC, Device
from homeassistant.helpers.entity import EntityDescription
from homeassistant.helpers.update_coordinator import CoordinatorEntity
from . import DOMAIN, OpenGarageDataUpdateCoordinator
from .const import DOMAIN
from .coordinator import OpenGarageDataUpdateCoordinator
class OpenGarageEntity(CoordinatorEntity[OpenGarageDataUpdateCoordinator]):

View File

@ -22,8 +22,8 @@ from homeassistant.const import (
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from . import OpenGarageDataUpdateCoordinator
from .const import DOMAIN
from .coordinator import OpenGarageDataUpdateCoordinator
from .entity import OpenGarageEntity
_LOGGER = logging.getLogger(__name__)