-
Notifications
You must be signed in to change notification settings - Fork 0
/
smartplug.py
709 lines (496 loc) · 21.9 KB
/
smartplug.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
##
# The MIT License (MIT)
#
# Copyright (c) 2018 Stefan Wendler
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
##
import requests as req
import optparse as par
import logging as log
from xml.dom.minidom import getDOMImplementation
from xml.dom.minidom import parseString
from requests.auth import HTTPDigestAuth
__author__ = 'Stefan Wendler, sw@kaltpost.de'
class SmartPlug(object):
"""
Simple class to access a "EDIMAX Smart Plug Switch SP1101W/SP2101W"
Usage example when used as library:
p = SmartPlug("172.16.100.75", ('admin', '1234'))
# get device info
print(p.info)
# change state of plug
p.state = "OFF"
p.state = "ON"
# query and print current state of plug
print(p.state)
# get power consumption (only SP2101W)
print(p.power)
# get current consumption (only SP2101W)
print(p.current)
# read and print complete week schedule from plug
print(p.schedule.__str__())
# write schedule for on day to plug (Saturday, 11:15 - 11:45)
p.schedule = {'state': u'ON', 'sched': [[[11, 15], [11, 45]]], 'day': 6}
# write schedule for the whole week
p.schedule = [
{'state': u'ON', 'sched': [[[0, 3], [0, 4]]], 'day': 0},
{'state': u'ON', 'sched': [[[0, 10], [0, 20]], [[10, 16], [11, 55]],
[[15, 19], [15, 32]], [[21, 0], [23, 8]], [[23, 17], [23, 59]]], 'day': 1},
{'state': u'OFF', 'sched': [[[19, 59], [21, 1]]], 'day': 2},
{'state': u'OFF', 'sched': [[[20, 59], [21, 12]]], 'day': 3},
{'state': u'OFF', 'sched': [], 'day': 4},
{'state': u'OFF', 'sched': [[[0, 0], [0, 30]], [[11, 14], [14, 31]]], 'day': 5},
{'state': u'ON', 'sched': [[[1, 42], [2, 41]]], 'day': 6}]
Usage example when used as command line utility:
Get device info:
python smartplug.py -H 172.16.100.75 -l admin -p 1234 -i
turn plug on:
python smartplug.py -H 172.16.100.75 -l admin -p 1234 -s ON
turn plug off:
python smartplug.py -H 172.16.100.75 -l admin -p 1234 -s OFF
get plug state:
python smartplug.py -H 172.16.100.75 -l admin -p 1234 -g
get power consumption (only SP2101W)
python smartplug.py -H 172.16.100.75 -l admin -p 1234 -w
get current consumption (only SP2101W)
python smartplug.py -H 172.16.100.75 -l admin -p 1234 -a
get schedule of the whole week:
python smartplug.py -H 172.16.100.75 -l admin -p 1234 -G
get schedule of the whole week as python array:
python smartplug.py -H 172.16.100.75 -l admin -p 1234 -P
set schedule for one day:
python smartplug.py -H 172.16.100.75 -l admin -p 1234 -S
"{'state': u'ON', 'sched': [[[11, 0], [11, 45]]], 'day': 6}"
set schedule for the whole week:
python smartplug.py -H 172.16.100.75 -l admin -p 1234 -S "[
{'state': u'ON', 'sched': [[[1, 0], [1, 1]]], 'day': 0},
{'state': u'ON', 'sched': [[[2, 0], [2, 2]]], 'day': 1},
{'state': u'ON', 'sched': [[[3, 0], [3, 3]]], 'day': 2},
{'state': u'ON', 'sched': [[[4, 0], [4, 4]]], 'day': 3},
{'state': u'ON', 'sched': [[[5, 0], [5, 5]]], 'day': 4},
{'state': u'ON', 'sched': [[[6, 0], [6, 6]]], 'day': 5},
{'state': u'ON', 'sched': [[[7, 0], [7, 7]]], 'day': 6},
]"
"""
def __init__(self, host, auth):
"""
Create a new SmartPlug instance identified by the given URL.
:rtype: object
:param host: The IP/hostname of the SmartPlug. E.g. '172.16.100.75'
:param auth: User and password to authenticate with the plug. E.g. ('admin', '1234')
"""
object.__init__(self)
self.url = "http://%s:10000/smartplug.cgi" % host
self.auth = auth
self.domi = getDOMImplementation()
# Make a request to detect if Authentication type is Digest
res = req.head(self.url)
if res.headers['WWW-Authenticate'][0:6] == 'Digest':
self.auth = HTTPDigestAuth(auth[0], auth[1])
self.log = log.getLogger("SmartPlug")
def _xml_cmd_setget_state(self, cmdId, cmdStr):
"""
Create XML representation of a state command.
:type self: object
:type cmdId: str
:type cmdStr: str
:rtype: str
:param cmdId: Use 'get' to request plug state, use 'setup' change plug state.
:param cmdStr: Empty string for 'get', 'ON' or 'OFF' for 'setup'
:return: XML representation of command
"""
assert (cmdId == "setup" and cmdStr in ["ON", "OFF"]) or (cmdId == "get" and cmdStr == "")
doc = self.domi.createDocument(None, "SMARTPLUG", None)
doc.documentElement.setAttribute("id", "edimax")
cmd = doc.createElement("CMD")
cmd.setAttribute("id", cmdId)
state = doc.createElement("Device.System.Power.State")
cmd.appendChild(state)
state.appendChild(doc.createTextNode(cmdStr))
doc.documentElement.appendChild(cmd)
xml = doc.toxml()
self.log.debug("Request: %s" % xml)
return xml
def _xml_cmd_get_pc(self, what):
"""
Get power or current consumption (only SP2101W).
:type self: object
:type what: str
:rtype: str
:param what: What to retrieve: "NowPower" or "NowCurrent
:return: XML representation of command
"""
assert what in ["NowPower", "NowCurrent"]
doc = self.domi.createDocument(None, "SMARTPLUG", None)
doc.documentElement.setAttribute("id", "edimax")
cmd = doc.createElement("CMD")
cmd.setAttribute("id", "get")
pwr = doc.createElement("NOW_POWER")
cmd.appendChild(pwr)
state = doc.createElement("Device.System.Power.%s" % what)
pwr.appendChild(state)
doc.documentElement.appendChild(cmd)
xml = doc.toxml()
self.log.debug("Request: %s" % xml)
return xml
def _xml_cmd_get_info(self):
"""
Create XML representation of a command to query some information
:type self: object
:rtype: str
:return: XML representation of command
"""
doc = self.domi.createDocument(None, "SMARTPLUG", None)
doc.documentElement.setAttribute("id", "edimax")
cmd = doc.createElement("CMD")
cmd.setAttribute("id", "get")
si = doc.createElement("SYSTEM_INFO")
cmd.appendChild(si)
doc.documentElement.appendChild(cmd)
xml = doc.toxml()
self.log.debug("Request: %s" % xml)
return xml
def _xml_cmd_get_sched(self):
"""
Create XML representation of a command to query schedule of whole week from plug.
:type self: object
:rtype: str
:return: XML representation of command
"""
doc = self.domi.createDocument(None, "SMARTPLUG", None)
doc.documentElement.setAttribute("id", "edimax")
cmd = doc.createElement("CMD")
cmd.setAttribute("id", "get")
sched = doc.createElement("SCHEDULE")
cmd.appendChild(sched)
doc.createElement("Device.System.Power.State")
doc.documentElement.appendChild(cmd)
xml = doc.toxml()
self.log.debug("Request: %s" % xml)
return xml
def _xml_cmd_set_sched(self, sched_days):
"""
Create XML representation of a command to set scheduling for one day or whole week.
:type self: object
:type sched_days: list
:rtype: str
:param sched_day: Single day or whole week
:return: XML representation of command
"""
doc = self.domi.createDocument(None, "SMARTPLUG", None)
doc.documentElement.setAttribute("id", "edimax")
cmd = doc.createElement("CMD")
cmd.setAttribute("id", "setup")
sched = doc.createElement("SCHEDULE")
cmd.appendChild(sched)
if isinstance(sched_days, list):
# more then one day
for one_sched_day in sched_days:
dev_sched = doc.createElement("Device.System.Power.Schedule.%d" % one_sched_day["day"])
dev_sched.appendChild(doc.createTextNode(self._render_schedule(one_sched_day["sched"])))
dev_sched.attributes["value"] = one_sched_day["state"]
sched.appendChild(dev_sched)
else:
# one day
dev_sched = doc.createElement("Device.System.Power.Schedule.%d" % sched_days["day"])
dev_sched.appendChild(doc.createTextNode(self._render_schedule(sched_days["sched"])))
dev_sched.attributes["value"] = sched_days["state"]
sched.appendChild(dev_sched)
doc.documentElement.appendChild(cmd)
xml = doc.toxml()
self.log.debug("Request: %s" % xml)
return xml
def _post_xml(self, xml):
"""
Post XML command as multipart file to SmartPlug, parse XML response.
:type self: object
:type xml: str
:rtype: str
:param xml: XML representation of command (as generated by _xml_cmd)
:return: 'OK' on success, 'FAILED' otherwise
"""
files = {'file': xml}
res = req.post(self.url, auth=self.auth, files=files)
self.log.debug("Status code: %d" % res.status_code)
self.log.debug("Response: %s" % res.text)
if res.status_code == req.codes.ok:
dom = parseString(res.text)
try:
val = dom.getElementsByTagName("CMD")[0].firstChild.nodeValue
if val is None:
val = dom.getElementsByTagName("CMD")[0].getElementsByTagName("Device.System.Power.State")[0].\
firstChild.nodeValue
return val
except Exception as e:
print(e.__str__())
return None
def _post_xml_dom(self, xml):
"""
Post XML command as multipart file to SmartPlug, return response as raw dom.
:type self: object
:type xml: str
:rtype: object
:param xml: XML representation of command (as generated by _xml_cmd)
:return: dom representation of XML response
"""
files = {'file': xml}
res = req.post(self.url, auth=self.auth, files=files)
self.log.debug("Status code: %d" % res.status_code)
self.log.debug("Response: %s" % res.text)
if res.status_code == req.codes.ok:
return parseString(res.text)
return None
@property
def info(self):
"""
Get device info (vendor, model, version, mac and system name (if available)).
:type self: object
:rtype: dictonary
:return: dictonary with the following keys: vendor, model, version, mac, name
"""
dom = self._post_xml_dom(self._xml_cmd_get_info())
vendor = dom.getElementsByTagName("Run.Cus")[0].firstChild.nodeValue
model = dom.getElementsByTagName("Run.Model")[0].firstChild.nodeValue
version = dom.getElementsByTagName("Run.FW.Version")[0].firstChild.nodeValue
mac = dom.getElementsByTagName("Run.LAN.Client.MAC.Address")[0].firstChild.nodeValue
inf = {"vendor":vendor, "model":model, "version":version, "mac":mac}
# not all plugs/fw versions seem to return the system name ...
try:
inf["name"] = dom.getElementsByTagName("Device.System.Name")[0].firstChild.nodeValue
except IndexError:
pass
return inf
@property
def state(self):
"""
Get the current state of the SmartPlug.
:type self: object
:rtype: str
:return: 'ON' or 'OFF'
"""
res = self._post_xml(self._xml_cmd_setget_state("get", ""))
if res != "ON" and res != "OFF":
raise Exception("Failed to communicate with SmartPlug")
return res
@state.setter
def state(self, value):
"""
Set the state of the SmartPlug
:type self: object
:type value: str
:param value: 'ON', 'on', 'OFF' or 'off'
"""
if value == "ON" or value == "on":
res = self._post_xml(self._xml_cmd_setget_state("setup", "ON"))
else:
res = self._post_xml(self._xml_cmd_setget_state("setup", "OFF"))
if res != "OK":
raise Exception("Failed to communicate with SmartPlug")
@property
def power(self):
"""
Get the power consumption of the SmartPlug (only SP2101W).
:type self: object
:rtype: tuple (str, float)
:return: power consumption in W
"""
dom = self._post_xml_dom(self._xml_cmd_get_pc("NowPower"))
try:
power = dom.getElementsByTagName("Device.System.Power.NowPower")[0].firstChild.nodeValue
except:
raise Exception("Failed to communicate with SmartPlug")
return power
@property
def current(self):
"""
Get the current consumption of the SmartPlug (only SP2101W).
:type self: object
:rtype: tuple (str, float)
:return: current consumption in A
"""
dom = self._post_xml_dom(self._xml_cmd_get_pc("NowCurrent"))
try:
current = dom.getElementsByTagName("Device.System.Power.NowCurrent")[0].firstChild.nodeValue
except:
raise Exception("Failed to communicate with SmartPlug")
return current
def _parse_schedule(self, sched):
"""
Parse the plugs internal scheduling format string to python array
:type self: object
:type sched: str
:rtype: list
:param sched: scheduling string (of one day) as returned by plug
:return: Python array with scheduling: [[[start_hh:start_mm],[end_hh:end_mm]], ... ]
"""
sched_unpacked = [0] * 60 * 24
hours = []
idx_sched = 0
# first, unpack the packed schedule from the plug
for packed in sched:
int_packed = int(packed, 16)
sched_unpacked[idx_sched+0] = (int_packed >> 3) & 1
sched_unpacked[idx_sched+1] = (int_packed >> 2) & 1
sched_unpacked[idx_sched+2] = (int_packed >> 1) & 1
sched_unpacked[idx_sched+3] = (int_packed >> 0) & 1
idx_sched += 4
idx_hours = 0
hour = 0
min = 0
found_range = False
# second build time array from unpacked schedule
for m in sched_unpacked:
if m == 1 and not found_range:
found_range = True
hours.append([[hour, min], [23, 59]])
elif m == 0 and found_range:
found_range = False
hours[idx_hours][1][0] = hour
hours[idx_hours][1][1] = min
idx_hours += 1
min += 1
if min > 59:
min = 0
hour += 1
return hours
def _render_schedule(self, hours):
"""
Render Python scheduling array back to plugs internal format
:type self: object
:type hours: list
:rtype: str
:param hours: Python array with scheduling hours: [[[start_hh:start_mm],[end_hh:end_mm]], ... ]
:return: scheduling string (of one day) as needed by plug
"""
sched = [0] * 60 * 24
sched_str = ''
# first, set every minute we found a schedule to 1 in the sched array
for times in hours:
idx_start = times[0][0] * 60 + times[0][1]
idx_end = times[1][0] * 60 + times[1][1]
if idx_end < idx_start:
idx_end = 60 * 24
for i in range(idx_start, idx_end):
sched[i] = 1
# second, pack the minute array from above into the plug format and make a string out of it
for i in range(0, 60 * 24, 4):
packed = (sched[i] << 3) + (sched[i+1] << 2) + (sched[i+2] << 1) + (sched[i+3] << 0)
sched_str += "%X" % packed
return sched_str
@property
def schedule(self):
"""
Get scheduling for all days of week from plug as python list.
Note: it looks like the plug only is able to return a whole week.
:type self: object
:rtype: list
:return: List with scheduling for each day of week:
[
{'state': u'ON|OFF', 'sched': [[[hh, mm], [hh, mm]], ...], 'day': 0..6},
...
]
"""
sched = []
dom = self._post_xml_dom(self._xml_cmd_get_sched())
if dom is None:
return sched
try:
dom_sched = dom.getElementsByTagName("CMD")[0].getElementsByTagName("SCHEDULE")[0]
for i in range(0, 7):
sched.append(
{"day": i,
"state": dom_sched.getElementsByTagName("Device.System.Power.Schedule.%d" % i)[0].attributes[
"value"].
firstChild.nodeValue,
"sched": self._parse_schedule(
dom_sched.getElementsByTagName("Device.System.Power.Schedule.%d" % i)[0].
firstChild.nodeValue)})
except Exception as e:
print(e.__str__())
return sched
@schedule.setter
def schedule(self, sched):
"""
Set scheduling for ony day of week or for whole week on the plug.
Note: it seams not to be possible to schedule anything else then one day or a whole week.
:type self: object
:type sched: list
:rtype: str
:param sched: Array with scheduling hours for ons day:
{'day': 0..6, 'state': 'ON' | 'OFF', [[start_hh:start_mm],[end_hh:end_mm]], ... ]}
Or whole week:
[{'day': 0..6, 'state': 'ON' | 'OFF', [[start_hh:start_mm],[end_hh:end_mm]], ... ]}, ...]
:return: 'OK' (or exception on error)
"""
res = self._post_xml(self._xml_cmd_set_sched(sched))
if res != "OK":
raise Exception("Failed to communicate with SmartPlug")
return res
if __name__ == "__main__":
usage = "%prog [options]"
parser = par.OptionParser(usage)
parser.add_option("-v", "--verbose", action="store_true", help="Print debug information")
parser.add_option("-H", "--host", default="172.16.100.75", help="Base URL of the SmartPlug")
parser.add_option("-l", "--login", default="admin", help="Login user to authenticate with SmartPlug")
parser.add_option("-p", "--password", default="1234", help="Password to authenticate with SmartPlug")
parser.add_option("-i", "--info", action="store_true", help="Get plug information")
parser.add_option("-g", "--get", action="store_true", help="Get state of plug")
parser.add_option("-s", "--set", help="Set state of plug: ON or OFF")
parser.add_option("-w", "--power", action="store_true", help="Get plug power consumption (only SP2101W)")
parser.add_option("-a", "--current", action="store_true", help="Get plug current consumption (only SP2101W)")
parser.add_option("-G", "--getsched", action="store_true", help="Get schedule from Plug")
parser.add_option("-P", "--getschedpy", action="store_true", help="Get schedule from Plug as Python list")
parser.add_option("-S", "--setsched", help="Set schedule of Plug")
(options, args) = parser.parse_args()
# this turns on debugging
level = log.ERROR
if options.verbose:
level = log.DEBUG
log.basicConfig(level=level, format='%(asctime)s - %(levelname) 8s [%(module) 15s] - %(message)s')
p = SmartPlug(options.host, (options.login, options.password))
if options.info:
print("Plug info:")
for i in sorted(p.info.items()):
print("- %s: %s" % i)
if options.get:
print(p.state)
elif options.set:
p.state = options.set
if options.power:
print("%s W" % p.power)
if options.current:
print("%s A" % p.current)
elif options.getsched:
days = {0: "Sunday", 1: "Monday", 2: "Tuesday", 3: "Wednesday",
4: "Thursday", 5: "Friday", 6: "Saturday"}
for day in p.schedule:
if len(day["sched"]) > 0:
print("Schedules for: %s (%s)" % (days[day["day"]], day["state"]))
for sched in day["sched"]:
print(" * %02d:%02d - %02d:%02d" % (sched[0][0], sched[0][1], sched[1][0], sched[1][1]))
elif options.getschedpy:
print(p.schedule.__str__())
elif options.setsched:
try:
sched = eval(options.setsched)
p.schedule = sched
except Exception as e:
print("Wrong input format: %s" % e.__str__())
exit(-1)