forked from Wizzard72/Domoticz-AtagOne
-
Notifications
You must be signed in to change notification settings - Fork 0
/
plugin.py
474 lines (427 loc) · 22.8 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
# AtagOne-On-Premise plugin
#
# Author: Wizzard72
#
"""
<plugin key="AtagOneOnPremise" name="AtagOne on-premise" author="Wizzard72" version="2.0.0" wikilink="https://github.com/Wizzard72/Domoticz-AtagOne" externallink="https://www.atag-one.com//">
<description>
<h2>AtagOne Local plugin</h2><br/>
Provides direct local network access to an installed Atag One thermostat.
Forked from code developed by mcorino (https://github.com/mcorino/Domoticz-AtagOne-Local).
Based on the code developed by Rob Juurlink (https://github.com/kozmoz/atag-one-api).
Creates a thermostat setpoint sensor and a temperature sensor.
</description>
<params>
<param field="Address" label="IP Address of Atag One" width="200px" required="true" default="127.0.0.1"/>
<param field="Mode1" label="Domoticz MAC" width="600px" required="true" default="1A-2B-3C-4D-5E-6F"/>
<param field="Mode2" label="Debug" width="75px">
<options>
<option label="True" value="Debug"/>
<option label="False" value="Normal" default="True" />
</options>
</param>
</params>
</plugin>
"""
import Domoticz
import socket
import json
class BasePlugin:
MESSAGE_INFO_CONTROL = 1
MESSAGE_INFO_SCHEDULES = 2
MESSAGE_INFO_CONFIGURATION = 4
MESSAGE_INFO_REPORT = 8
MESSAGE_INFO_STATUS = 16
MESSAGE_INFO_WIFISCAN = 32
MESSAGE_INFO_EXTRA = 64
HTTP_CLIENT_PORT = '10000'
TARGET_TEMP_UNIT = 1
ROOM_TEMP_UNIT = 2
OUTSIDE_TEMP_UNIT = 3
BURNING_HOURS_UNIT = 4
CH_SETPOINT_UNIT = 5
DHW_WATER_TEMP_UNIT = 6
CH_WATER_TEMP_UNIT = 7
CH_WATER_PRES_UNIT = 8
CH_RETURN_TEMP_UNIT = 9
TEMPERATURE_MIN = 4.0
TEMPERATURE_MAX = 27.0
FLAME_ON_IMG = 'AtagOneLocalFlame'
FLAME_OFF_IMG = 'AtagOneLocalNoFlame'
hostMac = '1a-2b-3c-4d-5e-6f' # 'unique' MAC
hostName = 'Domoticz Atag One API'
hostAuth = True
setLevel = False
newLevel = None
atagConn = None
countDown = -1
def __init__(self):
#self.var = 123
return
def onStart(self):
Domoticz.Debug("onStart called")
if Parameters["Mode2"] == 'Debug':
Domoticz.Debugging(1)
DumpConfigToLog()
else:
Domoticz.Debugging(0)
self.hostMac = str(Parameters['Mode1'])
if (self.FLAME_ON_IMG not in Images):
Domoticz.Log('Loading flame ON images')
Domoticz.Image('flame-on-icons.zip').Create()
if (self.FLAME_OFF_IMG not in Images):
Domoticz.Log('Loading flame OFF images')
Domoticz.Image('flame-off-icons.zip').Create()
for image in Images:
Domoticz.Debug("Icon " + str(Images[image].ID) + " " + Images[image].Name)
#Domoticz.Debug('flame ON image='+str(Images[self.FLAME_ON_IMG].ID))
#Domoticz.Debug('flame OFF image='+str(Images[self.FLAME_OFF_IMG].ID))
if (self.TARGET_TEMP_UNIT not in Devices):
Domoticz.Device(Name="Room Setpoint", Unit=self.TARGET_TEMP_UNIT, Type=242, Subtype=1, Image=Images[self.FLAME_OFF_IMG].ID).Create()
UpdateDevice(self.TARGET_TEMP_UNIT, 0, "0.0")
if (self.ROOM_TEMP_UNIT not in Devices):
Domoticz.Device(Name="Room Temperature", Unit=self.ROOM_TEMP_UNIT, TypeName='Temperature').Create()
UpdateDevice(self.ROOM_TEMP_UNIT, 0, "0.0")
if (self.OUTSIDE_TEMP_UNIT not in Devices):
Domoticz.Device(Name="Outside Temperature", Unit=self.OUTSIDE_TEMP_UNIT, TypeName='Temperature').Create()
UpdateDevice(self.OUTSIDE_TEMP_UNIT, 0, "0.0")
if (self.BURNING_HOURS_UNIT not in Devices):
Domoticz.Device(Name="Burning Hours", Unit=self.BURNING_HOURS_UNIT, Type=243, Subtype=31).Create()
UpdateDevice(self.BURNING_HOURS_UNIT, 0, "0.0")
if (self.CH_SETPOINT_UNIT not in Devices):
Domoticz.Device(Name="CH Setpoint", Unit=self.CH_SETPOINT_UNIT, Type=242, Subtype=1, Image=Images[self.FLAME_OFF_IMG].ID).Create()
UpdateDevice(self.CH_SETPOINT_UNIT, 0, "0.0")
if (self.DHW_WATER_TEMP_UNIT not in Devices):
Domoticz.Device(Name="DHW Water Temperature", Unit=self.DHW_WATER_TEMP_UNIT, TypeName='Temperature').Create()
UpdateDevice(self.DHW_WATER_TEMP_UNIT, 0, "0.0")
if (self.CH_WATER_TEMP_UNIT not in Devices):
Domoticz.Device(Name="CH Water Temperature", Unit=self.CH_WATER_TEMP_UNIT, TypeName='Temperature').Create()
UpdateDevice(self.CH_WATER_TEMP_UNIT, 0, "0.0")
if (self.CH_WATER_PRES_UNIT not in Devices):
Domoticz.Device(Name="CH Water Pressure", Unit=self.CH_WATER_PRES_UNIT, TypeName='Pressure').Create()
UpdateDevice(self.CH_WATER_PRES_UNIT, 0, "0.0")
if (self.CH_RETURN_TEMP_UNIT not in Devices):
Domoticz.Device(Name="CH Return Temperature", Unit=self.CH_RETURN_TEMP_UNIT, TypeName='Temperature').Create()
UpdateDevice(self.CH_RETURN_TEMP_UNIT, 0, "0.0")
self.SetupConnection()
Domoticz.Heartbeat(30)
def onStop(self):
Domoticz.Log("onStop called")
def onConnect(self, Connection, Status, Description):
Domoticz.Debug("onConnect called")
Domoticz.Log("Value changed")
Domoticz.Debug("Status = "+str(Status))
Domoticz.Debug("Description = "+str(Description))
if (Status == 0):
Domoticz.Log("Atag One connected successfully.")
if self.hostAuth:
if self.setLevel:
Domoticz.Log("Setting Atag One target temperature.")
self.UpdateTargetTemp(self.newLevel)
else:
Domoticz.Log("Requesting Atag One details.")
self.RequestDetails()
else:
Domoticz.Log("Requesting Atag One authorization.")
self.Authenticate()
else:
Domoticz.Log("Failed to connect ("+str(Status)+") to: "+Parameters["Address"]+":"+str(self.HTTP_CLIENT_PORT)+" with error: "+Description)
self.countDown = 6
def onMessage(self, Connection, Data):
Domoticz.Debug("onMessage called")
Status = int(Data["Status"])
Domoticz.Debug("onMessage Data = "+str(Data))
if (self.atagConn.Connecting() or self.atagConn.Connected()):
Domoticz.Debug("Connection is alive.")
if (Status == 200):
strData = Data["Data"].decode("utf-8", "ignore")
Domoticz.Debug('Atag One response: '+strData)
atagResponse = json.loads(strData)
if ('retrieve_reply' in atagResponse):
self.countDown = self.ProcessDetails(atagResponse['retrieve_reply'])
return
if ('pair_reply' in atagResponse):
self.countDown = self.ProcessAuthorization(atagResponse['pair_reply'])
return
if ('update_reply' in atagResponse):
Domoticz.Debug("Update_reply = "+str(atagResponse['update_reply']))
self.ProcessUpdate(atagResponse['update_reply'])
else:
Domoticz.Log('Unknown response from Atag One')
else:
Domoticz.Error('Atag One returned status='+Data['Status'])
self.countDown = 6
def onCommand(self, Unit, Command, Level, Hue):
Domoticz.Log("onCommand called for Unit " + str(Unit) + ": Parameter '" + str(Command) + "', Level: " + str(Level))
if (int(Unit) == self.TARGET_TEMP_UNIT) and (int(Unit) in Devices) and (str(Command) == 'Set Level'):
if (self.atagConn == None) or (not self.atagConn.Connected()):
self.setLevel = True
self.newLevel = Level
Domoticz.Debug('Attempting to reconnect Atag One')
self.SetupConnection()
else:
Domoticz.Log('Requesting Atag One details')
self.UpdateTargetTemp(Level)
def onNotification(self, Name, Subject, Text, Status, Priority, Sound, ImageFile):
Domoticz.Debug("onNotification called")
Domoticz.Log("Notification: " + Name + "," + Subject + "," + Text + "," + Status + "," + str(Priority) + "," + Sound + "," + ImageFile)
def onDisconnect(self, Connection):
Domoticz.Debug("onDisconnect called")
def onHeartbeat(self):
Domoticz.Debug("onHeartbeat called")
if (self.atagConn != None) and (self.atagConn.Connecting()):
return
if self.countDown >= 0: self.countDown -= 1
if self.countDown == 0:
if (self.atagConn == None) or (not self.atagConn.Connected()):
Domoticz.Debug('Attempting to reconnect AtagOne')
self.SetupConnection()
else:
if self.hostAuth:
Domoticz.Log('Requesting Atag One details')
self.RequestDetails()
else:
Domoticz.Log("Requesting Atag One authorization.")
self.Authenticate()
def SetupConnection(self):
Domoticz.Debug("SetupConnection called")
self.atagConn = Domoticz.Connection(Name='AtagOneLocalConn', Transport="TCP/IP", Protocol="HTTP", Address=Parameters["Address"], Port=self.HTTP_CLIENT_PORT)
self.atagConn.Connect()
# self.Authenticate()
newCountDown = 1
def RequestDetails(self):
Domoticz.Debug("RequestDetails called")
payload = { "retrieve_message": { "seqnr": 1,
"account_auth" : { "user_account": "",
"mac_address": self.hostMac },
"info": self.MESSAGE_INFO_CONTROL+self.MESSAGE_INFO_REPORT } }
sendData = { 'Verb' : 'POST',
'URL' : '/retrieve',
'Headers' : { 'User-Agent': "Mozilla/5.0 (compatible; AtagOneLocalAPI/1.0.0; http://atag.one/)",
'X-OneApp-Version': '1.0.0', \
'Content-Type': 'application/json; UTF-8', \
'Connection': 'keep-alive', \
'Accept': '*/*', \
'Accept-Charset': 'UTF-8', \
'Host': Parameters["Address"]+":"+str(self.HTTP_CLIENT_PORT) },
'Data' : json.dumps(payload)
}
self.atagConn.Send(sendData)
def ProcessDetails(self, response):
Domoticz.Debug("ProcessDetails called")
Domoticz.Debug("ProcessDetails response = "+str(response))
newCountDown = 6
if (('acc_status' in response) and int(response['acc_status']) == 2) and ('report' in response) and ('control' in response):
report = response['report']
control = response['control']
if ('room_temp' in report) and ('ch_mode_temp' in control) and ('boiler_status' in report):
roomTemp = report['room_temp']
targetTemp = control['ch_mode_temp']
boilerStatus = int(report['boiler_status'])
Domoticz.Debug('Atag One status retrieved: roomTemp='+str(roomTemp))
Domoticz.Debug('Atag One status retrieved: ch_mode_temp='+str(targetTemp))
Domoticz.Debug('Atag One status retrieved: boilerStatus='+str(boilerStatus))
if ((boilerStatus & 8) == 8):
Domoticz.Debug('Updating with flame ON')
UpdateDevice(self.TARGET_TEMP_UNIT, int(targetTemp), str(targetTemp))
else:
Domoticz.Debug('Updating with flame OFF')
UpdateDevice(self.TARGET_TEMP_UNIT, int(targetTemp), str(targetTemp))
UpdateDevice(self.ROOM_TEMP_UNIT, int(roomTemp), str(roomTemp))
else:
Domoticz.Log('Atag One invalid retrieve response (room_temp/ch_mode_temp/boiler_status)')
else:
if (('acc_status' in response) and (int(response['acc_status']) == 3)):
self.hostAuth = False
newCountDown = 1
else:
if (('acc_status' in response) and (int(response['acc_status']) == 0)):
newCountDown = 12 # wait longer before retrying
Domoticz.Log('Atag One missing retrieve response (report and/or control)')
if (('acc_status' in response) and int(response['acc_status']) == 2) and ('report' in response):
report = response['report']
if ('room_temp' in report):
roomTemp = report['room_temp']
Domoticz.Debug('Atag One status retrieved: roomTemp='+str(roomTemp))
UpdateDevice(self.ROOM_TEMP_UNIT, int(roomTemp), str(roomTemp))
else:
Domoticz.Log('Atag One invalid retrieve response (room_temp)')
if ('outside_temp' in report):
outsideTemp = report['outside_temp']
Domoticz.Debug('Atag One status retrieved: outside_temp='+str(outsideTemp))
UpdateDevice(self.OUTSIDE_TEMP_UNIT, int(outsideTemp), str(outsideTemp))
else:
Domoticz.Log('Atag One invalid retrieve response (outside_temp)')
if ('burning_hours' in report):
burningHours = report['burning_hours']
Domoticz.Debug('Atag One status retrieved: burning_hours='+str(burningHours))
UpdateDevice(self.BURNING_HOURS_UNIT, int(burningHours), str(burningHours))
else:
Domoticz.Log('Atag One invalid retrieve response (burning_hours)')
if ('ch_setpoint' in report):
chSetpoint = report['ch_setpoint']
Domoticz.Debug('Atag One status retrieved: ch_setpoint='+str(chSetpoint))
UpdateDevice(self.CH_SETPOINT_UNIT, int(chSetpoint), str(chSetpoint))
else:
Domoticz.Log('Atag One invalid retrieve response (ch_setpoint)')
if ('dhw_water_temp' in report):
dhwWaterTemp = report['dhw_water_temp']
Domoticz.Debug('Atag One status retrieved: dhw_water_temp='+str(dhwWaterTemp))
UpdateDevice(self.DHW_WATER_TEMP_UNIT, int(dhwWaterTemp), str(dhwWaterTemp))
else:
Domoticz.Log('Atag One invalid retrieve response (dhw_water_temp)')
if ('ch_water_temp' in report):
chWaterTemp = report['ch_water_temp']
Domoticz.Debug('Atag One status retrieved: ch_water_temp='+str(chWaterTemp))
UpdateDevice(self.CH_WATER_TEMP_UNIT, int(chWaterTemp), str(chWaterTemp))
else:
Domoticz.Log('Atag One invalid retrieve response (ch_water_temp)')
if ('ch_water_pres' in report):
chWaterPres = report['ch_water_pres']
Domoticz.Debug('Atag One status retrieved: dhw_water_pres='+str(chWaterPres))
UpdateDevice(self.CH_WATER_PRES_UNIT, int(chWaterPres), str(chWaterPres))
else:
Domoticz.Log('Atag One invalid retrieve response (ch_water_pres)')
if ('ch_return_temp' in report):
chReturnTemp = report['ch_return_temp']
Domoticz.Debug('Atag One status retrieved: ch_return_temp='+str(chReturnTemp))
UpdateDevice(self.CH_RETURN_TEMP_UNIT, int(chReturnTemp), str(chReturnTemp))
else:
Domoticz.Log('Atag One invalid retrieve response (ch_return_temp)')
else:
if (('acc_status' in response) and (int(response['acc_status']) == 3)):
Domoticz.Error("Atag One acc_status "+str(response['acc_status']))
self.hostAuth = False
newCountDown = 1
else:
if (('acc_status' in response) and (int(response['acc_status']) == 0)):
Domoticz.Error("Atag One acc_status "+str(response['acc_status']))
newCountDown = 12 # wait longer before retrying
Domoticz.Log('Atag One missing retrieve response (report)')
return newCountDown
def Authenticate(self):
Domoticz.Debug("Authenticate called")
payload = { "pair_message": { "seqnr": 1,
"account_auth": { "user_account": "",
"mac_address": self.hostMac },
"accounts": {"entries": [{"user_account": "",
"mac_address": self.hostMac,
"device_name": self.hostName,
"account_type": 0}]} } }
sendData = { 'Verb' : 'POST',
'URL' : '/pair_message',
'Headers' : { 'User-Agent': "Mozilla/5.0",
'Content-Type': 'application/json', \
'Connection': 'keep-alive', \
'Accept': '*/*', \
'Accept-Charset': 'UTF-8', \
'Host': Parameters["Address"]+":"+str(self.HTTP_CLIENT_PORT) },
'Data' : json.dumps(payload)
}
self.atagConn.Send(sendData)
def ProcessAuthorization(self, response):
Domoticz.Debug("ProcessAuthorization called")
newCountDown = 6
if ('acc_status' in response):
if (int(response['acc_status']) == 2):
self.hostAuth = True
Domoticz.Log('Atag One connection authorized')
else:
if (int(response['acc_status']) == 1):
newCountDown = 1
Domoticz.Log('Atag One authorization pending')
else:
if (int(response['acc_status']) == 3):
Domoticz.Log('Atag One authorization denied. Retry in a minute.')
else:
Domoticz.Log('Atag One invalid pairing response: acc_status='+str(response['acc_status']))
else:
Domoticz.Log('Atag One invalid pairing response')
return newCountDown
def UpdateTargetTemp(self, target):
Domoticz.Debug("UpdateTargetTemp called")
Domoticz.Debug("target = "+str(target))
self.setLevel = False
if (float(target) < self.TEMPERATURE_MIN) or (float(target) > self.TEMPERATURE_MAX):
Domoticz.Error('Invalid temperature setting : '+str(target)+'. Should be >='+str(self.TEMPERATURE_MIN)+' and <='+str(self.TEMPERATURE_MAX))
return
if (self.atagConn.Connecting() or self.atagConn.Connected()):
Domoticz.Debug("onConnect called, Connection is alive.")
Domoticz.Log('Updating target temperature to '+str(target))
payload = { "update_message": { "seqnr": 1,
"account_auth": { "user_account": "",
"mac_address": self.hostMac },
"control": { "ch_mode_temp": target } } }
sendData = { 'Verb' : 'POST',
'URL' : '/update',
'Headers' : { 'User-Agent': "Mozilla/5.0 (compatible; AtagOneLocalAPI/1.0.0; http://atag.one/)",
'Content-Type': 'application/json; UTF-8', \
'Accept-Charset': 'UTF-8', \
'Host': Parameters["Address"]+":"+str(self.HTTP_CLIENT_PORT) },
'Data' : json.dumps(payload)
}
Domoticz.Debug("sendData = "+str(sendData))
self.atagConn.Send(sendData)
def ProcessUpdate(self, response):
Domoticz.Debug("ProcessUpdate called")
Domoticz.Debug("ProcessUpdate response = "+str(response))
if (('acc_status' in response) and int(response['acc_status']) == 2) and ('status' in response):
Domoticz.Log('Atag One target temperature updated')
if (self.atagConn == None) or (not self.atagConn.Connected()):
Domoticz.Log('Requesting Atag One details')
self.RequestDetails()
else:
Domoticz.Debug('Attempting to reconnect Atag One')
self.SetupConnection()
else:
Domoticz.Log('Atag One failed update')
global _plugin
_plugin = BasePlugin()
def onStart():
global _plugin
_plugin.onStart()
def onStop():
global _plugin
_plugin.onStop()
def onConnect(Connection, Status, Description):
global _plugin
_plugin.onConnect(Connection, Status, Description)
def onMessage(Connection, Data):
global _plugin
_plugin.onMessage(Connection, Data)
def onCommand(Unit, Command, Level, Hue):
global _plugin
_plugin.onCommand(Unit, Command, Level, Hue)
def onNotification(Name, Subject, Text, Status, Priority, Sound, ImageFile):
global _plugin
_plugin.onNotification(Name, Subject, Text, Status, Priority, Sound, ImageFile)
def onDisconnect(Connection):
global _plugin
_plugin.onDisconnect(Connection)
def onHeartbeat():
global _plugin
_plugin.onHeartbeat()
def UpdateDevice(Unit, nValue, sValue, Image=None):
# Make sure that the Domoticz device still exists (they can be deleted) before updating it
if (Unit in Devices):
if (Devices[Unit].nValue != nValue) or (Devices[Unit].sValue != sValue) or ((Image != None) and (Image != Devices[Unit].Image)):
if (Image != None) and (Image != Devices[Unit].Image):
Devices[Unit].Update(nValue=nValue, sValue=str(sValue), Image=Image)
Domoticz.Log("Update "+str(nValue)+":'"+str(sValue)+"' ("+Devices[Unit].Name+") Image="+str(Image))
else:
Devices[Unit].Update(nValue=nValue, sValue=str(sValue))
Domoticz.Log("Update "+str(nValue)+":'"+str(sValue)+"' ("+Devices[Unit].Name+")")
# Generic helper functions
def DumpConfigToLog():
for x in Parameters:
if Parameters[x] != "":
Domoticz.Debug( "'" + x + "':'" + str(Parameters[x]) + "'")
Domoticz.Debug("Device count: " + str(len(Devices)))
for x in Devices:
Domoticz.Debug("Device: " + str(x) + " - " + str(Devices[x]))
Domoticz.Debug("Device ID: '" + str(Devices[x].ID) + "'")
Domoticz.Debug("Device Name: '" + Devices[x].Name + "'")
Domoticz.Debug("Device nValue: " + str(Devices[x].nValue))
Domoticz.Debug("Device sValue: '" + Devices[x].sValue + "'")
Domoticz.Debug("Device LastLevel: " + str(Devices[x].LastLevel))
return