This repository was archived by the owner on Jun 28, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathclimate_setting_schedules.py
More file actions
344 lines (298 loc) · 11.2 KB
/
Copy pathclimate_setting_schedules.py
File metadata and controls
344 lines (298 loc) · 11.2 KB
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
from typing import List, Optional, Union
from seamapi.types import AbstractClimateSettingSchedules
from seamapi.types import AbstractSeam as Seam
from seamapi.types import (ClimateSettingSchedule,
ClimateSettingScheduleId, Device, DeviceId)
from seamapi.utils.convert_to_id import (to_climate_setting_schedule_id,
to_device_id)
from seamapi.utils.report_error import report_error
class ClimateSettingSchedules(AbstractClimateSettingSchedules):
"""
A class used to interact with Climate Setting Schedules for Thermostats
Attributes
----------
seam : Seam
Initial seam class
Methods
-------
list(device=Union[DeviceId, Device])
Gets a list of climate setting schedules for a device
get(climate_setting_schedule: Union[ClimateSettingScheduleId, ClimateSettingSchedule])
Gets a climate setting schedule
create(
device,
device: Union[DeviceId, Device],
schedule_starts_at: str,
schedule_ends_at: str,
manual_override_allowed: bool,
name: Optional[str],
automatic_heating_enabled: Optional[bool],
automatic_cooling_enabled: Optional[bool],
hvac_mode_setting: Optional[str],
cooling_set_point_celsius: Optional[float],
heating_set_point_celsius: Optional[float],
cooling_set_point_fahrenheit: Optional[float],
heating_set_point_fahrenheit: Optional[float],
schedule_type: Optional[str],
)
Creates a climate setting schedule for a Device
update(
climate_setting_schedule,
self,
climate_setting_schedule: Union[str, ClimateSettingSchedule],
schedule_starts_at: Optional[str],
schedule_ends_at: Optional[str],
name: Optional[str],
automatic_heating_enabled: Optional[bool],
automatic_cooling_enabled: Optional[bool],
hvac_mode_setting: Optional[str],
cooling_set_point_celsius: Optional[float],
heating_set_point_celsius: Optional[float],
cooling_set_point_fahrenheit: Optional[float],
heating_set_point_fahrenheit: Optional[float],
manual_override_allowed: Optional[bool],
schedule_type: Optional[str],
)
Updates a climate setting schedule
delete(climate_setting_schedule)
Deletes a climate setting schedule
"""
seam: Seam
def __init__(self, seam: Seam):
"""
Parameters
----------
seam : Seam
Initial seam class
"""
self.seam = seam
@report_error
def list(
self,
device: Union[DeviceId, Device],
) -> List[ClimateSettingSchedule]:
"""Gets a list of Climate Setting Schedules.
Parameters
----------
device : DeviceId or Device
Device id or Device to get the climate setting schedules of
Raises
------
Exception
If the API request wasn't successful.
Returns
------
A list of climate setting schedules.
"""
device_id = to_device_id(device)
res = self.seam.make_request(
"GET",
"/thermostats/climate_setting_schedules/list",
params={
"device_id": device_id
},
)
climate_setting_schedules = res["climate_setting_schedules"]
return [ClimateSettingSchedule.from_dict(d) for d in climate_setting_schedules]
@report_error
def get(
self,
climate_setting_schedule: Union[ClimateSettingScheduleId, ClimateSettingSchedule]
) -> ClimateSettingSchedule:
"""Gets a Climate Setting Schedule.
Parameters
----------
climate_setting_schedule : Id or ClimateSettingSchedule
Id or ClimateSettingSchedule to get the state of
Raises
------
Exception
If the API request wasn't successful.
Returns
------
ClimateSettingSchedule
"""
climate_setting_schedule_id = to_climate_setting_schedule_id(climate_setting_schedule)
res = self.seam.make_request("GET", "/thermostats/climate_setting_schedules/get", params={
"climate_setting_schedule_id": climate_setting_schedule_id
})
json_response = res["climate_setting_schedule"]
return ClimateSettingSchedule.from_dict(json_response)
@report_error
def create(
self,
device: Union[DeviceId, Device],
schedule_starts_at: str,
schedule_ends_at: str,
manual_override_allowed: bool,
name: Optional[str] = None,
automatic_heating_enabled: Optional[bool] = None,
automatic_cooling_enabled: Optional[bool] = None,
hvac_mode_setting: Optional[str] = None,
cooling_set_point_celsius: Optional[float] = None,
heating_set_point_celsius: Optional[float] = None,
cooling_set_point_fahrenheit: Optional[float] = None,
heating_set_point_fahrenheit: Optional[float] = None,
schedule_type: Optional[str] = None,
) -> ClimateSettingSchedule:
"""Creates a Climate Setting Schedule.
Parameters
----------
device : DeviceId or Device
Device id or Device to create the climate setting schedule for
properties : ClimateSettingScheduleBase
Properties to update
Raises
------
Exception
If the API request wasn't successful.
Returns
------
Boolean
"""
device_id = to_device_id(device)
params = climate_setting_params(
automatic_heating_enabled,
automatic_cooling_enabled,
hvac_mode_setting,
cooling_set_point_celsius,
heating_set_point_celsius,
cooling_set_point_fahrenheit,
heating_set_point_fahrenheit,
manual_override_allowed,
schedule_type,
name,
schedule_starts_at,
schedule_ends_at,
)
params["device_id"] = device_id
res = self.seam.make_request(
"POST",
"/thermostats/climate_setting_schedules/create",
json=params
)
json_response = res["climate_setting_schedule"]
return ClimateSettingSchedule.from_dict(json_response)
@report_error
def update(
self,
climate_setting_schedule: Union[str, ClimateSettingSchedule],
schedule_starts_at: Optional[str] = None,
schedule_ends_at: Optional[str] = None,
name: Optional[str] = None,
automatic_heating_enabled: Optional[bool] = None,
automatic_cooling_enabled: Optional[bool] = None,
hvac_mode_setting: Optional[str] = None,
cooling_set_point_celsius: Optional[float] = None,
heating_set_point_celsius: Optional[float] = None,
cooling_set_point_fahrenheit: Optional[float] = None,
heating_set_point_fahrenheit: Optional[float] = None,
manual_override_allowed: Optional[bool] = None,
schedule_type: Optional[str] = None,
) -> ClimateSettingSchedule:
"""Updates a Climate Setting Schedule.
Parameters
----------
climate_setting_schedule : ClimateSettingScheduleId or ClimateSettingSchedule
ClimateSettingSchedule to update
properties : ClimateSettingScheduleBase
Properties to update
Raises
------
Exception
If the API request wasn't successful.
Returns
------
Boolean
"""
climate_setting_schedule_id = to_climate_setting_schedule_id(climate_setting_schedule)
params = climate_setting_params(
automatic_heating_enabled,
automatic_cooling_enabled,
hvac_mode_setting,
cooling_set_point_celsius,
heating_set_point_celsius,
cooling_set_point_fahrenheit,
heating_set_point_fahrenheit,
manual_override_allowed,
schedule_type,
name,
schedule_starts_at,
schedule_ends_at,
)
params["climate_setting_schedule_id"] = climate_setting_schedule_id
res = self.seam.make_request(
"POST",
"/thermostats/climate_setting_schedules/update",
json=params,
)
json_response = res["climate_setting_schedule"]
return ClimateSettingSchedule.from_dict(json_response)
@report_error
def delete(
self,
climate_setting_schedule: Union[ClimateSettingScheduleId, ClimateSettingSchedule]
) -> None:
"""Deletes a climate setting schedule.
Parameters
----------
climate_setting_schedule : Id or ClimateSettingSchedule
Id or ClimateSettingSchedule to delete
Raises
------
Exception
If the API request wasn't successful.
Returns
------
None
"""
climate_setting_schedule_id = to_climate_setting_schedule_id(climate_setting_schedule)
delete_payload = {
"climate_setting_schedule_id": climate_setting_schedule_id
}
self.seam.make_request(
"DELETE",
"/thermostats/climate_setting_schedules/delete",
json=delete_payload,
)
return None
def climate_setting_params(
automatic_heating_enabled: Optional[bool] = None,
automatic_cooling_enabled: Optional[bool] = None,
hvac_mode_setting: Optional[str] = None,
cooling_set_point_celsius: Optional[float] = None,
heating_set_point_celsius: Optional[float] = None,
cooling_set_point_fahrenheit: Optional[float] = None,
heating_set_point_fahrenheit: Optional[float] = None,
manual_override_allowed: Optional[bool] = None,
schedule_type: Optional[str] = None,
name: Optional[str] = None,
schedule_starts_at: Optional[str] = None,
schedule_ends_at: Optional[str] = None,
):
params = {}
if automatic_heating_enabled is not None:
params["automatic_heating_enabled"] = automatic_heating_enabled
if automatic_cooling_enabled is not None:
params["automatic_cooling_enabled"] = automatic_cooling_enabled
if hvac_mode_setting is not None:
params["hvac_mode_setting"] = hvac_mode_setting
if cooling_set_point_celsius is not None:
params["cooling_set_point_celsius"] = cooling_set_point_celsius
if heating_set_point_celsius is not None:
params["heating_set_point_celsius"] = heating_set_point_celsius
if cooling_set_point_fahrenheit is not None:
params["cooling_set_point_fahrenheit"] = cooling_set_point_fahrenheit
if heating_set_point_fahrenheit is not None:
params["heating_set_point_fahrenheit"] = heating_set_point_fahrenheit
if manual_override_allowed is not None:
params["manual_override_allowed"] = manual_override_allowed
if schedule_type is not None:
params["schedule_type"] = schedule_type
if name is not None:
params["name"] = name
if schedule_starts_at is not None:
params["schedule_starts_at"] = schedule_starts_at
if schedule_ends_at is not None:
params["schedule_ends_at"] = schedule_ends_at
return params