Skip to content
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
2 changes: 1 addition & 1 deletion homeassistant/components/abode/alarm_control_panel.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ async def async_setup_entry(hass, config_entry, async_add_entities):
)


class AbodeAlarm(AbodeDevice, alarm.AlarmControlPanel):
class AbodeAlarm(AbodeDevice, alarm.AlarmControlPanelEntity):
"""An alarm_control_panel implementation for Abode."""

@property
Expand Down
18 changes: 16 additions & 2 deletions homeassistant/components/alarm_control_panel/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@
SUPPORT_ALARM_TRIGGER,
)

_LOGGER = logging.getLogger(__name__)

DOMAIN = "alarm_control_panel"
SCAN_INTERVAL = timedelta(seconds=30)
ATTR_CHANGED_BY = "changed_by"
Expand Down Expand Up @@ -99,8 +101,8 @@ async def async_unload_entry(hass, entry):
return await hass.data[DOMAIN].async_unload_entry(entry)


class AlarmControlPanel(Entity):
"""An abstract class for alarm control devices."""
class AlarmControlPanelEntity(Entity):
"""An abstract class for alarm control entities."""

@property
def code_format(self):
Expand Down Expand Up @@ -179,3 +181,15 @@ def state_attributes(self):
ATTR_CODE_ARM_REQUIRED: self.code_arm_required,
}
return state_attr


class AlarmControlPanel(AlarmControlPanelEntity):
"""An abstract class for alarm control entities (for backwards compatibility)."""

def __init_subclass__(cls, **kwargs):
"""Print deprecation warning."""
super().__init_subclass__(**kwargs)
_LOGGER.warning(
"AlarmControlPanel is deprecated, modify %s to extend AlarmControlPanelEntity",
cls.__name__,
)
4 changes: 2 additions & 2 deletions homeassistant/components/alarmdecoder/alarm_control_panel.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

from homeassistant.components.alarm_control_panel import (
FORMAT_NUMBER,
AlarmControlPanel,
AlarmControlPanelEntity,
)
from homeassistant.components.alarm_control_panel.const import (
SUPPORT_ALARM_ARM_AWAY,
Expand Down Expand Up @@ -74,7 +74,7 @@ def alarm_keypress_handler(service):
)


class AlarmDecoderAlarmPanel(AlarmControlPanel):
class AlarmDecoderAlarmPanel(AlarmControlPanelEntity):
"""Representation of an AlarmDecoder-based alarm panel."""

def __init__(self, auto_bypass, code_arm_required):
Expand Down
4 changes: 2 additions & 2 deletions homeassistant/components/arlo/alarm_control_panel.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

