forked from Tom-Bom-badil/SmartHomeNG-Helios
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path__init__.py
executable file
·516 lines (451 loc) · 22.4 KB
/
__init__.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
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
#!/usr/bin/env python
#########################################################################
# Copyright 2014 Marcel Tiews [email protected]
# Modified 2014-2017 by René Jahncke aka Tom-Bom-badil @ github.com
#########################################################################
# Helios-Vallox-Plugin for SmartHome.py. http://mknx.github.io/smarthome/
#
# This plugin is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This plugin is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this plugin. If not, see <http://www.gnu.org/licenses/>.
#########################################################################
import sys
import serial
import logging
import socket
import threading
import struct
import time
import datetime
import array
from lib.model.smartplugin import SmartPlugin
# old / removed: logger = logging.getLogger("")
# Old CONST's - previous definitions
#CONST_BUSMEMBER__MAINBOARD = 0x11
#CONST_BUSMEMBER__SLAVEBOARDS = 0x10
#CONST_BUSMEMBER__CONTROLBOARDS = 0x20
#CONST_BUSMEMBER__ME = 0x2F
# Broadcast addresses - no way to address slave boards in the units directly (according to Vallox)
CONST_BUS_ALL_MAINBOARDS = 0x10
CONST_BUS_ALL_REMOTES = 0x20
# Individual addresses
CONST_BUS_MAINBOARD1 = 0x11 # 1st of max 15 ventilation units (mainboards 1-F)
CONST_BUS_REMOTE1 = 0x21 # 1st of max 15 remote controls (remotes 1-F, default jumper = 1)
CONST_BUS_LON = 0x28 # default for LON bus module (just for information --> expensive)
CONST_BUS_ME = 0x2F # stealth mode - we are behaving like a regular remote control
CONST_MAP_VARIABLES_TO_ID = {
"power_state" : {"varid" : 0xA3, 'type': 'bit', 'bitposition': 0, 'read': True, 'write': True },
"outside_temp" : {"varid" : 0x32, 'type': 'temperature', 'bitposition': -1, 'read': True, 'write': False },
"exhaust_temp" : {"varid" : 0x33, 'type': 'temperature', 'bitposition': -1, 'read': True, 'write': False },
"inside_temp" : {"varid" : 0x34, 'type': 'temperature', 'bitposition': -1, 'read': True, 'write': False },
"incoming_temp" : {"varid" : 0x35, 'type': 'temperature', 'bitposition': -1, 'read': True, 'write': False },
"fanspeed" : {"varid" : 0x29, 'type': 'fanspeed', 'bitposition': -1, 'read': True, 'write': True },
"max_fanspeed" : {"varid" : 0xA5, 'type': 'fanspeed', 'bitposition': -1, 'read': True, 'write': True },
"min_fanspeed" : {"varid" : 0xA9, 'type': 'fanspeed', 'bitposition': -1, 'read': True, 'write': True },
"bypass_temp" : {"varid" : 0xAF, 'type': 'temperature', 'bitposition': -1, 'read': True, 'write': True },
"bypass_disabled" : {"varid" : 0xA3, 'type': 'bit', 'bitposition': 3, 'read': True, 'write': True },
"heating_on_off" : {"varid" : 0x70, 'type': 'bit', 'bitposition': 7, 'read': True, 'write': True },
"heating_setpoint": {"varid" : 0xA7, 'type': 'temperature', 'bitposition': -1, 'read': True, 'write': True },
"frost_stop" : {"varid" : 0xA8, 'type': 'temperature', 'bitposition': -1, 'read': True, 'write': True },
"cell_defrost" : {"varid" : 0xB2, 'type': 'dec', 'bitposition': -1, 'read': True, 'write': True },
"boost_mode" : {"varid" : 0xAA, 'type': 'bit', 'bitposition': 5, 'read': True, 'write': True },
"boost_on" : {"varid" : 0x71, 'type': 'bit', 'bitposition': 5, 'read': True, 'write': True },
"boost_status" : {"varid" : 0x71, 'type': 'bit', 'bitposition': 6, 'read': True, 'write': False },
"boost_remaining" : {"varid" : 0x79, 'type': 'dec', 'bitposition': -1, 'read': True, 'write': False },
"fan_in_on_off" : {"varid" : 0x08, 'type': 'bit', 'bitposition': 3, 'read': True, 'write': True },
"fan_in_percent" : {"varid" : 0xB0, 'type': 'dec', 'bitposition': -1, 'read': True, 'write': True },
"fan_out_on_off" : {"varid" : 0x08, 'type': 'bit', 'bitposition': 5, 'read': True, 'write': True },
"fan_out_percent" : {"varid" : 0xB1, 'type': 'dec', 'bitposition': -1, 'read': True, 'write': True },
"clean_filter" : {"varid" : 0xAB, 'type': 'dec', 'bitposition': -1, 'read': True, 'write': True },
"device_error" : {"varid" : 0x36, 'type': 'dec', 'bitposition': -1, 'read': True, 'write': False }
}
CONST_TEMPERATURE = array.array('i', [
-74,-70,-66,-62,-59,-56,-54,-52,-50,-48,-47,-46,-44,-43,-42,-41,-40,-39,-38,-37,-36,
-35,-34,-33,-33,-32,-31,-30,-30,-29,-28,-28,-27,-27,-26,-25,-25,-24,-24,-23,-23,-22,
-22,-21,-21,-20,-20,-19,-19,-19,-18,-18,-17,-17,-16,-16,-16,-15,-15,-14,-14,-14,-13,
-13,-12,-12,-12,-11,-11,-11,-10,-10,-9,-9,-9,-8,-8,-8,-7,-7,-7,-6,-6,-6,-5,-5,-5,-4,
-4,-4,-3,-3,-3,-2,-2,-2,-1,-1,-1,-1,0,0,0,1,1,1,2,2,2,3,3,3,4,4,4,5,5,5,5,6,6,6,7,7,
7,8,8,8,9,9,9,10,10,10,11,11,11,12,12,12,13,13,13,14,14,14,15,15,15,16,16,16,17,17,
18,18,18,19,19,19,20,20,21,21,21,22,22,22,23,23,24,24,24,25,25,26,26,27,27,27,28,28,
29,29,30,30,31,31,32,32,33,33,34,34,35,35,36,36,37,37,38,38,39,40,40,41,41,42,43,43,
44,45,45,46,47,48,48,49,50,51,52,53,53,54,55,56,57,59,60,61,62,63,65,66,68,69,71,73,
75,77,79,81,82,86,90,93,97,100,100,100,100,100,100,100,100,100])
class HeliosException(Exception):
pass
class HeliosBase(SmartPlugin):
PLUGIN_VERSION = "1.4.2"
ALLOW_MULTIINSTANCE = False
def __init__(self, tty='/dev/ttyUSB0'):
self.logger = logging.getLogger(__name__)
self._tty = tty
self._is_connected = False
self._port = False
self._lock = threading.Lock()
def connect(self):
if self._is_connected and self._port:
return True
try:
self.logger.debug("Helios: Connecting...")
self._port = serial.Serial(
self._tty,
baudrate=9600,
bytesize=serial.EIGHTBITS,
parity=serial.PARITY_NONE,
stopbits=serial.STOPBITS_ONE,
timeout=1)
self._is_connected = True
return True
except:
self.logger.error("Helios: Could not open {0}.".format(self._tty))
return False
def disconnect(self):
if self._is_connected and self._port:
self.logger.debug("HeliosBase: Disconnecting...")
self._port.close()
self._is_connected = False
def _createTelegram(self, sender, receiver, function, value):
telegram = [1,sender,receiver,function,value,0]
telegram[5] = self._calculateCRC(telegram)
return telegram
def _waitForSilence(self):
# Modbus RTU only allows one master (client which controls communication).
# So lets try to wait a bit and jump in when nobody's speaking.
# Modbus defines a waittime of 3,5 Characters between telegrams:
# (1/9600baud * (1 Start bit + 8 Data bits + 1 Parity bit + 1 Stop bit)
# => about 4ms
# Lets go with 7ms! ;O)
gotSlot = False
backupTimeout = self._port.timeout
end = time.time() + 3
self._port.timeout = 0.007 # Changed from 0.07 --> 0.007 (7ms) according to Standard
while end > time.time():
chars = self._port.read(1)
# nothing received so we got a slot of silence...hopefully
if len(chars) == 0:
gotSlot = True
break
self._port.timeout = backupTimeout
return gotSlot
def _sendTelegram(self, telegram):
if not self._is_connected:
return False
self.logger.debug("Helios: Sending telegram '{0}'".format(self._telegramToString(telegram)))
self._port.write(bytearray(telegram))
return True
def _readTelegram(self, sender, receiver, datapoint):
# sometimes a lot of garbage is received...so lets get a bit robust
# and read a bit of this junk and see whether we are getting something
# useful out of it!
# How long does it take until something useful is received???
timeout = time.time() + 1
telegram = [0,0,0,0,0,0]
while self._is_connected and timeout > time.time():
char = self._port.read(1)
if(len(char) > 0):
byte = bytearray(char)[0]
telegram.pop(0)
telegram.append(byte)
# Telegrams always start with a 0x01, is the CRC valid?, ...
if (telegram[0] == 0x01 and
telegram[1] == sender and
telegram[2] == receiver and
telegram[3] == datapoint and
telegram[5] == self._calculateCRC(telegram)):
self.logger.debug("Telegram received '{0}'".format(self._telegramToString(telegram)))
return telegram[4]
return None
def _calculateCRC(self, telegram):
sum = 0
for c in telegram[:-1]:
sum = sum + c
return sum % 256
def _telegramToString(self, telegram):
str = ""
for c in telegram:
# str = str + hex(c) + " " 0x01 was showing as 0x1, 0x1A was showing as 0x1a
str = str + '0x%0*X' % (2,c) + " "
str = str[:-1] # remove trailing space
return str
def _convertFromRawValue(self, varname, rawvalue):
value = None
vardef = CONST_MAP_VARIABLES_TO_ID[varname]
if vardef["type"] == "temperature":
value = CONST_TEMPERATURE[rawvalue]
elif vardef["type"] == "fanspeed":
if rawvalue == 0x01:
value = 1
elif rawvalue == 0x03:
value = 2
elif rawvalue == 0x07:
value = 3
elif rawvalue == 0x0F:
value = 4
elif rawvalue == 0x1F:
value = 5
elif rawvalue == 0x3F:
value = 6
elif rawvalue == 0x7F:
value = 7
elif rawvalue == 0xFF:
value = 8
else:
value = None
elif vardef["type"] == "bit":
value = rawvalue >> vardef["bitposition"] & 0x01
elif vardef["type"] == "dec": # decimal value
value = rawvalue
return value
def _convertFromValue(self, varname, value, prevvalue):
rawvalue = None
vardef = CONST_MAP_VARIABLES_TO_ID[varname]
if vardef['type'] == "temperature":
rawvalue = CONST_TEMPERATURE.index(int(value))
elif vardef["type"] == "fanspeed":
value = int(value)
if value == 1:
rawvalue = 0x01
elif value == 2:
rawvalue = 0x03
elif value == 3:
rawvalue = 0x07
elif value == 4:
rawvalue = 0x0F
elif value == 5:
rawvalue = 0x1F
elif value == 6:
rawvalue = 0x3F
elif value == 7:
rawvalue = 0x7F
elif value == 8:
rawvalue = 0xFF
else:
rawvalue = None
elif vardef["type"] == "bit":
# for bits we have to keep the other bits of the byte (previous value)
if value in (True,1,"true","True","1","On","on"):
rawvalue = prevvalue | (1 << vardef["bitposition"])
else:
rawvalue = prevvalue & ~(1 << vardef["bitposition"])
elif vardef["type"] == "dec": # decimal value
rawvalue = int(value)
return rawvalue
def writeValue(self,varname, value):
if CONST_MAP_VARIABLES_TO_ID[varname]["write"] != True:
self.logger.error("Helios: Variable {0} may not be written!".format(varname))
return False
success = False
self._lock.acquire()
try:
# if we have got to write a single bit, we need the current (byte) value to
# reproduce the other bits...
if CONST_MAP_VARIABLES_TO_ID[varname]["type"] == "bit":
currentval = None
if self._waitForSilence():
# Send poll request
telegram = self._createTelegram(
CONST_BUS_ME,
CONST_BUS_MAINBOARD1,
0,
CONST_MAP_VARIABLES_TO_ID[varname]["varid"]
)
self._sendTelegram(telegram)
# Read response
currentval = self._readTelegram(
CONST_BUS_MAINBOARD1,
CONST_BUS_ME,
CONST_MAP_VARIABLES_TO_ID[varname]["varid"]
)
if currentval == None:
self.logger.error("Helios: Sending value to ventilation system failed. Can not read current variable value '{0}'."
.format(varname))
return False
rawvalue = self._convertFromValue(varname, value, currentval)
else:
rawvalue = self._convertFromValue(varname, value, None)
# send the new value
if self._waitForSilence():
if rawvalue != None:
# Broadcasting value to all remote control boards
telegram = self._createTelegram(
CONST_BUS_ME,
CONST_BUS_ALL_REMOTES,
CONST_MAP_VARIABLES_TO_ID[varname]["varid"],
rawvalue
)
self._sendTelegram(telegram)
# Broadcasting value to all mainboards
telegram = self._createTelegram(
CONST_BUS_ME,
CONST_BUS_ALL_MAINBOARDS,
CONST_MAP_VARIABLES_TO_ID[varname]["varid"],
rawvalue
)
self._sendTelegram(telegram)
# Writing value to 1st mainboard
telegram = self._createTelegram(
CONST_BUS_ME,
CONST_BUS_MAINBOARD1,
CONST_MAP_VARIABLES_TO_ID[varname]["varid"],
rawvalue
)
self._sendTelegram(telegram)
# Send checksum a second time
self._sendTelegram([telegram[5]])
#################### Special treatment to switch on remote controls after off state:
if CONST_MAP_VARIABLES_TO_ID[varname]["varid"] == 0xA3 and CONST_MAP_VARIABLES_TO_ID[varname]["bitposition"] == 0:
self.logger.debug("On/off command - special treatment for the remote controls")
telegram = self._createTelegram(
CONST_BUS_ME,
CONST_BUS_ALL_REMOTES,
CONST_MAP_VARIABLES_TO_ID[varname]["varid"],
rawvalue
)
self._sendTelegram(telegram)
telegram = self._createTelegram(
CONST_BUS_ME,
CONST_BUS_REMOTE1,
CONST_MAP_VARIABLES_TO_ID[varname]["varid"],
rawvalue
)
self._sendTelegram(telegram)
self._sendTelegram([telegram[5]])
#################### Doesn't work so far
success = True
else:
self.logger.error("Helios: Sending value to ventilation system failed. Can not convert value '{0}' for variable '{1}'."
.format(value,varname))
success = False
else:
self.logger.error("Helios: Sending value to ventilation system failed. No free slot for sending telegrams available.")
success = False
except Exception as e:
self.logger.error("Helios: Exception in writeValue() occurred: {0}".format(e))
finally:
self._lock.release()
return success
def readValue(self,varname):
if CONST_MAP_VARIABLES_TO_ID[varname]["read"] != True:
self.logger.error("Variable {0} may not be read!".format(varname))
return False
value = None
self._lock.acquire()
try:
self.logger.debug("Helios: Reading value: {0}".format(varname))
if self._waitForSilence():
# Send poll request
telegram = self._createTelegram(
CONST_BUS_ME,
CONST_BUS_MAINBOARD1,
0,
CONST_MAP_VARIABLES_TO_ID[varname]["varid"]
)
self._sendTelegram(telegram)
# Read response
value = self._readTelegram(
CONST_BUS_MAINBOARD1,
CONST_BUS_ME,
CONST_MAP_VARIABLES_TO_ID[varname]["varid"]
)
if value is not None:
raw_value = value
value = self._convertFromRawValue(varname,value)
self.logger.debug("Value for {0} ({1}) received: {2}|{3}|{4} --> converted = {5}"
.format(varname, '0x%0*X' % (2, CONST_MAP_VARIABLES_TO_ID[varname]["varid"]),
'0x%0*X' % (2,raw_value), "{0:08b}".format(raw_value), raw_value, value)
)
else: # logging as info only, so we stop spamming log file as some noise on the bus seems to be normal
self.logger.info("Helios: No valid value for '{0}' from ventilation system received."
.format(varname)
)
else:
self.logger.warning("Helios: Reading value from ventilation system failed. No free slot to send poll request available.")
except Exception as e:
self.logger.error("Helios: Exception in readValue() occurred: {0}".format(e))
finally:
self._lock.release()
return value
class Helios(HeliosBase):
_items = {}
def __init__(self, smarthome, tty, cycle=300):
HeliosBase.__init__(self, tty)
self._sh = smarthome
self._cycle = int(cycle)
self._alive = False
def run(self):
self.connect()
self._alive = True
self._sh.scheduler.add('Helios', self._update, cycle=self._cycle)
def stop(self):
self.disconnect()
self._alive = False
def parse_item(self, item):
if 'helios_var' in item.conf:
varname = item.conf['helios_var']
if varname in CONST_MAP_VARIABLES_TO_ID.keys():
self._items[varname] = item
return self.update_item
else:
self.logger.warning("Helios: Ignoring unknown variable '{0}'".format(varname))
def update_item(self, item, caller=None, source=None, dest=None):
if caller != 'Helios':
self.writeValue(item.conf['helios_var'], item())
def _update(self):
self.logger.debug("Helios: Updating values")
for var in self._items.keys():
val = self.readValue(var)
if val != None:
self._items[var](val,"Helios")
def main():
import argparse
parser = argparse.ArgumentParser(
description="Helios ventilation system commandline interface.",
epilog="Without arguments all readable values using default tty will be retrieved.",
argument_default=argparse.SUPPRESS)
parser.add_argument("-t", "--tty", dest="port", default="/dev/ttyUSB0", help="Serial device to use")
parser.add_argument("-r", "--read", dest="read_var", help="Read variables from ventilation system")
parser.add_argument("-w", "--write", dest="write_var", help="Write variable to ventilation system")
parser.add_argument("-v", "--value", dest="value", help="Value to write (required with option -v)")
parser.add_argument("-d", "--debug", dest="enable_debug", action="store_true", help="Prints debug statements.")
args = vars(parser.parse_args())
if "write_var" in args.keys() and "value" not in args.keys():
parser.print_usage()
return
logger.setLevel(logging.DEBUG)
# old log version
# ch = logging.StreamHandler()
# if "enable_debug" in args.keys():
# ch.setLevel(logging.DEBUG)
# else:
# ch.setLevel(logging.INFO)
# formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
# ch.setFormatter(formatter)
# logger.addHandler(ch)
try:
helios = HeliosBase(args["port"])
helios.connect()
if not helios._is_connected:
raise Exception("Not connected")
if "read_var" in args.keys():
print("{0} = {1}".format(args["read_var"],helios.readValue(args["read_var"])))
elif "write_var" in args.keys():
helios.writeValue(args["write_var"],args["value"])
else:
for var in CONST_MAP_VARIABLES_TO_ID.keys():
print("{0} = {1}".format(var,helios.readValue(var)))
except Exception as e:
print("Exception: {0}".format(e))
return 1
finally:
if helios:
helios.disconnect()
if __name__ == "__main__":
sys.exit(main())