Add EZVIZ AlarmControlPanelEntity (#96602)

* Add ezviz alarm panel

---------

Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>
Co-authored-by: Joakim Plate <elupus@ecce.se>
This commit is contained in:
Renier Moorcroft 2023-07-21 12:01:02 +02:00 committed by GitHub
parent 33c2fc008a
commit 4916351d9a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 167 additions and 2 deletions

View File

@ -315,6 +315,7 @@ omit =
homeassistant/components/everlights/light.py
homeassistant/components/evohome/*
homeassistant/components/ezviz/__init__.py
homeassistant/components/ezviz/alarm_control_panel.py
homeassistant/components/ezviz/binary_sensor.py
homeassistant/components/ezviz/camera.py
homeassistant/components/ezviz/image.py

View File

@ -33,6 +33,7 @@ _LOGGER = logging.getLogger(__name__)
PLATFORMS_BY_TYPE: dict[str, list] = {
ATTR_TYPE_CAMERA: [],
ATTR_TYPE_CLOUD: [
Platform.ALARM_CONTROL_PANEL,
Platform.BINARY_SENSOR,
Platform.CAMERA,
Platform.IMAGE,

View File

@ -0,0 +1,165 @@
"""Support for Ezviz alarm."""
from __future__ import annotations
from dataclasses import dataclass
from datetime import timedelta
import logging
from pyezviz import PyEzvizError
from pyezviz.constants import DefenseModeType
from homeassistant.components.alarm_control_panel import (
AlarmControlPanelEntity,
AlarmControlPanelEntityDescription,
AlarmControlPanelEntityFeature,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import (
STATE_ALARM_ARMED_AWAY,
STATE_ALARM_ARMED_HOME,
STATE_ALARM_DISARMED,
)
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import HomeAssistantError
from homeassistant.helpers.entity import DeviceInfo
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from .const import (
DATA_COORDINATOR,
DOMAIN,
MANUFACTURER,
)
from .coordinator import EzvizDataUpdateCoordinator
_LOGGER = logging.getLogger(__name__)
SCAN_INTERVAL = timedelta(seconds=60)
PARALLEL_UPDATES = 0
@dataclass
class EzvizAlarmControlPanelEntityDescriptionMixin:
"""Mixin values for EZVIZ Alarm control panel entities."""
ezviz_alarm_states: list
@dataclass
class EzvizAlarmControlPanelEntityDescription(
AlarmControlPanelEntityDescription, EzvizAlarmControlPanelEntityDescriptionMixin
):
"""Describe an EZVIZ Alarm control panel entity."""
ALARM_TYPE = EzvizAlarmControlPanelEntityDescription(
key="ezviz_alarm",
ezviz_alarm_states=[
None,
STATE_ALARM_DISARMED,
STATE_ALARM_ARMED_AWAY,
STATE_ALARM_ARMED_HOME,
],
)
async def async_setup_entry(
hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
) -> None:
"""Set up Ezviz alarm control panel."""
coordinator: EzvizDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id][
DATA_COORDINATOR
]
device_info: DeviceInfo = {
"identifiers": {(DOMAIN, entry.unique_id)}, # type: ignore[arg-type]
"name": "EZVIZ Alarm",
"model": "EZVIZ Alarm",
"manufacturer": MANUFACTURER,
}
async_add_entities(
[EzvizAlarm(coordinator, entry.entry_id, device_info, ALARM_TYPE)]
)
class EzvizAlarm(AlarmControlPanelEntity):
"""Representation of an Ezviz alarm control panel."""
entity_description: EzvizAlarmControlPanelEntityDescription
_attr_has_entity_name = True
_attr_name = None
_attr_supported_features = (
AlarmControlPanelEntityFeature.ARM_AWAY
| AlarmControlPanelEntityFeature.ARM_HOME
)
_attr_code_arm_required = False
def __init__(
self,
coordinator: EzvizDataUpdateCoordinator,
entry_id: str,
device_info: DeviceInfo,
entity_description: EzvizAlarmControlPanelEntityDescription,
) -> None:
"""Initialize alarm control panel entity."""
self._attr_unique_id = f"{entry_id}_{entity_description.key}"
self._attr_device_info = device_info
self.entity_description = entity_description
self.coordinator = coordinator
self._attr_state = None
async def async_added_to_hass(self) -> None:
"""Entity added to hass."""
self.async_schedule_update_ha_state(True)
def alarm_disarm(self, code: str | None = None) -> None:
"""Send disarm command."""
try:
if self.coordinator.ezviz_client.api_set_defence_mode(
DefenseModeType.HOME_MODE.value
):
self._attr_state = STATE_ALARM_DISARMED
except PyEzvizError as err:
raise HomeAssistantError("Cannot disarm EZVIZ alarm") from err
def alarm_arm_away(self, code: str | None = None) -> None:
"""Send arm away command."""
try:
if self.coordinator.ezviz_client.api_set_defence_mode(
DefenseModeType.AWAY_MODE.value
):
self._attr_state = STATE_ALARM_ARMED_AWAY
except PyEzvizError as err:
raise HomeAssistantError("Cannot arm EZVIZ alarm") from err
def alarm_arm_home(self, code: str | None = None) -> None:
"""Send arm home command."""
try:
if self.coordinator.ezviz_client.api_set_defence_mode(
DefenseModeType.SLEEP_MODE.value
):
self._attr_state = STATE_ALARM_ARMED_HOME
except PyEzvizError as err:
raise HomeAssistantError("Cannot arm EZVIZ alarm") from err
def update(self) -> None:
"""Fetch data from EZVIZ."""
ezviz_alarm_state_number = "0"
try:
ezviz_alarm_state_number = (
self.coordinator.ezviz_client.get_group_defence_mode()
)
_LOGGER.debug(
"Updating EZVIZ alarm with response %s", ezviz_alarm_state_number
)
self._attr_state = self.entity_description.ezviz_alarm_states[
int(ezviz_alarm_state_number)
]
except PyEzvizError as error:
raise HomeAssistantError(
f"Could not fetch EZVIZ alarm status: {error}"
) from error

View File

@ -6,8 +6,6 @@ MANUFACTURER = "EZVIZ"
# Configuration
ATTR_SERIAL = "serial"
CONF_FFMPEG_ARGUMENTS = "ffmpeg_arguments"
ATTR_HOME = "HOME_MODE"
ATTR_AWAY = "AWAY_MODE"
ATTR_TYPE_CLOUD = "EZVIZ_CLOUD_ACCOUNT"
ATTR_TYPE_CAMERA = "CAMERA_ACCOUNT"
CONF_SESSION_ID = "session_id"