Speedtest.net component
This commit is contained in:
parent
6149e509c3
commit
d469970e5a
2 changed files with 109 additions and 0 deletions
106
homeassistant/components/sensor/speedtest.py
Normal file
106
homeassistant/components/sensor/speedtest.py
Normal file
|
@ -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)}
|
||||
|
|
@ -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
|
||||
|
|
Loading…
Add table
Reference in a new issue