From f071e3b4ac554524a0fa91aad5574ef0522d5cd8 Mon Sep 17 00:00:00 2001 From: happyleaves Date: Fri, 18 Dec 2015 23:55:37 -0500 Subject: [PATCH 1/2] torque support --- .coveragerc | 1 + homeassistant/components/sensor/torque.py | 118 ++++++++++++++++++++++ 2 files changed, 119 insertions(+) create mode 100644 homeassistant/components/sensor/torque.py diff --git a/.coveragerc b/.coveragerc index d39169439d6..a1123c12be3 100644 --- a/.coveragerc +++ b/.coveragerc @@ -101,6 +101,7 @@ omit = homeassistant/components/sensor/systemmonitor.py homeassistant/components/sensor/temper.py homeassistant/components/sensor/time_date.py + homeassistant/components/sensor/torque.py homeassistant/components/sensor/transmission.py homeassistant/components/sensor/twitch.py homeassistant/components/sensor/worldclock.py diff --git a/homeassistant/components/sensor/torque.py b/homeassistant/components/sensor/torque.py new file mode 100644 index 00000000000..11ccba6ca1f --- /dev/null +++ b/homeassistant/components/sensor/torque.py @@ -0,0 +1,118 @@ +""" +homeassistant.components.sensor.torque +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Get data from the Torque OBD application. + +For more details about this platform, please refer to the documentation at +https://home-assistant.io/components/sensor.torque/ +""" + +import re +from homeassistant.helpers.entity import Entity + + +DOMAIN = 'torque' +DEPENDENCIES = ['http'] +SENSOR_EMAIL_FIELD = 'eml' +DEFAULT_NAME = 'vehicle' +HTTP_RESPONSE = 'OK' +HTTP_VERB = 'GET' +ENTITY_NAME_FORMAT = '{0} {1}' + +API_PATH = r'/api/torque' +SENSOR_NAME_KEY = r'userFullName(\w+)' +SENSOR_UNIT_KEY = r'userUnit(\w+)' +SENSOR_VALUE_KEY = r'k(\w+)' + +PATH_MATCH = re.compile(API_PATH) +NAME_KEY = re.compile(SENSOR_NAME_KEY) +UNIT_KEY = re.compile(SENSOR_UNIT_KEY) +VALUE_KEY = re.compile(SENSOR_VALUE_KEY) + + +def decode(value): + """ Double-decode required. """ + return value.encode('raw_unicode_escape').decode('utf-8') + + +def convert_pid(value): + """ Convert pid from hex string to integer. """ + return int(value, 16) + + +# pylint: disable=unused-argument +def setup_platform(hass, config, add_devices, discovery_info=None): + """ Set up Torque platform. """ + + vehicle = config.get('name', DEFAULT_NAME) + email = config.get('email', None) + sensors = {} + + def _receive_data(handler, path_match, data): + """ Received data from Torque. """ + handler.write_json_message(HTTP_RESPONSE) + + if email is not None and email != data[SENSOR_EMAIL_FIELD]: + return + + names = {} + units = {} + for key in data: + is_name = NAME_KEY.match(key) + is_unit = UNIT_KEY.match(key) + is_value = VALUE_KEY.match(key) + + if is_name: + pid = convert_pid(is_name.group(1)) + names[pid] = decode(data[key]) + elif is_unit: + pid = convert_pid(is_unit.group(1)) + units[pid] = decode(data[key]) + elif is_value: + pid = convert_pid(is_value.group(1)) + if pid in sensors: + sensors[pid].on_update(data[key]) + + for pid in names: + if pid not in sensors: + sensors[pid] = TorqueSensor( + ENTITY_NAME_FORMAT.format(vehicle, names[pid]), + units.get(pid, None)) + add_devices([sensors[pid]]) + + hass.http.register_path(HTTP_VERB, PATH_MATCH, _receive_data) + return True + + +class TorqueSensor(Entity): + """ Represents a Torque sensor. """ + + def __init__(self, name, unit): + self._name = name + self._unit = unit + self._state = None + + @property + def name(self): + """ Returns the name of the sensor. """ + return self._name + + @property + def unit_of_measurement(self): + """ Returns the unit of measurement. """ + return self._unit + + @property + def state(self): + """ State of the sensor. """ + return self._state + + @property + def icon(self): + """ Sensor default icon. """ + return 'mdi:car' + + def on_update(self, value): + """ Receive an update. """ + self._state = value + self.update_ha_state() From 04316d9723db32dc6ac750c7edb8991dbc3e6cad Mon Sep 17 00:00:00 2001 From: happyleaves Date: Sun, 20 Dec 2015 11:20:40 -0500 Subject: [PATCH 2/2] http fixes --- homeassistant/components/sensor/torque.py | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/homeassistant/components/sensor/torque.py b/homeassistant/components/sensor/torque.py index 11ccba6ca1f..e123aa2d18c 100644 --- a/homeassistant/components/sensor/torque.py +++ b/homeassistant/components/sensor/torque.py @@ -8,6 +8,7 @@ https://home-assistant.io/components/sensor.torque/ """ import re +from homeassistant.const import HTTP_OK from homeassistant.helpers.entity import Entity @@ -15,16 +16,13 @@ DOMAIN = 'torque' DEPENDENCIES = ['http'] SENSOR_EMAIL_FIELD = 'eml' DEFAULT_NAME = 'vehicle' -HTTP_RESPONSE = 'OK' -HTTP_VERB = 'GET' ENTITY_NAME_FORMAT = '{0} {1}' -API_PATH = r'/api/torque' +API_PATH = '/api/torque' SENSOR_NAME_KEY = r'userFullName(\w+)' SENSOR_UNIT_KEY = r'userUnit(\w+)' SENSOR_VALUE_KEY = r'k(\w+)' -PATH_MATCH = re.compile(API_PATH) NAME_KEY = re.compile(SENSOR_NAME_KEY) UNIT_KEY = re.compile(SENSOR_UNIT_KEY) VALUE_KEY = re.compile(SENSOR_VALUE_KEY) @@ -50,7 +48,8 @@ def setup_platform(hass, config, add_devices, discovery_info=None): def _receive_data(handler, path_match, data): """ Received data from Torque. """ - handler.write_json_message(HTTP_RESPONSE) + handler.send_response(HTTP_OK) + handler.end_headers() if email is not None and email != data[SENSOR_EMAIL_FIELD]: return @@ -80,7 +79,7 @@ def setup_platform(hass, config, add_devices, discovery_info=None): units.get(pid, None)) add_devices([sensors[pid]]) - hass.http.register_path(HTTP_VERB, PATH_MATCH, _receive_data) + hass.http.register_path('GET', API_PATH, _receive_data) return True