from homeassistant.components.alarm_control_panel import (
PLATFORM_SCHEMA,
AlarmControlPanel,
AlarmControlPanelEntity,
)
from homeassistant.components.alarm_control_panel.const import (
SUPPORT_ALARM_ARM_AWAY,
Expand Down Expand Up @@ -66,7 +66,7 @@ def setup_platform(hass, config, add_entities, discovery_info=None):
add_entities(base_stations, True)


class ArloBaseStation(AlarmControlPanel):
class ArloBaseStation(AlarmControlPanelEntity):
"""Representation of an Arlo Alarm Control Panel."""

def __init__(self, data, home_mode_name, away_mode_name, night_mode_name):
Expand Down
4 changes: 2 additions & 2 deletions homeassistant/components/blink/alarm_control_panel.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""Support for Blink Alarm Control Panel."""
import logging

from homeassistant.components.alarm_control_panel import AlarmControlPanel
from homeassistant.components.alarm_control_panel import AlarmControlPanelEntity
from homeassistant.components.alarm_control_panel.const import SUPPORT_ALARM_ARM_AWAY
from homeassistant.const import (
ATTR_ATTRIBUTION,
Expand All @@ -28,7 +28,7 @@ def setup_platform(hass, config, add_entities, discovery_info=None):
add_entities(sync_modules, True)


class BlinkSyncModule(AlarmControlPanel):
class BlinkSyncModule(AlarmControlPanelEntity):
"""Representation of a Blink Alarm Control Panel."""

def __init__(self, data, name, sync):
Expand Down
4 changes: 2 additions & 2 deletions homeassistant/components/canary/alarm_control_panel.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

from canary.api import LOCATION_MODE_AWAY, LOCATION_MODE_HOME, LOCATION_MODE_NIGHT

from homeassistant.components.alarm_control_panel import AlarmControlPanel
from homeassistant.components.alarm_control_panel import AlarmControlPanelEntity
from homeassistant.components.alarm_control_panel.const import (
SUPPORT_ALARM_ARM_AWAY,
SUPPORT_ALARM_ARM_HOME,
Expand Down Expand Up @@ -32,7 +32,7 @@ def setup_platform(hass, config, add_entities, discovery_info=None):
add_entities(devices, True)


class CanaryAlarm(AlarmControlPanel):
class CanaryAlarm(AlarmControlPanelEntity):
"""Representation of a Canary alarm control panel."""

def __init__(self, data, location_id):
Expand Down
2 changes: 1 addition & 1 deletion homeassistant/components/concord232/alarm_control_panel.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ def setup_platform(hass, config, add_entities, discovery_info=None):
_LOGGER.error("Unable to connect to Concord232: %s", str(ex))


class Concord232Alarm(alarm.AlarmControlPanel):
class Concord232Alarm(alarm.AlarmControlPanelEntity):
"""Representation of the Concord232-based alarm panel."""

def __init__(self, url, name, code, mode):
Expand Down
2 changes: 1 addition & 1 deletion homeassistant/components/egardia/alarm_control_panel.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ def setup_platform(hass, config, add_entities, discovery_info=None):
add_entities([device], True)


class EgardiaAlarm(alarm.AlarmControlPanel):
class EgardiaAlarm(alarm.AlarmControlPanelEntity):
"""Representation of a Egardia alarm."""

def __init__(
Expand Down
4 changes: 2 additions & 2 deletions homeassistant/components/elkm1/alarm_control_panel.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
from homeassistant.components.alarm_control_panel import (
ATTR_CHANGED_BY,
FORMAT_NUMBER,
AlarmControlPanel,
AlarmControlPanelEntity,
)
from homeassistant.components.alarm_control_panel.const import (
SUPPORT_ALARM_ARM_AWAY,
Expand Down Expand Up @@ -109,7 +109,7 @@ async def async_setup_entry(hass, config_entry, async_add_entities):
)


class ElkArea(ElkAttachedEntity, AlarmControlPanel, RestoreEntity):
class ElkArea(ElkAttachedEntity, AlarmControlPanelEntity, RestoreEntity):
"""Representation of an Area / Partition within the ElkM1 alarm panel."""

def __init__(self, element, elk, elk_data):
Expand Down
4 changes: 2 additions & 2 deletions homeassistant/components/envisalink/alarm_control_panel.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

from homeassistant.components.alarm_control_panel import (
FORMAT_NUMBER,
AlarmControlPanel,
AlarmControlPanelEntity,
)
from homeassistant.components.alarm_control_panel.const import (
SUPPORT_ALARM_ARM_AWAY,
Expand Down Expand Up @@ -96,7 +96,7 @@ def alarm_keypress_handler(service):
return True


class EnvisalinkAlarm(EnvisalinkDevice, AlarmControlPanel):
class EnvisalinkAlarm(EnvisalinkDevice, AlarmControlPanelEntity):
"""Representation of an Envisalink-based alarm panel."""

def __init__(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

from aiohomekit.model.characteristics import CharacteristicsTypes

from homeassistant.components.alarm_control_panel import AlarmControlPanel
from homeassistant.components.alarm_control_panel import AlarmControlPanelEntity
from homeassistant.components.alarm_control_panel.const import (
SUPPORT_ALARM_ARM_AWAY,
SUPPORT_ALARM_ARM_HOME,
Expand Down Expand Up @@ -51,13 +51,13 @@ def async_add_service(aid, service):
if service["stype"] != "security-system":
return False
info = {"aid": aid, "iid": service["iid"]}
async_add_entities([HomeKitAlarmControlPanel(conn, info)], True)
async_add_entities([HomeKitAlarmControlPanelEntity(conn, info)], True)
return True

conn.add_listener(async_add_service)


class HomeKitAlarmControlPanel(HomeKitEntity, AlarmControlPanel):
class HomeKitAlarmControlPanelEntity(HomeKitEntity, AlarmControlPanelEntity):
"""Representation of a Homekit Alarm Control Panel."""

def get_characteristic_types(self):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

from homematicip.functionalHomes import SecurityAndAlarmHome

from homeassistant.components.alarm_control_panel import AlarmControlPanel
from homeassistant.components.alarm_control_panel import AlarmControlPanelEntity
from homeassistant.components.alarm_control_panel.const import (
SUPPORT_ALARM_ARM_AWAY,
SUPPORT_ALARM_ARM_HOME,
Expand Down Expand Up @@ -32,10 +32,10 @@ async def async_setup_entry(
) -> None:
"""Set up the HomematicIP alrm control panel from a config entry."""
hap = hass.data[HMIPC_DOMAIN][config_entry.unique_id]
async_add_entities([HomematicipAlarmControlPanel(hap)])
async_add_entities([HomematicipAlarmControlPanelEntity(hap)])


class HomematicipAlarmControlPanel(AlarmControlPanel):
class HomematicipAlarmControlPanelEntity(AlarmControlPanelEntity):
"""Representation of an alarm control panel."""

def __init__(self, hap: HomematicipHAP) -> None:
Expand Down
2 changes: 1 addition & 1 deletion homeassistant/components/ialarm/alarm_control_panel.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ def setup_platform(hass, config, add_entities, discovery_info=None):
add_entities([ialarm], True)


class IAlarmPanel(alarm.AlarmControlPanel):
class IAlarmPanel(alarm.AlarmControlPanelEntity):
"""Representation of an iAlarm status."""

def __init__(self, name, code, username, password, url):
Expand Down
4 changes: 2 additions & 2 deletions homeassistant/components/ifttt/alarm_control_panel.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
FORMAT_NUMBER,
FORMAT_TEXT,
PLATFORM_SCHEMA,
AlarmControlPanel,
AlarmControlPanelEntity,
)
from homeassistant.components.alarm_control_panel.const import (
SUPPORT_ALARM_ARM_AWAY,
Expand Down Expand Up @@ -108,7 +108,7 @@ async def push_state_update(service):
)


class IFTTTAlarmPanel(AlarmControlPanel):
class IFTTTAlarmPanel(AlarmControlPanelEntity):
"""Representation of an alarm control panel controlled through IFTTT."""

def __init__(
Expand Down
4 changes: 2 additions & 2 deletions homeassistant/components/lupusec/alarm_control_panel.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""Support for Lupusec System alarm control panels."""
from datetime import timedelta

from homeassistant.components.alarm_control_panel import AlarmControlPanel
from homeassistant.components.alarm_control_panel import AlarmControlPanelEntity
from homeassistant.components.alarm_control_panel.const import (
SUPPORT_ALARM_ARM_AWAY,
SUPPORT_ALARM_ARM_HOME,
Expand Down Expand Up @@ -32,7 +32,7 @@ def setup_platform(hass, config, add_entities, discovery_info=None):
add_entities(alarm_devices)


class LupusecAlarm(LupusecDevice, AlarmControlPanel):
class LupusecAlarm(LupusecDevice, AlarmControlPanelEntity):
"""An alarm_control_panel implementation for Lupusec."""

@property
Expand Down
2 changes: 1 addition & 1 deletion homeassistant/components/manual/alarm_control_panel.py
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ def setup_platform(hass, config, add_entities, discovery_info=None):
)


class ManualAlarm(alarm.AlarmControlPanel, RestoreEntity):
class ManualAlarm(alarm.AlarmControlPanelEntity, RestoreEntity):
"""
Representation of an alarm status.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ def setup_platform(hass, config, add_entities, discovery_info=None):
)


class ManualMQTTAlarm(alarm.AlarmControlPanel):
class ManualMQTTAlarm(alarm.AlarmControlPanelEntity):
"""
Representation of an alarm status.

Expand Down
2 changes: 1 addition & 1 deletion homeassistant/components/mqtt/alarm_control_panel.py
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ class MqttAlarm(
MqttAvailability,
MqttDiscoveryUpdate,
MqttEntityDeviceInfo,
alarm.AlarmControlPanel,
alarm.AlarmControlPanelEntity,
):
"""Representation of a MQTT alarm status."""

Expand Down
2 changes: 1 addition & 1 deletion homeassistant/components/ness_alarm/alarm_control_panel.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ async def async_setup_platform(hass, config, async_add_entities, discovery_info=
async_add_entities([device])


class NessAlarmPanel(alarm.AlarmControlPanel):
class NessAlarmPanel(alarm.AlarmControlPanelEntity):
"""Representation of a Ness alarm panel."""

def __init__(self, client, name):
Expand Down
2 changes: 1 addition & 1 deletion homeassistant/components/nx584/alarm_control_panel.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ def setup_platform(hass, config, add_entities, discovery_info=None):
return


class NX584Alarm(alarm.AlarmControlPanel):
class NX584Alarm(alarm.AlarmControlPanelEntity):
"""Representation of a NX584-based alarm panel."""

def __init__(self, hass, url, name):
Expand Down
4 changes: 2 additions & 2 deletions homeassistant/components/point/alarm_control_panel.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""Support for Minut Point."""
import logging

from homeassistant.components.alarm_control_panel import DOMAIN, AlarmControlPanel
from homeassistant.components.alarm_control_panel import DOMAIN, AlarmControlPanelEntity
from homeassistant.components.alarm_control_panel.const import SUPPORT_ALARM_ARM_AWAY
from homeassistant.const import (
STATE_ALARM_ARMED_AWAY,
Expand Down Expand Up @@ -36,7 +36,7 @@ async def async_discover_home(home_id):
)


class MinutPointAlarmControl(AlarmControlPanel):
class MinutPointAlarmControl(AlarmControlPanelEntity):
"""The platform class required by Home Assistant."""

def __init__(self, point_client, home_id):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ async def async_setup_platform(hass, config, async_add_entities, discovery_info=
async_add_entities(devices)


class SatelIntegraAlarmPanel(alarm.AlarmControlPanel):
class SatelIntegraAlarmPanel(alarm.AlarmControlPanelEntity):
"""Representation of an AlarmDecoder-based alarm panel."""

def __init__(self, controller, name, arm_home_mode, partition_id):
Expand Down
4 changes: 2 additions & 2 deletions homeassistant/components/simplisafe/alarm_control_panel.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
from homeassistant.components.alarm_control_panel import (
FORMAT_NUMBER,
FORMAT_TEXT,
AlarmControlPanel,
AlarmControlPanelEntity,
)
from homeassistant.components.alarm_control_panel.const import (
SUPPORT_ALARM_ARM_AWAY,
Expand Down Expand Up @@ -72,7 +72,7 @@ async def async_setup_entry(hass, entry, async_add_entities):
)


class SimpliSafeAlarm(SimpliSafeEntity, AlarmControlPanel):
class SimpliSafeAlarm(SimpliSafeEntity, AlarmControlPanelEntity):
"""Representation of a SimpliSafe alarm."""

def __init__(self, simplisafe, system):
Expand Down
2 changes: 1 addition & 1 deletion homeassistant/components/spc/alarm_control_panel.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ async def async_setup_platform(hass, config, async_add_entities, discovery_info=
async_add_entities([SpcAlarm(area=area, api=api) for area in api.areas.values()])


class SpcAlarm(alarm.AlarmControlPanel):
class SpcAlarm(alarm.AlarmControlPanelEntity):
"""Representation of the SPC alarm panel."""

def __init__(self, area, api):
Expand Down
4 changes: 2 additions & 2 deletions homeassistant/components/template/alarm_control_panel.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
ENTITY_ID_FORMAT,
FORMAT_NUMBER,
PLATFORM_SCHEMA,
AlarmControlPanel,
AlarmControlPanelEntity,
)
from homeassistant.components.alarm_control_panel.const import (
SUPPORT_ALARM_ARM_AWAY,
Expand Down Expand Up @@ -117,7 +117,7 @@ async def async_setup_platform(hass, config, async_add_entities, discovery_info=
async_add_entities(alarm_control_panels)


class AlarmControlPanelTemplate(AlarmControlPanel):
class AlarmControlPanelTemplate(AlarmControlPanelEntity):
"""Representation of a templated Alarm Control Panel."""

def __init__(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ async def async_setup_entry(hass, entry, async_add_entities) -> None:
async_add_entities(alarms, True)


class TotalConnectAlarm(alarm.AlarmControlPanel):
class TotalConnectAlarm(alarm.AlarmControlPanelEntity):
"""Represent an TotalConnect status."""

def __init__(self, name, location_id, client):
Expand Down
2 changes: 1 addition & 1 deletion homeassistant/components/verisure/alarm_control_panel.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ def set_arm_state(state, code=None):
hub.update_overview(no_throttle=True)


class VerisureAlarm(alarm.AlarmControlPanel):
class VerisureAlarm(alarm.AlarmControlPanelEntity):
"""Representation of a Verisure alarm status."""

def __init__(self):
Expand Down
Loading