Pushbullet notification sensor (#7182)
* Added the pushbullet sensor component * Updated requirements_all.txt and .coveragerc with the new sensor * Updated acording to houndci-bots comments * Some more changes * Final change by the hound (?) * Fixes from balloobs review and from houndci-bot This changes the sensors information to only contain one attribute as information, and the rest as device_state_attributes. * Added leading space to comments * Added docstrings, removed API_KEY from log, changed imports * The hound is at it again * Fix remaining issues * Fix pylint issue
This commit is contained in:
parent
8c72a57344
commit
1b83ce8759
3 changed files with 136 additions and 0 deletions
|
@ -391,6 +391,7 @@ omit =
|
|||
homeassistant/components/sensor/pi_hole.py
|
||||
homeassistant/components/sensor/plex.py
|
||||
homeassistant/components/sensor/pocketcasts.py
|
||||
homeassistant/components/sensor/pushbullet.py
|
||||
homeassistant/components/sensor/pvoutput.py
|
||||
homeassistant/components/sensor/qnap.py
|
||||
homeassistant/components/sensor/sabnzbd.py
|
||||
|
|
134
homeassistant/components/sensor/pushbullet.py
Normal file
134
homeassistant/components/sensor/pushbullet.py
Normal file
|
@ -0,0 +1,134 @@
|
|||
"""
|
||||
Pushbullet platform for sensor component.
|
||||
|
||||
For more details about this platform, please refer to the documentation at
|
||||
https://home-assistant.io/components/sensor.pushbullet/
|
||||
"""
|
||||
import logging
|
||||
|
||||
import voluptuous as vol
|
||||
|
||||
from homeassistant.const import (CONF_API_KEY, CONF_MONITORED_CONDITIONS)
|
||||
from homeassistant.components.sensor import PLATFORM_SCHEMA
|
||||
import homeassistant.helpers.config_validation as cv
|
||||
from homeassistant.helpers.entity import Entity
|
||||
|
||||
REQUIREMENTS = ['pushbullet.py==0.10.0']
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
SENSOR_TYPES = {
|
||||
'application_name': ['Application name'],
|
||||
'body': ['Body'],
|
||||
'notification_id': ['Notification ID'],
|
||||
'notification_tag': ['Notification tag'],
|
||||
'package_name': ['Package name'],
|
||||
'receiver_email': ['Receiver email'],
|
||||
'sender_email': ['Sender email'],
|
||||
'source_device_iden': ['Sender device ID'],
|
||||
'title': ['Title'],
|
||||
'type': ['Type'],
|
||||
}
|
||||
|
||||
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
||||
vol.Required(CONF_API_KEY): cv.string,
|
||||
vol.Optional(CONF_MONITORED_CONDITIONS, default=['title', 'body']):
|
||||
vol.All(cv.ensure_list, vol.Length(min=1), [vol.In(SENSOR_TYPES)]),
|
||||
})
|
||||
|
||||
|
||||
def setup_platform(hass, config, add_devices, discovery_info=None):
|
||||
"""Set up the Pushbllet Sensor platform."""
|
||||
from pushbullet import PushBullet
|
||||
from pushbullet import InvalidKeyError
|
||||
try:
|
||||
pushbullet = PushBullet(config.get(CONF_API_KEY))
|
||||
except InvalidKeyError:
|
||||
_LOGGER.error("Wrong API key for Pushbullet supplied")
|
||||
return False
|
||||
|
||||
pbprovider = PushBulletNotificationProvider(pushbullet)
|
||||
|
||||
devices = []
|
||||
for sensor_type in config[CONF_MONITORED_CONDITIONS]:
|
||||
devices.append(PushBulletNotificationSensor(pbprovider, sensor_type))
|
||||
add_devices(devices)
|
||||
|
||||
|
||||
class PushBulletNotificationSensor(Entity):
|
||||
"""Representation of a Pushbullet Sensor."""
|
||||
|
||||
def __init__(self, pb, element):
|
||||
"""Initialize the Pushbullet sensor."""
|
||||
self.pushbullet = pb
|
||||
self._element = element
|
||||
self._state = None
|
||||
self._state_attributes = None
|
||||
|
||||
def update(self):
|
||||
"""Fetch the latest data from the sensor.
|
||||
|
||||
This will fetch the 'sensor reading' into self._state but also all
|
||||
attributes into self._state_attributes.
|
||||
"""
|
||||
try:
|
||||
self._state = self.pushbullet.data[self._element]
|
||||
self._state_attributes = self.pushbullet.data
|
||||
except (KeyError, TypeError):
|
||||
pass
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
"""Return the name of the sensor."""
|
||||
return '{} {}'.format('Pushbullet', self._element)
|
||||
|
||||
@property
|
||||
def state(self):
|
||||
"""Return the current state of the sensor."""
|
||||
return self._state
|
||||
|
||||
@property
|
||||
def device_state_attributes(self):
|
||||
"""Return all known attributes of the sensor."""
|
||||
return self._state_attributes
|
||||
|
||||
|
||||
class PushBulletNotificationProvider():
|
||||
"""Provider for an account, leading to one or more sensors."""
|
||||
|
||||
def __init__(self, pb):
|
||||
"""Start to retrieve pushes from the given Pushbullet instance."""
|
||||
import threading
|
||||
self.pushbullet = pb
|
||||
self._data = None
|
||||
self.listener = None
|
||||
self.thread = threading.Thread(target=self.retrieve_pushes)
|
||||
self.thread.daemon = True
|
||||
self.thread.start()
|
||||
|
||||
def on_push(self, data):
|
||||
"""Method to update the current data.
|
||||
|
||||
Currently only monitors pushes but might be extended to monitor
|
||||
different kinds of Pushbullet events.
|
||||
"""
|
||||
if data['type'] == 'push':
|
||||
self._data = data['push']
|
||||
|
||||
@property
|
||||
def data(self):
|
||||
"""The current data stored in the provider."""
|
||||
return self._data
|
||||
|
||||
def retrieve_pushes(self):
|
||||
"""The method to run the daemon thread in.
|
||||
|
||||
Spawn a new Listener and links it to self.on_push.
|
||||
"""
|
||||
from pushbullet import Listener
|
||||
self.listener = Listener(account=self.pushbullet, on_push=self.on_push)
|
||||
_LOGGER.debug("Getting pushes")
|
||||
try:
|
||||
self.listener.run_forever()
|
||||
finally:
|
||||
self.listener.close()
|
|
@ -460,6 +460,7 @@ psutil==5.2.2
|
|||
pubnubsub-handler==1.0.2
|
||||
|
||||
# homeassistant.components.notify.pushbullet
|
||||
# homeassistant.components.sensor.pushbullet
|
||||
pushbullet.py==0.10.0
|
||||
|
||||
# homeassistant.components.notify.pushetta
|
||||
|
|
Loading…
Add table
Reference in a new issue