-
Notifications
You must be signed in to change notification settings - Fork 1
/
xvc_helper.py
221 lines (176 loc) · 5.74 KB
/
xvc_helper.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
import logging
from abc import abstractmethod, ABCMeta
from enum import Enum
from typing import List, Tuple
from miio import Vacuum, DeviceException
from xvc_util import XVCListable
class XVCHelperBase(metaclass=ABCMeta):
"""
Helper class to abstract and simplify vacuum methods.
"""
class FanLevel(Enum):
"""
Enum for distinct fan levels.
"""
Quiet = 38
Balanced = 60
Turbo = 75
Max = 100
Mob = 105
RESPONSE_SUCCEEDED = ['ok']
@abstractmethod
def status(self) -> Tuple[bool, str]:
"""
Gets current status.
:return: True on success, otherwise False.
:return:
"""
raise NotImplementedError()
@abstractmethod
def pause(self) -> bool:
"""
Pause vacuum cleaner.
:return: True on success, otherwise False.
"""
raise NotImplementedError()
@abstractmethod
def home(self) -> bool:
"""
Stops cleaning and sends vacuum cleaner back to the dock.
:return: True on success, otherwise False.
"""
raise NotImplementedError()
@abstractmethod
def start_zone_cleaning(self, zones: List[XVCListable]) -> bool:
"""
Start the zone cleanup.
:param zones: Different zones to clean.
:return: True on success, otherwise False.
"""
raise NotImplementedError()
@abstractmethod
def set_fan_level(self, fan_level: FanLevel) -> bool:
"""
Sets the fan level.
:param fan_level: New fan level.
:return: True on success, otherwise False.
"""
raise NotImplementedError()
class XVCHelperSimulator(XVCHelperBase):
"""
Helper class to abstract and simplify vacuum methods.
"""
def __init__(self, ip: str, token: str) -> None:
"""
Initialize a object of class XVCHelper.
:param ip: IP address of the vacuum cleaner.
:param token: Token of the vacuum cleaner.
"""
logging.info('Simulation: {}:{}'.format(ip, token))
self.__ip = ip
self.__token = token
def status(self) -> Tuple[bool, str]:
"""
Gets current status.
:return: True on success, otherwise False.
:return:
"""
logging.info('Simulation: status()')
return True, 'Simulation'
def pause(self) -> bool:
"""
Pause vacuum cleaner.
:return: True on success, otherwise False.
"""
logging.info('XVCHelperSimulator: pause()')
return True
def home(self) -> bool:
"""
Stops cleaning and sends vacuum cleaner back to the dock.
:return: True on success, otherwise False.
"""
logging.info('Simulation: home()')
return True
def start_zone_cleaning(self, zones: List[XVCListable]) -> bool:
"""
Start the zone cleanup.
:param zones: Different zones to clean.
:return: True on success, otherwise False.
"""
logging.info('Simulation: start_zone_cleaning()')
for zone in zones:
logging.info('Simulation: {}'.format(zone))
return True
def set_fan_level(self, fan_level: XVCHelperBase.FanLevel) -> bool:
"""
Sets the fan level.
:param fan_level: New fan level.
:return: True on success, otherwise False.
"""
logging.info('Simulation: set_fan_level()')
return True
class XVCHelper(XVCHelperBase):
"""
Helper class to abstract and simplify vacuum methods.
"""
def __init__(self, ip: str, token: str) -> None:
"""
Initialize a object of class XVCHelper.
:param ip: IP address of the vacuum cleaner.
:param token: Token of the vacuum cleaner.
"""
self.__vacuum = Vacuum(ip=ip, token=token, start_id=1)
# check connection
for _ in range(3):
try:
self.__vacuum.do_discover()
break
except DeviceException:
continue
else:
raise ConnectionError('Cannot establish connection to Vacuum Cleaner at {}'.format(ip))
def status(self) -> Tuple[bool, str]:
"""
Gets current status.
:return: True on success, otherwise False.
:return: Vacuum status.
"""
vacuum_status = None
try:
vacuum_status = self.__vacuum.status().state
result = True
except DeviceException:
result = False
return result, vacuum_status
def pause(self) -> bool:
"""
Pause vacuum cleaner.
:return: True on success, otherwise False.
"""
result = self.__vacuum.pause()
return result == XVCHelper.RESPONSE_SUCCEEDED
def home(self) -> bool:
"""
Stops cleaning and sends vacuum cleaner back to the dock.
:return: True on success, otherwise False.
"""
result = self.__vacuum.home()
return result == XVCHelper.RESPONSE_SUCCEEDED
def start_zone_cleaning(self, zones: List[XVCListable]) -> bool:
"""
Start the zone cleanup.
:param zones: Different zones to clean.
:return: True on success, otherwise False.
"""
self.pause()
zones_list = [zone.get_list() for zone in zones]
result = self.__vacuum.zoned_clean(zones_list)
return result == XVCHelper.RESPONSE_SUCCEEDED
def set_fan_level(self, fan_level: XVCHelperBase.FanLevel) -> bool:
"""
Sets the fan level.
:param fan_level: New fan level.
:return: True on success, otherwise False.
"""
result = self.__vacuum.set_fan_speed(fan_level.value)
return result == XVCHelper.RESPONSE_SUCCEEDED