homeassistant.components.reddit.sensor Namespace Reference

Classes
class	RedditSensor

Functions
None	setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback add_entities, DiscoveryInfoType|None discovery_info=None)

Variables
	_LOGGER = logging.getLogger(__name__)
string	ATTR_BODY = "body"
string	ATTR_COMMENTS_NUMBER = "comms_num"
string	ATTR_CREATED = "created"
string	ATTR_POSTS = "posts"
string	ATTR_SCORE = "score"
string	ATTR_SUBREDDIT = "subreddit"
string	ATTR_TITLE = "title"
string	ATTR_URL = "url"
string	CONF_SORT_BY = "sort_by"
string	CONF_SUBREDDITS = "subreddits"
string	DEFAULT_NAME = "Reddit"
string	DOMAIN = "reddit"
list	LIST_TYPES = ["top", "controversial", "hot", "new"]
	PLATFORM_SCHEMA
	SCAN_INTERVAL = timedelta(seconds=300)

Detailed Description

Support for Reddit.

Function Documentation

setup_platform()

None homeassistant.components.reddit.sensor.setup_platform	(	HomeAssistant	hass,
		ConfigType	config,
		AddEntitiesCallback	add_entities,
		DiscoveryInfoType | None	discovery_info = None
	)

Set up the Reddit sensor platform.

Definition at line 65 of file sensor.py.

Variable Documentation

_LOGGER

homeassistant.components.reddit.sensor._LOGGER = logging.getLogger(__name__)

private

Definition at line 28 of file sensor.py.

ATTR_BODY

string homeassistant.components.reddit.sensor.ATTR_BODY = "body"

Definition at line 33 of file sensor.py.

ATTR_COMMENTS_NUMBER

string homeassistant.components.reddit.sensor.ATTR_COMMENTS_NUMBER = "comms_num"

Definition at line 34 of file sensor.py.

ATTR_CREATED

string homeassistant.components.reddit.sensor.ATTR_CREATED = "created"

Definition at line 35 of file sensor.py.

ATTR_POSTS

string homeassistant.components.reddit.sensor.ATTR_POSTS = "posts"

Definition at line 36 of file sensor.py.

ATTR_SCORE

string homeassistant.components.reddit.sensor.ATTR_SCORE = "score"

Definition at line 38 of file sensor.py.

ATTR_SUBREDDIT

string homeassistant.components.reddit.sensor.ATTR_SUBREDDIT = "subreddit"

Definition at line 37 of file sensor.py.

ATTR_TITLE

string homeassistant.components.reddit.sensor.ATTR_TITLE = "title"

Definition at line 39 of file sensor.py.

ATTR_URL

string homeassistant.components.reddit.sensor.ATTR_URL = "url"

Definition at line 40 of file sensor.py.

CONF_SORT_BY

string homeassistant.components.reddit.sensor.CONF_SORT_BY = "sort_by"

Definition at line 30 of file sensor.py.

CONF_SUBREDDITS

string homeassistant.components.reddit.sensor.CONF_SUBREDDITS = "subreddits"

Definition at line 31 of file sensor.py.

DEFAULT_NAME

string homeassistant.components.reddit.sensor.DEFAULT_NAME = "Reddit"

Definition at line 42 of file sensor.py.

DOMAIN

string homeassistant.components.reddit.sensor.DOMAIN = "reddit"

Definition at line 44 of file sensor.py.

LIST_TYPES

list homeassistant.components.reddit.sensor.LIST_TYPES = ["top", "controversial", "hot", "new"]

Definition at line 46 of file sensor.py.

PLATFORM_SCHEMA

homeassistant.components.reddit.sensor.PLATFORM_SCHEMA

Initial value:

=  SENSOR_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_SORT_BY, default="hot"): vol.All(
            cv.string, vol.In(LIST_TYPES)
        ),
        vol.Optional(CONF_MAXIMUM, default=10): cv.positive_int,
    }
)

Definition at line 50 of file sensor.py.

SCAN_INTERVAL

homeassistant.components.reddit.sensor.SCAN_INTERVAL = timedelta(seconds=300)

Definition at line 48 of file sensor.py.