From 89807f24adfe0ec577a543a412b5015f4d3b6dfe Mon Sep 17 00:00:00 2001 From: Colin O'Dell Date: Thu, 23 Feb 2017 09:01:25 -0500 Subject: [PATCH] QNAP update (#6182) * Bump qnapstats library to 0.2.3 * Expose the new timeout setting * Show persistent notification if QNAP fails to set up This sitaution will usually occur if the server configuration is wrong or the timeout is set too low. In both cases `api.update()` will fail, which is a problem because we cannot initialize many of the sensors without having this data. * Add new system_temp condition to QNAP sensor --- homeassistant/components/sensor/qnap.py | 41 +++++++++++++++++++------ requirements_all.txt | 2 +- 2 files changed, 32 insertions(+), 11 deletions(-) diff --git a/homeassistant/components/sensor/qnap.py b/homeassistant/components/sensor/qnap.py index 95eece5779a..b37cb432461 100644 --- a/homeassistant/components/sensor/qnap.py +++ b/homeassistant/components/sensor/qnap.py @@ -12,13 +12,13 @@ from homeassistant.components.sensor import PLATFORM_SCHEMA from homeassistant.helpers.entity import Entity from homeassistant.const import ( CONF_HOST, CONF_USERNAME, CONF_PASSWORD, CONF_PORT, CONF_SSL, - CONF_VERIFY_SSL, CONF_MONITORED_CONDITIONS, TEMP_CELSIUS) + CONF_VERIFY_SSL, CONF_TIMEOUT, CONF_MONITORED_CONDITIONS, TEMP_CELSIUS) from homeassistant.util import Throttle import homeassistant.helpers.config_validation as cv import voluptuous as vol -REQUIREMENTS = ['qnapstats==0.2.2'] +REQUIREMENTS = ['qnapstats==0.2.3'] _LOGGER = logging.getLogger(__name__) @@ -44,11 +44,16 @@ CONF_NICS = 'nics' CONF_VOLUMES = 'volumes' DEFAULT_NAME = 'QNAP' DEFAULT_PORT = 8080 +DEFAULT_TIMEOUT = 5 MIN_TIME_BETWEEN_UPDATES = timedelta(minutes=1) -_HEALTH_MON_COND = { +NOTIFICATION_ID = 'qnap_notification' +NOTIFICATION_TITLE = 'QNAP Sensor Setup' + +_SYSTEM_MON_COND = { 'status': ['Status', None, 'mdi:checkbox-marked-circle-outline'], + 'system_temp': ['System Temperature', TEMP_CELSIUS, 'mdi:thermometer'], } _CPU_MON_COND = { 'cpu_temp': ['CPU Temperature', TEMP_CELSIUS, 'mdi:thermometer'], @@ -76,7 +81,7 @@ _VOLUME_MON_COND = { 'volume_percentage_used': ['Volume Used', '%', 'mdi:chart-pie'], } -_MONITORED_CONDITIONS = list(_HEALTH_MON_COND.keys()) + \ +_MONITORED_CONDITIONS = list(_SYSTEM_MON_COND.keys()) + \ list(_CPU_MON_COND.keys()) + \ list(_MEMORY_MON_COND.keys()) + \ list(_NETWORK_MON_COND.keys()) + \ @@ -88,6 +93,7 @@ PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ vol.Optional(CONF_SSL, default=False): cv.boolean, vol.Optional(CONF_VERIFY_SSL, default=True): cv.boolean, vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port, + vol.Optional(CONF_TIMEOUT, default=DEFAULT_TIMEOUT): cv.positive_int, vol.Required(CONF_USERNAME): cv.string, vol.Required(CONF_PASSWORD): cv.string, vol.Optional(CONF_MONITORED_CONDITIONS): @@ -104,13 +110,23 @@ def setup_platform(hass, config, add_devices, discovery_info=None): api = QNAPStatsAPI(config) api.update() + if not api.data: + import homeassistant.loader as loader + loader.get_component('persistent_notification').create( + hass, 'Error: Failed to set up QNAP sensor.
' + 'Check the logs for additional information. ' + 'You will need to restart hass after fixing.', + title=NOTIFICATION_TITLE, + notification_id=NOTIFICATION_ID) + return False + sensors = [] # Basic sensors for variable in config[CONF_MONITORED_CONDITIONS]: - if variable in _HEALTH_MON_COND: - sensors.append(QNAPHealthStatus(api, variable, - _HEALTH_MON_COND[variable])) + if variable in _SYSTEM_MON_COND: + sensors.append(QNAPSystemSensor(api, variable, + _SYSTEM_MON_COND[variable])) if variable in _CPU_MON_COND: sensors.append(QNAPCPUSensor(api, variable, _CPU_MON_COND[variable])) @@ -177,7 +193,8 @@ class QNAPStatsAPI(object): config.get(CONF_PORT), config.get(CONF_USERNAME), config.get(CONF_PASSWORD), - verify_ssl=config.get(CONF_VERIFY_SSL) + verify_ssl=config.get(CONF_VERIFY_SSL), + timeout=config.get(CONF_TIMEOUT), ) self.data = {} @@ -311,13 +328,17 @@ class QNAPNetworkSensor(QNAPSensor): } -class QNAPHealthStatus(QNAPSensor): +class QNAPSystemSensor(QNAPSensor): """A QNAP sensor that monitors overall system health.""" @property def state(self): """Return the state of the sensor.""" - return self._api.data["system_health"] + if self.var_id == "status": + return self._api.data["system_health"] + + if self.var_id == "system_temp": + return int(self._api.data["system_stats"]["system"]["temp_c"]) @property def device_state_attributes(self): diff --git a/requirements_all.txt b/requirements_all.txt index 938d4b6943f..4577801a07d 100755 --- a/requirements_all.txt +++ b/requirements_all.txt @@ -620,7 +620,7 @@ pywemo==0.4.13 pyzabbix==0.7.4 # homeassistant.components.sensor.qnap -qnapstats==0.2.2 +qnapstats==0.2.3 # homeassistant.components.climate.radiotherm radiotherm==1.2