126 lines
3.5 KiB
Python
126 lines
3.5 KiB
Python
"""Support for Reddit."""
|
|
from datetime import timedelta
|
|
import logging
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.sensor import PLATFORM_SCHEMA
|
|
from homeassistant.const import (CONF_USERNAME, CONF_PASSWORD, CONF_MAXIMUM)
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.helpers.entity import Entity
|
|
|
|
REQUIREMENTS = ['praw==6.1.1']
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
CONF_CLIENT_ID = 'client_id'
|
|
CONF_CLIENT_SECRET = 'client_secret'
|
|
CONF_SUBREDDITS = 'subreddits'
|
|
|
|
ATTR_ID = 'id'
|
|
ATTR_BODY = 'body'
|
|
ATTR_COMMENTS_NUMBER = 'comms_num'
|
|
ATTR_CREATED = 'created'
|
|
ATTR_POSTS = 'posts'
|
|
ATTR_SUBREDDIT = 'subreddit'
|
|
ATTR_SCORE = 'score'
|
|
ATTR_TITLE = 'title'
|
|
ATTR_URL = 'url'
|
|
|
|
DEFAULT_NAME = 'Reddit'
|
|
|
|
SCAN_INTERVAL = timedelta(seconds=300)
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
|
vol.Required(CONF_CLIENT_ID): cv.string,
|
|
vol.Required(CONF_CLIENT_SECRET): cv.string,
|
|
vol.Required(CONF_USERNAME): cv.string,
|
|
vol.Required(CONF_PASSWORD): cv.string,
|
|
vol.Required(CONF_SUBREDDITS): vol.All(cv.ensure_list, [cv.string]),
|
|
vol.Optional(CONF_MAXIMUM, default=10): cv.positive_int
|
|
})
|
|
|
|
|
|
def setup_platform(hass, config, add_entities, discovery_info=None):
|
|
"""Set up the Reddit sensor platform."""
|
|
import praw
|
|
|
|
subreddits = config[CONF_SUBREDDITS]
|
|
user_agent = '{}_home_assistant_sensor'.format(config[CONF_USERNAME])
|
|
limit = config[CONF_MAXIMUM]
|
|
|
|
try:
|
|
reddit = praw.Reddit(
|
|
client_id=config[CONF_CLIENT_ID],
|
|
client_secret=config[CONF_CLIENT_SECRET],
|
|
username=config[CONF_USERNAME],
|
|
password=config[CONF_PASSWORD],
|
|
user_agent=user_agent)
|
|
|
|
_LOGGER.debug('Connected to praw')
|
|
|
|
except praw.exceptions.PRAWException as err:
|
|
_LOGGER.error("Reddit error %s", err)
|
|
return
|
|
|
|
sensors = [RedditSensor(reddit, sub, limit) for sub in subreddits]
|
|
add_entities(sensors, True)
|
|
|
|
|
|
class RedditSensor(Entity):
|
|
"""Representation of a Reddit sensor."""
|
|
|
|
def __init__(self, reddit, subreddit: str, limit: int):
|
|
"""Initialize the Reddit sensor."""
|
|
self._reddit = reddit
|
|
self._limit = limit
|
|
self._subreddit = subreddit
|
|
|
|
self._subreddit_data = []
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the sensor."""
|
|
return 'reddit_{}'.format(self._subreddit)
|
|
|
|
@property
|
|
def state(self):
|
|
"""Return the state of the sensor."""
|
|
return len(self._subreddit_data)
|
|
|
|
@property
|
|
def device_state_attributes(self):
|
|
"""Return the state attributes."""
|
|
return {
|
|
ATTR_SUBREDDIT: self._subreddit,
|
|
ATTR_POSTS: self._subreddit_data
|
|
}
|
|
|
|
@property
|
|
def icon(self):
|
|
"""Return the icon to use in the frontend."""
|
|
return 'mdi:reddit'
|
|
|
|
def update(self):
|
|
"""Update data from Reddit API."""
|
|
import praw
|
|
|
|
self._subreddit_data = []
|
|
|
|
try:
|
|
subreddit = self._reddit.subreddit(self._subreddit)
|
|
|
|
for submission in subreddit.top(limit=self._limit):
|
|
self._subreddit_data.append({
|
|
ATTR_ID: submission.id,
|
|
ATTR_URL: submission.url,
|
|
ATTR_TITLE: submission.title,
|
|
ATTR_SCORE: submission.score,
|
|
ATTR_COMMENTS_NUMBER: submission.num_comments,
|
|
ATTR_CREATED: submission.created,
|
|
ATTR_BODY: submission.selftext
|
|
})
|
|
|
|
except praw.exceptions.PRAWException as err:
|
|
_LOGGER.error("Reddit error %s", err)
|