-
-
Notifications
You must be signed in to change notification settings - Fork 37.2k
Add Tautulli sensor platform #17835
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Add Tautulli sensor platform #17835
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
d01d3ed
Adds Tautulli as a sensor platform.
ludeeus 2258b8b
Remove blank last line.
ludeeus f331f42
Rewrite the platform to comply with review.
ludeeus 05db353
Linting issues.
ludeeus 280fb96
Remove tailing newline.
ludeeus b752e62
Corrected typo
ludeeus 1fe3d02
Correcte check_connection, removed wierd defaults, added line in impo…
ludeeus 2e50385
Merge branch 'tautulli' of https://github.com/ludeeus/home-assistant …
ludeeus de458b3
Use dict[key] for required config options.
ludeeus cae34db
Minor changes
fabaff File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| """ | ||
| A platform which allows you to get information from Tautulli. | ||
|
|
||
| For more details about this platform, please refer to the documentation at | ||
| https://www.home-assistant.io/components/sensor.tautulli/ | ||
| """ | ||
| from datetime import timedelta | ||
| import logging | ||
|
|
||
| import voluptuous as vol | ||
|
|
||
| from homeassistant.components.sensor import PLATFORM_SCHEMA | ||
| from homeassistant.const import ( | ||
| CONF_API_KEY, CONF_HOST, CONF_MONITORED_CONDITIONS, CONF_NAME, CONF_PORT, | ||
| CONF_SSL, CONF_VERIFY_SSL) | ||
| from homeassistant.exceptions import PlatformNotReady | ||
| from homeassistant.helpers.aiohttp_client import async_get_clientsession | ||
| import homeassistant.helpers.config_validation as cv | ||
| from homeassistant.helpers.entity import Entity | ||
| from homeassistant.util import Throttle | ||
|
|
||
| REQUIREMENTS = ['pytautulli==0.4.0'] | ||
|
|
||
| _LOGGER = logging.getLogger(__name__) | ||
|
|
||
| CONF_MONITORED_USERS = 'monitored_users' | ||
|
|
||
| DEFAULT_NAME = 'Tautulli' | ||
| DEFAULT_PORT = '8181' | ||
| DEFAULT_SSL = False | ||
| DEFAULT_VERIFY_SSL = True | ||
|
|
||
| TIME_BETWEEN_UPDATES = timedelta(seconds=10) | ||
|
|
||
| PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ | ||
| vol.Required(CONF_API_KEY): cv.string, | ||
| vol.Required(CONF_HOST): cv.string, | ||
| vol.Optional(CONF_MONITORED_CONDITIONS): | ||
| vol.All(cv.ensure_list, [cv.string]), | ||
| vol.Optional(CONF_MONITORED_USERS): vol.All(cv.ensure_list, [cv.string]), | ||
| vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string, | ||
| vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.string, | ||
| vol.Optional(CONF_SSL, default=DEFAULT_SSL): cv.boolean, | ||
| vol.Optional(CONF_VERIFY_SSL, default=DEFAULT_VERIFY_SSL): cv.boolean, | ||
| }) | ||
|
|
||
|
|
||
| async def async_setup_platform( | ||
| hass, config, async_add_entities, discovery_info=None): | ||
| """Create the Tautulli sensor.""" | ||
| from pytautulli import Tautulli | ||
|
|
||
| name = config.get(CONF_NAME) | ||
| host = config[CONF_HOST] | ||
| port = config.get(CONF_PORT) | ||
| api_key = config[CONF_API_KEY] | ||
| monitored_conditions = config.get(CONF_MONITORED_CONDITIONS) | ||
| user = config.get(CONF_MONITORED_USERS) | ||
| use_ssl = config.get(CONF_SSL) | ||
| verify_ssl = config.get(CONF_VERIFY_SSL) | ||
|
|
||
| session = async_get_clientsession(hass, verify_ssl) | ||
| tautulli = TautulliData(Tautulli( | ||
| host, port, api_key, hass.loop, session, use_ssl)) | ||
|
|
||
| if not await tautulli.test_connection(): | ||
| raise PlatformNotReady | ||
|
|
||
| sensor = [TautulliSensor(tautulli, name, monitored_conditions, user)] | ||
|
|
||
| async_add_entities(sensor, True) | ||
|
|
||
|
|
||
| class TautulliSensor(Entity): | ||
| """Representation of a Tautulli sensor.""" | ||
|
|
||
| def __init__(self, tautulli, name, monitored_conditions, users): | ||
| """Initialize the Tautulli sensor.""" | ||
| self.tautulli = tautulli | ||
| self.monitored_conditions = monitored_conditions | ||
| self.usernames = users | ||
| self.sessions = {} | ||
| self.home = {} | ||
| self._attributes = {} | ||
| self._name = name | ||
| self._state = None | ||
|
|
||
| async def async_update(self): | ||
| """Get the latest data from the Tautulli API.""" | ||
| await self.tautulli.async_update() | ||
| self.home = self.tautulli.api.home_data | ||
| self.sessions = self.tautulli.api.session_data | ||
| self._attributes['Top Movie'] = self.home[0]['rows'][0]['title'] | ||
| self._attributes['Top TV Show'] = self.home[3]['rows'][0]['title'] | ||
| self._attributes['Top User'] = self.home[7]['rows'][0]['user'] | ||
| for key in self.sessions: | ||
| if 'sessions' not in key: | ||
| self._attributes[key] = self.sessions[key] | ||
| for user in self.tautulli.api.users: | ||
| if self.usernames is None or user in self.usernames: | ||
| userdata = self.tautulli.api.user_data | ||
| self._attributes[user] = {} | ||
| self._attributes[user]['Activity'] = userdata[user]['Activity'] | ||
| if self.monitored_conditions: | ||
| for key in self.monitored_conditions: | ||
| try: | ||
| self._attributes[user][key] = userdata[user][key] | ||
| except (KeyError, TypeError): | ||
| self._attributes[user][key] = '' | ||
|
|
||
| @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.sessions['stream_count'] | ||
|
|
||
| @property | ||
| def icon(self): | ||
| """Return the icon of the sensor.""" | ||
| return 'mdi:plex' | ||
|
|
||
| @property | ||
| def device_state_attributes(self): | ||
| """Return attributes for the sensor.""" | ||
| return self._attributes | ||
|
|
||
|
|
||
| class TautulliData: | ||
ludeeus marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| """Get the latest data and update the states.""" | ||
|
|
||
| def __init__(self, api): | ||
| """Initialize the data object.""" | ||
| self.api = api | ||
|
|
||
| @Throttle(TIME_BETWEEN_UPDATES) | ||
| async def async_update(self): | ||
| """Get the latest data from Tautulli.""" | ||
| await self.api.get_data() | ||
|
|
||
ludeeus marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| async def test_connection(self): | ||
| """Test connection to Tautulli.""" | ||
| await self.api.test_connection() | ||
| connection_status = self.api.connection | ||
| return connection_status | ||
This file contains hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.