mirror of
https://github.com/home-assistant/core
synced 2024-07-30 21:18:57 +02:00
b4bac0f7a0
* Remove unnecessary exception re-wraps * Preserve exception chains on re-raise We slap "from cause" to almost all possible cases here. In some cases it could conceivably be better to do "from None" if we really want to hide the cause. However those should be in the minority, and "from cause" should be an improvement over the corresponding raise without a "from" in all cases anyway. The only case where we raise from None here is in plex, where the exception for an original invalid SSL cert is not the root cause for failure to validate a newly fetched one. Follow local convention on exception variable names if there is a consistent one, otherwise `err` to match with majority of codebase. * Fix mistaken re-wrap in homematicip_cloud/hap.py Missed the difference between HmipConnectionError and HmipcConnectionError. * Do not hide original error on plex new cert validation error Original is not the cause for the new one, but showing old in the traceback is useful nevertheless.
141 lines
4.2 KiB
Python
141 lines
4.2 KiB
Python
"""Support for monitoring the qBittorrent API."""
|
|
import logging
|
|
|
|
from qbittorrent.client import Client, LoginRequired
|
|
from requests.exceptions import RequestException
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.sensor import PLATFORM_SCHEMA
|
|
from homeassistant.const import (
|
|
CONF_NAME,
|
|
CONF_PASSWORD,
|
|
CONF_URL,
|
|
CONF_USERNAME,
|
|
DATA_RATE_KILOBYTES_PER_SECOND,
|
|
STATE_IDLE,
|
|
)
|
|
from homeassistant.exceptions import PlatformNotReady
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.helpers.entity import Entity
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
SENSOR_TYPE_CURRENT_STATUS = "current_status"
|
|
SENSOR_TYPE_DOWNLOAD_SPEED = "download_speed"
|
|
SENSOR_TYPE_UPLOAD_SPEED = "upload_speed"
|
|
|
|
DEFAULT_NAME = "qBittorrent"
|
|
|
|
SENSOR_TYPES = {
|
|
SENSOR_TYPE_CURRENT_STATUS: ["Status", None],
|
|
SENSOR_TYPE_DOWNLOAD_SPEED: ["Down Speed", DATA_RATE_KILOBYTES_PER_SECOND],
|
|
SENSOR_TYPE_UPLOAD_SPEED: ["Up Speed", DATA_RATE_KILOBYTES_PER_SECOND],
|
|
}
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
|
|
{
|
|
vol.Required(CONF_URL): cv.url,
|
|
vol.Required(CONF_USERNAME): cv.string,
|
|
vol.Required(CONF_PASSWORD): cv.string,
|
|
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
|
}
|
|
)
|
|
|
|
|
|
def setup_platform(hass, config, add_entities, discovery_info=None):
|
|
"""Set up the qBittorrent sensors."""
|
|
|
|
try:
|
|
client = Client(config[CONF_URL])
|
|
client.login(config[CONF_USERNAME], config[CONF_PASSWORD])
|
|
except LoginRequired:
|
|
_LOGGER.error("Invalid authentication")
|
|
return
|
|
except RequestException as err:
|
|
_LOGGER.error("Connection failed")
|
|
raise PlatformNotReady from err
|
|
|
|
name = config.get(CONF_NAME)
|
|
|
|
dev = []
|
|
for sensor_type in SENSOR_TYPES:
|
|
sensor = QBittorrentSensor(sensor_type, client, name, LoginRequired)
|
|
dev.append(sensor)
|
|
|
|
add_entities(dev, True)
|
|
|
|
|
|
def format_speed(speed):
|
|
"""Return a bytes/s measurement as a human readable string."""
|
|
kb_spd = float(speed) / 1024
|
|
return round(kb_spd, 2 if kb_spd < 0.1 else 1)
|
|
|
|
|
|
class QBittorrentSensor(Entity):
|
|
"""Representation of an qBittorrent sensor."""
|
|
|
|
def __init__(self, sensor_type, qbittorrent_client, client_name, exception):
|
|
"""Initialize the qBittorrent sensor."""
|
|
self._name = SENSOR_TYPES[sensor_type][0]
|
|
self.client = qbittorrent_client
|
|
self.type = sensor_type
|
|
self.client_name = client_name
|
|
self._state = None
|
|
self._unit_of_measurement = SENSOR_TYPES[sensor_type][1]
|
|
self._available = False
|
|
self._exception = exception
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the sensor."""
|
|
return f"{self.client_name} {self._name}"
|
|
|
|
@property
|
|
def state(self):
|
|
"""Return the state of the sensor."""
|
|
return self._state
|
|
|
|
@property
|
|
def available(self):
|
|
"""Return true if device is available."""
|
|
return self._available
|
|
|
|
@property
|
|
def unit_of_measurement(self):
|
|
"""Return the unit of measurement of this entity, if any."""
|
|
return self._unit_of_measurement
|
|
|
|
def update(self):
|
|
"""Get the latest data from qBittorrent and updates the state."""
|
|
try:
|
|
data = self.client.sync_main_data()
|
|
self._available = True
|
|
except RequestException:
|
|
_LOGGER.error("Connection lost")
|
|
self._available = False
|
|
return
|
|
except self._exception:
|
|
_LOGGER.error("Invalid authentication")
|
|
return
|
|
|
|
if data is None:
|
|
return
|
|
|
|
download = data["server_state"]["dl_info_speed"]
|
|
upload = data["server_state"]["up_info_speed"]
|
|
|
|
if self.type == SENSOR_TYPE_CURRENT_STATUS:
|
|
if upload > 0 and download > 0:
|
|
self._state = "up_down"
|
|
elif upload > 0 and download == 0:
|
|
self._state = "seeding"
|
|
elif upload == 0 and download > 0:
|
|
self._state = "downloading"
|
|
else:
|
|
self._state = STATE_IDLE
|
|
|
|
elif self.type == SENSOR_TYPE_DOWNLOAD_SPEED:
|
|
self._state = format_speed(download)
|
|
elif self.type == SENSOR_TYPE_UPLOAD_SPEED:
|
|
self._state = format_speed(upload)
|