From d469970e5a4d7b8ab330eed8be4550afdeebb75d Mon Sep 17 00:00:00 2001 From: "nkgilley@gmail.com" Date: Thu, 4 Feb 2016 18:21:37 -0500 Subject: [PATCH 1/8] Speedtest.net component --- homeassistant/components/sensor/speedtest.py | 106 +++++++++++++++++++ requirements_all.txt | 3 + 2 files changed, 109 insertions(+) create mode 100644 homeassistant/components/sensor/speedtest.py diff --git a/homeassistant/components/sensor/speedtest.py b/homeassistant/components/sensor/speedtest.py new file mode 100644 index 00000000000..b67f15a5b18 --- /dev/null +++ b/homeassistant/components/sensor/speedtest.py @@ -0,0 +1,106 @@ +""" +homeassistant.components.sensor.speedtest +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Speedtest.net sensor based on speedtest-cli. + +For more details about this platform, please refer to the documentation at +https://home-assistant.io/components/sensor.speedtest/ +""" +import logging +import sys +import re +from datetime import timedelta +from subprocess import check_output +from homeassistant.util import Throttle +from homeassistant.helpers.entity import Entity + +REQUIREMENTS = ['speedtest-cli==0.3.4'] +_LOGGER = logging.getLogger(__name__) + +_SPEEDTEST_REGEX = re.compile('Ping:\s(\d+\.\d+)\sms\\nDownload:\s(\d+\.\d+)' + '\sMbit/s\\nUpload:\s(\d+\.\d+)\sMbit/s\\n') + +SENSOR_TYPES = { + 'ping': ['Ping', 'ms'], + 'download': ['Download', 'Mbit/s'], + 'upload': ['Upload', 'Mbit/s'], +} + +# Return cached results if last scan was less then this time ago +MIN_TIME_BETWEEN_UPDATES = timedelta(hours=1) + + +def setup_platform(hass, config, add_devices, discovery_info=None): + """ Setup the Speedtest sensor. """ + + data = SpeedtestData(hass.config.path) + + dev = [] + for variable in config['monitored_conditions']: + if variable not in SENSOR_TYPES: + _LOGGER.error('Sensor type: "%s" does not exist', variable) + else: + dev.append(SpeedtestSensor(data, variable)) + + add_devices(dev) + + +# pylint: disable=too-few-public-methods +class SpeedtestSensor(Entity): + """ Implements a speedtest.net sensor. """ + + def __init__(self, speedtest_data, sensor_type): + self.client_name = 'Speedtest' + self._name = SENSOR_TYPES[sensor_type][0] + self.speedtest_client = speedtest_data + self.type = sensor_type + self._state = None + self._unit_of_measurement = SENSOR_TYPES[self.type][1] + self.update() + + @property + def name(self): + return '{} {}'.format(self.client_name, self._name) + + @property + def state(self): + """ Returns the state of the device. """ + return self._state + + @property + def unit_of_measurement(self): + """ Unit of measurement of this entity, if any. """ + return self._unit_of_measurement + + def update(self): + """ Gets the latest data from Forecast.io and updates the states. """ + self.speedtest_client.update() + data = self.speedtest_client.data + + if self.type == 'ping': + self._state = data['ping'] + elif self.type == 'download': + self._state = data['download'] + elif self.type == 'upload': + self._state = data['upload'] + + +class SpeedtestData(object): + """ Gets the latest data from speedtest.net. """ + + def __init__(self, path): + self.data = None + self.path = path + self.update() + + @Throttle(MIN_TIME_BETWEEN_UPDATES) + def update(self): + """ Gets the latest data from speedtest.net. """ + _LOGGER.info('Executing speedtest') + re_output = _SPEEDTEST_REGEX.split( + check_output([sys.executable, self.path( + 'lib', 'speedtest_cli.py'), '--simple']).decode("utf-8")) + self.data = {'ping': round(float(re_output[1]), 2), + 'download': round(float(re_output[2]), 2), + 'upload': round(float(re_output[3]), 2)} + diff --git a/requirements_all.txt b/requirements_all.txt index 9e0e159a1d2..90fcc53ce8f 100644 --- a/requirements_all.txt +++ b/requirements_all.txt @@ -216,6 +216,9 @@ slacker==0.6.8 # homeassistant.components.notify.xmpp sleekxmpp==1.3.1 +# homeassistant.components.sensor.speedtest +speedtest-cli==0.3.4 + # homeassistant.components.light.tellstick # homeassistant.components.sensor.tellstick # homeassistant.components.switch.tellstick From 19fc48f4a0aae6abb0d5c064ae9ddc65bd20a13e Mon Sep 17 00:00:00 2001 From: "nkgilley@gmail.com" Date: Thu, 4 Feb 2016 18:39:09 -0500 Subject: [PATCH 2/8] use raw regex --- homeassistant/components/sensor/speedtest.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/homeassistant/components/sensor/speedtest.py b/homeassistant/components/sensor/speedtest.py index b67f15a5b18..5de103c5e41 100644 --- a/homeassistant/components/sensor/speedtest.py +++ b/homeassistant/components/sensor/speedtest.py @@ -17,8 +17,10 @@ from homeassistant.helpers.entity import Entity REQUIREMENTS = ['speedtest-cli==0.3.4'] _LOGGER = logging.getLogger(__name__) -_SPEEDTEST_REGEX = re.compile('Ping:\s(\d+\.\d+)\sms\\nDownload:\s(\d+\.\d+)' - '\sMbit/s\\nUpload:\s(\d+\.\d+)\sMbit/s\\n') +# _SPEEDTEST_REGEX = re.compile('Ping:\s(\d+\.\d+)\sms\\nDownload:\s(\d+\.\d+)' +# '\sMbit/s\\nUpload:\s(\d+\.\d+)\sMbit/s\\n') +_SPEEDTEST_REGEX = re.compile(r'Ping:\s(\d+\.\d+)\sms\nDownload:\s(\d+\.\d+)' + r'\sMbit/s\nUpload:\s(\d+\.\d+)\sMbit/s\n') SENSOR_TYPES = { 'ping': ['Ping', 'ms'], @@ -103,4 +105,3 @@ class SpeedtestData(object): self.data = {'ping': round(float(re_output[1]), 2), 'download': round(float(re_output[2]), 2), 'upload': round(float(re_output[3]), 2)} - From 78e758925bff73e52867b671b246a391f87cf945 Mon Sep 17 00:00:00 2001 From: "nkgilley@gmail.com" Date: Thu, 4 Feb 2016 18:42:38 -0500 Subject: [PATCH 3/8] remove commented lines. --- homeassistant/components/sensor/speedtest.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/homeassistant/components/sensor/speedtest.py b/homeassistant/components/sensor/speedtest.py index 5de103c5e41..f7c47b124cf 100644 --- a/homeassistant/components/sensor/speedtest.py +++ b/homeassistant/components/sensor/speedtest.py @@ -17,8 +17,6 @@ from homeassistant.helpers.entity import Entity REQUIREMENTS = ['speedtest-cli==0.3.4'] _LOGGER = logging.getLogger(__name__) -# _SPEEDTEST_REGEX = re.compile('Ping:\s(\d+\.\d+)\sms\\nDownload:\s(\d+\.\d+)' -# '\sMbit/s\\nUpload:\s(\d+\.\d+)\sMbit/s\\n') _SPEEDTEST_REGEX = re.compile(r'Ping:\s(\d+\.\d+)\sms\nDownload:\s(\d+\.\d+)' r'\sMbit/s\nUpload:\s(\d+\.\d+)\sMbit/s\n') From e837e97c9d63c47652b7f7fad432a1f9c9705bcc Mon Sep 17 00:00:00 2001 From: "nkgilley@gmail.com" Date: Thu, 11 Feb 2016 19:09:51 -0500 Subject: [PATCH 4/8] use track_time_change --- homeassistant/components/sensor/speedtest.py | 49 +++++++++++--------- 1 file changed, 28 insertions(+), 21 deletions(-) diff --git a/homeassistant/components/sensor/speedtest.py b/homeassistant/components/sensor/speedtest.py index f7c47b124cf..d79e35c68d8 100644 --- a/homeassistant/components/sensor/speedtest.py +++ b/homeassistant/components/sensor/speedtest.py @@ -13,6 +13,7 @@ from datetime import timedelta from subprocess import check_output from homeassistant.util import Throttle from homeassistant.helpers.entity import Entity +from homeassistant.helpers import event REQUIREMENTS = ['speedtest-cli==0.3.4'] _LOGGER = logging.getLogger(__name__) @@ -20,6 +21,10 @@ _LOGGER = logging.getLogger(__name__) _SPEEDTEST_REGEX = re.compile(r'Ping:\s(\d+\.\d+)\sms\nDownload:\s(\d+\.\d+)' r'\sMbit/s\nUpload:\s(\d+\.\d+)\sMbit/s\n') +CONF_MONITORED_CONDITIONS = 'monitored_conditions' +CONF_MINUTE = 'minute' +CONF_HOUR = 'hour' +CONF_DAY = 'day' SENSOR_TYPES = { 'ping': ['Ping', 'ms'], 'download': ['Download', 'Mbit/s'], @@ -27,20 +32,20 @@ SENSOR_TYPES = { } # Return cached results if last scan was less then this time ago -MIN_TIME_BETWEEN_UPDATES = timedelta(hours=1) +MIN_TIME_BETWEEN_UPDATES = timedelta(minutes=1) def setup_platform(hass, config, add_devices, discovery_info=None): """ Setup the Speedtest sensor. """ - data = SpeedtestData(hass.config.path) + data = SpeedtestData(hass, event, config) dev = [] - for variable in config['monitored_conditions']: - if variable not in SENSOR_TYPES: - _LOGGER.error('Sensor type: "%s" does not exist', variable) + for sensor in config[CONF_MONITORED_CONDITIONS]: + if sensor not in SENSOR_TYPES: + _LOGGER.error('Sensor type: "%s" does not exist', sensor) else: - dev.append(SpeedtestSensor(data, variable)) + dev.append(SpeedtestSensor(data, sensor)) add_devices(dev) @@ -50,17 +55,15 @@ class SpeedtestSensor(Entity): """ Implements a speedtest.net sensor. """ def __init__(self, speedtest_data, sensor_type): - self.client_name = 'Speedtest' self._name = SENSOR_TYPES[sensor_type][0] self.speedtest_client = speedtest_data self.type = sensor_type self._state = None self._unit_of_measurement = SENSOR_TYPES[self.type][1] - self.update() @property def name(self): - return '{} {}'.format(self.client_name, self._name) + return '{} {}'.format('Speedtest', self._name) @property def state(self): @@ -74,27 +77,31 @@ class SpeedtestSensor(Entity): def update(self): """ Gets the latest data from Forecast.io and updates the states. """ - self.speedtest_client.update() data = self.speedtest_client.data - - if self.type == 'ping': - self._state = data['ping'] - elif self.type == 'download': - self._state = data['download'] - elif self.type == 'upload': - self._state = data['upload'] + if data is not None: + if self.type == 'ping': + self._state = data['ping'] + elif self.type == 'download': + self._state = data['download'] + elif self.type == 'upload': + self._state = data['upload'] class SpeedtestData(object): """ Gets the latest data from speedtest.net. """ - def __init__(self, path): + def __init__(self, hass, event, config): self.data = None - self.path = path - self.update() + self.hass = hass + self.path = hass.config.path + self.event = event + self.event.track_time_change(self.hass, self.update, + minute=config.get(CONF_MINUTE, 0), + hour=config.get(CONF_HOUR, None), + day=config.get(CONF_DAY, None)) @Throttle(MIN_TIME_BETWEEN_UPDATES) - def update(self): + def update(self, event=None): """ Gets the latest data from speedtest.net. """ _LOGGER.info('Executing speedtest') re_output = _SPEEDTEST_REGEX.split( From b00cad70954f8622c5eff18ce23a5159e4f83b75 Mon Sep 17 00:00:00 2001 From: "nkgilley@gmail.com" Date: Thu, 11 Feb 2016 19:27:05 -0500 Subject: [PATCH 5/8] fix travisci errors. --- homeassistant/components/sensor/speedtest.py | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/homeassistant/components/sensor/speedtest.py b/homeassistant/components/sensor/speedtest.py index d79e35c68d8..0558e67f598 100644 --- a/homeassistant/components/sensor/speedtest.py +++ b/homeassistant/components/sensor/speedtest.py @@ -13,7 +13,7 @@ from datetime import timedelta from subprocess import check_output from homeassistant.util import Throttle from homeassistant.helpers.entity import Entity -from homeassistant.helpers import event +from homeassistant.helpers.event import track_time_change REQUIREMENTS = ['speedtest-cli==0.3.4'] _LOGGER = logging.getLogger(__name__) @@ -38,7 +38,7 @@ MIN_TIME_BETWEEN_UPDATES = timedelta(minutes=1) def setup_platform(hass, config, add_devices, discovery_info=None): """ Setup the Speedtest sensor. """ - data = SpeedtestData(hass, event, config) + data = SpeedtestData(hass, config) dev = [] for sensor in config[CONF_MONITORED_CONDITIONS]: @@ -90,18 +90,17 @@ class SpeedtestSensor(Entity): class SpeedtestData(object): """ Gets the latest data from speedtest.net. """ - def __init__(self, hass, event, config): + def __init__(self, hass, config): self.data = None self.hass = hass self.path = hass.config.path - self.event = event - self.event.track_time_change(self.hass, self.update, - minute=config.get(CONF_MINUTE, 0), - hour=config.get(CONF_HOUR, None), - day=config.get(CONF_DAY, None)) + track_time_change(self.hass, self.update, + minute=config.get(CONF_MINUTE, 0), + hour=config.get(CONF_HOUR, None), + day=config.get(CONF_DAY, None)) @Throttle(MIN_TIME_BETWEEN_UPDATES) - def update(self, event=None): + def update(self, now): """ Gets the latest data from speedtest.net. """ _LOGGER.info('Executing speedtest') re_output = _SPEEDTEST_REGEX.split( From 88fe28ea1bca1f0f0784828592c2414e85e5ceb9 Mon Sep 17 00:00:00 2001 From: "nkgilley@gmail.com" Date: Fri, 12 Feb 2016 09:55:28 -0500 Subject: [PATCH 6/8] add update service --- homeassistant/components/sensor/speedtest.py | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/homeassistant/components/sensor/speedtest.py b/homeassistant/components/sensor/speedtest.py index 0558e67f598..0e47aa38154 100644 --- a/homeassistant/components/sensor/speedtest.py +++ b/homeassistant/components/sensor/speedtest.py @@ -14,6 +14,8 @@ from subprocess import check_output from homeassistant.util import Throttle from homeassistant.helpers.entity import Entity from homeassistant.helpers.event import track_time_change +from homeassistant.components.sensor import DOMAIN +import homeassistant.util.dt as dt_util REQUIREMENTS = ['speedtest-cli==0.3.4'] _LOGGER = logging.getLogger(__name__) @@ -39,7 +41,6 @@ def setup_platform(hass, config, add_devices, discovery_info=None): """ Setup the Speedtest sensor. """ data = SpeedtestData(hass, config) - dev = [] for sensor in config[CONF_MONITORED_CONDITIONS]: if sensor not in SENSOR_TYPES: @@ -49,6 +50,14 @@ def setup_platform(hass, config, add_devices, discovery_info=None): add_devices(dev) + def update(call=None): + """ Update service for manual updates. """ + data.update(dt_util.now()) + for sensor in dev: + sensor.update() + + hass.services.register(DOMAIN, 'update_speedtest', update) + # pylint: disable=too-few-public-methods class SpeedtestSensor(Entity): From 3e3f5db2a5d33241c709c8856f2ceee041978c2c Mon Sep 17 00:00:00 2001 From: "nkgilley@gmail.com" Date: Fri, 12 Feb 2016 11:30:55 -0500 Subject: [PATCH 7/8] use a windows & linux compatible regex --- homeassistant/components/sensor/speedtest.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/homeassistant/components/sensor/speedtest.py b/homeassistant/components/sensor/speedtest.py index 0e47aa38154..e6c213e6850 100644 --- a/homeassistant/components/sensor/speedtest.py +++ b/homeassistant/components/sensor/speedtest.py @@ -20,8 +20,8 @@ import homeassistant.util.dt as dt_util REQUIREMENTS = ['speedtest-cli==0.3.4'] _LOGGER = logging.getLogger(__name__) -_SPEEDTEST_REGEX = re.compile(r'Ping:\s(\d+\.\d+)\sms\nDownload:\s(\d+\.\d+)' - r'\sMbit/s\nUpload:\s(\d+\.\d+)\sMbit/s\n') +_SPEEDTEST_REGEX = re.compile(r'Ping:\s(\d+\.\d+)\sms[\r\n]+Download:\s(\d+\.\d+)' + r'\sMbit/s[\r\n]+Upload:\s(\d+\.\d+)\sMbit/s[\r\n]+') CONF_MONITORED_CONDITIONS = 'monitored_conditions' CONF_MINUTE = 'minute' From 7cb57583e2cdb7a6eef34df429c50806393d6d27 Mon Sep 17 00:00:00 2001 From: "nkgilley@gmail.com" Date: Fri, 12 Feb 2016 11:44:24 -0500 Subject: [PATCH 8/8] fix line too long --- homeassistant/components/sensor/speedtest.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/homeassistant/components/sensor/speedtest.py b/homeassistant/components/sensor/speedtest.py index e6c213e6850..7bb3c77ed09 100644 --- a/homeassistant/components/sensor/speedtest.py +++ b/homeassistant/components/sensor/speedtest.py @@ -20,8 +20,9 @@ import homeassistant.util.dt as dt_util REQUIREMENTS = ['speedtest-cli==0.3.4'] _LOGGER = logging.getLogger(__name__) -_SPEEDTEST_REGEX = re.compile(r'Ping:\s(\d+\.\d+)\sms[\r\n]+Download:\s(\d+\.\d+)' - r'\sMbit/s[\r\n]+Upload:\s(\d+\.\d+)\sMbit/s[\r\n]+') +_SPEEDTEST_REGEX = re.compile(r'Ping:\s(\d+\.\d+)\sms[\r\n]+' + r'Download:\s(\d+\.\d+)\sMbit/s[\r\n]+' + r'Upload:\s(\d+\.\d+)\sMbit/s[\r\n]+') CONF_MONITORED_CONDITIONS = 'monitored_conditions' CONF_MINUTE = 'minute'