-
Notifications
You must be signed in to change notification settings - Fork 5
/
plugin.py
1246 lines (1151 loc) · 59.3 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
# ebusd Plugin
#
# Author: Barberousse, z1mEk, 2017-2018
# MIT license
#
"""
<plugin key="ebusd" name="ebusd bridge" author="Barberousse" version="2.2.3" externallink="https://github.com/guillaumezin/DomoticzEbusd">
<params>
<!-- <param field="Username" label="Username (left empty if authentication not needed)" width="200px" required="false" default=""/>
<param field="Password" label="Password" width="200px" required="false" default="" password="true"/> -->
<param field="Address" label="IP or named address" width="200px" required="true" default="127.0.0.1"/>
<param field="Port" label="Telnet port" width="100px" required="true" default="8888"/>
<param field="Mode1" label="JSON HTTP port" width="100px" required="true" default="8889"/>
<param field="Mode2" label="Registers" width="1000px" required="false" default=""/>
<param field="Mode3" label="Refresh rate (seconds)" width="100px" required="false" default="600"/>
<param field="Mode4" label="Disable cache" width="100px">
<options>
<option label="True" value="True"/>
<option label="False" value="False" default="true" />
</options>
</param>
<param field="Mode5" label="Read-only" width="450px">
<options>
<option label="Read/write devices and automatically try to add discovered devices" value="False" default="true"/>
<option label="Read-only devices but automatically try to add discovered devices" value="True"/>
<option label="Read/write devices and don't add discovered devices" value="FalseNoAuto" />
<option label="Read-only devices and don't add discovered devices" value="TrueNoAuto"/>
</options>
</param>
<param field="Mode6" label="Debug" width="100px">
<options>
<option label="Advanced" value="2"/>
<option label="Enabled" value="1"/>
<option label="None" value="0" default="true" />
</options>
</param>
</params>
</plugin>
"""
# https://www.domoticz.com/wiki/Developing_a_Python_plugin
import DomoticzEx as Domoticz
import json
import time
import sys
from collections import deque
from collections import OrderedDict
if (sys.version_info.major == 3) and (sys.version_info.minor >= 10):
from collections.abc import MutableMapping
from collections.abc import Mapping
else:
from collections import MutableMapping
from collections import Mapping
import traceback
import re
import shlex
# https://github.com/requests/requests/blob/master/requests/structures.py
class CaseInsensitiveDict(MutableMapping):
"""A case-insensitive ``dict``-like object.
Implements all methods and operations of
``MutableMapping`` as well as dict's ``copy``. Also
provides ``lower_items``.
All keys are expected to be strings. The structure remembers the
case of the last key to be set, and ``iter(instance)``,
``keys()``, ``items()``, ``iterkeys()``, and ``iteritems()``
will contain case-sensitive keys. However, querying and contains
testing is case insensitive::
cid = CaseInsensitiveDict()
cid['Accept'] = 'application/json'
cid['aCCEPT'] == 'application/json' # True
list(cid) == ['Accept'] # True
For example, ``headers['content-encoding']`` will return the
value of a ``'Content-Encoding'`` response header, regardless
of how the header name was originally stored.
If the constructor, ``.update``, or equality comparison
operations are given keys that have equal ``.casefold()``s, the
behavior is undefined.
"""
def __init__(self, data=None, **kwargs):
self._store = OrderedDict()
if data is None:
data = {}
self.update(data, **kwargs)
# lower and remove substring between []
def __lowerAndFilter(self, key):
return re.sub(r'\[.+?\]', '', key).casefold()
def __setitem__(self, key, value):
# Use the lowercased key for lookups, but store the actual
# key alongside the value.
self._store[self.__lowerAndFilter(key)] = (key, value)
def __getitem__(self, key):
return self._store[self.__lowerAndFilter(key)][1]
def __delitem__(self, key):
del self._store[self.__lowerAndFilter(key)]
def __iter__(self):
return (casedkey for casedkey, mappedvalue in self._store.values())
def __len__(self):
return len(self._store)
def lower_items(self):
"""Like iteritems(), but with all lowercase keys."""
return (
(lowerkey, keyval[1])
for (lowerkey, keyval)
in self._store.items()
)
def __eq__(self, other):
if isinstance(other, Mapping):
other = CaseInsensitiveDict(other)
else:
return NotImplemented
# Compare insensitively
return dict(self.lower_items()) == dict(other.lower_items())
# Copy is required
def copy(self):
return CaseInsensitiveDict(self._store.values())
def __repr__(self):
return str(dict(self.items()))
class BasePlugin:
# string address port from parameters
sParamAddress = ""
# integer http port from parameters
iParamTelnetPort = 8888
# integer json port from parameters
iParamJsonPort = 8889
# integer refresh rate from parameters
iParamRefreshRate = 600
# boolean disable cache from parameters
bParamDisableCache = False
# boolean read-only from parameters
bParamReadOnly = False
# boolean auto add discovered devices
bParamAutoAdd = False
# boolean debug from parameters
iParamDebug = 0
# boolean to check that we are started, to prevent error messages when disabling or restarting the plugin
bIsStarted = None
# boolean to ask restart of the plugin
bShallRestart = None
# telnet connection
telnetConn = None
# string buffer for telnet data
sBuffer = None
# json http connection
jsonConn = None
# boolean that indicates that some registers weren't found yet
bStillToLook = None
# integer that count number of json objects
iJsonObjects = None
# integer to keep time of last refresh
iRefreshTime = None
# integer to keep time of last search for new messages
iRefreshFindDeviceTime = None
# integer to force search for new messages every xxx seconds
iRefreshFindDeviceRate = 600
# regex to search message
sRegExSearch = None
# regex to exclude message
sRegExExclude = None
# dictionnary of messages extracted from json, structured as keys wih circuit:message and circuit:message:fieldindex and pointing to json iFieldElement
dMessages = None
# dictionnary of dictonnaries, keyed by deviceid string (circuit:register:fieldindex, for instance "f47:OutsideTemp:0")
# "device": object: object corresponding in Devices dict
# "circuit": string: circuit name, for instance "f47"
# "message": string: register, for instance "OutsideTemp"
# "fieldindex": integer: field index (0 based)
# "fieldscount": integer: total number of fields
# "options": dictionnary: keyed by ebusd value, contains selector switch level integer value, empty if not selector switch
# "forcerefresh": boolean: to refresh device at creation
# "alwaysrefresh": boolean: to refresh at a regular basis
# "reverseoptions": dictionnary: keyed by selector switch level integer valu, contains selector switch ebusd string value, empty if not selector switch
# "domoticzoptions": dictionnary: options send during domoticz device type selector switch creation and update
# "fieldtype": string: cf. getFieldType() return value
# "fieldsvalues": string: fields values read after "readwhole" operation
# "fieldsvaluestimestamp": integer: time when fields values have been updated
dUnitsByDeviceID = None
# same dictionnary, but keyed by 3 dimensions: dUnits3D[circuit][register][fieldindex]
dUnits3D = None
# dequeue of dictionnaries
# "operation": string: can be "read", "readwhole", "write", "authenticate"
# "unit": dict contained in dUnitsByDeviceID
# "value": string: value to write in ebusd format, used only for "write" operation
dqFifo = None
# string that contains the connection step: "idle", then "connecting", then "connected", then "data sending"
sConnectionStep = None
# integer: time when connection step has been updated
iConnectionTimestamp = None
# string: keep track of current operation, see dfFifo
sCurrentCommand = None
# integer: timeout in s
iTimeoutConstant = 10
# integer: max heartbeat interval in s
iMaxHeartbeatInterval = 30
# integer: time when discovering starts
iDiscoverStartTime = None
# integer: time for messages discovering before deciding timeout in s
iDiscoverTime = 300
# integer: debug level
iParamDebug = 0
# integer: version of Domoticz
iVersion = 0
# integer build of Domoticz
iBuild = 0
def __init__(self):
self.bIsStarted = False
self.bShallRestart = False
self.telnetConn = None
self.jsonConn = None
self.sRegExSearch = None
self.sRegExExclude = None
self.dMessages = {}
self.dUnitsByDeviceID = {}
self.dUnits3D = {}
self.sBuffer = ""
self.bStillToLook = True
self.iJsonObjects = 0
timeNow = time.time()
self.iRefreshTime = timeNow
self.iRefreshFindDeviceTime = timeNow
self.iDiscoverStartTime = timeNow
self.dqFifo = deque()
self.sConnectionStep = "idle"
self.iConnectionTimestamp = 0
self.sCurrentCommand = ""
def myDebug(self, message):
if self.iParamDebug:
Domoticz.Log(message)
# Connect to JSON HTTP port to get list of ebusd devices
def findDevices(self):
if self.jsonConn == None:
self.myDebug("findDevices() create connection to " + self.sParamAddress + ":" + str(self.iParamJsonPort))
self.jsonConn = Domoticz.Connection(Name="JSON HTTP", Transport="TCP/IP", Protocol="HTTP", Address=self.sParamAddress, Port=str(self.iParamJsonPort))
if not self.jsonConn.Connected():
self.myDebug("Connect")
self.jsonConn.Connect()
else:
self.myDebug("Find")
# we connect with def and write to get complete list of fields and writable registers
sendData = { "Verb" : "GET",
"URL" : "/data?def&write",
"Headers" : { "Content-Type": "text/xml; charset=utf-8", \
"Connection": "keep-alive", \
"Accept": "Content-Type: text/html; charset=UTF-8", \
"Host": self.sParamAddress+":"+str(self.iParamJsonPort), \
"User-Agent":"Domoticz/1.0" }
}
self.jsonConn.Send(sendData)
# Parse received data from telnet connection in localStrBuffer
def parseTelnet(self, localStrBuffer):
self.myDebug("Parse telnet buffer size " + str(len(localStrBuffer)))
# We are interested only in first line
lLines = localStrBuffer.splitlines()
sReadValue = lLines[0]
# Check if we received an error message
if sReadValue[:5] == "ERR: ":
self.myDebug("Error from telnet client: " + sReadValue[5:])
else:
self.myDebug("Reveived value: " + repr(sReadValue))
# We sould receive something like "f47 OutsideTemp temp=9.56;sensor=ok"
# Split by space
lParams = sReadValue.split(" ", 2)
if len(lParams) >= 3:
# Split received fields by ;
sFields = lParams[2].split(";")
lFieldsValues = []
sCircuit = lParams[0].casefold()
sMessage = lParams[1].casefold()
# Look for corresponding circuit and register
if (sCircuit in self.dUnits3D) and (sMessage in self.dUnits3D[sCircuit]):
# Extract read fields
for sField in sFields:
# Keep only the right of =
sFieldContent = sField.split("=")
# Sanity check
if len(sFieldContent) == 2:
# Keep read values in lFieldsValues
lFieldsValues.append(sFieldContent[1])
else:
Domoticz.Error("Parsing error on field for value " + sReadValue)
# Save whole values for later use with a timestamp
sFieldsValues = ";".join(lFieldsValues)
iFieldsValuesTimestamp = time.time()
for dUnit in self.dUnits3D[sCircuit][sMessage].values():
dUnit["fieldsvalues"] = sFieldsValues
dUnit["fieldsvaluestimestamp"] = iFieldsValuesTimestamp
self.myDebug("Save whole fields values " + dUnit["fieldsvalues"])
# Distribute read values for each field we are interested into
if dUnit["fieldindex"] < len(lFieldsValues):
sFieldValue = lFieldsValues[dUnit["fieldindex"]]
iValue, sValue = valueEbusdToDomoticz(dUnit, sFieldValue)
oUnit = dUnit["device"]
if oUnit is not None:
if (oUnit.nValue != iValue) or (oUnit.sValue != sValue):
oUnit.nValue = iValue
oUnit.sValue = sValue
oUnit.Update(Log=True)
oUnit.Parent.TimedOut=0
dUnit["forcerefresh"] = False
elif dUnit["forcerefresh"] or dUnit["alwaysrefresh"] or oUnit.Parent.TimedOut:
oUnit.Parent.TimedOut=0
oUnit.Touch()
dUnit["forcerefresh"] = False
else:
oUnit.Touch()
else:
Domoticz.Error("Received unexpected value " + sReadValue + " for device not anymore in dictionnary")
else:
Domoticz.Error("Field not found in unit dictionaries for circuit " + dUnit["circuit"] + " message " + dUnit["message"] + " field " + str(dUnit["fieldindex"]) + " for value " + sReadValue)
else:
Domoticz.Error("Received unexpected value " + sReadValue)
# Data received, going back to "connected" connection step
self.sConnectionStep = "connected"
# Handle fifo if there are still command to proceed
self.handleFifo()
# parse JSON data received from ebusd
# sData: string: data received
def parseJson(self, sData):
self.bStillToLook = False
self.myDebug("Parsing JSON data")
try:
dJson = json.loads(sData, object_pairs_hook= lambda dict: CaseInsensitiveDict(dict))
# dJson = json.loads(sData)
except Exception as e:
self.bStillToLook = True
Domoticz.Error("Impossible to parse JSON (buffer size " + str(len(sData)) + "). " + traceback.format_exc())
return
iCount = 0
if ("global" in dJson) and ("messages" in dJson["global"]):
iCount = dJson["global"]["messages"]
if iCount == 0:
self.bStillToLook = True
self.myDebug("No usable messages, will try again later")
return
if iCount == self.iJsonObjects:
self.myDebug("No new messages to parse, will try again later")
return
# self.myDebug("Building messages list for " + str(iCount) + " messages")
self.bStillToLook = True
self.iJsonObjects = iCount
if iCount:
self.dMessages = {}
for sCircuit, dItem in dJson.items():
sCircuit = sCircuit.casefold()
if sCircuit == "global":
continue
if sCircuit.startswith("scan."):
continue
# self.myDebug("Exploring circuit " + sCircuit)
if ("messages" in dItem) and (sCircuit != "global"):
for sMessage, dMessageItem in dItem["messages"].items():
# self.myDebug("Exploring message " + sMessage)
if ("name" in dMessageItem) and dMessageItem["name"] and ("fielddefs" in dMessageItem) and (len(dMessageItem["fielddefs"]) > 0):
sMessage = sMessage.casefold()
sMessage = re.sub(r'\[.*\]', '', sMessage)
if sMessage.endswith("-w"):
continue
# self.myDebug("Add " + sCircuit+":"+sMessage + " to messages list")
# self.dMessages[sCircuit+":"+sMessage] = dMessageItem
iFieldsCount = 0
for iAllFieldsIndex, dAllFieldDefs in enumerate(dMessageItem["fielddefs"]):
sAllFieldType = getFieldType(dAllFieldDefs)
if sAllFieldType != "ignore":
self.myDebug("Add " + sCircuit+":"+sMessage+":"+str(iFieldsCount) + " to messages list by field id")
self.dMessages[sCircuit+":"+sMessage+":"+str(iFieldsCount)] = dMessageItem
iFieldsCount += 1
if "name" in dAllFieldDefs and dAllFieldDefs["name"] :
self.myDebug("Add " + sCircuit+":"+sMessage+":"+dAllFieldDefs["name"] + " to messages list by field name")
self.dMessages[sCircuit+":"+sMessage+":"+dAllFieldDefs["name"].casefold()] = dMessageItem
timeNow = time.time()
if not self.sRegExSearch:
lUnits = shlex.split(self.sParamRegisters.strip())
lUnitsSearch = []
lUnitsExclude = []
for sUnit in lUnits:
if sUnit.startswith("!"):
sUnitFixed = sUnit[1:]
if sUnitFixed:
lUnitsExclude.append(sUnitFixed)
else:
lUnitsSearch.append(sUnit)
if len(lUnitsSearch) == 0 :
self.sRegExSearch = re.compile(".*", re.IGNORECASE)
else:
self.sRegExSearch = re.compile("|".join(lUnitsSearch), re.IGNORECASE)
if len(lUnitsExclude) > 0 :
self.sRegExExclude = re.compile("|".join(lUnitsExclude), re.IGNORECASE)
self.myDebug("Search pattern is " + str(self.sRegExSearch))
self.myDebug("Exclude pattern is " + str(self.sRegExExclude))
for sRegister in self.dMessages:
# sDeviceIDField0 = sRegister + ":0"
# if not (sRegister in self.dUnitsByDeviceID) and (self.sRegExSearch.search(sRegister) or self.sRegExSearch.fullmatch(sDeviceIDField0)):
if self.sRegExSearch.search(sRegister):
# now split device in circuit/message/fieldnumber
#lPath = sRegister.split("-")
lPath = sRegister.split(":")
# if it seems incorrect
sCircuit = lPath[0]
sMessage = lPath[1]
sFieldIndex = lPath[2]
# check if writable
sWKey = sMessage + "-w"
if (not self.bParamReadOnly) and (sWKey in dJson[sCircuit]["messages"]) and ("write" in dJson[sCircuit]["messages"][sWKey]) and dJson[sCircuit]["messages"][sWKey]["write"] :
self.myDebug("Writable")
dMessage = dJson[sCircuit]["messages"][sWKey]
bWritable = True
else:
dMessage = dJson[sCircuit]["messages"][sMessage]
bWritable = False
# try to get fieldnumber, if not an integer, try by name
self.myDebug("Look for register " + sCircuit + ":" + sMessage + ":" + sFieldIndex + " in JSON data")
iFieldsCount = 0
iFieldAbsoluteIndex = -1
sFieldName = ""
if sFieldIndex.isdigit():
iFieldIndex = int(sFieldIndex)
for iAllFieldsIndex, dAllFieldDefs in enumerate(dMessage["fielddefs"]):
sAllFieldType = getFieldType(dAllFieldDefs)
if sAllFieldType != "ignore":
if iFieldIndex == iFieldsCount:
iFieldAbsoluteIndex = iAllFieldsIndex
sFieldName = dAllFieldDefs["name"].casefold()
break
iFieldsCount += 1
else:
for iAllFieldsIndex, dAllFieldDefs in enumerate(dMessage["fielddefs"]):
sAllFieldType = getFieldType(dAllFieldDefs)
if sAllFieldType != "ignore":
if dAllFieldDefs["name"].casefold() == sFieldIndex:
iFieldIndex = iFieldsCount
sFieldName = sFieldIndex
iFieldAbsoluteIndex = iAllFieldsIndex
self.myDebug("Field number of register " + sRegister + " is " + str(iFieldIndex))
break
iFieldsCount += 1
if iFieldAbsoluteIndex < 0:
Domoticz.Error("Cannot find usable field for device " + sRegister)
# error on this item, mark device as erroneous and go to next item
self.dUnitsByDeviceID[sRegister] = "no usable field for device"
continue
#flen = len(dMessage["fielddefs"])
#if bWritable and (flen > 1):
#Domoticz.Error("Register " + sCircuit + "-" + sMessage + " has " + str(flen) + " fields and is writable, more than one field and writable isn't supported yet, the register will be read only")
#bWritable = False
#flen = len(dMessage["fielddefs"])
#if bWritable and (flen > 1):
#Domoticz.Error("Register " + sCircuit + "-" + sMessage + " has " + str(flen) + " fields and is writable, more than one field and writable isn't supported yet, the register will be read only")
#bWritable = False
# count fields and keep track of field index, absolute and relative (ignoring IGN fields)
sDeviceIntegerID = sCircuit + ":" + sMessage + ":" + str(iFieldIndex)
# exclude registers based on field id or name
if self.sRegExExclude and self.sRegExExclude.search(sDeviceIntegerID) :
self.myDebug("Exclude " + sRegister + " based on exclude pattern and field id")
continue
if sFieldName:
sDeviceIntegerName = sCircuit + ":" + sMessage + ":" + sFieldName
sDeviceIntegerIDAndName = sDeviceIntegerID + " / " + sDeviceIntegerName
if self.sRegExExclude and self.sRegExExclude.search(sDeviceIntegerName) :
self.myDebug("Exclude " + sRegister + " based on exclude pattern and field name")
continue
else:
sDeviceIntegerIDAndName = sDeviceIntegerID
# we skip if already added (by field id or field name or previous parse)
if sDeviceIntegerID in self.dUnitsByDeviceID:
self.myDebug("Device " + sRegister + " skiped because already in dict")
continue
dFieldDefs = dMessage["fielddefs"][iFieldAbsoluteIndex]
sFieldType = getFieldType(dFieldDefs)
self.myDebug("Field is type " + sFieldType)
#sTypeName = ""
iSwitchType = 0
dValues = None
dOptions = {}
dOptionsMapping = {}
dReverseOptionsMapping = {}
bAlwaysRefresh = False
bCheckSwitchType02 = False
# now we try to get the best match between domoticz sensor and ebusd field type
# https://github.com/domoticz/domoticz/blob/master/hardware/hardwaretypes.h ligne 42
# https://github.com/domoticz/domoticz/blob/master/hardware/plugins/PythonObjects.cpp ligne 410
# on/off type
#if (sFieldType == "switch") and bWritable:
if (sFieldType == "switchonoff") or (sFieldType == "switchyesno"):
# if not bWritable:
# sTypeName = "Contact"
# else:
# sTypeName = "Switch"
iMainType = 0xF4
iSubType = 0x49
if not bWritable:
iSwitchType = 2
bCheckSwitchType02 = True
bHandleTimeout = True
# selector switch type
elif ("values" in dFieldDefs):
if bWritable:
#sTypeName = "Selector Switch"
iMainType = 0xF4
iSubType = 0x3E
iSwitchType = 18
else:
#sTypeName = "Text"
iMainType = 0xF3
iSubType = 0x13
dValues = dFieldDefs["values"]
sLevelActions = "|"
sLevelNames = "donotuse|"
# Sort by key, then enumerate tuple
for iIndexValue, (sIndexInJson, sValue) in enumerate(sorted(dValues.items())):
if iIndexValue > 0:
sLevelActions += "|"
sLevelNames += "|"
sLevelNames += str(sValue)
iIndexValue += 1
iIndexValue *= 10
if bWritable:
dOptionsMapping[sValue] = iIndexValue
else:
dOptionsMapping[sValue] = sValue
dReverseOptionsMapping[iIndexValue] = sValue
self.myDebug("LevelNames for Domoticz are " + sLevelNames)
dOptions = {"LevelActions": sLevelActions, "LevelNames": sLevelNames, "LevelOffHidden": "true", "SelectorStyle": "1"}
# number type, probably to improve
elif (sFieldType == "number") or (sFieldType == "custom") or (sFieldType == "time"):
#sTypeName = "Custom"
iMainType = 0xF3
iSubType = 0x1F
dOptions = { "Custom": "1;" + str(dFieldDefs["unit"])}
# setpoint type
elif (sFieldType == "temperature") and bWritable:
#sTypeName = "Setpoint"
iMainType = 0xF2
iSubType = 0x01
# read-only temperature type
elif (sFieldType == "temperature"):
#sTypeName = "Temperature"
iMainType = 0x50
iSubType = 0x05
bAlwaysRefresh = True
# pressure type
elif (sFieldType == "pressure"):
#sTypeName = "Pressure"
iMainType = 0xF3
iSubType = 0x09
bAlwaysRefresh = True
# fan type
elif (sFieldType == "rpm"):
#sTypeName = "Fan"
iMainType = 0xF3
iSubType = 0x07
# percentage type
elif (sFieldType == "percentage"):
# sTypeName = "Percentage"
iMainType = 0xF3
iSubType = 0x06
bAlwaysRefresh = True
# else text type (including for timedate)
else:
#sTypeName = "Text"
iMainType = 0xF3
iSubType = 0x13
iImage = 0
if (sFieldType == "timedate") or (sFieldType == "time"):
iImage = 21
# check if device is already in domoticz database, based on deviceid
bFound = False
bForceRefresh = False
if dFieldDefs["comment"]:
sComment = " - " + dFieldDefs["comment"]
else:
sComment = ""
for sCurrentDeviceID, oDevice in Devices.items():
# .casefold() for backward compatibility
if sCurrentDeviceID.casefold() == sDeviceIntegerID:
sDeviceIntegerID = sCurrentDeviceID
for iIndexUnit, oUnit in oDevice.Units.items():
# log device found, with dFieldDefs["name"] and dFieldDefs["comment"] giving hints on how to use register
Domoticz.Status("Device detected: " + oUnit.Name + " unit " + str(iIndexUnit) + " and register " + sDeviceIntegerIDAndName + sComment)
if (oUnit.Type != iMainType) or (oUnit.SubType != iSubType) or (bCheckSwitchType02 and ((not bWritable and (iSwitchType == 0)) or (bWritable and (iSwitchType == 2)))):
if (self.iBuild >= 16100) or (self.iVersion > 2024000004) :
Domoticz.Status("Device " + sDeviceIntegerID + " type changed, updating Domoticz database as type " + str(iMainType) + ", subtype " + str(iSubType) + " and switchtype " + str(iSwitchType))
bForceRefresh = True
oUnit.Type=iMainType
oUnit.SubType=iSubType
oUnit.SwitchType=iSwitchType
oUnit.Image=iImage
oUnit.Options=dOptions
oUnit.Update(Log=False, UpdateProperties=True, UpdateOptions=True)
oUnit.Parent.TimedOut=0
else:
Domoticz.Error("Device " + sDeviceIntegerID + " type is incorrect, you should consider deleting it and restart the plugin")
# if found, continue loop to next item
bFound = True
break
break
# not in database: add device
if not bFound:
bForceRefresh = True
iIndexUnit = 1
# Create name
sCompleteName = sCircuit + " - " + sMessage
if dFieldDefs["name"] != "":
sCompleteName += " - " + dFieldDefs["name"]
else:
sCompleteName += " - " + sFieldIndex
if not self.bParamAutoAdd :
self.myDebug("Found " + sDeviceIntegerIDAndName + sComment + " but not adding it because auto add is disabled")
continue
# if the user didn't specify a filter, we will add every devices, but don't include all to prevent cluttering the GUI, keep them not used in devices list
if len(lUnitsSearch) == 0 :
iUsed = 0
else:
iUsed = 1
# create device, log dFieldDefs["name"] and dFieldDefs["comment"] giving hints on how to use register
Domoticz.Unit(Name=sCompleteName, Unit=iIndexUnit, Type=iMainType, Subtype=iSubType, Switchtype=iSwitchType, Image=iImage, Description=dFieldDefs["comment"], Options=dOptions, Used=iUsed, DeviceID=sDeviceIntegerID).Create()
if (sDeviceIntegerID in Devices) and (iIndexUnit in Devices[sDeviceIntegerID].Units):
Domoticz.Status("Add register " + sDeviceIntegerIDAndName + " unit " + str(iIndexUnit) + " as type " + str(iMainType) + ", subtype " + str(iSubType) + " and switchtype " + str(iSwitchType) + sComment)
else:
Domoticz.Error("Cannot add register " + sDeviceIntegerIDAndName + " unit " + str(iIndexUnit) + ". Check in settings that Domoticz is set up to accept new devices")
self.bStillToLook = True
break
# incorporate found or created device to local self.dUnits dictionnaries, to keep additionnal parameters used by the plugin
self.dUnitsByDeviceID[sDeviceIntegerID] = { "device":Devices[sDeviceIntegerID].Units[iIndexUnit], "circuit":sCircuit, "message":sMessage, "fieldindex":iFieldIndex, "fieldscount":iFieldsCount, "options":dOptionsMapping, "reverseoptions":dReverseOptionsMapping, "domoticzoptions": dOptions, "fieldtype": sFieldType, "forcerefresh": bForceRefresh, "alwaysrefresh": bAlwaysRefresh }
# set fieldsvaluestimestamp for read then write timeout
self.dUnitsByDeviceID[sDeviceIntegerID]["fieldsvaluestimestamp"] = timeNow - (2 * self.iTimeoutConstant)
if not sCircuit in self.dUnits3D:
self.dUnits3D[sCircuit] = {}
if not sMessage in self.dUnits3D[sCircuit]:
self.dUnits3D[sCircuit][sMessage] = {}
self.dUnits3D[sCircuit][sMessage][iFieldIndex] = self.dUnitsByDeviceID[sDeviceIntegerID]
# place a read command in the queue for each device to refresh its value asap
self.read(self.dUnitsByDeviceID[sDeviceIntegerID])
self.myDebug("End of parsing JSON data")
def onStart(self):
Domoticz.Debug("onStart called")
# Ignore username and password, I'm not sure when I should authenticate and it can be handled by ACL file directly by ebusd
#Domoticz.Log("Username set to " + Parameters["Username"])
self.sParamAddress = Parameters["Address"]
try:
self.iParamTelnetPort = int(Parameters["Port"])
except ValueError:
Domoticz.Error("HTTP port parameter incorrect, set to its default value")
try:
self.iParamJsonPort = int(Parameters["Mode1"])
except ValueError:
Domoticz.Error("JSON port parameter incorrect, set to its default value")
self.sParamRegisters = Parameters["Mode2"]
try:
self.iParamRefreshRate = int(Parameters["Mode3"])
except ValueError:
Domoticz.Error("Refresh rate parameter incorrect, set to its default value")
self.bParamDisableCache = Parameters["Mode4"] == "True"
self.bParamReadOnly = False
self.bParamAutoAdd = True
if "True" in Parameters["Mode5"]:
self.bParamReadOnly = True
if "NoAuto" in Parameters["Mode5"]:
self.bParamAutoAdd = False
try:
self.iParamDebug = int(Parameters["Mode6"])
except ValueError:
Domoticz.Error("Debug level parameter incorrect, set to its default value")
matchVersions = re.search(r"(\d+)[^\d]+(\d+)[^\d]*(\d*)", Parameters["DomoticzVersion"])
if (matchVersions):
iVersionMaj = int(matchVersions.group(1))
iVersionMin = int(matchVersions.group(2))
if matchVersions.group(3) :
self.iBuild = int(matchVersions.group(3))
else :
self.iBuild = 0
self.iVersion = (iVersionMaj * 1000000) + iVersionMin
# Domoticz.Error(Parameters["DomoticzVersion"] + "/" + str(iVersionMaj) + "/" + str(iVersionMin) + "/" + str(self.iBuild) + "/" + str(self.iVersion))
if self.iVersion < 2024000001:
Domoticz.Error("Your Domoticz version is too old for the plugin to work properly, you might observe unexpected behavior")
Domoticz.Log("This plugin is compatible with Domoticz version 2024.1 onwards")
Domoticz.Log("IP or named address set to " + self.sParamAddress)
Domoticz.Log("Telnet port set to " + str(self.iParamTelnetPort))
Domoticz.Log("JSON HTTP port set to " + str(self.iParamJsonPort))
Domoticz.Log("Refresh rate set to " + str(self.iParamRefreshRate))
Domoticz.Log("Registers set to " + self.sParamRegisters)
Domoticz.Log("Disable cache set to " + str(self.bParamDisableCache))
Domoticz.Log("Read-only set to " + str(self.bParamReadOnly))
Domoticz.Log("Auto add set to " + str(self.bParamAutoAdd))
Domoticz.Log("Debug set to " + str(self.iParamDebug))
# most init
self.__init__()
# enable debug if required
if self.iParamDebug > 1:
Domoticz.Debugging(1)
# set heartbeat interval
if self.iParamRefreshRate < self.iMaxHeartbeatInterval:
Domoticz.Heartbeat(self.iParamRefreshRate)
else:
Domoticz.Heartbeat(self.iMaxHeartbeatInterval)
# we need to let at least 2 heartbeats before discovering to launch discovering then populate dUnits dict
if self.iDiscoverTime < (3 * self.iParamRefreshRate):
self.iDiscoverTime = 3 * self.iParamRefreshRate
# now we can enabling the plugin
self.bIsStarted = True
# Ignore username and password, I'm not sure when I should authenticate and it can be handled by ACL file directly by ebusd
#if Parameters["Username"] != "":
#self.dqFifo.append({"operation":"authenticate"})
# first scan of available registers
self.findDevices()
def onStop(self):
Domoticz.Debug("onStop called")
# prevent error messages during disabling plugin
self.bIsStarted = False
# close connections
if self.telnetConn != None:
if self.telnetConn.Connected():
self.telnetConn.Disconnect()
if self.jsonConn != None:
if self.jsonConn.Connected():
self.jsonConn.Disconnect()
self.__init__()
def onConnect(self, Connection, Status, Description):
Domoticz.Debug("onConnect called")
if self.bIsStarted:
if ((Connection == self.jsonConn) and (Status == 0)):
self.myDebug("onConnect for json called")
self.findDevices()
elif ((Connection == self.telnetConn) and (Status == 0)):
self.myDebug("onConnect for telnet called")
self.sConnectionStep = "connected"
self.handleFifo()
def onMessage(self, Connection, Data):
Domoticz.Debug("onMessage called")
# if started and not stopping
if self.bIsStarted:
# message for finddevices: JSON HTTP response, buffer completion is handled by domoticz HTTP protocol
if (Connection == self.jsonConn):
sData = Data["Data"].decode("utf-8", "ignore")
Status = int(Data["Status"])
if (Status == 200):
self.myDebug("Good Response received from ebusd : length " + str(len(sData)))
#self.jsonConn.Disconnect()
# now parse
self.parseJson(sData)
else:
Domoticz.Error("ebusd JSON HTTP interface returned a status: " + str(Status))
# telnet answer, buffer may be incomplete, we wait for \n\n to be sure to get complete response, buffer completion is not handled by domoticz line protocol
else:
sData = Data.decode("utf-8", "ignore")
# self.myDebug("Received data size " + str(len(sData)) + ": '"+sData+"'")
# we limit buffer size to keep memory, telnet answer shouldn't be big, as used by the plugin
if len(self.sBuffer) > 100000:
self.sBuffer = ""
self.sBuffer += sData
# \n\n is the end of telnet response send by ebusd
if sData.endswith("\n\n"):
# self.myDebug("Received buffer size " + str(len(self.sBuffer)) + ": '"+self.sBuffer+"'")
# now parse
self.parseTelnet(self.sBuffer)
# empty buffer
self.sBuffer = ""
def onCommand(self, DeviceID, Unit, Command, Level, Hue):
Domoticz.Debug("onCommand called for device " + str(DeviceID) + " unit " + str(Unit) + ": Parameter '" + str(Command) + "', Level: " + str(Level) + ", Hue: " + str(Hue))
# if started and not stopping
if self.bIsStarted:
# add write to the queue
self.write(DeviceID, Unit, Command, Level, "")
def onDeviceModified(self, DeviceID, Unit):
Domoticz.Debug("onDeviceModified called for device " + str(DeviceID) + " unit " + str(Unit))
def onNotification(self, Name, Subject, Text, Status, Priority, Sound, ImageFile):
Domoticz.Debug("onNotification called: " + Name + "," + Subject + "," + Text + "," + Status + "," + str(Priority) + "," + Sound + "," + ImageFile)
def onDisconnect(self, Connection):
Domoticz.Debug("onDisconnect called")
# Add a read command to the queue
# dUnit: dict
def read(self, dUnit):
if type(dUnit) is dict:
self.myDebug("read called for circuit " + dUnit["circuit"] + " message " + dUnit["message"] + " field " + str(dUnit["fieldindex"]))
self.dqFifo.append({"operation":"read", "unit":dUnit})
self.handleFifo()
else:
Domoticz.Error("Cannot read device that is in error state: " + dUnit)
# Will write a value to ebusd
# sDeviceID: string: device in Devices dict
# ifLevel: integer or float: value to write
def write(self, sDeviceID, iUnitNumber, sCommand, ifValue, sValue):
Domoticz.Debug("write called for device " + str(sDeviceID) + " command " + sCommand + " value " + str(ifValue) + " / " + sValue)
if self.bParamReadOnly:
Domoticz.Debug("Cannot write device " + str(sDeviceID) + " because the read-only parameter is set")
return
elif sDeviceID in self.dUnitsByDeviceID:
dUnit = self.dUnitsByDeviceID[sDeviceID]
# convert domoticz command and level to ebusd string value
sValue = valueDomoticzToEbusd(dUnit, sCommand, ifValue, sValue, Devices[sDeviceID].Units[iUnitNumber].nValue, Devices[sDeviceID].Units[iUnitNumber].sValue)
# if there are more than one field, we must read all fields, modify the required field and write back all fields at once
iFieldsCount = dUnit["fieldscount"]
if iFieldsCount <= 1:
self.myDebug("Will write " + sValue)
self.dqFifo.append({"operation":"write", "unit":dUnit, "value":sValue})
# write then read to update Domoticz interface
self.dqFifo.append({"operation":"read", "unit":dUnit})
# launch commands in the queue
self.handleFifo()
else:
self.myDebug("Will write (more than one field) " + sValue)
# read all fields first before write one field when more than one field in the message
self.dqFifo.append({"operation":"read", "unit":dUnit})
self.dqFifo.append({"operation":"write", "unit":dUnit, "value":sValue})
# write then read to update Domoticz interface
self.dqFifo.append({"operation":"read", "unit":dUnit})
# launch commands in the queue
self.handleFifo()
else:
Domoticz.Error("Cannot write device " + str(sDeviceID) + " that doesn't exist")
# Handle the connection to Telnet port and the command queue
def handleFifo(self):
Domoticz.Debug("handleFifo() called")
timeNow = time.time()
# init of self.iConnectionTimestamp
if self.iConnectionTimestamp == 0 :
self.iConnectionTimestamp = timeNow
# telnet connection not connected yet or no data processing
if ((self.sConnectionStep == "idle") or (self.sConnectionStep == "connected")) and (len(self.dqFifo) > 0):
# record time
self.iConnectionTimestamp = timeNow
# create connection
if self.telnetConn == None:
self.myDebug("handleFifo() create connection to " + self.sParamAddress + ":" + str(self.iParamTelnetPort))
self.telnetConn = Domoticz.Connection(Name="Telnet", Transport="TCP/IP", Protocol="", Address=self.sParamAddress, Port=str(self.iParamTelnetPort))
if not self.telnetConn.Connected():
self.myDebug("Connect")
self.sConnectionStep = "connecting"
self.telnetConn.Connect()
# or process queue
else:
self.myDebug("Handle")
# pop command from queue (first in first out)
# pop command from queue (first in first out)
sCommand = self.dqFifo.popleft()
dUnit = sCommand["unit"]
self.sConnectionStep = "data sending"
if type(dUnit) is dict:
self.sCurrentCommand = sCommand["operation"]
# read command
if self.sCurrentCommand == "read":
#self.telnetConn.Send("read -c " + dUnit["circuit"] + " " + dUnit["message"] + "\r\n")
#self.telnetConn.Send("read -c " + dUnit["circuit"] + " " + dUnit["message"] + " " + dUnit["fieldname"] + "." + str(dUnit["fieldindex"]) + "\r\n")
# telnet read command in verbose mode
sRead = "read "
# if no cache
if self.bParamDisableCache :
sRead = sRead + "-f "
sRead = sRead + " -v -c " + dUnit["circuit"] + " " + dUnit["message"] + "\r\n"
self.myDebug("Telnet write: " + sRead)
self.telnetConn.Send(sRead)
# write command
elif self.sCurrentCommand == "write" and (not self.bParamReadOnly):
iFieldsCount = dUnit["fieldscount"]
# we have more than one field, retrieve all fields value (from last read) if not too old, modify the field and write
if iFieldsCount > 1:
if ((dUnit["fieldsvaluestimestamp"] + self.iTimeoutConstant) >= timeNow):
# fields in a string are separated by ;
lData = dUnit["fieldsvalues"].split(";")
# sanity check
if len(lData) != iFieldsCount:
Domoticz.Error("Field count is not " + str(iFieldsCount) + " as expected")
else:
# modify register
lData[dUnit["fieldindex"]] = sCommand["value"]
# rebuild the fields for the message, in a string, with ; as separator
sData = ";".join(lData)
# telnet write command
sWrite = "write -c " + dUnit["circuit"] + " " + dUnit["message"] + " " + sData + "\r\n"
self.myDebug("Telnet write: " + sWrite)
self.telnetConn.Send(sWrite)
else:
Domoticz.Error("Data cached is too old or inexistent, won't take the risk to modify many fields at once")
else:
# telnet write command if only one field in message
sWrite = "write -c " + dUnit["circuit"] + " " + dUnit["message"] + " " + sCommand["value"] + "\r\n"
self.myDebug("Telnet write: " + sWrite)
self.telnetConn.Send(sWrite)
# Ignore username and password, I'm not sure when I should authenticate and it can be handled by ACL file directly by ebusd
#elif self.sCurrentCommand == "authenticate":
#sWrite = "auth " + Parameters["Username"] + " " + Parameters["Password"] + "\r\n"
#self.myDebug("Telnet write:" + sWrite)
else:
Domoticz.Error("Received command for unit in error state: " + dUnit)
# the plugin seems blocked in connecting or data sending step, restart the plugin
elif (len(self.dqFifo) > 0) and (timeNow >= (self.iConnectionTimestamp + self.iTimeoutConstant)) :
Domoticz.Error("Timeout during handleFifo, ask to restart plugin")
self.bShallRestart = True
return
def onHeartbeat(self):
Domoticz.Debug("onHeartbeat() called")
# if started and not stopping
if self.bIsStarted:
# restart pending ?
if self.bShallRestart:
self.onStop()
self.onStart()
else:
timeNow = time.time()
# refresh
if (timeNow >= (self.iRefreshTime + self.iParamRefreshRate)) :
# refresh values of already detected registers
for sCircuit in self.dUnits3D:
for sMessage in self.dUnits3D[sCircuit]:
# only refresh first found field, read operation will read all declared fields anyway
dUnit = next(iter(self.dUnits3D[sCircuit][sMessage].values()), None)
if dUnit:
self.read(dUnit)
# check for timeouts
for sDeviceID, oDevice in Devices.items():
if not oDevice.TimedOut:
if sDeviceID in self.dUnitsByDeviceID:
dUnit = self.dUnitsByDeviceID[sDeviceID]
if (dUnit["fieldsvaluestimestamp"] + (3 * self.iParamRefreshRate)) < timeNow:
Domoticz.Error("DeviceID " + oDevice.DeviceID + " not refreshed since a long time and timed out")
oDevice.TimedOut=1
else:
if timeNow >= (self.iDiscoverStartTime + self.iDiscoverTime):
Domoticz.Error("DeviceID " + oDevice.DeviceID + " not detected and timed out")
oDevice.TimedOut=1
# we still not have detected all registers given in configuration, retry JSON search
if self.bStillToLook or (timeNow >= (self.iRefreshFindDeviceTime + self.iRefreshFindDeviceRate)) :
self.findDevices()
self.iRefreshFindDeviceTime = timeNow
self.iRefreshTime = timeNow
global _plugin
_plugin = BasePlugin()
def onStart():
global _plugin
_plugin.onStart()