forked from beveradb/pysonofflan
-
Notifications
You must be signed in to change notification settings - Fork 23
/
sonoffdevice.py
471 lines (367 loc) · 15.2 KB
/
sonoffdevice.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
"""
pysonofflan
Python library supporting Sonoff Smart Devices (Basic/S20/Touch) in LAN Mode.
"""
import asyncio
import json
import logging
import sys
from typing import Callable, Awaitable, Dict
import traceback
from pysonofflanr3 import SonoffLANModeClient
class SonoffDevice(object):
def __init__(
self,
host: str,
callback_after_update: Callable[..., Awaitable[None]] = None,
shared_state: Dict = None,
logger=None,
loop=None,
ping_interval=SonoffLANModeClient.DEFAULT_PING_INTERVAL,
timeout=SonoffLANModeClient.DEFAULT_TIMEOUT,
context: str = None,
device_id: str = "",
api_key: str = "",
outlet: int = None,
) -> None:
"""
Create a new SonoffDevice instance.
:param str host: host name or ip address on which the device listens
:param context: optional child ID for context in a parent device
"""
self.callback_after_update = callback_after_update
self.host = host
self.context = context
self.api_key = api_key
self.outlet = outlet
self.shared_state = shared_state
self.basic_info = None
self.params = {"switch": "unknown"}
self.loop = loop
self.tasks = []
self.new_loop = False
if logger is None:
self.logger = logging.getLogger(__name__)
else:
self.logger = logger
# Ctrl-C (KeyboardInterrupt) does not work well on Windows
# This module solve that issue with wakeup coroutine.
# noqa https://stackoverflow.com/questions/24774980/why-cant-i-catch-sigint-when-asyncio-event-loop-is-running/24775107#24775107
# noqa code lifted from https://gist.github.com/lambdalisue/05d5654bd1ec04992ad316d50924137c
if sys.platform.startswith("win"):
def hotfix(loop: asyncio.AbstractEventLoop) -> \
asyncio.AbstractEventLoop:
loop.call_soon(_wakeup, loop, 1.0)
return loop
def _wakeup(loop: asyncio.AbstractEventLoop,
delay: float = 1.0) -> None:
loop.call_later(delay, _wakeup, loop, delay)
else:
# Do Nothing on non Windows
def hotfix(loop: asyncio.AbstractEventLoop) -> \
asyncio.AbstractEventLoop:
return loop
try:
if self.loop is None:
self.new_loop = True
self.loop = asyncio.new_event_loop()
asyncio.set_event_loop(self.loop)
self.logger.debug(
"Initializing SonoffLANModeClient class in SonoffDevice"
)
self.client = SonoffLANModeClient(
host,
self.handle_message,
ping_interval=ping_interval,
timeout=timeout,
logger=self.logger,
loop=self.loop,
device_id=device_id,
api_key=api_key,
outlet=outlet,
)
self.message_ping_event = asyncio.Event()
self.message_acknowledged_event = asyncio.Event()
self.params_updated_event = asyncio.Event()
self.client.connect()
self.tasks.append(self.loop.create_task(
self.send_availability_loop()
))
self.send_updated_params_task = self.loop.create_task(
self.send_updated_params_loop()
)
self.tasks.append(self.send_updated_params_task)
if self.new_loop:
hotfix(self.loop) # see Cltr-C hotfix earlier in routine
self.loop.run_until_complete(self.send_updated_params_task)
except asyncio.CancelledError:
self.logger.debug("SonoffDevice loop ended, returning")
def calculate_retry(self, retry_count):
try:
# increasing backoff each retry attempt
wait_seconds = [2, 5, 10, 30, 60]
if retry_count >= len(wait_seconds):
retry_count = len(wait_seconds) - 1
return wait_seconds[retry_count]
except Exception as ex:
self.logger.error("Unexpected error in wait_before_retry(): %s",
format(ex))
async def send_availability_loop(self):
self.logger.debug("enter send_availability_loop()")
try:
while True:
self.logger.debug("waiting for connection")
await self.client.connected_event.wait()
self.client.disconnected_event.clear()
self.logger.debug("connected event, sending update")
# no need to send thos update as handle_message calls it
# if self.callback_after_update is not None:
# await self.callback_after_update(self)
self.logger.debug("waiting for disconnection")
await self.client.disconnected_event.wait()
self.client.connected_event.clear()
self.logger.debug("disconnected event, sending update")
if self.callback_after_update is not None:
await self.callback_after_update(self)
finally:
self.logger.debug("exiting send_availability_loop()")
async def send_updated_params_loop(self):
self.logger.debug(
"send_updated_params_loop is active on the event loop"
)
retry_count = 0
try:
self.logger.debug(
"Starting loop waiting for device params to change")
while True:
self.logger.debug(
"send_updated_params_loop now awaiting event")
await self.params_updated_event.wait()
await self.client.connected_event.wait()
self.logger.debug("Connected!")
update_message = self.client.get_update_payload(
self.device_id, self.params
)
try:
self.message_ping_event.clear()
self.message_acknowledged_event.clear()
await self.loop.run_in_executor(
None, self.client.send_switch, update_message
)
await asyncio.wait_for(
self.message_ping_event.wait(),
self.calculate_retry(retry_count),
)
if self.message_acknowledged_event.is_set():
self.params_updated_event.clear()
self.logger.debug(
"Update message sent, event cleared, looping"
)
retry_count = 0
else:
self.logger.info(
"we didn't get a confirmed acknowledgement, "
"state has changed in between retry!"
)
retry_count += 1
except asyncio.TimeoutError:
self.logger.warn(
"Device: %s. "
"Update message not received in timeout period, retry",
self.device_id,
)
retry_count += 1
except asyncio.CancelledError:
self.logger.debug("send_updated_params_loop cancelled")
break
except OSError as ex:
if retry_count == 0:
self.logger.warn(
"Connection issue for device %s: %s",
self.device_id,
format(ex),
)
else:
self.logger.debug(
"Connection issue for device %s: %s",
self.device_id,
format(ex),
)
await asyncio.sleep(self.calculate_retry(retry_count))
retry_count += 1
except Exception as ex:
self.logger.error(
"send_updated_params_loop() [inner block] "
"Unexpected error for device %s: %s %s",
self.device_id,
format(ex),
traceback.format_exc(),
)
break
except asyncio.CancelledError:
self.logger.debug("send_updated_params_loop cancelled")
except Exception as ex:
self.logger.error(
"send_updated_params_loop() [outer block] "
"Unexpected error for device %s: %s %s",
self.device_id,
format(ex),
traceback.format_exc(),
)
finally:
self.logger.debug("send_updated_params_loop finally block reached")
def update_params(self, params):
if self.params != params:
self.logger.debug(
"Scheduling params update message to device: %s" % params)
self.params = params
self.params_updated_event.set()
else:
self.logger.debug("unnecessary update received, ignoring")
async def handle_message(self, message):
"""
Receive message sent by the device and handle it, either updating
state or storing basic device info
"""
try:
self.logger.debug("enter handle_message() %s", message)
self.message_ping_event.set()
response = json.loads(message.decode('utf-8'))
if self.client.type == b"strip":
if self.outlet is None:
self.outlet = 0
switch_status = \
response["switches"][int(self.outlet)]["switch"]
elif (
self.client.type == b"plug"
or self.client.type == b"diy_plug"
or self.client.type == b"enhanced_plug"
or self.client.type == b"th_plug"
):
switch_status = response["switch"]
else:
self.logger.error(
"Unknown message received from device: " % message)
raise Exception("Unknown message received from device")
self.logger.debug(
"Message: Received status from device, storing in instance"
)
self.basic_info = response
self.basic_info["deviceid"] = self.host
self.client.connected_event.set()
send_update = False
# is there is a new message queued to be sent
if self.params_updated_event.is_set():
# only send client update message if the change successful
if self.params["switch"] == switch_status:
self.message_acknowledged_event.set()
send_update = True
self.logger.debug(
"expected update received from switch: %s",
switch_status
)
else:
self.logger.info(
"failed update! state is: %s, expecting: %s",
switch_status,
self.params["switch"],
)
else:
# this is a status update message originating from the device
# only send client update message if the status has changed
self.logger.info(
"unsolicited update received from switch: %s",
switch_status
)
if self.params["switch"] != switch_status:
self.params = {"switch": switch_status}
send_update = True
if send_update and self.callback_after_update is not None:
await self.callback_after_update(self)
except Exception as ex:
self.logger.error(
"Unexpected error in handle_message() for device %s: %s %s",
self.device_id,
format(ex),
traceback.format_exc(),
)
def shutdown_event_loop(self):
self.logger.debug("shutdown_event_loop called")
try:
# Hide Cancelled Error exceptions during shutdown
def shutdown_exception_handler(loop, context):
if "exception" not in context or not isinstance(
context["exception"], asyncio.CancelledError
):
loop.default_exception_handler(context)
self.loop.set_exception_handler(shutdown_exception_handler)
# Handle shutdown gracefully by waiting for all tasks
# to be cancelled
tasks = asyncio.gather(*self.tasks, loop=self.loop,
return_exceptions=True)
if self.new_loop:
tasks.add_done_callback(lambda t: self.loop.stop())
tasks.cancel()
# Keep the event loop running until it is either
# destroyed or all tasks have really terminated
if self.new_loop:
while (
not tasks.done()
and not self.loop.is_closed()
and not self.loop.is_running()
):
self.loop.run_forever()
except Exception as ex:
self.logger.error(
"Unexpected error in shutdown_event_loop(): %s", format(ex)
)
finally:
if self.new_loop:
if (
hasattr(self.loop, "shutdown_asyncgens")
and not self.loop.is_running()
):
# Python 3.5
self.loop.run_until_complete(
self.loop.shutdown_asyncgens())
self.loop.close()
@property
def device_id(self) -> str:
"""
Get current device ID (immutable value based on hardware MAC address)
:return: Device ID.
:rtype: str
"""
return self.client.properties[b"id"].decode("utf-8")
async def turn_off(self) -> None:
"""
Turns the device off.
"""
raise NotImplementedError("Device subclass needs to implement this.")
@property
def is_off(self) -> bool:
"""
Returns whether device is off.
:return: True if device is off, False otherwise.
:rtype: bool
"""
return not self.is_on
async def turn_on(self) -> None:
"""
Turns the device on.
"""
raise NotImplementedError("Device subclass needs to implement this.")
@property
def is_on(self) -> bool:
"""
Returns whether the device is on.
:return: True if the device is on, False otherwise.
:rtype: bool
:return:
"""
raise NotImplementedError("Device subclass needs to implement this.")
def __repr__(self):
return "<%s at %s>" % (self.__class__.__name__, self.device_id)
@property
def available(self) -> bool:
return self.client.connected_event.is_set()