-
Notifications
You must be signed in to change notification settings - Fork 3
/
plugin.py
1035 lines (974 loc) · 51 KB
/
plugin.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
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
'''
<plugin key="HivePlug" name="Hive Plugin" author="imcfarla, MikeF and roadsnail" version="1.2" wikilink="http://www.domoticz.com/wiki/plugins" externallink="https://github.com/imcfarla2003/domoticz-hive">
<description>
<h2>Hive Plugin</h2>
<h3>Features</h3>
<ul style="list-style-type:square">
<li>Thermostats (including multizone)</li>
<li>Active lights</li>
<li>Warm to Cool lights</li>
<li>Colour lights</li>
<li>Activeplugs</li>
</ul>
<h3>To Do</h3>
<ul style="list-style-type:square">
<li>Allow to choose the heating mode from boost, scheduled, manual and off</li>
</ul>
</description>
<params>
<param field="Username" label="Hive Username" width="200px" required="true" default=""/>
<param field="Password" label="Hive Password" width="200px" required="true" default=""/>
<param field="Mode1" label="Heartbeat Multiplier" width="30px" required="true" default="6"/>
<param field="Mode3" label="Postcode" width="100px" required="false" default=""/>
<param field="Mode6" label="Debug" width="150px">
<options>
<option label="None" value="0" default="true" />
<option label="Python Only" value="2"/>
<option label="Basic Debugging" value="62"/>
<option label="Basic+Messages" value="126"/>
<option label="Connections Only" value="16"/>
<option label="Connections+Queue" value="144"/>
<option label="All" value="-1"/></options>
</param>
</params>
</plugin>
'''
try:
import json
import math
from urllib.parse import urlencode
import Domoticz
except ImportError as L_err:
print("ImportError: {0}".format(L_err))
raise L_err
class BasePlugin:
enabled = False
def __init__(self):
self.sessionId = ''
self.counter = 0
self.multiplier = 10
self.lightsSet = set()
self.activeplugsSet = set()
self.hwrelaySet = set()
self.chrelaySet = set()
self.TimedOutAvailable = True
self.httpConn = False
self.deviceConn = False
self.deviceUpdateConn = False
self.weatherConn = False
self.sessionHost = 'beekeeper.hivehome.com'
self.deviceHost = 'api.prod.bgchprod.info'
self.weatherHost = 'weather.prod.bgchprod.info'
self.headers = ''
self.weatherHeaders = {}
self.deviceUpdate = False
self.updateCounter = 0
self.updateCounterLast = 0
def onStart(self):
Domoticz.Log('Starting')
if Parameters["Mode6"] != "0":
if Parameters["Mode6"] == "Normal":
Domoticz.Debugging(0)
elif Parameters["Mode6"] == "null":
Domoticz.Debugging(0)
elif Parameters["Mode6"] == "Debug":
Domoticz.Debugging(-1)
else:
Domoticz.Debugging(int(Parameters["Mode6"]))
self.multiplier = int(Parameters['Mode1'])
self.deviceUpdate = Buffer(20) # Buffer up to 20 commands
if int(self.getDomoticzRevision()) < 9030:
Domoticz.Log("SNI connections are only available in Revision >= 9030. This plugin will not work")
else:
self.httpConn = Domoticz.Connection(Name="Hive Session", Transport="TCP/IP", Protocol="HTTPS", Address=self.sessionHost, Port="443")
self.httpConn.Connect() # Get a SessionId
self.deviceConn = Domoticz.Connection(Name="Hive Devices", Transport="TCP/IP", Protocol="HTTPS", Address=self.deviceHost, Port="443")
self.deviceUpdateConn = Domoticz.Connection(Name="Hive Device Update", Transport="TCP/IP", Protocol="HTTPS", Address=self.deviceHost, Port="443")
self.weatherConn = Domoticz.Connection(Name="Hive Weather", Transport="TCP/IP", Protocol="HTTPS", Address=self.weatherHost, Port="443")
def onStop(self):
return
# TODO: This does not work!
Domoticz.Log('Deleting Session')
url = '/omnia/auth/sessions/' + self.sessionId
self.httpConn.Connect()
self.httpConn.Send({'Verb':'DELETE','URL':url,'Headers':self.headers})
self.httpConn.Disconnect()
def onConnect(self, Connection, Status, Description):
Domoticz.Debug('onConnect called for ' + Connection.Name)
if (Connection.Name == 'Hive Session'):
if self.sessionId == '':
Domoticz.Debug('Creating Session')
self.headers = {'Content-Type': 'application/json',
'Accept': 'application/json',
'Host':self.sessionHost}
payload = {'username':Parameters["Username"],'password':Parameters["Password"]}
url = '/1.0/cognito/login'
data = json.dumps(payload).encode('ascii')
#Domoticz.Debug(str(data))
Connection.Send({'Verb':'POST','URL':url,'Headers':self.headers,'Data':data})
if (Connection.Name == 'Hive Devices'):
Domoticz.Debug('Getting Devices')
url = '/omnia/nodes'
Connection.Send({'Verb':'GET','URL':url,'Headers':self.headers})
if (Connection.Name == 'Hive Device Update'):
url = '/omnia/nodes'
while (self.deviceUpdate.get_size() > 0):
Domoticz.Debug('Updating Device')
deviceUpdate = self.deviceUpdate.pop_element()
self.updateDevice(deviceUpdate['Unit'],deviceUpdate['Command'],deviceUpdate['Level'],deviceUpdate['Hue'], Connection, url)
if (Connection.Name == 'Hive Weather'):
Domoticz.Debug('Getting Weather')
pc = str(Parameters['Mode3'])
pc = pc.replace(" ","") # strip spaces from postcode (if existing)
url = '/weather?postcode=' +str(pc) + '&country=GB'
Connection.Send({'Verb':'GET','URL':url,'Headers':self.weatherHeaders})
def onMessage(self, Connection, Data):
Domoticz.Debug('onMessage called for ' + Connection.Name)
if (Connection.Name == 'Hive Session'):
if (Data['Status'] == '200'):
r = Data['Data'].decode('UTF-8')
self.sessionId = json.loads(r)["token"]
Domoticz.Debug(self.sessionId)
self.headers = {'Content-Type': 'application/vnd.alertme.zoo-6.2+json',
'Accept': 'application/vnd.alertme.zoo-6.2+json',
'X-AlertMe-Client': 'Hive Web Dashboard',
'X-Omnia-Access-Token': self.sessionId,
'Host':self.deviceHost}
self.weatherHeaders = {'Content-Type': 'application/vnd.alertme.zoo-6.2+json',
'Accept': 'application/vnd.alertme.zoo-6.2+json',
'X-AlertMe-Client': 'Hive Web Dashboard',
'X-Omnia-Access-Token': self.sessionId,
'Host':self.weatherHost}
self.deviceConn.Connect() # Update the devices now
else:
Domoticz.Log("Error Creating Session")
Domoticz.Debug(Data['Status'])
self.httpConn.Disconnect()
if (Connection.Name == 'Hive Devices'):
if (Data['Status'] == '200'):
r = Data['Data'].decode('UTF-8')
nodes = json.loads(r)['nodes']
self.deviceConn.Disconnect()
self.UpdateDeviceState(nodes)
else:
self.deviceConn.Disconnect()
# Bad session?
Domoticz.Log("Error Getting Devices - Recreating Session")
self.sessionId = ''
self.httpConn.Connect()
if (Connection.Name == 'Hive Device Update'):
# The return data from a device update will only contain the info for that device
self.updateCounter -= 1 # Reduce the updateCounter
if (Data['Status'] == '200'):
r = Data['Data'].decode('UTF-8')
nodes = json.loads(r)['nodes']
self.UpdateDeviceState(nodes)
else:
Domoticz.Error("Update Device Failed")
if (self.updateCounter <= 0): # Disconnect if we are not expecting more updates to process
self.deviceUpdateConn.Disconnect()
if (Connection.Name == 'Hive Weather'):
if (Data['Status'] == '200'):
r = Data['Data'].decode('UTF-8')
try:
w = json.loads(r)['weather']
outsidetemp = w["temperature"]["value"]
except Exception as e:
w = False
Domoticz.Error(str(e))
try:
Domoticz.Debug("Finding Outside Device")
foundOutsideDevice = False
for unit in Devices:
if Devices[unit].DeviceID == "Hive_Outside":
Devices[unit].Update(nValue=int(outsidetemp), sValue=str(outsidetemp))
foundOutsideDevice = True
Domoticz.Debug("Outside Device Updated")
if foundOutsideDevice == False:
newUnit = self.GetNextUnit(False)
Domoticz.Device(Name = 'Outside',
Unit = newUnit,
TypeName = 'Temperature',
DeviceID = 'Hive_Outside').Create()
Domoticz.Debug("Outside Device Created: " + str(newUnit))
Devices[newUnit].Update(nValue=int(outsidetemp), sValue=str(outsidetemp))
except Exception as e:
Domoticz.Error(str(e))
else:
Domoticz.Error("Error getting weather information")
self.weatherConn.Disconnect()
def onCommand(self, Unit, Command, Level, Hue):
Domoticz.Debug('onCommand called for Unit ' + str(Unit) + ": Parameter '" + str(Command) + "', Level: " + str(Level))
if(self.deviceUpdateConn.Connected()):
Domoticz.Debug("Already connected so updateDevice")
self.updateDevice(Unit, Command, Level, Hue, self.deviceUpdateConn)
else:
try:
self.deviceUpdate.push_element({'Unit':Unit,'Command':Command,'Level':Level,'Hue':Hue})
except Exception as e:
Domoticz.Error(str(e)) # buffer is full
if(self.deviceUpdateConn.Connecting() == False):
self.deviceUpdateConn.Connect()
def onNotification(self, Name, Subject, Text, Status, Priority, Sound, ImageFile):
Domoticz.Debug('Notification: ' + Name + ',' + Subject + ',' + Text + ',' + Status + ',' + str(Priority) + ',' + Sound + ',' + ImageFile)
def onDisconnect(self, Connection):
Domoticz.Debug('onDisconnect called for ' + Connection.Name)
def onHeartbeat(self):
Domoticz.Debug('onHeartbeat called')
if self.counter >= self.multiplier:
Domoticz.Debug('Getting Data')
self.counter = 1
self.deviceConn.Connect()
if Parameters["Mode3"] != "":
Domoticz.Debug('Getting Weather')
self.weatherConn.Connect()
else:
self.counter += 1
Domoticz.Debug('Counter = ' + str(self.counter))
# Check if we have a stale connection
if self.updateCounter > 0:
# we are waiting for a message
self.updateCounterLast += 1
else:
# nothing waiting to be received
self.updateCounterLast = 0
if self.deviceUpdate.get_size() > 0: # Connect to clear down the buffer
self.deviceUpdateConn.Connect()
if self.updateCounterLast > 6: # Arbitrarily choose 6 heartbeats (1 minute)
self.updateCounter = 0 # clear the message queue
self.deviceUpdateConn.Disconnect()
def GetThermostat(self, d, ttype):
#ttype can be 'Heating' or 'HotWater'
thermostats = False
k = 'state'+ttype+'Relay'
x = find_key_in_list(d, 'http://alertme.com/schema/json/node.class.thermostat.json#')
if x:
for i in x:
if k in i['attributes']:
if thermostats:
thermostats.append(i)
else:
thermostats = [i]
return thermostats
def GetThermostatUI(self, d, parentNodeId):
thermostatui = False
x = find_key_in_list(d, 'http://alertme.com/schema/json/node.class.thermostatui.json#')
if not x: # Try a Hive2 thermostat
x = find_key_in_list(d,"Hive2")
if x:
for i in x:
try:
if i["relationships"]["boundNodes"][0]["id"] == parentNodeId:
thermostatui = i
except Exception as e:
Domoticz.Debug("Thermostatui - No boundNodes under relationship")
if len(x) == 1:
Domoticz.Debug("Only one thermostatui node so using that")
thermostatui = x[0]
return thermostatui
def GetLights(self, d):
lights = False
x = find_key_in_list(d,"http://alertme.com/schema/json/node.class.light.json#")
if x:
lights = x
return lights
def GetTunableLights(self, d):
lights = False
x = find_key_in_list(d,"http://alertme.com/schema/json/node.class.tunable.light.json#")
if x:
lights = x
return lights
def GetColourLights(self, d):
lights = False
x = find_key_in_list(d,"http://alertme.com/schema/json/node.class.colour.tunable.light.json#")
if x:
lights = x
return lights
def GetActivePlugs(self, d):
activeplugs = False
x = find_key_in_list(d,"http://alertme.com/schema/json/node.class.smartplug.json#")
if x:
activeplugs = x
return activeplugs
def GetNextUnit(self, unit):
if not unit:
nextUnit = len(Devices) + 1
else:
nextUnit = unit +1
if nextUnit in Devices or nextUnit < 1:
nextUnit = self.GetNextUnit(nextUnit)
return nextUnit
def UpdateDeviceState(self, d):
foundHotWaterDevice = False
foundOutsideDevice = False
Domoticz.Debug('Getting Temperatures')
thermostats = self.GetThermostat(d, 'Heating')
if thermostats:
for node in thermostats:
# TODO: add schedule switch to change toggle scheduled or off (chrelay switch toggles manual or off)
# TODO: add switch for boost mode (fix time to half an hour)
foundInsideDevice = False
foundTargetDevice = False
foundHeatingDevice = False
foundThermostatDevice = False
thermostat_battery = 0
thermostat_rssi = 0
# get the temperature and heating states
temp = node["attributes"]["temperature"]["reportedValue"]
Domoticz.Debug('Temp = ' + str(temp))
targetTemp = node["attributes"]["targetHeatTemperature"]["reportedValue"]
if targetTemp < 7.0: targetTemp = 7.0
Domoticz.Debug('Target = ' + str(targetTemp))
heating = node["attributes"]["stateHeatingRelay"]["reportedValue"]
Domoticz.Debug('Heating = ' + heating)
Domoticz.Debug('Getting Battery Status')
thermostatui = self.GetThermostatUI(d, node["parentNodeId"])
if (thermostatui):
# get the battery and rssi values
thermostat_battery = thermostatui["attributes"]["batteryLevel"]["reportedValue"]
Domoticz.Debug('Battery = ' + str(thermostat_battery))
thermostat_rssi = 12*((0 - thermostatui["attributes"]["RSSI"]["reportedValue"])/100)
Domoticz.Debug('RSSI = ' + str(thermostat_rssi))
# Loop through the devices and update temperatures
Domoticz.Debug('Updating Devices')
for unit in Devices:
if Devices[unit].DeviceID == node["name"]+"_Current":
Devices[unit].Update(nValue=int(temp), sValue=str(temp))
foundInsideDevice = True
if Devices[unit].DeviceID == node["name"]+"_Target":
Devices[unit].Update(nValue=int(targetTemp), sValue=str(targetTemp))
foundTargetDevice = True
if Devices[unit].DeviceID == node["id"] and Devices[unit].Type == 244: #if CH Switch device
foundHeatingDevice = True
if unit not in set(self.chrelaySet):
self.chrelaySet.add(unit)
if (thermostatui):
if thermostatui["attributes"]["presence"]["reportedValue"] == "ABSENT":
if self.TimedOutAvailable:
if Devices[unit].TimedOut == 0:
Devices[unit].Update(nValue=Devices[unit].nValue, sValue=Devices[unit].sValue, TimedOut=1)
else:
Domoticz.Log("Device Offline : " + Devices[unit].Name)
else:
if heating == 'ON':
if Devices[unit].nValue == 0:
if self.TimedOutAvailable:
Devices[unit].Update(nValue=1, sValue='On', TimedOut=0)
else:
Devices[unit].Update(nValue=1, sValue='On')
else:
if Devices[unit].nValue == 1:
if self.TimedOutAvailable:
Devices[unit].Update(nValue=0, sValue='Off', TimedOut=0)
else:
Devices[unit].Update(nValue=0, sValue='Off')
if Devices[unit].DeviceID == node['id'] and Devices[unit].Type == 242: #Thermostat
foundThermostatDevice = True
Devices[unit].Update(nValue = int(targetTemp),
sValue = str(targetTemp),
BatteryLevel = int(thermostat_battery),
SignalLevel = int(thermostat_rssi))
if foundInsideDevice == False and thermostatui:
Domoticz.Device(Name = thermostatui["name"] + ' - Current',
Unit = self.GetNextUnit(False),
TypeName = 'Temperature',
DeviceID = node["name"]+'_Current').Create()
self.counter = self.multiplier
if foundTargetDevice == False and thermostatui:
Domoticz.Device(Name = thermostatui["name"] + ' - Target',
Unit = self.GetNextUnit(False),
TypeName = 'Temperature',
DeviceID = node["name"]+'_Target').Create()
self.counter = self.multiplier
if foundHeatingDevice == False and thermostatui:
Domoticz.Device(Name = thermostatui["name"] + ' - Heating',
Unit = self.GetNextUnit(False),
TypeName = 'Switch',
Switchtype = 0,
DeviceID = node['id']).Create()
self.counter = self.multiplier
if foundThermostatDevice == False and thermostatui:
Domoticz.Device(Name = thermostatui["name"] + ' - Thermostat',
Unit = self.GetNextUnit(False),
Type = 242,
Subtype = 1,
DeviceID = node['id']).Create()
self.counter = self.multiplier
else:
Domoticz.Debug('No heating thermostat found')
thermostatsW = self.GetThermostat(d, 'HotWater')
if thermostatsW: # HotWater too...
thermostatW = thermostatsW[0]
hotwater = thermostatW["attributes"]["stateHotWaterRelay"]["reportedValue"]
for unit in Devices:
if Devices[unit].DeviceID == thermostatW["id"]:
foundHotWaterDevice = True
if unit not in set(self.hwrelaySet):
self.hwrelaySet.add(unit)
if (thermostatui):
if thermostatui["attributes"]["presence"]["reportedValue"] == "ABSENT":
if self.TimedOutAvailable:
if Devices[unit].TimedOut == 0:
Devices[unit].Update(nValue=Devices[unit].nValue, sValue=Devices[unit].sValue, TimedOut=1)
else:
Domoticz.Log("Device Offline : " + Devices[unit].Name)
else:
if hotwater == 'ON':
if Devices[unit].nValue == 0:
if self.TimedOutAvailable:
Devices[unit].Update(nValue=1, sValue='On', TimedOut=0)
else:
Devices[unit].Update(nValue=1, sValue='On')
else:
if Devices[unit].nValue == 1:
if self.TimedOutAvailable:
Devices[unit].Update(nValue=0, sValue='Off', TimedOut=0)
else:
Devices[unit].Update(nValue=0, sValue='Off')
if foundHotWaterDevice == False:
Domoticz.Device(Name = 'HotWater - Relay',
Unit = self.GetNextUnit(False),
TypeName = 'Switch',
Switchtype = 0,
DeviceID = thermostatW["id"]).Create()
self.counter = self.multiplier
else:
Domoticz.Debug('No hot water thermostat/relay found')
lights = self.GetLights(d)
tunablelights = self.GetTunableLights(d)
colourlights = self.GetColourLights(d)
if lights:
Domoticz.Debug("Found Standard Light(s)")
if colourlights:
Domoticz.Debug("Found Colour Light(s)")
lights += colourlights
if tunablelights:
Domoticz.Debug("Found Tunable Light(s)")
lights += tunablelights
else:
if tunablelights:
Domoticz.Debug("Found Tunable Light(s)")
lights += tunablelights
else:
if colourlights:
Domoticz.Debug("Found Colour Light(s)")
lights = colourlights
if tunablelights:
Domoticz.Debug("Found Tunable Light(s)")
lights += tunablelights
else:
if tunablelights:
Domoticz.Debug("Found Tunable Light(s)")
lights = tunablelights
if lights:
for node in lights:
Domoticz.Debug("Light detected " + node["name"])
rssi = 0
if "RSSI" in node["attributes"]:
rssi = 12*((0 - node["attributes"]["RSSI"]["reportedValue"])/100)
found = False
for unit in Devices:
if node['id'] == Devices[unit].DeviceID:
found = True
if unit not in set(self.lightsSet):
self.lightsSet.add(unit)
Domoticz.Debug(Devices[unit].Name + ": " + node["attributes"]["presence"]["reportedValue"])
if node["attributes"]["presence"]["reportedValue"] == "ABSENT":
if self.TimedOutAvailable:
if Devices[unit].TimedOut == 0:
Devices[unit].Update(nValue=0, sValue='Off', TimedOut=1, SignalLevel=0)
else:
Domoticz.Log("Device Offline : " + Devices[unit].Name)
else:
if "state" not in node["attributes"]:
Domoticz.Debug("No State")
break
# Work on targetValues (allows to update devices on the return of an update posted but not yet executed)
if ("targetValue" in node["attributes"]["state"] and node["attributes"]["state"]["targetValue"] == "OFF") or \
("targetValue" not in node["attributes"]["state"] and node["attributes"]["state"]["reportedValue"] == "OFF"):
if Devices[unit].nValue != 0: # Device not already off
if self.TimedOutAvailable:
Devices[unit].Update(nValue=0, sValue='Off', TimedOut=0, SignalLevel=int(rssi))
else:
Devices[unit].Update(nValue=0, sValue='Off', SignalLevel=int(rssi))
else: # Device is already off but could have been timed out
if self.TimedOutAvailable:
if Devices[unit].TimedOut:
Devices[unit].Update(nValue=0, sValue='Off', TimedOut=0, SignalLevel=int(rssi))
else:
if "targetValue" not in node["attributes"]["brightness"]:
node["attributes"]["brightness"]["targetValue"] = node["attributes"]["brightness"]["reportedValue"]
Domoticz.Debug("Brightness Target: " + str(Devices[unit].LastLevel))
Domoticz.Debug("Brightness: " + str(node["attributes"]["brightness"]["targetValue"]))
if Devices[unit].LastLevel != int(node["attributes"]["brightness"]["targetValue"]) or Devices[unit].sValue == 'Off':
if self.TimedOutAvailable:
if node["attributes"]["model"]["reportedValue"] == "RGBBulb01UK":
# Don't bother with colours as there is currently nowhere in domoticz to store these
# 1 = Set Level for rgbww dimmer
Devices[unit].Update(nValue=1,
sValue=str(node["attributes"]["brightness"]["targetValue"]),
TimedOut=0,
SignalLevel=int(rssi))
elif node["attributes"]["model"]["reportedValue"] == "TWBulb01UK" \
or node["attributes"]["model"]["reportedValue"] == "TWBulb01US" \
or node["attributes"]["model"]["reportedValue"] == "TWGU10Bulb01UK" \
or node["attributes"]["model"]["reportedValue"] == "FWCLBulb01UK" :
# 1 = Set Level for ww dimmer
Devices[unit].Update(nValue=1,
sValue=str(node["attributes"]["brightness"]["targetValue"]),
TimedOut=0,
SignalLevel=int(rssi))
elif node["attributes"]["model"]["reportedValue"] == "FWBulb01" \
or node["attributes"]["model"]["reportedValue"] == "FWBulb02UK":
# 2 = Set Level
Devices[unit].Update(nValue=2,
sValue=str(node["attributes"]["brightness"]["targetValue"]),
TimedOut=0,
SignalLevel=int(rssi))
else:
Domoticz.Debug("Unknown Light")
else:
# 2 = Set Level
Devices[unit].Update(nValue=2,
sValue=str(node["attributes"]["brightness"]["targetValue"]),
SignalLevel=int(rssi))
Domoticz.Debug("Light finished " + node["name"])
break
if not found:
Domoticz.Log("Light not found " + node["name"])
created = False
newUnit = self.GetNextUnit(False)
if node["attributes"]["model"]["reportedValue"] == "RGBBulb01UK":
# RGB WW CW Bulb
Domoticz.Device(Name = node["name"],
Unit = newUnit,
Type=241,
Subtype=4,
Switchtype=7,
DeviceID = node['id']).Create()
created = True
elif node["attributes"]["model"]["reportedValue"] == "TWBulb01UK" \
or node["attributes"]["model"]["reportedValue"] == "TWBulb01US" \
or node["attributes"]["model"]["reportedValue"] == "TWGU10Bulb01UK":
# TW CW Bulb
Domoticz.Device(Name = node["name"],
Unit = newUnit,
Type=241,
Subtype=8,
Switchtype=7,
DeviceID = node['id']).Create()
created = True
elif node["attributes"]["model"]["reportedValue"] == "FWBulb01" \
or node["attributes"]["model"]["reportedValue"] == "FWBulb02UK" \
or node["attributes"]["model"]["reportedValue"] == "FWCLBulb01UK":
# Standard dimmable light
Domoticz.Device(Name = node["name"],
Unit = newUnit,
Type=244,
Subtype=73,
Switchtype=7,
DeviceID = node['id']).Create()
created = True
else:
Domoticz.Debug("Unknown Light")
if created:
if node["attributes"]["presence"]["reportedValue"] == "ABSENT" \
or node["attributes"]["presence"]["reportedValue"] == "UNKNOWN":
Domoticz.Debug("New Device " + node["attributes"]["presence"]["reportedValue"].lower() + " " + str(newUnit))
if self.TimedOutAvailable:
Devices[newUnit].Update(nValue=0,
sValue="Off",
TimedOut=1,
SignalLevel=0)
else:
Devices[newUnit].Update(nValue=0,
sValue='Off',
SignalLevel=0)
elif node["attributes"]["state"]["reportedValue"] == "OFF":
Domoticz.Debug("New Device Off " + str(newUnit))
Devices[newUnit].Update(nValue=0,
sValue='Off',
SignalLevel=int(rssi))
else:
Domoticz.Debug("New Device On")
Devices[newUnit].Update(nValue=2,
sValue=str(node["attributes"]["brightness"]["reportedValue"]),
SignalLevel=int(rssi)) # 2 = Set Level
activeplugs = self.GetActivePlugs(d)
if activeplugs:
for node in activeplugs:
for unit in Devices:
# Active plugs also have internalTemperature, energyConsumed and powerConsumption
if "RSSI" in node["attributes"]:
rssi = 12*((0 - node["attributes"]["RSSI"]["reportedValue"])/100)
else:
rssi = 0
if node['id'] == Devices[unit].DeviceID and Devices[unit].Type == 244:
if unit not in set(self.activeplugsSet):
self.activeplugsSet.add(unit)
if node["attributes"]["presence"]["reportedValue"] == "ABSENT":
if self.TimedOutAvailable:
if Devices[unit].TimedOut == 0:
Devices[unit].Update(nValue=Devices[unit].nValue,
sValue=Devices[unit].sValue,
TimedOut=1,
SignalLevel=0)
else:
Domoticz.Log("Device Offline : " + Devices[unit].Name)
else:
if node["attributes"]["state"]["reportedValue"] == "OFF":
if Devices[unit].nValue != 0:
if self.TimedOutAvailable:
Devices[unit].Update(nValue=0, sValue='Off', TimedOut=0, SignalLevel=int(rssi))
else:
Devices[unit].Update(nValue=0, sValue='Off', SignalLevel=int(rssi))
else:
Domoticz.Debug("State: " + Devices[unit].sValue)
if Devices[unit].nValue != 1:
if self.TimedOutAvailable:
Devices[unit].Update(nValue=1, sValue='On', TimedOut=0, SignalLevel=int(rssi))
else:
Devices[unit].Update(nValue=1, sValue='On', SignalLevel=int(rssi))
if "internalTemperature" in node["attributes"]:
for unit1 in Devices:
if node['id'] == Devices[unit1].DeviceID and Devices[unit1].Type == 80:
Domoticz.Debug("ActivePlug Temperature found " + node["name"])
Devices[unit1].Update(nValue = 0, sValue = str(node["attributes"]["internalTemperature"]["reportedValue"]))
break
else:
# Create a temperature device to go with the plug
Domoticz.Debug("ActivePlug Temperature not found " + node["name"])
newUnit = self.GetNextUnit(False)
Domoticz.Device(Name = node["name"]+" - Temperature",
Unit = newUnit,
TypeName = "Temperature",
DeviceID = node['id']).Create()
Devices[newUnit].Update(nValue = 0, sValue = str(node["attributes"]["internalTemperature"]["reportedValue"]))
break
else:
Domoticz.Log("ActivePlug not found " + node["name"])
newUnit = self.GetNextUnit(False)
Domoticz.Device(Name = node["name"],
Unit = newUnit,
TypeName = "Switch",
Switchtype = 0,
DeviceID = node['id']).Create()
if "state" in node["attributes"]:
if node["attributes"]["state"]["reportedValue"] == "OFF":
Devices[newUnit].Update(nValue=0, sValue='Off', SignalLevel=int(rssi))
else:
Devices[newUnit].Update(nValue=1, sValue='On', SignalLevel=int(rssi))
else:
Devices[newUnit].Update(nValue=0, sValue='Off', SignalLevel=int(rssi))
if "internalTemperature" in node["attributes"]:
# Create a temperature device to go with the plug
newUnit = self.GetNextUnit(False)
Domoticz.Device(Name = node["name"]+" - Temperature",
Unit = newUnit,
TypeName = "Temperature",
DeviceID = node['id']).Create()
Devices[newUnit].Update(nValue = 0, sValue = str(node["attributes"]["internalTemperature"]["reportedValue"]))
def CreateLightPayload(self, State, Brightness, ColourMode = None, ColourTemperature = None, HsvSat = None):
# state ON or OFF
# brightness 0->100
# colourMode COLOUR or TUNABLE : switches from colour to temperature mode
# colourMode = COLOUR colourTemperature(hsvHue) - 0->359, hsvSat - 0->1
# colourMode = TUNABLE colourTemperature 2700->6535
response = {}
nodes = []
attributes = {}
state = {}
brightness = {}
state["targetValue"] = State
brightness["targetValue"] = Brightness
if ColourMode == None:
attributes["attributes"] = {"brightness":brightness,"state":state}
if ColourMode == "COLOUR":
colourMode = {}
hsvHue = {}
hsvSat = {}
colourMode["targetValue"] = ColourMode
hsvHue["targetValue"] = ColourTemperature
hsvSat["targetValue"] = HsvSat * 100
attributes["attributes"] = {"brightness":brightness,"state":state,"colourMode":colourMode,"hsvHue":hsvHue,"hsvSaturation":hsvSat}
if ColourMode == "TUNABLE":
colourMode = {}
colourTemperature = {}
colourMode["targetValue"] = ColourMode
colourTemperature["targetValue"] = ColourTemperature
attributes["attributes"] = {"brightness":brightness,"state":state,"colourMode":colourMode,"colourTemperature":colourTemperature}
nodes.append(attributes)
response["nodes"] = nodes
return response
def CreateThermostatPayload(self, Temperature):
response = {}
nodes = []
attributes = {}
targetHeatTemperature = {}
targetHeatTemperature["targetValue"] = Temperature
attributes["attributes"] = {"targetHeatTemperature":targetHeatTemperature}
nodes.append(attributes)
response["nodes"] = nodes
return response
def CreateActivePlugPayload(self, State):
response = {}
nodes = []
attributes = {}
state = {}
state["targetValue"] = State
attributes["attributes"] = {"state":state}
nodes.append(attributes)
response["nodes"] = nodes
return response
def CreateHotWaterPayload(self, State):
response = {}
nodes = []
attributes = {}
if State == "HEAT":
Domoticz.Debug('HW On')
attributes["attributes"] = {"activeHeatCoolMode": {"targetValue": "HEAT"},"activeScheduleLock": {"targetValue": "True"}}
if State == "OFF":
Domoticz.Debug('HW Off')
attributes["attributes"] = {"activeHeatCoolMode": {"targetValue": "OFF"},"activeScheduleLock": {"targetValue": "False"}}
nodes.append(attributes)
response["nodes"] = nodes
return response
def CreateCentralHeatingPayload(self, State):
response = {}
nodes = []
attributes = {}
if State == "HEAT":
Domoticz.Debug('CH On')
attributes["attributes"] = {"activeHeatCoolMode": {"targetValue": "HEAT"},"activeScheduleLock": {"targetValue": "True"}}
if State == "OFF":
Domoticz.Debug('CH Off')
attributes["attributes"] = {"activeHeatCoolMode": {"targetValue": "OFF"},"activeScheduleLock": {"targetValue": "False"}}
nodes.append(attributes)
response["nodes"] = nodes
return response
def isLight(self, Unit):
Domoticz.Debug(str(self.lightsSet))
if Devices[Unit].Type == 244 and Devices[Unit].SubType == 73 and Unit in self.lightsSet:
Domoticz.Debug(str(Unit) + " is Active Light")
return True
elif Devices[Unit].Type == 241 and Devices[Unit].SubType == 4 and Unit in self.lightsSet:
Domoticz.Debug(str(Unit) + " is RGB Light")
return True
elif Devices[Unit].Type == 241 and Devices[Unit].SubType == 8 and Unit in self.lightsSet:
Domoticz.Debug(str(Unit) + " is WW/CW Light")
return True
else:
return False
def isThermostat(self, Unit):
if Devices[Unit].Type == 242:
return True
else:
return False
def isActivePlug(self, Unit):
if Devices[Unit].Type == 244 and Devices[Unit].SubType == 73 and Unit in self.activeplugsSet:
return True
else:
return False
def isHotWaterRelay(self, Unit):
if Unit in self.hwrelaySet:
return True
else:
return False
def isCentralHeatingRelay(self, Unit):
Domoticz.Debug(str(self.chrelaySet))
if Unit in self.chrelaySet:
return True
else:
return False
def getDomoticzRevision(self):
Revision = 8650 #Min version that supports all the features required -1
if 'DomoticzVersion' in Parameters:
Domoticz.Log("DomoticzVersion Available " + Parameters['DomoticzVersion'])
if int(Parameters['DomoticzVersion'].split(".")[0]) > 4:
Domoticz.Debug("Post-2020.2 build found")
# We don't worry about revisions post 2020
Revision = 9031
else:
Domoticz.Debug("Pre-2020.2 build found")
Revision = Parameters['DomoticzVersion'].split(".")[1]
Domoticz.Debug("Domoticz Revision: " + str(Revision))
return Revision
def updateDevice(self, Unit, Command, Level, Hue, Connection, url="/omnia/nodes"):
Domoticz.Debug(
'updateDevice called for Unit ' + str(Unit) + ": Parameter '" + str(Command) + "', Level: " + str(Level))
Domoticz.Debug(str(Devices[Unit].Type))
Domoticz.Debug(str(Devices[Unit].SubType))
Domoticz.Debug(Devices[Unit].DeviceID)
Domoticz.Debug(str(Devices[Unit].sValue))
payload = ""
if self.isLight(Unit):
Domoticz.Log("Setting Light Parameters")
if str(Command) == "Set Level":
payload = self.CreateLightPayload("ON", Level)
if str(Command) == "On":
payload = self.CreateLightPayload("ON", Devices[Unit].LastLevel)
if str(Command) == "Off":
payload = self.CreateLightPayload("OFF", Devices[Unit].LastLevel)
if str(Command) == "Set Color":
Domoticz.Debug(Hue)
colourDict = json.loads(Hue)
colourMode = colourDict.get("m")
if colourMode == 2:
# white temp
colourTemp = 6533 - (colourDict.get("t") * 15)
Domoticz.Debug(str(colourTemp))
payload = self.CreateLightPayload("ON", Level, "TUNABLE", colourTemp)
elif colourMode == 3:
# rgb colour
h, s, v = rgb2hsv(colourDict.get("r"), colourDict.get("g"), colourDict.get("b"))
Domoticz.Debug(str(h) + " " + str(s) + " " + str(v))
payload = self.CreateLightPayload("ON", Level, "COLOUR", h, s)
else:
Domoticz.Log("Colour Mode not supported: " + str(colourMode))
elif self.isThermostat(Unit):
Domoticz.Log("Setting Thermostat Level")
payload = self.CreateThermostatPayload(Level)
elif self.isActivePlug(Unit):
Domoticz.Log("Setting ActivePlug State")
if str(Command) == "On":
payload = self.CreateActivePlugPayload("ON")
if str(Command) == "Off":
payload = self.CreateActivePlugPayload("OFF")
elif self.isHotWaterRelay(Unit):
Domoticz.Log("Setting Hot Water Relay State")
if str(Command) == "On":
payload = self.CreateHotWaterPayload("HEAT") # Android APP Shows as On
if str(Command) == "Off":
payload = self.CreateHotWaterPayload("OFF") # Android APP shows as Off
elif self.isCentralHeatingRelay(Unit):
Domoticz.Log("Setting Central Heating Relay State")
if str(Command) == "On":
payload = self.CreateCentralHeatingPayload(
"HEAT") # Android APP Shows as Manual (Governed by Thermostat setting)
if str(Command) == "Off":
payload = self.CreateCentralHeatingPayload("OFF") # Android APP shows as Off
else:
Domoticz.Log("Unknown Device Type")
payload = ""
if payload != "":
data = json.dumps(payload)
Connection.Send({'Verb': 'PUT', 'URL': url + '/' + Devices[Unit].DeviceID, 'Headers': self.headers, 'Data': data})
self.updateCounter += 1
_plugin = BasePlugin()
def onStart():
_plugin.onStart()
def onStop():
_plugin.onStop()
def onConnect(Connection, Status, Description):
_plugin.onConnect(Connection, Status, Description)
def onMessage(Connection, Data):
_plugin.onMessage(Connection, Data)
def onCommand(Unit, Command, Level, Hue):
_plugin.onCommand(Unit, Command, Level, Hue)
def onNotification(Name, Subject, Text, Status, Priority, Sound, ImageFile):
_plugin.onNotification(Name, Subject, Text, Status, Priority, Sound, ImageFile)
def onDisconnect(Connection):
_plugin.onDisconnect(Connection)
def onHeartbeat():
_plugin.onHeartbeat()
def DumpConfigToLog():
for x in Parameters:
if Parameters[x] != '':
Domoticz.Debug("'" + x + "':'" + str(Parameters[x]) + "'")
Domoticz.Debug('Device count: ' + str(len(Devices)))
for x in Devices:
Domoticz.Debug('Device: ' + str(x) + ' - ' + str(Devices[x]))
Domoticz.Debug("Device ID: '" + str(Devices[x].ID) + "'")
Domoticz.Debug("Device Name: '" + Devices[x].Name + "'")
Domoticz.Debug('Device nValue: ' + str(Devices[x].nValue))
Domoticz.Debug("Device sValue: '" + Devices[x].sValue + "'")
Domoticz.Debug('Device LastLevel: ' + str(Devices[x].LastLevel))
Domoticz.Debug('Device Timed Out: ' + str(Devices[x].TimedOut))
def find_key_in_list(d, value):
if isinstance(d, list):
t = list(d)
for v in d:
if isinstance(v, dict):
p = find_key(v, value)
if not p:
t.remove(v)
return t
def find_key(d, value):
for (k, v) in d.items():
if isinstance(v, dict):
p = find_key(v, value)
if p:
return [k] + p
elif v == value:
return [k]
def merge_dicts(*dict_args):
'''
Given any number of dicts, shallow copy and merge into a new dict,
precedence goes to key value pairs in latter dicts.
'''
result = { }
for dictionary in dict_args:
result.update(dictionary)
return result
def rgb2hsv(r, g, b):
r, g, b = r/255.0, g/255.0, b/255.0
mx = max(r, g, b)
mn = min(r, g, b)
df = mx-mn
if mx == mn:
h = 0
elif mx == r:
h = (60 * ((g-b)/df) + 360) % 360
elif mx == g:
h = (60 * ((b-r)/df) + 120) % 360
elif mx == b:
h = (60 * ((r-g)/df) + 240) % 360
if mx == 0:
s = 0
else:
s = df/mx
v = mx
return h, s, v
def DumpHTTPResponseToLog(httpDict):
if isinstance(httpDict, dict):
Domoticz.Log("HTTP Details ("+str(len(httpDict))+"):")
for x in httpDict:
if isinstance(httpDict[x], dict):
Domoticz.Log("--->'"+x+" ("+str(len(httpDict[x]))+"):")
for y in httpDict[x]:
Domoticz.Log("------->'" + y + "':'" + str(httpDict[x][y]) + "'")
else:
Domoticz.Log("--->'" + x + "':'" + str(httpDict[x]) + "'")
class Buffer:
def __init__(self, capacity):
self.buffer = [0] * capacity
self.size = 0
self.capacity = capacity