Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extract foscam base entity for reuse #108893

Merged
merged 5 commits into from
Jan 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .coveragerc
Original file line number Diff line number Diff line change
Expand Up @@ -433,6 +433,7 @@ omit =
homeassistant/components/foscam/__init__.py
homeassistant/components/foscam/camera.py
homeassistant/components/foscam/coordinator.py
homeassistant/components/foscam/entity.py
homeassistant/components/foursquare/*
homeassistant/components/free_mobile/notify.py
homeassistant/components/freebox/camera.py
Expand Down
17 changes: 3 additions & 14 deletions homeassistant/components/foscam/camera.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@
from homeassistant.const import CONF_PASSWORD, CONF_USERNAME
from homeassistant.core import HomeAssistant
from homeassistant.helpers import config_validation as cv, entity_platform
from homeassistant.helpers.device_registry import DeviceInfo
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.update_coordinator import CoordinatorEntity

from .const import (
CONF_RTSP_PORT,
Expand All @@ -23,6 +21,7 @@
SERVICE_PTZ_PRESET,
)
from .coordinator import FoscamCoordinator
from .entity import FoscamEntity

DIR_UP = "up"
DIR_DOWN = "down"
Expand Down Expand Up @@ -94,7 +93,7 @@ async def async_setup_entry(
async_add_entities([HassFoscamCamera(coordinator, config_entry)])


class HassFoscamCamera(CoordinatorEntity[FoscamCoordinator], Camera):
class HassFoscamCamera(FoscamEntity, Camera):
"""An implementation of a Foscam IP camera."""

_attr_has_entity_name = True
Expand All @@ -106,7 +105,7 @@ def __init__(
config_entry: ConfigEntry,
) -> None:
"""Initialize a Foscam camera."""
super().__init__(coordinator)
super().__init__(coordinator, config_entry.entry_id)
Camera.__init__(self)

self._foscam_session = coordinator.session
Expand All @@ -118,16 +117,6 @@ def __init__(
if self._rtsp_port:
self._attr_supported_features = CameraEntityFeature.STREAM

self._attr_device_info = DeviceInfo(
identifiers={(DOMAIN, config_entry.entry_id)},
manufacturer="Foscam",
name=config_entry.title,
)
if dev_info := coordinator.data.get("dev_info"):
self._attr_device_info["model"] = dev_info["productName"]
self._attr_device_info["sw_version"] = dev_info["firmwareVer"]
self._attr_device_info["hw_version"] = dev_info["hardwareVer"]

async def async_added_to_hass(self) -> None:
"""Handle entity addition to hass."""
# Get motion detection status
Expand Down
30 changes: 30 additions & 0 deletions homeassistant/components/foscam/entity.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
"""Component providing basic support for Foscam IP cameras."""
from __future__ import annotations

from homeassistant.const import ATTR_HW_VERSION, ATTR_MODEL, ATTR_SW_VERSION
from homeassistant.helpers.device_registry import DeviceInfo
from homeassistant.helpers.update_coordinator import CoordinatorEntity
krmarien marked this conversation as resolved.
Show resolved Hide resolved

from .const import DOMAIN
from .coordinator import FoscamCoordinator


class FoscamEntity(CoordinatorEntity[FoscamCoordinator]):
"""Base entity for Foscam camera."""

def __init__(
self,
coordinator: FoscamCoordinator,
entry_id: str,
) -> None:
"""Initialize the base Foscam entity."""
super().__init__(coordinator)

self._attr_device_info = DeviceInfo(
identifiers={(DOMAIN, entry_id)},
manufacturer="Foscam",
)
if dev_info := coordinator.data.get("dev_info"):
self._attr_device_info[ATTR_MODEL] = dev_info["productName"]
self._attr_device_info[ATTR_SW_VERSION] = dev_info["firmwareVer"]
self._attr_device_info[ATTR_HW_VERSION] = dev_info["hardwareVer"]
Loading