forked from home-assistant/core
/
qbittorrent.py
139 lines (111 loc) · 4.42 KB
/
qbittorrent.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
"""Support for monitoring the qBittorrent API."""
import logging
import voluptuous as vol
from homeassistant.components.sensor import PLATFORM_SCHEMA
from homeassistant.const import (
CONF_NAME, CONF_PASSWORD, CONF_URL, CONF_USERNAME, STATE_IDLE)
from homeassistant.helpers.entity import Entity
import homeassistant.helpers.config_validation as cv
from homeassistant.exceptions import PlatformNotReady
from requests.exceptions import RequestException
REQUIREMENTS = ['python-qbittorrent==0.3.1']
_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', 'kB/s'],
SENSOR_TYPE_UPLOAD_SPEED: ['Up Speed', 'kB/s'],
}
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
})
async def async_setup_platform(hass, config, add_entities,
discovery_info=None):
"""Set up the qbittorrent sensors."""
from qbittorrent.client import Client, LoginRequired
try:
client = Client(config.get(CONF_URL))
client.login(config.get(CONF_USERNAME), config.get(CONF_PASSWORD))
except LoginRequired:
_LOGGER.info("Invalid authentication for qBittorrent. Check config.")
return
except RequestException:
_LOGGER.error("Connection to qBittorrent failed. Check config.")
raise PlatformNotReady
name = config.get(CONF_NAME)
dev = []
for sensor_type in SENSOR_TYPES:
sensor = QBittorrentSensor(sensor_type, client, name, LoginRequired)
dev.append(sensor)
await sensor.async_update()
add_entities(dev)
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 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 '{} {}'.format(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
async def async_update(self):
"""Get the latest data from qbittorrent and updates the state."""
try:
data = self.client.sync()
self._available = True
except RequestException:
_LOGGER.error("Connection to qBittorrent lost.")
self._available = False
return
except self._exception:
_LOGGER.info("Invalid authentication for qBittorrent."
" Check config.")
return
download = data['server_state']['dl_info_speed']
upload = data['server_state']['up_info_speed']
if self.type == SENSOR_TYPE_CURRENT_STATUS:
if data:
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
else:
self._state = None
if data:
if self.type == SENSOR_TYPE_DOWNLOAD_SPEED:
self._state = format_speed(download)
elif self.type == SENSOR_TYPE_UPLOAD_SPEED:
self._state = format_speed(upload)