mirror of
https://github.com/home-assistant/core.git
synced 2026-03-04 00:30:26 +00:00
fe626f5669
* Added Post Processing Jobs to NZBGet component In the current implementation of the NZBGet component there is no way of knowing whether NZBGet is still in the Post Processing phase of a download job. This can be very useful information. For instance when you want to suspend the NZBGet service when all queue items have been completed. This change adds that additional sensor. * Renamed Count to Jobs in NZBGet component
113 lines
3.5 KiB
Python
113 lines
3.5 KiB
Python
"""Monitor the NZBGet API."""
|
|
import logging
|
|
|
|
from homeassistant.core import callback
|
|
from homeassistant.helpers.dispatcher import async_dispatcher_connect
|
|
from homeassistant.helpers.entity import Entity
|
|
|
|
from . import DATA_NZBGET, DATA_UPDATED
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
DEFAULT_NAME = "NZBGet"
|
|
|
|
SENSOR_TYPES = {
|
|
"article_cache": ["ArticleCacheMB", "Article Cache", "MB"],
|
|
"average_download_rate": ["AverageDownloadRate", "Average Speed", "MB/s"],
|
|
"download_paused": ["DownloadPaused", "Download Paused", None],
|
|
"download_rate": ["DownloadRate", "Speed", "MB/s"],
|
|
"download_size": ["DownloadedSizeMB", "Size", "MB"],
|
|
"free_disk_space": ["FreeDiskSpaceMB", "Disk Free", "MB"],
|
|
"post_job_count": ["PostJobCount", "Post Processing Jobs", "Jobs"],
|
|
"post_paused": ["PostPaused", "Post Processing Paused", None],
|
|
"remaining_size": ["RemainingSizeMB", "Queue Size", "MB"],
|
|
"uptime": ["UpTimeSec", "Uptime", "min"],
|
|
}
|
|
|
|
|
|
def setup_platform(hass, config, add_entities, discovery_info=None):
|
|
"""Create NZBGet sensors."""
|
|
|
|
if discovery_info is None:
|
|
return
|
|
|
|
nzbget_data = hass.data[DATA_NZBGET]
|
|
name = discovery_info["client_name"]
|
|
|
|
devices = []
|
|
for sensor_config in SENSOR_TYPES.values():
|
|
new_sensor = NZBGetSensor(
|
|
nzbget_data, sensor_config[0], name, sensor_config[1], sensor_config[2]
|
|
)
|
|
devices.append(new_sensor)
|
|
|
|
add_entities(devices, True)
|
|
|
|
|
|
class NZBGetSensor(Entity):
|
|
"""Representation of a NZBGet sensor."""
|
|
|
|
def __init__(
|
|
self, nzbget_data, sensor_type, client_name, sensor_name, unit_of_measurement
|
|
):
|
|
"""Initialize a new NZBGet sensor."""
|
|
self._name = f"{client_name} {sensor_name}"
|
|
self.type = sensor_type
|
|
self.client_name = client_name
|
|
self.nzbget_data = nzbget_data
|
|
self._state = None
|
|
self._unit_of_measurement = unit_of_measurement
|
|
|
|
@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._state
|
|
|
|
@property
|
|
def unit_of_measurement(self):
|
|
"""Return the unit of measurement of this entity, if any."""
|
|
return self._unit_of_measurement
|
|
|
|
@property
|
|
def available(self):
|
|
"""Return whether the sensor is available."""
|
|
return self.nzbget_data.available
|
|
|
|
async def async_added_to_hass(self):
|
|
"""Handle entity which will be added."""
|
|
async_dispatcher_connect(
|
|
self.hass, DATA_UPDATED, self._schedule_immediate_update
|
|
)
|
|
|
|
@callback
|
|
def _schedule_immediate_update(self):
|
|
self.async_schedule_update_ha_state(True)
|
|
|
|
def update(self):
|
|
"""Update state of sensor."""
|
|
|
|
if self.nzbget_data.status is None:
|
|
_LOGGER.debug(
|
|
"Update of %s requested, but no status is available", self._name
|
|
)
|
|
return
|
|
|
|
value = self.nzbget_data.status.get(self.type)
|
|
if value is None:
|
|
_LOGGER.warning("Unable to locate value for %s", self.type)
|
|
return
|
|
|
|
if "DownloadRate" in self.type and value > 0:
|
|
# Convert download rate from Bytes/s to MBytes/s
|
|
self._state = round(value / 2 ** 20, 2)
|
|
elif "UpTimeSec" in self.type and value > 0:
|
|
# Convert uptime from seconds to minutes
|
|
self._state = round(value / 60, 2)
|
|
else:
|
|
self._state = value
|