Created
February 17, 2017 04:39
-
-
Save tchellomello/e803c13c7fafd5cd8a4b83cbd5c7869b to your computer and use it in GitHub Desktop.
Beta Ring sensor for HA
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
""" | |
This component provides HA sensor support for Ring Door Bell/Chimes. | |
For more details about this platform, please refer to the documentation at | |
https://home-assistant.io/components/sensor.ring/ | |
""" | |
import logging | |
from datetime import timedelta | |
import voluptuous as vol | |
import homeassistant.helpers.config_validation as cv | |
from homeassistant.components.sensor import PLATFORM_SCHEMA | |
from homeassistant.const import ( | |
CONF_ENTITY_NAMESPACE, CONF_MONITORED_CONDITIONS, CONF_SCAN_INTERVAL, | |
CONF_USERNAME, CONF_PASSWORD, STATE_UNKNOWN, | |
ATTR_ATTRIBUTION) | |
from homeassistant.helpers.entity import Entity | |
import homeassistant.loader as loader | |
from requests.exceptions import HTTPError, ConnectTimeout | |
REQUIREMENTS = ['ring_doorbell==0.0.4'] | |
_LOGGER = logging.getLogger(__name__) | |
NOTIFICATION_ID = 'ring_notification' | |
NOTIFICATION_TITLE = 'Ring Sensor Setup' | |
DEFAULT_ENTITY_NAMESPACE = 'ring' | |
DEFAULT_SCAN_INTERVAL = timedelta(seconds=10) | |
CONF_ATTRIBUTION = "Data provided by Ring.com" | |
# Sensor types: Name, category, units, icon | |
SENSOR_TYPES = { | |
'battery': ['Battery', ['doorbell'], '%', 'battery-50'], | |
'last_activity': ['Last Activity', ['doorbell'], None, 'history'], | |
'motion': ['Motion Sensor', ['doorbell'], None, 'run'], | |
'volume': ['Volume', ['chime', 'doorbell'], None, 'bell-ring'], | |
} | |
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ | |
vol.Required(CONF_USERNAME): cv.string, | |
vol.Required(CONF_PASSWORD): cv.string, | |
vol.Optional(CONF_ENTITY_NAMESPACE, default=DEFAULT_ENTITY_NAMESPACE): | |
cv.string, | |
vol.Optional(CONF_SCAN_INTERVAL, default=DEFAULT_SCAN_INTERVAL): | |
vol.All(vol.Coerce(int), vol.Range(min=1)), | |
vol.Required(CONF_MONITORED_CONDITIONS, default=[]): | |
vol.All(cv.ensure_list, [vol.In(SENSOR_TYPES)]), | |
}) | |
def setup_platform(hass, config, add_devices, discovery_info=None): | |
"""Set up a sensor for a Ring device.""" | |
from ring_doorbell import Ring | |
ring = Ring(config.get(CONF_USERNAME), config.get(CONF_PASSWORD)) | |
persistent_notification = loader.get_component('persistent_notification') | |
try: | |
ring.is_connected | |
except (ConnectTimeout, HTTPError) as ex: | |
_LOGGER.error("Unable to connect to Ring service: %s", str(ex)) | |
persistent_notification.create( | |
hass, 'Error: {}<br />' | |
'You will need to restart hass after fixing.' | |
''.format(ex), | |
title=NOTIFICATION_TITLE, | |
notification_id=NOTIFICATION_ID) | |
return False | |
sensors = [] | |
for sensor_type in config.get(CONF_MONITORED_CONDITIONS): | |
for dev in ring.chimes: | |
if 'chime' in SENSOR_TYPES[sensor_type][1]: | |
sensors.append(RingSensor(hass, | |
dev, | |
'chime', | |
ring, | |
sensor_type)) | |
for dev in ring.doorbells: | |
if 'doorbell' in SENSOR_TYPES[sensor_type][1]: | |
sensors.append(RingSensor(hass, | |
dev, | |
'doorbell', | |
ring, | |
sensor_type)) | |
add_devices(sensors, True) | |
return True | |
class RingSensor(Entity): | |
"""A sensor implementation for Ring device.""" | |
def __init__(self, hass, name, family, ring, sensor_type): | |
"""Initialize a sensor for Ring device.""" | |
super(RingSensor, self).__init__() | |
self._ring = ring | |
self._sensor_type = sensor_type | |
self._family = family | |
self._name = "{0} {1}".format(name, | |
SENSOR_TYPES.get(self._sensor_type)[0]) | |
self._altname = name | |
self._icon = 'mdi:{}'.format(SENSOR_TYPES.get(self._sensor_type)[3]) | |
self._state = STATE_UNKNOWN | |
self._tz = str(hass.config.time_zone) | |
self._data = None | |
@property | |
def name(self): | |
"""Return the name of the sensor.""" | |
return self._name | |
@property | |
def state(self): | |
"""Return the state of the sensor.""" | |
return self._state | |
@property | |
def device_state_attributes(self): | |
"""Return the state attributes.""" | |
attrs = {} | |
attrs[ATTR_ATTRIBUTION] = CONF_ATTRIBUTION | |
attrs['type'] = self._family | |
if self._data: | |
if self._sensor_type == 'last_activity': | |
attrs['created_at'] = self._data['created_at'] | |
attrs['answered'] = self._data['answered'] | |
attrs['recording_status'] = self._data['recording']['status'] | |
attrs['kind'] = self._data['kind'] | |
else: | |
_LOGGER.info("sensor_type: %s data: %s", self._sensor_type, self._data) | |
attrs['firmware'] = self._data['firmware_version'] | |
attrs['device_id'] = self._data['device_id'] | |
attrs['timezone'] = self._data['time_zone'] | |
return attrs | |
@property | |
def icon(self): | |
"""Icon to use in the frontend, if any.""" | |
return self._icon | |
@property | |
def unit_of_measurement(self): | |
"""Return the units of measurement.""" | |
if self._data and self._sensor_type == 'last_activity': | |
return self._data['kind'] | |
else: | |
return SENSOR_TYPES.get(self._sensor_type)[2] | |
def update(self): | |
"""Get the latest data and updates the state.""" | |
if self._family == 'chime': | |
self._data = self._ring.chime_attributes(self._altname) | |
if self._data and self._sensor_type == 'volume': | |
self._state = self._data['settings']['volume'] | |
if self._family == 'doorbell': | |
self._data = self._ring.doorbell_attributes(self._altname) | |
if self._data: | |
if self._sensor_type == 'battery': | |
self._state = \ | |
self._ring.doorbell_battery_life(self._altname) | |
if self._sensor_type == 'last_activity': | |
self._data = self._ring.history(self._altname, | |
limit=1, | |
timezone=self._tz)[0] | |
created_at = self._data['created_at'] | |
self._state = '{0:0>2}:{1:0>2}'.format(created_at.hour, | |
created_at.minute) | |
if self._sensor_type == 'motion': | |
self._data = self._ring.check_activity | |
self._state = bool(self._data) | |
if self._sensor_type == 'volume': | |
self._state = self._data['settings']['doorbell_volume'] |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment