Refactor USPS into component with Sensors+Camera (#8679)

* Inital USPS Camera expansion

* Cleanup debugging, add camera change interval

* Change to local nomail image

* Explicitly pass in date

* Move camera date info to model property

* Fix copy typo

* Fix hound line-length

* Fix lint whitespace

* Fix requirements

* Bump myusps version, clarify interval, alter update scheme

* Add units

* Code cleanup, address comments

* Use built-in scan interval, remove nomail image

* Remove logging line
This commit is contained in:
John Mihalic authored and Pascal Vizeli committed 2017-08-18 23:47:36 +02:00
1 parent 6215e27de4
commit ecc249aa27
5 files changed
+226 -50

No files matched your search

+42 -47
View File
@@ -6,65 +6,44 @@ https://home-assistant.io/components/sensor.usps/
"""
from collections import defaultdict
import logging
from datetime import timedelta
import voluptuous as vol
from homeassistant.components.sensor import PLATFORM_SCHEMA
from homeassistant.const import (CONF_NAME, CONF_USERNAME, CONF_PASSWORD,
ATTR_ATTRIBUTION)
from homeassistant.components.usps import DATA_USPS
from homeassistant.const import ATTR_ATTRIBUTION, ATTR_DATE
from homeassistant.helpers.entity import Entity
from homeassistant.util import slugify
from homeassistant.util.dt import now, parse_datetime
import homeassistant.helpers.config_validation as cv
REQUIREMENTS = ['myusps==1.1.2']
_LOGGER = logging.getLogger(__name__)
DOMAIN = 'usps'
SCAN_INTERVAL = timedelta(minutes=30)
COOKIE = 'usps_cookies.pickle'
DEPENDENCIES = ['usps']
STATUS_DELIVERED = 'delivered'
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
vol.Required(CONF_USERNAME): cv.string,
vol.Required(CONF_PASSWORD): cv.string,
vol.Optional(CONF_NAME): cv.string
})
# pylint: disable=unused-argument
def setup_platform(hass, config, add_devices, discovery_info=None):
"""Setup the USPS platform."""
import myusps
try:
cookie = hass.config.path(COOKIE)
session = myusps.get_session(
config.get(CONF_USERNAME), config.get(CONF_PASSWORD),
cookie_path=cookie)
except myusps.USPSError:
_LOGGER.exception('Could not connect to My USPS')
return False
if discovery_info is None:
return
add_devices([USPSPackageSensor(session, config.get(CONF_NAME)),
USPSMailSensor(session, config.get(CONF_NAME))], True)
usps = hass.data[DATA_USPS]
add_devices([USPSPackageSensor(usps),
USPSMailSensor(usps)], True)
class USPSPackageSensor(Entity):
"""USPS Package Sensor."""
def __init__(self, session, name):
def __init__(self, usps):
"""Initialize the sensor."""
self._session = session
self._name = name
self._usps = usps
self._name = self._usps.name
self._attributes = None
self._state = None
@property
def name(self):
"""Return the name of the sensor."""
return '{} packages'.format(self._name or DOMAIN)
return '{} packages'.format(self._name)
@property
def state(self):
@@ -73,16 +52,16 @@ class USPSPackageSensor(Entity):
def update(self):
"""Update device state."""
import myusps
self._usps.update()
status_counts = defaultdict(int)
for package in myusps.get_packages(self._session):
for package in self._usps.packages:
status = slugify(package['primary_status'])
if status == STATUS_DELIVERED and \
parse_datetime(package['date']).date() < now().date():
continue
status_counts[status] += 1
self._attributes = {
ATTR_ATTRIBUTION: myusps.ATTRIBUTION
ATTR_ATTRIBUTION: self._usps.attribution
}
self._attributes.update(status_counts)
self._state = sum(status_counts.values())
@@ -97,21 +76,26 @@ class USPSPackageSensor(Entity):
"""Icon to use in the frontend."""
return 'mdi:package-variant-closed'
@property
def unit_of_measurement(self):
"""Return the unit of measurement of this entity, if any."""
return 'packages'
class USPSMailSensor(Entity):
"""USPS Mail Sensor."""
def __init__(self, session, name):
def __init__(self, usps):
"""Initialize the sensor."""
self._session = session
self._name = name
self._usps = usps
self._name = self._usps.name
self._attributes = None
self._state = None
@property
def name(self):
"""Return the name of the sensor."""
return '{} mail'.format(self._name or DOMAIN)
return '{} mail'.format(self._name)
@property
def state(self):
@@ -120,18 +104,29 @@ class USPSMailSensor(Entity):
def update(self):
"""Update device state."""
import myusps
self._state = len(myusps.get_mail(self._session))
self._usps.update()
if self._usps.mail is not None:
self._state = len(self._usps.mail)
else:
self._state = 0
@property
def device_state_attributes(self):
"""Return the state attributes."""
import myusps
return {
ATTR_ATTRIBUTION: myusps.ATTRIBUTION
}
attr = {}
attr[ATTR_ATTRIBUTION] = self._usps.attribution
try:
attr[ATTR_DATE] = self._usps.mail[0]['date']
except IndexError:
pass
return attr
@property
def icon(self):
"""Icon to use in the frontend."""
return 'mdi:mailbox'
@property
def unit_of_measurement(self):
"""Return the unit of measurement of this entity, if any."""
return 'pieces'