forked from akbooer/Z-Way
-
Notifications
You must be signed in to change notification settings - Fork 0
/
L_ZWay.lua
1299 lines (1049 loc) · 40.4 KB
/
L_ZWay.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
module (..., package.seeall)
ABOUT = {
NAME = "L_ZWay",
VERSION = "2018.07.16",
DESCRIPTION = "Z-Way interface for openLuup",
AUTHOR = "@akbooer",
COPYRIGHT = "(c) 2013-2017 AKBooer",
DOCUMENTATION = "http://forum.micasaverde.com/index.php/topic,39261.0.html",
LICENSE = [[
Copyright 2013-2017 AK Booer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
]]
}
-- 2017.10.03 added test_from_file function
-- 2018.03.15 remove command class 113 from being Security sensor CC 48 equivalent
-- see: http://forum.micasaverde.com/index.php/topic,62975.0.html
-- 2018.07.16 name = dv.metrics.title, for @DesT
local loader = require "openLuup.loader"
local json = require "openLuup.json"
local http = require "socket.http"
local ltn12 = require "ltn12"
local Z -- the Zway API object
local cclass_update -- table of command_class updaters indexed by altid
------------------
local devNo
local service_schema = {} -- serviceId ==> schema implementation
local DEV = {
controller = "D_SceneController1.xml", -- these preset devices don't correspond to any ZWay vDev
combo = "D_ComboDevice1.xml",
rgb = "D_DimmableRGBLight1.xml",
}
local SID = { -- schema implementation or shorthand name ==> serviceId
AltUI = "urn:upnp-org:serviceId:altui1",
ZWave = "urn:micasaverde-com:serviceId:ZWaveNetwork1",
ZWay = "urn:akbooer-com:serviceId:ZWay1",
controller = "urn:micasaverde-com:serviceId:SceneController1",
combo = "urn:micasaverde-com:serviceId:ComboDevice1",
rgb = "urn:micasaverde-com:serviceId:Color1",
setpoint = "urn:upnp-org:serviceId:TemperatureSetpoint1",
setpointHeat = "urn:upnp-org:serviceId:TemperatureSetpoint1_Heat",
setpointCool = "urn:upnp-org:serviceId:TemperatureSetpoint1_Cool",
}
-- NB: for thermostats, see @rigpapa's useful post:
-- http://forum.micasaverde.com/index.php/topic,79510.0.html
-- LUUP utility functions
local function log(text, level)
luup.log(("%s: %s"): format ("ZWay", text), (level or 50))
end
local function getVar (name, service, device)
service = service or SID.ZWay
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.ZWay
device = device or devNo
local old = luup.variable_get (service, name, device)
if tostring(value) ~= old then
luup.variable_set (service, name, value, device)
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 "on" or "off" or "1" or "0"
-- return "1" or "0" or "on" or "off"
local function on_or_off (x)
local y = {["on"] = "1", ["off"] = "0", ["1"] = "on", ["0"] = "off", [true] = "on"}
local z = tonumber (x)
local on = z and z > 0
return y[on or x] or x
end
local function open_or_close (x)
local y = {["open"] = "0", ["close"] = "1", ["0"] = "open", ["1"] = "close"}
return y[x] or x
end
----------------------------------------------------
--
-- GENERIC GET/SET SERVICES - used by several actual services
-- - local effect only (no ZWay communication)
--
local Name = {
get = {returns = {CurrentName = "Name"}},
set = function (d, args)
if args.NewName then
luup.variable_set (args.serviceId, "Name", args.NewName, d)
end
end,
}
local Application = {
get = {returns = {CurrentApplication = "Application"}}, -- return value handled by action request mechanism
set = function (d, args, allowedValue)
local valid = true
if allowedValue then
for _, value in ipairs(allowedValue) do allowedValue[value] = true end
valid = allowedValue [args.NewApplication]
end
if valid then
luup.variable_set (args.serviceId, "Application", args.NewApplication, d)
end
end,
}
----------------------------------------------------
--
-- SERVICE SCHEMAS - virtual services
-- openLuup => Zway
--
--[[
vDev commands:
1. ’update’: updates a sensor value
2. ’on’: turns a device on. Only valid for binary commands
3. ’off’: turns a device off. Only valid for binary commands
4. ’exact’: sets the device to an exact value. This will be a temperature for thermostats or a percentage value of motor controls or dimmers
--]]
local S_SwitchPower = {
SetTarget = function (d, args)
local value = on_or_off (args.newTargetValue or '0')
local altid = luup.devices[d].id
altid = altid: match "^%d+$" and altid.."-0-37" or altid
Z.command (altid, value)
end,
}
local S_Dimming = {
SetLoadLevelTarget = function (d, args)
local level = tonumber (args.newLoadlevelTarget or '0')
local value = "exact?level=" .. level
local altid = luup.devices[d].id
altid = altid: match "^%d+$" and altid.."-0-38" or altid
Z.command (altid, value)
end,
}
local S_HaDevice = {
ToggleState = function (d)
local toggle = {['0'] = '1', ['1']= '0'}
local status = getVar ("Status", SID[S_SwitchPower], d)
S_SwitchPower.SetTarget (d, {newTargetValue = toggle [status] or '0'})
end,
}
local S_Temperature = {
GetApplication = Application.get,
SetApplication = function (d, args) return Application.set (d, args, {"Room", "Outdoor", "Pipe", "AirDuct"}) end,
GetCurrentTemperature = {returns = {CurrentTemp = "CurrentTemperature"}},
GetName = Name.get,
SetName = Name.set,
}
--
local S_Security = {
SetArmed = function (d, args)
luup.variable_set (args.serviceId, "Armed", args.newArmedValue or '0', d)
end,
}
local S_Color = {
-- args.newColorRGBTarget = "61,163,69"
SetColorRGB = function (d, args)
local rgb = { (args.newColorRGBTarget or ''): match "^(%d+),(%d+),(%d+)" }
if #rgb ~= 3 then return end
-- find our child devices...
local c = {}
for i,dev in pairs (luup.devices) do
if dev.device_num_parent == d then
c[#c+1] = {devNo = i, altid = dev.id}
end
end
table.sort (c, function (a,b) return a.altid < b.altid end)
if #c < 5 then return end
-- assume the order M0 M1 R G B (w)
for i = 1,3 do
log ("setting: " .. rgb[i])
local level = math.floor ((rgb[i]/256)^2 * 100) -- map 0-255 to 0-100, with a bit of gamma
S_Dimming.SetLoadLevelTarget (c[i+2].devNo, {newLoadlevelTarget = level})
end
end,
}
local S_DoorLock = {
SetTarget = function (d, args)
local value = open_or_close (args.newTargetValue)
local altid = luup.devices[d].id
altid = altid: match "^%d+$" and altid.."-0-98" or altid
Z.command (altid, value)
end,
}
local S_Camera = { }
local S_EnergyMetering = { }
local S_Generic = { }
local S_Humidity = { }
local S_Light = { }
local S_SceneController = { }
local S_Unknown = { } -- "catch-all" service
------------
--
-- Thermostat info
--
-- D_HVAC_ZoneThermostat1.xml uses these default serviceIds and variables...
local S_HVAC_FanMode = {
-- <name>SetMode</name>
-- <name>NewMode</name>
-- <relatedStateVariable>Mode</relatedStateVariable>
-- command_class ["68"] Fan_mode
--ThermostatFanMode
-- Auto Low,On Low,Auto High,On High,Auto Medium,On Medium,Circulation,Humidity and circulation,Left and right,Up and down,Quite
SetMode = function (d, args)
local valid = {Auto = true, ContinuousOn = true, PeriodicOn = true}
end,
--[[
urn:upnp-org:serviceId:HVAC_FanOperatingMode1,Mode=Auto
urn:upnp-org:serviceId:HVAC_FanOperatingMode1,FanStatus=On
--]]
GetMode = { returns = {CurrentMode = "Mode" } },
GetFanStatus = { returns = {CurrentStatus = "FanStatus" } },
GetName = Name.get,
SetName = Name.set,
}
SID[S_HVAC_FanMode] = "urn:upnp-org:serviceId:HVAC_FanOperatingMode1"
local S_HVAC_State = { --[[
--["66"] Operating_state
-- ["67"] -- Setpoint
--Setpoint
-- Heating,Cooling,Furnace,Dry Air,Moist Air,Auto Change Over,Energy Save Heating,Energy Save Cooling,Away Heating,Away Cooling,Full Power
urn:micasaverde-com:serviceId:HVAC_OperatingState1,ModeState=Off
<allowedValue>Idle</allowedValue>
<allowedValue>Heating</allowedValue>
<allowedValue>Cooling</allowedValue>
<allowedValue>FanOnly</allowedValue>
<allowedValue>PendingHeat</allowedValue>
<allowedValue>PendingCool</allowedValue>
<allowedValue>Vent</allowedValue>
--]]
}
SID[S_HVAC_State] = "urn:micasaverde-com:serviceId:HVAC_OperatingState1"
local S_HVAC_UserMode = {
-- <name>SetModeTarget</name>
-- <name>NewModeTarget</name>
-- <relatedStateVariable>ModeTarget</relatedStateVariable>
SetModeTarget = function (d, args)
local valid = {Off = true, AutoChangeOver = true, CoolOn = true, HeatOn = true, }
local value = args.NewModeTarget
if valid[value] then
-- luup.variable_set (args.serviceId, "ModeTarget", value, d)
end
end,
-- ["64"] --ThermostatMode
-- Off,Heat,Cool,Auto,Auxiliary,Resume,Fan Only,Furnace,Dry Air,Moist Air,Auto Change Over,
-- Energy Save Heat,Energy Save Cool,Away Heat,Away Cool,Full Power,Manufacturer Specific
--urn:upnp-org:serviceId:HVAC_UserOperatingMode1,ModeTarget=Off
--urn:upnp-org:serviceId:HVAC_UserOperatingMode1,ModeStatus=Off
--urn:upnp-org:serviceId:HVAC_UserOperatingMode1,EnergyModeTarget=Normal
--urn:upnp-org:serviceId:HVAC_UserOperatingMode1,EnergyModeStatus=Normal
--[[
<name>SetEnergyModeTarget</name>
<name>NewModeTarget</name>
<relatedStateVariable>EnergyModeTarget</relatedStateVariable>
<name>GetModeTarget</name>
<name>CurrentModeTarget</name>
<relatedStateVariable>ModeTarget</relatedStateVariable>
<name>GetModeStatus</name>
<name>CurrentModeStatus</name>
<relatedStateVariable>ModeStatus</relatedStateVariable>
<name>GetName</name>
<name>CurrentName</name>
<name>SetName</name>
<name>NewName</name>
<relatedStateVariable>Name</relatedStateVariable>
--]]
}
SID[S_HVAC_UserMode] = "urn:upnp-org:serviceId:HVAC_UserOperatingMode1"
local S_HVAC_FanSpeed = { --[[
urn:upnp-org:serviceId:FanSpeed1,FanSpeedTarget=0
urn:upnp-org:serviceId:FanSpeed1,FanSpeedStatus=0
urn:upnp-org:serviceId:FanSpeed1,DirectionTarget=0
urn:upnp-org:serviceId:FanSpeed1,DirectionStatus=0
<name>SetFanSpeed</name>
<name>NewFanSpeedTarget</name>
<relatedStateVariable>FanSpeedTarget</relatedStateVariable>
<name>GetFanSpeed</name>
<name>CurrentFanSpeedStatus</name>
<relatedStateVariable>FanSpeedStatus</relatedStateVariable>
<name>GetFanSpeedTarget</name>
<name>CurrentFanSpeedTarget</name>
<relatedStateVariable>FanSpeedTarget</relatedStateVariable>
<name>SetFanDirection</name>
<name>NewDirectionTarget</name>
<relatedStateVariable>DirectionTarget</relatedStateVariable>
<name>GetFanDirection</name>
<name>CurrentDirectionStatus</name>
<relatedStateVariable>DirectionStatus</relatedStateVariable>
<name>GetFanDirectionTarget</name>
<name>CurrentDirectionTarget</name>
<relatedStateVariable>DirectionTarget</relatedStateVariable>
--]]
}
SID[S_HVAC_FanSpeed] = "urn:upnp-org:serviceId:FanSpeed1"
local S_TemperatureSetpoint = {
GetApplication = Application.get,
SetApplication = Application.set,
GetCurrentSetpoint = {returns = {CurrentSP = "CurrentSetpoint"}},
GetSetpointAchieved = {returns = {CurrentSPA = "SetpointAchieved"}},
GetName = Name.get,
SetName = Name.set,
SetCurrentSetpoint = function (d, args)
local level = args.NewCurrentSetpoint
if level then
local sid = args.serviceId
luup.variable_set (sid, "CurrentSetpoint", level, d)
local value = "exact?level=" .. level
local altid = luup.devices[d].id
if altid: match "^%d+$" then
local suffix = {
[SID.setpoint] = "-0-67",
[SID.setpointHeat] = "-0-67-1",
[SID.setpointCool] = "-0-67-2",
}
altid = altid .. (suffix[args.serviceId] or '')
end
Z.command (altid, value)
end
end,
}
local function shallow_copy (x)
local y = {}
for a,b in pairs (x) do y[a] = b end
return y
end
-- these copies MUST be separate tables, since they're used to index the SID table
local S_TemperatureSetpointHeat = shallow_copy (S_TemperatureSetpoint)
local S_TemperatureSetpointCool = shallow_copy (S_TemperatureSetpoint)
SID [S_TemperatureSetpoint] = SID.setpoint
SID [S_TemperatureSetpointHeat] = SID.setpointHeat
SID [S_TemperatureSetpointCool] = SID.setpointCool
--[[
--]]
SID [S_Camera] = "urn:micasaverde-com:serviceId:Camera1"
SID [S_Color] = "urn:micasaverde-com:serviceId:Color1"
SID [S_Dimming] = "urn:upnp-org:serviceId:Dimming1"
SID [S_DoorLock] = "urn:micasaverde-com:serviceId:DoorLock1"
SID [S_EnergyMetering] = "urn:micasaverde-com:serviceId:EnergyMetering1"
SID [S_Generic] = "urn:micasaverde-com:serviceId:GenericSensor1"
SID [S_HaDevice] = "urn:micasaverde-com:serviceId:HaDevice1"
SID [S_Humidity] = "urn:micasaverde-com:serviceId:HumiditySensor1"
SID [S_Light] = "urn:micasaverde-com:serviceId:LightSensor1"
SID [S_Security] = "urn:micasaverde-com:serviceId:SecuritySensor1"
SID [S_SwitchPower] = "urn:upnp-org:serviceId:SwitchPower1"
SID [S_Temperature] = "urn:upnp-org:serviceId:TemperatureSensor1"
for schema, sid in pairs (SID) do -- reverse look-up sid ==> schema
if type(schema) == "table" then service_schema[sid] = schema end
end
-- Generic ACTION callbacks
local function generic_action (serviceId, action)
local function noop(lul_device)
local message = "service/action not implemented: %d.%s.%s"
log (message: format (lul_device, serviceId, action))
return false
end
local service = service_schema[serviceId] or {}
local act = service [action] or noop
if type(act) == "function" then act = {run = act} end
act.serviceId = serviceId
act.action = action
return act
end
----------------------------------------------------
--
-- COMMAND CLASSES - virtual device updates
--
local command_class = {
-- catch-all
["0"] = function (d, inst, meta)
-- scene controller
if inst.deviceType == "toggleButton" then
local click = inst.updateTime
-- setVar ("LastUpdate_" .. meta.altid, click, SID.ZWay, d)
if click ~= meta.click then -- force variable updates
local scene = meta.scale
local time = os.time() -- "◷" == json.decode [["\u25F7"]]
local date = os.date ("◷ %Y-%m-%d %H:%M:%S", time): gsub ("^0",'')
luup.variable_set (SID[S_SceneController], "sl_SceneActivated", scene, d)
luup.variable_set (SID[S_SceneController], "LastSceneTime",time, d)
if time then luup.variable_set (SID.AltUI, "DisplayLine1", date, d) end
luup.variable_set (SID.AltUI, "DisplayLine2", "Last Scene: " .. scene, d)
meta.click = click
end
else
-- local message = "no update for device %d [%s] %s %s"
-- log (message: format (d, inst.id, inst.deviceType or '?', (inst.metrics or {}).icon or ''))
--...
end
end,
-- binary switch
["37"] = function (d, inst, meta)
setVar ("Status",on_or_off (inst.metrics.level), meta.service, d)
end,
-- multilevel switch
["38"] = function (d, inst, meta)
local level = tonumber (inst.metrics.level) or 0
setVar ("LoadLevelTarget", level, meta.service, d)
setVar ("LoadLevelStatus", level, meta.service, d)
local status = (level > 0 and "1") or "0"
setVar ("Status", status, SID[S_SwitchPower], d)
end,
-- binary sensor
["48"] = function (d, inst)
local sid = SID [S_Security]
local tripped = on_or_off (inst.metrics.level)
local old = getVar ("Tripped", sid)
if tripped ~= old then
setVar ("Tripped", tripped, sid, d)
setVar ("LastTrip", inst.updateTime, sid, d)
local armed = getVar ("Armed", sid, d)
if armed == "1" then
setVar ("ArmedTripped", tripped, sid, d)
end
end
end,
-- multilevel sensor
["49"] = function (d, inst, meta) -- TODO: more to do here to sub-type?
local sensor_variable_name = {
[SID[S_Temperature]] = "CurrentTemperature",
[SID[S_EnergyMetering]] = "Watts",
}
local var = sensor_variable_name[meta.service] or "CurrentLevel"
setVar (var, inst.metrics.level, meta.service, d)
end,
-- meter
["50"] = function (d, inst, meta)
local var = (inst.metrics.scaleTitle or '?'): upper ()
if var then setVar (var, inst.metrics.level, meta.service, d) end
end,
-- door lock
["98"] = function (d, inst)
setVar ("Status",open_or_close (inst.metrics.level), SID[S_DoorLock], d)
end,
-- thermostat
["64"] = function (d, inst, meta) -- ThermostatMode
-- ZWay modes:
-- Off,Heat,Cool,Auto,Auxiliary,Resume,Fan Only,Furnace,Dry Air,Moist Air,Auto Change Over,
-- Energy Save Heat,Energy Save Cool,Away Heat,Away Cool,Full Power,Manufacturer Specific.
-- Vera modes:
-- {Off = true, AutoChangeOver = true, CoolOn = true, HeatOn = true, }
local ZtoV = {Off = "Off", Heat = "HeatOn", Cool = "CoolOn", Auto = "AutoChangeOver", ["Auto Change Over"] = "AutoChangeOver"}
local level = inst.metrics.level
setVar ("ModeStatus", ZtoV[level] or level, meta.service, d)
end,
["66"] = function (d, inst) -- Operating_state
end,
["67"] = function (d, inst, meta) -- Setpoint
-- Heating,Cooling,Furnace,Dry Air,Moist Air,Auto Change Over,Energy Save Heating,Energy Save Cooling,Away Heating,Away Cooling,Full Power
local scale = meta.scale
local sid
if scale == "1" then -- heat
sid = SID.setpointHeat
elseif scale == "2" then -- cool
sid = SID.setpointCool
end
if sid then
setVar ("SetpointAchieved", inst.metrics.level, sid, d)
end
end,
["68"] = function (d, inst) -- ThermostatFanMode
-- Auto Low,On Low,Auto High,On High,Auto Medium,On Medium,Circulation,Humidity and circulation,Left and right,Up and down,Quite
end,
-- barrier operator (eg. garage door)
["102"] = function (d, inst)
setVar ("Status",open_or_close (inst.metrics.level), SID[S_DoorLock], d)
end,
-- battery
["128"] = function (d, inst)
local level = tonumber (inst.metrics.level)
local warning = (level < 10) and "1" or "0"
setVar ("BatteryLevel", level, SID[S_HaDevice], d)
setVar ("sl_BatteryAlarm", warning, SID[S_HaDevice], d)
end,
}
--command_class ["113"] = command_class ["48"] -- alarm
--command_class ["156"] = command_class ["48"] -- tamper switch
function command_class.new (dino, meta)
local updater = command_class[meta.c_class] or command_class["0"]
return function (inst, ...)
setVar (inst.id, inst.metrics.level, SID.ZWay, dino) -- diagnostic, for the moment
setVar (inst.id .. "_LastUpdate", inst.updateTime, SID.ZWay, dino) -- diagnostic, for the moment
-- call with deviceNo, instance object, and metadata (for persistent data)
return updater (dino, inst, meta, ...)
end
end
-----------------------------------------
--
-- DEVICE status updates: ZWay => openLuup
--
local D = {} -- device structure simply for the HTTP callback diagnostic
function _G.updateChildren (d)
D = d or Z.devices () or {}
for _,instance in pairs (D) do
local altid = instance.id: match "^ZWayVDev_zway_.-([%w%-]+)$"
if altid and cclass_update [altid] then
cclass_update [altid] (instance)
end
end
luup.call_delay ("updateChildren", 2)
end
----------------------------------------------------
-- DEVICES
-- use Device maps to lookup Vera category, hence device type...
-- ...and from the device file we can then get services...
-- ...and from the service files, the actions and variables.
--
-- c_class, {upnp_file, serviceId, json_file}, [scale = {...}] }
local vMap = {
["0"] = { nil, S_HaDevice }, -- not really a NO_OP, but a "catch-all"
["37"] = { "D_BinaryLight1.xml", S_SwitchPower },
["38"] = { "D_DimmableLight1.xml", S_Dimming },
["48"] = { "D_MotionSensor1.xml", S_Security , -- SensorBinary
scale = {
-- 1 "General purpose"
-- 2 "Smoke" -- "D_SmokeSensor1.xml"
-- 3 "CO" -- "D_SmokeCoSensor1.json"
-- 4 "CO2"
-- 5 "Heat"
["6"] = { nil, nil, "D_LeakSensor1.json" }, -- 6 "Water"
-- 7 "Freeze"
-- 8 "Tamper"
-- 9 "Aux"
["10"] = { "D_DoorSensor1.xml" }, -- 10 "Door/Window"
-- 11 "Tilt"
-- 12 "Motion"
-- 13 "Glass Break"
-- 14 "First supported Sensor Type"
--]]
}},
["49"] = { -- SensorMultilevel: no default device or service
scale = {
["1"] = { "D_TemperatureSensor1.xml", S_Temperature },
["2"] = { nil, S_Generic },
["3"] = { "D_LightSensor1.xml", S_Light},
["4"] = { nil, S_EnergyMetering},
["5"] = { "D_HumiditySensor1.xml", S_Humidity},
["27"] = { "D_LightSensor1.xml", S_Light, "D_UVSensor.json" } -- special .json file for icon
}},
--[[
SensorMultilevel
1 "Temperature" - scale: {"C","F"}
2 "Generic" - scale: {"","%"}
3 "Luminiscence" - scale: {"%","Lux"}
4 "Power" - scale: {"W","Btu/h"}
5 "Humidity" - scale: {"%","Absolute humidity"}
6 "Velocity" - scale: {"m/s","mph"}
7 "Direction"
8 "Athmospheric Pressure" - scale: {"kPa","inch Mercury"}
9 "Barometric Pressure" - scale: {"kPa","inch Mercury"}
10 "Solar Radiation"
11 "Dew Point" - scale: {"C","F"}
12 "Rain Rate" - scale: {"mm/h","inch/h"}
13 "Tide Level" - scale: {"m","feet"}
14 "Weigth" - scale: {"kg","pounds"}
15 "Voltage" - scale: {"V","mV"}
16 "Current" - scale: {"A","mA"}
17 "CO2 Level"
18 "Air Flow" - scale: {"m3/h","cfm"}
19 "Tank Capacity" - scale: {"l","cbm","gallons"}
20 "Distance" - scale: {"m","cm","Feet"}
21 "Angle Position" - scale: {"%","Degree to North Pole","Degree to South Pole"}
22 "Rotation" - scale: {"rpm","Hz"}
23 "Water temperature" - scale: {"C","F"}
24 "Soil temperature" - scale: {"C","F"}
25 "Seismic intensity" - scale: {"Mercalli","European Macroseismic","Liedu","Shindo"}
26 "Seismic magnitude" - scale: {"Local","Moment","Surface wave","Body wave"}
27 "Ultraviolet"
28 "Electrical resistivity"
29 "Electrical conductivity"
30 "Loudness" - scale: {"Absolute loudness (dB)","A-weighted decibels (dBA)"}
31 "Moisture" - scale: {"%","Volume water content (m3/m3)","Impedance (kΩ)","Water activity (aw)"}
32 "Frequency" - scale: {"Hz","kHz"}
33 "Time"
34 "Target Temperature" - scale: {"C","F"}
35 "Particulate Matter" - scale: {"mol/m3","μg/m3"}
36 "Formaldehyde (CH2O)"
37 "Radon Concentration" - scale: {"bq/m3","pCi/L"}
38 "Methane Density (CH4)"
39 "Volatile Organic Compound (VOC)"
40 "Carbon Monoxide (CO)"
41 "Soil Humidity"
42 "Soil Reactivity"
43 "Soil Salinity"
44 "Heart Rate"
45 "Blood Pressure" - scale: {"Systolic (mmHg)","Diastolic (mmHg)"}
46 "Muscle Mass"
47 "Fat Mass"
48 "Bone Mass"
49 "Total Body Water"
50 "Basic Metabolic Rate"
51 "Body Mass Index"
52 "AccelerationX-axis"
53 "AccelerationY-axis"
54 "AccelerationZ-axis"
55 "Smoke Density"
--]]
["50"] = { nil, S_EnergyMetering }, -- device is "D_PowerMeter1.xml"
--[[
Meter
1 "Electric" - scale: {"kWh","kVAh","W","Pulse Count","V","A","Power Factor"}
2 "Gas" - scale: {"Cubic meter","Cubic feet","reserved","Pulse Count"}
3 "Water" - scale: {"Cubic meter","Cubic feet","US Gallon","Pulse Count"}
--]]
["64"] = { "D_HVAC_ZoneThermostat1.xml", S_HVAC_UserMode}, -- Thermostat_mode
-- Off,Heat,Cool,Auto,Auxiliary,Resume,Fan Only,Furnace,Dry Air,Moist Air,Auto Change Over,
-- Energy Save Heat,Energy Save Cool,Away Heat,Away Cool,Full Power,Manufacturer Specific
["66"] = { nil, S_HVAC_State }, -- Operating_state
["67"] = { nil, S_TemperatureSetpoint, -- Setpoint
-- Heating,Cooling,Furnace,Dry Air,Moist Air,Auto Change Over,Energy Save Heating,Energy Save Cooling,Away Heating,Away Cooling,Full Power
scale = {
["1"] = { nil, S_TemperatureSetpointHeat },
["2"] = { nil, S_TemperatureSetpointCool },
},
},
["68"] = {nil, S_HVAC_FanMode}, -- ThermostatFanMode
-- Auto Low,On Low,Auto High,On High,Auto Medium,On Medium,Circulation,Humidity and circulation,Left and right,Up and down,Quite
["98"] = { "D_DoorLock1.xml", S_DoorLock },
["102"] = { "D_DoorLock1.xml", S_DoorLock }, -- "Barrier Operator"
["113"] = { nil, S_Security }, -- Switch
["128"] = { nil, S_EnergyMetering },
["152"] = { "D_MotionSensor1.xml", S_Security },
["156"] = { nil, S_Security }, -- Tamper switch?
-- D_Siren1.xml
-- D_SmokeSensor1.xml
}
--[[
instance = {
creationTime = 1468168215,
creatorId = 1,
deviceType = "sensorMultilevel",
h = 618053595,
hasHistory = false,
id = "ZWayVDev_zway_9-0-49-3",
location = 0,
metrics = {
icon = "luminosity",
level = 9,
probeTitle = "Luminiscence",
scaleTitle = "Lux",
title = "Aeon Labs Luminiscence (9.0.49.3)"
},
permanently_hidden = false,
probeType = "luminosity",
tags = {},
updateTime = 1468837030,
visibility = true
}
--]]
--[[
ZWayVDev [Node ID]:[Instance ID]:[Command Class ID]:[Scale ID]
The Node Id is the node id of the physical device,
the Instance ID is the instance id of the device or ’0’ if there is only one instance.
The command class ID refers to the command class the function is embedded in.
The scale id is usually ’0’ unless the virtual device is generated from a Z-Wave device
that supports multiple sensors with different scales in one single command class.
--]]
local NICS_pattern = "^(%d+)%-(%d+)%-(%d+)%-?(%d*)%-?(%d*)%-?(%d*)%-?(.-)$"
-- create metadata for each virtual device instance
local function vDev_meta (v)
local altid = v.id: match "([%-%w]+)$"
local node, instance, c_class, scale, sub_class, sub_scale, tail = altid: match (NICS_pattern)
local x = vMap[c_class] or {}
local y = (x.scale or {})[scale] or {}
local z = setmetatable (y, {__index = x})
local upnp_file = z[1]
local service = SID[z[2]]
local json_file = z[3]
local devtype = (json_file or upnp_file or ''): match "^D_(%u+%l*)"
return {
upnp_file = upnp_file,
service = service,
json_file = json_file,
devtype = devtype,
altid = altid,
node = node,
instance = instance,
c_class = c_class,
scale = scale,
sub_class = sub_class,
sub_scale = sub_scale,
tail = tail,
}
end
-- transform each node into some sort of Luup device structure with parents and children
local function luupDevice (node, instances)
-- split into devices and variables
local dev, var = {}, {}
local children = {} -- count of children indexed by (shorthand) device type
for _, v in ipairs (instances) do
local t = v.meta.devtype
if t then
children[t] = (children[t] or 0) + 1
dev[#dev+1] = v
else
var[#var+1] = v
end
end
-- create top-level device: three different sorts:
local Ndev = #dev
local upnp_file, altid, devtype, parameters
------------------------
-- a controller has no devices and is just a collection of buttons and switches or other services
if Ndev == 0 then
upnp_file, altid, devtype = DEV.controller, var[1].meta.node, " Controller"
local txt = [[Define scene triggers to watch sl_SceneActivated]] ..
[[ with Lua Expression: new == "button_number"]]
parameters = table.concat { SID.controller, ',', "Scenes", '=', txt }
------------------------
-- a singleton device is a node with only one vDev device
elseif Ndev == 1 then
upnp_file, altid = dev[1].meta.upnp_file, dev[1].meta.altid
------------------------
-- a combo device is a collection of more than one vDev device, and may have service variables
else
upnp_file, altid, devtype = DEV.combo, dev[1].meta.node, " Combo" -- (the space is important)
local dimmers = children.Dimmable
local thermos = children.HVAC
-- HOWEVER...
-- if there are lots of dimmers, ...
if dimmers and dimmers > 3 then -- ... we'll asume that it's an RGB(W) switch
devtype = " RGB Controller"
upnp_file = DEV.rgb
-- if there are any HVAC services, ...
elseif thermos and thermos > 0 then -- ... it's a thermostat
devtype = " Thermostat"
upnp_file = "D_HVAC_ZoneThermostat1.xml"
local newdev = {}
for i, d in ipairs (dev) do -- convert instance 0 devices to embeded variables
if d.meta.instance ~= "0" then
newdev[#newdev+1] = d
else
var[#var+1] = d
d.meta.upnp_file = nil
d.meta.devtype = nil
end
end
dev = newdev
-- otherwise...
else -- ... it's just a vanilla combination device
local label = {}
for a,b in pairs(children) do
label[#label+1] = table.concat {a,':', b}
end
table.sort (label)
parameters = table.concat { SID.AltUI, ',', "DisplayLine1", '=', table.concat (label, ' ') }
end
end
-- return structure with info for creating the top-level device
local dv = (dev[1] or var[1])
devtype = devtype or dv.meta.devtype or '?'
local name = ("%3s: %s %s"): format (node, dv.metrics.title: match "%w+", devtype)
return {
upnp_file = upnp_file,
altid = altid,
-- name = name,
name = dv.metrics.title, -- 2018.07.16, for @DesT
node = node,
devices = dev,
variables = var,
parameters = parameters,
}
end
-- index virtual devices number by node number and build instance metadata
local function index_nodes (d)
local index = {}
for _,v in pairs (d) do
local node = v.id: match "^ZWayVDev_zway_.-(%d+)"
if node and node ~= "0" then -- 2017.10.04 ignore device "0" (which appeared in a new firmware update)
v.meta = vDev_meta (v) -- construct metadata
local t = index[node] or {}
t[#t+1] = v
index[node] = t
end
end
return index
end
-- intepret the vDev structure and devices or services with variables
-- define the top-level devices with other instances as children
local function analyze (devices)
local luupDevs = {}
local vDevs = index_nodes (devices)
for node, instances in pairs(vDevs) do
local d = luupDevice (node, instances)
luupDevs[#luupDevs+1] = d
luupDevs[node] = d -- also index by node id (string)
end
return luupDevs
end
-- this reads a device file and its service files returning a list of variables
-- which can be used in the luup.chdev.append() call to preset device variables
local function parameter_list (upnp_file)
local parameters
if upnp_file then
local d = loader.read_device (upnp_file) -- read the device file
local p = {}
local parameter = "%s,%s=%s"
for _, s in ipairs (d.service_list or {}) do
if s.SCPDURL then
local svc = loader.read_service (s.SCPDURL) -- read the service file(s)