/
sensor.py
451 lines (397 loc) · 19.1 KB
/
sensor.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
"""
Support for OWL Intuition Network.
For more details about this platform, please refer to the documentation at
https://github.com/custom-components/sensor.owlintuition/blob/master/sensor.owlintuition.markdown
"""
import asyncio
import socket
from xml.etree import ElementTree as ET
from datetime import timedelta
from select import select
from functools import reduce
import logging
import voluptuous as vol
from homeassistant.components.sensor import PLATFORM_SCHEMA
from homeassistant.const import (CONF_NAME, CONF_PORT,
CONF_MONITORED_CONDITIONS, CONF_MODE, CONF_HOST,
ATTR_ATTRIBUTION)
from homeassistant.exceptions import TemplateError
from homeassistant.helpers.entity import Entity
import homeassistant.helpers.config_validation as cv
from homeassistant.util import Throttle
VERSION = '1.4.0'
_LOGGER = logging.getLogger(__name__)
DEFAULT_NAME = 'OWL Intuition'
MODE_MONO = 'monophase'
MODE_TRI = 'triphase'
CONF_COST_UNIT_OF_MEASUREMENT = 'cost_unit_of_measurement'
CONF_COST_ICON = 'cost_icon'
SENSOR_ELECTRICITY_BATTERY = 'electricity_battery'
SENSOR_ELECTRICITY_BATTERY_LVL = 'electricity_battery_lvl'
SENSOR_ELECTRICITY_RADIO = 'electricity_radio'
SENSOR_ELECTRICITY_POWER = 'electricity_power'
SENSOR_ELECTRICITY_ENERGY_TODAY = 'electricity_energy_today'
SENSOR_ELECTRICITY_COST_TODAY = 'electricity_cost_today'
SENSOR_ELECTRICITY_LAST_UPDATE = 'electricity_last_update'
SENSOR_SOLAR_GPOWER = 'solargen'
SENSOR_SOLAR_GENERGY_TODAY = 'solargen_today'
SENSOR_SOLAR_EPOWER = 'solarexp'
SENSOR_SOLAR_EENERGY_TODAY = 'solarexp_today'
SENSOR_HOTWATER_BATTERY = 'hotwater_battery'
SENSOR_HOTWATER_BATTERY_LVL = 'hotwater_battery_lvl'
SENSOR_HOTWATER_RADIO = 'hotwater_radio'
SENSOR_HOTWATER_CURRENT = 'hotwater_current'
SENSOR_HOTWATER_REQUIRED = 'hotwater_required'
SENSOR_HOTWATER_AMBIENT = 'hotwater_ambient'
SENSOR_HOTWATER_STATE = 'hotwater_state'
SENSOR_HEATING_BATTERY = 'heating_battery'
SENSOR_HEATING_BATTERY_LVL = 'heating_battery_lvl'
SENSOR_HEATING_RADIO = 'heating_radio'
SENSOR_HEATING_CURRENT = 'heating_current'
SENSOR_HEATING_REQUIRED = 'heating_required'
SENSOR_HEATING_STATE = 'heating_state'
SENSOR_RELAYS_RADIO = 'relays_radio'
ATTR_LAST_UPDATE = 'last_update'
#
# Sensors selected by defining which classes to monitor
#
OWLCLASS_WEATHER = 'weather'
OWLCLASS_ELECTRICITY = 'electricity'
OWLCLASS_SOLAR = 'solar'
OWLCLASS_HOTWATER = 'hot_water'
OWLCLASS_HEATING = 'heating'
OWLCLASS_RELAYS = 'relays'
OWL_CLASSES = [ OWLCLASS_WEATHER,
OWLCLASS_ELECTRICITY,
OWLCLASS_SOLAR,
OWLCLASS_HOTWATER,
OWLCLASS_HEATING,
OWLCLASS_RELAYS ]
BATTERY_SENSORS = [ SENSOR_ELECTRICITY_BATTERY,
SENSOR_HOTWATER_BATTERY,
SENSOR_HEATING_BATTERY ]
RADIO_SENSORS = [ SENSOR_ELECTRICITY_RADIO,
SENSOR_HOTWATER_RADIO,
SENSOR_HEATING_RADIO,
SENSOR_RELAYS_RADIO ]
SENSOR_TYPES = {
SENSOR_ELECTRICITY_BATTERY: ['Electricity Battery', None, 'mdi:battery', OWLCLASS_ELECTRICITY],
SENSOR_ELECTRICITY_BATTERY_LVL: ['Electricity Battery Level', None, 'mdi:battery', OWLCLASS_ELECTRICITY],
SENSOR_ELECTRICITY_RADIO: ['Electricity Radio', 'dBm', 'mdi:signal', OWLCLASS_ELECTRICITY],
SENSOR_ELECTRICITY_POWER: ['Electricity Power', 'W', 'mdi:flash', OWLCLASS_ELECTRICITY],
SENSOR_ELECTRICITY_ENERGY_TODAY: ['Electricity Today', 'kWh', 'mdi:flash', OWLCLASS_ELECTRICITY],
SENSOR_ELECTRICITY_COST_TODAY: ['Cost Today', None, 'mdi:coin', OWLCLASS_ELECTRICITY],
SENSOR_SOLAR_GPOWER: ['Solar Generating', 'W', 'mdi:flash', OWLCLASS_SOLAR],
SENSOR_SOLAR_GENERGY_TODAY: ['Solar Generated Today', 'kWh', 'mdi:flash', OWLCLASS_SOLAR],
SENSOR_SOLAR_EPOWER: ['Solar Exporting', 'W', 'mdi:flash', OWLCLASS_SOLAR],
SENSOR_SOLAR_EENERGY_TODAY: ['Solar Exported Today', 'kWh', 'mdi:flash', OWLCLASS_SOLAR],
SENSOR_HOTWATER_BATTERY: ['Hotwater Battery', None, 'mdi:battery', OWLCLASS_HOTWATER],
SENSOR_HOTWATER_BATTERY_LVL: ['Hotwater Battery Level', 'V', 'mdi:battery', OWLCLASS_HOTWATER],
SENSOR_HOTWATER_RADIO: ['Hotwater Radio', 'dBm', 'mdi:signal', OWLCLASS_HOTWATER],
SENSOR_HOTWATER_CURRENT: ['Hotwater Temperature', '°C', 'mdi:thermometer', OWLCLASS_HOTWATER],
SENSOR_HOTWATER_REQUIRED: ['Hotwater Required', '°C', 'mdi:thermostat', OWLCLASS_HOTWATER],
SENSOR_HOTWATER_AMBIENT: ['Hotwater Ambient', '°C', 'mdi:thermometer', OWLCLASS_HOTWATER],
SENSOR_HOTWATER_STATE: ['Hotwater State', '', 'mdi:information-outline', OWLCLASS_HOTWATER],
SENSOR_HEATING_BATTERY: ['Heating Battery', None, 'mdi:battery', OWLCLASS_HEATING],
SENSOR_HEATING_BATTERY_LVL: ['Heating Battery Level', 'V', 'mdi:battery', OWLCLASS_HEATING],
SENSOR_HEATING_RADIO: ['Heating Radio', 'dBm', 'mdi:signal', OWLCLASS_HEATING],
SENSOR_HEATING_CURRENT: ['Heating Temperature', '°C', 'mdi:thermometer', OWLCLASS_HEATING],
SENSOR_HEATING_REQUIRED: ['Heating Required', '°C', 'mdi:thermostat', OWLCLASS_HEATING],
SENSOR_HEATING_STATE: ['Heating State', None, 'mdi:information-outline', OWLCLASS_HEATING],
SENSOR_RELAYS_RADIO: ['Relays Radio', 'dBm', 'mdi:signal', OWLCLASS_RELAYS],
}
HEATING_STATE = [ 'Standby', # 0
'Comfort (Running)', # 1
'', # 2
'', # 3
'Comfort (Up To Temperature)', # 4
'Comfort (Warm Up)', # 5
'Comfort (Cool Down)', # 6
'Standby (Running)'] # 7
HOTWATER_STATE = [ 'Standby', # 0
'Running', # 1
'', # 2
'', # 3
'Up To Temperature', # 4
'Warm Up', # 5
'Cool Down', # 6
'Standby (Running)' ] # 7
DEFAULT_MONITORED = [ OWLCLASS_ELECTRICITY ]
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
vol.Required(CONF_PORT): cv.port,
vol.Optional(CONF_HOST, default='localhost'): cv.string,
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
vol.Optional(CONF_MODE, default=MODE_MONO):
vol.In([MODE_MONO, MODE_TRI]),
vol.Optional(CONF_MONITORED_CONDITIONS, default=DEFAULT_MONITORED):
vol.All(cv.ensure_list, [vol.In(OWL_CLASSES)]),
vol.Optional(CONF_COST_ICON, default='mdi:coin'): cv.string,
vol.Optional(CONF_COST_UNIT_OF_MEASUREMENT): cv.string,
})
SOCK_TIMEOUT = 60
@asyncio.coroutine
def async_setup_platform(hass, config, async_add_devices, discovery_info=None):
"""Set up the OWL Intuition Sensors."""
hostname = config.get(CONF_HOST)
if hostname == 'localhost':
# Perform a reverse lookup to make sure we listen to the correct IP
hostname = socket.gethostbyname(socket.getfqdn())
# Try and estimate an appropriate refresh interval, assuming each module
# is refreshed every 60 seconds.
# All of this won't be needed with an async listener...
try:
secs = 60/len(config.get(CONF_MONITORED_CONDITIONS))
except ZeroDivisionError:
secs = 60
owldata = OwlData((hostname, config.get(CONF_PORT)), \
timedelta(seconds=(secs)))
# Ideally an async listener loop as follows would be a better solution,
# but it crashes HA!
#owljob = hass.loop.create_datagram_endpoint(
# lambda: OwlStateUpdater(hass.loop), \
# local_addr=(hostname, config.get(CONF_PORT)))
#hass.async_add_job(owljob)
# initialize cost sensor unit of measurement and icon
SENSOR_TYPES[SENSOR_ELECTRICITY_COST_TODAY][1] = \
config.get(CONF_COST_UNIT_OF_MEASUREMENT)
SENSOR_TYPES[SENSOR_ELECTRICITY_COST_TODAY][2] = \
config.get(CONF_COST_ICON)
dev = []
# Iterate through the possible sensors and add if class is monitored
for sensor in SENSOR_TYPES:
if SENSOR_TYPES[sensor][3] in config.get(CONF_MONITORED_CONDITIONS):
dev.append(OwlIntuitionSensor(owldata, config.get(CONF_NAME), sensor))
_LOGGER.debug("Adding sensor %s", sensor)
# In case of electricity sensors, handle triphase mode
if config.get(CONF_MODE) == MODE_TRI and \
OWLCLASS_ELECTRICITY in config.get(CONF_MONITORED_CONDITIONS):
for phase in range(1, 4):
dev.append(OwlIntuitionSensor(owldata, config.get(CONF_NAME),
SENSOR_ELECTRICITY_POWER, phase))
dev.append(OwlIntuitionSensor(owldata, config.get(CONF_NAME),
SENSOR_ELECTRICITY_ENERGY_TODAY, phase))
async_add_devices(dev, True)
class OwlData:
"""A class to retrieve data from the OWL station via UDP.
The callback method can be used by an event loop in a thread-safe way
when new data is received. However, async loops crash HA!
The update() method is instead fully synchronous.
"""
def __init__(self, localaddr, refreshinterval):
"""Prepare an empty dictionary"""
self.data = {}
self._localaddr = localaddr
self.update = Throttle(refreshinterval)(self._update)
def _update(self):
"""Retrieve the latest data by listening to the periodic UDP message"""
with socket.socket(socket.AF_INET, socket.SOCK_DGRAM) as sock:
sock.settimeout(SOCK_TIMEOUT)
try:
sock.bind(self._localaddr)
except socket.error as se:
_LOGGER.error("Unable to bind: %s", se)
return
readable, _, _ = select([sock], [], [], SOCK_TIMEOUT)
if not readable:
_LOGGER.warning(
"Timeout (%s seconds) waiting for data on port %s",
SOCK_TIMEOUT, self._localaddr[1])
return
data, _ = sock.recvfrom(1024)
self.on_data_received(data.decode('utf-8'))
def on_data_received(self, xmldata):
"""Callback when new data is received: store it in the dict"""
try:
xml = ET.fromstring(xmldata)
self.data[xml.tag] = xml
_LOGGER.debug("Datagram received for type %s", xml.tag)
except ET.ParseError as pe:
_LOGGER.error("Unable to parse received data: %s", pe)
def get(self, owlclass):
"""Facade for the internal dictionary's get method"""
return self.data.get(owlclass)
class OwlIntuitionSensor(Entity):
"""Implementation of the OWL Intuition Power Meter sensors."""
def __init__(self, owldata, sensor_name, sensor_type, phase=0):
"""Set all the config values if they exist and get initial state."""
self._owldata = owldata
if(phase > 0):
self._name = '{} {} P{}'.format(
sensor_name,
SENSOR_TYPES[sensor_type][0],
phase)
else:
self._name = '{} {}'.format(
sensor_name,
SENSOR_TYPES[sensor_type][0])
self._sensor_type = sensor_type
self._phase = phase
self._owl_class = SENSOR_TYPES[sensor_type][3]
self._state = None
self._attrs = {
ATTR_LAST_UPDATE: None,
ATTR_ATTRIBUTION: 'Powered by OWL Intuition'
}
@property
def name(self):
"""Return the name of this sensor."""
return self._name
@property
def unit_of_measurement(self):
"""Return the unit of measurement of this entity."""
return SENSOR_TYPES[self._sensor_type][1]
@property
def icon(self):
"""Return the icon for this entity."""
return SENSOR_TYPES[self._sensor_type][2]
@property
def state(self):
"""Return the current value for this sensor."""
return self._state
@property
def device_state_attributes(self):
"""Return the state attributes of the sensor."""
return self._attrs
def update(self):
"""Retrieve the latest value for this sensor."""
self._owldata.update()
xml = self._owldata.get(self._owl_class)
if xml is None:
return
xml_ver = xml.attrib.get('ver')
self._attrs[ATTR_LAST_UPDATE] = int(xml.find('timestamp').text)
if (xml.tag == OWLCLASS_HEATING or xml.tag == OWLCLASS_HOTWATER or xml.tag == OWLCLASS_RELAYS):
# Only supports first zone currently
xml = xml.find('zones/zone')
# Radio & Battery sensors
if self._sensor_type in RADIO_SENSORS:
self._state = int(xml.find('signal').attrib['rssi'])
elif self._sensor_type == SENSOR_ELECTRICITY_BATTERY_LVL:
# Battery level in % for OWLCLASS_ELECTRICITY, mV for others
self._state = int(xml.find("battery").attrib['level'][:-1])
elif self._sensor_type in [SENSOR_HOTWATER_BATTERY_LVL, SENSOR_HEATING_BATTERY_LVL]:
self._state = round(float(xml.find("battery").attrib['level'])/1000, 2)
elif self._sensor_type == SENSOR_ELECTRICITY_BATTERY:
batt_lvl = int(xml.find("battery").attrib['level'][:-1])
if batt_lvl > 90:
self._state = 'High'
elif batt_lvl > 30:
self._state = 'Medium'
elif batt_lvl > 10:
self._state = 'Low'
else:
self._state = 'Very Low'
elif self._sensor_type in [SENSOR_HOTWATER_BATTERY, SENSOR_HEATING_BATTERY]:
# 2670mV = 66%
# 2780mV = 76%
batt_lvl = int(xml.find("battery").attrib['level'])
if batt_lvl > 2900:
self._state = 'High'
elif batt_lvl > 2750:
self._state = 'Medium'
elif batt_lvl > 2600:
self._state = 'Low'
else:
self._state = 'Very Low'
# Electricity sensors
elif self._sensor_type == SENSOR_ELECTRICITY_POWER:
if self._phase == 0:
# xml_ver undefined for older version
if xml_ver is None:
self._state = int(float(xml.find('chan/curr').text))
else:
self._state = int(float(xml.find('property/current/watts').text))
else:
# TODO: Older xml format not handled yet for tri-phase
if xml_ver is None:
self._state = int(float(xml.findall('chan')[self._phase-1].
find('curr').text))
else:
self._state = int(float(xml.find('channels').
findall('chan')[self._phase-1].
find('curr').text))
elif self._sensor_type == SENSOR_ELECTRICITY_ENERGY_TODAY:
if self._phase == 0:
# xml_ver undefined for older version
if xml_ver is None:
self._state = round(float(xml.find('chan/day').text)/1000,2)
else:
self._state = round(float(xml.find('property/day/wh').text)/1000, 2)
else:
# TODO: Older xml format not handled yet for tri-phase
if xml_ver is None:
self._state = round(float(xml.findall('chan')[self._phase-1].
find('day').text)/1000, 2)
else:
self._state = round(float(xml.find('channels').
findall('chan')[self._phase-1].
find('day').text)/1000, 2)
elif self._sensor_type == SENSOR_ELECTRICITY_COST_TODAY:
# xml_ver undefined for older version
if xml_ver is None:
self._state = 'N/A'
else:
# the measure comes in cent. of the configured currency
self._state = round(float(xml.find('property/day/cost').text)/100, 3)
# Solar sensors
elif self._sensor_type == SENSOR_SOLAR_GPOWER:
self._state = int(float(xml.find('current/generating').text))
elif self._sensor_type == SENSOR_SOLAR_EPOWER:
self._state = int(float(xml.find('current/exporting').text))
elif self._sensor_type == SENSOR_SOLAR_GENERGY_TODAY:
self._state = round(float(xml.find('day/generated').text)/1000, 2)
elif self._sensor_type == SENSOR_SOLAR_EENERGY_TODAY:
self._state = round(float(xml.find('day/exported').text)/1000, 2)
# Hotwater sensors
if self._sensor_type == SENSOR_HOTWATER_CURRENT:
self._state = round(float(xml.find('temperature/current').text),1)
elif self._sensor_type == SENSOR_HOTWATER_REQUIRED:
self._state = float(xml.find('temperature/required').text)
elif self._sensor_type == SENSOR_HOTWATER_AMBIENT:
self._state = float(xml.find('temperature/ambient').text)
elif self._sensor_type == SENSOR_HOTWATER_STATE:
# Heating state reported in version 2 and up
if xml_ver is not None:
self._state = HOTWATER_STATE[int(xml.find('temperature').attrib['state'])]
# Heating Sensors
elif self._sensor_type == SENSOR_HEATING_CURRENT:
self._state = round(float(xml.find('temperature/current').text),1)
elif self._sensor_type == SENSOR_HEATING_REQUIRED:
self._state = float(xml.find('temperature/required').text)
elif self._sensor_type == SENSOR_HEATING_STATE:
# Heating state reported in version 2 and up
if xml_ver is not None:
self._state = HEATING_STATE[int(xml.find('temperature').attrib['state'])]
class OwlStateUpdater(asyncio.DatagramProtocol):
"""An helper class for the async UDP listener loop.
More info at:
https://docs.python.org/3/library/asyncio-protocol.html"""
def __init__(self, eloop):
"""Boiler-plate initialisation"""
self.eloop = eloop
self.transport = None
def connection_made(self, transport):
"""Boiler-plate connection made metod"""
self.transport = transport
def datagram_received(self, packet, addr_unused):
"""Get the last received datagram and notify the
OwlData singleton for storing it if relevant"""
xmldata = packet.decode('utf-8')
root = xmldata[1:xmldata.find(' ')]
_LOGGER.debug("Datagram received for type %s", root)
if root in OWL_CLASSES:
# do not call here that method, but instead leave
# the event loop do it when convenient AND thread-safe!
self.eloop.call_soon_threadsafe(
owldata.on_data_received, xmldata)
else:
_LOGGER.warning("Unsupported type '%s' in data: %s", \
root, packet)
def error_received(self, exc):
"""Boiler-plate error received method"""
_LOGGER.error("Received error %s", exc)
def cleanup(self):
"""Boiler-plate cleanup method"""
if self.transport:
self.transport.close()
self.transport = None