-
-
Notifications
You must be signed in to change notification settings - Fork 29.9k
/
dsmr.py
364 lines (307 loc) · 11.4 KB
/
dsmr.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
"""
Support for Dutch Smart Meter (also known as Smartmeter or P1 port).
For more details about this platform, please refer to the documentation at
https://home-assistant.io/components/sensor.dsmr/
"""
import asyncio
from datetime import timedelta
from functools import partial
import logging
import voluptuous as vol
from homeassistant.components.sensor import PLATFORM_SCHEMA
from homeassistant.const import (
CONF_HOST, CONF_PORT, EVENT_HOMEASSISTANT_STOP)
from homeassistant.core import CoreState
import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.entity import Entity
_LOGGER = logging.getLogger(__name__)
REQUIREMENTS = ['dsmr_parser==0.12']
CONF_DSMR_VERSION = 'dsmr_version'
CONF_RECONNECT_INTERVAL = 'reconnect_interval'
CONF_PRECISION = 'precision'
DEFAULT_DSMR_VERSION = '2.2'
DEFAULT_PORT = '/dev/ttyUSB0'
DEFAULT_PRECISION = 3
DOMAIN = 'dsmr'
ICON_GAS = 'mdi:fire'
ICON_POWER = 'mdi:flash'
ICON_POWER_FAILURE = 'mdi:flash-off'
ICON_SWELL_SAG = 'mdi:pulse'
# Smart meter sends telegram every 10 seconds
MIN_TIME_BETWEEN_UPDATES = timedelta(seconds=10)
RECONNECT_INTERVAL = 5
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.string,
vol.Optional(CONF_HOST): cv.string,
vol.Optional(CONF_DSMR_VERSION, default=DEFAULT_DSMR_VERSION): vol.All(
cv.string, vol.In(['5', '4', '2.2'])),
vol.Optional(CONF_RECONNECT_INTERVAL, default=30): int,
vol.Optional(CONF_PRECISION, default=DEFAULT_PRECISION): vol.Coerce(int),
})
async def async_setup_platform(hass, config, async_add_entities,
discovery_info=None):
"""Set up the DSMR sensor."""
# Suppress logging
logging.getLogger('dsmr_parser').setLevel(logging.ERROR)
from dsmr_parser import obis_references as obis_ref
from dsmr_parser.clients.protocol import (
create_dsmr_reader, create_tcp_dsmr_reader)
import serial
dsmr_version = config[CONF_DSMR_VERSION]
# Define list of name,obis mappings to generate entities
obis_mapping = [
[
'Power Consumption',
obis_ref.CURRENT_ELECTRICITY_USAGE
],
[
'Power Production',
obis_ref.CURRENT_ELECTRICITY_DELIVERY
],
[
'Power Tariff',
obis_ref.ELECTRICITY_ACTIVE_TARIFF
],
[
'Power Consumption (low)',
obis_ref.ELECTRICITY_USED_TARIFF_1
],
[
'Power Consumption (normal)',
obis_ref.ELECTRICITY_USED_TARIFF_2
],
[
'Power Production (low)',
obis_ref.ELECTRICITY_DELIVERED_TARIFF_1
],
[
'Power Production (normal)',
obis_ref.ELECTRICITY_DELIVERED_TARIFF_2
],
[
'Power Consumption Phase L1',
obis_ref.INSTANTANEOUS_ACTIVE_POWER_L1_POSITIVE
],
[
'Power Consumption Phase L2',
obis_ref.INSTANTANEOUS_ACTIVE_POWER_L2_POSITIVE
],
[
'Power Consumption Phase L3',
obis_ref.INSTANTANEOUS_ACTIVE_POWER_L3_POSITIVE
],
[
'Power Production Phase L1',
obis_ref.INSTANTANEOUS_ACTIVE_POWER_L1_NEGATIVE
],
[
'Power Production Phase L2',
obis_ref.INSTANTANEOUS_ACTIVE_POWER_L2_NEGATIVE
],
[
'Power Production Phase L3',
obis_ref.INSTANTANEOUS_ACTIVE_POWER_L3_NEGATIVE
],
[
'Long Power Failure Count',
obis_ref.LONG_POWER_FAILURE_COUNT
],
[
'Voltage Sags Phase L1',
obis_ref.VOLTAGE_SAG_L1_COUNT
],
[
'Voltage Sags Phase L2',
obis_ref.VOLTAGE_SAG_L2_COUNT
],
[
'Voltage Sags Phase L3',
obis_ref.VOLTAGE_SAG_L3_COUNT
],
[
'Voltage Swells Phase L1',
obis_ref.VOLTAGE_SWELL_L1_COUNT
],
[
'Voltage Swells Phase L2',
obis_ref.VOLTAGE_SWELL_L2_COUNT
],
[
'Voltage Swells Phase L3',
obis_ref.VOLTAGE_SWELL_L3_COUNT
],
[
'Voltage Phase L1',
obis_ref.INSTANTANEOUS_VOLTAGE_L1
],
[
'Voltage Phase L2',
obis_ref.INSTANTANEOUS_VOLTAGE_L2
],
[
'Voltage Phase L3',
obis_ref.INSTANTANEOUS_VOLTAGE_L3
],
]
# Generate device entities
devices = [DSMREntity(name, obis, config) for name, obis in obis_mapping]
# Protocol version specific obis
if dsmr_version in ('4', '5'):
gas_obis = obis_ref.HOURLY_GAS_METER_READING
else:
gas_obis = obis_ref.GAS_METER_READING
# Add gas meter reading and derivative for usage
devices += [
DSMREntity('Gas Consumption', gas_obis, config),
DerivativeDSMREntity('Hourly Gas Consumption', gas_obis, config),
]
async_add_entities(devices)
def update_entities_telegram(telegram):
"""Update entities with latest telegram and trigger state update."""
# Make all device entities aware of new telegram
for device in devices:
device.telegram = telegram
hass.async_create_task(device.async_update_ha_state())
# Creates an asyncio.Protocol factory for reading DSMR telegrams from
# serial and calls update_entities_telegram to update entities on arrival
if CONF_HOST in config:
reader_factory = partial(
create_tcp_dsmr_reader, config[CONF_HOST], config[CONF_PORT],
config[CONF_DSMR_VERSION], update_entities_telegram,
loop=hass.loop)
else:
reader_factory = partial(
create_dsmr_reader, config[CONF_PORT], config[CONF_DSMR_VERSION],
update_entities_telegram, loop=hass.loop)
async def connect_and_reconnect():
"""Connect to DSMR and keep reconnecting until Home Assistant stops."""
while hass.state != CoreState.stopping:
# Start DSMR asyncio.Protocol reader
try:
transport, protocol = await hass.loop.create_task(
reader_factory())
except (serial.serialutil.SerialException, ConnectionRefusedError,
TimeoutError):
# Log any error while establishing connection and drop to retry
# connection wait
_LOGGER.exception("Error connecting to DSMR")
transport = None
if transport:
# Register listener to close transport on HA shutdown
stop_listener = hass.bus.async_listen_once(
EVENT_HOMEASSISTANT_STOP, transport.close)
# Wait for reader to close
await protocol.wait_closed()
if hass.state != CoreState.stopping:
# Unexpected disconnect
if transport:
# remove listener
stop_listener()
# Reflect disconnect state in devices state by setting an
# empty telegram resulting in `unknown` states
update_entities_telegram({})
# throttle reconnect attempts
await asyncio.sleep(config[CONF_RECONNECT_INTERVAL],
loop=hass.loop)
# Can't be hass.async_add_job because job runs forever
hass.loop.create_task(connect_and_reconnect())
class DSMREntity(Entity):
"""Entity reading values from DSMR telegram."""
def __init__(self, name, obis, config):
"""Initialize entity."""
self._name = name
self._obis = obis
self._config = config
self.telegram = {}
def get_dsmr_object_attr(self, attribute):
"""Read attribute from last received telegram for this DSMR object."""
# Make sure telegram contains an object for this entities obis
if self._obis not in self.telegram:
return None
# Get the attribute value if the object has it
dsmr_object = self.telegram[self._obis]
return getattr(dsmr_object, attribute, None)
@property
def name(self):
"""Return the name of the sensor."""
return self._name
@property
def icon(self):
"""Icon to use in the frontend, if any."""
if 'Sags' in self._name or 'Swells' in self.name:
return ICON_SWELL_SAG
if 'Failure' in self._name:
return ICON_POWER_FAILURE
if 'Power' in self._name:
return ICON_POWER
if 'Gas' in self._name:
return ICON_GAS
@property
def state(self):
"""Return the state of sensor, if available, translate if needed."""
from dsmr_parser import obis_references as obis
value = self.get_dsmr_object_attr('value')
if self._obis == obis.ELECTRICITY_ACTIVE_TARIFF:
return self.translate_tariff(value)
try:
value = round(float(value), self._config[CONF_PRECISION])
except TypeError:
pass
if value is not None:
return value
return None
@property
def unit_of_measurement(self):
"""Return the unit of measurement of this entity, if any."""
return self.get_dsmr_object_attr('unit')
@staticmethod
def translate_tariff(value):
"""Convert 2/1 to normal/low."""
# DSMR V2.2: Note: Rate code 1 is used for low rate and rate code 2 is
# used for normal rate.
if value == '0002':
return 'normal'
if value == '0001':
return 'low'
return None
class DerivativeDSMREntity(DSMREntity):
"""Calculated derivative for values where the DSMR doesn't offer one.
Gas readings are only reported per hour and don't offer a rate only
the current meter reading. This entity converts subsequents readings
into a hourly rate.
"""
_previous_reading = None
_previous_timestamp = None
_state = None
@property
def state(self):
"""Return the calculated current hourly rate."""
return self._state
async def async_update(self):
"""Recalculate hourly rate if timestamp has changed.
DSMR updates gas meter reading every hour. Along with the new
value a timestamp is provided for the reading. Test if the last
known timestamp differs from the current one then calculate a
new rate for the previous hour.
"""
# check if the timestamp for the object differs from the previous one
timestamp = self.get_dsmr_object_attr('datetime')
if timestamp and timestamp != self._previous_timestamp:
current_reading = self.get_dsmr_object_attr('value')
if self._previous_reading is None:
# Can't calculate rate without previous datapoint
# just store current point
pass
else:
# Recalculate the rate
diff = current_reading - self._previous_reading
timediff = timestamp - self._previous_timestamp
self._state = diff / timediff * 3600
self._previous_reading = current_reading
self._previous_timestamp = timestamp
@property
def unit_of_measurement(self):
"""Return the unit of measurement of this entity, per hour, if any."""
unit = self.get_dsmr_object_attr('unit')
if unit:
return unit + '/h'