core/homeassistant/components/alarmdotcom/alarm_control_panel.py

133 lines
4.1 KiB
Python
Raw Normal View History

"""Interfaces with Alarm.com alarm control panels."""
import logging
import re
2019-10-17 13:05:45 +00:00
from pyalarmdotcom import Alarmdotcom
2016-09-06 21:48:32 +00:00
import voluptuous as vol
2016-01-14 06:09:39 +00:00
import homeassistant.components.alarm_control_panel as alarm
2016-09-06 21:48:32 +00:00
from homeassistant.components.alarm_control_panel import PLATFORM_SCHEMA
from homeassistant.components.alarm_control_panel.const import (
SUPPORT_ALARM_ARM_AWAY,
SUPPORT_ALARM_ARM_HOME,
)
2016-01-14 06:09:39 +00:00
from homeassistant.const import (
2019-07-31 19:25:30 +00:00
CONF_CODE,
CONF_NAME,
CONF_PASSWORD,
CONF_USERNAME,
STATE_ALARM_ARMED_AWAY,
STATE_ALARM_ARMED_HOME,
STATE_ALARM_DISARMED,
)
from homeassistant.helpers.aiohttp_client import async_get_clientsession
import homeassistant.helpers.config_validation as cv
2016-01-14 06:09:39 +00:00
2016-09-06 21:48:32 +00:00
_LOGGER = logging.getLogger(__name__)
2019-07-31 19:25:30 +00:00
DEFAULT_NAME = "Alarm.com"
2016-01-14 06:09:39 +00:00
2019-07-31 19:25:30 +00:00
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
{
vol.Required(CONF_PASSWORD): cv.string,
vol.Required(CONF_USERNAME): cv.string,
vol.Optional(CONF_CODE): cv.positive_int,
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
}
)
2016-09-06 21:48:32 +00:00
2016-01-14 06:09:39 +00:00
2019-07-31 19:25:30 +00:00
async def async_setup_platform(hass, config, async_add_entities, discovery_info=None):
"""Set up a Alarm.com control panel."""
2016-09-06 21:48:32 +00:00
name = config.get(CONF_NAME)
code = config.get(CONF_CODE)
2016-01-14 06:09:39 +00:00
username = config.get(CONF_USERNAME)
password = config.get(CONF_PASSWORD)
alarmdotcom = AlarmDotCom(hass, name, code, username, password)
await alarmdotcom.async_login()
async_add_entities([alarmdotcom])
2016-01-14 06:09:39 +00:00
class AlarmDotCom(alarm.AlarmControlPanel):
"""Representation of an Alarm.com status."""
2016-03-07 19:21:43 +00:00
2016-01-14 06:09:39 +00:00
def __init__(self, hass, name, code, username, password):
2016-03-07 19:21:43 +00:00
"""Initialize the Alarm.com status."""
2019-07-31 19:25:30 +00:00
_LOGGER.debug("Setting up Alarm.com...")
2016-01-14 06:09:39 +00:00
self._hass = hass
self._name = name
self._code = str(code) if code else None
self._username = username
self._password = password
self._websession = async_get_clientsession(self._hass)
self._state = None
2019-07-31 19:25:30 +00:00
self._alarm = Alarmdotcom(username, password, self._websession, hass.loop)
async def async_login(self):
"""Login to Alarm.com."""
await self._alarm.async_login()
async def async_update(self):
"""Fetch the latest state."""
await self._alarm.async_update()
return self._alarm.state
2016-01-14 06:09:39 +00:00
@property
def name(self):
2016-03-07 19:21:43 +00:00
"""Return the name of the alarm."""
2016-01-14 06:09:39 +00:00
return self._name
@property
def code_format(self):
"""Return one or more digits/characters."""
if self._code is None:
return None
2019-07-31 19:25:30 +00:00
if isinstance(self._code, str) and re.search("^\\d+$", self._code):
return alarm.FORMAT_NUMBER
return alarm.FORMAT_TEXT
2016-01-14 06:09:39 +00:00
@property
def state(self):
2016-03-07 19:21:43 +00:00
"""Return the state of the device."""
2019-07-31 19:25:30 +00:00
if self._alarm.state.lower() == "disarmed":
2016-01-14 06:09:39 +00:00
return STATE_ALARM_DISARMED
2019-07-31 19:25:30 +00:00
if self._alarm.state.lower() == "armed stay":
2016-01-14 06:09:39 +00:00
return STATE_ALARM_ARMED_HOME
2019-07-31 19:25:30 +00:00
if self._alarm.state.lower() == "armed away":
2016-01-14 06:09:39 +00:00
return STATE_ALARM_ARMED_AWAY
return None
2016-01-14 06:09:39 +00:00
@property
def supported_features(self) -> int:
"""Return the list of supported features."""
return SUPPORT_ALARM_ARM_HOME | SUPPORT_ALARM_ARM_AWAY
@property
def device_state_attributes(self):
"""Return the state attributes."""
2019-07-31 19:25:30 +00:00
return {"sensor_status": self._alarm.sensor_status}
async def async_alarm_disarm(self, code=None):
2016-03-07 15:45:21 +00:00
"""Send disarm command."""
if self._validate_code(code):
await self._alarm.async_alarm_disarm()
async def async_alarm_arm_home(self, code=None):
"""Send arm hom command."""
if self._validate_code(code):
await self._alarm.async_alarm_arm_home()
async def async_alarm_arm_away(self, code=None):
2016-03-07 15:45:21 +00:00
"""Send arm away command."""
if self._validate_code(code):
await self._alarm.async_alarm_arm_away()
def _validate_code(self, code):
2016-03-07 15:45:21 +00:00
"""Validate given code."""
2016-01-14 06:09:39 +00:00
check = self._code is None or code == self._code
if not check:
_LOGGER.warning("Wrong code entered")
2016-01-14 06:09:39 +00:00
return check