Converted SABnzbd to a component (#12915)
* Converted SABnzbd to a component * fixed async issues * Made sabnzbd scan interval static. More async fixes. * Sabnzbd component code cleanup * Skip sensor platform setup if discovery_info is None
This commit is contained in:
Jerad Meisner
Martin Hjelmare
parent
91fe6e4e56
commit
e60d066514
5 changed files with 296 additions and 180 deletions
|
|
@ -4,216 +4,75 @@ Support for monitoring an SABnzbd NZB client.
|
|||
For more details about this platform, please refer to the documentation at
|
||||
https://home-assistant.io/components/sensor.sabnzbd/
|
||||
"""
|
||||
import asyncio
|
||||
import logging
|
||||
from datetime import timedelta
|
||||
|
||||
import voluptuous as vol
|
||||
|
||||
from homeassistant.components.sensor import PLATFORM_SCHEMA
|
||||
from homeassistant.const import (
|
||||
CONF_HOST, CONF_API_KEY, CONF_NAME, CONF_PORT, CONF_MONITORED_VARIABLES,
|
||||
CONF_SSL)
|
||||
from homeassistant.components.sabnzbd import DATA_SABNZBD, \
|
||||
SIGNAL_SABNZBD_UPDATED, SENSOR_TYPES
|
||||
from homeassistant.helpers.dispatcher import async_dispatcher_connect
|
||||
from homeassistant.helpers.entity import Entity
|
||||
from homeassistant.util import Throttle
|
||||
from homeassistant.util.json import load_json, save_json
|
||||
import homeassistant.helpers.config_validation as cv
|
||||
|
||||
REQUIREMENTS = ['pysabnzbd==1.0.1']
|
||||
DEPENDENCIES = ['sabnzbd']
|
||||
|
||||
_CONFIGURING = {}
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
CONFIG_FILE = 'sabnzbd.conf'
|
||||
DEFAULT_NAME = 'SABnzbd'
|
||||
DEFAULT_PORT = 8080
|
||||
DEFAULT_SSL = False
|
||||
|
||||
MIN_TIME_BETWEEN_UPDATES = timedelta(seconds=1)
|
||||
|
||||
SENSOR_TYPES = {
|
||||
'current_status': ['Status', None],
|
||||
'speed': ['Speed', 'MB/s'],
|
||||
'queue_size': ['Queue', 'MB'],
|
||||
'queue_remaining': ['Left', 'MB'],
|
||||
'disk_size': ['Disk', 'GB'],
|
||||
'disk_free': ['Disk Free', 'GB'],
|
||||
'queue_count': ['Queue Count', None],
|
||||
}
|
||||
|
||||
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
||||
vol.Required(CONF_API_KEY): cv.string,
|
||||
vol.Required(CONF_HOST): cv.string,
|
||||
vol.Optional(CONF_MONITORED_VARIABLES, default=['current_status']):
|
||||
vol.All(cv.ensure_list, [vol.In(SENSOR_TYPES)]),
|
||||
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
||||
vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port,
|
||||
vol.Optional(CONF_SSL, default=DEFAULT_SSL): cv.boolean,
|
||||
})
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def async_check_sabnzbd(sab_api, base_url, api_key):
|
||||
"""Check if we can reach SABnzbd."""
|
||||
from pysabnzbd import SabnzbdApiException
|
||||
sab_api = sab_api(base_url, api_key)
|
||||
|
||||
try:
|
||||
yield from sab_api.check_available()
|
||||
except SabnzbdApiException:
|
||||
_LOGGER.error("Connection to SABnzbd API failed")
|
||||
return False
|
||||
return True
|
||||
|
||||
|
||||
def setup_sabnzbd(base_url, apikey, name, config,
|
||||
async_add_devices, sab_api):
|
||||
"""Set up polling from SABnzbd and sensors."""
|
||||
sab_api = sab_api(base_url, apikey)
|
||||
monitored = config.get(CONF_MONITORED_VARIABLES)
|
||||
async_add_devices([SabnzbdSensor(variable, sab_api, name)
|
||||
for variable in monitored])
|
||||
|
||||
|
||||
@Throttle(MIN_TIME_BETWEEN_UPDATES)
|
||||
async def async_update_queue(sab_api):
|
||||
"""
|
||||
Throttled function to update SABnzbd queue.
|
||||
|
||||
This ensures that the queue info only gets updated once for all sensors
|
||||
"""
|
||||
await sab_api.refresh_data()
|
||||
|
||||
|
||||
def request_configuration(host, name, hass, config, async_add_devices,
|
||||
sab_api):
|
||||
"""Request configuration steps from the user."""
|
||||
configurator = hass.components.configurator
|
||||
# We got an error if this method is called while we are configuring
|
||||
if host in _CONFIGURING:
|
||||
configurator.notify_errors(_CONFIGURING[host],
|
||||
'Failed to register, please try again.')
|
||||
|
||||
async def async_setup_platform(hass, config, async_add_devices,
|
||||
discovery_info=None):
|
||||
"""Set up the SABnzbd sensors."""
|
||||
if discovery_info is None:
|
||||
return
|
||||
|
||||
@asyncio.coroutine
|
||||
def async_configuration_callback(data):
|
||||
"""Handle configuration changes."""
|
||||
api_key = data.get('api_key')
|
||||
if (yield from async_check_sabnzbd(sab_api, host, api_key)):
|
||||
setup_sabnzbd(host, api_key, name, config,
|
||||
async_add_devices, sab_api)
|
||||
|
||||
def success():
|
||||
"""Set up was successful."""
|
||||
conf = load_json(hass.config.path(CONFIG_FILE))
|
||||
conf[host] = {'api_key': api_key}
|
||||
save_json(hass.config.path(CONFIG_FILE), conf)
|
||||
req_config = _CONFIGURING.pop(host)
|
||||
configurator.async_request_done(req_config)
|
||||
|
||||
hass.async_add_job(success)
|
||||
|
||||
_CONFIGURING[host] = configurator.async_request_config(
|
||||
DEFAULT_NAME,
|
||||
async_configuration_callback,
|
||||
description='Enter the API Key',
|
||||
submit_caption='Confirm',
|
||||
fields=[{'id': 'api_key', 'name': 'API Key', 'type': ''}]
|
||||
)
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def async_setup_platform(hass, config, async_add_devices, discovery_info=None):
|
||||
"""Set up the SABnzbd platform."""
|
||||
from pysabnzbd import SabnzbdApi
|
||||
|
||||
if discovery_info is not None:
|
||||
host = discovery_info.get(CONF_HOST)
|
||||
port = discovery_info.get(CONF_PORT)
|
||||
name = DEFAULT_NAME
|
||||
use_ssl = discovery_info.get('properties', {}).get('https', '0') == '1'
|
||||
else:
|
||||
host = config.get(CONF_HOST)
|
||||
port = config.get(CONF_PORT)
|
||||
name = config.get(CONF_NAME, DEFAULT_NAME)
|
||||
use_ssl = config.get(CONF_SSL)
|
||||
|
||||
api_key = config.get(CONF_API_KEY)
|
||||
|
||||
uri_scheme = 'https://' if use_ssl else 'http://'
|
||||
base_url = "{}{}:{}/".format(uri_scheme, host, port)
|
||||
|
||||
if not api_key:
|
||||
conf = load_json(hass.config.path(CONFIG_FILE))
|
||||
if conf.get(base_url, {}).get('api_key'):
|
||||
api_key = conf[base_url]['api_key']
|
||||
|
||||
if not (yield from async_check_sabnzbd(SabnzbdApi, base_url, api_key)):
|
||||
request_configuration(base_url, name, hass, config,
|
||||
async_add_devices, SabnzbdApi)
|
||||
return
|
||||
|
||||
setup_sabnzbd(base_url, api_key, name, config,
|
||||
async_add_devices, SabnzbdApi)
|
||||
sab_api_data = hass.data[DATA_SABNZBD]
|
||||
sensors = sab_api_data.sensors
|
||||
client_name = sab_api_data.name
|
||||
async_add_devices([SabnzbdSensor(sensor, sab_api_data, client_name)
|
||||
for sensor in sensors])
|
||||
|
||||
|
||||
class SabnzbdSensor(Entity):
|
||||
"""Representation of an SABnzbd sensor."""
|
||||
|
||||
def __init__(self, sensor_type, sabnzbd_api, client_name):
|
||||
def __init__(self, sensor_type, sabnzbd_api_data, client_name):
|
||||
"""Initialize the sensor."""
|
||||
self._client_name = client_name
|
||||
self._field_name = SENSOR_TYPES[sensor_type][2]
|
||||
self._name = SENSOR_TYPES[sensor_type][0]
|
||||
self.sabnzbd_api = sabnzbd_api
|
||||
self.type = sensor_type
|
||||
self.client_name = client_name
|
||||
self._sabnzbd_api = sabnzbd_api_data
|
||||
self._state = None
|
||||
self._type = sensor_type
|
||||
self._unit_of_measurement = SENSOR_TYPES[sensor_type][1]
|
||||
|
||||
async def async_added_to_hass(self):
|
||||
"""Call when entity about to be added to hass."""
|
||||
async_dispatcher_connect(self.hass, SIGNAL_SABNZBD_UPDATED,
|
||||
self.update_state)
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
"""Return the name of the sensor."""
|
||||
return '{} {}'.format(self.client_name, self._name)
|
||||
return '{} {}'.format(self._client_name, self._name)
|
||||
|
||||
@property
|
||||
def state(self):
|
||||
"""Return the state of the sensor."""
|
||||
return self._state
|
||||
|
||||
def should_poll(self):
|
||||
"""Don't poll. Will be updated by dispatcher signal."""
|
||||
return False
|
||||
|
||||
@property
|
||||
def unit_of_measurement(self):
|
||||
"""Return the unit of measurement of this entity, if any."""
|
||||
return self._unit_of_measurement
|
||||
|
||||
@asyncio.coroutine
|
||||
def async_refresh_sabnzbd_data(self):
|
||||
"""Call the throttled SABnzbd refresh method."""
|
||||
from pysabnzbd import SabnzbdApiException
|
||||
try:
|
||||
yield from async_update_queue(self.sabnzbd_api)
|
||||
except SabnzbdApiException:
|
||||
_LOGGER.exception("Connection to SABnzbd API failed")
|
||||
|
||||
@asyncio.coroutine
|
||||
def async_update(self):
|
||||
def update_state(self, args):
|
||||
"""Get the latest data and updates the states."""
|
||||
yield from self.async_refresh_sabnzbd_data()
|
||||
self._state = self._sabnzbd_api.get_queue_field(self._field_name)
|
||||
|
||||
if self.sabnzbd_api.queue:
|
||||
if self.type == 'current_status':
|
||||
self._state = self.sabnzbd_api.queue.get('status')
|
||||
elif self.type == 'speed':
|
||||
mb_spd = float(self.sabnzbd_api.queue.get('kbpersec')) / 1024
|
||||
self._state = round(mb_spd, 1)
|
||||
elif self.type == 'queue_size':
|
||||
self._state = self.sabnzbd_api.queue.get('mb')
|
||||
elif self.type == 'queue_remaining':
|
||||
self._state = self.sabnzbd_api.queue.get('mbleft')
|
||||
elif self.type == 'disk_size':
|
||||
self._state = self.sabnzbd_api.queue.get('diskspacetotal1')
|
||||
elif self.type == 'disk_free':
|
||||
self._state = self.sabnzbd_api.queue.get('diskspace1')
|
||||
elif self.type == 'queue_count':
|
||||
self._state = self.sabnzbd_api.queue.get('noofslots_total')
|
||||
else:
|
||||
self._state = 'Unknown'
|
||||
if self._type == 'speed':
|
||||
self._state = round(float(self._state) / 1024, 1)
|
||||
elif 'size' in self._type:
|
||||
self._state = round(float(self._state), 2)
|
||||
|
||||
self.schedule_update_ha_state()
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue