forked from 999LV/DomoticzBridge
-
Notifications
You must be signed in to change notification settings - Fork 0
/
L_DomoticzBridge.lua
1152 lines (1030 loc) · 49.3 KB
/
L_DomoticzBridge.lua
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
ABOUT = {
NAME = "DomoticzBridge",
VERSION = "0.20",
DESCRIPTION = "Domoticz Bridge plugin for openLuup, based on VeraBridge",
AUTHOR = "@logread, based on code from @akbooer",
COPYRIGHT = "(c) 2016 logread",
DOCUMENTATION = "https://github.com/999LV/DomoticzBridge/raw/master/documentation/DomoticzBridge.pdf",
}
--[[
bi-directional monitor/control link to remote Domoticz system
it is based on @Akbooer's VeraBridge plugin, modified as follows
NB. this version ONLY works in openLuup
it plays with action calls and device creation in ways that you can't do in Vera,
in order to be able to implement ANY command action and
also to logically group device numbers for remote machine device clones.
2016-08-06 alpha version 0.01 to prove concept
2016-08-19 alpha version 0.05 functional with basic test set of devices
2016-08-20 alpha verison 0.06 simplify translation of luup actions into Domoticz API calls
+ added dimmer device - still debug needed though
2016-08-21 alpha version 0.07 improved actions code - dimmer device and PushOnButton bugs corrected
2016-08-21 alpha version 0.08 smoke sensor and tripped info for both smoke and motion sensors
2016-08-22 alpha version 0.09 major change to device creation... add all default variables, not just the ones cloned from Domoticz
2016-08-26 alpha version 0.10 code optimization and cleanup for Domoticz API calls
2016-08-26 alpha version 0.11 WIP: variable change function to address some device actions (e.g. security sensors armed/tripped)
2016-08-31 alpha version 0.12 first public release on Alt App Store
2016-11-24 beta version 0.13 bug fix for dimmers/blinds level
2016-11-28 beta version 0.14 added support for power meters
2016-12-13 beta version 0.15 implemented device mirroring from openLuup to Domoticz
+ improved remote devices polling and actions handling code
+ bugfix for excluded devices
+ bugfix for multiple Vera or Domoticz bridges !!!
- known bug to fix in future version: possible timeout on action http calls (but action handling works,
just the feeback sometimes times out)
2017-01-09 beta version 0.16 support for domoticz contact sensors (door sensor in openLuup)
+ bugfix in openLuup domoticz script to avoid timeout on certain http calls
2021-02-06 beta version 0.20 PerH updates plugin 0.2 to work with OpenLuup
+ Changes connection to Rooms from Require "openluup.rooms" to just "luup.rooms"
+ Uses Device number offset from current VeraBridge
+ Minor UI updates
+ Added Barometer definition (line 137 and 570)
+ Added DoorContact definition (line 260 and 574)
+ Corrected "GetUserData" error handling to prevent room assignments beig reset is Domoticz Connection is lost.
This program is free software: you can redistribute it and/or modify
it under the condition that it is for private or home useage and
this whole comment is reproduced in the source code file.
Commercial utilisation is not authorized without the appropriate
written agreement from "logread", contact by PM on http://forum.micasaverde.com/
This program 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.
-]]
local devNo -- our device number
local DZport = "8080" -- default port of the Domoticz server
local bridgestypes = "VeraBridge, DomoticzBridge" --[[ device types that need to be checked for multiple bridges present
and proper offset calculations ]]
local chdev = require "openLuup.chdev"
local json = require "openLuup.json"
local scenes = require "openLuup.scenes"
local userdata = require "openLuup.userdata"
local url = require "socket.url"
local lfs = require "lfs"
local loader = require "openLuup.loader" -- thank @akbooer for the hint about device file info
local http = require "socket.http"
local SID_DZB = "urn:upnp-org:serviceId:DomoticzBridge:1"
local pollmap = {} -- table of local/remote variables polling loop and update handlers
local actionmap = {} -- bi-directional index for device actions
local cloneddevmap = {} -- index table of cloned variables for each cloned device idx
local actionhash = {} -- reverse lookup hash table for device/service/action index to actionmap index
local ip -- remote machine ip address
local POLL_DELAY = 60 -- number of seconds between remote polls
local local_room_index -- bi-directional index of our rooms
local remote_room_index -- bi-directional of remote rooms
local BuildVersion -- ...of remote machine
local SID = {
altui = "urn:upnp-org:serviceId:altui1" , -- Variables = 'DisplayLine1' and 'DisplayLine2'
gateway = "urn:upnp-org:serviceId:DomoticzBridge:1", --"urn:akbooer-com:serviceId:VeraBridge1",
hag = "urn:micasaverde-com:serviceId:HomeAutomationGateway1",
}
local Mirrored -- mirrors is a set of device IDs for 'reverse bridging', not to be cloned
local MirrorHash -- reverse lookup: local hash to remote device ID
local MirrorValue -- added by logread... type of value (nvalue or svalue) for the mirror device setting
local HouseModeMirror -- flag with one of the following options
local HouseModeTime = 0 -- last time we checked
local HouseModeOptions = { -- 2016.05.23
['0'] = "0 : no mirroring",
['1'] = "1 : local mirrors remote",
['2'] = "2 : remote mirrors local",
}
-- @explorer options for device filtering
local ZWaveOnly, Included, Excluded
--[[ the DZ2VeraMap allows matching a given (known) Domoticz device type/subtype with the closest possible device type in openLuup.
the device_file key is used to create the relevant device (a call to openLuup's loader module gathers the other required data);
the states table is mapping the Domoticz variables to the appropriate openLuup ones. For now, there is no attempt to create/use
any other services/variables than the ones in this table
--]]
local DZ2VeraMap = {
Temp = {
device_file = "D_TemperatureSensor1.xml",
states = {
{service = "urn:upnp-org:serviceId:TemperatureSensor1", variable = "CurrentTemperature", DZData = "Temp"},
{service = "urn:micasaverde-com:serviceId:HaDevice1", variable = "BatteryLevel", DZData = "BatteryLevel"}
},
actions = {
{service = "urn:upnp-org:serviceId:TemperatureSensor1",
action = "SetVariable", name = "CurrentTemperature",
command = "udevice&idx=%d&nvalue=0&svalue=%d" }
}
},
Humidity = {
device_file = "D_HumiditySensor1.xml",
states = {
{service = "urn:micasaverde-com:serviceId:HumiditySensor1", variable = "CurrentLevel", DZData = "Humidity"},
{service = "urn:micasaverde-com:serviceId:HaDevice1", variable = "BatteryLevel", DZData = "BatteryLevel"}
},
actions = {
{service = "urn:micasaverde-com:serviceId:HumiditySensor1",
action = "SetVariable", name = "CurrentLevel",
command = "udevice&idx=%d&nvalue=%d&svalue=0"} -- need to be tested... nvalue with % or not ? svalue can be "" ?
}
},
Barometer = {
device_file = "D_BarometerSensor1.xml",
states = {
{service = "urn:upnp-org:serviceId:BarometerSensor1", variable = "CurrentPressure", DZData = "Barometer"},
{service = "urn:upnp-org:serviceId:BarometerSensor1", variable = "Forecast", DZData = "ForecastStr"},
{service = "urn:micasaverde-com:serviceId:HaDevice1", variable = "BatteryLevel", DZData = "BatteryLevel"}
},
actions = {
{service = "urn:micasaverde-com:serviceId:BarometerSensor1",
action = "SetVariable", name = "CurrentPressure",
command = "udevice&idx=%d&nvalue=%d&svalue=0"}
}
},
TempHumidityBaro = { -- original data = "Temp + Humidity + Baro"
device_file = "D_ComboDevice1.xml",
states = {
{service = "urn:upnp-org:serviceId:TemperatureSensor1", variable = "CurrentTemperature", DZData = "Temp"},
{service = "urn:micasaverde-com:serviceId:HumiditySensor1", variable = "CurrentLevel", DZData = "Humidity"},
{service = "urn:upnp-org:serviceId:altui1", variable = "DisplayLine1", DZData = "Data"},
{service = "urn:micasaverde-com:serviceId:HaDevice1", variable = "BatteryLevel", DZData = "BatteryLevel"}
}
},
SwitchOnOff = { -- original data = "Light/Switch", with SubType to be refined
device_file = "D_BinaryLight1.xml",
states = {
{service = "urn:upnp-org:serviceId:SwitchPower1", variable = "Status", DZData = "Status", boolean = true},
-- {service = "urn:upnp-org:serviceId:SwitchPower1", variable = "Target", DZData = "Status", boolean = true},
{service = "urn:micasaverde-com:serviceId:HaDevice1", variable = "BatteryLevel", DZData = "BatteryLevel"}
},
actions = {
{service = "urn:upnp-org:serviceId:SwitchPower1",
action = "SetTarget", name = "newTargetValue",
command = "switchlight&idx=%d&switchcmd=%s", boolean = true}
}
},
PushOnButton = { -- original data = "Lighting 2", with SubType = "AC" and SwitchType = "Push On Button"
device_file = "D_BinaryLight1.xml",
states = {
{service = "urn:upnp-org:serviceId:SwitchPower1", variable = "Status", DZData = "Data", boolean = true},
{service = "urn:micasaverde-com:serviceId:HaDevice1", variable = "BatteryLevel", DZData = "BatteryLevel"}
},
actions = {
{service = "urn:upnp-org:serviceId:SwitchPower1",
action = "SetTarget", name = "newTargetValue",
command = "switchlight&idx=%d&switchcmd=%s", boolean = true}
}
},
Dimmer = { -- original data = ""Light/Switch", with SubType = "Selector Switch" and SwitchType = "Dimmer"
device_file = "D_DimmableLight1.xml",
states = {
{service = "urn:upnp-org:serviceId:Dimming1", variable = "LoadLevelTarget", DZData = "Level"},
{service = "urn:upnp-org:serviceId:Dimming1", variable = "LoadLevelStatus", DZData = "Level"},
{service = "urn:upnp-org:serviceId:SwitchPower1", variable = "Status", DZData = "Status", boolean = true},
{service = "urn:micasaverde-com:serviceId:HaDevice1", variable = "BatteryLevel", DZData = "BatteryLevel"}
},
actions = {
{service = "urn:upnp-org:serviceId:Dimming1",
action = "SetLoadLevelTarget", name = "newLoadlevelTarget",
command = "switchlight&idx=%d&switchcmd=Set%%20Level&level=%d"},
{service = "urn:upnp-org:serviceId:SwitchPower1",
action = "SetTarget", name = "newTargetValue",
command = "switchlight&idx=%d&switchcmd=%s", boolean = true}
}
},
Blinds = { -- original data = ""Light/Switch", with SubType = "Switch" and SwitchType includes "Blinds"
device_file = "D_WindowCovering1.xml",
states = {
{service = "urn:upnp-org:serviceId:SwitchPower1", variable = "Status", DZData = "Status", boolean = true},
{service = "urn:upnp-org:serviceId:Dimming1", variable = "LoadLevelStatus", DZData = "Level"},
{service = "urn:upnp-org:serviceId:Dimming1", variable = "LoadLevelTarget", DZData = "Level"},
{service = "urn:micasaverde-com:serviceId:HaDevice1", variable = "BatteryLevel", DZData = "BatteryLevel"}
},
actions = {
{service = "urn:upnp-org:serviceId:Dimming1",
action = "SetLoadLevelTarget", name = "newLoadlevelTarget",
command = "switchlight&idx=%d&switchcmd=%s", boolean = true, inverted = true}, -- &level=0
-- {service = "urn:upnp-org:serviceId:Dimming1",
-- action = "SetLoadLevelTarget", name = "newLoadlevelTarget",
-- command = "switchlight&idx=%d&switchcmd=Set%%20Level&level=%d"},
{service = "urn:upnp-org:serviceId:WindowCovering1",
action = "Stop", name = "",
command = "switchlight&idx=%d&switchcmd=Stop"} -- &level=0
}
},
MotionSensor = { -- original Type = "Light/Switch" with SubType = "Switch" and SwitchType = "Motion Sensor"
device_file = "D_MotionSensor1.xml",
states = {
{service = "urn:micasaverde-com:serviceId:SecuritySensor1", variable = "Tripped", DZData = "Status", boolean = true},
-- {service = "urn:micasaverde-com:serviceId:SecuritySensor1", variable = "LastTrip", DZData = "LastUpdate", epoch = true},
{service = "urn:micasaverde-com:serviceId:HaDevice1", variable = "BatteryLevel", DZData = "BatteryLevel"}
},
actions = {
{service = "urn:micasaverde-com:serviceId:SecuritySensor1",
action = "SetArmed", name = "newArmedValue",
command = "Armed", self = true}
}
},
SmokeDetector = { -- original Type = "Light/Switch" with SubType = "Switch" and SwitchType = "Smoke Detector"
device_file = "D_SmokeSensor1.xml",
states = {
{service = "urn:micasaverde-com:serviceId:SecuritySensor1", variable = "Tripped", DZData = "Status", boolean = true},
-- {service = "urn:micasaverde-com:serviceId:SecuritySensor1", variable = "LastTrip", DZData = "LastUpdate", epoch = true},
{service = "urn:micasaverde-com:serviceId:HaDevice1", variable = "BatteryLevel", DZData = "BatteryLevel"}
},
actions = {
{service = "urn:micasaverde-com:serviceId:SecuritySensor1",
action = "SetArmed", name = "newArmedValue",
command = "Armed", self = true}
}
},
Contact = { -- original Type = "Light/Switch" with SubType = "Switch" and SwitchType = "Contact"
device_file = "D_DoorSensor1.xml",
states = {
{service = "urn:micasaverde-com:serviceId:SecuritySensor1", variable = "Tripped", DZData = "Status", contact = true},
-- {service = "urn:micasaverde-com:serviceId:SecuritySensor1", variable = "LastTrip", DZData = "LastUpdate", epoch = true},
{service = "urn:micasaverde-com:serviceId:HaDevice1", variable = "BatteryLevel", DZData = "BatteryLevel"}
},
actions = {
{service = "urn:micasaverde-com:serviceId:SecuritySensor1",
action = "SetArmed", name = "newArmedValue",
command = "Armed", self = true}
}
},
DoorContact = { -- original Type = "Light/Switch" with SubType = "Switch" and SwitchType = "Contact"
device_file = "D_DoorSensor1.xml",
states = {
{service = "urn:micasaverde-com:serviceId:SecuritySensor1", variable = "Tripped", DZData = "Status", contact = true},
-- {service = "urn:micasaverde-com:serviceId:SecuritySensor1", variable = "LastTrip", DZData = "LastUpdate", epoch = true},
{service = "urn:micasaverde-com:serviceId:HaDevice1", variable = "BatteryLevel", DZData = "BatteryLevel"}
},
actions = {
{service = "urn:micasaverde-com:serviceId:SecuritySensor1",
action = "SetArmed", name = "newArmedValue",
command = "Armed", self = true}
}
},
Lux = {
device_file = "D_LightSensor1.xml",
states = {
{service = "urn:micasaverde-com:serviceId:LightSensor1", variable = "CurrentLevel", DZData = "Data", pattern = "[^%d]"},
{service = "urn:micasaverde-com:serviceId:HaDevice1", variable = "BatteryLevel", DZData = "BatteryLevel"}
}
},
ElectricMeter = { -- original Type = "General" with SubType = "kWh"
device_file = "D_PowerMeter1.xml",
states = {
{service = "urn:micasaverde-com:serviceId:EnergyMetering1", variable = "Watts", DZData = "Usage", pattern = " Watt"},
{service = "urn:micasaverde-com:serviceId:EnergyMetering1", variable = "KWH", DZData = "Data", pattern = " kWh"},
{service = "urn:micasaverde-com:serviceId:HaDevice1", variable = "BatteryLevel", DZData = "BatteryLevel"}
}
},
ElectricUsage = { -- original Type = "Usage" with SubType = "Electric"
device_file = "D_PowerMeter1.xml",
states = {
{service = "urn:micasaverde-com:serviceId:EnergyMetering1", variable = "Watts", DZData = "Data", pattern = " Watt"},
{service = "urn:micasaverde-com:serviceId:HaDevice1", variable = "BatteryLevel", DZData = "BatteryLevel"}
}
},
Generic = {
device_file = "D_GenericSensor1.xml",
states = {
{service = "urn:micasaverde-com:serviceId:GenericSensor1", variable = "CurrentLevel", DZData = "Data"},
{service = "urn:upnp-org:serviceId:altui1", variable = "DisplayLine1", DZData = "Data"},
{service = "urn:micasaverde-com:serviceId:HaDevice1", variable = "BatteryLevel", DZData = "BatteryLevel"}
}
}
}
--------------------------------------------------------------------------------------------------
-- Logread's utility functions
local function nicelog(message)
local display = "Domoticz Bridge : %s"
message = message or ""
if type(message) == "table" then message = table.concat(message) end
luup.log(string.format(display, message))
-- print(string.format(display, message))
end
-- shallow-copy a table
local function tablecopy(t)
if type(t) ~= "table" then return t end
local meta = getmetatable(t)
local target = {}
for k, v in pairs(t) do target[k] = v end
setmetatable(target, meta)
return target
end
-- converts a Domoticz date string to a Unix epoch
local function datetoepoch(datestring)
local template = "(%d+)-(%d+)-(%d+) (%d+):(%d+):(%d+)"
local year, month, day, hour, minutes, seconds = datestring:match(template)
return os.time{year=year, month=month, day=day, hour=hour, min=minutes, sec=seconds}
end
-- revised "is_to_be_cloned" function to just work with a Domoticz idx
local function is_dev_to_be_cloned(idx)
idx = tonumber(idx) or 0
return not(Excluded[idx] or Mirrored[idx])
end
--[[
**************************************************************************************************************************
* THIS SECTION HOLDS ORIGINAL VERA BRIDGE FUNCTIONS INTERFACING WITH OPENLUUP *
**************************************************************************************************************************
--]]
-- LUUP utility functions
local function getVar (name, service, device)
service = service or SID.gateway
device = device or devNo
local x = luup.variable_get (service, name, device)
return x
end
local function setVar (name, value, service, device)
service = service or SID.gateway
device = device or devNo
local old = luup.variable_get (service, name, device)
if tostring(value) ~= old then
luup.variable_set (service, name, value, device)
return true
else
return false
end
end
-- get and check UI variables
local function uiVar (name, default, lower, upper)
local value = getVar (name)
local oldvalue = value
if value and (value ~= "") then -- bounds check if required
if lower and (tonumber (value) < lower) then value = lower end
if upper and (tonumber (value) > upper) then value = upper end
else
value = default
end
value = tostring (value)
if value ~= oldvalue then setVar (name, value) end -- default or limits may have modified value
return value
end
-- given a string of numbers s = "n, m, ..." convert to a set (for easy indexing)
local function convert_to_set (s)
local set = {}
for a in s: gmatch "%d+" do
local n = tonumber (a)
if n then set[n] = true end
end
return set
end
-----------
-- mapping between remote and local device IDs
local OFFSET -- offset to base of new device numbering scheme
local BLOCKSIZE = 10000 -- size of each block of device and scene IDs allocated
local Zwave = {} -- list of Zwave Controller IDs to map without device number translation
local function local_by_remote_id (id)
return Zwave[id] or id + OFFSET
end
local function remote_by_local_id (id)
return Zwave[id] or id - OFFSET
end
-- change parent of given device, and ensure that it handles child actions
local function set_parent (devNo, newParent)
local dev = luup.devices[devNo]
if dev then
local meta = getmetatable(dev).__index
nicelog("device[" .. devNo .. "] parent set to " .. newParent)
meta.handle_children = true -- handle Zwave actions
dev.device_num_parent = newParent -- parent resides in two places under different names !!
dev.attributes.id_parent = newParent
end
end
-- create bi-directional indices of rooms: room name <--> room number
local function index_rooms (rooms)
local room_index = {}
for number, name in pairs (rooms) do
local roomNo = tonumber (number) -- user_data may return string, not number
room_index[roomNo] = name
room_index[name] = roomNo
end
return room_index
end
-- make a list of our existing children, counting grand-children, etc.!!!
local function existing_children (parent)
local c = {}
local function children_of (d,index)
for _, child in ipairs (index[d] or {}) do
c[child] = luup.devices[child]
children_of (child, index)
end
end
local idx = {}
for child, dev in pairs (luup.devices) do
local num = dev.device_num_parent
local children = idx[num] or {}
children[#children+1] = child
idx[num] = children
end
children_of (parent, idx)
return c
end
-- create a new device, cloning the remote one
local function create_new (cloneId, dev, room)
--[[
hidden = nil,
pluginnum = d.plugin,
disabled = d.disabled,
--]]
local d = chdev.create {
devNo = cloneId,
device_type = dev.device_type,
internal_id = tostring(dev.altid or ''),
invisible = dev.invisible == "1", -- might be invisible, eg. Zwave and Scene controllers
json_file = dev.device_json,
description = dev.name,
upnp_file = dev.device_file,
upnp_impl = 'X', -- override device file's implementation definition... musn't run here!
parent = devNo,
password = dev.password,
room = room,
statevariables = dev.states,
username = dev.username,
ip = dev.ip,
mac = dev.mac,
}
luup.devices[cloneId] = d -- remember to put into the devices table! (chdev.create doesn't do that)
end
-- ensure that all the parent/child relationships are correct
local function build_families (devices)
for _, dev in pairs (devices) do -- once again, this 'devices' table is from the 'user_data' request
local cloneId = local_by_remote_id (dev.id)
local parentId = local_by_remote_id (tonumber (dev.id_parent) or 0)
if parentId == OFFSET then parentId = devNo end -- the bridge is the "device 0" surrogate
local clone = luup.devices[cloneId]
local parent = luup.devices[parentId]
if clone and parent then
set_parent (cloneId, parentId)
end
end
end
-- return true if device is to be cloned
-- note: these are REMOTE devices from the Domoticz status request
-- consider: Excluded or Mirrored, a sequence of "remote = local" device IDs for 'reverse bridging'
-- plus @explorer modification
-- see: http://forum.micasaverde.com/index.php/topic,37753.msg282098.html#msg282098
local function is_to_be_cloned (dev)
local d = tonumber (dev.id)
local p = tonumber (dev.id_parent)
local zwave = p == 1 or d == 1
if ZWaveOnly and p then -- see if it's a child of the remote zwave device
local i = local_by_remote_id(p)
if i and luup.devices[i] then zwave = true end
end
return not (Excluded[d] or Mirrored[d])
and (Included[d] or (not ZWaveOnly) or (ZWaveOnly and zwave) )
end
-- create the child devices managed by the bridge
local function create_children (devices, room)
local N = 0
local list = {} -- list of created or deleted devices (for logging)
local something_changed = false
local current = existing_children (devNo)
for _, dev in ipairs (devices) do -- this 'devices' table is from the 'user_data' request
dev.id = tonumber(dev.id)
if is_to_be_cloned (dev) then
N = N + 1
local cloneId = local_by_remote_id (dev.id)
if not current[cloneId] then
something_changed = true
else
local old_room = luup.devices[cloneId].room_num
room = (old_room ~= 0) and old_room or room -- use room number
end
create_new (cloneId, dev, room) -- recreate the device anyway to set current attributes and variables
list[#list+1] = cloneId
current[cloneId] = nil
end
end
if #list > 0 then nicelog("creating device numbers: " .. json.encode(list)) end
list = {}
for n in pairs (current) do
luup.devices[n] = nil -- remove entirely!
something_changed = true
list[#list+1] = n
end
if #list > 0 then nicelog("deleting device numbers: " .. json.encode(list)) end
build_families (devices)
if something_changed then luup.reload() end
return N
end
--[[
**************************************************************************************************************************
* THIS SECTION HOLDS THE SPECIFIC FUNCTIONS TO DOMOTICZ BRIDGE *
**************************************************************************************************************************
--]]
-- FUNCTIONS TO EXTRACT DATA FROM DOMOTICZ AND CONVERT INTO A SYNTHETIC OPENLUUP USER_DATA CONTEXT
-- deals with the messy device types that exist in Domoticz and put some consistency for device type lookup
local function devicetypeconvert(DZType, DZSubType, DZSwitchType)
local function cleanstring(originalstring)
originalstring = originalstring or ""
return string.gsub(originalstring, "[% %/%c%+]", "") -- clean DZ device type from spaces, slashes and any control char
end
DZType = cleanstring(DZType or "")
if string.match(DZType, "Switch") or string.match(DZType, "Light") then -- this is a switch or light and we need to look at SubType / SwitchType (Domoticz is messy there...)
local DZSubType = cleanstring(DZSubType)
if DZSubType == "Switch" or DZSubType == "AC" or DZSubType == "SelectorSwitch" then
local DZSwitchType = cleanstring(DZSwitchType)
if DZSwitchType == "MotionSensor" or
DZSwitchType == "SmokeDetector" or
DZSwitchType == "Contact" or
DZSwitchType == "DoorContact" or
DZSwitchType == "PushOnButton" or
DZSwitchType == "Dimmer"
then DZType = DZSwitchType
elseif
string.match(DZSwitchType, "Blinds") then DZType = "Blinds"
else
DZType = "SwitchOnOff" -- default if no specific switch type
end
end
end
if DZType == "General" and DZSubType == "Barometer" then DZType = "Barometer" end --Pressure sensors
if DZType == "General" and DZSubType == "kWh" then DZType = "ElectricMeter" end
if DZType == "Usage" and DZSubType == "Electric" then DZType = "ElectricUsage" end
if not DZ2VeraMap[DZType] then DZType = "Generic" end -- no match with list of specific known "vera like" devices
return DZType
end
-- generic call to Domoticz's API, used for polling and/or actions
local function DZAPI(APIcall, logmessage)
APIcall = table.concat{"http://", ip, ":", DZport, APIcall}
nicelog(APIcall)
local result = ""
local retdata, retcode = http.request(APIcall)
if retcode == 200 then
retdata, _ = json.decode(retdata)
if retdata.status == "OK" then
result = "API responded success"
nicelog({logmessage, " ", result})
return retdata
else
result = "API responded error !"
nicelog({logmessage, " ", result})
return false
end
else
result = "Network error, Domoticz API not reachable !"
nicelog({logmessage, " ", result})
return false
end
end
-- this is the reading of Domoticz's API... used for building user_data and for subsequent variables polling
local function GetDZData(deviceidx)
local DZData = {}
local APIcall = ""
if deviceidx then
APIcall = "/json.htm?type=devices&rid=" .. tostring(deviceidx or "")
else
APIcall = "/json.htm?type=devices&filter=all&used=true&order=Name"
end
DZData = DZAPI(APIcall, "device(s) polling call to Domoticz:")
if DZData then
return DZData.result, DZData.ActTime -- returns a table with the devices data and the timestamp of the data
else
return false
end
end
-- dealing with the fact that Domoticz variables can have very different formats compared to openLuup
local function convertvariable(variable, value, format_table)
local tempval = nil
if not(variable == "BatteryLevel" and value == 255) then -- if BatteryLevel = 255 then it is not a battery device and we discard that variable
tempval = tostring(value)
if format_table.pattern then tempval = string.gsub(tempval, format_table.pattern, "") end
if format_table.epoch then tempval = datetoepoch(tempval) end
if format_table.boolean then if tempval == "Off" then tempval = "0" else tempval = "1" end end
if format_table.contact then if tempval == "Closed" then tempval = "0" else tempval = "1" end end
if variable == "LoadLevelStatus" and (tonumber(tempval) or 0) == 0 then tempval = "0" end -- deals with nil value sent for zero load by Domoticz
end
return tempval
end
-- add to each device as extracted from Domoticz the relevant "vera-like" attributes and variables
local function BuildDevice(device, context)
local function BuildVariable(service, variable, value, id)
local state = {}
state.service = service or ""
state.variable = variable or ""
state.value = value or ""
state.id = id
return state
end
-- read the "Vera" device definition files to populate the default services/variables - thanks @akbooer !
local function getdefaultvariables(services)
local variables = {}
local parameter = "%s,%s=%s"
for _, service in pairs(services or {}) do
if service.serviceId ~= "urn:micasaverde-com:serviceId:HaDevice1" then
if service.SCPDURL then
local svc = loader.read_service (service.SCPDURL) -- read the service file(s)
for _,v in ipairs (svc.variables or {}) do
local default = v.defaultValue
if default and default ~= '' then -- only variables with defaults
local index = table.concat{service.serviceId, ".", v.name}
variables[index] = {service = service.serviceId, variable = v.name, value = default}
end
end
end
end
end
return variables
end
local DZType = devicetypeconvert(context.Type, context.SubType, context.SwitchType)
nicelog({"Processing original device ", device.id, " ", device.name, " of type '", device.DZType, "' as '", DZType, "'"})
-- process to add the "vera-like" serviceIds and variables
device.device_file = DZ2VeraMap[DZType].device_file
local loaderdevice = loader.read_device(device.device_file)
device.device_type = loaderdevice.device_type
device.device_json = loaderdevice.json_file
device.states = {} -- the device variables
-- initialize required device variables
local defaultvariables = getdefaultvariables(loaderdevice.service_list) -- use the openluup loader read_service function to initialize all default variables
local state
for _, state in pairs(DZ2VeraMap[DZType].states) do
local tempval = convertvariable(state.variable, context[state.DZData], state)
if tempval then
table.insert(device.states, BuildVariable(state.service, state.variable, tempval, #device.states+1))
local index = table.concat{state.service, ".", state.variable}
if defaultvariables[index] then -- this is a default variable so we will mark as created
defaultvariables[index]["created"] = true
end
-- register the variables to be managed by the polling loop
local tmap = tablecopy(state) --{}
tmap.idx = device.id
table.insert(pollmap, tmap) -- pollmap is used in the polling loop to match Domoticz variables with openLuup's
local varmap = cloneddevmap[device.id] or {}
table.insert(varmap, #pollmap)
cloneddevmap[device.id] = varmap -- for each device id, create an index of polled variables
end
end
-- create the luup default variables not mapped by the bridge
for _, variable in pairs(defaultvariables) do
if not variable.created then
table.insert(device.states, BuildVariable(variable.service, variable.variable, variable.value, #device.states+1))
end
end
-- initialize actions to be handled for this device
if DZ2VeraMap[DZType].actions then
for _, action in pairs(DZ2VeraMap[DZType].actions) do
local actiontable = tablecopy(action)
actiontable.idx = device.id
table.insert(actionmap, actiontable) -- actionmap is used to match Domoticz actions with openLuup actions
hash = table.concat({actiontable.idx, actiontable.service, actiontable.action}, ".")
actionhash[hash] = #actionmap
-- nicelog({"action table hash = ", hash, " maps to actionmap ", actionhash[hash]})
end
end
return device
end
-- Create a "vera-like" userdata table from the Domoticz data
local function BuildUserData()
local virtualuserdata = {}
local k, v
-- initialize userdata necessary fields - to be expanded
-- virtualuserdata.Mode = "1"
virtualuserdata.BuildVersion = "*1.7.0*"
virtualuserdata.model = "Domoticz"
virtualuserdata.PK_AccessPoint = "88800000"
virtualuserdata.devices = {}
local DZData = GetDZData()
if DZData then
for _, DZDev in pairs(DZData) do -- loop DZ devices
if is_dev_to_be_cloned(DZDev.idx) then
device = {}
device.id = DZDev.idx
device.name = string.gsub(DZDev.Name, "[%_]", " ") -- DEV to allow better display in AltUI
device.id_parent = 0 -- we assume all Domoticz devices to be level 1 children to the controller
device.DZType = DZDev.Type -- the original Domoticz type
device.DZSubType = DZDev.SubType -- the original Domoticz subtype
device.DZSwitchType = DZDev.SwitchType or "" -- if this is a switch we need to capture this as well
device=BuildDevice(device, DZDev)
table.insert(virtualuserdata.devices, device) -- we are done with this device
end
end
return virtualuserdata
else
return false
end
end
-- POLLING FUNCTIONS FOR VARIABLE UPDATES
-- handles some device specific triggers such as armed sensors
function updatevar(serviceId, variable, value, devNo)
-- let's first update the required variable itself
local change = setVar (variable, value, serviceId, devNo)
-- then go for possible associations...
-- if security sensor trips while it is "Armed", then we need to raise the "ArmedTripped flag",
-- but if it untrips, then we kill the "ArmedTripped" flag regarless of the "Armed" status
-- we also update the "LastTrip" variable (and the now disregarded by MiOS "LastUnTrip" variable) as Domoticz only give last change timestamp
if serviceId == "urn:micasaverde-com:serviceId:SecuritySensor1" and variable == "Tripped" then
local ArmedTripped = "0"
local Armed = luup.variable_get(serviceId, "Armed", devNo)
if tonumber(value) == 1 then -- the sensor tripped
setVar("LastTrip", os.time(), serviceId, devNo)
if tonumber(Armed) == 1 then ArmedTripped = "1" end
end
setVar("ArmedTripped", ArmedTripped, serviceId, devNo)
if change and tonumber(value) == 0 then -- the sensor was previously tripped but now it is not...
setVar("LastUnTrip", os.time(), serviceId, devNo)
end
end
-- this requires some work to handle complex devices in the future
end
-- the function handling the polling requests, either for comprehensive or device specific polling
function polling(deviceidx)
-- nicelog("Begin Domoticz polling !")
local IndexedDZData = {}
local tempval
local DZData, timestamp = GetDZData(deviceidx)
luup.variable_set(SID_DZB, "DataTimestamp", timestamp, devNo)
for _, DZv in pairs(DZData) do -- loop the device list received from Domoticz (either full or partial)
if cloneddevmap[DZv.idx] then -- this is a deviced that is cloned
for _, v in pairs(cloneddevmap[DZv.idx]) do -- loop the index table for cloned variables associated to the device
tempval = convertvariable(pollmap[v].variable, DZv[pollmap[v].DZData], pollmap[v])
if tempval then updatevar(pollmap[v].service, pollmap[v].variable, tempval, OFFSET + DZv.idx) end
end
end
end
-- nicelog("Finished Domoticz polling !")
end
-- the polling loop !
function pollfullDZData()
polling()
luup.call_delay("pollfullDZData", POLL_DELAY)
end
-- HANDLER FOR BIDIRECTIONAL UPDATES
-- This is called by the companion script "script_device_openLuup.lua" to be installed in the appropriate ./domoticz/scripts/lua folder.
-- Each time a Domoticz device changes status, the below handler is called and prompts a ad-hoc polling of the relevant device if cloned in openLuup
function DZData_update(lul_request, lul_parameters, lul_outputformat)
local status = 0 -- 0 = polling error, 1 = device ignored as excluded or mirrored by bridge, 2 = change processed
for key, value in pairs(lul_parameters) do
if key == "idx" then
for idx in value:gmatch "%d+" do -- loop each idx received in CSV string format... actually it seems that only one idx at a time is ever received ?
nicelog({"Received change notification from Domoticz - Device = ", idx or ""})
local nidx = tonumber(idx)
if nidx ~= 0 then
if is_dev_to_be_cloned(idx) then
status = 2
polling(idx)
else
status = 1
nicelog({"Change notification ignored for excluded or mirrored device ", idx})
end
end
end
end
end
if status == 0 then
return "openLuup: Domoticz http request invalid: no device idx found !!!", "text/plain"
elseif status == 1 then
return "openLuup: Domoticz data change ignored for excluded or mirrored device", "text/plain"
else
return "openLuup: Domoticz data change received OK", "text/plain"
end
end
-- registers our handler as /data_request?id=lr_DZUpdate&idx=[x]
function sethandler()
luup.register_handler("DZData_update", "DZUpdate")
end
-- ORIGINAL FUNCTION FROM VERABRIDGE MODIFIED
local function GetUserData ()
local Domoticz
local Ndev = 0
local version
Domoticz = BuildUserData() -- this is the trick for DZ Plugin... build & inject a virtual userdata build from Domoticz
if Domoticz then
nicelog"Domoticz info needed to build bridge environment received!"
if Domoticz.devices then
local new_room_name = "Z - Domoticz"
nicelog("creating room " .. new_room_name)
luup.rooms.create (new_room_name)
remote_room_index = index_rooms (Domoticz.rooms or {})
local_room_index = index_rooms (luup.rooms or {})
nicelog("new room number: " .. (local_room_index[new_room_name] or '?'))
version = Domoticz.BuildVersion
nicelog("Domoticz BuildVersion = " .. version)
Ndev = #Domoticz.devices
nicelog("number of remote devices = " .. Ndev)
local roomNo = local_room_index[new_room_name] or 0
Ndev = create_children (Domoticz.devices, roomNo)
return Ndev, version
end
else
nicelog"Domoticz info needed to build bridge environment NOT received!"
return 0, "0"
end
end
--
-- GENERIC ACTION HANDLER
--
-- called with serviceId and name of undefined action
-- returns action tag object with possible run/job/incoming/timeout functions
local function generic_action (serviceId, name)
local function job (lul_device, lul_settings)
local devNo = remote_by_local_id (lul_device)
if not devNo then return end -- not a device we have cloned
local message = "Action table match: %s - %s - %s"
local hash = table.concat({devNo, lul_settings.serviceId, lul_settings.action}, ".")
local action = actionmap[actionhash[hash]]
if action then
local APIcall = "/json.htm?type=command¶m="
local value = lul_settings[action.name]
if action.boolean then
local test = tonumber(value) > 0
if action.inverted then test = not test end -- Domoticz treats blinds in inverted manner for commands (on = closed)
if test then value = "On" else value = "Off" end
end
if action.self then -- this is an action for a local variable within the openLuup device
luup.variable_set(action.service, action.command, value, OFFSET + tonumber(action.idx))
else -- this is an action for Domoticz
APIcall = table.concat{APIcall, string.format(action.command, devNo, value)}
DZAPI(APIcall, "Action handler call to Domoticz:")
end
return 4, 0
else
local message = "service/action not implemented: %d.%s.%s"
nicelog(message: format (lul_device, lul_settings.serviceId, lul_settings.action))
return 2, 0
end
end
return {run = job}
end
--[[
**************************************************************************************************************************
* THIS SECTION HOLDS MOSTLY UNCHANGED ORIGINAL VERA BRIDGE FUNCTIONS *
**************************************************************************************************************************
--]]
-- update HouseMode variable and, possibly, the actual openLuup Mode
local function UpdateHouseMode (Mode)
Mode = tostring(Mode)
setVar ("HouseMode", Mode) -- 2016.05.15, thanks @logread!
local current = userdata.attributes.Mode
if current ~= Mode then
if HouseModeMirror == '1' then
luup.attr_set ("Mode", Mode) -- 2016.05.23, thanks @konradwalsh!
elseif HouseModeMirror == '2' then
local now = os.time()
nicelog"remote HouseMode differs from that set..."
if now > HouseModeTime + 60 then -- ensure a long delay between retries (Vera is slow to change)
local switch = "remote HouseMode update, was: %s, switching to: %s"
nicelog(switch: format (Mode, current))
HouseModeTime = now
local request = "http://%s:3480/data_request?id=action&serviceId=%s&DeviceNum=0&action=SetHouseMode&Mode=%s"
luup.inet.wget (request: format(ip, SID.hag, current))
end
end
end
end
-- find other bridges in order to establish base device number for cloned devices
local function findOffset ()
local offset
-- local my_type = luup.devices[devNo].device_type
local bridges = {} -- devNos of ALL bridges
for d, dev in pairs (luup.devices) do
-- if dev.device_type == my_type then
if string.find(bridgestypes, dev.device_type) then -- modified by logread
bridges[#bridges + 1] = d
end
end
table.sort (bridges) -- sort into ascending order by deviceNo
for d, n in ipairs (bridges) do
if n == devNo then offset = d end
end
return offset * BLOCKSIZE -- every remote machine starts in a new block of devices
end
-- logged request
local function wget (request)
nicelog(request)
local status, result = luup.inet.wget (request)
if status ~= 0 then
nicelog("failed requests status: " .. (result or '?'))
end
end
--
-- MIRRORS
--
--[==[ openLuup.dzmirrors syntax is:
<DomoticzIP>
<Domoticz Device Idx>.<nvalue or svalue> = <openLuupDeviceId>.<serviceId>.<variableName>
more info on nvalue and svalue at https://www.domoticz.com/wiki/Domoticz_API/JSON_URL's#Update_devices.2Fsensors
example: